workable-pact-provider-verifier 1.24.2

data/bin/pact-provider-verifier

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'pact/provider_verifier/cli/verify'
+Pact::ProviderVerifier::CLI::Verify.start

data/lib/pact/provider_verifier.rb

@@ -0,0 +1,2 @@
+require 'pact/provider_verifier/version'
+require 'pact/provider_verifier/app'

data/lib/pact/provider_verifier/add_header_middlware.rb

@@ -0,0 +1,34 @@
+module Pact
+  module ProviderVerifier
+    class AddHeaderMiddlware
+
+      def initialize app, headers
+        @app = app
+        @headers = headers
+      end
+
+      def call env
+        @app.call(add_headers(env))
+      end
+
+      def add_headers env
+        new_env = env.dup
+        @headers.each_pair do | key, value |
+          header_name = "HTTP_#{key.upcase.gsub("-", "_")}"
+          warn_about_header_replacement key, new_env[header_name], value
+          new_env[header_name] = value
+        end
+        new_env
+      end
+
+      def warn_about_header_replacement header_name, existing_value, new_value
+        if existing_value.nil?
+          $stderr.puts "WARN: Adding header '#{header_name}: #{new_value}' to replayed request. This header did not exist in the pact, and hence this test cannot confirm that the request will work in real life."
+        else
+          # Don't mess up the json formatter by using stdout here
+          $stderr.puts "INFO: Replacing header '#{header_name}: #{existing_value}' with '#{header_name}: #{new_value}'"
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider_verifier/aggregate_pact_configs.rb

@@ -0,0 +1,51 @@
+require 'pact/pact_broker'
+require 'ostruct'
+require 'pact/provider/pact_uri'
+
+module Pact
+  module ProviderVerifier
+    class AggregatePactConfigs
+
+      def self.call(pact_urls, provider_name, consumer_version_tags, provider_version_tags, pact_broker_base_url, http_client_options)
+        new(pact_urls, provider_name, consumer_version_tags, provider_version_tags, pact_broker_base_url, http_client_options).call
+      end
+
+      def initialize(pact_urls, provider_name, consumer_version_tags, provider_version_tags, pact_broker_base_url, http_client_options)
+        @pact_urls = pact_urls
+        @provider_name = provider_name
+        @consumer_version_tags = consumer_version_tags
+        @provider_version_tags = provider_version_tags
+        @pact_broker_base_url = pact_broker_base_url
+        @http_client_options = http_client_options
+      end
+
+      def call
+        pacts_urls_from_broker + specified_pact_uris
+      end
+
+      private
+
+      attr_reader :pact_urls, :provider_name, :consumer_version_tags, :provider_version_tags, :pact_broker_base_url, :http_client_options
+
+      def specified_pact_uris
+        pact_urls.collect{ | url | Pact::PactBroker.build_pact_uri(url) }
+      end
+
+      def pacts_urls_from_broker
+        if pact_broker_base_url && provider_name
+          pacts_for_verification
+        else
+          []
+        end
+      end
+
+      def pacts_for_verification
+        @pacts_for_verification ||= Pact::PactBroker.fetch_pact_uris_for_verification(provider_name, consumer_version_selectors, provider_version_tags, pact_broker_base_url, http_client_options)
+      end
+
+      def consumer_version_selectors
+        consumer_version_tags.collect{ |tag| { tag: tag, latest: true } }
+      end
+    end
+  end
+end

data/lib/pact/provider_verifier/app.rb

