pact 1.4.0 → 1.5.0

data/CHANGELOG.md

@@ -2,7 +2,20 @@ Do this to generate your change history
 
   git log --pretty=format:'  * %h - %s (%an, %ad)'
 
-
+### 1.5.0 (25 November 2014)
+
+* 9a5ab1c - Allow path to be specified as a Pact::Term (Beth, Wed Jan 21 07:56:19 2015 +1100)
+* cdec8bd - Prepended rake commands in output with 'bundle exec' (Beth, Mon Dec 22 17:27:12 2014 +1100)
+* 6dfb16e - Added line to print pact verify command to stdout (Beth, Mon Dec 22 17:19:00 2014 +1100)
+* b507f50 - Changed colours of missing provider state templates (Beth, Tue Dec 16 21:50:00 2014 +1100)
+* d61769c - Added prompt for rake pact:verify:help on test failure. (Beth, Tue Dec 16 21:34:51 2014 +1100)
+* c5377a1 - Created rake pact:verify:help task to display help text (Beth, Tue Dec 16 20:38:45 2014 +1100)
+* c9d1189 - Write help to file after pact:verify (Beth, Tue Dec 16 19:49:20 2014 +1100)
+* c7d8c35 - Added pact diff to help text (Beth, Tue Dec 16 13:14:35 2014 +1100)
+* c877b94 - Moved interaction filter to command line argument from ENV (Beth, Sun Dec 14 22:05:44 2014 +1100)
+* cd077ec - Added message to show diff between current pact and previous version when pact:verify fails. This relies on the 'diff-previous-distinct' relation being present in the pact resource, so will only work when the pact is retrieved from a pact broker (Beth, Fri Dec 12 11:25:59 2014 +1100)
+* 43aa930 - Added command line option to show full backtrace for pact:verify failures (Beth, Thu Dec 4 08:45:28 2014 +1100)
+* 5667874 - Ensure markdown doc rendering doesn't blow up if there is a nil description (Beth, Wed Dec 3 21:35:42 2014 +1100)
 
 ### 1.4.0 (25 November 2014)
 

data/lib/pact/cli.rb

@@ -1,8 +1,5 @@
-require 'find_a_port'
 require 'thor'
-require 'thwait'
-require 'pact/consumer'
-require 'rack/handler/webrick'
+require 'pact/cli/run_pact_verification'
 
 module Pact
   class CLI < Thor
@@ -10,103 +7,13 @@ module Pact
     desc 'verify', "Verify a pact"
     method_option :pact_helper, aliases: "-h", desc: "Pact helper file", :required => true
     method_option :pact_uri, aliases: "-p", desc: "Pact URI"
+    method_option :backtrace, aliases: "-b", desc: "Show full backtrace", :default => false, :type => :boolean
+    method_option :description, aliases: "-d", desc: "Interaction description filter"
+    method_option :provider_state, aliases: "-s", desc: "Provider state filter"
 
     def verify
-      RunPactVerification.call(options)
+      Cli::RunPactVerification.call(options)
     end
 
