pact_broker-client 1.35.0 → 1.38.1

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

@@ -19,17 +19,27 @@ Using a specific version is the easiest way to ensure you get an accurate respon
 
 #### Recommended usage - allowing the Pact Broker to automatically determine the dependencies
 
-Prerequisite: if you would like the Pact Broker to calculate the dependencies for you when you want to deploy an application into a given environment, you will need to let the Broker know which version of each application is in that environment. To do this, the relevant application version resource in the Broker will need to be "tagged" with the name of the environment during the deployment process:
+Prerequisite: if you would like the Pact Broker to calculate the dependencies for you when you want to deploy an application into a given environment, you will need to let the Broker know which version of each application is in that environment.
+
+How you do this depends on the version of the Pact Broker you are running.
+
+If you are using a Broker version where deployment versions are supported, then you would notify the Broker of the deployment of this application version like so:
+
+    $ pact-broker record-deployment --pacticipant Foo --version 173153ae0 --environment test
+
+This assumes that you have already set up an environment named "test" in the Broker.
+
+If you are using a Broker version that does not support deployment environments, then you will need to use tags to notify the broker of the deployment of this application version, like so:
 
     $ pact-broker create-version-tag --pacticipant Foo --version 173153ae0 --tag test
 
-This allows you to use the following simple command to find out if you are safe to deploy:
+Once you have configured your build to notify the Pact Broker of the successful deployment using either method describe above, you can use the following simple command to find out if you are safe to deploy (use either `--to` or  `--to-environment` as supported):
 
-    $ pact-broker can-i-deploy --pacticipant PACTICIPANT --version VERSION \
-                               --to ENVIRONMENT \
+    $ pact-broker can-i-deploy --pacticipant PACTICIPANT --version VERSION
+                               [--to-environment ENVIRONMENT | --to ENVIRONMENT_TAG ]
                                --broker-base-url BROKER_BASE_URL
 
-If the `--to` tag is omitted, then the query will return the compatiblity with the overall latest version of each of the other applications.
+If the `--to` or `--to-environment` options are omitted, then the query will return the compatiblity with the overall latest version of each of the other applications.
 
 Examples:
 
@@ -38,7 +48,7 @@ Can I deploy version 173153ae0 of application Foo to the test environment?
 
 
     $ pact-broker can-i-deploy --pacticipant Foo --version 173153ae0 \
-                               --to test \
+                               --to-environment test \
                                --broker-base-url https://my-pact-broker
 
 
@@ -56,21 +66,20 @@ Can I deploy the latest version of the application Foo that has the tag "test" t
                                --broker-base-url https://my-pact-broker
 
 
-
 #### Alternate usage - specifying dependencies explicitly
 
 If you are unable to use tags, or there is some other limitation that stops you from using the recommended approach, you can specify one or more of the dependencies explictly. You must also do this if you want to use the `--all TAG` option for any of the pacticipants.
 
 You can specify as many application versions as you like, and you can even specify multiple versions of the same application (repeat the `--pacticipant` name and supply a different version.)
 
-You can use explictly declared dependencies with or without the `--to ENVIRONMENT`. For example, if you declare two (or more) application versions with no `--to ENVIRONMENT`, then only the applications you specify will be taken into account when determining if it is safe to deploy. If you declare two (or more) application versions _as well as_ a `--to ENVIRONMENT`, then the Pact Broker will work out what integrations your declared applications will have in that environment when determining if it safe to deploy. When using this script for a production release, and you are using tags, it is always the most future-proof option to use the `--to` if possible, as it will catch any newly added consumers or providers.
+You can use explictly declared dependencies with or without the `--to ENVIRONMENT_TAG`. For example, if you declare two (or more) application versions with no `--to ENVIRONMENT_TAG`, then only the applications you specify will be taken into account when determining if it is safe to deploy. If you declare two (or more) application versions _as well as_ a `--to ENVIRONMENT`, then the Pact Broker will work out what integrations your declared applications will have in that environment when determining if it safe to deploy. When using this script for a production release, and you are using tags, it is always the most future-proof option to use the `--to` if possible, as it will catch any newly added consumers or providers.
 
 If you are finding that your dependencies are not being automatically included when you supply multiple pacticipant versions, please upgrade to the latest version of the Pact Broker, as this is a more recently added feature.
 
 
     $ pact-broker can-i-deploy --pacticipant PACTICIPANT_1 [--version VERSION_1 | --latest [TAG_1] | --all TAG_1] \
                                --pacticipant PACTICIPANT_2 [--version VERSION_2 | --latest [TAG_2] | --all TAG_2] \
