pact_broker-client 1.38.3 → 1.39.0

data/lib/pact_broker/client/hal_client_methods.rb

@@ -21,6 +21,14 @@ module PactBroker
           index_entry_point.get!
         end
       end
+
+      def is_pactflow?
+        index_resource.response.headers.keys.any?{ | header_name | header_name.downcase.include?("pactflow") }
+      end
+
+      def pact_broker_name
+        is_pactflow? ? "Pactflow" : "the Pact Broker"
+      end
     end
   end
 end

data/lib/pact_broker/client/pacts.rb

@@ -4,7 +4,6 @@ require 'pact_broker/client/pact_hash'
 module PactBroker
   module Client
     class Pacts  < BaseClient
-
       def publish options
         consumer_version = options[:consumer_version]
         pact_hash = options[:pact_hash]

data/lib/pact_broker/client/publish_pacts.rb

@@ -1,11 +1,7 @@
 require 'term/ansicolor'
-require 'pact_broker/client'
-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'
-require 'pact_broker/client/hash_refinements'
+require 'base64'
+require 'pact_broker/client/publish_pacts_the_old_way'
 
 module PactBroker
   module Client
@@ -13,170 +9,132 @@ module PactBroker
       using PactBroker::Client::HashRefinements
       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
+      def self.call(pact_broker_base_url, pact_file_paths, consumer_version_params, options, pact_broker_client_options={})
+        new(pact_broker_base_url, pact_file_paths, consumer_version_params, options, pact_broker_client_options).call
       end
 
-      def initialize pact_broker_base_url, pact_file_paths, consumer_version_params, pact_broker_client_options={}
+      def initialize pact_broker_base_url, pact_file_paths, consumer_version_params, options, pact_broker_client_options={}
         @pact_broker_base_url = pact_broker_base_url
         @pact_file_paths = pact_file_paths
-        @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]
+        @consumer_version_params = consumer_version_params
+        @consumer_version_number = strip(consumer_version_params[:number])
+        @branch = strip(consumer_version_params[:branch])
+        @build_url = strip(consumer_version_params[:build_url])
+        @tags = consumer_version_params[:tags] ? consumer_version_params[:tags].collect{ |tag| strip(tag) } : []
+        @options = options
         @pact_broker_client_options = pact_broker_client_options
       end
 
       def call
         validate
-        $stdout.puts("")
-        result = create_consumer_versions && apply_tags && publish_pacts
-        $stdout.puts("")
-        result
+        if index_resource.can?("pb:publish-contracts")
+          publish_pacts
+          PactBroker::Client::CommandResult.new(success?, message)
+        else
+          PublishPactsTheOldWay.call(pact_broker_base_url, pact_file_paths, consumer_version_params, options, pact_broker_client_options)
+        end
       end
 
       private
 
-      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
+      attr_reader :pact_broker_base_url, :pact_file_paths, :consumer_version_params, :consumer_version_number, :branch, :tags, :build_url, :options, :pact_broker_client_options, :response_entities
 
-      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
+      def request_body_for(consumer_name)
+        {
+          pacticipantName: consumer_name,
+          pacticipantVersionNumber: consumer_version_number,
+          tags: tags,
+          branch: branch,
+          buildUrl: build_url,
+          contracts: contracts_for(consumer_name)
+        }.compact
       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
-          publish_pact(PactHash[merge_contents(pact_files)])
-        end.all?
-      end
-
-      def merge_contents(pact_files)
-        MergePacts.call(pact_files.collect(&:pact_hash))
-      end
-
-      def pact_files
-        @pact_files ||= pact_file_paths.collect{ |pact_file_path| PactFile.new(pact_file_path) }
-      end
-
-      def consumer_names
-        pact_files.collect(&:consumer_name).uniq
+        @response_entities = consumer_names.collect do | consumer_name |
+          index_resource._link("pb:publish-contracts").post(request_body_for(consumer_name))
+        end
       end
 
-      def publish_pact pact
-        begin
-          $stdout.puts "Publishing #{pact.pact_name} to pact broker at #{pact_broker_base_url}"
-          publish_pact_contents pact
-        rescue => e
-          $stderr.puts "Failed to publish #{pact.pact_name} due to error: #{e.class} - #{e}"
-          false
-        end
+      def success?
+        response_entities.all?(&:success?)
       end
 
-      def create_consumer_versions
-        if create_versions?
-          consumer_names.collect do | consumer_name |
-            create_version(index_resource, consumer_name)
-          end
-          true
+      def message
+        if options[:output] == "json"
+          response_entities.collect(&:response).collect(&:body).to_a.to_json
         else
-          true
+          text_message
         end
       end
 
-      def create_versions?
-        if version_required
-          if can_create_version_with_branch?
-            true
+      def text_message
+        response_entities.flat_map do | response_entity |
+          if response_entity.success?
+            if response_entity.logs
+              response_entity.logs.collect do | log |
+                colorized_message(log)
+              end
+            else
+              "Successfully published pacts"
+            end
           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.")
