pact_broker-client 1.39.0 → 1.44.0

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

data/spec/lib/pact_broker/client/generate_display_name_spec.rb

@@ -0,0 +1,39 @@
+require 'pact_broker/client/generate_display_name'
+
+module PactBroker
+  module Client
+    describe GenerateDisplayName do
+      describe ".call" do
+        TEST_CASES = {
+          "foo" => "Foo",
+          "MyService" => "My Service",
+          "my-service" => "My Service",
+          "my_service" => "My Service",
+          "my service" => "My Service",
+          "ABCService" => "ABC Service",
+          "A4Service" => "A4 Service",
+          "SNSPactEventConsumer" => "SNS Pact Event Consumer",
+          "AWSSummiteerWeb" => "AWS Summiteer Web",
+          "Beer-Consumer" => "Beer Consumer",
+          "foo.pretend-consumer" => "Foo Pretend Consumer",
+          "Client-XX" => "Client XX",
+          "providerJSWorkshop" => "Provider JS Workshop",
+          "e2e Provider Example" => "E2e Provider Example",
+          "MP - Our Provider" => "MP - Our Provider",
+          "PoC - Pact-broker-consumer" => "PoC - Pact Broker Consumer",
+          "QB-DATABASE Service" => "QB DATABASE Service",
+          "Support Species App (Provider)" => "Support Species App (Provider)",
+          9 => "9",
+          "" => "",
+          nil => nil
+        }
+
+        TEST_CASES.each do | name, expected_display_name |
+          it "converts #{name.inspect} to #{expected_display_name.inspect}" do
+            expect(GenerateDisplayName.call(name)).to eq expected_display_name
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -73,7 +73,7 @@ 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 making request to http://pact status="
           end
         end
 
@@ -83,7 +83,7 @@ module PactBroker::Client
           subject(:entity) { ErrorEntity.new("http://pact", pact_hash, http_client, response) }
 
           it "raises an error" do
-            expect { entity.assert_success! }.to raise_error ErrorResponseReturned, "Error retrieving http://pact status=200 body"
+            expect { entity.assert_success! }.to raise_error ErrorResponseReturned, "Error making request to http://pact status=200 body"
           end
         end
       end

data/spec/lib/pact_broker/client/pacticipants/create_spec.rb

@@ -8,11 +8,11 @@ module PactBroker
           before do
             allow_any_instance_of(PactBroker::Client::Hal::HttpClient).to receive(:sleep)
           end
-          let(:pact_broker_client_options) { {} }
+          let(:pact_broker_client_options) { { pact_broker_base_url: broker_base_url} }
           let(:broker_base_url) { "http://url" }
           let(:params) { { name: 'Foo' } }
 
-          subject { Create.call(params, broker_base_url, pact_broker_client_options)}
+          subject { Create.call(params, {}, pact_broker_client_options)}
 
           context "when there is an http error" do
             let!(:index_request) do