pact_broker-client 1.34.0 → 1.38.0

data/lib/pact_broker/client/tasks/publication_task.rb

@@ -1,5 +1,6 @@
 require 'rake/tasklib'
 require 'pact_broker/client/git'
+require 'pact_broker/client/hash_refinements'
 
 =begin
 require pact_broker/client/tasks
@@ -17,31 +18,52 @@ end
 module PactBroker
   module Client
     class PublicationTask < ::Rake::TaskLib
+      using PactBroker::Client::HashRefinements
 
       attr_accessor :pattern, :pact_broker_base_url, :consumer_version, :tag, :write_method, :tag_with_git_branch, :pact_broker_basic_auth, :pact_broker_token
+      attr_reader :auto_detect_version_properties, :branch, :build_url
       alias_method :tags=, :tag=
       alias_method :tags, :tag
 
       def initialize name = nil, &block
         @name = name
+        @auto_detect_version_properties = nil
+        @version_required = false
         @pattern = 'spec/pacts/*.json'
         @pact_broker_base_url = 'http://pact-broker'
         rake_task &block
       end
 
+      def auto_detect_version_properties= auto_detect_version_properties
+        @version_required = version_required || auto_detect_version_properties
+        @auto_detect_version_properties = auto_detect_version_properties
+      end
+
+      def branch= branch
+        @version_required = version_required || !!branch
+        @branch = branch
+      end
+
+      def build_url= build_url
+        @version_required = version_required || !!build_url
+        @build_url = build_url
+      end
+
       private
 
+      attr_reader :version_required
+
       def rake_task &block
         namespace :pact do
           desc "Publish pacts to pact broker"
           task task_name do
             block.call(self)
             require 'pact_broker/client/publish_pacts'
-            pact_broker_client_options =  {}
-              .merge( pact_broker_basic_auth ? { basic_auth: pact_broker_basic_auth } : {} )
-              .merge( write_method ? { write: write_method } : {} )
-              .merge( pact_broker_token ? { token: pact_broker_token } : {} )
-            success = PactBroker::Client::PublishPacts.new(pact_broker_base_url, FileList[pattern], consumer_version, all_tags, pact_broker_client_options).call
+            pact_broker_client_options = { write: write_method, token: pact_broker_token }
+            pact_broker_client_options[:basic_auth] = pact_broker_basic_auth if pact_broker_basic_auth && pact_broker_basic_auth.any?
+            pact_broker_client_options.compact!
+            consumer_version_params = { number: consumer_version, branch: the_branch, build_url: build_url, tags: all_tags, version_required: version_required }.compact
+            success = PactBroker::Client::PublishPacts.new(pact_broker_base_url, FileList[pattern], consumer_version_params, pact_broker_client_options).call
             raise "One or more pacts failed to be published" unless success
           end
         end
@@ -53,9 +75,18 @@ module PactBroker
 
       def all_tags
         t = [*tags]
-        t << PactBroker::Client::Git.branch if tag_with_git_branch
+        t << PactBroker::Client::Git.branch(raise_error: true) if tag_with_git_branch
         t.compact.uniq
       end
+
+      def the_branch
+        if branch.nil? && auto_detect_version_properties != false
+          PactBroker::Client::Git.branch(raise_error: auto_detect_version_properties == true)
+        else
+          branch
+        end
+      end
+
     end
   end
 end

data/lib/pact_broker/client/version.rb

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

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

@@ -0,0 +1,109 @@
+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 RecordDeployment
+        include PactBroker::Client::HalClientMethods
+
+        NOT_SUPPORTED_MESSAGE = "This version of the Pact Broker does not support recording deployments. 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)
+          @replaced_previous_deployed_version = params.fetch(:replaced_previous_deployed_version)
+          @output = params.fetch(:output)
+          @pact_broker_client_options = pact_broker_client_options
+        end
+
+        def call
+          check_if_command_supported
+          record_deployment
+
+          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
+          index_resource
+            ._link!("pb:environments")
+            .get!
+            ._links("pb:environments")
+            .find!(environment_name, "No environment found with name '#{environment_name}'")
+        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/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

@@ -26,10 +26,11 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'table_print', '~> 1.5'
   gem.add_runtime_dependency 'thor', '>= 0.20', '< 2.0'
   gem.add_runtime_dependency 'rake', '~> 13.0' #For FileList
+  gem.add_runtime_dependency 'dig_rb', '~> 1.0'
 
   gem.add_development_dependency 'fakefs', '~> 0.4'
   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/publish-pact.sh

@@ -1 +1,7 @@
-bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json --consumer-app-version 1.2.3 --broker-base-url http://localhost:9292 --tag-with-git-branch --broker-username localhost --broker-password localhost
+bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json \
+  --consumer-app-version 1.2.7 \
+  --broker-base-url http://localhost:9292 \
+   --broker-username localhost --broker-password localhost \
+    --auto-detect-branch \
+    --build-url http://mybuild
+

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/script/trigger-release.sh

@@ -19,7 +19,7 @@ output=$(curl -v -X POST https://api.github.com/repos/${repository_slug}/dispatc
       -H "Authorization: Bearer $GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES" \
       -d "{\"event_type\": \"release-triggered\", \"client_payload\": {\"increment\": ${increment}}}" 2>&1)
 
-if  ! echo "${output}" | grep "HTTP\/1.1 204" > /dev/null; then
+if  ! echo "${output}" | grep "HTTP\/.* 204" > /dev/null; then
   echo "$output" | sed  "s/${GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES}/********/g"
   echo "Failed to trigger release"
   exit 1

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

@@ -1,4 +1,6 @@
 require 'pact_broker/client/cli/broker'
+require 'pact_broker/client/cli/version_selector_options_parser'
+require 'pact_broker/client/can_i_deploy'
 
 module PactBroker
   module Client
@@ -35,7 +37,7 @@ module PactBroker
         end
 
         it "invokes the CanIDeploy service" do
-          expect(CanIDeploy).to receive(:call).with('http://pact-broker', version_selectors, {to_tag: nil, limit: 1000}, {output: 'table', retry_while_unknown: 1, retry_interval: 2}, {verbose: 'verbose'})
+          expect(CanIDeploy).to receive(:call).with('http://pact-broker', version_selectors, {to_tag: nil, to_environment: nil, limit: 1000}, {output: 'table', retry_while_unknown: 1, retry_interval: 2}, {verbose: 'verbose'})
           invoke_can_i_deploy
         end
 
@@ -53,7 +55,18 @@ module PactBroker
           end
 
           it "passes the value as the matrix options" do
-            expect(CanIDeploy).to receive(:call).with(anything, anything, {to_tag: 'prod', limit: 1000}, anything, anything)
+            expect(CanIDeploy).to receive(:call).with(anything, anything, {to_tag: 'prod', to_environment: nil, limit: 1000}, anything, anything)
+            invoke_can_i_deploy
+          end
+        end
+
+        context "with --to-environment" do
+          before do
+            subject.options.to_environment = 'prod'
+          end
+
+          it "passes the value as the matrix options" do
+            expect(CanIDeploy).to receive(:call).with(anything, anything, {to_tag: nil, to_environment: 'prod', limit: 1000}, anything, anything)
             invoke_can_i_deploy
           end
         end
@@ -100,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