capistrano 3.8.2 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f88f4b773f72433e56b0f290b92e2565952295e
-  data.tar.gz: ac9af7055287f89ff36d9a16dd735166a02cdf80
+  metadata.gz: a4ae57e87cafad9fe7cb1307d847f5f3bd9d7ccb
+  data.tar.gz: e6ea828e10e6863b07c9fcd685a334464a3a3890
 SHA512:
-  metadata.gz: c4f12ab9a1d3c746d969c8c8ea738b9a63978b4e93d0654a9ca0e70d5956eeb7e93061cc258947d15ccb7790bab9554925814c1c3d93f182c7bead906d16791f
-  data.tar.gz: 147305f082e0043d2ca4185f23088f90693d9ce31aab3816301e1f2060bc8006c1841f6f09176b6e43af0fdd1aacbd83912840b710862677a1270fb2d014a2ef
+  metadata.gz: 49fd63f868fdc87cefd58e047dc22c2b05cd95211a7a99080a010f627c3f32944539a16876ade7496257d4a8b71e18fc099a57ec126abf3f2efa7d2991d36c41
+  data.tar.gz: 35064cfd5c3da3a39e8ca044aa1eae03b8b0fbbea3c22a08fb08d5c2755b1fe18f7be8f2e7bccc431214d166f0d953e5c112d026b818a462105761528f3478cc

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
+  - 2.4.1
   - 2.3.1
   - 2.2
   - 2.1

data/CHANGELOG.md

@@ -16,10 +16,26 @@ gem "capistrano", :github => "capistrano/capistrano"
 
 ## master
 
-https://github.com/capistrano/capistrano/compare/v3.8.1...HEAD
+https://github.com/capistrano/capistrano/compare/v3.9.0...HEAD
 
 * Your contribution here!
 
