pact 1.55.0 → 1.57.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54f6d8684eb57457977a86f79a9e2aace62f2fe63ef1e3896e8beee31586b0fe
-  data.tar.gz: 292f5bdfe8cf126faaaab4a1792b1e68a21484f32a311fc9a5053f9a64f00f04
+  metadata.gz: 2f5bff8179ed3588a9363fd864b36527a51672bc2f0812778e188f60571975c1
+  data.tar.gz: 8bec6ad8f69b8a60836256c261f32c288624ae1a876e452acedfc62daeffebc8
 SHA512:
-  metadata.gz: 2501e2bb9ea36e185d45816d1944718fca0b0ebab315f7c51557553f85c809c96cb2a20d09096a326be108eafef352e6d41d2cc018369b3422f162bcc8fe7696
-  data.tar.gz: d08e959aa8220f31b0fc8e60b82e9dda9f367f04604db7d26bdef16304b8862f45679e9333e49646d157e292ca03ef98fd94cb221723c7aee988539d0cc8540d
+  metadata.gz: a0638972bc29d64815a6d29fbd46a88092eb0d748e21f0da41cde9e485c63fa1158cbf03d9b4d638d273b1caff78470d07d40377be176804fab62e96aecce043
+  data.tar.gz: 9161da6d7c9490db14c7472ca54e0c8a0d7a8fdad65f033694a31db8d80097f3a343098fc41f4c12fb59f12a3ae5a36f2b5503ade581eeb1f9c0f8fb66e74920

data/CHANGELOG.md

