Instalação

O Axe Watcher integra testes de acessibilidade nos seus testes de ponta a ponta existentes. Este guia cobre a instalação para as versões do pacote em JavaScript/TypeScript e Java.

Requisitos do Sistema

Antes de instalar o Axe Watcher, assegure-se de que seu ambiente atende a estes requisitos:

• Suporte a idiomas: Seus testes devem ser escritos em JavaScript, TypeScript ou Java.

• Node.js (somente JavaScript/TypeScript): Use uma versão de Long Term Support (LTS) atualmente mantida do Node.js.

• Java (somente Java): Use uma versão LTS atualmente mantida do Java.

• Versões das plataformas de automação de navegador: O Axe Watcher suporta a versão mais recente ou a versão principal anterior de cada plataforma suportada (exceto para Playwright e Playwright Test, que é a versão menor anterior e posterior).

• Navegador: Watcher usa a versão estável mais recente do Chrome para Testes ou Chromium (com JavaScript/TypeScript ou Java com Playwright, você também pode usar o Microsoft Edge). Note que o navegador Electron embutido do Cypress não é compatível com o Watcher, e você precisará invocar o Cypress com cypress run --browser chrome-for-testing --headless, cypress run --browser chromium --headless, ou cypress run --browser edge --headless.

• Acesso ao registro npm (somente JavaScript/TypeScript): Seu ambiente deve ter permissão para baixar e instalar pacotes do O Registro npm.

• Acesso ao repositório Maven Central (somente Java): Seu ambiente deve ter permissão para baixar e instalar pacotes do Maven Central.

• Repositório Git (opcional, mas recomendado): Usar o Git permite associar resultados de acessibilidade a commits específicos e monitorar o progresso da acessibilidade do seu projeto ao longo do tempo.

Instalação de JavaScript e TypeScript

O pacote @axe-core/watcher está disponível no npm. Instale-o no nível raiz da sua pasta de teste usando o gerenciador de pacotes de sua preferência:

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

Ou com yarn:

yarn add --dev @axe-core/watcher

Ou com pnpm:

pnpm add --save-dev @axe-core/watcher

Plataformas Suportadas

O pacote JavaScript/TypeScript suporta estas plataformas de automação de navegador (versão atual e uma versão principal atrás):

• Cypress (incluindo teste de componentes)
• Playwright (a versão menor anterior e posterior são suportadas)
• Playwright Test (a versão menor anterior e posterior são suportadas)
• Puppeteer
• WebdriverIO
• WebdriverIO Testrunner
• WebDriverJS (Selenium)

Após a instalação, siga as instruções específicas do framework JavaScript ou TypeScript na documentação do Axe Watcher para configurar sua suíte de testes.

Instalação de Java

O pacote Java Watcher está disponível no Maven Central. Adicione a dependência ao seu pom.xml:

<dependencies>
  <dependency>
    <groupId>com.deque.axe_core</groupId>
    <artifactId>watcher</artifactId>
    <version>4.0.0</version>
  </dependency>
</dependencies>

Atualize o número da versão conforme necessário para usar a versão mais recente. Mais informações sobre as versões disponíveis do pacote podem ser encontradas em Maven Central.

Plataformas Suportadas

O pacote Java suporta o Selenium WebDriver (a versão atual e a versão principal anterior).

Próximos Passos

Depois de instalar o pacote, você precisará:

1. Crie um projeto no Axe Developer Hub para obter seu ID de projeto
2. Modifique sua suíte de testes de acordo com as instruções para o seu framework de testes específico
3. Defina seu ACCESSIBILITY_API_KEY e PROJECT_ID como variáveis de ambiente
4. Execute seus testes e veja os resultados no Axe Developer Hub

Para instruções detalhadas de configuração específicas para o seu framework de testes, consulte as páginas de documentação específicas do framework.