pact 1.1.0.rc2 → 1.1.0.rc3

data/lib/pact/provider/pact_spec_runner.rb

@@ -91,6 +91,14 @@ module Pact
         config.add_formatter Pact::Provider::RSpec::Formatter
         config.add_formatter Pact::Provider::RSpec::SilentJsonFormatter
 
+        config.before(:suite) do
+          # Preload app before suite so the classes loaded in memory are consistent for
+          # before :each and after :each hooks.
+          # Otherwise the app and all its dependencies are loaded between the first before :each
+          # and the first after :each, leading to inconsistent behaviour
+          # (eg. with database_cleaner transactions)
+          Pact.configuration.provider.app
+        end
       end
 
       def run_specs

data/lib/pact/provider/rspec.rb

@@ -109,7 +109,7 @@ module Pact
                 expected_response['headers'].each do |name, expected_header_value|
                   it "\"#{name}\" with value \"#{expected_header_value}\"" do
                     header_value = response.headers[name]
-                    expect(header_value).to match_term expected_header_value
+                    expect(header_value).to match_header(name, expected_header_value)
                   end
                 end
               end

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

@@ -1,12 +1,13 @@
 require 'pact/provider/print_missing_provider_states'
 require 'rspec/core/formatters'
-require 'colored'
+require 'term/ansicolor'
 
 module Pact
   module Provider
     module RSpec
       class Formatter < ::RSpec::Core::Formatters::DocumentationFormatter
 
+        C = ::Term::ANSIColor
 
         def dump_commands_to_rerun_failed_examples
           return if failed_examples.empty?
@@ -17,9 +18,11 @@ module Pact
 
         end
 
+        private
+
         def print_rerun_commands
           output.puts("\n")
-          interaction_failure_messages.each do | message |
+          interaction_rerun_commands.each do | message |
             output.puts(message)
           end
         end
@@ -28,13 +31,13 @@ module Pact
           PrintMissingProviderStates.call Pact.world.provider_states.missing_provider_states, output
         end
 
-        def interaction_failure_messages
+        def interaction_rerun_commands
           failed_examples.collect do |example|
-            interaction_failure_message_for example
+            interaction_rerun_command_for example
           end.uniq
         end
 
-        def interaction_failure_message_for example
+        def interaction_rerun_command_for example
           provider_state = example.metadata[:pact_interaction].provider_state
           description = example.metadata[:pact_interaction].description
           pactfile_uri = example.metadata[:pactfile_uri]
@@ -47,8 +50,7 @@ module Pact
         end
 
         def failure_message
-
-          "\n" + "For assistance debugging failures, please note:".underline.yellow + "\n\n" +
+          "\n" +  C.underline(C.yellow("For assistance debugging failures, please note:")) + "\n\n" +
           "The pact files have been stored locally in the following temp directory:\n #{Pact.configuration.tmp_dir}\n\n" +
           "The requests and responses are logged in the following log file:\n #{Pact.configuration.log_path}\n\n"
         end

data/lib/pact/{consumer_contract → shared}/active_support_support.rb

@@ -43,5 +43,9 @@ module Pact
       end
     end
 
+    def remove_unicode json
+      json.gsub(/\\u([0-9A-Za-z]{4})/) {|s| [$1.to_i(16)].pack("U")}
+    end
+
   end
 end

data/lib/pact/shared/jruby_support.rb

@@ -0,0 +1,18 @@
+module Pact
+  module JRubySupport
+
+    # Under jruby, JSON.pretty_generate inserts a blank new line between the opening and closing
+    # brackets of an empty hash, like so:
+    # {
+    #   "empty": {
+    #
+    #   }
+    # }
+    # This screws up the UnixDiffFormatter, so we need to remove the blank lines.
+
+    def fix_blank_lines_in_empty_hashes json
+      json.gsub(/({\n)\n(\s*})/,'\1\2')
+    end
+
+  end
+end

data/lib/pact/shared/key_not_found.rb

@@ -1,25 +1,12 @@
-module Pact
-  class KeyNotFound
-    def == other
-      other.is_a? KeyNotFound
-    end
+require 'pact/matchers/difference_indicator'
 
-    def eql? other
-      self == other
-    end
+module Pact
+  class KeyNotFound < Pact::DifferenceIndicator
 
     def to_s
       "<key not found>"
     end
 
-    def as_json options={}
-      to_s
-    end
-
-    def to_json options = {}
-      as_json.to_json options
-    end
-
     def empty?
       true
     end

data/lib/pact/shared/request.rb

@@ -29,15 +29,15 @@ module Pact
       end
 
       def to_hash
