capistrano-fanfare 0.0.1

data/spec/fixtures/Procfile

@@ -0,0 +1,2 @@
+web: bundle exec thin start
+job: bundle exec rake jobs:work

data/spec/fixtures/fanfare/bark.rb

@@ -0,0 +1,14 @@
+module Capistrano::Fanfare::Bark
+  def self.load_into(configuration)
+    configuration.load do
+      task :bark do
+        set :message, 'ruff ruff'
+        message
+      end
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Capistrano::Fanfare::Bark.load_into(Capistrano::Configuration.instance)
+end

data/spec/fixtures/fanfare/meow.rb

@@ -0,0 +1,14 @@
+module Capistrano::Fanfare::Meow
+  def self.load_into(configuration)
+    configuration.load do
+      task :meow do
+        'purr purr'
+      end
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Capistrano::Fanfare::Meow.load_into(Capistrano::Configuration.instance)
+end
+

data/spec/foreman/strategy/runit_spec.rb

@@ -0,0 +1,83 @@
+require 'minitest/autorun'
+require 'minitest/capistrano'
+require 'capistrano/fanfare'
+require 'capistrano/fanfare/foreman/strategy/runit'
+
+describe Capistrano::Fanfare::Foreman::Strategy::Runit do
+  before do
+    @config = Capistrano::Configuration.new
+    @config.extend(MiniTest::Capistrano::ConfigurationExtension)
+  end
+
+  let(:strategy) { Capistrano::Fanfare::Foreman::Strategy::Runit.new(@config) }
+
+  it "#export generates runit services from the Procfile" do
+    @config.set :current_release, "/srv/fooapp/releases/thisone"
+    @config.set :foreman_cmd, "bin/foreman"
+    @config.set :shared_path, "/srv/fooapp/shared"
+    @config.set :runit_sv_path, "/srv/fooapp/shared/sv"
+    @config.set :runit_app_name, "fooapp_production"
+    @config.set :user, "deploy"
+    strategy.export
+
+    @config.must_have_run [
+      "cd /srv/fooapp/releases/thisone &&",
+      "if [ -f Procfile ] ; then",
+      "mkdir -p /srv/fooapp/shared/sv &&",
+      "bin/foreman export runit /srv/fooapp/shared/sv",
+      "--app=fooapp_production --log=/srv/fooapp/shared/log",
+      "--user=deploy &&",
+      "find /srv/fooapp/shared/sv -type f -name run",
+      "-exec chmod 755 {} \\; ; else",
+      "echo '>>>> A Procfile must exist in this project.' && exit 10 ; fi"
+    ].join(' ')
+  end
+
+  it "#register symlinks services in :runit_sv_path to :runit_service_path" do
+    @config.set :runit_sv_path, "/apps/foo/shared/sv"
+    @config.set :runit_service_path, "/home/foouser/service"
+    strategy.register
+
+    @config.must_have_run "ln -snf /apps/foo/shared/sv/* /home/foouser/service/"
+  end
+
+  describe "#start" do
+    it "starts all services without arguments" do
+      @config.set :runit_service_path, "/home/foouser/service"
+      @config.set :runit_app_name, "wuzzle_production"
+      strategy.start
+
+      @config.must_have_run "sv start /home/foouser/service/wuzzle_production-*"
+    end
+  end
+
+  describe "#stop" do
+    it "stops all services without arguments" do
+      @config.set :runit_service_path, "/home/foouser/service"
+      @config.set :runit_app_name, "wuzzle_production"
+      strategy.stop
+
+      @config.must_have_run "sv stop /home/foouser/service/wuzzle_production-*"
+    end
+  end
+
+  describe "#restart" do
+    it "restarts all services without arguments" do
+      @config.set :runit_service_path, "/home/foouser/service"
+      @config.set :runit_app_name, "wuzzle_production"
+      strategy.restart
+
+      @config.must_have_run "sv restart /home/foouser/service/wuzzle_production-*"
+    end
+  end
+
+  describe "#ps" do
+    it "returns all service process statuses" do
+      @config.set :runit_service_path, "/home/foouser/service"
+      @config.set :runit_app_name, "wuzzle_production"
+      strategy.ps
+
+      @config.must_have_run "sv status /home/foouser/service/wuzzle_production-*"
+    end
+  end
+end

data/spec/foreman_spec.rb

