pact_broker 2.76.2 → 2.77.0

data/spec/lib/pact_broker/pacts/repository_find_for_verification_fallback_spec.rb

@@ -67,7 +67,7 @@ module PactBroker
               it "only returns the pacts for the consumer" do
                 expect(subject.size).to eq 1
                 expect(subject.first.consumer.name).to eq "Foo"
-                expect(subject.first.selectors.first).to eq selector.resolve(PactBroker::Domain::Version.for("Foo", "1"))
+                expect(subject.first.selectors.first).to eq selector.resolve_for_fallback(PactBroker::Domain::Version.for("Foo", "1"))
               end
             end
           end

data/spec/lib/pact_broker/pacts/repository_find_for_verification_spec.rb

@@ -74,7 +74,7 @@ module PactBroker
 
           it "returns the latest pact for each consumer" do
             expect(subject.size).to eq 1
-            expect(find_by_consumer_name_and_consumer_version_number("Foo1", "2").selectors).to eq [pact_selector_1.resolve(PactBroker::Domain::Version.find(number: "2"))]
+            expect(find_by_consumer_name_and_consumer_version_number("Foo1", "2").selectors).to eq [pact_selector_1.resolve(PactBroker::Domain::Version.for("Foo1", "2"))]
           end
         end
 

data/spec/lib/pact_broker/pacts/repository_find_wip_pact_versions_for_provider_branch_spec.rb

