pact 1.28.0 → 1.53.0

data/lib/pact/provider/configuration/message_provider_dsl.rb

@@ -0,0 +1,59 @@
+require 'pact/provider/configuration/service_provider_dsl'
+
+module Pact
+  module Provider
+    module Configuration
+      class MessageProviderDSL < ServiceProviderDSL
+        class RackToMessageAdapter
+          def initialize(message_builder)
+            @message_builder = message_builder
+          end
+
+          def call(env)
+            request_body_json = JSON.parse(env['rack.input'].read)
+            contents = @message_builder.call(request_body_json['description'])
+            [200, {"Content-Type" => "application/json"}, [{ contents: contents }.to_json]]
+          end
+        end
+
+        def initialize name
+          super
+          @mapper_block = lambda { |args|  }
+        end
+
+        dsl do
+          def app &block
+            self.app_block = block
+          end
+
+          def app_version application_version
+            self.application_version = application_version
+          end
+
+          def app_version_tags tags
+            self.tags = tags
+          end
+
+          def publish_verification_results publish_verification_results
+            self.publish_verification_results = publish_verification_results
+            Pact::RSpec.with_rspec_2 do
+              Pact.configuration.error_stream.puts "WARN: Publishing of verification results is currently not supported with rspec 2. If you would like this functionality, please feel free to submit a PR!"
+            end
+          end
+
+          def honours_pact_with consumer_name, options = {}, &block
+            create_pact_verification consumer_name, options, &block
+          end
+
+          def honours_pacts_from_pact_broker &block
+            create_pact_verification_from_broker &block
+          end
+
+          def builder &block
+            self.app_block = lambda { RackToMessageAdapter.new(block)  }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider/configuration/pact_verification_from_broker.rb

@@ -1,6 +1,7 @@
 require 'pact/shared/dsl'
 require 'pact/provider/world'
-require 'pact/pact_broker/fetch_pacts'
+require 'pact/pact_broker/fetch_pact_uris_for_verification'
+require 'pact/errors'
 
 module Pact
   module Provider
@@ -13,11 +14,13 @@ module Pact
         # in parent scope, it will clash with these ones,
         # so put an underscore in front of the name to be safer.
 
-        attr_accessor :_provider_name, :_pact_broker_base_url, :_consumer_version_tags, :_basic_auth_options, :_verbose
+        attr_accessor :_provider_name, :_pact_broker_base_url, :_consumer_version_tags, :_provider_version_tags, :_basic_auth_options, :_enable_pending, :_verbose
 
-        def initialize(provider_name)
+        def initialize(provider_name, provider_version_tags)
           @_provider_name = provider_name
+          @_provider_version_tags = provider_version_tags
           @_consumer_version_tags = []
+          @_enable_pending = false
           @_verbose = false
         end
 
@@ -31,6 +34,10 @@ module Pact
             self._consumer_version_tags = *consumer_version_tags
           end
 
+          def enable_pending enable_pending
+            self._enable_pending = enable_pending
+          end
+
           def verbose verbose
             self._verbose = verbose
           end
@@ -44,10 +51,28 @@ module Pact
         private
 
         def create_pact_verification
-          fetch_pacts = Pact::PactBroker::FetchPacts.new(_provider_name, _consumer_version_tags, _pact_broker_base_url, _basic_auth_options.merge(verbose: _verbose))
+          fetch_pacts = Pact::PactBroker::FetchPactURIsForVerification.new(
+            _provider_name,
+            consumer_version_selectors,
+            _provider_version_tags,
+            _pact_broker_base_url,
+            _basic_auth_options.merge(verbose: _verbose),
+            { include_pending_status: _enable_pending }
+          )
+
           Pact.provider_world.add_pact_uri_source fetch_pacts
         end
 
+        def consumer_version_selectors
+          # TODO support "all"
+          _consumer_version_tags.collect do | tag |
+            {
+              tag: tag,
+              latest: true
+            }
+          end
+        end
+
         def validate
           raise Pact::Error.new("Please provide a pact_broker_base_url from which to retrieve the pacts") unless _pact_broker_base_url
         end

data/lib/pact/provider/configuration/service_provider_dsl.rb

@@ -65,7 +65,7 @@ module Pact
         end
 
         def create_pact_verification_from_broker(&block)
-          PactVerificationFromBroker.build(name, &block)
+          PactVerificationFromBroker.build(name, tags, &block)
         end
 
         def finalize

