dk-abdeploy 0.0.1 → 0.1.0

data/lib/dk-abdeploy/version.rb

@@ -1,4 +1,4 @@
 module Dk; end
 module Dk::ABDeploy
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/test/support/validate.rb

@@ -0,0 +1,27 @@
+require 'much-plugin'
+require 'dk/task'
+require 'dk-abdeploy/validate'
+
+class Dk::ABDeploy::Validate
+
+  module TestHelpers
+    include MuchPlugin
+
+    plugin_included do
+
+      # this just adds an extra setup block just for dk-abdeploy tests
+      setup do
+        @root      = @dk_abdeploy_root
+        @repo      = @dk_abdeploy_repo
+        @shared    = @dk_abdeploy_shared
+        @current   = @dk_abdeploy_current
+        @releases  = @dk_abdeploy_releases
+        @release_a = @dk_abdeploy_release_a
+        @release_b = @dk_abdeploy_release_b
+      end
+
+    end
+
+  end
+
+end

data/test/unit/cleanup_tests.rb

@@ -0,0 +1,97 @@
+require 'assert'
+require 'dk-abdeploy/cleanup'
+
+require 'dk/task'
+require 'dk/task_run'
+require 'dk-abdeploy'
+require 'dk-abdeploy/update'
+require 'test/support/validate'
+
+class Dk::ABDeploy::Cleanup
+
+  class UnitTests < Assert::Context
+    desc "Dk::ABDeploy::Cleanup"
+    setup do
+      @task_class = Dk::ABDeploy::Cleanup
+    end
+    subject{ @task_class }
+
+    should "be a Dk task" do
+      assert_includes Dk::Task, subject
+    end
+
+    should "know its description" do
+      exp = "(dk-abdeploy) update the non-deploy release's source post-update"
+      assert_equal exp, subject.description
+    end
+
+    should "run the Validate task as a before callback" do
+      assert_equal [Dk::ABDeploy::Validate], subject.before_callback_task_classes
+    end
+
+  end
+
+  class InitTests < UnitTests
+    include Dk::ABDeploy::Update::TestHelpers
+
+    desc "when init"
+    setup do
+      @params.merge!({
+        Dk::ABDeploy::REF_PARAM_NAME => Factory.hex,
+      })
+      @runner = test_runner(@task_class, :params => @params)
+      @task = @runner.task
+    end
+    subject{ @task }
+
+    should "know its ssh hosts" do
+      assert_equal Dk::ABDeploy::SSH_HOSTS_GROUP_NAME, subject.dk_dsl_ssh_hosts
+    end
+
+  end
+
+  class RunTests < InitTests
+    desc "and run"
+    setup do
+      @runner.run
+    end
+    subject{ @runner }
+
+    should "run the Validate callback and 1 ssh cmd" do
+      assert_equal 2, subject.runs.size
+    end
+
+    should "run an ssh cmd to reset the current release git repo" do
+      _, git_reset_ssh = subject.runs
+
+      repo_dir = @params[Dk::ABDeploy::CURRENT_RELEASE_DIR_PARAM_NAME]
+      ref      = @params[Dk::ABDeploy::REF_PARAM_NAME]
+      exp      = Dk::ABDeploy::Update.git_reset_cmd_str(repo_dir, ref)
+      assert_equal exp, git_reset_ssh.cmd_str
+    end
+
+    should "complain if the current release dir or ref params aren't set" do
+      value = [nil, ''].sample
+
+      runner = test_runner(@task_class, :params => {
+        Dk::ABDeploy::REF_PARAM_NAME                 => value,
+        Dk::ABDeploy::CURRENT_RELEASE_DIR_PARAM_NAME => value
+      })
+      assert_raises(ArgumentError){ runner.run }
+
+      runner = test_runner(@task_class, :params => {
+        Dk::ABDeploy::REF_PARAM_NAME                 => Factory.string,
+        Dk::ABDeploy::CURRENT_RELEASE_DIR_PARAM_NAME => value
+      })
+      assert_raises(ArgumentError){ runner.run }
+
+      runner = test_runner(@task_class, :params => {
+        Dk::ABDeploy::REF_PARAM_NAME                 => value,
+        Dk::ABDeploy::CURRENT_RELEASE_DIR_PARAM_NAME => Factory.string
+      })
+      assert_raises(ArgumentError){ runner.run }
+    end
+
+  end
+
+end

