pact 1.41.2 → 1.49.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 682d57626c30c4ce3f4e83038a3e5ff54d0f4878
-  data.tar.gz: 7eb5834ea442abebf6e8739a5a2746514560fdc8
+SHA256:
+  metadata.gz: d23bb31e12922ffa6334faa9105770afc780d97310296dd48f120613e12cee63
+  data.tar.gz: 89178f9552aabbf8099e65f3a10864303f53370b7ea76f841be6401d5667a66d
 SHA512:
-  metadata.gz: 369f376d001db7fac67ed5fce394dd0672c735de178c4c940b67082e7f36e7b8f43e18f2eb91d93403c969a1c26a995c229331f14780563e18b957456951b814
-  data.tar.gz: db56fdd2c74f3cba9dd6b1e3ec7983eb50a46888f2c6ea7a9a70f2153738be1bbd6a53894a433d70d8f8dd4329b3526334b31c825cc7bcf75d4072e962f4f506
+  metadata.gz: 0a1f2a19a89eacda8db9a85b08d538821bf8ff25986ea6e8d5df4b84ea798bd41dd9136b6a0f894b3a513bf538055b734d7335d585279653822c81e3bfb49fb0
+  data.tar.gz: e9b962314733660dd23127eab1076abda1391000de6d9f0f647fbdb5353cc37c79c6c308be6e04c16d9b1e5e341a38ea531f6e6fa7174852edbcb5f4c9dfc46e

data/CHANGELOG.md

