pact 0.1.28 → 1.3.3

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

@@ -0,0 +1,59 @@
+require 'pact/provider/configuration/pact_verification'
+require 'pact/provider/configuration/service_provider_config'
+
+module Pact
+
+  module Provider
+
+    module Configuration
+
+      class ServiceProviderDSL
+
+        extend Pact::DSL
+
+        attr_accessor :name, :app_block
+
+        CONFIG_RU_APP = lambda {
+          unless File.exist? Pact.configuration.config_ru_path
+            raise "Could not find config.ru file at #{Pact.configuration.config_ru_path} Please configure the service provider app or create a config.ru file in the root directory of the project. See https://github.com/realestate-com-au/pact/blob/master/documentation/verifying-pacts.md for more information."
+          end
+          Rack::Builder.parse_file(Pact.configuration.config_ru_path).first
+        }
+
+        def initialize name
+          @name = name
+          @app_block = CONFIG_RU_APP
+        end
+
+        dsl do
+          def app &block
+            self.app_block = block
+          end
+
+          def honours_pact_with consumer_name, options = {}, &block
+            create_pact_verification consumer_name, options, &block
+          end
+        end
+
+        def create_pact_verification consumer_name, options, &block
+          PactVerification.build(consumer_name, options, &block)
+        end
+
+        def finalize
+          validate
+          create_service_provider
+        end
+
+        private
+
+        def validate
+          raise "Please provide a name for the Provider" unless name && !name.strip.empty?
+        end
+
+        def create_service_provider
+          Pact.configuration.provider = ServiceProviderConfig.new(&@app_block)
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider/configuration.rb

@@ -0,0 +1,7 @@
+require 'pact/provider/configuration/dsl'
+require 'pact/provider/configuration/configuration_extension'
+require 'pact/provider/state/provider_state'
+
+Pact.send(:extend, Pact::Provider::DSL)
+Pact.send(:extend, Pact::Provider::State::DSL)
+Pact::Configuration.send(:include, Pact::Provider::Configuration::ConfigurationExtension)

data/lib/pact/provider/matchers/messages.rb

@@ -0,0 +1,45 @@
+require 'term/ansicolor'
+require 'pact/term'
+
+module Pact
+  module Matchers
+    module Messages
+
+      def match_term_failure_message diff, actual, diff_formatter, color_enabled
+        message = "Actual: #{(String === actual ? actual : actual.to_json)}\n\n"
+        formatted_diff = diff_formatter.call(diff)
+        message + colorize_if_enabled(formatted_diff, color_enabled)
+      end
+
+      def match_header_failure_message header_name, expected, actual
+        "Expected header \"#{header_name}\" to #{expected_desc(expected)}, but was #{actual_desc(actual)}"
+      end
+
+      private
+
+      def colorize_if_enabled formatted_diff, color_enabled
+        if color_enabled
+          # RSpec wraps each line in the failure message with failure_color, turning it red.
+          # To ensure the lines in the diff that should be white, stay white, put an
+          # ANSI reset at the start of each line.
+          formatted_diff.split("\n").collect{ |line| ::Term::ANSIColor.reset + line }.join("\n")
+        else
+          formatted_diff
+        end
+      end
+
+      def expected_desc expected
+        case expected
+        when NilClass then "be nil"
+        else
+          "match #{expected.inspect}"
+        end
+      end
+
+      def actual_desc actual
+        actual.nil? ? 'nil' : '"' + actual + '"'
+      end
+
+    end
+  end
+end

data/lib/pact/provider/pact_helper_locator.rb

@@ -0,0 +1,22 @@
+module Pact
+  module Provider
+    module PactHelperLocater
+        PACT_HELPER_FILE_PATTERNS = [
+        "spec/**/*service*consumer*/pact_helper.rb",
+        "spec/**/*consumer*/pact_helper.rb",
+        "spec/**/pact_helper.rb",
+        "**/pact_helper.rb"]
+
+        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.pact_helper_path
+          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?
+          File.join(Dir.pwd, pact_helper_search_results[0])
+        end
+
+    end
+  end
+end
+

data/lib/pact/provider/pact_spec_runner.rb

