pact_broker-client 1.41.0 → 1.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b929ba48b8f21f7cafeb339e925fac9ecf7a4a83cd3392f5170c769c725998c3
-  data.tar.gz: 1b50eef690671dfdf9a78f1bb8da0f2f1e58cf380b199a554b5a9e770d40a825
+  metadata.gz: 1da6a5e8cef3f91ae1cd441eb92dd2d788ad67ccac947c476090787b27b134ea
+  data.tar.gz: 0df7d512c7c45a8b7ea4d049560be927d1d7c3273c0ec157c22cb81651caa16e
 SHA512:
-  metadata.gz: e527702e1d7d9cc3644f3c4db48c7e02060435699b0104f9048ab6142228475405fac9abea025c713bbf8a3a15b71660a56973515b72464814ff8dee62518289
-  data.tar.gz: 0b81d80a4ab02de7f7d71a7e5c991a6e322731c1803c7c85fd0b53379d92f4739e3296c0acd76cf528567b14147fb3743c352322104da46e4064116bc531514b
+  metadata.gz: 27dc97ff230f86c530b8aed93cf5e86334dd51982017627a7c99de57a2cf8f65af6706c5a73c5d1999df0b145b60b88a649b716fc7f859cbc289193f9dbca437
+  data.tar.gz: 1f970d5b863efc1bc27c55515b95afe8c4a3e166e3da62819ac92e1d4f6205fccb7f8979925266dc37342c1be496310c59a150408398e000b5e8e8b2079ab609

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+<a name="v1.42.0"></a>
+### v1.42.0 (2021-05-31)
+
+#### Features
+
+* add list-pacticipants	 ([fc8ce3b](/../../commit/fc8ce3b))
+* add --display-name to create-or-update-pacticipant	 ([76f323b](/../../commit/76f323b))
+* add backtrace to error output when verbose is true	 ([abf1ef0](/../../commit/abf1ef0))
+* add list-environments and describe-environment	 ([4472d48](/../../commit/4472d48))
+* add delete-environment	 ([361eed1](/../../commit/361eed1))
+* add update-environment command	 ([95276cd](/../../commit/95276cd))
+* add create-environment command	 ([a9fab50](/../../commit/a9fab50))
+
+#### Bug Fixes
+
+* stop long values in columns from being truncated	 ([18063fd](/../../commit/18063fd))
+
 <a name="v1.41.0"></a>
 ### v1.41.0 (2021-05-25)
 

data/lib/pact_broker/client/backports.rb

@@ -10,4 +10,13 @@ class Hash
   def compact!
     reject! {|_key, value| value == nil}
   end unless method_defined? :compact!
+
+  def except(*keys)
+    if keys.size > 4 && size > 4 # index if O(m*n) is big
+      h = {}
+      keys.each { |key| h[key] = true }
+      keys = h
+    end
+    reject { |key, _value| keys.include? key}
+  end unless method_defined? :except
 end

data/lib/pact_broker/client/base_command.rb

@@ -0,0 +1,95 @@
+require 'pact_broker/client/hal_client_methods'
+require 'pact_broker/client/error'
+require 'pact_broker/client/command_result'
+require 'term/ansicolor'
+require 'pact_broker/client/backports'
+
+module PactBroker
+  module Client
+    class BaseCommand
+      include PactBroker::Client::HalClientMethods
+
+      def self.call(params, options, pact_broker_client_options)
+        new(params, options, pact_broker_client_options).call
+      end
+
+      def initialize(params, options, pact_broker_client_options)
+        @params = params
+        @options = options
+        @pact_broker_base_url = pact_broker_client_options.fetch(:pact_broker_base_url)
+        @pact_broker_client_options = pact_broker_client_options
+      end
+
+      def call
+        check_if_command_supported
+        do_call
+      rescue PactBroker::Client::Hal::ErrorResponseReturned => e
+        handle_http_error(e)
+      rescue PactBroker::Client::Error => e
+        handle_ruby_error(e)
+      rescue StandardError => e
+        handle_ruby_error(e, verbose?)
+      end
+
+      private
+
+      attr_reader :params, :options
+      attr_reader :pact_broker_base_url, :pact_broker_client_options
+
+      def handle_http_error(e)
+        message = if json_output?
+          body = e.entity.response.raw_body
+          (body.nil? || body == "") ? "{}" : body
+        else
+          red(e.message)
+        end
+        PactBroker::Client::CommandResult.new(false, message)
+      end
+
+      def handle_ruby_error(e, include_backtrace = false)
+        PactBroker::Client::CommandResult.new(false,  error_message(e, include_backtrace))
+      end
+
+      def error_message(e, include_backtrace)
+        if json_output?
+          json_error_message(e, include_backtrace)
+        else
+          text_error_message(e, include_backtrace)
+        end
+      end
+
+      def json_error_message(e, include_backtrace)
+        error_hash = { message: e.message }
+        error_hash[:class] = e.class.name unless e.is_a?(PactBroker::Client::Error)
+        error_hash[:backtrace] = e.backtrace if include_backtrace
+        { error: error_hash }.to_json
+      end
+
+
+      def text_error_message(e, include_backtrace)
+        maybe_backtrace = (include_backtrace ? "\n" + e.backtrace.join("\n") : "")
+        exception_message = e.is_a?(PactBroker::Client::Error) ? e.message : "#{e.class} - #{e.message}"
+        red(exception_message) + maybe_backtrace
+      end
+
+      def check_if_command_supported
+      end
+
+      def json_output?
+        options[:output] == "json"
+      end
+
+      def verbose?
+        options[:verbose]
+      end
+
+      def green(text)
+        ::Term::ANSIColor.green(text)
+      end
+
+      def red(text)
+        ::Term::ANSIColor.red(text)
+      end
+    end
+  end
+end

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

