template¶

Template a qaas configuration file to see how it looks after being loaded, will template what it can even if the configuration file is invalid.

Invocation¶

dotnet run <dotnet-parameters> -- template <config-file> [flags]

Use When¶

You want to see the effective YAML after files, folders, references, placeholders, and environment overrides are resolved.
You are validating a complicated configuration merge before running a real test.

Positional Arguments¶

Position	Property	Source Type	Required	Default	Value Type	Description
`0`	`ConfigurationFile`	`Base options`	Yes	test.qaas.yaml	`string`	Path to a qaas yaml configuration file to use with the command.

Flags¶

Category	Flag	Inherited	Required	Default	Value Type	Description
Selection	`--assertion-categories`	Yes	No	[]	`string list`	Used to filter the assertion categories to run. The sessions that are associated with assertions will run too.
Selection	`-a`, `--assertion-names`	Yes	No	[]	`string list`	Names of the assertions to run. Only sessions given to those assertions will run.
Selection	`-c`, `--cases`	Yes	No		`string`	Name of the folder containing all the different .yaml case files that cases are ran with, If no folder is given will run the .qaas.yaml file as is without cases.
Selection	`--cases-name-patterns-ignore`	Yes	No	[]	`string list`	Regex patterns of test-case names to ignore.
Selection	`-n`, `--cases-names`	Yes	No	[]	`string list`	Names of the test-cases to run.
Selection	`--cases-names-ignore`	Yes	No	[]	`string list`	Names of the test-cases to ignore.
Logging	`--disable-elastic-defaults`	Yes	No	False	`bool`	Disables Elastic defaults registered through the runtime defaults provider for this run.
Logging	`--elastic-password`	Yes	No		`string`	Optional Elasticsearch password for the logger sink.
Logging	`--elastic-uri`	Yes	No		`string`	Elasticsearch URI used by the logger sink when send-logs is enabled.
Logging	`--elastic-username`	Yes	No		`string`	Optional Elasticsearch username for the logger sink.
Logging	`-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.
Logging	`-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.
Configuration	`--no-env`	Yes	No	False	`bool`	When this flag is used environment variables will not override loaded configurations.
Runtime	`--no-process-exit`	Yes	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.
Configuration	`-r`, `--overwrite-arguments`	Yes	No	[]	`string list`	List of arguments to overwrite the qaas configuration with, The first argument overwrites the qaas configuration and then the one after it overwrites the result and so on... For example: `Path:To:Variable:To:Overwrite=NewVariableValue`
Configuration	`-p`, `--push-references`	Yes	No	[]	`string list`	References to push onto the qaas configuration. References are configurations that are pushed in the completed test case's root level list configurations instead of a certain keyword to replace, if such a keyword is not found for a certain list nothing will be added to it. The items added to the configuration list will have a prefix of the given keyword to replace added to their unique name field. For example: If we push the reference below `reference.yaml` `<br />Sessions:<br /> - Name: A<br /> - Name: B<br />` On the configuration below `test.qaas.yaml` `<br />Sessions:<br /> - Name: First<br /> - ReplaceKeyWord<br /> - Name: Seconds<br />` With the replace keyword `ReplaceKeyWord` we will get the following results: `<br />Sessions:<br /> - Name: First<br /> - Name: ReplaceKeyWordA<br /> - Name: ReplaceKeyWordB<br /> - Name: Seconds<br />` The syntax to add a reference is: `-p KeyWordToReplace Path/To/Reference.yaml PathToReferenceOverridingFiles.yaml` To add multiple references you can invoke the -p flag multiple times or use a single -p flag but have the references separated by the KeyWordToReplace: `-p KeyWordToReplace1 Reference1.yaml -p KeyWordToReplace2 Reference2.yaml` Or `-p KeyWordToReplace1 Reference1.yaml KeyWordToReplace2 Reference2.yaml` !!! Note that the `KeyWordToReplace` must not end with the suffix `.yml` or `.yaml`.
Configuration	`--resolve-cases-last`	Yes	No	False	`bool`	When this flag is used cases will be resolved after all other types of configuration resolutions, instead of its default behaviour which is after overwrite files and before references.
Logging	`--send-logs`	Yes	No	False	`bool`	Whether to send logs to the configured Elasticsearch sink.
Selection	`--session-categories`	Yes	No	[]	`string list`	Used to filter the session categories to run.
Selection	`-i`, `--session-names`	Yes	No	[]	`string list`	Names of the sessions to run.
Configuration	`-w`, `--with-files`	Yes	No	[]	`string list`	List of files to overwrite the qaas configuration with, The first file overwrites the qaas configuration file and then the one after it overwrite the result and so on...
Configuration	`-f`, `--with-folders`	Yes	No	[]	`string list`	List of folders whose yaml files overwrite the qaas configuration in alphabetical order, after overwrite files and in the order the folders are given.

Flag Notes¶

`-r`, `--overwrite-arguments`¶

List of arguments to overwrite the qaas configuration with. The first argument overwrites the loaded qaas configuration, then each following argument overwrites the result of the previous one.

