pact 1.41.2 → 1.54.0

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

@@ -6,13 +6,13 @@ require 'pact/provider/help/prompt_text'
 module Pact
   module Provider
     module RSpec
-
       class Formatter < ::RSpec::Core::Formatters::DocumentationFormatter
 
         class NilFormatter < ::RSpec::Core::Formatters::BaseFormatter
           Pact::RSpec.with_rspec_3 do
             ::RSpec::Core::Formatters.register self, :start, :example_group_started, :close
           end
+
           def dump_summary(summary)
           end
         end
@@ -93,17 +93,32 @@ module Pact
 
         def interaction_rerun_command_for example
           example_description = example.metadata[:pact_interaction_example_description]
-          if ENV['PACT_INTERACTION_RERUN_COMMAND']
+
+          _id = example.metadata[:pact_interaction]._id
+          index = example.metadata[:pact_interaction].index
+          provider_state = example.metadata[:pact_interaction].provider_state
+          description = example.metadata[:pact_interaction].description
+          pactfile_uri = example.metadata[:pactfile_uri]
+
+          if _id && ENV['PACT_INTERACTION_RERUN_COMMAND_FOR_BROKER']
+            cmd = String.new(ENV['PACT_INTERACTION_RERUN_COMMAND_FOR_BROKER'])
+            cmd.gsub!("<PACT_URI>", example.metadata[:pactfile_uri].to_s)
+            cmd.gsub!("<PACT_BROKER_INTERACTION_ID>", "#{_id}")
+            colorizer.wrap("#{cmd} ", ::RSpec.configuration.failure_color) + colorizer.wrap("# #{example_description}", ::RSpec.configuration.detail_color)
+          elsif ENV['PACT_INTERACTION_RERUN_COMMAND']
             cmd = String.new(ENV['PACT_INTERACTION_RERUN_COMMAND'])
-            provider_state = example.metadata[:pact_interaction].provider_state
-            description = example.metadata[:pact_interaction].description
-            pactfile_uri = example.metadata[:pactfile_uri]
             cmd.gsub!("<PACT_URI>", pactfile_uri.to_s)
             cmd.gsub!("<PACT_DESCRIPTION>", description)
             cmd.gsub!("<PACT_PROVIDER_STATE>", "#{provider_state}")
+            cmd.gsub!("<PACT_INTERACTION_INDEX>", "#{index}")
             colorizer.wrap("#{cmd} ", ::RSpec.configuration.failure_color) + colorizer.wrap("# #{example_description}", ::RSpec.configuration.detail_color)
           else
-            colorizer.wrap("* #{example_description}", ::RSpec.configuration.failure_color)
+            message = if _id
+              "* #{example_description} (to re-run just this interaction, set environment variable PACT_BROKER_INTERACTION_ID=\"#{_id}\")"
+            else
+              "* #{example_description} (to re-run just this interaction, set environment variables PACT_DESCRIPTION=\"#{description}\" PACT_PROVIDER_STATE=\"#{provider_state}\")"
+            end
+            colorizer.wrap(message, ::RSpec.configuration.failure_color)
           end
         end
 

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

