pact_broker-client 1.36.0 → 1.38.2

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/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
@@ -111,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_CODE_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/lib/pact_broker/client/cli/broker_publish_spec.rb

@@ -28,7 +28,7 @@ module PactBroker::Client::CLI
             "http://pact-broker",
             ["spec/support/cli_test_pacts/foo.json"],
             { number: "1.2.3", tags: [], version_required: false },
-            { verbose: nil }
+            { }
           )
           invoke_broker
         end

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

@@ -52,12 +52,9 @@ module PactBroker::Client::CLI
         ENV['PACT_BROKER_TOKEN'] = 'token'
       end
 
-      it "populates the options from the environment variables" do
+      it "populates the base URL from the environment variables" do
         expect(Delegate).to receive(:call) do | options |
           expect(options.broker_base_url).to eq 'http://foo'
-          expect(options.broker_username).to eq 'username'
-          expect(options.broker_password).to eq 'password'
-          expect(options.broker_token).to eq 'token'
         end
         TestThor.start(%w{test_using_env_vars})
       end
@@ -65,9 +62,6 @@ module PactBroker::Client::CLI
       it "does not override a value specifed on the command line" do
         expect(Delegate).to receive(:call) do | options |
           expect(options.broker_base_url).to eq 'http://bar'
-          expect(options.broker_username).to eq 'username'
-          expect(options.broker_password).to eq 'password'
-          expect(options.broker_token).to eq 'token'
         end
         TestThor.start(%w{test_using_env_vars --broker-base-url http://bar})
       end

data/spec/lib/pact_broker/client/hal/entity_spec.rb

@@ -9,8 +9,9 @@ module PactBroker::Client
       end
 
       let(:provider_response) do
-        double('response', body: provider_hash, success?: true)
+        double('response', body: provider_hash, success?: true, status: status)
       end
+      let(:status) { 200 }
 
       let(:provider_hash) do
         {
@@ -72,12 +73,12 @@ module PactBroker::Client
           subject(:entity) { ErrorEntity.new("http://pact", pact_hash, http_client) }
 
           it "raises an error" do
-            expect { entity.assert_success! }.to raise_error ErrorResponseReturned, "Error retrieving http://pact status= "
+            expect { entity.assert_success! }.to raise_error ErrorResponseReturned, "Error retrieving http://pact status="
           end
         end
 
         context "when the response is not successful and there is a response" do
-          let(:response) { double('response', code: 200, raw_body: "body") }
+          let(:response) { double('response', status: 200, raw_body: "body") }
 
           subject(:entity) { ErrorEntity.new("http://pact", pact_hash, http_client, response) }
 

data/spec/lib/pact_broker/client/hal/http_client_spec.rb

@@ -3,13 +3,13 @@ require 'pact_broker/client/hal/http_client'
 module PactBroker::Client
   module Hal
     describe HttpClient do
-      before do
-        allow(Retry).to receive(:until_truthy_or_max_times) { |&block| block.call }
-      end
-
       subject { HttpClient.new(username: 'foo', password: 'bar') }
 
       describe "get" do
+        before do
+          allow(subject).to receive(:until_truthy_or_max_times) { |&block| block.call }
+        end
+
         let!(:request) do
           stub_request(:get, "http://example.org/").
             with(  headers: {
@@ -41,18 +41,22 @@ module PactBroker::Client
           end
         end
 
-
         it "retries on failure" do
-          expect(Retry).to receive(:until_truthy_or_max_times)
+          expect(subject).to receive(:until_truthy_or_max_times)
           do_get
         end
 
         it "returns a response" do
           expect(do_get.body).to eq({"some" => "json"})
         end
+
       end
 
       describe "post" do
+        before do
+          allow(subject).to receive(:until_truthy_or_max_times) { |&block| block.call }
+        end
+
         let!(:request) do
           stub_request(:post, "http://example.org/").
             with(  headers: {
@@ -75,7 +79,7 @@ module PactBroker::Client
         end
 
         it "calls Retry.until_truthy_or_max_times" do
-          expect(Retry).to receive(:until_truthy_or_max_times)
+          expect(subject).to receive(:until_truthy_or_max_times)
           do_post
         end
 
@@ -100,6 +104,59 @@ module PactBroker::Client
           end
         end
       end
+
+      describe "integration test" do
+        before do
+          allow(subject).to receive(:sleep)
+        end
+
+        let(:do_get) { subject.get('http://example.org') }
+
+        context "with a 50x error is returned less than the max number of tries" do
+          let!(:request) do
+            stub_request(:get, "http://example.org").
+              to_return({ status: 500 }, { status: 502 }, { status: 503 }, { status: 200 })
+          end
+
+          it "retries" do
+            expect(do_get.status).to eq 200
+          end
+        end
+
+        context "with a 50x error is returned more than the max number of tries" do
+          let!(:request) do
+            stub_request(:get, "http://example.org").
+              to_return({ status: 500 }, { status: 501 }, { status: 502 }, { status: 503 }, { status: 504 })
+          end
+
+          it "retries and returns the last 50x response" do
+            expect(do_get.status).to eq 504
+          end
+        end
+
+        context "when exceptions are raised" do
+          before do
+            allow($stderr).to receive(:puts)
+          end
+
+          let!(:request) do
+            stub_request(:get, "http://example.org")
+              .to_raise(Errno::ECONNREFUSED)
+          end
+
+          it "logs the error" do
+            expect($stderr).to receive(:puts).with(/Errno::ECONNREFUSED/)
+            begin
+              do_get
+            rescue Errno::ECONNREFUSED
+            end
+          end
+
+          it "retries and raises the last exception" do
+            expect { do_get }.to raise_error(Errno::ECONNREFUSED)
+          end
+        end
+      end
     end
   end
 end

data/spec/lib/pact_broker/client/versions/describe_spec.rb

@@ -5,7 +5,6 @@ module PactBroker
     class Versions
       describe Describe do
         describe ".call" do
-
           let(:versions_client) do
             instance_double('PactBroker::Client::Versions', latest: version_hash)
           end

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

@@ -0,0 +1,82 @@
+require 'pact_broker/client/versions/record_deployment'
+
+module PactBroker
+  module Client
+    class Versions
+      describe RecordDeployment do
+        describe ".call" do
+          let(:broker_base_url) { "http://broker" }
+          let(:index_body_hash) do
+            {
+              _links: {}
+            }
+          end
+          let!(:index_request) do
+            stub_request(:get, broker_base_url).to_return(status: 200, body: index_body_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+          end
+
+          let(:replaced_previous_deployed_version) { true }
+
+          let(:params) do
+            {
+              pacticipant_name: "Foo",
+              version_number: "1",
+              environment_name: "test",
+              replaced_previous_deployed_version: replaced_previous_deployed_version,
+              output: "text"
+            }
+          end
+
+          let(:pact_broker_client_options) { {} }
+
+          subject { RecordDeployment.call(params, broker_base_url, pact_broker_client_options) }
+
+          context "when the pb:environments relation does not exist" do
+            it "returns an error response" do
+              expect(subject.success).to be false
+              expect(subject.message).to include "does not support"
+            end
+          end
+
+          context "when the response headers contain Pactflow" do
+            before do
+              allow_any_instance_of(RecordDeployment).to receive(:check_if_command_supported)
+              allow_any_instance_of(RecordDeployment).to receive(:check_environment_exists)
+              allow_any_instance_of(RecordDeployment).to receive(:record_deployment)
+              allow_any_instance_of(RecordDeployment).to receive(:deployed_version_resource).and_return(deployed_version_resource)
+            end
+
+            let(:response_headers) { { "X-Pactflow-Sha" => "abc" } }
+
+            let(:deployed_version_resource) do
+              double('PactBroker::Client::Hal::Entity', response: double('response', headers: response_headers) )
+            end
+
+            it "indicates the API was Pactflow" do
+              expect(subject.message).to include "Recorded deployment of Foo version 1 to test in Pactflow"
+            end
+          end
+
+          context "when replaced_previous_deployed_version is false" do
+            before do
+              allow_any_instance_of(RecordDeployment).to receive(:check_if_command_supported)
+              allow_any_instance_of(RecordDeployment).to receive(:check_environment_exists)
+              allow_any_instance_of(RecordDeployment).to receive(:record_deployment)
+              allow_any_instance_of(RecordDeployment).to receive(:pact_broker_name).and_return("")
+            end
+
+            let(:replaced_previous_deployed_version) { false }
+
+            let(:deployed_version_resource) do
+              double('PactBroker::Client::Hal::Entity', response: double('response', headers: response_headers) )
+            end
+
+            it "does not include the message about marking the previous version as undeployed" do
+              expect(subject.message).to_not include "undeployed"
+            end
+          end
+        end
+      end
+    end
+  end
+end