pact_broker-client 1.43.0 → 1.47.0

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

@@ -0,0 +1,94 @@
+module PactBroker
+  module Client
+    module CLI
+      module DeploymentCommands
+        RECORD_DEPLOYMENT_HELP_URL = "https://docs.pact.io/go/record-deployment"
+        RECORD_UNDEPLOYMENT_HELP_URL = "https://docs.pact.io/go/record-undeployment"
+        RECORD_RELEASE_HELP_URL = "https://docs.pact.io/go/record-release"
+        RECORD_SUPPORT_ENDED_HELP_URL = "https://docs.pact.io/go/record-support-ended"
+
+
+        def self.included(thor)
+          thor.class_eval do
+            desc "record-deployment", "Record deployment of a pacticipant version to an environment. See #{RECORD_DEPLOYMENT_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 from an environment."
+            long_desc "Note that use of this command is only required if you are permanently removing an application instance from an environment. It is not required if you are deploying over a previous version, as record-deployment will automatically mark the previously deployed version as undeployed for you. See #{RECORD_UNDEPLOYMENT_HELP_URL} for more information."
+            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 #{RECORD_RELEASE_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
+
+            desc "record-support-ended", "Record the end of support for a pacticipant version in an environment. See #{RECORD_SUPPORT_ENDED_HELP_URL} for more information."
+            method_option :pacticipant, required: true, aliases: "-a", desc: "The name of the pacticipant."
+            method_option :version, required: true, aliases: "-e", desc: "The pacticipant version number for which support is ended."
+            method_option :environment, required: true, desc: "The name of the environment in which the support is ended."
+            output_option_json_or_text
+            shared_authentication_options
+
+            def record_support_ended
+              params = {
+                pacticipant_name: options.pacticipant,
+                version_number: options.version,
+                environment_name: options.environment
+              }
+              execute_deployment_command(params, "RecordSupportEnded")
+            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/matrix_commands.rb

