Skip to content

SeleniumFoundationSettings.md

Latest commit

 

History

History
124 lines (86 loc) · 10.2 KB

SeleniumFoundationSettings.md

File metadata and controls

124 lines (86 loc) · 10.2 KB

Selenium Foundation Settings

Configuration settings for Selenium Foundation, controlled via settings.properties or System property declarations.

NOTE: The System property key associated with each setting can be revealed by tapping the expander next to the setting constant name.

Target URI

Settings that define the components of the target URI used for test navigation.

Setting Default Description
TARGET_SCHEMEselenium.target.scheme
 http Scheme component of the target URI
TARGET_CREDSselenium.target.creds
 (none)
Credentials component of the target URIProvides credentials in standard URL format
(e.g. - username:password)
TARGET_HOSTselenium.target.host
 localhost Host component of the target URI
TARGET_PORTselenium.target.port
 (none)
Port component of the target URISpecifies a non-default port number
TARGET_PATHselenium.target.path
 /
Path component of the target URISpecifies a base path from which all pages originate

Selenium Grid

Settings that control the local Selenium Grid instance.

Setting Default Description
GRID_PLUGINSselenium.grid.plugins
 (none)
Path-delimited list of fully-qualified driver plug-in class names.NOTE: Overrides the ServiceLoader provider configuration file.
GRID_SERVLETSselenium.grid.servlets
 (none)
Comma-delimited list of fully-qualified servlet class names.Selenium 3: Hosted by the hub server.
Selenium 4: Hosted by ServletContainer.
SHUTDOWN_GRIDselenium.grid.shutdown
 true Whether to shut down the local Grid instance at the end of the test run
GRID_LAUNCHERselenium.grid.launcher
version-specificSelenium 3: org.openqa.grid.selenium.GridLauncherV3
Selenium 4: org.openqa.selenium.grid.Bootstrap
 Fully-qualified name of the GridLauncher class.
LAUNCHER_DEPSselenium.launcher.deps
 version-specific Path-delimited list of fully-qualified context class names for Grid launcher dependencies
SLOT_MATCHERselenium.slot.matcher
 FoundationSlotMatcher Slot matcher used by the hub server
GRID_WORKING_DIRselenium.grid.working.dir
 (none) Working directory for local Grid server processes
GRID_LOGS_FOLDERselenium.grid.log.folder
 logs
Log file folder for local Grid server processes.If relative, resolved against GRID_WORKING_DIR (or user.dir if unset).
GRID_NO_REDIRECTselenium.grid.no.redirect
 false Whether to suppress capture of Grid server output to log files
GRID_EXAMPLESselenium.grid.examples
 true Whether to install the ExamplePageServlet on the hub server
GRID_LIFECYCLEselenium.grid.lifecycle
 true Whether to install the LifecycleServlet on hub and node servers (enables remote shutdown)

Hub Server

Settings that configure the Selenium Grid hub server.

Setting Default Description
HUB_CONFIGselenium.hub.config
version-specific Selenium 3: hubConfig-s3.json
Selenium 4: hubConfig-s4.json
 Hub server configuration file name or path.
HUB_HOSTselenium.hub.host
version-specificSelenium 3: http://localhost:4445/wd/hub
Selenium 4: http://localhost:4446/wd/hub
 URL for the Grid hub endpoint ([scheme:][//authority]/wd/hub).
HUB_PORTselenium.hub.port
version-specific Selenium 3: 4445
Selenium 4: 4446
 Port for the local hub server.
HUB_DEBUGselenium.hub.debug
falseAdds JDWP library to suspend the hub server on launch, listening at port 8000
 Whether to launch the hub server with JDWP debugging enabled

Node Server

Settings that configure Selenium Grid node servers.

Setting Default Description
NODE_CONFIGselenium.node.config
version-specificSelenium 3: nodeConfig-s3.json
Selenium 4: nodeConfig-s4.json
 Node server configuration template file name or path.
NODE_DEBUGselenium.node.debug
falseAdds JDWP library to suspend the node server on launch, listening at port 8001
 Whether to launch node servers with JDWP debugging enabled

Browser

Settings that specify the browser used for new WebDriver sessions.

Setting Default Description
BROWSER_NAMEselenium.browser.name
 (none) Browser name or "personality" for new session requests
BROWSER_CAPSselenium.browser.caps
 (none)
Capabilities for new session requests. Learn more...Used when BROWSER_NAME is undefined. This setting may specify a file path (absolute, relative, or simple filename) or a JSON Capabilities object.

Timeouts

Settings that control various wait and timeout intervals (all values in seconds).

Setting Default Description
PAGE_LOAD_TIMEOUTselenium.timeout.pageload
 30s Maximum number of seconds allowed for a page to finish loading
IMPLIED_TIMEOUTselenium.timeout.implied
 15s Maximum number of seconds the driver will search for an element
SCRIPT_TIMEOUTselenium.timeout.script
 30s Maximum number of seconds allowed for an asynchronous script to finish
WAIT_TIMEOUTselenium.timeout.wait
 15s Maximum number of seconds to wait for a search context event
HOST_TIMEOUTselenium.timeout.host
 30s Maximum number of seconds to wait for a Grid server to launch

Context

Settings that define the current test context.

Setting Default Description
CONTEXT_PLATFORMselenium.context.platform
 support Target platform for the current test context Learn more...
ALLOWED_EXCEPTIONSselenium.allowed.exceptions
 (none)
Java exceptions that scripts are allowed to return Learn more...This setting specifies a comma-delimited list of exceptions (or packages/subtrees containing exceptions) that executed JavaScript snippets are allowed to return.

Appium

Settings that configure the Appium mobile automation server.

Setting Default Description
APPIUM_CONFIG_PATHappium.config.path
 (none)
Appium server configuration file name or path Learn more...The Appium configuration can be JSON, YAML, or JavaScript (for dynamic configuration)
APPIUM_CLI_ARGSappium.cli.args
 (none)
Server arguments passed to Appium on launch.May be declared multiple times in settings.properties. For complex configurations, consider using APPIUM_CONFIG instead.
APPIUM_BINARY_PATHappium.binary.path
 $APPIUM_BINARY_PATH Path to the Appium main script file. If unset, the global Node package repository is searched.
APPIUM_WITH_PM2appium.with.pm2
 false
Whether Appium should be managed by the PM2 process manager (required for standalone node)NOTE: Appium requires an active execution context. To run Appium as a stand-alone Selenium Grid node, the server must to executed as a daemon process. Starting the server via the PM2 utility provides the required persistent execution context.

Node.js / NPM

Settings that locate the Node.js runtime and associated package managers.

Setting Default Description
NODE_BINARY_PATHnode.binary.path
 $NODE_BINARY_PATH Path to the Node.js JavaScript runtime. If unset, the system PATH is searched.
NPM_BINARY_PATHnpm.binary.path
 (none) Path to the NPM package manager utility. If unset, the system PATH is searched.
PM2_BINARY_PATHpm2.binary.path
 (none) Path to the PM2 process manager utility. If unset, the system PATH is searched.