capistrano 3.4.0 → 3.17.1

data/spec/lib/capistrano/version_validator_spec.rb

@@ -1,19 +1,18 @@
-require 'spec_helper'
+require "spec_helper"
 
 module Capistrano
-
   describe VersionValidator do
     let(:validator) { VersionValidator.new(version) }
     let(:version) { stub }
 
-    describe '#new' do
-      it 'takes a version' do
+    describe "#new" do
+      it "takes a version" do
         expect(validator)
       end
     end
 
-    describe '#verify' do
-      let(:current_version) { '3.0.1' }
+    describe "#verify" do
+      let(:current_version) { "3.0.1" }
 
       subject { validator.verify }
 
@@ -21,83 +20,99 @@ module Capistrano
         validator.stubs(:current_version).returns(current_version)
       end
 
-      context 'with exact version' do
-        context 'valid' do
-          let(:version) { '3.0.1' }
+      context "with exact version" do
+        context "valid" do
+          let(:version) { "3.0.1" }
           it { expect(subject).to be_truthy }
         end
 
-        context 'invalid - lower' do
-          let(:version) { '3.0.0' }
+        context "invalid - lower" do
+          let(:version) { "3.0.0" }
 
-          it 'fails' do
-            expect { subject }.to raise_error
+          it "fails" do
+            expect { subject }.to raise_error(RuntimeError)
           end
         end
 
-        context 'invalid - higher' do
-          let(:version) { '3.0.2' }
+        context "invalid - higher" do
+          let(:version) { "3.0.2" }
 
-          it 'fails' do
-            expect { subject }.to raise_error
+          it "fails" do
+            expect { subject }.to raise_error(RuntimeError)
           end
         end
-
       end
 
-      context 'with optimistic versioning' do
-        context 'valid' do
-          let(:version) { '>= 3.0.0' }
+      context "with optimistic versioning" do
+        context "valid" do
+          let(:version) { ">= 3.0.0" }
           it { expect(subject).to be_truthy }
         end
 
-        context 'invalid - lower' do
-          let(:version) { '<= 2.0.0' }
+        context "invalid - lower" do
+          let(:version) { "<= 2.0.0" }
 
-          it 'fails' do
-            expect { subject }.to raise_error
+          it "fails" do
+            expect { subject }.to raise_error(RuntimeError)
           end
         end
       end
 
-
-
-      context 'with pessimistic versioning' do
-        context '2 decimal places' do
-          context 'valid' do
-            let(:version) { '~> 3.0.0' }
+      context "with pessimistic versioning" do
+        context "2 decimal places" do
+          context "valid" do
+            let(:version) { "~> 3.0.0" }
             it { expect(subject).to be_truthy }
           end
 
-          context 'invalid' do
-            let(:version) { '~> 3.1.0' }
+          context "invalid" do
+            let(:version) { "~> 3.1.0" }
 
-            it 'fails' do
-              expect { subject }.to raise_error
+            it "fails" do
+              expect { subject }.to raise_error(RuntimeError)
             end
           end
         end
 
-        context '1 decimal place' do
-          let(:current_version) { '3.5.0' }
+        context "1 decimal place" do
+          let(:current_version) { "3.5.0" }
 
-          context 'valid' do
-            let(:version) { '~> 3.1' }
+          context "valid" do
+            let(:version) { "~> 3.1" }
             it { expect(subject).to be_truthy }
           end
 
-          context 'invalid' do
-            let(:version) { '~> 3.6' }
-            it 'fails' do
-              expect { subject }.to raise_error
+          context "invalid" do
+            let(:version) { "~> 3.6" }
+            it "fails" do
+              expect { subject }.to raise_error(RuntimeError)
             end
           end
         end
 
-      end
+        context "with multiple versions" do
+          let(:current_version) { "3.5.9" }
 
-    end
+          context "valid" do
+            let(:version) { [">= 3.5.0", "< 3.5.10"] }
+            it { is_expected.to be_truthy }
+          end
 
