pact_broker-client 1.36.0 → 1.38.2

data/lib/pact_broker/client/cli/create_or_update_webhook_long_desc.txt

@@ -1 +1,3 @@
-Create a curl command that executes the request that you want your webhook to execute, then replace "curl" with "pact-broker create-or-update-webhook" and add the consumer, provider, event types and broker details. Note that the URL must be the first parameter when executing create-or-update-webhook and a uuid must also be provided. You can generate a valid UUID by using the `generate-uuid` command.
+Create a curl command that executes the request that you want your webhook to execute, then replace "curl" with "pact-broker create-or-update-webhook" and add the consumer, provider, event types and broker details. Note that the URL must be the first parameter when executing create-or-update-webhook and a uuid must also be provided. You can generate a valid UUID by using the `generate-uuid` command.
+
+Note that the -u option from the curl command clashes with the -u option from the pact-broker CLI. When used in this command, the -u will be used as a curl option. Please use the --broker-username or environment variable for the Pact Broker username.

data/lib/pact_broker/client/cli/create_webhook_long_desc.txt

@@ -1 +1,3 @@
 Create a curl command that executes the request that you want your webhook to execute, then replace "curl" with "pact-broker create-webhook" and add the consumer, provider, event types and broker details. Note that the URL must be the first parameter when executing create-webhook.
+
+Note that the -u option from the curl command clashes with the -u option from the pact-broker CLI. When used in this command, the -u will be used as a curl option. Please use the --broker-username or environment variable for the Pact Broker username.

data/lib/pact_broker/client/cli/custom_thor.rb

@@ -22,10 +22,7 @@ module PactBroker
           def self.add_broker_config_from_environment_variables argv
             return argv if argv[0] == 'help' || argv.empty?
 
-            new_argv = add_option_from_environment_variable(argv, 'broker-base-url', 'b', 'PACT_BROKER_BASE_URL')
-            new_argv = add_option_from_environment_variable(new_argv, 'broker-username', 'u', 'PACT_BROKER_USERNAME')
-            new_argv = add_option_from_environment_variable(new_argv, 'broker-token', 'k', 'PACT_BROKER_TOKEN')
-            add_option_from_environment_variable(new_argv, 'broker-password', 'p', 'PACT_BROKER_PASSWORD')
+            add_option_from_environment_variable(argv, 'broker-base-url', 'b', 'PACT_BROKER_BASE_URL')
           end
 
           def self.add_option_from_environment_variable argv, long_name, short_name, environment_variable_name
@@ -86,6 +83,14 @@ module PactBroker
             method_option :broker_token, hide: true
           end
 
+          def self.shared_authentication_options
+            method_option :broker_base_url, required: true, aliases: "-b", desc: "The base URL of the Pact Broker"
+            method_option :broker_username, aliases: "-u", desc: "Pact Broker basic auth username"
+            method_option :broker_password, aliases: "-p", desc: "Pact Broker basic auth password"
+            method_option :broker_token, aliases: "-k", desc: "Pact Broker bearer token"
+            method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
+          end
+
           def self.shared_options_for_webhook_commands
             method_option :request, banner: "METHOD", aliases: "-X", desc: "Webhook HTTP method", required: true
             method_option :header, aliases: "-H", type: :array, desc: "Webhook Header"
@@ -93,24 +98,13 @@ module PactBroker
             method_option :user, aliases: "-u", desc: "Webhook basic auth username and password eg. username:password"
             method_option :consumer, desc: "Consumer name"
             method_option :provider, desc: "Provider name"
