pact_broker-client 1.51.1 → 1.54.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2e9f7e405595ad05502d071f02a3af96cb551acac1e2431b046a59b3253ebde
-  data.tar.gz: d8ff809310b56b9a1f8c7ffc104c2da5690c84973b08f536860eacfde45bbfce
+  metadata.gz: 9478634ba01370a4d9cfff8a54ae4165a95b5525258795e57d3da002b6ca510f
+  data.tar.gz: 3ca1944dacbff6fcf88c718d5ec7c4a85e3d2b764492024aca504c4dd5b02235
 SHA512:
-  metadata.gz: eb977bc1fe55c901c704293e3046d52e39a2a30cef55282e03c6c4afa1f3f6bb06adf038686a871a8d8df1675415136ba8b2eaa79d4bc02449a6b52fde2aca85
-  data.tar.gz: 6b650d970bfa921d83a160051c765f8e82d140017a32b32f1b145454f2023829ce1ebfc3dd30102d51f136e80731f5b251cc9bb9d6b0c47f5371586cd7fd19a5
+  metadata.gz: fddb34d2ce7a559323ab51b90dabb2c003f731e8dc8b5666b9531fb7fc689452f54fc9d273d1c894cc398a36168817b8ab46ceba112975075660f935d6700292
+  data.tar.gz: b2e377f2f4e823699847f1be5e366b0c95a5ad9cbff7e37b6e149e6eb510b1c1826b0bd0cdd8ed186adaaac7c0001dd4b982222cfeb38b2f38a3bd15b4f0c1c6

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+<a name="v1.54.0"></a>
+### v1.54.0 (2021-10-01)
+
+#### Features
+
+* disable SSL verification for HAL client and HTTParty client when environment variable PACT_DISABLE_SSL_VERIFICATION=true	 ([470aafa](/../../commit/470aafa))
+* support setting the --main-branch for a pacticipant	 ([1f18e70](/../../commit/1f18e70))
+
+<a name="v1.53.0"></a>
+### v1.53.0 (2021-09-29)
+
+#### Features
+
+* allow pacts to be published using the old API by setting the environment variable PACT_BROKER_FEATURES=publish_pacts_using_old_api	 ([7c34132](/../../commit/7c34132))
+
+<a name="v1.52.0"></a>
+### v1.52.0 (2021-09-29)
+
+#### Features
+
+* rename target to application-instance for record-deployment and record-undeployment (backwards compatible)	 ([53d23eb](/../../commit/53d23eb))
+
+<a name="v1.51.2"></a>
+### v1.51.2 (2021-09-27)
+
+#### Bug Fixes
+
+* **deps**
+  * lock httparty to 0.18.1	 ([1ab2d9c](/../../commit/1ab2d9c))
+
 <a name="v1.51.1"></a>
 ### v1.51.1 (2021-09-22)
 

data/README.md

@@ -275,29 +275,33 @@ Usage:
   pact-broker record-deployment --environment=ENVIRONMENT -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BROKER_BASE_URL -e, --version=VERSION
 
 Options:
-  -a, --pacticipant=PACTICIPANT            
+  -a, --pacticipant=PACTICIPANT                      
               # The name of the pacticipant that was deployed.
-  -e, --version=VERSION                    
+  -e, --version=VERSION                              
               # The pacticipant version number that was deployed.
-      --environment=ENVIRONMENT            
+      --environment=ENVIRONMENT                      
               # The name of the environment that the pacticipant version was
                 deployed to.
-      [--target=TARGET]                    
-              # 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.
-  -o, [--output=OUTPUT]                    
+      [--application-instance=APPLICATION_INSTANCE]  
+              # Optional. The application instance to which the deployment has
+                occurred - a logical identifer required to differentiate
+                deployments when there are multiple instances of the same
+                application in an environment. This field was called 'target'
+                in a beta release.
+      [--target=TARGET]                              
+              # Renamed to application_instance
+  -o, [--output=OUTPUT]                              
               # json or text
               # Default: text
-  -b, --broker-base-url=BROKER_BASE_URL    
+  -b, --broker-base-url=BROKER_BASE_URL              
               # The base URL of the Pact Broker
-  -u, [--broker-username=BROKER_USERNAME]  
+  -u, [--broker-username=BROKER_USERNAME]            
               # Pact Broker basic auth username
