pact 1.0.26 → 1.0.27

data/CHANGELOG.md

@@ -2,6 +2,20 @@ Do this to generate your change history
 
     git log --date=relative --pretty=format:'  * %h - %s (%an, %ad)'
 
+### 1.0.26 (10 December 2013)
+
+* 388fc7b - Changing provider set up and tear down to run before :all rather than before :each (Beth, 13 minutes ago)
+* 06b5626 - Updating TODO list in the README. (Beth, 25 hours ago)
+* 823f306 - Update README.md (bethesque, 32 hours ago)
+* 7d96017 - Improving layout of text diff message (Beth Skurrie, 2 days ago)
+* 9c88c3a - Working on a new way to display the diff between an expected and actual request/response (Beth Skurrie, 2 days ago)
+* ff2c448 - Added a Difference class instead of a hash with :expected and :actual (Beth Skurrie, 2 days ago)
+* b34457c - Moved all missing provider state templates into the one message at the end of the test so it's easier to digest and can be copied directly into a file. (Beth Skurrie, 2
+* 1729887 - Moving ProviderStateProxy on to Pact World (Beth Skurrie, 3 days ago)
+* c53cb4d - Starting to add Pact::World (Beth, 4 days ago)
+* f7af9e2 - Recording missing provider states (Beth, 4 days ago)
+* 4caa171 - Starting work on ProviderStateProxy - intent is for it to record missing and unused states to report at the end of the pact:verify (Beth, 4 days ago)
+
 ### 1.0.26 (5 December 2013)
 
 * e4be654 - BEST COMMIT TO PACT EVER since the introduction of pact:verify. Got rid of the horrific backtraces. (Beth, 5 hours ago)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pact (1.0.26)
+    pact (1.0.27)
       awesome_print (~> 1.1)
       find_a_port (~> 1.0.1)
       json

data/README.md

@@ -161,10 +161,8 @@ require 'pact/provider/rspec'
 require './spec_helper'
 
 Pact.service_provider "My Service Provider" do
-  # If you have a config.ru file, the app will be loaded from it automatically and you can skip the app config.
-  # Otherwise, set your rack app here as you would when using Rack::Test::Methods
 
-  app { MyApp.new }
+  app { MyApp.new } # Optional, loads app from config.ru by default
 
   honours_pact_with 'My Service Consumer' do
 
@@ -391,8 +389,12 @@ Short term:
 
 Long term:
 - Provide more flexible matching (eg the keys should match, and the classes of the values should match, but the values of each key do not need to be equal). This is to make the pact verification less brittle.
+- Add support for verifying pact against running server
+- Add XML support
+- Improve display of interaction diffs
 - Decouple Rspec from Pact and make rspec-pact gem for easy integration
 
+
 ## Contributing
 
 1. Fork it

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

@@ -1,3 +1,5 @@
+require 'pact/matchers/diff_decorator'
+
 module Pact
   module Consumer
     class InteractionMismatch
@@ -12,8 +14,12 @@ module Pact
         @candiate_diffs = candidate_interactions.collect{ | candidate_interaction| CandidateDiff.new(candidate_interaction, actual_request)}
       end
 
-      def diffs
-        candiate_diffs.collect(&:diff_summary)
+      def to_hash
+        candiate_diffs.collect(&:to_hash)
+      end
+
+      def to_s
+        candiate_diffs.collect(&:to_s).join("\n")
       end
 
       def short_summary
@@ -36,12 +42,19 @@ module Pact
           diff.keys
         end
 
-        def diff_summary
+        def to_hash
           summary = {:description => candidate_interaction.description}
           summary[:provider_state] = candidate_interaction.provider_state if candidate_interaction.provider_state
           summary.merge(diff)
         end
 
+        def to_s
+          [
+            "Diff with interaction: #{candidate_interaction.description_with_provider_state_quoted}",
+            Pact::Matchers::DiffDecorator.new(diff).to_s
+          ].join("\n")
+        end
+
         def diff
           @diff ||= candidate_interaction.request.difference(actual_request)
         end

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

