workable-pact-provider-verifier 1.24.2

data/lib/pact/provider_verifier/custom_middleware.rb

@@ -0,0 +1,33 @@
+require 'ostruct'
+
+module Pact
+  module ProviderVerifier
+    class CustomMiddleware
+      def self.descendants
+        descendants = []
+        ObjectSpace.each_object(singleton_class) do |k|
+          descendants.unshift k unless k == self
+        end
+        descendants
+      end
+
+      attr_accessor :app
+
+      def initialize app
+        @app = app
+      end
+
+      def call env
+        raise NotImplementedError
+      end
+
+      def provider_states_from(env)
+        if env["X_PACT_PROVIDER_STATES"]
+          env["X_PACT_PROVIDER_STATES"].collect{ | provider_state| OpenStruct.new(provider_state) }
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider_verifier/pact_helper.rb

@@ -0,0 +1,25 @@
+require 'net/https'
+require 'faraday_middleware'
+require 'json'
+require_relative './app'
+require_relative 'set_up_provider_state'
+require 'pact/provider/configuration'
+require 'pact/provider_verifier/underscored_headers_monkeypatch.rb'
+
+# Responsible for making the call to the provider state server to set up the state
+
+Pact.configure do | config |
+  config.provider_state_set_up = Pact::ProviderVerifier::SetUpProviderState
+  config.provider_state_tear_down = -> (*args){ }
+end
+
+if ENV['MONKEYPATCH']
+  ENV['MONKEYPATCH'].split("\n").each do | file |
+    $stdout.puts "DEBUG: Requiring monkeypatch file #{file}" if ENV['VERBOSE_LOGGING']
+    begin
+      require file
+    rescue LoadError => e
+      $stderr.puts "ERROR: #{e.class} - #{e.message}. Ensure you have specified the absolute path."
+    end
+  end
+end

data/lib/pact/provider_verifier/provider_states/add_provider_states_header.rb

@@ -0,0 +1,36 @@
+require 'delegate'
+
+module Pact
+  module ProviderVerifier
+    module ProviderStates
+      class RequestDelegate < SimpleDelegator
+        def initialize request, extra_rack_headers
+          super(request)
+          @extra_rack_headers = extra_rack_headers
+        end
+
+        def headers
+          __getobj__().headers.merge(@extra_rack_headers)
+        end
+
+        def method
+          __getobj__().method
+        end
+      end
+
+      class AddProviderStatesHeader
+
+        def self.call(request, interaction)
+          if interaction.provider_state
+            extra_rack_headers = {
+              "X_PACT_PROVIDER_STATES" => [{ "name" => interaction.provider_state }]
+            }
+            RequestDelegate.new(request, extra_rack_headers)
+          else
+            request
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider_verifier/provider_states/remove_provider_states_header_middleware.rb

@@ -0,0 +1,19 @@
+module Pact
+  module ProviderVerifier
+    module ProviderStates
+      class RemoveProviderStatesHeaderMiddleware
+        def initialize app
+          @app = app
+        end
+
+        def call env
+          @app.call(remove_header(env))
+        end
+
+        def remove_header env
+          env.reject { | key, value | key == "X_PACT_PROVIDER_STATES" }
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider_verifier/rspec_json_formatter_monkeypatch.rb

@@ -0,0 +1,34 @@
+require 'rspec'
+
+begin
+  require 'rspec/core/formatters/json_formatter'
+
+  RSpec::Core::Formatters::JsonFormatter
+
+  # This looks dodgy, but it's actually safer than inheriting from
+  # RSpec::Core::Formatters::JsonFormatter and using a custom class,
+  # because if the JsonFormatter class gets refactored,
+  # the --format json option will still work, but the inheritance will break.
+
+  module RSpec
+    module Core
+      module Formatters
+        class JsonFormatter
+          alias_method :old_close, :close
+
+          def close(*args)
+            # Append a new line so that the output stream can be split at
+            # the new lines, and each JSON document parsed separately
+            old_close(*args)
+            output.write("\n")
+          end
+        end
+      end
+    end
+  end
+
+rescue NameError
+  Pact.configuration.error_stream.puts "WARN: Could not find RSpec::Core::Formatters::JsonFormatter to modify it to put a new line between JSON result documents."
+rescue LoadError
+  Pact.configuration.error_stream.puts "WARN: Could not load rspec/core/formatters/json_formatter to modify it to put a new line between JSON result documents."
+end

data/lib/pact/provider_verifier/set_up_provider_state.rb

