pact 1.3.0 → 1.3.1

data/lib/pact/provider/configuration/service_provider_dsl.rb

@@ -13,7 +13,12 @@ module Pact
 
         attr_accessor :name, :app_block
 
-        CONFIG_RU_APP = lambda { Rack::Builder.parse_file(Pact.configuration.config_ru_path).first }
+        CONFIG_RU_APP = lambda {
+          unless File.exist? Pact.configuration.config_ru_path
+            raise "Could not find config.ru file at #{Pact.configuration.config_ru_path} Please configure the service provider app or create a config.ru file in the root directory of the project. See https://github.com/realestate-com-au/pact/blob/master/documentation/verifying-pacts.md for more information."
+          end
+          Rack::Builder.parse_file(Pact.configuration.config_ru_path).first
+        }
 
         def initialize name
           @name = name

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

@@ -5,9 +5,9 @@ module Pact
   module Matchers
     module Messages
 
-      def match_term_failure_message diff, actual, color_enabled
+      def match_term_failure_message diff, actual, diff_formatter, color_enabled
         message = "Actual: #{(String === actual ? actual : actual.to_json)}\n\n"
-        formatted_diff = Pact.configuration.diff_formatter.call(diff)
+        formatted_diff = diff_formatter.call(diff)
         message + colorize_if_enabled(formatted_diff, color_enabled)
       end
 

data/lib/pact/provider/rspec.rb

@@ -106,6 +106,12 @@ module Pact
             let(:response) { interaction_context.last_response }
             let(:response_status) { response.status }
             let(:response_body) { parse_body_from_response(response) }
+            let(:differ) { Pact.configuration.body_differ_for_content_type diff_content_type }
+            let(:diff_formatter) { Pact.configuration.diff_formatter_for_content_type diff_content_type }
+            let(:expected_content_type) { Pact::Headers.new(expected_response['headers'] || {})['Content-Type'] }
+            let(:actual_content_type) { response.headers['Content-Type']}
+            let(:diff_content_type) { String === expected_content_type ? expected_content_type : actual_content_type } # expected_content_type may be a Regexp
+            let(:options) { { with: differ, diff_formatter: diff_formatter } }
 
             if expected_response['status']
               it "has status code #{expected_response['status']}" do
@@ -126,7 +132,7 @@ module Pact
 
             if expected_response['body']
               it "has a matching body" do
-                expect(response_body).to match_term expected_response_body
+                expect(response_body).to match_term expected_response_body, options
               end
             end
           end

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

@@ -1,19 +1,43 @@
 module RSpec
   module Core
 
+    # RSpec 3 has a hardwired @system_exclusion_patterns which removes everything matching /bin\//
+    # This causes *all* the backtrace lines to be cleaned, as rake pact:verify now shells out
+    # to the executable `pact verify ...`
+    # which then causes *all* the lines to be included as the BacktraceFormatter will
+    # include all lines of the backtrace if all lines were filtered out.
+    # This monkey patch only shows lines including bin/pact and removes the
+    # "show all lines if no lines would otherwise be shown" logic.
+
     class BacktraceFormatter
 
-      # RSpec 3 has a hardwired @system_exclusion_patterns which removes everything matching /bin\//
-      # This causes *all* the backtrace lines to be cleaned, as rake pact:verify now shells out
-      # to the executable `pact verify ...`
-      # which then causes *all* the lines to be included
+
+      def format_backtrace(backtrace, options = {})
+        return backtrace if options[:full_backtrace]
+        backtrace.map { |l| backtrace_line(l) }.compact
+      end
+
+      def backtrace_line(line)
+        relative_path(line) unless exclude?(line)
+      rescue SecurityError
+        nil
+      end
 
       def exclude?(line)
         return false if @full_backtrace
-        matches_an_exclusion_pattern?(line) &&
-        @inclusion_patterns.none? { |p| p =~ line }
+        relative_line = relative_path(line)
+        return true unless /bin\/pact/ =~ relative_line
       end
 