@@ -0,0 +1,234 @@
+require 'minitest/autorun'
+require 'minitest/capistrano'
+require 'capistrano/fanfare'
+require 'capistrano/fanfare/foreman'
+
+describe Capistrano::Fanfare::Foreman do
+  before do
+    @config = Capistrano::Configuration.new
+    @config.load "deploy"
+    Capistrano::Fanfare::Foreman.load_into(@config)
+    @config.extend(MiniTest::Capistrano::ConfigurationExtension)
+  end
+
+  describe "for variables" do
+    it "sets :local_procfile to 'Procfile'" do
+      @config.fetch(:local_procfile).must_equal "Procfile"
+    end
+
+    it "sets :user_home to the capistrano user's home directory" do
+      @config.captures_responses["echo $HOME"] = "/u/home/fooguy\n"
+
+      @config.fetch(:user_home).must_equal "/u/home/fooguy"
+    end
+
+    it "sets :foreman_cmd to 'foreman'" do
+      @config.fetch(:foreman_cmd).must_equal "foreman"
+    end
+
+    it "sets :foreman_export_via to :runit" do
+      @config.fetch(:foreman_export_via).must_equal :runit
+    end
+
+    it "sets :foreman_strategy to an Runit strategy" do
+      @config.fetch(:foreman_strategy).class.
+        must_equal Capistrano::Fanfare::Foreman::Strategy::Runit
+    end
+
+    it "sets :runit_service_path to :user_home/service" do
+      @config.set :user_home, "/home/app"
+
+      @config.fetch(:runit_service_path).must_equal "/home/app/service"
+    end
+
+    it "sets :runit_app_name to a combination of :application and :deploy_env" do
+      @config.set :application, "barness"
+      @config.set :deploy_env, "production"
+
+      @config.fetch(:runit_app_name).must_equal "barness_production"
+    end
+
+    it "sets :runit_sv_path to shared_path/sv" do
+      @config.set :shared_path, "/srv/wakka/shared"
+
+      @config.fetch(:runit_sv_path).must_equal "/srv/wakka/shared/sv"
+    end
+  end
+
+  describe "for namespace :foreman" do
+    let(:strategy)  { MiniTest::Mock.new }
+
+    before do
+      @config.set :foreman_strategy, strategy
+    end
+
+    describe "task :cp_env" do
+      it "copies env file from shared_path into current_release as .env" do
+        @config.set :shared_path, "/tmp/app/shared"
+        @config.set :current_release, "/tmp/app/releases/blah"
+        @config.find_and_execute_task("foreman:cp_env")
+
+        @config.must_have_run "cp /tmp/app/shared/env /tmp/app/releases/blah/.env"
+      end
+
+      it "gets called after deploy:updated_code task" do
+        @config.must_have_callback_after "deploy:update_code", "foreman:cp_env"
+      end
+    end
+
+    describe "task :run_cmd" do
+      before do
+        ENV['_FOREMAN_COMMAND'] = ENV['COMMAND']
+        ENV['COMMAND'] = "rake db:migrate"
+      end
+
+      after do
+        ENV['COMMAND'] = ENV.delete('_FOREMAN_COMMAND')
+      end
+
+      it "runs a command in a foreman environment context" do
+        @config.set :current_path, "/apps/fuyou/current"
+        @config.set :foreman_cmd, "bin/foreman"
+        @config.find_and_execute_task("foreman:run_cmd")
+
+        @config.must_have_run [
+          "cd /apps/fuyou/current &&",
+          "bin/foreman run 'rake db:migrate'"
+        ].join(' ')
+      end
+
+      it "raises an exception when ENV['COMMAND'] is not found" do
+        ENV.delete('COMMAND')
+        proc { @config.find_and_execute_task("foreman:run_cmd") }.
+          must_raise RuntimeError
+      end
+    end
+
+    describe "task :export" do
+      it "delegates to forman_strategy.export" do
+        strategy.expect :export, true
+        @config.find_and_execute_task("foreman:export")
+
+        strategy.verify
+      end
+    end
+
+    describe "task :register" do
+      it "delegates to forman_strategy.register" do
+        strategy.expect :register, true
+        @config.find_and_execute_task("foreman:register")
+
+        strategy.verify
+      end
+    end
+
+    describe "task :start" do
+      it "delegates to forman_strategy.start" do
+        strategy.expect :start, true
+        @config.find_and_execute_task("foreman:start")
+
+        strategy.verify
+      end
+    end
+
+    describe "task :stop" do
+      it "delegates to forman_strategy.stop" do
+        strategy.expect :stop, true
+        @config.find_and_execute_task("foreman:stop")
+
+        strategy.verify
+      end
+    end
+
+    describe "task :restart" do
+      it "delegates to forman_strategy.restart" do
+        strategy.expect :restart, true
+        @config.find_and_execute_task("foreman:restart")
+
+        strategy.verify
+      end
+    end
+
+    describe "task :ps" do
+      it "delegates to forman_strategy.ps" do
+        strategy.expect :ps, true
+        @config.find_and_execute_task("foreman:ps")
+
+        strategy.verify
+      end
+    end
+
+    describe "dynamic tasks" do
+      before do
+        ENV['PROCFILE'] =
+          File.expand_path(File.join(File.dirname(__FILE__), %w{fixtures Procfile}))
+        @config = Capistrano::Configuration.new
+        @config.load "deploy"
+        Capistrano::Fanfare::Foreman.load_into(@config)
+        @config.extend(MiniTest::Capistrano::ConfigurationExtension)
+        @config.set :foreman_strategy, strategy
+      end
+
+      after do
+        ENV.delete('PROCFILE')
+      end
+
+      describe "for namespace :start" do
+        it "creates a task for each Procfile entry (on client side copy)" do
+          @config.must_have_task "foreman:start:web"
+          @config.must_have_task "foreman:start:job"
+        end
+
+        it "task :web delegates to foreman_strategy.start" do
+          strategy.expect :start, true, ["web"]
+          @config.find_and_execute_task("foreman:start:web")
+
+          strategy.verify
+        end
+      end
+
+      describe "for namespace :stop" do
+        it "creates a task for each Procfile entry (on client side copy)" do
+          @config.must_have_task "foreman:stop:web"
+          @config.must_have_task "foreman:stop:job"
+        end
+
+        it "task :web delegates to foreman_strategy.stop" do
+          strategy.expect :stop, true, ["web"]
+          @config.find_and_execute_task("foreman:stop:web")
+
+          strategy.verify
+        end
+      end
+
+      describe "for namespace :restart" do
+        it "creates a task for each Procfile entry (on client side copy)" do
+          @config.must_have_task "foreman:restart:web"
+          @config.must_have_task "foreman:restart:job"
+        end
+
+        it "task :web delegates to foreman_strategy.restart" do
+          strategy.expect :restart, true, ["web"]
+          @config.find_and_execute_task("foreman:restart:web")
+
+          strategy.verify
+        end
+      end
+    end
+  end
+
+  describe "task :frun" do
+    it "delegates to foreman:run_cmd task" do
+      @config.load do
+        def methods_called ; @methods_called ||= [] ; end
+
+        namespace :foreman do
+          task(:run_cmd) { methods_called << "foreman:run_cmd" }
+        end
+      end
+      @config.find_and_execute_task("frun")
+
+      @config.methods_called.must_equal ["foreman:run_cmd"]
+    end
+  end
+end

