pact 1.1.1 → 1.2.1.rc1

data/lib/pact/consumer_contract/consumer_contract.rb

@@ -102,7 +102,7 @@ module Pact
 
     def pactfile_path
       raise 'You must first specify a consumer and service name' unless (consumer && consumer.name && provider && provider.name)
-      @pactfile_path ||= File.join(Pact.configuration.pact_dir, pact_file_name)
+      @pactfile_path ||= file_path consumer.name, provider.name
     end
 
     def update_pactfile

data/lib/pact/consumer_contract/consumer_contract_writer.rb

@@ -0,0 +1,84 @@
+require 'pact/consumer_contract'
+require 'pact/consumer/interactions_filter'
+require 'pact/consumer_contract/file_name'
+
+module Pact
+
+  class ConsumerContractWriter
+
+    attr_reader :consumer_contract_details, :pactfile_write_mode, :interactions, :logger
+
+    def initialize consumer_contract_details, logger
+      @logger = logger
+      @consumer_contract_details = consumer_contract_details
+      @pactfile_write_mode = consumer_contract_details.fetch(:pactfile_write_mode, :overwrite).to_sym
+      @interactions = consumer_contract_details.fetch(:interactions)
+    end
+
+    def consumer_contract
+      @consumer_contract ||= Pact::ConsumerContract.new(
+        consumer: ServiceConsumer.new(name: consumer_contract_details[:consumer][:name]),
+        provider: ServiceProvider.new(name: consumer_contract_details[:provider][:name]),
+        interactions: interactions_for_new_consumer_contract)
+    end
+
+    def write
+      consumer_contract.update_pactfile
+      consumer_contract.to_json
+    end
+
+    def interactions_for_new_consumer_contract
+      if pactfile_write_mode == :update
+        merged_interactions = existing_interactions
+        filter = Consumer::UpdatableInteractionsFilter.new(merged_interactions)
+        interactions.each {|i| filter << i }
+        merged_interactions
+      else
+        interactions
+      end
+    end
+
+    def existing_interactions
+      interactions = []
+      if pactfile_exists?
+        begin
+          interactions = existing_consumer_contract.interactions
+          info_and_puts "*****************************************************************************"
+          info_and_puts "Updating existing file .#{pactfile_path.gsub(Dir.pwd, '')} as config.pactfile_write_mode is :update"
+          info_and_puts "Only interactions defined in this test run will be updated."
+          info_and_puts "As interactions are identified by description and provider state, pleased note that if either of these have changed, the old interactions won't be removed from the pact file until the specs are next run with :pactfile_write_mode => :overwrite."
+          info_and_puts "*****************************************************************************"
+        rescue StandardError => e
+          warn_and_stderr "Could not load existing consumer contract from #{pactfile_path} due to #{e}"
+          logger.error e
+          logger.error e.backtrace
+          warn_and_stderr "Creating a new file."
+        end
+      end
+      interactions
+    end
+
+    def pactfile_exists?
+      File.exist?(pactfile_path)
+    end
+
+    def pactfile_path
+      Pact::FileName.file_path consumer_contract_details[:consumer][:name], consumer_contract_details[:provider][:name]
+    end
+
+    def existing_consumer_contract
+      Pact::ConsumerContract.from_uri(pactfile_path)
+    end
+
+    def warn_and_stderr msg
+      Pact.configuration.error_stream.puts msg
+      logger.warn msg
+    end
+
+    def info_and_puts msg
+      $stdout.puts msg
+      logger.info msg
+    end
+  end
+
+end

data/lib/pact/consumer_contract/file_name.rb

@@ -1,11 +1,17 @@
 module Pact
 
-  #TODO move to external file for reuse
   module FileName
+
+    extend self
+
     def file_name consumer_name, provider_name
       "#{filenamify(consumer_name)}-#{filenamify(provider_name)}.json"
     end
 
+    def file_path consumer_name, provider_name, pact_dir = Pact.configuration.pact_dir
+      File.join(pact_dir, file_name(consumer_name, provider_name))
+    end
+
     def filenamify name
       name.downcase.gsub(/\s/, '_')
     end

