pact_broker-client 1.41.0 → 1.46.0

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

@@ -0,0 +1,103 @@
+require 'pact_broker/client/base_command'
+
+module PactBroker
+  module Client
+    module Deployments
+      class RecordSupportEnded < PactBroker::Client::BaseCommand
+        def initialize(params, options, pact_broker_client_options)
+          super
+          @pacticipant_name = params.fetch(:pacticipant_name)
+          @environment_name = params.fetch(:environment_name)
+          @version_number = params.fetch(:version_number)
+        end
+
+        private
+
+        def do_call
+          if unsupported_versions_resources.empty?
+            PactBroker::Client::CommandResult.new(false, error_result_message)
+          else
+            PactBroker::Client::CommandResult.new(unsupported_versions_resources.all?(&:success?), result_message)
+          end
+        end
+
+        attr_reader :pacticipant_name, :environment_name, :version_number
+
+        def currently_supported_versions_link
+          environment_resource._link("pb:currently-supported-versions") or raise PactBroker::Client::Error.new(not_supported_message)
+        end
+
+        def currently_supported_version_entities_for_pacticipant_version
+          @deployed_version_links ||= currently_supported_versions_link.get!(pacticipant: pacticipant_name, version: version_number).embedded_entities!("releasedVersions")
+        end
+
+        def unsupported_versions_resources
+          @unsupported_versions_resources ||= currently_supported_version_entities_for_pacticipant_version.collect do | entity |
+            entity._link!("self").patch(currentlySupported: 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?
+            unsupported_versions_resources.collect{ | resource | resource.response.body }.to_a.to_json
+          else
+            unsupported_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)
+          "Recorded support ended for #{pacticipant_name} version #{version_number} in #{environment_name} environment"
+        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
+            "#{pacticipant_name} version #{version_number} is not currently released in #{environment_name} environment. Cannot record support ended."
+          end
+        end
+
+        def not_supported_message
+          "This version of the Pact Broker does not support recording end of support. 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/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