pact 1.0.39 → 1.1.0.rc1

data/lib/pact/matchers/unexpected_index.rb

@@ -1,11 +1,21 @@
-require 'pact/matchers/difference_indicator'
-
 module Pact
-  class UnexpectedIndex < Pact::DifferenceIndicator
+  class UnexpectedIndex
+
+    def == other
+      other.is_a? UnexpectedIndex
+    end
 
     def to_s
       '<index not to exist>'
     end
 
+    def as_json options = {}
+      to_s
+    end
+
+    def to_json opts = {}
+      as_json.to_json options
+    end
+
   end
 end

data/lib/pact/matchers/unexpected_key.rb

@@ -1,11 +1,20 @@
-require 'pact/matchers/difference_indicator'
-
 module Pact
-  class UnexpectedKey < Pact::DifferenceIndicator
+  class UnexpectedKey
+
+    def == other
+      other.is_a? UnexpectedKey
+    end
 
     def to_s
       '<key not to exist>'
     end
 
+    def as_json options = {}
+      to_s
+    end
+
+    def to_json opts = {}
+      as_json.to_json options
+    end
   end
 end

data/lib/pact/provider/configuration.rb

@@ -2,6 +2,10 @@ require 'pact/provider/pact_verification'
 require 'pact/shared/dsl'
 require 'pact/provider/state/provider_state'
 require 'pact/provider/state/provider_state_configured_modules'
+require 'pact/matchers/plus_minus_diff_decorator'
+require 'pact/matchers/nested_json_diff_decorator'
+
+# TODO break this class up!
 
 module Pact
 
@@ -19,6 +23,12 @@ module Pact
     module Configuration
 
       module ConfigurationExtension
+
+        DIFF_FORMATTERS = {
+          :nested_json => Pact::Matchers::NestedJsonDiffDecorator,
+          :plus_and_minus => Pact::Matchers::PlusMinusDiffDecorator
+        }
+
         def provider= provider
           @provider = provider
         end
@@ -47,6 +57,27 @@ module Pact
           @config_ru_path = config_ru_path
         end
 
+        def color_enabled
+          # Can't use ||= when the variable might be false, it will execute the expression if it's false
+          defined?(@color_enabled) ? @color_enabled : true
+        end
+
+        def color_enabled= color_enabled
+          @color_enabled = color_enabled
+        end
+
+        def diff_format= diff_format
+          @diff_format = diff_format
+        end
+
+        def diff_format
+          @diff_format ||= :nested_json
+        end
+
+        def diff_formatter_class
+          DIFF_FORMATTERS.fetch(diff_format)
+        end
+
         def include mod
           Pact::Provider::State::ProviderStateConfiguredModules.instance_eval do
             include mod

data/lib/pact/provider/matchers.rb

@@ -1,17 +1,17 @@
 require 'pact/term'
-require 'pact/consumer_contract/active_support_support'
 require 'awesome_print'
 require 'pact/matchers'
 require 'awesome_print'
 require 'rspec'
+require 'pact/matchers/nested_json_diff_decorator'
+require 'pact/matchers/diff_decorator'
 
 RSpec::Matchers.define :match_term do |expected|
   include Pact::Matchers
-  include Pact::ActiveSupportSupport
 
   match do |actual|
     if (difference = diff(expected, actual)).any?
-      @message = difference
+      @diff_decorator = Pact.configuration.diff_formatter_class.new(difference)
       false
     else
       true
@@ -19,7 +19,7 @@ RSpec::Matchers.define :match_term do |expected|
   end
 
   failure_message_for_should do | actual |
-    fix_json_formatting @message.to_json
+    @diff_decorator.to_s
   end
 
 end

data/lib/pact/provider/pact_spec_runner.rb

@@ -4,8 +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/rspec/formatter'
-require 'pact/provider/rspec/silent_json_formatter'
+require 'pact/provider/print_missing_provider_states'
 require_relative 'rspec'
 
 
@@ -37,7 +36,6 @@ module Pact
           run_specs
         ensure
           ::RSpec.reset
-          Pact.clear_world
         end
       end
 
@@ -45,11 +43,11 @@ module Pact
 
       def require_pact_helper spec_definition
         if spec_definition[:pact_helper]
-          Pact.configuration.output_stream.puts "Using #{spec_definition[:pact_helper]}"
+          puts "Using #{spec_definition[:pact_helper]}"
           require spec_definition[:pact_helper]
         elsif spec_definition[:support_file]
-          Pact.configuration.output_stream.puts "Using #{spec_definition[:support_file]}"
-          Pact.configuration.error_stream.puts SUPPORT_FILE_DEPRECATION_MESSAGE
+          puts "Using #{spec_definition[:support_file]}"
+          $stderr.puts SUPPORT_FILE_DEPRECATION_MESSAGE
           require spec_definition[:support_file]
         else
           require 'pact/provider/client_project_pact_helper'
@@ -72,47 +70,42 @@ module Pact
         config = ::RSpec.configuration
 
         config.color = true
