testaro 18.1.1 → 18.2.0

package/testaro/headingAmb.js

@@ -0,0 +1,103 @@
+/*
+  headingAmb
+  Related to ASLint rule headings-sibling-unique.
+  This test reports same-level heading siblings in the heading hierarchy that have identical text
+  contents.
+*/
+
+// ########## IMPORTS
+
+// Module to get locator data.
+const {getLocatorData} = require('../procs/getLocatorData');
+
+// ########## FUNCTIONS
+
+// Performs the test.
+exports.reporter = async (page, withItems) => {
+  // Initialize the standard result.
+  const data = {};
+  const totals = [0, 0, 0, 0];
+  const standardInstances = [];
+  // Get locators for all the headings.
+  const headingLevels = [1, 2, 3, 4, 5, 6];
+  const locAll = page.locator(headingLevels.map(level => `body h${level}`).join(', '));
+  const locsAll = await locAll.all();
+  const ambIndexes = await locAll.evaluateAll(headings => {
+    // Initialize the array of indexes of violating headings.
+    const badIndexes = [];
+    // For each heading:
+    headings.forEach((heading, index) => {
+      // If any same-level and same-text heading precedes it:
+      const priors = headings.slice(0, index);
+      priors.forEach((prior, priorIndex) => {
+        if (['tagName', 'textContent'].every(property => prior[property] === heading[property])) {
+          // If no superior heading exists between them:
+          if (
+            headings
+            .slice(priorIndex + 1, index)
+            .every(betweenHeading => betweenHeading.tagName[1] >= heading.tagName[1])
+          ) {
+            // Add the index of the later heading to the index of violating headings.
+            badIndexes.push(headings.indexOf(heading));
+          }
+        }
+      });
+    });
+    return badIndexes;
+  });
+  // If there were any instances:
+  if (ambIndexes.length) {
+    // Add to the totals.
+    totals[1] = ambIndexes.length;
+    // If itemization is required:
+    if (withItems) {
+      // For each instance:
+      for (const index of ambIndexes) {
+        // If it exists:
+        const loc = locsAll[index];
+        if (loc) {
+          // Get data on the element.
+          const elData = await getLocatorData(loc);
+          // Add a standard instance.
+          standardInstances.push({
+            ruleID: 'headingAmb',
+            what: 'Heading has the same text as a prior same-level sibling heading',
+            ordinalSeverity: 1,
+            tagName: elData.tagName,
+            id: elData.id,
+            location: elData.location,
+            excerpt: elData.excerpt
+          });
+        }
+        // Otherwise, i.e. if it does not exist:
+        else {
+          // Report this.
+          console.log('ERROR: Reportedly same-text sibling heading not found');
+        }
+      }
+    }
+    // Otherwise, i.e. if itemization is not required:
+    else {
+      // Add a summary instance.
+      standardInstances.push({
+        ruleID: 'headingAmb',
+        what: 'Sibling same-level headings have the same text',
+        ordinalSeverity: 1,
+        count: totals[1],
+        tagName: '',
+        id: '',
+        location: {
+          doc: '',
+          type: '',
+          spec: ''
+        },
+        excerpt: ''
+      });
+    }
+  }
+  return {
+    data,
+    totals,
+    standardInstances
+  };
+};

package/testaro/template.js

@@ -0,0 +1,78 @@
+/*
+  template
+  This test reports ….
+*/
+
+// ########## IMPORTS
+
+// Module to get locator data.
+const {getLocatorData} = require('../procs/getLocatorData');
+
+// ########## FUNCTIONS
+
+// Performs the test.
+exports.reporter = async (page, withItems) => {
+  // Initialize the standard result.
+  const data = {};
+  const totals = [0, 0, 0, 0];
+  const standardInstances = [];
+  // Get locators for all applicable elements.
+  const locAll = page.locator('body *', {option: ''});
+  const locsAll = await locAll.all();
+  // For each of them:
+  for (const loc of locsAll) {
+    // Get data on it.
+    const facts = await loc.evaluate(element => {
+      return element.something;
+    });
+    // If there are any instances:
+    if (facts.length) {
+      // Add to the totals.
+      totals[0]++;
+      // If itemization is required:
+      if (withItems) {
+        // Get data on the element.
+        const elData = await getLocatorData(loc);
+        // Add a standard instance.
+        standardInstances.push({
+          ruleID: 'template',
+          what: 'Element is bad',
+          ordinalSeverity: 0,
+          tagName: elData.tagName,
+          id: elData.id,
+          location: elData.location,
+          excerpt: elData.excerpt
+        });
+      }
+    }
+  }
+  // If itemization is not required:
+  if (! withItems) {
+    // For each ordinal severity:
+    [0, 1, 2, 3].forEach(ordinalSeverity => {
+      // If there are instances with it:
+      if (totals[ordinalSeverity]) {
+        // Add a summary instance.
+        standardInstances.push({
+          ruleID: 'template',
+          what: 'Elements are bad',
+          ordinalSeverity,
+          count: totals[ordinalSeverity],
+          tagName: '',
+          id: '',
+          location: {
+            doc: '',
+            type: '',
+            spec: ''
+          },
+          excerpt: ''
+        });
+      }
+    });
+  }
+  return {
+    data,
+    totals,
+    standardInstances
+  };
+};

