Files
kuber/tests/server/management.test.ts
T

355 lines
11 KiB
TypeScript

import { describe, expect, test } from "bun:test";
import type { KubernetesObject, V1Deployment } from "@kubernetes/client-node";
import {
createManagementService,
type ManagementDependencies,
type ResourceIdentity,
WORKSPACE_PROJECT_LABEL,
WORKSPACE_UID_LABEL,
} from "../../server/management";
const workspace = { project: "shop", uid: "workspace-1" };
function object(
kind: string,
name: string,
uid: string,
labels: Record<string, string> = {
"app.kubernetes.io/managed-by": "kuber",
[WORKSPACE_UID_LABEL]: workspace.uid,
},
): KubernetesObject {
return {
apiVersion:
kind === "Deployment"
? "apps/v1"
: kind === "HorizontalPodAutoscaler"
? "autoscaling/v2"
: "v1",
kind,
metadata: { name, namespace: workspace.project, uid, labels },
};
}
function dependencies(
overrides: Partial<ManagementDependencies> = {},
): ManagementDependencies {
return {
readNamespace: async () => ({
uid: "namespace-uid",
labels: {
"app.kubernetes.io/managed-by": "kuber",
[WORKSPACE_UID_LABEL]: workspace.uid,
},
}),
listDeployments: async () => [],
scaleDeployment: async () => {},
restartDeployment: async () => {},
waitForDeployment: async () => {},
fetchGraphObjects: async () => [],
planRollback: async () => [],
rollbackDeployment: async () => {},
listProjectResources: async () => [],
listDatabaseResources: async () => [],
listStorageResources: async () => [],
findStaleResources: async () => [],
applyResource: async (resource) => resource,
deleteResource: async () => {},
reconcileDatabases: async () => ({}),
getDatabaseCredentials: async () => ({
username: "user",
password: "pass",
}),
reconcileStorage: async () => ({}),
getStorageCredentials: async () => ({}),
...overrides,
};
}
describe("server management service", () => {
test("contains no authorization policy and operates on an explicit workspace", async () => {
const calls: string[] = [];
const service = createManagementService(
dependencies({
listDeployments: async (project) => {
calls.push(`list:${project}`);
return [object("Deployment", "api", "api-uid") as V1Deployment];
},
scaleDeployment: async (project, name, replicas) => {
calls.push(`scale:${project}:${name}:${replicas}`);
},
}),
);
expect(await service.stop(workspace)).toEqual(["api"]);
expect(calls).toEqual(["list:shop", "scale:shop:api:0"]);
});
test("targets requested deployments and rejects unmanaged names", async () => {
const restarted: string[] = [];
const service = createManagementService(
dependencies({
listDeployments: async () =>
["api", "worker"].map(
(name) => object("Deployment", name, `${name}-uid`) as V1Deployment,
),
restartDeployment: async (_project, name) => {
restarted.push(name);
},
}),
);
expect(await service.restart(workspace, ["worker", "worker"])).toEqual([
"worker",
]);
expect(restarted).toEqual(["worker"]);
await expect(service.restart(workspace, ["missing"])).rejects.toThrow(
"No managed deployment named missing",
);
});
test("normal down retains ingress and persistent volume claims", async () => {
const resources = [
object("Deployment", "api", "deployment-uid"),
object("Ingress", "api", "ingress-uid"),
object("PersistentVolumeClaim", "data", "pvc-uid"),
object("Service", "api", "service-uid"),
];
const service = createManagementService(
dependencies({ listProjectResources: async () => resources }),
);
const plan = await service.planDown(workspace);
expect(plan.retained.map((item) => item.kind)).toEqual([
"PersistentVolumeClaim",
"Ingress",
]);
expect(plan.delete.map((item) => item.kind)).toEqual([
"Deployment",
"Service",
]);
});
test("uses stale object UIDs as immutable deletion identities", async () => {
const stale = object("Secret", "old-env", "old-secret-uid");
const deleted: ResourceIdentity[] = [];
const service = createManagementService(
dependencies({
findStaleResources: async () => [stale],
deleteResource: async (item) => {
deleted.push(item);
},
}),
);
const plan = await service.planResources(workspace, [
{ apiVersion: "v1", kind: "ConfigMap", metadata: { name: "env" } },
]);
expect(plan.desired[0]?.metadata?.labels).toMatchObject({
[WORKSPACE_UID_LABEL]: workspace.uid,
[WORKSPACE_PROJECT_LABEL]: workspace.project,
});
expect(plan.stale).toEqual([
{
apiVersion: "v1",
kind: "Secret",
name: "old-env",
namespace: "shop",
uid: "old-secret-uid",
workspaceUid: workspace.uid,
},
]);
await service.deleteResources(workspace, plan.stale);
expect(deleted).toEqual(plan.stale);
});
test("rejects namespace and resource ownership mismatches", async () => {
const wrongNamespace = createManagementService(
dependencies({
readNamespace: async () => ({
uid: "namespace-uid",
labels: {
"app.kubernetes.io/managed-by": "kuber",
[WORKSPACE_UID_LABEL]: "someone-else",
},
}),
}),
);
await expect(wrongNamespace.stop(workspace)).rejects.toThrow(
"different-workspace",
);
const wrongResource = createManagementService(
dependencies({
findStaleResources: async () => [
object("Secret", "foreign", "foreign-uid", {
"app.kubernetes.io/managed-by": "kuber",
[WORKSPACE_UID_LABEL]: "someone-else",
}),
],
}),
);
await expect(wrongResource.planResources(workspace, [])).rejects.toThrow(
"is not owned by workspace",
);
});
test("full down requires the namespace UID and includes owned external resources", async () => {
const database = {
...object("Database", "orders", "database-uid"),
apiVersion: "postgresql.cnpg.io/v1",
metadata: {
...object("Database", "orders", "database-uid").metadata,
namespace: "database",
},
};
const service = createManagementService(
dependencies({ listDatabaseResources: async () => [database] }),
);
const plan = await service.planDown(workspace, true);
expect(plan.delete.map(({ kind, uid }) => [kind, uid])).toEqual([
["Database", "database-uid"],
["Namespace", "namespace-uid"],
]);
const missingUid = createManagementService(
dependencies({
readNamespace: async () => ({
labels: {
"app.kubernetes.io/managed-by": "kuber",
[WORKSPACE_UID_LABEL]: workspace.uid,
},
}),
}),
);
await expect(missingUid.planDown(workspace, true)).rejects.toThrow(
"no UID deletion precondition",
);
});
test("stop deletes matching HPAs before scaling selected deployments", async () => {
const calls: string[] = [];
const service = createManagementService(
dependencies({
listDeployments: async () =>
["api", "worker", "batch"].map(
(name) =>
object("Deployment", name, `${name}-uid`) as V1Deployment,
),
listProjectResources: async () => [
object("HorizontalPodAutoscaler", "api", "api-hpa-uid", undefined),
object("HorizontalPodAutoscaler", "worker", "worker-hpa-uid", undefined),
object("HorizontalPodAutoscaler", "batch", "batch-hpa-uid", undefined),
],
scaleDeployment: async (_project, name, replicas) => {
calls.push(`scale:${name}:${replicas}`);
},
deleteResource: async (item) => {
calls.push(`delete:${item.kind}:${item.name}`);
},
}),
);
expect(await service.stop(workspace, ["api", "worker"])).toEqual([
"api",
"worker",
]);
expect(calls).toEqual([
"delete:HorizontalPodAutoscaler:api",
"delete:HorizontalPodAutoscaler:worker",
"scale:api:0",
"scale:worker:0",
]);
});
test("stop deletes HPAs for all deployments and leaves unrelated HPAs alone", async () => {
const calls: string[] = [];
const service = createManagementService(
dependencies({
listDeployments: async () =>
["api", "worker"].map(
(name) =>
object("Deployment", name, `${name}-uid`) as V1Deployment,
),
listProjectResources: async () => [
object("HorizontalPodAutoscaler", "api", "api-hpa-uid", undefined),
object("HorizontalPodAutoscaler", "worker", "worker-hpa-uid", undefined),
object("HorizontalPodAutoscaler", "legacy", "legacy-hpa-uid", undefined),
],
scaleDeployment: async (_project, name, replicas) => {
calls.push(`scale:${name}:${replicas}`);
},
deleteResource: async (item) => {
calls.push(`delete:${item.kind}:${item.name}`);
},
}),
);
expect(await service.stop(workspace)).toEqual(["api", "worker"]);
expect(calls).toEqual([
"delete:HorizontalPodAutoscaler:api",
"delete:HorizontalPodAutoscaler:worker",
"scale:api:0",
"scale:worker:0",
]);
});
test("refuses to delete an HPA not owned by the workspace", async () => {
const service = createManagementService(
dependencies({
listDeployments: async () =>
[object("Deployment", "api", "api-uid") as V1Deployment],
listProjectResources: async () => [
object("HorizontalPodAutoscaler", "api", "api-hpa-uid", {
"app.kubernetes.io/managed-by": "kuber",
[WORKSPACE_UID_LABEL]: "someone-else",
}),
],
}),
);
await expect(service.stop(workspace, ["api"])).rejects.toThrow(
"is not owned by workspace",
);
});
test("stop scales deployments to zero when there are no HPAs", async () => {
const calls: string[] = [];
const service = createManagementService(
dependencies({
listDeployments: async () =>
["api", "worker"].map(
(name) =>
object("Deployment", name, `${name}-uid`) as V1Deployment,
),
listProjectResources: async () => [
object("ConfigMap", "env", "env-uid"),
object("Service", "api", "api-svc-uid"),
],
scaleDeployment: async (_project, name, replicas) => {
calls.push(`scale:${name}:${replicas}`);
},
}),
);
expect(await service.stop(workspace)).toEqual(["api", "worker"]);
expect(calls).toEqual(["scale:api:0", "scale:worker:0"]);
});
test("protects reserved namespaces before consulting Kubernetes", async () => {
let read = false;
const service = createManagementService(
dependencies({
readNamespace: async () => {
read = true;
return undefined;
},
}),
);
await expect(
service.namespaceSafety({ project: "kube-system", uid: "workspace-1" }),
).rejects.toThrow("reserved");
expect(read).toBe(false);
});
});