pact_broker-client 1.32.0 → 1.37.0

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.32.0'
+    VERSION = '1.37.0'
   end
 end

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

@@ -0,0 +1,109 @@
+require 'pact_broker/client/hal_client_methods'
+require 'pact_broker/client/error'
+require 'pact_broker/client/command_result'
+
+module PactBroker
+  module Client
+    class Versions
+      class RecordDeployment
+        include PactBroker::Client::HalClientMethods
+
+        NOT_SUPPORTED_MESSAGE = "This version of the Pact Broker does not support recording deployments. Please upgrade to version 2.80.0 or later."
+
+        def self.call(params, pact_broker_base_url, pact_broker_client_options)
+          new(params, pact_broker_base_url, pact_broker_client_options).call
+        end
+
+        def initialize(params, pact_broker_base_url, pact_broker_client_options)
+          @pact_broker_base_url = pact_broker_base_url
+          @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)
+          @output = params.fetch(:output)
+          @pact_broker_client_options = pact_broker_client_options
+        end
+
+        def call
+          check_if_command_supported
+          record_deployment
+
+          PactBroker::Client::CommandResult.new(true, result_message)
+        rescue PactBroker::Client::Error => e
+          PactBroker::Client::CommandResult.new(false, e.message)
+        end
+
+        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
+
+        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 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 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
+        end
+
+        def pact_broker_name
+          is_pactflow? ? "Pactflow" : "the Pact Broker"
+        end
+
+        def is_pactflow?
+          deployed_version_resource.response.headers.keys.any?{ | header_name | header_name.downcase.include?("pactflow") }
+        end
+
+        def check_if_command_supported
+          unless index_resource.can?("pb:environments")
+            raise PactBroker::Client::Error.new(NOT_SUPPORTED_MESSAGE)
+          end
+        end
+      end
+    end
+  end
+end

data/pact-broker-client.gemspec

@@ -26,9 +26,11 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'table_print', '~> 1.5'
   gem.add_runtime_dependency 'thor', '>= 0.20', '< 2.0'
   gem.add_runtime_dependency 'rake', '~> 13.0' #For FileList
+  gem.add_runtime_dependency 'dig_rb', '~> 1.0'
 
   gem.add_development_dependency 'fakefs', '~> 0.4'
   gem.add_development_dependency 'webmock', '~> 3.0'
   gem.add_development_dependency 'conventional-changelog', '~>1.3'
   gem.add_development_dependency 'pact', '~> 1.16'
+  gem.add_development_dependency 'pact-support', '1.15.0'
 end

data/script/publish-pact.sh

@@ -1 +1,7 @@
-bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json --consumer-app-version 1.2.3 --broker-base-url http://localhost:9292 --tag-with-git-branch --broker-username localhost --broker-password localhost
+bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json \
+  --consumer-app-version 1.2.7 \
+  --broker-base-url http://localhost:9292 \
+   --broker-username localhost --broker-password localhost \
+    --auto-detect-branch \
+    --build-url http://mybuild
+

data/script/trigger-release.sh

@@ -19,7 +19,7 @@ output=$(curl -v -X POST https://api.github.com/repos/${repository_slug}/dispatc
       -H "Authorization: Bearer $GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES" \
       -d "{\"event_type\": \"release-triggered\", \"client_payload\": {\"increment\": ${increment}}}" 2>&1)
 
-if  ! echo "${output}" | grep "HTTP\/1.1 204" > /dev/null; then
+if  ! echo "${output}" | grep "HTTP\/.* 204" > /dev/null; then
   echo "$output" | sed  "s/${GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES}/********/g"
   echo "Failed to trigger release"
   exit 1

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

@@ -35,7 +35,7 @@ module PactBroker
         end
 
         it "invokes the CanIDeploy service" do
-          expect(CanIDeploy).to receive(:call).with('http://pact-broker', version_selectors, {to_tag: 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}, {output: 'table', retry_while_unknown: 1, retry_interval: 2}, {verbose: 'verbose'})
           invoke_can_i_deploy
         end
 
@@ -53,7 +53,18 @@ module PactBroker
           end
 
           it "passes the value as the matrix options" do
-            expect(CanIDeploy).to receive(:call).with(anything, anything, {to_tag: 'prod', limit: 1000}, anything, anything)
+            expect(CanIDeploy).to receive(:call).with(anything, anything, {to_tag: 'prod', to_environment: nil, limit: 1000}, anything, anything)
+            invoke_can_i_deploy
+          end
+        end
+
+        context "with --to-environment" do
+          before do
+            subject.options.to_environment = 'prod'
+          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)
             invoke_can_i_deploy
           end
         end

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

