floe 0.19.2 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1e0936f8b333d83b40601da291196c63d9fef4357dcd86c54d0b762051c3ca7
-  data.tar.gz: 5f084c9783bacc4ea7dd0c33aca1ae89001c097218c04b57d7f7be67e32e16d6
+  metadata.gz: 7276764c838fbe619e9dfbd03ef63ee48d654cb51e1c90338bd221312c35bac3
+  data.tar.gz: 61541bf22ba9193628978471a418d351aac5576cbdf3dc186374da04319dbec1
 SHA512:
-  metadata.gz: 62ab51ba7cea145cf5c8abb9d2f89074810eacae5c645321116bc93239887749e4685594adc064780920fcc86adf4cfc1ad41caad23517271a73210aa8ed33f1
-  data.tar.gz: 4486619b555718e0244a65b437cf419e92f3b94f1c802c05f9fd00b39142f9933b7ee97145b50310fb1bc4257f1545a2e3bf823c95b921469be75a9ef12409b6
+  metadata.gz: 4f295717a57a70e71683ec8e82b0755452cb5e740ffad204c40aa8d6970e78f159559c784541694982326a09e7437fea579202e77a34caa2f075293b4c11c421
+  data.tar.gz: 6ec1d9c222569c4bfa9d5decab841aa87fd8206bf69f753aa77dad6b182e680f9e0252f8be29cd8a93965ef91e1a92a290bc13bcb941c802dcb983ab289582a9

data/CHANGELOG.md

