pact 1.0.22 → 1.0.23

data/CHANGELOG.md

@@ -2,6 +2,10 @@ Do this to generate your change history
 
     git log --date=relative --pretty=format:'  * %h - %s (%an, %ad)'
 
+### 1.0.23 (29 November 2013)
+
+* a978654 - Improving the display of verification errors in the consumer project. (Beth Skurrie, 2 days ago)
+
 ### 1.0.22 (25 November 2013)
 
 * f742833 - Updating README (Beth Skurrie, 36 seconds ago)

data/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
-
+source 'http://rea-rubygems'
 # Specify your gem's dependencies in pact.gemspec
 gemspec
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pact (1.0.22)
+    pact (1.0.23)
       awesome_print (~> 1.1.0)
       find_a_port (~> 1.0.1)
       json
@@ -13,6 +13,7 @@ PATH
 
 GEM
   remote: https://rubygems.org/
+  remote: http://rea-rubygems/
   specs:
     activesupport (4.0.0)
       i18n (~> 0.6, >= 0.6.4)

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

@@ -4,6 +4,7 @@ module Pact
 
       attr_reader :interactions
       attr_reader :unexpected_requests
+      attr_reader :interaction_mismatches
 
       def initialize
         clear
@@ -13,6 +14,7 @@ module Pact
       def clear
         @interactions = []
         @matched_interactions = []
+        @interaction_mismatches = []
         @unexpected_requests = []
       end
 
@@ -28,18 +30,35 @@ module Pact
         @unexpected_requests << request
       end
 
+      def register_interaction_mismatch interaction_mismatch
+        @interaction_mismatches << interaction_mismatch
+      end
+
       def all_matched?
         interaction_diffs.empty?
       end
 
       def missing_interactions
-        @interactions - @matched_interactions
+        @interactions - @matched_interactions - @interaction_mismatches.collect(&:candidate_interactions).flatten
+      end
+
+      def missing_interactions_summaries
+        missing_interactions.collect(&:request).collect(&:method_and_path)
+      end
+
+      def interaction_mismatches_summaries
+        interaction_mismatches.collect(&:short_summary)
+      end
+
+      def unexpected_requests_summaries
+        unexpected_requests.collect(&:method_and_path)
       end
 
       def interaction_diffs
         {
-          :missing_interactions => missing_interactions.collect(&:as_json),
-          :unexpected_requests => unexpected_requests.collect(&:as_json)
+          :missing_interactions => missing_interactions_summaries,
+          :interaction_mismatches => interaction_mismatches_summaries,
+          :unexpected_requests => unexpected_requests_summaries
         }.inject({}) do | hash, pair |
           hash[pair.first] = pair.last if pair.last.any?
           hash
@@ -49,9 +68,9 @@ module Pact
       def find_candidate_interactions actual_request
         interactions.select do | interaction |
           interaction.request.matches_route? actual_request
-        end        
-      end      
+        end
+      end
 
-    end    
+    end
   end
 end

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

@@ -0,0 +1,51 @@
+module Pact
+  module Consumer
+    class InteractionMismatch
+
+      attr_accessor :candidate_interactions, :actual_request
+
+      # Assumes the method and path matches...
+
+      def initialize candidate_interactions, actual_request
+        @candidate_interactions = candidate_interactions
+        @actual_request = actual_request
+        @candiate_diffs = candidate_interactions.collect{ | candidate_interaction| CandidateDiff.new(candidate_interaction, actual_request)}
+      end
+
+      def diffs
+        candiate_diffs.collect(&:diff_summary)
+      end
+
+      def short_summary
+        mismatched_attributes = candiate_diffs.collect(&:mismatched_attributes).flatten.uniq.join(", ").reverse.sub(",", "dna ").reverse #OMG what a hack!
+        actual_request.method_and_path + " (#{mismatched_attributes} did not match)"
+      end
+
+      private
+
+      attr_accessor :candiate_diffs
+
+      class CandidateDiff
+        attr_accessor :candidate_interaction, :actual_request
+        def initialize candidate_interaction, actual_request
+          @candidate_interaction = candidate_interaction
+          @actual_request = actual_request
+        end
+
+        def mismatched_attributes
+          diff.keys
+        end
+
+        def diff_summary
+          summary = {:description => candidate_interaction.description}
+          summary[:provider_state] = candidate_interaction.provider_state if candidate_interaction.provider_state
+          summary.merge(diff)
+        end
+
+        def diff
+          @diff ||= candidate_interaction.request.difference(actual_request)
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,6 @@
 require 'pact/matchers'
 require 'pact/consumer/mock_service/rack_request_helper'