@@ -0,0 +1,229 @@
+require 'pact/wait_until_server_available'
+require 'pact/provider_verifier/add_header_middlware'
+require 'pact/provider_verifier/provider_states/add_provider_states_header'
+require 'pact/provider_verifier/provider_states/remove_provider_states_header_middleware'
+require 'pact/provider_verifier/custom_middleware'
+require 'pact/provider/rspec'
+require 'pact/message'
+require 'pact/cli/run_pact_verification'
+require 'pact/provider_verifier/aggregate_pact_configs'
+require 'rack/reverse_proxy'
+require 'faraday_middleware'
+require 'json'
+
+module Pact
+  module ProviderVerifier
+    class App
+      include Pact::WaitUntilServerAvailable
+
+      PROXY_PACT_HELPER = File.expand_path(File.join(File.dirname(__FILE__), "pact_helper.rb"))
+      attr_reader :pact_urls, :options, :consumer_version_tags, :provider_version_tags
+
+      def initialize pact_urls, options = {}
+        @pact_urls = pact_urls
+        @options = options
+        @consumer_version_tags = options[:consumer_version_tag] || []
+        @provider_version_tags = options[:provider_version_tag] || []
+      end
+
+      def self.call pact_urls, options
+        new(pact_urls, options).call
+      end
+
+      def call
+        setup
+
+        pact_urls = all_pact_urls
+        wait_until_provider_available
+        exit_statuses = pact_urls.collect do |pact_uri|
+          verify_pact pact_uri
+        end
+
+        exit_statuses.all?{ | status | status == 0 }
+      end
+
+      private
+
+
+      def setup
+        print_deprecation_note
+        set_environment_variables
+        require_rspec_monkeypatch_for_jsonl
+        require_pact_project_pact_helper # Beth: not sure if this is needed, hangover from pact-provider-proxy?
+        set_broker_token_env_var
+      end
+
+      def set_environment_variables
+        ENV['PROVIDER_STATES_SETUP_URL'] = options.provider_states_setup_url
+        ENV['VERBOSE_LOGGING'] = options.verbose if options.verbose
+        ENV['CUSTOM_PROVIDER_HEADER'] = custom_provider_headers_for_env_var if custom_provider_headers_for_env_var
+        ENV['MONKEYPATCH'] = options.monkeypatch.join("\n") if options.monkeypatch && options.monkeypatch.any?
+      end
+
+      def configure_service_provider
+        # Have to declare these locally as the class scope gets lost within the block
+        application = configure_reverse_proxy
+        application = configure_provider_states_header_removal_middleware(application)
+        application = configure_custom_middleware(application)
+        application = configure_custom_header_middleware(application)
+
+        this = self
+
+        Pact.service_provider "Running Provider Application" do
+          app do
+            application
+          end
+
+          if this.options.provider_app_version
+            app_version this.options.provider_app_version
+          end
+
+          if this.provider_version_tags.any?
+            app_version_tags this.provider_version_tags
+          end
+
+          publish_verification_results this.options.publish_verification_results
+        end
+      end
+
+      def configure_reverse_proxy
+        provider_base_url = options.provider_base_url
+        Rack::ReverseProxy.new do
+          reverse_proxy_options(
+            verify_mode: OpenSSL::SSL::VERIFY_NONE,
+            preserve_host: true,
+            x_forwarded_headers: false
+          )
+          reverse_proxy %r{(.*)}, "#{provider_base_url}$1"
+        end
+      end
+
+      def configure_custom_header_middleware rack_reverse_proxy
+        if options.custom_provider_header
+          Pact::ProviderVerifier::AddHeaderMiddlware.new(rack_reverse_proxy, parse_header)
+        else
+          rack_reverse_proxy
+        end
+      end
+
+      def configure_custom_middleware app
+        if options.custom_middleware && options.custom_middleware.any?
+          require_custom_middlware
+          apply_custom_middleware(app)
+        else
+          app
+        end
+      end
+
+      def configure_provider_states_header_removal_middleware app
+        ProviderStates::RemoveProviderStatesHeaderMiddleware.new(app)
+      end
+
+      def require_custom_middlware
+        options.custom_middleware.each do |file|
+          $stdout.puts "DEBUG: Requiring custom middleware file #{file}" if options.verbose
+          begin
+            require file
+          rescue LoadError => e
+            $stderr.puts "ERROR: #{e.class} - #{e.message}. Please specify an absolute path."
+            exit(1)
+          end
+        end
+      end
+
+      def apply_custom_middleware app
+        CustomMiddleware.descendants.inject(app) do | app, clazz |
+          Pact.configuration.output_stream.puts "INFO: Adding custom middleware #{clazz}"
+          clazz.new(app)
+        end
+      end
+
+      def verify_pact(pact_uri)
+        begin
+          verify_options = {
+            pact_helper: PROXY_PACT_HELPER,
+            pact_uri: pact_uri,
+            backtrace: ENV['BACKTRACE'] == 'true',
+            pact_broker_username: options.broker_username,
+            pact_broker_password: options.broker_password,
+            pact_broker_token: options.broker_token,
+            format: options.format,
+            out: options.out,
+            request_customizer: ProviderStates::AddProviderStatesHeader
+          }
+          verify_options[:description] = ENV['PACT_DESCRIPTION'] if ENV['PACT_DESCRIPTION']
+          verify_options[:provider_state] = ENV['PACT_PROVIDER_STATE'] if ENV['PACT_PROVIDER_STATE']
+
+          reset_pact_configuration
+          # Really, this should call the PactSpecRunner directly, rather than using the CLI class.
+          Cli::RunPactVerification.call(verify_options)
+        rescue SystemExit => e
+          e.status
+        end
+      end
+
+      def reset_pact_configuration
+        require 'pact/configuration'
+        require 'pact/consumer/world'
+        require 'pact/provider/world'
+        Pact.clear_configuration
+        Pact.clear_consumer_world
+        Pact.clear_provider_world
+        configure_service_provider
+      end
+
+      def all_pact_urls
+        http_client_options = { username: options.broker_username, password: options.broker_password, token: options.broker_token, verbose: options.verbose }
+        AggregatePactConfigs.call(pact_urls, options.provider, consumer_version_tags, provider_version_tags, options.pact_broker_base_url, http_client_options)
+      end
+
+      def require_pact_project_pact_helper
+        require ENV['PACT_PROJECT_PACT_HELPER'] if ENV.fetch('PACT_PROJECT_PACT_HELPER','') != ''
+      end
+
+      def require_rspec_monkeypatch_for_jsonl
+        if options.format == 'json'
+          require 'pact/provider_verifier/rspec_json_formatter_monkeypatch'
+        end
+      end
+
+      def custom_provider_headers_for_env_var
+        if options.custom_provider_header && options.custom_provider_header.any?
+          options.custom_provider_header.join("\n")
+        end
+      end
+
+      def parse_header
+        options.custom_provider_header.each_with_object({}) do | custom_provider_header, header_hash |
+          header_name, header_value = custom_provider_header.split(":", 2).collect(&:strip)
+          header_hash[header_name] = header_value
+        end
+      end
+
+      def print_deprecation_note
+        if options.provider_states_url
+          $stderr.puts "WARN: The --provider-states-url option is deprecated and the URL endpoint can be removed from the application"
+        end
+      end
+
+      def wait_until_provider_available
+        if options.wait && options.wait != 0
+          uri = URI(options.provider_base_url)
+          $stderr.puts "INFO: Polling for up to #{options.wait} seconds for provider to become available at #{uri.host}:#{uri.port}..."
+          up = wait_until_server_available(uri.host, uri.port, options.wait)
+          if up
+            $stderr.puts "INFO: Provider available, proceeding with verifications"
+          else
+            $stderr.puts "WARN: Provider does not appear to be up on #{uri.host}:#{uri.port}... proceeding with verifications anyway"
+          end
+        end
+      end
+
+      def set_broker_token_env_var
+        if options.broker_token && !ENV['PACT_BROKER_TOKEN']
+          ENV['PACT_BROKER_TOKEN'] = options.broker_token
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider_verifier/cli/custom_thor.rb

