exitcode_directive - set runtask exit code based on last or worst test outcome¶
New in version 0.3.18.
This directives takes YAML specified by key result_last
or result_worst
(keys are
mutually exclusive), and generates returncode based on last or worst YAML outcome.
If YAML is empty, exitcode is set to SUCCESS.
If task formula contains multiple usages of exitcode directive, worst exitcode is returned by runtask.
Input for directive is supposed to be in a Task Result Format. The easiest way to create it
is to use CheckDetail
objects to construct your result (or results), and then generate
the YAML output with export_YAML()
.
Read more in Writing Taskotron Tasks.
Parameters¶
Parameter | Required | Description | Type | Default | Choices |
---|---|---|---|---|---|
result_last |
yes | YAML output, last outcome is used. result_worst cannot be specified together with this one. |
str |
||
result_worst |
yes | YAML output, worst outcome is used. result_last cannot be specified together with this one. |
str |
Return Values¶
int: | Returncode based on YAML last or worst outcome. Success is 0 , failure is 100 . |
---|
Exceptions¶
TaskotronDirectiveError
: when there’s not exactly one of parametersresult_last
orresult_last
presentTaskotronValueError
: when YAML input cannot be parsed