testaro 5.8.0 → 5.9.0

package/commands.js

@@ -150,6 +150,15 @@ exports.commands = {
         rules: [true, 'array', 'areStrings', 'rule names, or empty if all']
       }
     ],
+    elements: [
+      'Perform an elements test',
+      {
+        detailLevel: [true, 'number', '', '0 = counts, 1 = selves, 2 = also sibling nodes'],
+        tagName: [false, 'string', '', 'tag name of elements'],
+        onlyVisible: [false, 'boolean', '', 'whether to exclude invisible elements'],
+        attribute: [false, 'string', 'hasLength', 'required attribute or attribute=value']
+      }
+    ],
     embAc: [
       'Perform an embAc test',
       {

package/package.json

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

package/run.js

@@ -34,6 +34,7 @@ const tests = {
   bulk: 'count of visible elements',
   continuum: 'Level Access Continuum, community edition',
   docType: 'document without a doctype property',
+  elements: 'data on specified elements',
   embAc: 'active elements embedded in links or buttons',
   focAll: 'focusable and Tab-focused elements',
   focInd: 'focus indicators',
@@ -70,7 +71,7 @@ const browserTypeNames = {
   'firefox': 'Firefox'
 };
 // Items that may be waited for.
-const waitables = ['url', 'title', 'body', 'mailLink'];
+const waitables = ['url', 'title', 'body'];
 // Tenon data.
 const tenonData = {
   accessToken: '',
@@ -81,6 +82,7 @@ const errorWords = [
   'content security policy',
   'deprecated',
   'error',
+  'expected',
   'failed',
   'invalid',
   'missing',
@@ -812,44 +814,6 @@ const doActs = async (report, actIndex, page) => {
               waitError(page, act, error, 'body');
             }
           }
-          else if (what === 'mailLink') {
-            try {
-              const addressJSHandle = await page.waitForFunction(
-                text => {
-                  const mailLinks = document
-                  && document.body
-                  && document.body.querySelectorAll('a[href^="mailto:"]');
-                  if (mailLinks && mailLinks.length) {
-                    const textLC = text.toLowerCase();
-                    const a11yLink = Array
-                    .from(mailLinks)
-                    .find(link => link.textContent.toLowerCase().includes(textLC));
-                    if (a11yLink) {
-                      return a11yLink.href.replace(/^mailto:/, '');
-                    }
-                    else {
-                      return false;
-                    }
-                  }
-                  else {
-                    return false;
-                  }
-                },
-                which,
-                {
-                  polling: 1000,
-                  timeout: 5000
-                }
-              );
-              const address = await addressJSHandle.jsonValue();
-              result.found = true;
-              result.address = address;
-            }
-            catch(error) {
-              actIndex = -2;
-              waitError(page, act, error, 'mailLink');
-            }
-          }
         }
         // Otherwise, if the act is a wait for a state:
         else if (act.type === 'state') {

package/tests/elements.js

@@ -0,0 +1,128 @@
+/*
+  elements
+  This test reports data about specified elements.
+*/
+exports.reporter = async (page, detailLevel, tagName, onlyVisible, attribute) => {
+  // Determine a selector of the specified elements.
+  let selector = tagName || '*';
+  if (attribute) {
+    selector += `[${attribute}]`;
+  }
+  if (onlyVisible) {
+    selector += ':visible';
+  }
+  // Get the data on the elements.
+  const data = await page.$$eval(selector, (elements, detailLevel) => {
+    // FUNCTION DEFINITIONS START
+    // Compacts a string.
+    const compact = string => string.replace(/\s+/g, ' ').trim();
+    // Gets data on the sibling nodes of an element.
+    const getSibInfo = (node, nodeType, text) => {
+      const sibInfo = {
+        type: nodeType
+      };
+      if (nodeType === 1) {
+        sibInfo.tagName = node.tagName;
+      }
+      else if (nodeType === 3) {
+        sibInfo.text = compact(text);
+      }
+      return sibInfo;
+    };
+    // FUNCTION DEFINITIONS END
+    // Initialize the data with the count of the specified elements.
+    const data = {
+      total: elements.length
+    };
+    // If no itemization is required:
+    if (detailLevel === 0) {
+      // Return the element count.
+      return data;
+    }
+    // Otherwise, i.e. if itemization is required:
+    else {
+      // Initialize the item data.
+      data.items = [];
+      // For each specified element:
+      elements.forEach(element => {
+        // Initialize data on it.
+        const datum = {
+          tagName: element.tagName,
+          code: compact(element.outerHTML),
+          attributes: [],
+          textContent: compact(element.textContent)
+        };
+        // For each of its attributes:
+        for (const attribute of element.attributes) {
+          // Add data on the attribute to the element data.
+          const {name, value} = attribute;
+          datum.attributes.push({
+            name,
+            value
+          });
+          // If the element has reference labels:
+          if (name === 'aria-labelledby') {
+            // Add their texts to the element data.
+            const labelerIDs = value.split(/\s+/);
+            const labelers = [];
+            labelerIDs.forEach(id => {
+              const labeler = document.getElementById(id);
+              if (labeler) {
+                labelers.push(compact(labeler.textContent));
+              }
+            });
+            if (labelers.length) {
+              datum.labelers = labelers;
+            }
+          }
+        }
+        // If the element has text content:
+        const {labels, textContent} = element;
+        const compactContent = compact(textContent);
+        if (compactContent) {
+          // Add it to the element data.
+          datum.textContent = compactContent;
+        }
+        // If the element has labels:
+        if (labels && labels.length) {
+          // Add their texts to the element data.
+          datum.labels = Array.from(labels).map(label => compact(label.textContent));
+        }
+        // If sibling itemization is required:
+        if (detailLevel === 2) {
+          // Add the sibling data to the element data.
+          datum.siblings = {
+            before: [],
+            after: []
+          };
+          let more = element;
+          while (more) {
+            more = more.previousSibling;
+            if (more) {
+              const {nodeType, nodeValue} = more;
+              if (! (nodeType === 3 && nodeValue === '')) {
+                const sibInfo = getSibInfo(more, nodeType, nodeValue);
+                datum.siblings.before.unshift(sibInfo);
+              }
+            }
+          }
+          more = element;
+          while (more) {
+            more = more.nextSibling;
+            if (more) {
+              const {nodeType, textContent} = more;
+              if (! (nodeType === 3 && textContent === '')) {
+                const sibInfo = getSibInfo(more, nodeType, compact(textContent));
+                datum.siblings.after.push(sibInfo);
+              }
+            }
+          }
+        }
+        data.items.push(datum);
+      });
+      return data;
+    }
+  }, detailLevel);
+  // Return the result.
+  return {result: data};
+};