mirror of
				https://github.com/microsoft/playwright.git
				synced 2025-06-26 21:40:17 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			292 lines
		
	
	
		
			9.5 KiB
		
	
	
	
		
			TypeScript
		
	
	
	
	
	
			
		
		
	
	
			292 lines
		
	
	
		
			9.5 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 { test, expect } from './playwright-test-fixtures';
 | |
| import { ZipFile } from '../../packages/playwright-core/lib/utils';
 | |
| import fs from 'fs';
 | |
| 
 | |
| test('should stop tracing with trace: on-first-retry, when not retrying', async ({ runInlineTest }, testInfo) => {
 | |
|   const result = await runInlineTest({
 | |
|     'playwright.config.ts': `
 | |
|       module.exports = { use: { trace: 'on-first-retry' } };
 | |
|     `,
 | |
|     'a.spec.ts': `
 | |
|       const { test } = pwt;
 | |
| 
 | |
|       test.describe('shared', () => {
 | |
|         let page;
 | |
|         test.beforeAll(async ({ browser }) => {
 | |
|           page = await browser.newPage();
 | |
|         });
 | |
| 
 | |
|         test.afterAll(async () => {
 | |
|           await page.close();
 | |
|         });
 | |
| 
 | |
|         test('flaky', async ({}, testInfo) => {
 | |
|           expect(testInfo.retry).toBe(1);
 | |
|         });
 | |
| 
 | |
|         test('no tracing', async ({}, testInfo) => {
 | |
|           const e = await page.context().tracing.stop({ path: 'ignored' }).catch(e => e);
 | |
|           expect(e.message).toContain('Must start tracing before stopping');
 | |
|         });
 | |
|       });
 | |
|     `,
 | |
|   }, { workers: 1, retries: 1 });
 | |
| 
 | |
|   expect(result.exitCode).toBe(0);
 | |
|   expect(result.passed).toBe(1);
 | |
|   expect(result.flaky).toBe(1);
 | |
|   expect(fs.existsSync(testInfo.outputPath('test-results', 'a-shared-flaky-retry1', 'trace.zip'))).toBeTruthy();
 | |
| });
 | |
| 
 | |
| test('should record api trace', async ({ runInlineTest, server }, testInfo) => {
 | |
|   const result = await runInlineTest({
 | |
|     'playwright.config.ts': `
 | |
|       module.exports = { use: { trace: 'on' } };
 | |
|     `,
 | |
|     'a.spec.ts': `
 | |
|       const { test } = pwt;
 | |
| 
 | |
|       test('pass', async ({request, page}, testInfo) => {
 | |
|         await page.goto('about:blank');
 | |
|         await request.get('${server.EMPTY_PAGE}');
 | |
|       });
 | |
| 
 | |
|       test('api pass', async ({playwright}, testInfo) => {
 | |
|         const request = await playwright.request.newContext();
 | |
|         await request.get('${server.EMPTY_PAGE}');
 | |
|       });
 | |
| 
 | |
|       test('fail', async ({request, page}, testInfo) => {
 | |
|         await page.goto('about:blank');
 | |
|         await request.get('${server.EMPTY_PAGE}');
 | |
|         expect(1).toBe(2);
 | |
|       });
 | |
|     `,
 | |
|   }, { workers: 1 });
 | |
| 
 | |
|   expect(result.exitCode).toBe(1);
 | |
|   expect(result.passed).toBe(2);
 | |
|   expect(result.failed).toBe(1);
 | |
|   // One trace file for request context and one for each APIRequestContext
 | |
|   expect(fs.existsSync(testInfo.outputPath('test-results', 'a-pass', 'trace.zip'))).toBeTruthy();
 | |
|   expect(fs.existsSync(testInfo.outputPath('test-results', 'a-pass', 'trace-1.zip'))).toBeTruthy();
 | |
|   expect(fs.existsSync(testInfo.outputPath('test-results', 'a-api-pass', 'trace.zip'))).toBeTruthy();
 | |
|   expect(fs.existsSync(testInfo.outputPath('test-results', 'a-api-pass', 'trace-1.zip'))).toBeFalsy();
 | |
|   expect(fs.existsSync(testInfo.outputPath('test-results', 'a-fail', 'trace.zip'))).toBeTruthy();
 | |
|   expect(fs.existsSync(testInfo.outputPath('test-results', 'a-fail', 'trace-1.zip'))).toBeTruthy();
 | |
|   // One leftover global APIRequestContext from 'api pass' test.
 | |
|   expect(fs.existsSync(testInfo.outputPath('test-results', 'a-fail', 'trace-2.zip'))).toBeTruthy();
 | |
| });
 | |
