pact 1.0.13 → 1.0.15

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+Do this to generate your change history
+
+    git log --date=relative --pretty=format:'  * %h - %s (%an, %ad)'
+
+### 1.0.15 (22 October 2013)
+
+ * 6800a58 - Updating README with latest TODOs (Beth, 2 hours ago)
+ * 99a6827 - Improving logging in pact:verify. Fixing bug where Pact log level was ignored. (Beth, 3 hours ago)
+ * 5434f54 - Updating README with best practice and information on the :pact => :verify metadata. (Beth, 4 hours ago)
+ * 16dd2be - Adding :pact => :verify to pact:verify rspec examples for https://github.com/uglyog/pact/issues/3 (Beth, 5 hours ago)
+
+### 1.0.14 (22 October 2013)
+
+* 406e746 - Added a template for the provider state when no provider state is found (Beth, 9 minutes ago)
+* 1f58be8 - Adding error messages when set_up or tear_down are not defined, and added no_op as a way to avoid having to use an empty set_up block when there is no data to set up (Beth)
+* 78d3999 - Merge pull request #2 from stuliston/json_warning_minor_refactor (Ronald Holshausen, 18 hours ago)
+* be4a466 - Altering JsonWarning so that it only warns once. Added spec to confirm that's the case. (Stuart Liston, 21 hours ago)
+* 3b11b42 - Fixing the issue where a method defined in global scope could not be accessed in the DSL delegation code (Beth, 11 days ago)
+
 ### 1.0.13 (10 October 2013)
 
 * Fixed bug deserialising Pact::SomethingLike [Beth Skurrie]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pact (1.0.13)
+    pact (1.0.15)
       awesome_print (~> 1.1.0)
       find_a_port (~> 1.0.1)
       json
@@ -28,7 +28,7 @@ GEM
     geminabox-client (0.0.2)
       multipart-post
     hashie (2.0.5)
-    json (1.8.0)
+    json (1.8.1)
     method_source (0.8.2)
     multipart-post (1.2.0)
     pry (0.9.12.2)

data/README.md

@@ -177,9 +177,7 @@ Pact.provider_states_for 'My Service Consumer' do
   end
 
   provider_state "a thing does not exist" do
-    set_up do
-      # Well, probably not much to do here, but you get the picture.
-    end
+    no_op # If there's nothing to do because the state name is more for documentation purposes, you can use no_op to imply this.
   end
 end
 
@@ -225,6 +223,28 @@ end
 The pact.uri may be a local file system path or a remote URL.
 
 
