floe 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2bab2c07fd71a45bcf896aa219993770c83eedd5c4e3268c318d8b9ba0413ed
-  data.tar.gz: 786064609be7fee8a19855cb97fd160984b5a8a7aedc85344eab01302155a988
+  metadata.gz: 58ace49051c911efbe352b2b882cc663aea3be231e6c8dcf138864e340ae2de6
+  data.tar.gz: d422be1ce106663dd1dc40b7ddb52024f9eb9b0e85f807572d66f31fcdf16e51
 SHA512:
-  metadata.gz: 45a9fd8a85bb5b1059574c0dc63b0434496b6c75634c567aba9f0008400867b4dbf8c33337b3940084c644606dc3fe6065fc4f79ac5732449ca0d9675d0e2531
-  data.tar.gz: f4147cd4e1633d2af02b7cbbd04735a9ffdc733359eb7f349b23a2fb8bada9de18a4f37fad82de543f2eb8060fa6fa52d1864a159f3ab3f780cbdab1824b6ab1
+  metadata.gz: e5eab9d1763c723d8bb913e31bb736d0ba3c3e6d6d63585031e30adc5cbd3049105c756b89eee6999df2d6a0dcfd35e6a1ae4a39c10ce949387e91aae30acf32
+  data.tar.gz: 3249cce513b7195ce5ed791c300d9df62159febeb522c45db36dda38244c76f9290af3157ac744fa0757417ce327f95eea80c704375310ed3181e05426208e3b

data/CHANGELOG.md

@@ -4,6 +4,31 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [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))
+- Add ability to pass task service account to kube runner ([#131](https://github.com/ManageIQ/floe/pull/131))
+
+### Fixed
+- Don't put credentials file into input ([#124](https://github.com/ManageIQ/floe/pull/124))
+- exe/floe return success status if the workflow was successful ([#129](https://github.com/ManageIQ/floe/pull/129))
+- For error output, drop trailing newline ([#126](https://github.com/ManageIQ/floe/pull/126))
+
 ## [0.4.1] - 2023-10-06
 ### Added
 - Add Fail#CausePath and Fail#ErrorPath ([#110](https://github.com/ManageIQ/floe/pull/110))
@@ -22,19 +47,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
@@ -74,7 +99,9 @@ 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.0...HEAD
+[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/examples/workflow.asl

@@ -4,7 +4,7 @@
   "States": {
     "FirstState": {
       "Type": "Task",
-      "Resource": "docker://agrare/hello-world:latest",
+      "Resource": "docker://docker.io/agrare/hello-world:latest",
       "Credentials": {
         "mysecret": "dont tell anyone"
       },
@@ -49,13 +49,13 @@
 
     "FirstMatchState": {
       "Type" : "Task",
-      "Resource": "docker://agrare/hello-world:latest",
+      "Resource": "docker://docker.io/agrare/hello-world:latest",
       "Next": "PassState"
     },
 
     "SecondMatchState": {
       "Type" : "Task",
-      "Resource": "docker://agrare/hello-world:latest",
+      "Resource": "docker://docker.io/agrare/hello-world:latest",
       "Next": "NextState"
     },
 
@@ -87,7 +87,7 @@
 
     "NextState": {
       "Type": "Task",
-      "Resource": "docker://agrare/hello-world:latest",
+      "Resource": "docker://docker.io/agrare/hello-world:latest",
       "Secrets": ["vmdb:aaa-bbb-ccc"],
       "End": true
     }

data/exe/floe

@@ -37,3 +37,4 @@ workflow = Floe::Workflow.load(opts[:workflow], context, opts[:credentials])
 workflow.run!
 
 puts workflow.output.inspect
+exit workflow.status == "success" ? 0 : 1

data/lib/floe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Floe
-  VERSION = "0.4.1"
+  VERSION = "0.6.0".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"
@@ -13,24 +17,6 @@ module Floe
           @network = options.fetch("network", "bridge")
         end
 
-        def run!(resource, env = {}, secrets = {})
-          raise ArgumentError, "Invalid resource" unless resource&.start_with?("docker://")
-
-          image = resource.sub("docker://", "")
-
-          secrets_file = nil
-          if secrets && !secrets.empty?
-            secrets_file = create_secret(secrets)
-            env["_CREDENTIALS"] = "/run/secrets"
-          end
-
-          output = run_container(image, env, secrets_file)
-
-          {"exit_code" => 0, "output" => output}
-        ensure
-          cleanup({"secrets_ref" => secrets_file})
-        end
-
         def run_async!(resource, env = {}, secrets = {})
           raise ArgumentError, "Invalid resource" unless resource&.start_with?("docker://")
 
@@ -40,11 +26,10 @@ module Floe
 
           if secrets && !secrets.empty?
             runner_context["secrets_ref"] = create_secret(secrets)
-            env["_CREDENTIALS"] = "/run/secrets"
           end
 
           begin
-            runner_context["container_ref"] = run_container(image, env, runner_context["secrets_ref"], :detached => true)
+            runner_context["container_ref"] = run_container(image, env, runner_context["secrets_ref"])
           rescue
             cleanup(runner_context)
             raise
@@ -57,7 +42,7 @@ module Floe
           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)
@@ -81,12 +66,14 @@ module Floe
 
         attr_reader :network
 
-        def run_container(image, env, secrets_file, detached: false)
+        def run_container(image, env, secrets_file)
           params  = ["run"]
-          params << (detached ? :detach : :rm)
+          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)}")
@@ -105,6 +92,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)
@@ -112,8 +107,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"
@@ -35,42 +40,16 @@ module Floe
 
           @namespace = options.fetch("namespace", "default")
 
-          super
-        end
-
-        def run!(resource, env = {}, secrets = {})
-          raise ArgumentError, "Invalid resource" unless resource&.start_with?("docker://")
-
-          image  = resource.sub("docker://", "")
-          name   = pod_name(image)
-          secret = create_secret!(secrets) if secrets && !secrets.empty?
-
-          begin
-            runner_context = {"container_ref" => name}
+          @task_service_account = options["task_service_account"]
 
-            create_pod!(name, image, env, secret)
-            loop do
-              case pod_info(name).dig("status", "phase")
-              when "Pending", "Running"
-                sleep(1)
-              else # also "Succeeded"
-                runner_context["exit_code"] = 0
-                output(runner_context)
-                break
-              end
-            end
-
-            runner_context
-          ensure
-            cleanup({"container_ref" => name, "secrets_ref" => secret})
-          end
+          super
         end
 
         def run_async!(resource, env = {}, secrets = {})
           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}
@@ -86,11 +65,17 @@ module Floe
         end
 
         def status!(runner_context)
-          runner_context["container_state"] = pod_info(runner_context["container_ref"])["status"]
+          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)
@@ -98,8 +83,13 @@ module Floe
         end
 
         def output(runner_context)
-          output = kubeclient.get_pod_log(runner_context["container_ref"], namespace).body
-          runner_context["output"] = output
+          runner_context["output"] =
+            if container_failed?(runner_context)
+              failed_state = failed_container_states(runner_context).first
+              {"Error" => failed_state["reason"], "Cause" => failed_state["message"]}
+            else
+              kubeclient.get_pod_log(runner_context["container_ref"], namespace).body
+            end
         end
 
         def cleanup(runner_context)
@@ -117,15 +107,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)
@@ -139,7 +132,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} }
                 }