+      # Copied from Metadata so a refactor can't break this overridden class
+      def relative_path(line)
+        line = line.sub(File.expand_path("."), ".")
+        line = line.sub(/\A([^:]+:\d+)$/, '\\1')
+        return nil if line == '-e:1'
+        line
+      rescue SecurityError
+        nil
+      end
     end
   end
 end

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

@@ -2,6 +2,8 @@ require 'rspec'
 require 'pact/matchers'
 require 'pact/provider/matchers/messages'
 require 'pact/rspec'
+require 'pact/shared/json_differ'
+
 
 module Pact
   module RSpec
@@ -20,27 +22,28 @@ module Pact
 
       class MatchTerm
 
-        include Pact::Matchers
         include Pact::Matchers::Messages
         include RSpec2Delegator
 
-        def initialize expected
+        def initialize expected, differ, diff_formatter
           @expected = expected
+          @differ = differ
+          @diff_formatter = diff_formatter
         end
 
         def matches? actual
           @actual = actual
-          (@difference = diff(@expected, @actual)).empty?
+          (@difference = @differ.call(@expected, @actual)).empty?
         end
 
         def failure_message
-          match_term_failure_message @difference, @actual, Pact::RSpec.color_enabled?
+          match_term_failure_message @difference, @actual, @diff_formatter, Pact::RSpec.color_enabled?
         end
 
       end
 
-      def match_term expected
-        MatchTerm.new(expected)
+      def match_term expected, options
+        MatchTerm.new(expected, options.fetch(:with), options.fetch(:diff_formatter))
       end
 
       class MatchHeader

data/lib/pact/shared/json_differ.rb

@@ -0,0 +1,15 @@
+require 'pact/matchers/matchers'
+
+module Pact
+  class JsonDiffer
+
+    extend Matchers
+
+
+    def self.call expected, actual, options = {}
+      diff expected, actual, options
+    end
+
+
+  end
+end

data/lib/pact/shared/request.rb

@@ -1,5 +1,6 @@
 require 'pact/matchers'
 require 'pact/symbolize_keys'
+require 'pact/consumer_contract/headers'
 
 module Pact
 
@@ -15,7 +16,7 @@ module Pact
       def initialize(method, path, headers, body, query)
         @method = method.to_s
         @path = path.chomp('/')
-        @headers = headers
+        @headers = Hash === headers ? Headers.new(headers) : headers # Could be a NullExpectation - TODO make this more elegant
         @body = body
         @query = query
       end
@@ -48,6 +49,11 @@ module Pact
         display_path + display_query
       end
 
+      def content_type
+        return nil if headers.is_a? self.class.key_not_found.class
+        headers['Content-Type']
+      end
+
       protected
 
       def self.key_not_found
@@ -56,7 +62,9 @@ module Pact
 
       def to_hash_without_body
         keep_keys = [:method, :path, :headers, :query]
-        as_json.reject{ |key, value| !keep_keys.include? key }
+        as_json.reject{ |key, value| !keep_keys.include? key }.tap do | hash |
+          hash[:method] = method.upcase
+        end
       end
 
       def display_path
@@ -66,6 +74,7 @@ module Pact
       def display_query
         (query.nil? || query.empty?) ? '' : "?#{Pact::Reification.from_term(query)}"
       end
+
     end
   end
 end

data/lib/pact/shared/text_differ.rb

@@ -0,0 +1,14 @@
+require 'pact/matchers/matchers'
+require 'pact/matchers/difference'
+
+module Pact
+  class TextDiffer
+
+    extend Matchers
+
+    def self.call expected, actual, options = {}
+      diff expected, actual, options
+    end
+
+  end
+end

data/lib/pact/version.rb

@@ -1,3 +1,3 @@
 module Pact
-  VERSION = "1.3.0"
+  VERSION = "1.3.1"
 end

