pact 1.51.0 → 1.55.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d44ad8e4df2bd24bef464ef32020657e3e0262627c68e351c3678f249f490416
-  data.tar.gz: 4e81574cbea58077da6f937030078126403854f09caf778c13ef92860c3de731
+  metadata.gz: 54f6d8684eb57457977a86f79a9e2aace62f2fe63ef1e3896e8beee31586b0fe
+  data.tar.gz: 292f5bdfe8cf126faaaab4a1792b1e68a21484f32a311fc9a5053f9a64f00f04
 SHA512:
-  metadata.gz: '0928d99da9e29d1574b8e788c8125f58eabcf866b373e40a9a13b4aa8ea90f7b138fa38cff40050738f54500cd5be5fb98a42e0941b838c23b7aa2e3b4bbafef'
-  data.tar.gz: baf430cc555d61d1ed2d0c375c8038d70894b0ff27fa5eb2e82e4c5db1d347c219f354b6793319a8168bd8c028530dc3378b469c7f2f1859026d9e5c3671d028
+  metadata.gz: 2501e2bb9ea36e185d45816d1944718fca0b0ebab315f7c51557553f85c809c96cb2a20d09096a326be108eafef352e6d41d2cc018369b3422f162bcc8fe7696
+  data.tar.gz: d08e959aa8220f31b0fc8e60b82e9dda9f367f04604db7d26bdef16304b8862f45679e9333e49646d157e292ca03ef98fd94cb221723c7aee988539d0cc8540d

data/CHANGELOG.md

@@ -1,3 +1,44 @@
+<a name="v1.55.0"></a>
+### v1.55.0 (2020-09-26)
+
+#### Features
+
+* add consumer_version_selectors to pact verification DSL, and convert consumer_version_tags to selectors	 ([39e6c4a](/../../commit/39e6c4a))
+* allow verification task to set just a pact_helper without a URI	 ([303077d](/../../commit/303077d))
+* split pending and failed rerun commands into separate sections	 ([f839391](/../../commit/f839391))
+* update output during verification so the pact info shows before the describe blocks of the pact that is being verified	 ([15ec231](/../../commit/15ec231))
+
+<a name="v1.54.0"></a>
+### v1.54.0 (2020-09-12)
+
+#### Features
+
+* use pb relation in preference to beta relation when fetching pacts for verification	 ([7563fcf](/../../commit/7563fcf))
+* allow include_wip_pacts_since to use a Date, DateTime or Time	 ([dd35366](/../../commit/dd35366))
+* add support for include_wip_pacts_since	 ([f2247b8](/../../commit/f2247b8))
+
+<a name="v1.53.0"></a>
+### v1.53.0 (2020-09-11)
+
+#### Features
+
+* add support for the enable_pending flag	 ([16866f4](/../../commit/16866f4))
+
+<a name="v1.52.0"></a>
+### v1.52.0 (2020-09-10)
+
+#### Features
+
+* support webdav http methods	 ([fa1d712](/../../commit/fa1d712))
+
+<a name="v1.51.1"></a>
+### v1.51.1 (2020-08-12)
+
+#### Bug Fixes
+
+* update thor dependency (#218)	 ([bf3ce69](/../../commit/bf3ce69))
+* bump rake dependency per CVE-2020-8130 (#219)	 ([09feaa6](/../../commit/09feaa6))
+
 <a name="v1.51.0"></a>
 ### v1.51.0 (2020-06-24)
 

data/lib/pact/cli.rb

@@ -4,6 +4,9 @@ require 'pact/provider/configuration'
 
 module Pact
   class CLI < Thor
+    def self.exit_on_failure? # Thor 1.0 deprecation guard
+      false
+    end
 
     desc 'verify', "Verify a pact"
     method_option :pact_helper, aliases: "-h", desc: "Pact helper file", :required => true

data/lib/pact/pact_broker/fetch_pact_uris_for_verification.rb

@@ -12,7 +12,8 @@ module Pact
       include PactSelectionDescription
       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_FOR_VERIFICATION_RELATION = 'pb:provider-pacts-for-verification'.freeze
+      PACTS_FOR_VERIFICATION_RELATION_BETA = 'beta:provider-pacts-for-verification'.freeze
       PACTS = 'pacts'.freeze
       HREF = 'href'.freeze
       LINKS = '_links'.freeze
@@ -22,7 +23,7 @@ module Pact
       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 || []
+        @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)
@@ -34,13 +35,15 @@ module Pact
       end
 
       def call
-        if index.can?(PACTS_FOR_VERIFICATION_RELATION)
+        if index.can?(PACTS_FOR_VERIFICATION_RELATION) || index.can?(PACTS_FOR_VERIFICATION_RELATION_BETA)
           log_message
           pacts_for_verification
         else
+          old_selectors = consumer_version_selectors.collect do | selector |
+            { name: selector[:tag], all: !selector[:latest], fallback: selector[:fallbackTag]}
+          end
           # 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)
+          FetchPacts.call(provider, old_selectors, broker_base_url, http_client_options)
         end
       end
 
@@ -63,7 +66,7 @@ module Pact
 
       def pacts_for_verification_entity
         index
-          ._link(PACTS_FOR_VERIFICATION_RELATION)
+          ._link(PACTS_FOR_VERIFICATION_RELATION, PACTS_FOR_VERIFICATION_RELATION_BETA)
           .expand(provider: provider)
           .post!(query)
       end

data/lib/pact/pact_broker/pact_selection_description.rb

@@ -7,7 +7,6 @@ module Pact
         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}"

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

