testaro 4.5.1 → 4.5.2

package/commands.js

@@ -146,7 +146,8 @@ exports.commands = {
     aatt: [
       'Perform an AATT test with HTML CodeSniffer',
       {
-        waitLong: [false, 'boolean', '', 'whether to wait 20 instead of 10 seconds for the result']
+        waitLong: [false, 'boolean', '', 'whether to wait 12 instead of 6 seconds for a result'],
+        tryLimit: [false, 'number', '', 'times to try the test before giving up; default 4']
       }
     ],
     axe: [

package/package.json

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

package/run.js

@@ -900,7 +900,7 @@ const doActs = async (report, actIndex, page) => {
             // Otherwise, if the act is a move:
             else if (moves[act.type]) {
               const selector = typeof moves[act.type] === 'string' ? moves[act.type] : act.what;
-              // Wait 10 seconds until the element to perform the move on is identified.
+              // Try up to 5 times, every 2 seconds, to identify the element to perform the move on.
               let matchResult = {success: false};
               let tries = 0;
               while (tries++ < 5 && ! matchResult.success) {

package/tests/aatt.js

@@ -7,31 +7,59 @@
 const {evaluate} = require('aatt');
 
 // FUNCTIONS
-exports.reporter = async (page, waitLong) => {
-  // Set the limit in seconds on the wait for the result.
-  const timeLimit = waitLong ? 20 : 10;
-  // Get the HTML of the document body.
-  const source = await page.content();
-  // Return the result of a test with the HTML CodeSniffer WCAG 2.1 AA ruleset as a string.
-  const report = evaluate({
-    source,
-    output: 'json',
-    engine: 'htmlcs',
-    level: 'WCAG2AA'
-  });
-  // Wait for it until the time limit expires.
-  let timeoutID;
-  const wait = new Promise(resolve => {
-    timeoutID = setTimeout(() => {
-      resolve('');
-    }, 1000 * timeLimit);
-  });
-  const resultIfFast = await Promise.race([report, wait]);
-  // If it arrived within the time limit:
-  if (resultIfFast) {
-    clearTimeout(timeoutID);
-    // Remove the non-JSON prefix and (if any) suffix from the string.
-    const reportJSON = resultIfFast.replace(/^.+?Object]\s+|\s+done\s*$/sg, '');
+// Recursively test a page with HTML CodeSniffer for WCAC 2.1 AAA.
+const retest = async (page, waitLong, triesLeft) => {
+  // If the limit on tries has not been exhausted:
+  if (triesLeft) {
+    // Set the limit in seconds on the wait for the result.
+    const timeLimit = waitLong ? 12 : 6;
+    // Get the HTML of the document body.
+    const source = await page.content();
+    // Return the result of a test with the HTML CodeSniffer WCAG 2.1 AA ruleset as a string.
+    const report = evaluate({
+      source,
+      output: 'json',
+      engine: 'htmlcs',
+      level: 'WCAG2AAA'
+    });
+    // Wait for it until the time limit expires.
+    let timeoutID;
+    const wait = new Promise(resolve => {
+      timeoutID = setTimeout(() => {
+        resolve('');
+      }, 1000 * timeLimit);
+    });
+    const result = await Promise.race([report, wait]);
+    // If it arrived within the time limit:
+    if (result) {
+      clearTimeout(timeoutID);
+      // Return the result as JSON.
+      const reportJSON = result.replace(/^.+?Object.?\s+|\s+done\s*$/sg, '');
+      return {
+        triesLeft,
+        reportJSON
+      };
+    }
+    else {
+      console.log(`ERROR: Test aatt timed out at ${timeLimit} seconds; tries left: ${triesLeft - 1}`);
+      return retest(page, waitLong, --triesLeft);
+    }
+  }
+  // Otherwise, i.e. if the limit on tries has been exhausted:
+  else {
+    // Return this.
+    return {
+      triesLeft,
+      reportJSON: ''
+    };
+  }
+};
+exports.reporter = async (page, waitLong, tryLimit = 4) => {
+  // Try the test up to the limit on tries.
+  const result = await retest(page, waitLong, tryLimit);
+  const {triesLeft, reportJSON} = result;
+  // If any try succeeded:
+  if (reportJSON) {
     try {
       // Convert the JSON string to an array.
       const issueArray = JSON.parse(reportJSON);
@@ -49,10 +77,18 @@ exports.reporter = async (page, waitLong) => {
           .join('+');
         }
       });
-      return {result: nonNotices};
+      return {
+        result: {
+          report: nonNotices,
+          triesLeft
+        }
+      };
     }
     catch (error) {
       console.log(`ERROR processing AATT report (${error.message})`);
+      console.log(
+        `JSON report starts with ${reportJSON.slice(0, 50)} and ends with ${reportJSON.slice(-50)}`
+      );
       return {
         result: {
           prevented: true,
@@ -61,14 +97,15 @@ exports.reporter = async (page, waitLong) => {
       };
     }
   }
-  // Otherwise, i.e. if the result did not arrive within the time limit:
+  // Otherwise, i.e. if the limit on tries was exhausted:
   else {
     // Report the failure.
-    console.log('ERROR: getting report took too long');
+    const error = 'ERROR: Getting AATT report took too long';
+    console.log(error);
     return {
       result: {
         prevented: true,
-        error: 'ERROR: getting AATT report took too long'
+        error
       }
     };
   }