Validate that the workflow payload is correct

ManageIQ · Oct 31, 2023 · 33d5ca5 · 33d5ca5
1 parent 76851e3
commit 33d5ca5
Show file tree

Hide file tree

Showing 14 changed files with 149 additions and 19 deletions.
diff --git a/lib/floe.rb b/lib/floe.rb
@@ -26,6 +26,7 @@
 require_relative "floe/workflow/states/choice"
 require_relative "floe/workflow/states/fail"
 require_relative "floe/workflow/states/map"
+require_relative "floe/workflow/states/non_terminal_mixin"
 require_relative "floe/workflow/states/parallel"
 require_relative "floe/workflow/states/pass"
 require_relative "floe/workflow/states/succeed"

diff --git a/lib/floe/workflow.rb b/lib/floe/workflow.rb
@@ -38,6 +38,10 @@ def initialize(payload, context = nil, credentials = {})
       credentials = JSON.parse(credentials) if credentials.kind_of?(String)
       context     = Context.new(context)    unless context.kind_of?(Context)
 
+      raise Floe::InvalidWorkflowError, "Missing field \"States\""  if payload["States"].nil?
+      raise Floe::InvalidWorkflowError, "Missing field \"StartAt\"" if payload["StartAt"].nil?
+      raise Floe::InvalidWorkflowError, "\"StartAt\" not in the \"States\" field" unless payload["States"].key?(payload["StartAt"])
+
       @payload     = payload
       @context     = context
       @credentials = credentials

diff --git a/lib/floe/workflow/path.rb b/lib/floe/workflow/path.rb
@@ -11,6 +11,9 @@ def value(payload, context, input = {})
 
       def initialize(payload)
         @payload = payload
+
+        raise Floe::InvalidWorkflowError, "Path [#{payload}] must be a string" if payload.nil? || !payload.kind_of?(String)
+        raise Floe::InvalidWorkflowError, "Path [#{payload}] must start with \"$\"" if payload[0] != "$"
       end
 
       def value(context, input = {})

diff --git a/lib/floe/workflow/state.rb b/lib/floe/workflow/state.rb
@@ -8,6 +8,7 @@ class State
       class << self
         def build!(workflow, name, payload)
           state_type = payload["Type"]
+          raise Floe::InvalidWorkflowError, "Missing \"Type\" field in state [#{name}]" if payload["Type"].nil?
 
           begin
             klass = Floe::Workflow::States.const_get(state_type)
@@ -27,6 +28,9 @@ def initialize(workflow, name, payload)
         @payload  = payload
         @type     = payload["Type"]
         @comment  = payload["Comment"]
+
+        raise Floe::InvalidWorkflowError, "Missing \"Type\" field in state [#{name}]" if payload["Type"].nil?
+        raise Floe::InvalidWorkflowError, "State name [#{name}] must be less than or equal to 80 characters" if name.length > 80
       end
 
       def run!(_input = nil)

diff --git a/lib/floe/workflow/states/choice.rb b/lib/floe/workflow/states/choice.rb
@@ -9,6 +9,8 @@ class Choice < Floe::Workflow::State
         def initialize(workflow, name, payload)
           super
 
+          validate_state!
+
           @choices = payload["Choices"].map { |choice| ChoiceRule.build(choice) }
           @default = payload["Default"]
 
@@ -33,6 +35,22 @@ def running?
         def end?
           false
         end
+
+        private
+
+        def validate_state!
+          validate_state_choices!
+          validate_state_default!
+        end
+
+        def validate_state_choices!
+          raise Floe::InvalidWorkflowError, "Choice state must have \"Choices\"" unless payload.key?("Choices")
+          raise Floe::InvalidWorkflowError, "\"Choices\" must be a non-empty array" unless payload["Choices"].kind_of?(Array) && !payload["Choices"].empty?
+        end
+
+        def validate_state_default!
+          raise Floe::InvalidWorkflowError, "\"Default\" not in \"States\"" unless workflow.payload["States"].include?(payload["Default"])
+        end
       end
     end
   end

diff --git a/lib/floe/workflow/states/non_terminal_mixin.rb b/lib/floe/workflow/states/non_terminal_mixin.rb
@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Floe
+  class Workflow
+    module States
+      module NonTerminalMixin
+        def validate_state_next!
+          raise Floe::InvalidWorkflowError, "Missing \"Next\" field in state [#{name}]" if @next.nil? && !@end
+          raise Floe::InvalidWorkflowError, "\"Next\" [#{@next}] not in \"States\" for state [#{name}]" if @next && !workflow.payload["States"].key?(@next)
+        end
+      end
+    end
+  end
+end
diff --git a/lib/floe/workflow/states/pass.rb b/lib/floe/workflow/states/pass.rb
@@ -4,6 +4,8 @@ module Floe
   class Workflow
     module States
       class Pass < Floe::Workflow::State
