cluster |
object
|
|
Cluster namespace.
Properties
Name |
Type |
Argument |
Default |
Description |
isMaster |
boolean
|
<optional>
|
true
|
Mark current process as master. |
isSlave |
boolean
|
<optional>
|
false
|
Mark current process as slave. |
slavesNum |
number
|
<optional>
|
0
|
Number of slaves to launch. |
slaveId |
number
|
<optional>
|
null
|
ID of slave. |
|
session |
object
|
|
Session namespace.
Properties
Name |
Type |
Argument |
Default |
Description |
name |
string
|
|
|
Session name. By default contains timestamp.
Can be overridden with CLI option --session-name . |
id |
string
|
|
|
Session ID. Default is timestamp. |
errors |
boolean
|
<optional>
|
[]
|
List of session errors. |
isPassed |
boolean
|
<optional>
|
false
|
Flag to define if tests session
run is passed or no. |
preloads |
array.<string>
|
<optional>
|
[]
|
Array of paths to js modules
which will be loaded before tests session run. |
interactive |
boolean
|
<optional>
|
false
|
Flag to launch interactive
session. Can be overridden with CLI option -i / --interactive . |
debugOnFail |
boolean
|
<optional>
|
false
|
Flag to enter to interactive
mode on step failure. Can be overridden with CLI option --debug-on-fail . |
exitOnFail |
boolean
|
<optional>
|
false
|
Flag to break tests session on
first test failure. Can be overridden with CLI option --exit-on-fail . |
uncaughtException |
string
|
<optional>
|
log
|
Strategy to process uncaught
exceptions. Available values are log , fail , mocha . Can be overridden
with CLI option --uncaught . |
rootConftest |
string
|
|
|
Path to js module which will be
loaded right after preloads. Can be overridden with CLI
option --root-conftest . |
killProcs |
array.<string>
|
|
|
Array of process names which will
be killed before tests session run. Can be overridden with CLI
option --kill-procs . |
|
retry |
object
|
|
Retry settings namespace.
Properties
Name |
Type |
Argument |
Default |
Description |
id |
integer
|
<optional>
|
0
|
Number of retried session. |
chunkIds |
object
|
<optional>
|
{}
|
Chunk ids grouped by retry values. For
example: {1: ['1_1', '1_2'], 3: ['2_1'], 2: ['3_1', '3_2']} . Populated on
first session run. |
curChunkIds |
array.<string>
|
<optional>
<nullable>
|
null
|
Reference to currently
populated group in retry.chunkIds . |
|
test |
object
|
|
Test settings namespace.
Properties
Name |
Type |
Argument |
Default |
Description |
id |
integer
|
<optional>
|
0
|
Number of currently created test. Each test has
unique incremental id. On first session run it's assigned, on retry is used
to find test by id, because test name can be non-unique. |
curCase |
TestCase
|
<optional>
<nullable>
|
null
|
Currently executed test case. |
cases |
array.<TestCase>
|
<optional>
|
[]
|
Array of session test cases. |
languages |
array.<string>
|
<optional>
|
[]
|
Array of language names. Can be
overridden with CLI option --languages . |
dirs |
array.<string>
|
<optional>
|
[]
|
Array of test files or folders. Can
be overridden with CLI arguments or option --targets separated with comma. |
checkNames |
boolean
|
<optional>
|
true
|
Flag to check test names uniqueness.
Can be overridden with CLI option --dont-check-names . |
retries |
integer
|
<optional>
|
0
|
#
Number of test retries on failure. Overridden with CLI option --retry . |
|
chunk |
object
|
|
Chunk settings namespace.
Properties
Name |
Type |
Argument |
Default |
Description |
id |
integer
|
<optional>
|
0
|
Number of chunk inside a test, incremental,
starts from 0 in each test. Fully unique chunk id is consist of test.id &
chunk.id , like 1_1 , 1_2 , 2_1 . |
curId |
string
|
<optional>
<nullable>
|
null
|
Currently executed fully unique chunk id. |
passedIds |
array.<string>
|
<optional>
|
[]
|
Fully unique ids of passed chunks.
Used to skip already passed chunks on retry. |
retries |
integer
|
<optional>
|
0
|
#
Number of chunk retries on failure. Overridden with CLI option --chunk-retry . |
timeout |
integer
|
<optional>
|
180
|
#
Timeout of chunk execution, sec. Overridden with CLI option --chunk-timeout . |
|
report |
object
|
|
Report namespace.
Properties
Name |
Type |
Argument |
Default |
Description |
dir |
string
|
<optional>
|
cwd/report
|
Folder to save tests session report. |
testDir |
string
|
<optional>
|
|
Folder to save test-specific artifacts. |
clear |
boolean
|
<optional>
|
true
|
Flag to clear report before tests run.
Can be overridden with CLI option --dont-clear-report . |
errorsNow |
boolean
|
<optional>
|
false
|
Flag to print test error right
after its capture. Can be overridden with CLI option --errors-now . |
failedTestsPath |
string
|
<optional>
|
cwd/failed-tests.json
|
Path to file
where info about failed tests will be saved to. Can be overridden with CLI
option --failed-tests-path . |
|
xunit |
object
|
<optional>
|
xUnit report namespace.
Properties
Name |
Type |
Argument |
Default |
Description |
use |
boolean
|
<optional>
|
false
|
Flag to activate xUnit report. Can be
overridden with CLI option --xunit . |
path |
string
|
<optional>
|
report.dir/xunit.xml
|
Path to xUnit report. Can
be overridden with CLI option --xunit-path . |
suiteName |
string
|
<optional>
|
session.name
|
xUnit suite name. Can be
overridden with CLI option --xunit-suite-name . |
|
allure |
object
|
<optional>
|
Allure report namespace.
Properties
Name |
Type |
Argument |
Default |
Description |
use |
boolean
|
<optional>
|
false
|
Flag to activate allure report. Can be
overridden with CLI option --allure . |
dir |
string
|
<optional>
|
report.dir/allure
|
Folder to save allure report.
Can be overridden with CLI option --allure-dir . |
suiteName |
string
|
<optional>
|
session.name
|
Allure suite name. Can be
overridden with CLI option --allure-suite-name . |
|
testrail |
object
|
|
Testrail report namespace.
Properties
Name |
Type |
Argument |
Default |
Description |
use |
boolean
|
<optional>
|
false
|
Flag to activate testrail report. Can
be overridden with CLI option --testrail . |
host |
string
|
|
|
Testrail host. Can be overridden with CLI
option --testrail-host . |
user |
string
|
|
|
Testrail user name or email. Can be overridden
with CLI option --testrail-user . |
token |
string
|
|
|
Testrail auth token. Can be overridden with
CLI option --testrail-token . |
projectId |
string
|
|
|
Testrail project ID. Can be overridden
with CLI option --testrail-project-id . |
suiteId |
string
|
|
|
Testrail suite ID. Can be overridden with
CLI option --testrail-suite-id . |
runName |
string
|
|
|
Testrail run name. Can be overridden with
CLI option --testrail-run-name . |
runDescription |
string
|
|
|
Testrail run description. Can be
overridden with CLI option --testrail-run-description . |
|
plugins |
object
|
|
Plugins namespace.
Properties
Name |
Type |
Description |
dir |
string
|
Folder with custom plugins. Can be overridden
with CLI option --plugins-dir . |
|
filter |
object
|
|
Tests filter namespace.
Properties
Name |
Type |
Argument |
Default |
Description |
grep |
string
|
|
|
Mocha grep option to filter tests, scopes and
suites. Can be overridden with CLI option -g / --grep . |
include |
array.<string>
|
|
|
List of test names which should be
included to tests session. Can be overridden with CLI option --include . |
exclude |
array.<string>
|
|
|
List of test names which should be
excluded from tests session. Can be overridden with CLI option --exclude . |
precise |
boolean
|
<optional>
|
false
|
Flag for precise tests inclusion or
exclusion (not substring pattern). Can be overridden with CLI option
--precise . |
|
tools |
object
|
|
Tools namespace.
Properties
Name |
Type |
Argument |
Default |
Description |
stepsList |
boolean
|
<optional>
|
false
|
Flag to list available steps only.
Can be overridden with CLI option --list-steps . |
stepsFilter |
string
|
|
|
String to filter steps. Can be overridden
with CLI option --list-steps . |
testsList |
boolean
|
<optional>
|
false
|
Flag to list implemented tests
only. Can be overridden with CLI option --list-tests . |
testsFilter |
string
|
|
|
String to filter tests. Can be overridden
with CLI option --list-tests . |
fixturesList |
boolean
|
<optional>
|
false
|
Flag to list available fixtures
only. Can be overridden with CLI option --list-fixtures . |
fixturesFilter |
string
|
|
|
String to filter fixtures. Can be
overridden with CLI option --list-fixtures . |
checkTestrail |
boolean
|
<optional>
|
false
|
Flag to check matching of
testrail cases with implemented tests only. Can be overridden with CLI
option --testrail-check . |
|