Skip to content

feat: Add allColorModes option to axe tests #978

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

Merged
GZolla merged 3 commits into from
May 7, 2026
Merged

feat: Add allColorModes option to axe tests #978

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c98ec2c
feat: Add allColorModes option to axe tests
GZolla May 7, 2026
ae8e946
Remove log
GZolla May 7, 2026
fef7db2
Appease Linter
GZolla May 7, 2026
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
12 changes: 12 additions & 0 deletions src/alt-tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
export const ALT_TESTS = {
dark: {
set() {
document.documentElement.setAttribute('data-color-mode', 'dark');
},
reset() {
document.documentElement.removeAttribute('data-color-mode');
}
}
};

export const allColorModes = ['dark'];
35 changes: 35 additions & 0 deletions src/browser/axe.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import { allColorModes, ALT_TESTS } from '../alt-tests.js';
import { chai } from '@open-wc/testing';

/* eslint-disable no-invalid-this, prefer-arrow-callback */
chai.Assertion.overwriteMethod('accessible', function(_super) {
return async function(opts = {}) {
let violationsHeader = '';
const violationsMessages = [];
const run = async(prefix = '') => {
try {
await _super.apply(this, arguments);
} catch (e) {
const violations = e.message.split('---');
violationsHeader = violations.shift();
violations.pop();
violationsMessages.push(...violations.map(v => `${prefix}${v}`));
}
};
await run();
if (opts.allColorModes) {
for (const mode of allColorModes) {
ALT_TESTS[mode].set();
await run(`\nColor mode: ${mode.charAt(0).toUpperCase() + mode.slice(1)}`);
ALT_TESTS[mode].reset();
}
}
if (violationsMessages.length > 0) {
violationsMessages.unshift(violationsHeader);
violationsMessages.push('---');
throw new Error(violationsMessages.join('---'));
}

};
});
/* eslint-enable */
1 change: 1 addition & 0 deletions src/browser/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import './vdiff.js';
import './axe.js';

export { assert, aTimeout, defineCE, expect, html, nextFrame, oneDefaultPreventedEvent, oneEvent, waitUntil } from '@open-wc/testing';
export { clickAt, clickElem, clickElemAt, dragDropElems, focusElem, hoverAt, hoverElem, hoverElemAt, sendKeys, sendKeysElem, setViewport } from './commands.js';
Expand Down
3 changes: 2 additions & 1 deletion src/browser/vdiff.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { chai, expect } from '@open-wc/testing';
import { allColorModes } from '../alt-tests.js';
import { executeServerCommand } from '@web/test-runner-commands';

// start loading fonts early
Expand Down Expand Up @@ -90,7 +91,7 @@ async function ScreenshotAndCompare(opts = {}) {
}
const slowDuration = this.test.slow();
const altTests = [];
if (opts.allColorModes) altTests.push('dark');
if (opts.allColorModes) altTests.push(...allColorModes);

this.test.timeout(0);
const result = await executeServerCommand('brightspace-visual-diff-compare', { altTests, name, fullPage, rect, slowDuration });
Expand Down
12 changes: 1 addition & 11 deletions src/server/visual-diff-plugin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { access, constants, mkdir, readdir, readFile, rename, rm, stat, writeFile } from 'node:fs/promises';
import { basename, dirname, join } from 'node:path';
import { ALT_TESTS } from '../alt-tests.js';
import { env } from 'node:process';
import { PATHS } from './paths.js';
import pixelmatch from 'pixelmatch';
Expand All @@ -9,17 +10,6 @@ import { TestInfoManager } from './visual-diff-info.js';
const isCI = !!env['CI'];
const DEFAULT_TOLERANCE = 0; // TODO: Support tolerance override?

const ALT_TESTS = {
dark: {
set() {
document.documentElement.setAttribute('data-color-mode', 'dark');
},
reset() {
document.documentElement.removeAttribute('data-color-mode');
}
}
};

