mrsk 0.1.0 → 0.3.0

data/lib/mrsk/configuration.rb

@@ -3,26 +3,42 @@ require "active_support/core_ext/string/inquiry"
 require "active_support/core_ext/module/delegation"
 require "pathname"
 require "erb"
+require "mrsk/utils"
 
 class Mrsk::Configuration
-  delegate :service, :image, :servers, :env, :labels, :registry, :builder, to: :config, allow_nil: true
+  delegate :service, :image, :servers, :env, :labels, :registry, :builder, to: :raw_config, allow_nil: true
+  delegate :argumentize, :argumentize_env_with_secrets, to: Mrsk::Utils
+
+  attr_accessor :raw_config
 
   class << self
-    def load_file(file)
-      if file.exist?
-        new YAML.load(ERB.new(IO.read(file)).result).symbolize_keys
-      else
-        raise "Configuration file not found in #{file}"
-      end
+    def create_from(base_config_file, destination: nil, version: "missing")
+      new(load_config_file(base_config_file).tap do |config|
+        if destination
+          config.deep_merge! \
+            load_config_file destination_config_file(base_config_file, destination)
+        end
+      end, version: version)
     end
 
-    def argumentize(argument, attributes)
-      attributes.flat_map { |k, v| [ argument, "#{k}=#{v}" ] }
-    end
+    private
+      def load_config_file(file)
+        if file.exist?
+          YAML.load(ERB.new(IO.read(file)).result).symbolize_keys
+        else
+          raise "Configuration file not found in #{file}"
+        end
+      end
+
+      def destination_config_file(base_config_file, destination)
+        dir, basename = base_config_file.split
+        dir.join basename.to_s.remove(".yml") + ".#{destination}.yml"
+      end
   end
 
-  def initialize(config, validate: true)
-    @config = ActiveSupport::InheritableOptions.new(config)
+  def initialize(raw_config, version: "missing", validate: true)
+    @raw_config = ActiveSupport::InheritableOptions.new(raw_config)
+    @version = version
     ensure_required_keys_present if validate
   end
 
@@ -35,36 +51,34 @@ class Mrsk::Configuration
     roles.detect { |r| r.name == name.to_s }
   end
 
-  def hosts
-    hosts =
-      case
-      when ENV["HOSTS"]
-        ENV["HOSTS"].split(",")
-      when ENV["ROLES"]
-        role_names = ENV["ROLES"].split(",")
-        roles.select { |r| role_names.include?(r.name) }.flat_map(&:hosts)
-      else
-        roles.flat_map(&:hosts)
-      end
+  def accessories
+    @accessories ||= raw_config.accessories&.keys&.collect { |name| Mrsk::Configuration::Assessory.new(name, config: self) } || []
+  end
 
-      if hosts.any?
-        hosts
-      else
-        raise ArgumentError, "No hosts found"
-      end
+  def accessory(name)
+    accessories.detect { |a| a.name == name.to_s }
+  end
+
+
+  def all_hosts
+    roles.flat_map(&:hosts)
   end
 
-  def primary_host
+  def primary_web_host
     role(:web).hosts.first
   end
 
+  def traefik_hosts
+    roles.select(&:running_traefik?).flat_map(&:hosts)
+  end
+
 
   def version
-    @version ||= ENV["VERSION"] || `git rev-parse HEAD`.strip
+    @version
   end
 
   def repository
-    [ config.registry["server"], image ].compact.join("/")
+    [ raw_config.registry["server"], image ].compact.join("/")
   end
 
   def absolute_image
@@ -77,15 +91,23 @@ class Mrsk::Configuration
 
 
   def env_args
-    if config.env.present?
-      self.class.argumentize "-e", config.env
+    if raw_config.env.present?
+      argumentize_env_with_secrets(raw_config.env)
+    else
+      []
+    end
+  end
+
+  def volume_args
+    if raw_config.volumes.present?
+      argumentize "--volume", raw_config.volumes
     else
       []
     end
   end
 
   def ssh_user
-    config.ssh_user || "root"
+    raw_config.ssh_user || "root"
   end
 
   def ssh_options
@@ -93,26 +115,48 @@ class Mrsk::Configuration
   end
 
   def master_key
-    ENV["RAILS_MASTER_KEY"] || File.read(Pathname.new(File.expand_path("config/master.key")))
+    unless raw_config.skip_master_key
+      ENV["RAILS_MASTER_KEY"] || File.read(Pathname.new(File.expand_path("config/master.key")))
+    end
   end
 