-  end
+          context "invalid" do
+            let(:version) { [">= 3.5.0", "< 3.5.8"] }
+            it "fails" do
+              expect { subject }.to raise_error(RuntimeError)
+            end
+          end
 
+          context "invalid" do
+            let(:version) { ["> 3.5.9", "< 3.5.13"] }
+            it "fails" do
+              expect { subject }.to raise_error(RuntimeError)
+            end
+          end
+        end
+      end
+    end
+  end
 end

data/spec/lib/capistrano_spec.rb

@@ -1,8 +1,7 @@
-require 'spec_helper'
+require "spec_helper"
 
 module Capistrano
-
   describe Application do
-    let(:app) { Application.new  }
+    let(:app) { Application.new }
   end
 end

data/spec/spec_helper.rb

@@ -1,16 +1,29 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'capistrano/all'
-require 'rspec'
-require 'mocha/api'
-require 'time'
+require "capistrano/all"
+require "rspec"
+require "mocha/api"
+require "time"
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
-Dir['#{File.dirname(__FILE__)}/support/**/*.rb'].each {|f| require f}
+Dir['#{File.dirname(__FILE__)}/support/**/*.rb'].each { |f| require f }
 
 RSpec.configure do |config|
-	config.raise_errors_for_deprecations!
+  config.raise_errors_for_deprecations!
   config.mock_framework = :mocha
-  config.order = 'random'
+  config.order = "random"
+
+  config.around(:example, capture_io: true) do |example|
+    begin
+      Rake.application.options.trace_output = StringIO.new
+      $stdout = StringIO.new
+      $stderr = StringIO.new
+      example.run
+    ensure
+      Rake.application.options.trace_output = STDERR
+      $stdout = STDOUT
+      $stderr = STDERR
+    end
+  end
 end

data/spec/support/Vagrantfile

@@ -1,20 +1,19 @@
-require 'open-uri'
+require "open-uri"
 
 Vagrant.configure("2") do |config|
-
   config.ssh.insert_key = false
 
   [:app].each_with_index do |role, i|
-    config.vm.define(role, primary: true) do |config|
-      config.vm.define role
-      config.vm.box = 'hashicorp/precise64'
-      config.vm.network "forwarded_port", guest: 22, host: "222#{i}".to_i
-      config.vm.provision :shell, inline: 'sudo apt-get -y install git-core'
+    config.vm.define(role, primary: true) do |primary|
+      primary.vm.define role
+      primary.vm.box = "hashicorp/bionic64"
+      primary.vm.network "forwarded_port", guest: 22, host: "222#{i}".to_i
+      primary.vm.provision :shell, inline: "sudo apt-get -y install git-core"
 
-      vagrantkey = open("https://raw.githubusercontent.com/mitchellh/vagrant/master/keys/vagrant.pub", "r",&:read)
+      vagrantkey = open("https://raw.githubusercontent.com/mitchellh/vagrant/master/keys/vagrant.pub", "r", &:read)
 
-      config.vm.provision :shell,
-        inline: <<-INLINE
+      primary.vm.provision :shell,
+                           inline: <<-INLINE
           install -d -m 700 /root/.ssh
           echo -e "#{vagrantkey}" > /root/.ssh/authorized_keys
           chmod 0600 /root/.ssh/authorized_keys

data/spec/support/tasks/database.rake

@@ -1,11 +1,11 @@
 namespace :deploy do
   namespace :check do
-    task :linked_files => 'config/database.yml'
+    task linked_files: "config/database.yml"
   end
 end
 
-remote_file 'config/database.yml' => '/tmp/database.yml', roles: :all
+remote_file "config/database.yml" => "/tmp/database.yml", :roles => :all
 
-file '/tmp/database.yml' do |t|
+file "/tmp/database.yml" do |t|
   sh "touch #{t.name}"
 end

data/spec/support/tasks/fail.rake

