Module

WebdriverIO veröffentlicht verschiedene Module auf NPM und anderen Registries, die Sie verwenden können, um Ihr eigenes Automatisierungs-Framework aufzubauen. Weitere Dokumentation zu WebdriverIO-Einrichtungstypen finden Sie hier.

webdriver und devtools

Die Protokoll-Pakete (webdriver und devtools) stellen eine Klasse mit den folgenden statischen Funktionen zur Verfügung, die es Ihnen ermöglichen, Sitzungen zu initiieren:

newSession(options, modifier, userPrototype, customCommandWrapper)

Startet eine neue Sitzung mit spezifischen Capabilities. Basierend auf der Sitzungsantwort werden Befehle aus verschiedenen Protokollen bereitgestellt.

Paramaters

• options: WebDriver Options
• modifier: Funktion, die es ermöglicht, die Client-Instanz zu modifizieren, bevor sie zurückgegeben wird
• userPrototype: Eigenschaftsobjekt, das es ermöglicht, den Instanzprototyp zu erweitern
• customCommandWrapper: Funktion, die es ermöglicht, Funktionalität um Funktionsaufrufe zu wickeln

Returns

• Browser Objekt

Example

const client = await WebDriver.newSession({
    capabilities: { browserName: 'chrome' }
})

attachToSession(attachInstance, modifier, userPrototype, customCommandWrapper)

Verbindet sich mit einer laufenden WebDriver- oder DevTools-Sitzung.

Paramaters

• attachInstance: Instanz, mit der eine Sitzung verbunden werden soll, oder zumindest ein Objekt mit einer Eigenschaft sessionId (z.B. { sessionId: 'xxx' })
• modifier: Funktion, die es ermöglicht, die Client-Instanz zu modifizieren, bevor sie zurückgegeben wird
• userPrototype: Eigenschaftsobjekt, das es ermöglicht, den Instanzprototyp zu erweitern
• customCommandWrapper: Funktion, die es ermöglicht, Funktionalität um Funktionsaufrufe zu wickeln

Returns

• Browser Objekt

Example

const client = await WebDriver.newSession({...})
const clonedClient = await WebDriver.attachToSession(client)

reloadSession(instance)

Lädt eine Sitzung mit der bereitgestellten Instanz neu.

Paramaters

• instance: Paketinstanz zum Neuladen

Example

const client = await WebDriver.newSession({...})
await WebDriver.reloadSession(client)

webdriverio

Ähnlich wie bei den Protokoll-Paketen (webdriver und devtools) können Sie auch die WebdriverIO-Paket-APIs verwenden, um Sitzungen zu verwalten. Die APIs können mit import { remote, attach, multiremote } from 'webdriverio' importiert werden und enthalten die folgende Funktionalität:

remote(options, modifier)

Startet eine WebdriverIO-Sitzung. Die Instanz enthält alle Befehle wie das Protokoll-Paket, aber mit zusätzlichen Funktionen höherer Ordnung, siehe API-Dokumentation.

Paramaters

• options: WebdriverIO Options
• modifier: Funktion, die es ermöglicht, die Client-Instanz zu modifizieren, bevor sie zurückgegeben wird

Returns

• Browser Objekt

Example

import { remote } from 'webdriverio'

const browser = await remote({
    capabilities: { browserName: 'chrome' }
})

attach(attachOptions)

Verbindet sich mit einer laufenden WebdriverIO-Sitzung.

Paramaters

• attachOptions: Instanz, mit der eine Sitzung verbunden werden soll, oder zumindest ein Objekt mit einer Eigenschaft sessionId (z.B. { sessionId: 'xxx' })

Returns

• Browser Objekt

Example

import { remote, attach } from 'webdriverio'

const browser = await remote({...})
const newBrowser = await attach(browser)

multiremote(multiremoteOptions)

Initiiert eine Multiremote-Instanz, mit der Sie mehrere Sitzungen innerhalb einer einzigen Instanz steuern können. Schauen Sie sich unsere Multiremote-Beispiele für konkrete Anwendungsfälle an.

Paramaters

• multiremoteOptions: ein Objekt mit Schlüsseln, die den Browsernamen und ihre WebdriverIO Options repräsentieren.

Returns

• Browser Objekt

Example

import { multiremote } from 'webdriverio'

const matrix = await multiremote({
    myChromeBrowser: {
        capabilities: { browserName: 'chrome' }
    },
    myFirefoxBrowser: {
        capabilities: { browserName: 'firefox' }
    }
})
await matrix.url('http://json.org')
await matrix.getInstance('browserA').url('https://google.com')

console.log(await matrix.getTitle())
// returns ['Google', 'JSON']

@wdio/cli

Anstatt den wdio-Befehl aufzurufen, können Sie den Testrunner auch als Modul einbinden und in einer beliebigen Umgebung ausführen. Dafür müssen Sie das @wdio/cli-Paket als Modul einbinden, wie hier:

EcmaScript Modules

import Launcher from '@wdio/cli'

CommonJS

const Launcher = require('@wdio/cli').default

Danach erstellen Sie eine Instanz des Launchers und führen den Test aus.

Launcher(configPath, opts)

Der Launcher-Klassenkonstruktor erwartet die URL zur Konfigurationsdatei und ein opts-Objekt mit Einstellungen, die die in der Konfiguration überschreiben.

Paramaters

• configPath: Pfad zur auszuführenden wdio.conf.js
• opts: Argumente (<RunCommandArguments>) zum Überschreiben von Werten aus der Konfigurationsdatei

Example

const wdio = new Launcher(
    '/path/to/my/wdio.conf.js',
    { spec: '/path/to/a/single/spec.e2e.js' }
)

wdio.run().then((exitCode) => {
    process.exit(exitCode)
}, (error) => {
    console.error('Launcher failed to start the test', error.stacktrace)
    process.exit(1)
})

Der run-Befehl gibt ein Promise zurück. Es wird aufgelöst, wenn Tests erfolgreich ausgeführt wurden oder fehlgeschlagen sind, und es wird abgelehnt, wenn der Launcher die Tests nicht starten konnte.

@wdio/browser-runner

Wenn Sie Unit- oder Komponententests mit WebdriverIO's Browser-Runner ausführen, können Sie Mocking-Hilfsprogramme für Ihre Tests importieren, z.B.:

import { fn, spyOn, mock, unmock } from '@wdio/browser-runner'

Die folgenden benannten Exports sind verfügbar:

fn

Mock-Funktion, weitere Informationen finden Sie in der offiziellen Vitest-Dokumentation.

spyOn

Spy-Funktion, weitere Informationen finden Sie in der offiziellen Vitest-Dokumentation.

mock

Methode zum Mocken von Dateien oder Abhängigkeitsmodulen.

Paramaters

• moduleName: entweder ein relativer Pfad zur zu mockenden Datei oder ein Modulname.
• factory: Funktion, die den gemockten Wert zurückgibt (optional)

Example

mock('../src/constants.ts', () => ({
    SOME_DEFAULT: 'mocked out'
}))

mock('lodash', (origModuleFactory) => {
    const origModule = await origModuleFactory()
    return {
        ...origModule,
        pick: fn()
    }
})

unmock

Unmockt eine Abhängigkeit, die innerhalb des manuellen Mock-Verzeichnisses (__mocks__) definiert ist.

Paramaters

• moduleName: Name des Moduls, das unmocked werden soll.

Example

unmock('lodash')