+## Pact best practices
+
+### Ensure all calls to the provider go through your provider client class
+
+Do not hand create any HTTP requests in your consumer app or specs. Testing through your provider client class gives you the assurance that your consumer app will be creating exactly the HTTP requests that you think it should.
+
+### Do not stub your database calls in the provider project
+
+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.
+
+### Use factories to create your expected models in your consumer project
+
+Sure, you've checked that your client deserialises the HTTP response into the object you expect, but then you need to make sure in your other tests where you stub your client that you're stubbing it with a valid object. The best way to do this is to use factories for all your tests.
+
+### Publish your pacts as artifacts on your CI machine
+
+Configure the pact_uri in the Pact.service_provider block with the pact artifact URL of your last successful build. This way you're only verifying green builds. No point verifying a broken one.
+(Watch this space - pact-broker coming soon, so we don't have to use messy build box artifact URLs)
+
+
+## Advanced
+
 ### Running a standalone mock server
 A pact service can be run locally and is really useful for debugging purposes.
 
@@ -233,33 +253,35 @@ A pact service can be run locally and is really useful for debugging purposes.
 The service prints messages it recieves to stdout which can be really useful
 when diagnosing issues with pacts.
 
-## Advanced
-
 ### Notes on pact file write mode
 
 By default, the pact file will be overwritten (started from scratch) every time any rspec runs any spec using pacts. This means that if there are interactions that haven't been executed in the most recent rspec run, they are effectively removed from the pact file. If you have long running pact specs (e.g. they are generated using the browser with Capybara) and you are developing both consumer and provider in parallel, or trying to fix a broken interaction, it can be tedius to run all the specs at once. In this scenario, you can set the pactfile_write_mode to :update. This will keep all existing interactions, and update only the changed ones, identified by description and provider state. The down side of this is that if either of those fields change, the old interactions will not be removed from the pact file. As a middle path, you can set pactfile_write_mode to :smart. This will use :overwrite mode when running rake (as determined by a call to system using 'ps') and :update when running an individual spec.
 
+### To use RSpec hooks for pact:verify
+
+The pact:verify RSpec examples have the metadata `{:pact => :verify}` defined. You can add RSpec hooks using a filter as shown here:
+
+```ruby
+RSpec.configure do | config |
+  config.before :each, :pact => :verify do
+    # Your code here
+  end
+end
+```
+
+See https://www.relishapp.com/rspec/rspec-core/docs/hooks/filters for more information.
+
 ## TODO
 
 Short term:
-- Rename Pact to ConsumerContract (Done)
-- Simplify set up for consumer (Done)
-  - Move server spawning into to the "at" method (Done)
-  - automatically register before and after hooks in consumer (Done)
-- Provide before and after hooks and a place to define the app for Pact configuration in service provider (remove Rspc from interface of Pact setup) (Done)
-  - Set_up for state
-  - Tear_down for state
-  - Before hook for all
-  - After hook for all
-- Make service provider state lookup try consumer defined state first, then fall back to global one (Done)
-- Put service provider and consumer name into pact file (Done)
-- Remove consumer name from the rake task, as it should now be able to be determined from the pact file. (Done)
-- 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.
+- 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.
 - Decouple Rspec from Pact and make rspec-pact gem for easy integration
 
-
 ## Contributing
 
 1. Fork it

data/lib/pact/configuration.rb

@@ -12,7 +12,7 @@ module Pact
     attr_writer :pactfile_write_mode
 
     def log_path
-      log_dir + "/pact_gem.log"
+      log_dir + "/pact.log"
     end
 
     def pactfile_write_mode

data/lib/pact/consumer/mock_service/app.rb

@@ -24,16 +24,7 @@ module Pact
     class MockService
 
       def initialize options = {}
-        options = {log_file: STDOUT}.merge options
-        log_stream = options[:log_file]
-        @logger = Logger.new log_stream
-
-        log_description = if log_stream.is_a? File
-           File.absolute_path(log_stream).gsub(Dir.pwd + "/", '')
-        else
-          "standard out/err"
-        end
-
+        log_description = configure_logger options
         interaction_list = InteractionList.new
 
         @name = options.fetch(:name, "MockService")
@@ -47,6 +38,19 @@ module Pact
         ]
       end
 
+      def configure_logger options
+        options = {log_file: STDOUT}.merge options
+        log_stream = options[:log_file]
+        @logger = Logger.new log_stream
+        @logger.level = Pact.configuration.logger.level
+
+        if log_stream.is_a? File
+           File.absolute_path(log_stream).gsub(Dir.pwd + "/", '')
+        else
+          "standard out/err"
+        end
+      end
+
       def to_s
         "#{@name} #{super.to_s}"
       end

data/lib/pact/json_warning.rb

@@ -4,7 +4,8 @@ require 'json/add/regexp'
 module Pact
   module JsonWarning
     def check_for_active_support_json
-      @already_warned ||= false
+      return if @already_warned
+
       # Active support clobbers the as_json methods defined in the json/add directory of the json gem.
       # These methods are required to serialize and deserialize the Regexp and Symbol classes properly.
       # You can potentially fix this by making sure the json gem is required AFTER the active_support/json gem
@@ -16,12 +17,16 @@ module Pact
       # without breaking the calling code, which may depend on activesupport/json... then please fix this.
       # Note: we can probably do this in Ruby 2.0 with refinements, but for now, we're all stuck on 1.9 :(
 
-      unless @already_warned
-        unless Regexp.new('').as_json.is_a?(Hash)
-          Logger.new($stderr).warn("It appears you are using ActiveSupport json in your project. You are now in rubygems hell. Please see Pact::JsonWarning for more info.")
-          @already_warned = true
-        end
+      if as_json_clobbered?
+        Logger.new($stderr).warn("It appears you are using ActiveSupport json in your project. You are now in rubygems hell. Please see Pact::JsonWarning for more info.")
+        @already_warned = true
       end
     end
