pact_broker 2.81.0 → 2.82.0

data/lib/pact_broker/configuration.rb

@@ -1,118 +1,63 @@
 require "pact_broker/version"
 require "pact_broker/error"
-require "pact_broker/config/space_delimited_string_list"
-require "pact_broker/config/space_delimited_integer_list"
 require "semantic_logger"
+require "forwardable"
+require "pact_broker/config/runtime_configuration"
+require "anyway/auto_cast"
 
 module PactBroker
-
-  class ConfigurationError < PactBroker::Error; end
-
   def self.configuration
     @@configuration ||= Configuration.default_configuration
   end
 
+  def self.with_runtime_configuration_overrides(overrides, &block)
+    self.configuration.with_runtime_configuration_overrides(overrides, &block)
+  end
+
   # @private, for testing only
   def self.reset_configuration
     @@configuration = Configuration.default_configuration
   end
 
   class Configuration
+    extend Forwardable
+
+    delegate PactBroker::Config::RuntimeConfiguration.getter_and_setter_method_names => :runtime_configuration
 
-    SAVABLE_SETTING_NAMES = [
-      :order_versions_by_date,
-      :use_case_sensitive_resource_names,
-      :enable_public_badge_access,
-      :shields_io_base_url,
-      :check_for_potential_duplicate_pacticipant_names,
-      :webhook_retry_schedule,
-      :semver_formats,
-      :disable_ssl_verification,
-      :webhook_http_method_whitelist,
-      :webhook_scheme_whitelist,
-      :webhook_host_whitelist,
-      :webhook_http_code_success,
-      :base_equality_only_on_content_that_affects_verification_results,
-      :seed_example_data,
-      :badge_provider_mode,
-      :warning_error_class_names,
-      :base_url,
-      :log_dir,
-      :allow_missing_migration_files,
-      :auto_migrate_db_data,
-      :use_rack_protection,
-      :metrics_sql_statement_timeout,
-      :create_deployed_versions_for_tags
-    ]
-
-    attr_accessor :base_url, :log_dir, :database_connection, :auto_migrate_db, :auto_migrate_db_data, :allow_missing_migration_files, :example_data_seeder, :seed_example_data, :use_hal_browser, :html_pact_renderer, :use_rack_protection
-    attr_accessor :validate_database_connection_config, :enable_diagnostic_endpoints, :version_parser, :sha_generator
-    attr_accessor :use_case_sensitive_resource_names, :order_versions_by_date
-    attr_accessor :warning_error_class_names
-    attr_accessor :check_for_potential_duplicate_pacticipant_names
-    attr_accessor :webhook_retry_schedule
-    attr_accessor :user_agent
-    attr_reader :webhook_http_method_whitelist, :webhook_scheme_whitelist, :webhook_host_whitelist, :webhook_http_code_success
-    attr_accessor :semver_formats
-    attr_accessor :enable_public_badge_access, :shields_io_base_url, :badge_provider_mode
-    attr_accessor :disable_ssl_verification
+    attr_accessor :database_connection
+    attr_accessor :example_data_seeder
+    attr_accessor :html_pact_renderer, :version_parser, :sha_generator
     attr_accessor :content_security_policy, :hal_browser_content_security_policy_overrides
-    attr_accessor :base_equality_only_on_content_that_affects_verification_results
-    attr_reader :api_error_reporters
+    attr_accessor :api_error_reporters
     attr_reader :custom_logger
     attr_accessor :policy_builder, :policy_scope_builder, :base_resource_class_factory
-    attr_accessor :metrics_sql_statement_timeout
-    attr_accessor :create_deployed_versions_for_tags
-
     alias_method :policy_finder=, :policy_builder=
     alias_method :policy_scope_finder=, :policy_scope_builder=
 
+    attr_accessor :runtime_configuration
+
     def initialize
