A Spike to get dynamic auth tokens in request headers

lib/pact/consumer/interaction_builder.rb

@@ -24,6 +24,7 @@ def given provider_state
       end
 
       def with(request_details)
+        #require 'pry'; binding.pry
         interaction.request = Pact::Request::Expected.from_hash(request_details)
         self
       end

lib/pact/provider/request.rb

@@ -67,4 +67,4 @@ def with_http_prefix header
       end
     end
   end
-end
+end

lib/pact/provider/rspec.rb

@@ -77,15 +77,15 @@ def describe_interaction interaction, options
               before do | example |
                 interaction_context.run_once :before do
                   Pact.configuration.logger.info "Running example '#{Pact::RSpec.full_description(example)}'"
-                  set_up_provider_state interaction.provider_state, options[:consumer]
+                  set_up_provider_state interaction, options[:consumer]
                   replay_interaction interaction
                   interaction_context.last_response = last_response
                 end
               end
 
               after do
                 interaction_context.run_once :after do
-                  tear_down_provider_state interaction.provider_state, options[:consumer]
+                  tear_down_provider_state interaction, options[:consumer]
                 end
               end
 

lib/pact/provider/state/provider_state.rb

@@ -68,6 +68,7 @@ class ProviderState
 
       attr_accessor :name
       attr_accessor :namespace
+      attr_accessor :interaction
 
       extend Pact::DSL
 
@@ -116,7 +117,8 @@ def register_no_op
         @no_op_defined = true
       end
 
-      def set_up
+      def set_up interaction
+        @interaction = interaction
         if @set_up_block
           include_provider_state_configured_modules
           instance_eval &@set_up_block
@@ -168,7 +170,7 @@ def include_provider_state_configured_modules
 
     class NoOpProviderState
 
-      def self.set_up
+      def self.set_up interaction=nil
 
       end
 

lib/pact/provider/state/provider_state_manager.rb

@@ -2,31 +2,31 @@ module Pact
   module Provider::State
     class ProviderStateManager
 
-      attr_reader :provider_state_name, :consumer
+      attr_reader :interaction, :consumer
 
-      def initialize provider_state_name, consumer
-        @provider_state_name = provider_state_name
+      def initialize interaction, consumer
+        @interaction = interaction
         @consumer = consumer
       end
 
       def set_up_provider_state
-        get_global_base_provider_state.set_up
-        get_consumer_base_provider_state.set_up
-        if provider_state_name
-          get_provider_state.set_up
+        if interaction && interaction.provider_state
+          get_global_base_provider_state.set_up(interaction)
+          get_consumer_base_provider_state.set_up(interaction)
+          get_provider_state.set_up(interaction)
         end
       end
 
       def tear_down_provider_state
-        if provider_state_name
+        if interaction && interaction.provider_state
           get_provider_state.tear_down
         end
         get_consumer_base_provider_state.tear_down
         get_global_base_provider_state.tear_down
       end
 
       def get_provider_state
-        Pact.provider_world.provider_states.get(provider_state_name, :for => consumer)
+        Pact.provider_world.provider_states.get(interaction.provider_state, :for => consumer)
       end
 
       def get_consumer_base_provider_state
@@ -39,4 +39,4 @@ def get_global_base_provider_state
 
     end
   end
-end
+end

lib/pact/provider/test_methods.rb

@@ -34,12 +34,12 @@ def parse_body_from_response rack_response
         end
       end
 
-      def set_up_provider_state provider_state_name, consumer
-        State::ProviderStateManager.new(provider_state_name, consumer).set_up_provider_state
+      def set_up_provider_state interaction, consumer
+        State::ProviderStateManager.new(interaction, consumer).set_up_provider_state
       end
 
-      def tear_down_provider_state provider_state_name, consumer
-        State::ProviderStateManager.new(provider_state_name, consumer).tear_down_provider_state
+      def tear_down_provider_state interaction, consumer
+        State::ProviderStateManager.new(interaction, consumer).tear_down_provider_state
       end
 
     end

spec/lib/pact/provider/state/provider_state_manager_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'pact/provider/state/provider_state_manager'
+require 'pact/consumer_contract/interaction'
 
 module Pact::Provider::State
 
@@ -42,7 +43,8 @@ module Pact::Provider::State
       end
     end
 
-    let(:provider_state_manager) { ProviderStateManager.new("a custom state", "a consumer with provider states") }
+    let(:interaction) { Pact::Interaction.new(provider_state: "a custom state") }
+    let(:provider_state_manager) { ProviderStateManager.new(interaction, "a consumer with provider states") }
 
     describe "set_up_provider_state" do
 
@@ -86,4 +88,4 @@ module Pact::Provider::State
 
   end
 
-end
+end

spec/lib/pact/provider/state/provider_state_spec.rb

@@ -5,6 +5,8 @@ module Pact
   module Provider::State
 
     describe ProviderStates do
+
+      let(:interaction) { double(:interaction).as_null_object }
       MESSAGES = []
 
       before do
@@ -13,7 +15,6 @@ module Provider::State
 
       describe 'global ProviderState' do
 
-
         Pact.provider_state :no_alligators do
           set_up do
             MESSAGES << 'set_up'
@@ -27,12 +28,11 @@ module Provider::State
           no_op
         end
 
-
         subject { ProviderStates.get('no_alligators') }
 
         describe 'set_up' do
           it 'should call the block passed to set_up' do
-            subject.set_up
+            subject.set_up interaction
             expect(MESSAGES).to eq ['set_up']
           end
         end
@@ -59,12 +59,13 @@ module Provider::State
       end
 
       describe 'no_op' do
