pact 1.28.0 → 1.53.0

data/lib/pact/provider/rspec/pact_broker_formatter.rb

@@ -8,23 +8,14 @@ module Pact
     module RSpec
       class PactBrokerFormatter < ::RSpec::Core::Formatters::BaseFormatter
         Pact::RSpec.with_rspec_3 do
-          ::RSpec::Core::Formatters.register self, :message, :dump_summary, :stop, :seed, :close
+          ::RSpec::Core::Formatters.register self, :stop, :close
         end
 
         attr_reader :output_hash
 
         def initialize(output)
           super
-          @output_hash = {
-            :version => ::RSpec::Core::Version::STRING
-          }
-        end
-
-        def message(notification)
-          (@output_hash[:messages] ||= []) << notification.message
-        end
-
-        def dump_summary(summary)
+          @output_hash = {}
         end
 
         def stop(notification)
@@ -33,11 +24,6 @@ module Pact
                                   .map { |example| format_example(example) }
         end
 
-        def seed(notification)
-          return unless notification.seed_used?
-          @output_hash[:seed] = notification.seed
-        end
-
         def close(_notification)
           Pact::Provider::VerificationResults::PublishAll.call(Pact.provider_world.pact_sources, output_hash)
         end
@@ -73,10 +59,14 @@ module Pact
               hash[:actualBody] = example.metadata[:pact_actual_body]
             end
 
+            if example.metadata[:pact_actual_contents]
+              hash[:actualContents] = example.metadata[:pact_actual_contents]
+            end
+
             if example.metadata[:pact_diff]
               hash[:differences] = Pact::Matchers::ExtractDiffMessages.call(example.metadata[:pact_diff])
                                     .to_a
-                                    .collect{ | description | {description: description} }
+                                    .collect{ | description | { description: description } }
             end
           end
         end

data/lib/pact/provider/rspec.rb

@@ -17,15 +17,24 @@ module Pact
       end
 
       module ClassMethods
+        EMPTY_ARRAY = [].freeze
 
         include ::RSpec::Core::DSL
 
-        def honour_pactfile pact_uri, pact_json, options
+        def honour_pactfile pact_source, pact_json, options
+          pact_uri = pact_source.uri
           Pact.configuration.output_stream.puts "INFO: Reading pact at #{pact_uri}"
-          Pact.configuration.output_stream.puts "INFO: Filtering interactions by: #{options[:criteria]}" if options[:criteria] && options[:criteria].any?
+          if pact_uri.metadata[:notices]
+            pact_uri.metadata[:notices].before_verification_notices_text.each do | text |
+              Pact.configuration.output_stream.puts("DEBUG: #{text}")
+            end
+          end
+
+          Pact.configuration.output_stream.puts "DEBUG: Filtering interactions by: #{options[:criteria]}" if options[:criteria] && options[:criteria].any?
           consumer_contract = Pact::ConsumerContract.from_json(pact_json)
-          ::RSpec.describe "Verifying a pact between #{consumer_contract.consumer.name} and #{consumer_contract.provider.name}", pactfile_uri: pact_uri do
-            honour_consumer_contract consumer_contract, options.merge(pact_json: pact_json, pact_uri: pact_uri)
+          suffix = pact_uri.metadata[:pending] ? " [PENDING]": ""
+          ::RSpec.describe "Verifying a pact between #{consumer_contract.consumer.name} and #{consumer_contract.provider.name}#{suffix}", pactfile_uri: pact_uri do
+            honour_consumer_contract consumer_contract, options.merge(pact_json: pact_json, pact_uri: pact_uri, pact_source: pact_source, consumer_contract: consumer_contract)
           end
         end
 
@@ -72,7 +81,10 @@ module Pact
             pact: :verify,
             pact_interaction: interaction,
             pact_interaction_example_description: interaction_description_for_rerun_command(interaction),
-            pact_uri: options[:pact_uri]
+            pact_uri: options[:pact_uri],
+            pact_source: options[:pact_source],
+            pact_ignore_failures: options[:pact_uri].metadata[:pending] || options[:ignore_failures],
+            pact_consumer_contract: options[:consumer_contract]
           }
 
           describe description_for(interaction), metadata do
@@ -82,15 +94,15 @@ module Pact
             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]
-                replay_interaction interaction
+                set_up_provider_states interaction.provider_states, options[:consumer]
+                replay_interaction interaction, options[:request_customizer]
                 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_states interaction.provider_states, options[:consumer]
               end
             end
 
@@ -108,20 +120,21 @@ module Pact
           include Pact::RSpec::Matchers
           extend Pact::Matchers::Messages
 
