blob: 74ded9798cb6a9ea127b831e53d665e33decf553 [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
102def _CheckBuildGN(input_api, output_api):
Brandon Goddarde7028672020-01-30 09:31:04 -0800103 results = [output_api.PresubmitNotifyResult('Running BUILD.GN check:')]
Yang Guo75beda92019-10-28 08:29:25 +0100104 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'check_gn.js')
Brandon Goddarde7028672020-01-30 09:31:04 -0800105 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
106 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000107
108
Brandon Goddard33104372020-08-13 08:49:23 -0700109def _CheckExperimentTelemetry(input_api, output_api):
Brandon Goddard33104372020-08-13 08:49:23 -0700110 experiment_telemetry_files = [
111 input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end',
112 'main', 'MainImpl.js'),
113 input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end',
114 'host', 'UserMetrics.js')
115 ]
116 affected_main_files = _getAffectedFiles(input_api,
117 experiment_telemetry_files, [],
118 ['.js'])
119 if len(affected_main_files) == 0:
Tim van der Lippefb023462020-08-21 14:10:06 +0100120 return [
121 output_api.PresubmitNotifyResult(
122 'No affected files for telemetry check')
123 ]
Brandon Goddard33104372020-08-13 08:49:23 -0700124
Tim van der Lippefb023462020-08-21 14:10:06 +0100125 results = [
126 output_api.PresubmitNotifyResult('Running Experiment Telemetry check:')
127 ]
Brandon Goddard33104372020-08-13 08:49:23 -0700128 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
129 'scripts', 'check_experiments.js')
130 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
131 return results
132
133
Tim van der Lippee4bdd742019-12-17 16:40:16 +0100134def _CheckJSON(input_api, output_api):
Brandon Goddarde7028672020-01-30 09:31:04 -0800135 results = [output_api.PresubmitNotifyResult('Running JSON Validator:')]
Tim van der Lippee4bdd742019-12-17 16:40:16 +0100136 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'json_validator', 'validate_module_json.js')
Brandon Goddarde7028672020-01-30 09:31:04 -0800137 results.extend(_checkWithNodeScript(input_api, output_api, script_path))
138 return results
Tim van der Lippee4bdd742019-12-17 16:40:16 +0100139
140
Blink Reformat4c46d092018-04-07 15:32:37 +0000141def _CheckFormat(input_api, output_api):
Tim van der Lippefdbd42e2020-04-07 15:14:36 +0100142 node_modules_affected_files = _getAffectedFiles(input_api, [input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules')], [], [])
143
144 # TODO(crbug.com/1068198): Remove once `git cl format --js` can handle large CLs.
145 if (len(node_modules_affected_files) > 0):
146 return [output_api.PresubmitNotifyResult('Skipping Format Checks because `node_modules` files are affected.')]
147
Brandon Goddarde7028672020-01-30 09:31:04 -0800148 results = [output_api.PresubmitNotifyResult('Running Format Checks:')]
Blink Reformat4c46d092018-04-07 15:32:37 +0000149
Tim van der Lippef515fdc2020-03-06 16:18:25 +0000150 return _ExecuteSubProcess(input_api, output_api, ['git', 'cl', 'format', '--js'], [], results)
Blink Reformat4c46d092018-04-07 15:32:37 +0000151
152
e52a82bdfb5106bd658c2c5ea465e200594be1e2019-10-29 16:02:46 -0700153def _CheckDevtoolsLocalization(input_api, output_api, check_all_files=False): # pylint: disable=invalid-name
Mandy Chene997da72019-08-22 23:50:19 +0000154 devtools_root = input_api.PresubmitLocalPath()
vidorteg2b675b02019-11-25 09:51:28 -0800155 script_path = input_api.os_path.join(devtools_root, 'scripts', 'test', 'run_localization_check.py')
Paul Lewis954a5a92019-11-20 15:33:49 +0000156 if check_all_files == True:
vidorteg2b675b02019-11-25 09:51:28 -0800157 # Scan all files and fix any errors
vidorteg75c025e2019-11-25 09:52:43 -0800158 args = ['--autofix', '--all']
Paul Lewis954a5a92019-11-20 15:33:49 +0000159 else:
vidorteg2b675b02019-11-25 09:51:28 -0800160 devtools_front_end = input_api.os_path.join(devtools_root, 'front_end')
161 affected_front_end_files = _getAffectedFiles(input_api, [devtools_front_end], ['D'],
162 ['.js', '.grdp', '.grd', 'module.json'])
163
164 if len(affected_front_end_files) == 0:
Tim van der Lippefb023462020-08-21 14:10:06 +0100165 return [
166 output_api.PresubmitNotifyResult(
167 'No affected files for localization check')
168 ]
Christy Chen1ab87e02020-01-30 16:32:16 -0800169
170 with input_api.CreateTemporaryFile() as file_list:
171 for affected_file in affected_front_end_files:
172 file_list.write(affected_file + '\n')
173 file_list.close()
174
vidorteg2b675b02019-11-25 09:51:28 -0800175 # Scan only added or modified files with specific extensions.
Christy Chen1ab87e02020-01-30 16:32:16 -0800176 args = ['--autofix', '--file-list', file_list.name]
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000177
Tim van der Lippefb023462020-08-21 14:10:06 +0100178 results = [
179 output_api.PresubmitNotifyResult('Running Localization Checks:')
180 ]
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000181 return _ExecuteSubProcess(input_api, output_api, script_path, args, results)
Mandy Chen465b4f72019-03-21 22:52:54 +0000182
183
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200184def _CheckDevToolsStyleJS(input_api, output_api):
Tim van der Lippefb023462020-08-21 14:10:06 +0100185 results = [output_api.PresubmitNotifyResult('JS style check:')]
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200186 lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
187 'scripts', 'test',
188 'run_lint_check_js.js')
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000189
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200190 front_end_directory = input_api.os_path.join(
191 input_api.PresubmitLocalPath(), 'front_end')
192 test_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
193 'test')
194 scripts_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
195 'scripts')
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000196
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200197 default_linted_directories = [
198 front_end_directory, test_directory, scripts_directory
199 ]
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000200
201 eslint_related_files = [
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200202 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules',
203 'eslint'),
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000204 input_api.os_path.join(input_api.PresubmitLocalPath(), '.eslintrc.js'),
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200205 input_api.os_path.join(input_api.PresubmitLocalPath(),
206 '.eslintignore'),
207 input_api.os_path.join(scripts_directory, 'test',
208 'run_lint_check_js.py'),
209 input_api.os_path.join(scripts_directory, 'test',
210 'run_lint_check_js.js'),
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000211 input_api.os_path.join(scripts_directory, '.eslintrc.js'),
212 input_api.os_path.join(scripts_directory, 'eslint_rules'),
213 ]
214
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200215 lint_config_files = _getAffectedFiles(input_api, eslint_related_files, [],
216 ['.js', '.py', '.eslintignore'])
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000217
Mathias Bynens0ec56612020-06-19 09:14:03 +0200218 should_bail_out, files_to_lint = _getFilesToLint(
219 input_api, output_api, lint_config_files, default_linted_directories,
220 ['.js', '.ts'], results)
221 if should_bail_out:
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200222 return results
Tim van der Lippe2a4ae2b2020-03-11 17:28:06 +0000223
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200224 results.extend(
225 _checkWithNodeScript(input_api, output_api, lint_path, files_to_lint))
Tim van der Lippe98132242020-04-14 17:16:54 +0100226 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000227
228
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200229def _CheckDevToolsStyleCSS(input_api, output_api):
Tim van der Lippefb023462020-08-21 14:10:06 +0100230 results = [output_api.PresubmitNotifyResult('CSS style check:')]
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200231 lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
232 'scripts', 'test',
233 'run_lint_check_css.py')
234
235 front_end_directory = input_api.os_path.join(
236 input_api.PresubmitLocalPath(), 'front_end')
237 default_linted_directories = [front_end_directory]
238
239 scripts_directory = input_api.os_path.join(input_api.PresubmitLocalPath(),
240 'scripts')
241
242 stylelint_related_files = [
243 input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules',
244 'stylelint'),
245 input_api.os_path.join(input_api.PresubmitLocalPath(),
246 '.stylelintrc.json'),
247 input_api.os_path.join(input_api.PresubmitLocalPath(),
248 '.stylelintignore'),
249 input_api.os_path.join(scripts_directory, 'test',
250 'run_lint_check_css.py'),
251 ]
252
253 lint_config_files = _getAffectedFiles(input_api, stylelint_related_files,
254 [],
255 ['.json', '.py', '.stylelintignore'])
256
Mathias Bynens0ec56612020-06-19 09:14:03 +0200257 should_bail_out, files_to_lint = _getFilesToLint(
258 input_api, output_api, lint_config_files, default_linted_directories,
259 ['.css'], results)
260 if should_bail_out:
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200261 return results
262
263 return _ExecuteSubProcess(input_api, output_api, lint_path, files_to_lint,
264 results)
265
266
Joel Einbinderf6f86b62019-06-10 23:19:12 +0000267def _CheckOptimizeSVGHashes(input_api, output_api):
Tim van der Lippefb023462020-08-21 14:10:06 +0100268 if not input_api.platform.startswith('linux'):
269 return [output_api.PresubmitNotifyResult('Skipping SVG hash check')]
270
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200271 results = [
272 output_api.PresubmitNotifyResult('Running SVG optimization check:')
273 ]
Blink Reformat4c46d092018-04-07 15:32:37 +0000274
275 original_sys_path = sys.path
276 try:
277 sys.path = sys.path + [input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'build')]
278 import devtools_file_hashes
279 finally:
280 sys.path = original_sys_path
281
282 absolute_local_paths = [af.AbsoluteLocalPath() for af in input_api.AffectedFiles(include_deletes=False)]
Yang Guo75beda92019-10-28 08:29:25 +0100283 images_src_path = input_api.os_path.join('devtools', 'front_end', 'Images', 'src')
284 image_source_file_paths = [path for path in absolute_local_paths if images_src_path in path and path.endswith('.svg')]
285 image_sources_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end', 'Images', 'src')
286 hashes_file_name = 'optimize_svg.hashes'
Blink Reformat4c46d092018-04-07 15:32:37 +0000287 hashes_file_path = input_api.os_path.join(image_sources_path, hashes_file_name)
288 invalid_hash_file_paths = devtools_file_hashes.files_with_invalid_hashes(hashes_file_path, image_source_file_paths)
289 if len(invalid_hash_file_paths) == 0:
Brandon Goddarde7028672020-01-30 09:31:04 -0800290 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000291 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 +0100292 file_paths_str = ', '.join(invalid_hash_file_names)
293 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 -0800294 results.append(output_api.PresubmitError(error_message))
295 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000296
297
Mathias Bynens032591d2019-10-21 11:51:31 +0200298
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000299def _CheckGeneratedFiles(input_api, output_api):
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000300 v8_directory_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'v8')
301 blink_directory_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party', 'blink')
302 protocol_location = input_api.os_path.join(blink_directory_path, 'public', 'devtools_protocol')
303 scripts_build_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'build')
Tim van der Lippe5d2d79b2020-03-23 11:45:04 +0000304 scripts_generated_output_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end', 'generated')
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000305
306 generated_aria_path = input_api.os_path.join(scripts_build_path, 'generate_aria.py')
307 generated_supported_css_path = input_api.os_path.join(scripts_build_path, 'generate_supported_css.py')
308 generated_protocol_path = input_api.os_path.join(scripts_build_path, 'code_generator_frontend.py')
309 concatenate_protocols_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party', 'inspector_protocol',
310 'concatenate_protocols.py')
311
312 affected_files = _getAffectedFiles(input_api, [
313 v8_directory_path,
314 blink_directory_path,
315 input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party', 'pyjson5'),
316 generated_aria_path,
317 generated_supported_css_path,
318 concatenate_protocols_path,
319 generated_protocol_path,
Tim van der Lippe5d2d79b2020-03-23 11:45:04 +0000320 scripts_generated_output_path,
321 ], [], ['.pdl', '.json5', '.py', '.js'])
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000322
323 if len(affected_files) == 0:
Tim van der Lippefb023462020-08-21 14:10:06 +0100324 return [
325 output_api.PresubmitNotifyResult(
326 'No affected files for generated files check')
327 ]
Tim van der Lippeb3b90762020-03-04 15:21:52 +0000328
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000329 results = [output_api.PresubmitNotifyResult('Running Generated Files Check:')]
Tim van der Lippeb0d65f12020-03-05 12:15:24 +0000330 generate_protocol_resources_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'deps',
331 'generate_protocol_resources.py')
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000332
Tim van der Lippeb0d65f12020-03-05 12:15:24 +0000333 return _ExecuteSubProcess(input_api, output_api, generate_protocol_resources_path, [], results)
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000334
335
Tim van der Lippe5279f842020-01-14 16:26:38 +0000336def _CheckNoUncheckedFiles(input_api, output_api):
337 results = []
338 process = input_api.subprocess.Popen(['git', 'diff', '--exit-code'],
339 stdout=input_api.subprocess.PIPE,
340 stderr=input_api.subprocess.STDOUT)
341 out, _ = process.communicate()
342 if process.returncode != 0:
Jack Franklin324f3042020-09-03 11:28:29 +0100343 files_changed_process = input_api.subprocess.Popen(
344 ['git', 'diff', '--name-only'],
345 stdout=input_api.subprocess.PIPE,
346 stderr=input_api.subprocess.STDOUT)
Tim van der Lippe9bb1cf62020-03-06 16:17:02 +0000347 files_changed, _ = files_changed_process.communicate()
348
349 return [
350 output_api.PresubmitError('You have changed files that need to be committed:'),
351 output_api.PresubmitError(files_changed)
352 ]
Tim van der Lippe5279f842020-01-14 16:26:38 +0000353 return []
354
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000355def _CheckForTooLargeFiles(input_api, output_api):
Christy Chen1ab87e02020-01-30 16:32:16 -0800356 """Avoid large files, especially binary files, in the repository since
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000357 git doesn't scale well for those. They will be in everyone's repo
358 clones forever, forever making Chromium slower to clone and work
359 with."""
Christy Chen1ab87e02020-01-30 16:32:16 -0800360 # Uploading files to cloud storage is not trivial so we don't want
361 # to set the limit too low, but the upper limit for "normal" large
362 # files seems to be 1-2 MB, with a handful around 5-8 MB, so
363 # anything over 20 MB is exceptional.
364 TOO_LARGE_FILE_SIZE_LIMIT = 20 * 1024 * 1024 # 10 MB
365 too_large_files = []
366 for f in input_api.AffectedFiles():
367 # Check both added and modified files (but not deleted files).
368 if f.Action() in ('A', 'M'):
369 size = input_api.os_path.getsize(f.AbsoluteLocalPath())
370 if size > TOO_LARGE_FILE_SIZE_LIMIT:
371 too_large_files.append("%s: %d bytes" % (f.LocalPath(), size))
372 if too_large_files:
373 message = (
374 'Do not commit large files to git since git scales badly for those.\n' +
375 'Instead put the large files in cloud storage and use DEPS to\n' +
376 'fetch them.\n' + '\n'.join(too_large_files)
377 )
378 return [output_api.PresubmitError(
379 'Too large files found in commit', long_text=message + '\n')]
380 else:
381 return []
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000382
Tim van der Lippe5279f842020-01-14 16:26:38 +0000383
Jack Franklin324f3042020-09-03 11:28:29 +0100384def _CheckComponentBridgesUpToDate(input_api, output_api):
385 # Regenerate all bridge files - if any are out of date it will cause the git diff check to fail.
386 results = []
387
388 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
389 'scripts', 'component_bridges', 'gen',
390 'regenerate-all-bridges.js')
391
392 tsc_arguments = ['-p', 'scripts/component_bridges/tsconfig.json']
393 results.extend(
394 _checkWithTypeScript(input_api, output_api, tsc_arguments, script_path,
395 ['--silent']))
396 return results
397
398
Tim van der Lippef8a87092020-09-14 13:01:18 +0100399def _RunCannedChecks(input_api, output_api):
400 results = []
401 results.extend(
402 input_api.canned_checks.CheckOwnersFormat(input_api, output_api))
403 results.extend(input_api.canned_checks.CheckOwners(input_api, output_api))
404 results.extend(
405 input_api.canned_checks.CheckChangeHasNoCrAndHasOnlyOneEol(
406 input_api, output_api))
407 results.extend(
408 input_api.canned_checks.CheckChangeHasNoStrayWhitespace(
409 input_api, output_api))
410 results.extend(
411 input_api.canned_checks.CheckGenderNeutral(input_api, output_api))
412 return results
413
414
Yang Guo4fd355c2019-09-19 10:59:03 +0200415def _CommonChecks(input_api, output_api):
Mathias Bynens032591d2019-10-21 11:51:31 +0200416 """Checks common to both upload and commit."""
417 results = []
Mathias Bynens011b0072020-08-05 10:17:35 +0200418 results.extend(
419 input_api.canned_checks.CheckAuthorizedAuthor(
420 input_api, output_api, bot_allowlist=[AUTOROLL_ACCOUNT]))
Blink Reformat4c46d092018-04-07 15:32:37 +0000421 results.extend(_CheckBuildGN(input_api, output_api))
Brandon Goddard33104372020-08-13 08:49:23 -0700422 results.extend(_CheckExperimentTelemetry(input_api, output_api))
Tim van der Lippe4d004ec2020-03-03 18:32:01 +0000423 results.extend(_CheckGeneratedFiles(input_api, output_api))
Tim van der Lippee4bdd742019-12-17 16:40:16 +0100424 results.extend(_CheckJSON(input_api, output_api))
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200425 results.extend(_CheckDevToolsStyleJS(input_api, output_api))
426 results.extend(_CheckDevToolsStyleCSS(input_api, output_api))
Tim van der Lippe5497d482020-01-14 15:27:30 +0000427 results.extend(_CheckFormat(input_api, output_api))
Joel Einbinderf6f86b62019-06-10 23:19:12 +0000428 results.extend(_CheckOptimizeSVGHashes(input_api, output_api))
Yang Guoa7845d52019-10-31 11:30:23 +0100429 results.extend(_CheckChangesAreExclusiveToDirectory(input_api, output_api))
Jack Franklin324f3042020-09-03 11:28:29 +0100430 results.extend(_CheckComponentBridgesUpToDate(input_api, output_api))
Tim van der Lippef8a87092020-09-14 13:01:18 +0100431 # Run the canned checks from `depot_tools` after the custom DevTools checks.
432 # The canned checks for example check that lines have line endings. The
433 # DevTools presubmit checks automatically fix these issues. If we would run
434 # the canned checks before the DevTools checks, they would erroneously conclude
435 # that there are issues in the code. Since the canned checks are allowed to be
436 # ignored, a confusing message is shown that asks if the failed presubmit can
437 # be continued regardless. By fixing the issues before we reach the canned checks,
438 # we don't show the message to suppress these errors, which would otherwise be
439 # causing CQ to fail.
440 results.extend(_RunCannedChecks(input_api, output_api))
Tim van der Lippe5279f842020-01-14 16:26:38 +0000441 results.extend(_CheckNoUncheckedFiles(input_api, output_api))
Tim van der Lippe8fdda112020-01-27 11:27:06 +0000442 results.extend(_CheckForTooLargeFiles(input_api, output_api))
Blink Reformat4c46d092018-04-07 15:32:37 +0000443 return results
444
445
Liviu Raud614e092020-01-08 10:56:33 +0100446def CheckChangeOnUpload(input_api, output_api):
447 results = []
448 results.extend(_CommonChecks(input_api, output_api))
449 results.extend(_CheckDevtoolsLocalization(input_api, output_api))
450 return results
451
452
Blink Reformat4c46d092018-04-07 15:32:37 +0000453def CheckChangeOnCommit(input_api, output_api):
Mandy Chenf0fbdbe2019-08-22 23:58:37 +0000454 results = []
Yang Guo4fd355c2019-09-19 10:59:03 +0200455 results.extend(_CommonChecks(input_api, output_api))
e52a82bdfb5106bd658c2c5ea465e200594be1e2019-10-29 16:02:46 -0700456 results.extend(_CheckDevtoolsLocalization(input_api, output_api, True))
Mathias Bynens032591d2019-10-21 11:51:31 +0200457 results.extend(input_api.canned_checks.CheckChangeHasDescription(input_api, output_api))
Mandy Chenf0fbdbe2019-08-22 23:58:37 +0000458 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000459
460
Mandy Chena6be46a2019-07-09 17:06:27 +0000461def _getAffectedFiles(input_api, parent_directories, excluded_actions, accepted_endings): # pylint: disable=invalid-name
Yang Guo75beda92019-10-28 08:29:25 +0100462 """Return absolute file paths of affected files (not due to an excluded action)
Mandy Chena6be46a2019-07-09 17:06:27 +0000463 under a parent directory with an accepted file ending.
Yang Guo75beda92019-10-28 08:29:25 +0100464 """
Mandy Chena6be46a2019-07-09 17:06:27 +0000465 local_paths = [
466 f.AbsoluteLocalPath() for f in input_api.AffectedFiles() if all(f.Action() != action for action in excluded_actions)
467 ]
468 affected_files = [
Tim van der Lippefdbd42e2020-04-07 15:14:36 +0100469 file_name for file_name in local_paths if any(parent_directory in file_name for parent_directory in parent_directories) and
470 (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 +0000471 ]
472 return affected_files
473
474
Tim van der Lippec4617122020-03-06 16:24:19 +0000475def _checkWithNodeScript(input_api, output_api, script_path, script_arguments=[]): # pylint: disable=invalid-name
Blink Reformat4c46d092018-04-07 15:32:37 +0000476 original_sys_path = sys.path
477 try:
Yang Guo75beda92019-10-28 08:29:25 +0100478 sys.path = sys.path + [input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')]
Yang Guod8176982019-10-04 20:30:35 +0000479 import devtools_paths
Blink Reformat4c46d092018-04-07 15:32:37 +0000480 finally:
481 sys.path = original_sys_path
482
Tim van der Lippec4617122020-03-06 16:24:19 +0000483 return _ExecuteSubProcess(input_api, output_api, [devtools_paths.node_path(), script_path], script_arguments, [])
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200484
485
Jack Franklin324f3042020-09-03 11:28:29 +0100486def _checkWithTypeScript(input_api,
487 output_api,
488 tsc_arguments,
489 script_path,
490 script_arguments=[]): # pylint: disable=invalid-name
491 original_sys_path = sys.path
492 try:
493 sys.path = sys.path + [
494 input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')
495 ]
496 import devtools_paths
497 finally:
498 sys.path = original_sys_path
499
500 # First run tsc to compile the TS script that we then run in the _ExecuteSubProcess call
501 tsc_compiler_process = input_api.subprocess.Popen(
502 [
503 devtools_paths.node_path(),
504 devtools_paths.typescript_compiler_path()
505 ] + tsc_arguments,
506 stdout=input_api.subprocess.PIPE,
507 stderr=input_api.subprocess.STDOUT)
508
509 out, _ = tsc_compiler_process.communicate()
510 if tsc_compiler_process.returncode != 0:
511 return [
512 output_api.PresubmitError('Error compiling briges regenerator:\n' +
513 str(out))
514 ]
515
516 return _checkWithNodeScript(input_api, output_api, script_path,
517 script_arguments)
518
519
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200520def _getFilesToLint(input_api, output_api, lint_config_files,
521 default_linted_directories, accepted_endings, results):
Mathias Bynens0ec56612020-06-19 09:14:03 +0200522 run_full_check = False
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200523 files_to_lint = []
524
525 # We are changing the lint configuration; run the full check.
526 if len(lint_config_files) is not 0:
527 results.append(
528 output_api.PresubmitNotifyResult('Running full lint check'))
Mathias Bynens0ec56612020-06-19 09:14:03 +0200529 run_full_check = True
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200530 else:
531 # Only run the linter on files that are relevant, to save PRESUBMIT time.
532 files_to_lint = _getAffectedFiles(input_api,
533 default_linted_directories, ['D'],
534 accepted_endings)
535
Paul Lewis2b9224f2020-09-08 18:13:10 +0100536 # Exclude front_end/third_party files.
537 files_to_lint = filter(lambda path: "third_party" not in path,
538 files_to_lint)
539
Mathias Bynens1b2c5e42020-06-18 08:29:21 +0200540 if len(files_to_lint) is 0:
541 results.append(
542 output_api.PresubmitNotifyResult(
543 'No affected files for lint check'))
544
Mathias Bynens0ec56612020-06-19 09:14:03 +0200545 should_bail_out = len(files_to_lint) is 0 and not run_full_check
546 return should_bail_out, files_to_lint