data/spec/lib/pact/configuration_spec.rb

@@ -83,12 +83,12 @@ describe Pact do
 
     end
 
-    describe "#diff_formatter" do
+    describe "#diff_formatter_for_content_type" do
 
       let(:subject) { Pact::Configuration.new }
 
       it "returns the Pact::Matchers::UnixDiffFormatter by default" do
-        expect(subject.diff_formatter).to eq(Pact::Matchers::UnixDiffFormatter)
+        expect(subject.diff_formatter_for_content_type 'anything').to eq(Pact::Matchers::UnixDiffFormatter)
       end
 
       Pact::Configuration::DIFF_FORMATTERS.each_pair do | key, diff_formatter |
@@ -100,7 +100,7 @@ describe Pact do
           end
 
           it "sets the diff_formatter to #{diff_formatter}" do
-            expect(subject.diff_formatter).to be diff_formatter
+            expect(subject.diff_formatter_for_content_type nil).to be diff_formatter
           end
         end
 
@@ -115,18 +115,140 @@ describe Pact do
         end
 
         it "sets the diff_formatter to the object" do
-          expect(subject.diff_formatter).to be diff_formatter
+          expect(subject.diff_formatter_for_content_type nil).to be diff_formatter
         end
       end
 
       context "when set to an object that does not respond to call and isn't a known default option" do
         it "raises an error" do
-          expect { subject.diff_formatter = Object.new }.to raise_error "Pact.configuration.diff_formatter needs to respond to call, or be in the preconfigured list: [:embedded, :unix, :list]"
+          expect { subject.diff_formatter = Object.new }.to raise_error "Pact diff_formatter needs to respond to call, or be in the preconfigured list: [:embedded, :unix, :list]"
+          expect { subject.diff_formatter = Object.new }.to raise_error "Pact diff_formatter needs to respond to call, or be in the preconfigured list: [:embedded, :unix, :list]"
         end
       end
 
     end
 