-          let(:expected_content) { expected_response.body[:contents].as_json }
+          let(:expected_contents) { expected_response.body[:contents].as_json }
           let(:response) { interaction_context.last_response }
           let(:differ) { Pact.configuration.body_differ_for_content_type diff_content_type }
           let(:diff_formatter) { Pact.configuration.diff_formatter_for_content_type diff_content_type }
           let(:diff_options) { { with: differ, diff_formatter: diff_formatter } }
           let(:diff_content_type) { 'application/json' }
           let(:response_body) { parse_body_from_response(response) }
-          let(:actual_content) { response_body['contents'] }
+          let(:actual_contents) { response_body['contents'] }
 
           it "has matching content" do | example |
             if response.status != 200
               raise "An error was raised while verifying the message. The response body is: #{response.body}"
             end
-            expect(actual_content).to match_term expected_content, diff_options, example
+            set_metadata(example, :pact_actual_contents, actual_contents)
+            expect(actual_contents).to match_term expected_contents, diff_options, example
           end
         end
 

data/lib/pact/provider/state/provider_state.rb

@@ -116,17 +116,17 @@ module Pact
         @no_op_defined = true
       end
 
-      def set_up
+      def set_up params = {}
         if @set_up_block
           include_provider_state_configured_modules
-          instance_eval &@set_up_block
+          instance_exec params, &@set_up_block
         end
       end
 
-      def tear_down
+      def tear_down params = {}
         if @tear_down_block
           include_provider_state_configured_modules
-          instance_eval &@tear_down_block
+          instance_exec params, &@tear_down_block
         end
       end
 
@@ -168,14 +168,13 @@ module Pact
 
     class NoOpProviderState
 
-      def self.set_up
+      def self.set_up params = {}
 
       end
 
-      def self.tear_down
+      def self.tear_down params = {}
 
       end
-
     end
   end
 end

data/lib/pact/provider/state/provider_state_manager.rb

@@ -2,27 +2,28 @@ module Pact
   module Provider::State
     class ProviderStateManager
 
-      attr_reader :provider_state_name, :consumer
+      attr_reader :provider_state_name, :params, :consumer
 
-      def initialize provider_state_name, consumer
+      def initialize provider_state_name, params, consumer
         @provider_state_name = provider_state_name
+        @params = params
         @consumer = consumer
       end
 
       def set_up_provider_state
-        get_global_base_provider_state.set_up
-        get_consumer_base_provider_state.set_up
+        get_global_base_provider_state.set_up(params)
+        get_consumer_base_provider_state.set_up(params)
         if provider_state_name
-          get_provider_state.set_up
+          get_provider_state.set_up(params)
         end
       end
 
       def tear_down_provider_state
         if provider_state_name
-          get_provider_state.tear_down
+          get_provider_state.tear_down(params)
         end
-        get_consumer_base_provider_state.tear_down
-        get_global_base_provider_state.tear_down
+        get_consumer_base_provider_state.tear_down(params)
+        get_global_base_provider_state.tear_down(params)
       end
 
       def get_provider_state
@@ -36,7 +37,6 @@ module Pact
       def get_global_base_provider_state
         Pact.provider_world.provider_states.get_base
       end
-
     end
   end
-end
+end

data/lib/pact/provider/state/set_up.rb

@@ -5,7 +5,7 @@ module Pact
     module State
       class SetUp
         def self.call provider_state_name, consumer, options = {}
-          State::ProviderStateManager.new(provider_state_name, consumer).set_up_provider_state
+          State::ProviderStateManager.new(provider_state_name, options[:params], consumer).set_up_provider_state
         end
       end
     end

data/lib/pact/provider/state/tear_down.rb

@@ -5,7 +5,7 @@ module Pact
     module State
       class TearDown
         def self.call provider_state_name, consumer, options = {}
-          State::ProviderStateManager.new(provider_state_name, consumer).tear_down_provider_state
+          State::ProviderStateManager.new(provider_state_name, options[:params], consumer).tear_down_provider_state
         end
       end
     end

data/lib/pact/provider/test_methods.rb

@@ -14,13 +14,18 @@ module Pact
       include Pact::Logging
       include Rack::Test::Methods
 
-      def replay_interaction interaction
+      def replay_interaction interaction, request_customizer = nil
         request = Request::Replayable.new(interaction.request)
+        request = request_customizer.call(request, interaction) if request_customizer
         args = [request.path, request.body, request.headers]
 
         logger.info "Sending #{request.method.upcase} request to path: \"#{request.path}\" with headers: #{request.headers}, see debug logs for body"
         logger.debug "body :#{request.body}"
