Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sridharbandi/java-a11y
Accessibility Automated Testing with Java Selenium
https://github.com/sridharbandi/java-a11y
a11y a11y-testing accessibility accessibility-automation axe deque htmlcodesniffer pa11y selenium selenium-java selenium-webdriver
Last synced: 4 months ago
JSON representation
Accessibility Automated Testing with Java Selenium
- Host: GitHub
- URL: https://github.com/sridharbandi/java-a11y
- Owner: sridharbandi
- License: mit
- Created: 2018-12-05T22:31:30.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-04T18:22:00.000Z (over 1 year ago)
- Last Synced: 2024-09-29T02:05:57.228Z (4 months ago)
- Topics: a11y, a11y-testing, accessibility, accessibility-automation, axe, deque, htmlcodesniffer, pa11y, selenium, selenium-java, selenium-webdriver
- Language: Java
- Homepage: https://sridharbandi.github.io/Java-a11y/
- Size: 1.47 MB
- Stars: 13
- Watchers: 7
- Forks: 12
- Open Issues: 5
-
Metadata Files:
- Readme: ReadMe.md
- License: LICENSE
Awesome Lists containing this project
README
# Java-a11y
## Accessibility Automation for Web Apps with Java and Selenium Webdriver.
>Note If you are using version 2.1.4 and below, refer [readme](/ReadMe_Pre.md)
### This project uses [HTML CodeSniffer](https://squizlabs.github.io/HTML_CodeSniffer/) and [Deque Axe](https://www.deque.com/)
**HTML CodeSniffer** : checks HTML source code and detects any Accessibility violations. Comes with standards that cover the three (A, AA & AAA) conformance levels of the W3C's Web Content Accessibility Guidelines (WCAG) 2.1 and the U.S. Section 508 legislation.
**Deque Axe** : World’s leading digital accessibility toolkit. Powerful and accurate accessibility toolkit can get you to 80% issue coverage, or more, during development.
[](http://search.maven.org/#search|ga|1|g:"io.github.sridharbandi")
[](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
[](https://www.codacy.com/gh/sridharbandi/Java-a11y/dashboard?utm_source=github.com&utm_medium=referral&utm_content=sridharbandi/Java-a11y&utm_campaign=Badge_Grade)
[](https://www.codacy.com/gh/sridharbandi/Java-a11y/dashboard?utm_source=github.com&utm_medium=referral&utm_content=sridharbandi/Java-a11y&utm_campaign=Badge_Coverage)
[](https://opensource.org/licenses/MIT)
[](https://github.com/sridharbandi/Java-a11y/graphs/contributors)
### Features
1. Simple & Easy to use
2. No need of prior knowledge on Accessibility
3. Works with Java Selenium [Webdriver](https://www.selenium.dev/projects/)
4. Rich Reporting
5. Open source
### Usage
For maven based project add the below dependency
```xml
io.github.sridharbandi
java-a11y
3.0.4
```
For gradle based project add the below dependency
```
compile 'io.github.sridharbandi:java-a11y:3.0.4'
```
For non gradle/maven project download the jar from below mentioned link and add it to CLASSPATH for your project
[https://github.com/sridharbandi/Java-a11y/releases](https://github.com/sridharbandi/Java-a11y/releases)
### Getting Started
#### Using HTML CodeSniffer
Create object of `HtmlCsRunner` as below. `driver` will be your WebDriver instance.
```java
HtmlCsRunner htmlCsRunner = new HtmlCsRunner(driver);;
```
Once after you navigated to any page/popup with Selenium Webdriver execute Accessibility on that particular page/popup
```java
htmlCsRunner.execute();
```
The above `execute` will also generate `JSON Report` on accessibility issues at page/popup level
Once after all the tests executed, you can call the below method to generate consolidated `HTML Report` on accessibility issues
```java
htmlCsRunner.generateHtmlReport();
```
Below is junit example with reporting.
```java
import freemarker.template.TemplateException;
import io.github.bonigarcia.wdm.ChromeDriverManager;
import io.github.sridharbandi.HtmlCsRunner;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;
import java.io.IOException;
import java.net.URISyntaxException;
import java.time.Duration;
/**
* A sample test to demonstrate
*/
public class Example {
private WebDriver driver;
private static HtmlCsRunner htmlCsRunner;
@BeforeEach
public void beforeTest() {
ChromeDriverManager.chromedriver().setup();
driver = new ChromeDriver();
driver.manage().timeouts().pageLoadTimeout(Duration.ofSeconds(60));
driver.manage().window().fullscreen();
htmlCsRunner = new HtmlCsRunner(driver);
}
@AfterEach
public void tearDown() throws IOException {
htmlCsRunner.execute();
driver.quit();
}
@AfterAll
public static void generateReport() throws IOException {
htmlCsRunner.generateHtmlReport();
}
@Test
public void googleTest() {
driver.get("https://www.google.com/");
}
@Test
public void stockTest() {
driver.get("https://www.istockphoto.com/");
}
}
```
By default, it will check against `WCAG2AA` standards. However, you can configure it to standard you want to test with
```java
htmlCsRunner.setStandard(HTMLCS.WCAG2A);
```
HTML Reports will be generated under `./target/java-a11y/htmlcs` folder.
Below are the report screenshots
Consolidated Report
Page Report
#### Using Deque Axe
Create object of `AxeRunner` as below. `driver` will be your WebDriver instance.
```java
AxeRunner axeRunner = new AxeRunner(driver);
```
Once after you navigated to any page/popup with Selenium Webdriver execute Accessibility on that particular page/popup
```java
axeRunner.execute();
```
The above `execute` will also generate `JSON Report` on accessibility issues at page/popup level
Once after all the tests executed, you can call the below method to generate consolidated `HTML Report` on accessibility issues
```java
axeRunner.generateHtmlReport();
```
Below is junit example with reporting.
```java
import freemarker.template.TemplateException;
import io.github.bonigarcia.wdm.ChromeDriverManager;
import io.github.sridharbandi.AxeRunner;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;
import java.io.IOException;
import java.net.URISyntaxException;
import java.time.Duration;
/**
* A sample test to demonstrate
*/
public class Example {
private WebDriver driver;
private static AxeRunner axeRunner;
@BeforeEach
public void beforeTest() {
ChromeDriverManager.chromedriver().setup();
driver = new ChromeDriver();
driver.manage().timeouts().pageLoadTimeout(Duration.ofSeconds(60));
driver.manage().window().fullscreen();
axeRunner = new AxeRunner(driver);
}
@AfterEach
public void tearDown() throws IOException {
axeRunner.execute();
driver.quit();
}
@AfterAll
public static void generateReport() throws IOException {
axeRunner.generateHtmlReport();
}
@Test
public void googleTest() {
driver.get("https://www.google.com/");
}
@Test
public void stockTest() {
driver.get("https://www.istockphoto.com/");
}
}
```
By default, it will check against `WCAG2AA` and `section508` tags. However, you can configure it to tag you want to test with
```java
axeRunner.setTags(AxeTag.WCAG21AA);
```
Or multiple tags using varargs syntax
```java
axeRunner.setTags(AxeTag.WCAG21A, AxeTag.BEST_PRACTICE);
```
Each [Tag](https://www.deque.com/axe/core-documentation/api-documentation/#axe-core-tags) has set of [Rules](https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md) and you can enable/disable particular rule as needed
```java
axeRunner.disableRules("link-name", "aria-allowed-role")
.enableRules("autocomplete-valid", "region")
```
HTML Reports will be generated under `./target/java-a11y/axe` folder.
Below are the report screenshots
Consolidated Report
Page Report
