floe 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40373ebff63056265508d03a1f3d12c3f10c9933b0dbcaffee700140838797cb
-  data.tar.gz: 51df9c1251e26551c8eb07e3bf16ed17775753b5f62b8407f83b813349063a12
+  metadata.gz: d7ec87295c6283b53c25c1791a9f8a2a953e48bec4059bf67fd5487875c114ce
+  data.tar.gz: a56a431253dd0a4a4c4470363ce0dfa83aa6f8ec834239a43266c6e41ccc0b61
 SHA512:
-  metadata.gz: 57201f74d63b63a34c250f615b06013e9355828ed8a8e0007ba229f9b0b49d370428db87f067e0860dbef59bbd349e274a4573b661b34ca69c69ce5d65df1c01
-  data.tar.gz: e50628793fc80d43fa51fc266b26e1dc8dfeee6c98b9ffbed8c2a0d495ade115c4b77c68d9bcb2d059e1b0f5d573e40315530b837805d8e5b90bbfd9ddef291a
+  metadata.gz: c3d888a3713b5e3291e9fb7a04ea3254268e2ee11ccdc1a49af71f992cab61d5752d689f70292d67f3c9d3b69f146c47c0a86423a424c18220e813c2997c4402
+  data.tar.gz: f54adf8264d7ed09c05d2c78b8f5029d0ed5c472ac365e75a3656cc66fa29db0dd79eded1136b0893114d75eaf9a5e4637e76a2c347d1b8917ac8d3cf4238ec2

data/CHANGELOG.md

