-
Notifications
You must be signed in to change notification settings - Fork 13
/
Copy pathweb-test-runner.config.ts
229 lines (215 loc) · 7.44 KB
/
web-test-runner.config.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
import { globSync } from 'node:fs';
import { platform } from 'node:os';
import { parseArgs } from 'node:util';
import { litSsrPlugin } from '@lit-labs/testing/web-test-runner-ssr-plugin.js';
import {
defaultReporter,
type TestRunnerConfig,
type TestRunnerCoreConfig,
type TestRunnerGroupConfig,
} from '@web/test-runner';
import { a11ySnapshotPlugin } from '@web/test-runner-commands/plugins';
import {
type PlaywrightLauncherArgs,
playwrightLauncher,
type PlaywrightLauncher,
} from '@web/test-runner-playwright';
import { visualRegressionPlugin } from '@web/test-runner-visual-regression/plugin';
import { initCompiler } from 'sass';
import {
configureRemotePlaywrightBrowser,
minimalReporter,
patchedSummaryReporter,
containerPlaywrightBrowserPlugin,
visualRegressionConfig,
vitePlugin,
preloadIcons,
} from './tools/web-test-runner/index.js';
const { values: cliArgs } = parseArgs({
strict: false,
options: {
file: { type: 'string' },
module: { type: 'string' },
segment: { type: 'string' },
ci: { type: 'boolean', default: !!process.env.CI },
debug: { type: 'boolean' },
'all-browsers': { type: 'boolean', short: 'a' },
firefox: { type: 'boolean' },
webkit: { type: 'boolean' },
parallel: { type: 'boolean' },
'update-visual-baseline': { type: 'boolean' },
group: { type: 'string' },
ssr: { type: 'boolean' },
container: { type: 'boolean' },
local: { type: 'boolean' },
'visual-regression': { type: 'boolean' },
},
});
const concurrency = cliArgs.parallel ? {} : { concurrency: 1 };
const launchOptions: PlaywrightLauncherArgs = {
launchOptions: {
ignoreDefaultArgs: ['--hide-scrollbars'],
// Enables focusing links with tab on Firefox, probably only relevant on macOS.
firefoxUserPrefs: { 'accessibility.tabfocus': 7 },
},
};
const stylesCompiler = initCompiler();
const renderStyles = (): string =>
stylesCompiler.compile('./src/elements/core/styles/standard-theme.scss', {
loadPaths: ['.', './node_modules/'],
}).css;
const browsers =
cliArgs.ci || cliArgs['all-browsers']
? // Parallelism has problems, we need force concurrency to 1
(['chromium', 'firefox', 'webkit'] as const).map((product) =>
playwrightLauncher({
product,
createPage: ({ context }) =>
context.newPage().then((page) => {
page.on('console', (message) => {
if (message.type() === 'error' && !message.location().url.includes('dummy.png')) {
console.error(`CONSOLE: ${product} ${page.url()}`);
console.error(message.location());
console.error(message.text());
}
});
page.on('pageerror', (err) => {
console.error(`PAGEERROR: ${product} ${page.url()}`);
console.error(err);
});
return page;
}),
...concurrency,
...launchOptions,
}),
)
: cliArgs.firefox
? [playwrightLauncher({ product: 'firefox', ...launchOptions })]
: cliArgs.webkit
? [playwrightLauncher({ product: 'webkit', ...launchOptions })]
: [playwrightLauncher({ product: 'chromium', ...launchOptions })];
const preloadedIcons = await preloadIcons();
const testRunnerHtml = (
testFramework: string,
_config: TestRunnerCoreConfig,
_group?: TestRunnerGroupConfig,
): string => `
<!DOCTYPE html>
<html lang='en'>
<head>${
// Although we provide the fonts as base64, we preload the original
// files which prevents a bug in Safari rendering special characters.
['Roman', 'Bold', 'Light']
.map(
(type) => `
<link
rel="preload"
href="https://cdn.app.sbb.ch/fonts/v1_8_1_subset/SBBWeb-${type}.woff2"
as="font"
type="font/woff2"
crossorigin="anonymous"
/>`,
)
.join('')
}
<link rel="modulepreload" href="/src/elements/core/testing/private/test-setup.ts" />
<style type="text/css">
${renderStyles()}
</style>
<script type="module">
globalThis.testEnv = '${cliArgs.debug ? 'debug' : ''}';
globalThis.testGroup = '${cliArgs['visual-regression'] ? 'visual-regression' : 'default'}';
globalThis.testRunScript = '${testFramework}';
</script>
</head>
<body class="sbb-disable-animation">
<div hidden>${preloadedIcons
.map(
(i) => `
<template id="icon:${i.namespace}:${i.icon}">${i.svg}</template>`,
)
.join('')}</div>
<script type="module" src="/src/elements/core/testing/private/test-setup.ts"></script>
</body>
</html>
`;
// A list of log messages, that should not be printed to the test console.
const suppressedLogs = [
'Lit is in dev mode. Not recommended for production! See https://lit.dev/msg/dev-mode for more information.',
'[vite] connecting...',
'[vite] connected.',
// TODO(major): Verify if still needed
'Using <sbb-datepicker> with a native <input> is deprecated. Use a <sbb-date-input> instead of <input>.',
];
let testFiles = globSync(`src/**/*.spec.ts`);
// The visual regression test group is only added when explicitly set, as the tests are very expensive.
if (cliArgs['visual-regression']) {
testFiles = testFiles.filter((f) => f.endsWith('.visual.spec.ts'));
if (!cliArgs.local && platform() !== 'linux') {
console.log(
`Running visual regression tests in a non-linux environment. Switching to container usage. Use --local to opt-out.`,
);
cliArgs.container = true;
}
} else {
testFiles = testFiles.filter((f) => !f.endsWith('.visual.spec.ts'));
}
if (typeof cliArgs.file === 'string' && cliArgs.file) {
testFiles = testFiles.filter((f) => f === cliArgs.file);
} else if (typeof cliArgs.module === 'string' && cliArgs.module) {
testFiles = testFiles.filter((f) => f.includes(cliArgs.module as string));
} else if (typeof cliArgs.segment === 'string' && cliArgs.segment) {
const match = cliArgs.segment.match(/^(\d+)\/(\d+)$/);
if (!match) {
throw new Error(
`--segment parameter must be in the format index/total (e.g. 1/5), but received ${cliArgs.segment}`,
);
}
const total = +match[2];
const index = +match[1];
const fileAmount = Math.ceil(testFiles.length / total);
testFiles = testFiles.slice(fileAmount * (index - 1), fileAmount * index);
}
if (cliArgs.container) {
browsers
.filter((b): b is PlaywrightLauncher => b.type === 'playwright')
.forEach((browser) => configureRemotePlaywrightBrowser(browser));
}
export default {
files: testFiles,
nodeResolve: true,
reporters:
cliArgs.debug || !cliArgs.ci
? [defaultReporter(), patchedSummaryReporter()]
: [minimalReporter()],
browsers: browsers,
concurrentBrowsers: 3,
plugins: [
a11ySnapshotPlugin(),
litSsrPlugin({
workerInitModules: [
'./tools/node-esm-hook/register-hooks.js',
'./src/elements/core/testing/private/test-setup-ssr.ts',
],
}),
vitePlugin(),
visualRegressionPlugin({
...visualRegressionConfig,
update: !!cliArgs['update-visual-baseline'],
}),
...(cliArgs.container ? [containerPlaywrightBrowserPlugin()] : []),
],
testFramework: {
config: {
timeout: '10000',
slow: '1000',
failZero: true,
},
},
coverageConfig: {
exclude: ['**/node_modules/**/*', '**/assets/*.svg', '**/assets/*.png', '**/*.scss'],
reporters: cliArgs.ci ? ['json'] : undefined,
},
filterBrowserLogs: (log) => !suppressedLogs.includes(log.args[0]),
testRunnerHtml,
} satisfies TestRunnerConfig;