@@ -2,6 +2,7 @@ require 'pact/shared/dsl'
 require 'pact/provider/world'
 require 'pact/pact_broker/fetch_pact_uris_for_verification'
 require 'pact/errors'
+require 'pact/utils/string'
 
 module Pact
   module Provider
@@ -14,12 +15,15 @@ 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, :_provider_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, :_include_wip_pacts_since, :_verbose, :_consumer_version_selectors
 
         def initialize(provider_name, provider_version_tags)
           @_provider_name = provider_name
           @_provider_version_tags = provider_version_tags
           @_consumer_version_tags = []
+          @_consumer_version_selectors = []
+          @_enable_pending = false
+          @_include_wip_pacts_since = nil
           @_verbose = false
         end
 
@@ -33,6 +37,22 @@ module Pact
             self._consumer_version_tags = *consumer_version_tags
           end
 
+          def consumer_version_selectors consumer_version_selectors
+            self._consumer_version_selectors = *consumer_version_selectors
+          end
+
+          def enable_pending enable_pending
+            self._enable_pending = enable_pending
+          end
+
+          def include_wip_pacts_since since
+            self._include_wip_pacts_since = if since.respond_to?(:xmlschema)
+              since.xmlschema
+            else
+              since
+            end
+          end
+
           def verbose verbose
             self._verbose = verbose
           end
@@ -51,19 +71,41 @@ module Pact
             consumer_version_selectors,
             _provider_version_tags,
             _pact_broker_base_url,
-            _basic_auth_options.merge(verbose: _verbose)
+            _basic_auth_options.merge(verbose: _verbose),
+            { include_pending_status: _enable_pending, include_wip_pacts_since: _include_wip_pacts_since }
           )
 
           Pact.provider_world.add_pact_uri_source fetch_pacts
         end
 
         def consumer_version_selectors
-          # TODO support "all"
+          convert_tags_to_selectors + convert_consumer_version_selectors
+        end
+
+        def convert_tags_to_selectors
           _consumer_version_tags.collect do | tag |
-            {
-              tag: tag,
-              latest: true
-            }
+            if tag.is_a?(Hash)
+              {
+                tag: tag.fetch(:name),
+                latest: !tag[:all],
+                fallbackTag: tag[:fallback]
+              }
+            elsif tag.is_a?(String)
+              {
+                tag: tag,
+                latest: true
+              }
+            else
+              raise Pact::Error.new("The value supplied for consumer_version_tags must be a String or a Hash. Found #{tag.class}")
+            end
+          end
+        end
+
+        def convert_consumer_version_selectors
+          _consumer_version_selectors.collect do | selector |
+            selector.each_with_object({}) do | (key, value), new_selector |
+              new_selector[Pact::Utils::String.camelcase(key.to_s).to_sym] = value
+            end
           end
         end
 

data/lib/pact/provider/rspec.rb

@@ -24,28 +24,34 @@ module Pact
         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)
           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)
+            honour_consumer_contract consumer_contract, options.merge(
+              pact_json: pact_json,
+              pact_uri: pact_uri,
+              pact_source: pact_source,
+              consumer_contract: consumer_contract,
+              criteria: options[:criteria]
+              )
           end
         end
 
         def honour_consumer_contract consumer_contract, options = {}