-            method_option :broker_base_url, required: true, aliases: "-b", desc: "The base URL of the Pact Broker"
-            method_option :broker_username, desc: "Pact Broker basic auth username"
-            method_option :broker_password, aliases: "-p", desc: "Pact Broker basic auth password"
-            method_option :broker_token, aliases: "-k", desc: "Pact Broker bearer token"
             method_option :description, desc: "Wwebhook description"
             method_option :contract_content_changed, type: :boolean, desc: "Trigger this webhook when the pact content changes"
             method_option :contract_published, type: :boolean, desc: "Trigger this webhook when a pact is published"
             method_option :provider_verification_published, type: :boolean, desc: "Trigger this webhook when a provider verification result is published"
             method_option :provider_verification_failed, type: :boolean, desc: "Trigger this webhook when a failed provider verification result is published"
             method_option :provider_verification_succeeded, type: :boolean, desc: "Trigger this webhook when a successful provider verification result is published"
-            method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
-          end
-
-          def self.shared_authentication_options_for_pact_broker
-            method_option :broker_base_url, required: true, aliases: "-b", desc: "The base URL of the Pact Broker"
-            method_option :broker_username, aliases: "-u", desc: "Pact Broker basic auth username"
-            method_option :broker_password, aliases: "-p", desc: "Pact Broker basic auth password"
-            method_option :broker_token, aliases: "-k", desc: "Pact Broker bearer token"
+            shared_authentication_options
           end
 
           def self.verbose_option
@@ -120,4 +114,4 @@ module PactBroker
       end
     end
   end
-end
+end

data/lib/pact_broker/client/git.rb

@@ -1,4 +1,5 @@
 require 'pact_broker/client/error'
+require 'pact_broker/client/hash_refinements'
 
 =begin
 
@@ -21,6 +22,8 @@ BITBUCKET_BRANCH BITBUCKET_COMMIT https://confluence.atlassian.com/bitbucket/var
 module PactBroker
   module Client
     module Git
+      using PactBroker::Client::HashRefinements
+
       COMMAND = 'git rev-parse --abbrev-ref HEAD'.freeze
       BRANCH_ENV_VAR_NAMES = %w{BUILDKITE_BRANCH CIRCLE_BRANCH TRAVIS_BRANCH GIT_BRANCH GIT_LOCAL_BRANCH APPVEYOR_REPO_BRANCH CI_COMMIT_REF_NAME BITBUCKET_BRANCH}.freeze
       COMMIT_ENV_VAR_NAMES = %w{BUILDKITE_COMMIT CIRCLE_SHA1 TRAVIS_COMMIT GIT_COMMIT APPVEYOR_REPO_COMMIT CI_COMMIT_ID BITBUCKET_COMMIT}

data/lib/pact_broker/client/hal/entity.rb

@@ -1,6 +1,8 @@
 require 'erb'
 require 'delegate'
+require 'pact_broker/client/error'
 require 'pact_broker/client/hal/link'
+require 'pact_broker/client/hal/links'
 
 module PactBroker
   module Client
@@ -51,10 +53,43 @@ module PactBroker
           end
         end
 
+        def _links(key)
+          if @links[key] && @links[key].is_a?(Array)
+            link_collection = @links[key].collect do | hash |
+              Link.new(hash, @client)
+            end
+            Links.new(@href, key, link_collection)
+          elsif @links[key].is_a?(Hash)
+            Links.new(@href, key, [Link.new(@links[key], @client)])
+          else
+            nil
+          end
+        end
+
         def _link!(key)
           _link(key) or raise RelationNotFoundError.new("Could not find relation '#{key}' in resource at #{@href}")
         end
 
+        def _links!(key)
+          _links(key) or raise RelationNotFoundError.new("Could not find relation '#{key}' in resource at #{@href}")
+        end
+
+        def embedded_entity
+          embedded_ent = yield @data["_embedded"]
+          Entity.new(embedded_ent["_links"]["self"]["href"], embedded_ent, @client, response)
+        end
+
+        def embedded_entities(key = nil)
+          embedded_ents = if key
+            @data["_embedded"][key]
+          else
+            yield @data["_embedded"]
+          end
+          embedded_ents.collect do | embedded_ent |
+            Entity.new(embedded_ent["_links"]["self"]["href"], embedded_ent, @client, response)
+          end
+        end
+
         def success?
           true
         end
