testaro 78.0.8 → 78.4.0

package/procs/testaro.js

@@ -1,3 +1,4 @@
+"use strict";
 /*
   © 2023–2024 CVS Health and/or one of its affiliates. All rights reserved.
   © 2026 Jeff Witt.
@@ -7,209 +8,255 @@
 
   SPDX-License-Identifier: MIT
 */
-
-/*
-  testaro
-  Utilities for Testaro tests.
-*/
-
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBasicResult = exports.doTest = void 0;
 // ########## IMPORTS
-
 // Function to get a catalog index from an XPath.
-const {getXPathCatalogIndex} = require('./xPath');
-
+const xPath_1 = require("./xPath");
+// Function to build a standard instance.
+const standard_1 = require("./standard");
 // ########## FUNCTIONS
-
+// Returns a standard instance, leaving the outcome unset if the violation did not specify one, so
+// that the testaro tool can apply the rule's default outcome.
+const getRuleInstance = (spec) => {
+    const instance = (0, standard_1.getInstance)(spec);
+    if (!spec.outcome) {
+        instance.outcome = undefined;
+    }
+    return instance;
+};
 // Tests for a testaro rule.
-exports.doTest = async (
-  page,
-  report,
-  withItems,
-  ruleID,
-  candidateSelector,
-  whats,
-  severity,
-  getBadWhatString
-) => {
-  const ruleData = await page.evaluate(async args => {
-    // Get the arguments.
-    const [
-      withItems,
-      candidateSelector,
-      severity,
-      getBadWhatString
-    ] = args;
-    // Get all violator candidates.
-    const candidates = document.querySelectorAll(candidateSelector);
-    let violationCount = 0;
-    // Initialize proto-instances.
-    const protoInstances = [];
-    // Parse the supplied string to get the classifier.
-    const getBadWhat = eval(`(${getBadWhatString})`);
-    // Initialize data on the rule.
-    let data = {};
-    const totals = [0, 0, 0, 0];
-    // For each candidate:
-    for (const candidate of candidates) {
-      // Classify it as and get a violation description if a violator or undefined if not.
-      const violationWhat = await getBadWhat(candidate);
-      // If the candidate violates the rule:
-      if (violationWhat) {
-        // Increment the violation count.
-        violationCount++;
-        let ruleWhat;
-        const violationType = typeof violationWhat;
-        // If data on the violation were provided (unusual):
-        if (violationType === 'object') {
-          // Get the description and add the data to the rule data.
-          ruleWhat = violationWhat.description;
-          data[violationCount - 1] = violationWhat.data;
+const doTest = async (page, report, withItems, ruleID, candidateSelector, whats, severity, getBadWhatString) => {
+    // The subtree roots the rule is restricted to, if the test act has scope changed and the
+    // testaro tool judged the rule element-local (set per rule by tests/testaro.ts).
+    const scopeRoots = report.ruleScopeRoots ?? null;
+    const ruleData = await page.evaluate(async (args) => {
+        // Get the arguments.
+        const [withItems, candidateSelector, severity, getBadWhatString, scopeRoots] = args;
+        // Get all violator candidates, within the scope roots if any.
+        let candidates = Array.from(document.querySelectorAll(candidateSelector));
+        if (scopeRoots && scopeRoots.length) {
+            const roots = scopeRoots
+                .map(selector => {
+                try {
+                    return document.querySelector(selector);
+                }
+                catch {
+                    return null;
+                }
+            })
+                .filter((root) => Boolean(root));
+            candidates = candidates.filter(candidate => roots.some(root => root.contains(candidate)));
         }
-        // Otherwise, i.e. if only a description of the violation was provided:
-        else if (violationType === 'string') {
-          // Get it.
-          ruleWhat = violationWhat;
+        let violationCount = 0;
+        // Initialize proto-instances.
+        const protoInstances = [];
+        // Initialize counts of cantTell violations by ordinal severity, for summary instances.
+        const cantTellTotals = [0, 0, 0, 0];
+        /*
+          Parse the supplied string to get the classifier. The predicate travels as
+          source text (serialized with toString() by the rule module) because it
+          must run inside the page; this cast is the single point where its type is
+          asserted rather than checked (issue #73, RFC decision 4). The eval input
+          is first-party rule-module source from this repository, never target-page
+          or user data; replacing the eval pipeline with a bundled artifact is the
+          Phase 3 reassessment recorded on issue #73.
+        */
+        const getBadWhat = eval(`(${getBadWhatString})`);
+        // Initialize data on the rule.
+        let data = {};
+        const totals = [0, 0, 0, 0];
+        // For each candidate:
+        for (const candidate of candidates) {
+            // Classify it as and get a violation description if a violator or undefined if not.
+            const violationWhat = await getBadWhat(candidate);
+            // If the candidate violates the rule:
+            if (violationWhat) {
+                // Increment the violation count.
+                violationCount++;
+                let ruleWhat;
+                const violationType = typeof violationWhat;
+                // If data on the violation were provided (unusual):
+                if (violationType === 'object') {
+                    // Get the description and add the data to the rule data.
+                    ruleWhat = violationWhat.description;
+                    data[violationCount - 1] = violationWhat.data;
+                }
+                // Otherwise, i.e. if only a description of the violation was provided:
+                else if (violationType === 'string') {
+                    // Get it.
+                    ruleWhat = violationWhat;
+                }
+                let ordinalSeverity = severity;
+                let outcome;
+                // A predicate that returns a truthy non-object non-string would make this throw,
+                // exactly as in the JavaScript original.
+                // If this violation has a custom severity or outcome prefix (e.g. 2:, 2?:, or ?:):
+                const prefixMatch = ruleWhat.match(/^([0-3])?(\?)?:/);
+                if (prefixMatch) {
+                    // If the prefix has a severity, get it.
+                    if (prefixMatch[1]) {
+                        ordinalSeverity = Number(prefixMatch[1]);
+                    }
+                    // If the prefix marks the violation as uncertain, record this.
+                    if (prefixMatch[2]) {
+                        outcome = 'cantTell';
+                        cantTellTotals[ordinalSeverity]++;
+                    }
+                    // Remove the prefix from the violation description.
+                    ruleWhat = ruleWhat.slice(prefixMatch[0].length);
+                }
+                // Increment the applicable rule-violation total.
+                totals[ordinalSeverity]++;
+                // If itemization is required:
+                if (withItems) {
+                    const protoInstance = {
+                        what: ruleWhat,
+                        ordinalSeverity,
+                        outcome,
+                        xPath: window.getXPath(candidate) ?? '/html'
+                    };
+                    // Add a proto-instance to the proto-instances.
+                    protoInstances.push(protoInstance);
+                }
+            }
         }
-        const ruleWhatStart = ruleWhat.slice(0, 2);
-        let ordinalSeverity = severity;
-        // If this violation has a custom severity:
-        if (/[0-3]:/.test(ruleWhatStart)) {
-          // Get it.
-          ordinalSeverity = Number(ruleWhat[0]);
-          // Remove it from the violation description.
-          ruleWhat = ruleWhat.slice(2);
-        }
-        // Increment the applicable rule-violation total.
-        totals[ordinalSeverity]++;
-        // If itemization is required:
-        if (withItems) {
-          const protoInstance = {
-            what: ruleWhat,
-            ordinalSeverity,
-            xPath: window.getXPath(candidate) ?? '/html'
-          };
-          // Add a proto-instance to the proto-instances.
-          protoInstances.push(protoInstance);
-        }
-      }
-    }
-    return {
-      data,
-      totals,
-      protoInstances
+        return {
+            data,
+            totals,
+            cantTellTotals,
+            protoInstances
+        };
+    }, [
+        withItems,
+        candidateSelector,
+        severity,
+        getBadWhatString,
+        scopeRoots
+    ]);
+    // Initialize the standard instances. Any instance without an outcome gets the rule's default
+    // outcome from the testaro tool.
+    let standardInstances = [];
+    const { data, totals, cantTellTotals, protoInstances } = ruleData;
+    // If itemization is required:
+    if (withItems) {
+        // For each proto-instance:
+        protoInstances.forEach(protoInstance => {
+            const { what, ordinalSeverity, outcome, xPath } = protoInstance;
+            // Add a standard instance to the standard instances.
+            standardInstances.push(getRuleInstance({
+                ruleID,
+                what,
+                ordinalSeverity,
+                outcome,
+                catalogIndex: xPath ? (0, xPath_1.getXPathCatalogIndex)(report, xPath) : undefined
+            }));
+        });
     }
-  }, [
-      withItems,
-      candidateSelector,
-      severity,
-      getBadWhatString
-    ]
-  );
-  // Initialize the standard instances.
-  let standardInstances = [];
-  const {data, totals, protoInstances} = ruleData;
-  // If itemization is required:
-  if (withItems) {
-    // For each proto-instance:
-    protoInstances.forEach(protoInstance => {
-      const {what, ordinalSeverity, xPath} = protoInstance;
-      // Initialize a standard instance.
-      const standardInstance = {
-        ruleID,
-        what,
-        ordinalSeverity,
-        count: 1
-      };
-      // If the proto-instance includes an XPath:
-      if (xPath) {
-        // Add the catalog index to the standard instance.
-        standardInstance.catalogIndex = getXPathCatalogIndex(report, xPath);
-      }
-      // Add the standard instance to the standard instances.
-      standardInstances.push(standardInstance);
-    });
-  }
-  // Otherwise, i.e. if itemization is not required:
-  else {
-    // For each ordinal severity:
-    for (const index in totals) {
-      // If there were any violations at that severity:
-      if (totals[index]) {
-        // Add a summary standard instance to the standard instances.
-        standardInstances.push({
-          ruleID,
-          what: whats,
-          ordinalSeverity: index,
-          count: totals[index]
+    // Otherwise, i.e. if itemization is not required:
+    else {
+        // For each ordinal severity:
+        totals.forEach((total, ordinalSeverity) => {
+            const cantTellTotal = cantTellTotals[ordinalSeverity];
+            // If there were any asserted violations at that severity:
+            if (total - cantTellTotal) {
+                // Add a summary standard instance to the standard instances.
+                standardInstances.push(getRuleInstance({
+                    ruleID,
+                    what: whats,
+                    ordinalSeverity,
+                    count: total - cantTellTotal
+                }));
+            }
+            // If there were any uncertain violations at that severity:
+            if (cantTellTotal) {
+                // Add a summary standard instance for them.
+                standardInstances.push(getRuleInstance({
+                    ruleID,
+                    what: whats,
+                    ordinalSeverity,
+                    outcome: 'cantTell',
+                    count: cantTellTotal
+                }));
+            }
         });
-      }
     }
-  }
-  // Return the data, totals, and standard instances.
-  return {
-    data,
-    totals,
-    standardInstances
-  };
+    // Return the data, totals, and standard instances.
+    return {
+        data,
+        totals: totals,
+        standardInstances
+    };
 };
+exports.doTest = doTest;
 // Adds a catalog index or, if necessary, an XPath to a proto-instance.
 const addCatalogIndex = async (protoInstance, locator, report) => {
-  // Get the XPath of the element referenced by the locator.
-  const xPath = await locator.evaluate(element => window.getXPath(element) ?? '/html');
-  // Add a catalog index to the proto-instance.
-  protoInstance.catalogIndex = getXPathCatalogIndex(report, xPath);
-  // Return the proto-instance with any modification.
-  return protoInstance;
+    // Get the XPath of the element referenced by the locator.
+    const xPath = await locator.evaluate(element => window.getXPath(element) ?? '/html');
+    // Add a catalog index to the proto-instance.
+    protoInstance.catalogIndex = (0, xPath_1.getXPathCatalogIndex)(report, xPath);
+    // Return the proto-instance with any modification.
+    return protoInstance;
 };
 // Tests for a doTest-ineligible Testaro rule.
-exports.getBasicResult = async (
-  report, withItems, ruleID, ordinalSeverity, whats, data, violations
-) => {
-  // If the test was prevented:
-  if (data.prevented) {
-    // Return this.
+const getBasicResult = async (report, withItems, ruleID, ordinalSeverity, whats, data, violations) => {
+    // If the test was prevented:
+    if (data.prevented) {
+        // Return this.
+        return {
+            data,
+            totals: [0, 0, 0, 0],
+            standardInstances: []
+        };
+    }
+    // Otherwise, i.e. if the test was not prevented:
+    const totals = [0, 0, 0, 0];
+    totals[ordinalSeverity] = violations.length;
+    const standardInstances = [];
+    // If itemization is required:
+    if (withItems) {
+        // For each violation:
+        for (const violation of violations) {
+            const { loc, what, outcome, uncertainty, needed } = violation;
+            // Initialize a standard instance.
+            const protoInstance = getRuleInstance({
+                ruleID,
+                what,
+                ordinalSeverity,
+                outcome,
+                uncertainty,
+                needed
+            });
+            // Add a catalog index to it, awaited so the index is present before the
+            // report can be serialized (issue #100).
+            await addCatalogIndex(protoInstance, loc, report);
+            // Add the standard instance to the standard instances.
+            standardInstances.push(protoInstance);
+        }
+    }
+    // Otherwise, i.e. if itemization is not required:
+    else {
+        // Add a summary instance per outcome to the instances.
+        const outcomeCounts = {};
+        violations.forEach(violation => {
+            const outcome = violation.outcome || 'failed';
+            outcomeCounts[outcome] = (outcomeCounts[outcome] || 0) + 1;
+        });
+        Object.keys(outcomeCounts).forEach(outcome => {
+            standardInstances.push(getRuleInstance({
+                ruleID,
+                what: whats,
+                ordinalSeverity,
+                outcome,
+                count: outcomeCounts[outcome]
+            }));
+        });
+    }
+    // Return the result.
     return {
-      data,
-      totals: [0, 0, 0, 0],
-      standardInstances: []
+        data,
+        totals,
+        standardInstances
     };
-  }
-  // Otherwise, i.e. if the test was not prevented:
-  const totals = [0, 0, 0, 0];
-  totals[ordinalSeverity] = violations.length;
-  const standardInstances = [];
-  // If itemization is required:
-  if (withItems) {
-    // For each violation:
-    for (const violation of violations) {
-      const {loc, what} = violation;
-      // Initialize a standard instance.
-      const protoInstance = {
-        ruleID,
-        what,
-        ordinalSeverity,
-        count: 1
-      };
-      // Add a catalog index to it.
-      addCatalogIndex(protoInstance, loc, report);
-      // Add the standard instance to the standard instances.
-      standardInstances.push(protoInstance);
-    }
-  }
-  // Otherwise, i.e. if itemization is not required:
-  else {
-    // Add a summary instance to the instances.
-    standardInstances.push({
-      ruleID,
-      what: whats,
-      ordinalSeverity,
-      count: violations.length
-    });
-  }
-  // Return the result.
-  return {
-    data,
-    totals,
-    standardInstances
-  };
 };
+exports.getBasicResult = getBasicResult;