blob: 599cfd61b73bf4f88c7c2868378d6f8f15846e94 [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
Yang Guoa7845d52019-10-31 11:30:23 +010039EXCLUSIVE_CHANGE_DIRECTORIES = [
Sigurd Schneiderf3a1ecd2021-03-02 15:46:03 +010040 ['third_party', 'v8'],
Tim van der Lippe2b488032021-04-08 17:23:55 +010041 [
42 'node_modules', 'package.json', 'package-lock.json',
43 'scripts/deps/manage_node_deps.py'
44 ],
Tim van der Lippe2e143872021-04-08 12:56:40 +010045 ['OWNERS', 'config/owner'],
Yang Guoa7845d52019-10-31 11:30:23 +010046]
47
Liviu Raufd2e3212019-12-18 16:38:20 +010048AUTOROLL_ACCOUNT = "devtools-ci-autoroll-builder@chops-service-accounts.iam.gserviceaccount.com"
Mathias Bynensa0a6e292019-12-17 13:24:08 +010049
Tim van der Lippe4d004ec2020-03-03 18:32:01 +000050
51def _ExecuteSubProcess(input_api, output_api, script_path, args, results):
Tim van der Lippef515fdc2020-03-06 16:18:25 +000052 if isinstance(script_path, six.string_types):
53 script_path = [input_api.python_executable, script_path]
54
Tim van der Lippefb023462020-08-21 14:10:06 +010055 start_time = time.time()
Sigurd Schneiderf3a1ecd2021-03-02 15:46:03 +010056 process = input_api.subprocess.Popen(script_path + args,
57 stdout=input_api.subprocess.PIPE,
58 stderr=input_api.subprocess.STDOUT)
Tim van der Lippe4d004ec2020-03-03 18:32:01 +000059 out, _ = process.communicate()
Tim van der Lippefb023462020-08-21 14:10:06 +010060 end_time = time.time()
61
62 time_difference = end_time - start_time
63 time_info = "Script execution time was %.1fs seconds\n" % (time_difference)
Tim van der Lippe4d004ec2020-03-03 18:32:01 +000064 if process.returncode != 0:
Tim van der Lippefb023462020-08-21 14:10:06 +010065 results.append(output_api.PresubmitError(time_info + out))
Tim van der Lippe4d004ec2020-03-03 18:32:01 +000066 else:
Tim van der Lippefb023462020-08-21 14:10:06 +010067 results.append(output_api.PresubmitNotifyResult(time_info + out))
Tim van der Lippe4d004ec2020-03-03 18:32:01 +000068 return results
69
70
Yang Guoa7845d52019-10-31 11:30:23 +010071def _CheckChangesAreExclusiveToDirectory(input_api, output_api):
Tim van der Lippebc42a632019-11-28 14:22:55 +000072 if input_api.change.DISABLE_THIRD_PARTY_CHECK != None:
73 return []
Brandon Goddarde7028672020-01-30 09:31:04 -080074 results = [output_api.PresubmitNotifyResult('Directory Exclusivity Check:')]
Sigurd Schneiderf3a1ecd2021-03-02 15:46:03 +010075
Yang Guoa7845d52019-10-31 11:30:23 +010076 def IsParentDir(file, dir):
77 while file != '':
78 if file == dir:
79 return True
80 file = input_api.os_path.dirname(file)
Yang Guoa7845d52019-10-31 11:30:23 +010081 return False
82
83 def FileIsInDir(file, dirs):
84 for dir in dirs:
85 if IsParentDir(file, dir):
86 return True
87
88 affected_files = input_api.LocalPaths()
Yang Guoa7845d52019-10-31 11:30:23 +010089 num_affected = len(affected_files)
90 for dirs in EXCLUSIVE_CHANGE_DIRECTORIES:
Paul Lewis14effba2019-12-02 14:56:40 +000091 dir_list = ', '.join(dirs)
Yang Guoa7845d52019-10-31 11:30:23 +010092 affected_in_dir = filter(lambda f: FileIsInDir(f, dirs), affected_files)
93 num_in_dir = len(affected_in_dir)
94 if num_in_dir == 0:
95 continue
Tim van der Lippeebb94a92019-11-19 17:07:53 +000096 # Addition of new third_party folders must have a new entry in `.gitignore`
97 if '.gitignore' in affected_files:
98 num_in_dir = num_in_dir + 1
Yang Guoa7845d52019-10-31 11:30:23 +010099 if num_in_dir < num_affected:
Brandon Goddarde7028672020-01-30 09:31:04 -0800100 results.append(output_api
Paul Lewis14effba2019-12-02 14:56:40 +0000101 .PresubmitError(('CLs that affect files in "%s" should be limited to these files/directories.' % dir_list) +
Brandon Goddarde7028672020-01-30 09:31:04 -0800102 ' You can disable this check by adding DISABLE_THIRD_PARTY_CHECK=<reason> to your commit message'))
103 break
104
105 return results
Yang Guoa7845d52019-10-31 11:30:23 +0100106
Blink Reformat4c46d092018-04-07 15:32:37 +0000107
Sigurd Schneider5c9b4f92021-01-22 11:09:55 +0100108def _CheckBugAssociation(input_api, output_api, is_committing):
109 results = [output_api.PresubmitNotifyResult('Bug Association Check:')]
110 bugs = input_api.change.BugsFromDescription()
111 message = (
112 "Each CL should be associated with a bug, use \'Bug:\' or \'Fixed:\' lines in\n"
113 "the footer of the commit description. If you explicitly don\'t want to\n"
114 "set a bug, use \'Bug: none\' in the footer of the commit description.\n\n"
115 "Note: The footer of the commit description is the last block of lines in\n"
116 "the commit description that doesn't contain empty lines. This means that\n"
117 "any \'Bug:\' or \'Fixed:\' lines that are eventually followed by an empty\n"
118 "line are not detected by this presubmit check.")
119
120 if not bugs:
121 if is_committing:
122 results.append(output_api.PresubmitError(message))
123 else:
124 results.append(output_api.PresubmitNotifyResult(message))
125
126 for bug in bugs:
127 results.append(output_api.PresubmitNotifyResult(('%s') % bug))
128
129 return results
130
131
Blink Reformat4c46d092018-04-07 15:32:37 +0000132def _CheckBuildGN(input_api, output_api):
Brandon Goddarde7028672020-01-30 09:31:04 -0800133 results = [output_api.PresubmitNotifyResult('Running BUILD.GN check:')]
Sigurd Schneiderf3a1ecd2021-03-02 15:46:03 +0100134 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
135 'scripts', 'check_gn.js')
Brandon Goddarde7028672020-01-30 09:31:04 -0800136 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
137 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000138
139
Brandon Goddard33104372020-08-13 08:49:23 -0700140def _CheckExperimentTelemetry(input_api, output_api):
Brandon Goddard33104372020-08-13 08:49:23 -0700141 experiment_telemetry_files = [
142 input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end',
Jan Schefflerb4eb22d2021-04-05 22:38:36 +0200143 'main', 'MainImpl.ts'),
Brandon Goddard33104372020-08-13 08:49:23 -0700144 input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end',
Tim van der Lippee0247312021-04-01 15:25:30 +0100145 'core', 'host', 'UserMetrics.ts')
Brandon Goddard33104372020-08-13 08:49:23 -0700146 ]
147 affected_main_files = _getAffectedFiles(input_api,
148 experiment_telemetry_files, [],
149 ['.js'])
150 if len(affected_main_files) == 0:
Tim van der Lippefb023462020-08-21 14:10:06 +0100151 return [
152 output_api.PresubmitNotifyResult(
153 'No affected files for telemetry check')
154 ]
Brandon Goddard33104372020-08-13 08:49:23 -0700155
Tim van der Lippefb023462020-08-21 14:10:06 +0100156 results = [
157 output_api.PresubmitNotifyResult('Running Experiment Telemetry check:')
158 ]
Brandon Goddard33104372020-08-13 08:49:23 -0700159 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
160 'scripts', 'check_experiments.js')
161 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
162 return results
163
164
Tim van der Lippee4bdd742019-12-17 16:40:16 +0100165def _CheckJSON(input_api, output_api):
Brandon Goddarde7028672020-01-30 09:31:04 -0800166 results = [output_api.PresubmitNotifyResult('Running JSON Validator:')]
Sigurd Schneiderf3a1ecd2021-03-02 15:46:03 +0100167 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
168 'scripts', 'json_validator',
169 'validate_module_json.js')
Brandon Goddarde7028672020-01-30 09:31:04 -0800170 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
171 return results
Tim van der Lippee4bdd742019-12-17 16:40:16 +0100172
173
Blink Reformat4c46d092018-04-07 15:32:37 +0000174def _CheckFormat(input_api, output_api):
Sigurd Schneiderf3a1ecd2021-03-02 15:46:03 +0100175 node_modules_affected_files = _getAffectedFiles(input_api, [
176 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules')
177 ], [], [])
Tim van der Lippefdbd42e2020-04-07 15:14:36 +0100178
179 # TODO(crbug.com/1068198): Remove once `git cl format --js` can handle large CLs.
180 if (len(node_modules_affected_files) > 0):
181 return [output_api.PresubmitNotifyResult('Skipping Format Checks because `node_modules` files are affected.')]
182
Brandon Goddarde7028672020-01-30 09:31:04 -0800183 results = [output_api.PresubmitNotifyResult('Running Format Checks:')]
Blink Reformat4c46d092018-04-07 15:32:37 +0000184
Tim van der Lippef515fdc2020-03-06 16:18:25 +0000185 return _ExecuteSubProcess(input_api, output_api, ['git', 'cl', 'format', '--js'], [], results)
Blink Reformat4c46d092018-04-07 15:32:37 +0000186
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200187def _CheckDevToolsStyleJS(input_api, output_api):
Tim van der Lippefb023462020-08-21 14:10:06 +0100188 results = [output_api.PresubmitNotifyResult('JS style check:')]
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200189 lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
190 'scripts', 'test',
191 'run_lint_check_js.js')
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000192
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200193 front_end_directory = input_api.os_path.join(
194 input_api.PresubmitLocalPath(), 'front_end')
Jack Franklinbcfd6ad2021-02-17 10:12:50 +0000195 component_docs_directory = input_api.os_path.join(front_end_directory,
196 'component_docs')
Alex Rudenko5556a902020-09-29 09:37:23 +0000197 inspector_overlay_directory = input_api.os_path.join(
198 input_api.PresubmitLocalPath(), 'inspector_overlay')
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200199 test_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
200 'test')
201 scripts_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
202 'scripts')
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000203
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200204 default_linted_directories = [
Alex Rudenko5556a902020-09-29 09:37:23 +0000205 front_end_directory, test_directory, scripts_directory,
206 inspector_overlay_directory
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200207 ]
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000208
209 eslint_related_files = [
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200210 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules',
211 'eslint'),
Tim van der Lippecf4ab402021-02-12 14:30:58 +0000212 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules',
213 '@typescript-eslint'),
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000214 input_api.os_path.join(input_api.PresubmitLocalPath(), '.eslintrc.js'),
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200215 input_api.os_path.join(input_api.PresubmitLocalPath(),
216 '.eslintignore'),
Tim van der Lippe33543ac2020-12-14 15:37:45 +0100217 input_api.os_path.join(front_end_directory, '.eslintrc.js'),
Jack Franklinbcfd6ad2021-02-17 10:12:50 +0000218 input_api.os_path.join(component_docs_directory, '.eslintrc.js'),
Tim van der Lippe406249f2020-12-14 15:59:10 +0100219 input_api.os_path.join(test_directory, '.eslintrc.js'),
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200220 input_api.os_path.join(scripts_directory, 'test',
221 'run_lint_check_js.py'),
222 input_api.os_path.join(scripts_directory, 'test',
223 'run_lint_check_js.js'),
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000224 input_api.os_path.join(scripts_directory, '.eslintrc.js'),
225 input_api.os_path.join(scripts_directory, 'eslint_rules'),
226 ]
227
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200228 lint_config_files = _getAffectedFiles(input_api, eslint_related_files, [],
229 ['.js', '.py', '.eslintignore'])
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000230
Mathias Bynens0ec56612020-06-19 09:14:03 +0200231 should_bail_out, files_to_lint = _getFilesToLint(
232 input_api, output_api, lint_config_files, default_linted_directories,
233 ['.js', '.ts'], results)
234 if should_bail_out:
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200235 return results
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000236
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200237 results.extend(
238 _checkWithNodeScript(input_api, output_api, lint_path, files_to_lint))
Tim van der Lippe98132242020-04-14 17:16:54 +0100239 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000240
241
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200242def _CheckDevToolsStyleCSS(input_api, output_api):
Tim van der Lippefb023462020-08-21 14:10:06 +0100243 results = [output_api.PresubmitNotifyResult('CSS style check:')]
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200244 lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
245 'scripts', 'test',
Jack Franklinbc302342021-01-18 10:03:30 +0000246 'run_lint_check_css.js')
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200247
248 front_end_directory = input_api.os_path.join(
249 input_api.PresubmitLocalPath(), 'front_end')
Alex Rudenko5556a902020-09-29 09:37:23 +0000250 inspector_overlay_directory = input_api.os_path.join(
251 input_api.PresubmitLocalPath(), 'inspector_overlay')
252 default_linted_directories = [
253 front_end_directory, inspector_overlay_directory
254 ]
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200255
256 scripts_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
257 'scripts')
258
259 stylelint_related_files = [
260 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules',
261 'stylelint'),
262 input_api.os_path.join(input_api.PresubmitLocalPath(),
263 '.stylelintrc.json'),
264 input_api.os_path.join(input_api.PresubmitLocalPath(),
265 '.stylelintignore'),
266 input_api.os_path.join(scripts_directory, 'test',
Sigurd Schneider6523c512021-02-12 10:44:28 +0100267 'run_lint_check_css.js'),
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200268 ]
269
270 lint_config_files = _getAffectedFiles(input_api, stylelint_related_files,
Sigurd Schneider6523c512021-02-12 10:44:28 +0100271 [], [])
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200272
Sigurd Schneidere3bf6c22021-02-11 15:35:23 +0100273 css_should_bail_out, css_files_to_lint = _getFilesToLint(
Mathias Bynens0ec56612020-06-19 09:14:03 +0200274 input_api, output_api, lint_config_files, default_linted_directories,
275 ['.css'], results)
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200276
Sigurd Schneidere3bf6c22021-02-11 15:35:23 +0100277 ts_should_bail_out, ts_files_to_lint = _getFilesToLint(
278 input_api, output_api, lint_config_files, default_linted_directories,
279 ['.ts'], results)
280
Sigurd Schneiderf3a1ecd2021-03-02 15:46:03 +0100281 # If there are more than 50 files to check, don't bother and check
282 # everything, so as to not run into command line length limits on Windows.
283 if not css_should_bail_out:
284 if len(css_files_to_lint) < 50:
285 script_args = ["--files"] + css_files_to_lint
286 else:
287 script_args = [] # The defaults check all CSS files.
288 results.extend(
289 _checkWithNodeScript(input_api, output_api, lint_path,
290 script_args))
291
Sigurd Schneidere3bf6c22021-02-11 15:35:23 +0100292 if not ts_should_bail_out:
Sigurd Schneiderf3a1ecd2021-03-02 15:46:03 +0100293 script_args = ["--syntax", "html"]
294 if len(ts_files_to_lint) < 50:
295 script_args += ["--files"] + ts_files_to_lint
296 else:
297 script_args += ["--glob", "front_end/**/*.ts"]
Sigurd Schneidere3bf6c22021-02-11 15:35:23 +0100298 results.extend(
299 _checkWithNodeScript(input_api, output_api, lint_path,
300 script_args))
301
Jack Franklinbc302342021-01-18 10:03:30 +0000302 return results
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200303
304
Jack Franklin13812f62021-02-01 15:51:12 +0000305def _CheckDarkModeStyleSheetsUpToDate(input_api, output_api):
306 devtools_root = input_api.PresubmitLocalPath()
307 devtools_front_end = input_api.os_path.join(devtools_root, 'front_end')
Jack Franklina5840542021-04-08 14:10:15 +0000308 dark_mode_scripts_folder = input_api.os_path.join(devtools_root, 'scripts',
309 'dark_mode')
310 dark_mode_script_files = _getAffectedFiles(input_api,
311 dark_mode_scripts_folder, [],
312 ['.js'])
313 script_arguments = []
314 if len(dark_mode_script_files) > 0:
315 # If the scripts have changed, we should check all darkmode files as they may need to be updated.
316 script_arguments += ['--check-all-files']
317 else:
318 affected_css_files = _getAffectedFiles(input_api, [devtools_front_end],
319 [], ['.css'])
320 script_arguments += affected_css_files
321
Jack Franklin13812f62021-02-01 15:51:12 +0000322 results = [output_api.PresubmitNotifyResult('Dark Mode CSS check:')]
323 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
324 'scripts', 'dark_mode',
325 'check_darkmode_css_up_to_date.js')
326 results.extend(
327 _checkWithNodeScript(input_api, output_api, script_path,
Jack Franklina5840542021-04-08 14:10:15 +0000328 script_arguments))
Jack Franklin13812f62021-02-01 15:51:12 +0000329 return results
330
331
Joel Einbinderf6f86b62019-06-10 23:19:12 +0000332def _CheckOptimizeSVGHashes(input_api, output_api):
Tim van der Lippefb023462020-08-21 14:10:06 +0100333 if not input_api.platform.startswith('linux'):
334 return [output_api.PresubmitNotifyResult('Skipping SVG hash check')]
335
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200336 results = [
337 output_api.PresubmitNotifyResult('Running SVG optimization check:')
338 ]
Blink Reformat4c46d092018-04-07 15:32:37 +0000339
340 original_sys_path = sys.path
341 try:
342 sys.path = sys.path + [input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'build')]
343 import devtools_file_hashes
344 finally:
345 sys.path = original_sys_path
346
347 absolute_local_paths = [af.AbsoluteLocalPath() for af in input_api.AffectedFiles(include_deletes=False)]
Yang Guo75beda92019-10-28 08:29:25 +0100348 images_src_path = input_api.os_path.join('devtools', 'front_end', 'Images', 'src')
349 image_source_file_paths = [path for path in absolute_local_paths if images_src_path in path and path.endswith('.svg')]
350 image_sources_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end', 'Images', 'src')
351 hashes_file_name = 'optimize_svg.hashes'
Blink Reformat4c46d092018-04-07 15:32:37 +0000352 hashes_file_path = input_api.os_path.join(image_sources_path, hashes_file_name)
353 invalid_hash_file_paths = devtools_file_hashes.files_with_invalid_hashes(hashes_file_path, image_source_file_paths)
354 if len(invalid_hash_file_paths) == 0:
Brandon Goddarde7028672020-01-30 09:31:04 -0800355 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000356 invalid_hash_file_names = [input_api.os_path.basename(file_path) for file_path in invalid_hash_file_paths]
Yang Guo75beda92019-10-28 08:29:25 +0100357 file_paths_str = ', '.join(invalid_hash_file_names)
358 error_message = 'The following SVG files should be optimized using optimize_svg_images script before uploading: \n - %s' % file_paths_str
Brandon Goddarde7028672020-01-30 09:31:04 -0800359 results.append(output_api.PresubmitError(error_message))
360 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000361
362
Mathias Bynens032591d2019-10-21 11:51:31 +0200363
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000364def _CheckGeneratedFiles(input_api, output_api):
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000365 v8_directory_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'v8')
366 blink_directory_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party', 'blink')
367 protocol_location = input_api.os_path.join(blink_directory_path, 'public', 'devtools_protocol')
368 scripts_build_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'build')
Tim van der Lippe5d2d79b2020-03-23 11:45:04 +0000369 scripts_generated_output_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end', 'generated')
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000370
371 generated_aria_path = input_api.os_path.join(scripts_build_path, 'generate_aria.py')
372 generated_supported_css_path = input_api.os_path.join(scripts_build_path, 'generate_supported_css.py')
373 generated_protocol_path = input_api.os_path.join(scripts_build_path, 'code_generator_frontend.py')
374 concatenate_protocols_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party', 'inspector_protocol',
375 'concatenate_protocols.py')
376
377 affected_files = _getAffectedFiles(input_api, [
378 v8_directory_path,
379 blink_directory_path,
380 input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party', 'pyjson5'),
381 generated_aria_path,
382 generated_supported_css_path,
383 concatenate_protocols_path,
384 generated_protocol_path,
Tim van der Lippe5d2d79b2020-03-23 11:45:04 +0000385 scripts_generated_output_path,
386 ], [], ['.pdl', '.json5', '.py', '.js'])
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000387
388 if len(affected_files) == 0:
Tim van der Lippefb023462020-08-21 14:10:06 +0100389 return [
390 output_api.PresubmitNotifyResult(
391 'No affected files for generated files check')
392 ]
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000393
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000394 results = [output_api.PresubmitNotifyResult('Running Generated Files Check:')]
Tim van der Lippeb0d65f12020-03-05 12:15:24 +0000395 generate_protocol_resources_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'deps',
396 'generate_protocol_resources.py')
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000397
Tim van der Lippeb0d65f12020-03-05 12:15:24 +0000398 return _ExecuteSubProcess(input_api, output_api, generate_protocol_resources_path, [], results)
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000399
400
Christy Chen2d6d9a62020-09-22 09:04:09 -0700401def _CollectStrings(input_api, output_api):
402 devtools_root = input_api.PresubmitLocalPath()
403 devtools_front_end = input_api.os_path.join(devtools_root, 'front_end')
404 affected_front_end_files = _getAffectedFiles(input_api,
Peter Marshall1d952dc2021-02-10 13:49:32 +0100405 [devtools_front_end], [],
Tim van der Lippec50df852021-01-19 15:15:52 +0000406 ['.js', '.ts'])
Christy Chen2d6d9a62020-09-22 09:04:09 -0700407 if len(affected_front_end_files) == 0:
408 return [
409 output_api.PresubmitNotifyResult(
410 'No affected files to run collect-strings')
411 ]
412
413 results = [
414 output_api.PresubmitNotifyResult('Collecting strings from front_end:')
415 ]
416 script_path = input_api.os_path.join(devtools_root, 'third_party', 'i18n',
417 'collect-strings.js')
418 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
419 results.append(
420 output_api.PresubmitNotifyResult(
Peter Marshalld67e9f12021-02-08 10:34:35 +0100421 'Please commit en-US.json/en-XL.json if changes are generated.'))
Christy Chen2d6d9a62020-09-22 09:04:09 -0700422 return results
423
424
Tim van der Lippe5279f842020-01-14 16:26:38 +0000425def _CheckNoUncheckedFiles(input_api, output_api):
426 results = []
427 process = input_api.subprocess.Popen(['git', 'diff', '--exit-code'],
428 stdout=input_api.subprocess.PIPE,
429 stderr=input_api.subprocess.STDOUT)
430 out, _ = process.communicate()
431 if process.returncode != 0:
Jack Franklin324f3042020-09-03 11:28:29 +0100432 files_changed_process = input_api.subprocess.Popen(
433 ['git', 'diff', '--name-only'],
434 stdout=input_api.subprocess.PIPE,
435 stderr=input_api.subprocess.STDOUT)
Tim van der Lippe9bb1cf62020-03-06 16:17:02 +0000436 files_changed, _ = files_changed_process.communicate()
437
438 return [
439 output_api.PresubmitError('You have changed files that need to be committed:'),
440 output_api.PresubmitError(files_changed)
441 ]
Tim van der Lippe5279f842020-01-14 16:26:38 +0000442 return []
443
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000444def _CheckForTooLargeFiles(input_api, output_api):
Christy Chen1ab87e02020-01-30 16:32:16 -0800445 """Avoid large files, especially binary files, in the repository since
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000446 git doesn't scale well for those. They will be in everyone's repo
447 clones forever, forever making Chromium slower to clone and work
448 with."""
Christy Chen1ab87e02020-01-30 16:32:16 -0800449 # Uploading files to cloud storage is not trivial so we don't want
450 # to set the limit too low, but the upper limit for "normal" large
451 # files seems to be 1-2 MB, with a handful around 5-8 MB, so
452 # anything over 20 MB is exceptional.
453 TOO_LARGE_FILE_SIZE_LIMIT = 20 * 1024 * 1024 # 10 MB
454 too_large_files = []
455 for f in input_api.AffectedFiles():
456 # Check both added and modified files (but not deleted files).
457 if f.Action() in ('A', 'M'):
458 size = input_api.os_path.getsize(f.AbsoluteLocalPath())
459 if size > TOO_LARGE_FILE_SIZE_LIMIT:
460 too_large_files.append("%s: %d bytes" % (f.LocalPath(), size))
461 if too_large_files:
462 message = (
463 'Do not commit large files to git since git scales badly for those.\n' +
464 'Instead put the large files in cloud storage and use DEPS to\n' +
465 'fetch them.\n' + '\n'.join(too_large_files)
466 )
467 return [output_api.PresubmitError(
468 'Too large files found in commit', long_text=message + '\n')]
469 else:
470 return []
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000471
Tim van der Lippe5279f842020-01-14 16:26:38 +0000472
Tim van der Lippef8a87092020-09-14 13:01:18 +0100473def _RunCannedChecks(input_api, output_api):
474 results = []
475 results.extend(
476 input_api.canned_checks.CheckOwnersFormat(input_api, output_api))
477 results.extend(input_api.canned_checks.CheckOwners(input_api, output_api))
478 results.extend(
479 input_api.canned_checks.CheckChangeHasNoCrAndHasOnlyOneEol(
480 input_api, output_api))
481 results.extend(
482 input_api.canned_checks.CheckChangeHasNoStrayWhitespace(
483 input_api, output_api))
484 results.extend(
485 input_api.canned_checks.CheckGenderNeutral(input_api, output_api))
486 return results
487
488
Yang Guo4fd355c2019-09-19 10:59:03 +0200489def _CommonChecks(input_api, output_api):
Mathias Bynens032591d2019-10-21 11:51:31 +0200490 """Checks common to both upload and commit."""
491 results = []
Mathias Bynens011b0072020-08-05 10:17:35 +0200492 results.extend(
493 input_api.canned_checks.CheckAuthorizedAuthor(
494 input_api, output_api, bot_allowlist=[AUTOROLL_ACCOUNT]))
Blink Reformat4c46d092018-04-07 15:32:37 +0000495 results.extend(_CheckBuildGN(input_api, output_api))
Brandon Goddard33104372020-08-13 08:49:23 -0700496 results.extend(_CheckExperimentTelemetry(input_api, output_api))
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000497 results.extend(_CheckGeneratedFiles(input_api, output_api))
Tim van der Lippee4bdd742019-12-17 16:40:16 +0100498 results.extend(_CheckJSON(input_api, output_api))
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200499 results.extend(_CheckDevToolsStyleJS(input_api, output_api))
500 results.extend(_CheckDevToolsStyleCSS(input_api, output_api))
Jack Franklinb10193f2021-03-19 10:25:08 +0000501
Jack Franklind34cf332021-03-24 10:27:20 +0000502 results.extend(_CheckDarkModeStyleSheetsUpToDate(input_api, output_api))
Tim van der Lippe5497d482020-01-14 15:27:30 +0000503 results.extend(_CheckFormat(input_api, output_api))
Joel Einbinderf6f86b62019-06-10 23:19:12 +0000504 results.extend(_CheckOptimizeSVGHashes(input_api, output_api))
Yang Guoa7845d52019-10-31 11:30:23 +0100505 results.extend(_CheckChangesAreExclusiveToDirectory(input_api, output_api))
Peter Marshallcd845512021-01-28 15:29:21 +0100506 results.extend(_CheckI18nWasBundled(input_api, output_api))
Tim van der Lippef8a87092020-09-14 13:01:18 +0100507 # Run the canned checks from `depot_tools` after the custom DevTools checks.
508 # The canned checks for example check that lines have line endings. The
509 # DevTools presubmit checks automatically fix these issues. If we would run
510 # the canned checks before the DevTools checks, they would erroneously conclude
511 # that there are issues in the code. Since the canned checks are allowed to be
512 # ignored, a confusing message is shown that asks if the failed presubmit can
513 # be continued regardless. By fixing the issues before we reach the canned checks,
514 # we don't show the message to suppress these errors, which would otherwise be
515 # causing CQ to fail.
516 results.extend(_RunCannedChecks(input_api, output_api))
Kalon Hindsd44fddf2020-12-10 05:43:25 -0800517 return results
518
519
520def _SideEffectChecks(input_api, output_api):
521 """Check side effects caused by other checks"""
522 results = []
Tim van der Lippe5279f842020-01-14 16:26:38 +0000523 results.extend(_CheckNoUncheckedFiles(input_api, output_api))
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000524 results.extend(_CheckForTooLargeFiles(input_api, output_api))
Blink Reformat4c46d092018-04-07 15:32:37 +0000525 return results
526
527
Liviu Raud614e092020-01-08 10:56:33 +0100528def CheckChangeOnUpload(input_api, output_api):
529 results = []
530 results.extend(_CommonChecks(input_api, output_api))
Christy Chen2d6d9a62020-09-22 09:04:09 -0700531 results.extend(_CollectStrings(input_api, output_api))
Kalon Hindsd44fddf2020-12-10 05:43:25 -0800532 # Run checks that rely on output from other DevTool checks
533 results.extend(_SideEffectChecks(input_api, output_api))
Sigurd Schneider5c9b4f92021-01-22 11:09:55 +0100534 results.extend(_CheckBugAssociation(input_api, output_api, False))
Liviu Raud614e092020-01-08 10:56:33 +0100535 return results
536
537
Blink Reformat4c46d092018-04-07 15:32:37 +0000538def CheckChangeOnCommit(input_api, output_api):
Mandy Chenf0fbdbe2019-08-22 23:58:37 +0000539 results = []
Yang Guo4fd355c2019-09-19 10:59:03 +0200540 results.extend(_CommonChecks(input_api, output_api))
Christy Chen2d6d9a62020-09-22 09:04:09 -0700541 results.extend(_CollectStrings(input_api, output_api))
Kalon Hindsd44fddf2020-12-10 05:43:25 -0800542 # Run checks that rely on output from other DevTool checks
543 results.extend(_SideEffectChecks(input_api, output_api))
Mathias Bynens032591d2019-10-21 11:51:31 +0200544 results.extend(input_api.canned_checks.CheckChangeHasDescription(input_api, output_api))
Sigurd Schneider5c9b4f92021-01-22 11:09:55 +0100545 results.extend(_CheckBugAssociation(input_api, output_api, True))
Mandy Chenf0fbdbe2019-08-22 23:58:37 +0000546 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000547
548
Mandy Chena6be46a2019-07-09 17:06:27 +0000549def _getAffectedFiles(input_api, parent_directories, excluded_actions, accepted_endings): # pylint: disable=invalid-name
Yang Guo75beda92019-10-28 08:29:25 +0100550 """Return absolute file paths of affected files (not due to an excluded action)
Mandy Chena6be46a2019-07-09 17:06:27 +0000551 under a parent directory with an accepted file ending.
Yang Guo75beda92019-10-28 08:29:25 +0100552 """
Mandy Chena6be46a2019-07-09 17:06:27 +0000553 local_paths = [
554 f.AbsoluteLocalPath() for f in input_api.AffectedFiles() if all(f.Action() != action for action in excluded_actions)
555 ]
556 affected_files = [
Tim van der Lippefdbd42e2020-04-07 15:14:36 +0100557 file_name for file_name in local_paths if any(parent_directory in file_name for parent_directory in parent_directories) and
558 (len(accepted_endings) is 0 or any(file_name.endswith(accepted_ending) for accepted_ending in accepted_endings))
Mandy Chena6be46a2019-07-09 17:06:27 +0000559 ]
560 return affected_files
561
562
Tim van der Lippec4617122020-03-06 16:24:19 +0000563def _checkWithNodeScript(input_api, output_api, script_path, script_arguments=[]): # pylint: disable=invalid-name
Blink Reformat4c46d092018-04-07 15:32:37 +0000564 original_sys_path = sys.path
565 try:
Yang Guo75beda92019-10-28 08:29:25 +0100566 sys.path = sys.path + [input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')]
Yang Guod8176982019-10-04 20:30:35 +0000567 import devtools_paths
Blink Reformat4c46d092018-04-07 15:32:37 +0000568 finally:
569 sys.path = original_sys_path
570
Tim van der Lippec4617122020-03-06 16:24:19 +0000571 return _ExecuteSubProcess(input_api, output_api, [devtools_paths.node_path(), script_path], script_arguments, [])
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200572
573
Jack Franklin324f3042020-09-03 11:28:29 +0100574def _checkWithTypeScript(input_api,
575 output_api,
576 tsc_arguments,
577 script_path,
578 script_arguments=[]): # pylint: disable=invalid-name
579 original_sys_path = sys.path
580 try:
581 sys.path = sys.path + [
582 input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')
583 ]
584 import devtools_paths
585 finally:
586 sys.path = original_sys_path
587
588 # First run tsc to compile the TS script that we then run in the _ExecuteSubProcess call
589 tsc_compiler_process = input_api.subprocess.Popen(
590 [
591 devtools_paths.node_path(),
592 devtools_paths.typescript_compiler_path()
593 ] + tsc_arguments,
594 stdout=input_api.subprocess.PIPE,
595 stderr=input_api.subprocess.STDOUT)
596
597 out, _ = tsc_compiler_process.communicate()
598 if tsc_compiler_process.returncode != 0:
599 return [
600 output_api.PresubmitError('Error compiling briges regenerator:\n' +
601 str(out))
602 ]
603
604 return _checkWithNodeScript(input_api, output_api, script_path,
605 script_arguments)
606
607
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200608def _getFilesToLint(input_api, output_api, lint_config_files,
609 default_linted_directories, accepted_endings, results):
Mathias Bynens0ec56612020-06-19 09:14:03 +0200610 run_full_check = False
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200611 files_to_lint = []
612
613 # We are changing the lint configuration; run the full check.
614 if len(lint_config_files) is not 0:
615 results.append(
616 output_api.PresubmitNotifyResult('Running full lint check'))
Mathias Bynens0ec56612020-06-19 09:14:03 +0200617 run_full_check = True
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200618 else:
619 # Only run the linter on files that are relevant, to save PRESUBMIT time.
620 files_to_lint = _getAffectedFiles(input_api,
621 default_linted_directories, ['D'],
622 accepted_endings)
623
Paul Lewis2b9224f2020-09-08 18:13:10 +0100624 # Exclude front_end/third_party files.
625 files_to_lint = filter(lambda path: "third_party" not in path,
626 files_to_lint)
627
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200628 if len(files_to_lint) is 0:
629 results.append(
630 output_api.PresubmitNotifyResult(
631 'No affected files for lint check'))
632
Mathias Bynens0ec56612020-06-19 09:14:03 +0200633 should_bail_out = len(files_to_lint) is 0 and not run_full_check
634 return should_bail_out, files_to_lint
Peter Marshallcd845512021-01-28 15:29:21 +0100635
636
637def _CheckI18nWasBundled(input_api, output_api):
638 affected_files = _getAffectedFiles(input_api, [
639 input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end',
640 'third_party', 'i18n', 'lib')
641 ], [], ['.js'])
642
643 if len(affected_files) == 0:
644 return [
645 output_api.PresubmitNotifyResult(
646 'No affected files for i18n bundle check')
647 ]
648
649 results = [output_api.PresubmitNotifyResult('Running buildi18nBundle.js:')]
650 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
651 'scripts', 'localizationV2',
652 'buildi18nBundle.js')
653 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
654 return results