capistrano 3.7.0 → 3.17.0

data/spec/integration/dsl_spec.rb

@@ -356,14 +356,16 @@ describe Capistrano::DSL do
   end
 
   describe "asking for a variable" do
+    let(:stdin) { stub(tty?: true) }
+
     before do
-      dsl.ask(:scm, :svn)
+      dsl.ask(:scm, :svn, stdin: stdin)
       $stdout.stubs(:print)
     end
 
     context "variable is provided" do
       before do
-        $stdin.expects(:gets).returns("git")
+        stdin.expects(:gets).returns("git")
       end
 
       it "sets the input as the variable" do
@@ -373,7 +375,7 @@ describe Capistrano::DSL do
 
     context "variable is not provided" do
       before do
-        $stdin.expects(:gets).returns("")
+        stdin.expects(:gets).returns("")
       end
 
       it "sets the variable as the default" do

data/spec/lib/capistrano/application_spec.rb

@@ -5,46 +5,40 @@ describe Capistrano::Application do
 
   it "provides a --format option which enables the choice of output formatting"
 
-  let(:help_output) do
-    out, _err = capture_io do
-      flags "--help", "-h"
-    end
-    out
-  end
-
-  it "displays documentation URL as help banner" do
-    expect(help_output.lines.first).to match(/capistranorb.com/)
+  it "displays documentation URL as help banner", capture_io: true do
+    flags "--help", "-h"
+    expect($stdout.string.each_line.first).to match(/capistranorb.com/)
   end
 
   %w(quiet silent verbose).each do |switch|