data/test/unit/dk-abdeploy_tests.rb

@@ -0,0 +1,42 @@
+require 'assert'
+require 'dk-abdeploy'
+
+module Dk::ABDeploy
+
+  class UnitTests < Assert::Context
+    desc "Dk::ABDeploy"
+    setup do
+      @deploy_module = Dk::ABDeploy
+    end
+    subject{ @deploy_module }
+
+    should "know its dir/link names" do
+      assert_equal 'shared',   subject::SHARED_DIR_NAME
+      assert_equal 'releases', subject::RELEASES_DIR_NAME
+      assert_equal 'A',        subject::RELEASE_A_DIR_NAME
+      assert_equal 'B',        subject::RELEASE_B_DIR_NAME
+      assert_equal 'current',  subject::CURRENT_LINK_NAME
+    end
+
+    should "know its param names" do
+      s = subject
+      assert_equal 'dk_abdeploy_root',                s::ROOT_PARAM_NAME
+      assert_equal 'dk_abdeploy_shared_dir',          s::SHARED_DIR_PARAM_NAME
+      assert_equal 'dk_abdeploy_current_dir',         s::CURRENT_DIR_PARAM_NAME
+      assert_equal 'dk_abdeploy_releases_dir',        s::RELEASES_DIR_PARAM_NAME
+      assert_equal 'dk_abdeploy_release_a_dir',       s::RELEASE_A_DIR_PARAM_NAME
+      assert_equal 'dk_abdeploy_release_b_dir',       s::RELEASE_B_DIR_PARAM_NAME
+      assert_equal 'dk_abdeploy_current_release_dir', s::CURRENT_RELEASE_DIR_PARAM_NAME
+      assert_equal 'dk_abdeploy_deploy_release_dir',  s::DEPLOY_RELEASE_DIR_PARAM_NAME
+      assert_equal 'dk_abdeploy_repo',                s::REPO_PARAM_NAME
+      assert_equal 'dk_abdeploy_ref',                 s::REF_PARAM_NAME
+      assert_equal 'dk_abdeploy_primary_ssh_host',    s::PRIMARY_SSH_HOST_PARAM_NAME
+    end
+
+    should "know its ssh hosts group name" do
+      assert_equal 'dk_abdeploy_servers', subject::SSH_HOSTS_GROUP_NAME
+    end
+
+  end
+
+end

data/test/unit/link_tests.rb

@@ -0,0 +1,84 @@
+require 'assert'
+require 'dk-abdeploy/link'
+
+require 'dk/task'
+require 'dk/task_run'
+require 'dk-abdeploy'
+require 'test/support/validate'
+
+class Dk::ABDeploy::Link
+
+  class UnitTests < Assert::Context
+    desc "Dk::ABDeploy::Link"
+    setup do
+      @task_class = Dk::ABDeploy::Link
+    end
+    subject{ @task_class }
+
+    should "be a Dk task" do
+      assert_includes Dk::Task, subject
+    end
+
+    should "know its description" do
+      exp = "(dk-abdeploy) link the deploy release dir as the current dir"
+      assert_equal exp, subject.description
+    end
+
+    should "run the Validate task as a before callback" do
+      assert_equal [Dk::ABDeploy::Validate], subject.before_callback_task_classes
+    end
+
+  end
+
+  class InitTests < UnitTests
+    include Dk::ABDeploy::Validate::TestHelpers
+
+    desc "when init"
+    setup do
+      release_dirs = [
+        @params[Dk::ABDeploy::RELEASE_A_DIR_PARAM_NAME],
+        @params[Dk::ABDeploy::RELEASE_B_DIR_PARAM_NAME]
+      ]
+      @params[Dk::ABDeploy::DEPLOY_RELEASE_DIR_PARAM_NAME] = release_dirs.sample
+
+      @runner = test_runner(@task_class, :params => @params)
+      @task = @runner.task
+    end
+    subject{ @task }
+
+    should "know its ssh hosts" do
+      assert_equal Dk::ABDeploy::SSH_HOSTS_GROUP_NAME, subject.dk_dsl_ssh_hosts
+    end
+
+  end
+
+  class RunTests < InitTests
+    desc "and run"
+    setup do
+      @runner.run
+    end
+    subject{ @runner }
+
+    should "run the Validate task callback and 1 ssh cmd" do
+      assert_equal 2, subject.runs.size
+    end
+
+    should "run an ssh cmds to link the deploy release dir as the current dir" do
+      _, link_ssh = subject.runs
+      curr_dir    = @params[Dk::ABDeploy::CURRENT_DIR_PARAM_NAME]
+      release_dir = @params[Dk::ABDeploy::DEPLOY_RELEASE_DIR_PARAM_NAME]
+
+      exp = "rm -f #{curr_dir} && ln -s #{release_dir} #{curr_dir}"
+      assert_equal exp, link_ssh.cmd_str
+    end
+
+    should "complain if the deploy release dir param isn't set" do
+      runner = test_runner(@task_class, :params => {
+        Dk::ABDeploy::DEPLOY_RELEASE_DIR_PARAM_NAME => [nil, ''].sample
+      })
+      assert_raises(ArgumentError){ runner.run }
+    end
+
+  end
+
+end

