From 5c95209f88a0ed675131406c6d013e26219009a6 Mon Sep 17 00:00:00 2001 From: Pavel Feldman Date: Mon, 24 Apr 2023 17:27:24 -0700 Subject: [PATCH] chore: remove cli from playwright-core --- package-lock.json | 3 - packages/playwright-chromium/cli.js | 2 +- packages/playwright-chromium/package.json | 1 - packages/playwright-core/cli.js | 17 - packages/playwright-core/package.json | 8 +- packages/playwright-core/src/cli/DEPS.list | 2 +- packages/playwright-core/src/cli/cli.ts | 711 +----------------- packages/playwright-core/src/cli/program.ts | 662 ++++++++++++++++ packages/playwright-firefox/cli.js | 2 +- packages/playwright-firefox/package.json | 1 - packages/playwright-test/cli.js | 2 +- packages/playwright-test/src/cli.ts | 17 +- packages/playwright-webkit/cli.js | 2 +- packages/playwright-webkit/package.json | 1 - packages/playwright/cli.js | 2 +- .../playwright-test-fixtures.ts | 2 +- 16 files changed, 704 insertions(+), 731 deletions(-) delete mode 100755 packages/playwright-core/cli.js create mode 100644 packages/playwright-core/src/cli/program.ts diff --git a/package-lock.json b/package-lock.json index b2f5d1723fe79..1adfdd4ce3081 100644 --- a/package-lock.json +++ b/package-lock.json @@ -6192,9 +6192,6 @@ "packages/playwright-core": { "version": "1.34.0-next", "license": "Apache-2.0", - "bin": { - "playwright": "cli.js" - }, "engines": { "node": ">=14" } diff --git a/packages/playwright-chromium/cli.js b/packages/playwright-chromium/cli.js index 17ed363fa2905..bd995de11422c 100755 --- a/packages/playwright-chromium/cli.js +++ b/packages/playwright-chromium/cli.js @@ -14,4 +14,4 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -module.exports = require('playwright-core/cli'); +module.exports = require('playwright-core/lib/cli/cli'); diff --git a/packages/playwright-chromium/package.json b/packages/playwright-chromium/package.json index e77ba7fd508ca..fdbf38e173077 100644 --- a/packages/playwright-chromium/package.json +++ b/packages/playwright-chromium/package.json @@ -18,7 +18,6 @@ "require": "./index.js", "default": "./index.js" }, - "./cli": "./cli.js", "./package.json": "./package.json" }, "bin": { diff --git a/packages/playwright-core/cli.js b/packages/playwright-core/cli.js deleted file mode 100755 index 7867c0a901811..0000000000000 --- a/packages/playwright-core/cli.js +++ /dev/null @@ -1,17 +0,0 @@ -#!/usr/bin/env node -/** - * 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. - */ -module.exports = require('./lib/cli/cli'); diff --git a/packages/playwright-core/package.json b/packages/playwright-core/package.json index 7888e8c5cf6eb..480bd409dc17e 100644 --- a/packages/playwright-core/package.json +++ b/packages/playwright-core/package.json @@ -18,13 +18,14 @@ "require": "./index.js", "default": "./index.js" }, - "./cli": "./cli.js", "./package.json": "./package.json", "./lib/outofprocess": "./lib/outofprocess.js", "./lib/image_tools/stats": "./lib/image_tools/stats.js", "./lib/image_tools/compare": "./lib/image_tools/compare.js", "./lib/image_tools/imageChannel": "./lib/image_tools/imageChannel.js", "./lib/image_tools/colorUtils": "./lib/image_tools/colorUtils.js", + "./lib/cli/cli": "./lib/cli/cli.js", + "./lib/cli/program": "./lib/cli/program.js", "./lib/containers/docker": "./lib/containers/docker.js", "./lib/remote/playwrightServer": "./lib/remote/playwrightServer.js", "./lib/server": "./lib/server/index.js", @@ -34,8 +35,5 @@ "./types/protocol": "./types/protocol.d.ts", "./types/structs": "./types/structs.d.ts" }, - "types": "types/types.d.ts", - "bin": { - "playwright": "./cli.js" - } + "types": "types/types.d.ts" } diff --git a/packages/playwright-core/src/cli/DEPS.list b/packages/playwright-core/src/cli/DEPS.list index fdca1c1698039..ab30158290a6d 100644 --- a/packages/playwright-core/src/cli/DEPS.list +++ b/packages/playwright-core/src/cli/DEPS.list @@ -9,7 +9,7 @@ ../utils ../utilsBundle.ts -[cli.ts] +[program.ts] ../server/trace/viewer/traceViewer.ts ../server/ ../containers/ diff --git a/packages/playwright-core/src/cli/cli.ts b/packages/playwright-core/src/cli/cli.ts index b0a950c84bdc7..67003e63fecb6 100755 --- a/packages/playwright-core/src/cli/cli.ts +++ b/packages/playwright-core/src/cli/cli.ts @@ -18,701 +18,36 @@ /* eslint-disable no-console */ -import fs from 'fs'; -import os from 'os'; -import path from 'path'; -import type { Command } from '../utilsBundle'; -import { program } from '../utilsBundle'; -import { runDriver, runServer, printApiJson, launchBrowserServer } from './driver'; -import { showTraceViewer } from '../server/trace/viewer/traceViewer'; -import * as playwright from '../..'; -import type { BrowserContext } from '../client/browserContext'; -import type { Browser } from '../client/browser'; -import type { Page } from '../client/page'; -import type { BrowserType } from '../client/browserType'; -import type { BrowserContextOptions, LaunchOptions } from '../client/types'; -import { spawn } from 'child_process'; -import { wrapInASCIIBox, isLikelyNpxGlobal, assert } from '../utils'; -import type { Executable } from '../server'; -import { registry, writeDockerVersion } from '../server'; - -const packageJSON = require('../../package.json'); - -program - .version('Version ' + (process.env.PW_CLI_DISPLAY_VERSION || packageJSON.version)) - .name(buildBasePlaywrightCLICommand(process.env.PW_LANG_NAME)); - -program - .command('mark-docker-image [dockerImageNameTemplate]', { hidden: true }) - .description('mark docker image') - .allowUnknownOption(true) - .action(function(dockerImageNameTemplate) { - assert(dockerImageNameTemplate, 'dockerImageNameTemplate is required'); - writeDockerVersion(dockerImageNameTemplate).catch(logErrorAndExit); - }); - -commandWithOpenOptions('open [url]', 'open page in browser specified via -b, --browser', []) - .action(function(url, options) { - open(options, url, codegenId()).catch(logErrorAndExit); - }) - .addHelpText('afterAll', ` -Examples: - - $ open - $ open -b webkit https://example.com`); - -commandWithOpenOptions('codegen [url]', 'open page and generate code for user actions', - [ - ['-o, --output ', 'saves the generated script to a file'], - ['--target ', `language to generate, one of javascript, playwright-test, python, python-async, python-pytest, csharp, csharp-mstest, csharp-nunit, java`, codegenId()], - ['--save-trace ', 'record a trace for the session and save it to a file'], - ]).action(function(url, options) { - codegen(options, url, options.target, options.output).catch(logErrorAndExit); -}).addHelpText('afterAll', ` -Examples: - - $ codegen - $ codegen --target=python - $ codegen -b webkit https://example.com`); - -program - .command('debug [args...]', { hidden: true }) - .description('run command in debug mode: disable timeout, open inspector') - .allowUnknownOption(true) - .action(function(app, options) { - spawn(app, options, { - env: { ...process.env, PWDEBUG: '1' }, - stdio: 'inherit' - }); - }).addHelpText('afterAll', ` -Examples: - - $ debug node test.js - $ debug npm run test`); - -function suggestedBrowsersToInstall() { - return registry.executables().filter(e => e.installType !== 'none' && e.type !== 'tool').map(e => e.name).join(', '); -} - -function checkBrowsersToInstall(args: string[]): Executable[] { - const faultyArguments: string[] = []; - const executables: Executable[] = []; - for (const arg of args) { - const executable = registry.findExecutable(arg); - if (!executable || executable.installType === 'none') - faultyArguments.push(arg); - else - executables.push(executable); - } - if (faultyArguments.length) { - console.log(`Invalid installation targets: ${faultyArguments.map(name => `'${name}'`).join(', ')}. Expecting one of: ${suggestedBrowsersToInstall()}`); +import program from './program'; + +{ + const command = program.command('test').allowUnknownOption(true); + command.description('Run tests with Playwright Test. Available in @playwright/test package.'); + command.action(async () => { + console.error('Please install @playwright/test package to use Playwright Test.'); + console.error(' npm install -D @playwright/test'); process.exit(1); - } - return executables; -} - - -program - .command('install [browser...]') - .description('ensure browsers necessary for this version of Playwright are installed') - .option('--with-deps', 'install system dependencies for browsers') - .option('--dry-run', 'do not execute installation, only print information') - .option('--force', 'force reinstall of stable browser channels') - .action(async function(args: string[], options: { withDeps?: boolean, force?: boolean, dryRun?: boolean }) { - if (isLikelyNpxGlobal()) { - console.error(wrapInASCIIBox([ - `WARNING: It looks like you are running 'npx playwright install' without first`, - `installing your project's dependencies.`, - ``, - `To avoid unexpected behavior, please install your dependencies first, and`, - `then run Playwright's install command:`, - ``, - ` npm install`, - ` npx playwright install`, - ``, - `If your project does not yet depend on Playwright, first install the`, - `applicable npm package (most commonly @playwright/test), and`, - `then run Playwright's install command to download the browsers:`, - ``, - ` npm install @playwright/test`, - ` npx playwright install`, - ``, - ].join('\n'), 1)); - } - try { - const hasNoArguments = !args.length; - const executables = hasNoArguments ? registry.defaultExecutables() : checkBrowsersToInstall(args); - if (options.withDeps) - await registry.installDeps(executables, !!options.dryRun); - if (options.dryRun) { - for (const executable of executables) { - const version = executable.browserVersion ? `version ` + executable.browserVersion : ''; - console.log(`browser: ${executable.name}${version ? ' ' + version : ''}`); - console.log(` Install location: ${executable.directory ?? ''}`); - if (executable.downloadURLs?.length) { - const [url, ...fallbacks] = executable.downloadURLs; - console.log(` Download url: ${url}`); - for (let i = 0; i < fallbacks.length; ++i) - console.log(` Download fallback ${i + 1}: ${fallbacks[i]}`); - } - console.log(``); - } - } else { - const forceReinstall = hasNoArguments ? false : !!options.force; - await registry.install(executables, forceReinstall); - } - } catch (e) { - console.log(`Failed to install browsers\n${e}`); - process.exit(1); - } - }).addHelpText('afterAll', ` - -Examples: - - $ install - Install default browsers. - - - $ install chrome firefox - Install custom browsers, supports ${suggestedBrowsersToInstall()}.`); - - -program - .command('install-deps [browser...]') - .description('install dependencies necessary to run browsers (will ask for sudo permissions)') - .option('--dry-run', 'Do not execute installation commands, only print them') - .action(async function(args: string[], options: { dryRun?: boolean }) { - try { - if (!args.length) - await registry.installDeps(registry.defaultExecutables(), !!options.dryRun); - else - await registry.installDeps(checkBrowsersToInstall(args), !!options.dryRun); - } catch (e) { - console.log(`Failed to install browser dependencies\n${e}`); - process.exit(1); - } - }).addHelpText('afterAll', ` -Examples: - - $ install-deps - Install dependencies for default browsers. - - - $ install-deps chrome firefox - Install dependencies for specific browsers, supports ${suggestedBrowsersToInstall()}.`); - -const browsers = [ - { alias: 'cr', name: 'Chromium', type: 'chromium' }, - { alias: 'ff', name: 'Firefox', type: 'firefox' }, - { alias: 'wk', name: 'WebKit', type: 'webkit' }, -]; - -for (const { alias, name, type } of browsers) { - commandWithOpenOptions(`${alias} [url]`, `open page in ${name}`, []) - .action(function(url, options) { - open({ ...options, browser: type }, url, options.target).catch(logErrorAndExit); - }).addHelpText('afterAll', ` -Examples: - - $ ${alias} https://example.com`); -} - -commandWithOpenOptions('screenshot ', 'capture a page screenshot', - [ - ['--wait-for-selector ', 'wait for selector before taking a screenshot'], - ['--wait-for-timeout ', 'wait for timeout in milliseconds before taking a screenshot'], - ['--full-page', 'whether to take a full page screenshot (entire scrollable area)'], - ]).action(function(url, filename, command) { - screenshot(command, command, url, filename).catch(logErrorAndExit); -}).addHelpText('afterAll', ` -Examples: - - $ screenshot -b webkit https://example.com example.png`); - -commandWithOpenOptions('pdf ', 'save page as pdf', - [ - ['--wait-for-selector ', 'wait for given selector before saving as pdf'], - ['--wait-for-timeout ', 'wait for given timeout in milliseconds before saving as pdf'], - ]).action(function(url, filename, options) { - pdf(options, options, url, filename).catch(logErrorAndExit); -}).addHelpText('afterAll', ` -Examples: - - $ pdf https://example.com example.pdf`); - -program - .command('run-driver', { hidden: true }) - .action(function(options) { - runDriver(); - }); - -program - .command('run-server', { hidden: true }) - .option('--port ', 'Server port') - .option('--path ', 'Endpoint Path', '/') - .option('--max-clients ', 'Maximum clients') - .action(function(options) { - runServer({ - port: options.port ? +options.port : undefined, - path: options.path, - maxConnections: options.maxClients ? +options.maxClients : Infinity, - }).catch(logErrorAndExit); - }); - -program - .command('print-api-json', { hidden: true }) - .action(function(options) { - printApiJson(); - }); - -program - .command('launch-server', { hidden: true }) - .requiredOption('--browser ', 'Browser name, one of "chromium", "firefox" or "webkit"') - .option('--config ', 'JSON file with launchServer options') - .action(function(options) { - launchBrowserServer(options.browser, options.config); - }); - -program - .command('show-trace [trace...]') - .option('-b, --browser ', 'browser to use, one of cr, chromium, ff, firefox, wk, webkit', 'chromium') - .option('-h, --host ', 'Host to serve trace on', 'localhost') - .option('-p, --port ', 'Port to serve trace on', '9322') - .description('show trace viewer') - .action(function(traces, options) { - if (options.browser === 'cr') - options.browser = 'chromium'; - if (options.browser === 'ff') - options.browser = 'firefox'; - if (options.browser === 'wk') - options.browser = 'webkit'; - - showTraceViewer(traces, options.browser, { headless: false, host: options.host, port: +options.port }).catch(logErrorAndExit); - }).addHelpText('afterAll', ` -Examples: - - $ show-trace https://example.com/trace.zip`); - -if (!process.env.PW_LANG_NAME) { - let playwrightTestPackagePath = null; - const resolvePwTestPaths = [__dirname, process.cwd()]; - try { - playwrightTestPackagePath = require.resolve('@playwright/test/lib/cli', { - paths: resolvePwTestPaths, - }); - } catch {} - - if (playwrightTestPackagePath) { - const pwTestVersion = require(require.resolve('@playwright/test/package.json', { - paths: resolvePwTestPaths, - })).version; - const pwCoreVersion = require(path.join(__dirname, '../../package.json')).version; - if (pwTestVersion !== pwCoreVersion) { - let hasPlaywrightPackage = false; - try { - require('playwright'); - hasPlaywrightPackage = true; - } catch {} - const strayPackage = hasPlaywrightPackage ? 'playwright' : 'playwright-core'; - console.error(wrapInASCIIBox([ - `Playwright Test integrity check failed:`, - `You have @playwright/test version '${pwTestVersion}' and '${strayPackage}' version '${pwCoreVersion}' installed!`, - `You probably added '${strayPackage}' into your package.json by accident, remove it and re-run 'npm install'`, - ].join('\n'), 1)); - process.exit(1); - } - - require(playwrightTestPackagePath).addTestCommands(program); - } else { - { - const command = program.command('test').allowUnknownOption(true); - command.description('Run tests with Playwright Test. Available in @playwright/test package.'); - command.action(async () => { - console.error('Please install @playwright/test package to use Playwright Test.'); - console.error(' npm install -D @playwright/test'); - process.exit(1); - }); - } - - { - const command = program.command('show-report').allowUnknownOption(true); - command.description('Show Playwright Test HTML report. Available in @playwright/test package.'); - command.action(async () => { - console.error('Please install @playwright/test package to use Playwright Test.'); - console.error(' npm install -D @playwright/test'); - process.exit(1); - }); - } - } -} - -program.parse(process.argv); - -type Options = { - browser: string; - channel?: string; - colorScheme?: string; - device?: string; - geolocation?: string; - ignoreHttpsErrors?: boolean; - lang?: string; - loadStorage?: string; - proxyServer?: string; - proxyBypass?: string; - blockServiceWorkers?: boolean; - saveHar?: string; - saveHarGlob?: string; - saveStorage?: string; - saveTrace?: string; - timeout: string; - timezone?: string; - viewportSize?: string; - userAgent?: string; -}; - -type CaptureOptions = { - waitForSelector?: string; - waitForTimeout?: string; - fullPage: boolean; -}; - -async function launchContext(options: Options, headless: boolean, executablePath?: string): Promise<{ browser: Browser, browserName: string, launchOptions: LaunchOptions, contextOptions: BrowserContextOptions, context: BrowserContext }> { - validateOptions(options); - const browserType = lookupBrowserType(options); - const launchOptions: LaunchOptions = { headless, executablePath }; - if (options.channel) - launchOptions.channel = options.channel as any; - launchOptions.handleSIGINT = false; - - const contextOptions: BrowserContextOptions = - // Copy the device descriptor since we have to compare and modify the options. - options.device ? { ...playwright.devices[options.device] } : {}; - - // In headful mode, use host device scale factor for things to look nice. - // In headless, keep things the way it works in Playwright by default. - // Assume high-dpi on MacOS. TODO: this is not perfect. - if (!headless) - contextOptions.deviceScaleFactor = os.platform() === 'darwin' ? 2 : 1; - - // Work around the WebKit GTK scrolling issue. - if (browserType.name() === 'webkit' && process.platform === 'linux') { - delete contextOptions.hasTouch; - delete contextOptions.isMobile; - } - - if (contextOptions.isMobile && browserType.name() === 'firefox') - contextOptions.isMobile = undefined; - - if (options.blockServiceWorkers) - contextOptions.serviceWorkers = 'block'; - - // Proxy - - if (options.proxyServer) { - launchOptions.proxy = { - server: options.proxyServer - }; - if (options.proxyBypass) - launchOptions.proxy.bypass = options.proxyBypass; - } - - const browser = await browserType.launch(launchOptions); - - if (process.env.PWTEST_CLI_IS_UNDER_TEST) { - (process as any)._didSetSourcesForTest = (text: string) => { - process.stdout.write('\n-------------8<-------------\n'); - process.stdout.write(text); - process.stdout.write('\n-------------8<-------------\n'); - const autoExitCondition = process.env.PWTEST_CLI_AUTO_EXIT_WHEN; - if (autoExitCondition && text.includes(autoExitCondition)) - Promise.all(context.pages().map(async p => p.close())); - }; - // Make sure we exit abnormally when browser crashes. - const logs: string[] = []; - require('playwright-core/lib/utilsBundle').debug.log = (...args: any[]) => { - const line = require('util').format(...args) + '\n'; - logs.push(line); - process.stderr.write(line); - }; - browser.on('disconnected', () => { - const hasCrashLine = logs.some(line => line.includes('process did exit:') && !line.includes('process did exit: exitCode=0, signal=null')); - if (hasCrashLine) { - process.stderr.write('Detected browser crash.\n'); - process.exit(1); - } - }); - } - - // Viewport size - if (options.viewportSize) { - try { - const [width, height] = options.viewportSize.split(',').map(n => parseInt(n, 10)); - contextOptions.viewport = { width, height }; - } catch (e) { - console.log('Invalid window size format: use "width, height", for example --window-size=800,600'); - process.exit(0); - } - } - - // Geolocation - - if (options.geolocation) { - try { - const [latitude, longitude] = options.geolocation.split(',').map(n => parseFloat(n.trim())); - contextOptions.geolocation = { - latitude, - longitude - }; - } catch (e) { - console.log('Invalid geolocation format: user lat, long, for example --geolocation="37.819722,-122.478611"'); - process.exit(0); - } - contextOptions.permissions = ['geolocation']; - } - - // User agent - - if (options.userAgent) - contextOptions.userAgent = options.userAgent; - - // Lang - - if (options.lang) - contextOptions.locale = options.lang; - - // Color scheme - - if (options.colorScheme) - contextOptions.colorScheme = options.colorScheme as 'dark' | 'light'; - - // Timezone - - if (options.timezone) - contextOptions.timezoneId = options.timezone; - - // Storage - - if (options.loadStorage) - contextOptions.storageState = options.loadStorage; - - if (options.ignoreHttpsErrors) - contextOptions.ignoreHTTPSErrors = true; - - // HAR - - if (options.saveHar) { - contextOptions.recordHar = { path: path.resolve(process.cwd(), options.saveHar), mode: 'minimal' }; - if (options.saveHarGlob) - contextOptions.recordHar.urlFilter = options.saveHarGlob; - contextOptions.serviceWorkers = 'block'; - } - - // Close app when the last window closes. - - const context = await browser.newContext(contextOptions); - - let closingBrowser = false; - async function closeBrowser() { - // We can come here multiple times. For example, saving storage creates - // a temporary page and we call closeBrowser again when that page closes. - if (closingBrowser) - return; - closingBrowser = true; - if (options.saveTrace) - await context.tracing.stop({ path: options.saveTrace }); - if (options.saveStorage) - await context.storageState({ path: options.saveStorage }).catch(e => null); - if (options.saveHar) - await context.close(); - await browser.close(); - } - - context.on('page', page => { - page.on('dialog', () => {}); // Prevent dialogs from being automatically dismissed. - page.on('close', () => { - const hasPage = browser.contexts().some(context => context.pages().length > 0); - if (hasPage) - return; - // Avoid the error when the last page is closed because the browser has been closed. - closeBrowser().catch(e => null); - }); - }); - process.on('SIGINT', async () => { - await closeBrowser(); - process.exit(130); - }); - - const timeout = options.timeout ? parseInt(options.timeout, 10) : 0; - context.setDefaultTimeout(timeout); - context.setDefaultNavigationTimeout(timeout); - - if (options.saveTrace) - await context.tracing.start({ screenshots: true, snapshots: true }); - - // Omit options that we add automatically for presentation purpose. - delete launchOptions.headless; - delete launchOptions.executablePath; - delete launchOptions.handleSIGINT; - delete contextOptions.deviceScaleFactor; - return { browser, browserName: browserType.name(), context, contextOptions, launchOptions }; -} - -async function openPage(context: BrowserContext, url: string | undefined): Promise { - const page = await context.newPage(); - if (url) { - if (fs.existsSync(url)) - url = 'file://' + path.resolve(url); - else if (!url.startsWith('http') && !url.startsWith('file://') && !url.startsWith('about:') && !url.startsWith('data:')) - url = 'http://' + url; - await page.goto(url).catch(error => { - if (process.env.PWTEST_CLI_AUTO_EXIT_WHEN && error.message.includes('Navigation failed because page was closed')) { - // Tests with PWTEST_CLI_AUTO_EXIT_WHEN might close page too fast, resulting - // in a stray navigation aborted error. We should ignore it. - } else { - throw error; - } - }); - } - return page; -} - -async function open(options: Options, url: string | undefined, language: string) { - const { context, launchOptions, contextOptions } = await launchContext(options, !!process.env.PWTEST_CLI_HEADLESS, process.env.PWTEST_CLI_EXECUTABLE_PATH); - await context._enableRecorder({ - language, - launchOptions, - contextOptions, - device: options.device, - saveStorage: options.saveStorage, }); - await openPage(context, url); } -async function codegen(options: Options, url: string | undefined, language: string, outputFile?: string) { - const { context, launchOptions, contextOptions } = await launchContext(options, !!process.env.PWTEST_CLI_HEADLESS, process.env.PWTEST_CLI_EXECUTABLE_PATH); - await context._enableRecorder({ - language, - launchOptions, - contextOptions, - device: options.device, - saveStorage: options.saveStorage, - mode: 'recording', - outputFile: outputFile ? path.resolve(outputFile) : undefined, - handleSIGINT: false, +{ + const command = program.command('show-report').allowUnknownOption(true); + command.description('Show Playwright Test HTML report. Available in @playwright/test package.'); + command.action(async () => { + console.error('Please install @playwright/test package to use Playwright Test.'); + console.error(' npm install -D @playwright/test'); + process.exit(1); }); - await openPage(context, url); -} - -async function waitForPage(page: Page, captureOptions: CaptureOptions) { - if (captureOptions.waitForSelector) { - console.log(`Waiting for selector ${captureOptions.waitForSelector}...`); - await page.waitForSelector(captureOptions.waitForSelector); - } - if (captureOptions.waitForTimeout) { - console.log(`Waiting for timeout ${captureOptions.waitForTimeout}...`); - await page.waitForTimeout(parseInt(captureOptions.waitForTimeout, 10)); - } } -async function screenshot(options: Options, captureOptions: CaptureOptions, url: string, path: string) { - const { context } = await launchContext(options, true); - console.log('Navigating to ' + url); - const page = await openPage(context, url); - await waitForPage(page, captureOptions); - console.log('Capturing screenshot into ' + path); - await page.screenshot({ path, fullPage: !!captureOptions.fullPage }); - // launchContext takes care of closing the browser. - await page.close(); -} - -async function pdf(options: Options, captureOptions: CaptureOptions, url: string, path: string) { - if (options.browser !== 'chromium') { - console.error('PDF creation is only working with Chromium'); +{ + const command = program.command('show-trace').allowUnknownOption(true); + command.description('Show Playwright Trace. Available in @playwright/test package.'); + command.action(async () => { + console.error('Please install @playwright/test package to use Playwright Test.'); + console.error(' npm install -D @playwright/test'); process.exit(1); - } - const { context } = await launchContext({ ...options, browser: 'chromium' }, true); - console.log('Navigating to ' + url); - const page = await openPage(context, url); - await waitForPage(page, captureOptions); - console.log('Saving as pdf into ' + path); - await page.pdf!({ path }); - // launchContext takes care of closing the browser. - await page.close(); -} - -function lookupBrowserType(options: Options): BrowserType { - let name = options.browser; - if (options.device) { - const device = playwright.devices[options.device]; - name = device.defaultBrowserType; - } - let browserType: any; - switch (name) { - case 'chromium': browserType = playwright.chromium; break; - case 'webkit': browserType = playwright.webkit; break; - case 'firefox': browserType = playwright.firefox; break; - case 'cr': browserType = playwright.chromium; break; - case 'wk': browserType = playwright.webkit; break; - case 'ff': browserType = playwright.firefox; break; - } - if (browserType) - return browserType; - program.help(); - process.exit(1); -} - -function validateOptions(options: Options) { - if (options.device && !(options.device in playwright.devices)) { - console.log(`Device descriptor not found: '${options.device}', available devices are:`); - for (const name in playwright.devices) - console.log(` "${name}"`); - process.exit(0); - } - if (options.colorScheme && !['light', 'dark'].includes(options.colorScheme)) { - console.log('Invalid color scheme, should be one of "light", "dark"'); - process.exit(0); - } -} - -function logErrorAndExit(e: Error) { - console.error(e); - process.exit(1); -} - -function codegenId(): string { - return process.env.PW_LANG_NAME || 'playwright-test'; -} - -function commandWithOpenOptions(command: string, description: string, options: any[][]): Command { - let result = program.command(command).description(description); - for (const option of options) - result = result.option(option[0], ...option.slice(1)); - return result - .option('-b, --browser ', 'browser to use, one of cr, chromium, ff, firefox, wk, webkit', 'chromium') - .option('--block-service-workers', 'block service workers') - .option('--channel ', 'Chromium distribution channel, "chrome", "chrome-beta", "msedge-dev", etc') - .option('--color-scheme ', 'emulate preferred color scheme, "light" or "dark"') - .option('--device ', 'emulate device, for example "iPhone 11"') - .option('--geolocation ', 'specify geolocation coordinates, for example "37.819722,-122.478611"') - .option('--ignore-https-errors', 'ignore https errors') - .option('--load-storage ', 'load context storage state from the file, previously saved with --save-storage') - .option('--lang ', 'specify language / locale, for example "en-GB"') - .option('--proxy-server ', 'specify proxy server, for example "http://myproxy:3128" or "socks5://myproxy:8080"') - .option('--proxy-bypass ', 'comma-separated domains to bypass proxy, for example ".com,chromium.org,.domain.com"') - .option('--save-har ', 'save HAR file with all network activity at the end') - .option('--save-har-glob ', 'filter entries in the HAR by matching url against this glob pattern') - .option('--save-storage ', 'save context storage state at the end, for later use with --load-storage') - .option('--timezone