pact_broker-client 1.40.0 → 1.45.0

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.40.0'
+    VERSION = '1.45.0'
   end
 end

data/lib/pact_broker/client/versions.rb

@@ -1,4 +1,7 @@
-require_relative 'base_client'
+require 'pact_broker/client/base_client'
+require 'pact_broker/client/versions/describe'
+
+# Old code
 require 'pact_broker/client/pacts'
 
 module PactBroker

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

@@ -1,9 +1,11 @@
+# Need Versions class to extend BaseClient until we can remove the old Versions code
+require 'pact_broker/client/base_client'
 require 'pact_broker/client/pact_broker_client'
 require 'pact_broker/client/versions/formatter'
 
 module PactBroker
   module Client
-    class Versions
+    class Versions < BaseClient
       class Describe
 
         class Result

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

@@ -1,9 +1,11 @@
+# Need Versions class to extend BaseClient until we can remove the old Versions code
+require 'pact_broker/client/base_client'
 require 'pact_broker/client/versions/json_formatter'
 require 'pact_broker/client/versions/text_formatter'
 
 module PactBroker
   module Client
-    class Versions
+    class Versions < BaseClient
       class Formatter
         def self.call(matrix_lines, format)
           formatter = case format

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

@@ -1,11 +1,13 @@
+# Need Versions class to extend BaseClient until we can remove the old Versions code
+require 'pact_broker/client/base_client'
 require 'table_print'
 
 module PactBroker
   module Client
-    class Versions
+    class Versions < BaseClient
       class JsonFormatter
-        def self.call(matrix)
-          JSON.pretty_generate(matrix)
+        def self.call(version)
+          JSON.pretty_generate(version)
         end
       end
     end

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

@@ -1,8 +1,10 @@
+# Need Versions class to extend BaseClient until we can remove the old Versions code
+require 'pact_broker/client/base_client'
 require 'table_print'
 
 module PactBroker
   module Client
-    class Versions
+    class Versions < BaseClient
       class TextFormatter
 
         Line = Struct.new(:number, :tags)

data/pact-broker-client.gemspec

@@ -33,4 +33,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'conventional-changelog', '~>1.3'
   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/script/approve-all.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+for file in $(find spec/fixtures/approvals -ipath "*.received.*"); do
+  approved_path=$(echo "$file" | sed 's/received/approved/')
+  mv "$file" "$approved_path"
+done;

data/script/publish-pact.sh

@@ -1,3 +1,6 @@
+export PACT_BROKER_BASE_URL="http://localhost:9292"
+export PACT_BROKER_TOKEN="localhost"
+
 # bundle exec bin/pact-broker create-or-update-webhook http://localhost:9393 \
 #   --uuid d40f38c3-aaa3-47f5-9161-95c07bc16b14 \
 #   --request POST \
@@ -5,18 +8,18 @@
 #   --contract-published
 
 bundle exec bin/pact-broker create-or-update-webhook http://localhost:9393 \
-  --uuid d40f38c3-aaa3-47f5-9161-95c07bc16555 \
-  --provider Bar \
+  --uuid d40f38c3-aaa3-47f5-9161-95csfadfsd7 \
+  --description "This is quite a long description for a webhook that I hope will be truncated" \
   --request POST \
   --contract-published
 
-bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json spec/pacts/foo-bar.json \
-  --consumer-app-version 1.2.12 \
-  --broker-base-url http://localhost:9292 \
-   --broker-username localhost --broker-password localhost \
-    --auto-detect-version-properties \
-    --build-url http://mybuild \
-    --branch master --tag foo5
+# bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json spec/fixtures/foo-bar.json \
+#   --consumer-app-version 1.2.12 \
+#   --broker-base-url http://localhost:9292 \
+#    --broker-username localhost --broker-password localhost \
+#     --auto-detect-version-properties \
+#     --build-url http://mybuild \
+#     --branch master --tag foo5
 
 # bundle exec bin/pact-broker create-or-update-webhook http://localhost:9393 \
 #   --uuid d40f38c3-aaa3-47f5-9161-95c07bc16555 \

data/script/record-deployments-and-releases.sh

