pact 1.28.0 → 1.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5574afeb058510333631c49794bddac105131115
-  data.tar.gz: 89806235aea0cdbee6639a035e2f5a8a31d1111b
+  metadata.gz: b4544628feb78e41d434d8df2fa467c3795b0849
+  data.tar.gz: 22c2d7a7caa71c7da7dd33e232a44ba5374f3fd9
 SHA512:
-  metadata.gz: '0390c191e18ee7442e1a72ec3aca47094d1e540f84d7c47c5b4284e0263f177464fb3230892e0266d6aa7c880e28beeabbebb17d394878e644ba339028019728'
-  data.tar.gz: fd382cd61c88b3ad551c0de1c6490567d4f09d5b1f5bf1b1ea58b9ff3b4f77339f74c7b432b53b94355d42aea0f9f1816bd1a3c6f4b7203c461d4352a2333064
+  metadata.gz: e1e6ddfcaad18582eb50938d8599e02d19a68efc4053f26e677ccd44125d3c855d4447a13e11a900652612ba1eec1d13759d18fbf32824f8d4c686d06601f9fc
+  data.tar.gz: 572c7b4c21f1143d3352620f4596f923917dc974c590b78a2cc9cd2fed071d9d5a5cf2ffe41e369e9cfda4ae6201713760ff3e263a6a74a34ccec747b5b3bcd4

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+<a name="v1.29.0"></a>
+### v1.29.0 (2018-07-24)
+
+
+#### Features
+
+* return plain string URLs from Pact::PactBroker.fetch_pact_uris	 ([1aa1989](/../../commit/1aa1989))
+* use beta:wip-provider-pacts rather than pb:wip-provider-pacts to fetch WIP pacts	 ([3bb0501](/../../commit/3bb0501))
+* allow WIP pacts to be verified without causing the process to return an non zero exit code	 ([9e6de46](/../../commit/9e6de46))
+
+
+#### Bug Fixes
+
+* add missing require	 ([0aa2d2a](/../../commit/0aa2d2a))
+* default pact specification version to 2	 ([917891a](/../../commit/917891a))
+
+
 <a name="v1.28.0"></a>
 ### v1.28.0 (2018-06-24)
 

data/lib/pact/cli.rb

@@ -8,6 +8,7 @@ module Pact
     desc 'verify', "Verify a pact"
     method_option :pact_helper, aliases: "-h", desc: "Pact helper file", :required => true
     method_option :pact_uri, aliases: "-p", desc: "Pact URI"
+    method_option :wip, type: :boolean, default: false, desc: "If WIP, process will always exit with exit code 0", hide: true
     method_option :pact_broker_username, aliases: "-u", desc: "Pact broker user name"
     method_option :pact_broker_password, aliases: "-w", desc: "Pact broker password"
     method_option :backtrace, aliases: "-b", desc: "Show full backtrace", :default => false, :type => :boolean
@@ -33,6 +34,5 @@ module Pact
       require 'pact/doc/generator'
       Pact::Doc::Generate.call(options[:pact_dir], options[:doc_dir], [Pact::Doc::Markdown::Generator])
     end
-
   end
 end

data/lib/pact/cli/run_pact_verification.rb

@@ -71,7 +71,8 @@ module Pact
           full_backtrace: options[:backtrace],
           criteria: SpecCriteria.call(options),
           format: options[:format],
-          out: options[:out]
+          out: options[:out],
+          wip: options[:wip]
         }
       end
     end

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

@@ -20,7 +20,7 @@ module Pact
           @port = nil
           @standalone = false
           @verify = true
-          @pact_specification_version = nil
+          @pact_specification_version = '2'
           @finalized = false
         end
 

data/lib/pact/hal/entity.rb

@@ -48,8 +48,8 @@ module Pact
         @response
       end
 
-      def fetch(key)
-        @links[key]
+      def fetch(key, fallback_key = nil)
+        @links[key] || (fallback_key && @links[fallback_key])
       end
 
       def method_missing(method_name, *args, &block)

data/lib/pact/pact_broker.rb