@@ -1,7 +1,8 @@
-set :fail, proc { fail }
-before 'deploy:starting', :fail do
+set :fail, proc { raise }
+before "deploy:starting", :fail do
   on roles :all do
-    execute :touch, shared_path.join('fail')
+    execute :mkdir, "-p", shared_path
+    execute :touch, shared_path.join("fail")
   end
   fetch(:fail)
 end

data/spec/support/tasks/failed.rake

@@ -1,5 +1,5 @@
-after 'deploy:failed', :failed do
+after "deploy:failed", :custom_failed do
   on roles :all do
-    execute :touch, shared_path.join('failed')
+    execute :touch, shared_path.join("failed")
   end
 end

data/spec/support/tasks/plugin.rake

@@ -0,0 +1,6 @@
+# This rake file is used by plugin_spec.rb.
+
+task :plugin_test do
+  # Example of invoking a helper method provided by the plugin
+  hello
+end

data/spec/support/tasks/root.rake

@@ -1,11 +1,11 @@
 task :am_i_root do
   on roles(:all) do |host|
-    host.user = 'root'
-    ident = capture :id, '-a'
+    host.user = "root"
+    ident = capture :id, "-a"
     info "I am #{ident}"
   end
-  on roles(:all) do |host|
-    ident = capture :id, '-a'
+  on roles(:all) do |_host|
+    ident = capture :id, "-a"
     info "I am #{ident}"
   end
 end

data/spec/support/test_app.rb

@@ -1,5 +1,6 @@
-require 'fileutils'
-require 'pathname'
+require "English"
+require "fileutils"
+require "pathname"
 
 module TestApp
   extend self
@@ -9,15 +10,17 @@ module TestApp
   end
 
   def default_config
-    %{
+    <<-CONFIG
       set :deploy_to, '#{deploy_to}'
-      set :repo_url, 'git://github.com/capistrano/capistrano.git'
+      set :repo_url, 'https://github.com/capistrano/capistrano.git'
       set :branch, 'master'
       set :ssh_options, { keys: "\#{ENV['HOME']}/.vagrant.d/insecure_private_key", auth_methods: ['publickey'] }
       server 'vagrant@localhost:2220', roles: %w{web app}
       set :linked_files, #{linked_files}
       set :linked_dirs, #{linked_dirs}
-    }
+      set :format_options, log_file: nil
+      set :local_user, #{current_user.inspect}
+    CONFIG
   end
 
   def linked_files
@@ -29,45 +32,52 @@ module TestApp
   end
 
   def linked_dirs
-    %w{bin log public/system vendor/bundle}
+    %w{bin log public/system}
   end
 
   def create_test_app
     FileUtils.rm_rf(test_app_path)
     FileUtils.mkdir(test_app_path)
 
-    File.open(gemfile, 'w+') do |file|
+    File.open(gemfile, "w+") do |file|
+      file.write "source 'https://rubygems.org'\n"
       file.write "gem 'capistrano', path: '#{path_to_cap}'"
     end
 
     Dir.chdir(test_app_path) do
-      %x[bundle]
+      run "bundle"
     end
   end
 
   def install_test_app_with(config)
     create_test_app
     Dir.chdir(test_app_path) do
