Konfiguracja
W zależności od typu konfiguracji (np. używając surowych bindingów protokołu, WebdriverIO jako samodzielnego pakietu lub testera WDIO) dostępny jest różny zestaw opcji do kontrolowania środowiska.
Opcje WebDriver
Następujące opcje są zdefiniowane podczas korzystania z pakietu protokołu webdriver:
protocol
Protokół używany do komunikacji z serwerem sterownika.
Typ: String
Domyślnie: http
hostname
Host serwera sterownika.
Typ: String
Domyślnie: 0.0.0.0
port
Port, na którym znajduje się serwer sterownika.
Typ: Number
Domyślnie: undefined
path
Ścieżka do punktu końcowego serwera sterownika.
Typ: String
Domyślnie: /
queryParams
Parametry zapytania, które są przekazywane do serwera sterownika.
Typ: Object
Domyślnie: undefined
user
Nazwa użytkownika usługi w chmurze (działa tylko dla kont Sauce Labs, Browserstack, TestingBot lub LambdaTest). Jeśli jest ustawiona, WebdriverIO automatycznie skonfiguruje opcje połączenia za Ciebie. Jeśli nie korzystasz z dostawcy usług w chmurze, możesz użyć tej opcji do uwierzytelnienia dowolnego innego backendu WebDrivera.
Typ: String
Domyślnie: undefined
key
Klucz dostępu lub tajny klucz usługi w chmurze (działa tylko dla kont Sauce Labs, Browserstack, TestingBot lub LambdaTest). Jeśli jest ustawiony, WebdriverIO automatycznie skonfiguruje opcje połączenia za Ciebie. Jeśli nie korzystasz z dostawcy usług w chmurze, możesz użyć tej opcji do uwierzytelnienia dowolnego innego backendu WebDrivera.
Typ: String
Domyślnie: undefined
capabilities
Definiuje możliwości, które chcesz uruchomić w swojej sesji WebDriver. Więcej szczegółów znajdziesz w protokole WebDriver. Jeśli używasz starszego sterownika, który nie obsługuje protokołu WebDriver, musisz użyć możliwości JSONWireProtocol, aby pomyślnie uruchomić sesję.
Oprócz możliwości opartych na WebDriver, możesz zastosować opcje specyficzne dla przeglądarki i dostawcy, które umożliwiają głębszą konfigurację zdalnej przeglądarki lub urządzenia. Są one udokumentowane w odpowiednich dokumentach dostawcy, np.:
goog:chromeOptions: dla Google Chromemoz:firefoxOptions: dla Mozilla Firefoxms:edgeOptions: dla Microsoft Edgesauce:options: dla Sauce Labsbstack:options: dla BrowserStackselenoid:options: dla Selenoid
Dodatkowo, przydatnym narzędziem jest Konfigurator Testów Automatycznych od Sauce Labs, który pomaga utworzyć ten obiekt poprzez kliknięcie i zestawienie pożądanych możliwości.
Typ: Object
Domyślnie: null
Przykład:
{
browserName: 'chrome', // opcje: `chrome`, `edge`, `firefox`, `safari`
browserVersion: '27.0', // wersja przeglądarki
platformName: 'Windows 10' // platforma systemu operacyjnego
}
Jeśli uruchamiasz testy internetowe lub natywne na urządzeniach mobilnych, capabilities różni się od protokołu WebDriver. Więcej szczegółów można znaleźć w dokumentacji Appium.
logLevel
Poziom szczegółowości logowania.
Typ: String
Domyślnie: info
Opcje: trace | debug | info | warn | error | silent
outputDir
Katalog do przechowywania wszystkich plików logów testera (w tym logów reporterów i logów wdio). Jeśli nie jest ustawiony, wszystkie logi są przekazywane do stdout. Ponieważ większość reporterów jest skonfigurowana do logowania do stdout, zaleca się używanie tej opcji tylko dla konkretnych reporterów, gdzie bardziej sensowne jest przesyłanie raportów do pliku (na przykład dla reportera junit).
W trybie samodzielnym jedynym logiem generowanym przez WebdriverIO będzie log wdio.
Typ: String
Domyślnie: null
connectionRetryTimeout
Limit czasu dla dowolnego żądania WebDriver do sterownika lub siatki.
Typ: Number
Domyślnie: 120000
connectionRetryCount
Maksymalna liczba ponownych prób żądania do serwera Selenium.
Typ: Number
Domyślnie: 3
agent
Umożliwia użycie niestandardowego agenta http/https/http2 agent do wykonywania żądań.
Typ: Object
Domyślnie:
{
http: new http.Agent({ keepAlive: true }),
https: new https.Agent({ keepAlive: true })
}
headers
Określ niestandardowe nagłówki do przekazania w każdym żądaniu WebDriver. Jeśli Twoja siatka Selenium wymaga uwierzytelnienia Basic, zalecamy przekazanie nagłówka Authorization przez tę opcję, aby uwierzytelnić żądania WebDrivera, np.:
import { Buffer } from 'buffer';
// Odczytaj nazwę użytkownika i hasło ze zmiennych środowiskowych
const username = process.env.SELENIUM_GRID_USERNAME;
const password = process.env.SELENIUM_GRID_PASSWORD;
// Połącz nazwę użytkownika i hasło separatorem dwukropka
const credentials = `${username}:${password}`;
// Koduj poświadczenia używając Base64
const encodedCredentials = Buffer.from(credentials).toString('base64');
export const config: WebdriverIO.Config = {
// ...
headers: {
Authorization: `Basic ${encodedCredentials}`
}
// ...
}
Typ: Object
Domyślnie: {}
transformRequest
Funkcja przechwytująca opcje żądania HTTP przed wykonaniem żądania WebDriver
Typ: (RequestOptions) => RequestOptions
Domyślnie: brak
transformResponse
Funkcja przechwytująca obiekty odpowiedzi HTTP po nadejściu odpowiedzi WebDriver. Funkcja otrzymuje oryginalny obiekt odpowiedzi jako pierwszy argument i odpowiednie RequestOptions jako drugi argument.
Typ: (Response, RequestOptions) => Response
Domyślnie: brak
strictSSL
Określa, czy wymaga się, aby certyfikat SSL był ważny.
Można ustawić za pomocą zmiennych środowiskowych STRICT_SSL lub strict_ssl.
Typ: Boolean
Domyślnie: true
enableDirectConnect
Czy włączyć funkcję bezpośredniego połączenia Appium. Nie robi nic, jeśli odpowiedź nie zawierała odpowiednich kluczy, gdy flaga jest włączona.
Typ: Boolean
Domyślnie: true
cacheDir
Ścieżka do katalogu głównego pamięci podręcznej. Ten katalog jest używany do przechowywania wszystkich sterowników, które są pobierane podczas próby rozpoczęcia sesji.
Typ: String
Domyślnie: process.env.WEBDRIVER_CACHE_DIR || os.tmpdir()
maskingPatterns
Dla bezpieczniejszego logowania, wyrażenia regularne ustawione za pomocą maskingPatterns mogą zaciemniać poufne informacje w logach.
- Format ciągu to wyrażenie regularne z flagami lub bez nich (np.
/.../i) i oddzielone przecinkami dla wielu wyrażeń regularnych. - Więcej szczegółów na temat masek wzorców znajdziesz w sekcji Maski wzorców w pliku README loggera WDIO.
Typ: String
Domyślnie: undefined
Przykład:
{
maskingPatterns: '/--key=([^ ]*)/i,/RESULT (.*)/'
}
WebdriverIO
Następujące opcje (w tym wymienione powyżej) można wykorzystać z WebdriverIO w trybie samodzielnym:
automationProtocol
Zdefiniuj protokół, którego chcesz użyć do automatyzacji przeglądarki. Obecnie obsługiwany jest tylko webdriver, ponieważ jest to główna technologia automatyzacji przeglądarki, z której korzysta WebdriverIO.
Jeśli chcesz zautomatyzować przeglądarkę za pomocą innej technologii automatyzacji, upewnij się, że ustawiłeś tę właściwość na ścieżkę, która rozwiązuje się do modułu zgodnego z następującym interfejsem:
import type { Capabilities } from '@wdio/types';
import type { Client, AttachOptions } from 'webdriver';
export default class YourAutomationLibrary {
/**
* Uruchom sesję automatyzacji i zwróć WebdriverIO [monad](https://github.com/webdriverio/webdriverio/blob/940cd30939864bdbdacb2e94ee6e8ada9b1cc74c/packages/wdio-utils/src/monad.ts)
* z odpowiednimi poleceniami automatyzacji. Zobacz pakiet [webdriver](https://www.npmjs.com/package/webdriver)
* jako przykładową implementację
*
* @param {Capabilities.RemoteConfig} options Opcje WebdriverIO
* @param {Function} hook który pozwala modyfikować klienta przed zwolnieniem go z funkcji
* @param {PropertyDescriptorMap} userPrototype pozwala użytkownikowi dodawać niestandardowe polecenia protokołu
* @param {Function} customCommandWrapper pozwala modyfikować wykonanie polecenia
* @returns instancję klienta zgodną z WebdriverIO
*/
static newSession(
options: Capabilities.RemoteConfig,
modifier?: (...args: any[]) => any,
userPrototype?: PropertyDescriptorMap,
customCommandWrapper?: (...args: any[]) => any
): Promise<Client>;
/**
* pozwala użytkownikowi dołączyć do istniejących sesji
* @optional
*/
static attachToSession(
options?: AttachOptions,
modifier?: (...args: any[]) => any, userPrototype?: {},
commandWrapper?: (...args: any[]) => any
): Client;
/**
* Zmienia identyfikator sesji instancji i możliwości przeglądarki dla nowej sesji
* bezpośrednio w przekazanym obiekcie przeglądarki
*
* @optional
* @param {object} instance obiekt, który otrzymujemy z nowej sesji przeglądarki.
* @returns {string} nowy identyfikator sesji przeglądarki
*/
static reloadSession(
instance: Client,
newCapabilities?: WebdriverIO.Capabilitie
): Promise<string>;
}
Typ: String
Domyślnie: webdriver
baseUrl
Skróć wywołania polecenia url ustawiając podstawowy URL.
- Jeśli parametr
urlzaczyna się od/, wtedybaseUrljest dodawany na początku (z wyjątkiem ścieżkibaseUrl, jeśli taką posiada). - Jeśli parametr
urlzaczyna się bez schematu lub/(jaksome/path), wtedy pełnybaseUrljest dodawany bezpośrednio na początku.
Typ: String
Domyślnie: null
waitforTimeout
Domyślny limit czasu dla wszystkich poleceń waitFor*. (Uwaga: mała litera f w nazwie opcji.) Ten limit czasu tylko wpływa na polecenia zaczynające się od waitFor* i ich domyślny czas oczekiwania.
Aby zwiększyć limit czasu dla testu, zapoznaj się z dokumentacją frameworka.
Typ: Number
Domyślnie: 5000
waitforInterval
Domyślny interwał dla wszystkich poleceń waitFor* do sprawdzania, czy oczekiwany stan (np. widoczność) został zmieniony.
Typ: Number
Domyślnie: 100
region
Jeśli korzystasz z Sauce Labs, możesz wybrać uruchamianie testów między różnymi centrami danych: US lub EU.
Aby zmienić region na EU, dodaj region: 'eu' do swojej konfiguracji.
Uwaga: Ma to wpływ tylko wtedy, gdy podasz opcje user i key, które są połączone z Twoim kontem Sauce Labs.
Typ: String
Domyślnie: us
(tylko dla vm i/lub em/symulatorów)
Opcje Testera
Następujące opcje (w tym wymienione powyżej) są zdefiniowane tylko dla uruchamiania WebdriverIO z testerem WDIO:
specs
Określa specyfikacje do wykonania testów. Możesz podać wzorzec glob, aby dopasować wiele plików jednocześnie, lub opakować glob czy zestaw ścieżek w tablicę, aby uruchomić je w ramach jednego procesu roboczego. Wszystkie ścieżki są traktowane jako względne w stosunku do ścieżki pliku konfiguracyjnego.
Typ: (String | String[])[]
Domyślnie: []
exclude
Wyklucza specyfikacje z wykonania testów. Wszystkie ścieżki są traktowane jako względne w stosunku do ścieżki pliku konfiguracyjnego.
Typ: String[]
Domyślnie: []
suites
Obiekt opisujący różne zestawy, które można określić za pomocą opcji --suite w CLI wdio.
Typ: Object
Domyślnie: {}
capabilities
Tak samo jak sekcja capabilities opisana powyżej, z opcją określenia obiektu multiremote lub wielu sesji WebDrivera w tablicy do równoległego wykonania.
Możesz zastosować te same możliwości specyficzne dla dostawcy i przeglądarki, jak zdefiniowano powyżej.
Typ: Object|Object[]
Domyślnie: [{ 'wdio:maxInstances': 5, browserName: 'firefox' }]
maxInstances
Maksymalna liczba wszystkich równoległych działających pracowników.
Uwaga: może to być liczba tak wysoka jak 100, gdy testy są wykonywane na maszynach zewnętrznych dostawców, takich jak Sauce Labs. Tam testy nie są testowane na pojedynczej maszynie, ale na wielu maszynach wirtualnych. Jeśli testy mają być uruchamiane na lokalnej maszynie deweloperskiej, użyj bardziej rozsądnej liczby, takiej jak 3, 4 lub 5. W istocie jest to liczba przeglądarek, które będą jednocześnie uruchamiane i wykonywać Twoje testy w tym samym czasie, więc zależy to od ilości pamięci RAM w Twojej maszynie i ilości innych aplikacji uruchomionych na Twojej maszynie.
Możesz również zastosować maxInstances w obiektach capability za pomocą capability wdio:maxInstances. Ograniczy to liczbę równoległych sesji dla tej konkretnej możliwości.
Typ: Number
Domyślnie: 100
maxInstancesPerCapability
Maksymalna liczba wszystkich równoległych działających pracowników na capability.
Typ: Number
Domyślnie: 100
injectGlobals
Wstawia globalne zmienne WebdriverIO (np. browser, $ i $$) do globalnego środowiska.
Jeśli ustawisz na false, powinieneś zaimportować z @wdio/globals, np.:
import { browser, $, $$, expect } from '@wdio/globals'
Uwaga: WebdriverIO nie obsługuje wstrzykiwania globalnych zmiennych specyficznych dla frameworka testowego.
Typ: Boolean
Domyślnie: true
bail
Jeśli chcesz, aby uruchomienie testu zatrzymało się po określonej liczbie niepowodzeń testów, użyj bail.
(Domyślnie jest to 0, co oznacza wykonanie wszystkich testów bez względu na wyniki.) Uwaga: Test w tym kontekście to wszystkie testy w pojedynczym pliku spec (podczas korzystania z Mocha lub Jasmine) lub wszystkie kroki w pliku funkcji (podczas korzystania z Cucumber). Jeśli chcesz kontrolować zachowanie zatrzymywania wewnątrz testów w pojedynczym pliku testowym, zapoznaj się z dostępnymi opcjami framework.
Typ: Number
Domyślnie: 0 (nie zatrzymuj; uruchom wszystkie testy)
specFileRetries
Liczba ponownych prób całego pliku specyfikacji, gdy nie powiedzie się jako całość.
Typ: Number
Domyślnie: 0
specFileRetriesDelay
Opóźnienie w sekundach między próbami ponownego uruchomienia pliku specyfikacji
Typ: Number
Domyślnie: 0
specFileRetriesDeferred
Czy ponownie próbować uruchomić pliki specyfikacji natychmiast, czy odłożyć je na koniec kolejki.
Typ: Boolean
Domyślnie: true
groupLogsByTestSpec
Wybierz widok wyjścia logów.
Jeśli ustawiono na false, logi z różnych plików testowych będą drukowane w czasie rzeczywistym. Należy zauważyć, że może to prowadzić do mieszania się wyjść logów z różnych plików podczas równoległego uruchamiania.
Jeśli ustawiono na true, wyjścia logów będą grupowane według Specyfikacji Testowej i drukowane tylko po zakończeniu danej Specyfikacji Testowej.
Domyślnie jest ustawione na false, więc logi są drukowane w czasie rzeczywistym.
Typ: Boolean
Domyślnie: false