pact-provider-verifier 1.14.0 → 1.14.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91e57d1d70bc73bb118c32c1751add6a86b5bed6a7473a1f127edab30729e329
-  data.tar.gz: 3507befee7fce08b019cc7dfbe834a871f4f3f66d4ccf7a21a9cb40f8815a7c6
+  metadata.gz: ee26873b6d4026f5e77d867508a23c823c580e60e34ed23b8aa7cb9f31a9f6f8
+  data.tar.gz: 29a26e0a4648253c240bff44855e013ee8e201fe04e9d2411e1711a2b2455455
 SHA512:
-  metadata.gz: 57878d218ad9d4cd506c88202e1404c5f012c99068e729c90d73b2c137ba8a7768638d2a2455f0d79b7f5251fd8f7c745f8e01a1eece8ab0bc97108bbba78d59
-  data.tar.gz: 73980447db71db302c20d04e56553f728c77a0782d2e6bdef48252bd84e6f1ba5940d03eb944f0a3dd82832afe3ab11e268db5add12bbd5af1a92dc7ab808f75
+  metadata.gz: 082de71a324d991ecf66957ae3b6d498acaf031cba0924bdf44aeaee525f6151ccc7b8e1debf6399a6a9f26a824ee0273bc34abaf608142772e16b32be6e3e21
+  data.tar.gz: 96a7dbceb37c46dac5b2fb2193addcd0fd91d64cfccac93c2278c9072077a918fed18d60c9f1fead3bdf490d89b128d80f32d983051977ddf84811e7d817354a

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+<a name="v1.14.1-1"></a>
+### v1.14.1-1 (2018-05-08)
+
+
+#### Bug Fixes
+
+* ensure headers with underscores are correctly replayed	 ([abb4b4a](/../../commit/abb4b4a))
+
+
 <a name="v1.14.0-1"></a>
 ### v1.14.0-1 (2018-04-16)
 

data/README.md

@@ -109,6 +109,8 @@ Rather than tearing down the specific test data created after each interaction,
 
 Note that the HTTP endpoint does not have to actually be within your application - it just has to have access to the same data store. So if you cannot add "test only" endpoints during your verification, consider making a separate app which shares credentials to your app's datastore. It is highly recommended that you run your verifications against a locally running provider, rather than a deployed one, as this will make it much easier to stub any downstream calls, debug issues, and it will make your tests run as fast as possible.
 
+Ignore the `states` array that you will see if you happen to print out the live provider state set up request body - that was an attempt to make the set up call forwards compatible with the v3 pact specification, which allows multiple provider states. Unfortunately, this forwards compatibilty attempt failed, because the v3 provider states support a map of params, not just a name, so it should have been `{ "state": { "name": "PROVIDER_STATE, "params": {...} } }`.
+
 ### Using the Pact Broker with Basic authentication
 
 The following flags are required to use basic authentication with a Pact Broker:

data/lib/pact/provider_verifier/app.rb

@@ -80,7 +80,7 @@ module Pact
             preserve_host: true,
             x_forwarded_headers: false
           )
-          reverse_proxy /(.*)/, "#{provider_base_url}$1"
+          reverse_proxy %r{(.*)}, "#{provider_base_url}$1"
         end
       end
 

data/lib/pact/provider_verifier/pact_helper.rb

@@ -4,6 +4,7 @@ require 'json'
 require_relative './app'
 require_relative 'set_up_provider_state'
 require 'pact/provider/configuration'
+require 'pact/provider_verifier/underscored_headers_monkeypatch.rb'
 
 # Responsible for making the call to the provider state server to set up the state
 

data/lib/pact/provider_verifier/underscored_headers_monkeypatch.rb

