/** * 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 fs from 'fs'; import path from 'path'; import { test as baseTest, expect } from './playwright-test-fixtures'; import { HttpServer } from 'playwright-core/src/utils/httpServer'; const test = baseTest.extend<{ showReport: () => Promise }>({ showReport: async ({ page }, use, testInfo) => { const server = new HttpServer(); await use(async () => { const reportFolder = testInfo.outputPath('playwright-report'); server.routePrefix('/', (request, response) => { let relativePath = new URL('http://localhost' + request.url).pathname; if (relativePath === '/') relativePath = '/index.html'; const absolutePath = path.join(reportFolder, ...relativePath.split('/')); return server.serveFile(response, absolutePath); }); const location = await server.start(); await page.goto(location); }); await server.stop(); } }); test.use({ channel: 'chrome' }); test('should generate report', async ({ runInlineTest }, testInfo) => { await runInlineTest({ 'playwright.config.ts': ` module.exports = { name: 'project-name' }; `, 'a.test.js': ` const { test } = pwt; test('passes', async ({}) => {}); test('fails', async ({}) => { expect(1).toBe(2); }); test('skip', async ({}) => { test.skip('Does not work') }); test('flaky', async ({}, testInfo) => { expect(testInfo.retry).toBe(1); }); `, }, { reporter: 'dot,html', retries: 1 }); const report = testInfo.outputPath('playwright-report', 'data', 'projects.json'); const reportObject = JSON.parse(fs.readFileSync(report, 'utf-8')); delete reportObject[0].suites[0].duration; delete reportObject[0].suites[0].location.line; delete reportObject[0].suites[0].location.column; const fileNames = new Set(); for (const test of reportObject[0].suites[0].tests) { fileNames.add(testInfo.outputPath('playwright-report', 'data', test.fileId + '.json')); delete test.testId; delete test.fileId; delete test.location.line; delete test.location.column; delete test.duration; } expect(reportObject[0]).toEqual({ name: 'project-name', suites: [ { title: 'a.test.js', location: { file: 'a.test.js' }, stats: { total: 4, expected: 1, unexpected: 1, flaky: 1, skipped: 1, ok: false }, suites: [], tests: [ { location: { file: 'a.test.js' }, title: 'passes', outcome: 'expected', ok: true }, { location: { file: 'a.test.js' }, title: 'fails', outcome: 'unexpected', ok: false }, { location: { file: 'a.test.js' }, title: 'skip', outcome: 'skipped', ok: true }, { location: { file: 'a.test.js' }, title: 'flaky', outcome: 'flaky', ok: true } ] } ], stats: { total: 4, expected: 1, unexpected: 1, flaky: 1, skipped: 1, ok: false } }); expect(fileNames.size).toBe(1); const fileName = fileNames.values().next().value; const testCase = JSON.parse(fs.readFileSync(fileName, 'utf-8')); expect(testCase.tests).toHaveLength(4); expect(testCase.tests.map(t => t.title)).toEqual(['passes', 'fails', 'skip', 'flaky']); expect(testCase).toBeTruthy(); }); test('should not throw when attachment is missing', async ({ runInlineTest }) => { const result = await runInlineTest({ 'playwright.config.ts': ` module.exports = { preserveOutput: 'failures-only' }; `, 'a.test.js': ` const { test } = pwt; test('passes', async ({ page }, testInfo) => { const screenshot = testInfo.outputPath('screenshot.png'); await page.screenshot({ path: screenshot }); testInfo.attachments.push({ name: 'screenshot', path: screenshot, contentType: 'image/png' }); }); `, }, { reporter: 'dot,html' }); expect(result.exitCode).toBe(0); expect(result.passed).toBe(1); }); test('should include image diff', async ({ runInlineTest, page, showReport }) => { const expected = Buffer.from('iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAAAXNSR0IArs4c6QAAAhVJREFUeJzt07ERwCAQwLCQ/Xd+FuDcQiFN4MZrZuYDjv7bAfAyg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAgEg0AwCASDQDAIBINAMAiEDVPZBYx6ffy+AAAAAElFTkSuQmCC', 'base64'); const result = await runInlineTest({ 'playwright.config.ts': ` module.exports = { use: { viewport: { width: 200, height: 200 }} }; `, 'a.test.js-snapshots/expected-linux.png': expected, 'a.test.js-snapshots/expected-darwin.png': expected, 'a.test.js-snapshots/expected-win32.png': expected, 'a.test.js': ` const { test } = pwt; test('fails', async ({ page }, testInfo) => { await page.setContent('Hello World'); const screenshot = await page.screenshot(); await expect(screenshot).toMatchSnapshot('expected.png'); }); `, }, { reporter: 'dot,html' }); expect(result.exitCode).toBe(1); expect(result.failed).toBe(1); await showReport(); await page.click('text=a.test.js'); await page.click('text=fails'); const imageDiff = page.locator('.test-image-mismatch'); const image = imageDiff.locator('img'); await expect(image).toHaveAttribute('src', /.*png/); const actualSrc = await image.getAttribute('src'); await imageDiff.locator('text=Expected').click(); const expectedSrc = await image.getAttribute('src'); await imageDiff.locator('text=Diff').click(); const diffSrc = await image.getAttribute('src'); const set = new Set([expectedSrc, actualSrc, diffSrc]); expect(set.size).toBe(3); }); test('should include screenshot on failure', async ({ runInlineTest, page, showReport }) => { const result = await runInlineTest({ 'playwright.config.ts': ` module.exports = { use: { viewport: { width: 200, height: 200 }, screenshot: 'only-on-failure', } }; `, 'a.test.js': ` const { test } = pwt; test('fails', async ({ page }) => { await page.setContent('Failed state'); await expect(true).toBeFalsy(); }); `, }, { reporter: 'dot,html' }); expect(result.exitCode).toBe(1); expect(result.failed).toBe(1); await showReport(); await page.click('text=a.test.js'); await page.click('text=fails'); await expect(page.locator('text=Screenshots')).toBeVisible(); await expect(page.locator('img')).toBeVisible(); const src = await page.locator('img').getAttribute('src'); expect(src).toBeTruthy(); });