Skip to content

Latest commit

 

History

History
82 lines (66 loc) · 7.8 KB

CONFIG.md

File metadata and controls

82 lines (66 loc) · 7.8 KB
Raw

Configuration

The Configuration follows the Gauge configuration approach. The following properties are supported:

Categories

General

Property Type Default Description
driver_cache_days int 365 number of days, before the driver manager will invalidate the cache and make a renewal request.
debug_log boolean false Logs more information.
diff_formats gradient | full | color:xyz full For screenshot comparisons. xyz: any CSS3 color name.
screenshot_whole_page_no_scroll boolean false Firefox offers to take a screenshot of the whole page, even if the page is wider and higher than the current viewport. This is not standard behaviour.
time_pattern string %Y-%m-%d_%H-%M-%S Supported date format codes can be taken from the Python docs.
filename_pattern string %{browser}_%{name}.%{ext} Screenshot files will be named according to this pattern. Available placeholders are %{browser}, %{name}, %{ext}, %{time}. %{time} is defined by the property %{time_pattern}.
screenshot_dir string screenshots Determines the directory, in which screenshots should be saved.
actual_screenshot_dir string actual_screenshots Determines the directory, in which the screenshots of the current test run should be stored, which will be compared to expected screenshots.
expected_screenshot_dir string expected_screenshots Determines the directory, in which the expected screenshots will be found, which are the source for comparisons.
failure_screenshot_dir string reports/html-report/images Determines the directory, in which screenshots will be stored, that are taken when an error happens.
driver_browser chrome | firefox | safari | edge | internet explorer | opera firefox The browser, in which tests should run.
driver_implicit_timeout int 5 Seconds to wait for any web elements to appear, disappear, or transform into an expected state.
driver_operating_system win | macos | linux | android | ios macos Determines on which OS the tests should run.
driver_operating_system_version string None | Windows 11 | macOS 13 Some drivers need the OS version, but it is not needed for local tests.
driver_page_load_timeout int 30 Timeout in seconds to wait until a web page has been loaded.
driver_platform local | saucelabs local Whether the driver should connect to a remote device cloud provider. At the moment, SauceLabs is the only supported service provider.
driver_platform_local_headless boolean false When driver_platform = local, then tests can be run in headless mode.
driver_custom_args string None Optional custom arguments, that are appended to the browser options, f.i. incognito for chrome browsers. Multiple arguments can be comma-separated.
driver_binary_copy boolean false The driver binary will be copied to a unique temporary file for each parallel process. This is a workaround for parallel selenium driver executions. Use it if you experience errors in parallel test runs.
driver_manager_selenium4 boolean false Use the build-in driver manager of Selenium 4 (currently beta) instead of the standard third party 'webdriver-manager'. This might help solve issues with parallel test executions, when driver_binary_copy does not work. Does not work with Opera.

Appium

The following properties define a connection to an Appium server. With Appium, mobile browsers can be used for testing.

Property Type Default Description
driver_platform_local_mobile_appium_server_url string None This is the URL of the appium command executor. For local tests, this typically is http://127.0.0.1:4444/wd/hub.
driver_platform_local_mobile_device_name string None The device name of the Appium test device.
driver_platform_local_mobile_device_udid string None The UID of the Appium test device.
driver_platform_local_mobile_real_device boolean false Whether the test device is a simulator or a real device.

Saucelabs

The following properties define a connection to the SauceLabs device cloud provider.

Property Type Default Description
driver_platform_saucelabs_mobile_appium_version string None When not specified, a default will be picked by SauceLabs.
driver_platform_saucelabs_desktop_browser_version string latest The release version of the chosen browser.
driver_platform_saucelabs_mobile_device_name string None The name of the test device. Regular expressions are supported: Samsung.*, iPhone [6-7]. The Platform Configurator can be used to pick a device.
driver_platform_saucelabs_executor string None The executor URL of SauceLabs. This URL can be found in the Platform Configurator.
driver_platform_saucelabs_test_title string None Test runs can be given a title, so they can be found more easily in the Test Results or Builds.
driver_platform_saucelabs_build string None Test runs can be given a build ID, so they can be found more easily in the Test Results or Builds.
driver_platform_saucelabs_devicecache boolean false Whether real devices should be allocated to a test suite and bypass the device cleaning process in between multiple specifications. A cacheId will be assigned automatically.
driver_platform_saucelabs_extended_debugging boolean false Enable extended debugging with this flag.

The following properties should be set as system variables, rather than Gauge properties:

Property Type Default Description
SAUCE_TUNNEL_ACTIVE boolean false Whether the Sauce Connect tunnel should be started before test execution.
SAUCE_PATH string sc Path to the Sauce Connect binary.
SAUCE_USERNAME string None SauceLabs user name
SAUCE_ACCESS_KEY string None SauceLabs access key. It can be found in the user settings.
SAUCE_API_ADDRESS string 127.0.0.1:8080 The standard address of the SauceConnect tunnel API, when run locally is 127.0.0.1:8080, without http://. It is needed to determine the status of the connection.
SAUCE_TUNNEL_NAME string None If the SauceConnect tunnel is used, a name must be chosen. The name can be found on the Tunnel Proxies page.
SAUCE_REGION string None Possible regions as of now: eu-central, us-west

Other Sauce Connect properties can be found in the Sauce Connect Proxy Configuration. For example, when testing on android devices on your VPN, it is usually needed to set a value for SAUCE_TLS_PASSTHROUGH_DOMAINS = <regexp>.

Deprecated

  • driver_headless: use driver_platform_local_headless instead