Merge pull request #24 from sridharbandi/feature/page_stats

Return Page Stats and custom page title

Author: sridharbandi

ReadMe.md

@@ -29,12 +29,12 @@ For maven based project add the below dependency
 <dependency>
   <groupId>io.github.sridharbandi</groupId>
   <artifactId>java-a11y</artifactId>
-  <version>3.0.1</version>
+  <version>3.0.2</version>
 </dependency>
 ```
 For gradle based project add the below dependency
 ```
-compile 'io.github.sridharbandi:java-a11y:3.0.1'
+compile 'io.github.sridharbandi:java-a11y:3.0.2'
 ```
 For non gradle/maven project download the jar from below mentioned link and add it to CLASSPATH for your project
 
@@ -95,7 +95,7 @@ public class Example {
     }
 
     @AfterEach
-    public void tearDown() throws TemplateException, IOException, URISyntaxException {
+    public void tearDown() throws IOException {
         htmlCsRunner.execute();
         driver.quit();
     }
@@ -188,7 +188,7 @@ public class Example {
     }
 
     @AfterEach
-    public void tearDown() throws TemplateException, IOException, URISyntaxException {
+    public void tearDown() throws IOException {
         axeRunner.execute();
         driver.quit();
     }

pom.xml

@@ -5,7 +5,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>io.github.sridharbandi</groupId>
     <artifactId>java-a11y</artifactId>
-    <version>3.0.1</version>
+    <version>3.0.2</version>
 
     <name>Java a11y</name>
     <description>Accessibility Automation for Web Apps with Java and Selenium Webdriver</description>

src/main/java/io/github/sridharbandi/AxeRunner.java

@@ -1,25 +1,30 @@
 package io.github.sridharbandi;
 
-import freemarker.template.TemplateException;
 import io.github.sridharbandi.a11y.Engine;
 import io.github.sridharbandi.modal.axe.Issues;
+import io.github.sridharbandi.modal.htmlcs.Params;
 import io.github.sridharbandi.util.A11y;
 import org.openqa.selenium.WebDriver;
 
 import java.io.IOException;
-import java.net.URISyntaxException;
 
 public class AxeRunner implements IRunner {
 
     private A11y a11y;
+    private Params params;
 
     public AxeRunner(WebDriver driver) {
         a11y = new A11y(driver);
+        params = new Params();
     }
 
+    public AxeRunner setPageTile(String pageTitle) {
+        params.setPageTitle(pageTitle);
+        return this;
+    }
     @Override
-    public void execute() throws IOException, URISyntaxException, TemplateException {
-        a11y.execute(Engine.AXE, null);
+    public Issues execute() throws IOException {
+        return (Issues) a11y.execute(Engine.AXE, params);
     }
 
 

src/main/java/io/github/sridharbandi/HtmlCsRunner.java

@@ -1,6 +1,5 @@
 package io.github.sridharbandi;
 
-import freemarker.template.TemplateException;
 import io.github.sridharbandi.a11y.Engine;
 import io.github.sridharbandi.a11y.HTMLCS;
 import io.github.sridharbandi.modal.htmlcs.Issues;
@@ -9,7 +8,6 @@
 import org.openqa.selenium.WebDriver;
 
 import java.io.IOException;
-import java.net.URISyntaxException;
 import java.util.Objects;
 
 public class HtmlCsRunner implements IRunner {
@@ -24,21 +22,27 @@ public HtmlCsRunner(WebDriver driver) {
         params = new Params();
     }
 
-    public void setStandard(HTMLCS standard) {
+    public HtmlCsRunner setStandard(HTMLCS standard) {
         this.standard = standard;
+        return this;
     }
 
-    public void setIgnoreCodes(String[] codes){
+    public HtmlCsRunner setIgnoreCodes(String[] codes) {
         this.codes = codes;
+        return this;
     }
 
+    public HtmlCsRunner setPageTile(String pageTitle) {
+        params.setPageTitle(pageTitle);
+        return this;
+    }
 
     @Override
-    public void execute() throws IOException, URISyntaxException, TemplateException {
+    public Issues execute() throws IOException {
         String stdrd = Objects.isNull(standard) ? HTMLCS.WCAG2AA.name() : standard.name();
         params.setStandard(stdrd);
         params.setIgnoreCodes(codes);
-        a11y.execute(Engine.HTMLCS, params);
+        return (Issues) a11y.execute(Engine.HTMLCS, params);
     }
 
     public void generateHtmlReport() throws IOException {

src/main/java/io/github/sridharbandi/IRunner.java

@@ -14,7 +14,7 @@
 import java.util.Map;
 
 public interface IRunner {
-    void execute() throws IOException, URISyntaxException, TemplateException;
+    Object execute() throws IOException;
 
     default void generateHtmlReport(A11y a11y, Engine engine, Class<?> clazz) throws IOException {
         Template tmplIndex = FtlConfig.getInstance().getTemplate(engine.name().toLowerCase() + "/index.ftl");

src/main/java/io/github/sridharbandi/ftl/FtlConfig.java

@@ -23,7 +23,7 @@ public FtlConfig() {
         cfg.setClassLoaderForTemplateLoading(this.getClass().getClassLoader(), TEMPLATE_DIR);
         cfg.setDefaultEncoding(ENCODING);
         cfg.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);
-        cfg.setSharedVariable("random", new BeansWrapperBuilder(Configuration.VERSION_2_3_30).build().getStaticModels());
+        cfg.setSharedVariable("random", new BeansWrapperBuilder(Configuration.VERSION_2_3_31).build().getStaticModels());
         cfg.setLogTemplateExceptions(false);
         cfg.setWrapUncheckedExceptions(true);
         cfg.setFallbackOnNullLoopVariable(false);

src/main/java/io/github/sridharbandi/modal/htmlcs/Params.java

@@ -4,6 +4,7 @@ public class Params {
 
     String standard;
     String[] ignoreCodes;
+    String pageTitle;
 
     public String getStandard() {
         return standard;
@@ -20,4 +21,12 @@ public String[] getIgnoreCodes() {
     public void setIgnoreCodes(String[] ignoreCodes) {
         this.ignoreCodes = ignoreCodes;
     }
+
+    public String getPageTitle() {
+        return pageTitle;
+    }
+
+    public void setPageTitle(String pageTitle) {
+        this.pageTitle = pageTitle;
+    }
 }

src/main/java/io/github/sridharbandi/util/A11y.java

@@ -4,6 +4,7 @@
 import freemarker.template.Template;
 import freemarker.template.TemplateException;
 import io.github.sridharbandi.a11y.Engine;
+import io.github.sridharbandi.modal.htmlcs.Issues;
 import io.github.sridharbandi.modal.htmlcs.Params;
 import org.apache.commons.io.FilenameUtils;
 import org.apache.commons.io.IOUtils;
@@ -41,22 +42,20 @@ public A11y(WebDriver driver) {
     public A11y() {
     }
 
-    public void execute(Engine engine, Params params) throws URISyntaxException, IOException, TemplateException {
+    public Object execute(Engine engine, Params params) throws IOException {
         waitForLoad();
         InputStream in = this.getClass().getClassLoader().getResourceAsStream("js/" + engine.toString().toLowerCase() + ".js");
         String js = IOUtils.toString(in, StandardCharsets.UTF_8);
-        String strJson = "";
-        if (engine.name().equals(Engine.HTMLCS.name())) {
-            ObjectMapper mapper = new ObjectMapper();
-            strJson = mapper.writeValueAsString(params);
-        }
-        String script = engine.name().equalsIgnoreCase("axe") ? "return axeData();" + js : "return getData('" + strJson + "');" + js;
+        ObjectMapper mapper = new ObjectMapper();
+        String strJson = mapper.writeValueAsString(params);
+        String script = engine.name().equalsIgnoreCase("axe") ? "return axeData('" + strJson + "');" + js : "return getData('" + strJson + "');" + js;
         Object issues = javascriptExecutor.executeScript(script);
-        ObjectMapper objectMapper = new ObjectMapper();
-        String strResponse = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(issues);
+        String strResponse = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(issues);
         Path path = get("./target/java-a11y/" + engine.toString().toLowerCase() + "/json/" + UUID.randomUUID() + ".json");
         createDirectories(path.getParent());
         write(path, strResponse.getBytes(StandardCharsets.UTF_8));
+        Class<?> clazz = engine.name().equalsIgnoreCase("axe") ? io.github.sridharbandi.modal.axe.Issues.class : Issues.class;
+        return mapper.readValue(strResponse, clazz);
     }
 
     private void waitForLoad() {

src/main/resources/js/axe.js

@@ -1,8 +1,9 @@
-async function axeData() {
+async function axeData(params) {
+    const obj = JSON.parse(params);
     await injectAxeScript();
     var results = await runAxe()
     results.id = 'id_' + (Date.now().toString(36) + Math.random().toString(36).substr(2, 5));
-    results.title = document.title;
+    results.title = obj.pageTitle == null ? document.title : obj.pageTitle;
     results.dimension = window.innerWidth + ' X ' + window.innerHeight;
     results.device = device();
     results.browser = getBrowser();

src/main/resources/js/htmlcs.js

@@ -4,6 +4,7 @@ async function getData(params) {
 
     await injectScript();
     const results = await runHtmlCS(obj.standard, codes);
+    const pageTitle = obj.pageTitle == null ? document.title : obj.pageTitle;
     return {
         errors: resultsCount(results, 1),
         warnings: resultsCount(results, 2),
@@ -12,7 +13,7 @@ async function getData(params) {
         date: getFormattedDate(),
         dimension: window.innerWidth + ' X ' + window.innerHeight,
         url: window.location.href,
-        title: document.title,
+        title: pageTitle,
         device: device(),
         browser: getBrowser(),
         results: results,

src/test/java/io/github/sridharbandi/AxeRunnerTest.java

@@ -1,6 +1,7 @@
 package io.github.sridharbandi;
 
 import io.github.sridharbandi.a11y.Engine;
+import io.github.sridharbandi.modal.htmlcs.Params;
 import io.github.sridharbandi.util.A11y;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -11,6 +12,7 @@
 import org.mockito.junit.jupiter.MockitoExtension;
 import org.openqa.selenium.WebDriver;
 
+import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.verify;
 
 @ExtendWith(MockitoExtension.class)
@@ -22,8 +24,6 @@ public class AxeRunnerTest {
     AxeRunner axeRunner = new AxeRunner(driver);
     @Mock
     A11y a11y;
-    @Mock
-    IRunner iRunner;
 
     @BeforeEach
     public void setUp() {
@@ -32,7 +32,7 @@ public void setUp() {
 
     @Test
     public void testExecute() throws Exception {
-        axeRunner.execute();
-        verify(a11y).execute(Engine.AXE, null);
+        axeRunner.setPageTile("Page Title").execute();
+        verify(a11y).execute(any(Engine.class), any(Params.class));
     }
 }

src/test/java/io/github/sridharbandi/HtmlCsRunnerTest.java

@@ -36,7 +36,7 @@ public void testExecute() throws Exception {
         htmlCsRunner.setStandard(HTMLCS.WCAG2AA);
         String codes[] = {"Code1", "Code2"};
         htmlCsRunner.setIgnoreCodes(codes);
-        htmlCsRunner.execute();
+        htmlCsRunner.setPageTile("Page Title").execute();
         verify(a11y).execute(any(Engine.class), any(Params.class));
     }