feat(P06): docs & hardening — AGENTS.md/README fixes, agent tests, Gitea tests, multi-project tests, version 0.7.0

---ci---
phase: 6
milestone: v0.7.0
plan: 06
task: P06-all
status: execute
---/ci---
This commit is contained in:
Jon Chery
2026-05-29 18:20:46 +00:00
parent e8c6c5c917
commit a416413c7d
15 changed files with 1031 additions and 21 deletions
+191
View File
@@ -0,0 +1,191 @@
import * as fs from "node:fs";
import * as path from "node:path";
import * as os from "node:os";
import { GiteaClient, generateReleaseNotes, GiteaReleaseConfig } from "../core/gitea.js";
const defaultConfig: GiteaReleaseConfig = {
baseUrl: "https://git.example.com",
token: "test-token-123",
owner: "testorg",
repo: "testrepo",
};
function makeReleaseResponse(overrides: Partial<{
id: number;
tag_name: string;
name: string;
body: string;
url: string;
html_url: string;
draft: boolean;
prerelease: boolean;
}> = {}): Record<string, unknown> {
return {
id: overrides.id ?? 1,
tag_name: overrides.tag_name ?? "v1.0.0",
name: overrides.name ?? "v1.0.0",
body: overrides.body ?? "Release notes",
url: overrides.url ?? "https://git.example.com/api/v1/repos/testorg/testrepo/releases/1",
html_url: overrides.html_url ?? "https://git.example.com/testorg/testrepo/releases/tag/v1.0.0",
draft: overrides.draft ?? false,
prerelease: overrides.prerelease ?? false,
};
}
describe("GiteaClient", () => {
let originalFetch: typeof globalThis.fetch;
beforeEach(() => {
originalFetch = globalThis.fetch;
});
afterEach(() => {
globalThis.fetch = originalFetch;
});
describe("createRelease", () => {
it("creates a release via POST", async () => {
const client = new GiteaClient(defaultConfig);
globalThis.fetch = jest.fn().mockResolvedValue({
ok: true,
json: async () => makeReleaseResponse({ tag_name: "v1.0.0", name: "v1.0.0" }),
});
const release = await client.createRelease({
tag_name: "v1.0.0",
name: "v1.0.0",
body: "Initial release",
});
expect(release.tag_name).toBe("v1.0.0");
expect(globalThis.fetch).toHaveBeenCalledTimes(1);
const call = (globalThis.fetch as jest.Mock).mock.calls[0];
expect(call[0]).toContain("/releases");
expect(call[1].method).toBe("POST");
expect(call[1].headers.Authorization).toBe("token test-token-123");
});
it("throws on non-ok response", async () => {
const client = new GiteaClient(defaultConfig);
globalThis.fetch = jest.fn().mockResolvedValue({
ok: false,
status: 409,
text: async () => "Conflict: tag already exists",
});
await expect(client.createRelease({
tag_name: "v1.0.0",
name: "v1.0.0",
body: "",
})).rejects.toThrow("Gitea API error: 409");
});
});
describe("listReleases", () => {
it("lists releases via GET", async () => {
const client = new GiteaClient(defaultConfig);
globalThis.fetch = jest.fn().mockResolvedValue({
ok: true,
json: async () => [
makeReleaseResponse({ id: 1, tag_name: "v1.0.0" }),
makeReleaseResponse({ id: 2, tag_name: "v1.1.0" }),
],
});
const releases = await client.listReleases();
expect(releases).toHaveLength(2);
expect(releases[0].tag_name).toBe("v1.0.0");
expect(releases[1].tag_name).toBe("v1.1.0");
});
it("throws on non-ok response", async () => {
const client = new GiteaClient(defaultConfig);
globalThis.fetch = jest.fn().mockResolvedValue({
ok: false,
status: 500,
});
await expect(client.listReleases()).rejects.toThrow("Gitea API error: 500");
});
});
describe("getReleaseByTag", () => {
it("returns release when found", async () => {
const client = new GiteaClient(defaultConfig);
globalThis.fetch = jest.fn().mockResolvedValue({
ok: true,
status: 200,
json: async () => makeReleaseResponse({ tag_name: "v1.0.0" }),
});
const release = await client.getReleaseByTag("v1.0.0");
expect(release).not.toBeNull();
expect(release!.tag_name).toBe("v1.0.0");
});
it("returns null on 404", async () => {
const client = new GiteaClient(defaultConfig);
globalThis.fetch = jest.fn().mockResolvedValue({
ok: false,
status: 404,
});
const release = await client.getReleaseByTag("v0.0.0");
expect(release).toBeNull();
});
it("throws on other non-ok status", async () => {
const client = new GiteaClient(defaultConfig);
globalThis.fetch = jest.fn().mockResolvedValue({
ok: false,
status: 500,
});
await expect(client.getReleaseByTag("v1.0.0")).rejects.toThrow("Gitea API error: 500");
});
});
});
describe("generateReleaseNotes", () => {
let dir: string;
beforeEach(() => {
dir = fs.mkdtempSync(path.join(os.tmpdir(), "ciagent-gitea-test-"));
});
afterEach(() => {
fs.rmSync(dir, { recursive: true, force: true });
});
it("parses git log into categorized sections", () => {
const gitDir = path.join(dir, "repo");
fs.mkdirSync(gitDir, { recursive: true });
const { execSync } = require("node:child_process");
execSync("git init", { cwd: gitDir, stdio: "pipe" });
execSync('git config user.email "test@test.com"', { cwd: gitDir, stdio: "pipe" });
execSync('git config user.name "Test"', { cwd: gitDir, stdio: "pipe" });
fs.writeFileSync(path.join(gitDir, "file1.txt"), "hello");
execSync("git add -A", { cwd: gitDir, stdio: "pipe" });
execSync('git commit -m "feat: add authentication"', { cwd: gitDir, stdio: "pipe" });
fs.writeFileSync(path.join(gitDir, "file2.txt"), "world");
execSync("git add -A", { cwd: gitDir, stdio: "pipe" });
execSync('git commit -m "fix: resolve login bug"', { cwd: gitDir, stdio: "pipe" });
execSync("git tag v1.0.0", { cwd: gitDir, stdio: "pipe" });
const notes = generateReleaseNotes(gitDir, null, "v1.0.0");
expect(notes).toContain("New Features");
expect(notes).toContain("add authentication");
expect(notes).toContain("Bug Fixes");
expect(notes).toContain("resolve login bug");
});
it("returns no-commits message when no commits found", () => {
const nonExistent = path.join(dir, "nonexistent");
const notes = generateReleaseNotes(nonExistent, null, "v0.0.0");
expect(notes).toContain("No commits found");
});
});
+171
View File
@@ -0,0 +1,171 @@
import * as fs from "node:fs";
import * as path from "node:path";
import * as os from "node:os";
import { CIAgentFiles, ProjectEntry } from "../core/ciagent-files.js";
import { initCIAgent, loadConfig, saveConfig } from "../core/config.js";
import { DEFAULT_CIAGENT_CONFIG } from "../types/config.js";
function createTempDir(): string {
return fs.mkdtempSync(path.join(os.tmpdir(), "ciagent-multiproject-test-"));
}
function cleanup(dir: string): void {
fs.rmSync(dir, { recursive: true, force: true });
}
describe("Multi-project CIAgentFiles operations", () => {
let dir: string;
beforeEach(() => {
dir = createTempDir();
});
afterEach(() => {
cleanup(dir);
});
describe("--project flag behavior via CIAgentFiles", () => {
it("sets active project via setActiveProject", () => {
const ciFiles = new CIAgentFiles(dir);
ciFiles.ensureCIDir();
ciFiles.addProject("task-api", "Task API");
ciFiles.addProject("auth-svc", "Auth Service");
ciFiles.setActiveProject("auth-svc");
expect(ciFiles.getActiveProject()).toBe("auth-svc");
});
it("lists all added projects", () => {
const ciFiles = new CIAgentFiles(dir);
ciFiles.ensureCIDir();
ciFiles.addProject("task-api", "Task API");
ciFiles.addProject("auth-svc", "Auth Service");
const projects = ciFiles.listProjects();
expect(projects.length).toBeGreaterThanOrEqual(2);
const slugs = projects.map(p => p.slug);
expect(slugs).toContain("task-api");
expect(slugs).toContain("auth-svc");
});
it("addProject does not duplicate existing slug", () => {
const ciFiles = new CIAgentFiles(dir);
ciFiles.ensureCIDir();
ciFiles.addProject("task-api", "Task API");
ciFiles.addProject("task-api", "Task API V2");
const projects = ciFiles.listProjects();
const taskApiProjects = projects.filter(p => p.slug === "task-api");
expect(taskApiProjects.length).toBe(1);
});
it("defaults to empty string when no active project set", () => {
const ciFiles = new CIAgentFiles(dir);
ciFiles.ensureCIDir();
expect(ciFiles.getActiveProject()).toBe("");
});
it("isMultiProject returns false for single or no projects", () => {
const ciFiles = new CIAgentFiles(dir);
ciFiles.ensureCIDir();
expect(ciFiles.isMultiProject()).toBe(false);
});
it("isMultiProject returns true when projects exist in config", () => {
const ciFiles = new CIAgentFiles(dir);
ciFiles.ensureCIDir();
ciFiles.addProject("task-api", "Task API");
ciFiles.addProject("auth-svc", "Auth Service");
expect(ciFiles.isMultiProject()).toBe(true);
});
});
describe("config-level project operations", () => {
it("initCIAgent with slug adds project to config", () => {
const config = initCIAgent(dir, undefined, "task-api", "Task API");
expect(config.projects).toHaveLength(1);
expect(config.active_project).toBe("task-api");
});
it("--project override sets active_project in config", () => {
initCIAgent(dir, undefined, "task-api", "Task API");
const config = loadConfig(dir);
config.active_project = "task-api";
config.projects = [
{ slug: "task-api", name: "Task API", default: true },
{ slug: "auth-svc", name: "Auth Service" },
];
saveConfig(dir, config);
const loaded = loadConfig(dir);
expect(loaded.active_project).toBe("task-api");
expect(loaded.projects).toHaveLength(2);
});
it("setActiveProject persists to config", () => {
initCIAgent(dir, undefined, "task-api", "Task API");
const ciFiles = new CIAgentFiles(dir);
ciFiles.addProject("auth-svc", "Auth Service");
ciFiles.setActiveProject("auth-svc");
const config = loadConfig(dir);
expect(config.active_project).toBe("auth-svc");
});
});
describe("project slug and directory structure", () => {
it("multi-project mode uses .ciagent/<slug>/ subdirectory", () => {
const ciFiles = new CIAgentFiles(dir, "task-api");
ciFiles.ensureCIDir();
ciFiles.ensureProjectDir();
const projectDir = path.join(dir, ".ciagent", "task-api");
expect(fs.existsSync(projectDir)).toBe(true);
});
it("single-project mode uses .ciagent/ directly", () => {
const ciFiles = new CIAgentFiles(dir);
ciFiles.ensureCIDir();
ciFiles.ensureProjectDir();
expect(fs.existsSync(path.join(dir, ".ciagent"))).toBe(true);
expect(fs.existsSync(path.join(dir, ".ciagent", "task-api"))).toBe(false);
});
it("writeProjectMd writes to project subdirectory in multi-project", () => {
const ciFiles = new CIAgentFiles(dir, "task-api");
ciFiles.ensureCIDir();
ciFiles.ensureProjectDir();
ciFiles.writeProjectMd({
name: "Task API",
coreValue: "Manage tasks",
requirements: { validated: [], active: ["Task CRUD"], outOfScope: [] },
constraints: ["Node.js"],
context: "REST API",
keyDecisions: [],
}, "test write");
expect(fs.existsSync(path.join(dir, ".ciagent", "task-api", "PROJECT.md"))).toBe(true);
});
it("readProjectMd reads from project subdirectory in multi-project", () => {
const ciFiles = new CIAgentFiles(dir, "task-api");
ciFiles.ensureCIDir();
ciFiles.ensureProjectDir();
ciFiles.writeProjectMd({
name: "Task API",
coreValue: "Manage tasks",
requirements: { validated: [], active: [], outOfScope: [] },
constraints: [],
context: "",
keyDecisions: [],
}, "test write");
const projectMd = ciFiles.readProjectMd();
expect(projectMd).not.toBeNull();
expect(projectMd!.name).toBe("Task API");
});
});
});