pact_broker-client 1.25.0 → 1.27.2

data/lib/pact_broker/client/can_i_deploy.rb

@@ -87,6 +87,8 @@ module PactBroker
         if retry_while_unknown?
           check_if_retry_while_unknown_supported(matrix)
           if matrix.any_unknown?
+            results = matrix.unknown_count == 1 ? "result" : "results"
+            $stderr.puts "Waiting for #{matrix.unknown_count} verification #{results} to be published (maximum of #{wait_time} seconds)"
             matrix = Retry.until_truthy_or_max_times(retry_options) do
               fetch_matrix
             end
@@ -120,6 +122,10 @@ module PactBroker
         options[:retry_while_unknown]
       end
 
+      def wait_time
+        retry_interval * retry_tries
+      end
+
       def check_if_retry_while_unknown_supported(matrix)
         if !matrix.supports_unknown_count?
           raise PactBroker::Client::Error.new("This version of the Pact Broker does not provide a count of the unknown verification results. Please upgrade your Broker to >= v2.23.4")

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

@@ -130,6 +130,15 @@ module PactBroker
           run_webhook_commands webhook_url
         end
 
+        desc 'test-webhook', 'Test the execution of a webhook'
+        method_option :uuid, type: :string, required: true, desc: "Specify the uuid for the webhook"
+        shared_authentication_options_for_pact_broker
+        def test_webhook
+          require 'pact_broker/client/webhooks/test'
+          result = PactBroker::Client::Webhooks::Test.call(options, pact_broker_client_options)
+          $stdout.puts result.message
+        end
+
         ignored_and_hidden_potential_options_from_environment_variables
         desc 'generate-uuid', 'Generate a UUID for use when calling create-or-update-webhook'
         def generate_uuid
@@ -138,6 +147,29 @@ module PactBroker
           puts SecureRandom.uuid
         end
 
+        desc 'create-or-update-pacticipant', 'Create or update pacticipant by name'
+        method_option :name, type: :string, required: true, desc: "Pacticipant name"
+        method_option :repository_url, type: :string, required: false, desc: "The repository URL of the pacticipant"
+        shared_authentication_options_for_pact_broker
+        verbose_option
+        def create_or_update_pacticipant(*required_but_ignored)
+          raise ::Thor::RequiredArgumentMissingError, "Pacticipant name cannot be blank" if options.name.strip.size == 0
+          require 'pact_broker/client/pacticipants/create'
+          result = PactBroker::Client::Pacticipants2::Create.call({ name: options.name, repository_url: options.repository_url }, options.broker_base_url, pact_broker_client_options)
+          $stdout.puts result.message
+          exit(1) unless result.success
+        end
+
+        desc 'list-latest-pact-versions', 'List the latest pact for each integration'
+        shared_authentication_options_for_pact_broker
+        method_option :output, aliases: "-o", desc: "json or table", default: 'table'
+        def list_latest_pact_versions(*required_but_ignored)
+          require 'pact_broker/client/pacts/list_latest_versions'
+          result = PactBroker::Client::Pacts::ListLatestVersions.call(options.broker_base_url, options.output, pact_broker_client_options)
+          $stdout.puts result.message
+          exit(1) unless result.success
+        end
+
         ignored_and_hidden_potential_options_from_environment_variables
         desc 'version', "Show the pact_broker-client gem version"
         def version
@@ -249,6 +281,7 @@ module PactBroker
 
             {
               uuid: options.uuid,
+              description: options.description,
               http_method: options.request,
               url: webhook_url,
               headers: headers,

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

@@ -20,7 +20,7 @@ module PactBroker
           end
 
           def self.add_broker_config_from_environment_variables argv
-            return argv if argv[0] == 'help'
+            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')
@@ -45,20 +45,31 @@ module PactBroker
           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]
+            argv.each_with_index do | word, i |
+              if word.start_with?('-')
+                if word.include?('=')
+                  opt_name, opt_value = word.split('=', 2)
+
+                  existing = new_argv.find { | a | a.first == opt_name }
+                  if existing
+                    existing << opt_value
+                  else
+                    new_argv << [opt_name, opt_value]
+                  end
+                else
+                  opt_name = word
+                  existing = new_argv.find { | a | a.first == opt_name }
+                  if !existing
+                    new_argv << [word]
+                  end
                 end
               else
                 if opt_name
                   existing = new_argv.find { | a | a.first == opt_name }
-                  existing << arg
+                  existing << word
                   opt_name = nil
                 else
-                  new_argv << [arg]
+                  new_argv << [word]
                 end
               end
             end
@@ -76,17 +87,17 @@ module PactBroker
           end
 
           def self.shared_options_for_webhook_commands
