Merge pull request #203 from kbrock/context_credentials

Pass credentials around with context

exe/floe

@@ -57,8 +57,8 @@ credentials =
 
 workflows =
   args.each_slice(2).map do |workflow, input|
-    context = Floe::Workflow::Context.new(opts[:context], :input => input)
-    Floe::Workflow.load(workflow, context, credentials)
+    context = Floe::Workflow::Context.new(opts[:context], :input => input, :credentials => credentials)
+    Floe::Workflow.load(workflow, context)
   end
 
 # run

lib/floe/workflow.rb

@@ -85,21 +85,24 @@ def wait(workflows, timeout: nil, &block)
       end
     end
 
-    attr_reader :context, :credentials, :payload, :states, :states_by_name, :start_at, :name, :comment
+    attr_reader :context, :payload, :states, :states_by_name, :start_at, :name, :comment
 
-    def initialize(payload, context = nil, credentials = {}, name = nil)
+    def initialize(payload, context = nil, credentials = nil, name = nil)
       payload     = JSON.parse(payload)     if payload.kind_of?(String)
       credentials = JSON.parse(credentials) if credentials.kind_of?(String)
       context     = Context.new(context)    unless context.kind_of?(Context)
 
+      # backwards compatibility
+      # caller should really put credentials into context and not pass that variable
+      context.credentials = credentials if credentials
+
       raise Floe::InvalidWorkflowError, "Missing field \"States\""  if payload["States"].nil?
       raise Floe::InvalidWorkflowError, "Missing field \"StartAt\"" if payload["StartAt"].nil?
       raise Floe::InvalidWorkflowError, "\"StartAt\" not in the \"States\" field" unless payload["States"].key?(payload["StartAt"])
 
       @name        = name
       @payload     = payload
       @context     = context
-      @credentials = credentials || {}
       @comment     = payload["Comment"]
       @start_at    = payload["StartAt"]
 
@@ -175,6 +178,10 @@ def current_state
       @states_by_name[context.state_name]
     end
 
+    # backwards compatibility. Caller should access directly from context
+    def credentials
+      @context.credentials
+    end
     private
 
     def step!

lib/floe/workflow/context.rb

@@ -3,9 +3,11 @@
 module Floe
   class Workflow
     class Context
+      attr_accessor :credentials
+
       # @param context [Json|Hash] (default, create another with input and execution params)
       # @param input [Hash] (default: {})
-      def initialize(context = nil, input: nil)
+      def initialize(context = nil, input: nil, credentials: {})
         context = JSON.parse(context) if context.kind_of?(String)
 
         input ||= {}
@@ -18,6 +20,8 @@ def initialize(context = nil, input: nil)
         self["StateHistory"]       ||= []
         self["StateMachine"]       ||= {}
         self["Task"]               ||= {}
+
+        @credentials = credentials || {}
       end
 
       def execution

lib/floe/workflow/states/input_output_mixin.rb

@@ -16,8 +16,8 @@ def process_output(input, results)
 
           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)
+            credentials = result_path.set(context.credentials, results)["Credentials"]
+            context.credentials.merge!(credentials)
             output = input
           else
             output = result_path.set(input, results)

lib/floe/workflow/states/task.rb

@@ -36,7 +36,7 @@ def start(input)
           super
 
           input          = process_input(input)
-          runner_context = runner.run_async!(resource, input, credentials&.value({}, workflow.credentials), context)
+          runner_context = runner.run_async!(resource, input, credentials&.value({}, workflow.context.credentials), context)
 
           context.state["RunnerContext"] = runner_context
         end

spec/spec_helper.rb

@@ -59,8 +59,8 @@
 
   # factory methods
 
-  def make_workflow(ctx, payload, creds: {})
-    Floe::Workflow.new(make_payload(payload), ctx, creds)
+  def make_workflow(ctx, payload)
+    Floe::Workflow.new(make_payload(payload), ctx)
   end
 
   def make_payload(states)

spec/workflow/context_spec.rb

@@ -13,6 +13,10 @@
       expect(ctx.execution["api"]).to eq("http://localhost/")
       expect(ctx.state).not_to eq(nil)
     end
+
+    it "defaults credentials to {}" do
+      expect(ctx.credentials).to eq({})
+    end
   end
 
   describe "#started?" do

spec/workflow/states/pass_spec.rb

@@ -49,7 +49,7 @@
 
       it "sets the result in Credentials" do
         state.run_nonblock!
-        expect(workflow.credentials).to include({"user" => "luggage", "password" => "1234"})
+        expect(ctx.credentials).to include({"user" => "luggage", "password" => "1234"})
         expect(ctx.next_state).to eq("SuccessState")
       end
     end

spec/workflow/states/task_spec.rb

@@ -162,7 +162,7 @@
 
             workflow.run_nonblock
 
-            expect(workflow.credentials).to include("token" => "shhh!")
+            expect(ctx.credentials).to include("token" => "shhh!")
             expect(ctx.output).to eq(
               "foo" => {"bar" => "baz"},
               "bar" => {"baz" => "foo"}

spec/workflow_spec.rb

@@ -16,11 +16,6 @@
       expect(ctx.ended?).to eq(false)
     end
 
-    it "sets credentials to empty hash if nil passed in" do
-      workflow = make_workflow(ctx, {"FirstState" => {"Type" => "Succeed"}}, :creds => nil)
-      expect(workflow.credentials).to eq({})
-    end
-
     it "raises an exception for missing States" do
       payload = {"StartAt" => "Nothing"}
 
@@ -366,12 +361,12 @@
 
   describe "#comment" do
     it "handles no comment" do
-      workflow = Floe::Workflow.new({"StartAt" => "First", "States" => {"First" => {"Type" => "Succeed"}}}, {})
+      workflow = Floe::Workflow.new({"StartAt" => "First", "States" => {"First" => {"Type" => "Succeed"}}})
       expect(workflow.comment).to be nil
     end
 
     it "handles a comment" do
-      workflow = Floe::Workflow.new({"StartAt" => "First", "Comment" => "great stuff", "States" => {"First" => {"Type" => "Succeed"}}}, {})
+      workflow = Floe::Workflow.new({"StartAt" => "First", "Comment" => "great stuff", "States" => {"First" => {"Type" => "Succeed"}}})
       expect(workflow.comment).to eq("great stuff")
     end
   end