pact_broker 2.79.1 → 2.80.0

data/spec/lib/pact_broker/api/decorators/provider_pacts_decorator_spec.rb

@@ -1,4 +1,4 @@
-require 'pact_broker/api/decorators/provider_pacts_decorator'
+require "pact_broker/api/decorators/provider_pacts_decorator"
 
 module PactBroker
   module Api
@@ -7,19 +7,19 @@ module PactBroker
 
         let(:pacts) { [pact]}
         let(:pact) do
-          double('pact', name: 'Pact name', consumer_name: 'Foo')
+          double("pact", name: "Pact name", consumer_name: "Foo")
         end
         let(:user_options) do
           {
-            base_url: 'http://example.org',
-            resource_url: 'http://example.org/provider-pacts',
-            title: 'title',
-            provider_name: 'foo'
+            base_url: "http://example.org",
+            resource_url: "http://example.org/provider-pacts",
+            title: "title",
+            provider_name: "foo"
           }
         end
 
         before do
-          allow_any_instance_of(ProviderPactsDecorator).to receive(:pact_url).and_return('pact_url')
+          allow_any_instance_of(ProviderPactsDecorator).to receive(:pact_url).and_return("pact_url")
         end
 
         subject { JSON.parse ProviderPactsDecorator.new(pacts).to_json(user_options: user_options), symbolize_names: true }

data/spec/lib/pact_broker/api/decorators/publish_contracts_results_decorator_spec.rb

@@ -0,0 +1,53 @@
+require "pact_broker/api/decorators/publish_contracts_results_decorator"
+require "pact_broker/contracts/contracts_publication_results"
+require "pact_broker/contracts/notice"
+
+module PactBroker
+  module Api
+    module Decorators
+      describe PublishContractsResultsDecorator do
+        describe "to_hash" do
+          before do
+            allow(decorator).to receive(:version_url).and_return("version_url")
+            allow(decorator).to receive(:tag_url).and_return("tag_url")
+            allow(decorator).to receive(:pact_url).and_return("pact_url")
+            allow(decorator).to receive(:pacticipant_url).and_return("pacticipant_url")
+            allow(version).to receive(:pacticipant).and_return(pacticipant)
+            allow(tag).to receive(:version).and_return(version)
+          end
+
+          let(:results) do
+            PactBroker::Contracts::ContractsPublicationResults.from_hash(
+              notices: notices,
+              pacticipant: pacticipant,
+              version: version,
+              contracts: contracts,
+              tags: tags
+            )
+          end
+          let(:contracts) { [pact] }
+          let(:pact) { instance_double(PactBroker::Domain::Pact, name: "pact name") }
+          let(:pacticipant) { PactBroker::Domain::Pacticipant.new(name: "Foo" ) }
+          let(:tags) { [tag]}
+          let(:tag) { PactBroker::Domain::Tag.new(name: "main")}
+          let(:version) { PactBroker::Domain::Version.new(number: "1" ) }
+          let(:notices) { [PactBroker::Contracts::Notice.warning("foo") ] }
+          let(:decorator_options) { { user_options: user_options } }
+          let(:user_options) do
+            {
+              base_url: "http://example.org"
+            }
+          end
+
+          let(:decorator) { PublishContractsResultsDecorator.new(results) }
+
+          subject { decorator.to_hash(decorator_options) }
+
+          it {
+            Approvals.verify(subject, :name => "publish_contracts_results_decorator", format: :json)
+          }
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/api/decorators/reason_decorator_spec.rb

@@ -1,5 +1,5 @@
-require 'pact_broker/api/decorators/reason_decorator'
-require 'pact_broker/matrix/reason'
+require "pact_broker/api/decorators/reason_decorator"
+require "pact_broker/matrix/reason"
 
 module PactBroker
   module Api
@@ -8,23 +8,23 @@ module PactBroker
         REASON_CLASSES = ObjectSpace.each_object(Class).select { |klass| klass < PactBroker::Matrix::Reason && klass.name&.start_with?("PactBroker") }
 
         describe "the number of Reason classes" do
-          let(:expected_number_of_reason_classes) { 10 }
+          let(:expected_number_of_reason_classes) { 14 }
 
-          it "is 10 - add another spec here if a new Reason is added" do
+          it "is 14 - this is a reminder to add another spec here if a new Reason is added" do
             expect(REASON_CLASSES.size).to eq expected_number_of_reason_classes
           end
         end
 
         describe "#to_s" do