data/spec/git_style_spec.rb

@@ -0,0 +1,168 @@
+require 'minitest/autorun'
+require 'minitest/capistrano'
+require 'capistrano/fanfare'
+require 'capistrano/fanfare/git_style'
+require 'timecop'
+
+describe Capistrano::Fanfare::GitStyle do
+  before do
+    @config = Capistrano::Configuration.new
+    @config.load "deploy"
+    Capistrano::Fanfare::GitStyle.load_into(@config)
+    @config.extend(MiniTest::Capistrano::ConfigurationExtension)
+
+    @config.set :application, "fooapp"
+    @config.set :repository, "git@example.com:fooapp.git"
+  end
+
+  describe "for variables" do
+    it "sets :scm to :git" do
+      @config.fetch(:scm).must_equal :git
+    end
+
+    it "sets :deploy_via to :git_style" do
+      @config.fetch(:deploy_via).must_equal :git_style
+    end
+
+    it "sets :release_name to a timestamp and git commit id" do
+      @config.set :real_revision, "git123"
+
+      Timecop.freeze(Time.utc(2012, 1, 1, 2, 3, 4)) do
+        @config.fetch(:release_name).must_equal "20120101020304-git123"
+      end
+    end
+
+    it "sets :release_path to :current_path" do
+      @config.fetch(:release_path).must_equal @config.fetch(:current_path)
+    end
+
+    it "sets :current_release to :current_path" do
+      @config.fetch(:current_release).must_equal @config.fetch(:current_path)
+    end
+
+    it "sets :latest_release to :current_path" do
+      @config.fetch(:latest_release).must_equal @config.fetch(:current_path)
+    end
+
+    it "sets :current_revision to current git revision on server" do
+      @config.set :current_path, "/a/apps/barapp/current"
+      capture_cmd = "cd /a/apps/barapp/current && git rev-parse HEAD"
+      @config.captures_responses[capture_cmd] = "gitZZZ"
+
+      @config.fetch(:current_revision).must_equal "gitZZZ"
+    end
+
+    it "sets :latest_revision to current git revision on the server" do
+      @config.set :releases_path, "/a/apps/zurb/releases"
+      @config.set :releases, ["first-one", "20120101020304-gitFAB"]
+      capture_cmd = "basename /a/apps/zurb/releases/20120101020304-gitFAB | cut -d - -f 2"
+      @config.captures_responses[capture_cmd] = "gitFAB"
+
+      @config.fetch(:latest_revision).must_equal "gitFAB"
+    end
+
+    it "sets :previous_revision to git revision of last deployment" do
+      @config.set :previous_release, "/a/apps/zurb/releases/20060212125959-gitCC"
+      capture_cmd = "basename /a/apps/zurb/releases/20060212125959-gitCC | cut -d - -f 2"
+      @config.captures_responses[capture_cmd] = "gitCC"
+
+      @config.fetch(:previous_revision).must_equal "gitCC"
+    end
+
+    it "sets :previous_revision to nil if :previous_release is not set" do
+      @config.set :previous_release, nil
+
+      @config.captures.must_be_empty
+      @config.fetch(:previous_revision).must_be_nil
+    end
+  end
+
+  describe "for namespace :deploy" do
+    describe "task :update_code" do
+      before do
+        @config.load do
+          def methods_called ; @methods_called ||= [] ; end
+
+          namespace :deploy do
+            task(:finalize_update) { methods_called << "deploy:finalize_update" }
+          end
+        end
+
+        # stub out strategy.deploy!
+        strategy = @config.strategy
+        def strategy.deploy! ; methods_called << "strategy.deploy!" ; end
+
+        # stub out on_rollback
+        def @config.on_rollback ; methods_called << "on_rollback" ; end
+      end
+
+      it "calls same tasks as delivered gem code" do
+        @config.find_and_execute_task("deploy:update_code")
+
+        @config.methods_called.must_equal(["strategy.deploy!", "deploy:finalize_update"])
+      end
+    end
+
+    it "task :create_symlink must not run anything (no-op)" do
+      @config.find_and_execute_task("deploy:create_symlink")
+
+      @config.wont_have_run_anything
+    end
+
+    describe "in namespace :rollback" do
+      before do
+        @config.load do
+          def methods_called ; @methods_called ||= [] ; end
+
+          namespace :deploy do
+            task(:update_code) { methods_called << "deploy:update_code" }
+          end
+        end
+      end
+
+      def runs_msg(cmd)
+        runs_list = @config.runs.keys.sort.
+          map { |c|c.sub(/^/, '\'').sub(/$/, '\'')}.join(', ')
+        "Expected run call of '#{cmd}' in run list of: [#{runs_list}]"
+      end
+
+      it "task :revision sets :branch to :previous_release" do
+        @config.set :branch, "ding"
+        @config.set :previous_revision, "gitPREV"
+        @config.set :previous_release, "/u/apps/rofl/releases/20080808082800-gitPREV"
+        @config.find_and_execute_task("deploy:rollback:revision")
+
+        @config.fetch(:branch).must_equal "gitPREV"
+      end
+
+      it "task :revision runs deploy:update_code" do
+        @config.set :previous_revision, "gitPREV"
+        @config.set :previous_release, "/u/apps/rofl/releases/20080808082800-gitPREV"
+        @config.find_and_execute_task("deploy:rollback:revision")
+
+        @config.methods_called.must_include "deploy:update_code"
+      end
+
+      it "task :revision raises an exception if no previous release exists" do
+        @config.set :previous_release, nil
+
+        proc { @config.find_and_execute_task("deploy:rollback:revision") }.
+          must_raise RuntimeError
+        @config.methods_called.wont_include "deploy:update_code"
+      end
+
+      it "task :cleanup removes :current_release directory conditionally" do
+        @config.set :current_path, "/u/apps/rofl/current"
+        @config.set :latest_revision, "gitAAA"
+        @config.set :current_release, "/u/apps/rofl/releases/20120101020304-gitAAA"
+        @config.find_and_execute_task("deploy:rollback:cleanup")
+
+        cmd = [
+          "if [ `(cd /u/apps/rofl/current && git rev-parse HEAD)` != `gitAAA` ]; " +
+          "then rm -rf /u/apps/rofl/releases/20120101020304-gitAAA; fi"
+        ]
+        @config.must_have_run cmd.join, runs_msg(cmd.join)
+      end
+    end
+  end
+end