Add a ${resource:<name>.url} env-template ref that resolves to the internal URL
of a database the same manifest declares, read back from the live resource's
internal_db_url — never stored in the age store, never decrypted, never printed.
This deletes the two-pass generated-secret bootstrap for a database's own URL
rather than automating it: no placeholder, no stored copy to drift or overwrite,
and a rotated password is simply followed on the next apply.
Resolution runs in one function (fillDerivedEnv) against two URL maps: at diff
time against databases already on the box (so a matching app shows no drift —
killing the "secret DATABASE_URL differs" noise that ran on every plan), and in
the executor at apply time against a database created earlier in the same run
(the from-nothing case; apply acts databases-before-applications, #45). The
unresolved sentinel is never written — the executor refuses, rather than write a
blank that boots the app pointed at nothing, and re-running once the database is
up resolves it as an ordinary update.
A ${resource:X.url} naming a database the manifest does not declare, or an
attribute other than .url, is a hard plan-time error refused by every verb that
opens a template (apply, diff, capture). generated_secrets and the two-pass
bootstrap remain for the residual class — a provider-generated value that
genuinely is not derivable.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
116 lines
4.4 KiB
TypeScript
116 lines
4.4 KiB
TypeScript
import { describe, expect, it } from "vitest";
|
|
import {
|
|
DERIVED_UNRESOLVED,
|
|
assertEnvVarPolicy,
|
|
fillDerivedEnv,
|
|
resolveTemplate,
|
|
templateRefs,
|
|
templateResourceRefs,
|
|
unresolvedDerived,
|
|
} from "../src/envtemplate.js";
|
|
|
|
describe("resolveTemplate", () => {
|
|
it("classifies literals as non-secret and ${…} as secret", () => {
|
|
const r = resolveTemplate(
|
|
"PORT=3000\nMAILGUN_KEY=${MAILGUN_KEY}\n# comment\n\n",
|
|
{
|
|
MAILGUN_KEY: "mk-123",
|
|
},
|
|
);
|
|
expect(r.vars.PORT).toEqual({ value: "3000", secret: false });
|
|
expect(r.vars.MAILGUN_KEY).toEqual({ value: "mk-123", secret: true });
|
|
});
|
|
it("throws on a missing secret, naming key and placeholder", () => {
|
|
expect(() => resolveTemplate("API_KEY=${NOPE}", {})).toThrow(
|
|
/NOPE.*API_KEY|API_KEY.*NOPE/,
|
|
);
|
|
});
|
|
it("throws on malformed lines with the line number", () => {
|
|
expect(() => resolveTemplate("PORT=3000\nnot a line", {})).toThrow(
|
|
/line 2/,
|
|
);
|
|
});
|
|
});
|
|
|
|
describe("assertEnvVarPolicy", () => {
|
|
const withFlag = { vars: { ALLOW_SEED: { value: "false", secret: false } } };
|
|
const banAllow = ["^ALLOW_"];
|
|
|
|
it("refuses when a forbidden var is PRESENT, even set false", () => {
|
|
expect(() =>
|
|
assertEnvVarPolicy("prod", { "core-api": withFlag }, banAllow),
|
|
).toThrow(/ALLOW_SEED.*core-api.*off.*absent/s);
|
|
});
|
|
it("allows the same env where the policy is not declared", () => {
|
|
expect(() =>
|
|
assertEnvVarPolicy("staging", { "core-api": withFlag }, undefined),
|
|
).not.toThrow();
|
|
});
|
|
it("is a pattern, not a fixed list — it catches unforeseen siblings", () => {
|
|
const future = {
|
|
vars: { ALLOW_WIPE_EVERYTHING: { value: "true", secret: false } },
|
|
};
|
|
expect(() =>
|
|
assertEnvVarPolicy("prod", { worker: future }, banAllow),
|
|
).toThrow(/ALLOW_WIPE_EVERYTHING/);
|
|
});
|
|
it("leaves vars that do not match the pattern alone", () => {
|
|
const ok = { vars: { PORT: { value: "3000", secret: false } } };
|
|
expect(() =>
|
|
assertEnvVarPolicy("prod", { "core-api": ok }, banAllow),
|
|
).not.toThrow();
|
|
});
|
|
});
|
|
|
|
describe("derived resource refs (#60)", () => {
|
|
const template =
|
|
"PORT=3000\nMAILGUN_KEY=${MAILGUN_KEY}\nDATABASE_URL=${resource:postgres.url}\n";
|
|
|
|
it("resolveTemplate marks a ${resource:…} var derived and UNRESOLVED, not secret-missing", () => {
|
|
// No store entry for it, and yet it does not throw the way a missing secret
|
|
// does: a derived value is not in the store to be missing FROM.
|
|
const r = resolveTemplate(template, { MAILGUN_KEY: "mk" });
|
|
expect(r.vars.DATABASE_URL).toEqual({
|
|
value: DERIVED_UNRESOLVED,
|
|
secret: true,
|
|
derived: { resource: "postgres", attr: "url" },
|
|
});
|
|
// The secret and the literal are untouched by the new branch.
|
|
expect(r.vars.MAILGUN_KEY).toEqual({ value: "mk", secret: true });
|
|
expect(r.vars.PORT).toEqual({ value: "3000", secret: false });
|
|
});
|
|
|
|
it("templateResourceRefs reports the edge; templateRefs does NOT treat it as a secret", () => {
|
|
expect(templateResourceRefs(template)).toEqual([
|
|
{ key: "DATABASE_URL", resource: "postgres", attr: "url" },
|
|
]);
|
|
// capture reads templateRefs — a derived edge must never appear there, or it
|
|
// would go hunting for a store name called `resource:postgres.url`.
|
|
expect(templateRefs(template).map((r) => r.key)).toEqual(["MAILGUN_KEY"]);
|
|
});
|
|
|
|
it("fillDerivedEnv resolves against a URL map and leaves the rest alone", () => {
|
|
const env = resolveTemplate(template, { MAILGUN_KEY: "mk" });
|
|
const filled = fillDerivedEnv(env, {
|
|
postgres: "postgres://u:p@uuid:5432/db",
|
|
});
|
|
expect(filled.vars.DATABASE_URL).toEqual({
|
|
value: "postgres://u:p@uuid:5432/db",
|
|
secret: true,
|
|
derived: { resource: "postgres", attr: "url" },
|
|
});
|
|
expect(unresolvedDerived(filled)).toEqual([]);
|
|
});
|
|
|
|
it("fillDerivedEnv leaves a ref whose resource is absent (or empty) unresolved", () => {
|
|
const env = resolveTemplate(template, { MAILGUN_KEY: "mk" });
|
|
// Absent from the map, and present-but-empty, are both non-resolutions — an
|
|
// empty URL must never be written (it boots the app pointed at nothing).
|
|
expect(unresolvedDerived(fillDerivedEnv(env, {}))).toEqual([
|
|
{ key: "DATABASE_URL", resource: "postgres" },
|
|
]);
|
|
expect(unresolvedDerived(fillDerivedEnv(env, { postgres: "" }))).toEqual([
|
|
{ key: "DATABASE_URL", resource: "postgres" },
|
|
]);
|
|
});
|
|
});
|