+  def to_h
+    {
+      roles: role_names,
+      hosts: all_hosts,
+      primary_host: primary_web_host,
+      version: version,
+      repository: repository,
+      absolute_image: absolute_image,
+      service_with_version: service_with_version,
+      env_args: env_args,
+      volume_args: volume_args,
+      ssh_options: ssh_options,
+      builder: raw_config.builder,
+      accessories: raw_config.accessories
+    }.compact
+  end
 
-  private
-    attr_accessor :config
 
+  private
     def ensure_required_keys_present
-      %i[ service image registry ].each do |key|
-        raise ArgumentError, "Missing required configuration for #{key}" unless config[key].present?
+      %i[ service image registry servers ].each do |key|
+        raise ArgumentError, "Missing required configuration for #{key}" unless raw_config[key].present?
       end
 
-      %w[ username password ].each do |key|
-        raise ArgumentError, "Missing required configuration for registry/#{key}" unless config.registry[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)"
+      end
     end
 
     def role_names
-      config.servers.is_a?(Array) ? [ "web" ] : config.servers.keys.sort
+      raw_config.servers.is_a?(Array) ? [ "web" ] : raw_config.servers.keys.sort
     end
 end
 
 require "mrsk/configuration/role"
+require "mrsk/configuration/accessory"

data/lib/mrsk/sshkit_with_ext.rb

@@ -0,0 +1,12 @@
+require "sshkit"
+require "sshkit/dsl"
+
+class SSHKit::Backend::Abstract
+  def capture_with_info(*args)
+    capture(*args, verbosity: Logger::INFO)
+  end
+
+  def puts_by_host(host, output, type: "App")
+    puts "#{type} Host: #{host}\n#{output}\n\n"
+  end
+end

data/lib/mrsk/utils.rb

@@ -0,0 +1,29 @@
+module Mrsk::Utils
+  extend self
+
+  # Return a list of shell arguments using the same named argument against the passed attributes (hash or array).
+  def argumentize(argument, attributes, redacted: false)
+    Array(attributes).flat_map do |k, v|
+      if v.present?
+        [ argument, redacted ? redact("#{k}=#{v}") : "#{k}=#{v}" ]
+      else
+        [ argument, k ]
+      end
+    end
+  end
+
+  # Return a list of shell arguments using the same named argument against the passed attributes,
+  # but redacts and expands secrets.
+  def argumentize_env_with_secrets(env)
+    if (secrets = env["secret"]).present?
+      argumentize("-e", secrets.to_h { |key| [ key, ENV.fetch(key) ] }, redacted: true) + argumentize("-e", env["clear"])
+    else
+      argumentize "-e", env
+    end
+  end
+
+  # Copied from SSHKit::Backend::Abstract#redact to be available inside Commands classes
+  def redact(arg) # Used in execute_command to hide redact() args a user passes in
+    arg.to_s.extend(SSHKit::Redaction) # to_s due to our inability to extend Integer, etc
+  end
+end

data/lib/mrsk/version.rb

@@ -1,3 +1,3 @@
 module Mrsk
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mrsk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-14 00:00:00.000000000 Z
+date: 2023-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -64,6 +64,7 @@ files:
 - bin/mrsk
 - lib/mrsk.rb
 - lib/mrsk/cli.rb
+- lib/mrsk/cli/accessory.rb
 - lib/mrsk/cli/app.rb
 - lib/mrsk/cli/base.rb
 - lib/mrsk/cli/build.rb
@@ -75,17 +76,23 @@ files:
 - lib/mrsk/cli/traefik.rb
 - lib/mrsk/commander.rb
 - lib/mrsk/commands.rb
+- lib/mrsk/commands/accessory.rb
 - lib/mrsk/commands/app.rb
 - lib/mrsk/commands/base.rb
 - lib/mrsk/commands/builder.rb
+- lib/mrsk/commands/builder/base.rb
 - lib/mrsk/commands/builder/multiarch.rb
 - lib/mrsk/commands/builder/multiarch/remote.rb
 - lib/mrsk/commands/builder/native.rb
+- lib/mrsk/commands/builder/native/remote.rb
 - lib/mrsk/commands/prune.rb
 - lib/mrsk/commands/registry.rb
 - lib/mrsk/commands/traefik.rb
 - lib/mrsk/configuration.rb
+- lib/mrsk/configuration/accessory.rb
 - lib/mrsk/configuration/role.rb
+- lib/mrsk/sshkit_with_ext.rb
+- lib/mrsk/utils.rb
 - lib/mrsk/version.rb
 homepage: https://github.com/rails/mrsk
 licenses:
@@ -106,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.5
 signing_key:
 specification_version: 4
 summary: Deploy Rails apps in containers to servers running Docker with zero downtime.