Merge pull request #145 from basecamp/config-version

Commander needn't accumulate configuration

lib/mrsk/cli/app.rb

@@ -37,7 +37,7 @@ class Mrsk::Cli::App < Mrsk::Cli::Base
   desc "start", "Start existing app container on servers"
   def start
     on(MRSK.hosts) do
-      execute *MRSK.auditor.record("Started app version #{MRSK.version}"), verbosity: :debug
+      execute *MRSK.auditor.record("Started app version #{MRSK.config.version}"), verbosity: :debug
       execute *MRSK.app.start, raise_on_non_zero_exit: false
     end
   end

lib/mrsk/cli/base.rb

@@ -39,14 +39,6 @@ module Mrsk::Cli
 
       def initialize_commander(options)
         MRSK.tap do |commander|
-          commander.config_file = Pathname.new(File.expand_path(options[:config_file]))
-          commander.destination = options[:destination]
-          commander.version     = options[:version]
-
-          commander.specific_hosts    = options[:hosts]&.split(",")
-          commander.specific_roles    = options[:roles]&.split(",")
-          commander.specific_primary! if options[:primary]
-
           if options[:verbose]
             ENV["VERBOSE"] = "1" # For backtraces via cli/start
             commander.verbosity = :debug
@@ -55,6 +47,15 @@ module Mrsk::Cli
           if options[:quiet]
             commander.verbosity = :error
           end
+
+          commander.configure \
+            config_file: Pathname.new(File.expand_path(options[:config_file])),
+            destination: options[:destination],
+            version: options[:version]
+
+          commander.specific_hosts    = options[:hosts]&.split(",")
+          commander.specific_roles    = options[:roles]&.split(",")
+          commander.specific_primary! if options[:primary]
         end
       end
 

lib/mrsk/cli/build.rb

@@ -29,7 +29,7 @@ class Mrsk::Cli::Build < Mrsk::Cli::Base
   desc "pull", "Pull app image from registry onto servers"
   def pull
     on(MRSK.hosts) do
-      execute *MRSK.auditor.record("Pulled image with version #{MRSK.version}"), verbosity: :debug
+      execute *MRSK.auditor.record("Pulled image with version #{MRSK.config.version}"), verbosity: :debug
       execute *MRSK.builder.clean, raise_on_non_zero_exit: false
       execute *MRSK.builder.pull
     end

lib/mrsk/cli/main.rb

@@ -68,7 +68,7 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
 
   desc "rollback [VERSION]", "Rollback app to VERSION"
   def rollback(version)
-    MRSK.version = version
+    MRSK.config.version = version
 
     if container_name_available?(MRSK.config.service_with_version)
       say "Start version #{version}, then wait #{MRSK.config.readiness_delay}s for app to boot before stopping the old version...", :magenta

lib/mrsk/commander.rb

@@ -1,19 +1,26 @@
 require "active_support/core_ext/enumerable"
+require "active_support/core_ext/module/delegation"
 
 class Mrsk::Commander
-  attr_accessor :config_file, :destination, :verbosity, :version
+  attr_accessor :verbosity
 
-  def initialize(config_file: nil, destination: nil, verbosity: :info)
+  def initialize
-    @config_file, @destination, @verbosity = config_file, destination, verbosity
+    self.verbosity = :info
   end
 
+
   def config
-    @config ||= \
+    @config ||= Mrsk::Configuration.create_from(**@config_kwargs).tap do |config|
-      Mrsk::Configuration
+      @config_kwargs = nil
-        .create_from(config_file, destination: destination, version: cascading_version)
+      configure_sshkit_with(config)
-        .tap { |config| configure_sshkit_with(config) }
+    end
   end
 
+  def configure(**kwargs)
+    @config, @config_kwargs = nil, kwargs
+  end
+
+
   attr_accessor :specific_hosts
 
   def specific_primary!
@@ -90,26 +97,15 @@ class Mrsk::Commander
     SSHKit.config.output_verbosity = old_level
   end
 
+
   # Test-induced damage!
   def reset
-    @config = @config_file = @destination = @version = nil
+    @config = nil
     @app = @builder = @traefik = @registry = @prune = @auditor = nil
     @verbosity = :info
   end
 
   private
