pact 1.57.0 → 1.66.1

data/lib/pact/provider/pact_spec_runner.rb

@@ -12,6 +12,7 @@ require 'pact/provider/rspec/pact_broker_formatter'
 require 'pact/provider/rspec/json_formatter'
 require 'pact/provider/rspec'
 require 'pact/provider/rspec/calculate_exit_code'
+require 'pact/utils/metrics'
 
 module Pact
   module Provider
@@ -130,6 +131,8 @@ module Pact
             ignore_failures: options[:ignore_failures],
             request_customizer: options[:request_customizer]
           }
+          Pact::Utils::Metrics.report_metric("Pacts verified", "ProviderTest", "Completed")
+
           honour_pactfile pact_source, ordered_pact_json(pact_source.pact_json), spec_options
         end
       end

data/lib/pact/provider/pact_uri.rb

@@ -3,7 +3,7 @@ module Pact
     class PactURI
       attr_reader :uri, :options, :metadata
 
-      def initialize (uri, options = nil, metadata = nil)
+      def initialize(uri, options = nil, metadata = nil)
         @uri = uri
         @options = options || {}
         @metadata = metadata || {} # make sure it's not nil if nil is passed in
@@ -30,7 +30,11 @@ module Pact
 
       def to_s
         if basic_auth? && http_or_https_uri?
-          URI(@uri).tap { |x| x.userinfo="#{username}:*****"}.to_s
+          begin
+            URI(@uri).tap { |x| x.userinfo="#{username}:*****"}.to_s
+          rescue URI::InvalidComponentError
+            URI(@uri).tap { |x| x.userinfo="*****:*****"}.to_s
+          end
         elsif personal_access_token? && http_or_https_uri?
           URI(@uri).tap { |x| x.userinfo="*****"}.to_s
         else
@@ -45,7 +49,7 @@ module Pact
       private def http_or_https_uri?
         uri.start_with?('http://', 'https://')
       end
-      
+
     end
   end
 end

data/lib/pact/provider/print_missing_provider_states.rb

@@ -1,11 +1,9 @@
-require 'term/ansicolor'
+require 'rainbow'
 
 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?
@@ -15,8 +13,8 @@ module Pact
 
       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 = Rainbow(lines[0]).cyan.underline
+        other_lines = Rainbow(lines[1..-1].join("\n")).cyan
         first_line + "\n" + other_lines
       end
 

data/lib/pact/provider/request.rb

@@ -1,6 +1,7 @@
 require 'json'
 require 'pact/reification'
 require 'pact/shared/null_expectation'
+require 'pact/generators'
 
 module Pact
   module Provider
@@ -10,8 +11,9 @@ module Pact
         # See https://github.com/rack/rack/blob/e7d741c6282ca4cf4e01506f5681e6e6b14c0b32/SPEC#L87-89
         NO_HTTP_PREFIX = ["CONTENT-TYPE", "CONTENT-LENGTH"]
 
-        def initialize expected_request
+        def initialize expected_request, state_params = nil
           @expected_request = expected_request
+          @state_params = state_params
         end
 
         def method
@@ -19,7 +21,7 @@ module Pact
         end
 
         def path
-          expected_request.full_path
+          Pact::Generators.apply_generators(expected_request, "path", expected_request.full_path, @state_params)
         end
 
         def body
@@ -27,17 +29,22 @@ module Pact
           when String then expected_request.body
           when NullExpectation then ''
           else
-            reified_body
+            Pact::Generators.apply_generators(expected_request, "body", reified_body, @state_params)
           end
         end
 
         def headers
           request_headers = {}
+          # https://github.com/pact-foundation/pact-ruby/pull/327
+          request_headers.merge!('HOST' => 'localhost') if defined?(Sinatra)
           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)] = Pact::Reification.from_term(value)
+            request_headers[key] = Pact::Reification.from_term(value)
           end
-          request_headers
+
+          request_headers = Pact::Generators.apply_generators(expected_request, "header", request_headers, @state_params)
+          request_headers.map{ |key,value| [rack_request_header_for(key), value]}.to_h
         end
 
         private

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

