pact_broker-client 1.31.0 → 1.36.0

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/git.rb

@@ -16,19 +16,23 @@ 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
+      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 +41,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 +65,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 +84,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/matrix.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base_client'
 require 'pact_broker/client/matrix/resource'
 
@@ -39,7 +41,7 @@ module PactBroker
               response.body
             end
           rescue
-            raise Error.new(response.body)
+            raise Error.new("status=#{response.code} #{response.body}")
           end
           raise Error.new(error_message)
         end
@@ -51,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,41 +1,74 @@
 require 'table_print'
+require 'dig_rb'
 
 module PactBroker
   module Client
     class Matrix
       class TextFormatter
 
-        Line = Struct.new(:consumer, :consumer_version, :provider, :provider_version, :success)
+        Line = Struct.new(:consumer, :consumer_version, :provider, :provider_version, :success, :ref)
 
         OPTIONS = [
           { consumer: {} },
           { consumer_version: {display_name: 'C.VERSION'} },
           { provider: {} },
           { provider_version: {display_name: 'P.VERSION'} },
-          { success: {display_name: 'SUCCESS?'} }
+          { success: {display_name: 'SUCCESS?'} },
+          { ref: { display_name: 'RESULT#' }}
         ]
 
         def self.call(matrix)
           matrix_rows = matrix[:matrix]
           return "" if matrix_rows.size == 0
-          data = matrix_rows.collect do | line |
+          verification_result_number = 0
+          data = matrix_rows.each_with_index.collect do | line |
+            has_verification_result_url = lookup(line, nil, :verificationResult, :_links, :self, :href)
+            if has_verification_result_url
+              verification_result_number += 1
+            end
             Line.new(
-              lookup(line, :consumer, :name),
-              lookup(line, :consumer, :version, :number),
-              lookup(line, :provider, :name),
-              lookup(line, :provider, :version, :number),
-              lookup(line, :verificationResult, :success).to_s
+              lookup(line, "???", :consumer, :name),
+              lookup(line, "???", :consumer, :version, :number),
+              lookup(line, "???", :provider, :name) ,
+              lookup(line, "???", :provider, :version, :number),
+              (lookup(line, "???", :verificationResult, :success)).to_s,
+              has_verification_result_url ? verification_result_number : ""
             )
           end
 
           printer = TablePrint::Printer.new(data, OPTIONS)
-          printer.table_print
+          printer.table_print + verification_result_urls_text(matrix)
         end
 
-        def self.lookup line, *keys
+        def self.lookup line, default, *keys
           keys.reduce(line) { | line, key | line[key] }
         rescue NoMethodError
-          "???"
+          default
+        end
+
+        def self.verification_results_urls_and_successes(matrix)
+          (matrix[:matrix] || []).collect do | row |
+            url = row.dig(:verificationResult, :_links, :self, :href)
+            if url
+              success = row.dig(:verificationResult, :success)
+              [url, success]
+            else
+              nil
+            end
+          end.compact
+        end
+
+        def self.verification_result_urls_text(matrix)
+          text = self.verification_results_urls_and_successes(matrix).each_with_index.collect do |(url, success), i|
+            status = success ? 'success' : 'failure'
+            "#{i+1}. #{url} (#{status})"
+          end.join("\n")
+
+          if text.size > 0
+            "\n\nVERIFICATION RESULTS\n--------------------\n#{text}"
+          else
+            text
+          end
         end
       end
     end

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

@@ -20,7 +20,7 @@ module PactBroker
 
         def call
           message = if output == 'json'
-            versions_resource.response.body
+            versions_resource.response.raw_body
           else
             to_text(versions)
           end

data/lib/pact_broker/client/publish_pacts.rb

@@ -4,39 +4,63 @@ require 'pact_broker/client/retry'
 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'
 
 module PactBroker
   module Client
     class PublishPacts
 
-      def self.call(pact_broker_base_url, pact_file_paths, consumer_version, tags, pact_broker_client_options={})
-        new(pact_broker_base_url, pact_file_paths, consumer_version, tags, pact_broker_client_options).call
+      include HalClientMethods
+
+      def self.call(pact_broker_base_url, pact_file_paths, consumer_version_params, pact_broker_client_options={})
+        new(pact_broker_base_url, pact_file_paths, consumer_version_params, pact_broker_client_options).call
       end
 
-      def initialize pact_broker_base_url, pact_file_paths, consumer_version, tags, pact_broker_client_options={}
+      def initialize pact_broker_base_url, pact_file_paths, consumer_version_params, pact_broker_client_options={}
         @pact_broker_base_url = pact_broker_base_url
         @pact_file_paths = pact_file_paths
-        @consumer_version = consumer_version
-        @tags = tags
+        @consumer_version_number = consumer_version_params[:number].respond_to?(:strip) ? consumer_version_params[:number].strip : consumer_version_params[:number]
+        @branch = consumer_version_params[:branch]
+        @build_url = consumer_version_params[:build_url]
+        @tags = consumer_version_params[:tags] ? consumer_version_params[:tags].collect{ |tag| tag.respond_to?(:strip) ? tag.strip : tag } : []
+        @version_required = consumer_version_params[:version_required]
         @pact_broker_client_options = pact_broker_client_options
       end
 
       def call
         validate
         $stdout.puts("")