@@ -27,9 +27,8 @@ module PactBroker::Client::CLI
           expect(PactBroker::Client::PublishPacts).to receive(:call).with(
             "http://pact-broker",
             ["spec/support/cli_test_pacts/foo.json"],
-            "1.2.3",
-            [],
-            {verbose: nil}
+            { number: "1.2.3", tags: [], version_required: false },
+            { verbose: nil }
           )
           invoke_broker
         end
@@ -43,7 +42,6 @@ module PactBroker::Client::CLI
             anything,
             ["spec/support/cli_test_pacts/bar.json", "spec/support/cli_test_pacts/foo.json"],
             anything,
-            anything,
             anything
           )
           invoke_broker
@@ -58,7 +56,6 @@ module PactBroker::Client::CLI
             anything,
             ["spec/support/cli_test_pacts/bar.json", "spec/support/cli_test_pacts/foo.json"],
             anything,
-            anything,
             anything
           )
           invoke_broker
@@ -73,7 +70,6 @@ module PactBroker::Client::CLI
             anything,
             ["spec/support/cli_test_pacts/bar.json", "spec/support/cli_test_pacts/foo.json"],
             anything,
-            anything,
             anything
           )
           invoke_broker
@@ -89,8 +85,7 @@ module PactBroker::Client::CLI
           expect(PactBroker::Client::PublishPacts).to receive(:call).with(
             anything,
             anything,
-            anything,
-            ['foo'],
+            hash_including(tags: ['foo']),
             anything
           )
           invoke_broker
@@ -100,7 +95,7 @@ module PactBroker::Client::CLI
       context "with tag-with-git-branch" do
         before do
           subject.options = OpenStruct.new(
-            minimum_valid_options.merge(tag_with_git_branch: true)
+            minimum_valid_options.merge(tag_with_git_branch: true, tag: ['foo'])
           )
         end
 
@@ -112,9 +107,111 @@ module PactBroker::Client::CLI
         it "adds it to the list of tags when publishing" do
           expect(PactBroker::Client::PublishPacts).to receive(:call).with(
             anything,
+            anything,
+            hash_including(tags: ['foo', 'bar']),
+            anything
+          )
+          invoke_broker
+        end
+      end
+
+      context "with a branch specified" do
+        before do
+          subject.options = OpenStruct.new(
+            minimum_valid_options.merge(branch: "main")
+          )
+        end
+
+        it "passes in the branch option" do
+          expect(PactBroker::Client::PublishPacts).to receive(:call).with(
+            anything,
+            anything,
+            hash_including(branch: "main", version_required: true),
+            anything
+          )
+          invoke_broker
+        end
+      end
+
+      context "with --auto-detect-version-properties on by default" do
+        before do
+          subject.options = OpenStruct.new(
+            minimum_valid_options.merge(auto_detect_version_properties: true)
+          )
+          allow(subject).to receive(:explict_auto_detect_version_properties).and_return(false)
+        end
+
+        it "determines the git branch name" do
+          expect(PactBroker::Client::Git).to receive(:branch).with(raise_error: false)
+          invoke_broker
+        end
+
+        it "passes in the auto detected branch option with version_required: false" do
+          expect(PactBroker::Client::PublishPacts).to receive(:call).with(
+            anything,
+            anything,
+            hash_including(branch: "bar", version_required: false),
+            anything
+          )
+          invoke_broker
+        end
+      end
+
+
+      context "with --auto-detect-version-properties specified explicitly" do
+        before do
+          subject.options = OpenStruct.new(
+            minimum_valid_options.merge(auto_detect_version_properties: true)
+          )
+          allow(subject).to receive(:explict_auto_detect_version_properties).and_return(true)
+        end
+
+        it "determines the git branch name" do
+          expect(PactBroker::Client::Git).to receive(:branch).with(raise_error: true)
+          invoke_broker
+        end
+
+        it "passes in the auto detected branch option with version_required: true" do
+          expect(PactBroker::Client::PublishPacts).to receive(:call).with(
             anything,
             anything,
-            ['bar'],
+            hash_including(branch: "bar", version_required: true),
+            anything
+          )
+          invoke_broker
+        end
+
+        context "with the branch specified as well" do
+          before do
+            subject.options = OpenStruct.new(
+              minimum_valid_options.merge(branch: "specified-branch", auto_detect_version_properties: true)
+            )
+          end
+
+          it "uses the specified branch" do
+            expect(PactBroker::Client::PublishPacts).to receive(:call).with(
+              anything,
+              anything,
+              hash_including(branch: "specified-branch", version_required: true),
+              anything
+            )
+            invoke_broker
+          end
+        end
+      end
+
+      context "with the build_url specified" do
+        before do
+          subject.options = OpenStruct.new(
+            minimum_valid_options.merge(build_url: "http://ci")
+          )
+        end
+
+        it "passes in the branch option" do
+          expect(PactBroker::Client::PublishPacts).to receive(:call).with(
+            anything,
+            anything,
+            hash_including(build_url: "http://ci"),
             anything
           )
           invoke_broker
