Capabilities

Eine Capability ist eine Definition für eine entfernte Software. Es hilft WebdriverIO zu verstehen, in welchem Browser oder in welcher mobilen Umgebung Sie Ihre Tests ausführen möchten. Capabilities sind weniger wichtig, wenn Sie Tests lokal entwickeln, da Sie sie die meiste Zeit auf einer Remote-Schnittstelle ausführen, werden aber wichtiger, wenn Sie eine große Anzahl von Integrationstests in CI/CD ausführen.

info

Das Format eines Capability-Objekts ist durch die WebDriver-Spezifikationgenau definiert. Der WebdriverIO-Testrunner schlägt vorzeitig fehl, wenn benutzerdefinierte Funktionen diese Spezifikation nicht einhalten.

Benutzerdefinierte Capabilities

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:

Browserspezifische Capability-Erweiterungen

• goog:chromeOptions: Chromedriver Erweiterungen, nur zum Testen in Chrome anwendbar
• moz:firefoxOptions: Geckodriver Erweiterungen, nur anwendbar zum Testen in Firefox
• ms:edgeOptions: EdgeOptions zum Angeben der Umgebung bei Verwendung von EdgeDriver zum Testen von Chromium Edge

Capability Erweiterungen von Cloud-Anbietern

• sauce:options: Sauce Labs
• bstack:options: BrowserStack
• tb:options: TestingBot
• und viel, viel mehr!

Erweiterungen der Automation Engine-Capabilities

• appium:xxx: Appium
• selenoid:xxx: Selenoid
• und viel, viel mehr!

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.

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.

Type: string

Browser Specific Driver Options

In order to propagate options to the driver you can use the following custom capabilities:

• Chrome: wdio:chromedriverOptions
• Firefox: wdio:geckodriverOptions
• Microsoft Egde: wdio:edgedriverOptions
• Safari: wdio:safaridriverOptions

wdio:chromedriverOptions

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: ['*']

wdio:geckodriverOptions

See all Geckodriver options in the official driver package.

wdio:edgedriverOptions

See all Edgedriver options in the official driver package.

wdio:safaridriverOptions

See all Safaridriver options in the official driver package.

Spezielle Capabilities für spezielle Anwendungsfälle

Dies ist eine Liste von Beispielen, die zeigen, welche Fähigkeiten angewendet werden müssen, um einen bestimmten Anwendungsfall zu erreichen.

Führen Sie den Browser Headless aus

Das Ausführen eines Headless-Browsers bedeutet, eine Browserinstanz ohne Fenster oder Benutzeroberfläche auszuführen. Dies wird hauptsächlich in CI/CD-Umgebungen verwendet, in denen kein Display verwendet wird. Wenden Sie die folgenden Funktionen an, um einen Browser im Headless-Modus auszuführen:

Chrome

{
    browserName: 'chrome',    // or 'chromium'
    'goog:chromeOptions': {
        args: ['headless', 'disable-gpu']
    }
}

Firefox

    browserName: 'firefox',
    'moz:firefoxOptions': {
        args: ['-headless']
    }

Microsoft Edge

    browserName: 'msedge',
    'ms:edgeOptions': {
        args: ['--headless']
    }

Safari

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

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'
}

Firefox

When testing on Firefox, you can let WebdriverIO setup Firefox Nightly for you by providing latest as browserVersion:

    browserName: 'firefox',
    browserVersion: 'latest'

If you like to test a manually downloaded version you can provide a binary path to the browser via:

    browserName: 'firefox',
    'moz:firefoxOptions': {
        bin: '/Applications/Firefox\ Nightly.app/Contents/MacOS/firefox'
    }

Microsoft Edge

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': {
        bin: '/Applications/Microsoft\ Edge\ Canary.app/Contents/MacOS/Microsoft\ Edge\ Canary'
    }

Safari

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'