blob: 72b55cc0b940dd612796bcde16883847c63e667e [file] [log] [blame]
Blink Reformat4c46d092018-04-07 15:32:37 +00001# 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 08:29:25 +010028"""
29DevTools presubmit script
Blink Reformat4c46d092018-04-07 15:32:37 +000030
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:25 +000036import six
Tim van der Lippefb023462020-08-21 14:10:06 +010037import time
Blink Reformat4c46d092018-04-07 15:32:37 +000038
Liviu Raufd2e3212019-12-18 16:38:20 +010039AUTOROLL_ACCOUNT = "devtools-ci-autoroll-builder@chops-service-accounts.iam.gserviceaccount.com"
Tim van der Lippefb1dc172021-05-11 16:40:26 +010040USE_PYTHON3 = True
Mathias Bynensa0a6e292019-12-17 13:24:08 +010041
Tim van der Lippe4d004ec2020-03-03 18:32:01 +000042
43def _ExecuteSubProcess(input_api, output_api, script_path, args, results):
Tim van der Lippef515fdc2020-03-06 16:18:25 +000044 if isinstance(script_path, six.string_types):
45 script_path = [input_api.python_executable, script_path]
46
Tim van der Lippefb023462020-08-21 14:10:06 +010047 start_time = time.time()
Sigurd Schneiderf3a1ecd2021-03-02 15:46:03 +010048 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:01 +000051 out, _ = process.communicate()
Tim van der Lippefb023462020-08-21 14:10:06 +010052 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:01 +000056 if process.returncode != 0:
Tim van der Lippefb1dc172021-05-11 16:40:26 +010057 results.append(
58 output_api.PresubmitError(time_info + out.decode('utf-8')))
Tim van der Lippe4d004ec2020-03-03 18:32:01 +000059 else:
Tim van der Lippefb1dc172021-05-11 16:40:26 +010060 results.append(
61 output_api.PresubmitNotifyResult(time_info + out.decode('utf-8')))
Tim van der Lippe4d004ec2020-03-03 18:32:01 +000062 return results
63
64
Yang Guoa7845d52019-10-31 11:30:23 +010065def _CheckChangesAreExclusiveToDirectory(input_api, output_api):
Tim van der Lippebc42a632019-11-28 14:22:55 +000066 if input_api.change.DISABLE_THIRD_PARTY_CHECK != None:
67 return []
Brandon Goddarde7028672020-01-30 09:31:04 -080068 results = [output_api.PresubmitNotifyResult('Directory Exclusivity Check:')]
Sigurd Schneiderf3a1ecd2021-03-02 15:46:03 +010069
Yang Guoa7845d52019-10-31 11:30:23 +010070 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 11:30:23 +010075 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 10:21:21 +010082 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 10:21:21 +010089 '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 11:30:23 +010095 affected_files = input_api.LocalPaths()
Yang Guoa7845d52019-10-31 11:30:23 +010096 num_affected = len(affected_files)
97 for dirs in EXCLUSIVE_CHANGE_DIRECTORIES:
Paul Lewis14effba2019-12-02 14:56:40 +000098 dir_list = ', '.join(dirs)
Tim van der Lippefb1dc172021-05-11 16:40:26 +010099 affected_in_dir = [
100 file for file in affected_files if FileIsInDir(file, dirs)
101 ]
Yang Guoa7845d52019-10-31 11:30:23 +0100102 num_in_dir = len(affected_in_dir)
103 if num_in_dir == 0:
104 continue
Tim van der Lippeebb94a92019-11-19 17:07:53 +0000105 # 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 11:30:23 +0100108 if num_in_dir < num_affected:
Tim van der Lippe239963b2021-04-09 10:43:38 +0100109 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 09:31:04 -0800119 break
120
121 return results
Yang Guoa7845d52019-10-31 11:30:23 +0100122
Blink Reformat4c46d092018-04-07 15:32:37 +0000123
Sigurd Schneider5c9b4f92021-01-22 11:09:55 +0100124def _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
Brandon Goddard33104372020-08-13 08:49:23 -0700148def _CheckExperimentTelemetry(input_api, output_api):
Brandon Goddard33104372020-08-13 08:49:23 -0700149 experiment_telemetry_files = [
150 input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end',
Christy Chenab9a44d2021-07-02 12:54:30 -0700151 'entrypoints', 'main', 'MainImpl.ts'),
Brandon Goddard33104372020-08-13 08:49:23 -0700152 input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end',
Tim van der Lippee0247312021-04-01 15:25:30 +0100153 'core', 'host', 'UserMetrics.ts')
Brandon Goddard33104372020-08-13 08:49:23 -0700154 ]
155 affected_main_files = _getAffectedFiles(input_api,
156 experiment_telemetry_files, [],
Christy Chenab9a44d2021-07-02 12:54:30 -0700157 ['.ts'])
Brandon Goddard33104372020-08-13 08:49:23 -0700158 if len(affected_main_files) == 0:
Tim van der Lippefb023462020-08-21 14:10:06 +0100159 return [
160 output_api.PresubmitNotifyResult(
161 'No affected files for telemetry check')
162 ]
Brandon Goddard33104372020-08-13 08:49:23 -0700163
Tim van der Lippefb023462020-08-21 14:10:06 +0100164 results = [
165 output_api.PresubmitNotifyResult('Running Experiment Telemetry check:')
166 ]
Brandon Goddard33104372020-08-13 08:49:23 -0700167 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
168 'scripts', 'check_experiments.js')
169 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
170 return results
171
172
Blink Reformat4c46d092018-04-07 15:32:37 +0000173def _CheckFormat(input_api, output_api):
Sigurd Schneiderf3a1ecd2021-03-02 15:46:03 +0100174 node_modules_affected_files = _getAffectedFiles(input_api, [
Tim van der Lippe6509dba2021-11-23 16:19:23 +0000175 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules'),
176 input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end',
177 'third_party')
Sigurd Schneiderf3a1ecd2021-03-02 15:46:03 +0100178 ], [], [])
Tim van der Lippefdbd42e2020-04-07 15:14:36 +0100179
180 # TODO(crbug.com/1068198): Remove once `git cl format --js` can handle large CLs.
181 if (len(node_modules_affected_files) > 0):
Tim van der Lippe6509dba2021-11-23 16:19:23 +0000182 return [
183 output_api.PresubmitNotifyResult(
184 'Skipping Format Checks because `node_modules`/`front_end/third_party` files are affected.'
185 )
186 ]
Tim van der Lippefdbd42e2020-04-07 15:14:36 +0100187
Brandon Goddarde7028672020-01-30 09:31:04 -0800188 results = [output_api.PresubmitNotifyResult('Running Format Checks:')]
Blink Reformat4c46d092018-04-07 15:32:37 +0000189
Tim van der Lippef515fdc2020-03-06 16:18:25 +0000190 return _ExecuteSubProcess(input_api, output_api, ['git', 'cl', 'format', '--js'], [], results)
Blink Reformat4c46d092018-04-07 15:32:37 +0000191
Jack Franklin1aa212d2021-09-10 15:20:08 +0100192
193def _CheckDevToolsRunESLintTests(input_api, output_api):
194 # Check for changes in the eslint_rules directory, and run the eslint rules
195 # tests if so.
196 # We don't do this on every CL as most do not touch the rules, but if we do
197 # change them we need to make sure all the tests are passing.
Jack Franklin03db63a2021-09-16 14:40:56 +0100198 original_sys_path = sys.path
199 try:
200 sys.path = sys.path + [
201 input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')
202 ]
203 import devtools_paths
204 finally:
205 sys.path = original_sys_path
Jack Franklin1aa212d2021-09-10 15:20:08 +0100206 eslint_rules_dir_path = input_api.os_path.join(
207 input_api.PresubmitLocalPath(), 'scripts', 'eslint_rules')
208 eslint_rules_affected_files = _getAffectedFiles(input_api,
209 [eslint_rules_dir_path],
210 [], [])
211
212 if (len(eslint_rules_affected_files) == 0):
213 return []
214
Jack Franklin03db63a2021-09-16 14:40:56 +0100215 mocha_path = devtools_paths.mocha_path()
Jack Franklin1aa212d2021-09-10 15:20:08 +0100216 eslint_tests_path = input_api.os_path.join(eslint_rules_dir_path, 'tests',
217 '*_test.js')
218
219 results = [output_api.PresubmitNotifyResult('ESLint rules unit tests')]
220 results.extend(
221 # The dot reporter is more concise which is useful to not get LOADS of
222 # output when just one test fails.
223 _checkWithNodeScript(input_api, output_api, mocha_path,
224 ['--reporter', 'dot', eslint_tests_path]))
225 return results
226
227
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200228def _CheckDevToolsStyleJS(input_api, output_api):
Tim van der Lippefb023462020-08-21 14:10:06 +0100229 results = [output_api.PresubmitNotifyResult('JS style check:')]
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200230 lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
231 'scripts', 'test',
Tim van der Lippef9e565e2021-11-08 16:22:11 +0000232 'run_lint_check_js.mjs')
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000233
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200234 front_end_directory = input_api.os_path.join(
235 input_api.PresubmitLocalPath(), 'front_end')
Jack Franklinbcfd6ad2021-02-17 10:12:50 +0000236 component_docs_directory = input_api.os_path.join(front_end_directory,
Tim van der Lippee622f552021-04-14 15:15:18 +0100237 'ui', 'components',
238 'docs')
Alex Rudenko5556a902020-09-29 09:37:23 +0000239 inspector_overlay_directory = input_api.os_path.join(
240 input_api.PresubmitLocalPath(), 'inspector_overlay')
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200241 test_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
242 'test')
243 scripts_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
244 'scripts')
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000245
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200246 default_linted_directories = [
Alex Rudenko5556a902020-09-29 09:37:23 +0000247 front_end_directory, test_directory, scripts_directory,
248 inspector_overlay_directory
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200249 ]
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000250
251 eslint_related_files = [
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200252 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules',
253 'eslint'),
Tim van der Lippecf4ab402021-02-12 14:30:58 +0000254 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules',
255 '@typescript-eslint'),
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000256 input_api.os_path.join(input_api.PresubmitLocalPath(), '.eslintrc.js'),
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200257 input_api.os_path.join(input_api.PresubmitLocalPath(),
258 '.eslintignore'),
Tim van der Lippe33543ac2020-12-14 15:37:45 +0100259 input_api.os_path.join(front_end_directory, '.eslintrc.js'),
Jack Franklinbcfd6ad2021-02-17 10:12:50 +0000260 input_api.os_path.join(component_docs_directory, '.eslintrc.js'),
Tim van der Lippe406249f2020-12-14 15:59:10 +0100261 input_api.os_path.join(test_directory, '.eslintrc.js'),
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200262 input_api.os_path.join(scripts_directory, 'test',
263 'run_lint_check_js.py'),
264 input_api.os_path.join(scripts_directory, 'test',
Tim van der Lippef9e565e2021-11-08 16:22:11 +0000265 'run_lint_check_js.mjs'),
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000266 input_api.os_path.join(scripts_directory, '.eslintrc.js'),
267 input_api.os_path.join(scripts_directory, 'eslint_rules'),
268 ]
269
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200270 lint_config_files = _getAffectedFiles(input_api, eslint_related_files, [],
271 ['.js', '.py', '.eslintignore'])
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000272
Mathias Bynens0ec56612020-06-19 09:14:03 +0200273 should_bail_out, files_to_lint = _getFilesToLint(
274 input_api, output_api, lint_config_files, default_linted_directories,
275 ['.js', '.ts'], results)
276 if should_bail_out:
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200277 return results
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000278
Brandon Goddarde34e94f2021-04-12 10:58:26 -0700279 # If there are more than 50 files to check, don't bother and check
280 # everything, so as to not run into command line length limits on Windows.
281 if len(files_to_lint) > 50:
282 files_to_lint = []
283
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200284 results.extend(
285 _checkWithNodeScript(input_api, output_api, lint_path, files_to_lint))
Tim van der Lippe98132242020-04-14 17:16:54 +0100286 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000287
288
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200289def _CheckDevToolsStyleCSS(input_api, output_api):
Tim van der Lippefb023462020-08-21 14:10:06 +0100290 results = [output_api.PresubmitNotifyResult('CSS style check:')]
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200291 lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
292 'scripts', 'test',
Jack Franklinbc302342021-01-18 10:03:30 +0000293 'run_lint_check_css.js')
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200294
295 front_end_directory = input_api.os_path.join(
296 input_api.PresubmitLocalPath(), 'front_end')
Alex Rudenko5556a902020-09-29 09:37:23 +0000297 inspector_overlay_directory = input_api.os_path.join(
298 input_api.PresubmitLocalPath(), 'inspector_overlay')
299 default_linted_directories = [
300 front_end_directory, inspector_overlay_directory
301 ]
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200302
303 scripts_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
304 'scripts')
305
306 stylelint_related_files = [
307 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules',
308 'stylelint'),
309 input_api.os_path.join(input_api.PresubmitLocalPath(),
310 '.stylelintrc.json'),
311 input_api.os_path.join(input_api.PresubmitLocalPath(),
312 '.stylelintignore'),
313 input_api.os_path.join(scripts_directory, 'test',
Sigurd Schneider6523c512021-02-12 10:44:28 +0100314 'run_lint_check_css.js'),
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200315 ]
316
317 lint_config_files = _getAffectedFiles(input_api, stylelint_related_files,
Sigurd Schneider6523c512021-02-12 10:44:28 +0100318 [], [])
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200319
Sigurd Schneidere3bf6c22021-02-11 15:35:23 +0100320 css_should_bail_out, css_files_to_lint = _getFilesToLint(
Mathias Bynens0ec56612020-06-19 09:14:03 +0200321 input_api, output_api, lint_config_files, default_linted_directories,
322 ['.css'], results)
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200323
Sigurd Schneiderf3a1ecd2021-03-02 15:46:03 +0100324 # If there are more than 50 files to check, don't bother and check
325 # everything, so as to not run into command line length limits on Windows.
326 if not css_should_bail_out:
327 if len(css_files_to_lint) < 50:
328 script_args = ["--files"] + css_files_to_lint
329 else:
330 script_args = [] # The defaults check all CSS files.
331 results.extend(
332 _checkWithNodeScript(input_api, output_api, lint_path,
333 script_args))
334
Jack Franklinbc302342021-01-18 10:03:30 +0000335 return results
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200336
337
Tim van der Lippea53672d2021-07-08 15:52:35 +0100338def _CheckDevToolsNonJSFileLicenseHeaders(input_api, output_api):
Tim van der Lippe81752502021-05-26 15:38:12 +0100339 results = [
340 output_api.PresubmitNotifyResult(
341 'Python-like file license header check:')
342 ]
Tim van der Lippea53672d2021-07-08 15:52:35 +0100343 lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
344 'scripts', 'test',
345 'run_header_check_non_js_files.js')
Tim van der Lippe81752502021-05-26 15:38:12 +0100346
347 front_end_directory = input_api.os_path.join(
348 input_api.PresubmitLocalPath(), 'front_end')
349 inspector_overlay_directory = input_api.os_path.join(
350 input_api.PresubmitLocalPath(), 'inspector_overlay')
351 test_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
352 'test')
353 scripts_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
354 'scripts')
Tim van der Lippe8b929542021-05-26 15:54:20 +0100355 config_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
356 'config')
Tim van der Lippe81752502021-05-26 15:38:12 +0100357
358 default_linted_directories = [
359 front_end_directory, test_directory, scripts_directory,
Tim van der Lippe8b929542021-05-26 15:54:20 +0100360 inspector_overlay_directory, config_directory
Tim van der Lippe81752502021-05-26 15:38:12 +0100361 ]
362
363 check_related_files = [lint_path]
364
365 lint_config_files = _getAffectedFiles(input_api, check_related_files, [],
366 ['.js'])
367
368 should_bail_out, files_to_lint = _getFilesToLint(
369 input_api, output_api, lint_config_files, default_linted_directories,
Tim van der Lippea53672d2021-07-08 15:52:35 +0100370 ['BUILD.gn', '.gni', '.css'], results)
Tim van der Lippe81752502021-05-26 15:38:12 +0100371 if should_bail_out:
372 return results
373
374 # If there are more than 50 files to check, don't bother and check
375 # everything, so as to not run into command line length limits on Windows.
376 if len(files_to_lint) > 50:
377 files_to_lint = []
378
379 results.extend(
380 _checkWithNodeScript(input_api, output_api, lint_path, files_to_lint))
381 return results
382
383
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000384def _CheckGeneratedFiles(input_api, output_api):
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000385 v8_directory_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'v8')
386 blink_directory_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party', 'blink')
387 protocol_location = input_api.os_path.join(blink_directory_path, 'public', 'devtools_protocol')
388 scripts_build_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'build')
Tim van der Lippe5d2d79b2020-03-23 11:45:04 +0000389 scripts_generated_output_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end', 'generated')
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000390
391 generated_aria_path = input_api.os_path.join(scripts_build_path, 'generate_aria.py')
392 generated_supported_css_path = input_api.os_path.join(scripts_build_path, 'generate_supported_css.py')
393 generated_protocol_path = input_api.os_path.join(scripts_build_path, 'code_generator_frontend.py')
Tim van der Lippe2a1eac22021-05-13 16:19:29 +0100394 generated_protocol_typescript_path = input_api.os_path.join(
395 input_api.PresubmitLocalPath(), 'scripts', 'protocol_typescript')
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000396 concatenate_protocols_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party', 'inspector_protocol',
397 'concatenate_protocols.py')
398
399 affected_files = _getAffectedFiles(input_api, [
400 v8_directory_path,
401 blink_directory_path,
Tim van der Lippe2a1eac22021-05-13 16:19:29 +0100402 input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party',
403 'pyjson5'),
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000404 generated_aria_path,
405 generated_supported_css_path,
406 concatenate_protocols_path,
407 generated_protocol_path,
Tim van der Lippe5d2d79b2020-03-23 11:45:04 +0000408 scripts_generated_output_path,
Tim van der Lippe2a1eac22021-05-13 16:19:29 +0100409 generated_protocol_typescript_path,
410 ], [], ['.pdl', '.json5', '.py', '.js', '.ts'])
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000411
412 if len(affected_files) == 0:
Tim van der Lippefb023462020-08-21 14:10:06 +0100413 return [
414 output_api.PresubmitNotifyResult(
415 'No affected files for generated files check')
416 ]
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000417
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000418 results = [output_api.PresubmitNotifyResult('Running Generated Files Check:')]
Tim van der Lippeb0d65f12020-03-05 12:15:24 +0000419 generate_protocol_resources_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'deps',
420 'generate_protocol_resources.py')
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000421
Tim van der Lippeb0d65f12020-03-05 12:15:24 +0000422 return _ExecuteSubProcess(input_api, output_api, generate_protocol_resources_path, [], results)
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000423
424
Christy Chen2d6d9a62020-09-22 09:04:09 -0700425def _CollectStrings(input_api, output_api):
426 devtools_root = input_api.PresubmitLocalPath()
427 devtools_front_end = input_api.os_path.join(devtools_root, 'front_end')
Tim van der Lippe25f11082021-06-24 16:28:08 +0100428 script_path = input_api.os_path.join(devtools_root, 'third_party', 'i18n',
429 'collect-strings.js')
430 affected_front_end_files = _getAffectedFiles(
431 input_api, [devtools_front_end, script_path], [], ['.js', '.ts'])
Christy Chen2d6d9a62020-09-22 09:04:09 -0700432 if len(affected_front_end_files) == 0:
433 return [
434 output_api.PresubmitNotifyResult(
435 'No affected files to run collect-strings')
436 ]
437
438 results = [
439 output_api.PresubmitNotifyResult('Collecting strings from front_end:')
440 ]
Tim van der Lippe25f11082021-06-24 16:28:08 +0100441 results.extend(
442 _checkWithNodeScript(input_api, output_api, script_path,
443 [devtools_front_end]))
Christy Chen2d6d9a62020-09-22 09:04:09 -0700444 results.append(
445 output_api.PresubmitNotifyResult(
Peter Marshalld67e9f12021-02-08 10:34:35 +0100446 'Please commit en-US.json/en-XL.json if changes are generated.'))
Christy Chen2d6d9a62020-09-22 09:04:09 -0700447 return results
448
449
Tim van der Lippe5279f842020-01-14 16:26:38 +0000450def _CheckNoUncheckedFiles(input_api, output_api):
451 results = []
452 process = input_api.subprocess.Popen(['git', 'diff', '--exit-code'],
453 stdout=input_api.subprocess.PIPE,
454 stderr=input_api.subprocess.STDOUT)
455 out, _ = process.communicate()
456 if process.returncode != 0:
Jack Franklin324f3042020-09-03 11:28:29 +0100457 files_changed_process = input_api.subprocess.Popen(
Tim van der Lippe25f11082021-06-24 16:28:08 +0100458 ['git', 'diff'],
Jack Franklin324f3042020-09-03 11:28:29 +0100459 stdout=input_api.subprocess.PIPE,
460 stderr=input_api.subprocess.STDOUT)
Tim van der Lippe9bb1cf62020-03-06 16:17:02 +0000461 files_changed, _ = files_changed_process.communicate()
462
463 return [
Tim van der Lippefb1dc172021-05-11 16:40:26 +0100464 output_api.PresubmitError(
465 'You have changed files that need to be committed:'),
466 output_api.PresubmitError(files_changed.decode('utf-8'))
Tim van der Lippe9bb1cf62020-03-06 16:17:02 +0000467 ]
Tim van der Lippe5279f842020-01-14 16:26:38 +0000468 return []
469
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000470def _CheckForTooLargeFiles(input_api, output_api):
Christy Chen1ab87e02020-01-30 16:32:16 -0800471 """Avoid large files, especially binary files, in the repository since
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000472 git doesn't scale well for those. They will be in everyone's repo
473 clones forever, forever making Chromium slower to clone and work
474 with."""
Christy Chen1ab87e02020-01-30 16:32:16 -0800475 # Uploading files to cloud storage is not trivial so we don't want
476 # to set the limit too low, but the upper limit for "normal" large
477 # files seems to be 1-2 MB, with a handful around 5-8 MB, so
478 # anything over 20 MB is exceptional.
479 TOO_LARGE_FILE_SIZE_LIMIT = 20 * 1024 * 1024 # 10 MB
480 too_large_files = []
481 for f in input_api.AffectedFiles():
482 # Check both added and modified files (but not deleted files).
483 if f.Action() in ('A', 'M'):
484 size = input_api.os_path.getsize(f.AbsoluteLocalPath())
485 if size > TOO_LARGE_FILE_SIZE_LIMIT:
486 too_large_files.append("%s: %d bytes" % (f.LocalPath(), size))
487 if too_large_files:
488 message = (
489 'Do not commit large files to git since git scales badly for those.\n' +
490 'Instead put the large files in cloud storage and use DEPS to\n' +
491 'fetch them.\n' + '\n'.join(too_large_files)
492 )
493 return [output_api.PresubmitError(
494 'Too large files found in commit', long_text=message + '\n')]
495 else:
496 return []
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000497
Tim van der Lippe5279f842020-01-14 16:26:38 +0000498
Tim van der Lippef8a87092020-09-14 13:01:18 +0100499def _RunCannedChecks(input_api, output_api):
500 results = []
501 results.extend(
502 input_api.canned_checks.CheckOwnersFormat(input_api, output_api))
503 results.extend(input_api.canned_checks.CheckOwners(input_api, output_api))
504 results.extend(
505 input_api.canned_checks.CheckChangeHasNoCrAndHasOnlyOneEol(
506 input_api, output_api))
507 results.extend(
508 input_api.canned_checks.CheckChangeHasNoStrayWhitespace(
Tim van der Lippe69775382021-05-27 17:06:12 +0100509 input_api,
510 output_api,
511 source_file_filter=lambda file: not file.LocalPath().startswith(
512 'node_modules')))
Tim van der Lippef8a87092020-09-14 13:01:18 +0100513 results.extend(
514 input_api.canned_checks.CheckGenderNeutral(input_api, output_api))
515 return results
516
517
Yang Guo4fd355c2019-09-19 10:59:03 +0200518def _CommonChecks(input_api, output_api):
Mathias Bynens032591d2019-10-21 11:51:31 +0200519 """Checks common to both upload and commit."""
520 results = []
Mathias Bynens011b0072020-08-05 10:17:35 +0200521 results.extend(
522 input_api.canned_checks.CheckAuthorizedAuthor(
523 input_api, output_api, bot_allowlist=[AUTOROLL_ACCOUNT]))
Brandon Goddard33104372020-08-13 08:49:23 -0700524 results.extend(_CheckExperimentTelemetry(input_api, output_api))
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000525 results.extend(_CheckGeneratedFiles(input_api, output_api))
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200526 results.extend(_CheckDevToolsStyleJS(input_api, output_api))
527 results.extend(_CheckDevToolsStyleCSS(input_api, output_api))
Jack Franklin1aa212d2021-09-10 15:20:08 +0100528 results.extend(_CheckDevToolsRunESLintTests(input_api, output_api))
Tim van der Lippea53672d2021-07-08 15:52:35 +0100529 results.extend(_CheckDevToolsNonJSFileLicenseHeaders(
530 input_api, output_api))
Jack Franklinb10193f2021-03-19 10:25:08 +0000531
Tim van der Lippe5497d482020-01-14 15:27:30 +0000532 results.extend(_CheckFormat(input_api, output_api))
Yang Guoa7845d52019-10-31 11:30:23 +0100533 results.extend(_CheckChangesAreExclusiveToDirectory(input_api, output_api))
Tim van der Lippef8a87092020-09-14 13:01:18 +0100534 # Run the canned checks from `depot_tools` after the custom DevTools checks.
535 # The canned checks for example check that lines have line endings. The
536 # DevTools presubmit checks automatically fix these issues. If we would run
537 # the canned checks before the DevTools checks, they would erroneously conclude
538 # that there are issues in the code. Since the canned checks are allowed to be
539 # ignored, a confusing message is shown that asks if the failed presubmit can
540 # be continued regardless. By fixing the issues before we reach the canned checks,
541 # we don't show the message to suppress these errors, which would otherwise be
542 # causing CQ to fail.
543 results.extend(_RunCannedChecks(input_api, output_api))
Kalon Hindsd44fddf2020-12-10 05:43:25 -0800544 return results
545
546
547def _SideEffectChecks(input_api, output_api):
548 """Check side effects caused by other checks"""
549 results = []
Tim van der Lippe5279f842020-01-14 16:26:38 +0000550 results.extend(_CheckNoUncheckedFiles(input_api, output_api))
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000551 results.extend(_CheckForTooLargeFiles(input_api, output_api))
Blink Reformat4c46d092018-04-07 15:32:37 +0000552 return results
553
554
Liviu Raud614e092020-01-08 10:56:33 +0100555def CheckChangeOnUpload(input_api, output_api):
556 results = []
557 results.extend(_CommonChecks(input_api, output_api))
Christy Chen2d6d9a62020-09-22 09:04:09 -0700558 results.extend(_CollectStrings(input_api, output_api))
Kalon Hindsd44fddf2020-12-10 05:43:25 -0800559 # Run checks that rely on output from other DevTool checks
560 results.extend(_SideEffectChecks(input_api, output_api))
Sigurd Schneider5c9b4f92021-01-22 11:09:55 +0100561 results.extend(_CheckBugAssociation(input_api, output_api, False))
Liviu Raud614e092020-01-08 10:56:33 +0100562 return results
563
564
Blink Reformat4c46d092018-04-07 15:32:37 +0000565def CheckChangeOnCommit(input_api, output_api):
Mandy Chenf0fbdbe2019-08-22 23:58:37 +0000566 results = []
Yang Guo4fd355c2019-09-19 10:59:03 +0200567 results.extend(_CommonChecks(input_api, output_api))
Christy Chen2d6d9a62020-09-22 09:04:09 -0700568 results.extend(_CollectStrings(input_api, output_api))
Kalon Hindsd44fddf2020-12-10 05:43:25 -0800569 # Run checks that rely on output from other DevTool checks
570 results.extend(_SideEffectChecks(input_api, output_api))
Mathias Bynens032591d2019-10-21 11:51:31 +0200571 results.extend(input_api.canned_checks.CheckChangeHasDescription(input_api, output_api))
Sigurd Schneider5c9b4f92021-01-22 11:09:55 +0100572 results.extend(_CheckBugAssociation(input_api, output_api, True))
Mandy Chenf0fbdbe2019-08-22 23:58:37 +0000573 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000574
575
Mandy Chena6be46a2019-07-09 17:06:27 +0000576def _getAffectedFiles(input_api, parent_directories, excluded_actions, accepted_endings): # pylint: disable=invalid-name
Yang Guo75beda92019-10-28 08:29:25 +0100577 """Return absolute file paths of affected files (not due to an excluded action)
Mandy Chena6be46a2019-07-09 17:06:27 +0000578 under a parent directory with an accepted file ending.
Yang Guo75beda92019-10-28 08:29:25 +0100579 """
Mandy Chena6be46a2019-07-09 17:06:27 +0000580 local_paths = [
581 f.AbsoluteLocalPath() for f in input_api.AffectedFiles() if all(f.Action() != action for action in excluded_actions)
582 ]
583 affected_files = [
Tim van der Lippefb1dc172021-05-11 16:40:26 +0100584 file_name for file_name in local_paths
585 if any(parent_directory in file_name
586 for parent_directory in parent_directories) and (
587 len(accepted_endings) == 0 or any(
588 file_name.endswith(accepted_ending)
589 for accepted_ending in accepted_endings))
Mandy Chena6be46a2019-07-09 17:06:27 +0000590 ]
591 return affected_files
592
593
Tim van der Lippec4617122020-03-06 16:24:19 +0000594def _checkWithNodeScript(input_api, output_api, script_path, script_arguments=[]): # pylint: disable=invalid-name
Blink Reformat4c46d092018-04-07 15:32:37 +0000595 original_sys_path = sys.path
596 try:
Yang Guo75beda92019-10-28 08:29:25 +0100597 sys.path = sys.path + [input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')]
Yang Guod8176982019-10-04 20:30:35 +0000598 import devtools_paths
Blink Reformat4c46d092018-04-07 15:32:37 +0000599 finally:
600 sys.path = original_sys_path
601
Tim van der Lippec4617122020-03-06 16:24:19 +0000602 return _ExecuteSubProcess(input_api, output_api, [devtools_paths.node_path(), script_path], script_arguments, [])
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200603
604
Jack Franklin324f3042020-09-03 11:28:29 +0100605def _checkWithTypeScript(input_api,
606 output_api,
607 tsc_arguments,
608 script_path,
609 script_arguments=[]): # pylint: disable=invalid-name
610 original_sys_path = sys.path
611 try:
612 sys.path = sys.path + [
613 input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')
614 ]
615 import devtools_paths
616 finally:
617 sys.path = original_sys_path
618
619 # First run tsc to compile the TS script that we then run in the _ExecuteSubProcess call
620 tsc_compiler_process = input_api.subprocess.Popen(
621 [
622 devtools_paths.node_path(),
623 devtools_paths.typescript_compiler_path()
624 ] + tsc_arguments,
625 stdout=input_api.subprocess.PIPE,
626 stderr=input_api.subprocess.STDOUT)
627
628 out, _ = tsc_compiler_process.communicate()
629 if tsc_compiler_process.returncode != 0:
630 return [
631 output_api.PresubmitError('Error compiling briges regenerator:\n' +
Tim van der Lippefb1dc172021-05-11 16:40:26 +0100632 out.decode('utf-8'))
Jack Franklin324f3042020-09-03 11:28:29 +0100633 ]
634
635 return _checkWithNodeScript(input_api, output_api, script_path,
636 script_arguments)
637
638
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200639def _getFilesToLint(input_api, output_api, lint_config_files,
640 default_linted_directories, accepted_endings, results):
Mathias Bynens0ec56612020-06-19 09:14:03 +0200641 run_full_check = False
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200642 files_to_lint = []
643
644 # We are changing the lint configuration; run the full check.
Tim van der Lippefb1dc172021-05-11 16:40:26 +0100645 if len(lint_config_files) != 0:
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200646 results.append(
647 output_api.PresubmitNotifyResult('Running full lint check'))
Mathias Bynens0ec56612020-06-19 09:14:03 +0200648 run_full_check = True
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200649 else:
650 # Only run the linter on files that are relevant, to save PRESUBMIT time.
651 files_to_lint = _getAffectedFiles(input_api,
652 default_linted_directories, ['D'],
653 accepted_endings)
654
Paul Lewis2b9224f2020-09-08 18:13:10 +0100655 # Exclude front_end/third_party files.
Tim van der Lippefb1dc172021-05-11 16:40:26 +0100656 files_to_lint = [
657 file for file in files_to_lint if "third_party" not in file
658 ]
Paul Lewis2b9224f2020-09-08 18:13:10 +0100659
Tim van der Lippefb1dc172021-05-11 16:40:26 +0100660 if len(files_to_lint) == 0:
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200661 results.append(
662 output_api.PresubmitNotifyResult(
663 'No affected files for lint check'))
664
Tim van der Lippefb1dc172021-05-11 16:40:26 +0100665 should_bail_out = len(files_to_lint) == 0 and not run_full_check
Mathias Bynens0ec56612020-06-19 09:14:03 +0200666 return should_bail_out, files_to_lint