@@ -0,0 +1,71 @@
+require 'thor'
+
+module Pact
+  module ProviderVerifier
+    module CLI
+      ##
+      # Custom Thor task allows the following:
+      #
+      # `script arg1 arg2` to be interpreted as `script <default_task> arg1 arg2`
+      # `--option 1 --option 2` to be interpreted as `--option 1 2` (the standard Thor format for multiple value options)
+      # `script --help` to display the help for the default task instead of the command list
+      #
+      class CustomThor < ::Thor
+
+        no_commands do
+          def self.start given_args = ARGV, config = {}
+            super(massage_args(given_args))
+          end
+
+          def help *args
+            if args.empty?
+              super(self.class.default_task)
+            else
+              super
+            end
+          end
+
+          def self.massage_args argv
+            prepend_default_task_name(turn_muliple_tag_options_into_array(argv))
+          end
+
+          def self.prepend_default_task_name argv
+            if known_first_arguments.include?(argv[0])
+              argv
+            else
+              [default_command] + argv
+            end
+          end
+
+          # other task names, help, and the help shortcuts
+          def self.known_first_arguments
+            @known_first_arguments ||= tasks.keys + ::Thor::HELP_MAPPINGS + ['help']
+          end
+
+          def self.turn_muliple_tag_options_into_array argv
+            new_argv = []
+            opt_name = nil
+            argv.each_with_index do | arg, i |
+              if arg.start_with?('-')
+                opt_name = arg
+                existing = new_argv.find { | a | a.first == opt_name }
+                if !existing
+                  new_argv << [arg]
+                end
+              else
+                if opt_name
+                  existing = new_argv.find { | a | a.first == opt_name }
+                  existing << arg
+                  opt_name = nil
+                else
+                  new_argv << [arg]
+                end
+              end
+            end
+            new_argv.flatten
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider_verifier/cli/verify.rb

