Clase AxeWatcher

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

La clase principal para integrar las pruebas de accesibilidad de axe en los conjuntos de pruebas de Selenium Java (use AxeWatcherPlaywright para Playwright)

Not for use with personal data

La clase AxeWatcher es el componente central de la integración de axe Watcher con Selenium Java, que te permite agregar fácilmente pruebas de accesibilidad a tus conjuntos de pruebas de extremo a extremo existentes. Esta clase proporciona métodos para configurar opciones del navegador y envolver instancias de WebDriver para habilitar el análisis de accesibilidad durante las pruebas automatizadas.

Cuando se integra en tu marco de pruebas, axe Watcher:

  • Analiza automáticamente las páginas web en busca de problemas de accesibilidad cuando se ejecutan las pruebas
  • Reanaliza las páginas al detectar cambios en el DOM
  • Vincula los commits de Git a los resultados de accesibilidad
  • Envía los resultados de accesibilidad al Hub del Desarrollador de axe para seguimiento y análisis

Constructor

AxeWatcher(AxeWatcherOptions options)

Crea una nueva instancia de AxeWatcher con las opciones especificadas.

Parámetros:

  • options - Las opciones de configuración para axe Watcher

Ejemplo:

AxeWatcherOptions options = new AxeWatcherOptions()
    .setApiKey("your-api-key-here")
    .setProjectId("your-project-ID-here")
    .setServerUrl("https://axe.deque.com");

AxeWatcher watcher = new AxeWatcher(options);

Métodos

configure(ChromeOptions chromeOptions)

Configura ChromeOptions para habilitar las pruebas de accesibilidad con axe Watcher.

important

Este método debe llamarse antes de crear una instancia de ChromeDriver.

Parámetros:

  • chromeOptions - La instancia existente de ChromeOptions a configurar

Devuelve:

  • Una nueva instancia de ChromeOptions con la configuración de axe Watcher aplicada

Lanza excepción:

  • IllegalArgumentException - Si el modo headless o incógnito está habilitado (axe Watcher no admite estos modos)

Ejemplo:

AxeWatcherOptions options = new AxeWatcherOptions();
options.setApiKey("your-api-key-here");
options.setProjectId("your-project-id-here");
AxeWatcher watcher = new AxeWatcher(options);

ChromeOptions chromeOptions = new ChromeOptions();
// Add any additional Chrome options here
ChromeOptions configuredOptions = watcher.configure(chromeOptions);

// Now create ChromeDriver with the configured options
ChromeDriver driver = new ChromeDriver(configuredOptions);

wrapDriver(ChromeDriver chromeDriver)

Envuelve una instancia de ChromeDriver para habilitar la funcionalidad de pruebas de accesibilidad.

important

Este método debe llamarse después de que configure() haya sido utilizado para configurar el ChromeDriver.

Parámetros:

  • chromeDriver - La instancia de ChromeDriver a envolver

Devuelve:

  • Una instancia de WebDriver envuelta con la funcionalidad de pruebas de accesibilidad habilitada

Lanza excepción:

  • RuntimeException - Si configure() no fue llamado antes de este método

Ejemplo:

AxeWatcherOptions options = new AxeWatcherOptions();
options.setApiKey("your-api-key-here");
options.setProjectId("your-project-id-here");

AxeWatcher watcher = new AxeWatcher(options);

ChromeOptions chromeOptions = watcher.configure(new ChromeOptions());
ChromeDriver chromeDriver = new ChromeDriver(chromeOptions);

// Wrap the ChromeDriver
WebDriver driver = watcher.wrapDriver(chromeDriver);

// Now use the wrapped driver for testing
driver.get("https://example.com");

enableDebugLogger()

Habilita el registro de depuración para las operaciones de axe Watcher. Esto puede ser útil para solucionar problemas durante el desarrollo de pruebas.

Devuelve:

  • La instancia actual de AxeWatcher para encadenamiento de métodos

Ejemplo:

AxeWatcherOptions options = new AxeWatcherOptions();
options.setApiKey("your-api-key-here");
options.setProjectId("your-project-id-here");
AxeWatcher watcher = new AxeWatcher(options).enableDebugLogger();

Notas y Limitaciones

  • axe Watcher no admite el modo completamente headless. Use --headless=new en lugar de --headless si necesita operación en modo headless.
  • axe Watcher no admite el modo incógnito.
  • Debes llamar a configure() antes de crear una instancia de ChromeDriver.
  • Debes llamar a wrapDriver() después de crear la instancia de ChromeDriver.
  • Llama a flush() en el axeWatcher() del controlador envuelto en tu desmantelamiento de pruebas para asegurar que todos los resultados se envían al Hub del Desarrollador de axe.

Véase también