@@ -0,0 +1,224 @@
+require 'pact_broker/pacts/repository'
+
+module PactBroker
+  module Pacts
+    describe Repository do
+      describe "find_wip_pact_versions_for_provider by branch" do
+        # let(:provider_tags) { %w[dev] }
+        let(:provider_tags) { [] }
+        let(:provider_version_branch) { "dev" }
+        let(:options) { { include_wip_pacts_since: include_wip_pacts_since } }
+        let(:include_wip_pacts_since) { (Date.today - 1).to_datetime }
+
+        subject { Repository.new.find_wip_pact_versions_for_provider("bar", provider_version_branch, provider_tags, options) }
+
+        context "when there are no tags or branch" do
+          let(:provider_tags) { [] }
+          let(:provider_version_branch) { nil }
+
+          it "returns an empty list" do
+            expect(subject).to eq []
+          end
+        end
+
+        context "when there are multiple wip pacts" do
+          before do
+            td.create_provider("bar")
+              .create_provider_version("333", branch: provider_version_branch)
+              .add_day
+              .create_pact_with_hierarchy("foo", "1", "bar")
+              .create_consumer_version_tag("feat-1")
+              .add_day
+              .create_consumer_version("2", branch: "branch-1")
+              .create_pact
+              .create_pact_with_hierarchy("meep", "2", "bar")
+              .create_consumer_version_tag("feat-2")
+              .add_day
+              .create_pact_with_hierarchy("foo", "3", "bar")
+              .create_consumer_version_tag("feat-2")
+              .add_day
+              .create_pact_with_hierarchy("meep", "1", "bar")
+              .create_consumer_version_tag("feat-1")
+          end
+
+          it "sorts them" do
+            expect(subject[0].consumer_name).to eq "foo"
+            expect(subject[0].consumer_version_number).to eq "1"
+
+            expect(subject[1].consumer_name).to eq "foo"
+            expect(subject[1].consumer_version_number).to eq "2"
+
+            expect(subject[2].consumer_name).to eq "foo"
+            expect(subject[2].consumer_version_number).to eq "3"
+
+            expect(subject[3].consumer_name).to eq "meep"
+            expect(subject[3].consumer_version_number).to eq "2"
+
+            expect(subject[4].consumer_name).to eq "meep"
+            expect(subject[4].consumer_version_number).to eq "1"
+          end
+
+          it "sets the selectors" do
+            expect(subject[0].selectors).to eq Selectors.create_for_latest_for_tag("feat-1")
+            expect(subject[1].selectors).to eq Selectors.create_for_latest_for_branch("branch-1")
+            expect(subject[2].selectors).to eq Selectors.create_for_latest_for_tag("feat-2")
+            expect(subject[3].selectors).to eq Selectors.create_for_latest_for_tag("feat-2")
+            expect(subject[4].selectors).to eq Selectors.create_for_latest_for_tag("feat-1")
+          end
+        end
+
+        context "when the latest pact for a tag has been successfully verified by the given provider branch" do
+          before do
+            td.create_pact_with_hierarchy("foo", "1", "bar")
+              .comment("above not included because it's not the latest prod")
+              .create_consumer_version("2")
+              .create_consumer_version_tag("prod")
+              .create_pact
+              .create_verification(provider_version: "3", branch: provider_version_branch, comment: "not included because already verified")
+          end
+
+          it "is not included" do
+            expect(subject.size).to be 0
+          end
+        end
+
+        context "when the latest pact for a tag has been successfully verified by the given provider tag but it was a WIP verification" do
+          before do
+            td.create_provider("bar")
+              .create_provider_version("333", branch: provider_version_branch)
+              .add_day
+              .create_pact_with_hierarchy("foo", "1", "bar")
+              .comment("above not included because it's not the latest")
+              .create_consumer_version("2")
+              .create_consumer_version_tag("feat-1")
+              .create_pact
+              .create_verification(wip: true, success: true, provider_version: "3", branch: provider_version_branch)
+          end
+
+          it "it is included" do
+            expect(subject[0].consumer_name).to eq "foo"
+            expect(subject[0].consumer_version_number).to eq "2"
+          end
+        end
+
+        context "when a pact is the latest for a tag and a branch and has no successful verifications" do
+          before do
+            td.create_provider("bar")
+              .create_provider_version("333", branch: provider_version_branch)
+              .add_day
+              .create_consumer("foo")
+              .create_consumer_version("1", branch: "branch-1", tag_names: ["feat-1"])
+              .comment("above not included because it's not the latest")
+              .create_consumer_version("2", branch: "branch-1", tag_names: ["feat-1"])
+              .create_pact
+          end
+
+          it "it has two selectors" do
+            expect(subject.size).to eq 1
+            expect(subject.first.selectors).to eq Selectors.new([Selector.latest_for_branch("branch-1"), Selector.latest_for_tag("feat-1")])
+          end
+        end
+
+        context "when the latest pact for a tag has failed verification from the specified provider version branch" do
+          before do
+            td.create_provider("bar")
+              .create_provider_version("333")
+              .create_provider_version_tag("dev")
+              .add_day
+              .create_pact_with_hierarchy("foo", "1", "bar")
+              .create_consumer_version_tag("feat-1")
+              .create_verification(provider_version: "3", success: false, branch: provider_version_branch)
+              .add_day
+              .create_consumer_version("2", branch: "branch-1")
+              .create_pact
+              .create_verification(provider_version: "3", success: false, branch: provider_version_branch)
+
+          end
+
+          it "is included" do
+            expect(subject.size).to be 2
+          end
+
+          it "sets the pending tags" do
+            expect(subject.first.provider_branch).to eq provider_version_branch
+            expect(subject.last.provider_branch).to eq provider_version_branch
+          end
+        end
+
+        context "when there are no consumer tags" do
+          before do
+            td.create_pact_with_hierarchy("foo", "1", "bar")
+              .create_verification(provider_version: "3", success: false, branch: provider_version_branch)
+          end
+
+          it "returns an empty list" do
+            expect(subject).to eq []
+          end
+        end
+
+        context "when the latest pact for a tag has successful then failed verifications" do
+          before do
+            td.create_provider("bar")
+              .create_provider_version("333")
+              .create_provider_version_tag("dev")
+              .add_day
+              .create_pact_with_hierarchy("foo", "1", "bar")
+              .create_consumer_version_tag("dev")
+              .create_verification(provider_version: "3", success: true, branch: provider_version_branch)
+              .create_verification(provider_version: "5", success: false, number: 2, branch: provider_version_branch)
+          end
+
+          it "is not included, but maybe it should be? can't really work out a scenario where this is likely to happen" do
+            expect(subject).to eq []
+          end
+        end
+
+        context "when the latest pact for a tag has not been verified" do
+          before do
+            td.create_provider("bar")
+              .create_provider_version("333")
+              .create_provider_version_tag("dev")
+              .add_day
+              .create_pact_with_hierarchy("foo", "1", "bar")
+              .create_consumer_version_tag("feat-1")
+          end
+
+          it "is included" do
+            expect(subject.size).to be 1
+          end
+
+          it "sets the pending tags" do
+            expect(subject.first.provider_branch).to eq provider_version_branch
+          end
+        end
+
+        context "when the provider name does not match the given provider name" do
+          before do
+            td.create_pact_with_hierarchy("foo", "1", "baz")
+              .create_provider("bar")
+          end
+
+          it "is not included" do
+            expect(subject.size).to be 0
+          end
+        end
+
+        context "when the pact was published before the specified include_wip_pacts_since" do
+          before do
+            td.create_provider("bar")
+              .create_provider_version("333", branch: provider_version_branch)
+              .add_day
+              .create_pact_with_hierarchy("foo", "1", "bar")
+              .create_consumer_version_tag("prod")
+          end
+
+          let(:include_wip_pacts_since) { (Date.today + 3).to_datetime }
+
+          it "is not included" do
+            expect(subject.size).to be 0
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/pacts/repository_find_wip_pact_versions_for_provider_spec.rb

