mirror of
https://github.com/getpaseo/paseo.git
synced 2026-07-29 12:01:31 +00:00
315 lines
8.2 KiB
TypeScript
315 lines
8.2 KiB
TypeScript
/**
|
|
* Test Daemon Helper
|
|
*
|
|
* Provides utilities for launching real Paseo daemons in E2E tests.
|
|
* Each test gets an isolated daemon on a random port with its own PASEO_HOME.
|
|
*
|
|
* CRITICAL RULES (from design doc):
|
|
* 1. Port: Random port in 20000-30000 range - NEVER use 6767 (production)
|
|
* 2. Protocol: WebSocket ONLY - daemon has no HTTP endpoints
|
|
* 3. Temp dirs: Create temp directories for PASEO_HOME and agent --cwd
|
|
* 4. Model: Always use claude provider with haiku model for fast, cheap tests
|
|
* 5. Cleanup: Kill daemon and remove temp dirs after each test
|
|
*/
|
|
|
|
import { mkdtemp, rm, mkdir } from 'fs/promises'
|
|
import { existsSync } from 'fs'
|
|
import { tmpdir } from 'os'
|
|
import { join } from 'path'
|
|
import { ChildProcess, spawn } from 'child_process'
|
|
|
|
export interface TestDaemonContext {
|
|
/** Random port for test daemon (never 6767) */
|
|
port: number
|
|
/** WebSocket URL for connecting to daemon */
|
|
wsUrl: string
|
|
/** Temp directory for PASEO_HOME */
|
|
paseoHome: string
|
|
/** Temp directory for agent working directory */
|
|
workDir: string
|
|
/** Running daemon process */
|
|
process: ChildProcess | null
|
|
/** Whether the daemon is ready to accept connections */
|
|
isReady: boolean
|
|
/** Stop the daemon and clean up resources */
|
|
stop: () => Promise<void>
|
|
}
|
|
|
|
/**
|
|
* Generate a random port for test daemon
|
|
* Uses range 20000-30000 to avoid conflicts
|
|
* NEVER uses 6767 (user's running daemon)
|
|
*/
|
|
export function getRandomPort(): number {
|
|
return 20000 + Math.floor(Math.random() * 10000)
|
|
}
|
|
|
|
/**
|
|
* Create isolated temp directories for testing
|
|
*/
|
|
export async function createTempDirs(): Promise<{ paseoHome: string; workDir: string }> {
|
|
const paseoHome = await mkdtemp(join(tmpdir(), 'paseo-e2e-home-'))
|
|
const workDir = await mkdtemp(join(tmpdir(), 'paseo-e2e-work-'))
|
|
|
|
// Create the agents directory that the daemon expects
|
|
const agentsDir = join(paseoHome, 'agents')
|
|
await mkdir(agentsDir, { recursive: true })
|
|
|
|
return { paseoHome, workDir }
|
|
}
|
|
|
|
/**
|
|
* Wait for daemon to be ready by running `paseo agent ls`
|
|
* This connects via WebSocket and ensures the daemon is responsive
|
|
*/
|
|
async function waitForDaemonReady(
|
|
port: number,
|
|
timeout = 30000
|
|
): Promise<void> {
|
|
const start = Date.now()
|
|
|
|
while (Date.now() - start < timeout) {
|
|
try {
|
|
const { exitCode } = await runPaseoCli(
|
|
{
|
|
port,
|
|
wsUrl: `ws://127.0.0.1:${port}`,
|
|
paseoHome: '',
|
|
workDir: '',
|
|
process: null,
|
|
isReady: false,
|
|
stop: async () => {}
|
|
},
|
|
['agent', 'ls']
|
|
)
|
|
|
|
if (exitCode === 0) {
|
|
return // Daemon is ready
|
|
}
|
|
} catch {
|
|
// Connection failed, keep trying
|
|
}
|
|
await sleep(100)
|
|
}
|
|
throw new Error(`Daemon failed to become ready on port ${port} within ${timeout}ms`)
|
|
}
|
|
|
|
function sleep(ms: number): Promise<void> {
|
|
return new Promise((resolve) => setTimeout(resolve, ms))
|
|
}
|
|
|
|
/**
|
|
* Start a test daemon programmatically using the server's bootstrap API
|
|
*
|
|
* This starts the daemon in a separate process using the CLI's daemon start command
|
|
* with isolated PASEO_HOME and PASEO_LISTEN environment variables.
|
|
*/
|
|
export async function startTestDaemon(options?: {
|
|
port?: number
|
|
paseoHome?: string
|
|
workDir?: string
|
|
timeout?: number
|
|
}): Promise<TestDaemonContext> {
|
|
const port = options?.port ?? getRandomPort()
|
|
const { paseoHome, workDir } = options?.paseoHome && options?.workDir
|
|
? { paseoHome: options.paseoHome, workDir: options.workDir }
|
|
: await createTempDirs()
|
|
const timeout = options?.timeout ?? 30000
|
|
|
|
const wsUrl = `ws://127.0.0.1:${port}`
|
|
|
|
// Find the CLI entry point - use the source file directly with tsx
|
|
const cliDir = join(import.meta.dirname, '..', '..')
|
|
const cliSrcPath = join(cliDir, 'src', 'index.ts')
|
|
|
|
// Start daemon process using tsx to run TypeScript directly
|
|
const daemonProcess = spawn('npx', ['tsx', cliSrcPath, 'daemon', 'start', '--foreground'], {
|
|
env: {
|
|
...process.env,
|
|
PASEO_HOME: paseoHome,
|
|
PASEO_LISTEN: `127.0.0.1:${port}`,
|
|
// Disable relay for tests
|
|
PASEO_RELAY_ENABLED: 'false',
|
|
// Force no TTY to prevent QR code output
|
|
CI: 'true',
|
|
},
|
|
stdio: ['ignore', 'pipe', 'pipe'],
|
|
detached: false,
|
|
})
|
|
|
|
let stdout = ''
|
|
let stderr = ''
|
|
|
|
daemonProcess.stdout?.on('data', (data) => {
|
|
stdout += data.toString()
|
|
})
|
|
|
|
daemonProcess.stderr?.on('data', (data) => {
|
|
stderr += data.toString()
|
|
})
|
|
|
|
const cleanup = async () => {
|
|
if (daemonProcess && !daemonProcess.killed) {
|
|
daemonProcess.kill('SIGTERM')
|
|
// Wait for process to exit
|
|
await new Promise<void>((resolve) => {
|
|
const timeoutId = setTimeout(() => {
|
|
daemonProcess.kill('SIGKILL')
|
|
resolve()
|
|
}, 5000)
|
|
|
|
daemonProcess.on('exit', () => {
|
|
clearTimeout(timeoutId)
|
|
resolve()
|
|
})
|
|
})
|
|
}
|
|
|
|
// Clean up temp directories
|
|
try {
|
|
if (existsSync(paseoHome)) {
|
|
await rm(paseoHome, { recursive: true, force: true })
|
|
}
|
|
} catch {
|
|
// Ignore cleanup errors
|
|
}
|
|
|
|
try {
|
|
if (existsSync(workDir)) {
|
|
await rm(workDir, { recursive: true, force: true })
|
|
}
|
|
} catch {
|
|
// Ignore cleanup errors
|
|
}
|
|
}
|
|
|
|
// Handle process errors
|
|
daemonProcess.on('error', (err) => {
|
|
console.error('Daemon process error:', err)
|
|
})
|
|
|
|
daemonProcess.on('exit', (code) => {
|
|
if (code !== 0 && code !== null) {
|
|
console.error(`Daemon process exited with code ${code}`)
|
|
if (stderr) {
|
|
console.error('Daemon stderr:', stderr)
|
|
}
|
|
}
|
|
})
|
|
|
|
const ctx: TestDaemonContext = {
|
|
port,
|
|
wsUrl,
|
|
paseoHome,
|
|
workDir,
|
|
process: daemonProcess,
|
|
isReady: false,
|
|
stop: cleanup,
|
|
}
|
|
|
|
// Wait for daemon to be ready
|
|
try {
|
|
await waitForDaemonReady(port, timeout)
|
|
ctx.isReady = true
|
|
} catch (err) {
|
|
// Daemon failed to start - clean up and rethrow
|
|
await cleanup()
|
|
const message = err instanceof Error ? err.message : String(err)
|
|
throw new Error(`Failed to start test daemon: ${message}\nStdout: ${stdout}\nStderr: ${stderr}`)
|
|
}
|
|
|
|
return ctx
|
|
}
|
|
|
|
/**
|
|
* Run a paseo CLI command against a test daemon
|
|
*
|
|
* This is a helper that sets the correct environment variables
|
|
* to point at the test daemon.
|
|
*/
|
|
export async function runPaseoCli(
|
|
ctx: TestDaemonContext,
|
|
args: string[],
|
|
options?: {
|
|
timeout?: number
|
|
cwd?: string
|
|
}
|
|
): Promise<{ exitCode: number; stdout: string; stderr: string }> {
|
|
const timeout = options?.timeout ?? 60000
|
|
const cwd = options?.cwd ?? ctx.workDir
|
|
|
|
const cliDir = join(import.meta.dirname, '..', '..')
|
|
const cliSrcPath = join(cliDir, 'src', 'index.ts')
|
|
|
|
return new Promise((resolve, reject) => {
|
|
const proc = spawn('npx', ['tsx', cliSrcPath, ...args], {
|
|
env: {
|
|
...process.env,
|
|
PASEO_HOST: `localhost:${ctx.port}`,
|
|
PASEO_HOME: ctx.paseoHome,
|
|
},
|
|
cwd,
|
|
stdio: ['ignore', 'pipe', 'pipe'],
|
|
})
|
|
|
|
let stdout = ''
|
|
let stderr = ''
|
|
|
|
proc.stdout?.on('data', (data) => {
|
|
stdout += data.toString()
|
|
})
|
|
|
|
proc.stderr?.on('data', (data) => {
|
|
stderr += data.toString()
|
|
})
|
|
|
|
const timeoutId = setTimeout(() => {
|
|
proc.kill('SIGKILL')
|
|
reject(new Error(`CLI command timed out after ${timeout}ms: paseo ${args.join(' ')}`))
|
|
}, timeout)
|
|
|
|
proc.on('exit', (code) => {
|
|
clearTimeout(timeoutId)
|
|
resolve({
|
|
exitCode: code ?? 1,
|
|
stdout,
|
|
stderr,
|
|
})
|
|
})
|
|
|
|
proc.on('error', (err) => {
|
|
clearTimeout(timeoutId)
|
|
reject(err)
|
|
})
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Create a test context that includes a started daemon
|
|
* and a helper to run CLI commands against it.
|
|
*
|
|
* This is the main entry point for E2E tests.
|
|
*/
|
|
export async function createE2ETestContext(options?: {
|
|
timeout?: number
|
|
}): Promise<
|
|
TestDaemonContext & {
|
|
/** Run a paseo CLI command against this daemon */
|
|
paseo: (args: string[], opts?: { timeout?: number; cwd?: string }) => Promise<{
|
|
exitCode: number
|
|
stdout: string
|
|
stderr: string
|
|
}>
|
|
}
|
|
> {
|
|
const ctx = await startTestDaemon({ timeout: options?.timeout })
|
|
|
|
const paseo = (args: string[], opts?: { timeout?: number; cwd?: string }) =>
|
|
runPaseoCli(ctx, args, opts)
|
|
|
|
return {
|
|
...ctx,
|
|
paseo,
|
|
}
|
|
}
|