pact-provider-verifier 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 841f89c7d8e4630a4e451fe78a7aa565e040bfd9
-  data.tar.gz: 5185190d6bb9316ea3187bd804f883f5efec301c
+  metadata.gz: 8b43ff3b5b20e388373c13ea48743bdd78a24e6d
+  data.tar.gz: 73378cfd5da336900a6bc5b4ccf231287eef90e8
 SHA512:
-  metadata.gz: 4270937089f9520069c711ca967b0a5dc2d9c936748db259da8af1edc2d8ccc5fb43c24a9833ad6e1d08f97fe694b869d18bcf32fcf6cd6aa4751b3df614fdbf
-  data.tar.gz: 2fd9ed5470c4fd58325d962232eb2b3e24c6a27e42ddcb69809a31da72712bd3311b6f99c806dd206bcf8ba828b9aad1187115fdfc811207d19031fb5f6af7c6
+  metadata.gz: 2200801d7a18443487d7954d6eb68df0a74751332377ffdbd046638e3358ec66270144eafff2cd7499c9b347380f7494711d43ffe17cba094c672d1ca5969333
+  data.tar.gz: 0e5995e8176546921343631e1d5b7dcec3f18236d279073038941432bb26269b04eecbda45ed1411ffd055d7ad737ecc63665286dff2889eb45aeb125ceb172e

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+<a name="1.3.0-1"></a>
+# v1.3.0 (2017-08-08)
+
+#### Features
+
+* **custom provider header**
+  * Allow a --custom-provider-header to be specified   ([e3ea6fa](/../../commit/e3ea6fa))
+
 <a name="1.2.0"></a>
 # 1.2.0 (2017-08-05)
 

data/lib/pact/provider_verifier/add_header_middlware.rb

@@ -0,0 +1,33 @@
+module Pact
+  module ProviderVerifier
+    class AddHeaderMiddlware
+
+      def initialize app, headers
+        @app = app
+        @headers = headers
+      end
+
+      def call env
+        @app.call(add_headers(env))
+      end
+
+      def add_headers env
+        new_env = env.dup
+        @headers.each_pair do | key, value |
+          header_name = "HTTP_#{key.upcase.gsub("-", "_")}"
+          warn_about_header_replacement key, new_env[header_name], value
+          new_env[header_name] = value
+        end
+        new_env
+      end
+
+      def warn_about_header_replacement header_name, existing_value, new_value
+        if existing_value.nil?
+          $stderr.puts "WARN: Adding header '#{header_name}: #{new_value}' to replayed request. This header did not exist in the pact, and hence this test cannot confirm that the request will work in real life."
+        else
+          $stdout.puts "INFO: Replacing header '#{header_name}: #{existing_value}' with '#{header_name}: #{new_value}'"
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider_verifier/app.rb

@@ -6,6 +6,7 @@ require 'pact/cli/run_pact_verification'
 require 'net/https'
 require 'faraday_middleware'
 require 'json'
+require 'pact/provider_verifier/add_header_middlware'
 
 module Pact
   module ProviderVerifier
@@ -33,16 +34,23 @@ module Pact
         proxy_pact_helper = File.expand_path(File.join(File.dirname(__FILE__), "pact_helper.rb"))
         ENV['PROVIDER_STATES_SETUP_URL'] = @options.provider_states_setup_url
         ENV['VERBOSE_LOGGING'] = @options.verbose if @options.verbose
+        ENV['CUSTOM_PROVIDER_HEADER'] = @options.custom_provider_header if @options.custom_provider_header
         provider_base_url = @options.provider_base_url
 
         provider_application_version = @options.provider_app_version
         publish_results  = @options.publish_verification_results
 
+        rack_reverse_proxy = Rack::ReverseProxy.new do
+          reverse_proxy '/', provider_base_url
+        end
+
+        if @options.custom_provider_header
+          rack_reverse_proxy = Pact::ProviderVerifier::AddHeaderMiddlware.new(rack_reverse_proxy, parse_header)
+        end
+
         Pact.service_provider "Running Provider Application" do
           app do
-            Rack::ReverseProxy.new do
-              reverse_proxy '/', provider_base_url
-            end
+            rack_reverse_proxy
           end
 
           if provider_application_version
@@ -74,6 +82,11 @@ module Pact
         exit exit_statuses.count{ | status | status != 0 }
       end
 
+      def parse_header
+        header_name, header_value = @options.custom_provider_header.split(":", 2).collect(&:strip)
+        {header_name => header_value}
+      end
+
       def print_deprecation_note
         if @options.provider_states_url
           $stderr.puts "The --provider-states-url option is deprecated and the URL endpoint can be removed from the application"

data/lib/pact/provider_verifier/cli.rb

@@ -14,6 +14,7 @@ module Pact
       method_option :broker_username, aliases: "-n", desc: "Pact Broker username", :required => false
       method_option :broker_password, aliases: "-p", desc: "Pact Broker password", :required => false
       method_option :verbose, aliases: "-v", desc: "Verbose output", :required => false
+      method_option :custom_provider_header, desc: "Header to add to provider state set up and pact requests. eg 'Authorization: Basic cGFjdDpwYWN0'", :required => false
       method_option :provider_states_url, aliases: "-s", desc: "DEPRECATED", :required => false
 
       def verify

data/lib/pact/provider_verifier/set_up_provider_state.rb

@@ -36,6 +36,7 @@ module Pact
         connection = Faraday.new(:url => provider_states_setup_url)
         connection.post do |req|
           req.headers["Content-Type"] = "application/json"
+          add_custom_provider_header req
           req.body = {consumer: consumer, state: provider_state, states: [provider_state] }.to_json
         end
       end
@@ -48,6 +49,24 @@ module Pact
         ENV['VERBOSE_LOGGING']
       end
 
+      def provider_header_set?
+        ENV.fetch('CUSTOM_PROVIDER_HEADER', '') != ''
+      end
+
+      def provider_header_name
+        ENV['CUSTOM_PROVIDER_HEADER'].split(":", 2)[0]
+      end
+
+      def provider_header_value
+        ENV['CUSTOM_PROVIDER_HEADER'].split(":", 2)[1]
+      end
+
+      def add_custom_provider_header request
+        if provider_header_set?
+          request[provider_header_name] = provider_header_value
+        end
+      end
+
       def check_for_error response
         if response.status >= 300
           raise SetUpProviderStateError.new("Error setting up provider state '#{provider_state}' for consumer '#{consumer}' at #{provider_states_setup_url}. response status=#{response.status} response body=#{response.body}")

data/lib/pact/provider_verifier/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module ProviderVerifier
-    VERSION = "1.2.0"
+    VERSION = "1.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact-provider-verifier
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Matt Fellows
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-05 00:00:00.000000000 Z
+date: 2017-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -190,6 +190,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: conventional-changelog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 description: |-
   A cross-platform Pact verification tool to validate API Providers.
                         Used in the pact-js-provider project to simplify development
@@ -206,6 +220,7 @@ files:
 - README.md
 - bin/pact-provider-verifier
 - lib/pact/provider_verifier.rb
+- lib/pact/provider_verifier/add_header_middlware.rb
 - lib/pact/provider_verifier/app.rb
 - lib/pact/provider_verifier/cli.rb
 - lib/pact/provider_verifier/pact_helper.rb