@@ -85,7 +120,7 @@ module PactBroker
           @data.key?(method_name) || @links.key?(method_name)
         end
 
-        def assert_success!
+        def assert_success!(_ignored = nil)
           self
         end
       end
@@ -107,8 +142,14 @@ module PactBroker
           false
         end
 
-        def assert_success!
-          raise ErrorResponseReturned.new("Error retrieving #{@href} status=#{response ? response.code: nil} #{response ? response.raw_body : ''}")
+        def assert_success!(messages = {})
+          default_message = "Error retrieving #{@href} status=#{response ? response.status: nil} #{response ? response.raw_body : ''}".strip
+          message = if response && messages[response.status]
+            (messages[response.status] || "") + " (#{default_message})"
+          else
+            default_message
+          end
+          raise ErrorResponseReturned.new(message)
         end
       end
     end

data/lib/pact_broker/client/hal/http_client.rb

@@ -7,6 +7,7 @@ module PactBroker
   module Client
     module Hal
       class HttpClient
+        RETRYABLE_ERRORS = [Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::ETIMEDOUT, Errno::EHOSTUNREACH, Net::ReadTimeout]
         attr_accessor :username, :password, :verbose, :token
 
         def initialize options
@@ -17,7 +18,7 @@ module PactBroker
         end
 
         def get href, params = {}, headers = {}
-          query = params.collect{ |(key, value)| "#{CGI::escape(key)}=#{CGI::escape(value)}" }.join("&")
+          query = params.collect{ |(key, value)| "#{CGI::escape(key.to_s)}=#{CGI::escape(value)}" }.join("&")
           uri = URI(href)
           uri.query = query
           perform_request(create_request(uri, 'Get', nil, headers), uri)
@@ -53,7 +54,7 @@ module PactBroker
         end
 
         def perform_request request, uri
-          response = Retry.until_truthy_or_max_times do
+          response = until_truthy_or_max_times(times: 5, sleep: 5, condition: ->(resp) { resp.code.to_i < 500 }) do
             http = Net::HTTP.new(uri.host, uri.port, :ENV)
             http.set_debug_output(output_stream) if verbose
             http.use_ssl = (uri.scheme == 'https')
@@ -69,6 +70,37 @@ module PactBroker
           Response.new(response)
         end
 
+        def until_truthy_or_max_times options = {}
+          max_tries = options.fetch(:times, 3)
+          tries = 0
+          sleep_interval = options.fetch(:sleep, 5)
+          sleep(sleep_interval) if options[:sleep_first]
+          while true
+            begin
+              result = yield
+              return result if max_tries < 2
+              if options[:condition]
+                condition_result = options[:condition].call(result)
+                return result if condition_result
+              else
+                return result if result
+              end
+              tries += 1
+              return result if max_tries == tries
+              sleep sleep_interval
+            rescue *RETRYABLE_ERRORS => e
+              tries += 1
+              $stderr.puts "ERROR: Error making request - #{e.class} #{e.message} #{e.backtrace.find{|l| l.include?('pact_broker-client')}}, attempt #{tries} of #{max_tries}"
+              raise e if max_tries == tries
+              sleep sleep_interval
+            end
+          end
+        end
+
+        def sleep seconds
+          Kernel.sleep seconds
+        end
+
         def output_stream
           AuthorizationHeaderRedactor.new($stdout)
         end
@@ -83,6 +115,10 @@ module PactBroker
             end
           end
 
+          def headers
+            __getobj__().to_hash
+          end
+
           def raw_body
             __getobj__().body
           end

data/lib/pact_broker/client/hal/links.rb