+require 'pact/consumer/mock_service/interaction_mismatch'
 
 module Pact
   module Consumer
@@ -70,11 +71,8 @@ module Pact
         multiple_interactions_found_response actual_request, matching_interactions
       end
 
-      def interaction_diffs actual_request, candidate_interactions
-        candidate_interactions.collect do | candidate_interaction |
-          diff = candidate_interaction.request.difference(actual_request)
-          diff_summary_for candidate_interaction, diff
-        end
+      def interaction_mismatch actual_request, candidate_interactions
+        InteractionMismatch.new(candidate_interactions, actual_request)
       end
 
       def diff_summary_for interaction, diff
@@ -90,25 +88,29 @@ module Pact
         summary
       end
 
-      def unrecognised_request_response actual_request, interaction_diffs
+      def unrecognised_request_response interaction_mismatch
         response = {
-          message: "No interaction found for #{actual_request.method_and_path}",
-          interaction_diffs:  interaction_diffs
+          message: "No interaction found for #{interaction_mismatch.actual_request.method_and_path}",
+          interaction_diffs:  interaction_mismatch.diffs
         }
         [500, {'Content-Type' => 'application/json'}, [response.to_json]]
       end
 
-      def log_unrecognised_request_and_interaction_diff actual_request, interaction_diffs, candidate_interactions
-        logger.error "No interaction found on #{name} for #{actual_request.method_and_path}"
+      def log_unrecognised_request_and_interaction_diff interaction_mismatch
+        logger.error "No interaction found on #{name} for #{interaction_mismatch.actual_request.method_and_path}"
         logger.error 'Interaction diffs for that route:'
-        logger.ap(interaction_diffs, :error)
+        logger.ap(interaction_mismatch.diffs, :error)
       end
 
       def handle_unrecognised_request actual_request, candidate_interactions
-        interaction_list.register_unexpected_request actual_request
-        interaction_diffs = interaction_diffs(actual_request, candidate_interactions)
-        log_unrecognised_request_and_interaction_diff actual_request, interaction_diffs, candidate_interactions
-        unrecognised_request_response actual_request, interaction_diffs
+        interaction_mismatch = interaction_mismatch(actual_request, candidate_interactions)
+        if candidate_interactions.any?
+          interaction_list.register_interaction_mismatch interaction_mismatch
+        else
+          interaction_list.register_unexpected_request actual_request
+        end
+        log_unrecognised_request_and_interaction_diff interaction_mismatch
+        unrecognised_request_response interaction_mismatch
       end
 
       def response_from response

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

@@ -26,9 +26,19 @@ module Pact
           logger.info "Verifying - interactions matched for example \"#{example_description(env)}\""
           [200, {}, ['Interactions matched']]
         else
-          logger.warn "Verifying - actual interactions do not match expected interactions for example \"#{example_description(env)}\". Interaction diffs:"
-          logger.ap interaction_list.interaction_diffs, :warn
-          [500, {}, ["Actual interactions do not match expected interactions for mock #{name}. See #{log_description} for details."]]
+
+          missing_interactions_summaries = interaction_list.missing_interactions_summaries
+          interaction_mismatches_summaries = interaction_list.interaction_mismatches_summaries
+          unexpected_requests_summaries = interaction_list.unexpected_requests_summaries
+          error_message = "Missing requests:
+  #{missing_interactions_summaries.join("\n  ")}
+Incorrect requests:
+  #{interaction_mismatches_summaries.join("\n  ")}
+Unexpected requests:
+  #{unexpected_requests_summaries.join("\n  ")}"
+logger.warn "Verifying - actual interactions do not match expected interactions for example \"#{example_description(env)}\". \n#{error_message}"
+logger.warn error_message
+          [500, {}, ["Actual interactions do not match expected interactions for mock #{name}.\n#{error_message}\nSee #{log_description} for details."]]
         end
       end
 

