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
|
# Copyright 2020 The Pigweed Authors
#
# 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
#
# https://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.
"""Argument parsing code for presubmit checks."""
import argparse
import logging
from pathlib import Path
import re
import shutil
from typing import Callable, Collection, Optional, Sequence
from pw_presubmit import git_repo, presubmit
_LOG = logging.getLogger(__name__)
DEFAULT_PATH = Path('out', 'presubmit')
_OUTPUT_PATH_README = '''\
This directory was created by pw_presubmit to run presubmit checks for the
{repo} repository. This directory is not used by the regular GN or CMake Ninja
builds. It may be deleted safely.
'''
def add_path_arguments(parser) -> None:
"""Adds common presubmit check options to an argument parser."""
parser.add_argument(
'paths',
metavar='pathspec',
nargs='*',
help=('Paths or patterns to which to restrict the checks. These are '
'interpreted as Git pathspecs. If --base is provided, only '
'paths changed since that commit are checked.'))
base = parser.add_mutually_exclusive_group()
base.add_argument(
'-b',
'--base',
metavar='commit',
default=git_repo.TRACKING_BRANCH_ALIAS,
help=('Git revision against which to diff for changed files. '
'Default is the tracking branch of the current branch.'))
base.add_argument(
'--full',
dest='base',
action='store_const',
const=None,
help='Run presubmit on all files, not just changed files.')
parser.add_argument(
'-e',
'--exclude',
metavar='regular_expression',
default=[],
action='append',
type=re.compile,
help=('Exclude paths matching any of these regular expressions, '
"which are interpreted relative to each Git repository's root."))
def _add_programs_arguments(exclusive: argparse.ArgumentParser,
programs: presubmit.Programs, default: str):
def presubmit_program(arg: str) -> presubmit.Program:
if arg not in programs:
raise argparse.ArgumentTypeError(
f'{arg} is not the name of a presubmit program')
return programs[arg]
exclusive.add_argument('-p',
'--program',
choices=programs.values(),
type=presubmit_program,
default=default,
help='Which presubmit program to run')
all_steps = programs.all_steps()
# The step argument appends steps to a program. No "step" argument is
# created on the resulting argparse.Namespace.
class AddToCustomProgram(argparse.Action):
def __call__(self, parser, namespace, values, unused_option=None):
if not isinstance(namespace.program, list):
namespace.program = []
if values not in all_steps:
raise parser.error(
f'argument --step: {values} is not the name of a '
'presubmit check\n\nValid values for --step:\n'
f'{{{",".join(sorted(all_steps))}}}')
namespace.program.append(all_steps[values])
exclusive.add_argument(
'--step',
action=AddToCustomProgram,
default=argparse.SUPPRESS, # Don't create a "step" argument.
help='Provide explicit steps instead of running a predefined program.',
)
def add_arguments(parser: argparse.ArgumentParser,
programs: Optional[presubmit.Programs] = None,
default: str = '') -> None:
"""Adds common presubmit check options to an argument parser."""
add_path_arguments(parser)
parser.add_argument('-k',
'--keep-going',
action='store_true',
help='Continue instead of aborting when errors occur.')
parser.add_argument(
'--output-directory',
type=Path,
help=f'Output directory (default: {"<repo root>" / DEFAULT_PATH})',
)
parser.add_argument(
'--package-root',
type=Path,
help='Package root directory (default: <output directory>/packages)',
)
exclusive = parser.add_mutually_exclusive_group()
exclusive.add_argument(
'--clear',
'--clean',
action='store_true',
help='Delete the presubmit output directory and exit.',
)
if programs:
if not default:
raise ValueError('A default must be provided with programs')
_add_programs_arguments(parser, programs, default)
# LUCI builders extract the list of steps from the program and run them
# individually for a better UX in MILO.
parser.add_argument(
'--only-list-steps',
action='store_true',
help=argparse.SUPPRESS,
)
def run(
program: Sequence[Callable],
output_directory: Optional[Path],
package_root: Path,
clear: bool,
root: Path = None,
repositories: Collection[Path] = (),
only_list_steps=False,
**other_args,
) -> int:
"""Processes arguments from add_arguments and runs the presubmit.
Args:
program: from the --program option
output_directory: from --output-directory option
package_root: from --package-root option
clear: from the --clear option
root: base path from which to run presubmit checks; defaults to the root
of the current directory's repository
repositories: roots of Git repositories on which to run presubmit checks;
defaults to the root of the current directory's repository
only_list_steps: list the steps that would be executed, one per line,
instead of executing them
**other_args: remaining arguments defined by by add_arguments
Returns:
exit code for sys.exit; 0 if succesful, 1 if an error occurred
"""
if root is None:
root = git_repo.root()
if not repositories:
repositories = [root]
if output_directory is None:
output_directory = root / DEFAULT_PATH
output_directory.mkdir(parents=True, exist_ok=True)
output_directory.joinpath('README.txt').write_text(
_OUTPUT_PATH_README.format(repo=root))
if not package_root:
package_root = output_directory / 'packages'
_LOG.debug('Using environment at %s', output_directory)
if clear:
_LOG.info('Clearing presubmit output directory')
if output_directory.exists():
shutil.rmtree(output_directory)
_LOG.info('Deleted %s', output_directory)
return 0
if presubmit.run(program,
root,
repositories,
only_list_steps=only_list_steps,
output_directory=output_directory,
package_root=package_root,
**other_args):
return 0
return 1
|