+        include NonTerminalMixin
+
         attr_reader :end, :next, :result, :parameters, :input_path, :output_path, :result_path
 
         def initialize(workflow, name, payload)
@@ -17,6 +19,8 @@ def initialize(workflow, name, payload)
           @input_path  = Path.new(payload.fetch("InputPath", "$"))
           @output_path = Path.new(payload.fetch("OutputPath", "$"))
           @result_path = ReferencePath.new(payload.fetch("ResultPath", "$"))
+
+          validate_state!
         end
 
         def start(input)
@@ -36,6 +40,12 @@ def running?
         def end?
           @end
         end
+
+        private
+
+        def validate_state!
+          validate_state_next!
+        end
       end
     end
   end

diff --git a/lib/floe/workflow/states/task.rb b/lib/floe/workflow/states/task.rb
@@ -4,6 +4,8 @@ module Floe
   class Workflow
     module States
       class Task < Floe::Workflow::State
+        include NonTerminalMixin
+
         attr_reader :credentials, :end, :heartbeat_seconds, :next, :parameters,
                     :result_selector, :resource, :timeout_seconds, :retry, :catch,
                     :input_path, :output_path, :result_path
@@ -25,6 +27,8 @@ def initialize(workflow, name, payload)
           @parameters        = PayloadTemplate.new(payload["Parameters"])     if payload["Parameters"]
           @result_selector   = PayloadTemplate.new(payload["ResultSelector"]) if payload["ResultSelector"]
           @credentials       = PayloadTemplate.new(payload["Credentials"])    if payload["Credentials"]
+
+          validate_state!
         end
 
         def start(input)
@@ -72,6 +76,10 @@ def end?
 
         attr_reader :runner
 
+        def validate_state!
+          validate_state_next!
+        end
+
         def success?
           runner.success?(context.state["RunnerContext"])
         end

diff --git a/lib/floe/workflow/states/wait.rb b/lib/floe/workflow/states/wait.rb
@@ -6,6 +6,8 @@ module Floe
   class Workflow
     module States
       class Wait < Floe::Workflow::State
+        include NonTerminalMixin
+
         attr_reader :end, :next, :seconds, :input_path, :output_path
 
         def initialize(workflow, name, payload)
@@ -20,6 +22,8 @@ def initialize(workflow, name, payload)
 
           @input_path  = Path.new(payload.fetch("InputPath", "$"))
           @output_path = Path.new(payload.fetch("OutputPath", "$"))
+
+          validate_state!
         end
 
         def start(input)
@@ -41,6 +45,10 @@ def end?
 
         private
 
+        def validate_state!
+          validate_state_next!
+        end
+
         def please_hold(input)
           wait(
             :seconds => @seconds_path ? @seconds_path.value(context, input).to_i : @seconds,

diff --git a/spec/workflow/path_spec.rb b/spec/workflow/path_spec.rb
@@ -1,4 +1,13 @@
 RSpec.describe Floe::Workflow::Path do
+  it "raises an exception if the payload isn't a string" do
+    expect { described_class.new(nil) }.to raise_error(Floe::InvalidWorkflowError, "Path [] must be a string")
+    expect { described_class.new(0) }.to raise_error(Floe::InvalidWorkflowError, "Path [0] must be a string")
+  end
+
+  it "raises an exception if the first character isn't a $" do
+    expect { described_class.new("foo") }.to raise_error(Floe::InvalidWorkflowError, "Path [foo] must start with \"$\"")
+  end
+
   describe "#value" do
     context "referencing the global context" do
       it "with a missing value" do

diff --git a/spec/workflow/states/choice_spec.rb b/spec/workflow/states/choice_spec.rb
@@ -28,6 +28,26 @@
     )
   end
 