@@ -5,10 +5,11 @@ module PactBroker
     describe Repository do
       describe "find_wip_pact_versions_for_provider" do
         let(:provider_tags) { %w[dev] }
+        let(:provider_version_branch) { nil }
         let(:options) { { include_wip_pacts_since: include_wip_pacts_since } }
         let(:include_wip_pacts_since) { (Date.today - 1).to_datetime }
 
-        subject { Repository.new.find_wip_pact_versions_for_provider("bar", provider_tags, options) }
+        subject { Repository.new.find_wip_pact_versions_for_provider("bar", provider_version_branch, provider_tags, options) }
 
         context "when there are no tags" do
           let(:provider_tags) { [] }
@@ -21,16 +22,17 @@ module PactBroker
         context "when there are multiple wip pacts" do
           before do
             td.create_provider("bar")
-              .create_provider_version("333")
-              .create_provider_version_tag("dev")
+              .create_provider_version("333", tag_names: provider_tags)
               .add_day
               .create_pact_with_hierarchy("foo", "1", "bar")
               .create_consumer_version_tag("feat-1")
               .add_day
+              .create_consumer_version("2", branch: "branch-1")
+              .create_pact
               .create_pact_with_hierarchy("meep", "2", "bar")
               .create_consumer_version_tag("feat-2")
               .add_day
-              .create_pact_with_hierarchy("foo", "2", "bar")
+              .create_pact_with_hierarchy("foo", "3", "bar")
               .create_consumer_version_tag("feat-2")
               .add_day
               .create_pact_with_hierarchy("meep", "1", "bar")
@@ -46,11 +48,22 @@ module PactBroker
             expect(subject[1].consumer_name).to eq "foo"
             expect(subject[1].consumer_version_number).to eq "2"
 
-            expect(subject[2].consumer_name).to eq "meep"
-            expect(subject[2].consumer_version_number).to eq "2"
+            expect(subject[2].consumer_name).to eq "foo"
+            expect(subject[2].consumer_version_number).to eq "3"
 
             expect(subject[3].consumer_name).to eq "meep"
