run step

step run

Execute an external command providing input and capturing output from that program through standard input and output streams or files.

See also

Package mtrchk-org-momotor-run-inout

Python package containing the checklet implementing this step. The recipe requires version ~=2.0, this document is based on version 2.0.0.

preflight@scheduler option

A preflight check handled by the scheduler. This allows recipes to indicate situations in which the step does not have to be executed.

See Scheduler preflight option for the documentation of this option.

Type:

string

Required:

False

Multiple:

True

All:

True

Value:

%notall pass => fail-hidden { "reason": "Compile error"}

tasks@scheduler option

Enable multiple tasks for this step. If not provided, a single task is generated for this step.

See Scheduler tasks option for the documentation of this option.

Type:

string

Required:

False

Multiple:

False

Value:

?

timeLimit option

Maximum time allowed for execution. Can be supplied in hh:mm:ss format, or as seconds

Type:

Any

Required:

False

Multiple:

False

Default:

No default

blockLimit option

Maximum time allowed without any progress (wall clock time). Can be supplied in hh:mm:ss format, or as seconds

Type:

Any

Required:

False

Multiple:

False

Default:

No default

memoryLimit option

Maximum memory usage allowed for execution. Can use IEC or SI units, eg. 1k (for 1000 bytes) or 1KiB (for 1024 bytes)

Type:

Any

Required:

False

Multiple:

False

Default:

No default

processLimit option

Maximum number of child processes

Type:

integer

Required:

False

Multiple:

False

Default:

No default

stdin option

Content to provide on stdin. Mutually exclusive with the stdin-file-ref option. If neither stdin and stdin-file-ref options are provided, stdin is closed.

Type:

Any

Required:

False

Multiple:

False

Default:

No default

stdin-file-ref option

Reference to a file to provide text on stdin. Mutually exclusive with the stdin option. If neither stdin-file-ref and :momotor:option:.stdin` options are provided, stdin is closed.

The reference is parsed with find_files(), see that method for details.

Type:

Any

Required:

False

Multiple:

False

Default:

No default

input-file-ref option

Reference for file(s) to put in execution tree.

The reference is parsed with find_files(), see that method for details.

Type:

Any

Required:

False

Multiple:

True

All:

False

Value:

No values

input-delay option

Delay (in milliseconds) between sending lines on stdin

Type:

integer

Required:

False

Multiple:

False

Default:

No default

capture-stdio option

Capture the stream on stdin/out/err. When enabled, the checklet outputs a property stdio containing a (json) list of objects. The objects contains entries for I/O on ‘stdin’, ‘stdout’, ‘stderr’ (with key 0, 1 and 2 respectively), and a timestamp in seconds since execution start (with key @)

Type:

boolean

Required:

False

Multiple:

False

Default:

False

stdout-file-class option

Export output produced on stdout to a file with this class

Type:

Any

Required:

False

Multiple:

False

Default:

stdout

stderr-file-class option

Export output produced on stderr to a file with this class

Type:

Any

Required:

False

Multiple:

False

Default:

No default

stdouterr-file-class option

Export combined output produced on stdout/stderr combined to a file with this class

Type:

Any

Required:

False

Multiple:

False

Default:

No default

output-file-class option

Export produced or modified files with this class

Type:

Any

Required:

False

Multiple:

False

Default:

No default

pass-on-exitcode option

A comma-separated list of exit codes that should not be considered a failure. Ranges can be indicated as X..Y. This list should include the “0” exit code if it should be a pass. e.g. 0, 1, 100..109 allows exit codes 0, 1 and 100 up to and including 109

Type:

Any

Required:

False

Multiple:

False

Default:

0

fail-on-stderr option

Produce a fail outcome if any (non-whitespace) output is produced on stderr

Type:

boolean

Required:

False

Multiple:

False

Default:

False

report-stdio option

Report stdio.

Either true, false or a (comma or space-seperated) list of streams (in, out, err) to include.

in stream will be formatted bold, out stream will be in regular font and err stream will be in red.

Default: false

Type:

Any

Required:

False

Multiple:

False

Default:

err

truncate-stdout-lines option

Limit for the number of lines captured from stdout.

Can be use IEC or SI units, eg. 1k (for 1000 lines) or 1KiB (for 1024 lines). Default = 5000, hard limit = 100k

Type:

string

Required:

False

Multiple:

False

Default:

No default

truncate-stdout-bytes option

Limit for the number of bytes captured from stdout.

Can be use IEC or SI units, eg. 1k (for 1000 bytes) or 1KiB (for 1024 bytes). Default = 1 MiB, hard limit = 16 MiB

Type:

string

Required:

False

Multiple:

False

Default:

No default

truncate-stderr-lines option

Limit for the number of lines captured from stderr.

Can be use IEC or SI units, eg. 1k (for 1000 lines) or 1KiB (for 1024 lines). Default = 5000, hard limit = 100k

Type:

string

Required:

False

Multiple:

False

Default:

No default

truncate-stderr-bytes option

Limit for the number of bytes captured from stderr. Can be use IEC or SI units, eg. 1k (for 1000 bytes) or 1KiB (for 1024 bytes).

Default = 1 MiB, hard limit = 16 MiB

Type:

string

Required:

False

Multiple:

False

Default:

No default

fail-on-truncation option

Fail if an output is truncated.

Can be a boolean ‘true’ to fail if either stdout or stderr is truncated, ‘false’ to never fail on truncation, or the values ‘stdout’ or ‘stderr’ to only fail if that stream is truncated

Type:

string

Required:

False

Multiple:

False

Default:

false

secret option

Dynamic secret property value for the result. Momotor LTI will not show steps with a secret property set to true to learners, but will still show that step to reviewers.

The option value can be one of the following:

  • always or true: adds a secret property with value true to the result.

  • false: do not add a secret property to the result.

  • on-fail: adds a secret property with value true to the result if the step fails.

  • on-pass: adds a secret property with value true to the result if the step passed.

  • default: inherits the value from the next provider. If the last provider is ‘default’ no property will be added.

Note that this only adds a secret property with value true, but never one with value false. This ensures that a default defined in a recipe will be used unless the step or config explicitly override it.

The value can contain reference placeholders to inherit the value from another step’s options or properties.

Type:

Any

Required:

False

Multiple:

False

Default:

true

label option

Label for this step. Momotor LTI uses labels as the header of the step in the result view. If a step does not have a label, Momotor LTI will use the step id as the label.

Can contain reference placeholders and task id placeholders.

Type:

Any

Required:

False

Multiple:

False

Default:

Run test case $1#

feedback-pass option

Feedback to prepend to the report property when this step passes.

Can contain reference placeholders and task id placeholders.

Type:

Any

Required:

False

Multiple:

False

Default:

No default

feedback-fail option

Feedback to prepend to the report property when this step fails.

Can contain reference placeholders and task id placeholders.

Type:

Any

Required:

False

Multiple:

False

Default:

No default

exec-file-ref option

Reference to the executable file to run.

The reference is parsed with find_files(), see that method for details.

Type:

Any

Required:

True

Multiple:

True

All:

False

Value:

  • @result#build.$0:executable

  • @result#build.$0.*:executable

extra-file-ref option

Reference to additional files to add to the executable directory.

The reference is parsed with find_files(), see that method for details.

Type:

Any

Required:

False

Multiple:

True

All:

False

Value:

No values