Add CheckChangeHasOnlyOneEol and CheckChangeHasNoCrAndHasOnlyOneEol.

presubmit_canned_checks.py

 #!/usr/bin/env python
 # Copyright (c) 2006-2009 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Generic presubmit checks that can be reused by other presubmit checks."""
 
 
 ### Description checks
 
@@ skipping 49 matching lines @@
   keyword = 'DO NOT ' + 'SUBMIT'
   # We want to check every text files, not just source files.
   for f, line_num, line in input_api.RightHandSideLines(lambda x: x):
     if keyword in line:
       text = 'Found ' + keyword + ' in %s, line %s' % (f.LocalPath(), line_num)
       return [output_api.PresubmitError(text)]
   return []
 
 
 def CheckChangeHasNoCR(input_api, output_api, source_file_filter=None):
-  """Checks that there are no \r, \r\n (CR or CRLF) characters in any of the
-  source files to be submitted.
-  """
-  outputs = []
+  """Checks no '\r' (CR) character is in any source files."""
+  cr_files = []
   for f in input_api.AffectedSourceFiles(source_file_filter):
     if '\r' in input_api.ReadFile(f, 'rb'):
-      outputs.append(output_api.PresubmitPromptWarning(
-          "Found a CR character in %s" % f.LocalPath()))
+      cr_files.append(f.LocalPath())
+  if cr_files:
+    return [output_api.PresubmitPromptWarning(
+        "Found a CR character in these files:", items=cr_files)]
+  return []
+
+
+def CheckChangeHasOnlyOneEol(input_api, output_api, source_file_filter=None):
+  """Checks the files ends with one and only one \n (LF)."""
+  eof_files = []
+  for f in input_api.AffectedSourceFiles(source_file_filter):
+    contents = input_api.ReadFile(f, 'rb')
+    # Check that the file ends in one and only one newline character.
+    if len(contents) > 1 and (contents[-1:] != "\n" or contents[-2:-1] == "\n"):
+      eof_files.append(f.LocalPath())
+
+  if eof_files:
+    return [output_api.PresubmitPromptWarning(
+      'These files should end in one (and only one) newline character:',
+      items=eof_files)]
+  return []
+
+
+def CheckChangeHasNoCrAndHasOnlyOneEol(input_api, output_api,
+                                       source_file_filter=None):
+  """Runs both CheckChangeHasNoCR and CheckChangeHasOnlyOneEOL in one pass.
+
+  It is faster because it is reading the file only once.

[Jói Sigurðsson, 2009/06/10 18:02:33]

this makes me think perhaps in the future we should have input_api.ReadFile
cache files that have been read

+  """
+  cr_files = []
+  eof_files = []
+  for f in input_api.AffectedSourceFiles(source_file_filter):
+    contents = input_api.ReadFile(f, 'rb')
+    if '\r' in contents:
+      cr_files.append(f.LocalPath())
+    # Check that the file ends in one and only one newline character.
+    if len(contents) > 1 and (contents[-1:] != "\n" or contents[-2:-1] == "\n"):
+      eof_files.append(f.LocalPath())
+  outputs = []
+  if cr_files:
+    outputs.append(output_api.PresubmitPromptWarning(
+        "Found a CR character in these files:", items=cr_files))
+  if eof_files:
+    outputs.append(output_api.PresubmitPromptWarning(
+      'These files should end in one (and only one) newline character:',
+      items=eof_files))
   return outputs
 
 
 def CheckChangeHasNoTabs(input_api, output_api, source_file_filter=None):
   """Checks that there are no tab characters in any of the text files to be
   submitted.
   """
+  tabs = []
   for f, line_num, line in input_api.RightHandSideLines(source_file_filter):
     if '\t' in line:
-      return [output_api.PresubmitPromptWarning(
-          "Found a tab character in %s, line %s" %
-          (f.LocalPath(), line_num))]
+      tabs.append("%s, line %s" % (f.LocalPath(), line_num))
+  if tabs:
+    return [output_api.PresubmitPromptWarning("Found a tab character in:",
+                                              long_text="\n".join(tabs))]
   return []
 
 
 def CheckLongLines(input_api, output_api, maxlen=80, source_file_filter=None):
   """Checks that there aren't any lines longer than maxlen characters in any of
   the text files to be submitted.
   """
   bad = []
   for f, line_num, line in input_api.RightHandSideLines(source_file_filter):
     # Allow lines with http://, https:// and #define/#pragma/#include/#if/#endif
@@ skipping 80 matching lines @@
                                   long_text=input_api.traceback.format_exc()))
 
   buffer = input_api.cStringIO.StringIO()
   results = input_api.unittest.TextTestRunner(stream=buffer, verbosity=0).run(
       input_api.unittest.TestSuite(tests_suite))
   if not results.wasSuccessful():
     outputs.append(message_type("%d unit tests failed." %
                                 (len(results.failures) + len(results.errors)),
                                 long_text=buffer.getvalue()))
   return outputs