-    private
-
-    def log message
-      puts message unless options[:quiet]
-    end
-  end
-
-  class RunPactVerification
-
-    attr_reader :options
-
-    def initialize options
-      @options = options
-    end
-
-    def self.call options
-      new(options).call
-    end
-
-
-    def call
-      initialize_rspec
-      setup_load_path
-      load_pact_helper
-      run_specs
-    end
-
-    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 = 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
-      load options[:pact_helper]
-    end
-
-    def run_specs
-      exit_code = if options[:pact_uri]
-        run_with_pact_uri
-      else
-        run_with_configured_pacts
-      end
-      exit 1 unless exit_code == 0
-    end
-
-    def run_with_pact_uri
-      Pact::Provider::PactSpecRunner.new([{uri: options[:pact_uri]}], pact_spec_options).run
-    end
-
-    def run_with_configured_pacts
-      pact_verifications = Pact.configuration.pact_verifications
-      verification_configs = pact_verifications.collect { | pact_verification | { :uri => pact_verification.uri }}
-      raise "Please configure a pact to verify" if verification_configs.empty?
-      Pact::Provider::PactSpecRunner.new(verification_configs, options).run
-    end
-
-    def pact_spec_options
-      {criteria: SpecCriteria.call}
-    end
-
-  end
-
-  class SpecCriteria
-
-    def self.call
-      criteria = {}
-
-      description = ENV["PACT_DESCRIPTION"]
-      criteria[:description] = Regexp.new(description) if description
-
-      provider_state = ENV["PACT_PROVIDER_STATE"]
-      if provider_state
-        if provider_state.length == 0
-          criteria[:provider_state] = nil #Allow PACT_PROVIDER_STATE="" to mean no provider state
-        else
-          criteria[:provider_state] = Regexp.new(provider_state)
-        end
-      end
-
-      criteria
-    end
   end
 end

data/lib/pact/cli/run_pact_verification.rb

@@ -0,0 +1,74 @@
+require 'pact/cli/spec_criteria'
+
+module Pact
+  module Cli
+    class RunPactVerification
+
+      attr_reader :options
+
+      def initialize options
+        @options = options
+      end
+
+      def self.call options
+        new(options).call
+      end
+
+
+      def call
+        initialize_rspec
+        setup_load_path
+        load_pact_helper
+        run_specs
+      end
+
+      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 = 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
+        load options[:pact_helper]
+      end
+
+      def run_specs
+        exit_code = if options[:pact_uri]
+          run_with_pact_uri
+        else
+          run_with_configured_pacts
+        end
+        exit exit_code
+      end
+
+      def run_with_pact_uri
+        Pact::Provider::PactSpecRunner.new([options[:pact_uri]], pact_spec_options).run
+      end
+
+      def run_with_configured_pacts
+        pact_urls = Pact.provider_world.pact_urls
+        raise "Please configure a pact to verify" if pact_urls.empty?
+        Pact::Provider::PactSpecRunner.new(pact_urls, pact_spec_options).run
+      end
+
+      def pact_spec_options
+        {
+          full_backtrace: options[:backtrace],
+          criteria: SpecCriteria.call(options)
+        }
+      end
+
+    end
+  end
+end

data/lib/pact/cli/spec_criteria.rb

@@ -0,0 +1,23 @@
+module Pact
+  module Cli
+    class SpecCriteria
+
+      def self.call options
+        criteria = {}
+
+        criteria[:description] = Regexp.new(options[:description]) if options[:description]
+
+        provider_state = options[:provider_state]
+        if provider_state
+          if provider_state.length == 0
+            criteria[:provider_state] = nil #Allow PACT_PROVIDER_STATE="" to mean no provider state
+          else
+            criteria[:provider_state] = Regexp.new(provider_state)
+          end
+        end
+
+        criteria
+      end
+    end
+  end
+end

data/lib/pact/consumer/configuration/configuration_extensions.rb

@@ -17,6 +17,18 @@ module Pact
           @doc_dir = doc_dir
         end
 
+        def reports_dir
+          @reports_dir ||= default_reports_dir
+        end
+
+        def default_reports_dir
+          File.expand_path("./reports/pacts")
+        end
+
+        def reports_dir= reports_dir
+          @reports_dir = reports_dir
+        end
+
         def add_provider_verification &block
           provider_verifications << block
         end

data/lib/pact/doc/interaction_view_model.rb

@@ -17,7 +17,7 @@ module Pact
           if has_provider_state?
             "#{description} given #{interaction.provider_state}"
           else
-            interaction.description
+            description
           end.gsub(/\s+/,'_')
         end
       end
@@ -51,6 +51,7 @@ module Pact
       end
 
       def description start_of_sentence = false
+        return '' unless @interaction.description
         apply_capitals(@interaction.description.strip, start_of_sentence)
       end
 

