pact_broker 2.34.0 → 2.35.0

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

@@ -5,10 +5,8 @@ module PactBroker
   module Api
     module Decorators
       describe WebhookExecutionResultDecorator do
-
         describe "to_json" do
-
-          let(:webhook_execution_result) { PactBroker::Webhooks::WebhookExecutionResult.new(request, response, logs, error)}
+          let(:webhook_execution_result) { PactBroker::Webhooks::WebhookExecutionResult.new(request, response, logs, error) }
           let(:logs) { "logs" }
           let(:headers) { { "Something" => ["blah", "thing"]} }
           let(:request) do
@@ -20,21 +18,40 @@ module PactBroker
           let(:response) { double('http_response', code: '200', body: response_body, to_hash: headers) }
           let(:response_body) { 'body' }
           let(:error) { nil }
-          let(:webhook) { instance_double(PactBroker::Domain::Webhook, uuid: 'some-uuid') }
+          let(:webhook) { instance_double(PactBroker::Domain::Webhook, uuid: uuid) }
+          let(:uuid) { 'some-uuid' }
           let(:show_response) { true }
           let(:json) {
             WebhookExecutionResultDecorator.new(webhook_execution_result)
-            .to_json(user_options: { base_url: 'http://example.org', webhook: webhook, show_response: show_response })
+            .to_json(user_options: { resource_url: 'http://resource-url', base_url: 'http://example.org', webhook: webhook, show_response: show_response })
           }
 
-          let(:subject) { JSON.parse(json, symbolize_names: true)}
+          let(:subject) { JSON.parse(json, symbolize_names: true) }
 
           it "includes a link to execute the webhook again" do
-            expect(subject[:_links][:'try-again'][:href]).to eq 'http://example.org/webhooks/some-uuid/execute'
+            expect(subject[:_links][:'try-again'][:href]).to eq 'http://resource-url'
+          end
+
+          it "includes a success flag" do
+            expect(subject[:success]).to be true
+          end
+
+          it "includes the logs" do
+            expect(subject[:logs]).to eq logs
           end
 
-          it "includes a link to the webhook" do
-            expect(subject[:_links][:webhook][:href]).to eq 'http://example.org/webhooks/some-uuid'
+          context "when there is a uuid" do
+            it "include a link to the webhook" do
+              expect(subject[:_links][:webhook][:href]).to eq 'http://example.org/webhooks/some-uuid'
+            end
+          end
+
+          context "when there is a not uuid because this is an unsaved webhook" do
+            let(:uuid) { nil }
+
+            it "does not includes a link to the webhook" do
+              expect(subject[:_links]).to_not have_key(:webhook)
+            end
           end
 
           context "when there is an error" do

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

@@ -17,7 +17,9 @@ module PactBroker
             method: 'POST',
             url: 'url',
             body: 'body',
-            headers: {})
+            redacted_headers: {
+              'foo' => '***'
+            })
         end
 
         let(:json) { WebhookRequestTemplateDecorator.new(webhook_request).to_json }

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

@@ -9,7 +9,8 @@ module PactBroker
         let(:webhook) do
           instance_double(Domain::Webhook,
             uuid: 'some-uuid',
-            display_description: 'description'
+            display_description: 'description',
+            scope_description: 'scope description'
           )
         end
         let(:base_url) { 'http://example.org' }
@@ -34,7 +35,7 @@ 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: 'Webhook', name: 'description', href: 'http://example.org/webhooks/some-uuid'
+            expect(subject[:_links][:'pb:webhooks'].first).to eq title: 'scope description', name: 'description', href: 'http://example.org/webhooks/some-uuid'
           end
 
           it "includes curies" do

data/spec/lib/pact_broker/api/resources/badge_spec.rb

@@ -22,7 +22,6 @@ module PactBroker
         let(:verification) { double("verification", provider_version_number: "3", number: "7") }
         let(:verification_status) { instance_double("PactBroker::Verifications::Status", to_sym: :verified) }
 
-
         subject { get path, params, {'HTTP_ACCEPT' => 'image/svg+xml'}; last_response }
 
         context "when enable_public_badge_access is false and the request is not authenticated" do
