pact_broker-client 1.40.0 → 1.45.0

data/lib/pact_broker/client/deployments/record_undeployment.rb

@@ -0,0 +1,127 @@
+require 'pact_broker/client/base_command'
+
+module PactBroker
+  module Client
+    module Deployments
+      class RecordUndeployment < PactBroker::Client::BaseCommand
+        def initialize(params, options, pact_broker_client_options)
+          super
+          @pacticipant_name = params.fetch(:pacticipant_name)
+          @environment_name = params.fetch(:environment_name)
+          @target = params.fetch(:target)
+        end
+
+        private
+
+        def do_call
+          if undeployed_versions_resources.empty?
+            PactBroker::Client::CommandResult.new(false, error_result_message)
+          else
+            PactBroker::Client::CommandResult.new(undeployed_versions_resources.all?(&:success?), result_message)
+          end
+        end
+
+        attr_reader :pacticipant_name, :environment_name, :target
+
+        def currently_deployed_versions_link
+          environment_resource._link("pb:currently-deployed-versions") or raise PactBroker::Client::Error.new(not_supported_message)
+        end
+
+        def currently_deployed_version_entities_for_pacticipant
+          @deployed_version_links ||= currently_deployed_versions_link.get!(pacticipant: pacticipant_name).embedded_entities!("deployedVersions")
+        end
+
+        def currently_deployed_version_entities_for_pacticipant_and_target
+          currently_deployed_version_entities_for_pacticipant.select do | entity |
+            entity.target == target
+          end
+        end
+
+        def undeployed_versions_resources
+          @undeployed_versions_resources ||= currently_deployed_version_entities_for_pacticipant_and_target.collect do | entity |
+            entity._link!("self").patch(currentlyDeployed: false)
+          end
+        end
+
+        def action
+          "undeployment"
+        end
+
+        def environment_resource
+          index_resource
+            ._link!("pb:environments")
+            .get!
+            ._links("pb:environments")
+            .find!(environment_name, "No environment found with name '#{environment_name}'")
+            .get!
+        end
+
+        def result_message
+          if json_output?
+            undeployed_versions_resources.collect{ | resource | resource.response.body }.to_a.to_json
+          else
+            undeployed_versions_resources.collect do | undeployed_versions_resource |
+              if undeployed_versions_resource.success?
+                green("#{success_result_text_message(undeployed_versions_resource)} in #{pact_broker_name}.")
+              else
+                red(undeployed_versions_resource.error_message)
+              end
+            end.join("\n")
+          end
+        end
+
+        def success_result_text_message(undeployed_versions_resource)
+          version = undeployed_versions_resource.embedded_entity{ | embedded_entity| embedded_entity && embedded_entity['version'] }
+          message = "Recorded #{action} of #{pacticipant_name}"
+          message = "#{message} version #{version.number}" if (version && version.number)
+          message = "#{message} from #{environment_name} environment"
+          message = "#{message} (target #{target})" if target
+          message
+        end
+
+        def error_result_message
+          if json_output?
+            error_message_as_json(error_text)
+          else
+            red(error_text)
+          end
+        end
+
+        def error_text
+          if pacticipant_does_not_exist?
+            "No pacticipant with name '#{pacticipant_name}' found."
+          else
+            if currently_deployed_version_entities_for_pacticipant.any?
+              target_does_not_match_message
+            else
+              "#{pacticipant_name} is not currently deployed to #{environment_name} environment. Cannot record undeployment."
+            end
+          end
+        end
+
+        def target_does_not_match_message
+          potential_targets = currently_deployed_version_entities_for_pacticipant.collect(&:target).collect { |target| target || "<no target>"}
+          if target
+            "#{pacticipant_name} is not currently deployed to target '#{target}' in #{environment_name} environment. Please specify one of the following targets to record the undeployment from: #{potential_targets.join(", ")}"
+          else
+            "Please specify one of the following targets to record the undeployment from: #{potential_targets.join(", ")}"
+          end
+        end
+
+        def not_supported_message
+          "This version of the Pact Broker does not support recording undeployments. Please upgrade to version 2.80.0 or later."
+        end
+
+        def pacticipant_does_not_exist?
+          index_resource._link("pb:pacticipant") && index_resource._link("pb:pacticipant").expand(pacticipant: pacticipant_name).get.does_not_exist?
+        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

data/lib/pact_broker/client/describe_text_formatter.rb

@@ -0,0 +1,23 @@
+require 'yaml'
+require 'pact_broker/client/generate_display_name'
+
+module PactBroker
+  module Client
+    class DescribeTextFormatter
+      extend GenerateDisplayName
+
+      def self.call(properties)
+        YAML.dump(displayify_keys(properties)).gsub("---\n", "")
+      end
+
+      def self.displayify_keys(thing)
+        case thing
+        when Hash then thing.each_with_object({}) { | (key, value), new_hash | new_hash[generate_display_name(key)] = displayify_keys(value) }
+        when Array then thing.collect{ | value | displayify_keys(value) }
+        else
+          thing
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/environments.rb

