pact_broker-client 1.40.0 → 1.41.0

data/lib/pact_broker/client/colorize_notices.rb

@@ -0,0 +1,31 @@
+require 'term/ansicolor'
+
+module PactBroker
+  module Client
+    class ColorizeNotices
+      def self.call(notices)
+        notices.collect do | notice |
+          colorized_message(notice)
+        end
+      end
+
+      def self.colorized_message(notice)
+        color = color_for_type(notice.type)
+        if color
+          ::Term::ANSIColor.color(color, notice.text || '')
+        else
+          notice.text
+        end
+      end
+
+      def self.color_for_type(type)
+        case type
+        when "warning", "prompt" then "yellow"
+        when "error", "danger" then :red
+        when "success" then :green
+        else nil
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/matrix.rb

@@ -60,6 +60,9 @@ module PactBroker
         elsif selectors.size == 1 && !options[:to_environment]
           opts[:latest] = 'true'
         end
+        if options[:ignore_selectors] && options[:ignore_selectors].any?
+          opts[:ignore] = convert_selector_hashes_to_params(options[:ignore_selectors])
+        end
         opts
       end
 
@@ -69,6 +72,7 @@ module PactBroker
             hash[:version] = selector[:version] if selector[:version]
             hash[:latest] = 'true' if selector[:latest]
             hash[:tag] = selector[:tag] if selector[:tag]
+            hash[:branch] = selector[:branch] if selector[:branch]
           end
         end
       end

data/lib/pact_broker/client/matrix/abbreviate_version_number.rb

@@ -0,0 +1,15 @@
+module PactBroker
+  module Client
+    class Matrix
+      class AbbreviateVersionNumber
+        def self.call version_number
+          if version_number
+            version_number.gsub(/[A-Za-z0-9]{40}/) do | val |
+              val[0...7] + "..."
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/matrix/resource.rb

@@ -2,9 +2,22 @@ require 'pact_broker/client/base_client'
 
 module PactBroker
   module Client
+    class Notice < Hash
+      def initialize(hash)
+        self.merge!(hash)
+      end
+
+      def text
+        self[:text]
+      end
+
+      def type
+        self[:type]
+      end
+    end
     class Matrix < BaseClient
-      class Resource < Hash
 
+      class Resource < Hash
         def initialize hash
           self.merge!(hash)
         end
@@ -21,6 +34,10 @@ module PactBroker
           !!(self[:summary] && Integer === self[:summary][:unknown] )
         end
 
+        def supports_ignore?
+          !!(self[:summary] && Integer === self[:summary][:ignored] )
+        end
+
         def unknown_count
           supports_unknown_count? ? self[:summary][:unknown] : nil
         end
@@ -32,6 +49,14 @@ module PactBroker
         def deployable?
           self[:summary][:deployable]
         end
+
+        def notices
+          if self[:notices].is_a?(Array)
+            self[:notices].collect { | notice_hash | Notice.new(notice_hash) }
+          else
+            nil
+          end
+        end
       end
     end
   end

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

@@ -1,6 +1,7 @@
 require 'table_print'
 require 'dig_rb'
 require 'pact_broker/client/hash_refinements'
+require 'pact_broker/client/matrix/abbreviate_version_number'
 
 module PactBroker
   module Client
@@ -8,18 +9,19 @@ module PactBroker
       class TextFormatter
         using PactBroker::Client::HashRefinements
 
-        Line = Struct.new(:consumer, :consumer_version, :provider, :provider_version, :success, :ref)
+        Line = Struct.new(:consumer, :consumer_version, :provider, :provider_version, :success, :ref, :ignored)
 
-        OPTIONS = [
+        TP_OPTIONS = [
           { consumer: {} },
           { consumer_version: {display_name: 'C.VERSION'} },
           { provider: {} },
           { provider_version: {display_name: 'P.VERSION'} },
           { success: {display_name: 'SUCCESS?'} },
-          { ref: { display_name: 'RESULT#' }}
+          { ref: { display_name: 'RESULT#' } }
         ]
 
         def self.call(matrix)
+          tp_options = TP_OPTIONS.dup
           matrix_rows = matrix[:matrix]
           return "" if matrix_rows.size == 0
           verification_result_number = 0
@@ -30,15 +32,16 @@ module PactBroker
             end
             Line.new(
               lookup(line, "???", :consumer, :name),
-              lookup(line, "???", :consumer, :version, :number),
+              AbbreviateVersionNumber.call(lookup(line, "???", :consumer, :version, :number)),
               lookup(line, "???", :provider, :name) ,
-              lookup(line, "???", :provider, :version, :number),
-              (lookup(line, "???", :verificationResult, :success)).to_s,
-              has_verification_result_url ? verification_result_number : ""
+              AbbreviateVersionNumber.call(lookup(line, "???", :provider, :version, :number)),
+              (lookup(line, "???", :verificationResult, :success)).to_s + ( line[:ignored] ? " [ignored]" : ""),
+              has_verification_result_url ? verification_result_number : "",
+              lookup(line, nil, :ignored)
             )
           end
 
-          printer = TablePrint::Printer.new(data, OPTIONS)
+          printer = TablePrint::Printer.new(data, tp_options)
           printer.table_print + verification_result_urls_text(matrix)
         end
 

data/lib/pact_broker/client/publish_pacts.rb

@@ -2,6 +2,7 @@ require 'term/ansicolor'
 require 'pact_broker/client/hal_client_methods'
 require 'base64'
 require 'pact_broker/client/publish_pacts_the_old_way'
+require 'pact_broker/client/colorize_notices'
 
 module PactBroker
   module Client
@@ -71,7 +72,9 @@ module PactBroker
       def text_message
         response_entities.flat_map do | response_entity |
           if response_entity.success?
-            if response_entity.logs
+            if response_entity.notices
+              PactBroker::Client::ColorizeNotices.call(response_entity.notices.collect{ |n| OpenStruct.new(n) } )
+            elsif response_entity.logs
               response_entity.logs.collect do | log |
                 colorized_message(log)
               end
@@ -112,7 +115,8 @@ module PactBroker
             specification: "pact",
             contentType: "application/json",
             content: Base64.strict_encode64(pact_hash.to_json),
-            writeMode: write_mode
+            writeMode: write_mode,
+            onConflict: write_mode
           }
         end
       end

