pact_broker-client 1.37.1 → 1.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ee5df1eb310d1b9e093c4221ac3761f24cf7038dc923311cef87bc2d51fffcf
-  data.tar.gz: 0332f399dd793f3ab9a2e37446bee976770ba4e37ddbed83ebe2ef00074a20ad
+  metadata.gz: 5ff434f0cdc2c246e13875eb094bf057cada5e72e6049aace2387a344ba35aa2
+  data.tar.gz: 508a60bac06506938f425a64eefe63d0fb56ca4b3f32df54bf8d41c9773e6fa5
 SHA512:
-  metadata.gz: 6c3ba1e4b3303fe74c5227fdbd24c919cf6ce63bac1a85ec98e04b75618f6f75074b7cbba5933f5140ba80da903fc5c43b381c240639a0795d4cc4e835ec6244
-  data.tar.gz: 64104a222d139eb496ebe1c4a0850c755e96e1437ab337aafe480b549bea89da49684b67108b4314fbd0fa66bd03a6ef346f04848b0340f13a0bbe1b796f22cc
+  metadata.gz: 4150fdf1cc5cb1970b60d07f646b151bae9fc56f68422b22a1265d64bb9f99b559ca01d7c688e1fdd047a08fb69c1d0cb28c3cd2be3370285d739cd1a9f36b0d
+  data.tar.gz: 91ee03c84a4ebec001ef2f2fb3c1dcc47e41a2f55b97e2b23101f99fa58a9114ffa199beb160deabc5f395ba8dc4a01cdd2901d73db2c4263ca444ec37d4b22e

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+<a name="v1.38.0"></a>
+### v1.38.0 (2021-03-22)
+
 <a name="v1.37.1"></a>
 ### v1.37.1 (2021-03-11)
 

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

@@ -39,7 +39,7 @@ module PactBroker
           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 }, can_i_deploy_options, pact_broker_client_options)
           $stdout.puts result.message
-          exit(1) unless result.success
+          exit(can_i_deploy_exit_status) unless result.success
         end
 
         desc 'publish PACT_DIRS_OR_FILES ...', "Publish pacts to a Pact Broker."
@@ -197,6 +197,31 @@ module PactBroker
             exit(1) unless result.success
           end
 
+          ignored_and_hidden_potential_options_from_environment_variables
+          desc "record-undeployment", "Record undeployment of (or the end of support for) a pacticipant version from an environment"
+          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'
+          shared_authentication_options
+
+          def record_undeployment
+            require 'pact_broker/client/versions/record_undeployment'
+            params = {
+              pacticipant_name: options.pacticipant,
+              version_number: options.version,
+              environment_name: options.environment,
+              output: options.output
+            }
+            result = PactBroker::Client::Versions::RecordUndeployment.call(
+              params,
+              options.broker_base_url,
+              pact_broker_client_options
+            )
+            $stdout.puts result.message
+            exit(1) unless result.success
+          end
+
         end
 
         ignored_and_hidden_potential_options_from_environment_variables
@@ -213,6 +238,16 @@ module PactBroker
             true
           end
 
