pact_broker-client 1.38.3 → 1.39.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.3'
+    VERSION = '1.39.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,13 +75,13 @@ module PactBroker
         end
 
         def record_deployment_request_body
-          { replacedPreviousDeployedVersion: replaced_previous_deployed_version }
+          { replacedPreviousDeployedVersion: 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." : ""
+            suffix = target ? " Marked previous deployed version as undeployed." : ""
             message + suffix
           elsif output == "json"
             deployed_version_resource.response.raw_body

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/script/publish-pact.sh

@@ -1,7 +1,20 @@
-bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json \
-  --consumer-app-version 1.2.7 \
+# 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-95c07bc16555 \
+  --provider Bar \
+  --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-branch \
-    --build-url http://mybuild
+    --auto-detect-version-properties \
+    --build-url http://mybuild \
+    --branch master --tag foo5
 

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/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/cli/broker_publish_spec.rb

@@ -6,11 +6,14 @@ module PactBroker::Client::CLI
   describe Broker do
     describe ".broker" do
       before do
-        allow(PactBroker::Client::PublishPacts).to receive(:call).and_return(true)
+        allow(PactBroker::Client::PublishPacts).to receive(:call).and_return(result)
         allow(PactBroker::Client::Git).to receive(:branch).and_return("bar")
         subject.options = OpenStruct.new(minimum_valid_options)
+        allow($stdout).to receive(:puts)
       end
 
+      let(:success) { true }
+      let(:result) { instance_double(PactBroker::Client::CommandResult, success: success, message: "message")}
       let(:file_list) { ["spec/support/cli_test_pacts/foo.json"] }
       let(:minimum_valid_options) do
         {
@@ -28,7 +31,8 @@ module PactBroker::Client::CLI
             "http://pact-broker",
             ["spec/support/cli_test_pacts/foo.json"],
             { number: "1.2.3", tags: [], version_required: false },
-            { }
+            {},
+            {}
           )
           invoke_broker
         end
@@ -42,6 +46,7 @@ module PactBroker::Client::CLI
             anything,
             ["spec/support/cli_test_pacts/bar.json", "spec/support/cli_test_pacts/foo.json"],
             anything,
+            anything,
             anything
           )
           invoke_broker
@@ -56,6 +61,7 @@ module PactBroker::Client::CLI
             anything,
             ["spec/support/cli_test_pacts/bar.json", "spec/support/cli_test_pacts/foo.json"],
             anything,
+            anything,
             anything
           )
           invoke_broker
@@ -70,12 +76,29 @@ module PactBroker::Client::CLI
             anything,
             ["spec/support/cli_test_pacts/bar.json", "spec/support/cli_test_pacts/foo.json"],
             anything,
+            anything,
             anything
           )
           invoke_broker
         end
       end
 
+      context "with an invalid argument specified that gets interpreted as a path" do
+        let(:file_list) { ['--wrong'] }
+
+        it "raises a more helpful error" do
+          expect{ invoke_broker }.to raise_error(Thor::Error, 'ERROR: pact-broker publish was called with invalid arguments ["--wrong"]')
+        end
+      end
+
+      context "when a specified file does not exist" do
+        let(:file_list) { ['no-existy'] }
+
+        it "raises a more helpful error" do
+          expect{ invoke_broker }.to raise_error(Thor::Error, /Specified pact file 'no-existy' does not exist/)
+        end
+      end
+
       context "with a tag" do
         before do
           subject.options = OpenStruct.new(minimum_valid_options.merge(tag: ['foo']))
@@ -86,6 +109,7 @@ module PactBroker::Client::CLI
             anything,
             anything,
             hash_including(tags: ['foo']),
+            anything,
             anything
           )
           invoke_broker
@@ -109,6 +133,7 @@ module PactBroker::Client::CLI
             anything,
             anything,
             hash_including(tags: ['foo', 'bar']),
+            anything,
             anything
           )
           invoke_broker
@@ -127,6 +152,7 @@ module PactBroker::Client::CLI
             anything,
             anything,
             hash_including(branch: "main", version_required: true),
+            anything,
             anything
           )
           invoke_broker
@@ -151,6 +177,7 @@ module PactBroker::Client::CLI
             anything,
             anything,
             hash_including(branch: "bar", version_required: false),
+            anything,
             anything
           )
           invoke_broker
@@ -176,6 +203,7 @@ module PactBroker::Client::CLI
             anything,
             anything,
             hash_including(branch: "bar", version_required: true),
+            anything,
             anything
           )
           invoke_broker
@@ -193,6 +221,7 @@ module PactBroker::Client::CLI
               anything,
               anything,
               hash_including(branch: "specified-branch", version_required: true),
+              anything,
               anything
             )
             invoke_broker
@@ -212,6 +241,7 @@ module PactBroker::Client::CLI
             anything,
             anything,
             hash_including(build_url: "http://ci"),
+            anything,
             anything
           )
           invoke_broker
@@ -230,6 +260,7 @@ module PactBroker::Client::CLI
             anything,
             anything,
             anything,
+            anything,
             hash_including(basic_auth: { username: 'foo', password: 'bar' })
           )
           invoke_broker
@@ -267,12 +298,10 @@ module PactBroker::Client::CLI
       end
 
       context "when the publish command is not successful" do
-        before do
-          allow(PactBroker::Client::PublishPacts).to receive(:call).and_return(false)
-        end
+        let(:success) { false }
 
-        it "raises a PactPublicationError" do
-          expect { invoke_broker }.to raise_error PactPublicationError
+        it "raises a SystemExit" do
+          expect { invoke_broker }.to raise_error SystemExit
         end
       end
     end

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

@@ -5,6 +5,9 @@ module PactBroker
     module Pacticipants2
       describe Create do
         describe ".call" do
+          before do
+            allow_any_instance_of(PactBroker::Client::Hal::HttpClient).to receive(:sleep)
+          end
           let(:pact_broker_client_options) { {} }
           let(:broker_base_url) { "http://url" }
           let(:params) { { name: 'Foo' } }

data/spec/lib/pact_broker/client/{publish_pacts_spec.rb → publish_pacts_the_old_way_spec.rb}

@@ -1,11 +1,11 @@
 require 'spec_helper'
 require 'fakefs/safe'
-require 'pact_broker/client/publish_pacts'
+require 'pact_broker/client/publish_pacts_the_old_way'
 require 'json'
 
 module PactBroker
   module Client
-    describe PublishPacts do
+    describe PublishPactsTheOldWay do
 
       # The amount of stubbing that we have to do here indicates this class is doing
       # TOO MUCH and needs to be split up!
@@ -23,7 +23,7 @@ module PactBroker
         File.open("spec/pacts/consumer-provider.json", "w") { |file| file << pact_hash.to_json }
         File.open("spec/pacts/consumer-provider-2.json", "w") { |file| file << pact_hash.to_json }
         File.open("spec/pacts/foo-bar.json", "w") { |file| file << pact_hash_2.to_json }
-        allow_any_instance_of(PublishPacts).to receive(:create_index_entry_point).and_return(index_entry_point)
+        allow_any_instance_of(PublishPactsTheOldWay).to receive(:create_index_entry_point).and_return(index_entry_point)
       end
 
       after do
@@ -63,8 +63,9 @@ module PactBroker
       let(:index_entry_point) { instance_double("PactBroker::Client::Hal::EntryPoint", :get! => index_resource )}
       let(:index_resource) { instance_double("PactBroker::Client::Hal::Entity", can?: can_create_version ) }
       let(:can_create_version) { false }
+      let(:options) { {} }
 
-      subject { PublishPacts.new(pact_broker_base_url, pact_file_paths, consumer_version_params, pact_broker_client_options) }
+      subject { PublishPactsTheOldWay.new(pact_broker_base_url, pact_file_paths, consumer_version_params, options, pact_broker_client_options) }
 
       describe "call" do
         it "creates a PactBroker Client" do
@@ -85,7 +86,7 @@ module PactBroker
           end
 
           it "returns true" do
-            expect(subject.call).to be true
+            expect(subject.call.success).to eq true
           end
         end
 
@@ -140,7 +141,7 @@ module PactBroker
           end
 
           it "returns false" do
-            expect(subject.call).to be false
+            expect(subject.call.success).to be false
           end
         end
 
@@ -212,7 +213,7 @@ module PactBroker
             end
 
             it "returns false" do
-              expect(subject.call).to eq false
+              expect(subject.call.success).to eq false
             end
           end
         end
@@ -230,7 +231,7 @@ module PactBroker
           end
 
           it "returns false" do
-            expect(subject.call).to eq false
+            expect(subject.call.success).to eq false
           end
         end
 
@@ -255,7 +256,7 @@ module PactBroker
           end
 
           it "returns true" do
-            expect(subject.call).to eq true
+            expect(subject.call.success).to eq true
           end
         end