-    def cascading_version
-      version.presence || ENV["VERSION"] || current_commit_hash
-    end
-
-    def current_commit_hash
-      if system("git rev-parse")
-        `git rev-parse HEAD`.strip
-      else
-        raise "Can't use commit hash as version, no git repository found in #{Dir.pwd}"
-      end
-    end
-
     # Lazy setup of SSHKit
     def configure_sshkit_with(config)
       SSHKit::Backend::Netssh.configure { |ssh| ssh.ssh_options = config.ssh_options }

lib/mrsk/configuration.rb

@@ -9,13 +9,12 @@ class Mrsk::Configuration
   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 :version
   attr_accessor :destination
   attr_accessor :raw_config
 
   class << self
-    def create_from(base_config_file, destination: nil, version: "missing")
+    def create_from(config_file:, destination: nil, version: nil)
-      raw_config = load_config_files(base_config_file, *destination_config_file(base_config_file, destination))
+      raw_config = load_config_files(config_file, *destination_config_file(config_file, destination))
 
       new raw_config, destination: destination, version: version
     end
@@ -38,14 +37,22 @@ class Mrsk::Configuration
       end
   end
 
-  def initialize(raw_config, destination: nil, version: "missing", validate: true)
+  def initialize(raw_config, destination: nil, version: nil, validate: true)
     @raw_config = ActiveSupport::InheritableOptions.new(raw_config)
     @destination = destination
-    @version = version
+    @declared_version = version
     valid? if validate
   end
 
 
+  def version=(version)
+    @declared_version = version
+  end
+
+  def version
+    @declared_version.presence || ENV["VERSION"] || current_commit_hash
+  end
+
   def abbreviated_version
     Mrsk::Utils.abbreviate_version(version)
   end
@@ -73,7 +80,7 @@ class Mrsk::Configuration
   end
 
   def primary_web_host
-    role(:web).hosts.first
+    role(:web).primary_host
   end
 
   def traefik_hosts
@@ -189,6 +196,12 @@ class Mrsk::Configuration
         raise ArgumentError, "You must specify a password for the registry in config/deploy.yml (or set the ENV variable if that's used)"
       end
 
+      roles.each do |role|
+        if role.hosts.empty?
+          raise ArgumentError, "No servers specified for the #{role.name} role"
+        end
+      end
+
       true
     end
 
@@ -203,4 +216,13 @@ class Mrsk::Configuration
     def role_names
       raw_config.servers.is_a?(Array) ? [ "web" ] : raw_config.servers.keys.sort
     end
+
+    def current_commit_hash
+      @current_commit_hash ||=
+        if system("git rev-parse")
+          `git rev-parse HEAD`.strip
+        else
+          raise "Can't use commit hash as version, no git repository found in #{Dir.pwd}"
+        end
+    end
 end

lib/mrsk/configuration/role.rb

@@ -7,6 +7,10 @@ class Mrsk::Configuration::Role
    @name, @config = name.inquiry, config
   end
 
+  def primary_host
+    hosts.first
+  end
+
   def hosts
     @hosts ||= extract_hosts_from_config
   end
@@ -55,7 +59,7 @@ class Mrsk::Configuration::Role
         config.servers
       else
         servers = config.servers[name]
-        servers.is_a?(Array) ? servers : servers["hosts"]
+        servers.is_a?(Array) ? servers : Array(servers["hosts"])
       end
     end
 

test/cli/main_test.rb

@@ -126,7 +126,7 @@ class CliMainTest < CliTestCase
   end
 
   test "config" do
-    run_command("config").tap do |output|
+    run_command("config", config_file: "deploy_with_accessories").tap do |output|
       config = YAML.load(output)
 
       assert_equal ["web"], config[:roles]
@@ -138,6 +138,32 @@ class CliMainTest < CliTestCase
     end
   end
 
+  test "config with roles" do
+    run_command("config", config_file: "deploy_with_roles").tap do |output|
+      config = YAML.load(output)
+
+      assert_equal ["web", "workers"], config[:roles]
+      assert_equal ["1.1.1.1", "1.1.1.2", "1.1.1.3", "1.1.1.4"], config[:hosts]
+      assert_equal "999", config[:version]
+      assert_equal "registry.digitalocean.com/dhh/app", config[:repository]
+      assert_equal "registry.digitalocean.com/dhh/app:999", config[:absolute_image]
+      assert_equal "app-999", config[:service_with_version]
+    end
+  end
+
+  test "config with destination" do
+    run_command("config", "-d", "world", config_file: "deploy_for_dest").tap do |output|
+      config = YAML.load(output)
+
+      assert_equal ["web"], config[:roles]
+      assert_equal ["1.1.1.1", "1.1.1.2"], config[:hosts]
+      assert_equal "999", config[:version]
+      assert_equal "registry.digitalocean.com/dhh/app", config[:repository]
+      assert_equal "registry.digitalocean.com/dhh/app:999", config[:absolute_image]
+      assert_equal "app-999", config[:service_with_version]
+    end
+  end
+
   test "init" do
     Pathname.any_instance.expects(:exist?).returns(false).twice
     FileUtils.stubs(:mkdir_p)
@@ -227,7 +253,7 @@ class CliMainTest < CliTestCase
   end
 
   private
-    def run_command(*command)
+    def run_command(*command, config_file: "deploy_with_accessories")
-      stdouted { Mrsk::Cli::Main.start([*command, "-c", "test/fixtures/deploy_with_accessories.yml"]) }
+      stdouted { Mrsk::Cli::Main.start([*command, "-c", "test/fixtures/#{config_file}.yml"]) }
     end
 end

test/commander_test.rb

@@ -2,23 +2,15 @@ require "test_helper"
 
 class CommanderTest < ActiveSupport::TestCase
   setup do
-    @mrsk = Mrsk::Commander.new config_file: Pathname.new(File.expand_path("fixtures/deploy_with_roles.yml", __dir__))
+    @mrsk = Mrsk::Commander.new.tap do |mrsk|
+      mrsk.configure config_file: Pathname.new(File.expand_path("fixtures/deploy_with_roles.yml", __dir__))
+    end
   end
 
   test "lazy configuration" do
     assert_equal Mrsk::Configuration, @mrsk.config.class
   end
 
-  test "commit hash as version" do
-    assert_equal `git rev-parse HEAD`.strip, @mrsk.config.version
-  end
-
-  test "commit hash as version but not in git" do
-    @mrsk.expects(:system).with("git rev-parse").returns(nil)
-    error = assert_raises(RuntimeError) { @mrsk.config }
-    assert_match /no git repository found/, error.message
-  end
-
   test "overwriting hosts" do
     assert_equal [ "1.1.1.1", "1.1.1.2", "1.1.1.3", "1.1.1.4" ], @mrsk.hosts
 

test/configuration_test.rb

@@ -3,6 +3,7 @@ require "test_helper"
 class ConfigurationTest < ActiveSupport::TestCase
   setup do
     ENV["RAILS_MASTER_KEY"] = "456"
+    ENV["VERSION"] = "missing"
 
     @deploy = {
       service: "app", image: "dhh/app",
@@ -21,17 +22,23 @@ class ConfigurationTest < ActiveSupport::TestCase
   end
 
   teardown do
-    ENV["RAILS_MASTER_KEY"] = nil
+    ENV.delete("RAILS_MASTER_KEY")
+    ENV.delete("VERSION")
   end
 
-  test "ensure valid keys" do
+  %i[ service image registry ].each do |key|
-    assert_raise(ArgumentError) do
+    test "#{key} config required" do
-      Mrsk::Configuration.new(@deploy.tap { _1.delete(:service) })
+      assert_raise(ArgumentError) do
-      Mrsk::Configuration.new(@deploy.tap { _1.delete(:image) })
+        Mrsk::Configuration.new @deploy.tap { _1.delete key }
-      Mrsk::Configuration.new(@deploy.tap { _1.delete(:registry) })
+      end
+    end
+  end
 
-      Mrsk::Configuration.new(@deploy.tap { _1[:registry].delete("username") })
+  %w[ username password ].each do |key|
-      Mrsk::Configuration.new(@deploy.tap { _1[:registry].delete("password") })
+    test "registry #{key} required" do
+      assert_raise(ArgumentError) do
+        Mrsk::Configuration.new @deploy.tap { _1[:registry].delete key }
+      end
     end
   end
 
@@ -66,8 +73,20 @@ class ConfigurationTest < ActiveSupport::TestCase
   end
 
   test "version" do
-    assert_equal "missing", @config.version
+    ENV.delete("VERSION")
-    assert_equal "123", Mrsk::Configuration.new(@deploy, version: "123").version
+
+    @config.expects(:system).with("git rev-parse").returns(nil)
+    error = assert_raises(RuntimeError) { @config.version}
+    assert_match /no git repository found/, error.message
+
+    @config.expects(:current_commit_hash).returns("git-version")
+    assert_equal "git-version", @config.version
+
+    ENV["VERSION"] = "env-version"
+    assert_equal "env-version", @config.version
+
+    @config.version = "arg-version"
+    assert_equal "arg-version", @config.version
   end
 
   test "repository" do
@@ -134,6 +153,39 @@ class ConfigurationTest < ActiveSupport::TestCase
 
   test "valid config" do
     assert @config.valid?
+    assert @config_with_roles.valid?
+  end
+
+  test "hosts required for all roles" do
+    # Empty server list for implied web role
+    assert_raises(ArgumentError) do
+      Mrsk::Configuration.new @deploy.merge(servers: [])
+    end
+
+    # Empty server list
+    assert_raises(ArgumentError) do
+      Mrsk::Configuration.new @deploy.merge(servers: { "web" => [] })
+    end
+
+    # Missing hosts key
+    assert_raises(ArgumentError) do
+      Mrsk::Configuration.new @deploy.merge(servers: { "web" => {} })
+    end
+
+    # Empty hosts list
+    assert_raises(ArgumentError) do
+      Mrsk::Configuration.new @deploy.merge(servers: { "web" => { "hosts" => [] } })
+    end
+
+    # Nil hosts
+    assert_raises(ArgumentError) do
+      Mrsk::Configuration.new @deploy.merge(servers: { "web" => { "hosts" => nil } })
+    end
+
+    # One role with hosts, one without
+    assert_raises(ArgumentError) do
+      Mrsk::Configuration.new @deploy.merge(servers: { "web" => %w[ web ], "workers" => { "hosts" => %w[ ] } })
+    end
   end
 
   test "ssh options" do
@@ -158,17 +210,17 @@ class ConfigurationTest < ActiveSupport::TestCase
   end
 
   test "erb evaluation of yml config" do
-    config = Mrsk::Configuration.create_from Pathname.new(File.expand_path("fixtures/deploy.erb.yml", __dir__))
+    config = Mrsk::Configuration.create_from config_file: Pathname.new(File.expand_path("fixtures/deploy.erb.yml", __dir__))
     assert_equal "my-user", config.registry["username"]
   end
 
   test "destination yml config merge" do
     dest_config_file = Pathname.new(File.expand_path("fixtures/deploy_for_dest.yml", __dir__))
 
-    config = Mrsk::Configuration.create_from dest_config_file, destination: "world"
+    config = Mrsk::Configuration.create_from config_file: dest_config_file, destination: "world"
     assert_equal "1.1.1.1", config.all_hosts.first
 
-    config = Mrsk::Configuration.create_from dest_config_file, destination: "mars"
+    config = Mrsk::Configuration.create_from config_file: dest_config_file, destination: "mars"
     assert_equal "1.1.1.3", config.all_hosts.first
   end
 
@@ -176,7 +228,7 @@ class ConfigurationTest < ActiveSupport::TestCase
     dest_config_file = Pathname.new(File.expand_path("fixtures/deploy_for_dest.yml", __dir__))
 
     assert_raises(RuntimeError) do
-      config = Mrsk::Configuration.create_from dest_config_file, destination: "missing"
+      config = Mrsk::Configuration.create_from config_file: dest_config_file, destination: "missing"
     end
   end
 

test/fixtures/deploy_with_roles.yml

@@ -5,8 +5,9 @@ servers:
     - 1.1.1.1
     - 1.1.1.2
   workers:
-    - 1.1.1.3
+    hosts:
-    - 1.1.1.4
+      - 1.1.1.3
+      - 1.1.1.4
 env:
   REDIS_URL: redis://x/y
 registry: