Passer au contenu principal

L'objet Browser

Comprend : EventEmitter

L'objet "browser" est l'instance de session que vous utilisez pour contrÎler le navigateur ou périphérique mobile. Si vous utilisez l'exécuteur de test WDIO, vous pouvez accéder à l'instance WebDriver via l'objet global browser ou driver ou l'importer à l'aide de @wdio/globals. Si vous utilisez WebdriverIO en mode autonome, l'objet browser est renvoyé par la méthode remote.

La session est initialisĂ©e par l'exĂ©cuteur de test. Il en va de mĂȘme pour la clĂŽture de la session. Cela est Ă©galement fait par le processus d'exĂ©cuteur de test.

Attributs​

Un objet browser possÚde les propriétés suivantes :

NomTypeDĂ©tails
capacitésObjetCapacité assignée par le serveur distant.
Exemple :
{
acceptInsecureCerts: false,
browserName: 'chrome',
browserVersion: '105.0.5195.125',
chrome: {
chromedriverVersion: '105.0.5195.52',
userDataDir: '/var/folders/3_/pzc_f56j15vbd9z3r0j050sh0000gn/T/.com.google.Chrome.76HD3S'
},
'goog:chromeOptions': { debuggerAddress: 'localhost:64679' },
networkConnectionEnabled: false,
pageLoadStrategy: 'normal',
platformName: 'mac os x',
proxy: {},
setWindowRect: true,
strictFileInteractability: false,
timeouts: { implicit: 0, pageLoad: 300000, script: 30000 },
unhandledPromptBehavior: 'dismiss and notify',
'webauthn:extension:credBlob': true,
'webauthn:extension:largeBlob': true,
'webauthn:virtualAuthenticators': true
}
capacités demandéesObjetCapacités demandées au serveur distant.
Exemple :
{ browserName: 'chrome' }
sessionIdStringId de session attribué à partir du serveur distant.
optionsObjectWebdriverIO options selon la façon dont l'objet navigateur a été créé. Voir plus types de configuration.
commandListString[]Une liste de commandes enregistrées dans l'instance du navigateur
isMobileBooleanIndique une session mobile. Voir plus sous Mobile Flags.
isIOSBooleanIndique une session iOS. Voir plus sous Mobile Flags.
isAndroidBooleanIndique une session Android. Voir plus sous Mobile Flags.

MĂ©thodes​

Basé sur le backend d'automatisation utilisé pour votre session, WebdriverIO identifie quelles commandes du protocole seront attachées à l'objet browser. Par exemple, si vous lancez une session automatisée dans Chrome, vous aurez accÚs aux commandes spécifiques à Chromium telles que elementHover mais aucune des commandes Appium.

De plus, WebdriverIO fournit un ensemble de méthodes pratiques qu'il est recommandé d'utiliser pour interagir avec le navigateur ou les éléments sur la page.

En plus de cela, les commandes suivantes sont disponibles :

NomParamĂštresDĂ©tails
addCommand- commandName (Type: String)
- fn (Type: Function)
- attachToElement (Type: boolean)
Permet de dĂ©finir des commandes personnalisĂ©es pouvant ĂȘtre appelĂ©es depuis l'objet browser Ă  des fins de composition. Pour en savoir plus, consultez le guide Commande personnalisĂ©e.
overwriteCommand- commandName (Type: String)
- fn (Type: Function)
- attachToElement (Type: boolean)
Permet d'écraser n'importe quelle commande de navigateur avec des fonctionnalités personnalisées. Utilisez-le avec précaution car cela peut perturber les utilisateurs du framework . Pour en savoir plus, consultez le guide Commande personnalisée.
addLocatorStrategy- strategyName (Type: String)
- fn (Type: Function)
Permet de définir une stratégie de sélection personnalisée, Pour en savoir plus consultez le guide de Sélections.

Remarques​

Drapeaux mobiles​

Si vous devez modifier votre test selon que votre session s'exécute ou non sur un appareil mobile, vous pouvez accéder aux indicateurs mobiles à vérifier.

Par exemple, compte tenu de cette configuration :

// wdio.conf.js
export const config = {
// ...
capabilities: {
platformName: 'iOS',
app: 'net.company.SafariLauncher',
udid: '123123123123abc',
deviceName: 'iPhone',
// ...
}
// ...
}

Vous pouvez accéder à ces drapeaux dans votre test comme suit :

// Note: `driver` is the equivalent to the `browser` object but semantically more correct
// you can choose which global variable you want to use
console.log(driver.isMobile) // outputs: true
console.log(driver.isIOS) // outputs: true
console.log(driver.isAndroid) // outputs: false

Cela peut ĂȘtre utile si, par exemple, vous souhaitez dĂ©finir des sĂ©lecteurs dans vos objets de page en fonction du type d'appareil, comme ceci :

// mypageobject.page.js
import Page from './page'

class LoginPage extends Page {
// ...
get username() {
const selectorAndroid = 'new UiSelector().text("Cancel").className("android.widget.Button")'
const selectorIOS = 'UIATarget.localTarget().frontMostApp().mainWindow().buttons()[0]'
const selectorType = driver.isAndroid ? 'android' : 'ios'
const selector = driver.isAndroid ? selectorAndroid : selectorIOS
return $(`${selectorType}=${selector}`)
}
// ...
}

Vous pouvez également utiliser ces indicateurs pour exécuter uniquement certains tests pour certains types d'appareils :

// mytest.e2e.js
describe('my test', () => {
// ...
// only run test with Android devices
if (driver.isAndroid) {
it('tests something only for Android', () => {
// ...
})
}
// ...
})

ÉvĂ©nements​

L'objet browser est un EventEmitter et quelques événements sont émis pour vos cas d'utilisation.

Voici une liste d'événements. Gardez à l'esprit qu'il ne s'agit pas de la liste complÚte des événements disponibles. N'hésitez pas à contribuer en mettant à jour le document et en ajoutant des descriptions des autres événements ici.

request.performance​

Il s'agit d'un Ă©vĂ©nement pour mesurer les opĂ©rations au niveau WebDriver. Chaque fois que WebdriverIO envoie une requĂȘte au backend WebDriver, cet Ă©vĂ©nement sera Ă©mis avec quelques informations utiles :

  • durationMillisecond: DurĂ©e de la requĂȘte en milliseconde.
  • error: objet d'erreur si la requĂȘte a Ă©chouĂ©.
  • request: Objet de la requĂȘte. Vous pouvez trouver l'Url, la mĂ©thode, les en-tĂȘtes, etc.
  • retryCount: Si c'est 0, la requĂȘte Ă©tait la premiĂšre tentative. Il augmentera lorsque WebDriverIO rĂ©essaiera par la suite.
  • success: BoolĂ©en pour reprĂ©senter si la requĂȘte a Ă©tĂ© rĂ©ussi ou non. Si c'est false, la propriĂ©tĂ© error sera Ă©galement fournie.

Un exemple d'événement :

Object {
"durationMillisecond": 0.01770925521850586,
"error": [Error: Timeout],
"request": Object { ... },
"retryCount": 0,
"success": false,
},

Commandes personnalisĂ©es​

Vous pouvez définir des commandes personnalisées sur la portée du navigateur pour abstraire les workflows qui sont couramment utilisés. Consultez notre guide sur Commandes personnalisées pour plus d'informations.

Welcome! How can I help?

WebdriverIO AI Copilot