-  -p, [--broker-password=BROKER_PASSWORD]  
+  -p, [--broker-password=BROKER_PASSWORD]            
               # Pact Broker basic auth password
-  -k, [--broker-token=BROKER_TOKEN]        
+  -k, [--broker-token=BROKER_TOKEN]                  
               # Pact Broker bearer token
-  -v, [--verbose], [--no-verbose]          
+  -v, [--verbose], [--no-verbose]                    
               # Verbose output. Default: false
 ```
 
@@ -310,28 +314,34 @@ Usage:
   pact-broker record-undeployment --environment=ENVIRONMENT -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BROKER_BASE_URL
 
 Options:
-  -a, --pacticipant=PACTICIPANT            
+  -a, --pacticipant=PACTICIPANT                      
               # The name of the pacticipant that was undeployed.
-      --environment=ENVIRONMENT            
+      --environment=ENVIRONMENT                      
               # The name of the environment that the pacticipant version was
                 undeployed from.
-      [--target=TARGET]                    
+      [--application-instance=APPLICATION_INSTANCE]  
+              # Optional. The application instance from which the application
+                is being undeployed - a logical identifer required to
+                differentiate deployments when there are multiple instances of
+                the same application in an environment. This field was called
+                'target' in a beta release.
+      [--target=TARGET]                              
               # 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.
-  -o, [--output=OUTPUT]                    
+  -o, [--output=OUTPUT]                              
               # json or text
               # Default: text
-  -b, --broker-base-url=BROKER_BASE_URL    
+  -b, --broker-base-url=BROKER_BASE_URL              
               # The base URL of the Pact Broker
-  -u, [--broker-username=BROKER_USERNAME]  
+  -u, [--broker-username=BROKER_USERNAME]            
               # Pact Broker basic auth username
-  -p, [--broker-password=BROKER_PASSWORD]  
+  -p, [--broker-password=BROKER_PASSWORD]            
               # Pact Broker basic auth password
-  -k, [--broker-token=BROKER_TOKEN]        
+  -k, [--broker-token=BROKER_TOKEN]                  
               # Pact Broker bearer token
-  -v, [--verbose], [--no-verbose]          
+  -v, [--verbose], [--no-verbose]                    
               # Verbose output. Default: false
 ```
 
@@ -469,8 +479,8 @@ Description:
   support for environments, deployments and releases. For documentation on how to use can-i-deploy with tags, please see
   https://docs.pact.io/pact_broker/client_cli/can_i_deploy_usage_with_tags/
 
-  Before `can-i-deploy` can be used, the relevant environment resources must first be created in the Pact Broker using the `create-environment` command. The "test"
-  and "production" environments will have been seeded for you. You can check the existing environments by running `pact-broker list-environments`. See
+  Before `can-i-deploy` can be used, the relevant environment resources must first be created in the Pact Broker using the `create-environment` command. The
+  "test" and "production" environments will have been seeded for you. You can check the existing environments by running `pact-broker list-environments`. See
   https://docs.pact.io/pact_broker/client_cli/readme#environments for more information.
 
   $ pact-broker create-environment --name "uat" --display-name "UAT" --no-production
@@ -480,8 +490,8 @@ Description:
 
   $ pact-broker record-deployment --pacticipant Foo --version 173153ae0 --environment uat
 
-  Before an application is deployed or released to an environment, the can-i-deploy command must be run to check that the application version is safe to deploy with
-  the versions of each integrated application that are already in that environment.
+  Before an application is deployed or released to an environment, the can-i-deploy command must be run to check that the application version is safe to deploy
+  with the versions of each integrated application that are already in that environment.
 
   $ pact-broker can-i-deploy --pacticipant PACTICIPANT --version VERSION --to-environment ENVIRONMENT
 
@@ -489,8 +499,8 @@ Description:
 
   $ pact-broker can-i-deploy --pacticipant Foo --version 173153ae0 --to-environment test
 
-  Can-i-deploy can also be used to check if arbitrary versions have a successful verification. When asking "Can I deploy this application version with the latest version
-  from the main branch of another application" it functions as a "can I merge" check.
+  Can-i-deploy can also be used to check if arbitrary versions have a successful verification. When asking "Can I deploy this application version with the
+  latest version from the main branch of another application" it functions as a "can I merge" check.
 
   $ pact-broker can-i-deploy --pacticipant Foo 173153ae0 \ --pacticipant Bar --latest main
 
