floe 0.13.1 → 0.15.0

data/lib/floe.rb

@@ -8,8 +8,11 @@ require_relative "floe/logging"
 require_relative "floe/runner"
 
 require_relative "floe/validation_mixin"
+require_relative "floe/workflow_base"
 require_relative "floe/workflow"
+# mixins used by workflow components
 require_relative "floe/workflow/error_matcher_mixin"
+require_relative "floe/workflow/branch"
 require_relative "floe/workflow/catcher"
 require_relative "floe/workflow/choice_rule"
 require_relative "floe/workflow/choice_rule/not"
@@ -17,6 +20,7 @@ require_relative "floe/workflow/choice_rule/or"
 require_relative "floe/workflow/choice_rule/and"
 require_relative "floe/workflow/choice_rule/data"
 require_relative "floe/workflow/context"
+require_relative "floe/workflow/item_processor"
 require_relative "floe/workflow/intrinsic_function"
 require_relative "floe/workflow/intrinsic_function/parser"
 require_relative "floe/workflow/intrinsic_function/transformer"
@@ -25,11 +29,14 @@ require_relative "floe/workflow/payload_template"
 require_relative "floe/workflow/reference_path"
 require_relative "floe/workflow/retrier"
 require_relative "floe/workflow/state"
+# mixins used by states
+require_relative "floe/workflow/states/child_workflow_mixin"
+require_relative "floe/workflow/states/input_output_mixin"
+require_relative "floe/workflow/states/non_terminal_mixin"
+require_relative "floe/workflow/states/retry_catch_mixin"
 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"
 require_relative "floe/workflow/states/pass"
 require_relative "floe/workflow/states/succeed"
@@ -43,7 +50,18 @@ module Floe
   class Error < StandardError; end
   class InvalidWorkflowError < Error; end
   class InvalidExecutionInput < Error; end
-  class PathError < Error; end
+
+  class ExecutionError < Error
+    attr_reader :floe_error
+
+    def initialize(message, floe_error = "States.Runtime")
+      super(message)
+      @floe_error = floe_error
+    end
+  end
+
+  class PathError < ExecutionError
+  end
 
   def self.logger
     @logger ||= NullLogger.new

