blob: be6075bb93c1498c91dfe2478d8841abba53d102 [file] [log] [blame]
Blink Reformat4c46d092018-04-07 15:32:371# Copyright (C) 2014 Google Inc. All rights reserved.
2#
3# Redistribution and use in source and binary forms, with or without
4# modification, are permitted provided that the following conditions are
5# met:
6#
7# * Redistributions of source code must retain the above copyright
8# notice, this list of conditions and the following disclaimer.
9# * Redistributions in binary form must reproduce the above
10# copyright notice, this list of conditions and the following disclaimer
11# in the documentation and/or other materials provided with the
12# distribution.
13# * Neither the name of Google Inc. nor the names of its
14# contributors may be used to endorse or promote products derived from
15# this software without specific prior written permission.
16#
17# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Yang Guo75beda92019-10-28 07:29:2528"""
29DevTools presubmit script
Blink Reformat4c46d092018-04-07 15:32:3730
31See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts
32for more details about the presubmit API built into gcl.
33"""
34
35import sys
Tim van der Lippef515fdc2020-03-06 16:18:2536import six
Tim van der Lippefb023462020-08-21 13:10:0637import time
Blink Reformat4c46d092018-04-07 15:32:3738
Liviu Raufd2e3212019-12-18 15:38:2039AUTOROLL_ACCOUNT = "devtools-ci-autoroll-builder@chops-service-accounts.iam.gserviceaccount.com"
Tim van der Lippefb1dc172021-05-11 15:40:2640USE_PYTHON3 = True
Mathias Bynensa0a6e292019-12-17 12:24:0841
Tim van der Lippe4d004ec2020-03-03 18:32:0142
43def _ExecuteSubProcess(input_api, output_api, script_path, args, results):
Tim van der Lippef515fdc2020-03-06 16:18:2544 if isinstance(script_path, six.string_types):
45 script_path = [input_api.python_executable, script_path]
46
Tim van der Lippefb023462020-08-21 13:10:0647 start_time = time.time()
Sigurd Schneiderf3a1ecd2021-03-02 14:46:0348 process = input_api.subprocess.Popen(script_path + args,
49 stdout=input_api.subprocess.PIPE,
50 stderr=input_api.subprocess.STDOUT)
Tim van der Lippe4d004ec2020-03-03 18:32:0151 out, _ = process.communicate()
Tim van der Lippefb023462020-08-21 13:10:0652 end_time = time.time()
53
54 time_difference = end_time - start_time
55 time_info = "Script execution time was %.1fs seconds\n" % (time_difference)
Tim van der Lippe4d004ec2020-03-03 18:32:0156 if process.returncode != 0:
Tim van der Lippefb1dc172021-05-11 15:40:2657 results.append(
58 output_api.PresubmitError(time_info + out.decode('utf-8')))
Tim van der Lippe4d004ec2020-03-03 18:32:0159 else:
Tim van der Lippefb1dc172021-05-11 15:40:2660 results.append(
61 output_api.PresubmitNotifyResult(time_info + out.decode('utf-8')))
Tim van der Lippe4d004ec2020-03-03 18:32:0162 return results
63
64
Yang Guoa7845d52019-10-31 10:30:2365def _CheckChangesAreExclusiveToDirectory(input_api, output_api):
Tim van der Lippebc42a632019-11-28 14:22:5566 if input_api.change.DISABLE_THIRD_PARTY_CHECK != None:
67 return []
Brandon Goddarde7028672020-01-30 17:31:0468 results = [output_api.PresubmitNotifyResult('Directory Exclusivity Check:')]
Sigurd Schneiderf3a1ecd2021-03-02 14:46:0369
Yang Guoa7845d52019-10-31 10:30:2370 def IsParentDir(file, dir):
71 while file != '':
72 if file == dir:
73 return True
74 file = input_api.os_path.dirname(file)
Yang Guoa7845d52019-10-31 10:30:2375 return False
76
77 def FileIsInDir(file, dirs):
78 for dir in dirs:
79 if IsParentDir(file, dir):
80 return True
81
Tim van der Lippe4050a302021-04-13 09:21:2182 EXCLUSIVE_CHANGE_DIRECTORIES = [
83 [
84 'third_party', 'v8',
85 input_api.os_path.join('front_end', 'generated')
86 ],
87 [
88 'node_modules',
Tim van der Lippe4050a302021-04-13 09:21:2189 'package-lock.json',
90 input_api.os_path.join('scripts', 'deps', 'manage_node_deps.py'),
91 ],
92 ['OWNERS', input_api.os_path.join('config', 'owner')],
93 ]
94
Yang Guoa7845d52019-10-31 10:30:2395 affected_files = input_api.LocalPaths()
Yang Guoa7845d52019-10-31 10:30:2396 num_affected = len(affected_files)
97 for dirs in EXCLUSIVE_CHANGE_DIRECTORIES:
Paul Lewis14effba2019-12-02 14:56:4098 dir_list = ', '.join(dirs)
Tim van der Lippefb1dc172021-05-11 15:40:2699 affected_in_dir = [
100 file for file in affected_files if FileIsInDir(file, dirs)
101 ]
Yang Guoa7845d52019-10-31 10:30:23102 num_in_dir = len(affected_in_dir)
103 if num_in_dir == 0:
104 continue
Tim van der Lippeebb94a92019-11-19 17:07:53105 # Addition of new third_party folders must have a new entry in `.gitignore`
106 if '.gitignore' in affected_files:
107 num_in_dir = num_in_dir + 1
Yang Guoa7845d52019-10-31 10:30:23108 if num_in_dir < num_affected:
Tim van der Lippe239963b2021-04-09 09:43:38109 unexpected_files = [
110 file for file in affected_files if file not in affected_in_dir
111 ]
112 results.append(
113 output_api.PresubmitError(
114 ('CLs that affect files in "%s" should be limited to these files/directories.'
115 % dir_list) +
116 ('\nUnexpected files: %s.' % unexpected_files) +
117 '\nYou can disable this check by adding DISABLE_THIRD_PARTY_CHECK=<reason> to your commit message'
118 ))
Brandon Goddarde7028672020-01-30 17:31:04119 break
120
121 return results
Yang Guoa7845d52019-10-31 10:30:23122
Blink Reformat4c46d092018-04-07 15:32:37123
Sigurd Schneider5c9b4f92021-01-22 10:09:55124def _CheckBugAssociation(input_api, output_api, is_committing):
125 results = [output_api.PresubmitNotifyResult('Bug Association Check:')]
126 bugs = input_api.change.BugsFromDescription()
127 message = (
128 "Each CL should be associated with a bug, use \'Bug:\' or \'Fixed:\' lines in\n"
129 "the footer of the commit description. If you explicitly don\'t want to\n"
130 "set a bug, use \'Bug: none\' in the footer of the commit description.\n\n"
131 "Note: The footer of the commit description is the last block of lines in\n"
132 "the commit description that doesn't contain empty lines. This means that\n"
133 "any \'Bug:\' or \'Fixed:\' lines that are eventually followed by an empty\n"
134 "line are not detected by this presubmit check.")
135
136 if not bugs:
137 if is_committing:
138 results.append(output_api.PresubmitError(message))
139 else:
140 results.append(output_api.PresubmitNotifyResult(message))
141
142 for bug in bugs:
143 results.append(output_api.PresubmitNotifyResult(('%s') % bug))
144
145 return results
146
147
Blink Reformat4c46d092018-04-07 15:32:37148def _CheckBuildGN(input_api, output_api):
Brandon Goddarde7028672020-01-30 17:31:04149 results = [output_api.PresubmitNotifyResult('Running BUILD.GN check:')]
Sigurd Schneiderf3a1ecd2021-03-02 14:46:03150 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
151 'scripts', 'check_gn.js')
Brandon Goddarde7028672020-01-30 17:31:04152 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
153 return results
Blink Reformat4c46d092018-04-07 15:32:37154
155
Brandon Goddard33104372020-08-13 15:49:23156def _CheckExperimentTelemetry(input_api, output_api):
Brandon Goddard33104372020-08-13 15:49:23157 experiment_telemetry_files = [
158 input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end',
Christy Chenab9a44d2021-07-02 19:54:30159 'entrypoints', 'main', 'MainImpl.ts'),
Brandon Goddard33104372020-08-13 15:49:23160 input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end',
Tim van der Lippee0247312021-04-01 14:25:30161 'core', 'host', 'UserMetrics.ts')
Brandon Goddard33104372020-08-13 15:49:23162 ]
163 affected_main_files = _getAffectedFiles(input_api,
164 experiment_telemetry_files, [],
Christy Chenab9a44d2021-07-02 19:54:30165 ['.ts'])
Brandon Goddard33104372020-08-13 15:49:23166 if len(affected_main_files) == 0:
Tim van der Lippefb023462020-08-21 13:10:06167 return [
168 output_api.PresubmitNotifyResult(
169 'No affected files for telemetry check')
170 ]
Brandon Goddard33104372020-08-13 15:49:23171
Tim van der Lippefb023462020-08-21 13:10:06172 results = [
173 output_api.PresubmitNotifyResult('Running Experiment Telemetry check:')
174 ]
Brandon Goddard33104372020-08-13 15:49:23175 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
176 'scripts', 'check_experiments.js')
177 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
178 return results
179
180
Tim van der Lippee4bdd742019-12-17 15:40:16181def _CheckJSON(input_api, output_api):
Brandon Goddarde7028672020-01-30 17:31:04182 results = [output_api.PresubmitNotifyResult('Running JSON Validator:')]
Sigurd Schneiderf3a1ecd2021-03-02 14:46:03183 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
184 'scripts', 'json_validator',
185 'validate_module_json.js')
Brandon Goddarde7028672020-01-30 17:31:04186 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
187 return results
Tim van der Lippee4bdd742019-12-17 15:40:16188
189
Blink Reformat4c46d092018-04-07 15:32:37190def _CheckFormat(input_api, output_api):
Sigurd Schneiderf3a1ecd2021-03-02 14:46:03191 node_modules_affected_files = _getAffectedFiles(input_api, [
Tim van der Lippe6509dba2021-11-23 16:19:23192 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules'),
193 input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end',
194 'third_party')
Sigurd Schneiderf3a1ecd2021-03-02 14:46:03195 ], [], [])
Tim van der Lippefdbd42e2020-04-07 14:14:36196
197 # TODO(crbug.com/1068198): Remove once `git cl format --js` can handle large CLs.
198 if (len(node_modules_affected_files) > 0):
Tim van der Lippe6509dba2021-11-23 16:19:23199 return [
200 output_api.PresubmitNotifyResult(
201 'Skipping Format Checks because `node_modules`/`front_end/third_party` files are affected.'
202 )
203 ]
Tim van der Lippefdbd42e2020-04-07 14:14:36204
Brandon Goddarde7028672020-01-30 17:31:04205 results = [output_api.PresubmitNotifyResult('Running Format Checks:')]
Blink Reformat4c46d092018-04-07 15:32:37206
Tim van der Lippef515fdc2020-03-06 16:18:25207 return _ExecuteSubProcess(input_api, output_api, ['git', 'cl', 'format', '--js'], [], results)
Blink Reformat4c46d092018-04-07 15:32:37208
Jack Franklin1aa212d2021-09-10 14:20:08209
210def _CheckDevToolsRunESLintTests(input_api, output_api):
211 # Check for changes in the eslint_rules directory, and run the eslint rules
212 # tests if so.
213 # We don't do this on every CL as most do not touch the rules, but if we do
214 # change them we need to make sure all the tests are passing.
Jack Franklin03db63a2021-09-16 13:40:56215 original_sys_path = sys.path
216 try:
217 sys.path = sys.path + [
218 input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')
219 ]
220 import devtools_paths
221 finally:
222 sys.path = original_sys_path
Jack Franklin1aa212d2021-09-10 14:20:08223 eslint_rules_dir_path = input_api.os_path.join(
224 input_api.PresubmitLocalPath(), 'scripts', 'eslint_rules')
225 eslint_rules_affected_files = _getAffectedFiles(input_api,
226 [eslint_rules_dir_path],
227 [], [])
228
229 if (len(eslint_rules_affected_files) == 0):
230 return []
231
Jack Franklin03db63a2021-09-16 13:40:56232 mocha_path = devtools_paths.mocha_path()
Jack Franklin1aa212d2021-09-10 14:20:08233 eslint_tests_path = input_api.os_path.join(eslint_rules_dir_path, 'tests',
234 '*_test.js')
235
236 results = [output_api.PresubmitNotifyResult('ESLint rules unit tests')]
237 results.extend(
238 # The dot reporter is more concise which is useful to not get LOADS of
239 # output when just one test fails.
240 _checkWithNodeScript(input_api, output_api, mocha_path,
241 ['--reporter', 'dot', eslint_tests_path]))
242 return results
243
244
Mathias Bynens1b2c5e42020-06-18 06:29:21245def _CheckDevToolsStyleJS(input_api, output_api):
Tim van der Lippefb023462020-08-21 13:10:06246 results = [output_api.PresubmitNotifyResult('JS style check:')]
Mathias Bynens1b2c5e42020-06-18 06:29:21247 lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
248 'scripts', 'test',
Tim van der Lippef9e565e2021-11-08 16:22:11249 'run_lint_check_js.mjs')
Tim van der Lippe4d004ec2020-03-03 18:32:01250
Mathias Bynens1b2c5e42020-06-18 06:29:21251 front_end_directory = input_api.os_path.join(
252 input_api.PresubmitLocalPath(), 'front_end')
Jack Franklinbcfd6ad2021-02-17 10:12:50253 component_docs_directory = input_api.os_path.join(front_end_directory,
Tim van der Lippee622f552021-04-14 14:15:18254 'ui', 'components',
255 'docs')
Alex Rudenko5556a902020-09-29 09:37:23256 inspector_overlay_directory = input_api.os_path.join(
257 input_api.PresubmitLocalPath(), 'inspector_overlay')
Mathias Bynens1b2c5e42020-06-18 06:29:21258 test_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
259 'test')
260 scripts_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
261 'scripts')
Tim van der Lippe2a4ae2b2020-03-11 17:28:06262
Mathias Bynens1b2c5e42020-06-18 06:29:21263 default_linted_directories = [
Alex Rudenko5556a902020-09-29 09:37:23264 front_end_directory, test_directory, scripts_directory,
265 inspector_overlay_directory
Mathias Bynens1b2c5e42020-06-18 06:29:21266 ]
Tim van der Lippe2a4ae2b2020-03-11 17:28:06267
268 eslint_related_files = [
Mathias Bynens1b2c5e42020-06-18 06:29:21269 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules',
270 'eslint'),
Tim van der Lippecf4ab402021-02-12 14:30:58271 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules',
272 '@typescript-eslint'),
Tim van der Lippe2a4ae2b2020-03-11 17:28:06273 input_api.os_path.join(input_api.PresubmitLocalPath(), '.eslintrc.js'),
Mathias Bynens1b2c5e42020-06-18 06:29:21274 input_api.os_path.join(input_api.PresubmitLocalPath(),
275 '.eslintignore'),
Tim van der Lippe33543ac2020-12-14 14:37:45276 input_api.os_path.join(front_end_directory, '.eslintrc.js'),
Jack Franklinbcfd6ad2021-02-17 10:12:50277 input_api.os_path.join(component_docs_directory, '.eslintrc.js'),
Tim van der Lippe406249f2020-12-14 14:59:10278 input_api.os_path.join(test_directory, '.eslintrc.js'),
Mathias Bynens1b2c5e42020-06-18 06:29:21279 input_api.os_path.join(scripts_directory, 'test',
280 'run_lint_check_js.py'),
281 input_api.os_path.join(scripts_directory, 'test',
Tim van der Lippef9e565e2021-11-08 16:22:11282 'run_lint_check_js.mjs'),
Tim van der Lippe2a4ae2b2020-03-11 17:28:06283 input_api.os_path.join(scripts_directory, '.eslintrc.js'),
284 input_api.os_path.join(scripts_directory, 'eslint_rules'),
285 ]
286
Mathias Bynens1b2c5e42020-06-18 06:29:21287 lint_config_files = _getAffectedFiles(input_api, eslint_related_files, [],
288 ['.js', '.py', '.eslintignore'])
Tim van der Lippe2a4ae2b2020-03-11 17:28:06289
Mathias Bynens0ec56612020-06-19 07:14:03290 should_bail_out, files_to_lint = _getFilesToLint(
291 input_api, output_api, lint_config_files, default_linted_directories,
292 ['.js', '.ts'], results)
293 if should_bail_out:
Mathias Bynens1b2c5e42020-06-18 06:29:21294 return results
Tim van der Lippe2a4ae2b2020-03-11 17:28:06295
Brandon Goddarde34e94f2021-04-12 17:58:26296 # If there are more than 50 files to check, don't bother and check
297 # everything, so as to not run into command line length limits on Windows.
298 if len(files_to_lint) > 50:
299 files_to_lint = []
300
Mathias Bynens1b2c5e42020-06-18 06:29:21301 results.extend(
302 _checkWithNodeScript(input_api, output_api, lint_path, files_to_lint))
Tim van der Lippe98132242020-04-14 16:16:54303 return results
Blink Reformat4c46d092018-04-07 15:32:37304
305
Mathias Bynens1b2c5e42020-06-18 06:29:21306def _CheckDevToolsStyleCSS(input_api, output_api):
Tim van der Lippefb023462020-08-21 13:10:06307 results = [output_api.PresubmitNotifyResult('CSS style check:')]
Mathias Bynens1b2c5e42020-06-18 06:29:21308 lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
309 'scripts', 'test',
Jack Franklinbc302342021-01-18 10:03:30310 'run_lint_check_css.js')
Mathias Bynens1b2c5e42020-06-18 06:29:21311
312 front_end_directory = input_api.os_path.join(
313 input_api.PresubmitLocalPath(), 'front_end')
Alex Rudenko5556a902020-09-29 09:37:23314 inspector_overlay_directory = input_api.os_path.join(
315 input_api.PresubmitLocalPath(), 'inspector_overlay')
316 default_linted_directories = [
317 front_end_directory, inspector_overlay_directory
318 ]
Mathias Bynens1b2c5e42020-06-18 06:29:21319
320 scripts_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
321 'scripts')
322
323 stylelint_related_files = [
324 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules',
325 'stylelint'),
326 input_api.os_path.join(input_api.PresubmitLocalPath(),
327 '.stylelintrc.json'),
328 input_api.os_path.join(input_api.PresubmitLocalPath(),
329 '.stylelintignore'),
330 input_api.os_path.join(scripts_directory, 'test',
Sigurd Schneider6523c512021-02-12 09:44:28331 'run_lint_check_css.js'),
Mathias Bynens1b2c5e42020-06-18 06:29:21332 ]
333
334 lint_config_files = _getAffectedFiles(input_api, stylelint_related_files,
Sigurd Schneider6523c512021-02-12 09:44:28335 [], [])
Mathias Bynens1b2c5e42020-06-18 06:29:21336
Sigurd Schneidere3bf6c22021-02-11 14:35:23337 css_should_bail_out, css_files_to_lint = _getFilesToLint(
Mathias Bynens0ec56612020-06-19 07:14:03338 input_api, output_api, lint_config_files, default_linted_directories,
339 ['.css'], results)
Mathias Bynens1b2c5e42020-06-18 06:29:21340
Sigurd Schneiderf3a1ecd2021-03-02 14:46:03341 # If there are more than 50 files to check, don't bother and check
342 # everything, so as to not run into command line length limits on Windows.
343 if not css_should_bail_out:
344 if len(css_files_to_lint) < 50:
345 script_args = ["--files"] + css_files_to_lint
346 else:
347 script_args = [] # The defaults check all CSS files.
348 results.extend(
349 _checkWithNodeScript(input_api, output_api, lint_path,
350 script_args))
351
Jack Franklinbc302342021-01-18 10:03:30352 return results
Mathias Bynens1b2c5e42020-06-18 06:29:21353
354
Tim van der Lippea53672d2021-07-08 14:52:35355def _CheckDevToolsNonJSFileLicenseHeaders(input_api, output_api):
Tim van der Lippe81752502021-05-26 14:38:12356 results = [
357 output_api.PresubmitNotifyResult(
358 'Python-like file license header check:')
359 ]
Tim van der Lippea53672d2021-07-08 14:52:35360 lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
361 'scripts', 'test',
362 'run_header_check_non_js_files.js')
Tim van der Lippe81752502021-05-26 14:38:12363
364 front_end_directory = input_api.os_path.join(
365 input_api.PresubmitLocalPath(), 'front_end')
366 inspector_overlay_directory = input_api.os_path.join(
367 input_api.PresubmitLocalPath(), 'inspector_overlay')
368 test_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
369 'test')
370 scripts_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
371 'scripts')
Tim van der Lippe8b929542021-05-26 14:54:20372 config_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
373 'config')
Tim van der Lippe81752502021-05-26 14:38:12374
375 default_linted_directories = [
376 front_end_directory, test_directory, scripts_directory,
Tim van der Lippe8b929542021-05-26 14:54:20377 inspector_overlay_directory, config_directory
Tim van der Lippe81752502021-05-26 14:38:12378 ]
379
380 check_related_files = [lint_path]
381
382 lint_config_files = _getAffectedFiles(input_api, check_related_files, [],
383 ['.js'])
384
385 should_bail_out, files_to_lint = _getFilesToLint(
386 input_api, output_api, lint_config_files, default_linted_directories,
Tim van der Lippea53672d2021-07-08 14:52:35387 ['BUILD.gn', '.gni', '.css'], results)
Tim van der Lippe81752502021-05-26 14:38:12388 if should_bail_out:
389 return results
390
391 # If there are more than 50 files to check, don't bother and check
392 # everything, so as to not run into command line length limits on Windows.
393 if len(files_to_lint) > 50:
394 files_to_lint = []
395
396 results.extend(
397 _checkWithNodeScript(input_api, output_api, lint_path, files_to_lint))
398 return results
399
400
Tim van der Lippe4d004ec2020-03-03 18:32:01401def _CheckGeneratedFiles(input_api, output_api):
Tim van der Lippeb3b90762020-03-04 15:21:52402 v8_directory_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'v8')
403 blink_directory_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party', 'blink')
404 protocol_location = input_api.os_path.join(blink_directory_path, 'public', 'devtools_protocol')
405 scripts_build_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'build')
Tim van der Lippe5d2d79b2020-03-23 11:45:04406 scripts_generated_output_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end', 'generated')
Tim van der Lippeb3b90762020-03-04 15:21:52407
408 generated_aria_path = input_api.os_path.join(scripts_build_path, 'generate_aria.py')
409 generated_supported_css_path = input_api.os_path.join(scripts_build_path, 'generate_supported_css.py')
410 generated_protocol_path = input_api.os_path.join(scripts_build_path, 'code_generator_frontend.py')
Tim van der Lippe2a1eac22021-05-13 15:19:29411 generated_protocol_typescript_path = input_api.os_path.join(
412 input_api.PresubmitLocalPath(), 'scripts', 'protocol_typescript')
Tim van der Lippeb3b90762020-03-04 15:21:52413 concatenate_protocols_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party', 'inspector_protocol',
414 'concatenate_protocols.py')
415
416 affected_files = _getAffectedFiles(input_api, [
417 v8_directory_path,
418 blink_directory_path,
Tim van der Lippe2a1eac22021-05-13 15:19:29419 input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party',
420 'pyjson5'),
Tim van der Lippeb3b90762020-03-04 15:21:52421 generated_aria_path,
422 generated_supported_css_path,
423 concatenate_protocols_path,
424 generated_protocol_path,
Tim van der Lippe5d2d79b2020-03-23 11:45:04425 scripts_generated_output_path,
Tim van der Lippe2a1eac22021-05-13 15:19:29426 generated_protocol_typescript_path,
427 ], [], ['.pdl', '.json5', '.py', '.js', '.ts'])
Tim van der Lippeb3b90762020-03-04 15:21:52428
429 if len(affected_files) == 0:
Tim van der Lippefb023462020-08-21 13:10:06430 return [
431 output_api.PresubmitNotifyResult(
432 'No affected files for generated files check')
433 ]
Tim van der Lippeb3b90762020-03-04 15:21:52434
Tim van der Lippe4d004ec2020-03-03 18:32:01435 results = [output_api.PresubmitNotifyResult('Running Generated Files Check:')]
Tim van der Lippeb0d65f12020-03-05 12:15:24436 generate_protocol_resources_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'deps',
437 'generate_protocol_resources.py')
Tim van der Lippe4d004ec2020-03-03 18:32:01438
Tim van der Lippeb0d65f12020-03-05 12:15:24439 return _ExecuteSubProcess(input_api, output_api, generate_protocol_resources_path, [], results)
Tim van der Lippe4d004ec2020-03-03 18:32:01440
441
Christy Chen2d6d9a62020-09-22 16:04:09442def _CollectStrings(input_api, output_api):
443 devtools_root = input_api.PresubmitLocalPath()
444 devtools_front_end = input_api.os_path.join(devtools_root, 'front_end')
Tim van der Lippe25f11082021-06-24 15:28:08445 script_path = input_api.os_path.join(devtools_root, 'third_party', 'i18n',
446 'collect-strings.js')
447 affected_front_end_files = _getAffectedFiles(
448 input_api, [devtools_front_end, script_path], [], ['.js', '.ts'])
Christy Chen2d6d9a62020-09-22 16:04:09449 if len(affected_front_end_files) == 0:
450 return [
451 output_api.PresubmitNotifyResult(
452 'No affected files to run collect-strings')
453 ]
454
455 results = [
456 output_api.PresubmitNotifyResult('Collecting strings from front_end:')
457 ]
Tim van der Lippe25f11082021-06-24 15:28:08458 results.extend(
459 _checkWithNodeScript(input_api, output_api, script_path,
460 [devtools_front_end]))
Christy Chen2d6d9a62020-09-22 16:04:09461 results.append(
462 output_api.PresubmitNotifyResult(
Peter Marshalld67e9f12021-02-08 09:34:35463 'Please commit en-US.json/en-XL.json if changes are generated.'))
Christy Chen2d6d9a62020-09-22 16:04:09464 return results
465
466
Tim van der Lippe5279f842020-01-14 16:26:38467def _CheckNoUncheckedFiles(input_api, output_api):
468 results = []
469 process = input_api.subprocess.Popen(['git', 'diff', '--exit-code'],
470 stdout=input_api.subprocess.PIPE,
471 stderr=input_api.subprocess.STDOUT)
472 out, _ = process.communicate()
473 if process.returncode != 0:
Jack Franklin324f3042020-09-03 10:28:29474 files_changed_process = input_api.subprocess.Popen(
Tim van der Lippe25f11082021-06-24 15:28:08475 ['git', 'diff'],
Jack Franklin324f3042020-09-03 10:28:29476 stdout=input_api.subprocess.PIPE,
477 stderr=input_api.subprocess.STDOUT)
Tim van der Lippe9bb1cf62020-03-06 16:17:02478 files_changed, _ = files_changed_process.communicate()
479
480 return [
Tim van der Lippefb1dc172021-05-11 15:40:26481 output_api.PresubmitError(
482 'You have changed files that need to be committed:'),
483 output_api.PresubmitError(files_changed.decode('utf-8'))
Tim van der Lippe9bb1cf62020-03-06 16:17:02484 ]
Tim van der Lippe5279f842020-01-14 16:26:38485 return []
486
Tim van der Lippe8fdda112020-01-27 11:27:06487def _CheckForTooLargeFiles(input_api, output_api):
Christy Chen1ab87e02020-01-31 00:32:16488 """Avoid large files, especially binary files, in the repository since
Tim van der Lippe8fdda112020-01-27 11:27:06489 git doesn't scale well for those. They will be in everyone's repo
490 clones forever, forever making Chromium slower to clone and work
491 with."""
Christy Chen1ab87e02020-01-31 00:32:16492 # Uploading files to cloud storage is not trivial so we don't want
493 # to set the limit too low, but the upper limit for "normal" large
494 # files seems to be 1-2 MB, with a handful around 5-8 MB, so
495 # anything over 20 MB is exceptional.
496 TOO_LARGE_FILE_SIZE_LIMIT = 20 * 1024 * 1024 # 10 MB
497 too_large_files = []
498 for f in input_api.AffectedFiles():
499 # Check both added and modified files (but not deleted files).
500 if f.Action() in ('A', 'M'):
501 size = input_api.os_path.getsize(f.AbsoluteLocalPath())
502 if size > TOO_LARGE_FILE_SIZE_LIMIT:
503 too_large_files.append("%s: %d bytes" % (f.LocalPath(), size))
504 if too_large_files:
505 message = (
506 'Do not commit large files to git since git scales badly for those.\n' +
507 'Instead put the large files in cloud storage and use DEPS to\n' +
508 'fetch them.\n' + '\n'.join(too_large_files)
509 )
510 return [output_api.PresubmitError(
511 'Too large files found in commit', long_text=message + '\n')]
512 else:
513 return []
Tim van der Lippe8fdda112020-01-27 11:27:06514
Tim van der Lippe5279f842020-01-14 16:26:38515
Tim van der Lippef8a87092020-09-14 12:01:18516def _RunCannedChecks(input_api, output_api):
517 results = []
518 results.extend(
519 input_api.canned_checks.CheckOwnersFormat(input_api, output_api))
520 results.extend(input_api.canned_checks.CheckOwners(input_api, output_api))
521 results.extend(
522 input_api.canned_checks.CheckChangeHasNoCrAndHasOnlyOneEol(
523 input_api, output_api))
524 results.extend(
525 input_api.canned_checks.CheckChangeHasNoStrayWhitespace(
Tim van der Lippe69775382021-05-27 16:06:12526 input_api,
527 output_api,
528 source_file_filter=lambda file: not file.LocalPath().startswith(
529 'node_modules')))
Tim van der Lippef8a87092020-09-14 12:01:18530 results.extend(
531 input_api.canned_checks.CheckGenderNeutral(input_api, output_api))
532 return results
533
534
Yang Guo4fd355c2019-09-19 08:59:03535def _CommonChecks(input_api, output_api):
Mathias Bynens032591d2019-10-21 09:51:31536 """Checks common to both upload and commit."""
537 results = []
Mathias Bynens011b0072020-08-05 08:17:35538 results.extend(
539 input_api.canned_checks.CheckAuthorizedAuthor(
540 input_api, output_api, bot_allowlist=[AUTOROLL_ACCOUNT]))
Blink Reformat4c46d092018-04-07 15:32:37541 results.extend(_CheckBuildGN(input_api, output_api))
Brandon Goddard33104372020-08-13 15:49:23542 results.extend(_CheckExperimentTelemetry(input_api, output_api))
Tim van der Lippe4d004ec2020-03-03 18:32:01543 results.extend(_CheckGeneratedFiles(input_api, output_api))
Tim van der Lippee4bdd742019-12-17 15:40:16544 results.extend(_CheckJSON(input_api, output_api))
Mathias Bynens1b2c5e42020-06-18 06:29:21545 results.extend(_CheckDevToolsStyleJS(input_api, output_api))
546 results.extend(_CheckDevToolsStyleCSS(input_api, output_api))
Jack Franklin1aa212d2021-09-10 14:20:08547 results.extend(_CheckDevToolsRunESLintTests(input_api, output_api))
Tim van der Lippea53672d2021-07-08 14:52:35548 results.extend(_CheckDevToolsNonJSFileLicenseHeaders(
549 input_api, output_api))
Jack Franklinb10193f2021-03-19 10:25:08550
Tim van der Lippe5497d482020-01-14 15:27:30551 results.extend(_CheckFormat(input_api, output_api))
Yang Guoa7845d52019-10-31 10:30:23552 results.extend(_CheckChangesAreExclusiveToDirectory(input_api, output_api))
Tim van der Lippef8a87092020-09-14 12:01:18553 # Run the canned checks from `depot_tools` after the custom DevTools checks.
554 # The canned checks for example check that lines have line endings. The
555 # DevTools presubmit checks automatically fix these issues. If we would run
556 # the canned checks before the DevTools checks, they would erroneously conclude
557 # that there are issues in the code. Since the canned checks are allowed to be
558 # ignored, a confusing message is shown that asks if the failed presubmit can
559 # be continued regardless. By fixing the issues before we reach the canned checks,
560 # we don't show the message to suppress these errors, which would otherwise be
561 # causing CQ to fail.
562 results.extend(_RunCannedChecks(input_api, output_api))
Kalon Hindsd44fddf2020-12-10 13:43:25563 return results
564
565
566def _SideEffectChecks(input_api, output_api):
567 """Check side effects caused by other checks"""
568 results = []
Tim van der Lippe5279f842020-01-14 16:26:38569 results.extend(_CheckNoUncheckedFiles(input_api, output_api))
Tim van der Lippe8fdda112020-01-27 11:27:06570 results.extend(_CheckForTooLargeFiles(input_api, output_api))
Blink Reformat4c46d092018-04-07 15:32:37571 return results
572
573
Liviu Raud614e092020-01-08 09:56:33574def CheckChangeOnUpload(input_api, output_api):
575 results = []
576 results.extend(_CommonChecks(input_api, output_api))
Christy Chen2d6d9a62020-09-22 16:04:09577 results.extend(_CollectStrings(input_api, output_api))
Kalon Hindsd44fddf2020-12-10 13:43:25578 # Run checks that rely on output from other DevTool checks
579 results.extend(_SideEffectChecks(input_api, output_api))
Sigurd Schneider5c9b4f92021-01-22 10:09:55580 results.extend(_CheckBugAssociation(input_api, output_api, False))
Liviu Raud614e092020-01-08 09:56:33581 return results
582
583
Blink Reformat4c46d092018-04-07 15:32:37584def CheckChangeOnCommit(input_api, output_api):
Mandy Chenf0fbdbe2019-08-22 23:58:37585 results = []
Yang Guo4fd355c2019-09-19 08:59:03586 results.extend(_CommonChecks(input_api, output_api))
Christy Chen2d6d9a62020-09-22 16:04:09587 results.extend(_CollectStrings(input_api, output_api))
Kalon Hindsd44fddf2020-12-10 13:43:25588 # Run checks that rely on output from other DevTool checks
589 results.extend(_SideEffectChecks(input_api, output_api))
Mathias Bynens032591d2019-10-21 09:51:31590 results.extend(input_api.canned_checks.CheckChangeHasDescription(input_api, output_api))
Sigurd Schneider5c9b4f92021-01-22 10:09:55591 results.extend(_CheckBugAssociation(input_api, output_api, True))
Mandy Chenf0fbdbe2019-08-22 23:58:37592 return results
Blink Reformat4c46d092018-04-07 15:32:37593
594
Mandy Chena6be46a2019-07-09 17:06:27595def _getAffectedFiles(input_api, parent_directories, excluded_actions, accepted_endings): # pylint: disable=invalid-name
Yang Guo75beda92019-10-28 07:29:25596 """Return absolute file paths of affected files (not due to an excluded action)
Mandy Chena6be46a2019-07-09 17:06:27597 under a parent directory with an accepted file ending.
Yang Guo75beda92019-10-28 07:29:25598 """
Mandy Chena6be46a2019-07-09 17:06:27599 local_paths = [
600 f.AbsoluteLocalPath() for f in input_api.AffectedFiles() if all(f.Action() != action for action in excluded_actions)
601 ]
602 affected_files = [
Tim van der Lippefb1dc172021-05-11 15:40:26603 file_name for file_name in local_paths
604 if any(parent_directory in file_name
605 for parent_directory in parent_directories) and (
606 len(accepted_endings) == 0 or any(
607 file_name.endswith(accepted_ending)
608 for accepted_ending in accepted_endings))
Mandy Chena6be46a2019-07-09 17:06:27609 ]
610 return affected_files
611
612
Tim van der Lippec4617122020-03-06 16:24:19613def _checkWithNodeScript(input_api, output_api, script_path, script_arguments=[]): # pylint: disable=invalid-name
Blink Reformat4c46d092018-04-07 15:32:37614 original_sys_path = sys.path
615 try:
Yang Guo75beda92019-10-28 07:29:25616 sys.path = sys.path + [input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')]
Yang Guod8176982019-10-04 20:30:35617 import devtools_paths
Blink Reformat4c46d092018-04-07 15:32:37618 finally:
619 sys.path = original_sys_path
620
Tim van der Lippec4617122020-03-06 16:24:19621 return _ExecuteSubProcess(input_api, output_api, [devtools_paths.node_path(), script_path], script_arguments, [])
Mathias Bynens1b2c5e42020-06-18 06:29:21622
623
Jack Franklin324f3042020-09-03 10:28:29624def _checkWithTypeScript(input_api,
625 output_api,
626 tsc_arguments,
627 script_path,
628 script_arguments=[]): # pylint: disable=invalid-name
629 original_sys_path = sys.path
630 try:
631 sys.path = sys.path + [
632 input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')
633 ]
634 import devtools_paths
635 finally:
636 sys.path = original_sys_path
637
638 # First run tsc to compile the TS script that we then run in the _ExecuteSubProcess call
639 tsc_compiler_process = input_api.subprocess.Popen(
640 [
641 devtools_paths.node_path(),
642 devtools_paths.typescript_compiler_path()
643 ] + tsc_arguments,
644 stdout=input_api.subprocess.PIPE,
645 stderr=input_api.subprocess.STDOUT)
646
647 out, _ = tsc_compiler_process.communicate()
648 if tsc_compiler_process.returncode != 0:
649 return [
650 output_api.PresubmitError('Error compiling briges regenerator:\n' +
Tim van der Lippefb1dc172021-05-11 15:40:26651 out.decode('utf-8'))
Jack Franklin324f3042020-09-03 10:28:29652 ]
653
654 return _checkWithNodeScript(input_api, output_api, script_path,
655 script_arguments)
656
657
Mathias Bynens1b2c5e42020-06-18 06:29:21658def _getFilesToLint(input_api, output_api, lint_config_files,
659 default_linted_directories, accepted_endings, results):
Mathias Bynens0ec56612020-06-19 07:14:03660 run_full_check = False
Mathias Bynens1b2c5e42020-06-18 06:29:21661 files_to_lint = []
662
663 # We are changing the lint configuration; run the full check.
Tim van der Lippefb1dc172021-05-11 15:40:26664 if len(lint_config_files) != 0:
Mathias Bynens1b2c5e42020-06-18 06:29:21665 results.append(
666 output_api.PresubmitNotifyResult('Running full lint check'))
Mathias Bynens0ec56612020-06-19 07:14:03667 run_full_check = True
Mathias Bynens1b2c5e42020-06-18 06:29:21668 else:
669 # Only run the linter on files that are relevant, to save PRESUBMIT time.
670 files_to_lint = _getAffectedFiles(input_api,
671 default_linted_directories, ['D'],
672 accepted_endings)
673
Paul Lewis2b9224f2020-09-08 17:13:10674 # Exclude front_end/third_party files.
Tim van der Lippefb1dc172021-05-11 15:40:26675 files_to_lint = [
676 file for file in files_to_lint if "third_party" not in file
677 ]
Paul Lewis2b9224f2020-09-08 17:13:10678
Tim van der Lippefb1dc172021-05-11 15:40:26679 if len(files_to_lint) == 0:
Mathias Bynens1b2c5e42020-06-18 06:29:21680 results.append(
681 output_api.PresubmitNotifyResult(
682 'No affected files for lint check'))
683
Tim van der Lippefb1dc172021-05-11 15:40:26684 should_bail_out = len(files_to_lint) == 0 and not run_full_check
Mathias Bynens0ec56612020-06-19 07:14:03685 return should_bail_out, files_to_lint