@@ -507,6 +517,8 @@ Options:
               # Pacticipant name
       [--display-name=DISPLAY_NAME]        
               # Display name
+      [--main-branch=MAIN_BRANCH]          
+              # The main development branch of the pacticipant repository
       [--repository-url=REPOSITORY_URL]    
               # The repository URL of the pacticipant
   -o, [--output=OUTPUT]                    
@@ -628,8 +640,8 @@ Options:
 ```
 
 Description:
-  Create a curl command that executes the request that you want your webhook to execute, then replace "curl" with "pact-broker create-webhook" and add the consumer,
-  provider, event types and broker details. Note that the URL must be the first parameter when executing create-webhook.
+  Create a curl command that executes the request that you want your webhook to execute, then replace "curl" with "pact-broker create-webhook" and add the
+  consumer, provider, event types and broker details. Note that the URL must be the first parameter when executing create-webhook.
 
   Note that the -u option from the curl command clashes with the -u option from the pact-broker CLI. When used in this command, the -u will be used as a curl
   option. Please use the --broker-username or environment variable for the Pact Broker username.
@@ -686,9 +698,9 @@ Options:
 ```
 
 Description:
-  Create a curl command that executes the request that you want your webhook to execute, then replace "curl" with "pact-broker create-or-update-webhook" and add the
-  consumer, provider, event types and broker details. Note that the URL must be the first parameter when executing create-or-update-webhook and a uuid must
-  also be provided. You can generate a valid UUID by using the `generate-uuid` command.
+  Create a curl command that executes the request that you want your webhook to execute, then replace "curl" with "pact-broker create-or-update-webhook" and
+  add the consumer, provider, event types and broker details. Note that the URL must be the first parameter when executing create-or-update-webhook and a uuid
+  must also be provided. You can generate a valid UUID by using the `generate-uuid` command.
 
   Note that the -u option from the curl command clashes with the -u option from the pact-broker CLI. When used in this command, the -u will be used as a curl
   option. Please use the --broker-username or environment variable for the Pact Broker username.

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

@@ -2129,6 +2129,7 @@ Given **version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exis
     "Accept": "application/hal+json"
   },
   "body": {
+    "applicationInstance": "blue",
     "target": "blue"
   }
 }

data/lib/pact_broker/client/base_client.rb

@@ -54,6 +54,8 @@ module PactBroker
         self.class.headers('Authorization' => "Bearer #{client_options[:token]}") if client_options[:token]
         self.class.ssl_ca_file(ENV['SSL_CERT_FILE']) if ENV['SSL_CERT_FILE'] && ENV['SSL_CERT_FILE'] != ''
         self.class.ssl_ca_path(ENV['SSL_CERT_DIR']) if ENV['SSL_CERT_DIR'] && ENV['SSL_CERT_DIR'] != ''
+        @default_options = {}
+        @default_options[:verify] = false if (ENV['PACT_DISABLE_SSL_VERIFICATION'] == 'true' || ENV['PACT_BROKER_DISABLE_SSL_VERIFICATION'] == 'true')
       end
 
       def default_request_headers
@@ -102,15 +104,15 @@ module PactBroker
       end
 
       def patch url, options
-        self.class.patch(url, options.merge(body: options[:body].to_json))
+        self.class.patch(url, @default_options.merge(options.merge(body: options[:body].to_json)))
       end
 
-      def put url, *args
-        self.class.put(url, *args)
+      def put url, options = {}, &block
+        self.class.put(url, @default_options.merge(options), &block)
       end
 
-      def get url, *args
-        self.class.get(url, *args)
+      def get url, options = {}, &block
+        self.class.get(url, @default_options.merge(options), &block)
       end
 
       def url_for_relation relation_name, params

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

@@ -14,16 +14,18 @@ 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 :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 :application_instance, default: nil, required: false, desc: "Optional. The application instance to which the deployment has occurred - a logical identifer required to differentiate deployments when there are multiple instances of the same application in an environment. This field was called 'target' in a beta release."
+            method_option :target, hidden: true, default: nil, required: false, desc: "Renamed to application_instance"
             output_option_json_or_text
             shared_authentication_options
 
             def record_deployment
+              $stderr.puts("WARN: target has been renamed to application-instance") if options.target
               params = {
                 pacticipant_name: options.pacticipant,
                 version_number: options.version,
                 environment_name: options.environment,
-                target: options.target
+                application_instance: options.application_instance || options.target
               }
               execute_deployment_command(params, "RecordDeployment")
             end