data/lib/pact/provider/help/content.rb

@@ -5,8 +5,8 @@ module Pact
     module Help
       class Content
 
-        def initialize pact_jsons
-          @pact_jsons = pact_jsons
+        def initialize pact_sources
+          @pact_sources = pact_sources
         end
 
         def text
@@ -15,7 +15,7 @@ module Pact
 
         private
 
-        attr_reader :pact_jsons
+        attr_reader :pact_sources
 
         def help_text
           temp_dir = Pact.configuration.tmp_dir
@@ -28,7 +28,7 @@ module Pact
         end
 
         def pact_diffs
-          pact_jsons.collect do | pact_json |
+          pact_sources.collect do | pact_json |
             PactDiff.call(pact_json)
           end.compact.join("\n")
         end

data/lib/pact/provider/help/pact_diff.rb

@@ -1,26 +1,24 @@
+require 'pact/hal/entity'
+
 module Pact
   module Provider
     module Help
-
       class PactDiff
-
         class PrintPactDiffError < StandardError; end
 
-        attr_reader :pact_json, :output
+        attr_reader :pact_source, :output
 
-        def initialize pact_json
-          @pact_json = pact_json
+        def initialize pact_source
+          @pact_source = pact_source
         end
 
-        def self.call pact_json
-          new(pact_json).call
+        def self.call pact_source
+          new(pact_source).call
         end
 
         def call
           begin
-            if diff_rel && diff_url
-              header + "\n" + get_diff
-            end
+            header + "\n" + get_diff
           rescue PrintPactDiffError => e
             return e.message
           end
@@ -32,35 +30,13 @@ module Pact
           "The following changes have been made since the previous distinct version of this pact, and may be responsible for verification failure:\n"
         end
 
-        def pact_hash
-          @pact_hash ||= json_load(pact_json)
-        end
-
-        def links
-          pact_hash['_links'] || pact_hash['links']
-        end
-
-        def diff_rel
-          return nil unless links
-          key = links.keys.find { | key | key =~ /diff/ && key =~ /distinct/ && key =~ /previous/}
-          key ? links[key] : nil
-        end
-
-        def diff_url
-          diff_rel['href']
-        end
-
         def get_diff
           begin
-            open(diff_url) { | file | file.read }
+            pact_source.hal_entity._link!("pb:diff-previous-distinct").get!(nil, "Accept" => "text/plain").body
           rescue StandardError => e
-            raise PrintPactDiffError.new("Tried to retrieve diff with previous pact from #{diff_url}, but received response code #{e}.")
+            raise PrintPactDiffError.new("Tried to retrieve diff with previous pact, but received error #{e.class} #{e.message}.")
           end
         end
-
-        def json_load json
-          JSON.load(json, nil, { max_nesting: 50 })
-        end
       end
     end
   end

data/lib/pact/provider/help/write.rb

@@ -9,12 +9,12 @@ module Pact
 
         HELP_FILE_NAME = 'help.md'
 
-        def self.call pact_jsons, reports_dir = Pact.configuration.reports_dir
-          new(pact_jsons, reports_dir).call
+        def self.call pact_sources, reports_dir = Pact.configuration.reports_dir
+          new(pact_sources, reports_dir).call
         end
 
-        def initialize pact_jsons, reports_dir
-          @pact_jsons = pact_jsons
+        def initialize pact_sources, reports_dir
+          @pact_sources = pact_sources
           @reports_dir = File.expand_path(reports_dir)
         end
 
@@ -25,7 +25,7 @@ module Pact
 
         private
 
-        attr_reader :reports_dir, :pact_jsons
+        attr_reader :reports_dir, :pact_sources
 
         def clean_reports_dir
           raise "Cleaning report dir #{reports_dir} would delete project!" if reports_dir_contains_pwd
@@ -46,9 +46,8 @@ module Pact
         end
 
         def help_text
-          Content.new(pact_jsons).text
+          Content.new(pact_sources).text
         end
-
       end
     end
   end

data/lib/pact/provider/pact_helper_locator.rb

@@ -1,22 +1,24 @@
 module Pact
   module Provider
     module PactHelperLocater