@@ -142,7 +141,6 @@ module PactBroker
               subject
             end
 
-
             context "when a verification is found" do
               before do
                 allow(PactBroker::Verifications::Service).to receive(:find_latest_verification_for_tags).and_return(verification)

data/spec/lib/pact_broker/api/resources/dashboard_spec.rb

@@ -9,7 +9,6 @@ module PactBroker
         let(:path) { "/dashboard" }
         subject { get path; last_response }
 
-
       end
     end
   end

data/spec/lib/pact_broker/api/resources/error_handler_spec.rb

@@ -9,6 +9,7 @@ module PactBroker
           before do
             allow(ErrorHandler).to receive(:logger).and_return(logger)
             allow(SecureRandom).to receive(:urlsafe_base64).and_return("bYWfn-+yWPlf")
+            allow(error).to receive(:backtrace).and_return(["backtrace"])
           end
 
           let(:logger) { double('logger').as_null_object }
@@ -71,6 +72,7 @@ module PactBroker
                 subject
               end
             end
+
             context "when the error is not a PactBroker::Error or subclass" do
               it "invokes the api error reporters" do
                 expect(thing).to receive(:call).with(error, options)
@@ -120,6 +122,7 @@ module PactBroker
                 subject
               end
             end
+
             context "when the error is not a PactBroker::Error or subclass" do
               it "invokes the api error reporters" do
                 expect(thing).to receive(:call).with(error, options)

data/spec/lib/pact_broker/api/resources/group_spec.rb

@@ -72,7 +72,6 @@ module PactBroker::Api
           end
         end
 
-
       end
 
     end

data/spec/lib/pact_broker/api/resources/pact_spec.rb

@@ -4,7 +4,6 @@ require 'rack/test'
 require 'pact_broker/pacts/service'
 require 'pact_broker/pacticipants/service'
 
-
 module PactBroker::Api
   module Resources
     describe Pact do
@@ -59,7 +58,6 @@ module PactBroker::Api
         end
       end
 
-
       shared_examples "an update endpoint" do |http_method|
         subject { self.send http_method, "/pacts/provider/Provider/consumer/Consumer/version/1.2.3", json, {'CONTENT_TYPE' => "application/json"} ; last_response }
 

data/spec/lib/pact_broker/api/resources/pacticipant_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 require 'pact_broker/api/resources/pacticipant'
 
-
 module PactBroker::Api
 
   module Resources

data/spec/lib/pact_broker/api/resources/tag_spec.rb

@@ -138,7 +138,6 @@ module PactBroker
               allow(Tags::Service).to receive(:create).and_return(tag)
             end
 
-
             it "creates the tag" do
               expect(Tags::Service).to receive(:create).with(hash_including(tag_attributes))
               subject
@@ -157,7 +156,6 @@ module PactBroker
 
           end
 
-
         end
 
       end

data/spec/lib/pact_broker/api/resources/verifications_spec.rb

@@ -19,11 +19,14 @@ module PactBroker
           let(:errors_empty) { true }
           let(:parsed_metadata) { { the: 'metadata' } }
           let(:base_url) { "http://example.org" }
+          let(:webhook_execution_configuration) { instance_double(PactBroker::Webhooks::ExecutionConfiguration) }
 
           before do
             allow(PactBroker::Verifications::Service).to receive(:create).and_return(verification)
             allow(PactBroker::Verifications::Service).to receive(:errors).and_return(double(:errors, messages: ['errors'], empty?: errors_empty))
             allow(PactBrokerUrls).to receive(:parse_webhook_metadata).and_return(parsed_metadata)
+            allow_any_instance_of(Verifications).to receive(:webhook_execution_configuration).and_return(webhook_execution_configuration)
+            allow(webhook_execution_configuration).to receive(:with_webhook_context).and_return(webhook_execution_configuration)
           end
 
           subject { post url, request_body, rack_env; last_response }
@@ -74,19 +77,18 @@ module PactBroker
               expect(subject.headers['Location']).to eq("http://example.org/pacts/provider/Provider/consumer/Consumer/pact-version/1234/verification-results/2")
             end
 
