Capacidades
Una capacidad es la definición de una interfaz remota. Ayuda a WebdriverIO a comprender en qué navegador o entorno móvil le gusta ejecutar sus pruebas. Las capacidades son menos cruciales a la hora de desarrollar pruebas localmente a medida que se ejecuta en una interfaz remota la mayoría de las veces, pero se hace más importante cuando se ejecuta un amplio conjunto de pruebas de integración en CI/Cd.
El formato de un objeto de capacidad está bien definido por la especificación WebDriver. El testrunner de WebdriverIO fallará temprano si las capacidades definidas por el usuario no se adhieren a esa especificación.
Características personalizadas
While the amount of fixed defined capabilities is very low, everyone can provide and accept custom capabilities that are specific to the automation driver or remote interface:
Extensiones de Capacidad Específica del Explorador
goog:chromeOptions
: extensiones de Chromedriver , solo aplicables para pruebas en Chromemoz:firefoxOptions
: extensiones de Geckodriver solo aplicables para pruebas en Firefoxms:edgeOptions
: EdgeOptions para especificar el entorno cuando se usa EdgeDriver para probar Chromium Edge
Extensiones de capacidad del vendedor en la nube
sauce:options
: Sauce Labsbstack:options
: BrowserStacktb:options
: TestingBot- y mucho más...
Extensiones de capacidad de Motor de Automatización
WebdriverIO Capabilities to manage browser driver options
WebdriverIO manages installing and running browser driver for you. WebdriverIO uses a custom capability that allows you to pass in parameters to the driver.
wdio:chromedriverOptions
Specific options passed into Chromedriver when starting it.
wdio:geckodriverOptions
Specific options passed into Geckodriver when starting it.
wdio:edgedriverOptions
Specific options passed into Edgedriver when starting it.
wdio:safaridriverOptions
Specific options passed into Safari when starting it.
wdio:maxInstances
Maximum number of total parallel running workers for the specific browser/capability. Takes precedence over maxInstances and maxInstancesPerCapability.
Type: number
wdio:specs
Define specs for test execution for that browser/capability. Same as the regular specs
configuration option, but specific to the browser/capability. Takes precedence over specs
.
Type: (String | String[])[]
wdio:exclude
Exclude specs from test execution for that browser/capability. Same as the regular exclude
configuration option, but specific to the browser/capability. Takes precedence over exclude
.
Type: String[]
wdio:enforceWebDriverClassic
By default, WebdriverIO attempts to establish a WebDriver Bidi session. If you don't prefer that, you can set this flag to disable this behavior.
Type: boolean
Common Driver Options
While all driver offer different parameters for configuration, there are some common ones that WebdriverIO understand and uses for setting up your driver or browser:
cacheDir
The path to the root of the cache directory. This directory is used to store all drivers that are downloaded when attempting to start a session.
Type: string
Default: process.env.WEBDRIVER_CACHE_DIR || os.tmpdir()
binary
Path to a custom driver binary. If set WebdriverIO won't attempt to download a driver but will use the one provided by this path. Make sure the driver is compatible with the browser you are using.
You can provide this path via CHROMEDRIVER_PATH
, GECKODRIVER_PATH
or EDGEDRIVER_PATH
environment variables.
Type: string
If the driver binary
is set, WebdriverIO won't attempt to download a driver but will use the one provided by this path. Make sure the driver is compatible with the browser you are using.
Browser Specific Driver Options
In order to propagate options to the driver you can use the following custom capabilities:
- Chrome or Chromium:
wdio:chromedriverOptions
- Firefox:
wdio:geckodriverOptions
- Microsoft Egde:
wdio:edgedriverOptions
- Safari:
wdio:safaridriverOptions
- wdio:chromedriverOptions
- wdio:geckodriverOptions
- wdio:edgedriverOptions
- wdio:safaridriverOptions
adbPort
The port on which the ADB driver should run.
Example: 9515
Type: number
urlBase
Base URL path prefix for commands, e.g. wd/url
.
Example: /
Type: string
logPath
Write server log to file instead of stderr, increases log level to INFO
Type: string
logLevel
Set log level. Possible options ALL
, DEBUG
, INFO
, WARNING
, SEVERE
, OFF
.
Type: string
verbose
Log verbosely (equivalent to --log-level=ALL
)
Type: boolean
silent
Log nothing (equivalent to --log-level=OFF
)
Type: boolean
appendLog
Append log file instead of rewriting.
Type: boolean
replayable
Log verbosely and don't truncate long strings so that the log can be replayed (experimental).
Type: boolean
readableTimestamp
Add readable timestamps to log.
Type: boolean
enableChromeLogs
Show logs from the browser (overrides other logging options).
Type: boolean
bidiMapperPath
Custom bidi mapper path.
Type: string
allowedIps
Comma-separated allowlist of remote IP addresses which are allowed to connect to EdgeDriver.
Type: string[]
Default: ['']
allowedOrigins
Comma-separated allowlist of request origins which are allowed to connect to EdgeDriver. Using *
to allow any host origin is dangerous!
Type: string[]
Default: ['*']
spawnOpts
Options to be passed into the driver process.
Type: SpawnOptionsWithoutStdio | SpawnOptionsWithStdioTuple<StdioOption, StdioOption, StdioOption>
Default: undefined
See all Geckodriver options in the official driver package.
See all Edgedriver options in the official driver package.
See all Safaridriver options in the official driver package.
Capacidades especiales para Casos de Uso Específico
Esta es una lista de ejemplos que muestran qué capacidades se deben aplicar para lograr un caso de uso concreto.
Ejecutar navegador remotamente
Ejecutar un navegador remotamente significa ejecutar una instancia del navegador sin ventana o IU. Esto se usa principalmente en entornos CI/CD en los que no se usa ninguna pantalla. Para ejecutar un navegador en modo remoto, aplique las siguientes capacidades:
- Chrome
- Firefox
- Microsoft Edge
- Safari
{
browserName: 'chrome', // or 'chromium'
'goog:chromeOptions': {
args: ['headless', 'disable-gpu']
}
}
browserName: 'firefox',
'moz:firefoxOptions': {
args: ['-headless']
}
browserName: 'msedge',
'ms:edgeOptions': {
args: ['--headless']
}
It seems that Safari doesn't support running in headless mode.
Automate Different Browser Channels
If you like to test a browser version that is not yet released as stable, e.g. Chrome Canary, you can do so by setting capabilities and pointing to the browser you like to start, e.g.:
- Chrome
- Firefox
- Microsoft Edge
- Safari
When testing on Chrome, WebdriverIO will automatically download the desired browser version and driver for you based on the defined browserVersion
, e.g.:
{
browserName: 'chrome', // or 'chromium'
browserVersion: '116' // or '116.0.5845.96', 'stable', 'dev', 'canary', 'beta' or 'latest' (same as 'canary')
}
If you like to test a manually downloaded browser, you can provide a binary path to the browser via:
{
browserName: 'chrome', // or 'chromium'
'goog:chromeOptions': {
binary: '/Applications/Google\ Chrome\ Canary.app/Contents/MacOS/Google\ Chrome\ Canary'
}
}
Additionally, if you like to use a manually downloaded driver, you can provide a binary path to the driver via:
{
browserName: 'chrome', // or 'chromium'
'wdio:chromedriverOptions': {
binary: '/path/to/chromdriver'
}
}
When testing on Firefox, WebdriverIO will automatically download the desired browser version and driver for you based on the defined browserVersion
, e.g.:
{
browserName: 'firefox',
browserVersion: '119.0a1' // or 'latest'
}
If you like to test a manually downloaded version you can provide a binary path to the browser via:
{
browserName: 'firefox',
'moz:firefoxOptions': {
binary: '/Applications/Firefox\ Nightly.app/Contents/MacOS/firefox'
}
}
Additionally, if you like to use a manually downloaded driver, you can provide a binary path to the driver via:
{
browserName: 'firefox',
'wdio:geckodriverOptions': {
binary: '/path/to/geckodriver'
}
}
When testing on Microsoft Edge, make sure you have the desired browser version installed on your machine. You can point WebdriverIO to the browser to execute via:
{
browserName: 'msedge',
'ms:edgeOptions': {
binary: '/Applications/Microsoft\ Edge\ Canary.app/Contents/MacOS/Microsoft\ Edge\ Canary'
}
}
WebdriverIO will automatically download the desired driver version for you based on the defined browserVersion
, e.g.:
{
browserName: 'msedge',
browserVersion: '109' // or '109.0.1467.0', 'stable', 'dev', 'canary', 'beta'
}
Additionally, if you like to use a manually downloaded driver, you can provide a binary path to the driver via:
{
browserName: 'msedge',
'wdio:edgedriverOptions': {
binary: '/path/to/msedgedriver'
}
}
When testing on Safari, make sure you have the Safari Technology Preview installed on your machine. You can point WebdriverIO to that version via:
{
browserName: 'safari technology preview'
}
Extend Custom Capabilities
If you like to define your own set of capabilities in order to e.g. store arbitrary data to be used within the tests for that specific capability, you can do so by e.g. setting:
export const config = {
// ...
capabilities: [{
browserName: 'chrome',
'custom:caps': {
// custom configurations
}
}]
}
It is advised to follow the W3C protocol when it comes to capability naming which requires a :
(colon) character, denoting an implementation specific namespace. Within your tests you can access your custom capability through, e.g.:
browser.capabilities['custom:caps']
In order to ensure type safety you can extend WebdriverIOs capability interface via:
declare global {
namespace WebdriverIO {
interface Capabilities {
'custom:caps': {
// ...
}
}
}
}