Browserstack Accessibility support with WebdriverIO 🚀 by kamal-kaur04 · Pull Request #11064 · webdriverio/webdriverio

kamal-kaur04 · 2023-08-31T11:54:09Z

Proposed changes

BrowserStack Accessibility Automation Support to conduct accessibility testing on pre-existing test builds and generate health reports on BrowserStack

Types of changes

Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation update

Checklist

I have read the CONTRIBUTING doc
I have added tests that prove my fix is effective or that my feature works
I have added necessary documentation (if appropriate)
I have added proper type definitions for new commands (if appropriate)

Further comments

Reviewers: @webdriverio/project-committers

kamal-kaur04 · 2023-08-31T11:59:18Z

@christian-bromann Request your review on the above PR created against v8. Once the review finishes for this PR, will create a PR against v7 also.

Thanks!

packages/wdio-browserstack-service/src/accessibility-handler.ts

packages/wdio-browserstack-service/src/types.ts

packages/wdio-types/src/Capabilities.ts

kamal-kaur04 · 2023-08-31T19:05:01Z

@christian-bromann Thanks for the quick review. Have resolved most of the review comments.

christian-bromann · 2023-09-02T19:11:17Z

packages/wdio-browserstack-service/src/scripts/test-event-scripts.ts

+}
+
+export function accessibilityResultsSummary() {
+    return `


No need to return a string as it would remove all the code highlighting and prevents us from being able to test it. You can do this:

scripts.ts

export function accessibilityResultsSummary (paramA, paramB) { return new Promise(... // ... }

in your service file:

import { accessibilityResultsSummary } from './scripts.js' // ... await browser.execute(accessibilityResultsSummary, paramA, paramB)

@christian-bromann Could you please let me know, are you referring tests as lint tests or any other tests? Unit Tests don't seem to be feasible to test scripts. Any suggestions or thoughts here?

Unit Tests don't seem to be feasible to test scripts

How so? Vitest allows running in JSDOM mode and we could even test the function in the browser using WebdriverIO itself 😉

packages/wdio-browserstack-service/src/accessibility-handler.ts

christian-bromann · 2023-09-02T19:18:54Z

packages/wdio-browserstack-service/src/accessibility-handler.ts

+
+        if (!this.shouldRunTestHooks(this._browser, this._accessibility)) {
+            return
+        }


packages/wdio-browserstack-service/src/accessibility-handler.ts

christian-bromann · 2023-09-02T19:19:07Z

packages/wdio-browserstack-service/src/accessibility-handler.ts

+
+        if (!this.shouldRunTestHooks(this._browser, this._accessibility)) {
+            return
+        }


packages/wdio-browserstack-service/src/accessibility-handler.ts

packages/wdio-browserstack-service/src/types.ts

…-support

kamal-kaur04 · 2023-09-11T17:16:57Z

@christian-bromann Please check, have resolved most of the comments.

christian-bromann

Awesome, lgtm 👍

kamal-kaur04 · 2023-09-18T16:08:27Z

@christian-bromann Thanks for releasing the changes. Are these changes good to be raised against for WebDriverIO v7 branch as well?

christian-bromann · 2023-09-18T16:09:26Z

Yes, but the v7 branch seems currently broken and I haven't had time to look into why.

kamal-kaur04 · 2023-09-18T17:56:11Z

Okay, when running unit tests, encountered an error. Is this known test failure? -

Details:

    /Users/kamalpreet/Documents/frameworks-core-forks/webdriverio/packages/wdio-sauce-service/node_modules/query-string/index.js:1
    ({"Object.<anonymous>":function(module,exports,require,__dirname,__filename,jest){import * as queryString from './base.js';
                                                                                      ^^^^^^

    SyntaxError: Cannot use import statement outside a module

      at Runtime.createScriptFromCode (node_modules/jest-runtime/build/index.js:1796:14)
      at Object.<anonymous> (packages/wdio-sauce-service/node_modules/saucelabs/build/index.js:13:43)

christian-bromann · 2023-09-18T18:30:32Z

There is a known issue for this in the saucelabs dependency, we had to downgrade the saucelabs package version, see saucelabs/node-saucelabs#207. I think we have to do the same in v7

kamal-kaur04 added 6 commits August 29, 2023 17:07

init: Accessibility support for WebdriverIO

26dae1d

chore: fix lint issues

496a9f2

add: tests for the service

8c8f9e7

chore: more unit tests - util methods

21b6366

chore: add accessibility true check in hooks and some refactoring

9322a3d

chore: change method name

42636db

christian-bromann reviewed Aug 31, 2023

View reviewed changes

chore: refactoring as per comments

df4b826

kamal-kaur04 and others added 4 commits September 1, 2023 01:01

chore: typo fix

b16fa91

update: make accessibility of type boolean | undefined

1e4ea83

Merge branch 'main' into browserstack-accessibility-support

9fac6e1

chore: added more tests - coverage drop

3ab83f6

christian-bromann reviewed Sep 2, 2023

View reviewed changes

kamal-kaur04 added 4 commits September 11, 2023 17:36

Merge remote-tracking branch 'origin' into browserstack-accessibility…

f4c72b3

…-support

chore: refactoring code

6a71009

chore: add types to the methods

af618a8

chore: change type for accessibilityResultsSummary

88c3629

christian-bromann approved these changes Sep 12, 2023

View reviewed changes

christian-bromann added the PR: New Feature 🚀 PRs that contain new features label Sep 12, 2023

christian-bromann merged commit 3f38778 into webdriverio:main Sep 12, 2023

Uh oh!

Conversation

kamal-kaur04 commented Aug 31, 2023

Proposed changes

Types of changes

Checklist

Further comments

Reviewers: @webdriverio/project-committers

Uh oh!

kamal-kaur04 commented Aug 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kamal-kaur04 commented Aug 31, 2023

Uh oh!

christian-bromann Sep 2, 2023

Choose a reason for hiding this comment

Uh oh!

kamal-kaur04 Sep 11, 2023

Choose a reason for hiding this comment

Uh oh!

christian-bromann Sep 12, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

christian-bromann Sep 2, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

christian-bromann Sep 2, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kamal-kaur04 commented Sep 11, 2023

Uh oh!

christian-bromann left a comment

Choose a reason for hiding this comment

Uh oh!

kamal-kaur04 commented Sep 18, 2023

Uh oh!

christian-bromann commented Sep 18, 2023

Uh oh!

kamal-kaur04 commented Sep 18, 2023

Uh oh!

christian-bromann commented Sep 18, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kamal-kaur04 commented Aug 31, 2023 •

edited

Loading