@@ -0,0 +1,123 @@
+require 'open-uri'
+require 'rspec'
+require 'rspec/core'
+require 'rspec/core/formatters/documentation_formatter'
+require 'pact/provider/pact_helper_locator'
+require 'pact/project_root'
+require 'pact/rspec'
+
+require_relative 'rspec'
+
+
+module Pact
+  module Provider
+    class PactSpecRunner
+
+      include Pact::Provider::RSpec::ClassMethods
+
+      attr_reader :spec_definitions
+      attr_reader :options
+      attr_reader :output
+
+      def initialize spec_definitions, options = {}
+        @spec_definitions = spec_definitions
+        @options = options
+        @results = nil
+      end
+
+      def run
+        begin
+          configure_rspec
+          initialize_specs
+          run_specs
+        ensure
+          ::RSpec.reset
+          Pact.clear_provider_world
+        end
+      end
+
+      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
+
+        config = ::RSpec.configuration
+
+        config.color = true
+        config.pattern = "pattern which doesn't match any files"
+        config.backtrace_inclusion_patterns = [Regexp.new(Dir.getwd), /pact.*main/]
+
+        config.extend Pact::Provider::RSpec::ClassMethods
+        config.include Pact::Provider::RSpec::InstanceMethods
+        config.include Pact::Provider::TestMethods
+
+        if options[:silent]
+          config.output_stream = StringIO.new
+          config.error_stream = StringIO.new
+        else
+          config.error_stream = Pact.configuration.error_stream
+          config.output_stream = Pact.configuration.output_stream
+        end
+
+        # 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
+          # before :each and after :each hooks.
+          # Otherwise the app and all its dependencies are loaded between the first before :each
+          # and the first after :each, leading to inconsistent behaviour
+          # (eg. with database_cleaner transactions)
+          Pact.configuration.provider.app
+        end
+
+      end
+
+      def run_specs
+        exit_code = if Pact::RSpec.runner_defined?
+          ::RSpec::Core::Runner.run(rspec_runner_options)
+        else
+          ::RSpec::Core::CommandLine.new(NoConfigurationOptions.new)
+            .run(::RSpec.configuration.output_stream, ::RSpec.configuration.error_stream)
+        end
+        exit_code
+      end
+
+      def rspec_runner_options
+        ["--options", Pact.project_root.join("lib/pact/provider/rspec/custom_options_file").to_s]
+      end
+
+      def monkey_patch_backtrace_formatter
+        Pact::RSpec.with_rspec_3 do
+          require 'pact/provider/rspec/backtrace_formatter'
+        end
+      end
+
+      def class_exists? name
+        Kernel.const_get name
+      rescue NameError
+        false
+      end
+
+      class NoConfigurationOptions
+        def method_missing(method, *args, &block)
+          # Do nothing!
+        end
+      end
+
+    end
+  end
+end

data/lib/pact/provider/pact_verification.rb

@@ -0,0 +1,17 @@
+module Pact::Provider
+   class PactVerification
+      attr_reader :consumer_name, :uri, :ref
+      def initialize consumer_name, uri, ref
+         @consumer_name = consumer_name
+         @uri = uri
+         @ref = ref
+      end
+
+      def == other
+        other.is_a?(PactVerification) &&
+          consumer_name == other.consumer_name &&
+          uri == other.uri &&
+          ref == other.ref
+      end
+   end
+end

data/lib/pact/provider/print_missing_provider_states.rb

@@ -0,0 +1,30 @@
+module Pact
+  module Provider
+    class PrintMissingProviderStates
+
+      # 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))
+        end
+      end
+
+      def self.orangeify string
+        "\e[33m#{string}\e[m"
+      end
+
+      def self.text missing_provider_states
+        create_provider_states_for(missing_provider_states)
+      end
+
+      def self.create_provider_states_for consumers
+        ERB.new(template_string).result(binding)
+      end
+
+      def self.template_string
+        File.read(File.expand_path( '../../templates/provider_state.erb', __FILE__))
+      end
+
+    end
+  end
+end

data/lib/pact/provider/request.rb

