fix(ui): respect --output param (#32351)

Closes https://github.com/microsoft/playwright/issues/32331

We're already passing the `outputDir` param to the UI, but the UI isn't
passing it back to the TestServer. This PR fixes that. I've added it to
`listTests`, which is requires to that
`TestServerDispatcher#_ignoredProjectOutputs` is populated with the
correct output dir. And i've added it to `runGlobalSetup`, which is what
the bug report was about.
This commit is contained in:
Simon Knott 2024-08-30 08:29:49 +02:00 committed by GitHub
parent 90e7b9ebac
commit ed5c21b827
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 30 additions and 13 deletions

View file

@ -44,7 +44,7 @@ export interface TestServerInterface {
installBrowsers(params: {}): Promise<void>; installBrowsers(params: {}): Promise<void>;
runGlobalSetup(params: {}): Promise<{ runGlobalSetup(params: { outputDir?: string }): Promise<{
report: ReportEntry[], report: ReportEntry[],
status: reporterTypes.FullResult['status'] status: reporterTypes.FullResult['status']
}>; }>;
@ -81,6 +81,7 @@ export interface TestServerInterface {
locations?: string[]; locations?: string[];
grep?: string; grep?: string;
grepInvert?: string; grepInvert?: string;
outputDir?: string;
}): Promise<{ }): Promise<{
report: ReportEntry[], report: ReportEntry[],
status: reporterTypes.FullResult['status'] status: reporterTypes.FullResult['status']

View file

@ -148,7 +148,10 @@ class TestServerDispatcher implements TestServerInterface {
async runGlobalSetup(params: Parameters<TestServerInterface['runGlobalSetup']>[0]): ReturnType<TestServerInterface['runGlobalSetup']> { async runGlobalSetup(params: Parameters<TestServerInterface['runGlobalSetup']>[0]): ReturnType<TestServerInterface['runGlobalSetup']> {
await this.runGlobalTeardown(); await this.runGlobalTeardown();
const { config, error } = await this._loadConfig(); const overrides: ConfigCLIOverrides = {
outputDir: params.outputDir,
};
const { config, error } = await this._loadConfig(overrides);
if (!config) { if (!config) {
const { reporter, report } = await this._collectingInternalReporter(); const { reporter, report } = await this._collectingInternalReporter();
// Produce dummy config when it has an error. // Produce dummy config when it has an error.
@ -256,6 +259,7 @@ class TestServerDispatcher implements TestServerInterface {
const overrides: ConfigCLIOverrides = { const overrides: ConfigCLIOverrides = {
repeatEach: 1, repeatEach: 1,
retries: 0, retries: 0,
outputDir: params.outputDir,
}; };
const { config, error } = await this._loadConfig(overrides); const { config, error } = await this._loadConfig(overrides);
if (!config) { if (!config) {

View file

@ -205,12 +205,14 @@ export const UIModeView: React.FC<{}> = ({
interceptStdio: true, interceptStdio: true,
watchTestDirs: true watchTestDirs: true
}); });
const { status, report } = await testServerConnection.runGlobalSetup({}); const { status, report } = await testServerConnection.runGlobalSetup({
outputDir: queryParams.outputDir,
});
teleSuiteUpdater.processGlobalReport(report); teleSuiteUpdater.processGlobalReport(report);
if (status !== 'passed') if (status !== 'passed')
return; return;
const result = await testServerConnection.listTests({ projects: queryParams.projects, locations: queryParams.args, grep: queryParams.grep, grepInvert: queryParams.grepInvert }); const result = await testServerConnection.listTests({ projects: queryParams.projects, locations: queryParams.args, grep: queryParams.grep, grepInvert: queryParams.grepInvert, outputDir: queryParams.outputDir });
teleSuiteUpdater.processListReport(result.report); teleSuiteUpdater.processListReport(result.report);
testServerConnection.onReport(params => { testServerConnection.onReport(params => {
@ -333,7 +335,7 @@ export const UIModeView: React.FC<{}> = ({
commandQueue.current = commandQueue.current.then(async () => { commandQueue.current = commandQueue.current.then(async () => {
setIsLoading(true); setIsLoading(true);
try { try {
const result = await testServerConnection.listTests({ projects: queryParams.projects, locations: queryParams.args, grep: queryParams.grep, grepInvert: queryParams.grepInvert }); const result = await testServerConnection.listTests({ projects: queryParams.projects, locations: queryParams.args, grep: queryParams.grep, grepInvert: queryParams.grepInvert, outputDir: queryParams.outputDir });
teleSuiteUpdater.processListReport(result.report); teleSuiteUpdater.processListReport(result.report);
} catch (e) { } catch (e) {
// eslint-disable-next-line no-console // eslint-disable-next-line no-console

View file

@ -19,7 +19,7 @@ import path from 'path';
test.describe.configure({ mode: 'parallel', retries }); test.describe.configure({ mode: 'parallel', retries });
test('should run global setup and teardown', async ({ runUITest }) => { test('should run global setup and teardown', async ({ runUITest }, testInfo) => {
const { page, testProcess } = await runUITest({ const { page, testProcess } = await runUITest({
'playwright.config.ts': ` 'playwright.config.ts': `
import { defineConfig } from '@playwright/test'; import { defineConfig } from '@playwright/test';
@ -29,26 +29,36 @@ test('should run global setup and teardown', async ({ runUITest }) => {
}); });
`, `,
'globalSetup.ts': ` 'globalSetup.ts': `
export default () => console.log('\\n%%from-global-setup'); import { basename } from "node:path";
export default (config) => {
console.log('\\n%%from-global-setup');
console.log("setupOutputDir: " + basename(config.projects[0].outputDir));
};
`, `,
'globalTeardown.ts': ` 'globalTeardown.ts': `
export default () => console.log('\\n%%from-global-teardown'); export default (config) => {
console.log('\\n%%from-global-teardown');
console.log('%%' + JSON.stringify(config));
};
`, `,
'a.test.js': ` 'a.test.js': `
import { test, expect } from '@playwright/test'; import { test, expect } from '@playwright/test';
test('should work', async ({}) => {}); test('should work', async ({}) => {});
` `
}); }, undefined, { additionalArgs: ['--output=foo'] });
await page.getByTitle('Run all').click(); await page.getByTitle('Run all').click();
await expect(page.getByTestId('status-line')).toHaveText('1/1 passed (100%)'); await expect(page.getByTestId('status-line')).toHaveText('1/1 passed (100%)');
await page.getByTitle('Toggle output').click(); await page.getByTitle('Toggle output').click();
await expect(page.getByTestId('output')).toContainText('from-global-setup'); const output = page.getByTestId('output');
await expect(output).toContainText('from-global-setup');
await expect(output).toContainText('setupOutputDir: foo');
await page.close(); await page.close();
await expect.poll(() => testProcess.outputLines()).toEqual([ await expect.poll(() => testProcess.outputLines()).toContain('from-global-teardown');
'from-global-teardown',
]); const teardownConfig = JSON.parse(testProcess.outputLines()[1]);
expect(teardownConfig.projects[0].outputDir).toEqual(testInfo.outputPath('foo'));
}); });
test('should teardown on sigint', async ({ runUITest, nodeVersion }) => { test('should teardown on sigint', async ({ runUITest, nodeVersion }) => {