@sa11y/jest 4.1.2 → 4.1.3

package/dist/groupViolationResultsProcessor.d.ts

@@ -0,0 +1,10 @@
+import { AggregatedResult } from '@jest/test-result';
+/**
+ * Custom results processor for a11y results grouping the violations. Only affects JSON results file output.
+ * To be used with jest cli options --json --outputFile
+ *  e.g. jest --json --outputFile jestResults.json --testResultsProcessor `node_modules/@sa11y/jest/dist/groupViolationResultsProcessor.js`
+ * Ref: https://jestjs.io/docs/configuration#testresultsprocessor-string
+ *  - Mapping of AggregatedResult to JSON format to https://github.com/facebook/jest/blob/master/packages/jest-test-result/src/formatTestResults.ts
+ */
+export default function resultsProcessor(results: AggregatedResult): AggregatedResult;
+//# sourceMappingURL=groupViolationResultsProcessor.d.ts.map

package/dist/groupViolationResultsProcessor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"groupViolationResultsProcessor.d.ts","sourceRoot":"","sources":["../src/groupViolationResultsProcessor.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,gBAAgB,EAA+B,MAAM,mBAAmB,CAAC;AAkHlF;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,GAAG,gBAAgB,CAapF"}

package/dist/groupViolationResultsProcessor.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const common_1 = require("@sa11y/common");
+const format_1 = require("@sa11y/format");
+/**
+ * Create a test failure html elements array grouped by rule violation
+ */
+function createA11yErrorElements(errorElements) {
+    const a11yErrorElements = [];
+    errorElements.forEach((errorElement, index) => {
+        a11yErrorElements.push(`- (${index + 1}) HTML element : ${errorElement.html.replace(/&lt;/g, '<').replace(/&gt;/, '>')}
+             - CSS selector(s) : ${errorElement.selectors.replace(/&gt;/, '>')}
+             - HTML Tag Hierarchy : ${errorElement.hierarchy}`);
+    });
+    return a11yErrorElements.join('\n');
+}
+/**
+ * Create a test failure violation error message grouped by rule violation
+ */
+function createA11yRuleViolation(a11yRule, ruleIndex) {
+    return `(${ruleIndex}) [${a11yRule.id}] ${a11yRule.description}
+            * Help URL: ${a11yRule.helpUrl}
+            * More info: ${a11yRule.summary}
+            * Error element(s) : ${a11yRule.errorElements.length}
+            ${createA11yErrorElements(a11yRule.errorElements)}`;
+}
+/**
+ * Convert any a11y errors from test failures into their own test suite, results
+ */
+function processA11yErrors(results, testSuite, testResult) {
+    const a11yFailureDetails = [];
+    const a11yFailureMessages = [];
+    let a11yErrorsExist = false;
+    testResult.failureDetails.forEach((failure) => {
+        let error = failure.error;
+        // If using circus test runner https://github.com/facebook/jest/issues/11405#issuecomment-843549606
+        // TODO (code cov): Add test data covering the case for circus test runner
+        /* istanbul ignore next */
+        if (error === undefined)
+            error = failure;
+        if (error.name === format_1.A11yError.name) {
+            a11yErrorsExist = true;
+            a11yFailureDetails.push({ ...failure });
+            const a11yRuleViolations = {};
+            let a11yRuleViolationsCount = 0;
+            let a11yErrorElementsCount = 0;
+            error.a11yResults.forEach((a11yResult) => {
+                a11yErrorElementsCount++;
+                if (!a11yRuleViolations[a11yResult.wcag]) {
+                    a11yRuleViolationsCount++;
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+                    a11yRuleViolations[a11yResult.wcag] = {
+                        id: a11yResult.id,
+                        description: a11yResult.description,
+                        helpUrl: a11yResult.helpUrl,
+                        summary: a11yResult.summary,
+                        errorElements: [],
+                    };
+                }
+                a11yRuleViolations[a11yResult.wcag].errorElements.push({
+                    html: a11yResult.html,
+                    selectors: a11yResult.selectors,
+                    hierarchy: a11yResult.key,
+                });
+            });
+            const a11yFailureMessage = `
+            The test has failed the accessibility check. Accessibility Stacktrace/Issues:
+            ${a11yErrorElementsCount} HTML elements have accessibility issue(s). ${a11yRuleViolationsCount} rules failed.
+
+            ${Object.values(a11yRuleViolations)
+                .map((a11yRuleViolation, index) => createA11yRuleViolation(a11yRuleViolation, index + 1))
+                .join('\n')}
+            For more info about automated accessibility testing: https://sfdc.co/a11y-test
+            For tips on fixing accessibility bugs: https://sfdc.co/a11y
+            Questions? Post on Accessibility Team Chatter: https://sfdc.co/a11y-gus
+            `;
+            a11yFailureMessages.push(a11yFailureMessage);
+        }
+    });
+    if (!a11yErrorsExist) {
+        testSuite.numFailingTests -= 1;
+        results.numFailedTests -= 1;
+        if (testSuite.numFailingTests === 0)
+            results.numFailedTestSuites -= 1;
+    }
+    testResult.failureDetails = [...a11yFailureDetails];
+    testResult.failureMessages = [...a11yFailureMessages];
+    testResult.status = a11yFailureDetails.length === 0 ? 'passed' : testResult.status;
+}
+/**
+ * Custom results processor for a11y results grouping the violations. Only affects JSON results file output.
+ * To be used with jest cli options --json --outputFile
+ *  e.g. jest --json --outputFile jestResults.json --testResultsProcessor `node_modules/@sa11y/jest/dist/groupViolationResultsProcessor.js`
+ * Ref: https://jestjs.io/docs/configuration#testresultsprocessor-string
+ *  - Mapping of AggregatedResult to JSON format to https://github.com/facebook/jest/blob/master/packages/jest-test-result/src/formatTestResults.ts
+ */
+function resultsProcessor(results) {
+    (0, common_1.log)(`Processing ${results.numTotalTests} tests ..`);
+    results.testResults // suite results
+        .filter((testSuite) => testSuite.numFailingTests > 0)
+        .forEach((testSuite) => {
+        testSuite.testResults // individual test results
+            .filter((testResult) => testResult.status === 'failed')
+            .forEach((testResult) => {
+            processA11yErrors(results, testSuite, testResult);
+        });
+    });
+    return results;
+}
+exports.default = resultsProcessor;
+// The processor must be a node module that exports a function
+module.exports = resultsProcessor;
+//# sourceMappingURL=groupViolationResultsProcessor.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sa11y/jest",
-    "version": "4.1.2",
+    "version": "4.1.3",
     "description": "Accessibility testing matcher for Jest",
     "license": "BSD-3-Clause",
     "homepage": "https://github.com/salesforce/sa11y/tree/master/packages/jest#readme",
@@ -24,9 +24,9 @@
     ],
     "dependencies": {
         "@jest/test-result": "^27",
-        "@sa11y/assert": "4.1.2",
-        "@sa11y/format": "4.1.2",
-        "@sa11y/preset-rules": "4.1.2",
+        "@sa11y/assert": "4.1.3",
+        "@sa11y/format": "4.1.3",
+        "@sa11y/preset-rules": "4.1.3",
         "jest-matcher-utils": "^27"
     },
     "peerDependencies": {
@@ -34,8 +34,8 @@
     },
     "devDependencies": {
         "@jest/globals": "28.1.3",
-        "@sa11y/common": "4.1.2",
-        "@sa11y/test-utils": "4.1.2"
+        "@sa11y/common": "4.1.3",
+        "@sa11y/test-utils": "4.1.3"
     },
     "publishConfig": {
         "access": "public"
@@ -43,5 +43,5 @@
     "engines": {
         "node": "^14 || ^16"
     },
-    "gitHead": "6ae4e2c8424c321ac13d2d25f2e9a8a8579e85c6"
+    "gitHead": "0dd89aeb585291616b64ccd8026f2f18f84c8b4b"
 }