-        response = self.send(request.method.downcase, *args)
+        response = if self.respond_to?(:custom_request)
+          self.custom_request(request.method.upcase, *args)
+        else
+          self.send(request.method.downcase, *args)
+        end
         logger.info "Received response with status: #{response.status}, headers: #{response.headers}, see debug logs for body"
         logger.debug "body: #{response.body}"
       end
@@ -28,18 +33,28 @@ module Pact
       def parse_body_from_response rack_response
         case rack_response.headers['Content-Type']
         when /json/
-          JSON.load(rack_response.body)
+          # For https://github.com/pact-foundation/pact-net/issues/237
+          # Only required for the pact-ruby-standalone ¯\_(ツ)_/¯
+          JSON.load("[#{rack_response.body}]").first
         else
           rack_response.body
         end
       end
 
-      def set_up_provider_state provider_state_name, consumer, options = {}
-        Pact.configuration.provider_state_set_up.call(provider_state_name, consumer, options)
+      def set_up_provider_states provider_states, consumer, options = {}
+        # If there are no provider state, execute with an nil state to ensure global and base states are executed
+        Pact.configuration.provider_state_set_up.call(nil, consumer, options) if provider_states.nil? || provider_states.empty?
+        provider_states.each do | provider_state |
+          Pact.configuration.provider_state_set_up.call(provider_state.name, consumer, options.merge(params: provider_state.params))
+        end
       end
 
-      def tear_down_provider_state provider_state_name, consumer, options = {}
-        Pact.configuration.provider_state_tear_down.call(provider_state_name, consumer, options)
+      def tear_down_provider_states provider_states, consumer, options = {}
+        # If there are no provider state, execute with an nil state to ensure global and base states are executed
+        Pact.configuration.provider_state_tear_down.call(nil, consumer, options) if provider_states.nil? || provider_states.empty?
+        provider_states.reverse_each do | provider_state |
+          Pact.configuration.provider_state_tear_down.call(provider_state.name, consumer, options.merge(params: provider_state.params))
+        end
       end
 
       def set_metadata example, key, value

data/lib/pact/provider/verification_results/create.rb

@@ -57,6 +57,12 @@ module Pact
             summary: {
               testCount: examples_for_pact_uri.size,
               failureCount: count_failures_for_pact_uri
+            },
+            metadata: {
+              warning: "These test results use a beta format. Do not rely on it, as it will definitely change.",
+              pactVerificationResultsSpecification: {
+                version: "1.0.0-beta.1"
+              }
             }
           }
         end

data/lib/pact/provider/verification_results/publish.rb

@@ -24,21 +24,18 @@ module Pact
         def initialize pact_source, verification_result
           @pact_source = pact_source
           @verification_result = verification_result
-
-          http_client_options = {}
-          if pact_source.uri.basic_auth?
-            http_client_options[:username] = pact_source.uri.username
-            http_client_options[:password] = pact_source.uri.password
-          end
-
+          http_client_options = pact_source.uri.options.reject{ |k, v| ![:username, :password, :token].include?(k) }
           @http_client = Pact::Hal::HttpClient.new(http_client_options)
-          @pact_entity = Pact::Hal::Entity.new(pact_source.pact_hash, http_client)
+          @pact_entity = Pact::Hal::Entity.new(pact_source.uri, pact_source.pact_hash, http_client)
         end
 
         def call
           if can_publish_verification_results?
             tag_versions_if_configured
             publish_verification_results
+            true
+          else
+            false
           end
         end
 

data/lib/pact/provider/verification_results/publish_all.rb

@@ -17,7 +17,12 @@ module Pact
 
         def call
           verification_results.collect do | (pact_source, verification_result) |
-            Publish.call(pact_source, verification_result)
+            published = false
+            begin
+              published = Publish.call(pact_source, verification_result)
+            ensure
+              print_after_verification_notices(pact_source, verification_result, published)
+            end
           end
         end
 
@@ -29,6 +34,14 @@ module Pact
           end
         end
 
+        def print_after_verification_notices(pact_source, verification_result, published)
+          if pact_source.uri.metadata[:notices]
+            pact_source.uri.metadata[:notices].after_verification_notices_text(verification_result.success, published).each do | text |
+              Pact.configuration.output_stream.puts "DEBUG: #{text}"
+            end
+          end
+        end
+
         attr_reader :pact_sources, :test_results_hash
       end
     end

data/lib/pact/provider/verification_results/verification_result.rb