@@ -0,0 +1,100 @@
+require 'rspec/core/formatters/json_formatter'
+
+module Pact
+  module Provider
+    module RSpec
+      class JsonFormatter < ::RSpec::Core::Formatters::JsonFormatter
+        ::RSpec::Core::Formatters.register self, :message, :dump_summary, :dump_profile, :stop, :seed, :close
+
+        def dump_summary(summary)
+          super(create_custom_summary(summary))
+          output_hash[:summary][:pacts] = pacts(summary)
+        end
+
+        def format_example(example)
+          {
+            :id => example.id,
+            :interaction_index => example.metadata[:pact_interaction].index,
+            :description => example.description,
+            :full_description => example.full_description,
+            :status => calculate_status(example),
+            :file_path => example.metadata[:file_path],
+            :line_number  => example.metadata[:line_number],
+            :run_time => example.execution_result.run_time,
+            :mismatches => extract_differences(example),
+            :pact_url => example.metadata[:pact_uri].uri
+          }
+        end
+
+        def stop(notification)
+          output_hash[:examples] = notification.examples.map do |example|
+            format_example(example).tap do |hash|
+              e = example.exception
+              if e
+                hash[:exception] =  {
+                  class: e.class.name,
+                  message: e.message,
+                }
+                # No point providing a backtrace for a mismatch, too much noise
+                if !e.is_a?(::RSpec::Expectations::ExpectationNotMetError)
+                  hash[:exception][:backtrace]
+                end
+              end
+            end
+          end
+        end
+
+        def calculate_status(example)
+          if example.execution_result.status == :failed && example.metadata[:pact_ignore_failures]
+            'pending'
+          else
+            example.execution_result.status.to_s
+          end
+        end
+
+        # There will most likely be only one pact associated with this RSpec execution, because
+        # the most likely user of this formatter is the Go implementation that parses the JSON
+        # and builds Go tests from them.
+        # If the JSON formatter is used by someone else and they have multiple pacts, all the notices
+        # for the pacts will be mushed together in one collection, so it will be hard to know which notice
+        # belongs to which pact.
+        def pacts(summary)
+          unique_pact_metadatas(summary).collect do | example_metadata |
+            pact_uri = example_metadata[:pact_uri]
+            notices = (pact_uri.metadata[:notices] && pact_uri.metadata[:notices].before_verification_notices) || []
+            {
+              notices: notices,
+              url: pact_uri.uri,
+              consumer_name: example_metadata[:pact_consumer_contract].consumer.name,
+              provider_name: example_metadata[:pact_consumer_contract].provider.name,
+              short_description: pact_uri.metadata[:short_description]
+            }
+          end
+        end
+
+        def unique_pact_metadatas(summary)
+          summary.examples.collect(&:metadata).group_by{ | metadata | metadata[:pact_uri].uri }.values.collect(&:first)
+        end
+
+        def create_custom_summary(summary)
+          ::RSpec::Core::Notifications::SummaryNotification.new(
+            summary.duration,
+            summary.examples,
+            summary.examples.select{ | example | example.execution_result.status == :failed && !example.metadata[:pact_ignore_failures] },
+            summary.examples.select{ | example | example.execution_result.status == :failed && example.metadata[:pact_ignore_failures] },
+            summary.load_time,
+            summary.errors_outside_of_examples_count
+          )
+        end
+
+        def extract_differences(example)
+          if example.metadata[:pact_diff]
+            Pact::Matchers::ExtractDiffMessages.call(example.metadata[:pact_diff]).to_a
+          else
+            []
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -66,7 +66,7 @@ module Pact
             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,16 +17,24 @@ module Pact
       end
 
       module ClassMethods
+        EMPTY_ARRAY = [].freeze
 
         include ::RSpec::Core::DSL
 
-        def honour_pactfile pact_uri, pact_json, options
-          pact_description = options[:ignore_failures] ? "Pending pact" : "pact"
-          Pact.configuration.output_stream.puts "INFO: Reading #{pact_description} at #{pact_uri}"
-          Pact.configuration.output_stream.puts "INFO: Filtering interactions by: #{options[:criteria]}" if options[:criteria] && options[:criteria].any?
+        def honour_pactfile pact_source, pact_json, options
+          pact_uri = pact_source.uri
+          Pact.configuration.output_stream.puts "INFO: Reading pact at #{pact_uri}"
+          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_description} 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
 
@@ -74,7 +82,9 @@ module Pact
             pact_interaction: interaction,
             pact_interaction_example_description: interaction_description_for_rerun_command(interaction),
             pact_uri: options[:pact_uri],
-            pact_ignore_failures: options[:ignore_failures]
+            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

data/lib/pact/provider/test_methods.rb

@@ -21,7 +21,11 @@ module Pact
 
         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
@@ -29,7 +33,9 @@ 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
@@ -46,7 +52,7 @@ module Pact
       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 |
+        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

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

@@ -33,6 +33,9 @@ module Pact
           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
@@ -31,10 +32,6 @@ module Pact
         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/tasks/task_helper.rb

@@ -7,6 +7,7 @@ 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
 
@@ -34,6 +35,8 @@ module Pact
       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
 
@@ -41,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/version.rb

@@ -1,4 +1,4 @@
 # Remember to bump pact-provider-proxy when this changes major version
 module Pact
-  VERSION = "1.41.2"
+  VERSION = "1.54.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,36 +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.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 'randexp', '~> 0.1.7'
-  gem.add_runtime_dependency 'rspec', '>=2.14'
+  gem.add_runtime_dependency 'rspec', '~> 3.0'
   gem.add_runtime_dependency 'rack-test', '>= 0.6.3', '< 2.0.0'
-  gem.add_runtime_dependency 'thor'
-  gem.add_runtime_dependency 'json','> 1.8.5'
-  gem.add_runtime_dependency 'webrick'
+  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.9'
-  gem.add_runtime_dependency 'pact-mock_service', '~> 3.0'
+  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