@@ -1,6 +1,6 @@
 require 'pact/provider/print_missing_provider_states'
 require 'rspec/core/formatters/documentation_formatter'
-require 'term/ansicolor'
+require 'rainbow'
 require 'pact/provider/help/prompt_text'
 
 module Pact
@@ -13,8 +13,6 @@ module Pact
           end
         end
 
-        C = ::Term::ANSIColor
-
         def dump_commands_to_rerun_failed_examples
           return if failed_examples.empty?
 

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

@@ -1,6 +1,6 @@
 require 'pact/provider/print_missing_provider_states'
 require 'rspec/core/formatters'
-require 'term/ansicolor'
+require 'rainbow'
 require 'pact/provider/help/prompt_text'
 
 module Pact
@@ -22,8 +22,6 @@ module Pact
                                     :example_passed, :example_pending, :example_failed
         end
 
-        C = ::Term::ANSIColor
-
         def example_group_started(notification)
           # This is the metadata on the top level "Verifying a pact between X and Y" describe block
           if @group_level == 0

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

@@ -1,6 +1,6 @@
 require 'rspec/core/formatters'
 require 'pact/provider/verification_results/publish_all'
-require 'term/ansicolor'
+require 'rainbow'
 require 'pact/matchers/extract_diff_messages'
 
 module Pact
@@ -43,7 +43,7 @@ module Pact
             if example.exception
               hash[:exception] =  {
                 class: example.exception.class.name,
-                message: ::Term::ANSIColor.uncolor(example.exception.message)
+                message: "\e[0m#{example.exception.message}"
               }
             end
 

data/lib/pact/provider/rspec.rb

@@ -25,6 +25,7 @@ module Pact
           pact_uri = pact_source.uri
           Pact.configuration.output_stream.puts "INFO: Reading pact at #{pact_uri}"
           consumer_contract = Pact::ConsumerContract.from_json(pact_json)
+
           suffix = pact_uri.metadata[:pending] ? " [PENDING]": ""
           example_group_description = "Verifying a pact between #{consumer_contract.consumer.name} and #{consumer_contract.provider.name}#{suffix}"
           example_group_metadata = { pactfile_uri: pact_uri, pact_criteria: options[:criteria] }
@@ -77,7 +78,6 @@ module Pact
         end
 
         def describe_interaction interaction, options
-
           # pact_uri and pact_interaction are used by
           # Pact::Provider::RSpec::PactBrokerFormatter
 
@@ -103,8 +103,9 @@ module Pact
             before do | example |
               interaction_context.run_once :before do
                 Pact.configuration.logger.info "Running example '#{Pact::RSpec.full_description(example)}'"
-                set_up_provider_states interaction.provider_states, options[:consumer]
-                replay_interaction interaction, options[:request_customizer]
+                provider_states_result = set_up_provider_states interaction.provider_states, options[:consumer]
+                state_params = provider_states_result[interaction.provider_state];
+                replay_interaction interaction, options[:request_customizer], state_params
                 interaction_context.last_response = last_response
               end
             end
@@ -129,6 +130,7 @@ module Pact
           include Pact::RSpec::Matchers
           extend Pact::Matchers::Messages
 
+
           let(:expected_contents) { expected_response.body[:contents].as_json }
           let(:response) { interaction_context.last_response }
           let(:differ) { Pact.configuration.body_differ_for_content_type diff_content_type }

data/lib/pact/provider/state/provider_state.rb

@@ -12,11 +12,11 @@ module Pact
       end
 
       def set_up &block
-        ProviderStates.base_provider_state.register.register_set_up &block
+        ProviderStates.base_provider_state.register.register_set_up(&block)
       end
 
       def tear_down &block
-        ProviderStates.base_provider_state.register_tear_down &block
+        ProviderStates.base_provider_state.register_tear_down(&block)
       end
 
       def provider_states_for name, &block
