testaro 25.0.1 → 25.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaro",
-  "version": "25.0.1",
+  "version": "25.1.0",
   "description": "Run 920 web accessibility tests from 9 tools and get a standardized report",
   "main": "index.js",
   "scripts": {

package/testaro/hover.js

@@ -1,153 +1,58 @@
 /*
   hover
-  This test reports unexpected impacts of hovering on the visible page. Impacts are measured by
-  pixel changes outside the hovered element and by unhoverability.
-
-  The elements that are subjected to hovering (called “triggers”) are the Playwright-visible
-  elements that have 'A', 'BUTTON', or (if not with role=menuitem) 'LI' tag names or have
-  'onmouseenter' or 'onmouseover' attributes.
-
-  Despite the delay, the test can make the execution time practical by randomly sampling triggers
-  instead of hovering over all of them. When sampling is performed, the results may vary from one
-  execution to another. Because hover impacts typically occur near the beginning of a page with
-  navigation menus, the probability of the inclusion of a trigger in a sample decreases with the
-  index of the trigger.
-
-  Pixel changes: If no pixel changes occur immediately after an element is hovered over, the page
-  is examined once more, after 0.5 second. The greater the fraction of changed pixels, the greater
-  the ordinal severity.
-
-  Unhoverability: An element is reported as unhoverable when it fails the Playwright actionability
-  checks for hovering, i.e. fails to be attached to the DOM, visible, stable (not or no longer
-  animating), and able to receive events. All triggers satisfy the first two conditions, so only the
-  last two might fail. Playwright defines the ability to receive events as being the target of an
-  action on the location where the center of the element is, rather than some other element with a
-  higher zIndex value in the same location being the target.
-
-  WARNING: This test uses the procs/visChange module. See the warning in that module about browser
-  types.
+  This test reports unexpected impacts of hovering. The elements that are subjected to hovering
+  (called “triggers”) include all the elements that have aria-controls, aria-expanded,
+  onmouseenter, or onmouseover' attributes and a sample of all visible elements in the body. If
+  hovering over an element results in an increase or decrease in the total count of visible
+  elements in the body, the rule is considered violated.
 */
 
-// IMPORTS
-
-// Module to get locator data.
-const {getLocatorData} = require('../procs/getLocatorData');
-// Module to draw a sample.
-const {getSample} = require('../procs/sample');
-// Module to get pixel changes between two times.
-const {visChange} = require('../procs/visChange');
-
-// FUNCTIONS
-
-// Performs the hover test and reports results.
-exports.reporter = async (page, withItems, sampleSize = 20) => {
-  // Initialize the result.
-  const data = {};
-  const totals = [0, 0, 0, 0];
-  const standardInstances = [];
-  // Identify the triggers.
-  const selectors = ['a', 'button', 'li:not([role=menuitem])', '[onmouseenter]', '[onmouseover]'];
-  const selectorString = selectors.map(selector => `body ${selector}:visible`).join(', ');
-  const locAll = page.locator(selectorString);
-  const locsAll = await locAll.all();
-  // Get the population-to-sample ratio.
-  const psRatio = Math.max(1, locsAll.length / sampleSize);
-  // Get a sample of the triggers.
-  const sampleIndexes = getSample(locsAll, sampleSize);
-  const sample = sampleIndexes.map(index => locsAll[index]);
-  // For each trigger in the sample:
-  for (const loc of sample) {
-    // Hover over it and get the fractional pixel change.
-    const hoverData = await visChange(page, {
-      delayBefore: 0,
-      delayBetween: 500,
-      exclusion: loc
-    });
-    // If the hovering and measurement succeeded:
-    if (hoverData.success) {
-      // If any pixels changed:
-      if (hoverData.changePercent) {
-        // Get the ordinal severity from the fractional pixel change.
-        const ordinalSeverity = Math.floor(Math.min(3, 0.4 * Math.sqrt(hoverData.changePercent)));
-        // Add to the totals.
-        totals[ordinalSeverity] += psRatio;
-        // If itemization is required:
-        if (withItems) {
-          // Get data on the trigger.
-          const elData = await getLocatorData(loc);
-          // Add an instance to the result.
-          standardInstances.push({
-            ruleID: 'hover',
-            what: 'Hovering over the element changes the page',
-            ordinalSeverity,
-            tagName: elData.tagName,
-            id: elData.id,
-            location: elData.location,
-            excerpt: elData.excerpt
-          });
-        }
-      }
-    }
-    // Otherwise, i.e. if hovering and measurement failed:
-    else {
-      // Add to the totals.
-      totals[3] += psRatio;
-      // If itemization is required:
-      if (withItems) {
-        // Get data on the trigger.
-        const elData = await getLocatorData(loc);
-        // Add an instance to the result.
-        standardInstances.push({
-          ruleID: 'hover',
-          what: 'Element is not hoverable',
-          ordinalSeverity: 3,
-          tagName: elData.tagName,
-          id: elData.id,
-          location: elData.location,
-          excerpt: elData.excerpt
-        });
-      }
-    }
-    // Reload the page to preserve locator integrity.
+// ########## IMPORTS
+
+// Module to perform common operations.
+const {init, report} = require('../procs/testaro');
+
+// ########## FUNCTIONS
+
+// Runs the test and returns the result.
+exports.reporter = async (page, withItems) => {
+  // Initialize the locators and result.
+  const all = await init(
+    page, 'body [aria-controls], body [aria-expanded], body [onmouseenter], body [onmouseover]'
+  );
+  const miscAll = await init(page, 'body *:visible');
+  all.allLocs.push(... miscAll.allLocs.slice(0, - all.allLocs.length));
+  // For each locator:
+  for (const loc of all.allLocs) {
+    // Get how many elements are added or subtracted when the element is hovered over.
+    await page.mouse.move(0, 0);
+    const loc0 = page.locator('body *:visible');
+    const elementCount0 = await loc0.count();
     try {
-      await page.reload({timeout: 5000});
+      await loc.hover({
+        force: true,
+        timeout: 100
+      });
+      const loc1 = page.locator('body *:visible');
+      const elementCount1 = await loc1.count();
+      const additions = elementCount1 - elementCount0;
+      // If any elements are:
+      if (additions !== 0) {
+        // Add the locator and the change of element count to the array of violators.
+        const impact = additions > 0
+          ? `added ${additions} elements to the page`
+          : `subtracted ${- additions} from the page`;
+        all.locs.push([loc, impact]);
+      }
     }
     catch(error) {
-      console.log('ERROR: page reload timed out');
-    }
-  }
-  // If itemization is not required:
-  if (! withItems) {
-    // For each ordinal severity:
-    for (const index in totals) {
-      // If there were any instances with it:
-      if (totals[index]) {
-        // Add a summary instance to the result.
-        standardInstances.push({
-          ruleID: 'hover',
-          what: 'Hovering over elements changes the page or fails',
-          ordinalSeverity: index,
-          count: Math.round(totals[index]),
-          tagName: '',
-          id: '',
-          location: {
-            doc: '',
-            type: '',
-            spec: ''
-          },
-          excerpt: ''
-        });
-      }
+      console.log(`Hovering timed out (${error.message.replace(/[\n].+/s, '')})`);
     }
   }
-  // Round the totals.
-  totals.forEach((total, index) => {
-    totals[index] = Math.round(totals[index]);
-  });
-  // Return the result.
-  return {
-    data,
-    totals,
-    standardInstances
-  };
+  // Populate and return the result.
+  const whats = [
+    'Hovering over the element __param__',
+    'Hovering over elements adds elements to or subtracts elements from the page'
+  ];
+  return await report(withItems, all, 'hover', whats, 0);
 };