pact_broker 2.22.0 → 2.23.0

data/lib/pact_broker/verifications/repository.rb

@@ -37,6 +37,15 @@ module PactBroker
           .verification_number(verification_number).single_record
       end
 
+      def search_for_latest consumer_name, provider_name
+        query = LatestVerificationsByConsumerVersion
+                  .select_all_qualified
+                  .join(:all_pact_publications, pact_version_id: :pact_version_id)
+        query = query.consumer(consumer_name) if consumer_name
+        query = query.provider(provider_name) if provider_name
+        query.reverse(:execution_date, :id).first
+      end
+
       def find_latest_verifications_for_consumer_version consumer_name, consumer_version_number
         # Use LatestPactPublicationsByConsumerVersion not AllPactPublcations because we don't
         # want verifications for shadowed revisions as it would be misleading.

data/lib/pact_broker/verifications/service.rb

@@ -23,7 +23,7 @@ module PactBroker
         PactBroker::Api::Decorators::VerificationDecorator.new(verification).from_hash(params)
         verification.number = next_verification_number
         verification = verification_repository.create(verification, provider_version_number, pact)
-        webhook_service.execute_webhooks pact, verification, PactBroker::Webhooks::WebhookEvent::VERIFICATION_PUBLISHED
+        webhook_service.trigger_webhooks pact, verification, PactBroker::Webhooks::WebhookEvent::VERIFICATION_PUBLISHED
         verification
       end
 
@@ -53,6 +53,10 @@ module PactBroker
         verification_repository.find_latest_verification_for_tags(consumer_name, provider_name, consumer_version_tag_name, provider_version_tag_name)
       end
 
+      def search_for_latest consumer_name, provider_name
+        verification_repository.search_for_latest(consumer_name, provider_name)
+      end
+
       def verification_summary_for_consumer_version params
         verifications = find_latest_verifications_for_consumer_version(params)
         pacts = pact_service.find_by_consumer_version(params)

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.22.0'
+  VERSION = '2.23.0'
 end

data/lib/pact_broker/webhooks/repository.rb

@@ -59,14 +59,44 @@ module PactBroker
         Webhook.all.collect(&:to_domain)
       end
 
+      def find_for_pact pact
+        find_by_consumer_and_or_provider(pact.consumer, pact.provider)
+      end
+
+      def find_by_consumer_and_or_provider consumer, provider
+        find_by_consumer_and_provider(consumer, provider) +
+          find_by_consumer_and_provider(nil, provider) +
+          find_by_consumer_and_provider(consumer, nil) +
+          find_by_consumer_and_provider(nil, nil)
+      end
+
       def find_by_consumer_and_provider consumer, provider
-        Webhook.where(consumer_id: consumer.id, provider_id: provider.id).collect(&:to_domain)
+        criteria = {
+          consumer_id: (consumer ? consumer.id : nil),
+          provider_id: (provider ? provider.id : nil)
+        }
+        Webhook.where(criteria).collect(&:to_domain)
+      end
+
+      def find_for_pact_and_event_name pact, event_name
+        find_by_consumer_and_or_provider_and_event_name(pact.consumer, pact.provider, event_name)
+      end
+
+      def find_by_consumer_and_or_provider_and_event_name consumer, provider, event_name
+        find_by_consumer_and_provider_and_event_name(consumer, provider, event_name) +
+          find_by_consumer_and_provider_and_event_name(nil, provider, event_name) +
+          find_by_consumer_and_provider_and_event_name(consumer, nil, event_name) +
+          find_by_consumer_and_provider_and_event_name(nil, nil, event_name)
       end
 
       def find_by_consumer_and_provider_and_event_name consumer, provider, event_name
+        criteria = {
+          consumer_id: (consumer ? consumer.id : nil),
+          provider_id: (provider ? provider.id : nil)
+        }
         Webhook
           .select_all_qualified
-          .where(consumer_id: consumer.id, provider_id: provider.id)
+          .where(criteria)
           .join(:webhook_events, { webhook_id: :id })
           .where(Sequel[:webhook_events][:name] => event_name)
           .collect(&:to_domain)