@@ -0,0 +1,80 @@
+require 'thor'
+require 'socket'
+require 'pact/provider_verifier/app'
+require 'pact/provider_verifier/cli/custom_thor'
+
+module Pact
+  module ProviderVerifier
+    module CLI
+      class Verify < CustomThor
+
+        class InvalidArgumentsError < ::Thor::Error; end
+
+        desc 'PACT_URL ...', "Verify pact(s) against a provider. Supports local and networked (http-based) files."
+        method_option :provider_base_url, aliases: "-h", desc: "Provider host URL", :required => true
+        method_option :provider_states_setup_url, aliases: "-c", desc: "Base URL to setup the provider states at", :required => false
+        method_option :pact_broker_base_url, desc: "Base URL of the Pact Broker from which to retrieve the pacts.", :required => false
+        method_option :broker_username, aliases: "-n", desc: "Pact Broker basic auth username", :required => false
+        method_option :broker_password, aliases: "-p", desc: "Pact Broker basic auth password", :required => false
+        method_option :broker_token, aliases: "-k", desc: "Pact Broker bearer token", :required => false
+        method_option :provider, required: false
+        method_option :consumer_version_tag, type: :array, banner: "TAG", desc: "Retrieve the latest pacts with this consumer version tag. Used in conjunction with --provider. May be specified multiple times.", :required => false
+        method_option :provider_version_tag, type: :array, banner: "TAG", desc: "Tag to apply to the provider application version. May be specified multiple times.", :required => false
+        method_option :provider_app_version, aliases: "-a", desc: "Provider application version, required when publishing verification results", :required => false
+        method_option :publish_verification_results, aliases: "-r", desc: "Publish verification results to the broker", required: false, type: :boolean, default: false
+        method_option :custom_provider_header, type: :array, banner: 'CUSTOM_PROVIDER_HEADER', desc: "Header to add to provider state set up and pact verification requests. eg 'Authorization: Basic cGFjdDpwYWN0'. May be specified multiple times.", :required => false
+        method_option :custom_middleware, type: :array, banner: 'FILE', desc: "Ruby file containing a class implementing Pact::ProviderVerifier::CustomMiddleware. This allows the response to be modified before replaying. Use with caution!", :required => false
+        method_option :monkeypatch, hide: true, type: :array, :required => false
+        method_option :verbose, aliases: "-v", desc: "Verbose output", :required => false
+        method_option :provider_states_url, aliases: "-s", :required => false, hide: true
+        method_option :format, banner: "FORMATTER", aliases: "-f", desc: "RSpec formatter. Defaults to custom Pact formatter. Other options are json and RspecJunitFormatter (which outputs xml)."
+        method_option :out, aliases: "-o", banner: "FILE", desc: "Write output to a file instead of $stdout."
+        method_option :ignore_failures, type: :boolean, default: false, desc: "If specified, process will always exit with exit code 0", hide: true
+        method_option :pact_urls, aliases: "-u", hide: true, :required => false
+        method_option :wait, banner: "SECONDS", required: false, type: :numeric, desc: "The number of seconds to poll for the provider to become available before running the verification", default: 0
+
+        def verify(*pact_urls)
+          validate_verify
+          print_deprecation_warnings
+          success = Pact::ProviderVerifier::App.call(merged_urls(pact_urls), options)
+          exit_with_non_zero_status if !success && !options.ignore_failures
+        end
+
+        default_task :verify
+
+        desc 'version', 'Show the pact-provider-verifier gem version'
+        def version
+          require 'pact/provider_verifier/version'
+          puts Pact::ProviderVerifier::VERSION
+        end
+
+        no_commands do
+          def merged_urls pact_urls_from_args
+            from_opts = options.pact_urls ? options.pact_urls.split(',') : []
+            from_opts + pact_urls_from_args
+          end
+
+          def print_deprecation_warnings
+            if options.pact_urls
+              $stderr.puts "WARN: The --pact-urls option is deprecated. Please pass in a space separated list of URLs as the first arguments to the pact-provider-verifier command."
+            end
+          end
+
+          def validate_verify
+            if options.pact_broker_base_url && (options.provider.nil? || options.provider == "")
+              raise InvalidArgumentsError, "No value provided for required option '--provider'"
+            end
+          end
+
+          def exit_with_non_zero_status
+            exit 1
+          end
+
+          def exit_on_failure?
+            true
+          end
+        end
+      end
+    end
+  end
+end