testaro 41.0.2 → 42.0.1

package/README.md

@@ -132,7 +132,6 @@ Here is an example of a job:
 ```javaScript
 {
   id: '250110T1200-7f-4',
-  what: 'aside mislocation',
   strict: true,
   isolate: true,
   standard: 'also',
@@ -143,17 +142,16 @@ Here is an example of a job:
   timeLimit: 80,
   creationTimeStamp: '241229T0537',
   executionTimeStamp: '250110T1200',
+  sendReportTo: 'https://abccorp.com/api/report',
+  target: {
+    what: 'Real Estate Management',
+    url: 'https://abccorp.com/mgmt/realproperty.html'
+  },
   sources: {
     script: 'ts99',
     batch: 'departments',
     mergeID: '7f',
-    sendReportTo: 'https://abccorp.com/api/report',
     requester: 'malavu@abccorp.com'
-    target: {
-      what: 'Real Estate Management',
-      url: 'https://abccorp.com/mgmt/realproperty.html'
-    },
-    lastTarget: false,
   },
   acts: [
     {
@@ -194,7 +192,9 @@ Job properties:
 - `timeLimit`: the number of seconds allowed for the execution of the job.
 - `creationTimeStamp`: a string in `yymmddThhMM` format, describing when the job was created.
 - `executionTimeStamp`: a string in `yymmddThhMM` format, specifying a date and time before which the job is not to be performed.
-- `sources`: an object describing the source of the job.
+- `sendReportTo`: the URL to which the job report is to be sent, or `''` if not a `netWatch` job.
+- `target`: data about the target of the job, or `{}` if the job involves multiple targets.
+- `sources`: data optionally inserted into the job by the job creator for use by the job creator.
 - `acts`: an array of the acts to be performed (documented below).
 
 ## Acts
@@ -237,7 +237,7 @@ When the texts of multiple elements of the same type will contain the same `whic
 
 #### Navigations
 
-An example of a **navigation** is the act of type `launch` above. The launch configuration is inherited from properties of the job, except that the act may override any of those properties.
+An example of a **navigation** is the act of type `launch` above. The launch configuration is inherited from the `deviceID`, `browserID`, `lowMotion`, and `target` properties of the job, except that the act may override any of those properties.
 
 If any act alters the page, you can restore the page to its original state for the next act by inserting a new `launch` act (and, if necessary, additional page-specific acts) between them.
 

package/call.js

@@ -83,7 +83,7 @@ const callRun = async jobIDStart => {
   // Otherwise, i.e. if the job does not exist.
   else {
     // Report the error.
-    console.log('ERROR: No specified job exists');
+    console.log('ERROR: Specified job does not exist');
   }
 };
 // Starts a directory watch, converting the interval argument to a number.

package/netWatch.js

