mirror of
				https://github.com/microsoft/playwright.git
				synced 2025-06-26 21:40:17 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			521 lines
		
	
	
		
			17 KiB
		
	
	
	
		
			TypeScript
		
	
	
	
	
	
			
		
		
	
	
			521 lines
		
	
	
		
			17 KiB
		
	
	
	
		
			TypeScript
		
	
	
	
	
	
| /**
 | |
|  * 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 { createImage } from './playwright-test-fixtures';
 | |
| import { test, expect, retries } from './ui-mode-fixtures';
 | |
| 
 | |
| test.describe.configure({ mode: 'parallel', retries });
 | |
| 
 | |
| test('should merge trace events', async ({ runUITest }) => {
 | |
|   const { page } = await runUITest({
 | |
|     'a.test.ts': `
 | |
|       import { test, expect } from '@playwright/test';
 | |
|       test('trace test', async ({ page }) => {
 | |
|         await page.setContent('<button>Submit</button>');
 | |
|         expect(1).toBe(1);
 | |
|         await page.getByRole('button').click();
 | |
|         expect(2).toBe(2);
 | |
|       });
 | |
|     `,
 | |
|   });
 | |
| 
 | |
|   await page.getByText('trace test').dblclick();
 | |
| 
 | |
|   const listItem = page.getByTestId('actions-tree').getByRole('treeitem');
 | |
|   await expect(
 | |
|       listItem,
 | |
|       'action list'
 | |
|   ).toHaveText([
 | |
|     /Before Hooks[\d.]+m?s/,
 | |
|     /page.setContent[\d.]+m?s/,
 | |
|     /expect.toBe[\d.]+m?s/,
 | |
|     /locator.clickgetByRole\('button'\)[\d.]+m?s/,
 | |
|     /expect.toBe[\d.]+m?s/,
 | |
|     /After Hooks[\d.]+m?s/,
 | |
|   ]);
 | |
| });
 | |
| 
 | |
| test('should merge web assertion events', async ({  runUITest }, testInfo) => {
 | |
|   const { page } = await runUITest({
 | |
|     'a.test.ts': `
 | |
|       import { test, expect } from '@playwright/test';
 | |
|       test('trace test', async ({ page }) => {
 | |
|         await page.setContent('<button>Submit</button>');
 | |
|         await expect(page.locator('button')).toBeVisible();
 | |
|       });
 | |
|     `,
 | |
|   });
 | |
| 
 | |
|   await page.getByText('trace test').dblclick();
 | |
| 
 | |
|   const listItem = page.getByTestId('actions-tree').getByRole('treeitem');
 | |
|   await expect(
 | |
|       listItem,
 | |
|       'action list'
 | |
|   ).toHaveText([
 | |
|     /Before Hooks[\d.]+m?s/,
 | |
|     /page.setContent[\d.]+m?s/,
 | |
|     /expect.toBeVisiblelocator\('button'\)[\d.]+m?s/,
 | |
|     /After Hooks[\d.]+m?s/,
 | |
|   ]);
 | |
| });
 | |
| 
 | |
| test('should merge screenshot assertions', async ({  runUITest }, testInfo) => {
 | |
|   const { page } = await runUITest({
 | |
|     'a.test.ts': `
 | |
|       import { test, expect } from '@playwright/test';
 | |
|       test('trace test', async ({ page }) => {
 | |
|         await page.setContent('<button>Submit</button>');
 | |
|         await expect(page.locator('button')).toHaveScreenshot();
 | |
|       });
 | |
|     `,
 | |
|   });
 | |
| 
 | |
|   await page.getByText('trace test').dblclick();
 | |
| 
 | |
|   const listItem = page.getByTestId('actions-tree').getByRole('treeitem');
 | |
|   await expect(
 | |
|       listItem,
 | |
|       'action list'
 | |
|   ).toHaveText([
 | |
|     /Before Hooks[\d.]+m?s/,
 | |
|     /page.setContent[\d.]+m?s/,
 | |
|     /expect.toHaveScreenshot[\d.]+m?s/,
 | |
|     /After Hooks[\d.]+m?s/,
 | |
|     /Worker Cleanup[\d.]+m?s/,
 | |
|   ]);
 | |
| });
 | |
| 
 | |
| test('should locate sync assertions in source', async ({ runUITest }) => {
 | |
|   const { page } = await runUITest({
 | |
|     'a.test.ts': `
 | |
|       import { test, expect } from '@playwright/test';
 | |
|       test('trace test', async ({}) => {
 | |
|         expect(1).toBe(1);
 | |
|       });
 | |
|     `,
 | |
|   });
 | |
| 
 | |
|   await page.getByText('trace test').dblclick();
 | |
|   await page.getByText('expect.toBe').click();
 | |
| 
 | |
|   await expect(
 | |
|       page.locator('.CodeMirror .source-line-running'),
 | |
|       'check source tab',
 | |
|   ).toHaveText('4        expect(1).toBe(1);');
 | |
| });
 | |
| 
 | |
| test('should show snapshots for sync assertions', async ({ runUITest }) => {
 | |
|   const { page } = await runUITest({
 | |
|     'a.test.ts': `
 | |
|       import { test, expect } from '@playwright/test';
 | |
|       test('trace test', async ({ page }) => {
 | |
|         await page.setContent('<button>Submit</button>');
 | |
|         await page.getByRole('button').click();
 | |
|         expect(1).toBe(1);
 | |
|       });
 | |
|     `,
 | |
|   });
 | |
| 
 | |
|   await page.getByText('trace test').dblclick();
 | |
| 
 | |
|   const listItem = page.getByTestId('actions-tree').getByRole('treeitem');
 | |
|   await expect(
 | |
|       listItem,
 | |
|       'action list'
 | |
|   ).toHaveText([
 | |
|     /Before Hooks[\d.]+m?s/,
 | |
|     /page\.setContent[\d.]+m?s/,
 | |
|     /locator\.clickgetByRole\('button'\)[\d.]+m?s/,
 | |
|     /expect\.toBe[\d.]+m?s/,
 | |
|     /After Hooks[\d.]+m?s/,
 | |
|   ]);
 | |
| 
 | |
|   await expect(
 | |
|       page.frameLocator('iframe.snapshot-visible[name=snapshot]').locator('button'),
 | |
|       'verify snapshot'
 | |
|   ).toHaveText('Submit');
 | |
| });
 | |
| 
 | |
| test('should show image diff', async ({ runUITest }) => {
 | |
|   const { page } = await runUITest({
 | |
|     'playwright.config.js': `
 | |
|       module.exports = {
 | |
|         snapshotPathTemplate: '{arg}{ext}'
 | |
|       };
 | |
|     `,
 | |
|     'snapshot.png': createImage(100, 100, 255, 0, 0),
 | |
|     'a.test.ts': `
 | |
|       import { test, expect } from '@playwright/test';
 | |
|       test('vrt test', async ({ page }) => {
 | |
|         await page.setViewportSize({ width: 100, height: 100 });
 | |
|         await expect(page).toHaveScreenshot('snapshot.png', { timeout: 2000 });
 | |
|       });
 | |
|     `,
 | |
|   });
 | |
| 
 | |
|   await page.getByText('vrt test').dblclick();
 | |
|   await page.getByText(/Attachments/).click();
 | |
|   await expect(page.getByText('Diff', { exact: true })).toBeVisible();
 | |
|   await expect(page.getByText('Actual', { exact: true })).toBeVisible();
 | |
|   await expect(page.getByText('Expected', { exact: true })).toBeVisible();
 | |
|   await expect(page.getByTestId('test-result-image-mismatch').locator('img')).toBeVisible();
 | |
| });
 | |
| 
 | |
| test('should show screenshot', async ({ runUITest }) => {
 | |
|   const { page } = await runUITest({
 | |
|     'playwright.config.js': `
 | |
|       module.exports = {
 | |
|         use: {
 | |
|           screenshot: 'on',
 | |
|           viewport: { width: 100, height: 100 }
 | |
|         }
 | |
|       };
 | |
|     `,
 | |
|     'a.test.ts': `
 | |
|       import { test, expect } from '@playwright/test';
 | |
|       test('vrt test', async ({ page }) => {
 | |
|       });
 | |
|     `,
 | |
|   });
 | |
| 
 | |
|   await page.getByText('vrt test').dblclick();
 | |
|   await page.getByText(/Attachments/).click();
 | |
|   await expect(page.getByText('Screenshots', { exact: true })).toBeVisible();
 | |
|   await expect(page.locator('.attachment-item img')).toHaveCount(1);
 | |
| });
 | |
| 
 | |
| test('should not fail on internal page logs', async ({ runUITest, server }) => {
 | |
|   const { page } = await runUITest({
 | |
|     'a.test.ts': `
 | |
|       import { test, expect } from '@playwright/test';
 | |
|       test('pass', async ({ browser }, testInfo) => {
 | |
|         const context = await browser.newContext({ storageState: { cookies: [], origins: [] } });
 | |
|         const page = await context.newPage();
 | |
|         await page.goto("${server.EMPTY_PAGE}");
 | |
|         await page.context().storageState({ path: testInfo.outputPath('storage.json') });
 | |
|       });
 | |
|     `,
 | |
|   });
 | |
| 
 | |
|   await page.getByText('pass').dblclick();
 | |
|   const listItem = page.getByTestId('actions-tree').getByRole('treeitem');
 | |
| 
 | |
|   await expect(
 | |
|       listItem,
 | |
|       'action list'
 | |
|   ).toHaveText([
 | |
|     /Before Hooks[\d.]+m?s/,
 | |
|     /browser.newContext[\d.]+m?s/,
 | |
|     /browserContext.newPage[\d.]+m?s/,
 | |
|     /page.goto/,
 | |
|     /browserContext.storageState[\d.]+m?s/,
 | |
|     /After Hooks/,
 | |
|   ]);
 | |
| });
 | |
| 
 | |
| test('should not show caught errors in the errors tab', async ({ runUITest }, testInfo) => {
 | |
|   const { page } = await runUITest({
 | |
|     'a.spec.ts': `
 | |
|       import { test, expect } from '@playwright/test';
 | |
|       test('pass', async ({ page }, testInfo) => {
 | |
|         await page.setContent("<input id='checkbox' type='checkbox'></input>");
 | |
|         await expect(page.locator('input')).toBeChecked({ timeout: 1 }).catch(() => {});
 | |
|       });
 | |
|     `,
 | |
|   });
 | |
| 
 | |
|   await page.getByText('pass').dblclick();
 | |
|   const listItem = page.getByTestId('actions-tree').getByRole('treeitem');
 | |
| 
 | |
|   await expect(
 | |
|       listItem,
 | |
|       'action list'
 | |
|   ).toHaveText([
 | |
|     /Before Hooks[\d.]+m?s/,
 | |
|     /page.setContent/,
 | |
|     /expect.toBeCheckedlocator.*[\d.]+m?s/,
 | |
|     /After Hooks/,
 | |
|   ]);
 | |
| 
 | |
|   await page.getByText('Source', { exact: true }).click();
 | |
|   await expect(page.locator('.source-line-running')).toContainText('toBeChecked');
 | |
|   await expect(page.locator('.CodeMirror-linewidget')).toHaveCount(0);
 | |
| 
 | |
|   await page.getByText('Errors', { exact: true }).click();
 | |
|   await expect(page.locator('.tab-errors')).toHaveText('No errors');
 | |
| });
 | |
| 
 | |
| test('should show errors with causes in the error tab', async ({ runUITest }) => {
 | |
|   const { page } = await runUITest({
 | |
|     'a.spec.ts': `
 | |
|       import { test, expect } from '@playwright/test';
 | |
|       test('pass', async ({ page }) => {
 | |
|         try {
 | |
|           try {
 | |
|             const error = new Error('my-message');
 | |
|             error.name = 'SpecialError';
 | |
|             throw error;
 | |
|           } catch (e) {
 | |
|             try {
 | |
|               throw new Error('inner-message', { cause: e });
 | |
|             } catch (e) {
 | |
|               throw new Error('outer-message', { cause: e });
 | |
|             }
 | |
|           }
 | |
|         } catch (e) {
 | |
|           throw new Error('wrapper-message', { cause: e });
 | |
|         }
 | |
|       });
 | |
|     `,
 | |
|   });
 | |
| 
 | |
|   await page.getByText('pass').dblclick();
 | |
|   await page.getByText('Errors', { exact: true }).click();
 | |
|   await expect(page.locator('.tab-errors')).toContainText(`Error: wrapper-message
 | |
| [cause]: Error: outer-message
 | |
| [cause]: Error: inner-message
 | |
| [cause]: SpecialError: my-message`);
 | |
| });
 | |
| 
 | |
| test('should reveal errors in the sourcetab', async ({ runUITest }) => {
 | |
|   const { page } = await runUITest({
 | |
|     'a.spec.ts': `
 | |
|       import { test, expect } from '@playwright/test';
 | |
|       test('pass', async ({ page }) => {
 | |
|         throw new Error('Oh my');
 | |
|       });
 | |
|     `,
 | |
|   });
 | |
| 
 | |
|   await page.getByText('pass').dblclick();
 | |
|   const listItem = page.getByTestId('actions-tree').getByRole('treeitem');
 | |
| 
 | |
|   await expect(
 | |
|       listItem,
 | |
|       'action list'
 | |
|   ).toContainText([
 | |
|     /Before Hooks/,
 | |
|     /After Hooks/,
 | |
|   ]);
 | |
| 
 | |
|   await page.getByText('Errors', { exact: true }).click();
 | |
|   await page.getByText('a.spec.ts:4', { exact: true }).click();
 | |
|   await expect(page.locator('.source-line-running')).toContainText(`throw new Error('Oh my');`);
 | |
| });
 | |
| 
 | |
| test('should show request source context id', async ({ runUITest, server }) => {
 | |
|   const { page } = await runUITest({
 | |
|     'a.spec.ts': `
 | |
|       import { test, expect } from '@playwright/test';
 | |
|       test('pass', async ({ page, context, request }) => {
 | |
|         await page.goto('${server.EMPTY_PAGE}');
 | |
|         const page2 = await context.newPage();
 | |
|         await page2.goto('${server.EMPTY_PAGE}');
 | |
|         await request.get('${server.EMPTY_PAGE}');
 | |
|       });
 | |
|     `,
 | |
|   });
 | |
| 
 | |
|   await page.getByText('pass').dblclick();
 | |
|   await page.getByText('Network', { exact: true }).click();
 | |
|   await expect(page.locator('span').filter({ hasText: 'Source' })).toBeVisible();
 | |
|   await expect(page.getByText('page#1')).toBeVisible();
 | |
|   await expect(page.getByText('page#2')).toBeVisible();
 | |
|   await expect(page.getByText('api#1')).toBeVisible();
 | |
| });
 | |
| 
 | |
| test('should work behind reverse proxy', { annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright/issues/33705' } }, async ({ runUITest, proxyServer: reverseProxy }) => {
 | |
|   const { page } = await runUITest({
 | |
|     'a.test.ts': `
 | |
|       import { test, expect } from '@playwright/test';
 | |
|       test('trace test', async ({ page }) => {
 | |
|         await page.setContent('<button>Submit</button>');
 | |
|         await page.getByRole('button').click();
 | |
|         expect(1).toBe(1);
 | |
|       });
 | |
|     `,
 | |
|   });
 | |
| 
 | |
|   const uiModeUrl = new URL(page.url());
 | |
|   reverseProxy.forwardTo(+uiModeUrl.port, { prefix: '/subdir', preserveHostname: true });
 | |
|   await page.goto(`${reverseProxy.URL}/subdir${uiModeUrl.pathname}?${uiModeUrl.searchParams}`);
 | |
| 
 | |
|   await page.getByText('trace test').dblclick();
 | |
| 
 | |
|   await expect(page.getByTestId('actions-tree')).toMatchAriaSnapshot(`
 | |
|     - tree:
 | |
|       - treeitem /Before Hooks \\d+[hmsp]+/
 | |
|       - treeitem /page\\.setContent \\d+[hmsp]+/
 | |
|       - treeitem /locator\\.clickgetByRole\\('button'\\) \\d+[hmsp]+/
 | |
|       - treeitem /expect\\.toBe \\d+[hmsp]+/ [selected]
 | |
|       - treeitem /After Hooks \\d+[hmsp]+/
 | |
|   `);
 | |
| 
 | |
|   await expect(
 | |
|       page.frameLocator('iframe.snapshot-visible[name=snapshot]').locator('button'),
 | |
|   ).toHaveText('Submit');
 | |
| });
 | |
| 
 | |
| test('should filter actions tab on double-click', async ({ runUITest, server }) => {
 | |
|   const { page } = await runUITest({
 | |
|     'a.spec.ts': `
 | |
|       import { test, expect } from '@playwright/test';
 | |
|       test('pass', async ({ page }) => {
 | |
|         await page.goto('${server.EMPTY_PAGE}');
 | |
|       });
 | |
|     `,
 | |
|   });
 | |
| 
 | |
|   await page.getByText('pass').dblclick();
 | |
| 
 | |
|   const actionsTree = page.getByTestId('actions-tree');
 | |
|   await expect(actionsTree.getByRole('treeitem')).toHaveText([
 | |
|     /Before Hooks/,
 | |
|     /page.goto/,
 | |
|     /After Hooks/,
 | |
|   ]);
 | |
|   await actionsTree.getByRole('treeitem', { name: 'page.goto' }).dblclick();
 | |
|   await expect(actionsTree.getByRole('treeitem')).toHaveText([
 | |
|     /page.goto/,
 | |
|   ]);
 | |
| });
 | |
| 
 | |
| test('should show custom fixture titles in actions tree', async ({ runUITest }) => {
 | |
|   const { page } = await runUITest({
 | |
|     'a.test.ts': `
 | |
|       import { test as base, expect } from '@playwright/test';
 | |
| 
 | |
|       const test = base.extend({
 | |
|         fixture1: [async ({}, use) => {
 | |
|           await use();
 | |
|         }, { title: 'My Custom Fixture' }],
 | |
|         fixture2: async ({}, use) => {
 | |
|           await use();
 | |
|         },
 | |
|       });
 | |
| 
 | |
|       test('fixture test', async ({ fixture1, fixture2 }) => {
 | |
|         // Empty test using both fixtures
 | |
|       });
 | |
|     `,
 | |
|   });
 | |
| 
 | |
|   await page.getByText('fixture test').dblclick();
 | |
|   const listItem = page.getByTestId('actions-tree').getByRole('treeitem');
 | |
|   await expect(listItem, 'action list').toHaveText([
 | |
|     /Before Hooks[\d.]+m?s/,
 | |
|     /My Custom Fixture[\d.]+m?s/,
 | |
|     /fixture2[\d.]+m?s/,
 | |
|     /After Hooks[\d.]+m?s/,
 | |
|   ]);
 | |
| });
 | |
| 
 | |
| test('attachments tab shows all but top-level .push attachments', async ({ runUITest }) => {
 | |
|   const { page } = await runUITest({
 | |
|     'a.test.ts': `
 | |
|       import { test, expect } from '@playwright/test';
 | |
|       test('attachment test', async ({}) => {
 | |
|         await test.step('step', async () => {
 | |
|           test.info().attachments.push({
 | |
|             name: 'foo-push',
 | |
|             body: Buffer.from('foo-content'),
 | |
|             contentType: 'text/plain'
 | |
|           });
 | |
| 
 | |
|           await test.info().attach('foo-attach', { body: 'foo-content' })
 | |
|         });
 | |
| 
 | |
|         test.info().attachments.push({
 | |
|           name: 'bar-push',
 | |
|           body: Buffer.from('bar-content'),
 | |
|           contentType: 'text/plain'
 | |
|         });
 | |
|         await test.info().attach('bar-attach', { body: 'bar-content' })
 | |
|       });
 | |
|     `,
 | |
|   });
 | |
| 
 | |
|   await page.getByRole('treeitem', { name: 'attachment test' }).dblclick();
 | |
|   const actionsTree = page.getByTestId('actions-tree');
 | |
|   await actionsTree.getByRole('treeitem', { name: 'step' }).click();
 | |
|   await page.keyboard.press('ArrowRight');
 | |
|   await expect(actionsTree, 'attach() and top-level attachments.push calls are shown as actions').toMatchAriaSnapshot(`
 | |
|     - tree:
 | |
|       - treeitem /step/:
 | |
|         - group:
 | |
|           - treeitem /attach \\"foo-attach\\"/
 | |
|       - treeitem /attach \\"bar-push\\"/
 | |
|       - treeitem /attach \\"bar-attach\\"/
 | |
|   `);
 | |
|   await page.getByRole('tab', { name: 'Attachments' }).click();
 | |
|   await expect(page.getByRole('tabpanel', { name: 'Attachments' })).toMatchAriaSnapshot(`
 | |
|     - tabpanel:
 | |
|       - button /foo-push/
 | |
|       - button /foo-attach/
 | |
|       - button /bar-push/
 | |
|       - button /bar-attach/
 | |
|   `);
 | |
| });
 | |
| 
 | |
| test('skipped steps should have an indicator', async ({ runUITest }) => {
 | |
|   const { page } = await runUITest({
 | |
|     'a.test.ts': `
 | |
|       import { test, expect } from '@playwright/test';
 | |
|       test('test with steps', async ({}) => {
 | |
|         await test.step('outer', async () => {
 | |
|           await test.step.skip('skipped1', () => {});
 | |
|         });
 | |
|         await test.step.skip('skipped2', () => {});
 | |
|       });
 | |
|     `,
 | |
|   });
 | |
| 
 | |
|   await page.getByRole('treeitem', { name: 'test with steps' }).dblclick();
 | |
|   const actionsTree = page.getByTestId('actions-tree');
 | |
|   await actionsTree.getByRole('treeitem', { name: 'outer' }).click();
 | |
|   await page.keyboard.press('ArrowRight');
 | |
|   await expect(actionsTree).toMatchAriaSnapshot(`
 | |
|     - tree:
 | |
|       - treeitem /outer/ [expanded]:
 | |
|         - group:
 | |
|           - treeitem /skipped1/
 | |
|       - treeitem /skipped2/
 | |
|   `);
 | |
|   const skippedMarker = actionsTree.getByRole('treeitem', { name: 'skipped1' }).locator('.action-skipped');
 | |
|   await expect(skippedMarker).toBeVisible();
 | |
|   await expect(skippedMarker).toHaveAccessibleName('skipped');
 | |
| });
 | |
| 
 | |
| test('should show copy prompt button in errors tab', async ({ runUITest }) => {
 | |
|   const { page } = await runUITest({
 | |
|     'a.spec.ts': `
 | |
|       import { test, expect } from '@playwright/test';
 | |
|       test('fails', async () => {
 | |
|         expect(1).toBe(2);
 | |
|       });
 | |
|     `,
 | |
|   });
 | |
| 
 | |
|   await page.getByText('fails').dblclick();
 | |
| 
 | |
|   await page.context().grantPermissions(['clipboard-read', 'clipboard-write']);
 | |
|   await page.getByText('Errors', { exact: true }).click();
 | |
|   await page.locator('.tab-errors').getByRole('button', { name: 'Copy as Prompt' }).click();
 | |
|   const prompt = await page.evaluate(() => navigator.clipboard.readText());
 | |
|   expect(prompt, 'contains error').toContain('expect(received).toBe(expected)');
 | |
| });
 | 