-          describe_consumer_contract consumer_contract, options.merge(consumer: consumer_contract.consumer.name)
+          describe_consumer_contract consumer_contract, options.merge(consumer: consumer_contract.consumer.name, pact_context: InteractionContext.new)
         end
 
         private
 
         def describe_consumer_contract consumer_contract, options
-          consumer_interactions(consumer_contract, options).each do |interaction|
+          consumer_interactions(consumer_contract, options).tap{ |interactions|
+            if interactions.empty?
+              # If there are no interactions, the documentation formatter never fires to print this out,
+              # so print it out here.
+              Pact.configuration.output_stream.puts "DEBUG: All interactions for #{options[:pact_uri]} have been filtered out by criteria: #{options[:criteria]}" if options[:criteria] && options[:criteria].any?
+            end
+          }.each do |interaction|
             describe_interaction_with_provider_state interaction, options
           end
         end
@@ -54,7 +60,7 @@ module Pact
           if options[:criteria].nil?
             consumer_contract.interactions
           else
-            consumer_contract.find_interactions options[:criteria]
+            consumer_contract.find_interactions(options[:criteria])
           end
         end
 
@@ -84,14 +90,19 @@ module Pact
             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]
+            pact_consumer_contract: options[:consumer_contract],
+            pact_criteria: options[:criteria]
           }
 
           describe description_for(interaction), metadata do
 
             interaction_context = InteractionContext.new
+            pact_context = options[:pact_context]
 
             before do | example |
+              pact_context.run_once :before do
+                ::RSpec.configuration.reporter.message "THIS IS A PACT"
+              end
               interaction_context.run_once :before do
                 Pact.configuration.logger.info "Running example '#{Pact::RSpec.full_description(example)}'"
                 set_up_provider_states interaction.provider_states, options[:consumer]

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

@@ -24,6 +24,25 @@ module Pact
 
         C = ::Term::ANSIColor
 
+        def example_group_started(notification)
+          if @group_level == 0
+            Pact.configuration.output_stream.puts
+            pact_uri = notification.group.metadata[:pactfile_uri]
+            ::RSpec.configuration.failure_color = pact_uri.metadata[:pending] ? :yellow : :red
+
+            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
+
+            criteria = notification.group.metadata[:pact_criteria]
+            Pact.configuration.output_stream.puts "DEBUG: Filtering interactions by: #{criteria}" if criteria && criteria.any?
+          end
+          super
+        end
+
+
         def dump_summary(summary)
           output.puts "\n" + colorized_totals_line(summary)
           return if summary.failure_count == 0
@@ -35,11 +54,15 @@ module Pact
         private
 
         def interactions_count(summary)
-          summary.examples.collect{ |e| e.metadata[:pact_interaction_example_description] }.uniq.size
+          summary.examples.collect{ |e| interaction_unique_key(e) }.uniq.size
         end
 
         def failed_interactions_count(summary)
-          summary.failed_examples.collect{ |e| e.metadata[:pact_interaction_example_description] }.uniq.size
+          failed_interaction_examples(summary).size
+        end
+
+        def pending_interactions_count(summary)
+          pending_interaction_examples(summary).size
         end
 
         def ignore_failures?(summary)
@@ -47,16 +70,14 @@ module Pact
         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
+          ::RSpec::Core::Formatters::Helpers.pluralize(failed_interactions_count(summary), "failure")
         end
 
         def totals_line summary
           line = ::RSpec::Core::Formatters::Helpers.pluralize(interactions_count(summary), "interaction")
           line << ", " << failure_title(summary)
+          pending_count = pending_interactions_count(summary)
+          line << ", " << "#{pending_count} pending" if pending_count > 0
           line
         end
 
@@ -69,12 +90,17 @@ module Pact
         end
 
         def print_rerun_commands summary
-          if ignore_failures?(summary)
+          if pending_interactions_count(summary) > 0
+            set_rspec_failure_color(:yellow)
             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")
+            interaction_rerun_commands(pending_interaction_examples(summary)).each do | message |
+              output.puts(message)
+            end
           end
-          interaction_rerun_commands(summary).each do | message |
+
+          set_rspec_failure_color(:red)
+          output.puts("\nFailed interactions:\n\n")
+          interaction_rerun_commands(failed_interaction_examples(summary)).each do | message |
             output.puts(message)
           end
         end
@@ -85,10 +111,34 @@ module Pact
           end
         end
 