+      @runtime_configuration = PactBroker::Config::RuntimeConfiguration.new
       @before_resource_hook = ->(resource){}
       @after_resource_hook = ->(resource){}
       @authenticate_with_basic_auth = nil
       @authorize = nil
       @api_error_reporters = []
-      @semantic_logger = SemanticLogger["root"]
     end
 
-    # rubocop: disable Metrics/MethodLength
     def self.default_configuration
       require "pact_broker/versions/parse_semantic_version"
       require "pact_broker/pacts/generate_sha"
 
       config = Configuration.new
-      config.log_dir = File.expand_path("./log")
-      config.auto_migrate_db = true
-      config.auto_migrate_db_data = true
-      config.allow_missing_migration_files = false
-      config.use_rack_protection = true
-      config.use_hal_browser = true
-      config.validate_database_connection_config = true
-      config.enable_diagnostic_endpoints = true
-      config.enable_public_badge_access = false # For security
-      config.shields_io_base_url = "https://img.shields.io".freeze
-      config.badge_provider_mode = :proxy # other option is :redirect
-      config.use_case_sensitive_resource_names = true
       config.html_pact_renderer = default_html_pact_render
       config.version_parser = PactBroker::Versions::ParseSemanticVersion
       config.sha_generator = PactBroker::Pacts::GenerateSha
-      config.seed_example_data = true
       config.example_data_seeder = lambda do
         require "pact_broker/db/seed_example_data"
         PactBroker::DB::SeedExampleData.call
       end
-      config.user_agent = "Pact Broker v#{PactBroker::VERSION}"
-      config.base_equality_only_on_content_that_affects_verification_results = true
-      config.order_versions_by_date = true
-      config.semver_formats = ["%M.%m.%p%s%d", "%M.%m", "%M"]
-      config.webhook_retry_schedule = [10, 60, 120, 300, 600, 1200] #10 sec, 1 min, 2 min, 5 min, 10 min, 20 min => 38 minutes
-      config.check_for_potential_duplicate_pacticipant_names = true
-      config.disable_ssl_verification = false
-      config.webhook_http_method_whitelist = ["POST"]
-      config.webhook_http_code_success = [200, 201, 202, 203, 204, 205, 206]
-      config.webhook_scheme_whitelist = ["https"]
-      config.webhook_host_whitelist = []
+
       # TODO get rid of unsafe-inline
       config.content_security_policy = {
         script_src: "'self' 'unsafe-inline'",
@@ -133,25 +78,49 @@ module PactBroker
         require "pact_broker/api/resources/default_base_resource"
         PactBroker::Api::Resources::DefaultBaseResource
       }
-      config.warning_error_class_names = ["Sequel::ForeignKeyConstraintViolation", "PG::QueryCanceled"]
-      config.metrics_sql_statement_timeout = 30
-      config.create_deployed_versions_for_tags = true
       config
     end
-    # rubocop: enable Metrics/MethodLength
+
+    def with_runtime_configuration_overrides(overrides)
+      original_runtime_configuration = runtime_configuration
+      self.runtime_configuration = override_runtime_configuration(overrides, original_runtime_configuration.dup)
+      yield
+    ensure
+      self.runtime_configuration = original_runtime_configuration
+    end
+
+    def logger_from_runtime_configuration
+      @logger_from_runtime_configuration ||= begin
+        runtime_configuration.validate_logging_attributes!
+        SemanticLogger.default_level = runtime_configuration.log_level
+        if runtime_configuration.log_stream == :file
+          path = runtime_configuration.log_dir + "/pact_broker.log"
+          FileUtils.mkdir_p(runtime_configuration.log_dir)
+          @default_appender = SemanticLogger.add_appender(file_name: path, formatter: runtime_configuration.log_format)
+        else
+          @default_appender = SemanticLogger.add_appender(io: $stdout, formatter: runtime_configuration.log_format)
+        end
+        @logger_from_runtime_configuration = SemanticLogger["pact-broker"]
+      end
+    end
 
     def logger
-      custom_logger || @semantic_logger
+      custom_logger || logger_from_runtime_configuration
     end
 
     def logger= logger
+      if @default_appender && SemanticLogger.appenders.include?(@default_appender)
+        SemanticLogger.remove_appender(@default_appender)
+        @default_appender = nil
+      end
       @custom_logger = logger
     end
 
     def log_configuration
-      SAVABLE_SETTING_NAMES.sort.each do | setting |
-        logger.info "PactBroker.configuration.#{setting}=#{PactBroker.configuration.send(setting).inspect}"
-      end
+      logger.info "------------------------------------------------------------------------"
+      logger.info "PACT BROKER CONFIGURATION:"
+      runtime_configuration.log_configuration(logger)
+      logger.info "------------------------------------------------------------------------"
     end
 
     def self.default_html_pact_render
@@ -232,68 +201,35 @@ module PactBroker
       self.enable_public_badge_access = enable_badge_resources
     end
 
-    def save_to_database
-      # Can't require a Sequel::Model class before the connection has been set
-      require "pact_broker/config/save"
-      PactBroker::Config::Save.call(self, SAVABLE_SETTING_NAMES)
-    end
-
     def load_from_database!
       # Can't require a Sequel::Model class before the connection has been set
       require "pact_broker/config/load"
-      PactBroker::Config::Load.call(self)
+      PactBroker::Config::Load.call(runtime_configuration)
     end
 
-    def webhook_http_method_whitelist= webhook_http_method_whitelist
-      @webhook_http_method_whitelist = parse_space_delimited_string_list_property("webhook_http_method_whitelist", webhook_http_method_whitelist)
-    end
-
-    def webhook_http_code_success= webhook_http_code_success
-      @webhook_http_code_success = parse_space_delimited_integer_list_property("webhook_http_code_success", webhook_http_code_success)
-    end
-
-    def webhook_scheme_whitelist= webhook_scheme_whitelist
-      @webhook_scheme_whitelist = parse_space_delimited_string_list_property("webhook_scheme_whitelist", webhook_scheme_whitelist)
-    end
-
-    def webhook_host_whitelist= webhook_host_whitelist
-      @webhook_host_whitelist = parse_space_delimited_string_list_property("webhook_host_whitelist", webhook_host_whitelist)
-    end
+    private
 
-    def base_urls
-      base_url ? base_url.split(" ") : []
-    end
+    def override_runtime_configuration(overrides, new_runtime_configuration)
+      valid_overrides = {}
+      invalid_overrides = {}
 
-    def warning_error_classes
-      warning_error_class_names.collect do | class_name |
-        begin
-          Object.const_get(class_name)
-        rescue NameError => e
-          logger.warn("Class #{class_name} couldn't be loaded as a warning error class (#{e.class} - #{e.message}). Ignoring.")
-          nil
+      overrides.each do | key, value |
+        if new_runtime_configuration.respond_to?("#{key}=")
+          valid_overrides[key] = Anyway::AutoCast.call(value)
+        else
+          invalid_overrides[key] = Anyway::AutoCast.call(value)
         end
-      end.compact
-    end
-
-    private
+      end
 
-    def parse_space_delimited_string_list_property property_name, property_value
-      case property_value
-      when String then Config::SpaceDelimitedStringList.parse(property_value)
-      when Array then Config::SpaceDelimitedStringList.new(property_value)
-      else
-        raise ConfigurationError.new("Pact Broker configuration property `#{property_name}` must be a space delimited String or an Array")
+      if logger.debug?
+        logger.debug("Overridding runtime configuration", payload: { overrides: valid_overrides, ignoring: invalid_overrides })
       end
-    end
 
