pact_broker-client 1.44.0 → 1.47.1

data/doc/pacts/markdown/Pact Broker Client - Pactflow.md

@@ -0,0 +1,94 @@
+### A pact between Pact Broker Client and Pactflow
+
+#### Requests from Pact Broker Client to Pactflow
+
+* [A request for the index resource](#a_request_for_the_index_resource)
+
+* [A request to create a webhook for a team](#a_request_to_create_a_webhook_for_a_team_given_a_team_with_UUID_2abbc12a-427d-432a-a521-c870af1739d9_exists) given a team with UUID 2abbc12a-427d-432a-a521-c870af1739d9 exists
+
+#### Interactions
+
+<a name="a_request_for_the_index_resource"></a>
+Upon receiving **a request for the index resource** from Pact Broker Client, with
+```json
+{
+  "method": "get",
+  "path": "/",
+  "headers": {
+    "Accept": "application/hal+json"
+  }
+}
+```
+Pactflow will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "_links": {
+      "pb:webhooks": {
+        "href": "http://localhost:1235/HAL-REL-PLACEHOLDER-PB-WEBHOOKS"
+      },
+      "pb:pacticipants": {
+        "href": "http://localhost:1235/HAL-REL-PLACEHOLDER-PB-PACTICIPANTS"
+      },
+      "pb:pacticipant": {
+        "href": "http://localhost:1235/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-{pacticipant}"
+      }
+    }
+  }
+}
+```
+<a name="a_request_to_create_a_webhook_for_a_team_given_a_team_with_UUID_2abbc12a-427d-432a-a521-c870af1739d9_exists"></a>
+Given **a team with UUID 2abbc12a-427d-432a-a521-c870af1739d9 exists**, upon receiving **a request to create a webhook for a team** from Pact Broker Client, with
+```json
+{
+  "method": "post",
+  "path": "/HAL-REL-PLACEHOLDER-PB-WEBHOOKS",
+  "headers": {
+    "Content-Type": "application/json",
+    "Accept": "application/hal+json"
+  },
+  "body": {
+    "description": "a webhook",
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
+    "request": {
+      "url": "https://webhook",
+      "method": "POST",
+      "headers": {
+        "Foo": "bar",
+        "Bar": "foo"
+      },
+      "body": {
+        "some": "body"
+      }
+    },
+    "teamUuid": "2abbc12a-427d-432a-a521-c870af1739d9"
+  }
+}
+```
+Pactflow will respond with:
+```json
+{
+  "status": 201,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "description": "a webhook",
+    "teamUuid": "2abbc12a-427d-432a-a521-c870af1739d9",
+    "_links": {
+      "self": {
+        "href": "http://localhost:1234/some-url",
+        "title": "A title"
+      }
+    }
+  }
+}
+```

data/doc/pacts/markdown/README.md

@@ -1,3 +1,4 @@
 ### Pacts for Pact Broker Client
 
 * [Pact Broker](Pact%20Broker%20Client%20-%20Pact%20Broker.md)
+* [Pactflow](Pact%20Broker%20Client%20-%20Pactflow.md)

data/lib/pact_broker/client/base_command.rb

@@ -65,6 +65,9 @@ module PactBroker
         { error: error_hash }.to_json
       end
 
+      def error_message_as_json(message)
+        { error: { message: message } }.to_json
+      end
 
       def text_error_message(e, include_backtrace)
         maybe_backtrace = (include_backtrace ? "\n" + e.backtrace.join("\n") : "")

data/lib/pact_broker/client/can_i_deploy.rb

@@ -33,9 +33,9 @@ module PactBroker
       def call
         create_result(fetch_matrix_with_retries)
       rescue PactBroker::Client::Error => e
-        Result.new(false, Term::ANSIColor.red(e.message))
+        Result.new(dry_run_or_false, for_dry_run(Term::ANSIColor.red(e.message)))
       rescue StandardError => e
-        Result.new(false, "Error retrieving matrix. #{e.class} - #{e.message}\n#{e.backtrace.join("\n")}")
+        Result.new(dry_run_or_false, for_dry_run(Term::ANSIColor.red("Error retrieving matrix. #{e.class} - #{e.message}") + "\n#{e.backtrace.join("\n")}"))
       end
 
       private
@@ -46,14 +46,15 @@ module PactBroker
         if matrix.deployable?
           Result.new(true, success_message(matrix))
         else
-          Result.new(false, failure_message(matrix))
+          Result.new(dry_run_or_false, failure_message(matrix))
         end
       end
 
       def success_message(matrix)
         message = format_matrix(matrix)
         if format != 'json'
-          message = warning(matrix) + Term::ANSIColor.green('Computer says yes \o/ ') + message + "\n\n" + notice_or_reason(matrix, :green)
+          message = warning(matrix) + computer_says(true) + message + "\n\n" + notice_or_reason(matrix, :green)
+          message = for_dry_run(message)
         end
         message
       end
@@ -61,11 +62,28 @@ module PactBroker
       def failure_message(matrix)
         message = format_matrix(matrix)
         if format != 'json'
-          message = warning(matrix) + Term::ANSIColor.red('Computer says no ¯\_(ツ)_/¯ ') + message + "\n\n" + notice_or_reason(matrix, :red)
+          message = warning(matrix) + computer_says(false) + message + "\n\n" + notice_or_reason(matrix, :red)
+          message = for_dry_run(message)
         end
         message
       end
 
+      def computer_says(success)
+        if success
+          if dry_run?
+            "Computer says yes \\o/ (and maybe you don't need to enable dry run)"
+          else
+            Term::ANSIColor.green('Computer says yes \o/ ')
+          end
+        else
+          if dry_run?
+            "Computer says no ¯\\_(ツ)_/¯ (but you're ignoring this by enabling dry run)"
+          else
+            Term::ANSIColor.red("Computer says no ¯\_(ツ)_/¯")
+          end
+        end
+      end
+
       def notice_or_reason(matrix, reason_color)
         if matrix.notices
           PactBroker::Client::ColorizeNotices.call(matrix.notices).join("\n")
@@ -114,6 +132,23 @@ module PactBroker
         options[:retry_while_unknown] > 0
       end
 
+      def dry_run?
+        options[:dry_run]
+      end
+
+      def dry_run_or_false
+        dry_run? || false
+      end
+
+      def for_dry_run(lines)
+        if dry_run?
+          prefix = Term::ANSIColor.yellow("[dry-run] ")
+          lines.split("\n").collect { |line| prefix + Term::ANSIColor.uncolor(line) }.join("\n") + "\n" + prefix + "\n" + prefix + Term::ANSIColor.green("Dry run enabled - ignoring any failures")
+        else
+          lines
+        end
+      end
+
       def retry_options
         {
           condition: lambda { |matrix| !matrix.any_unknown?  },

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

@@ -4,59 +4,25 @@ require 'thor/error'
 require 'pact_broker/client/cli/environment_commands'
 require 'pact_broker/client/cli/deployment_commands'
 require 'pact_broker/client/cli/pacticipant_commands'
+require 'pact_broker/client/cli/webhook_commands'
+require "pact_broker/client/cli/matrix_commands"
 
 module PactBroker
   module Client
     module CLI
       # Thor::Error will have its backtrace hidden
       class PactPublicationError < ::Thor::Error; end
-      class WebhookCreationError < ::Thor::Error; end
       class AuthError < ::Thor::Error; end
       class VersionCreationError < ::Thor::Error; end
 
       class Broker < CustomThor
         using PactBroker::Client::HashRefinements
-        if ENV.fetch("PACT_BROKER_FEATURES", "").include?("deployments")
-          include PactBroker::Client::CLI::EnvironmentCommands
-          include PactBroker::Client::CLI::DeploymentCommands
-        end
-        include PactBroker::Client::CLI::PacticipantCommands
-
-
-        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
-        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)
-          can_i_deploy_options = { output: options.output, retry_while_unknown: options.retry_while_unknown, retry_interval: options.retry_interval }
-          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
+        include PactBroker::Client::CLI::EnvironmentCommands
+        include PactBroker::Client::CLI::DeploymentCommands
+        include PactBroker::Client::CLI::MatrixCommands
+        include PactBroker::Client::CLI::PacticipantCommands
+        include PactBroker::Client::CLI::WebhookCommands
 
         desc 'publish PACT_DIRS_OR_FILES ...', "Publish pacts to a Pact Broker."
         method_option :consumer_app_version, required: true, aliases: "-a", desc: "The consumer application version"
@@ -129,31 +95,7 @@ module PactBroker
           exit(1) unless result.success
         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
 
         ignored_and_hidden_potential_options_from_environment_variables
         desc 'generate-uuid', 'Generate a UUID for use when calling create-or-update-webhook'
@@ -187,16 +129,6 @@ module PactBroker
             true
           end
 
-          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_credentials
             if options.broker_username && options.broker_token
               raise AuthError, "You cannot provide both a username/password and a bearer token. If your Pact Broker uses a bearer token, please remove the username and password configuration."
@@ -209,10 +141,6 @@ module PactBroker
             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
 
           def publish_pacts pact_files
             require 'pact_broker/client/publish_pacts'
@@ -295,64 +223,6 @@ module PactBroker
 
             client_options.compact
           end
-
-          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
-            }
-          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

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

@@ -91,22 +91,6 @@ module PactBroker
             method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
           end
 
-          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: "Wwebhook 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"
-            shared_authentication_options
-          end
-
           def self.verbose_option
             method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
           end

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

@@ -2,11 +2,15 @@ module PactBroker
   module Client
     module CLI
       module DeploymentCommands
-        HELP_URL = "https://docs.pact.io/pact_broker/recording_deployments_and_releases/"
+        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 #{HELP_URL} for more information."
+            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."
@@ -24,8 +28,8 @@ module PactBroker
               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."
+            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."
@@ -41,7 +45,7 @@ module PactBroker
               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."
+            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."
@@ -57,6 +61,22 @@ module PactBroker
               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'