@@ -32,15 +34,17 @@ module PactBroker
             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 :application_instance, default: nil, required: false, desc: "Optional. The application instance from which the application is being undeployed - a logical identifer required to differentiate deployments when there are multiple instances of the same application in an environment. This field was called 'target' in a beta release."
             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
+              $stderr.puts("WARN: target has been renamed to application-instance") if options.target
               params = {
                 pacticipant_name: options.pacticipant,
                 environment_name: options.environment,
-                target: options.target
+                application_instance: options.application_instance || options.target
               }
               execute_deployment_command(params, "RecordUndeployment")
             end

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

@@ -2,13 +2,14 @@ module PactBroker
   module Client
     module CLI
       module PacticipantCommands
-        PACTICIPANT_PARAM_NAMES = [:name, :display_name, :repository_url]
+        PACTICIPANT_PARAM_NAMES = [:name, :display_name, :main_branch, :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 :main_branch, type: :string, required: false, desc: "The main development branch of the pacticipant repository"
             method_option :repository_url, type: :string, required: false, desc: "The repository URL of the pacticipant"
             output_option_json_or_text
             shared_authentication_options

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

@@ -6,12 +6,12 @@ module PactBroker
       class RecordDeployment < PactBroker::Client::Deployments::RecordRelease
         def initialize(params, options, pact_broker_client_options)
           super
-          @target = params.fetch(:target)
+          @application_instance = params.fetch(:application_instance)
         end
 
         private
 
-        attr_reader :target
+        attr_reader :application_instance
 
         def action
           "deployment"
@@ -22,12 +22,13 @@ module PactBroker
         end
 
         def record_action_request_body
-          { target: target }.compact
+          # for backwards compatibility with old broker
+          { applicationInstance: application_instance, target: application_instance }.compact
         end
 
         def result_text_message
-          if target
-            "#{super} (target #{target})"
+          if application_instance
+            "#{super} (application instance #{application_instance})"
           else
             super
           end

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

@@ -8,7 +8,7 @@ module PactBroker
           super
           @pacticipant_name = params.fetch(:pacticipant_name)
           @environment_name = params.fetch(:environment_name)
-          @target = params.fetch(:target)
+          @application_instance = params.fetch(:application_instance)
         end
 
         private
@@ -21,7 +21,7 @@ module PactBroker
           end
         end
 
-        attr_reader :pacticipant_name, :environment_name, :target
+        attr_reader :pacticipant_name, :environment_name, :application_instance
 
         def currently_deployed_versions_link
           environment_resource._link("pb:currently-deployed-deployed-versions", "pb:currently-deployed-versions") or raise PactBroker::Client::Error.new(not_supported_message)
@@ -31,14 +31,19 @@ module PactBroker
           @deployed_version_links ||= currently_deployed_versions_link.get!(pacticipant: pacticipant_name).embedded_entities!("deployedVersions")
         end
 
-        def currently_deployed_version_entities_for_pacticipant_and_target
+        def currently_deployed_version_entities_for_pacticipant_and_instance
           currently_deployed_version_entities_for_pacticipant.select do | entity |
-            entity.target == target
+            if application_instance
+              entity.applicationInstance == application_instance || entity.target == application_instance
+            else
+              entity.applicationInstance == nil && entity.target == nil
+            end
+
           end
         end
 
         def undeployed_versions_resources
-          @undeployed_versions_resources ||= currently_deployed_version_entities_for_pacticipant_and_target.collect do | entity |
+          @undeployed_versions_resources ||= currently_deployed_version_entities_for_pacticipant_and_instance.collect do | entity |
             entity._link!("self").patch(currentlyDeployed: false)
           end
         end
@@ -75,7 +80,7 @@ module PactBroker
           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 = "#{message} (application instance #{application_instance})" if application_instance
           message
         end
 
@@ -92,19 +97,22 @@ module PactBroker
             "No pacticipant with name '#{pacticipant_name}' found."
           else
             if currently_deployed_version_entities_for_pacticipant.any?
-              target_does_not_match_message
+              application_instance_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(", ")}"
+        def application_instance_does_not_match_message
+          potential_application_instances = currently_deployed_version_entities_for_pacticipant.collect{|e| e.applicationInstance || e.target }
+
+          if application_instance
+            omit_text = potential_application_instances.include?(nil) ? "omit the application instance to undeploy from the anonymous instance" : nil
+            specify_text = potential_application_instances.compact.any? ? "specify one of the following application instances to record the undeployment from: #{potential_application_instances.compact.join(", ")}" : nil
+            "#{pacticipant_name} is not currently deployed to application instance '#{application_instance}' in #{environment_name} environment. Please #{[omit_text, specify_text].compact.join(" or ")}."
           else