+    describe "diff_formatter_for_content_type" do
+      let(:diff_formatter) { lambda { |expected, actual| }}
+      context "with the default configuration" do
+        context "when the content type is nil" do
+          it "returns the UnixDiffFormatter" do
+            expect(Pact.configuration.diff_formatter_for_content_type nil).to eq Pact::Matchers::UnixDiffFormatter
+          end
+        end
+        context "when the content type is application/json" do
+          it "returns the UnixDiffFormatter" do
+            expect(Pact.configuration.diff_formatter_for_content_type nil).to eq Pact::Matchers::UnixDiffFormatter
+          end
+        end
+        context "when the content type is text/plain" do
+          it "returns the UnixDiffFormatter" do
+            expect(Pact.configuration.diff_formatter_for_content_type nil).to eq Pact::Matchers::UnixDiffFormatter
+          end
+        end
+      end
+      context "with a custom diff_formatter registered for nil content type" do
+        context "when the content_type is nil" do
+          it "returns the custom diff_formatter" do
+            Pact.configuration.register_diff_formatter nil, diff_formatter
+            expect(Pact.configuration.diff_formatter_for_content_type nil).to eq diff_formatter
+          end
+        end
+      end
+      context "with a custom diff_formatter registered for json content type" do
+        context "when the content_type is application/json" do
+          it "returns the custom diff_formatter" do
+            Pact.configuration.register_diff_formatter /json/, diff_formatter
+            expect(Pact.configuration.diff_formatter_for_content_type 'application/json').to eq diff_formatter
+          end
+        end
+      end
+    end
+
+    describe "register_body_differ" do
+
+      let(:differ) { lambda{ |expected, actual| } }
+
+      context "with a string for a content type" do
+        it "configures the differ for the given content type" do
+          Pact.configure do | config |
+            config.register_body_differ 'application/xml', differ
+          end
+
+          expect(Pact.configuration.body_differ_for_content_type 'application/xml').to be differ
+        end
+      end
+
+      context "with a regexp for a content type" do
+        it "returns a matching differ" do
+          Pact.configuration.register_body_differ /application\/.*xml/, differ
+          expect(Pact.configuration.body_differ_for_content_type 'application/hal+xml').to be differ
+        end
+      end
+
+      context "when a non string or regexp is used to register a differ" do
+        it "raises an error" do
+          expect { Pact.configuration.register_body_differ 1, differ }.to raise_error /Invalid/
+        end
+      end
+
+      context "when something that does not respond to call is sumbitted as a differ" do
+        it "raises an error" do
+          expect { Pact.configuration.register_body_differ 'thing', Object.new }.to raise_error /responds to call/
+        end
+      end
+
+      context "when a nil content type is registered for responses without a content type header" do
+        it "returns that differ if the differ for a nil content type is requested" do
+          Pact.configuration.register_body_differ nil, differ
+          expect(Pact.configuration.body_differ_for_content_type(nil)).to be differ
+        end
+      end
+
+    end
+
+    describe "body_differ_for_content_type" do
+
+      let(:differ) { lambda { |expected, actual| }}
+
+      context "when 2 potentially matching content types have a differ registered" do
+        let(:differ_1) { lambda{ |expected, actual| } }
+        let(:differ_2) { lambda{ |expected, actual| } }
+
+        it "returns the differ that was configured first" do
+          Pact.configuration.register_body_differ /application\/.*xml/, differ_2
+          Pact.configuration.register_body_differ /application\/hal\+xml/, differ_1
+          expect(Pact.configuration.body_differ_for_content_type 'application/hal+xml').to be differ_2
+        end
+      end
+
+      context "when a nil content type is given" do
+        it "returns the text differ" do
+          expect(Pact.configuration.body_differ_for_content_type nil).to be Pact::TextDiffer
+        end
+      end
+
+      context "when no matching content type is found" do
+        it "returns the text differ" do
+          expect(Pact.configuration.body_differ_for_content_type 'blah').to be Pact::TextDiffer
+        end
+      end
+
+      context "when the nil content type has a custom differ configured" do
+        it "returns the custom differ" do
+          Pact.configuration.register_body_differ nil, differ
+          expect(Pact.configuration.body_differ_for_content_type(nil)).to be differ
+        end
+      end
+
+      context "when a custom differ is registered for a content type that has a default differ" do
+        it "returns the custom differ" do
+          Pact.configuration.register_body_differ /application\/json/, differ
+          expect(Pact.configuration.body_differ_for_content_type 'application/json').to be differ
+        end
+      end
+    end
+
     describe "pactfile_write_mode" do
       context "when @pactfile_write_mode is :overwrite" do
         it 'returns :overwrite' do

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

@@ -4,9 +4,10 @@ require 'pact/consumer/mock_service/interaction_mismatch'
 module Pact
   module Consumer
     describe InteractionMismatch do
+      let(:content_type) { 'some/content' }
       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(:expected_request_1) { instance_double('Pact::Request::Expected', :content_type => content_type) }
+      let(:expected_request_2) { instance_double('Pact::Request::Expected', :content_type => content_type) }
       let(:candidate_1) { instance_double('Pact::Interaction', request: expected_request_1, description_with_provider_state_quoted: "desc 1") }
       let(:candidate_2) { instance_double('Pact::Interaction', request: expected_request_2, description_with_provider_state_quoted: "desc 2") }
       let(:candidate_interactions) { [candidate_1, candidate_2] }
@@ -48,13 +49,15 @@ module Pact
       describe "to_s" do
         let(:expected_message) { "Diff with interaction: desc 1\ndiff 1\nDiff with interaction: desc 2\ndiff 2" }
 
+        let(:diff_formatter) { double("diff_formatter")}
         before do
