Coolify API tokens are team-scoped, and a wrong-team token does not error: the API resolves what it cannot see to `null` (getResourceByUuid walks resource → environment → project → team_id and returns null on a mismatch). To cast, `null` is indistinguishable from "this resource does not exist yet" — an invitation to create it. So an apply with a token minted under the wrong team would not fail loudly; it would provision a duplicate set of resources into the wrong team, against whatever server that team owns. Silent, mutating, discovered late. That makes this a correctness bug, not hardening. - environments.yaml carries a required `team:` per environment (id, name, or both). Required is the point: an environment with no declared team is one cast cannot verify it is pointed at. - Every command that reaches a live Coolify (apply, diff, server add, smoke) resolves GET /teams/current — the only endpoint that answers "what team does this token act as?" — and aborts on mismatch before its first READ, not merely its first write: a wrong-team diff reports "everything is absent", which is the very lie an apply would then act on. - server add and smoke take --env for this reason. A server belongs to exactly one team forever (no pivot, no is_system_wide escape hatch), and smoke writes env vars onto a live app. - New read-only `cast team` prints the token's team, so the binding can be filled in without a chicken-and-egg. With --env it also checks the binding: the dry run for "would apply refuse?". Team id 0 is a first-class value, not a falsy absent — it is the Root Team that a single-admin instance keeps everything in (app/Models/User.php). Also records the #4 investigation in docs/semantics.md: GithubApp `is_system_wide` IS the supported way to serve every team — list_github_apps scopes to `team_id = token's team OR is_system_wide`, and POST /github-apps accepts the flag — so per-team App duplication is unnecessary. Corollary: resolving a GitHub App by name is NOT a proxy for being in the right team, which is the second reason the assert has to be explicit. Closes #9 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
198 lines
6.2 KiB
TypeScript
198 lines
6.2 KiB
TypeScript
import { describe, expect, it } from "vitest";
|
|
import { loadBindings } from "../src/bindings.js";
|
|
import { loadManifest } from "../src/manifest.js";
|
|
|
|
const FIX = new URL("./fixtures/", import.meta.url).pathname;
|
|
|
|
describe("loadManifest", () => {
|
|
it("parses a valid manifest", () => {
|
|
const m = loadManifest(`${FIX}manifest.yaml`);
|
|
expect(m.project).toBe("widget");
|
|
expect(m.environments.prod.applications["core-api"].build.pack).toBe(
|
|
"nixpacks",
|
|
);
|
|
expect(m.environments.prod.databases?.postgres.backup?.retention).toBe(7);
|
|
});
|
|
it("rejects unknown build packs", () => {
|
|
expect(() =>
|
|
loadManifest(`${FIX}manifest.yaml`, {
|
|
overrideText: `
|
|
project: x
|
|
environments:
|
|
prod:
|
|
applications:
|
|
a:
|
|
source: { repo: o/r, branch: main }
|
|
build: { pack: docker-compose, base_directory: / }
|
|
domains: []
|
|
`,
|
|
}),
|
|
).toThrow(/pack/);
|
|
});
|
|
it("rejects instance identity in manifests (no uuid-like fields)", () => {
|
|
expect(() =>
|
|
loadManifest(`${FIX}manifest.yaml`, {
|
|
overrideText: `
|
|
project: x
|
|
environments:
|
|
prod:
|
|
applications:
|
|
a:
|
|
source: { repo: o/r, branch: main }
|
|
build: { pack: static, base_directory: / }
|
|
domains: []
|
|
server_uuid: abc123
|
|
`,
|
|
}),
|
|
).toThrow(/unrecognized|server_uuid/i);
|
|
});
|
|
it("accepts a dockercompose app with compose_file + service_domains and no port/healthcheck/domains", () => {
|
|
const m = loadManifest(`${FIX}manifest.yaml`, {
|
|
overrideText: `
|
|
project: widget
|
|
environments:
|
|
prod:
|
|
applications:
|
|
core:
|
|
source: { repo: acme/widget, branch: main }
|
|
build: { pack: dockercompose, base_directory: /, compose_file: docker-compose.yaml }
|
|
service_domains:
|
|
api: ["https://api.example.com"]
|
|
env_template: core.prod.env.template
|
|
`,
|
|
});
|
|
const app = m.environments.prod.applications.core;
|
|
expect(app.build.pack).toBe("dockercompose");
|
|
expect(app.build.compose_file).toBe("docker-compose.yaml");
|
|
expect(app.service_domains).toEqual({ api: ["https://api.example.com"] });
|
|
expect(app.port).toBeUndefined();
|
|
expect(app.healthcheck).toBeUndefined();
|
|
expect(app.domains).toBeUndefined();
|
|
});
|
|
it("rejects a dockercompose app without compose_file", () => {
|
|
expect(() =>
|
|
loadManifest(`${FIX}manifest.yaml`, {
|
|
overrideText: `
|
|
project: widget
|
|
environments:
|
|
prod:
|
|
applications:
|
|
core:
|
|
source: { repo: acme/widget, branch: main }
|
|
build: { pack: dockercompose, base_directory: / }
|
|
service_domains:
|
|
api: ["https://api.example.com"]
|
|
`,
|
|
}),
|
|
).toThrow(/compose_file/);
|
|
});
|
|
it("rejects a dockercompose app with top-level domains", () => {
|
|
expect(() =>
|
|
loadManifest(`${FIX}manifest.yaml`, {
|
|
overrideText: `
|
|
project: widget
|
|
environments:
|
|
prod:
|
|
applications:
|
|
core:
|
|
source: { repo: acme/widget, branch: main }
|
|
build: { pack: dockercompose, base_directory: /, compose_file: docker-compose.yaml }
|
|
service_domains:
|
|
api: ["https://api.example.com"]
|
|
domains: ["https://api.example.com"]
|
|
`,
|
|
}),
|
|
).toThrow(/domains/);
|
|
});
|
|
it("rejects service_domains on a nixpacks app", () => {
|
|
expect(() =>
|
|
loadManifest(`${FIX}manifest.yaml`, {
|
|
overrideText: `
|
|
project: widget
|
|
environments:
|
|
prod:
|
|
applications:
|
|
core:
|
|
source: { repo: acme/widget, branch: main }
|
|
build: { pack: nixpacks, base_directory: / }
|
|
domains: ["https://api.example.com"]
|
|
service_domains:
|
|
api: ["https://api.example.com"]
|
|
`,
|
|
}),
|
|
).toThrow(/service_domains/);
|
|
});
|
|
});
|
|
|
|
describe("loadBindings", () => {
|
|
it("parses bindings", () => {
|
|
const b = loadBindings(`${FIX}environments.yaml`);
|
|
expect(b.environments.prod.server).toBe("prod-box");
|
|
expect(b.github_apps.widget).toBe("my-github-app");
|
|
});
|
|
it("carries an environment's forbidden_var_patterns through", () => {
|
|
const b = loadBindings(`${FIX}environments.yaml`);
|
|
expect(b.environments.prod.forbidden_var_patterns).toEqual(["^ALLOW_"]);
|
|
expect(b.environments.staging.forbidden_var_patterns).toBeUndefined();
|
|
});
|
|
it("carries an environment's expected team through", () => {
|
|
const b = loadBindings(`${FIX}environments.yaml`);
|
|
expect(b.environments.prod.team).toEqual({ id: 1, name: "heavy-duty" });
|
|
});
|
|
// Fail-closed at the schema: an environment with no declared team is one
|
|
// whose token cannot be verified, and an unverifiable target is exactly the
|
|
// duplicate-into-the-wrong-team failure the binding exists to prevent.
|
|
it("rejects an environment with no team", () => {
|
|
expect(() =>
|
|
loadBindings(`${FIX}environments.yaml`, {
|
|
overrideText: `
|
|
environments:
|
|
prod: { server: prod-box }
|
|
github_apps: { widget: my-github-app }
|
|
`,
|
|
}),
|
|
).toThrow(/team/);
|
|
});
|
|
it("rejects a team that names neither id nor name", () => {
|
|
expect(() =>
|
|
loadBindings(`${FIX}environments.yaml`, {
|
|
overrideText: `
|
|
environments:
|
|
prod: { server: prod-box, team: {} }
|
|
github_apps: { widget: my-github-app }
|
|
`,
|
|
}),
|
|
).toThrow(/at least one of/);
|
|
});
|
|
// Coolify's Root Team is id 0 (app/Models/User.php @ v4.1.2) — the team a
|
|
// single-admin instance keeps everything in. Rejecting it would make the id
|
|
// check unusable on exactly the topology that most needs it.
|
|
it("accepts team id 0, the Root Team", () => {
|
|
const b = loadBindings(`${FIX}environments.yaml`, {
|
|
overrideText: `
|
|
environments:
|
|
prod: { server: prod-box, team: { id: 0, name: Root Team } }
|
|
github_apps: { widget: my-github-app }
|
|
`,
|
|
});
|
|
expect(b.environments.prod.team).toEqual({ id: 0, name: "Root Team" });
|
|
});
|
|
it("accepts a team given by id alone, or by name alone", () => {
|
|
const byId = loadBindings(`${FIX}environments.yaml`, {
|
|
overrideText: `
|
|
environments:
|
|
prod: { server: prod-box, team: { id: 2 } }
|
|
github_apps: { widget: my-github-app }
|
|
`,
|
|
});
|
|
expect(byId.environments.prod.team).toEqual({ id: 2 });
|
|
const byName = loadBindings(`${FIX}environments.yaml`, {
|
|
overrideText: `
|
|
environments:
|
|
prod: { server: prod-box, team: { name: heavy-duty } }
|
|
github_apps: { widget: my-github-app }
|
|
`,
|
|
});
|
|
expect(byName.environments.prod.team).toEqual({ name: "heavy-duty" });
|
|
});
|
|
});
|