@@ -75,12 +75,6 @@ module Pact
         InteractionMismatch.new(candidate_interactions, actual_request)
       end
 
-      def diff_summary_for interaction, diff
-        summary = {:description => interaction.description}
-        summary[:provider_state] = interaction.provider_state if interaction.provider_state
-        summary.merge(diff)
-      end
-
       def request_summary_for interaction
         summary = {:description => interaction.description}
         summary[:provider_state] if interaction.provider_state
@@ -91,7 +85,7 @@ module Pact
       def unrecognised_request_response interaction_mismatch
         response = {
           message: "No interaction found for #{interaction_mismatch.actual_request.method_and_path}",
-          interaction_diffs:  interaction_mismatch.diffs
+          interaction_diffs:  interaction_mismatch.to_hash
         }
         [500, {'Content-Type' => 'application/json'}, [response.to_json]]
       end
@@ -99,7 +93,8 @@ module Pact
       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_mismatch.diffs, :error)
+        logger.ap(interaction_mismatch.to_hash, :error)
+        logger.error("Interaction diffs for that route in text format:\n#{interaction_mismatch.to_s}")
       end
 
       def handle_unrecognised_request actual_request, candidate_interactions

data/lib/pact/consumer_contract/interaction.rb

@@ -56,6 +56,10 @@ module Pact
         self == other
       end
 
+      def description_with_provider_state_quoted
+        provider_state ? "\"#{description}\" given \"#{provider_state}\"" : "\"#{description}\""
+      end
+
       def to_s
         JSON.pretty_generate(self)
       end

data/lib/pact/matchers/diff_decorator.rb

@@ -0,0 +1,84 @@
+module Pact
+  module Matchers
+    class DiffDecorator
+
+      attr_reader :diff
+
+      def initialize diff
+        @diff = diff
+      end
+
+      def to_hash
+        diff
+      end
+
+      def to_s
+        diff_descriptions(diff).join("\n")
+      end
+
+      def diff_descriptions obj, path = [], descriptions = []
+        case obj
+        when Hash then handle_hash obj, path, descriptions
+        when Array then handle_array obj, path, descriptions
+        when Difference then handle_difference obj, path, descriptions
+        when NoDiffIndicator then nil
+        else
+          raise "Invalid diff, expected Hash, Array, NoDiffIndicator or Difference, found #{obj}"
+        end
+        descriptions
+      end
+
+      def handle_hash hash, path, descriptions
+        hash.each_pair do | key, value |
+          diff_descriptions value, path + [key.inspect], descriptions
+        end
+      end
+
+      def handle_array array, path, descriptions
+        array.each_with_index do | obj, index |
+          diff_descriptions obj, path + [index], descriptions
+        end
+      end
+
+      def handle_difference difference, path, descriptions
+
+        case difference.actual
+        when Pact::KeyNotFound then handle_key_not_found(difference, path, descriptions)
+        when Pact::IndexNotFound then handle_index_not_found(difference, path, descriptions)
+        else
+          case difference.expected
+          when Pact::UnexpectedKey then handle_unexpected_key(difference, path, descriptions)
+          when Pact::UnexpectedIndex then handle_unexpected_index(difference, path, descriptions)
+          else
+            handle_mismatched_value(difference, path, descriptions)
+          end
+        end
+      end
+
+      def handle_unexpected_index difference, path, descriptions
+        descriptions << "\tAt:\n\t\t#{path_to_s(path)}\n\tArray contained unexpected item:\n\t\t#{difference.actual.ai}"
+      end
+
+      def handle_mismatched_value difference, path, descriptions
+        descriptions << "\tAt:\n\t\t#{path_to_s(path)}\n\tExpected:\n\t\t#{difference.expected.ai}\n\tActual:\n\t\t#{difference.actual.ai}"
+      end
+
+      def handle_index_not_found difference, path, descriptions
+        descriptions << "\tAt:\n\t\t#{path_to_s(path)}\n\tMissing index with value:\n\t\t#{difference.expected.ai}"
+      end
+
+      def handle_key_not_found difference, path, descriptions
+        descriptions << "\tAt:\n\t\t#{path_to_s(path)}\n\tMissing key with value:\n\t\t#{difference.expected.ai}"
+      end
+
+      def handle_unexpected_key difference, path, descriptions
+        descriptions << "\tAt:\n\t\t#{path_to_s(path)}\n\tHash contained unexpected key with value:\n\t\t#{difference.actual.ai}"
+      end
+
+      def path_to_s path
+        "[" + path.join("][") + "]"
+      end
+
+    end
+  end
+end

