testaro 9.0.2 → 10.1.0

package/README.md

@@ -591,14 +591,15 @@ The arguments passed to `cycle` by a module or to `watch` by a user are:
 - whether to watch a directory (`true`) or the network (`false`)
 - whether to continue watching indefinitely after the first report (`true` or `false`)
 - how many seconds to wait after finding no job before checking again (a nonnegative number)
+- optionally, where the watched jobs are located
 
 ##### Directory watch
 
-With directory watch, Testaro checks whether the `todo` subdirectory of the job directory (`process.env.JOBDIR`) contains a job.
+With directory watch, Testaro checks whether the `todo` subdirectory of the job directory contains a job. The job directory is given by the fourth passed argument, if present, or, if not, then by `process.env.JOBDIR`.
 
-When Testaro finds one or more jobs to do, the `watch` module runs the first job, saves the report in the `raw` subdirectory of the `process.env.REPORTDIR` directory, and moves the job file from the `todo` subdirectory to the `done` subdirectory of the `process.env.JOBDIR` directory.
+When Testaro finds one or more jobs to do, the `watch` module runs the first job, saves the report in the `raw` subdirectory of the report directory. The report directory is given by `process.env.REPORTDIR`. Testaro also moves the job file from the `todo` subdirectory to the `done` subdirectory of the job directory.
 
-Since Testaro runs the first job (i.e. the job whose file name is first in ASCII order), whoever populates the `todo` subdirectory of the `process.env.JOBDIR` directory with job files has control over the order in which Testaro runs them. For example, to force a new job to be run before the already waiting jobs, one can give it a filename that comes before that of the first waiting job.
+Since Testaro runs the first job (i.e. the job whose file name is first in ASCII order), whoever populates the `todo` subdirectory of the job directory with job files has control over the order in which Testaro runs them. For example, to force a new job to be run before the already waiting jobs, one can give it a filename that comes before that of the first waiting job.
 
 ##### Network watch
 
@@ -610,6 +611,10 @@ With network watch, the initiator of an interaction is Testaro, not the server.
 
 If multiple workstations run Testaro and do work for the same server, the server can assign jobs to specific agents by requiring each instance of Testaro to have a distinct value of `process.env.AGENT`.
 
+The URL from which Testaro requests jobs is given by the fourth passed argument, if present, or, if not, then by `process.env.JOB_URL`.
+
+The URL to which Testaro sends reports is given by the `sources.sendReportTo` property of each job, if the property exists, or, if not, by `process.env.REPORT_URL`.
+
 ### Environment variables
 
 In addition to their uses described above, environment variables can be used by commands of type `text`, as documented in the `commands.js` file.

package/actSpecs.js