+            ::Term::ANSIColor.red(response_entity.response.body.to_s)
           end
-        elsif (branch || build_url) && can_create_version_with_branch?
-          true
+        end.join("\n")
+      end
+
+      def colorized_message(log)
+        color = color_for_level(log["level"])
+        if color
+          ::Term::ANSIColor.send(color, log["message"])
         else
-          false
+          log["message"]
         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
+      def color_for_level(level)
+        case level
+        when "warn" then :yellow
+        when "error" then :red
+        when "info" then :green
+        else nil
+        end
+      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
+      def contracts_for(consumer_name)
+        pact_files_for(consumer_name).group_by(&:pact_name).values.collect do | pact_files |
+          $stderr.puts "Merging #{pact_files.collect(&:path).join(", ")}" if pact_files.size > 1
+          pact_hash = PactHash[merge_contents(pact_files)]
+          {
+            consumerName: pact_hash.consumer_name,
+            providerName: pact_hash.provider_name,
+            specification: "pact",
+            contentType: "application/json",
+            content: Base64.strict_encode64(pact_hash.to_json),
+            writeMode: write_mode
+          }
         end
       end
 
-      def version_body
-        {
-          branch: branch,
-          buildUrl: build_url
-        }.compact
+      def merge_contents(pact_files)
+        MergePacts.call(pact_files.collect(&:pact_hash))
       end
 
-      def apply_tags
-        return true if tags.empty?
-        tags.all? do | tag |
-          tag_consumer_version tag
-        end
+      def pact_files
+        @pact_files ||= pact_file_paths.collect{ |pact_file_path| PactFile.new(pact_file_path) }
       end
 
-      def tag_consumer_version tag
-        versions = pact_broker_client.pacticipants.versions
-        Retry.while_error do
-          consumer_names.collect do | consumer_name |
-            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
-      rescue => e
-        $stderr.puts "Failed to tag version due to error: #{e.class} - #{e}"
-        false
+      def pact_files_for(consumer_name)
+        pact_files.select{ | pact_file | pact_file.consumer_name == consumer_name }
       end
 
-      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_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
+      def consumer_names
+        pact_files.collect(&:consumer_name).uniq
+      end
 
-          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
+      def write_mode
+        options[:merge] ? "merge" : "overwrite"
       end
 
       def validate
@@ -184,6 +142,10 @@ module PactBroker
         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
+
+      def strip(maybe_string)
+        maybe_string.respond_to?(:strip) ? maybe_string.strip : maybe_string
+      end
     end
   end
 end

data/lib/pact_broker/client/publish_pacts_the_old_way.rb

@@ -0,0 +1,194 @@
+require 'term/ansicolor'
+require 'pact_broker/client'
+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'
+require 'pact_broker/client/hash_refinements'
+require 'pact_broker/client/command_result'
+
+module PactBroker
+  module Client
+    class PublishPactsTheOldWay
+      using PactBroker::Client::HashRefinements
+      include HalClientMethods
+
+      def self.call(pact_broker_base_url, pact_file_paths, consumer_version_params, options, pact_broker_client_options={})
+        new(pact_broker_base_url, pact_file_paths, consumer_version_params, options, pact_broker_client_options).call
+      end
+
+      def initialize pact_broker_base_url, pact_file_paths, consumer_version_params, options, pact_broker_client_options={}
+        @pact_broker_base_url = pact_broker_base_url
+        @pact_file_paths = pact_file_paths
+        @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 = create_consumer_versions && apply_tags && publish_pacts
+        $stdout.puts("")
+        if result
+          PactBroker::Client::CommandResult.new(true)
+        else
+          PactBroker::Client::CommandResult.new(false, "One or more pacts failed to be published")
+        end
+      end
+
+      private
+
+      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
+          publish_pact(PactHash[merge_contents(pact_files)])
+        end.all?
+      end
+
+      def merge_contents(pact_files)
+        MergePacts.call(pact_files.collect(&:pact_hash))
+      end
+
+      def pact_files
+        @pact_files ||= pact_file_paths.collect{ |pact_file_path| PactFile.new(pact_file_path) }
+      end
+
+      def consumer_names
+        pact_files.collect(&:consumer_name).uniq
+      end
+
+      def publish_pact pact
+        begin
+          $stdout.puts "Publishing #{pact.pact_name} to pact broker at #{pact_broker_base_url}"
+          publish_pact_contents pact
+        rescue => e
+          $stderr.puts "Failed to publish #{pact.pact_name} due to error: #{e.class} - #{e}"
+          false
+        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.empty?
+        tags.all? do | tag |
+          tag_consumer_version tag
+        end
+      end
+
+      def tag_consumer_version tag
+        versions = pact_broker_client.pacticipants.versions
+        Retry.while_error do
+          consumer_names.collect do | consumer_name |
+            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
+      rescue => e
+        $stderr.puts "Failed to tag version due to error: #{e.class} - #{e}"
+        false
+      end
+
+      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_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_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_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
+    end
+  end
+end