+  it "raises an exception if Choices is missing" do
+    payload = {"StartAt" => "Choice", "States" => {"Choice" => {"Type" => "Choice", "Default" => "DefaultState"}, "DefaultState" => {"type" => "Succeed"}}}
+    expect { Floe::Workflow.new(payload) }.to raise_error(Floe::InvalidWorkflowError, "Choice state must have \"Choices\"")
+  end
+
+  it "raises an exception if Choices is not an array" do
+    payload = {"StartAt" => "Choice", "States" => {"Choice" => {"Type" => "Choice", "Choices" => {}, "Default" => "DefaultState"}, "DefaultState" => {"type" => "Succeed"}}}
+    expect { Floe::Workflow.new(payload) }.to raise_error(Floe::InvalidWorkflowError, "\"Choices\" must be a non-empty array")
+  end
+
+  it "raises an exception if Choices is an empty array" do
+    payload = {"StartAt" => "Choice", "States" => {"Choice" => {"Type" => "Choice", "Choices" => [], "Default" => "DefaultState"}, "DefaultState" => {"type" => "Succeed"}}}
+    expect { Floe::Workflow.new(payload) }.to raise_error(Floe::InvalidWorkflowError, "\"Choices\" must be a non-empty array")
+  end
+
+  it "raises an exception if Default isn't a valid state" do
+    payload = {"StartAt" => "Choice", "States" => {"Choice" => {"Type" => "Choice", "Choices" => [{"Variable" => "$.foo", "NumericEquals" => 1, "Next" => "FirstMatchState"}], "Default" => "MissingState"}}}
+    expect { Floe::Workflow.new(payload) }.to raise_error(Floe::InvalidWorkflowError, "\"Default\" not in \"States\"")
+  end
+
   it "#end?" do
     expect(state.end?).to eq(false)
   end

diff --git a/spec/workflow/states/task_spec.rb b/spec/workflow/states/task_spec.rb
@@ -21,7 +21,7 @@
 
     describe "Input" do
       context "with no InputPath" do
-        let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource}}) }
+        let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource, "End" => true}}) }
 
         it "passes the whole context to the resource" do
           expect(mock_runner)
@@ -34,7 +34,7 @@
       end
 
       context "with an InputPath" do
-        let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource, "InputPath" => "$.foo"}}) }
+        let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource, "InputPath" => "$.foo", "End" => true}}) }
 
         it "filters the context passed to the resource" do
           expect(mock_runner)
@@ -47,7 +47,7 @@
       end
 
       context "with Parameters" do
-        let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource, "Parameters" => {"var1.$" => "$.foo.bar"}}}) }
+        let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource, "Parameters" => {"var1.$" => "$.foo.bar"}, "End" => true}}) }
 
         it "passes the interpolated parameters to the resource" do
           expect(mock_runner)
@@ -61,7 +61,7 @@
     end
 
     describe "Output" do
-      let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource}}) }
+      let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource, "End" => true}}) }
 
       it "uses the last line as output if it is JSON" do
         expect(mock_runner)
@@ -101,7 +101,7 @@
       end
 
       context "ResultSelector" do
-        let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource, "ResultSelector" => {"ip_addrs.$" => "$.response"}}}) }
+        let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource, "ResultSelector" => {"ip_addrs.$" => "$.response"}, "End" => true}}) }
 
         it "filters the results" do
           expect(mock_runner)
@@ -116,7 +116,7 @@
       end
 
       context "ResultPath" do
-        let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource, "ResultPath" => "$.ip_addrs"}}) }
+        let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource, "ResultPath" => "$.ip_addrs", "End" => true}}) }
 
         it "inserts the response into the input" do
           expect(mock_runner)
@@ -135,7 +135,7 @@
       end
 
       context "OutputPath" do
-        let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource, "ResultPath" => "$.data.ip_addrs", "OutputPath" => output_path}}) }
+        let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource, "ResultPath" => "$.data.ip_addrs", "OutputPath" => output_path, "End" => true}}) }
 
         context "with the default '$'" do
           let(:output_path) { "$" }
@@ -174,7 +174,7 @@
     end
 
     describe "Retry" do
-      let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource, "Retry" => retriers, "TimeoutSeconds" => 2}}) }
+      let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource, "Retry" => retriers, "TimeoutSeconds" => 2, "End" => true}}) }
 
       context "with specific errors" do
         let(:retriers) { [{"ErrorEquals" => ["States.Timeout"], "MaxAttempts" => 1}] }
@@ -195,7 +195,7 @@
         end
 
         context "with multiple retriers" do
-          let(:retriers) { [{"ErrorEquals" => ["States.Timeout"], "MaxAttempts" => 1}, {"ErrorEquals" => ["Exception"]}] }
+          let(:retriers) { [{"ErrorEquals" => ["States.Timeout"], "MaxAttempts" => 1}, {"ErrorEquals" => ["Exception"], "End" => true}] }
 
           it "resets the retrier if a different exception is raised" do
             expect(mock_runner).to receive(:running?).and_return(false)
@@ -266,7 +266,7 @@
       end
 
       context "with a Catch" do
