A WebDriver server for ChromeOS, implementing the subset of the WebDriver protocol necessary for Karma. Add ChromeOS to your Selenium grid!
Part of the Generic WebDriver Server family.
npm install --save-dev generic-webdriver-server chromeos-webdriver-server
First, please refer to the "Setup" doc for Generic WebDriver Server. That will explain how to set up Selenium to talk to Generic WebDriver Servers, as well as how to set server parameters.
In the command-line for the Selenium node, set the following Java system properties:
-
genericwebdriver.browser.name
: We recommend the value "chromeos". See also notes in the "Setup" doc. -
genericwebdriver.backend.exe
: The path to the executable, such asnode_modules/chromeos-webdriver-server/chromeos-webdriver-server.js
-
genericwebdriver.backend.params.hostname
: The hostname or IP address of the ChromeOS device, with optional SSH port number. If omitted, this must be provided in the client's desired capabilities instead. (See below.)
This backend supports the following parameters:
-
hostname
: (required) The hostname or IP address of the ChromeOS device, with optional SSH port number. -
username
: The username to use when logging in via SSH (defaults toroot
). -
private-key
: The path to the private key to use when logging in via SSH (defaults to~/.ssh/chromeos_testing_rsa
). -
fetch-private-key
: If true, fetch the SSH private key if it doesn't exist at the path specified byprivate-key
(defaults to true). -
private-key-url
: The URL from which to fetch a base64-encoded private key (defaults to the source code URL of the private key used by default in all dev-mode ChromeOS devices).
In addition to the parameters above, this server supports passing on extra command line arguments to Chrome. On the server command line, these are placed at the end of the command and are separated from server parameters by "--".
These Chrome arguments can be set in the client's desired capabilities under
generic:args
. For example:
caps = {
'browserName': 'chromeos',
'version': 'Pixelbook',
'generic:args': [
# Appended to the server command after "--", then passed on to the Chrome
# instance instead of being handled by the server.
'--autoplay-policy=no-user-gesture-required',
],
}
See also related notes in the "Setup" doc.
See device-setup.md for details on setting up a ChromeOS device in dev mode and enabling SSH access.
See how-it-works.md for details.
See tunneling.md for details.
In addition to running a ChromeOS node in Selenium, this package offers a CLI
for directing a ChromeOS device to a specific URL. For example, if installed
globally with npm install -g chromeos-webdriver-server
:
chromeos-webdriver-cli --hostname=192.168.1.42 --url=https://www.google.com/