diff --git a/packages/gittensory-engine/src/index.ts b/packages/gittensory-engine/src/index.ts index d1ef6cba82..3fe4e1f595 100644 --- a/packages/gittensory-engine/src/index.ts +++ b/packages/gittensory-engine/src/index.ts @@ -143,6 +143,7 @@ export { isPlanFullyCompleted } from "./plan-completion.js"; export { hasPlanFailedSteps } from "./plan-failure.js"; export { hasPlanPendingSteps } from "./plan-pending.js"; export { hasPlanRunningSteps } from "./plan-running.js"; +export { hasPlanSkippedSteps } from "./plan-skipped.js"; export * from "./plan-templates.js"; export * from "./portfolio/queue.js"; export { diff --git a/packages/gittensory-engine/src/plan-skipped.ts b/packages/gittensory-engine/src/plan-skipped.ts new file mode 100644 index 0000000000..1dc48a8bde --- /dev/null +++ b/packages/gittensory-engine/src/plan-skipped.ts @@ -0,0 +1,8 @@ +import type { PlanDag } from "./plan-export.js"; + +/** + * Return whether any step in the plan was skipped. Pure — reads the plan DAG only. + */ +export function hasPlanSkippedSteps(plan: PlanDag): boolean { + return plan.steps.some((step) => step.status === "skipped"); +} diff --git a/test/unit/plan-skipped.test.ts b/test/unit/plan-skipped.test.ts new file mode 100644 index 0000000000..f21f3f154c --- /dev/null +++ b/test/unit/plan-skipped.test.ts @@ -0,0 +1,54 @@ +import { describe, expect, it } from "vitest"; + +import { hasPlanSkippedSteps } from "../../packages/gittensory-engine/src/plan-skipped"; +import type { PlanStep } from "../../packages/gittensory-engine/src/plan-export"; + +function step(over: Partial & { id: string; title: string }): PlanStep { + return { + actionClass: undefined, + dependsOn: [], + status: "pending", + attempts: 0, + maxAttempts: 3, + lastError: null, + ...over, + }; +} + +describe("hasPlanSkippedSteps", () => { + it("returns false for an empty plan", () => { + expect(hasPlanSkippedSteps({ steps: [] })).toBe(false); + }); + + it("returns false when no step was skipped", () => { + expect( + hasPlanSkippedSteps({ + steps: [ + step({ id: "a", title: "Build", status: "completed" }), + step({ id: "b", title: "Test", status: "pending" }), + ], + }), + ).toBe(false); + }); + + it("returns true when at least one step was skipped", () => { + expect( + hasPlanSkippedSteps({ + steps: [ + step({ id: "a", title: "Build", status: "completed" }), + step({ id: "b", title: "Deploy", status: "skipped" }), + ], + }), + ).toBe(true); + }); + + it("is exported from the package barrel", async () => { + const barrel = await import("../../packages/gittensory-engine/src/index"); + expect(typeof barrel.hasPlanSkippedSteps).toBe("function"); + expect( + barrel.hasPlanSkippedSteps({ + steps: [step({ id: "a", title: "A", status: "skipped" })], + }), + ).toBe(true); + }); +});