-        result = apply_tags && publish_pacts
+        result = create_consumer_versions && apply_tags && publish_pacts
         $stdout.puts("")
         result
       end
 
       private
 
-      attr_reader :pact_broker_base_url, :pact_file_paths, :consumer_version, :tags, :pact_broker_client_options
+      attr_reader :pact_broker_base_url, :pact_file_paths, :consumer_version_number, :branch, :tags, :build_url, :pact_broker_client_options, :version_required
 
       def pact_broker_client
         @pact_broker_client ||= PactBroker::Client::PactBrokerClient.new(base_url: pact_broker_base_url, client_options: pact_broker_client_options)
       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
+
+      def can_create_version_with_branch?
+        @can_create_version_with_branch ||= index_resource.can?('pb:pacticipant-version')
+      end
+
+      def merge_on_server?
+        pact_broker_client_options[:write] == :merge
+      end
+
       def publish_pacts
         pact_files.group_by(&:pact_name).collect do | pact_name, pact_files |
           $stdout.puts "Merging #{pact_files.collect(&:path).join(", ")}" if pact_files.size > 1
@@ -66,8 +90,58 @@ module PactBroker
         end
       end
 
+      def create_consumer_versions
+        if create_versions?
+          consumer_names.collect do | consumer_name |
+            create_version(index_resource, consumer_name)
+          end
+          true
+        else
+          true
+        end
+      end
+
+      def create_versions?
+        if version_required
+          if can_create_version_with_branch?
+            true
+          else
+            raise PactBroker::Client::Error.new("This version of the Pact Broker does not support versions with branches or build URLs. Please upgrade your broker to 2.76.2 or later.")
+          end
+        elsif (branch || build_url) && can_create_version_with_branch?
+          true
+        else
+          false
+        end
+      end
+
+      def create_version(index_resource, consumer_name)
+        Retry.while_error do
+          version_resource = index_resource._link('pb:pacticipant-version').expand(version: consumer_version_number, pacticipant: consumer_name).put(version_body).assert_success!
+          message = if version_resource.response.status == 200
+            "Replaced version #{consumer_version_number} of #{consumer_name}"
+          else
+            "Created version #{consumer_version_number} of #{consumer_name}"
+          end
+
+          message = message + " (branch #{branch})" if branch
+          $stdout.puts message
+          if version_resource.response.status == 200
+            $stdout.puts ::Term::ANSIColor.yellow("Replacing the version resource is not recommended under normal circumstances and may indicate that you have not configured your Pact pipeline correctly (unless you are just re-running a build for a particular commit). For more information see https://docs.pact.io/versioning")
+          end
+          true
+        end
+      end
+
+      def version_body
+        {
+          branch: branch,
+          buildUrl: build_url
+        }.compact
+      end
+
       def apply_tags
-        return true if tags.nil? || tags.empty?
+        return true if tags.empty?
         tags.all? do | tag |
           tag_consumer_version tag
         end
@@ -77,8 +151,8 @@ module PactBroker
         versions = pact_broker_client.pacticipants.versions
         Retry.while_error do
           consumer_names.collect do | consumer_name |
-            versions.tag(pacticipant: consumer_name, version: consumer_version, tag: tag)
-            $stdout.puts "Tagged version #{consumer_version} of #{consumer_name} as #{tag.inspect}"
+            versions.tag(pacticipant: consumer_name, version: consumer_version_number, tag: tag)
+            $stdout.puts "Tagged version #{consumer_version_number} of #{consumer_name} as #{tag.inspect}"
             true
           end
         end
@@ -90,18 +164,22 @@ module PactBroker
       def publish_pact_contents(pact)
         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("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.)")
+          if pacts.version_published?(consumer: pact.consumer_name, provider: pact.provider_name, consumer_version: consumer_version_number)
+            if merge_on_server?
+              $stdout.puts "A pact for this consumer version is already published. Merging contents."
+            else
+              $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. For more information, see https://docs.pact.io/versioning)")
+            end
           end
 
-          latest_pact_url = pacts.publish(pact_hash: pact, consumer_version: consumer_version)
+          latest_pact_url = pacts.publish(pact_hash: pact, consumer_version: consumer_version_number)
           $stdout.puts "The latest version of this pact can be accessed at the following URL:\n#{latest_pact_url}"
           true
         end
       end
 
       def validate
-        raise PactBroker::Client::Error.new("Please specify the consumer_version") unless (consumer_version && consumer_version.to_s.strip.size > 0)
+        raise PactBroker::Client::Error.new("Please specify the consumer_version_number") unless (consumer_version_number && consumer_version_number.to_s.strip.size > 0)
         raise PactBroker::Client::Error.new("Please specify the pact_broker_base_url") unless (pact_broker_base_url && pact_broker_base_url.to_s.strip.size > 0)
         raise PactBroker::Client::Error.new("No pact files found") unless (pact_file_paths && pact_file_paths.any?)
       end