pact 1.0.15 → 1.0.18

data/lib/pact/consumer_contract/interaction.rb

@@ -1,8 +1,10 @@
 require 'pact/consumer_contract/request'
 require 'pact/symbolize_keys'
+require 'pact/consumer_contract/active_support_support'
 
 module Pact
    class Interaction
+    include ActiveSupportSupport
       include SymbolizeKeys
 
       attr_accessor :description, :request, :response, :provider_state
@@ -19,12 +21,16 @@ module Pact
         new(symbolize_keys(hash).merge({request: request}))
       end
 
-      def as_json
+      def to_hash
         hash = { :description => @description }
         hash[:provider_state] = @provider_state if @provider_state #Easier to read when provider state at top
         hash.merge(:request => @request.as_json, :response => @response)
       end
 
+      def as_json options = {}
+        fix_all_the_things to_hash
+      end
+
       def to_json(options = {})
         as_json.to_json(options)
       end

data/lib/pact/consumer_contract/request.rb

@@ -35,7 +35,7 @@ module Pact
       end
 
       def difference(actual_request)
-        request_diff = diff(as_json_without_body, actual_request.as_json_without_body)
+        request_diff = diff(to_hash_without_body, actual_request.to_hash_without_body)
         unless body.is_a? NullExpectation
           request_diff.merge(body_difference(actual_request.body))
         else
@@ -51,7 +51,7 @@ module Pact
 
       private
 
-      # Options is a dirty hack to allow Condor to send extra keys in the request, 
+      # Options is a dirty hack to allow Condor to send extra keys in the request,
       # as it's too much work to set up an exactly matching expectation.
       # Need to implement a proper matching strategy and remove this.
       # Do not rely on it!

data/lib/pact/consumer_contract/service_consumer.rb

@@ -13,10 +13,14 @@ module Pact
       name
     end
 
-    def as_json options = {}
+    def to_hash
       {name: name}
     end
 
+    def as_json options = {}
+      to_hash
+    end
+
     def self.from_hash hash
       new(symbolize_keys(hash))
     end

data/lib/pact/consumer_contract/service_provider.rb

@@ -13,10 +13,14 @@ module Pact
       name
     end
 
-    def as_json options = {}
+    def to_hash
       {name: name}
     end
 
+    def as_json options = {}
+      to_hash
+    end
+
     def self.from_hash hash
       new(symbolize_keys(hash))
     end

data/lib/pact/matchers/matchers.rb

@@ -31,7 +31,7 @@ module Pact
     end
 
     def regexp_diff regexp, actual, options
-      if actual != nil && regexp.match(actual)
+      if actual.is_a?(String) && regexp.match(actual)
         {}
       else
         {expected: regexp, actual: actual}

data/lib/pact/provider/pact_spec_runner.rb

@@ -3,79 +3,107 @@ require 'rspec'
 require 'rspec/core'
 require 'rspec/core/formatters/documentation_formatter'
 require 'rspec/core/formatters/json_formatter'
+require 'pact/provider/pact_helper_locator'
 require_relative 'rspec'
 
 
 module Pact
-	module Provider
-		class PactSpecRunner
-
-			include Pact::Provider::RSpec::ClassMethods
-
-			attr_reader :spec_definitions
-			attr_reader :options
-			attr_reader :output
-
-			def initialize spec_definitions, options = {}
-				@spec_definitions = spec_definitions
-				@options = options
-				@results = nil
-			end
-
-			def run
-				initialize_specs
-				configure_rspec
-				run_specs
-			end
-
-			private
-
-			def require_pact_helper spec_definition
-				if spec_definition[:support_file]
-					$stderr.puts "Specifying a support_file is deprecated. Please create a pact_helper.rb instead."
-					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}
-					honour_pactfile spec_definition[:uri], options
-				end
-			end
-
-			def configure_rspec
-				config = ::RSpec.configuration
-				config.color = true
-
-				unless options[:silent]
-					config.error_stream = $stderr
-					config.output_stream = $stdout
-				end
-
-				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
-
-			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
-				@output = @json_formatter.output_hash
-				exit_code
-			end
-		end
-	end
-end
+  module Provider
+    class PactSpecRunner
+
+      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
+
+      def initialize spec_definitions, options = {}
+        @spec_definitions = spec_definitions
+        @options = options
+        @results = nil
+      end
+
+      def run
+        begin
+          configure_rspec
+          initialize_specs
+          run_specs
+        ensure
+          ::RSpec.reset
+        end
+      end
+
+      private
+
+      def require_pact_helper spec_definition
+        if spec_definition[:pact_helper]
+          puts "Requiring #{spec_definition[:pact_helper]}"
+          require spec_definition[:pact_helper]
+        elsif spec_definition[:support_file]
+          puts "Requiring #{spec_definition[:support_file]}"
+          $stderr.puts SUPPORT_FILE_DEPRECATION_MESSAGE
+          require spec_definition[:support_file]
+        else
+          puts "Requiring #{Pact::Provider::PactHelperLocater.pact_helper_path}"
+          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,
+            criteria: @options[:criteria]
+          }
+          honour_pactfile spec_definition[:uri], options
+        end
+      end
+
+      def configure_rspec
+        config = ::RSpec.configuration
+
+        config.color = true
+        config.extend Pact::Provider::RSpec::ClassMethods
+        config.include Pact::Provider::RSpec::InstanceMethods
+        config.include Pact::Provider::TestMethods
+
+        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
+
+        unless options[:silent]
+          config.error_stream = $stderr
+          config.output_stream = $stdout
+        end
+
+        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
+
+      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
+        @output = @json_formatter.output_hash
+        exit_code
+      end
+    end
+  end
+end

