1# Copyright (c) 2018 The Chromium Authors. All rights reserved. 2# Use of this source code is governed by a BSD-style license that can be 3# found in the LICENSE file. 4 5import os 6import re 7import sys 8 9_REPO_PATH = os.path.dirname(os.path.realpath('__file__')) 10_IMPORT_SUBFOLDERS = ['tools', os.path.join('buildtools', 'checkdeps')] 11 12# git-cl upload is not compatible with __init__.py based subfolder imports, so 13# we extend the system path instead. 14sys.path.extend(os.path.join(_REPO_PATH, p) for p in _IMPORT_SUBFOLDERS) 15 16import licenses 17from checkdeps import DepsChecker 18 19# Opt-in to using Python3 instead of Python2, as part of the ongoing Python2 20# deprecation. For more information, see 21# https://issuetracker.google.com/173766869. 22USE_PYTHON3 = True 23 24# Rather than pass this to all of the checks, we override the global excluded 25# list with this one. 26_EXCLUDED_PATHS = ( 27 # Exclude all of third_party/ except for BUILD.gns that we maintain. 28 r'third_party[\\\/].*(?<!BUILD.gn)$', 29 30 # Exclude everything under third_party/chromium_quic/{src|build} 31 r'third_party/chromium_quic/(src|build)/.*', 32 33 # Output directories (just in case) 34 r'.*\bDebug[\\\/].*', 35 r'.*\bRelease[\\\/].*', 36 r'.*\bxcodebuild[\\\/].*', 37 r'.*\bout[\\\/].*', 38 39 # There is no point in processing a patch file. 40 r'.+\.diff$', 41 r'.+\.patch$', 42) 43 44 45def _CheckLicenses(input_api, output_api): 46 """Checks third party licenses and returns a list of violations.""" 47 return [ 48 output_api.PresubmitError(v) for v in licenses.ScanThirdPartyDirs() 49 ] 50 51 52def _CheckDeps(input_api, output_api): 53 """Checks DEPS rules and returns a list of violations.""" 54 deps_checker = DepsChecker(input_api.PresubmitLocalPath()) 55 deps_checker.CheckDirectory(input_api.PresubmitLocalPath()) 56 deps_results = deps_checker.results_formatter.GetResults() 57 return [output_api.PresubmitError(v) for v in deps_results] 58 59 60# Matches OSP_CHECK(foo.is_value()) or OSP_DCHECK(foo.is_value()) 61_RE_PATTERN_VALUE_CHECK = re.compile( 62 r'\s*OSP_D?CHECK\([^)]*\.is_value\(\)\);\s*') 63 64# Matches Foo(Foo&&) when not followed by noexcept. 65_RE_PATTERN_MOVE_WITHOUT_NOEXCEPT = re.compile( 66 r'\s*(?P<classname>\w+)\((?P=classname)&&[^)]*\)\s*(?!noexcept)\s*[{;=]') 67 68 69def _CheckNoRegexMatches(regex, 70 filename, 71 clean_lines, 72 linenum, 73 error, 74 error_type, 75 error_msg, 76 include_cpp_files=True): 77 """Checks that there are no matches for a specific regex. 78 79 Args: 80 regex: regex to use for matching. 81 filename: The name of the current file. 82 clean_lines: A CleansedLines instance containing the file. 83 linenum: The number of the line to check. 84 error: The function to call with any errors found. 85 error_type: type of error, e.g. runtime/noexcept 86 error_msg: Specific message to prepend when regex match is found. 87 """ 88 if not include_cpp_files and not filename.endswith('.h'): 89 return 90 91 line = clean_lines.elided[linenum] 92 matched = regex.match(line) 93 if matched: 94 error(filename, linenum, error_type, 4, 95 'Error: {} at {}'.format(error_msg, 96 matched.group(0).strip())) 97 98 99def _CheckNoValueDchecks(filename, clean_lines, linenum, error): 100 """Checks that there are no OSP_DCHECK(foo.is_value()) instances. 101 102 filename: The name of the current file. 103 clean_lines: A CleansedLines instance containing the file. 104 linenum: The number of the line to check. 105 error: The function to call with any errors found. 106 """ 107 _CheckNoRegexMatches(_RE_PATTERN_VALUE_CHECK, filename, clean_lines, 108 linenum, error, 'runtime/is_value_dchecks', 109 'Unnecessary CHECK for ErrorOr::is_value()') 110 111 112def _CheckNoexceptOnMove(filename, clean_lines, linenum, error): 113 """Checks that move constructors are declared with 'noexcept'. 114 115 filename: The name of the current file. 116 clean_lines: A CleansedLines instance containing the file. 117 linenum: The number of the line to check. 118 error: The function to call with any errors found. 119 """ 120 # We only check headers as noexcept is meaningful on declarations, not 121 # definitions. This may skip some definitions in .cc files though. 122 _CheckNoRegexMatches(_RE_PATTERN_MOVE_WITHOUT_NOEXCEPT, filename, 123 clean_lines, linenum, error, 'runtime/noexcept', 124 'Move constructor not declared \'noexcept\'', False) 125 126# - We disable c++11 header checks since Open Screen allows them. 127# - We disable whitespace/braces because of various false positives. 128# - There are some false positives with 'explicit' checks, but it's useful 129# enough to keep. 130# - We add a custom check for 'noexcept' usage. 131def _CheckChangeLintsClean(input_api, output_api): 132 """Checks that all '.cc' and '.h' files pass cpplint.py.""" 133 cpplint = input_api.cpplint 134 # Directive that allows access to a protected member _XX of a client class. 135 # pylint: disable=protected-access 136 cpplint._cpplint_state.ResetErrorCounts() 137 138 cpplint._SetFilters('-build/c++11,-whitespace/braces') 139 files = [ 140 f.AbsoluteLocalPath() for f in input_api.AffectedSourceFiles(None) 141 ] 142 CPPLINT_VERBOSE_LEVEL = 4 143 for file_name in files: 144 cpplint.ProcessFile(file_name, CPPLINT_VERBOSE_LEVEL, 145 [_CheckNoexceptOnMove, _CheckNoValueDchecks]) 146 147 if cpplint._cpplint_state.error_count: 148 if input_api.is_committing: 149 res_type = output_api.PresubmitError 150 else: 151 res_type = output_api.PresubmitPromptWarning 152 return [res_type('Changelist failed cpplint.py check.')] 153 154 return [] 155 156 157def _CommonChecks(input_api, output_api): 158 # PanProjectChecks include: 159 # CheckLongLines (@ 80 cols) 160 # CheckChangeHasNoTabs 161 # CheckChangeHasNoStrayWhitespace 162 # CheckLicense 163 # CheckChangeWasUploaded (if committing) 164 # CheckChangeHasDescription 165 # CheckDoNotSubmitInDescription 166 # CheckDoNotSubmitInFiles 167 results = input_api.canned_checks.PanProjectChecks(input_api, 168 output_api, 169 owners_check=False) 170 171 # No carriage return characters, files end with one EOL (\n). 172 results.extend( 173 input_api.canned_checks.CheckChangeHasNoCrAndHasOnlyOneEol( 174 input_api, output_api)) 175 176 # Ensure code change is gender inclusive. 177 results.extend( 178 input_api.canned_checks.CheckGenderNeutral(input_api, output_api)) 179 180 # Ensure code change to do items uses TODO(bug) or TODO(user) format. 181 # TODO(bug) is generally preferred. 182 results.extend( 183 input_api.canned_checks.CheckChangeTodoHasOwner(input_api, output_api)) 184 185 # Ensure code change passes linter cleanly. 186 results.extend(_CheckChangeLintsClean(input_api, output_api)) 187 188 # Ensure code change has already had clang-format ran. 189 results.extend( 190 input_api.canned_checks.CheckPatchFormatted(input_api, 191 output_api, 192 bypass_warnings=False)) 193 194 # Ensure code change has had GN formatting ran. 195 results.extend( 196 input_api.canned_checks.CheckGNFormatted(input_api, output_api)) 197 198 # Run buildtools/checkdeps on code change. 199 results.extend(_CheckDeps(input_api, output_api)) 200 201 # Run tools/licenses on code change. 202 # TODO(https://crbug.com/1215335): licenses check is confused by our 203 # buildtools checkout that doesn't actually check out the libraries. 204 licenses.PRUNE_PATHS.add(os.path.join('buildtools', 'third_party')); 205 results.extend(_CheckLicenses(input_api, output_api)) 206 207 return results 208 209 210def CheckChangeOnUpload(input_api, output_api): 211 input_api.DEFAULT_FILES_TO_SKIP = _EXCLUDED_PATHS 212 # We always run the OnCommit checks, as well as some additional checks. 213 results = CheckChangeOnCommit(input_api, output_api) 214 # TODO(crbug.com/1220846): Open Screen needs a `main` config_set. 215 #results.extend( 216 # input_api.canned_checks.CheckChangedLUCIConfigs(input_api, output_api)) 217 return results 218 219 220def CheckChangeOnCommit(input_api, output_api): 221 input_api.DEFAULT_FILES_TO_SKIP = _EXCLUDED_PATHS 222 return _CommonChecks(input_api, output_api) 223