Anpassade tjänster

Du kan skriva din egen anpassad tjänst för WDIO testrunner för att passa dina behov.

Tjänster är tillägg som skapas för återanvändbar logik för att förenkla tester, hantera din testsvit och integrera resultat. Tjänster har tillgång till alla samma krokar som finns i wdio.conf.js.

Det finns två typer av tjänster som kan definieras: en startartjänst som endast har tillgång till onPrepare, onWorkerStart, onWorkerEnd och onComplete krokarna som endast körs en gång per testkörning, och en arbetartjänst som har tillgång till alla andra krokar och körs för varje arbetare. Observera att du inte kan dela (globala) variabler mellan båda typerna av tjänster eftersom arbetartjänster körs i en annan (arbetar)process.

En startartjänst kan definieras enligt följande:

export default class CustomLauncherService {
    // If a hook returns a promise, WebdriverIO will wait until that promise is resolved to continue.
    async onPrepare(config, capabilities) {
        // TODO: something before all workers launch
    }

    onComplete(exitCode, config, capabilities) {
        // TODO: something after the workers shutdown
    }

    // custom service methods ...
}

Medan en arbetartjänst bör se ut så här:

export default class CustomWorkerService {
    /**
     * `serviceOptions` contains all options specific to the service
     * e.g. if defined as follows:
     *
     * ```
     * services: [['custom', { foo: 'bar' }]]
     * ```
     *
     * the `serviceOptions` parameter will be: `{ foo: 'bar' }`
     */
    constructor (serviceOptions, capabilities, config) {
        this.options = serviceOptions
    }

    /**
     * this browser object is passed in here for the first time
     */
    async before(config, capabilities, browser) {
        this.browser = browser

        // TODO: something before all tests are run, e.g.:
        await this.browser.setWindowSize(1024, 768)
    }

    after(exitCode, config, capabilities) {
        // TODO: something after all tests are run
    }

    beforeTest(test, context) {
        // TODO: something before each Mocha/Jasmine test run
    }

    beforeScenario(test, context) {
        // TODO: something before each Cucumber scenario run
    }

    // other hooks or custom service methods ...
}

Det rekommenderas att lagra browserobjektet genom den parameter som skickas in i konstruktorn. Slutligen exponera båda typerna av arbetare enligt följande:

import CustomLauncherService from './launcher'
import CustomWorkerService from './service'

export default CustomWorkerService
export const launcher = CustomLauncherService

Om du använder TypeScript och vill säkerställa att krokmetodernas parametrar är typsäkra, kan du definiera din tjänstklass så här:

import type { Capabilities, Options, Services } from '@wdio/types'

export default class CustomWorkerService implements Services.ServiceInstance {
    constructor (
        private _options: MyServiceOptions,
        private _capabilities: Capabilities.RemoteCapability,
        private _config: WebdriverIO.Config,
    ) {
        // ...
    }

    // ...
}

Felhantering för tjänster

Ett fel som kastas under en tjänstkrok kommer att loggas medan körlaren fortsätter. Om en krok i din tjänst är kritisk för uppsättningen eller nedmonteringen av testköraren, kan SevereServiceError som exponeras från paketet webdriverio användas för att stoppa körlaren.

import { SevereServiceError } from 'webdriverio'

export default class CustomServiceLauncher {
    async onPrepare(config, capabilities) {
        // TODO: something critical for setup before all workers launch

        throw new SevereServiceError('Something went wrong.')
    }

    // custom service methods ...
}

Importera tjänst från modul

Det enda du nu behöver göra för att använda denna tjänst är att tilldela den till egenskapen services.

Ändra din wdio.conf.js fil så att den ser ut så här:

import CustomService from './service/my.custom.service'

export const config = {
    // ...
    services: [
        /**
         * use imported service class
         */
        [CustomService, {
            someOption: true
        }],
        /**
         * use absolute path to service
         */
        ['/path/to/service.js', {
            someOption: true
        }]
    ],
    // ...
}

Publicera tjänst på NPM

För att göra tjänster lättare att använda och upptäcka av WebdriverIO-gemenskapen, vänligen följ dessa rekommendationer:

• Tjänster bör använda denna namnkonvention: wdio-*-service
• Använd NPM-nyckelord: wdio-plugin, wdio-service
• main-ingången bör export en instans av tjänsten
• Exempel på tjänster: @wdio/sauce-service

Genom att följa det rekommenderade namnmönstret kan tjänster läggas till med namn:

// Add wdio-custom-service
export const config = {
    // ...
    services: ['custom'],
    // ...
}

Lägg till publicerad tjänst till WDIO CLI och dokumentation

Vi uppskattar verkligen varje nytt plugin som kan hjälpa andra människor att köra bättre tester! Om du har skapat ett sådant plugin, överväg att lägga till det i vår CLI och dokumentation för att göra det lättare att hitta.

Vänligen öppna en pull request med följande ändringar:

• lägg till din tjänst i listan över stödda tjänster) i CLI-modulen
• förbättra tjänstlistan för att lägga till din dokumentation på den officiella Webdriver.io-sidan