@@ -1,3 +1,145 @@
+<a name="v1.49.0"></a>
+### v1.49.0 (2020-02-18)
+
+
+#### Features
+
+* use environment variables PACT_BROKER_USERNAME and PACT_BROKER_PASSWORD when verifying a pact by URL, if the environment variables are present	 ([308f25d](/../../commit/308f25d))
+
+
+<a name="v1.48.0"></a>
+### v1.48.0 (2020-02-13)
+
+
+#### Features
+
+* use certificates from SSL_CERT_FILE and SSL_CERT_DIR environment variables in HTTP connections	 ([164912b](/../../commit/164912b))
+
+
+<a name="v1.47.0"></a>
+### v1.47.0 (2020-02-08)
+
+
+#### Features
+
+* update json formatter output	 ([376e47a](/../../commit/376e47a))
+* add pact metadata to json formatter	 ([6c6ddb8](/../../commit/6c6ddb8))
+
+
+<a name="v1.46.1"></a>
+### v1.46.1 (2020-01-22)
+
+
+#### Bug Fixes
+
+* send output messages to the correct stream when using the XML formatter	 ([e768a33](/../../commit/e768a33))
+
+
+<a name="v1.46.0"></a>
+### v1.46.0 (2020-01-22)
+
+
+#### Features
+
+* expose full notice object in JSON output	 ([bdc2711](/../../commit/bdc2711))
+
+
+#### Bug Fixes
+
+* remove accidentally committed verbose: true	 ([498518c](/../../commit/498518c))
+
+
+<a name="v1.45.0"></a>
+### v1.45.0 (2020-01-21)
+
+
+#### Features
+
+* use custom json formatter when --format json is specified and send it straight to stdout or the configured file	 ([6c703a1](/../../commit/6c703a1))
+* support pending pacts in json formatter	 ([2c0d20d](/../../commit/2c0d20d))
+
+
+#### Bug Fixes
+
+* show pending test output in yellow instead of red	 ([e8d4a55](/../../commit/e8d4a55))
+
+
+<a name="v1.44.1"></a>
+### v1.44.1 (2020-01-20)
+
+
+#### Bug Fixes
+
+* print notices from 'pacts for verification' response to indicate why pacts are included an/or pending	 ([b107348](/../../commit/b107348))
+
+
+<a name="v1.44.0"></a>
+### v1.44.0 (2020-01-16)
+
+
+#### Features
+
+* **message pact**
+  * add DSL for configuring Message Pact verifications	 ([a5181b6](/../../commit/a5181b6))
+
+
+<a name="v1.43.1"></a>
+### v1.43.1 (2020-01-11)
+
+
+#### Bug Fixes
+
+* use configured credentials when fetching the diff with previous version	 ([b9deb09](/../../commit/b9deb09))
+* use URI.open instead of Kernel.open	 ([7b3ea81](/../../commit/7b3ea81))
+
+
+<a name="v1.43.0"></a>
+### v1.43.0 (2020-01-11)
+
+
+#### Features
+
+* **verify**
+  * allow includePendingStatus to be specified when fetching pacts	 ([1f5fc9c](/../../commit/1f5fc9c))
+
+
+<a name="v1.42.3"></a>
+### v1.42.3 (2019-11-15)
+
+
+#### Bug Fixes
+
+* **verify**
+  * exit with status 0 if all pacts are in pending state	 ([2f7110b](/../../commit/2f7110b))
+
+
+<a name="v1.42.2"></a>
+### v1.42.2 (2019-11-09)
+
+
+#### Bug Fixes
+
+* remove missed &.	 ([be700d8](/../../commit/be700d8))
+
+
+<a name="v1.42.1"></a>
+### v1.42.1 (2019-11-09)
+
+
+#### Bug Fixes
+
+* can't use safe navigation operator because of Ruby 2.2 in Travelling Ruby for the pact-ruby-standalone	 ([3068ceb](/../../commit/3068ceb))
+
+
+<a name="v1.42.0"></a>
+### v1.42.0 (2019-09-26)
+
+
+#### Features
+
+* use new 'pacts for verification' endpoint to retrieve pacts (#199)	 ([55bb935](/../../commit/55bb935))
+
+
 <a name="v1.41.2"></a>
 ### v1.41.2 (2019-09-10)
 

data/lib/pact/cli/run_pact_verification.rb

@@ -3,7 +3,6 @@ require 'pact/cli/spec_criteria'
 module Pact
   module Cli
     class RunPactVerification
-
       attr_reader :options
 
       def initialize options
@@ -15,6 +14,7 @@ module Pact
       end
 
       def call
+        configure_output
         initialize_rspec
         setup_load_path
         load_pact_helper
@@ -44,24 +44,32 @@ module Pact
       end
 
       def run_specs
-        exit_code = if options[:pact_uri]
-          run_with_pact_uri
+        exit_code = if options[:pact_uri].is_a?(String)
+          run_with_pact_url_string
+        elsif options[:pact_uri]
+          run_with_pact_uri_object # from pact-provider-verifier
         else
-          run_with_configured_pacts
+          run_with_configured_pacts_from_pact_helper
         end
         exit exit_code
       end
 
-      def run_with_pact_uri
+      def run_with_pact_url_string
         pact_repository_uri_options = {}
+        pact_repository_uri_options[:username] = ENV['PACT_BROKER_USERNAME'] if ENV['PACT_BROKER_USERNAME']
+        pact_repository_uri_options[:password] = ENV['PACT_BROKER_PASSWORD'] if ENV['PACT_BROKER_PASSWORD']
+        pact_repository_uri_options[:token] = ENV['PACT_BROKER_TOKEN']
         pact_repository_uri_options[:username] = options[:pact_broker_username] if options[:pact_broker_username]
         pact_repository_uri_options[:password] = options[:pact_broker_password] if options[:pact_broker_password]
-        pact_repository_uri_options[:token] = ENV['PACT_BROKER_TOKEN']
         pact_uri = ::Pact::Provider::PactURI.new(options[:pact_uri], pact_repository_uri_options)
         Pact::Provider::PactSpecRunner.new([pact_uri], pact_spec_options).run
       end
 
-      def run_with_configured_pacts
+      def run_with_pact_uri_object
+        Pact::Provider::PactSpecRunner.new([options[:pact_uri]], pact_spec_options).run
+      end
+
+      def run_with_configured_pacts_from_pact_helper
         pact_urls = Pact.provider_world.pact_urls
         raise "Please configure a pact to verify" if pact_urls.empty?
         Pact::Provider::PactSpecRunner.new(pact_urls, pact_spec_options).run
@@ -77,6 +85,14 @@ module Pact
           request_customizer: options[:request_customizer]
         }
       end
