diff options
| -rwxr-xr-x | PRESUBMIT.py | 102 | ||||
| -rwxr-xr-x | PRESUBMIT_unittest.py | 48 |
2 files changed, 103 insertions, 47 deletions
diff --git a/PRESUBMIT.py b/PRESUBMIT.py index 1340216..e0bd7de 100755 --- a/PRESUBMIT.py +++ b/PRESUBMIT.py @@ -9,17 +9,24 @@ See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts for details on the presubmit API built into gcl. """ - -import os - - # Files with these extensions will be considered source files -SOURCE_FILE_EXTENSIONS = ['.c', '.cc', '.cpp', '.h', '.m', '.mm', '.py'] - +SOURCE_FILE_EXTENSIONS = [ + '.c', '.cc', '.cpp', '.h', '.m', '.mm', '.py', '.mk', '.am', '.json', +] +EXCLUDED_PATHS = [ + r"breakpad[\\\/].*", + r"chrome[\\\/]Debug[\\\/].*", + r"chrome[\\\/]Hammer[\\\/].*", + r"chrome[\\\/]Release[\\\/].*", + r"xcodebuild[\\\/].*", + r"skia[\\\/].*", + r".*third_party[\\\/].*", + r"v8[\\\/].*", +] def ReadFile(path): """Given a path, returns the full contents of the file. - + Reads files in binary format. """ fo = open(path, 'rb') @@ -35,39 +42,76 @@ _ReadFile = ReadFile def CheckChangeOnUpload(input_api, output_api): - return (CheckNoCrOrTabs(input_api, output_api) + - input_api.canned_checks.CheckDoNotSubmit(input_api, output_api)) + return LocalChecks(input_api, output_api) def CheckChangeOnCommit(input_api, output_api): - # No extra checks on commit for now - return CheckChangeOnUpload(input_api, output_api) + return (LocalChecks(input_api, output_api) + + input_api.canned_checks.CheckDoNotSubmit(input_api, output_api)) + +def LocalChecks(input_api, output_api, max_cols=80): + """Reports an error if for any source file in SOURCE_FILE_EXTENSIONS: + - uses CR (or CRLF) + - contains a TAB + - has a line that ends with whitespace + - contains a line >|max_cols| cols unless |max_cols| is 0. -def CheckNoCrOrTabs(input_api, output_api): - """Reports an error if source files use CR (or CRLF) or TAB. + Note that the whole file is checked, not only the changes. """ cr_files = [] - tab_files = [] results = [] - - for f in input_api.AffectedTextFiles(include_deletes=False): + excluded_paths = [input_api.re.compile(x) for x in EXCLUDED_PATHS] + files = input_api.AffectedFiles() + for f in files: path = f.LocalPath() - root, ext = os.path.splitext(path) - if ext in SOURCE_FILE_EXTENSIONS: - # Need to read the file ourselves since AffectedFile.NewContents() - # will normalize line endings. - contents = _ReadFile(path) - if '\r' in contents: - cr_files.append(path) - if '\t' in contents: - tab_files.append(path) + root, ext = input_api.os_path.splitext(path) + # Look for unsupported extensions. + if not ext in SOURCE_FILE_EXTENSIONS: + continue + # Look for excluded paths. + found = False + for item in excluded_paths: + if item.match(path): + found = True + break + if found: + continue + + # Need to read the file ourselves since AffectedFile.NewContents() + # will normalize line endings. + contents = _ReadFile(path) + if '\r' in contents: + cr_files.append(path) + + local_errors = [] + # Remove EOL character. + lines = contents.splitlines() + line_num = 1 + for line in lines: + if line.endswith(' '): + local_errors.append(output_api.PresubmitError( + '%s, line %s ends with whitespaces.' % + (path, line_num))) + # Accept lines with http:// to exceed the max_cols rule. + if max_cols and len(line) > max_cols and not 'http://' in line: + local_errors.append(output_api.PresubmitError( + '%s, line %s has %s chars, please reduce to %d chars.' % + (path, line_num, len(line), max_cols))) + if '\t' in line: + local_errors.append(output_api.PresubmitError( + "%s, line %s contains a tab character." % + (path, line_num))) + line_num += 1 + # Just show the first 5 errors. + if len(local_errors) == 6: + local_errors.pop() + local_errors.append(output_api.PresubmitError("... and more.")) + break + results.extend(local_errors) + if cr_files: results.append(output_api.PresubmitError( 'Found CR (or CRLF) line ending in these files, please use only LF:', items=cr_files)) - if tab_files: - results.append(output_api.PresubmitError( - 'Found tabs in the following files, please use spaces', - items=tab_files)) return results diff --git a/PRESUBMIT_unittest.py b/PRESUBMIT_unittest.py index 5a2c514..b8183c2 100755 --- a/PRESUBMIT_unittest.py +++ b/PRESUBMIT_unittest.py @@ -7,14 +7,21 @@ """ +import os import PRESUBMIT +import re import unittest class MockInputApi(object): def __init__(self): self.affected_files = [] - + self.re = re + self.os_path = os.path + + def AffectedFiles(self): + return self.affected_files + def AffectedTextFiles(self, include_deletes=True): return self.affected_files @@ -22,14 +29,14 @@ class MockInputApi(object): class MockAffectedFile(object): def __init__(self, path): self.path = path - + def LocalPath(self): return self.path class MockOutputApi(object): class PresubmitError(object): - def __init__(self, msg, items): + def __init__(self, msg, items=[], long_text=''): self.msg = msg self.items = items @@ -41,34 +48,39 @@ class PresubmitUnittest(unittest.TestCase): self.failIf(path.endswith('notsource')) return self.file_contents PRESUBMIT._ReadFile = MockReadFile - + def tearDown(self): PRESUBMIT._ReadFile = PRESUBMIT.ReadFile - - def testCheckNoCrLfOrTabs(self): + + def testLocalChecks(self): api = MockInputApi() api.affected_files = [ MockAffectedFile('foo/blat/yoo.notsource'), + MockAffectedFile('third_party/blat/source.cc'), MockAffectedFile('foo/blat/source.h'), MockAffectedFile('foo/blat/source.mm'), MockAffectedFile('foo/blat/source.py'), ] - self.file_contents = 'file with\nerror\nhere\r\nyes there' - self.failUnless(len(PRESUBMIT.CheckNoCrOrTabs(api, MockOutputApi)) == 1) - self.failUnless( - len(PRESUBMIT.CheckNoCrOrTabs(api, MockOutputApi)[0].items) == 3) - + self.file_contents = 'file with \n\terror\nhere\r\nyes there' + # 3 source files, 2 errors by file + 1 global CR error. + self.failUnless(len(PRESUBMIT.LocalChecks(api, MockOutputApi)) == 7) + self.file_contents = 'file\twith\ttabs' - self.failUnless(len(PRESUBMIT.CheckNoCrOrTabs(api, MockOutputApi)) == 1) - + # 3 source files, 1 error by file. + self.failUnless(len(PRESUBMIT.LocalChecks(api, MockOutputApi)) == 3) + self.file_contents = 'file\rusing\rCRs' - self.failUnless(len(PRESUBMIT.CheckNoCrOrTabs(api, MockOutputApi)) == 1) - + # One global CR error. + self.failUnless(len(PRESUBMIT.LocalChecks(api, MockOutputApi)) == 1) + self.failUnless( + len(PRESUBMIT.LocalChecks(api, MockOutputApi)[0].items) == 3) + self.file_contents = 'both\ttabs and\r\nCRLF' - self.failUnless(len(PRESUBMIT.CheckNoCrOrTabs(api, MockOutputApi)) == 2) - + # 3 source files, 1 error by file + 1 global CR error. + self.failUnless(len(PRESUBMIT.LocalChecks(api, MockOutputApi)) == 4) + self.file_contents = 'file with\nzero \\t errors \\r\\n' - self.failIf(PRESUBMIT.CheckNoCrOrTabs(api, MockOutputApi)) + self.failIf(PRESUBMIT.LocalChecks(api, MockOutputApi)) if __name__ == '__main__': |