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
|
# Copyright 2017 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Presubmit script for //testing/buildbot/filters.
See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts
for more details about the presubmit API built into depot_tools.
"""
import os
import re
def _CheckFilterFileFormat(input_api, output_api):
"""This ensures all modified filter files are free of common syntax errors.
See the following for the correct syntax of these files:
https://chromium.googlesource.com/chromium/src/+/main/testing/buildbot/filters/README.md#file-syntax
As well as:
https://bit.ly/chromium-test-list-format
"""
errors = []
warnings = []
for f in input_api.AffectedFiles():
filename = os.path.basename(f.LocalPath())
if not filename.endswith('.filter'):
# Non-filter files. Ignore these.
continue
inclusions = 0
exclusions = 0
for line_num, line in enumerate(f.NewContents()):
# Implicitly allow for trailing (but not leading) whitespace.
# Allow nocheck comments
line = line.rstrip().replace('# nocheck', '')
if not line:
# Empty line. Ignore these.
continue
if line.startswith('#'):
# A comment. Ignore these.
continue
if line.find('#') >= 0:
errors.append(
'%s:%d "#" is not a valid method separator. Use ".": "%s"' % (
filename, line_num, line))
continue
if line.startswith('//') or line.startswith('/*'):
errors.append(
'%s:%d Not a valid comment syntax. Use "#" instead: "%s"' % (
filename, line_num, line))
continue
if not re.match(r'^\S+$', line):
errors.append(
'%s:%d Line must not contain whitespace: "%s"' % (
filename, line_num, line))
continue
if line[0] == '-':
exclusions += 1
else:
inclusions += 1
# If we have a mix of exclusions and inclusions, print a warning with a
# Y/N prompt to the author. Though this is a valid syntax, it's possible
# that such a combination will lead to a situation where zero tests are run.
if exclusions and inclusions:
warnings.append(
'%s: Contains both inclusions (%d) and exclusions (%d). This may '
'result in no tests running. Are you sure this is correct?' % (
filename, inclusions, exclusions))
res = []
if errors:
res.append(output_api.PresubmitError(
'Filter files do not follow the correct format:',
long_text='\n'.join(errors)))
if warnings:
res.append(output_api.PresubmitPromptWarning(
'Filter files may be incorrect:\n%s' % '\n'.join(warnings)))
return res
def CommonChecks(input_api, output_api):
return _CheckFilterFileFormat(input_api, output_api)
def CheckChangeOnUpload(input_api, output_api):
return CommonChecks(input_api, output_api)
def CheckChangeOnCommit(input_api, output_api):
return CommonChecks(input_api, output_api)
|
