pact-provider-verifier 1.17.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9a81a012908b0e5c40d70fc383041979cbe9e788d70e50b7ff88125264897eb
-  data.tar.gz: 8b6017a1b1b8be59aaecfb3a9cbe672994747859c4e423c280cb57541b77c465
+  metadata.gz: 4816191834c42acad2eb1b2d1c23ad3080946f7d38304cccd2773aba2fc224c8
+  data.tar.gz: aa706e5dcf1069847773c7d547ee8d19d0f22020ccea133c77861052e33bf63c
 SHA512:
-  metadata.gz: 85855c162d8798e1e2d36b80c2ca773908b25135cc35115239f43987fd87aaa243732fce1a5ddb12d74b0ffbd54eab7b5cf0dbb918f67973733724aa532f437d
-  data.tar.gz: e14d6f338fe7d324642260e1aedbb3dd5a2d1d6e9c4093db433b7d80a66d7fe83530715bb458c17bb7111cc271ad951dd0ec51817cb7851fc6f82c56f5a14cb6
+  metadata.gz: 800639f786836a31e616b9455fdf2b046d244345a1ad0f81e0de416ad59238afebf794f8bc05bab11ad625dbe1b8e8da696b12d5ebeca307cd36c34fb0241e67
+  data.tar.gz: 2291ff8495f596a5bb15eded82328fabddf58065a6626881efbbe44c8de264ca35ba30628375410ce283bac88e38166b5485917946267090202885cf2e17183d

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+<a name="v1.18.0-1"></a>
+### v1.18.0-1 (2018-09-11)
+
+
+#### Features
+
+* **pending pacts**
+  * allow pending pacts to be feature toggled	 ([5e8e15f](/../../commit/5e8e15f))
+
+* allow custom rack middleware to be specified	 ([ef857d4](/../../commit/ef857d4))
+
+* **custom-middleware**
+  * allow custom middleware to be configured via the command line	 ([217136d](/../../commit/217136d))
+
+
 <a name="v1.17.0-1"></a>
 ### v1.17.0-1 (2018-09-06)
 

data/lib/pact/provider_verifier/aggregate_pact_configs.rb

@@ -43,8 +43,12 @@ module Pact
       end
 
       def net_pending_pact_uris
-        pending_pact_uris - non_pending_pact_uris
+        if ENV['PACT_INCLUDE_PENDING'] == 'true'
+          pending_pact_uris - non_pending_pact_uris
+        else
+          []
+        end
       end
     end
   end
-end
+end

data/lib/pact/provider_verifier/app.rb

@@ -1,4 +1,7 @@
 require 'pact/provider_verifier/add_header_middlware'
+require 'pact/provider_verifier/provider_states/add_provider_states_header'
+require 'pact/provider_verifier/provider_states/remove_provider_states_header_middleware'
+require 'pact/provider_verifier/custom_middleware'
 require 'pact/provider/rspec'
 require 'pact/message'
 require 'pact/cli/run_pact_verification'
@@ -53,15 +56,17 @@ module Pact
 
       def configure_service_provider
         # Have to declare these locally as the class scope gets lost within the block
-        rack_reverse_proxy = configure_reverse_proxy
-        rack_reverse_proxy = configure_custom_header_middleware(rack_reverse_proxy)
+        application = configure_reverse_proxy
+        application = configure_provider_states_header_removal_middleware(application)
+        application = configure_custom_middleware(application)
+        application = configure_custom_header_middleware(application)
 
         provider_application_version = options.provider_app_version
         publish_results  = options.publish_verification_results
 
         Pact.service_provider "Running Provider Application" do
           app do
-            rack_reverse_proxy
+            application
           end
 
           if provider_application_version
@@ -92,7 +97,39 @@ module Pact
         end
       end
 
-      def verify_pact config
+      def configure_custom_middleware app
+        if options.custom_middleware && options.custom_middleware.any?
+          require_custom_middlware
+          apply_custom_middleware(app)
+        else
+          app
+        end
+      end
+
+      def configure_provider_states_header_removal_middleware app
+        ProviderStates::RemoveProviderStatesHeaderMiddleware.new(app)
+      end
+
+      def require_custom_middlware
+        options.custom_middleware.each do |file|
+          $stdout.puts "DEBUG: Requiring custom middleware file #{file}" if options.verbose
+          begin
+            require file
+          rescue LoadError => e
+            $stderr.puts "ERROR: #{e.class} - #{e.message}. Please specify an absolute path."
+            exit(1)
+          end
+        end
+      end
+
+      def apply_custom_middleware app
+        CustomMiddleware.descendants.inject(app) do | app, clazz |
+          Pact.configuration.output_stream.puts "INFO: Adding custom middleware #{clazz}"
+          clazz.new(app)
+        end
+      end
+
+      def verify_pact(config)
         begin
           verify_options = {
             pact_helper: PROXY_PACT_HELPER,
@@ -102,7 +139,8 @@ module Pact
             pact_broker_password: options.broker_password,
             format: options.format,
             out: options.out,
-            ignore_failures: config.pending
+            ignore_failures: config.pending,
+            request_customizer: ProviderStates::AddProviderStatesHeader
           }
           verify_options[:description] = ENV['PACT_DESCRIPTION'] if ENV['PACT_DESCRIPTION']
           verify_options[:provider_state] = ENV['PACT_PROVIDER_STATE'] if ENV['PACT_PROVIDER_STATE']