data/test/unit/setup_tests.rb

@@ -0,0 +1,84 @@
+require 'assert'
+require 'dk-abdeploy/setup'
+
+require 'dk/task'
+require 'dk/task_run'
+require 'dk-abdeploy'
+require 'test/support/validate'
+
+class Dk::ABDeploy::Setup
+
+  class UnitTests < Assert::Context
+    desc "Dk::ABDeploy::Setup"
+    setup do
+      @task_class = Dk::ABDeploy::Setup
+    end
+    subject{ @task_class }
+
+    should "be a Dk task" do
+      assert_includes Dk::Task, subject
+    end
+
+    should "know its description" do
+      exp = "(dk-abdeploy) create the dirs and clone the repos for the A/B deploy scheme"
+      assert_equal exp, subject.description
+    end
+
+    should "run the Validate task as a before callback" do
+      assert_equal [Dk::ABDeploy::Validate], subject.before_callback_task_classes
+    end
+
+  end
+
+  class InitTests < UnitTests
+    include Dk::ABDeploy::Validate::TestHelpers
+
+    desc "when init"
+    setup do
+      @runner = test_runner(@task_class, :params => @params)
+      @task = @runner.task
+    end
+    subject{ @task }
+
+    should "know its ssh hosts" do
+      assert_equal Dk::ABDeploy::SSH_HOSTS_GROUP_NAME, subject.dk_dsl_ssh_hosts
+    end
+
+  end
+
+  class RunTests < InitTests
+    desc "and run"
+    setup do
+      @runner.run
+    end
+    subject{ @runner }
+
+    should "run the Validate task callback and 3 ssh cmds" do
+      assert_equal 4, subject.runs.size
+    end
+
+    should "run ssh cmds to make the dirs and clone the A/B repos" do
+      _, mkdir_ssh, clone_a_ssh, clone_b_ssh = subject.runs
+
+      exp = "mkdir -p #{@root} #{@shared} #{@releases} #{@release_a} #{@release_b}"
+      assert_equal exp, mkdir_ssh.cmd_str
+
+      exp = clone_cmd_str(@repo, @release_a)
+      assert_equal exp, clone_a_ssh.cmd_str
+
+      exp = clone_cmd_str(@repo, @release_b)
+      assert_equal exp, clone_b_ssh.cmd_str
+    end
+
+    private
+
+    def clone_cmd_str(repo, release_dir)
+      "if [ -d #{release_dir}/.git ]; " \
+      "then echo 'repo already cloned'; " \
+      "else git clone -q  #{repo} #{release_dir}; " \
+      "fi"
+    end
+
+  end
+
+end

data/test/unit/update_tests.rb