-        PACT_HELPER_FILE_PATTERNS = [
+      PACT_HELPER_FILE_PATTERNS = [
         "spec/**/*service*consumer*/pact_helper.rb",
         "spec/**/*consumer*/pact_helper.rb",
         "spec/**/pact_helper.rb",
-        "**/pact_helper.rb"]
+        "test/**/*service*consumer*/pact_helper.rb",
+        "test/**/*consumer*/pact_helper.rb",
+        "test/**/pact_helper.rb",
+        "**/pact_helper.rb"
+      ]
 
-        NO_PACT_HELPER_FOUND_MSG = "Please create a pact_helper.rb file that can be found using one of the following patterns: #{PACT_HELPER_FILE_PATTERNS.join(", ")}"
-
-        def self.pact_helper_path
-          pact_helper_search_results = []
-          PACT_HELPER_FILE_PATTERNS.find { | pattern | (pact_helper_search_results.concat(Dir.glob(pattern))).any? }
-          raise NO_PACT_HELPER_FOUND_MSG if pact_helper_search_results.empty?
-          File.join(Dir.pwd, pact_helper_search_results[0])
-        end
+      NO_PACT_HELPER_FOUND_MSG = "Please create a pact_helper.rb file that can be found using one of the following patterns: #{PACT_HELPER_FILE_PATTERNS.join(", ")}"
 
+      def self.pact_helper_path
+        pact_helper_search_results = []
+        PACT_HELPER_FILE_PATTERNS.find { | pattern | (pact_helper_search_results.concat(Dir.glob(pattern))).any? }
+        raise NO_PACT_HELPER_FOUND_MSG if pact_helper_search_results.empty?
+        File.join(Dir.pwd, pact_helper_search_results[0])
+      end
     end
   end
 end
-

data/lib/pact/provider/pact_source.rb

@@ -1,10 +1,12 @@
 require 'pact/consumer_contract/pact_file'
+require 'pact/hal/http_client'
+require 'pact/hal/entity'
 
 module Pact
   module Provider
     class PactSource
 
-      attr_reader :uri
+      attr_reader :uri # PactURI class
 
       def initialize uri
         @uri = uri
@@ -17,6 +19,13 @@ module Pact
       def pact_hash
         @pact_hash ||= JSON.load(pact_json, nil, { max_nesting: 50 })
       end
+
+      def hal_entity
+        http_client_keys = [:username, :password, :token]
+        http_client_options = uri.options.reject{ |k, _| !http_client_keys.include?(k) }
+        http_client = Pact::Hal::HttpClient.new(http_client_options)
+        Pact::Hal::Entity.new(uri, pact_hash, http_client)
+      end
     end
   end
 end

data/lib/pact/provider/pact_spec_runner.rb

@@ -9,9 +9,8 @@ require 'pact/provider/pact_source'
 require 'pact/provider/help/write'
 require 'pact/provider/verification_results/publish_all'
 require 'pact/provider/rspec/pact_broker_formatter'
-
-require_relative 'rspec'
-
+require 'pact/provider/rspec/json_formatter'
+require 'pact/provider/rspec'
 
 module Pact
   module Provider
@@ -36,6 +35,7 @@ module Pact
         ensure
           ::RSpec.reset
           Pact.clear_provider_world
+          Pact.clear_consumer_world
         end
       end
 
@@ -79,7 +79,7 @@ module Pact
         executing_with_ruby = executing_with_ruby?
 
         config.after(:suite) do | suite |
-          Pact::Provider::Help::Write.call(jsons) if executing_with_ruby
+          Pact::Provider::Help::Write.call(Pact.provider_world.pact_sources) if executing_with_ruby
         end
       end
 
@@ -90,7 +90,7 @@ module Pact
           ::RSpec::Core::CommandLine.new(NoConfigurationOptions.new)
             .run(::RSpec.configuration.output_stream, ::RSpec.configuration.error_stream)
         end
-        exit_code
+        pending_mode? ? 0 : exit_code
       end
 
       def rspec_runner_options
@@ -117,10 +117,12 @@ module Pact
 
       def initialize_specs
         pact_sources.each do | pact_source |
