mirror of
https://github.com/microsoft/playwright.git
synced 2025-06-26 21:40:17 +00:00
2055 lines
76 KiB
TypeScript
2055 lines
76 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 * as fs from 'fs';
|
||
import type { PlaywrightTestConfig } from '@playwright/test';
|
||
import path from 'path';
|
||
import url from 'url';
|
||
import type { HttpServer } from '../../packages/playwright-core/src/utils';
|
||
import { startHtmlReportServer } from '../../packages/playwright/lib/reporters/html';
|
||
import { expect as baseExpect, test as baseTest, stripAnsi } from './playwright-test-fixtures';
|
||
import extractZip from '../../packages/playwright-core/bundles/zip/node_modules/extract-zip';
|
||
import * as yazl from '../../packages/playwright-core/bundles/zip/node_modules/yazl';
|
||
import { getUserAgent } from '../../packages/playwright-core/lib/utils/userAgent';
|
||
import { Readable } from 'stream';
|
||
|
||
const DOES_NOT_SUPPORT_UTF8_IN_TERMINAL = process.platform === 'win32' && process.env.TERM_PROGRAM !== 'vscode' && !process.env.WT_SESSION;
|
||
const POSITIVE_STATUS_MARK = DOES_NOT_SUPPORT_UTF8_IN_TERMINAL ? 'ok' : '✓ ';
|
||
const NEGATIVE_STATUS_MARK = DOES_NOT_SUPPORT_UTF8_IN_TERMINAL ? 'x ' : '✘ ';
|
||
|
||
const test = baseTest.extend<{
|
||
showReport: (reportFolder?: string) => Promise<void>
|
||
}>({
|
||
showReport: async ({ page }, use) => {
|
||
let server: HttpServer | undefined;
|
||
await use(async (reportFolder?: string) => {
|
||
reportFolder ??= test.info().outputPath('playwright-report');
|
||
server = startHtmlReportServer(reportFolder) as HttpServer;
|
||
await server.start();
|
||
await page.goto(server.urlPrefix('precise'));
|
||
});
|
||
await server?.stop();
|
||
}
|
||
});
|
||
|
||
test.use({ channel: 'chrome' });
|
||
test.slow(!!process.env.CI);
|
||
// Slow tests are 90s.
|
||
const expect = baseExpect.configure({ timeout: process.env.CI ? 75000 : 25000 });
|
||
|
||
test.describe.configure({ mode: 'parallel' });
|
||
|
||
const echoReporterJs = `
|
||
class EchoReporter {
|
||
onBegin(config, suite) {
|
||
console.log('onBegin');
|
||
}
|
||
onTestBegin(test, result) {
|
||
console.log('onTestBegin');
|
||
}
|
||
onStdOut(chunk, test, result) {
|
||
console.log('onStdOut');
|
||
}
|
||
onStdErr(chunk, test, result) {
|
||
console.log('onStdErr');
|
||
}
|
||
onTestEnd(test, result) {
|
||
console.log('onTestEnd');
|
||
}
|
||
onEnd(result) {
|
||
console.log('onEnd');
|
||
}
|
||
onExit() {
|
||
console.log('onExit');
|
||
}
|
||
onError(error) {
|
||
console.log('onError');
|
||
}
|
||
onStepBegin(test, result, step) {
|
||
}
|
||
onStepEnd(test, result, step) {
|
||
}
|
||
}
|
||
module.exports = EchoReporter;
|
||
`;
|
||
|
||
test('should call methods in right order', async ({ runInlineTest, mergeReports }) => {
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const files = {
|
||
'echo-reporter.js': echoReporterJs,
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
retries: 1,
|
||
reporter: [['blob', { outputDir: '${reportDir.replace(/\\/g, '/')}' }]]
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 1', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
test('failing 1', async ({}) => {
|
||
expect(1).toBe(2);
|
||
});
|
||
test('flaky 1', async ({}) => {
|
||
expect(test.info().retry).toBe(1);
|
||
});
|
||
test.skip('skipped 1', async ({}) => {});
|
||
`,
|
||
'b.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 2', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
test('failing 2', async ({}) => {
|
||
expect(1).toBe(2);
|
||
});
|
||
test.skip('skipped 2', async ({}) => {});
|
||
`,
|
||
'c.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 3', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
test('flaky 2', async ({}) => {
|
||
expect(test.info().retry).toBe(1);
|
||
});
|
||
test.skip('skipped 3', async ({}) => {});
|
||
`
|
||
};
|
||
await runInlineTest(files, { shard: `1/3` });
|
||
await runInlineTest(files, { shard: `3/3` }, { PWTEST_BLOB_DO_NOT_REMOVE: '1' });
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
reportFiles.sort();
|
||
expect(reportFiles).toEqual([expect.stringMatching(/report-.*.zip/), expect.stringMatching(/report-.*.zip/)]);
|
||
const { exitCode, output } = await mergeReports(reportDir, {}, { additionalArgs: ['--reporter', test.info().outputPath('echo-reporter.js')] });
|
||
expect(exitCode).toBe(0);
|
||
const lines = output.split('\n').filter(l => l.trim().length);
|
||
expect(lines[0]).toBe('onBegin');
|
||
expect(lines).toContain('onTestBegin');
|
||
expect(lines).toContain('onEnd');
|
||
expect(lines).toContain('onExit');
|
||
expect(lines.indexOf('onBegin')).toBeLessThan(lines.indexOf('onTestBegin'));
|
||
expect(lines[lines.length - 2]).toBe('onEnd');
|
||
expect(lines[lines.length - 1]).toBe('onExit');
|
||
expect(lines.filter(l => l === 'onBegin').length).toBe(1);
|
||
expect(lines.filter(l => l === 'onEnd').length).toBe(1);
|
||
expect(lines.filter(l => l === 'onExit').length).toBe(1);
|
||
});
|
||
|
||
test('should merge into html with dependencies', async ({ runInlineTest, mergeReports, showReport, page }) => {
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
retries: 1,
|
||
reporter: [['blob', { outputDir: '${reportDir.replace(/\\/g, '/')}' }]],
|
||
projects: [
|
||
{ name: 'test', dependencies: ['setup'] },
|
||
{ name: 'setup', testMatch: /.*setup.js/ },
|
||
]
|
||
};
|
||
`,
|
||
'setup.js': `
|
||
import { test as setup } from '@playwright/test';
|
||
setup('login once', async ({}) => {
|
||
await setup.step('login step', async () => {});
|
||
});
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 1', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
test('failing 1', async ({}) => {
|
||
expect(1).toBe(2);
|
||
});
|
||
test('flaky 1', async ({}) => {
|
||
expect(test.info().retry).toBe(1);
|
||
});
|
||
test.skip('skipped 1', async ({}) => {});
|
||
`,
|
||
'b.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 2', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
test('failing 2', async ({}) => {
|
||
expect(1).toBe(2);
|
||
});
|
||
test.skip('skipped 2', async ({}) => {});
|
||
`,
|
||
'c.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 3', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
test('flaky 2', async ({}) => {
|
||
expect(test.info().retry).toBe(1);
|
||
});
|
||
test.skip('skipped 3', async ({}) => {});
|
||
`
|
||
};
|
||
const totalShards = 3;
|
||
for (let i = 0; i < totalShards; i++)
|
||
await runInlineTest(files, { shard: `${i + 1}/${totalShards}` }, { PWTEST_BLOB_DO_NOT_REMOVE: '1' });
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
reportFiles.sort();
|
||
expect(reportFiles).toEqual([expect.stringMatching(/report-.*.zip/), expect.stringMatching(/report-.*.zip/), expect.stringMatching(/report-.*.zip/)]);
|
||
const { exitCode, output } = await mergeReports(reportDir, { 'PLAYWRIGHT_HTML_OPEN': 'never' }, { additionalArgs: ['--reporter', 'html'] });
|
||
expect(exitCode).toBe(0);
|
||
|
||
expect(output).not.toContain('To open last HTML report run:');
|
||
|
||
await showReport();
|
||
|
||
await expect(page.locator('.subnav-item:has-text("All") .counter')).toHaveText('10');
|
||
await expect(page.locator('.subnav-item:has-text("Passed") .counter')).toHaveText('6');
|
||
await expect(page.locator('.subnav-item:has-text("Failed") .counter')).toHaveText('2');
|
||
await expect(page.locator('.subnav-item:has-text("Flaky") .counter')).toHaveText('2');
|
||
await expect(page.locator('.subnav-item:has-text("Skipped") .counter')).toHaveText('3');
|
||
|
||
await expect(page.locator('.test-file-test .test-file-title')).toHaveText([
|
||
'failing 1', 'flaky 1', 'math 1',
|
||
'failing 2', 'math 2',
|
||
'flaky 2', 'math 3',
|
||
'login once', 'login once', 'login once',
|
||
]);
|
||
|
||
for (let i = 0; i < 3; i++) {
|
||
await page.getByText('login once').nth(i).click();
|
||
await expect(page.getByText('login step')).toBeVisible();
|
||
await page.goBack();
|
||
}
|
||
});
|
||
|
||
test('should merge blob into blob', async ({ runInlineTest, mergeReports, showReport, page }) => {
|
||
const reportDir = test.info().outputPath('blob-report-orig');
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
retries: 1,
|
||
reporter: [['blob', { outputDir: '${reportDir.replace(/\\/g, '/')}' }]]
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 1', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
test('failing 1', async ({}) => {
|
||
expect(1).toBe(2);
|
||
});
|
||
test('flaky 1', async ({}) => {
|
||
expect(test.info().retry).toBe(1);
|
||
});
|
||
test.skip('skipped 1', async ({}) => {});
|
||
`,
|
||
'b.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 2', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
test('failing 2', async ({}) => {
|
||
expect(1).toBe(2);
|
||
});
|
||
test.skip('skipped 2', async ({}) => {});
|
||
`
|
||
};
|
||
await runInlineTest(files, { shard: `1/2` }, { PWTEST_BLOB_DO_NOT_REMOVE: '1' });
|
||
await runInlineTest(files, { shard: `2/2` }, { PWTEST_BLOB_DO_NOT_REMOVE: '1' });
|
||
{
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
reportFiles.sort();
|
||
expect(reportFiles).toEqual(['report-1.zip', 'report-2.zip']);
|
||
const { exitCode } = await mergeReports(reportDir, undefined, { additionalArgs: ['--reporter', 'blob'] });
|
||
expect(exitCode).toBe(0);
|
||
}
|
||
{
|
||
const compinedBlobReportDir = test.info().outputPath('blob-report');
|
||
const { exitCode } = await mergeReports(compinedBlobReportDir, { 'PLAYWRIGHT_HTML_OPEN': 'never' }, { additionalArgs: ['--reporter', 'html,json'] });
|
||
expect(exitCode).toBe(0);
|
||
expect(fs.existsSync(test.info().outputPath('report.json'))).toBe(true);
|
||
await showReport();
|
||
await expect(page.locator('.subnav-item:has-text("All") .counter')).toHaveText('5');
|
||
await expect(page.locator('.subnav-item:has-text("Passed") .counter')).toHaveText('2');
|
||
await expect(page.locator('.subnav-item:has-text("Failed") .counter')).toHaveText('2');
|
||
await expect(page.locator('.subnav-item:has-text("Flaky") .counter')).toHaveText('1');
|
||
await expect(page.locator('.subnav-item:has-text("Skipped") .counter')).toHaveText('2');
|
||
}
|
||
});
|
||
|
||
test('should produce consistent step ids', {
|
||
annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright/issues/31023' },
|
||
}, async ({ runInlineTest, mergeReports, showReport, page }) => {
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
retries: 1,
|
||
reporter: [
|
||
['blob', { outputFile: 'blob-report/report-1.zip' }],
|
||
['blob', { outputFile: 'blob-report/report-2.zip' }]
|
||
]
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 1', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
`
|
||
};
|
||
await runInlineTest(files);
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
reportFiles.sort();
|
||
expect(reportFiles).toEqual(['report-1.zip', 'report-2.zip']);
|
||
const { exitCode } = await mergeReports(reportDir, { 'PLAYWRIGHT_HTML_OPEN': 'never' }, { additionalArgs: ['--reporter', 'html,json'] });
|
||
expect(exitCode).toBe(0);
|
||
await showReport();
|
||
await expect(page.locator('.subnav-item:has-text("All") .counter')).toHaveText('2');
|
||
await expect(page.locator('.subnav-item:has-text("Passed") .counter')).toHaveText('2');
|
||
});
|
||
|
||
test('be able to merge incomplete shards', async ({ runInlineTest, mergeReports, showReport, page }) => {
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
retries: 1,
|
||
reporter: [['blob', { outputDir: '${reportDir.replace(/\\/g, '/')}' }]]
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 1', async ({}) => {
|
||
});
|
||
test('failing 1', async ({}) => {
|
||
expect(1).toBe(2);
|
||
});
|
||
test.skip('skipped 1', async ({}) => {});
|
||
`,
|
||
'b.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 2', async ({}) => { });
|
||
test('failing 2', async ({}) => {
|
||
expect(1).toBe(2);
|
||
});
|
||
test.skip('skipped 2', async ({}) => {});
|
||
`,
|
||
'c.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 3', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
test('flaky 2', async ({}) => {
|
||
expect(test.info().retry).toBe(1);
|
||
});
|
||
test.skip('skipped 3', async ({}) => {});
|
||
`
|
||
};
|
||
await runInlineTest(files, { shard: `1/3` });
|
||
await runInlineTest(files, { shard: `3/3` }, { PWTEST_BLOB_DO_NOT_REMOVE: '1' });
|
||
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
reportFiles.sort();
|
||
expect(reportFiles).toEqual([expect.stringMatching(/report-.*.zip/), expect.stringMatching(/report-.*.zip/)]);
|
||
const { exitCode } = await mergeReports(reportDir, { 'PLAYWRIGHT_HTML_OPEN': 'never' }, { additionalArgs: ['--reporter', 'html'] });
|
||
expect(exitCode).toBe(0);
|
||
|
||
await showReport();
|
||
|
||
await expect(page.locator('.subnav-item:has-text("All") .counter')).toHaveText('4');
|
||
await expect(page.locator('.subnav-item:has-text("Passed") .counter')).toHaveText('2');
|
||
await expect(page.locator('.subnav-item:has-text("Failed") .counter')).toHaveText('1');
|
||
await expect(page.locator('.subnav-item:has-text("Flaky") .counter')).toHaveText('1');
|
||
await expect(page.locator('.subnav-item:has-text("Skipped") .counter')).toHaveText('2');
|
||
});
|
||
|
||
test('total time is from test run not from merge', async ({ runInlineTest, mergeReports, showReport, page }) => {
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
retries: 1,
|
||
reporter: [['blob', { outputDir: '${reportDir.replace(/\\/g, '/')}' }]]
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('slow 1', async ({}) => {
|
||
await new Promise(f => setTimeout(f, 2000));
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
`,
|
||
'b.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('slow 1', async ({}) => {
|
||
await new Promise(f => setTimeout(f, 1000));
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
`,
|
||
};
|
||
await runInlineTest(files, { shard: `1/2` });
|
||
await runInlineTest(files, { shard: `2/2` }, { PWTEST_BLOB_DO_NOT_REMOVE: '1' });
|
||
|
||
const { exitCode, output } = await mergeReports(reportDir, { 'PLAYWRIGHT_HTML_OPEN': 'never' }, { additionalArgs: ['--reporter', 'html'] });
|
||
expect(exitCode).toBe(0);
|
||
|
||
expect(output).not.toContain('To open last HTML report run:');
|
||
|
||
await showReport();
|
||
|
||
await expect(page.locator('.subnav-item:has-text("All") .counter')).toHaveText('2');
|
||
await expect(page.locator('.subnav-item:has-text("Passed") .counter')).toHaveText('2');
|
||
|
||
const durationText = await page.getByTestId('overall-duration').textContent();
|
||
// "Total time: 2.1s"
|
||
const time = /Total time: (\d+)(\.\d+)?s/.exec(durationText);
|
||
expect(time).toBeTruthy();
|
||
expect(parseInt(time[1], 10)).toBeGreaterThanOrEqual(2);
|
||
});
|
||
|
||
test('merge into list report by default', async ({ runInlineTest, mergeReports }) => {
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
retries: 1,
|
||
reporter: [['blob', { outputDir: '${reportDir.replace(/\\/g, '/')}' }]]
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 1', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
test('failing 1', async ({}) => {
|
||
expect(1).toBe(2);
|
||
});
|
||
test('flaky 1', async ({}) => {
|
||
expect(test.info().retry).toBe(1);
|
||
});
|
||
test.skip('skipped 1', async ({}) => {});
|
||
`,
|
||
'b.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 2', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
test('failing 2', async ({}) => {
|
||
expect(1).toBe(2);
|
||
});
|
||
test.skip('skipped 2', async ({}) => {});
|
||
`,
|
||
'c.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 3', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
test('flaky 2', async ({}) => {
|
||
expect(test.info().retry).toBe(1);
|
||
});
|
||
test.skip('skipped 3', async ({}) => {});
|
||
`
|
||
};
|
||
|
||
const totalShards = 3;
|
||
for (let i = 0; i < totalShards; i++)
|
||
await runInlineTest(files, { shard: `${i + 1}/${totalShards}` }, { PWTEST_BLOB_DO_NOT_REMOVE: '1' });
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
reportFiles.sort();
|
||
expect(reportFiles).toEqual(['report-1.zip', 'report-2.zip', 'report-3.zip']);
|
||
const { exitCode, output } = await mergeReports(reportDir, { PW_TEST_DEBUG_REPORTERS: '1', PLAYWRIGHT_LIST_PRINT_STEPS: '1', PLAYWRIGHT_FORCE_TTY: '80' }, { additionalArgs: ['--reporter', 'list'] });
|
||
expect(exitCode).toBe(0);
|
||
|
||
const text = stripAnsi(output);
|
||
expect(text).toContain('Running 10 tests using 3 workers');
|
||
const lines = text.split('\n').filter(l => l.match(/^#.* :/)).map(l => l.replace(/[.\d]+m?s/, 'Xms'));
|
||
expect(lines).toEqual([
|
||
`#0 : 1 a.test.js:3:11 › math 1`,
|
||
`#0 : ${POSITIVE_STATUS_MARK} 1 a.test.js:3:11 › math 1 (Xms)`,
|
||
`#1 : 2 a.test.js:6:11 › failing 1`,
|
||
`#1 : ${NEGATIVE_STATUS_MARK} 2 a.test.js:6:11 › failing 1 (Xms)`,
|
||
`#2 : 3 a.test.js:6:11 › failing 1 (retry #1)`,
|
||
`#2 : ${NEGATIVE_STATUS_MARK} 3 a.test.js:6:11 › failing 1 (retry #1) (Xms)`,
|
||
`#3 : 4 a.test.js:9:11 › flaky 1`,
|
||
`#3 : ${NEGATIVE_STATUS_MARK} 4 a.test.js:9:11 › flaky 1 (Xms)`,
|
||
`#4 : 5 a.test.js:9:11 › flaky 1 (retry #1)`,
|
||
`#4 : ${POSITIVE_STATUS_MARK} 5 a.test.js:9:11 › flaky 1 (retry #1) (Xms)`,
|
||
`#5 : 6 a.test.js:12:12 › skipped 1`,
|
||
`#5 : - 6 a.test.js:12:12 › skipped 1`,
|
||
`#6 : 7 b.test.js:3:11 › math 2`,
|
||
`#6 : ${POSITIVE_STATUS_MARK} 7 b.test.js:3:11 › math 2 (Xms)`,
|
||
`#7 : 8 b.test.js:6:11 › failing 2`,
|
||
`#7 : ${NEGATIVE_STATUS_MARK} 8 b.test.js:6:11 › failing 2 (Xms)`,
|
||
`#8 : 9 b.test.js:6:11 › failing 2 (retry #1)`,
|
||
`#8 : ${NEGATIVE_STATUS_MARK} 9 b.test.js:6:11 › failing 2 (retry #1) (Xms)`,
|
||
`#9 : 10 b.test.js:9:12 › skipped 2`,
|
||
`#9 : - 10 b.test.js:9:12 › skipped 2`,
|
||
`#10 : 11 c.test.js:3:11 › math 3`,
|
||
`#10 : ${POSITIVE_STATUS_MARK} 11 c.test.js:3:11 › math 3 (Xms)`,
|
||
`#11 : 12 c.test.js:6:11 › flaky 2`,
|
||
`#11 : ${NEGATIVE_STATUS_MARK} 12 c.test.js:6:11 › flaky 2 (Xms)`,
|
||
`#12 : 13 c.test.js:6:11 › flaky 2 (retry #1)`,
|
||
`#12 : ${POSITIVE_STATUS_MARK} 13 c.test.js:6:11 › flaky 2 (retry #1) (Xms)`,
|
||
`#13 : 14 c.test.js:9:12 › skipped 3`,
|
||
`#13 : - 14 c.test.js:9:12 › skipped 3`,
|
||
]);
|
||
});
|
||
|
||
test('should print progress', async ({ runInlineTest, mergeReports }) => {
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
retries: 1,
|
||
reporter: [['blob', { outputDir: '${reportDir.replace(/\\/g, '/')}' }]]
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 1', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
test('failing 1', async ({}) => {
|
||
expect(1).toBe(2);
|
||
});
|
||
test('flaky 1', async ({}) => {
|
||
expect(test.info().retry).toBe(1);
|
||
});
|
||
test.skip('skipped 1', async ({}) => {});
|
||
`,
|
||
'b.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 2', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
test('failing 2', async ({}) => {
|
||
expect(1).toBe(2);
|
||
});
|
||
test.skip('skipped 2', async ({}) => {});
|
||
`,
|
||
'c.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 3', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
test('flaky 2', async ({}) => {
|
||
expect(test.info().retry).toBe(1);
|
||
});
|
||
test.skip('skipped 3', async ({}) => {});
|
||
`
|
||
};
|
||
|
||
await runInlineTest(files, { shard: `1/2` }, { PWTEST_BLOB_DO_NOT_REMOVE: '1' });
|
||
await runInlineTest(files, { shard: `2/2` }, { PWTEST_BLOB_DO_NOT_REMOVE: '1' });
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
reportFiles.sort();
|
||
expect(reportFiles).toEqual(['report-1.zip', 'report-2.zip']);
|
||
const { exitCode, output } = await mergeReports(reportDir, { PLAYWRIGHT_HTML_OPEN: 'never' }, { additionalArgs: ['--reporter', 'html'] });
|
||
expect(exitCode).toBe(0);
|
||
|
||
const lines = output.split('\n');
|
||
expect(lines).toContainEqual(expect.stringMatching(/extracting: blob-report[\/\\]report-.*zip$/));
|
||
expect(lines).toContainEqual(expect.stringMatching(/merging events$/));
|
||
expect(lines).toContainEqual(expect.stringMatching(/building final report/));
|
||
expect(lines).toContainEqual(expect.stringMatching(/finished building report/));
|
||
});
|
||
|
||
test('preserve attachments', async ({ runInlineTest, mergeReports, showReport, page }) => {
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
retries: 1,
|
||
reporter: [['blob', { outputDir: '${reportDir.replace(/\\/g, '/')}' }]]
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
import fs from 'fs';
|
||
|
||
test('first', async ({}) => {
|
||
const attachmentPath = test.info().outputPath('foo.txt');
|
||
fs.writeFileSync(attachmentPath, 'hello!');
|
||
await test.info().attach('file-attachment', {path: attachmentPath});
|
||
|
||
console.log('console info');
|
||
console.error('console error');
|
||
});
|
||
test('failing 1', async ({}) => {
|
||
await test.info().attach('text-attachment', { body: 'hi!' });
|
||
expect(1).toBe(2);
|
||
});
|
||
test.skip('skipped 1', async ({}) => {});
|
||
`,
|
||
'b.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 2', async ({}) => { });
|
||
test('failing 2', async ({}) => {
|
||
expect(1).toBe(2);
|
||
});
|
||
test.skip('skipped 2', async ({}) => {});
|
||
`
|
||
};
|
||
await runInlineTest(files, { shard: `1/2` });
|
||
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
reportFiles.sort();
|
||
expect(reportFiles).toEqual(['report-1.zip']);
|
||
const { exitCode } = await mergeReports(reportDir, { 'PLAYWRIGHT_HTML_OPEN': 'never' }, { additionalArgs: ['--reporter', 'html'] });
|
||
expect(exitCode).toBe(0);
|
||
|
||
await showReport();
|
||
|
||
await page.getByText('first').click();
|
||
const downloadPromise = page.waitForEvent('download');
|
||
// Check file attachment.
|
||
await page.getByRole('link', { name: 'file-attachment' }).click();
|
||
const download = await downloadPromise;
|
||
// Check file attachment content.
|
||
expect(await readAllFromStreamAsString(await download.createReadStream())).toEqual('hello!');
|
||
|
||
await page.goBack();
|
||
|
||
await page.getByText('failing 1').click();
|
||
await expect(page.getByText('\'text-attachment\', { body: \'hi!\'')).toBeVisible();
|
||
});
|
||
|
||
test('generate html with attachment urls', async ({ runInlineTest, mergeReports, page, server }) => {
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
retries: 1,
|
||
use: {
|
||
trace: 'on'
|
||
},
|
||
reporter: [['blob', { outputDir: '${reportDir.replace(/\\/g, '/')}' }]]
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
import fs from 'fs';
|
||
|
||
test('first', async ({}) => {
|
||
const attachmentPath = test.info().outputPath('foo.txt');
|
||
fs.writeFileSync(attachmentPath, 'hello!');
|
||
await test.info().attach('file-attachment', { path: attachmentPath });
|
||
|
||
console.log('console info');
|
||
console.error('console error');
|
||
});
|
||
test('failing 1', async ({}) => {
|
||
await test.info().attach('text-attachment', { body: 'hi!' });
|
||
expect(1).toBe(2);
|
||
});
|
||
test.skip('skipped 1', async ({}) => {});
|
||
`,
|
||
'b.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 2', async ({}) => { });
|
||
test('failing 2', async ({}) => {
|
||
expect(1).toBe(2);
|
||
});
|
||
test.skip('skipped 2', async ({}) => {});
|
||
`
|
||
};
|
||
await runInlineTest(files, { shard: `1/2` });
|
||
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
reportFiles.sort();
|
||
expect(reportFiles).toEqual(['report-1.zip']);
|
||
const { exitCode } = await mergeReports(reportDir, { 'PLAYWRIGHT_HTML_OPEN': 'never' }, { additionalArgs: ['--reporter', 'html'] });
|
||
expect(exitCode).toBe(0);
|
||
|
||
const htmlReportDir = test.info().outputPath('playwright-report');
|
||
for (const entry of await fs.promises.readdir(htmlReportDir))
|
||
await fs.promises.cp(path.join(htmlReportDir, entry), path.join(reportDir, entry), { recursive: true });
|
||
|
||
const oldServeFile = server.serveFile;
|
||
server.serveFile = async (req, res) => {
|
||
const pathName = url.parse(req.url!).pathname!;
|
||
const filePath = path.join(reportDir, pathName.substring(1));
|
||
return oldServeFile.call(server, req, res, filePath);
|
||
};
|
||
|
||
await page.goto(`${server.PREFIX}/index.html`);
|
||
await page.getByText('first').click();
|
||
|
||
const downloadPromise = page.waitForEvent('download');
|
||
// Check file attachment.
|
||
await page.getByRole('link', { name: 'file-attachment' }).click();
|
||
const download = await downloadPromise;
|
||
// Check file attachment content.
|
||
expect(await readAllFromStreamAsString(await download.createReadStream())).toEqual('hello!');
|
||
|
||
await page.goBack();
|
||
|
||
// Check inline attachment.
|
||
await page.getByText('failing 1').click();
|
||
await expect(page.getByText('\'text-attachment\', { body: \'hi!\'')).toBeVisible();
|
||
await page.goBack();
|
||
|
||
// Check that trace loads.
|
||
await page.locator('div').filter({ hasText: /^a\.test\.js:13$/ }).getByRole('link', { name: 'View trace' }).click();
|
||
await expect(page).toHaveTitle('Playwright Trace Viewer');
|
||
await expect(page.getByTestId('actions-tree').locator('div').filter({ hasText: /^expect\.toBe$/ })).toBeVisible();
|
||
});
|
||
|
||
test('resource names should not clash between runs', async ({ runInlineTest, showReport, mergeReports, page }) => {
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
reporter: [['blob', { outputDir: '${reportDir.replace(/\\/g, '/')}' }]]
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
import fs from 'fs';
|
||
import path from 'path';
|
||
|
||
test('first', async ({}) => {
|
||
const attachmentPath = path.join(test.info().config.rootDir, 'foo.txt');
|
||
fs.writeFileSync(attachmentPath, 'hello!');
|
||
test.info().attachments.push({ name: 'file-attachment', path: attachmentPath, contentType: 'text/plain' });
|
||
});
|
||
`,
|
||
'b.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
import fs from 'fs';
|
||
import path from 'path';
|
||
|
||
test('failing 2', async ({}) => {
|
||
const attachmentPath = path.join(test.info().config.rootDir, 'foo.txt');
|
||
fs.writeFileSync(attachmentPath, 'bye!');
|
||
test.info().attachments.push({ name: 'file-attachment', path: attachmentPath, contentType: 'text/plain' });
|
||
});
|
||
`
|
||
};
|
||
await runInlineTest(files, { shard: `1/2` });
|
||
await runInlineTest(files, { shard: `2/2` }, { PWTEST_BLOB_DO_NOT_REMOVE: '1' });
|
||
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
reportFiles.sort();
|
||
expect(reportFiles).toEqual(['report-1.zip', 'report-2.zip']);
|
||
|
||
const { exitCode } = await mergeReports(reportDir, { 'PLAYWRIGHT_HTML_OPEN': 'never' }, { additionalArgs: ['--reporter', 'html'] });
|
||
expect(exitCode).toBe(0);
|
||
|
||
await showReport();
|
||
|
||
const fileAttachment = page.getByRole('link', { name: 'file-attachment' });
|
||
// Check first attachment content.
|
||
{
|
||
await page.getByText('first').click();
|
||
await expect(fileAttachment).toBeVisible();
|
||
|
||
const downloadPromise = page.waitForEvent('download');
|
||
await fileAttachment.click();
|
||
const download = await downloadPromise;
|
||
expect(await readAllFromStreamAsString(await download.createReadStream())).toEqual('hello!');
|
||
await page.goBack();
|
||
}
|
||
|
||
// Check second attachment content.
|
||
{
|
||
await page.getByText('failing 2').click();
|
||
await expect(fileAttachment).toBeVisible();
|
||
|
||
const downloadPromise = page.waitForEvent('download');
|
||
await fileAttachment.click();
|
||
const download = await downloadPromise;
|
||
expect(await readAllFromStreamAsString(await download.createReadStream())).toEqual('bye!');
|
||
await page.goBack();
|
||
}
|
||
});
|
||
|
||
test('multiple output reports', async ({ runInlineTest, mergeReports, showReport, page }) => {
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
retries: 1,
|
||
reporter: [['blob', { outputDir: '${reportDir.replace(/\\/g, '/')}' }]]
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
import fs from 'fs';
|
||
|
||
test('first', async ({}) => {
|
||
const attachmentPath = test.info().outputPath('foo.txt');
|
||
fs.writeFileSync(attachmentPath, 'hello!');
|
||
await test.info().attach('file-attachment', {path: attachmentPath});
|
||
|
||
console.log('console info');
|
||
console.error('console error');
|
||
});
|
||
test('failing 1', async ({}) => {
|
||
await test.info().attach('text-attachment', { body: 'hi!' });
|
||
expect(1).toBe(2);
|
||
});
|
||
test.skip('skipped 1', async ({}) => {});
|
||
`,
|
||
'b.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 2', async ({}) => { });
|
||
test('failing 2', async ({}) => {
|
||
expect(1).toBe(2);
|
||
});
|
||
test.skip('skipped 2', async ({}) => {});
|
||
`
|
||
};
|
||
await runInlineTest(files, { shard: `1/2` });
|
||
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
reportFiles.sort();
|
||
expect(reportFiles).toEqual(['report-1.zip']);
|
||
const { exitCode, output } = await mergeReports(reportDir, { 'PLAYWRIGHT_HTML_OPEN': 'never' }, { additionalArgs: ['--reporter', 'html,line'] });
|
||
expect(exitCode).toBe(0);
|
||
|
||
// Check that line reporter was called.
|
||
const text = stripAnsi(output);
|
||
expect(text).toContain('Running 3 tests using 1 worker');
|
||
expect(text).toContain('[1/3] a.test.js:5:11 › first');
|
||
expect(text).toContain('a.test.js:13:11 › failing 1 (retry #1)');
|
||
|
||
// Check html report presence.
|
||
await showReport();
|
||
await expect(page.getByText('first')).toBeVisible();
|
||
});
|
||
|
||
test('multiple output reports based on config', async ({ runInlineTest, mergeReports }) => {
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const files = {
|
||
'merged/playwright.config.ts': `
|
||
module.exports = {
|
||
reporter: [['blob', { outputDir: 'merged-blob' }], ['html', { outputFolder: 'html', open: 'never' }], ['line']]
|
||
};
|
||
`,
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
retries: 1,
|
||
reporter: [['blob', { outputDir: '${reportDir.replace(/\\/g, '/')}' }]]
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
import fs from 'fs';
|
||
|
||
test('first', async ({}) => {
|
||
const attachmentPath = test.info().outputPath('foo.txt');
|
||
fs.writeFileSync(attachmentPath, 'hello!');
|
||
await test.info().attach('file-attachment', {path: attachmentPath});
|
||
|
||
console.log('console info');
|
||
console.error('console error');
|
||
});
|
||
test('failing 1', async ({}) => {
|
||
await test.info().attach('text-attachment', { body: 'hi!' });
|
||
expect(1).toBe(2);
|
||
});
|
||
test.skip('skipped 1', async ({}) => {});
|
||
`,
|
||
'b.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 2', async ({}) => { });
|
||
test('failing 2', async ({}) => {
|
||
expect(1).toBe(2);
|
||
});
|
||
test.skip('skipped 2', async ({}) => {});
|
||
`
|
||
};
|
||
await runInlineTest(files, { shard: `1/2` });
|
||
await runInlineTest(files, { shard: `2/2` }, { PWTEST_BLOB_DO_NOT_REMOVE: '1' });
|
||
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
reportFiles.sort();
|
||
expect(reportFiles).toEqual(['report-1.zip', 'report-2.zip']);
|
||
const { exitCode, output } = await mergeReports(reportDir, undefined, { additionalArgs: ['--config', test.info().outputPath('merged/playwright.config.ts')] });
|
||
expect(exitCode).toBe(0);
|
||
|
||
// Check that line reporter was called.
|
||
const text = stripAnsi(output);
|
||
expect(text).toContain('Running 6 tests using 2 workers');
|
||
expect(text).toContain('[1/6] a.test.js:5:11 › first');
|
||
expect(text).toContain('a.test.js:13:11 › failing 1 (retry #1)');
|
||
|
||
// Check html report presence.
|
||
expect((await fs.promises.stat(test.info().outputPath('merged/html/index.html'))).isFile).toBeTruthy();
|
||
|
||
// Check report presence.
|
||
const mergedBlobReportFiles = await fs.promises.readdir(test.info().outputPath('merged/merged-blob'));
|
||
expect(mergedBlobReportFiles).toEqual(['report.zip']);
|
||
});
|
||
|
||
test('onError in the report', async ({ runInlineTest, mergeReports, showReport, page }) => {
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
retries: 1,
|
||
reporter: [['blob', { outputDir: '${reportDir.replace(/\\/g, '/')}' }]]
|
||
};
|
||
`,
|
||
'a.test.ts': `
|
||
import { test as base, expect } from '@playwright/test';
|
||
|
||
const test = base.extend<{}, { errorInTearDown: string }>({
|
||
errorInTearDown: [async ({ }, use) => {
|
||
await use('');
|
||
throw new Error('Error in teardown');
|
||
}, { scope: 'worker' }],
|
||
});
|
||
|
||
test('test', async ({ page, errorInTearDown }) => {
|
||
});
|
||
test('pass', async ({ page, errorInTearDown }) => {
|
||
});
|
||
test.skip('skipped 1', async ({}) => {});
|
||
`,
|
||
'b.test.ts': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 2', async ({}) => { });
|
||
test('failing 2', async ({}) => {
|
||
expect(1).toBe(2);
|
||
});
|
||
test.skip('skipped 2', async ({}) => {});
|
||
`,
|
||
'c.test.ts': `
|
||
import { test, expect } from '@playwright/test';
|
||
|
||
test('math 3', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
test('flaky 2', async ({}) => {
|
||
expect(test.info().retry).toBe(1);
|
||
});
|
||
test.skip('skipped 3', async ({}) => {});
|
||
`
|
||
};
|
||
const result = await runInlineTest(files, { shard: `1/3` }, { PWTEST_BOT_NAME: 'macos-node16-ttest' });
|
||
expect(result.exitCode).toBe(1);
|
||
|
||
const { exitCode } = await mergeReports(reportDir, { 'PLAYWRIGHT_HTML_OPEN': 'never' }, { additionalArgs: ['--reporter', 'html'] });
|
||
expect(exitCode).toBe(0);
|
||
|
||
await showReport();
|
||
|
||
await expect(page.locator('.subnav-item:has-text("All") .counter')).toHaveText('2');
|
||
await expect(page.locator('.subnav-item:has-text("Passed") .counter')).toHaveText('2');
|
||
await expect(page.locator('.subnav-item:has-text("Failed") .counter')).toHaveText('0');
|
||
await expect(page.locator('.subnav-item:has-text("Flaky") .counter')).toHaveText('0');
|
||
await expect(page.locator('.subnav-item:has-text("Skipped") .counter')).toHaveText('1');
|
||
await expect(page.getByTestId('report-errors')).toContainText('(macos-node16-ttest) Error: Error in teardown');
|
||
});
|
||
|
||
test('preserve config fields', async ({ runInlineTest, mergeReports }) => {
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const config: PlaywrightTestConfig = {
|
||
// Runner options:
|
||
globalTimeout: 202300,
|
||
maxFailures: 3,
|
||
metadata: {
|
||
'a': 'b',
|
||
'b': 100,
|
||
},
|
||
workers: 1,
|
||
retries: 1,
|
||
reporter: [['blob', { outputDir: `${reportDir.replace(/\\/g, '/')}` }]],
|
||
// Reporter options:
|
||
reportSlowTests: {
|
||
max: 7,
|
||
threshold: 15_000,
|
||
},
|
||
quiet: true
|
||
};
|
||
const files = {
|
||
'echo-reporter.js': `
|
||
import fs from 'fs';
|
||
|
||
class EchoReporter {
|
||
onBegin(config, suite) {
|
||
fs.writeFileSync('config.json', JSON.stringify(config));
|
||
}
|
||
}
|
||
module.exports = EchoReporter;
|
||
`,
|
||
'playwright.config.ts': `
|
||
module.exports = ${JSON.stringify(config, null, 2)};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 1', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
`,
|
||
'b.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 2', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
`,
|
||
'c.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 3', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
`
|
||
};
|
||
|
||
await runInlineTest(files, { shard: `1/3`, workers: 1 });
|
||
await runInlineTest(files, { shard: `3/3`, workers: 1 }, { PWTEST_BLOB_DO_NOT_REMOVE: '1' });
|
||
|
||
const mergeConfig = {
|
||
reportSlowTests: {
|
||
max: 2,
|
||
threshold: 1_000,
|
||
},
|
||
quiet: false
|
||
};
|
||
await fs.promises.writeFile(test.info().outputPath('merge.config.ts'), `module.exports = ${JSON.stringify(mergeConfig, null, 2)};`);
|
||
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
reportFiles.sort();
|
||
expect(reportFiles).toEqual(['report-1.zip', 'report-3.zip']);
|
||
const { exitCode } = await mergeReports(reportDir, {}, { additionalArgs: ['--reporter', test.info().outputPath('echo-reporter.js'), '-c', test.info().outputPath('merge.config.ts')] });
|
||
expect(exitCode).toBe(0);
|
||
const json = JSON.parse(fs.readFileSync(test.info().outputPath('config.json')).toString());
|
||
// Test shard parameters.
|
||
expect(json.rootDir).toBe(test.info().outputDir);
|
||
expect(json.globalTimeout).toBe(config.globalTimeout);
|
||
expect(json.maxFailures).toBe(config.maxFailures);
|
||
expect(json.metadata).toEqual(expect.objectContaining(config.metadata));
|
||
expect(json.workers).toBe(2);
|
||
expect(json.version).toBeTruthy();
|
||
expect(json.version).not.toEqual(test.info().config.version);
|
||
// Reporter config parameters.
|
||
expect(json.reportSlowTests).toEqual(mergeConfig.reportSlowTests);
|
||
expect(json.configFile).toEqual(test.info().outputPath('merge.config.ts'));
|
||
expect(json.quiet).toEqual(mergeConfig.quiet);
|
||
});
|
||
|
||
test('preserve stdout and stderr', async ({ runInlineTest, mergeReports }) => {
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const files = {
|
||
'echo-reporter.js': `
|
||
import fs from 'fs';
|
||
|
||
class EchoReporter {
|
||
log = [];
|
||
onStdOut(chunk, test, result) {
|
||
this.log.push('onStdOut: ' + chunk);
|
||
this.log.push('result.stdout: ' + result.stdout);
|
||
}
|
||
onStdErr(chunk, test, result) {
|
||
this.log.push('onStdErr: ' + chunk);
|
||
this.log.push('result.stderr: ' + result.stderr);
|
||
}
|
||
onTestEnd(test, result) {
|
||
this.log.push('onTestEnd');
|
||
this.log.push('result.stdout: ' + result.stdout);
|
||
this.log.push('result.stderr: ' + result.stderr);
|
||
}
|
||
onEnd() {
|
||
fs.writeFileSync('log.txt', this.log.join('\\n'));
|
||
}
|
||
}
|
||
module.exports = EchoReporter;
|
||
`,
|
||
'playwright.config.js': `
|
||
module.exports = {
|
||
reporter: [['blob']]
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('a test', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
console.log('stdout text');
|
||
console.error('stderr text');
|
||
});
|
||
`,
|
||
};
|
||
|
||
await runInlineTest(files);
|
||
|
||
const { exitCode } = await mergeReports(reportDir, {}, { additionalArgs: ['--reporter', test.info().outputPath('echo-reporter.js')] });
|
||
expect(exitCode).toBe(0);
|
||
const log = fs.readFileSync(test.info().outputPath('log.txt')).toString();
|
||
expect(log).toBe(`onStdOut: stdout text
|
||
|
||
result.stdout: stdout text
|
||
|
||
onStdErr: stderr text
|
||
|
||
result.stderr: stderr text
|
||
|
||
onTestEnd
|
||
result.stdout: stdout text
|
||
|
||
result.stderr: stderr text
|
||
`);
|
||
});
|
||
|
||
test('encode inline attachments', async ({ runInlineTest, mergeReports }) => {
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const files = {
|
||
'echo-reporter.js': `
|
||
import fs from 'fs';
|
||
|
||
class EchoReporter {
|
||
onTestEnd(test, result) {
|
||
const attachmentBodies = result.attachments.map(a => a.body?.toString('base64'));
|
||
result.attachments.forEach(a => console.log(a.body, 'isBuffer', Buffer.isBuffer(a.body)));
|
||
fs.writeFileSync('log.txt', attachmentBodies.join(','));
|
||
}
|
||
}
|
||
module.exports = EchoReporter;
|
||
`,
|
||
'playwright.config.js': `
|
||
module.exports = {
|
||
reporter: [['blob']]
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('a test', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
test.info().attachments.push({
|
||
name: 'example.txt',
|
||
contentType: 'text/plain',
|
||
body: Buffer.from('foo'),
|
||
});
|
||
|
||
test.info().attachments.push({
|
||
name: 'example.json',
|
||
contentType: 'application/json',
|
||
body: Buffer.from(JSON.stringify({ foo: 1 })),
|
||
});
|
||
|
||
test.info().attachments.push({
|
||
name: 'example-utf16.txt',
|
||
contentType: 'text/plain, charset=utf16le',
|
||
body: Buffer.from('utf16 encoded', 'utf16le'),
|
||
});
|
||
});
|
||
`,
|
||
};
|
||
|
||
await runInlineTest(files);
|
||
|
||
const { exitCode } = await mergeReports(reportDir, {}, { additionalArgs: ['--reporter', test.info().outputPath('echo-reporter.js')] });
|
||
expect(exitCode).toBe(0);
|
||
const log = fs.readFileSync(test.info().outputPath('log.txt')).toString();
|
||
expect(log).toBe(`Zm9v,eyJmb28iOjF9,dQB0AGYAMQA2ACAAZQBuAGMAbwBkAGUAZAA=`);
|
||
});
|
||
|
||
test('preserve steps in html report', async ({ runInlineTest, mergeReports, showReport, page }) => {
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
reporter: [['blob']]
|
||
};
|
||
`,
|
||
'tests/a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test.beforeAll(() => {
|
||
expect(1).toBe(1);
|
||
})
|
||
test('test 1', async ({}) => {
|
||
await test.step('my step', async () => {
|
||
expect(2).toBe(2);
|
||
});
|
||
});
|
||
`,
|
||
};
|
||
await runInlineTest(files);
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
reportFiles.sort();
|
||
expect(reportFiles).toEqual(['report.zip']);
|
||
// Run merger in a different directory to make sure relative paths will not be resolved
|
||
// relative to the current directory.
|
||
const mergeCwd = test.info().outputPath('foo');
|
||
await fs.promises.mkdir(mergeCwd, { recursive: true });
|
||
const { exitCode, output } = await mergeReports(reportDir, { 'PLAYWRIGHT_HTML_OPEN': 'never' }, { additionalArgs: ['--reporter', 'html'], cwd: mergeCwd });
|
||
expect(exitCode).toBe(0);
|
||
|
||
expect(output).not.toContain('To open last HTML report run:');
|
||
|
||
await showReport();
|
||
|
||
await expect(page.locator('.subnav-item:has-text("All") .counter')).toHaveText('1');
|
||
await expect(page.locator('.subnav-item:has-text("Passed") .counter')).toHaveText('1');
|
||
|
||
await page.getByRole('link', { name: 'test 1' }).click();
|
||
|
||
await page.getByText('Before Hooks').click();
|
||
await page.getByText('beforeAll hook').click();
|
||
await expect(page.getByText('expect.toBe')).toBeVisible();
|
||
// Collapse hooks.
|
||
await page.getByText('Before Hooks').click();
|
||
await expect(page.getByText('expect.toBe')).not.toBeVisible();
|
||
|
||
// Check that 'my step' location is relative.
|
||
await expect(page.getByText('— tests/a.test.js:7')).toBeVisible();
|
||
await page.getByText('my step').click();
|
||
await expect(page.getByText('expect.toBe')).toBeVisible();
|
||
});
|
||
|
||
test('support fileName option', async ({ runInlineTest, mergeReports }) => {
|
||
const files = (fileSuffix: string) => ({
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
reporter: [['blob', { fileName: 'report-${fileSuffix}.zip' }]],
|
||
projects: [
|
||
{ name: 'foo' },
|
||
]
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 1 @smoke', async ({}) => {});
|
||
`,
|
||
});
|
||
|
||
await runInlineTest(files('one'));
|
||
await runInlineTest(files('two'), undefined, { PWTEST_BLOB_DO_NOT_REMOVE: '1' });
|
||
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
expect(reportFiles.sort()).toEqual(['report-one.zip', 'report-two.zip']);
|
||
});
|
||
|
||
test('support PLAYWRIGHT_BLOB_OUTPUT_DIR env variable', async ({ runInlineTest, mergeReports }) => {
|
||
test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/30091' });
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
reporter: [['blob']],
|
||
projects: [
|
||
{ name: 'foo' },
|
||
]
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 1 @smoke', async ({}) => {});
|
||
`,
|
||
};
|
||
|
||
await runInlineTest(files, undefined, { PLAYWRIGHT_BLOB_OUTPUT_DIR: 'my/dir' });
|
||
|
||
const reportDir = test.info().outputPath('my', 'dir');
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
expect(reportFiles.sort()).toEqual(['report.zip']);
|
||
});
|
||
|
||
test('support PLAYWRIGHT_BLOB_OUTPUT_NAME env variable', async ({ runInlineTest, mergeReports }) => {
|
||
test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/30091' });
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
reporter: [['blob']],
|
||
projects: [
|
||
{ name: 'foo' },
|
||
]
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 1 @smoke', async ({}) => {});
|
||
`,
|
||
};
|
||
|
||
await runInlineTest(files, undefined, { PLAYWRIGHT_BLOB_OUTPUT_NAME: 'report-one.zip' });
|
||
await runInlineTest(files, undefined, { PLAYWRIGHT_BLOB_OUTPUT_NAME: 'report-two.zip', PWTEST_BLOB_DO_NOT_REMOVE: '1' });
|
||
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
expect(reportFiles.sort()).toEqual(['report-one.zip', 'report-two.zip']);
|
||
});
|
||
|
||
test('support outputFile option', async ({ runInlineTest, mergeReports }) => {
|
||
test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/30091' });
|
||
const files = (fileSuffix: string) => ({
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
reporter: [['blob', { outputDir: 'should-be-ignored', outputFile: 'my-reports/report-${fileSuffix}.zip' }]],
|
||
projects: [
|
||
{ name: 'foo' },
|
||
]
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 1 @smoke', async ({}) => {});
|
||
`,
|
||
});
|
||
|
||
await runInlineTest(files('one'));
|
||
await runInlineTest(files('two'));
|
||
|
||
const reportDir = test.info().outputPath('my-reports');
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
expect(reportFiles.sort()).toEqual(['report-one.zip', 'report-two.zip']);
|
||
});
|
||
|
||
test('support PLAYWRIGHT_BLOB_OUTPUT_FILE environment variable', async ({ runInlineTest, mergeReports }) => {
|
||
test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/30091' });
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
reporter: 'blob',
|
||
projects: [
|
||
{ name: 'foo' },
|
||
]
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 1 @smoke', async ({}) => {});
|
||
`,
|
||
'b.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 1 @smoke', async ({}) => {});
|
||
`,
|
||
};
|
||
const defaultDir = test.info().outputPath('blob-report');
|
||
fs.mkdirSync(defaultDir, { recursive: true });
|
||
const file = path.join(defaultDir, 'some.file');
|
||
fs.writeFileSync(file, 'content');
|
||
|
||
await runInlineTest(files, { shard: `1/2` }, { PLAYWRIGHT_BLOB_OUTPUT_FILE: 'subdir/report-one.zip' });
|
||
await runInlineTest(files, { shard: `2/2` }, { PLAYWRIGHT_BLOB_OUTPUT_FILE: test.info().outputPath('subdir/report-two.zip') });
|
||
const reportDir = test.info().outputPath('subdir');
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
expect(reportFiles.sort()).toEqual(['report-one.zip', 'report-two.zip']);
|
||
|
||
expect(fs.existsSync(file), 'Default directory should not be cleaned up if output file is specified.').toBe(true);
|
||
});
|
||
|
||
test('keep projects with same name different bot name separate', async ({ runInlineTest, mergeReports, showReport, page }) => {
|
||
const files = (reportName: string) => ({
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
reporter: [['blob', { fileName: '${reportName}.zip' }]],
|
||
projects: [
|
||
{ name: 'foo' },
|
||
]
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('test 1', async ({}) => { expect('${reportName}').toBe('second'); });
|
||
`,
|
||
});
|
||
|
||
await runInlineTest(files('first'), undefined, { PWTEST_BOT_NAME: 'first' });
|
||
await runInlineTest(files('second'), undefined, { PWTEST_BOT_NAME: 'second', PWTEST_BLOB_DO_NOT_REMOVE: '1' });
|
||
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const { exitCode } = await mergeReports(reportDir, { 'PLAYWRIGHT_HTML_OPEN': 'never' }, { additionalArgs: ['--reporter', 'html'] });
|
||
expect(exitCode).toBe(0);
|
||
await showReport();
|
||
await expect(page.locator('.subnav-item:has-text("Passed") .counter')).toHaveText('1');
|
||
await expect(page.locator('.subnav-item:has-text("Failed") .counter')).toHaveText('1');
|
||
|
||
await page.getByText(/test 1.*first/).getByRole('link', { name: 'test' }).click();
|
||
await expect(page.getByText('Errors')).toBeVisible();
|
||
await page.goBack();
|
||
await page.getByText(/test 1.*second/).getByRole('link', { name: 'test' }).click();
|
||
await expect(page.getByText('Errors')).not.toBeVisible();
|
||
});
|
||
|
||
test('no reports error', async ({ runInlineTest, mergeReports }) => {
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
fs.mkdirSync(reportDir, { recursive: true });
|
||
const { exitCode, output } = await mergeReports(reportDir);
|
||
expect(exitCode).toBe(1);
|
||
expect(output).toContain(`No report files found in`);
|
||
});
|
||
|
||
test('blob-report should be next to package.json', async ({ runInlineTest }, testInfo) => {
|
||
const result = await runInlineTest({
|
||
'foo/package.json': `{ "name": "foo" }`,
|
||
// unused config along "search path"
|
||
'foo/bar/playwright.config.js': `
|
||
module.exports = { projects: [ {} ] };
|
||
`,
|
||
'foo/bar/baz/tests/a.spec.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
const fs = require('fs');
|
||
test('pass', ({}, testInfo) => {
|
||
});
|
||
`,
|
||
}, { reporter: 'blob' }, {}, { cwd: 'foo/bar/baz/tests' });
|
||
expect(result.exitCode).toBe(0);
|
||
expect(result.passed).toBe(1);
|
||
expect(fs.existsSync(testInfo.outputPath('blob-report'))).toBe(false);
|
||
expect(fs.existsSync(testInfo.outputPath('foo', 'blob-report'))).toBe(true);
|
||
expect(fs.existsSync(testInfo.outputPath('foo', 'bar', 'blob-report'))).toBe(false);
|
||
expect(fs.existsSync(testInfo.outputPath('foo', 'bar', 'baz', 'tests', 'blob-report'))).toBe(false);
|
||
});
|
||
|
||
test('blob report should include version', async ({ runInlineTest }) => {
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
reporter: [['blob']]
|
||
};
|
||
`,
|
||
'tests/a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('test 1', async ({}) => {});
|
||
`,
|
||
};
|
||
// CI/1 is a part of user agent string, make sure it matches in the nested test runner.
|
||
await runInlineTest(files, undefined, { CI: process.env.CI });
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
expect(reportFiles).toEqual(['report.zip']);
|
||
|
||
const events = await extractReport(test.info().outputPath('blob-report', 'report.zip'), test.info().outputPath('tmp'));
|
||
const metadataEvent = events.find(e => e.method === 'onBlobReportMetadata');
|
||
expect(metadataEvent.params.version).toBe(2);
|
||
expect(metadataEvent.params.userAgent).toBe(getUserAgent());
|
||
});
|
||
|
||
async function extractReport(reportZipFile: string, unzippedReportDir: string): Promise<any[]> {
|
||
await extractZip(reportZipFile, { dir: unzippedReportDir });
|
||
const reportFile = path.join(unzippedReportDir, 'report.jsonl');
|
||
const data = await fs.promises.readFile(reportFile, 'utf8');
|
||
const events = data.split('\n').filter(Boolean).map(line => JSON.parse(line));
|
||
return events;
|
||
}
|
||
|
||
async function zipReport(events: any[], zipFilePath: string) {
|
||
const lines = events.map(e => JSON.stringify(e) + '\n');
|
||
const zipFile = new yazl.ZipFile();
|
||
const zipFinishPromise = new Promise((resolve, reject) => {
|
||
(zipFile as any).on('error', error => reject(error));
|
||
zipFile.outputStream.pipe(fs.createWriteStream(zipFilePath)).on('close', () => {
|
||
resolve(undefined);
|
||
}).on('error', error => reject(error));
|
||
});
|
||
const content = Readable.from(lines);
|
||
zipFile.addReadStream(content, 'report.jsonl');
|
||
zipFile.end();
|
||
await zipFinishPromise;
|
||
}
|
||
|
||
|
||
test('merge-reports should throw if report version is from the future', async ({ runInlineTest, mergeReports }) => {
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
reporter: [['blob']]
|
||
};
|
||
`,
|
||
'tests/a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('test 1', async ({}) => {});
|
||
`,
|
||
'tests/b.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('test 1', async ({}) => {});
|
||
`,
|
||
};
|
||
await runInlineTest(files, { shard: `1/2` });
|
||
await runInlineTest(files, { shard: `2/2` }, { PWTEST_BLOB_DO_NOT_REMOVE: '1' });
|
||
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
expect(reportFiles).toEqual(['report-1.zip', 'report-2.zip']);
|
||
|
||
// Extract report and modify version.
|
||
const reportZipFile = test.info().outputPath('blob-report', reportFiles[1]);
|
||
const events = await extractReport(reportZipFile, test.info().outputPath('tmp'));
|
||
|
||
const metadataEvent = events.find(e => e.method === 'onBlobReportMetadata');
|
||
expect(metadataEvent.params.version).toBeTruthy();
|
||
++metadataEvent.params.version;
|
||
|
||
// Zip it back.
|
||
await fs.promises.rm(reportZipFile, { force: true });
|
||
await zipReport(events, reportZipFile);
|
||
|
||
const { exitCode, output } = await mergeReports(reportDir, { 'PLAYWRIGHT_HTML_OPEN': 'never' }, { additionalArgs: ['--reporter', 'html'] });
|
||
expect(exitCode).toBe(1);
|
||
expect(output).toContain(`Error: Blob report report-2.zip was created with a newer version of Playwright.`);
|
||
|
||
});
|
||
|
||
test('should merge blob reports with same name', async ({ runInlineTest, mergeReports, showReport, page }) => {
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
retries: 1,
|
||
reporter: 'blob'
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 1', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
test('failing 1', async ({}) => {
|
||
expect(1).toBe(2);
|
||
});
|
||
test('flaky 1', async ({}) => {
|
||
expect(test.info().retry).toBe(1);
|
||
});
|
||
test.skip('skipped 1', async ({}) => {});
|
||
`,
|
||
'b.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 2', async ({}) => {
|
||
expect(1 + 1).toBe(2);
|
||
});
|
||
test('failing 2', async ({}) => {
|
||
expect(1).toBe(2);
|
||
});
|
||
test.skip('skipped 2', async ({}) => {});
|
||
`
|
||
};
|
||
await runInlineTest(files);
|
||
const reportZip = test.info().outputPath('blob-report', 'report.zip');
|
||
const allReportsDir = test.info().outputPath('all-blob-reports');
|
||
await fs.promises.cp(reportZip, path.join(allReportsDir, 'report-1.zip'));
|
||
await fs.promises.cp(reportZip, path.join(allReportsDir, 'report-2.zip'));
|
||
|
||
const { exitCode } = await mergeReports(allReportsDir, { 'PLAYWRIGHT_HTML_OPEN': 'never' }, { additionalArgs: ['--reporter', 'html'] });
|
||
expect(exitCode).toBe(0);
|
||
await showReport();
|
||
await expect(page.locator('.subnav-item:has-text("All") .counter')).toHaveText('10');
|
||
await expect(page.locator('.subnav-item:has-text("Passed") .counter')).toHaveText('4');
|
||
await expect(page.locator('.subnav-item:has-text("Failed") .counter')).toHaveText('4');
|
||
await expect(page.locator('.subnav-item:has-text("Flaky") .counter')).toHaveText('2');
|
||
await expect(page.locator('.subnav-item:has-text("Skipped") .counter')).toHaveText('4');
|
||
});
|
||
|
||
function readAllFromStreamAsString(stream: NodeJS.ReadableStream): Promise<string> {
|
||
return new Promise(resolve => {
|
||
const chunks: Buffer[] = [];
|
||
stream.on('data', chunk => chunks.push(chunk));
|
||
stream.on('end', () => resolve(Buffer.concat(chunks).toString('utf8')));
|
||
});
|
||
}
|
||
|
||
test('reporter list in the custom config', async ({ runInlineTest, mergeReports }) => {
|
||
test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/27281' });
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = { reporter: 'blob' };
|
||
`,
|
||
'a.test.ts': `
|
||
import { test, expect } from '@playwright/test';
|
||
|
||
test('first', async ({}) => {
|
||
});
|
||
`,
|
||
'merged/testReporter.js': `
|
||
class TestReporter {
|
||
onBegin(fullConfig, suite) {
|
||
console.log('reporter', fullConfig.reporter);
|
||
}
|
||
}
|
||
|
||
module.exports = TestReporter;
|
||
`,
|
||
'merged/playwright.config.ts': `
|
||
module.exports = {
|
||
retries: 1,
|
||
reporter: [['./testReporter.js', { myOpt: 1 }]]
|
||
};
|
||
`,
|
||
};
|
||
await runInlineTest(files);
|
||
|
||
const { exitCode, output } = await mergeReports(reportDir, undefined, { additionalArgs: ['--config', test.info().outputPath('merged/playwright.config.ts')] });
|
||
expect(exitCode).toBe(0);
|
||
|
||
const text = stripAnsi(output);
|
||
expect(text).toContain('testReporter.js');
|
||
expect(text).toContain('{ myOpt: 1 }');
|
||
});
|
||
|
||
test('merge reports with different rootDirs', async ({ runInlineTest, mergeReports }) => {
|
||
test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/27877' });
|
||
const files1 = {
|
||
'echo-reporter.js': `
|
||
export default class EchoReporter {
|
||
onBegin(config, suite) {
|
||
console.log('rootDir:', config.rootDir);
|
||
}
|
||
onTestBegin(test) {
|
||
console.log('test:', test.location.file);
|
||
}
|
||
};
|
||
`,
|
||
'merge.config.ts': `module.exports = {
|
||
testDir: 'mergeRoot',
|
||
reporter: './echo-reporter.js'
|
||
};`,
|
||
'dir1/playwright.config.ts': `module.exports = {
|
||
testDir: 'tests1',
|
||
reporter: [['blob', { outputDir: 'blob-report' }]]
|
||
};`,
|
||
'dir1/tests1/a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 1', async ({}) => { });
|
||
`,
|
||
};
|
||
await runInlineTest(files1, { workers: 1 }, undefined, { additionalArgs: ['--config', test.info().outputPath('dir1/playwright.config.ts')] });
|
||
|
||
const files2 = {
|
||
'dir2/playwright.config.ts': `module.exports = {
|
||
reporter: [['blob', { outputDir: 'blob-report' }]]
|
||
};`,
|
||
'dir2/tests2/b.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 2', async ({}) => { });
|
||
`,
|
||
};
|
||
await runInlineTest(files2, { workers: 1 }, undefined, { additionalArgs: ['--config', test.info().outputPath('dir2/playwright.config.ts')] });
|
||
|
||
const allReportsDir = test.info().outputPath('all-blob-reports');
|
||
await fs.promises.cp(test.info().outputPath('dir1', 'blob-report', 'report.zip'), path.join(allReportsDir, 'report-1.zip'));
|
||
await fs.promises.cp(test.info().outputPath('dir2', 'blob-report', 'report.zip'), path.join(allReportsDir, 'report-2.zip'));
|
||
|
||
{
|
||
const { exitCode, output } = await mergeReports(allReportsDir);
|
||
expect(exitCode).toBe(1);
|
||
expect(output).toContain(`Blob reports being merged were recorded with different test directories`);
|
||
}
|
||
|
||
{
|
||
const { exitCode, output } = await mergeReports(allReportsDir, undefined, { additionalArgs: ['--config', 'merge.config.ts'] });
|
||
expect(exitCode).toBe(0);
|
||
expect(output).toContain(`rootDir: ${test.info().outputPath('mergeRoot')}`);
|
||
expect(output).toContain(`test: ${test.info().outputPath('mergeRoot', 'a.test.js')}`);
|
||
expect(output).toContain(`test: ${test.info().outputPath('mergeRoot', 'tests2', 'b.test.js')}`);
|
||
}
|
||
});
|
||
|
||
test('merge reports same rootDirs', async ({ runInlineTest, mergeReports }) => {
|
||
test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/27877' });
|
||
const files = {
|
||
'echo-reporter.js': `
|
||
export default class EchoReporter {
|
||
onBegin(config, suite) {
|
||
console.log('rootDir:', config.rootDir);
|
||
}
|
||
onTestBegin(test) {
|
||
console.log('test:', test.location.file);
|
||
}
|
||
};
|
||
`,
|
||
'playwright.config.ts': `module.exports = {
|
||
testDir: 'tests',
|
||
reporter: [['blob', { outputDir: 'blob-report' }]]
|
||
};`,
|
||
'tests/dir1/a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 1', async ({}) => { });
|
||
`,
|
||
'tests/dir2/b.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 2', async ({}) => { });
|
||
`,
|
||
};
|
||
await runInlineTest(files, { shard: `1/2` });
|
||
await runInlineTest(files, { shard: `2/2` }, { PWTEST_BLOB_DO_NOT_REMOVE: '1' });
|
||
|
||
const allReportsDir = test.info().outputPath('blob-report');
|
||
|
||
const { exitCode, output } = await mergeReports(allReportsDir, undefined, { additionalArgs: ['--reporter', './echo-reporter.js'] });
|
||
expect(exitCode).toBe(0);
|
||
expect(output).toContain(`rootDir: ${test.info().outputPath('tests')}`);
|
||
expect(output).toContain(`test: ${test.info().outputPath('tests', 'dir1', 'a.test.js')}`);
|
||
expect(output).toContain(`test: ${test.info().outputPath('tests', 'dir2', 'b.test.js')}`);
|
||
});
|
||
|
||
|
||
function patchPathSeparators(json: any) {
|
||
const from = (path.sep === '/') ? /\//g : /\\/g;
|
||
const to = (path.sep === '/') ? '\\' : '/';
|
||
|
||
function patchPathSeparatorsRecursive(obj: any) {
|
||
if (typeof obj !== 'object')
|
||
return;
|
||
for (const key in obj) {
|
||
if (/file|dir|path|^title$/i.test(key) && typeof obj[key] === 'string')
|
||
obj[key] = obj[key].replace(from, to);
|
||
patchPathSeparatorsRecursive(obj[key]);
|
||
}
|
||
}
|
||
patchPathSeparatorsRecursive(json);
|
||
}
|
||
|
||
test('merge reports with different rootDirs and path separators', async ({ runInlineTest, mergeReports }) => {
|
||
test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/27877' });
|
||
const files1 = {
|
||
'echo-reporter.js': `
|
||
export default class EchoReporter {
|
||
onBegin(config, suite) {
|
||
console.log('rootDir:', config.rootDir);
|
||
}
|
||
onTestBegin(test) {
|
||
console.log('test:', test.location.file);
|
||
console.log('test title:', test.titlePath()[2]);
|
||
}
|
||
};
|
||
`,
|
||
'merge.config.ts': `module.exports = {
|
||
testDir: 'mergeRoot',
|
||
reporter: './echo-reporter.js'
|
||
};`,
|
||
'dir1/playwright.config.ts': `module.exports = {
|
||
reporter: [['blob', { outputDir: 'blob-report' }]]
|
||
};`,
|
||
'dir1/tests1/a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 1', async ({}) => { });
|
||
`,
|
||
};
|
||
await runInlineTest(files1, { workers: 1 }, undefined, { additionalArgs: ['--config', test.info().outputPath('dir1/playwright.config.ts')] });
|
||
|
||
const files2 = {
|
||
'dir2/playwright.config.ts': `module.exports = {
|
||
reporter: [['blob', { outputDir: 'blob-report' }]]
|
||
};`,
|
||
'dir2/tests2/b.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 2', async ({}) => { });
|
||
`,
|
||
};
|
||
await runInlineTest(files2, { workers: 1 }, undefined, { additionalArgs: ['--config', test.info().outputPath('dir2/playwright.config.ts')] });
|
||
|
||
const allReportsDir = test.info().outputPath('all-blob-reports');
|
||
await fs.promises.mkdir(allReportsDir, { recursive: true });
|
||
|
||
// Extract report and change path separators.
|
||
const reportZipFile = test.info().outputPath('dir1', 'blob-report', 'report.zip');
|
||
const events = await extractReport(reportZipFile, test.info().outputPath('tmp'));
|
||
events.forEach(patchPathSeparators);
|
||
|
||
// Zip it back.
|
||
const report1 = path.join(allReportsDir, 'report-1.zip');
|
||
await zipReport(events, report1);
|
||
|
||
// Copy second report as is.
|
||
await fs.promises.cp(test.info().outputPath('dir2', 'blob-report', 'report.zip'), path.join(allReportsDir, 'report-2.zip'));
|
||
|
||
{
|
||
const { exitCode, output } = await mergeReports(allReportsDir, undefined, { additionalArgs: ['--config', 'merge.config.ts'] });
|
||
expect(exitCode).toBe(0);
|
||
expect(output).toContain(`rootDir: ${test.info().outputPath('mergeRoot')}`);
|
||
expect(output).toContain(`test: ${test.info().outputPath('mergeRoot', 'tests1', 'a.test.js')}`);
|
||
expect(output).toContain(`test title: ${'tests1' + path.sep + 'a.test.js'}`);
|
||
expect(output).toContain(`test: ${test.info().outputPath('mergeRoot', 'tests2', 'b.test.js')}`);
|
||
expect(output).toContain(`test title: ${'tests2' + path.sep + 'b.test.js'}`);
|
||
}
|
||
});
|
||
|
||
test('merge reports without --config preserves path separators', async ({ runInlineTest, mergeReports }) => {
|
||
test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/27877' });
|
||
const files1 = {
|
||
'echo-reporter.js': `
|
||
export default class EchoReporter {
|
||
onBegin(config, suite) {
|
||
console.log('rootDir:', config.rootDir);
|
||
}
|
||
onTestBegin(test) {
|
||
console.log('test:', test.location.file);
|
||
console.log('test title:', test.titlePath()[2]);
|
||
}
|
||
};
|
||
`,
|
||
'dir1/playwright.config.ts': `module.exports = {
|
||
reporter: [['blob', { outputDir: 'blob-report' }]]
|
||
};`,
|
||
'dir1/tests1/a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 1', async ({}) => { });
|
||
`,
|
||
'dir1/tests2/b.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 2', async ({}) => { });
|
||
`,
|
||
};
|
||
await runInlineTest(files1, { workers: 1 }, undefined, { additionalArgs: ['--config', test.info().outputPath('dir1/playwright.config.ts')] });
|
||
|
||
const allReportsDir = test.info().outputPath('all-blob-reports');
|
||
await fs.promises.mkdir(allReportsDir, { recursive: true });
|
||
|
||
// Extract report and change path separators.
|
||
const reportZipFile = test.info().outputPath('dir1', 'blob-report', 'report.zip');
|
||
const events = await extractReport(reportZipFile, test.info().outputPath('tmp'));
|
||
events.forEach(patchPathSeparators);
|
||
|
||
// Zip it back.
|
||
const report1 = path.join(allReportsDir, 'report-1.zip');
|
||
await zipReport(events, report1);
|
||
|
||
const { exitCode, output } = await mergeReports(allReportsDir, undefined, { additionalArgs: ['--reporter', './echo-reporter.js'] });
|
||
expect(exitCode).toBe(0);
|
||
const otherSeparator = path.sep === '/' ? '\\' : '/';
|
||
expect(output).toContain(`rootDir: ${test.info().outputPath('dir1').replaceAll(path.sep, otherSeparator)}`);
|
||
expect(output).toContain(`test: ${test.info().outputPath('dir1', 'tests1', 'a.test.js').replaceAll(path.sep, otherSeparator)}`);
|
||
expect(output).toContain(`test title: ${'tests1' + otherSeparator + 'a.test.js'}`);
|
||
expect(output).toContain(`test: ${test.info().outputPath('dir1', 'tests2', 'b.test.js').replaceAll(path.sep, otherSeparator)}`);
|
||
expect(output).toContain(`test title: ${'tests2' + otherSeparator + 'b.test.js'}`);
|
||
});
|
||
|
||
test('merge reports must not change test ids when there is no need to', async ({ runInlineTest, mergeReports }) => {
|
||
const files = {
|
||
'echo-test-id-reporter.js': `
|
||
export default class EchoTestIdReporter {
|
||
onTestBegin(test) {
|
||
console.log('%%' + test.id);
|
||
}
|
||
};
|
||
`,
|
||
'single-run.config.ts': `module.exports = {
|
||
reporter: [
|
||
['./echo-test-id-reporter.js'],
|
||
]
|
||
};`,
|
||
'shard-1.config.ts': `module.exports = {
|
||
fullyParallel: true,
|
||
shard: { total: 2, current: 1 },
|
||
reporter: [
|
||
['./echo-test-id-reporter.js'],
|
||
['blob', { outputDir: 'blob-report' }],
|
||
]
|
||
};`,
|
||
'shard-2.config.ts': `module.exports = {
|
||
fullyParallel: true,
|
||
shard: { total: 2, current: 2 },
|
||
reporter: [
|
||
['./echo-test-id-reporter.js'],
|
||
['blob', { outputDir: 'blob-report' }],
|
||
]
|
||
};`,
|
||
'merge.config.ts': `module.exports = {
|
||
reporter: [
|
||
['./echo-test-id-reporter.js'],
|
||
]
|
||
};`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('test 1', async ({}) => { });
|
||
test('test 2', async ({}) => { });
|
||
test('test 3', async ({}) => { });
|
||
`,
|
||
};
|
||
let testIdsFromSingleRun: string[];
|
||
let testIdsFromShard1: string[];
|
||
let testIdsFromShard2: string[];
|
||
let testIdsFromMergedReport: string[];
|
||
{
|
||
const { exitCode, outputLines } = await runInlineTest(files, { workers: 1 }, undefined, { additionalArgs: ['--config', test.info().outputPath('single-run.config.ts')] });
|
||
expect(exitCode).toBe(0);
|
||
testIdsFromSingleRun = outputLines.sort();
|
||
expect(testIdsFromSingleRun.length).toEqual(3);
|
||
}
|
||
{
|
||
const { exitCode, outputLines } = await runInlineTest(files, { workers: 1 }, {}, { additionalArgs: ['--config', test.info().outputPath('shard-1.config.ts')] });
|
||
expect(exitCode).toBe(0);
|
||
testIdsFromShard1 = outputLines.sort();
|
||
}
|
||
{
|
||
const { exitCode, outputLines } = await runInlineTest(files, { workers: 1 }, { PWTEST_BLOB_DO_NOT_REMOVE: '1' }, { additionalArgs: ['--config', test.info().outputPath('shard-2.config.ts')] });
|
||
expect(exitCode).toBe(0);
|
||
testIdsFromShard2 = outputLines.sort();
|
||
expect([...testIdsFromShard1, ...testIdsFromShard2].sort()).toEqual(testIdsFromSingleRun);
|
||
}
|
||
{
|
||
const { exitCode, outputLines } = await mergeReports(test.info().outputPath('blob-report'), undefined, { additionalArgs: ['--config', test.info().outputPath('merge.config.ts')] });
|
||
expect(exitCode).toBe(0);
|
||
testIdsFromMergedReport = outputLines.sort();
|
||
expect(testIdsFromMergedReport).toEqual(testIdsFromSingleRun);
|
||
}
|
||
});
|
||
|
||
test('TestSuite.project() should return owning project', async ({ runInlineTest, mergeReports }) => {
|
||
test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/29173' });
|
||
const files1 = {
|
||
'echo-reporter.js': `
|
||
export default class EchoReporter {
|
||
onTestBegin(test) {
|
||
console.log('test project:', test.parent?.project()?.name);
|
||
}
|
||
};
|
||
`,
|
||
'merge.config.ts': `module.exports = {
|
||
testDir: 'mergeRoot',
|
||
reporter: './echo-reporter.js'
|
||
};`,
|
||
'playwright.config.ts': `module.exports = {
|
||
testDir: 'tests',
|
||
reporter: [['blob', { outputDir: 'blob-report' }]],
|
||
projects: [{name: 'my-project'}]
|
||
};`,
|
||
'tests/a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 1', async ({}) => { });
|
||
`,
|
||
};
|
||
await runInlineTest(files1);
|
||
|
||
const { exitCode, output } = await mergeReports(test.info().outputPath('blob-report'), undefined, { additionalArgs: ['--config', 'merge.config.ts'] });
|
||
expect(exitCode).toBe(0);
|
||
expect(output).toContain(`test project: my-project`);
|
||
});
|
||
|
||
test('open blob-1.42', async ({ runInlineTest, mergeReports }) => {
|
||
test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/29984' });
|
||
await runInlineTest({
|
||
'echo-reporter.js': `
|
||
export default class EchoReporter {
|
||
lines = [];
|
||
onTestBegin(test) {
|
||
this.lines.push(test.titlePath().join(' > '));
|
||
}
|
||
onEnd() {
|
||
console.log(this.lines.join('\\n'));
|
||
}
|
||
};
|
||
`,
|
||
'merge.config.ts': `module.exports = {
|
||
testDir: 'mergeRoot',
|
||
reporter: './echo-reporter.js'
|
||
};`,
|
||
});
|
||
|
||
const blobDir = test.info().outputPath('blob-report');
|
||
await fs.promises.mkdir(blobDir, { recursive: true });
|
||
await fs.promises.copyFile(path.join(__dirname, '../assets/blob-1.42.zip'), path.join(blobDir, 'blob-1.42.zip'));
|
||
|
||
const { exitCode, output } = await mergeReports(blobDir, undefined, { additionalArgs: ['--config', 'merge.config.ts'] });
|
||
expect(exitCode).toBe(0);
|
||
expect(output).toContain(` > chromium > example.spec.ts > test 0
|
||
> chromium > example.spec.ts > describe 1 > describe 2 > test 3
|
||
> chromium > example.spec.ts > describe 1 > describe 2 > test 4
|
||
> chromium > example.spec.ts > describe 1 > describe 2 > test 2
|
||
> chromium > example.spec.ts > describe 1 > test 1
|
||
> chromium > example.spec.ts > describe 1 > test 5
|
||
> chromium > example.spec.ts > test 6
|
||
> firefox > example.spec.ts > describe 1 > describe 2 > test 2
|
||
> firefox > example.spec.ts > describe 1 > describe 2 > test 3
|
||
> firefox > example.spec.ts > test 0
|
||
> firefox > example.spec.ts > describe 1 > describe 2 > test 4
|
||
> firefox > example.spec.ts > describe 1 > test 1
|
||
> firefox > example.spec.ts > test 6
|
||
> firefox > example.spec.ts > describe 1 > test 5
|
||
> webkit > example.spec.ts > describe 1 > describe 2 > test 4
|
||
> webkit > example.spec.ts > test 0
|
||
> webkit > example.spec.ts > describe 1 > test 1
|
||
> webkit > example.spec.ts > describe 1 > describe 2 > test 2
|
||
> webkit > example.spec.ts > describe 1 > describe 2 > test 3
|
||
> webkit > example.spec.ts > test 6
|
||
> webkit > example.spec.ts > describe 1 > test 5`);
|
||
});
|
||
|
||
test('preserve static annotations when tests did not run', async ({ runInlineTest, mergeReports, showReport, page }) => {
|
||
test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/30260' });
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
reporter: 'blob',
|
||
projects: [
|
||
{ name: 'setup', testMatch: 'setup.js' },
|
||
{ name: 'tests', testMatch: /.*test.js/, dependencies: ['setup'] },
|
||
]
|
||
};
|
||
`,
|
||
'setup.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('setup', { annotation: [{ type: "sample", description: "uno" }] }, async ({}) => {
|
||
expect(1).toBe(2);
|
||
});
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('first', { annotation: [{ type: "sample", description: "uno" }] }, async ({}) => {});
|
||
test.skip('second', { annotation: [{ type: "sample", description: "dos" }] }, async ({}) => {});
|
||
`
|
||
};
|
||
await runInlineTest(files);
|
||
const { exitCode } = await mergeReports(reportDir, { 'PLAYWRIGHT_HTML_OPEN': 'never' }, { additionalArgs: ['--reporter', 'html'] });
|
||
expect(exitCode).toBe(0);
|
||
await showReport();
|
||
|
||
// Show skipped tests.
|
||
await page.getByText('Skipped').click();
|
||
|
||
// Check first annotation.
|
||
{
|
||
await page.getByRole('link', { name: 'first' }).click();
|
||
await expect(page.getByText('sample: uno')).toBeVisible();
|
||
await page.goBack();
|
||
}
|
||
// Check second annotation.
|
||
{
|
||
await page.getByRole('link', { name: 'second' }).click();
|
||
await expect(page.getByText('sample: dos')).toBeVisible();
|
||
await page.goBack();
|
||
}
|
||
});
|
||
|
||
test('project filter in report name', async ({ runInlineTest }) => {
|
||
const files = {
|
||
'playwright.config.ts': `
|
||
module.exports = {
|
||
reporter: 'blob',
|
||
projects: [
|
||
{ name: 'foo' },
|
||
{ name: 'b%/\\ar' },
|
||
{ name: 'baz' },
|
||
]
|
||
};
|
||
`,
|
||
'a.test.js': `
|
||
import { test, expect } from '@playwright/test';
|
||
test('math 1 @smoke', async ({}) => {});
|
||
`,
|
||
};
|
||
|
||
const reportDir = test.info().outputPath('blob-report');
|
||
|
||
{
|
||
const result = await runInlineTest(files, { shard: `2/2`, project: 'foo' });
|
||
expect(result.exitCode).toBe(0);
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
expect(reportFiles.sort()).toEqual(['report-foo-2.zip']);
|
||
}
|
||
|
||
{
|
||
const result = await runInlineTest(files, { shard: `1/2`, project: ['foo', 'b*r'], grep: 'smoke' });
|
||
expect(result.exitCode).toBe(0);
|
||
const reportFiles = await fs.promises.readdir(reportDir);
|
||
expect(reportFiles.sort()).toEqual(['report-foo-b-r-6d9d49e-1.zip']);
|
||
}
|
||
}); |