floe 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0aac9121f1d393173b2fb11f9422f9e689693318a97dada576f054d827901024
-  data.tar.gz: 8118d4632e54c6fa3beb94384be517d5f3bf494890855901ce36af7ea94ee1c2
+  metadata.gz: b92b3c488e49ea77447b370e9152c49e11036e8295c6a781feda666662927f9e
+  data.tar.gz: c553deab6491c9876e28a816cb2422a1318ac6f91a9f9f75cbfc5a144a84d248
 SHA512:
-  metadata.gz: 3872e70c2bb41e46570bcba95ef63716cdf3ea93bed77e9654db6614f8225982e13e3a83256b97854b6aa4376799e803f2edd5066dc3e304e75e2970c55d60f2
-  data.tar.gz: fac7e8815bcff8d93e443653759a6cdf8371c78f9114e3fef133212c0a1ef49d76bb35a0f491ef5abfeb134a21dc11cbbc00a6694d1f05d0e90f5bdae3471c41
+  metadata.gz: 3f5c210d2a745aaed8e3419e228465203dcebb02ee678c1d2b47285083e1f154118c25864e51360d3d062ca0cfade9baa84f5a932804b586f26607a195acc710
+  data.tar.gz: 238fd469915e8682c449abd26e1950f68fd4b032a32fcace11130109d46dc6962b29e4ce381734d167f5328ef16ee2fdd4bb250f844644abebc571fc001ab2dd

data/CHANGELOG.md

