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
|
# Copyright 2018 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Common config and logic for binary search tool
This module serves two main purposes:
1. Programatically include the utils module in PYTHONPATH
2. Create the argument parsing shared between binary_search_state.py and
bisect.py
The argument parsing is handled by populating _ArgsDict with all arguments.
_ArgsDict is required so that binary_search_state.py and bisect.py can share
the argument parsing, but treat them slightly differently. For example,
bisect.py requires that all argument defaults are suppressed so that overriding
can occur properly (i.e. only options that are explicitly entered by the user
end up in the resultant options dictionary).
ArgumentDict inherits OrderedDict in order to preserve the order the args are
created so the help text is made properly.
"""
from __future__ import print_function
import collections
import os
import sys
# Programatically adding utils python path to PYTHONPATH
if os.path.isabs(sys.argv[0]):
utils_pythonpath = os.path.abspath('{0}/..'.format(
os.path.dirname(sys.argv[0])))
else:
wdir = os.getcwd()
utils_pythonpath = os.path.abspath('{0}/{1}/..'.format(wdir, os.path.dirname(
sys.argv[0])))
sys.path.append(utils_pythonpath)
class ArgumentDict(collections.OrderedDict):
"""Wrapper around OrderedDict, represents CLI arguments for program.
AddArgument enforces the following layout:
{
['-n', '--iterations'] : {
'dest': 'iterations',
'type': int,
'help': 'Number of iterations to try in the search.',
'default': 50
}
[arg_name1, arg_name2, ...] : {
arg_option1 : arg_option_val1,
...
},
...
}
"""
_POSSIBLE_OPTIONS = ['action', 'nargs', 'const', 'default', 'type', 'choices',
'required', 'help', 'metavar', 'dest']
def AddArgument(self, *args, **kwargs):
"""Add argument to ArgsDict, has same signature as argparse.add_argument
Emulates the the argparse.add_argument method so the internal OrderedDict
can be safely and easily populated. Each call to this method will have a 1-1
corresponding call to argparse.add_argument once BuildArgParser is called.
Args:
*args: The names for the argument (-V, --verbose, etc.)
**kwargs: The options for the argument, corresponds to the args of
argparse.add_argument
Returns:
None
Raises:
TypeError: if args is empty or if option in kwargs is not a valid
option for argparse.add_argument.
"""
if len(args) == 0:
raise TypeError('Argument needs at least one name')
for key in kwargs:
if key not in self._POSSIBLE_OPTIONS:
raise TypeError('Invalid option "%s" for argument %s' % (key, args[0]))
self[args] = kwargs
_ArgsDict = ArgumentDict()
def GetArgsDict():
"""_ArgsDict singleton method"""
if not _ArgsDict:
_BuildArgsDict(_ArgsDict)
return _ArgsDict
def BuildArgParser(parser, override=False):
"""Add all arguments from singleton ArgsDict to parser.
Will take argparse parser and add all arguments in ArgsDict. Will ignore
the default and required options if override is set to True.
Args:
parser: type argparse.ArgumentParser, will call add_argument for every item
in _ArgsDict
override: True if being called from bisect.py. Used to say that default and
required options are to be ignored
Returns:
None
"""
ArgsDict = GetArgsDict()
# Have no defaults when overriding
for arg_names, arg_options in ArgsDict.iteritems():
if override:
arg_options = arg_options.copy()
arg_options.pop('default', None)
arg_options.pop('required', None)
parser.add_argument(*arg_names, **arg_options)
def StrToBool(str_in):
if str_in.lower() in ['true', 't', '1']:
return True
if str_in.lower() in ['false', 'f', '0']:
return False
raise AttributeError('%s is not a valid boolean string' % str_in)
def _BuildArgsDict(args):
"""Populate ArgumentDict with all arguments"""
args.AddArgument(
'-n',
'--iterations',
dest='iterations',
type=int,
help='Number of iterations to try in the search.',
default=50)
args.AddArgument(
'-i',
'--get_initial_items',
dest='get_initial_items',
help='Script to run to get the initial objects. '
'If your script requires user input '
'the --verbose option must be used')
args.AddArgument(
'-g',
'--switch_to_good',
dest='switch_to_good',
help='Script to run to switch to good. '
'If your switch script requires user input '
'the --verbose option must be used')
args.AddArgument(
'-b',
'--switch_to_bad',
dest='switch_to_bad',
help='Script to run to switch to bad. '
'If your switch script requires user input '
'the --verbose option must be used')
args.AddArgument(
'-I',
'--test_setup_script',
dest='test_setup_script',
help='Optional script to perform building, flashing, '
'and other setup before the test script runs.')
args.AddArgument(
'-t',
'--test_script',
dest='test_script',
help='Script to run to test the '
'output after packages are built.')
# No input (evals to False),
# --prune (evals to True),
# --prune=False,
# --prune=True
args.AddArgument(
'-p',
'--prune',
dest='prune',
nargs='?',
const=True,
default=False,
type=StrToBool,
metavar='bool',
help='If True, continue until all bad items are found. '
'Defaults to False.')
args.AddArgument(
'-P',
'--pass_bisect',
dest='pass_bisect',
default=None,
help='Script to generate another script for pass level bisect, '
'which contains command line options to build bad item.'
'For now it only supports one single bad item, so to use it, '
'prune must be set to false.')
# No input (evals to False),
# --noincremental (evals to True),
# --noincremental=False,
# --noincremental=True
args.AddArgument(
'-c',
'--noincremental',
dest='noincremental',
nargs='?',
const=True,
default=False,
type=StrToBool,
metavar='bool',
help='If True, don\'t propagate good/bad changes '
'incrementally. Defaults to False.')
# No input (evals to False),
# --file_args (evals to True),
# --file_args=False,
# --file_args=True
args.AddArgument(
'-f',
'--file_args',
dest='file_args',
nargs='?',
const=True,
default=False,
type=StrToBool,
metavar='bool',
help='Whether to use a file to pass arguments to scripts. '
'Defaults to False.')
# No input (evals to True),
# --verify (evals to True),
# --verify=False,
# --verify=True
args.AddArgument(
'--verify',
dest='verify',
nargs='?',
const=True,
default=True,
type=StrToBool,
metavar='bool',
help='Whether to run verify iterations before searching. '
'Defaults to True.')
args.AddArgument(
'-N',
'--prune_iterations',
dest='prune_iterations',
type=int,
help='Number of prune iterations to try in the search.',
default=100)
# No input (evals to False),
# --verbose (evals to True),
# --verbose=False,
# --verbose=True
args.AddArgument(
'-V',
'--verbose',
dest='verbose',
nargs='?',
const=True,
default=False,
type=StrToBool,
metavar='bool',
help='If True, print full output to console.')
args.AddArgument(
'-r',
'--resume',
dest='resume',
action='store_true',
help='Resume bisection tool execution from state file.'
'Useful if the last bisection was terminated '
'before it could properly finish.')
|