+
+      def configure_output
+        if options[:format] == 'json' && !options[:out]
+          # Don't want to mess up the JSON parsing with messages to stdout, so send it to stderr
+          require 'pact/configuration'
+          Pact.configuration.output_stream = Pact.configuration.error_stream
+        end
+      end
     end
   end
 end

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

@@ -1,7 +1,6 @@
 require 'pact/consumer/configuration/service_consumer'
 
 module Pact
-
   module Consumer
     module DSL
       def service_consumer name, &block

data/lib/pact/consumer/spec_hooks.rb

@@ -29,7 +29,7 @@ module Pact
 
       def after_suite
         if Pact.consumer_world.any_pact_examples_ran?
-          Pact.consumer_world.consumer_contract_builders.each { | c | c.write_pact }
+          Pact.consumer_world.consumer_contract_builders.each(&:write_pact)
           Pact::Doc::Generate.call
           Pact::MockService::AppManager.instance.kill_all
           Pact::MockService::AppManager.instance.clear_all
@@ -37,4 +37,4 @@ module Pact
       end
     end
   end
-end
+end

data/lib/pact/doc/sort_interactions.rb

@@ -3,7 +3,7 @@ module Pact
     class SortInteractions
 
       def self.call interactions
-        interactions.sort{|a, b| sortable_id(a) <=> sortable_id(b)}
+        interactions.sort_by { |interaction| sortable_id(interaction) }
       end
 
       private
@@ -11,7 +11,6 @@ module Pact
       def self.sortable_id interaction
         "#{interaction.description.downcase} #{interaction.response.status} #{(interaction.provider_state || '').downcase}"
       end
-
     end
   end
-end
+end

data/lib/pact/hal/http_client.rb

@@ -1,6 +1,7 @@
 require 'pact/retry'
 require 'pact/hal/authorization_header_redactor'
 require 'net/http'
+require 'rack'
 
 module Pact
   module Hal
@@ -15,9 +16,11 @@ module Pact
       end
 
       def get href, params = {}, headers = {}
-        query = params.collect{ |(key, value)| "#{CGI::escape(key)}=#{CGI::escape(value)}" }.join("&")
         uri = URI(href)
-        uri.query = query
+        if params && params.any?
+          existing_params = Rack::Utils.parse_nested_query(uri.query)
+          uri.query = Rack::Utils.build_nested_query(existing_params.merge(params))
+        end
         perform_request(create_request(uri, 'Get', nil, headers), uri)
       end
 
@@ -33,12 +36,9 @@ module Pact
 
       def create_request uri, http_method, body = nil, headers = {}
         request = Net::HTTP.const_get(http_method).new(uri.request_uri)
-        request['Content-Type'] = "application/json" if ['Post', 'Put', 'Patch'].include?(http_method)
-        request['Accept'] = "application/hal+json"
         headers.each do | key, value |
           request[key] = value
         end
-
         request.body = body if body
         request.basic_auth username, password if username
         request['Authorization'] = "Bearer #{token}" if token
@@ -50,6 +50,8 @@ module Pact
           http = Net::HTTP.new(uri.host, uri.port, :ENV)
           http.set_debug_output(output_stream) if verbose
           http.use_ssl = (uri.scheme == 'https')
+          http.ca_file = ENV['SSL_CERT_FILE'] if ENV['SSL_CERT_FILE'] && ENV['SSL_CERT_FILE'] != ''
+          http.ca_path = ENV['SSL_CERT_DIR'] if ENV['SSL_CERT_DIR'] && ENV['SSL_CERT_DIR'] != ''
           http.start do |http|
             http.request request
           end
@@ -82,6 +84,10 @@ module Pact
         def success?
           __getobj__().code.start_with?("2")
         end
+
+        def json?
+          self['content-type'] && self['content-type'] =~ /json/
+        end
       end
     end
   end

data/lib/pact/hal/link.rb

@@ -6,6 +6,15 @@ module Pact
     class Link
       attr_reader :request_method, :href
 
+      DEFAULT_GET_HEADERS = {
+        "Accept" => "application/hal+json"
+      }.freeze
+
+      DEFAULT_POST_HEADERS = {
+        "Accept" => "application/hal+json",
+        "Content-Type" => "application/json"
+      }.freeze
+
       def initialize(attrs, http_client)
         @attrs = attrs
         @request_method = attrs.fetch(:method, :get).to_sym
@@ -14,14 +23,14 @@ module Pact
       end
 
       def run(payload = nil)
-        response = case request_method
-          when :get
-            get(payload)
-          when :put
-            put(payload)
-          when :post
-            post(payload)
-          end
+        case request_method
+        when :get
+          get(payload)
+        when :put
+          put(payload)
+        when :post
+          post(payload)
+        end
       end
 
       def title_or_name
@@ -37,29 +46,57 @@ module Pact
       end
 
       def get(payload = {}, headers = {})
-        wrap_response(href, @http_client.get(href, payload, headers))
+        wrap_response(href, @http_client.get(href, payload, DEFAULT_GET_HEADERS.merge(headers)))
+      end
+
+      def get!(*args)
+        get(*args).assert_success!
       end
 
       def put(payload = nil, headers = {})
-        wrap_response(href, @http_client.put(href, payload ? payload.to_json : nil, headers))
+        wrap_response(href, @http_client.put(href, payload ? payload.to_json : nil, DEFAULT_POST_HEADERS.merge(headers)))
       end
 
       def post(payload = nil, headers = {})
-        wrap_response(href, @http_client.post(href, payload ? payload.to_json : nil, headers))
+        wrap_response(href, @http_client.post(href, payload ? payload.to_json : nil, DEFAULT_POST_HEADERS.merge(headers)))
+      end
+
+      def post!(payload = nil, headers = {})
+        post(payload, headers).assert_success!
       end
 
       def expand(params)
         expanded_url = expand_url(params, href)
         new_attrs = @attrs.merge('href' => expanded_url)
-        Link.new(new_attrs, @http_client)
+        Link.new(new_attrs, http_client)
+      end
+
+      def with_query(query)
+        if query && query.any?
+          uri = URI(href)
+          existing_query_params = Rack::Utils.parse_nested_query(uri.query)
+          uri.query = Rack::Utils.build_nested_query(existing_query_params.merge(query))
+          new_attrs = attrs.merge('href' => uri.to_s)
+          Link.new(new_attrs, http_client)
+        else
+          self
+        end
       end
 
       private
 
+      attr_reader :attrs, :http_client
+
       def wrap_response(href, http_response)
         require 'pact/hal/entity' # avoid circular reference
+        require 'pact/hal/non_json_entity'
+
         if http_response.success?
-          Entity.new(href, http_response.body, @http_client, http_response)
+          if http_response.json?
+            Entity.new(href, http_response.body, @http_client, http_response)
+          else
+            NonJsonEntity.new(href, http_response.raw_body, @http_client, http_response)
+          end
         else
           ErrorEntity.new(href, http_response.raw_body, @http_client, http_response)
         end

data/lib/pact/hal/non_json_entity.rb

@@ -0,0 +1,28 @@
+module Pact
+  module Hal
+    class NonJsonEntity
+      def initialize(href, body, http_client, response = nil)
+        @href = href
+        @body = body
+        @client = http_client
+        @response = response
+      end
+
+      def success?
+        true
+      end
+
+      def response
+        @response
+      end
+
+      def body
+        @body
+      end
+
+      def assert_success!
+        self
+      end
+    end
+  end
+end

data/lib/pact/pact_broker/fetch_pact_uris_for_verification.rb

