Förmågor
En förmåga (capability) är en definition för ett fjärrgränssnitt. Det hjälper WebdriverIO att förstå i vilken webbläsare eller mobil miljö du vill köra dina tester på. Förmågor är mindre avgörande när du utvecklar tester lokalt eftersom du oftast kör det på ett fjärrgränssnitt, men blir viktigare när du kör en stor uppsättning integrationstester i CI/CD.
Formatet för ett förmågaobjekt är väl definierat av WebDriver-specifikationen. WebdriverIO-testrunner kommer att misslyckas tidigt om användardefinierade förmågor inte följer den specifikationen.
Anpassade förmågor
Medan antalet fast definierade förmågor är mycket lågt, kan alla tillhandahålla och acceptera anpassade förmågor som är specifika för automationsdrivrutinen eller fjärrgränssnittet:
Webbläsarspecifika förmågotillägg
goog:chromeOptions
: Chromedriver tillägg, endast tillämpligt för testning i Chromemoz:firefoxOptions
: Geckodriver tillägg, endast tillämpligt för testning i Firefoxms:edgeOptions
: EdgeOptions för att specificera miljön när du använder EdgeDriver för att testa Chromium Edge
Molnleverantörers förmågotillägg
sauce:options
: Sauce Labsbstack:options
: BrowserStacktb:options
: TestingBot- och många fler...
Automationsmotor förmågotillägg
WebdriverIO förmågor för att hantera webbläsardrivrutinsalternativ
WebdriverIO hanterar installation och körning av webbläsardrivrutiner för dig. WebdriverIO använder en anpassad förmåga som låter dig skicka in parametrar till drivrutinen.
wdio:chromedriverOptions
Specifika alternativ som skickas till Chromedriver vid start.
wdio:geckodriverOptions
Specifika alternativ som skickas till Geckodriver vid start.
wdio:edgedriverOptions
Specifika alternativ som skickas till Edgedriver vid start.
wdio:safaridriverOptions
Specifika alternativ som skickas till Safari vid start.
wdio:maxInstances
Maximalt antal parallellt körande arbetare för den specifika webbläsaren/förmågan. Har företräde framför maxInstances och maxInstancesPerCapability.
Typ: number
wdio:specs
Definiera specifikationer för testkörning för den webbläsaren/förmågan. Samma som det vanliga specs
-konfigurationsalternativet, men specifikt för webbläsaren/förmågan. Har företräde framför specs
.
Typ: (String | String[])[]
wdio:exclude
Exkludera specifikationer från testkörning för den webbläsaren/förmågan. Samma som det vanliga exclude
-konfigurationsalternativet, men specifikt för webbläsaren/förmågan. Har företräde framför exclude
.
Typ: String[]
wdio:enforceWebDriverClassic
Som standard försöker WebdriverIO upprätta en WebDriver Bidi-session. Om du inte föredrar det kan du ställa in denna flagga för att inaktivera detta beteende.
Typ: boolean
Gemensamma drivrutinsalternativ
Medan alla drivrutiner erbjuder olika parametrar för konfiguration, finns det några gemensamma som WebdriverIO förstår och använder för att konfigurera din drivrutin eller webbläsare:
cacheDir
Sökvägen till roten av cachekatalogen. Denna katalog används för att lagra alla drivrutiner som laddas ner när du försöker starta en session.
Typ: string
Standard: process.env.WEBDRIVER_CACHE_DIR || os.tmpdir()
binary
Sökväg till en anpassad drivrutinsbinär. Om angiven kommer WebdriverIO inte att försöka ladda ner en drivrutin utan kommer att använda den som anges via denna sökväg. Se till att drivrutinen är kompatibel med webbläsaren du använder.
Du kan ange denna sökväg via miljövariablerna CHROMEDRIVER_PATH
, GECKODRIVER_PATH
eller EDGEDRIVER_PATH
.
Typ: string
Om drivrutinens binary
är inställd, kommer WebdriverIO inte att försöka ladda ner en drivrutin utan kommer att använda den som anges via denna sökväg. Se till att drivrutinen är kompatibel med webbläsaren du använder.
Webbläsarspecifika drivrutinsalternativ
För att skicka alternativ till drivrutinen kan du använda följande anpassade förmågor:
- Chrome eller Chromium:
wdio:chromedriverOptions
- Firefox:
wdio:geckodriverOptions
- Microsoft Edge:
wdio:edgedriverOptions
- Safari:
wdio:safaridriverOptions
- wdio:chromedriverOptions
- wdio:geckodriverOptions
- wdio:edgedriverOptions
- wdio:safaridriverOptions
adbPort
Porten på vilken ADB-drivrutinen ska köras.
Exempel: 9515
Typ: number
urlBase
Bas-URL-sökvägsprefix för kommandon, t.ex. wd/url
.
Exempel: /
Typ: string
logPath
Skriv serverloggen till fil istället för stderr, ökar loggnivån till INFO
Typ: string
logLevel
Ställ in loggnivå. Möjliga alternativ ALL
, DEBUG
, INFO
, WARNING
, SEVERE
, OFF
.
Typ: string
verbose
Logga detaljerat (motsvarar --log-level=ALL
)
Typ: boolean
silent
Logga ingenting (motsvarar --log-level=OFF
)
Typ: boolean
appendLog
Lägg till i loggfil istället för att skriva över.
Typ: boolean
replayable
Logga detaljerat och trunkera inte långa strängar så att loggen kan spelas upp igen (experimentell).
Typ: boolean
readableTimestamp
Lägg till läsbara tidsstämplar i loggen.
Typ: boolean
enableChromeLogs
Visa loggar från webbläsaren (åsidosätter andra loggningsalternativ).
Typ: boolean
bidiMapperPath
Anpassad bidi mapper-sökväg.
Typ: string
allowedIps
Kommaseparerad lista med tillåtna fjärr-IP-adresser som får ansluta till EdgeDriver.
Typ: string[]
Standard: ['']
allowedOrigins
Kommaseparerad lista med tillåtna förfrågningsursprung som får ansluta till EdgeDriver. Att använda *
för att tillåta vilket värdusprung som helst är farligt!
Typ: string[]
Standard: ['*']
spawnOpts
Alternativ som ska skickas till drivrutinsprocessen.
Typ: SpawnOptionsWithoutStdio | SpawnOptionsWithStdioTuple<StdioOption, StdioOption, StdioOption>
Standard: undefined
Se alla Geckodriver-alternativ i det officiella drivrutinspaketet.
Se alla Edgedriver-alternativ i det officiella drivrutinspaketet.
Se alla Safaridriver-alternativ i det officiella drivrutinspaketet.
Speciella förmågor för specifika användningsfall
Detta är en lista med exempel som visar vilka förmågor som behöver tillämpas för att uppnå ett visst användningsfall.
Kör webbläsare i Headless-läge
Att köra en webbläsare i headless-läge innebär att köra en webbläsarinstans utan fönster eller UI. Detta används oftast inom CI/CD-miljöer där ingen display används. För att köra en webbläsare i headless-läge, tillämpa följande förmågor:
- Chrome
- Firefox
- Microsoft Edge
- Safari
{
browserName: 'chrome', // eller 'chromium'
'goog:chromeOptions': {
args: ['headless', 'disable-gpu']
}
}
browserName: 'firefox',
'moz:firefoxOptions': {
args: ['-headless']
}
browserName: 'msedge',
'ms:edgeOptions': {
args: ['--headless']
}
Det verkar som att Safari inte stöder körning i headless-läge.
Automatisera olika webbläsarkanaler
Om du vill testa en webbläsarversion som ännu inte har släppts som stabil, t.ex. Chrome Canary, kan du göra det genom att ställa in förmågor och peka på den webbläsare du vill starta, t.ex.:
- Chrome
- Firefox
- Microsoft Edge
- Safari
När du testar på Chrome kommer WebdriverIO automatiskt att ladda ner önskad webbläsarversion och drivrutin baserat på den definierade browserVersion
, t.ex.:
{
browserName: 'chrome', // eller 'chromium'
browserVersion: '116' // eller '116.0.5845.96', 'stable', 'dev', 'canary', 'beta' eller 'latest' (samma som 'canary')
}
Om du vill testa en manuellt nedladdad webbläsare kan du ange en binär sökväg till webbläsaren via:
{
browserName: 'chrome', // eller 'chromium'
'goog:chromeOptions': {
binary: '/Applications/Google\ Chrome\ Canary.app/Contents/MacOS/Google\ Chrome\ Canary'
}
}
Dessutom, om du vill använda en manuellt nedladdad drivrutin, kan du ange en binär sökväg till drivrutinen via:
{
browserName: 'chrome', // eller 'chromium'
'wdio:chromedriverOptions': {
binary: '/path/to/chromdriver'
}
}
När du testar på Firefox kommer WebdriverIO automatiskt att ladda ner önskad webbläsarversion och drivrutin baserat på den definierade browserVersion
, t.ex.:
{
browserName: 'firefox',
browserVersion: '119.0a1' // eller 'latest'
}
Om du vill testa en manuellt nedladdad version kan du ange en binär sökväg till webbläsaren via:
{
browserName: 'firefox',
'moz:firefoxOptions': {
binary: '/Applications/Firefox\ Nightly.app/Contents/MacOS/firefox'
}
}
Dessutom, om du vill använda en manuellt nedladdad drivrutin, kan du ange en binär sökväg till drivrutinen via:
{
browserName: 'firefox',
'wdio:geckodriverOptions': {
binary: '/path/to/geckodriver'
}
}
När du testar på Microsoft Edge, se till att du har den önskade webbläsarversionen installerad på din maskin. Du kan peka WebdriverIO till webbläsaren som ska köras via:
{
browserName: 'msedge',
'ms:edgeOptions': {
binary: '/Applications/Microsoft\ Edge\ Canary.app/Contents/MacOS/Microsoft\ Edge\ Canary'
}
}
WebdriverIO kommer automatiskt att ladda ner önskad drivrutinsversion baserat på den definierade browserVersion
, t.ex.:
{
browserName: 'msedge',
browserVersion: '109' // eller '109.0.1467.0', 'stable', 'dev', 'canary', 'beta'
}
Dessutom, om du vill använda en manuellt nedladdad drivrutin, kan du ange en binär sökväg till drivrutinen via:
{
browserName: 'msedge',
'wdio:edgedriverOptions': {
binary: '/path/to/msedgedriver'
}
}
När du testar på Safari, se till att du har Safari Technology Preview installerat på din maskin. Du kan peka WebdriverIO till den versionen via:
{
browserName: 'safari technology preview'
}
Utöka anpassade förmågor
Om du vill definiera din egen uppsättning förmågor för att t.ex. lagra godtycklig data som ska användas i testerna för den specifika förmågan, kan du göra det genom att t.ex. ställa in:
export const config = {
// ...
capabilities: [{
browserName: 'chrome',
'custom:caps': {
// anpassade konfigurationer
}
}]
}
Det rekommenderas att följa W3C-protokollet när det gäller namngivning av förmågor, vilket kräver ett :
(kolon)-tecken som betecknar ett implementationsspecifikt namnområde. I dina tester kan du komma åt din anpassade förmåga genom, t.ex.:
browser.capabilities['custom:caps']
För att säkerställa typsäkerhet kan du utöka WebdriverIOs förmågagränssnitt via:
declare global {
namespace WebdriverIO {
interface Capabilities {
'custom:caps': {
// ...
}
}
}
}