@@ -4,6 +4,7 @@ module Pact
   module Provider
     module VerificationResults
       class VerificationResult
+        attr_reader :success, :provider_application_version, :test_results_hash
 
         def initialize publishable, success, provider_application_version, test_results_hash
           @publishable = publishable
@@ -24,17 +25,13 @@ module Pact
           {
             success: success,
             providerApplicationVersion: provider_application_version,
-            #testResults: test_results_hash # not yet
+            testResults: test_results_hash
           }.to_json(options)
         end
 
         def to_s
           "[success: #{success}, providerApplicationVersion: #{provider_application_version}]"
         end
-
-        private
-
-        attr_reader :success, :provider_application_version, :test_results_hash
       end
     end
   end

data/lib/pact/provider/world.rb

@@ -43,7 +43,7 @@ module Pact
       end
 
       def pact_uris_from_pact_uri_sources
-        pact_uri_sources.collect{| pact_uri_source| pact_uri_source.call }.flatten
+        pact_uri_sources.collect(&:call).flatten
       end
     end
   end

data/lib/pact/retry.rb

@@ -1,3 +1,5 @@
+require 'pact/errors'
+
 module Pact
   class Retry
     class RescuableError

data/lib/pact/tasks/task_helper.rb

@@ -7,11 +7,12 @@ module Pact
   module TaskHelper
 
     PACT_INTERACTION_RERUN_COMMAND = "bundle exec rake pact:verify:at[<PACT_URI>] PACT_DESCRIPTION=\"<PACT_DESCRIPTION>\" PACT_PROVIDER_STATE=\"<PACT_PROVIDER_STATE>\""
+    PACT_INTERACTION_RERUN_COMMAND_FOR_BROKER = "bundle exec rake pact:verify:at[<PACT_URI>] PACT_BROKER_INTERACTION_ID=\"<PACT_BROKER_INTERACTION_ID>\""
 
     extend self
 
-    def execute_pact_verify pact_uri = nil, pact_helper = nil, rspec_opts = nil
-      execute_cmd verify_command(pact_helper || Pact::Provider::PactHelperLocater.pact_helper_path, pact_uri, rspec_opts)
+    def execute_pact_verify pact_uri = nil, pact_helper = nil, rspec_opts = nil, verification_opts = {}
+      execute_cmd verify_command(pact_helper || Pact::Provider::PactHelperLocater.pact_helper_path, pact_uri, rspec_opts, verification_opts)
     end
 
     def handle_verification_failure
@@ -19,7 +20,7 @@ module Pact
       abort if exit_status != 0
     end
 
-    def verify_command pact_helper, pact_uri, rspec_opts
+    def verify_command pact_helper, pact_uri, rspec_opts, verification_opts
       command_parts = []
       # Clear SPEC_OPTS, otherwise we can get extra formatters, creating duplicate output eg. CI Reporting.
       # Allow deliberate configuration using rspec_opts in VerificationTask.
@@ -28,11 +29,14 @@ module Pact
       command_parts << "-S pact verify"
       command_parts << "--pact-helper" << Shellwords.escape(pact_helper.end_with?(".rb") ? pact_helper : pact_helper + ".rb")
       (command_parts << "--pact-uri" << pact_uri) if pact_uri
+      command_parts << "--ignore-failures" if verification_opts[:ignore_failures]
       command_parts << "--pact-broker-username" << ENV['PACT_BROKER_USERNAME'] if ENV['PACT_BROKER_USERNAME']
       command_parts << "--pact-broker-password" << ENV['PACT_BROKER_PASSWORD'] if ENV['PACT_BROKER_PASSWORD']
       command_parts << "--backtrace" if ENV['BACKTRACE'] == 'true'
       command_parts << "--description #{Shellwords.escape(ENV['PACT_DESCRIPTION'])}" if ENV['PACT_DESCRIPTION']
       command_parts << "--provider-state #{Shellwords.escape(ENV['PACT_PROVIDER_STATE'])}" if ENV['PACT_PROVIDER_STATE']
+      command_parts << "--pact-broker-interaction-id #{Shellwords.escape(ENV['PACT_BROKER_INTERACTION_ID'])}" if ENV['PACT_BROKER_INTERACTION_ID']
+      command_parts << "--interaction-index #{Shellwords.escape(ENV['PACT_INTERACTION_INDEX'])}" if ENV['PACT_INTERACTION_INDEX']
       command_parts.flatten.join(" ")
     end
 