@@ -0,0 +1,93 @@
+module PactBroker
+  module Client
+    module CLI
+      module MatrixCommands
+
+        def self.included(thor)
+          thor.class_eval do
+            desc "can-i-deploy", ""
+            long_desc File.read(File.join(__dir__, "can_i_deploy_long_desc.txt"))
+
+            method_option :pacticipant, required: true, aliases: "-a", desc: "The pacticipant name. Use once for each pacticipant being checked."
+            method_option :version, required: false, aliases: "-e", desc: "The pacticipant version. Must be entered after the --pacticipant that it relates to."
+            method_option :ignore, required: false, desc: "The pacticipant name to ignore. Use once for each pacticipant being ignored. A specific version can be ignored by also specifying a --version after the pacticipant name option."
+            method_option :latest, required: false, aliases: "-l", banner: "[TAG]", desc: "Use the latest pacticipant version. Optionally specify a TAG to use the latest version with the specified tag."
+            method_option :to, required: false, banner: "TAG", desc: "This is too hard to explain in a short sentence. Look at the examples.", default: nil
+            method_option :to_environment, required: false, banner: "ENVIRONMENT", desc: "The environment into which the pacticipant(s) are to be deployed", default: nil, hide: true
+            method_option :output, aliases: "-o", desc: "json or table", default: "table"
+            method_option :retry_while_unknown, banner: "TIMES", type: :numeric, default: 0, required: false, desc: "The number of times to retry while there is an unknown verification result (ie. the provider verification is likely still running)"
+            method_option :retry_interval, banner: "SECONDS", type: :numeric, default: 10, required: false, desc: "The time between retries in seconds. Use in conjuction with --retry-while-unknown"
+            # Allow limit to be set manually until https://github.com/pact-foundation/pact_broker-client/issues/53 is fixed
+            method_option :limit, hide: true
+            method_option :dry_run, type: :boolean, default: false, desc: "When dry-run is enabled, always exit process with a success code. Can also be enabled by setting the environment variable PACT_BROKER_CAN_I_DEPLOY_DRY_RUN=true."
+            shared_authentication_options
+
+            def can_i_deploy(*ignored_but_necessary)
+              require "pact_broker/client/cli/version_selector_options_parser"
+              require "pact_broker/client/can_i_deploy"
+
+              validate_credentials
+              selectors = VersionSelectorOptionsParser.call(ARGV).select { |s| !s[:ignore] }
+              ignore_selectors = if ENV.fetch("PACT_BROKER_FEATURES", "").include?("ignore")
+                VersionSelectorOptionsParser.call(ARGV).select { |s| s[:ignore] }
+              else
+                []
+              end
+              validate_can_i_deploy_selectors(selectors)
+              dry_run = options.dry_run || ENV["PACT_BROKER_CAN_I_DEPLOY_DRY_RUN"] == "true"
+              can_i_deploy_options = { output: options.output, retry_while_unknown: options.retry_while_unknown, retry_interval: options.retry_interval, dry_run: dry_run, verbose: options.verbose }
+              result = CanIDeploy.call(options.broker_base_url, selectors, { to_tag: options.to, to_environment: options.to_environment, limit: options.limit, ignore_selectors: ignore_selectors }, can_i_deploy_options, pact_broker_client_options)
+              $stdout.puts result.message
+              $stdout.flush
+              exit(can_i_deploy_exit_status) unless result.success
+            end
+
+            if ENV.fetch("PACT_BROKER_FEATURES", "").include?("verification_required")
+
+              method_option :pacticipant, required: true, aliases: "-a", desc: "The pacticipant name. Use once for each pacticipant being checked."
+              method_option :version, required: false, aliases: "-e", desc: "The pacticipant version. Must be entered after the --pacticipant that it relates to."
+              method_option :latest, required: false, aliases: "-l", banner: "[TAG]", desc: "Use the latest pacticipant version. Optionally specify a TAG to use the latest version with the specified tag."
+              method_option :to, required: false, banner: "TAG", desc: "This is too hard to explain in a short sentence. Look at the examples.", default: nil
+              method_option :in_environment, required: false, banner: "ENVIRONMENT", desc: "The environment into which the pacticipant(s) are to be deployed", default: nil, hide: true
+              method_option :output, aliases: "-o", desc: "json or table", default: "table"
+
+              shared_authentication_options
+              desc "verification-required", "Checks if there is a verification required between the given pacticipant versions"
+              def verification_required(*ignored_but_necessary)
+                require "pact_broker/client/cli/version_selector_options_parser"
+                require "pact_broker/client/verification_required"
+
+                validate_credentials
+                selectors = VersionSelectorOptionsParser.call(ARGV)
+                validate_can_i_deploy_selectors(selectors)
+                verification_required_options = { output: options.output, verbose: options.verbose, retry_while_unknown: 0 }
+                result = VerificationRequired.call(options.broker_base_url, selectors, { to_tag: options.to, to_environment: options.in_environment, ignore_selectors: [] }, verification_required_options, pact_broker_client_options)
+                $stdout.puts result.message
+                $stdout.flush
+                exit(1) unless result.success
+              end
+
+            end
+
+            no_commands do
+              def can_i_deploy_exit_status
+                exit_code_string = ENV.fetch("PACT_BROKER_CAN_I_DEPLOY_EXIT_CODE_BETA", "")
+                if exit_code_string =~ /^\d+$/
+                  $stderr.puts "Exiting can-i-deploy with configured exit code #{exit_code_string}"
+                  exit_code_string.to_i
+                else
+                  1
+                end
+              end
+
+              def validate_can_i_deploy_selectors selectors
+                pacticipants_without_versions = selectors.select{ |s| s[:version].nil? && s[:latest].nil? && s[:tag].nil? }.collect{ |s| s[:pacticipant] }
+                raise ::Thor::RequiredArgumentMissingError, "The version must be specified using `--version VERSION`, `--latest`, `--latest TAG`, or `--all TAG` for pacticipant #{pacticipants_without_versions.join(", ")}" if pacticipants_without_versions.any?
+              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/cli/webhook_commands.rb

