blob: 4d2046ac8616e5208032d266c04792d98585a3dc [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
36
Yang Guoa7845d52019-10-31 11:30:23 +010037EXCLUSIVE_CHANGE_DIRECTORIES = [
38 [ 'third_party', 'v8' ],
39 [ 'node_modules' ],
40 [ 'OWNERS' ],
41]
42
Liviu Raufd2e3212019-12-18 16:38:20 +010043AUTOROLL_ACCOUNT = "devtools-ci-autoroll-builder@chops-service-accounts.iam.gserviceaccount.com"
Mathias Bynensa0a6e292019-12-17 13:24:08 +010044
Yang Guoa7845d52019-10-31 11:30:23 +010045def _CheckChangesAreExclusiveToDirectory(input_api, output_api):
Tim van der Lippebc42a632019-11-28 14:22:55 +000046 if input_api.change.DISABLE_THIRD_PARTY_CHECK != None:
47 return []
48
Yang Guoa7845d52019-10-31 11:30:23 +010049 def IsParentDir(file, dir):
50 while file != '':
51 if file == dir:
52 return True
53 file = input_api.os_path.dirname(file)
Yang Guoa7845d52019-10-31 11:30:23 +010054 return False
55
56 def FileIsInDir(file, dirs):
57 for dir in dirs:
58 if IsParentDir(file, dir):
59 return True
60
61 affected_files = input_api.LocalPaths()
Yang Guoa7845d52019-10-31 11:30:23 +010062 num_affected = len(affected_files)
63 for dirs in EXCLUSIVE_CHANGE_DIRECTORIES:
Paul Lewis14effba2019-12-02 14:56:40 +000064 dir_list = ', '.join(dirs)
Yang Guoa7845d52019-10-31 11:30:23 +010065 affected_in_dir = filter(lambda f: FileIsInDir(f, dirs), affected_files)
66 num_in_dir = len(affected_in_dir)
67 if num_in_dir == 0:
68 continue
Tim van der Lippeebb94a92019-11-19 17:07:53 +000069 # Addition of new third_party folders must have a new entry in `.gitignore`
70 if '.gitignore' in affected_files:
71 num_in_dir = num_in_dir + 1
Yang Guoa7845d52019-10-31 11:30:23 +010072 if num_in_dir < num_affected:
73 return [
Tim van der Lippebc42a632019-11-28 14:22:55 +000074 output_api
Paul Lewis14effba2019-12-02 14:56:40 +000075 .PresubmitError(('CLs that affect files in "%s" should be limited to these files/directories.' % dir_list) +
76 ' You can disable this check by adding DISABLE_THIRD_PARTY_CHECK=<reason> to your commit message')
Yang Guoa7845d52019-10-31 11:30:23 +010077 ]
78 return []
79
Blink Reformat4c46d092018-04-07 15:32:37 +000080
81def _CheckBuildGN(input_api, output_api):
Yang Guo75beda92019-10-28 08:29:25 +010082 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'check_gn.js')
Blink Reformat4c46d092018-04-07 15:32:37 +000083 return _checkWithNodeScript(input_api, output_api, script_path)
84
85
Tim van der Lippee4bdd742019-12-17 16:40:16 +010086def _CheckJSON(input_api, output_api):
87 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'json_validator', 'validate_module_json.js')
88 return _checkWithNodeScript(input_api, output_api, script_path)
89
90
Paul Lewis21fb3492020-01-14 15:28:22 +000091def _CheckUnitTests(input_api, output_api):
92 unittest_root = input_api.os_path.join(input_api.PresubmitLocalPath(), 'test')
93 affected_unittest_files = _getAffectedFiles(input_api, [unittest_root], ['D'], ['.ts'])
94 if len(affected_unittest_files) == 0:
95 return []
96
97 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'test', 'check_for_unittest_onlys.js')
98 return _checkWithNodeScript(input_api, output_api, script_path, affected_unittest_files)
99
100
Blink Reformat4c46d092018-04-07 15:32:37 +0000101def _CheckFormat(input_api, output_api):
102
103 def popen(args):
104 return input_api.subprocess.Popen(args=args, stdout=input_api.subprocess.PIPE, stderr=input_api.subprocess.STDOUT)
105
106 affected_files = _getAffectedJSFiles(input_api)
107 if len(affected_files) == 0:
108 return []
109 original_sys_path = sys.path
110 try:
Yang Guo75beda92019-10-28 08:29:25 +0100111 sys.path = sys.path + [input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')]
Yang Guod8176982019-10-04 20:30:35 +0000112 import devtools_paths
Blink Reformat4c46d092018-04-07 15:32:37 +0000113 finally:
114 sys.path = original_sys_path
115
116 ignore_files = []
117 eslint_ignore_path = input_api.os_path.join(input_api.PresubmitLocalPath(), '.eslintignore')
118 with open(eslint_ignore_path, 'r') as ignore_manifest:
119 for line in ignore_manifest:
Ingvar Stepanyanb532f3f2019-10-22 12:32:59 +0100120 ignore_files.append(input_api.os_path.normpath(line.strip()))
Mathias Bynens032591d2019-10-21 11:51:31 +0200121 formattable_files = [
122 affected_file for affected_file in affected_files if all(ignore_file not in affected_file for ignore_file in ignore_files)
123 ]
Blink Reformat4c46d092018-04-07 15:32:37 +0000124 if len(formattable_files) == 0:
125 return []
126
127 check_formatting_process = popen(['git', 'cl', 'format', '--js', '--dry-run'] + formattable_files)
128 check_formatting_process.communicate()
129 if check_formatting_process.returncode == 0:
130 return []
131
132 format_args = ['git', 'cl', 'format', '--js'] + formattable_files
133 format_process = popen(format_args)
134 format_out, _ = format_process.communicate()
135 if format_process.returncode != 0:
136 return [output_api.PresubmitError(format_out)]
137
Blink Reformat4c46d092018-04-07 15:32:37 +0000138 return [
Yang Guo5a805ab2019-10-31 13:53:28 +0100139 output_api.PresubmitError('ERROR: Found formatting violations.\n'
Yang Guo75beda92019-10-28 08:29:25 +0100140 'Ran clang-format on diff\n'
141 'Use git status to check the formatting changes'),
Blink Reformat4c46d092018-04-07 15:32:37 +0000142 output_api.PresubmitError(format_out),
143 ]
144
145
e52a82bdfb5106bd658c2c5ea465e200594be1e2019-10-29 16:02:46 -0700146def _CheckDevtoolsLocalization(input_api, output_api, check_all_files=False): # pylint: disable=invalid-name
Mandy Chene997da72019-08-22 23:50:19 +0000147 devtools_root = input_api.PresubmitLocalPath()
vidorteg2b675b02019-11-25 09:51:28 -0800148 script_path = input_api.os_path.join(devtools_root, 'scripts', 'test', 'run_localization_check.py')
Paul Lewis954a5a92019-11-20 15:33:49 +0000149 if check_all_files == True:
vidorteg2b675b02019-11-25 09:51:28 -0800150 # Scan all files and fix any errors
vidorteg75c025e2019-11-25 09:52:43 -0800151 args = ['--autofix', '--all']
Paul Lewis954a5a92019-11-20 15:33:49 +0000152 else:
vidorteg2b675b02019-11-25 09:51:28 -0800153 devtools_front_end = input_api.os_path.join(devtools_root, 'front_end')
154 affected_front_end_files = _getAffectedFiles(input_api, [devtools_front_end], ['D'],
155 ['.js', '.grdp', '.grd', 'module.json'])
156
157 if len(affected_front_end_files) == 0:
158 return []
159 # Scan only added or modified files with specific extensions.
160 args = [
161 '--autofix',
162 '--files',
163 ] + affected_front_end_files
164 process = input_api.subprocess.Popen(
165 [input_api.python_executable, script_path] + args, stdout=input_api.subprocess.PIPE, stderr=input_api.subprocess.STDOUT)
166 out, _ = process.communicate()
167 if process.returncode != 0:
168 return [output_api.PresubmitError(out)]
169 return [output_api.PresubmitNotifyResult(out)]
Mandy Chen465b4f72019-03-21 22:52:54 +0000170
171
Blink Reformat4c46d092018-04-07 15:32:37 +0000172def _CheckDevtoolsStyle(input_api, output_api):
Yang Guo75beda92019-10-28 08:29:25 +0100173 lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'test', 'run_lint_check.py')
Tim van der Lippec85c3122019-09-19 11:27:04 +0000174 process = input_api.subprocess.Popen([input_api.python_executable, lint_path],
175 stdout=input_api.subprocess.PIPE,
176 stderr=input_api.subprocess.STDOUT)
177 out, _ = process.communicate()
178 if process.returncode != 0:
179 return [output_api.PresubmitError(out)]
180 return [output_api.PresubmitNotifyResult(out)]
Blink Reformat4c46d092018-04-07 15:32:37 +0000181
182
Joel Einbinderf6f86b62019-06-10 23:19:12 +0000183def _CheckOptimizeSVGHashes(input_api, output_api):
Blink Reformat4c46d092018-04-07 15:32:37 +0000184 if not input_api.platform.startswith('linux'):
185 return []
186
187 original_sys_path = sys.path
188 try:
189 sys.path = sys.path + [input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'build')]
190 import devtools_file_hashes
191 finally:
192 sys.path = original_sys_path
193
194 absolute_local_paths = [af.AbsoluteLocalPath() for af in input_api.AffectedFiles(include_deletes=False)]
Yang Guo75beda92019-10-28 08:29:25 +0100195 images_src_path = input_api.os_path.join('devtools', 'front_end', 'Images', 'src')
196 image_source_file_paths = [path for path in absolute_local_paths if images_src_path in path and path.endswith('.svg')]
197 image_sources_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end', 'Images', 'src')
198 hashes_file_name = 'optimize_svg.hashes'
Blink Reformat4c46d092018-04-07 15:32:37 +0000199 hashes_file_path = input_api.os_path.join(image_sources_path, hashes_file_name)
200 invalid_hash_file_paths = devtools_file_hashes.files_with_invalid_hashes(hashes_file_path, image_source_file_paths)
201 if len(invalid_hash_file_paths) == 0:
202 return []
203 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 +0100204 file_paths_str = ', '.join(invalid_hash_file_names)
205 error_message = 'The following SVG files should be optimized using optimize_svg_images script before uploading: \n - %s' % file_paths_str
Blink Reformat4c46d092018-04-07 15:32:37 +0000206 return [output_api.PresubmitError(error_message)]
207
208
209def _CheckCSSViolations(input_api, output_api):
210 results = []
211 for f in input_api.AffectedFiles(include_deletes=False):
Yang Guo75beda92019-10-28 08:29:25 +0100212 if not f.LocalPath().endswith('.css'):
Blink Reformat4c46d092018-04-07 15:32:37 +0000213 continue
214 for line_number, line in f.ChangedContents():
Yang Guo75beda92019-10-28 08:29:25 +0100215 if '/deep/' in line:
216 results.append(output_api.PresubmitError(('%s:%d uses /deep/ selector') % (f.LocalPath(), line_number)))
217 if '::shadow' in line:
218 results.append(output_api.PresubmitError(('%s:%d uses ::shadow selector') % (f.LocalPath(), line_number)))
Blink Reformat4c46d092018-04-07 15:32:37 +0000219 return results
220
Mathias Bynens032591d2019-10-21 11:51:31 +0200221
Tim van der Lippe5279f842020-01-14 16:26:38 +0000222def _CheckNoUncheckedFiles(input_api, output_api):
223 results = []
224 process = input_api.subprocess.Popen(['git', 'diff', '--exit-code'],
225 stdout=input_api.subprocess.PIPE,
226 stderr=input_api.subprocess.STDOUT)
227 out, _ = process.communicate()
228 if process.returncode != 0:
229 return [output_api.PresubmitError('You have changed files that need to be committed.')]
230 return []
231
232
Yang Guo4fd355c2019-09-19 10:59:03 +0200233def _CommonChecks(input_api, output_api):
Mathias Bynens032591d2019-10-21 11:51:31 +0200234 """Checks common to both upload and commit."""
235 results = []
Liviu Raufd2e3212019-12-18 16:38:20 +0100236 results.extend(input_api.canned_checks.CheckAuthorizedAuthor(input_api, output_api,
237 bot_whitelist=[AUTOROLL_ACCOUNT]
238 ))
Mathias Bynens032591d2019-10-21 11:51:31 +0200239 results.extend(input_api.canned_checks.CheckOwnersFormat(input_api, output_api))
240 results.extend(input_api.canned_checks.CheckOwners(input_api, output_api))
241 results.extend(input_api.canned_checks.CheckChangeHasNoCrAndHasOnlyOneEol(input_api, output_api))
242 results.extend(input_api.canned_checks.CheckChangeHasNoStrayWhitespace(input_api, output_api))
243 results.extend(input_api.canned_checks.CheckGenderNeutral(input_api, output_api))
Blink Reformat4c46d092018-04-07 15:32:37 +0000244 results.extend(_CheckBuildGN(input_api, output_api))
Tim van der Lippee4bdd742019-12-17 16:40:16 +0100245 results.extend(_CheckJSON(input_api, output_api))
Blink Reformat4c46d092018-04-07 15:32:37 +0000246 results.extend(_CheckDevtoolsStyle(input_api, output_api))
Tim van der Lippe5497d482020-01-14 15:27:30 +0000247 results.extend(_CheckFormat(input_api, output_api))
Joel Einbinderf6f86b62019-06-10 23:19:12 +0000248 results.extend(_CheckOptimizeSVGHashes(input_api, output_api))
Blink Reformat4c46d092018-04-07 15:32:37 +0000249 results.extend(_CheckCSSViolations(input_api, output_api))
Yang Guoa7845d52019-10-31 11:30:23 +0100250 results.extend(_CheckChangesAreExclusiveToDirectory(input_api, output_api))
Paul Lewis21fb3492020-01-14 15:28:22 +0000251 results.extend(_CheckUnitTests(input_api, output_api))
Tim van der Lippe5279f842020-01-14 16:26:38 +0000252 results.extend(_CheckNoUncheckedFiles(input_api, output_api))
Blink Reformat4c46d092018-04-07 15:32:37 +0000253 return results
254
255
Liviu Raud614e092020-01-08 10:56:33 +0100256def CheckChangeOnUpload(input_api, output_api):
257 results = []
258 results.extend(_CommonChecks(input_api, output_api))
259 results.extend(_CheckDevtoolsLocalization(input_api, output_api))
260 return results
261
262
Blink Reformat4c46d092018-04-07 15:32:37 +0000263def CheckChangeOnCommit(input_api, output_api):
Mandy Chenf0fbdbe2019-08-22 23:58:37 +0000264 results = []
Yang Guo4fd355c2019-09-19 10:59:03 +0200265 results.extend(_CommonChecks(input_api, output_api))
e52a82bdfb5106bd658c2c5ea465e200594be1e2019-10-29 16:02:46 -0700266 results.extend(_CheckDevtoolsLocalization(input_api, output_api, True))
Mathias Bynens032591d2019-10-21 11:51:31 +0200267 results.extend(input_api.canned_checks.CheckChangeHasDescription(input_api, output_api))
Mandy Chenf0fbdbe2019-08-22 23:58:37 +0000268 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000269
270
Mandy Chena6be46a2019-07-09 17:06:27 +0000271def _getAffectedFiles(input_api, parent_directories, excluded_actions, accepted_endings): # pylint: disable=invalid-name
Yang Guo75beda92019-10-28 08:29:25 +0100272 """Return absolute file paths of affected files (not due to an excluded action)
Mandy Chena6be46a2019-07-09 17:06:27 +0000273 under a parent directory with an accepted file ending.
Yang Guo75beda92019-10-28 08:29:25 +0100274 """
Mandy Chena6be46a2019-07-09 17:06:27 +0000275 local_paths = [
276 f.AbsoluteLocalPath() for f in input_api.AffectedFiles() if all(f.Action() != action for action in excluded_actions)
277 ]
278 affected_files = [
279 file_name for file_name in local_paths
280 if any(parent_directory in file_name for parent_directory in parent_directories) and any(
281 file_name.endswith(accepted_ending) for accepted_ending in accepted_endings)
282 ]
283 return affected_files
284
285
Blink Reformat4c46d092018-04-07 15:32:37 +0000286def _getAffectedFrontEndFiles(input_api):
Blink Reformat4c46d092018-04-07 15:32:37 +0000287 devtools_root = input_api.PresubmitLocalPath()
Yang Guo75beda92019-10-28 08:29:25 +0100288 devtools_front_end = input_api.os_path.join(devtools_root, 'front_end')
289 affected_front_end_files = _getAffectedFiles(input_api, [devtools_front_end], ['D'], ['.js'])
Blink Reformat4c46d092018-04-07 15:32:37 +0000290 return [input_api.os_path.relpath(file_name, devtools_root) for file_name in affected_front_end_files]
291
292
293def _getAffectedJSFiles(input_api):
Blink Reformat4c46d092018-04-07 15:32:37 +0000294 devtools_root = input_api.PresubmitLocalPath()
Yang Guo75beda92019-10-28 08:29:25 +0100295 devtools_front_end = input_api.os_path.join(devtools_root, 'front_end')
296 devtools_scripts = input_api.os_path.join(devtools_root, 'scripts')
297 affected_js_files = _getAffectedFiles(input_api, [devtools_front_end, devtools_scripts], ['D'], ['.js'])
Blink Reformat4c46d092018-04-07 15:32:37 +0000298 return [input_api.os_path.relpath(file_name, devtools_root) for file_name in affected_js_files]
299
300
Lorne Mitchellc56ff2d2019-05-28 23:35:03 +0000301def _checkWithNodeScript(input_api, output_api, script_path, script_arguments=None): # pylint: disable=invalid-name
Blink Reformat4c46d092018-04-07 15:32:37 +0000302 original_sys_path = sys.path
303 try:
Yang Guo75beda92019-10-28 08:29:25 +0100304 sys.path = sys.path + [input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')]
Yang Guod8176982019-10-04 20:30:35 +0000305 import devtools_paths
Blink Reformat4c46d092018-04-07 15:32:37 +0000306 finally:
307 sys.path = original_sys_path
308
Yang Guod8176982019-10-04 20:30:35 +0000309 node_path = devtools_paths.node_path()
Blink Reformat4c46d092018-04-07 15:32:37 +0000310
Lorne Mitchellc56ff2d2019-05-28 23:35:03 +0000311 if script_arguments is None:
312 script_arguments = []
Mandy Chen465b4f72019-03-21 22:52:54 +0000313
Blink Reformat4c46d092018-04-07 15:32:37 +0000314 process = input_api.subprocess.Popen(
Lorne Mitchellc56ff2d2019-05-28 23:35:03 +0000315 [node_path, script_path] + script_arguments, stdout=input_api.subprocess.PIPE, stderr=input_api.subprocess.STDOUT)
Blink Reformat4c46d092018-04-07 15:32:37 +0000316 out, _ = process.communicate()
317
318 if process.returncode != 0:
319 return [output_api.PresubmitError(out)]
320 return [output_api.PresubmitNotifyResult(out)]