data/lib/pact/consumer/mock_service_client.rb

@@ -12,7 +12,7 @@ module Pact
 
       def verify example_description
         response = http.request_get("/verify?example_description=#{URI.encode(example_description)}", MOCK_SERVICE_ADMINISTRATON_HEADERS)
-        raise response.body unless response.is_a? Net::HTTPSuccess
+        raise "\e[31m#{response.body}\e[m" unless response.is_a? Net::HTTPSuccess
       end
 
       def log msg

data/lib/pact/consumer/request.rb

@@ -20,8 +20,8 @@ module Pact
 
         def self.key_not_found
           nil
-        end       
-      end      
+        end
+      end
     end
   end
 end

data/lib/pact/version.rb

@@ -1,3 +1,3 @@
 module Pact
-  VERSION = "1.0.22"
+  VERSION = "1.0.23"
 end

data/spec/lib/pact/consumer/mock_service/interaction_list_spec.rb

@@ -6,18 +6,21 @@ module Pact::Consumer
   describe InteractionList do
     shared_context "unexpected requests and missed interactions" do
       let(:expected_interaction) { InteractionFactory.create }
-      let(:unexpected_request) { RequestFactory.create_actual }
+      let(:unexpected_request) { RequestFactory.create_actual method: 'put' }
+      let(:candidate_interaction) { double("Pact::Interaction") }
+      let(:candidate_interactions) { [candidate_interaction] }
+      let(:interaction_mismatch) { instance_double("Pact::Consumer::InteractionMismatch", :short_summary => 'blah', :candidate_interactions => candidate_interactions)}
       subject {
         interactionList = InteractionList.new
         interactionList.add expected_interaction
         interactionList.register_unexpected_request unexpected_request
+        interactionList.register_interaction_mismatch interaction_mismatch
         interactionList
        }
     end
 
     shared_context "no unexpected requests or missed interactions exist" do
       let(:expected_interaction) { InteractionFactory.create }