Example:

-r MetaData:Environment=qa

`-p`, `--push-references`¶

References to push onto the qaas configuration. References are configurations that are pushed into the completed test case's root-level list configurations instead of a certain keyword to replace.

If such a keyword is not found for a certain list nothing will be added to it. The items added to the configuration list will have a prefix of the given keyword to replace added to their unique name field.

Example:

-p ReplaceKeyWord reference.yaml reference.overrides.yaml

Examples¶

Print the resolved configuration¶

dotnet run -- template test.qaas.yaml

Preview the merged config with one extra file and one override¶

dotnet run -- template test.qaas.yaml -w local.qaas.yaml -r MetaData:Environment=qa

Raw CLI Help¶

Usage:
 dotnet run [Dotnet Parameters] -- [Command] [Values] [Flags]

  -w, --with-files                   List of files to overwrite the qaas configuration with, The first file overwrites
                                     the qaas configuration file and then the one after it overwrite the result and so
                                     on...

  -f, --with-folders                 List of folders whose yaml files overwrite the qaas configuration in alphabetical
                                     order, after overwrite files and in the order the folders are given.

  -r, --overwrite-arguments          List of arguments to overwrite the qaas configuration with, The first argument
                                     overwrites the qaas configuration and then the one after it overwrites the result
                                     and so on...
                                     For example: `Path:To:Variable:To:Overwrite=NewVariableValue`


  -p, --push-references              References to push onto the qaas configuration.
                                     References are configurations that are pushed in the completed test case's root
                                     level list configurations instead of a certain keyword to replace,
                                     if such a keyword is not found for a certain list nothing will be added to it.
                                     The items added to the configuration list will have a prefix of the given keyword
                                     to replace added to their unique name field.

                                     For example:
                                     If we push the reference below
                                     `reference.yaml`
                                     ```
                                     Sessions:
                                       - Name: A
                                       - Name: B
                                     ```
                                     On the configuration below
                                     `test.qaas.yaml`
                                     ```
                                     Sessions:
                                       - Name: First
                                       - ReplaceKeyWord
                                       - Name: Seconds
                                     ```
                                     With the replace keyword `ReplaceKeyWord` we will get the following results:
                                     ```
                                     Sessions:
                                       - Name: First
                                       - Name: ReplaceKeyWordA
                                       - Name: ReplaceKeyWordB
                                       - Name: Seconds
                                     ```

                                     The syntax to add a reference is:
                                     `-p KeyWordToReplace Path/To/Reference.yaml PathToReferenceOverridingFiles.yaml`

                                     To add multiple references you can invoke the -p flag multiple times or
                                      use a single -p flag but have the references separated by the KeyWordToReplace:
                                     `-p KeyWordToReplace1 Reference1.yaml -p KeyWordToReplace2 Reference2.yaml`
                                     Or
                                     `-p KeyWordToReplace1 Reference1.yaml KeyWordToReplace2 Reference2.yaml`

                                     !!! Note that the `KeyWordToReplace` must not end with the suffix `.yml` or
                                     `.yaml`.


  -c, --cases                        Name of the folder containing all the different .yaml case files that cases are ran
                                     with, If no folder is given will run the .qaas.yaml file as is without cases.

  -n, --cases-names                  Names of the test-cases to run.

  --cases-names-ignore               Names of the test-cases to ignore.

  --cases-name-patterns-ignore       Regex patterns of test-case names to ignore.

  -i, --session-names                Names of the sessions to run.

  --session-categories               Used to filter the session categories to run.

  -a, --assertion-names              Names of the assertions to run. Only sessions given to those assertions will run.

  --assertion-categories             Used to filter the assertion categories to run. The sessions that are associated
                                     with assertions will run too.

  --resolve-cases-last               (Default: false) When this flag is used cases will be resolved after all other
                                     types of configuration resolutions, instead of its default behaviour which is after
                                     overwrite files and before references.

  --no-env                           (Default: false) When this flag is used environment variables will not override
                                     loaded configurations.

  --no-process-exit                  (Default: false) 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.

  -l, --logger-level                 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.

  -g, --logger-configuration-file    Path to a logger's configuration file, will override the default logger's
                                     configuration. Its level can be overridden by the logger-level flag.

  --send-logs                        (Default: false) Whether to send logs to the configured Elasticsearch sink.

  --elastic-uri                      Elasticsearch URI used by the logger sink when send-logs is enabled.

  --elastic-username                 Optional Elasticsearch username for the logger sink.

  --elastic-password                 Optional Elasticsearch password for the logger sink.

  --disable-elastic-defaults         (Default: false) Disables Elastic defaults registered through the runtime defaults
                                     provider for this run.

  --help                             Display this help screen.

  --version                          Display version information.

  value pos. 0                       (Default: test.qaas.yaml) Path to a qaas yaml configuration file to use with the
                                     command.

No-args guidance:
  Empty arguments only work for code-only hosts that choose a no-args path in Program.cs.
  If a YAML file is part of the scenario, pass it explicitly: dotnet run -- run <config-file>.