@@ -4,6 +4,16 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.20.0] - 2026-07-08
+### Fixed
+- Update to support io-wait v0.4 which drops the `IO#ready?` method ([#340](https://github.com/ManageIQ/floe/pull/340))
+- Return States.TaskFailed for failed http request ([#343](https://github.com/ManageIQ/floe/pull/343))
+- `kill -TERM` the docker wait process before exiting ([#344](https://github.com/ManageIQ/floe/pull/344))
+- Use Kernel.spawn directly to ensure no `/bin/sh -c` shell is created ([#345](https://github.com/ManageIQ/floe/pull/345))
+
+### Added
+- Add logging of the execution_id to exe/floe ([#341](https://github.com/ManageIQ/floe/pull/341))
+
 ## [0.19.2] - 2026-01-06
 ### Fixed
 - Lockdown io-wait to v0.3.* for `IO#ready?` ([#339](https://github.com/ManageIQ/floe/pull/339))
@@ -337,7 +347,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - Initial release
 
-[Unreleased]: https://github.com/ManageIQ/floe/compare/v0.19.2...HEAD
+[Unreleased]: https://github.com/ManageIQ/floe/compare/v0.20.0...HEAD
+[0.20.0]: https://github.com/ManageIQ/floe/compare/v0.19.2...v0.20.0
 [0.19.2]: https://github.com/ManageIQ/floe/compare/v0.19.1...v0.19.2
 [0.19.1]: https://github.com/ManageIQ/floe/compare/v0.19.0...v0.19.1
 [0.19.0]: https://github.com/ManageIQ/floe/compare/v0.18.0...v0.19.0

data/README.md

@@ -246,6 +246,27 @@ HTTP Parameters:
   * `User` - String - User for the proxy.
   * `Password` - String - Pasword for the proxy
 
+Output:
+A successful HTTP request will return the response Status, Body, and Headers. For example,
+```json
+{
+  "Status": 200,
+  "Body": {"result": {"foo": "bar"}},
+  "Headers": {"content-type": "application/json"}
+}
+```
+
+Errors:
+If an HTTP request fails, the `floe://http` builtin method will return an error payload that includes
+the error code, the reason, and the response Status, Body, and Headers. For example,
+```json
+{
+  "Error": "States.Http.StatusCode.404",
+  "Cause": "Not Found",
+  "Details": {"Status": 404, "Body": {"code": 404, "reason": "Page not found"}, "Headers": {"content-type": "application/json"}}
+}
+```
+
 #### Docker resource
 
 The docker resource runner takes a docker image URI, including the registry, name, and tag.

data/lib/floe/builtin_runner/methods.rb

@@ -94,7 +94,13 @@ module Floe
 
         output = {"Status" => response.status, "Body" => response.body, "Headers" => response.headers}
 
-        BuiltinRunner.success!({}, :output => output)
+        if response.success?
+          BuiltinRunner.success!({}, :output => output)
+        else
+          BuiltinRunner.error!({}, :error => "States.Http.StatusCode.#{response.status}", :cause => response.reason_phrase, :details => output)
+        end
+      rescue ::Faraday::ConnectionFailed => err
+        BuiltinRunner.error!({}, :cause => err.to_s)
       end
 
       private_class_method def self.http_verify_params(params)

data/lib/floe/builtin_runner.rb

@@ -7,9 +7,11 @@ module Floe
     SCHEME_PREFIX = "#{SCHEME}://".freeze
 
     class << self
-      def error!(runner_context = {}, cause:, error: "States.TaskFailed")
+      def error!(runner_context = {}, cause: nil, error: "States.TaskFailed", details: nil)
+        output = {"Error" => error, "Cause" => cause, "Details" => details}.compact
+
         runner_context.merge!(
-          "running" => false, "success" => false, "output" => {"Error" => error, "Cause" => cause}
+          "running" => false, "success" => false, "output" => output
         )
       end
 

data/lib/floe/cli/logger.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Floe
+  class CLI
+    class Logger < ::Logger
+      attr_accessor :execution_id
+
+      def initialize(...)
+        super
+
+        original_formatter = formatter || ::Logger::Formatter.new
+        self.formatter = proc do |severity, time, progname, msg|
+          prefix = execution_id ? "[#{execution_id}] " : ""
+          original_formatter.call(severity, time, progname, "#{prefix}#{msg}")
+        end
+      end
+    end
+  end
+end

data/lib/floe/cli.rb

@@ -1,44 +1,38 @@
 require "floe"
+require "floe/cli/logger"
 require "floe/container_runner"
+require "optimist"
+require "stringio"
 
 module Floe
   class CLI
     include Logging
 
     def initialize
-      require "optimist"
-      require "logger"
-
-      Floe.logger = Logger.new($stdout)
+      Floe.logger = ::Logger.new($stdout)
       Floe.logger.level = 0 if ENV["DEBUG"]
     end
 
     def run(args = ARGV)
       workflows_inputs, opts = parse_options!(args)
 
+      show_execution_id = workflows_inputs.size > 1
+
       credentials = create_credentials(opts)
 
       workflows =
-        workflows_inputs.each_slice(2).map do |workflow, input|
-          create_workflow(workflow, opts[:context], input, credentials)
+        workflows_inputs.map do |workflow, input|
+          wf_logger = create_logger(show_execution_id)
+          create_workflow(workflow, opts[:context], input, credentials, wf_logger)
         end
 
-      output_streams = create_loggers(workflows, opts[:segment_output])
-
       logger.info("Checking #{workflows.count} workflows...")
       ready = Floe::Workflow.wait(workflows, &:run_nonblock)
       logger.info("Checking #{workflows.count} workflows...Complete - #{ready.count} ready")
 
       # Display status
       workflows.each do |workflow|
-        if workflows.size > 1
-          logger.info("")
-          logger.info("#{workflow.name}#{" (#{workflow.status})" unless workflow.context.success?}")
-          logger.info("===")
-        end
-
-        logger.info(output_streams[workflow].string) if output_streams[workflow]
-        logger.info(workflow.output)
+        logger.info("[#{workflow.context.execution_id}] #{workflow.name} (#{workflow.status}) - output: #{workflow.output}")
       end
 
       workflows.all? { |workflow| workflow.context.success? }
@@ -62,7 +56,6 @@ module Floe
         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 :segment_output, "Segment output by each worker",     :default => false
 
         Floe::ContainerRunner.cli_options(self)
 
@@ -70,20 +63,20 @@ module Floe
         banner("General options:")
       end
 
-      # Create workflow/input pairs from the various combinations of paramaters
+      # Create workflow/input pairs from the various combinations of parameters
       workflows_inputs =
         if opts[:workflow_given]
           Optimist.die("cannot specify both --workflow and bare workflows") if args.any?
 
-          [opts[:workflow], opts.fetch(:input, "{}")]
+          [[opts[:workflow], opts.fetch(:input, "{}")]]
         elsif opts[:input_given]
           Optimist.die("workflow(s) must be specified") if args.empty?
 
-          args.flat_map { |w| [w, opts[:input].dup] }
+          args.map { |w| [w, opts[:input].dup] }
         else
           Optimist.die("workflow/input pairs must be specified") if args.empty? || (args.size > 1 && args.size.odd?)
 
-          args
+          args.each_slice(2).to_a
         end
 
       Floe::ContainerRunner.resolve_cli_options!(opts)
@@ -102,20 +95,15 @@ module Floe
       JSON.parse(credentials_str)
     end
 
-    def create_workflow(workflow, context_payload, input, credentials)
-      context = Floe::Workflow::Context.new(context_payload, :input => input, :credentials => credentials)
+    def create_workflow(workflow, context_payload, input, credentials, logger)
+      context = Floe::Workflow::Context.new(context_payload, :input => input, :credentials => credentials, :logger => logger)
       Floe::Workflow.load(workflow, context)
     end
 
-    def create_loggers(workflows, segment_output)
-      if workflows.size == 1 || !segment_output
-        # no extra work necessary
-        {}
-      else
-        workflows.each_with_object({}) do |workflow, h|
-          workflow.context.logger = Logger.new(output = StringIO.new)
-          h[workflow] = output
-        end
+    def create_logger(show_execution_id)
+      logger_class = show_execution_id ? Floe::CLI::Logger : ::Logger
+      logger_class.new($stdout).tap do |logger|
+        logger.level = 0 if ENV["DEBUG"]
       end
     end
   end

data/lib/floe/container_runner/docker.rb

@@ -46,13 +46,12 @@ module Floe
       end
 
       def wait(timeout: nil, events: %i[create update delete], &block)
-        until_timestamp = Time.now.utc + timeout if timeout
+        until_timestamp = (Time.now.utc + timeout).to_i if timeout
 
         r, w = IO.pipe
 
-        pid = AwesomeSpawn.run_detached(
-          self.class::DOCKER_COMMAND, :err => :out, :out => w, :params => wait_params(until_timestamp)
-        )
+        pid = Kernel.spawn({}, self.class::DOCKER_COMMAND, *wait_params(until_timestamp), :err => :out, :out => w)
+        Process.detach(pid)
 
         w.close
 
@@ -65,7 +64,7 @@ module Floe
 
           # Get all events while the pipe is readable
           notices = []
-          while r.ready?
+          while r.wait_readable(0)
             notice = r.gets
 
             # If the process has exited `r.gets` returns `nil` and the pipe is
@@ -92,10 +91,12 @@ module Floe
           Process.kill(0, pid)
         rescue Errno::ESRCH
           # Break out of the loop if the `docker events` process has exited
+          pid = nil
           break
         end
       ensure
         r.close
+        sigterm(pid) if pid
       end
 
       def status!(runner_context)
@@ -150,8 +151,10 @@ module Floe
       end
 
       def wait_params(until_timestamp)
-        params = ["events", [:format, "{{json .}}"], [:filter, "type=container"], [:since, Time.now.utc.to_i]]
-        params << [:until, until_timestamp.to_i] if until_timestamp
+        since_timestamp = Time.now.utc.to_i
+
+        params  = ["events", "--format", "{{json .}}", "--filter", "type=container", "--since", since_timestamp.to_s]
+        params += ["--until", until_timestamp.to_s] if until_timestamp
         params
       end
 

data/lib/floe/version.rb

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

data/lib/floe/workflow/context.rb

@@ -36,12 +36,20 @@ module Floe
 
         execution["Id"]      ||= SecureRandom.uuid
         execution["StartTime"] = Time.now.utc.iso8601
+
+        if logger.respond_to?(:execution_id=)
+          logger.execution_id = execution["Id"]
+        end
       end
 
       def execution
         @context["Execution"]
       end
 
+      def execution_id
+        execution["Id"]
+      end
+
       def credentials
         @context["Credentials"]
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: floe
 version: !ruby/object:Gem::Version
-  version: 0.19.2
+  version: 0.20.0
 platform: ruby
 authors:
 - ManageIQ Developers
@@ -69,16 +69,22 @@ dependencies:
   name: io-wait
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -155,14 +161,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -242,12 +248,12 @@ files:
 - examples/set-credential.asl
 - examples/workflow.asl
 - exe/floe
-- floe.gemspec
 - lib/floe.rb
 - lib/floe/builtin_runner.rb
 - lib/floe/builtin_runner/methods.rb
 - lib/floe/builtin_runner/runner.rb
 - lib/floe/cli.rb
+- lib/floe/cli/logger.rb
 - lib/floe/container_runner.rb
 - lib/floe/container_runner/docker.rb
 - lib/floe/container_runner/docker_mixin.rb

data/floe.gemspec

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/floe/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "floe"
-  spec.version = Floe::VERSION
-  spec.authors = ["ManageIQ Developers"]
-
-  spec.summary = "Floe is a runner for Amazon States Language workflows."
-  spec.description = spec.summary
-  spec.homepage = "https://github.com/ManageIQ/floe"
-  spec.licenses = ["Apache-2.0"]
-  spec.required_ruby_version = ">= 3.0.0"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-  spec.metadata['rubygems_mfa_required'] = "true"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "activesupport", ">5.2"
-  spec.add_dependency "awesome_spawn", "~>1.6"
-  spec.add_dependency "faraday"
-  spec.add_dependency "faraday-follow_redirects"
-  spec.add_dependency "io-wait", "~> 0.3.6"
-  spec.add_dependency "json", "~>2.10"
-  spec.add_dependency "jsonpath", "~>1.1"
-  spec.add_dependency "kubeclient", "~>4.7"
-  spec.add_dependency "optimist", "~>3.0"
-  spec.add_dependency "parslet", "~>2.0"
-
-  spec.add_development_dependency "manageiq-style", ">= 1.5.2"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "simplecov", ">= 0.21.2"
-  spec.add_development_dependency "timecop"
-end