@@ -148,6 +141,8 @@ module Floe
             }
           }
 
+          spec[:spec][:serviceAccountName] = @task_service_account if @task_service_account
+
           if secret
             spec[:spec][:volumes] = [
               {

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,75 +28,16 @@ module Floe
           @volumepath      = options["volumepath"]
         end
 
-        def run!(resource, env = {}, secrets = {})
-          raise ArgumentError, "Invalid resource" unless resource&.start_with?("docker://")
-
-          image = resource.sub("docker://", "")
-
-          if secrets && !secrets.empty?
-            secret = create_secret(secrets)
-            env["_CREDENTIALS"] = "/run/secrets/#{secret}"
-          end
-
-          output = run_container(image, env, secret)
-
-          {"exit_code" => 0, :output => output}
-        ensure
-          delete_secret(secret) if secret
-        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)
-            env["_CREDENTIALS"] = "/run/secrets/#{secret_guid}"
-          end
-
-          begin
-            container_id = run_container(image, env, secret_guid, :detached => true)
-          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, detached: false)
+        def run_container(image, env, secret)
           params  = ["run"]
-          params << (detached ? :detach : :rm)
+          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)}")
@@ -103,16 +46,6 @@ module Floe
           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)
           secret_guid = SecureRandom.uuid
           podman!("secret", "create", secret_guid, "-", :in_data => secrets.to_json)
@@ -125,13 +58,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,14 +134,16 @@ module Floe
 
         def parse_error(output)
           return if output.nil?
+          return output if output.kind_of?(Hash)
 
-          JSON.parse(output)
+          JSON.parse(output.split("\n").last)
         rescue JSON::ParserError
-          {"Error" => output}
+          {"Error" => output.chomp}
         end
 
         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.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - ManageIQ Developers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-06 00:00:00.000000000 Z
+date: 2023-11-09 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.3.15
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Simple Workflow Runner.