-          options = {
-            criteria: @options[:criteria]
+          spec_options = {
+            criteria: options[:criteria],
+            ignore_failures: options[:ignore_failures],
+            request_customizer: options[:request_customizer]
           }
-          honour_pactfile pact_source.uri, ordered_pact_json(pact_source.pact_json), options
+          honour_pactfile pact_source, ordered_pact_json(pact_source.pact_json), spec_options
         end
       end
 
@@ -131,11 +133,12 @@ module Pact
 
         output = options[:out] || Pact.configuration.output_stream
         if options[:format]
-          ::RSpec.configuration.add_formatter options[:format], output
-          if !options[:out]
-            # Don't want to mess up the JSON parsing with messages to stdout, so send it to stderr
-            Pact.configuration.output_stream = Pact.configuration.error_stream
-          end
+          formatter = options[:format] == 'json' ? Pact::Provider::RSpec::JsonFormatter : options[:format]
+          # Send formatted output to $stdout for parsing, unless a file is specified
+          output = options[:out] || $stdout
+          ::RSpec.configuration.add_formatter formatter, output
+          # Don't want to mess up the JSON parsing with INFO and DEBUG messages to stdout, so send it to stderr
+          Pact.configuration.output_stream = Pact.configuration.error_stream if !options[:out]
         else
           # Sometimes the formatter set in the cli.rb get set with an output of StringIO.. don't know why
           formatter_class = Pact::RSpec.formatter_class
@@ -144,6 +147,8 @@ module Pact
         end
 
         ::RSpec.configuration.full_backtrace = @options[:full_backtrace]
+
+        ::RSpec.configuration.failure_color = :yellow if pending_mode?
       end
 
       def ordered_pact_json(pact_json)
@@ -154,12 +159,20 @@ module Pact
         consumer_contract.to_json
       end
 
+      def all_pacts_pending?
+        pact_urls.all?{ | pact_url| pact_url.metadata[:pending] }
+      end
+
       def class_exists? name
         Kernel.const_get name
       rescue NameError
         false
       end
 
+      def pending_mode?
+        (all_pacts_pending? || options[:ignore_failures])
+      end
+
       def executing_with_ruby?
         ENV['PACT_EXECUTING_LANGUAGE'] == 'ruby'
       end

data/lib/pact/provider/pact_uri.rb

@@ -1,17 +1,19 @@
 module Pact
   module Provider
     class PactURI
-      attr_reader :uri, :options
+      attr_reader :uri, :options, :metadata
 
-      def initialize (uri, options={})
+      def initialize (uri, options = nil, metadata = nil)
         @uri = uri
-        @options = options
+        @options = options || {}
+        @metadata = metadata || {} # make sure it's not nil if nil is passed in
       end
 
       def == other
         other.is_a?(PactURI) &&
           uri == other.uri &&
-          options == other.options
+          options == other.options &&
+          metadata == other.metadata
       end
 
       def basic_auth?
@@ -27,10 +29,10 @@ module Pact
       end
 
       def to_s
-        if(basic_auth?)
+        if basic_auth? && uri.start_with?('http://', 'https://')
           URI(@uri).tap { |x| x.userinfo="#{username}:*****"}.to_s
         else
-          @uri
+          uri
         end
       end
     end

data/lib/pact/provider/request.rb

@@ -54,7 +54,7 @@ module Pact
         end
 
         def rack_request_header_for header
-          with_http_prefix(header.to_s.upcase).gsub('-', '_')
+          with_http_prefix(header.to_s.upcase).tr('-', '_')
         end
 
         def rack_request_value_for value

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
@@ -42,9 +42,21 @@ module Pact
           summary.failed_examples.collect{ |e| e.metadata[:pact_interaction_example_description] }.uniq.size
         end
 
+        def ignore_failures?(summary)
+          summary.failed_examples.any?{ |e| e.metadata[:pact_ignore_failures] }
+        end
+
+        def failure_title summary
+          if ignore_failures?(summary)
+            "#{failed_interactions_count(summary)} pending"
+          else
+            ::RSpec::Core::Formatters::Helpers.pluralize(failed_interactions_count(summary), "failure")
+          end
+        end
+
         def totals_line summary
           line = ::RSpec::Core::Formatters::Helpers.pluralize(interactions_count(summary), "interaction")
-          line << ", " << ::RSpec::Core::Formatters::Helpers.pluralize(failed_interactions_count(summary), "failure")
+          line << ", " << failure_title(summary)
           line
         end
 
@@ -57,7 +69,11 @@ module Pact
         end
 
         def print_rerun_commands summary
-          output.puts("\nFailed interactions:\n\n")
+          if ignore_failures?(summary)
+            output.puts("\nPending interactions: (Failures listed here are expected and do not affect your suite's status)\n\n")
+          else
+            output.puts("\nFailed interactions:\n\n")
+          end
           interaction_rerun_commands(summary).each do | message |
             output.puts(message)
           end
@@ -77,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