nightwatch.js schema Json Format

custom_commands_path - Location(s) where custom commands will be loaded from.

custom_assertions_path - Location(s) where custom assertions will be loaded from.

page_objects_path - Location(s) where page object files will be loaded from.

globals_path - Location of an external globals module which will be loaded and made available to the test as a property globals on the main client instance.

.globals

_

globals.abortOnAssertionFailure - This controls whether to abort the test execution when an assertion failed and skip the rest. It's being used in waitFor commands and expect assertions

globals.abortOnElementLocateError - This controls whether to abort the test execution when an element cannot be located; an error is logged in all cases, but this also enables skipping the rest of the testcase; It's being used in element commands such as .click() or .getText()

globals.waitForConditionPollInterval - This will overwrite the default polling interval (currently 500ms) for waitFor commands and expect assertions that use retry

globals.waitForConditionTimeout - Default timeout value in milliseconds for waitFor commands and implicit waitFor value for expect assertions

globals.throwOnMultipleElementsReturned - This will cause waitFor commands on elements to throw an error if multiple elements are found using the given locate strategy and selector

globals.suppressWarningsOnMultipleElementsReturned - By default a warning is printed if multiple elements are found using the given locate strategy and selector; set this to true to suppress those warnings

globals.asyncHookTimeout - Controls the timeout value for async hooks. Expects the done() callback to be invoked within this time or an error is thrown

globals.unitTestsTimeout - Controls the timeout value for when running async unit tests. Expects the done() callback to be invoked within this time or an error is thrown

globals.customReporterCallbackTimeout - Controls the timeout value for when executing the global async reporter. Expects the done() callback to be invoked within this time or an error is thrown

globals.retryAssertionTimeout - Automatically retrying failed assertions - You can tell Nightwatch to automatically retry failed assertions until a given timeout is reached, before the test runner gives up and fails the test.

.dotenv

_

persist_globals - Persist the same globals object between runs or have a (deep) copy of it per each test; this can be useful when persisting data between test suites is needed, such as a cookie or session information

output_folder - The location where the JUnit XML report files will be saved. Set this to false if you want to disable XML reporting

src_folders - A string or array of folders (excluding subfolders) where the tests are located.

live_output - Used when running in parallel to determine if the output should be collected and displayed at the end.

disable_colors - Used to disable colored output in the terminal.

parallel_process_delay - Used when running in parallel to specify the delay (in milliseconds) between starting the child processes

.selenium

_

selenium.start_process

selenium.cli_args

selenium.server_path

selenium.log_path

selenium.check_process_delay

selenium.max_status_poll_tries

selenium.status_poll_interval

start_session - Whether or not to automatically start the Selenium/WebDriver session. If running unit tests, this should be set tot false.

end_session_on_fail - End the session automatically when the test is being terminated, usually after a failed assertion.

test_workers - Whether or not to run individual test files in parallel.

test_runner - Specifies which test runner to use: default|mocha

.webdriver

_

webdriver.start_process

webdriver.cli_args

webdriver.server_path

webdriver.log_path

webdriver.check_process_delay - Time to wait (in ms) before starting to check the Webdriver server is up and running

webdriver.max_status_poll_tries - Maximum number of ping status check attempts before returning a timeout error

webdriver.status_poll_interval - Interval (in ms) to use between status ping checks when checking if the Webdriver server is up and running

webdriver.process_create_timeout - The entire time (in ms) to wait for the Node.js process to be created and running (default is 2 min), including spawning the child process and checking the status

.webdriver.timeout_options

_

.test_settings

_

launch_url - A url which can be used later in the tests as the main url to load.

silent - set to false if you want to show the extended http traffic command logs from the WebDriver server.

output - Used to disable terminal output completely.

detailed_output - Set this to false if you'd like to only see the test case name displayed and pass/fail status.

output_timestamp - Set this to true if you'd like to see timestamps next to the logging output

disable_error_log - Set this to true if you'd like to not display errors during the execution of the test (they are shown at the end always).

screenshots - Take error and failure screenshots during test execution

log_screenshot_data - Used to enable showing the Base64 image data in the (verbose) log when taking screenshots.

.desiredCapabilities

_

desiredCapabilities.browserName

exclude - An array of folders or file patterns to be skipped (relative to the main source folder).

filter - Folder or file pattern to be used when loading the tests. Files that don't match this pattern will be ignored.

skipgroup - Skip a group of tests (a subfolder); can be a list of comma-separated values (no space)

sync_test_names

skiptags - Skip tests by tag name; can be a list of comma-separated values (no space)

use_xpath - Use xpath as the default locator strategy

parallel_mode

report_prefix

unit_tests_mode

default_reporter

ToolMatter

Your Apps in Action

Use this form to visualize nightwatch.js schema.

{{repoTitle.MainEntity}}

_

_

_

_

_

_

_