http(s).Agent instance to use
Options for allure report.
Will be appended to bug keys displayed in allure report. This can be useful as allure report provides no way to distinct issues and bugs by default.
Will be prepended to bug keys displayed in allure report. This can be useful as allure report provides no way to distinct issues and bugs by default.
Will be appended to issue keys displayed in allure report. This can be useful as allure report provides no way to distinct issues and bugs by default.
Will be prepended to issue keys displayed in allure report. This can be useful as allure report provides no way to distinct issues and bugs by default.
Pattern used to create urls for issues and bugs.
'%s' in pattern will be replaced with issue/bug keys defined in Story options.
Pattern used to create urls for testcase management system.
'%s' in pattern will be replaced with testId keys defined in Story options.
Run only automatic testcases and do not consider manual results.
Skip future testcases after a specific amount of already executed testcases have failed. By default, does not bail.
Set a base URL in order to shorten url command calls. If your url parameter starts
with /, the base url gets prepended, not including the path portion of your baseUrl.
If your url parameter starts without a scheme or / (like some/path), the base url
gets prepended directly.
Defines the capabilities you want to run in your Selenium session. See https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities for a list of the available capabilities.
Please be aware that wdio-workflo's reporting only supports one single instance at a time. Therefore, the "maxInstance" property will always be set to 1.
Remove error stack trace lines that originate from the test framework itself.
Count of request retries to the Selenium server.
Timeout for any request to the Selenium server in milliseconds.
Log level output in spec reporter console.
Restricts testcases and specs (oldest spec criteria) by given date and time (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss).
If set to true, Node debugging via the chrome extension "Node-Inspector Manager" is enabled. The test process will then automatically connect to chrome's dedicated dev tools and break on "debugger" statements.
In order for this to work properly, a chrome browser must be installed on the system and the chrome extension "Node-Inspector Manager" needs to be installed.
Sometimes tests might hang after running with debug enabled. In this case, close all chrome processes, open a new chrome window, turn "Node-Inspector Menu" from "Auto" to "Manual" and again to "Auto" and then restarting the tests should resolve the problem.
The following settings are recommended for the "Node-Inspector Manager" extension:
(Main Menu)
(Settings Menu)
Outputs selenium commands in the allure report if set to true.
ACTIVATE THIS AT YOUR OWN RISK: Sometimes there is so much output that the maximum call stack size is exceeded.
Execution arguments for the node process. If using the debug option, execArgv will always be overwritten with the value ['--inspect']
Restricts test execution to these features.
A key-value store of headers to be added to every selenium request. Values must be strings.
Height of the browser window in pixels.
Host of your WebDriver server.
Intervals (for waitXXX and eventuallyXXX actions) in milliseconds.
"default" property will be used for every waitXXX and eventuallyXXX action if not explicitly stated otherwise.
WebdriverIO supports Sauce Labs, Browserstack and Testing Bot (other cloud providers should work too though). These services define specific user and key (or access key) values you need to put in here in order to connect to these services.
Do not run automatic testcases and consider only manual results.
Path to WebDriver server.
Port your WebDriver server is on.
Protocol to use when communicating with the Selenium standalone server (or driver)
An HTTP proxy to be used. Supports proxy Auth with Basic Auth, identical to support for the url parameter (by embedding the auth info in the uri)
A key-value store of query parameters to be added to every selenium request.
If set to true, will output errors and validation failures immediately. Will be enabled by default if consoleLogLevel is set to 'steps'.
Defines how many times a testcase should be rerun if it did not pass.
The current testcase will be aborted on the first error or failed expectation
and rerun
Arguments for install command of selenium-standalone service.
Arguments for start command of selenium-standalone service.
Webdriverio Services to run for test execution.
See http://webdriver.io/guide for more information.
Restricts specs by severity set during their last execution.
Restricts specs by status of their criteria set during their last execution.
Restricts test execution to these specs.
Root directory for all system test artifacts of wdio-workflo.
If you set this value to something other than ${__dirname} + '/system_test, you need to make sure that
the include array in workflo's tsconfig file tsconfig.workflo.json contains your testDir folder.
Restricts testcases by severity set during their last execution.
Restricts executed testcases by their result status set during their last execution.
Restricts test execution to these testcases.
Timeouts (for waitXXX and eventuallyXXX actions) in milliseconds.
"default" property will be used for every waitXXX and eventuallyXXX action if not explicitly stated otherwise.
Path to the uidStore.json file which is used to generate unique ids during test execution.
The generated ids will be preserved for future test runs until the uidStore.json file is deleted.
WebdriverIO supports Sauce Labs, Browserstack and Testing Bot (other cloud providers should work too though). These services define specific user and key (or access key) values you need to put in here in order to connect to these services.
Width of the browser window in pixels.
Gets executed after all tests are done. You still have access to all global variables from the test.
0 - test pass, 1 - test fail
list of capabilities details
List of testcases file paths that ran
Runs after a WebdriverIO command gets executed
hook command name
arguments that command would receive
0 - command success, 1 - command error
error object if any
Hook that gets executed after a hook within the suite ends (e.g. runs after calling afterEach in Jasmine)
Gets executed right after terminating the webdriver session.
This callback is only invoked during the "testcases" phase.
wdio-workflo configuration object
list of capabilities details
List of testcases file paths that ran
Hook that gets executed after the suite has ended
suite details
Function to be executed after a testcase ends.
test details
Gets executed after all tests are done. You still have access to all global variables from the test.
0 - test pass, 1 - test fail
list of capabilities details
List of spec file paths that ran
Gets executed before testcases execution begins. At this point you can access to all global
variables like browser. It is the perfect place to define custom commands.
This callback is only invoked during the "testcases" phase.
list of capabilities details
List of testcases file paths that are to be run
Runs before a WebdriverIO command gets executed.
hook command name
arguments that command would receive
Hook that gets executed before a hook within the suite starts (e.g. runs before calling beforeEach in Jasmine)
Gets executed just before initialising the webdriver session and test framework. It allows you to manipulate configurations depending on the capability or testcase.
This callback is only invoked during the "testcases" phase.
wdio-workflo configuration object
list of capabilities details
List of testcases file paths that are to be run
Hook that gets executed before the suite starts
suite details
Function to be executed before a testcase starts.
test details
Gets executed before test execution begins. At this point you can access to all global
variables like browser. It is the perfect place to define custom commands.
This callback is only invoked during the "testcases" phase.
list of capabilities details
List of spec file paths that are to be run
Gets executed after all workers got shut down and the process is about to exit.
0 - success, 1 - fail
wdio-workflo configuration object
list of capabilities details
Gets executed when an error happens, good place to take a screenshot @ {Error} error
Gets executed once before all workers get launched.
wdio-workflo configuration object
list of capabilities details
Generated using TypeDoc
Type definitions of the config used by wdio-workflo in the file workflo.conf.ts.