Configuration Keys Reference

auto-summon

--auto-summon

Libraries auto summon, set to false to disable it.

batch-mode

--batch-mode

Skip user interactions, for example do not open generated pdfs automatically.

no-color

--no-color

Force usage of plain-text console output.

output.file

-o <PATH>/--output <PATH>

Path for storing execution results.

run-source

--run-source <SRC> / -s <SRC>

Specify where to takes the runs from. Can be :random, :log, or a path to a traces file (commonly resides in products/run-source/).

verbose

--verbose

Print more data to stdout.

viewer.html

Sets the command used to view HTML files.

viewer.pdf

Sets the command used to view PDF files.

rest-api.ssl.validation

Validate ssl on Rest Api event, when set to false disabling SSL validation .

Security Implications: Disabling SSL validation bypasses the checks that ensure the server’s identity and the integrity of the communication channel. It should only be used cautiously in controlled environments or for testing purposes.

run.dry

--dry

Do not actuate external systems, just write to standard out what could have happened.

run.scripts.after-failure

--after-failure <COMMAND>

A command to run after a test failed test. Typically, cleans up and resets the test system..

run.scripts.after-success

--after-success <COMMAND>

A command to run after a successful test.

run.scripts.before-test

--before-test <COMMAND>

A command to run before each test.

run.scripts.setup

--setup <COMMAND>

A command to run before the tests start. Typically, used for bringing the test system up.

run.scripts.teardown

--teardown <COMMAND>

A command to run after all tests are executed. Typically, cleans up and frees resources.

selenium.action-delay

--action-delay <MSEC>

Default delay between Selenium actions, in milliseconds.

selenium.browser

--selenium-browser

Default browser type for selenium server.

selenium.implicit-wait

Default wait for page items to become visible or intractable (in milliseconds). Defaults to 5000.

selenium.max-windows

--max-windows

Maximize browser windows when opened.

selenium.server

--selenium-server <URL>

URL of a selenium server for driving web UIs.

selenium.show-sessions

--show-sessions

Show Selenium sessions. If this flag is not set we run in 'headless' mode.

source.run-id

--run-id <ID>

An ID of a specific run to execute from the run source. When the run source is :log, <ID> is the id of the run in the database.When the run source is a file name, <ID> is the 1-based index of the run in the file.

run.dev-mode

--dev-mode

Dev mode is special run mode dedicated to automation developers. While in this mode, provengo does not terminate test execution when an assertion fails. Rather, it pauses the test, waits for the user to press Enter, and then continues the test execution. This mode implies --show-sessions.

tn5250.server

URL of a tn5250 Provengo’s terminal for driving AS400/IBM System I.

report.junit

--junit-report

Create junit report

analyze.output.format

-f <NAME>/--format <NAME>

Format of generated test space map. Note: the 'pdf' option requires Graphviz. options: "json", "gv", "pdf.

run.max-depth

--max-depth <NUM>

Maximal number of steps for a script. Defaults to 60.

source.highlight

--highlight <PATH>

Name of file containing scenarios to be highlighted.

visualization.layout

--layout <LAYOUT>

Horizontal or vertical graph, the options are: horizontal(left to right), vertical(top to bottom), r-vertical(bottom to top), r-Horizontal(right to left).

visualization.style

--style <NAME>

Style of the generated visualization. NAME is either plain (no extra styling) or full. Defaults to full. Applicable only when combined with -f pdf.

visualization.order

Determines how graph edges are ordered. The default is lexicographic. Options are: lexicographic (by alphabetic order), visual (best graph view)

gen-book.output.format

-f <NAME>/--format <NAME>

Format of generated test book, options: html qc-xls.

gen-book.generator

--generator <NAME>/ -g <NAME>

Name of the book generation object.

gen-scripts.generator

--generator <NAME> / -g <NAME>

Name of the function that generates the scripts. Defaults to generateScript.

gen-scripts.end-function

--generator-end <NAME>

Name of a function to be invoked after all scenarios were written to a script file. Used only in single file mode. Defaults to singleFileEnd.

gen-scripts.suffix

