Rough commit of adding axe core to framework (#73)

Co-authored-by: damien-cooke <[email protected]>

Author: stevewalton28

pom.xml

@@ -108,8 +108,8 @@
         <sonar.projectKey>digital-delivery-academy_selenium-pom-example</sonar.projectKey>
         <sonar.organization>digital-delivery-academy</sonar.organization>
         <sonar.host.url>https://sonarcloud.io</sonar.host.url>
+        <axe.core.version>4.1.2</axe.core.version>
     </properties>
-
     <dependencies>
         <dependency>
             <groupId>org.seleniumhq.selenium</groupId>
@@ -207,6 +207,18 @@
             <version>${jetty.version}</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>com.deque.html.axe-core</groupId>
+            <artifactId>selenium</artifactId>
+            <version>${axe.core.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.deque.html.axe-core</groupId>
+            <artifactId>selenium</artifactId>
+            <version>4.1.2</version>
+            <scope>compile</scope>
+        </dependency>
     </dependencies>
 
     <build>

src/main/java/uk/co/evoco/webdriver/AccessibilityBase.java

@@ -0,0 +1,31 @@
+package uk.co.evoco.webdriver;
+
+import com.deque.html.axecore.results.Results;
+import com.deque.html.axecore.results.Rule;
+import com.deque.html.axecore.selenium.AxeBuilder;
+import com.deque.html.axecore.selenium.AxeReporter;
+import org.junit.Assert;
+import org.openqa.selenium.WebDriver;
+import java.io.IOException;
+import java.util.List;
+
+public class AccessibilityBase {
+    private static final String reportPath = System.getProperty("user.dir") + "\\src\\test\\java\\reports\\";
+
+    public static void checkAccessibilityViolations(WebDriver webDriver) throws IOException {
+        String reportFile = reportPath + "accessibilityReport";
+        AxeBuilder builder = new AxeBuilder();
+        Results results = builder.analyze(webDriver);
+        saveReport(results, reportFile);
+    }
+
+    private static void saveReport(Results results, String reportFile) {
+        List<Rule> violations = results.getViolations();
+        if (violations.size() == 0) {
+            Assert.assertTrue("No violations found", true);
+        } else {
+            AxeReporter.writeResultsToJsonFile(reportFile, results);
+            Assert.assertEquals(0, violations.size());
+        }
+    }
+}

src/test/java/uk/co/evoco/webdriver/AccessibilityTest.java

@@ -0,0 +1,56 @@
+package uk.co.evoco.webdriver;
+
+import org.junit.jupiter.api.*;
+import uk.co.evoco.tests.BaseAbstractTest;
+import uk.co.evoco.webdriver.utils.EmbeddedJetty;
+import java.io.File;
+import java.io.IOException;
+import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.MatcherAssert.assertThat;
+
+public class AccessibilityTest extends BaseAbstractTest{
+
+    private static String baseUrl;
+    private static EmbeddedJetty embeddedJetty;
+    private static final String reportPath = System.getProperty("user.dir") + "\\src\\test\\java\\reports\\accessibilityReport.json";
+    private final File accessibilityReport = new File(reportPath);
+
+
+    @BeforeAll
+    public static void webDriverSetup() throws Exception {
+        embeddedJetty = new EmbeddedJetty();
+        embeddedJetty.start();
+        String landingPage = "/index.html";
+        baseUrl = "http://localhost:" + embeddedJetty.getPort() + landingPage;
+    }
+
+    @AfterAll
+    public static void webDriverTearDown() throws Exception {
+        embeddedJetty.stop();
+    }
+
+    @BeforeEach
+    public void setUpWebApp() {
+        webDriver.get(baseUrl);
+    }
+
+    @AfterEach
+    public void deleteReport() {
+        accessibilityReport.delete();
+    }
+
+    @Test
+    public void testPageWithNoAccessibilityViolations() throws IOException {
+        AccessibilityBase.checkAccessibilityViolations(webDriver);
+        assertThat(accessibilityReport.exists(), is(false));
+    }
+
+    //Add assertion to read the json file output to check it has found the violations
+    //Add html page that has accessibility violations
+    @Test
+    public void testPageWithAccessibilityViolations() throws IOException {
+        webDriver.navigate().to(baseUrl + "/accessibilityViolations.html");
+        AccessibilityBase.checkAccessibilityViolations(webDriver);
+        assertThat(accessibilityReport.exists(), is(true));
+    }
+}