+            it "merges the upstream verification metdata into the webhook context" do
+              expect(webhook_execution_configuration).to receive(:with_webhook_context).with(parsed_metadata)
+              subject
+            end
+
             it "stores the verification in the database" do
               expect(PactBroker::Verifications::Service).to receive(:create).with(
                 next_verification_number,
                 hash_including('some' => 'params'),
                 pact,
                 {
-                  logging_options: {
-                    show_response: 'some-boolean'
-                  },
-                  webhook_context: {
-                    the: 'metadata',
-                    base_url: base_url,
-                  },
+                  webhook_execution_configuration: webhook_execution_configuration,
                   database_connector: database_connector
                 }
               )

data/spec/lib/pact_broker/api/resources/webhook_execution_spec.rb

@@ -4,11 +4,8 @@ require 'pact_broker/api/resources/webhook_execution'
 module PactBroker
   module Api
     module Resources
-
       describe WebhookExecution do
-
         describe "POST" do
-
           before do
             allow(PactBroker::Webhooks::Service).to receive(:find_by_uuid).and_return(webhook)
           end
@@ -33,28 +30,29 @@ module PactBroker
             let(:pact) { instance_double("PactBroker::Domain::Pact") }
             let(:consumer_name) { "foo" }
             let(:provider_name) { "bar" }
-            let(:webhook_options) do
-              {
-                logging_options: {
-                  show_response: false,
-                },
-                webhook_context: {
-                  base_url: "http://example.org"
-                }
-              }
-            end
+            let(:webhook_execution_configuration) { instance_double(PactBroker::Webhooks::ExecutionConfiguration) }
 
             before do
               allow(PactBroker::Webhooks::Service).to receive(:test_execution).and_return(execution_result)
               allow(PactBroker::Api::Decorators::WebhookExecutionResultDecorator).to receive(:new).and_return(decorator)
+              allow_any_instance_of(WebhookExecution).to receive(:webhook_execution_configuration).and_return(webhook_execution_configuration)
             end
 
             it "executes the webhook" do
-              expect(PactBroker::Webhooks::Service).to receive(:test_execution).with(webhook, webhook_options)
+              expect(PactBroker::Webhooks::Service).to receive(:test_execution).with(webhook, webhook_execution_configuration)
               subject
             end
 
             context "when execution is successful" do
+              let(:expected_user_options) do
+                {
+                  resource_url: 'http://example.org/webhooks/some-uuid/execute',
+                  base_url: 'http://example.org',
+                  webhook: webhook,
+                  show_response: 'foo',
+                }
+              end
+
               it "returns a 200 JSON response" do
                 subject
                 expect(last_response).to be_a_hal_json_success_response
@@ -62,7 +60,7 @@ module PactBroker
 
               it "generates a JSON response body for the execution result" do
                 allow(PactBroker.configuration).to receive(:show_webhook_response?).and_return('foo')
-                expect(decorator).to receive(:to_json).with(user_options: { base_url: 'http://example.org', webhook: webhook, show_response: 'foo' })
+                expect(decorator).to receive(:to_json).with(user_options: expected_user_options)
                 subject
               end
 

data/spec/lib/pact_broker/api/resources/webhooks_spec.rb

@@ -171,7 +171,6 @@ module PactBroker::Api
           end
         end
 
-
         context "with invalid attributes" do
 
           let(:valid) { false }

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

@@ -4,7 +4,7 @@ module PactBroker
   module Certificates
     describe Service do
       let(:certificate_content) { File.read('spec/fixtures/certificate.pem') }
-      let(:logger) { double('logger').as_null_object }
+      let(:logger) { spy('logger') }
 
       before do
         allow(Service).to receive(:logger).and_return(logger)
@@ -17,19 +17,25 @@ module PactBroker
           expect(subject).to be_instance_of(OpenSSL::X509::Store)
         end
 
-        context "when there is a duplicate certificate" do
+        context "when there is an error adding certificate" do
+          let(:cert_store) { instance_spy(OpenSSL::X509::Store) }
+
           before do
             Certificate.create(uuid: '1234', content: certificate_content)
