Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/gittensory-engine/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ export {
} from "./governor-ledger.js";
export * from "./plan-export.js";
export { countPlanStepsByStatus } from "./plan-step-stats.js";
export { isPlanFullyCompleted } from "./plan-completion.js";
export * from "./plan-templates.js";
export * from "./portfolio/queue.js";
export {
Expand Down
9 changes: 9 additions & 0 deletions packages/gittensory-engine/src/plan-completion.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import type { PlanDag } from "./plan-export.js";

/**
* Return whether every step in the plan is completed. Empty plans are not considered complete.
* Pure — reads the plan DAG only.
*/
export function isPlanFullyCompleted(plan: PlanDag): boolean {
return plan.steps.length > 0 && plan.steps.every((step) => step.status === "completed");
}
59 changes: 59 additions & 0 deletions test/unit/plan-completion.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
import { describe, expect, it } from "vitest";

import { isPlanFullyCompleted } from "../../packages/gittensory-engine/src/plan-completion";
import type { PlanStep } from "../../packages/gittensory-engine/src/plan-export";

function step(over: Partial<PlanStep> & { id: string; title: string }): PlanStep {
return {
actionClass: undefined,
dependsOn: [],
status: "pending",
attempts: 0,
maxAttempts: 3,
lastError: null,
...over,
};
}

describe("isPlanFullyCompleted", () => {
it("returns false for an empty plan", () => {
expect(isPlanFullyCompleted({ steps: [] })).toBe(false);
});

it("returns true when every step is completed", () => {
expect(
isPlanFullyCompleted({
steps: [
step({ id: "a", title: "Build", status: "completed" }),
step({ id: "b", title: "Test", status: "completed" }),
],
}),
).toBe(true);
});

it("returns false when any step is not completed", () => {
expect(
isPlanFullyCompleted({
steps: [
step({ id: "a", title: "Build", status: "completed" }),
step({ id: "b", title: "Test", status: "pending" }),
],
}),
).toBe(false);
expect(
isPlanFullyCompleted({
steps: [step({ id: "a", title: "Deploy", status: "failed" })],
}),
).toBe(false);
});

it("is exported from the package barrel", async () => {
const barrel = await import("../../packages/gittensory-engine/src/index");
expect(typeof barrel.isPlanFullyCompleted).toBe("function");
expect(
barrel.isPlanFullyCompleted({
steps: [step({ id: "a", title: "A", status: "completed" })],
}),
).toBe(true);
});
});
Loading