pact 1.1.0 → 1.1.1

data/lib/pact/consumer/rspec.rb

@@ -1,5 +1,6 @@
 require 'pact/consumer'
 require 'pact/consumer/spec_hooks'
+require 'pact/rspec'
 
 module Pact
   module Consumer
@@ -19,11 +20,11 @@ RSpec.configure do |config|
   end
 
   config.before :each, :pact => true do | example |
-    hooks.before_each example.example.full_description
+    hooks.before_each Pact::RSpec.full_description(example)
   end
 
   config.after :each, :pact => true do | example |
-    hooks.after_each example.example.full_description
+    hooks.after_each Pact::RSpec.full_description(example)
   end
 
   config.after :suite do

data/lib/pact/doc/doc_file.rb

@@ -3,10 +3,10 @@ module Pact
 
     class DocFile
 
-      def initialize consumer_contract, dir, interactions_renderer, file_extension
+      def initialize consumer_contract, dir, consumer_contract_renderer, file_extension
         @dir = dir
         @consumer_contract = consumer_contract
-        @interactions_renderer = interactions_renderer
+        @consumer_contract_renderer = consumer_contract_renderer
         @file_extension = file_extension
       end
 
@@ -24,7 +24,7 @@ module Pact
 
       private
 
-      attr_reader :dir, :consumer_contract, :interactions_renderer, :file_extension
+      attr_reader :dir, :consumer_contract, :consumer_contract_renderer, :file_extension
 
 
       def path
@@ -32,7 +32,7 @@ module Pact
       end
 
       def doc_file_contents
-        interactions_renderer.call(consumer_contract)
+        consumer_contract_renderer.call(consumer_contract)
       end
 
     end

data/lib/pact/doc/generator.rb

@@ -9,7 +9,7 @@ module Pact
       def initialize pact_dir, doc_dir, options
         @doc_dir = doc_dir
         @pact_dir = pact_dir
-        @interactions_renderer = options[:interactions_renderer]
+        @consumer_contract_renderer = options[:consumer_contract_renderer]
         @doc_type = options[:doc_type]
         @file_extension = options[:file_extension]
         @index_renderer = options[:index_renderer]
@@ -26,7 +26,7 @@ module Pact
 
       private
 
-      attr_reader :doc_dir, :pact_dir, :interactions_renderer, :doc_type, :file_extension, :index_renderer, :after
+      attr_reader :doc_dir, :pact_dir, :consumer_contract_renderer, :doc_type, :file_extension, :index_renderer, :after
 
       def write_index
         File.open(index_file_path, "w") { |io|  io << index_file_contents }
@@ -52,7 +52,7 @@ module Pact
 
       def doc_files
         consumer_contracts.collect do | consumer_contract |
-          DocFile.new(consumer_contract, target_dir, interactions_renderer, file_extension)
+          DocFile.new(consumer_contract, target_dir, consumer_contract_renderer, file_extension)
         end
       end
 

data/lib/pact/doc/interaction_view_model.rb

@@ -1,4 +1,5 @@
 require 'pact/shared/active_support_support'
+require 'pact/reification'
 
 module Pact
   module Doc

data/lib/pact/doc/markdown/{interactions_renderer.rb → consumer_contract_renderer.rb}

@@ -4,7 +4,7 @@ require 'pact/doc/sort_interactions'
 module Pact
   module Doc
     module Markdown
-      class InteractionsRenderer
+      class ConsumerContractRenderer
 
         def initialize consumer_contract
           @consumer_contract = consumer_contract

data/lib/pact/doc/markdown/generator.rb

@@ -1,5 +1,5 @@
 require 'pact/doc/generator'
-require 'pact/doc/markdown/interactions_renderer'
+require 'pact/doc/markdown/consumer_contract_renderer'
 require 'pact/doc/markdown/index_renderer'
 
 module Pact
