Classe 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 classe principale pour intégrer les tests d'accessibilité axe dans les suites de tests Selenium Java (utiliser AxeWatcherPlaywright pour Playwright)

Not for use with personal data

La classe AxeWatcher est le composant central de l'intégration axe Watcher Selenium Java, qui vous permet d'ajouter facilement des tests d'accessibilité à vos suites de tests de bout en bout existantes. Cette classe fournit des méthodes pour configurer les options de navigateur et encapsuler les instances de WebDriver afin d'activer l'analyse d'accessibilité lors de tests automatisés.

Lorsqu'il est intégré dans votre cadre de test, axe Watcher :

  • Analyse automatiquement les pages web pour détecter les problèmes d'accessibilité lorsque les tests sont exécutés
  • Ré-analyse les pages lors de la détection de changements dans le DOM
  • Liaison des commits Git aux résultats d'accessibilité
  • Envoie les résultats d'accessibilité au axe Developer Hub pour le suivi et l'analyse

Constructeur

AxeWatcher(AxeWatcherOptions options)

Crée une nouvelle instance de AxeWatcher avec les options spécifiées.

Paramètres :

  • options - Les options de configuration pour axe Watcher

Exemple :

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éthodes

configure(ChromeOptions chromeOptions)

Configure ChromeOptions pour activer les tests d'accessibilité avec axe Watcher.

important

Cette méthode doit être appelée avant la création d'une instance de ChromeDriver.

Paramètres :

  • chromeOptions - L'instance existante de ChromeOptions à configurer

Renvoie :

  • Une nouvelle instance de ChromeOptions avec la configuration axe Watcher appliquée

Lève :

  • IllegalArgumentException - Si le mode headless ou incognito est activé (axe Watcher ne supporte pas ces modes)

Exemple :

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)

Encapsule une instance de ChromeDriver pour activer la fonctionnalité de test d'accessibilité.

important

Cette méthode doit être appelée après que configure() a été utilisé pour configurer le ChromeDriver.

Paramètres :

  • chromeDriver - L'instance de ChromeDriver à encapsuler

Renvoie :

  • Une instance de WebDriver encapsulée avec la fonctionnalité de test d'accessibilité activée

Lève :

  • RuntimeException - Si configure() n'a pas été appelée avant cette méthode

Exemple :

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()

Active la journalisation de débogage pour les opérations axe Watcher. Cela peut être utile pour résoudre les problèmes lors du développement des tests.

Renvoie :

  • L'instance actuelle de AxeWatcher pour l'enchaînement des méthodes

Exemple :

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

Notes et Limitations

  • axe Watcher ne supporte pas le mode headless complet. Utilisez --headless=new au lieu de --headless si vous avez besoin du mode headless.
  • axe Watcher ne supporte pas le mode incognito.
  • Vous devez appeler configure() avant de créer une instance de ChromeDriver.
  • Vous devez appeler wrapDriver() après avoir créé l'instance de ChromeDriver.
  • Appelez flush() sur le axeWatcher() du pilote encapsulé lors du démontage de votre test pour vous assurer que tous les résultats sont envoyés à axe Developer Hub.

Voir Aussi