@@ -0,0 +1,70 @@
+require 'json'
+require 'pact/reification'
+require 'pact/shared/null_expectation'
+
+module Pact
+  module Provider
+    module Request
+      class Replayable
+
+        # See https://github.com/rack/rack/blob/e7d741c6282ca4cf4e01506f5681e6e6b14c0b32/SPEC#L87-89
+        NO_HTTP_PREFIX = ["CONTENT-TYPE", "CONTENT-LENGTH"]
+
+        def initialize expected_request
+          @expected_request = expected_request
+        end
+
+        def method
+          expected_request.method
+        end
+
+        def path
+          expected_request.full_path
+        end
+
+        def body
+          case expected_request.body
+          when String then expected_request.body
+          when NullExpectation then ''
+          else
+            reified_body
+          end
+        end
+
+        def headers
+          request_headers = {}
+          return request_headers if expected_request.headers.is_a?(Pact::NullExpectation)
+          expected_request.headers.each do |key, value|
+            request_headers[rack_request_header_for(key)] = value
+          end
+          request_headers
+        end
+
+        private
+        attr_reader :expected_request
+
+        def reified_body
+          rb = Pact::Reification.from_term(expected_request.body)
+          if rb.is_a?(String)
+            rb
+          else
+            JSON.dump(rb)
+          end
+        end
+
+        def rack_request_header_for header
+          with_http_prefix(header.to_s.upcase).gsub('-', '_')
+        end
+
+        def rack_request_value_for value
+          Array(value).join("\n")
+        end
+
+        def with_http_prefix header
+          NO_HTTP_PREFIX.include?(header) ? header : "HTTP_#{header}"
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module RSpec
+  module Core
+
+    # RSpec 3 has a hardwired @system_exclusion_patterns which removes everything matching /bin\//
+    # This causes *all* the backtrace lines to be cleaned, as rake pact:verify now shells out
+    # to the executable `pact verify ...`
+    # which then causes *all* the lines to be included as the BacktraceFormatter will
+    # include all lines of the backtrace if all lines were filtered out.
+    # This monkey patch only shows lines including bin/pact and removes the
+    # "show all lines if no lines would otherwise be shown" logic.
+
+    class BacktraceFormatter
+
+
+      def format_backtrace(backtrace, options = {})
+        return backtrace if options[:full_backtrace]
+        backtrace.map { |l| backtrace_line(l) }.compact
+      end
+
+      def backtrace_line(line)
+        relative_path(line) unless exclude?(line)
+      rescue SecurityError
+        nil
+      end
+
+      def exclude?(line)
+        return false if @full_backtrace
+        relative_line = relative_path(line)
+        return true unless /bin\/pact/ =~ relative_line
+      end
+
+      # Copied from Metadata so a refactor can't break this overridden class
+      def relative_path(line)
+        line = line.sub(File.expand_path("."), ".")
+        line = line.sub(/\A([^:]+:\d+)$/, '\\1')
+        return nil if line == '-e:1'
+        line
+      rescue SecurityError
+        nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+require 'pact/provider/print_missing_provider_states'
+require 'rspec/core/formatters/documentation_formatter'
+require 'term/ansicolor'
+
+module Pact
+  module Provider
+    module RSpec
+      class Formatter2 < ::RSpec::Core::Formatters::DocumentationFormatter
+
+        C = ::Term::ANSIColor
+
+        def dump_commands_to_rerun_failed_examples
+          return if failed_examples.empty?
+
+          print_rerun_commands
+          print_failure_message
+          print_missing_provider_states
+
+        end
+
+        private
+
+        def print_rerun_commands
+          output.puts("\n")
+          interaction_rerun_commands.each do | message |
+            output.puts(message)
+          end
+        end
+
+        def print_missing_provider_states
+          PrintMissingProviderStates.call Pact.provider_world.provider_states.missing_provider_states, output
+        end
+
+        def interaction_rerun_commands
+          failed_examples.collect do |example|
+            interaction_rerun_command_for example
+          end.uniq
+        end
+
+        def interaction_rerun_command_for example
+          provider_state = example.metadata[:pact_interaction].provider_state
+          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}")
+        end
+
+        def print_failure_message
+          output.puts failure_message
+        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"
+        end
+
+      end
+
+    end
+
+  end
+end
+
+

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

