pact_broker 2.31.0 → 2.32.0

data/spec/integration/webhooks/certificate_spec.rb

@@ -24,7 +24,7 @@ describe "executing a webhook to a server with a self signed certificate" do
 
   let(:pact) { td.create_pact_with_hierarchy.and_return(:pact) }
 
-  subject { webhook_request.execute({}) }
+  subject { webhook_request.execute({ show_response: true }) }
 
   context "without the correct cacert" do
     it "fails" do

data/spec/lib/pact_broker/api/contracts/webhook_contract_spec.rb

@@ -298,6 +298,18 @@ module PactBroker
               expect(subject.errors[:"request.url"]).to eq ["cannot have a template parameter in the host"]
             end
           end
+
+          context "when enabled is not a boolean", pending: "I can't work out why this doesn't work" do
+            let(:json) do
+              valid_webhook_with do |hash|
+                hash['enabled'] = 'foo'
+              end
+            end
+
+            it "contains an error" do
+              expect(subject.errors[:enabled]).to eq ["cannot have a template parameter in the host"]
+            end
+          end
         end
       end
     end

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

@@ -0,0 +1,82 @@
+require 'pact_broker/api/decorators/integration_decorator'
+require 'pact_broker/integrations/integration'
+
+module PactBroker
+  module Api
+    module Decorators
+      describe IntegrationDecorator do
+        before do
+          allow(integration_decorator).to receive(:dashboard_url_for_integration).and_return("/dashboard")
+          allow(integration_decorator).to receive(:matrix_url).and_return("/matrix")
+          allow(integration_decorator).to receive(:group_url).and_return("/group")
+        end
+
+        let(:integration) do
+          instance_double(PactBroker::Integrations::Integration,
+            consumer: consumer,
+            provider: provider
+          )
+        end
+        let(:consumer) { double("consumer", name: "the consumer") }
+        let(:provider) { double("provider", name: "the provider") }
+        let(:options) { { user_options: { base_url: 'http://example.org' } } }
+        let(:expected_hash) do
+          {
+            "consumer" => {
+              "name" => "the consumer"
+            },
+            "provider" => {
+              "name" => "the provider"
+            },
+            "_links" => {
+              "pb:dashboard" => {
+                "href" => "/dashboard"
+              },
+              "pb:matrix" => {
+                "title" => "Matrix of pacts/verification results for the consumer and the provider",
+                "href" => "/matrix"
+              },
+              "pb:group" => {
+                "href" => "/group"
+              }
+            }
+          }
+        end
+
+        let(:integration_decorator) { IntegrationDecorator.new(integration) }
+        let(:json) { integration_decorator.to_json(options) }
+        subject { JSON.parse(json) }
+
+        it "generates a hash" do
+          expect(subject).to match_pact expected_hash
+        end
+
+        it "generates the correct link for the dashboard" do
+          expect(integration_decorator).to receive(:dashboard_url_for_integration).with(
+            "the consumer",
+            "the provider",
+            "http://example.org"
+          )
+          subject
+        end
+
+        it "generates the correct link for the matrix" do
+          expect(integration_decorator).to receive(:matrix_url).with(
+            "the consumer",
+            "the provider",
+            "http://example.org"
+          )
+          subject
+        end
+
+        it "generates the correct group url for the matrix" do
+          expect(integration_decorator).to receive(:group_url).with(
+            "the consumer",
+            "http://example.org"
+          )
+          subject
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+require 'pact_broker/api/decorators/integrations_decorator'
+
+module PactBroker
+  module Api
+    module Decorators
+      describe IntegrationsDecorator do
+        before do
+          allow(IntegrationDecorator).to receive(:new).and_return(integration_decorator)
+        end
+        let(:integration_decorator) { instance_double(IntegrationDecorator).as_null_object }
+        let(:integration) { double('integration') }
+        let(:integrations_decorator) { IntegrationsDecorator.new([integration]) }
+        let(:options) { { user_options: { resource_url: 'http://example.org/integrations' } } }
+
+        let(:json) { integrations_decorator.to_json(options) }
+
+        subject { JSON.parse(json) }
+
+        it "includes a list of integrations" do
+          expect(subject["_embedded"]["integrations"]).to be_an(Array)
+        end
+
+        it "includes a link to itself" do
+          expect(subject["_links"]["self"]["href"]).to eq "http://example.org/integrations"
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,8 @@ module PactBroker
       describe PactDecorator do
 
         before do
