floe 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c7a74a5297258d481fb588ae0fa6eb1b22b7ecf5c049865b77ad23d6fb135cb
-  data.tar.gz: 82f73726e293e5345d3e7fa55a0049f881f2dce6e6d46570d2352968907c04b9
+  metadata.gz: 2b158e514e08902a1138c7b2878bb8633ca7c1abb59d4b77b6d9ce568c65710b
+  data.tar.gz: 32d053bba54e8c35645a636771964692e435ad72ee38e03c8c22b4da5bce25ec
 SHA512:
-  metadata.gz: 32d58e28cd76d936f31f9af2c1091d8a7dd930e47a2197b532c02d6d48df2c82feee696072af701aeca5f2af5437040ea3bace5df622c1ad5d0e47e388884ad2
-  data.tar.gz: 1ee0628fbfde496d00fae67812ac869582b1aca754aca7cf44caa7170edc1b0f6c9100a587770d6f6bb97bc0a948dd8fe0123fd108b9ed037ad71bc62bb8e104
+  metadata.gz: e39301eed1de9189b66f07a7ecdda807974bf47495b4906bd57f6f8ed862fab38448668155f79e12c87da8935f4054d14dbcd08e292429b194768d2234fa7c46
+  data.tar.gz: 5cf0476521a1cd4fc0dcc4edeccdd00c6c72ee88bf7428103b86f5f30097608f934f19e75499a61b5d7e7380f2e1451dccfd82f796eee6bcef041dd6f3db8664

data/CHANGELOG.md