-s <SFX>/--suffix <SFX>

Suffix for generated script files. Defaults to py.

gen-scripts.start-generator

--generator-start <NAME>

Name of a function to be invoked when a new script file ie crated, before any scenarios are written to it. Used only in single file mode. Defaults to singleFileStart.

gen-scripts.single-file

--single-file

When true, write all scenarios into a single script file. Otherwise, generate a separate script file for each scenario. Defaults to false.

gen-scripts.overwrite

--overwrite

Overwrite existing output files if exists.

gen-scripts.source

-s/--run-source

The file from which test scenarios are read. Defaults to products/run-source/ensemble.json.

gen-scripts.index-file.generator

Name of a function to be invoked when a generating index file, used only in non-single file mode. Defaults to writeIndexFile.

gen-scripts.index-file.name

Name of index file, defaults to index.

output.offline

--offline

Prevent logs from using on-line content (increases log size).

report.charset

The report’s charset, see https://www.ietf.org/rfc/rfc2278.txt for the complete list.

report.type

--type

Type of report, options: TestLog.

report.output.format

--format, -f

Report format, options: JUnit, TestLog.

report.suite.query

--suites

Suites for the report. options are: ':all' - all suites, ':last' - only last suite, ':last-15' - last 15 suites, '1,4,6' - specific suites(1,4,6), separate each suite id by ','"

combi.output.format

-f <NAME>/--format <NAME>

Format of generated combinations file. Use 'gv' to draw the combination paths, options: json, gv, tsv, csv, excel, xlsx, ods, pdf

sample.algorithm

--algorithm <NAME>/-a <NAME>

Sets the sampling algorithm used to generate scenarios from the model. Options are random (default), and full.

sample.overwrite

--overwrite

Delete the content of the file and starts over.

sample.not-growing-threshold

--not-growing-threshold

Number of non growing steps to allow before stopping the sampling process.

sample.object-prob

--p-object <NUM>

Probability of respecting events that b-threads object for.

sample.size

--size <NUM>

Maximum number of random path to sample from the model. When using --overwrite, this will be the maximal size of the new sample. When not using --overwrite, this will be the maximal number of scenarios added to the existing samples file. When using the full sampling algorithm (-a full), this parameter is ignored.

sample.wish-prob

--p-wish

Probability of choosing a wished-for event

ensemble.iterations

--iterations <NUM>

Number of iterations while optimizing the generated test ensemble.

ensemble.optimizer

-a <NAME>/--algorithm <NAME>

Name of optimization algorithm. Options: brute-force, genetic, goals. Defaults to genetic.

ensemble.ranking-function

--ranking-function <NAME>

Name of the ranking function to use. Defaults to rankingFunction.

ensemble.size

--size <NUM>

Number of required tests in the generated test suite.

ensemble.genetic.crossover-prob

--p-crossover

Probability of executing a crossover combinator.

ensemble.genetic.generation-attempts

Number of generations to execute.

ensemble.genetic.max-phenotype-age

Maximal phenotype age.

ensemble.genetic.mutation-prob

--p-mutation

Probability of executing a mutation mutator.

ensemble.goals.halt-condition.threshold

Size-based halt condition for the goals algorithm. Halts the optimization process once the algorithm achieve an ensemble whose size is below the specified number.

ensemble.goals.halt-condition.time

Time-based halt condition for the goals algorithm. units are: number[msec/sec/min] for example: 400msec / 100sec / 3 min.

ensemble.goals.halt-condition.stability

Stability-based halt condition for the goals algorithm. Halts the optimization algorithm after the specified number of optimization attempts was not able to reduce the size of the composed ensemble.

ensemble.goals.function

Name of the function that returns the goal array. Defaults to makeGoals. This function takes no arguments and returns an array of event arrays.

ensemble.goals.generation-attempts

Number of non-minimal goal-complete test suites to generate (bigger takes longer time but might achieve a smaller final result)

ensemble.goals.minimization-attempts

Number of minimization attempts per non-minimal goal-complete test suite (bigger takes longer time but might achieve a smaller final result)