pact_broker 2.59.1 → 2.62.0

data/lib/pact_broker/pacts/selector.rb

@@ -53,6 +53,14 @@ module PactBroker
         Selector.new(tag: tag, consumer: consumer)
       end
 
+      def self.latest_for_tag_and_consumer(tag, consumer)
+        Selector.new(latest: true, tag: tag, consumer: consumer)
+      end
+
+      def self.latest_for_consumer(consumer)
+        Selector.new(latest: true, consumer: consumer)
+      end
+
       def self.from_hash hash
         Selector.new(hash)
       end

data/lib/pact_broker/test/test_data_builder.rb

@@ -294,7 +294,7 @@ module PactBroker
         params.delete(:comment)
         trigger_uuid = params[:trigger_uuid] || webhook_service.next_uuid
         verification = @webhook.trigger_on_provider_verification_published? ? @verification : nil
-        @triggered_webhook = webhook_repository.create_triggered_webhook trigger_uuid, @webhook, @pact, verification, PactBroker::Webhooks::Service::RESOURCE_CREATION
+        @triggered_webhook = webhook_repository.create_triggered_webhook trigger_uuid, @webhook, @pact, verification, PactBroker::Webhooks::Service::RESOURCE_CREATION, @webhook.events.first.name
         @triggered_webhook.update(status: params[:status]) if params[:status]
         set_created_at_if_set params[:created_at], :triggered_webhooks, {id: @triggered_webhook.id}
         self

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.59.1'
+  VERSION = '2.62.0'
 end

data/lib/pact_broker/webhooks/job.rb

@@ -7,9 +7,10 @@ module PactBroker
   module Webhooks
     class Job
 
+      INFO_ERROR_PREFIXES = %w{Errno:: Timeout:: Net:: OpenSSL:: EOFError SocketError}
+
       include SuckerPunch::Job
       include PactBroker::Logging
-      include PactBroker::Logging
 
       def perform data
         data.fetch(:database_connector).call do
@@ -62,7 +63,12 @@ module PactBroker
       end
 
       def handle_error e
-        log_error e, "Error executing triggered webhook with ID #{triggered_webhook ? triggered_webhook.id : nil}"
+        message = "Error executing triggered webhook with ID #{triggered_webhook ? triggered_webhook.id : nil}"
+        if e.class.name.start_with?(*INFO_ERROR_PREFIXES)
+          logger.info(message, e)
+        else
+          logger.warn(message, e)
+        end
         handle_failure
       end
 

data/lib/pact_broker/webhooks/repository.rb

@@ -101,7 +101,7 @@ module PactBroker
           .collect(&:to_domain)
       end
 
-      def create_triggered_webhook trigger_uuid, webhook, pact, verification, trigger_type
+      def create_triggered_webhook trigger_uuid, webhook, pact, verification, trigger_type, event_name
         db_webhook = Webhook.where(uuid: webhook.uuid).single_record
         TriggeredWebhook.create(
           status: TriggeredWebhook::STATUS_NOT_RUN,
@@ -112,7 +112,8 @@ module PactBroker
           trigger_uuid: trigger_uuid,
           trigger_type: trigger_type,
           consumer: pact.consumer,
-          provider: pact.provider
+          provider: pact.provider,
+          event_name: event_name
         )
       end
 

data/lib/pact_broker/webhooks/service.rb

@@ -136,14 +136,14 @@ module PactBroker
         trigger_uuid = next_uuid
         webhooks.each do | webhook |
           begin
-            triggered_webhook = webhook_repository.create_triggered_webhook(trigger_uuid, webhook, pact, verification, RESOURCE_CREATION)
+            triggered_webhook = webhook_repository.create_triggered_webhook(trigger_uuid, webhook, pact, verification, RESOURCE_CREATION, event_name)
             logger.info "Scheduling job for webhook with uuid #{webhook.uuid}"
             logger.debug "Schedule webhook with options #{options}"
             job_data = { triggered_webhook: triggered_webhook }.deep_merge(options)
             # Delay slightly to make sure the request transaction has finished before we execute the webhook
             Job.perform_in(5, job_data)
           rescue StandardError => e
-            log_error e
+            logger.warn("Error scheduling webhook execution for webhook with uuid #{webhook.uuid}", e)
           end
         end
       end

data/lib/pact_broker/webhooks/triggered_webhook.rb

@@ -8,6 +8,7 @@ require 'pact_broker/webhooks/execution'
 module PactBroker
   module Webhooks
     class TriggeredWebhook < Sequel::Model(:triggered_webhooks)