-    def parse_space_delimited_integer_list_property property_name, property_value
-      case property_value
-      when String then Config::SpaceDelimitedIntegerList.parse(property_value)
-      when Array then Config::SpaceDelimitedIntegerList.new(property_value)
-      else
-        raise ConfigurationError.new("Pact Broker configuration property `#{property_name}` must be a space delimited String or an Array with Integer values")
+      valid_overrides.each do | key, value |
+        new_runtime_configuration.public_send("#{key}=", value)
       end
-    end
 
+      new_runtime_configuration
+    end
   end
 end

data/lib/pact_broker/contracts/notice.rb

@@ -13,6 +13,10 @@ module PactBroker
         Notice.new("warning", text)
       end
 
+      def self.prompt(text)
+        Notice.new("prompt", text)
+      end
+
       def self.success(text)
         Notice.new("success", text)
       end

data/lib/pact_broker/contracts/service.rb

@@ -129,7 +129,7 @@ module PactBroker
         message_params[:action] = existing_version ? "Updated" : "Created"
         notices << Notice.debug(message(message_key_for_version_creation(parsed_contracts), message_params))
         if parsed_contracts.branch.nil?
-          notices << Notice.warning("  Next steps:\n    " + message("messages.next_steps.version_branch"))
+          notices << Notice.prompt("  Next steps:\n    " + message("messages.next_steps.version_branch"))
         end
         notices
       end
@@ -217,15 +217,15 @@ module PactBroker
       def next_steps_notices(pact)
         notices = []
         if !verification_service.any_verifications?(pact.consumer, pact.provider)
-          notices << Notice.warning("    * " + message("messages.next_steps.verifications", provider_name: pact.provider_name))
+          notices << Notice.prompt("    * " + message("messages.next_steps.verifications", provider_name: pact.provider_name))
         end
 
         if !webhook_service.any_webhooks_configured_for_pact?(pact)
-          notices << Notice.warning("    * " + message("messages.next_steps.webhooks", provider_name: pact.provider_name))
+          notices << Notice.prompt("    * " + message("messages.next_steps.webhooks", provider_name: pact.provider_name))
         end
 
         if notices.any?
-          notices.unshift(Notice.warning("  Next steps:"))
+          notices.unshift(Notice.prompt("  Next steps:"))
         end
 
         notices

data/lib/pact_broker/db/models.rb

@@ -3,6 +3,7 @@ require "pact_broker/webhooks/triggered_webhook"
 require "pact_broker/webhooks/webhook"
 require "pact_broker/pacts/latest_pact_publication_id_for_consumer_version"
 require "pact_broker/verifications/latest_verification_id_for_pact_version_and_provider_version"
+require "pact_broker/integrations/integration"
 require "pact_broker/pacts/pact_publication"
 require "pact_broker/pacts/pact_version"
 require "pact_broker/domain/verification"
@@ -13,6 +14,8 @@ require "pact_broker/domain/pacticipant"
 require "pact_broker/deployments/environment"
 require "pact_broker/deployments/deployed_version"
 require "pact_broker/deployments/released_version"
