pact 1.0.2 → 1.0.3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+### 1.0.4 (unreleased)
+
+### 1.0.3 (5 September 2013)
+
+* pact_helper.rb is located and loaded automatically if a support_file is not defined in a pact:verify task [Beth Skurrie]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pact (1.0.2)
+    pact (1.0.3)
       awesome_print (~> 1.1.0)
       find_a_port (~> 1.0.1)
       hashie (~> 2.0)
@@ -24,6 +24,7 @@ GEM
     daemons (1.1.9)
     diff-lcs (1.2.4)
     eventmachine (1.0.3)
+    fakefs (0.4.2)
     find_a_port (1.0.1)
     geminabox-client (0.0.2)
       multipart-post
@@ -63,6 +64,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  fakefs (~> 0.4)
   geminabox-client
   pact!
   pry

data/README.md

@@ -117,6 +117,8 @@ end
 
 #### Configure your service provider rack app
 
+Create a `pact_helper.rb` in your service provider project. The file must be called pact_helper.rb so the verification tasks can find it, however there is some flexibility in where it can be stored. The recommended place is `specs/service_providers/pact_helper.rb`.
+
 ```ruby
 Pact.service_provider "My Provider" do
   app { MyApp.new }
@@ -150,7 +152,8 @@ Note that these states have been defined only for the 'My Consumer' consumer by
 
 ```ruby
 # The consumer name here must match the name of the consumer configured in your consumer project
-# for it to use these states.
+# for it to correctly find these provider states.
+# Make sure the provider states are included in or required by your pact_helper.rb file.
 
 Pact.provider_states_for 'My Consumer' do
   provider_state "a thing exists" do
