forked from autotest/autotest
-
Notifications
You must be signed in to change notification settings - Fork 0
/
action_common.py
284 lines (227 loc) · 9.67 KB
/
action_common.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
#
# Copyright 2008 Google Inc. All Rights Reserved.
"""This module contains the common behavior of some actions
Operations on ACLs or labels are very similar, so are creations and
deletions. The following classes provide the common handling.
In these case, the class inheritance is, taking the command
'atest label create' as an example:
atest
/ \
/ \
/ \
atest_create label
\ /
\ /
\ /
label_create
For 'atest label add':
atest
/ \
/ \
/ \
| label
| |
| |
| |
atest_add label_add_or_remove
\ /
\ /
\ /
label_add
"""
import re, socket, types
from autotest.cli import topic_common
#
# List action
#
class atest_list(topic_common.atest):
"""atest <topic> list"""
usage_action = 'list'
def _convert_wildcard(self, old_key, new_key,
value, filters, check_results):
filters[new_key] = value.rstrip('*')
check_results[new_key] = None
del filters[old_key]
del check_results[old_key]
def _convert_name_wildcard(self, key, value, filters, check_results):
if value.endswith('*'):
# Could be __name, __login, __hostname
new_key = key + '__startswith'
self._convert_wildcard(key, new_key, value, filters, check_results)
def _convert_in_wildcard(self, key, value, filters, check_results):
if value.endswith('*'):
assert key.endswith('__in'), 'Key %s does not end with __in' % key
new_key = key.replace('__in', '__startswith', 1)
self._convert_wildcard(key, new_key, value, filters, check_results)
def check_for_wildcard(self, filters, check_results):
"""Check if there is a wilcard (only * for the moment)
and replace the request appropriately"""
for (key, values) in filters.iteritems():
if isinstance(values, types.StringTypes):
self._convert_name_wildcard(key, values,
filters, check_results)
continue
if isinstance(values, types.ListType):
if len(values) == 1:
self._convert_in_wildcard(key, values[0],
filters, check_results)
continue
for value in values:
if value.endswith('*'):
# Can only be a wildcard if it is by itelf
self.invalid_syntax('Cannot mix wilcards and items')
def execute(self, op, filters={}, check_results={}):
"""Generic list execute:
If no filters where specified, list all the items. If
some specific items where asked for, filter on those:
check_results has the same keys than filters. If only
one filter is set, we use the key from check_result to
print the error"""
self.check_for_wildcard(filters, check_results)
results = self.execute_rpc(op, **filters)
for dbkey in filters.keys():
if not check_results.get(dbkey, None):
# Don't want to check the results
# for this key
continue
if len(results) >= len(filters[dbkey]):
continue
# Some bad items
field = check_results[dbkey]
# The filtering for the job is on the ID which is an int.
# Convert it as the jobids from the CLI args are strings.
good = set(str(result[field]) for result in results)
self.invalid_arg('Unknown %s(s): \n' % self.msg_topic,
', '.join(set(filters[dbkey]) - good))
return results
def output(self, results, keys, sublist_keys=[]):
self.print_table(results, keys, sublist_keys)
#
# Creation & Deletion of a topic (ACL, label, user)
#
class atest_create_or_delete(topic_common.atest):
"""atest <topic> [create|delete]
To subclass this, you must define:
Example Comment
self.topic 'acl_group'
self.op_action 'delete' Action to remove a 'topic'
self.data {} Additional args for the topic
creation/deletion
self.msg_topic: 'ACL' The printable version of the topic.
self.msg_done: 'Deleted' The printable version of the action.
"""
def execute(self):
handled = []
# Create or Delete the <topic> altogether
op = '%s_%s' % (self.op_action, self.topic)
for item in self.get_items():
try:
self.data[self.data_item_key] = item
new_id = self.execute_rpc(op, item=item, **self.data)
handled.append(item)
except topic_common.CliError:
pass
return handled
def output(self, results):
if results:
results = ["'%s'" % r for r in results]
self.print_wrapped("%s %s" % (self.msg_done, self.msg_topic),
results)
class atest_create(atest_create_or_delete):
usage_action = 'create'
op_action = 'add'
msg_done = 'Created'
class atest_delete(atest_create_or_delete):
data_item_key = 'id'
usage_action = op_action = 'delete'
msg_done = 'Deleted'
#
# Adding or Removing things (users, hosts or labels) from a topic
# (ACL, Label or AtomicGroup)
#
class atest_add_or_remove(topic_common.atest):
"""atest <topic> [add|remove]
To subclass this, you must define these attributes:
Example Comment
topic 'acl_group'
op_action 'remove' Action for adding users/hosts
add_remove_things {'users': 'user'} Dict of things to try add/removing.
Keys are the attribute names. Values
are the word to print for an
individual item of such a value.
"""
add_remove_things = {'users': 'user', 'hosts': 'host'} # Original behavior
def _add_remove_uh_to_topic(self, item, what):
"""Adds the 'what' (such as users or hosts) to the 'item'"""
uhs = getattr(self, what)
if len(uhs) == 0:
# To skip the try/else
raise AttributeError
op = '%s_%s_%s' % (self.topic, self.op_action, what)
try:
self.execute_rpc(op=op, # The opcode
**{'id': item, what: uhs}) # The data
setattr(self, 'good_%s' % what, uhs)
except topic_common.CliError, full_error:
bad_uhs = self.parse_json_exception(full_error)
good_uhs = list(set(uhs) - set(bad_uhs))
if bad_uhs and good_uhs:
self.execute_rpc(op=op,
**{'id': item, what: good_uhs})
setattr(self, 'good_%s' % what, good_uhs)
else:
raise
def execute(self):
"""Adds or removes things (users, hosts, etc.) from a topic, e.g.:
Add hosts to labels:
self.topic = 'label'
self.op_action = 'add'
self.add_remove_things = {'users': 'user', 'hosts': 'host'}
self.get_items() = The labels/ACLs that the hosts
should be added to.
Returns:
A dictionary of lists of things added successfully using the same
keys as self.add_remove_things.
"""
oks = {}
for item in self.get_items():
# FIXME(gps):
# This reverse sorting is only here to avoid breaking many
# existing extremely fragile unittests which depend on the
# exact order of the calls made below. 'users' must be run
# before 'hosts'.
plurals = reversed(sorted(self.add_remove_things.keys()))
for what in plurals:
try:
self._add_remove_uh_to_topic(item, what)
except AttributeError:
pass
except topic_common.CliError, err:
# The error was already logged by
# self.failure()
pass
else:
oks.setdefault(item, []).append(what)
results = {}
for thing in self.add_remove_things:
things_ok = [item for item, what in oks.items() if thing in what]
results[thing] = things_ok
return results
def output(self, results):
for thing, single_thing in self.add_remove_things.iteritems():
# Enclose each of the elements in a single quote.
things_ok = ["'%s'" % t for t in results[thing]]
if things_ok:
self.print_wrapped("%s %s %s %s" % (self.msg_done,
self.msg_topic,
', '.join(things_ok),
single_thing),
getattr(self, 'good_%s' % thing))
class atest_add(atest_add_or_remove):
usage_action = op_action = 'add'
msg_done = 'Added to'
usage_words = ('Add', 'to')
class atest_remove(atest_add_or_remove):
usage_action = op_action = 'remove'
msg_done = 'Removed from'
usage_words = ('Remove', 'from')