@@ -0,0 +1,230 @@
+require 'assert'
+require 'dk-abdeploy/update'
+
+require 'dk/task'
+require 'dk/task_run'
+require 'dk-abdeploy'
+require 'test/support/validate'
+
+class Dk::ABDeploy::Update
+
+  class UnitTests < Assert::Context
+    desc "Dk::ABDeploy::Update"
+    setup do
+      @task_class = Dk::ABDeploy::Update
+    end
+    subject{ @task_class }
+
+    should have_imeths :readlink_cmd_str, :git_reset_cmd_str
+
+    should "be a Dk task" do
+      assert_includes Dk::Task, subject
+    end
+
+    should "know its description" do
+      exp = "(dk-abdeploy) update the non-current release's source"
+      assert_equal exp, subject.description
+    end
+
+    should "run the Validate task as a before callback" do
+      assert_equal [Dk::ABDeploy::Validate], subject.before_callback_task_classes
+    end
+
+    should "build readlink cmd strs" do
+      link = Factory.path
+
+      exp = "readlink #{link}"
+      assert_equal exp, subject.readlink_cmd_str(link)
+    end
+
+    should "build git reset cmd strs" do
+      repo_dir = Factory.path
+      ref      = Factory.string
+
+      exp = "cd #{repo_dir} && " \
+            "git fetch -q origin && " \
+            "git reset -q --hard #{ref} && " \
+            "git clean -q -d -x -f"
+      assert_equal exp, subject.git_reset_cmd_str(repo_dir, ref)
+    end
+
+  end
+
+  class InitTests < UnitTests
+    include Dk::ABDeploy::Validate::TestHelpers
+
+    desc "when init"
+    setup do
+      @params.merge!({
+        Dk::ABDeploy::REF_PARAM_NAME              => Factory.hex,
+        Dk::ABDeploy::PRIMARY_SSH_HOST_PARAM_NAME => "#{Factory.string}.example.com"
+      })
+      @runner = test_runner(@task_class, :params => @params)
+      @task = @runner.task
+    end
+    subject{ @task }
+
+    should "know its ssh hosts" do
+      assert_equal Dk::ABDeploy::SSH_HOSTS_GROUP_NAME, subject.dk_dsl_ssh_hosts
+    end
+
+  end
+
+  class RunTests < InitTests
+    desc "and run"
+    setup do
+      @curr_link  = @params[Dk::ABDeploy::CURRENT_DIR_PARAM_NAME]
+      @rl_cmd_str = @task_class.readlink_cmd_str(@curr_link)
+
+      @runner.run
+    end
+    subject{ @runner }
+
+    should "run the Validate task callback, 1 cmd and 1 ssh cmd" do
+      assert_equal 3, subject.runs.size
+    end
+
+    should "run a readlink ssh to set or default the current release dir param" do
+      _, rl_ssh, _ = subject.runs
+
+      exp = @task_class.readlink_cmd_str(@params[Dk::ABDeploy::CURRENT_DIR_PARAM_NAME])
+      assert_equal exp, rl_ssh.cmd_str
+      exp = [@params[Dk::ABDeploy::PRIMARY_SSH_HOST_PARAM_NAME]]
+      assert_equal exp, rl_ssh.cmd_opts[:hosts]
+    end
+
+    should "set the current release dir param or default it to the B dir if none" do
+      curr_release_dir = Factory.path
+      runner = test_runner(@task_class, :params => @params)
+      runner.stub_ssh(@rl_cmd_str, {
+        :opts => {
+          :hosts => @params[Dk::ABDeploy::PRIMARY_SSH_HOST_PARAM_NAME]
+        }
+      }){ |spy| spy.stdout = curr_release_dir }
+      runner.run
+      exp = curr_release_dir
+      assert_equal exp, runner.params[Dk::ABDeploy::CURRENT_RELEASE_DIR_PARAM_NAME]
+
+      runner = test_runner(@task_class, :params => @params)
+      runner.stub_ssh(@rl_cmd_str, {
+        :opts => {
+          :hosts => @params[Dk::ABDeploy::PRIMARY_SSH_HOST_PARAM_NAME]
+        }
+      }){ |spy| spy.stdout = '' }
+      runner.run
+      exp = @params[Dk::ABDeploy::RELEASE_B_DIR_PARAM_NAME]
+      assert_equal exp, runner.params[Dk::ABDeploy::CURRENT_RELEASE_DIR_PARAM_NAME]
+    end
+
+    should "set the deploy release dir to the A dir by default" do
+      exp = @params[Dk::ABDeploy::RELEASE_A_DIR_PARAM_NAME]
+      assert_equal exp, subject.params[Dk::ABDeploy::DEPLOY_RELEASE_DIR_PARAM_NAME]
+    end
+
+    should "set the deploy release dir to the non-current release dir" do
+      # if current is A, set deploy to B
+      curr_release_dir = @params[Dk::ABDeploy::RELEASE_A_DIR_PARAM_NAME]
+      runner = test_runner(@task_class, :params => @params)
+      runner.stub_ssh(@rl_cmd_str, {
+        :opts => {
+          :hosts => @params[Dk::ABDeploy::PRIMARY_SSH_HOST_PARAM_NAME]
+        }
+      }){ |spy| spy.stdout = curr_release_dir }
+      runner.run
+
+      exp = @params[Dk::ABDeploy::RELEASE_B_DIR_PARAM_NAME]
+      assert_equal exp, runner.params[Dk::ABDeploy::DEPLOY_RELEASE_DIR_PARAM_NAME]
+
+      # if current is B, set deploy to A
+      curr_release_dir = @params[Dk::ABDeploy::RELEASE_B_DIR_PARAM_NAME]
+      runner = test_runner(@task_class, :params => @params)
+      runner.stub_ssh(@rl_cmd_str, {
+        :opts => {
+          :hosts => @params[Dk::ABDeploy::PRIMARY_SSH_HOST_PARAM_NAME]
+        }
+      }){ |spy| spy.stdout = curr_release_dir }
+      runner.run
+
+      exp = @params[Dk::ABDeploy::RELEASE_A_DIR_PARAM_NAME]
+      assert_equal exp, runner.params[Dk::ABDeploy::DEPLOY_RELEASE_DIR_PARAM_NAME]
+    end
+
+    should "run an ssh cmd to reset the deploy release git repo" do
+      _, _, git_reset_ssh = subject.runs
+      repo_dir = @params[Dk::ABDeploy::RELEASE_A_DIR_PARAM_NAME]
+      ref      = @params[Dk::ABDeploy::REF_PARAM_NAME]
+
+      exp = @task_class.git_reset_cmd_str(repo_dir, ref)
+      assert_equal exp, git_reset_ssh.cmd_str
+    end
+
+    should "complain if the ref/host params aren't set" do
+      value = [nil, ''].sample
+
+      runner = test_runner(@task_class, :params => {
+        Dk::ABDeploy::REF_PARAM_NAME              => value,
+        Dk::ABDeploy::PRIMARY_SSH_HOST_PARAM_NAME => value
+      })
+      assert_raises(ArgumentError){ runner.run }
+
+      runner = test_runner(@task_class, :params => {
+        Dk::ABDeploy::REF_PARAM_NAME              => Factory.string,
+        Dk::ABDeploy::PRIMARY_SSH_HOST_PARAM_NAME => value
+      })
+      assert_raises(ArgumentError){ runner.run }
+
+      runner = test_runner(@task_class, :params => {
+        Dk::ABDeploy::REF_PARAM_NAME              => value,
+        Dk::ABDeploy::PRIMARY_SSH_HOST_PARAM_NAME => Factory.string
+      })
+      assert_raises(ArgumentError){ runner.run }
+    end
+
+    private
+
+    def readlink_cmd_str(task, link, ssh_opts)
+      ssh_cmd_str(task, "readlink #{link}", ssh_opts)
+    end
+
+  end
+
+  class TestHelpersTests < UnitTests
+    desc "TestHelpers"
+    setup do
+      @context_class = Class.new do
+        def self.setup_blocks; @setup_blocks ||= []; end
+        def self.setup(&block)
+          self.setup_blocks << block
+        end
+        include Dk::ABDeploy::Update::TestHelpers
+        attr_reader :params
+        def initialize
+          self.class.setup_blocks.each{ |b| self.instance_eval(&b) }
+        end
+      end
+      @context = @context_class.new
+    end
+    subject{ @context }
+
+    should "use much-plugin" do
+      assert_includes MuchPlugin, @context_class
+    end
+
+    should "setup the params the update task does" do
+      exp_release_dirs = [
+        subject.params[Dk::ABDeploy::RELEASE_A_DIR_PARAM_NAME],
+        subject.params[Dk::ABDeploy::RELEASE_B_DIR_PARAM_NAME]
+      ]
+
+      exp_release_dirs.delete(
+        subject.params[Dk::ABDeploy::CURRENT_RELEASE_DIR_PARAM_NAME]
+      )
+      assert_equal 1, exp_release_dirs.size
+
+      exp = exp_release_dirs.first
+      assert_equal exp, subject.params[Dk::ABDeploy::DEPLOY_RELEASE_DIR_PARAM_NAME]
+    end
+
+  end
+
+end