feat(codex): read the Codex config surfaces

2026-09-08 16:32:06 +07:00
parent 57849d2f75
commit 7618766861
2 changed files with 407 additions and 0 deletions
@@ -0,0 +1,135 @@
+/**
+ * @file Tests for codex-discovery.js: read-only discovery of Codex config
+ * surfaces (skills, agents, rules, memory, config) across the user (CODEX_HOME)
+ * and project (<cwd>/.codex) scopes.
+ * @author Nguyễn Ngọc Trí Vĩ <vinnt@smartgift.vn>
+ */
+
+const fs = require("node:fs");
+const path = require("node:path");
+const os = require("node:os");
+
+const { describe, it, before, after } = require("node:test");
+const assert = require("node:assert/strict");
+
+function write(file, content) {
+  fs.mkdirSync(path.dirname(file), { recursive: true });
+  fs.writeFileSync(file, content);
+}
+
+describe("codex-discovery", () => {
+  let TMP;
+  let REPO;
+  let prevCodexHome;
+  let cx;
+
+  before(() => {
+    prevCodexHome = process.env.CODEX_HOME;
+    TMP = fs.mkdtempSync(path.join(os.tmpdir(), "codex-disc-"));
+    REPO = fs.mkdtempSync(path.join(os.tmpdir(), "codex-disc-repo-"));
+    process.env.CODEX_HOME = TMP;
+    delete require.cache[require.resolve("../lib/codex-home")];
+    delete require.cache[require.resolve("../lib/codex-discovery")];
+    cx = require("../lib/codex-discovery");
+  });
+
+  after(() => {
+    if (prevCodexHome === undefined) delete process.env.CODEX_HOME;
+    else process.env.CODEX_HOME = prevCodexHome;
+    fs.rmSync(TMP, { recursive: true, force: true });
+    fs.rmSync(REPO, { recursive: true, force: true });
+  });
+
+  it("reads a user skill and a project skill into one scoped list", () => {
+    write(
+      path.join(TMP, "skills", "release-guard", "SKILL.md"),
+      "---\nname: release-guard\n---\nbody"
+    );
+    write(
+      path.join(REPO, ".codex", "skills", "onboarding", "SKILL.md"),
+      "---\nname: onboarding\n---\nb"
+    );
+
+    const rows = cx.readSkills({ cwd: REPO });
+    assert.deepEqual(rows.map((r) => [r.scope, r.name]).sort(), [
+      ["project", "onboarding"],
+      ["user", "release-guard"],
+    ]);
+    assert.equal(rows.find((r) => r.name === "release-guard").frontmatter.name, "release-guard");
+  });
+
+  it("pulls an agent's identity out of its TOML without a TOML parser", () => {
+    write(
+      path.join(REPO, ".codex", "agents", "reviewer.toml"),
+      'name = "reviewer"\ndescription = "Read-only review agent."\nmodel = "gpt-5.4"\n' +
+        'developer_instructions = """\nmulti\nline\n"""\n'
+    );
+
+    const [agent] = cx.readAgents({ cwd: REPO, scope: "project" });
+    assert.equal(agent.meta.name, "reviewer");
+    assert.equal(agent.meta.description, "Read-only review agent.");
+    assert.equal(agent.meta.model, "gpt-5.4");
+  });
+
+  it("does not mistake a key inside a triple-quoted block for a top-level field", () => {
+    const meta = cx.readTomlMeta(
+      'name = "implementer"\n' +
+        'sandbox_mode = "workspace-write"\n' +
+        'developer_instructions = """\n' +
+        'model = "not-a-real-field"\n' +
+        '"""\n' +
+        'model = "gpt-5.3-codex-spark"\n'
+    );
+    assert.equal(meta.name, "implementer");
+    assert.equal(meta.sandbox_mode, "workspace-write");
+    assert.equal(meta.model, "gpt-5.3-codex-spark");
+  });
+
+  it("reads a rule file's preview", () => {
+    write(
+      path.join(TMP, "rules", "no-force-push.rules"),
+      "never force-push main\nask before deleting"
+    );
+    const [rule] = cx.readRules({ cwd: REPO, scope: "user" });
+    assert.equal(rule.name, "no-force-push");
+    assert.match(rule.preview, /never force-push main/);
+  });
+
+  it("reports a missing AGENTS.md as a row that does not exist, not a gap", () => {
+    const rows = cx.readMemory({ cwd: REPO });
+    const user = rows.find((r) => r.scope === "user");
+    assert.equal(user.exists, false, "the UI offers to create it, so the row must be present");
+  });
+
+  it("reads project AGENTS.md from the repo root, not under .codex", () => {
+    write(path.join(REPO, "AGENTS.md"), "# Project instructions");
+    const rows = cx.readMemory({ cwd: REPO });
+    const project = rows.find((r) => r.scope === "project");
+    assert.equal(project.exists, true);
+    assert.equal(project.file, path.join(REPO, "AGENTS.md"));
+  });
+
+  it("reads config.toml content for both scopes", () => {
+    write(path.join(TMP, "config.toml"), 'model = "gpt-5.3-codex-spark"\n');
+    const rows = cx.readConfig({ cwd: REPO });
+    const user = rows.find((r) => r.scope === "user");
+    assert.equal(user.exists, true);
+    assert.match(user.content, /gpt-5\.3-codex-spark/);
+    const project = rows.find((r) => r.scope === "project");
+    assert.equal(project.exists, false);
+  });
+
+  it("never walks outside the codex roots", () => {
+    write(path.join(TMP, "skills", "esc", "SKILL.md"), "x");
+    for (const row of cx.readSkills({ cwd: REPO })) {
+      assert.ok(row.file.startsWith(TMP) || row.file.startsWith(REPO));
+    }
+  });
+
+  it("summarizes counts and roots in the overview", () => {
+    const overview = cx.readOverview({ cwd: REPO });
+    assert.equal(overview.roots.projectRoot, REPO);
+    assert.ok(overview.counts.skills.user >= 1);
+    assert.ok(overview.counts.agents.project >= 1);
+  });
+});