@@ -161,3 +199,5 @@ module Pact
     end
   end
 end
+
+

data/lib/pact/provider_verifier/cli/verify.rb

@@ -17,10 +17,11 @@ module Pact
         method_option :broker_username, aliases: "-n", desc: "Pact Broker basic auth username", :required => false
         method_option :broker_password, aliases: "-p", desc: "Pact Broker basic auth password", :required => false
         method_option :provider, required: false
-        method_option :consumer_version_tag, type: :array, banner: "TAG", desc: "Retrieve the latest pacts with this consumer version tag. Used in conjuction with --provider. May be specified multiple times.", :required => false
+        method_option :consumer_version_tag, type: :array, banner: "TAG", desc: "Retrieve the latest pacts with this consumer version tag. Used in conjunction with --provider. May be specified multiple times.", :required => false
         method_option :provider_app_version, aliases: "-a", desc: "Provider application version, required when publishing verification results", :required => false
         method_option :publish_verification_results, aliases: "-r", desc: "Publish verification results to the broker", required: false
         method_option :custom_provider_header, type: :array, banner: 'CUSTOM_PROVIDER_HEADER', desc: "Header to add to provider state set up and pact verification requests. eg 'Authorization: Basic cGFjdDpwYWN0'. May be specified multiple times.", :required => false
+        method_option :custom_middleware, type: :array, banner: 'FILE', desc: "Ruby file containing a class implementing Pact::ProviderVerifier::CustomMiddleware. This allows the response to be modified before replaying. Use with caution!", :required => false
         method_option :monkeypatch, hide: true, type: :array, :required => false
         method_option :verbose, aliases: "-v", desc: "Verbose output", :required => false
         method_option :provider_states_url, aliases: "-s", :required => false, hide: true

data/lib/pact/provider_verifier/custom_middleware.rb

@@ -0,0 +1,33 @@
+require 'ostruct'
+
+module Pact
+  module ProviderVerifier
+    class CustomMiddleware
+      def self.descendants
+        descendants = []
+        ObjectSpace.each_object(singleton_class) do |k|
+          descendants.unshift k unless k == self
+        end
+        descendants
+      end
+
+      attr_accessor :app
+
+      def initialize app
+        @app = app
+      end
+
+      def call env
+        raise NotImplementedError
+      end
+
+      def provider_states_from(env)
+        if env["X_PACT_PROVIDER_STATES"]
+          env["X_PACT_PROVIDER_STATES"].collect{ | provider_state| OpenStruct.new(provider_state) }
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider_verifier/provider_states/add_provider_states_header.rb

@@ -0,0 +1,36 @@
+require 'delegate'
+
+module Pact
+  module ProviderVerifier
+    module ProviderStates
+      class RequestDelegate < SimpleDelegator
+        def initialize request, extra_rack_headers
+          super(request)
+          @extra_rack_headers = extra_rack_headers
+        end
+
+        def headers
+          __getobj__().headers.merge(@extra_rack_headers)
+        end
+
+        def method
+          __getobj__().method
+        end
+      end
+
+      class AddProviderStatesHeader
+
+        def self.call(request, interaction)
+          if interaction.provider_state
+            extra_rack_headers = {
+              "X_PACT_PROVIDER_STATES" => [{ "name" => interaction.provider_state }]
+            }
+            RequestDelegate.new(request, extra_rack_headers)
+          else
+            request
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider_verifier/provider_states/remove_provider_states_header_middleware.rb

@@ -0,0 +1,19 @@
+module Pact
+  module ProviderVerifier
+    module ProviderStates
+      class RemoveProviderStatesHeaderMiddleware
+        def initialize app
+          @app = app
+        end
+
+        def call env
+          @app.call(remove_header(env))
+        end
+
+        def remove_header env
+          env.reject { | key, value | key == "X_PACT_PROVIDER_STATES" }
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider_verifier/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module ProviderVerifier
-    VERSION = "1.17.0"
+    VERSION = "1.19.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact-provider-verifier
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Matt Fellows
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-05 00:00:00.000000000 Z
+date: 2018-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -31,20 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.33'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.33.2
+        version: '1.34'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.33'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.33.2
+        version: '1.34'
 - !ruby/object:Gem::Dependency
   name: pact-message
   requirement: !ruby/object:Gem::Requirement
@@ -309,7 +303,10 @@ files:
 - lib/pact/provider_verifier/app.rb
 - lib/pact/provider_verifier/cli/custom_thor.rb
 - lib/pact/provider_verifier/cli/verify.rb
+- lib/pact/provider_verifier/custom_middleware.rb
 - lib/pact/provider_verifier/pact_helper.rb
+- lib/pact/provider_verifier/provider_states/add_provider_states_header.rb
+- lib/pact/provider_verifier/provider_states/remove_provider_states_header_middleware.rb
 - lib/pact/provider_verifier/rspec_json_formatter_monkeypatch.rb
 - lib/pact/provider_verifier/set_up_provider_state.rb
 - lib/pact/provider_verifier/underscored_headers_monkeypatch.rb