data/lib/pact/provider/pact_helper_locator.rb

@@ -13,7 +13,7 @@ module Pact
           pact_helper_search_results = []
           PACT_HELPER_FILE_PATTERNS.find { | pattern | (pact_helper_search_results.concat(Dir.glob(pattern))).any? }
           raise NO_PACT_HELPER_FOUND_MSG if pact_helper_search_results.empty?
-          "#{Dir.pwd}/#{pact_helper_search_results[0]}"
+          File.join(Dir.pwd, pact_helper_search_results[0])
         end
 
     end

data/lib/pact/provider/pact_spec_runner.rb

@@ -2,10 +2,7 @@ require 'open-uri'
 require 'rspec'
 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/project_root'
 require 'pact/rspec'
 
@@ -35,7 +32,7 @@ module Pact
           run_specs
         ensure
           ::RSpec.reset
-          Pact.clear_world
+          Pact.clear_provider_world
         end
       end
 
@@ -72,8 +69,7 @@ module Pact
           config.output_stream = Pact.configuration.output_stream
         end
 
-        config.add_formatter Pact::Provider::RSpec::Formatter
-        config.add_formatter Pact::Provider::RSpec::SilentJsonFormatter
+        config.add_formatter Pact::RSpec.formatter_class
 
         config.before(:suite) do
           # Preload app before suite so the classes loaded in memory are consistent for
@@ -87,13 +83,11 @@ module Pact
 
       def run_specs
         exit_code = if Pact::RSpec.runner_defined?
-          ::RSpec::Core::Runner.run(rspec_runner_options,
-            ::RSpec.configuration.output_stream, ::RSpec.configuration.error_stream)
+          ::RSpec::Core::Runner.run(rspec_runner_options)
         else
           ::RSpec::Core::CommandLine.new(NoConfigurationOptions.new)
             .run(::RSpec.configuration.output_stream, ::RSpec.configuration.error_stream)
         end
-        @output = JSON.parse(Pact.world.json_formatter_stream.string, symbolize_keys: true)
         exit_code
       end
 

data/lib/pact/provider/rspec/{formatter.rb → formatter_rspec_2.rb}

@@ -5,7 +5,7 @@ require 'term/ansicolor'
 module Pact
   module Provider
     module RSpec
-      class Formatter < ::RSpec::Core::Formatters::DocumentationFormatter
+      class Formatter2 < ::RSpec::Core::Formatters::DocumentationFormatter
 
         C = ::Term::ANSIColor
 
@@ -28,7 +28,7 @@ module Pact
         end
 
         def print_missing_provider_states
-          PrintMissingProviderStates.call Pact.world.provider_states.missing_provider_states, output
+          PrintMissingProviderStates.call Pact.provider_world.provider_states.missing_provider_states, output
         end
 
         def interaction_rerun_commands

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