data/lib/pact/matchers/matchers.rb

@@ -10,7 +10,50 @@ require 'pact/matchers/index_not_found'
 module Pact
   module Matchers
 
-    NO_DIFF_INDICATOR = 'no difference here!'
+    class Difference
+      attr_reader :expected, :actual
+      def initialize expected, actual
+        @expected = expected
+        @actual = actual
+      end
+
+      def any?
+        true
+      end
+
+      def to_hash
+        {:EXPECTED => expected, :ACTUAL => actual}
+      end
+
+      def to_json options = {}
+        to_hash.to_json(options)
+      end
+
+      def to_s
+        to_hash.to_s
+      end
+
+      def == other
+        other.is_a?(Difference) && other.expected == expected && other.actual == actual
+      end
+    end
+
+    class NoDiffIndicator
+
+      def to_json
+        to_s
+      end
+
+      def to_s
+        'no difference here!'
+      end
+
+      def == other
+        other.is_a? NoDiffIndicator
+      end
+    end
+
+    NO_DIFF_INDICATOR = NoDiffIndicator.new
     #UnexpectedKey.new = '<key not to be present>'
     DEFAULT_OPTIONS = {allow_unexpected_keys: true, structure: false}.freeze
 
@@ -34,7 +77,7 @@ module Pact
       if actual.is_a?(String) && regexp.match(actual)
         {}
       else
-        {expected: regexp, actual: actual}
+        Difference.new regexp, actual
       end
     end
 
@@ -42,7 +85,7 @@ module Pact
       if actual.is_a? Array
         actual_array_diff expected, actual, options
       else
-        {expected: expected, actual: actual}
+        Difference.new expected, actual
       end
     end
 
@@ -78,7 +121,7 @@ module Pact
         {}
       else
         (actual.keys - expected.keys).inject({}) do | diff, key |
-          diff[key] = {:expected => UnexpectedKey.new, :actual => actual[key]}
+          diff[key] = Difference.new(UnexpectedKey.new, actual[key])
           diff
         end
       end
@@ -88,7 +131,7 @@ module Pact
       if actual.is_a? Hash
         actual_hash_diff expected, actual, options
       else
-        {expected: expected, actual: actual}
+        Difference.new expected, actual
       end
     end
 
@@ -96,7 +139,7 @@ module Pact
       if classes_match? expected, actual
         {}
       else
-        {:expected => structure_diff_expected_display(expected), :actual => structure_diff_actual_display(actual)}
+        Difference.new structure_diff_expected_display(expected), structure_diff_actual_display(actual)
       end
     end
 
@@ -118,7 +161,7 @@ module Pact
     def object_diff expected, actual, options
       return class_diff(expected, actual) if options[:structure]
       if expected != actual
-        {:expected => expected, :actual => actual}
+        Difference.new expected, actual
       else
         {}
       end

data/lib/pact/provider.rb

@@ -1,3 +1,4 @@
 require 'pact/configuration'
 require 'pact/provider/configuration'
 require 'pact/provider/pact_spec_runner'
+require 'pact/provider/world'

data/lib/pact/provider/pact_spec_runner.rb