+          def can_i_deploy_exit_status
+            exit_code_string = ENV.fetch('PACT_BROKER_CAN_I_DEPLOY_EXIT_STATUS_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."

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

@@ -1,5 +1,6 @@
 require 'erb'
 require 'delegate'
+require 'pact_broker/client/error'
 require 'pact_broker/client/hal/link'
 require 'pact_broker/client/hal/links'
 
@@ -73,6 +74,22 @@ module PactBroker
           _links(key) or raise RelationNotFoundError.new("Could not find relation '#{key}' in resource at #{@href}")
         end
 
+        def embedded_entity
+          embedded_ent = yield @data["_embedded"]
+          Entity.new(embedded_ent["_links"]["self"]["href"], embedded_ent, @client, response)
+        end
+
+        def embedded_entities(key = nil)
+          embedded_ents = if key
+            @data["_embedded"][key]
+          else
+            yield @data["_embedded"]
+          end
+          embedded_ents.collect do | embedded_ent |
+            Entity.new(embedded_ent["_links"]["self"]["href"], embedded_ent, @client, response)
+          end
+        end
+
         def success?
           true
         end

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

@@ -17,7 +17,7 @@ module PactBroker
         end
 
         def get href, params = {}, headers = {}
-          query = params.collect{ |(key, value)| "#{CGI::escape(key)}=#{CGI::escape(value)}" }.join("&")
+          query = params.collect{ |(key, value)| "#{CGI::escape(key.to_s)}=#{CGI::escape(value)}" }.join("&")
           uri = URI(href)
           uri.query = query
           perform_request(create_request(uri, 'Get', nil, headers), uri)

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.37.1'
+    VERSION = '1.38.0'
   end
 end

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

@@ -0,0 +1,125 @@
+require 'pact_broker/client/hal_client_methods'
+require 'pact_broker/client/error'
+require 'pact_broker/client/command_result'
+
+module PactBroker
+  module Client
+    class Versions
+      class RecordUndeployment
+        include PactBroker::Client::HalClientMethods
+
+        NOT_SUPPORTED_MESSAGE = "This version of the Pact Broker does not support recording undeployments. Please upgrade to version 2.80.0 or later."
+
+        def self.call(params, pact_broker_base_url, pact_broker_client_options)
+          new(params, pact_broker_base_url, pact_broker_client_options).call
+        end
+
+        def initialize(params, pact_broker_base_url, pact_broker_client_options)
+          @pact_broker_base_url = pact_broker_base_url
+          @pacticipant_name = params.fetch(:pacticipant_name)
+          @version_number = params.fetch(:version_number)
+          @environment_name = params.fetch(:environment_name)
+          @output = params.fetch(:output)
+          @pact_broker_client_options = pact_broker_client_options
+        end
+
+        def call
+          check_environment_exists
+          # record_undeployment
+
+          PactBroker::Client::CommandResult.new(true, result_message)
+        rescue PactBroker::Client::Error => e
+          PactBroker::Client::CommandResult.new(false, e.message)
+        end
+
+        private
+
+        attr_reader :pact_broker_base_url, :pact_broker_client_options
+        attr_reader :pacticipant_name, :version_number, :environment_name, :replaced_previous_deployed_version, :output
+        attr_reader :deployed_version_resource
+
+        def check_environment_exists
+          deployed_versions = currently_deployed_versions_for_pacticipant
+                                .get(version: version_number)
+                                .embedded_entities("deployedVersions")
+          deployed_versions
+        end
+
+        def currently_deployed_versions_for_pacticipant
+          @currently_deployed_versions_for_pacticipant ||= index_resource
+            ._link!("pb:environments")
+            .get!(name: environment_name)
+            .embedded_entities("environments")
+            .tap { |it| raise "Environment not found '#{environment_name}'" if it.empty? }
+            .first
+            ._link!("pb:currently-deployed-versions-for-pacticipant")
+            .expand(pacticipant: pacticipant_name)
+        end
+
+        def currently_deployed_versions_for_pacticipant_version
+          @currently_deployed_versions ||= currently_deployed_versions_for_pacticipant
+            .get(version: version_number)
+            .embedded_entities("deployedVersions")
+        end
+
+        # def record_deployment
+        #   @deployed_version_resource =
+        #     get_record_deployment_relation
+        #     .post(record_deployment_request_body)
+        #     .assert_success!
+        # end
+
+        # def get_record_deployment_relation
+        #   record_deployment_links = get_pacticipant_version._links!("pb:record-deployment")
+        #   link_for_environment = record_deployment_links.find(environment_name)
+        #   if link_for_environment
+        #     link_for_environment
+        #   else
+        #     check_environment_exists
+        #     # Force the exception to be raised
+        #     record_deployment_links.find!(environment_name, "Environment '#{environment_name}' is not an available option for recording a deployment of #{pacticipant_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_deployment_request_body
+        #   { replacedPreviousDeployedVersion: replaced_previous_deployed_version }
+        # end
+
+        def result_message
+          ""
+          # if output == "text"
+          #   message = "Recorded deployment of #{pacticipant_name} version #{version_number} to #{environment_name} in #{pact_broker_name}."
+          #   suffix = replaced_previous_deployed_version ? " Marked previous deployed version as undeployed." : ""
+          #   message + suffix
+          # elsif output == "json"
+          #   deployed_version_resource.response.raw_body
+          # else
+          #   ""
+          # end
+        end
+
+        def pact_broker_name
+          is_pactflow? ? "Pactflow" : "the Pact Broker"
+        end
+
+        def is_pactflow?
+          deployed_version_resource.response.headers.keys.any?{ | header_name | header_name.downcase.include?("pactflow") }
+        end
+
+        def check_if_command_supported
+          unless index_resource.can?("pb:environments")
+            raise PactBroker::Client::Error.new(NOT_SUPPORTED_MESSAGE)
+          end
+        end
+      end
+    end
+  end
+end

data/pact-broker-client.gemspec

@@ -32,5 +32,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'webmock', '~> 3.0'
   gem.add_development_dependency 'conventional-changelog', '~>1.3'
   gem.add_development_dependency 'pact', '~> 1.16'
-  gem.add_development_dependency 'pact-support', '1.15.0'
+  gem.add_development_dependency 'pact-support', '~> 1.16'
 end

data/script/record-deployment.sh

@@ -0,0 +1,4 @@
+PACT_BROKER_FEATURES=deployments bundle exec bin/pact-broker record-deployment \
+   --pacticipant Foo --version 1.0.0 --environment prod --broker-base-url http://localhost:9292
+
+

data/spec/lib/pact_broker/client/cli/broker_can_i_deploy_spec.rb

@@ -113,13 +113,45 @@ module PactBroker
           end
 
           it "exits with code 1" do
-            exited_with_error = false
+            exited_explicitly = false
+            exited_explicitlyerror = nil
             begin
               invoke_can_i_deploy
-            rescue SystemExit
-              exited_with_error = true
+            rescue SystemExit => e
+              exited_explicitly = true
+              error = e
+            end
+            expect(exited_explicitly).to be true
+            expect(error.status).to be 1
+          end
+
+          context "when an exit status is specified" do
+            before do
+              allow(ENV).to receive(:fetch).and_call_original
+              allow(ENV).to receive(:fetch).with('PACT_BROKER_CAN_I_DEPLOY_EXIT_STATUS_BETA', '').and_return("0")
+            end
+
+            it "exits with the specified code" do
+              exited_explicitly = false
+              error = nil
+              begin
+                invoke_can_i_deploy
+              rescue SystemExit => e
+                exited_explicitly = true
+                error = e
+              end
+              expect(exited_explicitly).to be true
+              expect(error.status).to be 0
+            end
+
+            it "prints the configured exit code" do
+              expect($stderr).to receive(:puts).with("Exiting can-i-deploy with configured exit code 0")
+              expect($stdout).to receive(:puts).with(message)
+              begin
+                invoke_can_i_deploy
+              rescue SystemExit
+              end
             end
-            expect(exited_with_error).to be true
           end
         end
       end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 require 'webmock/rspec'
 
+ENV['PACT_BROKER_FEATURES'] = 'deployments'
+
 WebMock.disable_net_connect!(allow_localhost: true)
 
 require "./spec/support/shared_context.rb"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.37.1
+  version: 1.38.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -160,16 +160,16 @@ dependencies:
   name: pact-support
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: '1.16'
 description: Client for the Pact Broker. Publish, retrieve and query pacts and verification
   results.
 email:
@@ -249,6 +249,7 @@ files:
 - lib/pact_broker/client/versions/formatter.rb
 - lib/pact_broker/client/versions/json_formatter.rb
 - lib/pact_broker/client/versions/record_deployment.rb
+- lib/pact_broker/client/versions/record_undeployment.rb
 - lib/pact_broker/client/versions/text_formatter.rb
 - lib/pact_broker/client/webhooks/create.rb
 - lib/pact_broker/client/webhooks/test.rb
@@ -257,6 +258,7 @@ files:
 - script/create-pacticipant.sh
 - script/generate-cli-usage.sh
 - script/publish-pact.sh
+- script/record-deployment.sh
 - script/release.sh
 - script/trigger-release.sh
 - spec/integration/can_i_deploy_spec.rb
@@ -337,7 +339,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.14
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: See description