data/lib/pact/provider/configuration/configuration_extension.rb

@@ -21,14 +21,6 @@ module Pact
           end
         end
 
-        def add_pact_verification verification
-          pact_verifications << verification
-        end
-
-        def pact_verifications
-          @pact_verifications ||= []
-        end
-
         def config_ru_path
           @config_ru_path ||= './config.ru'
         end

data/lib/pact/provider/configuration/pact_verification.rb

@@ -1,5 +1,6 @@
 require 'pact/provider/pact_verification'
 require 'pact/shared/dsl'
+require 'pact/provider/world'
 
 module Pact
   module Provider
@@ -33,7 +34,7 @@ module Pact
 
         def create_pact_verification
           verification = Pact::Provider::PactVerification.new(consumer_name, pact_uri, ref)
-          Pact.configuration.add_pact_verification verification
+          Pact.provider_world.add_pact_verification verification
         end
 
         def validate

data/lib/pact/provider/help/console_text.rb

@@ -0,0 +1,80 @@
+require 'pact/provider/help/content'
+require 'fileutils'
+require 'pact/consumer/configuration'
+require 'pact/provider/help/write'
+require 'term/ansicolor'
+
+module Pact
+  module Provider
+    module Help
+      class ConsoleText
+
+        C = ::Term::ANSIColor
+
+        def self.call reports_dir = Pact.configuration.reports_dir, options = {color: true}
+          new(reports_dir || Pact.configuration.reports_dir, options).call
+        end
+
+        def initialize reports_dir, options
+          @reports_dir = File.expand_path(reports_dir)
+          @options = options
+        end
+
+        def call
+          begin
+            options[:color] ? ColorizeMarkdown.(help_text) : help_text
+          rescue Errno::ENOENT
+            options[:color] ? error_text_coloured : error_text_plain
+          end
+        end
+
+        private
+
+        attr_reader :reports_dir, :options
+
+        def help_text
+          File.read(help_file_path)
+        end
+
+        def help_file_path
+          File.join(reports_dir, Write::HELP_FILE_NAME)
+        end
+
+        def error_text_plain
+          "Sorry, could not find help file at #{help_file_path}. Please ensure you have run `rake pact:verify`.\n" +
+           "If this does not fix the problem, please raise a github issues for this bug."
+        end
+
+        def error_text_coloured
+          C.red(error_text_plain)
+        end
+
+        class ColorizeMarkdown
+
+          C = ::Term::ANSIColor
+
+          def self.call markdown
+            markdown.split("\n").collect do | line |
+              if line.start_with?("# ")
+                yellow_underling line.gsub(/^# /, '')
+              elsif line.start_with?("* ")
+                green("* ") + line.gsub(/^\* /, '')
+              else
+                line
+              end
+            end.join("\n")
+          end
+
+          def self.yellow_underling string
+            C.underline(C.yellow(string))
+          end
+
+          def self.green string
+            C.green(string)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider/help/content.rb

@@ -0,0 +1,38 @@
+require 'pact/provider/help/pact_diff'
+
+module Pact
+  module Provider
+    module Help
+      class Content
+
+        def initialize pact_jsons
+          @pact_jsons = pact_jsons
+        end
+
+        def text
+          help_text + "\n\n" + pact_diffs
+        end
+
+        private
+
+        attr_reader :pact_jsons
+
+        def help_text
+          temp_dir = Pact.configuration.tmp_dir
+          log_path = Pact.configuration.log_path
+          ERB.new(template_string).result(binding)
+        end
+
+        def template_string
+          File.read(File.expand_path( '../../../templates/help.erb', __FILE__))
+        end
+
+        def pact_diffs
+          pact_jsons.collect do | pact_json |
+            PactDiff.call(pact_json)
+          end.compact.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider/help/pact_diff.rb

@@ -0,0 +1,67 @@
+module Pact
+  module Provider
+    module Help
+
+      class PactDiff
+
+        class PrintPactDiffError < StandardError; end
+
+        attr_reader :pact_json, :output
+
+        def initialize pact_json
+          @pact_json = pact_json
+        end
+
+        def self.call pact_json
+          new(pact_json).call
+        end
+
+        def call
+          begin
+            if diff_rel && diff_url
+              header + "\n" + get_diff
+            end
+          rescue PrintPactDiffError => e
+            return e.message
+          end
+        end
+
+        private
+
+        def header
+          "The following changes have been made since the previous distinct version of this pact, and may be responsible for verification failure:\n"
+        end
+
+        def pact_hash
+          @pact_hash ||= json_load(pact_json)
+        end
+
+        def links
+          pact_hash['_links'] || pact_hash['links']
+        end
+
+        def diff_rel
+          return nil unless links
+          key = links.keys.find { | key | key =~ /diff/ && key =~ /distinct/ && key =~ /previous/}
+          key ? links[key] : nil
+        end
+
+        def diff_url
+          diff_rel['href']
+        end
+
+        def get_diff
+          begin
+            open(diff_url) { | file | file.read }
+          rescue StandardError => e
+            raise PrintPactDiffError.new("Tried to retrieve diff with previous pact from #{diff_url}, but received response code #{e}.")
+          end
+        end
+
+        def json_load json
+          JSON.load(json, nil, { max_nesting: 50 })
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider/help/prompt_text.rb

@@ -0,0 +1,51 @@
+require 'pact/consumer/configuration'
+require 'term/ansicolor'
+require 'pathname'
+
+module Pact
+  module Provider
+    module Help
+      class PromptText
+
+        C = ::Term::ANSIColor
+
+        def self.call reports_dir = Pact.configuration.reports_dir, options = {color: Pact.configuration.color_enabled}
+          new(reports_dir, options).call
+        end
+
+        def initialize reports_dir, options
+          @reports_dir = File.expand_path(reports_dir)
+          @options = options
+        end
+
+        def call
+          options[:color] ? prompt_text_colored : prompt_text_plain
+        end
+
+        private
+
+        attr_reader :reports_dir, :options
+
+        def prompt_text_plain
+          "For assistance debugging failures, run `bundle exec rake pact:verify:help#{rake_args}`\n"
+        end
+
+        def prompt_text_colored
+          C.yellow(prompt_text_plain)
+        end
+
+        def rake_args
+          if reports_dir == Pact.configuration.default_reports_dir
+            ''
+          else
+            "[#{relative_reports_dir}]"
+          end
+        end
+
+        def relative_reports_dir
+          Pathname.new(reports_dir).relative_path_from(Pathname.new(Dir.pwd))
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider/help/write.rb

@@ -0,0 +1,55 @@
+require 'pact/provider/help/content'
+require 'fileutils'
+require 'pact/consumer/configuration'
+
+module Pact
+  module Provider
+    module Help
+      class Write
+
+        HELP_FILE_NAME = 'help.md'
+
+        def self.call pact_jsons, reports_dir = Pact.configuration.reports_dir
+          new(pact_jsons, reports_dir).call
+        end
+
+        def initialize pact_jsons, reports_dir
+          @pact_jsons = pact_jsons
+          @reports_dir = File.expand_path(reports_dir)
+        end
+
+        def call
+          clean_reports_dir
+          write
+        end
+
+        private
+
+        attr_reader :reports_dir, :pact_jsons
+
+        def clean_reports_dir
+          raise "Cleaning report dir #{reports_dir} would delete project!" if reports_dir_contains_pwd
+          FileUtils.rm_rf reports_dir
+          FileUtils.mkdir_p reports_dir
+        end
+
+        def reports_dir_contains_pwd
+          Dir.pwd.start_with?(reports_dir)
+        end
+
+        def write
+          File.open(help_path, "w") { |file| file << help_text }
+        end
+
+        def help_path
+          File.join(reports_dir, 'help.md')
+        end
+
+        def help_text
+          Content.new(pact_jsons).text
+        end
+
+      end
+    end
+  end
+end

data/lib/pact/provider/pact_source.rb

@@ -0,0 +1,19 @@
+require 'pact/consumer_contract/pact_file'
+
+module PactBroker
+  module Provider
+    class PactSource
+
+      attr_reader :uri
+
+      def initialize uri
+        @uri = uri
+      end
+
+      def pact_json
+        @pact_json ||= Pact::PactFile.read(uri, {})
+      end
+
+    end
+  end
+end

data/lib/pact/provider/pact_spec_runner.rb

@@ -5,6 +5,8 @@ require 'rspec/core/formatters/documentation_formatter'
 require 'pact/provider/pact_helper_locator'
 require 'pact/project_root'
 require 'pact/rspec'
+require 'pact/provider/pact_source'
+require 'pact/provider/help/write'
 
 require_relative 'rspec'
 
@@ -15,12 +17,12 @@ module Pact
 
       include Pact::Provider::RSpec::ClassMethods
 
-      attr_reader :spec_definitions
+      attr_reader :pact_urls
       attr_reader :options
       attr_reader :output
 
-      def initialize spec_definitions, options = {}
-        @spec_definitions = spec_definitions
+      def initialize pact_urls, options = {}
+        @pact_urls = pact_urls
         @options = options
         @results = nil
       end
@@ -38,17 +40,6 @@ module Pact
 
       private
 
-      def initialize_specs
-        spec_definitions.each do | spec_definition |
-          options = {
-            consumer: spec_definition[:consumer],
-            save_pactfile_to_tmp: true,
-            criteria: @options[:criteria]
-          }
-          honour_pactfile spec_definition[:uri], options
-        end
-      end
-
       def configure_rspec
         monkey_patch_backtrace_formatter
 
@@ -74,6 +65,7 @@ module Pact
         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
+        ::RSpec.configuration.full_backtrace = @options[:full_backtrace]
 
         config.before(:suite) do
           # Preload app before suite so the classes loaded in memory are consistent for
@@ -84,6 +76,12 @@ module Pact
           Pact.configuration.provider.app
         end
 
+        jsons = pact_jsons
+
+        config.after(:suite) do
+          Pact::Provider::Help::Write.call(jsons)
+        end
+
       end
 
       def run_specs
@@ -106,6 +104,27 @@ module Pact
         end
       end
 
+      def pact_sources
+        @pact_sources ||= begin
+          pact_urls.collect do | pact_url |
+            PactBroker::Provider::PactSource.new(pact_url)
+          end
+        end
+      end
+
+      def pact_jsons
+        pact_sources.collect(&:pact_json)
+      end
+
+      def initialize_specs
+        pact_sources.each do | pact_source |
+          options = {
+            criteria: @options[:criteria]
+          }
+          honour_pactfile pact_source.uri, pact_source.pact_json, options
+        end
+      end
+
       def class_exists? name
         Kernel.const_get name
       rescue NameError

data/lib/pact/provider/print_missing_provider_states.rb

@@ -1,16 +1,23 @@
+require 'term/ansicolor'
+
 module Pact
   module Provider
     class PrintMissingProviderStates
 
+      C = ::Term::ANSIColor
+
       # Hash of consumer names to array of names of missing provider states
       def self.call missing_provider_states, output
         if missing_provider_states.any?
-          output.puts orangeify(text(missing_provider_states))
+          output.puts colorize(text(missing_provider_states))
         end
       end
 
-      def self.orangeify string
-        "\e[33m#{string}\e[m"
+      def self.colorize string
+        lines = string.split("\n")
+        first_line = C.cyan(C.underline(lines[0]))
+        other_lines = C.cyan(lines[1..-1].join("\n"))
+        first_line + "\n" + other_lines
       end
 
       def self.text missing_provider_states

data/lib/pact/provider/rspec.rb

@@ -18,18 +18,18 @@ module Pact
 
         include ::RSpec::Core::DSL
 
-        def honour_pactfile pactfile_uri, options = {}
+        def honour_pactfile pact_uri, pact_json, options
           #TODO change puts to use output stream
-          puts "Reading pact at #{pactfile_uri}"
+          puts "Reading pact at #{pact_uri}"
           puts "Filtering interactions by: #{options[:criteria]}" if options[:criteria] && options[:criteria].any?
-          consumer_contract = Pact::ConsumerContract.from_json(read_pact_from(pactfile_uri, options))
-          ::RSpec.describe "Verifying a pact between #{consumer_contract.consumer.name} and #{consumer_contract.provider.name}", :pactfile_uri => pactfile_uri do
-            honour_consumer_contract consumer_contract, options
+          consumer_contract = Pact::ConsumerContract.from_json(pact_json)
+          ::RSpec.describe "Verifying a pact between #{consumer_contract.consumer.name} and #{consumer_contract.provider.name}", :pactfile_uri => pact_uri do
+            honour_consumer_contract consumer_contract, options.merge(pact_json: pact_json)
           end
         end
 
         def honour_consumer_contract consumer_contract, options = {}
-          describe_consumer_contract consumer_contract, options.merge({:consumer => consumer_contract.consumer.name})
+          describe_consumer_contract consumer_contract, options.merge(:consumer => consumer_contract.consumer.name)
         end
 
         private
@@ -63,7 +63,8 @@ module Pact
           metadata = {
             :pact => :verify,
             :pact_interaction => interaction,
-            :pact_interaction_example_description => interaction_description_for_rerun_command(interaction)
+            :pact_interaction_example_description => interaction_description_for_rerun_command(interaction),
+            :pact_json => options[:pact_json]
           }
 
           describe description_for(interaction), metadata do
@@ -148,10 +149,6 @@ module Pact
           description_for(interaction).capitalize + ( interaction.provider_state ? " given #{interaction.provider_state}" : "")
         end
 
-        def read_pact_from uri, options = {}
-          Pact::PactFile.read(uri, options)
-        end
-
       end
 
       # The "arrange" and "act" parts of the test really only need to be run once,

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

@@ -1,6 +1,7 @@
 require 'pact/provider/print_missing_provider_states'
 require 'rspec/core/formatters/documentation_formatter'
 require 'term/ansicolor'
+require 'pact/provider/help/prompt_text'
 
 module Pact
   module Provider
@@ -42,7 +43,7 @@ module Pact
           description = example.metadata[:pact_interaction].description
           pactfile_uri = example.metadata[:pactfile_uri]
           example_description = example.metadata[:pact_interaction_example_description]
-          failure_color("rake pact:verify:at[#{pactfile_uri}] PACT_DESCRIPTION=\"#{description}\" PACT_PROVIDER_STATE=\"#{provider_state}\"") + " " + detail_color("# #{example_description}")
+          failure_color("bundle exec rake pact:verify:at[#{pactfile_uri}] PACT_DESCRIPTION=\"#{description}\" PACT_PROVIDER_STATE=\"#{provider_state}\"") + " " + detail_color("# #{example_description}")
         end
 
         def print_failure_message
@@ -50,9 +51,7 @@ module Pact
         end
 
         def failure_message
-          "\n" +  C.underline(C.yellow("For assistance debugging failures, please note:")) + "\n\n" +
-          "The pact files have been stored locally in the following temp directory:\n #{Pact.configuration.tmp_dir}\n\n" +
-          "The requests and responses are logged in the following log file:\n #{Pact.configuration.log_path}\n\n"
+          "\n" + Pact::Provider::Help::PromptText.() + "\n"
         end
 
       end

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

@@ -1,6 +1,7 @@
 require 'pact/provider/print_missing_provider_states'
 require 'rspec/core/formatters'
 require 'term/ansicolor'
+require 'pact/provider/help/prompt_text'
 
 module Pact
   module Provider
@@ -25,11 +26,11 @@ module Pact
         private
 
         def interactions_count(summary)
-          summary.examples.collect{ |e|e.metadata[:pact_interaction_example_description]}.uniq.size
+          summary.examples.collect{ |e| e.metadata[:pact_interaction_example_description] }.uniq.size
         end
 
         def failed_interactions_count(summary)
-          summary.failed_examples.collect{ |e|e.metadata[:pact_interaction_example_description]}.uniq.size
+          summary.failed_examples.collect{ |e| e.metadata[:pact_interaction_example_description] }.uniq.size
         end
 
         def totals_line summary
@@ -39,11 +40,11 @@ module Pact
         end
 
         def colorized_totals_line(summary)
-          if summary.failure_count > 0
-            colorizer.wrap(totals_line(summary), ::RSpec.configuration.failure_color)
-          else
-            colorizer.wrap(totals_line(summary), ::RSpec.configuration.success_color)
-          end
+          colorizer.wrap(totals_line(summary), color_for_summary(summary))
+        end
+
+        def color_for_summary summary
+          summary.failure_count > 0 ? ::RSpec.configuration.failure_color : ::RSpec.configuration.success_color
         end
 
         def print_rerun_commands summary
@@ -68,7 +69,7 @@ module Pact
           description = example.metadata[:pact_interaction].description
           pactfile_uri = example.metadata[:pactfile_uri]
           example_description = example.metadata[:pact_interaction_example_description]
-          colorizer.wrap("rake pact:verify:at[#{pactfile_uri}] PACT_DESCRIPTION=\"#{description}\" PACT_PROVIDER_STATE=\"#{provider_state}\" ", ::RSpec.configuration.failure_color) +
+          colorizer.wrap("bundle exec rake pact:verify:at[#{pactfile_uri}] PACT_DESCRIPTION=\"#{description}\" PACT_PROVIDER_STATE=\"#{provider_state}\" ", ::RSpec.configuration.failure_color) +
             colorizer.wrap("# #{example_description}", ::RSpec.configuration.detail_color)
         end
 
@@ -77,9 +78,7 @@ module Pact
         end
 
         def failure_message
-          "\n" +  C.underline(C.yellow("For assistance debugging failures, please note:")) + "\n\n" +
-          "The pact files have been stored locally in the following temp directory:\n #{Pact.configuration.tmp_dir}\n\n" +
-          "The requests and responses are logged in the following log file:\n #{Pact.configuration.log_path}\n\n"
+          "\n" + Pact::Provider::Help::PromptText.() + "\n"
         end
 
         def colorizer

data/lib/pact/provider/world.rb

@@ -18,6 +18,18 @@ module Pact
         @provider_states_proxy ||= Pact::Provider::State::ProviderStateProxy.new
       end
 
+      def add_pact_verification verification
+        pact_verifications << verification
+      end
+
+      def pact_verifications
+        @pact_verifications ||= []
+      end
+
+      def pact_urls
+        pact_verifications.collect(&:uri)
+      end
+
     end
   end
 end

data/lib/pact/tasks/task_helper.rb

@@ -23,12 +23,16 @@ module Pact
       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")
-      (command_parts << "-p" << pact_uri) if pact_uri
+      command_parts << "--pact-helper" << (pact_helper.end_with?(".rb") ? pact_helper : pact_helper + ".rb")
+      (command_parts << "--pact-uri" << pact_uri) if pact_uri
+      command_parts << "--backtrace" if ENV['BACKTRACE'] == 'true'
+      command_parts << "--description #{Shellwords.escape(ENV['PACT_DESCRIPTION'])}" if ENV['PACT_DESCRIPTION']
+      command_parts << "--provider-state #{Shellwords.escape(ENV['PACT_PROVIDER_STATE'])}" if ENV['PACT_PROVIDER_STATE']
       command_parts.flatten.join(" ")
     end
 
     def execute_cmd command
+      $stdout.puts command
       system(command) ? 0 : 1
     end
 

data/lib/pact/templates/help.erb

@@ -0,0 +1,22 @@
+# For assistance debugging failures
+
+* The pact files have been stored locally in the following temp directory:
+    <%= temp_dir %>
+
+* The requests and responses are logged in the following log file:
+    <%= log_path %>
+
+* Add BACKTRACE=true to the `rake pact:verify` command to see the full backtrace
+
+* If the diff output is confusing, try using another diff formatter.
+  The options are :unix, :embedded and :list
+
+    Pact.configure do | config |
+      config.diff_formatter = :embedded
+    end
+
+  See https://github.com/realestate-com-au/pact/blob/master/documentation/configuration.md#diff_formatter for examples and more information.
+
+* Check out https://github.com/realestate-com-au/pact/wiki/Troubleshooting
+
+* Ask a question in the google users' group https://groups.google.com/forum/#!forum/pact-support

data/lib/pact/version.rb

@@ -1,3 +1,3 @@
 module Pact
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/lib/tasks/pact.rake

@@ -26,4 +26,10 @@ namespace :pact do
     end
   end
 
+  desc "Get help debugging pact:verify failures."
+  task 'verify:help', :reports_dir do | t, args |
+    require 'pact/provider/help/console_text'
+    puts Pact::Provider::Help::ConsoleText.(args[:reports_dir])
+  end
+
 end

data/pact.gemspec

@@ -28,8 +28,8 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'webrick'
   gem.add_runtime_dependency 'term-ansicolor', '~> 1.0'
 
-  gem.add_runtime_dependency 'pact-support', '~> 0.1.2'
-  gem.add_runtime_dependency 'pact-mock_service', '~> 0.2.0'
+  gem.add_runtime_dependency 'pact-support', '~> 0.2.1'
+  gem.add_runtime_dependency 'pact-mock_service', '~> 0.2.3'
 
   gem.add_development_dependency 'rake', '~> 10.0.3'
   gem.add_development_dependency 'webmock', '~> 1.18.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-25 00:00:00.000000000 Z
+date: 2015-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: randexp
@@ -166,7 +166,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -174,7 +174,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: pact-mock_service
   requirement: !ruby/object:Gem::Requirement
@@ -182,7 +182,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -190,7 +190,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -338,6 +338,8 @@ files:
 - bin/pact
 - lib/pact.rb
 - lib/pact/cli.rb
+- lib/pact/cli/run_pact_verification.rb
+- lib/pact/cli/spec_criteria.rb
 - lib/pact/consumer.rb
 - lib/pact/consumer/configuration.rb
 - lib/pact/consumer/configuration/configuration_extensions.rb
@@ -370,8 +372,14 @@ files:
 - lib/pact/provider/configuration/service_provider_config.rb
 - lib/pact/provider/configuration/service_provider_dsl.rb
 - lib/pact/provider/context.rb
+- lib/pact/provider/help/console_text.rb
+- lib/pact/provider/help/content.rb
+- lib/pact/provider/help/pact_diff.rb
+- lib/pact/provider/help/prompt_text.rb
+- lib/pact/provider/help/write.rb
 - lib/pact/provider/matchers/messages.rb
 - lib/pact/provider/pact_helper_locator.rb
+- lib/pact/provider/pact_source.rb
 - lib/pact/provider/pact_spec_runner.rb
 - lib/pact/provider/pact_verification.rb
 - lib/pact/provider/print_missing_provider_states.rb
@@ -392,6 +400,7 @@ files:
 - lib/pact/tasks.rb
 - lib/pact/tasks/task_helper.rb
 - lib/pact/tasks/verification_task.rb
+- lib/pact/templates/help.erb
 - lib/pact/templates/provider_state.erb
 - lib/pact/version.rb
 - lib/tasks/pact.rake
@@ -411,7 +420,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2181790472220138069
+      hash: -4361813118953471608
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -420,7 +429,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2181790472220138069
+      hash: -4361813118953471608
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23