@@ -60,7 +60,7 @@ module Pact
       end
 
       def self.namespaced_name name, options = {}
-        fullname = options[:for] ? "#{options[:for]}.#{name}" : name
+        options[:for] ? "#{options[:for]}.#{name}" : name
       end
     end
 
@@ -81,11 +81,11 @@ module Pact
 
       dsl do
         def set_up &block
-          self.register_set_up &block
+          self.register_set_up(&block)
         end
 
         def tear_down &block
-          self.register_tear_down &block
+          self.register_tear_down(&block)
         end
 
         def no_op

data/lib/pact/provider/test_methods.rb

@@ -14,8 +14,8 @@ module Pact
       include Pact::Logging
       include Rack::Test::Methods
 
-      def replay_interaction interaction, request_customizer = nil
-        request = Request::Replayable.new(interaction.request)
+      def replay_interaction interaction, request_customizer = nil, state_params = nil
+        request = Request::Replayable.new(interaction.request, state_params)
         request = request_customizer.call(request, interaction) if request_customizer
         args = [request.path, request.body, request.headers]
 
@@ -42,11 +42,17 @@ module Pact
       end
 
       def set_up_provider_states provider_states, consumer, options = {}
+        provider_states_result = {};
         # If there are no provider state, execute with an nil state to ensure global and base states are executed
         Pact.configuration.provider_state_set_up.call(nil, consumer, options) if provider_states.nil? || provider_states.empty?
         provider_states.each do | provider_state |
-          Pact.configuration.provider_state_set_up.call(provider_state.name, consumer, options.merge(params: provider_state.params))
+          result = Pact.configuration.provider_state_set_up.call(provider_state.name, consumer, options.merge(params: provider_state.params))
+          if result.is_a?(Hash)
+            provider_states_result[provider_state.name] = result
+          end
         end
+
+        provider_states_result
       end
 
       def tear_down_provider_states provider_states, consumer, options = {}

data/lib/pact/provider/verification_results/create.rb

@@ -14,7 +14,13 @@ module Pact
         end
 
         def call
-          VerificationResult.new(publishable?, !any_failures?, Pact.configuration.provider.application_version, test_results_hash_for_pact_uri)
+          VerificationResult.new(
+            publishable?,
+            !any_failures?,
+            Pact.configuration.provider.application_version,
+            test_results_hash_for_pact_uri,
+            Pact.configuration.provider.build_url
+          )
         end
 
         private

data/lib/pact/provider/verification_results/publish.rb

@@ -16,6 +16,7 @@ module Pact
         PUBLISH_RELATION = 'pb:publish-verification-results'.freeze
         PROVIDER_RELATION = 'pb:provider'.freeze
         VERSION_TAG_RELATION = 'pb:version-tag'.freeze
+        BRANCH_VERSION_RELATION = 'pb:branch-version'.freeze
 
         def self.call pact_source, verification_result, options = {}
           new(pact_source, verification_result, options).call
@@ -31,6 +32,7 @@ module Pact
 
         def call
           if can_publish_verification_results?
+            create_branch_version_if_configured
             tag_versions_if_configured
             publish_verification_results
             true
@@ -72,8 +74,28 @@ module Pact
           end
         end
 
+        def create_branch_version_if_configured
+          if Pact.configuration.provider.branch
+            branch_version_link = provider_entity._link(BRANCH_VERSION_RELATION)
+            if branch_version_link
+              version_number = Pact.configuration.provider.application_version
+              branch = Pact.configuration.provider.branch
+
+              Pact.configuration.output_stream.puts "INFO: Creating #{provider_name} version #{version_number} with branch \"#{branch}\""
+              branch_entity = branch_version_link.expand(
+                version: version_number,
+                branch: branch
+              ).put
+              unless branch_entity.success?
+                raise PublicationError.new("Error returned from tagging request: status=#{branch_entity.response.code} body=#{branch_entity.response.body}")
+              end
+            else
+              raise PublicationError.new("This version of the Pact Broker does not support version branches. Please update to version 2.58.0 or later.")
+            end
+          end
+        end
+
         def tag_versions
