pact 1.19.1 → 1.19.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91a3bec55f1ec0ebd0ce051fc4b52613b8143bf2
-  data.tar.gz: 978814b2a193198db83d41d68b5c55315ae839b5
+  metadata.gz: 5600e03dfa36e82f5046524a577d8d0b3fbfb65c
+  data.tar.gz: 806e61b3debf79d48dbdf7d6782f842b51d4e878
 SHA512:
-  metadata.gz: a546703241a9770b086de20318f1eaa8d2223fc56800a446dcb6fd4466da28051778d08efc3c2ef0721064d1da4d22ef0bd953d96b51e813bb894ae96b2ba8b5
-  data.tar.gz: 39237141c5ac6febcf2c4209a4d5d9a1bd610689e394d247d8ddccff67b05954d7ae36e1a324c32e2eb69cad93d4f0ec546e3305c408db70599f9e2547faabd5
+  metadata.gz: 716c814749febf3a308cf0fd4ceef616483f1ddc44cb5bd4e06d8abe6a8b2ea2c76046c87dd5db1f34e1c469cd71aeffa1a69aa9c1bfb245b7de726117f6b877
+  data.tar.gz: 71b3a60fab8ce4def9d6718ca78f806215c28e83b47ebdef2c8c4436536339d577e0b1ac754d3c2d274e1b135308acbfdad42bbe2cc1a8dba2f5b9e3cba17ffa

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+<a name="v1.19.2"></a>
+### v1.19.2 (2017-11-16)
+
+
+#### Features
+
+* **publish test results**
+  * rename example to test in JSON	 ([cd2b79e](/../../commit/cd2b79e))
+  * remove ansi colours from error messages	 ([4416d04](/../../commit/4416d04))
+  * only publish for rspec 3	 ([31192d0](/../../commit/31192d0))
+  * only publish verification results when all interactions have been run	 ([0c56752](/../../commit/0c56752))
+  * enable test results to be published to the pact broker in the verification results	 ([e0dad27](/../../commit/e0dad27))
+
+
+#### Bug Fixes
+
+* **verifications**
+  * tag provider version, not consumer version	 ([b347588](/../../commit/b347588))
+
+
 <a name="v1.19.1"></a>
 ### v1.19.1 (2017-10-31)
 

data/lib/pact/provider/pact_spec_runner.rb

@@ -8,6 +8,7 @@ require 'pact/rspec'
 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'
 
@@ -61,6 +62,10 @@ module Pact
           config.output_stream = Pact.configuration.output_stream
         end
 
+        Pact::RSpec.with_rspec_3 do
+          ::RSpec.configuration.add_formatter Pact::Provider::RSpec::PactBrokerFormatter, StringIO.new
+        end
+
         if options[:format]
           ::RSpec.configuration.add_formatter options[:format]
           # Don't want to mess up the JSON parsing with messages to stdout, so send it to stderr
@@ -82,14 +87,12 @@ module Pact
           Pact.configuration.provider.app
         end
 
+        # For the Pact::Provider::RSpec::PactBrokerFormatter
+        Pact.provider_world.pact_sources = pact_sources
         jsons = pact_jsons
-        sources = pact_sources
 
         config.after(:suite) do | suite |
           Pact::Provider::Help::Write.call(jsons)
-          Pact::RSpec.with_rspec_3 do
-            Pact::Provider::VerificationResults::PublishAll.call(sources, ::RSpec.configuration.reporter.failed_examples)
-          end
         end
 
       end

data/lib/pact/provider/rspec.rb

@@ -25,7 +25,7 @@ module Pact
           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
-            honour_consumer_contract consumer_contract, options.merge(pact_json: pact_json)
+            honour_consumer_contract consumer_contract, options.merge(pact_json: pact_json, pact_uri: pact_uri)
           end
         end
 
@@ -61,19 +61,24 @@ module Pact
 
         def describe_interaction interaction, options
 
