blob: d6b20d100f892de662dfe26c1e08796f017628a1 [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 = [
Tim van der Lippe90b9cac2021-04-12 12:21:42 +010040 ['third_party', 'v8', 'front_end/generated'],
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:
Tim van der Lippe239963b2021-04-09 10:43:38 +0100100 unexpected_files = [
101 file for file in affected_files if file not in affected_in_dir
102 ]
103 results.append(
104 output_api.PresubmitError(
105 ('CLs that affect files in "%s" should be limited to these files/directories.'
106 % dir_list) +
107 ('\nUnexpected files: %s.' % unexpected_files) +
108 '\nYou can disable this check by adding DISABLE_THIRD_PARTY_CHECK=<reason> to your commit message'
109 ))
Brandon Goddarde7028672020-01-30 09:31:04 -0800110 break
111
112 return results
Yang Guoa7845d52019-10-31 11:30:23 +0100113
Blink Reformat4c46d092018-04-07 15:32:37 +0000114
Sigurd Schneider5c9b4f92021-01-22 11:09:55 +0100115def _CheckBugAssociation(input_api, output_api, is_committing):
116 results = [output_api.PresubmitNotifyResult('Bug Association Check:')]
117 bugs = input_api.change.BugsFromDescription()
118 message = (
119 "Each CL should be associated with a bug, use \'Bug:\' or \'Fixed:\' lines in\n"
120 "the footer of the commit description. If you explicitly don\'t want to\n"
121 "set a bug, use \'Bug: none\' in the footer of the commit description.\n\n"
122 "Note: The footer of the commit description is the last block of lines in\n"
123 "the commit description that doesn't contain empty lines. This means that\n"
124 "any \'Bug:\' or \'Fixed:\' lines that are eventually followed by an empty\n"
125 "line are not detected by this presubmit check.")
126
127 if not bugs:
128 if is_committing:
129 results.append(output_api.PresubmitError(message))
130 else:
131 results.append(output_api.PresubmitNotifyResult(message))
132
133 for bug in bugs:
134 results.append(output_api.PresubmitNotifyResult(('%s') % bug))
135
136 return results
137
138
Blink Reformat4c46d092018-04-07 15:32:37 +0000139def _CheckBuildGN(input_api, output_api):
Brandon Goddarde7028672020-01-30 09:31:04 -0800140 results = [output_api.PresubmitNotifyResult('Running BUILD.GN check:')]
Sigurd Schneiderf3a1ecd2021-03-02 15:46:03 +0100141 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
142 'scripts', 'check_gn.js')
Brandon Goddarde7028672020-01-30 09:31:04 -0800143 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
144 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000145
146
Brandon Goddard33104372020-08-13 08:49:23 -0700147def _CheckExperimentTelemetry(input_api, output_api):
Brandon Goddard33104372020-08-13 08:49:23 -0700148 experiment_telemetry_files = [
149 input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end',
Jan Schefflerb4eb22d2021-04-05 22:38:36 +0200150 'main', 'MainImpl.ts'),
Brandon Goddard33104372020-08-13 08:49:23 -0700151 input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end',
Tim van der Lippee0247312021-04-01 15:25:30 +0100152 'core', 'host', 'UserMetrics.ts')
Brandon Goddard33104372020-08-13 08:49:23 -0700153 ]
154 affected_main_files = _getAffectedFiles(input_api,
155 experiment_telemetry_files, [],
156 ['.js'])
157 if len(affected_main_files) == 0:
Tim van der Lippefb023462020-08-21 14:10:06 +0100158 return [
159 output_api.PresubmitNotifyResult(
160 'No affected files for telemetry check')
161 ]
Brandon Goddard33104372020-08-13 08:49:23 -0700162
Tim van der Lippefb023462020-08-21 14:10:06 +0100163 results = [
164 output_api.PresubmitNotifyResult('Running Experiment Telemetry check:')
165 ]
Brandon Goddard33104372020-08-13 08:49:23 -0700166 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
167 'scripts', 'check_experiments.js')
168 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
169 return results
170
171
Tim van der Lippee4bdd742019-12-17 16:40:16 +0100172def _CheckJSON(input_api, output_api):
Brandon Goddarde7028672020-01-30 09:31:04 -0800173 results = [output_api.PresubmitNotifyResult('Running JSON Validator:')]
Sigurd Schneiderf3a1ecd2021-03-02 15:46:03 +0100174 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
175 'scripts', 'json_validator',
176 'validate_module_json.js')
Brandon Goddarde7028672020-01-30 09:31:04 -0800177 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
178 return results
Tim van der Lippee4bdd742019-12-17 16:40:16 +0100179
180
Blink Reformat4c46d092018-04-07 15:32:37 +0000181def _CheckFormat(input_api, output_api):
Sigurd Schneiderf3a1ecd2021-03-02 15:46:03 +0100182 node_modules_affected_files = _getAffectedFiles(input_api, [
183 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules')
184 ], [], [])
Tim van der Lippefdbd42e2020-04-07 15:14:36 +0100185
186 # TODO(crbug.com/1068198): Remove once `git cl format --js` can handle large CLs.
187 if (len(node_modules_affected_files) > 0):
188 return [output_api.PresubmitNotifyResult('Skipping Format Checks because `node_modules` files are affected.')]
189
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
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200194def _CheckDevToolsStyleJS(input_api, output_api):
Tim van der Lippefb023462020-08-21 14:10:06 +0100195 results = [output_api.PresubmitNotifyResult('JS style check:')]
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200196 lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
197 'scripts', 'test',
198 'run_lint_check_js.js')
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000199
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200200 front_end_directory = input_api.os_path.join(
201 input_api.PresubmitLocalPath(), 'front_end')
Jack Franklinbcfd6ad2021-02-17 10:12:50 +0000202 component_docs_directory = input_api.os_path.join(front_end_directory,
203 'component_docs')
Alex Rudenko5556a902020-09-29 09:37:23 +0000204 inspector_overlay_directory = input_api.os_path.join(
205 input_api.PresubmitLocalPath(), 'inspector_overlay')
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200206 test_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
207 'test')
208 scripts_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
209 'scripts')
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000210
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200211 default_linted_directories = [
Alex Rudenko5556a902020-09-29 09:37:23 +0000212 front_end_directory, test_directory, scripts_directory,
213 inspector_overlay_directory
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200214 ]
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000215
216 eslint_related_files = [
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200217 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules',
218 'eslint'),
Tim van der Lippecf4ab402021-02-12 14:30:58 +0000219 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules',
220 '@typescript-eslint'),
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000221 input_api.os_path.join(input_api.PresubmitLocalPath(), '.eslintrc.js'),
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200222 input_api.os_path.join(input_api.PresubmitLocalPath(),
223 '.eslintignore'),
Tim van der Lippe33543ac2020-12-14 15:37:45 +0100224 input_api.os_path.join(front_end_directory, '.eslintrc.js'),
Jack Franklinbcfd6ad2021-02-17 10:12:50 +0000225 input_api.os_path.join(component_docs_directory, '.eslintrc.js'),
Tim van der Lippe406249f2020-12-14 15:59:10 +0100226 input_api.os_path.join(test_directory, '.eslintrc.js'),
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200227 input_api.os_path.join(scripts_directory, 'test',
228 'run_lint_check_js.py'),
229 input_api.os_path.join(scripts_directory, 'test',
230 'run_lint_check_js.js'),
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000231 input_api.os_path.join(scripts_directory, '.eslintrc.js'),
232 input_api.os_path.join(scripts_directory, 'eslint_rules'),
233 ]
234
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200235 lint_config_files = _getAffectedFiles(input_api, eslint_related_files, [],
236 ['.js', '.py', '.eslintignore'])
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000237
Mathias Bynens0ec56612020-06-19 09:14:03 +0200238 should_bail_out, files_to_lint = _getFilesToLint(
239 input_api, output_api, lint_config_files, default_linted_directories,
240 ['.js', '.ts'], results)
241 if should_bail_out:
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200242 return results
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000243
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200244 results.extend(
245 _checkWithNodeScript(input_api, output_api, lint_path, files_to_lint))
Tim van der Lippe98132242020-04-14 17:16:54 +0100246 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000247
248
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200249def _CheckDevToolsStyleCSS(input_api, output_api):
Tim van der Lippefb023462020-08-21 14:10:06 +0100250 results = [output_api.PresubmitNotifyResult('CSS style check:')]
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200251 lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
252 'scripts', 'test',
Jack Franklinbc302342021-01-18 10:03:30 +0000253 'run_lint_check_css.js')
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200254
255 front_end_directory = input_api.os_path.join(
256 input_api.PresubmitLocalPath(), 'front_end')
Alex Rudenko5556a902020-09-29 09:37:23 +0000257 inspector_overlay_directory = input_api.os_path.join(
258 input_api.PresubmitLocalPath(), 'inspector_overlay')
259 default_linted_directories = [
260 front_end_directory, inspector_overlay_directory
261 ]
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200262
263 scripts_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
264 'scripts')
265
266 stylelint_related_files = [
267 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules',
268 'stylelint'),
269 input_api.os_path.join(input_api.PresubmitLocalPath(),
270 '.stylelintrc.json'),
271 input_api.os_path.join(input_api.PresubmitLocalPath(),
272 '.stylelintignore'),
273 input_api.os_path.join(scripts_directory, 'test',
Sigurd Schneider6523c512021-02-12 10:44:28 +0100274 'run_lint_check_css.js'),
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200275 ]
276
277 lint_config_files = _getAffectedFiles(input_api, stylelint_related_files,
Sigurd Schneider6523c512021-02-12 10:44:28 +0100278 [], [])
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200279
Sigurd Schneidere3bf6c22021-02-11 15:35:23 +0100280 css_should_bail_out, css_files_to_lint = _getFilesToLint(
Mathias Bynens0ec56612020-06-19 09:14:03 +0200281 input_api, output_api, lint_config_files, default_linted_directories,
282 ['.css'], results)
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200283
Sigurd Schneidere3bf6c22021-02-11 15:35:23 +0100284 ts_should_bail_out, ts_files_to_lint = _getFilesToLint(
285 input_api, output_api, lint_config_files, default_linted_directories,
286 ['.ts'], results)
287
Sigurd Schneiderf3a1ecd2021-03-02 15:46:03 +0100288 # If there are more than 50 files to check, don't bother and check
289 # everything, so as to not run into command line length limits on Windows.
290 if not css_should_bail_out:
291 if len(css_files_to_lint) < 50:
292 script_args = ["--files"] + css_files_to_lint
293 else:
294 script_args = [] # The defaults check all CSS files.
295 results.extend(
296 _checkWithNodeScript(input_api, output_api, lint_path,
297 script_args))
298
Sigurd Schneidere3bf6c22021-02-11 15:35:23 +0100299 if not ts_should_bail_out:
Sigurd Schneiderf3a1ecd2021-03-02 15:46:03 +0100300 script_args = ["--syntax", "html"]
301 if len(ts_files_to_lint) < 50:
302 script_args += ["--files"] + ts_files_to_lint
303 else:
304 script_args += ["--glob", "front_end/**/*.ts"]
Sigurd Schneidere3bf6c22021-02-11 15:35:23 +0100305 results.extend(
306 _checkWithNodeScript(input_api, output_api, lint_path,
307 script_args))
308
Jack Franklinbc302342021-01-18 10:03:30 +0000309 return results
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200310
311
Jack Franklin13812f62021-02-01 15:51:12 +0000312def _CheckDarkModeStyleSheetsUpToDate(input_api, output_api):
313 devtools_root = input_api.PresubmitLocalPath()
314 devtools_front_end = input_api.os_path.join(devtools_root, 'front_end')
Jack Franklina5840542021-04-08 14:10:15 +0000315 dark_mode_scripts_folder = input_api.os_path.join(devtools_root, 'scripts',
316 'dark_mode')
317 dark_mode_script_files = _getAffectedFiles(input_api,
318 dark_mode_scripts_folder, [],
319 ['.js'])
320 script_arguments = []
321 if len(dark_mode_script_files) > 0:
322 # If the scripts have changed, we should check all darkmode files as they may need to be updated.
323 script_arguments += ['--check-all-files']
324 else:
325 affected_css_files = _getAffectedFiles(input_api, [devtools_front_end],
326 [], ['.css'])
327 script_arguments += affected_css_files
328
Jack Franklin13812f62021-02-01 15:51:12 +0000329 results = [output_api.PresubmitNotifyResult('Dark Mode CSS check:')]
330 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
331 'scripts', 'dark_mode',
332 'check_darkmode_css_up_to_date.js')
333 results.extend(
334 _checkWithNodeScript(input_api, output_api, script_path,
Jack Franklina5840542021-04-08 14:10:15 +0000335 script_arguments))
Jack Franklin13812f62021-02-01 15:51:12 +0000336 return results
337
338
Joel Einbinderf6f86b62019-06-10 23:19:12 +0000339def _CheckOptimizeSVGHashes(input_api, output_api):
Tim van der Lippefb023462020-08-21 14:10:06 +0100340 if not input_api.platform.startswith('linux'):
341 return [output_api.PresubmitNotifyResult('Skipping SVG hash check')]
342
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200343 results = [
344 output_api.PresubmitNotifyResult('Running SVG optimization check:')
345 ]
Blink Reformat4c46d092018-04-07 15:32:37 +0000346
347 original_sys_path = sys.path
348 try:
349 sys.path = sys.path + [input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'build')]
350 import devtools_file_hashes
351 finally:
352 sys.path = original_sys_path
353
354 absolute_local_paths = [af.AbsoluteLocalPath() for af in input_api.AffectedFiles(include_deletes=False)]
Yang Guo75beda92019-10-28 08:29:25 +0100355 images_src_path = input_api.os_path.join('devtools', 'front_end', 'Images', 'src')
356 image_source_file_paths = [path for path in absolute_local_paths if images_src_path in path and path.endswith('.svg')]
357 image_sources_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end', 'Images', 'src')
358 hashes_file_name = 'optimize_svg.hashes'
Blink Reformat4c46d092018-04-07 15:32:37 +0000359 hashes_file_path = input_api.os_path.join(image_sources_path, hashes_file_name)
360 invalid_hash_file_paths = devtools_file_hashes.files_with_invalid_hashes(hashes_file_path, image_source_file_paths)
361 if len(invalid_hash_file_paths) == 0:
Brandon Goddarde7028672020-01-30 09:31:04 -0800362 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000363 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 +0100364 file_paths_str = ', '.join(invalid_hash_file_names)
365 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 -0800366 results.append(output_api.PresubmitError(error_message))
367 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000368
369
Mathias Bynens032591d2019-10-21 11:51:31 +0200370
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000371def _CheckGeneratedFiles(input_api, output_api):
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000372 v8_directory_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'v8')
373 blink_directory_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party', 'blink')
374 protocol_location = input_api.os_path.join(blink_directory_path, 'public', 'devtools_protocol')
375 scripts_build_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'build')
Tim van der Lippe5d2d79b2020-03-23 11:45:04 +0000376 scripts_generated_output_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end', 'generated')
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000377
378 generated_aria_path = input_api.os_path.join(scripts_build_path, 'generate_aria.py')
379 generated_supported_css_path = input_api.os_path.join(scripts_build_path, 'generate_supported_css.py')
380 generated_protocol_path = input_api.os_path.join(scripts_build_path, 'code_generator_frontend.py')
381 concatenate_protocols_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party', 'inspector_protocol',
382 'concatenate_protocols.py')
383
384 affected_files = _getAffectedFiles(input_api, [
385 v8_directory_path,
386 blink_directory_path,
387 input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party', 'pyjson5'),
388 generated_aria_path,
389 generated_supported_css_path,
390 concatenate_protocols_path,
391 generated_protocol_path,
Tim van der Lippe5d2d79b2020-03-23 11:45:04 +0000392 scripts_generated_output_path,
393 ], [], ['.pdl', '.json5', '.py', '.js'])
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000394
395 if len(affected_files) == 0:
Tim van der Lippefb023462020-08-21 14:10:06 +0100396 return [
397 output_api.PresubmitNotifyResult(
398 'No affected files for generated files check')
399 ]
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000400
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000401 results = [output_api.PresubmitNotifyResult('Running Generated Files Check:')]
Tim van der Lippeb0d65f12020-03-05 12:15:24 +0000402 generate_protocol_resources_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'deps',
403 'generate_protocol_resources.py')
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000404
Tim van der Lippeb0d65f12020-03-05 12:15:24 +0000405 return _ExecuteSubProcess(input_api, output_api, generate_protocol_resources_path, [], results)
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000406
407
Christy Chen2d6d9a62020-09-22 09:04:09 -0700408def _CollectStrings(input_api, output_api):
409 devtools_root = input_api.PresubmitLocalPath()
410 devtools_front_end = input_api.os_path.join(devtools_root, 'front_end')
411 affected_front_end_files = _getAffectedFiles(input_api,
Peter Marshall1d952dc2021-02-10 13:49:32 +0100412 [devtools_front_end], [],
Tim van der Lippec50df852021-01-19 15:15:52 +0000413 ['.js', '.ts'])
Christy Chen2d6d9a62020-09-22 09:04:09 -0700414 if len(affected_front_end_files) == 0:
415 return [
416 output_api.PresubmitNotifyResult(
417 'No affected files to run collect-strings')
418 ]
419
420 results = [
421 output_api.PresubmitNotifyResult('Collecting strings from front_end:')
422 ]
423 script_path = input_api.os_path.join(devtools_root, 'third_party', 'i18n',
424 'collect-strings.js')
425 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
426 results.append(
427 output_api.PresubmitNotifyResult(
Peter Marshalld67e9f12021-02-08 10:34:35 +0100428 'Please commit en-US.json/en-XL.json if changes are generated.'))
Christy Chen2d6d9a62020-09-22 09:04:09 -0700429 return results
430
431
Tim van der Lippe5279f842020-01-14 16:26:38 +0000432def _CheckNoUncheckedFiles(input_api, output_api):
433 results = []
434 process = input_api.subprocess.Popen(['git', 'diff', '--exit-code'],
435 stdout=input_api.subprocess.PIPE,
436 stderr=input_api.subprocess.STDOUT)
437 out, _ = process.communicate()
438 if process.returncode != 0:
Jack Franklin324f3042020-09-03 11:28:29 +0100439 files_changed_process = input_api.subprocess.Popen(
440 ['git', 'diff', '--name-only'],
441 stdout=input_api.subprocess.PIPE,
442 stderr=input_api.subprocess.STDOUT)
Tim van der Lippe9bb1cf62020-03-06 16:17:02 +0000443 files_changed, _ = files_changed_process.communicate()
444
445 return [
446 output_api.PresubmitError('You have changed files that need to be committed:'),
447 output_api.PresubmitError(files_changed)
448 ]
Tim van der Lippe5279f842020-01-14 16:26:38 +0000449 return []
450
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000451def _CheckForTooLargeFiles(input_api, output_api):
Christy Chen1ab87e02020-01-30 16:32:16 -0800452 """Avoid large files, especially binary files, in the repository since
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000453 git doesn't scale well for those. They will be in everyone's repo
454 clones forever, forever making Chromium slower to clone and work
455 with."""
Christy Chen1ab87e02020-01-30 16:32:16 -0800456 # Uploading files to cloud storage is not trivial so we don't want
457 # to set the limit too low, but the upper limit for "normal" large
458 # files seems to be 1-2 MB, with a handful around 5-8 MB, so
459 # anything over 20 MB is exceptional.
460 TOO_LARGE_FILE_SIZE_LIMIT = 20 * 1024 * 1024 # 10 MB
461 too_large_files = []
462 for f in input_api.AffectedFiles():
463 # Check both added and modified files (but not deleted files).
464 if f.Action() in ('A', 'M'):
465 size = input_api.os_path.getsize(f.AbsoluteLocalPath())
466 if size > TOO_LARGE_FILE_SIZE_LIMIT:
467 too_large_files.append("%s: %d bytes" % (f.LocalPath(), size))
468 if too_large_files:
469 message = (
470 'Do not commit large files to git since git scales badly for those.\n' +
471 'Instead put the large files in cloud storage and use DEPS to\n' +
472 'fetch them.\n' + '\n'.join(too_large_files)
473 )
474 return [output_api.PresubmitError(
475 'Too large files found in commit', long_text=message + '\n')]
476 else:
477 return []
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000478
Tim van der Lippe5279f842020-01-14 16:26:38 +0000479
Tim van der Lippef8a87092020-09-14 13:01:18 +0100480def _RunCannedChecks(input_api, output_api):
481 results = []
482 results.extend(
483 input_api.canned_checks.CheckOwnersFormat(input_api, output_api))
484 results.extend(input_api.canned_checks.CheckOwners(input_api, output_api))
485 results.extend(
486 input_api.canned_checks.CheckChangeHasNoCrAndHasOnlyOneEol(
487 input_api, output_api))
488 results.extend(
489 input_api.canned_checks.CheckChangeHasNoStrayWhitespace(
490 input_api, output_api))
491 results.extend(
492 input_api.canned_checks.CheckGenderNeutral(input_api, output_api))
493 return results
494
495
Yang Guo4fd355c2019-09-19 10:59:03 +0200496def _CommonChecks(input_api, output_api):
Mathias Bynens032591d2019-10-21 11:51:31 +0200497 """Checks common to both upload and commit."""
498 results = []
Mathias Bynens011b0072020-08-05 10:17:35 +0200499 results.extend(
500 input_api.canned_checks.CheckAuthorizedAuthor(
501 input_api, output_api, bot_allowlist=[AUTOROLL_ACCOUNT]))
Blink Reformat4c46d092018-04-07 15:32:37 +0000502 results.extend(_CheckBuildGN(input_api, output_api))
Brandon Goddard33104372020-08-13 08:49:23 -0700503 results.extend(_CheckExperimentTelemetry(input_api, output_api))
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000504 results.extend(_CheckGeneratedFiles(input_api, output_api))
Tim van der Lippee4bdd742019-12-17 16:40:16 +0100505 results.extend(_CheckJSON(input_api, output_api))
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200506 results.extend(_CheckDevToolsStyleJS(input_api, output_api))
507 results.extend(_CheckDevToolsStyleCSS(input_api, output_api))
Jack Franklinb10193f2021-03-19 10:25:08 +0000508
Jack Franklind34cf332021-03-24 10:27:20 +0000509 results.extend(_CheckDarkModeStyleSheetsUpToDate(input_api, output_api))
Tim van der Lippe5497d482020-01-14 15:27:30 +0000510 results.extend(_CheckFormat(input_api, output_api))
Joel Einbinderf6f86b62019-06-10 23:19:12 +0000511 results.extend(_CheckOptimizeSVGHashes(input_api, output_api))
Yang Guoa7845d52019-10-31 11:30:23 +0100512 results.extend(_CheckChangesAreExclusiveToDirectory(input_api, output_api))
Peter Marshallcd845512021-01-28 15:29:21 +0100513 results.extend(_CheckI18nWasBundled(input_api, output_api))
Tim van der Lippef8a87092020-09-14 13:01:18 +0100514 # Run the canned checks from `depot_tools` after the custom DevTools checks.
515 # The canned checks for example check that lines have line endings. The
516 # DevTools presubmit checks automatically fix these issues. If we would run
517 # the canned checks before the DevTools checks, they would erroneously conclude
518 # that there are issues in the code. Since the canned checks are allowed to be
519 # ignored, a confusing message is shown that asks if the failed presubmit can
520 # be continued regardless. By fixing the issues before we reach the canned checks,
521 # we don't show the message to suppress these errors, which would otherwise be
522 # causing CQ to fail.
523 results.extend(_RunCannedChecks(input_api, output_api))
Kalon Hindsd44fddf2020-12-10 05:43:25 -0800524 return results
525
526
527def _SideEffectChecks(input_api, output_api):
528 """Check side effects caused by other checks"""
529 results = []
Tim van der Lippe5279f842020-01-14 16:26:38 +0000530 results.extend(_CheckNoUncheckedFiles(input_api, output_api))
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000531 results.extend(_CheckForTooLargeFiles(input_api, output_api))
Blink Reformat4c46d092018-04-07 15:32:37 +0000532 return results
533
534
Liviu Raud614e092020-01-08 10:56:33 +0100535def CheckChangeOnUpload(input_api, output_api):
536 results = []
537 results.extend(_CommonChecks(input_api, output_api))
Christy Chen2d6d9a62020-09-22 09:04:09 -0700538 results.extend(_CollectStrings(input_api, output_api))
Kalon Hindsd44fddf2020-12-10 05:43:25 -0800539 # Run checks that rely on output from other DevTool checks
540 results.extend(_SideEffectChecks(input_api, output_api))
Sigurd Schneider5c9b4f92021-01-22 11:09:55 +0100541 results.extend(_CheckBugAssociation(input_api, output_api, False))
Liviu Raud614e092020-01-08 10:56:33 +0100542 return results
543
544
Blink Reformat4c46d092018-04-07 15:32:37 +0000545def CheckChangeOnCommit(input_api, output_api):
Mandy Chenf0fbdbe2019-08-22 23:58:37 +0000546 results = []
Yang Guo4fd355c2019-09-19 10:59:03 +0200547 results.extend(_CommonChecks(input_api, output_api))
Christy Chen2d6d9a62020-09-22 09:04:09 -0700548 results.extend(_CollectStrings(input_api, output_api))
Kalon Hindsd44fddf2020-12-10 05:43:25 -0800549 # Run checks that rely on output from other DevTool checks
550 results.extend(_SideEffectChecks(input_api, output_api))
Mathias Bynens032591d2019-10-21 11:51:31 +0200551 results.extend(input_api.canned_checks.CheckChangeHasDescription(input_api, output_api))
Sigurd Schneider5c9b4f92021-01-22 11:09:55 +0100552 results.extend(_CheckBugAssociation(input_api, output_api, True))
Mandy Chenf0fbdbe2019-08-22 23:58:37 +0000553 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000554
555
Mandy Chena6be46a2019-07-09 17:06:27 +0000556def _getAffectedFiles(input_api, parent_directories, excluded_actions, accepted_endings): # pylint: disable=invalid-name
Yang Guo75beda92019-10-28 08:29:25 +0100557 """Return absolute file paths of affected files (not due to an excluded action)
Mandy Chena6be46a2019-07-09 17:06:27 +0000558 under a parent directory with an accepted file ending.
Yang Guo75beda92019-10-28 08:29:25 +0100559 """
Mandy Chena6be46a2019-07-09 17:06:27 +0000560 local_paths = [
561 f.AbsoluteLocalPath() for f in input_api.AffectedFiles() if all(f.Action() != action for action in excluded_actions)
562 ]
563 affected_files = [
Tim van der Lippefdbd42e2020-04-07 15:14:36 +0100564 file_name for file_name in local_paths if any(parent_directory in file_name for parent_directory in parent_directories) and
565 (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 +0000566 ]
567 return affected_files
568
569
Tim van der Lippec4617122020-03-06 16:24:19 +0000570def _checkWithNodeScript(input_api, output_api, script_path, script_arguments=[]): # pylint: disable=invalid-name
Blink Reformat4c46d092018-04-07 15:32:37 +0000571 original_sys_path = sys.path
572 try:
Yang Guo75beda92019-10-28 08:29:25 +0100573 sys.path = sys.path + [input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')]
Yang Guod8176982019-10-04 20:30:35 +0000574 import devtools_paths
Blink Reformat4c46d092018-04-07 15:32:37 +0000575 finally:
576 sys.path = original_sys_path
577
Tim van der Lippec4617122020-03-06 16:24:19 +0000578 return _ExecuteSubProcess(input_api, output_api, [devtools_paths.node_path(), script_path], script_arguments, [])
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200579
580
Jack Franklin324f3042020-09-03 11:28:29 +0100581def _checkWithTypeScript(input_api,
582 output_api,
583 tsc_arguments,
584 script_path,
585 script_arguments=[]): # pylint: disable=invalid-name
586 original_sys_path = sys.path
587 try:
588 sys.path = sys.path + [
589 input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')
590 ]
591 import devtools_paths
592 finally:
593 sys.path = original_sys_path
594
595 # First run tsc to compile the TS script that we then run in the _ExecuteSubProcess call
596 tsc_compiler_process = input_api.subprocess.Popen(
597 [
598 devtools_paths.node_path(),
599 devtools_paths.typescript_compiler_path()
600 ] + tsc_arguments,
601 stdout=input_api.subprocess.PIPE,
602 stderr=input_api.subprocess.STDOUT)
603
604 out, _ = tsc_compiler_process.communicate()
605 if tsc_compiler_process.returncode != 0:
606 return [
607 output_api.PresubmitError('Error compiling briges regenerator:\n' +
608 str(out))
609 ]
610
611 return _checkWithNodeScript(input_api, output_api, script_path,
612 script_arguments)
613
614
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200615def _getFilesToLint(input_api, output_api, lint_config_files,
616 default_linted_directories, accepted_endings, results):
Mathias Bynens0ec56612020-06-19 09:14:03 +0200617 run_full_check = False
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200618 files_to_lint = []
619
620 # We are changing the lint configuration; run the full check.
621 if len(lint_config_files) is not 0:
622 results.append(
623 output_api.PresubmitNotifyResult('Running full lint check'))
Mathias Bynens0ec56612020-06-19 09:14:03 +0200624 run_full_check = True
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200625 else:
626 # Only run the linter on files that are relevant, to save PRESUBMIT time.
627 files_to_lint = _getAffectedFiles(input_api,
628 default_linted_directories, ['D'],
629 accepted_endings)
630
Paul Lewis2b9224f2020-09-08 18:13:10 +0100631 # Exclude front_end/third_party files.
632 files_to_lint = filter(lambda path: "third_party" not in path,
633 files_to_lint)
634
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200635 if len(files_to_lint) is 0:
636 results.append(
637 output_api.PresubmitNotifyResult(
638 'No affected files for lint check'))
639
Mathias Bynens0ec56612020-06-19 09:14:03 +0200640 should_bail_out = len(files_to_lint) is 0 and not run_full_check
641 return should_bail_out, files_to_lint
Peter Marshallcd845512021-01-28 15:29:21 +0100642
643
644def _CheckI18nWasBundled(input_api, output_api):
645 affected_files = _getAffectedFiles(input_api, [
646 input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end',
647 'third_party', 'i18n', 'lib')
648 ], [], ['.js'])
649
650 if len(affected_files) == 0:
651 return [
652 output_api.PresubmitNotifyResult(
653 'No affected files for i18n bundle check')
654 ]
655
656 results = [output_api.PresubmitNotifyResult('Running buildi18nBundle.js:')]
657 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
658 'scripts', 'localizationV2',
659 'buildi18nBundle.js')
660 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
661 return results