capistrano 3.4.1 → 3.5.0

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

@@ -0,0 +1,47 @@
+require "spec_helper"
+require "capistrano/doctor/output_helpers"
+
+module Capistrano
+  module Doctor
+    describe OutputHelpers do
+      include OutputHelpers
+
+      # Force color for the purpose of these tests
+      before { ENV.stubs(:[]).with("SSHKIT_COLOR").returns("1") }
+
+      it "prints titles in blue with newlines and without indentation" do
+        expect { title("Hello!") }.to\
+          output("\e[0;34;49m\nHello!\n\e[0m\n").to_stdout
+      end
+
+      it "prints warnings in yellow with 4-space indentation" do
+        expect { warning("Yikes!") }.to\
+          output("    \e[0;33;49mYikes!\e[0m\n").to_stdout
+      end
+
+      it "overrides puts to indent 4 spaces per line" do
+        expect { puts("one\ntwo") }.to output("    one\n    two\n").to_stdout
+      end
+
+      it "formats tables with indent, aligned columns and per-row color" do
+        data = [
+          ["one", ".", "1"],
+          ["two", "..", "2"],
+          ["three", "...", "3"]
+        ]
+        block = proc do |record, row|
+          row.yellow if record.first == "two"
+          row << record[0]
+          row << record[1]
+          row << record[2]
+        end
+        expected_output = <<-OUT
+    one   .   1
+    \e[0;33;49mtwo   ..  2\e[0m
+    three ... 3
+        OUT
+        expect { table(data, &block) }.to output(expected_output).to_stdout
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+require "spec_helper"
+require "capistrano/doctor/variables_doctor"
+
+module Capistrano
+  module Doctor
+    describe VariablesDoctor do
+      include Capistrano::DSL
+
+      let(:doc) { VariablesDoctor.new }
+
+      before do
+        set :branch, "master"
+        set :pty, false
+
+        env.variables.untrusted! do
+          set :application, "my_app"
+          set :repo_url, ".git"
+          set :copy_strategy, :scp
+          set :custom_setting, "hello"
+          ask :secret
+        end
+
+        fetch :custom_setting
+      end
+
+      after { Capistrano::Configuration.reset! }
+
+      it "prints using 4-space indentation" do
+        expect { doc.call }.to output(/^ {4}/).to_stdout
+      end
+
+      it "prints variable names and values" do
+        expect { doc.call }.to output(/:branch\s+"master"$/).to_stdout
+        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(/:copy_strategy\s+:scp$/).to_stdout
+        expect { doc.call }.to output(/:custom_setting\s+"hello"$/).to_stdout
+      end
+
+      it "prints unanswered question variable as <ask>" do
+        expect { doc.call }.to output(/:secret\s+<ask>$/).to_stdout
+      end
+
+      it "prints warning for unrecognized variable" do
+        expect { doc.call }.to \
+          output(/:copy_strategy is not a recognized Capistrano setting/)\
+          .to_stdout
+      end
+
+      it "does not print warning for unrecognized variable that is fetched" do
+        expect { doc.call }.not_to \
+          output(/:custom_setting is not a recognized Capistrano setting/)\
+          .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:variables task that calls VariablesDoctor" do
+          VariablesDoctor.any_instance.expects(:call)
+          Rake::Task["doctor:variables"].invoke
+        end
+
+        it "has a doctor task that depends on doctor:variables" do
+          expect(Rake::Task["doctor"].prerequisites).to \
+            include("doctor:variables")
+        end
+      end
+    end
+  end
+end

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

@@ -1,16 +1,15 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Capistrano::DSL::Paths do
-
   let(:dsl) { Class.new.extend Capistrano::DSL }
-  let(:parent) { Pathname.new('/var/shared') }
+  let(:parent) { Pathname.new("/var/shared") }
   let(:paths) { Class.new.extend Capistrano::DSL::Paths }
 
   let(:linked_dirs) { %w{log public/system} }
-  let(:linked_files) { %w{config/database.yml log/my.log} }
+  let(:linked_files) { %w{config/database.yml log/my.log log/access.log} }
 
   before do
-    dsl.set(:deploy_to, '/var/www')
+    dsl.set(:deploy_to, "/var/www")
   end
 
   describe '#linked_dirs' do
@@ -20,12 +19,14 @@ describe Capistrano::DSL::Paths do
       paths.expects(:fetch).with(:linked_dirs).returns(linked_dirs)
     end
 
-    it 'returns the full pathnames' do
-      expect(subject).to eq [Pathname.new('/var/shared/log'), Pathname.new('/var/shared/public/system')]
+    it "returns the full pathnames" do
+      expect(subject).to eq [
+        Pathname.new("/var/shared/log"),
+        Pathname.new("/var/shared/public/system")
+      ]
     end
   end
 
-
   describe '#linked_files' do
     subject { paths.linked_files(parent) }
 
@@ -33,8 +34,12 @@ describe Capistrano::DSL::Paths do
       paths.expects(:fetch).with(:linked_files).returns(linked_files)
     end
 
-    it 'returns the full pathnames' do
-      expect(subject).to eq [Pathname.new('/var/shared/config/database.yml'), Pathname.new('/var/shared/log/my.log')]
+    it "returns the full pathnames" do
+      expect(subject).to eq [
+        Pathname.new("/var/shared/config/database.yml"),
+        Pathname.new("/var/shared/log/my.log"),
+        Pathname.new("/var/shared/log/access.log")
+      ]
     end
   end
 
@@ -45,8 +50,11 @@ describe Capistrano::DSL::Paths do
       paths.expects(:fetch).with(:linked_files).returns(linked_files)
     end
 
-    it 'returns the full paths names of the parent dirs' do
-      expect(subject).to eq [Pathname.new('/var/shared/config'), Pathname.new('/var/shared/log')]
+    it "returns the full paths names of the parent dirs" do
+      expect(subject).to eq [
+        Pathname.new("/var/shared/config"),
+        Pathname.new("/var/shared/log")
+      ]
     end
   end
 
@@ -57,32 +65,34 @@ describe Capistrano::DSL::Paths do
       paths.expects(:fetch).with(:linked_dirs).returns(linked_dirs)
     end
 
-    it 'returns the full paths names of the parent dirs' do
-      expect(subject).to eq [Pathname.new('/var/shared'), Pathname.new('/var/shared/public')]
+    it "returns the full paths names of the parent dirs" do
+      expect(subject).to eq [
+        Pathname.new("/var/shared"),
+        Pathname.new("/var/shared/public")
+      ]
     end
   end
 
   describe '#release path' do
-
     subject { dsl.release_path }
 
-    context 'where no release path has been set' do
+    context "where no release path has been set" do
       before do
         dsl.delete(:release_path)
       end
 
-      it 'returns the `current_path` value' do
-        expect(subject.to_s).to eq '/var/www/current'
+      it "returns the `current_path` value" do
+        expect(subject.to_s).to eq "/var/www/current"
       end
     end
 
-    context 'where the release path has been set' do
+    context "where the release path has been set" do
       before do
-        dsl.set(:release_path,'/var/www/release_path')
+        dsl.set(:release_path, "/var/www/release_path")
       end
 
-      it 'returns the set `release_path` value' do
-        expect(subject.to_s).to eq '/var/www/release_path'
+      it "returns the set `release_path` value" do
+        expect(subject.to_s).to eq "/var/www/release_path"
       end
     end
   end
@@ -91,24 +101,24 @@ describe Capistrano::DSL::Paths do
     let(:now) { Time.parse("Oct 21 16:29:00 2015") }
     subject { dsl.release_path }
 
-    context 'without a timestamp' do
+    context "without a timestamp" do
       before do
         dsl.env.expects(:timestamp).returns(now)
         dsl.set_release_path
       end
 
-      it 'returns the release path with the current env timestamp' do
-        expect(subject.to_s).to eq '/var/www/releases/20151021162900'
+      it "returns the release path with the current env timestamp" do
+        expect(subject.to_s).to eq "/var/www/releases/20151021162900"
       end
     end
 
-    context 'with a timestamp' do
+    context "with a timestamp" do
       before do
-        dsl.set_release_path('timestamp')
+        dsl.set_release_path("timestamp")
       end
 
-      it 'returns the release path with the timestamp' do
-        expect(subject.to_s).to eq '/var/www/releases/timestamp'
+      it "returns the release path with the timestamp" do
+        expect(subject.to_s).to eq "/var/www/releases/timestamp"
       end
     end
   end
@@ -116,23 +126,23 @@ describe Capistrano::DSL::Paths do
   describe '#deploy_config_path' do
     subject { dsl.deploy_config_path.to_s }
 
-    context 'when not specified' do
+    context "when not specified" do
       before do
         dsl.delete(:deploy_config_path)
       end
 
       it 'returns "config/deploy.rb"' do
-        expect(subject).to eq 'config/deploy.rb'
+        expect(subject).to eq "config/deploy.rb"
       end
     end
 
-    context 'when the variable :deploy_config_path is set' do
+    context "when the variable :deploy_config_path is set" do
       before do
-        dsl.set(:deploy_config_path, 'my/custom/path.rb')
+        dsl.set(:deploy_config_path, "my/custom/path.rb")
       end
 
-      it 'returns the custom path' do
-        expect(subject).to eq 'my/custom/path.rb'
+      it "returns the custom path" do
+        expect(subject).to eq "my/custom/path.rb"
       end
     end
   end
@@ -140,24 +150,23 @@ describe Capistrano::DSL::Paths do
   describe '#stage_config_path' do
     subject { dsl.stage_config_path.to_s }
 
-    context 'when not specified' do
-
+    context "when not specified" do
       before do
         dsl.delete(:stage_config_path)
       end
 
       it 'returns "config/deploy"' do
-        expect(subject).to eq 'config/deploy'
+        expect(subject).to eq "config/deploy"
       end
     end
 
-    context 'when the variable :stage_config_path is set' do
+    context "when the variable :stage_config_path is set" do
       before do
-        dsl.set(:stage_config_path, 'my/custom/path')
+        dsl.set(:stage_config_path, "my/custom/path")
       end
 
-      it 'returns the custom path' do
-        expect(subject).to eq 'my/custom/path'
+      it "returns the custom path" do
+        expect(subject).to eq "my/custom/path"
       end
     end
   end
@@ -165,25 +174,24 @@ describe Capistrano::DSL::Paths do
   describe '#repo_path' do
     subject { dsl.repo_path.to_s }
 
-    context 'when not specified' do
-
+    context "when not specified" do
       before do
         dsl.delete(:repo_path)
       end
 
       it 'returns the default #{deploy_to}/repo' do
-        dsl.set(:deploy_to, '/var/www')
-        expect(subject).to eq '/var/www/repo'
+        dsl.set(:deploy_to, "/var/www")
+        expect(subject).to eq "/var/www/repo"
       end
     end
 
-    context 'when the variable :repo_path is set' do
+    context "when the variable :repo_path is set" do
       before do
-        dsl.set(:repo_path, 'my/custom/path')
+        dsl.set(:repo_path, "my/custom/path")
       end
 
-      it 'returns the custom path' do
-        expect(subject).to eq 'my/custom/path'
+      it "returns the custom path" do
+        expect(subject).to eq "my/custom/path"
       end
     end
   end

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

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require "spec_helper"
 
 module Capistrano
   class DummyTaskEnhancements
@@ -8,8 +8,7 @@ module Capistrano
   describe TaskEnhancements do
     let(:task_enhancements) { DummyTaskEnhancements.new }
 
-    describe 'ordering' do
-
+    describe "ordering" do
       after do
         task.clear
         before_task.clear
@@ -19,68 +18,99 @@ module Capistrano
 
       let(:order) { [] }
       let!(:task) do
-        Rake::Task.define_task('task', [:order]) do |t, args|
-          args['order'].push 'task'
+        Rake::Task.define_task("task", [:order]) do |_t, args|
+          args["order"].push "task"
         end
       end
 
       let!(:before_task) do
-        Rake::Task.define_task('before_task') do
-          order.push 'before_task'
+        Rake::Task.define_task("before_task") do
+          order.push "before_task"
         end
       end
 
       let!(:after_task) do
-        Rake::Task.define_task('after_task') do
-          order.push 'after_task'
+        Rake::Task.define_task("after_task") do
+          order.push "after_task"
         end
       end
 
-      it 'invokes in proper order if define after than before' do
-        task_enhancements.after('task', 'after_task')
-        task_enhancements.before('task', 'before_task')
+      it "invokes in proper order if define after than before" do
+        task_enhancements.after("task", "after_task")
+        task_enhancements.before("task", "before_task")
 
-        Rake::Task['task'].invoke order
+        Rake::Task["task"].invoke order
 
-        expect(order).to eq(['before_task', 'task', 'after_task'])
+        expect(order).to eq(%w(before_task task after_task))
       end
 
-      it 'invokes in proper order if define before than after' do
-        task_enhancements.before('task', 'before_task')
-        task_enhancements.after('task', 'after_task')
+      it "invokes in proper order if define before than after" do
+        task_enhancements.before("task", "before_task")
+        task_enhancements.after("task", "after_task")
 
-        Rake::Task['task'].invoke order
+        Rake::Task["task"].invoke order
 
-        expect(order).to eq(['before_task', 'task', 'after_task'])
+        expect(order).to eq(%w(before_task task after_task))
       end
 
-      it 'invokes in proper order and with arguments and block' do
-        task_enhancements.after('task', 'after_task_custom', :order) do |t, args|
-          order.push 'after_task'
+      it "invokes in proper order when referring to as-yet undefined tasks" do
+        task_enhancements.after("task", "not_loaded_task")
+
+        Rake::Task.define_task("not_loaded_task") do
+          order.push "not_loaded_task"
         end
 
-        task_enhancements.before('task', 'before_task_custom', :order) do |t, args|
-          order.push 'before_task'
+        Rake::Task["task"].invoke order
+
+        expect(order).to eq(%w(task not_loaded_task))
+      end
+
+      it "invokes in proper order and with arguments and block" do
+        task_enhancements.after("task", "after_task_custom", :order) do |_t, _args|
+          order.push "after_task"
         end
 
-        Rake::Task['task'].invoke(order)
+        task_enhancements.before("task", "before_task_custom", :order) do |_t, _args|
+          order.push "before_task"
+        end
 
-        expect(order).to eq(['before_task', 'task', 'after_task'])
+        Rake::Task["task"].invoke(order)
+
+        expect(order).to eq(%w(before_task task after_task))
       end
 
+      it "invokes using the correct namespace when defined within a namespace" do
+        Rake.application.in_namespace("namespace") do
+          Rake::Task.define_task("task") do |t|
+            order.push(t.name)
+          end
+          task_enhancements.before("task", "before_task", :order) do |t|
+            order.push(t.name)
+          end
+          task_enhancements.after("task", "after_task", :order) do |t|
+            order.push(t.name)
+          end
+        end
+
+        Rake::Task["namespace:task"].invoke
+
+        expect(order).to eq(
+          ["namespace:before_task", "namespace:task", "namespace:after_task"]
+        )
+      end
     end
 
-    describe 'remote_file' do
-      subject(:remote_file) { task_enhancements.remote_file('source' => 'destination') }
+    describe "remote_file" do
+      subject(:remote_file) { task_enhancements.remote_file("source" => "destination") }
 
-      it { expect(remote_file.name).to eq('source') }
+      it { expect(remote_file.name).to eq("source") }
       it { is_expected.to be_a(Capistrano::UploadTask) }
 
-      describe 'namespaced' do
+      describe "namespaced" do
         let(:app) { Rake.application }
-        around { |ex| app.in_namespace('namespace', &ex) }
+        around { |ex| app.in_namespace("namespace", &ex) }
 
-        it { expect(remote_file.name).to eq('source') }
+        it { expect(remote_file.name).to eq("source") }
         it { is_expected.to be_a(Capistrano::UploadTask) }
       end
     end