-        base_json = {
+        hash = {
           method: method,
           path: path,
         }
 
-        base_json.merge!(body: body) unless body.is_a? self.class.key_not_found.class
-        base_json.merge!(headers: headers) unless headers.is_a? self.class.key_not_found.class
-        base_json.merge!(query: query) unless query.is_a? self.class.key_not_found.class
-        base_json
+        hash.merge!(query: query) unless query.is_a? self.class.key_not_found.class
+        hash.merge!(headers: headers) unless headers.is_a? self.class.key_not_found.class
+        hash.merge!(body: body) unless body.is_a? self.class.key_not_found.class
+        hash
       end
 
       def method_and_path

data/lib/pact/term.rb

@@ -1,4 +1,4 @@
-require 'pact/consumer_contract/active_support_support'
+require 'pact/shared/active_support_support'
 require 'json/add/regexp'
 
 module Pact
@@ -43,7 +43,7 @@ module Pact
     end
 
     def to_s
-      "Pact::Term matcher: #{matcher.to_s}" + (generate.nil? ? "" : " generate: \"#{generate}\"")
+      "Pact::Term matcher: #{matcher.inspect}" + (generate.nil? ? "" : " generate: \"#{generate}\"")
     end
 
     def diff_with_actual(actual)

data/lib/pact/version.rb

@@ -1,3 +1,3 @@
 module Pact
-  VERSION = "1.1.0.rc2"
+  VERSION = "1.1.0.rc3"
 end

data/pact.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["james.fraser@alumni.swinburne.edu", "sergei.matheson@gmail.com", "brent@fuglylogic.com", "uglyog@gmail.com", "bskurrie@dius.com.au"]
   gem.description   = %q{Enables consumer driven contract testing, providing a mock service and DSL for the consumer project, and interaction playback and verification for the service provider project.}
   gem.summary       = %q{Enables consumer driven contract testing, providing a mock service and DSL for the consumer project, and interaction playback and verification for the service provider project.}
-  gem.homepage      = "https://github.com/realestate-com-au/pact.git"
+  gem.homepage      = "https://github.com/realestate-com-au/pact"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -26,7 +26,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'thor'
   gem.add_runtime_dependency 'json' #Not locking down a version because buncher gem requires 1.6, while other projects use 1.7.
   gem.add_runtime_dependency 'webrick'
-  gem.add_runtime_dependency 'colored'
+  gem.add_runtime_dependency 'term-ansicolor', '~> 1.0'
 
   gem.add_development_dependency 'rake', '~> 10.0.3'
   gem.add_development_dependency 'webmock', '~> 1.9.3'

data/spec/integration/pact/provider_configuration_spec.rb

@@ -9,11 +9,12 @@ describe "provider side" do
       end
 
       let(:application) { double("App")}
+
       before do
          app_block = ->{ application }
          Pact.service_provider "My Provider" do
             app &app_block
-         end         
+         end
       end
 
       it "makes the app available to the tests" do

data/spec/lib/pact/configuration_spec.rb

@@ -19,10 +19,83 @@ describe Pact do
         expect(Pact.configuration.send(key)).to eql(value)
       end
     end
+
   end
 
   describe Pact::Configuration do
     let(:configuration) { Pact::Configuration.new }
+
+    describe "doc_generator" do
+
+      context "with a symbol" do
+        it "allows configuration of a doc_generator" do
+          Pact.configuration.doc_generator = :markdown
+          expect(Pact.configuration.doc_generators).to eq [Pact::Doc::Markdown::Generator]
+        end
+      end
+
+      context "with anything that responds to 'call'" do
+
+        it "allows configuration of a doc_generator" do
+          Pact.configuration.doc_generator = lambda { | pact_dir, doc_dir | "doc" }
+          expect(Pact.configuration.doc_generators.size).to be 1
+          expect(Pact.configuration.doc_generators.first.call('doc','pacts')).to eq ("doc")
+        end
+
+      end
+
+      context "with something that does not respond to call and doesn't have a matching doc_generator" do
+        it "raises an error" do
+          expect { Pact.configuration.doc_generator = Object.new }.to raise_error "Pact.configuration.doc_generator needs to respond to call, or be in the preconfigured list: [:markdown]"
+        end
+      end
+
+    end
+
+    describe "#diff_formatter" do
+
+      let(:subject) { Pact::Configuration.new }
+
+      it "returns the Pact::Matchers::UnixDiffFormatter by default" do
+        expect(subject.diff_formatter).to eq(Pact::Matchers::UnixDiffFormatter)
+      end
+
+      Pact::Configuration::DIFF_FORMATTERS.each_pair do | key, diff_formatter |
+
+        context "when set to :#{key}" do
+
+          before do
+            subject.diff_formatter = key
+          end
+
+          it "sets the diff_formatter to #{diff_formatter}" do
+            expect(subject.diff_formatter).to be diff_formatter
+          end
+        end
+
+      end
+
+      context "when set to an object that responds to call" do
+
+        let(:diff_formatter) { lambda{ | diff| } }
+
+        before do
+          subject.diff_formatter = diff_formatter
+        end
+
+        it "sets the diff_formatter to the object" do
+          expect(subject.diff_formatter).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]"
+        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