-            "Please specify one of the following targets to record the undeployment from: #{potential_targets.join(", ")}"
+            "Please specify one of the following application instances to record the undeployment from: #{potential_application_instances.compact.join(", ")}"
           end
         end
 

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

@@ -2,6 +2,7 @@ require 'pact_broker/client/retry'
 require 'pact_broker/client/hal/authorization_header_redactor'
 require 'net/http'
 require 'json'
+require 'openssl'
 
 module PactBroker
   module Client
@@ -62,13 +63,19 @@ module PactBroker
         def perform_request request, uri
           response = until_truthy_or_max_times(condition: ->(resp) { resp.code.to_i < 500 }) do
             http = Net::HTTP.new(uri.host, uri.port, :ENV)
-            http.set_debug_output(output_stream) if verbose
+            http.set_debug_output(output_stream) if verbose?
             http.use_ssl = (uri.scheme == 'https')
             # Need to manually set the ca_file and ca_path for the pact-ruby-standalone.
             # The env vars seem to be picked up automatically in later Ruby versions.
             # See https://github.com/pact-foundation/pact-ruby-standalone/issues/57
             http.ca_file = ENV['SSL_CERT_FILE'] if ENV['SSL_CERT_FILE'] && ENV['SSL_CERT_FILE'] != ''
             http.ca_path = ENV['SSL_CERT_DIR'] if ENV['SSL_CERT_DIR'] && ENV['SSL_CERT_DIR'] != ''
+            if disable_ssl_verification?
+              if verbose?
+                $stdout.puts("SSL verification is disabled")
+              end
+              http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+            end
             http.start do |http|
               http.request request
             end
@@ -115,6 +122,14 @@ module PactBroker
           AuthorizationHeaderRedactor.new($stdout)
         end
 
+        def verbose?
+          verbose || ENV["VERBOSE"] == "true"
+        end
+
+        def disable_ssl_verification?
+          ENV['PACT_DISABLE_SSL_VERIFICATION'] == 'true' || ENV['PACT_BROKER_DISABLE_SSL_VERIFICATION'] == 'true'
+        end
+
         class Response < SimpleDelegator
           def body
             bod = raw_body

data/lib/pact_broker/client/pacticipants/create.rb

@@ -38,7 +38,8 @@ module PactBroker
           {
             name: params[:name],
             repositoryUrl: params[:repository_url],
-            displayName: params[:display_name]
+            displayName: params[:display_name],
+            mainBranch: params[:main_branch]
           }.compact
         end
       end

data/lib/pact_broker/client/publish_pacts.rb

@@ -28,7 +28,7 @@ module PactBroker
 
       def call
         validate
-        if index_resource.can?("pb:publish-contracts")
+        if !force_use_old_api? && index_resource.can?("pb:publish-contracts")
           publish_pacts
           PactBroker::Client::CommandResult.new(success?, message)
         else
@@ -40,6 +40,10 @@ module PactBroker
 
       attr_reader :pact_broker_base_url, :pact_file_paths, :consumer_version_params, :consumer_version_number, :branch, :tags, :build_url, :options, :pact_broker_client_options, :response_entities
 
