floe 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58ace49051c911efbe352b2b882cc663aea3be231e6c8dcf138864e340ae2de6
-  data.tar.gz: d422be1ce106663dd1dc40b7ddb52024f9eb9b0e85f807572d66f31fcdf16e51
+  metadata.gz: 8e3870ee415e08857191014d61d92dac1b84be70aeff69bed7dbb6dd6f5f7af3
+  data.tar.gz: f6695006e7043837a078a8092ba1c544e23750a9179018ed29e84520e78424eb
 SHA512:
-  metadata.gz: e5eab9d1763c723d8bb913e31bb736d0ba3c3e6d6d63585031e30adc5cbd3049105c756b89eee6999df2d6a0dcfd35e6a1ae4a39c10ce949387e91aae30acf32
-  data.tar.gz: 3249cce513b7195ce5ed791c300d9df62159febeb522c45db36dda38244c76f9290af3157ac744fa0757417ce327f95eea80c704375310ed3181e05426208e3b
+  metadata.gz: ada0c662fa9f4c300ca977029b3c522a5ba36adf37485260dfccba5961064adfc513853beb1b992ca9199856b457bb6f66c8f4d60918157cb4579cf0655d7a7b
+  data.tar.gz: f6918df717d7e5c29d7298c1f9076d77515a3033247fefde072cdfd59797227defcec0087189d58945bbbbd528da3b5d876af612479bd1d2754fc7dc78db8c81

data/CHANGELOG.md

@@ -4,6 +4,21 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.7.0] - 2023-12-18
+### Changed
+- Remove the dependency on more_core_extensions in ReferencePath ([#144](https://github.com/ManageIQ/floe/pull/144))
+
+### Added
+- Implement `ReferencePath#get` ([#144](https://github.com/ManageIQ/floe/pull/144))
+- Allow a State to set a value in Credentials for subsequent states ([#145](https://github.com/ManageIQ/floe/pull/145))
+
+## [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))
@@ -99,7 +114,9 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - Initial release
 
-[Unreleased]: https://github.com/ManageIQ/floe/compare/v0.6.0...HEAD
+[Unreleased]: https://github.com/ManageIQ/floe/compare/v0.7.0...HEAD
+[0.7.0]: https://github.com/ManageIQ/floe/compare/v0.6.1...v0.7.0
+[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

data/README.md

@@ -51,6 +51,38 @@ 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"}'
 ```
 
+If you need to set a credential at runtime you can do that by using the `"ResultPath": "$.Credentials"` directive, for example to user a username/password to login and get a Bearer token:
+
+```
+bundle exec ruby exe/floe --workflow my-workflow.asl --credentials='{"username": "user", "password": "pass"}'
+```
+
+```json
+{
+  "StartAt": "Login",
+  "States": {
+    "Login": {
+      "Type": "Task",
+      "Resource": "docker://login:latest",
+      "Credentials": {
+        "username.$": "$.username",
+        "password.$": "$.password"
+      },
+      "ResultPath": "$.Credentials",
+      "Next": "DoSomething"
+    },
+    "DoSomething": {
+      "Type": "Task",
+      "Resource": "docker://do-something:latest",
+      "Credentials": {
+        "token.$": "$.bearer_token"
+      },
+      "End": true
+    }
+  }
+}
+```
+
 ### Ruby Library
 
 ```ruby

data/examples/set-credential.asl

@@ -0,0 +1,26 @@
+{
+  "Comment": "An example showing how to set a credential.",
+  "StartAt": "Login",
+  "States": {
+    "Login": {
+      "Type": "Task",
+      "Resource": "docker://docker.io/agrare/echo:latest",
+      "Parameters": {
+        "ECHO": "TOKEN"
+      },
+      "ResultPath": "$.Credentials",
+      "ResultSelector": {
+        "bearer_token.$": "$.echo"
+      },
+      "Next": "DoSomething"
+    },
+    "DoSomething": {
+      "Type": "Task",
+      "Resource": "docker://docker.io/agrare/hello-world:latest",
+      "Credentials": {
+        "bearer_token.$": "$.bearer_token"
+      },
+      "End": true
+    }
+  }
+}

data/floe.gemspec

@@ -32,6 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "awesome_spawn", "~>1.0"
   spec.add_dependency "jsonpath", "~>1.1"
   spec.add_dependency "kubeclient", "~>4.7"
-  spec.add_dependency "more_core_extensions"
   spec.add_dependency "optimist", "~>3.0"
 end

data/lib/floe/version.rb

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

data/lib/floe/workflow/path.rb

@@ -9,6 +9,8 @@ module Floe
         end
       end
 
+      attr_reader :payload
+
       def initialize(payload)
         @payload = payload
 
@@ -28,10 +30,6 @@ module Floe
 
         results.count < 2 ? results.first : results
       end
-
-      private
-
-      attr_reader :payload
     end
   end
 end

data/lib/floe/workflow/reference_path.rb

@@ -4,37 +4,54 @@ module Floe
   class Workflow
     class ReferencePath < Path
       class << self
+        def get(payload, context)
+          new(payload).get(context)
+        end
+
         def set(payload, context, value)
           new(payload).set(context, value)
         end
       end
 
-      def initialize(*)
-        require "more_core_extensions/core_ext/hash/nested"
-        require "more_core_extensions/core_ext/array/nested"
+      attr_reader :path
 
+      def initialize(*)
         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
+      end
+
+      def get(context)
+        return context if path.empty?
+
+        context.dig(*path)
       end
 
       def set(context, value)
         result = context.dup
 
-        path = JsonPath.new(payload)
-                       .path[1..]
-                       .map { |v| v.match(/\[(?<name>.+)\]/)["name"] }
-                       .map { |v| v[0] == "'" ? v.delete("'") : v.to_i }
-                       .compact
-
         # If the payload is '$' then merge the value into the context
-        # otherwise use store path to set the value to a sub-key
+        # otherwise store the value under the path
         #
         # TODO: how to handle non-hash values, raise error if path=$ and value not a hash?
         if path.empty?
           result.merge!(value)
         else
-          result.store_path(path, value)
+          child    = result
+          keys     = path.dup
+          last_key = keys.pop
+
+          keys.each do |key|
+            child[key] = {} if child[key].nil?
+            child = child[key]
+          end
+
+          child[last_key] = value
         end
 
         result

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

@@ -30,12 +30,11 @@ 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)
@@ -46,11 +45,13 @@ module Floe
         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)
@@ -58,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
@@ -67,6 +70,15 @@ 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}"] }
@@ -75,11 +87,6 @@ module Floe
           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)

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

@@ -56,15 +56,16 @@ module Floe
 
           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)
+          return if runner_context.key?("Error")
+
           runner_context["container_state"] = pod_info(runner_context["container_ref"]).to_h.deep_stringify_keys["status"]
         end
 
@@ -83,13 +84,14 @@ module Floe
         end
 
         def output(runner_context)
-          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
+          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)

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

@@ -30,7 +30,7 @@ module Floe
 
         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}"] }
