pact_broker-client 1.43.0 → 1.44.0

data/lib/pact_broker/client/cli/deployment_commands.rb

@@ -0,0 +1,74 @@
+module PactBroker
+  module Client
+    module CLI
+      module DeploymentCommands
+        HELP_URL = "https://docs.pact.io/pact_broker/recording_deployments_and_releases/"
+
+        def self.included(thor)
+          thor.class_eval do
+            desc "record-deployment", "Record deployment of a pacticipant version to an environment. See #{HELP_URL} for more information."
+            method_option :pacticipant, required: true, aliases: "-a", desc: "The name of the pacticipant that was deployed."
+            method_option :version, required: true, aliases: "-e", desc: "The pacticipant version number that was deployed."
+            method_option :environment, required: true, desc: "The name of the environment that the pacticipant version was deployed to."
+            method_option :target, default: nil, required: false, desc: "Optional. The target of the deployment - a logical identifer required to differentiate deployments when there are multiple instances of the same application in an environment."
+            output_option_json_or_text
+            shared_authentication_options
+
+            def record_deployment
+              params = {
+                pacticipant_name: options.pacticipant,
+                version_number: options.version,
+                environment_name: options.environment,
+                target: options.target
+              }
+              execute_deployment_command(params, "RecordDeployment")
+            end
+
+            desc "record-undeployment", "Record undeployment of a pacticipant version from an environment."
+            long_desc "Note that use of this command is not required if you are deploying over a previous version, as record-deployment will handle that scenario for you. This command is only required if you are permanently removing an application instance from an environment."
+            method_option :pacticipant, required: true, aliases: "-a", desc: "The name of the pacticipant that was undeployed."
+            method_option :environment, required: true, desc: "The name of the environment that the pacticipant version was undeployed from."
+            method_option :target, default: nil, required: false, desc: "Optional. The target that the application is being undeployed from - a logical identifer required to differentiate deployments when there are multiple instances of the same application in an environment."
+            output_option_json_or_text
+            shared_authentication_options
+
+            def record_undeployment
+              params = {
+                pacticipant_name: options.pacticipant,
+                environment_name: options.environment,
+                target: options.target
+              }
+              execute_deployment_command(params, "RecordUndeployment")
+            end
+
+            desc "record-release", "Record release of a pacticipant version to an environment. See See #{HELP_URL} for more information."
+            method_option :pacticipant, required: true, aliases: "-a", desc: "The name of the pacticipant that was released."
+            method_option :version, required: true, aliases: "-e", desc: "The pacticipant version number that was released."
+            method_option :environment, required: true, desc: "The name of the environment that the pacticipant version was released to."
+            output_option_json_or_text
+            shared_authentication_options
+
+            def record_release
+              params = {
+                pacticipant_name: options.pacticipant,
+                version_number: options.version,
+                environment_name: options.environment
+              }
+              execute_deployment_command(params, "RecordRelease")
+            end
+
+            no_commands do
+              def execute_deployment_command(params, command_class_name)
+                require 'pact_broker/client/deployments'
+                command_options = { verbose: options.verbose, output: options.output }
+                result = PactBroker::Client::Deployments.const_get(command_class_name).call(params, command_options, pact_broker_client_options)
+                $stdout.puts result.message
+                exit(1) unless result.success
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/cli/pacticipant_commands.rb

@@ -27,6 +27,15 @@ module PactBroker
               execute_pacticipant_command(params_from_options(PACTICIPANT_PARAM_NAMES), 'List')
             end
 
+            desc 'describe-pacticipant', "Describe a pacticipant"
+            method_option :name, type: :string, required: true, desc: "Pacticipant name"
+            output_option_json_or_text
+            shared_authentication_options
+            verbose_option
+            def describe_pacticipant
+              execute_pacticipant_command({ name: options.name }, 'Describe')
+            end
+
             no_commands do
               def execute_pacticipant_command(params, command_class_name)
                 require 'pact_broker/client/pacticipants'

data/lib/pact_broker/client/deployments.rb

@@ -0,0 +1,4 @@
+require 'pact_broker/client/deployments/record_deployment'
+require 'pact_broker/client/deployments/record_release'
+require 'pact_broker/client/deployments/record_undeployment'
+

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