+      def force_use_old_api?
+        ENV.fetch("PACT_BROKER_FEATURES", "").include?("publish_pacts_using_old_api")
+      end
+
       def request_body_for(consumer_name)
         {
           pacticipantName: consumer_name,

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.51.1'
+    VERSION = '1.54.0'
   end
 end

data/pact-broker-client.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.license       = 'MIT'
 
-  gem.add_runtime_dependency 'httparty', '~>0.18'
+  gem.add_runtime_dependency 'httparty', '~>0.18.1' # https://github.com/jnunemaker/httparty/issues/733
   gem.add_runtime_dependency 'term-ansicolor', '~> 1.7'
   gem.add_runtime_dependency 'table_print', '~> 1.5'
   gem.add_runtime_dependency 'thor', '>= 0.20', '< 2.0'

data/script/publish-pact.sh

@@ -1,5 +1,6 @@
 export PACT_BROKER_BASE_URL="http://localhost:9292"
 export PACT_BROKER_TOKEN="localhost"
+#export PACT_BROKER_FEATURES=publish_pacts_using_old_api
 
 # bundle exec bin/pact-broker create-or-update-webhook http://localhost:9393 \
 #   --uuid d40f38c3-aaa3-47f5-9161-95c07bc16b14 \

data/script/record-deployments-and-releases.sh

@@ -8,9 +8,19 @@ bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --en
 bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test --target customer-1
 bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test --target customer-1
 
+bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test --target customer-2
 bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test
 bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test
 bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test --target customer-1
 
 bundle exec bin/pact-broker record-release --pacticipant Foo --version 2 --environment test
-bundle exec bin/pact-broker record-support-ended --pacticipant Foo --version 2 --environment test
+bundle exec bin/pact-broker record-support-ended --pacticipant Foo --version 2 --environment test
+
+bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test
+bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test --application-instance customer-1
+bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test --application-instance customer-1
+
+bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test --application-instance customer-2
+bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test
+bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test
+bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test --application-instance customer-1

data/spec/lib/pact_broker/client/deployments/record_deployment_spec.rb

@@ -61,14 +61,14 @@ module PactBroker
               to_return(status: 200, body: record_deployment_body_hash.to_json , headers: {})
           end
 
-          let(:target) { "blue" }
+          let(:application_instance) { "blue" }
 
           let(:params) do
             {
               pacticipant_name: "Foo",
               version_number: "1",
               environment_name: "test",
-              target: target
+              application_instance: application_instance
             }
           end
 
@@ -186,13 +186,13 @@ module PactBroker
             end
 
             it "indicates the API was Pactflow" do
-              expect(subject.message).to include "Recorded deployment of Foo version 1 to test environment (target blue) in Pactflow"
+              expect(subject.message).to include "Recorded deployment of Foo version 1 to test environment (application instance blue) in Pactflow"
             end
 
-            context "when target is nil" do
-              let(:target) { nil }
+            context "when application_instance is nil" do
+              let(:application_instance) { nil }
 
-              it "does not include the target in the result message" do
+              it "does not include the application_instance in the result message" do
                 expect(subject.message).to include "Recorded deployment of Foo version 1 to test environment in"
               end
             end

data/spec/lib/pact_broker/client/deployments/record_undeployment_spec.rb

@@ -7,11 +7,11 @@ module PactBroker
         let(:params) do
           {
             pacticipant_name: "Foo",
-            target: target,
+            application_instance: application_instance,
             environment_name: "test"
           }
         end
-        let(:target) { "customer-1" }
+        let(:application_instance) { "customer-1" }
         let(:output) { "text" }
         let(:options) { { output: output, verbose: true } }
         let(:pact_broker_base_url) { "http://broker" }
@@ -131,7 +131,7 @@ module PactBroker
         subject { RecordUndeployment.call(params, options, pact_broker_client_options) }
 
         its(:success) { is_expected.to eq true }
-        its(:message) { is_expected.to include "Recorded undeployment of Foo version 2 from test environment (target customer-1) in the Pact Broker" }
+        its(:message) { is_expected.to include "Recorded undeployment of Foo version 2 from test environment (application instance customer-1) in the Pact Broker" }
 
         context "when there is no pb:environments relation in the index" do
           let(:index_body_hash) do
@@ -173,8 +173,8 @@ module PactBroker
         end
 
         context "when a target is provided and there is no deployed version with a matching target" do
-          let(:target) { "wrong" }
-          let(:expected_message) { "Foo is not currently deployed to target 'wrong' in test environment. Please specify one of the following targets to record the undeployment from: customer-1, <no target>" }
+          let(:application_instance) { "wrong" }
+          let(:expected_message) { "Foo is not currently deployed to application instance 'wrong' in test environment. Please omit the application instance to undeploy from the anonymous instance or specify one of the following application instances to record the undeployment from: customer-1." }
 
           its(:success) { is_expected.to be false }
           its(:message) { is_expected.to include expected_message }
@@ -186,12 +186,20 @@ module PactBroker
           end
         end
 
+        context "when a target is provided and there is no deployed version with a matching target and all the application instances are set" do
+          let(:application_instance) { "wrong" }
+          let(:returned_target_2) { "customer-2" }
+          let(:expected_message) { "Foo is not currently deployed to application instance 'wrong' in test environment. Please specify one of the following application instances to record the undeployment from: customer-1, customer-2." }
+
+          its(:message) { is_expected.to include expected_message }
+        end
+
         context "when a target is not provided and there is no deployed verison without a target" do
-          let(:target) { nil }
+          let(:application_instance) { nil }
           let(:returned_target_2) { "customer-2" }
 
           its(:success) { is_expected.to be false }
-          its(:message) { is_expected.to include "Please specify one of the following targets to record the undeployment from: customer-1, customer-2" }
+          its(:message) { is_expected.to include "Please specify one of the following application instances to record the undeployment from: customer-1, customer-2" }
         end
 
         context "when there are no deployed versions for the pacticipant" do

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -1719,6 +1719,7 @@
           "Accept": "application/hal+json"
         },
         "body": {
+          "applicationInstance": "blue",
           "target": "blue"
         }
       },

