Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/src/test-agents-js.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,10 @@ npx playwright init-agents --loop=vscode
npx playwright init-agents --loop=claude
```

```bash tab=bash-codex
npx playwright init-agents --loop=codex
```

```bash tab=bash-opencode
npx playwright init-agents --loop=opencode
```
Expand Down
15 changes: 15 additions & 0 deletions packages/isomorphic/stringUtils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -189,6 +189,21 @@ export function parseRegex(regex: string): RegExp {
return new RegExp(source, flags);
}

export function tomlBasicString(value: string): string {
// JSON.stringify produces a valid TOML basic string: escapes \", \\, \n, \r, \t and uses \uXXXX for control chars.
return JSON.stringify(value);
}

export function tomlArray(values: string[]): string {
return `[${values.map(value => tomlBasicString(value)).join(', ')}]`;
}

export function tomlMultilineBasicString(value: string): string {
// Triple-quoted basic string: escape backslashes first, then any literal """ sequences.
const escaped = value.replace(/\\/g, '\\\\').replace(/"""/g, '\\"\\"\\"');
return `"""\n${escaped}\n"""`;
}

// Semicolons removed from [[\]()#;?] to avoid polynomial backtracking
// when both that group and (?:;...)* can match runs of semicolons.
// \d{1,4} relaxed to \d{0,4} so empty params (e.g. ESC[;H) still match.
Expand Down
1 change: 1 addition & 0 deletions packages/playwright/src/agents/DEPS.list
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
[*]
@isomorphic/**
@utils/**
../mcp/test/
node_modules/colors/safe
Expand Down
60 changes: 60 additions & 0 deletions packages/playwright/src/agents/generateAgents.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ import path from 'path';

import colors from 'colors/safe';
import yaml from 'yaml';
import { tomlArray, tomlBasicString, tomlMultilineBasicString } from '@isomorphic/stringUtils';
import { mkdirIfNeeded } from '@utils/fileUtils';

import { defaultSeedFile, findSeedFile, seedFileContent, seedProject } from '../mcp/test/seed';
Expand DownExpand Up@@ -90,6 +91,64 @@ export class ClaudeGenerator {
}
}

export class CodexGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {
await initRepo(fullConfig, projectName, {
promptsFolder: prompts ? '.codex/prompts' : undefined,
});

const agents = await loadAgentSpecs();

await fs.promises.mkdir('.codex/agents', { recursive: true });
for (const agent of agents)
await writeFile(`.codex/agents/${CodexGenerator.codexName(agent)}.toml`, CodexGenerator.agentSpec(agent), '🤖', 'agent definition');

initRepoDone();
}

// Codex's subagent registry rejects hyphenated identifiers at spawn time with
// `error=unknown agent_type '<name>'`. Codex's own documentation only shows
// snake_case names (`pr_explorer`, `reviewer`, `docs_researcher`, ...), see
// https://developers.openai.com/codex/subagents. Translate the shared agent
// name into snake_case so the filename and the `name` field stay in sync.
static codexName(agent: AgentSpec): string {
return agent.name.replace(/-/g, '_');
}

static agentSpec(agent: AgentSpec): string {
const mcpName = 'playwright-test';
const enabledTools: string[] = [];
for (const tool of agent.tools) {
const [first, second] = tool.split('/');
if (second && first === mcpName)
enabledTools.push(second);
}

const sandboxMode = agent.tools.includes('edit') ? 'workspace-write' : 'read-only';
const mcpServer = process.platform === 'win32'
? { command: 'cmd', args: ['/c', 'npx', 'playwright', 'run-test-mcp-server'] }
: { command: 'npx', args: ['playwright', 'run-test-mcp-server'] };

const examples = agent.examples.length
? ` Examples: ${agent.examples.map(example => `<example>${example}</example>`).join('')}`
: '';

const lines: string[] = [];
lines.push(`name = ${tomlBasicString(CodexGenerator.codexName(agent))}`);
lines.push(`description = ${tomlBasicString(agent.description + examples)}`);
lines.push(`sandbox_mode = ${tomlBasicString(sandboxMode)}`);
lines.push(`developer_instructions = ${tomlMultilineBasicString(agent.instructions)}`);
lines.push('');
lines.push(`[mcp_servers.${mcpName}]`);
lines.push(`command = ${tomlBasicString(mcpServer.command)}`);
lines.push(`args = ${tomlArray(mcpServer.args)}`);
if (enabledTools.length)
lines.push(`enabled_tools = ${tomlArray(enabledTools)}`);
lines.push('');
return lines.join('\n');
}
}

export class OpencodeGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {
await initRepo(fullConfig, projectName, {
Expand DownExpand Up@@ -155,6 +214,7 @@ export class OpencodeGenerator {
return JSON.stringify(result, null, 2);
}
}

export class CopilotGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {

Expand Down
6 changes: 4 additions & 2 deletions packages/playwright/src/program.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { builtInReporters, config, configLoader } from './common';
import { runTests, clearCache, runTestServerAction } from './cli/testActions';
import { showReport, mergeReports } from './cli/reportActions';
import { TestServerBackend, testServerBackendTools } from './mcp/test/testBackend';
import { ClaudeGenerator, OpencodeGenerator, VSCodeGenerator, CopilotGenerator } from './agents/generateAgents';
import { ClaudeGenerator, CodexGenerator, OpencodeGenerator, VSCodeGenerator, CopilotGenerator } from './agents/generateAgents';
import { packageJSON } from './package';

export { program };
Expand DownExpand Up@@ -155,7 +155,7 @@ function addInitAgentsCommand(program: Command) {
const command = program.command('init-agents');
command.description('Initialize repository agents');
const option = command.createOption('--loop <loop>', 'Agentic loop provider');
option.choices(['claude', 'copilot', 'opencode', 'vscode', 'vscode-legacy']);
option.choices(['claude', 'codex', 'copilot', 'opencode', 'vscode', 'vscode-legacy']);
command.addOption(option);
command.option('-c, --config <file>', `Configuration file to find a project to use for seed test`);
command.option('--project <project>', 'Project to use for seed test');
Expand All@@ -168,6 +168,8 @@ function addInitAgentsCommand(program: Command) {
await VSCodeGenerator.init(loadedConfig, opts.project);
} else if (opts.loop === 'claude') {
await ClaudeGenerator.init(loadedConfig, opts.project, opts.prompts);
} else if (opts.loop === 'codex') {
await CodexGenerator.init(loadedConfig, opts.project, opts.prompts);
} else {
await CopilotGenerator.init(loadedConfig, opts.project, opts.prompts);
return;
Expand Down
31 changes: 31 additions & 0 deletions tests/mcp/init-agents.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -90,3 +90,34 @@ test('claude generates correct mcp config', async ({ }) => {
expect(mcpJson.mcpServers['playwright-test'].args).toEqual(['playwright', 'run-test-mcp-server']);
}
});

test('codex generates agent toml files', async ({ }) => {
const baseDir = await writeFiles({
'playwright.config.ts': `module.exports = {};`,
});

await runInitAgents({ cwd: baseDir, args: ['--loop', 'codex'] });

const agentsDir = path.join(baseDir, '.codex', 'agents');
expect(fs.existsSync(agentsDir)).toBe(true);

const plannerToml = fs.readFileSync(path.join(agentsDir, 'playwright_test_planner.toml'), 'utf-8');
expect(plannerToml).toContain(`name = "playwright_test_planner"`);
expect(plannerToml).toContain(`[mcp_servers.playwright-test]`);
expect(plannerToml).toContain(`developer_instructions = """`);
Comment thread
0xharkirat marked this conversation as resolved.
if (process.platform === 'win32') {
expect(plannerToml).toContain(`command = "cmd"`);
expect(plannerToml).toContain(`args = ["/c", "npx", "playwright", "run-test-mcp-server"]`);
} else {
expect(plannerToml).toContain(`command = "npx"`);
expect(plannerToml).toContain(`args = ["playwright", "run-test-mcp-server"]`);
}

expect(plannerToml).toContain(`sandbox_mode = "read-only"`);
expect(plannerToml).toMatch(/enabled_tools = \[[^\]]*"planner_save_plan"[^\]]*\]/);
expect(plannerToml).toMatch(/enabled_tools = \[[^\]]*"browser_navigate"[^\]]*\]/);

const healerToml = fs.readFileSync(path.join(agentsDir, 'playwright_test_healer.toml'), 'utf-8');
expect(healerToml).toContain(`sandbox_mode = "workspace-write"`);
expect(healerToml).toMatch(/enabled_tools = \[[^\]]*"test_debug"[^\]]*\]/);
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(agents): add Codex --loop=codex generator by 0xharkirat · Pull Request #40817 · microsoft/playwright · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/src/test-agents-js.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,10 @@ npx playwright init-agents --loop=vscode
npx playwright init-agents --loop=claude
```

```bash tab=bash-codex
npx playwright init-agents --loop=codex
```

```bash tab=bash-opencode
npx playwright init-agents --loop=opencode
```
Expand Down
15 changes: 15 additions & 0 deletions packages/isomorphic/stringUtils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -189,6 +189,21 @@ export function parseRegex(regex: string): RegExp {
return new RegExp(source, flags);
}

export function tomlBasicString(value: string): string {
// JSON.stringify produces a valid TOML basic string: escapes \", \\, \n, \r, \t and uses \uXXXX for control chars.
return JSON.stringify(value);
}

export function tomlArray(values: string[]): string {
return `[${values.map(value => tomlBasicString(value)).join(', ')}]`;
}

export function tomlMultilineBasicString(value: string): string {
// Triple-quoted basic string: escape backslashes first, then any literal """ sequences.
const escaped = value.replace(/\\/g, '\\\\').replace(/"""/g, '\\"\\"\\"');
return `"""\n${escaped}\n"""`;
}

// Semicolons removed from [[\]()#;?] to avoid polynomial backtracking
// when both that group and (?:;...)* can match runs of semicolons.
// \d{1,4} relaxed to \d{0,4} so empty params (e.g. ESC[;H) still match.
Expand Down
1 change: 1 addition & 0 deletions packages/playwright/src/agents/DEPS.list
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
[*]
@isomorphic/**
@utils/**
../mcp/test/
node_modules/colors/safe
Expand Down
60 changes: 60 additions & 0 deletions packages/playwright/src/agents/generateAgents.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ import path from 'path';

import colors from 'colors/safe';
import yaml from 'yaml';
import { tomlArray, tomlBasicString, tomlMultilineBasicString } from '@isomorphic/stringUtils';
import { mkdirIfNeeded } from '@utils/fileUtils';

import { defaultSeedFile, findSeedFile, seedFileContent, seedProject } from '../mcp/test/seed';
Expand DownExpand Up@@ -90,6 +91,64 @@ export class ClaudeGenerator {
}
}

export class CodexGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {
await initRepo(fullConfig, projectName, {
promptsFolder: prompts ? '.codex/prompts' : undefined,
});

const agents = await loadAgentSpecs();

await fs.promises.mkdir('.codex/agents', { recursive: true });
for (const agent of agents)
await writeFile(`.codex/agents/${CodexGenerator.codexName(agent)}.toml`, CodexGenerator.agentSpec(agent), '🤖', 'agent definition');

initRepoDone();
}

// Codex's subagent registry rejects hyphenated identifiers at spawn time with
// `error=unknown agent_type '<name>'`. Codex's own documentation only shows
// snake_case names (`pr_explorer`, `reviewer`, `docs_researcher`, ...), see
// https://developers.openai.com/codex/subagents. Translate the shared agent
// name into snake_case so the filename and the `name` field stay in sync.
static codexName(agent: AgentSpec): string {
return agent.name.replace(/-/g, '_');
}

static agentSpec(agent: AgentSpec): string {
const mcpName = 'playwright-test';
const enabledTools: string[] = [];
for (const tool of agent.tools) {
const [first, second] = tool.split('/');
if (second && first === mcpName)
enabledTools.push(second);
}

const sandboxMode = agent.tools.includes('edit') ? 'workspace-write' : 'read-only';
const mcpServer = process.platform === 'win32'
? { command: 'cmd', args: ['/c', 'npx', 'playwright', 'run-test-mcp-server'] }
: { command: 'npx', args: ['playwright', 'run-test-mcp-server'] };

const examples = agent.examples.length
? ` Examples: ${agent.examples.map(example => `<example>${example}</example>`).join('')}`
: '';

const lines: string[] = [];
lines.push(`name = ${tomlBasicString(CodexGenerator.codexName(agent))}`);
lines.push(`description = ${tomlBasicString(agent.description + examples)}`);
lines.push(`sandbox_mode = ${tomlBasicString(sandboxMode)}`);
lines.push(`developer_instructions = ${tomlMultilineBasicString(agent.instructions)}`);
lines.push('');
lines.push(`[mcp_servers.${mcpName}]`);
lines.push(`command = ${tomlBasicString(mcpServer.command)}`);
lines.push(`args = ${tomlArray(mcpServer.args)}`);
if (enabledTools.length)
lines.push(`enabled_tools = ${tomlArray(enabledTools)}`);
lines.push('');
return lines.join('\n');
}
}

export class OpencodeGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {
await initRepo(fullConfig, projectName, {
Expand DownExpand Up@@ -155,6 +214,7 @@ export class OpencodeGenerator {
return JSON.stringify(result, null, 2);
}
}

export class CopilotGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {

Expand Down
6 changes: 4 additions & 2 deletions packages/playwright/src/program.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { builtInReporters, config, configLoader } from './common';
import { runTests, clearCache, runTestServerAction } from './cli/testActions';
import { showReport, mergeReports } from './cli/reportActions';
import { TestServerBackend, testServerBackendTools } from './mcp/test/testBackend';
import { ClaudeGenerator, OpencodeGenerator, VSCodeGenerator, CopilotGenerator } from './agents/generateAgents';
import { ClaudeGenerator, CodexGenerator, OpencodeGenerator, VSCodeGenerator, CopilotGenerator } from './agents/generateAgents';
import { packageJSON } from './package';

export { program };
Expand DownExpand Up@@ -155,7 +155,7 @@ function addInitAgentsCommand(program: Command) {
const command = program.command('init-agents');
command.description('Initialize repository agents');
const option = command.createOption('--loop <loop>', 'Agentic loop provider');
option.choices(['claude', 'copilot', 'opencode', 'vscode', 'vscode-legacy']);
option.choices(['claude', 'codex', 'copilot', 'opencode', 'vscode', 'vscode-legacy']);
command.addOption(option);
command.option('-c, --config <file>', `Configuration file to find a project to use for seed test`);
command.option('--project <project>', 'Project to use for seed test');
Expand All@@ -168,6 +168,8 @@ function addInitAgentsCommand(program: Command) {
await VSCodeGenerator.init(loadedConfig, opts.project);
} else if (opts.loop === 'claude') {
await ClaudeGenerator.init(loadedConfig, opts.project, opts.prompts);
} else if (opts.loop === 'codex') {
await CodexGenerator.init(loadedConfig, opts.project, opts.prompts);
} else {
await CopilotGenerator.init(loadedConfig, opts.project, opts.prompts);
return;
Expand Down
31 changes: 31 additions & 0 deletions tests/mcp/init-agents.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -90,3 +90,34 @@ test('claude generates correct mcp config', async ({ }) => {
expect(mcpJson.mcpServers['playwright-test'].args).toEqual(['playwright', 'run-test-mcp-server']);
}
});

test('codex generates agent toml files', async ({ }) => {
const baseDir = await writeFiles({
'playwright.config.ts': `module.exports = {};`,
});

await runInitAgents({ cwd: baseDir, args: ['--loop', 'codex'] });

const agentsDir = path.join(baseDir, '.codex', 'agents');
expect(fs.existsSync(agentsDir)).toBe(true);

const plannerToml = fs.readFileSync(path.join(agentsDir, 'playwright_test_planner.toml'), 'utf-8');
expect(plannerToml).toContain(`name = "playwright_test_planner"`);
expect(plannerToml).toContain(`[mcp_servers.playwright-test]`);
expect(plannerToml).toContain(`developer_instructions = """`);
Comment thread
0xharkirat marked this conversation as resolved.
if (process.platform === 'win32') {
expect(plannerToml).toContain(`command = "cmd"`);
expect(plannerToml).toContain(`args = ["/c", "npx", "playwright", "run-test-mcp-server"]`);
} else {
expect(plannerToml).toContain(`command = "npx"`);
expect(plannerToml).toContain(`args = ["playwright", "run-test-mcp-server"]`);
}

expect(plannerToml).toContain(`sandbox_mode = "read-only"`);
expect(plannerToml).toMatch(/enabled_tools = \[[^\]]*"planner_save_plan"[^\]]*\]/);
expect(plannerToml).toMatch(/enabled_tools = \[[^\]]*"browser_navigate"[^\]]*\]/);

const healerToml = fs.readFileSync(path.join(agentsDir, 'playwright_test_healer.toml'), 'utf-8');
expect(healerToml).toContain(`sandbox_mode = "workspace-write"`);
expect(healerToml).toMatch(/enabled_tools = \[[^\]]*"test_debug"[^\]]*\]/);
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(agents): add Codex --loop=codex generator by 0xharkirat · Pull Request #40817 · microsoft/playwright · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/src/test-agents-js.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,10 @@ npx playwright init-agents --loop=vscode
npx playwright init-agents --loop=claude
```

```bash tab=bash-codex
npx playwright init-agents --loop=codex
```

```bash tab=bash-opencode
npx playwright init-agents --loop=opencode
```
Expand Down
15 changes: 15 additions & 0 deletions packages/isomorphic/stringUtils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -189,6 +189,21 @@ export function parseRegex(regex: string): RegExp {
return new RegExp(source, flags);
}

export function tomlBasicString(value: string): string {
// JSON.stringify produces a valid TOML basic string: escapes \", \\, \n, \r, \t and uses \uXXXX for control chars.
return JSON.stringify(value);
}

export function tomlArray(values: string[]): string {
return `[${values.map(value => tomlBasicString(value)).join(', ')}]`;
}

export function tomlMultilineBasicString(value: string): string {
// Triple-quoted basic string: escape backslashes first, then any literal """ sequences.
const escaped = value.replace(/\\/g, '\\\\').replace(/"""/g, '\\"\\"\\"');
return `"""\n${escaped}\n"""`;
}

// Semicolons removed from [[\]()#;?] to avoid polynomial backtracking
// when both that group and (?:;...)* can match runs of semicolons.
// \d{1,4} relaxed to \d{0,4} so empty params (e.g. ESC[;H) still match.
Expand Down
1 change: 1 addition & 0 deletions packages/playwright/src/agents/DEPS.list
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
[*]
@isomorphic/**
@utils/**
../mcp/test/
node_modules/colors/safe
Expand Down
60 changes: 60 additions & 0 deletions packages/playwright/src/agents/generateAgents.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ import path from 'path';

import colors from 'colors/safe';
import yaml from 'yaml';
import { tomlArray, tomlBasicString, tomlMultilineBasicString } from '@isomorphic/stringUtils';
import { mkdirIfNeeded } from '@utils/fileUtils';

import { defaultSeedFile, findSeedFile, seedFileContent, seedProject } from '../mcp/test/seed';
Expand DownExpand Up@@ -90,6 +91,64 @@ export class ClaudeGenerator {
}
}

export class CodexGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {
await initRepo(fullConfig, projectName, {
promptsFolder: prompts ? '.codex/prompts' : undefined,
});

const agents = await loadAgentSpecs();

await fs.promises.mkdir('.codex/agents', { recursive: true });
for (const agent of agents)
await writeFile(`.codex/agents/${CodexGenerator.codexName(agent)}.toml`, CodexGenerator.agentSpec(agent), '🤖', 'agent definition');

initRepoDone();
}

// Codex's subagent registry rejects hyphenated identifiers at spawn time with
// `error=unknown agent_type '<name>'`. Codex's own documentation only shows
// snake_case names (`pr_explorer`, `reviewer`, `docs_researcher`, ...), see
// https://developers.openai.com/codex/subagents. Translate the shared agent
// name into snake_case so the filename and the `name` field stay in sync.
static codexName(agent: AgentSpec): string {
return agent.name.replace(/-/g, '_');
}

static agentSpec(agent: AgentSpec): string {
const mcpName = 'playwright-test';
const enabledTools: string[] = [];
for (const tool of agent.tools) {
const [first, second] = tool.split('/');
if (second && first === mcpName)
enabledTools.push(second);
}

const sandboxMode = agent.tools.includes('edit') ? 'workspace-write' : 'read-only';
const mcpServer = process.platform === 'win32'
? { command: 'cmd', args: ['/c', 'npx', 'playwright', 'run-test-mcp-server'] }
: { command: 'npx', args: ['playwright', 'run-test-mcp-server'] };

const examples = agent.examples.length
? ` Examples: ${agent.examples.map(example => `<example>${example}</example>`).join('')}`
: '';

const lines: string[] = [];
lines.push(`name = ${tomlBasicString(CodexGenerator.codexName(agent))}`);
lines.push(`description = ${tomlBasicString(agent.description + examples)}`);
lines.push(`sandbox_mode = ${tomlBasicString(sandboxMode)}`);
lines.push(`developer_instructions = ${tomlMultilineBasicString(agent.instructions)}`);
lines.push('');
lines.push(`[mcp_servers.${mcpName}]`);
lines.push(`command = ${tomlBasicString(mcpServer.command)}`);
lines.push(`args = ${tomlArray(mcpServer.args)}`);
if (enabledTools.length)
lines.push(`enabled_tools = ${tomlArray(enabledTools)}`);
lines.push('');
return lines.join('\n');
}
}

export class OpencodeGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {
await initRepo(fullConfig, projectName, {
Expand DownExpand Up@@ -155,6 +214,7 @@ export class OpencodeGenerator {
return JSON.stringify(result, null, 2);
}
}

export class CopilotGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {

Expand Down
6 changes: 4 additions & 2 deletions packages/playwright/src/program.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { builtInReporters, config, configLoader } from './common';
import { runTests, clearCache, runTestServerAction } from './cli/testActions';
import { showReport, mergeReports } from './cli/reportActions';
import { TestServerBackend, testServerBackendTools } from './mcp/test/testBackend';
import { ClaudeGenerator, OpencodeGenerator, VSCodeGenerator, CopilotGenerator } from './agents/generateAgents';
import { ClaudeGenerator, CodexGenerator, OpencodeGenerator, VSCodeGenerator, CopilotGenerator } from './agents/generateAgents';
import { packageJSON } from './package';

export { program };
Expand DownExpand Up@@ -155,7 +155,7 @@ function addInitAgentsCommand(program: Command) {
const command = program.command('init-agents');
command.description('Initialize repository agents');
const option = command.createOption('--loop <loop>', 'Agentic loop provider');
option.choices(['claude', 'copilot', 'opencode', 'vscode', 'vscode-legacy']);
option.choices(['claude', 'codex', 'copilot', 'opencode', 'vscode', 'vscode-legacy']);
command.addOption(option);
command.option('-c, --config <file>', `Configuration file to find a project to use for seed test`);
command.option('--project <project>', 'Project to use for seed test');
Expand All@@ -168,6 +168,8 @@ function addInitAgentsCommand(program: Command) {
await VSCodeGenerator.init(loadedConfig, opts.project);
} else if (opts.loop === 'claude') {
await ClaudeGenerator.init(loadedConfig, opts.project, opts.prompts);
} else if (opts.loop === 'codex') {
await CodexGenerator.init(loadedConfig, opts.project, opts.prompts);
} else {
await CopilotGenerator.init(loadedConfig, opts.project, opts.prompts);
return;
Expand Down
31 changes: 31 additions & 0 deletions tests/mcp/init-agents.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -90,3 +90,34 @@ test('claude generates correct mcp config', async ({ }) => {
expect(mcpJson.mcpServers['playwright-test'].args).toEqual(['playwright', 'run-test-mcp-server']);
}
});

test('codex generates agent toml files', async ({ }) => {
const baseDir = await writeFiles({
'playwright.config.ts': `module.exports = {};`,
});

await runInitAgents({ cwd: baseDir, args: ['--loop', 'codex'] });

const agentsDir = path.join(baseDir, '.codex', 'agents');
expect(fs.existsSync(agentsDir)).toBe(true);

const plannerToml = fs.readFileSync(path.join(agentsDir, 'playwright_test_planner.toml'), 'utf-8');
expect(plannerToml).toContain(`name = "playwright_test_planner"`);
expect(plannerToml).toContain(`[mcp_servers.playwright-test]`);
expect(plannerToml).toContain(`developer_instructions = """`);
Comment thread
0xharkirat marked this conversation as resolved.
if (process.platform === 'win32') {
expect(plannerToml).toContain(`command = "cmd"`);
expect(plannerToml).toContain(`args = ["/c", "npx", "playwright", "run-test-mcp-server"]`);
} else {
expect(plannerToml).toContain(`command = "npx"`);
expect(plannerToml).toContain(`args = ["playwright", "run-test-mcp-server"]`);
}

expect(plannerToml).toContain(`sandbox_mode = "read-only"`);
expect(plannerToml).toMatch(/enabled_tools = \[[^\]]*"planner_save_plan"[^\]]*\]/);
expect(plannerToml).toMatch(/enabled_tools = \[[^\]]*"browser_navigate"[^\]]*\]/);

const healerToml = fs.readFileSync(path.join(agentsDir, 'playwright_test_healer.toml'), 'utf-8');
expect(healerToml).toContain(`sandbox_mode = "workspace-write"`);
expect(healerToml).toMatch(/enabled_tools = \[[^\]]*"test_debug"[^\]]*\]/);
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(agents): add Codex --loop=codex generator by 0xharkirat · Pull Request #40817 · microsoft/playwright · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/src/test-agents-js.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,10 @@ npx playwright init-agents --loop=vscode
npx playwright init-agents --loop=claude
```

```bash tab=bash-codex
npx playwright init-agents --loop=codex
```

```bash tab=bash-opencode
npx playwright init-agents --loop=opencode
```
Expand Down
15 changes: 15 additions & 0 deletions packages/isomorphic/stringUtils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -189,6 +189,21 @@ export function parseRegex(regex: string): RegExp {
return new RegExp(source, flags);
}

export function tomlBasicString(value: string): string {
// JSON.stringify produces a valid TOML basic string: escapes \", \\, \n, \r, \t and uses \uXXXX for control chars.
return JSON.stringify(value);
}

export function tomlArray(values: string[]): string {
return `[${values.map(value => tomlBasicString(value)).join(', ')}]`;
}

export function tomlMultilineBasicString(value: string): string {
// Triple-quoted basic string: escape backslashes first, then any literal """ sequences.
const escaped = value.replace(/\\/g, '\\\\').replace(/"""/g, '\\"\\"\\"');
return `"""\n${escaped}\n"""`;
}

// Semicolons removed from [[\]()#;?] to avoid polynomial backtracking
// when both that group and (?:;...)* can match runs of semicolons.
// \d{1,4} relaxed to \d{0,4} so empty params (e.g. ESC[;H) still match.
Expand Down
1 change: 1 addition & 0 deletions packages/playwright/src/agents/DEPS.list
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
[*]
@isomorphic/**
@utils/**
../mcp/test/
node_modules/colors/safe
Expand Down
60 changes: 60 additions & 0 deletions packages/playwright/src/agents/generateAgents.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ import path from 'path';

import colors from 'colors/safe';
import yaml from 'yaml';
import { tomlArray, tomlBasicString, tomlMultilineBasicString } from '@isomorphic/stringUtils';
import { mkdirIfNeeded } from '@utils/fileUtils';

import { defaultSeedFile, findSeedFile, seedFileContent, seedProject } from '../mcp/test/seed';
Expand DownExpand Up@@ -90,6 +91,64 @@ export class ClaudeGenerator {
}
}

export class CodexGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {
await initRepo(fullConfig, projectName, {
promptsFolder: prompts ? '.codex/prompts' : undefined,
});

const agents = await loadAgentSpecs();

await fs.promises.mkdir('.codex/agents', { recursive: true });
for (const agent of agents)
await writeFile(`.codex/agents/${CodexGenerator.codexName(agent)}.toml`, CodexGenerator.agentSpec(agent), '🤖', 'agent definition');

initRepoDone();
}

// Codex's subagent registry rejects hyphenated identifiers at spawn time with
// `error=unknown agent_type '<name>'`. Codex's own documentation only shows
// snake_case names (`pr_explorer`, `reviewer`, `docs_researcher`, ...), see
// https://developers.openai.com/codex/subagents. Translate the shared agent
// name into snake_case so the filename and the `name` field stay in sync.
static codexName(agent: AgentSpec): string {
return agent.name.replace(/-/g, '_');
}

static agentSpec(agent: AgentSpec): string {
const mcpName = 'playwright-test';
const enabledTools: string[] = [];
for (const tool of agent.tools) {
const [first, second] = tool.split('/');
if (second && first === mcpName)
enabledTools.push(second);
}

const sandboxMode = agent.tools.includes('edit') ? 'workspace-write' : 'read-only';
const mcpServer = process.platform === 'win32'
? { command: 'cmd', args: ['/c', 'npx', 'playwright', 'run-test-mcp-server'] }
: { command: 'npx', args: ['playwright', 'run-test-mcp-server'] };

const examples = agent.examples.length
? ` Examples: ${agent.examples.map(example => `<example>${example}</example>`).join('')}`
: '';

const lines: string[] = [];
lines.push(`name = ${tomlBasicString(CodexGenerator.codexName(agent))}`);
lines.push(`description = ${tomlBasicString(agent.description + examples)}`);
lines.push(`sandbox_mode = ${tomlBasicString(sandboxMode)}`);
lines.push(`developer_instructions = ${tomlMultilineBasicString(agent.instructions)}`);
lines.push('');
lines.push(`[mcp_servers.${mcpName}]`);
lines.push(`command = ${tomlBasicString(mcpServer.command)}`);
lines.push(`args = ${tomlArray(mcpServer.args)}`);
if (enabledTools.length)
lines.push(`enabled_tools = ${tomlArray(enabledTools)}`);
lines.push('');
return lines.join('\n');
}
}

export class OpencodeGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {
await initRepo(fullConfig, projectName, {
Expand DownExpand Up@@ -155,6 +214,7 @@ export class OpencodeGenerator {
return JSON.stringify(result, null, 2);
}
}

export class CopilotGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {

Expand Down
6 changes: 4 additions & 2 deletions packages/playwright/src/program.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { builtInReporters, config, configLoader } from './common';
import { runTests, clearCache, runTestServerAction } from './cli/testActions';
import { showReport, mergeReports } from './cli/reportActions';
import { TestServerBackend, testServerBackendTools } from './mcp/test/testBackend';
import { ClaudeGenerator, OpencodeGenerator, VSCodeGenerator, CopilotGenerator } from './agents/generateAgents';
import { ClaudeGenerator, CodexGenerator, OpencodeGenerator, VSCodeGenerator, CopilotGenerator } from './agents/generateAgents';
import { packageJSON } from './package';

export { program };
Expand DownExpand Up@@ -155,7 +155,7 @@ function addInitAgentsCommand(program: Command) {
const command = program.command('init-agents');
command.description('Initialize repository agents');
const option = command.createOption('--loop <loop>', 'Agentic loop provider');
option.choices(['claude', 'copilot', 'opencode', 'vscode', 'vscode-legacy']);
option.choices(['claude', 'codex', 'copilot', 'opencode', 'vscode', 'vscode-legacy']);
command.addOption(option);
command.option('-c, --config <file>', `Configuration file to find a project to use for seed test`);
command.option('--project <project>', 'Project to use for seed test');
Expand All@@ -168,6 +168,8 @@ function addInitAgentsCommand(program: Command) {
await VSCodeGenerator.init(loadedConfig, opts.project);
} else if (opts.loop === 'claude') {
await ClaudeGenerator.init(loadedConfig, opts.project, opts.prompts);
} else if (opts.loop === 'codex') {
await CodexGenerator.init(loadedConfig, opts.project, opts.prompts);
} else {
await CopilotGenerator.init(loadedConfig, opts.project, opts.prompts);
return;
Expand Down
31 changes: 31 additions & 0 deletions tests/mcp/init-agents.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -90,3 +90,34 @@ test('claude generates correct mcp config', async ({ }) => {
expect(mcpJson.mcpServers['playwright-test'].args).toEqual(['playwright', 'run-test-mcp-server']);
}
});

test('codex generates agent toml files', async ({ }) => {
const baseDir = await writeFiles({
'playwright.config.ts': `module.exports = {};`,
});

await runInitAgents({ cwd: baseDir, args: ['--loop', 'codex'] });

const agentsDir = path.join(baseDir, '.codex', 'agents');
expect(fs.existsSync(agentsDir)).toBe(true);

const plannerToml = fs.readFileSync(path.join(agentsDir, 'playwright_test_planner.toml'), 'utf-8');
expect(plannerToml).toContain(`name = "playwright_test_planner"`);
expect(plannerToml).toContain(`[mcp_servers.playwright-test]`);
expect(plannerToml).toContain(`developer_instructions = """`);
Comment thread
0xharkirat marked this conversation as resolved.
if (process.platform === 'win32') {
expect(plannerToml).toContain(`command = "cmd"`);
expect(plannerToml).toContain(`args = ["/c", "npx", "playwright", "run-test-mcp-server"]`);
} else {
expect(plannerToml).toContain(`command = "npx"`);
expect(plannerToml).toContain(`args = ["playwright", "run-test-mcp-server"]`);
}

expect(plannerToml).toContain(`sandbox_mode = "read-only"`);
expect(plannerToml).toMatch(/enabled_tools = \[[^\]]*"planner_save_plan"[^\]]*\]/);
expect(plannerToml).toMatch(/enabled_tools = \[[^\]]*"browser_navigate"[^\]]*\]/);

const healerToml = fs.readFileSync(path.join(agentsDir, 'playwright_test_healer.toml'), 'utf-8');
expect(healerToml).toContain(`sandbox_mode = "workspace-write"`);
expect(healerToml).toMatch(/enabled_tools = \[[^\]]*"test_debug"[^\]]*\]/);
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' feat(agents): add Codex --loop=codex generator by 0xharkirat · Pull Request #40817 · microsoft/playwright · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/src/test-agents-js.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,10 @@ npx playwright init-agents --loop=vscode
npx playwright init-agents --loop=claude
```

```bash tab=bash-codex
npx playwright init-agents --loop=codex
```

```bash tab=bash-opencode
npx playwright init-agents --loop=opencode
```
Expand Down
15 changes: 15 additions & 0 deletions packages/isomorphic/stringUtils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -189,6 +189,21 @@ export function parseRegex(regex: string): RegExp {
return new RegExp(source, flags);
}

export function tomlBasicString(value: string): string {
// JSON.stringify produces a valid TOML basic string: escapes \", \\, \n, \r, \t and uses \uXXXX for control chars.
return JSON.stringify(value);
}

export function tomlArray(values: string[]): string {
return `[${values.map(value => tomlBasicString(value)).join(', ')}]`;
}

export function tomlMultilineBasicString(value: string): string {
// Triple-quoted basic string: escape backslashes first, then any literal """ sequences.
const escaped = value.replace(/\\/g, '\\\\').replace(/"""/g, '\\"\\"\\"');
return `"""\n${escaped}\n"""`;
}

// Semicolons removed from [[\]()#;?] to avoid polynomial backtracking
// when both that group and (?:;...)* can match runs of semicolons.
// \d{1,4} relaxed to \d{0,4} so empty params (e.g. ESC[;H) still match.
Expand Down
1 change: 1 addition & 0 deletions packages/playwright/src/agents/DEPS.list
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
[*]
@isomorphic/**
@utils/**
../mcp/test/
node_modules/colors/safe
Expand Down
60 changes: 60 additions & 0 deletions packages/playwright/src/agents/generateAgents.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ import path from 'path';

import colors from 'colors/safe';
import yaml from 'yaml';
import { tomlArray, tomlBasicString, tomlMultilineBasicString } from '@isomorphic/stringUtils';
import { mkdirIfNeeded } from '@utils/fileUtils';

import { defaultSeedFile, findSeedFile, seedFileContent, seedProject } from '../mcp/test/seed';
Expand DownExpand Up@@ -90,6 +91,64 @@ export class ClaudeGenerator {
}
}

export class CodexGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {
await initRepo(fullConfig, projectName, {
promptsFolder: prompts ? '.codex/prompts' : undefined,
});

const agents = await loadAgentSpecs();

await fs.promises.mkdir('.codex/agents', { recursive: true });
for (const agent of agents)
await writeFile(`.codex/agents/${CodexGenerator.codexName(agent)}.toml`, CodexGenerator.agentSpec(agent), '🤖', 'agent definition');

initRepoDone();
}

// Codex's subagent registry rejects hyphenated identifiers at spawn time with
// `error=unknown agent_type '<name>'`. Codex's own documentation only shows
// snake_case names (`pr_explorer`, `reviewer`, `docs_researcher`, ...), see
// https://developers.openai.com/codex/subagents. Translate the shared agent
// name into snake_case so the filename and the `name` field stay in sync.
static codexName(agent: AgentSpec): string {
return agent.name.replace(/-/g, '_');
}

static agentSpec(agent: AgentSpec): string {
const mcpName = 'playwright-test';
const enabledTools: string[] = [];
for (const tool of agent.tools) {
const [first, second] = tool.split('/');
if (second && first === mcpName)
enabledTools.push(second);
}

const sandboxMode = agent.tools.includes('edit') ? 'workspace-write' : 'read-only';
const mcpServer = process.platform === 'win32'
? { command: 'cmd', args: ['/c', 'npx', 'playwright', 'run-test-mcp-server'] }
: { command: 'npx', args: ['playwright', 'run-test-mcp-server'] };

const examples = agent.examples.length
? ` Examples: ${agent.examples.map(example => `<example>${example}</example>`).join('')}`
: '';

const lines: string[] = [];
lines.push(`name = ${tomlBasicString(CodexGenerator.codexName(agent))}`);
lines.push(`description = ${tomlBasicString(agent.description + examples)}`);
lines.push(`sandbox_mode = ${tomlBasicString(sandboxMode)}`);
lines.push(`developer_instructions = ${tomlMultilineBasicString(agent.instructions)}`);
lines.push('');
lines.push(`[mcp_servers.${mcpName}]`);
lines.push(`command = ${tomlBasicString(mcpServer.command)}`);
lines.push(`args = ${tomlArray(mcpServer.args)}`);
if (enabledTools.length)
lines.push(`enabled_tools = ${tomlArray(enabledTools)}`);
lines.push('');
return lines.join('\n');
}
}

export class OpencodeGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {
await initRepo(fullConfig, projectName, {
Expand DownExpand Up@@ -155,6 +214,7 @@ export class OpencodeGenerator {
return JSON.stringify(result, null, 2);
}
}

export class CopilotGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {

Expand Down
6 changes: 4 additions & 2 deletions packages/playwright/src/program.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { builtInReporters, config, configLoader } from './common';
import { runTests, clearCache, runTestServerAction } from './cli/testActions';
import { showReport, mergeReports } from './cli/reportActions';
import { TestServerBackend, testServerBackendTools } from './mcp/test/testBackend';
import { ClaudeGenerator, OpencodeGenerator, VSCodeGenerator, CopilotGenerator } from './agents/generateAgents';
import { ClaudeGenerator, CodexGenerator, OpencodeGenerator, VSCodeGenerator, CopilotGenerator } from './agents/generateAgents';
import { packageJSON } from './package';

export { program };
Expand DownExpand Up@@ -155,7 +155,7 @@ function addInitAgentsCommand(program: Command) {
const command = program.command('init-agents');
command.description('Initialize repository agents');
const option = command.createOption('--loop <loop>', 'Agentic loop provider');
option.choices(['claude', 'copilot', 'opencode', 'vscode', 'vscode-legacy']);
option.choices(['claude', 'codex', 'copilot', 'opencode', 'vscode', 'vscode-legacy']);
command.addOption(option);
command.option('-c, --config <file>', `Configuration file to find a project to use for seed test`);
command.option('--project <project>', 'Project to use for seed test');
Expand All@@ -168,6 +168,8 @@ function addInitAgentsCommand(program: Command) {
await VSCodeGenerator.init(loadedConfig, opts.project);
} else if (opts.loop === 'claude') {
await ClaudeGenerator.init(loadedConfig, opts.project, opts.prompts);
} else if (opts.loop === 'codex') {
await CodexGenerator.init(loadedConfig, opts.project, opts.prompts);
} else {
await CopilotGenerator.init(loadedConfig, opts.project, opts.prompts);
return;
Expand Down
31 changes: 31 additions & 0 deletions tests/mcp/init-agents.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -90,3 +90,34 @@ test('claude generates correct mcp config', async ({ }) => {
expect(mcpJson.mcpServers['playwright-test'].args).toEqual(['playwright', 'run-test-mcp-server']);
}
});

test('codex generates agent toml files', async ({ }) => {
const baseDir = await writeFiles({
'playwright.config.ts': `module.exports = {};`,
});

await runInitAgents({ cwd: baseDir, args: ['--loop', 'codex'] });

const agentsDir = path.join(baseDir, '.codex', 'agents');
expect(fs.existsSync(agentsDir)).toBe(true);

const plannerToml = fs.readFileSync(path.join(agentsDir, 'playwright_test_planner.toml'), 'utf-8');
expect(plannerToml).toContain(`name = "playwright_test_planner"`);
expect(plannerToml).toContain(`[mcp_servers.playwright-test]`);
expect(plannerToml).toContain(`developer_instructions = """`);
Comment thread
0xharkirat marked this conversation as resolved.
if (process.platform === 'win32') {
expect(plannerToml).toContain(`command = "cmd"`);
expect(plannerToml).toContain(`args = ["/c", "npx", "playwright", "run-test-mcp-server"]`);
} else {
expect(plannerToml).toContain(`command = "npx"`);
expect(plannerToml).toContain(`args = ["playwright", "run-test-mcp-server"]`);
}

expect(plannerToml).toContain(`sandbox_mode = "read-only"`);
expect(plannerToml).toMatch(/enabled_tools = \[[^\]]*"planner_save_plan"[^\]]*\]/);
expect(plannerToml).toMatch(/enabled_tools = \[[^\]]*"browser_navigate"[^\]]*\]/);

const healerToml = fs.readFileSync(path.join(agentsDir, 'playwright_test_healer.toml'), 'utf-8');
expect(healerToml).toContain(`sandbox_mode = "workspace-write"`);
expect(healerToml).toMatch(/enabled_tools = \[[^\]]*"test_debug"[^\]]*\]/);
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(agents): add Codex --loop=codex generator by 0xharkirat · Pull Request #40817 · microsoft/playwright · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/src/test-agents-js.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,10 @@ npx playwright init-agents --loop=vscode
npx playwright init-agents --loop=claude
```

```bash tab=bash-codex
npx playwright init-agents --loop=codex
```

```bash tab=bash-opencode
npx playwright init-agents --loop=opencode
```
Expand Down
15 changes: 15 additions & 0 deletions packages/isomorphic/stringUtils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -189,6 +189,21 @@ export function parseRegex(regex: string): RegExp {
return new RegExp(source, flags);
}

export function tomlBasicString(value: string): string {
// JSON.stringify produces a valid TOML basic string: escapes \", \\, \n, \r, \t and uses \uXXXX for control chars.
return JSON.stringify(value);
}

export function tomlArray(values: string[]): string {
return `[${values.map(value => tomlBasicString(value)).join(', ')}]`;
}

export function tomlMultilineBasicString(value: string): string {
// Triple-quoted basic string: escape backslashes first, then any literal """ sequences.
const escaped = value.replace(/\\/g, '\\\\').replace(/"""/g, '\\"\\"\\"');
return `"""\n${escaped}\n"""`;
}

// Semicolons removed from [[\]()#;?] to avoid polynomial backtracking
// when both that group and (?:;...)* can match runs of semicolons.
// \d{1,4} relaxed to \d{0,4} so empty params (e.g. ESC[;H) still match.
Expand Down
1 change: 1 addition & 0 deletions packages/playwright/src/agents/DEPS.list
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
[*]
@isomorphic/**
@utils/**
../mcp/test/
node_modules/colors/safe
Expand Down
60 changes: 60 additions & 0 deletions packages/playwright/src/agents/generateAgents.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ import path from 'path';

import colors from 'colors/safe';
import yaml from 'yaml';
import { tomlArray, tomlBasicString, tomlMultilineBasicString } from '@isomorphic/stringUtils';
import { mkdirIfNeeded } from '@utils/fileUtils';

import { defaultSeedFile, findSeedFile, seedFileContent, seedProject } from '../mcp/test/seed';
Expand DownExpand Up@@ -90,6 +91,64 @@ export class ClaudeGenerator {
}
}

export class CodexGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {
await initRepo(fullConfig, projectName, {
promptsFolder: prompts ? '.codex/prompts' : undefined,
});

const agents = await loadAgentSpecs();

await fs.promises.mkdir('.codex/agents', { recursive: true });
for (const agent of agents)
await writeFile(`.codex/agents/${CodexGenerator.codexName(agent)}.toml`, CodexGenerator.agentSpec(agent), '🤖', 'agent definition');

initRepoDone();
}

// Codex's subagent registry rejects hyphenated identifiers at spawn time with
// `error=unknown agent_type '<name>'`. Codex's own documentation only shows
// snake_case names (`pr_explorer`, `reviewer`, `docs_researcher`, ...), see
// https://developers.openai.com/codex/subagents. Translate the shared agent
// name into snake_case so the filename and the `name` field stay in sync.
static codexName(agent: AgentSpec): string {
return agent.name.replace(/-/g, '_');
}

static agentSpec(agent: AgentSpec): string {
const mcpName = 'playwright-test';
const enabledTools: string[] = [];
for (const tool of agent.tools) {
const [first, second] = tool.split('/');
if (second && first === mcpName)
enabledTools.push(second);
}

const sandboxMode = agent.tools.includes('edit') ? 'workspace-write' : 'read-only';
const mcpServer = process.platform === 'win32'
? { command: 'cmd', args: ['/c', 'npx', 'playwright', 'run-test-mcp-server'] }
: { command: 'npx', args: ['playwright', 'run-test-mcp-server'] };

const examples = agent.examples.length
? ` Examples: ${agent.examples.map(example => `<example>${example}</example>`).join('')}`
: '';

const lines: string[] = [];
lines.push(`name = ${tomlBasicString(CodexGenerator.codexName(agent))}`);
lines.push(`description = ${tomlBasicString(agent.description + examples)}`);
lines.push(`sandbox_mode = ${tomlBasicString(sandboxMode)}`);
lines.push(`developer_instructions = ${tomlMultilineBasicString(agent.instructions)}`);
lines.push('');
lines.push(`[mcp_servers.${mcpName}]`);
lines.push(`command = ${tomlBasicString(mcpServer.command)}`);
lines.push(`args = ${tomlArray(mcpServer.args)}`);
if (enabledTools.length)
lines.push(`enabled_tools = ${tomlArray(enabledTools)}`);
lines.push('');
return lines.join('\n');
}
}

export class OpencodeGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {
await initRepo(fullConfig, projectName, {
Expand DownExpand Up@@ -155,6 +214,7 @@ export class OpencodeGenerator {
return JSON.stringify(result, null, 2);
}
}

export class CopilotGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {

Expand Down
6 changes: 4 additions & 2 deletions packages/playwright/src/program.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { builtInReporters, config, configLoader } from './common';
import { runTests, clearCache, runTestServerAction } from './cli/testActions';
import { showReport, mergeReports } from './cli/reportActions';
import { TestServerBackend, testServerBackendTools } from './mcp/test/testBackend';
import { ClaudeGenerator, OpencodeGenerator, VSCodeGenerator, CopilotGenerator } from './agents/generateAgents';
import { ClaudeGenerator, CodexGenerator, OpencodeGenerator, VSCodeGenerator, CopilotGenerator } from './agents/generateAgents';
import { packageJSON } from './package';

export { program };
Expand DownExpand Up@@ -155,7 +155,7 @@ function addInitAgentsCommand(program: Command) {
const command = program.command('init-agents');
command.description('Initialize repository agents');
const option = command.createOption('--loop <loop>', 'Agentic loop provider');
option.choices(['claude', 'copilot', 'opencode', 'vscode', 'vscode-legacy']);
option.choices(['claude', 'codex', 'copilot', 'opencode', 'vscode', 'vscode-legacy']);
command.addOption(option);
command.option('-c, --config <file>', `Configuration file to find a project to use for seed test`);
command.option('--project <project>', 'Project to use for seed test');
Expand All@@ -168,6 +168,8 @@ function addInitAgentsCommand(program: Command) {
await VSCodeGenerator.init(loadedConfig, opts.project);
} else if (opts.loop === 'claude') {
await ClaudeGenerator.init(loadedConfig, opts.project, opts.prompts);
} else if (opts.loop === 'codex') {
await CodexGenerator.init(loadedConfig, opts.project, opts.prompts);
} else {
await CopilotGenerator.init(loadedConfig, opts.project, opts.prompts);
return;
Expand Down
31 changes: 31 additions & 0 deletions tests/mcp/init-agents.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -90,3 +90,34 @@ test('claude generates correct mcp config', async ({ }) => {
expect(mcpJson.mcpServers['playwright-test'].args).toEqual(['playwright', 'run-test-mcp-server']);
}
});

test('codex generates agent toml files', async ({ }) => {
const baseDir = await writeFiles({
'playwright.config.ts': `module.exports = {};`,
});

await runInitAgents({ cwd: baseDir, args: ['--loop', 'codex'] });

const agentsDir = path.join(baseDir, '.codex', 'agents');
expect(fs.existsSync(agentsDir)).toBe(true);

const plannerToml = fs.readFileSync(path.join(agentsDir, 'playwright_test_planner.toml'), 'utf-8');
expect(plannerToml).toContain(`name = "playwright_test_planner"`);
expect(plannerToml).toContain(`[mcp_servers.playwright-test]`);
expect(plannerToml).toContain(`developer_instructions = """`);
Comment thread
0xharkirat marked this conversation as resolved.
if (process.platform === 'win32') {
expect(plannerToml).toContain(`command = "cmd"`);
expect(plannerToml).toContain(`args = ["/c", "npx", "playwright", "run-test-mcp-server"]`);
} else {
expect(plannerToml).toContain(`command = "npx"`);
expect(plannerToml).toContain(`args = ["playwright", "run-test-mcp-server"]`);
}

expect(plannerToml).toContain(`sandbox_mode = "read-only"`);
expect(plannerToml).toMatch(/enabled_tools = \[[^\]]*"planner_save_plan"[^\]]*\]/);
expect(plannerToml).toMatch(/enabled_tools = \[[^\]]*"browser_navigate"[^\]]*\]/);

const healerToml = fs.readFileSync(path.join(agentsDir, 'playwright_test_healer.toml'), 'utf-8');
expect(healerToml).toContain(`sandbox_mode = "workspace-write"`);
expect(healerToml).toMatch(/enabled_tools = \[[^\]]*"test_debug"[^\]]*\]/);
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(agents): add Codex --loop=codex generator by 0xharkirat · Pull Request #40817 · microsoft/playwright · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/src/test-agents-js.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,10 @@ npx playwright init-agents --loop=vscode
npx playwright init-agents --loop=claude
```

```bash tab=bash-codex
npx playwright init-agents --loop=codex
```

```bash tab=bash-opencode
npx playwright init-agents --loop=opencode
```
Expand Down
15 changes: 15 additions & 0 deletions packages/isomorphic/stringUtils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -189,6 +189,21 @@ export function parseRegex(regex: string): RegExp {
return new RegExp(source, flags);
}

export function tomlBasicString(value: string): string {
// JSON.stringify produces a valid TOML basic string: escapes \", \\, \n, \r, \t and uses \uXXXX for control chars.
return JSON.stringify(value);
}

export function tomlArray(values: string[]): string {
return `[${values.map(value => tomlBasicString(value)).join(', ')}]`;
}

export function tomlMultilineBasicString(value: string): string {
// Triple-quoted basic string: escape backslashes first, then any literal """ sequences.
const escaped = value.replace(/\\/g, '\\\\').replace(/"""/g, '\\"\\"\\"');
return `"""\n${escaped}\n"""`;
}

// Semicolons removed from [[\]()#;?] to avoid polynomial backtracking
// when both that group and (?:;...)* can match runs of semicolons.
// \d{1,4} relaxed to \d{0,4} so empty params (e.g. ESC[;H) still match.
Expand Down
1 change: 1 addition & 0 deletions packages/playwright/src/agents/DEPS.list
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
[*]
@isomorphic/**
@utils/**
../mcp/test/
node_modules/colors/safe
Expand Down
60 changes: 60 additions & 0 deletions packages/playwright/src/agents/generateAgents.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ import path from 'path';

import colors from 'colors/safe';
import yaml from 'yaml';
import { tomlArray, tomlBasicString, tomlMultilineBasicString } from '@isomorphic/stringUtils';
import { mkdirIfNeeded } from '@utils/fileUtils';

import { defaultSeedFile, findSeedFile, seedFileContent, seedProject } from '../mcp/test/seed';
Expand DownExpand Up@@ -90,6 +91,64 @@ export class ClaudeGenerator {
}
}

export class CodexGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {
await initRepo(fullConfig, projectName, {
promptsFolder: prompts ? '.codex/prompts' : undefined,
});

const agents = await loadAgentSpecs();

await fs.promises.mkdir('.codex/agents', { recursive: true });
for (const agent of agents)
await writeFile(`.codex/agents/${CodexGenerator.codexName(agent)}.toml`, CodexGenerator.agentSpec(agent), '🤖', 'agent definition');

initRepoDone();
}

// Codex's subagent registry rejects hyphenated identifiers at spawn time with
// `error=unknown agent_type '<name>'`. Codex's own documentation only shows
// snake_case names (`pr_explorer`, `reviewer`, `docs_researcher`, ...), see
// https://developers.openai.com/codex/subagents. Translate the shared agent
// name into snake_case so the filename and the `name` field stay in sync.
static codexName(agent: AgentSpec): string {
return agent.name.replace(/-/g, '_');
}

static agentSpec(agent: AgentSpec): string {
const mcpName = 'playwright-test';
const enabledTools: string[] = [];
for (const tool of agent.tools) {
const [first, second] = tool.split('/');
if (second && first === mcpName)
enabledTools.push(second);
}

const sandboxMode = agent.tools.includes('edit') ? 'workspace-write' : 'read-only';
const mcpServer = process.platform === 'win32'
? { command: 'cmd', args: ['/c', 'npx', 'playwright', 'run-test-mcp-server'] }
: { command: 'npx', args: ['playwright', 'run-test-mcp-server'] };

const examples = agent.examples.length
? ` Examples: ${agent.examples.map(example => `<example>${example}</example>`).join('')}`
: '';

const lines: string[] = [];
lines.push(`name = ${tomlBasicString(CodexGenerator.codexName(agent))}`);
lines.push(`description = ${tomlBasicString(agent.description + examples)}`);
lines.push(`sandbox_mode = ${tomlBasicString(sandboxMode)}`);
lines.push(`developer_instructions = ${tomlMultilineBasicString(agent.instructions)}`);
lines.push('');
lines.push(`[mcp_servers.${mcpName}]`);
lines.push(`command = ${tomlBasicString(mcpServer.command)}`);
lines.push(`args = ${tomlArray(mcpServer.args)}`);
if (enabledTools.length)
lines.push(`enabled_tools = ${tomlArray(enabledTools)}`);
lines.push('');
return lines.join('\n');
}
}

export class OpencodeGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {
await initRepo(fullConfig, projectName, {
Expand DownExpand Up@@ -155,6 +214,7 @@ export class OpencodeGenerator {
return JSON.stringify(result, null, 2);
}
}

export class CopilotGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {

Expand Down
6 changes: 4 additions & 2 deletions packages/playwright/src/program.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { builtInReporters, config, configLoader } from './common';
import { runTests, clearCache, runTestServerAction } from './cli/testActions';
import { showReport, mergeReports } from './cli/reportActions';
import { TestServerBackend, testServerBackendTools } from './mcp/test/testBackend';
import { ClaudeGenerator, OpencodeGenerator, VSCodeGenerator, CopilotGenerator } from './agents/generateAgents';
import { ClaudeGenerator, CodexGenerator, OpencodeGenerator, VSCodeGenerator, CopilotGenerator } from './agents/generateAgents';
import { packageJSON } from './package';

export { program };
Expand DownExpand Up@@ -155,7 +155,7 @@ function addInitAgentsCommand(program: Command) {
const command = program.command('init-agents');
command.description('Initialize repository agents');
const option = command.createOption('--loop <loop>', 'Agentic loop provider');
option.choices(['claude', 'copilot', 'opencode', 'vscode', 'vscode-legacy']);
option.choices(['claude', 'codex', 'copilot', 'opencode', 'vscode', 'vscode-legacy']);
command.addOption(option);
command.option('-c, --config <file>', `Configuration file to find a project to use for seed test`);
command.option('--project <project>', 'Project to use for seed test');
Expand All@@ -168,6 +168,8 @@ function addInitAgentsCommand(program: Command) {
await VSCodeGenerator.init(loadedConfig, opts.project);
} else if (opts.loop === 'claude') {
await ClaudeGenerator.init(loadedConfig, opts.project, opts.prompts);
} else if (opts.loop === 'codex') {
await CodexGenerator.init(loadedConfig, opts.project, opts.prompts);
} else {
await CopilotGenerator.init(loadedConfig, opts.project, opts.prompts);
return;
Expand Down
31 changes: 31 additions & 0 deletions tests/mcp/init-agents.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -90,3 +90,34 @@ test('claude generates correct mcp config', async ({ }) => {
expect(mcpJson.mcpServers['playwright-test'].args).toEqual(['playwright', 'run-test-mcp-server']);
}
});

test('codex generates agent toml files', async ({ }) => {
const baseDir = await writeFiles({
'playwright.config.ts': `module.exports = {};`,
});

await runInitAgents({ cwd: baseDir, args: ['--loop', 'codex'] });

const agentsDir = path.join(baseDir, '.codex', 'agents');
expect(fs.existsSync(agentsDir)).toBe(true);

const plannerToml = fs.readFileSync(path.join(agentsDir, 'playwright_test_planner.toml'), 'utf-8');
expect(plannerToml).toContain(`name = "playwright_test_planner"`);
expect(plannerToml).toContain(`[mcp_servers.playwright-test]`);
expect(plannerToml).toContain(`developer_instructions = """`);
Comment thread
0xharkirat marked this conversation as resolved.
if (process.platform === 'win32') {
expect(plannerToml).toContain(`command = "cmd"`);
expect(plannerToml).toContain(`args = ["/c", "npx", "playwright", "run-test-mcp-server"]`);
} else {
expect(plannerToml).toContain(`command = "npx"`);
expect(plannerToml).toContain(`args = ["playwright", "run-test-mcp-server"]`);
}

expect(plannerToml).toContain(`sandbox_mode = "read-only"`);
expect(plannerToml).toMatch(/enabled_tools = \[[^\]]*"planner_save_plan"[^\]]*\]/);
expect(plannerToml).toMatch(/enabled_tools = \[[^\]]*"browser_navigate"[^\]]*\]/);

const healerToml = fs.readFileSync(path.join(agentsDir, 'playwright_test_healer.toml'), 'utf-8');
expect(healerToml).toContain(`sandbox_mode = "workspace-write"`);
expect(healerToml).toMatch(/enabled_tools = \[[^\]]*"test_debug"[^\]]*\]/);
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); feat(agents): add Codex --loop=codex generator by 0xharkirat · Pull Request #40817 · microsoft/playwright · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/src/test-agents-js.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,10 @@ npx playwright init-agents --loop=vscode
npx playwright init-agents --loop=claude
```

```bash tab=bash-codex
npx playwright init-agents --loop=codex
```

```bash tab=bash-opencode
npx playwright init-agents --loop=opencode
```
Expand Down
15 changes: 15 additions & 0 deletions packages/isomorphic/stringUtils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -189,6 +189,21 @@ export function parseRegex(regex: string): RegExp {
return new RegExp(source, flags);
}

export function tomlBasicString(value: string): string {
// JSON.stringify produces a valid TOML basic string: escapes \", \\, \n, \r, \t and uses \uXXXX for control chars.
return JSON.stringify(value);
}

export function tomlArray(values: string[]): string {
return `[${values.map(value => tomlBasicString(value)).join(', ')}]`;
}

export function tomlMultilineBasicString(value: string): string {
// Triple-quoted basic string: escape backslashes first, then any literal """ sequences.
const escaped = value.replace(/\\/g, '\\\\').replace(/"""/g, '\\"\\"\\"');
return `"""\n${escaped}\n"""`;
}

// Semicolons removed from [[\]()#;?] to avoid polynomial backtracking
// when both that group and (?:;...)* can match runs of semicolons.
// \d{1,4} relaxed to \d{0,4} so empty params (e.g. ESC[;H) still match.
Expand Down
1 change: 1 addition & 0 deletions packages/playwright/src/agents/DEPS.list
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
[*]
@isomorphic/**
@utils/**
../mcp/test/
node_modules/colors/safe
Expand Down
60 changes: 60 additions & 0 deletions packages/playwright/src/agents/generateAgents.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ import path from 'path';

import colors from 'colors/safe';
import yaml from 'yaml';
import { tomlArray, tomlBasicString, tomlMultilineBasicString } from '@isomorphic/stringUtils';
import { mkdirIfNeeded } from '@utils/fileUtils';

import { defaultSeedFile, findSeedFile, seedFileContent, seedProject } from '../mcp/test/seed';
Expand DownExpand Up@@ -90,6 +91,64 @@ export class ClaudeGenerator {
}
}

export class CodexGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {
await initRepo(fullConfig, projectName, {
promptsFolder: prompts ? '.codex/prompts' : undefined,
});

const agents = await loadAgentSpecs();

await fs.promises.mkdir('.codex/agents', { recursive: true });
for (const agent of agents)
await writeFile(`.codex/agents/${CodexGenerator.codexName(agent)}.toml`, CodexGenerator.agentSpec(agent), '🤖', 'agent definition');

initRepoDone();
}

// Codex's subagent registry rejects hyphenated identifiers at spawn time with
// `error=unknown agent_type '<name>'`. Codex's own documentation only shows
// snake_case names (`pr_explorer`, `reviewer`, `docs_researcher`, ...), see
// https://developers.openai.com/codex/subagents. Translate the shared agent
// name into snake_case so the filename and the `name` field stay in sync.
static codexName(agent: AgentSpec): string {
return agent.name.replace(/-/g, '_');
}

static agentSpec(agent: AgentSpec): string {
const mcpName = 'playwright-test';
const enabledTools: string[] = [];
for (const tool of agent.tools) {
const [first, second] = tool.split('/');
if (second && first === mcpName)
enabledTools.push(second);
}

const sandboxMode = agent.tools.includes('edit') ? 'workspace-write' : 'read-only';
const mcpServer = process.platform === 'win32'
? { command: 'cmd', args: ['/c', 'npx', 'playwright', 'run-test-mcp-server'] }
: { command: 'npx', args: ['playwright', 'run-test-mcp-server'] };

const examples = agent.examples.length
? ` Examples: ${agent.examples.map(example => `<example>${example}</example>`).join('')}`
: '';

const lines: string[] = [];
lines.push(`name = ${tomlBasicString(CodexGenerator.codexName(agent))}`);
lines.push(`description = ${tomlBasicString(agent.description + examples)}`);
lines.push(`sandbox_mode = ${tomlBasicString(sandboxMode)}`);
lines.push(`developer_instructions = ${tomlMultilineBasicString(agent.instructions)}`);
lines.push('');
lines.push(`[mcp_servers.${mcpName}]`);
lines.push(`command = ${tomlBasicString(mcpServer.command)}`);
lines.push(`args = ${tomlArray(mcpServer.args)}`);
if (enabledTools.length)
lines.push(`enabled_tools = ${tomlArray(enabledTools)}`);
lines.push('');
return lines.join('\n');
}
}

export class OpencodeGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {
await initRepo(fullConfig, projectName, {
Expand DownExpand Up@@ -155,6 +214,7 @@ export class OpencodeGenerator {
return JSON.stringify(result, null, 2);
}
}

export class CopilotGenerator {
static async init(fullConfig: FullConfigInternal, projectName: string, prompts: boolean) {

Expand Down
6 changes: 4 additions & 2 deletions packages/playwright/src/program.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { builtInReporters, config, configLoader } from './common';
import { runTests, clearCache, runTestServerAction } from './cli/testActions';
import { showReport, mergeReports } from './cli/reportActions';
import { TestServerBackend, testServerBackendTools } from './mcp/test/testBackend';
import { ClaudeGenerator, OpencodeGenerator, VSCodeGenerator, CopilotGenerator } from './agents/generateAgents';
import { ClaudeGenerator, CodexGenerator, OpencodeGenerator, VSCodeGenerator, CopilotGenerator } from './agents/generateAgents';
import { packageJSON } from './package';

export { program };
Expand DownExpand Up@@ -155,7 +155,7 @@ function addInitAgentsCommand(program: Command) {
const command = program.command('init-agents');
command.description('Initialize repository agents');
const option = command.createOption('--loop <loop>', 'Agentic loop provider');
option.choices(['claude', 'copilot', 'opencode', 'vscode', 'vscode-legacy']);
option.choices(['claude', 'codex', 'copilot', 'opencode', 'vscode', 'vscode-legacy']);
command.addOption(option);
command.option('-c, --config <file>', `Configuration file to find a project to use for seed test`);
command.option('--project <project>', 'Project to use for seed test');
Expand All@@ -168,6 +168,8 @@ function addInitAgentsCommand(program: Command) {
await VSCodeGenerator.init(loadedConfig, opts.project);
} else if (opts.loop === 'claude') {
await ClaudeGenerator.init(loadedConfig, opts.project, opts.prompts);
} else if (opts.loop === 'codex') {
await CodexGenerator.init(loadedConfig, opts.project, opts.prompts);
} else {
await CopilotGenerator.init(loadedConfig, opts.project, opts.prompts);
return;
Expand Down
31 changes: 31 additions & 0 deletions tests/mcp/init-agents.spec.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -90,3 +90,34 @@ test('claude generates correct mcp config', async ({ }) => {
expect(mcpJson.mcpServers['playwright-test'].args).toEqual(['playwright', 'run-test-mcp-server']);
}
});

test('codex generates agent toml files', async ({ }) => {
const baseDir = await writeFiles({
'playwright.config.ts': `module.exports = {};`,
});

await runInitAgents({ cwd: baseDir, args: ['--loop', 'codex'] });

const agentsDir = path.join(baseDir, '.codex', 'agents');
expect(fs.existsSync(agentsDir)).toBe(true);

const plannerToml = fs.readFileSync(path.join(agentsDir, 'playwright_test_planner.toml'), 'utf-8');
expect(plannerToml).toContain(`name = "playwright_test_planner"`);
expect(plannerToml).toContain(`[mcp_servers.playwright-test]`);
expect(plannerToml).toContain(`developer_instructions = """`);
Comment thread
0xharkirat marked this conversation as resolved.
if (process.platform === 'win32') {
expect(plannerToml).toContain(`command = "cmd"`);
expect(plannerToml).toContain(`args = ["/c", "npx", "playwright", "run-test-mcp-server"]`);
} else {
expect(plannerToml).toContain(`command = "npx"`);
expect(plannerToml).toContain(`args = ["playwright", "run-test-mcp-server"]`);
}

expect(plannerToml).toContain(`sandbox_mode = "read-only"`);
expect(plannerToml).toMatch(/enabled_tools = \[[^\]]*"planner_save_plan"[^\]]*\]/);
expect(plannerToml).toMatch(/enabled_tools = \[[^\]]*"browser_navigate"[^\]]*\]/);

const healerToml = fs.readFileSync(path.join(agentsDir, 'playwright_test_healer.toml'), 'utf-8');
expect(healerToml).toContain(`sandbox_mode = "workspace-write"`);
expect(healerToml).toMatch(/enabled_tools = \[[^\]]*"test_debug"[^\]]*\]/);
});
Loading