mirror of
https://github.com/Termix-SSH/Termix.git
synced 2026-10-28 06:05:24 +00:00
feat: add plugin packing, signing, pinned trust and tmxplug bundling
This commit is contained in:
1 parent
c6a44b7ff3
commit
2ee9b3592c
25 files changed
+1764
-56
No files matched your search
@@ -0,0 +1,161 @@
|
||||
import { afterEach, describe, expect, it } from "vitest";
|
||||
import crypto from "node:crypto";
|
||||
import fs from "node:fs";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import * as tar from "tar";
|
||||
import {
|
||||
parseBundledPlugins,
|
||||
loadBundledPlugins,
|
||||
fetchArtifact,
|
||||
extractArtifact,
|
||||
} from "./lib/bundled-plugins.cjs";
|
||||
|
||||
const cleanups: Array<() => void> = [];
|
||||
|
||||
function tempDir(): string {
|
||||
const dir = fs.mkdtempSync(path.join(os.tmpdir(), "termix-bundled-"));
|
||||
cleanups.push(() => fs.rmSync(dir, { recursive: true, force: true }));
|
||||
return dir;
|
||||
}
|
||||
|
||||
afterEach(() => {
|
||||
while (cleanups.length) cleanups.pop()?.();
|
||||
});
|
||||
|
||||
const SHA = "a".repeat(64);
|
||||
|
||||
async function artifactFor(id: string): Promise<Buffer> {
|
||||
const src = tempDir();
|
||||
fs.writeFileSync(path.join(src, "manifest.json"), JSON.stringify({ id }));
|
||||
fs.mkdirSync(path.join(src, "dist"));
|
||||
fs.writeFileSync(path.join(src, "dist", "backend.js"), "export {}\n");
|
||||
const file = path.join(tempDir(), `${id}.tmxplug`);
|
||||
await tar.c({ gzip: true, file, cwd: src }, ["manifest.json", "dist"]);
|
||||
return fs.readFileSync(file);
|
||||
}
|
||||
|
||||
const sha256 = (buffer: Buffer) =>
|
||||
crypto.createHash("sha256").update(buffer).digest("hex");
|
||||
|
||||
describe("parseBundledPlugins", () => {
|
||||
it("accepts workspace and tmxplug entries", () => {
|
||||
const { plugins, problems } = parseBundledPlugins(
|
||||
{
|
||||
plugins: [
|
||||
{ id: "one", source: "workspace" },
|
||||
{
|
||||
id: "two",
|
||||
source: "tmxplug",
|
||||
url: "https://x/two.tmxplug",
|
||||
sha256: SHA,
|
||||
},
|
||||
{
|
||||
id: "three",
|
||||
source: "tmxplug",
|
||||
path: "vendor/three.tmxplug",
|
||||
sha256: SHA,
|
||||
},
|
||||
],
|
||||
},
|
||||
["one"],
|
||||
);
|
||||
expect(problems).toEqual([]);
|
||||
expect(plugins.map((p: { id: string }) => p.id)).toEqual([
|
||||
"one",
|
||||
"two",
|
||||
"three",
|
||||
]);
|
||||
});
|
||||
|
||||
it("reports a plugins folder nobody listed", () => {
|
||||
const { problems } = parseBundledPlugins(
|
||||
{ plugins: [{ id: "one", source: "workspace" }] },
|
||||
["one", "stray"],
|
||||
);
|
||||
expect(problems).toEqual([
|
||||
"plugins/stray is not listed in docker/bundled-plugins.json",
|
||||
]);
|
||||
});
|
||||
|
||||
it("reports bad entries", () => {
|
||||
const { problems } = parseBundledPlugins(
|
||||
{
|
||||
plugins: [
|
||||
{ id: "gone", source: "workspace" },
|
||||
{ id: "nohash", source: "tmxplug", url: "https://x" },
|
||||
{ id: "plain", source: "tmxplug", url: "http://x", sha256: SHA },
|
||||
{ id: "still-here", source: "tmxplug", path: "a", sha256: SHA },
|
||||
{ id: "gone", source: "workspace" },
|
||||
{ id: "odd", source: "npm" },
|
||||
],
|
||||
},
|
||||
["still-here"],
|
||||
);
|
||||
expect(problems).toEqual([
|
||||
"gone is a workspace plugin but plugins/gone does not exist",
|
||||
"nohash needs a lowercase hex sha256",
|
||||
"plain needs exactly one of an https url or a path",
|
||||
"still-here comes from a .tmxplug, so delete plugins/still-here",
|
||||
"gone is listed twice",
|
||||
'odd has an unknown source "npm"',
|
||||
]);
|
||||
});
|
||||
|
||||
it("matches the plugins folder in this repo", () => {
|
||||
const root = path.resolve(__dirname, "..");
|
||||
expect(() => loadBundledPlugins(root)).not.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe("tmxplug entries", () => {
|
||||
it("unpacks an artifact that matches its pinned sha256", async () => {
|
||||
const root = tempDir();
|
||||
const buffer = await artifactFor("demo");
|
||||
fs.writeFileSync(path.join(root, "demo.tmxplug"), buffer);
|
||||
|
||||
const fetched = await fetchArtifact(
|
||||
{ id: "demo", path: "demo.tmxplug", sha256: sha256(buffer) },
|
||||
root,
|
||||
);
|
||||
const out = path.join(root, "dist", "plugins", "demo");
|
||||
await extractArtifact(fetched, out, "demo");
|
||||
expect(fs.existsSync(path.join(out, "dist", "backend.js"))).toBe(true);
|
||||
});
|
||||
|
||||
it("refuses an artifact whose sha256 differs", async () => {
|
||||
const root = tempDir();
|
||||
fs.writeFileSync(
|
||||
path.join(root, "demo.tmxplug"),
|
||||
await artifactFor("demo"),
|
||||
);
|
||||
await expect(
|
||||
fetchArtifact({ id: "demo", path: "demo.tmxplug", sha256: SHA }, root),
|
||||
).rejects.toThrow(/bundled-plugins.json pins/);
|
||||
});
|
||||
|
||||
it("downloads once and reuses the cache", async () => {
|
||||
const root = tempDir();
|
||||
const buffer = await artifactFor("demo");
|
||||
let calls = 0;
|
||||
const fakeFetch = async () => {
|
||||
calls++;
|
||||
return new Response(buffer);
|
||||
};
|
||||
const entry = {
|
||||
id: "demo",
|
||||
url: "https://example.test/demo.tmxplug",
|
||||
sha256: sha256(buffer),
|
||||
};
|
||||
await fetchArtifact(entry, root, fakeFetch);
|
||||
await fetchArtifact(entry, root, fakeFetch);
|
||||
expect(calls).toBe(1);
|
||||
});
|
||||
|
||||
it("refuses an artifact for a different id", async () => {
|
||||
const out = path.join(tempDir(), "demo");
|
||||
await expect(
|
||||
extractArtifact(await artifactFor("other"), out, "demo"),
|
||||
).rejects.toThrow(/is for "other"/);
|
||||
});
|
||||
});
|
||||
Reference in new issue
Block a user