testaro 4.6.1 → 4.7.0

package/commands.js

@@ -166,8 +166,9 @@ exports.commands = {
     focInd: [
       'Perform a focInd test',
       {
-        withItems: [true, 'boolean'],
-        revealAll: [true, 'boolean', '', 'whether to make all elements visible first']
+        revealAll: [true, 'boolean', '', 'whether to make all elements visible first'],
+        allowedDelay: [true, 'number', '', 'milliseconds to wait for an outline'],
+        withItems: [true, 'boolean']
       }
     ],
     focOp: [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaro",
-  "version": "4.6.1",
+  "version": "4.7.0",
   "description": "Automation of accessibility testing",
   "main": "index.js",
   "scripts": {

package/tests/focInd.js

@@ -1,21 +1,24 @@
 /*
   focInd
   This test reports focusable elements without focus indicators, with non-outline focus
-  indicators, and with outline focus indicators.
-
-  It as based on the assumption that outlines are the standard and thus most familiar
-  focus indicator. Other focus indicators are assumed better than none, but more likely
-  to be misunderstood. For example, underlines may be mistaken for selection indicators.
+  indicators, and with outline focus indicators. An outline is recognized if it has non-zero
+  line thickness and non-transparent color. The test is based on the assumption that outlines are
+  the standard and thus most familiar focus indicator. Other focus indicators are assumed better
+  than none, but more likely to be misunderstood. For example, underlines may be mistaken for
+  selection indicators. Some pages delay the appearance of focus indicators. This test waits for
+  focus indicators to appear if specified and, if there is a delay, reports on its magnitude.
 
   Bug: This test fails to recognize outlines when run with firefox.
 */
-exports.reporter = async (page, withItems, revealAll) => {
+exports.reporter = async (page, revealAll, allowedDelay, withItems) => {
   // If required, make all elements visible.
   if (revealAll) {
     await require('../procs/allVis').allVis(page);
   }
   // Get data on the focusable visible elements with and without indicators.
-  const data = await page.$$eval('body *:visible', (elements, withItems) => {
+  const data = await page.$$eval('body *:visible', async (elements, args) => {
+    const allowedDelay = args[0];
+    const withItems = args[1];
     // Initialize the data.
     const data = {
       totals: {
@@ -31,6 +34,7 @@ exports.reporter = async (page, withItems, revealAll) => {
           },
           outlinePresent: {
             total: 0,
+            meanDelay: 0,
             tagNames: {}
           }
         }
@@ -43,9 +47,13 @@ exports.reporter = async (page, withItems, revealAll) => {
         outlinePresent: []
       };
     }
-    const addElementFacts = (element, status) => {
+    // Adds facts about an element to the result.
+    const addElementFacts = (element, status, delay = null) => {
       const type = data.totals.types[status];
       type.total++;
+      if (status === 'outlinePresent') {
+        type.meanDelay = Math.round(((type.total - 1) * type.meanDelay + delay) / type.total);
+      }
       const tagName = element.tagName;
       if (type.tagNames[tagName]) {
         type.tagNames[tagName]++;
@@ -54,46 +62,91 @@ exports.reporter = async (page, withItems, revealAll) => {
         type.tagNames[tagName] = 1;
       }
       if (withItems) {
-        data.items[status].push({
+        const elementData = {
           tagName,
           text: element.textContent.trim().replace(/\s{2,}/g, ' ').slice(0, 100)
-        });
+        };
+        if (status === 'outlinePresent') {
+          elementData.delay = delay;
+        }
+        data.items[status].push(elementData);
       }
     };
-    elements.forEach(element => {
+    // For each visible element descendant of the body:
+    for(const element of elements) {
+      // If it is Tab-focusable:
       if (element.tabIndex === 0) {
+        // Increment the total of focusable elements.
         data.totals.total++;
-        const styleBlurred = Object.assign({}, window.getComputedStyle(element));
+        // Get a live style declaration of its properties.
+        const styleDec = window.getComputedStyle(element);
+        // Freeze a copy to preserve the style properties when not focused.
+        const styleBlurred = Object.assign({}, styleDec);
+        // Focus it, potentially changing the properties in its style declaration.
         element.focus({preventScroll: true});
-        const styleFocused = window.getComputedStyle(element);
-        const hasOutline
-          = styleBlurred.outlineWidth === '0px'
-          && styleFocused.outlineWidth !== '0px';
-        if (hasOutline) {
-          addElementFacts(element, 'outlinePresent');
+        let hasOutline = false;
+        // If it has no outline when not focused:
+        if (styleBlurred.outlineWidth === '0px') {
+          // If an outline appeared immediately on focus:
+          if (styleDec.outlineWidth !== '0px' && styleDec.outlineColor !== 'rgba(0, 0, 0, 0)') {
+            // Add facts about the element to the result.
+            addElementFacts(element, 'outlinePresent', 0);
+            hasOutline = true;
+          }
+          // Otherwise, if a wait for an outline is allowed:
+          else if (allowedDelay) {
+            // Determine how long an outline takes to appear or whether it times out.
+            const outlineDelay = new Promise(resolve => {
+              const focusTime = Date.now();
+              const deadline = focusTime + allowedDelay;
+              const interval = setInterval(() => {
+                if (
+                  styleDec.outlineWidth !== '0px' && styleDec.outlineColor !== 'rgba(0, 0, 0, 0)'
+                ) {
+                  resolve(Date.now() - focusTime);
+                  clearInterval(interval);
+                }
+                else if (Date.now() > deadline) {
+                  resolve(null);
+                  clearInterval(interval);
+                }
+              }, 100);
+            });
+            // If it appeared before the wait limit:
+            const delay = await outlineDelay;
+            if (delay) {
+              // Add facts about the element to the result.
+              addElementFacts(element, 'outlinePresent', delay);
+              hasOutline = true;
+            }
+          }
         }
-        else {
-          const diff = prop => styleFocused[prop] !== styleBlurred[prop];
+        // If no outline was allowed:
+        if (! hasOutline) {
+          // Returns whether a style property differs between focused and not focused.
+          const diff = prop => styleDec[prop] !== styleBlurred[prop];
+          // Determine whether the element has another allowed focus indicator.
           const hasIndicator
-            = diff('borderStyle')
-            && styleBlurred.borderWidth !== '0px'
-            && styleFocused.borderWidth !== '0px'
-            || (styleFocused.borderStyle !== 'none' && diff('borderWidth'))
-            || diff('outlineStyle')
-            && styleBlurred.outlineWidth !== '0px'
-            && styleFocused.outlineWidth !== '0px'
-            || (styleFocused.outlineStyle !== 'none' && diff('outlineWidth'))
-            || diff('fontSize')
-            || diff('fontStyle')
-            || diff('textDecorationLine')
-            || diff('textDecorationStyle')
-            || diff('textDecorationThickness');
+          = diff('borderStyle')
+          && styleBlurred.borderWidth !== '0px'
+          && styleDec.borderWidth !== '0px'
+          || (styleDec.borderStyle !== 'none' && diff('borderWidth'))
+          || diff('outlineStyle')
+          && styleBlurred.outlineWidth !== '0px'
+          && styleDec.outlineWidth !== '0px'
+          || (styleDec.outlineStyle !== 'none' && diff('outlineWidth'))
+          || diff('fontSize')
+          || diff('fontStyle')
+          || diff('textDecorationLine')
+          || diff('textDecorationStyle')
+          || diff('textDecorationThickness');
+          // Add the determination to the result.
           const status = hasIndicator ? 'nonOutlinePresent' : 'indicatorMissing';
           addElementFacts(element, status);
         }
       }
-    });
+    };
     return data;
-  }, withItems);
+  }, [allowedDelay, withItems]);
   return {result: data};
 };