Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
chore(html): reverse noSnippets option and add documentation (#36583)
Adam Gastineau3fc31ff746d6
diff --git a/docs/src/test-reporters-js.md b/docs/src/test-reporters-js.mdindex e5fe3f526d..f3393c6a25 100644--- a/docs/src/test-reporters-js.md+++ b/docs/src/test-reporters-js.md@@ -252,6 +252,7 @@ HTML report supports the following configuration options and environment variabl| `PLAYWRIGHT_HTML_HOST` | `host` | When report opens in the browser, it will be served bound to this hostname. | `localhost`| `PLAYWRIGHT_HTML_PORT` | `port` | When report opens in the browser, it will be served on this port. | `9323` or any available port when `9323` is not available.| `PLAYWRIGHT_HTML_ATTACHMENTS_BASE_URL` | `attachmentsBaseURL` | A separate location where attachments from the `data` subdirectory are uploaded. Only needed when you upload report and `data` separately to different locations. | `data/`+| `PLAYWRIGHT_HTML_NO_SNIPPETS` | `noSnippets` | If true, disable rendering code snippets in the action log. If there is a top level error, that report section with code snippet will still render. Supports `true`, `1`, `false`, and `0`. | `false`### Blob reporterdiff --git a/packages/playwright/src/reporters/html.ts b/packages/playwright/src/reporters/html.tsindex 2946ab676f..eb34ab0192 100644--- a/packages/playwright/src/reporters/html.ts+++ b/packages/playwright/src/reporters/html.ts@@ -125,7 +125,14 @@ class HtmlReporter implements ReporterV2 {async onEnd(result: api.FullResult) {const projectSuites = this.suite.suites;await removeFolders([this._outputFolder]);- const builder = new HtmlBuilder(this.config, this._outputFolder, this._attachmentsBaseURL, process.env.PLAYWRIGHT_HTML_TITLE || this._options.title, this._options.snippets);+ let noSnippets: boolean | undefined;+ if (process.env.PLAYWRIGHT_HTML_NO_SNIPPETS === 'false' || process.env.PLAYWRIGHT_HTML_NO_SNIPPETS === '0')+ noSnippets = false;+ else if (process.env.PLAYWRIGHT_HTML_NO_SNIPPETS)+ noSnippets = true;+ noSnippets = noSnippets || this._options.noSnippets;++ const builder = new HtmlBuilder(this.config, this._outputFolder, this._attachmentsBaseURL, process.env.PLAYWRIGHT_HTML_TITLE || this._options.title, noSnippets);this._buildResult = await builder.build(this.config.metadata, projectSuites, result, this._topLevelErrors);}@@ -223,12 +230,12 @@ class HtmlBuilder {private _hasTraces = false;private _attachmentsBaseURL: string;private _title: string | undefined;- private _snippets: boolean;+ private _noSnippets: boolean;- constructor(config: api.FullConfig, outputDir: string, attachmentsBaseURL: string, title: string | undefined, snippets: boolean = true) {+ constructor(config: api.FullConfig, outputDir: string, attachmentsBaseURL: string, title: string | undefined, noSnippets: boolean = false) {this._config = config;this._reportFolder = outputDir;- this._snippets = snippets;+ this._noSnippets = noSnippets;fs.mkdirSync(this._reportFolder, { recursive: true });this._dataZipFile = new yazl.ZipFile();this._attachmentsBaseURL = attachmentsBaseURL;@@ -258,7 +265,7 @@ class HtmlBuilder {}}}- if (this._snippets)+ if (!this._noSnippets)createSnippets(this._stepsInFile);let ok = true;diff --git a/packages/playwright/types/test.d.ts b/packages/playwright/types/test.d.tsindex 8390543f34..cfc062bafb 100644--- a/packages/playwright/types/test.d.ts+++ b/packages/playwright/types/test.d.ts@@ -22,7 +22,7 @@ export type BlobReporterOptions = { outputDir?: string, fileName?: string };export type ListReporterOptions = { printSteps?: boolean };export type JUnitReporterOptions = { outputFile?: string, stripANSIControlSequences?: boolean, includeProjectInTestName?: boolean };export type JsonReporterOptions = { outputFile?: string };-export type HtmlReporterOptions = { outputFolder?: string, open?: 'always' | 'never' | 'on-failure', host?: string, port?: number, attachmentsBaseURL?: string, title?: string, snippets?: boolean };+export type HtmlReporterOptions = { outputFolder?: string, open?: 'always' | 'never' | 'on-failure', host?: string, port?: number, attachmentsBaseURL?: string, title?: string, noSnippets?: boolean };export type ReporterDescription = Readonly<['blob'] | ['blob', BlobReporterOptions] |diff --git a/tests/playwright-test/reporter-html.spec.ts b/tests/playwright-test/reporter-html.spec.tsindex ebd15d7511..d8f1df6afa 100644--- a/tests/playwright-test/reporter-html.spec.ts+++ b/tests/playwright-test/reporter-html.spec.ts@@ -3049,7 +3049,7 @@ for (const useIntermediateMergeReport of [true, false] as const) {test('should respect snippets configuration option', async ({ runInlineTest, showReport, page }) => {const result = await runInlineTest({'playwright.config.ts': `- export default { reporter: [['html', { snippets: false }]] }+ export default { reporter: [['html', { noSnippets: true }]] }`,'example.spec.ts': `import { test, expect } from '@playwright/test';diff --git a/utils/generate_types/overrides-test.d.ts b/utils/generate_types/overrides-test.d.tsindex 2dfd024bfc..374f66f179 100644--- a/utils/generate_types/overrides-test.d.ts+++ b/utils/generate_types/overrides-test.d.ts@@ -21,7 +21,7 @@ export type BlobReporterOptions = { outputDir?: string, fileName?: string };export type ListReporterOptions = { printSteps?: boolean };export type JUnitReporterOptions = { outputFile?: string, stripANSIControlSequences?: boolean, includeProjectInTestName?: boolean };export type JsonReporterOptions = { outputFile?: string };-export type HtmlReporterOptions = { outputFolder?: string, open?: 'always' | 'never' | 'on-failure', host?: string, port?: number, attachmentsBaseURL?: string, title?: string, snippets?: boolean };+export type HtmlReporterOptions = { outputFolder?: string, open?: 'always' | 'never' | 'on-failure', host?: string, port?: number, attachmentsBaseURL?: string, title?: string, noSnippets?: boolean };export type ReporterDescription = Readonly<['blob'] | ['blob', BlobReporterOptions] |