-    it "doesn't include --#{switch} in help" do
-      expect(help_output).not_to match(/--#{switch}/)
+    it "doesn't include --#{switch} in help", capture_io: true do
+      flags "--help", "-h"
+      expect($stdout.string).not_to match(/--#{switch}/)
     end
   end
 
-  it "overrides the rake method, but still prints the rake version" do
-    out, _err = capture_io do
-      flags "--version", "-V"
-    end
+  it "overrides the rake method, but still prints the rake version", capture_io: true do
+    flags "--version", "-V"
+    out = $stdout.string
     expect(out).to match(/\bCapistrano Version\b/)
     expect(out).to match(/\b#{Capistrano::VERSION}\b/)
     expect(out).to match(/\bRake Version\b/)
     expect(out).to match(/\b#{Rake::VERSION}\b/)
   end
 
-  it "overrides the rake method, and sets the sshkit_backend to SSHKit::Backend::Printer" do
-    capture_io do
-      flags "--dry-run", "-n"
-    end
+  it "overrides the rake method, and sets the sshkit_backend to SSHKit::Backend::Printer", capture_io: true do
+    flags "--dry-run", "-n"
     sshkit_backend = Capistrano::Configuration.fetch(:sshkit_backend)
     expect(sshkit_backend).to eq(SSHKit::Backend::Printer)
   end
 
-  it "enables printing all config variables on command line parameter" do
-    capture_io do
+  it "enables printing all config variables on command line parameter", capture_io: true do
+    begin
       flags "--print-config-variables", "-p"
+      expect(Capistrano::Configuration.fetch(:print_config_variables)).to be true
+    ensure
+      Capistrano::Configuration.reset!
     end
-    expect(Capistrano::Configuration.fetch(:print_config_variables)).to be true
   end
 
   def flags(*sets)
@@ -63,22 +57,4 @@ describe Capistrano::Application do
     subject.run
     subject.options
   end
-
-  def capture_io
-    require "stringio"
-
-    orig_stdout = $stdout
-    orig_stderr = $stderr
-    captured_stdout = StringIO.new
-    captured_stderr = StringIO.new
-    $stdout = captured_stdout
-    $stderr = captured_stderr
-
-    yield
-
-    return captured_stdout.string, captured_stderr.string
-  ensure
-    $stdout = orig_stdout
-    $stderr = orig_stderr
-  end
 end

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

@@ -5,7 +5,7 @@ module Capistrano
     describe Filter do
       let(:available) do
         [
-          Server.new("server1").add_roles([:web, :db]),
+          Server.new("server1").add_roles(%i(web db)),
           Server.new("server2").add_role(:web),
           Server.new("server3").add_role(:redis),
           Server.new("server4").add_role(:db),

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

@@ -10,7 +10,7 @@ module Capistrano
          Server.new("server2"),
          Server.new("server3"),
          Server.new("server4"),
-         Server.new("server5")]
+         Server.new("server10")]
       end
 
       shared_examples "it filters hosts correctly" do |expected|
@@ -32,8 +32,8 @@ module Capistrano
         end
 
         context "with a comma separated string" do
-          let(:values) { "server1,server3" }
-          it_behaves_like "it filters hosts correctly", %w{server1 server3}
+          let(:values) { "server1,server10" }
+          it_behaves_like "it filters hosts correctly", %w{server1 server10}
         end
 
         context "with an array of strings" do
@@ -41,6 +41,11 @@ module Capistrano
           it_behaves_like "it filters hosts correctly", %w{server1 server3}
         end
 
+        context "with mixed splittable and unsplittable strings" do
+          let(:values) { %w{server1 server2,server3} }
+          it_behaves_like "it filters hosts correctly", %w{server1 server2 server3}
+        end
+
         context "with a regexp" do
           let(:values) { "server[13]$" }
           it_behaves_like "it filters hosts correctly", %w{server1 server3}
@@ -48,12 +53,12 @@ module Capistrano
 
         context "with a regexp with line boundaries" do
           let(:values) { "^server" }
-          it_behaves_like "it filters hosts correctly", %w{server1 server2 server3 server4 server5}
+          it_behaves_like "it filters hosts correctly", %w{server1 server2 server3 server4 server10}
         end
 
         context "with a regexp with a comma" do
           let(:values) { 'server\d{1,3}$' }
-          it_behaves_like "it filters hosts correctly", %w{server1 server2 server3 server4 server5}
+          it_behaves_like "it filters hosts correctly", %w{server1 server2 server3 server4 server10}
         end
 
         context "without number" do

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

@@ -49,7 +49,7 @@ module Capistrano
           expect(task.prerequisites).to eq([:example_prerequisite])
         end
 
-        it "sets defaults when load:defaults is invoked" do
+        it "sets defaults when load:defaults is invoked", capture_io: true do
           expect(fetch(:example_variable)).to be_nil
           invoke "load:defaults"
           expect(fetch(:example_variable)).to eq("foo")

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

@@ -3,11 +3,14 @@ require "spec_helper"
 module Capistrano
   class Configuration
     describe Question do
-      let(:question) { Question.new(key, default, options) }
-      let(:question_without_echo) { Question.new(key, default, echo: false) }
+      let(:question) { Question.new(key, default, stdin: stdin) }
+      let(:question_without_echo) { Question.new(key, default, echo: false, stdin: stdin) }
+      let(:question_without_default) { Question.new(key, nil, stdin: stdin) }
+      let(:question_prompt) { Question.new(key, default, stdin: stdin, prompt: "Your favorite branch") }
+      let(:question_prompt_without_default) { Question.new(key, nil, stdin: stdin, prompt: "Your favorite branch") }
       let(:default) { :default }
       let(:key) { :branch }
-      let(:options) { nil }
+      let(:stdin) { stub(tty?: true) }
 
       describe ".new" do
         it "takes a key, default, options" do
@@ -19,23 +22,45 @@ module Capistrano
         context "value is entered" do
           let(:branch) { "branch" }
 
-          before do
-            $stdout.expects(:print).with("Please enter branch (default): ")
-          end
-
           it "returns the echoed value" do
-            $stdin.expects(:gets).returns(branch)
-            $stdin.expects(:noecho).never
+            $stdout.expects(:print).with("Please enter branch (default): ")
+            stdin.expects(:gets).returns(branch)
+            stdin.expects(:noecho).never
 
             expect(question.call).to eq(branch)
           end
 
           it "returns the value but does not echo it" do
-            $stdin.expects(:noecho).returns(branch)
+            $stdout.expects(:print).with("Please enter branch (default): ")
+            stdin.expects(:noecho).returns(branch)
             $stdout.expects(:print).with("\n")
 
             expect(question_without_echo.call).to eq(branch)
           end
+
+          it "returns the value but has no default between parenthesis" do
+            $stdout.expects(:print).with("Please enter branch: ")
+            stdin.expects(:gets).returns(branch)
+            stdin.expects(:noecho).never
+
+            expect(question_without_default.call).to eq(branch)
+          end
+
+          it "uses prompt and returns the value" do
+            $stdout.expects(:print).with("Your favorite branch (default): ")
+            stdin.expects(:gets).returns(branch)
+            stdin.expects(:noecho).never
+
+            expect(question_prompt.call).to eq(branch)
+          end
+
+          it "uses prompt and returns the value but has no default between parenthesis" do
+            $stdout.expects(:print).with("Your favorite branch: ")
+            stdin.expects(:gets).returns(branch)
+            stdin.expects(:noecho).never
+
+            expect(question_prompt_without_default.call).to eq(branch)
+          end
         end
 
         context "value is not entered" do
@@ -43,13 +68,24 @@ module Capistrano
 
           before do
             $stdout.expects(:print).with("Please enter branch (default): ")
-            $stdin.expects(:gets).returns("")
+            stdin.expects(:gets).returns("")
           end
 
           it "returns the default as the value" do
             expect(question.call).to eq(branch)
           end
         end
+
+        context "tty unavailable", capture_io: true do
+          before do
+            stdin.expects(:gets).never
+            stdin.expects(:tty?).returns(false)
+          end
+
+          it "returns the default as the value" do
+            expect(question.call).to eq(default)
+          end
+        end
       end
     end
   end

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

@@ -7,7 +7,7 @@ module Capistrano
 
       let(:available) do
         [
-          Server.new("server1").add_roles([:web, :db]),
+          Server.new("server1").add_roles(%i(web db)),
           Server.new("server2").add_role(:web),
           Server.new("server3").add_role(:redis),
           Server.new("server4").add_role(:db),
@@ -41,7 +41,7 @@ module Capistrano
         end
 
         context "with multiple roles" do
-          let(:values) { [:web, :db] }
+          let(:values) { %i(web db) }
           it_behaves_like "it filters roles correctly", 3, %w{server1 server2 server4}
         end
 

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

@@ -0,0 +1,55 @@
+require "spec_helper"
+require "capistrano/scm"
+
+module Capistrano
+  class Configuration
+    describe SCMResolver do
+      include Capistrano::DSL
+
+      let(:resolver) { SCMResolver.new }
+
+      before do
+        Rake::Task.define_task("deploy:check")
+        Rake::Task.define_task("deploy:new_release_path")
+        Rake::Task.define_task("deploy:set_current_revision")
+        set :scm, SCMResolver::DEFAULT_GIT
+      end
+
+      after do
+        Rake::Task.clear
+        Capistrano::Configuration.reset!
+      end
+
+      context "default scm, no plugin installed" do
+        it "emits a warning" do
+          expect { resolver.resolve }.to output(/will not load the git scm/i).to_stderr
+        end
+
+        it "activates the git scm", capture_io: true do
+          resolver.resolve
+          expect(Rake::Task["git:wrapper"]).not_to be_nil
+        end
+
+        it "sets :scm to :git", capture_io: true do
+          resolver.resolve
+          expect(fetch(:scm)).to eq(:git)
+        end
+      end
+
+      context "default scm, git plugin installed" do
+        before do
+          install_plugin Capistrano::SCM::Git
+        end
+
+        it "emits no warning" do
+          expect { resolver.resolve }.not_to output.to_stderr
+        end
+
+        it "deletes :scm" do
+          resolver.resolve
+          expect(fetch(:scm)).to be_nil
+        end
+      end
+    end
+  end
+end

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

@@ -13,7 +13,7 @@ module Capistrano
       end
 
       describe "adding roles" do
-        subject { server.add_roles([:things, :stuff]) }
+        subject { server.add_roles(%i(things stuff)) }
         it "adds the roles" do
           expect { subject }.to change { server.roles.size }.from(0).to(2)
         end

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

@@ -56,7 +56,7 @@ module Capistrano
 
       describe "collecting server roles" do
         let(:app) { Set.new([:app]) }
-        let(:web_app) { Set.new([:web, :app]) }
+        let(:web_app) { Set.new(%i(web app)) }
         let(:web) { Set.new([:web]) }
 
         before do
@@ -108,7 +108,7 @@ module Capistrano
         end
 
         it "returns the correct app and web servers" do
-          expect(servers.roles_for([:app, :web]).map(&:hostname)).to eq %w{1 2 3}
+          expect(servers.roles_for(%i(app web)).map(&:hostname)).to eq %w{1 2 3}
         end
 
         it "returns all servers" do
@@ -130,13 +130,14 @@ module Capistrano
 
         it "can accept multiple servers with the same hostname but different ports or users" do
           servers.add_host("1", roles: [:app, "web"], test: :value, port: 12)
+          expect(servers.count).to eq(2)
           servers.add_host("1", roles: [:app, "web"], test: :value, port: 34)
           servers.add_host("1", roles: [:app, "web"], test: :value, user: "root")
           servers.add_host("1", roles: [:app, "web"], test: :value, user: "deployer")
           servers.add_host("1", roles: [:app, "web"], test: :value, user: "root", port: 34)
           servers.add_host("1", roles: [:app, "web"], test: :value, user: "deployer", port: 34)
           servers.add_host("1", roles: [:app, "web"], test: :value, user: "deployer", port: 56)
-          expect(servers.count).to eq(5)
+          expect(servers.count).to eq(4)
         end
 
         describe "with a :user property" do
@@ -283,7 +284,7 @@ module Capistrano
           end
 
           context "when selecting specific roles" do
-            let(:roles) { [:app, :web] }
+            let(:roles) { %i(app web) }
             it "ignores it" do
               expect(subject).to eq %w{1 2 3 4}
             end
@@ -311,7 +312,7 @@ module Capistrano
           end
 
           context "when selecting specific roles" do
-            let(:roles) { [:app, :web] }
+            let(:roles) { %i(app web) }
             it "ignores it" do
               expect(subject).to eq %w{1 2 3 4}
             end

data/spec/lib/capistrano/configuration_spec.rb

@@ -238,7 +238,7 @@ module Capistrano
       end
 
       it "returns all set keys" do
-        expect(subject).to match_array [:key1, :key2]
+        expect(subject).to match_array %i(key1 key2)
       end
     end
 
@@ -255,7 +255,7 @@ module Capistrano
 
     describe "asking" do
       let(:question) { stub }
-      let(:options) { Hash.new }
+      let(:options) { {} }
 
       before do
         Configuration::Question.expects(:new).with(:branch, :default, options)

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

@@ -29,7 +29,7 @@ module Capistrano
           Rake::Task.clear
         end
 
-        it "has an doctor:environment task that calls EnvironmentDoctor" do
+        it "has an doctor:environment task that calls EnvironmentDoctor", capture_io: true do
           EnvironmentDoctor.any_instance.expects(:call)
           Rake::Task["doctor:environment"].invoke
         end

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

@@ -53,7 +53,7 @@ module Capistrano
           Rake::Task.clear
         end
 
-        it "has an doctor:gems task that calls GemsDoctor" do
+        it "has an doctor:gems task that calls GemsDoctor", capture_io: true do
           GemsDoctor.any_instance.expects(:call)
           Rake::Task["doctor:gems"].invoke
         end

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

@@ -71,7 +71,7 @@ module Capistrano
           Rake::Task.clear
         end
 
-        it "has an doctor:servers task that calls ServersDoctor" do
+        it "has an doctor:servers task that calls ServersDoctor", capture_io: true do
           ServersDoctor.any_instance.expects(:call)
           Rake::Task["doctor:servers"].invoke
         end

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

@@ -14,6 +14,7 @@ module Capistrano
 
         env.variables.untrusted! do
           set :application, "my_app"
+          set :repo_tree, "public"
           set :repo_url, ".git"
           set :copy_strategy, :scp
           set :custom_setting, "hello"
@@ -35,6 +36,7 @@ module Capistrano
         expect { doc.call }.to output(/:pty\s+false$/).to_stdout
         expect { doc.call }.to output(/:application\s+"my_app"$/).to_stdout
         expect { doc.call }.to output(/:repo_url\s+".git"$/).to_stdout
+        expect { doc.call }.to output(/:repo_tree\s+"public"$/).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
@@ -56,6 +58,12 @@ module Capistrano
           .to_stdout
       end
 
+      it "does not print warning for whitelisted variable" do
+        expect { doc.call }.not_to \
+          output(/:repo_tree is not a recognized Capistrano setting/)\
+          .to_stdout
+      end
+
       describe "Rake" do
         before do
           load File.expand_path("../../../../../lib/capistrano/doctor.rb",
@@ -66,7 +74,7 @@ module Capistrano
           Rake::Task.clear
         end
 
-        it "has an doctor:variables task that calls VariablesDoctor" do
+        it "has an doctor:variables task that calls VariablesDoctor", capture_io: true do
           VariablesDoctor.any_instance.expects(:call)
           Rake::Task["doctor:variables"].invoke
         end

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

@@ -123,6 +123,36 @@ describe Capistrano::DSL::Paths do
     end
   end
 
+  describe "#releases_path" do
+    subject { paths.releases_path }
+
+    context "with custom releases directory" do
+      before do
+        paths.expects(:fetch).with(:releases_directory, "releases").returns("test123")
+        paths.expects(:fetch).with(:deploy_to).returns("/var/www")
+      end
+
+      it "returns the releases path with the custom directory" do
+        expect(subject.to_s).to eq "/var/www/test123"
+      end
+    end
+  end
+
+  describe "#shared_path" do
+    subject { paths.shared_path }
+
+    context "with custom shared directory" do
+      before do
+        paths.expects(:fetch).with(:shared_directory, "shared").returns("test123")
+        paths.expects(:fetch).with(:deploy_to).returns("/var/www")
+      end
+
+      it "returns the shared path with the custom directory" do
+        expect(subject.to_s).to eq "/var/www/test123"
+      end
+    end
+  end
+
   describe "#deploy_config_path" do
     subject { dsl.deploy_config_path.to_s }
 

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

@@ -35,7 +35,7 @@ module Capistrano
         end
       end
 
-      it "invokes in proper order if define after than before" do
+      it "invokes in proper order if define after than before", capture_io: true do
         task_enhancements.after("task", "after_task")
         task_enhancements.before("task", "before_task")
 
@@ -44,7 +44,7 @@ module Capistrano
         expect(order).to eq(%w(before_task task after_task))
       end
 
-      it "invokes in proper order if define before than after" do
+      it "invokes in proper order if define before than after", capture_io: true do
         task_enhancements.before("task", "before_task")
         task_enhancements.after("task", "after_task")
 
@@ -53,7 +53,7 @@ module Capistrano
         expect(order).to eq(%w(before_task task after_task))
       end
 
-      it "invokes in proper order when referring to as-yet undefined tasks" do
+      it "invokes in proper order when referring to as-yet undefined tasks", capture_io: true do
         task_enhancements.after("task", "not_loaded_task")
 
         Rake::Task.define_task("not_loaded_task") do
@@ -65,7 +65,7 @@ module Capistrano
         expect(order).to eq(%w(task not_loaded_task))
       end
 
-      it "invokes in proper order and with arguments and block" do
+      it "invokes in proper order and with arguments and block", capture_io: true do
         task_enhancements.after("task", "after_task_custom", :order) do |_t, _args|
           order.push "after_task"
         end
@@ -79,7 +79,7 @@ module Capistrano
         expect(order).to eq(%w(before_task task after_task))
       end
 
-      it "invokes using the correct namespace when defined within a namespace" do
+      it "invokes using the correct namespace when defined within a namespace", capture_io: true do
         Rake.application.in_namespace("namespace") do
           Rake::Task.define_task("task") do |t|
             order.push(t.name)
@@ -99,7 +99,7 @@ module Capistrano
         )
       end
 
-      it "raises a sensible error if the task isn't found" do
+      it "raises a sensible error if the task isn't found", capture_io: true do
         task_enhancements.after("task", "non_existent_task")
         expect { Rake::Task["task"].invoke order }.to raise_error(ArgumentError, 'Task "non_existent_task" not found')
       end

data/spec/lib/capistrano/dsl_spec.rb

@@ -60,7 +60,7 @@ module Capistrano
           end
         end
 
-        it "prints helpful message to stderr" do
+        it "prints helpful message to stderr", capture_io: true do
           expect do
             expect do
               task.invoke
@@ -71,13 +71,54 @@ module Capistrano
     end
 
     describe "#invoke" do
-      it "will print a message on stderr, when reinvoking task" do
-        Rake::Task.define_task("some_task")
+      context "reinvoking" do
+        it "will not reenable invoking task", capture_io: true do
+          counter = 0
 
-        dsl.invoke("some_task")
-        expect do
-          dsl.invoke("some_task")
-        end.to output(/.*Capistrano tasks may only be invoked once.*/).to_stderr
+          Rake::Task.define_task("A") do
+            counter += 1
+          end
+
+          expect do
+            dsl.invoke("A")
+            dsl.invoke("A")
+          end.to change { counter }.by(1)
+        end
+
+        it "will print a message on stderr", capture_io: true do
+          Rake::Task.define_task("B")
+
+          expect do
+            dsl.invoke("B")
+            dsl.invoke("B")
+          end.to output(/If you really meant to run this task again, use invoke!/).to_stderr
+        end
+      end
+    end
+
+    describe "#invoke!" do
+      context "reinvoking" do
+        it "will reenable invoking task", capture_io: true do
+          counter = 0
+
+          Rake::Task.define_task("C") do
+            counter += 1
+          end
+
+          expect do
+            dsl.invoke!("C")
+            dsl.invoke!("C")
+          end.to change { counter }.by(2)
+        end
+
+        it "will not print a message on stderr", capture_io: true do
+          Rake::Task.define_task("D")
+
+          expect do
+            dsl.invoke!("D")
+            dsl.invoke!("D")
+          end.to_not output(/If you really meant to run this task again, use invoke!/).to_stderr
+        end
       end
     end
   end

data/spec/lib/capistrano/immutable_task_spec.rb

@@ -16,7 +16,7 @@ module Capistrano
       load_defaults.extend(Capistrano::ImmutableTask)
 
       $stderr.expects(:puts).with do |message|
-        message =~ /^WARNING: load:defaults has already been invoked/
+        message =~ /^ERROR: load:defaults has already been invoked/
       end
 
       expect do