+      plugin :timestamps, update_on_create: true
 
       TRIGGER_TYPE_RESOURCE_CREATION = 'resource_creation'
       TRIGGER_TYPE_USER = 'user'
@@ -95,9 +96,6 @@ module PactBroker
         end
       end
     end
-
-    TriggeredWebhook.plugin :timestamps, update_on_create: true
-
   end
 end
 

data/lib/pact_broker/webhooks/webhook_event.rb

@@ -4,6 +4,7 @@ require 'pact_broker/repositories/helpers'
 module PactBroker
   module Webhooks
     class WebhookEvent < Sequel::Model
+      plugin :timestamps, update_on_create: true
 
       CONTRACT_PUBLISHED = 'contract_published'
       CONTRACT_CONTENT_CHANGED = 'contract_content_changed'
@@ -38,8 +39,6 @@ module PactBroker
         name == VERIFICATION_FAILED
       end
     end
-
-    WebhookEvent.plugin :timestamps, update_on_create: true
   end
 end
 

data/script/seed.rb

@@ -46,24 +46,46 @@ webhook_body = {
 
 PactBroker.configuration.base_equality_only_on_content_that_affects_verification_results = false
 
-  # .create_global_webhook(
-  #   method: 'POST',
-  #   url: "http://localhost:9292/pact-changed-webhook",
-  #   body: webhook_body.to_json,
-  #   username: "foo",
-  #   password: "bar")
-TestDataBuilder.new
-  .create_global_verification_succeeded_webhook(
-    method: 'POST',
-    url: "http://localhost:9292/verification-published-webhook",
-    body: webhook_body.to_json)
-  .set_now(Date.today - 101)
-  .create_pact_with_hierarchy("Foo/Foo", "100", "Bar/Bar")
-  .create_pact_with_hierarchy("Foo", "1", "Bar")
-  .create_pact_with_hierarchy("<script>alert('hello')</script>", "<script>alert(\"version\")</script>", "Bar/Bar")
-  .create_consumer_version_tag("prod")
-  .create_verification(provider_version: "1", tag_names: "prod")
+json_content = <<-HEREDOC
+{
+  "consumer": {
+    "name": "Foo"
+  },
+  "provider": {
+    "name": "Bar"
+  },
+  "interactions": [
+    {
+      "description": "a retrieve thing request",
+      "request": {
+        "method": "get",
+        "path": "/thing"
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/json"
+        },
+        "body": {
+          "name": "Thing 1"
+        }
+      }
+    }
+  ],
+  "metadata": {
+    "pactSpecification": {
+      "version": "2.0.0"
+    }
+  }
+}
+HEREDOC
 
+TestDataBuilder.new
+  .create_pact_with_hierarchy("Foo", "1", "Bar", json_content)
+  .create_consumer_version_tag("master")
+  .create_verification(provider_version: "1", tag_name: "master")
+  .create_pact_with_hierarchy("Foo", "2", "Bar", json_content.gsub("200", "201"))
+  .create_consumer_version_tag("feat/x")
 
   # .create_certificate(path: 'spec/fixtures/certificates/self-signed.badssl.com.pem')
   # .create_consumer("Bethtest")

data/spec/features/get_provider_pacts_for_verification_spec.rb

@@ -33,6 +33,10 @@ describe "Get provider pacts for verification" do
         expect(pacts.size).to eq 1
       end
 
+      it "returns a deprecation notice" do
+        expect(last_response_body[:_embedded][:pacts].first[:verificationProperties][:notices].first[:text]).to start_with("WARNING")
+      end
+
       context "when the provider does not exist" do
         let(:path) { "/pacts/provider/ProviderThatDoesNotExist/for-verification" }
 
@@ -62,6 +66,10 @@ describe "Get provider pacts for verification" do
         expect(pacts.size).to eq 1
       end
 
+      it "does not include a deprecation notice" do
+        expect(last_response_body[:_embedded][:pacts].first[:verificationProperties][:notices].first[:text]).to_not start_with("WARNING")
+      end
+
       context "when the provider does not exist" do
         let(:path) { "/pacts/provider/ProviderThatDoesNotExist/for-verification" }
 

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

@@ -71,6 +71,27 @@ module PactBroker
           end
         end
 
