mirror of
https://github.com/jackwener/OpenCLI.git
synced 2026-09-14 18:25:42 +08:00
257e9ec4f8
# feat: add E2E testing infrastructure with real Chrome in CI ## What Establish a comprehensive E2E testing framework for opencli using **real Chrome + xvfb virtual display** in GitHub Actions CI. ## Changes ### E2E Test Suite (~52 test cases) - `public-commands.test.ts` — Public API commands (hackernews, v2ex) - `browser-public.test.ts` — Browser commands for public data across all 18 sites (21 tests) - `browser-auth.test.ts` — Graceful failure verification for login-required commands (14 tests) - `management.test.ts` — Full coverage of management commands (list/validate/verify/version/help) - `output-formats.test.ts` — Output format validation (json/yaml/csv/md) - `smoke/api-health.test.ts` — Scheduled API health checks ### Auto-detect Browser Mode - `buildMcpArgs` automatically selects mode based on `PLAYWRIGHT_MCP_EXTENSION_TOKEN`: - Token present → `--extension` (local user, connects to logged-in Chrome) - Token absent → standalone (CI launches its own browser) - No extra environment variables needed ### CI Pipeline - `e2e-headed.yml` — Real Chrome via `browser-actions/setup-chrome` + `xvfb-run` in headed mode - `ci.yml` — build + unit-test (2 shards) + smoke-test (scheduled/manual) - Browser commands that return empty data due to geo-blocking or bot detection gracefully warn + pass without blocking CI ### Documentation - New `TESTING.md` — Architecture, coverage, local setup, how to add tests, CI explanation - Updated `README.md` — Added Testing section with quick-start commands
64 lines
1.6 KiB
TypeScript
64 lines
1.6 KiB
TypeScript
/**
|
|
* Shared helpers for E2E tests.
|
|
* Runs the built opencli binary as a subprocess.
|
|
*/
|
|
|
|
import { execFile } from 'node:child_process';
|
|
import { promisify } from 'node:util';
|
|
import * as path from 'node:path';
|
|
import { fileURLToPath } from 'node:url';
|
|
|
|
const exec = promisify(execFile);
|
|
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
|
const ROOT = path.resolve(__dirname, '../..');
|
|
const MAIN = path.join(ROOT, 'dist', 'main.js');
|
|
|
|
export interface CliResult {
|
|
stdout: string;
|
|
stderr: string;
|
|
code: number;
|
|
}
|
|
|
|
/**
|
|
* Run `opencli` as a child process with the given arguments.
|
|
* Without PLAYWRIGHT_MCP_EXTENSION_TOKEN, opencli auto-launches its own browser.
|
|
*/
|
|
export async function runCli(
|
|
args: string[],
|
|
opts: { timeout?: number; env?: Record<string, string> } = {},
|
|
): Promise<CliResult> {
|
|
const timeout = opts.timeout ?? 30_000;
|
|
try {
|
|
const { stdout, stderr } = await exec('node', [MAIN, ...args], {
|
|
cwd: ROOT,
|
|
timeout,
|
|
env: {
|
|
...process.env,
|
|
// Prevent chalk colors from polluting test assertions
|
|
FORCE_COLOR: '0',
|
|
NO_COLOR: '1',
|
|
...opts.env,
|
|
},
|
|
});
|
|
return { stdout, stderr, code: 0 };
|
|
} catch (err: any) {
|
|
return {
|
|
stdout: err.stdout ?? '',
|
|
stderr: err.stderr ?? '',
|
|
code: err.code ?? 1,
|
|
};
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Parse JSON output from a CLI command.
|
|
* Throws a descriptive error if parsing fails.
|
|
*/
|
|
export function parseJsonOutput(stdout: string): any {
|
|
try {
|
|
return JSON.parse(stdout.trim());
|
|
} catch {
|
|
throw new Error(`Failed to parse CLI JSON output:\n${stdout.slice(0, 500)}`);
|
|
}
|
|
}
|