-
Notifications
You must be signed in to change notification settings - Fork 0
Add testing skill for the OpenCodex management API #616
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
0688106
ef9ad96
ab64dac
5380b9b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| --- | ||
| name: testing-opencodex-management-api | ||
| description: Run the opencodex proxy locally against a scratch home and exercise the management /api/* endpoints with admin-token auth (Windows + bun). | ||
| --- | ||
|
|
||
| # Testing the opencodex management API locally | ||
|
|
||
| ## Start a scratch instance | ||
| - `OPENCODEX_HOME` relocates OpenCodex-owned state ONLY (config.json, admin-api-token, | ||
| lab automation state, SQLite projections). Client homes are NOT relocated: startup | ||
| syncs can still write to the real `~/.codex`, `~/.grok`, `~/.claude`, and Claude | ||
| Desktop dirs. Point these at scratch too: `CODEX_HOME`, `GROK_HOME`, | ||
| `CLAUDE_CONFIG_DIR`, `OPENCODEX_CLAUDE_DESKTOP_CONFIG_DIR`. | ||
| - `codexAutoStart:false` does NOT gate startup client syncs: `shouldSyncCodexOnStart` | ||
| reads `clientIntegrations.codex` (absent = ON), `shouldSyncGrokOnStart` reads | ||
| `clientIntegrations.grok`, and the Claude roster write (`ocx-*.md` into | ||
| `~/.claude/agents/`) is gated by `claudeCode.enabled`/`claudeCode.injectAgents`. | ||
| Observed: a run with only OPENCODEX_HOME + codexAutoStart:false still injected five | ||
| `ocx-*.md` files into the real `~/.claude/agents/`. | ||
| - Safe scratch `config.json`: | ||
| `{"port":<testport>,"hostname":"127.0.0.1","codexAutoStart":false, | ||
| "clientIntegrations":{"codex":false,"grok":false,"claude-desktop":false}, | ||
| "claudeCode":{"injectAgents":false}}` | ||
| — loopback bind avoids the server-auth assert. Use the env vars AND the config | ||
| disables together; either alone leaves a write path open (e.g. a disabled | ||
| integration still prunes its owned files under the real home). | ||
|
devin-ai-integration[bot] marked this conversation as resolved.
|
||
| - Residual writes the recipe does NOT cover (macOS only, opencodex-owned artifacts | ||
| only): startup always runs `refreshOwnedRaycastCatalog` (rewrites an existing | ||
| opencodex-owned Raycast provider entry under the OS home — no env override) and | ||
| `reconcileShellHook` (removes the opencodex-marked block from `~/.zshrc` when the | ||
|
Comment on lines
+27
to
+30
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔍 Scratch-home warning may also apply outside macOS The skill labels Raycast writes macOS-only, but refreshOwnedRaycastCatalog has no platform gate. Check whether Windows testers with an owned Raycast catalog also need isolation. Was this helpful? React with 👍 or 👎 to provide feedback. |
||
| system env is inactive — `CLAUDE_CONFIG_DIR` does not redirect it). Harmless on a | ||
| box with neither installed; for hermetic isolation on macOS run under a disposable | ||
| OS user/home instead. | ||
| - Management auth: set `OPENCODEX_ADMIN_AUTH_TOKEN` (any non-empty string works for the env | ||
| source). If unset, the server mints `admin-api-token` in OPENCODEX_HOME on first start. | ||
| - Start foreground: `bun run src/cli/index.ts start --port <testport>` | ||
| (`bun run dev` is the same). bun is not on PATH — prefix `PATH="$HOME/.bun/bin:$PATH"` | ||
| in Git Bash. `ocx ensure`/tray paths spawn DETACHED children instead — avoid them for testing. | ||
|
|
||
| ## Calling /api/* | ||
| - Header: `x-opencodex-api-key: <token>` (or `Authorization: Bearer <token>`). No token → | ||
| `401 {"error":"opencodex admin token required"}`. Origin header NOT required for curl. | ||
| - Useful routes: `GET/PUT /api/lab/automation` (status has `schedulerRunning` — live | ||
| interval presence, not just policy), `POST /api/lab/automation/run` (SYNCHRONOUS — the | ||
| 200 response IS the terminal run record), `GET /api/lab/automation/runs`. | ||
| - PUT policy body: `{"policy":{"enabled":true,"layers":{"protocolConformance":true}}}`; | ||
| merges with disk policy atomically. | ||
| - Manual run body: `{"evidenceLayer":"protocol_conformance","scenarioId":"responses-core.protocol.request-shape"}` | ||
| — protocol_conformance runs need NO provider (in-process fixture harness; upstream is | ||
| deliberately dead). live_route_compatibility needs providerName+modelId in config. | ||
| - Scheduler tick is `LAB_AUTOMATION_HARD_MAX.schedulerTickMs` = 60s — scheduled work only | ||
| appears in `/runs` after the first tick; runs persist to `<OPENCODEX_HOME>/lab/automation-state.json`. | ||
|
Comment on lines
+40
to
+52
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔍 The described curl walkthrough is missing The PR description promises curl-based baseline, enable, and disable checks. The skill supplies routes and request bodies, but no curl commands or transition checks. Confirm whether the walkthrough belongs here. Was this helpful? React with 👍 or 👎 to provide feedback. |
||
|
|
||
| ## Windows desktop quirks | ||
| - The exec tool CANNOT spawn visible desktop windows (`cmd //c start` hangs the shell on | ||
| the inherited pipe). Open interactive windows via the computer tool: `super+r` → | ||
| `cmd /k <batch>` → Enter; snap halves with `super+Left/Right`. | ||
| - Ctrl+C on a cmd batch shows `Terminate batch job (Y/N)?` — the child process still | ||
| received SIGINT and drains normally; answer `N` to keep the window and see the exit. | ||
| - Single Ctrl+C → `🛑 Shutting down opencodex proxy...` → drainAndShutdown | ||
| (`shutdownTimeoutMs` default 5000) → exit 0. A second signal >500ms later force-exits. | ||
|
|
||
| ## Devin Secrets Needed | ||
| - none — the admin token is provisioned by the tester via env var. | ||
Uh oh!
There was an error while loading. Please reload this page.