-            Certificate.create(uuid: '5678', content: certificate_content)
+
+            allow(cert_store).to receive(:add_cert).and_raise(StandardError)
+            allow(OpenSSL::X509::Store).to receive(:new).and_return(cert_store)
           end
 
           it "logs the error" do
-            expect(Service).to receive(:log_error).with(anything, /Error adding certificate/).at_least(1).times
             subject
+
+            expect(logger).to have_received(:error)
+              .with(/Error adding certificate/).at_least(1).times
           end
 
           it "returns an OpenSSL::X509::Store" do
-            expect(subject).to be_instance_of(OpenSSL::X509::Store)
+            expect(subject).to be(cert_store)
           end
         end
       end

data/spec/lib/pact_broker/domain/group_spec.rb

@@ -6,7 +6,6 @@ module PactBroker
   module Domain
     describe Group do
 
-
       describe "#include_pacticipant" do
 
         let(:consumer_a) { double('consumer a') }

data/spec/lib/pact_broker/domain/webhook_spec.rb

@@ -8,6 +8,8 @@ module PactBroker
       let(:provider) { Pacticipant.new(name: 'Provider')}
       let(:request_template) { instance_double(PactBroker::Webhooks::WebhookRequestTemplate, build: webhook_request)}
       let(:webhook_request) { instance_double(PactBroker::Domain::WebhookRequest, execute: http_response, http_request: http_request) }
+      let(:webhook_template_parameters) { instance_double(PactBroker::Webhooks::PactAndVerificationParameters, to_hash: webhook_template_parameters_hash) }
+      let(:webhook_template_parameters_hash) { { 'foo' => 'bar' } }
       let(:http_request) { double('http request') }
       let(:http_response) { double('http response') }
       let(:webhook_context) { { some: 'things' } }
@@ -19,6 +21,7 @@ module PactBroker
 
       before do
         allow(webhook).to receive(:logger).and_return(logger)
+        allow(PactBroker::Webhooks::PactAndVerificationParameters).to receive(:new).and_return(webhook_template_parameters)
       end
 
       subject(:webhook) { Webhook.new(uuid: uuid, request: request_template, consumer: consumer, provider: provider) }
@@ -60,11 +63,15 @@ module PactBroker
 
         let(:execute) { subject.execute pact, verification, options }
 
+        it "creates the template parameters" do
+          expect(PactBroker::Webhooks::PactAndVerificationParameters).to receive(:new).with(
+            pact, verification, webhook_context
+          )
+          execute
+        end
+
         it "builds the request" do
-          expect(request_template).to receive(:build).with(
-            pact: pact,
-            verification: verification,
-            webhook_context: webhook_context)
+          expect(request_template).to receive(:build).with(webhook_template_parameters_hash)
           execute
         end
 

data/spec/lib/pact_broker/feature_toggle_spec.rb

@@ -60,7 +60,6 @@ module PactBroker
           it { is_expected.to be true }
         end
 
-
         context "when PACT_BROKER_FEATURES does not include the given string" do
           before do
             allow(ENV).to receive(:[]).with('PACT_BROKER_FEATURES').and_return(nil)

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

@@ -7,7 +7,6 @@ module PactBroker
   module Groups
     describe Service do
 
-
       describe "#find_group_containing" do
 
         let(:consumer_a) { double('consumer a', name: 'consumer a', id: 1)}

data/spec/lib/pact_broker/hash_refinements_spec.rb

@@ -0,0 +1,15 @@
+require 'pact_broker/hash_refinements'
+
+module PactBroker
+  describe HashRefinements do
+    using HashRefinements
+
+    let(:a) { { a: 1, b: { c: 3 }, d: 5, e: nil } }
+    let(:b) { { a: 2, b: { c: 4 } } }
+    let(:expected) { { a: 2, b: { c: 4 }, d: 5, e: nil } }
+
+    it "merges" do
+      expect(a.deep_merge(b)).to eq expected
+    end
+  end
+end

data/spec/lib/pact_broker/matrix/repository_spec.rb