| 
 | |
| 
 | |
| test('should not throw with trace: on-first-retry and two retries in the same worker', async ({ runInlineTest }, testInfo) => {
 | |
|   const files = {};
 | |
|   for (let i = 0; i < 6; i++) {
 | |
|     files[`a${i}.spec.ts`] = `
 | |
|       import { test } from './helper';
 | |
|       test('flaky', async ({ myContext }, testInfo) => {
 | |
|         await new Promise(f => setTimeout(f, 200 + Math.round(Math.random() * 1000)));
 | |
|         expect(testInfo.retry).toBe(1);
 | |
|       });
 | |
|       test('passing', async ({ myContext }, testInfo) => {
 | |
|         await new Promise(f => setTimeout(f, 200 + Math.round(Math.random() * 1000)));
 | |
|       });
 | |
|     `;
 | |
|   }
 | |
|   const result = await runInlineTest({
 | |
|     ...files,
 | |
|     'playwright.config.ts': `
 | |
|       module.exports = { use: { trace: 'on-first-retry' } };
 | |
|     `,
 | |
|     'helper.ts': `
 | |
|       const { test: base } = pwt;
 | |
|       export const test = base.extend({
 | |
|         myContext: [async ({ browser }, use) => {
 | |
|           const c = await browser.newContext();
 | |
|           await use(c);
 | |
|           await c.close();
 | |
|         }, { scope: 'worker' }]
 | |
|       })
 | |
|     `,
 | |
|   }, { workers: 3, retries: 1 });
 | |
| 
 | |
|   expect(result.exitCode).toBe(0);
 | |
|   expect(result.passed).toBe(6);
 | |
|   expect(result.flaky).toBe(6);
 | |
| });
 | |
| 
 | |
| test('should save sources when requested', async ({ runInlineTest }, testInfo) => {
 | |
|   const result = await runInlineTest({
 | |
|     'playwright.config.ts': `
 | |
|       module.exports = {
 | |
|         use: {
 | |
|           trace: 'on',
 | |
|         }
 | |
|       };
 | |
|     `,
 | |
|     'a.spec.ts': `
 | |
|       const { test } = pwt;
 | |
|       test('pass', async ({ page }) => {
 | |
|         await page.evaluate(2 + 2);
 | |
|       });
 | |
|     `,
 | |
|   }, { workers: 1 });
 | |
|   expect(result.exitCode).toEqual(0);
 | |
|   const resources = await parseTrace(testInfo.outputPath('test-results', 'a-pass', 'trace.zip'));
 | |
|   expect([...resources.keys()].filter(f => f.includes('src@'))).toHaveLength(1);
 | |
| });
 | |
| 
 | |
| test('should not save sources when not requested', async ({ runInlineTest }, testInfo) => {
 | |
|   const result = await runInlineTest({
 | |
|     'playwright.config.ts': `
 | |
|       module.exports = {
 | |
|         use: {
 | |
|           trace: {
 | |
|             mode: 'on',
 | |
|             sources: false,
 | |
|           }
 | |
|         }
 | |
|       };
 | |
|     `,
 | |
|     'a.spec.ts': `
 | |
|       const { test } = pwt;
 | |
|       test('pass', async ({ page }) => {
 | |
|         await page.evaluate(2 + 2);
 | |
|       });
 | |
|     `,
 | |
|   }, { workers: 1 });
 | |
|   expect(result.exitCode).toEqual(0);
 | |
|   const resources = await parseTrace(testInfo.outputPath('test-results', 'a-pass', 'trace.zip'));
 | |
|   expect([...resources.keys()].filter(f => f.includes('src@'))).toHaveLength(0);
 | |
| });
 | |
| 
 | |
| test('should work in serial mode', async ({ runInlineTest }, testInfo) => {
 | |
|   const result = await runInlineTest({
 | |
|     'playwright.config.ts': `
 | |
|       module.exports = { use: { trace: 'retain-on-failure' } };
 | |
|     `,
 | |
|     'a.spec.ts': `
 | |
|       const { test } = pwt;
 | |
| 
 | |
|       test.describe.serial('serial', () => {
 | |
|         let page;
 | |
|         test.beforeAll(async ({ browser }) => {
 | |
|           page = await browser.newPage();
 | |
|         });
 | |
| 
 | |
|         test.afterAll(async () => {
 | |
|           await page.close();
 | |
|         });
 | |
| 
 | |
|         test('passes', async ({}, testInfo) => {
 | |
|         });
 | |
| 
 | |
|         test('fails', async ({}, testInfo) => {
 | |
|           throw new Error('oh my');
 | |
|         });
 | |
|       });
 | |
|     `,
 | |
|   }, { workers: 1 });
 | |
| 
 | |
|   expect(result.exitCode).toBe(1);
 | |
|   expect(result.passed).toBe(1);
 | |
|   expect(result.failed).toBe(1);
 | |
|   expect(fs.existsSync(testInfo.outputPath('test-results', 'a-serial-passes', 'trace.zip'))).toBeFalsy();
 | |
|   expect(fs.existsSync(testInfo.outputPath('test-results', 'a-serial-fails', 'trace.zip'))).toBeTruthy();
 | |
| });
 | |