@@ -0,0 +1,96 @@
+require 'pact/provider/print_missing_provider_states'
+require 'rspec/core/formatters'
+require 'term/ansicolor'
+
+module Pact
+  module Provider
+    module RSpec
+      class Formatter < ::RSpec::Core::Formatters::DocumentationFormatter
+
+        Pact::RSpec.with_rspec_3 do
+          ::RSpec::Core::Formatters.register self, :example_group_started, :example_group_finished,
+                                    :example_passed, :example_pending, :example_failed
+        end
+
+        C = ::Term::ANSIColor
+
+        def dump_summary(summary)
+          output.puts "\n" + colorized_totals_line(summary)
+          return if summary.failure_count == 0
+          print_rerun_commands summary
+          print_failure_message
+          print_missing_provider_states
+        end
+
+        private
+
+        def interactions_count(summary)
+          summary.examples.collect{ |e|e.metadata[:pact_interaction_example_description]}.uniq.size
+        end
+
+        def failed_interactions_count(summary)
+          summary.failed_examples.collect{ |e|e.metadata[:pact_interaction_example_description]}.uniq.size
+        end
+
+        def totals_line summary
+          line = ::RSpec::Core::Formatters::Helpers.pluralize(interactions_count(summary), "interaction")
+          line << ", " << ::RSpec::Core::Formatters::Helpers.pluralize(failed_interactions_count(summary), "failure")
+          line
+        end
+
+        def colorized_totals_line(summary)
+          if summary.failure_count > 0
+            colorizer.wrap(totals_line(summary), ::RSpec.configuration.failure_color)
+          else
+            colorizer.wrap(totals_line(summary), ::RSpec.configuration.success_color)
+          end
+        end
+
+        def print_rerun_commands summary
+          output.puts("\nFailed interactions:\n\n")
+          interaction_rerun_commands(summary).each do | message |
+            output.puts(message)
+          end
+        end
+
+        def print_missing_provider_states
+          PrintMissingProviderStates.call Pact.provider_world.provider_states.missing_provider_states, output
+        end
+
+        def interaction_rerun_commands summary
+          summary.failed_examples.collect do |example|
+            interaction_rerun_command_for example
+          end.uniq
+        end
+
+        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]
+          example_description = example.metadata[:pact_interaction_example_description]
+          colorizer.wrap("rake pact:verify:at[#{pactfile_uri}] PACT_DESCRIPTION=\"#{description}\" PACT_PROVIDER_STATE=\"#{provider_state}\" ", ::RSpec.configuration.failure_color) +
+            colorizer.wrap("# #{example_description}", ::RSpec.configuration.detail_color)
+        end
+
+        def print_failure_message
+          output.puts failure_message
+        end
+
+        def failure_message
+          "\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
+
+        def colorizer
+          @colorizer ||= ::RSpec::Core::Formatters::ConsoleCodes
+        end
+
+      end
+
+    end
+
+  end
+end
+
+

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

@@ -3,32 +3,92 @@ require 'pact/matchers'
 require 'pact/provider/matchers/messages'
 require 'pact/rspec'
 
-RSpec::Matchers.define :match_term do |expected|
+module Pact
+  module RSpec
+    module Matchers
 
-  include Pact::Matchers
-  include Pact::Matchers::Messages
+      module RSpec2Delegator
+        # For backwards compatiblity with rspec-2
+        def method_missing(method, *args, &block)
+          if method_name == :failure_message_for_should
+            failure_message method, *args, &block
+          else
+            super
+          end
+        end
+      end
 
-  match do |actual|
-    (@difference = diff(expected, actual)).empty?
-  end
+      class MatchTerm
 
-  failure_message_for_should do | actual |
-    match_term_failure_message @difference, actual, Pact::RSpec.color_enabled?
-  end
+        include Pact::Matchers
+        include Pact::Matchers::Messages
+        include RSpec2Delegator
 
-end
+        def initialize expected
+          @expected = expected
+        end
 
-RSpec::Matchers.define :match_header do |header_name, expected|
+        def matches? actual
+          @actual = actual
+          (@difference = diff(@expected, @actual)).empty?
+        end
 
-  include Pact::Matchers
-  include Pact::Matchers::Messages
+        def failure_message
+          match_term_failure_message @difference, @actual, Pact::RSpec.color_enabled?
+        end
 
-  match do |actual|
-    diff(expected, actual).empty?
-  end
+      end
+
+      def match_term expected
+        MatchTerm.new(expected)
+      end
+
+      class MatchHeader
+
+        include Pact::Matchers
+        include Pact::Matchers::Messages
+        include RSpec2Delegator
+
+        def initialize header_name, expected
+          @header_name = header_name
+          @expected = expected
+        end
+
+        def matches? actual
+          @actual = actual
+          diff(@expected, @actual).empty?
+        end
+
+        def failure_message
+          match_header_failure_message @header_name, @expected, @actual
+        end
 
-  failure_message_for_should do | actual |
-    match_header_failure_message header_name, expected, actual
+      end
+
+      def match_header header_name, expected
+        MatchHeader.new(header_name, expected)
+      end
+
+    end
   end
+end
+
+
+# RSpec::Matchers.define :match_header do |header_name, expected|
+
+#   include Pact::Matchers
+#   include Pact::Matchers::Messages
+
+#   match do |actual|
+#     diff(expected, actual).empty?
+#   end
+
+#   def failure_message_for_should(actual)
+#     match_header_failure_message header_name, expected, actual
+#   end
+
+#   # failure_message_for_should do | actual |
+#   #   match_header_failure_message header_name, expected, actual
+#   # end
 
-end
+# end

data/lib/pact/provider/rspec.rb

@@ -23,7 +23,7 @@ module Pact
           puts "Reading pact at #{pactfile_uri}"
           puts "Filtering interactions by: #{options[:criteria]}" if options[:criteria] && options[:criteria].any?
           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
+          ::RSpec.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
           end
         end
@@ -99,6 +99,8 @@ module Pact
 
           describe "returns a response which" do
 
+            include Pact::RSpec::Matchers
+
             let(:expected_response_status) { expected_response['status'] }
             let(:expected_response_body) { expected_response['body'] }
             let(:response) { interaction_context.last_response }

data/lib/pact/provider/state/provider_state_configured_modules.rb

@@ -1,7 +1,13 @@
+require 'rspec/mocks'
+
 module Pact
   module Provider::State
     module ProviderStateConfiguredModules
+
+      include ::RSpec::Mocks::ExampleMethods
+
       # Placeholder for modules configured using config.include
+
     end
   end
 end

data/lib/pact/provider/state/provider_state_manager.rb

@@ -26,15 +26,15 @@ module Pact
       end
 
       def get_provider_state
-        Pact.world.provider_states.get(provider_state_name, :for => consumer)
+        Pact.provider_world.provider_states.get(provider_state_name, :for => consumer)
       end
 
       def get_consumer_base_provider_state
-        Pact.world.provider_states.get_base(:for => consumer)
+        Pact.provider_world.provider_states.get_base(:for => consumer)
       end
 
       def get_global_base_provider_state
-        Pact.world.provider_states.get_base
+        Pact.provider_world.provider_states.get_base
       end
 
     end

data/lib/pact/provider/world.rb

@@ -2,24 +2,18 @@ require 'pact/provider/state/provider_state_proxy'
 
 module Pact
 
-  def self.world
+  def self.provider_world
     @world ||= Pact::Provider::World.new
   end
 
   # internal api, for testing only
-  def self.clear_world
+  def self.clear_provider_world
     @world = nil
   end
 
   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/rspec.rb

@@ -1,3 +1,4 @@
+# This is horrible, must work out a better way of doing this
 module Pact
   module RSpec
 
@@ -9,6 +10,17 @@ module Pact
       end
     end
 
+    def self.formatter_class
+      if ::RSpec::Core::Formatters.respond_to?(:register)
+        require 'pact/provider/rspec/formatter_rspec_3'
+        Pact::Provider::RSpec::Formatter
+      else
+        require 'pact/provider/rspec/formatter_rspec_2'
+        Pact::Provider::RSpec::Formatter2
+      end
+
+    end
+
     def self.full_description example
       example.respond_to?(:full_description) ? example.full_description : example.example.full_description
     end
@@ -16,5 +28,25 @@ module Pact
     def self.runner_defined?
       defined?(::RSpec::Core::Runner)
     end
+
+    def self.is_rspec_3
+      ::RSpec::Core::Formatters.respond_to?(:register)
+    end
+
+    def self.is_rspec_2
+      !is_rspec_3
+    end
+
+    def self.with_rspec_3
+      if is_rspec_3
+        yield
+      end
+    end
+
+    def self.with_rspec_2
+      if is_rspec_2
+        yield
+      end
+    end
   end
 end

data/lib/pact/version.rb

@@ -1,3 +1,3 @@
 module Pact
-  VERSION = "1.1.1"
+  VERSION = "1.2.1.rc1"
 end

data/pact.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |gem|
   gem.license       = 'MIT'
 
   gem.add_runtime_dependency 'randexp', '~> 0.1.7'
-  gem.add_runtime_dependency 'rspec', '~> 2.12'
+  gem.add_runtime_dependency 'rspec', '>=2.14'
   gem.add_runtime_dependency 'find_a_port', '~> 1.0.1'
   gem.add_runtime_dependency 'rack-test', '~> 0.6.2'
   gem.add_runtime_dependency 'awesome_print', '~> 1.1'
