Módulos

O WebdriverIO publica vários módulos no NPM e outros registros que você pode usar para construir seu próprio framework de automação. Veja mais documentação sobre os tipos de configuração do WebdriverIO aqui.

webdriver e devtools

Os pacotes de protocolo (webdriver e devtools) expõem uma classe com as seguintes funções estáticas anexadas que permitem iniciar sessões:

newSession(options, modifier, userPrototype, customCommandWrapper)

Inicia uma nova sessão com capacidades específicas. Com base na resposta da sessão, comandos de diferentes protocolos serão fornecidos.

Paramaters

• options: Opções WebDriver
• modifier: função que permite modificar a instância do cliente antes de ser retornada
• userPrototype: objeto de propriedades que permite estender o protótipo da instância
• customCommandWrapper: função que permite envolver funcionalidades em chamadas de função

Returns

• Objeto Browser

Example

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

attachToSession(attachInstance, modifier, userPrototype, customCommandWrapper)

Conecta-se a uma sessão WebDriver ou DevTools em execução.

Paramaters

• attachInstance: instância para conectar uma sessão ou pelo menos um objeto com uma propriedade sessionId (ex: { sessionId: 'xxx' })
• modifier: função que permite modificar a instância do cliente antes de ser retornada
• userPrototype: objeto de propriedades que permite estender o protótipo da instância
• customCommandWrapper: função que permite envolver funcionalidades em chamadas de função

Returns

• Objeto Browser

Example

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

reloadSession(instance)

Recarrega uma sessão dada a instância fornecida.

Paramaters

• instance: instância do pacote para recarregar

Example

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

webdriverio

Assim como os pacotes de protocolo (webdriver e devtools), você também pode usar as APIs do pacote WebdriverIO para gerenciar sessões. As APIs podem ser importadas usando import { remote, attach, multiremote } from 'webdriverio' e contêm as seguintes funcionalidades:

remote(options, modifier)

Inicia uma sessão WebdriverIO. A instância contém todos os comandos como o pacote de protocolo, mas com funções de ordem superior adicionais, veja Documentação da API.

Paramaters

• options: Opções WebdriverIO
• modifier: função que permite modificar a instância do cliente antes de ser retornada

Returns

• Objeto Browser

Example

import { remote } from 'webdriverio'

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

attach(attachOptions)

Conecta-se a uma sessão WebdriverIO em execução.

Paramaters

• attachOptions: instância para conectar uma sessão ou pelo menos um objeto com uma propriedade sessionId (ex: { sessionId: 'xxx' })

Returns

• Objeto Browser

Example

import { remote, attach } from 'webdriverio'

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

multiremote(multiremoteOptions)

Inicia uma instância multiremote que permite controlar várias sessões em uma única instância. Confira nossos exemplos de multiremote para casos de uso concretos.

Paramaters

• multiremoteOptions: um objeto com chaves representando o nome do navegador e suas Opções WebdriverIO.

Returns

• Objeto Browser

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

Em vez de chamar o comando wdio, você também pode incluir o executor de teste como módulo e executá-lo em um ambiente arbitrário. Para isso, você precisará requerer o pacote @wdio/cli como módulo, assim:

EcmaScript Modules

import Launcher from '@wdio/cli'

CommonJS

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

Depois disso, crie uma instância do launcher e execute o teste.

Launcher(configPath, opts)

O construtor da classe Launcher espera a URL para o arquivo de configuração e um objeto opts com configurações que substituirão as do arquivo de configuração.

Paramaters

• configPath: caminho para o wdio.conf.js a ser executado
• opts: argumentos (<RunCommandArguments>) para substituir valores do arquivo de configuração

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

O comando run retorna uma Promise. Ela é resolvida se os testes foram executados com sucesso ou falharam, e é rejeitada se o launcher não conseguiu iniciar os testes.

@wdio/browser-runner

Ao executar testes de unidade ou componentes usando o browser runner do WebdriverIO, você pode importar utilitários de simulação para seus testes, por exemplo:

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

As seguintes exportações nomeadas estão disponíveis:

fn

Função mock, veja mais na documentação oficial do Vitest.

spyOn

Função spy, veja mais na documentação oficial do Vitest.

mock

Método para simular arquivo ou módulo de dependência.

Paramaters

• moduleName: caminho relativo para o arquivo a ser simulado ou um nome de módulo.
• factory: função para retornar o valor simulado (opcional)

Example

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

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

unmock

Desfaz a simulação de dependência que é definida dentro do diretório de simulação manual (__mocks__).

Paramaters

• moduleName: nome do módulo a ser dessimulado.

Example

unmock('lodash')