| 
 | |
| test('should not override trace file in afterAll', async ({ runInlineTest, server }, testInfo) => {
 | |
|   const result = await runInlineTest({
 | |
|     'playwright.config.ts': `
 | |
|       module.exports = { use: { trace: 'retain-on-failure' } };
 | |
|     `,
 | |
|     'a.spec.ts': `
 | |
|       const { test } = pwt;
 | |
| 
 | |
|       test('test 1', async ({ page }) => {
 | |
|         await page.goto('about:blank');
 | |
|         throw 'oh no!';
 | |
|       });
 | |
| 
 | |
|       // Another test in the same file to affect after hooks order.
 | |
|       test('test 2', async ({}) => {
 | |
|       });
 | |
| 
 | |
|       test.afterAll(async ({ request }) => {
 | |
|         await request.get('${server.EMPTY_PAGE}');
 | |
|       });
 | |
|     `,
 | |
|   }, { workers: 1 });
 | |
| 
 | |
|   expect(result.exitCode).toBe(1);
 | |
|   expect(result.passed).toBe(1);
 | |
|   expect(result.failed).toBe(1);
 | |
|   expect(fs.existsSync(testInfo.outputPath('test-results', 'a-test-1', 'trace.zip'))).toBeTruthy();
 | |
|   expect(fs.existsSync(testInfo.outputPath('test-results', 'a-test-1', 'trace-1.zip'))).toBeTruthy();
 | |
| });
 | |
| 
 | |
| test('should retain traces for interrupted tests', async ({ runInlineTest }, testInfo) => {
 | |
|   const result = await runInlineTest({
 | |
|     'playwright.config.ts': `
 | |
|       module.exports = { use: { trace: 'retain-on-failure' }, maxFailures: 1 };
 | |
|     `,
 | |
|     'a.spec.ts': `
 | |
|       pwt.test('test 1', async ({ page }) => {
 | |
|         await page.waitForTimeout(2000);
 | |
|         expect(1).toBe(2);
 | |
|       });
 | |
|     `,
 | |
|     'b.spec.ts': `
 | |
|       pwt.test('test 2', async ({ page }) => {
 | |
|         await page.goto('about:blank');
 | |
|         await page.waitForTimeout(5000);
 | |
|       });
 | |
|     `,
 | |
|   }, { workers: 2 });
 | |
| 
 | |
|   expect(result.exitCode).toBe(1);
 | |
|   expect(result.failed).toBe(1);
 | |
|   expect(result.interrupted).toBe(1);
 | |
|   expect(fs.existsSync(testInfo.outputPath('test-results', 'a-test-1', 'trace.zip'))).toBeTruthy();
 | |
|   expect(fs.existsSync(testInfo.outputPath('test-results', 'b-test-2', 'trace.zip'))).toBeTruthy();
 | |
| });
 | |
| 
 | |
| test('should respect --trace', async ({ runInlineTest }, testInfo) => {
 | |
|   const result = await runInlineTest({
 | |
|     'a.spec.ts': `
 | |
|       pwt.test('test 1', async ({ page }) => {
 | |
|         await page.goto('about:blank');
 | |
|       });
 | |
|     `,
 | |
|   }, { trace: 'on' });
 | |
| 
 | |
|   expect(result.exitCode).toBe(0);
 | |
|   expect(result.passed).toBe(1);
 | |
|   expect(fs.existsSync(testInfo.outputPath('test-results', 'a-test-1', 'trace.zip'))).toBeTruthy();
 | |
| });
 | |
| 
 | |
| async function parseTrace(file: string): Promise<Map<string, Buffer>> {
 | |
|   const zipFS = new ZipFile(file);
 | |
|   const resources = new Map<string, Buffer>();
 | |
|   for (const entry of await zipFS.entries())
 | |
|     resources.set(entry, await zipFS.read(entry));
 | |
|   zipFS.close();
 | |
|   return resources;
 | |
| }
 | 
