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
|
# Copyright (C) 2014 Linaro Limited
#
# Author: Neil Williams <neil.williams@linaro.org>
#
# This file is part of LAVA Dispatcher.
#
# LAVA Dispatcher is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# LAVA Dispatcher is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along
# with this program; if not, see <http://www.gnu.org/licenses>.
import yaml
from yaml.composer import Composer
from yaml.constructor import Constructor
from lava_dispatcher.job import Job
from lava_dispatcher.action import (
Pipeline,
Timeout,
JobError,
)
from lava_dispatcher.logical import (
Deployment,
Boot,
LavaTest,
)
from lava_dispatcher.deployment_data import get_deployment_data
from lava_dispatcher.power import FinalizeAction
from lava_dispatcher.connection import Protocol
# Bring in the strategy subclass lists, ignore pylint warnings.
# pylint: disable=unused-import,too-many-arguments,too-many-nested-blocks,too-many-branches
from lava_dispatcher.actions.commands import CommandAction
import lava_dispatcher.actions.deploy.strategies
import lava_dispatcher.actions.boot.strategies
import lava_dispatcher.actions.test.strategies
import lava_dispatcher.protocols.strategies
def parse_action(job_data, name, device, pipeline, test_info, test_count):
"""
If protocols are defined, each Action may need to be aware of the protocol parameters.
"""
parameters = job_data[name]
parameters['test_info'] = test_info
if 'protocols' in pipeline.job.parameters:
parameters.update(pipeline.job.parameters['protocols'])
if name == 'boot':
Boot.select(device, parameters)(pipeline, parameters)
elif name == 'test':
# stage starts at 0
parameters['stage'] = test_count - 1
LavaTest.select(device, parameters)(pipeline, parameters)
elif name == 'deploy':
candidate = Deployment.select(device, parameters)
if parameters['namespace'] in test_info and candidate.uses_deployment_data():
if any([testclass for testclass in test_info[parameters['namespace']] if testclass['class'].needs_deployment_data()]):
parameters.update({'deployment_data': get_deployment_data(parameters.get('os', ''))})
if 'preseed' in parameters:
parameters.update({'deployment_data': get_deployment_data(parameters.get('os', ''))})
Deployment.select(device, parameters)(pipeline, parameters)
class JobParser(object):
"""
Creates a Job object from the Device and the job YAML by selecting the
Strategy class with the highest priority for the parameters of the job.
Adding new behaviour is a two step process:
- always add a new Action, usually with an internal pipeline, to implement the new behaviour
- add a new Strategy class which creates a suitable pipeline to use that Action.
Re-use existing Action classes wherever these can be used without changes.
If two or more Action classes have very similar behaviour, re-factor to make a
new base class for the common behaviour and retain the specialised classes.
Strategy selection via select() must only ever rely on the device and the
job parameters. Add new parameters to the job to distinguish strategies, e.g.
the boot method or deployment method.
"""
# FIXME: needs a Schema and a check routine
loader = None
# annotate every object in data with line numbers so we can use
# them is user-friendly validation messages, combined with the action.level
# each action will also include an output_line to map to the stdout log,
# once executed.
def compose_node(self, parent, index):
# the line number where the previous token has ended (plus empty lines)
line = self.loader.line
node = Composer.compose_node(self.loader, parent, index)
node.__line__ = line + 1
return node
def construct_mapping(self, node, deep=False):
mapping = Constructor.construct_mapping(self.loader, node, deep=deep)
mapping['yaml_line'] = node.__line__
return mapping
def _timeouts(self, data, job):
if data.get('timeouts', None) is not None:
if 'job' in data['timeouts']:
duration = Timeout.parse(data['timeouts']['job'])
job.timeout = Timeout(data['job_name'], duration)
# pylint: disable=too-many-locals,too-many-statements
def parse(self, content, device, job_id, logger, dispatcher_config,
env_dut=None):
self.loader = yaml.SafeLoader(content)
self.loader.compose_node = self.compose_node
self.loader.construct_mapping = self.construct_mapping
data = self.loader.get_single_data()
job = Job(job_id, data, logger)
test_counts = {}
job.device = device
job.parameters['env_dut'] = env_dut
# Load the dispatcher config
job.parameters['dispatcher'] = {}
if dispatcher_config is not None:
config = yaml.safe_load(dispatcher_config)
if isinstance(config, dict):
job.parameters['dispatcher'] = config
level_tuple = Protocol.select_all(job.parameters)
# sort the list of protocol objects by the protocol class level.
job.protocols = [item[0](job.parameters, job_id) for item in sorted(level_tuple, key=lambda level_tuple: level_tuple[1])]
pipeline = Pipeline(job=job)
self._timeouts(data, job)
# deploy and boot classes can populate the pipeline differently depending
# on the test action type they are linked with (via namespacing).
# This code builds an information dict for each namespace which is then
# passed as a parameter to each Action class to use.
test_info = {}
test_actions = ([action for action in data['actions'] if 'test' in action])
for test_action in test_actions:
test_parameters = test_action['test']
test_type = LavaTest.select(device, test_parameters)
namespace = test_parameters.get('namespace', 'common')
connection_namespace = test_parameters.get('connection-namespace', namespace)
if namespace in test_info:
test_info[namespace].append({'class': test_type, 'parameters': test_parameters})
else:
test_info.update({namespace: [{'class': test_type, 'parameters': test_parameters}]})
if namespace != connection_namespace:
test_info.update({connection_namespace: [{'class': test_type, 'parameters': test_parameters}]})
# FIXME: also read permissable overrides from device config and set from job data
# FIXME: ensure that a timeout for deployment 0 does not get set as the timeout for deployment 1 if 1 is default
for action_data in data['actions']:
action_data.pop('yaml_line', None)
for name in action_data:
# Set a default namespace if needed
namespace = action_data[name].setdefault('namespace', 'common')
test_counts.setdefault(namespace, 1)
if name == 'deploy' or name == 'boot' or name == 'test':
parse_action(action_data, name, device, pipeline,
test_info, test_counts[namespace])
if name == 'test':
test_counts[namespace] += 1
elif name == 'repeat':
count = action_data[name]['count'] # first list entry must be the count dict
repeats = action_data[name]['actions']
for c_iter in range(count):
for repeating in repeats: # block of YAML to repeat
for repeat_action in repeating: # name of the action for this block
if repeat_action == 'yaml_line':
continue
repeating[repeat_action]['repeat-count'] = c_iter
namespace = repeating[repeat_action].setdefault('namespace', 'common')
test_counts.setdefault(namespace, 1)
parse_action(repeating, repeat_action, device,
pipeline, test_info, test_counts[namespace])
if repeat_action == 'test':
test_counts[namespace] += 1
elif name == 'command':
action = CommandAction()
action.parameters = action_data[name]
pipeline.add_action(action)
else:
raise JobError("Unknown action name '%s'" % name)
# there's always going to need to be a finalize_process action
finalize = FinalizeAction()
pipeline.add_action(finalize)
finalize.populate(None)
job.pipeline = pipeline
if 'compatibility' in data:
try:
job_c = int(job.compatibility)
data_c = int(data['compatibility'])
except ValueError as exc:
raise JobError('invalid compatibility value: %s' % exc)
if job_c < data_c:
raise JobError('Dispatcher unable to meet job compatibility requirement. %d > %d' % (job_c, data_c))
return job
|