@@ -88,8 +118,8 @@ module PactBroker
           webhook_uuid: db_webhook.uuid,
           trigger_uuid: trigger_uuid,
           trigger_type: trigger_type,
-          consumer: db_webhook.consumer,
-          provider: db_webhook.provider
+          consumer: pact.consumer,
+          provider: pact.provider
         )
       end
 
@@ -136,6 +166,10 @@ module PactBroker
         DeprecatedExecution.where(pact_publication_id: pact_publication_ids).delete
       end
 
+      def find_latest_triggered_webhooks_for_pact pact
+        find_latest_triggered_webhooks(pact.consumer, pact.provider)
+      end
+
       def find_latest_triggered_webhooks consumer, provider
         LatestTriggeredWebhook
           .where(consumer: consumer, provider: provider)
@@ -143,6 +177,22 @@ module PactBroker
           .all
       end
 
+      def find_triggered_webhooks_for_pact pact
+        PactBroker::Webhooks::TriggeredWebhook
+          .where(pact_publication_id: pact.pact_publication_id)
+          .eager(:webhook)
+          .eager(:webhook_executions)
+          .reverse(:created_at, :id)
+      end
+
+      def find_triggered_webhooks_for_verification verification
+        PactBroker::Webhooks::TriggeredWebhook
+          .where(verification_id: verification.id)
+          .eager(:webhook)
+          .eager(:webhook_executions)
+          .reverse(:created_at, :id)
+      end
+
       def fail_retrying_triggered_webhooks
         TriggeredWebhook.retrying.update(status: TriggeredWebhook::STATUS_FAILURE)
       end

data/lib/pact_broker/webhooks/service.rb

@@ -1,4 +1,5 @@
 require 'pact_broker/repositories'
+require 'pact_broker/services'
 require 'pact_broker/logging'
 require 'base64'
 require 'securerandom'
@@ -6,6 +7,8 @@ require 'pact_broker/webhooks/job'
 require 'pact_broker/webhooks/triggered_webhook'
 require 'pact_broker/webhooks/status'
 require 'pact_broker/webhooks/webhook_event'
+require 'pact_broker/verifications/placeholder_verification'
+require 'pact_broker/pacts/placeholder_pact'
 
 module PactBroker
 
@@ -16,6 +19,7 @@ module PactBroker
       USER = PactBroker::Webhooks::TriggeredWebhook::TRIGGER_TYPE_USER
 
       extend Repositories
+      extend Services
       include Logging
 
       def self.next_uuid
@@ -59,6 +63,17 @@ module PactBroker
         webhook_repository.find_all
       end
 
+      def self.test_execution webhook
+        options = { failure_log_message: "Webhook execution failed", show_response: PactBroker.configuration.show_webhook_response?}
+        verification = nil
+        if webhook.trigger_on_provider_verification_published?
+          verification = verification_service.search_for_latest(webhook.consumer_name, webhook.provider_name) || PactBroker::Verifications::PlaceholderVerification.new
+        end
+
+        pact = pact_service.search_for_latest_pact(consumer_name: webhook.consumer_name, provider_name: webhook.provider_name) || PactBroker::Pacts::PlaceholderPact.new
+        webhook.execute(pact, verification, options)
+      end
+
       def self.execute_webhook_now webhook, pact, verification = nil
         triggered_webhook = webhook_repository.create_triggered_webhook(next_uuid, webhook, pact, verification, USER)
         options = { failure_log_message: "Webhook execution failed"}
@@ -81,12 +96,20 @@ module PactBroker
         webhook_repository.update_triggered_webhook_status triggered_webhook, status
       end
 
+      def self.find_for_pact pact
+        webhook_repository.find_for_pact(pact)
+      end
+
+      def self.find_by_consumer_and_or_provider consumer, provider
+        webhook_repository.find_by_consumer_and_or_provider(consumer, provider)
+      end
+
       def self.find_by_consumer_and_provider consumer, provider
         webhook_repository.find_by_consumer_and_provider consumer, provider
       end
 
-      def self.execute_webhooks pact, verification, event_name
-        webhooks = webhook_repository.find_by_consumer_and_provider_and_event_name pact.consumer, pact.provider, event_name
+      def self.trigger_webhooks pact, verification, event_name
+        webhooks = webhook_repository.find_by_consumer_and_or_provider_and_event_name pact.consumer, pact.provider, event_name
 
         if webhooks.any?
           run_later(webhooks, pact, verification, event_name)
@@ -109,6 +132,10 @@ module PactBroker
         end
       end
 
+      def self.find_latest_triggered_webhooks_for_pact pact
+        webhook_repository.find_latest_triggered_webhooks_for_pact pact
+      end
+
       def self.find_latest_triggered_webhooks consumer, provider
         webhook_repository.find_latest_triggered_webhooks consumer, provider
       end
@@ -116,6 +143,14 @@ module PactBroker
       def self.fail_retrying_triggered_webhooks
         webhook_repository.fail_retrying_triggered_webhooks
       end
+
+      def self.find_triggered_webhooks_for_pact pact
+        webhook_repository.find_triggered_webhooks_for_pact(pact)
+      end
+
+      def self.find_triggered_webhooks_for_verification verification
+        webhook_repository.find_triggered_webhooks_for_verification(verification)
+      end
     end
   end
 end

data/lib/pact_broker/webhooks/webhook.rb

@@ -1,5 +1,6 @@
 require 'sequel'
 require 'pact_broker/domain/webhook'
+require 'pact_broker/webhooks/webhook_request_template'
 require 'pact_broker/domain/pacticipant'
 
 module PactBroker
@@ -28,8 +29,8 @@ module PactBroker
         new(
           properties_hash_from_domain(webhook).merge(uuid: webhook.uuid)
         ).tap do | db_webhook |
-          db_webhook.consumer_id = consumer.id
-          db_webhook.provider_id = provider.id
+          db_webhook.consumer_id = consumer.id if consumer
+          db_webhook.provider_id = provider.id if provider
         end
       end
 
@@ -43,7 +44,7 @@ module PactBroker
           consumer: consumer,
           provider: provider,
           events: events,
-          request: Domain::WebhookRequest.new(request_attributes),
+          request: Webhooks::WebhookRequestTemplate.new(request_attributes),
           created_at: created_at,
           updated_at: updated_at)
       end

data/lib/pact_broker/webhooks/webhook_event.rb

@@ -17,6 +17,14 @@ module PactBroker
         include PactBroker::Repositories::Helpers
       end
 
+      def contract_content_changed?
+        name == CONTRACT_CONTENT_CHANGED
+      end
+
+      def provider_verification_published?
+        name == VERIFICATION_PUBLISHED
+      end
+
     end
 
     WebhookEvent.plugin :timestamps, update_on_create: true

data/lib/pact_broker/webhooks/webhook_request_template.rb

@@ -0,0 +1,72 @@
+require 'pact_broker/domain/webhook_request_header'
+require 'pact_broker/webhooks/render'
+require 'cgi'
+require 'pact_broker/domain/webhook_request'
+
+module PactBroker
+  module Webhooks
+    class WebhookRequestTemplate
+
+      include PactBroker::Logging
+      include PactBroker::Messages
+      HEADERS_TO_REDACT = [/authorization/i, /token/i]
+
+      attr_accessor :method, :url, :headers, :body, :username, :password, :uuid
+
+      # Reform gets confused by the :method method, as :method is a standard
+      # Ruby method.
+      alias_method :http_method, :method
+
+      def initialize attributes = {}
+        @method = attributes[:method]
+        @url = attributes[:url]
+        @username = attributes[:username]
+        @password = attributes[:password]
+        @headers = attributes[:headers] || {}
+        @body = attributes[:body]
+        @uuid = attributes[:uuid]
+      end
+
+      def build(context)
+        attributes = {
+          method: http_method,
+          url: build_url(context[:pact], context[:verification]),
+          username: username,
+          password: password,
+          uuid: uuid,
+          body: build_body(context[:pact], context[:verification])
+        }
+        PactBroker::Domain::WebhookRequest.new(attributes)
+      end
+
+      def build_url(pact, verification)
+        URI(PactBroker::Webhooks::Render.call(url, pact, verification){ | value | CGI::escape(value) if !value.nil? } ).to_s
+      end
+
+      def build_body(pact, verification)
+        PactBroker::Webhooks::Render.call(String === body ? body : body.to_json, pact, verification)
+      end
+
+      def description
+        "#{http_method.upcase} #{URI(url.gsub(PactBroker::Webhooks::Render::TEMPLATE_PARAMETER_REGEXP, 'placeholder')).host}"
+      end
+
+      def display_password
+        password.nil? ? nil : "**********"
+      end
+
+      def redacted_headers
+        headers.each_with_object({}) do | (name, value), new_headers |
+          redact = HEADERS_TO_REDACT.any?{ | pattern | name =~ pattern }
+          new_headers[name] = redact ? "**********" : value
+        end
+      end
+
+      private
+
+      def to_s
+        "#{method.upcase} #{url}, username=#{username}, password=#{display_password}, headers=#{redacted_headers}, body=#{body}"
+      end
+    end
+  end
+end