@@ -9,7 +9,7 @@ module Pact
 
         def initialize pact_dir, doc_dir
           super(pact_dir, doc_dir,
-            interactions_renderer: InteractionsRenderer,
+            consumer_contract_renderer: ConsumerContractRenderer,
             doc_type: 'markdown',
             file_extension: '.md',
             index_renderer: IndexRenderer,

data/lib/pact/matchers/unix_diff_formatter.rb

@@ -24,7 +24,7 @@ module Pact
       def to_s
         expected = generate_string(diff, :expected)
         actual = generate_string(diff, :actual)
-        Pact::Matchers::Differ.new(@colour).diff_as_string actual, expected
+        Pact::Matchers::Differ.new(@colour).diff_as_string(actual, expected).lstrip
       end
 
       private

data/lib/pact/project_root.rb

@@ -0,0 +1,7 @@
+require 'pathname'
+
+module Pact
+  def self.project_root
+    @project_root ||= Pathname.new(File.expand_path('../../../',__FILE__)).freeze
+  end
+end

data/lib/pact/provider.rb

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

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

@@ -5,32 +5,34 @@ module Pact
   module Matchers
     module Messages
 
-      def match_term_failure_message diff, color_enabled
-        message = Pact.configuration.diff_formatter.call(diff)
+      def match_term_failure_message diff, actual, color_enabled
+        message = "Actual: #{(String === actual ? actual : actual.to_json)}\n\n"
+        formatted_diff = Pact.configuration.diff_formatter.call(diff)
+        message + colorize_if_enabled(formatted_diff, color_enabled)
+      end
+
+      def match_header_failure_message header_name, expected, actual
+        "Expected header \"#{header_name}\" to #{expected_desc(expected)}, but was #{actual_desc(actual)}"
+      end
+
+      private
 
+      def colorize_if_enabled formatted_diff, color_enabled
         if color_enabled
           # RSpec wraps each line in the failure message with failure_color, turning it red.
           # To ensure the lines in the diff that should be white, stay white, put an
           # ANSI reset at the start of each line.
-          message.split("\n").collect{ |line| ::Term::ANSIColor.reset + line }.join("\n")
+          formatted_diff.split("\n").collect{ |line| ::Term::ANSIColor.reset + line }.join("\n")
         else
-          message
+          formatted_diff
         end
-
       end
 
-      def match_header_failure_message header_name, expected, actual
-        "Expected header \"#{header_name}\" to #{expected_desc(expected)}, but was #{actual_desc(actual)}"
-      end
-
-      private
-
       def expected_desc expected
         case expected
-        when Pact::Term then "match #{expected.matcher.inspect}"
         when NilClass then "be nil"
         else
-          "match \"#{expected}\""
+          "match #{expected.inspect}"
         end
       end
 

data/lib/pact/provider/pact_spec_runner.rb

@@ -6,6 +6,9 @@ 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'
+
 require_relative 'rspec'
 
 
@@ -15,11 +18,6 @@ module Pact
 
       include Pact::Provider::RSpec::ClassMethods
 
-      SUPPORT_FILE_DEPRECATION_MESSAGE = "The :support_file option is deprecated. " +
-        "The preferred way to specify a support file is to create a pact_helper.rb in one of the following paths: " +
-        Pact::Provider::PactHelperLocater::PACT_HELPER_FILE_PATTERNS.join(", ") +
-        ". If you cannot do this, you may use the :pact_helper option in place of the :support_file option."
-
       attr_reader :spec_definitions
       attr_reader :options
       attr_reader :output
@@ -43,22 +41,8 @@ module Pact
 
       private
 
-      def require_pact_helper spec_definition
-        if spec_definition[:pact_helper]
-          Pact.configuration.output_stream.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
-          require spec_definition[:support_file]
-        else
-          require 'pact/provider/client_project_pact_helper'
-        end
-      end
-
       def initialize_specs
         spec_definitions.each do | spec_definition |
-          require_pact_helper spec_definition
           options = {
             consumer: spec_definition[:consumer],
             save_pactfile_to_tmp: true,
@@ -73,7 +57,7 @@ module Pact
 
         config.color = true
         config.pattern = "pattern which doesn't match any files"
-        config.backtrace_inclusion_patterns = [/pact\/provider\/rspec/]
+        config.backtrace_inclusion_patterns = [Regexp.new(Dir.getwd), /pact.*pact\.rake.*2/]
         config.backtrace_exclusion_patterns << /pact/
 
         config.extend Pact::Provider::RSpec::ClassMethods
@@ -102,12 +86,27 @@ module Pact
       end
 
       def run_specs
-        exit_code = ::RSpec::Core::CommandLine.new(NoConfigurationOptions.new)
-          .run(::RSpec.configuration.output_stream, ::RSpec.configuration.error_stream)
+        exit_code = if Pact::RSpec.runner_defined?
+          ::RSpec::Core::Runner.run(rspec_runner_options,
+            ::RSpec.configuration.output_stream, ::RSpec.configuration.error_stream)
+        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
 
+      def rspec_runner_options
+        ["--options", Pact.project_root.join("lib/pact/provider/rspec/custom_options_file").to_s]
+      end
+
+      def class_exists? name
+        Kernel.const_get name
+      rescue NameError
+        false
+      end
+
       class NoConfigurationOptions
         def method_missing(method, *args, &block)
           # Do nothing!

data/lib/pact/provider/rspec.rb

@@ -1,6 +1,6 @@
 require 'open-uri'
 require 'pact/consumer_contract'
-require 'pact/provider/matchers'
+require 'pact/provider/rspec/matchers'
 require 'pact/provider/test_methods'
 require 'pact/provider/configuration'
 
@@ -19,7 +19,9 @@ module Pact
         include ::RSpec::Core::DSL
 
         def honour_pactfile pactfile_uri, options = {}
-          puts "Filtering specs by: #{options[:criteria]}" if options[:criteria] && options[:criteria].any?
+          #TODO change puts to use output stream
+          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
             honour_consumer_contract consumer_contract, options
@@ -66,24 +68,29 @@ module Pact
 
           describe description_for(interaction), metadata do
 
-            interaction_context = InteractionContext.new
+            describe "with #{interaction.request.method_and_path}" do
 
-            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
+              interaction_context = InteractionContext.new
+
+              before do | example |
+                interaction_context.run_once :before do
+                  Pact.configuration.logger.info "Running example '#{Pact::RSpec.full_description(example)}'"
+                  set_up_provider_state interaction.provider_state, options[:consumer]
+                  replay_interaction interaction
+                  interaction_context.last_response = last_response
+                end
               end
-            end
 
-            after do
-              interaction_context.run_once :after do
-                tear_down_provider_state interaction.provider_state, options[:consumer]
+              after do
+                interaction_context.run_once :after do
+                  tear_down_provider_state interaction.provider_state, options[:consumer]
+                end
               end
+
+              describe_response Pact::Term.unpack_regexps(interaction.response), interaction_context
+
             end
 
-            describe_response interaction.response, interaction_context
           end
 
         end
@@ -107,7 +114,7 @@ module Pact
             if expected_response['headers']
               describe "includes headers" do
                 expected_response['headers'].each do |name, expected_header_value|
-                  it "\"#{name}\" with value \"#{expected_header_value}\"" do
+                  it "\"#{name}\" with value #{expected_header_value.inspect}" do
                     header_value = response.headers[name]
                     expect(header_value).to match_header(name, expected_header_value)
                   end

data/lib/pact/provider/{matchers.rb → rspec/matchers.rb}

@@ -1,6 +1,7 @@
 require 'rspec'
 require 'pact/matchers'
 require 'pact/provider/matchers/messages'
+require 'pact/rspec'
 
 RSpec::Matchers.define :match_term do |expected|
 
@@ -12,7 +13,7 @@ RSpec::Matchers.define :match_term do |expected|
   end
 
   failure_message_for_should do | actual |
-    match_term_failure_message @difference, ::RSpec.configuration.color_enabled
+    match_term_failure_message @difference, actual, Pact::RSpec.color_enabled?
   end
 
 end

data/lib/pact/rspec.rb

@@ -0,0 +1,20 @@
+module Pact
+  module RSpec
+
+    def self.color_enabled?
+      if ::RSpec.configuration.respond_to?(:color_enabled?)
+        ::RSpec.configuration.color_enabled?(::RSpec.configuration.output_stream)
+      else
+        ::RSpec.configuration.color_enabled?
+      end
+    end
+
+    def self.full_description example
+      example.respond_to?(:full_description) ? example.full_description : example.example.full_description
+    end
+
+    def self.runner_defined?
+      defined?(::RSpec::Core::Runner)
+    end
+  end
+end

data/lib/pact/shared/request.rb

@@ -41,7 +41,7 @@ module Pact
       end
 
       def method_and_path
-        "#{method.upcase} #{display_path}"
+        "#{method.upcase} #{full_path}"
       end
 
       def full_path

data/lib/pact/tasks/task_helper.rb

@@ -1,29 +1,32 @@
+require 'pact/provider/pact_helper_locator'
+require 'rake/file_utils'
+
 module Pact
   module TaskHelper
 
     extend self
 
+    def execute_pact_verify pact_uri = nil, pact_helper = nil
+      execute_cmd verify_command(pact_helper || Pact::Provider::PactHelperLocater.pact_helper_path, pact_uri)
+    end
+
     def handle_verification_failure
       exit_status = yield
       abort if exit_status != 0
     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
-      end
+    def verify_command pact_helper, pact_uri = nil
+      command_parts = []
+      command_parts << FileUtils::RUBY
+      command_parts << "-S pact verify"
+      command_parts << "-h" << (pact_helper.end_with?(".rb") ? pact_helper : pact_helper + ".rb")
+      (command_parts << "-p" << pact_uri) if pact_uri
+      command_parts.flatten.join(" ")
+    end
 
-      criteria
+    def execute_cmd command
+      system(command) ? 0 : 1
     end
+
   end
 end

data/lib/pact/tasks/verification_task.rb

@@ -1,7 +1,4 @@
 require 'rake/tasklib'
-require 'pact/provider/pact_spec_runner'
-require 'pact/provider/verification_report'
-require 'pact/tasks/task_helper'
 
 =begin
   To create a rake pact:verify:<something> task
@@ -30,58 +27,55 @@ require 'pact/tasks/task_helper'
 
 module Pact
   class VerificationTask < ::Rake::TaskLib
-    attr_reader :pact_spec_config
 
-    include Pact::TaskHelper
+    attr_reader :pact_spec_configs
+
     def initialize(name)
-      @pact_spec_config = []
+      @pact_spec_configs = []
       @name = name
       yield self
       rake_task
     end
 
     def uri(uri, options = {})
-      @pact_spec_config << {uri: uri, support_file: options[:support_file], pact_helper: options[:pact_helper]}
+      @pact_spec_configs << {uri: uri, pact_helper: options[:pact_helper]}
     end
 
     private
 
     attr_reader :name
 
-    def parse_pactfile config
-      Pact::ConsumerContract.from_uri config[:uri]
-    end
+    # def parse_pactfile config
+    #   Pact::ConsumerContract.from_uri config[:uri]
+    # end
 
-    def publish_report config, output, result, provider_ref, reports_dir
-      consumer_contract = parse_pactfile config
-      #TODO - when checking out a historical version, provider ref will be prod, however it will think it is head. Fix this!!!!
-      report = Provider::VerificationReport.new(
-        :result => result,
-        :output => output,
-        :consumer => {:name => consumer_contract.consumer.name, :ref => name},
-        :provider => {:name => consumer_contract.provider.name, :ref => provider_ref}
-      )
-
-      FileUtils.mkdir_p reports_dir
-      File.open("#{reports_dir}/#{report.report_file_name}", "w") { |file| file << JSON.pretty_generate(report) }
-    end
+    # def publish_report config, output, result, provider_ref, reports_dir
+    #   consumer_contract = parse_pactfile config
+    #   #TODO - when checking out a historical version, provider ref will be prod, however it will think it is head. Fix this!!!!
+    #   report = Provider::VerificationReport.new(
+    #     :result => result,
+    #     :output => output,
+    #     :consumer => {:name => consumer_contract.consumer.name, :ref => name},
+    #     :provider => {:name => consumer_contract.provider.name, :ref => provider_ref}
+    #   )
+
+    #   FileUtils.mkdir_p reports_dir
+    #   File.open("#{reports_dir}/#{report.report_file_name}", "w") { |file| file << JSON.pretty_generate(report) }
+    # end
 
     def rake_task
       namespace :pact do
+
         desc "Verify provider against the consumer pacts for #{name}"
-        task "verify:#{name}", :description, :provider_state do |t, args|
+        task "verify:#{name}" do |t, args|
 
-          options = {criteria: spec_criteria(args)}
+          require 'pact/tasks/task_helper'
 
-          exit_statuses = pact_spec_config.collect do | config |
-            #TODO: Change this to accept the ConsumerContract that is already parsed, so we don't make the same request twice
-            pact_spec_runner = Provider::PactSpecRunner.new([config], options)
-            exit_status = pact_spec_runner.run
-            publish_report config, pact_spec_runner.output, exit_status == 0, 'head', Pact.configuration.reports_dir
-            exit_status
+          exit_statuses = pact_spec_configs.collect do | config |
+            Pact::TaskHelper.execute_pact_verify config[:uri], config[:pact_helper]
           end
 
-          handle_verification_failure do
+          Pact::TaskHelper.handle_verification_failure do
             exit_statuses.count{ | status | status != 0 }
           end
         end