@@ -132,9 +132,9 @@ exports.netWatch = async (isForever, intervalInSeconds, isCertTolerant = true) =
             .on('end', async () => {
               const content = chunks.join('');
               try {
-                // If there was no job to do:
                 let contentObj = JSON.parse(content);
                 let jobInvalidity = '';
+                // If there was no job to do:
                 if (! Object.keys(contentObj).length) {
                   // Report this.
                   console.log(`No job to do at ${url}`);
@@ -142,8 +142,7 @@ exports.netWatch = async (isForever, intervalInSeconds, isCertTolerant = true) =
                 }
                 // Otherwise, i.e. if there was a job or a message:
                 else {
-                  const {id, message, sources} = contentObj;
-                  const sendReportTo = sources ? sources.sendReportTo : '';
+                  const {id, message, sendReportTo, sources} = contentObj;
                   // If the server sent a message, not a job:
                   if (message) {
                     // Report it.

package/package.json

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

package/procs/identify.js

@@ -96,7 +96,7 @@ exports.identify = async (instance, page) => {
     const {type, spec} = location;
     // If the instance specifies a CSS selector or XPath location:
     if (['selector', 'xpath'].includes(type)) {
-      // Get a locator of the element.
+      // Get locators for elements with that specifier.
       let specifier = spec;
       if (type === 'xpath') {
         specifier = spec.replace(/\/text\(\)\[\d+\]$/, '');
@@ -107,33 +107,50 @@ exports.identify = async (instance, page) => {
         }
         try {
           const locators = page.locator(specifier);
+          // Get their count, or throw an error if the specifier is invalid.
           const locatorCount = await locators.count();
-          // If the count of matching elements is 1:
+          // If the specifier is valid and the count is 1:
           if (locatorCount === 1) {
             // Add a box ID and a path ID to the result.
             await addIDs(locators, elementID);
           }
-          // Otherwise, if the count is not 1 and the instance specifies an XPath location:
+          /*
+            Otherwise, if the specifier is valid, the count is not 1, and the instance specifies
+            an XPath location:
+          */
           else if (type === 'xpath') {
             // Use the XPath location as the path ID.
             elementID.pathID = spec;
           }
         }
+        // If the specifier is invalid:
         catch(error) {
-          console.log(`ERROR locating element by CSS selector or XPath (${error.message})`);
+          // Add this to the instance.
+          instance.invalidity = {
+            badProperty: 'location',
+            validityError: error.message
+          };
         }
       }
     }
     // If either ID remains undefined and the instance specifies an element ID:
     if (id && ! (elementID.boxID && elementID.pathID)) {
-      // Get the first of the locators for elements with the ID.
+      /*
+        Get the first locator for an element with the ID, or throw an error if the identifier is
+        invalid.
+      */
       try {
         let locator = page.locator(`#${id.replace(/([-&;/]|^\d)/g, '\\$1')}`).first();
         // Add a box ID and a path ID to the result.
         await addIDs(locator, elementID);
       }
+      // If the identifier is invalid:
       catch(error) {
-        console.log(`ERROR locating element by ID (${error.message})`);
+        // Add this to the instance.
+        instance.invalidity = {
+          badProperty: 'id',
+          validityError: error.message
+        };
       }
     }
     // If either ID remains undefined and the instance specifies a tag name:

package/procs/job.js

@@ -196,6 +196,8 @@ exports.isValidJob = job => {
       timeLimit,
       creationTimeStamp,
       executionTimeStamp,
+      sendReportTo,
+      target,
       sources,
       acts
     } = job;
@@ -237,12 +239,13 @@ exports.isValidJob = job => {
     ) {
       return 'bad job executionTimeStamp';
     }
-    if (
-      ! sources
-      || typeof sources !== 'object'
-      || ! ['script', 'batch', 'target'].every(key => sources[key])
-      || ! ['what', 'url'].every(key => sources.target[key])
-    ) {
+    if (typeof sendReportTo !== 'string' || sendReportTo && ! isURL(sendReportTo)) {
+      return 'bad job sendReportTo';
+    }
+    if (typeof target !== 'object' || target.url && ! isURL(target.url) || target.what === '') {
+      return 'bad job target';
+    }
+    if (sources && typeof sources !== 'object') {
       return 'Bad job sources';
     }
     if (

package/run.js

@@ -622,7 +622,7 @@ const doActs = async (report, actIndex, page) => {
       // Launch the specified browser on the specified device and navigate to the specified URL.
       const launchResult = await launch(
         report,
-        act.url || report.sources.target.url,
+        act.url || report.target.url,
         debug,
         waits,
         act.deviceID || report.deviceID,

package/tests/ed11y.js

@@ -48,7 +48,7 @@ exports.reporter = async (page, options) => {
     const timer = setTimeout(() => {
       // Return this as the report.
       resolve({
-        facts: {
+        result: {
           prevented: true,
           error: 'ed11y timed out'
         }
@@ -151,37 +151,52 @@ exports.reporter = async (page, options) => {
     }
     catch(error) {
       resolve({
-        facts: {
+        result: {
           prevented: true,
           error: error.message
         }
       });
     };
   }), {scriptNonce, script, rulesToTest: act.rules});
-  // Add the violation facts to the result.
-  const factsJSHandle = await reportJSHandle.getProperty('facts');
-  const facts = await factsJSHandle.jsonValue();
-  const result = facts;
-  // If there were any violations:
-  const {violations} = facts;
-  if (violations && violations.length) {
-    // Get the violating elements.
-    const elementsJSHandle = await reportJSHandle.getProperty('elements');
-    const elementJSHandles = await elementsJSHandle.getProperties();
-    // For each violation:
-    for (const index in violations) {
-      // Get its path ID.
-      const elementHandle = elementJSHandles.get(index).asElement();
-      const pathID = await xPath(elementHandle);
-      // Add it to the violation facts.
-      violations[index].pathID = pathID;
+  // Initialize the result as the violation facts.
+  const resultJSHandle = await reportJSHandle.getProperty('facts');
+  const result = await resultJSHandle.jsonValue();
+  // If there were any violation facts:
+  if (result) {
+    // Get the violations from them.
+    const {violations} = result;
+    // If any exist:
+    if (violations && violations.length) {
+      // Get the violating elements.
+      const elementsJSHandle = await reportJSHandle.getProperty('elements');
+      const elementJSHandles = await elementsJSHandle.getProperties();
+      // For each violation:
+      for (const index in violations) {
+        // Get its path ID from the identically indexed element.
+        const elementHandle = elementJSHandles.get(index).asElement();
+        const pathID = await xPath(elementHandle);
+        // Add the path ID to the violation facts of the result.
+        violations[index].pathID = pathID;
+      };
+    }
+    // Return the data and result, discarding the separate element data.
+    return {
+      data: {
+        prevented: result.prevented
+      },
+      result
     };
   }
-  // Return the report.
-  return {
-    data: {
-      prevented: facts.prevented
-    },
-    result
-  };
+  // Otherwise, i.e. if there were no violation facts:
+  else {
+    // Return this.
+    return {
+      data: {
+        prevented: false
+      },
+      result: {
+        prevented: false,
+      }
+    }
+  }
 };

package/tests/nuVal.js

@@ -47,9 +47,14 @@ exports.reporter = async (page, options) => {
   const pageContent = await page.content();
   // Get the source.
   const sourceData = await getSource(page);
-  // If it was not obtained:
-  const data = {};
+  const data = {
+    docTypes: {
+      pageContent: {},
+      rawPage: {}
+    }
+  };
   const result = {};
+  // If it was not obtained:
   if (sourceData.prevented) {
     // Report this.
     data.prevented = true;
@@ -66,8 +71,9 @@ exports.reporter = async (page, options) => {
       }
     };
     const nuURL = 'https://validator.w3.org/nu/?parser=html&out=json';
+    const pageTypes = [['pageContent', pageContent], ['rawPage', sourceData.source]];
     // For each page type:
-    for (const page of [['pageContent', pageContent], ['rawPage', sourceData.source]]) {
+    for (const page of pageTypes) {
       try {
         // Get a Nu Html Checker report on it.
         fetchOptions.body = page[1];
@@ -96,10 +102,16 @@ exports.reporter = async (page, options) => {
       catch (error) {
         const message = `ERROR getting results for ${page[0]} (${error.message})`;
         console.log(message);
-        data.prevented = true;
-        data.error = message;
+        data.docTypes[page[0]].prevented = true;
+        data.docTypes[page[0]].error = message;
       };
     };
+    // If both page types prevented testing:
+    if (pageTypes.every(pageType => data.docTypes[pageType[0]].prevented)) {
+      // Report this.
+      data.prevented = true;
+      data.error = 'Both doc types prevented';
+    }
   }
   return {
     data,