@@ -0,0 +1,96 @@
+# Ok, this doesn't make me feel good about myself, but it's the best way I've found
+# to ensure that any underscored headers (eg "access_token") are not turned into dasherized
+# headers by the Rack code that converts capitalized, dasherized headers into uppercase,
+# underscored headers, and then back again.
+# eg. access_token => HTTP_ACCESS_TOKEN => ACCESS-TOKEN
+# To ensure the original header format is kept, an extra header, HTTP_X_PACT_ORIGINAL_HEADER_NAMES
+# is added to the Rack Request when it is created from the request in the pact file, which contains
+# a comma separated list of the original header names.
+# This header is then removed by the modified Rack Reverse Proxy code, and used to restore
+# the original header names if they have been transformed "incorrectly".
+require 'pact/configuration'
+
+def rack_reverse_proxy_headers_method_found
+  begin
+    RackReverseProxy::RoundTrip.instance_method(:headers)
+    true
+  rescue NameError
+    Pact.configuration.error_stream.puts "WARN: Could not find the RackReverseProxy::RoundTrip#headers method. The implementation must have changed. Cannot monkey patch the aforementioned method to ensure any underscores are retained in header names. You can ignore this warning if you use normal dasherized headers."
+    false
+  end
+end
+
+def pact_provider_request_headers_method_found
+  begin
+    Pact::Provider::Request::Replayable.instance_method(:headers)
+    true
+  rescue NameError
+    Pact.configuration.error_stream.puts "WARN: Could not find the Pact::Provider::Request::Replayable#headers method. The implementation must have changed. Cannot monkey patch the aforementioned method to ensure any underscores are retained in header names. You can ignore this warning if you use normal dasherized headers."
+    false
+  end
+end
+
+module Pact
+  module ProviderVerifier
+    module UnderscoredHeadersMonkeyPatch
+      extend self
+
+      def save_original_header_names rack_headers, expected_request_headers
+        # expected_request_headers may be a Pact::NullExpectation
+        if rack_headers.any?
+          rack_headers['HTTP_X_PACT_ORIGINAL_HEADER_NAMES'] = expected_request_headers.keys.join(",")
+        end
+        rack_headers
+      end
+
+      def restore_original_header_names dasherized_headers
+        original_header_names_value = dasherized_headers.delete("X-PACT-ORIGINAL-HEADER-NAMES")
+        if original_header_names_value && original_header_names_value.size > 0
+          replace_header_names(dasherized_headers, original_header_names_value.split(","))
+        else
+          dasherized_headers
+        end
+      end
+
+      private
+
+      def replace_header_names dasherized_headers, original_header_names
+        original_header_names.each_with_object(dasherized_headers) do | original_header_name, headers |
+          if headers.key?(pact_uppercase_and_dasherize(original_header_name))
+            headers[original_header_name] = headers.delete(pact_uppercase_and_dasherize(original_header_name))
+          end
+        end
+      end
+
+      def pact_uppercase_and_dasherize header_name
+        header_name.upcase.split("_").join("-")
+      end
+    end
+  end
+end
+
+if pact_provider_request_headers_method_found && rack_reverse_proxy_headers_method_found
+  module Pact
+    module Provider
+      module Request
+        class Replayable
+          alias_method :pact_old_headers, :headers
+
+          def headers
+            Pact::ProviderVerifier::UnderscoredHeadersMonkeyPatch.save_original_header_names(pact_old_headers, expected_request.headers)
+          end
+        end
+      end
+    end
+  end
+
+  module RackReverseProxy
+    class RoundTrip
+      alias_method :pact_old_headers, :headers
+
+      def headers
+        Pact::ProviderVerifier::UnderscoredHeadersMonkeyPatch.restore_original_header_names(pact_old_headers)
+      end
+    end
+  end
+end

data/lib/pact/provider_verifier/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module ProviderVerifier
-    VERSION = "1.14.0"
+    VERSION = "1.14.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact-provider-verifier
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.14.3
 platform: ruby
 authors:
 - Matt Fellows
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-15 00:00:00.000000000 Z
+date: 2018-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -302,6 +302,7 @@ files:
 - lib/pact/provider_verifier/cli/verify.rb
 - lib/pact/provider_verifier/pact_helper.rb
 - lib/pact/provider_verifier/set_up_provider_state.rb
+- lib/pact/provider_verifier/underscored_headers_monkeypatch.rb
 - lib/pact/provider_verifier/version.rb
 homepage: https://github.com/pact-foundation/pact-provider-verifier
 licenses: