pact_broker-client 1.41.0 → 1.42.0

data/lib/pact_broker/client/pacticipants/text_formatter.rb

@@ -0,0 +1,41 @@
+require 'table_print'
+require 'ostruct'
+
+module PactBroker
+  module Client
+    module Pacticipants2
+      class TextFormatter
+        def self.call(pacticipants)
+          return "" if pacticipants.size == 0
+
+          data = pacticipants.collect do | pacticipant |
+            # Might add a UUID in at some stage. Backwards compatible supporting code.
+            OpenStruct.new({ uuid: "" }.merge(pacticipant).merge(url: pacticipant["_links"]["self"]["href"]))
+          end.sort_by{ | pacticipant | pacticipant.name.downcase }
+
+          TablePrint::Printer.new(data, tp_options(data)).table_print
+        end
+
+        def self.tp_options(data)
+          uuid_width = max_width(data, :uuid, "")
+          name_width = max_width(data, :name, "NAME")
+          display_name_width = max_width(data, :displayName, "DISPLAY NAME")
+
+          tp_options = [
+            { name: { width: name_width} },
+            { displayName: { display_name: "Display name", width: display_name_width } },
+          ]
+
+          if uuid_width > 0
+            tp_options.unshift({ uuid: { width: uuid_width } })
+          end
+          tp_options
+        end
+
+        def self.max_width(data, column, title)
+          (data.collect{ |row| row.send(column) } + [title]).compact.collect(&:size).max
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/string_refinements.rb

@@ -0,0 +1,56 @@
+module PactBroker
+  module Client
+    module StringRefinements
+      refine NilClass do
+        def blank?
+          true
+        end
+      end
+
+      refine String do
+        def not_blank?
+          !blank?
+        end
+
+        def blank?
+          self.strip.size == 0
+        end
+
+        # ripped from rubyworks/facets, thank you
+        def snakecase
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+          .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+          .tr('-', '_')
+          .gsub(/\s/, '_')
+          .gsub(/__+/, '_')
+          .downcase
+        end
+
+        # ripped from rubyworks/facets, thank you
+        def camelcase(*separators)
+          case separators.first
+          when Symbol, TrueClass, FalseClass, NilClass
+            first_letter = separators.shift
+          end
+
+          separators = ['_', '\s'] if separators.empty?
+
+          str = self.dup
+
+          separators.each do |s|
+            str = str.gsub(/(?:#{s}+)([a-z])/){ $1.upcase }
+          end
+
+          case first_letter
+          when :upper, true
+            str = str.gsub(/(\A|\s)([a-z])/){ $1 + $2.upcase }
+          when :lower, false
+            str = str.gsub(/(\A|\s)([A-Z])/){ $1 + $2.downcase }
+          end
+
+          str
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.41.0'
+    VERSION = '1.42.0'
   end
 end

data/pact-broker-client.gemspec

@@ -34,4 +34,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'pact', '~> 1.16'
   gem.add_development_dependency 'pact-support', '~> 1.16'
   gem.add_development_dependency 'approvals', '>=0.0.24', '<1.0.0'
+  gem.add_development_dependency 'rspec-its', '~> 1.3'
 end

data/spec/fixtures/approvals/describe_environment.approved.txt

@@ -0,0 +1,7 @@
+Name: existing name
+Display Name: existing display name
+Production: true
+Contacts:
+- Name: Someone
+  Details:
+    Email Address: foo@bar.com

data/spec/fixtures/approvals/list_environments.approved.txt

@@ -0,0 +1,3 @@
+UUID                                 | NAME | DISPLAY NAME | PRODUCTION
+-------------------------------------|------|--------------|-----------
+78e85fb2-9df1-48da-817e-c9bea6294e01 | test | Test         | false     

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

@@ -37,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, to_environment: nil, limit: 1000, ignore_selectors: []}, {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, ignore_selectors: []}, {output: 'table', retry_while_unknown: 1, retry_interval: 2}, { pact_broker_base_url: 'http://pact-broker', verbose: 'verbose' })
           invoke_can_i_deploy
         end
 
@@ -78,7 +78,7 @@ module PactBroker
           end
 
           it "invokes the CanIDeploy service with the basic auth credentials" do
-            expect(CanIDeploy).to receive(:call).with(anything, anything, anything, anything, {basic_auth: {username: "foo", password: "bar"}, verbose: 'verbose'})
+            expect(CanIDeploy).to receive(:call).with(anything, anything, anything, anything, { pact_broker_base_url: 'http://pact-broker', basic_auth: {username: "foo", password: "bar"}, verbose: 'verbose'})
             invoke_can_i_deploy
           end
         end
@@ -89,7 +89,7 @@ module PactBroker
           end
 
           it "invokes the CanIDeploy service with the basic auth credentials" do
-            expect(CanIDeploy).to receive(:call).with(anything, anything, anything, anything, {token: "some token", verbose: 'verbose'})
+            expect(CanIDeploy).to receive(:call).with(anything, anything, anything, anything, {pact_broker_base_url: 'http://pact-broker', token: "some token", verbose: 'verbose'})
             invoke_can_i_deploy
           end
         end

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

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

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

@@ -66,7 +66,7 @@ module PactBroker
           it "calls PactBroker::Client::Webhooks::Create with pact broker details" do
             expect(PactBroker::Client::Webhooks::Create).to receive(:call) do | _, broker_base_url, pact_broker_client_options |
               expect(broker_base_url).to eq "http://broker"
-              expect(pact_broker_client_options).to eq(basic_auth: { username: "username", password: "password"}, verbose: true)
+              expect(pact_broker_client_options).to eq(pact_broker_base_url: 'http://broker', basic_auth: { username: "username", password: "password"}, verbose: true)
               command_result
             end
             subject
@@ -92,7 +92,7 @@ module PactBroker
 
             it "calls Webhooks::Create without basic auth" do
               expect(PactBroker::Client::Webhooks::Create).to receive(:call) do | _, _, pact_broker_client_options |
-                expect(pact_broker_client_options).to eq(verbose: true)
+                expect(pact_broker_client_options).to eq(verbose: true, pact_broker_base_url: 'http://broker')
                 command_result
               end
               subject
@@ -110,7 +110,7 @@ module PactBroker
             it "calls Webhooks::Create without basic auth" do
 
               expect(PactBroker::Client::Webhooks::Create).to receive(:call) do | _, _, pact_broker_client_options |
-                expect(pact_broker_client_options).to eq(verbose: true, token: "token")
+                expect(pact_broker_client_options).to eq(verbose: true, token: "token", pact_broker_base_url: 'http://broker')
                 command_result
               end
               subject

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