Instructions for Java and Selenium

Link to Instructions for Java and Selenium copied to clipboard

Configuring your tests with Java and Selenium

Not for use with personal data

Add a new dependency for the Java Watcher package to your pom.xml (for Maven) dependencies section (the Java Watcher package is available on Maven Central):

<dependencies>

<!-- Add this dependency: -->
  <dependency>
     <groupId>com.deque.axe_core</groupId>
     <artifactId>watcher</artifactId>
     <version>3.10.1</version> <!-- Update this as needed -->
  </dependency>

</dependencies>

Add imports for Java Watcher to your testing code:

import com.deque.axe_core.commons.AxeWatcherOptions;
import com.deque.axe_core.selenium.AxeWatcher;
import com.deque.axe_core.selenium.AxeWatcherDriver;

Add setup code for Java Watcher, including your project's API key (obtained from the environment as API_KEY):

AxeWatcherOptions options =
    new AxeWatcherOptions()
        .setApiKey(System.getenv("API_KEY"));
AxeWatcher watcher = new AxeWatcher(options);
ChromeOptions chromeOptions = new ChromeOptions();
chromeOptions = watcher.configure(chromeOptions);
WebDriver wrappedDriver = watcher.wrapDriver(new ChromeDriver(chromeOptions));

This code snippet creates a new WebDriver instance called wrappedDriver that you need to cast to use the axe controller methods.

At the end of your testing session, call flush():
```
((AxeWatcherDriver) wrappedDriver).axeWatcher().flush();
```
Calling flush() indicates that the test run is finished, and the results can be processed and presented to the user.

Instructions for Java and Selenium

Is this page helpful?

Help us improve this page

Try axe® Developer Hub

Still need help?