Istruzioni per WebDriverJS e TypeScript

Nella cartella principale del tuo ambiente di test, installa il pacchetto @axe-core/watcher e tutte le sue dipendenze utilizzando npm o il tuo gestore di pacchetti preferito (ad esempio, yarn o pnpm).

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

Nel tuo file o nei tuoi file di test, importa la funzione webdriverConfig(), la funzione wrapWebdriver() e la classe WebdriverController da @axe-core/watcher/webdriver:

import {
  webdriverConfig,
  wrapWebdriver,
  WebdriverController
} from '@axe-core/watcher/webdriver'

Aggiorna il codice di configurazione del tuo test (tipicamente in un blocco before o beforeAll), specificando le opzioni Chrome quando istanzi la tua istanza di browser, fornendo la tua chiave API:

// Original code:
const browser = await new Builder()
  .forBrowser('chrome')
  .build()

// Becomes:
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 new Builder()
  .forBrowser('chrome')
  .setChromeOptions(
    webdriverConfig({
      axe: {
        apiKey: ACCESSIBILITY_API_KEY,
        projectId: PROJECT_ID,
        serverURL: SERVER_URL
      }
    }
  )
  .build()

Assicurati di impostare ACCESSIBILITY_API_KEY e PROJECT_ID nel tuo ambiente con la tua chiave API personale (che si trova nel tuo account Axe, scheda **API KEYS**) e l'ID del tuo progetto (mostrato nella parte superiore di queste istruzioni quando hai creato il tuo progetto o disponibile nella pagina Progetti scegliendo **Configura progetto** sotto **Impostazioni**). Se la tua organizzazione utilizza un'istanza regionale, cloud privato o on-premise di Axe Developer Hub, imposta anche SERVER_URL sull'URL di base di tale istanza (per esempio, https://axe-eu.deque.com); altrimenti, ometti SERVER_URL e verrà utilizzato il https://axe.deque.com predefinito.

Crea un'istanza di WebdriverController:

const controller = new WebdriverController(browser)

Avvolgi la tua istanza di browser con la funzione wrapWebdriver():

browser = wrapWebdriver(browser, controller)

Infine, assicurati che tutti i risultati dei test di Axe Watcher siano eliminati. Per fare ciò, aggiungi il seguente blocco di codice al tuo codice di smontaggio dei test (tipicamente in un blocco afterEach):

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