blob: c281b9a70db9752946eb59acbad314556feae288 [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',
rmistry@google.comfb4a68d2013-08-12 14:51:20 +000034)
35
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +000036AUTHORS_FILE_NAME = 'AUTHORS'
37
rmistryd223fb22015-02-26 10:16:13 -080038DOCS_PREVIEW_URL = 'https://skia.org/?cl='
rmistryd88b0be2016-05-20 03:50:01 -070039GOLD_TRYBOT_URL = 'https://gold.skia.org/search?issue='
rmistryd223fb22015-02-26 10:16:13 -080040
halcanary6950de62015-11-07 05:29:00 -080041# Path to CQ bots feature is described in https://bug.skia.org/4364
rmistry58276532015-10-01 08:24:03 -070042PATH_PREFIX_TO_EXTRA_TRYBOTS = {
43 # pylint: disable=line-too-long
rmistryd8f09882016-07-13 12:57:42 -070044 'cmake/': 'master.client.skia.compile:Build-Mac-Clang-x86_64-Release-CMake-Trybot,Build-Ubuntu-GCC-x86_64-Release-CMake-Trybot',
rmistry58276532015-10-01 08:24:03 -070045 # pylint: disable=line-too-long
rmistryd8f09882016-07-13 12:57:42 -070046 'src/opts/': 'master.client.skia:Test-Ubuntu-GCC-GCE-CPU-AVX2-x86_64-Release-SKNX_NO_SIMD-Trybot',
rmistry58276532015-10-01 08:24:03 -070047
rmistryd8f09882016-07-13 12:57:42 -070048 'include/private/SkAtomics.h': ('master.client.skia:'
mtklein04fff632016-08-31 12:43:14 -070049 'Test-Ubuntu-Clang-GCE-CPU-AVX2-x86_64-Release-TSAN-Trybot,'
50 'Test-Ubuntu-Clang-Golo-GPU-GT610-x86_64-Release-TSAN-Trybot'
mtkleinab8296b2015-10-07 11:49:00 -070051 ),
52
rmistry58276532015-10-01 08:24:03 -070053 # 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
rmistry@google.com547012d2013-04-12 19:45:46 +000059
rmistry@google.com713276b2013-01-25 18:27:34 +000060def _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
Eric Borenbb0ef0a2014-06-25 11:13:27 -040076def _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.
borenetd9fa7582016-02-18 08:05:48 -080087 'W0105', # String statement has no effect.
Eric Borenbb0ef0a2014-06-25 11:13:27 -040088 )
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
rmistry01cbf6c2015-03-12 07:48:40 -0700102def _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'
halcanary6950de62015-11-07 05:29:00 -0800138 'See https://bug.skia.org/3362 for why this should be fixed.' %
rmistry01cbf6c2015-03-12 07:48:40 -0700139 '\n'.join(failing_files)))
140 return results
141
142
borenetc7c91802015-03-25 04:47:02 -0700143def _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
mtkleine4b19c42015-05-05 10:28:44 -0700161def _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
borenet1ed2ae42016-07-26 11:52:17 -0700172def _RecipeSimulationTest(input_api, output_api):
173 """Run the recipe simulation test."""
174 results = []
mtklein3da80f52016-07-27 04:14:07 -0700175 if not any(f.LocalPath().startswith('infra')
176 for f in input_api.AffectedFiles()):
177 return results
178
borenet1ed2ae42016-07-26 11:52:17 -0700179 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
mtklein4db3b792016-08-03 14:18:22 -0700188def _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:
mtkleind434b012016-08-10 07:30:58 -0700199 fix = 'gn format ' + f.LocalPath()
mtklein4db3b792016-08-03 14:18:22 -0700200 results.append(output_api.PresubmitError(
mtkleind434b012016-08-10 07:30:58 -0700201 '`%s` failed, try\n\t%s' % (' '.join(cmd), fix)))
mtklein4db3b792016-08-03 14:18:22 -0700202 return results
203
borenet1ed2ae42016-07-26 11:52:17 -0700204
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000205def _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
mtklein18e55802015-03-25 07:21:20 -0700213 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
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000218 x.LocalPath().endswith('.cpp'))
219 results.extend(
rmistry@google.com713276b2013-01-25 18:27:34 +0000220 _CheckChangeHasEol(
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000221 input_api, output_api, source_file_filter=sources))
Eric Borenbb0ef0a2014-06-25 11:13:27 -0400222 results.extend(_PythonChecks(input_api, output_api))
rmistry01cbf6c2015-03-12 07:48:40 -0700223 results.extend(_IfDefChecks(input_api, output_api))
borenetc7c91802015-03-25 04:47:02 -0700224 results.extend(_CopyrightChecks(input_api, output_api,
225 source_file_filter=sources))
mtkleine4b19c42015-05-05 10:28:44 -0700226 results.extend(_ToolFlags(input_api, output_api))
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000227 return results
228
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000229
230def CheckChangeOnUpload(input_api, output_api):
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000231 """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))
borenet1ed2ae42016-07-26 11:52:17 -0700238 # Run on upload, not commit, since the presubmit bot apparently doesn't have
239 # coverage installed.
240 results.extend(_RecipeSimulationTest(input_api, output_api))
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
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
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000333def _CheckOwnerIsInAuthorsFile(input_api, output_api):
334 results = []
rmistryb398ecc2016-08-29 08:13:29 -0700335 if input_api.change.issue:
336 cr = CodeReview(input_api)
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000337
rmistryb398ecc2016-08-29 08:13:29 -0700338 owner_email = cr.GetOwnerEmail()
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000339 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:
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000350 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 '
rmistry9806d4d2015-10-01 08:10:54 -0700354 'file.'
rmistry83fab472014-07-18 05:25:56 -0700355 % owner_email))
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000356 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
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000364def _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
rmistry9407ece2014-08-26 14:00:54 -0700372 for affected_file in input_api.AffectedFiles():
373 affected_file_path = affected_file.LocalPath()
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000374 file_path, file_ext = os.path.splitext(affected_file_path)
rmistry9407ece2014-08-26 14:00:54 -0700375 # We only care about files that end in .h and are under the top-level
mtkleinbda12672015-07-28 08:54:12 -0700376 # 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):
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000380 requires_owner_check = True
381
382 if not requires_owner_check:
383 return results
384
385 lgtm_from_owner = False
rmistryb398ecc2016-08-29 08:13:29 -0700386 if input_api.change.issue:
387 cr = CodeReview(input_api)
388
389 if re.match(REVERT_CL_SUBJECT_PREFIX, cr.GetSubject(), re.I):
commit-bot@chromium.orgcfdc5962014-01-31 17:33:04 +0000390 # It is a revert CL, ignore the public api owners check.
391 return results
rmistryf2d83ca2014-08-26 10:30:29 -0700392
rmistryb398ecc2016-08-29 08:13:29 -0700393 if cr.IsDryRun():
rmistry04abf132015-04-07 07:41:51 -0700394 # Ignore public api owners check for dry run CLs since they are not
rmistryf91b7172015-03-12 09:48:10 -0700395 # going to be committed.
396 return results
397
rmistryb398ecc2016-08-29 08:13:29 -0700398 match = re.search(r'^TBR=(.*)$', cr.GetDescription(), re.M)
rmistryf2d83ca2014-08-26 10:30:29 -0700399 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
rmistryb398ecc2016-08-29 08:13:29 -0700407 if cr.GetOwnerEmail() in PUBLIC_API_OWNERS:
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000408 # An owner created the CL that is an automatic LGTM.
409 lgtm_from_owner = True
410
rmistryb398ecc2016-08-29 08:13:29 -0700411 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
commit-bot@chromium.orgcfdc5962014-01-31 17:33:04 +0000416
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000417 if not lgtm_from_owner:
418 results.append(
419 output_api.PresubmitError(
mtkleinbda12672015-07-28 08:54:12 -0700420 "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)))
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000426 return results
427
428
rmistryd223fb22015-02-26 10:16:13 -0800429def 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:
rmistry11f457e2015-12-15 06:23:33 -0800433 * Adds a link to the CL's Gold trybot results.
rmistryd223fb22015-02-26 10:16:13 -0800434 * 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.
rmistry896f3932015-02-26 11:52:05 -0800436 * 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.
borenetaf6005c2015-06-04 15:15:42 -0700440 * Adds 'NOPRESUBMIT=true' for non master branch changes since those don't
441 run the presubmit checks.
rmistry58276532015-10-01 08:24:03 -0700442 * Adds extra trybots for the paths defined in PATH_TO_EXTRA_TRYBOTS.
rmistryd223fb22015-02-26 10:16:13 -0800443 """
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
rmistryb9a9e872016-09-01 09:52:32 -0700459 if issue:
460 original_description = cl.GetDescription()
rmistry07f04462016-09-01 13:36:31 -0700461 changeIdLine = None
462 if cl.IsGerrit():
463 # Remove Change-Id from description and add it back at the end.
464 regex = re.compile(r'^(Change-Id: (\w+))(\n*)\Z', re.M | re.I)
465 changeIdLine = re.search(regex, original_description).group(0)
466 original_description = re.sub(regex, '', original_description)
467 original_description = re.sub('\n+\Z', '\n', original_description)
468
rmistryd223fb22015-02-26 10:16:13 -0800469 new_description = original_description
470
rmistry11f457e2015-12-15 06:23:33 -0800471 # Add GOLD_TRYBOT_URL if it does not exist yet.
472 if not re.search(r'^GOLD_TRYBOT_URL=', new_description, re.M | re.I):
473 new_description += '\nGOLD_TRYBOT_URL= %s%s' % (GOLD_TRYBOT_URL, issue)
474 results.append(
475 output_api.PresubmitNotifyResult(
476 'Added link to Gold trybot runs to the CL\'s description.\n'
477 'Note: Results may take sometime to be populated after trybots '
478 'complete.'))
479
rmistryd223fb22015-02-26 10:16:13 -0800480 # If the change includes only doc changes then add NOTRY=true in the
481 # CL's description if it does not exist yet.
482 if all_docs_changes and not re.search(
rmistry896f3932015-02-26 11:52:05 -0800483 r'^NOTRY=true$', new_description, re.M | re.I):
rmistryd223fb22015-02-26 10:16:13 -0800484 new_description += '\nNOTRY=true'
485 results.append(
486 output_api.PresubmitNotifyResult(
487 'This change has only doc changes. Automatically added '
488 '\'NOTRY=true\' to the CL\'s description'))
489
490 # If there is atleast one docs change then add preview link in the CL's
491 # description if it does not already exist there.
492 if atleast_one_docs_change and not re.search(
rmistry896f3932015-02-26 11:52:05 -0800493 r'^DOCS_PREVIEW=.*', new_description, re.M | re.I):
rmistryd223fb22015-02-26 10:16:13 -0800494 # Automatically add a link to where the docs can be previewed.
495 new_description += '\nDOCS_PREVIEW= %s%s' % (DOCS_PREVIEW_URL, issue)
496 results.append(
497 output_api.PresubmitNotifyResult(
498 'Automatically added a link to preview the docs changes to the '
499 'CL\'s description'))
500
rmistry896f3932015-02-26 11:52:05 -0800501 # If the target ref is not master then add NOTREECHECKS=true and NOTRY=true
502 # to the CL's description if it does not already exist there.
rmistryb9a9e872016-09-01 09:52:32 -0700503 target_ref = cl.GetRemoteBranch()[1]
504 if target_ref != 'refs/remotes/origin/master':
rmistry896f3932015-02-26 11:52:05 -0800505 if not re.search(
506 r'^NOTREECHECKS=true$', new_description, re.M | re.I):
507 new_description += "\nNOTREECHECKS=true"
508 results.append(
509 output_api.PresubmitNotifyResult(
510 'Branch changes do not need to rely on the master branch\'s '
511 'tree status. Automatically added \'NOTREECHECKS=true\' to the '
512 'CL\'s description'))
513 if not re.search(
514 r'^NOTRY=true$', new_description, re.M | re.I):
515 new_description += "\nNOTRY=true"
516 results.append(
517 output_api.PresubmitNotifyResult(
518 'Trybots do not yet work for non-master branches. '
519 'Automatically added \'NOTRY=true\' to the CL\'s description'))
borenetaf6005c2015-06-04 15:15:42 -0700520 if not re.search(
521 r'^NOPRESUBMIT=true$', new_description, re.M | re.I):
522 new_description += "\nNOPRESUBMIT=true"
523 results.append(
524 output_api.PresubmitNotifyResult(
525 'Branch changes do not run the presubmit checks.'))
rmistry896f3932015-02-26 11:52:05 -0800526
rmistry3b3ee202016-07-11 08:27:49 -0700527 # Automatically set CQ_INCLUDE_TRYBOTS if any of the changed files here
528 # begin with the paths of interest.
rmistry58276532015-10-01 08:24:03 -0700529 cq_master_to_trybots = collections.defaultdict(set)
530 for affected_file in change.AffectedFiles():
531 affected_file_path = affected_file.LocalPath()
532 for path_prefix, extra_bots in PATH_PREFIX_TO_EXTRA_TRYBOTS.iteritems():
533 if affected_file_path.startswith(path_prefix):
534 results.append(
535 output_api.PresubmitNotifyResult(
536 'Your CL modifies the path %s.\nAutomatically adding %s to '
537 'the CL description.' % (affected_file_path, extra_bots)))
538 _MergeCQExtraTrybotsMaps(
539 cq_master_to_trybots, _GetCQExtraTrybotsMap(extra_bots))
540 if cq_master_to_trybots:
541 new_description = _AddCQExtraTrybotsToDesc(
542 cq_master_to_trybots, new_description)
rmistry896f3932015-02-26 11:52:05 -0800543
rmistryd223fb22015-02-26 10:16:13 -0800544 # If the description has changed update it.
545 if new_description != original_description:
rmistry07f04462016-09-01 13:36:31 -0700546 if changeIdLine:
547 # The Change-Id line must have two newlines before it.
548 new_description += '\n\n' + changeIdLine
rmistryb9a9e872016-09-01 09:52:32 -0700549 cl.UpdateDescription(new_description)
rmistryd223fb22015-02-26 10:16:13 -0800550
551 return results
552
553
rmistry58276532015-10-01 08:24:03 -0700554def _AddCQExtraTrybotsToDesc(cq_master_to_trybots, description):
rmistry3b3ee202016-07-11 08:27:49 -0700555 """Adds the specified master and trybots to the CQ_INCLUDE_TRYBOTS keyword.
rmistry58276532015-10-01 08:24:03 -0700556
557 If the keyword already exists in the description then it appends to it only
558 if the specified values do not already exist.
559 If the keyword does not exist then it creates a new section in the
560 description.
561 """
rmistry3b3ee202016-07-11 08:27:49 -0700562 match = re.search(r'^CQ_INCLUDE_TRYBOTS=(.*)$', description, re.M | re.I)
rmistry58276532015-10-01 08:24:03 -0700563 if match:
564 original_trybots_map = _GetCQExtraTrybotsMap(match.group(1))
565 _MergeCQExtraTrybotsMaps(cq_master_to_trybots, original_trybots_map)
566 new_description = description.replace(
567 match.group(0), _GetCQExtraTrybotsStr(cq_master_to_trybots))
568 else:
569 new_description = description + "\n%s" % (
570 _GetCQExtraTrybotsStr(cq_master_to_trybots))
571 return new_description
572
573
574def _MergeCQExtraTrybotsMaps(dest_map, map_to_be_consumed):
575 """Merges two maps of masters to trybots into one."""
576 for master, trybots in map_to_be_consumed.iteritems():
577 dest_map[master].update(trybots)
578 return dest_map
579
580
581def _GetCQExtraTrybotsMap(cq_extra_trybots_str):
rmistry3b3ee202016-07-11 08:27:49 -0700582 """Parses CQ_INCLUDE_TRYBOTS str and returns a map of masters to trybots."""
rmistry58276532015-10-01 08:24:03 -0700583 cq_master_to_trybots = collections.defaultdict(set)
584 for section in cq_extra_trybots_str.split(';'):
585 if section:
586 master, bots = section.split(':')
587 cq_master_to_trybots[master].update(bots.split(','))
588 return cq_master_to_trybots
589
590
591def _GetCQExtraTrybotsStr(cq_master_to_trybots):
rmistry3b3ee202016-07-11 08:27:49 -0700592 """Constructs the CQ_INCLUDE_TRYBOTS str from a map of masters to trybots."""
rmistry58276532015-10-01 08:24:03 -0700593 sections = []
594 for master, trybots in cq_master_to_trybots.iteritems():
595 sections.append('%s:%s' % (master, ','.join(trybots)))
rmistry3b3ee202016-07-11 08:27:49 -0700596 return 'CQ_INCLUDE_TRYBOTS=%s' % ';'.join(sections)
rmistry3cfd1ad2015-03-25 12:53:35 -0700597
598
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000599def CheckChangeOnCommit(input_api, output_api):
600 """Presubmit checks for the change on commit.
601
602 The following are the presubmit checks:
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000603 * Check change has one and only one EOL.
rmistry@google.comc2993442013-01-23 14:35:58 +0000604 * Ensures that the Skia tree is open in
605 http://skia-tree-status.appspot.com/. Shows a warning if it is in 'Caution'
606 state and an error if it is in 'Closed' state.
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000607 """
608 results = []
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000609 results.extend(_CommonChecks(input_api, output_api))
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000610 results.extend(
rmistry@google.comc2993442013-01-23 14:35:58 +0000611 _CheckTreeStatus(input_api, output_api, json_url=(
rmistry@google.com547012d2013-04-12 19:45:46 +0000612 SKIA_TREE_STATUS_URL + '/banner-status?format=json')))
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000613 results.extend(_CheckLGTMsForPublicAPI(input_api, output_api))
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000614 results.extend(_CheckOwnerIsInAuthorsFile(input_api, output_api))
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000615 return results