Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
test(html-reporter): add story picker to the component gallery (#41936)
Dmitry Gozman56e1b0682577
diff --git a/docs/src/test-components-js.md b/docs/src/test-components-js.mdindex 8d411a66ff..d95e8ad577 100644--- a/docs/src/test-components-js.md+++ b/docs/src/test-components-js.md@@ -219,7 +219,7 @@ This pattern is the heart of the methodology:### Per-test props-When a scenario is genuinely parametric — a boundary-value sweep, a text matrix — pass plain serializable props as the second argument to `mount`. The gallery hands them to the story as its props:+When a scenario benefits from parameterizing, pass plain serializable props as the second argument to `mount`. The gallery hands them to the story as its props:```js title="src/components/Button.story.tsx"import { Button } from './Button';@@ -256,7 +256,7 @@ await expect(await mount('Button/Primary')).toHaveScreenshot('primary.png');await expect(await mount('Button/Disabled')).toHaveScreenshot('disabled.png');```-Screenshot the returned root locator, not the page, to avoid asserting on browser chrome.+Screenshot the returned root locator, not the page, to avoid asserting on anything extra you might put in the gallery.### Handling network requestsdiff --git a/packages/html-reporter/playwright.config.ts b/packages/html-reporter/playwright.config.tsindex d15ded9a00..22b4ac5f4c 100644--- a/packages/html-reporter/playwright.config.ts+++ b/packages/html-reporter/playwright.config.ts@@ -18,6 +18,8 @@ import path from 'path';import url from 'url';import { devices, defineConfig } from '@playwright/test';+process.env.PWTEST_UNDER_TEST = '1';+const dirname = path.dirname(url.fileURLToPath(import.meta.url));const outputDir = path.join(dirname, '..', '..', 'test-results');diff --git a/packages/html-reporter/playwright/gallery/index.html b/packages/html-reporter/playwright/gallery/index.htmlindex 0842528ca8..0279894a6d 100644--- a/packages/html-reporter/playwright/gallery/index.html+++ b/packages/html-reporter/playwright/gallery/index.html@@ -22,11 +22,17 @@<title>Component Gallery</title><style>html, body { margin: 0; padding: 0; }- #root { position: fixed; inset: 0; }+ body { display: flex; flex-direction: column; height: 100vh; }+ #picker { flex: none; margin: 4px; align-self: flex-start; }+ #wrapper { flex: auto; position: relative; }+ #root { position: absolute; top: 0; right: 0; bottom: 0; left: 0; }</style></head><body>- <div id="root"></div>+ <select id="picker">+ <option>Select a story…</option>+ </select>+ <div id="wrapper"></div><script type="module" src="./main.tsx"></script></body></html>diff --git a/packages/html-reporter/playwright/gallery/main.tsx b/packages/html-reporter/playwright/gallery/main.tsxindex 38120efe0c..467a9ecb2e 100644--- a/packages/html-reporter/playwright/gallery/main.tsx+++ b/packages/html-reporter/playwright/gallery/main.tsx@@ -17,6 +17,7 @@import { flushSync } from 'react-dom';import { createRoot, type Root } from 'react-dom/client';import '../../src/theme.css';+import { SearchParamsProvider } from '../../src/links';const stories = import.meta.glob('../../src/**/*.story.{tsx,jsx}');const storyId = (file: string) => file.replace(/^(\.\.\/)+src\//, '').replace(/\.story\.\w+$/, '');@@ -29,7 +30,7 @@ async function resolveStory(id: string): Promise<React.ComponentType<any> | undereturn mod?.[name] ?? mod?.default;}-const rootElement = document.getElementById('root')!;+const wrapperElement = document.getElementById('wrapper')!;let root: Root | undefined;(window as any).mount = async ({ story, props }: { story: string, props?: Record<string, any> }) => {@@ -37,12 +38,44 @@ let root: Root | undefined;if (!Story)throw new Error(`Unknown story: ${story}`);// Reuse the root so that update() reconciles and preserves state.- root ??= createRoot(rootElement);+ root ??= createRoot(wrapperElement);// flushSync so that a render error rejects the promise instead of being swallowed.- flushSync(() => root!.render(<Story {...props} />));+ flushSync(() => root!.render(+ <SearchParamsProvider>+ <div id="root">+ <Story {...props} />+ </div>+ </SearchParamsProvider>+ ));};(window as any).unmount = async () => {root?.unmount();root = undefined;};++async function listStories(): Promise<string[]> {+ const lists = await Promise.all(Object.entries(stories).map(async ([file, loadModule]) => {+ const mod = await loadModule() as Record<string, any>;+ return Object.keys(mod).filter(name => typeof mod[name] === 'function').map(name => `${storyId(file)}/${name}`);+ }));+ return lists.flat().sort();+}++const pickerElement = document.getElementById('picker') as HTMLSelectElement;+let pickerPopulated = false;+async function populatePicker() {+ if (pickerPopulated)+ return;+ pickerPopulated = true;+ for (const id of await listStories())+ pickerElement.add(new Option(id, id));+}+// Populate on mouseenter/focus rather than on click, because an already-open+// select popup does not refresh when options are added.+pickerElement.addEventListener('mouseenter', () => void populatePicker());+pickerElement.addEventListener('focus', () => void populatePicker());+pickerElement.addEventListener('change', () => {+ if (pickerElement.value)+ void (window as any).mount({ story: pickerElement.value });+});diff --git a/packages/html-reporter/src/DEPS.list b/packages/html-reporter/src/DEPS.listindex 87831ba08b..00c6045447 100644--- a/packages/html-reporter/src/DEPS.list+++ b/packages/html-reporter/src/DEPS.list@@ -10,3 +10,6 @@[testCaseView.spec.ts]***++[testFileView.spec.ts]+***diff --git a/packages/html-reporter/src/headerView.story.tsx b/packages/html-reporter/src/headerView.story.tsxindex d4c61c327b..27f5857484 100644--- a/packages/html-reporter/src/headerView.story.tsx+++ b/packages/html-reporter/src/headerView.story.tsx@@ -16,7 +16,6 @@import * as React from 'react';import { GlobalFilterView } from './headerView';-import { SearchParamsProvider } from './links';const stats = {total: 100,@@ -29,8 +28,8 @@ const stats = {export const Default = () => {const [filterText, setFilterText] = React.useState('');- return <SearchParamsProvider>+ return <><GlobalFilterView stats={stats} filterText={filterText} setFilterText={setFilterText} /><form hidden><input data-testid='filter-text' readOnly value={filterText} /></form>- </SearchParamsProvider>;+ </>;};diff --git a/packages/html-reporter/src/sampleReport.ts b/packages/html-reporter/src/sampleReport.tsnew file mode 100644index 0000000000..322d8168c7--- /dev/null+++ b/packages/html-reporter/src/sampleReport.ts@@ -0,0 +1,170 @@+/**+ * Copyright (c) Microsoft Corporation.+ *+ * Licensed under the Apache License, Version 2.0 (the "License");+ * you may not use this file except in compliance with the License.+ * You may obtain a copy of the License at+ *+ * http://www.apache.org/licenses/LICENSE-2.0+ *+ * Unless required by applicable law or agreed to in writing, software+ * distributed under the License is distributed on an "AS IS" BASIS,+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+ * See the License for the specific language governing permissions and+ * limitations under the License.+ */++import type { LoadedReport } from './loadedReport';+import type { HTMLReport, TestCase, TestCaseSummary, TestFileSummary, TestResult } from './types';++const passedResult: TestResult = {+ retry: 0,+ workerIndex: 0,+ startTime: new Date(0).toUTCString(),+ duration: 100,+ errors: [],+ steps: [{+ title: 'Outer step',+ startTime: new Date(100).toUTCString(),+ duration: 10,+ location: { file: 'test.spec.ts', line: 62, column: 0 },+ count: 1,+ steps: [{+ title: 'Inner step',+ startTime: new Date(200).toUTCString(),+ duration: 10,+ location: { file: 'test.spec.ts', line: 82, column: 0 },+ steps: [],+ attachments: [],+ count: 1,+ }],+ attachments: [],+ }],+ annotations: [+ { type: 'annotation', description: 'Annotation text' },+ { type: 'annotation', description: 'Another annotation text' },+ { type: '_annotation', description: 'Hidden annotation' },+ ],+ attachments: [],+ status: 'passed',+};++const failedResult: TestResult = {+ ...passedResult,+ errors: [{ message: 'Error message' }],+ status: 'failed',+};++export const basicTest: TestCase = {+ testId: 'basic-test',+ title: 'My test',+ path: [],+ projectName: 'chromium',+ location: { file: 'test.spec.ts', line: 42, column: 0 },+ annotations: passedResult.annotations,+ tags: [],+ outcome: 'expected',+ duration: 200,+ ok: true,+ results: [passedResult],+};++export const annotationLinksTest: TestCase = {+ ...basicTest,+ testId: 'annotation-links-test',+ title: 'Test with annotation links',+ duration: 10,+ annotations: [],+ results: [{+ ...passedResult,+ annotations: [+ { type: 'more info', description: 'read https://playwright.dev/docs/intro and https://playwright.dev/docs/api/class-playwright' },+ { type: 'related issues', description: 'https://github.com/microsoft/playwright/issues/23180, https://github.com/microsoft/playwright/issues/23181' },+ ]+ }]+};++const resultWithAttachments: TestResult = {+ ...passedResult,+ steps: [{+ title: 'Outer step',+ startTime: new Date(100).toUTCString(),+ duration: 10,+ location: { file: 'test.spec.ts', line: 62, column: 0 },+ count: 1,+ steps: [],+ attachments: [1],+ }],+ attachments: [{+ name: 'first attachment',+ body: 'The body with https://playwright.dev/docs/intro link and https://github.com/microsoft/playwright/issues/31284.',+ contentType: 'text/plain'+ }, {+ name: 'attachment with inline link https://github.com/microsoft/playwright/issues/31284',+ contentType: 'text/plain'+ }],+ annotations: [],+};++export const attachmentLinksTest: TestCase = {+ ...basicTest,+ testId: 'attachment-links-test',+ title: 'Test with attachment links',+ path: ['group'],+ duration: 10,+ annotations: [],+ results: [resultWithAttachments]+};++export const nextTest: TestCaseSummary = {+ ...attachmentLinksTest,+ testId: 'next-test',+ title: 'next test',+ path: [],+};++export const twoAttemptsTest: TestCase = {+ ...basicTest,+ testId: 'two-attempts-test',+ title: 'Test with two attempts',+ outcome: 'flaky',+ results: [+ { ...failedResult, duration: 50 },+ { ...passedResult, duration: 150 },+ ],+};++export const webkitTest: TestCase = {+ ...basicTest,+ testId: 'webkit-test',+ title: 'Failing webkit test',+ projectName: 'webkit',+ outcome: 'unexpected',+ ok: false,+ annotations: [],+ results: [failedResult],+};++export const testFile: TestFileSummary = {+ fileId: 'file-id',+ fileName: 'test.spec.ts',+ tests: [basicTest, annotationLinksTest, attachmentLinksTest, nextTest, twoAttemptsTest, webkitTest],+ stats: { total: 6, expected: 4, unexpected: 1, flaky: 1, skipped: 0, ok: false },+};++export const report: HTMLReport = {+ metadata: {},+ files: [testFile],+ stats: testFile.stats,+ projectNames: ['chromium', 'webkit'],+ startTime: 0,+ duration: 200,+ machines: [],+ errors: [],+ options: {},+};++export const loadedReport: LoadedReport = {+ json: () => report,+ entry: async () => undefined,+};diff --git a/packages/html-reporter/src/testCaseView.spec.ts b/packages/html-reporter/src/testCaseView.spec.tsindex 511c207b2b..e4f44e7ac4 100644--- a/packages/html-reporter/src/testCaseView.spec.ts+++ b/packages/html-reporter/src/testCaseView.spec.ts@@ -96,24 +96,24 @@ test('should correctly render prev and next', async ({ mount }) => {- text: group- link "« previous"- link "next »"- - text: "My test test.spec.ts:42 10ms chromium"+ - text: "Test with attachment links test.spec.ts:42 10ms chromium"`);});test('total duration is selected run duration', async ({ mount, page }) => {const component = await mount<typeof TwoAttempts>('testCaseView/TwoAttempts');await expect(component).toMatchAriaSnapshot(`- - text: "My test test.spec.ts:42 200ms chromium"+ - text: "Test with two attempts test.spec.ts:42 200ms chromium"- tablist:- tab "Run 50ms"- 'tab "Retry #1 150ms"'`);await page.getByRole('tab', { name: 'Run' }).click();await expect(component).toMatchAriaSnapshot(`- - text: "My test test.spec.ts:42 200ms chromium"+ - text: "Test with two attempts test.spec.ts:42 200ms chromium"`);await page.getByRole('tab', { name: 'Retry' }).click();await expect(component).toMatchAriaSnapshot(`- - text: "My test test.spec.ts:42 200ms chromium"+ - text: "Test with two attempts test.spec.ts:42 200ms chromium"`);});diff --git a/packages/html-reporter/src/testCaseView.story.tsx b/packages/html-reporter/src/testCaseView.story.tsxindex ba2f9066c5..cda50d19cd 100644--- a/packages/html-reporter/src/testCaseView.story.tsx+++ b/packages/html-reporter/src/testCaseView.story.tsx@@ -14,139 +14,20 @@* limitations under the License.*/-import type { LoadedReport } from './loadedReport';+import { annotationLinksTest, attachmentLinksTest, basicTest, loadedReport, nextTest, twoAttemptsTest } from './sampleReport';import { TestCaseView } from './testCaseView';-import type { HTMLReport, TestCase, TestCaseSummary, TestResult } from './types';--const report: LoadedReport = {- json: () => ({ projectNames: ['chromium', 'webkit'] } as HTMLReport),- entry: async () => undefined,-};--const result: TestResult = {- retry: 0,- workerIndex: 0,- startTime: new Date(0).toUTCString(),- duration: 100,- errors: [],- steps: [{- title: 'Outer step',- startTime: new Date(100).toUTCString(),- duration: 10,- location: { file: 'test.spec.ts', line: 62, column: 0 },- count: 1,- steps: [{- title: 'Inner step',- startTime: new Date(200).toUTCString(),- duration: 10,- location: { file: 'test.spec.ts', line: 82, column: 0 },- steps: [],- attachments: [],- count: 1,- }],- attachments: [],- }],- annotations: [- { type: 'annotation', description: 'Annotation text' },- { type: 'annotation', description: 'Another annotation text' },- { type: '_annotation', description: 'Hidden annotation' },- ],- attachments: [],- status: 'passed',-};--const testCase: TestCase = {- testId: 'testid',- title: 'My test',- path: [],- projectName: 'chromium',- location: { file: 'test.spec.ts', line: 42, column: 0 },- annotations: result.annotations,- tags: [],- outcome: 'expected',- duration: 200,- ok: true,- results: [result]-};--const annotationLinkRenderingTestCase: TestCase = {- ...testCase,- duration: 10,- annotations: [],- results: [{- ...result,- annotations: [- { type: 'more info', description: 'read https://playwright.dev/docs/intro and https://playwright.dev/docs/api/class-playwright' },- { type: 'related issues', description: 'https://github.com/microsoft/playwright/issues/23180, https://github.com/microsoft/playwright/issues/23181' },- ]- }]-};--const resultWithAttachment: TestResult = {- ...result,- steps: [{- title: 'Outer step',- startTime: new Date(100).toUTCString(),- duration: 10,- location: { file: 'test.spec.ts', line: 62, column: 0 },- count: 1,- steps: [],- attachments: [1],- }],- attachments: [{- name: 'first attachment',- body: 'The body with https://playwright.dev/docs/intro link and https://github.com/microsoft/playwright/issues/31284.',- contentType: 'text/plain'- }, {- name: 'attachment with inline link https://github.com/microsoft/playwright/issues/31284',- contentType: 'text/plain'- }],- annotations: [],-};--const attachmentLinkRenderingTestCase: TestCase = {- ...testCase,- path: ['group'],- duration: 10,- annotations: [],- results: [resultWithAttachment]-};--const testCaseSummary: TestCaseSummary = {- ...attachmentLinkRenderingTestCase,- testId: 'nextTestId',- title: 'next test',- path: [],-};--const testCaseWithTwoAttempts: TestCase = {- ...testCase,- results: [- {- ...result,- errors: [{ message: 'Error message' }],- status: 'failed',- duration: 50,- },- {- ...result,- duration: 150,- status: 'passed',- },- ],-};export const Default = () =>- <TestCaseView report={report} test={testCase} prev={undefined} next={undefined} run={0} />;+ <TestCaseView report={loadedReport} test={basicTest} prev={undefined} next={undefined} run={0} />;export const AnnotationLinks = () =>- <TestCaseView report={report} test={annotationLinkRenderingTestCase} prev={undefined} next={undefined} run={0} />;+ <TestCaseView report={loadedReport} test={annotationLinksTest} prev={undefined} next={undefined} run={0} />;export const AttachmentLinks = () =>- <TestCaseView report={report} test={attachmentLinkRenderingTestCase} prev={undefined} next={undefined} run={0} />;+ <TestCaseView report={loadedReport} test={attachmentLinksTest} prev={undefined} next={undefined} run={0} />;export const PrevNext = () =>- <TestCaseView report={report} test={attachmentLinkRenderingTestCase} prev={testCaseSummary} next={testCaseSummary} run={0} />;+ <TestCaseView report={loadedReport} test={attachmentLinksTest} prev={nextTest} next={nextTest} run={0} />;export const TwoAttempts = () =>- <TestCaseView report={report} test={testCaseWithTwoAttempts} prev={undefined} next={undefined} run={0} />;+ <TestCaseView report={loadedReport} test={twoAttemptsTest} prev={undefined} next={undefined} run={0} />;diff --git a/packages/html-reporter/src/testFileView.spec.ts b/packages/html-reporter/src/testFileView.spec.tsnew file mode 100644index 0000000000..55e9d88439--- /dev/null+++ b/packages/html-reporter/src/testFileView.spec.ts@@ -0,0 +1,32 @@+/**+ * Copyright (c) Microsoft Corporation.+ *+ * Licensed under the Apache License, Version 2.0 (the "License");+ * you may not use this file except in compliance with the License.+ * You may obtain a copy of the License at+ *+ * http://www.apache.org/licenses/LICENSE-2.0+ *+ * Unless required by applicable law or agreed to in writing, software+ * distributed under the License is distributed on an "AS IS" BASIS,+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+ * See the License for the specific language governing permissions and+ * limitations under the License.+ */++import { expect, test } from '@playwright/test';++import type { Default } from './testFileView.story';++test.use({ viewport: { width: 800, height: 600 } });++test('should render project links', async ({ mount, page }) => {+ const component = await mount<typeof Default>('testFileView/Default');+ await expect(component.locator('.label', { hasText: 'chromium' })).toHaveCount(5);+ await expect(component.locator('.label', { hasText: 'webkit' })).toHaveCount(1);+ const webkitLabel = component.locator('.label', { hasText: 'webkit' });+ await webkitLabel.click();+ await expect(page).toHaveURL(/p(:|%3A)webkit/);+ await webkitLabel.click({ modifiers: ['ControlOrMeta'] });+ await expect(page).not.toHaveURL(/webkit/);+});diff --git a/packages/html-reporter/src/testFileView.story.tsx b/packages/html-reporter/src/testFileView.story.tsxnew file mode 100644index 0000000000..4c973c0ac9--- /dev/null+++ b/packages/html-reporter/src/testFileView.story.tsx@@ -0,0 +1,21 @@+/**+ * Copyright (c) Microsoft Corporation.+ *+ * Licensed under the Apache License, Version 2.0 (the "License");+ * you may not use this file except in compliance with the License.+ * You may obtain a copy of the License at+ *+ * http://www.apache.org/licenses/LICENSE-2.0+ *+ * Unless required by applicable law or agreed to in writing, software+ * distributed under the License is distributed on an "AS IS" BASIS,+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+ * See the License for the specific language governing permissions and+ * limitations under the License.+ */++import { report, testFile } from './sampleReport';+import { TestFileView } from './testFileView';++export const Default = () =>+ <TestFileView file={testFile} projectNames={report.projectNames} />;diff --git a/packages/web/playwright.config.ts b/packages/web/playwright.config.tsindex b8eb76a2f8..85dd14a184 100644--- a/packages/web/playwright.config.ts+++ b/packages/web/playwright.config.ts@@ -17,6 +17,8 @@import path from 'path';import { devices, defineConfig } from '@playwright/test';+process.env.PWTEST_UNDER_TEST = '1';+const outputDir = path.join(__dirname, '..', '..', 'test-results');export default defineConfig({