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

mohanraj-r · 2020-06-17T18:12:38Z

@sa11y/wdio

Add a @sa11y/wdio package that provides a assertAccessible() API that can be used with WebdriverIO to check accessibility of web pages rendered in browsers.
- Primary changes in packages/wdio/src/wdio.ts
While existing @sa11y packages provide support for unit testing - with virtual jsdom, this package provides testing accessibility in a real browser such as google chrome
- while reusing the existing @sa11y packages as much as possible

Other changes in this PR

Couldn't do a successful git rebase, hence this PR shows commits that are already in master - though they are not reflected in the diff.

preset-rules:
- add a full ruleset with all rules from axe
- rename extended ruleset to recommended, recommended preset rule to base
Fixes to formatting - w.r.t to handling undefined (fix(format): error when expect(elem).not.toBeAccessible is called on an elem with no a11y issues #18)
Pin axe-core, which is our primary dependency, so that we can be sure that users are using the same version of axe-core that we have tested with
Updates, additions to docs
- fix all Readme headings and structure for consistency
Bump versions
- changed release label from alpha to beta for all packages except wdio

TODO

Address all significant TODOs related to refactor in the new wdio package
Fix error when expect(elem).not.toBeAccessible is called on an elem with no a11y issues · Issue #18 · salesforce/sa11y
CircleCI runs wdio tests
Update to axe v3.5.5
Remove sematic-release dependency · Issue #24 · salesforce/sa11y
Bump versions, Update changelog

Post merge

Publish packages to npm
Publish github release

# Conflicts: # package.json

# Conflicts: # package.json # yarn.lock

based on https://github.com/salesforce/lwc

based on recommendations from https://tools.ietf.org/id/draft-knodel-terminology-00.html

https://webdriver.io/docs/gettingstarted.html

https://webdriver.io/docs/typescript.html

that has been moved to wdio

mohanraj-r · 2020-06-29T22:17:36Z

@cordeliadillon This PR contains the changes to ruleset names as discussed.

…st-utils

local files opened in browser need to have file:/// prefix

# Conflicts: # yarn.lock

trevor-bliss

Nice! Really only looked at the wdio changes btw...

packages/wdio/src/wdio.ts

packages/wdio/package.json

…r version match

mohanraj-r

Thanks for the review @trevor-bliss

packages/wdio/src/wdio.ts

packages/wdio/package.json

so that it can be consistent across different packages in the repo that use wdio

as the handle is already part of the reviewers group

as the wdio dependencies are part of the root dev deps

have to figure out why this hook never runs

since the last specified handle takes precedence and does not inherit from global scope

cordeliadillon · 2020-07-17T22:20:26Z

All the preset-rule renaming work looks good to me!

mohanraj-r · 2020-07-17T22:26:36Z

All the preset-rule renaming work looks good to me!

Thanks for the review @cordeliadillon 👍

Mohan Raj Rajamanickam added 30 commits June 2, 2020 20:37

build(deps): add semantic release deps

474aa7d

build(release): add semanic release config

b26f5fc

build: add cmds to list packages and its deps

c9f98f2

build(deps): add cmds for versioning, publishing, dep check

bfd79e4

build: add cmds to list packages and its deps

a0d8737

# Conflicts: # package.json

build: fix dep check cmd, add lint:deps cmd

805210a

fix(deps): add missing dependencies in package json

066522a

chore(release): bump versions

922af5d

build: fix dep check cmd

cef8a48

build: add deps, config for semantic release github plugin

521a197

build: add git hook to run yarn install when switching branches

66ad552

build: change release cmd, config in prep for merge to release branch

dd2bb29

docs(changelog): remove obsolete links, add PR links, cleanup

07fd558

Merge branch 'release-semantic' into release

03d2888

# Conflicts: # package.json # yarn.lock

build: add test debug script and update corresponding docs

384f46c

based on https://github.com/salesforce/lwc

docs(contributing): add notes on release process

219f2c2

chore: update yarn lockfile

c6cc630

docs(contributing): clarify about when to use release branch

a58303e

docs(jest): updates to readme for clarity

20b209f

docs(jest): add clarification on recommended ruleset

36241e3

test(cspell): add flagwords

293fa02

based on recommendations from https://tools.ietf.org/id/draft-knodel-terminology-00.html

test(integ): add integ test to inject axe using wdio

b4e9a64

docs(contrib): add note about yarn installing when changing branches

b897c2c

build(wdio): add scafolding for wdio package

ef565c8

build(wdio): add dev deps for wdio using wdio cli

7fe2de6

https://webdriver.io/docs/gettingstarted.html

build(wdio): add pkgs,config for wdio typescript integration

2fd6e4e

https://webdriver.io/docs/typescript.html

test(wdio): add tests to inject axe using wdio

95d5549

feat(wdio): add assert accessible API for WDIO

23e50ae

test(wdio): add tests using the wdio assert API

ee0b97a

revert(wdio): revert obsolete code in integ tests package

6db20b4

that has been moved to wdio

Mohan Raj Rajamanickam added 2 commits June 29, 2020 15:00

feat(preset-rules): add a full ruleset with all rules from axe

6367dd7

docs: update changelog with preset rule name changes

bbf6918

Mohan Raj Rajamanickam added 6 commits June 29, 2020 18:00

refactor(test-utils): de-duplicate test html data between wdio and te…

ce1275a

…st-utils

chore(release): bump versions

8d3116d

build(wdio): add test-utils as dev dep

ba7a85a

test(wdio): fix test file paths for wdio tests

70222d0

local files opened in browser need to have file:/// prefix

docs(wdio): add todo about reusing babel instead of ts-node

e8ec64a

Merge branch 'master' of github.com:salesforce/sa11y into wdio

95bba31

# Conflicts: # yarn.lock

trevor-bliss reviewed Jul 8, 2020

View reviewed changes

packages/wdio/src/wdio.ts Show resolved Hide resolved

packages/wdio/src/wdio.ts Outdated Show resolved Hide resolved

packages/wdio/package.json Outdated Show resolved Hide resolved

packages/wdio/package.json Show resolved Hide resolved

Mohan Raj Rajamanickam added 2 commits July 8, 2020 20:03

build(wdio,jest): fix peer dependencies to use >= to allow for broade…

eb0d195

…r version match

refactor(wdio): replace executeAsync with execute in get axe version

5eb52d6

mohanraj-r commented Jul 9, 2020

View reviewed changes

packages/wdio/src/wdio.ts Outdated Show resolved Hide resolved

packages/wdio/src/wdio.ts Show resolved Hide resolved

packages/wdio/package.json Show resolved Hide resolved

packages/wdio/package.json Outdated Show resolved Hide resolved

Mohan Raj Rajamanickam added 11 commits July 10, 2020 19:12

build(wdio): move wdio dev deps out of wdio package to root level

e44598d

so that it can be consistent across different packages in the repo that use wdio

chore: remove redundant github handle from code owners

ecf0f0d

as the handle is already part of the reviewers group

refactor(format): extract error msg header to a static var for reuse

884fa15

refactor(wdio): extract common test workflow into a test util method

0346bc3

chore: update deps - pickup latest webdriverio with fixes

d58873d

build(wdio): add wdio sync pkg

59fd9f8

test(wdio): add WIP integration test for sync mode

7f2e5cd

build(depcheck): update depcheck ignores for wdio and integration tests

5f1d80d

as the wdio dependencies are part of the root dev deps

feat(wdio): add a sync version of the assert accessible api

df5fe55

build(wdio): add build step to post checkout git hook

88d3519

have to figure out why this hook never runs

ci(github): add global reviewer as backup codeowner for preset-rules

8b3e2d2

since the last specified handle takes precedence and does not inherit from global scope

mohanraj-r requested a review from trevor-bliss July 22, 2020 17:57

trevor-bliss approved these changes Jul 27, 2020

View reviewed changes

mohanraj-r merged commit 1ac7486 into salesforce:master Jul 28, 2020

mohanraj-r deleted the wdio branch July 28, 2020 22:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

mohanraj-r commented Jun 17, 2020 •

edited

Loading

mohanraj-r commented Jun 29, 2020

trevor-bliss left a comment

mohanraj-r left a comment

cordeliadillon commented Jul 17, 2020

mohanraj-r commented Jul 17, 2020

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

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

Conversation

mohanraj-r commented Jun 17, 2020 • edited Loading

@sa11y/wdio

Other changes in this PR

TODO

Post merge

mohanraj-r commented Jun 29, 2020

trevor-bliss left a comment

Choose a reason for hiding this comment

mohanraj-r left a comment

Choose a reason for hiding this comment

cordeliadillon commented Jul 17, 2020

mohanraj-r commented Jul 17, 2020

mohanraj-r commented Jun 17, 2020 •

edited

Loading