Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 1 | # 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 Guo | 75beda9 | 2019-10-28 08:29:25 +0100 | [diff] [blame] | 28 | """ |
| 29 | DevTools presubmit script |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 30 | |
| 31 | See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts |
| 32 | for more details about the presubmit API built into gcl. |
| 33 | """ |
| 34 | |
| 35 | import sys |
| 36 | |
Yang Guo | a7845d5 | 2019-10-31 11:30:23 +0100 | [diff] [blame] | 37 | EXCLUSIVE_CHANGE_DIRECTORIES = [ |
| 38 | [ 'third_party', 'v8' ], |
| 39 | [ 'node_modules' ], |
| 40 | [ 'OWNERS' ], |
| 41 | ] |
| 42 | |
Liviu Rau | fd2e321 | 2019-12-18 16:38:20 +0100 | [diff] [blame] | 43 | AUTOROLL_ACCOUNT = "devtools-ci-autoroll-builder@chops-service-accounts.iam.gserviceaccount.com" |
Mathias Bynens | a0a6e29 | 2019-12-17 13:24:08 +0100 | [diff] [blame] | 44 | |
Yang Guo | a7845d5 | 2019-10-31 11:30:23 +0100 | [diff] [blame] | 45 | def _CheckChangesAreExclusiveToDirectory(input_api, output_api): |
Tim van der Lippe | bc42a63 | 2019-11-28 14:22:55 +0000 | [diff] [blame] | 46 | if input_api.change.DISABLE_THIRD_PARTY_CHECK != None: |
| 47 | return [] |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 48 | results = [output_api.PresubmitNotifyResult('Directory Exclusivity Check:')] |
Yang Guo | a7845d5 | 2019-10-31 11:30:23 +0100 | [diff] [blame] | 49 | def IsParentDir(file, dir): |
| 50 | while file != '': |
| 51 | if file == dir: |
| 52 | return True |
| 53 | file = input_api.os_path.dirname(file) |
Yang Guo | a7845d5 | 2019-10-31 11:30:23 +0100 | [diff] [blame] | 54 | 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 Guo | a7845d5 | 2019-10-31 11:30:23 +0100 | [diff] [blame] | 62 | num_affected = len(affected_files) |
| 63 | for dirs in EXCLUSIVE_CHANGE_DIRECTORIES: |
Paul Lewis | 14effba | 2019-12-02 14:56:40 +0000 | [diff] [blame] | 64 | dir_list = ', '.join(dirs) |
Yang Guo | a7845d5 | 2019-10-31 11:30:23 +0100 | [diff] [blame] | 65 | 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 Lippe | ebb94a9 | 2019-11-19 17:07:53 +0000 | [diff] [blame] | 69 | # 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 Guo | a7845d5 | 2019-10-31 11:30:23 +0100 | [diff] [blame] | 72 | if num_in_dir < num_affected: |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 73 | results.append(output_api |
Paul Lewis | 14effba | 2019-12-02 14:56:40 +0000 | [diff] [blame] | 74 | .PresubmitError(('CLs that affect files in "%s" should be limited to these files/directories.' % dir_list) + |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 75 | ' You can disable this check by adding DISABLE_THIRD_PARTY_CHECK=<reason> to your commit message')) |
| 76 | break |
| 77 | |
| 78 | return results |
Yang Guo | a7845d5 | 2019-10-31 11:30:23 +0100 | [diff] [blame] | 79 | |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 80 | |
| 81 | def _CheckBuildGN(input_api, output_api): |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 82 | results = [output_api.PresubmitNotifyResult('Running BUILD.GN check:')] |
Yang Guo | 75beda9 | 2019-10-28 08:29:25 +0100 | [diff] [blame] | 83 | script_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'check_gn.js') |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 84 | results.extend(_checkWithNodeScript(input_api, output_api, script_path)) |
| 85 | return results |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 86 | |
| 87 | |
Tim van der Lippe | e4bdd74 | 2019-12-17 16:40:16 +0100 | [diff] [blame] | 88 | def _CheckJSON(input_api, output_api): |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 89 | results = [output_api.PresubmitNotifyResult('Running JSON Validator:')] |
Tim van der Lippe | e4bdd74 | 2019-12-17 16:40:16 +0100 | [diff] [blame] | 90 | script_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'json_validator', 'validate_module_json.js') |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 91 | results.extend(_checkWithNodeScript(input_api, output_api, script_path)) |
| 92 | return results |
Tim van der Lippe | e4bdd74 | 2019-12-17 16:40:16 +0100 | [diff] [blame] | 93 | |
| 94 | |
Brandon Goddard | 53faba1 | 2020-01-24 16:55:04 +0000 | [diff] [blame] | 95 | def _CheckLicenses(input_api, output_api): |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 96 | results = [output_api.PresubmitNotifyResult('Running License Header Check:')] |
Brandon Goddard | 53faba1 | 2020-01-24 16:55:04 +0000 | [diff] [blame] | 97 | script_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'test', 'run_license_header_check.js') |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 98 | results.extend(_checkWithNodeScript(input_api, output_api, script_path)) |
| 99 | return results |
Brandon Goddard | 53faba1 | 2020-01-24 16:55:04 +0000 | [diff] [blame] | 100 | |
| 101 | |
Paul Lewis | 21fb349 | 2020-01-14 15:28:22 +0000 | [diff] [blame] | 102 | def _CheckUnitTests(input_api, output_api): |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 103 | results = [output_api.PresubmitNotifyResult('Running Unit Tests:')] |
Paul Lewis | 21fb349 | 2020-01-14 15:28:22 +0000 | [diff] [blame] | 104 | unittest_root = input_api.os_path.join(input_api.PresubmitLocalPath(), 'test') |
| 105 | affected_unittest_files = _getAffectedFiles(input_api, [unittest_root], ['D'], ['.ts']) |
| 106 | if len(affected_unittest_files) == 0: |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 107 | return results |
Paul Lewis | 21fb349 | 2020-01-14 15:28:22 +0000 | [diff] [blame] | 108 | |
| 109 | script_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'test', 'check_for_unittest_onlys.js') |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 110 | results.extend(_checkWithNodeScript(input_api, output_api, script_path, affected_unittest_files)) |
| 111 | return results |
Paul Lewis | 21fb349 | 2020-01-14 15:28:22 +0000 | [diff] [blame] | 112 | |
| 113 | |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 114 | def _CheckFormat(input_api, output_api): |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 115 | results = [output_api.PresubmitNotifyResult('Running Format Checks:')] |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 116 | def popen(args): |
| 117 | return input_api.subprocess.Popen(args=args, stdout=input_api.subprocess.PIPE, stderr=input_api.subprocess.STDOUT) |
| 118 | |
| 119 | affected_files = _getAffectedJSFiles(input_api) |
| 120 | if len(affected_files) == 0: |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 121 | return results |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 122 | original_sys_path = sys.path |
| 123 | try: |
Yang Guo | 75beda9 | 2019-10-28 08:29:25 +0100 | [diff] [blame] | 124 | sys.path = sys.path + [input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')] |
Yang Guo | d817698 | 2019-10-04 20:30:35 +0000 | [diff] [blame] | 125 | import devtools_paths |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 126 | finally: |
| 127 | sys.path = original_sys_path |
| 128 | |
| 129 | ignore_files = [] |
| 130 | eslint_ignore_path = input_api.os_path.join(input_api.PresubmitLocalPath(), '.eslintignore') |
| 131 | with open(eslint_ignore_path, 'r') as ignore_manifest: |
| 132 | for line in ignore_manifest: |
Ingvar Stepanyan | b532f3f | 2019-10-22 12:32:59 +0100 | [diff] [blame] | 133 | ignore_files.append(input_api.os_path.normpath(line.strip())) |
Mathias Bynens | 032591d | 2019-10-21 11:51:31 +0200 | [diff] [blame] | 134 | formattable_files = [ |
| 135 | affected_file for affected_file in affected_files if all(ignore_file not in affected_file for ignore_file in ignore_files) |
| 136 | ] |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 137 | if len(formattable_files) == 0: |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 138 | return results |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 139 | |
| 140 | check_formatting_process = popen(['git', 'cl', 'format', '--js', '--dry-run'] + formattable_files) |
| 141 | check_formatting_process.communicate() |
| 142 | if check_formatting_process.returncode == 0: |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 143 | return results |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 144 | |
| 145 | format_args = ['git', 'cl', 'format', '--js'] + formattable_files |
| 146 | format_process = popen(format_args) |
| 147 | format_out, _ = format_process.communicate() |
| 148 | if format_process.returncode != 0: |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 149 | results.append(output_api.PresubmitError(format_out)) |
| 150 | return results |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 151 | |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 152 | results.append(output_api.PresubmitError('ERROR: Found formatting violations.\n' |
Yang Guo | 75beda9 | 2019-10-28 08:29:25 +0100 | [diff] [blame] | 153 | 'Ran clang-format on diff\n' |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 154 | 'Use git status to check the formatting changes')) |
| 155 | results.append(output_api.PresubmitError(format_out)) |
| 156 | return results |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 157 | |
| 158 | |
e52a82bdfb5106bd658c2c5ea465e200 | 594be1e | 2019-10-29 16:02:46 -0700 | [diff] [blame] | 159 | def _CheckDevtoolsLocalization(input_api, output_api, check_all_files=False): # pylint: disable=invalid-name |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 160 | results = [output_api.PresubmitNotifyResult('Running Localization Checks:')] |
Mandy Chen | e997da7 | 2019-08-22 23:50:19 +0000 | [diff] [blame] | 161 | devtools_root = input_api.PresubmitLocalPath() |
vidorteg | 2b675b0 | 2019-11-25 09:51:28 -0800 | [diff] [blame] | 162 | script_path = input_api.os_path.join(devtools_root, 'scripts', 'test', 'run_localization_check.py') |
Paul Lewis | 954a5a9 | 2019-11-20 15:33:49 +0000 | [diff] [blame] | 163 | if check_all_files == True: |
vidorteg | 2b675b0 | 2019-11-25 09:51:28 -0800 | [diff] [blame] | 164 | # Scan all files and fix any errors |
vidorteg | 75c025e | 2019-11-25 09:52:43 -0800 | [diff] [blame] | 165 | args = ['--autofix', '--all'] |
Paul Lewis | 954a5a9 | 2019-11-20 15:33:49 +0000 | [diff] [blame] | 166 | else: |
vidorteg | 2b675b0 | 2019-11-25 09:51:28 -0800 | [diff] [blame] | 167 | devtools_front_end = input_api.os_path.join(devtools_root, 'front_end') |
| 168 | affected_front_end_files = _getAffectedFiles(input_api, [devtools_front_end], ['D'], |
| 169 | ['.js', '.grdp', '.grd', 'module.json']) |
| 170 | |
| 171 | if len(affected_front_end_files) == 0: |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 172 | return results |
vidorteg | 2b675b0 | 2019-11-25 09:51:28 -0800 | [diff] [blame] | 173 | # Scan only added or modified files with specific extensions. |
| 174 | args = [ |
| 175 | '--autofix', |
| 176 | '--files', |
| 177 | ] + affected_front_end_files |
| 178 | process = input_api.subprocess.Popen( |
| 179 | [input_api.python_executable, script_path] + args, stdout=input_api.subprocess.PIPE, stderr=input_api.subprocess.STDOUT) |
| 180 | out, _ = process.communicate() |
| 181 | if process.returncode != 0: |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 182 | results.append(output_api.PresubmitError(out)) |
| 183 | else: |
| 184 | results.append(output_api.PresubmitNotifyResult(out)) |
| 185 | return results |
Mandy Chen | 465b4f7 | 2019-03-21 22:52:54 +0000 | [diff] [blame] | 186 | |
| 187 | |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 188 | def _CheckDevtoolsStyle(input_api, output_api): |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 189 | results = [output_api.PresubmitNotifyResult('Running Devtools Style Check:')] |
Yang Guo | 75beda9 | 2019-10-28 08:29:25 +0100 | [diff] [blame] | 190 | lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'test', 'run_lint_check.py') |
Tim van der Lippe | c85c312 | 2019-09-19 11:27:04 +0000 | [diff] [blame] | 191 | process = input_api.subprocess.Popen([input_api.python_executable, lint_path], |
| 192 | stdout=input_api.subprocess.PIPE, |
| 193 | stderr=input_api.subprocess.STDOUT) |
| 194 | out, _ = process.communicate() |
| 195 | if process.returncode != 0: |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 196 | results.append(output_api.PresubmitError(out)) |
| 197 | else: |
| 198 | results.append(output_api.PresubmitNotifyResult(out)) |
| 199 | return results |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 200 | |
| 201 | |
Joel Einbinder | f6f86b6 | 2019-06-10 23:19:12 +0000 | [diff] [blame] | 202 | def _CheckOptimizeSVGHashes(input_api, output_api): |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 203 | results = [output_api.PresubmitNotifyResult('Running SVG Optimization Check:')] |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 204 | if not input_api.platform.startswith('linux'): |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 205 | return results |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 206 | |
| 207 | original_sys_path = sys.path |
| 208 | try: |
| 209 | sys.path = sys.path + [input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts', 'build')] |
| 210 | import devtools_file_hashes |
| 211 | finally: |
| 212 | sys.path = original_sys_path |
| 213 | |
| 214 | absolute_local_paths = [af.AbsoluteLocalPath() for af in input_api.AffectedFiles(include_deletes=False)] |
Yang Guo | 75beda9 | 2019-10-28 08:29:25 +0100 | [diff] [blame] | 215 | images_src_path = input_api.os_path.join('devtools', 'front_end', 'Images', 'src') |
| 216 | image_source_file_paths = [path for path in absolute_local_paths if images_src_path in path and path.endswith('.svg')] |
| 217 | image_sources_path = input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end', 'Images', 'src') |
| 218 | hashes_file_name = 'optimize_svg.hashes' |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 219 | hashes_file_path = input_api.os_path.join(image_sources_path, hashes_file_name) |
| 220 | invalid_hash_file_paths = devtools_file_hashes.files_with_invalid_hashes(hashes_file_path, image_source_file_paths) |
| 221 | if len(invalid_hash_file_paths) == 0: |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 222 | return results |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 223 | invalid_hash_file_names = [input_api.os_path.basename(file_path) for file_path in invalid_hash_file_paths] |
Yang Guo | 75beda9 | 2019-10-28 08:29:25 +0100 | [diff] [blame] | 224 | file_paths_str = ', '.join(invalid_hash_file_names) |
| 225 | error_message = 'The following SVG files should be optimized using optimize_svg_images script before uploading: \n - %s' % file_paths_str |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 226 | results.append(output_api.PresubmitError(error_message)) |
| 227 | return results |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 228 | |
| 229 | |
| 230 | def _CheckCSSViolations(input_api, output_api): |
Brandon Goddard | e702867 | 2020-01-30 09:31:04 -0800 | [diff] [blame^] | 231 | results = [output_api.PresubmitNotifyResult('Running CSS Violation Check:')] |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 232 | for f in input_api.AffectedFiles(include_deletes=False): |
Yang Guo | 75beda9 | 2019-10-28 08:29:25 +0100 | [diff] [blame] | 233 | if not f.LocalPath().endswith('.css'): |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 234 | continue |
| 235 | for line_number, line in f.ChangedContents(): |
Yang Guo | 75beda9 | 2019-10-28 08:29:25 +0100 | [diff] [blame] | 236 | if '/deep/' in line: |
| 237 | results.append(output_api.PresubmitError(('%s:%d uses /deep/ selector') % (f.LocalPath(), line_number))) |
| 238 | if '::shadow' in line: |
| 239 | results.append(output_api.PresubmitError(('%s:%d uses ::shadow selector') % (f.LocalPath(), line_number))) |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 240 | return results |
| 241 | |
Mathias Bynens | 032591d | 2019-10-21 11:51:31 +0200 | [diff] [blame] | 242 | |
Tim van der Lippe | 5279f84 | 2020-01-14 16:26:38 +0000 | [diff] [blame] | 243 | def _CheckNoUncheckedFiles(input_api, output_api): |
| 244 | results = [] |
| 245 | process = input_api.subprocess.Popen(['git', 'diff', '--exit-code'], |
| 246 | stdout=input_api.subprocess.PIPE, |
| 247 | stderr=input_api.subprocess.STDOUT) |
| 248 | out, _ = process.communicate() |
| 249 | if process.returncode != 0: |
| 250 | return [output_api.PresubmitError('You have changed files that need to be committed.')] |
| 251 | return [] |
| 252 | |
Tim van der Lippe | 8fdda11 | 2020-01-27 11:27:06 +0000 | [diff] [blame] | 253 | def _CheckForTooLargeFiles(input_api, output_api): |
| 254 | """Avoid large files, especially binary files, in the repository since |
| 255 | git doesn't scale well for those. They will be in everyone's repo |
| 256 | clones forever, forever making Chromium slower to clone and work |
| 257 | with.""" |
| 258 | # Uploading files to cloud storage is not trivial so we don't want |
| 259 | # to set the limit too low, but the upper limit for "normal" large |
| 260 | # files seems to be 1-2 MB, with a handful around 5-8 MB, so |
| 261 | # anything over 20 MB is exceptional. |
| 262 | TOO_LARGE_FILE_SIZE_LIMIT = 20 * 1024 * 1024 # 10 MB |
| 263 | too_large_files = [] |
| 264 | for f in input_api.AffectedFiles(): |
| 265 | # Check both added and modified files (but not deleted files). |
| 266 | if f.Action() in ('A', 'M'): |
| 267 | size = input_api.os_path.getsize(f.AbsoluteLocalPath()) |
| 268 | if size > TOO_LARGE_FILE_SIZE_LIMIT: |
| 269 | too_large_files.append("%s: %d bytes" % (f.LocalPath(), size)) |
| 270 | if too_large_files: |
| 271 | message = ( |
| 272 | 'Do not commit large files to git since git scales badly for those.\n' + |
| 273 | 'Instead put the large files in cloud storage and use DEPS to\n' + |
| 274 | 'fetch them.\n' + '\n'.join(too_large_files) |
| 275 | ) |
| 276 | return [output_api.PresubmitError( |
| 277 | 'Too large files found in commit', long_text=message + '\n')] |
| 278 | else: |
| 279 | return [] |
| 280 | |
Tim van der Lippe | 5279f84 | 2020-01-14 16:26:38 +0000 | [diff] [blame] | 281 | |
Yang Guo | 4fd355c | 2019-09-19 10:59:03 +0200 | [diff] [blame] | 282 | def _CommonChecks(input_api, output_api): |
Mathias Bynens | 032591d | 2019-10-21 11:51:31 +0200 | [diff] [blame] | 283 | """Checks common to both upload and commit.""" |
| 284 | results = [] |
Liviu Rau | fd2e321 | 2019-12-18 16:38:20 +0100 | [diff] [blame] | 285 | results.extend(input_api.canned_checks.CheckAuthorizedAuthor(input_api, output_api, |
| 286 | bot_whitelist=[AUTOROLL_ACCOUNT] |
| 287 | )) |
Mathias Bynens | 032591d | 2019-10-21 11:51:31 +0200 | [diff] [blame] | 288 | results.extend(input_api.canned_checks.CheckOwnersFormat(input_api, output_api)) |
| 289 | results.extend(input_api.canned_checks.CheckOwners(input_api, output_api)) |
| 290 | results.extend(input_api.canned_checks.CheckChangeHasNoCrAndHasOnlyOneEol(input_api, output_api)) |
| 291 | results.extend(input_api.canned_checks.CheckChangeHasNoStrayWhitespace(input_api, output_api)) |
| 292 | results.extend(input_api.canned_checks.CheckGenderNeutral(input_api, output_api)) |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 293 | results.extend(_CheckBuildGN(input_api, output_api)) |
Tim van der Lippe | e4bdd74 | 2019-12-17 16:40:16 +0100 | [diff] [blame] | 294 | results.extend(_CheckJSON(input_api, output_api)) |
Brandon Goddard | 53faba1 | 2020-01-24 16:55:04 +0000 | [diff] [blame] | 295 | results.extend(_CheckLicenses(input_api, output_api)) |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 296 | results.extend(_CheckDevtoolsStyle(input_api, output_api)) |
Tim van der Lippe | 5497d48 | 2020-01-14 15:27:30 +0000 | [diff] [blame] | 297 | results.extend(_CheckFormat(input_api, output_api)) |
Joel Einbinder | f6f86b6 | 2019-06-10 23:19:12 +0000 | [diff] [blame] | 298 | results.extend(_CheckOptimizeSVGHashes(input_api, output_api)) |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 299 | results.extend(_CheckCSSViolations(input_api, output_api)) |
Yang Guo | a7845d5 | 2019-10-31 11:30:23 +0100 | [diff] [blame] | 300 | results.extend(_CheckChangesAreExclusiveToDirectory(input_api, output_api)) |
Paul Lewis | 21fb349 | 2020-01-14 15:28:22 +0000 | [diff] [blame] | 301 | results.extend(_CheckUnitTests(input_api, output_api)) |
Tim van der Lippe | 5279f84 | 2020-01-14 16:26:38 +0000 | [diff] [blame] | 302 | results.extend(_CheckNoUncheckedFiles(input_api, output_api)) |
Tim van der Lippe | 8fdda11 | 2020-01-27 11:27:06 +0000 | [diff] [blame] | 303 | results.extend(_CheckForTooLargeFiles(input_api, output_api)) |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 304 | return results |
| 305 | |
| 306 | |
Liviu Rau | d614e09 | 2020-01-08 10:56:33 +0100 | [diff] [blame] | 307 | def CheckChangeOnUpload(input_api, output_api): |
| 308 | results = [] |
| 309 | results.extend(_CommonChecks(input_api, output_api)) |
| 310 | results.extend(_CheckDevtoolsLocalization(input_api, output_api)) |
| 311 | return results |
| 312 | |
| 313 | |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 314 | def CheckChangeOnCommit(input_api, output_api): |
Mandy Chen | f0fbdbe | 2019-08-22 23:58:37 +0000 | [diff] [blame] | 315 | results = [] |
Yang Guo | 4fd355c | 2019-09-19 10:59:03 +0200 | [diff] [blame] | 316 | results.extend(_CommonChecks(input_api, output_api)) |
e52a82bdfb5106bd658c2c5ea465e200 | 594be1e | 2019-10-29 16:02:46 -0700 | [diff] [blame] | 317 | results.extend(_CheckDevtoolsLocalization(input_api, output_api, True)) |
Mathias Bynens | 032591d | 2019-10-21 11:51:31 +0200 | [diff] [blame] | 318 | results.extend(input_api.canned_checks.CheckChangeHasDescription(input_api, output_api)) |
Mandy Chen | f0fbdbe | 2019-08-22 23:58:37 +0000 | [diff] [blame] | 319 | return results |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 320 | |
| 321 | |
Mandy Chen | a6be46a | 2019-07-09 17:06:27 +0000 | [diff] [blame] | 322 | def _getAffectedFiles(input_api, parent_directories, excluded_actions, accepted_endings): # pylint: disable=invalid-name |
Yang Guo | 75beda9 | 2019-10-28 08:29:25 +0100 | [diff] [blame] | 323 | """Return absolute file paths of affected files (not due to an excluded action) |
Mandy Chen | a6be46a | 2019-07-09 17:06:27 +0000 | [diff] [blame] | 324 | under a parent directory with an accepted file ending. |
Yang Guo | 75beda9 | 2019-10-28 08:29:25 +0100 | [diff] [blame] | 325 | """ |
Mandy Chen | a6be46a | 2019-07-09 17:06:27 +0000 | [diff] [blame] | 326 | local_paths = [ |
| 327 | f.AbsoluteLocalPath() for f in input_api.AffectedFiles() if all(f.Action() != action for action in excluded_actions) |
| 328 | ] |
| 329 | affected_files = [ |
| 330 | file_name for file_name in local_paths |
| 331 | if any(parent_directory in file_name for parent_directory in parent_directories) and any( |
| 332 | file_name.endswith(accepted_ending) for accepted_ending in accepted_endings) |
| 333 | ] |
| 334 | return affected_files |
| 335 | |
| 336 | |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 337 | def _getAffectedFrontEndFiles(input_api): |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 338 | devtools_root = input_api.PresubmitLocalPath() |
Yang Guo | 75beda9 | 2019-10-28 08:29:25 +0100 | [diff] [blame] | 339 | devtools_front_end = input_api.os_path.join(devtools_root, 'front_end') |
| 340 | affected_front_end_files = _getAffectedFiles(input_api, [devtools_front_end], ['D'], ['.js']) |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 341 | return [input_api.os_path.relpath(file_name, devtools_root) for file_name in affected_front_end_files] |
| 342 | |
| 343 | |
| 344 | def _getAffectedJSFiles(input_api): |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 345 | devtools_root = input_api.PresubmitLocalPath() |
Yang Guo | 75beda9 | 2019-10-28 08:29:25 +0100 | [diff] [blame] | 346 | devtools_front_end = input_api.os_path.join(devtools_root, 'front_end') |
| 347 | devtools_scripts = input_api.os_path.join(devtools_root, 'scripts') |
| 348 | affected_js_files = _getAffectedFiles(input_api, [devtools_front_end, devtools_scripts], ['D'], ['.js']) |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 349 | return [input_api.os_path.relpath(file_name, devtools_root) for file_name in affected_js_files] |
| 350 | |
| 351 | |
Lorne Mitchell | c56ff2d | 2019-05-28 23:35:03 +0000 | [diff] [blame] | 352 | def _checkWithNodeScript(input_api, output_api, script_path, script_arguments=None): # pylint: disable=invalid-name |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 353 | original_sys_path = sys.path |
| 354 | try: |
Yang Guo | 75beda9 | 2019-10-28 08:29:25 +0100 | [diff] [blame] | 355 | sys.path = sys.path + [input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts')] |
Yang Guo | d817698 | 2019-10-04 20:30:35 +0000 | [diff] [blame] | 356 | import devtools_paths |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 357 | finally: |
| 358 | sys.path = original_sys_path |
| 359 | |
Yang Guo | d817698 | 2019-10-04 20:30:35 +0000 | [diff] [blame] | 360 | node_path = devtools_paths.node_path() |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 361 | |
Lorne Mitchell | c56ff2d | 2019-05-28 23:35:03 +0000 | [diff] [blame] | 362 | if script_arguments is None: |
| 363 | script_arguments = [] |
Mandy Chen | 465b4f7 | 2019-03-21 22:52:54 +0000 | [diff] [blame] | 364 | |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 365 | process = input_api.subprocess.Popen( |
Lorne Mitchell | c56ff2d | 2019-05-28 23:35:03 +0000 | [diff] [blame] | 366 | [node_path, script_path] + script_arguments, stdout=input_api.subprocess.PIPE, stderr=input_api.subprocess.STDOUT) |
Blink Reformat | 4c46d09 | 2018-04-07 15:32:37 +0000 | [diff] [blame] | 367 | out, _ = process.communicate() |
| 368 | |
| 369 | if process.returncode != 0: |
| 370 | return [output_api.PresubmitError(out)] |
| 371 | return [output_api.PresubmitNotifyResult(out)] |