-          let(:consumer_selector) { double('consumer selector', description: "version 2 of Foo") }
-          let(:provider_selector) { double('provider selector', description: "version 6 of Bar") }
+          let(:consumer_selector) { double("consumer selector", description: "version 2 of Foo") }
+          let(:provider_selector) { double("provider selector", description: "version 6 of Bar") }
           let(:selectors) { [consumer_selector, provider_selector] }
 
           subject { ReasonDecorator.new(reason) }
 
           context "when the reason is PactBroker::Matrix::PactNotEverVerifiedByProvider" do
             let(:reason) { PactBroker::Matrix::PactNotEverVerifiedByProvider.new(*selectors) }
-            let(:provider_selector) { double('provider selector', description: "any version of Bar") }
+            let(:provider_selector) { double("provider selector", description: "any version of Bar") }
 
             its(:to_s) { is_expected.to eq "There is no verified pact between version 2 of Foo and any version of Bar" }
           end
@@ -53,6 +53,13 @@ module PactBroker
             its(:to_s) { is_expected.to eq "All required verification results are published and successful" }
           end
 
+          context "when the reason is PactBroker::Matrix::IgnoreSelectorDoesNotExist" do
+            let(:reason) { PactBroker::Matrix::IgnoreSelectorDoesNotExist.new(selector) }
+            let(:selector) {  double("consumer selector", description: "version 2 of Foo (no such version exists)") }
+
+            its(:to_s) { is_expected.to eq "WARN: Cannot ignore version 2 of Foo (no such version exists)" }
+          end
+
           context "when the reason is PactBroker::Matrix::InteractionsMissingVerifications" do
             let(:reason) { PactBroker::Matrix::InteractionsMissingVerifications.new(consumer_selector, provider_selector, interactions) }
             let(:interactions) do
@@ -67,7 +74,19 @@ module PactBroker
               ]
             end
 
-            its(:to_s) { is_expected.to eq "WARNING: Although the verification was reported as successful, the results for version 2 of Foo and version 6 of Bar may be missing tests for the following interactions: desc1 given p2; desc1 given desc3, desc4" }
+            its(:to_s) { is_expected.to eq "WARN: Although the verification was reported as successful, the results for version 2 of Foo and version 6 of Bar may be missing tests for the following interactions: desc1 given p2; desc1 given desc3, desc4" }
+          end
+
+          context "when the reason is NoEnvironmentSpecified" do
+            let(:reason) { PactBroker::Matrix::NoEnvironmentSpecified.new }
+
+            its(:to_s) { is_expected.to start_with "WARN: For production use of can-i-deploy, it is recommended to specify the environment" }
+          end
+
+          context "when the reason is SelectorWithoutPacticipantVersionNumberSpecified" do
+            let(:reason) { PactBroker::Matrix::SelectorWithoutPacticipantVersionNumberSpecified.new }
+
+            its(:to_s) { is_expected.to start_with "WARN: For production use of can-i-deploy, it is recommended to specify the version number" }
           end
         end
       end

data/spec/lib/pact_broker/api/decorators/relationships_csv_decorator_spec.rb

@@ -1,5 +1,5 @@
-require 'spec_helper'
-require 'pact_broker/api/decorators/relationships_csv_decorator'
+require "spec_helper"
+require "pact_broker/api/decorators/relationships_csv_decorator"
 
 module PactBroker
   module Api
@@ -13,8 +13,8 @@ module PactBroker
 
         describe "#to_csv" do
 
-          let(:line_1) { '1,My Consumer,1,3158419,0,1,2,0,0,0,0,0,0,0,0'}
-          let(:line_2) { '2,My Provider,1,3158419,0,2,0,0,0,0,0,0,0,0,0' }
+          let(:line_1) { "1,My Consumer,1,3158419,0,1,2,0,0,0,0,0,0,0,0"}
+          let(:line_2) { "2,My Provider,1,3158419,0,2,0,0,0,0,0,0,0,0,0" }
           let(:expected_text) { [line_1, line_2].join("\n") + "\n" }
 
           xit "returns the relationships as CSV" do

data/spec/lib/pact_broker/api/decorators/representable_pact_spec.rb

@@ -1,16 +1,16 @@
-require 'spec_helper'
-require 'spec/support/test_data_builder'
-require 'pact_broker/api/decorators/representable_pact'
+require "spec_helper"
+require "spec/support/test_data_builder"
+require "pact_broker/api/decorators/representable_pact"
 
 module PactBroker::Api::Decorators
   describe RepresentablePact do