+          # pact_uri and pact_interaction are used by
+          # Pact::Provider::RSpec::PactBrokerFormatter
+
+          # pact_interaction_example_description is used by
+          # Pact::Provider::RSpec::Formatter and Pact::Provider::RSpec::Formatter2
+
+          # pact: verify is used to allow RSpec before and after hooks.
           metadata = {
             pact: :verify,
             pact_interaction: interaction,
             pact_interaction_example_description: interaction_description_for_rerun_command(interaction),
-            pact_json: options[:pact_json]
+            pact_uri: options[:pact_uri]
           }
 
           describe description_for(interaction), metadata do
 
-
             describe "with #{interaction.request.method_and_path}" do
 
-
               interaction_context = InteractionContext.new
 
               before do | example |

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

@@ -0,0 +1,67 @@
+require 'rspec/core/formatters'
+require 'pact/provider/verification_results/publish_all'
+require 'term/ansicolor'
+
+module Pact
+  module Provider
+    module RSpec
+      class PactBrokerFormatter < ::RSpec::Core::Formatters::BaseFormatter
+        Pact::RSpec.with_rspec_3 do
+          ::RSpec::Core::Formatters.register self, :message, :dump_summary, :stop, :seed, :close
+        end
+
+        attr_reader :output_hash
+
+        def initialize(output)
+          super
+          @output_hash = {
+            :version => ::RSpec::Core::Version::STRING
+          }
+        end
+
+        def message(notification)
+          (@output_hash[:messages] ||= []) << notification.message
+        end
+
+        def dump_summary(summary)
+        end
+
+        def stop(notification)
+          @output_hash[:tests] = notification
+                                  .examples
+                                  .map { |example| format_example(example) }
+        end
+
+        def seed(notification)
+          return unless notification.seed_used?
+          @output_hash[:seed] = notification.seed
+        end
+
+        def close(_notification)
+          Pact::Provider::VerificationResults::PublishAll.call(Pact.provider_world.pact_sources, output_hash)
+        end
+
+      private
+
+        def format_example(example)
+          {
+            testDescription: example.description,
+            testFullDescription: example.full_description,
+            status: example.execution_result.status.to_s,
+            interactionProviderState: example.metadata[:pact_interaction].provider_state,
+            interactionDescription: example.metadata[:pact_interaction].description,
+            pact_uri: example.metadata[:pact_uri],
+            pact_interaction: example.metadata[:pact_interaction]
+          }.tap do |hash|
+            if example.exception
+              hash[:exception] =  {
+                class: example.exception.class.name,
+                message: ::Term::ANSIColor.uncolor(example.exception.message)
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -4,38 +4,67 @@ module Pact
     module VerificationResults
       class Create
 
-        def self.call pact_json, failed_examples
-          new(pact_json, failed_examples).call
+        def self.call pact_source, test_results_hash
+          new(pact_source, test_results_hash).call
         end
 
-        def initialize pact_json, failed_examples
-          @pact_json = pact_json
-          @failed_examples = failed_examples
+        def initialize pact_source, test_results_hash
+          @pact_source = pact_source
+          @test_results_hash = test_results_hash
         end
 
         def call
-          VerificationResult.new(!any_failures?, Pact.configuration.provider.application_version)
+          VerificationResult.new(publishable?, !any_failures?, Pact.configuration.provider.application_version, test_results_hash_for_pact_uri)
         end
 
         private
 
-        def pact_hash
-          @pact_hash ||= json_load(pact_json)
+        def pact_uri
+          @pact_uri ||= pact_source.uri
         end
 
-        def json_load json
-          JSON.load(json, nil, { max_nesting: 50 })
+        def any_failures?
+          count_failures_for_pact_uri > 0
         end
 
-        def count_failures_for_pact_json
-          failed_examples.collect{ |e| e.metadata[:pact_json] == pact_json }.uniq.size
+        def publishable?
+          executed_interactions_count == all_interactions_count && all_interactions_count > 0
         end
 
-        def any_failures?
-          count_failures_for_pact_json > 0
+        def examples_for_pact_uri
+          @examples_for_pact_uri ||= test_results_hash[:tests].select{ |e| e[:pact_uri] == pact_uri }
+        end
+
+        def count_failures_for_pact_uri
+          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
+          pact_source.pact_hash['interactions'].count
+        end
+
+        def test_results_hash_for_pact_uri
+          {
+            tests: examples_for_pact_uri.collect{ |e| clean_example(e) },
+            summary: {
+              testCount: examples_for_pact_uri.size,
+              failureCount: count_failures_for_pact_uri
+            }
+          }
+        end
+
+        def clean_example(example)
+          example.reject{ |k, v| k == :pact_uri || k == :pact_interaction }
         end
 
-        attr_reader :pact_json, :failed_examples
+        attr_reader :pact_source, :test_results_hash
       end
     end
   end

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

@@ -22,32 +22,50 @@ module Pact
         end
 
         def call
-          if Pact.configuration.provider.publish_verification_results?
-            if Pact.configuration.provider.tags.any?
-              if tag_url('')
-                tag_versions
-              else
-                Pact.configuration.error_stream.puts "WARN: Cannot tag provider version as there is no link named pb:tag-version in the pact JSON."
-              end
-            end
-
-            if publication_url
-              publish
-            else
-              Pact.configuration.error_stream.puts "WARN: Cannot publish verification for #{consumer_name} as there is no link named pb:publish-verification-results in the pact JSON. If you are using a pact broker, please upgrade to version 2.0.0 or later."
-            end
+          if can_publish_verification_results?
+            tag_versions_if_configured
+            publish_verification_results
           end
         end
 
         private
 
+        def can_publish_verification_results?
+          return false unless Pact.configuration.provider.publish_verification_results?
+
+          if publication_url.nil?
+            Pact.configuration.error_stream.puts "WARN: Cannot publish verification for #{consumer_name} as there is no link named pb:publish-verification-results in the pact JSON. If you are using a pact broker, please upgrade to version 2.0.0 or later."
+            return false
+          end
+
+          if !verification_result.publishable?
+            Pact.configuration.error_stream.puts "WARN: Cannot publish verification for #{consumer_name} as not all interactions have been verified. Re-run the verification without the filter parameters or environment variables to publish the verification."
+            return false
+          end
+          true
+        end
+
         def publication_url
           @publication_url ||= pact_source.pact_hash.fetch('_links', {}).fetch('pb:publish-verification-results', {})['href']
         end
 
         def tag_url tag
-          href = pact_source.pact_hash.fetch('_links', {}).fetch('pb:tag-version', {})['href']
-          href ? href.gsub('{tag}', tag) : nil
+          # This is so dodgey, need to use proper HAL
+          if publication_url
+            u = URI(publication_url)
+            if match = publication_url.match(%r{/provider/([^/]+)})
+              provider_name = match[1]
+              base_url = "#{u.scheme}://#{u.host}:#{u.host == u.default_port ? '' : u.port}"
+              provider_application_version = Pact.configuration.provider.application_version
+              "#{base_url}/pacticipants/#{provider_name}/versions/#{provider_application_version}/tags/#{tag}"
+            end
+          end
+        end
+
+        def tag_versions_if_configured
+          if Pact.configuration.provider.tags.any?
+            tag_versions if tag_url('')
+          end
         end
 
         def tag_versions
@@ -71,9 +89,9 @@ module Pact
           end
         end
 
-        def publish
+        def publish_verification_results
           uri = URI(publication_url)
-          request = build_request('Post', uri, verification_result.to_json, "Publishing verification result #{verification_result.to_json} to")
+          request = build_request('Post', uri, verification_result.to_json, "Publishing verification result #{verification_result} to")
           response = nil
           begin
             options = {:use_ssl => uri.scheme == 'https'}
@@ -81,12 +99,17 @@ module Pact
               http.request request
             end
           rescue StandardError => e
-            error_message = "Failed to publish verification result due to: #{e.class} #{e.message}"
+            error_message = "Failed to publish verification results due to: #{e.class} #{e.message}"
             raise PublicationError.new(error_message)
           end
 
-          unless response.code.start_with?("2")
-            raise PublicationError.new("Error returned from verification result publication #{response.code} #{response.body}")
+
+
+          if response.code.start_with?("2")
+            new_resource_url = JSON.parse(response.body)['_links']['self']['href']
+            $stdout.puts "INFO: Verification results published to #{new_resource_url}"
+          else
+            raise PublicationError.new("Error returned from verification results publication #{response.code} #{response.body}")
           end
         end
 

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

@@ -6,19 +6,18 @@ module Pact
     module VerificationResults
       class PublishAll
 
-        def self.call pact_sources, rspec_summary
-          new(pact_sources, rspec_summary).call
+        def self.call pact_sources, test_results_hash
+          new(pact_sources, test_results_hash).call
         end
 
-        def initialize pact_sources, rspec_summary
+        def initialize pact_sources, test_results_hash
           @pact_sources = pact_sources
-          @rspec_summary = rspec_summary
+          @test_results_hash = test_results_hash
         end
 
-        # TODO do not publish unless all interactions have been run
         def call
-          verification_results.collect do | pair |
-            Publish.call(pair.first, pair.last)
+          verification_results.collect do | (pact_source, verification_result) |
+            Publish.call(pact_source, verification_result)
           end
         end
 
@@ -26,11 +25,11 @@ module Pact
 
         def verification_results
           pact_sources.collect do | pact_source |
-            [pact_source, Create.call(pact_source.pact_json, rspec_summary)]
+            [pact_source, Create.call(pact_source, test_results_hash)]
           end
         end
 
-        attr_reader :pact_sources, :rspec_summary
+        attr_reader :pact_sources, :test_results_hash
       end
     end
   end

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

@@ -1,11 +1,19 @@
+require 'json'
+
 module Pact
   module Provider
     module VerificationResults
       class VerificationResult
 
-        def initialize success, provider_application_version
+        def initialize publishable, success, provider_application_version, test_results_hash
+          @publishable = publishable
           @success = success
           @provider_application_version = provider_application_version
+          @test_results_hash = test_results_hash
+        end
+
+        def publishable?
+          @publishable
         end
 
         def provider_application_version_set?
@@ -15,13 +23,18 @@ module Pact
         def to_json
           {
             success: success,
-            providerApplicationVersion: provider_application_version
+            providerApplicationVersion: provider_application_version,
+            #testResults: test_results_hash # not yet
           }.to_json
         end
 
+        def to_s
+          "[success: #{success}, providerApplicationVersion: #{provider_application_version}]"
+        end
+
         private
 
-        attr_reader :success, :provider_application_version
+        attr_reader :success, :provider_application_version, :test_results_hash
       end
     end
   end

data/lib/pact/provider/world.rb

@@ -14,6 +14,8 @@ module Pact
   module Provider
     class World
 
+      attr_accessor :pact_sources
+
       def provider_states
         @provider_states_proxy ||= Pact::Provider::State::ProviderStateProxy.new
       end
@@ -29,7 +31,6 @@ module Pact
       def pact_urls
         pact_verifications.collect(&:uri)
       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.19.1"
+  VERSION = "1.19.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact
 version: !ruby/object:Gem::Version
-  version: 1.19.1
+  version: 1.19.2
 platform: ruby
 authors:
 - James Fraser
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-31 00:00:00.000000000 Z
+date: 2017-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: randexp
@@ -366,6 +366,7 @@ files:
 - lib/pact/provider/rspec/formatter_rspec_2.rb
 - lib/pact/provider/rspec/formatter_rspec_3.rb
 - lib/pact/provider/rspec/matchers.rb
+- lib/pact/provider/rspec/pact_broker_formatter.rb
 - lib/pact/provider/state/provider_state.rb
 - lib/pact/provider/state/provider_state_configured_modules.rb
 - lib/pact/provider/state/provider_state_manager.rb