-        def interaction_rerun_commands summary
-          summary.failed_examples.collect do |example|
+        def pending_interaction_examples(summary)
+          one_failed_example_per_interaction(summary).select do | example |
+            example.metadata[:pactfile_uri].metadata[:pending]
+          end
+        end
+
+        def failed_interaction_examples(summary)
+          one_failed_example_per_interaction(summary).select do | example |
+            !example.metadata[:pactfile_uri].metadata[:pending]
+          end
+        end
+
+        def one_failed_example_per_interaction(summary)
+          summary.failed_examples.group_by{| e| interaction_unique_key(e)}.values.collect(&:first)
+        end
+
+        def interaction_rerun_commands examples
+          examples.collect do |example|
             interaction_rerun_command_for example
-          end.uniq.compact
+          end.compact
+        end
+
+        def interaction_unique_key(example)
+          # pending is just to make the counting easier, it isn't required for the unique key
+          {
+            pactfile_uri: example.metadata[:pactfile_uri],
+            index: example.metadata[:pact_interaction].index,
+          }
         end
 
         def interaction_rerun_command_for example
@@ -137,6 +187,10 @@ module Pact
         def executing_with_ruby?
           ENV['PACT_EXECUTING_LANGUAGE'] == 'ruby'
         end
+
+        def set_rspec_failure_color color
+          ::RSpec.configuration.failure_color = color
+        end
       end
     end
   end

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

data/lib/pact/tasks/verification_task.rb

@@ -31,6 +31,7 @@ module Pact
     attr_reader :pact_spec_configs
     attr_accessor :rspec_opts
     attr_accessor :ignore_failures
+    attr_accessor :_pact_helper
 
     def initialize(name)
       @rspec_opts = nil
@@ -41,6 +42,10 @@ module Pact
       rake_task
     end
 
+    def pact_helper(pact_helper)
+      @pact_spec_configs << { pact_helper: pact_helper }
+    end
+
     def uri(uri, options = {})
       @pact_spec_configs << {uri: uri, pact_helper: options[:pact_helper]}
     end
@@ -82,6 +87,7 @@ module Pact
           Pact::TaskHelper.handle_verification_failure do
             exit_statuses.count{ | status | status != 0 }
           end
+
         end
       end
     end

data/lib/pact/utils/string.rb

@@ -0,0 +1,35 @@
+# Can't use refinements because of Travelling Ruby
+
+module Pact
+  module Utils
+    module String
+
+      extend self
+
+      # ripped from rubyworks/facets, thank you
+      def camelcase(string, *separators)
+        case separators.first
+        when Symbol, TrueClass, FalseClass, NilClass
+          first_letter = separators.shift
+        end
+
+        separators = ['_', '\s'] if separators.empty?
+
+        str = string.dup
+
+        separators.each do |s|
+          str = str.gsub(/(?:#{s}+)([a-z])/){ $1.upcase }
+        end
+
+        case first_letter
+        when :upper, true
+          str = str.gsub(/(\A|\s)([a-z])/){ $1 + $2.upcase }
+        when :lower, false
+          str = str.gsub(/(\A|\s)([A-Z])/){ $1 + $2.downcase }
+        end
+
+        str
+      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.51.0"
+  VERSION = "1.55.0"
 end

data/pact.gemspec

@@ -28,14 +28,14 @@ Gem::Specification.new do |gem|
 
   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'
+  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', '>= 3.3.1'
 
-  gem.add_development_dependency 'rake', '~> 10.0'
+  gem.add_development_dependency 'rake', '~> 13.0'
   gem.add_development_dependency 'webmock', '~> 3.0'
   gem.add_development_dependency 'fakefs', '0.5' # 0.6.0 blows up
   gem.add_development_dependency 'hashie', '~> 2.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact
 version: !ruby/object:Gem::Version
-  version: 1.51.0
+  version: 1.55.0
 platform: ruby
 authors:
 - James Fraser
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-24 00:00:00.000000000 Z
+date: 2020-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -52,16 +52,22 @@ dependencies:
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.20'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.20'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: webrick
   requirement: !ruby/object:Gem::Requirement
@@ -130,14 +136,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -371,6 +377,7 @@ files:
 - lib/pact/tasks/verification_task.rb
 - lib/pact/templates/help.erb
 - lib/pact/templates/provider_state.erb
+- lib/pact/utils/string.rb
 - lib/pact/version.rb
 - lib/tasks/pact.rake
 - pact.gemspec
@@ -397,8 +404,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Enables consumer driven contract testing, providing a mock service and DSL