capistrano 3.4.0 → 3.17.1

data/lib/capistrano/scm.rb

@@ -1,5 +1,4 @@
 module Capistrano
-
   # Base class for SCM strategy providers.
   #
   # @abstract
@@ -25,7 +24,7 @@ module Capistrano
 
     # Call test in context
     def test!(*args)
-      context.test *args
+      context.test(*args)
     end
 
     # The repository URL according to the context
@@ -59,9 +58,7 @@ module Capistrano
     # @return [Boolean]
     #
     def test
-      raise NotImplementedError.new(
-        "Your SCM strategy module should provide a #test method"
-      )
+      raise NotImplementedError, "Your SCM strategy module should provide a #test method"
     end
 
     # @abstract
@@ -72,9 +69,7 @@ module Capistrano
     # @return [Boolean]
     #
     def check
-      raise NotImplementedError.new(
-        "Your SCM strategy module should provide a #check method"
-      )
+      raise NotImplementedError, "Your SCM strategy module should provide a #check method"
     end
 
     # @abstract
@@ -84,9 +79,7 @@ module Capistrano
     # @return void
     #
     def clone
-      raise NotImplementedError.new(
-        "Your SCM strategy module should provide a #clone method"
-      )
+      raise NotImplementedError, "Your SCM strategy module should provide a #clone method"
     end
 
     # @abstract
@@ -96,9 +89,7 @@ module Capistrano
     # @return void
     #
     def update
-      raise NotImplementedError.new(
-        "Your SCM strategy module should provide a #update method"
-      )
+      raise NotImplementedError, "Your SCM strategy module should provide a #update method"
     end
 
     # @abstract
@@ -108,9 +99,7 @@ module Capistrano
     # @return void
     #
     def release
-      raise NotImplementedError.new(
-        "Your SCM strategy module should provide a #release method"
-      )
+      raise NotImplementedError, "Your SCM strategy module should provide a #release method"
     end
 
     # @abstract
@@ -120,9 +109,7 @@ module Capistrano
     # @return void
     #
     def fetch_revision
-      raise NotImplementedError.new(
-        "Your SCM strategy module should provide a #fetch_revision method"
-      )
+      raise NotImplementedError, "Your SCM strategy module should provide a #fetch_revision method"
     end
   end
 end

data/lib/capistrano/setup.rb

@@ -1,22 +1,36 @@
+require "capistrano/doctor"
+require "capistrano/immutable_task"
 include Capistrano::DSL
 
 namespace :load do
   task :defaults do
-    load 'capistrano/defaults.rb'
+    load "capistrano/defaults.rb"
   end
 end
 
+require "airbrussh/capistrano"
+# We don't need to show the "using Airbrussh" banner announcement since
+# Airbrussh is now the built-in formatter. Also enable command output by
+# default; hiding the output might be confusing to users new to Capistrano.
+Airbrussh.configure do |airbrussh|
+  airbrussh.banner = false
+  airbrussh.command_output = true
+end
+
 stages.each do |stage|
   Rake::Task.define_task(stage) do
     set(:stage, stage.to_sym)
 
-    invoke 'load:defaults'
-    load deploy_config_path
-    load stage_config_path.join("#{stage}.rb")
-    load "capistrano/#{fetch(:scm)}.rb"
+    invoke "load:defaults"
+    Rake.application["load:defaults"].extend(Capistrano::ImmutableTask)
+    env.variables.untrusted! do
+      load deploy_config_path
+      load stage_config_path.join("#{stage}.rb")
+    end
+    configure_scm
     I18n.locale = fetch(:locale, :en)
     configure_backend
   end
 end
 
-require 'capistrano/dotfile'
+require "capistrano/dotfile"

data/lib/capistrano/tasks/console.rake

@@ -1,20 +1,16 @@
-desc 'Execute remote commands'
+desc "Execute remote commands"
 task :console do
   stage = fetch(:stage)
-  puts I18n.t('console.welcome', scope: :capistrano, stage: stage)
+  puts I18n.t("console.welcome", scope: :capistrano, stage: stage)
   loop do
     print "#{stage}> "
 