@@ -1,6 +1,8 @@
 require 'pact_broker/client/cli/custom_thor'
 require 'pact_broker/client/hash_refinements'
 require 'thor/error'
+require 'pact_broker/client/cli/environment_commands'
+require 'pact_broker/client/cli/pacticipant_commands'
 
 module PactBroker
   module Client
@@ -13,6 +15,10 @@ module PactBroker
 
       class Broker < CustomThor
         using PactBroker::Client::HashRefinements
+        if ENV.fetch("PACT_BROKER_FEATURES", "").include?("deployments")
+          include PactBroker::Client::CLI::EnvironmentCommands
+        end
+        include PactBroker::Client::CLI::PacticipantCommands
 
         desc 'can-i-deploy', ''
         long_desc File.read(File.join(__dir__, 'can_i_deploy_long_desc.txt'))
@@ -60,7 +66,7 @@ module PactBroker
         method_option :tag_with_git_branch, aliases: "-g", type: :boolean, default: false, required: false, desc: "Tag consumer version with the name of the current git branch. Default: false"
         method_option :build_url, desc: "The build URL that created the pact"
         method_option :merge, type: :boolean, default: false, require: false, desc: "If a pact already exists for this consumer version and provider, merge the contents. Useful when running Pact tests concurrently on different build nodes."
-        method_option :output, aliases: "-o", desc: "json or text", default: 'text'
+        output_option_json_or_text
         shared_authentication_options
 
         def publish(*pact_files)
@@ -157,22 +163,9 @@ module PactBroker
           puts SecureRandom.uuid
         end
 
-        desc 'create-or-update-pacticipant', 'Create or update pacticipant by name'
-        method_option :name, type: :string, required: true, desc: "Pacticipant name"
-        method_option :repository_url, type: :string, required: false, desc: "The repository URL of the pacticipant"
-        shared_authentication_options
-        verbose_option
-        def create_or_update_pacticipant(*required_but_ignored)
-          raise ::Thor::RequiredArgumentMissingError, "Pacticipant name cannot be blank" if options.name.strip.size == 0
-          require 'pact_broker/client/pacticipants/create'
-          result = PactBroker::Client::Pacticipants2::Create.call({ name: options.name, repository_url: options.repository_url }, options.broker_base_url, pact_broker_client_options)
-          $stdout.puts result.message
-          exit(1) unless result.success
-        end
-
         desc 'list-latest-pact-versions', 'List the latest pact for each integration'
         shared_authentication_options
-        method_option :output, aliases: "-o", desc: "json or table", default: 'table'
+        output_option_json_or_table
         def list_latest_pact_versions(*required_but_ignored)
           require 'pact_broker/client/pacts/list_latest_versions'
           result = PactBroker::Client::Pacts::ListLatestVersions.call(options.broker_base_url, options.output, pact_broker_client_options)
@@ -181,14 +174,13 @@ module PactBroker
         end
 
         if ENV.fetch("PACT_BROKER_FEATURES", "").include?("deployments")
-
           ignored_and_hidden_potential_options_from_environment_variables
           desc "record-deployment", "Record deployment of a pacticipant version to an environment. See https://docs.pact.io/go/record_deployment 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."
-          method_option :output, aliases: "-o", desc: "json or text", default: 'text'
+          output_option_json_or_text
           shared_authentication_options
 
           def record_deployment
@@ -214,7 +206,7 @@ module PactBroker
           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 :output, aliases: "-o", desc: "json or text", default: 'text'
+          output_option_json_or_text
           shared_authentication_options
 
           def record_undeployment
@@ -347,7 +339,7 @@ module PactBroker
           end
 
           def pact_broker_client_options