data/spec/service_providers/record_deployment_spec.rb

@@ -9,13 +9,13 @@ RSpec.describe "recording a deployment", pact: true do
   let(:version_number) { "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30" }
   let(:environment_name) { "test" }
   let(:output) { "text" }
-  let(:target) { "blue" }
+  let(:application_instance) { "blue" }
   let(:params) do
     {
       pacticipant_name: pacticipant_name,
       version_number: version_number,
       environment_name: environment_name,
-      target: target
+      application_instance: application_instance
     }
   end
   let(:options) do
@@ -139,14 +139,15 @@ RSpec.describe "recording a deployment", pact: true do
         path: "/HAL-REL-PLACEHOLDER-PB-RECORD-DEPLOYMENT-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST",
         headers: post_request_headers,
         body: {
-          target: target
+          applicationInstance: application_instance,
+          target: application_instance
         }
       )
       .will_respond_with(
         status: 201,
         headers: pact_broker_response_headers,
         body: {
-          target: target
+          target: application_instance
         }
       )
   end
@@ -160,14 +161,14 @@ RSpec.describe "recording a deployment", pact: true do
 
     it "returns a success message" do
       expect(subject.success).to be true
-      expect(subject.message).to include "Recorded deployment of Foo version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 to test environment (target blue) in the Pact Broker."
+      expect(subject.message).to include "Recorded deployment of Foo version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 to test environment (application instance blue) in the Pact Broker."
     end
 
     context "when the output is json" do
       let(:output) { "json" }
 
       it "returns the JSON payload" do
-        expect(JSON.parse(subject.message)).to eq "target" => target
+        expect(JSON.parse(subject.message)).to eq "target" => application_instance
       end
     end
   end

data/spec/service_providers/record_undeployment_spec.rb

@@ -8,12 +8,12 @@ RSpec.describe "recording an undeployment", pact: true do
   let(:pacticipant_name) { "Foo" }
   let(:environment_name) { "test" }
   let(:output) { "text" }
-  let(:target) { "customer-1" }
+  let(:application_instance) { "customer-1" }
   let(:params) do
     {
       pacticipant_name: pacticipant_name,
       environment_name: environment_name,
-      target: target
+      application_instance: application_instance
     }
   end
   let(:options) do
@@ -100,7 +100,7 @@ RSpec.describe "recording an undeployment", pact: true do
           _embedded: {
             deployedVersions: [
               {
-                target: target,
+                target: application_instance,
                 _links: {
                   self: {
                     href: Pact.term(pact_broker.mock_service_base_url + deployed_version_placeholder_path, /^http/)
@@ -150,7 +150,7 @@ RSpec.describe "recording an undeployment", pact: true do
 
     it "returns a success message" do
       expect(subject.success).to be true
-      expect(subject.message).to include "Recorded undeployment of Foo version 2 from test environment (target customer-1) in the Pact Broker"
+      expect(subject.message).to include "Recorded undeployment of Foo version 2 from test environment (application instance customer-1) in the Pact Broker"
     end
 
     context "when the output is json" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.51.1
+  version: 1.54.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-21 00:00:00.000000000 Z
+date: 2021-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: 0.18.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: 0.18.1
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
@@ -430,7 +430,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.27
+rubygems_version: 3.2.28
 signing_key: 
 specification_version: 4
 summary: See description