@@ -4,6 +4,19 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.10.0] - 2024-04-05
+### Fixed
+- Fix rubocops ([#164](https://github.com/ManageIQ/floe/pull/164))
+- Output should contain errors ([#165](https://github.com/ManageIQ/floe/pull/165))
+
+### Added
+- Add simplecov ([#162](https://github.com/ManageIQ/floe/pull/162))
+- Add ability to pass context on the command line ([#161](https://github.com/ManageIQ/floe/pull/161))
+- Add specs for `Workflow#wait_until`, `#waiting?` ([#166](https://github.com/ManageIQ/floe/pull/166))
+
+### Changed
+- Drop non-standard Error/Cause fields ([#167](https://github.com/ManageIQ/floe/pull/167))
+
 ## [0.9.0] - 2024-02-19
 ### Changed
 - Default to wait indefinitely ([#157](https://github.com/ManageIQ/floe/pull/157))
@@ -136,7 +149,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - Initial release
 
-[Unreleased]: https://github.com/ManageIQ/floe/compare/v0.9.0...HEAD
+[Unreleased]: https://github.com/ManageIQ/floe/compare/v0.10.0...HEAD
+[0.10.0]: https://github.com/ManageIQ/floe/compare/v0.9.0...v0.10.0
 [0.9.0]: https://github.com/ManageIQ/floe/compare/v0.8.0...v0.9.0
 [0.8.0]: https://github.com/ManageIQ/floe/compare/v0.7.0...v0.8.0
 [0.7.0]: https://github.com/ManageIQ/floe/compare/v0.6.1...v0.7.0

data/Gemfile

@@ -7,9 +7,3 @@ require File.join(Bundler::Plugin.index.load_paths("bundler-inject")[0], "bundle
 
 # Specify your gem's dependencies in floe.gemspec
 gemspec
-
-gem "manageiq-style"
-gem "rake", "~> 13.0"
-gem "rspec"
-gem "rubocop"
-gem "timecop"

data/exe/floe

@@ -10,6 +10,7 @@ opts = Optimist.options do
 
   opt :workflow, "Path to your workflow json (legacy)",         :type => :string
   opt :input, "JSON payload to input to the workflow (legacy)", :type => :string
+  opt :context, "JSON payload of the Context",                  :type => :string
   opt :credentials, "JSON payload with credentials",            :type => :string
   opt :credentials_file, "Path to a file with credentials",     :type => :string
   opt :docker_runner, "Type of runner for docker images",       :type => :string, :short => 'r'
@@ -49,7 +50,7 @@ credentials =
 
 workflows =
   args.each_slice(2).map do |workflow, input|
-    context = Floe::Workflow::Context.new(:input => input || opts[:input] || "{}")
+    context = Floe::Workflow::Context.new(opts[:context], :input => input || opts[:input] || "{}")
     Floe::Workflow.load(workflow, context, credentials)
   end
 

data/floe.gemspec

@@ -34,4 +34,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency "jsonpath", "~>1.1"
   spec.add_dependency "kubeclient", "~>4.7"
   spec.add_dependency "optimist", "~>3.0"
+
+  spec.add_development_dependency "manageiq-style"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "simplecov", ">= 0.21.2"
+  spec.add_development_dependency "timecop"
 end

data/lib/floe/version.rb

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

data/lib/floe/workflow/context.rb

@@ -3,19 +3,19 @@
 module Floe
   class Workflow
     class Context
+      # @param context [Json|Hash] (default, create another with input and execution params)
+      # @param input [Hash] (default: {})
       def initialize(context = nil, input: {})
         context = JSON.parse(context) if context.kind_of?(String)
         input = JSON.parse(input) if input.kind_of?(String)
 
-        @context = context || {
-          "Execution"    => {
-            "Input" => input
-          },
-          "State"        => {},
-          "StateHistory" => [],
-          "StateMachine" => {},
-          "Task"         => {}
-        }
+        @context = context || {}
+        self["Execution"]          ||= {}
+        self["Execution"]["Input"] ||= input
+        self["State"]              ||= {}
+        self["StateHistory"]       ||= []
+        self["StateMachine"]       ||= {}
+        self["Task"]               ||= {}
       end
 
       def execution
@@ -30,6 +30,10 @@ module Floe
         started? && !ended?
       end
 
+      def failed?
+        output&.key?("Error") || false
+      end
+
       def ended?
         execution.key?("EndTime")
       end
@@ -67,7 +71,7 @@ module Floe
           "pending"
         elsif running?
           "running"
-        elsif state["Error"]
+        elsif failed?
           "failure"
         else
           "success"

data/lib/floe/workflow/reference_path.rb

@@ -19,11 +19,11 @@ module Floe
         super
 
         raise Floe::InvalidWorkflowError, "Invalid Reference Path" if payload.match?(/@|,|:|\?/)
+
         @path = JsonPath.new(payload)
                         .path[1..]
                         .map { |v| v.match(/\[(?<name>.+)\]/)["name"] }
-                        .map { |v| v[0] == "'" ? v.delete("'") : v.to_i }
-                        .compact
+                        .filter_map { |v| v[0] == "'" ? v.delete("'") : v.to_i }
       end
 
       def get(context)

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

@@ -6,9 +6,10 @@ module Floe
           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
+        # 63 is the max kubernetes pod name length
+        # -5 for the "floe-" prefix
+        # -9 for the random hex suffix and leading hyphen
+        MAX_CONTAINER_NAME_SIZE = 63 - 5 - 9
 
         def container_name(image)
           name = image_name(image)

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

@@ -164,7 +164,7 @@ module Floe
 
         def failed_container_states(context)
           container_statuses = context.dig("container_state", "containerStatuses") || []
-          container_statuses.map { |status| status["state"]&.values&.first }.compact
+          container_statuses.filter_map { |status| status["state"]&.values&.first }
                             .select { |state| FAILURE_REASONS.include?(state["reason"]) }
         end
 

data/lib/floe/workflow/state.rb

@@ -58,7 +58,7 @@ module Floe
         context.state["Guid"]            = SecureRandom.uuid
         context.state["EnteredTime"]     = start_time
 
-        logger.info("Running state: [#{context.state_name}] with input [#{context.input}]...")
+        logger.info("Running state: [#{long_name}] with input [#{context.input}]...")
       end
 
       def finish
@@ -70,7 +70,8 @@ module Floe
         context.state["Duration"]       = finished_time - entered_time
         context.execution["EndTime"]    = finished_time_iso if context.next_state.nil?
 
-        logger.info("Running state: [#{context.state_name}] with input [#{context.input}]...Complete - next state: [#{context.next_state}] output: [#{context.output}]")
+        level = context.output&.[]("Error") ? :error : :info
+        logger.public_send(level, "Running state: [#{long_name}] with input [#{context.input}]...Complete #{context.next_state ? "- next state [#{context.next_state}]" : "workflow -"} output: [#{context.output}]")
 
         context.state_history << context.state
 
@@ -101,6 +102,10 @@ module Floe
         context.state["WaitUntil"] && Time.parse(context.state["WaitUntil"])
       end
 
+      def long_name
+        "#{self.class.name.split("::").last}:#{name}"
+      end
+
       private
 
       def wait_until!(seconds: nil, time: nil)

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

@@ -18,14 +18,14 @@ module Floe
           @output_path = Path.new(payload.fetch("OutputPath", "$"))
         end
 
-        def start(input)
-          super
-          input      = input_path.value(context, input)
+        def finish
+          input      = input_path.value(context, context.input)
           next_state = choices.detect { |choice| choice.true?(context, input) }&.next || default
           output     = output_path.value(context, input)
 
           context.next_state = next_state
           context.output     = output
+          super
         end
 
         def running?

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

@@ -15,18 +15,16 @@ module Floe
           @error_path = Path.new(payload["ErrorPath"]) if payload["ErrorPath"]
         end
 
-        def start(input)
-          super
+        def finish
           context.next_state = nil
           # TODO: support intrinsic functions here
           # see https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-fail-state.html
           #     https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-intrinsic-functions.html#asl-intrsc-func-generic
           context.output     = {
-            "Error" => @error_path ? @error_path.value(context, input) : error,
-            "Cause" => @cause_path ? @cause_path.value(context, input) : cause
+            "Error" => @error_path ? @error_path.value(context, context.input) : error,
+            "Cause" => @cause_path ? @cause_path.value(context, context.input) : cause
           }.compact
-          context.state["Error"] = context.output["Error"]
-          context.state["Cause"] = context.output["Cause"]
+          super
         end
 
         def running?

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

@@ -24,13 +24,11 @@ module Floe
           validate_state!
         end
 
-        def start(input)
-          super
-
-          input = process_input(input)
-
+        def finish
+          input              = process_input(context.input)
           context.output     = process_output(input, result)
           context.next_state = end? ? nil : @next
+          super
         end
 
         def running?

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

@@ -10,10 +10,10 @@ module Floe
           super
         end
 
-        def start(input)
-          super
+        def finish
           context.next_state = nil
-          context.output     = input
+          context.output     = context.input
+          super
         end
 
         def running?

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

@@ -46,19 +46,18 @@ module Floe
         end
 
         def finish
-          super
-
           output = runner.output(context.state["RunnerContext"])
 
           if success?
             output = parse_output(output)
-            context.state["Output"] = process_output(context.input.dup, output)
+            context.output = process_output(context.input.dup, output)
+            super
           else
             context.next_state = nil
-            error = parse_error(output)
+            context.output = error = parse_error(output)
+            super
             retry_state!(error) || catch_error!(error) || fail_workflow!(error)
           end
-
         ensure
           runner.cleanup(context.state["RunnerContext"])
         end
@@ -110,6 +109,7 @@ module Floe
 
           wait_until!(:seconds => retrier.sleep_duration(context["State"]["RetryCount"]))
           context.next_state = context.state_name
+          logger.info("Running state: [#{long_name}] with input [#{context.input}]...Retry - delay: #{wait_until}")
           true
         end
 
@@ -119,13 +119,15 @@ module Floe
 
           context.next_state = catcher.next
           context.output     = catcher.result_path.set(context.input, error)
+          logger.info("Running state: [#{long_name}] with input [#{context.input}]...CatchError - next state: [#{context.next_state}] output: [#{context.output}]")
+
           true
         end
 
         def fail_workflow!(error)
           context.next_state     = nil
           context.output         = {"Error" => error["Error"], "Cause" => error["Cause"]}.compact
-          context.state["Error"] = context.output["Error"]
+          logger.error("Running state: [#{long_name}] with input [#{context.input}]...Complete workflow - output: [#{context.output}]")
         end
 
         def parse_error(output)

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

@@ -29,8 +29,7 @@ module Floe
         def start(input)
           super
 
-          input          = input_path.value(context, input)
-          context.output = output_path.value(context, input)
+          input = input_path.value(context, context.input)
 
           wait_until!(
             :seconds => seconds_path ? seconds_path.value(context, input).to_i : seconds,
@@ -38,6 +37,12 @@ module Floe
           )
         end
 
+        def finish
+          input          = input_path.value(context, context.input)
+          context.output = output_path.value(context, input)
+          super
+        end
+
         def running?
           waiting?
         end

data/lib/floe/workflow.rb

@@ -85,7 +85,7 @@ module Floe
       end
     end
 
-    attr_reader :context, :credentials, :payload, :states, :states_by_name, :start_at, :name
+    attr_reader :context, :credentials, :payload, :states, :states_by_name, :start_at, :name, :comment
 
     def initialize(payload, context = nil, credentials = {}, name = nil)
       payload     = JSON.parse(payload)     if payload.kind_of?(String)
@@ -100,6 +100,7 @@ module Floe
       @payload     = payload
       @context     = context
       @credentials = credentials || {}
+      @comment     = payload["Comment"]
       @start_at    = payload["StartAt"]
 
       @states         = payload["States"].to_a.map { |state_name, state| State.build!(self, state_name, state) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: floe
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - ManageIQ Developers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-19 00:00:00.000000000 Z
+date: 2024-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_spawn
@@ -80,6 +80,90 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: manageiq-style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Simple Workflow Runner.
 email:
 executables: