sascha/workload-automation
1
0
Fork 0
mirror of https://github.com/ARM-software/workload-automation.git synced 2025-02-21 20:38:57 +00:00
Code Issues Releases Wiki Activity

Tidying run_config config points

Browse Source
This commit is contained in:
Sergei Trofimov 2017-03-20 14:40:13 +00:00
parent 482a936639
commit 1c4eef54d6
1 changed files with 123 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

211
wa/framework/configuration/core.py
View File

@ -636,109 +636,144 @@ class RunConfiguration(Configuration):
# Metadata is separated out because it is not loaded into the auto # Metadata is separated out because it is not loaded into the auto
# generated config file # generated config file
meta_data = [ meta_data = [
ConfigurationPoint('run_name', kind=str, ConfigurationPoint(
description=''' 'run_name',
A string that labels the WA run that is being performed. This would typically kind=str,
be set in the ``config`` section of an agenda (see description='''
:ref:`configuration in an agenda <configuration_in_agenda>`) rather than in the config file. A string that labels the WA run that is being performed. This would
typically be set in the ``config`` section of an agenda (see
.. _old-style format strings: http://docs.python.org/2/library/stdtypes.html#string-formatting-operations :ref:`configuration in an agenda <configuration_in_agenda>`) rather
.. _log record attributes: http://docs.python.org/2/library/logging.html#logrecord-attributes than in the config file.
'''), ''',
ConfigurationPoint('project', kind=str, ),
description=''' ConfigurationPoint(
A string naming the project for which data is being collected. This may be 'project',
useful, e.g. when uploading data to a shared database that is populated from kind=str,
multiple projects. description='''
'''), A string naming the project for which data is being collected. This
ConfigurationPoint('project_stage', kind=dict, may be useful, e.g. when uploading data to a shared database that
description=''' is populated from multiple projects.
A dict or a string that allows adding additional identifier. This is may be ''',
useful for long-running projects. ),
'''), ConfigurationPoint(
'project_stage',
kind=dict,
description='''
A dict or a string that allows adding additional identifier. This
is may be useful for long-running projects.
''',
),
] ]
config_points = [ config_points = [
ConfigurationPoint('execution_order', kind=str, default='by_iteration', ConfigurationPoint(
allowed_values=['by_iteration', 'by_spec', 'by_section', 'random'], 'execution_order',
description=''' kind=str,
Defines the order in which the agenda spec will be executed. At the moment, default='by_iteration',
the following execution orders are supported: allowed_values=['by_iteration', 'by_spec', 'by_section', 'random'],
description='''
Defines the order in which the agenda spec will be executed. At the
moment, the following execution orders are supported:
``"by_iteration"`` ``"by_iteration"``
The first iteration of each workload spec is executed one after the other, The first iteration of each workload spec is executed one after
so all workloads are executed before proceeding on to the second iteration. the other, so all workloads are executed before proceeding on
E.g. A1 B1 C1 A2 C2 A3. This is the default if no order is explicitly specified. to the second iteration. E.g. A1 B1 C1 A2 C2 A3. This is the
default if no order is explicitly specified.
In case of multiple sections, this will spread them out, such that specs In case of multiple sections, this will spread them out, such
from the same section are further part. E.g. given sections X and Y, global that specs from the same section are further part. E.g. given
specs A and B, and two iterations, this will run :: sections X and Y, global specs A and B, and two iterations,
this will run ::
X.A1, Y.A1, X.B1, Y.B1, X.A2, Y.A2, X.B2, Y.B2 X.A1, Y.A1, X.B1, Y.B1, X.A2, Y.A2, X.B2, Y.B2
``"by_section"`` ``"by_section"``
Same as ``"by_iteration"``, however this will group specs from the same Same as ``"by_iteration"``, however this will group specs from
section together, so given sections X and Y, global specs A and B, and two iterations, the same section together, so given sections X and Y, global
this will run :: specs A and B, and two iterations, this will run ::
X.A1, X.B1, Y.A1, Y.B1, X.A2, X.B2, Y.A2, Y.B2 X.A1, X.B1, Y.A1, Y.B1, X.A2, X.B2, Y.A2, Y.B2
``"by_spec"`` ``"by_spec"``
All iterations of the first spec are executed before moving on to the next All iterations of the first spec are executed before moving on
spec. E.g. A1 A2 A3 B1 C1 C2 This may also be specified as ``"classic"``, to the next spec. E.g. A1 A2 A3 B1 C1 C2 This may also be
as this was the way workloads were executed in earlier versions of WA. specified as ``"classic"``, as this was the way workloads were
executed in earlier versions of WA.
``"random"`` ``"random"``
Execution order is entirely random. Execution order is entirely random.
'''), ''',
ConfigurationPoint('reboot_policy', kind=RebootPolicy, default='as_needed', ),
allowed_values=RebootPolicy.valid_policies, ConfigurationPoint(
description=''' 'reboot_policy',
This defines when during execution of a run the Device will be rebooted. The kind=RebootPolicy,
possible values are: default='as_needed',
allowed_values=RebootPolicy.valid_policies,
description='''
This defines when during execution of a run the Device will be
rebooted. The possible values are:
``"never"`` ``"never"``
The device will never be rebooted. The device will never be rebooted.
``"initial"``
The device will be rebooted when the execution first starts, just before
executing the first workload spec.
``"each_spec"``
The device will be rebooted before running a new workload spec.
Note: this acts the same as each_iteration when execution order is set to by_iteration
``"each_iteration"``
The device will be rebooted before each new iteration.
'''),
ConfigurationPoint('device', kind=str, mandatory=True,
description='''
This setting defines what specific Device subclass will be used to interact
the connected device. Obviously, this must match your setup.
'''),
ConfigurationPoint('retry_on_status', kind=list_of(JobStatus),
default=['FAILED', 'PARTIAL'],
allowed_values=JobStatus.values,
description='''
This is list of statuses on which a job will be cosidered to have failed and
will be automatically retried up to ``max_retries`` times. This defaults to
``["FAILED", "PARTIAL"]`` if not set. Possible values are:
``"OK"`` ``"initial"``
This iteration has completed and no errors have been detected The device will be rebooted when the execution first starts,
just before executing the first workload spec.
``"PARTIAL"`` ``"each_spec"``
One or more instruments have failed (the iteration may still be running). The device will be rebooted before running a new workload spec.
``"FAILED"`` .. note:: this acts the same as each_iteration when execution order
The workload itself has failed. is set to by_iteration
``"ABORTED"`` ``"each_iteration"``
The user interupted the workload The device will be rebooted before each new iteration.
'''), '''),
ConfigurationPoint('max_retries', kind=int, default=2, ConfigurationPoint(
description=''' 'device',
The maximum number of times failed jobs will be retried before giving up. If kind=str,
not set. mandatory=True,
description='''
This setting defines what specific Device subclass will be used to
interact the connected device. Obviously, this must match your
setup.
''',
),
ConfigurationPoint(
'retry_on_status',
kind=list_of(JobStatus),
default=['FAILED', 'PARTIAL'],
allowed_values=JobStatus.values,
description='''
This is list of statuses on which a job will be cosidered to have
failed and will be automatically retried up to ``max_retries``
times. This defaults to ``["FAILED", "PARTIAL"]`` if not set.
Possible values are::
.. note:: this number does not include the original attempt ``"OK"``
'''), This iteration has completed and no errors have been detected
``"PARTIAL"``
One or more instruments have failed (the iteration may still be running).
``"FAILED"``
The workload itself has failed.
``"ABORTED"``
The user interupted the workload
''',
),
ConfigurationPoint(
'max_retries',
kind=int,
default=2,
description='''
The maximum number of times failed jobs will be retried before
giving up. If not set.
.. note:: this number does not include the original attempt
''',
),
] ]
configuration = {cp.name: cp for cp in config_points + meta_data} configuration = {cp.name: cp for cp in config_points + meta_data}