-    if input = $stdin.gets
-      command = input.chomp
-    else
-      command = 'exit'
-    end
+    command = (input = $stdin.gets) ? input.chomp : "exit"
 
     next if command.empty?
 
     if %w{quit exit q}.include? command
-      puts t('console.bye')
+      puts t("console.bye")
       break
     else
       begin

data/lib/capistrano/tasks/deploy.rake

@@ -1,70 +1,88 @@
 namespace :deploy do
-
   task :starting do
-    invoke 'deploy:check'
-    invoke 'deploy:set_previous_revision'
+    invoke "deploy:print_config_variables" if fetch(:print_config_variables, false)
+    invoke "deploy:check"
+    invoke "deploy:set_previous_revision"
+  end
+
+  task :print_config_variables do
+    puts
+    puts "------- Printing current config variables -------"
+    env.keys.each do |config_variable_key|
+      if is_question?(config_variable_key)
+        puts "#{config_variable_key.inspect} => Question (awaits user input on next fetch(#{config_variable_key.inspect}))"
+      else
+        puts "#{config_variable_key.inspect} => #{fetch(config_variable_key).inspect}"
+      end
+    end
+
+    puts
+    puts "------- Printing current config variables of SSHKit mechanism -------"
+    puts env.backend.config.inspect
+    # puts env.backend.config.backend.config.ssh_options.inspect
+    # puts env.backend.config.command_map.defaults.inspect
+
+    puts
   end
 
-  task :updating => :new_release_path do
-    invoke "#{scm}:create_release"
+  task updating: :new_release_path do
     invoke "deploy:set_current_revision"
-    invoke 'deploy:symlink:shared'
+    invoke "deploy:symlink:shared"
   end
 
   task :reverting do
-    invoke 'deploy:revert_release'
+    invoke "deploy:revert_release"
   end
 
   task :publishing do
-    invoke 'deploy:symlink:release'
+    invoke "deploy:symlink:release"
   end
 
   task :finishing do
-    invoke 'deploy:cleanup'
+    invoke "deploy:cleanup"
   end
 
   task :finishing_rollback do
-    invoke 'deploy:cleanup_rollback'
+    invoke "deploy:cleanup_rollback"
   end
 
   task :finished do
-    invoke 'deploy:log_revision'
+    invoke "deploy:log_revision"
   end
 
-  desc 'Check required files and directories exist'
+  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'
-    invoke 'deploy:check:linked_files'
+    invoke "deploy:check:directories"
+    invoke "deploy:check:linked_dirs"
+    invoke "deploy:check:make_linked_dirs"
+    invoke "deploy:check:linked_files"
   end
 
   namespace :check do
-    desc 'Check shared and release directories exist'
+    desc "Check shared and release directories exist"
     task :directories do
       on release_roles :all do
-        execute :mkdir, '-p', shared_path, releases_path
+        execute :mkdir, "-p", shared_path, releases_path
       end
     end
 
-    desc 'Check directories to be linked exist in shared'
+    desc "Check directories to be linked exist in shared"
     task :linked_dirs do
       next unless any? :linked_dirs
       on release_roles :all do
-        execute :mkdir, '-p', linked_dirs(shared_path)
+        execute :mkdir, "-p", linked_dirs(shared_path)
       end
     end
 
-    desc 'Check directories of files to be linked exist in shared'
+    desc "Check directories of files to be linked exist in shared"
     task :make_linked_dirs do
       next unless any? :linked_files
-      on release_roles :all do |host|
-        execute :mkdir, '-p', linked_file_dirs(shared_path)
+      on release_roles :all do |_host|
+        execute :mkdir, "-p", linked_file_dirs(shared_path)
       end
     end
 
-    desc 'Check files to be linked exist in shared'
+    desc "Check files to be linked exist in shared"
     task :linked_files do
       next unless any? :linked_files
       on release_roles :all do |host|
@@ -79,72 +97,80 @@ namespace :deploy do
   end
 
   namespace :symlink do
