testaro 4.5.3 → 4.6.0

package/commands.js

@@ -179,6 +179,7 @@ exports.commands = {
     hover: [
       'Perform a hover test',
       {
+        sampleSize: [false, 'number', '', 'number of triggers to sample, if fewer than all'],
         withItems: [true, 'boolean']
       }
     ],

package/package.json

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

package/tests/hover.js

@@ -9,9 +9,9 @@
   has the tag name 'A' or 'BUTTON' or otherwise the descendants of the element. The only
   elements counted as being made visible by hovering are those with tag names 'A', 'BUTTON',
   'INPUT', and 'SPAN', and those with 'role="menuitem"' attributes. The test waits 700 ms after
-  each hover in case of delayed effects. Despite this delay, the test makes the execution time
-  practical by randomly sampling targets instead of hovering over all of them. Therefore, the
-  results may vary from one execution to another.
+  each hover in case of delayed effects. Despite this delay, the test can make the execution time
+  practical by randomly sampling targets instead of hovering over all of them. When sampling is
+  performed, the results may vary from one execution to another.
 */
 
 // CONSTANTS
@@ -53,14 +53,14 @@ const getSample = (population, sampleSize) => {
     return [];
   }
 };
+// Returns the text of an element.
+const textOf = async (element, limit) => {
+  let text = await element.textContent();
+  text = text.trim() || await element.innerHTML();
+  return text.trim().replace(/\s*/sg, '').slice(0, limit);
+};
 // Recursively finds and reports triggers and targets.
 const find = async (withItems, page, triggers) => {
-  if (withItems) {
-    data.items = {
-      triggers: [],
-      unhoverables: []
-    };
-  }
   // If any potential disclosure triggers remain:
   if (triggers.length) {
     // Identify the first of them.
@@ -181,12 +181,6 @@ const find = async (withItems, page, triggers) => {
       }
       catch (error) {
         console.log('ERROR hovering');
-        // Returns the text of an element.
-        const textOf = async (element, limit) => {
-          let text = await element.textContent();
-          text = text.trim() || await element.innerHTML();
-          return text.trim().replace(/\s*/sg, '').slice(0, limit);
-        };
         data.totals.unhoverables++;
         if (withItems) {
           data.items.unhoverables.push({
@@ -201,7 +195,16 @@ const find = async (withItems, page, triggers) => {
     await find(withItems, page, triggers.slice(1));
   }
 };
-exports.reporter = async (page, withItems) => {
+// Performs hover test and reports results.
+exports.reporter = async (page, sampleSize = Infinity, withItems) => {
+  // If details are to be reported:
+  if (withItems) {
+    // Add properties for details to the initialized result.
+    data.items = {
+      triggers: [],
+      unhoverables: []
+    };
+  }
   // Identify the triggers.
   const selectors = [
     'body a:visible',
@@ -217,8 +220,7 @@ exports.reporter = async (page, withItems) => {
   });
   // If they number more than the sample size limit, sample them.
   const triggerCount = triggers.length;
-  const sampleSize = 15;
-  const triggerSample = triggerCount > sampleSize ? getSample(triggers, 15) : triggers;
+  const triggerSample = triggerCount > sampleSize ? getSample(triggers, sampleSize) : triggers;
   // Find and document the hover-triggered disclosures.
   await find(withItems, page, triggerSample);
   // If the triggers were sampled: