floe 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad8fec2f632914594254c32b7871eb8a4f23f3dfd2263ef5fe0875d0cccce8fa
-  data.tar.gz: 7e12b5a1a197dc44a7c7bd1b1581891a56908e7ae26836d5e26b73eb41c2a3ae
+  metadata.gz: f2791bb2351fad37f210264d51e059b780937e42a5cb1ab2c9c157ac01e18eea
+  data.tar.gz: 37436eb4095fc92c4ec4d07e84a09fd27a5b3e794faea09d5ebd37383f886830
 SHA512:
-  metadata.gz: 0b02c0ff479ff69433994732d6f3371c2a3e27fa36a094d5dea8340798f249015319821de30ad61334bc2bd9a6b25fb1791dfb0b023e7d0097472f35b93279a7
-  data.tar.gz: 49b6adb80c1910c9d006d41418e1741e8c62510633507583d2b34dc526a0ce4b73bb1faaa83b7950f0e1d31cbb9b37bd3e4b566bd2c374c824390a840e2e2519
+  metadata.gz: ef1fd3317c12e6af2cdfaaf07dc7cf9c281579d21b623b8ff1a7bcfe906794e19d4b964e3e33560a8d1a3e66abc1c7b1fe85e236c05497aaafea5dc027e8acfd
+  data.tar.gz: da683adbe9e0513613524f1e6c94380159e0cb07a34b6464c90b76b1ea9227534c1a7af6c1c884873ee9a811cbf90bc40275c4c728c20d2a8732172eab6554d6

data/CHANGELOG.md

@@ -4,45 +4,59 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.3.0] - 2023-08-07
+### Added
+- 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)
+
+## [0.2.3] - 2023-07-28
+### Fixed
+- Fix storing next_state in Context ([#76])(https://github.com/ManageIQ/floe/pull/76)
+
 ## [0.2.2] - 2023-07-24
 ### Fixed
-- Don't pick up real KUBECONFIG for tests (#73)
-- Fix double json.parse and context default value (#69)
+- Don't pick up real KUBECONFIG for tests ([#73](https://github.com/ManageIQ/floe/pull/73))
+- Fix double json.parse and context default value ([#69](https://github.com/ManageIQ/floe/pull/69))
 
 ### Added
-- Configure Renovate (#46)
+- Configure Renovate ([#46](https://github.com/ManageIQ/floe/pull/46))
 
 ### Changed
-- Simplify next state handling (#66)
-- Refactor Input/Output path handling (#68)
+- Simplify next state handling ([#66](https://github.com/ManageIQ/floe/pull/66))
+- Refactor Input/Output path handling ([#68](https://github.com/ManageIQ/floe/pull/68))
 
 ## [0.2.1] - 2023-07-12
 ### Fixed
-- Fix State EnteredTime and FinishedTime (#59)
+- Fix State EnteredTime and FinishedTime ([#59](https://github.com/ManageIQ/floe/pull/59))
 
 ### Added
-- Add workflow output (#57)
+- Add workflow output ([#57](https://github.com/ManageIQ/floe/pull/57))
 
 ## [0.2.0] - 2023-07-05
 ### Added
-- Add ability to pass options to `Floe::Workflow::Runner` (#48)
-- Add kubeconfig file support to `Floe::Workflow::Runner::Kubernetes` (#53)
+- Add ability to pass options to `Floe::Workflow::Runner` ([#48](https://github.com/ManageIQ/floe/pull/48))
+- Add kubeconfig file support to `Floe::Workflow::Runner::Kubernetes` ([#53](https://github.com/ManageIQ/floe/pull/53))
 
 ### Removed
-- Remove to_dot/to_svg code (#54)
+- Remove to_dot/to_svg code ([#54](https://github.com/ManageIQ/floe/pull/54))
 
 ### Fixed
-- Fixed default rake task to spec (#55)
+- Fixed default rake task to spec ([#55](https://github.com/ManageIQ/floe/pull/55))
 
 ## [0.1.1] - 2023-06-05
 ### Fixed
-- Fix States::Wait Path initializer arguments (#47)
+- Fix States::Wait Path initializer arguments ([#47](https://github.com/ManageIQ/floe/pull/47))
 
 ## [0.1.0] - 2023-03-13
 ### Added
 - Initial release
 
-[Unreleased]: https://github.com/ManageIQ/floe/compare/v0.2.2...HEAD
+[Unreleased]: https://github.com/ManageIQ/floe/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/ManageIQ/floe/compare/v0.2.3...v0.3.0
+[0.2.3]: https://github.com/ManageIQ/floe/compare/v0.2.2...v0.2.3
 [0.2.2]: https://github.com/ManageIQ/floe/compare/v0.2.1...v0.2.2
 [0.2.1]: https://github.com/ManageIQ/floe/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/ManageIQ/floe/compare/v0.1.1...v0.2.0

data/README.md

@@ -36,6 +36,21 @@ bundle exec ruby exe/floe --workflow examples/workflow.asl --inputs='{"foo": 1}'
 bundle exec ruby exe/floe --workflow examples/workflow.asl --inputs='{"foo": 1}' --docker-runner kubernetes --docker-runner-options namespace=default server=https://k8s.example.com:6443 token=my-token
 ```
 
+If your workflow has `Credentials` you can provide a payload that will help resolve those credentials references at runtime.
+
+For example if your workflow had the following Credentials field with a JSON Path property:
+```json
+"Credentials": {
+  "RoleArn.$": "$.roleArn"
+}
+```
+
+You can provide that at runtime via the `--credentials` parameter:
+
+```
+bundle exec ruby exe/floe --workflow my-workflow.asl --credentials='{"roleArn": "arn:aws:iam::111122223333:role/LambdaRole"}'
+```
+
 ### Ruby Library
 
 ```ruby
@@ -59,6 +74,18 @@ workflow.run!
 
 ### Docker Runner Options
 
+#### Docker
+
+Options supported by the Docker docker runner are:
+
+* `network` - What docker to connect the container to, defaults to `"bridge"`.  If you need access to host resources for development you can pass `network=host`.
+
+#### Podman
+
+Options supported by the podman docker runner are:
+
+* `network` - What docker to connect the container to, defaults to `"bridge"`.  If you need access to host resources for development you can pass `network=host`.
+
 #### Kubernetes
 
 Options supported by the kubernetes docker runner are:

data/lib/floe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Floe
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/floe/workflow/payload_template.rb

@@ -21,10 +21,11 @@ module Floe
           value.map { |val| interpolate_value_nested(val, context, inputs) }
         when Hash
           value.to_h do |key, val|
-            val = interpolate_value_nested(val, context, inputs)
-            key = key.gsub(/\.\$$/, "") if key.end_with?(".$")
-
-            [key, val]
+            if key.end_with?(".$")
+              [key.chomp(".$"), interpolate_value_nested(val, context, inputs)]
+            else
+              [key, val]
+            end
           end
         when String
           value.start_with?("$") ? Path.value(value, context, inputs) : value

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

@@ -4,11 +4,13 @@ module Floe
   class Workflow
     class Runner
       class Docker < Floe::Workflow::Runner
-        def initialize(*)
+        def initialize(options = {})
           require "awesome_spawn"
           require "tempfile"
 
           super
+
+          @network = options.fetch("network", "bridge")
         end
 
         def run!(resource, env = {}, secrets = {})
@@ -16,7 +18,8 @@ module Floe
 
           image = resource.sub("docker://", "")
 
-          params = ["run", :rm, [:net, "host"]]
+          params  = ["run", :rm]
+          params += [[:net, "host"]] if network == "host"
           params += env.map { |k, v| [:e, "#{k}=#{v}"] } if env
 
           secrets_file = nil
@@ -39,6 +42,10 @@ module Floe
         ensure
           secrets_file&.close!
         end
+
+        private
+
+        attr_reader :network
       end
     end
   end

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

@@ -4,11 +4,13 @@ module Floe
   class Workflow
     class Runner
       class Podman < Floe::Workflow::Runner
-        def initialize(*)
+        def initialize(options = {})
           require "awesome_spawn"
           require "securerandom"
 
           super
+
+          @network = options.fetch("network", "bridge")
         end
 
         def run!(resource, env = {}, secrets = {})
@@ -16,7 +18,8 @@ module Floe
 
           image = resource.sub("docker://", "")
 
-          params = ["run", :rm]
+          params  = ["run", :rm]
+          params += [[:net, "host"]] if network == "host"
           params += env.map { |k, v| [:e, "#{k}=#{v}"] } if env
 
           if secrets && !secrets.empty?
@@ -36,6 +39,10 @@ module Floe
         ensure
           AwesomeSpawn.run("podman", :params => ["secret", "rm", secret_guid]) if secret_guid
         end
+
+        private
+
+        attr_reader :network
       end
     end
   end

data/lib/floe/workflow/state.rb

@@ -25,22 +25,13 @@ module Floe
         @workflow = workflow
         @name     = name
         @payload  = payload
-        @end      = !!payload["End"]
         @type     = payload["Type"]
         @comment  = payload["Comment"]
       end
 
-      def end?
-        @end
-      end
-
       def context
         workflow.context
       end
-
-      def status
-        end? ? "success" : "running"
-      end
     end
   end
 end

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

@@ -23,6 +23,14 @@ module Floe
 
           [next_state, output]
         end
+
+        def status
+          "running"
+        end
+
+        def end?
+          false
+        end
       end
     end
   end

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

@@ -11,7 +11,6 @@ module Floe
 
           @cause = payload["Cause"]
           @error = payload["Error"]
-          @end   = true
         end
 
         def run!(input)
@@ -21,6 +20,10 @@ module Floe
         def status
           "errored"
         end
+
+        def end?
+          true
+        end
       end
     end
   end

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

@@ -10,6 +10,7 @@ module Floe
           super
 
           @next        = payload["Next"]
+          @end         = !!payload["End"]
           @result      = payload["Result"]
 
           @parameters  = PayloadTemplate.new(payload["Parameters"]) if payload["Parameters"]
@@ -23,7 +24,15 @@ module Floe
           output = result_path.set(output, result) if result && result_path
           output = output_path.value(context, output)
 
-          [@next, output]
+          [@end ? nil : @next, output]
+        end
+
+        def status
+          @end ? "success" : "running"
+        end
+
+        def end?
+          @end
         end
       end
     end

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

@@ -8,13 +8,19 @@ module Floe
 
         def initialize(workflow, name, payload)
           super
-
-          @end = true
         end
 
         def run!(input)
           [nil, input]
         end
+
+        def status
+          "success"
+        end
+
+        def end?
+          true
+        end
       end
     end
   end

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

@@ -13,6 +13,7 @@ module Floe
 
           @heartbeat_seconds = payload["HeartbeatSeconds"]
           @next              = payload["Next"]
+          @end               = !!payload["End"]
           @resource          = payload["Resource"]
           @timeout_seconds   = payload["TimeoutSeconds"]
           @retry             = payload["Retry"].to_a.map { |retrier| Retrier.new(retrier) }
@@ -33,7 +34,7 @@ module Floe
           _exit_status, results = runner.run!(resource, input, credentials&.value({}, workflow.credentials))
 
           output = process_output!(input, results)
-          [@next, output]
+          [@end ? nil : @next, output]
         rescue => err
           retrier = self.retry.detect { |r| (r.error_equals & [err.to_s, "States.ALL"]).any? }
           retry if retry!(retrier)
@@ -44,6 +45,14 @@ module Floe
           [catcher.next, output]
         end
 
+        def status
+          @end ? "success" : "running"
+        end
+
+        def end?
+          @end
+        end
+
         private
 
         def retry!(retrier)

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

@@ -10,6 +10,7 @@ module Floe
           super
 
           @next    = payload["Next"]
+          @end     = !!payload["End"]
           @seconds = payload["Seconds"].to_i
 
           @input_path  = Path.new(payload.fetch("InputPath", "$"))
@@ -20,7 +21,15 @@ module Floe
           input = input_path.value(context, input)
           sleep(seconds)
           output = output_path.value(context, input)
-          [@next, output]
+          [@end ? nil : @next, output]
+        end
+
+        def status
+          @end ? "success" : "running"
+        end
+
+        def end?
+          @end
         end
       end
     end

data/lib/floe/workflow.rb

@@ -29,8 +29,10 @@ module Floe
       @states_by_name = @states.each_with_object({}) { |state, result| result[state.name] = state }
       start_at        = @payload["StartAt"]
 
-      current_state_name = context.state["Name"] || start_at
-      @current_state = @states_by_name[current_state_name]
+      context.state["Name"] ||= start_at
+
+      current_state_name = context.state["Name"]
+      @current_state     = @states_by_name[current_state_name]
 
       @status = current_state_name == start_at ? "pending" : current_state.status
     rescue JSON::ParserError => err
@@ -41,26 +43,22 @@ module Floe
       @status = "running" if @status == "pending"
       context.execution["StartTime"] ||= Time.now.utc
 
-      input = context.state["Output"] || context.execution["Input"].dup
+      context.state["Guid"]    = SecureRandom.uuid
+      context.state["Input"] ||= context.execution["Input"].dup
 
-      logger.info("Running state: [#{current_state.name}] with input [#{input}]...")
+      logger.info("Running state: [#{current_state.name}] with input [#{context.state["Input"]}]...")
 
-      context.state = {
-        "Guid"        => SecureRandom.uuid,
-        "EnteredTime" => Time.now.utc,
-        "Input"       => input,
-        "Name"        => current_state.name
-      }
+      context.state["EnteredTime"] = Time.now.utc
 
       tick = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-      next_state, output = current_state.run!(input)
+      next_state, output = current_state.run!(context.state["Input"])
       tock = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
       context.state["FinishedTime"] = Time.now.utc
       context.state["Duration"]     = (tock - tick) / 1_000_000.0
       context.state["Output"]       = output
 
-      logger.info("Running state: [#{current_state.name}] with input [#{input}]...Complete - next state: [#{next_state}] output: [#{output}]")
+      logger.info("Running state: [#{current_state.name}] with input [#{context["Input"]}]...Complete - next state: [#{next_state}] output: [#{output}]")
 
       context.states << context.state
 
@@ -68,6 +66,8 @@ module Floe
       @current_state = next_state && @states_by_name[next_state]
       @output        = output if end?
 
+      context.state = {"Name" => next_state, "Input" => output} unless end?
+
       self
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: floe
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - ManageIQ Developers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-24 00:00:00.000000000 Z
+date: 2023-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_spawn