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