-            method_option :request, banner: "METHOD", aliases: "-X", desc: "HTTP method", required: true
-            method_option :header, aliases: "-H", type: :array, desc: "Header"
-            method_option :data, aliases: "-d", desc: "Data"
-            method_option :user, aliases: "-u", desc: "Basic auth username and password eg. username:password"
+            method_option :request, banner: "METHOD", aliases: "-X", desc: "Webhook HTTP method", required: true
+            method_option :header, aliases: "-H", type: :array, desc: "Webhook Header"
+            method_option :data, aliases: "-d", desc: "Webhook payload (file or string)"
+            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: "The description of the webhook"
+            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"
@@ -94,6 +105,17 @@ module PactBroker
             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"
+          end
+
+          def self.verbose_option
+            method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
+          end
         end
       end
     end

data/lib/pact_broker/client/git.rb

@@ -11,6 +11,7 @@ APPVEYOR_REPO_COMMIT APPVEYOR_REPO_BRANCH       https://www.appveyor.com/docs/en
 CI_COMMIT_REF_NAME https://docs.gitlab.com/ee/ci/variables/predefined_variables.html
 CI_BRANCH CI_COMMIT_ID https://documentation.codeship.com/pro/builds-and-configuration/environment-variables/
 bamboo.repository.git.branch https://confluence.atlassian.com/bamboo/bamboo-variables-289277087.html
+BITBUCKET_BRANCH https://confluence.atlassian.com/bitbucket/variables-in-pipelines-794502608.html
 
 =end
 
@@ -19,7 +20,7 @@ module PactBroker
   module Client
     module Git
       COMMAND = 'git name-rev --name-only 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}.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
 
       def self.branch
         find_branch_from_env_vars || branch_from_git_command

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

@@ -6,11 +6,9 @@ module PactBroker
   module Client
     module Hal
       class RelationNotFoundError < ::PactBroker::Client::Error; end
-
       class ErrorResponseReturned < ::PactBroker::Client::Error; end
 
       class Entity
-
         def initialize(href, data, http_client, response = nil)
           @href = href
           @data = data
@@ -31,6 +29,10 @@ module PactBroker
           _link(key).put(*args)
         end
 
+        def patch(key, *args)
+          _link(key).patch(*args)
+        end
+
         def can?(key)
           @links.key? key.to_s
         end
@@ -57,6 +59,10 @@ module PactBroker
           true
         end
 
+        def does_not_exist?
+          false
+        end
+
         def response
           @response
         end
@@ -71,7 +77,7 @@ module PactBroker
           elsif @links.key?(method_name)
             Link.new(@links[method_name], @client).run(*args)
           else
-            super
+            nil
           end
         end
 
@@ -85,7 +91,6 @@ module PactBroker
       end
 
       class ErrorEntity < Entity
-
         def initialize(href, data, http_client, response = nil)
           @href = href
           @data = data
@@ -94,6 +99,10 @@ module PactBroker
           @response = response
         end
 
+        def does_not_exist?
+          response && response.status == 404
+        end
+
         def success?
           false
         end

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

@@ -1,6 +1,7 @@
 require 'pact_broker/client/retry'
 require 'pact_broker/client/hal/authorization_header_redactor'
 require 'net/http'
+require 'json'
 
 module PactBroker
   module Client
@@ -32,6 +33,11 @@ module PactBroker
           perform_request(create_request(uri, 'Post', body, headers), uri)
         end
 
+        def patch href, body = nil, headers = {}
+          uri = URI(href)
+          perform_request(create_request(uri, 'Patch', body, headers), uri)
+        end
+
         def create_request uri, http_method, body = nil, headers = {}
           request = Net::HTTP.const_get(http_method).new(uri.request_uri)
           request['Content-Type'] = "application/json" if ['Post', 'Put', 'Patch'].include?(http_method)

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

@@ -53,6 +53,10 @@ module PactBroker
           wrap_response(href, @http_client.post(href, payload ? JSON.dump(payload) : nil, headers))
         end
 
+        def patch(payload = nil, headers = {})
+          wrap_response(href, @http_client.patch(href, payload ? JSON.dump(payload) : nil, headers))
+        end
+
         def expand(params)
           expanded_url = expand_url(params, href)
           new_attrs = @attrs.merge('href' => expanded_url)
@@ -62,7 +66,7 @@ module PactBroker
         private
 
         def wrap_response(href, http_response)
-          require 'pact/hal/entity' # avoid circular reference
+          require 'pact_broker/client/hal/entity' # avoid circular reference
           if http_response.success?
             Entity.new(href, http_response.body, @http_client, http_response)
           else

data/lib/pact_broker/client/hal_client_methods.rb

@@ -0,0 +1,15 @@
+require 'pact_broker/client/hal'
+
+module PactBroker
+  module Client
+    module HalClientMethods
+      def create_index_entry_point(pact_broker_base_url, pact_broker_client_options)
+        PactBroker::Client::Hal::EntryPoint.new(pact_broker_base_url, create_http_client(pact_broker_client_options))
+      end
+
+      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
+    end
+  end
+end

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

@@ -11,7 +11,7 @@ module PactBroker
 
         def any_unknown?
           if supports_unknown_count?
-            self[:summary][:unknown] > 0
+            unknown_count > 0
           else
             false
           end
@@ -21,6 +21,10 @@ module PactBroker
           !!(self[:summary] && Integer === self[:summary][:unknown] )
         end
 
+        def unknown_count
+          supports_unknown_count? ? self[:summary][:unknown] : nil
+        end
+
         def reason
           self[:summary][:reason]
         end

data/lib/pact_broker/client/pacticipants/create.rb

@@ -0,0 +1,57 @@
+require 'pact_broker/client/hal'
+require 'json'
+require 'pact_broker/client/command_result'
+require 'pact_broker/client/hal_client_methods'
+
+module PactBroker
+  module Client
+    module Pacticipants2
+      class Create
+
+        include HalClientMethods
+
+        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)
+          @params = params
+          @index_entry_point = create_index_entry_point(pact_broker_base_url, pact_broker_client_options)
+          @verbose = pact_broker_client_options[:verbose]
+        end
+
+        def call
+          pacticipant_entity = index_entity._link('pb:pacticipant').expand('pacticipant' => params[:name]).get
+          message = nil
+          response_entity = if pacticipant_entity.does_not_exist?
+            message = "Pacticipant \"#{params[:name]}\" created"
+            index_entity._link!('pb:pacticipants').post(pacticipant_resource_params)
+          else
+            message = "Pacticipant \"#{params[:name]}\" updated"
+            pacticipant_entity._link!('self').patch(pacticipant_resource_params)
+          end
+
+          response_entity.assert_success!
+          PactBroker::Client::CommandResult.new(true, message)
+        rescue StandardError => e
+          $stderr.puts("#{e.class} - #{e}\n#{e.backtrace.join("\n")}") if verbose
+          PactBroker::Client::CommandResult.new(false, "#{e.class} - #{e}")
+        end
+
+        private
+
+        attr_reader :index_entry_point, :params, :verbose
+
+        def index_entity
+          @index_entity ||= index_entry_point.get!
+        end
+
+        def pacticipant_resource_params
+          p = { name: params[:name] }
+          p[:repositoryUrl] = params[:repository_url] if params[:repository_url]
+          p
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/pacts/list_latest_versions.rb

@@ -0,0 +1,65 @@
+require 'pact_broker/client/hal'
+require 'pact_broker/client/command_result'
+require 'pact_broker/client/hal_client_methods'
+
+module PactBroker
+  module Client
+    module Pacts
+      class ListLatestVersions
+
+        include HalClientMethods
+
+        def self.call(pact_broker_base_url, output, pact_broker_client_options)
+          new(pact_broker_base_url, output, pact_broker_client_options).call
+        end
+
+        def initialize(pact_broker_base_url, output, pact_broker_client_options)
+          @index_entry_point = create_index_entry_point(pact_broker_base_url, pact_broker_client_options)
+          @output = output
+        end
+
+        def call
+          message = if output == 'json'
+            versions_resource.response.body
+          else
+            to_text(versions)
+          end
+          PactBroker::Client::CommandResult.new(true, message)
+
+        rescue StandardError => e
+          PactBroker::Client::CommandResult.new(false, e.message)
+        end
+
+        private
+
+        attr_reader :index_entry_point, :output
+
+        def versions
+          versions_resource.pacts.collect do | pact |
+            OpenStruct.new(
+              consumer_name: pact['_embedded']['consumer']['name'],
+              provider_name: pact['_embedded']['provider']['name'],
+              consumer_version_number: pact['_embedded']['consumer']['_embedded']['version']['number'],
+              created_at: pact['createdAt']
+            )
+          end
+        end
+
+        def versions_resource
+          index_entry_point.get!._link('pb:latest-pact-versions').get!
+        end
+
+        def to_text(pacts)
+          require 'table_print'
+          options = [
+            { consumer_name: {display_name: 'consumer'} },
+            { consumer_version_number: {display_name: 'consumer_version'} },
+            { provider_name: {display_name: 'provider'} },
+            { created_at: {} }
+          ]
+          TablePrint::Printer.new(pacts, options).table_print
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/publish_pacts.rb

@@ -85,7 +85,7 @@ module PactBroker
         Retry.while_error do
           pacts = pact_broker_client.pacticipants.versions.pacts
           if pacts.version_published?(consumer: pact.consumer_name, provider: pact.provider_name, consumer_version: consumer_version)
-            $stdout.puts ::Term::ANSIColor.yellow("The given version of pact is already published. Overwriting...")
+            $stdout.puts ::Term::ANSIColor.yellow("A pact for this consumer version is already published. Overwriting. (Note: Overwriting pacts is not recommended as it can lead to race conditions. Best practice is to provide a unique consumer version number for each publication.)")
           end
 
           latest_pact_url = pacts.publish(pact_hash: pact, consumer_version: consumer_version)