@@ -133,8 +230,7 @@ module PactBroker::Client::CLI
             anything,
             anything,
             anything,
-            anything,
-            hash_including({basic_auth: {username: 'foo', password: 'bar'}})
+            hash_including(basic_auth: { username: 'foo', password: 'bar' })
           )
           invoke_broker
         end

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

@@ -9,9 +9,20 @@ module PactBroker
           Git::BRANCH_ENV_VAR_NAMES.each do | env_var_name|
             allow(ENV).to receive(:[]).with(env_var_name).and_return(nil)
           end
+          allow(Git).to receive(:execute_git_command).and_return(" origin/HEAD \n origin/foo")
         end
 
-        subject { Git.branch }
+        let(:raise_exception) { true }
+
+        subject { Git.branch(raise_error: raise_exception) }
+
+        shared_examples_for "when raise_error is false" do
+          context "when raise_error is false" do
+            let(:raise_exception) { false }
+
+            it { is_expected.to be nil }
+          end
+        end
 
         context "when there is a known environment variable for the branch" do
           before do
@@ -24,8 +35,28 @@ module PactBroker
           end
         end
 
+        context "when there is one environment variable ending with _BRANCH" do
+          before do
+            allow(ENV).to receive(:keys).and_return(%w{FOO_BRANCH BAR_BRANCH BLAH})
+            allow(ENV).to receive(:[]).with("FOO_BRANCH").and_return("")
+            allow(ENV).to receive(:[]).with("BAR_BRANCH").and_return("meep")
+          end
+
+          it "returns the value of that environment variable" do
+            expect(subject).to eq "meep"
+          end
+        end
+
+        context "when there is more than one environment variable ending with _BRANCH" do
+          it "attempts to execute a git command to determine the value" do
+            expect(Git).to receive(:execute_git_command)
+            expect(subject).to_not be_empty
+          end
+        end
+
         context "when there is no known environment variable for the branch", skip_ci: true do
           it "attempts to execute a git command to determine the value" do
+            expect(Git).to receive(:execute_git_command)
             expect(subject).to_not be_empty
           end
         end
@@ -35,7 +66,7 @@ module PactBroker
             allow(Git).to receive(:execute_git_command).and_return(" origin/HEAD \n origin/foo")
           end
 
-          it "raises an error" do
+          it "returns the branch" do
             expect(subject).to eq "foo"
           end
         end
@@ -48,6 +79,8 @@ module PactBroker
           it "raises an error" do
             expect { subject }.to raise_error PactBroker::Client::Error, /returned multiple branches: foo, bar/
           end
+
+          include_examples "when raise_error is false"
         end
 
 
@@ -59,6 +92,8 @@ module PactBroker
           it "raises an error" do
             expect { subject }.to raise_error PactBroker::Client::Error, /didn't return anything/
           end
+
+          include_examples "when raise_error is false"
         end
 
         context "when there is an error executing the git command" do
@@ -69,6 +104,8 @@ module PactBroker
           it "raises an error" do
             expect { subject }.to raise_error PactBroker::Client::Error, /some error/
           end
+
+          include_examples "when raise_error is false"
         end
       end
     end

data/spec/lib/pact_broker/client/hal/entity_spec.rb

@@ -9,8 +9,9 @@ module PactBroker::Client
       end
 
       let(:provider_response) do
-        double('response', body: provider_hash, success?: true)
+        double('response', body: provider_hash, success?: true, status: status)
       end
+      let(:status) { 200 }
 
       let(:provider_hash) do
         {
@@ -72,12 +73,12 @@ module PactBroker::Client
           subject(:entity) { ErrorEntity.new("http://pact", pact_hash, http_client) }
 
           it "raises an error" do
-            expect { entity.assert_success! }.to raise_error ErrorResponseReturned, "Error retrieving http://pact status= "
+            expect { entity.assert_success! }.to raise_error ErrorResponseReturned, "Error retrieving http://pact status="
           end
         end
 
         context "when the response is not successful and there is a response" do
-          let(:response) { double('response', code: 200, raw_body: "body") }
+          let(:response) { double('response', status: 200, raw_body: "body") }
 
           subject(:entity) { ErrorEntity.new("http://pact", pact_hash, http_client, response) }