blob: 9695b8208c9f594263c4ec171f6012973c2c714b [file] [log] [blame]
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +00001# 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
8See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts
9for more details about the presubmit API built into gcl.
10"""
11
rmistry58276532015-10-01 08:24:03 -070012import collections
rmistry3cfd1ad2015-03-25 12:53:35 -070013import csv
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +000014import fnmatch
rmistry@google.comf6c5f752013-03-29 17:26:00 +000015import os
commit-bot@chromium.orgcfdc5962014-01-31 17:33:04 +000016import re
rmistryd223fb22015-02-26 10:16:13 -080017import subprocess
rmistry@google.comf6c5f752013-03-29 17:26:00 +000018import sys
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +000019import traceback
rmistry@google.comf6c5f752013-03-29 17:26:00 +000020
rmistry@google.comc2993442013-01-23 14:35:58 +000021
commit-bot@chromium.orgcfdc5962014-01-31 17:33:04 +000022REVERT_CL_SUBJECT_PREFIX = 'Revert '
23
rmistry@google.com547012d2013-04-12 19:45:46 +000024SKIA_TREE_STATUS_URL = 'http://skia-tree-status.appspot.com'
25
rmistryf2d83ca2014-08-26 10:30:29 -070026# Please add the complete email address here (and not just 'xyz@' or 'xyz').
rmistry@google.comfb4a68d2013-08-12 14:51:20 +000027PUBLIC_API_OWNERS = (
28 'reed@chromium.org',
29 'reed@google.com',
30 'bsalomon@chromium.org',
31 'bsalomon@google.com',
rmistry83fab472014-07-18 05:25:56 -070032 'djsollen@chromium.org',
33 'djsollen@google.com',
Ravi Mistryfbff3292017-01-19 12:00:08 -050034 'hcm@chromium.org',
35 'hcm@google.com',
rmistry@google.comfb4a68d2013-08-12 14:51:20 +000036)
37
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +000038AUTHORS_FILE_NAME = 'AUTHORS'
39
rmistryd223fb22015-02-26 10:16:13 -080040DOCS_PREVIEW_URL = 'https://skia.org/?cl='
rmistryd88b0be2016-05-20 03:50:01 -070041GOLD_TRYBOT_URL = 'https://gold.skia.org/search?issue='
rmistryd223fb22015-02-26 10:16:13 -080042
halcanary6950de62015-11-07 05:29:00 -080043# Path to CQ bots feature is described in https://bug.skia.org/4364
rmistry58276532015-10-01 08:24:03 -070044PATH_PREFIX_TO_EXTRA_TRYBOTS = {
Eric Boren50831302016-11-18 13:10:51 -050045 'src/opts/':
46 'skia.primary:Test-Ubuntu-GCC-GCE-CPU-AVX2-x86_64-Release-SKNX_NO_SIMD',
47 'include/private/SkAtomics.h': ('skia.primary:'
48 'Test-Ubuntu-Clang-GCE-CPU-AVX2-x86_64-Release-TSAN,'
mtklein04fff632016-08-31 12:43:14 -070049 'Test-Ubuntu-Clang-Golo-GPU-GT610-x86_64-Release-TSAN-Trybot'
mtkleinab8296b2015-10-07 11:49:00 -070050 ),
51
rmistry58276532015-10-01 08:24:03 -070052 # Below are examples to show what is possible with this feature.
53 # 'src/svg/': 'master1:abc;master2:def',
54 # 'src/svg/parser/': 'master3:ghi,jkl;master4:mno',
55 # 'src/image/SkImage_Base.h': 'master5:pqr,stu;master1:abc1;master2:def',
56}
57
rmistry@google.com547012d2013-04-12 19:45:46 +000058
rmistry@google.com713276b2013-01-25 18:27:34 +000059def _CheckChangeHasEol(input_api, output_api, source_file_filter=None):
60 """Checks that files end with atleast one \n (LF)."""
61 eof_files = []
62 for f in input_api.AffectedSourceFiles(source_file_filter):
63 contents = input_api.ReadFile(f, 'rb')
64 # Check that the file ends in atleast one newline character.
65 if len(contents) > 1 and contents[-1:] != '\n':
66 eof_files.append(f.LocalPath())
67
68 if eof_files:
69 return [output_api.PresubmitPromptWarning(
70 'These files should end in a newline character:',
71 items=eof_files)]
72 return []
73
74
Eric Borenbb0ef0a2014-06-25 11:13:27 -040075def _PythonChecks(input_api, output_api):
76 """Run checks on any modified Python files."""
77 pylint_disabled_warnings = (
78 'F0401', # Unable to import.
79 'E0611', # No name in module.
80 'W0232', # Class has no __init__ method.
81 'E1002', # Use of super on an old style class.
82 'W0403', # Relative import used.
83 'R0201', # Method could be a function.
84 'E1003', # Using class name in super.
85 'W0613', # Unused argument.
borenetd9fa7582016-02-18 08:05:48 -080086 'W0105', # String statement has no effect.
Eric Borenbb0ef0a2014-06-25 11:13:27 -040087 )
88 # Run Pylint on only the modified python files. Unfortunately it still runs
89 # Pylint on the whole file instead of just the modified lines.
90 affected_python_files = []
91 for affected_file in input_api.AffectedSourceFiles(None):
92 affected_file_path = affected_file.LocalPath()
93 if affected_file_path.endswith('.py'):
94 affected_python_files.append(affected_file_path)
95 return input_api.canned_checks.RunPylint(
96 input_api, output_api,
97 disabled_warnings=pylint_disabled_warnings,
98 white_list=affected_python_files)
99
100
rmistry01cbf6c2015-03-12 07:48:40 -0700101def _IfDefChecks(input_api, output_api):
102 """Ensures if/ifdef are not before includes. See skbug/3362 for details."""
103 comment_block_start_pattern = re.compile('^\s*\/\*.*$')
104 comment_block_middle_pattern = re.compile('^\s+\*.*')
105 comment_block_end_pattern = re.compile('^\s+\*\/.*$')
106 single_line_comment_pattern = re.compile('^\s*//.*$')
107 def is_comment(line):
108 return (comment_block_start_pattern.match(line) or
109 comment_block_middle_pattern.match(line) or
110 comment_block_end_pattern.match(line) or
111 single_line_comment_pattern.match(line))
112
113 empty_line_pattern = re.compile('^\s*$')
114 def is_empty_line(line):
115 return empty_line_pattern.match(line)
116
117 failing_files = []
118 for affected_file in input_api.AffectedSourceFiles(None):
119 affected_file_path = affected_file.LocalPath()
120 if affected_file_path.endswith('.cpp') or affected_file_path.endswith('.h'):
121 f = open(affected_file_path)
122 for line in f.xreadlines():
123 if is_comment(line) or is_empty_line(line):
124 continue
125 # The below will be the first real line after comments and newlines.
126 if line.startswith('#if 0 '):
127 pass
128 elif line.startswith('#if ') or line.startswith('#ifdef '):
129 failing_files.append(affected_file_path)
130 break
131
132 results = []
133 if failing_files:
134 results.append(
135 output_api.PresubmitError(
136 'The following files have #if or #ifdef before includes:\n%s\n\n'
halcanary6950de62015-11-07 05:29:00 -0800137 'See https://bug.skia.org/3362 for why this should be fixed.' %
rmistry01cbf6c2015-03-12 07:48:40 -0700138 '\n'.join(failing_files)))
139 return results
140
141
borenetc7c91802015-03-25 04:47:02 -0700142def _CopyrightChecks(input_api, output_api, source_file_filter=None):
143 results = []
144 year_pattern = r'\d{4}'
145 year_range_pattern = r'%s(-%s)?' % (year_pattern, year_pattern)
146 years_pattern = r'%s(,%s)*,?' % (year_range_pattern, year_range_pattern)
147 copyright_pattern = (
148 r'Copyright (\([cC]\) )?%s \w+' % years_pattern)
149
150 for affected_file in input_api.AffectedSourceFiles(source_file_filter):
151 if 'third_party' in affected_file.LocalPath():
152 continue
153 contents = input_api.ReadFile(affected_file, 'rb')
154 if not re.search(copyright_pattern, contents):
155 results.append(output_api.PresubmitError(
156 '%s is missing a correct copyright header.' % affected_file))
157 return results
158
159
mtkleine4b19c42015-05-05 10:28:44 -0700160def _ToolFlags(input_api, output_api):
161 """Make sure `{dm,nanobench}_flags.py test` passes if modified."""
162 results = []
163 sources = lambda x: ('dm_flags.py' in x.LocalPath() or
164 'nanobench_flags.py' in x.LocalPath())
165 for f in input_api.AffectedSourceFiles(sources):
166 if 0 != subprocess.call(['python', f.LocalPath(), 'test']):
167 results.append(output_api.PresubmitError('`python %s test` failed' % f))
168 return results
169
170
borenet2dbbfa52016-10-14 06:32:09 -0700171def _InfraTests(input_api, output_api):
172 """Run the infra tests."""
borenet1ed2ae42016-07-26 11:52:17 -0700173 results = []
mtklein3da80f52016-07-27 04:14:07 -0700174 if not any(f.LocalPath().startswith('infra')
175 for f in input_api.AffectedFiles()):
176 return results
177
borenet2dbbfa52016-10-14 06:32:09 -0700178 cmd = ['python', os.path.join('infra', 'bots', 'infra_tests.py')]
borenet60b0a2d2016-10-04 12:45:41 -0700179 try:
180 subprocess.check_output(cmd)
181 except subprocess.CalledProcessError as e:
182 results.append(output_api.PresubmitError(
183 '`%s` failed:\n%s' % (' '.join(cmd), e.output)))
184 return results
185
186
mtklein4db3b792016-08-03 14:18:22 -0700187def _CheckGNFormatted(input_api, output_api):
188 """Make sure any .gn files we're changing have been formatted."""
189 results = []
190 for f in input_api.AffectedFiles():
Mike Kleina5fb6152016-10-26 14:17:04 -0400191 if (not f.LocalPath().endswith('.gn') and
192 not f.LocalPath().endswith('.gni')):
mtklein4db3b792016-08-03 14:18:22 -0700193 continue
194
Mike Klein7a1c53d2016-10-11 14:03:06 -0400195 gn = 'gn.bat' if 'win32' in sys.platform else 'gn'
196 cmd = [gn, 'format', '--dry-run', f.LocalPath()]
mtklein4db3b792016-08-03 14:18:22 -0700197 try:
198 subprocess.check_output(cmd)
199 except subprocess.CalledProcessError:
mtkleind434b012016-08-10 07:30:58 -0700200 fix = 'gn format ' + f.LocalPath()
mtklein4db3b792016-08-03 14:18:22 -0700201 results.append(output_api.PresubmitError(
mtkleind434b012016-08-10 07:30:58 -0700202 '`%s` failed, try\n\t%s' % (' '.join(cmd), fix)))
mtklein4db3b792016-08-03 14:18:22 -0700203 return results
204
borenet1ed2ae42016-07-26 11:52:17 -0700205
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000206def _CommonChecks(input_api, output_api):
207 """Presubmit checks common to upload and commit."""
208 results = []
209 sources = lambda x: (x.LocalPath().endswith('.h') or
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000210 x.LocalPath().endswith('.py') or
211 x.LocalPath().endswith('.sh') or
mtklein18e55802015-03-25 07:21:20 -0700212 x.LocalPath().endswith('.m') or
213 x.LocalPath().endswith('.mm') or
214 x.LocalPath().endswith('.go') or
215 x.LocalPath().endswith('.c') or
216 x.LocalPath().endswith('.cc') or
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000217 x.LocalPath().endswith('.cpp'))
218 results.extend(
rmistry@google.com713276b2013-01-25 18:27:34 +0000219 _CheckChangeHasEol(
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000220 input_api, output_api, source_file_filter=sources))
Eric Borenbb0ef0a2014-06-25 11:13:27 -0400221 results.extend(_PythonChecks(input_api, output_api))
rmistry01cbf6c2015-03-12 07:48:40 -0700222 results.extend(_IfDefChecks(input_api, output_api))
borenetc7c91802015-03-25 04:47:02 -0700223 results.extend(_CopyrightChecks(input_api, output_api,
224 source_file_filter=sources))
mtkleine4b19c42015-05-05 10:28:44 -0700225 results.extend(_ToolFlags(input_api, output_api))
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000226 return results
227
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000228
229def CheckChangeOnUpload(input_api, output_api):
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000230 """Presubmit checks for the change on upload.
231
232 The following are the presubmit checks:
233 * Check change has one and only one EOL.
234 """
235 results = []
236 results.extend(_CommonChecks(input_api, output_api))
borenet1ed2ae42016-07-26 11:52:17 -0700237 # Run on upload, not commit, since the presubmit bot apparently doesn't have
borenet60b0a2d2016-10-04 12:45:41 -0700238 # coverage or Go installed.
borenet2dbbfa52016-10-14 06:32:09 -0700239 results.extend(_InfraTests(input_api, output_api))
borenet60b0a2d2016-10-04 12:45:41 -0700240
mtklein4db3b792016-08-03 14:18:22 -0700241 results.extend(_CheckGNFormatted(input_api, output_api))
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000242 return results
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000243
244
rmistry@google.comc2993442013-01-23 14:35:58 +0000245def _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()
rmistry@google.comf6c5f752013-03-29 17:26:00 +0000260 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.
rmistry@google.comc2993442013-01-23 14:35:58 +0000265 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))
rmistry@google.com547012d2013-04-12 19:45:46 +0000270 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']
rmistry@google.comc2993442013-01-23 14:35:58 +0000280 return tree_status_results
281
282
rmistryb398ecc2016-08-29 08:13:29 -0700283class 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
Ravi Mistry39eabb62016-10-05 08:41:12 -0400319 def GetReviewers(self):
320 if self._gerrit:
321 code_review_label = (
322 self._gerrit.GetChangeInfo(self._issue)['labels']['Code-Review'])
323 return [r['email'] for r in code_review_label.get('all', [])]
324 else:
325 return self._rietveld_properties['reviewers']
326
rmistryb398ecc2016-08-29 08:13:29 -0700327 def GetApprovers(self):
328 approvers = []
329 if self._gerrit:
Ravi Mistry39eabb62016-10-05 08:41:12 -0400330 code_review_label = (
331 self._gerrit.GetChangeInfo(self._issue)['labels']['Code-Review'])
332 for m in code_review_label.get('all', []):
rmistryb398ecc2016-08-29 08:13:29 -0700333 if m.get("value") == 1:
334 approvers.append(m["email"])
335 else:
336 for m in self._rietveld_properties.get('messages', []):
337 if 'lgtm' in m['text'].lower():
338 approvers.append(m['sender'])
339 return approvers
340
341
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000342def _CheckOwnerIsInAuthorsFile(input_api, output_api):
343 results = []
rmistryb398ecc2016-08-29 08:13:29 -0700344 if input_api.change.issue:
345 cr = CodeReview(input_api)
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000346
rmistryb398ecc2016-08-29 08:13:29 -0700347 owner_email = cr.GetOwnerEmail()
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000348 try:
349 authors_content = ''
350 for line in open(AUTHORS_FILE_NAME):
351 if not line.startswith('#'):
352 authors_content += line
353 email_fnmatches = re.findall('<(.*)>', authors_content)
354 for email_fnmatch in email_fnmatches:
355 if fnmatch.fnmatch(owner_email, email_fnmatch):
356 # Found a match, the user is in the AUTHORS file break out of the loop
357 break
358 else:
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000359 results.append(
360 output_api.PresubmitError(
361 'The email %s is not in Skia\'s AUTHORS file.\n'
362 'Issue owner, this CL must include an addition to the Skia AUTHORS '
rmistry9806d4d2015-10-01 08:10:54 -0700363 'file.'
rmistry83fab472014-07-18 05:25:56 -0700364 % owner_email))
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000365 except IOError:
366 # Do not fail if authors file cannot be found.
367 traceback.print_exc()
368 input_api.logging.error('AUTHORS file not found!')
369
370 return results
371
372
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000373def _CheckLGTMsForPublicAPI(input_api, output_api):
374 """Check LGTMs for public API changes.
375
376 For public API files make sure there is an LGTM from the list of owners in
377 PUBLIC_API_OWNERS.
378 """
379 results = []
380 requires_owner_check = False
rmistry9407ece2014-08-26 14:00:54 -0700381 for affected_file in input_api.AffectedFiles():
382 affected_file_path = affected_file.LocalPath()
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000383 file_path, file_ext = os.path.splitext(affected_file_path)
rmistry9407ece2014-08-26 14:00:54 -0700384 # We only care about files that end in .h and are under the top-level
mtkleinbda12672015-07-28 08:54:12 -0700385 # include dir, but not include/private.
386 if (file_ext == '.h' and
387 'include' == file_path.split(os.path.sep)[0] and
388 'private' not in file_path):
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000389 requires_owner_check = True
390
391 if not requires_owner_check:
392 return results
393
394 lgtm_from_owner = False
rmistryb398ecc2016-08-29 08:13:29 -0700395 if input_api.change.issue:
396 cr = CodeReview(input_api)
397
398 if re.match(REVERT_CL_SUBJECT_PREFIX, cr.GetSubject(), re.I):
commit-bot@chromium.orgcfdc5962014-01-31 17:33:04 +0000399 # It is a revert CL, ignore the public api owners check.
400 return results
rmistryf2d83ca2014-08-26 10:30:29 -0700401
rmistryb398ecc2016-08-29 08:13:29 -0700402 if cr.IsDryRun():
rmistry04abf132015-04-07 07:41:51 -0700403 # Ignore public api owners check for dry run CLs since they are not
rmistryf91b7172015-03-12 09:48:10 -0700404 # going to be committed.
405 return results
406
Ravi Mistry39eabb62016-10-05 08:41:12 -0400407 if input_api.gerrit:
408 for reviewer in cr.GetReviewers():
409 if reviewer in PUBLIC_API_OWNERS:
410 # If an owner is specified as an reviewer in Gerrit then ignore the
411 # public api owners check.
rmistryf2d83ca2014-08-26 10:30:29 -0700412 return results
Ravi Mistry39eabb62016-10-05 08:41:12 -0400413 else:
414 match = re.search(r'^TBR=(.*)$', cr.GetDescription(), re.M)
415 if match:
416 tbr_section = match.group(1).strip().split(' ')[0]
417 tbr_entries = tbr_section.split(',')
418 for owner in PUBLIC_API_OWNERS:
419 if owner in tbr_entries or owner.split('@')[0] in tbr_entries:
420 # If an owner is specified in the TBR= line then ignore the public
421 # api owners check.
422 return results
rmistryf2d83ca2014-08-26 10:30:29 -0700423
rmistryb398ecc2016-08-29 08:13:29 -0700424 if cr.GetOwnerEmail() in PUBLIC_API_OWNERS:
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000425 # An owner created the CL that is an automatic LGTM.
426 lgtm_from_owner = True
427
rmistryb398ecc2016-08-29 08:13:29 -0700428 for approver in cr.GetApprovers():
429 if approver in PUBLIC_API_OWNERS:
430 # Found an lgtm in a message from an owner.
431 lgtm_from_owner = True
432 break
commit-bot@chromium.orgcfdc5962014-01-31 17:33:04 +0000433
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000434 if not lgtm_from_owner:
435 results.append(
436 output_api.PresubmitError(
mtkleinbda12672015-07-28 08:54:12 -0700437 "If this CL adds to or changes Skia's public API, you need an LGTM "
438 "from any of %s. If this CL only removes from or doesn't change "
Ravi Mistrydbb84c22016-10-05 12:47:44 -0400439 "Skia's public API, please add a short note to the CL saying so. "
440 "Add one of the owners as a reviewer to your CL. For Rietveld CLs "
441 "you also need to add one of those owners on a TBR= line. If you "
442 "don't know if this CL affects Skia's public API, treat it like it "
443 "does." % str(PUBLIC_API_OWNERS)))
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000444 return results
445
446
Ravi Mistry355feab2017-05-23 14:24:08 -0400447def _FooterExists(footers, key, value):
448 for k, v in footers:
449 if k == key and v == value:
450 return True
451 return False
452
453
rmistryd223fb22015-02-26 10:16:13 -0800454def PostUploadHook(cl, change, output_api):
455 """git cl upload will call this hook after the issue is created/modified.
456
457 This hook does the following:
458 * Adds a link to preview docs changes if there are any docs changes in the CL.
Ravi Mistry355feab2017-05-23 14:24:08 -0400459 * Adds 'No-Try: true' if the CL contains only docs changes.
460 * Adds 'No-Tree-Checks: true' for non master branch changes since they do not
rmistry896f3932015-02-26 11:52:05 -0800461 need to be gated on the master branch's tree.
Ravi Mistry355feab2017-05-23 14:24:08 -0400462 * Adds 'No-Try: true' for non master branch changes since trybots do not yet
rmistry896f3932015-02-26 11:52:05 -0800463 work on them.
Ravi Mistry355feab2017-05-23 14:24:08 -0400464 * Adds 'No-Presubmit: true' for non master branch changes since those don't
borenetaf6005c2015-06-04 15:15:42 -0700465 run the presubmit checks.
rmistry58276532015-10-01 08:24:03 -0700466 * Adds extra trybots for the paths defined in PATH_TO_EXTRA_TRYBOTS.
rmistryd223fb22015-02-26 10:16:13 -0800467 """
468
469 results = []
470 atleast_one_docs_change = False
471 all_docs_changes = True
472 for affected_file in change.AffectedFiles():
473 affected_file_path = affected_file.LocalPath()
474 file_path, _ = os.path.splitext(affected_file_path)
475 if 'site' == file_path.split(os.path.sep)[0]:
476 atleast_one_docs_change = True
477 else:
478 all_docs_changes = False
479 if atleast_one_docs_change and not all_docs_changes:
480 break
481
482 issue = cl.issue
rmistryb9a9e872016-09-01 09:52:32 -0700483 if issue:
Eric Borenbf17eec2017-04-03 08:30:35 -0400484 original_description_lines, footers = cl.GetDescriptionFooters()
485 new_description_lines = list(original_description_lines)
rmistryd223fb22015-02-26 10:16:13 -0800486
Ravi Mistry355feab2017-05-23 14:24:08 -0400487 # If the change includes only doc changes then add No-Try: true in the
rmistryd223fb22015-02-26 10:16:13 -0800488 # CL's description if it does not exist yet.
Ravi Mistry355feab2017-05-23 14:24:08 -0400489 if all_docs_changes and not _FooterExists(footers, 'No-Try', 'true'):
490 new_description_lines.append('No-Try: true')
rmistryd223fb22015-02-26 10:16:13 -0800491 results.append(
492 output_api.PresubmitNotifyResult(
493 'This change has only doc changes. Automatically added '
Ravi Mistry355feab2017-05-23 14:24:08 -0400494 '\'No-Try: true\' to the CL\'s description'))
rmistryd223fb22015-02-26 10:16:13 -0800495
496 # If there is atleast one docs change then add preview link in the CL's
497 # description if it does not already exist there.
Ravi Mistry355feab2017-05-23 14:24:08 -0400498 docs_preview_link = '%s%s' % (DOCS_PREVIEW_URL, issue)
499 docs_preview_line = 'Docs-Preview: %s' % docs_preview_link
Eric Borenbf17eec2017-04-03 08:30:35 -0400500 if (atleast_one_docs_change and
Ravi Mistry355feab2017-05-23 14:24:08 -0400501 not _FooterExists(footers, 'Docs-Preview', docs_preview_link)):
rmistryd223fb22015-02-26 10:16:13 -0800502 # Automatically add a link to where the docs can be previewed.
Eric Borenbf17eec2017-04-03 08:30:35 -0400503 new_description_lines.append(docs_preview_line)
rmistryd223fb22015-02-26 10:16:13 -0800504 results.append(
505 output_api.PresubmitNotifyResult(
506 'Automatically added a link to preview the docs changes to the '
507 'CL\'s description'))
508
Ravi Mistry355feab2017-05-23 14:24:08 -0400509 # If the target ref is not master then add 'No-Tree-Checks: true' and
510 # 'No-Try: true' to the CL's description if it does not already exist there.
rmistryb9a9e872016-09-01 09:52:32 -0700511 target_ref = cl.GetRemoteBranch()[1]
512 if target_ref != 'refs/remotes/origin/master':
Ravi Mistry355feab2017-05-23 14:24:08 -0400513 if not _FooterExists(footers, 'No-Tree-Checks', 'true'):
514 new_description_lines.append('No-Tree-Checks: true')
rmistry896f3932015-02-26 11:52:05 -0800515 results.append(
516 output_api.PresubmitNotifyResult(
517 'Branch changes do not need to rely on the master branch\'s '
Ravi Mistry355feab2017-05-23 14:24:08 -0400518 'tree status. Automatically added \'No-Tree-Checks: true\' to '
519 'the CL\'s description'))
520 if not _FooterExists(footers, 'No-Try', 'true'):
521 new_description_lines.append('No-Try: true')
rmistry896f3932015-02-26 11:52:05 -0800522 results.append(
523 output_api.PresubmitNotifyResult(
524 'Trybots do not yet work for non-master branches. '
Ravi Mistry355feab2017-05-23 14:24:08 -0400525 'Automatically added \'No-Try: true\' to the CL\'s '
526 'description'))
527 if not _FooterExists(footers, 'No-Presubmit', 'true'):
528 new_description_lines.append('No-Presubmit: true')
borenetaf6005c2015-06-04 15:15:42 -0700529 results.append(
530 output_api.PresubmitNotifyResult(
531 'Branch changes do not run the presubmit checks.'))
rmistry896f3932015-02-26 11:52:05 -0800532
rmistry3b3ee202016-07-11 08:27:49 -0700533 # Automatically set CQ_INCLUDE_TRYBOTS if any of the changed files here
534 # begin with the paths of interest.
rmistry58276532015-10-01 08:24:03 -0700535 cq_master_to_trybots = collections.defaultdict(set)
536 for affected_file in change.AffectedFiles():
537 affected_file_path = affected_file.LocalPath()
538 for path_prefix, extra_bots in PATH_PREFIX_TO_EXTRA_TRYBOTS.iteritems():
539 if affected_file_path.startswith(path_prefix):
540 results.append(
541 output_api.PresubmitNotifyResult(
542 'Your CL modifies the path %s.\nAutomatically adding %s to '
543 'the CL description.' % (affected_file_path, extra_bots)))
544 _MergeCQExtraTrybotsMaps(
545 cq_master_to_trybots, _GetCQExtraTrybotsMap(extra_bots))
546 if cq_master_to_trybots:
Eric Borenbf17eec2017-04-03 08:30:35 -0400547 _AddCQExtraTrybotsToDesc(cq_master_to_trybots, new_description_lines)
rmistry896f3932015-02-26 11:52:05 -0800548
rmistryd223fb22015-02-26 10:16:13 -0800549 # If the description has changed update it.
Eric Borenbf17eec2017-04-03 08:30:35 -0400550 if new_description_lines != original_description_lines:
Ravi Mistryee06ffe2017-05-08 12:59:56 -0400551 # Add a new line separating the new contents from the old contents.
552 new_description_lines.insert(len(original_description_lines), '')
Eric Borenbf17eec2017-04-03 08:30:35 -0400553 cl.UpdateDescriptionFooters(new_description_lines, footers)
rmistryd223fb22015-02-26 10:16:13 -0800554
555 return results
556
557
Eric Borenbf17eec2017-04-03 08:30:35 -0400558def _AddCQExtraTrybotsToDesc(cq_master_to_trybots, description_lines):
rmistry3b3ee202016-07-11 08:27:49 -0700559 """Adds the specified master and trybots to the CQ_INCLUDE_TRYBOTS keyword.
rmistry58276532015-10-01 08:24:03 -0700560
561 If the keyword already exists in the description then it appends to it only
562 if the specified values do not already exist.
563 If the keyword does not exist then it creates a new section in the
564 description.
565 """
Eric Borenbf17eec2017-04-03 08:30:35 -0400566 found = None
567 foundIdx = -1
568 for idx, line in enumerate(description_lines):
569 if line.startswith('CQ_INCLUDE_TRYBOTS'):
570 found = line
571 foundIdx = idx
572
573 if found:
574 original_trybots_map = _GetCQExtraTrybotsMap(found)
rmistry58276532015-10-01 08:24:03 -0700575 _MergeCQExtraTrybotsMaps(cq_master_to_trybots, original_trybots_map)
Eric Borenbf17eec2017-04-03 08:30:35 -0400576 new_line = _GetCQExtraTrybotsStr(cq_master_to_trybots)
577 if new_line != found:
578 description_lines[foundIdx] = new_line
rmistry58276532015-10-01 08:24:03 -0700579 else:
Eric Borenbf17eec2017-04-03 08:30:35 -0400580 description_lines.append(_GetCQExtraTrybotsStr(cq_master_to_trybots))
rmistry58276532015-10-01 08:24:03 -0700581
582
583def _MergeCQExtraTrybotsMaps(dest_map, map_to_be_consumed):
584 """Merges two maps of masters to trybots into one."""
585 for master, trybots in map_to_be_consumed.iteritems():
586 dest_map[master].update(trybots)
587 return dest_map
588
589
590def _GetCQExtraTrybotsMap(cq_extra_trybots_str):
rmistry3b3ee202016-07-11 08:27:49 -0700591 """Parses CQ_INCLUDE_TRYBOTS str and returns a map of masters to trybots."""
rmistry58276532015-10-01 08:24:03 -0700592 cq_master_to_trybots = collections.defaultdict(set)
593 for section in cq_extra_trybots_str.split(';'):
594 if section:
595 master, bots = section.split(':')
596 cq_master_to_trybots[master].update(bots.split(','))
597 return cq_master_to_trybots
598
599
600def _GetCQExtraTrybotsStr(cq_master_to_trybots):
rmistry3b3ee202016-07-11 08:27:49 -0700601 """Constructs the CQ_INCLUDE_TRYBOTS str from a map of masters to trybots."""
rmistry58276532015-10-01 08:24:03 -0700602 sections = []
603 for master, trybots in cq_master_to_trybots.iteritems():
604 sections.append('%s:%s' % (master, ','.join(trybots)))
rmistry3b3ee202016-07-11 08:27:49 -0700605 return 'CQ_INCLUDE_TRYBOTS=%s' % ';'.join(sections)
rmistry3cfd1ad2015-03-25 12:53:35 -0700606
607
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000608def CheckChangeOnCommit(input_api, output_api):
609 """Presubmit checks for the change on commit.
610
611 The following are the presubmit checks:
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000612 * Check change has one and only one EOL.
rmistry@google.comc2993442013-01-23 14:35:58 +0000613 * Ensures that the Skia tree is open in
614 http://skia-tree-status.appspot.com/. Shows a warning if it is in 'Caution'
615 state and an error if it is in 'Closed' state.
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000616 """
617 results = []
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000618 results.extend(_CommonChecks(input_api, output_api))
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000619 results.extend(
rmistry@google.comc2993442013-01-23 14:35:58 +0000620 _CheckTreeStatus(input_api, output_api, json_url=(
rmistry@google.com547012d2013-04-12 19:45:46 +0000621 SKIA_TREE_STATUS_URL + '/banner-status?format=json')))
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000622 results.extend(_CheckLGTMsForPublicAPI(input_api, output_api))
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000623 results.extend(_CheckOwnerIsInAuthorsFile(input_api, output_api))
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000624 return results