@@ -0,0 +1,18 @@
+export PACT_BROKER_FEATURES=deployments
+
+bundle exec bin/pact-broker create-or-update-pacticipant --name Foo
+bundle exec bin/pact-broker create-version-tag --pacticipant Foo --version 2 --tag main --auto-create-version
+bundle exec bin/pact-broker describe-version --pacticipant Foo --version 2
+bundle exec bin/pact-broker create-environment --name test
+bundle exec bin/pact-broker can-i-deploy --pacticipant Foo --version 2 --to-environment test
+
+bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test
+bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test --target customer-1
+bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test --target customer-1
+
+bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test
+bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test
+bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test --target customer-1
+
+bundle exec bin/pact-broker record-release --pacticipant Foo --version 2 --environment test
+bundle exec bin/pact-broker record-support-ended --pacticipant Foo --version 2 --environment test

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

@@ -0,0 +1,7 @@
+[dry-run] Computer says no ¯\_(ツ)_/¯ (but you're ignoring this by enabling dry run)
+[dry-run] 
+[dry-run] text matrix
+[dry-run] 
+[dry-run] some reason
+[dry-run] 
+[dry-run] Dry run enabled - ignoring any failures

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

@@ -0,0 +1,13 @@
+Computer says yes \o/ 
+
+CONSUMER | C.VERSION | PROVIDER | P.VERSION | SUCCESS?        | RESULT#
+---------|-----------|----------|-----------|-----------------|--------
+Foo      | 1.2.3     | Bar      | 4.5.6     | true            | 1      
+Foo      | 3.4.5     | Bar      | 4.5.6     | false [ignored] | 2      
+
+VERIFICATION RESULTS
+--------------------
+1. http://result (success)
+2. http://result (failure)
+
+some notice

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

@@ -0,0 +1,7 @@
+[dry-run] Computer says yes \o/ (and maybe you don't need to enable dry run)
+[dry-run] 
+[dry-run] text matrix
+[dry-run] 
+[dry-run] some reason
+[dry-run] 
+[dry-run] Dry run enabled - ignoring any failures

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/describe_pacticipant.approved.txt

@@ -0,0 +1,2 @@
+Name: Pricing Service
+Repository Url: git@git.realestate.com.au:business-systems/pricing-service

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/integration/describe_environment_spec.rb

@@ -0,0 +1,31 @@
+require 'pact_broker/client/cli/broker'
+
+RSpec.describe "describe-environment" do
+  let(:index_body_hash) do
+    {
+      _links: {
+        "pb:pacticipant" => {
+          href: "http://broker/pacticipants/{pacticipant}"
+        }
+      }
+    }
+  end
+
+  let(:pacticipant_body_hash) { JSON.parse(File.read("./spec/support/pacticipant_get.json")) }
+
+  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!(:pacticipant_request) do
+    stub_request(:get, "http://broker/pacticipants/Foo").to_return(status: 200, body: pacticipant_body_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+  end
+
+  let(:parameters) { %w{describe-pacticipant --name Foo --broker-base-url http://broker} }
+
+  subject { capture(:stdout) { PactBroker::Client::CLI::Broker.start(parameters) } }
+
+  it "prints the pacticipant properties" do
+    Approvals.verify(subject, :name => "describe_pacticipant", format: :txt)
+  end
+end

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

@@ -6,22 +6,28 @@ module PactBroker
     describe CanIDeploy do
       let(:pact_broker_base_url) { 'http://example.org' }
       let(:version_selectors) { [{ pacticipant: "Foo", version: "1" }] }
-      let(:matrix_options) { {} }
+      let(:matrix_options) { { } }
       let(:pact_broker_client_options) { { foo: 'bar' } }
+      let(:dry_run) { false }
       let(:matrix_client) { instance_double('PactBroker::Client::Matrix') }
       let(:matrix) do
         instance_double('Matrix::Resource',
-          deployable?: true,
+          deployable?: deployable,
           reason: 'some reason',
           any_unknown?: any_unknown,
           supports_unknown_count?: supports_unknown_count,
-          unknown_count: unknown_count)
+          supports_ignore?: supports_ignore,
+          unknown_count: unknown_count,
+          notices: notices)
       end
       let(:unknown_count) { 0 }
       let(:any_unknown) { unknown_count > 0 }
       let(:supports_unknown_count) { true }
       let(:retry_while_unknown) { 0 }
-      let(:options) { { output: 'text', retry_while_unknown: retry_while_unknown, retry_interval: 5 } }
+      let(:options) { { output: 'text', retry_while_unknown: retry_while_unknown, retry_interval: 5, dry_run: dry_run } }
+      let(:notices) { nil }
+      let(:supports_ignore) { true }
+      let(:deployable) { true }
 
 
       before do
@@ -55,10 +61,27 @@ module PactBroker
         it "returns a success reason" do
           expect(subject.message).to include "some reason"
         end
+
+        context "when there are notices" do
+          let(:notices) { [Notice.new(text: "some notice", type: "info")] }
+
+          it "returns the notices instead of the reason" do
+            expect(subject.message).to_not include "some reason"
+            expect(subject.message).to include "some notice"
+          end
+        end
+
+        context "when dry_run is enabled" do
+          let(:dry_run) { true }
+
+          it "prefixes each line with [dry-run]" do
+            Approvals.verify(subject.message, :name => "can_i_deploy_success_dry_run", format: :txt)
+          end
+        end
       end
 
       context "when the versions are not deployable" do
-        let(:matrix) { instance_double('Matrix::Resource', deployable?: false, reason: 'some reason', any_unknown?: false) }
+        let(:matrix) { instance_double('Matrix::Resource', deployable?: false, reason: 'some reason', any_unknown?: false, notices: notices) }
 
         it "returns a failure response" do
           expect(subject.success).to be false
@@ -71,6 +94,27 @@ module PactBroker
         it "returns a failure reason" do
           expect(subject.message).to include "some reason"
         end
+
+        context "when there are notices" do
+          let(:notices) { [Notice.new(text: "some notice", type: "info")] }
+
+          it "returns the notices instead of the reason" do
+            expect(subject.message).to_not include "some reason"
+            expect(subject.message).to include "some notice"
+          end
+        end
+
+        context "when dry_run is enabled" do
+          let(:dry_run) { true }
+
+          it "returns a success response" do
+            expect(subject.success).to be true
+          end
+
+          it "prefixes each line with [dry-run]" do
+            Approvals.verify(subject.message, :name => "can_i_deploy_failure_dry_run", format: :txt)
+          end
+        end
       end
 
       context "when retry_while_unknown is greater than 0" do
@@ -112,6 +156,38 @@ module PactBroker
           it "returns a failure message" do
             expect(subject.message).to match /does not provide a count/
           end
+
+          context "when dry_run is enabled" do
+            let(:dry_run) { true }
+
+            it "returns a success response" do
+              expect(subject.success).to be true
+            end
+
+            it "returns a failure message" do
+              expect(subject.message).to include "[dry-run]"
+              expect(subject.message).to match /does not provide a count/
+            end
+          end
+        end
+      end
+
+      context "when there are ignore selectors but the matrix does not support ignoring" do
+        let(:matrix_options) { { ignore_selectors: [{ pacticipant_name: "Foo" }]} }
+        let(:supports_ignore) { false }
+
+        context "when deployable" do
+          it "returns a warning" do
+            expect(subject.message).to include "does not support"
+          end
+        end
+
+        context "when not deployable" do
+          let(:deployable) { false }
+
+          it "returns a warning" do
+            expect(subject.message).to include "does not support"
+          end
         end
       end
 
@@ -125,7 +201,20 @@ module PactBroker
         end
 
         it "returns a failure message" do
-          expect(subject.message).to eq "error text"
+          expect(subject.message).to include "error text"
+        end
+
+        context "when dry_run is enabled" do
+          let(:dry_run) { true }
+
+          it "returns a success response" do
+            expect(subject.success).to be true
+          end
+
+          it "returns a failure message" do
+            expect(subject.message).to include "[dry-run]"
+            expect(subject.message).to match /error text/
+          end
         end
       end
 
@@ -141,7 +230,20 @@ module PactBroker
         end
 
         it "returns a failure message and backtrace" do
-          expect(subject.message).to include "Error retrieving matrix. StandardError - error text\n"
+          expect(subject.message).to include "Error retrieving matrix. StandardError - error text"
+        end
+
+        context "when dry_run is enabled" do
+          let(:dry_run) { true }
+
+          it "returns a success response" do
+            expect(subject.success).to be true
+          end
+
+          it "returns a failure message" do
+            expect(subject.message).to include "[dry-run]"
+            expect(subject.message).to match /error text/
+          end
         end
       end
     end