@@ -44,7 +44,6 @@ module PactBroker
         subject { shorten_rows(rows) }
         let(:rows) { Repository.new.find(selectors, options) }
 
-
         let(:options) { { latestby: latestby } }
         let(:latestby) { nil }
         let(:a1_b1_n1) { "A1 B1 n1" }
@@ -784,7 +783,6 @@ module PactBroker
           end
         end
 
-
       end
 
       describe "#find_for_consumer_and_provider" do

data/spec/lib/pact_broker/pacticipants/find_potential_duplicate_pacticipant_names_spec.rb

@@ -30,7 +30,6 @@ module PactBroker
 
         subject { FindPotentialDuplicatePacticipantNames.call(new_name, existing_names) }
 
-
         CALL_TEST_CASES = [
           ["accounts", ["accounts-receivable"], []],
           ["Accounts", ["Accounts Receivable"], []],

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

@@ -92,6 +92,22 @@ module PactBroker
           expect(PactVersion.first.latest_consumer_version_number).to eq "1.0.1"
         end
       end
+
+      describe "#latest_verification" do
+        before do
+          td.create_pact_with_hierarchy
+            .create_verification
+            .create_verification(number: 2)
+            .create_verification(number: 3)
+        end
+        let(:pact_version) { PactVersion.last }
+
+        subject { pact_version.latest_verification }
+
+        it "returns the latest verification by execution date" do
+          expect(subject.number).to eq 3
+        end
+      end
     end
   end
 end

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

@@ -88,6 +88,17 @@ module PactBroker
           it "reuses the same PactVersion to save room" do
             expect { subject }.to_not change{ PactVersion.count }
           end
+
+          context "when there is a race condition and the pact version gets created by another request in between attempting to find and create" do
+            before do
+              allow(PactVersion).to receive(:find).and_return(nil)
+            end
+
+            it "doesn't blow up" do
+              expect(PactVersion).to receive(:find)
+              subject
+            end
+          end
         end
 
         context "when base_equality_only_on_content_that_affects_verification_results is true" do

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

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'pact_broker/pacts/service'
 require 'pact_broker/pacts/pact_params'
-
+require 'pact_broker/webhooks/execution_configuration'
 
 module PactBroker
 
@@ -47,13 +47,15 @@ module PactBroker
         end
         let(:content) { double('content') }
         let(:content_with_interaction_ids) { double('content_with_interaction_ids', to_json: json_content_with_ids) }
-        let(:webhook_options) { { the: 'options'} }
-        let(:outgoing_webhook_options) { { the: 'options', webhook_context: { consumer_version_tags: %[dev] }} }
+        let(:webhook_options) { { webhook_execution_configuration: webhook_execution_configuration } }
+        let(:webhook_execution_configuration) { instance_double(PactBroker::Webhooks::ExecutionConfiguration) }
+
 
         before do
           allow(Content).to receive(:from_json).and_return(content)
           allow(content).to receive(:with_ids).and_return(content_with_interaction_ids)
           allow(PactBroker::Pacts::GenerateSha).to receive(:call).and_call_original
+          allow(webhook_execution_configuration).to receive(:with_webhook_context).and_return(webhook_execution_configuration)
         end
 
         subject { Service.create_or_update_pact(params, webhook_options) }
@@ -70,8 +72,13 @@ module PactBroker
             subject
           end
 
+          it "sets the consumer version tags" do
+            expect(webhook_execution_configuration).to receive(:with_webhook_context).with(consumer_version_tags: %[dev]).and_return(webhook_execution_configuration)
+            subject
+          end
+
           it "triggers webhooks" do
-            expect(webhook_trigger_service).to receive(:trigger_webhooks_for_new_pact).with(new_pact, outgoing_webhook_options)
+            expect(webhook_trigger_service).to receive(:trigger_webhooks_for_new_pact).with(new_pact, webhook_options)
             subject
           end
         end
@@ -97,7 +104,7 @@ module PactBroker
           end
 
           it "triggers webhooks" do
-            expect(webhook_trigger_service).to receive(:trigger_webhooks_for_updated_pact).with(existing_pact, new_pact, outgoing_webhook_options)
+            expect(webhook_trigger_service).to receive(:trigger_webhooks_for_updated_pact).with(existing_pact, new_pact, webhook_options)
             subject
           end
         end

data/spec/lib/pact_broker/relationships/groupify_spec.rb

@@ -23,14 +23,12 @@ module PactBroker
         let(:provider_y) { double('provider y', id: 8, name: 'provider y') }
         let(:provider_z) { double('provider z', id: 9, name: 'provider z') }
 
-
         let(:relationship_1) { Domain::IndexItem.new(consumer_a, provider_x) }
         let(:relationship_4) { Domain::IndexItem.new(consumer_a, provider_y) }
         let(:relationship_2) { Domain::IndexItem.new(consumer_b, provider_y) }
 
         let(:relationship_3) { Domain::IndexItem.new(consumer_c, provider_z) }
 
-
         let(:relationship_5) { Domain::IndexItem.new(consumer_l, provider_p) }
         let(:relationship_6) { Domain::IndexItem.new(consumer_m, provider_p) }
 

data/spec/lib/pact_broker/tags/repository_spec.rb

@@ -117,7 +117,6 @@ module PactBroker
         end
       end
 
-
       describe "find_all_tag_names_for_pacticipant" do
         before do
           td.create_consumer("Foo")

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

@@ -1,5 +1,6 @@
 require 'pact_broker/verifications/service'
 require 'pact_broker/verifications/repository'
+require 'pact_broker/webhooks/execution_configuration'
 
 module PactBroker
 
@@ -16,10 +17,11 @@ module PactBroker
       describe "#create" do
         before do
           allow(PactBroker::Webhooks::Service).to receive(:trigger_webhooks)
+          allow(webhook_execution_configuration).to receive(:with_webhook_context).and_return(webhook_execution_configuration)
         end
 
-        let(:options) { { webhook_context: {} } }
-        let(:expected_options) { { webhook_context: { provider_version_tags: %w[dev] } } }
+        let(:options) { { webhook_execution_configuration: webhook_execution_configuration } }
+        let(:webhook_execution_configuration) { instance_double(PactBroker::Webhooks::ExecutionConfiguration) }
         let(:params) { {'success' => true, 'providerApplicationVersion' => '4.5.6'} }
         let(:pact) do
           td.create_pact_with_hierarchy
@@ -52,13 +54,18 @@ module PactBroker
           expect(verification.provider_version_number).to eq '4.5.6'
         end
 
+        it "sets the provider version tags on the webhook execution configuration" do
+          expect(webhook_execution_configuration).to receive(:with_webhook_context).with(provider_version_tags: %w[dev])
+          create_verification
+        end
+
         it "invokes the webhooks for the verification" do
           verification = create_verification
           expect(PactBroker::Webhooks::Service).to have_received(:trigger_webhooks).with(
             pact,
             verification,
             PactBroker::Webhooks::WebhookEvent::VERIFICATION_PUBLISHED,
-            expected_options
+            options
           )
         end
       end

data/spec/lib/pact_broker/versions/repository_spec.rb

@@ -9,7 +9,6 @@ module PactBroker
       let(:pacticipant_name) { "test_pacticipant" }
       let(:version_number) { "1.2.3" }
 
-
       describe "#find_by_pacticipant_name_and_latest_tag" do
         before do
           td.create_consumer("Bar")

data/spec/lib/pact_broker/webhooks/execution_configuration_spec.rb

@@ -0,0 +1,18 @@
+require 'pact_broker/webhooks/execution_configuration'
+
+module PactBroker
+  module Webhooks
+    describe ExecutionConfiguration do
+      subject { ExecutionConfiguration.new }
+
+      it "returns a new object with the updated value" do
+        expect(subject.with_show_response(true)[:logging_options][:show_response]).to eq true
+        expect(subject.with_show_response(false)[:logging_options][:show_response]).to eq false
+      end
+
+      it "deep merges webhook context" do
+        expect(subject.with_webhook_context(a: 1, b: 1).with_webhook_context(b: 2)[:webhook_context]).to eq a: 1, b: 2
+      end
+    end
+  end
+end