feat(jest): add custom results processor for a11y failures

.circleci/config.yml

@@ -1,7 +1,7 @@
 version: 2.1
 orbs:
-    node: circleci/node@4.1.0
-    browser-tools: circleci/[email protected].0
+    node: circleci/node@4.5.0
+    browser-tools: circleci/[email protected].3
 jobs:
     build-and-test:
         executor:

.eslintrc.js

@@ -56,6 +56,7 @@ module.exports = {
                 templateFile: 'license-header.txt',
             },
         ],
+        '@typescript-eslint/no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
         '@typescript-eslint/naming-convention': 'error',
         'tsdoc/syntax': 'warn',
         'prefer-arrow-callback': 'warn',

CHANGELOG.md

@@ -3,49 +3,61 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-- [0.8.0-beta](#080-beta)
+- [0.9.0-beta](#090-beta)
     - [Features](#features)
+- [0.8.0-beta (2021-03-19)](#080-beta-2021-03-19)
+    - [Features](#features-1)
     - [BREAKING CHANGES](#breaking-changes)
     - [Refactor](#refactor)
 - [0.7.0-beta (2021-02-24)](#070-beta-2021-02-24)
-    - [Features](#features-1)
-- [0.6.0-beta (2021-01-22)](#060-beta-2021-01-22)
     - [Features](#features-2)
-- [0.5.0-beta (2020-12-01)](#050-beta-2020-12-01)
+- [0.6.0-beta (2021-01-22)](#060-beta-2021-01-22)
     - [Features](#features-3)
+- [0.5.0-beta (2020-12-01)](#050-beta-2020-12-01)
+    - [Features](#features-4)
 - [0.4.1-beta (2020-11-24)](#041-beta-2020-11-24)
     - [Bug Fixes](#bug-fixes)
 - [0.4.0-beta (2020-10-31)](#040-beta-2020-10-31)
-    - [Features](#features-4)
+    - [Features](#features-5)
     - [Refactor](#refactor-1)
   - [0.3.2-beta (2020-09-22)](#032-beta-2020-09-22)
     - [Bug Fixes](#bug-fixes-1)
     - [Refactor](#refactor-2)
 - [0.3.1-beta (2020-08-20)](#031-beta-2020-08-20)
     - [Refactor](#refactor-3)
 - [0.3.0-beta (2020-08-19)](#030-beta-2020-08-19)
-    - [Features](#features-5)
-- [0.2.0-beta (2020-06-25)](#020-beta-2020-06-25)
     - [Features](#features-6)
+- [0.2.0-beta (2020-06-25)](#020-beta-2020-06-25)
+    - [Features](#features-7)
     - [Bug Fixes](#bug-fixes-2)
     - [BREAKING CHANGES](#breaking-changes-1)
 - [v0.1.0-alpha (2020-06-02)](#v010-alpha-2020-06-02)
-    - [Features](#features-7)
-- [(2020-05-29)](#2020-05-29)
     - [Features](#features-8)
+- [(2020-05-29)](#2020-05-29)
+    - [Features](#features-9)
 - [(2020-05-07)](#2020-05-07)
     - [Bug Fixes](#bug-fixes-3)
-    - [Features](#features-9)
+    - [Features](#features-10)
 - [(2020-04-07)](#2020-04-07)
     - [Bug Fixes](#bug-fixes-4)
-    - [Features](#features-10)
+    - [Features](#features-11)
 - [(2020-03-20)](#2020-03-20)
     - [Bug Fixes](#bug-fixes-5)
-    - [Features](#features-11)
+    - [Features](#features-12)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
-# [0.8.0-beta] (2021-03-19)
+# [0.9.0-beta] (2021-06-15)
+
+### Features
+
+-   **jest:** de-duplicate a11y failures for automatic checks ([#61](https://github.com/salesforce/sa11y/issues/61))
+-   **jest:** add a custom test results processor ([#62](https://github.com/salesforce/sa11y/pull/62))
+    -   create a new test suite to hold a11y errors
+    -   add wcag metadata to results output
+    -   transform a11y error details into suite, test names
+
+# [0.8.0-beta](https://github.com/salesforce/sa11y/releases/tag/v0.8.0-beta) (2021-03-19)
 
 ### Features
 

CONTRIBUTING.md

@@ -15,6 +15,7 @@ We want to encourage the developer community to contribute to Sa11y. This guide
   - [Unit Testing](#unit-testing)
   - [Integration Testing](#integration-testing)
 - [Release](#release)
+    - [Upgrade dependencies](#upgrade-dependencies)
     - [Use local npm registry for testing](#use-local-npm-registry-for-testing)
 - [Editor Configurations](#editor-configurations)
   - [Types](#types)
@@ -161,6 +162,16 @@ Your test should now be running in the Chrome debugger. You get your handy conso
     -   Push the `release` branch and create a pull request against `master`
         -   with PR title of the format `chore(release): ...`
 
+#### Upgrade dependencies
+
+-   `yarn install:update`
+    -   Select dependencies to update
+-   Check for CircleCI Orb updates
+    -   [circleci/node](https://circleci.com/developer/orbs/orb/circleci/node)
+    -   [circleci/browser-tools](https://circleci.com/developer/orbs/orb/circleci/browser-tools)
+    -   update CircleCI config file
+    -   [Test CI config](#test-ci-config)
+
 #### Use local npm registry for testing
 
 -   Use [verdaccio](https://github.com/verdaccio/verdaccio) to spin-up a local npm registry

jest.config.js

@@ -22,4 +22,10 @@ module.exports = {
     testPathIgnorePatterns: [browserLibTestPath, integrationTestPath, wdioTestPath],
     // Direct Jest to read the jest config file from integration tests
     projects: ['<rootDir>', integrationTestPath],
+    testEnvironment: 'jsdom',
+    // Custom results processor for a11y results. Only affects JSON results file output.
+    // To be used with jest cli options --json --outputFile
+    //   *  e.g. jest --json --outputFile jestResults.json
+    // Ref: https://jestjs.io/docs/configuration#testresultsprocessor-string
+    testResultsProcessor: '<rootDir>/packages/jest/dist/resultsProcessor.js',
 };

package.json

@@ -1,6 +1,6 @@
 {
     "name": "sa11y-monorepo",
-    "version": "0.8.0-beta",
+    "version": "0.9.0-beta",
     "private": true,
     "description": "Salesforce Accessibility Automated Testing Libraries and Tools (@sa11y packages)",
     "license": "BSD-3-Clause",
@@ -40,11 +40,12 @@
         "release:version": "yarn pkg:diff; lerna version --no-push --no-git-tag-version && yarn build:clean",
         "release:version:auto": "yarn release:version --conventional-commits --no-changelog && yarn build:clean",
         "release:publish": "yarn test:clean && lerna publish from-package",
-        "test": "jest --coverage",
+        "test": "jest --coverage --runInBand",
         "test:ci": "yarn lint:all && yarn test --ci && yarn test:wdio",
         "test:clean": "yarn build:clean && yarn test:ci",
-        "test:debug": "node --inspect node_modules/.bin/jest --runInBand --watch",
+        "test:debug": "SA11Y_DEBUG=1 node --inspect node_modules/.bin/jest --runInBand --watch",
         "test:watch": "jest --watch",
+        "test:auto": "SA11Y_AUTO=1 yarn test --json --outputFile jestResults.json",
         "test:wdio": "wdio run wdio.conf.js --suite wdio --suite integration --suite browserLib < /dev/null",
         "prepare": "husky install"
     },
@@ -54,50 +55,50 @@
         }
     },
     "devDependencies": {
-        "@babel/core": "7.14.0",
-        "@babel/preset-env": "7.14.1",
-        "@babel/preset-typescript": "7.13.0",
-        "@commitlint/cli": "12.1.1",
-        "@commitlint/config-conventional": "12.1.1",
+        "@babel/core": "7.14.6",
+        "@babel/preset-env": "7.14.5",
+        "@babel/preset-typescript": "7.14.5",
+        "@commitlint/cli": "12.1.4",
+        "@commitlint/config-conventional": "12.1.4",
         "@types/jest": "26.0.23",
-        "@types/node": "15.0.2",
-        "@typescript-eslint/eslint-plugin": "4.22.1",
-        "@typescript-eslint/parser": "4.22.1",
+        "@types/node": "15.12.2",
+        "@typescript-eslint/eslint-plugin": "4.27.0",
+        "@typescript-eslint/parser": "4.27.0",
         "@wdio/cli": "6.12.1",
         "@wdio/local-runner": "6.10.5",
         "@wdio/mocha-framework": "6.10.4",
         "@wdio/spec-reporter": "6.11.0",
         "@wdio/sync": "6.10.4",
-        "babel-jest": "26.6.3",
-        "chromedriver": "90.0.0",
+        "babel-jest": "27.0.2",
+        "chromedriver": "91.0.1",
         "codecov": "3.8.2",
-        "commitizen": "4.2.3",
+        "commitizen": "4.2.4",
         "conventional-changelog-cli": "2.1.1",
-        "cspell": "5.4.0",
-        "depcheck": "1.4.0",
-        "doctoc": "2.0.0",
-        "eslint": "7.25.0",
+        "cspell": "5.6.4",
+        "depcheck": "1.4.1",
+        "doctoc": "2.0.1",
+        "eslint": "7.28.0",
         "eslint-config-prettier": "8.3.0",
         "eslint-import-resolver-typescript": "2.4.0",
         "eslint-plugin-eslint-comments": "3.2.0",
-        "eslint-plugin-import": "2.22.1",
+        "eslint-plugin-import": "2.23.4",
         "eslint-plugin-jest": "24.3.6",
-        "eslint-plugin-markdown": "2.1.0",
+        "eslint-plugin-markdown": "2.2.0",
         "eslint-plugin-notice": "0.9.10",
         "eslint-plugin-prettier": "3.4.0",
         "eslint-plugin-tsdoc": "0.2.14",
         "eslint-watch": "7.0.0",
         "husky": "6.0.0",
         "jest": "26.6.3",
         "lerna": "4.0.0",
-        "lint-staged": "10.5.4",
+        "lint-staged": "11.0.0",
         "lockfile-lint": "4.6.2",
         "markdown-link-check": "3.8.7",
         "package-dependency-graph": "1.11.2",
-        "prettier": "2.2.1",
+        "prettier": "2.3.1",
         "rimraf": "3.0.2",
-        "ts-node": "9.1.1",
-        "typescript": "4.2.4",
+        "ts-node": "10.0.0",
+        "typescript": "4.3.2",
         "vertioner": "1.0.6",
         "wdio-chromedriver-service": "6.0.4",
         "webdriverio": "6.12.1"

packages/assert/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sa11y/assert",
-    "version": "0.2.3",
+    "version": "0.2.4",
     "description": "Provides assertAccessible API to check DOM for accessibility issues",
     "license": "BSD-3-Clause",
     "homepage": "https://github.com/salesforce/sa11y/tree/master/packages/assert#readme",
@@ -21,13 +21,13 @@
         "dist/**/*.d.ts*"
     ],
     "dependencies": {
-        "@sa11y/common": "0.3.0",
-        "@sa11y/format": "0.3.4",
+        "@sa11y/common": "0.3.1",
+        "@sa11y/format": "0.4.0",
         "@sa11y/preset-rules": "0.3.3",
         "axe-core": "4.1.4"
     },
     "devDependencies": {
-        "@sa11y/test-utils": "0.4.0"
+        "@sa11y/test-utils": "0.4.1"
     },
     "publishConfig": {
         "access": "public"

packages/browser-lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sa11y/browser-lib",
-    "version": "0.4.0",
+    "version": "0.4.1",
     "description": "Provides a minified version of selected `@sa11y` libraries to be injected into a browser (using webdriver) and executed from integration testing workflows.",
     "license": "BSD-3-Clause",
     "homepage": "https://github.com/salesforce/sa11y/tree/master/packages/browser-lib#readme",
@@ -34,16 +34,16 @@
         "url": "https://github.com/salesforce/sa11y/issues"
     },
     "dependencies": {
-        "@sa11y/format": "0.3.4",
+        "@sa11y/format": "0.4.0",
         "@sa11y/preset-rules": "0.3.3",
         "axe-core": "4.1.4"
     },
     "devDependencies": {
-        "@rollup/plugin-commonjs": "18.1.0",
+        "@rollup/plugin-commonjs": "19.0.0",
         "@rollup/plugin-node-resolve": "13.0.0",
-        "@sa11y/common": "0.3.0",
-        "@sa11y/test-utils": "0.4.0",
-        "rollup": "2.47.0",
+        "@sa11y/common": "0.3.1",
+        "@sa11y/test-utils": "0.4.1",
+        "rollup": "2.51.2",
         "rollup-plugin-polyfill-node": "0.6.2",
         "rollup-plugin-progress": "1.1.2",
         "rollup-plugin-sizes": "1.0.4",

packages/common/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sa11y/common",
-    "version": "0.3.0",
+    "version": "0.3.1",
     "description": "Common utilities, constants, error messages for @sa11y",
     "license": "BSD-3-Clause",
     "homepage": "https://github.com/salesforce/sa11y/tree/master/packages/common#readme",

packages/common/src/format.ts

@@ -6,7 +6,7 @@
  */
 import { AxeResults } from './axe';
 
-export const errMsgHeader = 'accessibility issues found';
+export const errMsgHeader = 'Accessibility issues found';
 
 /**
  * Filter to post-process a11y results from axe

packages/common/src/helpers.ts

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+/**
+ * Convenience wrapper to prefix a standard header for console log messages.
+ * Logging is enabled only when environment variable `SA11Y_DEBUG` is set.
+ */
+export function log(...args: unknown[]): void {
+    // Probably not worth it to mock and test console logging for this helper util
+    /* istanbul ignore next */
+    if (process.env.SA11Y_DEBUG) console.log('♿[Sa11y]', ...args);
+}

packages/common/src/index.ts

@@ -8,3 +8,4 @@
 export { A11yConfig, AxeResults, axeRuntimeExceptionMsgPrefix, axeVersion, getViolations } from './axe';
 export { WdioAssertFunction, WdioOptions, WdioBrowser } from './wdio';
 export { errMsgHeader, ExceptionList } from './format';
+export { log } from './helpers';