yujunjun/playwright
1
0
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: expose configuration for HTML report serving. (#17560)

Browse Source 
Fixes #16667
This commit is contained in:
Andrey Lushnikov 2022-09-25 23:36:38 -04:00 committed by GitHub
parent 10d7c60abf
commit ec40e49978
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/src/test-reporters-js.md
View File

@ -238,13 +238,19 @@ By default, HTML report is opened automatically if some of the tests failed. You
`open` property in the Playwright config. The possible values for that property are `always`, `never` and `on-failure`
(default).
You can also configure `host` and `port` that are used to serve the HTML report.
```js tab=js-js
// playwright.config.js
// @ts-check
/** @type {import('@playwright/test').PlaywrightTestConfig} */
const config = {
reporter: [ ['html', { open: 'never' }] ],
reporter: [ ['html', {
open: 'never',
host: '0.0.0.0',
port: 9223,
}] ],
};
module.exports = config;
@ -647,4 +653,4 @@ export default config;
* [Allure](https://www.npmjs.com/package/allure-playwright)
* [Monocart](https://github.com/cenfun/monocart-reporter)
* [Tesults](https://www.tesults.com/docs/playwright)
* [Tesults](https://www.tesults.com/docs/playwright)

6
packages/playwright-core/src/utils/httpServer.ts
View File

@ -51,14 +51,14 @@ export class HttpServer {
return this._port;
}
async start(port?: number): Promise<string> {
async start(port?: number, host = 'localhost'): Promise<string> {
assert(!this._started, 'server already started');
this._started = true;
this._server.on('connection', socket => {
this._activeSockets.add(socket);
socket.once('close', () => this._activeSockets.delete(socket));
});
this._server.listen(port, 'localhost');
this._server.listen(port, host);
await new Promise(cb => this._server!.once('listening', cb));
const address = this._server.address();
assert(address, 'Could not bind server socket');
@ -67,7 +67,7 @@ export class HttpServer {
this._urlPrefix = address;
} else {
this._port = address.port;
this._urlPrefix = `http://localhost:${address.port}`;
this._urlPrefix = `http://${host}:${address.port}`;
}
}
return this._urlPrefix;

8
packages/playwright-test/src/reporters/html.ts
View File

@ -45,6 +45,8 @@ type HtmlReportOpenOption = 'always' | 'never' | 'on-failure';
type HtmlReporterOptions = {
outputFolder?: string,
open?: HtmlReportOpenOption,
host?: string,
port?: number,
};
class HtmlReporter implements ReporterInternal {
@ -116,7 +118,7 @@ class HtmlReporter implements ReporterInternal {
const { ok, singleTestId } = this._buildResult!;
const shouldOpen = this._open === 'always' || (!ok && this._open === 'on-failure');
if (shouldOpen) {
await showHTMLReport(this._outputFolder, singleTestId);
await showHTMLReport(this._outputFolder, this._options.host, this._options.port, singleTestId);
} else {
const relativeReportPath = this._outputFolder === standaloneDefaultFolder() ? '' : ' ' + path.relative(process.cwd(), this._outputFolder);
console.log('');
@ -147,7 +149,7 @@ function standaloneDefaultFolder(): string {
return reportFolderFromEnv() ?? defaultReportFolder(process.cwd());
}
export async function showHTMLReport(reportFolder: string | undefined, testId?: string) {
export async function showHTMLReport(reportFolder: string | undefined, host: string = 'localhost', port: number = 9223, testId?: string) {
const folder = reportFolder ?? standaloneDefaultFolder();
try {
assert(fs.statSync(folder).isDirectory());
@ -157,7 +159,7 @@ export async function showHTMLReport(reportFolder: string | undefined, testId?:
return;
}
const server = startHtmlReportServer(folder);
let url = await server.start(9323);
let url = await server.start(port, host);
console.log('');
console.log(colors.cyan(` Serving HTML report at ${url}. Press Ctrl+C to quit.`));
if (testId)