+
         context "when a no_op is defined instead of a set_up or tear_down" do
           it "treats set_up and tear_down as empty blocks" do
             Pact.provider_state 'with_no_op' do
               no_op
             end
-            ProviderStates.get('with_no_op').set_up
+            ProviderStates.get('with_no_op').set_up interaction
             ProviderStates.get('with_no_op').tear_down
           end
         end
@@ -134,14 +135,15 @@ module Provider::State
         describe 'set_up' do
           context 'for a consumer' do
             it 'runs its own setup' do
-              ProviderStates.get('the weather is sunny', :for => 'a consumer').set_up
+              ProviderStates.get('the weather is sunny', :for => 'a consumer').set_up interaction
               expect(NAMESPACED_MESSAGES).to eq ['sunny!']
             end
           end
         end
       end
 
       describe "base_provider_state" do
+
         Pact.provider_states_for "a consumer with base state" do
           set_up do
             MESSAGES << "setting up base provider state"
@@ -150,15 +152,15 @@ module Provider::State
 
         context "when the base state has been declared" do
           it "creates a base state for the provider" do
-            ProviderStates.get_base(:for => "a consumer with base state").set_up
+            ProviderStates.get_base(:for => "a consumer with base state").set_up interaction
             expect(MESSAGES).to eq ["setting up base provider state"]
           end
 
         end
 
         context "when a base state has not been declared" do
           it "returns a no op state" do
-            ProviderStates.get_base(:for => "a consumer that does not exist").set_up
+            ProviderStates.get_base(:for => "a consumer that does not exist").set_up nil
             ProviderStates.get_base(:for => "a consumer that does not exist").tear_down
           end
         end
@@ -167,6 +169,7 @@ module Provider::State
 
       describe "global base_provider_state" do
 
+
         before(:all) do
           Pact.set_up do
             MESSAGES << "setting up global base provider state"
@@ -175,15 +178,15 @@ module Provider::State
 
         context "when the base state has been declared" do
           it "creates a base state for the provider" do
-            ProviderStates.get_base.set_up
+            ProviderStates.get_base.set_up interaction
             expect(MESSAGES).to eq ["setting up global base provider state"]
           end
 
         end
 
         context "when a base state has not been declared" do
           it "returns a no op state" do
-            ProviderStates.get_base.set_up
+            ProviderStates.get_base.set_up interaction
             ProviderStates.get_base.tear_down
           end
         end

spec/spec_helper.rb

@@ -13,6 +13,7 @@
 
 RSpec.configure do | config |
   config.include(FakeFS::SpecHelpers, :fakefs => true)
+  config.fail_fast = false
 
   config.extend Pact::Provider::RSpec::ClassMethods
   config.include Pact::Provider::RSpec::InstanceMethods

spec/support/intercept_request_headers.json

@@ -0,0 +1,21 @@
+{
+    "consumer": {
+        "name": "Consumer"
+    },
+    "provider": {
+        "name": "Provider"
+    },
+    "interactions": [
+        {
+            "description": "",
+            "provider_state": "intercepted_request_with_dynamic_auth_token",
+            "request": {
+                "method": "get",
+                "path": "/authorized_call"
+            },
+            "response": {
+                "status": 200
+            }
+        }
+    ]
+}

spec/support/intercept_request_headers.rb

@@ -0,0 +1,27 @@
+require 'json'
+require 'pact/provider/rspec'
+require './spec/support/active_support_if_configured'
+
+class App
+
+  def call env
+    if env['PATH_INFO'] == '/authorized_call' && env['HTTP_AUTHORIZATION'] == 'some dynamic token'
+      [200, {'Content-Type' => 'application/json'}, [{message: 'so secure...'}.to_json]]
+    end
+  end
+
+  Pact.service_provider "Provider" do
+    app { App.new }
+
+    honours_pact_with 'Consumer' do
+      pact_uri './spec/support/intercept_request_headers.json'
+    end
+  end
+
+  Pact.provider_state "intercepted_request_with_dynamic_auth_token" do
+    set_up do
+      interaction.request.instance_eval('@headers = {}') # hack this in there to create some headers for now.
+      interaction.request.headers['Authorization'] = 'some dynamic token'
+    end
+  end
+end

spec/support/stubbing_using_allow.rb

@@ -26,4 +26,4 @@ def self.call env
 
 Pact.service_provider 'Provider' do
   app { App }
-end
+end

tasks/pact-test.rake

@@ -42,6 +42,10 @@ Pact::VerificationTask.new('test_app:content_type') do | pact |
 	pact.uri './spec/support/test_app_with_right_content_type_differ.json'
 end
 
+Pact::VerificationTask.new('test_app:intercept_request_headers') do | pact |
+	pact.uri './spec/support/intercept_request_headers.json', pact_helper: './spec/support/intercept_request_headers.rb'
+end
+
 Pact::VerificationTask.new('test_app:fail') do | pact |
 	pact.uri './spec/support/test_app_fail.json', pact_helper: './spec/support/pact_helper.rb'
 end
@@ -59,6 +63,7 @@ namespace :pact do
 		Rake::Task['pact:test:fail'].execute
 		Rake::Task['pact:test:pactfile'].execute
 		Rake::Task['pact:verify:test_app:content_type'].execute
+		Rake::Task['pact:verify:test_app:intercept_request_headers'].execute
 		Rake::Task['pact:verify:case_insensitive_response_header_matching'].execute
 	end
 
@@ -111,4 +116,4 @@ namespace :pact do
 		end
 	end
 
-end
+end