@@ -0,0 +1,96 @@
+require 'pact/provider/print_missing_provider_states'
+require 'rspec/core/formatters'
+require 'term/ansicolor'
+
+module Pact
+  module Provider
+    module RSpec
+      class Formatter < ::RSpec::Core::Formatters::DocumentationFormatter
+
+        Pact::RSpec.with_rspec_3 do
+          ::RSpec::Core::Formatters.register self, :example_group_started, :example_group_finished,
+                                    :example_passed, :example_pending, :example_failed
+        end
+
+        C = ::Term::ANSIColor
+
+        def dump_summary(summary)
+          output.puts "\n" + colorized_totals_line(summary)
+          return if summary.failure_count == 0
+          print_rerun_commands summary
+          print_failure_message
+          print_missing_provider_states
+        end
+
+        private
+
+        def interactions_count(summary)
+          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
+        end
+
+        def totals_line summary
+          line = ::RSpec::Core::Formatters::Helpers.pluralize(interactions_count(summary), "interaction")
+          line << ", " << ::RSpec::Core::Formatters::Helpers.pluralize(failed_interactions_count(summary), "failure")
+          line
+        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
+        end
+
+        def print_rerun_commands summary
+          output.puts("\nFailed interactions:\n\n")
+          interaction_rerun_commands(summary).each do | message |
+            output.puts(message)
+          end
+        end
+
+        def print_missing_provider_states
+          PrintMissingProviderStates.call Pact.provider_world.provider_states.missing_provider_states, output
+        end
+
+        def interaction_rerun_commands summary
+          summary.failed_examples.collect do |example|
+            interaction_rerun_command_for example
+          end.uniq
+        end
+
+        def interaction_rerun_command_for example
+          provider_state = example.metadata[:pact_interaction].provider_state
+          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("# #{example_description}", ::RSpec.configuration.detail_color)
+        end
+
+        def print_failure_message
+          output.puts failure_message
+        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"
+        end
+
+        def colorizer
+          @colorizer ||= ::RSpec::Core::Formatters::ConsoleCodes
+        end
+
+      end
+
+    end
+
+  end
+end
+
+

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

@@ -0,0 +1,97 @@
+require 'rspec'
+require 'pact/matchers'
+require 'pact/provider/matchers/messages'
+require 'pact/rspec'
+require 'pact/shared/json_differ'
+
+
+module Pact
+  module RSpec
+    module Matchers
+
+      module RSpec2Delegator
+        # For backwards compatiblity with rspec-2
+        def method_missing(method, *args, &block)
+          if method_name == :failure_message_for_should
+            failure_message method, *args, &block
+          else
+            super
+          end
+        end
+      end
+
+      class MatchTerm
+
+        include Pact::Matchers::Messages
+        include RSpec2Delegator
+
+        def initialize expected, differ, diff_formatter
+          @expected = expected
+          @differ = differ
+          @diff_formatter = diff_formatter
+        end
+
+        def matches? actual
+          @actual = actual
+          (@difference = @differ.call(@expected, @actual)).empty?
+        end
+
+        def failure_message
+          match_term_failure_message @difference, @actual, @diff_formatter, Pact::RSpec.color_enabled?
+        end
+
+      end
+
+      def match_term expected, options
+        MatchTerm.new(expected, options.fetch(:with), options.fetch(:diff_formatter))
+      end
+
+      class MatchHeader
+
+        include Pact::Matchers
+        include Pact::Matchers::Messages
+        include RSpec2Delegator
+
+        def initialize header_name, expected
+          @header_name = header_name
+          @expected = expected
+        end
+
+        def matches? actual
+          @actual = actual
+          diff(@expected, @actual).empty?
+        end
+
+        def failure_message
+          match_header_failure_message @header_name, @expected, @actual
+        end
+
+      end
+
+      def match_header header_name, expected
+        MatchHeader.new(header_name, expected)
+      end
+
+    end
+  end
+end
+
+
+# RSpec::Matchers.define :match_header do |header_name, expected|
+
+#   include Pact::Matchers
+#   include Pact::Matchers::Messages
+
+#   match do |actual|
+#     diff(expected, actual).empty?
+#   end
+
+#   def failure_message_for_should(actual)
+#     match_header_failure_message header_name, expected, actual
+#   end
+
+#   # failure_message_for_should do | actual |
+#   #   match_header_failure_message header_name, expected, actual
+#   # end
+
+# end