@@ -0,0 +1,102 @@
+require 'pact/hal/entity'
+require 'pact/hal/http_client'
+require 'pact/provider/pact_uri'
+require 'pact/errors'
+require 'pact/pact_broker/fetch_pacts'
+require 'pact/pact_broker/notices'
+
+module Pact
+  module PactBroker
+    class FetchPactURIsForVerification
+      attr_reader :provider, :consumer_version_selectors, :provider_version_tags, :broker_base_url, :http_client_options, :http_client, :options
+
+      PACTS_FOR_VERIFICATION_RELATION = 'beta:provider-pacts-for-verification'.freeze
+      PACTS = 'pacts'.freeze
+      HREF = 'href'.freeze
+      LINKS = '_links'.freeze
+      SELF = 'self'.freeze
+      EMBEDDED = '_embedded'.freeze
+
+      def initialize(provider, consumer_version_selectors, provider_version_tags, broker_base_url, http_client_options, options = {})
+        @provider = provider
+        @consumer_version_selectors = consumer_version_selectors || []
+        @provider_version_tags = provider_version_tags || []
+        @http_client_options = http_client_options
+        @broker_base_url = broker_base_url
+        @http_client = Pact::Hal::HttpClient.new(http_client_options)
+        @options = options
+      end
+
+      def self.call(provider, consumer_version_selectors, provider_version_tags, broker_base_url, http_client_options, options = {})
+        new(provider, consumer_version_selectors, provider_version_tags, broker_base_url, http_client_options, options).call
+      end
+
+      def call
+        if index.can?(PACTS_FOR_VERIFICATION_RELATION)
+          log_message
+          pacts_for_verification
+        else
+          # Fall back to old method of fetching pacts
+          consumer_version_tags = consumer_version_selectors.collect{ | selector | selector[:tag] }
+          FetchPacts.call(provider, consumer_version_tags, broker_base_url, http_client_options)
+        end
+      end
+
+      private
+
+      def index
+        @index_entity ||= Pact::Hal::Link.new({ "href" => broker_base_url }, http_client).get.assert_success!
+      end
+
+      def pacts_for_verification
+        pacts_for_verification_entity.response.body[EMBEDDED][PACTS].collect do | pact |
+          metadata = {
+            pending: pact["verificationProperties"]["pending"],
+            notices: extract_notices(pact),
+            short_description: pact["shortDescription"]
+          }
+          Pact::Provider::PactURI.new(pact[LINKS][SELF][HREF], http_client_options, metadata)
+        end
+      end
+
+      def pacts_for_verification_entity
+        index
+          ._link(PACTS_FOR_VERIFICATION_RELATION)
+          .expand(provider: provider)
+          .post!(query)
+      end
+
+      def query
+        q = {}
+        q["includePendingStatus"] = true if options[:include_pending_status]
+        q["consumerVersionSelectors"] = consumer_version_selectors if consumer_version_selectors.any?
+        q["providerVersionTags"] = provider_version_tags if provider_version_tags.any?
+        q["includeWipPactsSince"] = options[:include_wip_pacts_since] if options[:include_wip_pacts_since]
+        q
+      end
+
+      def extract_notices(pact)
+        Notices.new((pact["verificationProperties"]["notices"] || []).collect{ |notice| symbolize_keys(notice) })
+      end
+
+      def symbolize_keys(hash)
+        hash.each_with_object({}){ |(k,v), h| h[k.to_sym] = v }
+      end
+
+      def log_message
+        latest = consumer_version_selectors.any? ? "" : "latest "
+        message = "INFO: 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[:all] ? "all for tag" : "latest for tag"
+            # TODO support fallback
+            name = selector[:fallback] ? "#{selector[:tag]} (or #{selector[:fallback]} if not found)" : selector[:tag]
+            "#{all_or_latest} #{name}"
+          end.join(", ")
+          message << ": #{desc}"
+        end
+        Pact.configuration.output_stream.puts message
+      end
+    end
+  end
+end

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.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,32 @@
+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 builder &block
+            self.app_block = lambda { RackToMessageAdapter.new(block)  }
+          end
+        end
+      end
+    end
+  end
+end