-          allow(Pact.configuration.diff_formatter).to receive(:call).and_return("diff 1", "diff 2")
+          allow(Pact.configuration).to receive(:diff_formatter_for_content_type).with(content_type).and_return(diff_formatter)
+          allow(diff_formatter).to receive(:call).and_return("diff 1", "diff 2")
         end
 
         it "creates diff output using the configured diff_formatter" do
-          expect(Pact.configuration.diff_formatter).to receive(:call).with(diff_1, colour: false)
-          expect(Pact.configuration.diff_formatter).to receive(:call).with(diff_2, colour: false)
+          expect(diff_formatter).to receive(:call).with(diff_1, colour: false)
+          expect(diff_formatter).to receive(:call).with(diff_2, colour: false)
           subject.to_s
         end
 

data/spec/lib/pact/consumer_contract/headers_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+require 'pact/consumer_contract/headers'
+
+module Pact
+  describe Headers do
+
+    describe "initialize" do
+
+      context "with duplicate headers" do
+
+        subject { Headers.new('Content-Type' => 'application/hippo', 'CONTENT-TYPE' => 'application/giraffe') }
+
+        it "raises an error" do
+          expect { subject }.to raise_error DuplicateHeaderError, /Content\-Type.*CONTENT\-TYPE/
+        end
+
+      end
+
+      context "with a symbol as a header name" do
+
+        subject { Headers.new(:'content-type' => 'application/hippo') }
+
+        it "converts the header name to a String" do
+          expect( subject.to_hash ).to eq 'content-type' => 'application/hippo'
+        end
+
+      end
+
+      context "with a nil header name" do
+
+        subject { Headers.new(nil => 'application/hippo') }
+
+        it "raises an error" do
+          expect{ subject }.to raise_error InvalidHeaderNameTypeError
+        end
+
+      end
+
+      context "with a boolean header name" do
+
+        subject { Headers.new(false => 'application/hippo') }
+
+        it "raises an error" do
+          expect{ subject }.to raise_error InvalidHeaderNameTypeError
+        end
+
+      end
+
+    end
+
+    describe "[]" do
+
+      subject { Headers.new 'Content-Type' => 'application/hippo' }
+
+      it "is case insensitive as HTTP headers are case insensitive" do
+        expect(subject['Content-Type']).to eq('application/hippo')
+        expect(subject['CONTENT-TYPE']).to eq('application/hippo')
+        expect(subject['content-type']).to eq('application/hippo')
+      end
+
+    end
+
+    describe "fetch" do
+
+      subject { Headers.new 'Content-Type' => 'application/hippo' }
+
+      it "is case insensitive as HTTP headers are case insensitive" do
+        expect(subject.fetch('Content-Type')).to eq('application/hippo')
+        expect(subject.fetch('CONTENT-TYPE')).to eq('application/hippo')
+        expect(subject.fetch('content-type')).to eq('application/hippo')
+        expect(subject.fetch('Content-Length','1')).to eq('1')
+        expect { subject.fetch('Content-Length')}.to raise_error KeyError
+      end
+
+    end
+
+    describe "key?" do
+
+      subject { Headers.new 'Content-Type' => 'application/hippo' }
+
+      it "is case insensitive as HTTP headers are case insensitive" do
+        expect(subject.key?('CONTENT-TYPE')).to be true
+        expect(subject.key?('CONTENT-LENGTH')).to be false
+      end
+    end
+
+    describe "has_key?" do
+
+      subject { Headers.new 'Content-Type' => 'application/hippo' }
+
+      it "is case insensitive as HTTP headers are case insensitive" do
+        expect(subject.has_key?('CONTENT-TYPE')).to be true
+        expect(subject.has_key?('CONTENT-LENGTH')).to be false
+      end
+    end
+
+    describe "[]=" do
+
+      subject { Headers.new }
+
+      it "does not allow modification" do
+        expect{ subject['Content-Type'] = 'application/hippo' }.to raise_error /frozen/
+      end
+
+    end
+  end
+end