+## `3.9.0` (2017-07-28)
+
+https://github.com/capistrano/capistrano/compare/v3.8.2...v3.9.0
+
+### Breaking changes:
+
+* None
+
+### New features:
+
+* [#1911](https://github.com/capistrano/capistrano/pull/1911): Add Capistrano::DSL#invoke! for repetetive tasks
+
+### Fixes:
+
+* [#1899](https://github.com/capistrano/capistrano/pull/1899): Updated `deploy:cleanup` to continue rotating the releases and skip the invalid directory names instead of skipping the whole rotation of releases. The warning message has changed slightly due to the change of behavior.
+
 ## `3.8.2` (2017-06-16)
 
 https://github.com/capistrano/capistrano/compare/v3.8.1...v3.8.2

data/CONTRIBUTING.md

@@ -41,6 +41,8 @@ Also include in your report:
 
 If you are an experienced Ruby programmer, take a few minutes to get the Capistrano test suite running (see [DEVELOPMENT.md][]), and do what you can to get a test case written that fails. *This will be a huge help!*
 
+If you think you may have discovered a security vulnerability in Capistrano, do not open a GitHub issue. Instead, please send a report to <security@capistranorb.com>.
+
 ## Requesting new features or improvements
 
 Capistrano continues to improve thanks to people like you! Feel free to open a GitHub issue for any or all of these ideas:

data/DEVELOPMENT.md

@@ -28,11 +28,10 @@ Capistrano is a Ruby project, so we expect you to have a functioning Ruby enviro
 
 Make sure to install:
 
-* [Bundler](https://bundler.io/) 1.10.5 (see note)
+* [Bundler](https://bundler.io/)
 * [Vagrant](https://www.vagrantup.com/)
 * [VirtualBox](https://www.virtualbox.org/wiki/Downloads) (or another [Vagrant-supported](https://docs.vagrantup.com/v2/getting-started/providers.html) VM host)
 
-*Note: As of this writing (December 2015), Vagrant does not work with Bundler > 1.10.5. If you have multiple versions of Bundler installed, use the special underscore command-line argument to force a compatible version, like this: `bundle _1.10.5_ exec rake features`.*
 
 ### Running tests
 
@@ -45,7 +44,7 @@ $ bundle install
 # Run the RSpec suite
 $ bundle exec rake spec
 
-# Run the Cucumber suite (requires Bundler 1.10.5)
+# Run the Cucumber suite
 $ bundle exec rake features
 
 # Run the Cucumber suite and leave the VM running (faster for subsequent runs)

data/README.md

@@ -103,7 +103,7 @@ Add Capistrano to your project's Gemfile:
 
 ``` ruby
 group :development do
-  gem "capistrano", "~> 3.8"
+  gem "capistrano", "~> 3.9"
 end
 ```
 
@@ -186,6 +186,8 @@ Related GitHub repositories:
 
 GitHub issues are for bug reports and feature requests. Please refer to the [CONTRIBUTING](CONTRIBUTING.md) document for guidelines on submitting GitHub issues.
 
+If you think you may have discovered a security vulnerability in Capistrano, do not open a GitHub issue. Instead, please send a report to <security@capistranorb.com>.
+
 ## How to contribute
 
 Contributions to Capistrano, in the form of code, documentation or idea, are gladly accepted. Read the [DEVELOPMENT](DEVELOPMENT.md) document to learn how to hack on Capistrano's code, run the tests, and contribute your first pull request.

data/features/deploy.feature

@@ -52,3 +52,21 @@ 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: 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/step_definitions/assertions.rb

@@ -6,7 +6,9 @@ end
 
 Then(/^git wrapper permissions are 0700$/) do
   permissions_test = %Q([ $(stat -c "%a" #{TestApp.git_wrapper_path.shellescape}) == "700" ])
-  expect(vagrant_cli_command("ssh -c #{permissions_test.shellescape}")).to be_success
+  _stdout, _stderr, status = vagrant_cli_command("ssh -c #{permissions_test.shellescape}")
+
+  expect(status).to be_success
 end
 
 Then(/^the shared path is created$/) do
@@ -17,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)))
@@ -124,3 +138,15 @@ 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

@@ -13,3 +13,9 @@ end
 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

data/features/step_definitions/setup.rb

@@ -21,10 +21,16 @@ end
 
 Given(/^file "(.*?)" exists in shared path$/) do |file|
   file_shared_path = TestApp.shared_path.join(file)
-  run_vagrant_command("mkdir -p #{TestApp.shared_path}")
+  run_vagrant_command("mkdir -p #{file_shared_path.dirname}")
   run_vagrant_command("touch #{file_shared_path}")
 end
 
+Given(/^all linked files exists in shared path$/) do
+  TestApp.linked_files.each do |linked_file|
+    step %Q{file "#{linked_file}" exists in shared path}
+  end
+end
+
 Given(/^file "(.*?)" does not exist in shared path$/) do |file|
   file_shared_path = TestApp.shared_path.join(file)
   run_vagrant_command("mkdir -p #{TestApp.shared_path}")
@@ -60,3 +66,27 @@ end
 Given(/^a stage file named (.+)$/) do |filename|
   TestApp.write_local_stage_file(filename)
 end
+
+Given(/^I make (\d+) deployments$/) do |count|
+  step "all linked files exists in shared path"
+
+  @release_paths = (1..count.to_i).map do
+    TestApp.cap("deploy")
+    stdout, _stderr = run_vagrant_command("readlink #{TestApp.current_path}")
+
+    stdout.strip
+  end
+end
+
+Given(/^(\d+) valid existing releases$/) do |num|
+  a_day = 86_400 # in seconds
+  offset = -(a_day * num.to_i)
+  num.to_i.times do
+    run_vagrant_command("mkdir -p #{TestApp.release_path(TestApp.timestamp(offset))}")
+    offset += a_day
+  end
+end
+
+Given(/^an invalid release named "(.+)"$/) do |filename|
+  run_vagrant_command("mkdir -p #{TestApp.release_path(filename)}")
+end

data/features/support/remote_command_helpers.rb

@@ -15,6 +15,10 @@ module RemoteCommandHelpers
     %Q{[ -#{type} "#{path}" ]}
   end
 
+  def symlinked?(symlink_path, target_path)
+    "[ #{symlink_path} -ef #{target_path} ]"
+  end
+
   def safely_remove_file(_path)
     run_vagrant_command("rm #{test_file}")
   rescue

data/features/support/vagrant_helpers.rb

@@ -1,4 +1,4 @@
-require "English"
+require "open3"
 
 module VagrantHelpers
   extend self
@@ -16,17 +16,18 @@ module VagrantHelpers
 
   def vagrant_cli_command(command)
     puts "[vagrant] #{command}"
-    Dir.chdir(VAGRANT_ROOT) do
-      `#{VAGRANT_BIN} #{command} 2>&1`.split("\n").each do |line|
-        puts "[vagrant] #{line}"
-      end
+    stdout, stderr, status = Dir.chdir(VAGRANT_ROOT) do
+      Open3.capture3("#{VAGRANT_BIN} #{command}")
     end
-    $CHILD_STATUS
+
+    (stdout + stderr).each_line { |line| puts "[vagrant] #{line}" }
+
+    [stdout, stderr, status]
   end
 
   def run_vagrant_command(command)
-    status = vagrant_cli_command("ssh -c #{command.inspect}")
-    return true if status.success?
+    stdout, stderr, status = vagrant_cli_command("ssh -c #{command.inspect}")
+    return [stdout, stderr] if status.success?
     raise VagrantSSHCommandError, status
   end
 end

data/lib/capistrano/dsl.rb

@@ -19,13 +19,19 @@ module Capistrano
         colors = SSHKit::Color.new($stderr)
         $stderr.puts colors.colorize("Skipping task `#{task_name}'.", :yellow)
         $stderr.puts "Capistrano tasks may only be invoked once. Since task `#{task}' was previously invoked, invoke(\"#{task_name}\") at #{file}:#{line} will be skipped."
-        $stderr.puts "If you really meant to run this task again, first call Rake::Task[\"#{task_name}\"].reenable"
+        $stderr.puts "If you really meant to run this task again, use invoke!(\"#{task_name}\")"
         $stderr.puts colors.colorize("THIS BEHAVIOR MAY CHANGE IN A FUTURE VERSION OF CAPISTRANO. Please join the conversation here if this affects you.", :red)
         $stderr.puts colors.colorize("https://github.com/capistrano/capistrano/issues/1686", :red)
       end
       task.invoke(*args)
     end
 
+    def invoke!(task_name, *args)
+      task = Rake::Task[task_name]
+      task.reenable
+      task.invoke(*args)
+    end
+
     def t(key, options={})
       I18n.t(key, options.merge(scope: :capistrano))
     end

data/lib/capistrano/i18n.rb

@@ -13,7 +13,7 @@ en = {
   question: "Please enter %{key}: ",
   question_default: "Please enter %{key} (%{default_value}): ",
   keeping_releases: "Keeping %{keep_releases} of %{releases} deployed releases on %{host}",
-  skip_cleanup: "Skipping cleanup of old releases on %{host}; unexpected foldername found (should be timestamp)",
+  skip_cleanup: "Skipping cleanup of invalid releases on %{host}; unexpected foldername found (should be timestamp)",
   no_old_releases: "No old releases (keeping newest %{keep_releases}) on %{host}",
   linked_file_does_not_exist: "linked file %{file} does not exist on %{host}",
   cannot_rollback: "There are no older releases to rollback to",

data/lib/capistrano/tasks/deploy.rake

@@ -149,11 +149,13 @@ namespace :deploy do
   task :cleanup do
     on release_roles :all do |host|
       releases = capture(:ls, "-x", releases_path).split
-      if !(releases.all? { |e| /^\d{14}$/ =~ e })
-        warn t(:skip_cleanup, host: host.to_s)
-      elsif releases.count >= fetch(:keep_releases)
-        info t(:keeping_releases, host: host.to_s, keep_releases: fetch(:keep_releases), releases: releases.count)
-        directories = (releases - releases.last(fetch(:keep_releases)))
+      valid, invalid = releases.partition { |e| /^\d{14}$/ =~ e }
+
+      warn t(:skip_cleanup, host: host.to_s) if invalid.any?
+
+      if valid.count >= fetch(:keep_releases)
+        info t(:keeping_releases, host: host.to_s, keep_releases: fetch(:keep_releases), releases: valid.count)
+        directories = (valid - valid.last(fetch(:keep_releases)))
         if directories.any?
           directories_str = directories.map do |release|
             releases_path.join(release)

data/lib/capistrano/version.rb

@@ -1,3 +1,3 @@
 module Capistrano
-  VERSION = "3.8.2".freeze
+  VERSION = "3.9.0".freeze
 end

data/spec/lib/capistrano/dsl_spec.rb

@@ -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" 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" 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" 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" 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/support/test_app.rb

@@ -132,12 +132,12 @@ module TestApp
     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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano
 version: !ruby/object:Gem::Version
-  version: 3.8.2
+  version: 3.9.0
 platform: ruby
 authors:
 - Tom Clements
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-16 00:00:00.000000000 Z
+date: 2017-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: airbrussh
@@ -285,7 +285,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Capistrano - Welcome to easy deployment with Ruby over SSH