data/pact_broker.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'redcarpet', '>=3.3.2', '~>3.3'
   gem.add_runtime_dependency 'pact-support'
   gem.add_runtime_dependency 'padrino-core', '>= 0.14.3', '~> 0.14'
-  gem.add_runtime_dependency 'sinatra', '>= 2.0.1'
+  gem.add_runtime_dependency 'sinatra', '>= 2.0.2'
   gem.add_runtime_dependency 'haml', '~>5.0'
   gem.add_runtime_dependency 'sucker_punch', '~>2.0'
   gem.add_runtime_dependency 'rack-protection', '~>2.0'

data/script/seed.rb

@@ -8,86 +8,82 @@ $LOAD_PATH.unshift './tasks'
 ENV['RACK_ENV'] = 'development'
 require 'sequel'
 require 'logger'
-DATABASE_CREDENTIALS = {logger: Logger.new($stdout), adapter: "sqlite", database: ARGV[0], :encoding => 'utf8'}
+DATABASE_CREDENTIALS = {logger: Logger.new($stdout), adapter: "sqlite", database: ARGV[0], :encoding => 'utf8'}.tap { |it| puts it }
 #DATABASE_CREDENTIALS = {adapter: "postgres", database: "pact_broker", username: 'pact_broker', password: 'pact_broker', :encoding => 'utf8'}
 
 connection = Sequel.connect(DATABASE_CREDENTIALS)
 connection.timezone = :utc
+# Uncomment these lines to open a pry session for inspecting the database
+# require 'table_print'
+# require 'pry'; pry(binding);
+# exit
+
 require 'pact_broker/db'
 PactBroker::DB.connection = connection
 require 'pact_broker'
 require 'support/test_data_builder'
 
-# Uncomment these lines to open a pry session for inspecting the database
-# require 'table_print'
-# require 'pry'; pry(binding);
-# exit
 
 require 'database/table_dependency_calculator'
 PactBroker::Database::TableDependencyCalculator.call(connection).each do | table_name |
   connection[table_name].delete
 end
 
-class TestDataBuilder
-  def method_missing *args
-      self
-  end
-
-  def publish_pact params = {}
-    create_pact params
-  end
-end
-
-# latest verifications
-# TestDataBuilder.new
-#   .create_consumer("Foo")
-#   .create_provider("Bar")
-#   .create_consumer_version("1.2.3")
-#   .create_pact
-#   .create_verification(provider_version: "4.5.6", success: true)
-#   .create_provider("Wiffle")
-#   .create_pact
-#   .create_verification(provider_version: "5.6.7", success: false)
-#   .create_provider("Meep")
-#   .create_pact
+  # .create_webhook(method: 'GET', url: 'https://localhost:9393?url=${pactbroker.pactUrl}', body: '${pactbroker.pactUrl}')
 
+webhook_body = {
+  'pactUrl' => '${pactbroker.pactUrl}',
+  'verificationResultUrl' => '${pactbroker.verificationResultUrl}',
+  'consumerVersionNumber' => '${pactbroker.consumerVersionNumber}',
+  'providerVersionNumber' => '${pactbroker.providerVersionNumber}',
+  'providerVersionTags' => '${pactbroker.providerVersionTags}',
+  'consumerVersionTags' => '${pactbroker.consumerVersionTags}',
+  'consumerName' => '${pactbroker.consumerName}',
+  'providerName' => '${pactbroker.providerName}',
+  'githubVerificationStatus' => '${pactbroker.githubVerificationStatus}'
+}
 
