pact_broker-client 1.38.1 → 1.41.0

data/lib/pact_broker/client/tasks/publication_task.rb

@@ -63,8 +63,9 @@ module PactBroker
             pact_broker_client_options[:basic_auth] = pact_broker_basic_auth if pact_broker_basic_auth && pact_broker_basic_auth.any?
             pact_broker_client_options.compact!
             consumer_version_params = { number: consumer_version, branch: the_branch, build_url: build_url, tags: all_tags, version_required: version_required }.compact
-            success = PactBroker::Client::PublishPacts.new(pact_broker_base_url, FileList[pattern], consumer_version_params, pact_broker_client_options).call
-            raise "One or more pacts failed to be published" unless success
+            result = PactBroker::Client::PublishPacts.new(pact_broker_base_url, FileList[pattern], consumer_version_params, {}, pact_broker_client_options).call
+            $stdout.puts result.message
+            raise "One or more pacts failed to be published" unless result.success
           end
         end
       end
@@ -86,7 +87,6 @@ module PactBroker
           branch
         end
       end
-
     end
   end
 end

data/lib/pact_broker/client/version.rb

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

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

@@ -19,7 +19,7 @@ module PactBroker
           @pacticipant_name = params.fetch(:pacticipant_name)
           @version_number = params.fetch(:version_number)
           @environment_name = params.fetch(:environment_name)
-          @replaced_previous_deployed_version = params.fetch(:replaced_previous_deployed_version)
+          @target = params.fetch(:target)
           @output = params.fetch(:output)
           @pact_broker_client_options = pact_broker_client_options
         end
@@ -36,7 +36,7 @@ module PactBroker
         private
 
         attr_reader :pact_broker_base_url, :pact_broker_client_options
-        attr_reader :pacticipant_name, :version_number, :environment_name, :replaced_previous_deployed_version, :output
+        attr_reader :pacticipant_name, :version_number, :environment_name, :target, :output
         attr_reader :deployed_version_resource
 
         def check_environment_exists
@@ -75,14 +75,14 @@ module PactBroker
         end
 
         def record_deployment_request_body
