pact_broker-client 1.40.0 → 1.45.0

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

@@ -0,0 +1,219 @@
+require 'pact_broker/client/deployments/record_undeployment'
+
+module PactBroker
+  module Client
+    module Deployments
+      describe RecordUndeployment do
+        let(:params) do
+          {
+            pacticipant_name: "Foo",
+            target: target,
+            environment_name: "test"
+          }
+        end
+        let(:target) { "customer-1" }
+        let(:output) { "text" }
+        let(:options) { { output: output, verbose: true } }
+        let(:pact_broker_base_url) { "http://broker" }
+        let(:pact_broker_client_options) { { pact_broker_base_url: pact_broker_base_url } }
+
+        let(:index_body_hash) do
+          {
+            _links: {
+              :'pb:environments' => {
+                href: environments_url
+              },
+              :'pb:pacticipant' => {
+                href: pacticipant_url
+              }
+            }
+          }
+        end
+
+        let(:environments_hash) do
+          {
+            _links: {
+              :'pb:environments' => [
+                {
+                  name: "test",
+                  href: test_environment_url
+                }
+              ]
+            }
+          }
+        end
+
+        let(:environment_hash) do
+          {
+            _links: {
+              :'pb:currently-deployed-versions' => {
+                href: currently_deployed_versions_url
+              }
+            }
+          }
+        end
+
+        let(:deployed_versions_hash) do
+          {
+            _embedded: {
+              deployedVersions: [
+                {
+                  target: "customer-1",
+                  _links: {
+                    self: {
+                      href: deployed_version_url_1
+                    }
+                  }
+                },
+                {
+                  target: returned_target_2,
+                  _links: {
+                    self: {
+                      href: deployed_version_url_2
+                    }
+                  }
+                }
+              ]
+            }
+          }
+        end
+
+        let(:returned_target_2) { nil }
+        let(:deployed_version_hash) do
+          {
+            _embedded: {
+              version: {
+                number: "2"
+              }
+            }
+          }
+        end
+
+        let(:environments_url) { "#{webmock_base_url}/environments" }
+        let(:test_environment_url) { "#{webmock_base_url}/environments/1234" }
+        let(:currently_deployed_versions_url) { "#{webmock_base_url}/currently-deployed-versions" }
+        let(:deployed_version_url_1) { "#{webmock_base_url}/deployed-version-1" }
+        let(:deployed_version_url_2) { "#{webmock_base_url}/deployed-version-2" }
+        let(:pacticipant_url) { "#{webmock_base_url}/pacticipant" }
+
+        let(:webmock_base_url) { "http://broker" }
+
+        let!(:index_request) do
+          stub_request(:get, "http://broker").to_return(status: 200, body: index_body_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let!(:environments_request) do
+          stub_request(:get, "http://broker/environments").to_return(status: 200, body: environments_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let!(:environment_request) do
+          stub_request(:get, test_environment_url).to_return(status: 200, body: environment_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let!(:deployed_versions_request) do
+          stub_request(:get, currently_deployed_versions_url + "?pacticipant=Foo").to_return(status: 200, body: deployed_versions_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let!(:deployed_version_patch_request_1) do
+          stub_request(:patch, deployed_version_url_1).with(body: { currentlyDeployed: false}.to_json).to_return(status: 200, body: deployed_version_hash.to_json, headers: { "Content-Type" => "application/hal+json" })
+        end
+
+        let!(:deployed_version_patch_request_2) do
+          stub_request(:patch, deployed_version_url_2).with(body: { currentlyDeployed: false}.to_json).to_return(status: 200, body: deployed_version_hash.to_json, headers: { "Content-Type" => "application/hal+json" })
+        end
+
+        let!(:pacticipant_request) do
+          stub_request(:get, pacticipant_url).to_return(status: pacticipant_request_status, body: {}.to_json, headers: { "Content-Type" => "application/hal+json" })
+        end
+
+        let(:pacticipant_request_status) { 200 }
+
+        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" }
+
+        context "when there is no pb:environments relation in the index" do
+          let(:index_body_hash) do
+            {
+              _links: {}
+            }
+          end
+
+          its(:success) { is_expected.to be false }
+          its(:message) { is_expected.to include "support" }
+        end
+
+        context "when output is json" do
+          let(:output) { "json" }
+          its(:message) { is_expected.to eq [deployed_version_hash].to_json }
+        end
+
+        context "when there is an error returned from one of the deployed version updates (there should only ever be one deployed version, but testing just for the sake of it)" do
+          let!(:deployed_version_patch_request_2) do
+            stub_request(:patch, deployed_version_url_2).to_return(status: 400, body: { errors: { foo: ["some error"]}}.to_json, headers: { "Content-Type" => "application/hal+json" })
+          end
+
+          let(:returned_target_2) { "customer-1" }
+
+          its(:success) { is_expected.to be false }
+          its(:message) { is_expected.to include "Recorded undeployment of Foo version 2" }
+          its(:message) { is_expected.to include "some error" }
+        end
+
+        context "when there is no currently-deployed-versions relation in the environment resource" do
+          let(:environment_hash) do
+            {
+              _links: {}
+            }
+          end
+
+          its(:success) { is_expected.to be false }
+          its(:message) { is_expected.to include "support" }
+        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>" }
+
+          its(:success) { is_expected.to be false }
+          its(:message) { is_expected.to include expected_message }
+
+          context "when output is json" do
+            let(:output) { "json" }
+
+            its(:message) { is_expected.to eq({ error: { message: expected_message } }.to_json) }
+          end
+        end
+
+        context "when a target is not provided and there is no deployed verison without a target" do
+          let(:target) { 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" }
+        end
+
+        context "when there are no deployed versions for the pacticipant" do
+          let(:deployed_versions_hash) do
+            {
+              _embedded: {
+                deployedVersions: []
+              }
+            }
+          end
+
+          its(:success) { is_expected.to be false }
+          its(:message) { is_expected.to include "Foo is not currently deployed to test environment. Cannot record undeployment." }
+
+          context "when the pacticipant does not exist" do
+            let(:pacticipant_request_status) { 404 }
+
+            its(:success) { is_expected.to be false }
+            its(:message) { is_expected.to include "No pacticipant with name 'Foo' found" }
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/client/environments/delete_environment_spec.rb

@@ -0,0 +1,120 @@
+require 'pact_broker/client/environments/delete_environment'
+
+module PactBroker
+  module Client
+    module Environments
+      describe DeleteEnvironment do
+        before do
+          allow_any_instance_of(PactBroker::Client::Hal::HttpClient).to receive(:sleep)
+          allow_any_instance_of(PactBroker::Client::Hal::HttpClient).to receive(:default_max_tries).and_return(1)
+        end
+
+        let(:params) do
+          {
+            uuid: uuid,
+            name: "new name",
+            displayName: "new display name",
+            production: false,
+            output: output
+          }
+        end
+        let(:options) do
+          {
+            output: output,
+            verbose: verbose
+          }
+        end
+        let(:uuid) { "a9aa4c22-66bb-45d3-ba4c-4916ac8b48c5" }
+        let(:pact_broker_base_url) { "http://example.org" }
+        let(:pact_broker_client_options) { { pact_broker_base_url: pact_broker_base_url } }
+        let(:response_headers) { { "Content-Type" => "application/hal+json"} }
+        let(:output) { "text" }
+        let(:verbose) { false }
+
+        before do
+          stub_request(:get, "http://example.org/").to_return(status: 200, body: index_response_body, headers: response_headers)
+          stub_request(:get, "http://example.org/environments/#{uuid}").to_return(status: get_environment_response_status, body: get_environment_response_body, headers: response_headers)
+          stub_request(:delete, "http://example.org/environments/#{uuid}").to_return(status: delete_response_status, body: delete_environment_response_body, headers: response_headers)
+        end
+        let(:delete_response_status) { 200 }
+        let(:get_environment_response_status) { 200 }
+
+        let(:index_response_body) do
+          {
+            "_links" => {
+              "pb:environments" => {},
+              "pb:environment" => {
+                "href" => "http://example.org/environments/{uuid}"
+              }
+            }
+          }.to_json
+        end
+
+        let(:get_environment_response_body) do
+          {
+            name: "existing name",
+            displayName: "existing display name",
+            production: true
+          }.to_json
+        end
+
+        let(:delete_environment_response_body) do
+          JSON.parse(get_environment_response_body).merge("updatedAt" => "2021-05-28T13:34:54+10:00").to_json
+        end
+
+        subject { DeleteEnvironment.call(params, options, pact_broker_client_options) }
+
+        context "when delete is successful" do
+          its(:success) { is_expected.to be true }
+          its(:message) { is_expected.to include "Deleted environment existing name from the Pact Broker" }
+
+          context "when output is json" do
+            let(:output) { "json" }
+
+            its(:message) { is_expected.to eq delete_environment_response_body }
+          end
+        end
+
+        context "when environments are not supported" do
+          let(:index_response_body) { "{}" }
+
+          its(:success) { is_expected.to be false }
+          its(:message) { is_expected.to include "does not support environments" }
+        end
+
+        context "when the environment does not exist" do
+          let(:get_environment_response_status) { 404 }
+          let(:get_environment_response_body) { "" }
+          let(:delete_environment_response_body) { "" }
+
+          its(:success) { is_expected.to be false }
+          its(:message) { is_expected.to include get_environment_response_body }
+
+          context "when output is json" do
+            let(:output) { "json" }
+
+            its(:message) { is_expected.to eq "{}" }
+          end
+        end
+
+        context "when delete is unsuccessful" do
+          let(:delete_response_status) { 500 }
+          let(:delete_environment_response_body) do
+            {
+              "some" => "error"
+            }.to_json
+          end
+
+          its(:success) { is_expected.to be false }
+          its(:message) { is_expected.to include delete_environment_response_body }
+
+          context "when output is json" do
+            let(:output) { "json" }
+
+            its(:message) { is_expected.to eq delete_environment_response_body }
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/client/environments/describe_environment_spec.rb

@@ -0,0 +1,89 @@
+require 'pact_broker/client/environments/describe_environment'
+
+module PactBroker
+  module Client
+    module Environments
+      describe DescribeEnvironment do
+        before do
+          allow_any_instance_of(PactBroker::Client::Hal::HttpClient).to receive(:sleep)
+          allow_any_instance_of(PactBroker::Client::Hal::HttpClient).to receive(:default_max_tries).and_return(1)
+        end
+
+        let(:params) { { uuid: uuid } }
+        let(:options) { { output: output }}
+        let(:uuid) { "a9aa4c22-66bb-45d3-ba4c-4916ac8b48c5" }
+        let(:pact_broker_base_url) { "http://example.org" }
+        let(:pact_broker_client_options) { { pact_broker_base_url: pact_broker_base_url } }
+        let(:response_headers) { { "Content-Type" => "application/hal+json"} }
+        let(:output) { "text" }
+
+        before do
+          stub_request(:get, "http://example.org/").to_return(status: 200, body: index_response_body, headers: response_headers)
+          stub_request(:get, "http://example.org/environments/#{uuid}").to_return(status: get_environment_response_status, body: get_environment_response_body, headers: response_headers)
+        end
+
+        let(:get_environment_response_status) { 200 }
+        let(:index_response_body) do
+          {
+            "_links" => {
+              "pb:environments" => {},
+              "pb:environment" => {
+                "href" => "http://example.org/environments/{uuid}"
+              }
+            }
+          }.to_json
+        end
+
+        let(:get_environment_response_body) do
+          {
+            name: "existing name",
+            displayName: "existing display name",
+            production: true,
+            contacts: [
+              name: "Someone",
+              details: { emailAddress: "foo@bar.com" }
+            ]
+          }.to_json
+        end
+
+        subject { DescribeEnvironment.call(params, options, pact_broker_client_options) }
+
+        context "when the environment exists" do
+          its(:success) { is_expected.to be true }
+
+          it "describes the environment" do
+            Approvals.verify(subject.message, :name => "describe_environment", format: :txt)
+          end
+
+          context "when output is json" do
+            let(:output) { "json" }
+
+            its(:message) { is_expected.to eq get_environment_response_body }
+          end
+        end
+
+        context "when environments are not supported" do
+          let(:index_response_body) { "{}" }
+
+          its(:success) { is_expected.to be false }
+          its(:message) { is_expected.to include "does not support environments" }
+        end
+
+        context "when the environment does not exist" do
+          let(:get_environment_response_status) { 404 }
+          let(:get_environment_response_body) { "" }
+          let(:put_environment_response_body) { "" }
+
+          its(:success) { is_expected.to be false }
+          its(:message) { is_expected.to include get_environment_response_body }
+
+          context "when output is json" do
+            let(:output) { "json" }
+
+            its(:message) { is_expected.to eq "{}" }
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/client/environments/update_environment_spec.rb

@@ -0,0 +1,167 @@
+require 'pact_broker/client/environments/update_environment'
+
+module PactBroker
+  module Client
+    module Environments
+      describe UpdateEnvironment do
+        before do
+          allow_any_instance_of(PactBroker::Client::Hal::HttpClient).to receive(:sleep)
+          allow_any_instance_of(PactBroker::Client::Hal::HttpClient).to receive(:default_max_tries).and_return(1)
+        end
+
+        let(:params) do
+          {
+            uuid: uuid,
+            name: "new name",
+            display_name: "new display name",
+            production: false
+          }
+        end
+        let(:options) do
+          {
+            output: output,
+            verbose: verbose
+          }
+        end
+        let(:uuid) { "a9aa4c22-66bb-45d3-ba4c-4916ac8b48c5" }
+        let(:pact_broker_base_url) { "http://example.org" }
+        let(:pact_broker_client_options) { { pact_broker_base_url: pact_broker_base_url } }
+        let(:response_headers) { { "Content-Type" => "application/hal+json"} }
+        let(:output) { "text" }
+        let(:verbose) { false }
+
+        before do
+          stub_request(:get, "http://example.org/").to_return(status: 200, body: index_response_body, headers: response_headers)
+          stub_request(:get, "http://example.org/environments/#{uuid}").to_return(status: get_environment_response_status, body: get_environment_response_body, headers: response_headers)
+          stub_request(:put, "http://example.org/environments/#{uuid}").to_return(status: put_response_status, body: put_environment_response_body, headers: response_headers)
+        end
+        let(:put_response_status) { 200 }
+        let(:get_environment_response_status) { 200 }
+        let(:put_request_body) do
+          {
+            name: "new name",
+            displayName: "new display name",
+            production: false
+          }.to_json
+        end
+
+        let(:index_response_body) do
+          {
+            "_links" => {
+              "pb:environments" => {},
+              "pb:environment" => {
+                "href" => "http://example.org/environments/{uuid}"
+              }
+            }
+          }.to_json
+        end
+
+        let(:get_environment_response_body) do
+          {
+            name: "existing name",
+            displayName: "existing display name",
+            production: true
+          }.to_json
+        end
+
+        let(:put_environment_response_body) do
+          JSON.parse(get_environment_response_body).merge("updatedAt" => "2021-05-28T13:34:54+10:00").to_json
+        end
+
+        subject { UpdateEnvironment.call(params, options, pact_broker_client_options) }
+
+        it "updates the environment" do
+          request = stub_request(:put, "http://example.org/environments/#{uuid}").with(body: put_request_body)
+          subject
+          expect(request).to have_been_made
+        end
+
+        context "when update is successful" do
+          its(:success) { is_expected.to be true }
+          its(:message) { is_expected.to include "Updated new name environment in the Pact Broker" }
+
+          context "when output is json" do
+            let(:output) { "json" }
+
+            its(:message) { is_expected.to eq put_environment_response_body }
+          end
+        end
+
+        context "when environments are not supported" do
+          let(:index_response_body) { "{}" }
+
+          its(:success) { is_expected.to be false }
+          its(:message) { is_expected.to include "does not support environments" }
+        end
+
+        context "when a StandardError occurs" do
+          before do
+            allow_any_instance_of(described_class).to receive(:do_call).and_raise(StandardError.new("Foo"))
+          end
+
+          its(:success) { is_expected.to be false }
+          its(:message) { is_expected.to include "StandardError - Foo" }
+
+          context "when verbose is on" do
+            let(:verbose) { true }
+
+            it "includes the message and class and backtrace in the error" do
+              expect(subject.message.split("\n").size).to be > 2
+            end
+          end
+
+          context "when output is json" do
+            let(:output) { "json" }
+
+            it "includes the message and class in the error" do
+              message_hash = JSON.parse(subject.message)
+              expect(message_hash).to eq "error" => { "message" => "Foo", "class" => "StandardError" }
+            end
+
+            context "when verbose is on" do
+              let(:verbose) { true }
+
+              it "includes the message and class and backtrace in the error" do
+                message_hash = JSON.parse(subject.message)
+                expect(message_hash["error"]["backtrace"]).to be_a(Array)
+              end
+            end
+          end
+        end
+
+        context "when the environment does not exist" do
+          let(:get_environment_response_status) { 404 }
+          let(:get_environment_response_body) { "" }
+          let(:put_environment_response_body) { "" }
+
+          its(:success) { is_expected.to be false }
+          its(:message) { is_expected.to include get_environment_response_body }
+
+          context "when output is json" do
+            let(:output) { "json" }
+
+            its(:message) { is_expected.to eq "{}" }
+          end
+        end
+
+        context "when update is unsuccessful" do
+          let(:put_response_status) { 400 }
+          let(:put_environment_response_body) do
+            {
+              "some" => "error"
+            }.to_json
+          end
+
+          its(:success) { is_expected.to be false }
+          its(:message) { is_expected.to include put_environment_response_body }
+
+          context "when output is json" do
+            let(:output) { "json" }
+
+            its(:message) { is_expected.to eq put_environment_response_body }
+          end
+        end
+      end
+    end
+  end
+end