+        context "when the latest version for a particular consumer is requested" do
+          let(:consumer_version_selectors) do
+            [{
+              consumer: "Foo",
+              latest: true
+            }]
+          end
+
+          it { is_expected.to be_empty }
+        end
+
+        context "when the latest version for all is requested" do
+          let(:consumer_version_selectors) do
+            [{
+              latest: true
+            }]
+          end
+
+          it { is_expected.to be_empty }
+        end
+
         context "when providerVersionTags is not an array" do
           let(:provider_version_tags) { true }
 
@@ -89,7 +110,7 @@ module PactBroker
           end
 
           it "flattens the messages" do
-            expect(subject[:consumerVersionSelectors].first).to eq "tag is missing at index 0"
+            expect(subject[:consumerVersionSelectors].first).to eq "latest must be true, or a tag must be provided (at index 0)"
           end
         end
 
@@ -150,9 +171,7 @@ module PactBroker
             }]
           end
 
-          it "has an error" do
-            expect(subject[:consumerVersionSelectors].first).to include "not yet supported"
-          end
+          it { is_expected.to be_empty }
         end
       end
     end

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

@@ -22,7 +22,8 @@ module PactBroker
             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),
+            event_name: 'some_event'
           )
         end
 

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

@@ -7,6 +7,7 @@ module PactBroker
         let(:triggered_webhook) do
           double('PactBroker::Webhooks::TriggeredWebhook',
             trigger_type: PactBroker::Webhooks::TriggeredWebhook::TRIGGER_TYPE_RESOURCE_CREATION,
+            event_name: 'some_event',
             status: status,
             failure?: failure,
             retrying?: retrying,
@@ -55,7 +56,8 @@ module PactBroker
             status: 'success',
             triggerType: 'resource_creation',
             attemptsMade: 1,
-            attemptsRemaining: 2
+            attemptsRemaining: 2,
+            eventName: 'some_event'
           )
         end
       end

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

@@ -3,6 +3,10 @@ require 'pact_broker/api/pact_broker_urls'
 module PactBroker
   module Api
     describe PactBrokerUrls do
+      before do
+        allow(PactBrokerUrls).to receive(:logger).and_return(logger)
+      end
+      let(:logger) { double('logger').as_null_object }
 
       # Regex find all the URL parameter names
       # \/\{[^\}\s\[\(\.]+\}
@@ -117,6 +121,17 @@ module PactBroker
             expect(PactBrokerUrls.decode_webhook_metadata(nil)).to eq({})
           end
         end
+
+        context "when the metadata is not valid base64" do
+          it "returns an empty hash" do
+            expect(PactBrokerUrls.decode_webhook_metadata("foo==,")).to eq({})
+          end
+
+          it "logs a warning" do
+            expect(logger).to receive(:warn).with("Exception parsing webhook metadata: foo==,", ArgumentError)
+            PactBrokerUrls.decode_webhook_metadata("foo==,")
+          end
+        end
       end
 
       describe "latest_verification_for_pact_url" do

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

@@ -133,23 +133,28 @@ module PactBroker
         .select { |klass| klass < DefaultBaseResource }
         .select { |klass| !klass.name.end_with?("BaseResource") }
 
-      ALL_RESOURCES.each do | resource |
-        describe resource do
+      ALL_RESOURCES.each do | resource_class |
+        describe resource_class do
           let(:request) { double('request', uri: URI("http://example.org")).as_null_object }
           let(:response) { double('response') }
+          let(:resource) { resource_class.new(request, response) }
 
           it "includes OPTIONS in the list of allowed_methods" do
-            expect(resource.new(request, response).allowed_methods).to include "OPTIONS"
+            expect(resource.allowed_methods).to include "OPTIONS"
           end
 
           it "calls super in its constructor" do
             expect(PactBroker.configuration.before_resource).to receive(:call)
-            resource.new(request, response)
+            resource
           end
 
           it "calls super in finish_request" do
             expect(PactBroker.configuration.after_resource).to receive(:call)
-            resource.new(request, response).finish_request
+            resource.finish_request
+          end
+
+          it "has a policy_name method" do
+            expect(resource).to respond_to(:policy_name)
           end
         end
       end

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

@@ -5,7 +5,6 @@ module PactBroker
     module Resources
       describe ErrorHandler do
         describe "call" do
-
           before do
             allow(ErrorHandler).to receive(:logger).and_return(logger)
             allow(SecureRandom).to receive(:urlsafe_base64).and_return("bYWfn-+yWPlf")
@@ -45,6 +44,24 @@ module PactBroker
             subject
           end
 
