| # Copyright (C) 2014 Google Inc. All rights reserved. |
| # |
| # Redistribution and use in source and binary forms, with or without |
| # modification, are permitted provided that the following conditions are |
| # met: |
| # |
| # * Redistributions of source code must retain the above copyright |
| # notice, this list of conditions and the following disclaimer. |
| # * Redistributions in binary form must reproduce the above |
| # copyright notice, this list of conditions and the following disclaimer |
| # in the documentation and/or other materials provided with the |
| # distribution. |
| # * Neither the name of Google Inc. nor the names of its |
| # contributors may be used to endorse or promote products derived from |
| # this software without specific prior written permission. |
| # |
| # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| """ |
| DevTools presubmit script |
| |
| See http://goo.gle/devtools-testing-guide#Presubmit-checks for more how to |
| run presubmit checks in DevTools. |
| |
| See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts |
| for more details about the presubmit API built into gcl. |
| |
| `git cl presubmit -v -v` to debug presubmit checks. |
| """ |
| |
| import sys |
| import six |
| import time |
| |
| from pathlib import Path |
| |
| AUTOROLL_ACCOUNT = "devtools-ci-autoroll-builder@chops-service-accounts.iam.gserviceaccount.com" |
| USE_PYTHON3 = True |
| PRESUBMIT_VERSION = '2.0.0' |
| |
| |
| def _ExecuteSubProcess(input_api, |
| output_api, |
| script_path, |
| script_arguments=[], |
| results=[], |
| message=None): |
| if isinstance(script_path, six.string_types): |
| script_path = [input_api.python3_executable, script_path] |
| |
| start_time = time.time() |
| process = input_api.subprocess.Popen(script_path + script_arguments, |
| stdout=input_api.subprocess.PIPE, |
| stderr=input_api.subprocess.STDOUT) |
| out, _ = process.communicate() |
| end_time = time.time() |
| time_difference = end_time - start_time |
| if process.returncode != 0: |
| results.extend([ |
| output_api.PresubmitError( |
| "%s (%.1fs): %s" % |
| (message if message is not None else script_path, |
| time_difference, out.decode('utf-8').strip())) |
| ]) |
| |
| return results |
| |
| |
| def _IsEnvCog(input_api): |
| old_sys_path = sys.path[:] |
| devtools_root = input_api.PresubmitLocalPath() |
| depot_tools = input_api.os_path.join(devtools_root, 'third_party', |
| 'depot_tools') |
| try: |
| sys.path.append(depot_tools) |
| from gclient_utils import IsEnvCog |
| if IsEnvCog(): |
| return True |
| finally: |
| sys.path = old_sys_path |
| return False |
| |
| |
| def _GetAffectedFiles(input_api, parent_directories, excluded_actions, |
| accepted_endings): |
| """Return absolute file paths of affected files (not due to an excluded action) |
| under a parent directory with an accepted file ending. |
| """ |
| local_paths = [ |
| f.AbsoluteLocalPath() for f in input_api.AffectedFiles() |
| if all(f.Action() != action for action in excluded_actions) |
| ] |
| affected_files = [ |
| file_name for file_name in local_paths |
| if any(parent_directory in file_name |
| for parent_directory in parent_directories) and ( |
| len(accepted_endings) == 0 or any( |
| file_name.endswith(accepted_ending) |
| for accepted_ending in accepted_endings)) |
| ] |
| return affected_files |
| |
| |
| def _CheckWithNodeScript(input_api, |
| output_api, |
| script_path, |
| script_arguments=[], |
| allow_typescript=False, |
| message=None): |
| original_sys_path = sys.path |
| try: |
| sys.path = sys.path + [ |
| input_api.os_path.join(input_api.PresubmitLocalPath(), 'scripts') |
| ] |
| import devtools_paths |
| finally: |
| sys.path = original_sys_path |
| |
| process = [devtools_paths.node_path(), script_path] |
| |
| if allow_typescript: |
| process.insert(1, '--no-warnings=ExperimentalWarning') |
| process.insert(1, '--experimental-strip-types') |
| |
| return _ExecuteSubProcess(input_api, |
| output_api, |
| process, |
| script_arguments=script_arguments, |
| message=message) |
| |
| |
| def _GetFilesToLint(input_api, lint_config_files, default_linted_directories, |
| accepted_endings): |
| run_full_check = False |
| files_to_lint = [] |
| |
| # We are changing the lint configuration; run the full check. |
| if len(lint_config_files) != 0: |
| run_full_check = True |
| else: |
| # Only run the linter on files that are relevant, to save PRESUBMIT time. |
| files_to_lint = _GetAffectedFiles(input_api, |
| default_linted_directories, ['D'], |
| accepted_endings) |
| |
| # Exclude front_end/third_party and front_end/generated files. |
| files_to_lint = [ |
| file for file in files_to_lint |
| if "front_end/third_party" not in file |
| and "front_end/generated" not in file |
| ] |
| |
| should_bail_out = len(files_to_lint) == 0 and not run_full_check |
| return should_bail_out, files_to_lint |
| |
| |
| def _CheckFormat(input_api, output_api): |
| if _IsEnvCog(input_api): |
| return [ |
| output_api.PresubmitPromptWarning( |
| 'Non-git environment detected, skipping _CheckFormat.') |
| ] |
| |
| results = [] |
| |
| _ExecuteSubProcess(input_api, |
| output_api, ['git', 'cl', 'format', '--js'], |
| results=results, |
| message='Format JS') |
| |
| _ExecuteSubProcess(input_api, |
| output_api, ['git', 'cl', 'format'], |
| results=results, |
| message='Format') |
| |
| return results |
| |
| |
| def CheckBugAssociationOnCommit(input_api, output_api): |
| results = [] |
| bugs = input_api.change.BugsFromDescription() |
| message = ( |
| "Each CL should be associated with a bug, use \'Bug:\' or \'Fixed:\' lines in\n" |
| "the footer of the commit description. If you explicitly don\'t want to\n" |
| "set a bug, use \'Bug: none\' in the footer of the commit description.\n\n" |
| "Note: The footer of the commit description is the last block of lines in\n" |
| "the commit description that doesn't contain empty lines. This means that\n" |
| "any \'Bug:\' or \'Fixed:\' lines that are eventually followed by an empty\n" |
| "line are not detected by this presubmit check.") |
| |
| if not bugs: |
| results.append(output_api.PresubmitError(message)) |
| |
| return results |
| |
| |
| def CheckExperimentTelemetry(input_api, output_api): |
| experiment_telemetry_files = [ |
| input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end', |
| 'entrypoints', 'main', 'MainImpl.ts'), |
| input_api.os_path.join(input_api.PresubmitLocalPath(), 'front_end', |
| 'core', 'host', 'UserMetrics.ts') |
| ] |
| affected_main_files = _GetAffectedFiles(input_api, |
| experiment_telemetry_files, [], |
| ['.ts']) |
| if len(affected_main_files) == 0: |
| return [] |
| |
| script_path = input_api.os_path.join(input_api.PresubmitLocalPath(), |
| 'scripts', 'check_experiments.js') |
| return _CheckWithNodeScript(input_api, |
| output_api, |
| script_path, |
| message='Experiment telemetry') |
| |
| |
| def CheckESBuildVersion(input_api, output_api): |
| script_path = input_api.os_path.join(input_api.PresubmitLocalPath(), |
| 'scripts', |
| 'check_esbuild_versions.js') |
| return _CheckWithNodeScript(input_api, |
| output_api, |
| script_path, |
| message='ESBuild version') |
| |
| |
| def CheckDevToolsLint(input_api, output_api): |
| lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(), |
| 'scripts', 'test', 'run_lint_check.mjs') |
| |
| front_end_directory = input_api.os_path.join( |
| input_api.PresubmitLocalPath(), 'front_end') |
| |
| inspector_overlay_directory = input_api.os_path.join( |
| input_api.PresubmitLocalPath(), 'inspector_overlay') |
| test_directory = input_api.os_path.join(input_api.PresubmitLocalPath(), |
| 'test') |
| scripts_directory = input_api.os_path.join(input_api.PresubmitLocalPath(), |
| 'scripts') |
| |
| default_linted_directories = [ |
| front_end_directory, |
| test_directory, |
| scripts_directory, |
| inspector_overlay_directory, |
| ] |
| |
| lint_related_files = [ |
| input_api.os_path.join(input_api.PresubmitLocalPath(), |
| 'eslint.config.mjs'), |
| input_api.os_path.join(input_api.PresubmitLocalPath(), |
| '.stylelintrc.json'), |
| input_api.os_path.join(input_api.PresubmitLocalPath(), |
| '.stylelintignore'), |
| # This file includes the LitAnalyzer rules |
| input_api.os_path.join(input_api.PresubmitLocalPath(), |
| 'tsconfig.json'), |
| input_api.os_path.join(scripts_directory, 'test', |
| 'run_lint_check.mjs'), |
| ] |
| |
| lint_related_directories = [ |
| input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules', |
| 'eslint'), |
| input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules', |
| 'stylelint'), |
| input_api.os_path.join(input_api.PresubmitLocalPath(), 'node_modules', |
| '@typescript-eslint'), |
| input_api.os_path.join(scripts_directory, 'eslint_rules'), |
| ] |
| |
| lint_config_files = _GetAffectedFiles( |
| input_api, lint_related_directories, |
| [], [".js", ".mjs", ".ts"]) + _GetAffectedFiles( |
| input_api, lint_related_files, [], []) |
| |
| should_bail_out, files_to_lint = _GetFilesToLint( |
| input_api, lint_config_files, default_linted_directories, |
| ['.css', '.mjs', '.js', '.ts']) |
| if should_bail_out: |
| return [] |
| |
| # If there are more than 50 files to check, don't bother and check |
| # everything, so as to not run into command line length limits on Windows. |
| if len(files_to_lint) > 50: |
| files_to_lint = [] |
| |
| results = [] |
| results.extend( |
| _CheckWithNodeScript(input_api, |
| output_api, |
| lint_path, |
| script_arguments=files_to_lint, |
| allow_typescript=True, |
| message="Lint")) |
| |
| results.extend(_CheckFormat(input_api, output_api)) |
| return results |
| |
| |
| def CheckDevToolsNonJSFileLicenseHeaders(input_api, output_api): |
| lint_path = input_api.os_path.join(input_api.PresubmitLocalPath(), |
| 'scripts', 'test', |
| 'run_header_check_non_js_files.js') |
| |
| front_end_directory = input_api.os_path.join( |
| input_api.PresubmitLocalPath(), 'front_end') |
| inspector_overlay_directory = input_api.os_path.join( |
| input_api.PresubmitLocalPath(), 'inspector_overlay') |
| test_directory = input_api.os_path.join(input_api.PresubmitLocalPath(), |
| 'test') |
| scripts_directory = input_api.os_path.join(input_api.PresubmitLocalPath(), |
| 'scripts') |
| config_directory = input_api.os_path.join(input_api.PresubmitLocalPath(), |
| 'config') |
| |
| default_linted_directories = [ |
| front_end_directory, test_directory, scripts_directory, |
| inspector_overlay_directory, config_directory |
| ] |
| |
| check_related_files = [lint_path] |
| |
| lint_config_files = _GetAffectedFiles(input_api, check_related_files, [], |
| ['.js']) |
| |
| should_bail_out, files_to_lint = _GetFilesToLint( |
| input_api, lint_config_files, default_linted_directories, |
| ['BUILD.gn', '.gni', '.css']) |
| if should_bail_out: |
| return [] |
| |
| # If there are more than 50 files to check, don't bother and check |
| # everything, so as to not run into command line length limits on Windows. |
| if len(files_to_lint) > 50: |
| files_to_lint = [] |
| |
| return _CheckWithNodeScript(input_api, |
| output_api, |
| lint_path, |
| files_to_lint, |
| message='License headers') |
| |
| |
| def CheckGeneratedFiles(input_api, output_api): |
| v8_directory_path = input_api.os_path.join(input_api.PresubmitLocalPath(), |
| 'v8') |
| blink_directory_path = input_api.os_path.join( |
| input_api.PresubmitLocalPath(), 'third_party', 'blink') |
| scripts_build_path = input_api.os_path.join(input_api.PresubmitLocalPath(), |
| 'scripts', 'build') |
| scripts_generated_output_path = input_api.os_path.join( |
| input_api.PresubmitLocalPath(), 'front_end', 'generated') |
| |
| generated_aria_path = input_api.os_path.join(scripts_build_path, |
| 'generate_aria.py') |
| generated_supported_css_path = input_api.os_path.join( |
| scripts_build_path, 'generate_supported_css.py') |
| generated_deprecation_path = input_api.os_path.join( |
| scripts_build_path, 'generate_deprecations.py') |
| generated_protocol_path = input_api.os_path.join( |
| scripts_build_path, 'code_generator_frontend.py') |
| generated_protocol_typescript_path = input_api.os_path.join( |
| input_api.PresubmitLocalPath(), 'scripts', 'protocol_typescript') |
| concatenate_protocols_path = input_api.os_path.join( |
| input_api.PresubmitLocalPath(), 'third_party', 'inspector_protocol', |
| 'concatenate_protocols.py') |
| |
| affected_files = _GetAffectedFiles(input_api, [ |
| v8_directory_path, |
| blink_directory_path, |
| input_api.os_path.join(input_api.PresubmitLocalPath(), 'third_party', |
| 'pyjson5'), |
| generated_aria_path, |
| generated_supported_css_path, |
| generated_deprecation_path, |
| concatenate_protocols_path, |
| generated_protocol_path, |
| scripts_generated_output_path, |
| generated_protocol_typescript_path, |
| ], [], ['.pdl', '.json5', '.py', '.js', '.ts']) |
| |
| if len(affected_files) == 0: |
| return [] |
| |
| generate_protocol_resources_path = input_api.os_path.join( |
| input_api.PresubmitLocalPath(), 'scripts', 'deps', |
| 'generate_protocol_resources.py') |
| |
| return _ExecuteSubProcess(input_api, |
| output_api, |
| generate_protocol_resources_path, |
| message='Generated files') |
| |
| |
| def CheckL10nStrings(input_api, output_api): |
| devtools_root = input_api.PresubmitLocalPath() |
| devtools_front_end = input_api.os_path.join(devtools_root, 'front_end') |
| script_path = input_api.os_path.join(devtools_root, 'third_party', 'i18n', |
| 'check-strings.js') |
| affected_front_end_files = _GetAffectedFiles( |
| input_api, [devtools_front_end, script_path], [], ['.js', '.ts']) |
| if len(affected_front_end_files) == 0: |
| return [] |
| return _CheckWithNodeScript(input_api, |
| output_api, |
| script_path, [devtools_front_end], |
| message='l10n strings') |
| |
| |
| def CheckForTooLargeFiles(input_api, output_api): |
| """Avoid large files, especially binary files, in the repository since |
| git doesn't scale well for those. They will be in everyone's repo |
| clones forever, forever making Chromium slower to clone and work |
| with.""" |
| # Uploading files to cloud storage is not trivial so we don't want |
| # to set the limit too low, but the upper limit for "normal" large |
| # files seems to be 1-2 MB, with a handful around 5-8 MB, so |
| # anything over 20 MB is exceptional. |
| TOO_LARGE_FILE_SIZE_LIMIT = 20 * 1024 * 1024 # 10 MB |
| too_large_files = [] |
| for f in input_api.AffectedFiles(): |
| # Check both added and modified files (but not deleted files). |
| if f.Action() in ('A', 'M'): |
| size = input_api.os_path.getsize(f.AbsoluteLocalPath()) |
| if size > TOO_LARGE_FILE_SIZE_LIMIT: |
| too_large_files.append("%s: %d bytes" % (f.LocalPath(), size)) |
| if too_large_files: |
| message = ( |
| 'Do not commit large files to git since git scales badly for those.\n' |
| + |
| 'Instead put the large files in cloud storage and use DEPS to\n' + |
| 'fetch them.\n' + '\n'.join(too_large_files)) |
| return [ |
| output_api.PresubmitError('Too large files found in commit', |
| long_text=message + '\n') |
| ] |
| return [] |
| |
| |
| def CheckObsoleteScreenshotGoldens(input_api, output_api): |
| interaction_test_root_path = input_api.os_path.join( |
| input_api.PresubmitLocalPath(), 'test', 'interactions') |
| interaction_test_files = [interaction_test_root_path] |
| |
| interaction_test_files_changed = _GetAffectedFiles(input_api, |
| interaction_test_files, |
| [], []) |
| if len(interaction_test_files_changed) == 0: |
| return [] |
| script_path = input_api.os_path.join(input_api.PresubmitLocalPath(), |
| 'scripts', 'test', |
| 'check_obsolete_goldens.js') |
| return _CheckWithNodeScript(input_api, |
| output_api, |
| script_path, |
| script_arguments=[], |
| message='Obsolete screenshot images') |
| |
| |
| def CheckNodeModules(input_api, output_api): |
| files = ['.clang-format', 'OWNERS', 'README.chromium'] |
| results = [] |
| for file in files: |
| file_path = input_api.os_path.join(input_api.PresubmitLocalPath(), |
| 'node_modules', file) |
| if not Path(file_path).is_file(): |
| results.extend([ |
| output_api.PresubmitError( |
| "node_modules/%s is missing. Use npm run install-deps to re-create it." |
| % file) |
| ]) |
| return results |
| |
| |
| def CheckNoUncheckedFiles(input_api, output_api): |
| if _IsEnvCog(input_api): |
| return [] |
| |
| process = input_api.subprocess.Popen(['git', 'diff', '--exit-code'], |
| stdout=input_api.subprocess.PIPE, |
| stderr=input_api.subprocess.STDOUT) |
| out, _ = process.communicate() |
| if process.returncode != 0: |
| files_changed_process = input_api.subprocess.Popen( |
| ['git', 'diff', '--name-only'], |
| stdout=input_api.subprocess.PIPE, |
| stderr=input_api.subprocess.STDOUT) |
| files_changed, _ = files_changed_process.communicate() |
| |
| return [ |
| output_api.PresubmitError( |
| 'You have changed files that need to be committed:\n%s' % |
| (files_changed.decode('utf-8').strip())) |
| ] |
| |
| return [] |
| |
| |
| # Canned check wrappers below. |
| |
| |
| def _TextFilesOnlyFilter(file): |
| """Filters files based on prefixes and extensions that should not be treated as text files for the canned checks below.""" |
| excluded_prefixes = [ |
| 'node_modules', |
| 'third_party', |
| 'front_end/third_party', |
| 'extensions/cxx_debugging/third_party', |
| ] |
| excluded_extensions = [ |
| '.png', '.webm', '.svg', '.avif', '.rawresponse', '.gz' |
| ] |
| |
| if any(file.LocalPath().startswith(prefix) |
| for prefix in excluded_prefixes): |
| return False |
| if any(file.LocalPath().endswith(ext) for ext in excluded_extensions): |
| return False |
| return True |
| |
| |
| def CheckChangeHasNoStrayWhitespace(input_api, output_api): |
| return input_api.canned_checks.CheckChangeHasNoStrayWhitespace( |
| input_api, output_api, source_file_filter=_TextFilesOnlyFilter) |
| |
| |
| def CheckChangeHasNoCrAndHasOnlyOneEol(input_api, output_api): |
| return input_api.canned_checks.CheckChangeHasNoCrAndHasOnlyOneEol( |
| input_api, output_api, source_file_filter=_TextFilesOnlyFilter) |
| |
| |
| def CheckForCommitObjects(input_api, output_api): |
| return input_api.canned_checks.CheckForCommitObjects(input_api, output_api) |
| |
| |
| def CheckOwnersFormat(input_api, output_api): |
| return input_api.canned_checks.CheckOwnersFormat(input_api, output_api) |
| |
| |
| def CheckOwners(input_api, output_api): |
| return input_api.canned_checks.CheckOwners(input_api, output_api) |
| |
| |
| def CheckGenderNeutral(input_api, output_api): |
| return input_api.canned_checks.CheckGenderNeutral(input_api, output_api) |
| |
| |
| def CheckDoNotSubmitInFiles(input_api, output_api): |
| return input_api.canned_checks.CheckDoNotSubmitInFiles( |
| input_api, output_api) |
| |
| |
| def CheckChangeHasDescriptionCommit(input_api, output_api): |
| return input_api.canned_checks.CheckChangeHasDescription( |
| input_api, output_api) |
| |
| |
| def CheckAuthorizedAuthor(input_api, output_api): |
| return input_api.canned_checks.CheckAuthorizedAuthor( |
| input_api, output_api, bot_allowlist=[AUTOROLL_ACCOUNT]) |