+
+    private
+
+    def as_json_clobbered?
+      !Regexp.new('').as_json.is_a?(Hash)
+    end
   end
 end

data/lib/pact/provider/provider_state.rb

@@ -46,12 +46,17 @@ module Pact
       def initialize name, namespace, &block
         @name = name
         @namespace = namespace
+        @set_up_defined = false
+        @tear_down_defined = false
+        @no_op_defined = false
         instance_eval(&block)
+        validate
       end
 
       def set_up &block
         if block_given?
           @set_up_block = block
+          @set_up_defined = true
         elsif @set_up_block
           instance_eval &@set_up_block
         end
@@ -60,13 +65,34 @@ module Pact
       def tear_down &block
         if block_given?
           @tear_down_block = block
+          @tear_down_defined = true
         elsif @tear_down_block
           instance_eval &@tear_down_block
         end
       end
 
+      def no_op
+        @no_op_defined = true
+      end
+
       private
 
+      attr_accessor :no_op_defined, :set_up_defined, :tear_down_defined
+
+      def validate
+        if no_op_defined && set_up_defined
+          raise error_message_for_extra_block 'set_up'
+        elsif no_op_defined && tear_down_defined
+          raise error_message_for_extra_block 'tear_down'
+        elsif !(no_op_defined || set_up_defined || tear_down_defined)
+          raise "Please provide a set_up or tear_down block for provider state \"#{name}\". If there is no data to set up or tear down, you can use \"no_op\" instead."
+        end
+      end
+
+      def error_message_for_extra_block block_name
+        "Provider state \"#{name}\" has been defined as a no_op but it also has a #{block_name} block. Please remove one or the other."
+      end
+
       def namespaced(name)
         if namespace.empty?
           name

data/lib/pact/provider/rspec.rb

@@ -53,7 +53,7 @@ module Pact
 
         def describe_interaction interaction, options
 
-          describe description_for(interaction) do
+          describe description_for(interaction), :pact => :verify do
 
             before do
               set_up_provider_state interaction.provider_state, options[:consumer]
@@ -89,7 +89,6 @@ module Pact
 
             if response['body']
               it "has a matching body" do
-                logger.debug "Response body is #{last_response.body}"
                 expect(parse_body_from_response(last_response)).to match_term response['body']
               end
             end
@@ -126,4 +125,9 @@ 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/test_methods.rb

@@ -15,8 +15,11 @@ module Pact
         request = Request::Replayable.new(interaction.request)
         args = [request.path, request.body, request.headers]
 
-        logger.debug "Sending #{request.method} with #{args}"
-        self.send(request.method, *args)
+        logger.info "Sending #{request.method} request to path: \"#{request.path}\" with headers: #{request.headers}, see debug logs for body"
+        logger.debug "body :#{request.body}"
+        response = self.send(request.method, *args)
+        logger.info "Received response with status: #{response.status}, headers: #{response.headers}, see debug logs for body"
+        logger.debug "body: #{response.body}"
       end
 
       def parse_body_from_response rack_response
@@ -46,7 +49,15 @@ module Pact
           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}\"
+If you have not yet defined a provider state for \"#{provider_state_name}\", here is a template:
+
+Pact.provider_states_for \"#{consumer}\" do
+  provider_state \"#{provider_state_name}\" do
+    set_up do
+      # Your set up code goes here
+    end
+  end
+end
 eos
           raise error_msg
         end

data/lib/pact/version.rb

@@ -1,3 +1,3 @@
 module Pact
-  VERSION = "1.0.13"
+  VERSION = "1.0.15"
 end

