mirrored from https://chromium.googlesource.com/infra/luci/recipes-py
-
Notifications
You must be signed in to change notification settings - Fork 17
/
test_api.py
285 lines (257 loc) · 9.08 KB
/
test_api.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
# Copyright 2018 The LUCI Authors. All rights reserved.
# Use of this source code is governed under the Apache License, Version 2.0
# that can be found in the LICENSE file.
import json
from recipe_engine import recipe_test_api
from PB.recipe_modules.recipe_engine.swarming import properties
from .api import TaskRequest
from .state import TaskState
class SwarmingTestApi(recipe_test_api.RecipeTestApi):
TaskState = TaskState
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self._task_id_count = 0
self._saved_task_for_show_request = None
def check_triggered_request(self, check, step_odict, step, *checkers):
"""Check the input request of a swarming trigger call.
Args:
check, step_odict: provided by post_process
step (str): the step name to check
checkers (Seq[lambda]): a list of functions that take in two args: |check|
and a TaskRequest object.
Example usage:
c1 = lambda check, req: check(req[0].dimensions == {'os': 'Linux'})
c2 = lambda check, req: check(req[0].env == {'FOO': '42'})
post_check(api.swarming.check_triggered_request, 'trigger foo', c1, c2)
"""
# step.json.input is not available.
cmd = step_odict[step].cmd
json_d = cmd[cmd.index('-json-input') + 1]
json_reqs = json.loads(json_d)['requests']
for jr in json_reqs:
req = TaskRequest(self.m)._from_jsonish(jr)
for c in checkers:
c(check, req)
def example_task_request_jsonish(self):
"""Returns a dict that can be parsed by task_request_from_jsonish()."""
return {
'name': 'QEMU',
'priority': 20,
'service_account': 'foo@example.com',
'task_slices': [{
'expiration_secs': '18000',
'properties': {
'cipd_input': {
'packages': [],
'server': ''
},
'command': ['/bin/true'],
'relative_cwd': 'some/dir',
'containment': {
'containment_type': 'NONE',
'limit_processes': False,
'limit_total_committed_memory': False,
'lower_priority': False,
},
'dimensions': [{
'key': 'pool',
'value': 'swarming-pool',
}],
'env': [],
'env_prefixes': [],
'execution_timeout_secs': '2400',
'grace_period_secs': '30',
'cas_input_root': {
'cas_instance':
'projects/example-project/instances/default_instance',
'digest': {
'hash':
'24b2420bc49d8b8fdc1d011a163708927532b37dc9f91d7d8d6877e3a86559ca',
'size_bytes':
'73',
},
},
'idempotent': False,
'io_timeout_secs': '430',
'outputs': []
}
}],
'realm': 'project:bucket',
'resultdb': {
'enable': True,
},
}
def properties(self, task_id='fake-task-id', bot_id='fake-bot-id'):
return self.m.properties.environ(
properties.EnvProperties(
SWARMING_TASK_ID=task_id, SWARMING_BOT_ID=bot_id))
def trigger(self, task_names, initial_id=None, resultdb=True):
"""Generates step test data intended to mock api.swarming.trigger()
Args:
task_names (seq[str]): A sequence of task names representing the tasks we
want to trigger.
initial_id (int): The beginning of the ID range.
resultdb (bool|seq[bool]): If true, adds an invocation name to the trigger
output. A sequence of bools can be passed to add an invocation on a
task-by-task basis.
"""
start = self._task_id_count if initial_id is None else initial_id
self._task_id_count += len(task_names)
if resultdb in (True, False):
resultdb = [resultdb] * len(task_names)
assert len(resultdb) == len(task_names)
trigger_output = {'tasks': []}
for idx, (name, add_invocation) in enumerate(
zip(task_names, resultdb), start=start):
task_output = {
'task_id': '%d' % idx,
'request': {
'name': name,
},
}
if add_invocation:
task_output['task_result'] = {
'resultdb_info': {
'invocation': 'invocations/%d' % idx,
},
}
trigger_output['tasks'].append(task_output)
return self.m.json.output(trigger_output)
@staticmethod
def task_result(id,
name,
state=TaskState.COMPLETED,
duration=62.35,
failure=False,
output='hello world!',
outputs=(),
bot_id='vm-123'):
"""
Returns the raw results of a Swarming task.
Args:
id (str): The ID of the task.
name (str): The name of the task.
state (TaskState|None): The final state of the task; if None, the task is
regarded to be in an unknown state.
duration (int): The duration of the task
failure (bool): Whether the task failed; ignored if state is not
TaskState.COMPLETE.
output (str): That raw output of the task.
outputs (seq(str)):
"""
assert isinstance(state, TaskState) or state == None
assert state not in [
TaskState.INVALID,
TaskState.PENDING,
TaskState.RUNNING,
], 'state %s invalid or not final' % state.name
if state == None:
return {
'error': 'Bot could not be contacted',
'results': {
'task_id': id
},
}
cas_hash = '24b2420bc49d8b8fdc1d011a163708927532b37dc9f91d7d8d6877e3a86559ca'
raw_results = {
'output': output,
'outputs': outputs,
'results': {
'bot_id': bot_id,
'name': name,
'task_id': id,
'state': state.name,
'duration': duration,
'cas_output_root': {
'cas_instance':
'projects/example-project/instances/default_instance',
'digest': {
'hash': cas_hash,
'size_bytes': '73',
},
},
'resultdb_info': {
'invocation': 'invocations/some-inv-name',
},
},
}
if state == TaskState.COMPLETED:
raw_results['results']['exit_code'] = str(int(failure))
return raw_results
def collect(self, task_results):
"""Generates test step data for the swarming API collect method.
Args:
task_results (seq[dict]): A sequence of dicts encoding swarming task
results.
Returns:
Step test data in the form of JSON output intended to mock a swarming API
collect method call.
"""
id_to_result = {
result['results']['task_id']: result for result in task_results
}
return self.m.json.output(id_to_result)
def set_task_for_show_request(self, task):
self._saved_task_for_show_request = task
def show_request(self):
"""Return saved TaskRequest jsonish data for the Swarming API show-request
method.
Returns:
Step test data in the form of JSON output intended to mock a swarming API
show-request method call.
"""
task = self._saved_task_for_show_request
if isinstance(task, TaskRequest):
task = task.to_jsonish()
return self.m.json.output_stream(task)
def generate_bot_json(self,
bot_id,
is_dead=False,
quarantined=False,
maintenance_msg=None,
dimensions=None,
state=None):
bot = {'bot_id': bot_id}
if is_dead:
bot['is_dead'] = True
if quarantined:
bot['quarantined'] = True
if maintenance_msg:
bot['maintenance_msg'] = maintenance_msg
if dimensions:
bot['dimensions'] = [{
'key': k,
'value': v
} for k, v in dimensions.items()]
if state:
bot['state'] = self.m.json.dumps(state)
return bot
def list_bots(self, dimensions=None):
"""Generates step test data intended to mock api.swarming.list_bots()
Args:
dimensions (None|Dict[str, str]): Select bots that match the given
dimensions.
"""
raw_results = [
self.generate_bot_json(
'build11-dead--device1',
is_dead=True,
dimensions=dimensions),
self.generate_bot_json(
'build12-quarantined--device1',
quarantined=True,
dimensions=dimensions),
self.generate_bot_json(
'build13-maintenance--device1',
maintenance_msg='In maintenance mode',
dimensions=dimensions),
self.generate_bot_json(
'build14-alive--device1',
dimensions=dimensions,
state={'devices': {
'build13-alive-1-serial': {
'max_uid': 19999,
}
}}),
]
return self.m.json.output(raw_results)