-                               [--to ENVIRONMENT] \
+                               [--to-environment ENVIRONMENT | --to ENVIRONMENT_TAG] \
                                --broker-base-url BROKER_BASE_URL
 
 Examples:

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
 
@@ -16,19 +17,25 @@ BITBUCKET_BRANCH BITBUCKET_COMMIT https://confluence.atlassian.com/bitbucket/var
 =end
 
 # Keep in sync with pact-provider-verifier/lib/pact/provider_verifier/git.rb
+
+# `git name-rev --name-only HEAD` provides "tags/v1.35.0^0"
 module PactBroker
   module Client
     module Git
-      COMMAND = 'git name-rev --name-only HEAD'.freeze
+      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}
 
+      BUILD_URL_ENV_VAR_NAMES = %w{BUILDKITE_BUILD_URL CIRCLE_BUILD_URL TRAVIS_BUILD_WEB_URL BUILD_URL }
+
       def self.commit
         find_commit_from_env_vars
       end
 
-      def self.branch
-        find_branch_from_env_vars || branch_from_git_command
+      def self.branch(options)
+        find_branch_from_known_env_vars || find_branch_from_env_var_ending_with_branch || branch_from_git_command(options[:raise_error])
       end
 
       # private
@@ -37,10 +44,21 @@ module PactBroker
         COMMIT_ENV_VAR_NAMES.collect { |env_var_name| value_from_env_var(env_var_name) }.compact.first
       end
 
-      def self.find_branch_from_env_vars
+      def self.find_branch_from_known_env_vars
         BRANCH_ENV_VAR_NAMES.collect { |env_var_name| value_from_env_var(env_var_name) }.compact.first
       end
 
+      def self.find_branch_from_env_var_ending_with_branch
+        values = ENV.keys
+          .select{ |env_var_name| env_var_name.end_with?("_BRANCH") }
+          .collect{ |env_var_name| value_from_env_var(env_var_name) }.compact
+        if values.size == 1
+          values.first
+        else
+          nil
+        end
+      end
+
       def self.value_from_env_var(env_var_name)
         val = ENV[env_var_name]
         if val && val.strip.size > 0
@@ -50,24 +68,10 @@ module PactBroker
         end
       end
 
-      def self.branch_from_git_command
-        branch_names = nil
-        begin
-          branch_names = execute_git_command
-            .split("\n")
-            .collect(&:strip)
-            .reject(&:empty?)
-            .collect(&:split)
-            .collect(&:first)
-            .collect{ |line| line.gsub(/^origin\//, '') }
-            .reject{ |line| line == "HEAD" }
-
-        rescue StandardError => e
-          raise PactBroker::Client::Error, "Could not determine current git branch using command `#{COMMAND}`. #{e.class} #{e.message}"
-        end
-
-        validate_branch_names(branch_names)
-        branch_names[0]
+      def self.branch_from_git_command(raise_error)
+        branch_names = execute_and_parse_command(raise_error)
+        validate_branch_names(branch_names) if raise_error
+        branch_names.size == 1 ? branch_names[0] : nil
       end
 
       def self.validate_branch_names(branch_names)
@@ -83,6 +87,23 @@ module PactBroker
       def self.execute_git_command
         `#{COMMAND}`
       end
+
+      def self.execute_and_parse_command(raise_error)
+        execute_git_command
+          .split("\n")
+          .collect(&:strip)
+          .reject(&:empty?)
+          .collect(&:split)
+          .collect(&:first)
+          .collect{ |line| line.gsub(/^origin\//, '') }
+          .reject{ |line| line == "HEAD" }
+      rescue StandardError => e
+        if raise_error
+          raise PactBroker::Client::Error, "Could not determine current git branch using command `#{COMMAND}`. #{e.class} #{e.message}"
+        else
+          return []
+        end
+      end
     end
   end
 end

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

@@ -17,7 +17,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)
@@ -83,6 +83,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.rb

@@ -53,10 +53,11 @@ module PactBroker
           opts[:success] = [*options[:success]]
         end
         opts[:limit] = options[:limit] if options[:limit]
+        opts[:environment] = options[:to_environment] if options[:to_environment]
         if options[:to_tag]
           opts[:latest] = 'true'
           opts[:tag] = options[:to_tag]
-        elsif selectors.size == 1
+        elsif selectors.size == 1 && !options[:to_environment]
           opts[:latest] = 'true'
         end
         opts

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)