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(test runner): unify handling of cliArgs with other filters (#40033)
Dmitry Gozmanf5932b9c99bf
diff --git a/packages/playwright/src/common/suiteUtils.ts b/packages/playwright/src/common/suiteUtils.tsindex 4108a9696e..61389b1076 100644--- a/packages/playwright/src/common/suiteUtils.ts+++ b/packages/playwright/src/common/suiteUtils.ts@@ -17,23 +17,11 @@import path from 'path';import { calculateSha1, toPosixPath } from 'playwright-core/lib/utils';--import { createFileMatcher } from '../util';+import { createFileMatcher, forceRegExp, parseLocationArg } from '../util';import type { FullProjectInternal } from './config';import type { Suite, TestCase } from './test';-import type { TestCaseFilter, TestFileFilter } from '../util';---export function filterSuite(suite: Suite, suiteFilter: (suites: Suite) => boolean, testFilter: TestCaseFilter) {- for (const child of suite.suites) {- if (!suiteFilter(child))- filterSuite(child, suiteFilter, testFilter);- }- const filteredTests = suite.tests.filter(testFilter);- const entries = new Set([...suite.suites, ...filteredTests]);- suite._entries = suite._entries.filter(e => entries.has(e)); // Preserve the order.-}+import type { Matcher, TestCaseFilter } from '../util';export function filterTestsRemoveEmptySuites(suite: Suite, filter: TestCaseFilter): boolean {const filteredSuites = suite.suites.filter(child => filterTestsRemoveEmptySuites(child, filter));@@ -111,7 +99,7 @@ export function filterOnly(suite: Suite) {return filterSuiteWithOnlySemantics(suite, suiteFilter, testFilter);}-function filterSuiteWithOnlySemantics(suite: Suite, suiteFilter: (suites: Suite) => boolean, testFilter: TestCaseFilter) {+function filterSuiteWithOnlySemantics(suite: Suite, suiteFilter: (suite: Suite) => boolean, testFilter: TestCaseFilter) {const onlySuites = suite.suites.filter(child => filterSuiteWithOnlySemantics(child, suiteFilter, testFilter) || suiteFilter(child));const onlyTests = suite.tests.filter(testFilter);const onlyEntries = new Set([...onlySuites, ...onlyTests]);@@ -122,18 +110,23 @@ function filterSuiteWithOnlySemantics(suite: Suite, suiteFilter: (suites: Suite)return false;}-export function filterByFocusedLine(suite: Suite, focusedTestFileLines: TestFileFilter[]) {- if (!focusedTestFileLines.length)- return;- const matchers = focusedTestFileLines.map(createFileMatcherFromFilter);- const testFileLineMatches = (testFileName: string, testLine: number, testColumn: number) => matchers.some(m => m(testFileName, testLine, testColumn));- const suiteFilter = (suite: Suite) => !!suite.location && testFileLineMatches(suite.location.file, suite.location.line, suite.location.column);- const testFilter = (test: TestCase) => testFileLineMatches(test.location.file, test.location.line, test.location.column);- return filterSuite(suite, suiteFilter, testFilter);-}+export function createFiltersFromArguments(args: string[]): { fileFilter: Matcher, testFilter: TestCaseFilter } {+ const matchers = args.map(arg => {+ const parsed = parseLocationArg(arg);+ const fileMatcher = createFileMatcher(forceRegExp(parsed.file));+ const locationMatcher = (file: string, line: number, column: number) => fileMatcher(file) && (parsed.line === line || parsed.line === null) && (parsed.column === column || parsed.column === null);+ return { fileMatcher, locationMatcher };+ });-function createFileMatcherFromFilter(filter: TestFileFilter) {- const fileMatcher = createFileMatcher(filter.re || filter.exact || '');- return (testFileName: string, testLine: number, testColumn: number) =>- fileMatcher(testFileName) && (filter.line === testLine || filter.line === null) && (filter.column === testColumn || filter.column === null);+ const fileFilter = (file: string) => matchers.some(m => m.fileMatcher(file));+ const locationMatcher = (file: string, line: number, column: number) => matchers.some(m => m.locationMatcher(file, line, column));+ const testFilter = (test: TestCase) => {+ // If any suite matches the filter, always include all tests.+ for (let suite: Suite | undefined = test.parent; suite; suite = suite.parent) {+ if (suite.location && locationMatcher(suite.location.file, suite.location.line, suite.location.column))+ return true;+ }+ return locationMatcher(test.location.file, test.location.line, test.location.column);+ };+ return { fileFilter, testFilter };}diff --git a/packages/playwright/src/runner/loadUtils.ts b/packages/playwright/src/runner/loadUtils.tsindex 1f885288bf..07979c2d8f 100644--- a/packages/playwright/src/runner/loadUtils.ts+++ b/packages/playwright/src/runner/loadUtils.ts@@ -19,10 +19,10 @@ import fs from 'fs';import { toPosixPath } from 'playwright-core/lib/utils';import { InProcessLoaderHost, OutOfProcessLoaderHost } from './loaderHost';-import { createFileFiltersFromArguments, createTitleMatcher, errorWithFile, forceRegExp, parseLocationArg } from '../util';+import { createTitleMatcher, errorWithFile, parseLocationArg } from '../util';import { buildProjectsClosure, collectFilesForProject, filterProjects } from './projectUtils';import { createTestGroups, filterForShard } from './testGroups';-import { applyRepeatEachIndex, bindFileSuiteToProject, filterByFocusedLine, filterOnly, filterTestsRemoveEmptySuites } from '../common/suiteUtils';+import { applyRepeatEachIndex, bindFileSuiteToProject, filterOnly, filterTestsRemoveEmptySuites } from '../common/suiteUtils';import { Suite } from '../common/test';import { dependenciesForTestFile } from '../transform/compilationCache';import { requireOrImport } from '../transform/transform';@@ -34,7 +34,7 @@ import type { FullConfig, Reporter, TestError } from '../../types/testReporter';import type { FullProjectInternal } from '../common/config';import type { FullConfigInternal } from '../common/config';import type { TestCase } from '../common/test';-import type { Matcher, TestCaseFilter, TestFileFilter } from '../util';+import type { Matcher, TestCaseFilter } from '../util';import type { RawSourceMap } from '../utilsBundle';@@ -131,20 +131,13 @@ export async function createRootSuite(testRun: TestRun, errors: TestError[], shoconst projectSuites = new Map<FullProjectInternal, Suite>();const filteredProjectSuites = new Map<FullProjectInternal, Suite>();- // Filter all the projects using grep, testId, file names.+ // Filter all the projects using grep, testId, file names, etc.{- // Interpret cli parameters.- const cliFileFilters = createFileFiltersFromArguments(config.cliArgs);- const grepMatcher = config.cliGrep ? createTitleMatcher(forceRegExp(config.cliGrep)) : () => true;- const grepInvertMatcher = config.cliGrepInvert ? createTitleMatcher(forceRegExp(config.cliGrepInvert)) : () => false;- const cliTitleMatcher = (title: string) => !grepInvertMatcher(title) && grepMatcher(title);-- // Filter file suites for all projects.for (const [project, fileSuites] of testRun.projectSuites) {const projectSuite = createProjectSuite(project, fileSuites);projectSuites.set(project, projectSuite);- const filteredProjectSuite = filterProjectSuite(projectSuite, { cliFileFilters, cliTitleMatcher, testFilters: config.preOnlyTestFilters });+ const filteredProjectSuite = filterProjectSuite(projectSuite, config.preOnlyTestFilters);filteredProjectSuites.set(project, filteredProjectSuite);}}@@ -240,21 +233,13 @@ function createProjectSuite(project: FullProjectInternal, fileSuites: Suite[]):return projectSuite;}-function filterProjectSuite(projectSuite: Suite, options: { cliFileFilters: TestFileFilter[], cliTitleMatcher?: Matcher, testFilters: TestCaseFilter[] }): Suite {+function filterProjectSuite(projectSuite: Suite, testFilters: TestCaseFilter[]): Suite {// Fast path.- if (!options.cliFileFilters.length && !options.cliTitleMatcher && !options.testFilters.length)+ if (!testFilters.length)return projectSuite;const result = projectSuite._deepClone();- if (options.cliFileFilters.length)- filterByFocusedLine(result, options.cliFileFilters);- filterTestsRemoveEmptySuites(result, (test: TestCase) => {- if (!options.testFilters.every(filter => filter(test)))- return false;- if (options.cliTitleMatcher && !options.cliTitleMatcher(test._grepTitleWithTags()))- return false;- return true;- });+ filterTestsRemoveEmptySuites(result, test => testFilters.every(filter => filter(test)));return result;}diff --git a/packages/playwright/src/runner/tasks.ts b/packages/playwright/src/runner/tasks.tsindex 0a621da1a0..15bd7b2784 100644--- a/packages/playwright/src/runner/tasks.ts+++ b/packages/playwright/src/runner/tasks.ts@@ -31,7 +31,8 @@ import { detectChangedTestFiles } from './vcs';import { Suite } from '../common/test';import { createTestGroups } from '../runner/testGroups';import { cacheDir } from '../transform/compilationCache';-import { createFileMatcherFromArguments, removeDirAndLogToConsole } from '../util';+import { createTitleMatcher, forceRegExp, removeDirAndLogToConsole } from '../util';+import { createFiltersFromArguments } from '../common/suiteUtils';import type { TestGroup } from '../runner/testGroups';import type { EnvByProjectId } from './dispatcher';@@ -258,8 +259,11 @@ export function createLoadTask(mode: 'out-of-process' | 'in-process', options: {return {title: 'load tests',setup: async (testRun, errors, softErrors) => {- if (testRun.config.cliArgs.length)- testRun.config.loadFileFilters.push(createFileMatcherFromArguments(testRun.config.cliArgs));+ if (testRun.config.cliArgs.length) {+ const { testFilter, fileFilter } = createFiltersFromArguments(testRun.config.cliArgs);+ testRun.config.loadFileFilters.push(fileFilter);+ testRun.config.preOnlyTestFilters.push(testFilter);+ }if (testRun.config.cliTestList) {const { testFilter, fileFilter } = await loadTestList(testRun.config, testRun.config.cliTestList);@@ -276,6 +280,15 @@ export function createLoadTask(mode: 'out-of-process' | 'in-process', options: {testRun.config.preOnlyTestFilters.push(test => !testFilter(test));}+ if (testRun.config.cliGrep || testRun.config.cliGrepInvert) {+ const grepMatcher = testRun.config.cliGrep ? createTitleMatcher(forceRegExp(testRun.config.cliGrep)) : () => true;+ const grepInvertMatcher = testRun.config.cliGrepInvert ? createTitleMatcher(forceRegExp(testRun.config.cliGrepInvert)) : () => false;+ testRun.config.preOnlyTestFilters.push(test => {+ const grepTitle = test._grepTitleWithTags();+ return !grepInvertMatcher(grepTitle) && grepMatcher(grepTitle);+ });+ }+await collectProjectsAndTestFiles(testRun, !!options.doNotRunDepsOutsideProjectFilter);await loadFileSuites(testRun, mode, options.failOnLoadErrors ? errors : softErrors);diff --git a/packages/playwright/src/util.ts b/packages/playwright/src/util.tsindex bb15feceec..3da87f30c8 100644--- a/packages/playwright/src/util.ts+++ b/packages/playwright/src/util.ts@@ -75,14 +75,6 @@ export function serializeError(error: Error | any): TestInfoErrorImpl {}export type Matcher = (value: string) => boolean;--export type TestFileFilter = {- re?: RegExp;- exact?: string;- line: number | null;- column: number | null;-};-export type TestCaseFilter = (test: TestCase) => boolean;export function parseLocationArg(arg: string): { file: string, line: number | null, column: number | null } {@@ -94,18 +86,6 @@ export function parseLocationArg(arg: string): { file: string, line: number | nu};}-export function createFileFiltersFromArguments(args: string[]): TestFileFilter[] {- return args.map(arg => {- const parsed = parseLocationArg(arg);- return { re: forceRegExp(parsed.file), line: parsed.line, column: parsed.column };- });-}--export function createFileMatcherFromArguments(args: string[]): Matcher {- const filters = createFileFiltersFromArguments(args);- return createFileMatcher(filters.map(filter => filter.re || filter.exact || ''));-}-export function createFileMatcher(patterns: string | RegExp | (string | RegExp)[]): Matcher {const reList: RegExp[] = [];const filePatterns: string[] = [];