Checklet

checklet mtrchk.org.momotor.check.files.CheckFiles(recipe, product, config, results, task_id, work_dir=None)
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

Location:

config, step, recipe

Default:

default

Provided by: SecretOptionMixin

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

Location:

config, step, recipe

Default:

No default

Provided by: LabelOptionMixin

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

Location:

config, step, recipe

Default:

No default

Provided by: FeedbackOptionMixin

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

Location:

config, step, recipe

Default:

No default

Provided by: FeedbackOptionMixin

match option

Match rules for the files to check.

Can contain reference placeholders and task id placeholders, and these will be expanded before the match rules are parsed.

Type:

Any

Required:

False

Multiple:

True

All:

False

Location:

config, step, recipe

Default:

No default

Provided by: BaseCheckFilesMixin

match-default option

Default match rules when no match options are provided.

Can contain reference placeholders and task id placeholders, and these will be expanded before the match rules are parsed.

Can only be provided in the recipe or steps, not in the config.

Type:

Any

Required:

False

Multiple:

True

All:

False

Location:

recipe, step

Default:

No default

Provided by: BaseCheckFilesMixin

accepted-file-class option

Default file class for files matching pass rules if no class is given in the match option.

If empty and the match option also do not supply a class, no file will be added to the result.

Type:

Any

Required:

False

Multiple:

False

Location:

config, step, recipe

Default:

accepted

Provided by: BaseCheckFilesMixin

rejected-file-class option

Default file class for files matching fail rules if no class is given in the match option.

If empty and the match option also do not supply a class, no file will be added to the result.

Type:

Any

Required:

False

Multiple:

False

Location:

config, step, recipe

Default:

rejected

Provided by: BaseCheckFilesMixin

remaining-file-class option

File class for files not matching any rules. Empty to not export these files.

Type:

Any

Required:

False

Multiple:

False

Location:

config, step, recipe

Default:

Empty string

Provided by: BaseCheckFilesMixin

report-title option

Title for the generated report.

Type:

Any

Required:

False

Multiple:

False

Location:

config, step, recipe

Default:

Checking expected files:

Provided by: BaseCheckFilesMixin

report-files option

Add a list of all files in the input ref to the report.

Type:

boolean

Required:

False

Multiple:

False

Location:

config, step, recipe

Default:

True

Provided by: BaseCheckFilesMixin

fail-reason option

Default reason message for the failure if no message is given in the match option.

Type:

Any

Required:

False

Multiple:

False

Location:

config, step, recipe

Default:

File check failed

Provided by: BaseCheckFilesMixin

input-file-ref option

Reference to the files to consider.

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

Type:

Any

Required:

False

Multiple:

True

All:

False

Location:

config, step, recipe

Default:

@product