playwright/tests/playwright-test/reporter.spec.ts

/**
 * 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, stripAnsi } from './playwright-test-fixtures';
import fs from 'fs';

const smallReporterJS = `
class Reporter {
  onBegin(config, suite) {
    console.log('\\n%%begin');
  }
  onTestBegin(test) {}
  onStdOut() {}
  onStdErr() {}
  onTestEnd(test, result) {}
  onTimeout() {}
  onError(error) {
    console.log('\\n%%got error: ' + error.message);
  }
  onEnd() {
    console.log('\\n%%end');
  }
  onExit() {
    console.log('\\n%%exit');
  }
}
module.exports = Reporter;
`;

const stepsReporterJS = `
class Reporter {
  onStdOut(chunk) {
    process.stdout.write(chunk);
  }
  distillStep(step) {
    return {
      ...step,
      _startTime: undefined,
      startTime: undefined,
      duration: undefined,
      parent: undefined,
      data: undefined,
      location: undefined,
      steps: step.steps.length ? step.steps.map(s => this.distillStep(s)) : undefined,
    };
  }
  onStepBegin(test, result, step) {
    console.log('%%%% begin', JSON.stringify(this.distillStep(step)));
  }
  onStepEnd(test, result, step) {
    if (step.error?.stack)
      step.error.stack = '<stack>';
    if (step.error?.location)
      step.error.location = '<location>';
    if (step.error?.snippet)
      step.error.snippet = '<snippet>';
    if (step.error?.message.includes('getaddrinfo'))
      step.error.message = '<message>';
    console.log('%%%% end', JSON.stringify(this.distillStep(step)));
  }
}
module.exports = Reporter;
`;

for (const useIntermediateMergeReport of [false, true] as const) {
  test.describe(`${useIntermediateMergeReport ? 'merged' : 'created'}`, () => {
    test.use({ useIntermediateMergeReport });

    test('should work with custom reporter', async ({ runInlineTest }) => {
      const result = await runInlineTest({
        'reporter.ts': `
          class Reporter {
            constructor(options) {
              this.options = options;
            }
            onBegin(config, suite) {
              console.log('\\n%%reporter-begin-' + this.options.begin + '%%');
              console.log('\\n%%version-' + config.version);
            }
            onTestBegin(test) {
              const projectName = test.titlePath()[1];
              console.log('\\n%%reporter-testbegin-' + test.title + '-' + projectName + '%%');
              const suite = test.parent;
              if (!suite.tests.includes(test))
                console.log('\\n%%error-inconsistent-parent');
              if (test.parent.project().name !== projectName)
                console.log('\\n%%error-inconsistent-project-name');
            }
            onStdOut() {
              console.log('\\n%%reporter-stdout%%');
            }
            onStdErr() {
              console.log('\\n%%reporter-stderr%%');
            }
            onTestEnd(test, result) {
              console.log('\\n%%reporter-testend-' + test.title + '-' + test.titlePath()[1] + '%%');
              if (!result.startTime)
                console.log('\\n%%error-no-start-time');
            }
            onTimeout() {
              console.log('\\n%%reporter-timeout%%');
            }
            onError() {
              console.log('\\n%%reporter-error%%');
            }
            async onEnd() {
              await new Promise(f => setTimeout(f, 500));
              console.log('\\n%%reporter-end-' + this.options.end + '%%');
            }
          }
          export default Reporter;
        `,
        'playwright.config.ts': `
          module.exports = {
            reporter: [
              [ './reporter.ts', { begin: 'begin', end: 'end' } ]
            ],
            projects: [
              { name: 'foo', repeatEach: 2 },
              { name: 'bar' },
            ],
          };
        `,
        'a.test.ts': `
          import { test, expect } from '@playwright/test';
          test('not run', async ({}) => {
            console.log('log');
            console.error('error');
          });
          test.only('is run', async ({}) => {
            console.log('log');
            console.error('error');
          });
        `
      }, { reporter: '', workers: 1 });

      expect(result.exitCode).toBe(0);
      expect(result.outputLines).toEqual([
        'reporter-begin-begin%%',
        'version-' + require('../../packages/playwright/package.json').version,
        'reporter-testbegin-is run-foo%%',
        'reporter-stdout%%',
        'reporter-stderr%%',
        'reporter-testend-is run-foo%%',
        'reporter-testbegin-is run-foo%%',
        'reporter-stdout%%',
        'reporter-stderr%%',
        'reporter-testend-is run-foo%%',
        'reporter-testbegin-is run-bar%%',
        'reporter-stdout%%',
        'reporter-stderr%%',
        'reporter-testend-is run-bar%%',
        'reporter-end-end%%',
      ]);
    });

    test('should work without a file extension', async ({ runInlineTest }) => {
      const result = await runInlineTest({
        'reporter.ts': smallReporterJS,
        'playwright.config.ts': `
          module.exports = {
            reporter: './reporter',
          };
        `,
        'a.test.ts': `
          import { test, expect } from '@playwright/test';
          test('pass', async ({}) => {
          });
        `
      }, { reporter: '', workers: 1 });

      expect(result.exitCode).toBe(0);
      expect(result.outputLines).toEqual([
        'begin',
        'end',
        'exit',
      ]);
    });

    test('should report onEnd after global teardown', async ({ runInlineTest }) => {
      test.skip(useIntermediateMergeReport);
      const result = await runInlineTest({
        'reporter.ts': smallReporterJS,
        'globalSetup.ts': `
          module.exports = () => {
            return () => console.log('\\n%%global teardown');
          };
        `,
        'playwright.config.ts': `
          module.exports = {
            reporter: './reporter',
            globalSetup: './globalSetup',
          };
        `,
        'a.test.ts': `
          import { test, expect } from '@playwright/test';
          test('pass', async ({}) => {
          });
        `
      }, { reporter: '', workers: 1 });

      expect(result.exitCode).toBe(0);
      expect(result.outputLines).toEqual([
        'begin',
        'global teardown',
        'end',
        'exit',
      ]);
    });

    test('should load reporter from node_modules', async ({ runInlineTest }) => {
      const result = await runInlineTest({
        'node_modules/my-reporter/index.js': smallReporterJS,
        'playwright.config.ts': `
          module.exports = {
            reporter: 'my-reporter',
          };
        `,
        'a.test.ts': `
          import { test, expect } from '@playwright/test';
          test('pass', async ({}) => {
          });
        `
      }, { reporter: '', workers: 1 });

      expect(result.exitCode).toBe(0);
      expect(result.outputLines).toEqual([
        'begin',
        'end',
        'exit',
      ]);
    });

    test('should report expect steps', async ({ runInlineTest }) => {
      const result = await runInlineTest({
        'reporter.ts': stepsReporterJS,
        'playwright.config.ts': `
          module.exports = {
            reporter: './reporter',
          };
        `,
        'a.test.ts': `
          import { test, expect } from '@playwright/test';
          test('fail', async ({}) => {
            expect(true).toBeTruthy();
            expect(false).toBeTruthy();
          });
          test('pass', async ({}) => {
            expect(false).not.toBeTruthy();
          });
          test('async', async ({ page }) => {
            await expect(page).not.toHaveTitle('False');
          });
        `
      }, { reporter: '', workers: 1 });

      expect(result.exitCode).toBe(1);
      expect(result.outputLines).toEqual([
        `begin {\"title\":\"Before Hooks\",\"category\":\"hook\"}`,
        `end {\"title\":\"Before Hooks\",\"category\":\"hook\"}`,
        `begin {\"title\":\"expect.toBeTruthy\",\"category\":\"expect\"}`,
        `end {\"title\":\"expect.toBeTruthy\",\"category\":\"expect\"}`,
        `begin {\"title\":\"expect.toBeTruthy\",\"category\":\"expect\"}`,
        `end {\"title\":\"expect.toBeTruthy\",\"category\":\"expect\",\"error\":{\"message\":\"Error: \\u001b[2mexpect(\\u001b[22m\\u001b[31mreceived\\u001b[39m\\u001b[2m).\\u001b[22mtoBeTruthy\\u001b[2m()\\u001b[22m\\n\\nReceived: \\u001b[31mfalse\\u001b[39m\",\"stack\":\"<stack>\",\"location\":\"<location>\",\"snippet\":\"<snippet>\"}}`,
        `begin {\"title\":\"After Hooks\",\"category\":\"hook\"}`,
        `end {\"title\":\"After Hooks\",\"category\":\"hook\"}`,
        `begin {\"title\":\"Before Hooks\",\"category\":\"hook\"}`,
        `end {\"title\":\"Before Hooks\",\"category\":\"hook\"}`,
        `begin {\"title\":\"expect.not.toBeTruthy\",\"category\":\"expect\"}`,
        `end {\"title\":\"expect.not.toBeTruthy\",\"category\":\"expect\"}`,
        `begin {\"title\":\"After Hooks\",\"category\":\"hook\"}`,
        `end {\"title\":\"After Hooks\",\"category\":\"hook\"}`,
        `begin {\"title\":\"Before Hooks\",\"category\":\"hook\"}`,
        `begin {\"title\":\"fixture: browser\",\"category\":\"fixture\"}`,
        `begin {\"title\":\"browserType.launch\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"browserType.launch\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"fixture: browser\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browserType.launch\",\"category\":\"pw:api\"}]}`,
        `begin {\"title\":\"fixture: context\",\"category\":\"fixture\"}`,
        `begin {\"title\":\"browser.newContext\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"browser.newContext\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"fixture: context\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browser.newContext\",\"category\":\"pw:api\"}]}`,
        `begin {\"title\":\"fixture: page\",\"category\":\"fixture\"}`,
        `begin {\"title\":\"browserContext.newPage\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"browserContext.newPage\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"fixture: page\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browserContext.newPage\",\"category\":\"pw:api\"}]}`,
        `end {\"title\":\"Before Hooks\",\"category\":\"hook\",\"steps\":[{\"title\":\"fixture: browser\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browserType.launch\",\"category\":\"pw:api\"}]},{\"title\":\"fixture: context\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browser.newContext\",\"category\":\"pw:api\"}]},{\"title\":\"fixture: page\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browserContext.newPage\",\"category\":\"pw:api\"}]}]}`,
        `begin {\"title\":\"expect.not.toHaveTitle\",\"category\":\"expect\"}`,
        `end {\"title\":\"expect.not.toHaveTitle\",\"category\":\"expect\"}`,
        `begin {\"title\":\"After Hooks\",\"category\":\"hook\"}`,
        `begin {\"title\":\"fixture: page\",\"category\":\"fixture\"}`,
        `end {\"title\":\"fixture: page\",\"category\":\"fixture\"}`,
        `begin {\"title\":\"fixture: context\",\"category\":\"fixture\"}`,
        `end {\"title\":\"fixture: context\",\"category\":\"fixture\"}`,
        `end {\"title\":\"After Hooks\",\"category\":\"hook\",\"steps\":[{\"title\":\"fixture: page\",\"category\":\"fixture\"},{\"title\":\"fixture: context\",\"category\":\"fixture\"}]}`,
      ]);
    });

    test('should report api steps', async ({ runInlineTest }) => {
      const result = await runInlineTest({
        'reporter.ts': stepsReporterJS,
        'playwright.config.ts': `
          module.exports = {
            reporter: './reporter',
          };
        `,
        'a.test.ts': `
          import { test, expect } from '@playwright/test';
          test('pass', async ({ page, request }) => {
            await Promise.all([
              page.waitForNavigation(),
              page.goto('data:text/html,<button></button>'),
            ]);
            await page.click('button');
            await page.getByRole('button').click();
            await page.request.get('http://localhost2').catch(() => {});
            await request.get('http://localhost2').catch(() => {});
          });

          test.describe('suite', () => {
            let myPage;
            test.beforeAll(async ({ browser }) => {
              myPage = await browser.newPage();
              await myPage.setContent('<button></button>');
            });

            test('pass1', async () => {
              await myPage.click('button');
            });
            test('pass2', async () => {
              await myPage.click('button');
            });

            test.afterAll(async () => {
              await myPage.close();
            });
          });
        `
      }, { reporter: '', workers: 1 });

      expect(result.exitCode).toBe(0);
      expect(result.outputLines).toEqual([
        `begin {\"title\":\"Before Hooks\",\"category\":\"hook\"}`,
        `begin {\"title\":\"fixture: browser\",\"category\":\"fixture\"}`,
        `begin {\"title\":\"browserType.launch\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"browserType.launch\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"fixture: browser\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browserType.launch\",\"category\":\"pw:api\"}]}`,
        `begin {\"title\":\"fixture: context\",\"category\":\"fixture\"}`,
        `begin {\"title\":\"browser.newContext\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"browser.newContext\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"fixture: context\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browser.newContext\",\"category\":\"pw:api\"}]}`,
        `begin {\"title\":\"fixture: page\",\"category\":\"fixture\"}`,
        `begin {\"title\":\"browserContext.newPage\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"browserContext.newPage\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"fixture: page\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browserContext.newPage\",\"category\":\"pw:api\"}]}`,
        `begin {\"title\":\"fixture: request\",\"category\":\"fixture\"}`,
        `begin {\"title\":\"apiRequest.newContext\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"apiRequest.newContext\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"fixture: request\",\"category\":\"fixture\",\"steps\":[{\"title\":\"apiRequest.newContext\",\"category\":\"pw:api\"}]}`,
        `end {\"title\":\"Before Hooks\",\"category\":\"hook\",\"steps\":[{\"title\":\"fixture: browser\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browserType.launch\",\"category\":\"pw:api\"}]},{\"title\":\"fixture: context\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browser.newContext\",\"category\":\"pw:api\"}]},{\"title\":\"fixture: page\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browserContext.newPage\",\"category\":\"pw:api\"}]},{\"title\":\"fixture: request\",\"category\":\"fixture\",\"steps\":[{\"title\":\"apiRequest.newContext\",\"category\":\"pw:api\"}]}]}`,
        `begin {\"title\":\"page.waitForNavigation\",\"category\":\"pw:api\"}`,
        `begin {\"title\":\"page.goto(data:text/html,<button></button>)\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"page.waitForNavigation\",\"category\":\"pw:api\",\"steps\":[{\"title\":\"page.goto(data:text/html,<button></button>)\",\"category\":\"pw:api\"}]}`,
        `end {\"title\":\"page.goto(data:text/html,<button></button>)\",\"category\":\"pw:api\"}`,
        `begin {\"title\":\"page.click(button)\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"page.click(button)\",\"category\":\"pw:api\"}`,
        `begin {\"title\":\"locator.getByRole('button').click\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"locator.getByRole('button').click\",\"category\":\"pw:api\"}`,
        `begin {"title":"apiRequestContext.get(http://localhost2)","category":"pw:api"}`,
        `end {"title":"apiRequestContext.get(http://localhost2)","category":"pw:api","error":{"message":"<message>","stack":"<stack>","location":"<location>","snippet":"<snippet>"}}`,
        `begin {"title":"apiRequestContext.get(http://localhost2)","category":"pw:api"}`,
        `end {"title":"apiRequestContext.get(http://localhost2)","category":"pw:api","error":{"message":"<message>","stack":"<stack>","location":"<location>","snippet":"<snippet>"}}`,
        `begin {\"title\":\"After Hooks\",\"category\":\"hook\"}`,
        `begin {\"title\":\"fixture: request\",\"category\":\"fixture\"}`,
        `begin {\"title\":\"apiRequestContext.dispose\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"apiRequestContext.dispose\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"fixture: request\",\"category\":\"fixture\",\"steps\":[{\"title\":\"apiRequestContext.dispose\",\"category\":\"pw:api\"}]}`,
        `begin {\"title\":\"fixture: page\",\"category\":\"fixture\"}`,
        `end {\"title\":\"fixture: page\",\"category\":\"fixture\"}`,
        `begin {\"title\":\"fixture: context\",\"category\":\"fixture\"}`,
        `end {\"title\":\"fixture: context\",\"category\":\"fixture\"}`,
        `end {\"title\":\"After Hooks\",\"category\":\"hook\",\"steps\":[{\"title\":\"fixture: request\",\"category\":\"fixture\",\"steps\":[{\"title\":\"apiRequestContext.dispose\",\"category\":\"pw:api\"}]},{\"title\":\"fixture: page\",\"category\":\"fixture\"},{\"title\":\"fixture: context\",\"category\":\"fixture\"}]}`,
        `begin {\"title\":\"Before Hooks\",\"category\":\"hook\"}`,
        `begin {\"title\":\"beforeAll hook\",\"category\":\"hook\"}`,
        `begin {\"title\":\"browser.newPage\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"browser.newPage\",\"category\":\"pw:api\"}`,
        `begin {\"title\":\"page.setContent\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"page.setContent\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"beforeAll hook\",\"category\":\"hook\",\"steps\":[{\"title\":\"browser.newPage\",\"category\":\"pw:api\"},{\"title\":\"page.setContent\",\"category\":\"pw:api\"}]}`,
        `end {\"title\":\"Before Hooks\",\"category\":\"hook\",\"steps\":[{\"title\":\"beforeAll hook\",\"category\":\"hook\",\"steps\":[{\"title\":\"browser.newPage\",\"category\":\"pw:api\"},{\"title\":\"page.setContent\",\"category\":\"pw:api\"}]}]}`,
        `begin {\"title\":\"page.click(button)\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"page.click(button)\",\"category\":\"pw:api\"}`,
        `begin {\"title\":\"After Hooks\",\"category\":\"hook\"}`,
        `end {\"title\":\"After Hooks\",\"category\":\"hook\"}`,
        `begin {\"title\":\"Before Hooks\",\"category\":\"hook\"}`,
        `end {\"title\":\"Before Hooks\",\"category\":\"hook\"}`,
        `begin {\"title\":\"page.click(button)\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"page.click(button)\",\"category\":\"pw:api\"}`,
        `begin {\"title\":\"After Hooks\",\"category\":\"hook\"}`,
        `begin {\"title\":\"afterAll hook\",\"category\":\"hook\"}`,
        `begin {\"title\":\"page.close\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"page.close\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"afterAll hook\",\"category\":\"hook\",\"steps\":[{\"title\":\"page.close\",\"category\":\"pw:api\"}]}`,
        `end {\"title\":\"After Hooks\",\"category\":\"hook\",\"steps\":[{\"title\":\"afterAll hook\",\"category\":\"hook\",\"steps\":[{\"title\":\"page.close\",\"category\":\"pw:api\"}]}]}`,
      ]);
    });


    test('should report api step failure', async ({ runInlineTest }) => {
      const result = await runInlineTest({
        'reporter.ts': stepsReporterJS,
        'playwright.config.ts': `
          module.exports = {
            reporter: './reporter',
          };
        `,
        'a.test.ts': `
          import { test, expect } from '@playwright/test';
          test('fail', async ({ page }) => {
            await page.setContent('<button></button>');
            await page.click('input', { timeout: 1 });
          });
        `
      }, { reporter: '', workers: 1 });

      expect(result.exitCode).toBe(1);
      expect(result.outputLines).toEqual([
        `begin {\"title\":\"Before Hooks\",\"category\":\"hook\"}`,
        `begin {\"title\":\"fixture: browser\",\"category\":\"fixture\"}`,
        `begin {\"title\":\"browserType.launch\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"browserType.launch\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"fixture: browser\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browserType.launch\",\"category\":\"pw:api\"}]}`,
        `begin {\"title\":\"fixture: context\",\"category\":\"fixture\"}`,
        `begin {\"title\":\"browser.newContext\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"browser.newContext\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"fixture: context\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browser.newContext\",\"category\":\"pw:api\"}]}`,
        `begin {\"title\":\"fixture: page\",\"category\":\"fixture\"}`,
        `begin {\"title\":\"browserContext.newPage\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"browserContext.newPage\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"fixture: page\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browserContext.newPage\",\"category\":\"pw:api\"}]}`,
        `end {\"title\":\"Before Hooks\",\"category\":\"hook\",\"steps\":[{\"title\":\"fixture: browser\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browserType.launch\",\"category\":\"pw:api\"}]},{\"title\":\"fixture: context\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browser.newContext\",\"category\":\"pw:api\"}]},{\"title\":\"fixture: page\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browserContext.newPage\",\"category\":\"pw:api\"}]}]}`,
        `begin {\"title\":\"page.setContent\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"page.setContent\",\"category\":\"pw:api\"}`,
        `begin {\"title\":\"page.click(input)\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"page.click(input)\",\"category\":\"pw:api\",\"error\":{\"message\":\"TimeoutError: page.click: Timeout 1ms exceeded.\\nCall log:\\n  \\u001b[2m- waiting for locator('input')\\u001b[22m\\n\",\"stack\":\"<stack>\",\"location\":\"<location>\",\"snippet\":\"<snippet>\"}}`,
        `begin {\"title\":\"After Hooks\",\"category\":\"hook\"}`,
        `begin {\"title\":\"fixture: page\",\"category\":\"fixture\"}`,
        `end {\"title\":\"fixture: page\",\"category\":\"fixture\"}`,
        `begin {\"title\":\"fixture: context\",\"category\":\"fixture\"}`,
        `end {\"title\":\"fixture: context\",\"category\":\"fixture\"}`,
        `begin {\"title\":\"fixture: browser\",\"category\":\"fixture\"}`,
        `end {\"title\":\"fixture: browser\",\"category\":\"fixture\"}`,
        `end {\"title\":\"After Hooks\",\"category\":\"hook\",\"steps\":[{\"title\":\"fixture: page\",\"category\":\"fixture\"},{\"title\":\"fixture: context\",\"category\":\"fixture\"},{\"title\":\"fixture: browser\",\"category\":\"fixture\"}]}`,
      ]);
    });

    test('should not have internal error when steps are finished after timeout', async ({ runInlineTest }) => {
      const result = await runInlineTest({
        'a.test.ts': `
          import { test as base, expect } from '@playwright/test';
          const test = base.extend({
            page: async ({ page }, use) => {
              await use(page);
              // Timeout in fixture teardown that will resolve on browser.close.
              await page.waitForNavigation();
            },
          });
          test('pass', async ({ page }) => {
            // Timeout in the test.
            await page.click('foo');
          });
        `
      }, { workers: 1, timeout: 1000, reporter: 'dot', retries: 1 });

      expect(result.exitCode).toBe(1);
      expect(result.failed).toBe(1);
      expect(result.output).not.toContain('Internal error');
    });

    test('should show nice stacks for locators', async ({ runInlineTest }) => {
      const result = await runInlineTest({
        'reporter.ts': stepsReporterJS,
        'playwright.config.ts': `
          module.exports = {
            reporter: './reporter',
          };
        `,
        'a.test.ts': `
          import { test, expect } from '@playwright/test';
          test('pass', async ({ page }) => {
            await page.setContent('<button></button>');
            const locator = page.locator('button');
            await locator.evaluate(e => e.innerText);
          });
        `
      }, { reporter: '', workers: 1 });

      expect(result.exitCode).toBe(0);
      expect(result.passed).toBe(0);
      expect(result.output).not.toContain('Internal error');
      expect(result.outputLines).toEqual([
        `begin {"title":"Before Hooks","category":"hook"}`,
        `begin {\"title\":\"fixture: browser\",\"category\":\"fixture\"}`,
        `begin {\"title\":\"browserType.launch\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"browserType.launch\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"fixture: browser\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browserType.launch\",\"category\":\"pw:api\"}]}`,
        `begin {\"title\":\"fixture: context\",\"category\":\"fixture\"}`,
        `begin {\"title\":\"browser.newContext\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"browser.newContext\",\"category\":\"pw:api\"}`,
        `end {\"title\":\"fixture: context\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browser.newContext\",\"category\":\"pw:api\"}]}`,
        `begin {\"title\":\"fixture: page\",\"category\":\"fixture\"}`,
        `begin {"title":"browserContext.newPage","category":"pw:api"}`,
        `end {"title":"browserContext.newPage","category":"pw:api"}`,
        `end {\"title\":\"fixture: page\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browserContext.newPage\",\"category\":\"pw:api\"}]}`,
        `end {\"title\":\"Before Hooks\",\"category\":\"hook\",\"steps\":[{\"title\":\"fixture: browser\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browserType.launch\",\"category\":\"pw:api\"}]},{\"title\":\"fixture: context\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browser.newContext\",\"category\":\"pw:api\"}]},{\"title\":\"fixture: page\",\"category\":\"fixture\",\"steps\":[{\"title\":\"browserContext.newPage\",\"category\":\"pw:api\"}]}]}`,
        `begin {"title":"page.setContent","category":"pw:api"}`,
        `end {"title":"page.setContent","category":"pw:api"}`,
        `begin {"title":"locator.evaluate(button)","category":"pw:api"}`,
        `end {"title":"locator.evaluate(button)","category":"pw:api"}`,
        `begin {"title":"After Hooks","category":"hook"}`,
        `begin {\"title\":\"fixture: page\",\"category\":\"fixture\"}`,
        `end {\"title\":\"fixture: page\",\"category\":\"fixture\"}`,
        `begin {\"title\":\"fixture: context\",\"category\":\"fixture\"}`,
        `end {\"title\":\"fixture: context\",\"category\":\"fixture\"}`,
        `end {\"title\":\"After Hooks\",\"category\":\"hook\",\"steps\":[{\"title\":\"fixture: page\",\"category\":\"fixture\"},{\"title\":\"fixture: context\",\"category\":\"fixture\"}]}`,
      ]);
    });

    test('should report forbid-only error to reporter', async ({ runInlineTest }) => {
      const result = await runInlineTest({
        'reporter.ts': smallReporterJS,
        'playwright.config.ts': `
          module.exports = {
            reporter: './reporter',
          };
        `,
        'a.test.ts': `
          import { test, expect } from '@playwright/test';
          test.only('pass', () => {});
        `
      }, { 'reporter': '', 'forbid-only': true });

      expect(result.exitCode).toBe(1);
      expect(result.output).toContain(`%%got error: Error: item focused with '.only' is not allowed due to the '--forbid-only' CLI flag: \"a.test.ts pass\"`);
    });

    test('should report no-tests error to reporter', async ({ runInlineTest }) => {
      const result = await runInlineTest({
        'reporter.ts': smallReporterJS,
        'playwright.config.ts': `
          module.exports = {
            reporter: './reporter',
          };
        `
      }, { 'reporter': '' });

      expect(result.exitCode).toBe(1);
      expect(result.output).toContain(`%%got error: Error: No tests found`);
    });

    test('should report require error to reporter', async ({ runInlineTest }) => {
      const result = await runInlineTest({
        'reporter.ts': smallReporterJS,
        'playwright.config.ts': `
          module.exports = {
            reporter: './reporter',
          };
        `,
        'a.spec.js': `
          throw new Error('Oh my!');
        `,
      }, { 'reporter': '' });

      expect(result.exitCode).toBe(1);
      expect(result.output).toContain(`%%got error: Error: Oh my!`);
    });

    test('should report global setup error to reporter', async ({ runInlineTest }) => {
      const result = await runInlineTest({
        'reporter.ts': smallReporterJS,
        'playwright.config.ts': `
          module.exports = {
            reporter: './reporter',
            globalSetup: './globalSetup',
          };
        `,
        'globalSetup.ts': `
          module.exports = () => {
            throw new Error('Oh my!');
          };
        `,
        'a.spec.js': `
          const { test, expect } = require('@playwright/test');
          test('test', () => {});
        `,
      }, { 'reporter': '' });

      expect(result.exitCode).toBe(1);
      expect(result.output).toContain(`%%got error: Error: Oh my!`);
    });

    test('should report correct tests/suites when using grep', async ({ runInlineTest }) => {
      const result = await runInlineTest({
        'a.spec.js': `
          import { test, expect } from '@playwright/test';

          test.describe('@foo', () => {
            test('test1', async ({ }) => {
              console.log('%%test1');
            });
            test('test2', async ({ }) => {
              console.log('%%test2');
            });
          });

          test('test3', async ({ }) => {
            console.log('%%test3');
          });
        `,
      }, { 'grep': '@foo' });

      expect(result.exitCode).toBe(0);
      expect(result.output).toContain('%%test1');
      expect(result.output).toContain('%%test2');
      expect(result.output).not.toContain('%%test3');
      const fileSuite = result.report.suites[0];
      expect(fileSuite.suites!.length).toBe(1);
      expect(fileSuite.suites![0].specs.length).toBe(2);
      expect(fileSuite.specs.length).toBe(0);
    });

    test('should use sourceMap-based file suite names', async ({ runInlineTest }) => {
      test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/11028' });
      const result = await runInlineTest({
        'reporter.js': `
          class Reporter {
            onBegin(config, suite) {
              console.log(suite.suites[0].suites[0].location.file);
            }
          }
          module.exports = Reporter;
        `,
        'playwright.config.ts': `
          module.exports = {
            reporter: './reporter',
          };
        `,
        'a.spec.js':
`var __create = Object.create;
var __defProp = Object.defineProperty;
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
var __getOwnPropNames = Object.getOwnPropertyNames;
var __getProtoOf = Object.getPrototypeOf;
var __hasOwnProp = Object.prototype.hasOwnProperty;
var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
var __reExport = (target, module2, desc) => {
  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
    for (let key of __getOwnPropNames(module2))
      if (!__hasOwnProp.call(target, key) && key !== "default")
        __defProp(target, key, { get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable });
  }
  return target;
};
var __toModule = (module2) => {
  return __reExport(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", module2 && module2.__esModule && "default" in module2 ? { get: () => module2.default, enumerable: true } : { value: module2, enumerable: true })), module2);
};
var import_test = __toModule(require("@playwright/test"));
(0, import_test.test)("pass", async () => {
});
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL2Euc3BlYy50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiaW1wb3J0IHsgdGVzdCB9IGZyb20gXCJAcGxheXdyaWdodC90ZXN0XCI7XG5cbnRlc3QoJ3Bhc3MnLCBhc3luYyAoKSA9PiB7fSk7Il0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQUEsa0JBQXFCO0FBRXJCLHNCQUFLLFFBQVEsWUFBWTtBQUFBOyIsCiAgIm5hbWVzIjogW10KfQo=`,
      }, { 'reporter': '' });

      expect(result.exitCode).toBe(0);
      expect(result.output).toContain('a.spec.ts');
    });

    test('parallelIndex is presented in onTestEnd', async ({ runInlineTest }) => {
      const result = await runInlineTest({
        'reporter.ts': `
        class Reporter {
          onTestEnd(test, result) {
            console.log('parallelIndex: ' + result.parallelIndex)
          }
        }
        module.exports = Reporter;`,
        'playwright.config.ts': `
          module.exports = {
            reporter: './reporter',
          };
        `,
        'a.spec.js': `
          const { test, expect } = require('@playwright/test');
          test('test', () => {});
        `,
      }, { 'reporter': '', 'workers': 1 });

      expect(result.output).toContain('parallelIndex: 0');
    });

    test('test and step error should have code snippet', async ({ runInlineTest }) => {
      const testErrorFile = test.info().outputPath('testError.txt');
      const stepErrorFile = test.info().outputPath('stepError.txt');
      const result = await runInlineTest({
        'reporter.ts': `
        import fs from 'fs';
        class Reporter {
          onStepEnd(test, result, step) {
            console.log('\\n%%onStepEnd: ' + step.error?.snippet?.length);
            if (step.error?.snippet)
              fs.writeFileSync('${stepErrorFile.replace(/\\/g, '\\\\')}', step.error?.snippet);
          }
          onTestEnd(test, result) {
            console.log('\\n%%onTestEnd: ' + result.error?.snippet?.length);
            if (result.error)
              fs.writeFileSync('${testErrorFile.replace(/\\/g, '\\\\')}', result.error?.snippet);
          }
          onError(error) {
            console.log('\\n%%onError: ' + error.snippet?.length);
          }
        }
        module.exports = Reporter;`,
        'playwright.config.ts': `
          module.exports = {
            reporter: './reporter',
          };
        `,
        'a.spec.js': `
          const { test, expect } = require('@playwright/test');
          test('test', async () => {
            await test.step('step', async () => {
              expect(1).toBe(2);
            });
          });
        `,
      }, { 'reporter': '', 'workers': 1 });

      expect(result.output).toContain('onTestEnd: 550');
      expect(result.output).toContain('onStepEnd: 550');
      expect(stripAnsi(fs.readFileSync(testErrorFile, 'utf8'))).toBe(`  3 |           test('test', async () => {
  4 |             await test.step('step', async () => {
> 5 |               expect(1).toBe(2);
    |                         ^
  6 |             });
  7 |           });
  8 |         `);
      expect(stripAnsi(fs.readFileSync(stepErrorFile, 'utf8'))).toBe(`  3 |           test('test', async () => {
  4 |             await test.step('step', async () => {
> 5 |               expect(1).toBe(2);
    |                         ^
  6 |             });
  7 |           });
  8 |         `);
    });

    test('onError should have code snippet', async ({ runInlineTest }) => {
      const errorFile = test.info().outputPath('error.txt');
      const result = await runInlineTest({
        'reporter.ts': `
        import fs from 'fs';
        class Reporter {
          onError(error) {
            console.log('\\n%%onError: ' + error.snippet?.length);
            fs.writeFileSync('${errorFile.replace(/\\/g, '\\\\')}', error.snippet);
          }
        }
        module.exports = Reporter;`,
        'playwright.config.ts': `
          module.exports = {
            reporter: './reporter',
          };
        `,
        'a.spec.js': `
          const { test, expect } = require('@playwright/test');
          throw new Error('test');
        `,
      }, { 'reporter': '', 'workers': 1 });

      expect(result.output).toContain('onError: 412');
      expect(stripAnsi(fs.readFileSync(errorFile, 'utf8'))).toBe(`   at a.spec.js:3

  1 |
  2 |           const { test, expect } = require('@playwright/test');
> 3 |           throw new Error('test');
    |                 ^
  4 |         `);
    });
  });
}

test('should report a stable test.id', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'reporter.ts': `
      class Reporter {
        onTestBegin(test) {
          console.log('\\n%%testbegin-' + test.id);
        }
      }
      export default Reporter;
    `,
    'playwright.config.ts': `
      module.exports = { reporter: [[ './reporter.ts' ]] };
    `,
    'a.test.ts': `
      import { test, expect } from '@playwright/test';
      test('example test', async ({}) => {
      });
    `
  }, { reporter: '', workers: 1 });

  expect(result.exitCode).toBe(0);
  expect(result.outputLines).toEqual([
    'testbegin-20289bcdad95a5e18c38-8b63c3695b9c8bd62d98',
  ]);
});

test('should report annotations from test declaration', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'reporter.ts': `
      export default class Reporter {
        onBegin(config, suite) {
          const visit = suite => {
            for (const test of suite.tests || []) {
              const annotations = test.annotations.map(a => {
                return a.description ? a.type + '=' + a.description : a.type;
              });
              console.log('\\n%%title=' + test.title + ', annotations=' + annotations.join(','));
            }
            for (const child of suite.suites || [])
              visit(child);
          };
          visit(suite);
        }
        onError(error) {
          console.log(error);
        }
      }
    `,
    'playwright.config.ts': `
      module.exports = {
        reporter: './reporter',
      };
    `,
    'stdio.spec.js': `
      import { test, expect } from '@playwright/test';
      test('none', () => {
        expect(test.info().annotations).toEqual([]);
      });
      test('foo', { annotation: { type: 'foo' } }, () => {
        expect(test.info().annotations).toEqual([{ type: 'foo' }]);
      });
      test('foo-bar', {
        annotation: [
          { type: 'foo', description: 'desc' },
          { type: 'bar' },
        ],
      }, () => {
        expect(test.info().annotations).toEqual([
          { type: 'foo', description: 'desc' },
          { type: 'bar' },
        ]);
      });
      test.skip('skip-foo', { annotation: { type: 'foo' } }, () => {
      });
      test.fixme('fixme-bar', { annotation: { type: 'bar' } }, () => {
      });
      test.fail('fail-foo-bar', {
        annotation: [
          { type: 'foo' },
          { type: 'bar', description: 'desc' },
        ],
      }, () => {
        expect(1).toBe(2);
      });
      test.describe('suite', { annotation: { type: 'foo' } }, () => {
        test('foo-suite', () => {
          expect(test.info().annotations).toEqual([{ type: 'foo' }]);
        });
        test.describe('inner', { annotation: { type: 'bar' } }, () => {
          test('foo-bar-suite', () => {
            expect(test.info().annotations).toEqual([{ type: 'foo' }, { type: 'bar' }]);
          });
        });
      });
      test.describe.skip('skip-foo-suite', { annotation: { type: 'foo' } }, () => {
        test('skip-foo-suite', () => {
        });
      });
      test.describe.fixme('fixme-bar-suite', { annotation: { type: 'bar' } }, () => {
        test('fixme-bar-suite', () => {
        });
      });
    `
  });
  expect(result.exitCode).toBe(0);
  expect(result.outputLines).toEqual([
    `title=none, annotations=`,
    `title=foo, annotations=foo`,
    `title=foo-bar, annotations=foo=desc,bar`,
    `title=skip-foo, annotations=foo,skip`,
    `title=fixme-bar, annotations=bar,fixme`,
    `title=fail-foo-bar, annotations=foo,bar=desc,fail`,
    `title=foo-suite, annotations=foo`,
    `title=foo-bar-suite, annotations=foo,bar`,
    `title=skip-foo-suite, annotations=foo,skip`,
    `title=fixme-bar-suite, annotations=bar,fixme`,
  ]);
});