blob: 98e8fc3bd72af5d54dc0e919149919128946620a [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):
Tim van der Lippec2756dc2021-12-08 12:17:32 +000078 if file.endswith('OWNERS') and 'OWNERS' in dirs:
79 return True
Yang Guoa7845d52019-10-31 11:30:23 +010080 for dir in dirs:
81 if IsParentDir(file, dir):
82 return True
83
Tim van der Lippe4050a302021-04-13 10:21:21 +010084 EXCLUSIVE_CHANGE_DIRECTORIES = [
85 [
86 'third_party', 'v8',
87 input_api.os_path.join('front_end', 'generated')
88 ],
89 [
90 'node_modules',
Tim van der Lippe4050a302021-04-13 10:21:21 +010091 'package-lock.json',
92 input_api.os_path.join('scripts', 'deps', 'manage_node_deps.py'),
93 ],
Tim van der Lippec2756dc2021-12-08 12:17:32 +000094 ['OWNERS'],
Tim van der Lippe4050a302021-04-13 10:21:21 +010095 ]
96
Yang Guoa7845d52019-10-31 11:30:23 +010097 affected_files = input_api.LocalPaths()
Yang Guoa7845d52019-10-31 11:30:23 +010098 num_affected = len(affected_files)
99 for dirs in EXCLUSIVE_CHANGE_DIRECTORIES:
Paul Lewis14effba2019-12-02 14:56:40 +0000100 dir_list = ', '.join(dirs)
Tim van der Lippefb1dc172021-05-11 16:40:26 +0100101 affected_in_dir = [
102 file for file in affected_files if FileIsInDir(file, dirs)
103 ]
Yang Guoa7845d52019-10-31 11:30:23 +0100104 num_in_dir = len(affected_in_dir)
105 if num_in_dir == 0:
106 continue
Tim van der Lippeebb94a92019-11-19 17:07:53 +0000107 # Addition of new third_party folders must have a new entry in `.gitignore`
108 if '.gitignore' in affected_files:
109 num_in_dir = num_in_dir + 1
Yang Guoa7845d52019-10-31 11:30:23 +0100110 if num_in_dir < num_affected:
Tim van der Lippe239963b2021-04-09 10:43:38 +0100111 unexpected_files = [
112 file for file in affected_files if file not in affected_in_dir
113 ]
114 results.append(
115 output_api.PresubmitError(
116 ('CLs that affect files in "%s" should be limited to these files/directories.'
117 % dir_list) +
118 ('\nUnexpected files: %s.' % unexpected_files) +
119 '\nYou can disable this check by adding DISABLE_THIRD_PARTY_CHECK=<reason> to your commit message'
120 ))
Brandon Goddarde7028672020-01-30 09:31:04 -0800121 break
122
123 return results
Yang Guoa7845d52019-10-31 11:30:23 +0100124
Blink Reformat4c46d092018-04-07 15:32:37 +0000125
Sigurd Schneider5c9b4f92021-01-22 11:09:55 +0100126def _CheckBugAssociation(input_api, output_api, is_committing):
127 results = [output_api.PresubmitNotifyResult('Bug Association Check:')]
128 bugs = input_api.change.BugsFromDescription()
129 message = (
130 "Each CL should be associated with a bug, use \'Bug:\' or \'Fixed:\' lines in\n"
131 "the footer of the commit description. If you explicitly don\'t want to\n"
132 "set a bug, use \'Bug: none\' in the footer of the commit description.\n\n"
133 "Note: The footer of the commit description is the last block of lines in\n"
134 "the commit description that doesn't contain empty lines. This means that\n"
135 "any \'Bug:\' or \'Fixed:\' lines that are eventually followed by an empty\n"
136 "line are not detected by this presubmit check.")
137
138 if not bugs:
139 if is_committing:
140 results.append(output_api.PresubmitError(message))
141 else:
142 results.append(output_api.PresubmitNotifyResult(message))
143
144 for bug in bugs:
145 results.append(output_api.PresubmitNotifyResult(('%s') % bug))
146
147 return results
148
149
Brandon Goddard33104372020-08-13 08:49:23 -0700150def _CheckExperimentTelemetry(input_api, output_api):
Brandon Goddard33104372020-08-13 08:49:23 -0700151 experiment_telemetry_files = [
152 input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end',
Christy Chenab9a44d2021-07-02 12:54:30 -0700153 'entrypoints', 'main', 'MainImpl.ts'),
Brandon Goddard33104372020-08-13 08:49:23 -0700154 input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end',
Tim van der Lippee0247312021-04-01 15:25:30 +0100155 'core', 'host', 'UserMetrics.ts')
Brandon Goddard33104372020-08-13 08:49:23 -0700156 ]
157 affected_main_files = _getAffectedFiles(input_api,
158 experiment_telemetry_files, [],
Christy Chenab9a44d2021-07-02 12:54:30 -0700159 ['.ts'])
Brandon Goddard33104372020-08-13 08:49:23 -0700160 if len(affected_main_files) == 0:
Tim van der Lippefb023462020-08-21 14:10:06 +0100161 return [
162 output_api.PresubmitNotifyResult(
163 'No affected files for telemetry check')
164 ]
Brandon Goddard33104372020-08-13 08:49:23 -0700165
Tim van der Lippefb023462020-08-21 14:10:06 +0100166 results = [
167 output_api.PresubmitNotifyResult('Running Experiment Telemetry check:')
168 ]
Brandon Goddard33104372020-08-13 08:49:23 -0700169 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
170 'scripts', 'check_experiments.js')
171 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
172 return results
173
174
Blink Reformat4c46d092018-04-07 15:32:37 +0000175def _CheckFormat(input_api, output_api):
Sigurd Schneiderf3a1ecd2021-03-02 15:46:03 +0100176 node_modules_affected_files = _getAffectedFiles(input_api, [
Tim van der Lippe6509dba2021-11-23 16:19:23 +0000177 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules'),
178 input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end',
179 'third_party')
Sigurd Schneiderf3a1ecd2021-03-02 15:46:03 +0100180 ], [], [])
Tim van der Lippefdbd42e2020-04-07 15:14:36 +0100181
182 # TODO(crbug.com/1068198): Remove once `git cl format --js` can handle large CLs.
183 if (len(node_modules_affected_files) > 0):
Tim van der Lippe6509dba2021-11-23 16:19:23 +0000184 return [
185 output_api.PresubmitNotifyResult(
186 'Skipping Format Checks because `node_modules`/`front_end/third_party` files are affected.'
187 )
188 ]
Tim van der Lippefdbd42e2020-04-07 15:14:36 +0100189
Brandon Goddarde7028672020-01-30 09:31:04 -0800190 results = [output_api.PresubmitNotifyResult('Running Format Checks:')]
Blink Reformat4c46d092018-04-07 15:32:37 +0000191
Tim van der Lippef515fdc2020-03-06 16:18:25 +0000192 return _ExecuteSubProcess(input_api, output_api, ['git', 'cl', 'format', '--js'], [], results)
Blink Reformat4c46d092018-04-07 15:32:37 +0000193
Jack Franklin1aa212d2021-09-10 15:20:08 +0100194
195def _CheckDevToolsRunESLintTests(input_api, output_api):
196 # Check for changes in the eslint_rules directory, and run the eslint rules
197 # tests if so.
198 # We don't do this on every CL as most do not touch the rules, but if we do
199 # change them we need to make sure all the tests are passing.
Jack Franklin03db63a2021-09-16 14:40:56 +0100200 original_sys_path = sys.path
201 try:
202 sys.path = sys.path + [
203 input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')
204 ]
205 import devtools_paths
206 finally:
207 sys.path = original_sys_path
Jack Franklin1aa212d2021-09-10 15:20:08 +0100208 eslint_rules_dir_path = input_api.os_path.join(
209 input_api.PresubmitLocalPath(), 'scripts', 'eslint_rules')
210 eslint_rules_affected_files = _getAffectedFiles(input_api,
211 [eslint_rules_dir_path],
212 [], [])
213
214 if (len(eslint_rules_affected_files) == 0):
215 return []
216
Jack Franklin03db63a2021-09-16 14:40:56 +0100217 mocha_path = devtools_paths.mocha_path()
Jack Franklin1aa212d2021-09-10 15:20:08 +0100218 eslint_tests_path = input_api.os_path.join(eslint_rules_dir_path, 'tests',
219 '*_test.js')
220
221 results = [output_api.PresubmitNotifyResult('ESLint rules unit tests')]
222 results.extend(
223 # The dot reporter is more concise which is useful to not get LOADS of
224 # output when just one test fails.
225 _checkWithNodeScript(input_api, output_api, mocha_path,
226 ['--reporter', 'dot', eslint_tests_path]))
227 return results
228
229
Tim van der Lippe800d8752022-02-04 12:49:56 +0000230def _CheckDevToolsRunBuildTests(input_api, output_api):
231 # Check for changes in the build/tests directory, and run the tests if so.
232 # We don't do this on every CL as most do not touch the rules, but if we do
233 # change them we need to make sure all the tests are passing.
234 original_sys_path = sys.path
235 try:
236 sys.path = sys.path + [
237 input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')
238 ]
239 import devtools_paths
240 finally:
241 sys.path = original_sys_path
242 scripts_build_dir_path = input_api.os_path.join(
243 input_api.PresubmitLocalPath(), 'scripts', 'build')
244 scripts_build_affected_files = _getAffectedFiles(input_api,
245 [scripts_build_dir_path],
246 [], [])
247
248 if len(scripts_build_affected_files) == 0:
249 return []
250
251 mocha_path = devtools_paths.mocha_path()
252 build_tests_path = input_api.os_path.join(scripts_build_dir_path, 'tests',
253 '*_test.js')
254
255 results = [output_api.PresubmitNotifyResult('Build plugins unit tests')]
256 results.extend(
257 # The dot reporter is more concise which is useful to not get LOADS of
258 # output when just one test fails.
259 _checkWithNodeScript(input_api, output_api, mocha_path,
260 ['--reporter', 'dot', build_tests_path]))
261 return results
262
263
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200264def _CheckDevToolsStyleJS(input_api, output_api):
Tim van der Lippefb023462020-08-21 14:10:06 +0100265 results = [output_api.PresubmitNotifyResult('JS style check:')]
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200266 lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
267 'scripts', 'test',
Tim van der Lippef9e565e2021-11-08 16:22:11 +0000268 'run_lint_check_js.mjs')
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000269
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200270 front_end_directory = input_api.os_path.join(
271 input_api.PresubmitLocalPath(), 'front_end')
Jack Franklinbcfd6ad2021-02-17 10:12:50 +0000272 component_docs_directory = input_api.os_path.join(front_end_directory,
Tim van der Lippee622f552021-04-14 15:15:18 +0100273 'ui', 'components',
274 'docs')
Alex Rudenko5556a902020-09-29 09:37:23 +0000275 inspector_overlay_directory = input_api.os_path.join(
276 input_api.PresubmitLocalPath(), 'inspector_overlay')
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200277 test_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
278 'test')
279 scripts_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
280 'scripts')
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000281
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200282 default_linted_directories = [
Alex Rudenko5556a902020-09-29 09:37:23 +0000283 front_end_directory, test_directory, scripts_directory,
284 inspector_overlay_directory
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200285 ]
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000286
287 eslint_related_files = [
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200288 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules',
289 'eslint'),
Tim van der Lippecf4ab402021-02-12 14:30:58 +0000290 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules',
291 '@typescript-eslint'),
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000292 input_api.os_path.join(input_api.PresubmitLocalPath(), '.eslintrc.js'),
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200293 input_api.os_path.join(input_api.PresubmitLocalPath(),
294 '.eslintignore'),
Tim van der Lippe33543ac2020-12-14 15:37:45 +0100295 input_api.os_path.join(front_end_directory, '.eslintrc.js'),
Jack Franklinbcfd6ad2021-02-17 10:12:50 +0000296 input_api.os_path.join(component_docs_directory, '.eslintrc.js'),
Tim van der Lippe406249f2020-12-14 15:59:10 +0100297 input_api.os_path.join(test_directory, '.eslintrc.js'),
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200298 input_api.os_path.join(scripts_directory, 'test',
299 'run_lint_check_js.py'),
300 input_api.os_path.join(scripts_directory, 'test',
Tim van der Lippef9e565e2021-11-08 16:22:11 +0000301 'run_lint_check_js.mjs'),
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000302 input_api.os_path.join(scripts_directory, '.eslintrc.js'),
303 input_api.os_path.join(scripts_directory, 'eslint_rules'),
304 ]
305
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200306 lint_config_files = _getAffectedFiles(input_api, eslint_related_files, [],
307 ['.js', '.py', '.eslintignore'])
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000308
Mathias Bynens0ec56612020-06-19 09:14:03 +0200309 should_bail_out, files_to_lint = _getFilesToLint(
310 input_api, output_api, lint_config_files, default_linted_directories,
311 ['.js', '.ts'], results)
312 if should_bail_out:
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200313 return results
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000314
Brandon Goddarde34e94f2021-04-12 10:58:26 -0700315 # If there are more than 50 files to check, don't bother and check
316 # everything, so as to not run into command line length limits on Windows.
317 if len(files_to_lint) > 50:
318 files_to_lint = []
319
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200320 results.extend(
321 _checkWithNodeScript(input_api, output_api, lint_path, files_to_lint))
Tim van der Lippe98132242020-04-14 17:16:54 +0100322 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000323
324
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200325def _CheckDevToolsStyleCSS(input_api, output_api):
Tim van der Lippefb023462020-08-21 14:10:06 +0100326 results = [output_api.PresubmitNotifyResult('CSS style check:')]
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200327 lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
328 'scripts', 'test',
Jack Franklinbc302342021-01-18 10:03:30 +0000329 'run_lint_check_css.js')
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200330
331 front_end_directory = input_api.os_path.join(
332 input_api.PresubmitLocalPath(), 'front_end')
Alex Rudenko5556a902020-09-29 09:37:23 +0000333 inspector_overlay_directory = input_api.os_path.join(
334 input_api.PresubmitLocalPath(), 'inspector_overlay')
335 default_linted_directories = [
336 front_end_directory, inspector_overlay_directory
337 ]
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200338
339 scripts_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
340 'scripts')
341
342 stylelint_related_files = [
343 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules',
344 'stylelint'),
345 input_api.os_path.join(input_api.PresubmitLocalPath(),
346 '.stylelintrc.json'),
347 input_api.os_path.join(input_api.PresubmitLocalPath(),
348 '.stylelintignore'),
349 input_api.os_path.join(scripts_directory, 'test',
Sigurd Schneider6523c512021-02-12 10:44:28 +0100350 'run_lint_check_css.js'),
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200351 ]
352
353 lint_config_files = _getAffectedFiles(input_api, stylelint_related_files,
Sigurd Schneider6523c512021-02-12 10:44:28 +0100354 [], [])
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200355
Sigurd Schneidere3bf6c22021-02-11 15:35:23 +0100356 css_should_bail_out, css_files_to_lint = _getFilesToLint(
Mathias Bynens0ec56612020-06-19 09:14:03 +0200357 input_api, output_api, lint_config_files, default_linted_directories,
358 ['.css'], results)
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200359
Sigurd Schneiderf3a1ecd2021-03-02 15:46:03 +0100360 # If there are more than 50 files to check, don't bother and check
361 # everything, so as to not run into command line length limits on Windows.
362 if not css_should_bail_out:
363 if len(css_files_to_lint) < 50:
364 script_args = ["--files"] + css_files_to_lint
365 else:
366 script_args = [] # The defaults check all CSS files.
367 results.extend(
368 _checkWithNodeScript(input_api, output_api, lint_path,
369 script_args))
370
Jack Franklinbc302342021-01-18 10:03:30 +0000371 return results
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200372
373
Tim van der Lippea53672d2021-07-08 15:52:35 +0100374def _CheckDevToolsNonJSFileLicenseHeaders(input_api, output_api):
Tim van der Lippe81752502021-05-26 15:38:12 +0100375 results = [
376 output_api.PresubmitNotifyResult(
377 'Python-like file license header check:')
378 ]
Tim van der Lippea53672d2021-07-08 15:52:35 +0100379 lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
380 'scripts', 'test',
381 'run_header_check_non_js_files.js')
Tim van der Lippe81752502021-05-26 15:38:12 +0100382
383 front_end_directory = input_api.os_path.join(
384 input_api.PresubmitLocalPath(), 'front_end')
385 inspector_overlay_directory = input_api.os_path.join(
386 input_api.PresubmitLocalPath(), 'inspector_overlay')
387 test_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
388 'test')
389 scripts_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
390 'scripts')
Tim van der Lippe8b929542021-05-26 15:54:20 +0100391 config_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
392 'config')
Tim van der Lippe81752502021-05-26 15:38:12 +0100393
394 default_linted_directories = [
395 front_end_directory, test_directory, scripts_directory,
Tim van der Lippe8b929542021-05-26 15:54:20 +0100396 inspector_overlay_directory, config_directory
Tim van der Lippe81752502021-05-26 15:38:12 +0100397 ]
398
399 check_related_files = [lint_path]
400
401 lint_config_files = _getAffectedFiles(input_api, check_related_files, [],
402 ['.js'])
403
404 should_bail_out, files_to_lint = _getFilesToLint(
405 input_api, output_api, lint_config_files, default_linted_directories,
Tim van der Lippea53672d2021-07-08 15:52:35 +0100406 ['BUILD.gn', '.gni', '.css'], results)
Tim van der Lippe81752502021-05-26 15:38:12 +0100407 if should_bail_out:
408 return results
409
410 # If there are more than 50 files to check, don't bother and check
411 # everything, so as to not run into command line length limits on Windows.
412 if len(files_to_lint) > 50:
413 files_to_lint = []
414
415 results.extend(
416 _checkWithNodeScript(input_api, output_api, lint_path, files_to_lint))
417 return results
418
419
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000420def _CheckGeneratedFiles(input_api, output_api):
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000421 v8_directory_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'v8')
422 blink_directory_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party', 'blink')
423 protocol_location = input_api.os_path.join(blink_directory_path, 'public', 'devtools_protocol')
424 scripts_build_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'build')
Tim van der Lippe5d2d79b2020-03-23 11:45:04 +0000425 scripts_generated_output_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end', 'generated')
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000426
427 generated_aria_path = input_api.os_path.join(scripts_build_path, 'generate_aria.py')
428 generated_supported_css_path = input_api.os_path.join(scripts_build_path, 'generate_supported_css.py')
429 generated_protocol_path = input_api.os_path.join(scripts_build_path, 'code_generator_frontend.py')
Tim van der Lippe2a1eac22021-05-13 16:19:29 +0100430 generated_protocol_typescript_path = input_api.os_path.join(
431 input_api.PresubmitLocalPath(), 'scripts', 'protocol_typescript')
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000432 concatenate_protocols_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party', 'inspector_protocol',
433 'concatenate_protocols.py')
434
435 affected_files = _getAffectedFiles(input_api, [
436 v8_directory_path,
437 blink_directory_path,
Tim van der Lippe2a1eac22021-05-13 16:19:29 +0100438 input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party',
439 'pyjson5'),
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000440 generated_aria_path,
441 generated_supported_css_path,
442 concatenate_protocols_path,
443 generated_protocol_path,
Tim van der Lippe5d2d79b2020-03-23 11:45:04 +0000444 scripts_generated_output_path,
Tim van der Lippe2a1eac22021-05-13 16:19:29 +0100445 generated_protocol_typescript_path,
446 ], [], ['.pdl', '.json5', '.py', '.js', '.ts'])
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000447
Jack Franklin3a802602022-07-13 08:39:42 +0000448 return []
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000449 if len(affected_files) == 0:
Tim van der Lippefb023462020-08-21 14:10:06 +0100450 return [
451 output_api.PresubmitNotifyResult(
452 'No affected files for generated files check')
453 ]
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000454
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000455 results = [output_api.PresubmitNotifyResult('Running Generated Files Check:')]
Tim van der Lippeb0d65f12020-03-05 12:15:24 +0000456 generate_protocol_resources_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'deps',
457 'generate_protocol_resources.py')
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000458
Tim van der Lippeb0d65f12020-03-05 12:15:24 +0000459 return _ExecuteSubProcess(input_api, output_api, generate_protocol_resources_path, [], results)
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000460
461
Christy Chen2d6d9a62020-09-22 09:04:09 -0700462def _CollectStrings(input_api, output_api):
463 devtools_root = input_api.PresubmitLocalPath()
464 devtools_front_end = input_api.os_path.join(devtools_root, 'front_end')
Tim van der Lippe25f11082021-06-24 16:28:08 +0100465 script_path = input_api.os_path.join(devtools_root, 'third_party', 'i18n',
466 'collect-strings.js')
467 affected_front_end_files = _getAffectedFiles(
468 input_api, [devtools_front_end, script_path], [], ['.js', '.ts'])
Christy Chen2d6d9a62020-09-22 09:04:09 -0700469 if len(affected_front_end_files) == 0:
470 return [
471 output_api.PresubmitNotifyResult(
472 'No affected files to run collect-strings')
473 ]
474
475 results = [
476 output_api.PresubmitNotifyResult('Collecting strings from front_end:')
477 ]
Tim van der Lippe25f11082021-06-24 16:28:08 +0100478 results.extend(
479 _checkWithNodeScript(input_api, output_api, script_path,
480 [devtools_front_end]))
Christy Chen2d6d9a62020-09-22 09:04:09 -0700481 results.append(
482 output_api.PresubmitNotifyResult(
Peter Marshalld67e9f12021-02-08 10:34:35 +0100483 'Please commit en-US.json/en-XL.json if changes are generated.'))
Christy Chen2d6d9a62020-09-22 09:04:09 -0700484 return results
485
486
Tim van der Lippe5279f842020-01-14 16:26:38 +0000487def _CheckNoUncheckedFiles(input_api, output_api):
488 results = []
489 process = input_api.subprocess.Popen(['git', 'diff', '--exit-code'],
490 stdout=input_api.subprocess.PIPE,
491 stderr=input_api.subprocess.STDOUT)
492 out, _ = process.communicate()
493 if process.returncode != 0:
Jack Franklin324f3042020-09-03 11:28:29 +0100494 files_changed_process = input_api.subprocess.Popen(
Tim van der Lippe25f11082021-06-24 16:28:08 +0100495 ['git', 'diff'],
Jack Franklin324f3042020-09-03 11:28:29 +0100496 stdout=input_api.subprocess.PIPE,
497 stderr=input_api.subprocess.STDOUT)
Tim van der Lippe9bb1cf62020-03-06 16:17:02 +0000498 files_changed, _ = files_changed_process.communicate()
499
500 return [
Tim van der Lippefb1dc172021-05-11 16:40:26 +0100501 output_api.PresubmitError(
502 'You have changed files that need to be committed:'),
503 output_api.PresubmitError(files_changed.decode('utf-8'))
Tim van der Lippe9bb1cf62020-03-06 16:17:02 +0000504 ]
Tim van der Lippe5279f842020-01-14 16:26:38 +0000505 return []
506
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000507def _CheckForTooLargeFiles(input_api, output_api):
Christy Chen1ab87e02020-01-30 16:32:16 -0800508 """Avoid large files, especially binary files, in the repository since
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000509 git doesn't scale well for those. They will be in everyone's repo
510 clones forever, forever making Chromium slower to clone and work
511 with."""
Christy Chen1ab87e02020-01-30 16:32:16 -0800512 # Uploading files to cloud storage is not trivial so we don't want
513 # to set the limit too low, but the upper limit for "normal" large
514 # files seems to be 1-2 MB, with a handful around 5-8 MB, so
515 # anything over 20 MB is exceptional.
516 TOO_LARGE_FILE_SIZE_LIMIT = 20 * 1024 * 1024 # 10 MB
517 too_large_files = []
518 for f in input_api.AffectedFiles():
519 # Check both added and modified files (but not deleted files).
520 if f.Action() in ('A', 'M'):
521 size = input_api.os_path.getsize(f.AbsoluteLocalPath())
522 if size > TOO_LARGE_FILE_SIZE_LIMIT:
523 too_large_files.append("%s: %d bytes" % (f.LocalPath(), size))
524 if too_large_files:
525 message = (
526 'Do not commit large files to git since git scales badly for those.\n' +
527 'Instead put the large files in cloud storage and use DEPS to\n' +
528 'fetch them.\n' + '\n'.join(too_large_files)
529 )
530 return [output_api.PresubmitError(
531 'Too large files found in commit', long_text=message + '\n')]
532 else:
533 return []
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000534
Tim van der Lippe5279f842020-01-14 16:26:38 +0000535
Tim van der Lippef8a87092020-09-14 13:01:18 +0100536def _RunCannedChecks(input_api, output_api):
537 results = []
538 results.extend(
539 input_api.canned_checks.CheckOwnersFormat(input_api, output_api))
540 results.extend(input_api.canned_checks.CheckOwners(input_api, output_api))
541 results.extend(
542 input_api.canned_checks.CheckChangeHasNoCrAndHasOnlyOneEol(
543 input_api, output_api))
544 results.extend(
545 input_api.canned_checks.CheckChangeHasNoStrayWhitespace(
Tim van der Lippe69775382021-05-27 17:06:12 +0100546 input_api,
547 output_api,
548 source_file_filter=lambda file: not file.LocalPath().startswith(
549 'node_modules')))
Tim van der Lippef8a87092020-09-14 13:01:18 +0100550 results.extend(
551 input_api.canned_checks.CheckGenderNeutral(input_api, output_api))
552 return results
553
554
Yang Guo4fd355c2019-09-19 10:59:03 +0200555def _CommonChecks(input_api, output_api):
Mathias Bynens032591d2019-10-21 11:51:31 +0200556 """Checks common to both upload and commit."""
557 results = []
Mathias Bynens011b0072020-08-05 10:17:35 +0200558 results.extend(
559 input_api.canned_checks.CheckAuthorizedAuthor(
560 input_api, output_api, bot_allowlist=[AUTOROLL_ACCOUNT]))
Brandon Goddard33104372020-08-13 08:49:23 -0700561 results.extend(_CheckExperimentTelemetry(input_api, output_api))
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000562 results.extend(_CheckGeneratedFiles(input_api, output_api))
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200563 results.extend(_CheckDevToolsStyleJS(input_api, output_api))
564 results.extend(_CheckDevToolsStyleCSS(input_api, output_api))
Jack Franklin1aa212d2021-09-10 15:20:08 +0100565 results.extend(_CheckDevToolsRunESLintTests(input_api, output_api))
Tim van der Lippe800d8752022-02-04 12:49:56 +0000566 results.extend(_CheckDevToolsRunBuildTests(input_api, output_api))
Tim van der Lippea53672d2021-07-08 15:52:35 +0100567 results.extend(_CheckDevToolsNonJSFileLicenseHeaders(
568 input_api, output_api))
Jack Franklinb10193f2021-03-19 10:25:08 +0000569
Tim van der Lippe5497d482020-01-14 15:27:30 +0000570 results.extend(_CheckFormat(input_api, output_api))
Yang Guoa7845d52019-10-31 11:30:23 +0100571 results.extend(_CheckChangesAreExclusiveToDirectory(input_api, output_api))
Tim van der Lippef8a87092020-09-14 13:01:18 +0100572 # Run the canned checks from `depot_tools` after the custom DevTools checks.
573 # The canned checks for example check that lines have line endings. The
574 # DevTools presubmit checks automatically fix these issues. If we would run
575 # the canned checks before the DevTools checks, they would erroneously conclude
576 # that there are issues in the code. Since the canned checks are allowed to be
577 # ignored, a confusing message is shown that asks if the failed presubmit can
578 # be continued regardless. By fixing the issues before we reach the canned checks,
579 # we don't show the message to suppress these errors, which would otherwise be
580 # causing CQ to fail.
581 results.extend(_RunCannedChecks(input_api, output_api))
Kalon Hindsd44fddf2020-12-10 05:43:25 -0800582 return results
583
584
585def _SideEffectChecks(input_api, output_api):
586 """Check side effects caused by other checks"""
587 results = []
Tim van der Lippe5279f842020-01-14 16:26:38 +0000588 results.extend(_CheckNoUncheckedFiles(input_api, output_api))
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000589 results.extend(_CheckForTooLargeFiles(input_api, output_api))
Blink Reformat4c46d092018-04-07 15:32:37 +0000590 return results
591
592
Liviu Raud614e092020-01-08 10:56:33 +0100593def CheckChangeOnUpload(input_api, output_api):
594 results = []
595 results.extend(_CommonChecks(input_api, output_api))
Christy Chen2d6d9a62020-09-22 09:04:09 -0700596 results.extend(_CollectStrings(input_api, output_api))
Kalon Hindsd44fddf2020-12-10 05:43:25 -0800597 # Run checks that rely on output from other DevTool checks
598 results.extend(_SideEffectChecks(input_api, output_api))
Sigurd Schneider5c9b4f92021-01-22 11:09:55 +0100599 results.extend(_CheckBugAssociation(input_api, output_api, False))
Liviu Raud614e092020-01-08 10:56:33 +0100600 return results
601
602
Blink Reformat4c46d092018-04-07 15:32:37 +0000603def CheckChangeOnCommit(input_api, output_api):
Mandy Chenf0fbdbe2019-08-22 23:58:37 +0000604 results = []
Yang Guo4fd355c2019-09-19 10:59:03 +0200605 results.extend(_CommonChecks(input_api, output_api))
Christy Chen2d6d9a62020-09-22 09:04:09 -0700606 results.extend(_CollectStrings(input_api, output_api))
Kalon Hindsd44fddf2020-12-10 05:43:25 -0800607 # Run checks that rely on output from other DevTool checks
608 results.extend(_SideEffectChecks(input_api, output_api))
Mathias Bynens032591d2019-10-21 11:51:31 +0200609 results.extend(input_api.canned_checks.CheckChangeHasDescription(input_api, output_api))
Sigurd Schneider5c9b4f92021-01-22 11:09:55 +0100610 results.extend(_CheckBugAssociation(input_api, output_api, True))
Mandy Chenf0fbdbe2019-08-22 23:58:37 +0000611 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000612
613
Mandy Chena6be46a2019-07-09 17:06:27 +0000614def _getAffectedFiles(input_api, parent_directories, excluded_actions, accepted_endings): # pylint: disable=invalid-name
Yang Guo75beda92019-10-28 08:29:25 +0100615 """Return absolute file paths of affected files (not due to an excluded action)
Mandy Chena6be46a2019-07-09 17:06:27 +0000616 under a parent directory with an accepted file ending.
Yang Guo75beda92019-10-28 08:29:25 +0100617 """
Mandy Chena6be46a2019-07-09 17:06:27 +0000618 local_paths = [
619 f.AbsoluteLocalPath() for f in input_api.AffectedFiles() if all(f.Action() != action for action in excluded_actions)
620 ]
621 affected_files = [
Tim van der Lippefb1dc172021-05-11 16:40:26 +0100622 file_name for file_name in local_paths
623 if any(parent_directory in file_name
624 for parent_directory in parent_directories) and (
625 len(accepted_endings) == 0 or any(
626 file_name.endswith(accepted_ending)
627 for accepted_ending in accepted_endings))
Mandy Chena6be46a2019-07-09 17:06:27 +0000628 ]
629 return affected_files
630
631
Tim van der Lippec4617122020-03-06 16:24:19 +0000632def _checkWithNodeScript(input_api, output_api, script_path, script_arguments=[]): # pylint: disable=invalid-name
Blink Reformat4c46d092018-04-07 15:32:37 +0000633 original_sys_path = sys.path
634 try:
Yang Guo75beda92019-10-28 08:29:25 +0100635 sys.path = sys.path + [input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')]
Yang Guod8176982019-10-04 20:30:35 +0000636 import devtools_paths
Blink Reformat4c46d092018-04-07 15:32:37 +0000637 finally:
638 sys.path = original_sys_path
639
Tim van der Lippec4617122020-03-06 16:24:19 +0000640 return _ExecuteSubProcess(input_api, output_api, [devtools_paths.node_path(), script_path], script_arguments, [])
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200641
642
643def _getFilesToLint(input_api, output_api, lint_config_files,
644 default_linted_directories, accepted_endings, results):
Mathias Bynens0ec56612020-06-19 09:14:03 +0200645 run_full_check = False
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200646 files_to_lint = []
647
648 # We are changing the lint configuration; run the full check.
Tim van der Lippefb1dc172021-05-11 16:40:26 +0100649 if len(lint_config_files) != 0:
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200650 results.append(
651 output_api.PresubmitNotifyResult('Running full lint check'))
Mathias Bynens0ec56612020-06-19 09:14:03 +0200652 run_full_check = True
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200653 else:
654 # Only run the linter on files that are relevant, to save PRESUBMIT time.
655 files_to_lint = _getAffectedFiles(input_api,
656 default_linted_directories, ['D'],
657 accepted_endings)
658
Jack Franklin130d2ae2022-07-12 09:51:26 +0000659 # Exclude front_end/third_party and front_end/generated files.
Tim van der Lippefb1dc172021-05-11 16:40:26 +0100660 files_to_lint = [
Jack Franklin130d2ae2022-07-12 09:51:26 +0000661 file for file in files_to_lint
662 if "third_party" not in file or "generated" not in file
Tim van der Lippefb1dc172021-05-11 16:40:26 +0100663 ]
Paul Lewis2b9224f2020-09-08 18:13:10 +0100664
Tim van der Lippefb1dc172021-05-11 16:40:26 +0100665 if len(files_to_lint) == 0:
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200666 results.append(
667 output_api.PresubmitNotifyResult(
668 'No affected files for lint check'))
669
Tim van der Lippefb1dc172021-05-11 16:40:26 +0100670 should_bail_out = len(files_to_lint) == 0 and not run_full_check
Mathias Bynens0ec56612020-06-19 09:14:03 +0200671 return should_bail_out, files_to_lint