capistrano 3.5.0 → 3.6.0

data/lib/capistrano/proc_helpers.rb

@@ -0,0 +1,13 @@
+module Capistrano
+  module ProcHelpers
+    module_function
+
+    # Tests whether the given object appears to respond to `call` with
+    # zero parameters. In Capistrano, such a proc is used to represent a
+    # "deferred value". That is, a value that is resolved by invoking `call` at
+    # the time it is first needed.
+    def callable_without_parameters?(x)
+      x.respond_to?(:call) && (!x.respond_to?(:arity) || x.arity.zero?)
+    end
+  end
+end

data/lib/capistrano/tasks/deploy.rake

@@ -209,7 +209,15 @@ namespace :deploy do
         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

data/lib/capistrano/tasks/doctor.rake

@@ -1,5 +1,5 @@
 desc "Display a Capistrano troubleshooting report (all doctor: tasks)"
-task doctor: ["doctor:environment", "doctor:gems", "doctor:variables"]
+task doctor: ["doctor:environment", "doctor:gems", "doctor:variables", "doctor:servers"]
 
 namespace :doctor do
   desc "Display Ruby environment details"
@@ -16,4 +16,9 @@ namespace :doctor do
   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/git.rake

@@ -3,19 +3,26 @@ namespace :git do
     @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(:tmp_dir)}/#{fetch(:application)}/git-ssh.sh"
+      git_ssh: fetch(:git_wrapper_path)
     }
   }
 
   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, "+rx", "#{fetch(:tmp_dir)}/#{fetch(:application)}/git-ssh.sh"
+      execute :mkdir, "-p", File.dirname(fetch(:git_wrapper_path))
+      upload! StringIO.new("#!/bin/sh -e\nexec /usr/bin/ssh -o PasswordAuthentication=no -o StrictHostKeyChecking=no \"$@\"\n"), fetch(:git_wrapper_path)
+      execute :chmod, "700", fetch(:git_wrapper_path)
     end
   end
 

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

@@ -24,26 +24,13 @@ set :repo_url, 'git@example.com:me/my_repo.git'
 # set :pty, true
 
 # Default value for :linked_files is []
-# set :linked_files, fetch(:linked_files, []).push('config/database.yml', 'config/secrets.yml')
+# append :linked_files, 'config/database.yml', 'config/secrets.yml'
 
 # Default value for linked_dirs is []
-# set :linked_dirs, fetch(:linked_dirs, []).push('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" }
 
 # Default value for keep_releases is 5
 # set :keep_releases, 5
-
-namespace :deploy do
-
-  after :restart, :clear_cache do
-    on roles(:web), in: :groups, limit: 3, wait: 10 do
-      # Here we can do anything such as:
-      # within release_path do
-      #   execute :rake, 'cache:clear'
-      # end
-    end
-  end
-
-end

data/lib/capistrano/version.rb

@@ -1,3 +1,3 @@
 module Capistrano
-  VERSION = "3.5.0".freeze
+  VERSION = "3.6.0".freeze
 end

data/spec/lib/capistrano/configuration/empty_filter_spec.rb

@@ -5,7 +5,7 @@ module Capistrano
     describe EmptyFilter do
       subject(:empty_filter) { EmptyFilter.new }
 
-      describe '#filter' do
+      describe "#filter" do
         let(:servers) { mock("servers") }
 
         it "returns an empty array" do

data/spec/lib/capistrano/configuration/filter_spec.rb

@@ -13,7 +13,7 @@ module Capistrano
         ]
       end
 
-      describe '#new' do
+      describe "#new" do
         it "won't create an invalid type of filter" do
           expect do
             Filter.new(:zarg)
@@ -73,12 +73,12 @@ module Capistrano
         end
       end
 
-      describe '#filter' do
+      describe "#filter" do
         let(:strategy) { filter.instance_variable_get(:@strategy) }
         let(:results) { mock("result") }
 