@@ -0,0 +1,19 @@
+require 'pact/pact_broker/fetch_pacts'
+require 'pact/pact_broker/fetch_wip_pacts'
+
+#
+# @public Use by Pact Provider Verifier
+#
+module Pact
+  module PactBroker
+    extend self
+
+    def fetch_pact_uris *args
+      Pact::PactBroker::FetchPacts.call(*args).collect(&:uri)
+    end
+
+    def fetch_wip_pact_uris *args
+      Pact::PactBroker::FetchWipPacts.call(*args).collect(&:uri)
+    end
+  end
+end

data/lib/pact/pact_broker/fetch_pacts.rb

@@ -11,6 +11,7 @@ module Pact
       LATEST_PROVIDER_TAG_RELATION = 'pb:latest-provider-pacts-with-tag'.freeze
       LATEST_PROVIDER_RELATION = 'pb:latest-provider-pacts'.freeze
       PACTS = 'pacts'.freeze
+      PB_PACTS = 'pb:pacts'.freeze
       HREF = 'href'.freeze
 
       def initialize(provider, tags, broker_base_url, http_client_options)
@@ -33,11 +34,11 @@ module Pact
 
       def call
         log_message
-        if get_index.success?
+        if index.success?
           if any_tags?
-            get_tagged_pacts_for_provider
+            tagged_pacts_for_provider
           else
-            get_latest_pacts_for_provider
+            latest_pacts_for_provider
           end
         else
           raise Pact::Error.new("Error retrieving #{broker_base_url} status=#{index_entity.response.code} #{index_entity.response.raw_body}")
@@ -50,18 +51,18 @@ module Pact
         tags && tags.any?
       end
 
-      def get_tagged_pacts_for_provider
+      def tagged_pacts_for_provider
         tags.collect do |tag|
-          link = get_link(tag)
-          urls = get_pact_urls(link.expand(provider: provider, tag: tag[:name]).get)
-          if urls == [] && tag[:fallback]
-            urls = get_pact_urls(link.expand(provider: provider, tag: tag[:fallback]).get)
+          link = link_for(tag)
+          urls = pact_urls(link.expand(provider: provider, tag: tag[:name]).get)
+          if urls.empty? && tag[:fallback]
+            urls = pact_urls(link.expand(provider: provider, tag: tag[:fallback]).get)
           end
           urls
         end.flatten
       end
 
-      def get_link(tag)
+      def link_for(tag)
         if !tag[:all]
           index_entity._link(LATEST_PROVIDER_TAG_RELATION)
         else
@@ -69,17 +70,17 @@ module Pact
         end
       end
 
-      def get_index
-        @index_entity = Pact::Hal::Link.new({ "href" => broker_base_url }, http_client).get
+      def index
+        @index_entity ||= Pact::Hal::Link.new({ "href" => broker_base_url }, http_client).get
       end
 
-      def get_latest_pacts_for_provider
+      def latest_pacts_for_provider
         link = index_entity._link(LATEST_PROVIDER_RELATION)
-        get_pact_urls(link.expand(provider: provider).get)
+        pact_urls(link.expand(provider: provider).get)
       end
 
-      def get_pact_urls(link_by_provider)
-        link_by_provider.fetch(PACTS).collect do |pact|
+      def pact_urls(link_by_provider)
+        link_by_provider.fetch(PB_PACTS, PACTS).collect do |pact|
           Pact::Provider::PactURI.new(pact[HREF], http_client_options)
         end
       end

data/lib/pact/pact_broker/fetch_wip_pacts.rb

