blob: 97ffbbda41a5b5be4b86e82e542b841be3798ac7 [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 = [
40 [ 'third_party', 'v8' ],
41 [ 'node_modules' ],
42 [ 'OWNERS' ],
43]
44
Liviu Raufd2e3212019-12-18 16:38:20 +010045AUTOROLL_ACCOUNT = "devtools-ci-autoroll-builder@chops-service-accounts.iam.gserviceaccount.com"
Mathias Bynensa0a6e292019-12-17 13:24:08 +010046
Tim van der Lippe4d004ec2020-03-03 18:32:01 +000047
48def _ExecuteSubProcess(input_api, output_api, script_path, args, results):
Tim van der Lippef515fdc2020-03-06 16:18:25 +000049 if isinstance(script_path, six.string_types):
50 script_path = [input_api.python_executable, script_path]
51
Tim van der Lippefb023462020-08-21 14:10:06 +010052 start_time = time.time()
Tim van der Lippef515fdc2020-03-06 16:18:25 +000053 process = input_api.subprocess.Popen(script_path + args, stdout=input_api.subprocess.PIPE, stderr=input_api.subprocess.STDOUT)
Tim van der Lippe4d004ec2020-03-03 18:32:01 +000054 out, _ = process.communicate()
Tim van der Lippefb023462020-08-21 14:10:06 +010055 end_time = time.time()
56
57 time_difference = end_time - start_time
58 time_info = "Script execution time was %.1fs seconds\n" % (time_difference)
Tim van der Lippe4d004ec2020-03-03 18:32:01 +000059 if process.returncode != 0:
Tim van der Lippefb023462020-08-21 14:10:06 +010060 results.append(output_api.PresubmitError(time_info + out))
Tim van der Lippe4d004ec2020-03-03 18:32:01 +000061 else:
Tim van der Lippefb023462020-08-21 14:10:06 +010062 results.append(output_api.PresubmitNotifyResult(time_info + out))
Tim van der Lippe4d004ec2020-03-03 18:32:01 +000063 return results
64
65
Yang Guoa7845d52019-10-31 11:30:23 +010066def _CheckChangesAreExclusiveToDirectory(input_api, output_api):
Tim van der Lippebc42a632019-11-28 14:22:55 +000067 if input_api.change.DISABLE_THIRD_PARTY_CHECK != None:
68 return []
Brandon Goddarde7028672020-01-30 09:31:04 -080069 results = [output_api.PresubmitNotifyResult('Directory Exclusivity Check:')]
Yang Guoa7845d52019-10-31 11:30:23 +010070 def IsParentDir(file, dir):
71 while file != '':
72 if file == dir:
73 return True
74 file = input_api.os_path.dirname(file)
Yang Guoa7845d52019-10-31 11:30:23 +010075 return False
76
77 def FileIsInDir(file, dirs):
78 for dir in dirs:
79 if IsParentDir(file, dir):
80 return True
81
82 affected_files = input_api.LocalPaths()
Yang Guoa7845d52019-10-31 11:30:23 +010083 num_affected = len(affected_files)
84 for dirs in EXCLUSIVE_CHANGE_DIRECTORIES:
Paul Lewis14effba2019-12-02 14:56:40 +000085 dir_list = ', '.join(dirs)
Yang Guoa7845d52019-10-31 11:30:23 +010086 affected_in_dir = filter(lambda f: FileIsInDir(f, dirs), affected_files)
87 num_in_dir = len(affected_in_dir)
88 if num_in_dir == 0:
89 continue
Tim van der Lippeebb94a92019-11-19 17:07:53 +000090 # Addition of new third_party folders must have a new entry in `.gitignore`
91 if '.gitignore' in affected_files:
92 num_in_dir = num_in_dir + 1
Yang Guoa7845d52019-10-31 11:30:23 +010093 if num_in_dir < num_affected:
Brandon Goddarde7028672020-01-30 09:31:04 -080094 results.append(output_api
Paul Lewis14effba2019-12-02 14:56:40 +000095 .PresubmitError(('CLs that affect files in "%s" should be limited to these files/directories.' % dir_list) +
Brandon Goddarde7028672020-01-30 09:31:04 -080096 ' You can disable this check by adding DISABLE_THIRD_PARTY_CHECK=<reason> to your commit message'))
97 break
98
99 return results
Yang Guoa7845d52019-10-31 11:30:23 +0100100
Blink Reformat4c46d092018-04-07 15:32:37 +0000101
Sigurd Schneider5c9b4f92021-01-22 11:09:55 +0100102def _CheckBugAssociation(input_api, output_api, is_committing):
103 results = [output_api.PresubmitNotifyResult('Bug Association Check:')]
104 bugs = input_api.change.BugsFromDescription()
105 message = (
106 "Each CL should be associated with a bug, use \'Bug:\' or \'Fixed:\' lines in\n"
107 "the footer of the commit description. If you explicitly don\'t want to\n"
108 "set a bug, use \'Bug: none\' in the footer of the commit description.\n\n"
109 "Note: The footer of the commit description is the last block of lines in\n"
110 "the commit description that doesn't contain empty lines. This means that\n"
111 "any \'Bug:\' or \'Fixed:\' lines that are eventually followed by an empty\n"
112 "line are not detected by this presubmit check.")
113
114 if not bugs:
115 if is_committing:
116 results.append(output_api.PresubmitError(message))
117 else:
118 results.append(output_api.PresubmitNotifyResult(message))
119
120 for bug in bugs:
121 results.append(output_api.PresubmitNotifyResult(('%s') % bug))
122
123 return results
124
125
Blink Reformat4c46d092018-04-07 15:32:37 +0000126def _CheckBuildGN(input_api, output_api):
Brandon Goddarde7028672020-01-30 09:31:04 -0800127 results = [output_api.PresubmitNotifyResult('Running BUILD.GN check:')]
Yang Guo75beda92019-10-28 08:29:25 +0100128 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'check_gn.js')
Brandon Goddarde7028672020-01-30 09:31:04 -0800129 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
130 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000131
132
Brandon Goddard33104372020-08-13 08:49:23 -0700133def _CheckExperimentTelemetry(input_api, output_api):
Brandon Goddard33104372020-08-13 08:49:23 -0700134 experiment_telemetry_files = [
135 input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end',
136 'main', 'MainImpl.js'),
137 input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end',
138 'host', 'UserMetrics.js')
139 ]
140 affected_main_files = _getAffectedFiles(input_api,
141 experiment_telemetry_files, [],
142 ['.js'])
143 if len(affected_main_files) == 0:
Tim van der Lippefb023462020-08-21 14:10:06 +0100144 return [
145 output_api.PresubmitNotifyResult(
146 'No affected files for telemetry check')
147 ]
Brandon Goddard33104372020-08-13 08:49:23 -0700148
Tim van der Lippefb023462020-08-21 14:10:06 +0100149 results = [
150 output_api.PresubmitNotifyResult('Running Experiment Telemetry check:')
151 ]
Brandon Goddard33104372020-08-13 08:49:23 -0700152 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
153 'scripts', 'check_experiments.js')
154 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
155 return results
156
157
Tim van der Lippee4bdd742019-12-17 16:40:16 +0100158def _CheckJSON(input_api, output_api):
Brandon Goddarde7028672020-01-30 09:31:04 -0800159 results = [output_api.PresubmitNotifyResult('Running JSON Validator:')]
Tim van der Lippee4bdd742019-12-17 16:40:16 +0100160 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'json_validator', 'validate_module_json.js')
Brandon Goddarde7028672020-01-30 09:31:04 -0800161 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
162 return results
Tim van der Lippee4bdd742019-12-17 16:40:16 +0100163
164
Blink Reformat4c46d092018-04-07 15:32:37 +0000165def _CheckFormat(input_api, output_api):
Tim van der Lippefdbd42e2020-04-07 15:14:36 +0100166 node_modules_affected_files = _getAffectedFiles(input_api, [input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules')], [], [])
167
168 # TODO(crbug.com/1068198): Remove once `git cl format --js` can handle large CLs.
169 if (len(node_modules_affected_files) > 0):
170 return [output_api.PresubmitNotifyResult('Skipping Format Checks because `node_modules` files are affected.')]
171
Brandon Goddarde7028672020-01-30 09:31:04 -0800172 results = [output_api.PresubmitNotifyResult('Running Format Checks:')]
Blink Reformat4c46d092018-04-07 15:32:37 +0000173
Tim van der Lippef515fdc2020-03-06 16:18:25 +0000174 return _ExecuteSubProcess(input_api, output_api, ['git', 'cl', 'format', '--js'], [], results)
Blink Reformat4c46d092018-04-07 15:32:37 +0000175
176
e52a82bdfb5106bd658c2c5ea465e200594be1e2019-10-29 16:02:46 -0700177def _CheckDevtoolsLocalization(input_api, output_api, check_all_files=False): # pylint: disable=invalid-name
Mandy Chene997da72019-08-22 23:50:19 +0000178 devtools_root = input_api.PresubmitLocalPath()
vidorteg2b675b02019-11-25 09:51:28 -0800179 script_path = input_api.os_path.join(devtools_root, 'scripts', 'test', 'run_localization_check.py')
Paul Lewis954a5a92019-11-20 15:33:49 +0000180 if check_all_files == True:
vidorteg2b675b02019-11-25 09:51:28 -0800181 # Scan all files and fix any errors
vidorteg75c025e2019-11-25 09:52:43 -0800182 args = ['--autofix', '--all']
Paul Lewis954a5a92019-11-20 15:33:49 +0000183 else:
vidorteg2b675b02019-11-25 09:51:28 -0800184 devtools_front_end = input_api.os_path.join(devtools_root, 'front_end')
Andres Olivares71a1ce42020-11-03 11:07:30 -0500185 affected_front_end_files = _getAffectedFiles(
Peter Marshall1d952dc2021-02-10 13:49:32 +0100186 input_api, [devtools_front_end], [],
Andres Olivares71a1ce42020-11-03 11:07:30 -0500187 ['.ts', '.js', '.grdp', '.grd', 'module.json'])
vidorteg2b675b02019-11-25 09:51:28 -0800188
189 if len(affected_front_end_files) == 0:
Tim van der Lippefb023462020-08-21 14:10:06 +0100190 return [
191 output_api.PresubmitNotifyResult(
192 'No affected files for localization check')
193 ]
Christy Chen1ab87e02020-01-30 16:32:16 -0800194
195 with input_api.CreateTemporaryFile() as file_list:
196 for affected_file in affected_front_end_files:
197 file_list.write(affected_file + '\n')
198 file_list.close()
199
vidorteg2b675b02019-11-25 09:51:28 -0800200 # Scan only added or modified files with specific extensions.
Christy Chen1ab87e02020-01-30 16:32:16 -0800201 args = ['--autofix', '--file-list', file_list.name]
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000202
Tim van der Lippefb023462020-08-21 14:10:06 +0100203 results = [
204 output_api.PresubmitNotifyResult('Running Localization Checks:')
205 ]
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000206 return _ExecuteSubProcess(input_api, output_api, script_path, args, results)
Mandy Chen465b4f72019-03-21 22:52:54 +0000207
208
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200209def _CheckDevToolsStyleJS(input_api, output_api):
Tim van der Lippefb023462020-08-21 14:10:06 +0100210 results = [output_api.PresubmitNotifyResult('JS style check:')]
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200211 lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
212 'scripts', 'test',
213 'run_lint_check_js.js')
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000214
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200215 front_end_directory = input_api.os_path.join(
216 input_api.PresubmitLocalPath(), 'front_end')
Alex Rudenko5556a902020-09-29 09:37:23 +0000217 inspector_overlay_directory = input_api.os_path.join(
218 input_api.PresubmitLocalPath(), 'inspector_overlay')
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200219 test_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
220 'test')
221 scripts_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
222 'scripts')
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000223
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200224 default_linted_directories = [
Alex Rudenko5556a902020-09-29 09:37:23 +0000225 front_end_directory, test_directory, scripts_directory,
226 inspector_overlay_directory
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200227 ]
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000228
229 eslint_related_files = [
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200230 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules',
231 'eslint'),
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000232 input_api.os_path.join(input_api.PresubmitLocalPath(), '.eslintrc.js'),
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200233 input_api.os_path.join(input_api.PresubmitLocalPath(),
234 '.eslintignore'),
Tim van der Lippe33543ac2020-12-14 15:37:45 +0100235 input_api.os_path.join(front_end_directory, '.eslintrc.js'),
Tim van der Lippe406249f2020-12-14 15:59:10 +0100236 input_api.os_path.join(test_directory, '.eslintrc.js'),
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200237 input_api.os_path.join(scripts_directory, 'test',
238 'run_lint_check_js.py'),
239 input_api.os_path.join(scripts_directory, 'test',
240 'run_lint_check_js.js'),
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000241 input_api.os_path.join(scripts_directory, '.eslintrc.js'),
242 input_api.os_path.join(scripts_directory, 'eslint_rules'),
243 ]
244
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200245 lint_config_files = _getAffectedFiles(input_api, eslint_related_files, [],
246 ['.js', '.py', '.eslintignore'])
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000247
Mathias Bynens0ec56612020-06-19 09:14:03 +0200248 should_bail_out, files_to_lint = _getFilesToLint(
249 input_api, output_api, lint_config_files, default_linted_directories,
250 ['.js', '.ts'], results)
251 if should_bail_out:
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200252 return results
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000253
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200254 results.extend(
255 _checkWithNodeScript(input_api, output_api, lint_path, files_to_lint))
Tim van der Lippe98132242020-04-14 17:16:54 +0100256 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000257
258
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200259def _CheckDevToolsStyleCSS(input_api, output_api):
Tim van der Lippefb023462020-08-21 14:10:06 +0100260 results = [output_api.PresubmitNotifyResult('CSS style check:')]
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200261 lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
262 'scripts', 'test',
Jack Franklinbc302342021-01-18 10:03:30 +0000263 'run_lint_check_css.js')
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200264
265 front_end_directory = input_api.os_path.join(
266 input_api.PresubmitLocalPath(), 'front_end')
Alex Rudenko5556a902020-09-29 09:37:23 +0000267 inspector_overlay_directory = input_api.os_path.join(
268 input_api.PresubmitLocalPath(), 'inspector_overlay')
269 default_linted_directories = [
270 front_end_directory, inspector_overlay_directory
271 ]
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200272
273 scripts_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
274 'scripts')
275
276 stylelint_related_files = [
277 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules',
278 'stylelint'),
279 input_api.os_path.join(input_api.PresubmitLocalPath(),
280 '.stylelintrc.json'),
281 input_api.os_path.join(input_api.PresubmitLocalPath(),
282 '.stylelintignore'),
283 input_api.os_path.join(scripts_directory, 'test',
284 'run_lint_check_css.py'),
285 ]
286
287 lint_config_files = _getAffectedFiles(input_api, stylelint_related_files,
288 [],
289 ['.json', '.py', '.stylelintignore'])
290
Sigurd Schneidere3bf6c22021-02-11 15:35:23 +0100291 css_should_bail_out, css_files_to_lint = _getFilesToLint(
Mathias Bynens0ec56612020-06-19 09:14:03 +0200292 input_api, output_api, lint_config_files, default_linted_directories,
293 ['.css'], results)
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200294
Sigurd Schneidere3bf6c22021-02-11 15:35:23 +0100295 if not css_should_bail_out:
296 script_args = ["--syntax", "html", "--files"] + ts_files_to_lint
297 results.extend(
298 _checkWithNodeScript(input_api, output_api, lint_path,
299 css_files_to_lint))
300
301 ts_should_bail_out, ts_files_to_lint = _getFilesToLint(
302 input_api, output_api, lint_config_files, default_linted_directories,
303 ['.ts'], results)
304
305 if not ts_should_bail_out:
306 script_args = ["--syntax", "html", "--files"] + ts_files_to_lint
307 results.extend(
308 _checkWithNodeScript(input_api, output_api, lint_path,
309 script_args))
310
Jack Franklinbc302342021-01-18 10:03:30 +0000311 return results
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200312
313
Jack Franklin13812f62021-02-01 15:51:12 +0000314def _CheckDarkModeStyleSheetsUpToDate(input_api, output_api):
315 devtools_root = input_api.PresubmitLocalPath()
316 devtools_front_end = input_api.os_path.join(devtools_root, 'front_end')
317 affected_css_files = _getAffectedFiles(input_api, [devtools_front_end], [],
318 ['.css'])
319 results = [output_api.PresubmitNotifyResult('Dark Mode CSS check:')]
320 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
321 'scripts', 'dark_mode',
322 'check_darkmode_css_up_to_date.js')
323 results.extend(
324 _checkWithNodeScript(input_api, output_api, script_path,
325 affected_css_files))
326 return results
327
328
Joel Einbinderf6f86b62019-06-10 23:19:12 +0000329def _CheckOptimizeSVGHashes(input_api, output_api):
Tim van der Lippefb023462020-08-21 14:10:06 +0100330 if not input_api.platform.startswith('linux'):
331 return [output_api.PresubmitNotifyResult('Skipping SVG hash check')]
332
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200333 results = [
334 output_api.PresubmitNotifyResult('Running SVG optimization check:')
335 ]
Blink Reformat4c46d092018-04-07 15:32:37 +0000336
337 original_sys_path = sys.path
338 try:
339 sys.path = sys.path + [input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'build')]
340 import devtools_file_hashes
341 finally:
342 sys.path = original_sys_path
343
344 absolute_local_paths = [af.AbsoluteLocalPath() for af in input_api.AffectedFiles(include_deletes=False)]
Yang Guo75beda92019-10-28 08:29:25 +0100345 images_src_path = input_api.os_path.join('devtools', 'front_end', 'Images', 'src')
346 image_source_file_paths = [path for path in absolute_local_paths if images_src_path in path and path.endswith('.svg')]
347 image_sources_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end', 'Images', 'src')
348 hashes_file_name = 'optimize_svg.hashes'
Blink Reformat4c46d092018-04-07 15:32:37 +0000349 hashes_file_path = input_api.os_path.join(image_sources_path, hashes_file_name)
350 invalid_hash_file_paths = devtools_file_hashes.files_with_invalid_hashes(hashes_file_path, image_source_file_paths)
351 if len(invalid_hash_file_paths) == 0:
Brandon Goddarde7028672020-01-30 09:31:04 -0800352 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000353 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 +0100354 file_paths_str = ', '.join(invalid_hash_file_names)
355 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 -0800356 results.append(output_api.PresubmitError(error_message))
357 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000358
359
Mathias Bynens032591d2019-10-21 11:51:31 +0200360
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000361def _CheckGeneratedFiles(input_api, output_api):
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000362 v8_directory_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'v8')
363 blink_directory_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party', 'blink')
364 protocol_location = input_api.os_path.join(blink_directory_path, 'public', 'devtools_protocol')
365 scripts_build_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'build')
Tim van der Lippe5d2d79b2020-03-23 11:45:04 +0000366 scripts_generated_output_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end', 'generated')
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000367
368 generated_aria_path = input_api.os_path.join(scripts_build_path, 'generate_aria.py')
369 generated_supported_css_path = input_api.os_path.join(scripts_build_path, 'generate_supported_css.py')
370 generated_protocol_path = input_api.os_path.join(scripts_build_path, 'code_generator_frontend.py')
371 concatenate_protocols_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party', 'inspector_protocol',
372 'concatenate_protocols.py')
373
374 affected_files = _getAffectedFiles(input_api, [
375 v8_directory_path,
376 blink_directory_path,
377 input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party', 'pyjson5'),
378 generated_aria_path,
379 generated_supported_css_path,
380 concatenate_protocols_path,
381 generated_protocol_path,
Tim van der Lippe5d2d79b2020-03-23 11:45:04 +0000382 scripts_generated_output_path,
383 ], [], ['.pdl', '.json5', '.py', '.js'])
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000384
385 if len(affected_files) == 0:
Tim van der Lippefb023462020-08-21 14:10:06 +0100386 return [
387 output_api.PresubmitNotifyResult(
388 'No affected files for generated files check')
389 ]
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000390
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000391 results = [output_api.PresubmitNotifyResult('Running Generated Files Check:')]
Tim van der Lippeb0d65f12020-03-05 12:15:24 +0000392 generate_protocol_resources_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'deps',
393 'generate_protocol_resources.py')
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000394
Tim van der Lippeb0d65f12020-03-05 12:15:24 +0000395 return _ExecuteSubProcess(input_api, output_api, generate_protocol_resources_path, [], results)
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000396
397
Christy Chen2d6d9a62020-09-22 09:04:09 -0700398def _CollectStrings(input_api, output_api):
399 devtools_root = input_api.PresubmitLocalPath()
400 devtools_front_end = input_api.os_path.join(devtools_root, 'front_end')
401 affected_front_end_files = _getAffectedFiles(input_api,
Peter Marshall1d952dc2021-02-10 13:49:32 +0100402 [devtools_front_end], [],
Tim van der Lippec50df852021-01-19 15:15:52 +0000403 ['.js', '.ts'])
Christy Chen2d6d9a62020-09-22 09:04:09 -0700404 if len(affected_front_end_files) == 0:
405 return [
406 output_api.PresubmitNotifyResult(
407 'No affected files to run collect-strings')
408 ]
409
410 results = [
411 output_api.PresubmitNotifyResult('Collecting strings from front_end:')
412 ]
413 script_path = input_api.os_path.join(devtools_root, 'third_party', 'i18n',
414 'collect-strings.js')
415 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
416 results.append(
417 output_api.PresubmitNotifyResult(
Peter Marshalld67e9f12021-02-08 10:34:35 +0100418 'Please commit en-US.json/en-XL.json if changes are generated.'))
Christy Chen2d6d9a62020-09-22 09:04:09 -0700419 return results
420
421
Tim van der Lippe5279f842020-01-14 16:26:38 +0000422def _CheckNoUncheckedFiles(input_api, output_api):
423 results = []
424 process = input_api.subprocess.Popen(['git', 'diff', '--exit-code'],
425 stdout=input_api.subprocess.PIPE,
426 stderr=input_api.subprocess.STDOUT)
427 out, _ = process.communicate()
428 if process.returncode != 0:
Jack Franklin324f3042020-09-03 11:28:29 +0100429 files_changed_process = input_api.subprocess.Popen(
430 ['git', 'diff', '--name-only'],
431 stdout=input_api.subprocess.PIPE,
432 stderr=input_api.subprocess.STDOUT)
Tim van der Lippe9bb1cf62020-03-06 16:17:02 +0000433 files_changed, _ = files_changed_process.communicate()
434
435 return [
436 output_api.PresubmitError('You have changed files that need to be committed:'),
437 output_api.PresubmitError(files_changed)
438 ]
Tim van der Lippe5279f842020-01-14 16:26:38 +0000439 return []
440
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000441def _CheckForTooLargeFiles(input_api, output_api):
Christy Chen1ab87e02020-01-30 16:32:16 -0800442 """Avoid large files, especially binary files, in the repository since
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000443 git doesn't scale well for those. They will be in everyone's repo
444 clones forever, forever making Chromium slower to clone and work
445 with."""
Christy Chen1ab87e02020-01-30 16:32:16 -0800446 # Uploading files to cloud storage is not trivial so we don't want
447 # to set the limit too low, but the upper limit for "normal" large
448 # files seems to be 1-2 MB, with a handful around 5-8 MB, so
449 # anything over 20 MB is exceptional.
450 TOO_LARGE_FILE_SIZE_LIMIT = 20 * 1024 * 1024 # 10 MB
451 too_large_files = []
452 for f in input_api.AffectedFiles():
453 # Check both added and modified files (but not deleted files).
454 if f.Action() in ('A', 'M'):
455 size = input_api.os_path.getsize(f.AbsoluteLocalPath())
456 if size > TOO_LARGE_FILE_SIZE_LIMIT:
457 too_large_files.append("%s: %d bytes" % (f.LocalPath(), size))
458 if too_large_files:
459 message = (
460 'Do not commit large files to git since git scales badly for those.\n' +
461 'Instead put the large files in cloud storage and use DEPS to\n' +
462 'fetch them.\n' + '\n'.join(too_large_files)
463 )
464 return [output_api.PresubmitError(
465 'Too large files found in commit', long_text=message + '\n')]
466 else:
467 return []
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000468
Tim van der Lippe5279f842020-01-14 16:26:38 +0000469
Tim van der Lippef8a87092020-09-14 13:01:18 +0100470def _RunCannedChecks(input_api, output_api):
471 results = []
472 results.extend(
473 input_api.canned_checks.CheckOwnersFormat(input_api, output_api))
474 results.extend(input_api.canned_checks.CheckOwners(input_api, output_api))
475 results.extend(
476 input_api.canned_checks.CheckChangeHasNoCrAndHasOnlyOneEol(
477 input_api, output_api))
478 results.extend(
479 input_api.canned_checks.CheckChangeHasNoStrayWhitespace(
480 input_api, output_api))
481 results.extend(
482 input_api.canned_checks.CheckGenderNeutral(input_api, output_api))
483 return results
484
485
Yang Guo4fd355c2019-09-19 10:59:03 +0200486def _CommonChecks(input_api, output_api):
Mathias Bynens032591d2019-10-21 11:51:31 +0200487 """Checks common to both upload and commit."""
488 results = []
Mathias Bynens011b0072020-08-05 10:17:35 +0200489 results.extend(
490 input_api.canned_checks.CheckAuthorizedAuthor(
491 input_api, output_api, bot_allowlist=[AUTOROLL_ACCOUNT]))
Blink Reformat4c46d092018-04-07 15:32:37 +0000492 results.extend(_CheckBuildGN(input_api, output_api))
Brandon Goddard33104372020-08-13 08:49:23 -0700493 results.extend(_CheckExperimentTelemetry(input_api, output_api))
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000494 results.extend(_CheckGeneratedFiles(input_api, output_api))
Tim van der Lippee4bdd742019-12-17 16:40:16 +0100495 results.extend(_CheckJSON(input_api, output_api))
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200496 results.extend(_CheckDevToolsStyleJS(input_api, output_api))
497 results.extend(_CheckDevToolsStyleCSS(input_api, output_api))
Jack Franklin13812f62021-02-01 15:51:12 +0000498 results.extend(_CheckDarkModeStyleSheetsUpToDate(input_api, output_api))
Tim van der Lippe5497d482020-01-14 15:27:30 +0000499 results.extend(_CheckFormat(input_api, output_api))
Joel Einbinderf6f86b62019-06-10 23:19:12 +0000500 results.extend(_CheckOptimizeSVGHashes(input_api, output_api))
Yang Guoa7845d52019-10-31 11:30:23 +0100501 results.extend(_CheckChangesAreExclusiveToDirectory(input_api, output_api))
Peter Marshallcd845512021-01-28 15:29:21 +0100502 results.extend(_CheckI18nWasBundled(input_api, output_api))
Tim van der Lippef8a87092020-09-14 13:01:18 +0100503 # Run the canned checks from `depot_tools` after the custom DevTools checks.
504 # The canned checks for example check that lines have line endings. The
505 # DevTools presubmit checks automatically fix these issues. If we would run
506 # the canned checks before the DevTools checks, they would erroneously conclude
507 # that there are issues in the code. Since the canned checks are allowed to be
508 # ignored, a confusing message is shown that asks if the failed presubmit can
509 # be continued regardless. By fixing the issues before we reach the canned checks,
510 # we don't show the message to suppress these errors, which would otherwise be
511 # causing CQ to fail.
512 results.extend(_RunCannedChecks(input_api, output_api))
Kalon Hindsd44fddf2020-12-10 05:43:25 -0800513 return results
514
515
516def _SideEffectChecks(input_api, output_api):
517 """Check side effects caused by other checks"""
518 results = []
Tim van der Lippe5279f842020-01-14 16:26:38 +0000519 results.extend(_CheckNoUncheckedFiles(input_api, output_api))
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000520 results.extend(_CheckForTooLargeFiles(input_api, output_api))
Blink Reformat4c46d092018-04-07 15:32:37 +0000521 return results
522
523
Liviu Raud614e092020-01-08 10:56:33 +0100524def CheckChangeOnUpload(input_api, output_api):
525 results = []
526 results.extend(_CommonChecks(input_api, output_api))
527 results.extend(_CheckDevtoolsLocalization(input_api, output_api))
Christy Chen2d6d9a62020-09-22 09:04:09 -0700528 # Run collectStrings after localization check that cleans up unused strings
529 results.extend(_CollectStrings(input_api, output_api))
Kalon Hindsd44fddf2020-12-10 05:43:25 -0800530 # Run checks that rely on output from other DevTool checks
531 results.extend(_SideEffectChecks(input_api, output_api))
Sigurd Schneider5c9b4f92021-01-22 11:09:55 +0100532 results.extend(_CheckBugAssociation(input_api, output_api, False))
Liviu Raud614e092020-01-08 10:56:33 +0100533 return results
534
535
Blink Reformat4c46d092018-04-07 15:32:37 +0000536def CheckChangeOnCommit(input_api, output_api):
Mandy Chenf0fbdbe2019-08-22 23:58:37 +0000537 results = []
Yang Guo4fd355c2019-09-19 10:59:03 +0200538 results.extend(_CommonChecks(input_api, output_api))
e52a82bdfb5106bd658c2c5ea465e200594be1e2019-10-29 16:02:46 -0700539 results.extend(_CheckDevtoolsLocalization(input_api, output_api, True))
Christy Chen2d6d9a62020-09-22 09:04:09 -0700540 # Run collectStrings after localization check that cleans up unused strings
541 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