+require "pact_broker/matrix/row"
+require "pact_broker/matrix/head_row"
 
 module PactBroker
   INTEGRATIONS_TABLES = [

data/lib/pact_broker/db/validate_encoding.rb

@@ -3,11 +3,8 @@ require "pact_broker/messages"
 
 module PactBroker
   module DB
-
     class ConnectionConfigurationError < StandardError; end
-
     class ValidateEncoding
-
       extend PactBroker::Messages
 
       def self.call connection
@@ -16,7 +13,6 @@ module PactBroker
           raise ConnectionConfigurationError.new(message("errors.validation.connection_encoding_not_utf8", encoding: encoding.inspect))
         end
       end
-
     end
   end
 end

data/lib/pact_broker/deployments/deployed_version.rb

@@ -4,6 +4,7 @@ require "pact_broker/deployments/currently_deployed_version_id"
 module PactBroker
   module Deployments
     class DeployedVersion < Sequel::Model
+      many_to_one :pacticipant, :class => "PactBroker::Domain::Pacticipant", :key => :pacticipant_id, :primary_key => :id
       many_to_one :version, :class => "PactBroker::Domain::Version", :key => :version_id, :primary_key => :id
       many_to_one :environment, :class => "PactBroker::Deployments::Environment", :key => :environment_id, :primary_key => :id
       one_to_one :currently_deployed_version_id, :class => "PactBroker::Deployments::CurrentlyDeployedVersionId", key: :deployed_version_id, primary_key: :id
@@ -87,10 +88,15 @@ module PactBroker
         version.number
       end
 
+      def environment_name
+        environment.name
+      end
+
       def record_undeployed
         self.class.where(id: id).record_undeployed
         self.refresh
       end
+
     end
   end
 end
@@ -102,11 +108,11 @@ end
 #  version_id       | integer                     | NOT NULL
 #  pacticipant_id   | integer                     | NOT NULL
 #  environment_id   | integer                     | NOT NULL
-#  target           | text                        |
-#  target_for_index | text                        | NOT NULL DEFAULT ''::text
 #  created_at       | timestamp without time zone | NOT NULL
 #  updated_at       | timestamp without time zone | NOT NULL
 #  undeployed_at    | timestamp without time zone |
+#  target           | text                        |
+#  target_for_index | text                        | NOT NULL DEFAULT ''::text
 # Indexes:
 #  deployed_versions_pkey       | PRIMARY KEY btree (id)
 #  deployed_versions_uuid_index | UNIQUE btree (uuid)

data/lib/pact_broker/deployments/deployed_version_service.rb

@@ -1,8 +1,12 @@
 require "pact_broker/deployments/deployed_version"
+require "pact_broker/repositories/scopes"
 
 module PactBroker
   module Deployments
     class DeployedVersionService
+      include PactBroker::Logging
+      extend PactBroker::Repositories::Scopes
+      extend PactBroker::Services
 
       def self.next_uuid
         SecureRandom.uuid
@@ -68,6 +72,15 @@ module PactBroker
         deployed_version.record_undeployed
       end
 
+      def self.maybe_create_deployed_version_for_tag(version, environment_name)
+        if PactBroker.configuration.create_deployed_versions_for_tags
+          if (environment = environment_service.find_by_name(environment_name))
+            logger.info("Creating deployed version for #{version.pacticipant.name} version #{version.number} in environment #{environment_name} (because create_deployed_versions_for_tags=true)")
+            find_or_create(next_uuid, version, environment, nil)
+          end
+        end
+      end
+
       def self.record_previous_version_undeployed(pacticipant, environment, target)
         DeployedVersion.where(
           undeployed_at: nil,
@@ -78,12 +91,6 @@ module PactBroker
       end
 
       private_class_method :record_previous_version_undeployed
-
-      def self.scope_for(scope)
-        PactBroker.policy_scope!(scope)
-      end
-
-      private_class_method :scope_for
     end
   end
 end

data/lib/pact_broker/deployments/environment.rb

@@ -44,6 +44,6 @@ end
 #  environments_name_index | UNIQUE btree (name)
 #  environments_uuid_index | UNIQUE btree (uuid)
 # Referenced By:
-#  deployed_versions              | deployed_versions_environment_id_fkey              | (environment_id) REFERENCES environments(id)
 #  currently_deployed_version_ids | currently_deployed_version_ids_environment_id_fkey | (environment_id) REFERENCES environments(id) ON DELETE CASCADE
+#  deployed_versions              | deployed_versions_environment_id_fkey              | (environment_id) REFERENCES environments(id)
 #  released_versions              | released_versions_environment_id_fkey              | (environment_id) REFERENCES environments(id)

data/lib/pact_broker/deployments/released_version.rb

@@ -59,6 +59,14 @@ module PactBroker
       def currently_supported
         support_ended_at == nil
       end
+
+      def version_number
+        version.number
+      end
+
+      def environment_name
+        environment.name
+      end
     end
   end
 end