data/lib/pact/provider/rspec.rb

@@ -1,6 +1,5 @@
 require 'open-uri'
 require 'pact/consumer_contract'
-require 'pact/json_warning'
 require 'pact/provider/matchers'
 require 'pact/provider/test_methods'
 require 'pact/provider/configuration'
@@ -19,28 +18,36 @@ module Pact
 
         include ::RSpec::Core::DSL
 
-        include Pact::JsonWarning
-
         def honour_pactfile pactfile_uri, options = {}
-          describe "Pact in #{pactfile_uri}" do
-            consumer_contract = Pact::ConsumerContract.from_json(read_pact_from(pactfile_uri, options))
-            honour_consumer_contract consumer_contract, options
+          puts "Filtering specs by: #{options[:criteria]}" if options[:criteria]
+          consumer_contract = Pact::ConsumerContract.from_json(read_pact_from(pactfile_uri, 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
 
         def honour_consumer_contract consumer_contract, options = {}
-          check_for_active_support_json
           describe_consumer_contract consumer_contract, options.merge({:consumer => consumer_contract.consumer.name})
         end
 
         private
 
         def describe_consumer_contract consumer_contract, options
-          consumer_contract.interactions.each do |interaction|
+          consumer_interactions(consumer_contract, options).each do |interaction|
             describe_interaction_with_provider_state interaction, options
           end
         end
 
+        def consumer_interactions(consumer_contract, options)
+          if options[:criteria].nil?
+            consumer_contract.interactions
+          else
+            consumer_contract.find_interactions options[:criteria]
+          end
+        end
+
         def describe_interaction_with_provider_state interaction, options
           if interaction.provider_state
             describe "Given #{interaction.provider_state}" do
@@ -96,24 +103,11 @@ module Pact
         end
 
         def description_for interaction
-          "#{interaction.description} to #{interaction.request.path}"
+          "#{interaction.description} using #{interaction.request.method.upcase} to #{interaction.request.path}"
         end
 
         def read_pact_from uri, options = {}
-          pact = open(uri) { | file | file.read }
-          if options[:save_pactfile_to_tmp]
-            save_pactfile_to_tmp pact, File.basename(uri)
-          end
-          pact
-        rescue StandardError => e
-          $stderr.puts "Error reading file from #{uri}"
-          $stderr.puts "#{e.to_s} #{e.backtrace.join("\n")}"
-          raise e
-        end
-
-        def save_pactfile_to_tmp pact, name
-          FileUtils.mkdir_p Pact.configuration.tmp_dir
-          File.open(Pact.configuration.tmp_dir + "/#{name}", "w") { |file|  file << pact}
+          Pact::PactFile.read(uri, options)
         end
 
       end
@@ -121,13 +115,3 @@ module Pact
   end
 end
 
-RSpec.configure do |config|
-  config.extend Pact::Provider::RSpec::ClassMethods
-  config.include Pact::Provider::RSpec::InstanceMethods
-  config.include Pact::Provider::TestMethods
-
-  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
-end

data/lib/pact/provider/verification_report.rb

@@ -12,7 +12,7 @@ module Pact::Provider
       @output = options[:output]
     end
 
-    def as_json
+    def to_hash
       {
         :consumer => @consumer,
         :provider => @provider,
@@ -21,6 +21,10 @@ module Pact::Provider
       }
     end
 
+    def as_json options = {}
+      to_hash
+    end
+
     def to_json(options = {})
       as_json.to_json(options)
     end

data/lib/pact/shared/request.rb

@@ -24,7 +24,11 @@ module Pact
         as_json.to_json(options)
       end
 
-      def as_json
+      def as_json options = {}
+        to_hash
+      end
+
+      def to_hash
         base_json = {
           method: method,
           path: path,
@@ -57,9 +61,9 @@ module Pact
 
       def self.key_not_found
         raise NotImplementedError
-      end      
+      end
 
-      def as_json_without_body
+      def to_hash_without_body
         keep_keys = [:method, :path, :headers, :query]
         as_json.reject{ |key, value| !keep_keys.include? key }
       end

data/lib/pact/something_like.rb

@@ -13,13 +13,17 @@ module Pact
       @contents = contents
     end
 
-    def as_json
+    def to_hash
       {
         :json_class => self.class.name,
         :contents => contents
       }
     end
 
+    def as_json
+      to_hash
+    end
+
     def to_json opts = {}
       as_json.to_json opts
     end

data/lib/pact/tasks/task_helper.rb

@@ -19,5 +19,14 @@ module Pact
         fail
       end
     end
+
+    def spec_criteria defaults = {description: nil, provider_state: nil}
+      criteria = {}
+      [: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.any? ? criteria : nil
+    end
   end
 end

data/lib/pact/tasks/verification_task.rb

@@ -4,87 +4,88 @@ require 'pact/provider/verification_report'
 require 'pact/tasks/task_helper'
 
 =begin
-	To create a rake pact:verify:<something> task
+  To create a rake pact:verify:<something> task
 
-	Pact::VerificationTask.new(:head) do | pact |
-	  pact.uri 'http://master.cd.vpc.realestate.com.au/browse/BIQ-MAS/latestSuccessful/artifact/JOB2/Pacts/mas-contract_transaction_service.json'
+  Pact::VerificationTask.new(:head) do | pact |
+    pact.uri 'http://master.cd.vpc.realestate.com.au/browse/BIQ-MAS/latestSuccessful/artifact/JOB2/Pacts/mas-contract_transaction_service.json'
      pact.uri 'http://master.cd.vpc.realestate.com.au/browse/BIQ-IMAGINARY-CONSUMER/latestSuccessful/artifact/JOB2/Pacts/imaginary_consumer-contract_transaction_service.json'
-	end
+  end
 
-	The pact.uri may be a local file system path or a remote URL.
+  The pact.uri may be a local file system path or a remote URL.
 
-	To run a pact:verify:xxx task you need to define a pact_helper.rb, ideally in spec/service_consumers.
-	It should contain your service_provider definition, and load any provider state definition files.
-	It should also load all your app's dependencies (eg by calling out to spec_helper)
+  To run a pact:verify:xxx task you need to define a pact_helper.rb, ideally in spec/service_consumers.
+  It should contain your service_provider definition, and load any provider state definition files.
+  It should also load all your app's dependencies (eg by calling out to spec_helper)
 
-	Eg.
+  Eg.
 
-	require 'spec_helper'
-	require 'provider_states_for_my_consumer'
+  require 'spec_helper'
+  require 'provider_states_for_my_consumer'
 
-	Pact.service_provider "My Provider" do
-		app { TestApp.new }
-	end
+  Pact.service_provider "My Provider" do
+    app { TestApp.new }
+  end
 
 =end
 
-
 module Pact
-	class VerificationTask < ::Rake::TaskLib
-	  attr_reader :pact_spec_config
-
-	  include Pact::TaskHelper
-	  def initialize(name)
-	    @pact_spec_config = []
-	    @name = name
-	    yield self
-	    rake_task
-	  end
-
-	  def uri(uri, options = {})
-	    @pact_spec_config << {uri: uri, support_file: options[:support_file]}
-	  end
-
-	  private
-
-	  attr_reader :name
-
-	  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 rake_task
-	  	namespace :pact do
-	  	  desc "Verify provider against the consumer pacts for #{name}"
-	  	  task "verify:#{name}" do
-
-	  	  	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])
-		  	    exit_status = pact_spec_runner.run
-		  	    publish_report config, pact_spec_runner.output, exit_status == 0, 'head', Pact.configuration.reports_dir
-		  	    exit_status
-	  	  	end
-
-	  	  	handle_verification_failure do
-	  	  		exit_statuses.count{ | status | status != 0 }
-	  	  	end
-	  	  end
-	  	end
-	  end
-	end
-end
+  class VerificationTask < ::Rake::TaskLib
+    attr_reader :pact_spec_config
+
+    include Pact::TaskHelper
+    def initialize(name)
+      @pact_spec_config = []
+      @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]}
+    end
+
+    private
+
+    attr_reader :name
+
+    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 rake_task
+      namespace :pact do
+        desc "Verify provider against the consumer pacts for #{name}"
+        task "verify:#{name}", :description, :provider_state do |t, args|
+
+          options = {criteria: spec_criteria(args)}
+
+          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
+          end
+
+          handle_verification_failure do
+            exit_statuses.count{ | status | status != 0 }
+          end
+        end
+      end
+    end
+  end
+end