@@ -1,3 +1,68 @@
+<a name="v1.57.0"></a>
+### v1.57.0 (2021-01-27)
+
+#### Features
+
+* allow verbose flag to be set when publishing verifications	 ([9238e4c](/../../commit/9238e4c))
+
+<a name="v1.56.0"></a>
+### v1.56.0 (2021-01-22)
+
+#### Features
+
+* catch and log error during help text generation	 ([182a7cd](/../../commit/182a7cd))
+
+<a name="v1.55.7"></a>
+### v1.55.7 (2020-11-25)
+
+#### Bug Fixes
+
+* add consumer name to the selection description (#229)	 ([5127036](/../../commit/5127036))
+
+<a name="v1.55.6"></a>
+### v1.55.6 (2020-11-06)
+
+#### Bug Fixes
+
+* require rspec now that pact-support does not depend on it	 ([5b5c27c](/../../commit/5b5c27c))
+
+<a name="v1.55.5"></a>
+### v1.55.5 (2020-10-12)
+
+#### Bug Fixes
+
+* **security**
+  * hide personal access token given in uri (#225)	 ([f6db12d](/../../commit/f6db12d))
+
+<a name="v1.55.4"></a>
+### v1.55.4 (2020-10-09)
+
+#### Bug Fixes
+
+* add back missing output describing the interactions filter	 ([1a2d7c1](/../../commit/1a2d7c1))
+
+<a name="v1.55.3"></a>
+### v1.55.3 (2020-09-28)
+
+#### Bug Fixes
+
+* correct logic for determining if all interactions for a pact have been verified	 ([c4f968e](/../../commit/c4f968e))
+* de-duplicate re-run commands	 ([0813498](/../../commit/0813498))
+
+<a name="v1.55.2"></a>
+### v1.55.2 (2020-09-26)
+
+#### Bug Fixes
+
+* correctly calculate exit code when a mix of pending and non pending pacts are verified	 ([533faa1](/../../commit/533faa1))
+
+<a name="v1.55.1"></a>
+### v1.55.1 (2020-09-26)
+
+#### Bug Fixes
+
+* remove accidentally committed debug logging	 ([081423e](/../../commit/081423e))
+
 <a name="v1.55.0"></a>
 ### v1.55.0 (2020-09-26)
 

data/lib/pact/cli.rb

@@ -16,6 +16,7 @@ module Pact
     method_option :pact_broker_password, aliases: "-w", desc: "Pact broker password"
     method_option :pact_broker_token, aliases: "-k", desc: "Pact broker token"
     method_option :backtrace, aliases: "-b", desc: "Show full backtrace", :default => false, :type => :boolean
+    method_option :verbose, aliases: "-v", desc: "Show verbose HTTP logging", :default => false, :type => :boolean
     method_option :interactions_replay_order, aliases: "-o",
                   desc: "Interactions replay order: randomised or recorded (default)",
                   default: Pact.configuration.interactions_replay_order

data/lib/pact/cli/run_pact_verification.rb

@@ -27,6 +27,7 @@ module Pact
         # With RSpec3, if the pact_helper loads a library that adds its own formatter before we set one,
         # we will get a ProgressFormatter too, and get little dots sprinkled throughout our output.
         # Load a NilFormatter here to prevent that.
+        require 'rspec'
         require 'pact/rspec'
         ::RSpec.configuration.add_formatter Pact::RSpec.formatter_class.const_get('NilFormatter')
       end
@@ -78,6 +79,7 @@ module Pact
       def pact_spec_options
         {
           full_backtrace: options[:backtrace],
+          verbose: options[:verbose] || ENV['VERBOSE'] == 'true',
           criteria: SpecCriteria.call(options),
           format: options[:format],
           out: options[:out],

data/lib/pact/pact_broker/pact_selection_description.rb

@@ -2,14 +2,14 @@ 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"
+            consumer = selector[:consumer] ? "of consumer #{selector[:consumer]}" : nil
             fallback = selector[:fallback] || selector[:fallbackTag]
             name = fallback ? "#{selector[:tag]} (or #{fallback} if not found)" : selector[:tag]
-            "#{all_or_latest} #{name}"
+            [all_or_latest, name, consumer].compact.join(" ")
           end.join(", ")
           if options[:include_wip_pacts_since]
             desc = "#{desc}, work in progress pacts created after #{options[:include_wip_pacts_since]}"

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

@@ -21,6 +21,8 @@ module Pact
         def call
           clean_reports_dir
           write
+        rescue StandardError => e
+          Pact.configuration.error_stream.puts("ERROR: Error generating help output - #{e.class} #{e.message} \n" + e.backtrace.join("\n"))
         end
 
         private

data/lib/pact/provider/pact_source.rb

@@ -1,6 +1,7 @@
 require 'pact/consumer_contract/pact_file'
 require 'pact/hal/http_client'
 require 'pact/hal/entity'
+require 'pact/consumer_contract'
 
 module Pact
   module Provider
@@ -20,6 +21,14 @@ module Pact
         @pact_hash ||= JSON.load(pact_json, nil, { max_nesting: 50 })
       end
 
+      def pending?
+        uri.metadata[:pending]
+      end
+
+      def consumer_contract
+        @consumer_contract ||= Pact::ConsumerContract.from_json(pact_json)
+      end
+
       def hal_entity
         http_client_keys = [:username, :password, :token]
         http_client_options = uri.options.reject{ |k, _| !http_client_keys.include?(k) }

data/lib/pact/provider/pact_spec_runner.rb

@@ -11,6 +11,7 @@ require 'pact/provider/verification_results/publish_all'
 require 'pact/provider/rspec/pact_broker_formatter'
 require 'pact/provider/rspec/json_formatter'
 require 'pact/provider/rspec'
+require 'pact/provider/rspec/calculate_exit_code'
 
 module Pact
   module Provider
@@ -74,11 +75,13 @@ module Pact
         end
 
         # For the Pact::Provider::RSpec::PactBrokerFormatter
+        Pact.provider_world.verbose = options[:verbose]
         Pact.provider_world.pact_sources = pact_sources
         jsons = pact_jsons
         executing_with_ruby = executing_with_ruby?
 
         config.after(:suite) do | suite |
+          Pact.provider_world.failed_examples = suite.reporter.failed_examples
           Pact::Provider::Help::Write.call(Pact.provider_world.pact_sources) if executing_with_ruby
         end
       end
@@ -90,7 +93,12 @@ module Pact
           ::RSpec::Core::CommandLine.new(NoConfigurationOptions.new)
             .run(::RSpec.configuration.output_stream, ::RSpec.configuration.error_stream)
         end
-        pending_mode? ? 0 : exit_code
+
+        if options[:ignore_failures]
+          0
+        else
+          Pact::Provider::RSpec::CalculateExitCode.call(pact_sources, Pact.provider_world.failed_examples)
+        end
       end
 
       def rspec_runner_options
@@ -147,8 +155,6 @@ 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)
@@ -159,20 +165,12 @@ 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

@@ -17,7 +17,7 @@ module Pact
       end
 
       def basic_auth?
-        !!username
+        !!username && !!password
       end
 
       def username
@@ -29,12 +29,23 @@ module Pact
       end
 
       def to_s
-        if basic_auth? && uri.start_with?('http://', 'https://')
+        if basic_auth? && http_or_https_uri?
           URI(@uri).tap { |x| x.userinfo="#{username}:*****"}.to_s
+        elsif personal_access_token? && http_or_https_uri?
+          URI(@uri).tap { |x| x.userinfo="*****"}.to_s
         else
           uri
         end
       end
+
+      private def personal_access_token?
+        !!username && !password
+      end
+
+      private def http_or_https_uri?
+        uri.start_with?('http://', 'https://')
+      end
+      
     end
   end
 end

data/lib/pact/provider/rspec.rb

@@ -26,15 +26,17 @@ module Pact
           Pact.configuration.output_stream.puts "INFO: Reading pact at #{pact_uri}"
           consumer_contract = Pact::ConsumerContract.from_json(pact_json)
           suffix = pact_uri.metadata[:pending] ? " [PENDING]": ""
+          example_group_description = "Verifying a pact between #{consumer_contract.consumer.name} and #{consumer_contract.provider.name}#{suffix}"
+          example_group_metadata = { pactfile_uri: pact_uri, pact_criteria: options[:criteria] }
 
-          ::RSpec.describe "Verifying a pact between #{consumer_contract.consumer.name} and #{consumer_contract.provider.name}#{suffix}", pactfile_uri: pact_uri do
+          ::RSpec.describe example_group_description, example_group_metadata do
             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
 
@@ -89,9 +91,8 @@ module Pact
             pact_interaction_example_description: interaction_description_for_rerun_command(interaction),
             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_criteria: options[:criteria]
+            pact_ignore_failures: options[:pact_source].pending? || options[:ignore_failures],
+            pact_consumer_contract: options[:consumer_contract]
           }
 
           describe description_for(interaction), metadata do
@@ -100,9 +101,6 @@ module Pact
             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/calculate_exit_code.rb

@@ -0,0 +1,18 @@
+module Pact
+  module Provider
+    module RSpec
+      module CalculateExitCode
+        def self.call(pact_sources, failed_examples)
+          any_non_pending_failures = pact_sources.any? do |pact_source|
+            if pact_source.pending?
+              nil
+            else
+              failed_examples.select { |e| e.metadata[:pact_source] == pact_source }.any?
+            end
+          end
+          any_non_pending_failures ? 1 : 0
+        end
+      end
+    end
+  end
+end

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

@@ -25,6 +25,7 @@ module Pact
         C = ::Term::ANSIColor
 
         def example_group_started(notification)
+          # This is the metadata on the top level "Verifying a pact between X and Y" describe block
           if @group_level == 0
             Pact.configuration.output_stream.puts
             pact_uri = notification.group.metadata[:pactfile_uri]
@@ -65,10 +66,6 @@ module Pact
           pending_interaction_examples(summary).size
         end
 
-        def ignore_failures?(summary)
-          summary.failed_examples.any?{ |e| e.metadata[:pact_ignore_failures] }
-        end
-
         def failure_title summary
           ::RSpec::Core::Formatters::Helpers.pluralize(failed_interactions_count(summary), "failure")
         end
@@ -96,12 +93,14 @@ module Pact
             interaction_rerun_commands(pending_interaction_examples(summary)).each do | message |
               output.puts(message)
             end
+            set_rspec_failure_color(:red)
           end
 
-          set_rspec_failure_color(:red)
-          output.puts("\nFailed interactions:\n\n")
-          interaction_rerun_commands(failed_interaction_examples(summary)).each do | message |
-            output.puts(message)
+          if failed_interactions_count(summary) > 0
+            output.puts("\nFailed interactions:\n\n")
+            interaction_rerun_commands(failed_interaction_examples(summary)).each do | message |
+              output.puts(message)
+            end
           end
         end
 
@@ -130,7 +129,7 @@ module Pact
         def interaction_rerun_commands examples
           examples.collect do |example|
             interaction_rerun_command_for example
-          end.compact
+          end.compact.uniq
         end
 
         def interaction_unique_key(example)

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

@@ -8,7 +8,7 @@ module Pact
   module RSpec
     module Matchers
       module RSpec2Delegator
-        # For backwards compatiblity with rspec-2
+        # For backwards compatibility with rspec-2
         def method_missing(method, *args, &block)
           if method_name == :failure_message_for_should
             failure_message method, *args, &block

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

@@ -25,7 +25,7 @@ module Pact
         end
 
         def close(_notification)
-          Pact::Provider::VerificationResults::PublishAll.call(Pact.provider_world.pact_sources, output_hash)
+          Pact::Provider::VerificationResults::PublishAll.call(Pact.provider_world.pact_sources, output_hash, { verbose: Pact.provider_world.verbose })
         end
 
       private

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

@@ -28,7 +28,23 @@ module Pact
         end
 
         def publishable?
-          executed_interactions_count == all_interactions_count && all_interactions_count > 0
+          if defined?(@publishable)
+            @publishable
+          else
+            @publishable = pact_source.consumer_contract.interactions.all? do | interaction |
+              examples_for_pact_uri.any?{ |e| example_is_for_interaction?(e, interaction) }
+            end && examples_for_pact_uri.count > 0
+          end
+        end
+
+        def example_is_for_interaction?(example, interaction)
+          # Use the Pact Broker id if supported
+          if interaction._id
+            example[:pact_interaction]._id == interaction._id
+          else
+            # fall back to object equality (based on the field values of the interaction)
+            example[:pact_interaction] == interaction
+          end
         end
 
         def examples_for_pact_uri
@@ -39,18 +55,6 @@ module Pact
           examples_for_pact_uri.count{ |e| e[:status] != 'passed' }
         end
 
-        def executed_interactions_count
-          examples_for_pact_uri
-            .collect { |e| e[:pact_interaction].object_id }
-            .uniq
-            .count
-        end
-
-        def all_interactions_count
-          interactions = (pact_source.pact_hash['interactions'] || pact_source.pact_hash['messages'])
-          interactions ? interactions.count : 0
-        end
-
         def test_results_hash_for_pact_uri
           {
             tests: examples_for_pact_uri.collect{ |e| clean_example(e) },

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

@@ -17,15 +17,15 @@ module Pact
         PROVIDER_RELATION = 'pb:provider'.freeze
         VERSION_TAG_RELATION = 'pb:version-tag'.freeze
 
-        def self.call pact_source, verification_result
-          new(pact_source, verification_result).call
+        def self.call pact_source, verification_result, options = {}
+          new(pact_source, verification_result, options).call
         end
 
-        def initialize pact_source, verification_result
+        def initialize pact_source, verification_result, options = {}
           @pact_source = pact_source
           @verification_result = verification_result
           http_client_options = pact_source.uri.options.reject{ |k, v| ![:username, :password, :token].include?(k) }
-          @http_client = Pact::Hal::HttpClient.new(http_client_options)
+          @http_client = Pact::Hal::HttpClient.new(http_client_options.merge(verbose: options[:verbose]))
           @pact_entity = Pact::Hal::Entity.new(pact_source.uri, pact_source.pact_hash, http_client)
         end
 
@@ -81,7 +81,7 @@ module Pact
             Pact.configuration.output_stream.puts "INFO: Tagging version #{provider_application_version} of #{provider_name} as #{tag.inspect}"
             tag_entity = tag_link.expand(version: provider_application_version, tag: tag).put
             unless tag_entity.success?
-              raise PublicationError.new("Error returned from tagging request #{tag_entity.response.code} #{tag_entity.response.body}")
+              raise PublicationError.new("Error returned from tagging request: status=#{tag_entity.response.code} body=#{tag_entity.response.body}")
             end
           end
         end

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

@@ -6,20 +6,21 @@ module Pact
     module VerificationResults
       class PublishAll
 
-        def self.call pact_sources, test_results_hash
-          new(pact_sources, test_results_hash).call
+        def self.call pact_sources, test_results_hash, options = {}
+          new(pact_sources, test_results_hash, options).call
         end
 
-        def initialize pact_sources, test_results_hash
+        def initialize pact_sources, test_results_hash, options = {}
           @pact_sources = pact_sources
           @test_results_hash = test_results_hash
+          @options = options
         end
 
         def call
           verification_results.collect do | (pact_source, verification_result) |
             published = false
             begin
-              published = Publish.call(pact_source, verification_result)
+              published = Publish.call(pact_source, verification_result, { verbose: options[:verbose] })
             ensure
               print_after_verification_notices(pact_source, verification_result, published)
             end
@@ -42,7 +43,7 @@ module Pact
           end
         end
 
-        attr_reader :pact_sources, :test_results_hash
+        attr_reader :pact_sources, :test_results_hash, :options
       end
     end
   end

data/lib/pact/provider/world.rb

@@ -14,7 +14,7 @@ module Pact
   module Provider
     class World
 
-      attr_accessor :pact_sources
+      attr_accessor :pact_sources, :failed_examples, :verbose
 
       def provider_states
         @provider_states_proxy ||= Pact::Provider::State::ProviderStateProxy.new

data/lib/pact/version.rb

@@ -1,4 +1,4 @@
 # Remember to bump pact-provider-proxy when this changes major version
 module Pact
-  VERSION = "1.55.0"
+  VERSION = "1.57.0"
 end

data/pact.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |gem|
   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-support', '~> 1.15'
   gem.add_runtime_dependency 'pact-mock_service', '~> 3.0', '>= 3.3.1'
 
   gem.add_development_dependency 'rake', '~> 13.0'
@@ -43,6 +43,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'faraday', '~> 0.13'
   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 'pact-message', '~> 0.8'
   gem.add_development_dependency 'rspec-its', '~> 1.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact
 version: !ruby/object:Gem::Version
-  version: 1.55.0
+  version: 1.57.0
 platform: ruby
 authors:
 - James Fraser
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-26 00:00:00.000000000 Z
+date: 2021-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -102,14 +102,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: pact-mock_service
   requirement: !ruby/object:Gem::Requirement
@@ -248,14 +248,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -352,6 +352,7 @@ files:
 - lib/pact/provider/request.rb
 - lib/pact/provider/rspec.rb
 - lib/pact/provider/rspec/backtrace_formatter.rb
+- lib/pact/provider/rspec/calculate_exit_code.rb
 - lib/pact/provider/rspec/custom_options_file
 - lib/pact/provider/rspec/formatter_rspec_2.rb
 - lib/pact/provider/rspec/formatter_rspec_3.rb
@@ -404,7 +405,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.7
 signing_key: 
 specification_version: 4
 summary: Enables consumer driven contract testing, providing a mock service and DSL