execute¶
The execute command runs multiple Runner commands sequentially within a single test execution.
Note
When running QaaS Runner Commands using the execute command, each QaaS Runner Command will receive an ID that will be used to identify it in the logs and allure-results.
Configurations¶
The execute command uses a YAML configuration file to know which commands to run.
⚠️ Important
The commands in the YAML file are QaaS Commands there is no need to use dotnet run in them.
YAML View¶
Table View¶
| Property Path | Type | Required | Default | Description |
|---|---|---|---|---|
Commands |
array (length >= 1) |
✔ | The list of QaaS commands to execute in the order they will be executed | |
Commands[] |
object |
✔ | ||
Commands[].Command |
string |
✔ | The QaaS command to execute | |
Commands[].Id |
string (100 >= length >= 1) |
✔ | A unique identifier to identify the command by | |
Commands[].Parallel |
boolean |
✖ | false | Whether to run this command in parallel with other commands coming before and after it that are also set to run in parallel or not |
Example¶
Explanation
In this example, the execute command will first run the template command with the test.qaas.yaml configuration and then run the run command with the same configuration.
Positional Arguments¶
| Position | Property | Source Type | Required | Default | Value Type | Description |
|---|---|---|---|---|---|---|
0 |
ConfigurationFile |
Execute options |
Yes | executable.yaml | string |
Path to a yaml configuration file that contains a list of QaaS commands to execute in sequential order. |
Flags¶
| Flag | Inherited | Required | Default | Value Type | Description |
|---|---|---|---|---|---|
-c, --command-ids-to-run |
No | No | [] | string list |
Ids of the commands to run. Only the commands given would run. If none is given runs all commands. |
--disable-elastic-defaults |
Yes | No | False | bool |
Disables Elastic defaults registered through the runtime defaults provider for this run. |
--elastic-password |
Yes | No | string |
Optional Elasticsearch password for the logger sink. | |
--elastic-uri |
Yes | No | string |
Elasticsearch URI used by the logger sink when send-logs is enabled. | |
--elastic-username |
Yes | No | string |
Optional Elasticsearch username for the logger sink. | |
-e, --empty-allure-directory |
No | No | False | bool |
If flag is enabled will automatically empty the allure results directory before running. |
-g, --logger-configuration-file |
Yes | No | string |
Path to a logger's configuration file, will override the default logger's configuration. Its level can be overridden by the logger-level flag. | |
-l, --logger-level |
Yes | No | LogEventLevel (optional) |
The logger's level, overrides both the default logger's level (Information) and the level of any logger's configuration given. All available options (not case sensitive) are: Verbose, Debug, Information, Warning, Error, Fatal. |
|
--no-process-exit |
No | No | False | bool |
When this flag is used the runner will not terminate the current process after it completes. Useful when embedding QaaS.Runner and orchestrating multiple runners in a single host process. |
--send-logs |
Yes | No | False | bool |
Whether to send logs to the configured Elasticsearch sink. |
-s, --serve-results |
No | No | allure-results (with bare -s) |
string |
Serves Allure output after executing all commands. If you pass -s without a value, QaaS serves the default raw results folder allure-results. Pass a folder name such as allure-report to open that directory instead, which is useful for Allure 3 flows.When any of the commands written in the executable configuration file use this flag it will not do anything; this top-level flag is the deciding one. Uses a locally installed allure CLI tool, if allure CLI is not installed and added to path the serve will fail. |
Each Commands item contains the full QaaS command string and the unique Id that the loader uses for filtering and reporting.
Example¶
execute executable.yaml -sservesallure-results.execute executable.yaml -s allure-reportopensallure-report, which is useful for Allure 3 style report output.