-    let(:pact) { TestDataBuilder.new.create_pact_with_hierarchy('Consumer', '1.2.3', 'Provider').and_return(:pact) }
+    let(:pact) { TestDataBuilder.new.create_pact_with_hierarchy("Consumer", "1.2.3", "Provider").and_return(:pact) }
 
     subject { RepresentablePact.new(pact) }
 
     describe "initialize" do
       it "creates an object with a provider with a name" do
-        expect(subject.provider.name).to eq 'Provider'
+        expect(subject.provider.name).to eq "Provider"
       end
 
       it "creates an object with a provider with a nil version" do
@@ -18,11 +18,11 @@ module PactBroker::Api::Decorators
       end
 
       it "creates an object with a consumer with a name" do
-        expect(subject.consumer.name).to eq 'Consumer'
+        expect(subject.consumer.name).to eq "Consumer"
       end
 
       it "creates an object with a consumer that has the current pact's version" do
-        expect(subject.consumer.version.number).to eq '1.2.3'
+        expect(subject.consumer.version.number).to eq "1.2.3"
       end
     end
   end

data/spec/lib/pact_broker/api/decorators/tag_decorator_spec.rb

@@ -1,7 +1,7 @@
-require 'pact_broker/api/decorators/tag_decorator'
-require 'pact_broker/tags/repository'
+require "pact_broker/api/decorators/tag_decorator"
+require "pact_broker/tags/repository"
 
-require 'support/test_data_builder'
+require "support/test_data_builder"
 
 module PactBroker
 
@@ -19,7 +19,7 @@ module PactBroker
             .and_return(:tag)
         end
 
-        let(:options) { { user_options: { base_url: 'http://example.org' } } }
+        let(:options) { { user_options: { base_url: "http://example.org" } } }
 
         subject { JSON.parse TagDecorator.new(tag).to_json(options), symbolize_names: true }
 

data/spec/lib/pact_broker/api/decorators/tagged_pact_versions_decorator_spec.rb

@@ -1,4 +1,4 @@
-require 'pact_broker/api/decorators/tagged_pact_versions_decorator'
+require "pact_broker/api/decorators/tagged_pact_versions_decorator"
 
 module PactBroker
   module Api
@@ -6,9 +6,9 @@ module PactBroker
       describe TaggedPactVersionsDecorator do
         before do
           allow(PactBroker::Api::Decorators::PactVersionDecorator).to receive(:new).and_return(_version_decorator)
-          allow_any_instance_of(TaggedPactVersionsDecorator).to receive(:pact_url).and_return('pact_url')
-          allow_any_instance_of(TaggedPactVersionsDecorator).to receive(:pacticipant_url).and_return('pacticipant_url')
-          allow_any_instance_of(TaggedPactVersionsDecorator).to receive(:pacticipant_url).and_return('pacticipant_url')
+          allow_any_instance_of(TaggedPactVersionsDecorator).to receive(:pact_url).and_return("pact_url")
+          allow_any_instance_of(TaggedPactVersionsDecorator).to receive(:pacticipant_url).and_return("pacticipant_url")
+          allow_any_instance_of(TaggedPactVersionsDecorator).to receive(:pacticipant_url).and_return("pacticipant_url")
         end
 
         let(:user_options) do

data/spec/lib/pact_broker/api/decorators/triggered_webhook_decorator_spec.rb

@@ -1,40 +1,43 @@
-require 'pact_broker/api/decorators/triggered_webhook_decorator'
+require "pact_broker/api/decorators/triggered_webhook_decorator"
 
 module PactBroker
   module Api
     module Decorators
       describe TriggeredWebhookDecorator do
         let(:triggered_webhook) do
