pact_broker 2.74.1 → 2.75.0

data/lib/pact_broker/api/resources/webhooks.rb

@@ -43,11 +43,11 @@ module PactBroker
 
         def from_json
           saved_webhook = webhook_service.create next_uuid, webhook, consumer, provider
-          response.body = Decorators::WebhookDecorator.new(saved_webhook).to_json(decorator_options)
+          response.body = decorator_class(:webhook_decorator).new(saved_webhook).to_json(decorator_options)
         end
 
         def to_json
-          Decorators::WebhooksDecorator.new(webhooks).to_json(decorator_options(resource_title: 'Pact webhooks'))
+          decorator_class(:webhooks_decorator).new(webhooks).to_json(decorator_options(resource_title: 'Pact webhooks'))
         end
 
         def policy_name
@@ -61,7 +61,7 @@ module PactBroker
         end
 
         def webhook
-          @webhook ||= Decorators::WebhookDecorator.new(PactBroker::Domain::Webhook.new).from_json(request_body)
+          @webhook ||= decorator_class(:webhook_decorator).new(PactBroker::Domain::Webhook.new).from_json(request_body)
         end
 
         def next_uuid

data/lib/pact_broker/app.rb

@@ -32,6 +32,8 @@ module PactBroker
       @cascade_apps = []
       @make_it_later_api_auth = ::Rack::PactBroker::ConfigurableMakeItLater.new(Rack::PactBroker::NoAuth)
       @make_it_later_ui_auth = ::Rack::PactBroker::ConfigurableMakeItLater.new(Rack::PactBroker::NoAuth)
+      # Can only be required after database connection has been made because the decorators rely on the Sequel models
+      @create_pact_broker_api_block = ->() { require 'pact_broker/api'; PactBroker::API }
       @configuration = PactBroker.configuration
       yield configuration
       post_configure
@@ -68,13 +70,17 @@ module PactBroker
       @custom_api = custom_api
     end
 
+    def use_to_create_pact_broker_api &block
+      @create_pact_broker_api_block = block
+    end
+
     def call env
       running_app.call env
     end
 
     private
 
-    attr_reader :custom_ui
+    attr_reader :custom_ui, :create_pact_broker_api_block
 
     def post_configure
       configure_logger
@@ -207,8 +213,7 @@ module PactBroker
 
     def build_api
       logger.info "Mounting PactBroker::API"
-      require 'pact_broker/api'
-      api_apps = [PactBroker::API]
+      api_apps = [create_pact_broker_api_block.call]
       api_apps.unshift(@custom_api) if @custom_api
       builder = ::Rack::Builder.new
       builder.use @make_it_later_api_auth

data/lib/pact_broker/application_context.rb

@@ -0,0 +1,41 @@
+require 'pact_broker/api/decorators/configuration'
+require 'pact_broker/api/decorators/decorator_context_creator'
+require 'pact_broker/webhooks/execution_configuration_creator'
+require 'pact_broker/errors/error_logger'
+require 'pact_broker/api/resources/error_response_body_generator'
+
+module PactBroker
+  class ApplicationContext
+    attr_reader :decorator_configuration,
+                :decorator_context_creator,
+                :webhook_execution_configuration_creator,
+                :resource_authorizer,
+                :before_resource,
+                :after_resource,
+                :error_logger,
+                :error_response_body_generator
+
+    def initialize(params = {})
+      params_with_defaults = {
+        decorator_configuration: PactBroker::Api::Decorators::Configuration.default_configuration,
+        decorator_context_creator: PactBroker::Api::Decorators::DecoratorContextCreator,
+        webhook_execution_configuration_creator: PactBroker::Webhooks::ExecutionConfigurationCreator,
+        error_logger: PactBroker::Errors::ErrorLogger,
+        error_response_body_generator: PactBroker::Api::Resources::ErrorResponseBodyGenerator
+      }.merge(params)
+
+      @decorator_configuration = params_with_defaults[:decorator_configuration]
+      @decorator_context_creator = params_with_defaults[:decorator_context_creator]
+      @webhook_execution_configuration_creator = params_with_defaults[:webhook_execution_configuration_creator]
+      @resource_authorizer = params_with_defaults[:resource_authorizer]
+      @before_resource = params_with_defaults[:before_resource]
+      @after_resource = params_with_defaults[:after_resource]
+      @error_logger = params_with_defaults[:error_logger]
+      @error_response_body_generator = params_with_defaults[:error_response_body_generator]
+    end
+
+    def self.default_application_context(overrides = {})
+      ApplicationContext.new(overrides)
+    end
+  end
+end

data/lib/pact_broker/doc/controllers/app.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'padrino-core'
 require 'redcarpet'
 
