kamal 1.6.0 → 1.7.0

data/lib/kamal/configuration/validator.rb

@@ -0,0 +1,140 @@
+class Kamal::Configuration::Validator
+  attr_reader :config, :example, :context
+
+  def initialize(config, example:, context:)
+    @config = config
+    @example = example
+    @context = context
+  end
+
+  def validate!
+    validate_against_example! config, example
+  end
+
+  private
+    def validate_against_example!(validation_config, example)
+      validate_type! validation_config, Hash
+
+      if (unknown_keys = validation_config.keys - example.keys).any?
+        unknown_keys_error unknown_keys
+      end
+
+      validation_config.each do |key, value|
+        with_context(key) do
+          example_value = example[key]
+
+          if example_value == "..."
+            validate_type! value, *(Array if key == :servers), Hash
+          elsif key == "hosts"
+            validate_servers! value
+          elsif example_value.is_a?(Array)
+            validate_array_of! value, example_value.first.class
+          elsif example_value.is_a?(Hash)
+            case key.to_s
+            when "options"
+              validate_type! value, Hash
+            when "args", "labels"
+              validate_hash_of! value, example_value.first[1].class
+            else
+              validate_against_example! value, example_value
+            end
+          else
+            validate_type! value, example_value.class
+          end
+        end
+      end
+    end
+
+
+    def valid_type?(value, type)
+      value.is_a?(type) ||
+        (type == String && stringish?(value)) ||
+        (boolean?(type) && boolean?(value.class))
+    end
+
+    def type_description(type)
+      if type == Integer || type == Array
+        "an #{type.name.downcase}"
+      elsif type == TrueClass || type == FalseClass
+        "a boolean"
+      else
+        "a #{type.name.downcase}"
+      end
+    end
+
+    def boolean?(type)
+      type == TrueClass || type == FalseClass
+    end
+
+    def stringish?(value)
+      value.is_a?(String) || value.is_a?(Symbol) || value.is_a?(Numeric) || value.is_a?(TrueClass) || value.is_a?(FalseClass)
+    end
+
+    def validate_array_of!(array, type)
+      validate_type! array, Array
+
+      array.each_with_index do |value, index|
+        with_context(index) do
+          validate_type! value, type
+        end
+      end
+    end
+
+    def validate_hash_of!(hash, type)
+      validate_type! hash, Hash
+
+      hash.each do |key, value|
+        with_context(key) do
+          validate_type! value, type
+        end
+      end
+    end
+
+    def validate_servers!(servers)
+      validate_type! servers, Array
+
+      servers.each_with_index do |server, index|
+        with_context(index) do
+          validate_type! server, String, Hash
+
+          if server.is_a?(Hash)
+            error "multiple hosts found" unless server.size == 1
+            host, tags = server.first
+
+            with_context(host) do
+              validate_type! tags, String, Array
+              validate_array_of! tags, String if tags.is_a?(Array)
+            end
+          end
+        end
+      end
+    end
+
+    def validate_type!(value, *types)
+      type_error(*types) unless types.any? { |type| valid_type?(value, type) }
+    end
+
+    def error(message)
+      raise Kamal::ConfigurationError, "#{error_context}#{message}"
+    end
+
+    def type_error(*expected_types)
+      error "should be #{expected_types.map { |type| type_description(type) }.join(" or ")}"
+    end
+
+    def unknown_keys_error(unknown_keys)
+      error "unknown #{"key".pluralize(unknown_keys.count)}: #{unknown_keys.join(", ")}"
+    end
+
+    def error_context
+      "#{context}: " if context.present?
+    end
+
+    def with_context(context)
+      old_context = @context
+      @context = [ @context, context ].select(&:present?).join("/")
+      yield
+    ensure
+      @context = old_context
+    end
+end

data/lib/kamal/configuration.rb

@@ -1,15 +1,19 @@
 require "active_support/ordered_options"
 require "active_support/core_ext/string/inquiry"
 require "active_support/core_ext/module/delegation"
+require "active_support/core_ext/hash/keys"
 require "pathname"
 require "erb"
 require "net/ssh/proxy/jump"
 
 class Kamal::Configuration
-  delegate :service, :image, :servers, :labels, :registry, :stop_wait_time, :hooks_path, :logging, to: :raw_config, allow_nil: true
+  delegate :service, :image, :labels, :stop_wait_time, :hooks_path, to: :raw_config, allow_nil: true
   delegate :argumentize, :optionize, to: Kamal::Utils
 
   attr_reader :destination, :raw_config
+  attr_reader :accessories, :boot, :builder, :env, :healthcheck, :logging, :traefik, :servers, :ssh, :sshkit, :registry
+
+  include Validation
 
   class << self
     def create_from(config_file:, destination: nil, version: nil)
@@ -42,7 +46,29 @@ class Kamal::Configuration
     @raw_config = ActiveSupport::InheritableOptions.new(raw_config)
     @destination = destination
     @declared_version = version