@@ -0,0 +1,56 @@
+require 'pact/hal/entity'
+require 'pact/hal/http_client'
+require 'pact/provider/pact_uri'
+
+module Pact
+  module PactBroker
+    class FetchWipPacts
+      attr_reader :provider, :tags, :broker_base_url, :http_client_options, :http_client, :index_entity
+
+      WIP_PROVIDER_RELATION = 'beta:wip-provider-pacts'.freeze
+      PACTS = 'pacts'.freeze
+      PB_PACTS = 'pb:pacts'.freeze
+      HREF = 'href'.freeze
+
+      def initialize(provider, broker_base_url, http_client_options)
+        @provider = provider
+        @http_client_options = http_client_options
+        @broker_base_url = broker_base_url
+        @http_client = Pact::Hal::HttpClient.new(http_client_options)
+      end
+
+      def self.call(provider, broker_base_url, http_client_options)
+        new(provider, broker_base_url, http_client_options).call
+      end
+
+      def call
+        if index.success?
+          wip_pacts_for_provider
+        else
+          raise Pact::Error.new("Error retrieving #{broker_base_url} status=#{index_entity.response.code} #{index_entity.response.raw_body}")
+        end
+      end
+
+      private
+
+      def index
+        @index_entity ||= Pact::Hal::Link.new({ "href" => broker_base_url }, http_client).get
+      end
+
+      def wip_pacts_for_provider
+        link = index_entity._link(WIP_PROVIDER_RELATION)
+        if link
+          get_pact_urls(link.expand(provider: provider).get)
+        else
+          []
+        end
+      end
+
+      def get_pact_urls(link_by_provider)
+        link_by_provider.fetch(PB_PACTS, PACTS).collect do |pact|
+          Pact::Provider::PactURI.new(pact[HREF], http_client_options)
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider/pact_spec_runner.rb

@@ -36,6 +36,7 @@ module Pact
         ensure
           ::RSpec.reset
           Pact.clear_provider_world
+          Pact.clear_consumer_world
         end
       end
 
@@ -90,7 +91,7 @@ module Pact
           ::RSpec::Core::CommandLine.new(NoConfigurationOptions.new)
             .run(::RSpec.configuration.output_stream, ::RSpec.configuration.error_stream)
         end
-        exit_code
+        options[:wip] ? 0 : exit_code
       end
 
       def rspec_runner_options
@@ -118,7 +119,8 @@ module Pact
       def initialize_specs
         pact_sources.each do | pact_source |
           options = {
-            criteria: @options[:criteria]
+            criteria: @options[:criteria],
+            wip: @options[:wip]
           }
           honour_pactfile pact_source.uri, ordered_pact_json(pact_source.pact_json), options
         end
@@ -144,6 +146,8 @@ module Pact
         end
 
         ::RSpec.configuration.full_backtrace = @options[:full_backtrace]
+
+        ::RSpec.configuration.failure_color = :yellow if @options[:wip]
       end
 
       def ordered_pact_json(pact_json)

data/lib/pact/provider/rspec.rb

@@ -21,10 +21,11 @@ module Pact
         include ::RSpec::Core::DSL
 
         def honour_pactfile pact_uri, pact_json, options
-          Pact.configuration.output_stream.puts "INFO: Reading pact at #{pact_uri}"
+          pact_description = options[:wip] ? "WIP pact" : "pact"
+          Pact.configuration.output_stream.puts "INFO: Reading #{pact_description} at #{pact_uri}"
           Pact.configuration.output_stream.puts "INFO: Filtering interactions by: #{options[:criteria]}" if options[:criteria] && options[:criteria].any?
           consumer_contract = Pact::ConsumerContract.from_json(pact_json)
-          ::RSpec.describe "Verifying a pact between #{consumer_contract.consumer.name} and #{consumer_contract.provider.name}", pactfile_uri: pact_uri do
+          ::RSpec.describe "Verifying a #{pact_description} between #{consumer_contract.consumer.name} and #{consumer_contract.provider.name}", pactfile_uri: pact_uri do
             honour_consumer_contract consumer_contract, options.merge(pact_json: pact_json, pact_uri: pact_uri)
           end
         end
@@ -72,7 +73,8 @@ module Pact
             pact: :verify,
             pact_interaction: interaction,
             pact_interaction_example_description: interaction_description_for_rerun_command(interaction),
-            pact_uri: options[:pact_uri]
+            pact_uri: options[:pact_uri],
+            pact_wip: options[:wip]
           }
 
           describe description_for(interaction), metadata do

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

@@ -42,9 +42,21 @@ module Pact
           summary.failed_examples.collect{ |e| e.metadata[:pact_interaction_example_description] }.uniq.size
         end
 