-            expect(subject[3].consumer_version_number).to eq "1"
+            expect(subject[3].consumer_version_number).to eq "2"
+
+            expect(subject[4].consumer_name).to eq "meep"
+            expect(subject[4].consumer_version_number).to eq "1"
+          end
+
+          it "sets the selectors" do
+            expect(subject[0].selectors).to eq Selectors.create_for_latest_for_tag("feat-1")
+            expect(subject[1].selectors).to eq Selectors.create_for_latest_for_branch("branch-1")
+            expect(subject[2].selectors).to eq Selectors.create_for_latest_for_tag("feat-2")
+            expect(subject[3].selectors).to eq Selectors.create_for_latest_for_tag("feat-2")
+            expect(subject[4].selectors).to eq Selectors.create_for_latest_for_tag("feat-1")
           end
         end
 

data/spec/lib/pact_broker/pacts/selector_spec.rb

@@ -6,6 +6,7 @@ module PactBroker
       describe "<=>" do
         let(:overall_latest_1) { Selector.overall_latest }
         let(:overall_latest_2) { Selector.overall_latest }
+        let(:latest_for_branch_main) { Selector.latest_for_branch('main') }
         let(:latest_for_tag_prod) { Selector.latest_for_tag('prod') }
         let(:latest_for_tag_dev) { Selector.latest_for_tag('dev') }
         let(:all_prod_for_consumer_1) { Selector.all_for_tag_and_consumer('prod', 'Foo') }
@@ -15,11 +16,11 @@ module PactBroker
         let(:all_dev) { Selector.all_for_tag('dev') }
 
         let(:unsorted_selectors) do
-          [all_prod, all_dev, all_dev_for_consumer_1, latest_for_tag_prod, overall_latest_1, overall_latest_1, latest_for_tag_dev, all_prod_for_consumer_2, all_prod_for_consumer_1]
+          [all_prod, all_dev, all_dev_for_consumer_1, latest_for_branch_main, latest_for_tag_prod, overall_latest_1, overall_latest_1, latest_for_tag_dev, all_prod_for_consumer_2, all_prod_for_consumer_1]
         end
 
         let(:expected_sorted_selectors) do
-          [overall_latest_1, overall_latest_1, latest_for_tag_dev, latest_for_tag_prod, all_dev_for_consumer_1, all_prod_for_consumer_2, all_prod_for_consumer_1, all_dev, all_prod]
+          [overall_latest_1, overall_latest_1, latest_for_branch_main, latest_for_tag_dev, latest_for_tag_prod, all_dev_for_consumer_1, all_prod_for_consumer_2, all_prod_for_consumer_1, all_dev, all_prod]
         end
 
         it "sorts the selectors" do

data/spec/lib/pact_broker/pacts/service_find_for_verification_spec.rb

@@ -2,9 +2,7 @@ require 'spec_helper'
 require 'pact_broker/pacts/service'
 require 'pact_broker/pacts/pact_params'
 
-
 module PactBroker
-
   module Pacts
     describe Service do
       let(:td) { TestDataBuilder.new }
@@ -38,13 +36,14 @@ module PactBroker
 
         let(:provider_name) { "Bar" }
         let(:provider_version_tags) { [] }
+        let(:provider_version_branch) { "main" }
         let(:consumer_version_selectors) { [] }
 
         before do
           allow(pact_repository).to receive(:find_for_verification).and_return(head_pacts)
         end
 
-        subject { Service.find_for_verification(provider_name, provider_version_tags, consumer_version_selectors) }
+        subject { Service.find_for_verification(provider_name, provider_version_branch, provider_version_tags, consumer_version_selectors) }
       end
     end
   end

data/spec/lib/pact_broker/pacts/service_spec.rb

@@ -172,7 +172,7 @@ module PactBroker
 
         let(:options) { { } }
 
-        subject { Service.find_for_verification("Bar", ["master"], Selectors.new, options) }
+        subject { Service.find_for_verification("Bar", nil, ["master"], Selectors.new, options) }
 
 
         context "when the consumer version tags are empty" do
@@ -209,7 +209,7 @@ module PactBroker
                 .republish_same_pact(comment: "overall latest")
             end
 
