test(test runner): calling test.step() from fixture (#8899)

This commit is contained in:
Dmitry Gozman 2021-09-13 17:49:58 -07:00 committed by GitHub
parent 6c41ad3329
commit 440651e05c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 184 additions and 147 deletions

View File

@ -337,41 +337,6 @@ test('should report api step failure', async ({ runInlineTest }) => {
]);
});
test('should report test.step', async ({ runInlineTest }) => {
const result = await runInlineTest({
'reporter.ts': stepsReporterJS,
'playwright.config.ts': `
module.exports = {
reporter: './reporter',
};
`,
'a.test.ts': `
const { test } = pwt;
test('pass', async ({ page }) => {
await test.step('First step', async () => {
expect(1).toBe(2);
});
});
`
}, { reporter: '', workers: 1 });
expect(result.exitCode).toBe(1);
expect(result.output.split('\n').filter(line => line.startsWith('%%')).map(stripEscapedAscii)).toEqual([
`%% begin {\"title\":\"Before Hooks\",\"category\":\"hook\"}`,
`%% begin {\"title\":\"browserContext.newPage\",\"category\":\"pw:api\"}`,
`%% end {\"title\":\"browserContext.newPage\",\"category\":\"pw:api\"}`,
`%% end {\"title\":\"Before Hooks\",\"category\":\"hook\",\"steps\":[{\"title\":\"browserContext.newPage\",\"category\":\"pw:api\"}]}`,
`%% begin {\"title\":\"First step\",\"category\":\"test.step\"}`,
`%% begin {\"title\":\"expect.toBe\",\"category\":\"expect\"}`,
`%% end {\"title\":\"expect.toBe\",\"category\":\"expect\",\"error\":{\"message\":\"expect(received).toBe(expected) // Object.is equality\\n\\nExpected: 2\\nReceived: 1\",\"stack\":\"<stack>\"}}`,
`%% end {\"title\":\"First step\",\"category\":\"test.step\",\"steps\":[{\"title\":\"expect.toBe\",\"category\":\"expect\",\"error\":{\"message\":\"expect(received).toBe(expected) // Object.is equality\\n\\nExpected: 2\\nReceived: 1\",\"stack\":\"<stack>\"}}],\"error\":{\"message\":\"expect(received).toBe(expected) // Object.is equality\\n\\nExpected: 2\\nReceived: 1\",\"stack\":\"<stack>\"}}`,
`%% begin {\"title\":\"After Hooks\",\"category\":\"hook\"}`,
`%% begin {\"title\":\"browserContext.close\",\"category\":\"pw:api\"}`,
`%% end {\"title\":\"browserContext.close\",\"category\":\"pw:api\"}`,
`%% end {\"title\":\"After Hooks\",\"category\":\"hook\",\"steps\":[{\"title\":\"browserContext.close\",\"category\":\"pw:api\"}]}`,
]);
});
test('should not have internal error when steps are finished after timeout', async ({ runInlineTest }) => {
const result = await runInlineTest({
'a.test.ts': `
@ -394,118 +359,6 @@ test('should not have internal error when steps are finished after timeout', asy
expect(result.output).not.toContain('Internal error');
});
test('should report api step hierarchy', async ({ runInlineTest }) => {
const expectReporterJS = `
class Reporter {
onBegin(config: FullConfig, suite: Suite) {
this.suite = suite;
}
distillStep(step) {
return {
...step,
startTime: undefined,
duration: undefined,
parent: undefined,
data: undefined,
steps: step.steps.length ? step.steps.map(s => this.distillStep(s)) : undefined,
};
}
async onEnd() {
const processSuite = (suite: Suite) => {
for (const child of suite.suites)
processSuite(child);
for (const test of suite.tests) {
for (const result of test.results) {
for (const step of result.steps) {
console.log('%% ' + JSON.stringify(this.distillStep(step)));
}
}
}
};
processSuite(this.suite);
}
}
module.exports = Reporter;
`;
const result = await runInlineTest({
'reporter.ts': expectReporterJS,
'playwright.config.ts': `
module.exports = {
reporter: './reporter',
};
`,
'a.test.ts': `
const { test } = pwt;
test('pass', async ({ page }) => {
await test.step('outer step 1', async () => {
await test.step('inner step 1.1', async () => {});
await test.step('inner step 1.2', async () => {});
});
await test.step('outer step 2', async () => {
await test.step('inner step 2.1', async () => {});
await test.step('inner step 2.2', async () => {});
});
});
`
}, { reporter: '', workers: 1 });
expect(result.exitCode).toBe(0);
const objects = result.output.split('\n').filter(line => line.startsWith('%% ')).map(line => line.substring(3).trim()).filter(Boolean).map(line => JSON.parse(line));
expect(objects).toEqual([
{
category: 'hook',
title: 'Before Hooks',
steps: [
{
category: 'pw:api',
title: 'browserContext.newPage',
},
],
},
{
category: 'test.step',
title: 'outer step 1',
steps: [
{
category: 'test.step',
title: 'inner step 1.1',
},
{
category: 'test.step',
title: 'inner step 1.2',
},
],
},
{
category: 'test.step',
title: 'outer step 2',
steps: [
{
category: 'test.step',
title: 'inner step 2.1',
},
{
category: 'test.step',
title: 'inner step 2.2',
},
],
},
{
category: 'hook',
title: 'After Hooks',
steps: [
{
category: 'pw:api',
title: 'browserContext.close',
},
],
},
]);
});
test('should report expect and pw:api stacks and logs', async ({ runInlineTest }, testInfo) => {
const expectReporterJS = `
class Reporter {

View File

@ -0,0 +1,184 @@
/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { test, expect } from './playwright-test-fixtures';
test('should report api step hierarchy', async ({ runInlineTest }) => {
const expectReporterJS = `
class Reporter {
onBegin(config: FullConfig, suite: Suite) {
this.suite = suite;
}
distillStep(step) {
return {
...step,
startTime: undefined,
duration: undefined,
parent: undefined,
data: undefined,
steps: step.steps.length ? step.steps.map(s => this.distillStep(s)) : undefined,
};
}
async onEnd() {
const processSuite = (suite: Suite) => {
for (const child of suite.suites)
processSuite(child);
for (const test of suite.tests) {
for (const result of test.results) {
for (const step of result.steps) {
console.log('%% ' + JSON.stringify(this.distillStep(step)));
}
}
}
};
processSuite(this.suite);
}
}
module.exports = Reporter;
`;
const result = await runInlineTest({
'reporter.ts': expectReporterJS,
'playwright.config.ts': `
module.exports = {
reporter: './reporter',
};
`,
'a.test.ts': `
const { test } = pwt;
test('pass', async ({ page }) => {
await test.step('outer step 1', async () => {
await test.step('inner step 1.1', async () => {});
await test.step('inner step 1.2', async () => {});
});
await test.step('outer step 2', async () => {
await test.step('inner step 2.1', async () => {});
await test.step('inner step 2.2', async () => {});
});
});
`
}, { reporter: '', workers: 1 });
expect(result.exitCode).toBe(0);
const objects = result.output.split('\n').filter(line => line.startsWith('%% ')).map(line => line.substring(3).trim()).filter(Boolean).map(line => JSON.parse(line));
expect(objects).toEqual([
{
category: 'hook',
title: 'Before Hooks',
steps: [
{
category: 'pw:api',
title: 'browserContext.newPage',
},
],
},
{
category: 'test.step',
title: 'outer step 1',
steps: [
{
category: 'test.step',
title: 'inner step 1.1',
},
{
category: 'test.step',
title: 'inner step 1.2',
},
],
},
{
category: 'test.step',
title: 'outer step 2',
steps: [
{
category: 'test.step',
title: 'inner step 2.1',
},
{
category: 'test.step',
title: 'inner step 2.2',
},
],
},
{
category: 'hook',
title: 'After Hooks',
steps: [
{
category: 'pw:api',
title: 'browserContext.close',
},
],
},
]);
});
test('should report test.step from fixtures', async ({ runInlineTest }) => {
const expectReporterJS = `
class Reporter {
onStepBegin(test, result, step) {
console.log('%% begin ' + step.title);
}
onStepEnd(test, result, step) {
console.log('%% end ' + step.title);
}
}
module.exports = Reporter;
`;
const result = await runInlineTest({
'reporter.ts': expectReporterJS,
'playwright.config.ts': `
module.exports = {
reporter: './reporter',
};
`,
'a.test.ts': `
const test = pwt.test.extend({
foo: async ({}, use) => {
await pwt.test.step('setup foo', () => {});
await use(async () => {
await test.step('inside foo', () => {});
});
await test.step('teardown foo', () => {});
},
});
test('pass', async ({ foo }) => {
await test.step('test step', async () => {
await foo();
});
});
`
}, { reporter: '', workers: 1 });
expect(result.exitCode).toBe(0);
expect(result.output.split('\n').filter(line => line.startsWith('%%'))).toEqual([
`%% begin Before Hooks`,
`%% begin setup foo`,
`%% end setup foo`,
`%% end Before Hooks`,
`%% begin test step`,
`%% begin inside foo`,
`%% end inside foo`,
`%% end test step`,
`%% begin After Hooks`,
`%% begin teardown foo`,
`%% end teardown foo`,
`%% end After Hooks`,
]);
});