pact 1.0.15 → 1.0.18

data/CHANGELOG.md

@@ -2,6 +2,35 @@ Do this to generate your change history
 
     git log --date=relative --pretty=format:'  * %h - %s (%an, %ad)'
 
+### 1.0.18 (29 October 2013)
+
+* f2892d4 - Fixed bug where an exception is thrown when a key is not found and is attempted to be matched to a regexp (Beth, 60 seconds ago)
+
+### 1.0.17 (29 October 2013)
+
+* 74bdf09 - Added missing require for Regexp json deserialisation (Beth, 3 minutes ago)
+ * d69482e - Removed JsonWarning for ActiveSupport JSON. (Beth, 3 hours ago)
+ * 5f72720 - Fixing ALL THE REGEXPS that ActiveSupport JSON broke. The pact gem should now serialise and deserialise its own JSON properly even when ActiveSupport is loaded by the call
+ * c3e6430 - Added config.ru parsing to best practices. (Beth, 9 hours ago)
+ * ae3a70f - DRYing up pact file reading code. (Beth, 11 hours ago)
+ * dc83557 - Fixing VerificationTask spec (Beth, 11 hours ago)
+ * bae379c - Added consumer name, provider name and request method to output of rspec. (Beth, 12 hours ago)
+ * 89c2620 - Adding spec filtering using PACT_DESCRIPTION and PACT_PROVIDER_STATE to pact:verify and pact:verify:at tasks. (Beth, 28 hours ago)
+ * 7ab43a9 - Adding puts to show when pact:verify specs are being filtered. (Beth, 28 hours ago)
+
+### 1.0.16 (28 October 2013)
+
+* ce0d102 - Fixing specs after adding pact_helper and changing producer_state to provider_state. There is no producer here any more! Naughty producer. (Beth, 71 seconds ago)
+* 90f7203 - Fixing bug where RSpec world was not cleared between pact:verify tasks. (Beth, 16 minutes ago)
+* b323336 - Fixed bug where pact_helper option was not being passed into the PactSpecRunner from the task configuration (Beth, 4 hours ago)
+* b1e78f5 - Added environment variable support. (Sergei Matheson, 3 days ago)
+* 2b9f39a - Allow match criteria to be passed through to pact:verify tasks on command line (Sergei Matheson, 3 days ago)
+* 2241f29 - Un-deprecating the support_file functionality after having discovered a valid use for it (project that contains two rack apps that have a pact with each other). Renamed op
+* c94fc13 - Updating example provider state (Beth, 4 days ago)
+* 6900f39 - Updating README with better client class example (Beth, 5 days ago)
+* e41f755 - Update README.md (bskurrie, 5 days ago)
+* 2abcce4 - Adding to pact best practices. (Beth, 5 days ago)
+
 ### 1.0.15 (22 October 2013)
 
  * 6800a58 - Updating README with latest TODOs (Beth, 2 hours ago)

data/Gemfile

@@ -1,5 +1,4 @@
 source 'https://rubygems.org'
-source 'http://rea-rubygems'
 
 # Specify your gem's dependencies in pact.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pact (1.0.15)
+    pact (1.0.18)
       awesome_print (~> 1.1.0)
       find_a_port (~> 1.0.1)
       json
@@ -13,24 +13,37 @@ PATH
 
 GEM
   remote: https://rubygems.org/
-  remote: http://rea-rubygems/
   specs:
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
     addressable (2.3.5)
+    atomic (1.1.14)
     awesome_print (1.1.0)
     coderay (1.0.9)
+    columnize (0.3.6)
     crack (0.4.1)
       safe_yaml (~> 0.9.0)
     daemons (1.1.9)
+    debugger (1.6.2)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.3)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.3)
     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
     hashie (2.0.5)
+    i18n (0.6.5)
     json (1.8.1)
     method_source (0.8.2)
-    multipart-post (1.2.0)
+    minitest (4.7.5)
+    multi_json (1.8.2)
     pry (0.9.12.2)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
@@ -57,6 +70,9 @@ GEM
       eventmachine (>= 1.0.0)
       rack (>= 1.5.0)
     thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
     webmock (1.9.3)
       addressable (>= 2.2.7)
       crack (>= 0.3.2)
@@ -65,8 +81,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport
+  debugger
   fakefs (~> 0.4)
-  geminabox-client
   hashie (~> 2.0)
   pact!
   pry

data/README.md

@@ -47,11 +47,25 @@ class MyServiceProviderClient
   include HTTParty
   base_uri 'http://my-service'
 
-  def get_text_from_something
-    JSON.parse(self.class.get("/something").body)['text']
+  def get_something
+    name = JSON.parse(self.class.get("/something").body)['name']
+    Something.new(name)
   end
 end
 
