Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

validate --sharding-mode CLI parameter

Browse source
This commit is contained in:
Mathias Leppich 2024-09-09 15:48:07 +02:00
parent 1eb11ffc0b
commit 0503672cfb
2 changed files with 16 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
packages/playwright/src/program.ts
View file

@ -27,7 +27,7 @@ import { createMergedReport } from './reporters/merge';
import { loadConfigFromFileRestartIfNeeded, loadEmptyConfigForMergeReports, resolveConfigLocation } from './common/configLoader'; import { loadConfigFromFileRestartIfNeeded, loadEmptyConfigForMergeReports, resolveConfigLocation } from './common/configLoader';
import type { ConfigCLIOverrides } from './common/ipc'; import type { ConfigCLIOverrides } from './common/ipc';
import type { TestError } from '../types/testReporter'; import type { TestError } from '../types/testReporter';
import type { TraceMode } from '../types/test'; import type { TraceMode, ShardingMode } from '../types/test';
import { builtInReporters, defaultReporter, defaultTimeout } from './common/config'; import { builtInReporters, defaultReporter, defaultTimeout } from './common/config';
import { program } from 'playwright-core/lib/cli/program'; import { program } from 'playwright-core/lib/cli/program';
export { program } from 'playwright-core/lib/cli/program'; export { program } from 'playwright-core/lib/cli/program';
@ -305,7 +305,7 @@ function overridesFromOptions(options: { [key: string]: any }): ConfigCLIOverrid
retries: options.retries ? parseInt(options.retries, 10) : undefined, retries: options.retries ? parseInt(options.retries, 10) : undefined,
reporter: resolveReporterOption(options.reporter), reporter: resolveReporterOption(options.reporter),
shard: shardPair ? { current: shardPair[0], total: shardPair[1] } : undefined, shard: shardPair ? { current: shardPair[0], total: shardPair[1] } : undefined,
shardingMode: options.shardingMode ? options.shardingMode : undefined, shardingMode: options.shardingMode ? resolveShardingModeOption(options.shardingMode) : undefined,
lastRunFile: options.lastRunFile ? path.resolve(process.cwd(), options.lastRunFile) : undefined, lastRunFile: options.lastRunFile ? path.resolve(process.cwd(), options.lastRunFile) : undefined,
timeout: options.timeout ? parseInt(options.timeout, 10) : undefined, timeout: options.timeout ? parseInt(options.timeout, 10) : undefined,
tsconfig: options.tsconfig ? path.resolve(process.cwd(), options.tsconfig) : undefined, tsconfig: options.tsconfig ? path.resolve(process.cwd(), options.tsconfig) : undefined,
@ -342,6 +342,16 @@ function overridesFromOptions(options: { [key: string]: any }): ConfigCLIOverrid
return overrides; return overrides;
} }
const shardingModes: ShardingMode[] = ['partition', 'round-robin', 'duration-round-robin'];
function resolveShardingModeOption(shardingMode?: string): ShardingMode | undefined {
if (!shardingMode)
return undefined;
if (!shardingModes.includes(shardingMode as ShardingMode))
throw new Error(`Unsupported sharding mode "${shardingMode}", must be one of: ${shardingModes.map(mode => `"${mode}"`).join(', ')}`);
return shardingMode as ShardingMode;
}
function resolveReporterOption(reporter?: string): ReporterDescription[] | undefined { function resolveReporterOption(reporter?: string): ReporterDescription[] | undefined {
if (!reporter || !reporter.length) if (!reporter || !reporter.length)
return undefined; return undefined;
@ -372,7 +382,7 @@ const testOptions: [string, string][] = [
['--headed', `Run tests in headed browsers (default: headless)`], ['--headed', `Run tests in headed browsers (default: headless)`],
['--ignore-snapshots', `Ignore screenshot and snapshot expectations`], ['--ignore-snapshots', `Ignore screenshot and snapshot expectations`],
['--last-failed', `Only re-run the failures`], ['--last-failed', `Only re-run the failures`],
['--last-run-file', `Path to a json file where the last run information is read from and written to (default: .last-run.json)`], ['--last-run-file', `Path to a json file where the last run information is read from and written to (default: test-results/.last-run.json)`],
['--list', `Collect all the tests and report them, but do not run`], ['--list', `Collect all the tests and report them, but do not run`],
['--max-failures <N>', `Stop after the first N failures`], ['--max-failures <N>', `Stop after the first N failures`],
['--no-deps', 'Do not run project dependencies'], ['--no-deps', 'Do not run project dependencies'],

4
packages/playwright/types/test.d.ts vendored
View file

@ -1439,7 +1439,7 @@ interface TestConfig<TestArgs = {}, WorkerArgs = {}> {
* *
* Learn more about [sharding](https://playwright.dev/docs/test-sharding) with Playwright Test. * Learn more about [sharding](https://playwright.dev/docs/test-sharding) with Playwright Test.
*/ */
shardingMode?: "partition"|"round-robin"|"duration-round-robin"; shardingMode?: ShardingMode;
/** /**
* **NOTE** Use * **NOTE** Use
@ -5118,6 +5118,8 @@ export interface PlaywrightWorkerOptions {
video: VideoMode | /** deprecated */ 'retry-with-video' | { mode: VideoMode, size?: ViewportSize }; video: VideoMode | /** deprecated */ 'retry-with-video' | { mode: VideoMode, size?: ViewportSize };
} }
export type ShardingMode = "partition" | "round-robin" | "duration-round-robin";
export type ScreenshotMode = 'off' | 'on' | 'only-on-failure'; export type ScreenshotMode = 'off' | 'on' | 'only-on-failure';
export type TraceMode = 'off' | 'on' | 'retain-on-failure' | 'on-first-retry' | 'on-all-retries' | 'retain-on-first-failure'; export type TraceMode = 'off' | 'on' | 'retain-on-failure' | 'on-first-retry' | 'on-all-retries' | 'retain-on-first-failure';
export type VideoMode = 'off' | 'on' | 'retain-on-failure' | 'on-first-retry'; export type VideoMode = 'off' | 'on' | 'retain-on-failure' | 'on-first-retry';