@@ -50,9 +51,9 @@ module PactBroker
           # https://www.acunetix.com/blog/articles/automated-detection-of-host-header-attacks/
           # Either use the explicitly configured base url or an empty string,
           # rather than request.base_url, which uses the X-Forwarded headers.
-          PactBroker.configuration.base_url || ''
+          env["pactbroker.base_url"] || PactBroker.configuration.base_url || ''
         end
       end
     end
   end
-end
+end

data/lib/pact_broker/domain/webhook_request.rb

@@ -51,7 +51,7 @@ module PactBroker
       end
 
       def execute
-        options = PactBroker::BuildHttpOptions.call(uri)
+        options = PactBroker::BuildHttpOptions.call(uri).merge(read_timeout: 15, open_timeout: 15)
         req = http_request
         Net::HTTP.start(uri.hostname, uri.port, :ENV, options) do |http|
           http.request req

data/lib/pact_broker/error.rb

@@ -1,6 +1,4 @@
 module PactBroker
-
   class Error < StandardError; end
   class TestError < StandardError; end
-
 end

data/lib/pact_broker/errors.rb

@@ -0,0 +1,28 @@
+require 'pact_broker/configuration'
+require 'pact_broker/error'
+require 'pact_broker/logging'
+require 'securerandom'
+
+module PactBroker
+  module Errors
+    include PactBroker::Logging
+
+    def self.generate_error_reference
+      SecureRandom.urlsafe_base64.gsub(/[^a-z]/i, '')[0,10]
+    end
+
+    def self.reportable_error?(error)
+      !error.is_a?(PactBroker::Error) && !error.is_a?(JSON::JSONError)
+    end
+
+    def self.report error, error_reference, request
+      PactBroker.configuration.api_error_reporters.each do | error_notifier |
+        begin
+          error_notifier.call(error, env: request.env, error_reference: error_reference)
+        rescue StandardError => e
+          log_error(e, "Error executing api_error_reporter")
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/errors/error_logger.rb

@@ -0,0 +1,25 @@
+require 'pact_broker/configuration'
+require 'pact_broker/logging'
+
+module PactBroker
+  module Errors
+    class ErrorLogger
+      include PactBroker::Logging
+
+      # don't need the env, just in case PF needs it
+      def self.call(error, error_reference, env = {})
+        if log_as_warning?(error)
+          logger.warn("Error reference #{error_reference}", error)
+        elsif PactBroker::Errors.reportable_error?(error)
+          log_error(error, "Error reference #{error_reference}")
+        else
+          logger.info("Error reference #{error_reference}", error)
+        end
+      end
+
+      def self.log_as_warning?(error)
+        PactBroker.configuration.warning_error_classes.any? { |clazz| error.is_a?(clazz) || error.cause&.is_a?(clazz) }
+      end
+    end
+  end
+end

data/lib/pact_broker/services.rb

@@ -1,80 +1,155 @@
 module PactBroker
   module Services
 
+    FACTORIES = {}
+
+    extend self
+
+    def register_service(name, &block)
+      FACTORIES[name] = block
+    end
+
+    def get(name)
+      FACTORIES[name].call
+    end
+
     def index_service
-      require 'pact_broker/index/service'
-      Index::Service
+      get(:index_service)
     end
 
     def pact_service
-      # TODO work out how to fix circular dependency
-      require 'pact_broker/pacts/service'
-      Pacts::Service
+      get(:pact_service)
     end
 
     def pacticipant_service
-      require 'pact_broker/pacticipants/service'
-      Pacticipants::Service
+      get(:pacticipant_service)
     end
 
     def tag_service
-      require 'pact_broker/tags/service'
-      Tags::Service
+      get(:tag_service)
     end
 
     def label_service
-      require 'pact_broker/labels/service'
-      Labels::Service
+      get(:label_service)
     end
 
     def group_service
-      require 'pact_broker/groups/service'
-      Groups::Service
+      get(:group_service)
     end
 
     def webhook_service
-      require 'pact_broker/webhooks/service'
-      Webhooks::Service
+      get(:webhook_service)
     end
 
     def version_service
-      require 'pact_broker/versions/service'
-      Versions::Service
+      get(:version_service)
     end
 
     def verification_service
-      require 'pact_broker/verifications/service'
-      Verifications::Service
+      get(:verification_service)
     end
 
     def badge_service
-      require 'pact_broker/badges/service'
-      Badges::Service
+      get(:badge_service)
     end
 
     def matrix_service
-      require 'pact_broker/matrix/service'
-      Matrix::Service
+      get(:matrix_service)
     end
 
     def certificate_service
-      require 'pact_broker/certificates/service'
-      Certificates::Service
+      get(:certificate_service)
     end
 
     def integration_service
-      require 'pact_broker/integrations/service'
-      Integrations::Service
+      get(:integration_service)
     end
 
     def webhook_trigger_service