@@ -153,6 +153,12 @@ exports.actSpecs = {
     ]
   },
   tests: {
+    alfa: [
+      'Perform an alfa test',
+      {
+        rules: [false, 'array', 'areStrings', 'rule names (e.g., r25), if not all']
+      }
+    ],
     attVal: [
       'Perform an attVal test',
       {

package/call.js

@@ -57,11 +57,11 @@ const callRun = async jobIDStart => {
   }
 };
 // Starts a watch.
-const callWatch = async (isDirWatch, isForever, interval) => {
+const callWatch = async (isDirWatch, isForever, interval, watchee = null) => {
   const whenType = isForever === 'true' ? 'repeating' : 'one-time';
   const whereType = isDirWatch === 'true' ? 'directory' : 'network';
   console.log(`Starting ${whenType} ${whereType} watch`);
-  await cycle(isDirWatch === 'true', isForever === 'true', Number.parseInt(interval, 10));
+  await cycle(isDirWatch === 'true', isForever === 'true', Number.parseInt(interval, 10), watchee);
 };
 
 // ########## OPERATION

package/package.json

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

package/tests/alfa.js

@@ -7,12 +7,17 @@
 
 const {Audit} = require('@siteimprove/alfa-act');
 const {Scraper} = require('@siteimprove/alfa-scraper');
-const alfaRules = require('@siteimprove/alfa-rules');
+let alfaRules = require('@siteimprove/alfa-rules').default;
 
 // FUNCTIONS
 
 // Conducts and reports an alfa test.
-exports.reporter = async page => {
+exports.reporter = async (page, rules) => {
+  // If only some rules are to be employed:
+  if (rules && rules.length) {
+    // Remove the other rules.
+    alfaRules = alfaRules.filter(rule => rules.includes(rule.uri.replace(/^.+-/, '')));
+  }
   // Get the document containing the summaries of the alfa rules.
   const context = page.context();
   const rulePage = await context.newPage();
@@ -53,7 +58,7 @@ exports.reporter = async page => {
     };
     await Scraper.with(async scraper => {
       for (const input of await scraper.scrape(page.url())) {
-        const audit = Audit.of(input, alfaRules.default);
+        const audit = Audit.of(input, alfaRules);
         const outcomes = Array.from(await audit.evaluate());
         outcomes.forEach((outcome, index) => {
           const {target} = outcome;

package/watch.js

@@ -25,13 +25,13 @@ const reportDir = process.env.REPORTDIR;
 // ########## FUNCTIONS
 
 // Checks for a directory job.
-const checkDirJob = async () => {
+const checkDirJob = async watchee => {
   try {
-    const toDoDirFileNames = await fs.readdir(`${jobDir}/todo`);
+    const watchJobDir = watchee || jobDir;
+    const toDoDirFileNames = await fs.readdir(`${watchJobDir}/todo`);
     const jobFileNames = toDoDirFileNames.filter(fileName => fileName.endsWith('.json'));
     if (jobFileNames.length) {
-      console.log('Directory job found');
-      const jobJSON = await fs.readFile(`${jobDir}/todo/${jobFileNames[0]}`, 'utf8');
+      const jobJSON = await fs.readFile(`${watchJobDir}/todo/${jobFileNames[0]}`, 'utf8');
       try {
         const job = JSON.parse(jobJSON, null, 2);
         return job;
@@ -44,7 +44,7 @@ const checkDirJob = async () => {
       }
     }
     else {
-      console.log('Directory job not found');
+      console.log('No job to do');
       return {};
     }
   }
@@ -52,10 +52,11 @@ const checkDirJob = async () => {
     return {};
   }
 };
-// Checks for a network job.
-const checkNetJob = async () => {
+// Checks for and returns a network job.
+const checkNetJob = async watchee => {
+  const watchJobURL = watchee || jobURL;
   const job = await new Promise(resolve => {
-    const wholeURL = `${protocol}://${jobURL}?agent=${agent}`;
+    const wholeURL = `${protocol}://${watchJobURL}?agent=${agent}`;
     const request = client.request(wholeURL, response => {
       const chunks = [];
       response.on('data', chunk => {
@@ -83,7 +84,9 @@ const checkNetJob = async () => {
     });
     request.end();
   });
-  console.log(`Network job ${job.id || 'not'} received`);
+  if (job.id) {
+    console.log(`Network job ${job.id} received`);
+  }
   return job;
 };
 // Writes a directory report.
@@ -108,48 +111,57 @@ const writeDirReport = async report => {
 // Submits a network report to a server and returns the server response.
 const writeNetReport = async report => {
   const ack = await new Promise(resolve => {
-    const wholeURL = `${process.env.PROTOCOL}://${reportURL}`;
-    const request = client.request(wholeURL, {method: 'POST'}, response => {
-      const chunks = [];
-      response.on('data', chunk => {
-        chunks.push(chunk);
-      });
-      response.on('end', () => {
-        const content = chunks.join('');
-        try {
-          resolve(JSON.parse(content));
-        }
-        catch(error) {
-          resolve({
-            error: 'ERROR: Response was not JSON',
-            message: error.message,
-            status: response.statusCode,
-            content: content.slice(0, 200)
-          });
-        }
+    if (report.sources) {
+      // Get the report destination from the report or the environment.
+      const destination = report.sources.sendReportTo;
+      const wholeURL = destination || `${process.env.PROTOCOL}://${reportURL}`;
+      // Contact the server.
+      const request = client.request(wholeURL, {method: 'POST'}, response => {
+        const chunks = [];
+        response.on('data', chunk => {
+          chunks.push(chunk);
+        });
+        response.on('end', () => {
+          const content = chunks.join('');
+          try {
+            resolve(JSON.parse(content));
+          }
+          catch(error) {
+            resolve({
+              error: 'ERROR: Response was not JSON',
+              message: error.message,
+              status: response.statusCode,
+              content: content.slice(0, 200)
+            });
+          }
+        });
       });
-    });
-    report.jobData.agent = agent;
-    request.on('error', error => {
-      console.log(`ERROR submitting job report (${error.message})`);
-      resolve({
-        error: 'ERROR: Job report submission failed',
-        message: error.message
+      report.jobData.agent = agent;
+      request.on('error', error => {
+        console.log(`ERROR submitting job report (${error.message})`);
+        resolve({
+          error: 'ERROR: Job report submission failed',
+          message: error.message
+        });
       });
-    });
-    // Send the report to the server.
-    request.write(JSON.stringify(report, null, 2));
-    request.end();
-    console.log(`Report ${report.id} submitted`);
+      // Send the report to the server.
+      request.write(JSON.stringify(report, null, 2));
+      request.end();
+      console.log(`Report ${report.id} submitted`);
+    }
+    else {
+      console.log('ERROR: Report has no sources property');
+    }
   });
   // Return the server response.
   return ack;
 };
 // Archives a job.
-const archiveJob = async job => {
+const archiveJob = async (job, watchee) => {
   const jobJSON = JSON.stringify(job, null, 2);
-  await fs.writeFile(`${jobDir}/done/${job.id}.json`, jobJSON);
-  await fs.rm(`${jobDir}/todo/${job.id}.json`);
+  const watchJobDir = watchee || jobDir;
+  await fs.writeFile(`${watchJobDir}/done/${job.id}.json`, jobJSON);
+  await fs.rm(`${watchJobDir}/todo/${job.id}.json`);
 };
 // Waits.
 const wait = ms => {
@@ -194,7 +206,7 @@ const runJob = async (job, isDirWatch) => {
   }
 };
 // Checks for a job, performs it, and submits a report, once or repeatedly.
-exports.cycle = async (isDirWatch, isForever, interval) => {
+exports.cycle = async (isDirWatch, isForever, interval, watchee = null) => {
   const intervalMS = 1000 * Number.parseInt(interval);
   let statusOK = true;
   // Prevent a wait before the first iteration.
@@ -207,21 +219,21 @@ exports.cycle = async (isDirWatch, isForever, interval) => {
     // Check for a job.
     let job;
     if (isDirWatch) {
-      job = await checkDirJob();
+      job = await checkDirJob(watchee);
     }
     else {
-      job = await checkNetJob();
+      job = await checkNetJob(watchee);
     }
     // If there was one:
     if (job.id) {
-      // Run it and save a report.
+      // Run it, save a report, and if applicable send the report to the job source.
       console.log(`Running job ${job.id}`);
       await runJob(JSON.parse(JSON.stringify(job)), isDirWatch);
       console.log(`Job ${job.id} finished`);
       // If a directory was watched:
       if (isDirWatch) {
         // Archive the job.
-        await archiveJob(job);
+        await archiveJob(job, watchee);
         console.log(`Job ${job.id} archived`);
       }
       // If watching was specified for only 1 job, quit.
@@ -231,6 +243,7 @@ exports.cycle = async (isDirWatch, isForever, interval) => {
     }
     // Otherwise, i.e. if no job was found:
     else {
+      console.log('No job to do');
       // Cause a wait before the next check.
       empty = true;
     }