forked from google/perfetto
-
Notifications
You must be signed in to change notification settings - Fork 1
/
PRESUBMIT.py
330 lines (271 loc) · 10.9 KB
/
PRESUBMIT.py
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
# Copyright (C) 2017 The Android Open Source Project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import print_function
import itertools
import subprocess
import time
USE_PYTHON3 = True
def RunAndReportIfLong(func, *args, **kargs):
start = time.time()
results = func(*args, **kargs)
end = time.time()
limit = 0.5 # seconds
name = func.__name__
runtime = end - start
if runtime > limit:
print("{} took >{:.2}s ({:.2}s)".format(name, limit, runtime))
return results
def CheckChange(input, output):
# There apparently is no way to wrap strings in blueprints, so ignore long
# lines in them.
def long_line_sources(x):
return input.FilterSourceFile(
x,
files_to_check='.*',
files_to_skip=[
'Android[.]bp',
"buildtools/grpc/BUILD.gn",
'.*[.]json$',
'.*[.]sql$',
'.*[.]out$',
'test/trace_processor/.*/tests.*$',
'(.*/)?BUILD$',
'WORKSPACE',
'.*/Makefile$',
'/perfetto_build_flags.h$',
"infra/luci/.*",
])
results = []
results += RunAndReportIfLong(input.canned_checks.CheckDoNotSubmit, input,
output)
results += RunAndReportIfLong(input.canned_checks.CheckChangeHasNoTabs, input,
output)
results += RunAndReportIfLong(
input.canned_checks.CheckLongLines,
input,
output,
80,
source_file_filter=long_line_sources)
results += RunAndReportIfLong(
input.canned_checks.CheckPatchFormatted, input, output, check_js=True)
results += RunAndReportIfLong(input.canned_checks.CheckGNFormatted, input,
output)
results += RunAndReportIfLong(CheckIncludeGuards, input, output)
results += RunAndReportIfLong(CheckIncludeViolations, input, output)
results += RunAndReportIfLong(CheckProtoComments, input, output)
results += RunAndReportIfLong(CheckBuild, input, output)
results += RunAndReportIfLong(CheckAndroidBlueprint, input, output)
results += RunAndReportIfLong(CheckBinaryDescriptors, input, output)
results += RunAndReportIfLong(CheckMergedTraceConfigProto, input, output)
results += RunAndReportIfLong(CheckProtoEventList, input, output)
results += RunAndReportIfLong(CheckBannedCpp, input, output)
results += RunAndReportIfLong(CheckSqlModules, input, output)
results += RunAndReportIfLong(CheckSqlMetrics, input, output)
results += RunAndReportIfLong(CheckTestData, input, output)
results += RunAndReportIfLong(CheckAmalgamatedPythonTools, input, output)
return results
def CheckChangeOnUpload(input_api, output_api):
return CheckChange(input_api, output_api)
def CheckChangeOnCommit(input_api, output_api):
return CheckChange(input_api, output_api)
def CheckBuild(input_api, output_api):
tool = 'tools/gen_bazel'
# If no GN files were modified, bail out.
def build_file_filter(x):
return input_api.FilterSourceFile(
x, files_to_check=('.*BUILD[.]gn$', '.*[.]gni$', 'BUILD\.extras', tool))
if not input_api.AffectedSourceFiles(build_file_filter):
return []
if subprocess.call([tool, '--check-only']):
return [
output_api.PresubmitError('Bazel BUILD(s) are out of date. Run ' +
tool + ' to update them.')
]
return []
def CheckAndroidBlueprint(input_api, output_api):
tool = 'tools/gen_android_bp'
# If no GN files were modified, bail out.
def build_file_filter(x):
return input_api.FilterSourceFile(
x, files_to_check=('.*BUILD[.]gn$', '.*[.]gni$', tool))
if not input_api.AffectedSourceFiles(build_file_filter):
return []
if subprocess.call([tool, '--check-only']):
return [
output_api.PresubmitError('Android build files are out of date. ' +
'Run ' + tool + ' to update them.')
]
return []
def CheckIncludeGuards(input_api, output_api):
tool = 'tools/fix_include_guards'
def file_filter(x):
return input_api.FilterSourceFile(
x, files_to_check=['.*[.]cc$', '.*[.]h$', tool])
if not input_api.AffectedSourceFiles(file_filter):
return []
if subprocess.call([tool, '--check-only']):
return [
output_api.PresubmitError('Please run ' + tool +
' to fix include guards.')
]
return []
def CheckBannedCpp(input_api, output_api):
bad_cpp = [
(r'\bstd::stoi\b',
'std::stoi throws exceptions prefer base::StringToInt32()'),
(r'\bstd::stol\b',
'std::stoull throws exceptions prefer base::StringToInt32()'),
(r'\bstd::stoul\b',
'std::stoull throws exceptions prefer base::StringToUint32()'),
(r'\bstd::stoll\b',
'std::stoull throws exceptions prefer base::StringToInt64()'),
(r'\bstd::stoull\b',
'std::stoull throws exceptions prefer base::StringToUint64()'),
(r'\bstd::stof\b',
'std::stof throws exceptions prefer base::StringToDouble()'),
(r'\bstd::stod\b',
'std::stod throws exceptions prefer base::StringToDouble()'),
(r'\bstd::stold\b',
'std::stold throws exceptions prefer base::StringToDouble()'),
(r'\bstrncpy\b',
'strncpy does not null-terminate if src > dst. Use base::StringCopy'),
(r'[(=]\s*snprintf\(',
'snprintf can return > dst_size. Use base::SprintfTrunc'),
(r'//.*\bDNS\b',
'// DNS (Do Not Ship) found. Did you mean to remove some testing code?'),
(r'\bPERFETTO_EINTR\(close\(',
'close(2) must not be retried on EINTR on Linux and other OSes '
'that we run on, as the fd will be closed.'),
(r'^#include <inttypes.h>', 'Use <cinttypes> rather than <inttypes.h>. ' +
'See https://github.com/google/perfetto/issues/146'),
]
def file_filter(x):
return input_api.FilterSourceFile(x, files_to_check=[r'.*\.h$', r'.*\.cc$'])
errors = []
for f in input_api.AffectedSourceFiles(file_filter):
for line_number, line in f.ChangedContents():
if input_api.re.search(r'^\s*//', line):
continue # Skip comments
for regex, message in bad_cpp:
if input_api.re.search(regex, line):
errors.append(
output_api.PresubmitError('Banned pattern:\n {}:{} {}'.format(
f.LocalPath(), line_number, message)))
return errors
def CheckIncludeViolations(input_api, output_api):
tool = 'tools/check_include_violations'
def file_filter(x):
return input_api.FilterSourceFile(
x, files_to_check=['include/.*[.]h$', tool])
if not input_api.AffectedSourceFiles(file_filter):
return []
if subprocess.call([tool]):
return [output_api.PresubmitError(tool + ' failed.')]
return []
def CheckBinaryDescriptors(input_api, output_api):
tool = 'tools/gen_binary_descriptors'
def file_filter(x):
return input_api.FilterSourceFile(
x, files_to_check=['protos/perfetto/.*[.]proto$', '.*[.]h', tool])
if not input_api.AffectedSourceFiles(file_filter):
return []
if subprocess.call([tool, '--check-only']):
return [
output_api.PresubmitError('Please run ' + tool +
' to update binary descriptors.')
]
return []
def CheckMergedTraceConfigProto(input_api, output_api):
tool = 'tools/gen_merged_protos'
def build_file_filter(x):
return input_api.FilterSourceFile(
x, files_to_check=['protos/perfetto/.*[.]proto$', tool])
if not input_api.AffectedSourceFiles(build_file_filter):
return []
if subprocess.call([tool, '--check-only']):
return [
output_api.PresubmitError(
'perfetto_config.proto or perfetto_trace.proto is out of ' +
'date. Please run ' + tool + ' to update it.')
]
return []
# Prevent removing or changing lines in event_list.
def CheckProtoEventList(input_api, output_api):
for f in input_api.AffectedFiles():
if f.LocalPath() != 'src/tools/ftrace_proto_gen/event_list':
continue
if any((not new_line.startswith('removed')) and new_line != old_line
for old_line, new_line in zip(f.OldContents(), f.NewContents())):
return [
output_api.PresubmitError(
'event_list only has two supported changes: '
'appending a new line, and replacing a line with removed.')
]
return []
def CheckProtoComments(input_api, output_api):
tool = 'tools/check_proto_comments'
def file_filter(x):
return input_api.FilterSourceFile(
x, files_to_check=['protos/perfetto/.*[.]proto$', tool])
if not input_api.AffectedSourceFiles(file_filter):
return []
if subprocess.call([tool]):
return [output_api.PresubmitError(tool + ' failed')]
return []
def CheckSqlModules(input_api, output_api):
tool = 'tools/check_sql_modules.py'
def file_filter(x):
return input_api.FilterSourceFile(
x, files_to_check=['src/trace_processor/stdlib/.*[.]sql$', tool])
if not input_api.AffectedSourceFiles(file_filter):
return []
if subprocess.call([tool]):
return [output_api.PresubmitError(tool + ' failed')]
return []
def CheckSqlMetrics(input_api, output_api):
tool = 'tools/check_sql_metrics.py'
def file_filter(x):
return input_api.FilterSourceFile(
x, files_to_check=['src/trace_processor/metrics/.*[.]sql$', tool])
if not input_api.AffectedSourceFiles(file_filter):
return []
if subprocess.call([tool]):
return [output_api.PresubmitError(tool + ' failed')]
return []
def CheckTestData(input_api, output_api):
tool = 'tools/test_data'
if subprocess.call([tool, 'status', '--quiet']):
return [
output_api.PresubmitError(
'//test/data is out of sync. Run ' + tool + ' status for more. \n'
'If you rebaselined UI tests or added a new test trace, run:'
'`tools/test_data upload`. Otherwise run `tools/install-build-deps`'
' or `tools/test_data download --overwrite` to sync local test_data'
)
]
return []
def CheckAmalgamatedPythonTools(input_api, output_api):
tool = 'tools/gen_amalgamated_python_tools'
# If no GN files were modified, bail out.
def build_file_filter(x):
return input_api.FilterSourceFile(x, files_to_check=('python/.*$', tool))
if not input_api.AffectedSourceFiles(build_file_filter):
return []
if subprocess.call([tool, '--check-only']):
return [
output_api.PresubmitError(
'amalgamated python tools/ are out of date. ' + 'Run ' + tool +
' to update them.')
]
return []