@@ -0,0 +1,39 @@
+require 'uri'
+require 'delegate'
+
+module PactBroker
+  module Client
+    module Hal
+      class Links
+        def initialize(href, key, links)
+          @href = href
+          @key = key
+          @links = links
+        end
+
+        def names
+          @names ||= links.collect(&:name).compact.uniq
+        end
+
+        def find!(name, not_found_message = nil)
+          link = find(name)
+          if link
+            link
+          else
+            message = not_found_message || "Could not find relation '#{key}' with name '#{name}' in resource at #{href}."
+            available_options = names.any? ? names.join(", ") : "<none found>"
+            raise RelationNotFoundError.new(message.chomp(".") + ". Available options: #{available_options}")
+          end
+        end
+
+        def find(name)
+          links.find{ | link | link.name == name }
+        end
+
+        private
+
+        attr_reader :links, :key, :href
+      end
+    end
+  end
+end

data/lib/pact_broker/client/hal_client_methods.rb

@@ -1,4 +1,5 @@
 require 'pact_broker/client/hal'
+require 'pact_broker/client/retry'
 
 module PactBroker
   module Client
@@ -10,6 +11,16 @@ module PactBroker
       def create_http_client(pact_broker_client_options)
         PactBroker::Client::Hal::HttpClient.new(pact_broker_client_options.merge(pact_broker_client_options[:basic_auth] || {}))
       end
+
+      def index_entry_point
+        @index_entry_point ||= create_index_entry_point(pact_broker_base_url, pact_broker_client_options)
+      end
+
+      def index_resource
+        @index_resource ||= Retry.while_error do
+          index_entry_point.get!
+        end
+      end
     end
   end
 end

data/lib/pact_broker/client/hash_refinements.rb

@@ -0,0 +1,19 @@
+module PactBroker
+  module Client
+    module HashRefinements
+      refine Hash do
+        def compact
+          h = {}
+          each do |key, value|
+            h[key] = value unless value == nil
+          end
+          h
+        end unless Hash.method_defined? :compact
+
+        def compact!
+          reject! {|_key, value| value == nil}
+        end unless Hash.method_defined? :compact!
+      end
+    end
+  end
+end

data/lib/pact_broker/client/matrix/text_formatter.rb

@@ -1,10 +1,12 @@
 require 'table_print'
 require 'dig_rb'
+require 'pact_broker/client/hash_refinements'
 
 module PactBroker
   module Client
     class Matrix
       class TextFormatter
+        using PactBroker::Client::HashRefinements
 
         Line = Struct.new(:consumer, :consumer_version, :provider, :provider_version, :success, :ref)
 

data/lib/pact_broker/client/publish_pacts.rb

@@ -5,11 +5,12 @@ require 'pact_broker/client/pact_file'
 require 'pact_broker/client/pact_hash'
 require 'pact_broker/client/merge_pacts'
 require 'pact_broker/client/hal_client_methods'
+require 'pact_broker/client/hash_refinements'
 
 module PactBroker
   module Client
     class PublishPacts
-
+      using PactBroker::Client::HashRefinements
       include HalClientMethods
 
       def self.call(pact_broker_base_url, pact_file_paths, consumer_version_params, pact_broker_client_options={})

data/lib/pact_broker/client/tasks/publication_task.rb

@@ -1,5 +1,6 @@
 require 'rake/tasklib'
 require 'pact_broker/client/git'
+require 'pact_broker/client/hash_refinements'
 
 =begin
 require pact_broker/client/tasks
@@ -17,6 +18,7 @@ end
 module PactBroker
   module Client
     class PublicationTask < ::Rake::TaskLib
+      using PactBroker::Client::HashRefinements
 
       attr_accessor :pattern, :pact_broker_base_url, :consumer_version, :tag, :write_method, :tag_with_git_branch, :pact_broker_basic_auth, :pact_broker_token
       attr_reader :auto_detect_version_properties, :branch, :build_url

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.36.0'
+    VERSION = '1.38.2'
   end
 end