+        def wip?(summary)
+          summary.failed_examples.any?{ |e| e.metadata[:pact_wip] }
+        end
+
+        def failure_title summary
+          if wip?(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 wip?(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

data/lib/pact/retry.rb

@@ -1,3 +1,5 @@
+require 'pact/errors'
+
 module Pact
   class Retry
     class RescuableError

data/lib/pact/tasks/task_helper.rb

@@ -10,8 +10,8 @@ module Pact
 
     extend self
 
-    def execute_pact_verify pact_uri = nil, pact_helper = nil, rspec_opts = nil
-      execute_cmd verify_command(pact_helper || Pact::Provider::PactHelperLocater.pact_helper_path, pact_uri, rspec_opts)
+    def execute_pact_verify pact_uri = nil, pact_helper = nil, rspec_opts = nil, verification_opts = {}
+      execute_cmd verify_command(pact_helper || Pact::Provider::PactHelperLocater.pact_helper_path, pact_uri, rspec_opts, verification_opts)
     end
 
     def handle_verification_failure
@@ -19,7 +19,7 @@ module Pact
       abort if exit_status != 0
     end
 
-    def verify_command pact_helper, pact_uri, rspec_opts
+    def verify_command pact_helper, pact_uri, rspec_opts, verification_opts
       command_parts = []
       # Clear SPEC_OPTS, otherwise we can get extra formatters, creating duplicate output eg. CI Reporting.
       # Allow deliberate configuration using rspec_opts in VerificationTask.
@@ -28,6 +28,7 @@ module Pact
       command_parts << "-S pact verify"
       command_parts << "--pact-helper" << Shellwords.escape(pact_helper.end_with?(".rb") ? pact_helper : pact_helper + ".rb")
       (command_parts << "--pact-uri" << pact_uri) if pact_uri
+      command_parts << "--wip" if verification_opts[:wip]
       command_parts << "--pact-broker-username" << ENV['PACT_BROKER_USERNAME'] if ENV['PACT_BROKER_USERNAME']
       command_parts << "--pact-broker-password" << ENV['PACT_BROKER_PASSWORD'] if ENV['PACT_BROKER_PASSWORD']
       command_parts << "--backtrace" if ENV['BACKTRACE'] == 'true'

data/lib/pact/tasks/verification_task.rb

@@ -30,9 +30,11 @@ module Pact
 
     attr_reader :pact_spec_configs
     attr_accessor :rspec_opts
+    attr_accessor :wip
 
     def initialize(name)
       @rspec_opts = nil
+      @wip = false
       @pact_spec_configs = []
       @name = name
       yield self
@@ -74,7 +76,7 @@ module Pact
           require 'pact/tasks/task_helper'
 
           exit_statuses = pact_spec_configs.collect do | config |
-            Pact::TaskHelper.execute_pact_verify config[:uri], config[:pact_helper], rspec_opts
+            Pact::TaskHelper.execute_pact_verify config[:uri], config[:pact_helper], rspec_opts, { wip: wip }
           end
 
           Pact::TaskHelper.handle_verification_failure do

data/lib/pact/version.rb

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

data/pact.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'rake', '~> 10.0.3'
   gem.add_development_dependency 'webmock', '~> 3.0'
-  gem.add_development_dependency 'pry-byebug'
+  #gem.add_development_dependency 'pry-byebug'
   gem.add_development_dependency 'fakefs', '0.5' # 0.6.0 blows up
   gem.add_development_dependency 'hashie', '~> 2.0'
   gem.add_development_dependency 'activesupport'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact
 version: !ruby/object:Gem::Version
-  version: 1.28.0
+  version: 1.29.0
 platform: ruby
 authors:
 - James Fraser
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-28 00:00:00.000000000 Z
+date: 2018-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: randexp
@@ -174,20 +174,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: fakefs
   requirement: !ruby/object:Gem::Requirement
@@ -335,7 +321,9 @@ files:
 - lib/pact/hal/entity.rb
 - lib/pact/hal/http_client.rb
 - lib/pact/hal/link.rb
+- lib/pact/pact_broker.rb
 - lib/pact/pact_broker/fetch_pacts.rb
+- lib/pact/pact_broker/fetch_wip_pacts.rb
 - lib/pact/project_root.rb
 - lib/pact/provider.rb
 - lib/pact/provider/configuration.rb