-        shared_examples 'it calls #filter on its strategy' do
-          it 'calls #filter on its strategy' do
+        shared_examples "it calls #filter on its strategy" do
+          it "calls #filter on its strategy" do
             strategy.expects(:filter).with(available).returns(results)
             expect(filter.filter(available)).to eq(results)
           end
@@ -86,22 +86,22 @@ module Capistrano
 
         context "for an empty filter" do
           let(:filter) { Filter.new(:role) }
-          it_behaves_like 'it calls #filter on its strategy'
+          it_behaves_like "it calls #filter on its strategy"
         end
 
         context "for a null filter" do
           let(:filter) { Filter.new(:role, :all) }
-          it_behaves_like 'it calls #filter on its strategy'
+          it_behaves_like "it calls #filter on its strategy"
         end
 
         context "for a role filter" do
           let(:filter) { Filter.new(:role, "web") }
-          it_behaves_like 'it calls #filter on its strategy'
+          it_behaves_like "it calls #filter on its strategy"
         end
 
         context "for a host filter" do
           let(:filter) { Filter.new(:host, "server1") }
-          it_behaves_like 'it calls #filter on its strategy'
+          it_behaves_like "it calls #filter on its strategy"
         end
       end
     end

data/spec/lib/capistrano/configuration/host_filter_spec.rb

@@ -20,7 +20,7 @@ module Capistrano
         end
       end
 
-      describe '#filter' do
+      describe "#filter" do
         context "with a string" do
           let(:values) { "server1" }
           it_behaves_like "it filters hosts correctly", %w{server1}

data/spec/lib/capistrano/configuration/null_filter_spec.rb

@@ -5,7 +5,7 @@ module Capistrano
     describe NullFilter do
       subject(:null_filter) { NullFilter.new }
 
-      describe '#filter' do
+      describe "#filter" do
         let(:servers) { mock("servers") }
 
         it "returns the servers passed in as arguments" do

data/spec/lib/capistrano/configuration/question_spec.rb

@@ -15,7 +15,7 @@ module Capistrano
         end
       end
 
-      describe '#call' do
+      describe "#call" do
         context "value is entered" do
           let(:branch) { "branch" }
 

data/spec/lib/capistrano/configuration/role_filter_spec.rb

@@ -23,7 +23,7 @@ module Capistrano
         end
       end
 
-      describe '#filter' do
+      describe "#filter" do
         context "with a single role string" do
           let(:values) { "web" }
           it_behaves_like "it filters roles correctly", 2, %w{server1 server2}

data/spec/lib/capistrano/configuration/server_spec.rb

@@ -141,7 +141,7 @@ module Capistrano
         end
       end
 
-      describe '#include?' do
+      describe "#include?" do
         let(:options) { {} }
 
         subject { server.select?(options) }
@@ -269,7 +269,8 @@ module Capistrano
               user: "another_user",
               keys: %w(/home/another_user/.ssh/id_rsa),
               forward_agent: false,
-              auth_methods: %w(publickey password) } }
+              auth_methods: %w(publickey password)
+            } }
           end
 
           before do

data/spec/lib/capistrano/configuration_spec.rb

@@ -150,13 +150,23 @@ module Capistrano
           end
         end
 
-        it "validates without error" do
+        it "validates string without error" do
           config.set(:key, "longer_value")
         end
 
-        it "raises an exception" do
+        it "validates proc without error" do
+          config.set(:key) { "longer_value" }
+          expect(config.fetch(:key)).to eq "longer_value"
+        end
+
+        it "raises an exception on invalid string" do
           expect { config.set(:key, "sho") }.to raise_error(Capistrano::ValidationError)
         end
+
+        it "raises an exception on invalid string provided by proc" do
+          config.set(:key) { "sho" }
+          expect { config.fetch(:key) }.to raise_error(Capistrano::ValidationError)
+        end
       end
 
       context "appending" do