-            subject { Service.find_for_verification("Wiffle", ["master"], Selectors.new, options) }
+            subject { Service.find_for_verification("Wiffle", "main", ["master"], Selectors.new, options) }
 
             it "is not included" do
               expect(subject.size).to eq 1

data/spec/lib/pact_broker/pacts/verifiable_pact_messages_spec.rb

@@ -7,6 +7,7 @@ module PactBroker
     describe VerifiablePactMessages do
       let(:pending_provider_tags) { [] }
       let(:non_pending_provider_tags) { [] }
+      let(:provider_branch) { nil }
       let(:pending) { false }
       let(:wip) { false }
       let(:selectors) { Selectors.new }
@@ -20,7 +21,8 @@ module PactBroker
             non_pending_provider_tags: non_pending_provider_tags,
             pending?: pending,
             wip?: wip,
-            selectors: selectors
+            selectors: selectors,
+            provider_branch: provider_branch
         )
       end
 
@@ -35,7 +37,18 @@ module PactBroker
         context "when there is 1 head consumer tags" do
           let(:selectors) { Selectors.create_for_latest_of_each_tag(%w[dev]) }
           its(:inclusion_reason) { is_expected.to include "The pact at http://pact is being verified because it matches the following configured selection criterion: latest pact for a consumer version tagged 'dev'" }
-          its(:pact_description) { is_expected.to eq "Pact between Foo and Bar, consumer version 123, latest dev"}
+          its(:pact_description) { is_expected.to eq "Pact between Foo and Bar, consumer version 123, latest with tag dev"}
+        end
+
+        context "when there are branches" do
+          let(:selectors) { Selectors.create_for_latest_of_each_branch(%w[main feat-x]) }
+          its(:inclusion_reason) { is_expected.to include "latest pact for a consumer version from branch 'feat-x', latest pact for a consumer version from branch 'main'" }
+          its(:pact_description) { is_expected.to eq "Pact between Foo and Bar, consumer version 123, latest from branch main, latest from branch feat-x"}
+        end
+
+        context "when there are branches and tags" do
+          let(:selectors) { Selectors.new([Selector.latest_for_branch("main"), Selector.latest_for_tag("prod")]) }
+          its(:inclusion_reason) { is_expected.to include "latest pact for a consumer version from branch 'main', latest pact for a consumer version tagged 'prod'" }
         end
 
         context "when there are 2 head consumer tags" do
@@ -53,13 +66,30 @@ module PactBroker
           its(:inclusion_reason) { is_expected.to include "latest pact for a consumer version tagged 'master' (fallback tag used as no pact was found with tag 'feat-x')" }
         end
 
-        context "when the pact is a WIP pact" do
+        context "when the pact was selected by the fallback tag" do
+          let(:selectors) { Selectors.new(Selector.latest_for_branch_with_fallback("feat-x", "master")) }
+          its(:inclusion_reason) { is_expected.to include "latest pact for a consumer version from branch 'master' (fallback branch used as no pact was found from branch 'feat-x')" }
+        end
+
+        context "when the pact is a WIP pact for the specified provider tags" do
           let(:selectors) { Selectors.create_for_latest_of_each_tag(%w[feat-x]) }
           let(:wip) { true }
           let(:pending) { true }
           let(:pending_provider_tags) { %w[dev] }
 
           its(:inclusion_reason) { is_expected.to include "The pact at http://pact is being verified because it is a 'work in progress' pact (ie. it is the pact for the latest version of Foo tagged with 'feat-x' and is still in pending state)."}
