capistrano-fanfare 0.0.1

data/lib/capistrano/fanfare/git_style.rb

@@ -0,0 +1,87 @@
+require 'capistrano'
+require 'capistrano/recipes/deploy/strategy/git_style'
+
+module Capistrano::Fanfare::GitStyle
+  def self.load_into(configuration)
+    configuration.load do
+      set :scm,             :git
+      set :deploy_via,      :git_style
+      set(:release_name)    { %{#{Time.now.utc.strftime("%Y%m%d%H%M%S")}-#{real_revision}} }
+      set(:release_path)    { current_path }
+      set(:current_release) { current_path }
+      set(:latest_release)  { current_path }
+
+      set(:current_revision) {
+        capture("cd #{current_path} && git rev-parse HEAD",
+                :except => { :no_release => true }).chomp }
+      set(:latest_revision) {
+        last_release_dir = releases.length > 0 ? File.join(releases_path, releases.last) : nil
+        capture("basename #{last_release_dir} | cut -d - -f 2",
+                :except => { :no_release => true }).chomp }
+      set(:previous_revision) {
+        capture("basename #{previous_release} | cut -d - -f 2",
+                :except => { :no_release => true }).chomp if previous_release }
+
+      namespace :deploy do
+        desc <<-DESC
+          Copies your project to the remote servers. This is the first stage \
+          of any deployment; moving your updated code and assets to the deployment \
+          servers. You will rarely call this task directly, however; instead, you \
+          should call the `deploy' task (to do a complete deploy) or the `update' \
+          task (if you want to perform the `restart' task separately).
+
+          You will need to make sure you set the :scm variable to the source \
+          control software you are using (it defaults to :subversion), and the \
+          :deploy_via variable to the strategy you want to use to deploy (it \
+          defaults to :checkout).
+
+          [NOTE] This overrides the capistrano default by removing the \
+          on_rollback logic since previous release checkouts don't exist.
+        DESC
+        task :update_code, :except => { :no_release => true } do
+          strategy.deploy!
+          finalize_update
+        end
+
+        desc <<-DESC
+          [internal] No-op for git-based deployments.
+
+          [NOTE] This overides the capistrano default since there is no need for a
+          symlink farm.
+        DESC
+        task :create_symlink, :except => { :no_release => true } do
+        end
+
+        namespace :rollback do
+          desc <<-DESC
+            [internal] Updates git HEAD to the last deployed commit.
+            This is called by the rollback sequence, and should rarely (if
+            ever) need to be called directly.
+          DESC
+          task :revision, :except => { :no_release => true } do
+            if previous_release
+              set :branch, previous_revision
+              update_code
+            else
+              raise "could not rollback the code because there is no prior release"
+            end
+          end
+
+          desc <<-DESC
+            [internal] No-op for git-based deployments.
+            This is called by the rollback sequence, and should rarely
+            (if ever) need to be called directly.
+          DESC
+          task :cleanup, :roles => [:app, :web, :db], :except => { :no_release => true } do
+            run %{if [ `(cd #{current_path} && git rev-parse HEAD)` != `#{latest_revision}` ]; then rm -rf #{current_release}; fi}
+          end
+        end
+
+      end
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Capistrano::Fanfare::GitStyle.load_into(Capistrano::Configuration.instance)
+end

data/lib/capistrano/fanfare/multistage.rb

@@ -0,0 +1,36 @@
+require 'capistrano'
+
+module Capistrano::Fanfare::Multistage
+  def self.load_into(configuration)
+    configuration.load do
+      def _cset(name, *args, &block)
+        unless exists?(name)
+          set(name, *args, &block)
+        end
+      end
+
+      _cset :stages,          %w{staging production}
+      _cset :default_stage,   "staging"
+
+      require 'capistrano/ext/multistage'
+
+      # =========================================================================
+      # These are the tasks that are available to help with deploying web apps,
+      # and specifically, Rails applications. You can have cap give you a summary
+      # of them with `cap -T'.
+      # =========================================================================
+
+      desc <<-DESC
+        Lists all valid deployment environments.
+      DESC
+      task :all_stages, :roles => :app, :except => { :no_release => true } do
+        logger.important "Valid stages are:\n\n"
+        fetch(:stages, []).each { |s| logger.important "* #{s}" }
+      end
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Capistrano::Fanfare::Multistage.load_into(Capistrano::Configuration.instance)
+end

data/lib/capistrano/fanfare/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Fanfare
+    VERSION = "0.0.1"
+  end
+end

data/lib/capistrano/fanfare.rb

@@ -0,0 +1,22 @@
+require "capistrano"
+require "capistrano/fanfare/version"
+
+if Capistrano::Configuration.instance
+  Capistrano::Configuration.instance.load_paths << File.dirname(__FILE__)
+end
+
+module Capistrano
+  module Fanfare
+    module Configuration
+      def fanfare_recipe(recipe)
+        require "capistrano/fanfare/#{recipe}"
+      end
+    end
+  end
+end
+
+module Capistrano
+  class Configuration
+    include Capistrano::Fanfare::Configuration
+  end
+end

data/lib/capistrano/recipes/deploy/strategy/git_style.rb

@@ -0,0 +1,22 @@
+require 'capistrano/recipes/deploy/strategy/remote'
+
+module Capistrano
+  module Deploy
+    module Strategy
+
+      class GitStyle < Remote
+        protected
+
+        def command
+          @command ||= "if [ -d #{configuration[:current_path]}/.git ]; then " +
+            "#{source.sync(revision, configuration[:current_path])}; " +
+            "else #{source.checkout(revision, configuration[:current_path])}; fi"
+        end
+
+        def mark
+          "(mkdir -p #{File.join(configuration[:releases_path], configuration[:release_name])})"
+        end
+      end
+    end
+  end
+end

data/spec/bundler_spec.rb

@@ -0,0 +1,162 @@
+require 'minitest/autorun'
+require 'minitest/capistrano'
+require 'capistrano/fanfare'
+require 'capistrano/fanfare/bundler'
+
+#
+# Rake mixes in FileUtils methods into Capistrano::Configuration::Namespace as
+# private methods which will cause a method/task namespace collision when the
+# `bundle:install' task is created.
+#
+# So, if we are in a Rake context, nuke :install in the Namespace class--we
+# won't be using it directly in this codebase but this feels so very, very
+# wrong (here be dragons).
+#
+if defined?(Rake::DSL)
+  Capistrano::Configuration::Namespaces::Namespace.class_eval { undef :install }
+end
+
+describe Capistrano::Fanfare::Bundler do
+  before do
+    @config = Capistrano::Configuration.new
+    Capistrano::Fanfare::Bundler.load_into(@config)
+    @config.extend(MiniTest::Capistrano::ConfigurationExtension)
+    @orig_config = Capistrano::Configuration.instance
+    Capistrano::Configuration.instance = @config
+
+    @config.set :current_release, "/srv/gemmy/releases/thisone"
+  end
+
+  after do
+    Capistrano::Configuration.instance = @orig_config
+  end
+
+  describe "for variables" do
+    it "sets :bundle_cmd to 'bundle'" do
+      @config.fetch(:bundle_cmd).must_equal "bundle"
+    end
+
+    it "sets :bundle_shebang to 'ruby-local-exec'" do
+      @config.fetch(:bundle_shebang).must_equal "ruby-local-exec"
+    end
+
+    it "add :current_path/bin to the default_environment PATH" do
+      @config.set :current_path, "/tmp/app/current"
+
+      @config.fetch(:default_environment)['PATH'].must_equal "/tmp/app/current/bin:$PATH"
+    end
+
+    it "sets :bundle_binstub_template to the binstub script" do
+      @config.set :bundle_shebang, "jruby"
+
+      @config.fetch(:bundle_binstub_template).must_equal <<-BINSTUB
+#!/usr/bin/env jruby
+#
+# This file was generated by capistrano.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+
+load Gem.bin_path('bundler', 'bundle')
+      BINSTUB
+    end
+
+    it "sets :rake to 'rake'" do
+      @config.fetch(:rake).must_equal "rake"
+    end
+
+    describe ":bundle_flags" do
+      after do
+        ENV.delete('VERBOSE')
+      end
+
+      it "contains --deployment" do
+        @config.fetch(:bundle_flags).must_match /--deployment/
+      end
+
+      it "contains --binstubs" do
+        @config.fetch(:bundle_flags).must_match /--binstubs/
+      end
+
+      it "contains --shebang <shebang_bin>" do
+        @config.set :bundle_shebang, "bangbang"
+
+        @config.fetch(:bundle_flags).must_match /--shebang bangbang/
+      end
+
+      it "contains --quiet by default" do
+        @config.fetch(:bundle_flags).must_match /--quiet/
+      end
+
+      it "does not contain --quiet if ENV['VERSBOSE'] is set" do
+        ENV['VERBOSE'] = "yes"
+
+        @config.fetch(:bundle_flags).wont_match /--quiet/
+      end
+    end
+
+    describe ":bundle_without" do
+      it "contains :development and :test groups" do
+        @config.fetch(:bundle_without).must_include :development
+        @config.fetch(:bundle_without).must_include :test
+      end
+
+      it "contains all other values from :os_types if the :os_type variable exists" do
+        @config.set :os_types, [:fizz, :buzz, :rocketships]
+        @config.set :os_type, :rocketshipos
+
+        @config.fetch(:bundle_without).must_include :fizz
+        @config.fetch(:bundle_without).must_include :buzz
+        @config.fetch(:bundle_without).must_include :development
+        @config.fetch(:bundle_without).must_include :test
+      end
+    end
+  end
+
+  describe "for namespace :bundle" do
+    it "creates a bundle:install task" do
+      @config.must_have_task "bundle:install"
+    end
+
+    it "calls bundle:install task after deploy:finalize_update" do
+      @config.must_have_callback_after "deploy:finalize_update", "bundle:install"
+    end
+
+    describe "task :create_binstub_script" do
+      it "creates bin/bundle binstub script" do
+        @config.set :shared_path, "/tmp/app/shared"
+        @config.set :bundle_binstub_template, "thescript"
+        @config.find_and_execute_task("bundle:create_binstub_script")
+
+        @config.must_have_run "mkdir -p /tmp/app/shared/bin"
+        @config.must_have_put "/tmp/app/shared/bin/bundle", "thescript"
+      end
+
+      it "gets called after deploy:setup task" do
+        @config.must_have_callback_after "deploy:setup", "bundle:create_binstub_script"
+      end
+    end
+
+    describe "task :cp_bundle_binstub" do
+      it "copies bin/bundle into current_path" do
+        @config.set :shared_path, "/tmp/app/shared"
+        @config.set :current_path, "/tmp/app/current"
+        @config.find_and_execute_task("bundle:cp_bundle_binstub")
+
+        @config.must_have_run [
+          "mkdir -p /tmp/app/current/bin",
+          "cp /tmp/app/shared/bin/bundle /tmp/app/current/bin/bundle",
+          "chmod 0755 /tmp/app/current/bin/bundle"
+        ].join(" && ")
+      end
+
+      it "gets called after deploy:update_code task" do
+        @config.must_have_callback_before "deploy:finalize_update", "bundle:cp_bundle_binstub"
+      end
+    end
+  end
+end

data/spec/defaults_spec.rb

@@ -0,0 +1,177 @@
+require 'minitest/autorun'
+require 'minitest/capistrano'
+require 'capistrano/fanfare'
+require 'capistrano/fanfare/defaults'
+
+describe Capistrano::Fanfare::Defaults do
+  before do
+    @config = Capistrano::Configuration.new
+    Capistrano::Fanfare::Defaults.load_into(@config)
+    @config.extend(MiniTest::Capistrano::ConfigurationExtension)
+    ENV['BRANCH'] = nil
+  end
+
+  it "sets :scm to :git" do
+    @config.fetch(:scm).must_equal :git
+  end
+
+  it "sets :use_sudo to false" do
+    @config.fetch(:use_sudo).must_equal false
+  end
+
+  it "sets :user to 'deploy'" do
+    @config.fetch(:user).must_equal "deploy"
+  end
+
+  it "sets :rake to 'bundle exec rake'" do
+    @config.fetch(:rake).must_equal "bundle exec rake"
+  end
+
+  it "sets :ssh_options to include :forward_agent => true" do
+    @config.fetch(:ssh_options)[:forward_agent].must_equal true
+  end
+
+  it "sets :deploy_to to a directory containing :application and :deploy_env" do
+    @config.set :application, "fizzy"
+    @config.set :deploy_env,  "staging"
+
+    @config.fetch(:deploy_to).must_equal "/srv/fizzy_staging"
+  end
+
+  describe ":branch" do
+    it "sets to master by default" do
+      @config.fetch(:branch).must_equal "master"
+    end
+
+    it "sets to ENV['BRANCH'] if set" do
+      ENV['BRANCH'] = "tree-branch"
+
+      @config.fetch(:branch).must_equal "tree-branch"
+    end
+  end
+
+  describe ":deploy_env" do
+    before do
+      @config.set :stage,     "stage_env"
+      @config.set :rails_env, "railsy_baby"
+      @config.set :rack_env,  "rackish_dude"
+
+      ENV['RAILS_ENV']  = "rails_env_hash"
+      ENV['RACK_ENV']   = "rack_env_hash"
+    end
+
+    after do
+      ENV.delete 'RAILS_ENV'
+      ENV.delete 'RACK_ENV'
+    end
+
+    it "sets to :stage if it exists" do
+      @config.fetch(:deploy_env).must_equal "stage_env"
+    end
+
+    it "set to :rails_env if :stage isn't present" do
+      @config.unset :stage
+
+      @config.fetch(:deploy_env).must_equal "railsy_baby"
+    end
+
+    it "set to ENV['RAILS_ENV'] if :stage and :rails_env arent't present" do
+      @config.unset :stage
+      @config.unset :rails_env
+
+      @config.fetch(:deploy_env).must_equal "rails_env_hash"
+    end
+
+    it "set to :rack_env if :stage, :rails_env, and ENV['RAILS_ENV'] arent't present" do
+      @config.unset :stage
+      @config.unset :rails_env
+      ENV.delete 'RAILS_ENV'
+
+      @config.fetch(:deploy_env).must_equal "rackish_dude"
+    end
+
+    it "set to ENV['RACK_ENV'] if :stage, :rails_env, ENV['RAILS_ENV'], and :rack_env arent't present" do
+      @config.unset :stage
+      @config.unset :rails_env
+      @config.unset :rack_env
+      ENV.delete 'RAILS_ENV'
+
+      @config.fetch(:deploy_env).must_equal "rack_env_hash"
+    end
+
+    it "set to 'production' as a fallback" do
+      @config.unset :stage
+      @config.unset :rails_env
+      @config.unset :rack_env
+      ENV.delete 'RAILS_ENV'
+      ENV.delete 'RACK_ENV'
+
+      @config.fetch(:deploy_env).must_equal "production"
+    end
+  end
+
+  it "sets :pty = true for default_run_options" do
+    @config.default_run_options[:pty].must_equal true
+  end
+
+  it "sets :os_types to a list of OSes" do
+    @config.fetch(:os_types).must_equal [:darwin, :linux, :sunos]
+  end
+
+  describe ":os_type" do
+    it "set to :darwin for Mac OS" do
+      @config.captures_responses["uname -s"] = "Darwin\n"
+
+      @config.fetch(:os_type).must_equal :darwin
+    end
+
+    it "set to :linunx for Linux-based OSes" do
+      @config.captures_responses["uname -s"] = "Linux\n"
+
+      @config.fetch(:os_type).must_equal :linux
+    end
+
+    it "set to :sunos for Solaris-based OSes" do
+      @config.captures_responses["uname -s"] = "SunOS\n"
+
+      @config.fetch(:os_type).must_equal :sunos
+    end
+  end
+
+  it "sets :shared_children to include tmp/sockets and tmp/sessions" do
+    @config.fetch(:shared_children).
+      must_equal %w{public/system log tmp/pids tmp/sockets tmp/sessions}
+  end
+
+  describe "for :deploy namespace" do
+    describe "task :cold" do
+      before do
+        @config.load do
+          def methods_called ; @methods_called ||= [] ; end
+
+          namespace :deploy do
+            task(:update)   { methods_called << "deploy:update" }
+            task(:migrate)  { methods_called << "deploy:migrate" }
+            task(:start)    { methods_called << "deploy:start" }
+          end
+        end
+      end
+
+      it "calls same tasks as delivered gem code" do
+        @config.find_and_execute_task("deploy:cold")
+
+        @config.methods_called.must_equal(
+          ["deploy:update", "deploy:migrate", "deploy:start"])
+      end
+
+      it "calls db:seed if the task exists" do
+        @config.namespace :db do
+          task(:seed) { methods_called << "db:seed" }
+        end
+        @config.find_and_execute_task("deploy:cold")
+
+        @config.methods_called.must_include "db:seed"
+      end
+    end
+  end
+end