Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

CLI args for noninteractive and runnable to run #61

Merged
merged 2 commits into from
Nov 10, 2022
Merged

CLI args for noninteractive and runnable to run #61

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba694c8
CLI args for noninteractive and runnable to run
karlnaden Nov 3, 2022
0789442
add example execution to readme
karlnaden Nov 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
add example execution to readme
  • Loading branch information
@karlnaden
karlnaden committed Nov 10, 2022
commit 07894428b7260c6e1a2c3d331ef1f063b52cf6cb
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,11 @@ The engine can be configured through several variables, each of which has a pres
### Commandline Arguments

Some configurations can be set using command line arguments:
- `-r` or `--runnable`: the next argument must be the name of runnable to execute. Only works if the noninteractive flag is provided.
- `-r` or `--runnable`: the next argument must be the name of runnable to execute (from `TestScript.name`). Only works if the noninteractive flag is provided.
- `-n` or `--noninteractive`: disable confirmation of configuration settings
karlnaden marked this conversation as resolved.
Show resolved Hide resolved

For example, to execute the TestScript runnable in file `TestScripts/read_testscript.json` (with name `TestScript Example Read Test`) in non-interactive mode, execute `bundle exec bin/testscript_engine -n -r "TestScript Example Read Test"`.

## Details

TestScripts are validated and loaded in by the engine. By default, the engine looks for a `./TestScripts` folder in its given context, but will allow the user to specify an alternate path. Once scripts are loaded, they are converted into 'runnables'. The engine allows users to specify which runnable to execute, and by default will execute all available runnables. Likewise, the user can specify the endpoint upon which the runnable(s) should be executed. Following execution, the user can either re-execute -- specifying a different runnable or endpoint -- or shut-down the engine. Finally, the results from each runnable's latest execution are written out to the `./TestReports` folder.
Expand Down