+class Something
+  attr_reader :name
+
+  def intialize name
+    @name = name
+  end
+
+  def == other
+    other.is_a?(Something) && other.name == name
+  end
+end
+
+
 # The following code creates a service on localhost:1234 which will respond to your application's queries
 # over HTTP as if it were the real "My Service Provider" app. It also creats a mock service provider object
 # which you will use to set up your expectations. The method name to access the mock service provider
@@ -76,7 +90,7 @@ describe MyServiceProviderClient, :pact => true do
     MyServiceProviderClient.base_uri 'localhost:1234'
   end
 
-  describe "get_text_from_something" do
+  describe "get_something" do
     before do
       my_service_provider.
         .given("something exists")
@@ -85,15 +99,12 @@ describe MyServiceProviderClient, :pact => true do
         .will_respond_with(
           status: 200,
           headers: { 'Content-Type' => 'application/json' },
-          body: {text: 'A thing!', something_else: 'Woot!'}
+          body: {name: 'A small something'}
         )
     end
 
-    it "returns the text from something" do
-      # Use your service's client to make the request, rather than hand crafting a HTTP request,
-      # so that you can be sure that the request that will be recorded in the pact file
-      # is one that is actually made by your app.
-      expect(MyServiceProviderClient.get_text_from_something).to eql("A thing!")
+    it "returns a Something" do
+      expect(MyServiceProviderClient.get_something).to eq(Something.new('A small something'))
     end
 
   end
@@ -147,14 +158,14 @@ For example, some code that creates the pact in a consumer project might look li
 my_service.
    given("a thing exists").
      upon_receiving("a request for a thing").
-        with({method: 'get', path: '/thing'}).
-          will_respond_with({status: 200, :body => {thing: "yay!"} })
+        with(method: 'get', path: '/thing').
+          will_respond_with(status: 200, :body => {thing: "yay!"} )
 
 my_service.
   given("a thing does not exist").
    upon_receiving("a request for a thing").
