capistrano 3.6.0 → 3.7.0

data/lib/capistrano/configuration.rb

@@ -102,12 +102,33 @@ module Capistrano
       end
     end
 
+    def configure_scm
+      Capistrano::Configuration::SCMResolver.new.resolve
+    end
+
     def timestamp
       @timestamp ||= Time.now.utc
     end
 
+    def add_filter(filter=nil, &block)
+      if block
+        raise ArgumentError, "Both a block and an object were given" if filter
+
+        filter = Object.new
+        def filter.filter(servers)
+          block.call(servers)
+        end
+      elsif !filter.respond_to? :filter
+        raise TypeError, "Provided custom filter <#{filter.inspect}> does " \
+                         "not have a public 'filter' method"
+      end
+      @custom_filters ||= []
+      @custom_filters << filter
+    end
+
     def setup_filters
-      @filters = cmdline_filters.clone
+      @filters = cmdline_filters
+      @filters += @custom_filters if @custom_filters
       @filters << Filter.new(:role, ENV["ROLES"]) if ENV["ROLES"]
       @filters << Filter.new(:host, ENV["HOSTS"]) if ENV["HOSTS"]
       fh = fetch_for(:filter, {}) || {}
@@ -130,8 +151,14 @@ module Capistrano
       fetch(:sshkit_backend) == SSHKit::Backend::Printer
     end
 
-    def install_plugin(plugin, load_hooks: true)
-      installer.install(plugin, load_hooks: load_hooks)
+    def install_plugin(plugin, load_hooks: true, load_immediately: false)
+      installer.install(plugin,
+                        load_hooks: load_hooks,
+                        load_immediately: load_immediately)
+    end
+
+    def scm_plugin_installed?
+      installer.scm_installed?
     end
 
     def servers

data/lib/capistrano/defaults.rb

@@ -18,7 +18,9 @@ end
   end
 end
 
-set_if_empty :scm, :git
+# We use a special :_default_git value so that SCMResolver can tell whether the
+# default has been replaced by the user via `set`.
+set_if_empty :scm, Capistrano::Configuration::SCMResolver::DEFAULT_GIT
 set_if_empty :branch, "master"
 set_if_empty :deploy_to, -> { "/var/www/#{fetch(:application)}" }
 set_if_empty :tmp_dir, "/tmp"

data/lib/capistrano/doctor/variables_doctor.rb

@@ -7,7 +7,7 @@ module Capistrano
     class VariablesDoctor
       # These are keys that have no default values in Capistrano, but are
       # nonetheless expected to be set.
-      WHITELIST = [:application, :repo_url, :git_strategy, :hg_strategy, :svn_strategy].freeze
+      WHITELIST = [:application, :repo_url].freeze
       private_constant :WHITELIST
 
       include Capistrano::Doctor::OutputHelpers

data/lib/capistrano/dsl/env.rb

@@ -7,15 +7,8 @@ module Capistrano
       def_delegators :env,
                      :configure_backend, :fetch, :set, :set_if_empty, :delete,
                      :ask, :role, :server, :primary, :validate, :append,
-                     :remove, :dry_run?, :install_plugin
-
-      def is_question?(key)
-        env.is_question?(key)
-      end
-
-      def any?(key)
-        env.any?(key)
-      end
+                     :remove, :dry_run?, :install_plugin, :any?, :is_question?,
+                     :configure_scm, :scm_plugin_installed?
 
       def roles(*names)
         env.roles_for(names.flatten)

data/lib/capistrano/dsl/paths.rb

@@ -19,7 +19,7 @@ module Capistrano
       end
 
       def release_path
-        fetch(:release_path, current_path)
+        fetch(:release_path) { current_path }
       end
 
       def set_release_path(timestamp=now)

data/lib/capistrano/dsl/task_enhancements.rb

@@ -17,14 +17,6 @@ module Capistrano
       end
     end
 