@@ -4,6 +4,18 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.19.0] - 2025-12-16
+### Fixed
+- Fix builtin_runner/runner spec file name ([#329](https://github.com/ManageIQ/floe/pull/329))
+- Check WaitUntil before starting a State ([#336](https://github.com/ManageIQ/floe/pull/336))
+- Task TimeoutSeconds and TimeoutSecondsPath not implemented ([#330](https://github.com/ManageIQ/floe/pull/330))
+
+### Added
+- Add floe://log builtin method ([#328](https://github.com/ManageIQ/floe/pull/328))
+
+### Changed
+- Raise `States.Timeout` in `running?` and remove duplicate `timed_out?` check in `finished?` ([#337](https://github.com/ManageIQ/floe/pull/337))
+
 ## [0.18.0] - 2025-10-24
 ### Added
 - Declare active support dependency ([#316](https://github.com/ManageIQ/floe/pull/316))
@@ -317,7 +329,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - Initial release
 
-[Unreleased]: https://github.com/ManageIQ/floe/compare/v0.18.0...HEAD
+[Unreleased]: https://github.com/ManageIQ/floe/compare/v0.19.0...HEAD
+[0.19.0]: https://github.com/ManageIQ/floe/compare/v0.18.0...v0.19.0
 [0.18.0]: https://github.com/ManageIQ/floe/compare/v0.17.1...v0.18.0
 [0.17.1]: https://github.com/ManageIQ/floe/compare/v0.17.0...v0.17.1
 [0.17.0]: https://github.com/ManageIQ/floe/compare/v0.16.0...v0.17.0

data/README.md

@@ -1,8 +1,6 @@
 # Floe
 
 [![CI](https://github.com/ManageIQ/floe/actions/workflows/ci.yaml/badge.svg)](https://github.com/ManageIQ/floe/actions/workflows/ci.yaml)
-[![Code Climate](https://codeclimate.com/github/ManageIQ/floe.svg)](https://codeclimate.com/github/ManageIQ/floe)
-[![Test Coverage](https://codeclimate.com/github/ManageIQ/floe/badges/coverage.svg)](https://codeclimate.com/github/ManageIQ/floe/coverage)
 
 ## Overview
 
@@ -167,6 +165,31 @@ Task Runner Types:
 
 This is the "builtin" runner and exposes methods that are executed internally without having to call out to a docker image.
 
+##### Log builtin method
+
+`floe://log` allows you to write a message to the logger.
+
+Example:
+```json
+{
+  "Comment": "Print log message",
+  "StartAt": "Log",
+  "States": {
+    "Log": {
+      "Type": "Task",
+      "Resource": "floe://log",
+      "Parameters": {
+        "Level": "INFO",
+        "Message": "Hello, Floe!"
+      },
+      "End": true
+    }
+```
+
+Log Parameters:
+* `Level` (required) - Log level. Permitted values: `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL`, or `UNKNOWN`.  Defaults to `INFO`.
+* `Message` (required) - The message to log
+
 ##### HTTP builtin method
 
 `floe://http` allows you to execute HTTP method calls.

data/examples/log.asl

@@ -0,0 +1,33 @@
+{
+  "Comment": "Print log messages",
+  "StartAt": "Log Info",
+  "States": {
+    "Log Info": {
+      "Type": "Task",
+      "Resource": "floe://log",
+      "Parameters": {
+        "Level": "INFO",
+        "Message": "Hello, Floe!"
+      },
+      "Next": "Log Debug"
+    },
+    "Log Debug": {
+      "Type": "Task",
+      "Resource": "floe://log",
+      "Parameters": {
+        "Level": "DEBUG",
+        "Message": "Hello, Floe!"
+      },
+      "Next": "Log From Input"
+    },
+    "Log From Input": {
+      "Type": "Task",
+      "Resource": "floe://log",
+      "Parameters": {
+        "Level": "INFO",
+        "Message.$": "States.Format('Hello, {}!', $.name)"
+      },
+      "End": true
+    }
+  }
+}

data/lib/floe/builtin_runner/methods.rb

@@ -1,6 +1,35 @@
+require "logger"
+
 module Floe
   module BuiltinRunner
     class Methods < BasicObject
+      def self.log(params, _secrets, context)
+        params["Level"] = (params["Level"] ||= "INFO").upcase
+
+        error = log_verify_params(params)
+        return BuiltinRunner.error!({}, :cause => error) if error
+
+        level, message = params.values_at("Level", "Message")
+
+        context.logger.add(::Logger::Severity.const_get(level), message)
+
+        BuiltinRunner.success!({}, :output => context.input)
+      end
+
+      LOG_SEVERITIES = ::Logger::Severity.constants.sort_by { |s| ::Logger::Severity.const_get(s) }.map(&:to_s)
+      LOG_SEVERITIES_S = "#{LOG_SEVERITIES[0..-2].join(", ")}, or #{LOG_SEVERITIES[-1]}"
+
+      private_class_method def self.log_verify_params(params)
+        return "Missing Parameter: Message" if params["Message"].nil?
+        return "Invalid Parameter: Level: [#{params["Level"]}], must be one of #{LOG_SEVERITIES_S}" unless LOG_SEVERITIES.include?(params["Level"])
+
+        nil
+      end
+
+      private_class_method def self.log_status!(runner_context)
+        runner_context
+      end
+
       def self.http(params, _secrets, _context)
         params["Method"] ||= "GET"
 

data/lib/floe/container_runner/docker.rb

@@ -105,10 +105,14 @@ module Floe
       end
 
       def running?(runner_context)
+        return false if runner_context.key?("Error")
+
         !!runner_context.dig("container_state", "Running")
       end
 
       def success?(runner_context)
+        return false if runner_context.key?("Error")
+
         runner_context.dig("container_state", "ExitCode") == 0
       end
 
@@ -186,8 +190,11 @@ module Floe
         raise Floe::ExecutionError, "Failed to get status for container #{container_id}: #{err}"
       end
 
-      def delete_container(container_id)
-        docker!("rm", container_id)
+      def delete_container(container_id, force: true)
+        params = ["rm", container_id]
+        params << "--force" if force
+
+        docker!(*params)
       rescue
         nil
       end

data/lib/floe/container_runner/kubernetes.rb

@@ -70,6 +70,7 @@ module Floe
       end
 
       def running?(runner_context)
+        return false if runner_context.key?("Error")
         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
@@ -80,6 +81,8 @@ module Floe
       end
 
       def success?(runner_context)
+        return false if runner_context.key?("Error")
+
         runner_context.dig("container_state", "phase") == "Succeeded"
       end
 

data/lib/floe/version.rb

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

data/lib/floe/workflow/context.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "securerandom"
+
 module Floe
   class Workflow
     class Context
@@ -25,6 +27,17 @@ module Floe
         raise Floe::InvalidExecutionInput, "Invalid State Machine Execution Input: #{err}: was expecting (JSON String, Number, Array, Object or token 'null', 'true' or 'false')"
       end
 
+      def prepare_start(start_at)
+        return if started?
+
+        state["Name"]  = start_at
+        state["Input"] = execution["Input"].dup
+        state["Guid"]  = SecureRandom.uuid
+
+        execution["Id"]      ||= SecureRandom.uuid
+        execution["StartTime"] = Time.now.utc.iso8601
+      end
+
       def execution
         @context["Execution"]
       end

data/lib/floe/workflow/state.rb

@@ -43,7 +43,9 @@ module Floe
 
       # @return for incomplete Errno::EAGAIN, for completed 0
       def run_nonblock!(context)
-        start(context) unless context.state_started?
+        # Only start the state if it isn't already started and it isn't waiting
+        # from a prior Retry.
+        start(context)       unless started?(context) || waiting?(context)
         return Errno::EAGAIN unless ready?(context)
 
         finish(context)
@@ -89,13 +91,13 @@ module Floe
       def mark_error(context, exception)
         # InputPath or OutputPath were bad.
         context.next_state = nil
-        context.output     = {"Error" => exception.floe_error, "Cause" => exception.message}
+        context.output     = exception.to_output
         # Since finish threw an exception, super was never called. Calling that now.
         mark_finished(context)
       end
 
       def ready?(context)
-        !started?(context) || !running?(context)
+        (started?(context) && !running?(context)) || !waiting?(context)
       end
 
       def running?(context)

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

@@ -9,29 +9,29 @@ module Floe
         include RetryCatchMixin
 
         attr_reader :credentials, :end, :heartbeat_seconds, :next, :parameters,
-                    :result_selector, :resource, :timeout_seconds, :retry, :catch,
-                    :input_path, :output_path, :result_path
+                    :result_selector, :resource, :timeout_seconds, :timeout_seconds_path,
+                    :retry, :catch, :input_path, :output_path, :result_path
 
         def initialize(workflow, name, payload)
           super
 
-          @heartbeat_seconds = payload["HeartbeatSeconds"]
-          @next              = payload["Next"]
-          @end               = !!payload["End"]
-          @resource          = payload["Resource"]
-
+          @resource = payload["Resource"]
           missing_field_error!("Resource") unless @resource.kind_of?(String)
           @runner = wrap_parser_error("Resource", @resource) { Floe::Runner.for_resource(@resource) }
 
-          @timeout_seconds   = payload["TimeoutSeconds"]
-          @retry             = payload["Retry"].to_a.map.with_index { |retrier, i| Retrier.new(workflow, name + ["Retry", i.to_s], retrier) }
-          @catch             = payload["Catch"].to_a.map.with_index { |catcher, i| Catcher.new(workflow, name + ["Catch", i.to_s], catcher) }
-          @input_path        = Path.new(payload.fetch("InputPath", "$"))
-          @output_path       = Path.new(payload.fetch("OutputPath", "$"))
-          @result_path       = ReferencePath.new(payload.fetch("ResultPath", "$"))
-          @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"]
+          @next                 = payload["Next"]
+          @end                  = !!payload["End"]
+          @timeout_seconds      = payload["TimeoutSeconds"]
+          @heartbeat_seconds    = payload["HeartbeatSeconds"]
+          @retry                = payload["Retry"].to_a.map.with_index { |retrier, i| Retrier.new(workflow, name + ["Retry", i.to_s], retrier) }
+          @catch                = payload["Catch"].to_a.map.with_index { |catcher, i| Catcher.new(workflow, name + ["Catch", i.to_s], catcher) }
+          @input_path           = Path.new(payload.fetch("InputPath", "$"))
+          @output_path          = Path.new(payload.fetch("OutputPath", "$"))
+          @result_path          = ReferencePath.new(payload.fetch("ResultPath", "$"))
+          @timeout_seconds_path = ReferencePath.new(payload["TimeoutSecondsPath"]) if payload["TimeoutSecondsPath"]
+          @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!(workflow)
         end
@@ -39,6 +39,9 @@ module Floe
         def start(context)
           super
 
+          # Wakeup no later than timeout_seconds to check if the Resource has timed out
+          wait_until!(context, :seconds => timeout_seconds) if timeout_seconds
+
           input          = process_input(context)
           secrets        = credentials&.value(context, context.input)
           runner_context = runner.run_async!(resource, input, secrets, context)
@@ -48,27 +51,31 @@ module Floe
 
         def finish(context)
           output = runner.output(context.state["RunnerContext"])
+          raise Floe::ExecutionError.from_output(parse_error(output)) unless success?(context)
+
+          output = parse_output(output)
+          context.output = process_output(context, output)
 
-          if success?(context)
-            output = parse_output(output)
-            context.output = process_output(context, output)
-          else
-            error = parse_error(output)
-            retry_state!(context, error) || catch_error!(context, error) || fail_workflow!(context, error)
-          end
           super
         ensure
           runner.cleanup(context.state["RunnerContext"])
         end
 
         def running?(context)
-          return true  if waiting?(context)
+          raise Floe::TimeoutError if timed_out?(context)
           return false if finished?(context)
 
           runner.status!(context.state["RunnerContext"])
           runner.running?(context.state["RunnerContext"])
         end
 
+        def mark_error(context, exception)
+          error = exception.to_output
+
+          retry_state!(context, error) || catch_error!(context, error) || fail_workflow!(context, error)
+          mark_finished(context)
+        end
+
         def end?
           @end
         end
@@ -79,12 +86,43 @@ module Floe
 
         def validate_state!(workflow)
           validate_state_next!(workflow)
+          validate_state_timeout_seconds!(workflow)
+          validate_state_timeout_seconds_path!(workflow)
+        end
+
+        def validate_state_timeout_seconds!(workflow)
+          return if @timeout_seconds.nil?
+          return if @timeout_seconds.kind_of?(Integer) && @timeout_seconds > 0
+
+          invalid_field_error!("TimeoutSeconds", @timeout_seconds, "must be positive, non-zero integer")
+        end
+
+        def validate_state_timeout_seconds_path!(workflow)
+          return if @timeout_seconds_path.nil? || @timeout_seconds.nil?
+
+          invalid_field_error!("TimeoutSecondsPath", nil, "cannot specify both \"TimeoutSeconds\" and \"TimeoutSecondsPath\"")
         end
 
         def success?(context)
           runner.success?(context.state["RunnerContext"])
         end
 
+        def timed_out?(context)
+          return false if timeout_seconds.nil? && timeout_seconds_path.nil?
+
+          timeout      = timeout_seconds || timeout_seconds_path.value(context, context.input)
+          entered_time = Time.parse(context.state["EnteredTime"])
+
+          Time.now.utc > entered_time + timeout
+        end
+
+        def task_timed_out!(context)
+          context.state["RunnerContext"]["Error"] = "States.Timeout"
+          context.state["RunnerContext"]["Cause"] = "Task timed out"
+
+          false
+        end
+
         def parse_error(output)
           return if output.nil?
           return output if output.kind_of?(Hash)

data/lib/floe/workflow.rb

@@ -150,15 +150,7 @@ module Floe
 
     # setup a workflow
     def start_workflow
-      return if context.state_name
-
-      context.state["Name"]  = start_at
-      context.state["Input"] = context.execution["Input"].dup
-      context.state["Guid"]  = SecureRandom.uuid
-
-      context.execution["Id"]      ||= SecureRandom.uuid
-      context.execution["StartTime"] = Time.now.utc.iso8601
-
+      context.prepare_start(start_at)
       self
     end
 
@@ -183,7 +175,7 @@ module Floe
 
       # if rerunning due to an error (and we are using Retry)
       if context.state_name == context.next_state && context.failed? && context.state.key?("Retrier")
-        next_state.merge!(context.state.slice("RetryCount", "Input", "Retrier"))
+        next_state.merge!(context.state.slice("RetryCount", "Input", "Retrier", "WaitUntil"))
       else
         next_state["Input"] = context.output
       end

data/lib/floe.rb

@@ -54,17 +54,36 @@ module Floe
   class InvalidExecutionInput < Error; end
 
   class ExecutionError < Error
+    def self.from_output(output)
+      raise ArgumentError unless output.kind_of?(Hash) && output.key?("Error")
+
+      new(output["Cause"], output["Error"])
+    end
+
     attr_reader :floe_error
 
     def initialize(message, floe_error = "States.Runtime")
       super(message)
       @floe_error = floe_error
     end
+
+    def to_output
+      {"Error" => floe_error}.tap do |output|
+        # If there is no "Cause" then ::Exception will use the exception class name
+        output["Cause"] = message if message != self.class.name.to_s
+      end
+    end
   end
 
   class PathError < ExecutionError
   end
 
+  class TimeoutError < ExecutionError
+    def initialize(message = nil)
+      super(message, "States.Timeout")
+    end
+  end
+
   def self.logger
     @logger ||= NullLogger.new
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: floe
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - ManageIQ Developers
@@ -225,10 +225,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop_cc.yml"
 - ".rubocop_local.yml"
 - ".yamllint"
 - CHANGELOG.md
@@ -238,6 +236,7 @@ files:
 - Rakefile
 - examples/everything.asl
 - examples/http.asl
+- examples/log.asl
 - examples/map.asl
 - examples/parallel.asl
 - examples/set-credential.asl

data/.codeclimate.yml

@@ -1,36 +0,0 @@
-version: '2'
-prepare:
-  fetch:
-  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/.rubocop_base.yml
-    path: ".rubocop_base.yml"
-  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/.rubocop_cc_base.yml
-    path: ".rubocop_cc_base.yml"
-  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/styles/base.yml
-    path: styles/base.yml
-  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/styles/cc_base.yml
-    path: styles/cc_base.yml
-checks:
-  argument-count:
-    enabled: false
-  complex-logic:
-    enabled: false
-  file-lines:
-    enabled: false
-  method-complexity:
-    config:
-      threshold: 11
-  method-count:
-    enabled: false
-  method-lines:
-    enabled: false
-  nested-control-flow:
-    enabled: false
-  return-statements:
-    enabled: false
-plugins:
-  rubocop:
-    enabled: true
-    config: ".rubocop_cc.yml"
-    channel: rubocop-1-56-3
-exclude_patterns:
-- spec/

data/.rubocop_cc.yml

@@ -1,4 +0,0 @@
-inherit_from:
-- ".rubocop_base.yml"
-- ".rubocop_cc_base.yml"
-- ".rubocop_local.yml"