capistrano 3.3.5 → 3.16.0

data/RELEASING.md

@@ -0,0 +1,17 @@
+# Releasing
+
+## Prerequisites
+
+* You must have commit rights to the Capistrano repository.
+* You must have push rights for the capistrano gem on rubygems.org.
+
+## How to release
+
+1. Run `bundle install` to make sure that you have all the gems necessary for testing and releasing.
+2.  **Ensure all tests are passing by running `rake spec` and `rake features`.**
+3. Determine which would be the correct next version number according to [semver](http://semver.org/).
+4. Update the version in `./lib/capistrano/version.rb`.
+5. Update the version in the `./README.md` Gemfile example (`gem "capistrano", "~> X.Y"`).
+6. Commit the `version.rb` and `README.md` changes in a single commit, the message should be "Release vX.Y.Z"
+7. Run `rake release`; this will tag, push to GitHub, and publish to rubygems.org.
+8. Update the draft release on the [GitHub releases page](https://github.com/capistrano/capistrano/releases) to point to the new tag and publish the release

data/Rakefile

@@ -1,9 +1,17 @@
 require "bundler/gem_tasks"
 require "cucumber/rake/task"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
-task :default => :spec
+task default: %i(spec rubocop)
 RSpec::Core::RakeTask.new
 
 Cucumber::Rake::Task.new(:features)
 
+desc "Run RuboCop checks"
+RuboCop::RakeTask.new
+
+Rake::Task["release"].enhance do
+  puts "Don't forget to publish the release on GitHub!"
+  system "open https://github.com/capistrano/capistrano/releases"
+end

data/UPGRADING-3.7.md

@@ -0,0 +1,86 @@
+# Capistrano 3.7.0 upgrade guide
+
+## The :scm variable is deprecated
+
+Up until now, Capistrano's SCM was configured using the `:scm` variable:
+
+```ruby
+# This is now deprecated
+set :scm, :svn
+```
+
+To avoid deprecation warnings:
+
+1. Remove `set :scm, ...` from your Capistrano configuration.
+2. Add *one* of the following SCM declarations to your `Capfile` after `require "capistrano/deploy"`:
+
+```ruby
+# To use Git
+require "capistrano/scm/git"
+install_plugin Capistrano::SCM::Git
+
+# To use Mercurial
+require "capistrano/scm/hg"
+install_plugin Capistrano::SCM::Hg
+
+# To use Subversion
+require "capistrano/scm/svn"
+install_plugin Capistrano::SCM::Svn
+```
+
+## This is the last release where Git is the automatic default
+
+If you do not specify an SCM, Capistrano assumes Git. However this behavior is
+now deprecated. Add this to your Capfile to avoid deprecation warnings:
+
+```ruby
+require "capistrano/scm/git"
+install_plugin Capistrano::SCM::Git
+```
+
+## :git_strategy, :hg_strategy, and :svn_strategy are removed
+
+Capistrano 3.7.0 has a rewritten SCM system that relies on "plugins". This
+system is more flexible than the old "strategy" system that only allowed certain
+parts of SCM tasks to be customized.
+
+If your deployment relies on a custom SCM strategy, you will need to rewrite
+that strategy to be a full-fledged SCM plugin instead. There is a fairly
+straightforward migration path: write your plugin to be a subclass of the
+built-in SCM that you want to customize. For example:
+
+```ruby
+require "capistrano/scm/git"
+
+class MyCustomGit < Capistrano::SCM::Git
+  # Override the methods you wish to customize, e.g.:
+  def clone_repo
+    # ...
+  end
+end
+```
+
+Then use your plugin in by loading it in the Capfile:
+
+```ruby
+require_relative "path/to/my_custom_git.rb"
+install_plugin MyCustomGit
+```
+
+## Existing third-party SCMs are deprecated
+
+If you are using a third-party SCM, you can continue using it without
+changes, but you will see deprecation warnings. Contact the maintainer of the
+third-party SCM gem and ask them about modifying the gem to work with the new
+Capistrano 3.7.0 SCM plugin system.
+
+## remote_file is removed
+
+The `remote_file` method is no longer in Capistrano 3.7.0. You can read the
+discussion that led to its removal here:
+[issue 762](https://github.com/capistrano/capistrano/issues/762).
+
+There is no direct replacement. To migrate to 3.7.0, you will need to rewrite
+any parts of your deployment that use `remote_file` to use a different
+mechanism for uploading files. Consider using the `upload!` method directly in
+a procedural fashion instead.

data/bin/cap

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
-require 'capistrano/all'
+require "capistrano/all"
 Capistrano::Application.new.run

data/capistrano.gemspec

@@ -1,38 +1,38 @@
 # -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'capistrano/version'
+require "capistrano/version"
 
 Gem::Specification.new do |gem|
   gem.name          = "capistrano"
   gem.version       = Capistrano::VERSION
   gem.authors       = ["Tom Clements", "Lee Hambley"]
   gem.email         = ["seenmyfate@gmail.com", "lee.hambley@gmail.com"]
-  gem.description   = %q{Capistrano is a utility and framework for executing commands in parallel on multiple remote machines, via SSH.}
-  gem.summary       = %q{Capistrano - Welcome to easy deployment with Ruby over SSH}
-  gem.homepage      = "http://capistranorb.com/"
-
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = ['cap', 'capify']
+  gem.description   = "Capistrano is a utility and framework for executing commands in parallel on multiple remote machines, via SSH."
+  gem.summary       = "Capistrano - Welcome to easy deployment with Ruby over SSH"
+  gem.homepage      = "https://capistranorb.com/"
+  gem.metadata      = {
+    "bug_tracker_uri" => "https://github.com/capistrano/capistrano/issues",
+    "changelog_uri" => "https://github.com/capistrano/capistrano/releases",
+    "source_code_uri" => "https://github.com/capistrano/capistrano",
+    "homepage_uri" => "https://capistranorb.com/",
+    "documentation_uri" => "https://capistranorb.com/"
+  }
+  gem.files         = `git ls-files -z`.split("\x0").reject { |f| f =~ /^docs/ }
+  gem.executables   = %w(cap capify)
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.licenses      = ['MIT']
-
-  gem.post_install_message = <<eos
-Capistrano 3.1 has some breaking changes. Please check the CHANGELOG: http://goo.gl/SxB0lr
-
-If you're upgrading Capistrano from 2.x, we recommend to read the upgrade guide: http://goo.gl/4536kB
-
-The `deploy:restart` hook for passenger applications is now in a separate gem called capistrano-passenger.  Just add it to your Gemfile and require it in your Capfile.
-eos
+  gem.licenses      = ["MIT"]
 
-  gem.required_ruby_version = '>= 1.9.3'
-  gem.add_dependency 'sshkit', '~> 1.3'
-  gem.add_dependency 'capistrano-stats', '~> 1.1.0'
-  gem.add_dependency 'rake', '>= 10.0.0'
-  gem.add_dependency 'i18n'
+  gem.required_ruby_version = ">= 2.0"
+  gem.add_dependency "airbrussh", ">= 1.0.0"
+  gem.add_dependency "i18n"
+  gem.add_dependency "rake", ">= 10.0.0"
+  gem.add_dependency "sshkit", ">= 1.9.0"
 
-  gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency "mocha"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rubocop", "0.48.1"
 end

data/features/deploy.feature

@@ -7,7 +7,7 @@ Feature: Deploy
   Scenario: Creating the repo
     When I run cap "git:check"
     Then the task is successful
-    And references in the remote repo are listed
+    And git wrapper permissions are 0700
 
   Scenario: Creating the directory structure
     When I run cap "deploy:check:directories"
@@ -52,3 +52,37 @@ Feature: Deploy
     When I run cap "deploy:symlink:release"
     Then the current directory will be a symlink to the release
 
+  Scenario: Cleanup
+    Given config stage file has line "set :keep_releases, 3"
+    And 5 valid existing releases
+    And an invalid release named "new"
+    When I run cap "deploy:cleanup"
+    Then 3 valid releases are kept
+    And the invalid "new" release is ignored
+
+  Scenario: Cleanup after many failed releases doesn't remove last good release
+    Given config stage file has line "set :keep_releases, 2"
+    And I make 2 deployments
+    And an invalid release named "77777777777777"
+    And an invalid release named "88888888888888"
+    And an invalid release named "99999999999999"
+    When I run cap "deploy:cleanup"
+    Then 3 valid releases are kept
+    And the current directory will be a symlink to the release
+
+  Scenario: Cleanup when there are more releases than arguments can handle
+    Given config stage file has line "set :keep_releases, 3"
+    And 5000 valid existing releases
+    When I run cap "deploy:cleanup"
+    Then 3 valid releases are kept
+
+  Scenario: Rolling Back
+    Given I make 2 deployments
+    When I run cap "deploy:rollback"
+    Then the current symlink points to the previous release
+
+  Scenario: Rolling Back to a specific release
+    Given I make 3 deployments
+    When I rollback to a specific release
+    Then the current symlink points to that specific release
+

data/features/doctor.feature

@@ -0,0 +1,11 @@
+Feature: Doctor
+
+  Background:
+    Given a test app with the default configuration
+
+  Scenario: Running the doctor task
+    When I run cap "doctor"
+    Then the task is successful
+    And contains "Environment" in the output
+    And contains "Gems" in the output
+    And contains "Variables" in the output

data/features/installation.feature

@@ -1,16 +1,21 @@
 Feature: Installation
 
   Background:
-    Given a test app with the default configuration
+    Given a test app without any configuration
+
+  Scenario: The "install" task documentation can be viewed
+    When I run "cap -T"
+    Then the task is successful
+    And contains "cap install" in the output
 
   Scenario: With default stages
-    When I run cap "install"
+    When I run "cap install"
     Then the deploy.rb file is created
     And the default stage files are created
     And the tasks folder is created
 
   Scenario: With specified stages
-    When I run cap "install STAGES=qa,production"
+    When I run "cap install STAGES=qa,production"
     Then the deploy.rb file is created
     And the specified stage files are created
     And the tasks folder is created

data/features/sshconnect.feature

@@ -0,0 +1,11 @@
+Feature: SSH Connection
+
+  Background:
+    Given a test app with the default configuration
+    And servers with the roles app and web
+    And a task which executes as root
+
+  Scenario: Switching from default user to root and back again
+    When I run cap "am_i_root"
+    Then the task is successful
+    And the output matches "I am uid=0\(root\)" followed by "I am uid=\d+\(vagrant\)"

data/features/stage_failure.feature

@@ -0,0 +1,9 @@
+Feature: Stage failure
+
+  Background:
+    Given a test app with the default configuration
+    And a stage file named deploy.rb
+
+  Scenario: Running a task
+    When I run cap "doctor"
+    Then the task fails

data/features/step_definitions/assertions.rb

@@ -1,5 +1,14 @@
+require "shellwords"
+
 Then(/^references in the remote repo are listed$/) do
-  expect(@output).to include('refs/heads/master')
+  expect(@output).to include("refs/heads/master")
+end
+
+Then(/^git wrapper permissions are 0700$/) do
+  permissions_test = %Q([ $(stat -c "%a" #{TestApp.git_wrapper_path_glob}) == "700" ])
+  _stdout, _stderr, status = vagrant_cli_command("ssh -c #{permissions_test.shellescape}")
+
+  expect(status).to be_success
 end
 
 Then(/^the shared path is created$/) do
@@ -10,6 +19,18 @@ Then(/^the releases path is created$/) do
   run_vagrant_command(test_dir_exists(TestApp.releases_path))
 end
 
+Then(/^(\d+) valid releases are kept/) do |num|
+  test = %Q([ $(ls -g #{TestApp.releases_path} | grep -E '[0-9]{14}' | wc -l) == "#{num}" ])
+  _, _, status = vagrant_cli_command("ssh -c #{test.shellescape}")
+  expect(status).to be_success
+end
+
+Then(/^the invalid (.+) release is ignored$/) do |filename|
+  test = "ls -g #{TestApp.releases_path} | grep #{filename}"
+  _, _, status = vagrant_cli_command("ssh -c #{test.shellescape}")
+  expect(status).to be_success
+end
+
 Then(/^directories in :linked_dirs are created in shared$/) do
   TestApp.linked_dirs.each do |dir|
     run_vagrant_command(test_dir_exists(TestApp.shared_path.join(dir)))
@@ -18,7 +39,7 @@ end
 
 Then(/^directories referenced in :linked_files are created in shared$/) do
   dirs = TestApp.linked_files.map { |path| TestApp.shared_path.join(path).dirname }
-  dirs.each do | dir|
+  dirs.each do |dir|
     run_vagrant_command(test_dir_exists(dir))
   end
 end
@@ -45,31 +66,31 @@ Then(/^directory symlinks are created in the new release$/) do
 end
 
 Then(/^the current directory will be a symlink to the release$/) do
-  run_vagrant_command(test_symlink_exists(TestApp.current_path))
+  run_vagrant_command(exists?("e", TestApp.current_path))
 end
 
 Then(/^the deploy\.rb file is created$/) do
-  file = TestApp.test_app_path.join('config/deploy.rb')
-  expect(File.exists?(file)).to be true
+  file = TestApp.test_app_path.join("config/deploy.rb")
+  expect(File.exist?(file)).to be true
 end
 
 Then(/^the default stage files are created$/) do
-  staging = TestApp.test_app_path.join('config/deploy/staging.rb')
-  production = TestApp.test_app_path.join('config/deploy/production.rb')
-  expect(File.exists?(staging)).to be true
-  expect(File.exists?(production)).to be true
+  staging = TestApp.test_app_path.join("config/deploy/staging.rb")
+  production = TestApp.test_app_path.join("config/deploy/production.rb")
+  expect(File.exist?(staging)).to be true
+  expect(File.exist?(production)).to be true
 end
 
 Then(/^the tasks folder is created$/) do
-  path = TestApp.test_app_path.join('lib/capistrano/tasks')
-  expect(Dir.exists?(path)).to be true
+  path = TestApp.test_app_path.join("lib/capistrano/tasks")
+  expect(Dir.exist?(path)).to be true
 end
 
 Then(/^the specified stage files are created$/) do
-  qa = TestApp.test_app_path.join('config/deploy/qa.rb')
-  production = TestApp.test_app_path.join('config/deploy/production.rb')
-  expect(File.exists?(qa)).to be true
-  expect(File.exists?(production)).to be true
+  qa = TestApp.test_app_path.join("config/deploy/qa.rb")
+  production = TestApp.test_app_path.join("config/deploy/production.rb")
+  expect(File.exist?(qa)).to be true
+  expect(File.exist?(production)).to be true
 end
 
 Then(/^it creates the file with the remote_task prerequisite$/) do
@@ -91,25 +112,41 @@ Then(/^the task fails$/) do
 end
 
 Then(/^the failure task will run$/) do
-  failed = TestApp.shared_path.join('failed')
+  failed = TestApp.shared_path.join("failed")
   run_vagrant_command(test_file_exists(failed))
 end
 
 Then(/^the failure task will not run$/) do
-  failed = TestApp.shared_path.join('failed')
+  failed = TestApp.shared_path.join("failed")
   expect { run_vagrant_command(test_file_exists(failed)) }
     .to raise_error(VagrantHelpers::VagrantSSHCommandError)
 end
 
 When(/^an error is raised$/) do
-  error = TestApp.shared_path.join('fail')
+  error = TestApp.shared_path.join("fail")
   run_vagrant_command(test_file_exists(error))
 end
 
-Then(/contains "(.*?)" in the output/) do |expected|
+Then(/contains "([^"]*)" in the output/) do |expected|
   expect(@output).to include(expected)
 end
 
-Then(/doesn't contain "(.*?)" in the output/) do |expected|
+Then(/the output matches "([^"]*)" followed by "([^"]*)"/) do |expected, followedby|
+  expect(@output).to match(/#{expected}.*#{followedby}/m)
+end
+
+Then(/doesn't contain "([^"]*)" in the output/) do |expected|
   expect(@output).not_to include(expected)
 end
+
+Then(/the current symlink points to the previous release/) do
+  previous_release_path = @release_paths[-2]
+
+  run_vagrant_command(symlinked?(TestApp.current_path, previous_release_path))
+end
+
+Then(/^the current symlink points to that specific release$/) do
+  specific_release_path = TestApp.releases_path.join(@rollback_release)
+
+  run_vagrant_command(symlinked?(TestApp.current_path, specific_release_path))
+end

data/features/step_definitions/cap_commands.rb

@@ -2,6 +2,10 @@ When(/^I run cap "(.*?)"$/) do |task|
   @success, @output = TestApp.cap(task)
 end
 
+When(/^I run cap "(.*?)" within the "(.*?)" directory$/) do |task, directory|
+  @success, @output = TestApp.cap(task, directory)
+end
+
 When(/^I run cap "(.*?)" as part of a release$/) do |task|
   TestApp.cap("deploy:new_release_path #{task}")
 end
@@ -10,3 +14,8 @@ When(/^I run "(.*?)"$/) do |command|
   @success, @output = TestApp.run(command)
 end
 
+When(/^I rollback to a specific release$/) do
+  @rollback_release = @release_paths.first.split("/").last
+
+  step %Q{I run cap "deploy:rollback ROLLBACK_RELEASE=#{@rollback_release}"}
+end