-    valid? if validate
+
+    validate! raw_config, example: validation_yml.symbolize_keys, context: ""
+
+    # Eager load config to validate it, these are first as they have dependencies later on
+    @servers = Servers.new(config: self)
+    @registry = Registry.new(config: self)
+
+    @accessories = @raw_config.accessories&.keys&.collect { |name| Accessory.new(name, config: self) } || []
+    @boot = Boot.new(config: self)
+    @builder = Builder.new(config: self)
+    @env = Env.new(config: @raw_config.env || {})
+
+    @healthcheck = Healthcheck.new(healthcheck_config: @raw_config.healthcheck)
+    @logging = Logging.new(logging_config: @raw_config.logging)
+    @traefik = Traefik.new(config: self)
+    @ssh = Ssh.new(config: self)
+    @sshkit = Sshkit.new(config: self)
+
+    ensure_destination_if_required
+    ensure_required_keys_present
+    ensure_valid_kamal_version
+    ensure_retain_containers_valid
+    ensure_valid_service_name
   end
 
 
@@ -71,17 +97,13 @@ class Kamal::Configuration
 
 
   def roles
-    @roles ||= role_names.collect { |role_name| Role.new(role_name, config: self) }
+    servers.roles
   end
 
   def role(name)
     roles.detect { |r| r.name == name.to_s }
   end
 
-  def accessories
-    @accessories ||= raw_config.accessories&.keys&.collect { |name| Kamal::Configuration::Accessory.new(name, config: self) } || []
-  end
-
   def accessory(name)
     accessories.detect { |a| a.name == name.to_s }
   end
@@ -120,7 +142,7 @@ class Kamal::Configuration
   end
 
   def repository
-    [ raw_config.registry["server"], image ].compact.join("/")
+    [ registry.server, image ].compact.join("/")
   end
 
   def absolute_image
@@ -157,40 +179,10 @@ class Kamal::Configuration
   end
 
   def logging_args
-    if logging.present?
-      optionize({ "log-driver" => logging["driver"] }.compact) +
-        argumentize("--log-opt", logging["options"])
-    else
-      argumentize("--log-opt", { "max-size" => "10m" })
-    end
-  end
-
-
-  def boot
-    Kamal::Configuration::Boot.new(config: self)
-  end
-
-  def builder
-    Kamal::Configuration::Builder.new(config: self)
-  end
-
-  def traefik
-    raw_config.traefik || {}
-  end
-
-  def ssh
-    Kamal::Configuration::Ssh.new(config: self)
-  end
-
-  def sshkit
-    Kamal::Configuration::Sshkit.new(config: self)
+    logging.args
   end
 
 
-  def healthcheck
-    { "path" => "/up", "port" => 3000, "max_attempts" => 7, "cord" => "/tmp/kamal-cord", "log_lines" => 50 }.merge(raw_config.healthcheck || {})
-  end
-
   def healthcheck_service
     [ "healthcheck", service, destination ].compact.join("-")
   end
@@ -229,13 +221,9 @@ class Kamal::Configuration
     File.join(run_directory, "env")
   end
 
-  def env
-    raw_config.env || {}
-  end
-
   def env_tags
     @env_tags ||= if (tags = raw_config.env["tags"])
-      tags.collect { |name, config| Kamal::Configuration::Env::Tag.new(name, config: config) }
+      tags.collect { |name, config| Env::Tag.new(name, config: config) }
     else
       []
     end
@@ -246,10 +234,6 @@ class Kamal::Configuration
   end
 
 
-  def valid?
-    ensure_destination_if_required && ensure_required_keys_present && ensure_valid_kamal_version && ensure_retain_containers_valid && ensure_valid_service_name
-  end
-
   def to_h
     {
       roles: role_names,
@@ -265,11 +249,10 @@ class Kamal::Configuration
       builder: builder.to_h,
       accessories: raw_config.accessories,
       logging: logging_args,
-      healthcheck: healthcheck
+      healthcheck: healthcheck.to_h
     }.compact
   end
 
-
   private
     # Will raise ArgumentError if any required config keys are missing
     def ensure_destination_if_required
@@ -282,29 +265,21 @@ class Kamal::Configuration
 
     def ensure_required_keys_present
       %i[ service image registry servers ].each do |key|
-        raise ArgumentError, "Missing required configuration for #{key}" unless raw_config[key].present?
-      end
-
-      if raw_config.registry["username"].blank?
-        raise ArgumentError, "You must specify a username for the registry in config/deploy.yml"
-      end
-
-      if raw_config.registry["password"].blank?
-        raise ArgumentError, "You must specify a password for the registry in config/deploy.yml (or set the ENV variable if that's used)"
+        raise Kamal::ConfigurationError, "Missing required configuration for #{key}" unless raw_config[key].present?
       end
 
