testaro 10.2.0 → 10.4.1

package/actSpecs.js

@@ -229,13 +229,25 @@ exports.actSpecs = {
         withItems: [true, 'boolean', '', 'itemize']
       }
     ],
+    htmlcs: [
+      'Perform an htmlcs test',
+      {
+        rules: [
+          false,
+          'array',
+          'areStrings',
+          'rule names (e.g., Principle1.Guideline1_4.1_4_9), if not all'
+        ]
+      }
+    ],
     ibm: [
       'Perform an IBM Equal Access test',
       {
         withItems: [true, 'boolean', '', 'itemize'],
         withNewContent: [
           false, 'boolean', '', 'true: use a URL; false: use page content; omitted: both'
-        ]
+        ],
+        rules: [false, 'array', 'areStrings', 'rule names (e.g., RPT_Elem_UniqueId), if not all']
       }
     ],
     labClash: [

package/package.json

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

package/tests/htmlcs.js

@@ -5,8 +5,9 @@
 
 // FUNCTIONS
 // Runs HTML CodeSniffer on the page.
-exports.reporter = async page => {
+exports.reporter = async (page, rules) => {
   const result = {};
+  // Add the HTMLCS script to the page.
   await page.addScriptTag({
     path: `${__dirname}/../htmlcs/HTMLCS.js`
   })
@@ -17,17 +18,26 @@ exports.reporter = async page => {
   });
   if (! result.prevented) {
     let messageStrings = [];
-    for (const standard of ['WCAG2AA']) {
-      const nextIssues = await page.evaluate(standard => {
+    // Define the rules to be employed as those of WCAG 2 level AAA.
+    for (const standard of ['WCAG2AAA']) {
+      const nextIssues = await page.evaluate(args => {
+        const standard = args[0];
+        const rules = args[1];
+        // If only some rules are to be employed:
+        if (rules && Array.isArray(rules) && rules.length) {
+          // Redefine WCAG 2 AAA as including only them.
+          window.HTMLCS_WCAG2AAA.sniffs = rules;
+        }
+        // Run the tests.
         let issues = null;
         try {
-          issues = window['HTMLCS_RUNNER'].run(standard);
+          issues = window.HTMLCS_RUNNER.run(standard);
         }
         catch(error) {
           console.log(`ERROR executing HTMLCS_RUNNER on ${document.URL} (${error.message})`);
         }
         return issues;
-      }, standard);
+      }, [standard, rules]);
       if (nextIssues && nextIssues.every(issue => typeof issue === 'string')) {
         messageStrings.push(... nextIssues);
       }

package/tests/ibm.js

@@ -41,15 +41,34 @@ const run = async (content, timeLimit) => {
   clearTimeout(timeoutID);
   return result;
 };
+// Revises report totals for any rule limitation.
+const limitRuleTotals = (report, rules) => {
+  if (rules && Array.isArray(rules) && rules.length) {
+    const totals = report.report.summary.counts;
+    const items = report.report.results;
+    totals.violation = totals.recommendation = 0;
+    items.forEach(item => {
+      if (rules.includes(item.ruleId)) {
+        totals[item.level]++;
+      }
+    });
+  }
+};
 // Trims an IBM report.
-const trimReport = (report, withItems) => {
+const trimReport = (report, withItems, rules) => {
   const data = {};
   if (report && report.report && report.report.summary) {
+    limitRuleTotals(report, rules);
     const totals = report.report.summary.counts;
     if (totals) {
       data.totals = totals;
       if (withItems) {
-        data.items = report.report.results;
+        if (rules && Array.isArray(rules) && rules.length) {
+          data.items = report.report.results.filter(item => rules.includes(item.ruleId));
+        }
+        else {
+          data.items = report.report.results;
+        }
         data.items.forEach(item => {
           delete item.apiArgs;
           delete item.category;
@@ -72,8 +91,8 @@ const trimReport = (report, withItems) => {
   }
   return data;
 };
-// Performs an IBM test and return the result.
-const doTest = async (content, withItems, timeLimit) => {
+// Performs an IBM test and returns the result.
+const doTest = async (content, withItems, timeLimit, rules) => {
   // Conduct the test and get the result.
   const report = await run(content, timeLimit);
   // If the test did not time out:
@@ -89,7 +108,7 @@ const doTest = async (content, withItems, timeLimit) => {
       console.log('ibm test created no result files.');
     }
     // Return the result.
-    const typeReport = trimReport(report, withItems);
+    const typeReport = trimReport(report, withItems, rules);
     return typeReport;
   }
   else {
@@ -100,13 +119,13 @@ const doTest = async (content, withItems, timeLimit) => {
   }
 };
 // Returns results of one or two IBM tests.
-exports.reporter = async (page, withItems, withNewContent) => {
+exports.reporter = async (page, withItems, withNewContent, rules) => {
   // If a test with existing content is to be performed:
   const result = {};
   if (! withNewContent) {
     const timeLimit = 20;
     const typeContent = await page.content();
-    result.content = await doTest(typeContent, withItems, timeLimit);
+    result.content = await doTest(typeContent, withItems, timeLimit, rules);
     if (result.content.prevented) {
       result.prevented = true;
       console.log(`ERROR: Getting ibm test report from page timed out at ${timeLimit} seconds`);
@@ -116,7 +135,7 @@ exports.reporter = async (page, withItems, withNewContent) => {
   if ([true, undefined].includes(withNewContent)) {
     const timeLimit = 20;
     const typeContent = page.url();
-    result.url = await doTest(typeContent, withItems, timeLimit);
+    result.url = await doTest(typeContent, withItems, timeLimit, rules);
     if (result.url.prevented) {
       result.prevented = true;
       console.log(`ERROR: Getting ibm test report from URL timed out at ${timeLimit} seconds`);