Enable Gerrit support in Skia's PostUploadHook
[platform/upstream/libSkiaSharp.git] / PRESUBMIT.py
1 # Copyright (c) 2013 The Chromium Authors. All rights reserved.
2 # Use of this source code is governed by a BSD-style license that can be
3 # found in the LICENSE file.
4
5
6 """Top-level presubmit script for Skia.
7
8 See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts
9 for more details about the presubmit API built into gcl.
10 """
11
12 import collections
13 import csv
14 import fnmatch
15 import os
16 import re
17 import subprocess
18 import sys
19 import traceback
20
21
22 REVERT_CL_SUBJECT_PREFIX = 'Revert '
23
24 SKIA_TREE_STATUS_URL = 'http://skia-tree-status.appspot.com'
25
26 # Please add the complete email address here (and not just 'xyz@' or 'xyz').
27 PUBLIC_API_OWNERS = (
28     'reed@chromium.org',
29     'reed@google.com',
30     'bsalomon@chromium.org',
31     'bsalomon@google.com',
32     'djsollen@chromium.org',
33     'djsollen@google.com',
34 )
35
36 AUTHORS_FILE_NAME = 'AUTHORS'
37
38 DOCS_PREVIEW_URL = 'https://skia.org/?cl='
39 GOLD_TRYBOT_URL = 'https://gold.skia.org/search?issue='
40
41 # Path to CQ bots feature is described in https://bug.skia.org/4364
42 PATH_PREFIX_TO_EXTRA_TRYBOTS = {
43     # pylint: disable=line-too-long
44     'cmake/': 'master.client.skia.compile:Build-Mac-Clang-x86_64-Release-CMake-Trybot,Build-Ubuntu-GCC-x86_64-Release-CMake-Trybot',
45     # pylint: disable=line-too-long
46     'src/opts/': 'master.client.skia:Test-Ubuntu-GCC-GCE-CPU-AVX2-x86_64-Release-SKNX_NO_SIMD-Trybot',
47
48     'include/private/SkAtomics.h': ('master.client.skia:'
49       'Test-Ubuntu-Clang-GCE-CPU-AVX2-x86_64-Release-TSAN-Trybot,'
50       'Test-Ubuntu-Clang-Golo-GPU-GT610-x86_64-Release-TSAN-Trybot'
51     ),
52
53     # Below are examples to show what is possible with this feature.
54     # 'src/svg/': 'master1:abc;master2:def',
55     # 'src/svg/parser/': 'master3:ghi,jkl;master4:mno',
56     # 'src/image/SkImage_Base.h': 'master5:pqr,stu;master1:abc1;master2:def',
57 }
58
59
60 def _CheckChangeHasEol(input_api, output_api, source_file_filter=None):
61   """Checks that files end with atleast one \n (LF)."""
62   eof_files = []
63   for f in input_api.AffectedSourceFiles(source_file_filter):
64     contents = input_api.ReadFile(f, 'rb')
65     # Check that the file ends in atleast one newline character.
66     if len(contents) > 1 and contents[-1:] != '\n':
67       eof_files.append(f.LocalPath())
68
69   if eof_files:
70     return [output_api.PresubmitPromptWarning(
71       'These files should end in a newline character:',
72       items=eof_files)]
73   return []
74
75
76 def _PythonChecks(input_api, output_api):
77   """Run checks on any modified Python files."""
78   pylint_disabled_warnings = (
79       'F0401',  # Unable to import.
80       'E0611',  # No name in module.
81       'W0232',  # Class has no __init__ method.
82       'E1002',  # Use of super on an old style class.
83       'W0403',  # Relative import used.
84       'R0201',  # Method could be a function.
85       'E1003',  # Using class name in super.
86       'W0613',  # Unused argument.
87       'W0105',  # String statement has no effect.
88   )
89   # Run Pylint on only the modified python files. Unfortunately it still runs
90   # Pylint on the whole file instead of just the modified lines.
91   affected_python_files = []
92   for affected_file in input_api.AffectedSourceFiles(None):
93     affected_file_path = affected_file.LocalPath()
94     if affected_file_path.endswith('.py'):
95       affected_python_files.append(affected_file_path)
96   return input_api.canned_checks.RunPylint(
97       input_api, output_api,
98       disabled_warnings=pylint_disabled_warnings,
99       white_list=affected_python_files)
100
101
102 def _IfDefChecks(input_api, output_api):
103   """Ensures if/ifdef are not before includes. See skbug/3362 for details."""
104   comment_block_start_pattern = re.compile('^\s*\/\*.*$')
105   comment_block_middle_pattern = re.compile('^\s+\*.*')
106   comment_block_end_pattern = re.compile('^\s+\*\/.*$')
107   single_line_comment_pattern = re.compile('^\s*//.*$')
108   def is_comment(line):
109     return (comment_block_start_pattern.match(line) or
110             comment_block_middle_pattern.match(line) or
111             comment_block_end_pattern.match(line) or
112             single_line_comment_pattern.match(line))
113
114   empty_line_pattern = re.compile('^\s*$')
115   def is_empty_line(line):
116     return empty_line_pattern.match(line)
117
118   failing_files = []
119   for affected_file in input_api.AffectedSourceFiles(None):
120     affected_file_path = affected_file.LocalPath()
121     if affected_file_path.endswith('.cpp') or affected_file_path.endswith('.h'):
122       f = open(affected_file_path)
123       for line in f.xreadlines():
124         if is_comment(line) or is_empty_line(line):
125           continue
126         # The below will be the first real line after comments and newlines.
127         if line.startswith('#if 0 '):
128           pass
129         elif line.startswith('#if ') or line.startswith('#ifdef '):
130           failing_files.append(affected_file_path)
131         break
132
133   results = []
134   if failing_files:
135     results.append(
136         output_api.PresubmitError(
137             'The following files have #if or #ifdef before includes:\n%s\n\n'
138             'See https://bug.skia.org/3362 for why this should be fixed.' %
139                 '\n'.join(failing_files)))
140   return results
141
142
143 def _CopyrightChecks(input_api, output_api, source_file_filter=None):
144   results = []
145   year_pattern = r'\d{4}'
146   year_range_pattern = r'%s(-%s)?' % (year_pattern, year_pattern)
147   years_pattern = r'%s(,%s)*,?' % (year_range_pattern, year_range_pattern)
148   copyright_pattern = (
149       r'Copyright (\([cC]\) )?%s \w+' % years_pattern)
150
151   for affected_file in input_api.AffectedSourceFiles(source_file_filter):
152     if 'third_party' in affected_file.LocalPath():
153       continue
154     contents = input_api.ReadFile(affected_file, 'rb')
155     if not re.search(copyright_pattern, contents):
156       results.append(output_api.PresubmitError(
157           '%s is missing a correct copyright header.' % affected_file))
158   return results
159
160
161 def _ToolFlags(input_api, output_api):
162   """Make sure `{dm,nanobench}_flags.py test` passes if modified."""
163   results = []
164   sources = lambda x: ('dm_flags.py'        in x.LocalPath() or
165                        'nanobench_flags.py' in x.LocalPath())
166   for f in input_api.AffectedSourceFiles(sources):
167     if 0 != subprocess.call(['python', f.LocalPath(), 'test']):
168       results.append(output_api.PresubmitError('`python %s test` failed' % f))
169   return results
170
171
172 def _RecipeSimulationTest(input_api, output_api):
173   """Run the recipe simulation test."""
174   results = []
175   if not any(f.LocalPath().startswith('infra')
176              for f in input_api.AffectedFiles()):
177     return results
178
179   recipes_py = os.path.join('infra', 'bots', 'recipes.py')
180   cmd = ['python', recipes_py, 'simulation_test']
181   try:
182     subprocess.check_output(cmd)
183   except subprocess.CalledProcessError as e:
184     results.append(output_api.PresubmitError(
185         '`%s` failed:\n%s' % (' '.join(cmd), e.output)))
186   return results
187
188 def _CheckGNFormatted(input_api, output_api):
189   """Make sure any .gn files we're changing have been formatted."""
190   results = []
191   for f in input_api.AffectedFiles():
192     if not f.LocalPath().endswith('.gn'):
193       continue
194
195     cmd = ['gn', 'format', '--dry-run', f.LocalPath()]
196     try:
197       subprocess.check_output(cmd)
198     except subprocess.CalledProcessError:
199       fix = 'gn format ' + f.LocalPath()
200       results.append(output_api.PresubmitError(
201           '`%s` failed, try\n\t%s' % (' '.join(cmd), fix)))
202   return results
203
204
205 def _CommonChecks(input_api, output_api):
206   """Presubmit checks common to upload and commit."""
207   results = []
208   sources = lambda x: (x.LocalPath().endswith('.h') or
209                        x.LocalPath().endswith('.gypi') or
210                        x.LocalPath().endswith('.gyp') or
211                        x.LocalPath().endswith('.py') or
212                        x.LocalPath().endswith('.sh') or
213                        x.LocalPath().endswith('.m') or
214                        x.LocalPath().endswith('.mm') or
215                        x.LocalPath().endswith('.go') or
216                        x.LocalPath().endswith('.c') or
217                        x.LocalPath().endswith('.cc') or
218                        x.LocalPath().endswith('.cpp'))
219   results.extend(
220       _CheckChangeHasEol(
221           input_api, output_api, source_file_filter=sources))
222   results.extend(_PythonChecks(input_api, output_api))
223   results.extend(_IfDefChecks(input_api, output_api))
224   results.extend(_CopyrightChecks(input_api, output_api,
225                                   source_file_filter=sources))
226   results.extend(_ToolFlags(input_api, output_api))
227   return results
228
229
230 def CheckChangeOnUpload(input_api, output_api):
231   """Presubmit checks for the change on upload.
232
233   The following are the presubmit checks:
234   * Check change has one and only one EOL.
235   """
236   results = []
237   results.extend(_CommonChecks(input_api, output_api))
238   # Run on upload, not commit, since the presubmit bot apparently doesn't have
239   # coverage installed.
240   results.extend(_RecipeSimulationTest(input_api, output_api))
241   results.extend(_CheckGNFormatted(input_api, output_api))
242   return results
243
244
245 def _CheckTreeStatus(input_api, output_api, json_url):
246   """Check whether to allow commit.
247
248   Args:
249     input_api: input related apis.
250     output_api: output related apis.
251     json_url: url to download json style status.
252   """
253   tree_status_results = input_api.canned_checks.CheckTreeIsOpen(
254       input_api, output_api, json_url=json_url)
255   if not tree_status_results:
256     # Check for caution state only if tree is not closed.
257     connection = input_api.urllib2.urlopen(json_url)
258     status = input_api.json.loads(connection.read())
259     connection.close()
260     if ('caution' in status['message'].lower() and
261         os.isatty(sys.stdout.fileno())):
262       # Display a prompt only if we are in an interactive shell. Without this
263       # check the commit queue behaves incorrectly because it considers
264       # prompts to be failures.
265       short_text = 'Tree state is: ' + status['general_state']
266       long_text = status['message'] + '\n' + json_url
267       tree_status_results.append(
268           output_api.PresubmitPromptWarning(
269               message=short_text, long_text=long_text))
270   else:
271     # Tree status is closed. Put in message about contacting sheriff.
272     connection = input_api.urllib2.urlopen(
273         SKIA_TREE_STATUS_URL + '/current-sheriff')
274     sheriff_details = input_api.json.loads(connection.read())
275     if sheriff_details:
276       tree_status_results[0]._message += (
277           '\n\nPlease contact the current Skia sheriff (%s) if you are trying '
278           'to submit a build fix\nand do not know how to submit because the '
279           'tree is closed') % sheriff_details['username']
280   return tree_status_results
281
282
283 class CodeReview(object):
284   """Abstracts which codereview tool is used for the specified issue."""
285
286   def __init__(self, input_api):
287     self._issue = input_api.change.issue
288     self._gerrit = input_api.gerrit
289     self._rietveld_properties = None
290     if not self._gerrit:
291       self._rietveld_properties = input_api.rietveld.get_issue_properties(
292           issue=int(self._issue), messages=True)
293
294   def GetOwnerEmail(self):
295     if self._gerrit:
296       return self._gerrit.GetChangeOwner(self._issue)
297     else:
298       return self._rietveld_properties['owner_email']
299
300   def GetSubject(self):
301     if self._gerrit:
302       return self._gerrit.GetChangeInfo(self._issue)['subject']
303     else:
304       return self._rietveld_properties['subject']
305
306   def GetDescription(self):
307     if self._gerrit:
308       return self._gerrit.GetChangeDescription(self._issue)
309     else:
310       return self._rietveld_properties['description']
311
312   def IsDryRun(self):
313     if self._gerrit:
314       return self._gerrit.GetChangeInfo(
315           self._issue)['labels']['Commit-Queue'].get('value', 0) == 1
316     else:
317       return self._rietveld_properties['cq_dry_run']
318
319   def GetApprovers(self):
320     approvers = []
321     if self._gerrit:
322       for m in self._gerrit.GetChangeInfo(
323                    self._issue)['labels']['Code-Review']['all']:
324         if m.get("value") == 1:
325           approvers.append(m["email"])
326     else:
327       for m in self._rietveld_properties.get('messages', []):
328         if 'lgtm' in m['text'].lower():
329           approvers.append(m['sender'])
330     return approvers
331
332
333 def _CheckOwnerIsInAuthorsFile(input_api, output_api):
334   results = []
335   if input_api.change.issue:
336     cr = CodeReview(input_api)
337
338     owner_email = cr.GetOwnerEmail()
339     try:
340       authors_content = ''
341       for line in open(AUTHORS_FILE_NAME):
342         if not line.startswith('#'):
343           authors_content += line
344       email_fnmatches = re.findall('<(.*)>', authors_content)
345       for email_fnmatch in email_fnmatches:
346         if fnmatch.fnmatch(owner_email, email_fnmatch):
347           # Found a match, the user is in the AUTHORS file break out of the loop
348           break
349       else:
350         results.append(
351           output_api.PresubmitError(
352             'The email %s is not in Skia\'s AUTHORS file.\n'
353             'Issue owner, this CL must include an addition to the Skia AUTHORS '
354             'file.'
355             % owner_email))
356     except IOError:
357       # Do not fail if authors file cannot be found.
358       traceback.print_exc()
359       input_api.logging.error('AUTHORS file not found!')
360
361   return results
362
363
364 def _CheckLGTMsForPublicAPI(input_api, output_api):
365   """Check LGTMs for public API changes.
366
367   For public API files make sure there is an LGTM from the list of owners in
368   PUBLIC_API_OWNERS.
369   """
370   results = []
371   requires_owner_check = False
372   for affected_file in input_api.AffectedFiles():
373     affected_file_path = affected_file.LocalPath()
374     file_path, file_ext = os.path.splitext(affected_file_path)
375     # We only care about files that end in .h and are under the top-level
376     # include dir, but not include/private.
377     if (file_ext == '.h' and
378         'include' == file_path.split(os.path.sep)[0] and
379         'private' not in file_path):
380       requires_owner_check = True
381
382   if not requires_owner_check:
383     return results
384
385   lgtm_from_owner = False
386   if input_api.change.issue:
387     cr = CodeReview(input_api)
388
389     if re.match(REVERT_CL_SUBJECT_PREFIX, cr.GetSubject(), re.I):
390       # It is a revert CL, ignore the public api owners check.
391       return results
392
393     if cr.IsDryRun():
394       # Ignore public api owners check for dry run CLs since they are not
395       # going to be committed.
396       return results
397
398     match = re.search(r'^TBR=(.*)$', cr.GetDescription(), re.M)
399     if match:
400       tbr_entries = match.group(1).strip().split(',')
401       for owner in PUBLIC_API_OWNERS:
402         if owner in tbr_entries or owner.split('@')[0] in tbr_entries:
403           # If an owner is specified in the TBR= line then ignore the public
404           # api owners check.
405           return results
406
407     if cr.GetOwnerEmail() in PUBLIC_API_OWNERS:
408       # An owner created the CL that is an automatic LGTM.
409       lgtm_from_owner = True
410
411     for approver in cr.GetApprovers():
412       if approver in PUBLIC_API_OWNERS:
413         # Found an lgtm in a message from an owner.
414         lgtm_from_owner = True
415         break
416
417   if not lgtm_from_owner:
418     results.append(
419         output_api.PresubmitError(
420             "If this CL adds to or changes Skia's public API, you need an LGTM "
421             "from any of %s.  If this CL only removes from or doesn't change "
422             "Skia's public API, please add a short note to the CL saying so "
423             "and add one of those reviewers on a TBR= line.  If you don't know "
424             "if this CL affects Skia's public API, treat it like it does."
425             % str(PUBLIC_API_OWNERS)))
426   return results
427
428
429 def PostUploadHook(cl, change, output_api):
430   """git cl upload will call this hook after the issue is created/modified.
431
432   This hook does the following:
433   * Adds a link to the CL's Gold trybot results.
434   * Adds a link to preview docs changes if there are any docs changes in the CL.
435   * Adds 'NOTRY=true' if the CL contains only docs changes.
436   * Adds 'NOTREECHECKS=true' for non master branch changes since they do not
437     need to be gated on the master branch's tree.
438   * Adds 'NOTRY=true' for non master branch changes since trybots do not yet
439     work on them.
440   * Adds 'NOPRESUBMIT=true' for non master branch changes since those don't
441     run the presubmit checks.
442   * Adds extra trybots for the paths defined in PATH_TO_EXTRA_TRYBOTS.
443   """
444
445   results = []
446   atleast_one_docs_change = False
447   all_docs_changes = True
448   for affected_file in change.AffectedFiles():
449     affected_file_path = affected_file.LocalPath()
450     file_path, _ = os.path.splitext(affected_file_path)
451     if 'site' == file_path.split(os.path.sep)[0]:
452       atleast_one_docs_change = True
453     else:
454       all_docs_changes = False
455     if atleast_one_docs_change and not all_docs_changes:
456       break
457
458   issue = cl.issue
459   if issue:
460     original_description = cl.GetDescription()
461     new_description = original_description
462
463     # Add GOLD_TRYBOT_URL if it does not exist yet.
464     if not re.search(r'^GOLD_TRYBOT_URL=', new_description, re.M | re.I):
465       new_description += '\nGOLD_TRYBOT_URL= %s%s' % (GOLD_TRYBOT_URL, issue)
466       results.append(
467           output_api.PresubmitNotifyResult(
468               'Added link to Gold trybot runs to the CL\'s description.\n'
469               'Note: Results may take sometime to be populated after trybots '
470               'complete.'))
471
472     # If the change includes only doc changes then add NOTRY=true in the
473     # CL's description if it does not exist yet.
474     if all_docs_changes and not re.search(
475         r'^NOTRY=true$', new_description, re.M | re.I):
476       new_description += '\nNOTRY=true'
477       results.append(
478           output_api.PresubmitNotifyResult(
479               'This change has only doc changes. Automatically added '
480               '\'NOTRY=true\' to the CL\'s description'))
481
482     # If there is atleast one docs change then add preview link in the CL's
483     # description if it does not already exist there.
484     if atleast_one_docs_change and not re.search(
485         r'^DOCS_PREVIEW=.*', new_description, re.M | re.I):
486       # Automatically add a link to where the docs can be previewed.
487       new_description += '\nDOCS_PREVIEW= %s%s' % (DOCS_PREVIEW_URL, issue)
488       results.append(
489           output_api.PresubmitNotifyResult(
490               'Automatically added a link to preview the docs changes to the '
491               'CL\'s description'))
492
493     # If the target ref is not master then add NOTREECHECKS=true and NOTRY=true
494     # to the CL's description if it does not already exist there.
495     target_ref = cl.GetRemoteBranch()[1]
496     if target_ref != 'refs/remotes/origin/master':
497       if not re.search(
498           r'^NOTREECHECKS=true$', new_description, re.M | re.I):
499         new_description += "\nNOTREECHECKS=true"
500         results.append(
501             output_api.PresubmitNotifyResult(
502                 'Branch changes do not need to rely on the master branch\'s '
503                 'tree status. Automatically added \'NOTREECHECKS=true\' to the '
504                 'CL\'s description'))
505       if not re.search(
506           r'^NOTRY=true$', new_description, re.M | re.I):
507         new_description += "\nNOTRY=true"
508         results.append(
509             output_api.PresubmitNotifyResult(
510                 'Trybots do not yet work for non-master branches. '
511                 'Automatically added \'NOTRY=true\' to the CL\'s description'))
512       if not re.search(
513           r'^NOPRESUBMIT=true$', new_description, re.M | re.I):
514         new_description += "\nNOPRESUBMIT=true"
515         results.append(
516             output_api.PresubmitNotifyResult(
517                 'Branch changes do not run the presubmit checks.'))
518
519     # Automatically set CQ_INCLUDE_TRYBOTS if any of the changed files here
520     # begin with the paths of interest.
521     cq_master_to_trybots = collections.defaultdict(set)
522     for affected_file in change.AffectedFiles():
523       affected_file_path = affected_file.LocalPath()
524       for path_prefix, extra_bots in PATH_PREFIX_TO_EXTRA_TRYBOTS.iteritems():
525         if affected_file_path.startswith(path_prefix):
526           results.append(
527               output_api.PresubmitNotifyResult(
528                   'Your CL modifies the path %s.\nAutomatically adding %s to '
529                   'the CL description.' % (affected_file_path, extra_bots)))
530           _MergeCQExtraTrybotsMaps(
531               cq_master_to_trybots, _GetCQExtraTrybotsMap(extra_bots))
532     if cq_master_to_trybots:
533       new_description = _AddCQExtraTrybotsToDesc(
534           cq_master_to_trybots, new_description)
535
536     # If the description has changed update it.
537     if new_description != original_description:
538       cl.UpdateDescription(new_description)
539
540     return results
541
542
543 def _AddCQExtraTrybotsToDesc(cq_master_to_trybots, description):
544   """Adds the specified master and trybots to the CQ_INCLUDE_TRYBOTS keyword.
545
546   If the keyword already exists in the description then it appends to it only
547   if the specified values do not already exist.
548   If the keyword does not exist then it creates a new section in the
549   description.
550   """
551   match = re.search(r'^CQ_INCLUDE_TRYBOTS=(.*)$', description, re.M | re.I)
552   if match:
553     original_trybots_map = _GetCQExtraTrybotsMap(match.group(1))
554     _MergeCQExtraTrybotsMaps(cq_master_to_trybots, original_trybots_map)
555     new_description = description.replace(
556         match.group(0), _GetCQExtraTrybotsStr(cq_master_to_trybots))
557   else:
558     new_description = description + "\n%s" % (
559         _GetCQExtraTrybotsStr(cq_master_to_trybots))
560   return new_description
561
562
563 def _MergeCQExtraTrybotsMaps(dest_map, map_to_be_consumed):
564   """Merges two maps of masters to trybots into one."""
565   for master, trybots in map_to_be_consumed.iteritems():
566     dest_map[master].update(trybots)
567   return dest_map
568
569
570 def _GetCQExtraTrybotsMap(cq_extra_trybots_str):
571   """Parses CQ_INCLUDE_TRYBOTS str and returns a map of masters to trybots."""
572   cq_master_to_trybots = collections.defaultdict(set)
573   for section in cq_extra_trybots_str.split(';'):
574     if section:
575       master, bots = section.split(':')
576       cq_master_to_trybots[master].update(bots.split(','))
577   return cq_master_to_trybots
578
579
580 def _GetCQExtraTrybotsStr(cq_master_to_trybots):
581   """Constructs the CQ_INCLUDE_TRYBOTS str from a map of masters to trybots."""
582   sections = []
583   for master, trybots in cq_master_to_trybots.iteritems():
584     sections.append('%s:%s' % (master, ','.join(trybots)))
585   return 'CQ_INCLUDE_TRYBOTS=%s' % ';'.join(sections)
586
587
588 def CheckChangeOnCommit(input_api, output_api):
589   """Presubmit checks for the change on commit.
590
591   The following are the presubmit checks:
592   * Check change has one and only one EOL.
593   * Ensures that the Skia tree is open in
594     http://skia-tree-status.appspot.com/. Shows a warning if it is in 'Caution'
595     state and an error if it is in 'Closed' state.
596   """
597   results = []
598   results.extend(_CommonChecks(input_api, output_api))
599   results.extend(
600       _CheckTreeStatus(input_api, output_api, json_url=(
601           SKIA_TREE_STATUS_URL + '/banner-status?format=json')))
602   results.extend(_CheckLGTMsForPublicAPI(input_api, output_api))
603   results.extend(_CheckOwnerIsInAuthorsFile(input_api, output_api))
604   return results