fix(enterprise): add step skipped event

We now emit a `workflowStepSkipped` event when a workflow step is skipped.
garden-io · Nov 6, 2020 · f644cdb · f644cdb
1 parent b866079
commit f644cdb
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 6 deletions.
diff --git a/core/src/commands/run/workflow.ts b/core/src/commands/run/workflow.ts
@@ -107,6 +107,7 @@ export class RunWorkflowCommand extends Command<Args, {}> {
           outputs: {},
           log: "",
         }
+        garden.events.emit("workflowStepSkipped", { index })
         continue
       }
 

diff --git a/core/src/events.ts b/core/src/events.ts
@@ -163,6 +163,9 @@ export interface Events extends LoggerEvents {
   workflowStepProcessing: {
     index: number
   }
+  workflowStepSkipped: {
+    index: number
+  }
   workflowStepComplete: {
     index: number
     durationMsec: number
@@ -202,6 +205,7 @@ export const eventNames: EventName[] = [
   "workflowRunning",
   "workflowComplete",
   "workflowStepProcessing",
+  "workflowStepSkipped",
   "workflowStepError",
   "workflowStepComplete",
 ]
diff --git a/core/test/unit/src/commands/run/workflow.ts b/core/test/unit/src/commands/run/workflow.ts
@@ -122,7 +122,7 @@ describe("RunWorkflowCommand", () => {
         name: "workflow-a",
         kind: "Workflow",
         path: garden.projectRoot,
-        steps: [{ command: ["deploy"] }, { command: ["test"] }],
+        steps: [{ command: ["deploy"] }, { command: ["build"], skip: true }, { command: ["test"] }],
       },
     ])
 
@@ -137,13 +137,15 @@ describe("RunWorkflowCommand", () => {
     expect(we[2].payload.index).to.eql(0)
     expect(we[2].payload.durationMsec).to.gte(0)
 
-    expect(we[3]).to.eql({ name: "workflowStepProcessing", payload: { index: 1 } })
+    expect(we[3]).to.eql({ name: "workflowStepSkipped", payload: { index: 1 } })
+
+    expect(we[4]).to.eql({ name: "workflowStepProcessing", payload: { index: 2 } })
 
-    expect(we[4].name).to.eql("workflowStepComplete")
-    expect(we[4].payload.index).to.eql(1)
-    expect(we[4].payload.durationMsec).to.gte(0)
+    expect(we[5].name).to.eql("workflowStepComplete")
+    expect(we[5].payload.index).to.eql(2)
+    expect(we[5].payload.durationMsec).to.gte(0)
 
-    expect(we[5]).to.eql({ name: "workflowComplete", payload: {} })
+    expect(we[6]).to.eql({ name: "workflowComplete", payload: {} })
   })
 
   function filterLogEntries(entries: LogEntry[], msgRegex: RegExp): LogEntry[] {
@@ -663,6 +665,7 @@ function getWorkflowEvents(garden: TestGarden) {
     "workflowRunning",
     "workflowComplete",
     "workflowStepProcessing",
+    "workflowStepSkipped",
     "workflowStepError",
     "workflowStepComplete",
   ]