data/spec/lib/pact/json_warning_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module Pact
+
+  describe JsonWarning do
+
+    class TestContract
+      include JsonWarning
+    end
+
+    let(:logger) { double }
+
+    before do
+      Logger.stub(new: logger)
+      @contract = TestContract.new
+    end
+
+    context 'when as_json has been clobbered' do
+      before { @contract.stub(as_json_clobbered?: true) }
+
+      it 'logs a single warning' do
+        logger.should_receive(:warn).once
+        @contract.check_for_active_support_json
+        @contract.check_for_active_support_json
+      end
+    end
+
+    context 'when as_json has NOT been clobbered' do
+      before { @contract.stub(as_json_clobbered?: false) }
+
+      it 'does not log a warning' do
+        logger.should_not_receive(:warn)
+        @contract.check_for_active_support_json
+      end
+    end
+
+  end
+
+end

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

@@ -18,6 +18,7 @@ module Pact
       end
 
       Pact.provider_state 'some alligators' do
+        no_op
       end
 
       before do
@@ -54,6 +55,43 @@ module Pact
       end
     end
 
+    describe 'no_op' do
+      context "when a no_op is defined instead of a set_up or tear_down" do
+        it "treats set_up and tear_down as empty blocks" do
+          Pact.provider_state 'with_no_op' do
+            no_op
+          end
+          ProviderState.get('with_no_op').set_up
+          ProviderState.get('with_no_op').tear_down
+        end
+      end
+      context "when a no_op is defined with a set_up" do
+        it "raises an error" do
+          expect do
+            Pact.provider_state 'with_no_op_and_set_up' do
+              no_op
+              set_up do
+
+              end
+            end.to raise_error(/Provider state \"with_no_op_and_set_up\" has been defined as a no_op but it also has a set_up block. Please remove one or the other./)
+          end
+        end
+      end
+      context "when a no_op is defined with a tear_down" do
+        it "raises an error" do
+          expect do
+            Pact.provider_state 'with_no_op_and_set_up' do
+              no_op
+              tear_down do
+
+              end
+            end.to raise_error(/Provider state \"with_no_op_and_set_up\" has been defined as a no_op but it also has a tear_down block. Please remove one or the other./)
+          end
+        end
+      end
+
+    end
+
 
     describe 'namespaced ProviderStates' do
 
@@ -99,5 +137,25 @@ module Pact
         end
       end
     end
+
+    describe "invalid provider state" do
+      context "when no set_up or tear_down is provided" do
+        it "raises an error to prevent someone forgetting about the set_up and putting the set_up code directly in the provider_state block and wasting 20 minutes trying to work out why their provider states aren't working properly" do
+          expect do
+            Pact.provider_state 'invalid' do
+            end
+          end.to raise_error(/Please provide a set_up or tear_down block for provider state \"invalid\"/)
+        end
+      end
+      context "when a no_op is defined" do
+        it "does not raise an error" do
+          expect do
+            Pact.provider_state 'valid' do
+              no_op
+            end
+          end.not_to raise_error
+        end
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact
 version: !ruby/object:Gem::Version
-  version: 1.0.13
+  version: 1.0.15
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-21 00:00:00.000000000 Z
+date: 2013-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: randexp
@@ -375,6 +375,7 @@ files:
 - spec/lib/pact/consumer_contract/consumer_contract_spec.rb
 - spec/lib/pact/consumer_contract/interaction_spec.rb
 - spec/lib/pact/consumer_contract/request_spec.rb
+- spec/lib/pact/json_warning_spec.rb
 - spec/lib/pact/matchers/matchers_spec.rb
 - spec/lib/pact/provider/configuration_spec.rb
 - spec/lib/pact/provider/pact_helper_locator_spec.rb
@@ -414,7 +415,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1516639792059640389
+      hash: -222789045808917234
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -423,10 +424,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1516639792059640389
+      hash: -222789045808917234
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Define a pact between service consumers and providers
@@ -451,6 +452,7 @@ test_files:
 - spec/lib/pact/consumer_contract/consumer_contract_spec.rb
 - spec/lib/pact/consumer_contract/interaction_spec.rb
 - spec/lib/pact/consumer_contract/request_spec.rb
+- spec/lib/pact/json_warning_spec.rb
 - spec/lib/pact/matchers/matchers_spec.rb
 - spec/lib/pact/provider/configuration_spec.rb
 - spec/lib/pact/provider/pact_helper_locator_spec.rb