package/tests/testaro.js

@@ -21,6 +21,7 @@ const evalRules = {
   focInd: 'missing and nonstandard focus indicators',
   focOp: 'discrepancies between focusability and operability',
   focVis: 'links that are invisible when focused',
+  headingAmb: 'same-level sibling headings with identical texts',
   hover: 'hover-caused content changes',
   hovInd: 'hover indication nonstandard',
   labClash: 'labeling inconsistencies',

package/validation/tests/jobs/headingAmb.json

@@ -0,0 +1,129 @@
+{
+  "id": "headingAmb",
+  "what": "validation of headingAmb test",
+  "strict": true,
+  "timeLimit": 20,
+  "acts": [
+    {
+      "type": "launch",
+      "which": "chromium",
+      "what": "usual browser"
+    },
+    {
+      "type": "url",
+      "which": "__targets__/headingAmb/index.html",
+      "what": "page with and without heading ambiguity"
+    },
+    {
+      "type": "test",
+      "which": "testaro",
+      "withItems": true,
+      "stopOnFail": true,
+      "expect": [
+        [
+          "standardResult.totals.1",
+          "=",
+          3
+        ],
+        [
+          "standardResult.instances.length",
+          "=",
+          3
+        ],
+        [
+          "standardResult.instances.0.ruleID",
+          "=",
+          "headingAmb"
+        ],
+        [
+          "standardResult.instances.0.what",
+          "i",
+          "Heading has the same text"
+        ],
+        [
+          "standardResult.instances.0.ordinalSeverity",
+          "=",
+          1
+        ],
+        [
+          "standardResult.instances.0.tagName",
+          "=",
+          "H2"
+        ],
+        [
+          "standardResult.instances.0.location.doc",
+          "=",
+          "dom"
+        ],
+        [
+          "standardResult.instances.0.location.type",
+          "=",
+          "box"
+        ],
+        [
+          "standardResult.instances.0.location.spec.y",
+          ">",
+          0
+        ],
+        [
+          "standardResult.instances.0.excerpt",
+          "=",
+          "Level-2 heading"
+        ]
+      ],
+      "rules": [
+        "y",
+        "headingAmb"
+      ]
+    },
+    {
+      "type": "test",
+      "which": "testaro",
+      "withItems": false,
+      "stopOnFail": true,
+      "expect": [
+        [
+          "standardResult.totals.1",
+          "=",
+          3
+        ],
+        [
+          "standardResult.totals.2",
+          "=",
+          0
+        ],
+        [
+          "standardResult.instances.length",
+          "=",
+          1
+        ],
+        [
+          "standardResult.instances.0.ruleID",
+          "=",
+          "headingAmb"
+        ],
+        [
+          "standardResult.instances.0.count",
+          "=",
+          3
+        ],
+        [
+          "standardResult.instances.0.what",
+          "i",
+          "Sibling same-level headings"
+        ]
+      ],
+      "rules": [
+        "y",
+        "headingAmb"
+      ]
+    }
+  ],
+  "sources": {
+    "script": "",
+    "host": {},
+    "requester": ""
+  },
+  "creationTime": "2013-05-28T12:00:00",
+  "timeStamp": "00000"
+}

package/validation/tests/targets/headingAmb/index.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <title>Page with and without heading ambiguity</title>
+    <meta name="description" content="tester">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+  </head>
+  <body>
+    <main>
+      <h1>Page with and without heading ambiguity</h1>
+      <p>This is a paragraph.</p>
+      <h2>Level-2 heading</h2>
+      <h2>Level-2 heading</h2>
+      <p>The heading of this paragraph is a violator.</p>
+      <h2>Yet another level-2 heading</h2>
+      <h3>Level-3 heading</h3>
+      <div>
+        <h2>Level-2 heading</h2>
+        <p>The heading of this paragraph is a 2-time violator, notwithstanding the div.</p>
+        <h3>Level-3 heading</h3>
+        <p>The heading of this paragraph is OK, because a superior heading intervenes.</p>
+      </div>
+    </main>
+  </body>
+</html>