pact 1.0.21 → 1.0.22

data/CHANGELOG.md

@@ -2,6 +2,12 @@ Do this to generate your change history
 
     git log --date=relative --pretty=format:'  * %h - %s (%an, %ad)'
 
+### 1.0.22 (25 November 2013)
+
+* f742833 - Updating README (Beth Skurrie, 36 seconds ago)
+* ec0d9e2 - Refactor config_ru lambda (Beth Skurrie, 8 minutes ago)
+* 5cb5702 - Added code to use app in config.ru if non is specified as per https://github.com/uglyog/pact/issues/9 (Beth Skurrie, 10 minutes ago)
+
 ### 1.0.21 (25 November 2013)
 
 * f810795 - add jruby 2.0 to travis (Ronald Holshausen, 4 days ago)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pact (1.0.21)
+    pact (1.0.22)
       awesome_print (~> 1.1.0)
       find_a_port (~> 1.0.1)
       json

data/README.md

@@ -1,11 +1,10 @@
 # Pact
 
-Define a pact between service consumers and providers.
+Define a pact between service consumers and providers, enabling "consumer driven contract" testing.
 
+Pact provides an RSpec DSL for service consumers to define the requests they will make to a service provider and the responses they expect back. These expectations are used in the consumers specs to provide a mock service provider. The interactions are recorded, and played back in the service provider specs to ensure the service provider actually does provide the response the consumer expects.
 
-Pact provides an RSpec DSL for service consumers to define the request they will make to a service service provider and the response they expect back. This expectation is used in the consumers specs to provide a mock service provider, and is also played back in the service provider specs to ensure the service provider actually does provide the response the consumer expects.
-
-This allows you to test both sides of an integration point using fast unit tests.
+This allows testing of both sides of an integration point using fast unit tests.
 
 This gem is inspired by the concept of "Consumer driven contracts". See http://martinfowler.com/articles/consumerDrivenContracts.html for more information.
 
