blob: cd350d2c09e4ba9e7219561371e926cee223447c [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
Mathias Bynensa0a6e292019-12-17 13:24:08 +010043# Bypass the AUTHORS check for these accounts.
44_KNOWN_ROBOTS = set('%s-autoroll-builder@chops-service-accounts.iam.gserviceaccount.com' % s for s in ('devtools-ci')) | set(
45 '%s@appspot.gserviceaccount.com' % s for s in ('findit-for-me',))
46
47
Yang Guoa7845d52019-10-31 11:30:23 +010048def _CheckChangesAreExclusiveToDirectory(input_api, output_api):
Tim van der Lippebc42a632019-11-28 14:22:55 +000049 if input_api.change.DISABLE_THIRD_PARTY_CHECK != None:
50 return []
51
Yang Guoa7845d52019-10-31 11:30:23 +010052 def IsParentDir(file, dir):
53 while file != '':
54 if file == dir:
55 return True
56 file = input_api.os_path.dirname(file)
Yang Guoa7845d52019-10-31 11:30:23 +010057 return False
58
59 def FileIsInDir(file, dirs):
60 for dir in dirs:
61 if IsParentDir(file, dir):
62 return True
63
64 affected_files = input_api.LocalPaths()
Yang Guoa7845d52019-10-31 11:30:23 +010065 num_affected = len(affected_files)
66 for dirs in EXCLUSIVE_CHANGE_DIRECTORIES:
Paul Lewis14effba2019-12-02 14:56:40 +000067 dir_list = ', '.join(dirs)
Yang Guoa7845d52019-10-31 11:30:23 +010068 affected_in_dir = filter(lambda f: FileIsInDir(f, dirs), affected_files)
69 num_in_dir = len(affected_in_dir)
70 if num_in_dir == 0:
71 continue
Tim van der Lippeebb94a92019-11-19 17:07:53 +000072 # Addition of new third_party folders must have a new entry in `.gitignore`
73 if '.gitignore' in affected_files:
74 num_in_dir = num_in_dir + 1
Yang Guoa7845d52019-10-31 11:30:23 +010075 if num_in_dir < num_affected:
76 return [
Tim van der Lippebc42a632019-11-28 14:22:55 +000077 output_api
Paul Lewis14effba2019-12-02 14:56:40 +000078 .PresubmitError(('CLs that affect files in "%s" should be limited to these files/directories.' % dir_list) +
79 ' You can disable this check by adding DISABLE_THIRD_PARTY_CHECK=<reason> to your commit message')
Yang Guoa7845d52019-10-31 11:30:23 +010080 ]
81 return []
82
Blink Reformat4c46d092018-04-07 15:32:37 +000083
84def _CheckBuildGN(input_api, output_api):
Yang Guo75beda92019-10-28 08:29:25 +010085 script_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'check_gn.js')
Blink Reformat4c46d092018-04-07 15:32:37 +000086 return _checkWithNodeScript(input_api, output_api, script_path)
87
88
89def _CheckFormat(input_api, output_api):
90
91 def popen(args):
92 return input_api.subprocess.Popen(args=args, stdout=input_api.subprocess.PIPE, stderr=input_api.subprocess.STDOUT)
93
94 affected_files = _getAffectedJSFiles(input_api)
95 if len(affected_files) == 0:
96 return []
97 original_sys_path = sys.path
98 try:
Yang Guo75beda92019-10-28 08:29:25 +010099 sys.path = sys.path + [input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')]
Yang Guod8176982019-10-04 20:30:35 +0000100 import devtools_paths
Blink Reformat4c46d092018-04-07 15:32:37 +0000101 finally:
102 sys.path = original_sys_path
103
104 ignore_files = []
105 eslint_ignore_path = input_api.os_path.join(input_api.PresubmitLocalPath(), '.eslintignore')
106 with open(eslint_ignore_path, 'r') as ignore_manifest:
107 for line in ignore_manifest:
Ingvar Stepanyanb532f3f2019-10-22 12:32:59 +0100108 ignore_files.append(input_api.os_path.normpath(line.strip()))
Mathias Bynens032591d2019-10-21 11:51:31 +0200109 formattable_files = [
110 affected_file for affected_file in affected_files if all(ignore_file not in affected_file for ignore_file in ignore_files)
111 ]
Blink Reformat4c46d092018-04-07 15:32:37 +0000112 if len(formattable_files) == 0:
113 return []
114
115 check_formatting_process = popen(['git', 'cl', 'format', '--js', '--dry-run'] + formattable_files)
116 check_formatting_process.communicate()
117 if check_formatting_process.returncode == 0:
118 return []
119
120 format_args = ['git', 'cl', 'format', '--js'] + formattable_files
121 format_process = popen(format_args)
122 format_out, _ = format_process.communicate()
123 if format_process.returncode != 0:
124 return [output_api.PresubmitError(format_out)]
125
126 # Use eslint to autofix the braces.
127 # Also fix semicolon to avoid confusing clang-format.
Mathias Bynens032591d2019-10-21 11:51:31 +0200128 eslint_process = popen(
129 [devtools_paths.node_path(), devtools_paths.eslint_path(), '--config', '.eslintrc.js', '--fix'] + affected_files)
Blink Reformat4c46d092018-04-07 15:32:37 +0000130 eslint_process.communicate()
131
132 # Need to run clang-format again to align the braces
133 popen(format_args).communicate()
134
135 return [
Yang Guo5a805ab2019-10-31 13:53:28 +0100136 output_api.PresubmitError('ERROR: Found formatting violations.\n'
Yang Guo75beda92019-10-28 08:29:25 +0100137 'Ran clang-format on diff\n'
138 'Use git status to check the formatting changes'),
Blink Reformat4c46d092018-04-07 15:32:37 +0000139 output_api.PresubmitError(format_out),
140 ]
141
142
e52a82bdfb5106bd658c2c5ea465e200594be1e2019-10-29 16:02:46 -0700143def _CheckDevtoolsLocalization(input_api, output_api, check_all_files=False): # pylint: disable=invalid-name
Mandy Chene997da72019-08-22 23:50:19 +0000144 devtools_root = input_api.PresubmitLocalPath()
vidorteg2b675b02019-11-25 09:51:28 -0800145 script_path = input_api.os_path.join(devtools_root, 'scripts', 'test', 'run_localization_check.py')
Paul Lewis954a5a92019-11-20 15:33:49 +0000146 if check_all_files == True:
vidorteg2b675b02019-11-25 09:51:28 -0800147 # Scan all files and fix any errors
vidorteg75c025e2019-11-25 09:52:43 -0800148 args = ['--autofix', '--all']
Paul Lewis954a5a92019-11-20 15:33:49 +0000149 else:
vidorteg2b675b02019-11-25 09:51:28 -0800150 devtools_front_end = input_api.os_path.join(devtools_root, 'front_end')
151 affected_front_end_files = _getAffectedFiles(input_api, [devtools_front_end], ['D'],
152 ['.js', '.grdp', '.grd', 'module.json'])
153
154 if len(affected_front_end_files) == 0:
155 return []
156 # Scan only added or modified files with specific extensions.
157 args = [
158 '--autofix',
159 '--files',
160 ] + affected_front_end_files
161 process = input_api.subprocess.Popen(
162 [input_api.python_executable, script_path] + args, stdout=input_api.subprocess.PIPE, stderr=input_api.subprocess.STDOUT)
163 out, _ = process.communicate()
164 if process.returncode != 0:
165 return [output_api.PresubmitError(out)]
166 return [output_api.PresubmitNotifyResult(out)]
Mandy Chen465b4f72019-03-21 22:52:54 +0000167
168
Blink Reformat4c46d092018-04-07 15:32:37 +0000169def _CheckDevtoolsStyle(input_api, output_api):
Yang Guo75beda92019-10-28 08:29:25 +0100170 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 +0000171 process = input_api.subprocess.Popen([input_api.python_executable, lint_path],
172 stdout=input_api.subprocess.PIPE,
173 stderr=input_api.subprocess.STDOUT)
174 out, _ = process.communicate()
175 if process.returncode != 0:
176 return [output_api.PresubmitError(out)]
177 return [output_api.PresubmitNotifyResult(out)]
Blink Reformat4c46d092018-04-07 15:32:37 +0000178
179
Joel Einbinderf6f86b62019-06-10 23:19:12 +0000180def _CheckOptimizeSVGHashes(input_api, output_api):
Blink Reformat4c46d092018-04-07 15:32:37 +0000181 if not input_api.platform.startswith('linux'):
182 return []
183
184 original_sys_path = sys.path
185 try:
186 sys.path = sys.path + [input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'build')]
187 import devtools_file_hashes
188 finally:
189 sys.path = original_sys_path
190
191 absolute_local_paths = [af.AbsoluteLocalPath() for af in input_api.AffectedFiles(include_deletes=False)]
Yang Guo75beda92019-10-28 08:29:25 +0100192 images_src_path = input_api.os_path.join('devtools', 'front_end', 'Images', 'src')
193 image_source_file_paths = [path for path in absolute_local_paths if images_src_path in path and path.endswith('.svg')]
194 image_sources_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end', 'Images', 'src')
195 hashes_file_name = 'optimize_svg.hashes'
Blink Reformat4c46d092018-04-07 15:32:37 +0000196 hashes_file_path = input_api.os_path.join(image_sources_path, hashes_file_name)
197 invalid_hash_file_paths = devtools_file_hashes.files_with_invalid_hashes(hashes_file_path, image_source_file_paths)
198 if len(invalid_hash_file_paths) == 0:
199 return []
200 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 +0100201 file_paths_str = ', '.join(invalid_hash_file_names)
202 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 +0000203 return [output_api.PresubmitError(error_message)]
204
205
206def _CheckCSSViolations(input_api, output_api):
207 results = []
208 for f in input_api.AffectedFiles(include_deletes=False):
Yang Guo75beda92019-10-28 08:29:25 +0100209 if not f.LocalPath().endswith('.css'):
Blink Reformat4c46d092018-04-07 15:32:37 +0000210 continue
211 for line_number, line in f.ChangedContents():
Yang Guo75beda92019-10-28 08:29:25 +0100212 if '/deep/' in line:
213 results.append(output_api.PresubmitError(('%s:%d uses /deep/ selector') % (f.LocalPath(), line_number)))
214 if '::shadow' in line:
215 results.append(output_api.PresubmitError(('%s:%d uses ::shadow selector') % (f.LocalPath(), line_number)))
Blink Reformat4c46d092018-04-07 15:32:37 +0000216 return results
217
Mathias Bynens032591d2019-10-21 11:51:31 +0200218
Yang Guo4fd355c2019-09-19 10:59:03 +0200219def _CommonChecks(input_api, output_api):
Mathias Bynens032591d2019-10-21 11:51:31 +0200220 """Checks common to both upload and commit."""
221 results = []
Mathias Bynensa0a6e292019-12-17 13:24:08 +0100222 author = input_api.change.author_email
223 if author and author not in _KNOWN_ROBOTS:
224 results.extend(input_api.canned_checks.CheckAuthorizedAuthor(input_api, output_api))
Mathias Bynens032591d2019-10-21 11:51:31 +0200225 results.extend(input_api.canned_checks.CheckOwnersFormat(input_api, output_api))
226 results.extend(input_api.canned_checks.CheckOwners(input_api, output_api))
227 results.extend(input_api.canned_checks.CheckChangeHasNoCrAndHasOnlyOneEol(input_api, output_api))
228 results.extend(input_api.canned_checks.CheckChangeHasNoStrayWhitespace(input_api, output_api))
229 results.extend(input_api.canned_checks.CheckGenderNeutral(input_api, output_api))
Mathias Bynens032591d2019-10-21 11:51:31 +0200230 return results
231
Blink Reformat4c46d092018-04-07 15:32:37 +0000232
233def CheckChangeOnUpload(input_api, output_api):
234 results = []
Yang Guo4fd355c2019-09-19 10:59:03 +0200235 results.extend(_CommonChecks(input_api, output_api))
Blink Reformat4c46d092018-04-07 15:32:37 +0000236 results.extend(_CheckBuildGN(input_api, output_api))
237 results.extend(_CheckFormat(input_api, output_api))
238 results.extend(_CheckDevtoolsStyle(input_api, output_api))
Joel Einbinderf6f86b62019-06-10 23:19:12 +0000239 results.extend(_CheckOptimizeSVGHashes(input_api, output_api))
Blink Reformat4c46d092018-04-07 15:32:37 +0000240 results.extend(_CheckCSSViolations(input_api, output_api))
e52a82bdfb5106bd658c2c5ea465e200594be1e2019-10-29 16:02:46 -0700241 results.extend(_CheckDevtoolsLocalization(input_api, output_api))
Yang Guoa7845d52019-10-31 11:30:23 +0100242 results.extend(_CheckChangesAreExclusiveToDirectory(input_api, output_api))
Blink Reformat4c46d092018-04-07 15:32:37 +0000243 return results
244
245
246def CheckChangeOnCommit(input_api, output_api):
Mandy Chenf0fbdbe2019-08-22 23:58:37 +0000247 results = []
Yang Guo4fd355c2019-09-19 10:59:03 +0200248 results.extend(_CommonChecks(input_api, output_api))
e52a82bdfb5106bd658c2c5ea465e200594be1e2019-10-29 16:02:46 -0700249 results.extend(_CheckDevtoolsLocalization(input_api, output_api, True))
Yang Guoa7845d52019-10-31 11:30:23 +0100250 results.extend(_CheckChangesAreExclusiveToDirectory(input_api, output_api))
Mathias Bynens032591d2019-10-21 11:51:31 +0200251 results.extend(input_api.canned_checks.CheckChangeHasDescription(input_api, output_api))
Mandy Chenf0fbdbe2019-08-22 23:58:37 +0000252 return results
Blink Reformat4c46d092018-04-07 15:32:37 +0000253
254
Mandy Chena6be46a2019-07-09 17:06:27 +0000255def _getAffectedFiles(input_api, parent_directories, excluded_actions, accepted_endings): # pylint: disable=invalid-name
Yang Guo75beda92019-10-28 08:29:25 +0100256 """Return absolute file paths of affected files (not due to an excluded action)
Mandy Chena6be46a2019-07-09 17:06:27 +0000257 under a parent directory with an accepted file ending.
Yang Guo75beda92019-10-28 08:29:25 +0100258 """
Mandy Chena6be46a2019-07-09 17:06:27 +0000259 local_paths = [
260 f.AbsoluteLocalPath() for f in input_api.AffectedFiles() if all(f.Action() != action for action in excluded_actions)
261 ]
262 affected_files = [
263 file_name for file_name in local_paths
264 if any(parent_directory in file_name for parent_directory in parent_directories) and any(
265 file_name.endswith(accepted_ending) for accepted_ending in accepted_endings)
266 ]
267 return affected_files
268
269
Blink Reformat4c46d092018-04-07 15:32:37 +0000270def _getAffectedFrontEndFiles(input_api):
Blink Reformat4c46d092018-04-07 15:32:37 +0000271 devtools_root = input_api.PresubmitLocalPath()
Yang Guo75beda92019-10-28 08:29:25 +0100272 devtools_front_end = input_api.os_path.join(devtools_root, 'front_end')
273 affected_front_end_files = _getAffectedFiles(input_api, [devtools_front_end], ['D'], ['.js'])
Blink Reformat4c46d092018-04-07 15:32:37 +0000274 return [input_api.os_path.relpath(file_name, devtools_root) for file_name in affected_front_end_files]
275
276
277def _getAffectedJSFiles(input_api):
Blink Reformat4c46d092018-04-07 15:32:37 +0000278 devtools_root = input_api.PresubmitLocalPath()
Yang Guo75beda92019-10-28 08:29:25 +0100279 devtools_front_end = input_api.os_path.join(devtools_root, 'front_end')
280 devtools_scripts = input_api.os_path.join(devtools_root, 'scripts')
281 affected_js_files = _getAffectedFiles(input_api, [devtools_front_end, devtools_scripts], ['D'], ['.js'])
Blink Reformat4c46d092018-04-07 15:32:37 +0000282 return [input_api.os_path.relpath(file_name, devtools_root) for file_name in affected_js_files]
283
284
Lorne Mitchellc56ff2d2019-05-28 23:35:03 +0000285def _checkWithNodeScript(input_api, output_api, script_path, script_arguments=None): # pylint: disable=invalid-name
Blink Reformat4c46d092018-04-07 15:32:37 +0000286 original_sys_path = sys.path
287 try:
Yang Guo75beda92019-10-28 08:29:25 +0100288 sys.path = sys.path + [input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')]
Yang Guod8176982019-10-04 20:30:35 +0000289 import devtools_paths
Blink Reformat4c46d092018-04-07 15:32:37 +0000290 finally:
291 sys.path = original_sys_path
292
Yang Guod8176982019-10-04 20:30:35 +0000293 node_path = devtools_paths.node_path()
Blink Reformat4c46d092018-04-07 15:32:37 +0000294
Lorne Mitchellc56ff2d2019-05-28 23:35:03 +0000295 if script_arguments is None:
296 script_arguments = []
Mandy Chen465b4f72019-03-21 22:52:54 +0000297
Blink Reformat4c46d092018-04-07 15:32:37 +0000298 process = input_api.subprocess.Popen(
Lorne Mitchellc56ff2d2019-05-28 23:35:03 +0000299 [node_path, script_path] + script_arguments, stdout=input_api.subprocess.PIPE, stderr=input_api.subprocess.STDOUT)
Blink Reformat4c46d092018-04-07 15:32:37 +0000300 out, _ = process.communicate()
301
302 if process.returncode != 0:
303 return [output_api.PresubmitError(out)]
304 return [output_api.PresubmitNotifyResult(out)]