Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

chore(mcp): run seed test in the first top level project by default (#37668)

Yury Semikhatsky63bc19600fe8
diff --git a/packages/playwright/src/mcp/test/generatorTools.ts b/packages/playwright/src/mcp/test/generatorTools.ts
index cf2d0a52ea..318762c922 100644
--- a/packages/playwright/src/mcp/test/generatorTools.ts
+++ b/packages/playwright/src/mcp/test/generatorTools.ts
@@ -35,9 +35,9 @@ export const setupPage = defineTestTool({
},
handle: async (context, params, progress) => {
- const seed = await context.getOrCreateSeedFile(params);
+ const seed = await context.getOrCreateSeedFile(params.seedFile, params.project);
context.generatorJournal = new GeneratorJournal(context.rootPath, params.plan, seed);
- await context.runSeedTest(seed.file, params.project, progress);
+ await context.runSeedTest(seed.file, seed.projectName, progress);
return { content: [] };
},
});
diff --git a/packages/playwright/src/mcp/test/plannerTools.ts b/packages/playwright/src/mcp/test/plannerTools.ts
index 5fc7d41e4d..02ef964151 100644
--- a/packages/playwright/src/mcp/test/plannerTools.ts
+++ b/packages/playwright/src/mcp/test/plannerTools.ts
@@ -30,8 +30,8 @@ export const setupPage = defineTestTool({
},
handle: async (context, params, progress) => {
- const seed = await context.getOrCreateSeedFile(params);
- await context.runSeedTest(seed.file, params.project, progress);
+ const seed = await context.getOrCreateSeedFile(params.seedFile, params.project);
+ await context.runSeedTest(seed.file, seed.projectName, progress);
return { content: [] };
},
});
diff --git a/packages/playwright/src/mcp/test/seed.ts b/packages/playwright/src/mcp/test/seed.ts
index 849315c438..346ef1dfd2 100644
--- a/packages/playwright/src/mcp/test/seed.ts
+++ b/packages/playwright/src/mcp/test/seed.ts
@@ -21,7 +21,7 @@ import { mkdirIfNeeded } from 'playwright-core/lib/utils';
import { collectFilesForProject, findTopLevelProjects } from '../../runner/projectUtils';
-import type { FullConfigInternal } from '../../common/config';
+import type { FullConfigInternal, FullProjectInternal } from '../../common/config';
export function seedProject(config: FullConfigInternal, projectName?: string) {
if (!projectName)
@@ -32,8 +32,7 @@ export function seedProject(config: FullConfigInternal, projectName?: string) {
return project;
}
-export async function ensureSeedTest(config: FullConfigInternal, projectName: string | undefined, logNew: boolean) {
- const project = seedProject(config, projectName);
+export async function ensureSeedTest(project: FullProjectInternal, logNew: boolean) {
const files = await collectFilesForProject(project);
const seed = files.find(file => path.basename(file).includes('seed'));
if (seed)
diff --git a/packages/playwright/src/mcp/test/testContext.ts b/packages/playwright/src/mcp/test/testContext.ts
index d8d4b27192..fc9271939e 100644
--- a/packages/playwright/src/mcp/test/testContext.ts
+++ b/packages/playwright/src/mcp/test/testContext.ts
@@ -98,35 +98,41 @@ export class TestContext {
return testRunner;
}
- async getOrCreateSeedFile(params: { project?: string, seedFile?: string }) {
+ async getOrCreateSeedFile(seedFile: string | undefined, projectName: string | undefined) {
const configDir = this.configLocation.configDir;
const testRunner = await this.createTestRunner();
const config = await testRunner.loadConfig();
+ const project = seedProject(config, projectName);
- let seedFile: string | undefined;
- if (!params.seedFile) {
- seedFile = await ensureSeedTest(config, params.project, false);
+ if (!seedFile) {
+ seedFile = await ensureSeedTest(project, false);
} else {
const candidateFiles: string[] = [];
- const testDir = seedProject(config, params.project).project.testDir;
- candidateFiles.push(path.resolve(testDir, params.seedFile));
- candidateFiles.push(path.resolve(configDir, params.seedFile));
- candidateFiles.push(path.resolve(this.rootPath, params.seedFile));
+ const testDir = project.project.testDir;
+ candidateFiles.push(path.resolve(testDir, seedFile));
+ candidateFiles.push(path.resolve(configDir, seedFile));
+ candidateFiles.push(path.resolve(this.rootPath, seedFile));
+ let resolvedSeedFile: string | undefined;
for (const candidateFile of candidateFiles) {
if (await fileExistsAsync(candidateFile)) {
- seedFile = candidateFile;
+ resolvedSeedFile = candidateFile;
break;
}
}
- if (!seedFile)
+ if (!resolvedSeedFile)
throw new Error('seed test not found.');
+ seedFile = resolvedSeedFile;
}
const seedFileContent = await fs.promises.readFile(seedFile, 'utf8');
- return { file: seedFile, content: seedFileContent };
+ return {
+ file: seedFile,
+ content: seedFileContent,
+ projectName: project.project.name,
+ };
}
- async runSeedTest(seedFile: string, projectName: string | undefined, progress: ProgressCallback) {
+ async runSeedTest(seedFile: string, projectName: string, progress: ProgressCallback) {
const { screen } = this.createScreen(progress);
const configDir = this.configLocation.configDir;
const reporter = new ListReporter({ configDir, screen });
@@ -135,7 +141,7 @@ export class TestContext {
const result = await testRunner.runTests(reporter, {
headed: !this.options?.headless,
locations: ['/' + escapeRegExp(seedFile) + '/'],
- projects: projectName ? [projectName] : undefined,
+ projects: [projectName],
timeout: 0,
workers: 1,
pauseAtEnd: true,
diff --git a/packages/playwright/src/program.ts b/packages/playwright/src/program.ts
index 4180153327..7ea4813d20 100644
--- a/packages/playwright/src/program.ts
+++ b/packages/playwright/src/program.ts
@@ -35,7 +35,7 @@ import { runAllTestsWithConfig, TestRunner } from './runner/testRunner';
import { createErrorCollectingReporter } from './runner/reporters';
import { ServerBackendFactory, runMainBackend } from './mcp/sdk/exports';
import { TestServerBackend } from './mcp/test/testBackend';
-import { ensureSeedTest } from './mcp/test/seed';
+import { ensureSeedTest, seedProject } from './mcp/test/seed';
import { decorateCommand } from './mcp/program';
import { setupExitWatchdog } from './mcp/browser/watchdog';
import { initClaudeCodeRepo, initOpencodeRepo, initVSCodeRepo } from './agents/generateAgents';
@@ -200,7 +200,8 @@ function addInitAgentsCommand(program: Command) {
return;
}
const config = await loadConfigFromFile(opts.config);
- await ensureSeedTest(config, opts.project, true);
+ const project = seedProject(config, opts.project);
+ await ensureSeedTest(project, true);
});
}
diff --git a/tests/mcp/seed-default-project.spec.ts b/tests/mcp/seed-default-project.spec.ts
new file mode 100644
index 0000000000..c0acdef706
--- /dev/null
+++ b/tests/mcp/seed-default-project.spec.ts
@@ -0,0 +1,107 @@
+/**
+ * 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.
+ */
+
+import fs from 'fs';
+import path from 'path';
+import { test, expect, writeFiles } from './fixtures';
+
+test.use({ mcpServerType: 'test-mcp' });
+
+test('seed test runs in first top-level project by default', async ({ startClient }) => {
+ const baseDir = await writeFiles({
+ 'playwright.config.ts': `
+ module.exports = {
+ projects: [
+ { name: 'first-project', testDir: './first' },
+ { name: 'second-project', testDir: './second' },
+ { name: 'third-project', testDir: './third' },
+ ],
+ };
+ `,
+ });
+
+ const { client } = await startClient();
+
+ // Call planner_setup_page without specifying a project - should use first top-level project
+ expect(await client.callTool({
+ name: 'planner_setup_page',
+ arguments: {},
+ })).toHaveTextResponse(expect.stringContaining(`### Paused at end of test. ready for interaction`));
+
+ // Verify seed.spec.ts was created in the first project's testDir
+ expect(fs.existsSync(path.join(baseDir, 'first', 'seed.spec.ts'))).toBe(true);
+ expect(fs.existsSync(path.join(baseDir, 'second', 'seed.spec.ts'))).toBe(false);
+ expect(fs.existsSync(path.join(baseDir, 'third', 'seed.spec.ts'))).toBe(false);
+});
+
+test('seed test runs in first top-level project with dependencies', async ({ startClient }) => {
+ const baseDir = await writeFiles({
+ 'playwright.config.ts': `
+ module.exports = {
+ projects: [
+ { name: 'setup', testDir: './setup', testMatch: /.*setup\\.ts/ },
+ { name: 'first-top-level', testDir: './first', dependencies: ['setup'] },
+ { name: 'second-top-level', testDir: './second', dependencies: ['setup'] },
+ { name: 'third-top-level', testDir: './third' },
+ ],
+ };
+ `,
+ });
+
+ const { client } = await startClient();
+
+ // Call planner_setup_page without specifying a project
+ // Should use the first top-level project (first-top-level, not setup which is a dependency)
+ expect(await client.callTool({
+ name: 'planner_setup_page',
+ arguments: {},
+ })).toHaveTextResponse(expect.stringContaining(`### Paused at end of test. ready for interaction`));
+
+ // Verify seed.spec.ts was created in the first top-level project's testDir
+ expect(fs.existsSync(path.join(baseDir, 'setup', 'seed.spec.ts'))).toBe(false);
+ expect(fs.existsSync(path.join(baseDir, 'first', 'seed.spec.ts'))).toBe(true);
+ expect(fs.existsSync(path.join(baseDir, 'second', 'seed.spec.ts'))).toBe(false);
+ expect(fs.existsSync(path.join(baseDir, 'third', 'seed.spec.ts'))).toBe(false);
+});
+
+test('generator_setup_page uses first top-level project by default', async ({ startClient }) => {
+ const baseDir = await writeFiles({
+ 'playwright.config.ts': `
+ module.exports = {
+ projects: [
+ { name: 'alpha', testDir: './alpha' },
+ { name: 'beta', testDir: './beta', dependencies: ['alpha'] },
+ { name: 'gamma', testDir: './gamma' },
+ ],
+ };
+ `,
+ });
+
+ const { client } = await startClient();
+
+ // Call generator_setup_page without specifying a project - should use first top-level project
+ expect(await client.callTool({
+ name: 'generator_setup_page',
+ arguments: {
+ plan: 'Test plan for verification',
+ },
+ })).toHaveTextResponse(expect.stringContaining(`### Paused at end of test. ready for interaction`));
+
+ // Verify seed.spec.ts was created in the first project's testDir
+ expect(fs.existsSync(path.join(baseDir, 'alpha', 'seed.spec.ts'))).toBe(false);
+ expect(fs.existsSync(path.join(baseDir, 'beta', 'seed.spec.ts'))).toBe(true);
+ expect(fs.existsSync(path.join(baseDir, 'gamma', 'seed.spec.ts'))).toBe(false);
+});