added new rule AvoidAbstractRoleRule

Author: codescape

bitvunit-core/src/main/java/de/codescape/bitvunit/model/Page.java

@@ -293,4 +293,15 @@ public HtmlTitle findTitleTag() {
         return (HtmlTitle) htmlPage.getFirstByXPath("/html/head/title[1]");
     }
 
+    /**
+     * Returns all elements with the given attribute name as {@link HtmlElement} instances.
+     *
+     * @param attributeName name of the attribute to filter by
+     * @return all elements with the given attribute name as {@link HtmlElement} instances
+     */
+    @SuppressWarnings("unchecked")
+    public List<HtmlElement> findAllElementsWithAttribute(String attributeName) {
+        return (List<HtmlElement>) htmlPage.getByXPath("//*[@" + attributeName + "]");
+    }
+
 }

bitvunit-core/src/main/java/de/codescape/bitvunit/rule/page/AvoidAbstractRoleRule.java

@@ -0,0 +1,42 @@
+package de.codescape.bitvunit.rule.page;
+
+import com.gargoylesoftware.htmlunit.html.HtmlElement;
+import de.codescape.bitvunit.model.Page;
+import de.codescape.bitvunit.rule.AbstractRule;
+import de.codescape.bitvunit.rule.Violations;
+
+import java.util.Arrays;
+import java.util.List;
+
+/**
+ * AvoidAbstractRoleRule ensures that no abstract roles that are part of the Accessible Rich Internet Applications
+ * (WAI-ARIA) 1.0 document are used within the current HTML page.
+ *
+ * @author Stefan Glase
+ * @see <a href="http://www.w3.org/TR/wai-aria/roles#abstract_roles">http://www.w3.org/TR/wai-aria/roles#abstract_roles</a>
+ * @since 0.6
+ */
+public class AvoidAbstractRoleRule extends AbstractRule {
+
+    private static final String RULE_NAME = "AvoidAbstractRole";
+    private static final String RULE_MESSAGE = "Abstract roles must not be used inside HTML documents because their only purpose is the aggregation of their child roles.";
+    private static final List<String> ABSTRACT_ROLES = Arrays.asList("command", "composite", "input", "landmark",
+            "range", "roletype", "section", "sectionhead", "select", "structure", "widget", "window");
+
+    @Override
+    public String getName() {
+        return RULE_NAME;
+    }
+
+    @Override
+    protected void applyTo(Page page, Violations violations) {
+        List<HtmlElement> elements = page.findAllElementsWithAttribute("role");
+        for (HtmlElement element : elements) {
+            String roleValue = element.getAttribute("role");
+            if (roleValue != null && !roleValue.isEmpty() && ABSTRACT_ROLES.contains(roleValue)) {
+                violations.add(createViolation(element, RULE_MESSAGE));
+            }
+        }
+    }
+
+}

bitvunit-core/src/main/resources/rulesets/all-rules.xml

@@ -41,6 +41,7 @@
     <rule class="de.codescape.bitvunit.rule.media.AlternativeTextForObjectRule"/>
 
     <!-- Page -->
+    <rule class="de.codescape.bitvunit.rule.page.AvoidAbstractRoleRule"/>
     <rule class="de.codescape.bitvunit.rule.page.TitleForPageRule"/>
     <rule class="de.codescape.bitvunit.rule.page.LanguageForHtmlTagRule"/>
 

bitvunit-core/src/test/java/de/codescape/bitvunit/rule/page/AvoidAbstractRoleRuleTest.java

@@ -0,0 +1,95 @@
+package de.codescape.bitvunit.rule.page;
+
+import de.codescape.bitvunit.rule.Violations;
+import org.junit.Test;
+
+import static de.codescape.bitvunit.test.Assertions.assertNoViolations;
+import static de.codescape.bitvunit.test.Assertions.assertViolations;
+import static de.codescape.bitvunit.util.html.HtmlPageUtil.toHtmlPage;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+public class AvoidAbstractRoleRuleTest {
+
+    private AvoidAbstractRoleRule rule = new AvoidAbstractRoleRule();
+
+    @Test
+    public void ruleHasAName() throws Exception {
+        assertNotNull(rule.getName());
+        assertEquals("AvoidAbstractRole", rule.getName());
+    }
+
+    @Test
+    public void abstractRoleCommandPresentCausesViolation() throws Exception {
+        abstractRoleWithRoleNamePresentCausesViolation("command");
+    }
+
+    @Test
+    public void abstractRoleCompositePresentCausesViolation() throws Exception {
+        abstractRoleWithRoleNamePresentCausesViolation("composite");
+    }
+
+    @Test
+    public void abstractRoleInputPresentCausesViolation() throws Exception {
+        abstractRoleWithRoleNamePresentCausesViolation("input");
+    }
+
+    @Test
+    public void abstractRoleLandmarkPresentCausesViolation() throws Exception {
+        abstractRoleWithRoleNamePresentCausesViolation("landmark");
+    }
+
+    @Test
+    public void abstractRoleRangePresentCausesViolation() throws Exception {
+        abstractRoleWithRoleNamePresentCausesViolation("range");
+    }
+
+    @Test
+    public void abstractRoleRoletypePresentCausesViolation() throws Exception {
+        abstractRoleWithRoleNamePresentCausesViolation("roletype");
+    }
+
+    @Test
+    public void abstractRoleSectionPresentCausesViolation() throws Exception {
+        abstractRoleWithRoleNamePresentCausesViolation("section");
+    }
+
+    @Test
+    public void abstractRoleSectionheadPresentCausesViolation() throws Exception {
+        abstractRoleWithRoleNamePresentCausesViolation("sectionhead");
+    }
+
+    @Test
+    public void abstractRoleSelectPresentCausesViolation() throws Exception {
+        abstractRoleWithRoleNamePresentCausesViolation("select");
+    }
+
+    @Test
+    public void abstractRoleStructurePresentCausesViolation() throws Exception {
+        abstractRoleWithRoleNamePresentCausesViolation("structure");
+    }
+
+    @Test
+    public void abstractRoleWidgetPresentCausesViolation() throws Exception {
+        abstractRoleWithRoleNamePresentCausesViolation("widget");
+    }
+
+    @Test
+    public void abstractRoleWindowPresentCausesViolation() throws Exception {
+        abstractRoleWithRoleNamePresentCausesViolation("window");
+    }
+
+    private void abstractRoleWithRoleNamePresentCausesViolation(String roleName) {
+        String content = "<html><body><div role=\"" + roleName + "\">Content</div></body></html>";
+        Violations violations = rule.applyTo(toHtmlPage(content));
+        assertViolations(violations, rule, 1);
+    }
+
+    @Test
+    public void landmarkRoleBannerPresentCausesNoViolation() throws Exception {
+        String content = "<html><body><div role=\"banner\">Content</div></body></html>";
+        Violations violations = rule.applyTo(toHtmlPage(content));
+        assertNoViolations(violations, rule);
+    }
+
+}