Skip to main content
Invokes a module file with a path relative to the file containing the invocation. The simplified form takes the path (or id) as a single string.

​
Parameters

ParameterTypeRequiredDescription
pathstringYesRelative path to the module file (or its id).
inputsRecord<string, value>NoValues bound to the module’s parameters (see below).
saveAsstringNoVariable to store this step’s return value on env.<name>.
retriesnumberNoTimes to retry the step on failure before failing the test.
skippedbooleanNoSkip this step at execution time.
Each value in inputs is one of:
  • A shorthand string. It is evaluated as a JavaScript expression (e.g. env.QA_EMAIL), not mustache templating.
  • { string: ... }: a literal string.
  • { javascript: ... }: the script’s return value is bound to the parameter.

​
Shorthand

Path as a single string when the module takes no inputs. 
- module: ../modules/log-in.module.yaml

​
Examples

- module:
    path: ../modules/log-in.module.yaml
    inputs: # map module parameters to values in the caller
      USERNAME: env.QA_EMAIL
      PASSWORD:
        javascript: "return env.QA_PASSWORD"