pact 1.2.1.rc1 → 1.2.1.rc2

data/CHANGELOG.md

@@ -2,6 +2,11 @@ Do this to generate your change history
 
   git log --pretty=format:'  * %h - %s (%an, %ad)'
 
+### 1.2.1.rc2 (13 June 2014)
+
+* d805f35 - Ensuring the pact RSpec formatter works for both rspec 2 and rspec 3 (Beth, Fri Jun 13 16:27:01 2014 +1000)
+* 1669d46 - Fix require for sample app to work without munging LOAD_PATH (Daniel Heath, Fri Jun 13 15:50:03 2014 +1000)
+
 ### 1.2.1.rc1 (13 June 2014)
 
 * b8d1586 - Making RSpec::Mocks::ExampleMethods available in set_up and tear_down, so the allow method is available without configuration.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pact (1.2.1.rc1)
+    pact (1.2.1.rc2)
       awesome_print (~> 1.1)
       find_a_port (~> 1.0.1)
       json

data/bin/pact

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
-require 'pact/app'
-Pact::App.start
+require 'pact/cli'
+Pact::CLI.start

data/documentation/development-workflow.md

@@ -14,9 +14,9 @@ The development process will be different for every organisation, but this is on
 
 ## New features
 
-1. Add new feature, with pact specs, to consumer project on a branch.
+1. Add new feature, with pact specs, to consumer project on a new feature branch.
 1. In the provider project, use `rake pact:verify:at[/path/to/pact/on/branch]` to verify the new pact.
 1. Commit/release new provider feature.
-1. Merge consumer branch into master.
+1. Merge consumer branch into main development branch.
 
-This may seem complex, but it is actually sufacing the underlying reality, that you cannot add new functionality to the consumer before it can be supported by the provider, but that the functionality that the provider supports should still be driven by the needs of the consumer.
+This may seem complex, but it is actually sufacing the underlying reality, that you cannot add new functionality to the consumer before it can be supported by the provider, and that the functionality that the provider supports should still be driven by the needs of the consumer.

data/documentation/verifying-pacts.md

@@ -73,8 +73,8 @@ by your CI box) add the following to your Rakefile. The pact.uri may be a local
 # This creates a rake task that can be executed by running
 # $ rake pact:verify:dev
 