-        config.pattern = "pattern which doesn't match any files"
-        config.backtrace_inclusion_patterns = [/pact\/provider\/rspec/]
-
         config.extend Pact::Provider::RSpec::ClassMethods
         config.include Pact::Provider::RSpec::InstanceMethods
         config.include Pact::Provider::TestMethods
+        config.backtrace_inclusion_patterns = [/pact\/provider\/rspec/]
 
-        if options[:silent]
-          config.output_stream = StringIO.new
-          config.error_stream = StringIO.new
-        else
-          config.error_stream = Pact.configuration.error_stream
-          config.output_stream = Pact.configuration.output_stream
+        config.before :each, :pact => :verify do | example |
+          example_description = "#{example.example.example_group.description} #{example.example.description}"
+          Pact.configuration.logger.info "Running example '#{example_description}'"
         end
 
-        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
+        unless options[:silent]
+          config.error_stream = $stderr
+          config.output_stream = $stdout
         end
-      end
 
-      def run_specs
-        exit_code = ::RSpec::Core::CommandLine.new(NoConfigurationOptions.new)
-          .run(::RSpec.configuration.output_stream, ::RSpec.configuration.error_stream)
-        @output = JSON.parse(Pact.world.json_formatter_stream.string, symbolize_keys: true)
-        exit_code
+        formatter = ::RSpec::Core::Formatters::DocumentationFormatter.new(config.output)
+        @json_formatter = ::RSpec::Core::Formatters::JsonFormatter.new(StringIO.new)
+        reporter =  ::RSpec::Core::Reporter.new(formatter, @json_formatter)
+        config.instance_variable_set(:@reporter, reporter)
       end
 
-      class NoConfigurationOptions
-        def method_missing(method, *args, &block)
-          # Do nothing!
+      def run_specs
+        config = ::RSpec.configuration
+        world = ::RSpec::world
+        exit_code = config.reporter.report(world.example_count, nil) do |reporter|
+          begin
+            config.run_hook(:before, :suite)
+            world.example_groups.ordered.map {|g| g.run(reporter)}.all? ? 0 : config.failure_exit_code
+          ensure
+            config.run_hook(:after, :suite)
+          end
         end
+        PrintMissingProviderStates.call Pact.world.provider_states.missing_provider_states
+        @output = @json_formatter.output_hash
+        exit_code
       end
-
     end
   end
 end

data/lib/pact/provider/print_missing_provider_states.rb

@@ -3,9 +3,9 @@ module Pact
     class PrintMissingProviderStates
 
       # Hash of consumer names to array of names of missing provider states
-      def self.call missing_provider_states, output
+      def self.call missing_provider_states
         if missing_provider_states.any?
-          output.puts orangeify(text(missing_provider_states))
+          puts orangeify(text(missing_provider_states))
         end
       end
 

data/lib/pact/provider/rspec.rb

@@ -19,10 +19,12 @@ module Pact
         include ::RSpec::Core::DSL
 
         def honour_pactfile pactfile_uri, options = {}
-          puts "Filtering specs by: #{options[:criteria]}" if options[:criteria] && options[:criteria].any?
+          puts "Filtering specs by: #{options[:criteria]}" if options[:criteria]
           consumer_contract = Pact::ConsumerContract.from_json(read_pact_from(pactfile_uri, options))
-          describe "Verifying a pact between #{consumer_contract.consumer.name} and #{consumer_contract.provider.name}", :pactfile_uri => pactfile_uri do
-            honour_consumer_contract consumer_contract, options
+          describe "A pact between #{consumer_contract.consumer.name} and #{consumer_contract.provider.name}" do
+            describe "in #{pactfile_uri}" do
+              honour_consumer_contract consumer_contract, options
+            end
           end
         end
 
@@ -58,19 +60,12 @@ module Pact
 
         def describe_interaction interaction, options
 
-          metadata = {
-            :pact => :verify,
-            :pact_interaction => interaction,
-            :pact_interaction_example_description => interaction_description_for_rerun_command(interaction)
-          }
-
-          describe description_for(interaction), metadata do
+          describe description_for(interaction), :pact => :verify do
 
             interaction_context = InteractionContext.new
 
             before do
               interaction_context.run_once :before do
-                Pact.configuration.logger.info "Running example '#{self.example.full_description}'"
                 set_up_provider_state interaction.provider_state, options[:consumer]
                 replay_interaction interaction
                 interaction_context.last_response = last_response
@@ -124,11 +119,7 @@ module Pact
         end
 
         def description_for interaction
-          interaction.provider_state ? interaction.description : interaction.description.capitalize
-        end
-
-        def interaction_description_for_rerun_command interaction
-          description_for(interaction).capitalize + ( interaction.provider_state ? " given #{interaction.provider_state}" : "")
+          "#{interaction.description} using #{interaction.request.method.upcase} to #{interaction.request.path}"
         end
 
         def read_pact_from uri, options = {}