async function checkFileExists(fileName) {
try {
await access(fileName, constants.F_OK);
Expand Down
172 changes: 85 additions & 87 deletions src/server/wtr-config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,86 @@ const SUPPRESS_RESIZE_OBSERVER_ERRORS = `
</script>
`;
export const DEFAULT_VDIFF_SLOW = 500;
const HTML_BODY = testFramework => `
<body>
${TEST_PAGE}
${SUPPRESS_RESIZE_OBSERVER_ERRORS}
<script type="module" src="${testFramework}"></script>
</body>
`;
const HTML_HEAD = `
<head>
<link rel="preload" href="${FONT_ASSETS}Lato-400.woff2" as="font" type="font/woff2" crossorigin>
<link rel="preload" href="${FONT_ASSETS}Lato-700.woff2" as="font" type="font/woff2" crossorigin>
<style>

html {
--d2l-cursor-resize-inline-end: e-resize;
--d2l-cursor-resize-inline-start: w-resize;
--d2l-document-direction: ltr;
--d2l-inline-end: right;
--d2l-inline-start: left;
--d2l-length-factor: 1;
--d2l-mirror-transform: none;
--d2l-theme-background-color-base: #ffffff;
--d2l-theme-text-color-static-standard: #202122;
font-size: 20px;
}

html[dir="rtl"] * {
--d2l-cursor-resize-inline-end: w-resize;
--d2l-cursor-resize-inline-start: e-resize;
--d2l-document-direction: rtl;
--d2l-inline-end: left;
--d2l-inline-start: right;
--d2l-length-factor: -1;
--d2l-mirror-transform: scale(-1, 1);
}

html[data-color-mode="dark"] {
--d2l-theme-background-color-base: #161718;
--d2l-theme-text-color-static-standard: #cdd5dc;
}

@font-face {
font-family: 'Lato';
font-style: normal;
font-weight: 400;
src: url(${FONT_ASSETS}Lato-400.woff2) format('woff2');
}
@font-face {
font-family: 'Lato';
font-style: normal;
font-weight: 700;
src: url(${FONT_ASSETS}Lato-700.woff2) format('woff2');
}

body {
background-color: var(--d2l-theme-background-color-base);
color: var(--d2l-theme-text-color-static-standard);
font-family: 'Lato', sans-serif;
letter-spacing: 0.01rem;
font-size: 0.95rem;
font-weight: 400;
line-height: 1.4rem;
margin: 0;
padding: 38px;
}
body.no-padding {
padding: 0;
}
</style>
</head>
`;
const DEFAULT_TEST_RUNNER_HTML = testFramework => `<!DOCTYPE html>
<html lang="en" data-timezone='${TIMEZONE}'>
${HTML_BODY(testFramework)}
</html>`;
const FULL_TEST_RUNNER_HTML = testFramework => `<!DOCTYPE html>
<html lang="en" data-timezone='${TIMEZONE}'>
${HTML_HEAD}
${HTML_BODY(testFramework)}
</html>`;
Comment on lines +62 to +141
Copy link
Copy Markdown
Contributor Author

@GZolla GZolla May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make HTML reusable to set it for axe tests


export class WTRConfig {

Expand All @@ -73,77 +153,7 @@ export class WTRConfig {
name: 'vdiff',
files: this.#pattern,
browsers: [BROWSER_MAP.chrome],
testRunnerHtml: testFramework =>
`<!DOCTYPE html>
<html lang="en" data-timezone='${TIMEZONE}'>
<head>
<link rel="preload" href="${FONT_ASSETS}Lato-400.woff2" as="font" type="font/woff2" crossorigin>
<link rel="preload" href="${FONT_ASSETS}Lato-700.woff2" as="font" type="font/woff2" crossorigin>
<style>

html {
--d2l-cursor-resize-inline-end: e-resize;
--d2l-cursor-resize-inline-start: w-resize;
--d2l-document-direction: ltr;
--d2l-inline-end: right;
--d2l-inline-start: left;
--d2l-length-factor: 1;
--d2l-mirror-transform: none;
--d2l-theme-background-color-base: #ffffff;
--d2l-theme-text-color-static-standard: #202122;
font-size: 20px;
}

html[dir="rtl"] * {
--d2l-cursor-resize-inline-end: w-resize;
--d2l-cursor-resize-inline-start: e-resize;
--d2l-document-direction: rtl;
--d2l-inline-end: left;
--d2l-inline-start: right;
--d2l-length-factor: -1;
--d2l-mirror-transform: scale(-1, 1);
}

html[data-color-mode="dark"] {
--d2l-theme-background-color-base: #161718;
--d2l-theme-text-color-static-standard: #cdd5dc;
}

@font-face {
font-family: 'Lato';
font-style: normal;
font-weight: 400;
src: url(${FONT_ASSETS}Lato-400.woff2) format('woff2');
}
@font-face {
font-family: 'Lato';
font-style: normal;
font-weight: 700;
src: url(${FONT_ASSETS}Lato-700.woff2) format('woff2');
}

body {
background-color: var(--d2l-theme-background-color-base);
color: var(--d2l-theme-text-color-static-standard);
font-family: 'Lato', sans-serif;
letter-spacing: 0.01rem;
font-size: 0.95rem;
font-weight: 400;
line-height: 1.4rem;
margin: 0;
padding: 38px;
}
body.no-padding {
padding: 0;
}
</style>
</head>
<body>
${TEST_PAGE}
${SUPPRESS_RESIZE_OBSERVER_ERRORS}
<script type="module" src="${testFramework}"></script>
</body>
</html>`
testRunnerHtml: FULL_TEST_RUNNER_HTML
};
}
create({
Expand All @@ -169,20 +179,16 @@ export class WTRConfig {
};

if (!['test', 'vdiff', ...passthroughGroupNames].includes(group)) {
config.groups.push({ name: group, files: this.#pattern });
const groupConfig = { name: group, files: this.#pattern };
if (group === 'axe') groupConfig.testRunnerHtml = FULL_TEST_RUNNER_HTML;
config.groups.push(groupConfig);
} else {
const groupConfig = config.groups.find(g => g.name === group);
if (groupConfig) {
groupConfig.files = this.#pattern;
}
}

if (filter) {
config.groups.forEach(group => {
group.files = this.#filterFiles([ group.files ].flat());
});
}
Comment on lines -180 to -184
Copy link
Copy Markdown
Contributor Author

@GZolla GZolla May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I may be missing something but this.#pattern already sets .files to a filtered set of wildcards, doing it again here breaks those wildcards(e.g. axe --filter card was resulting in **/test/+(+(card.axe.js)) which was not matching any files.

Copy link
Copy Markdown
Member

@dlockhart dlockhart May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I ran into this bug the other day -- makes sense!


config.reporters ??= [ defaultReporterGrep() ];

if (group === 'test') {
Expand Down Expand Up @@ -250,15 +256,7 @@ export class WTRConfig {
nodeResolve: {
exportConditions: ['default']
},
testRunnerHtml: testFramework =>
`<!DOCTYPE html>
<html lang="en" data-timezone='${TIMEZONE}'>
<body>
${TEST_PAGE}
${SUPPRESS_RESIZE_OBSERVER_ERRORS}
<script type="module" src="${testFramework}"></script>
</body>
</html>`,
testRunnerHtml: DEFAULT_TEST_RUNNER_HTML,
};
}

Expand Down