-          allow_any_instance_of(PactDecorator).to receive(:templated_diff_url).and_return('templated-diff-url')
+          allow(decorator).to receive(:templated_diff_url).and_return('templated-diff-url')
+          allow(decorator).to receive(:verification_publication_url).and_return('verification-publication-url')
         end
         let(:content_hash) {
           {
@@ -34,11 +35,18 @@ module PactBroker
         let(:consumer) { instance_double(PactBroker::Domain::Pacticipant, name: 'A Consumer')}
         let(:provider) { instance_double(PactBroker::Domain::Pacticipant, name: 'A Provider')}
         let(:consumer_version) { instance_double(PactBroker::Domain::Version, number: '1234', pacticipant: consumer)}
-
-        subject { JSON.parse PactDecorator.new(pact).to_json(user_options: { base_url: base_url }), symbolize_names: true}
+        let(:metadata) { "abcd" }
+        let(:decorator) { PactDecorator.new(pact) }
+        let(:json) { decorator.to_json(user_options: { base_url: base_url, metadata: metadata }) }
+        subject { JSON.parse(json, symbolize_names: true) }
 
         describe "#to_json" do
 
+          it "creates the verification link" do
+            expect(decorator).to receive(:verification_publication_url).with(pact, base_url, metadata)
+            subject
+          end
+
           it "includes the json_content" do
             expect(subject[:consumer]).to eq name: 'Consumer'
           end
@@ -102,7 +110,7 @@ module PactBroker
           end
 
           it "includes a link to publish a verification" do
-            expect(subject[:_links][:'pb:publish-verification-results'][:href]).to match %r{http://example.org/.*/verification-results}
+            expect(subject[:_links][:'pb:publish-verification-results'][:href]).to eq "verification-publication-url"
           end
 
           it "includes a link to diff this pact version with another pact version" do

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

@@ -0,0 +1,30 @@
+require 'pact_broker/api/decorators/verifiable_pact_decorator'
+
+module PactBroker
+  module Api
+    module Decorators
+      describe VerifiablePactDecorator do
+
+        let(:expected_hash) do
+          {
+            "pending" => true,
+            "_links" => {
+              "self" => "http://pact"
+            }
+          }
+        end
+
+        let(:decorator) { VerifiablePactDecorator.new(pact) }
+        let(:pact) { double('pact') }
+        let(:json) { decorator.to_json(options) }
+        let(:options) { { user_options: { base_url: 'http://example.org' } } }
+
+        subject { JSON.parse(json) }
+
+        it "generates a matching hash", pending: true do
+          expect(subject).to match_pact(expected_hash)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+require 'pact_broker/api/decorators/verifiable_pacts_decorator'
+
+module PactBroker
+  module Api
+    module Decorators
+      describe VerifiablePactsDecorator do
+        before do
+          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(:decorator) { VerifiablePactsDecorator.new([pact]) }
+        let(:options) { { user_options: { resource_url: 'http://example.org/pacts' } } }
+
+        let(:json) { decorator.to_json(options) }
+
+        subject { JSON.parse(json) }
+
+        it "includes a list of verifiable pacts" do
+          expect(subject["_embedded"]["pacts"]).to be_an(Array)
+        end
+
+        it "includes a link to itself" do
+          expect(subject["_links"]["self"]["href"]).to eq "http://example.org/pacts"
+        end
+      end
+    end
+  end
+end

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

@@ -5,6 +5,7 @@ module PactBroker
   module Api
     module Decorators
       describe WebhookDecorator do
+        let(:description) { "Trigger build" }
         let(:headers) { { :'Content-Type' => 'application/json' } }
         let(:request) do
           {
@@ -27,13 +28,15 @@ module PactBroker
 
         let(:webhook) do
           Domain::Webhook.new(
+            description: description,
             request: webhook_request,
             uuid: 'some-uuid',
             consumer: consumer,
             provider: provider,
             events: [event],
             created_at: created_at,
-            updated_at: updated_at
+            updated_at: updated_at,
+            enabled: false
           )
         end
 
@@ -42,6 +45,10 @@ module PactBroker
         describe 'to_json' do
           let(:parsed_json) { JSON.parse(subject.to_json(user_options: { base_url: 'http://example.org' }), symbolize_names: true) }
 
+          it 'includes the description' do
+            expect(parsed_json[:description]).to eq "Trigger build"
+          end
+
           it 'includes the request' do
             expect(parsed_json[:request]).to eq request
           end
@@ -90,6 +97,10 @@ module PactBroker
             expect(parsed_json[:updatedAt]).to eq FormatDateTime.call(updated_at)
           end
 
+          it 'includes the enabled flag' do
+            expect(parsed_json[:enabled]).to eq false
+          end
+
           context 'when the headers are empty' do
             let(:headers) { nil }
             it 'does not include the headers' do
@@ -131,6 +142,14 @@ module PactBroker
               expect(parsed_json[:request][:headers][:'Authorization']).to eq "**********"
             end
           end
+
+          context "when the description is empty" do
+            let(:description) { " " }
+
+            it 'uses the scope description' do
+              expect(parsed_json[:description]).to match /example.org/
+            end
+          end
         end
 
         describe 'from_json' do

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

@@ -43,10 +43,6 @@ module PactBroker
             it "includes the message" do
               expect(subject[:error][:message]).to eq 'message'
             end
-
-            it "includes the backtrace" do
-              expect(subject[:error][:backtrace]).to eq ['blah','blah']
-            end
           end
 
           context "when there is a request" do

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

@@ -7,7 +7,10 @@ module PactBroker
       describe WebhooksDecorator do
 
         let(:webhook) do
-          instance_double(Domain::Webhook, uuid: 'some-uuid', description: 'description', request_description: 'request description')
+          instance_double(Domain::Webhook,
+            uuid: 'some-uuid',
+            display_description: 'description'
+          )
         end
         let(:base_url) { 'http://example.org' }
         let(:resource_url) { 'http://example.org/webhooks' }
@@ -31,15 +34,13 @@ module PactBroker
 
           it "includes a list of links to the webhooks" do
             expect(subject[:_links][:'pb:webhooks']).to be_instance_of(Array)
-            expect(subject[:_links][:'pb:webhooks'].first).to eq title: 'description', name: 'request description', href: 'http://example.org/webhooks/some-uuid'
+            expect(subject[:_links][:'pb:webhooks'].first).to eq title: 'Webhook', name: 'description', href: 'http://example.org/webhooks/some-uuid'
           end
 
           it "includes curies" do
             expect(subject[:_links][:curies]).to eq [{:name=>"pb", :href=>"http://example.org/doc/webhooks-{rel}", templated: true}]
           end
-
         end
-
       end
     end
   end

data/spec/lib/pact_broker/api/pact_broker_urls_spec.rb

@@ -10,7 +10,14 @@ module PactBroker
       let(:base_url) { "http://example.org" }
       let(:consumer_name) { "Foo/Foo" }
       let(:provider_name) { "Bar/Bar" }
-      let(:pact) { double('pact', consumer: consumer, provider: provider, consumer_version_number: "123/456", pact_version_sha: "5hbfu") }
+      let(:pact) do
+        double('pact',
+          consumer: consumer,
+          provider: provider,
+          consumer_version_number: "123/456",
+          pact_version_sha: "5hbfu",
+          consumer_version_tag_names: ["dev"])
+      end
       let(:consumer) { double('pacticipant', name: consumer_name) }
       let(:provider) { double('pacticipant', name: provider_name) }
       let(:verification) do
@@ -21,9 +28,29 @@ module PactBroker
           number: "1")
       end
 
+      matcher :match_route_in_api do |api|
+        match do |url|
+          req = Webmachine::Request.new("GET", URI(url), Webmachine::Headers.new, "", nil)
+          api.application.routes.any?{ |route| route.match?(req) }
+        end
+
+        description do
+          "match route in API"
+        end
+
+        failure_message do |_|
+          "expected API to have route for path #{URI.parse(url).path}"
+        end
+
+        failure_message_when_negated do |_|
+          "expected API to not have route for path #{URI.parse(url).path}"
+        end
+      end
+
       describe "pact_url" do
         subject { PactBrokerUrls.pact_url(base_url, pact) }
 
+        it { is_expected.to match_route_in_api(PactBroker::API) }
         it { is_expected.to eq "http://example.org/pacts/provider/Bar%2FBar/consumer/Foo%2FFoo/version/123%2F456" }
       end
 
@@ -36,20 +63,56 @@ module PactBroker
       describe "pact_triggered_webhooks_url" do
         subject { PactBrokerUrls.pact_triggered_webhooks_url(pact, base_url) }
 
+        it { is_expected.to match_route_in_api(PactBroker::API) }
         it { is_expected.to eq "http://example.org/pacts/provider/Bar%2FBar/consumer/Foo%2FFoo/version/123%2F456/triggered-webhooks" }
       end
 
       describe "verification_triggered_webhooks_url" do
         subject { PactBrokerUrls.verification_triggered_webhooks_url(verification, base_url) }
 
+        it { is_expected.to match_route_in_api(PactBroker::API) }
         it { is_expected.to eq "http://example.org/pacts/provider/Bar%2FBar/consumer/Foo%2FFoo/pact-version/1234/verification-results/1/triggered-webhooks" }
       end
 
+      describe "verification_publication_url" do
+        context "with no metadata" do
+          subject { PactBrokerUrls.verification_publication_url(verification, base_url) }
+
+          it { is_expected.to match_route_in_api(PactBroker::API) }
+          it { is_expected.to eq "http://example.org/pacts/provider/Bar%2FBar/consumer/Foo%2FFoo/pact-version/1234/metadata//verification-results" }
+        end
+
+        context "with metadata" do
+          subject { PactBrokerUrls.verification_publication_url(verification, base_url, "abcd") }
+
+          it { is_expected.to match_route_in_api(PactBroker::API) }
+          it { is_expected.to eq "http://example.org/pacts/provider/Bar%2FBar/consumer/Foo%2FFoo/pact-version/1234/metadata/abcd/verification-results" }
+        end
+      end
+
       describe "templated_diff_url" do
         subject { PactBrokerUrls.templated_diff_url(pact, base_url) }
 
         it { is_expected.to eq "http://example.org/pacts/provider/Bar%2FBar/consumer/Foo%2FFoo/pact-version/5hbfu/diff/pact-version/{pactVersion}" }
       end
+
+      describe "webhook metadata" do
+        let(:expected_metadata) do
+          { consumer_version_number: "123/456", consumer_version_tags: %w[dev] }
+        end
+
+        it "builds the webhook metadata" do
+          expect(PactBrokerUrls.parse_webhook_metadata(PactBrokerUrls.build_webhook_metadata(pact))).to eq (expected_metadata)
+        end
+      end
+
+      describe "parse_webhook_metadata" do
+        context "when the metadata is nil" do
+          it "returns an empty hash" do
+            expect(PactBrokerUrls.parse_webhook_metadata(nil)).to eq({})
+          end
+        end
+      end
     end
   end
 end