blob: dbdec901d7d35337057c6604394fe662cce38cd7 [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
rmistryf2d83ca2014-08-26 10:30:29 -070024# Please add the complete email address here (and not just 'xyz@' or 'xyz').
rmistry@google.comfb4a68d2013-08-12 14:51:20 +000025PUBLIC_API_OWNERS = (
Mike Reed7dafb092019-04-02 10:16:42 -040026 'mtklein@google.com',
rmistry@google.comfb4a68d2013-08-12 14:51:20 +000027 'reed@chromium.org',
28 'reed@google.com',
29 'bsalomon@chromium.org',
30 'bsalomon@google.com',
rmistry83fab472014-07-18 05:25:56 -070031 'djsollen@chromium.org',
32 'djsollen@google.com',
Ravi Mistryfbff3292017-01-19 12:00:08 -050033 'hcm@chromium.org',
34 'hcm@google.com',
rmistry@google.comfb4a68d2013-08-12 14:51:20 +000035)
36
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +000037AUTHORS_FILE_NAME = 'AUTHORS'
Ravi Mistry57735162019-07-25 13:45:15 -040038RELEASE_NOTES_FILE_NAME = 'RELEASE_NOTES.txt'
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +000039
Edward Lemur2b7876c2020-01-17 18:48:13 -050040DOCS_PREVIEW_URL = 'https://skia.org/?cl={issue}'
rmistryd88b0be2016-05-20 03:50:01 -070041GOLD_TRYBOT_URL = 'https://gold.skia.org/search?issue='
rmistryd223fb22015-02-26 10:16:13 -080042
Eric Boren1eec99c2018-04-26 13:09:48 -040043SERVICE_ACCOUNT_SUFFIX = [
Eric Boren47ed6f12018-04-26 14:02:43 -040044 '@%s.iam.gserviceaccount.com' % project for project in [
Eric Boren6ad3ca42018-09-07 14:22:16 -040045 'skia-buildbots.google.com', 'skia-swarming-bots', 'skia-public',
Ravi Mistry53c44232019-03-12 08:51:42 -040046 'skia-corp.google.com', 'chops-service-accounts']]
Eric Borendd988292018-01-02 13:29:21 -050047
rmistry@google.com547012d2013-04-12 19:45:46 +000048
rmistry@google.com713276b2013-01-25 18:27:34 +000049def _CheckChangeHasEol(input_api, output_api, source_file_filter=None):
Edward Lemur2b7876c2020-01-17 18:48:13 -050050 """Checks that files end with at least one \n (LF)."""
rmistry@google.com713276b2013-01-25 18:27:34 +000051 eof_files = []
52 for f in input_api.AffectedSourceFiles(source_file_filter):
53 contents = input_api.ReadFile(f, 'rb')
Edward Lemur2b7876c2020-01-17 18:48:13 -050054 # Check that the file ends in at least one newline character.
rmistry@google.com713276b2013-01-25 18:27:34 +000055 if len(contents) > 1 and contents[-1:] != '\n':
56 eof_files.append(f.LocalPath())
57
58 if eof_files:
59 return [output_api.PresubmitPromptWarning(
60 'These files should end in a newline character:',
61 items=eof_files)]
62 return []
63
64
Ben Wagnercf42e982018-02-09 17:41:20 -050065def _JsonChecks(input_api, output_api):
66 """Run checks on any modified json files."""
67 failing_files = []
68 for affected_file in input_api.AffectedFiles(None):
69 affected_file_path = affected_file.LocalPath()
70 is_json = affected_file_path.endswith('.json')
71 is_metadata = (affected_file_path.startswith('site/') and
72 affected_file_path.endswith('/METADATA'))
73 if is_json or is_metadata:
74 try:
75 input_api.json.load(open(affected_file_path, 'r'))
76 except ValueError:
77 failing_files.append(affected_file_path)
78
79 results = []
80 if failing_files:
81 results.append(
82 output_api.PresubmitError(
83 'The following files contain invalid json:\n%s\n\n' %
84 '\n'.join(failing_files)))
85 return results
86
87
rmistry01cbf6c2015-03-12 07:48:40 -070088def _IfDefChecks(input_api, output_api):
89 """Ensures if/ifdef are not before includes. See skbug/3362 for details."""
90 comment_block_start_pattern = re.compile('^\s*\/\*.*$')
91 comment_block_middle_pattern = re.compile('^\s+\*.*')
92 comment_block_end_pattern = re.compile('^\s+\*\/.*$')
93 single_line_comment_pattern = re.compile('^\s*//.*$')
94 def is_comment(line):
95 return (comment_block_start_pattern.match(line) or
96 comment_block_middle_pattern.match(line) or
97 comment_block_end_pattern.match(line) or
98 single_line_comment_pattern.match(line))
99
100 empty_line_pattern = re.compile('^\s*$')
101 def is_empty_line(line):
102 return empty_line_pattern.match(line)
103
104 failing_files = []
105 for affected_file in input_api.AffectedSourceFiles(None):
106 affected_file_path = affected_file.LocalPath()
107 if affected_file_path.endswith('.cpp') or affected_file_path.endswith('.h'):
108 f = open(affected_file_path)
109 for line in f.xreadlines():
110 if is_comment(line) or is_empty_line(line):
111 continue
112 # The below will be the first real line after comments and newlines.
113 if line.startswith('#if 0 '):
114 pass
115 elif line.startswith('#if ') or line.startswith('#ifdef '):
116 failing_files.append(affected_file_path)
117 break
118
119 results = []
120 if failing_files:
121 results.append(
122 output_api.PresubmitError(
123 'The following files have #if or #ifdef before includes:\n%s\n\n'
halcanary6950de62015-11-07 05:29:00 -0800124 'See https://bug.skia.org/3362 for why this should be fixed.' %
rmistry01cbf6c2015-03-12 07:48:40 -0700125 '\n'.join(failing_files)))
126 return results
127
128
borenetc7c91802015-03-25 04:47:02 -0700129def _CopyrightChecks(input_api, output_api, source_file_filter=None):
130 results = []
131 year_pattern = r'\d{4}'
132 year_range_pattern = r'%s(-%s)?' % (year_pattern, year_pattern)
133 years_pattern = r'%s(,%s)*,?' % (year_range_pattern, year_range_pattern)
134 copyright_pattern = (
135 r'Copyright (\([cC]\) )?%s \w+' % years_pattern)
136
137 for affected_file in input_api.AffectedSourceFiles(source_file_filter):
138 if 'third_party' in affected_file.LocalPath():
139 continue
140 contents = input_api.ReadFile(affected_file, 'rb')
141 if not re.search(copyright_pattern, contents):
142 results.append(output_api.PresubmitError(
143 '%s is missing a correct copyright header.' % affected_file))
144 return results
145
146
borenet2dbbfa52016-10-14 06:32:09 -0700147def _InfraTests(input_api, output_api):
148 """Run the infra tests."""
borenet1ed2ae42016-07-26 11:52:17 -0700149 results = []
mtklein3da80f52016-07-27 04:14:07 -0700150 if not any(f.LocalPath().startswith('infra')
151 for f in input_api.AffectedFiles()):
152 return results
153
borenet2dbbfa52016-10-14 06:32:09 -0700154 cmd = ['python', os.path.join('infra', 'bots', 'infra_tests.py')]
borenet60b0a2d2016-10-04 12:45:41 -0700155 try:
156 subprocess.check_output(cmd)
157 except subprocess.CalledProcessError as e:
158 results.append(output_api.PresubmitError(
159 '`%s` failed:\n%s' % (' '.join(cmd), e.output)))
160 return results
161
162
mtklein4db3b792016-08-03 14:18:22 -0700163def _CheckGNFormatted(input_api, output_api):
164 """Make sure any .gn files we're changing have been formatted."""
Ben Wagner3c4a9d32020-02-14 14:28:33 -0500165 files = []
Corentin Wallez6a5187a2020-04-08 10:24:04 +0200166 for f in input_api.AffectedFiles(include_deletes=False):
Ben Wagner3c4a9d32020-02-14 14:28:33 -0500167 if (f.LocalPath().endswith('.gn') or
168 f.LocalPath().endswith('.gni')):
169 files.append(f)
170 if not files:
171 return []
mtklein4db3b792016-08-03 14:18:22 -0700172
Ben Wagner3c4a9d32020-02-14 14:28:33 -0500173 cmd = ['python', os.path.join('bin', 'fetch-gn')]
174 try:
175 subprocess.check_output(cmd)
176 except subprocess.CalledProcessError as e:
177 return [output_api.PresubmitError(
178 '`%s` failed:\n%s' % (' '.join(cmd), e.output))]
179
180 results = []
181 for f in files:
Brian Osman70f24af2020-02-18 15:08:27 -0500182 gn = 'gn.exe' if 'win32' in sys.platform else 'gn'
Ben Wagner06265e02020-02-13 19:02:46 -0500183 gn = os.path.join(input_api.PresubmitLocalPath(), 'bin', gn)
Mike Klein7a1c53d2016-10-11 14:03:06 -0400184 cmd = [gn, 'format', '--dry-run', f.LocalPath()]
mtklein4db3b792016-08-03 14:18:22 -0700185 try:
186 subprocess.check_output(cmd)
187 except subprocess.CalledProcessError:
Ben Wagner06265e02020-02-13 19:02:46 -0500188 fix = 'bin/gn format ' + f.LocalPath()
mtklein4db3b792016-08-03 14:18:22 -0700189 results.append(output_api.PresubmitError(
mtkleind434b012016-08-10 07:30:58 -0700190 '`%s` failed, try\n\t%s' % (' '.join(cmd), fix)))
mtklein4db3b792016-08-03 14:18:22 -0700191 return results
192
Mike Kleinbb413432019-07-26 11:55:40 -0500193def _CheckIncludesFormatted(input_api, output_api):
194 """Make sure #includes in files we're changing have been formatted."""
Mike Kleinf9ad5ba2019-07-29 12:34:39 -0500195 files = [str(f) for f in input_api.AffectedFiles() if f.Action() != 'D']
Mike Kleinbb413432019-07-26 11:55:40 -0500196 cmd = ['python',
197 'tools/rewrite_includes.py',
Mike Kleinf9ad5ba2019-07-29 12:34:39 -0500198 '--dry-run'] + files
Hal Canary4df3d532019-07-30 13:49:45 -0400199 if 0 != subprocess.call(cmd):
Mike Kleinbb413432019-07-26 11:55:40 -0500200 return [output_api.PresubmitError('`%s` failed' % ' '.join(cmd))]
201 return []
borenet1ed2ae42016-07-26 11:52:17 -0700202
Eric Boren58d1f762019-07-19 08:07:44 -0400203def _CheckCompileIsolate(input_api, output_api):
204 """Ensure that gen_compile_isolate.py does not change compile.isolate."""
205 # Only run the check if files were added or removed.
206 results = []
207 script = os.path.join('infra', 'bots', 'gen_compile_isolate.py')
208 isolate = os.path.join('infra', 'bots', 'compile.isolated')
209 for f in input_api.AffectedFiles():
210 if f.Action() in ('A', 'D', 'R'):
211 break
212 if f.LocalPath() in (script, isolate):
213 break
214 else:
215 return results
216
217 cmd = ['python', script, 'test']
218 try:
219 subprocess.check_output(cmd, stderr=subprocess.STDOUT)
220 except subprocess.CalledProcessError as e:
221 results.append(output_api.PresubmitError(e.output))
222 return results
223
224
Ben Wagner88855502017-10-12 17:55:19 -0400225class _WarningsAsErrors():
226 def __init__(self, output_api):
227 self.output_api = output_api
228 self.old_warning = None
229 def __enter__(self):
230 self.old_warning = self.output_api.PresubmitPromptWarning
231 self.output_api.PresubmitPromptWarning = self.output_api.PresubmitError
232 return self.output_api
233 def __exit__(self, ex_type, ex_value, ex_traceback):
234 self.output_api.PresubmitPromptWarning = self.old_warning
235
236
Eric Boren6dc00212019-07-24 15:15:43 -0400237def _CheckDEPSValid(input_api, output_api):
238 """Ensure that DEPS contains valid entries."""
239 results = []
240 script = os.path.join('infra', 'bots', 'check_deps.py')
241 relevant_files = ('DEPS', script)
242 for f in input_api.AffectedFiles():
243 if f.LocalPath() in relevant_files:
244 break
245 else:
246 return results
247 cmd = ['python', script]
248 try:
249 subprocess.check_output(cmd, stderr=subprocess.STDOUT)
250 except subprocess.CalledProcessError as e:
251 results.append(output_api.PresubmitError(e.output))
252 return results
253
254
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000255def _CommonChecks(input_api, output_api):
256 """Presubmit checks common to upload and commit."""
257 results = []
258 sources = lambda x: (x.LocalPath().endswith('.h') or
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000259 x.LocalPath().endswith('.py') or
260 x.LocalPath().endswith('.sh') or
mtklein18e55802015-03-25 07:21:20 -0700261 x.LocalPath().endswith('.m') or
262 x.LocalPath().endswith('.mm') or
263 x.LocalPath().endswith('.go') or
264 x.LocalPath().endswith('.c') or
265 x.LocalPath().endswith('.cc') or
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000266 x.LocalPath().endswith('.cpp'))
Ben Wagner88855502017-10-12 17:55:19 -0400267 results.extend(_CheckChangeHasEol(
268 input_api, output_api, source_file_filter=sources))
269 with _WarningsAsErrors(output_api):
270 results.extend(input_api.canned_checks.CheckChangeHasNoCR(
271 input_api, output_api, source_file_filter=sources))
272 results.extend(input_api.canned_checks.CheckChangeHasNoStrayWhitespace(
273 input_api, output_api, source_file_filter=sources))
Ben Wagnercf42e982018-02-09 17:41:20 -0500274 results.extend(_JsonChecks(input_api, output_api))
rmistry01cbf6c2015-03-12 07:48:40 -0700275 results.extend(_IfDefChecks(input_api, output_api))
borenetc7c91802015-03-25 04:47:02 -0700276 results.extend(_CopyrightChecks(input_api, output_api,
277 source_file_filter=sources))
Eric Boren58d1f762019-07-19 08:07:44 -0400278 results.extend(_CheckCompileIsolate(input_api, output_api))
Eric Boren6dc00212019-07-24 15:15:43 -0400279 results.extend(_CheckDEPSValid(input_api, output_api))
Mike Kleinbb413432019-07-26 11:55:40 -0500280 results.extend(_CheckIncludesFormatted(input_api, output_api))
Mike Klein96f64012020-04-03 10:59:37 -0500281 results.extend(_CheckGNFormatted(input_api, output_api))
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000282 return results
283
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000284
285def CheckChangeOnUpload(input_api, output_api):
Ravi Mistry4c0ffe72020-03-02 13:19:02 -0500286 """Presubmit checks for the change on upload."""
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000287 results = []
288 results.extend(_CommonChecks(input_api, output_api))
borenet1ed2ae42016-07-26 11:52:17 -0700289 # Run on upload, not commit, since the presubmit bot apparently doesn't have
borenet60b0a2d2016-10-04 12:45:41 -0700290 # coverage or Go installed.
borenet2dbbfa52016-10-14 06:32:09 -0700291 results.extend(_InfraTests(input_api, output_api))
Ravi Mistry57735162019-07-25 13:45:15 -0400292 results.extend(_CheckReleaseNotesForPublicAPI(input_api, output_api))
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000293 return results
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000294
295
rmistryb398ecc2016-08-29 08:13:29 -0700296class CodeReview(object):
297 """Abstracts which codereview tool is used for the specified issue."""
298
299 def __init__(self, input_api):
300 self._issue = input_api.change.issue
301 self._gerrit = input_api.gerrit
rmistryb398ecc2016-08-29 08:13:29 -0700302
303 def GetOwnerEmail(self):
Aaron Gablea49909a2017-10-09 12:50:52 -0700304 return self._gerrit.GetChangeOwner(self._issue)
rmistryb398ecc2016-08-29 08:13:29 -0700305
306 def GetSubject(self):
Aaron Gablea49909a2017-10-09 12:50:52 -0700307 return self._gerrit.GetChangeInfo(self._issue)['subject']
rmistryb398ecc2016-08-29 08:13:29 -0700308
309 def GetDescription(self):
Aaron Gablea49909a2017-10-09 12:50:52 -0700310 return self._gerrit.GetChangeDescription(self._issue)
rmistryb398ecc2016-08-29 08:13:29 -0700311
Ravi Mistry39eabb62016-10-05 08:41:12 -0400312 def GetReviewers(self):
Aaron Gablea49909a2017-10-09 12:50:52 -0700313 code_review_label = (
314 self._gerrit.GetChangeInfo(self._issue)['labels']['Code-Review'])
315 return [r['email'] for r in code_review_label.get('all', [])]
Ravi Mistry39eabb62016-10-05 08:41:12 -0400316
rmistryb398ecc2016-08-29 08:13:29 -0700317 def GetApprovers(self):
318 approvers = []
Aaron Gablea49909a2017-10-09 12:50:52 -0700319 code_review_label = (
320 self._gerrit.GetChangeInfo(self._issue)['labels']['Code-Review'])
321 for m in code_review_label.get('all', []):
322 if m.get("value") == 1:
323 approvers.append(m["email"])
rmistryb398ecc2016-08-29 08:13:29 -0700324 return approvers
325
326
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000327def _CheckOwnerIsInAuthorsFile(input_api, output_api):
328 results = []
rmistryb398ecc2016-08-29 08:13:29 -0700329 if input_api.change.issue:
330 cr = CodeReview(input_api)
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000331
rmistryb398ecc2016-08-29 08:13:29 -0700332 owner_email = cr.GetOwnerEmail()
Eric Borendd988292018-01-02 13:29:21 -0500333
334 # Service accounts don't need to be in AUTHORS.
Eric Boren1eec99c2018-04-26 13:09:48 -0400335 for suffix in SERVICE_ACCOUNT_SUFFIX:
336 if owner_email.endswith(suffix):
337 return results
Eric Borendd988292018-01-02 13:29:21 -0500338
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
Ravi Mistry57735162019-07-25 13:45:15 -0400364def _CheckReleaseNotesForPublicAPI(input_api, output_api):
365 """Checks to see if release notes file is updated with public API changes."""
366 results = []
367 public_api_changed = False
368 release_file_changed = False
369 for affected_file in input_api.AffectedFiles():
370 affected_file_path = affected_file.LocalPath()
371 file_path, file_ext = os.path.splitext(affected_file_path)
372 # We only care about files that end in .h and are under the top-level
373 # include dir, but not include/private.
374 if (file_ext == '.h' and
375 file_path.split(os.path.sep)[0] == 'include' and
376 'private' not in file_path):
377 public_api_changed = True
378 elif affected_file_path == RELEASE_NOTES_FILE_NAME:
379 release_file_changed = True
380
381 if public_api_changed and not release_file_changed:
382 results.append(output_api.PresubmitPromptWarning(
383 'If this change affects a client API, please add a summary line '
384 'to the %s file.' % RELEASE_NOTES_FILE_NAME))
385 return results
386
387
388
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000389def _CheckLGTMsForPublicAPI(input_api, output_api):
390 """Check LGTMs for public API changes.
391
392 For public API files make sure there is an LGTM from the list of owners in
393 PUBLIC_API_OWNERS.
394 """
395 results = []
396 requires_owner_check = False
rmistry9407ece2014-08-26 14:00:54 -0700397 for affected_file in input_api.AffectedFiles():
398 affected_file_path = affected_file.LocalPath()
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000399 file_path, file_ext = os.path.splitext(affected_file_path)
rmistry9407ece2014-08-26 14:00:54 -0700400 # We only care about files that end in .h and are under the top-level
mtkleinbda12672015-07-28 08:54:12 -0700401 # include dir, but not include/private.
402 if (file_ext == '.h' and
403 'include' == file_path.split(os.path.sep)[0] and
404 'private' not in file_path):
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000405 requires_owner_check = True
406
407 if not requires_owner_check:
408 return results
409
410 lgtm_from_owner = False
rmistryb398ecc2016-08-29 08:13:29 -0700411 if input_api.change.issue:
412 cr = CodeReview(input_api)
413
414 if re.match(REVERT_CL_SUBJECT_PREFIX, cr.GetSubject(), re.I):
commit-bot@chromium.orgcfdc5962014-01-31 17:33:04 +0000415 # It is a revert CL, ignore the public api owners check.
416 return results
rmistryf2d83ca2014-08-26 10:30:29 -0700417
Ravi Mistry39eabb62016-10-05 08:41:12 -0400418 if input_api.gerrit:
419 for reviewer in cr.GetReviewers():
420 if reviewer in PUBLIC_API_OWNERS:
421 # If an owner is specified as an reviewer in Gerrit then ignore the
422 # public api owners check.
rmistryf2d83ca2014-08-26 10:30:29 -0700423 return results
Ravi Mistry39eabb62016-10-05 08:41:12 -0400424 else:
425 match = re.search(r'^TBR=(.*)$', cr.GetDescription(), re.M)
426 if match:
427 tbr_section = match.group(1).strip().split(' ')[0]
428 tbr_entries = tbr_section.split(',')
429 for owner in PUBLIC_API_OWNERS:
430 if owner in tbr_entries or owner.split('@')[0] in tbr_entries:
431 # If an owner is specified in the TBR= line then ignore the public
432 # api owners check.
433 return results
rmistryf2d83ca2014-08-26 10:30:29 -0700434
rmistryb398ecc2016-08-29 08:13:29 -0700435 if cr.GetOwnerEmail() in PUBLIC_API_OWNERS:
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000436 # An owner created the CL that is an automatic LGTM.
437 lgtm_from_owner = True
438
rmistryb398ecc2016-08-29 08:13:29 -0700439 for approver in cr.GetApprovers():
440 if approver in PUBLIC_API_OWNERS:
441 # Found an lgtm in a message from an owner.
442 lgtm_from_owner = True
443 break
commit-bot@chromium.orgcfdc5962014-01-31 17:33:04 +0000444
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000445 if not lgtm_from_owner:
446 results.append(
447 output_api.PresubmitError(
mtkleinbda12672015-07-28 08:54:12 -0700448 "If this CL adds to or changes Skia's public API, you need an LGTM "
449 "from any of %s. If this CL only removes from or doesn't change "
Ravi Mistrydbb84c22016-10-05 12:47:44 -0400450 "Skia's public API, please add a short note to the CL saying so. "
Aaron Gablea49909a2017-10-09 12:50:52 -0700451 "Add one of the owners as a reviewer to your CL as well as to the "
452 "TBR= line. If you don't know if this CL affects Skia's public "
453 "API, treat it like it does." % str(PUBLIC_API_OWNERS)))
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000454 return results
455
456
Edward Lemur2b7876c2020-01-17 18:48:13 -0500457def PostUploadHook(gerrit, change, output_api):
rmistryd223fb22015-02-26 10:16:13 -0800458 """git cl upload will call this hook after the issue is created/modified.
459
460 This hook does the following:
461 * Adds a link to preview docs changes if there are any docs changes in the CL.
Ravi Mistry355feab2017-05-23 14:24:08 -0400462 * Adds 'No-Try: true' if the CL contains only docs changes.
rmistryd223fb22015-02-26 10:16:13 -0800463 """
Edward Lemur2b7876c2020-01-17 18:48:13 -0500464 if not change.issue:
465 return []
466
467 # Skip PostUploadHooks for all auto-commit service account bots. New
468 # patchsets (caused due to PostUploadHooks) invalidates the CQ+2 vote from
469 # the "--use-commit-queue" flag to "git cl upload".
470 for suffix in SERVICE_ACCOUNT_SUFFIX:
471 if change.author_email.endswith(suffix):
472 return []
rmistryd223fb22015-02-26 10:16:13 -0800473
474 results = []
Edward Lemur2b7876c2020-01-17 18:48:13 -0500475 at_least_one_docs_change = False
rmistryd223fb22015-02-26 10:16:13 -0800476 all_docs_changes = True
477 for affected_file in change.AffectedFiles():
478 affected_file_path = affected_file.LocalPath()
479 file_path, _ = os.path.splitext(affected_file_path)
480 if 'site' == file_path.split(os.path.sep)[0]:
Edward Lemur2b7876c2020-01-17 18:48:13 -0500481 at_least_one_docs_change = True
rmistryd223fb22015-02-26 10:16:13 -0800482 else:
483 all_docs_changes = False
Edward Lemur2b7876c2020-01-17 18:48:13 -0500484 if at_least_one_docs_change and not all_docs_changes:
rmistryd223fb22015-02-26 10:16:13 -0800485 break
486
Edward Lemur2b7876c2020-01-17 18:48:13 -0500487 footers = change.GitFootersFromDescription()
488 description_changed = False
Ravi Mistryb5e2acc2017-12-07 11:10:11 -0500489
Edward Lemur2b7876c2020-01-17 18:48:13 -0500490 # If the change includes only doc changes then add No-Try: true in the
491 # CL's description if it does not exist yet.
492 if all_docs_changes and 'true' not in footers.get('No-Try', []):
493 description_changed = True
Edward Lemurc631b7c2020-02-04 15:30:18 -0500494 change.AddDescriptionFooter('No-Try', 'true')
Edward Lemur2b7876c2020-01-17 18:48:13 -0500495 results.append(
496 output_api.PresubmitNotifyResult(
497 'This change has only doc changes. Automatically added '
498 '\'No-Try: true\' to the CL\'s description'))
rmistryd223fb22015-02-26 10:16:13 -0800499
Edward Lemur2b7876c2020-01-17 18:48:13 -0500500 # If there is at least one docs change then add preview link in the CL's
501 # description if it does not already exist there.
502 docs_preview_link = DOCS_PREVIEW_URL.format(issue=change.issue)
503 if (at_least_one_docs_change
504 and docs_preview_link not in footers.get('Docs-Preview', [])):
505 # Automatically add a link to where the docs can be previewed.
506 description_changed = True
507 change.AddDescriptionFooter('Docs-Preview', docs_preview_link)
508 results.append(
509 output_api.PresubmitNotifyResult(
510 'Automatically added a link to preview the docs changes to the '
511 'CL\'s description'))
rmistryd223fb22015-02-26 10:16:13 -0800512
Edward Lemur2b7876c2020-01-17 18:48:13 -0500513 # If the description has changed update it.
514 if description_changed:
515 gerrit.UpdateDescription(
516 change.FullDescriptionText(), change.issue)
rmistryd223fb22015-02-26 10:16:13 -0800517
Edward Lemur2b7876c2020-01-17 18:48:13 -0500518 return results
rmistryd223fb22015-02-26 10:16:13 -0800519
520
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000521def CheckChangeOnCommit(input_api, output_api):
Ravi Mistry4c0ffe72020-03-02 13:19:02 -0500522 """Presubmit checks for the change on commit."""
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000523 results = []
rmistry@google.com6be0b4c2013-01-17 14:50:59 +0000524 results.extend(_CommonChecks(input_api, output_api))
rmistry@google.comfb4a68d2013-08-12 14:51:20 +0000525 results.extend(_CheckLGTMsForPublicAPI(input_api, output_api))
commit-bot@chromium.org745e08c2014-02-03 14:18:32 +0000526 results.extend(_CheckOwnerIsInAuthorsFile(input_api, output_api))
Ravi Mistrya70cb8a2017-09-12 13:52:05 -0400527 # Checks for the presence of 'DO NOT''SUBMIT' in CL description and in
528 # content of files.
529 results.extend(
530 input_api.canned_checks.CheckDoNotSubmit(input_api, output_api))
rmistry@google.com8e3ff8c2013-01-17 12:55:34 +0000531 return results