164 lines
12 KiB
TypeScript
164 lines
12 KiB
TypeScript
import { afterEach, beforeEach, describe, expect, it } from "vitest";
|
|
import { chmodSync, mkdtempSync, readFileSync, statSync, rmSync } from "node:fs";
|
|
import { tmpdir } from "node:os";
|
|
import path from "node:path";
|
|
import { randomUUID } from "node:crypto";
|
|
import { buildApp } from "../server/app.js";
|
|
import { loadConfig, prepareDataDirectories } from "../server/config.js";
|
|
import { openDatabase } from "../server/db/index.js";
|
|
import { hashPassword } from "../server/security.js";
|
|
import { detectPlatform } from "../server/update.js";
|
|
|
|
describe("更新 API", () => {
|
|
let dataDir: string;
|
|
let config: ReturnType<typeof loadConfig>;
|
|
let database: ReturnType<typeof openDatabase>;
|
|
let app: Awaited<ReturnType<typeof buildApp>>;
|
|
const originalFetch = globalThis.fetch;
|
|
|
|
beforeEach(async () => {
|
|
dataDir = mkdtempSync(path.join(tmpdir(), "tallynote-update-api-"));
|
|
process.env.TALLYNOTE_DATA_DIR = dataDir;
|
|
process.env.TALLYNOTE_PUBLIC_ORIGIN = "http://127.0.0.1:3995";
|
|
process.env.TALLYNOTE_COOKIE_SECURE = "false";
|
|
process.env.TALLYNOTE_UPDATE_STRATEGY = "systemd";
|
|
process.env.TALLYNOTE_UPDATE_METADATA_URL = "https://updates.example/latest";
|
|
process.env.TALLYNOTE_UPDATE_ALLOWED_HOSTS = "updates.example";
|
|
// This API fixture focuses on queue ownership; the signature path is
|
|
// covered by update.test.ts with a generated Ed25519 key.
|
|
process.env.TALLYNOTE_UPDATE_REQUIRE_SIGNATURE = "false";
|
|
config = loadConfig();
|
|
prepareDataDirectories(config);
|
|
database = openDatabase(config);
|
|
app = await buildApp(database, config);
|
|
});
|
|
|
|
afterEach(async () => {
|
|
globalThis.fetch = originalFetch;
|
|
await app.close();
|
|
database.sqlite.close();
|
|
rmSync(dataDir, { recursive: true, force: true });
|
|
for (const key of ["TALLYNOTE_DATA_DIR", "TALLYNOTE_PUBLIC_ORIGIN", "TALLYNOTE_COOKIE_SECURE", "TALLYNOTE_UPDATE_STRATEGY", "TALLYNOTE_UPDATE_METADATA_URL", "TALLYNOTE_UPDATE_ALLOWED_HOSTS", "TALLYNOTE_UPDATE_REQUIRE_SIGNATURE", "TALLYNOTE_UPDATE_PUBLIC_KEY"]) delete process.env[key];
|
|
});
|
|
|
|
async function login(username = "update-admin") {
|
|
const adminId = randomUUID();
|
|
const password = "UpdateApiPassword!2026";
|
|
const passwordHash = await hashPassword(password);
|
|
database.sqlite.prepare(`
|
|
INSERT INTO admins(id, username, username_norm, display_name, password_hash, status,
|
|
must_change_password, auth_version, version, created_at)
|
|
VALUES (?, ?, ?, ?, ?, 'active', 0, 1, 1, ?)
|
|
`).run(adminId, username, username, `更新测试管理员-${username}`, passwordHash, Date.now());
|
|
const response = await app.inject({ method: "POST", url: "/api/auth/login", headers: { origin: config.publicOrigin }, payload: { username, password } });
|
|
const raw = response.headers["set-cookie"];
|
|
const cookies = (Array.isArray(raw) ? raw : [raw ?? ""]).map((value) => value.split(";", 1)[0]).join("; ");
|
|
const csrf = /(?:^|; )tally_csrf=([^;]+)/.exec(cookies)?.[1] ?? "";
|
|
return { cookies, csrf };
|
|
}
|
|
|
|
function mockRelease() {
|
|
const digest = "c".repeat(64);
|
|
const asset = `tallynote-1.1.8-${detectPlatform().target}-glibc.tar.gz`;
|
|
globalThis.fetch = (async (input: string | URL) => input.toString().endsWith("SHA256SUMS")
|
|
? new Response(`${digest} ${asset}\n`, { status: 200 })
|
|
: new Response(JSON.stringify({ tag_name: "v1.1.8", assets: [{ name: "SHA256SUMS", browser_download_url: "https://updates.example/SHA256SUMS" }, { name: asset, browser_download_url: `https://updates.example/${asset}` }] }), { status: 200 })) as typeof fetch;
|
|
}
|
|
|
|
it("检查 release、创建受保护请求文件并拒绝重复任务", async () => {
|
|
const session = await login();
|
|
mockRelease();
|
|
const checked = await app.inject({ method: "POST", url: "/api/update/check", headers: { origin: config.publicOrigin, cookie: session.cookies, "x-csrf-token": session.csrf }, payload: {} });
|
|
expect(checked.statusCode).toBe(200);
|
|
expect(checked.json().latest).toMatchObject({ version: "1.1.8", compatible: true, integrityReady: true, isNewer: true });
|
|
expect(checked.headers["cache-control"]).toBe("no-store");
|
|
const tooSoon = await app.inject({ method: "POST", url: "/api/update/check", headers: { origin: config.publicOrigin, cookie: session.cookies, "x-csrf-token": session.csrf }, payload: {} });
|
|
expect(tooSoon.statusCode).toBe(429);
|
|
expect(tooSoon.headers["retry-after"]).toBeDefined();
|
|
|
|
const applied = await app.inject({ method: "POST", url: "/api/update/apply", headers: { origin: config.publicOrigin, cookie: session.cookies, "x-csrf-token": session.csrf }, payload: { version: "1.1.8", confirm: true } });
|
|
expect(applied.statusCode).toBe(202);
|
|
const jobId = applied.json().job.id as string;
|
|
const request = JSON.parse(readFileSync(config.updateRequestPath, "utf8")) as { jobId: string; expectedSha256: string; currentLink: string };
|
|
expect(request).toMatchObject({ jobId, version: "1.1.8", expectedSha256: "c".repeat(64), currentLink: config.currentLink });
|
|
expect(statSync(config.updateRequestPath).mode & 0o777).toBe(0o600);
|
|
|
|
mockRelease();
|
|
const duplicate = await app.inject({ method: "POST", url: "/api/update/apply", headers: { origin: config.publicOrigin, cookie: session.cookies, "x-csrf-token": session.csrf }, payload: { version: "1.1.8", confirm: true } });
|
|
expect(duplicate.statusCode).toBe(409);
|
|
expect(duplicate.json().error.code).toBe("UPDATE_IN_PROGRESS");
|
|
const status = await app.inject({ method: "GET", url: "/api/update/status", headers: { cookie: session.cookies } });
|
|
expect(status.json().job).toMatchObject({ id: jobId, status: "queued" });
|
|
const audit = database.sqlite.prepare("SELECT action FROM audit_events WHERE action LIKE 'update.%' ORDER BY id").all() as Array<{ action: string }>;
|
|
expect(audit.map((row) => row.action)).toEqual(expect.arrayContaining(["update.checked", "update.apply_requested"]));
|
|
});
|
|
|
|
it("先下载并暂存更新包,再由同一管理员认领应用", async () => {
|
|
const session = await login("update-staged");
|
|
mockRelease();
|
|
const checked = await app.inject({ method: "POST", url: "/api/update/check", headers: { origin: config.publicOrigin, cookie: session.cookies, "x-csrf-token": session.csrf }, payload: {} });
|
|
expect(checked.statusCode).toBe(200);
|
|
const downloaded = await app.inject({ method: "POST", url: "/api/update/download", headers: { origin: config.publicOrigin, cookie: session.cookies, "x-csrf-token": session.csrf }, payload: { version: "1.1.8", confirm: true } });
|
|
expect(downloaded.statusCode).toBe(202);
|
|
const downloadJobId = downloaded.json().job.id as string;
|
|
expect(downloaded.json().job).toMatchObject({ operation: "download", status: "queued", version: "1.1.8" });
|
|
const downloadRequest = JSON.parse(readFileSync(config.updateRequestPath, "utf8")) as { jobId: string; operation: string };
|
|
expect(downloadRequest).toMatchObject({ jobId: downloadJobId, operation: "download" });
|
|
expect(database.sqlite.prepare("SELECT operation, status FROM update_jobs WHERE id=?").get(downloadJobId)).toEqual({ operation: "download", status: "queued" });
|
|
database.sqlite.prepare("UPDATE update_jobs SET status='failed', error_message='test', updated_at=? WHERE id=?").run(Date.now(), downloadJobId);
|
|
|
|
const stagedId = randomUUID();
|
|
const now = Date.now();
|
|
database.sqlite.prepare(`INSERT INTO update_jobs(id, admin_id, session_hash, request_id, requested_at, operation, status, version, platform, release_url, asset_name, asset_url, expected_sha256, actual_sha256, download_path, created_at, updated_at) VALUES (?, ?, ?, ?, ?, 'download', 'staged', ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)`)
|
|
.run(stagedId, (await database.sqlite.prepare("SELECT id FROM admins WHERE username=?").get("update-staged") as { id: string }).id, "session", "staged-request", now, "1.1.8", detectPlatform().target, config.updateMetadataUrl, "release.tar.gz", "https://updates.example/release.tar.gz", "c".repeat(64), "c".repeat(64), path.join(config.dataDir, "staged-workspace"), now, now);
|
|
const applied = await app.inject({ method: "POST", url: "/api/update/apply", headers: { origin: config.publicOrigin, cookie: session.cookies, "x-csrf-token": session.csrf }, payload: { jobId: stagedId, version: "1.1.8", confirm: true } });
|
|
expect(applied.statusCode).toBe(202);
|
|
expect(applied.json().job).toMatchObject({ id: stagedId, operation: "apply", status: "staged" });
|
|
expect(database.sqlite.prepare("SELECT operation, status FROM update_jobs WHERE id=?").get(stagedId)).toEqual({ operation: "apply", status: "staged" });
|
|
const applyRequest = JSON.parse(readFileSync(config.updateRequestPath, "utf8")) as { jobId: string; operation: string; assetUrl: string; expectedSha256: string };
|
|
expect(applyRequest).toMatchObject({ jobId: stagedId, operation: "apply", assetUrl: "https://updates.example/release.tar.gz", expectedSha256: "c".repeat(64) });
|
|
const duplicate = await app.inject({ method: "POST", url: "/api/update/apply", headers: { origin: config.publicOrigin, cookie: session.cookies, "x-csrf-token": session.csrf }, payload: { jobId: stagedId, version: "1.1.8", confirm: true } });
|
|
expect(duplicate.statusCode).toBe(409);
|
|
expect(duplicate.json().error.code).toBe("UPDATE_IN_PROGRESS");
|
|
});
|
|
|
|
it("缺少确认或未启用 systemd 时不接受更新", async () => {
|
|
const session = await login();
|
|
const invalid = await app.inject({ method: "POST", url: "/api/update/apply", headers: { origin: config.publicOrigin, cookie: session.cookies, "x-csrf-token": session.csrf }, payload: { version: "1.1.8" } });
|
|
expect(invalid.statusCode).toBe(400);
|
|
process.env.TALLYNOTE_UPDATE_STRATEGY = "disabled";
|
|
const disabledConfig = loadConfig();
|
|
expect(disabledConfig.updateStrategy).toBe("disabled");
|
|
});
|
|
|
|
it("更新任务只对发起管理员可见,并隐藏内部错误详情", async () => {
|
|
const owner = await login("update-owner");
|
|
const other = await login("update-other");
|
|
mockRelease();
|
|
const checked = await app.inject({ method: "POST", url: "/api/update/check", headers: { origin: config.publicOrigin, cookie: owner.cookies, "x-csrf-token": owner.csrf }, payload: {} });
|
|
expect(checked.statusCode).toBe(200);
|
|
const applied = await app.inject({ method: "POST", url: "/api/update/apply", headers: { origin: config.publicOrigin, cookie: owner.cookies, "x-csrf-token": owner.csrf }, payload: { version: "1.1.8", confirm: true } });
|
|
expect(applied.statusCode).toBe(202);
|
|
const jobId = applied.json().job.id as string;
|
|
database.sqlite.prepare("UPDATE update_jobs SET error_message=? WHERE id=?").run("/var/lib/tallynote/secret-command-output", jobId);
|
|
|
|
const hiddenStatus = await app.inject({ method: "GET", url: "/api/update/status", headers: { cookie: other.cookies } });
|
|
expect(hiddenStatus.statusCode).toBe(200);
|
|
expect(hiddenStatus.json().job).toBeNull();
|
|
const hiddenDetail = await app.inject({ method: "GET", url: `/api/update/jobs/${jobId}`, headers: { cookie: other.cookies } });
|
|
expect(hiddenDetail.statusCode).toBe(404);
|
|
const ownDetail = await app.inject({ method: "GET", url: `/api/update/jobs/${jobId}`, headers: { cookie: owner.cookies } });
|
|
expect(ownDetail.statusCode).toBe(200);
|
|
expect(ownDetail.json().job.errorMessage).toBe("更新失败,请查看服务器日志或重试");
|
|
});
|
|
|
|
it("应用前重新校验失败时写入失败审计", async () => {
|
|
const session = await login("update-audit");
|
|
globalThis.fetch = (async () => new Response("upstream unavailable", { status: 503 })) as typeof fetch;
|
|
const response = await app.inject({ method: "POST", url: "/api/update/apply", headers: { origin: config.publicOrigin, cookie: session.cookies, "x-csrf-token": session.csrf }, payload: { version: "1.1.8", confirm: true } });
|
|
expect(response.statusCode).toBe(502);
|
|
const audit = database.sqlite.prepare("SELECT outcome FROM audit_events WHERE action='update.apply_requested' ORDER BY id DESC LIMIT 1").get() as { outcome: string } | undefined;
|
|
expect(audit?.outcome).toBe("failure");
|
|
});
|
|
});
|