aiden
/
depot_tools
mirror of https://chromium.googlesource.com/chromium/tools/depot_tools
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

presubmit_support: Refactor and add tests for DoPostUploadExecuter.

Browse Source 
Remove input and output stream, that always pointed to sys.stdin
and sys.stdout.
Add tests for DoPostUploadExecuter.

Bug: 1042324
Change-Id: Ib5d092706a242ae97ec877af5dbceef6db7cbb73
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/tools/depot_tools/+/2079411
Reviewed-by: Josip Sokcevic <sokcevic@google.com>
Commit-Queue: Edward Lesmes <ehmaldonado@chromium.org>
changes/11/2079411/5
Edward Lemur 5 years ago committed by LUCI CQ
parent 24fd86307f
commit 6eb1d32f5d
3 changed files with 239 additions and 233 deletions
Show Stats Download Patch File Download Diff File

4
git_cl.py
Unescape Escape View File

@ -1534,9 +1534,7 @@ class Changelist(object):
presubmit_support.DoPostUploadExecuter( presubmit_support.DoPostUploadExecuter(
change, change,
self.GetGerritObjForPresubmit(), self.GetGerritObjForPresubmit(),
settings.GetRoot(), options.verbose)
options.verbose,
sys.stdout)
# Upload all dependencies if specified. # Upload all dependencies if specified.
if options.dependencies: if options.dependencies:

179
presubmit_support.py
Unescape Escape View File