@@ -39,11 +39,6 @@ module Floe
           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 create_secret(secrets)

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Floe
+  class Workflow
+    module States
+      module InputOutputMixin
+        def process_input(input)
+          input = input_path.value(context, input)
+          input = parameters.value(context, input) if parameters
+          input
+        end
+
+        def process_output(input, results)
+          return input if results.nil?
+          return if output_path.nil?
+
+          results = result_selector.value(context, results) if @result_selector
+          if result_path.payload.start_with?("$.Credentials")
+            credentials = result_path.set(workflow.credentials, results)["Credentials"]
+            workflow.credentials.merge!(credentials)
+            output = input
+          else
+            output = result_path.set(input, results)
+          end
+
+          output_path.value(context, output)
+        end
+      end
+    end
+  end
+end

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

@@ -4,6 +4,7 @@ module Floe
   class Workflow
     module States
       class Pass < Floe::Workflow::State
+        include InputOutputMixin
         include NonTerminalMixin
 
         attr_reader :end, :next, :result, :parameters, :input_path, :output_path, :result_path
@@ -25,12 +26,11 @@ module Floe
 
         def start(input)
           super
-          output = input_path.value(context, input)
-          output = result_path.set(output, result) if result && result_path
-          output = output_path.value(context, output)
 
+          input = process_input(input)
+
+          context.output     = process_output(input, result)
           context.next_state = end? ? nil : @next
-          context.output     = output
         end
 
         def running?

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

@@ -4,6 +4,7 @@ module Floe
   class Workflow
     module States
       class Task < Floe::Workflow::State
+        include InputOutputMixin
         include NonTerminalMixin
 
         attr_reader :credentials, :end, :heartbeat_seconds, :next, :parameters,
@@ -49,7 +50,7 @@ module Floe
 
           if success?
             output = parse_output(output)
-            context.state["Output"] = process_output!(output)
+            context.state["Output"] = process_output(context.input.dup, output)
             context.next_state      = next_state
           else
             error = parse_error(output)
@@ -126,12 +127,6 @@ module Floe
           context.state["Error"] = context.output["Error"]
         end
 
-        def process_input(input)
-          input = input_path.value(context, input)
-          input = parameters.value(context, input) if parameters
-          input
-        end
-
         def parse_error(output)
           return if output.nil?
           return output if output.kind_of?(Hash)
@@ -150,16 +145,6 @@ module Floe
           nil
         end
 
-        def process_output!(results)
-          output = context.input.dup
-          return output if results.nil?
-          return if output_path.nil?
-
-          results = result_selector.value(context, results) if result_selector
-          output  = result_path.set(output, results)
-          output_path.value(context, output)
-        end
-
         def next_state
           end? ? nil : @next
         end

data/lib/floe.rb

@@ -25,6 +25,7 @@ require_relative "floe/workflow/runner/podman"
 require_relative "floe/workflow/state"
 require_relative "floe/workflow/states/choice"
 require_relative "floe/workflow/states/fail"
+require_relative "floe/workflow/states/input_output_mixin"
 require_relative "floe/workflow/states/map"
 require_relative "floe/workflow/states/non_terminal_mixin"
 require_relative "floe/workflow/states/parallel"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: floe
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - ManageIQ Developers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-09 00:00:00.000000000 Z
+date: 2023-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_spawn
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.7'
-- !ruby/object:Gem::Dependency
-  name: more_core_extensions
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: optimist
   requirement: !ruby/object:Gem::Requirement
@@ -96,6 +82,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- examples/set-credential.asl
 - examples/workflow.asl
 - exe/floe
 - floe.gemspec
@@ -123,6 +110,7 @@ files:
 - lib/floe/workflow/state.rb
 - lib/floe/workflow/states/choice.rb
 - lib/floe/workflow/states/fail.rb
+- lib/floe/workflow/states/input_output_mixin.rb
 - lib/floe/workflow/states/map.rb
 - lib/floe/workflow/states/non_terminal_mixin.rb
 - lib/floe/workflow/states/parallel.rb