pact_broker-client 1.40.0 → 1.45.0

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

@@ -1,109 +0,0 @@
-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)
-          @target = params.fetch(:target)
-          @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, :target, :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: target }
-        end
-
-        def result_message
-          if output == "text"
-            message = "Recorded deployment of #{pacticipant_name} version #{version_number} to #{environment_name} in #{pact_broker_name}."
-            suffix = target ? " 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

@@ -1,102 +0,0 @@
-require 'pact_broker/client/hal_client_methods'
-require 'pact_broker/client/error'
-require 'pact_broker/client/command_result'
-
-# TODO
-# --limit 1
-# order by date so that the oldest one gets undeployed first
-
-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_if_command_supported
-          if deployed_version_links_for_environment.any?
-            @undeployment_entities = deployed_version_links_for_environment.collect do | deployed_version_link |
-              deployed_version_link.get!._link!("pb:record-undeployment").post!
-            end
-          else
-            check_environment_exists
-            raise_not_found_error
-          end
-
-          PactBroker::Client::CommandResult.new(true, "foo")
-        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, :target, :output
-        attr_reader :deployed_version_resource, :undeployment_entities
-
-        def version_resource
-          index_resource._link!("pb:pacticipant-version").expand(pacticipant: pacticipant_name, version: version_number).get!
-        end
-
-        def deployed_version_links
-          @deployed_version_links ||= version_resource._links!("pb:currently-deployed-versions")
-        end
-
-        def deployed_version_links_for_environment
-          @deployed_version_links_for_environment ||= deployed_version_links.select(environment_name)
-        end
-
-        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 raise_not_found_error
-          raise PactBroker::Client::Error.new(deployed_version_not_found_message)
-        end
-
-        def deployed_version_not_found_message
-          if (env_names = deployed_version_links.names).any?
-            "#{pacticipant_name} version #{version_number} is not currently deployed to #{environment_name}. It is currently deployed to: #{env_names.join(", ")}"
-          else
-            "#{pacticipant_name} version #{version_number} is not currently deployed to any environment."
-          end
-        end
-
-        def result_message
-          if output == "text"
-            message = "Recorded undeployment of #{pacticipant_name} version #{version_number} from #{environment_name} in #{pact_broker_name}."
-          elsif output == "json"
-            undeployment_entities.last.response.raw_body
-          else
-            ""
-          end
-        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/spec/lib/pact_broker/client/versions/record_deployment_spec.rb

@@ -1,82 +0,0 @@
-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(:target) { true }
-
-          let(:params) do
-            {
-              pacticipant_name: "Foo",
-              version_number: "1",
-              environment_name: "test",
-              target: target,
-              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 target 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(:target) { 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