pact_broker-client 1.35.0 → 1.36.0

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

@@ -19,29 +19,49 @@ module PactBroker
     class PublicationTask < ::Rake::TaskLib
 
       attr_accessor :pattern, :pact_broker_base_url, :consumer_version, :tag, :write_method, :tag_with_git_branch, :pact_broker_basic_auth, :pact_broker_token
+      attr_reader :auto_detect_version_properties, :branch, :build_url
       alias_method :tags=, :tag=
       alias_method :tags, :tag
 
       def initialize name = nil, &block
         @name = name
+        @auto_detect_version_properties = nil
+        @version_required = false
         @pattern = 'spec/pacts/*.json'
         @pact_broker_base_url = 'http://pact-broker'
         rake_task &block
       end
 
+      def auto_detect_version_properties= auto_detect_version_properties
+        @version_required = version_required || auto_detect_version_properties
+        @auto_detect_version_properties = auto_detect_version_properties
+      end
+
+      def branch= branch
+        @version_required = version_required || !!branch
+        @branch = branch
+      end
+
+      def build_url= build_url
+        @version_required = version_required || !!build_url
+        @build_url = build_url
+      end
+
       private
 
+      attr_reader :version_required
+
       def rake_task &block
         namespace :pact do
           desc "Publish pacts to pact broker"
           task task_name do
             block.call(self)
             require 'pact_broker/client/publish_pacts'
-            pact_broker_client_options =  {}
-              .merge( pact_broker_basic_auth ? { basic_auth: pact_broker_basic_auth } : {} )
-              .merge( write_method ? { write: write_method } : {} )
-              .merge( pact_broker_token ? { token: pact_broker_token } : {} )
-            success = PactBroker::Client::PublishPacts.new(pact_broker_base_url, FileList[pattern], consumer_version, all_tags, pact_broker_client_options).call
+            pact_broker_client_options = { write: write_method, token: pact_broker_token }
+            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
           end
         end
@@ -53,9 +73,18 @@ module PactBroker
 
       def all_tags
         t = [*tags]
-        t << PactBroker::Client::Git.branch if tag_with_git_branch
+        t << PactBroker::Client::Git.branch(raise_error: true) if tag_with_git_branch
         t.compact.uniq
       end
+
+      def the_branch
+        if branch.nil? && auto_detect_version_properties != false
+          PactBroker::Client::Git.branch(raise_error: auto_detect_version_properties == true)
+        else
+          branch
+        end
+      end
+
     end
   end
 end

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.35.0'
+    VERSION = '1.36.0'
   end
 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/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/publish_pacts_spec.rb

@@ -23,6 +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)
       end
 
       after do
@@ -34,11 +35,23 @@ module PactBroker
       let(:pact_file_paths) { ['spec/pacts/consumer-provider.json']}
       let(:consumer_version) { "1.2.3" }
       let(:tags) { nil }
-      let(:pact_hash) { {consumer: {name: 'Consumer'}, provider: {name: 'Provider'}, interactions: [] } }
-      let(:pact_hash_2) { {consumer: {name: 'Foo'}, provider: {name: 'Bar'}, interactions: [] } }
+      let(:branch) { nil }
+      let(:build_url) { nil }
+      let(:version_required) { false }
+      let(:pact_hash) { { consumer: { name: 'Consumer'}, provider: { name: 'Provider' }, interactions: [] } }
+      let(:pact_hash_2) { {consumer: { name: 'Foo' }, provider: { name: 'Bar' }, interactions: [] } }
       let(:pacts_client) { instance_double("PactBroker::ClientSupport::Pacts")}
       let(:pact_versions_client) { instance_double("PactBroker::Client::Versions", tag: false) }
       let(:pact_broker_base_url) { 'http://some-host'}
+      let(:consumer_version_params) do
+        {
+          number: consumer_version,
+          branch: branch,
+          tags: tags,
+          build_url: build_url,
+          version_required: version_required
+        }
+      end
       let(:pact_broker_client_options) do
         {
           basic_auth: {
@@ -47,8 +60,11 @@ module PactBroker
           }
         }
       end