+          context "when the error class is in the warning_error_classes list" do
+            let(:error) { Sequel::ForeignKeyConstraintViolation.new }
+
+            it "logs at warn so as not to wake everyone up in the middle of the night" do
+              expect(logger).to receive(:warn).with(/bYWfnyWPlf/, error)
+              subject
+            end
+          end
+
+          context "when the error is not reportable and not a warning level" do
+            let(:error) { PactBroker::Error.new('foo') }
+
+            it "logs at info" do
+              expect(logger).to receive(:info).with(/bYWfnyWPlf/, error)
+              subject
+            end
+          end
+
           context "when show_backtrace_in_error_response? is true" do
             before do
               allow(PactBroker.configuration).to receive(:show_backtrace_in_error_response?).and_return(true)

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

@@ -11,7 +11,7 @@ module PactBroker
         end
 
         let(:provider) { double('provider') }
-        let(:pacts) { double('pacts') }
+        let(:pacts) { [] }
         let(:path) { '/pacts/provider/Bar/for-verification' }
         let(:decorator) { instance_double('PactBroker::Api::Decorators::VerifiablePactsDecorator') }
         let(:query) do

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

@@ -34,7 +34,6 @@ module PactBroker
           end
 
           context "when the verification exists" do
-
             it "finds the triggered webhooks for the verification" do
               expect(webhook_service).to receive(:find_triggered_webhooks_for_verification)
               subject

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

@@ -286,7 +286,7 @@ module PactBroker
           end
 
           it "logs the error" do
-            expect(logger).to receive(:error).with(/Error retrieving badge from.*shield.*an error/)
+            expect(logger).to receive(:warn).with(/Error retrieving badge from.*shield.*/, RuntimeError)
             subject
           end
 

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

@@ -30,8 +30,8 @@ module PactBroker
           it "logs the error" do
             subject
 
-            expect(logger).to have_received(:error)
-              .with(/Error adding certificate/).at_least(1).times
+            expect(logger).to have_received(:warn)
+              .with(/Error adding certificate/, StandardError).at_least(1).times
           end
 
           it "returns an OpenSSL::X509::Store" do
@@ -66,7 +66,7 @@ module PactBroker
           let(:certificate_content) { File.read('spec/fixtures/certificate-invalid.pem') }
 
           it "logs an error" do
-            expect(logger).to receive(:error).with(/Error.*1234/)
+            expect(logger).to receive(:warn).with(/Error.*1234/, StandardError)
             subject
           end
 

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

@@ -308,6 +308,14 @@ module PactBroker
           expect(subject.interactions_missing_test_results.count).to eq 1
         end
 
+        context "with no interactions" do
+          let(:pact_content) { {} }
+
+          it "does not blow up" do
+            expect(subject.interactions_missing_test_results.count).to eq 0
+          end
+        end
+
         context "with nil test results" do
           let(:test_results) { nil }
 
@@ -351,6 +359,88 @@ module PactBroker
             expect(subject.to_hash).to eq merged_with_empty_tests
           end
         end
+
+        context "with the new format" do
+          let(:test_results) do
+            [
+              {
+                "interactionId" => "1",
+                "success "=> false
+              },{
+                "foo" => "bar"
+              }
+            ]
+          end
+
+          let(:pact_content) do
+            {
+              "interactions" => [
+                {
+                 "_id" => "1"
+                },
+                {
+                 "_id" => "2"
+                }
+              ]
+            }
+          end
+
+          let(:merged) do
+            {
+              "interactions" => [
+                {
+                 "_id" => "1",
+                 "tests" => [{
+                    "interactionId" => "1",
+                    "success "=> false
+                  }]
+                },{
+                 "_id" => "2",
+                 "tests" => []
+                }
+              ]
+            }
+          end
+
+          it "merges the tests into the pact content" do
+            expect(subject.to_hash).to eq merged
+          end
+        end
+      end
+
+      describe "interaction_ids" do
+        let(:interaction_1) do
+          {
+            _id: '1'
+          }
+        end
+
+        let(:interaction_2) do
+          {
+            _id: '2'
+          }
+        end
+
+        let(:interaction_3) do
+          {
+          }
+        end
+
+        let(:content_hash) do
+          {
+            interactions: [interaction_1, interaction_2, interaction_3]
+          }
+        end
+
+        subject { Content.from_json(content_hash.to_json) }
+
+        its(:interaction_ids) { is_expected.to eq ['1', '2'] }
+
+        context "when there are no interactions" do
+          let(:content_hash) { {} }
+
+          its(:interaction_ids) { is_expected.to eq [] }
+        end
       end
     end
   end