-Pact::VerificationTask.new(:dev) do | pact |
-  pact.uri '../path-to-your-consumer-project/specs/pacts/my_consumer-my_provider.json'
+Pact::VerificationTask.new(:dev) do | task |
+  task.uri '../path-to-your-consumer-project/specs/pacts/my_consumer-my_provider.json'
 end
 ```
 
@@ -84,6 +84,15 @@ At some stage, you'll want to be able to run your specs one at a time while you
 
     $ rake pact:verify PACT_DESCRIPTION="a request for something" PACT_PROVIDER_STATE="something exists"
 
+## Configuring RSpec
+
+Pact uses dynamically created RSpec specs to verify pacts. If you want to modify the behaviour of the underlying RSpec execution, you can:
+
+1. Set `task.rspec_opts` in your custom rake VerificationTask, the same way you would with a normal RSpec rake task declaration.
+1. Configure RSpec in the pact_helper using the normal `RSpec.configure` code.
+
+For future proofing though, try to use the provider state set_up/tear_down blocks where you can, because we may swap out RSpec for custom verification code in the future.
+
 ## Pact Helper location
 
 The search paths for the pact_helper are:

data/example/animal-service/config.ru

@@ -1,3 +1,3 @@
 require File.dirname(__FILE__) + '/lib/animal_service/api'
 
-run AnimalService::Api
+run AnimalService::Api

data/example/animal-service/lib/animal_service/api.rb

@@ -1,5 +1,5 @@
 require 'sinatra/base'
-require 'animal_service/animal_repository'
+require_relative 'animal_repository'
 
 module AnimalService
 
@@ -25,4 +25,4 @@ module AnimalService
     end
 
   end
-end
+end

data/lib/pact/{app.rb → cli.rb}

@@ -5,7 +5,7 @@ require 'pact/consumer'
 require 'rack/handler/webrick'
 
 module Pact
-  class App < Thor
+  class CLI < Thor
 
     desc 'verify', "Verify a pact"
     method_option :pact_helper, aliases: "-h", desc: "Pact helper file", :required => true
@@ -45,6 +45,7 @@ module Pact
 
 
     def call
+      initialize_rspec
       setup_load_path
       load_pact_helper
       run_specs
@@ -52,10 +53,19 @@ module Pact
 
     private
 
+    def initialize_rspec
+      # With RSpec3, if the pact_helper loads a library that adds its own formatter before we set one,
+      # we will get a ProgressFormatter too, and get little dots sprinkled throughout our output.
+      require 'pact/rspec'
+      ::RSpec.configuration.add_formatter Pact::RSpec.formatter_class
+    end
+
     def setup_load_path
       require 'pact/provider/pact_spec_runner'
-      lib = Dir.pwd + "/lib" # Assume we are running from within the project root. RSpec is smarter about this.
+      lib = File.join(Dir.pwd, "lib") # Assume we are running from within the project root. RSpec is smarter about this.
+      spec = File.join(Dir.pwd, "spec")
       $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+      $LOAD_PATH.unshift(spec) if Dir.exist?(spec) && !$LOAD_PATH.include?(spec)
     end
 
     def load_pact_helper

data/lib/pact/provider/pact_spec_runner.rb

@@ -54,8 +54,7 @@ module Pact
 
         config.color = true
         config.pattern = "pattern which doesn't match any files"
-        config.backtrace_inclusion_patterns = [Regexp.new(Dir.getwd), /pact.*pact\.rake.*2/]
-        config.backtrace_exclusion_patterns << /pact/
+        config.backtrace_inclusion_patterns = [Regexp.new(Dir.getwd), /bin\/pact/]
 
         config.extend Pact::Provider::RSpec::ClassMethods
         config.include Pact::Provider::RSpec::InstanceMethods
@@ -69,7 +68,10 @@ module Pact
           config.output_stream = Pact.configuration.output_stream
         end
 
-        config.add_formatter Pact::RSpec.formatter_class
+        # Sometimes the formatter set in the cli.rb get set with an output of StringIO.. don't know why
+        formatter_class = Pact::RSpec.formatter_class
+        pact_formatter = ::RSpec.configuration.formatters.find {|f| f.class == formatter_class && f.output == ::RSpec.configuration.output_stream}
+        ::RSpec.configuration.add_formatter formatter_class unless pact_formatter
 
         config.before(:suite) do
           # Preload app before suite so the classes loaded in memory are consistent for
@@ -79,6 +81,7 @@ module Pact
           # (eg. with database_cleaner transactions)
           Pact.configuration.provider.app
         end
+
       end
 
       def run_specs

data/lib/pact/provider/rspec/formatter_rspec_2.rb

@@ -1,5 +1,5 @@
 require 'pact/provider/print_missing_provider_states'
-require 'rspec/core/formatters'
+require 'rspec/core/formatters/documentation_formatter'
 require 'term/ansicolor'
 
 module Pact

data/lib/pact/rspec.rb

@@ -1,3 +1,4 @@
+require 'rspec'
 # This is horrible, must work out a better way of doing this
 module Pact
   module RSpec

data/lib/pact/tasks/task_helper.rb

@@ -1,13 +1,14 @@
 require 'pact/provider/pact_helper_locator'
 require 'rake/file_utils'
+require 'shellwords'
 
 module Pact
   module TaskHelper
 
     extend self
 
-    def execute_pact_verify pact_uri = nil, pact_helper = nil
-      execute_cmd verify_command(pact_helper || Pact::Provider::PactHelperLocater.pact_helper_path, pact_uri)
+    def execute_pact_verify pact_uri = nil, pact_helper = nil, rspec_opts = nil
+      execute_cmd verify_command(pact_helper || Pact::Provider::PactHelperLocater.pact_helper_path, pact_uri, rspec_opts)
     end
 
     def handle_verification_failure
@@ -15,8 +16,11 @@ module Pact
       abort if exit_status != 0
     end
 
-    def verify_command pact_helper, pact_uri = nil
+    def verify_command pact_helper, pact_uri, rspec_opts
       command_parts = []
+      # Clear SPEC_OPTS, otherwise we can get extra formatters, creating duplicate output eg. CI Reporting.
+      # Allow deliberate configuration using rspec_opts in VerificationTask.
+      command_parts << "SPEC_OPTS=#{Shellwords.escape(rspec_opts || '')}"
       command_parts << FileUtils::RUBY
       command_parts << "-S pact verify"
       command_parts << "-h" << (pact_helper.end_with?(".rb") ? pact_helper : pact_helper + ".rb")

data/lib/pact/tasks/verification_task.rb

@@ -29,8 +29,10 @@ module Pact
   class VerificationTask < ::Rake::TaskLib
 
     attr_reader :pact_spec_configs
+    attr_accessor :rspec_opts
 
     def initialize(name)
+      @rspec_opts = nil
       @pact_spec_configs = []
       @name = name
       yield self
@@ -72,7 +74,7 @@ module Pact
           require 'pact/tasks/task_helper'
 
           exit_statuses = pact_spec_configs.collect do | config |
-            Pact::TaskHelper.execute_pact_verify config[:uri], config[:pact_helper]
+            Pact::TaskHelper.execute_pact_verify config[:uri], config[:pact_helper], rspec_opts
           end
 
           Pact::TaskHelper.handle_verification_failure do

data/lib/pact/version.rb

@@ -1,3 +1,3 @@
 module Pact
-  VERSION = "1.2.1.rc1"
+  VERSION = "1.2.1.rc2"
 end

data/spec/lib/pact/{app_spec.rb → cli_spec.rb}

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'pact/app'
+require 'pact/cli'
 
 module Pact
   describe SpecCriteria do

data/spec/lib/pact/tasks/task_helper_spec.rb

@@ -17,7 +17,7 @@ module Pact
       end
 
       context "with no pact_helper or pact URI" do
-        let(:command) { "#{ruby_path} -S pact verify -h #{default_pact_helper_path}" }
+        let(:command) { "SPEC_OPTS='' #{ruby_path} -S pact verify -h #{default_pact_helper_path}" }
         it "executes the command" do
           expect(TaskHelper).to receive(:execute_cmd).with(command)
           TaskHelper.execute_pact_verify
@@ -25,7 +25,7 @@ module Pact
       end
 
       context "with a pact URI" do
-        let(:command) { "#{ruby_path} -S pact verify -h #{default_pact_helper_path} -p #{pact_uri}" }
+        let(:command) { "SPEC_OPTS='' #{ruby_path} -S pact verify -h #{default_pact_helper_path} -p #{pact_uri}" }
         it "executes the command" do
           expect(TaskHelper).to receive(:execute_cmd).with(command)
           TaskHelper.execute_pact_verify(pact_uri)
@@ -34,7 +34,7 @@ module Pact
 
       context "with a pact URI and a pact_helper" do
         let(:custom_pact_helper_path) { '/custom/pact_helper.rb' }
-        let(:command) { "#{ruby_path} -S pact verify -h #{custom_pact_helper_path} -p #{pact_uri}" }
+        let(:command) { "SPEC_OPTS='' #{ruby_path} -S pact verify -h #{custom_pact_helper_path} -p #{pact_uri}" }
         it "executes the command" do
           expect(TaskHelper).to receive(:execute_cmd).with(command)
           TaskHelper.execute_pact_verify(pact_uri, custom_pact_helper_path)
@@ -43,7 +43,7 @@ module Pact
 
       context "with a pact_helper with no .rb on the end" do
         let(:custom_pact_helper_path) { '/custom/pact_helper' }
-        let(:command) { "#{ruby_path} -S pact verify -h #{custom_pact_helper_path}.rb -p #{pact_uri}" }
+        let(:command) { "SPEC_OPTS='' #{ruby_path} -S pact verify -h #{custom_pact_helper_path}.rb -p #{pact_uri}" }
         it "executes the command" do
           expect(TaskHelper).to receive(:execute_cmd).with(command)
           TaskHelper.execute_pact_verify(pact_uri, custom_pact_helper_path)
@@ -51,13 +51,22 @@ module Pact
       end
 
       context "with a pact URI and a nil pact_helper" do
-        let(:command) { "#{ruby_path} -S pact verify -h #{default_pact_helper_path} -p #{pact_uri}" }
+        let(:command) { "SPEC_OPTS='' #{ruby_path} -S pact verify -h #{default_pact_helper_path} -p #{pact_uri}" }
         it "executes the command" do
           expect(TaskHelper).to receive(:execute_cmd).with(command)
           TaskHelper.execute_pact_verify(pact_uri, nil)
         end
       end
 
+      context "with rspec_opts" do
+        it "includes the rspec_opts as SPEC_OPTS in the command" do
+          expect(TaskHelper).to receive(:execute_cmd) do | command |
+            expect(command).to start_with("SPEC_OPTS=--reporter\\ SomeReporter #{ruby_path}")
+          end
+          TaskHelper.execute_pact_verify(pact_uri, nil, "--reporter SomeReporter")
+        end
+      end
+
     end
 
 

data/spec/lib/pact/tasks/verification_task_spec.rb

@@ -44,7 +44,7 @@ module Pact
 
       context "with no explicit pact_helper" do
         it 'verifies the pacts using the TaskHelper' do
-          expect(Pact::TaskHelper).to receive(:execute_pact_verify).with(@pact_uri, nil)
+          expect(Pact::TaskHelper).to receive(:execute_pact_verify).with(@pact_uri, nil, nil)
           Rake::Task[@task_name].execute
         end
       end
@@ -52,7 +52,7 @@ module Pact
       context "with an explict pact_helper" do
         let(:verification_config) { [ uri: @pact_uri, pact_helper: @pact_helper] }
         it 'verifies the pacts using the TaskHelper' do
-          expect(Pact::TaskHelper).to receive(:execute_pact_verify).with(@pact_uri, @pact_helper)
+          expect(Pact::TaskHelper).to receive(:execute_pact_verify).with(@pact_uri, @pact_helper, nil)
           Rake::Task[@task_name_with_explict_pact_helper].execute
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact
 version: !ruby/object:Gem::Version
-  version: 1.2.1.rc1
+  version: 1.2.1.rc2
   prerelease: 6
 platform: ruby
 authors:
@@ -333,7 +333,7 @@ files:
 - example/zoo-app/spec/service_providers/pact_helper.rb
 - example/zoo-app/spec/spec_helper.rb
 - lib/pact.rb
-- lib/pact/app.rb
+- lib/pact/cli.rb
 - lib/pact/configuration.rb
 - lib/pact/consumer.rb
 - lib/pact/consumer/app_manager.rb
@@ -456,7 +456,7 @@ files:
 - spec/integration/consumer_spec.rb
 - spec/integration/pact/consumer_configuration_spec.rb
 - spec/integration/pact/provider_configuration_spec.rb
-- spec/lib/pact/app_spec.rb
+- spec/lib/pact/cli_spec.rb
 - spec/lib/pact/configuration_spec.rb
 - spec/lib/pact/consumer/app_manager_spec.rb
 - spec/lib/pact/consumer/configuration_spec.rb
@@ -559,7 +559,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 984907966293091128
+      hash: -3125311526466390789
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -581,7 +581,7 @@ test_files:
 - spec/integration/consumer_spec.rb
 - spec/integration/pact/consumer_configuration_spec.rb
 - spec/integration/pact/provider_configuration_spec.rb
-- spec/lib/pact/app_spec.rb
+- spec/lib/pact/cli_spec.rb
 - spec/lib/pact/configuration_spec.rb
 - spec/lib/pact/consumer/app_manager_spec.rb
 - spec/lib/pact/consumer/configuration_spec.rb