-      unless role_names.include?(primary_role_name)
-        raise ArgumentError, "The primary_role #{primary_role_name} isn't defined"
+      unless role(primary_role_name).present?
+        raise Kamal::ConfigurationError, "The primary_role #{primary_role_name} isn't defined"
       end
 
       if primary_role.hosts.empty?
-        raise ArgumentError, "No servers specified for the #{primary_role.name} primary_role"
+        raise Kamal::ConfigurationError, "No servers specified for the #{primary_role.name} primary_role"
       end
 
       unless allow_empty_roles?
         roles.each do |role|
           if role.hosts.empty?
-            raise ArgumentError, "No servers specified for the #{role.name} role. You can ignore this with allow_empty_roles: true"
+            raise Kamal::ConfigurationError, "No servers specified for the #{role.name} role. You can ignore this with allow_empty_roles: true"
           end
         end
       end
@@ -313,21 +288,21 @@ class Kamal::Configuration
     end
 
     def ensure_valid_service_name
-      raise ArgumentError, "Service name can only include alphanumeric characters, hyphens, and underscores" unless raw_config[:service] =~ /^[a-z0-9_-]+$/i
+      raise Kamal::ConfigurationError, "Service name can only include alphanumeric characters, hyphens, and underscores" unless raw_config[:service] =~ /^[a-z0-9_-]+$/i
 
       true
     end
 
     def ensure_valid_kamal_version
       if minimum_version && Gem::Version.new(minimum_version) > Gem::Version.new(Kamal::VERSION)
-        raise ArgumentError, "Current version is #{Kamal::VERSION}, minimum required is #{minimum_version}"
+        raise Kamal::ConfigurationError, "Current version is #{Kamal::VERSION}, minimum required is #{minimum_version}"
       end
 
       true
     end
 
     def ensure_retain_containers_valid
-      raise ArgumentError, "Must retain at least 1 container" if retain_containers < 1
+      raise Kamal::ConfigurationError, "Must retain at least 1 container" if retain_containers < 1
 
       true
     end

data/lib/kamal/version.rb

@@ -1,3 +1,3 @@
 module Kamal
-  VERSION = "1.6.0"
+  VERSION = "1.7.0"
 end

data/lib/kamal.rb

@@ -1,8 +1,10 @@
 module Kamal
+  class ConfigurationError < StandardError; end
 end
 
 require "active_support"
 require "zeitwerk"
+require "yaml"
 
 loader = Zeitwerk::Loader.for_gem
 loader.ignore(File.join(__dir__, "kamal", "sshkit_with_ext.rb"))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kamal
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-03 00:00:00.000000000 Z
+date: 2024-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -114,6 +114,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: x25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.10
 - !ruby/object:Gem::Dependency
   name: bcrypt_pbkdf
   requirement: !ruby/object:Gem::Requirement
@@ -268,11 +288,37 @@ files:
 - lib/kamal/configuration/accessory.rb
 - lib/kamal/configuration/boot.rb
 - lib/kamal/configuration/builder.rb
+- lib/kamal/configuration/docs/accessory.yml
+- lib/kamal/configuration/docs/boot.yml
+- lib/kamal/configuration/docs/builder.yml
+- lib/kamal/configuration/docs/configuration.yml
+- lib/kamal/configuration/docs/env.yml
+- lib/kamal/configuration/docs/healthcheck.yml
+- lib/kamal/configuration/docs/logging.yml
+- lib/kamal/configuration/docs/registry.yml
+- lib/kamal/configuration/docs/role.yml
+- lib/kamal/configuration/docs/servers.yml
+- lib/kamal/configuration/docs/ssh.yml
+- lib/kamal/configuration/docs/sshkit.yml
+- lib/kamal/configuration/docs/traefik.yml
 - lib/kamal/configuration/env.rb
 - lib/kamal/configuration/env/tag.rb
+- lib/kamal/configuration/healthcheck.rb
+- lib/kamal/configuration/logging.rb
+- lib/kamal/configuration/registry.rb
 - lib/kamal/configuration/role.rb
+- lib/kamal/configuration/servers.rb
 - lib/kamal/configuration/ssh.rb
 - lib/kamal/configuration/sshkit.rb
+- lib/kamal/configuration/traefik.rb
+- lib/kamal/configuration/validation.rb
+- lib/kamal/configuration/validator.rb
+- lib/kamal/configuration/validator/accessory.rb
+- lib/kamal/configuration/validator/builder.rb
+- lib/kamal/configuration/validator/env.rb
+- lib/kamal/configuration/validator/registry.rb
+- lib/kamal/configuration/validator/role.rb
+- lib/kamal/configuration/validator/servers.rb
 - lib/kamal/configuration/volume.rb
 - lib/kamal/env_file.rb
 - lib/kamal/git.rb
@@ -300,7 +346,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Deploy web apps in containers to servers running Docker with zero downtime.