data/lib/pact_broker/client/versions/record_deployment.rb

@@ -0,0 +1,109 @@
+require 'pact_broker/client/hal_client_methods'
+require 'pact_broker/client/error'
+require 'pact_broker/client/command_result'
+
+module PactBroker
+  module Client
+    class Versions
+      class RecordDeployment
+        include PactBroker::Client::HalClientMethods
+
+        NOT_SUPPORTED_MESSAGE = "This version of the Pact Broker does not support recording deployments. Please upgrade to version 2.80.0 or later."
+
+        def self.call(params, pact_broker_base_url, pact_broker_client_options)
+          new(params, pact_broker_base_url, pact_broker_client_options).call
+        end
+
+        def initialize(params, pact_broker_base_url, pact_broker_client_options)
+          @pact_broker_base_url = pact_broker_base_url
+          @pacticipant_name = params.fetch(:pacticipant_name)
+          @version_number = params.fetch(:version_number)
+          @environment_name = params.fetch(:environment_name)
+          @replaced_previous_deployed_version = params.fetch(:replaced_previous_deployed_version)
+          @output = params.fetch(:output)
+          @pact_broker_client_options = pact_broker_client_options
+        end
+
+        def call
+          check_if_command_supported
+          record_deployment
+
+          PactBroker::Client::CommandResult.new(true, result_message)
+        rescue PactBroker::Client::Error => e
+          PactBroker::Client::CommandResult.new(false, e.message)
+        end
+
+        private
+
+        attr_reader :pact_broker_base_url, :pact_broker_client_options
+        attr_reader :pacticipant_name, :version_number, :environment_name, :replaced_previous_deployed_version, :output
+        attr_reader :deployed_version_resource
+
+        def check_environment_exists
+          index_resource
+            ._link!("pb:environments")
+            .get!
+            ._links("pb:environments")
+            .find!(environment_name, "No environment found with name '#{environment_name}'")
+        end
+
+        def record_deployment
+          @deployed_version_resource =
+            get_record_deployment_relation
+            .post(record_deployment_request_body)
+            .assert_success!
+        end
+
+        def get_record_deployment_relation
+          record_deployment_links = get_pacticipant_version._links!("pb:record-deployment")
+          link_for_environment = record_deployment_links.find(environment_name)
+          if link_for_environment
+            link_for_environment
+          else
+            check_environment_exists
+            # Force the exception to be raised
+            record_deployment_links.find!(environment_name, "Environment '#{environment_name}' is not an available option for recording a deployment of #{pacticipant_name}.")
+          end
+        end
+
+        def get_pacticipant_version
+          index_resource
+            ._link!("pb:pacticipant-version")
+            .expand(pacticipant: pacticipant_name, version: version_number)
+            .get
+            .assert_success!(404 => "#{pacticipant_name} version #{version_number} not found")
+        end
+
+        def record_deployment_request_body
+          { replacedPreviousDeployedVersion: replaced_previous_deployed_version }
+        end
+
+        def result_message
+          if output == "text"
+            message = "Recorded deployment of #{pacticipant_name} version #{version_number} to #{environment_name} in #{pact_broker_name}."
+            suffix = replaced_previous_deployed_version ? " Marked previous deployed version as undeployed." : ""
+            message + suffix
+          elsif output == "json"
+            deployed_version_resource.response.raw_body
+          else
+            ""
+          end
+        end
+
+        def pact_broker_name
+          is_pactflow? ? "Pactflow" : "the Pact Broker"
+        end
+
+        def is_pactflow?
+          deployed_version_resource.response.headers.keys.any?{ | header_name | header_name.downcase.include?("pactflow") }
+        end
+
+        def check_if_command_supported
+          unless index_resource.can?("pb:environments")
+            raise PactBroker::Client::Error.new(NOT_SUPPORTED_MESSAGE)
+          end
+        end
+      end
+    end
+  end
+end