-      %x[bundle exec cap install STAGES=#{stage}]
+      run "cap install STAGES=#{stage}"
     end
     write_local_deploy_file(config)
   end
 
   def write_local_deploy_file(config)
-    File.open(test_stage_path, 'w') do |file|
+    File.open(test_stage_path, "w") do |file|
       file.write config
     end
   end
 
+  def write_local_stage_file(filename, config=nil)
+    File.open(test_app_path.join("config/deploy/#{filename}"), "w") do |file|
+      file.write(config) if config
+    end
+  end
+
   def append_to_deploy_file(config)
-    File.open(test_stage_path, 'a') do |file|
+    File.open(test_stage_path, "a") do |file|
       file.write config + "\n"
     end
   end
 
   def prepend_to_capfile(config)
     current_capfile = File.read(capfile)
-    File.open(capfile, 'w') do |file|
+    File.open(capfile, "w") do |file|
       file.write config
       file.write current_capfile
     end
@@ -78,79 +88,81 @@ module TestApp
   end
 
   def create_shared_file(path)
-    File.open(shared_path.join(path), 'w')
+    File.open(shared_path.join(path), "w")
   end
 
-  def cap(task)
-    run "bundle exec cap #{stage} #{task}"
+  def cap(task, subdirectory=nil)
+    run "cap #{stage} #{task} --trace", subdirectory
   end
 
-  def run(command)
+  def run(command, subdirectory=nil)
     output = nil
-    Dir.chdir(test_app_path) do
-      output = %x[#{command}]
+    command = "bundle exec #{command}" unless command =~ /^bundle\b/
+    dir = subdirectory ? test_app_path.join(subdirectory) : test_app_path
+    Dir.chdir(dir) do
+      output = with_clean_bundler_env { `#{command}` }
     end
-    [$?.success?, output]
+    [$CHILD_STATUS.success?, output]
   end
 
   def stage
-    'test'
+    "test"
   end
 
   def test_stage_path
-    test_app_path.join('config/deploy/test.rb')
+    test_app_path.join("config/deploy/test.rb")
   end
 
   def test_app_path
-    Pathname.new('/tmp/test_app')
+    Pathname.new("/tmp/test_app")
   end
 
   def deploy_to
-    Pathname.new('/home/vagrant/var/www/deploy')
+    Pathname.new("/home/vagrant/var/www/deploy")
   end
 
   def shared_path
-    deploy_to.join('shared')
+    deploy_to.join("shared")
   end
 
   def current_path
-    deploy_to.join('current')
+    deploy_to.join("current")
   end
 
   def releases_path
-    deploy_to.join('releases')
+    deploy_to.join("releases")
   end
 
-  def release_path
-    releases_path.join(timestamp)
+  def release_path(t=timestamp)
+    releases_path.join(t)
   end
 
-  def timestamp
-    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  def timestamp(offset=0)
+    (Time.now.utc + offset).strftime("%Y%m%d%H%M%S")
   end
 
   def repo_path
-    deploy_to.join('repo')
+    deploy_to.join("repo")
   end
 
   def path_to_cap
-    File.expand_path('.')
+    File.expand_path(".")
   end
 
   def gemfile
-    test_app_path.join('Gemfile')
+    test_app_path.join("Gemfile")
   end
 
   def capfile
-    test_app_path.join('Capfile')
+    test_app_path.join("Capfile")
   end
 
   def current_user
-    `whoami`.chomp
+    "(GitHub Web Flow) via ShipIt"
   end
 
   def task_dir
-    test_app_path.join('lib/capistrano/tasks')
+    test_app_path.join("lib/capistrano/tasks")
   end
 
   def copy_task_to_test_app(source)
@@ -158,15 +170,15 @@ module TestApp
   end
 
   def config_path
-    test_app_path.join('config')
+    test_app_path.join("config")
   end
 
   def move_configuration_to_custom_location(location)
     prepend_to_capfile(
-      %{
+      <<-CONFIG
         set :stage_config_path, "app/config/deploy"
         set :deploy_config_path, "app/config/deploy.rb"
-      }
+      CONFIG
     )
 
     location = test_app_path.join(location)
@@ -174,4 +186,17 @@ module TestApp
     FileUtils.mv(config_path, location)
   end
 
+  def git_wrapper_path_glob
+    "/tmp/git-ssh-*.sh"
+  end
+
+  def with_clean_bundler_env(&block)
+    return yield unless defined?(Bundler)
+
+    if Bundler.respond_to?(:with_unbundled_env)
+      Bundler.with_unbundled_env(&block)
+    else
+      Bundler.with_clean_env(&block)
+    end
+  end
 end