data/lib/pact_broker/client/version.rb

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

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

@@ -75,14 +75,14 @@ module PactBroker
         end
 
         def record_deployment_request_body
-          { replacedPreviousDeployedVersion: target }
+          { target: 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
+            message = "Recorded deployment of #{pacticipant_name} version #{version_number} to #{environment_name}"
+            message = "#{message} (target #{target})" if target
+            "#{message} in #{pact_broker_name}."
           elsif output == "json"
             deployed_version_resource.response.raw_body
           else

data/pact-broker-client.gemspec

@@ -33,4 +33,5 @@ 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'
 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/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/lib/pact_broker/client/can_i_deploy_spec.rb

@@ -6,22 +6,27 @@ 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(: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(:notices) { nil }
+      let(:supports_ignore) { true }
+      let(:deployable) { true }
 
 
       before do
@@ -55,10 +60,19 @@ 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
       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 +85,15 @@ 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
       end
 
       context "when retry_while_unknown is greater than 0" do
@@ -115,6 +138,25 @@ module PactBroker
         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
+
       context "when a PactBroker::Client::Error is raised" do
         before do
           allow(matrix_client).to receive(:get).and_raise(PactBroker::Client::Error.new('error text'))
@@ -125,7 +167,7 @@ module PactBroker
         end
 
         it "returns a failure message" do
-          expect(subject.message).to eq "error text"
+          expect(subject.message).to include "error text"
         end
       end
 

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}, {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}, {verbose: 'verbose'})
           invoke_can_i_deploy
         end
 
@@ -55,7 +55,7 @@ module PactBroker
           end
 
           it "passes the value as the matrix options" do
-            expect(CanIDeploy).to receive(:call).with(anything, anything, {to_tag: 'prod', to_environment: nil, limit: 1000}, anything, anything)
+            expect(CanIDeploy).to receive(:call).with(anything, anything, {to_tag: 'prod', to_environment: nil, limit: 1000, ignore_selectors: []}, anything, anything)
             invoke_can_i_deploy
           end
         end
@@ -66,7 +66,7 @@ module PactBroker
           end
 
           it "passes the value as the matrix options" do
-            expect(CanIDeploy).to receive(:call).with(anything, anything, {to_tag: nil, to_environment: 'prod', limit: 1000}, anything, anything)
+            expect(CanIDeploy).to receive(:call).with(anything, anything, {to_tag: nil, to_environment: 'prod', limit: 1000, ignore_selectors: []}, anything, anything)
             invoke_can_i_deploy
           end
         end

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

@@ -48,6 +48,27 @@ module PactBroker
           ],[
             ["--pacticipant", "Foo=Bar", "--version", "1.2.3"],
             [{ pacticipant: "Foo=Bar", version: "1.2.3" } ]
+          ],[
+            ["--ignore", "Foo", "--version", "1.2.3"],
+            [{ pacticipant: "Foo", version: "1.2.3", ignore: true }]
+          ],[
+            ["--ignore", "Foo", "--ignore", "Bar", "--version", "1.2.3"],
+            [{ pacticipant: "Foo", ignore: true }, { pacticipant: "Bar", version: "1.2.3", ignore: true }]
+          ],[
+            ["--ignore", "Foo", "--pacticipant", "Bar", "--version", "1.2.3"],
+            [{ pacticipant: "Foo", ignore: true }, { pacticipant: "Bar", version: "1.2.3" }]
+          ],[
+            ["--pacticipant", "Foo", "--version", "1", "--version", "2"],
+            [{ pacticipant: "Foo", version: "2" }]
+          ],[
+            ["--pacticipant", "Foo", "--version", "2", "--latest"],
+            [{ pacticipant: "Foo", version: "2", latest: true }]
+          ],[
+            ["--pacticipant", "Foo", "--version", "2", "--latest", "--latest"],
+            [{ pacticipant: "Foo", version: "2", latest: true }]
+          ],[
+            ["--version", "2"],
+            [{ pacticipant: nil, version: "2" }]
           ]
         ]