testaro 40.0.2 → 41.0.0

package/actSpecs.js

@@ -54,9 +54,9 @@ exports.actSpecs = {
     launch: [
       'Launch a Playwright browser',
       {
-        which: [true, 'string', 'isBrowserType', 'chromium, firefox, or webkit'],
-        url: [true, 'string', 'isURL', 'initial URL to navigate to'],
-        deviceID: [false, 'string', '', 'Playwright device ID if not default, e.g. iPhone 6 landscape'],
+        url: [false, 'string', 'isURL', 'initial URL to navigate to'],
+        deviceID: [false, 'string', 'isDeviceID', 'Playwright device ID if not default, e.g. iPhone 6 landscape'],
+        browserID: [false, 'string', 'isBrowserID', 'chromium, firefox, or webkit if not job default'],
         lowMotion: [false, 'boolean', '', 'set reduced-motion option if true'],
         what: [false, 'string', 'hasLength', 'comment']
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaro",
-  "version": "40.0.2",
+  "version": "41.0.0",
   "description": "Run 1000 web accessibility tests from 10 tools and get a standardized report",
   "main": "index.js",
   "scripts": {

package/procs/device.js

@@ -0,0 +1,59 @@
+/*
+  © 2024 CVS Health and/or one of its affiliates. All rights reserved.
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all
+  copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  SOFTWARE.
+*/
+
+// device
+
+// IMPORTS
+
+const {devices} = require('playwright');
+
+// FUNCTIONS
+
+// Returns whether a device ID is valid.
+exports.isDeviceID = deviceID => deviceID === 'default' || !! devices[deviceID];
+
+// Returns options for the browser.newContext() function.
+exports.getDeviceOptions = (deviceID, motion) => {
+  const options = {
+    reduceMotion: motion
+  };
+  // If a non-default device was specified:
+  if (deviceID && deviceID !== 'default') {
+    // Get its properties if it exists.
+    const deviceProperties = devices[deviceID];
+    // Return options or report the device as invalid.
+    if (deviceProperties) {
+      return {
+        ... options,
+        ... deviceProperties
+      };
+    }
+    else {
+      return {};
+    }
+  }
+  // Otherwise, i.e. if no non-default device was specified:
+  else {
+    // Return options.
+    return options;
+  }
+};

package/procs/standardize.js

@@ -40,6 +40,8 @@ const cap = rawString => {
     return '';
   }
 };
+// Returns whether an id attribute value is valid without character escaping.
+const isBadID = id => /[^-\w]|^\d|^--|^-\d/.test(id);
 // Returns the tag name and the value of an id attribute from a substring of HTML code.
 const getIdentifiers = code => {
   let tagName = '';
@@ -47,7 +49,7 @@ const getIdentifiers = code => {
   // If the substring includes the start tag of an element:
   if (code && typeof code === 'string' && code.length && /<\s*[a-zA-Z]/.test(code)) {
     // Get the first start tag in the substring.
-    const startTag = code.replace(/^.*?<(?=[a-zA-Z])/s, '').replace(/>.*$/s, '').trim();
+    const startTag = code.replace(/^.*?<(?=[a-zA-Z])/s, '').replace(/[^a-zA-Z].*$/gs, '').trim();
     // If it exists:
     if (startTag && startTag.length) {
       // Get its tag name, upper-cased.
@@ -57,6 +59,11 @@ const getIdentifiers = code => {
       if (idArray && idArray.length === 2) {
         id = idArray[1];
       }
+      // If the id value is invalid without character escaping:
+      if (isBadID(id)) {
+        // Remove it.
+        id = '';
+      }
     }
   }
   return [tagName, id];
@@ -207,7 +214,7 @@ const doHTMLCS = (result, standardResult, severity) => {
             what,
             ordinalSeverity: ['Warning', '', '', 'Error'].indexOf(severity),
             tagName: tagName.toUpperCase(),
-            id: id.slice(1),
+            id: isBadID(id.slice(1)) ? '' : id.slice(1),
             location: {
               doc: 'dom',
               type: '',
@@ -317,7 +324,7 @@ const doWAVE = (result, standardResult, categoryName) => {
           if (finalTerm.includes('#')) {
             const finalArray = finalTerm.split('#');
             tagName = finalArray[0].replace(/:.*/, '');
-            id = finalArray[1];
+            id = isBadID(finalArray[1]) ? '' : finalArray[1];
           }
           else {
             tagName = finalTerm.replace(/:.*/, '');
@@ -450,14 +457,16 @@ const convert = (toolName, data, result, standardResult) => {
               if (! tagName && finalRuleID.endsWith('_svg')) {
                 tagName = 'SVG';
               }
-              const excerpt = ruleResult.element && ruleResult.element.html || '';
+              const excerpt = ruleResult.element && ruleResult.element.html.replace(/\s+/g, ' ')
+              || '';
               if (! tagName && /^<[a-z]+[ >]/.test(excerpt)) {
-                tagName = excerpt.slice(1).replace(/[ >]+/, '').toUpperCase();
+                tagName = excerpt.slice(1).replace(/[ >].+/, '').toUpperCase();
               }
               const idDraft = excerpt && excerpt.replace(/^[^[>]+id="/, 'id=').replace(/".*$/, '');
-              const id = idDraft && idDraft.length > 3 && idDraft.startsWith('id=')
+              const idFinal = idDraft && idDraft.length > 3 && idDraft.startsWith('id=')
                 ? idDraft.slice(3)
                 : '';
+              const id = idFinal === '' || isBadID(idFinal) ? '' : idFinal;
               const instance = {
                 ruleID: finalRuleID,
                 what,
@@ -513,7 +522,7 @@ const convert = (toolName, data, result, standardResult) => {
           what,
           ordinalSeverity: 0,
           tagName,
-          id,
+          id: isBadID(id) ? '' : id,
           location: {
             doc: 'dom',
             type: 'box',
@@ -567,7 +576,6 @@ const convert = (toolName, data, result, standardResult) => {
     if (result.rawPage) {
       doNuVal(result, standardResult, 'rawPage');
     }
-    const {instances} = standardResult;
   }
   // qualWeb
   else if (

package/run.js

@@ -37,6 +37,8 @@ const {standardize} = require('./procs/standardize');
 const {identify} = require('./procs/identify');
 // Module to send a notice to an observer.
 const {tellServer} = require('./procs/tellServer');
+// Module to get device options.
+const {getDeviceOptions, isDeviceID} = require('./procs/device');
 
 // ########## CONSTANTS
 
@@ -103,7 +105,7 @@ let requestedURL = '';
 // ########## VALIDATORS
 
 // Validates a browser type.
-const isBrowserType = type => ['chromium', 'firefox', 'webkit'].includes(type);
+const isBrowserID = type => ['chromium', 'firefox', 'webkit'].includes(type);
 // Validates a load state.
 const isState = string => ['loaded', 'idle'].includes(string);
 // Validates a URL.
@@ -146,8 +148,11 @@ const hasSubtype = (variable, subtype) => {
     else if (subtype === 'isURL') {
       return isURL(variable);
     }
-    else if (subtype === 'isBrowserType') {
-      return isBrowserType(variable);
+    else if (subtype === 'isDeviceID') {
+      return isDeviceID(variable);
+    }
+    else if (subtype === 'isBrowserID') {
+      return isBrowserID(variable);
     }
     else if (subtype === 'isFocusable') {
       return isFocusable(variable);
@@ -179,7 +184,7 @@ const hasSubtype = (variable, subtype) => {
     return true;
   }
 };
-// Validates an act.
+// Validates an act by reference to actSpecs.js.
 const isValidAct = act => {
   // Identify the type of the act.
   const type = act.type;
@@ -250,60 +255,78 @@ const dateOf = timeStamp => {
 const isValidReport = report => {
   if (report) {
     // Return whether the report is valid.
-    const {id, what, strict, timeLimit, acts, sources, creationTimeStamp, timeStamp} = report;
+    const {
+      id,
+      strict,
+      isolate,
+      standard,
+      observe,
+      deviceID,
+      browserID,
+      lowMotion,
+      timeLimit,
+      creationTimeStamp,
+      executionTimeStamp,
+      sources,
+      acts
+    } = report;
     if (! id || typeof id !== 'string') {
       return 'Bad report ID';
     }
-    if (! what || typeof what !== 'string') {
-      return 'Bad report what';
-    }
     if (typeof strict !== 'boolean') {
       return 'Bad report strict';
     }
-    if (typeof timeLimit !== 'number' || timeLimit < 1) {
-      return 'Bad report time limit';
+    if (typeof isolate !== 'boolean') {
+      return 'Bad report isolate';
     }
-    if (! acts || ! Array.isArray(acts) || ! acts.length) {
-      return 'Bad report acts';
+    if (! ['also', 'only', 'no'].includes(standard)) {
+      return 'Bad report standard';
     }
-    if (! acts.every(act => act.type && typeof act.type === 'string')) {
-      return 'Act with no type';
+    if (typeof observe !== 'boolean') {
+      return 'Bad report observe';
     }
-    if (acts[0].type !== 'launch') {
-      return 'First act type not launch';
+    if (! isDeviceID(deviceID)) {
+      return 'Bad report deviceID';
     }
-    if (! ['chromium', 'webkit', 'firefox'].includes(acts[0].which)) {
-      return 'Bad first act which';
+    if (! ['chromium', 'firefox', 'webkit'].includes(browserID)) {
+      return 'Bad report browserID';
     }
-    if (acts[0].type !== 'launch' || (
-      (
-        ! acts[0].url
-        || typeof acts[0].url !== 'string'
-        || ! isURL(acts[0].url)
-      )
-      && (
-        acts[1].type !== 'url'
-        || ! acts[1].which
-        || typeof acts[1].which !== 'string'
-        || ! isURL(acts[1].which)
-      )
-    )) {
-      return 'First or second act has no valid URL';
+    if (typeof lowMotion !== 'boolean') {
+      return 'Bad report lowMotion';
     }
-    const invalidAct = acts.find(act => ! isValidAct(act));
-    if (invalidAct) {
-      return `Invalid act:\n${JSON.stringify(invalidAct, null, 2)}`;
+    if (typeof timeLimit !== 'number' || timeLimit < 1) {
+      return 'Bad report timeLimit';
+    }
+    if (
+      ! (creationTimeStamp && typeof creationTimeStamp === 'string' && dateOf(creationTimeStamp))
+    ) {
+      return 'bad job creationTimeStamp';
+    }
+    if (
+      ! (executionTimeStamp && typeof executionTimeStamp === 'string') && dateOf(executionTimeStamp)
+    ) {
+      return 'bad report executionTimeStamp';
     }
-    if (! sources || typeof sources !== 'object') {
+    if (
+      ! sources
+      || typeof sources !== 'object'
+      || ! ['script', 'batch', 'target'].every(key => sources[key])
+      || ! ['what', 'url'].every(key => sources.target[key])
+    ) {
       return 'Bad report sources';
     }
     if (
-      ! (creationTimeStamp && typeof creationTimeStamp === 'string' && dateOf(creationTimeStamp))
+      ! acts
+      || ! Array.isArray(acts)
+      || acts.length < 2
+      || ! acts.every(act => act.type && typeof act.type === 'string')
+      || acts[0].type !== 'launch'
     ) {
-      return 'bad job creation time stamp';
+      return 'Bad report acts';
     }
-    if (! (timeStamp && typeof timeStamp === 'string')) {
-      return 'bad report time stamp';
+    const invalidAct = acts.find(act => ! isValidAct(act));
+    if (invalidAct) {
+      return `Invalid act:\n${JSON.stringify(invalidAct, null, 2)}`;
     }
     return '';
   }
@@ -409,27 +432,28 @@ const browserClose = async () => {
   }
 };
 // Launches a browser, navigates to a URL, and returns browser data.
-const launch = async (
-  report, typeName, url, debug, waits, deviceID = 'default', device, motion = 'no-preference'
-) => {
+const launch = async (report, url, debug, waits, deviceID, browserID, lowMotion) => {
+  // Get the default arguments.
+  url ??= report.url;
+  deviceID ??= report.deviceID;
+  browserID ??= report.browserID;
+  lowMotion ??= report.lowMotion;
   // If the specified browser type exists:
-  const browserType = require('playwright')[typeName];
-  if (browserType !== 'default') {
+  if (! browserID || ['chromium', 'firefox', 'webkit'].includes(browserID)) {
+    // Create a browser of the specified or default type.
+    const browserType = require('playwright')[browserID || report.browserID];
     // Close the current browser, if any.
     await browserClose();
-    // Launch a browser of the specified type.
+    // Define browser options.
     const browserOptions = {
       logger: {
         isEnabled: () => false,
         log: (name, severity, message) => console.log(message.slice(0, 100))
       }
     };
-    if (debug) {
-      browserOptions.headless = false;
-    }
-    if (waits) {
-      browserOptions.slowMo = waits;
-    }
+    browserOptions.headless = ! debug;
+    browserOptions.slowMo = waits || 0;
+    // Launch the browser.
     browser = await browserType.launch(browserOptions)
     // If the launch failed:
     .catch(async error => {
@@ -440,135 +464,132 @@ const launch = async (
         error: 'Browser launch failed'
       };
     });
-    // If a non-default device was specified:
-    let options = {
-      reduceMotion: motion
-    };
-    if (deviceID && deviceID !== 'default') {
-      // Get its properties.
-      const {devices} = require('playwright');
-      const deviceProperties = devices[deviceID];
-      if (deviceProperties) {
-        options = {
-          ... options,
-          ... deviceProperties
-        };
-      }
-      else {
-        console.log(`ERROR: Device ${deviceID} does not exist`);
-      }
-    }
-    // Open a context (i.e. browser tab), with reduced motion if specified.
-    const browserContext = await browser.newContext(options);
-    // Prevent default timeouts.
-    browserContext.setDefaultTimeout(0);
-    // When a page (i.e. browser tab) is added to the browser context (i.e. browser window):
-    browserContext.on('page', async page => {
-      // Ensure the report has a jobData property.
-      report.jobData ??= {};
-      report.jobData.logCount ??= 0;
-      report.jobData.logSize ??= 0;
-      report.jobData.errorLogCount ??= 0;
-      report.jobData.deviceID ??= deviceID;
-      report.jobData.browserTabOptions ??= options;
-      // Add any error events to the count of logging errors.
-      page.on('crash', () => {
-        report.jobData.errorLogCount++;
-        console.log('Page crashed');
-      });
-      page.on('pageerror', () => {
-        report.jobData.errorLogCount++;
-      });
-      page.on('requestfailed', () => {
-        report.jobData.errorLogCount++;
-      });
-      // If the page emits a message:
-      page.on('console', msg => {
-        const msgText = msg.text();
-        let indentedMsg = '';
-        // If debugging is on:
-        if (debug) {
-          // Log a summary of the message on the console.
-          const parts = [msgText.slice(0, 75)];
-          if (msgText.length > 75) {
-            parts.push(msgText.slice(75, 150));
-            if (msgText.length > 150) {
-              const tail = msgText.slice(150).slice(-150);
-              if (msgText.length > 300) {
-                parts.push('...');
-              }
-              parts.push(tail.slice(0, 75));
-              if (tail.length > 75) {
-                parts.push(tail.slice(75));
+    // Get the device options for a new context.
+    const deviceOptions = getDeviceOptions(
+      deviceID || 'default', lowMotion ? 'reduce-motion' : 'no-preference'
+    );
+    // If the device is valid:
+    if (deviceOptions) {
+      // Open a context (i.e. browser tab), with reduced motion if specified.
+      const browserContext = await browser.newContext(deviceOptions);
+      // Prevent default timeouts.
+      browserContext.setDefaultTimeout(0);
+      // When a page (i.e. browser tab) is added to the browser context (i.e. browser window):
+      browserContext.on('page', async page => {
+        // Ensure the report has a jobData property.
+        report.jobData ??= {};
+        report.jobData.logCount ??= 0;
+        report.jobData.logSize ??= 0;
+        report.jobData.errorLogCount ??= 0;
+        report.jobData.browserTabOptions ??= deviceOptions;
+        // Add any error events to the count of logging errors.
+        page.on('crash', () => {
+          report.jobData.errorLogCount++;
+          console.log('Page crashed');
+        });
+        page.on('pageerror', () => {
+          report.jobData.errorLogCount++;
+        });
+        page.on('requestfailed', () => {
+          report.jobData.errorLogCount++;
+        });
+        // If the page emits a message:
+        page.on('console', msg => {
+          const msgText = msg.text();
+          let indentedMsg = '';
+          // If debugging is on:
+          if (debug) {
+            // Log a summary of the message on the console.
+            const parts = [msgText.slice(0, 75)];
+            if (msgText.length > 75) {
+              parts.push(msgText.slice(75, 150));
+              if (msgText.length > 150) {
+                const tail = msgText.slice(150).slice(-150);
+                if (msgText.length > 300) {
+                  parts.push('...');
+                }
+                parts.push(tail.slice(0, 75));
+                if (tail.length > 75) {
+                  parts.push(tail.slice(75));
+                }
               }
             }
+            indentedMsg = parts.map(part => `    | ${part}`).join('\n');
+            console.log(`\n${indentedMsg}`);
           }
-          indentedMsg = parts.map(part => `    | ${part}`).join('\n');
-          console.log(`\n${indentedMsg}`);
-        }
-        // Add statistics on the message to the report.
-        const msgTextLC = msgText.toLowerCase();
-        const msgLength = msgText.length;
-        report.jobData.logCount++;
-        report.jobData.logSize += msgLength;
-        if (errorWords.some(word => msgTextLC.includes(word))) {
-          report.jobData.errorLogCount++;
-          report.jobData.errorLogSize += msgLength;
+          // Add statistics on the message to the report.
+          const msgTextLC = msgText.toLowerCase();
+          const msgLength = msgText.length;
+          report.jobData.logCount++;
+          report.jobData.logSize += msgLength;
+          if (errorWords.some(word => msgTextLC.includes(word))) {
+            report.jobData.errorLogCount++;
+            report.jobData.errorLogSize += msgLength;
+          }
+          const msgLC = msgText.toLowerCase();
+          if (
+            msgText.includes('403') && (msgLC.includes('status')
+            || msgLC.includes('prohibited'))
+          ) {
+            report.jobData.prohibitedCount++;
+          }
+        });
+      });
+      // Open the first page of the context.
+      const page = await browserContext.newPage();
+      try {
+        // Wait until it is stable.
+        await page.waitForLoadState('domcontentloaded', {timeout: 5000});
+        // Navigate to the specified URL.
+        const navResult = await goTo(report, page, url, 15000, 'domcontentloaded');
+        // If the navigation succeeded:
+        if (navResult.success) {
+          // Update the name of the current browser type and store it in the page.
+          page.browserTypeName = browserID;
+          // Return the response of the target server, the browser context, and the page.
+          return {
+            success: true,
+            response: navResult.response,
+            browserContext,
+            page
+          };
         }
-        const msgLC = msgText.toLowerCase();
-        if (
-          msgText.includes('403') && (msgLC.includes('status')
-          || msgLC.includes('prohibited'))
-        ) {
-          report.jobData.prohibitedCount++;
+        // Otherwise, if the navigation failed:
+        else {
+          // Return the error.
+          return {
+            success: false,
+            error: navResult.error
+          };
         }
-      });
-    });
-    // Open the first page of the context.
-    const page = await browserContext.newPage();
-    try {
-      // Wait until it is stable.
-      await page.waitForLoadState('domcontentloaded', {timeout: 5000});
-      // Navigate to the specified URL.
-      const navResult = await goTo(report, page, url, 15000, 'domcontentloaded');
-      // If the navigation succeeded:
-      if (navResult.success) {
-        // Update the name of the current browser type and store it in the page.
-        page.browserTypeName = typeName;
-        // Return the response of the target server, the browser context, and the page.
-        return {
-          success: true,
-          response: navResult.response,
-          browserContext,
-          page
-        };
       }
-      // Otherwise, if the navigation failed:
-      else {
-        // Return the error.
+      // If it fails to become stable after load:
+      catch(error) {
+        // Return this.
+        console.log(`ERROR: Blank page load in new tab timed out (${error.message})`);
         return {
           success: false,
-          error: navResult.error
+          error: 'Blank page load in new tab timed out'
         };
       }
     }
-    // If it fails to become stable after load:
-    catch(error) {
+    // Otherwise, i.e. if the device is invalid:
+    else {
       // Return this.
-      console.log(`ERROR: Blank page load in new tab timed out (${error.message})`);
+      console.log(`ERROR: Device ${deviceID} invalid`);
       return {
         success: false,
-        error: 'Blank page load in new tab timed out'
+        error: `${deviceID} device invalid`
       };
     }
   }
   // Otherwise, i.e. if it does not exist:
   else {
     // Return this.
-    console.log(`ERROR: Browser of type ${typeName} could not be launched`);
+    console.log(`ERROR: Browser of type ${browserID} could not be launched`);
     return {
       success: false,
-      error: `${typeName} browser launch failed`
+      error: `${browserID} browser launch failed`
     };
   }
 };
@@ -801,23 +822,16 @@ const doActs = async (report, actIndex, page) => {
   if (actIndex > -1 && actIndex < acts.length) {
     // Identify the act to be performed.
     const act = acts[actIndex];
+    const {type, which} = act;
     // If it is valid:
     if (isValidAct(act)) {
-      let actInfo = '';
-      if (act.which) {
-        if (act.type === 'launch' && act.url) {
-          actInfo = `${act.which} to ${act.url}`;
-        }
-        else {
-          actInfo = act.which;
-        }
-      }
-      const message = `>>>> ${act.type}: ${actInfo}`;
+      const actSuffix = type === 'test' ? ` ${which}` : '';
+      const message = `>>>> ${type}${actSuffix}`;
       // If granular reporting has been specified:
       if (report.observe) {
         // Notify the observer of the act and log it.
-        const whichParam = act.which ? `&which=${act.which}` : '';
-        const messageParams = `act=${act.type}${whichParam}`;
+        const whichParam = which ? `&which=${which}` : '';
+        const messageParams = `act=${type}${whichParam}`;
         tellServer(report, messageParams, message);
       }
       // Otherwise, i.e. if granular reporting has not been specified:
@@ -829,7 +843,7 @@ const doActs = async (report, actIndex, page) => {
       actCount++;
       act.startTime = Date.now();
       // If the act is an index changer:
-      if (act.type === 'next') {
+      if (type === 'next') {
         const condition = act.if;
         const logSuffix = condition.length === 3 ? ` ${condition[1]} ${condition[2]}` : '';
         console.log(`>> ${condition[0]}${logSuffix}`);
@@ -865,16 +879,16 @@ const doActs = async (report, actIndex, page) => {
         }
       }
       // Otherwise, if the act is a launch:
-      else if (act.type === 'launch') {
-        // Launch the specified browser and navigate to the specified URL.
+      else if (type === 'launch') {
+        // Launch the specified browser on the specified device and navigate to the specified URL.
         const launchResult = await launch(
           report,
-          act.which,
-          act.url,
+          act.url || report.sources.target.url,
           debug,
           waits,
-          act.deviceID || 'default',
-          act.lowMotion ? 'reduce' : 'no-preference'
+          act.deviceID || report.deviceID,
+          act.browserID || report.browserID,
+          act.lowMotion || report.lowMotion
         );
         // If the launch and navigation succeeded:
         if (launchResult && launchResult.success) {