data/lib/pact/provider/world.rb

@@ -14,12 +14,6 @@ module Pact
   module Provider
     class World
 
-      attr_reader :json_formatter_stream
-
-      def initialize
-        @json_formatter_stream = StringIO.new
-      end
-
       def provider_states
         @provider_states_proxy ||= Pact::Provider::State::ProviderStateProxy.new
       end

data/lib/pact/shared/key_not_found.rb

@@ -1,12 +1,25 @@
-require 'pact/matchers/difference_indicator'
-
 module Pact
-  class KeyNotFound < Pact::DifferenceIndicator
+  class KeyNotFound
+    def == other
+      other.is_a? KeyNotFound
+    end
+
+    def eql? other
+      self == other
+    end
 
     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/tasks/task_helper.rb

@@ -1,29 +1,32 @@
 module Pact
   module TaskHelper
+    def failure_message
+      redify(
+        "\n* * * * * * * * * * * * * * * * * * *\n" +
+        "Provider did not honour pact file.\nSee\n * #{Pact.configuration.log_path}\n * #{Pact.configuration.tmp_dir}\nfor logs and pact files." +
+        "\n* * * * * * * * * * * * * * * * * * *\n\n"
+      )
+    end
 
-    extend self
+    def redify string
+      "\e[31m#{string}\e[m"
+    end
 
     def handle_verification_failure
       exit_status = yield
-      abort if exit_status != 0
+      if exit_status != 0
+        $stderr.puts failure_message
+        fail
+      end
     end
 
     def spec_criteria defaults = {description: nil, provider_state: nil}
       criteria = {}
-
-      description = ENV.fetch("PACT_DESCRIPTION", defaults[:description])
-      criteria[:description] = Regexp.new(description) if description
-
-      provider_state = ENV.fetch("PACT_PROVIDER_STATE", defaults[:provider_state])
-      if provider_state
-        if provider_state.length == 0
-          criteria[:provider_state] = nil #Allow PACT_PROVIDER_STATE="" to mean no provider state
-        else
-          criteria[:provider_state] = Regexp.new(provider_state)
-        end
+      [:description, :provider_state].each  do | key |
+        value = ENV.fetch("PACT_#{key.to_s.upcase}", defaults[key])
+        criteria[key] = Regexp.new(value) unless value.nil?
       end
-
-      criteria
+      criteria.any? ? criteria : nil
     end
   end
 end

data/lib/pact/templates/provider_state.erb

@@ -1,3 +1,4 @@
+
 Could not find one or more provider states.
 Have you required the provider states file for this consumer in your pact_helper.rb?
 If you have not yet defined these states, here is a template:

data/lib/pact/version.rb

@@ -1,3 +1,3 @@
 module Pact
-  VERSION = "1.0.39"
+  VERSION = "1.1.0.rc1"
 end

data/spec/lib/pact/matchers/matchers_spec.rb

@@ -158,6 +158,15 @@ module Pact::Matchers
         end
       end
 
+      context "when the different index is in the middle of an array" do
+        subject { [1,2,3] }
+        let(:actual) { [1,7,3]}
+        let(:difference) { [Pact::Matchers::NO_DIFF_INDICATOR, Difference.new(2, 7), Pact::Matchers::NO_DIFF_INDICATOR] }
+        it 'returns the diff' do
+          expect(diff(subject, actual)).to eq(difference)
+        end
+      end
+
       context "when actual array is longer than the expected" do
         subject { [1] }
         let(:actual) { [1,2]}

data/spec/lib/pact/matchers/nested_json_diff_decorator_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'pact/matchers/nested_json_diff_decorator'
+
+module Pact
+  module Matchers
+    describe NestedJsonDiffDecorator do
+
+      let(:diff) do
+        {
+          :something => Difference.new({name: 'Fred'}, KeyNotFound.new)
+        }
+      end
+
+      subject { NestedJsonDiffDecorator.new(diff) }
+
+      describe "#to_s" do
+
+        context "when color_enabled is true" do
+          it "returns nicely formatted json" do
+            expect(subject.to_s.split("\n").size).to eq 8
+          end
+
+          it "returns a string displaying the diff in colour" do
+            expect(subject.to_s).to include NestedJsonDiffDecorator::EXPECTED_COLOURED
+            expect(subject.to_s).to include NestedJsonDiffDecorator::ACTUAL_COLOURED
+          end
+        end
+
+        context "when color_enabled is false" do
+          before do
+            Pact.configuration.stub(:color_enabled).and_return(false)
+          end
+
+          it "returns nicely formatted json" do
+            expect(subject.to_s.split("\n").size).to eq 8
+          end
+
+          it "returns a string displaying the diff without colour" do
+            expect(subject.to_s).to_not include NestedJsonDiffDecorator::EXPECTED_COLOURED
+            expect(subject.to_s).to_not include NestedJsonDiffDecorator::ACTUAL_COLOURED
+          end
+        end
+      end
+
+    end
+
+  end
+end