pact 1.41.2 → 1.53.0

data/lib/pact/pact_broker/notices.rb

@@ -0,0 +1,34 @@
+module Pact
+  module PactBroker
+    class Notices < Array
+      def before_verification_notices
+        select { | notice | notice[:when].nil? || notice[:when].start_with?('before_verification') }
+      end
+
+      def before_verification_notices_text
+        before_verification_notices.collect{ | notice | notice[:text] }
+      end
+
+      def after_verification_notices(success, published)
+        select { | notice | notice[:when] == "after_verification:success_#{success}_published_#{published}" || notice[:when] == "after_verification" }
+          .collect do | notice |
+            notice.merge(:when => simplify_notice_when(notice[:when]))
+          end
+      end
+
+      def after_verification_notices_text(success, published)
+        after_verification_notices(success, published).collect{ | notice | notice[:text] }
+      end
+
+      def all_notices(success, published)
+        before_verification_notices + after_verification_notices(success, published)
+      end
+
+      private
+
+      def simplify_notice_when(when_key)
+        when_key.split(":").first
+      end
+    end
+  end
+end

data/lib/pact/pact_broker/pact_selection_description.rb

@@ -0,0 +1,24 @@
+module Pact
+  module PactBroker
+    module PactSelectionDescription
+      def pact_selection_description(provider, consumer_version_selectors, options, broker_base_url)
+        latest = consumer_version_selectors.any? ? "" : "latest "
+        message = "Fetching pacts for #{provider} from #{broker_base_url} with the selection criteria: "
+        if consumer_version_selectors.any?
+          desc = consumer_version_selectors.collect do |selector|
+            all_or_latest = !selector[:latest] ? "all for tag" : "latest for tag"
+            # TODO support fallback
+            fallback = selector[:fallback] || selector[:fallbackTag]
+            name = fallback ? "#{selector[:tag]} (or #{fallback} if not found)" : selector[:tag]
+            "#{all_or_latest} #{name}"
+          end.join(", ")
+          if options[:include_wip_pacts_since]
+            desc = "#{desc}, work in progress pacts created after #{options[:include_wip_pacts_since]}"
+          end
+          message << "#{desc}"
+        end
+        message
+      end
+    end
+  end
+end

data/lib/pact/pact_broker.rb

@@ -1,19 +1,25 @@
 require 'pact/pact_broker/fetch_pacts'
-require 'pact/pact_broker/fetch_pending_pacts'
+require 'pact/pact_broker/fetch_pact_uris_for_verification'
+require 'pact/provider/pact_uri'
 
 #
-# @public Use by Pact Provider Verifier
+# @public Used by Pact Provider Verifier
 #
 module Pact
   module PactBroker
     extend self
 
+    # Keep for backwards compatibility with pact-provider-verifier < 1.23.1
     def fetch_pact_uris *args
       Pact::PactBroker::FetchPacts.call(*args).collect(&:uri)
     end
 
-    def fetch_pending_pact_uris *args
-      Pact::PactBroker::FetchPendingPacts.call(*args).collect(&:uri)
+    def fetch_pact_uris_for_verification *args
+      Pact::PactBroker::FetchPactURIsForVerification.call(*args)
+    end
+
+    def build_pact_uri(*args)
+      Pact::Provider::PactURI.new(*args)
     end
   end
 end

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

@@ -1,4 +1,5 @@
 require 'pact/provider/configuration/service_provider_dsl'
+require 'pact/provider/configuration/message_provider_dsl'
 
 module Pact
 
@@ -8,6 +9,10 @@ module Pact
       def service_provider name, &block
         Configuration::ServiceProviderDSL.build(name, &block)
       end
+
+      def message_provider name, &block
+        Configuration::MessageProviderDSL.build(name, &block)
+      end
     end
   end
-end
+end

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,6 @@
 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
@@ -14,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
 
@@ -32,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
@@ -45,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

@@ -22,4 +22,3 @@ module Pact
     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
@@ -80,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
 
@@ -91,7 +90,7 @@ module Pact
           ::RSpec::Core::CommandLine.new(NoConfigurationOptions.new)
             .run(::RSpec.configuration.output_stream, ::RSpec.configuration.error_stream)
         end
-        options[:ignore_failures] ? 0 : exit_code
+        pending_mode? ? 0 : exit_code
       end
 
       def rspec_runner_options
@@ -118,12 +117,12 @@ module Pact
 
       def initialize_specs
         pact_sources.each do | pact_source |
-          options = {
-            criteria: @options[:criteria],
-            ignore_failures: @options[:ignore_failures],
-            request_customizer: @options[:request_customizer]
+          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
 
@@ -134,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
@@ -148,7 +148,7 @@ module Pact
 
         ::RSpec.configuration.full_backtrace = @options[:full_backtrace]
 
-        ::RSpec.configuration.failure_color = :yellow if @options[:ignore_failures]
+        ::RSpec.configuration.failure_color = :yellow if pending_mode?
       end
 
       def ordered_pact_json(pact_json)
@@ -159,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
@@ -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