+
+          context "when the pact is a WIP pact for a consumer branch" do
+            let(:selectors) { Selectors.create_for_latest_of_each_branch(%w[feat-x feat-y]) }
+
+            its(:inclusion_reason) { is_expected.to include "The pact at http://pact is being verified because it is a 'work in progress' pact (ie. it is the pact for the latest versions of Foo from branches 'feat-x' and 'feat-y' (both have the same content) and is still in pending state)."}
+          end
+
+          context "when the pact is a WIP pact for a consumer branch and consumer rags" do
+            let(:selectors) { Selectors.create_for_latest_of_each_branch(%w[feat-x feat-y]) + Selectors.create_for_latest_of_each_tag(%w[feat-z feat-w]) }
+
+            its(:inclusion_reason) { is_expected.to include "it is the pact for the latest versions of Foo from branches 'feat-x' and 'feat-y' and tagged with 'feat-z' and 'feat-w' (all have the same content)"}
+          end
         end
 
         context "when the pact is one of all versions for a tag" do
@@ -74,13 +104,19 @@ module PactBroker
           its(:inclusion_reason) { is_expected.to include "The pact at http://pact is being verified because it matches the following configured selection criterion: pacts for all Foo versions tagged 'prod'"}
         end
 
-        context "when the pact is the latest versions for a tag and consumer" do
+        context "when the pact is the latest version for a tag and consumer" do
           let(:selectors) { Selectors.new(Selector.latest_for_tag_and_consumer('prod', 'Foo')) }
 
           its(:inclusion_reason) { is_expected.to include "The pact at http://pact is being verified because it matches the following configured selection criterion: latest pact for a version of Foo tagged 'prod'"}
         end
 
-        context "when the pact is the latest version for and consumer" do
+        context "when the pact is the latest version for a branch and consumer" do
+          let(:selectors) { Selectors.new(Selector.latest_for_branch_and_consumer('main', 'Foo')) }
+
+          its(:inclusion_reason) { is_expected.to include "The pact at http://pact is being verified because it matches the following configured selection criterion: latest pact for a version of Foo from branch 'main'"}
+        end
+
+        context "when the pact is the latest version for a consumer" do
           let(:selectors) { Selectors.new(Selector.latest_for_consumer('Foo')) }
 
           its(:inclusion_reason) { is_expected.to include "The pact at http://pact is being verified because it matches the following configured selection criterion: latest pact between Foo and Bar"}
@@ -89,7 +125,7 @@ module PactBroker
 
       describe "#pending_reason" do
         context "when the pact is not pending" do
-          context "when there are no non_pending_provider_tags" do
+          context "when there are no non_pending_provider_tags or a provider branch" do
             its(:pending_reason) { is_expected.to include "This pact has previously been successfully verified by Bar. If this verification fails, it will fail the build." }
           end
 
@@ -98,15 +134,26 @@ module PactBroker
 
             its(:pending_reason) { is_expected.to include "This pact has previously been successfully verified by a version of Bar with tag 'dev'. If this verification fails, it will fail the build."}
           end
+
+          context "when there is a provider branch" do
+            let(:provider_branch) { "main" }
+            let(:non_pending_provider_tags) { %w[dev] }
+
+            # uses branch in preference as that's what the WIP pacts logic does
+            its(:pending_reason) { is_expected.to include "This pact has previously been successfully verified by a version of Bar from branch 'main'. If this verification fails, it will fail the build."}
+          end
         end
 
         context "when the pact is pending" do
           let(:pending) { true }
 
-          context "when there are no pending_provider_tags" do
-            context "when there are no non_pending_provider_tags" do
-              its(:pending_reason) { is_expected.to include "This pact is in pending state for this version of Bar because a successful verification result for Bar has not yet been published. If this verification fails, it will not cause the overall build to fail." }
-            end
+          context "when there are no non_pending_provider_tags or a provider_branch" do
+            its(:pending_reason) { is_expected.to include "This pact is in pending state for this version of Bar because a successful verification result for Bar has not yet been published. If this verification fails, it will not cause the overall build to fail." }
+          end
+
+          context "when there is a provider_branch" do
+            let(:provider_branch) { "main" }
+            its(:pending_reason) { is_expected.to include "This pact is in pending state for this version of Bar because a successful verification result for a version of Bar from branch 'main' has not yet been published. If this verification fails, it will not cause the overall build to fail." }
           end
 
           context "when there is 1 pending_provider_tag" do