@@ -0,0 +1,6 @@
+require 'pact_broker/client/environments/create_environment'
+require 'pact_broker/client/environments/delete_environment'
+require 'pact_broker/client/environments/describe_environment'
+require 'pact_broker/client/environments/list_environments'
+require 'pact_broker/client/environments/update_environment'
+

data/lib/pact_broker/client/environments/create_environment.rb

@@ -0,0 +1,31 @@
+require 'pact_broker/client/environments/environment_command'
+
+module PactBroker
+  module Client
+    module Environments
+      class CreateEnvironment < PactBroker::Client::Environments::EnvironmentCommand
+
+        private
+
+        attr_reader :created_environment_resource
+
+        def do_call
+          @created_environment_resource = environments_link.post!(new_environment_body)
+          PactBroker::Client::CommandResult.new(created_environment_resource.success?, result_message)
+        end
+
+        def result_message
+          if json_output?
+            created_environment_resource.response.raw_body
+          else
+            ::Term::ANSIColor.green("Created #{params[:name]} environment in #{pact_broker_name} with UUID #{uuid}")
+          end
+        end
+
+        def uuid
+          created_environment_resource.uuid
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/environments/delete_environment.rb

@@ -0,0 +1,27 @@
+require 'pact_broker/client/environments/environment_command'
+
+module PactBroker
+  module Client
+    module Environments
+      class DeleteEnvironment < PactBroker::Client::Environments::EnvironmentCommand
+        private
+
+        attr_reader :deletion_request_resource
+
+        def do_call
+          existing_environment_resource!
+          @deletion_request_resource = existing_environment_link.delete!
+          PactBroker::Client::CommandResult.new(deletion_request_resource.success?, result_message)
+        end
+
+        def result_message
+          if json_output?
+            deletion_request_resource.response.raw_body
+          else
+            ::Term::ANSIColor.green("Deleted environment #{existing_environment_resource.name} from #{pact_broker_name}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/environments/describe_environment.rb

@@ -0,0 +1,26 @@
+require 'pact_broker/client/environments/environment_command'
+require 'pact_broker/client/describe_text_formatter'
+
+module PactBroker
+  module Client
+    module Environments
+      class DescribeEnvironment < PactBroker::Client::Environments::EnvironmentCommand
+        private
+
+        def do_call
+          existing_environment_resource!
+          PactBroker::Client::CommandResult.new(true, result_message)
+        end
+
+        def result_message
+          if json_output?
+            existing_environment_resource.response.raw_body
+          else
+            properties = existing_environment_resource.response.body.except("_links", "_embedded")
+            PactBroker::Client::DescribeTextFormatter.call(properties)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/environments/environment_command.rb

@@ -0,0 +1,66 @@
+require 'pact_broker/client/base_command'
+
+module PactBroker
+  module Client
+    module Environments
+      class EnvironmentCommand < PactBroker::Client::BaseCommand
+        NOT_SUPPORTED_MESSAGE = "This version of the Pact Broker does not support environments. Please upgrade to version 2.80.0 or later."
+
+        private
+
+        def new_environment_body
+          {
+            "name" => params[:name],
+            "displayName" => params[:display_name],
+            "production" => params[:production],
+            "contacts" => contacts
+          }.compact
+        end
+
+        def environments_link
+          index_resource._link!("pb:environments")
+        end
+
+        def existing_environment_link
+          index_resource
+            ._link!("pb:environment")
+            .expand(uuid: params[:uuid])
+        end
+
+        def existing_environment_resource
+          @existing_environment_resource ||= existing_environment_link.get
+        end
+
+        def existing_environment_resource!
+          existing_environment_resource.assert_success!
+        end
+
+        def existing_environment_body
+          @existing_environment_params ||= existing_environment_resource!
+            .response
+            .body
+            .except("uuid", "_links", "createdAt", "updatedAt")
+        end
+
+        def contacts
+          if params[:contact_name] || params[:contact_email_address]
+            contact = {}
+            contact["name"] = params[:contact_name] || "unknown"
+            if params[:contact_email_address]
+              contact["details"] = { "emailAddress" => params[:contact_email_address] }
+            end
+            [contact]
+          else
+            nil
+          end
+        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

data/lib/pact_broker/client/environments/list_environments.rb

@@ -0,0 +1,30 @@
+require 'pact_broker/client/environments/environment_command'
+require 'pact_broker/client/environments/text_formatter'
+
+module PactBroker
+  module Client
+    module Environments
+      class ListEnvironments < PactBroker::Client::Environments::EnvironmentCommand
+        private
+
+        attr_reader :environments_resource
+
+        def do_call
+          PactBroker::Client::CommandResult.new(true, result_message)
+        end
+
+        def environments_resource
+          @environments_resource = environments_link.get!
+        end
+
+        def result_message
+          if json_output?
+            environments_resource.response.raw_body
+          else
+            PactBroker::Client::Environments::TextFormatter.call(environments_resource._embedded["environments"])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+require 'table_print'
+require 'ostruct'
+
+module PactBroker
+  module Client
+    module Environments
+      class TextFormatter
+
+        def self.call(environments)
+          return "" if environments.size == 0
+
+          data = environments.collect do | environment |
+            OpenStruct.new(environment)
+          end.sort_by{ | environment | environment.name.downcase }
+
+          uuid_width = data.collect(&:uuid).collect(&:size).max
+
+          tp_options = [
+            { uuid: { width: uuid_width } },
+            { name: {} },
+            { displayName: { display_name: "Display name" } },
+            { production: {} }
+          ]
+
+          TablePrint::Printer.new(data, tp_options).table_print
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/environments/update_environment.rb

@@ -0,0 +1,31 @@
+require 'pact_broker/client/environments/environment_command'
+
+module PactBroker
+  module Client
+    module Environments
+      class UpdateEnvironment < PactBroker::Client::Environments::EnvironmentCommand
+
+        private
+
+        attr_reader :updated_environment_resource
+
+        def do_call
+          @updated_environment_resource = existing_environment_link.put!(request_body)
+          PactBroker::Client::CommandResult.new(updated_environment_resource.success?, result_message)
+        end
+
+        def request_body
+          @request_body ||= existing_environment_body.merge(new_environment_body)
+        end
+
+        def result_message
+          if json_output?
+            updated_environment_resource.response.raw_body
+          else
+            ::Term::ANSIColor.green("Updated #{request_body["name"]} environment in #{pact_broker_name}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/generate_display_name.rb

@@ -0,0 +1,27 @@
+require 'pact_broker/client/string_refinements'
+
+module PactBroker
+  module Client
+    module GenerateDisplayName
+      using PactBroker::Client::StringRefinements
+
+      def self.call(name)
+        return nil if name.nil?
+        name
+          .to_s
+          .gsub(/([A-Z])([A-Z])([a-z])/,'\1 \2\3')
+          .gsub(/([a-z\d])([A-Z])(\S)/,'\1 \2\3')
+          .gsub(/(\S)([\-_\s\.])(\S)/, '\1 \3')
+          .gsub(/\s+/, " ")
+          .strip
+          .split(" ")
+          .collect{ |word| word.camelcase(true) }
+          .join(" ")
+      end
+
+      def generate_display_name(name)
+        GenerateDisplayName.call(name)
+      end
+    end
+  end
+end

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

@@ -8,7 +8,15 @@ module PactBroker
   module Client
     module Hal
       class RelationNotFoundError < ::PactBroker::Client::Error; end
-      class ErrorResponseReturned < ::PactBroker::Client::Error; end
+      class EmbeddedEntityNotFoundError < ::PactBroker::Client::Error; end
+      class ErrorResponseReturned < ::PactBroker::Client::Error
+        attr_reader :entity
+
+        def initialize(message, entity)
+          super(message)
+          @entity = entity
+        end
+      end
 
       class Entity
         def initialize(href, data, http_client, response = nil)
@@ -92,7 +100,17 @@ module PactBroker
 
         def embedded_entity
           embedded_ent = yield @data["_embedded"]
-          Entity.new(embedded_ent["_links"]["self"]["href"], embedded_ent, @client, response)
+          if embedded_ent
+            Entity.new(self_href(embedded_ent), embedded_ent, @client, response)
+          end
+        end
+
+        def embedded_entities!(key)
+          embedded_ents = (@data["_embedded"] && @data["_embedded"][key])
+          raise EmbeddedEntityNotFoundError.new("Could not find embedded entity with key '#{key}' in resource at #{@href}") unless embedded_ents
+          embedded_ents.collect do | embedded_ent |
+            Entity.new(self_href(embedded_ent), embedded_ent, @client, response)
+          end
         end
 
         def embedded_entities(key = nil)
@@ -102,7 +120,7 @@ module PactBroker
             yield @data["_embedded"]
           end
           embedded_ents.collect do | embedded_ent |
-            Entity.new(embedded_ent["_links"]["self"]["href"], embedded_ent, @client, response)
+            Entity.new(self_href(embedded_ent), embedded_ent, @client, response)
           end
         end
 
@@ -139,6 +157,10 @@ module PactBroker
         def assert_success!(_ignored = nil)
           self
         end
+
+        def self_href(entity_hash)
+          entity_hash["_links"] && entity_hash["_links"]["self"] && entity_hash["_links"]["self"]["href"]
+        end
       end
 
       class ErrorEntity < Entity
@@ -158,14 +180,17 @@ module PactBroker
           false
         end
 
-        def assert_success!(messages = {})
-          default_message = "Error retrieving #{@href} status=#{response ? response.status: nil} #{response ? response.raw_body : ''}".strip
+        def error_message(messages = {})
+          default_message = "Error making request to #{@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
+
+        def assert_success!(messages = {})
+          raise ErrorResponseReturned.new(error_message(messages), self)
         end
       end
     end