@@ -40,7 +44,9 @@ module Pact
       Pact.configuration.output_stream.puts command
       temporarily_set_env_var 'PACT_EXECUTING_LANGUAGE', 'ruby' do
         temporarily_set_env_var 'PACT_INTERACTION_RERUN_COMMAND', PACT_INTERACTION_RERUN_COMMAND do
-          exit_status = system(command) ? 0 : 1
+          temporarily_set_env_var 'PACT_INTERACTION_RERUN_COMMAND_FOR_BROKER', PACT_INTERACTION_RERUN_COMMAND_FOR_BROKER do
+            exit_status = system(command) ? 0 : 1
+          end
         end
       end
     end

data/lib/pact/tasks/verification_task.rb

@@ -30,9 +30,11 @@ module Pact
 
     attr_reader :pact_spec_configs
     attr_accessor :rspec_opts
+    attr_accessor :ignore_failures
 
     def initialize(name)
       @rspec_opts = nil
+      @ignore_failures = false
       @pact_spec_configs = []
       @name = name
       yield self
@@ -74,7 +76,7 @@ module Pact
           require 'pact/tasks/task_helper'
 
           exit_statuses = pact_spec_configs.collect do | config |
-            Pact::TaskHelper.execute_pact_verify config[:uri], config[:pact_helper], rspec_opts
+            Pact::TaskHelper.execute_pact_verify config[:uri], config[:pact_helper], rspec_opts, { ignore_failures: ignore_failures }
           end
 
           Pact::TaskHelper.handle_verification_failure do

data/lib/pact/version.rb

@@ -1,4 +1,4 @@
 # Remember to bump pact-provider-proxy when this changes major version
 module Pact
-  VERSION = "1.28.0"
+  VERSION = "1.53.0"
 end

data/pact.gemspec

@@ -1,5 +1,4 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'pact/version'
 
@@ -15,30 +14,35 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 2.0'
 
   gem.files         = `git ls-files bin lib pact.gemspec CHANGELOG.md LICENSE.txt`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
   gem.license       = 'MIT'
 
-  gem.add_runtime_dependency 'randexp', '~> 0.1.7'
-  gem.add_runtime_dependency 'rspec', '>=2.14'
-  gem.add_runtime_dependency 'rack-test', '~> 0.6', '>= 0.6.3'
-  gem.add_runtime_dependency 'thor'
-  gem.add_runtime_dependency 'json','> 1.8.5'
-  gem.add_runtime_dependency 'webrick'
+  gem.metadata = {
+    'changelog_uri'     => 'https://github.com/pact-foundation/pact-ruby/blob/master/CHANGELOG.md',
+    'source_code_uri'   => 'https://github.com/pact-foundation/pact-ruby',
+    'bug_tracker_uri'   => 'https://github.com/pact-foundation/pact-ruby/issues',
+    'documentation_uri' => 'https://github.com/pact-foundation/pact-ruby/blob/master/README.md'
+  }
+
+  gem.add_runtime_dependency 'rspec', '~> 3.0'
+  gem.add_runtime_dependency 'rack-test', '>= 0.6.3', '< 2.0.0'
+  gem.add_runtime_dependency 'thor', '>= 0.20', '< 2.0'
+  gem.add_runtime_dependency 'webrick', '~> 1.3'
   gem.add_runtime_dependency 'term-ansicolor', '~> 1.0'
 
-  gem.add_runtime_dependency 'pact-support', '~> 1.4'
-  gem.add_runtime_dependency 'pact-mock_service', '~> 2.0'
+  gem.add_runtime_dependency 'pact-support', '~> 1.9'
+  gem.add_runtime_dependency 'pact-mock_service', '~> 3.0', '>= 3.3.1'
 
-  gem.add_development_dependency 'rake', '~> 10.0.3'
+  gem.add_development_dependency 'rake', '~> 13.0'
   gem.add_development_dependency 'webmock', '~> 3.0'
-  gem.add_development_dependency 'pry-byebug'
   gem.add_development_dependency 'fakefs', '0.5' # 0.6.0 blows up
   gem.add_development_dependency 'hashie', '~> 2.0'
-  gem.add_development_dependency 'activesupport'
+  gem.add_development_dependency 'activesupport', '~> 5.2'
   gem.add_development_dependency 'faraday', '~> 0.13'
-  gem.add_development_dependency 'appraisal', '~> 2.2'
   gem.add_development_dependency 'conventional-changelog', '~> 1.3'
   gem.add_development_dependency 'bump', '~> 0.5'
+  gem.add_development_dependency 'pact-message', '~> 0.6'
+  gem.add_development_dependency 'rspec-its', '~> 1.3'
 end