-      require 'pact_broker/webhooks/trigger_service'
-      Webhooks::TriggerService
+      get(:webhook_trigger_service)
     end
 
     def metrics_service
-      require 'pact_broker/metrics/service'
-      Metrics::Service
+      get(:metrics_service)
+    end
+
+    def register_default_services
+      register_service(:index_service) do
+        require 'pact_broker/index/service'
+        Index::Service
+      end
+
+      register_service(:metrics_service) do
+        require 'pact_broker/metrics/service'
+        Metrics::Service
+      end
+
+      register_service(:matrix_service) do
+        require 'pact_broker/matrix/service'
+        Matrix::Service
+      end
+
+      register_service(:pact_service) do
+        require 'pact_broker/pacts/service'
+        Pacts::Service
+      end
+
+      register_service(:pacticipant_service) do
+        require 'pact_broker/pacticipants/service'
+        Pacticipants::Service
+      end
+
+      register_service(:tag_service) do
+        require 'pact_broker/tags/service'
+        Tags::Service
+      end
+
+      register_service(:label_service) do
+        require 'pact_broker/labels/service'
+        Labels::Service
+      end
+
+      register_service(:group_service) do
+        require 'pact_broker/groups/service'
+        Groups::Service
+      end
+
+      register_service(:webhook_service) do
+        require 'pact_broker/webhooks/service'
+        Webhooks::Service
+      end
+
+      register_service(:version_service) do
+        require 'pact_broker/versions/service'
+        Versions::Service
+      end
+
+      register_service(:verification_service) do
+        require 'pact_broker/verifications/service'
+        Verifications::Service
+      end
+
+      register_service(:badge_service) do
+        require 'pact_broker/badges/service'
+        Badges::Service
+      end
+
+      register_service(:certificate_service) do
+        require 'pact_broker/certificates/service'
+        Certificates::Service
+      end
+
+      register_service(:integration_service) do
+        require 'pact_broker/integrations/service'
+        Integrations::Service
+      end
+
+      register_service(:webhook_trigger_service) do
+        require 'pact_broker/webhooks/trigger_service'
+        Webhooks::TriggerService
+      end
     end
   end
 end
+
+PactBroker::Services.register_default_services

data/lib/pact_broker/test/http_test_data_builder.rb

@@ -137,6 +137,33 @@ module PactBroker
         self
       end
 
+      def create_global_webhook_for_contract_changed(uuid: nil, url: "https://postman-echo.com/post")
+        puts "Creating global webhook for contract changed event with uuid #{uuid}"
+        uuid ||= SecureRandom.uuid
+        request_body = {
+          "description" => "A webhook for all consumers and providers",
+          "events" => [{
+            "name" => "contract_content_changed"
+          }],
+          "request" => {
+            "method" => "POST",
+            "url" => url
+          }
+        }
+        path = "/webhooks/#{uuid}"
+        response = client.put(path, request_body.to_json).tap { |response| check_for_error(response) }
+        separate
+        self
+      end
+
+      def delete_webhook(uuid:)
+        puts "Deleting webhook with uuid #{uuid}"
+        path = "/webhooks/#{uuid}"
+        response = client.delete(path).tap { |response| check_for_error(response) }
+        separate
+        self
+      end
+
       def print_pacts_for_verification_response
         puts @pacts_for_verification_response.body
         self
@@ -158,6 +185,13 @@ module PactBroker
         self
       end
 
+      def delete_pacticipant(name)
+        puts "Deleting pacticipant #{name}"
+        @publish_pact_response = client.delete("/pacticipants/#{encode(name)}").tap { |response| check_for_error(response) }
+        separate
+        self
+      end
+
       def generate_content(consumer_name, provider_name, content_id)
         {
           consumer: {
@@ -168,6 +202,7 @@ module PactBroker
           },
           interactions: [
             {
+              description: "a request",
               request: {
                 method: "GET",
                 path: "/things/#{content_id}"

data/lib/pact_broker/test/test_data_builder.rb

@@ -319,9 +319,10 @@ module PactBroker
         trigger_uuid = params[:trigger_uuid] || webhook_service.next_uuid
         event_name = params.key?(:event_name) ? params[:event_name] : @webhook.events.first.name # could be nil, for backwards compatibility
         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, event_name
+        event_context = params[:event_context]
+        @triggered_webhook = webhook_repository.create_triggered_webhook(trigger_uuid, @webhook, @pact, verification, PactBroker::Webhooks::Service::RESOURCE_CREATION, event_name, event_context)
         @triggered_webhook.update(status: params[:status]) if params[:status]
-        set_created_at_if_set params[:created_at], :triggered_webhooks, {id: @triggered_webhook.id}
+        set_created_at_if_set params[:created_at], :triggered_webhooks, { id: @triggered_webhook.id }
         self
       end