blob: 2513c9cbec86f3e5d42e401567bfadf235d92a78 [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 = (
Mike Reed7dafb092019-04-02 10:16:42 -040028 'mtklein@chromium.org',
29 'mtklein@google.com',
rmistry@google.comfb4a68d2013-08-12 14:51:20 +000030 'reed@chromium.org',
31 'reed@google.com',
32 'bsalomon@chromium.org',
33 'bsalomon@google.com',
rmistry83fab472014-07-18 05:25:56 -070034 'djsollen@chromium.org',
35 'djsollen@google.com',
Ravi Mistryfbff3292017-01-19 12:00:08 -050036 'hcm@chromium.org',
37 'hcm@google.com',
rmistry@google.comfb4a68d2013-08-12 14:51:20 +000038)
39
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +000040AUTHORS_FILE_NAME = 'AUTHORS'
41
Joe Gregorio73259422018-05-22 15:29:03 +000042DOCS_PREVIEW_URL = 'https://skia.org/?cl='
rmistryd88b0be2016-05-20 03:50:01 -070043GOLD_TRYBOT_URL = 'https://gold.skia.org/search?issue='
rmistryd223fb22015-02-26 10:16:13 -080044
Eric Boren1eec99c2018-04-26 13:09:48 -040045SERVICE_ACCOUNT_SUFFIX = [
Eric Boren47ed6f12018-04-26 14:02:43 -040046 '@%s.iam.gserviceaccount.com' % project for project in [
Eric Boren6ad3ca42018-09-07 14:22:16 -040047 'skia-buildbots.google.com', 'skia-swarming-bots', 'skia-public',
Ravi Mistry53c44232019-03-12 08:51:42 -040048 'skia-corp.google.com', 'chops-service-accounts']]
Eric Borendd988292018-01-02 13:29:21 -050049
rmistry@google.com547012d2013-04-12 19:45:46 +000050
rmistry@google.com713276b2013-01-25 18:27:34 +000051def _CheckChangeHasEol(input_api, output_api, source_file_filter=None):
52 """Checks that files end with atleast one \n (LF)."""
53 eof_files = []
54 for f in input_api.AffectedSourceFiles(source_file_filter):
55 contents = input_api.ReadFile(f, 'rb')
56 # Check that the file ends in atleast one newline character.
57 if len(contents) > 1 and contents[-1:] != '\n':
58 eof_files.append(f.LocalPath())
59
60 if eof_files:
61 return [output_api.PresubmitPromptWarning(
62 'These files should end in a newline character:',
63 items=eof_files)]
64 return []
65
66
Ben Wagnercf42e982018-02-09 17:41:20 -050067def _JsonChecks(input_api, output_api):
68 """Run checks on any modified json files."""
69 failing_files = []
70 for affected_file in input_api.AffectedFiles(None):
71 affected_file_path = affected_file.LocalPath()
72 is_json = affected_file_path.endswith('.json')
73 is_metadata = (affected_file_path.startswith('site/') and
74 affected_file_path.endswith('/METADATA'))
75 if is_json or is_metadata:
76 try:
77 input_api.json.load(open(affected_file_path, 'r'))
78 except ValueError:
79 failing_files.append(affected_file_path)
80
81 results = []
82 if failing_files:
83 results.append(
84 output_api.PresubmitError(
85 'The following files contain invalid json:\n%s\n\n' %
86 '\n'.join(failing_files)))
87 return results
88
89
rmistry01cbf6c2015-03-12 07:48:40 -070090def _IfDefChecks(input_api, output_api):
91 """Ensures if/ifdef are not before includes. See skbug/3362 for details."""
92 comment_block_start_pattern = re.compile('^\s*\/\*.*$')
93 comment_block_middle_pattern = re.compile('^\s+\*.*')
94 comment_block_end_pattern = re.compile('^\s+\*\/.*$')
95 single_line_comment_pattern = re.compile('^\s*//.*$')
96 def is_comment(line):
97 return (comment_block_start_pattern.match(line) or
98 comment_block_middle_pattern.match(line) or
99 comment_block_end_pattern.match(line) or
100 single_line_comment_pattern.match(line))
101
102 empty_line_pattern = re.compile('^\s*$')
103 def is_empty_line(line):
104 return empty_line_pattern.match(line)
105
106 failing_files = []
107 for affected_file in input_api.AffectedSourceFiles(None):
108 affected_file_path = affected_file.LocalPath()
109 if affected_file_path.endswith('.cpp') or affected_file_path.endswith('.h'):
110 f = open(affected_file_path)
111 for line in f.xreadlines():
112 if is_comment(line) or is_empty_line(line):
113 continue
114 # The below will be the first real line after comments and newlines.
115 if line.startswith('#if 0 '):
116 pass
117 elif line.startswith('#if ') or line.startswith('#ifdef '):
118 failing_files.append(affected_file_path)
119 break
120
121 results = []
122 if failing_files:
123 results.append(
124 output_api.PresubmitError(
125 'The following files have #if or #ifdef before includes:\n%s\n\n'
halcanary6950de62015-11-07 05:29:00 -0800126 'See https://bug.skia.org/3362 for why this should be fixed.' %
rmistry01cbf6c2015-03-12 07:48:40 -0700127 '\n'.join(failing_files)))
128 return results
129
130
borenetc7c91802015-03-25 04:47:02 -0700131def _CopyrightChecks(input_api, output_api, source_file_filter=None):
132 results = []
133 year_pattern = r'\d{4}'
134 year_range_pattern = r'%s(-%s)?' % (year_pattern, year_pattern)
135 years_pattern = r'%s(,%s)*,?' % (year_range_pattern, year_range_pattern)
136 copyright_pattern = (
137 r'Copyright (\([cC]\) )?%s \w+' % years_pattern)
138
139 for affected_file in input_api.AffectedSourceFiles(source_file_filter):
140 if 'third_party' in affected_file.LocalPath():
141 continue
142 contents = input_api.ReadFile(affected_file, 'rb')
143 if not re.search(copyright_pattern, contents):
144 results.append(output_api.PresubmitError(
145 '%s is missing a correct copyright header.' % affected_file))
146 return results
147
148
mtkleine4b19c42015-05-05 10:28:44 -0700149def _ToolFlags(input_api, output_api):
150 """Make sure `{dm,nanobench}_flags.py test` passes if modified."""
151 results = []
152 sources = lambda x: ('dm_flags.py' in x.LocalPath() or
153 'nanobench_flags.py' in x.LocalPath())
154 for f in input_api.AffectedSourceFiles(sources):
155 if 0 != subprocess.call(['python', f.LocalPath(), 'test']):
156 results.append(output_api.PresubmitError('`python %s test` failed' % f))
157 return results
158
159
borenet2dbbfa52016-10-14 06:32:09 -0700160def _InfraTests(input_api, output_api):
161 """Run the infra tests."""
borenet1ed2ae42016-07-26 11:52:17 -0700162 results = []
mtklein3da80f52016-07-27 04:14:07 -0700163 if not any(f.LocalPath().startswith('infra')
164 for f in input_api.AffectedFiles()):
165 return results
166
borenet2dbbfa52016-10-14 06:32:09 -0700167 cmd = ['python', os.path.join('infra', 'bots', 'infra_tests.py')]
borenet60b0a2d2016-10-04 12:45:41 -0700168 try:
169 subprocess.check_output(cmd)
170 except subprocess.CalledProcessError as e:
171 results.append(output_api.PresubmitError(
172 '`%s` failed:\n%s' % (' '.join(cmd), e.output)))
173 return results
174
175
mtklein4db3b792016-08-03 14:18:22 -0700176def _CheckGNFormatted(input_api, output_api):
177 """Make sure any .gn files we're changing have been formatted."""
178 results = []
179 for f in input_api.AffectedFiles():
Mike Kleina5fb6152016-10-26 14:17:04 -0400180 if (not f.LocalPath().endswith('.gn') and
181 not f.LocalPath().endswith('.gni')):
mtklein4db3b792016-08-03 14:18:22 -0700182 continue
183
Mike Klein7a1c53d2016-10-11 14:03:06 -0400184 gn = 'gn.bat' if 'win32' in sys.platform else 'gn'
185 cmd = [gn, 'format', '--dry-run', f.LocalPath()]
mtklein4db3b792016-08-03 14:18:22 -0700186 try:
187 subprocess.check_output(cmd)
188 except subprocess.CalledProcessError:
mtkleind434b012016-08-10 07:30:58 -0700189 fix = 'gn format ' + f.LocalPath()
mtklein4db3b792016-08-03 14:18:22 -0700190 results.append(output_api.PresubmitError(
mtkleind434b012016-08-10 07:30:58 -0700191 '`%s` failed, try\n\t%s' % (' '.join(cmd), fix)))
mtklein4db3b792016-08-03 14:18:22 -0700192 return results
193
borenet1ed2ae42016-07-26 11:52:17 -0700194
Eric Boren58d1f762019-07-19 08:07:44 -0400195def _CheckCompileIsolate(input_api, output_api):
196 """Ensure that gen_compile_isolate.py does not change compile.isolate."""
197 # Only run the check if files were added or removed.
198 results = []
199 script = os.path.join('infra', 'bots', 'gen_compile_isolate.py')
200 isolate = os.path.join('infra', 'bots', 'compile.isolated')
201 for f in input_api.AffectedFiles():
202 if f.Action() in ('A', 'D', 'R'):
203 break
204 if f.LocalPath() in (script, isolate):
205 break
206 else:
207 return results
208
209 cmd = ['python', script, 'test']
210 try:
211 subprocess.check_output(cmd, stderr=subprocess.STDOUT)
212 except subprocess.CalledProcessError as e:
213 results.append(output_api.PresubmitError(e.output))
214 return results
215
216
Ben Wagner88855502017-10-12 17:55:19 -0400217class _WarningsAsErrors():
218 def __init__(self, output_api):
219 self.output_api = output_api
220 self.old_warning = None
221 def __enter__(self):
222 self.old_warning = self.output_api.PresubmitPromptWarning
223 self.output_api.PresubmitPromptWarning = self.output_api.PresubmitError
224 return self.output_api
225 def __exit__(self, ex_type, ex_value, ex_traceback):
226 self.output_api.PresubmitPromptWarning = self.old_warning
227
228
Eric Boren6dc00212019-07-24 15:15:43 -0400229def _CheckDEPSValid(input_api, output_api):
230 """Ensure that DEPS contains valid entries."""
231 results = []
232 script = os.path.join('infra', 'bots', 'check_deps.py')
233 relevant_files = ('DEPS', script)
234 for f in input_api.AffectedFiles():
235 if f.LocalPath() in relevant_files:
236 break
237 else:
238 return results
239 cmd = ['python', script]
240 try:
241 subprocess.check_output(cmd, stderr=subprocess.STDOUT)
242 except subprocess.CalledProcessError as e:
243 results.append(output_api.PresubmitError(e.output))
244 return results
245
246
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000247def _CommonChecks(input_api, output_api):
248 """Presubmit checks common to upload and commit."""
249 results = []
250 sources = lambda x: (x.LocalPath().endswith('.h') or
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000251 x.LocalPath().endswith('.py') or
252 x.LocalPath().endswith('.sh') or
mtklein18e55802015-03-25 07:21:20 -0700253 x.LocalPath().endswith('.m') or
254 x.LocalPath().endswith('.mm') or
255 x.LocalPath().endswith('.go') or
256 x.LocalPath().endswith('.c') or
257 x.LocalPath().endswith('.cc') or
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000258 x.LocalPath().endswith('.cpp'))
Ben Wagner88855502017-10-12 17:55:19 -0400259 results.extend(_CheckChangeHasEol(
260 input_api, output_api, source_file_filter=sources))
261 with _WarningsAsErrors(output_api):
262 results.extend(input_api.canned_checks.CheckChangeHasNoCR(
263 input_api, output_api, source_file_filter=sources))
264 results.extend(input_api.canned_checks.CheckChangeHasNoStrayWhitespace(
265 input_api, output_api, source_file_filter=sources))
Ben Wagnercf42e982018-02-09 17:41:20 -0500266 results.extend(_JsonChecks(input_api, output_api))
rmistry01cbf6c2015-03-12 07:48:40 -0700267 results.extend(_IfDefChecks(input_api, output_api))
borenetc7c91802015-03-25 04:47:02 -0700268 results.extend(_CopyrightChecks(input_api, output_api,
269 source_file_filter=sources))
mtkleine4b19c42015-05-05 10:28:44 -0700270 results.extend(_ToolFlags(input_api, output_api))
Eric Boren58d1f762019-07-19 08:07:44 -0400271 results.extend(_CheckCompileIsolate(input_api, output_api))
Eric Boren6dc00212019-07-24 15:15:43 -0400272 results.extend(_CheckDEPSValid(input_api, output_api))
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000273 return results
274
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000275
276def CheckChangeOnUpload(input_api, output_api):
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000277 """Presubmit checks for the change on upload.
278
279 The following are the presubmit checks:
280 * Check change has one and only one EOL.
281 """
282 results = []
283 results.extend(_CommonChecks(input_api, output_api))
borenet1ed2ae42016-07-26 11:52:17 -0700284 # Run on upload, not commit, since the presubmit bot apparently doesn't have
borenet60b0a2d2016-10-04 12:45:41 -0700285 # coverage or Go installed.
borenet2dbbfa52016-10-14 06:32:09 -0700286 results.extend(_InfraTests(input_api, output_api))
borenet60b0a2d2016-10-04 12:45:41 -0700287
mtklein4db3b792016-08-03 14:18:22 -0700288 results.extend(_CheckGNFormatted(input_api, output_api))
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000289 return results
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000290
291
rmistry@google.comc2993442013-01-23 14:35:58 +0000292def _CheckTreeStatus(input_api, output_api, json_url):
293 """Check whether to allow commit.
294
295 Args:
296 input_api: input related apis.
297 output_api: output related apis.
298 json_url: url to download json style status.
299 """
300 tree_status_results = input_api.canned_checks.CheckTreeIsOpen(
301 input_api, output_api, json_url=json_url)
302 if not tree_status_results:
303 # Check for caution state only if tree is not closed.
304 connection = input_api.urllib2.urlopen(json_url)
305 status = input_api.json.loads(connection.read())
306 connection.close()
rmistry@google.comf6c5f752013-03-29 17:26:00 +0000307 if ('caution' in status['message'].lower() and
308 os.isatty(sys.stdout.fileno())):
309 # Display a prompt only if we are in an interactive shell. Without this
310 # check the commit queue behaves incorrectly because it considers
311 # prompts to be failures.
rmistry@google.comc2993442013-01-23 14:35:58 +0000312 short_text = 'Tree state is: ' + status['general_state']
313 long_text = status['message'] + '\n' + json_url
314 tree_status_results.append(
315 output_api.PresubmitPromptWarning(
316 message=short_text, long_text=long_text))
rmistry@google.com547012d2013-04-12 19:45:46 +0000317 else:
318 # Tree status is closed. Put in message about contacting sheriff.
319 connection = input_api.urllib2.urlopen(
320 SKIA_TREE_STATUS_URL + '/current-sheriff')
321 sheriff_details = input_api.json.loads(connection.read())
322 if sheriff_details:
323 tree_status_results[0]._message += (
324 '\n\nPlease contact the current Skia sheriff (%s) if you are trying '
325 'to submit a build fix\nand do not know how to submit because the '
326 'tree is closed') % sheriff_details['username']
rmistry@google.comc2993442013-01-23 14:35:58 +0000327 return tree_status_results
328
329
rmistryb398ecc2016-08-29 08:13:29 -0700330class CodeReview(object):
331 """Abstracts which codereview tool is used for the specified issue."""
332
333 def __init__(self, input_api):
334 self._issue = input_api.change.issue
335 self._gerrit = input_api.gerrit
rmistryb398ecc2016-08-29 08:13:29 -0700336
337 def GetOwnerEmail(self):
Aaron Gablea49909a2017-10-09 12:50:52 -0700338 return self._gerrit.GetChangeOwner(self._issue)
rmistryb398ecc2016-08-29 08:13:29 -0700339
340 def GetSubject(self):
Aaron Gablea49909a2017-10-09 12:50:52 -0700341 return self._gerrit.GetChangeInfo(self._issue)['subject']
rmistryb398ecc2016-08-29 08:13:29 -0700342
343 def GetDescription(self):
Aaron Gablea49909a2017-10-09 12:50:52 -0700344 return self._gerrit.GetChangeDescription(self._issue)
rmistryb398ecc2016-08-29 08:13:29 -0700345
346 def IsDryRun(self):
Aaron Gablea49909a2017-10-09 12:50:52 -0700347 return self._gerrit.GetChangeInfo(
348 self._issue)['labels']['Commit-Queue'].get('value', 0) == 1
rmistryb398ecc2016-08-29 08:13:29 -0700349
Ravi Mistry39eabb62016-10-05 08:41:12 -0400350 def GetReviewers(self):
Aaron Gablea49909a2017-10-09 12:50:52 -0700351 code_review_label = (
352 self._gerrit.GetChangeInfo(self._issue)['labels']['Code-Review'])
353 return [r['email'] for r in code_review_label.get('all', [])]
Ravi Mistry39eabb62016-10-05 08:41:12 -0400354
rmistryb398ecc2016-08-29 08:13:29 -0700355 def GetApprovers(self):
356 approvers = []
Aaron Gablea49909a2017-10-09 12:50:52 -0700357 code_review_label = (
358 self._gerrit.GetChangeInfo(self._issue)['labels']['Code-Review'])
359 for m in code_review_label.get('all', []):
360 if m.get("value") == 1:
361 approvers.append(m["email"])
rmistryb398ecc2016-08-29 08:13:29 -0700362 return approvers
363
364
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000365def _CheckOwnerIsInAuthorsFile(input_api, output_api):
366 results = []
rmistryb398ecc2016-08-29 08:13:29 -0700367 if input_api.change.issue:
368 cr = CodeReview(input_api)
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000369
rmistryb398ecc2016-08-29 08:13:29 -0700370 owner_email = cr.GetOwnerEmail()
Eric Borendd988292018-01-02 13:29:21 -0500371
372 # Service accounts don't need to be in AUTHORS.
Eric Boren1eec99c2018-04-26 13:09:48 -0400373 for suffix in SERVICE_ACCOUNT_SUFFIX:
374 if owner_email.endswith(suffix):
375 return results
Eric Borendd988292018-01-02 13:29:21 -0500376
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000377 try:
378 authors_content = ''
379 for line in open(AUTHORS_FILE_NAME):
380 if not line.startswith('#'):
381 authors_content += line
382 email_fnmatches = re.findall('<(.*)>', authors_content)
383 for email_fnmatch in email_fnmatches:
384 if fnmatch.fnmatch(owner_email, email_fnmatch):
385 # Found a match, the user is in the AUTHORS file break out of the loop
386 break
387 else:
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000388 results.append(
389 output_api.PresubmitError(
390 'The email %s is not in Skia\'s AUTHORS file.\n'
391 'Issue owner, this CL must include an addition to the Skia AUTHORS '
rmistry9806d4d2015-10-01 08:10:54 -0700392 'file.'
rmistry83fab472014-07-18 05:25:56 -0700393 % owner_email))
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000394 except IOError:
395 # Do not fail if authors file cannot be found.
396 traceback.print_exc()
397 input_api.logging.error('AUTHORS file not found!')
398
399 return results
400
401
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000402def _CheckLGTMsForPublicAPI(input_api, output_api):
403 """Check LGTMs for public API changes.
404
405 For public API files make sure there is an LGTM from the list of owners in
406 PUBLIC_API_OWNERS.
407 """
408 results = []
409 requires_owner_check = False
rmistry9407ece2014-08-26 14:00:54 -0700410 for affected_file in input_api.AffectedFiles():
411 affected_file_path = affected_file.LocalPath()
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000412 file_path, file_ext = os.path.splitext(affected_file_path)
rmistry9407ece2014-08-26 14:00:54 -0700413 # We only care about files that end in .h and are under the top-level
mtkleinbda12672015-07-28 08:54:12 -0700414 # include dir, but not include/private.
415 if (file_ext == '.h' and
416 'include' == file_path.split(os.path.sep)[0] and
417 'private' not in file_path):
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000418 requires_owner_check = True
419
420 if not requires_owner_check:
421 return results
422
423 lgtm_from_owner = False
rmistryb398ecc2016-08-29 08:13:29 -0700424 if input_api.change.issue:
425 cr = CodeReview(input_api)
426
427 if re.match(REVERT_CL_SUBJECT_PREFIX, cr.GetSubject(), re.I):
commit-bot@chromium.orgcfdc5962014-01-31 17:33:04 +0000428 # It is a revert CL, ignore the public api owners check.
429 return results
rmistryf2d83ca2014-08-26 10:30:29 -0700430
rmistryb398ecc2016-08-29 08:13:29 -0700431 if cr.IsDryRun():
rmistry04abf132015-04-07 07:41:51 -0700432 # Ignore public api owners check for dry run CLs since they are not
rmistryf91b7172015-03-12 09:48:10 -0700433 # going to be committed.
434 return results
435
Ravi Mistry39eabb62016-10-05 08:41:12 -0400436 if input_api.gerrit:
437 for reviewer in cr.GetReviewers():
438 if reviewer in PUBLIC_API_OWNERS:
439 # If an owner is specified as an reviewer in Gerrit then ignore the
440 # public api owners check.
rmistryf2d83ca2014-08-26 10:30:29 -0700441 return results
Ravi Mistry39eabb62016-10-05 08:41:12 -0400442 else:
443 match = re.search(r'^TBR=(.*)$', cr.GetDescription(), re.M)
444 if match:
445 tbr_section = match.group(1).strip().split(' ')[0]
446 tbr_entries = tbr_section.split(',')
447 for owner in PUBLIC_API_OWNERS:
448 if owner in tbr_entries or owner.split('@')[0] in tbr_entries:
449 # If an owner is specified in the TBR= line then ignore the public
450 # api owners check.
451 return results
rmistryf2d83ca2014-08-26 10:30:29 -0700452
rmistryb398ecc2016-08-29 08:13:29 -0700453 if cr.GetOwnerEmail() in PUBLIC_API_OWNERS:
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000454 # An owner created the CL that is an automatic LGTM.
455 lgtm_from_owner = True
456
rmistryb398ecc2016-08-29 08:13:29 -0700457 for approver in cr.GetApprovers():
458 if approver in PUBLIC_API_OWNERS:
459 # Found an lgtm in a message from an owner.
460 lgtm_from_owner = True
461 break
commit-bot@chromium.orgcfdc5962014-01-31 17:33:04 +0000462
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000463 if not lgtm_from_owner:
464 results.append(
465 output_api.PresubmitError(
mtkleinbda12672015-07-28 08:54:12 -0700466 "If this CL adds to or changes Skia's public API, you need an LGTM "
467 "from any of %s. If this CL only removes from or doesn't change "
Ravi Mistrydbb84c22016-10-05 12:47:44 -0400468 "Skia's public API, please add a short note to the CL saying so. "
Aaron Gablea49909a2017-10-09 12:50:52 -0700469 "Add one of the owners as a reviewer to your CL as well as to the "
470 "TBR= line. If you don't know if this CL affects Skia's public "
471 "API, treat it like it does." % str(PUBLIC_API_OWNERS)))
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000472 return results
473
474
Ravi Mistry355feab2017-05-23 14:24:08 -0400475def _FooterExists(footers, key, value):
476 for k, v in footers:
477 if k == key and v == value:
478 return True
479 return False
480
481
rmistryd223fb22015-02-26 10:16:13 -0800482def PostUploadHook(cl, change, output_api):
483 """git cl upload will call this hook after the issue is created/modified.
484
485 This hook does the following:
486 * Adds a link to preview docs changes if there are any docs changes in the CL.
Ravi Mistry355feab2017-05-23 14:24:08 -0400487 * Adds 'No-Try: true' if the CL contains only docs changes.
rmistryd223fb22015-02-26 10:16:13 -0800488 """
489
490 results = []
491 atleast_one_docs_change = False
492 all_docs_changes = True
493 for affected_file in change.AffectedFiles():
494 affected_file_path = affected_file.LocalPath()
495 file_path, _ = os.path.splitext(affected_file_path)
496 if 'site' == file_path.split(os.path.sep)[0]:
497 atleast_one_docs_change = True
498 else:
499 all_docs_changes = False
500 if atleast_one_docs_change and not all_docs_changes:
501 break
502
503 issue = cl.issue
rmistryb9a9e872016-09-01 09:52:32 -0700504 if issue:
Ravi Mistry4722a412018-05-03 08:02:03 -0400505 # Skip PostUploadHooks for all auto-commit service account bots. New
506 # patchsets (caused due to PostUploadHooks) invalidates the CQ+2 vote from
507 # the "--use-commit-queue" flag to "git cl upload".
508 for suffix in SERVICE_ACCOUNT_SUFFIX:
509 if cl.GetIssueOwner().endswith(suffix):
510 return results
Ravi Mistryb5e2acc2017-12-07 11:10:11 -0500511
Eric Borenbf17eec2017-04-03 08:30:35 -0400512 original_description_lines, footers = cl.GetDescriptionFooters()
513 new_description_lines = list(original_description_lines)
rmistryd223fb22015-02-26 10:16:13 -0800514
Ravi Mistry355feab2017-05-23 14:24:08 -0400515 # If the change includes only doc changes then add No-Try: true in the
Ravi Mistryb5e2acc2017-12-07 11:10:11 -0500516 # CL's description if it does not exist yet.
517 if all_docs_changes and not _FooterExists(footers, 'No-Try', 'true'):
Ravi Mistry355feab2017-05-23 14:24:08 -0400518 new_description_lines.append('No-Try: true')
rmistryd223fb22015-02-26 10:16:13 -0800519 results.append(
520 output_api.PresubmitNotifyResult(
521 'This change has only doc changes. Automatically added '
Ravi Mistry355feab2017-05-23 14:24:08 -0400522 '\'No-Try: true\' to the CL\'s description'))
rmistryd223fb22015-02-26 10:16:13 -0800523
524 # If there is atleast one docs change then add preview link in the CL's
525 # description if it does not already exist there.
Ravi Mistry355feab2017-05-23 14:24:08 -0400526 docs_preview_link = '%s%s' % (DOCS_PREVIEW_URL, issue)
527 docs_preview_line = 'Docs-Preview: %s' % docs_preview_link
Eric Borenbf17eec2017-04-03 08:30:35 -0400528 if (atleast_one_docs_change and
Ravi Mistry355feab2017-05-23 14:24:08 -0400529 not _FooterExists(footers, 'Docs-Preview', docs_preview_link)):
rmistryd223fb22015-02-26 10:16:13 -0800530 # Automatically add a link to where the docs can be previewed.
Eric Borenbf17eec2017-04-03 08:30:35 -0400531 new_description_lines.append(docs_preview_line)
rmistryd223fb22015-02-26 10:16:13 -0800532 results.append(
533 output_api.PresubmitNotifyResult(
534 'Automatically added a link to preview the docs changes to the '
535 'CL\'s description'))
536
537 # If the description has changed update it.
Eric Borenbf17eec2017-04-03 08:30:35 -0400538 if new_description_lines != original_description_lines:
Ravi Mistryee06ffe2017-05-08 12:59:56 -0400539 # Add a new line separating the new contents from the old contents.
540 new_description_lines.insert(len(original_description_lines), '')
Eric Borenbf17eec2017-04-03 08:30:35 -0400541 cl.UpdateDescriptionFooters(new_description_lines, footers)
rmistryd223fb22015-02-26 10:16:13 -0800542
543 return results
544
545
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000546def CheckChangeOnCommit(input_api, output_api):
547 """Presubmit checks for the change on commit.
548
549 The following are the presubmit checks:
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000550 * Check change has one and only one EOL.
rmistry@google.comc2993442013-01-23 14:35:58 +0000551 * Ensures that the Skia tree is open in
552 http://skia-tree-status.appspot.com/. Shows a warning if it is in 'Caution'
553 state and an error if it is in 'Closed' state.
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000554 """
555 results = []
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000556 results.extend(_CommonChecks(input_api, output_api))
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000557 results.extend(
rmistry@google.comc2993442013-01-23 14:35:58 +0000558 _CheckTreeStatus(input_api, output_api, json_url=(
rmistry@google.com547012d2013-04-12 19:45:46 +0000559 SKIA_TREE_STATUS_URL + '/banner-status?format=json')))
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000560 results.extend(_CheckLGTMsForPublicAPI(input_api, output_api))
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000561 results.extend(_CheckOwnerIsInAuthorsFile(input_api, output_api))
Ravi Mistrya70cb8a2017-09-12 13:52:05 -0400562 # Checks for the presence of 'DO NOT''SUBMIT' in CL description and in
563 # content of files.
564 results.extend(
565 input_api.canned_checks.CheckDoNotSubmit(input_api, output_api))
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000566 return results