@@ -4,6 +4,28 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.6.1] - 2023-11-21
+### Fixed
+- Return an error payload if run_async! fails ([#143](https://github.com/ManageIQ/floe/pull/143))
+
+### Changed
+- Extract run_container_params for docker/podman ([#142](https://github.com/ManageIQ/floe/pull/142))
+
+## [0.6.0] - 2023-11-09
+### Added
+- Prefix pod names with 'floe-' ([#132](https://github.com/ManageIQ/floe/pull/132))
+- Validate that the workflow payload is correct ([#136](https://github.com/ManageIQ/floe/pull/136))
+
+### Fixed
+- Fix issue where certain docker image names cannot be pod names ([#134](https://github.com/ManageIQ/floe/pull/134))
+- Fix uninitialized constant RSpec::Support::Differ in tests ([#137](https://github.com/ManageIQ/floe/pull/137))
+- Handle ImagePullErr/ImagePullBackOff as errors ([#135](https://github.com/ManageIQ/floe/pull/135))
+
+### Changed
+- Add task spec helper ([#123](https://github.com/ManageIQ/floe/pull/123))
+- Rename State#run_wait to just #wait ([#139](https://github.com/ManageIQ/floe/pull/139))
+- Refactor the Podman runner to be a Docker subclass ([#140](https://github.com/ManageIQ/floe/pull/140))
+
 ## [0.5.0] - 2023-10-12
 ### Added
 - For task errors, use the json on the last line ([#128](https://github.com/ManageIQ/floe/pull/128))
@@ -32,19 +54,19 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [0.3.1] - 2023-08-29
 ### Added
-- Add more global podman runner options ([#90])(https://github.com/ManageIQ/floe/pull/90)
+- Add more global podman runner options ([#90](https://github.com/ManageIQ/floe/pull/90))
 
 ## [0.3.0] - 2023-08-07
 ### Added
-- Add --network=host option to Docker/Podman runners ([#81])(https://github.com/ManageIQ/floe/pull/81)
+- Add --network=host option to Docker/Podman runners ([#81](https://github.com/ManageIQ/floe/pull/81))
 
 ### Fixed
-- Fix PayloadTemplate value transformation rules ([#78])(https://github.com/ManageIQ/floe/pull/78)
-- Move end out of the root state node ([#80])(https://github.com/ManageIQ/floe/pull/80)
+- Fix PayloadTemplate value transformation rules ([#78](https://github.com/ManageIQ/floe/pull/78))
+- Move end out of the root state node ([#80](https://github.com/ManageIQ/floe/pull/80))
 
 ## [0.2.3] - 2023-07-28
 ### Fixed
-- Fix storing next_state in Context ([#76])(https://github.com/ManageIQ/floe/pull/76)
+- Fix storing next_state in Context ([#76](https://github.com/ManageIQ/floe/pull/76))
 
 ## [0.2.2] - 2023-07-24
 ### Fixed
@@ -84,7 +106,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - Initial release
 
-[Unreleased]: https://github.com/ManageIQ/floe/compare/v0.4.1...HEAD
+[Unreleased]: https://github.com/ManageIQ/floe/compare/v0.6.1...HEAD
+[0.6.1]: https://github.com/ManageIQ/floe/compare/v0.6.0...v0.6.1
+[0.6.0]: https://github.com/ManageIQ/floe/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/ManageIQ/floe/compare/v0.4.1...v0.5.0
 [0.4.1]: https://github.com/ManageIQ/floe/compare/v0.4.0...v0.4.1
 [0.4.0]: https://github.com/ManageIQ/floe/compare/v0.3.1...v0.4.0
 [0.3.1]: https://github.com/ManageIQ/floe/compare/v0.3.0...v0.3.1

data/lib/floe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Floe
-  VERSION = "0.5.0".freeze
+  VERSION = "0.6.1".freeze
 end

data/lib/floe/workflow/path.rb

@@ -11,6 +11,9 @@ module Floe
 
       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 = {})

data/lib/floe/workflow/runner/docker.rb

@@ -4,6 +4,10 @@ module Floe
   class Workflow
     class Runner
       class Docker < Floe::Workflow::Runner
+        include DockerMixin
+
+        DOCKER_COMMAND = "docker"
+
         def initialize(options = {})
           require "awesome_spawn"
           require "tempfile"
@@ -26,27 +30,28 @@ module Floe
 
           begin
             runner_context["container_ref"] = run_container(image, env, runner_context["secrets_ref"])
-          rescue
+            runner_context
+          rescue AwesomeSpawn::CommandResultError => err
             cleanup(runner_context)
-            raise
+            {"Error" => "States.TaskFailed", "Cause" => err.to_s}
           end
-
-          runner_context
         end
 
         def cleanup(runner_context)
           container_id, secrets_file = runner_context.values_at("container_ref", "secrets_ref")
 
           delete_container(container_id) if container_id
-          File.unlink(secrets_file)      if secrets_file && File.exist?(secrets_file)
+          delete_secret(secrets_file)    if secrets_file
         end
 
         def status!(runner_context)
+          return if runner_context.key?("Error")
+
           runner_context["container_state"] = inspect_container(runner_context["container_ref"]).first&.dig("State")
         end
 
         def running?(runner_context)
-          runner_context.dig("container_state", "Running")
+          !!runner_context.dig("container_state", "Running")
         end
 
         def success?(runner_context)
@@ -54,6 +59,8 @@ module Floe
         end
 
         def output(runner_context)
+          return runner_context.slice("Error", "Cause") if runner_context.key?("Error")
+
           output = docker!("logs", runner_context["container_ref"], :combined_output => true).output
           runner_context["output"] = output
         end
@@ -63,18 +70,23 @@ module Floe
         attr_reader :network
 
         def run_container(image, env, secrets_file)
+          params = run_container_params(image, env, secrets_file)
+
+          logger.debug("Running #{AwesomeSpawn.build_command_line("docker", params)}")
+
+          result = docker!(*params)
+          result.output
+        end
+
+        def run_container_params(image, env, secrets_file)
           params  = ["run"]
           params << :detach
           params += env.map { |k, v| [:e, "#{k}=#{v}"] }
           params << [:e, "_CREDENTIALS=/run/secrets"] if secrets_file
           params << [:net, "host"] if @network == "host"
           params << [:v, "#{secrets_file}:/run/secrets:z"] if secrets_file
+          params << [:name, container_name(image)]
           params << image
-
-          logger.debug("Running docker: #{AwesomeSpawn.build_command_line("docker", params)}")
-
-          result = docker!(*params)
-          result.output
         end
 
         def inspect_container(container_id)
@@ -87,6 +99,14 @@ module Floe
           nil
         end
 
+        def delete_secret(secrets_file)
+          return unless File.exist?(secrets_file)
+
+          File.unlink(secrets_file)
+        rescue
+          nil
+        end
+
         def create_secret(secrets)
           secrets_file = Tempfile.new
           secrets_file.write(secrets.to_json)
@@ -94,8 +114,13 @@ module Floe
           secrets_file.path
         end
 
-        def docker!(*params, **kwargs)
-          AwesomeSpawn.run!("docker", :params => params, **kwargs)
+        def global_docker_options
+          []
+        end
+
+        def docker!(*args, **kwargs)
+          params = global_docker_options + args
+          AwesomeSpawn.run!(self.class::DOCKER_COMMAND, :params => params, **kwargs)
         end
       end
     end

data/lib/floe/workflow/runner/docker_mixin.rb

@@ -0,0 +1,31 @@
+module Floe
+  class Workflow
+    class Runner
+      module DockerMixin
+        def image_name(image)
+          image.match(%r{^(?<repository>.+/)?(?<image>.+):(?<tag>.+)$})&.named_captures&.dig("image")
+        end
+
+        MAX_CONTAINER_NAME_SIZE = 63 - 5 - 9 # 63 is the max kubernetes pod name length
+                                             # -5 for the "floe-" prefix
+                                             # -9 for the random hex suffix and leading hyphen
+
+        def container_name(image)
+          name = image_name(image)
+          raise ArgumentError, "Invalid docker image [#{image}]" if name.nil?
+
+          # Normalize the image name to be used in the container name.
+          # This follows RFC 1123 Label names in Kubernetes as they are the most restrictive
+          # See https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+          # and https://github.com/kubernetes/kubernetes/blob/952a9cb0/staging/src/k8s.io/apimachinery/pkg/util/validation/validation.go#L178-L184
+          #
+          # This does not follow the leading and trailing character restriction because we will embed it
+          # below with a prefix and suffix that already conform to the RFC.
+          normalized_name = name.downcase.gsub(/[^a-z0-9-]/, "-")[0, MAX_CONTAINER_NAME_SIZE]
+
+          "floe-#{normalized_name}-#{SecureRandom.hex(4)}"
+        end
+      end
+    end
+  end
+end

data/lib/floe/workflow/runner/kubernetes.rb

@@ -4,10 +4,15 @@ module Floe
   class Workflow
     class Runner
       class Kubernetes < Floe::Workflow::Runner
-        TOKEN_FILE   = "/run/secrets/kubernetes.io/serviceaccount/token"
-        CA_CERT_FILE = "/run/secrets/kubernetes.io/serviceaccount/ca.crt"
+        include DockerMixin
+
+        TOKEN_FILE      = "/run/secrets/kubernetes.io/serviceaccount/token"
+        CA_CERT_FILE    = "/run/secrets/kubernetes.io/serviceaccount/ca.crt"
+        RUNNING_PHASES  = %w[Pending Running].freeze
+        FAILURE_REASONS = %w[CrashLoopBackOff ImagePullBackOff ErrImagePull].freeze
 
         def initialize(options = {})
+          require "active_support/core_ext/hash/keys"
           require "awesome_spawn"
           require "securerandom"
           require "base64"
@@ -44,27 +49,34 @@ module Floe
           raise ArgumentError, "Invalid resource" unless resource&.start_with?("docker://")
 
           image  = resource.sub("docker://", "")
-          name   = pod_name(image)
+          name   = container_name(image)
           secret = create_secret!(secrets) if secrets && !secrets.empty?
 
           runner_context = {"container_ref" => name, "secrets_ref" => secret}
 
           begin
             create_pod!(name, image, env, secret)
-          rescue
+            runner_context
+          rescue Kubeclient::HttpError => err
             cleanup(runner_context)
-            raise
+            {"Error" => "States.TaskFailed", "Cause" => err.to_s}
           end
-
-          runner_context
         end
 
         def status!(runner_context)
-          runner_context["container_state"] = pod_info(runner_context["container_ref"])["status"]
+          return if runner_context.key?("Error")
+
+          runner_context["container_state"] = pod_info(runner_context["container_ref"]).to_h.deep_stringify_keys["status"]
         end
 
         def running?(runner_context)
-          %w[Pending Running].include?(runner_context.dig("container_state", "phase"))
+          return false unless pod_running?(runner_context)
+          # If a pod is Pending and the containers are waiting with a failure
+          # reason such as ImagePullBackOff or CrashLoopBackOff then the pod
+          # will never be run.
+          return false if container_failed?(runner_context)
+
+          true
         end
 
         def success?(runner_context)
@@ -72,8 +84,14 @@ module Floe
         end
 
         def output(runner_context)
-          output = kubeclient.get_pod_log(runner_context["container_ref"], namespace).body
-          runner_context["output"] = output
+          if runner_context.key?("Error")
+            runner_context.slice("Error", "Cause")
+          elsif container_failed?(runner_context)
+            failed_state = failed_container_states(runner_context).first
+            {"Error" => failed_state["reason"], "Cause" => failed_state["message"]}
+          else
+            runner_context["output"] = kubeclient.get_pod_log(runner_context["container_ref"], namespace).body
+          end
         end
 
         def cleanup(runner_context)
@@ -91,15 +109,18 @@ module Floe
           kubeclient.get_pod(pod_name, namespace)
         end
 
-        def container_name(image)
-          image.match(%r{^(?<repository>.+/)?(?<image>.+):(?<tag>.+)$})&.named_captures&.dig("image")
+        def pod_running?(context)
+          RUNNING_PHASES.include?(context.dig("container_state", "phase"))
         end
 
-        def pod_name(image)
-          container_short_name = container_name(image)
-          raise ArgumentError, "Invalid docker image [#{image}]" if container_short_name.nil?
+        def failed_container_states(context)
+          container_statuses = context.dig("container_state", "containerStatuses") || []
+          container_statuses.map { |status| status["state"]&.values&.first }.compact
+                            .select { |state| FAILURE_REASONS.include?(state["reason"]) }
+        end
 
-          "#{container_short_name}-#{SecureRandom.uuid}"
+        def container_failed?(context)
+          failed_container_states(context).any?
         end
 
         def pod_spec(name, image, env, secret = nil)
@@ -113,7 +134,7 @@ module Floe
             :spec       => {
               :containers    => [
                 {
-                  :name  => container_name(image),
+                  :name  => name[0...-9], # remove the random suffix and its leading hyphen
                   :image => image,
                   :env   => env.map { |k, v| {:name => k, :value => v.to_s} }
                 }

data/lib/floe/workflow/runner/podman.rb

@@ -3,7 +3,9 @@
 module Floe
   class Workflow
     class Runner
-      class Podman < Floe::Workflow::Runner
+      class Podman < Floe::Workflow::Runner::Docker
+        DOCKER_COMMAND = "podman"
+
         def initialize(options = {})
           require "awesome_spawn"
           require "securerandom"
@@ -26,74 +28,17 @@ module Floe
           @volumepath      = options["volumepath"]
         end
 
-        def run_async!(resource, env = {}, secrets = {})
-          raise ArgumentError, "Invalid resource" unless resource&.start_with?("docker://")
-
-          image = resource.sub("docker://", "")
-
-          if secrets && !secrets.empty?
-            secret_guid = create_secret(secrets)
-          end
-
-          begin
-            container_id = run_container(image, env, secret_guid)
-          rescue
-            cleanup({"container_ref" => container_id, "secrets_ref" => secret_guid})
-            raise
-          end
-
-          {"container_ref" => container_id, "secrets_ref" => secret_guid}
-        end
-
-        def cleanup(runner_context)
-          container_id, secret_guid = runner_context.values_at("container_ref", "secrets_ref")
-
-          delete_container(container_id) if container_id
-          delete_secret(secret_guid)     if secret_guid
-        end
-
-        def status!(runner_context)
-          runner_context["container_state"] = inspect_container(runner_context["container_ref"]).first&.dig("State")
-        end
-
-        def running?(runner_context)
-          runner_context.dig("container_state", "Running")
-        end
-
-        def success?(runner_context)
-          runner_context.dig("container_state", "ExitCode") == 0
-        end
-
-        def output(runner_context)
-          output = podman!("logs", runner_context["container_ref"], :combined_output => true).output
-          runner_context["output"] = output
-        end
-
         private
 
-        def run_container(image, env, secret)
+        def run_container_params(image, env, secret)
           params  = ["run"]
           params << :detach
           params += env.map { |k, v| [:e, "#{k}=#{v}"] }
           params << [:e, "_CREDENTIALS=/run/secrets/#{secret}"] if secret
           params << [:net, "host"] if @network == "host"
           params << [:secret, secret] if secret
+          params << [:name, container_name(image)]
           params << image
-
-          logger.debug("Running podman: #{AwesomeSpawn.build_command_line("podman", params)}")
-
-          result = podman!(*params)
-          result.output
-        end
-
-        def inspect_container(container_id)
-          JSON.parse(podman!("inspect", container_id).output)
-        end
-
-        def delete_container(container_id)
-          podman!("rm", container_id)
-        rescue
-          nil
         end
 
         def create_secret(secrets)
@@ -108,13 +53,9 @@ module Floe
           nil
         end
 
-        def podman!(*args, **kwargs)
-          params = podman_global_options + args
-
-          AwesomeSpawn.run!("podman", :params => params, **kwargs)
-        end
+        alias podman! docker!
 
-        def podman_global_options
+        def global_docker_options
           options = []
           options << [:identity, @identity]                 if @identity
           options << [:"log-level", @log_level]             if @log_level

data/lib/floe/workflow/state.rb

@@ -8,6 +8,7 @@ module Floe
       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,13 +28,16 @@ module Floe
         @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)
-        run_wait until run_nonblock! == 0
+        wait until run_nonblock! == 0
       end
 
-      def run_wait(timeout: 5)
+      def wait(timeout: 5)
         start = Time.now.utc
 
         loop do
@@ -95,7 +99,7 @@ module Floe
 
       private
 
-      def wait(seconds: nil, time: nil)
+      def wait_until!(seconds: nil, time: nil)
         context.state["WaitUntil"] =
           if seconds
             (Time.parse(context.state["EnteredTime"]) + seconds).iso8601

data/lib/floe/workflow/states/choice.rb

@@ -9,6 +9,8 @@ module Floe
         def initialize(workflow, name, payload)
           super
 
+          validate_state!
+
           @choices = payload["Choices"].map { |choice| ChoiceRule.build(choice) }
           @default = payload["Default"]
 
@@ -33,6 +35,22 @@ module Floe
         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

data/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

data/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 @@ module Floe
           @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 @@ module Floe
         def end?
           @end
         end
+
+        private
+
+        def validate_state!
+          validate_state_next!
+        end
       end
     end
   end

data/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 @@ module Floe
           @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 @@ module Floe
 
         attr_reader :runner
 
+        def validate_state!
+          validate_state_next!
+        end
+
         def success?
           runner.success?(context.state["RunnerContext"])
         end
@@ -98,7 +106,7 @@ module Floe
 
           return if context["State"]["RetryCount"] > retrier.max_attempts
 
-          wait(:seconds => retrier.sleep_duration(context["State"]["RetryCount"]))
+          wait_until!(:seconds => retrier.sleep_duration(context["State"]["RetryCount"]))
           context.next_state = context.state_name
           true
         end
@@ -126,6 +134,7 @@ module Floe
 
         def parse_error(output)
           return if output.nil?
+          return output if output.kind_of?(Hash)
 
           JSON.parse(output.split("\n").last)
         rescue JSON::ParserError
@@ -134,6 +143,7 @@ module Floe
 
         def parse_output(output)
           return if output.nil?
+          return output if output.kind_of?(Hash)
 
           JSON.parse(output.split("\n").last)
         rescue JSON::ParserError

data/lib/floe/workflow/states/wait.rb

@@ -6,7 +6,9 @@ module Floe
   class Workflow
     module States
       class Wait < Floe::Workflow::State
-        attr_reader :end, :next, :seconds, :input_path, :output_path
+        include NonTerminalMixin
+
+        attr_reader :end, :input_path, :next, :seconds, :seconds_path, :timestamp, :timestamp_path, :output_path
 
         def initialize(workflow, name, payload)
           super
@@ -20,6 +22,8 @@ module Floe
 
           @input_path  = Path.new(payload.fetch("InputPath", "$"))
           @output_path = Path.new(payload.fetch("OutputPath", "$"))
+
+          validate_state!
         end
 
         def start(input)
@@ -28,7 +32,11 @@ module Floe
 
           context.output     = output_path.value(context, input)
           context.next_state = end? ? nil : @next
-          please_hold(input)
+
+          wait_until!(
+            :seconds => seconds_path ? seconds_path.value(context, input).to_i : seconds,
+            :time    => timestamp_path ? timestamp_path.value(context, input) : timestamp
+          )
         end
 
         def running?
@@ -41,11 +49,8 @@ module Floe
 
         private
 
-        def please_hold(input)
-          wait(
-            :seconds => @seconds_path ? @seconds_path.value(context, input).to_i : @seconds,
-            :time    => @timestamp_path ? @timestamp_path.value(context, input) : @timestamp
-          )
+        def validate_state!
+          validate_state_next!
         end
       end
     end

data/lib/floe/workflow.rb

@@ -38,6 +38,10 @@ module Floe
       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
@@ -77,7 +81,7 @@ module Floe
     end
 
     def step_nonblock_wait(timeout: 5)
-      current_state.run_wait(:timeout => timeout)
+      current_state.wait(:timeout => timeout)
     end
 
     def step_nonblock_ready?

data/lib/floe.rb

@@ -18,6 +18,7 @@ require_relative "floe/workflow/payload_template"
 require_relative "floe/workflow/reference_path"
 require_relative "floe/workflow/retrier"
 require_relative "floe/workflow/runner"
+require_relative "floe/workflow/runner/docker_mixin"
 require_relative "floe/workflow/runner/docker"
 require_relative "floe/workflow/runner/kubernetes"
 require_relative "floe/workflow/runner/podman"
@@ -25,6 +26,7 @@ require_relative "floe/workflow/state"
 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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: floe
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - ManageIQ Developers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-12 00:00:00.000000000 Z
+date: 2023-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_spawn
@@ -117,12 +117,14 @@ files:
 - lib/floe/workflow/retrier.rb
 - lib/floe/workflow/runner.rb
 - lib/floe/workflow/runner/docker.rb
+- lib/floe/workflow/runner/docker_mixin.rb
 - lib/floe/workflow/runner/kubernetes.rb
 - lib/floe/workflow/runner/podman.rb
 - lib/floe/workflow/state.rb
 - lib/floe/workflow/states/choice.rb
 - lib/floe/workflow/states/fail.rb
 - lib/floe/workflow/states/map.rb
+- lib/floe/workflow/states/non_terminal_mixin.rb
 - lib/floe/workflow/states/parallel.rb
 - lib/floe/workflow/states/pass.rb
 - lib/floe/workflow/states/succeed.rb
@@ -152,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Simple Workflow Runner.