-    desc 'Symlink release to current'
+    desc "Symlink release to current"
     task :release do
       on release_roles :all do
         tmp_current_path = release_path.parent.join(current_path.basename)
-        execute :ln, '-s', release_path, tmp_current_path
+        execute :ln, "-s", release_path, tmp_current_path
         execute :mv, tmp_current_path, current_path.parent
       end
     end
 
-    desc 'Symlink files and directories from shared to release'
+    desc "Symlink files and directories from shared to release"
     task :shared do
-      invoke 'deploy:symlink:linked_files'
-      invoke 'deploy:symlink:linked_dirs'
+      invoke "deploy:symlink:linked_files"
+      invoke "deploy:symlink:linked_dirs"
     end
 
-    desc 'Symlink linked directories'
+    desc "Symlink linked directories"
     task :linked_dirs do
       next unless any? :linked_dirs
       on release_roles :all do
-        execute :mkdir, '-p', linked_dir_parents(release_path)
+        execute :mkdir, "-p", linked_dir_parents(release_path)
 
         fetch(:linked_dirs).each do |dir|
           target = release_path.join(dir)
           source = shared_path.join(dir)
-          unless test "[ -L #{target} ]"
-            if test "[ -d #{target} ]"
-              execute :rm, '-rf', target
-            end
-            execute :ln, '-s', source, target
-          end
+          next if test "[ -L #{target} ]"
+          execute :rm, "-rf", target if test "[ -d #{target} ]"
+          execute :ln, "-s", source, target
         end
       end
     end
 
-    desc 'Symlink linked files'
+    desc "Symlink linked files"
     task :linked_files do
       next unless any? :linked_files
       on release_roles :all do
-        execute :mkdir, '-p', linked_file_dirs(release_path)
+        execute :mkdir, "-p", linked_file_dirs(release_path)
 
         fetch(:linked_files).each do |file|
           target = release_path.join(file)
           source = shared_path.join(file)
-          unless test "[ -L #{target} ]"
-            if test "[ -f #{target} ]"
-              execute :rm, target
-            end
-            execute :ln, '-s', source, target
-          end
+          next if test "[ -L #{target} ]"
+          execute :rm, target if test "[ -f #{target} ]"
+          execute :ln, "-s", source, target
         end
       end
     end
   end
 
-  desc 'Clean up old releases'
+  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)
-        info t(:keeping_releases, host: host.to_s, keep_releases: fetch(:keep_releases), releases: releases.count)
-        directories = (releases - releases.last(fetch(:keep_releases)))
+      releases = capture(:ls, "-x", releases_path).split
+      valid, invalid = releases.partition { |e| /^\d{14}$/ =~ e }
+
+      warn t(:skip_cleanup, host: host.to_s) if invalid.any?
+
+      if valid.count >= fetch(:keep_releases)
+        info t(:keeping_releases, host: host.to_s, keep_releases: fetch(:keep_releases), releases: valid.count)
+        directories = (valid - valid.last(fetch(:keep_releases))).map do |release|
+          releases_path.join(release).to_s
+        end
+        if test("[ -d #{current_path} ]")
+          current_release = capture(:readlink, current_path).to_s
+          if directories.include?(current_release)
+            warn t(:wont_delete_current_release, host: host.to_s)
+            directories.delete(current_release)
+          end
+        else
+          debug t(:no_current_release, host: host.to_s)
+        end
         if directories.any?
-          directories_str = directories.map do |release|
-            releases_path.join(release)
-          end.join(" ")
-          execute :rm, '-rf', directories_str
+          directories.each_slice(100) do |directories_batch|
+            execute :rm, "-rf", *directories_batch
+          end
         else
           info t(:no_old_releases, host: host.to_s, keep_releases: fetch(:keep_releases))
         end
@@ -152,33 +178,33 @@ namespace :deploy do
     end
   end
 
-  desc 'Remove and archive rolled-back release.'
+  desc "Remove and archive rolled-back release."
   task :cleanup_rollback do
     on release_roles(:all) do
