testaro 74.2.3 → 75.0.0

package/testaro/optRoleSel.js

@@ -22,7 +22,7 @@ const {doTest} = require('../procs/testaro');
 // FUNCTIONS
 
 // Runs the test and returns the result.
-exports.reporter = async (page, catalog, withItems) => {
+exports.reporter = async (page, report, _, withItems) => {
   const getBadWhat = element => {
     // If the element has no aria-selected attribute:
     if (! element.hasAttribute('aria-selected')) {
@@ -32,6 +32,6 @@ exports.reporter = async (page, catalog, withItems) => {
   };
   const whats = 'Elements with role=option have no aria-selected attributes';
   return await doTest(
-    page, catalog, withItems, 'optRoleSel', 'body [role="option"]', whats, 1, getBadWhat.toString()
+    page, report.catalog, withItems, 'optRoleSel', 'body [role="option"]', whats, 1, getBadWhat.toString()
   );
 };

package/testaro/phOnly.js

@@ -22,7 +22,7 @@ const {doTest} = require('../procs/testaro');
 // FUNCTIONS
 
 // Runs the test and returns the result.
-exports.reporter = async (page, catalog, withItems) => {
+exports.reporter = async (page, report, _, withItems) => {
   const getBadWhat = element => {
     // Get the accessible name of the element.
     const accessibleName = window.getAccessibleName(element);
@@ -34,6 +34,6 @@ exports.reporter = async (page, catalog, withItems) => {
   };
   const whats = 'input elements have placeholders but no accessible names';
   return await doTest(
-    page, catalog, withItems, 'phOnly', 'body input[placeholder]', whats, 2, getBadWhat.toString()
+    page, report.catalog, withItems, 'phOnly', 'body input[placeholder]', whats, 2, getBadWhat.toString()
   );
 };

package/testaro/pseudoP.js

@@ -18,7 +18,7 @@ const {doTest} = require('../procs/testaro');
 // FUNCTIONS
 
 // Runs the test and returns the result.
-exports.reporter = async (page, catalog, withItems) => {
+exports.reporter = async (page, report, _, withItems) => {
   const getBadWhat = element => {
     // Get the node before the element node.
     const previousNode = element.previousSibling;
@@ -49,6 +49,6 @@ exports.reporter = async (page, catalog, withItems) => {
   };
   const whats = 'br elements follow other br elements, possibly constituting pseudo-paragraphs';
   return await doTest(
-    page, catalog, withItems, 'pseudoP', 'body br', whats, 0, getBadWhat.toString()
+    page, report.catalog, withItems, 'pseudoP', 'body br', whats, 0, getBadWhat.toString()
   );
 };

package/testaro/radioSet.js

@@ -19,7 +19,7 @@ const {doTest} = require('../procs/testaro');
 // FUNCTIONS
 
 // Runs the test and returns the result.
-exports.reporter = async (page, catalog, withItems) => {
+exports.reporter = async (page, report, _, withItems) => {
   const getBadWhat = element => {
     // Get the name of the element.
     const elName = element.name;
@@ -69,6 +69,6 @@ exports.reporter = async (page, catalog, withItems) => {
   };
   const whats = 'Radio buttons are not validly grouped in fieldsets with legends';
   return await doTest(
-    page, catalog, withItems, 'radioSet', 'body input[type=radio]', whats, 2, getBadWhat.toString()
+    page, report.catalog, withItems, 'radioSet', 'body input[type=radio]', whats, 2, getBadWhat.toString()
   );
 };

package/testaro/role.js

@@ -25,7 +25,7 @@ const implicitRoles = new Set(Array.from(elementRoles.values()).flat());
 // FUNCTIONS
 
 // Runs the test and returns the result.
-exports.reporter = async (page, catalog, withItems) => {
+exports.reporter = async (page, report, _, withItems) => {
   // Get locators for the elements with explicit roles.
   const loc = page.locator('[role]');
   const locs = await loc.all();
@@ -44,5 +44,5 @@ exports.reporter = async (page, catalog, withItems) => {
   }
   // Get and return a result.
   const whats = 'Elements have roles assigned that are also implicit HTML element roles';
-  return await getBasicResult(catalog, withItems, 'role', 0, whats, {}, violations);
+  return await getBasicResult(report.catalog, withItems, 'role', 0, whats, {}, violations);
 };

package/testaro/secHeading.js

@@ -20,7 +20,7 @@ const {doTest} = require('../procs/testaro');
 // FUNCTIONS
 
 // Runs the test and returns the result.
-exports.reporter = async (page, catalog, withItems) => {
+exports.reporter = async (page, report, _, withItems) => {
   const getBadWhat = element => {
     // Get the children of the element.
     const children = Array.from(element.children);
@@ -44,6 +44,6 @@ exports.reporter = async (page, catalog, withItems) => {
   const selector = 'body section, body article, body nav, body aside, body main';
   const whats = 'First child headings of sectioning containers are deeper than others';
   return await doTest(
-    page, catalog, withItems, 'secHeading', selector, whats, 0, getBadWhat.toString()
+    page, report.catalog, withItems, 'secHeading', selector, whats, 0, getBadWhat.toString()
   );
 };

package/testaro/shoot0.js

@@ -15,9 +15,18 @@ const {shoot} = require('../procs/shoot');
 // FUNCTIONS
 
 // Makes and saves the first screenshot.
-exports.reporter = async (page, _, __, tmpDir) => {
+exports.reporter = async (page, report) => {
   // Make and save the screenshot.
-  const pngPath = await shoot(page, 0, tmpDir);
+  const pngPath = await shoot(page, report, {
+    exclusionSelector: '',
+    colorType: 0,
+    action: 'file'
+  });
+  // If this succeeded:
+  if (pngPath) {
+    // Add the file path to the report.
+    report.jobData.testaroShoot0 = pngPath;
+  }
   // Return whether the screenshot was prevented.
   return {
     data: {

package/testaro/shoot1.js

@@ -16,13 +16,21 @@ const {shoot} = require('../procs/shoot');
 // FUNCTIONS
 
 // Make and save the second screenshot.
-exports.reporter = async (page, _0, _1, tmpDir) => {
-  const tempFileNames = await fs.readdir(tmpDir);
+exports.reporter = async (page, report) => {
   let pngPath = '';
   // If there is a shoot0 file:
-  if (tempFileNames.includes('testaro-shoot-0.png')) {
+  if (report.jobData.testaroShoot0) {
     // Make and save the screenshot.
-    pngPath = await shoot(page, 1, tmpDir);
+    pngPath = await shoot(page, report, {
+      exclusionSelector: null,
+      colorType: 0,
+      action: 'file'
+    });
+    // If this succeeded:
+    if (pngPath) {
+      // Add the file path to the report.
+      report.jobData.testaroShoot1 = pngPath;
+    }
   }
   // Return whether the screenshot was prevented.
   return {

package/testaro/styleDiff.js

@@ -81,10 +81,10 @@ const linksByType = async page => await page.evaluateHandle(() => {
   };
 });
 // Runs the test and returns the result.
-exports.reporter = async (page, catalog, withItems) => {
+exports.reporter = async (page, report, _, withItems) => {
   // Get an object with arrays of list links and adjacent links as properties.
   const linkTypes = await linksByType(page);
-  const catalogIndex = getXPathCatalogIndex(catalog, '/html/body');
+  const catalogIndex = getXPathCatalogIndex(report.catalog, '/html/body');
   return await page.evaluate(args => {
     const [linkTypes, withItems, catalogIndex] = args;
     const {body} = document;

package/testaro/tabNav.js

@@ -286,7 +286,7 @@ const testTabLists = async (tabLists, withItems, page) => {
   }
 };
 // Runs the test and returns the result.
-exports.reporter = async (page, catalog, withItems) => {
+exports.reporter = async (page, report, _, withItems) => {
   // Initialize the results.
   data.totals = {
     navigations: {
@@ -374,7 +374,7 @@ exports.reporter = async (page, catalog, withItems) => {
         what: `Tab responds nonstandardly to ${item.navigationErrors.join(', ')}`,
         ordinalSeverity: 1,
         count: 1,
-        catalogIndex: getXPathCatalogIndex(catalog, item.xPath)
+        catalogIndex: getXPathCatalogIndex(report.catalog, item.xPath)
       });
     });
   }

package/testaro/targetsNear.js

@@ -20,7 +20,7 @@ const {getXPathCatalogIndex} = require('../procs/xPath');
 // FUNCTIONS
 
 // Runs the test and returns the result.
-exports.reporter = async (page, catalog, withItems) => {
+exports.reporter = async (page, report, _, withItems) => {
   // Return totals and standard instances for the rule.
   const protoResult = await page.evaluate(withItems => {
     // Get all pointer targets.
@@ -142,7 +142,7 @@ exports.reporter = async (page, catalog, withItems) => {
   }, withItems);
   // Convert the XPaths of the proto-instances to catalog indexes.
   protoResult.standardInstances = protoResult.standardInstances.map(instance => {
-    instance.catalogIndex = getXPathCatalogIndex(catalog, instance.xPath);
+    instance.catalogIndex = getXPathCatalogIndex(report.catalog, instance.xPath);
     delete instance.xPath;
     return instance;
   });

package/testaro/textNodes.js

@@ -18,7 +18,7 @@
 // FUNCTIONS
 
 // Runs the test and returns the result.
-exports.reporter = async (page, _, _, detailLevel, text = '') => {
+exports.reporter = async (page, _0, _1, _2, detailLevel, text = '') => {
   let data = {};
   // Get the data on the text nodes.
   try {

package/testaro/textSem.js

@@ -19,7 +19,7 @@ const {doTest} = require('../procs/testaro');
 // FUNCTIONS
 
 // Runs the test and returns the result.
-exports.reporter = async (page, catalog, withItems) => {
+exports.reporter = async (page, report, _, withItems) => {
   const getBadWhat = element => {
     const isVisible = element.checkVisibility({
       contentVisibilityAuto: true,
@@ -38,6 +38,6 @@ exports.reporter = async (page, catalog, withItems) => {
   const selector = 'body i, body b, body small';
   const whats = 'Semantically vague elements i, b, and/or small are used';
   return await doTest(
-    page, catalog, withItems, 'textSem', selector, whats, 0, getBadWhat.toString()
+    page, report.catalog, withItems, 'textSem', selector, whats, 0, getBadWhat.toString()
   );
 };

package/testaro/titledEl.js

@@ -20,7 +20,7 @@ const {doTest} = require('../procs/testaro');
 // FUNCTIONS
 
 // Runs the test and returns the result.
-exports.reporter = async (page, catalog, withItems) => {
+exports.reporter = async (page, report, _, withItems) => {
   const getBadWhat = element => {
     const elementType = element.tagName.toLowerCase();
     // Return a violation description.
@@ -29,6 +29,6 @@ exports.reporter = async (page, catalog, withItems) => {
   const selector = 'body [title]:not(iframe, link, style)';
   const whats = 'title attributes are used on elements they are likely ineffective on';
   return await doTest(
-    page, catalog, withItems, 'titledEl', selector, whats, 0, getBadWhat.toString()
+    page, report.catalog, withItems, 'titledEl', selector, whats, 0, getBadWhat.toString()
   );
 };

package/testaro/zIndex.js

@@ -20,7 +20,7 @@ const {doTest} = require('../procs/testaro');
 // FUNCTIONS
 
 // Runs the test and returns the result.
-exports.reporter = async (page, catalog, withItems) => {
+exports.reporter = async (page, report, _, withItems) => {
   const getBadWhat = element => {
     // Get whether the element violates the rule.
     const styleDec = window.getComputedStyle(element);
@@ -33,6 +33,6 @@ exports.reporter = async (page, catalog, withItems) => {
   };
   const whats = 'Elements have non-default Z indexes';
   return await doTest(
-    page, catalog, withItems, 'zIndex', 'body, body *', whats, 0, getBadWhat.toString()
+    page, report.catalog, withItems, 'zIndex', 'body, body *', whats, 0, getBadWhat.toString()
   );
 };

package/tests/testaro.js

@@ -459,14 +459,6 @@ process.on('unhandledRejection', reason => {
 
 // FUNCTIONS
 
-// Waits.
-const wait = ms => {
-  return new Promise(resolve => {
-    setTimeout(() => {
-      resolve('');
-    }, ms);
-  });
-};
 // Conducts and reports Testaro tests.
 exports.reporter = async (page, report, actIndex) => {
   const act = report.acts[actIndex];
@@ -578,13 +570,13 @@ exports.reporter = async (page, report, actIndex) => {
         browser.on('disconnected', disconnectHandler);
       }
       // Initialize an argument array for the reporter.
-      const ruleArgs = [page, report.catalog, withItems];
+      const ruleArgs = [page, report, actIndex, withItems];
       // If the rule needs a temporary directory:
       if (rule.needsTmpDir) {
         // Add its path to the argument array.
         ruleArgs.push(report.jobData.tmpDir);
       }
-      // If the rule has extra arguments:
+      // If the testaro test act specifies extra arguments for this rule:
       if (argRules?.includes(ruleResult.id)) {
         // Add them to the argument array.
         ruleArgs.push(... args[ruleResult.id]);