-          provider_entity = pact_entity.get(PROVIDER_RELATION)
           tag_link = provider_entity._link(VERSION_TAG_RELATION) || hacky_tag_url(provider_entity)
           provider_application_version = Pact.configuration.provider.application_version
 
@@ -111,6 +133,10 @@ module Pact
         def provider_name
           pact_source.pact_hash['provider']['name']
         end
+
+        def provider_entity
+          @provider_entity ||= pact_entity.get!(PROVIDER_RELATION)
+        end
       end
     end
   end

data/lib/pact/provider/verification_results/verification_result.rb

@@ -6,11 +6,12 @@ module Pact
       class VerificationResult
         attr_reader :success, :provider_application_version, :test_results_hash
 
-        def initialize publishable, success, provider_application_version, test_results_hash
+        def initialize publishable, success, provider_application_version, test_results_hash, build_url
           @publishable = publishable
           @success = success
           @provider_application_version = provider_application_version
           @test_results_hash = test_results_hash
+          @build_url = build_url
         end
 
         def publishable?
@@ -25,7 +26,8 @@ module Pact
           {
             success: success,
             providerApplicationVersion: provider_application_version,
-            testResults: test_results_hash
+            testResults: test_results_hash,
+            buildUrl: @build_url
           }.to_json(options)
         end
 

data/lib/pact/utils/metrics.rb

@@ -0,0 +1,100 @@
+require 'securerandom'
+require 'digest'
+require 'socket'
+require 'pact/version'
+require 'net/http'
+
+module Pact
+  module Utils
+    class Metrics
+
+      def self.report_metric(event, category, action, value = 1)
+        do_once_per_thread(:pact_metrics_message_shown) do
+          if track_events?
+            Pact.configuration.output_stream.puts "pact WARN: Please note: we are tracking events anonymously to gather important usage statistics like Pact-Ruby version
+              and operating system. To disable tracking, set the 'PACT_DO_NOT_TRACK' environment
+              variable to 'true'."
+          end
+        end
+
+        in_thread do
+          begin
+            if track_events?
+              uri = URI('https://www.google-analytics.com/collect')
+              req = Net::HTTP::Post.new(uri)
+              req.set_form_data(create_tracking_event(event, category, action, value))
+
+              Net::HTTP.start(uri.hostname, uri.port, read_timeout:2, open_timeout:2, :use_ssl => true  ) do |http|
+                http.request(req)
+              end
+            end
+          rescue StandardError => e
+            handle_error(e)
+          end
+        end
+      end
+
+      private
+
+      def self.handle_error e
+        if ENV['PACT_METRICS_DEBUG'] == 'true'
+          Pact.configuration.output_stream.puts("DEBUG: #{e.inspect}\n" + e.backtrace.join("\n"))
+        end
+      end
+
+      def self.in_thread
+        Thread.new do
+          yield
+        end
+      end
+
+      # not super safe to use the thread, but it's good enough for this usecase
+      def self.do_once_per_thread(key)
+        result = nil
+        if !Thread.current[key]
+          result = yield
+        end
+        Thread.current[key] = true
+        result
+      end
+
+      def self.create_tracking_event(event, category, action, value)
+        {
+          "v" => 1,
+          "t" => "event",
+          "tid" => "UA-117778936-1",
+          "cid" => calculate_cid,
+          "an" => "Pact Ruby",
+          "av" => Pact::VERSION,
+          "aid" => "pact-ruby",
+          "aip" => 1,
+          "ds" => ENV['PACT_EXECUTING_LANGUAGE'] ? "client" : "cli",
+          "cd2" => ENV['CI'] == "true" ? "CI" : "unknown",
+          "cd3" => RUBY_PLATFORM,
+          "cd6" => ENV['PACT_EXECUTING_LANGUAGE'] || "unknown",
+          "cd7" => ENV['PACT_EXECUTING_LANGUAGE_VERSION'],
+          "el" => event,
+          "ec" => category,
+          "ea" => action,
+          "ev" => value
+        }
+      end
+
+      def self.track_events?
+        ENV['PACT_DO_NOT_TRACK'] != 'true'
+      end
+
+      def self.calculate_cid
+        if RUBY_PLATFORM.include? "windows"
+          hostname = ENV['COMPUTERNAME']
+        else
+          hostname = ENV['HOSTNAME']
+        end
+        if !hostname
+          hostname = Socket.gethostname
+        end
+        Digest::MD5.hexdigest hostname || SecureRandom.urlsafe_base64(5)
+      end
+    end
+  end
+end

