blob: 271cd13ada72eeab4de73b37d78f5d65d0cef4ba [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
Joe Gregorio73259422018-05-22 15:29:03 +000040DOCS_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 Boren47f07092017-06-29 15:04:00 -040045 'src/opts/': ('skia.primary:'
Kevin Lubick9ef6de72017-10-15 21:05:58 -040046 'Test-Debian9-Clang-GCE-CPU-AVX2-x86_64-Release-All-SKNX_NO_SIMD'),
Eric Boren50831302016-11-18 13:10:51 -050047 'include/private/SkAtomics.h': ('skia.primary:'
Kevin Lubick9ef6de72017-10-15 21:05:58 -040048 'Test-Debian9-Clang-GCE-CPU-AVX2-x86_64-Release-All-TSAN,'
49 'Test-Ubuntu17-Clang-Golo-GPU-QuadroP400-x86_64-Release-All-TSAN'
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
Eric Boren1eec99c2018-04-26 13:09:48 -040058SERVICE_ACCOUNT_SUFFIX = [
Eric Boren47ed6f12018-04-26 14:02:43 -040059 '@%s.iam.gserviceaccount.com' % project for project in [
Ben Wagner011b35c2018-04-26 16:21:58 -040060 'skia-buildbots.google.com', 'skia-swarming-bots']]
Eric Borendd988292018-01-02 13:29:21 -050061
rmistry@google.com547012d2013-04-12 19:45:46 +000062
rmistry@google.com713276b2013-01-25 18:27:34 +000063def _CheckChangeHasEol(input_api, output_api, source_file_filter=None):
64 """Checks that files end with atleast one \n (LF)."""
65 eof_files = []
66 for f in input_api.AffectedSourceFiles(source_file_filter):
67 contents = input_api.ReadFile(f, 'rb')
68 # Check that the file ends in atleast one newline character.
69 if len(contents) > 1 and contents[-1:] != '\n':
70 eof_files.append(f.LocalPath())
71
72 if eof_files:
73 return [output_api.PresubmitPromptWarning(
74 'These files should end in a newline character:',
75 items=eof_files)]
76 return []
77
78
Eric Borenbb0ef0a2014-06-25 11:13:27 -040079def _PythonChecks(input_api, output_api):
80 """Run checks on any modified Python files."""
Eric Boren5e090972018-06-22 10:13:52 -040081 blacklist = [
82 r'infra[\\\/]bots[\\\/]recipes.py',
83
84 # Blacklist DEPS. Those under third_party are already covered by
85 # input_api.DEFAULT_BLACK_LIST.
86 r'common[\\\/].*',
87 r'buildtools[\\\/].*',
Eric Boren9ad90752018-06-22 15:53:56 -040088 r'.*[\\\/]\.recipe_deps[\\\/].*',
Eric Boren5e090972018-06-22 10:13:52 -040089 ]
90 blacklist.extend(input_api.DEFAULT_BLACK_LIST)
91
Eric Borenbb0ef0a2014-06-25 11:13:27 -040092 pylint_disabled_warnings = (
93 'F0401', # Unable to import.
94 'E0611', # No name in module.
95 'W0232', # Class has no __init__ method.
96 'E1002', # Use of super on an old style class.
97 'W0403', # Relative import used.
98 'R0201', # Method could be a function.
99 'E1003', # Using class name in super.
100 'W0613', # Unused argument.
borenetd9fa7582016-02-18 08:05:48 -0800101 'W0105', # String statement has no effect.
Eric Borenbb0ef0a2014-06-25 11:13:27 -0400102 )
Eric Borenbb0ef0a2014-06-25 11:13:27 -0400103 return input_api.canned_checks.RunPylint(
104 input_api, output_api,
105 disabled_warnings=pylint_disabled_warnings,
Eric Boren5e090972018-06-22 10:13:52 -0400106 black_list=blacklist)
Eric Borenbb0ef0a2014-06-25 11:13:27 -0400107
108
Ben Wagnercf42e982018-02-09 17:41:20 -0500109def _JsonChecks(input_api, output_api):
110 """Run checks on any modified json files."""
111 failing_files = []
112 for affected_file in input_api.AffectedFiles(None):
113 affected_file_path = affected_file.LocalPath()
114 is_json = affected_file_path.endswith('.json')
115 is_metadata = (affected_file_path.startswith('site/') and
116 affected_file_path.endswith('/METADATA'))
117 if is_json or is_metadata:
118 try:
119 input_api.json.load(open(affected_file_path, 'r'))
120 except ValueError:
121 failing_files.append(affected_file_path)
122
123 results = []
124 if failing_files:
125 results.append(
126 output_api.PresubmitError(
127 'The following files contain invalid json:\n%s\n\n' %
128 '\n'.join(failing_files)))
129 return results
130
131
rmistry01cbf6c2015-03-12 07:48:40 -0700132def _IfDefChecks(input_api, output_api):
133 """Ensures if/ifdef are not before includes. See skbug/3362 for details."""
134 comment_block_start_pattern = re.compile('^\s*\/\*.*$')
135 comment_block_middle_pattern = re.compile('^\s+\*.*')
136 comment_block_end_pattern = re.compile('^\s+\*\/.*$')
137 single_line_comment_pattern = re.compile('^\s*//.*$')
138 def is_comment(line):
139 return (comment_block_start_pattern.match(line) or
140 comment_block_middle_pattern.match(line) or
141 comment_block_end_pattern.match(line) or
142 single_line_comment_pattern.match(line))
143
144 empty_line_pattern = re.compile('^\s*$')
145 def is_empty_line(line):
146 return empty_line_pattern.match(line)
147
148 failing_files = []
149 for affected_file in input_api.AffectedSourceFiles(None):
150 affected_file_path = affected_file.LocalPath()
151 if affected_file_path.endswith('.cpp') or affected_file_path.endswith('.h'):
152 f = open(affected_file_path)
153 for line in f.xreadlines():
154 if is_comment(line) or is_empty_line(line):
155 continue
156 # The below will be the first real line after comments and newlines.
157 if line.startswith('#if 0 '):
158 pass
159 elif line.startswith('#if ') or line.startswith('#ifdef '):
160 failing_files.append(affected_file_path)
161 break
162
163 results = []
164 if failing_files:
165 results.append(
166 output_api.PresubmitError(
167 'The following files have #if or #ifdef before includes:\n%s\n\n'
halcanary6950de62015-11-07 05:29:00 -0800168 'See https://bug.skia.org/3362 for why this should be fixed.' %
rmistry01cbf6c2015-03-12 07:48:40 -0700169 '\n'.join(failing_files)))
170 return results
171
172
borenetc7c91802015-03-25 04:47:02 -0700173def _CopyrightChecks(input_api, output_api, source_file_filter=None):
174 results = []
175 year_pattern = r'\d{4}'
176 year_range_pattern = r'%s(-%s)?' % (year_pattern, year_pattern)
177 years_pattern = r'%s(,%s)*,?' % (year_range_pattern, year_range_pattern)
178 copyright_pattern = (
179 r'Copyright (\([cC]\) )?%s \w+' % years_pattern)
180
181 for affected_file in input_api.AffectedSourceFiles(source_file_filter):
182 if 'third_party' in affected_file.LocalPath():
183 continue
184 contents = input_api.ReadFile(affected_file, 'rb')
185 if not re.search(copyright_pattern, contents):
186 results.append(output_api.PresubmitError(
187 '%s is missing a correct copyright header.' % affected_file))
188 return results
189
190
mtkleine4b19c42015-05-05 10:28:44 -0700191def _ToolFlags(input_api, output_api):
192 """Make sure `{dm,nanobench}_flags.py test` passes if modified."""
193 results = []
194 sources = lambda x: ('dm_flags.py' in x.LocalPath() or
195 'nanobench_flags.py' in x.LocalPath())
196 for f in input_api.AffectedSourceFiles(sources):
197 if 0 != subprocess.call(['python', f.LocalPath(), 'test']):
198 results.append(output_api.PresubmitError('`python %s test` failed' % f))
199 return results
200
201
borenet2dbbfa52016-10-14 06:32:09 -0700202def _InfraTests(input_api, output_api):
203 """Run the infra tests."""
borenet1ed2ae42016-07-26 11:52:17 -0700204 results = []
mtklein3da80f52016-07-27 04:14:07 -0700205 if not any(f.LocalPath().startswith('infra')
206 for f in input_api.AffectedFiles()):
207 return results
208
borenet2dbbfa52016-10-14 06:32:09 -0700209 cmd = ['python', os.path.join('infra', 'bots', 'infra_tests.py')]
borenet60b0a2d2016-10-04 12:45:41 -0700210 try:
211 subprocess.check_output(cmd)
212 except subprocess.CalledProcessError as e:
213 results.append(output_api.PresubmitError(
214 '`%s` failed:\n%s' % (' '.join(cmd), e.output)))
215 return results
216
217
mtklein4db3b792016-08-03 14:18:22 -0700218def _CheckGNFormatted(input_api, output_api):
219 """Make sure any .gn files we're changing have been formatted."""
220 results = []
221 for f in input_api.AffectedFiles():
Mike Kleina5fb6152016-10-26 14:17:04 -0400222 if (not f.LocalPath().endswith('.gn') and
223 not f.LocalPath().endswith('.gni')):
mtklein4db3b792016-08-03 14:18:22 -0700224 continue
225
Mike Klein7a1c53d2016-10-11 14:03:06 -0400226 gn = 'gn.bat' if 'win32' in sys.platform else 'gn'
227 cmd = [gn, 'format', '--dry-run', f.LocalPath()]
mtklein4db3b792016-08-03 14:18:22 -0700228 try:
229 subprocess.check_output(cmd)
230 except subprocess.CalledProcessError:
mtkleind434b012016-08-10 07:30:58 -0700231 fix = 'gn format ' + f.LocalPath()
mtklein4db3b792016-08-03 14:18:22 -0700232 results.append(output_api.PresubmitError(
mtkleind434b012016-08-10 07:30:58 -0700233 '`%s` failed, try\n\t%s' % (' '.join(cmd), fix)))
mtklein4db3b792016-08-03 14:18:22 -0700234 return results
235
borenet1ed2ae42016-07-26 11:52:17 -0700236
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000237def _CommonChecks(input_api, output_api):
238 """Presubmit checks common to upload and commit."""
239 results = []
240 sources = lambda x: (x.LocalPath().endswith('.h') or
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000241 x.LocalPath().endswith('.py') or
242 x.LocalPath().endswith('.sh') or
mtklein18e55802015-03-25 07:21:20 -0700243 x.LocalPath().endswith('.m') or
244 x.LocalPath().endswith('.mm') or
245 x.LocalPath().endswith('.go') or
246 x.LocalPath().endswith('.c') or
247 x.LocalPath().endswith('.cc') or
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000248 x.LocalPath().endswith('.cpp'))
249 results.extend(
rmistry@google.com713276b2013-01-25 18:27:34 +0000250 _CheckChangeHasEol(
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000251 input_api, output_api, source_file_filter=sources))
Ben Wagner29380bd2017-10-09 14:43:00 -0400252 results.extend(
253 input_api.canned_checks.CheckChangeHasNoCR(
254 input_api, output_api, source_file_filter=sources))
Ben Wagner63fd7602017-10-09 15:45:33 -0400255 results.extend(
256 input_api.canned_checks.CheckChangeHasNoStrayWhitespace(
257 input_api, output_api, source_file_filter=sources))
Eric Borenbb0ef0a2014-06-25 11:13:27 -0400258 results.extend(_PythonChecks(input_api, output_api))
Ben Wagnercf42e982018-02-09 17:41:20 -0500259 results.extend(_JsonChecks(input_api, output_api))
rmistry01cbf6c2015-03-12 07:48:40 -0700260 results.extend(_IfDefChecks(input_api, output_api))
borenetc7c91802015-03-25 04:47:02 -0700261 results.extend(_CopyrightChecks(input_api, output_api,
262 source_file_filter=sources))
mtkleine4b19c42015-05-05 10:28:44 -0700263 results.extend(_ToolFlags(input_api, output_api))
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000264 return results
265
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000266
267def CheckChangeOnUpload(input_api, output_api):
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000268 """Presubmit checks for the change on upload.
269
270 The following are the presubmit checks:
271 * Check change has one and only one EOL.
272 """
273 results = []
274 results.extend(_CommonChecks(input_api, output_api))
borenet1ed2ae42016-07-26 11:52:17 -0700275 # Run on upload, not commit, since the presubmit bot apparently doesn't have
borenet60b0a2d2016-10-04 12:45:41 -0700276 # coverage or Go installed.
borenet2dbbfa52016-10-14 06:32:09 -0700277 results.extend(_InfraTests(input_api, output_api))
borenet60b0a2d2016-10-04 12:45:41 -0700278
mtklein4db3b792016-08-03 14:18:22 -0700279 results.extend(_CheckGNFormatted(input_api, output_api))
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000280 return results
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000281
282
rmistry@google.comc2993442013-01-23 14:35:58 +0000283def _CheckTreeStatus(input_api, output_api, json_url):
284 """Check whether to allow commit.
285
286 Args:
287 input_api: input related apis.
288 output_api: output related apis.
289 json_url: url to download json style status.
290 """
291 tree_status_results = input_api.canned_checks.CheckTreeIsOpen(
292 input_api, output_api, json_url=json_url)
293 if not tree_status_results:
294 # Check for caution state only if tree is not closed.
295 connection = input_api.urllib2.urlopen(json_url)
296 status = input_api.json.loads(connection.read())
297 connection.close()
rmistry@google.comf6c5f752013-03-29 17:26:00 +0000298 if ('caution' in status['message'].lower() and
299 os.isatty(sys.stdout.fileno())):
300 # Display a prompt only if we are in an interactive shell. Without this
301 # check the commit queue behaves incorrectly because it considers
302 # prompts to be failures.
rmistry@google.comc2993442013-01-23 14:35:58 +0000303 short_text = 'Tree state is: ' + status['general_state']
304 long_text = status['message'] + '\n' + json_url
305 tree_status_results.append(
306 output_api.PresubmitPromptWarning(
307 message=short_text, long_text=long_text))
rmistry@google.com547012d2013-04-12 19:45:46 +0000308 else:
309 # Tree status is closed. Put in message about contacting sheriff.
310 connection = input_api.urllib2.urlopen(
311 SKIA_TREE_STATUS_URL + '/current-sheriff')
312 sheriff_details = input_api.json.loads(connection.read())
313 if sheriff_details:
314 tree_status_results[0]._message += (
315 '\n\nPlease contact the current Skia sheriff (%s) if you are trying '
316 'to submit a build fix\nand do not know how to submit because the '
317 'tree is closed') % sheriff_details['username']
rmistry@google.comc2993442013-01-23 14:35:58 +0000318 return tree_status_results
319
320
rmistryb398ecc2016-08-29 08:13:29 -0700321class CodeReview(object):
322 """Abstracts which codereview tool is used for the specified issue."""
323
324 def __init__(self, input_api):
325 self._issue = input_api.change.issue
326 self._gerrit = input_api.gerrit
rmistryb398ecc2016-08-29 08:13:29 -0700327
328 def GetOwnerEmail(self):
Aaron Gablea49909a2017-10-09 12:50:52 -0700329 return self._gerrit.GetChangeOwner(self._issue)
rmistryb398ecc2016-08-29 08:13:29 -0700330
331 def GetSubject(self):
Aaron Gablea49909a2017-10-09 12:50:52 -0700332 return self._gerrit.GetChangeInfo(self._issue)['subject']
rmistryb398ecc2016-08-29 08:13:29 -0700333
334 def GetDescription(self):
Aaron Gablea49909a2017-10-09 12:50:52 -0700335 return self._gerrit.GetChangeDescription(self._issue)
rmistryb398ecc2016-08-29 08:13:29 -0700336
337 def IsDryRun(self):
Aaron Gablea49909a2017-10-09 12:50:52 -0700338 return self._gerrit.GetChangeInfo(
339 self._issue)['labels']['Commit-Queue'].get('value', 0) == 1
rmistryb398ecc2016-08-29 08:13:29 -0700340
Ravi Mistry39eabb62016-10-05 08:41:12 -0400341 def GetReviewers(self):
Aaron Gablea49909a2017-10-09 12:50:52 -0700342 code_review_label = (
343 self._gerrit.GetChangeInfo(self._issue)['labels']['Code-Review'])
344 return [r['email'] for r in code_review_label.get('all', [])]
Ravi Mistry39eabb62016-10-05 08:41:12 -0400345
rmistryb398ecc2016-08-29 08:13:29 -0700346 def GetApprovers(self):
347 approvers = []
Aaron Gablea49909a2017-10-09 12:50:52 -0700348 code_review_label = (
349 self._gerrit.GetChangeInfo(self._issue)['labels']['Code-Review'])
350 for m in code_review_label.get('all', []):
351 if m.get("value") == 1:
352 approvers.append(m["email"])
rmistryb398ecc2016-08-29 08:13:29 -0700353 return approvers
354
355
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000356def _CheckOwnerIsInAuthorsFile(input_api, output_api):
357 results = []
rmistryb398ecc2016-08-29 08:13:29 -0700358 if input_api.change.issue:
359 cr = CodeReview(input_api)
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000360
rmistryb398ecc2016-08-29 08:13:29 -0700361 owner_email = cr.GetOwnerEmail()
Eric Borendd988292018-01-02 13:29:21 -0500362
363 # Service accounts don't need to be in AUTHORS.
Eric Boren1eec99c2018-04-26 13:09:48 -0400364 for suffix in SERVICE_ACCOUNT_SUFFIX:
365 if owner_email.endswith(suffix):
366 return results
Eric Borendd988292018-01-02 13:29:21 -0500367
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000368 try:
369 authors_content = ''
370 for line in open(AUTHORS_FILE_NAME):
371 if not line.startswith('#'):
372 authors_content += line
373 email_fnmatches = re.findall('<(.*)>', authors_content)
374 for email_fnmatch in email_fnmatches:
375 if fnmatch.fnmatch(owner_email, email_fnmatch):
376 # Found a match, the user is in the AUTHORS file break out of the loop
377 break
378 else:
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000379 results.append(
380 output_api.PresubmitError(
381 'The email %s is not in Skia\'s AUTHORS file.\n'
382 'Issue owner, this CL must include an addition to the Skia AUTHORS '
rmistry9806d4d2015-10-01 08:10:54 -0700383 'file.'
rmistry83fab472014-07-18 05:25:56 -0700384 % owner_email))
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000385 except IOError:
386 # Do not fail if authors file cannot be found.
387 traceback.print_exc()
388 input_api.logging.error('AUTHORS file not found!')
389
390 return results
391
392
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000393def _CheckLGTMsForPublicAPI(input_api, output_api):
394 """Check LGTMs for public API changes.
395
396 For public API files make sure there is an LGTM from the list of owners in
397 PUBLIC_API_OWNERS.
398 """
399 results = []
400 requires_owner_check = False
rmistry9407ece2014-08-26 14:00:54 -0700401 for affected_file in input_api.AffectedFiles():
402 affected_file_path = affected_file.LocalPath()
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000403 file_path, file_ext = os.path.splitext(affected_file_path)
rmistry9407ece2014-08-26 14:00:54 -0700404 # We only care about files that end in .h and are under the top-level
mtkleinbda12672015-07-28 08:54:12 -0700405 # include dir, but not include/private.
406 if (file_ext == '.h' and
407 'include' == file_path.split(os.path.sep)[0] and
408 'private' not in file_path):
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000409 requires_owner_check = True
410
411 if not requires_owner_check:
412 return results
413
414 lgtm_from_owner = False
rmistryb398ecc2016-08-29 08:13:29 -0700415 if input_api.change.issue:
416 cr = CodeReview(input_api)
417
418 if re.match(REVERT_CL_SUBJECT_PREFIX, cr.GetSubject(), re.I):
commit-bot@chromium.orgcfdc5962014-01-31 17:33:04 +0000419 # It is a revert CL, ignore the public api owners check.
420 return results
rmistryf2d83ca2014-08-26 10:30:29 -0700421
rmistryb398ecc2016-08-29 08:13:29 -0700422 if cr.IsDryRun():
rmistry04abf132015-04-07 07:41:51 -0700423 # Ignore public api owners check for dry run CLs since they are not
rmistryf91b7172015-03-12 09:48:10 -0700424 # going to be committed.
425 return results
426
Ravi Mistry39eabb62016-10-05 08:41:12 -0400427 if input_api.gerrit:
428 for reviewer in cr.GetReviewers():
429 if reviewer in PUBLIC_API_OWNERS:
430 # If an owner is specified as an reviewer in Gerrit then ignore the
431 # public api owners check.
rmistryf2d83ca2014-08-26 10:30:29 -0700432 return results
Ravi Mistry39eabb62016-10-05 08:41:12 -0400433 else:
434 match = re.search(r'^TBR=(.*)$', cr.GetDescription(), re.M)
435 if match:
436 tbr_section = match.group(1).strip().split(' ')[0]
437 tbr_entries = tbr_section.split(',')
438 for owner in PUBLIC_API_OWNERS:
439 if owner in tbr_entries or owner.split('@')[0] in tbr_entries:
440 # If an owner is specified in the TBR= line then ignore the public
441 # api owners check.
442 return results
rmistryf2d83ca2014-08-26 10:30:29 -0700443
rmistryb398ecc2016-08-29 08:13:29 -0700444 if cr.GetOwnerEmail() in PUBLIC_API_OWNERS:
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000445 # An owner created the CL that is an automatic LGTM.
446 lgtm_from_owner = True
447
rmistryb398ecc2016-08-29 08:13:29 -0700448 for approver in cr.GetApprovers():
449 if approver in PUBLIC_API_OWNERS:
450 # Found an lgtm in a message from an owner.
451 lgtm_from_owner = True
452 break
commit-bot@chromium.orgcfdc5962014-01-31 17:33:04 +0000453
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000454 if not lgtm_from_owner:
455 results.append(
456 output_api.PresubmitError(
mtkleinbda12672015-07-28 08:54:12 -0700457 "If this CL adds to or changes Skia's public API, you need an LGTM "
458 "from any of %s. If this CL only removes from or doesn't change "
Ravi Mistrydbb84c22016-10-05 12:47:44 -0400459 "Skia's public API, please add a short note to the CL saying so. "
Aaron Gablea49909a2017-10-09 12:50:52 -0700460 "Add one of the owners as a reviewer to your CL as well as to the "
461 "TBR= line. If you don't know if this CL affects Skia's public "
462 "API, treat it like it does." % str(PUBLIC_API_OWNERS)))
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000463 return results
464
465
Ravi Mistry355feab2017-05-23 14:24:08 -0400466def _FooterExists(footers, key, value):
467 for k, v in footers:
468 if k == key and v == value:
469 return True
470 return False
471
472
rmistryd223fb22015-02-26 10:16:13 -0800473def PostUploadHook(cl, change, output_api):
474 """git cl upload will call this hook after the issue is created/modified.
475
476 This hook does the following:
477 * Adds a link to preview docs changes if there are any docs changes in the CL.
Ravi Mistry355feab2017-05-23 14:24:08 -0400478 * Adds 'No-Try: true' if the CL contains only docs changes.
479 * Adds 'No-Tree-Checks: true' for non master branch changes since they do not
rmistry896f3932015-02-26 11:52:05 -0800480 need to be gated on the master branch's tree.
Ravi Mistry355feab2017-05-23 14:24:08 -0400481 * Adds 'No-Try: true' for non master branch changes since trybots do not yet
rmistry896f3932015-02-26 11:52:05 -0800482 work on them.
Ravi Mistry355feab2017-05-23 14:24:08 -0400483 * Adds 'No-Presubmit: true' for non master branch changes since those don't
borenetaf6005c2015-06-04 15:15:42 -0700484 run the presubmit checks.
rmistry58276532015-10-01 08:24:03 -0700485 * Adds extra trybots for the paths defined in PATH_TO_EXTRA_TRYBOTS.
rmistryd223fb22015-02-26 10:16:13 -0800486 """
487
488 results = []
489 atleast_one_docs_change = False
490 all_docs_changes = True
491 for affected_file in change.AffectedFiles():
492 affected_file_path = affected_file.LocalPath()
493 file_path, _ = os.path.splitext(affected_file_path)
494 if 'site' == file_path.split(os.path.sep)[0]:
495 atleast_one_docs_change = True
496 else:
497 all_docs_changes = False
498 if atleast_one_docs_change and not all_docs_changes:
499 break
500
501 issue = cl.issue
rmistryb9a9e872016-09-01 09:52:32 -0700502 if issue:
Ravi Mistry4722a412018-05-03 08:02:03 -0400503 # Skip PostUploadHooks for all auto-commit service account bots. New
504 # patchsets (caused due to PostUploadHooks) invalidates the CQ+2 vote from
505 # the "--use-commit-queue" flag to "git cl upload".
506 for suffix in SERVICE_ACCOUNT_SUFFIX:
507 if cl.GetIssueOwner().endswith(suffix):
508 return results
Ravi Mistryb5e2acc2017-12-07 11:10:11 -0500509
Eric Borenbf17eec2017-04-03 08:30:35 -0400510 original_description_lines, footers = cl.GetDescriptionFooters()
511 new_description_lines = list(original_description_lines)
rmistryd223fb22015-02-26 10:16:13 -0800512
Ravi Mistry355feab2017-05-23 14:24:08 -0400513 # If the change includes only doc changes then add No-Try: true in the
Ravi Mistryb5e2acc2017-12-07 11:10:11 -0500514 # CL's description if it does not exist yet.
515 if all_docs_changes and not _FooterExists(footers, 'No-Try', 'true'):
Ravi Mistry355feab2017-05-23 14:24:08 -0400516 new_description_lines.append('No-Try: true')
rmistryd223fb22015-02-26 10:16:13 -0800517 results.append(
518 output_api.PresubmitNotifyResult(
519 'This change has only doc changes. Automatically added '
Ravi Mistry355feab2017-05-23 14:24:08 -0400520 '\'No-Try: true\' to the CL\'s description'))
rmistryd223fb22015-02-26 10:16:13 -0800521
522 # If there is atleast one docs change then add preview link in the CL's
523 # description if it does not already exist there.
Ravi Mistry355feab2017-05-23 14:24:08 -0400524 docs_preview_link = '%s%s' % (DOCS_PREVIEW_URL, issue)
525 docs_preview_line = 'Docs-Preview: %s' % docs_preview_link
Eric Borenbf17eec2017-04-03 08:30:35 -0400526 if (atleast_one_docs_change and
Ravi Mistry355feab2017-05-23 14:24:08 -0400527 not _FooterExists(footers, 'Docs-Preview', docs_preview_link)):
rmistryd223fb22015-02-26 10:16:13 -0800528 # Automatically add a link to where the docs can be previewed.
Eric Borenbf17eec2017-04-03 08:30:35 -0400529 new_description_lines.append(docs_preview_line)
rmistryd223fb22015-02-26 10:16:13 -0800530 results.append(
531 output_api.PresubmitNotifyResult(
532 'Automatically added a link to preview the docs changes to the '
533 'CL\'s description'))
534
Ravi Mistry355feab2017-05-23 14:24:08 -0400535 # If the target ref is not master then add 'No-Tree-Checks: true' and
536 # 'No-Try: true' to the CL's description if it does not already exist there.
rmistryb9a9e872016-09-01 09:52:32 -0700537 target_ref = cl.GetRemoteBranch()[1]
538 if target_ref != 'refs/remotes/origin/master':
Ravi Mistry355feab2017-05-23 14:24:08 -0400539 if not _FooterExists(footers, 'No-Tree-Checks', 'true'):
540 new_description_lines.append('No-Tree-Checks: true')
rmistry896f3932015-02-26 11:52:05 -0800541 results.append(
542 output_api.PresubmitNotifyResult(
543 'Branch changes do not need to rely on the master branch\'s '
Ravi Mistry355feab2017-05-23 14:24:08 -0400544 'tree status. Automatically added \'No-Tree-Checks: true\' to '
545 'the CL\'s description'))
546 if not _FooterExists(footers, 'No-Try', 'true'):
547 new_description_lines.append('No-Try: true')
rmistry896f3932015-02-26 11:52:05 -0800548 results.append(
549 output_api.PresubmitNotifyResult(
550 'Trybots do not yet work for non-master branches. '
Ravi Mistry355feab2017-05-23 14:24:08 -0400551 'Automatically added \'No-Try: true\' to the CL\'s '
552 'description'))
553 if not _FooterExists(footers, 'No-Presubmit', 'true'):
554 new_description_lines.append('No-Presubmit: true')
borenetaf6005c2015-06-04 15:15:42 -0700555 results.append(
556 output_api.PresubmitNotifyResult(
557 'Branch changes do not run the presubmit checks.'))
rmistry896f3932015-02-26 11:52:05 -0800558
Ravi Mistry6f0751e2017-09-12 13:18:12 -0400559 # Automatically set Cq-Include-Trybots if any of the changed files here
rmistry3b3ee202016-07-11 08:27:49 -0700560 # begin with the paths of interest.
Ravi Mistry6f0751e2017-09-12 13:18:12 -0400561 bots_to_include = []
rmistry58276532015-10-01 08:24:03 -0700562 for affected_file in change.AffectedFiles():
563 affected_file_path = affected_file.LocalPath()
564 for path_prefix, extra_bots in PATH_PREFIX_TO_EXTRA_TRYBOTS.iteritems():
565 if affected_file_path.startswith(path_prefix):
566 results.append(
567 output_api.PresubmitNotifyResult(
568 'Your CL modifies the path %s.\nAutomatically adding %s to '
569 'the CL description.' % (affected_file_path, extra_bots)))
Ravi Mistry6f0751e2017-09-12 13:18:12 -0400570 bots_to_include.append(extra_bots)
571 if bots_to_include:
572 output_api.EnsureCQIncludeTrybotsAreAdded(
573 cl, bots_to_include, new_description_lines)
rmistry896f3932015-02-26 11:52:05 -0800574
rmistryd223fb22015-02-26 10:16:13 -0800575 # If the description has changed update it.
Eric Borenbf17eec2017-04-03 08:30:35 -0400576 if new_description_lines != original_description_lines:
Ravi Mistryee06ffe2017-05-08 12:59:56 -0400577 # Add a new line separating the new contents from the old contents.
578 new_description_lines.insert(len(original_description_lines), '')
Eric Borenbf17eec2017-04-03 08:30:35 -0400579 cl.UpdateDescriptionFooters(new_description_lines, footers)
rmistryd223fb22015-02-26 10:16:13 -0800580
581 return results
582
583
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000584def CheckChangeOnCommit(input_api, output_api):
585 """Presubmit checks for the change on commit.
586
587 The following are the presubmit checks:
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000588 * Check change has one and only one EOL.
rmistry@google.comc2993442013-01-23 14:35:58 +0000589 * Ensures that the Skia tree is open in
590 http://skia-tree-status.appspot.com/. Shows a warning if it is in 'Caution'
591 state and an error if it is in 'Closed' state.
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000592 """
593 results = []
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000594 results.extend(_CommonChecks(input_api, output_api))
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000595 results.extend(
rmistry@google.comc2993442013-01-23 14:35:58 +0000596 _CheckTreeStatus(input_api, output_api, json_url=(
rmistry@google.com547012d2013-04-12 19:45:46 +0000597 SKIA_TREE_STATUS_URL + '/banner-status?format=json')))
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000598 results.extend(_CheckLGTMsForPublicAPI(input_api, output_api))
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000599 results.extend(_CheckOwnerIsInAuthorsFile(input_api, output_api))
Ravi Mistrya70cb8a2017-09-12 13:52:05 -0400600 # Checks for the presence of 'DO NOT''SUBMIT' in CL description and in
601 # content of files.
602 results.extend(
603 input_api.canned_checks.CheckDoNotSubmit(input_api, output_api))
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000604 return results