@@ -7,11 +7,11 @@ module Pact
       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_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] }
       subject { InteractionMismatch.new(candidate_interactions, actual_request) }
-      let(:diff_1) { {body: nil} }
+      let(:diff_1) { {body: 'diff'} }
       let(:diff_2) { {} }
 
       before do
@@ -44,6 +44,24 @@ module Pact
           end
         end
       end
+
+      describe "to_s" do
+        let(:expected_message) { "Diff with interaction: desc 1\ndiff 1\nDiff with interaction: desc 2\ndiff 2" }
+
+        before do
+          allow(Pact.configuration.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)
+          subject.to_s
+        end
+
+        it "includes a diff output in the string output" do
+          expect(subject.to_s).to eq expected_message
+        end
+      end
     end
   end
 end

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

@@ -0,0 +1,134 @@
+require 'spec_helper'
+require 'pact/consumer/mock_service/verification_get'
+
+module Pact
+  module Consumer
+    describe VerificationGet do
+
+      let(:interaction_list) { instance_double("Pact::Consumer::InteractionList")}
+      let(:logger) { double("Logger").as_null_object }
+      let(:log_description) { "/log/pact.log" }
+
+      subject { VerificationGet.new('VerificationGet', logger, interaction_list, log_description) }
+
+      its(:request_path) { should eq '/verify'}
+      its(:request_method) { should eq 'GET'}
+
+
+      describe "#respond" do
+        let(:env) { {
+          "QUERY_STRING" => "example_description=a description"
+        } }
+
+        before do
+          allow(interaction_list).to receive(:all_matched?).and_return(all_matched)
+        end
+
+        let(:response) { subject.respond env }
+
+        context "when all interactions have been matched" do
+          let(:all_matched) { true }
+
+          it "returns a 200 status" do
+            expect(response.first).to eq 200
+          end
+
+          it "returns a Content-Type of text/plain" do
+            expect(response[1]).to eq 'Content-Type' => 'text/plain'
+          end
+
+          it "returns a nice message" do
+            expect(response.last).to eq ['Interactions matched']
+          end
+
+          it "logs the success" do
+            expect(logger).to receive(:info).with(/Verifying - interactions matched.*a description/)
+            response
+          end
+        end
+
+        context "when all interactions not been matched" do
+          let(:all_matched) { false }
+          let(:failure_message) { "this is a failure message"}
+
+          before do
+            allow_any_instance_of(VerificationGet::FailureMessage).to receive(:to_s).and_return(failure_message)
+          end
+
+          it "returns a 500 status" do
+            expect(response.first).to eq 500
+          end
+
+          it "returns a Content-Type of text/plain" do
+            expect(response[1]).to eq 'Content-Type' => 'text/plain'
+          end
+
+          it "returns a message" do
+            expect(response.last.first).to include "Actual interactions do not match"
+            expect(response.last.first).to include failure_message
+            expect(response.last.first).to include log_description
+          end
+
+          it "logs the failure message" do
+            expect(logger).to receive(:warn).with(/Verifying - actual interactions do not match/)
+            expect(logger).to receive(:warn).with(failure_message)
+            response
+          end
+
+        end
+
+      end
+
+      describe "FailureMessage" do
+        let(:missing_interactions_summaries) { ["Blah", "Thing"]}
+        let(:interaction_mismatches_summaries) { []}
+        let(:unexpected_requests_summaries) { []}
+        let(:interaction_list) { instance_double("Pact::Consumer::InteractionList") }
+        subject { VerificationGet::FailureMessage.new(interaction_list).to_s }
+
+        before do
+          allow(interaction_list).to receive(:missing_interactions_summaries).and_return(missing_interactions_summaries)
+          allow(interaction_list).to receive(:interaction_mismatches_summaries).and_return(interaction_mismatches_summaries)
+          allow(interaction_list).to receive(:unexpected_requests_summaries).and_return(unexpected_requests_summaries)
+        end
+
+        context "with only a missing interactions" do
+
+          let(:expected_string) { <<-EOS
+Missing requests:
+\tBlah
+\tThing
+
+EOS
+}
+          it "only includes missing interactions" do
+            expect(subject).to eq expected_string
+          end
+        end
+
+        context "with missing, mismatches and unexpected interactions" do
+
+          let(:interaction_mismatches_summaries) { ["wiffle"]}
+          let(:unexpected_requests_summaries) { ["moose"]}
+
+          let(:expected_string) { <<-EOS
+Incorrect requests:
+\twiffle
+
+Missing requests:
+\tBlah
+\tThing
+
+Unexpected requests:
+\tmoose
+
+EOS
+}
+          it "includes all the things" do
+            expect(subject).to eq expected_string
+          end
+        end
+      end
+    end
+  end
+end