@ -292,36 +292,10 @@ def _RightHandSideLinesImpl(affected_files):
yield (af, line[0], line[1]) yield (af, line[0], line[1])
class PresubmitOutput(object): def prompt_should_continue(prompt_string):
def __init__(self, input_stream=None, output_stream=None): sys.stdout.write(prompt_string)
self.input_stream = input_stream response = sys.stdin.readline().strip().lower()
self.output_stream = output_stream return response in ('y', 'yes')
self.more_cc = []
self.written_output = []
self.error_count = 0
def prompt_yes_no(self, prompt_string):
self.write(prompt_string)
if self.input_stream:
response = self.input_stream.readline().strip().lower()
if response not in ('y', 'yes'):
self.fail()
else:
self.fail()
def fail(self):
self.error_count += 1
def should_continue(self):
return not self.error_count
def write(self, s):
self.written_output.append(s)
if self.output_stream:
self.output_stream.write(s)
def getvalue(self):
return ''.join(self.written_output)
# Top level object so multiprocessing can pickle # Top level object so multiprocessing can pickle
@ -341,23 +315,21 @@ class _PresubmitResult(object):
self._items = items or [] self._items = items or []
self._long_text = long_text.rstrip() self._long_text = long_text.rstrip()
def handle(self, output): def handle(self):
output.write(self._message) sys.stdout.write(self._message)
output.write('\n') sys.stdout.write('\n')
for index, item in enumerate(self._items): for index, item in enumerate(self._items):
output.write(' ') sys.stdout.write(' ')
# Write separately in case it's unicode. # Write separately in case it's unicode.
output.write(str(item)) sys.stdout.write(str(item))
if index < len(self._items) - 1: if index < len(self._items) - 1:
output.write(' \\') sys.stdout.write(' \\')
output.write('\n') sys.stdout.write('\n')
if self._long_text: if self._long_text:
output.write('\n***************\n') sys.stdout.write('\n***************\n')
# Write separately in case it's unicode. # Write separately in case it's unicode.
output.write(self._long_text) sys.stdout.write(self._long_text)
output.write('\n***************\n') sys.stdout.write('\n***************\n')
if self.fatal:
output.fail()
def json_format(self): def json_format(self):
return { return {
@ -1459,22 +1431,18 @@ def DoGetTryMasters(change,
def DoPostUploadExecuter(change, def DoPostUploadExecuter(change,
gerrit_obj, gerrit_obj,
repository_root, verbose):
verbose,
output_stream):
"""Execute the post upload hook. """Execute the post upload hook.
Args: Args:
change: The Change object. change: The Change object.
gerrit_obj: The GerritAccessor object. gerrit_obj: The GerritAccessor object.
repository_root: The repository root.
verbose: Prints debug info. verbose: Prints debug info.
output_stream: A stream to write debug output to.
""" """
presubmit_files = ListRelevantPresubmitFiles( presubmit_files = ListRelevantPresubmitFiles(
change.LocalPaths(), repository_root) change.LocalPaths(), change.RepositoryRoot())
if not presubmit_files and verbose: if not presubmit_files and verbose:
output_stream.write('Warning, no PRESUBMIT.py found.\n') sys.stdout.write('Warning, no PRESUBMIT.py found.\n')
results = [] results = []
executer = GetPostUploadExecuter() executer = GetPostUploadExecuter()
# The root presubmit file should be executed after the ones in subdirectories. # The root presubmit file should be executed after the ones in subdirectories.
@ -1485,19 +1453,26 @@ def DoPostUploadExecuter(change,
for filename in presubmit_files: for filename in presubmit_files:
filename = os.path.abspath(filename) filename = os.path.abspath(filename)
if verbose: if verbose:
output_stream.write('Running %s\n' % filename) sys.stdout.write('Running %s\n' % filename)
# Accept CRLF presubmit script. # Accept CRLF presubmit script.
presubmit_script = gclient_utils.FileRead(filename, 'rU') presubmit_script = gclient_utils.FileRead(filename, 'rU')
results.extend(executer.ExecPresubmitScript( results.extend(executer.ExecPresubmitScript(
presubmit_script, filename, gerrit_obj, change)) presubmit_script, filename, gerrit_obj, change))
output_stream.write('\n')
if results: if not results:
output_stream.write('** Post Upload Hook Messages **\n') return 0
sys.stdout.write('\n')
sys.stdout.write('** Post Upload Hook Messages **\n')
exit_code = 0
for result in results: for result in results:
result.handle(output_stream) if result.fatal:
output_stream.write('\n') exit_code = 1
result.handle()
sys.stdout.write('\n')
return results return exit_code
class PresubmitExecuter(object): class PresubmitExecuter(object):
@ -1584,8 +1559,6 @@ class PresubmitExecuter(object):
def DoPresubmitChecks(change, def DoPresubmitChecks(change,
committing, committing,
verbose, verbose,
output_stream,
input_stream,
default_presubmit, default_presubmit,
may_prompt, may_prompt,
gerrit_obj, gerrit_obj,
@ -1605,8 +1578,6 @@ def DoPresubmitChecks(change,
change: The Change object. change: The Change object.
committing: True if 'git cl land' is running, False if 'git cl upload' is. committing: True if 'git cl land' is running, False if 'git cl upload' is.
verbose: Prints debug info. verbose: Prints debug info.
output_stream: A stream to write output from presubmit tests to.
input_stream: A stream to read input from the user.
default_presubmit: A default presubmit script to execute in any case. default_presubmit: A default presubmit script to execute in any case.
may_prompt: Enable (y/n) questions on warning or error. If False, may_prompt: Enable (y/n) questions on warning or error. If False,
any questions are answered with yes by default. any questions are answered with yes by default.
@ -1615,13 +1586,8 @@ def DoPresubmitChecks(change,
parallel: if true, all tests specified by input_api.RunTests in all parallel: if true, all tests specified by input_api.RunTests in all
PRESUBMIT files will be run in parallel. PRESUBMIT files will be run in parallel.
Warning:
If may_prompt is true, output_stream SHOULD be sys.stdout and input_stream
SHOULD be sys.stdin.
Return: Return:
A PresubmitOutput object. Use output.should_continue() to figure out 1 if presubmit checks failed or 0 otherwise.
if there were errors or warnings and the caller should abort.
""" """
old_environ = os.environ old_environ = os.environ
try: try:
@ -1629,84 +1595,83 @@ def DoPresubmitChecks(change,
os.environ = os.environ.copy() os.environ = os.environ.copy()
os.environ['PYTHONDONTWRITEBYTECODE'] = '1' os.environ['PYTHONDONTWRITEBYTECODE'] = '1'
output = PresubmitOutput(input_stream, output_stream)
if committing: if committing:
output.write('Running presubmit commit checks ...\n') sys.stdout.write('Running presubmit commit checks ...\n')
else: else:
output.write('Running presubmit upload checks ...\n') sys.stdout.write('Running presubmit upload checks ...\n')
start_time = time_time() start_time = time_time()
presubmit_files = ListRelevantPresubmitFiles( presubmit_files = ListRelevantPresubmitFiles(
change.AbsoluteLocalPaths(), change.RepositoryRoot()) change.AbsoluteLocalPaths(), change.RepositoryRoot())
if not presubmit_files and verbose: if not presubmit_files and verbose:
output.write('Warning, no PRESUBMIT.py found.\n') sys.stdout.write('Warning, no PRESUBMIT.py found.\n')
results = [] results = []
thread_pool = ThreadPool() thread_pool = ThreadPool()
executer = PresubmitExecuter(change, committing, verbose, gerrit_obj, executer = PresubmitExecuter(change, committing, verbose, gerrit_obj,
dry_run, thread_pool, parallel) dry_run, thread_pool, parallel)
if default_presubmit: if default_presubmit:
if verbose: if verbose:
output.write('Running default presubmit script.\n') sys.stdout.write('Running default presubmit script.\n')
fake_path = os.path.join(change.RepositoryRoot(), 'PRESUBMIT.py') fake_path = os.path.join(change.RepositoryRoot(), 'PRESUBMIT.py')
results += executer.ExecPresubmitScript(default_presubmit, fake_path) results += executer.ExecPresubmitScript(default_presubmit, fake_path)
for filename in presubmit_files: for filename in presubmit_files:
filename = os.path.abspath(filename) filename = os.path.abspath(filename)
if verbose: if verbose:
output.write('Running %s\n' % filename) sys.stdout.write('Running %s\n' % filename)
# Accept CRLF presubmit script. # Accept CRLF presubmit script.
presubmit_script = gclient_utils.FileRead(filename, 'rU') presubmit_script = gclient_utils.FileRead(filename, 'rU')
results += executer.ExecPresubmitScript(presubmit_script, filename) results += executer.ExecPresubmitScript(presubmit_script, filename)
results += thread_pool.RunAsync() results += thread_pool.RunAsync()
output.more_cc.extend(executer.more_cc) messages = {}
errors = [] should_prompt = False
notifications = [] presubmits_failed = False
warnings = []
for result in results: for result in results:
if result.fatal: if result.fatal:
errors.append(result) presubmits_failed = True
messages.setdefault('ERRORS', []).append(result)
elif result.should_prompt: elif result.should_prompt:
warnings.append(result) should_prompt = True
messages.setdefault('Warnings', []).append(result)
else: else:
notifications.append(result) messages.setdefault('Messages', []).append(result)
output.write('\n') sys.stdout.write('\n')
for name, items in (('Messages', notifications), for name, items in messages.items():
('Warnings', warnings), sys.stdout.write('** Presubmit %s **\n' % name)
('ERRORS', errors)): for item in items:
if items: item.handle()
output.write('** Presubmit %s **\n' % name) sys.stdout.write('\n')
for item in items:
item.handle(output)
output.write('\n')
total_time = time_time() - start_time total_time = time_time() - start_time
if total_time > 1.0: if total_time > 1.0:
output.write('Presubmit checks took %.1fs to calculate.\n\n' % total_time) sys.stdout.write(
'Presubmit checks took %.1fs to calculate.\n\n' % total_time)
if errors: if not should_prompt and not presubmits_failed:
output.fail() sys.stdout.write('Presubmit checks passed.\n')
elif warnings: elif should_prompt:
output.write('There were presubmit warnings. ') sys.stdout.write('There were presubmit warnings. ')
if may_prompt: if may_prompt:
output.prompt_yes_no('Are you sure you wish to continue? (y/N): ') presubmits_failed = not prompt_should_continue(
else: 'Are you sure you wish to continue? (y/N): ')
output.write('Presubmit checks passed.\n')
if json_output: if json_output:
# Write the presubmit results to json output # Write the presubmit results to json output
presubmit_results = { presubmit_results = {
'errors': [ 'errors': [
error.json_format() for error in errors error.json_format()
for error in messages.get('ERRORS', [])
], ],
'notifications': [ 'notifications': [
notification.json_format() for notification in notifications notification.json_format()
for notification in messages.get('Messages', [])
], ],
'warnings': [ 'warnings': [
warning.json_format() for warning in warnings warning.json_format()
for warning in messages.get('Warnings', [])
], ],
'more_cc': output.more_cc, 'more_cc': executer.more_cc,
} }
gclient_utils.FileWrite( gclient_utils.FileWrite(
@ -1715,12 +1680,13 @@ def DoPresubmitChecks(change,
global _ASKED_FOR_FEEDBACK global _ASKED_FOR_FEEDBACK
# Ask for feedback one time out of 5. # Ask for feedback one time out of 5.
if (len(results) and random.randint(0, 4) == 0 and not _ASKED_FOR_FEEDBACK): if (len(results) and random.randint(0, 4) == 0 and not _ASKED_FOR_FEEDBACK):
output.write( sys.stdout.write(
'Was the presubmit check useful? If not, run "git cl presubmit -v"\n' 'Was the presubmit check useful? If not, run "git cl presubmit -v"\n'
'to figure out which PRESUBMIT.py was run, then run git blame\n' 'to figure out which PRESUBMIT.py was run, then run git blame\n'
'on the file to figure out who to ask for help.\n') 'on the file to figure out who to ask for help.\n')
_ASKED_FOR_FEEDBACK = True _ASKED_FOR_FEEDBACK = True
return output
return 1 if presubmits_failed else 0
finally: finally:
os.environ = old_environ os.environ = old_environ
@ -1901,19 +1867,16 @@ def main(argv=None):
try: try:
with canned_check_filter(options.skip_canned): with canned_check_filter(options.skip_canned):
results = DoPresubmitChecks( return DoPresubmitChecks(
change, change,
options.commit, options.commit,
options.verbose, options.verbose,
sys.stdout,
sys.stdin,
options.default_presubmit, options.default_presubmit,
options.may_prompt, options.may_prompt,
gerrit_obj, gerrit_obj,
options.dry_run, options.dry_run,
options.parallel, options.parallel,
options.json_output) options.json_output)
return not results.should_continue()
except PresubmitFailure as e: except PresubmitFailure as e:
print(e, file=sys.stderr) print(e, file=sys.stderr)
print('Maybe your depot_tools is out of date?', file=sys.stderr) print('Maybe your depot_tools is out of date?', file=sys.stderr)

289
tests/presubmit_unittest.py
Unescape Escape View File

@ -80,6 +80,14 @@ def CheckChangeOnUpload(input_api, output_api):
return [output_api.PresubmitPromptWarning("??")] return [output_api.PresubmitPromptWarning("??")]
else: else:
return () return ()
def PostUploadHook(gerrit, change, output_api):
if change.tags.get('ERROR'):
return [output_api.PresubmitError("!!")]
if change.tags.get('PROMPT_WARNING'):
return [output_api.PresubmitPromptWarning("??")]
else:
return ()
""" """
presubmit_trymaster = """ presubmit_trymaster = """
@ -555,6 +563,51 @@ class PresubmitUnittest(PresubmitTestsBase):
self.assertEqual( self.assertEqual(
os.remove.mock_calls, [mock.call('baz'), mock.call('quux')]) os.remove.mock_calls, [mock.call('baz'), mock.call('quux')])
def testDoPostUploadExecuter(self):
os.path.isfile.side_effect = lambda f: 'PRESUBMIT.py' in f
os.listdir.return_value = ['PRESUBMIT.py']
gclient_utils.FileRead.return_value = self.presubmit_text
change = self.ExampleChange()
self.assertEqual(
0,
presubmit.DoPostUploadExecuter(
change=change, gerrit_obj=None, verbose=False))
self.assertEqual('', sys.stdout.getvalue())
def testDoPostUploadExecuterWarning(self):
path = os.path.join(self.fake_root_dir, 'PRESUBMIT.py')
os.path.isfile.side_effect = lambda f: f == path
os.listdir.return_value = ['PRESUBMIT.py']
gclient_utils.FileRead.return_value = self.presubmit_text
change = self.ExampleChange(extra_lines=['PROMPT_WARNING=yes'])
self.assertEqual(
0,
presubmit.DoPostUploadExecuter(
change=change, gerrit_obj=None, verbose=False))
self.assertEqual(
'\n'
'** Post Upload Hook Messages **\n'
'??\n'
'\n',
sys.stdout.getvalue())
def testDoPostUploadExecuterWarning(self):
path = os.path.join(self.fake_root_dir, 'PRESUBMIT.py')
os.path.isfile.side_effect = lambda f: f == path
os.listdir.return_value = ['PRESUBMIT.py']
gclient_utils.FileRead.return_value = self.presubmit_text
change = self.ExampleChange(extra_lines=['ERROR=yes'])
self.assertEqual(
1,
presubmit.DoPostUploadExecuter(
change=change, gerrit_obj=None, verbose=False))
self.assertEqual(
'\n'
'** Post Upload Hook Messages **\n'
'!!\n'
'\n',
sys.stdout.getvalue())
def testDoPresubmitChecksNoWarningsOrErrors(self): def testDoPresubmitChecksNoWarningsOrErrors(self):
haspresubmit_path = os.path.join( haspresubmit_path = os.path.join(
self.fake_root_dir, 'haspresubmit', 'PRESUBMIT.py') self.fake_root_dir, 'haspresubmit', 'PRESUBMIT.py')
@ -568,15 +621,15 @@ class PresubmitUnittest(PresubmitTestsBase):
# Make a change which will have no warnings. # Make a change which will have no warnings.
change = self.ExampleChange(extra_lines=['STORY=http://tracker/123']) change = self.ExampleChange(extra_lines=['STORY=http://tracker/123'])
output = presubmit.DoPresubmitChecks( self.assertEqual(
change=change, committing=False, verbose=True, 0,
output_stream=None, input_stream=None, presubmit.DoPresubmitChecks(
default_presubmit=None, may_prompt=False, change=change, committing=False, verbose=True,
gerrit_obj=None, json_output=None) default_presubmit=None, may_prompt=False,
self.assertIsNotNone(output.should_continue()) gerrit_obj=None, json_output=None))
self.assertEqual(output.getvalue().count('!!'), 0) self.assertEqual(sys.stdout.getvalue().count('!!'), 0)
self.assertEqual(output.getvalue().count('??'), 0) self.assertEqual(sys.stdout.getvalue().count('??'), 0)
self.assertEqual(output.getvalue().count( self.assertEqual(sys.stdout.getvalue().count(
'Running presubmit upload checks ...\n'), 1) 'Running presubmit upload checks ...\n'), 1)
def testDoPresubmitChecksJsonOutput(self): def testDoPresubmitChecksJsonOutput(self):
@ -653,13 +706,13 @@ def CheckChangeOnCommit(input_api, output_api):
fake_result_json = json.dumps(fake_result, sort_keys=True) fake_result_json = json.dumps(fake_result, sort_keys=True)
output = presubmit.DoPresubmitChecks( self.assertEqual(
change=change, committing=False, verbose=True, 1,
output_stream=None, input_stream=None, presubmit.DoPresubmitChecks(
default_presubmit=always_fail_presubmit_script, change=change, committing=False, verbose=True,
may_prompt=False, gerrit_obj=None, json_output=temp_path) default_presubmit=always_fail_presubmit_script,
may_prompt=False, gerrit_obj=None, json_output=temp_path))
self.assertFalse(output.should_continue())
gclient_utils.FileWrite.assert_called_with(temp_path, fake_result_json) gclient_utils.FileWrite.assert_called_with(temp_path, fake_result_json)
def testDoPresubmitChecksPromptsAfterWarnings(self): def testDoPresubmitChecksPromptsAfterWarnings(self):
@ -677,25 +730,28 @@ def CheckChangeOnCommit(input_api, output_api):
# Make a change with a single warning. # Make a change with a single warning.
change = self.ExampleChange(extra_lines=['PROMPT_WARNING=yes']) change = self.ExampleChange(extra_lines=['PROMPT_WARNING=yes'])
input_buf = StringIO('n\n') # say no to the warning # say no to the warning
output = presubmit.DoPresubmitChecks( with mock.patch('sys.stdin', StringIO('n\n')):
change=change, committing=False, verbose=True, self.assertEqual(
output_stream=None, input_stream=input_buf, 1,
default_presubmit=None, may_prompt=True, presubmit.DoPresubmitChecks(
gerrit_obj=None, json_output=None) change=change, committing=False, verbose=True,
self.assertFalse(output.should_continue()) default_presubmit=None, may_prompt=True,
self.assertEqual(output.getvalue().count('??'), 2) gerrit_obj=None, json_output=None))
self.assertEqual(sys.stdout.getvalue().count('??'), 2)
input_buf = StringIO('y\n') # say yes to the warning
output = presubmit.DoPresubmitChecks( sys.stdout.truncate(0)
change=change, committing=False, verbose=True, # say yes to the warning
output_stream=None, input_stream=input_buf, with mock.patch('sys.stdin', StringIO('y\n')):
default_presubmit=None, may_prompt=True, self.assertEqual(
gerrit_obj=None, json_output=None) 0,
self.assertIsNotNone(output.should_continue()) presubmit.DoPresubmitChecks(
self.assertEqual(output.getvalue().count('??'), 2) change=change, committing=False, verbose=True,
self.assertEqual(output.getvalue().count( default_presubmit=None, may_prompt=True,
'Running presubmit upload checks ...\n'), 1) gerrit_obj=None, json_output=None))
self.assertEqual(sys.stdout.getvalue().count('??'), 2)
self.assertEqual(sys.stdout.getvalue().count(
'Running presubmit upload checks ...\n'), 1)
def testDoPresubmitChecksWithWarningsAndNoPrompt(self): def testDoPresubmitChecksWithWarningsAndNoPrompt(self):
presubmit_path = os.path.join(self.fake_root_dir, 'PRESUBMIT.py') presubmit_path = os.path.join(self.fake_root_dir, 'PRESUBMIT.py')
@ -711,16 +767,16 @@ def CheckChangeOnCommit(input_api, output_api):
change = self.ExampleChange(extra_lines=['PROMPT_WARNING=yes']) change = self.ExampleChange(extra_lines=['PROMPT_WARNING=yes'])
# There is no input buffer and may_prompt is set to False. # There is no input buffer and may_prompt is set to False.
output = presubmit.DoPresubmitChecks( self.assertEqual(
change=change, committing=False, verbose=True, 0,
output_stream=None, input_stream=None, presubmit.DoPresubmitChecks(
default_presubmit=None, may_prompt=False, change=change, committing=False, verbose=True,
gerrit_obj=None, json_output=None) default_presubmit=None, may_prompt=False,
gerrit_obj=None, json_output=None))
# A warning is printed, and should_continue is True. # A warning is printed, and should_continue is True.
self.assertIsNotNone(output.should_continue()) self.assertEqual(sys.stdout.getvalue().count('??'), 2)
self.assertEqual(output.getvalue().count('??'), 2) self.assertEqual(sys.stdout.getvalue().count('(y/N)'), 0)
self.assertEqual(output.getvalue().count('(y/N)'), 0) self.assertEqual(sys.stdout.getvalue().count(
self.assertEqual(output.getvalue().count(
'Running presubmit upload checks ...\n'), 1) 'Running presubmit upload checks ...\n'), 1)
def testDoPresubmitChecksNoWarningPromptIfErrors(self): def testDoPresubmitChecksNoWarningPromptIfErrors(self):
@ -735,16 +791,16 @@ def CheckChangeOnCommit(input_api, output_api):
random.randint.return_value = 1 random.randint.return_value = 1
change = self.ExampleChange(extra_lines=['ERROR=yes']) change = self.ExampleChange(extra_lines=['ERROR=yes'])
output = presubmit.DoPresubmitChecks( self.assertEqual(
change=change, committing=False, verbose=True, 1,
output_stream=None, input_stream=None, presubmit.DoPresubmitChecks(
default_presubmit=None, may_prompt=True, change=change, committing=False, verbose=True,
gerrit_obj=None, json_output=None) default_presubmit=None, may_prompt=True,
self.assertFalse(output.should_continue()) gerrit_obj=None, json_output=None))
self.assertEqual(output.getvalue().count('??'), 0) self.assertEqual(sys.stdout.getvalue().count('??'), 0)
self.assertEqual(output.getvalue().count('!!'), 2) self.assertEqual(sys.stdout.getvalue().count('!!'), 2)
self.assertEqual(output.getvalue().count('(y/N)'), 0) self.assertEqual(sys.stdout.getvalue().count('(y/N)'), 0)
self.assertEqual(output.getvalue().count( self.assertEqual(sys.stdout.getvalue().count(
'Running presubmit upload checks ...\n'), 1) 'Running presubmit upload checks ...\n'), 1)
def testDoDefaultPresubmitChecksAndFeedback(self): def testDoDefaultPresubmitChecksAndFeedback(self):
@ -760,25 +816,25 @@ def CheckChangeOnCommit(input_api, output_api):
lambda d: [] if d == self.fake_root_dir else ['PRESUBMIT.py']) lambda d: [] if d == self.fake_root_dir else ['PRESUBMIT.py'])
random.randint.return_value = 0 random.randint.return_value = 0
input_buf = StringIO('y\n')
change = self.ExampleChange(extra_lines=['STORY=http://tracker/123']) change = self.ExampleChange(extra_lines=['STORY=http://tracker/123'])
output = presubmit.DoPresubmitChecks( with mock.patch('sys.stdin', StringIO('y\n')):
change=change, committing=False, verbose=True, self.assertEqual(
output_stream=None, input_stream=input_buf, 1,
default_presubmit=always_fail_presubmit_script, presubmit.DoPresubmitChecks(
may_prompt=False, gerrit_obj=None, json_output=None) change=change, committing=False, verbose=True,
self.assertFalse(output.should_continue()) default_presubmit=always_fail_presubmit_script,
text = ( may_prompt=False, gerrit_obj=None, json_output=None))
'Running presubmit upload checks ...\n' text = (
'Warning, no PRESUBMIT.py found.\n' 'Running presubmit upload checks ...\n'
'Running default presubmit script.\n' 'Warning, no PRESUBMIT.py found.\n'
'\n' 'Running default presubmit script.\n'
'** Presubmit ERRORS **\n!!\n\n' '\n'
'Was the presubmit check useful? If not, run "git cl presubmit -v"\n' '** Presubmit ERRORS **\n!!\n\n'
'to figure out which PRESUBMIT.py was run, then run git blame\n' 'Was the presubmit check useful? If not, run "git cl presubmit -v"\n'
'on the file to figure out who to ask for help.\n') 'to figure out which PRESUBMIT.py was run, then run git blame\n'
self.assertEqual(output.getvalue(), text) 'on the file to figure out who to ask for help.\n')
self.assertEqual(sys.stdout.getvalue(), text)
def testGetTryMastersExecuter(self): def testGetTryMastersExecuter(self):
change = self.ExampleChange( change = self.ExampleChange(
@ -880,14 +936,28 @@ def CheckChangeOnCommit(input_api, output_api):
self.fake_root_dir, None, None, self.fake_root_dir, None, None,
False, output)) False, output))
@mock.patch('presubmit_support.DoPresubmitChecks') @mock.patch(
def testMainUnversioned(self, mockDoPresubmitChecks): 'presubmit_support.ListRelevantPresubmitFiles',
return_value=['PRESUBMIT.py'])
def testMainUnversioned(self, *_mocks):
gclient_utils.FileRead.return_value = ''
scm.determine_scm.return_value = None scm.determine_scm.return_value = None
presubmit._parse_files.return_value = [('M', 'random_file.txt')]
mockDoPresubmitChecks().should_continue.return_value = False
self.assertEqual( self.assertEqual(
True, 0,
presubmit.main(['--root', self.fake_root_dir, 'random_file.txt']))
@mock.patch(
'presubmit_support.ListRelevantPresubmitFiles',
return_value=['PRESUBMIT.py'])
def testMainUnversionedChecksFail(self, *_mocks):
gclient_utils.FileRead.return_value = (
'def CheckChangeOnUpload(input_api, output_api):\n'
' return [output_api.PresubmitError("!!")]\n')
scm.determine_scm.return_value = None
self.assertEqual(
1,
presubmit.main(['--root', self.fake_root_dir, 'random_file.txt'])) presubmit.main(['--root', self.fake_root_dir, 'random_file.txt']))
def testMainUnversionedFail(self): def testMainUnversionedFail(self):
@ -1490,48 +1560,26 @@ class OutputApiUnittest(PresubmitTestsBase):
def testOutputApiHandling(self): def testOutputApiHandling(self):
presubmit.OutputApi.PresubmitError('!!!').handle()
self.assertIsNotNone(sys.stdout.getvalue().count('!!!'))
output = presubmit.PresubmitOutput() sys.stdout.truncate(0)
presubmit.OutputApi.PresubmitError('!!!').handle(output) presubmit.OutputApi.PresubmitNotifyResult('?see?').handle()
self.assertFalse(output.should_continue()) self.assertIsNotNone(sys.stdout.getvalue().count('?see?'))
self.assertIsNotNone(output.getvalue().count('!!!'))
output = presubmit.PresubmitOutput()
presubmit.OutputApi.PresubmitNotifyResult('?see?').handle(output)
self.assertIsNotNone(output.should_continue())
self.assertIsNotNone(output.getvalue().count('?see?'))
output = presubmit.PresubmitOutput(input_stream=StringIO('y'))
presubmit.OutputApi.PresubmitPromptWarning('???').handle(output)
output.prompt_yes_no('prompt: ')
self.assertIsNotNone(output.should_continue())
self.assertIsNotNone(output.getvalue().count('???'))
output = presubmit.PresubmitOutput(input_stream=StringIO('\n')) sys.stdout.truncate(0)
presubmit.OutputApi.PresubmitPromptWarning('???').handle(output) presubmit.OutputApi.PresubmitPromptWarning('???').handle()
output.prompt_yes_no('prompt: ') self.assertIsNotNone(sys.stdout.getvalue().count('???'))
self.assertFalse(output.should_continue())
self.assertIsNotNone(output.getvalue().count('???'))
sys.stdout.truncate(0)
output_api = presubmit.OutputApi(True) output_api = presubmit.OutputApi(True)
output = presubmit.PresubmitOutput(input_stream=StringIO('y')) output_api.PresubmitPromptOrNotify('???').handle()
output_api.PresubmitPromptOrNotify('???').handle(output) self.assertIsNotNone(sys.stdout.getvalue().count('???'))
output.prompt_yes_no('prompt: ')
self.assertIsNotNone(output.should_continue())
self.assertIsNotNone(output.getvalue().count('???'))
sys.stdout.truncate(0)
output_api = presubmit.OutputApi(False) output_api = presubmit.OutputApi(False)
output = presubmit.PresubmitOutput(input_stream=StringIO('y')) output_api.PresubmitPromptOrNotify('???').handle()
output_api.PresubmitPromptOrNotify('???').handle(output) self.assertIsNotNone(sys.stdout.getvalue().count('???'))
self.assertIsNotNone(output.should_continue())
self.assertIsNotNone(output.getvalue().count('???'))
output_api = presubmit.OutputApi(True)
output = presubmit.PresubmitOutput(input_stream=StringIO('\n'))
output_api.PresubmitPromptOrNotify('???').handle(output)
output.prompt_yes_no('prompt: ')
self.assertFalse(output.should_continue())
self.assertIsNotNone(output.getvalue().count('???'))
class AffectedFileUnittest(PresubmitTestsBase): class AffectedFileUnittest(PresubmitTestsBase):
@ -2526,15 +2574,15 @@ the current line as well!
if not is_committing and uncovered_files: if not is_committing and uncovered_files:
fake_db.reviewers_for.return_value = change.author_email fake_db.reviewers_for.return_value = change.author_email
output = presubmit.PresubmitOutput() results = presubmit_canned_checks.CheckOwners(
results = presubmit_canned_checks.CheckOwners(input_api, input_api, presubmit.OutputApi)
presubmit.OutputApi)
for result in results: for result in results:
result.handle(output) result.handle()
if expected_output: if expected_output:
self.assertRegexpMatches(output.getvalue(), expected_output) self.assertRegexpMatches(sys.stdout.getvalue(), expected_output)
else: else:
self.assertEqual(output.getvalue(), expected_output) self.assertEqual(sys.stdout.getvalue(), expected_output)
sys.stdout.truncate(0)
def testCannedCheckOwners_DryRun(self): def testCannedCheckOwners_DryRun(self):
response = { response = {
@ -2907,18 +2955,15 @@ the current line as well!
self.assertEqual( self.assertEqual(
presubmit.OutputApi.PresubmitPromptWarning, results[0].__class__) presubmit.OutputApi.PresubmitPromptWarning, results[0].__class__)
output = StringIO() results[0].handle()
results[0].handle(output)
self.assertIn( self.assertIn(
'bar.py --verbose (0.00s) failed\nProcess timed out after 100s', 'bar.py --verbose (0.00s) failed\nProcess timed out after 100s',
output.getvalue()) sys.stdout.getvalue())
threading.Timer.assert_called_once_with( threading.Timer.assert_called_once_with(
input_api.thread_pool.timeout, mock.ANY) input_api.thread_pool.timeout, mock.ANY)
timer_instance.start.assert_called_once_with() timer_instance.start.assert_called_once_with()
self.checkstdout('')
@mock.patch(BUILTIN_OPEN, mock.mock_open()) @mock.patch(BUILTIN_OPEN, mock.mock_open())
def testCannedRunUnitTestsPython3(self): def testCannedRunUnitTestsPython3(self):
open().readline.return_value = '#!/usr/bin/env python3' open().readline.return_value = '#!/usr/bin/env python3'

Write Preview
Loading…
Cancel
Save