capistrano 3.4.1 → 3.5.0

data/lib/capistrano/svn.rb

@@ -1,13 +1,15 @@
 load File.expand_path("../tasks/svn.rake", __FILE__)
 
-require 'capistrano/scm'
+require "capistrano/scm"
 
 class Capistrano::Svn < Capistrano::SCM
-  
   # execute svn in context with arguments
   def svn(*args)
     args.unshift(:svn)
-    context.execute *args
+    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)
+    context.execute(*args)
   end
 
   module DefaultStrategy
@@ -16,7 +18,9 @@ class Capistrano::Svn < Capistrano::SCM
     end
 
     def check
-      test! :svn, :info, repo_url
+      svn_username = fetch(:svn_username) ? "--username #{fetch(:svn_username)}" : ""
+      svn_password = fetch(:svn_password) ? "--password #{fetch(:svn_password)}" : ""
+      test! :svn, :info, repo_url, svn_username, svn_password
     end
 
     def clone
@@ -28,7 +32,7 @@ class Capistrano::Svn < Capistrano::SCM
     end
 
     def release
-      svn :export, '--force', '.', release_path
+      svn :export, "--force", ".", release_path
     end
 
     def fetch_revision

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,90 @@
 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
+  task updating: :new_release_path do
     invoke "#{scm}:create_release"
     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,64 +99,58 @@ 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
+      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)))
@@ -144,7 +158,7 @@ namespace :deploy do
           directories_str = directories.map do |release|
             releases_path.join(release)
           end.join(" ")
-          execute :rm, '-rf', directories_str
+          execute :rm, "-rf", directories_str
         else
           info t(:no_old_releases, host: host.to_s, keep_releases: fetch(:keep_releases))
         end
@@ -152,33 +166,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,7 +204,7 @@ 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
@@ -213,14 +227,13 @@ namespace :deploy do
 
   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,19 @@
+desc "Display a Capistrano troubleshooting report (all doctor: tasks)"
+task doctor: ["doctor:environment", "doctor:gems", "doctor:variables"]
+
+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
+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/git.rake

@@ -1,26 +1,25 @@
 namespace :git do
-
   def strategy
     @strategy ||= Capistrano::Git.new(self, fetch(:git_strategy, Capistrano::Git::DefaultStrategy))
   end
 
-  set :git_environmental_variables, ->() {
+  set :git_environmental_variables, lambda {
     {
       git_askpass: "/bin/echo",
-      git_ssh:     "#{fetch(:tmp_dir)}/#{fetch(:application)}/git-ssh.sh"
+      git_ssh: "#{fetch(:tmp_dir)}/#{fetch(:application)}/git-ssh.sh"
     }
   }
 
-  desc 'Upload the git wrapper script, this script guarantees that we can script git without getting an interactive prompt'
+  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
       execute :mkdir, "-p", "#{fetch(:tmp_dir)}/#{fetch(:application)}/"
       upload! StringIO.new("#!/bin/sh -e\nexec /usr/bin/ssh -o PasswordAuthentication=no -o StrictHostKeyChecking=no \"$@\"\n"), "#{fetch(:tmp_dir)}/#{fetch(:application)}/git-ssh.sh"
-      execute :chmod, "+x", "#{fetch(:tmp_dir)}/#{fetch(:application)}/git-ssh.sh"
+      execute :chmod, "+rx", "#{fetch(:tmp_dir)}/#{fetch(:application)}/git-ssh.sh"
     end
   end
 
-  desc 'Check that the repository is reachable'
+  desc "Check that the repository is reachable"
   task check: :'git:wrapper' do
     fetch(:branch)
     on release_roles :all do
@@ -30,7 +29,7 @@ namespace :git do
     end
   end
 
-  desc 'Clone the repo to the cache'
+  desc "Clone the repo to the cache"
   task clone: :'git:wrapper' do
     on release_roles :all do
       if strategy.test
@@ -45,7 +44,7 @@ namespace :git do
     end
   end
 
-  desc 'Update the repo mirror to reflect the origin state'
+  desc "Update the repo mirror to reflect the origin state"
   task update: :'git:clone' do
     on release_roles :all do
       within repo_path do
@@ -56,19 +55,19 @@ namespace :git do
     end
   end
 
-  desc 'Copy repo to releases'
+  desc "Copy repo to releases"
   task create_release: :'git:update' do
     on release_roles :all do
       with fetch(:git_environmental_variables) do
         within repo_path do
-          execute :mkdir, '-p', release_path
+          execute :mkdir, "-p", release_path
           strategy.release
         end
       end
     end
   end
 
-  desc 'Determine the revision that will be deployed'
+  desc "Determine the revision that will be deployed"
   task :set_current_revision do
     on release_roles :all do
       within repo_path do