@@ -0,0 +1,112 @@
+require 'faraday'
+
+module Pact
+  module ProviderVerifier
+
+    class SetUpProviderStateError < StandardError; end
+
+    class SetUpProviderState
+
+      def initialize provider_state, consumer, options
+        @provider_state = provider_state
+        @consumer = consumer
+        @options = options
+        @params = (options && options[:params]) || {}
+      end
+
+      def self.call provider_state, consumer, options
+        new(provider_state, consumer, options).call
+      end
+
+      def call
+        if provider_states_setup_url.nil?
+          warn_if_provider_state_set
+          return
+        end
+
+        log_request
+        response = post_to_provider_state
+        check_for_error response
+      end
+
+      private
+
+      attr_reader :provider_state, :consumer, :params
+
+      def post_to_provider_state
+        verbose = verbose?
+        options = {url: provider_states_setup_url}
+
+        if provider_states_setup_url.start_with?("https:")
+          options[:ssl] = {verify: false}
+        end
+
+        connection = Faraday.new(options) do | faraday |
+          # Have encountered flakiness on windows build for pact-go
+          # Using retries as a hacky solution to try and get around this
+          # until/if we can work out what the underlying cause is.
+          # https://github.com/pact-foundation/pact-go/issues/42
+          # eg. https://ci.appveyor.com/project/mefellows/pact-go/build/25#L1202
+
+          faraday.request :retry, max: 2, interval: 0.05,
+            interval_randomness: 0.5, backoff_factor: 2,
+            methods:[:post],
+            exceptions: [Faraday::ConnectionFailed]
+
+          faraday.response :logger if verbose
+          faraday.adapter Faraday.default_adapter
+        end
+
+        connection.post do |req|
+          req.headers["Content-Type"] = "application/json"
+          add_custom_provider_header req
+          req.body = {
+            consumer: consumer,
+            state: provider_state,
+            states: [provider_state],
+            params: params
+          }.to_json
+        end
+      end
+
+      def provider_states_setup_url
+        ENV['PROVIDER_STATES_SETUP_URL']
+      end
+
+      def verbose?
+        ENV['VERBOSE_LOGGING']
+      end
+
+      def custom_provider_headers
+        ENV.fetch('CUSTOM_PROVIDER_HEADER', '').split("\n").each_with_object({}) do | header, headers_hash |
+          header_name, header_value = header.split(":", 2).collect(&:strip)
+          headers_hash[header_name] = header_value
+        end
+      end
+
+      def add_custom_provider_header request
+        custom_provider_headers.each do | header_name, header_value |
+          request[header_name] = header_value
+        end
+      end
+
+      def check_for_error response
+        if response.status >= 300
+          raise SetUpProviderStateError.new("Error setting up provider state '#{provider_state}' for consumer '#{consumer}' at #{provider_states_setup_url}. response status=#{response.status} response body=#{response.body}")
+        end
+      end
+
+      def log_request
+        if verbose?
+          $stdout.puts "DEBUG: Setting up provider state '#{provider_state}' for consumer '#{consumer}' using provider state set up URL #{provider_states_setup_url}"
+        end
+      end
+
+      def warn_if_provider_state_set
+        if provider_state
+          $stderr.puts "WARN: Skipping set up for provider state '#{provider_state}' for consumer '#{consumer}' as there is no --provider-states-setup-url specified."
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider_verifier/underscored_headers_monkeypatch.rb