-  # .create_webhook(method: 'GET', url: 'https://localhost:9393?url=${pactbroker.pactUrl}', body: '${pactbroker.pactUrl}')
 TestDataBuilder.new
+  .create_global_webhook(method: 'GET', url: "http://example.org?consumer=${pactbroker.consumerName}&provider=${pactbroker.providerName}")
   .create_certificate(path: 'spec/fixtures/certificates/self-signed.badssl.com.pem')
+  .create_consumer("Bethtest")
+  .create_verification_webhook(method: 'POST', url: "http://localhost:9292", body: webhook_body, username: "foo", password: "bar")
   .create_consumer("Foo")
   .create_label("microservice")
   .create_provider("Bar")
   .create_label("microservice")
+  .create_verification_webhook(method: 'GET', url: "http://example.org")
+  .create_consumer_webhook(method: 'GET', url: 'https://www.google.com.au', event_names: ['provider_verification_published'])
+  .create_provider_webhook(method: 'GET', url: 'https://theage.com.au')
   .create_webhook(method: 'GET', url: 'https://self-signed.badssl.com')
   .create_consumer_version("1.2.100")
-  .publish_pact
+  .create_pact
   .create_verification(provider_version: "1.4.234", success: true, execution_date: DateTime.now - 15)
   .revise_pact
   .create_consumer_version("1.2.101")
   .create_consumer_version_tag('prod')
-  .publish_pact
+  .create_pact
   .create_verification(provider_version: "9.9.10", success: false, execution_date: DateTime.now - 15)
   .create_consumer_version("1.2.102")
-  .publish_pact(created_at: (Date.today - 7).to_datetime)
+  .create_pact(created_at: (Date.today - 7).to_datetime)
   .create_verification(provider_version: "9.9.9", success: true, execution_date: DateTime.now - 14)
   .create_provider("Animals")
   .create_webhook(method: 'GET', url: 'http://localhost:9393/')
-  .publish_pact(created_at: (Time.now - 140).to_datetime)
+  .create_pact(created_at: (Time.now - 140).to_datetime)
   .create_verification(provider_version: "2.0.366", execution_date: Date.today - 2) #changed
   .create_provider("Wiffles")
-  .publish_pact
+  .create_pact
   .create_verification(provider_version: "3.6.100", success: false, execution_date: Date.today - 7)
   .create_provider("Hello World App")
   .create_consumer_version("1.2.107")
-  .publish_pact(created_at: (Date.today - 1).to_datetime)
+  .create_pact(created_at: (Date.today - 1).to_datetime)
   .create_consumer("The Android App")
   .create_provider("The back end")
   .create_webhook(method: 'GET', url: 'http://localhost:9393/')
   .create_consumer_version("1.2.106")
   .create_consumer_version_tag("production")
   .create_consumer_version_tag("feat-x")
-  .publish_pact
+  .create_pact
   .create_consumer("Some other app")
   .create_provider("A service")
   .create_webhook(method: 'GET', url: 'http://localhost:9393/')
@@ -97,20 +93,5 @@ TestDataBuilder.new
   .create_triggered_webhook(status: 'failure')
   .create_webhook_execution
   .create_consumer_version("1.2.106")
-  .publish_pact(created_at: (Date.today - 26).to_datetime)
+  .create_pact(created_at: (Date.today - 26).to_datetime)
   .create_verification(provider_version: "4.8.152", execution_date: DateTime.now)
-
-# TestDataBuilder.new
-#   .create_pact_with_hierarchy("A", "1", "B")
-#   .create_consumer_version_tag("master")
-#   .create_consumer_version_tag("prod")
-#   .create_verification(provider_version: "1")
-#   .create_consumer_version("2")
-#   .create_consumer_version_tag("master")
-#   .create_pact
-#   .create_verification(provider_version: "2")
-
-# TestDataBuilder.new
-#   .create_pact_with_hierarchy("Foo", "1", "Bar")
-#   .create_webhook(method: 'GET', url: 'http://localhost:9393', events: [{ name: 'provider_verification_published' }, {name: ''}])
-