@@ -4,6 +4,7 @@ require 'rspec/core'
 require 'rspec/core/formatters/documentation_formatter'
 require 'rspec/core/formatters/json_formatter'
 require 'pact/provider/pact_helper_locator'
+require 'pact/provider/print_missing_provider_states'
 require_relative 'rspec'
 
 
@@ -101,6 +102,7 @@ module Pact
             config.run_hook(:after, :suite)
           end
         end
+        PrintMissingProviderStates.call Pact.world.provider_states.missing_provider_states
         @output = @json_formatter.output_hash
         exit_code
       end

data/lib/pact/provider/print_missing_provider_states.rb

@@ -0,0 +1,30 @@
+module Pact
+  module Provider
+    class PrintMissingProviderStates
+
+      # Hash of consumer names to array of names of missing provider states
+      def self.call missing_provider_states
+        if missing_provider_states.any?
+          puts orangeify(text(missing_provider_states))
+        end
+      end
+
+      def self.orangeify string
+        "\e[33m#{string}\e[m"
+      end
+
+      def self.text missing_provider_states
+        create_provider_states_for(missing_provider_states)
+      end
+
+      def self.create_provider_states_for consumers
+        ERB.new(template_string).result(binding)
+      end
+
+      def self.template_string
+        File.read(File.expand_path( '../../templates/provider_state.erb', __FILE__))
+      end
+
+    end
+  end
+end

data/lib/pact/provider/provider_state_proxy.rb

@@ -0,0 +1,35 @@
+module Pact
+  module Provider
+    class ProviderStateProxy
+
+      attr_reader :missing_provider_states
+
+      def initialize
+        @missing_provider_states = {}
+      end
+
+      def get name, options = {}
+        unless provider_state = ProviderState.get(name, options)
+          register_missing_provider_state name, options[:for]
+          raise error_message name, options[:for]
+        end
+        provider_state
+      end
+
+      private
+
+      def error_message name, consumer
+        "Could not find provider state \"#{name}\" for consumer #{consumer}"
+      end
+
+      def register_missing_provider_state name, consumer
+        missing_states_for(consumer) << name unless missing_states_for(consumer).include?(name)
+      end
+
+      def missing_states_for consumer
+        @missing_provider_states[consumer] ||= []
+      end
+
+    end
+  end
+end

data/lib/pact/provider/rspec.rb

@@ -62,12 +62,12 @@ module Pact
 
           describe description_for(interaction), :pact => :verify do
 
-            before do
+            before :all do
               set_up_provider_state interaction.provider_state, options[:consumer]
               replay_interaction interaction
             end
 
-            after do
+            after :all do
               tear_down_provider_state interaction.provider_state, options[:consumer]
             end
 

data/lib/pact/provider/test_methods.rb

@@ -2,7 +2,9 @@ require 'pact/logging'
 require 'rack/test'
 require 'pact/consumer_contract/interaction'
 require 'pact/provider/provider_state'
+require 'pact/provider/provider_state_proxy'
 require 'pact/provider/request'
+require 'pact/provider/world'
 
 module Pact
   module Provider
@@ -44,24 +46,7 @@ module Pact
       end
 
       def get_provider_state provider_state_name, consumer
-        unless provider_state = ProviderState.get(provider_state_name, :for => consumer)
-          extra = consumer ? " for consumer \"#{consumer}\"" : ""
-          error_msg = <<-eos
-Could not find a provider state named \"#{provider_state_name}\"#{extra}.
-Have you required the provider states file for this consumer in your pact_helper.rb?
-If you have not yet defined a provider state for \"#{provider_state_name}\", here is a template:
-
-Pact.provider_states_for \"#{consumer}\" do
-  provider_state \"#{provider_state_name}\" do
-    set_up do
-      # Your set up code goes here
-    end
-  end
-end
-eos
-          raise error_msg
-        end
-        provider_state
+        Pact.world.provider_states.get(provider_state_name, :for => consumer)
       end
     end
   end