@@ -172,7 +175,7 @@ end
 
 ```
 
-If a state should be used for all consumers, the top level Pact.with_consumer can be skipped, and a global Pact.provider_state can be defined on its own. 
+If a state should be used for all consumers, the top level Pact.with_consumer can be skipped, and a global Pact.provider_state can be defined on its own.
 
 #### Create a rake task to verify that the service provider honours the pact
 

data/lib/pact/provider/pact_spec_runner.rb

@@ -4,12 +4,21 @@ require 'rspec/core'
 require 'rspec/core/formatters/documentation_formatter'
 require_relative 'rspec'
 
+
 module Pact
 	module Provider
 		class PactSpecRunner
 
 			extend Pact::Provider::RSpec::ClassMethods
 
+			PACT_HELPER_FILE_PATTERNS = [
+				"spec/**/*service*consumer*/pact_helper.rb",
+				"spec/**/*consumer*/pact_helper.rb",
+				"spec/**/pact_helper.rb",
+			  "**/pact_helper.rb"]
+
+			NO_PACT_HELPER_FOUND_MSG = "Please create a pact_helper.rb file that can be found using one of the following patterns: #{PACT_HELPER_FILE_PATTERNS.join(", ")}"
+
 			def self.run(spec_definitions, options = {})
 				initialize_specs spec_definitions
 				configure_rspec options
@@ -18,9 +27,24 @@ module Pact
 
 			private
 
+			def self.require_pact_helper spec_definition
+				if spec_definition[:support_file]
+					require spec_definition[:support_file]
+				else
+					require pact_helper_file
+				end
+			end
+
+			def self.pact_helper_file
+				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]}"
+			end
+
 			def self.initialize_specs spec_definitions
 				spec_definitions.each do | spec_definition |
-					require spec_definition[:support_file] if spec_definition[:support_file]
+					require_pact_helper spec_definition
 					options = {consumer: spec_definition[:consumer], save_pactfile_to_tmp: true}
 					honour_pactfile spec_definition[:uri], options
 				end

data/lib/pact/provider/test_methods.rb

@@ -80,7 +80,12 @@ module Pact
       def get_provider_state provider_state_name, consumer
         unless provider_state = ProviderState.get(provider_state_name, :for => consumer)
           extra = consumer ? " for consumer \"#{consumer}\"" : ""
-          raise "Could not find a provider state defined for \"#{provider_state_name}\"#{extra}. Have you required the provider state file in your spec?"
+          error_msg = <<-eos
+Could not find a provider state named \"#{provider_state_name}\"#{extra}.
+Have you required the provider states file for this consumer in your pact_helper.rb?
+Check the name in the Pact.provider_states_for definition is exactly \"#{consumer}\"
+eos
+          raise error_msg
         end
         provider_state
       end

data/lib/pact/verification_task.rb

@@ -6,10 +6,8 @@ require_relative 'pact_task_helper'
 	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',
-	              support_file: './spec/consumers/pact_helper'
-    pact.uri 'http://master.cd.vpc.realestate.com.au/browse/BIQ-IMAGINARY-CONSUMER/latestSuccessful/artifact/JOB2/Pacts/imaginary_consumer-contract_transaction_service.json',
-                support_file: './spec/consumers/pact_helper'
+	  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
 
 	The pact.uri may be a local file system path or a remote URL.
@@ -32,21 +30,27 @@ module Pact
 	  include PactTaskHelper
 	  def initialize(name)
 	    @pact_spec_config = []
-
+	    @name = name
 	    yield self
-
-	    namespace :pact do
-
-	      desc "Verify provider against the consumer pacts for #{name}"
-	      task "verify:#{name}" do
-	        exit_status = Provider::PactSpecRunner.run(pact_spec_config)
-	        fail failure_message if exit_status != 0
-	      end
-	    end
+	    define_rake_task
 	  end
 
-	  def uri(uri, options)
+	  def uri(uri, options = {})
 	    @pact_spec_config << {uri: uri, support_file: options[:support_file]}
 	  end
+
+	  private
+
+	  attr_reader :name
+
+	  def define_rake_task
+	  	namespace :pact do
+	  	  desc "Verify provider against the consumer pacts for #{name}"
+	  	  task "verify:#{name}" do
+	  	    exit_status = Provider::PactSpecRunner.run(pact_spec_config)
+	  	    fail failure_message if exit_status != 0
+	  	  end
+	  	end
+	  end
 	end
 end

data/lib/pact/version.rb

@@ -1,3 +1,3 @@
 module Pact
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/pact.gemspec

@@ -32,4 +32,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake', '~> 10.0.3'
   gem.add_development_dependency 'webmock', '~> 1.9.3'
   gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'fakefs', '~> 0.4'
 end

data/spec/lib/pact/provider/pact_spec_runner_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'pact/provider/pact_spec_runner'
+
+module Pact::Provider
+  describe PactSpecRunner do
+    describe "pact_helper_file", :fakefs => true do
+
+      subject { PactSpecRunner.send(:pact_helper_file) }
+
+      def make_pactfile dir
+        FileUtils.mkdir_p ".#{dir}"
+        FileUtils.touch ".#{dir}/pact_helper.rb"
+      end
+
+      PACT_HELPER_FILE_DIRS = [
+        '/spec/blah/service-consumers',
+        '/spec/consumers',
+        '/spec/blah/service_consumers',
+        '/spec/serviceconsumers',
+        '/spec/consumer',
+        '/spec',
+        '/blah',
+        '/blah/consumer',
+        ''
+      ]
+
+      PACT_HELPER_FILE_DIRS.each do | dir |
+        context "the pact_helper is stored in #{dir}" do
+          it "finds the pact_helper" do
+            make_pactfile dir
+            expect(subject).to eq "#{Dir.pwd}#{dir}/pact_helper.rb"
+          end
+        end
+      end
+
+      context "when more than one pact_helper exists" do
+        it "returns the one that matches the most explict search pattern" do
+          make_pactfile '/spec/consumer'
+          FileUtils.touch 'pact_helper.rb'
+          expect(subject).to eq "#{Dir.pwd}/spec/consumer/pact_helper.rb"
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact/provider/test_methods_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'pact/provider/test_methods'
+
+module Pact::Provider
+  describe TestMethods do
+
+    class TestHelper
+      include TestMethods
+    end
+
+    subject { TestHelper.new }
+
+    describe "get_provider_state" do
+      it "raises a descriptive error if the provider state is not found" do
+        ProviderState.stub(:get).and_return(nil)
+        expect{ subject.send(:get_provider_state, 'some state', 'consumer') }.to raise_error /Could not find.*some state.*consumer.*/
+      end
+    end
+  end
+end

data/spec/lib/pact/verification_task_spec.rb

@@ -4,31 +4,51 @@ require 'pact/verification_task'
 module Pact
 	describe VerificationTask do
 		before :all do
-			@support_file = 'some_file.rb'
+			@support_file = '/custom/path/support_file.rb'
 			@pact_uri = 'http://example.org/pact.json'
 			@task_name = 'pact:verify:pact_rake_spec'
+			@task_name_with_explict_support_file = 'pact:verify:pact_rake_spec_with_explict_support_file'
 			@consumer = 'some-consumer'
 
+			VerificationTask.new(:pact_rake_spec_with_explict_support_file) do | pact |
+				pact.uri @pact_uri, support_file: @support_file
+			end
+
 			VerificationTask.new(:pact_rake_spec) do | pact |
-				pact.uri @pact_uri, support_file: @support_file, consumer: @consumer
+				pact.uri @pact_uri
 			end
 		end
 
 		describe '.initialize' do
-
-			it 'creates the tasks' do
-				Rake::Task.tasks.should include_task @task_name
+			context 'with an explict support_file' do
+				it 'creates the tasks' do
+					Rake::Task.tasks.should include_task @task_name
+				end
+			end
+			context 'with no explict support_file' do
+				it 'creates the tasks' do
+					Rake::Task.tasks.should include_task @task_name_with_explict_support_file
+				end
 			end
-
 		end
 
 		describe 'execute' do
 
-			let(:consumer_contract) { [ uri: @pact_uri, support_file: @support_file] }
+			let(:consumer_contract) { [ uri: @pact_uri, support_file: nil ] }
+
+			context "with no explict support file " do
+				it 'verifies the pacts using PactSpecRunner' do
+					Provider::PactSpecRunner.should_receive(:run).with(consumer_contract).and_return(0)
+					Rake::Task[@task_name].execute
+				end
+			end
 
-			it 'verifies the pacts using PactSpecRunner' do
-				Provider::PactSpecRunner.should_receive(:run).with(consumer_contract).and_return(0)
-				Rake::Task[@task_name].execute
+			context "with an explict support_file" do
+				let(:consumer_contract) { [ uri: @pact_uri, support_file: @support_file] }
+				it 'verifies the pacts using PactSpecRunner' do
+					Provider::PactSpecRunner.should_receive(:run).with(consumer_contract).and_return(0)
+					Rake::Task[@task_name_with_explict_support_file].execute
+				end
 			end
 
 			context 'when all specs pass' do

data/spec/spec_helper.rb

@@ -1,6 +1,11 @@
+require 'fakefs/spec_helpers'
 require 'rspec'
 require 'pact'
 require 'webmock/rspec'
 require_relative 'support/factories'
 
 WebMock.disable_net_connect!(allow_localhost: true)
+
+RSpec.configure do | config |
+  config.include(FakeFS::SpecHelpers, :fakefs => true)
+end

data/spec/support/{pact_rake_support.rb → pact_helper.rb}

@@ -1,4 +1,5 @@
 require 'json'
+# pact_helper for rake pact:tests
 
 module Pact
 	module Test

data/tasks/pact-test.rake

@@ -8,10 +8,10 @@ namespace :pact do
 		puts "Running task pact:tests"
 		# Run these specs silently, otherwise expected failures will be written to stdout and look like unexpected failures.
 
-		result = Pact::Provider::PactSpecRunner.run([{ uri: './spec/support/test_app_pass.json', support_file: './spec/support/pact_rake_support.rb', consumer: 'some-test-consumer' }], silent: silent)
+		result = Pact::Provider::PactSpecRunner.run([{ uri: './spec/support/test_app_pass.json' }], silent: silent)
 		fail 'Expected pact to pass' unless (result == 0)
 
-		result = Pact::Provider::PactSpecRunner.run([{ uri: './spec/support/test_app_fail.json', support_file: './spec/support/pact_rake_support.rb' }], silent: silent)
+		result = Pact::Provider::PactSpecRunner.run([{ uri: './spec/support/test_app_fail.json', support_file: './spec/support/pact_helper.rb' }], silent: silent)
 		fail 'Expected pact to fail' if (result == 0)
 
 		puts "Task pact:tests completed succesfully."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -223,6 +223,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
 description: Define a pact between service consumers and providers
 email:
 - james.fraser@alumni.swinburne.edu
@@ -237,6 +253,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -308,8 +325,10 @@ files:
 - spec/lib/pact/consumer_contract/interaction_spec.rb
 - spec/lib/pact/matchers/matchers_spec.rb
 - spec/lib/pact/provider/dsl_spec.rb
+- spec/lib/pact/provider/pact_spec_runner_spec.rb
 - spec/lib/pact/provider/provider_state_spec.rb
 - spec/lib/pact/provider/rspec_spec.rb
+- spec/lib/pact/provider/test_methods_spec.rb
 - spec/lib/pact/reification_spec.rb
 - spec/lib/pact/request_spec.rb
 - spec/lib/pact/term_spec.rb
@@ -319,7 +338,7 @@ files:
 - spec/support/a_consumer-a_provider.json
 - spec/support/consumer_contract_template.json
 - spec/support/factories.rb
-- spec/support/pact_rake_support.rb
+- spec/support/pact_helper.rb
 - spec/support/test_app_fail.json
 - spec/support/test_app_pass.json
 - tasks/pact-test.rake
@@ -366,8 +385,10 @@ test_files:
 - spec/lib/pact/consumer_contract/interaction_spec.rb
 - spec/lib/pact/matchers/matchers_spec.rb
 - spec/lib/pact/provider/dsl_spec.rb
+- spec/lib/pact/provider/pact_spec_runner_spec.rb
 - spec/lib/pact/provider/provider_state_spec.rb
 - spec/lib/pact/provider/rspec_spec.rb
+- spec/lib/pact/provider/test_methods_spec.rb
 - spec/lib/pact/reification_spec.rb
 - spec/lib/pact/request_spec.rb
 - spec/lib/pact/term_spec.rb
@@ -377,6 +398,6 @@ test_files:
 - spec/support/a_consumer-a_provider.json
 - spec/support/consumer_contract_template.json
 - spec/support/factories.rb
-- spec/support/pact_rake_support.rb
+- spec/support/pact_helper.rb
 - spec/support/test_app_fail.json
 - spec/support/test_app_pass.json