@@ -0,0 +1,38 @@
+require 'pact_broker/client/deployments/record_release'
+
+module PactBroker
+  module Client
+    module Deployments
+      class RecordDeployment < PactBroker::Client::Deployments::RecordRelease
+        def initialize(params, options, pact_broker_client_options)
+          super
+          @target = params.fetch(:target)
+        end
+
+        private
+
+        attr_reader :target
+
+        def action
+          "deployment"
+        end
+
+        def action_relation_name
+          "pb:record-deployment"
+        end
+
+        def record_action_request_body
+          { target: target }.compact
+        end
+
+        def result_text_message
+          if target
+            "#{super} (target #{target})"
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,99 @@
+require 'pact_broker/client/base_command'
+
+module PactBroker
+  module Client
+    module Deployments
+      class RecordRelease < PactBroker::Client::BaseCommand
+        def initialize(params, options, pact_broker_client_options)
+          super
+          @pacticipant_name = params.fetch(:pacticipant_name)
+          @version_number = params.fetch(:version_number)
+          @environment_name = params.fetch(:environment_name)
+        end
+
+        private
+
+        attr_reader :pacticipant_name, :version_number, :environment_name
+        attr_reader :deployed_version_resource
+
+        def do_call
+          record_action
+          PactBroker::Client::CommandResult.new(true, result_message)
+        end
+
+        def action
+          "release"
+        end
+
+        def action_relation_name
+          "pb:record-release"
+        end
+
+        def not_supported_message
+          "This version of the Pact Broker does not support recording #{action}s. Please upgrade to version 2.80.0 or later."
+        end
+
+        def environment_exists?
+          index_resource
+            ._link!("pb:environments")
+            .get!
+            ._links("pb:environments")
+            .find(environment_name)
+        end
+
+        def record_action
+          @deployed_version_resource =
+            get_record_action_relation
+            .post(record_action_request_body)
+            .assert_success!
+        end
+
+        def record_action_links
+          get_pacticipant_version._links(action_relation_name) or raise PactBroker::Client::Error.new(not_supported_message)
+        end
+
+        def get_record_action_relation
+          record_action_links.find(environment_name) or record_action_links.find!(environment_name, environment_relation_not_found_error_message)
+        end
+
+        def environment_relation_not_found_error_message
+          if environment_exists?
+            "Environment '#{environment_name}' is not an available option for recording a deployment of #{pacticipant_name}."
+          else
+            "No environment found with name '#{environment_name}'."
+          end
+        end
+
+        def get_pacticipant_version
+          index_resource
+            ._link!("pb:pacticipant-version")
+            .expand(pacticipant: pacticipant_name, version: version_number)
+            .get
+            .assert_success!(404 => "#{pacticipant_name} version #{version_number} not found")
+        end
+
+        def record_action_request_body
+          {}
+        end
+
+        def result_message
+          if json_output?
+            deployed_version_resource.response.raw_body
+          else
+            green("#{result_text_message} in #{pact_broker_name}.")
+          end
+        end
+
+        def result_text_message
+          "Recorded #{action} of #{pacticipant_name} version #{version_number} to #{environment_name} environment"
+        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,120 @@
+require 'pact_broker/client/base_command'
+
+module PactBroker
+  module Client
+    module Deployments
+      class RecordUndeployment < PactBroker::Client::BaseCommand
+
+
+
+        def initialize(params, pact_broker_base_url, 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?
+            check_pacticipant_exists!
+            PactBroker::Client::CommandResult.new(false, deployed_version_not_found_error_message)
+          else
+            PactBroker::Client::CommandResult.new(undeployed_versions_resources.all?(:success?), result_message)
+          end
+        end
+
+        attr_reader :pacticipant_name, :version_number, :environment_name, :target, :output
+        attr_reader :deployed_version_resource, :undeployment_entities
+
+        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_versions_resource
+          @deployed_version_links ||= currently_deployed_versions_link.get!(pacticipant: pacticipant_name, target: target)
+        end
+
+        def undeployed_versions_resources
+          @undeployed_versions_resources ||= currently_deployed_versions_resource.embedded_entities("deployedVersions").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 check_pacticipant_exists!
+          if index_resource._link!("pb:pacticipant").expand(pacticipant: pacticipant_name).get.does_not_exist?
+            raise PactBroker::Client::Error.new("No pacticipant with name '#{pacticipant_name}' found")
+          end
+        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_number = undeployed_versions_resource.embedded_entity{ | embedded_entity| embedded_entity['version'] }.number
+          message = "Recorded #{action} of #{pacticipant_name} version #{version_number} from #{environment_name} environment"
+          if target
+            message + " (target #{target})"
+          else
+            message
+          end
+        end
+
+        def deployed_version_not_found_error_message
+          target_bit = target ? " with target '#{target}'" : ""
+          message = "#{pacticipant_name} is not currently deployed to #{environment_name}#{target_bit}. Cannot record undeployment."
+
+          if json_output?
+            { error: message }.to_json
+          else
+            red(message)
+          end
+        end
+
+
+        def deployed_version_not_found_message
+          if (env_names = deployed_version_links.names).any?
+            "#{pacticipant_name} version #{version_number} is not currently deployed to #{environment_name}. It is currently deployed to: #{env_names.join(", ")}"
+          else
+            "#{pacticipant_name} version #{version_number} is not currently deployed to any environment."
+          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 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

@@ -1,3 +1,6 @@
-Dir.glob(File.join(__FILE__.gsub(".rb", "/**/*.rb"))).sort.each do | path |
-  require path
-end
+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/describe_environment.rb

@@ -1,12 +1,10 @@
 require 'pact_broker/client/environments/environment_command'
-require 'pact_broker/client/generate_display_name'
-require 'yaml'
+require 'pact_broker/client/describe_text_formatter'
 
 module PactBroker
   module Client
     module Environments
       class DescribeEnvironment < PactBroker::Client::Environments::EnvironmentCommand
-        include PactBroker::Client::GenerateDisplayName
         private
 
         def do_call
@@ -18,16 +16,8 @@ module PactBroker
           if json_output?
             existing_environment_resource.response.raw_body
           else
-            YAML.dump(displayify_keys(existing_environment_resource.response.body.except("_links"))).gsub("---\n", "")
-          end
-        end
-
-        def 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
+            properties = existing_environment_resource.response.body.except("_links", "_embedded")
+            PactBroker::Client::DescribeTextFormatter.call(properties)
           end
         end
       end

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

@@ -165,14 +165,17 @@ module PactBroker
           false
         end
 
-        def assert_success!(messages = {})
+        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, self)
+        end
+
+        def assert_success!(messages = {})
+          raise ErrorResponseReturned.new(error_message(messages), self)
         end
       end
     end