pact 1.0.4 → 1.0.5

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 1.0.5 (6 September 2013)
+
+* Added verification reports when running rake pact:verify:xxx [Latheesh Padukana, Beth Skurrie]
+* Changed pact:verify failure message to display in red [Latheesh Padukana, Beth Skurrie]
+
 ### 1.0.4 (6 September 2013)
 
 * Added pact/tasks as an easy way to load the rake tasks and classes into the client project [Beth Skurrie]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pact (1.0.4)
+    pact (1.0.5)
       awesome_print (~> 1.1.0)
       find_a_port (~> 1.0.1)
       hashie (~> 2.0)

data/lib/pact/consumer_contract/consumer_contract.rb

@@ -3,15 +3,31 @@ require 'pact/logging'
 require 'pact/json_warning'
 require 'date'
 require 'pact/version'
+require 'open-uri'
 require_relative 'service_consumer'
 require_relative 'service_provider'
 require_relative 'interaction'
 
+
+
 module Pact
+
+  #TODO move to external file for reuse
+  module FileName
+    def file_name consumer_name, provider_name
+      "#{filenamify(consumer_name)}-#{filenamify(provider_name)}.json"
+    end
+
+    def filenamify name
+      name.downcase.gsub(/\s/, '_')
+    end
+  end
+
   class ConsumerContract
 
-    include Pact::Logging
-    include Pact::JsonWarning
+    include Logging
+    include JsonWarning
+    include FileName
 
     attr_accessor :interactions
     attr_accessor :consumer
@@ -37,7 +53,8 @@ module Pact
     end
 
     def to_json(options = {})
-      as_json(options).to_json(options)
+      as_json(options).to_json(
+        )
     end
 
     def self.from_hash(obj)
@@ -53,6 +70,10 @@ module Pact
       from_hash(deserialised_object)
     end
 
+    def self.from_uri uri
+      from_json(open(uri){ |f| f.read })
+    end
+
     def self.maintain_backwards_compatiblity_with_producer_keys string
       string.gsub('"producer":', '"provider":').gsub('"producer_state":', '"provider_state":')
     end
@@ -78,26 +99,20 @@ module Pact
     end
 
     def pact_file_name
-      "#{filenamify(consumer.name)}-#{filenamify(provider.name)}.json"
+      file_name consumer.name, provider.name
     end
 
-      def pactfile_path
-        raise 'You must first specify a consumer and service name' unless (consumer && consumer.name && provider && provider.name)
-        @pactfile_path ||= File.join(Pact.configuration.pact_dir, pact_file_name)
-      end
-
-      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
-      end
-
-    private
+    def pactfile_path
+      raise 'You must first specify a consumer and service name' unless (consumer && consumer.name && provider && provider.name)
+      @pactfile_path ||= File.join(Pact.configuration.pact_dir, pact_file_name)
+    end
 
-      def filenamify name
-        name.downcase.gsub(/\s/, '_')
+    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
+    end
   end
 end

data/lib/pact/pact_task_helper.rb

@@ -1,7 +1,13 @@
 module PactTaskHelper
   def failure_message
-    "\n* * * * * * * * * * * * * * * * * * *\n" +
-    "Provider did not honour pact file.\nSee\n * #{Pact.configuration.log_path}\n * #{Pact.configuration.tmp_dir}\nfor logs and pact files." +
-    "\n* * * * * * * * * * * * * * * * * * *\n\n"
+    redify(
+      "\n* * * * * * * * * * * * * * * * * * *\n" +
+      "Provider did not honour pact file.\nSee\n * #{Pact.configuration.log_path}\n * #{Pact.configuration.tmp_dir}\nfor logs and pact files." +
+      "\n* * * * * * * * * * * * * * * * * * *\n\n"
+    )
+  end
+
+  def redify string
+    "\e[31m#{string}\e[m"
   end
 end

data/lib/pact/provider/pact_spec_runner.rb

@@ -2,6 +2,7 @@ require 'open-uri'
 require 'rspec'
 require 'rspec/core'
 require 'rspec/core/formatters/documentation_formatter'