+      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 }
 
-      subject { PublishPacts.new(pact_broker_base_url, pact_file_paths, consumer_version, tags, pact_broker_client_options) }
+      subject { PublishPacts.new(pact_broker_base_url, pact_file_paths, consumer_version_params, pact_broker_client_options) }
 
       describe "call" do
         it "creates a PactBroker Client" do
@@ -184,7 +200,6 @@ module PactBroker
           end
 
           context "when an error occurs tagging the pact" do
-
             before do
               allow(pact_versions_client).to receive(:tag).and_raise("an error")
               allow(Retry).to receive(:sleep)
@@ -203,7 +218,6 @@ module PactBroker
         end
 
         context "when an error occurs every time while publishing a pact" do
-
           before do
             allow(Retry).to receive(:sleep)
             allow(pacts_client).to receive(:publish).and_raise("an error")
@@ -221,7 +235,6 @@ module PactBroker
         end
 
         context "when an error occurs less than the maximum number of retries" do
-
           before do
             allow(Retry).to receive(:sleep)
             tries = 0
@@ -245,6 +258,86 @@ module PactBroker
             expect(subject.call).to eq true
           end
         end
+
+        context "when the broker does not support creation of a version with a branch but a branch is specified" do
+          let(:branch) { "main" }
+
+          context "when version_required is true" do
+            let(:version_required) { true }
+
+            it "raises an error" do
+              expect { subject.call }.to raise_error PactBroker::Client::Error
+            end
+          end
+        end
+
+        context "when the broker supports creation of a version with a branch" do
+          before do
+            allow(version_link).to receive(:expand).and_return(version_link)
+            allow(version_resource).to receive(:assert_success!).and_return(version_resource)
+            allow(version_resource).to receive_message_chain(:response, :status).and_return(version_creation_response_status)
+          end
+          let(:can_create_version) { true }
+          let(:version_link) { instance_double("PactBroker::Client::Hal::Link", put: version_resource) }
+          let(:version_resource) { instance_double("PactBroker::Client::Hal::Entity") }
+          let(:version_creation_response_status) { 201 }
+
+          before do
+            allow(index_resource).to receive(:_link).and_return(version_link)
+          end
+
+          context "when there is a branch, build_url or tags specified" do
+            let(:tags) { ["dev"] }
+            let(:branch) { ["main"] }
+            let(:build_url) { "build_url" }
+
+            it "creates a version with the branch, build_url and tags" do
+              expect(index_resource).to receive(:_link)
+              expect(version_link).to receive(:expand).with(pacticipant: "Consumer", version: "1.2.3")
+              expect(version_link).to receive(:put).with(branch: branch, buildUrl: build_url)
+              subject.call
+            end
+
+            context "when there is a branch but no tags" do
+              let(:tags) { [] }
+
+              it "does not set the tags, as this would overwrite the existing ones - not sure about this implementation" do
+                expect(version_link).to receive(:put).with(branch: branch, buildUrl: build_url)
+                subject.call
+              end
+            end
+
+            context "when the version response status is 201" do
+              it "puts a message indicating the version was created" do
+                expect($stdout).to receive(:puts).with(/Created/)
+                subject.call
+              end
+            end
+
+            context "when the version response status is 200" do
+              let(:version_creation_response_status) { 200 }
+
+              it "puts a message indicating the version was replaced" do
+                expect($stdout).to receive(:puts).with(/Replaced/)
+                subject.call
+              end
+            end
+          end
+
+          context "when there is no branch, tags or build_url specified" do
+            before do
+              allow(Retry).to receive(:while_error) { |&block| block.call }
+            end
+            let(:tags) { [] }
+            let(:branch) { nil }
+            let(:build_url) { nil }
+
+            it "does not create a version resource" do
+              expect(index_resource).to_not receive(:_link)
+              subject.call
+            end
+          end
+        end
       end
     end
   end