@@ -265,7 +275,10 @@ module Capistrano
           config.set :ssh_options, user: "albert"
           SSHKit::Backend::Netssh.configure { |ssh| ssh.ssh_options = { password: "einstein" } }
           config.configure_backend
-          expect(config.backend.config.backend.config.ssh_options).to eq(user: "albert", password: "einstein")
+
+          expect(
+            config.backend.config.backend.config.ssh_options
+          ).to include(user: "albert", password: "einstein")
         end
       end
     end

data/spec/lib/capistrano/doctor/gems_doctor_spec.rb

@@ -2,6 +2,7 @@ require "spec_helper"
 require "capistrano/doctor/gems_doctor"
 require "airbrussh/version"
 require "sshkit/version"
+require "net/ssh/version"
 
 module Capistrano
   module Doctor
@@ -32,6 +33,11 @@ module Capistrano
           output(/airbrussh\s+#{Regexp.quote(Airbrussh::VERSION)}/).to_stdout
       end
 
+      it "prints the net-ssh version" do
+        expect { doc.call }.to\
+          output(/net-ssh\s+#{Regexp.quote(Net::SSH::Version::STRING)}/).to_stdout
+      end
+
       it "warns that new version is available" do
         Gem.stubs(:latest_version_for).returns(Gem::Version.new("99.0.0"))
         expect { doc.call }.to output(/\(update available\)/).to_stdout

data/spec/lib/capistrano/doctor/servers_doctor_spec.rb

@@ -0,0 +1,86 @@
+require "spec_helper"
+require "capistrano/doctor/servers_doctor"
+
+module Capistrano
+  module Doctor
+    describe ServersDoctor do
+      include Capistrano::DSL
+      let(:doc) { ServersDoctor.new }
+
+      before { Capistrano::Configuration.reset! }
+      after { Capistrano::Configuration.reset! }
+
+      it "prints using 4-space indentation" do
+        expect { doc.call }.to output(/^ {4}/).to_stdout
+      end
+
+      it "prints the number of defined servers" do
+        role :app, %w(example.com)
+        server "www@example.com:22"
+
+        expect { doc.call }.to output(/Servers \(2\)/).to_stdout
+      end
+
+      describe "prints the server's details" do
+        it "including username" do
+          server "www@example.com"
+          expect { doc.call }.to output(/www@example.com/).to_stdout
+        end
+
+        it "including port" do
+          server "www@example.com:22"
+          expect { doc.call }.to output(/www@example.com:22/).to_stdout
+        end
+
+        it "including roles" do
+          role :app, %w(example.com)
+          expect { doc.call }.to output(/example.com\s+\[:app\]/).to_stdout
+        end
+
+        it "including empty roles" do
+          server "example.com"
+          expect { doc.call }.to output(/example.com\s+\[\]/).to_stdout
+        end
+
+        it "including properties" do
+          server "example.com", roles: %w(app db), primary: true
+          expect { doc.call }.to \
+            output(/example.com\s+\[:app, :db\]\s+\{ :primary => true \}/).to_stdout
+        end
+
+        it "including misleading role name alert" do
+          server "example.com", roles: ["web app db"]
+          warning_msg = 'Whitespace detected in role(s) :"web app db". ' \
+            'This might be a result of a mistyped "%w()" array literal'
+
+          expect { doc.call }.to output(/#{Regexp.escape(warning_msg)}/).to_stdout
+        end
+      end
+
+      it "doesn't fail for no servers" do
+        expect { doc.call }.to output("\nServers (0)\n    \n").to_stdout
+      end
+
+      describe "Rake" do
+        before do
+          load File.expand_path("../../../../../lib/capistrano/doctor.rb",
+                                __FILE__)
+        end
+
+        after do
+          Rake::Task.clear
+        end
+
+        it "has an doctor:servers task that calls ServersDoctor" do
+          ServersDoctor.any_instance.expects(:call)
+          Rake::Task["doctor:servers"].invoke
+        end
+
+        it "has a doctor task that depends on doctor:servers" do
+          expect(Rake::Task["doctor"].prerequisites).to \
+            include("doctor:servers")
+        end
+      end
+    end
+  end
+end

data/spec/lib/capistrano/doctor/variables_doctor_spec.rb

@@ -15,8 +15,10 @@ module Capistrano
         env.variables.untrusted! do
           set :application, "my_app"
           set :repo_url, ".git"
+          set :git_strategy, "Capistrano::Git::DefaultStrategy"
           set :copy_strategy, :scp
           set :custom_setting, "hello"
+          set "string_setting", "hello"
           ask :secret
         end
 
@@ -36,6 +38,7 @@ module Capistrano
         expect { doc.call }.to output(/:repo_url\s+".git"$/).to_stdout
         expect { doc.call }.to output(/:copy_strategy\s+:scp$/).to_stdout
         expect { doc.call }.to output(/:custom_setting\s+"hello"$/).to_stdout
+        expect { doc.call }.to output(/"string_setting"\s+"hello"$/).to_stdout
       end
 
       it "prints unanswered question variable as <ask>" do
@@ -54,6 +57,12 @@ module Capistrano
           .to_stdout
       end
 
+      it "does not print warning for the whitelisted git_strategy variable" do
+        expect { doc.call }.not_to \
+          output(/:git_strategy is not a recognized Capistrano setting/)\
+          .to_stdout
+      end
+
       describe "Rake" do
         before do
           load File.expand_path("../../../../../lib/capistrano/doctor.rb",

data/spec/lib/capistrano/dsl/paths_spec.rb

@@ -12,7 +12,7 @@ describe Capistrano::DSL::Paths do
     dsl.set(:deploy_to, "/var/www")
   end
 
-  describe '#linked_dirs' do
+  describe "#linked_dirs" do
     subject { paths.linked_dirs(parent) }
 
     before do
@@ -27,7 +27,7 @@ describe Capistrano::DSL::Paths do
     end
   end
 
-  describe '#linked_files' do
+  describe "#linked_files" do
     subject { paths.linked_files(parent) }
 
     before do
@@ -43,7 +43,7 @@ describe Capistrano::DSL::Paths do
     end
   end
 
-  describe '#linked_file_dirs' do
+  describe "#linked_file_dirs" do
     subject { paths.linked_file_dirs(parent) }
 
     before do
@@ -58,7 +58,7 @@ describe Capistrano::DSL::Paths do
     end
   end
 
-  describe '#linked_dir_parents' do
+  describe "#linked_dir_parents" do
     subject { paths.linked_dir_parents(parent) }
 
     before do
@@ -73,7 +73,7 @@ describe Capistrano::DSL::Paths do
     end
   end
 
-  describe '#release path' do
+  describe "#release path" do
     subject { dsl.release_path }
 
     context "where no release path has been set" do
@@ -97,7 +97,7 @@ describe Capistrano::DSL::Paths do
     end
   end
 
-  describe '#set_release_path' do
+  describe "#set_release_path" do
     let(:now) { Time.parse("Oct 21 16:29:00 2015") }
     subject { dsl.release_path }
 
@@ -123,7 +123,7 @@ describe Capistrano::DSL::Paths do
     end
   end
 
-  describe '#deploy_config_path' do
+  describe "#deploy_config_path" do
     subject { dsl.deploy_config_path.to_s }
 
     context "when not specified" do
@@ -147,7 +147,7 @@ describe Capistrano::DSL::Paths do
     end
   end
 
-  describe '#stage_config_path' do
+  describe "#stage_config_path" do
     subject { dsl.stage_config_path.to_s }
 
     context "when not specified" do
@@ -171,7 +171,7 @@ describe Capistrano::DSL::Paths do
     end
   end
 
-  describe '#repo_path' do
+  describe "#repo_path" do
     subject { dsl.repo_path.to_s }
 
     context "when not specified" do