data/lib/pact/version.rb

@@ -1,4 +1,4 @@
 # Remember to bump pact-provider-proxy when this changes major version
 module Pact
-  VERSION = "1.57.0"
+  VERSION = "1.66.1"
 end

data/lib/tasks/pact.rake

@@ -15,12 +15,12 @@ namespace :pact do
 
   desc "Verifies the pact at the given URI against this service provider."
   task 'verify:at', :pact_uri do | t, args |
-    require 'term/ansicolor'
+    require 'rainbow'
     require 'pact/tasks/task_helper'
 
     include Pact::TaskHelper
 
-    abort(::Term::ANSIColor.red("Please provide a pact URI. eg. rake pact:verify:at[../my-consumer/spec/pacts/my_consumer-my_provider.json]")) unless args[:pact_uri]
+    abort(Rainbow("Please provide a pact URI. eg. rake pact:verify:at[../my-consumer/spec/pacts/my_consumer-my_provider.json]").red) unless args[:pact_uri]
     handle_verification_failure do
       execute_pact_verify args[:pact_uri]
     end

data/pact.gemspec

@@ -27,22 +27,25 @@ Gem::Specification.new do |gem|
   }
 
   gem.add_runtime_dependency 'rspec', '~> 3.0'
-  gem.add_runtime_dependency 'rack-test', '>= 0.6.3', '< 2.0.0'
+  gem.add_runtime_dependency 'rack-test', '>= 0.6.3', '< 3.0.0'
   gem.add_runtime_dependency 'thor', '>= 0.20', '< 2.0'
-  gem.add_runtime_dependency 'webrick', '~> 1.3'
-  gem.add_runtime_dependency 'term-ansicolor', '~> 1.0'
+  gem.add_runtime_dependency "rainbow", '~> 3.1'
+  gem.add_runtime_dependency 'string_pattern', '~> 2.0'
+  gem.add_runtime_dependency 'jsonpath', '~> 1.0'
 
-  gem.add_runtime_dependency 'pact-support', '~> 1.15'
+  gem.add_runtime_dependency 'pact-support', '~> 1.21', '>= 1.21.0'
   gem.add_runtime_dependency 'pact-mock_service', '~> 3.0', '>= 3.3.1'
 
   gem.add_development_dependency 'rake', '~> 13.0'
   gem.add_development_dependency 'webmock', '~> 3.0'
-  gem.add_development_dependency 'fakefs', '0.5' # 0.6.0 blows up
-  gem.add_development_dependency 'hashie', '~> 2.0'
-  gem.add_development_dependency 'activesupport', '~> 5.2'
-  gem.add_development_dependency 'faraday', '~> 0.13'
+  gem.add_development_dependency 'fakefs', '2.4'
+  gem.add_development_dependency 'hashie', '~> 5.0'
+  gem.add_development_dependency 'faraday', '~>2.0', '<3.0'
+  gem.add_development_dependency 'faraday-multipart', '~> 1.0'
   gem.add_development_dependency 'conventional-changelog', '~> 1.3'
   gem.add_development_dependency 'bump', '~> 0.5'
   gem.add_development_dependency 'pact-message', '~> 0.8'
   gem.add_development_dependency 'rspec-its', '~> 1.3'
+  gem.add_development_dependency 'webrick', '~> 1.8'
+  gem.add_development_dependency 'ostruct'
 end