@@ -15,9 +14,10 @@ Travis CI Status: [![travis-ci.org Build Status](https://travis-ci.org/uglyog/pa
 * A services is mocked using an actual process running on a specified port, so javascript clients can be tested as easily as backend clients.
 * "Provider states" (similar to fixtures) allow the same request to be made with a different expected response.
 * Consumers specify only the fields they are interested in, allowing a provider to return more fields without breaking the pact. This allows a provider to have a different pact with a different consumer, and know which fields each cares about in a given response.
-* Expected interactions are verified to have actually occurred.
-* A rake verification task allows a pact at any URI to be checked against a given service provider codebase.
-* Different versions of a consumer/provider pair can be easily tested against each other, allowing confidence when deploying new versions of each.
+* Expected interactions are verified to have actually occurred in the consumer specs.
+* The mocked responses are verified to be valid by replaying the interactions against the provider codebase.
+* Rake verification tasks allow a pacts at one or more URIs to be checked against a given service provider codebase.
+* Different versions of a consumer/provider pair can be easily tested against each other, allowing confidence when deploying new versions of each (see the pact_broker and pact_broker-client gems).
 
 ## Installation
 
@@ -154,15 +154,23 @@ Create your API class using the framework of your choice (e.g. Sinatra, Grape) -
 Create a `pact_helper.rb` in your service provider project. The file must be called pact_helper.rb, however there is some flexibility in where it can be stored. The recommended place is `specs/service_consumers/pact_helper.rb`.
 
 ```ruby
-require 'my_app' # Require the boot files for your app
+require 'pact/provider/rspec'
+# If you wish to use the same spec_helper file as your unit tests, require it here.
+# Otherwise, you can set up a separate RSpec configuration in this file just for pact:verify.
+require './spec_helper'
 
 Pact.service_provider "My Service Provider" do
+  # If you have a config.ru file, the app will be loaded from it automatically and you can skip the app config.
+  # Otherwise, set your rack app here as you would when using Rack::Test::Methods
+
   app { MyApp.new }
 
   honours_pact_with 'My Service Consumer' do
+
     # This example points to a local file, however, on a real project with a continuous
     # integration box, you would publish your pacts as artifacts,
     # and point the pact_uri to the pact published by the last successful build.
+
     pact_uri '../path-to-your-consumer-project/specs/pacts/my_consumer-my_provider.json'
   end
 end
@@ -306,33 +314,14 @@ Configure the pact_uri in the Pact.service_provider block with the pact artifact
 
 It should run with all your other tests. If an integration is broken, you want to know about it *before* you check in.
 
-#### Load your app from the config.ru file
-
-Your config.ru file may mount your app at a specified path. e.g.
-
-```
-run Rack::URLMap.new( '/some-path' => MyServiceProvider::API )
-```
-
-To avoid duplicating this code, and potentially letting your tests get out of sync with the config.ru file, you can parse the config.ru file and use the returned app in your service provider definition. e.g.
-
-```
-def app_in_config_ru
-  app, options = Rack::Builder.parse_file('config.ru')
-  app
-end
-
-Pact.service_provider "My Service Provider" do
-  app { app_in_config_ru }
-end
-```
-
-Be aware that the Rack::Builder.parse_file seems to require files even if they have already been required, so make sure your boot files are idempotent.
-
 #### Use the real database
 
 Do not stub your database calls for pact:verify. This is the best time for you to test your database integration. If you stub your database calls, you are getting little more assurance that the real end-to-end will work than if you'd used a unit test. It's the appropriate time to incur the overhead of a database call.
 
+## Gotchas
+
+* Be aware when using the app from the config.ru file is used (the default option) that the Rack::Builder.parse_file seems to require files even if they have already been required, so make sure your boot files are idempotent.
+
 ## Advanced
 
 ### Filtering the pact:verify specs
@@ -398,8 +387,6 @@ See https://www.relishapp.com/rspec/rspec-core/docs/hooks/filters for more infor
 
 Short term:
 - FIX EXAMPLE!!!
-- Make a pact-broker to store and return all the pacts, removing dependency on the CI box URLs.
-- Provide a better work around for ActiveSupport JSON rubygems hell.
 
 Long term:
 - Provide more flexible matching (eg the keys should match, and the classes of the values should match, but the values of each key do not need to be equal). This is to make the pact verification less brittle.

data/config.ru

@@ -0,0 +1,3 @@
+require './spec/support/app_for_config_ru'
+
+run AppForConfigRu

data/lib/pact/provider/configuration.rb

@@ -34,6 +34,14 @@ module Pact
         def pact_verifications
           @pact_verifications ||= []
         end
+
+        def config_ru_path
+          @config_ru_path ||= './config.ru'
+        end
+
+        def config_ru_path= config_ru_path
+          @config_ru_path = config_ru_path
+        end
       end
 
       Pact::Configuration.send(:include, ConfigurationExtension)
@@ -89,9 +97,11 @@ module Pact
 
         attr_accessor :name, :app_block
 
+        CONFIG_RU_APP = lambda { Rack::Builder.parse_file(Pact.configuration.config_ru_path).first }
+
         def initialize name
           @name = name
-          @app_block = nil
+          @app_block = CONFIG_RU_APP
         end
 
         dsl do
@@ -117,7 +127,6 @@ module Pact
 
         def validate
           raise "Please provide a name for the Provider" unless name && !name.strip.empty?
-          raise "Please configure an app for the Provider" unless app_block
         end
 
         def create_service_provider

data/lib/pact/version.rb

@@ -1,3 +1,3 @@
 module Pact
-  VERSION = "1.0.21"
+  VERSION = "1.0.22"
 end

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

@@ -26,6 +26,16 @@ module Pact::Provider::Configuration
         expect{ Pact.configuration.provider }.to raise_error(/Please configure your provider/)
       end
     end
+
+    context "when a provider is configured without an app" do
+      before do
+        Pact.service_provider "Fred" do
+        end
+      end
+      it "uses the app from config.ru" do
+        expect( Pact.configuration.provider.app ).to be(AppForConfigRu)
+      end
+    end
   end
 
   describe PactVerification do
@@ -101,15 +111,6 @@ module Pact::Provider::Configuration
           expect{ subject.send(:validate)}.to raise_error("Please provide a name for the Provider")
         end
       end
-      context "when no app is provided" do
-        subject do
-          ServiceProviderDSL.new 'Blah' do
-          end
-        end
-        it "raises an error" do
-          expect{ subject.send(:validate) }.to raise_error("Please configure an app for the Provider")
-        end
-      end
     end
 
     describe 'honours_pact_with' do

data/spec/support/app_for_config_ru.rb

@@ -0,0 +1,4 @@
+class AppForConfigRu
+  def call env
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact
 version: !ruby/object:Gem::Version
-  version: 1.0.21
+  version: 1.0.22
   prerelease: 
 platform: ruby
 authors:
@@ -279,6 +279,7 @@ files:
 - README.md
 - Rakefile
 - bin/pact
+- config.ru
 - example/animal-service/Gemfile
 - example/animal-service/Gemfile.lock
 - example/animal-service/Rakefile
@@ -395,6 +396,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/a_consumer-a_producer.json
 - spec/support/a_consumer-a_provider.json
+- spec/support/app_for_config_ru.rb
 - spec/support/consumer_contract_template.json
 - spec/support/dsl_spec_support.rb
 - spec/support/factories.rb
@@ -419,7 +421,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2335732393810580306
+      hash: 1182047425998304532
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -428,7 +430,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2335732393810580306
+      hash: 1182047425998304532
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -475,6 +477,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/a_consumer-a_producer.json
 - spec/support/a_consumer-a_provider.json
+- spec/support/app_for_config_ru.rb
 - spec/support/consumer_contract_template.json
 - spec/support/dsl_spec_support.rb
 - spec/support/factories.rb