-          double('PactBroker::Webhooks::TriggeredWebhook',
+          double("PactBroker::Webhooks::TriggeredWebhook",
             trigger_type: PactBroker::Webhooks::TriggeredWebhook::TRIGGER_TYPE_RESOURCE_CREATION,
-            event_name: 'some_event',
+            event_name: "some_event",
             status: status,
             failure?: failure,
             retrying?: retrying,
-            trigger_uuid: '1234',
-            webhook_uuid: '4321',
+            uuid: "1234",
+            webhook_uuid: "4321",
             request_description: "GET http://foo",
             pact_publication: pact,
             number_of_attempts_made: 1,
             number_of_attempts_remaining: 2,
             created_at: DateTime.new(2017),
-            updated_at: DateTime.new(2017)
+            updated_at: DateTime.new(2017),
+            webhook: webhook
           )
         end
 
+        let(:webhook) { double("webhook") }
+
         let(:pact) do
-          double('pact',
-            provider: double(name: 'provider'),
-            consumer: double(name: 'consumer'),
-            consumer_version_number: '1',
-            name: 'foo '
+          double("pact",
+            provider: double(name: "provider"),
+            consumer: double(name: "consumer"),
+            consumer_version_number: "1",
+            name: "foo "
           )
         end
 
         let(:failure) { false }
         let(:retrying) { false }
         let(:status) { PactBroker::Webhooks::TriggeredWebhook::STATUS_SUCCESS }
-        let(:logs_url) { "http://example.org/webhooks/4321/trigger/1234/logs" }
+        let(:logs_url) { "http://example.org/triggered-webhooks/1234/logs" }
         let(:user_options) { { base_url: "http://example.org" } }
 
         let(:json) do
@@ -53,11 +56,11 @@ module PactBroker
 
         it "includes the triggered webhooks properties" do
           expect(subject).to include(
-            status: 'success',
-            triggerType: 'resource_creation',
+            status: "success",
+            triggerType: "resource_creation",
             attemptsMade: 1,
             attemptsRemaining: 2,
-            eventName: 'some_event'
+            eventName: "some_event"
           )
         end
       end

data/spec/lib/pact_broker/api/decorators/triggered_webhooks_decorator_spec.rb

@@ -1,5 +1,5 @@
-require 'pact_broker/api/decorators/triggered_webhooks_decorator'
-require 'pact_broker/webhooks/triggered_webhook'
+require "pact_broker/api/decorators/triggered_webhooks_decorator"
+require "pact_broker/webhooks/triggered_webhook"
 
 module PactBroker
   module Api
@@ -15,12 +15,12 @@ module PactBroker
         subject { JSON.parse(json) }
 
         it "includes a self relation" do
-          expect(subject['_links']['self']['title']).to eq "Title"
-          expect(subject['_links']['self']['href']).to eq "http://url"
+          expect(subject["_links"]["self"]["title"]).to eq "Title"
+          expect(subject["_links"]["self"]["href"]).to eq "http://url"
         end
 
         it "includes an embedded list of triggered webhooks" do
-          expect(subject['_embedded']['triggeredWebhooks']).to be_instance_of(Array)
+          expect(subject["_embedded"]["triggeredWebhooks"]).to be_instance_of(Array)
         end
       end
     end

data/spec/lib/pact_broker/api/decorators/verifiable_pact_decorator_spec.rb

@@ -1,13 +1,13 @@
-require 'pact_broker/api/decorators/verifiable_pact_decorator'
+require "pact_broker/api/decorators/verifiable_pact_decorator"
 
 module PactBroker
   module Api
     module Decorators
       describe VerifiablePactDecorator do
         before do
-          allow_any_instance_of(PactBroker::Api::PactBrokerUrls).to receive(:pact_version_url_with_metadata).and_return('http://pact')
+          allow_any_instance_of(PactBroker::Api::PactBrokerUrls).to receive(:pact_version_url_with_metadata).and_return("http://pact")
           allow(PactBroker::Pacts::BuildVerifiablePactNotices).to receive(:call).and_return(notices)
-          allow_any_instance_of(PactBroker::Pacts::VerifiablePactMessages).to receive(:pact_version_short_description).and_return('short desc')
+          allow_any_instance_of(PactBroker::Pacts::VerifiablePactMessages).to receive(:pact_version_short_description).and_return("short desc")
           allow_any_instance_of(VerifiablePactDecorator).to receive(:build_metadata_for_pact_for_verification).and_return(metadata)
         end
 
@@ -40,21 +40,21 @@ module PactBroker
         end
         let(:decorator) { VerifiablePactDecorator.new(pact) }
         let(:pact) do
-          double('PactBroker::Pacts::VerifiablePact',
+          double("PactBroker::Pacts::VerifiablePact",
             pending: true,
             wip: wip,
             name: "name",
             provider_name: "Bar",
             pending_provider_tags: pending_provider_tags,
             consumer_tags: consumer_tags,
-            selectors: PactBroker::Pacts::Selectors.new([PactBroker::Pacts::ResolvedSelector.new({ latest: true }, double('version', number: "2", id: 1))]))
+            selectors: PactBroker::Pacts::Selectors.new([PactBroker::Pacts::ResolvedSelector.new({ latest: true }, double("version", number: "2", id: 1))]))
         end
         let(:pending_provider_tags) { %w[dev] }
         let(:consumer_tags) { %w[dev] }
-        let(:options) { { user_options: { base_url: 'http://example.org', include_pending_status: include_pending_status } } }
+        let(:options) { { user_options: { base_url: "http://example.org", include_pending_status: include_pending_status } } }
         let(:include_pending_status) { true }
         let(:wip){ false }
-        let(:metadata) { double('metadata') }
+        let(:metadata) { double("metadata") }
         let(:json) { decorator.to_json(options) }
 
         subject { JSON.parse(json) }
@@ -64,12 +64,12 @@ module PactBroker
         end
 
         it "creates the pact version url" do
-          expect(decorator).to receive(:pact_version_url_with_metadata).with(pact, metadata, 'http://example.org')
+          expect(decorator).to receive(:pact_version_url_with_metadata).with(pact, metadata, "http://example.org")
           subject
         end
 
         it "creates the notices" do
-          allow(PactBroker::Pacts::BuildVerifiablePactNotices).to receive(:call).with(pact, 'http://pact', include_pending_status: include_pending_status)
+          allow(PactBroker::Pacts::BuildVerifiablePactNotices).to receive(:call).with(pact, "http://pact", include_pending_status: include_pending_status)
           subject
         end
 
@@ -77,7 +77,7 @@ module PactBroker
           let(:include_pending_status) { false }
 
           it "does not include the pending flag" do
-            expect(subject['verificationProperties']).to_not have_key('pending')
+            expect(subject["verificationProperties"]).to_not have_key("pending")
           end
         end
 
@@ -85,7 +85,7 @@ module PactBroker
           let(:wip) { true }
 
           it "includes the wip flag" do
-            expect(subject['verificationProperties']['wip']).to be true
+            expect(subject["verificationProperties"]["wip"]).to be true
           end
         end
       end

data/spec/lib/pact_broker/api/decorators/verifiable_pacts_decorator_spec.rb

@@ -1,4 +1,4 @@
-require 'pact_broker/api/decorators/verifiable_pacts_decorator'
+require "pact_broker/api/decorators/verifiable_pacts_decorator"
 
 module PactBroker
   module Api
@@ -8,9 +8,9 @@ module PactBroker
           allow(VerifiablePactDecorator).to receive(:new).and_return(verifiable_pact_decorator)
         end
         let(:verifiable_pact_decorator) { instance_double(VerifiablePactDecorator).as_null_object }
-        let(:pact) { double('pact') }
+        let(:pact) { double("pact") }
         let(:decorator) { VerifiablePactsDecorator.new([pact]) }
-        let(:options) { { user_options: { resource_url: 'http://example.org/pacts' } } }
+        let(:options) { { user_options: { resource_url: "http://example.org/pacts" } } }
 
         let(:json) { decorator.to_json(options) }
 

data/spec/lib/pact_broker/api/decorators/verifiable_pacts_query_decorator_spec.rb

@@ -1,4 +1,4 @@
-require 'pact_broker/api/decorators/verifiable_pacts_query_decorator'
+require "pact_broker/api/decorators/verifiable_pacts_query_decorator"
 
 module PactBroker
   module Api
@@ -70,6 +70,49 @@ module PactBroker
               expect(subject.provider_version_tags).to eq []
             end
           end
+
+          context "when a branch is specified but the latest is not specified" do
+            let(:consumer_version_selectors) do
+              [{ "branch" => "main" }]
+            end
+
+            it "defaults the latest to true" do
+              expect(subject.consumer_version_selectors.first.branch).to eq "main"
+              expect(subject.consumer_version_selectors.first.latest).to be true
+            end
+          end
+
+          context "when an environment is specified" do
+            let(:consumer_version_selectors) do
+              [{ "environment" => "prod" }]
+            end
+
+            it "sets the environment" do
+              expect(subject.consumer_version_selectors.first.environment_name).to eq "prod"
+            end
+          end
+
+          context "when an environment is specified and released is true" do
+            let(:consumer_version_selectors) do
+              [{ "environment" => "prod", "released" => true }]
+            end
+
+            it "sets the currently_supported to true" do
+              expect(subject.consumer_version_selectors.first.environment_name).to eq "prod"
+              expect(subject.consumer_version_selectors.first.currently_supported).to be true
+            end
+          end
+
+          context "when an environment is specified and deployed is true" do
+            let(:consumer_version_selectors) do
+              [{ "environment" => "prod", "deployed" => true }]
+            end
+
+            it "sets the currently_deployed to true" do
+              expect(subject.consumer_version_selectors.first.environment_name).to eq "prod"
+              expect(subject.consumer_version_selectors.first.currently_deployed).to be true
+            end
+          end
         end
 
         context "when parsing query string params" do