mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-08-23 07:32:20 +03:00
Adds a Grok Build card to the CLI Code dashboard: configures the main model and per-subagent model overrides, surgically upserts only the [model.omniroute] section of config.toml (preserving unrelated user sections), resolves config.toml via GROK_HOME or the CLI config home, and omits API keys from settings responses. Closes #10829. Validated in an isolated worktree boarded onto origin/release/v3.8.50 (0 conflicts, 14 files): - 6/48 focused node:test cases in tests/integration/cli-settings-grok-build.test.ts initially failed with 422 instead of 200/409 — traced to this route being the first CLI-tool settings route to actually pass a targetPath into the shared guardCliConfigWrite/ensureCliConfigWriteAllowed container-ephemeral-write guard (every other cli-tools/*-settings route calls it with no path, which always no-ops). This devbox genuinely runs inside Docker with no bind mount for the test's tmpdir fixtures, so the guard correctly refused — a real environment-dependent gap in the PR's own test setup (missing OMNIROUTE_ALLOW_CONTAINER_CONFIG_WRITE=1, the pattern already used by tests/unit/cli-tools-apply-container-422.test.ts for this exact guard). Fixed by setting that flag in the test file's setup, pushed fix-in-place. - 61/61 tests pass after the fix (grok-build-config, check-tool-config-status, all-statuses-route, cli-settings-grok-build, plus 13/13 UI tests via vitest for GrokBuildToolCard/ToolDetailClient). - Verified the "omit API keys from settings responses" claim: GET applies omitApiKeys() to both config/settings before responding. - check-file-size, check-changelog-integrity: OK. - typecheck:core: clean. - check-complexity / check-cognitive-complexity: OK, both under baseline. Co-authored-by: tuandinh0801 <tuandinh0801@users.noreply.github.com>
384 lines
15 KiB
TypeScript
384 lines
15 KiB
TypeScript
/**
|
|
* Integration tests for /api/cli-tools/grok-build-settings
|
|
*
|
|
* Ported from decolua/9router#2571 ("feat(cli-tools): add Grok Build setup"),
|
|
* rebuilt on top of OmniRoute's existing "custom" configType settings pattern
|
|
* (auth guard, Zod validation, write-guard, backups, sanitized errors — see
|
|
* forge-settings for the sibling implementation this mirrors).
|
|
*
|
|
* Unlike Forge's full-file overwrite, Grok Build's config.toml can hold other
|
|
* user-defined `[model.*]` sections, so the handler surgically upserts only
|
|
* the `[model.omniroute]` section and preserves the rest of the file.
|
|
*/
|
|
import test from "node:test";
|
|
import assert from "node:assert/strict";
|
|
import fs from "node:fs";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
|
|
const TEST_DATA_DIR = fs.mkdtempSync(path.join(os.tmpdir(), "omniroute-grok-build-settings-"));
|
|
process.env.DATA_DIR = TEST_DATA_DIR;
|
|
process.env.API_KEY_SECRET = "test-api-key-secret-grok-build";
|
|
process.env.JWT_SECRET = "test-jwt-secret-grok-build";
|
|
// guardCliConfigWrite refuses a write when the target isn't bind-mounted from
|
|
// the host inside a real container (see cliConfigWriteGuard.ts). This test
|
|
// suite runs inside CI/devbox containers with no such mount for its tmpdir
|
|
// fixtures, so allow the write here — the refusal path itself is covered by
|
|
// tests/unit/cli-tools-apply-container-422.test.ts.
|
|
process.env.OMNIROUTE_ALLOW_CONTAINER_CONFIG_WRITE = "1";
|
|
|
|
// Import DB reset helpers (must be before route import)
|
|
const core = await import("../../src/lib/db/core.ts");
|
|
const localDb = await import("../../src/lib/localDb.ts");
|
|
const apiKeysDb = await import("../../src/lib/db/apiKeys.ts");
|
|
|
|
// Import route handlers
|
|
const { GET, POST, DELETE } =
|
|
await import("../../src/app/api/cli-tools/grok-build-settings/route.ts");
|
|
|
|
async function resetStorage() {
|
|
delete process.env.INITIAL_PASSWORD;
|
|
core.resetDbInstance();
|
|
fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true });
|
|
fs.mkdirSync(TEST_DATA_DIR, { recursive: true });
|
|
}
|
|
|
|
async function enableAuth() {
|
|
process.env.INITIAL_PASSWORD = "test-bootstrap";
|
|
await localDb.updateSettings({ requireLogin: true, password: "" });
|
|
}
|
|
|
|
test.beforeEach(async () => {
|
|
await resetStorage();
|
|
});
|
|
|
|
// ── Test 1: GET without auth when auth is required → 401 ────────────────────
|
|
|
|
test("grok-build-settings GET: returns 401 when auth required and no token", async () => {
|
|
await enableAuth();
|
|
const res = await GET(new Request("http://localhost/api/cli-tools/grok-build-settings"));
|
|
assert.equal(res.status, 401, `Expected 401, got ${res.status}`);
|
|
});
|
|
|
|
// ── Test 2: GET with valid auth → 200 ────────────────────────────────────────
|
|
|
|
test("grok-build-settings GET: returns 200 with valid auth (grok not installed on CI)", async () => {
|
|
const res = await GET(new Request("http://localhost/api/cli-tools/grok-build-settings"));
|
|
assert.equal(res.status, 200, `Expected 200, got ${res.status}`);
|
|
const body = await res.json();
|
|
assert.ok(
|
|
"installed" in body || "config" in body,
|
|
"Response should contain installed or config field"
|
|
);
|
|
});
|
|
|
|
// ── Test 3: POST with invalid body → 400 ─────────────────────────────────────
|
|
|
|
test("grok-build-settings POST: 400 when baseUrl is missing", async () => {
|
|
const res = await POST(
|
|
new Request("http://localhost/api/cli-tools/grok-build-settings", {
|
|
method: "POST",
|
|
headers: { "content-type": "application/json" },
|
|
body: JSON.stringify({ apiKey: "sk-test", model: "grok-4.5" }), // missing baseUrl
|
|
})
|
|
);
|
|
assert.equal(res.status, 400, `Expected 400 for missing baseUrl, got ${res.status}`);
|
|
const body = await res.json();
|
|
assert.ok(body.error !== undefined, "Response should have error field");
|
|
});
|
|
|
|
test("grok-build-settings POST: 400 when model is missing", async () => {
|
|
const res = await POST(
|
|
new Request("http://localhost/api/cli-tools/grok-build-settings", {
|
|
method: "POST",
|
|
headers: { "content-type": "application/json" },
|
|
body: JSON.stringify({ baseUrl: "http://localhost:20128", apiKey: "sk-test" }),
|
|
})
|
|
);
|
|
assert.equal(res.status, 400, `Expected 400 for missing model, got ${res.status}`);
|
|
});
|
|
|
|
// ── Test 4: POST with valid body → surgically upserts [model.omniroute] ─────
|
|
|
|
test("grok-build-settings POST: writes [model.omniroute] section and preserves existing content", async () => {
|
|
const tmpHome = fs.mkdtempSync(path.join(os.tmpdir(), "grok-build-home-"));
|
|
const origHome = process.env.HOME;
|
|
process.env.HOME = tmpHome;
|
|
|
|
try {
|
|
// Pre-seed a config.toml with an unrelated user model + a non-default value,
|
|
// to prove the handler does not clobber content it does not own.
|
|
const grokDir = path.join(tmpHome, ".grok");
|
|
fs.mkdirSync(grokDir, { recursive: true });
|
|
const preExisting = [
|
|
"[models]",
|
|
'default = "grok-build"',
|
|
"",
|
|
"[model.custom-thing]",
|
|
'model = "some-other-model"',
|
|
'base_url = "https://example.test/v1"',
|
|
"",
|
|
].join("\n");
|
|
fs.writeFileSync(path.join(grokDir, "config.toml"), preExisting);
|
|
|
|
const res = await POST(
|
|
new Request("http://localhost/api/cli-tools/grok-build-settings", {
|
|
method: "POST",
|
|
headers: { "content-type": "application/json" },
|
|
body: JSON.stringify({
|
|
baseUrl: "http://localhost:20128",
|
|
apiKey: "sk-test-grok-build-key",
|
|
model: "grok-4.5",
|
|
}),
|
|
})
|
|
);
|
|
|
|
// 200 = success; 403 = write guard active (test env); 500 = backup dir issue
|
|
assert.ok([200, 403, 500].includes(res.status), `Unexpected status ${res.status}`);
|
|
|
|
if (res.status === 200) {
|
|
const body = await res.json();
|
|
assert.equal(body.success, true, "success should be true on 200");
|
|
|
|
const configPath = path.join(tmpHome, ".grok", "config.toml");
|
|
const content = fs.readFileSync(configPath, "utf-8");
|
|
|
|
assert.ok(content.includes("[model.omniroute]"), "Config should have [model.omniroute]");
|
|
assert.ok(content.includes("http://localhost:20128/v1"), "Config should contain base URL");
|
|
assert.ok(content.includes('default = "omniroute"'), "Default should point at our slot");
|
|
// The pre-existing unrelated model section must survive untouched.
|
|
// Exact line membership (not URL substring) — stronger, and dodges CodeQL
|
|
// js/incomplete-url-substring-sanitization false positives (#740/#741).
|
|
const preservedLines = content.split("\n").map((line) => line.trim());
|
|
assert.ok(
|
|
preservedLines.includes("[model.custom-thing]") &&
|
|
preservedLines.includes('base_url = "https://example.test/v1"'),
|
|
"Pre-existing unrelated [model.*] section must be preserved"
|
|
);
|
|
// The obsolete built-in default must become an absent-value sentinel.
|
|
assert.ok(
|
|
content.includes('omniroute-prev-default = "__omniroute_unset__"'),
|
|
"An obsolete default must use the absent-value sentinel"
|
|
);
|
|
}
|
|
} finally {
|
|
process.env.HOME = origHome;
|
|
fs.rmSync(tmpHome, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
// ── Test 5: DELETE → removes only our section and restores previous default ─
|
|
|
|
test("grok-build-settings DELETE: removes our section, preserves the rest, restores default", async () => {
|
|
const tmpHome = fs.mkdtempSync(path.join(os.tmpdir(), "grok-build-home-del-"));
|
|
const origHome = process.env.HOME;
|
|
process.env.HOME = tmpHome;
|
|
|
|
try {
|
|
const grokDir = path.join(tmpHome, ".grok");
|
|
fs.mkdirSync(grokDir, { recursive: true });
|
|
const preConfigured = [
|
|
"[models]",
|
|
'default = "omniroute"',
|
|
"",
|
|
'# omniroute-prev-default = "grok-build"',
|
|
"[model.omniroute]",
|
|
'model = "grok-4.5"',
|
|
'base_url = "http://localhost:20128/v1"',
|
|
'name = "OmniRoute"',
|
|
'api_backend = "chat_completions"',
|
|
'api_key = "sk-test"',
|
|
"",
|
|
"[model.custom-thing]",
|
|
'model = "some-other-model"',
|
|
'base_url = "https://example.test/v1"',
|
|
"",
|
|
].join("\n");
|
|
fs.writeFileSync(path.join(grokDir, "config.toml"), preConfigured);
|
|
|
|
const res = await DELETE(
|
|
new Request("http://localhost/api/cli-tools/grok-build-settings", { method: "DELETE" })
|
|
);
|
|
assert.ok([200, 403, 500].includes(res.status), `Expected 200/403/500, got ${res.status}`);
|
|
|
|
if (res.status === 200) {
|
|
const body = await res.json();
|
|
assert.equal(body.success, true);
|
|
|
|
const configPath = path.join(tmpHome, ".grok", "config.toml");
|
|
const content = fs.readFileSync(configPath, "utf-8");
|
|
assert.ok(!content.includes("[model.omniroute]"), "Our section should be removed");
|
|
// Exact line membership (not URL substring) — see the preserve block above (#740/#741).
|
|
const survivingLines = content.split("\n").map((line) => line.trim());
|
|
assert.ok(
|
|
survivingLines.includes("[model.custom-thing]") &&
|
|
survivingLines.includes('base_url = "https://example.test/v1"'),
|
|
"Unrelated section must survive"
|
|
);
|
|
assert.ok(!/^default\s*=/m.test(content), "The obsolete default must not be restored");
|
|
}
|
|
} finally {
|
|
process.env.HOME = origHome;
|
|
fs.rmSync(tmpHome, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
test("grok-build-settings DELETE: no-op success when no config file exists", async () => {
|
|
const tmpHome = fs.mkdtempSync(path.join(os.tmpdir(), "grok-build-home-noconfig-"));
|
|
const origHome = process.env.HOME;
|
|
process.env.HOME = tmpHome;
|
|
|
|
try {
|
|
const res = await DELETE(
|
|
new Request("http://localhost/api/cli-tools/grok-build-settings", { method: "DELETE" })
|
|
);
|
|
assert.equal(res.status, 200);
|
|
const body = await res.json();
|
|
assert.equal(body.success, true);
|
|
} finally {
|
|
process.env.HOME = origHome;
|
|
fs.rmSync(tmpHome, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
test("grok-build-settings: honors GROK_HOME and rejects a relative value", async () => {
|
|
const grokHome = fs.mkdtempSync(path.join(os.tmpdir(), "grok-build-env-home-"));
|
|
const original = process.env.GROK_HOME;
|
|
try {
|
|
process.env.GROK_HOME = grokHome;
|
|
const res = await POST(
|
|
new Request("http://localhost/api/cli-tools/grok-build-settings", {
|
|
method: "POST",
|
|
headers: { "content-type": "application/json" },
|
|
body: JSON.stringify({
|
|
baseUrl: "http://localhost:20128/v1/v1/",
|
|
apiKey: "sk-private",
|
|
model: "openai/gpt-5.5",
|
|
contextWindow: 321000,
|
|
subagentModels: {
|
|
explore: { model: "xai/grok-4", contextWindow: 256000 },
|
|
},
|
|
}),
|
|
})
|
|
);
|
|
assert.equal(res.status, 200);
|
|
const configPath = path.join(grokHome, "config.toml");
|
|
const content = fs.readFileSync(configPath, "utf8");
|
|
assert.match(content, /base_url = "http:\/\/localhost:20128\/v1"/);
|
|
assert.match(content, /context_window = 321000/);
|
|
assert.match(content, /\[model\.omniroute-explore\]/);
|
|
assert.match(content, /explore = "omniroute-explore"/);
|
|
|
|
const getRes = await GET(new Request("http://localhost/api/cli-tools/grok-build-settings"));
|
|
assert.equal(getRes.status, 200);
|
|
const body = await getRes.json();
|
|
assert.equal(body.apiKeyConfigured, true);
|
|
assert.equal("api_key" in body.config.model, false);
|
|
assert.equal("api_key" in body.config.subagentModels.explore, false);
|
|
assert.doesNotMatch(JSON.stringify(body), /sk-private/);
|
|
|
|
process.env.GROK_HOME = "relative/path";
|
|
const invalid = await POST(
|
|
new Request("http://localhost/api/cli-tools/grok-build-settings", {
|
|
method: "POST",
|
|
headers: { "content-type": "application/json" },
|
|
body: JSON.stringify({ baseUrl: "http://localhost:20128", model: "xai/grok-4" }),
|
|
})
|
|
);
|
|
assert.equal(invalid.status, 500);
|
|
} finally {
|
|
if (original === undefined) delete process.env.GROK_HOME;
|
|
else process.env.GROK_HOME = original;
|
|
fs.rmSync(grokHome, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
test("grok-build-settings POST: returns 409 for an unowned omniroute slot", async () => {
|
|
const grokHome = fs.mkdtempSync(path.join(os.tmpdir(), "grok-build-conflict-"));
|
|
const original = process.env.GROK_HOME;
|
|
process.env.GROK_HOME = grokHome;
|
|
try {
|
|
fs.writeFileSync(
|
|
path.join(grokHome, "config.toml"),
|
|
'[model.omniroute]\nmodel = "private"\nbase_url = "https://example.test/v1"\n'
|
|
);
|
|
const res = await POST(
|
|
new Request("http://localhost/api/cli-tools/grok-build-settings", {
|
|
method: "POST",
|
|
headers: { "content-type": "application/json" },
|
|
body: JSON.stringify({ baseUrl: "http://localhost:20128", model: "xai/grok-4" }),
|
|
})
|
|
);
|
|
assert.equal(res.status, 409);
|
|
} finally {
|
|
if (original === undefined) delete process.env.GROK_HOME;
|
|
else process.env.GROK_HOME = original;
|
|
fs.rmSync(grokHome, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
test("grok-build-settings POST: resolves keyId to an unmasked key", async () => {
|
|
const grokHome = fs.mkdtempSync(path.join(os.tmpdir(), "grok-build-key-id-"));
|
|
const original = process.env.GROK_HOME;
|
|
process.env.GROK_HOME = grokHome;
|
|
try {
|
|
const key = await apiKeysDb.createApiKey("Grok Build key", "grok-build-test-machine");
|
|
const res = await POST(
|
|
new Request("http://localhost/api/cli-tools/grok-build-settings", {
|
|
method: "POST",
|
|
headers: { "content-type": "application/json" },
|
|
body: JSON.stringify({
|
|
baseUrl: "http://localhost:20128",
|
|
keyId: key.id,
|
|
apiKey: "sk_****",
|
|
model: "openai/gpt-5.5",
|
|
}),
|
|
})
|
|
);
|
|
assert.equal(res.status, 200);
|
|
const content = fs.readFileSync(path.join(grokHome, "config.toml"), "utf8");
|
|
assert.match(content, new RegExp(`api_key = ${JSON.stringify(key.key)}`));
|
|
assert.doesNotMatch(content, /sk_\*\*\*\*/);
|
|
} finally {
|
|
if (original === undefined) delete process.env.GROK_HOME;
|
|
else process.env.GROK_HOME = original;
|
|
fs.rmSync(grokHome, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
// ── Test 6: Error sanitization (Hard Rule #12) ───────────────────────────────
|
|
|
|
test("grok-build-settings: error responses do not leak stack traces", async () => {
|
|
const badReq = new Request("http://localhost/api/cli-tools/grok-build-settings", {
|
|
method: "POST",
|
|
headers: { "content-type": "application/json" },
|
|
body: "{ this is not json }",
|
|
});
|
|
const res = await POST(badReq);
|
|
const bodyStr = JSON.stringify(await res.json());
|
|
assert.ok(
|
|
!bodyStr.match(/\s+at\s+\/[^\s]/),
|
|
"Error response must not contain absolute-path stack traces"
|
|
);
|
|
});
|
|
|
|
// ── Test 7: Hard Rule #13 (no exec/spawn) ────────────────────────────────────
|
|
|
|
test("grok-build-settings route.ts: does not call exec() or spawn() directly", () => {
|
|
const routePath = path.resolve(
|
|
import.meta.dirname,
|
|
"../../src/app/api/cli-tools/grok-build-settings/route.ts"
|
|
);
|
|
const content = fs.readFileSync(routePath, "utf-8");
|
|
assert.ok(!content.match(/\bexec\s*\(/), "Handler must not use exec()");
|
|
assert.ok(!content.match(/\bspawn\s*\(/), "Handler must not use spawn()");
|
|
});
|
|
|
|
test.after(async () => {
|
|
await resetStorage();
|
|
fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true });
|
|
delete process.env.DATA_DIR;
|
|
delete process.env.API_KEY_SECRET;
|
|
delete process.env.JWT_SECRET;
|
|
});
|