Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(webdriverio): Recursively find <frame> #238

Merged
merged 11 commits into from
May 5, 2021
Merged

fix(webdriverio): Recursively find <frame> #238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
24b1d71
Recursively find "frame"s and inject axe.js, not only "iframe"s
yokra9 Mar 14, 2021
429e06f
Merge branch 'develop' into fix-recursively-find-frame
michael-siek Mar 19, 2021
65347ef
Merge branch 'develop' into fix-recursively-find-frame
dylanb Mar 24, 2021
cf98b0f
Merge branch 'develop' into fix-recursively-find-frame
michael-siek Apr 5, 2021
637de84
test(webdriverjs): add unit test for <frame>
yokra9 Apr 6, 2021
f39a9ee
refactor(webdriverjs): remove unused test fixtures
yokra9 Apr 6, 2021
b8e8949
Merge remote-tracking branch 'dequelabs/develop' into fix-recursively…
yokra9 Apr 30, 2021
c1f1363
fix(webdriverio): Recursively find <frame>
yokra9 Apr 30, 2021
4d6235f
test(webdriverio): add unit test for <frame>
yokra9 Apr 30, 2021
d4f9955
Merge remote-tracking branch 'dequelabs/develop' into fix-recursively…
yokra9 Apr 30, 2021
36abf50
refactor(webdriverio): istanbul ignore default assignments
yokra9 Apr 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions packages/webdriverio/fixtures/frames/bar.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
<head>
<title>Bar</title>
</head>
<body>
<h1>Bar</h1>
<iframe src="/frames/baz.html"></iframe>
</body>
<frameset>
<frame src="/frames/baz.html">
</frameset>
</html>
7 changes: 3 additions & 4 deletions packages/webdriverio/fixtures/frames/foo.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
<head>
<title>Foo</title>
</head>
<body>
<h1>Foo</h1>
<iframe src="/frames/bar.html"></iframe>
</body>
<frameset>
<frame src="/frames/bar.html">
</frameset>
</html>
7 changes: 3 additions & 4 deletions packages/webdriverio/fixtures/frames/recursive.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
<head>
<title>Recursive</title>
</head>
<body>
<h1>Recursive</h1>
<iframe src="/frames/recursive.html"></iframe>
</body>
<frameset>
<frame src="/frames/recursive.html">
</frameset>
</html>
10 changes: 10 additions & 0 deletions packages/webdriverio/fixtures/iframes/bar.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html>
<head>
<title>Bar</title>
</head>
<body>
<h1>Bar</h1>
<iframe src="/iframes/baz.html"></iframe>
</body>
</html>
9 changes: 9 additions & 0 deletions packages/webdriverio/fixtures/iframes/baz.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!DOCTYPE html>
<html>
<head>
<title>Baz</title>
</head>
<body>
<h1>Baz</h1>
</body>
</html>
10 changes: 10 additions & 0 deletions packages/webdriverio/fixtures/iframes/foo.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html>
<head>
<title>Foo</title>
</head>
<body>
<h1>Foo</h1>
<iframe src="/iframes/bar.html"></iframe>
</body>
</html>
10 changes: 10 additions & 0 deletions packages/webdriverio/fixtures/iframes/recursive.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html>
<head>
<title>Recursive</title>
</head>
<body>
<h1>Recursive</h1>
<iframe src="/iframes/recursive.html"></iframe>
</body>
</html>
8 changes: 3 additions & 5 deletions packages/webdriverio/fixtures/nested-frames.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@
<head>
<title>Nested Frames</title>
</head>
<body>
<h1>This page has nested frames!</h1>
<br /><br /><br />
<iframe src="/frames/foo.html"></iframe>
</body>
<frameset>
<frame src="/frames/foo.html">
</frameset>
</html>
11 changes: 11 additions & 0 deletions packages/webdriverio/fixtures/nested-iframes.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html>
<head>
<title>Nested Frames</title>
</head>
<body>
<h1>This page has nested frames!</h1>
<br /><br /><br />
<iframe src="/iframes/foo.html"></iframe>
</body>
</html>
10 changes: 4 additions & 6 deletions packages/webdriverio/fixtures/recursive-frames.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,8 @@
<head>
<title>Recursive Frames</title>
</head>
<body>
<h1>This page has a weird recursive frams!</h1>
<br /><br /><br />
<iframe src="/frames/baz.html"></iframe>
<iframe src="/frames/recursive.html"></iframe>
</body>
<frameset>
<frame src="/frames/baz.html">
<frame src="/frames/recursive.html">
</frameset>
</html>
12 changes: 12 additions & 0 deletions packages/webdriverio/fixtures/recursive-iframes.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!DOCTYPE html>
<html>
<head>
<title>Recursive Frames</title>
</head>
<body>
<h1>This page has a weird recursive frams!</h1>
<br /><br /><br />
<iframe src="/iframes/baz.html"></iframe>
<iframe src="/iframes/recursive.html"></iframe>
</body>
</html>
22 changes: 20 additions & 2 deletions packages/webdriverio/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,12 @@ export default class AxeBuilder {
await this.setBrowsingContext(browsingContext);
await this.client.execute(this.script);

const iframes = (await this.client.$$(this.iframeSelector())) || [];
const frames =
(await this.client.$$(this.frameSelector())) ||
/* istanbul ignore next */ [];
const iframes =
frames.concat(await this.client.$$(this.iframeSelector())) ||
/* istanbul ignore next */ [];
if (!iframes.length) {
return;
}
Expand All @@ -215,7 +220,7 @@ export default class AxeBuilder {
}

/**
* Get a CSS selector for retrieving child frames.
* Get a CSS selector for retrieving child iframes.
* @returns {String}
*/

Expand All @@ -227,6 +232,19 @@ export default class AxeBuilder {
return selector;
}

/**
* Get a CSS selector for retrieving child frames.
* @returns {String}
*/

private frameSelector(): string {
let selector = 'frame';
for (const disableFrameSelector of this.disableFrameSelectors) {
selector += `:not(${disableFrameSelector})`;
}
return selector;
}

/**
* Set browsing context - when `null` sets top level page as context
* - https://webdriver.io/docs/api/webdriver.html#switchtoframe
Expand Down
48 changes: 42 additions & 6 deletions packages/webdriverio/src/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,26 @@ describe('@axe-core/webdriverio', () => {
});
});

describe('disableIframe', () => {
it('does not inject into disabled iframes', async () => {
await client.url(`${addr}/recursive-iframes.html`);
const executeSpy = sinon.spy(client, 'execute');
await new AxeBuilder({ client })
.disableFrame('[src*="recursive.html"]')
.analyze();
assert.strictEqual(executeSpy.callCount, 2);
});

it('does not error when disabled iframe does not exist', async () => {
await client.url(`${addr}/recursive-iframes.html`);
const executeSpy = sinon.spy(client, 'execute');
await new AxeBuilder({ client })
.disableFrame('[src*="does-not-exist.html"]')
.analyze();
assert.strictEqual(executeSpy.callCount, 5);
});
});

describe('disableFrame', () => {
it('does not inject into disabled frames', async () => {
await client.url(`${addr}/recursive-frames.html`);
Expand Down Expand Up @@ -171,16 +191,16 @@ describe('@axe-core/webdriverio', () => {
});

describe('iframe tests', () => {
it('injects into nested frames', async () => {
await client.url(`${addr}/nested-frames.html`);
it('injects into nested iframes', async () => {
await client.url(`${addr}/nested-iframes.html`);
const executeSpy = sinon.spy(client, 'execute');
await new AxeBuilder({ client }).analyze();
/**
* Ensure we called execute 4 times
* 1. nested-frames.html
* 2. foo.html
* 3. bar.html
* 4. baz.html
* 1. nested-iframes.html
* 2. iframes/foo.html
* 3. iframes/bar.html
* 4. iframes/baz.html
*/
assert.strictEqual(executeSpy.callCount, 4);
});
Expand All @@ -192,6 +212,22 @@ describe('@axe-core/webdriverio', () => {
});
});

describe('frame tests', () => {
it('injects into nested frames', async () => {
await client.url(`${addr}/nested-frames.html`);
const executeSpy = sinon.spy(client, 'execute');
await new AxeBuilder({ client }).analyze();
/**
* Ensure we called execute 4 times
* 1. nested-frames.html
* 2. frames/foo.html
* 3. frames/bar.html
* 4. frames/baz.html
*/
assert.strictEqual(executeSpy.callCount, 4);
});
});

describe('logOrRethrowError', () => {
it('log a StaleElementReference Error with `seleniumStack`', () => {
const error = {
Expand Down