testaro 60.16.2 → 60.18.0

package/tests/testaro.js

@@ -15,12 +15,8 @@
 
 // IMPORTS
 
-// Module to perform common operations.
-const {init, getRuleResult} = require('../procs/testaro');
 // Function to launch a browser.
 const {launch} = require('../run');
-// Module to handle files.
-const fs = require('fs/promises');
 
 // CONSTANTS
 
@@ -44,7 +40,7 @@ const allRules = [
     id: 'allCaps',
     what: 'leaf elements with entirely upper-case text longer than 7 characters',
     launchRole: 'sharer',
-    timeOut: 10,
+    timeOut: 5,
     defaultOn: true
   },
   {
@@ -114,14 +110,14 @@ const allRules = [
     id: 'distortion',
     what: 'distorted text',
     launchRole: 'sharer',
-    timeOut: 10,
+    timeOut: 5,
     defaultOn: true
   },
   {
     id: 'docType',
     what: 'document without a doctype property',
     launchRole: 'sharer',
-    timeOut: 10,
+    timeOut: 5,
     defaultOn: true
   },
   {
@@ -170,7 +166,7 @@ const allRules = [
     id: 'labClash',
     what: 'labeling inconsistencies',
     launchRole: 'sharer',
-    timeOut: 10,
+    timeOut: 5,
     defaultOn: true
   },
   {
@@ -184,14 +180,14 @@ const allRules = [
     id: 'lineHeight',
     what: 'text with a line height less than 1.5 times its font size',
     launchRole: 'sharer',
-    timeOut: 10,
+    timeOut: 5,
     defaultOn: true
   },
   {
     id: 'linkAmb',
     what: 'links with identical texts but different destinations',
     launchRole: 'sharer',
-    timeOut: 50,
+    timeOut: 20,
     defaultOn: true
   },
   {
@@ -208,13 +204,6 @@ const allRules = [
     timeOut: 5,
     defaultOn: true
   },
-  {
-    id: 'linkTitle',
-    what: 'links with title attributes repeating text content',
-    launchRole: 'sharer',
-    timeOut: 10,
-    defaultOn: true
-  },
   {
     id: 'linkTo',
     what: 'links without destinations',
@@ -226,7 +215,7 @@ const allRules = [
     id: 'linkUl',
     what: 'missing underlines on inline links',
     launchRole: 'sharer',
-    timeOut: 10,
+    timeOut: 5,
     defaultOn: true
   },
   {
@@ -275,7 +264,7 @@ const allRules = [
     id: 'role',
     what: 'native-replacing explicit roles',
     launchRole: 'sharer',
-    timeOut: 5,
+    timeOut: 20,
     defaultOn: true
   },
   {
@@ -303,7 +292,7 @@ const allRules = [
     id: 'textSem',
     what: 'semantically vague elements i, b, and/or small',
     launchRole: 'sharer',
-    timeOut: 10,
+    timeOut: 5,
     defaultOn: true
   },
   {
@@ -387,7 +376,7 @@ const allRules = [
     id: 'hover',
     what: 'hover-caused content changes',
     launchRole: 'waster',
-    timeOut: 300,
+    timeOut: 20,
     defaultOn: true
   },
   {
@@ -428,24 +417,6 @@ process.on('unhandledRejection', reason => {
 
 // FUNCTIONS
 
-// Conducts a JSON-defined test.
-const jsonTest = async (ruleID, ruleArgs) => {
-  const [page, withItems] = ruleArgs;
-  // Get the rule definition.
-  const ruleJSON = await fs.readFile(`${__dirname}/../testaro/${ruleID}.json`, 'utf8');
-  const ruleObj = JSON.parse(ruleJSON);
-  // Initialize the locators and result.
-  const all = await init(100, page, ruleObj.selector);
-  all.locs = all.allLocs;
-  // Populate and return the result.
-  const whats = [
-    ruleObj.complaints.instance,
-    ruleObj.complaints.summary
-  ];
-  return await getRuleResult(
-    withItems, all, ruleObj.ruleID, whats, ruleObj.ordinalSeverity, ruleObj.summaryTagName
-  );
-};
 // Waits.
 const wait = ms => {
   return new Promise(resolve => {
@@ -547,158 +518,136 @@ exports.reporter = async (page, report, actIndex) => {
       };
       browser.on('disconnected', disconnectHandler);
     }
-    // Initialize an argument array for reporter or jsonTest.
+    // Initialize an argument array for the reporter.
     const ruleArgs = [page, withItems];
-    const ruleFileNames = await fs.readdir(`${__dirname}/../testaro`);
-    const isJS = ruleFileNames.includes(`${ruleID}.js`);
-    const isJSON = ruleFileNames.includes(`${ruleID}.json`);
-    // If the rule is defined with JavaScript or JSON but not both:
-    if ((isJS || isJSON) && ! (isJS && isJSON)) {
-      // If with JavaScript and it has extra arguments:
-      if (isJS && argRules && argRules.includes(ruleID)) {
-        // Add them to the argument array.
-        ruleArgs.push(... args[ruleID]);
-      }
-      result[ruleID] ??= {};
-      const ruleResult = result[ruleID];
-      const {what} = rule;
-      ruleResult.what = what || '';
-      const startTime = Date.now();
-      let timeout;
-      let testRetries = 2;
-      let testSuccess = false;
-      while (testRetries > 0 && ! testSuccess) {
-        try {
-          // Apply a time limit to the test.
-          const timeLimit = 1000 * timeoutMultiplier * rule.timeOut;
-          // If the time limit expires during the test:
-          const timer = new Promise(resolve => {
-            timeout = setTimeout(() => {
-              // Add data about the test, including its prevention, to the result.
-              const endTime = Date.now();
-              testTimes.push([rule, Math.round((endTime - startTime) / 1000)]);
-              data.rulePreventions.push(ruleID);
-              data.rulePreventionMessages[ruleID] = 'Timeout';
-              ruleResult.totals = [0, 0, 0, 0];
-              ruleResult.standardInstances = [];
-              console.log(`ERROR: Test of testaro rule ${ruleID} timed out`);
-              resolve({timedOut: true});
-            }, timeLimit);
-          });
-          // Perform the test, subject to the time limit.
-          const ruleReport = isJS
-            ? require(`../testaro/${ruleID}`).reporter(... ruleArgs)
-            : jsonTest(ruleID, ruleArgs);
-          // Get the test result or a timeout result.
-          const ruleOrTimeoutReport = await Promise.race([timer, ruleReport]);
-          // If the test was completed:
-          if (! ruleOrTimeoutReport.timedOut) {
-            // Add data from the test to the result.
+    // If the rule has extra arguments:
+    if (argRules && argRules.includes(ruleID)) {
+      // Add them to the argument array.
+      ruleArgs.push(... args[ruleID]);
+    }
+    result[ruleID] ??= {};
+    const ruleResult = result[ruleID];
+    const {what} = rule;
+    ruleResult.what = what || '';
+    const startTime = Date.now();
+    let timeout;
+    let testRetries = 2;
+    let testSuccess = false;
+    // Until all permitted retries are exhausted or the test succeeds:
+    while (testRetries > 0 && ! testSuccess) {
+      try {
+        // Apply a time limit to the test.
+        const timeLimit = 1000 * timeoutMultiplier * rule.timeOut;
+        // If the time limit expires during the test:
+        const timer = new Promise(resolve => {
+          timeout = setTimeout(() => {
+            // Add data about the test, including its prevention, to the result.
             const endTime = Date.now();
-            testTimes.push([ruleID, Math.round((endTime - startTime) / 1000)]);
-            Object.keys(ruleOrTimeoutReport).forEach(key => {
-              ruleResult[key] = ruleOrTimeoutReport[key];
-            });
-            // If the test was prevented:
-            if (ruleResult.data?.prevented && ruleResult.data.error) {
-              // Add this to the result.
-              data.rulePreventions.push(ruleID);
-              data.rulePreventionMessages[ruleID] = ruleResult.data.error;
-            }
-            // If the result includes totals:
-            if (ruleResult.totals) {
-              // Round them.
-              ruleResult.totals = ruleResult.totals.map(total => Math.round(total));
-            }
-            // Prevent a retry of the test.
-            testSuccess = true;
-            // If testing is to stop after a failure and the page failed the test:
-            if (stopOnFail && ruleResult.totals && ruleResult.totals.some(total => total)) {
-              // Stop testing.
-              break;
-            }
-          }
-          // Otherwise, i.e. if the test timed out:
-          else {
-            // Report this.
+            testTimes.push([rule, Math.round((endTime - startTime) / 1000)]);
             data.rulePreventions.push(ruleID);
             data.rulePreventionMessages[ruleID] = 'Timeout';
-            // Stop retrying the test.
+            ruleResult.totals = [0, 0, 0, 0];
+            ruleResult.standardInstances = [];
+            console.log(`ERROR: Test of testaro rule ${ruleID} timed out`);
+            resolve({timedOut: true});
+          }, timeLimit);
+        });
+        // Perform the test, subject to the time limit.
+        const ruleReport = require(`../testaro/${ruleID}`).reporter(... ruleArgs);
+        // Get the test result or a timeout result.
+        const ruleOrTimeoutReport = await Promise.race([timer, ruleReport]);
+        // If the test was completed:
+        if (! ruleOrTimeoutReport.timedOut) {
+          // Add data from the test to the result.
+          const endTime = Date.now();
+          testTimes.push([ruleID, Math.round((endTime - startTime) / 1000)]);
+          Object.keys(ruleOrTimeoutReport).forEach(key => {
+            ruleResult[key] = ruleOrTimeoutReport[key];
+          });
+          // If the test was prevented:
+          if (ruleResult.data?.prevented && ruleResult.data.error) {
+            // Add this to the result.
+            data.rulePreventions.push(ruleID);
+            data.rulePreventionMessages[ruleID] = ruleResult.data.error;
+          }
+          // If the result includes totals:
+          if (ruleResult.totals) {
+            // Round them.
+            ruleResult.totals = ruleResult.totals.map(total => Math.round(total));
+          }
+          // Prevent a retry of the test.
+          testSuccess = true;
+          // If testing is to stop after a failure and the page failed the test:
+          if (stopOnFail && ruleResult.totals && ruleResult.totals.some(total => total)) {
+            // Stop testing.
             break;
           }
         }
-        // If an error is thrown by the test:
-        catch(error) {
-          const isPageClosed = ['closed', 'Protocol error', 'Target page'].some(phrase =>
-            error.message.includes(phrase)
+        // Otherwise, i.e. if the test timed out:
+        else {
+          // Report this.
+          data.rulePreventions.push(ruleID);
+          data.rulePreventionMessages[ruleID] = 'Timeout';
+          // Stop retrying the test.
+          break;
+        }
+      }
+      // If an error is thrown by the test:
+      catch(error) {
+        const isPageClosed = ['closed', 'Protocol error', 'Target page'].some(phrase =>
+          error.message.includes(phrase)
+        );
+        // If the page has closed and there are retries left:
+        if (isPageClosed && testRetries) {
+          // Report this and decrement the allowed retry count.
+          console.log(
+            `WARNING: Retry ${3 - testRetries--} of test ${ruleID} starting after page closed`
           );
-          // If the page has closed and there are retries left:
-          if (isPageClosed && testRetries) {
-            // Report this and decrement the allowed retry count.
-            console.log(
-              `WARNING: Retry ${3 - testRetries--} of test ${ruleID} starting after page closed`
-            );
-            await wait(2000);
-            // Replace the browser and the page in the run module and navigate to the target.
-            await launch(
-              report,
-              actIndex,
-              headEmulation,
-              report.browserID,
-              url
-            );
-            page = require('../run').page;
-            // If the page replacement failed:
-            if (! page) {
-              // Report this.
-              console.log(`ERROR: Browser relaunch to retry test ${ruleID} failed`);
-              data.rulePreventions.push(ruleID);
-              data.rulePreventionMessages[ruleID] = 'Retry failure due to browser relaunch failure';
-              // Stop retrying the test.
-              break;
-            }
-            // Update the rule arguments with the current page.
-            ruleArgs[0] = page;
-          }
-          // Otherwise, i.e. if the page is open or it is closed but no retries are left:
-          else {
-            // Treat the test as prevented.
+          await wait(2000);
+          // Replace the browser and the page in the run module and navigate to the target.
+          await launch(
+            report,
+            actIndex,
+            headEmulation,
+            report.browserID,
+            url
+          );
+          page = require('../run').page;
+          // If the page replacement failed:
+          if (! page) {
+            // Report this.
+            console.log(`ERROR: Browser relaunch to retry test ${ruleID} failed`);
             data.rulePreventions.push(ruleID);
-            data.rulePreventionMessages[ruleID] = error.message;
-            console.log(`ERROR: Test of testaro rule ${ruleID} prevented (${error.message})`);
-            // Do not retry the test even if retries are left.
+            data.rulePreventionMessages[ruleID] = 'Retry failure due to browser relaunch failure';
+            // Stop retrying the test.
             break;
           }
+          // Update the rule arguments with the current page.
+          ruleArgs[0] = page;
         }
-        finally {
-          // Clear the timeout.
-          clearTimeout(timeout);
+        // Otherwise, i.e. if the page is open or it is closed but no retries are left:
+        else {
+          // Treat the test as prevented.
+          data.rulePreventions.push(ruleID);
+          data.rulePreventionMessages[ruleID] = error.message;
+          console.log(`ERROR: Test of testaro rule ${ruleID} prevented (${error.message})`);
+          // Do not retry the test even if retries are left.
+          break;
         }
       }
-      // Clear the error listeners.
-      if (page && ! page.isClosed() && crashHandler) {
-        page.off('crash', crashHandler);
-        crashHandler = null;
-      }
-      if (browser && disconnectHandler) {
-        browser.off('disconnected', disconnectHandler);
-        disconnectHandler = null;
+      finally {
+        // Clear the timeout.
+        clearTimeout(timeout);
       }
     }
-    // Otherwise, i.e. if the rule is undefined or doubly defined:
-    else {
-      // Report this.
-      data.rulesInvalid.push(rule);
-      console.log(`ERROR: Rule ${rule.id} not validly defined`);
-      // Clear the crash listener.
-      if (page && ! page.isClosed() && crashHandler) {
-        page.off('crash', crashHandler);
-        crashHandler = null;
-      }
-      if (browser && disconnectHandler) {
-        browser.off('disconnected', disconnectHandler);
-        disconnectHandler = null;
-      }
+    // Clear the error listeners.
+    if (page && ! page.isClosed() && crashHandler) {
+      page.off('crash', crashHandler);
+      crashHandler = null;
+    }
+    if (browser && disconnectHandler) {
+      browser.off('disconnected', disconnectHandler);
+      disconnectHandler = null;
     }
     // Force a garbage collection.
     try {

package/data/template.js

@@ -1,39 +0,0 @@
-/*
-  © 2023 CVS Health and/or one of its affiliates. All rights reserved.
-
-  Licensed under the MIT License. See LICENSE file at the project root or
-  https://opensource.org/license/mit/ for details.
-
-  SPDX-License-Identifier: MIT
-*/
-
-/*
-  template
-  This test reports ….
-*/
-
-// ########## 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(100, page, 'body a');
-  // For each locator:
-  for (const loc of all.allLocs) {
-    // Get whether its element violates the rule.
-    const isBad = await loc.evaluate(el => el.tabIndex !== 0);
-    // If it does:
-    if (isBad) {
-      // Add the locator to the array of violators.
-      all.locs.push(loc);
-    }
-  }
-  // Populate and return the result.
-  const whats = ['Itemized description', 'Summary description'];
-  return await report(withItems, all, 'ruleID', whats, 0);
-};

package/testaro/hr.json

@@ -1,10 +0,0 @@
-{
-  "ruleID": "hr",
-  "selector": "body hr",
-  "complaints": {
-    "instance": "Element instead of styling is used for vertical segmentation",
-    "summary": "Elements instead of styling are used for vertical segmentation"
-  },
-  "ordinalSeverity": 0,
-  "summaryTagName": "HR"
-}

package/testaro/linkExt.json

@@ -1,10 +0,0 @@
-{
-  "ruleID": "linkExt",
-  "selector": "a[target=_blank]",
-  "complaints": {
-    "instance": "Link has a target=_blank attribute",
-    "summary": "Links have target=_blank attributes"
-  },
-  "ordinalSeverity": 0,
-  "summaryTagName": "A"
-}

package/testaro/linkOldAtt.json

@@ -1,10 +0,0 @@
-{
-  "ruleID": "linkOldAtt",
-  "selector": "a[charset], a[coords], a[name], a[rev], a[shape]",
-  "complaints": {
-    "instance": "Element has a deprecated attribute",
-    "summary": "Links have deprecated attributes"
-  },
-  "ordinalSeverity": 1,
-  "summaryTagName": "A"
-}

package/testaro/linkTitle.js

@@ -1,46 +0,0 @@
-/*
-  © 2023 CVS Health and/or one of its affiliates. All rights reserved.
-  © 2025 Jonathan Robert Pool.
-
-  Licensed under the MIT License. See LICENSE file at the project root or
-  https://opensource.org/license/mit/ for details.
-
-  SPDX-License-Identifier: MIT
-*/
-
-/*
-  linkTitle
-  Related to Tenon rule 79.
-  This test reports links with title attributes whose values the link text contains.
-*/
-
-// ########## IMPORTS
-
-// Module to perform common operations.
-const {simplify} = require('../procs/testaro');
-// Module to get locator data.
-const {getLocatorData} = require('../procs/getLocatorData');
-
-// ########## FUNCTIONS
-
-// Runs the test and returns the result.
-exports.reporter = async (page, withItems) => {
-  // Specify the rule.
-  const ruleData = {
-    ruleID: 'linkTitle',
-    selector: 'a[title]',
-    pruner: async loc => {
-      const elData = await getLocatorData(loc);
-      const title = await loc.getAttribute('title');
-      return elData.excerpt.toLowerCase().includes(title.toLowerCase());
-    },
-    complaints: {
-      instance: 'Link has a title attribute that repeats link text content',
-      summary: 'Links have title attributes that repeat link text contents'
-    },
-    ordinalSeverity: 0,
-    summaryTagName: 'A'
-  };
-  // Run the test and return the result.
-  return await simplify(page, withItems, ruleData);
-};

package/testaro/linkTo.json

@@ -1,10 +0,0 @@
-{
-  "ruleID": "linkTo",
-  "selector": "a:not([href]):visible",
-  "complaints": {
-    "instance": "Element has no href attribute",
-    "summary": "Links are missing href attributes"
-  },
-  "ordinalSeverity": 2,
-  "summaryTagName": "A"
-}

package/testaro/pseudoP.json

@@ -1,10 +0,0 @@
-{
-  "ruleID": "pseudoP",
-  "selector": "body br + br",
-  "complaints": {
-    "instance": "br element follows another br element, likely acting as a pseudo-paragraph",
-    "summary": "br elements follow other br elements, likely acting as pseudo-paragraphs"
-  },
-  "ordinalSeverity": 0,
-  "summaryTagName": "BR"
-}

package/testaro/titledEl.json

@@ -1,10 +0,0 @@
-{
-  "ruleID": "titledEl",
-  "selector": "[title]:not(button, iframe, input, link, select, textarea)",
-  "complaints": {
-    "instance": "Ineligible element has a title attribute",
-    "summary": "Ineligible elements have title attributes"
-  },
-  "ordinalSeverity": 2,
-  "summaryTagName": ""
-}