+require 'rspec/core/formatters/json_formatter'
 require_relative 'rspec'
 
 
@@ -9,7 +10,11 @@ module Pact
 	module Provider
 		class PactSpecRunner
 
-			extend Pact::Provider::RSpec::ClassMethods
+			include Pact::Provider::RSpec::ClassMethods
+
+			attr_reader :spec_definitions
+			attr_reader :options
+			attr_reader :output
 
 			PACT_HELPER_FILE_PATTERNS = [
 				"spec/**/*service*consumer*/pact_helper.rb",
@@ -19,15 +24,21 @@ module Pact
 
 			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
+			def initialize spec_definitions, options = {}
+				@spec_definitions = spec_definitions
+				@options = options
+				@results = nil
+			end
+
+			def run
+				initialize_specs
+				configure_rspec
 				run_specs
 			end
 
 			private
 
-			def self.require_pact_helper spec_definition
+			def require_pact_helper spec_definition
 				if spec_definition[:support_file]
 					require spec_definition[:support_file]
 				else
@@ -35,14 +46,14 @@ module Pact
 				end
 			end
 
-			def self.pact_helper_file
+			def 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
+			def initialize_specs
 				spec_definitions.each do | spec_definition |
 					require_pact_helper spec_definition
 					options = {consumer: spec_definition[:consumer], save_pactfile_to_tmp: true}
@@ -50,7 +61,7 @@ module Pact
 				end
 			end
 
-			def self.configure_rspec options
+			def configure_rspec
 				config = ::RSpec.configuration
 				config.color = true
 
@@ -60,14 +71,15 @@ module Pact
 				end
 
 				formatter = ::RSpec::Core::Formatters::DocumentationFormatter.new(config.output)
-				reporter =  ::RSpec::Core::Reporter.new(formatter)
+				@json_formatter = ::RSpec::Core::Formatters::JsonFormatter.new(StringIO.new)
+				reporter =  ::RSpec::Core::Reporter.new(formatter, @json_formatter)
 				config.instance_variable_set(:@reporter, reporter)
 			end
 
-			def self.run_specs
+			def run_specs
 				config = ::RSpec.configuration
 				world = ::RSpec::world
-				config.reporter.report(world.example_count, nil) do |reporter|
+				exit_code = config.reporter.report(world.example_count, nil) do |reporter|
 				  begin
 				    config.run_hook(:before, :suite)
 				    world.example_groups.ordered.map {|g| g.run(reporter)}.all? ? 0 : config.failure_exit_code
@@ -75,6 +87,8 @@ module Pact
 				    config.run_hook(:after, :suite)
 				  end
 				end
+				@output = @json_formatter.output_hash
+				exit_code
 			end
 		end
 	end

data/lib/pact/provider/rspec.rb

@@ -17,6 +17,8 @@ module Pact
 
       module ClassMethods
 
+        include ::RSpec::Core::DSL
+
         include Pact::JsonWarning
 
         def honour_pactfile pactfile_uri, options = {}

data/lib/pact/provider/verification_report.rb

@@ -0,0 +1,32 @@
+require 'pact/consumer_contract'
+
+module Pact::Provider
+  class VerificationReport
+
+    include Pact::FileName
+
+    def initialize (options)
+      @consumer = options[:consumer]
+      @provider = options[:provider]
+      @result = options[:result]
+      @output = options[:output]
+    end
+
+    def as_json
+      {
+        :consumer => @consumer,
+        :provider => @provider,
+        :result => @result,
+        :output => @output
+      }
+    end
+
+    def to_json(options = {})
+      as_json.to_json(options)
+    end
+
+    def report_file_name
+      file_name("#{@consumer[:name]}_#{@consumer[:ref]}", "#{@provider[:name]}_#{@provider[:ref]}")
+    end
+  end
+end

data/lib/pact/verification_task.rb

@@ -1,6 +1,7 @@
 require 'rake/tasklib'
 require 'pact/provider/pact_spec_runner'
 require_relative 'pact_task_helper'
+require_relative 'provider/verification_report'
 
 =begin
 	To create a rake pact:verify:<something> task
@@ -48,12 +49,38 @@ module Pact
 
 	  attr_reader :name
 
+	  def parse_pactfile config
+	  	Pact::ConsumerContract.from_uri config[:uri]
+	  end
+
+	  def publish_report config, output, result
+  	    consumer_contract = parse_pactfile config
+	    	#TODO - when checking out a historical version, provider ref will be prod, however it will think it is head. Fix this!!!!
+  	    report = Provider::VerificationReport.new(
+  	    	:result => result,
+  	    	:output => output,
+  	    	:consumer => {:name => consumer_contract.consumer.name, :ref => name},
+  	    	:provider => {:name => consumer_contract.provider.name, :ref => 'head'}
+  	    	)
+
+  	    FileUtils.mkdir_p "./reports/pact"
+  	    File.open("./reports/pact/#{report.report_file_name}", "w") { |file| file << JSON.pretty_generate(report) }
+	  end
+
 	  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
+
+	  	  	exit_statuses = pact_spec_config.collect do | config |
+	  	  		#TODO: Change this to accept the ConsumerContract that is already parsed, so we don't make the same request twice
+		  	  	pact_spec_runner = Provider::PactSpecRunner.new([config])
+		  	    exit_status = pact_spec_runner.run
+		  	    publish_report config, pact_spec_runner.output, exit_status == 0
+		  	    exit_status
+	  	  	end
+
+	  	    fail failure_message if exit_statuses.any?{ | status | status != 0 }
 	  	  end
 	  	end
 	  end

data/lib/pact/version.rb

@@ -1,3 +1,3 @@
 module Pact
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

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

@@ -5,7 +5,7 @@ module Pact::Provider
   describe PactSpecRunner do
     describe "pact_helper_file", :fakefs => true do
 
-      subject { PactSpecRunner.send(:pact_helper_file) }
+      subject { PactSpecRunner.new({}).send(:pact_helper_file) }
 
       def make_pactfile dir
         FileUtils.mkdir_p ".#{dir}"

data/spec/lib/pact/verification_task_spec.rb

@@ -19,6 +19,16 @@ module Pact
 			end
 		end
 
+		before do
+			VerificationTask.any_instance.stub(:publish_report)
+			Provider::PactSpecRunner.stub(:new).with(consumer_contract).and_return(pact_spec_runner)
+		end
+
+		let(:pact_spec_runner) { double('PactSpecRunner', :run => exit_code, :output => nil)}
+		let(:exit_code) {0}
+		let(:consumer_contract) { [ uri: @pact_uri, support_file: nil ] }
+
+
 		describe '.initialize' do
 			context 'with an explict support_file' do
 				it 'creates the tasks' do
@@ -34,11 +44,9 @@ module Pact
 
 		describe 'execute' do
 
-			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
@@ -46,17 +54,12 @@ module Pact
 			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
 
-				before do
-					Provider::PactSpecRunner.stub(:run).and_return(0)
-				end
-
 				it 'does not raise an exception' do
 					Rake::Task[@task_name].execute
 				end
@@ -64,9 +67,7 @@ module Pact
 
 			context 'when one or more specs fail' do
 
-				before do
-					Provider::PactSpecRunner.stub(:run).and_return(1)
-				end
+				let(:exit_code) {1}
 
 				it 'raises an exception' do
 					expect { Rake::Task[@task_name].execute }.to raise_error RuntimeError

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' }], silent: silent)
+		result = Pact::Provider::PactSpecRunner.new([{ uri: './spec/support/test_app_pass.json' }], silent: silent).run
 		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_helper.rb' }], silent: silent)
+		result = Pact::Provider::PactSpecRunner.new([{ uri: './spec/support/test_app_fail.json', support_file: './spec/support/pact_helper.rb' }], silent: silent).run
 		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.4
+  version: 1.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -299,6 +299,7 @@ files:
 - lib/pact/provider/provider_state.rb
 - lib/pact/provider/rspec.rb
 - lib/pact/provider/test_methods.rb
+- lib/pact/provider/verification_report.rb
 - lib/pact/reification.rb
 - lib/pact/request.rb
 - lib/pact/tasks.rb