-      let(:unexpected_request) { RequestFactory.create_actual }
       subject {
         interactionList = InteractionList.new
         interactionList.add expected_interaction
@@ -30,7 +33,9 @@ module Pact::Consumer
       context "when unexpected requests and missed interactions exist" do
         include_context "unexpected requests and missed interactions"
         let(:expected_diff) {
-          {:missing_interactions=>[expected_interaction.as_json], :unexpected_requests=>[unexpected_request.as_json]}
+          {:missing_interactions=>["GET /path"],
+            :unexpected_requests=>["PUT /path"],
+            :interaction_mismatches => ['blah']}
         }
         it "returns the unexpected requests and missed interactions" do
           expect(subject.interaction_diffs).to eq expected_diff
@@ -62,5 +67,12 @@ module Pact::Consumer
         end
       end
     end
+
+    describe "missing_interactions_summaries" do
+      include_context "unexpected requests and missed interactions"
+      it "returns a list of the method and paths for each missing interaction" do
+        expect(subject.missing_interactions_summaries).to eq ["GET /path"]
+      end
+    end
   end
 end

data/spec/lib/pact/consumer/mock_service/interaction_mismatch_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'pact/consumer/mock_service/interaction_mismatch'
+
+module Pact
+  module Consumer
+    describe InteractionMismatch do
+      let(:actual_request) { instance_double('Pact::Consumer::Request::Actual', :method_and_path => 'GET /path') }
+      let(:expected_request_1) { instance_double('Pact::Request::Expected') }
+      let(:expected_request_2) { instance_double('Pact::Request::Expected') }
+      let(:candidate_1) { instance_double('Pact::Interaction', request: expected_request_1) }
+      let(:candidate_2) { instance_double('Pact::Interaction', request: expected_request_2) }
+      let(:candidate_interactions) { [candidate_1, candidate_2] }
+      subject { InteractionMismatch.new(candidate_interactions, actual_request) }
+      let(:diff_1) { {body: nil} }
+      let(:diff_2) { {} }
+
+      before do
+        expected_request_1.stub(:difference).with(actual_request).and_return(diff_1)
+        expected_request_2.stub(:difference).with(actual_request).and_return(diff_2)
+      end
+
+      describe "short_summary" do
+        it "includes the method and path" do
+          expect(subject.short_summary).to match /GET \/path \(.*\)/
+        end
+        context "when the body does not match" do
+          let(:diff_1) { {body: nil} }
+
+          it "returns a message indicating that the body does not match" do
+            expect(subject.short_summary).to include "(body did not match)"
+          end
+        end
+        context "when the headers do not match" do
+          let(:diff_1) { {headers: nil} }
+          it "returns a message indicating that the body does not match" do
+            expect(subject.short_summary).to include "(headers did not match)"
+          end
+        end
+        context "when the headers and body do not match" do
+          let(:diff_1) { {body: nil, headers: nil} }
+          let(:diff_2) { {body: nil, headers: nil} }
+          it "returns a message indicating that the headers and body do not match" do
+            expect(subject.short_summary).to include "(body and headers did not match)"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/support/factories.rb

@@ -76,7 +76,7 @@ class RequestFactory
    deep_merge(DEFAULTS, overrides)
   end
 
-  def self.create_actual
-    Pact::Consumer::Request::Actual.from_hash(create_hash)
+  def self.create_actual overrides = {}
+    Pact::Consumer::Request::Actual.from_hash(create_hash(overrides))
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact
 version: !ruby/object:Gem::Version
-  version: 1.0.22
+  version: 1.0.23
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-25 00:00:00.000000000 Z
+date: 2013-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: randexp
@@ -307,6 +307,7 @@ files:
 - lib/pact/consumer/mock_service/app.rb
 - lib/pact/consumer/mock_service/interaction_delete.rb
 - lib/pact/consumer/mock_service/interaction_list.rb
+- lib/pact/consumer/mock_service/interaction_mismatch.rb
 - lib/pact/consumer/mock_service/interaction_post.rb
 - lib/pact/consumer/mock_service/interaction_replay.rb
 - lib/pact/consumer/mock_service/log_get.rb
@@ -372,6 +373,8 @@ files:
 - spec/lib/pact/consumer/interaction_builder_spec.rb
 - spec/lib/pact/consumer/interactions_spec.rb
 - spec/lib/pact/consumer/mock_service/interaction_list_spec.rb
+- spec/lib/pact/consumer/mock_service/interaction_mismatch_spec.rb
+- spec/lib/pact/consumer/mock_service/interaction_replay_spec.rb
 - spec/lib/pact/consumer/mock_service/rack_request_helper_spec.rb
 - spec/lib/pact/consumer/mock_service_interaction_expectation_spec.rb
 - spec/lib/pact/consumer/request_spec.rb
@@ -421,7 +424,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1182047425998304532
+      hash: -1054460629994905299
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -430,7 +433,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1182047425998304532
+      hash: -1054460629994905299
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -453,6 +456,8 @@ test_files:
 - spec/lib/pact/consumer/interaction_builder_spec.rb
 - spec/lib/pact/consumer/interactions_spec.rb
 - spec/lib/pact/consumer/mock_service/interaction_list_spec.rb
+- spec/lib/pact/consumer/mock_service/interaction_mismatch_spec.rb
+- spec/lib/pact/consumer/mock_service/interaction_replay_spec.rb
 - spec/lib/pact/consumer/mock_service/rack_request_helper_spec.rb
 - spec/lib/pact/consumer/mock_service_interaction_expectation_spec.rb
 - spec/lib/pact/consumer/request_spec.rb