@@ -0,0 +1,122 @@
+module PactBroker
+  module Client
+    module CLI
+      # Thor::Error will have its backtrace hidden
+      class WebhookCreationError < ::Thor::Error; end
+
+      module WebhookCommands
+        def self.included(thor)
+          thor.class_eval do
+
+            no_commands do
+              def self.shared_options_for_webhook_commands
+                method_option :request, banner: "METHOD", aliases: "-X", desc: "Webhook HTTP method", required: true
+                method_option :header, aliases: "-H", type: :array, desc: "Webhook Header"
+                method_option :data, aliases: "-d", desc: "Webhook payload (file or string)"
+                method_option :user, aliases: "-u", desc: "Webhook basic auth username and password eg. username:password"
+                method_option :consumer, desc: "Consumer name"
+                method_option :provider, desc: "Provider name"
+                method_option :description, desc: "Webhook description"
+                method_option :contract_content_changed, type: :boolean, desc: "Trigger this webhook when the pact content changes"
+                method_option :contract_published, type: :boolean, desc: "Trigger this webhook when a pact is published"
+                method_option :provider_verification_published, type: :boolean, desc: "Trigger this webhook when a provider verification result is published"
+                method_option :provider_verification_failed, type: :boolean, desc: "Trigger this webhook when a failed provider verification result is published"
+                method_option :provider_verification_succeeded, type: :boolean, desc: "Trigger this webhook when a successful provider verification result is published"
+                method_option :team_uuid, banner: "UUID", desc: "UUID of the Pactflow team to which the webhook should be assigned (Pactflow only)"
+                shared_authentication_options
+              end
+            end
+
+            shared_options_for_webhook_commands
+
+            desc 'create-webhook URL', 'Creates a webhook using the same switches as a curl request.'
+            long_desc File.read(File.join(File.dirname(__FILE__), 'create_webhook_long_desc.txt'))
+            def create_webhook webhook_url
+              run_webhook_commands webhook_url
+            end
+
+            shared_options_for_webhook_commands
+            method_option :uuid, type: :string, required: true, desc: "Specify the uuid for the webhook"
+
+            desc 'create-or-update-webhook URL', 'Creates or updates a webhook with a provided uuid and using the same switches as a curl request.'
+            long_desc File.read(File.join(File.dirname(__FILE__), 'create_or_update_webhook_long_desc.txt'))
+            def create_or_update_webhook webhook_url
+              run_webhook_commands webhook_url
+            end
+
+            desc 'test-webhook', 'Test the execution of a webhook'
+            method_option :uuid, type: :string, required: true, desc: "Specify the uuid for the webhook"
+            shared_authentication_options
+            def test_webhook
+              require 'pact_broker/client/webhooks/test'
+              result = PactBroker::Client::Webhooks::Test.call(options, pact_broker_client_options)
+              $stdout.puts result.message
+            end
+
+            no_commands do
+
+              def parse_webhook_events
+                events = []
+                events << 'contract_content_changed' if options.contract_content_changed
+                events << 'contract_published' if options.contract_published
+                events << 'provider_verification_published' if options.provider_verification_published
+                events << 'provider_verification_succeeded' if options.provider_verification_succeeded
+                events << 'provider_verification_failed' if options.provider_verification_failed
+                events
+              end
+
+              def parse_webhook_options(webhook_url)
+                events = parse_webhook_events
+
+                if events.size == 0
+                  raise WebhookCreationError.new("You must specify at least one of --contract-content-changed, --contract-published, --provider-verification-published, --provider-verification-succeeded or --provider-verification-failed")
+                end
+
+                username = options.user ? options.user.split(":", 2).first : nil
+                password = options.user ? options.user.split(":", 2).last : nil
+
+                headers = (options.header || []).each_with_object({}) { | header, headers | headers[header.split(":", 2).first.strip] = header.split(":", 2).last.strip }
+
+                body = options.data
+                if body && body.start_with?("@")
+                  filepath = body[1..-1]
+                  begin
+                    body = File.read(filepath)
+                  rescue StandardError => e
+                    raise WebhookCreationError.new("Couldn't read data from file \"#{filepath}\" due to #{e.class} #{e.message}")
+                  end
+                end
+
+                {
+                  uuid: options.uuid,
+                  description: options.description,
+                  http_method: options.request,
+                  url: webhook_url,
+                  headers: headers,
+                  username: username,
+                  password: password,
+                  body: body,
+                  consumer: options.consumer,
+                  provider: options.provider,
+                  events: events,
+                  team_uuid: options.team_uuid
+                }
+              end
+
+              def run_webhook_commands webhook_url
+                require 'pact_broker/client/webhooks/create'
+
+                validate_credentials
+                result = PactBroker::Client::Webhooks::Create.call(parse_webhook_options(webhook_url), options.broker_base_url, pact_broker_client_options)
+                $stdout.puts result.message
+                exit(1) unless result.success
+              rescue PactBroker::Client::Error => e
+                raise WebhookCreationError, "#{e.class} - #{e.message}"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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"
+require "pact_broker/client/deployments/record_support_ended"

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