@@ -29,10 +29,10 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'term-ansicolor', '~> 1.0'
 
   gem.add_development_dependency 'rake', '~> 10.0.3'
-  gem.add_development_dependency 'webmock', '~> 1.9.3'
+  gem.add_development_dependency 'webmock', '~> 1.18.0'
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'fakefs', '~> 0.4'
   gem.add_development_dependency 'hashie', '~> 2.0'
-  gem.add_development_dependency 'rspec-fire'
   gem.add_development_dependency 'activesupport'
+  gem.add_development_dependency 'faraday'
 end

data/spec/features/consumption_spec.rb

@@ -1,14 +1,19 @@
 require 'net/http'
 require 'pact/consumer'
 require 'pact/consumer/rspec'
+load 'pact/consumer/world.rb'
 
 describe "A service consumer side of a pact", :pact => true  do
 
+  before do
+    Pact.clear_configuration
+    Pact.clear_consumer_world
+  end
+
   describe "blah" do
     describe "thing" do
 
   it "goes a little something like this" do
-    Pact.clear_configuration
 
     Pact.service_consumer "Consumer" do
       has_pact_with "Alice Service" do

data/spec/integration/consumer_spec.rb

@@ -2,6 +2,8 @@ require 'spec_helper'
 require 'net/http'
 require 'pact/consumer'
 require 'pact/consumer/rspec'
+require 'faraday'
+load 'pact/consumer/world.rb'
 
 describe "A service consumer side of a pact", :pact => true  do
 
@@ -12,6 +14,7 @@ describe "A service consumer side of a pact", :pact => true  do
 
     it "returns an error" do
       Pact.clear_configuration
+      Pact.clear_consumer_world
 
       Pact.service_consumer "Consumer" do
         has_pact_with "Mary Service" do
@@ -109,6 +112,8 @@ describe "A service consumer side of a pact", :pact => true  do
       end
     end
 
+    let(:body) { 'That is some good Mallory.' }
+
     it "goes like this" do
       zebra_service.
         given(:the_zebras_are_here).
@@ -120,12 +125,14 @@ describe "A service consumer side of a pact", :pact => true  do
         will_respond_with({
           status: 200,
           headers: { 'Content-Type' => 'text/html' },
-          body: Pact::Term.new(matcher: /Mallory/, generate: 'That is some good Mallory.')
+          body: Pact::Term.new(matcher: /Mallory/, generate: body)
         })
 
-        interactions = Pact::ConsumerContract.from_json(File.read(zebra_service.consumer_contract.pactfile_path)).interactions
-        interactions.first.provider_state.should eq("the_zebras_are_here")
-        sleep 1
+      response = Faraday.get(zebra_service.mock_service_base_url + "/mallory", nil, {'Accept' => 'text/html'})
+      expect(response.body).to eq body
+
+      interactions = Pact::ConsumerContract.from_json(zebra_service.write_pact).interactions
+      expect(interactions.first.provider_state).to eq("the_zebras_are_here")
     end
   end
 
@@ -146,11 +153,6 @@ describe "A service consumer side of a pact", :pact => true  do
         upon_receiving("a request with multiple headers").
         with(method: :get, path: '/something', headers: {'X-Something' => "1, 2"}).
         will_respond_with(status: 200)
-    end
-
-    it "handles multiple headers with the same name in a comma separated list" do
-        interactions = Pact::ConsumerContract.from_json(File.read(multi_headers_service.consumer_contract.pactfile_path)).interactions
-        expect(interactions.first.request.headers['X-Something']).to eq("1, 2")
 
         uri = URI('http://localhost:1240/something')
         post_req = Net::HTTP::Get.new(uri.path)
@@ -161,6 +163,11 @@ describe "A service consumer side of a pact", :pact => true  do
         end
     end
 
+    it "handles multiple headers with the same name in a comma separated list" do
+      interactions = Pact::ConsumerContract.from_json(multi_headers_service.write_pact).interactions
+      expect(interactions.first.request.headers['X-Something']).to eq("1, 2")
+    end
+
   end
 
   context "with a async interaction with provider" do