-      last_release = capture(:ls, '-xt', releases_path).split.first
+      last_release = capture(:ls, "-xt", releases_path).split.first
       last_release_path = releases_path.join(last_release)
       if test "[ `readlink #{current_path}` != #{last_release_path} ]"
-        execute :tar, '-czf',
-          deploy_path.join("rolled-back-release-#{last_release}.tar.gz"),
-        last_release_path
-        execute :rm, '-rf', last_release_path
+        execute :tar, "-czf",
+                deploy_path.join("rolled-back-release-#{last_release}.tar.gz"),
+                last_release_path
+        execute :rm, "-rf", last_release_path
       else
-        debug 'Last release is the current release, skip cleanup_rollback.'
+        debug "Last release is the current release, skip cleanup_rollback."
       end
     end
   end
 
-  desc 'Log details of the deploy'
+  desc "Log details of the deploy"
   task :log_revision do
     on release_roles(:all) do
       within releases_path do
-        execute %{echo "#{revision_log_message}" >> #{revision_log}}
+        execute :echo, %Q{"#{revision_log_message}" >> #{revision_log}}
       end
     end
   end
 
-  desc 'Revert to previous release timestamp'
-  task :revert_release => :rollback_release_path do
+  desc "Revert to previous release timestamp"
+  task revert_release: :rollback_release_path do
     on release_roles(:all) do
       set(:revision_log_message, rollback_log_message)
     end
@@ -190,12 +216,20 @@ namespace :deploy do
 
   task :rollback_release_path do
     on release_roles(:all) do
-      releases = capture(:ls, '-xt', releases_path).split
+      releases = capture(:ls, "-xt", releases_path).split
       if releases.count < 2
         error t(:cannot_rollback)
         exit 1
       end
-      last_release = releases[1]
+
+      rollback_release = ENV["ROLLBACK_RELEASE"]
+      index = rollback_release.nil? ? 1 : releases.index(rollback_release)
+      if index.nil?
+        error t(:cannot_found_rollback_release, release: rollback_release)
+        exit 1
+      end
+
+      last_release = releases[index]
       set_release_path(last_release)
       set(:rollback_timestamp, last_release)
     end
@@ -203,24 +237,22 @@ 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"
+        execute :echo, "\"#{fetch(:current_revision)}\" > REVISION"
       end
     end
   end
 
   task :set_previous_revision do
     on release_roles(:all) do
-      target = release_path.join('REVISION')
+      target = release_path.join("REVISION")
       if test "[ -f #{target} ]"
-        set(:previous_revision, capture(:cat, target, '2>/dev/null'))
+        set(:previous_revision, capture(:cat, target, "2>/dev/null"))
       end
     end
   end
 
   task :restart
   task :failed
-
 end

data/lib/capistrano/tasks/doctor.rake

@@ -0,0 +1,24 @@
+desc "Display a Capistrano troubleshooting report (all doctor: tasks)"
+task doctor: ["doctor:environment", "doctor:gems", "doctor:variables", "doctor:servers"]
+
+namespace :doctor do
+  desc "Display Ruby environment details"
+  task :environment do
+    Capistrano::Doctor::EnvironmentDoctor.new.call
+  end
+
+  desc "Display Capistrano gem versions"
+  task :gems do
+    Capistrano::Doctor::GemsDoctor.new.call
+  end
+
+  desc "Display the values of all Capistrano variables"
+  task :variables do
+    Capistrano::Doctor::VariablesDoctor.new.call
+  end
+
+  desc "Display the effective servers configuration"
+  task :servers do
+    Capistrano::Doctor::ServersDoctor.new.call
+  end
+end

data/lib/capistrano/tasks/framework.rake

@@ -1,50 +1,49 @@
 namespace :deploy do
-
-  desc 'Start a deployment, make sure server(s) ready.'
+  desc "Start a deployment, make sure server(s) ready."
   task :starting do
   end
 
-  desc 'Started'
+  desc "Started"
   task :started do
   end
 
-  desc 'Update server(s) by setting up a new release.'
+  desc "Update server(s) by setting up a new release."
   task :updating do
   end
 
-  desc 'Updated'
+  desc "Updated"
   task :updated do
   end
 
-  desc 'Revert server(s) to previous release.'
+  desc "Revert server(s) to previous release."
   task :reverting do
   end
 
-  desc 'Reverted'
+  desc "Reverted"
   task :reverted do
   end
 
-  desc 'Publish the release.'
+  desc "Publish the release."
   task :publishing do
   end
 
-  desc 'Published'
+  desc "Published"
   task :published do
   end
 
-  desc 'Finish the deployment, clean up server(s).'
+  desc "Finish the deployment, clean up server(s)."
   task :finishing do
   end
 
-  desc 'Finish the rollback, clean up server(s).'
+  desc "Finish the rollback, clean up server(s)."
   task :finishing_rollback do
   end
 
-  desc 'Finished'
+  desc "Finished"
   task :finished do
   end
 
-  desc 'Rollback to previous release.'
+  desc "Rollback to previous release."
   task :rollback do
     %w{ starting started
         reverting reverted
@@ -55,7 +54,7 @@ namespace :deploy do
   end
 end
 
-desc 'Deploy a new release.'
+desc "Deploy a new release."
 task :deploy do
   set(:deploying, true)
   %w{ starting started

data/lib/capistrano/tasks/install.rake

@@ -1,12 +1,12 @@
-require 'erb'
-require 'pathname'
-desc 'Install Capistrano, cap install STAGES=staging,production'
+require "erb"
+require "pathname"
+desc "Install Capistrano, cap install STAGES=staging,production"
 task :install do
-  envs = ENV['STAGES'] || 'staging,production'
+  envs = ENV["STAGES"] || "staging,production"
 
-  tasks_dir = Pathname.new('lib/capistrano/tasks')
-  config_dir = Pathname.new('config')
-  deploy_dir = config_dir.join('deploy')
+  tasks_dir = Pathname.new("lib/capistrano/tasks")
+  config_dir = Pathname.new("config")
+  deploy_dir = config_dir.join("deploy")
 
   deploy_rb = File.expand_path("../../templates/deploy.rb.erb", __FILE__)
   stage_rb = File.expand_path("../../templates/stage.rb.erb", __FILE__)
@@ -14,14 +14,14 @@ task :install do
 
   mkdir_p deploy_dir
 
-  entries = [{template: deploy_rb, file: config_dir.join('deploy.rb')}]
-  entries += envs.split(',').map { |stage| {template: stage_rb, file: deploy_dir.join("#{stage}.rb")} }
+  entries = [{ template: deploy_rb, file: config_dir.join("deploy.rb") }]
+  entries += envs.split(",").map { |stage| { template: stage_rb, file: deploy_dir.join("#{stage}.rb") } }
 
   entries.each do |entry|
-    if File.exists?(entry[:file])
+    if File.exist?(entry[:file])
       warn "[skip] #{entry[:file]} already exists"
     else
-      File.open(entry[:file], 'w+') do |f|
+      File.open(entry[:file], "w+") do |f|
         f.write(ERB.new(File.read(entry[:template])).result(binding))
         puts I18n.t(:written_file, scope: :capistrano, file: entry[:file])
       end
@@ -30,13 +30,12 @@ task :install do
 
   mkdir_p tasks_dir
 
-  if File.exists?('Capfile')
+  if File.exist?("Capfile")
     warn "[skip] Capfile already exists"
   else
-    FileUtils.cp(capfile, 'Capfile')
-    puts I18n.t(:written_file, scope: :capistrano, file: 'Capfile')
+    FileUtils.cp(capfile, "Capfile")
+    puts I18n.t(:written_file, scope: :capistrano, file: "Capfile")
   end
 
-
   puts I18n.t :capified, scope: :capistrano
 end

data/lib/capistrano/templates/Capfile

@@ -1,8 +1,19 @@
 # Load DSL and set up stages
-require 'capistrano/setup'
+require "capistrano/setup"
 
 # Include default deployment tasks
-require 'capistrano/deploy'
+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
 #
@@ -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 }
+Dir.glob("lib/capistrano/tasks/*.rake").each { |r| import r }