-      with({method: 'get', path: '/thing'}).
-        will_respond_with({status: 404, :body => {error: "There is no thing :("} })
+      with(method: 'get', path: '/thing').
+        will_respond_with(status: 404, :body => {error: "There is no thing :("} )
 ```
 
 To define service provider states that create the right data for "a thing exists" and "a thing does not exist", write the following in the service provider project.
@@ -225,23 +236,57 @@ 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
+### In your consumer project
 
-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.
+#### Publish your pacts as artifacts on your CI machine
 
-### Do not stub your database calls in the provider project
+This makes the pact available via URL, which your provider build can then use when it runs 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.
+#### 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.
 
-### Use factories to create your expected models in your consumer project
+#### Use factories to create your expected models
 
 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
+### In your provider project
+
+#### Use the pact artifact published by your consumer's CI build to verify the provider
 
 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)
 
+#### Add pact:verify to your default rake task
+
+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.
+
+#### 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.
 
 ## Advanced
 

data/Rakefile

@@ -18,16 +18,16 @@ module Bundler
 end
 Bundler::GemHelper.install_tasks
 require 'rspec/core/rake_task'
-require 'geminabox-client'
 
 Dir.glob('lib/tasks/**/*.rake').each { |task| load task }
 Dir.glob('tasks/**/*.rake').each { |task| load task }
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => [:spec, 'pact:tests']
+task :default => [:spec, :spec_with_active_support, 'pact:tests']
 
 desc "Release to REA gems host"
 task :publish => :build do
   gem_file = "pkg/pact-#{Pact::VERSION}.gem"
+  require 'geminabox-client'
   Geminabox::Client.new('http://rea-rubygems').upload(gem_file)
 end

data/example/animal-service/spec/service_consumers/provider_states_for_zoo_app.rb

@@ -1,9 +1,12 @@
 Pact.provider_states_for "Zoo App" do
   provider_state "there are alligators" do
-    #AlligatorRepo.save(Alligator.name("Mary"))
+    set_up do
+      #AlligatorRepo.save(Alligator.name("Mary"))
+    end
+
   end
 
   provider_state "there is not an alligator named Mary" do
-
+    no_op
   end
 end

data/lib/pact/consumer/consumer_contract_builder.rb

@@ -100,7 +100,7 @@ module Pact
             info_and_puts "*****************************************************************************"
             info_and_puts "Updating existing file .#{consumer_contract.pactfile_path.gsub(Dir.pwd, '')} as config.pactfile_write_mode is :update"
             info_and_puts "Only interactions defined in this test run will be updated."
-            info_and_puts "As interactions are identified by description and provider state, pleased note that if either of these have changed, the old interactions won't be removed from the pact file until rake is next run."
+            info_and_puts "As interactions are identified by description and provider state, pleased note that if either of these have changed, the old interactions won't be removed from the pact file until the specs are next run with :pactfile_write_mode => :overwrite."
             info_and_puts "*****************************************************************************"
           rescue StandardError => e
             warn_and_stderr "Could not load existing consumer contract from #{consumer_contract.pactfile_path} due to #{e}"
@@ -115,7 +115,7 @@ module Pact
       end
 
       def existing_consumer_contract
-        Pact::ConsumerContract.from_json(File.read(consumer_contract.pactfile_path))
+        Pact::ConsumerContract.from_uri(consumer_contract.pactfile_path)
       end
 
     end

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

@@ -61,8 +61,8 @@ module Pact
           relevant_handler = @handlers.detect { |handler| handler.match? env }
           response = relevant_handler.respond env
         rescue Exception => e
-          @logger.ap 'Error ocurred in mock service:'
-          @logger.ap e
+          @logger.error 'Error ocurred in mock service:'
+          @logger.ap e, :error
           @logger.ap e.backtrace
           raise e
         end

data/lib/pact/consumer/mock_service_interaction_expectation.rb

@@ -11,7 +11,7 @@ module Pact
         @interaction = interaction
       end
 
-      def as_json
+      def to_hash
         hash = {:description => interaction.description}
         hash[:provider_state] = interaction.provider_state if interaction.provider_state
         options = interaction.request.options.empty? ? {} : { options: interaction.request.options}
@@ -20,6 +20,10 @@ module Pact
         hash
       end
 
+      def as_json options = {}
+        to_hash
+      end
+
       def to_json opts = {}
         as_json.to_json(opts)
       end

data/lib/pact/consumer_contract/active_support_support.rb

@@ -0,0 +1,29 @@
+module Pact
+  module ActiveSupportSupport
+
+    extend self
+
+    def fix_all_the_things thing
+      if thing.is_a?(Regexp)
+        fix_regexp(thing)
+      elsif thing.is_a?(Array)
+        thing.each{ | it | fix_all_the_things it }
+      elsif thing.is_a?(Hash)
+          thing.values.each{ | it | fix_all_the_things it }
+      elsif thing.class.name.start_with?("Pact")
+        thing.instance_variables.collect{ | iv_name | thing.instance_variable_get(iv_name)}.each do | iv |
+          fix_all_the_things iv
+        end
+      end
+      thing
+    end
+
+    def fix_regexp regexp
+      def regexp.as_json options = {}
+        {:json_class => 'Regexp', "o" => self.options, "s" => self.source }
+      end
+      regexp
+    end
+
+  end
+end

data/lib/pact/consumer_contract/consumer_contract.rb

@@ -1,20 +1,41 @@
 require 'pact/logging'
-require 'pact/json_warning'
 require 'pact/something_like'
 require 'pact/symbolize_keys'
 require 'pact/term'
 require 'pact/version'
 require 'date'
+require 'json/add/regexp'
 require 'open-uri'
 require_relative 'service_consumer'
 require_relative 'service_provider'
 require_relative 'interaction'
 require_relative 'request'
+require_relative 'active_support_support'
 
 
 
 module Pact
 
+  module PactFile
+    extend self
+    def read 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}
+    end
+  end
+
   #TODO move to external file for reuse
   module FileName
     def file_name consumer_name, provider_name
@@ -30,8 +51,8 @@ module Pact
 
     include SymbolizeKeys
     include Logging
-    include JsonWarning
     include FileName
+    include ActiveSupportSupport
 
     attr_accessor :interactions
     attr_accessor :consumer
@@ -43,7 +64,7 @@ module Pact
       @provider = attributes[:provider]
     end
 
-    def as_json(options = {})
+    def to_hash
       {
         provider: @provider.as_json,
         consumer: @consumer.as_json,
@@ -56,6 +77,10 @@ module Pact
       }
     end
 
+    def as_json(options = {})
+      fix_all_the_things to_hash
+    end
+
     def to_json(options = {})
       as_json.to_json(options)
     end
@@ -74,8 +99,8 @@ module Pact
       from_hash(deserialised_object)
     end
 
-    def self.from_uri uri
-      from_json(open(uri){ |f| f.read })
+    def self.from_uri uri, options = {}
+      from_json(Pact::PactFile.read(uri, options))
     end
 
     def self.maintain_backwards_compatiblity_with_producer_keys string
@@ -113,7 +138,6 @@ module Pact
 
     def update_pactfile
       logger.debug "Updating pact file for #{provider.name} at #{pactfile_path}"
-      check_for_active_support_json
       File.open(pactfile_path, 'w') do |f|
         f.write JSON.pretty_generate(self)
       end