Luigit
repositories / pi-ext

pi-ext

bugabingas pi extensions

owned by admin

scripts/changelog.test.ts

Raw
import { spawnSync } from "node:child_process";
import {
	mkdirSync,
	mkdtempSync,
	readdirSync,
	readFileSync,
	rmSync,
	statSync,
	writeFileSync,
} from "node:fs";
import { tmpdir } from "node:os";
import { join, relative } from "node:path";
import { afterEach, expect, it, vi } from "vitest";

let root: string | undefined;
afterEach(() => {
	vi.doUnmock("./lib/common.ts");
	vi.doUnmock("node:child_process");
	vi.resetModules();
	if (root) rmSync(root, { recursive: true, force: true });
});

function files(dir: string) {
	return Object.fromEntries(
		readdirSync(dir, { recursive: true })
			.map(String)
			.filter((path) => !path.startsWith(".git"))
			.filter((path) => statSync(join(dir, path)).isFile())
			.sort()
			.map((path) => [path, readFileSync(join(dir, path), "utf8")]),
	);
}

it.each([false, true])(
	"changelog --write changes only root history and preserves legacy entries (existing version: %s)",
	async (existingVersion) => {
		const dir = mkdtempSync(join(tmpdir(), "pi-ext-changelog-test-"));
		root = dir;
		expect(spawnSync("git", ["init", "--quiet", dir]).status).toBe(0);
		writeFileSync(join(dir, "package.json"), '{"version":"1.0.0"}\n');
		for (const name of ["selected", "other"]) {
			const ext = join(dir, "extensions", name);
			mkdirSync(ext, { recursive: true });
			writeFileSync(join(ext, "package.json"), JSON.stringify({ name }));
			writeFileSync(join(ext, "README.md"), `# ${name}\n`);
		}
		const history =
			"## 0.9.0\n\n- Earlier release\n\n## Legacy extension history\n\n### selected\n\n#### selected: Unreleased\n\n- Preserved engineering detail\n";
		const prefix = "# Changelog\n\n## Unreleased\n\n- Pending work\n\n";
		writeFileSync(
			join(dir, "CHANGELOG.md"),
			prefix +
				(existingVersion ? "## 1.0.0\n\n- Stale entry\n\n" : "") +
				history,
		);
		const before = files(dir);
		const generated = "## 1.0.0\n\n- Deterministic engineering update\n";
		vi.doMock("./lib/common.ts", async (importOriginal) => {
			const common = await importOriginal<typeof import("./lib/common.ts")>();
			return {
				...common,
				ROOT: dir,
				rel: (path: string) => relative(dir, path).replaceAll("\\", "/"),
				git: (args: string[]) =>
					spawnSync("git", args, { cwd: dir, encoding: "utf8" }),
			};
		});
		vi.doMock("node:child_process", async (importOriginal) => ({
			...(await importOriginal<typeof import("node:child_process")>()),
			spawnSync: (command: string, ...args: unknown[]) => {
				if (command === "pi" || command === "pi.cmd")
					return { status: 0, stdout: generated, stderr: "" };
				throw new Error(`Unexpected generation subprocess: ${command} ${args}`);
			},
		}));
		vi.resetModules();
		const { main } = await import("./extensions.ts");
		expect(await main(["changelog", "--write", "selected"])).toBe(0);
		const updated = readFileSync(join(dir, "CHANGELOG.md"), "utf8");
		expect(files(dir)).toEqual({ ...before, "CHANGELOG.md": updated });
		expect(updated).toContain(generated);
		expect(updated).toContain("## Unreleased\n\n- Pending work\n");
		expect(updated.endsWith(history)).toBe(true);
		expect(updated.match(/^## 1\.0\.0$/gm)).toHaveLength(1);
		expect(updated).not.toContain("Stale entry");
	},
);