-    def remote_file(task)
-      warn("[Deprecation Warning] `remote_file` is deprecated and will be "\
-           "removed in Capistrano 3.7.0")
-
-      target_roles = task.delete(:roles) { :all }
-      define_remote_file_task(task, target_roles)
-    end
-
     def define_remote_file_task(task, target_roles)
       Capistrano::UploadTask.define_task(task) do |t|
         prerequisite_file = t.prerequisites.first

data/lib/capistrano/dsl.rb

@@ -13,7 +13,8 @@ module Capistrano
 
     def invoke(task_name, *args)
       task = Rake::Task[task_name]
-      if task && task.already_invoked
+      # NOTE: We access instance variable since the accessor was only added recently. Once Capistrano depends on rake 11+, we can revert the following line
+      if task && task.instance_variable_get(:@already_invoked)
         file, line, = caller.first.split(":")
         colors = SSHKit::Color.new($stderr)
         $stderr.puts colors.colorize("Skipping task `#{task_name}'.", :yellow)

data/lib/capistrano/i18n.rb

@@ -12,6 +12,7 @@ en = {
   written_file: "create %{file}",
   question: "Please enter %{key} (%{default_value}): ",
   keeping_releases: "Keeping %{keep_releases} of %{releases} deployed releases on %{host}",
+  skip_cleanup: "Skipping cleanup of old releases on %{host}; unexpected foldername found (should be timestamp)",
   no_old_releases: "No old releases (keeping newest %{keep_releases}) on %{host}",
   linked_file_does_not_exist: "linked file %{file} does not exist on %{host}",
   cannot_rollback: "There are no older releases to rollback to",

data/lib/capistrano/scm/git.rb

@@ -0,0 +1,73 @@
+require "capistrano/scm/plugin"
+
+class Capistrano::SCM::Git < Capistrano::SCM::Plugin
+  def set_defaults
+    set_if_empty :git_shallow_clone, false
+    set_if_empty :git_wrapper_path, lambda {
+      # Try to avoid permissions issues when multiple users deploy the same app
+      # by using different file names in the same dir for each deployer and stage.
+      suffix = [:application, :stage, :local_user].map { |key| fetch(key).to_s }.join("-").gsub(/\s+/, "-")
+      "#{fetch(:tmp_dir)}/git-ssh-#{suffix}.sh"
+    }
+    set_if_empty :git_environmental_variables, lambda {
+      {
+        git_askpass: "/bin/echo",
+        git_ssh: fetch(:git_wrapper_path)
+      }
+    }
+  end
+
+  def register_hooks
+    after "deploy:new_release_path", "git:create_release"
+    before "deploy:check", "git:check"
+    before "deploy:set_current_revision", "git:set_current_revision"
+  end
+
+  def define_tasks
+    eval_rakefile File.expand_path("../tasks/git.rake", __FILE__)
+  end
+
+  def repo_mirror_exists?
+    backend.test " [ -f #{repo_path}/HEAD ] "
+  end
+
+  def check_repo_is_reachable
+    git :'ls-remote --heads', repo_url
+  end
+
+  def clone_repo
+    if (depth = fetch(:git_shallow_clone))
+      git :clone, "--mirror", "--depth", depth, "--no-single-branch", repo_url, repo_path.to_s
+    else
+      git :clone, "--mirror", repo_url, repo_path.to_s
+    end
+  end
+
+  def update_mirror
+    # Note: Requires git version 1.9 or greater
+    if (depth = fetch(:git_shallow_clone))
+      git :fetch, "--depth", depth, "origin", fetch(:branch)
+    else
+      git :remote, :update, "--prune"
+    end
+  end
+
+  def archive_to_release_path
+    if (tree = fetch(:repo_tree))
+      tree = tree.slice %r#^/?(.*?)/?$#, 1
+      components = tree.split("/").size
+      git :archive, fetch(:branch), tree, "| #{SSHKit.config.command_map[:tar]} -x --strip-components #{components} -f - -C", release_path
+    else
+      git :archive, fetch(:branch), "| #{SSHKit.config.command_map[:tar]} -x -f - -C", release_path
+    end
+  end
+
+  def fetch_revision
+    backend.capture(:git, "rev-list --max-count=1 #{fetch(:branch)}")
+  end
+
+  def git(*args)
+    args.unshift :git
+    backend.execute(*args)
+  end
+end

data/lib/capistrano/scm/hg.rb

@@ -0,0 +1,48 @@
+require "capistrano/scm/plugin"
+
+class Capistrano::SCM::Hg < Capistrano::SCM::Plugin
+  def register_hooks
+    after "deploy:new_release_path", "hg:create_release"
+    before "deploy:check", "hg:check"
+    before "deploy:set_current_revision", "hg:set_current_revision"
+  end
+
+  def define_tasks
+    eval_rakefile File.expand_path("../tasks/hg.rake", __FILE__)
+  end
+
+  def hg(*args)
+    args.unshift(:hg)
+    backend.execute(*args)
+  end
+
+  def repo_mirror_exists?
+    backend.test " [ -d #{repo_path}/.hg ] "
+  end
+
+  def check_repo_is_reachable
+    hg "id", repo_url
+  end
+
+  def clone_repo
+    hg "clone", "--noupdate", repo_url, repo_path.to_s
+  end
+
+  def update_mirror
+    hg "pull"
+  end
+
+  def archive_to_release_path
+    if (tree = fetch(:repo_tree))
+      tree = tree.slice %r#^/?(.*?)/?$#, 1
+      components = tree.split("/").size
+      hg "archive --type tgz -p . -I", tree, "--rev", fetch(:branch), "| tar -x --strip-components #{components} -f - -C", release_path
+    else
+      hg "archive", release_path, "--rev", fetch(:branch)
+    end
+  end
+
+  def fetch_revision
+    backend.capture(:hg, "log --rev #{fetch(:branch)} --template \"{node}\n\"")
+  end
+end

data/lib/capistrano/scm/plugin.rb

@@ -0,0 +1,13 @@
+require "capistrano/plugin"
+require "capistrano/scm"
+
+# Base class for all built-in and third-party SCM plugins. Notice that this
+# class doesn't really do anything other than provide an `scm?` predicate. This
+# tells Capistrano that the plugin provides SCM functionality. All other plugin
+# features are inherited from Capistrano::Plugin.
+#
+class Capistrano::SCM::Plugin < Capistrano::Plugin
+  def scm?
+    true
+  end
+end

data/lib/capistrano/scm/svn.rb

@@ -0,0 +1,47 @@
+require "capistrano/scm/plugin"
+
+class Capistrano::SCM::Svn < Capistrano::SCM::Plugin
+  def register_hooks
+    after "deploy:new_release_path", "svn:create_release"
+    before "deploy:check", "svn:check"
+    before "deploy:set_current_revision", "svn:set_current_revision"
+  end
+
+  def define_tasks
+    eval_rakefile File.expand_path("../tasks/svn.rake", __FILE__)
+  end
+
+  def svn(*args)
+    args.unshift(:svn)
+    args.push "--username #{fetch(:svn_username)}" if fetch(:svn_username)
+    args.push "--password #{fetch(:svn_password)}" if fetch(:svn_password)
+    args.push "--revision #{fetch(:svn_revision)}" if fetch(:svn_revision)
+    backend.execute(*args)
+  end
+
+  def repo_mirror_exists?
+    backend.test " [ -d #{repo_path}/.svn ] "
+  end
+
+  def check_repo_is_reachable
+    svn_username = fetch(:svn_username) ? "--username #{fetch(:svn_username)}" : ""
+    svn_password = fetch(:svn_password) ? "--password #{fetch(:svn_password)}" : ""
+    backend.test :svn, :info, repo_url, svn_username, svn_password
+  end
+
+  def clone_repo
+    svn :checkout, repo_url, repo_path.to_s
+  end
+
+  def update_mirror
+    svn :update
+  end
+
+  def archive_to_release_path
+    svn :export, "--force", ".", release_path
+  end
+
+  def fetch_revision
+    backend.capture(:svnversion, repo_path.to_s)
+  end
+end

data/lib/capistrano/{tasks → scm/tasks}/git.rake

@@ -1,22 +1,7 @@
-namespace :git do
-  def strategy
-    @strategy ||= Capistrano::Git.new(self, fetch(:git_strategy, Capistrano::Git::DefaultStrategy))
-  end
-
-  set :git_wrapper_path, lambda {
-    # Try to avoid permissions issues when multiple users deploy the same app
-    # by using different file names in the same dir for each deployer and stage.
-    suffix = [:application, :stage, :local_user].map { |key| fetch(key).to_s }.join("-")
-    "#{fetch(:tmp_dir)}/git-ssh-#{suffix}.sh"
-  }
-
-  set :git_environmental_variables, lambda {
-    {
-      git_askpass: "/bin/echo",
-      git_ssh: fetch(:git_wrapper_path)
-    }
-  }
+# This trick lets us access the Git plugin within `on` blocks.
+git_plugin = self
 
+namespace :git do
   desc "Upload the git wrapper script, this script guarantees that we can script git without getting an interactive prompt"
   task :wrapper do
     on release_roles :all do
@@ -31,7 +16,7 @@ namespace :git do
     fetch(:branch)
     on release_roles :all do
       with fetch(:git_environmental_variables) do
-        strategy.check
+        git_plugin.check_repo_is_reachable
       end
     end
   end
@@ -39,12 +24,12 @@ namespace :git do
   desc "Clone the repo to the cache"
   task clone: :'git:wrapper' do
     on release_roles :all do
-      if strategy.test
+      if git_plugin.repo_mirror_exists?
         info t(:mirror_exists, at: repo_path)
       else
         within deploy_path do
           with fetch(:git_environmental_variables) do
-            strategy.clone
+            git_plugin.clone_repo
           end
         end
       end
@@ -56,7 +41,7 @@ namespace :git do
     on release_roles :all do
       within repo_path do
         with fetch(:git_environmental_variables) do
-          strategy.update
+          git_plugin.update_mirror
         end
       end
     end
@@ -68,7 +53,7 @@ namespace :git do
       with fetch(:git_environmental_variables) do
         within repo_path do
           execute :mkdir, "-p", release_path
-          strategy.release
+          git_plugin.archive_to_release_path
         end
       end
     end
@@ -79,7 +64,7 @@ namespace :git do
     on release_roles :all do
       within repo_path do
         with fetch(:git_environmental_variables) do
-          set :current_revision, strategy.fetch_revision
+          set :current_revision, git_plugin.fetch_revision
         end
       end
     end

data/lib/capistrano/{tasks → scm/tasks}/hg.rake

@@ -1,23 +1,24 @@
-namespace :hg do
-  def strategy
-    @strategy ||= Capistrano::Hg.new(self, fetch(:hg_strategy, Capistrano::Hg::DefaultStrategy))
-  end
+# TODO: this is nearly identical to git.rake. DRY up?
 
+# This trick lets us access the Hg plugin within `on` blocks.
+hg_plugin = self
+
+namespace :hg do
   desc "Check that the repo is reachable"
   task :check do
     on release_roles :all do
-      strategy.check
+      hg_plugin.check_repo_is_reachable
     end
   end
 
   desc "Clone the repo to the cache"
   task :clone do
     on release_roles :all do
-      if strategy.test
+      if hg_plugin.repo_mirror_exists?
         info t(:mirror_exists, at: repo_path)
       else
         within deploy_path do
-          strategy.clone
+          hg_plugin.clone_repo
         end
       end
     end
@@ -27,7 +28,7 @@ namespace :hg do
   task update: :'hg:clone' do
     on release_roles :all do
       within repo_path do
-        strategy.update
+        hr.update_mirror
       end
     end
   end
@@ -36,7 +37,7 @@ namespace :hg do
   task create_release: :'hg:update' do
     on release_roles :all do
       within repo_path do
-        strategy.release
+        hg_plugin.archive_to_release_path
       end
     end
   end
@@ -45,7 +46,7 @@ namespace :hg do
   task :set_current_revision do
     on release_roles :all do
       within repo_path do
-        set :current_revision, strategy.fetch_revision
+        set :current_revision, hg_plugin.fetch_revision
       end
     end
   end

data/lib/capistrano/{tasks → scm/tasks}/svn.rake

@@ -1,23 +1,24 @@
-namespace :svn do
-  def strategy
-    @strategy ||= Capistrano::Svn.new(self, fetch(:svn_strategy, Capistrano::Svn::DefaultStrategy))
-  end
+# TODO: this is nearly identical to git.rake. DRY up?
 
+# This trick lets us access the Svn plugin within `on` blocks.
+svn_plugin = self
+
+namespace :svn do
   desc "Check that the repo is reachable"
   task :check do
     on release_roles :all do
-      strategy.check
+      svn_plugin.check_repo_is_reachable
     end
   end
 
   desc "Clone the repo to the cache"
   task :clone do
     on release_roles :all do
-      if strategy.test
+      if svn_plugin.repo_mirror_exists?
         info t(:mirror_exists, at: repo_path)
       else
         within deploy_path do
-          strategy.clone
+          svn_plugin.clone_repo
         end
       end
     end
@@ -27,7 +28,7 @@ namespace :svn do
   task update: :'svn:clone' do
     on release_roles :all do
       within repo_path do
-        strategy.update
+        svn_plugin.update_mirror
       end
     end
   end
@@ -36,7 +37,7 @@ namespace :svn do
   task create_release: :'svn:update' do
     on release_roles :all do
       within repo_path do
-        strategy.release
+        svn_plugin.archive_to_release_path
       end
     end
   end
@@ -45,7 +46,7 @@ namespace :svn do
   task :set_current_revision do
     on release_roles :all do
       within repo_path do
-        set :current_revision, strategy.fetch_revision
+        set :current_revision, svn_plugin.fetch_revision
       end
     end
   end

data/lib/capistrano/setup.rb

@@ -27,7 +27,7 @@ stages.each do |stage|
       load deploy_config_path
       load stage_config_path.join("#{stage}.rb")
     end
-    load "capistrano/#{fetch(:scm)}.rb"
+    configure_scm
     I18n.locale = fetch(:locale, :en)
     configure_backend
   end

data/lib/capistrano/tasks/deploy.rake

@@ -26,7 +26,6 @@ namespace :deploy do
   end
 
   task updating: :new_release_path do
-    invoke "#{scm}:create_release"
     invoke "deploy:set_current_revision"
     invoke "deploy:symlink:shared"
   end
@@ -53,7 +52,6 @@ namespace :deploy do
 
   desc "Check required files and directories exist"
   task :check do
-    invoke "#{scm}:check"
     invoke "deploy:check:directories"
     invoke "deploy:check:linked_dirs"
     invoke "deploy:check:make_linked_dirs"
@@ -150,8 +148,10 @@ namespace :deploy do
   desc "Clean up old releases"
   task :cleanup do
     on release_roles :all do |host|
-      releases = capture(:ls, "-xtr", releases_path).split
-      if releases.count >= fetch(:keep_releases)
+      releases = capture(:ls, "-x", releases_path).split
+      if !(releases.all? { |e| /^\d{14}$/ =~ e })
+        warn t(:skip_cleanup, host: host.to_s)
+      elsif releases.count >= fetch(:keep_releases)
         info t(:keeping_releases, host: host.to_s, keep_releases: fetch(:keep_releases), releases: releases.count)
         directories = (releases - releases.last(fetch(:keep_releases)))
         if directories.any?
@@ -225,7 +225,6 @@ namespace :deploy do
 
   desc "Place a REVISION file with the current revision SHA in the current release path"
   task :set_current_revision  do
-    invoke "#{scm}:set_current_revision"
     on release_roles(:all) do
       within release_path do
         execute :echo, "\"#{fetch(:current_revision)}\" >> REVISION"

data/lib/capistrano/templates/Capfile

@@ -4,6 +4,17 @@ require "capistrano/setup"
 # Include default deployment tasks
 require "capistrano/deploy"
 
+# Load the SCM plugin appropriate to your project:
+#
+# require "capistrano/scm/hg"
+# install_plugin Capistrano::SCM::Hg
+# or
+# require "capistrano/scm/svn"
+# install_plugin Capistrano::SCM::Svn
+# or
+require "capistrano/scm/git"
+install_plugin Capistrano::SCM::Git
+
 # Include tasks from other gems included in your Gemfile
 #
 # For documentation on these, see for example:
@@ -15,13 +26,13 @@ require "capistrano/deploy"
 #   https://github.com/capistrano/rails
 #   https://github.com/capistrano/passenger
 #
-# require 'capistrano/rvm'
-# require 'capistrano/rbenv'
-# require 'capistrano/chruby'
-# require 'capistrano/bundler'
-# require 'capistrano/rails/assets'
-# require 'capistrano/rails/migrations'
-# require 'capistrano/passenger'
+# require "capistrano/rvm"
+# require "capistrano/rbenv"
+# require "capistrano/chruby"
+# require "capistrano/bundler"
+# require "capistrano/rails/assets"
+# require "capistrano/rails/migrations"
+# require "capistrano/passenger"
 
 # Load custom tasks from `lib/capistrano/tasks` if you have any defined
 Dir.glob("lib/capistrano/tasks/*.rake").each { |r| import r }

data/lib/capistrano/templates/deploy.rb.erb

@@ -1,33 +1,30 @@
 # config valid only for current version of Capistrano
-lock '<%= Capistrano::VERSION %>'
+lock "<%= Capistrano::VERSION %>"
 
-set :application, 'my_app_name'
-set :repo_url, 'git@example.com:me/my_repo.git'
+set :application, "my_app_name"
+set :repo_url, "git@example.com:me/my_repo.git"
 
 # Default branch is :master
 # ask :branch, `git rev-parse --abbrev-ref HEAD`.chomp
 
 # Default deploy_to directory is /var/www/my_app_name
-# set :deploy_to, '/var/www/my_app_name'
-
-# Default value for :scm is :git
-# set :scm, :git
+# set :deploy_to, "/var/www/my_app_name"
 
 # Default value for :format is :airbrussh.
 # set :format, :airbrussh
 
 # You can configure the Airbrussh format using :format_options.
 # These are the defaults.
-# set :format_options, command_output: true, log_file: 'log/capistrano.log', color: :auto, truncate: :auto
+# set :format_options, command_output: true, log_file: "log/capistrano.log", color: :auto, truncate: :auto
 
 # Default value for :pty is false
 # set :pty, true
 
 # Default value for :linked_files is []
-# append :linked_files, 'config/database.yml', 'config/secrets.yml'
+# append :linked_files, "config/database.yml", "config/secrets.yml"
 
 # Default value for linked_dirs is []
-# append :linked_dirs, 'log', 'tmp/pids', 'tmp/cache', 'tmp/sockets', 'public/system'
+# append :linked_dirs, "log", "tmp/pids", "tmp/cache", "tmp/sockets", "public/system"
 
 # Default value for default_env is {}
 # set :default_env, { path: "/opt/ruby/bin:$PATH" }