You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
262 lines
9.2 KiB
Python
262 lines
9.2 KiB
Python
#!/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
|
|
|
|
def CheckChangeHasTestField(input_api, output_api):
|
|
"""Requires that the changelist have a TEST= field."""
|
|
if input_api.change.TEST:
|
|
return []
|
|
else:
|
|
return [output_api.PresubmitNotifyResult(
|
|
"Changelist should have a TEST= field. TEST=none is allowed.")]
|
|
|
|
|
|
def CheckChangeHasBugField(input_api, output_api):
|
|
"""Requires that the changelist have a BUG= field."""
|
|
if input_api.change.BUG:
|
|
return []
|
|
else:
|
|
return [output_api.PresubmitNotifyResult(
|
|
"Changelist should have a BUG= field. BUG=none is allowed.")]
|
|
|
|
|
|
def CheckChangeHasTestedField(input_api, output_api):
|
|
"""Requires that the changelist have a TESTED= field."""
|
|
if input_api.change.TESTED:
|
|
return []
|
|
else:
|
|
return [output_api.PresubmitError("Changelist must have a TESTED= field.")]
|
|
|
|
|
|
def CheckChangeHasQaField(input_api, output_api):
|
|
"""Requires that the changelist have a QA= field."""
|
|
if input_api.change.QA:
|
|
return []
|
|
else:
|
|
return [output_api.PresubmitError("Changelist must have a QA= field.")]
|
|
|
|
|
|
def CheckDoNotSubmitInDescription(input_api, output_api):
|
|
"""Checks that the user didn't add 'DO NOT ' + 'SUBMIT' to the CL description.
|
|
"""
|
|
keyword = 'DO NOT ' + 'SUBMIT'
|
|
if keyword in input_api.change.DescriptionText():
|
|
return [output_api.PresubmitError(
|
|
keyword + " is present in the changelist description.")]
|
|
else:
|
|
return []
|
|
|
|
|
|
def CheckChangeHasDescription(input_api, output_api):
|
|
"""Checks the CL description is not empty."""
|
|
text = input_api.change.DescriptionText()
|
|
if text.strip() == '':
|
|
if input_api.is_committing:
|
|
return [output_api.PresubmitError("Add a description.")]
|
|
else:
|
|
return [output_api.PresubmitNotifyResult("Add a description.")]
|
|
return []
|
|
|
|
### Content checks
|
|
|
|
def CheckDoNotSubmitInFiles(input_api, output_api):
|
|
"""Checks that the user didn't add 'DO NOT ' + 'SUBMIT' to any files."""
|
|
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 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'):
|
|
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.
|
|
"""
|
|
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:
|
|
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 CheckChangeHasNoStrayWhitespace(input_api, output_api,
|
|
source_file_filter=None):
|
|
"""Checks that there is no stray whitespace at source lines end."""
|
|
errors = []
|
|
for f, line_num, line in input_api.RightHandSideLines(source_file_filter):
|
|
if line.rstrip() != line:
|
|
errors.append("%s, line %s" % (f.LocalPath(), line_num))
|
|
if errors:
|
|
return [output_api.PresubmitPromptWarning(
|
|
"Found line ending with white spaces in:",
|
|
long_text="\n".join(errors))]
|
|
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
|
|
# to exceed the maxlen rule.
|
|
if (len(line) > maxlen and
|
|
not 'http://' in line and
|
|
not 'https://' in line and
|
|
not line.startswith('#define') and
|
|
not line.startswith('#include') and
|
|
not line.startswith('#pragma') and
|
|
not line.startswith('#if') and
|
|
not line.startswith('#endif')):
|
|
bad.append(
|
|
'%s, line %s, %s chars' %
|
|
(f.LocalPath(), line_num, len(line)))
|
|
if len(bad) == 5: # Just show the first 5 errors.
|
|
break
|
|
|
|
if bad:
|
|
msg = "Found lines longer than %s characters (first 5 shown)." % maxlen
|
|
return [output_api.PresubmitPromptWarning(msg, items=bad)]
|
|
else:
|
|
return []
|
|
|
|
|
|
def CheckChangeSvnEolStyle(input_api, output_api, source_file_filter=None):
|
|
"""Checks that the source files have svn:eol-style=LF."""
|
|
bad = filter(lambda f: f.scm == 'svn' and f.Property('svn:eol-style') != 'LF',
|
|
input_api.AffectedSourceFiles(source_file_filter))
|
|
if bad:
|
|
if input_api.is_committing:
|
|
return [output_api.PresubmitError(
|
|
"Fix these files with svn svn:eol-style=LF", items=bad)]
|
|
else:
|
|
return [output_api.PresubmitNotifyResult(
|
|
"Fix these files with svn svn:eol-style=LF", items=bad)]
|
|
return []
|
|
|
|
|
|
### Other checks
|
|
|
|
def CheckDoNotSubmit(input_api, output_api):
|
|
return (
|
|
CheckDoNotSubmitInDescription(input_api, output_api) +
|
|
CheckDoNotSubmitInFiles(input_api, output_api)
|
|
)
|
|
|
|
|
|
def CheckTreeIsOpen(input_api, output_api, url, closed):
|
|
"""Checks that an url's content doesn't match a regexp that would mean that
|
|
the tree is closed."""
|
|
assert(input_api.is_committing)
|
|
try:
|
|
connection = input_api.urllib2.urlopen(url)
|
|
status = connection.read()
|
|
connection.close()
|
|
if input_api.re.match(closed, status):
|
|
long_text = status + '\n' + url
|
|
return [output_api.PresubmitPromptWarning("The tree is closed.",
|
|
long_text=long_text)]
|
|
except IOError:
|
|
pass
|
|
return []
|
|
|
|
|
|
def _RunPythonUnitTests_LoadTests(input_api, module_name):
|
|
"""Meant to be stubbed out during unit testing."""
|
|
module = __import__(module_name)
|
|
for part in module_name.split('.')[1:]:
|
|
module = getattr(module, part)
|
|
return input_api.unittest.TestLoader().loadTestsFromModule(module)._tests
|
|
|
|
|
|
def RunPythonUnitTests(input_api, output_api, unit_tests):
|
|
"""Imports the unit_tests modules and run them."""
|
|
# We don't want to hinder users from uploading incomplete patches.
|
|
if input_api.is_committing:
|
|
message_type = output_api.PresubmitError
|
|
else:
|
|
message_type = output_api.PresubmitNotifyResult
|
|
tests_suite = []
|
|
outputs = []
|
|
for unit_test in unit_tests:
|
|
try:
|
|
tests_suite.extend(_RunPythonUnitTests_LoadTests(input_api, unit_test))
|
|
except ImportError:
|
|
outputs.append(message_type("Failed to load %s" % unit_test,
|
|
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
|