data/tools/step_functions

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby
+
+require "bundler/inline"
+gemfile do
+  source "https://rubygems.org"
+  gem "optimist"
+  gem "colorize"
+end
+require "pp"
+
+SUB_COMMANDS = {
+  "execute"   => "Execute an .asl file through the stepfunctions simulator.",
+  "intrinsic" => "Execute an intrinsic function or JSONPath standalone."
+}.freeze
+Optimist.options do
+  banner "Run the aws stepfunctions simulator."
+  banner ""
+  banner "Notes:"
+  banner "  This tool requires the stepfunctions simulator to be installed locally and running."
+  banner "  Installation instructions can be found at https://docs.aws.amazon.com/step-functions/latest/dg/sfn-local.html."
+  banner ""
+  banner "Commands:"
+  SUB_COMMANDS.each { |k, v| banner "  #{k.ljust(14)}#{v}" }
+  banner ""
+  banner "  For more help with a specific command use #{$PROGRAM_NAME} <command> --help"
+  banner ""
+  banner "Global Options:"
+  stop_on SUB_COMMANDS.keys
+end
+cmd = ARGV.shift
+Optimist.educate if cmd.nil?
+Optimist.die "unknown subcommand #{cmd.inspect}" unless SUB_COMMANDS.include?(cmd)
+
+def aws_stepfunctions(args)
+  cmd = "aws stepfunctions --endpoint-url http://localhost:8083 #{args}"
+  puts "** #{cmd}".light_black if ENV["DEBUG"]
+  output = `#{cmd}`.chomp
+  output = output.empty? ? {} : JSON.parse(output)
+  puts output.pretty_inspect.light_black if ENV["DEBUG"]
+  output
+rescue JSON::ParserError => err
+  warn "ERROR: #{err}".light_red if ENV["DEBUG"]
+  {}
+end
+
+def execute_stepfunction(definition, input)
+  require "json"
+  require "shellwords"
+
+  begin
+    state_machine_arn = aws_stepfunctions("create-state-machine --definition #{Shellwords.escape(definition)} --name 'StateMachine' --role-arn 'arn:aws:iam::012345678901:role/DummyRole'")["stateMachineArn"]
+    exit 1 if state_machine_arn.nil?
+
+    input = input ? "--input #{Shellwords.escape(input)}" : ""
+    execution_arn = aws_stepfunctions("start-execution --state-machine-arn #{state_machine_arn} #{input}")["executionArn"]
+    exit 1 if execution_arn.nil?
+
+    status, output = aws_stepfunctions("describe-execution --execution-arn #{execution_arn}").values_at("status", "output")
+    if status == "FAILED"
+      warn "ERROR: Execution failed. See simulator for reason.".light_red
+      exit 1
+    end
+  ensure
+    aws_stepfunctions("stop-execution --execution-arn #{execution_arn}") if execution_arn
+    aws_stepfunctions("delete-state-machine --state-machine-arn #{state_machine_arn}") if state_machine_arn
+  end
+
+  puts output if output
+end
+
+def execute
+  opts = Optimist.options do
+    banner SUB_COMMANDS["execute"]
+    banner ""
+
+    opt :file,  "The .asl file to execute", :default => "definition.asl"
+    opt :input, "Input to the execution", :type => :string
+  end
+
+  definition = File.read(opts[:file]).chomp
+  execute_stepfunction(definition, opts[:input])
+end
+
+def intrinsic
+  opts = Optimist.options do
+    banner SUB_COMMANDS["intrinsic"]
+    banner ""
+
+    opt :function, "The intrinsic function or JSONPath to run", :type => :string, :required => true
+    opt :input, "Input to the execution", :type => :string
+  end
+
+  require "json"
+
+  definition = {
+    "StartAt" => "ExecState",
+    "States"  => {
+      "ExecState" => {
+        "Type"       => "Pass",
+        "Parameters" => {"data.$" => opts[:function]},
+        "OutputPath" => "$.data",
+        "End"        => true
+      }
+    }
+  }.to_json
+
+  execute_stepfunction(definition, opts[:input])
+end
+
+send(cmd)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: floe
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.15.0
 platform: ruby
 authors:
 - ManageIQ Developers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-16 00:00:00.000000000 Z
+date: 2024-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_spawn
@@ -182,6 +182,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/map.asl
+- examples/parallel.asl
 - examples/set-credential.asl
 - examples/workflow.asl
 - exe/floe
@@ -199,6 +201,7 @@ files:
 - lib/floe/validation_mixin.rb
 - lib/floe/version.rb
 - lib/floe/workflow.rb
+- lib/floe/workflow/branch.rb
 - lib/floe/workflow/catcher.rb
 - lib/floe/workflow/choice_rule.rb
 - lib/floe/workflow/choice_rule/and.rb
@@ -210,11 +213,13 @@ files:
 - lib/floe/workflow/intrinsic_function.rb
 - lib/floe/workflow/intrinsic_function/parser.rb
 - lib/floe/workflow/intrinsic_function/transformer.rb
+- lib/floe/workflow/item_processor.rb
 - lib/floe/workflow/path.rb
 - lib/floe/workflow/payload_template.rb
 - lib/floe/workflow/reference_path.rb
 - lib/floe/workflow/retrier.rb
 - lib/floe/workflow/state.rb
+- lib/floe/workflow/states/child_workflow_mixin.rb
 - lib/floe/workflow/states/choice.rb
 - lib/floe/workflow/states/fail.rb
 - lib/floe/workflow/states/input_output_mixin.rb
@@ -222,11 +227,13 @@ files:
 - lib/floe/workflow/states/non_terminal_mixin.rb
 - lib/floe/workflow/states/parallel.rb
 - lib/floe/workflow/states/pass.rb
+- lib/floe/workflow/states/retry_catch_mixin.rb
 - lib/floe/workflow/states/succeed.rb
 - lib/floe/workflow/states/task.rb
 - lib/floe/workflow/states/wait.rb
+- lib/floe/workflow_base.rb
 - renovate.json
-- sig/floe.rbs/floe.rbs
+- tools/step_functions
 homepage: https://github.com/ManageIQ/floe
 licenses:
 - Apache-2.0

data/sig/floe.rbs/floe.rbs

@@ -1,4 +0,0 @@
-module Floe
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end