-          { replacedPreviousDeployedVersion: replaced_previous_deployed_version }
+          { 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 = replaced_previous_deployed_version ? " 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/lib/pact_broker/client/versions/record_undeployment.rb

@@ -2,6 +2,10 @@ require 'pact_broker/client/hal_client_methods'
 require 'pact_broker/client/error'
 require 'pact_broker/client/command_result'
 
+# TODO
+# --limit 1
+# order by date so that the oldest one gets undeployed first
+
 module PactBroker
   module Client
     class Versions
@@ -24,10 +28,17 @@ module PactBroker
         end
 
         def call
-          check_environment_exists
-          # record_undeployment
+          check_if_command_supported
+          if deployed_version_links_for_environment.any?
+            @undeployment_entities = deployed_version_links_for_environment.collect do | deployed_version_link |
+              deployed_version_link.get!._link!("pb:record-undeployment").post!
+            end
+          else
+            check_environment_exists
+            raise_not_found_error
+          end
 
-          PactBroker::Client::CommandResult.new(true, result_message)
+          PactBroker::Client::CommandResult.new(true, "foo")
         rescue PactBroker::Client::Error => e
           PactBroker::Client::CommandResult.new(false, e.message)
         end
@@ -35,83 +46,49 @@ module PactBroker
         private
 
         attr_reader :pact_broker_base_url, :pact_broker_client_options
-        attr_reader :pacticipant_name, :version_number, :environment_name, :replaced_previous_deployed_version, :output
-        attr_reader :deployed_version_resource
+        attr_reader :pacticipant_name, :version_number, :environment_name, :target, :output
+        attr_reader :deployed_version_resource, :undeployment_entities
 
-        def check_environment_exists
-          deployed_versions = currently_deployed_versions_for_pacticipant
-                                .get(version: version_number)
-                                .embedded_entities("deployedVersions")
-          deployed_versions
+        def version_resource
+          index_resource._link!("pb:pacticipant-version").expand(pacticipant: pacticipant_name, version: version_number).get!
         end
 
-        def currently_deployed_versions_for_pacticipant
-          @currently_deployed_versions_for_pacticipant ||= index_resource
-            ._link!("pb:environments")
-            .get!(name: environment_name)
-            .embedded_entities("environments")
-            .tap { |it| raise "Environment not found '#{environment_name}'" if it.empty? }
-            .first
-            ._link!("pb:currently-deployed-versions-for-pacticipant")
-            .expand(pacticipant: pacticipant_name)
+        def deployed_version_links
+          @deployed_version_links ||= version_resource._links!("pb:currently-deployed-versions")
         end
 
-        def currently_deployed_versions_for_pacticipant_version
-          @currently_deployed_versions ||= currently_deployed_versions_for_pacticipant
-            .get(version: version_number)
-            .embedded_entities("deployedVersions")
+        def deployed_version_links_for_environment
+          @deployed_version_links_for_environment ||= deployed_version_links.select(environment_name)
         end
 
-        # def record_deployment
-        #   @deployed_version_resource =
-        #     get_record_deployment_relation
-        #     .post(record_deployment_request_body)
-        #     .assert_success!
-        # end
-
-        # def get_record_deployment_relation
-        #   record_deployment_links = get_pacticipant_version._links!("pb:record-deployment")
-        #   link_for_environment = record_deployment_links.find(environment_name)
-        #   if link_for_environment
-        #     link_for_environment
-        #   else
-        #     check_environment_exists
-        #     # Force the exception to be raised
-        #     record_deployment_links.find!(environment_name, "Environment '#{environment_name}' is not an available option for recording a deployment of #{pacticipant_name}.")
-        #   end
-        # end
-
-        # def get_pacticipant_version
-        #   index_resource
-        #     ._link!("pb:pacticipant-version")
-        #     .expand(pacticipant: pacticipant_name, version: version_number)
-        #     .get
-        #     .assert_success!(404 => "#{pacticipant_name} version #{version_number} not found")
-        # end
-
-        # def record_deployment_request_body
-        #   { replacedPreviousDeployedVersion: replaced_previous_deployed_version }
-        # end
+        def check_environment_exists
+          index_resource
+            ._link!("pb:environments")
+            .get!
+            ._links("pb:environments")
+            .find!(environment_name, "No environment found with name '#{environment_name}'")
+        end
 
-        def result_message
-          ""
-          # if output == "text"
-          #   message = "Recorded deployment of #{pacticipant_name} version #{version_number} to #{environment_name} in #{pact_broker_name}."
-          #   suffix = replaced_previous_deployed_version ? " Marked previous deployed version as undeployed." : ""
-          #   message + suffix
-          # elsif output == "json"
-          #   deployed_version_resource.response.raw_body
-          # else
-          #   ""
-          # end
+        def raise_not_found_error
+          raise PactBroker::Client::Error.new(deployed_version_not_found_message)
         end
 
-        def pact_broker_name
-          is_pactflow? ? "Pactflow" : "the Pact Broker"
+        def deployed_version_not_found_message
+          if (env_names = deployed_version_links.names).any?
+            "#{pacticipant_name} version #{version_number} is not currently deployed to #{environment_name}. It is currently deployed to: #{env_names.join(", ")}"
+          else
+            "#{pacticipant_name} version #{version_number} is not currently deployed to any environment."
+          end
         end
 
-        def is_pactflow?
-          deployed_version_resource.response.headers.keys.any?{ | header_name | header_name.downcase.include?("pactflow") }
+        def result_message
+          if output == "text"
+            message = "Recorded undeployment of #{pacticipant_name} version #{version_number} from #{environment_name} in #{pact_broker_name}."
+          elsif output == "json"
+            undeployment_entities.last.response.raw_body
+          else
+            ""
+          end
         end
 
         def check_if_command_supported

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,7 +1,38 @@
-bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json \
-  --consumer-app-version 1.2.7 \
+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 \
+#   --description "foo webhook" \
+#   --contract-published
+
+bundle exec bin/pact-broker create-or-update-webhook http://localhost:9393 \
+  --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/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 \
+#   --provider Bar \
+#   --request POST \
+#   --contract-published
+
+
+PACT_BROKER_FEATURES=publish_contracts bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json \
+  --consumer-app-version 1.2.26 \
   --broker-base-url http://localhost:9292 \
-   --broker-username localhost --broker-password localhost \
-    --auto-detect-branch \
-    --build-url http://mybuild
+   --broker-token localhost \
+    --auto-detect-version-properties \
+    --build-url http://mybuild \
+    --branch master --tag foo5 --tag foo6
 

data/script/record-deployment.sh

@@ -1,4 +1,2 @@
 PACT_BROKER_FEATURES=deployments bundle exec bin/pact-broker record-deployment \
-   --pacticipant Foo --version 1.0.0 --environment prod --broker-base-url http://localhost:9292
-
-
+   --pacticipant foo-consumer --version 1 --environment prod --broker-base-url http://localhost:9292

data/script/record-undeployment.sh

@@ -0,0 +1,4 @@
+PACT_BROKER_FEATURES=deployments bundle exec bin/pact-broker record-undeployment \
+   --pacticipant foo-consumer --version 1 --environment prod --broker-base-url http://localhost:9292 --output json --verbose
+
+

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/foo-bar.json

@@ -0,0 +1,31 @@
+{
+  "consumer": {
+    "name": "Foo"
+  },
+  "provider": {
+    "name": "Bar"
+  },
+  "interactions": [
+    {
+      "description": "an example request",
+      "providerState": "a provider state",
+      "request": {
+        "method": "GET",
+        "path": "/",
+        "headers": {
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json"
+        }
+      }
+    }
+  ],
+  "metadata": {
+    "pactSpecification": {
+      "version": "2.0.0"
+    }
+  }
+}

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