Instructions pour WebdriverIO et TypeScript

Au niveau racine de votre dossier de test, installez le package @axe-core/watcher et toutes ses dépendances en utilisant npm ou votre gestionnaire de packages préféré (par exemple, yarn ou pnpm).

npm install --save-dev @axe-core/watcher

Dans vos fichiers de test, importez la fonction wdioConfig(), la fonction wrapWdio() et la classe WdioController depuis @axe-core/watcher/wdio :

import {
  wdioConfig,
  wrapWdio,
  WdioController
} from '@axe-core/watcher/wdio'

Dans votre code de configuration de test (généralement dans un bloc before ou beforeAll), enveloppez tout code existant pour créer une instance browser avec un appel à wdioConfig(), en fournissant votre clé API :

const ACCESSIBILITY_API_KEY = process.env.ACCESSIBILITY_API_KEY
const PROJECT_ID = process.env.PROJECT_ID
const SERVER_URL = process.env.SERVER_URL

const browser = await remote(
  wdioConfig({
    axe: {
      apiKey: ACCESSIBILITY_API_KEY,
      projectId: PROJECT_ID,
      serverURL: SERVER_URL
    }
  })
)

Assurez-vous de définir ACCESSIBILITY_API_KEY et PROJECT_ID dans votre environnement sur votre clé API personnelle (disponible dans votre compte Axe, onglet **CLÉS API**) et votre ID de projet (indiqué en haut de ces instructions lorsque vous avez créé votre projet ou disponible à partir de la page Projets en choisissant **Configurer le projet** sous **Paramètres**). Si votre organisation utilise une instance Axe Developer Hub régionale, cloud privé ou sur site, définissez également SERVER_URL sur l'URL de base de cette instance (par exemple, https://axe-eu.deque.com) ; sinon, omettez SERVER_URL et la valeur par défaut https://axe.deque.com sera utilisée.

Une fois que vous avez une instance browser, créez une instance de la classe WdioController :

const controller = new WdioController(browser);

Enveloppez votre instance browser avec la fonction wrapWdio(), en fournissant l'instance browser et l'instance controller :

wrapWdio(browser, controller)

Enfin, assurez-vous que tous les résultats de test d'Axe Watcher sont bien effectués. Pour ce faire, ajoutez le bloc de code suivant à votre code de désinstallation de test (généralement dans un bloc afterEach) :

afterEach(async () => {
  await controller.flush()
})