-        let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource, "Retry" => [{"ErrorEquals" => ["States.Timeout"]}], "Catch" => [{"ErrorEquals" => ["States.ALL"], "Next" => "FailState"}]}}) }
+        let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource, "Retry" => [{"ErrorEquals" => ["States.Timeout"]}], "Catch" => [{"ErrorEquals" => ["States.ALL"], "Next" => "FailState"}], "End" => true}}) }
         let(:success) { false }
 
         it "retry preceeds catch" do
@@ -299,7 +299,7 @@
       let(:success) { false }
 
       context "with specific errors" do
-        let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource, "Catch" => [{"ErrorEquals" => ["States.Timeout"], "Next" => "FirstState"}]}}) }
+        let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource, "Catch" => [{"ErrorEquals" => ["States.Timeout"], "Next" => "FirstState"}], "End" => true}}) }
 
         it "catches the exception" do
           expect(mock_runner).to receive("output").and_return("States.Timeout")
@@ -327,7 +327,7 @@
       end
 
       context "with a State.ALL catcher" do
-        let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource, "Catch" => [{"ErrorEquals" => ["States.Timeout"], "Next" => "FirstState"}, {"ErrorEquals" => ["States.ALL"], "Next" => "FailState"}]}}) }
+        let(:workflow) { make_workflow(ctx, {"State" => {"Type" => "Task", "Resource" => resource, "Catch" => [{"ErrorEquals" => ["States.Timeout"], "Next" => "FirstState"}, {"ErrorEquals" => ["States.ALL"], "Next" => "FailState"}], "End" => true}}) }
 
         it "catches a more specific exception" do
           expect(mock_runner).to receive("output").and_return("States.Timeout")
@@ -356,7 +356,7 @@
 
   describe "#end?" do
     it "with a normal state" do
-      workflow = make_workflow(ctx, {"FirstState" => {"Type" => "Task", "Resource" => resource, "Next" => "ChoiceState"}})
+      workflow = make_workflow(ctx, {"FirstState" => {"Type" => "Task", "Resource" => resource, "Next" => "SuccessState"}, "SuccessState" => {"Type" => "Succeed"}})
       state = workflow.current_state
       expect(state.end?).to be false
     end

diff --git a/spec/workflow/states/wait_spec.rb b/spec/workflow/states/wait_spec.rb
@@ -20,7 +20,7 @@
 
   describe "#running?" do
     context "with seconds" do
-      let(:workflow) { make_workflow(ctx, {"WaitState" => {"Type" => "Wait", "Seconds" => 1, "Next" => "SuccessState"}}) }
+      let(:workflow) { make_workflow(ctx, {"WaitState" => {"Type" => "Wait", "Seconds" => 1, "Next" => "SuccessState"}, "SuccessState" => {"Type" => "Succeed"}}) }
       it "is running before finished" do
         state.start(ctx.input)
         expect(state.running?).to be_truthy
@@ -36,7 +36,7 @@
 
     context "with secondsPath" do
       let(:input)    { {"expire" => "1"} }
-      let(:workflow) { make_workflow(ctx, {"WaitState" => {"Type" => "Wait", "SecondsPath" => "$.expire", "Next" => "SuccessState"}}) }
+      let(:workflow) { make_workflow(ctx, {"WaitState" => {"Type" => "Wait", "SecondsPath" => "$.expire", "Next" => "SuccessState"}, "SuccessState" => {"Type" => "Succeed"}}) }
       it "is running? before finished" do
         state.start(ctx.input)
         expect(state.running?).to be_truthy
@@ -52,7 +52,7 @@
 
     context "with timestamp" do
       let(:expiry) { Time.now.utc + 1 }
-      let(:workflow) { make_workflow(ctx, {"WaitState" => {"Type" => "Wait", "Timestamp" => expiry.iso8601, "Next" => "SuccessState"}}) }
+      let(:workflow) { make_workflow(ctx, {"WaitState" => {"Type" => "Wait", "Timestamp" => expiry.iso8601, "Next" => "SuccessState"}, "SuccessState" => {"Type" => "Succeed"}}) }
       it "is running? before finished" do
         state.start(ctx.input)
         expect(state.running?).to be_truthy
@@ -69,7 +69,7 @@
     context "with timestamp" do
       let(:expiry) { Time.now.utc + 1 }
       let(:input) { {"expire" => expiry.iso8601} }
-      let(:workflow) { make_workflow(ctx, {"WaitState" => {"Type" => "Wait", "TimestampPath" => "$.expire", "Next" => "SuccessState"}}) }
+      let(:workflow) { make_workflow(ctx, {"WaitState" => {"Type" => "Wait", "TimestampPath" => "$.expire", "Next" => "SuccessState"}, "SuccessState" => {"Type" => "Succeed"}}) }
       it "is running? before finished" do
         state.start(ctx.input)
         expect(state.running?).to be_truthy