feat(wdio): add wdio package for a11y testing with browsers

.circleci/config.yml

@@ -1,12 +1,15 @@
 version: 2.1
 orbs:
     node: circleci/[email protected]
+    browser-tools: circleci/[email protected]
 jobs:
     build-and-test:
         executor:
             name: node/default
             tag: 'lts'
         steps:
+            - browser-tools/install-chrome
+            - browser-tools/install-chromedriver
             - checkout
             - run: yarn build:ci
             - run: yarn test:ci

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+*   @salesforce/sa11y-reviewers
+/packages/preset-rules  @cordeliadillon @salesforce/sa11y-reviewers

.github/workflows-disabled/README.md

@@ -1,11 +1,8 @@
+# Github workflows
+
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-
-- [Github workflows](#github-workflows)
-
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
-# Github workflows
-
 Building and testing using Github CI has been disabled for this project due to [Build failure with Jest snapshot errors · Issue #14 · salesforce/sa11y](https://github.com/salesforce/sa11y/issues/14)

CHANGELOG.md

@@ -1,24 +1,55 @@
+# Changelog
+
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
 
-- [(2020-06-02)](#2020-06-02)
+- [(2020-06-25)](#2020-06-25)
     - [Features](#features)
-- [(2020-05-29)](#2020-05-29)
-    - [Features](#features-1)
-- [(2020-05-07)](#2020-05-07)
     - [Bug Fixes](#bug-fixes)
+    - [BREAKING CHANGES](#breaking-changes)
+- [(2020-06-02) v0.1.0-alpha](#2020-06-02-v010-alpha)
+    - [Features](#features-1)
+- [(2020-05-29)](#2020-05-29)
     - [Features](#features-2)
-- [(2020-04-07)](#2020-04-07)
+- [(2020-05-07)](#2020-05-07)
     - [Bug Fixes](#bug-fixes-1)
     - [Features](#features-3)
-- [(2020-03-20)](#2020-03-20)
+- [(2020-04-07)](#2020-04-07)
     - [Bug Fixes](#bug-fixes-2)
     - [Features](#features-4)
+- [(2020-03-20)](#2020-03-20)
+    - [Bug Fixes](#bug-fixes-3)
+    - [Features](#features-5)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
-# (2020-06-02)
+# (2020-06-25)
+
+### Features
+
+-   **wdio:** add assert accessible API for WDIO ([#21](https://github.com/salesforce/sa11y/pull/21))
+
+*   **preset-rules:** add a full ruleset with all rules from axe ([#21](https://github.com/salesforce/sa11y/pull/21))
+
+### Bug Fixes
+
+-   **format:** fix a11y error message to use formatted output ([#21](https://github.com/salesforce/sa11y/pull/21))
+-   **format:** check explicitly for undefined to allow custom formatter ([#21](https://github.com/salesforce/sa11y/pull/21))
+-   **jest:** fix a11y error being undefined when used with not matcher ([#21](https://github.com/salesforce/sa11y/pull/21)), closes [#18](https://github.com/salesforce/sa11y/issues/18)
+
+### BREAKING CHANGES
+
+-   **preset-rules:** align name and behavior to follow common naming conventions in terms of preset configs ([#21](https://github.com/salesforce/sa11y/pull/21))
+    -   rename `extended` ruleset to `recommended`
+        -   it continues to be the default and recommended
+    -   rename `recommended` preset rule to `base`
+    -   If you are not using the preset-rules explicitly in the APIs, this change will not affect you
+    -   But if you are using the preset-rules explicitly in your APIs, you will have to change them
+        -   If you are using the `recommended` preset-rule rename it to `base`
+        -   If you are using the `extended` preset-rule rename it to `recommended`
+
+# (2020-06-02) [v0.1.0-alpha](https://github.com/salesforce/sa11y/releases/tag/v0.1.0-alpha)
 
 ### Features
 

CONTRIBUTING.md

@@ -53,7 +53,7 @@ Before you start, it helps to be familiar with [Web Accessibility](https://trail
 -   `yarn test:watch`
 -   `yarn lint:watch`
 
-3. Update changelog with `yarn changelog`
+3. Update changelog with `yarn release:changelog`
 4. Stage changes in git and do `yarn commit` to check staged changes and commit them with a formatted commit message
 5. Push changes to feature branch
 
@@ -80,7 +80,8 @@ _We use [yarn](https://yarnpkg.com/) because it is significantly faster than npm
 yarn install
 ```
 
-If this fails with an error about _UNABLE_TO_GET_ISSUER_CERT_LOCALLY_, _Error: unable to get local issuer certificate_, or a registry communication issue then re-verify that step 2 was successful.
+-   Have to do this every time there are changes to `package.json` from external sources e.g. after switching branches or after merging/rebasing
+-   If this fails with an error about _UNABLE_TO_GET_ISSUER_CERT_LOCALLY_, _Error: unable to get local issuer certificate_, or a registry communication issue then re-verify that step 2 was successful.
 
 ## Building
 
@@ -124,15 +125,18 @@ Your test should now be running in the Chrome debugger. You get your handy conso
 
 ## Release
 
--   Cleanup `CHANGELOG` to remove references to squashed commits and replace them with references to corresponding PRs where possible
--   `yarn release:version` to bump versions
+-   Generate Changelog
+    -   `yarn release:changelog`
+    -   Cleanup `CHANGELOG` to remove references to squashed commits and replace them with references to corresponding PRs where possible
+-   `yarn release:version` to bump versions interactively
+    -   `yarn release:version:auto` to automatically determine version bump based on commits
 -   To publish packages to npm
     -   `npm login`
     -   `yarn release:publish`
--   Use `GH_TOKEN=<token> yarn release:semantic` to create a release in github
-    -   where `GH_TOKEN` is the [Github personal access token](https://github.com/semantic-release/github#github-authentication) created with `repo` permission
-    -   Update release notes to reflect Changelog
-    -   Add `--dry-run --debug` to simulate
+-   Create a release in github
+    -   Bump `version` in root `package.json` to reflect the changes to the packages since last release
+        -   Use that root `version` for the github release
+    -   Add release notes to reflect Changelog since last release
 -   If you couldn't make these changes in the last PR that went into master, you can make a separate PR for release
     -   Create a `release` branch from `master`
     -   Commit changes to versions, changelog

README.md

@@ -15,6 +15,7 @@ Salesforce Accessibility Automated Testing Libraries and Tools (@sa11y packages)
 - [Docs](#docs)
 - [Packages](#packages)
   - [Jest integration](#jest-integration)
+  - [WDIO integration](#wdio-integration)
   - [assertAccessible API](#assertaccessible-api)
   - [a11y results formatter](#a11y-results-formatter)
   - [Preset accessibility rules](#preset-accessibility-rules)
@@ -44,11 +45,14 @@ This repo contains the following packages
     -   integrates the [assertAccessible API](./packages/assert/README.md) with the [Jest assertion API](https://jestjs.io/docs/en/using-matchers)
 -   If you are looking to add accessibility testing to your Jest tests use this package
 
+### [WDIO integration](./packages/wdio/README.MD)
+
+-   Provides `assertAccessible()`, `assertAccessibleSync()` APIs that can be used with [WebdriverIO](https://webdriver.io/) to check accessibility of web pages rendered in browsers
+
 ### [assertAccessible API](./packages/assert/README.md)
 
 -   Checks DOM or HTML Element for accessibility issues and throws an error if a11y issues are found
--   If you are looking to add accessibility testing to your Javascript unit tests and _not_ using Jest,
-    use this package
+-   If you are looking to add accessibility testing to your Javascript unit tests and _not_ using Jest, use this package
 
 ### [a11y results formatter](./packages/format/README.md)
 
@@ -58,9 +62,9 @@ This repo contains the following packages
 
 ### [Preset accessibility rules](./packages/preset-rules/README.md)
 
--   Provides Recommended, Extended accessibility preset rules as [axe](https://github.com/dequelabs/axe-core) configuration
--   The Extended preset rule is used by default in the Jest a11y matcher and assert Accessible API
-    -   Both APIs can be overridden to use the Recommended ruleset
+-   Provides Base, Recommended, Full accessibility preset rules as [axe](https://github.com/dequelabs/axe-core) configuration
+-   The Recommended preset rule is used by default in the Jest a11y matcher and assert Accessible APIs
+    -   The APIs can be overridden to use the Base or Full ruleset as necessary
 
 ### Internal packages
 

cSpell.json

@@ -1,5 +1,6 @@
 {
     "ignorePaths": ["node_modules/**", "package.json"],
-    "ignoreWords": ["assertAccessible", "circleci", "CNCF", "doctoc", "SPDX", "tsdoc", "wcag"],
-    "ignoreRegExpList": ["ruleset"]
+    "ignoreWords": ["circleci", "CNCF", "dlitem", "doctoc", "SPDX", "tsdoc", "wcag", "wdio", "webdriverio"],
+    "flagWords": ["master-slave", "slave", "blacklist", "whitelist"],
+    "allowCompoundWords": true
 }

jest.config.js

@@ -6,6 +6,7 @@
  */
 
 const integrationTestPath = '<rootDir>/packages/test-integration';
+const wdioTestPath = '<rootDir>/packages/wdio';
 
 module.exports = {
     coverageThreshold: {
@@ -17,7 +18,7 @@ module.exports = {
         },
     },
     // Exclude integration tests from being run with config as it has its own config and setup
-    testPathIgnorePatterns: [integrationTestPath],
+    testPathIgnorePatterns: [integrationTestPath, wdioTestPath],
     // Direct Jest to read the jest config file from integration tests
     projects: ['<rootDir>', integrationTestPath],
 };

lerna.json

@@ -3,11 +3,5 @@
     "version": "independent",
     "exact": true,
     "npmClient": "yarn",
-    "useWorkspaces": true,
-    "command": {
-        "version": {
-            "allowBranch": "release",
-            "message": "chore(release): bump versions"
-        }
-    }
+    "useWorkspaces": true
 }

lint-staged.config.js

@@ -0,0 +1,14 @@
+/*
+ * Copyright (c) 2020, 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
+ */
+
+module.exports = {
+    '**/*.{js,ts,json,yaml,yml,md}': 'prettier --write',
+    '**/*.{js,ts,md}': ['eslint --fix', 'cspell -- --no-summary'],
+    '**/*.md': ['markdown-link-check --quiet --config mdLinkChecker.json', 'doctoc --github'],
+    'yarn.lock': 'yarn lint:lockfile',
+    'package.json': () => 'yarn install',
+};

package.json

@@ -1,5 +1,6 @@
 {
-    "name": "root",
+    "name": "sa11y-monorepo",
+    "version": "0.2.0-beta",
     "private": true,
     "description": "Salesforce Accessibility Automated Testing Libraries and Tools (@sa11y packages)",
     "license": "BSD-3-Clause",
@@ -19,7 +20,6 @@
         "build:ci": "yarn install --frozen-lockfile && yarn build",
         "build:clean": "yarn build --clean && rimraf packages/**/dist && yarn install && yarn build",
         "build:watch": "yarn build --watch",
-        "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s && git add CHANGELOG.md",
         "commit": "! git diff --cached --exit-code && lint-staged && git-cz",
         "install:clean": "lerna clean --yes; yarn install",
         "lint": "eslint . --ext ts,js,md",
@@ -31,14 +31,17 @@
         "lint:watch": "esw --watch --changed --color --ext .js,.ts",
         "pkg:list": "lerna list --long --all --toposort",
         "pkg:deps": "yarn pkg:list --graph",
+        "release:changelog": "conventional-changelog --infile CHANGELOG.md --same-file --preset angular --output-unreleased",
+        "release:version": "yarn lerna version --no-push --no-git-tag-version",
+        "release:version:auto": "yarn release:version --conventional-commits --no-changelog",
         "release:publish": "yarn lerna publish from-package",
-        "release:version": "yarn lerna version --conventional-prerelease --no-push --no-git-tag-version",
-        "release:semantic": "semantic-release",
         "test": "jest --coverage",
+        "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:ci": "yarn lint:all && yarn test --ci",
         "test:watch": "yarn test --watch",
-        "update": "ncu; lerna exec ncu; yarn install; yarn upgrade; yarn audit; yarn outdated"
+        "test:wdio": "yarn workspace @sa11y/wdio test",
+        "update": "yarn audit; yarn upgrade-interactive --latest && yarn test:clean"
     },
     "config": {
         "commitizen": {
@@ -49,64 +52,56 @@
         "hooks": {
             "commit-msg": "commitlint -e $GIT_PARAMS",
             "pre-commit": "lint-staged",
-            "pre-push": "yarn build:clean && yarn test:ci",
-            "post-checkout": "yarn install"
+            "pre-push": "yarn test:clean",
+            "post-checkout": "yarn install && yarn build"
         }
     },
-    "lint-staged": {
-        "**/*.{js,ts,json,yaml,yml,md}": "prettier --write",
-        "**/*.{js,ts,md}": [
-            "eslint --fix",
-            "cspell -- --no-summary"
-        ],
-        "**/*.md": [
-            "markdown-link-check --quiet --config mdLinkChecker.json",
-            "doctoc --github"
-        ],
-        "yarn.lock": "yarn lint:lockfile"
-    },
     "devDependencies": {
-        "@babel/core": "^7.9.6",
-        "@babel/preset-env": "^7.9.6",
-        "@babel/preset-typescript": "^7.9.0",
-        "@commitlint/cli": "^8.3.5",
-        "@commitlint/config-conventional": "^8.3.4",
-        "@semantic-release/changelog": "^5.0.1",
-        "@semantic-release/git": "^9.0.0",
-        "@semantic-release/github": "^7.0.7",
-        "@types/jest": "^25.2.2",
-        "@types/node": "^12.12.31",
+        "@babel/core": "^7.10.4",
+        "@babel/preset-env": "^7.10.4",
+        "@babel/preset-typescript": "^7.10.4",
+        "@commitlint/cli": "^9.1.1",
+        "@commitlint/config-conventional": "^9.1.1",
+        "@types/jest": "^26.0.4",
+        "@types/node": "^14.0.23",
         "@typescript-eslint/eslint-plugin": "^2.33.0",
         "@typescript-eslint/parser": "^2.33.0",
-        "babel-jest": "^26.0.1",
+        "@wdio/cli": "^6.2.0",
+        "@wdio/local-runner": "^6.2.0",
+        "@wdio/mocha-framework": "^6.2.0",
+        "@wdio/spec-reporter": "^6.1.23",
+        "@wdio/sync": "^6.2.0",
+        "babel-jest": "^26.1.0",
+        "chromedriver": "^83.0.1",
         "commitizen": "^4.1.2",
         "conventional-changelog-cli": "^2.0.34",
         "cspell": "^4.0.61",
-        "depcheck": "^0.9.2",
+        "depcheck": "^1.0.0",
         "doctoc": "^1.4.0",
-        "eslint": "^7.0.0",
+        "eslint": "^7.4.0",
         "eslint-config-prettier": "^6.11.0",
         "eslint-import-resolver-typescript": "^2.0.0",
         "eslint-plugin-eslint-comments": "^3.1.2",
-        "eslint-plugin-import": "^2.20.2",
-        "eslint-plugin-jest": "^23.11.0",
+        "eslint-plugin-import": "^2.22.0",
+        "eslint-plugin-jest": "^23.18.0",
         "eslint-plugin-license-header": "^0.2.0",
         "eslint-plugin-markdown": "^2.0.0-alpha.0",
         "eslint-plugin-notice": "^0.9.10",
-        "eslint-plugin-prettier": "^3.1.3",
+        "eslint-plugin-prettier": "^3.1.4",
         "eslint-plugin-tsdoc": "^0.2.4",
-        "eslint-watch": "^6.0.1",
+        "eslint-watch": "^7.0.0",
         "husky": "^4.2.5",
-        "jest": "^26.0.1",
+        "jest": "^26.1.0",
         "lerna": "^3.21.0",
         "lint-staged": "^10.2.2",
-        "lockfile-lint": "^4.3.4",
+        "lockfile-lint": "^4.3.7",
         "markdown-link-check": "^3.8.1",
-        "npm-check-updates": "^5.0.0",
-        "prettier": "2.0.5",
+        "prettier": "^2.0.5",
         "rimraf": "^3.0.2",
-        "semantic-release": "^17.0.8",
-        "typescript": "^3.9.2"
+        "ts-node": "^8.10.2",
+        "typescript": "^3.9.6",
+        "wdio-chromedriver-service": "^6.0.3",
+        "webdriverio": "^6.2.0"
     },
     "engines": {
         "node": "^10 || ^12"