-            client_options = { verbose: options.verbose }
+            client_options = { verbose: options.verbose, pact_broker_base_url: options.broker_base_url }
             client_options[:token] = options.broker_token || ENV['PACT_BROKER_TOKEN']
             if options.broker_username || ENV['PACT_BROKER_USERNAME']
               client_options[:basic_auth] = {

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

@@ -110,6 +110,18 @@ module PactBroker
           def self.verbose_option
             method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
           end
+
+          def self.output_option_json_or_text
+            method_option :output, aliases: "-o", desc: "json or text", default: 'text'
+          end
+
+          def self.output_option_json_or_table
+            method_option :output, aliases: "-o", desc: "json or table", default: 'table'
+          end
+
+          def params_from_options(keys)
+            keys.each_with_object({}) { | key, p | p[key] = options[key] }
+          end
         end
       end
     end

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

@@ -0,0 +1,70 @@
+module PactBroker
+  module Client
+    module CLI
+      module EnvironmentCommands
+        ENVIRONMENT_PARAM_NAMES = [:name, :display_name, :production, :contact_name, :contact_email_address]
+
+        def self.included(thor)
+          thor.class_eval do
+            def self.shared_environment_options(name_required: false)
+              method_option :name, required: name_required, desc: "The uniquely identifying name of the environment as used in deployment code"
+              method_option :display_name, desc: "The display name of the environment"
+              method_option :production, type: :boolean, default: false, desc: "Whether or not this environment is a production environment. Default: false"
+              method_option :contact_name, required: false, desc: "The name of the team/person responsible for this environment"
+              method_option :contact_email_address, required: false, desc: "The email address of the team/person responsible for this environment"
+              output_option_json_or_text
+            end
+
+            desc "create-environment", "Create an environment resource in the Pact Broker to represent a real world deployment or release environment."
+            shared_environment_options(name_required: true)
+            shared_authentication_options
+            def create_environment
+              execute_environment_command(params_from_options(ENVIRONMENT_PARAM_NAMES), "CreateEnvironment")
+            end
+
+            desc "update-environment", "Update an environment resource in the Pact Broker."
+            method_option :uuid, required: true, desc: "The UUID of the environment to update"
+            shared_environment_options(name_required: false)
+            shared_authentication_options
+            def update_environment
+              execute_environment_command(params_from_options(ENVIRONMENT_PARAM_NAMES + [:uuid]), "UpdateEnvironment")
+            end
+
+            desc "describe-environment", "Describe an environment"
+            method_option :uuid, required: true, desc: "The UUID of the environment to describe"
+            method_option :output, aliases: "-o", desc: "json or text", default: 'text'
+            shared_authentication_options
+            def describe_environment
+              execute_environment_command(params_from_options([:uuid]), "DescribeEnvironment")
+            end
+
+            desc "list-environments", "List environment"
+            method_option :output, aliases: "-o", desc: "json or text", default: 'text'
+            shared_authentication_options
+            def list_environments
+              execute_environment_command({}, "ListEnvironments")
+            end
+
+            desc "delete-environment", "Delete an environment"
+            method_option :uuid, required: true, desc: "The UUID of the environment to delete"
+            method_option :output, aliases: "-o", desc: "json or text", default: 'text'
+            shared_authentication_options
+            def delete_environment
+              execute_environment_command(params_from_options([:uuid]), "DeleteEnvironment")
+            end
+
+            no_commands do
+              def execute_environment_command(params, command_class_name)
+                require 'pact_broker/client/environments'
+                command_options = { verbose: options.verbose, output: options.output }
+                result = PactBroker::Client::Environments.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

@@ -0,0 +1,44 @@
+module PactBroker
+  module Client
+    module CLI
+      module PacticipantCommands
+        PACTICIPANT_PARAM_NAMES = [:name, :display_name, :repository_url]
+
+        def self.included(thor)
+          thor.class_eval do
+            desc 'create-or-update-pacticipant', 'Create or update pacticipant by name'
+            method_option :name, type: :string, required: true, desc: "Pacticipant name"
+            method_option :display_name, type: :string, desc: "Display name"
+            method_option :repository_url, type: :string, required: false, desc: "The repository URL of the pacticipant"
+            output_option_json_or_text
+            shared_authentication_options
+            verbose_option
+
+            def create_or_update_pacticipant(*required_but_ignored)
+              raise ::Thor::RequiredArgumentMissingError, "Pacticipant name cannot be blank" if options.name.strip.size == 0
+              execute_pacticipant_command(params_from_options(PACTICIPANT_PARAM_NAMES), 'Create')
+            end
+
+            desc 'list-pacticipants', 'List pacticipants'
+            output_option_json_or_text
+            shared_authentication_options
+            verbose_option
+            def list_pacticipants
+              execute_pacticipant_command(params_from_options(PACTICIPANT_PARAM_NAMES), 'List')
+            end
+
+            no_commands do
+              def execute_pacticipant_command(params, command_class_name)
+                require 'pact_broker/client/pacticipants'
+                command_options = { verbose: options.verbose, output: options.output }
+                result = PactBroker::Client::Pacticipants2.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/environments.rb

@@ -0,0 +1,3 @@
+Dir.glob(File.join(__FILE__.gsub(".rb", "/**/*.rb"))).sort.each do | path |
+  require path
+end

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,36 @@
+require 'pact_broker/client/environments/environment_command'
+require 'pact_broker/client/generate_display_name'
+require 'yaml'
+
+module PactBroker
+  module Client
+    module Environments
+      class DescribeEnvironment < PactBroker::Client::Environments::EnvironmentCommand
+        include PactBroker::Client::GenerateDisplayName
+        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
+            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
+          end
+        end
+      end
+    end
+  end
+end