@@ -0,0 +1,96 @@
+# Ok, this doesn't make me feel good about myself, but it's the best way I've found
+# to ensure that any underscored headers (eg "access_token") are not turned into dasherized
+# headers by the Rack code that converts capitalized, dasherized headers into uppercase,
+# underscored headers, and then back again.
+# eg. access_token => HTTP_ACCESS_TOKEN => ACCESS-TOKEN
+# To ensure the original header format is kept, an extra header, HTTP_X_PACT_ORIGINAL_HEADER_NAMES
+# is added to the Rack Request when it is created from the request in the pact file, which contains
+# a comma separated list of the original header names.
+# This header is then removed by the modified Rack Reverse Proxy code, and used to restore
+# the original header names if they have been transformed "incorrectly".
+require 'pact/configuration'
+
+def rack_reverse_proxy_headers_method_found
+  begin
+    RackReverseProxy::RoundTrip.instance_method(:headers)
+    true
+  rescue NameError
+    Pact.configuration.error_stream.puts "WARN: Could not find the RackReverseProxy::RoundTrip#headers method. The implementation must have changed. Cannot monkey patch the aforementioned method to ensure any underscores are retained in header names. You can ignore this warning if you use normal dasherized headers."
+    false
+  end
+end
+
+def pact_provider_request_headers_method_found
+  begin
+    Pact::Provider::Request::Replayable.instance_method(:headers)
+    true
+  rescue NameError
+    Pact.configuration.error_stream.puts "WARN: Could not find the Pact::Provider::Request::Replayable#headers method. The implementation must have changed. Cannot monkey patch the aforementioned method to ensure any underscores are retained in header names. You can ignore this warning if you use normal dasherized headers."
+    false
+  end
+end
+
+module Pact
+  module ProviderVerifier
+    module UnderscoredHeadersMonkeyPatch
+      extend self
+
+      def save_original_header_names rack_headers, expected_request_headers
+        # expected_request_headers may be a Pact::NullExpectation
+        if rack_headers.any?
+          rack_headers['HTTP_X_PACT_ORIGINAL_HEADER_NAMES'] = expected_request_headers.keys.join(",")
+        end
+        rack_headers
+      end
+
+      def restore_original_header_names dasherized_headers
+        original_header_names_value = dasherized_headers.delete("X-PACT-ORIGINAL-HEADER-NAMES")
+        if original_header_names_value && original_header_names_value.size > 0
+          replace_header_names(dasherized_headers, original_header_names_value.split(","))
+        else
+          dasherized_headers
+        end
+      end
+
+      private
+
+      def replace_header_names dasherized_headers, original_header_names
+        original_header_names.each_with_object(dasherized_headers) do | original_header_name, headers |
+          if headers.key?(pact_uppercase_and_dasherize(original_header_name))
+            headers[original_header_name] = headers.delete(pact_uppercase_and_dasherize(original_header_name))
+          end
+        end
+      end
+
+      def pact_uppercase_and_dasherize header_name
+        header_name.upcase.split("_").join("-")
+      end
+    end
+  end
+end
+
+if pact_provider_request_headers_method_found && rack_reverse_proxy_headers_method_found
+  module Pact
+    module Provider
+      module Request
+        class Replayable
+          alias_method :pact_old_headers, :headers
+
+          def headers
+            Pact::ProviderVerifier::UnderscoredHeadersMonkeyPatch.save_original_header_names(pact_old_headers, expected_request.headers)
+          end
+        end
+      end
+    end
+  end
+
+  module RackReverseProxy
+    class RoundTrip
+      alias_method :pact_old_headers, :headers
+
+      def headers
+        Pact::ProviderVerifier::UnderscoredHeadersMonkeyPatch.restore_original_header_names(pact_old_headers)
+      end
+    end
+  end
+end

data/lib/pact/provider_verifier/version.rb

@@ -0,0 +1,5 @@
+module Pact
+  module ProviderVerifier
+    VERSION = "1.24.2"
+  end
+end

data/lib/pact/wait_until_server_available.rb

@@ -0,0 +1,24 @@
+require 'socket'
+require 'time'
+
+module Pact
+  module WaitUntilServerAvailable
+    def self.call(host, port, wait_time = 15)
+      end_time = Time.now + wait_time
+      tries = 0
+      begin
+        sleep 2 if tries != 0
+        Socket.tcp(host, port, connect_timeout: 3) {}
+        true
+      rescue => e
+        tries += 1
+        retry if Time.now < end_time
+        return false
+      end
+    end
+
+    def wait_until_server_available *args
+      WaitUntilServerAvailable.call(*args)
+    end
+  end
+end

metadata

@@ -0,0 +1,324 @@
+--- !ruby/object:Gem::Specification
+name: workable-pact-provider-verifier
+version: !ruby/object:Gem::Version
+  version: 1.24.2
+platform: ruby
+authors:
+- Angelos Karagkiozidis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: pact
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.42.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.42.0
+- !ruby/object:Gem::Dependency
+  name: pact-message
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: rack-reverse-proxy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: conventional-changelog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: find_a_port
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: |-
+  A cross-platform Pact verification tool to validate API Providers.
+                        Used in the pact-js-provider project to simplify development
+email:
+- angelos@workable.com
+executables:
+- pact-provider-verifier
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- bin/pact-provider-verifier
+- lib/pact/provider_verifier.rb
+- lib/pact/provider_verifier/add_header_middlware.rb
+- lib/pact/provider_verifier/aggregate_pact_configs.rb
+- lib/pact/provider_verifier/app.rb
+- lib/pact/provider_verifier/cli/custom_thor.rb
+- lib/pact/provider_verifier/cli/verify.rb
+- lib/pact/provider_verifier/custom_middleware.rb
+- lib/pact/provider_verifier/pact_helper.rb
+- lib/pact/provider_verifier/provider_states/add_provider_states_header.rb
+- lib/pact/provider_verifier/provider_states/remove_provider_states_header_middleware.rb
+- lib/pact/provider_verifier/rspec_json_formatter_monkeypatch.rb
+- lib/pact/provider_verifier/set_up_provider_state.rb
+- lib/pact/provider_verifier/underscored_headers_monkeypatch.rb
+- lib/pact/provider_verifier/version.rb
+- lib/pact/wait_until_server_available.rb
+homepage: https://github.com/pact-foundation/pact-provider-verifier
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Provides a Pact verification service for use with Pact
+test_files: []