capistrano 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14835eba6a1dd4641ae3514aba8b5ae19a010745
-  data.tar.gz: 803ec0a5f10fa2460f1d781e3327458bd38e663c
+  metadata.gz: 3783d6041216c4b9c311d09d0e21b4cb59faa047
+  data.tar.gz: 9080286b94f6d929467214fe2beb1e4cbfcf69ac
 SHA512:
-  metadata.gz: b77178d4e4749b679702d11dd9024d545c4574311d1e31c1c79b2604219297fa21afa3e496ed20bb23bb94abb3609ccb74e98173e77282ff10de3da8e55d9b9a
-  data.tar.gz: 3aeda119efcdb4abb7ca7e245dab96e684133bf7556430aad99803730eb530b14738606485e0125c5a4dad2a56278b90ea8282e157a8ae07fb60fef95fb74f3d
+  metadata.gz: 1bb13c785e02643ee9a9f511f875fd96eb3d6cf0765b412546e7d0a89aaa04b8e46700700fa58ee47de02ad8ef9b1ac79ea37be6fabd895d74544d5b5a3d59f5
+  data.tar.gz: 6f00a69f1245900b8b1b88dfa7208b0416681fdd87157831c0c7f1415ee02bfb106b3c4e5b997aadeb7bc86cc79aca7dfc4e0c1cb92a94fee927ac292bc7caf5

data/.gitignore

@@ -18,3 +18,4 @@ tmp
 .rspec-local
 .ruby-version
 _site
+.rspec

data/.travis.yml

@@ -1,7 +1,10 @@
 language: ruby
 rvm:
+  - 2.1.0
   - 2.0.0
   - 1.9.3
   - 1.9.2
-  - rbx-19mode
-script: "rake spec"
+  - rbx
+script: bundle exec rake spec
+cache: bundler
+bundler_args: --without cucumber

data/CHANGELOG.md

@@ -2,9 +2,42 @@
 
 Reverse Chronological Order:
 
-## `3.0.1` (Not yet released)
-
-  * capify' not listed as executable (@leehambley)
+## `3.1.0`
+
+Breaking changes:
+
+  * `deploy:restart` task **is no longer run by default**.
+    From this version, developers who restart the app on each deploy need to declare it in their deploy flow (eg `after 'deploy:publishing', 'deploy:restart'`).
+
+    Please, check https://github.com/capistrano/capistrano/commit/4e6523e1f50707499cf75eb53dce37a89528a9b0 for more information. (@kirs)
+
+* Minor changes
+  * Tasks that used `linked_dirs` and `linked_files` now run on all roles, not just app roles (@mikespokefire)
+  * Tasks `deploy:linked_dirs`, `deploy:make_linked_dirs`, `deploy:linked_files`, `deploy:cleanup_rollback`,
+    `deploy:log_revision` and `deploy:revert_release` now use `release_roles()` not `roles()` meaning that they
+    will only run on servers where the `no_release` property is not falsy. (@leehambley)
+  * Fixed bug when `deploy:cleanup` was executed twice by default (@kirs)
+  * Config location can now be changed with `deploy_config_path` and `stage_config_path` options (@seenmyfate)
+  * `no_release` option is now available (@seenmyfate)
+  * Raise an error if developer tries to define `:all` role, which is reserved (@kirs)
+  * `deploy:fallback` hook was added to add some custom behaviour on failed deploy (@seenmyfate)
+  * Correctly infer namespace in task enhancements (@seenmyfate)
+  * Add SHA to revision log (@blackxored)
+  * Allow configuration of multiple servers with same hostname but different ports (@rsslldnphy)
+  * Add command line option to control role filtering (@andytinycat)
+  * Make use of recent changes in Rake to over-ride the application name (@shime)
+  * Readme corrections (@nathanstitt)
+  * Allow roles to be fetched with a variable containing an array (@seenmyfate)
+  * Improve console (@jage)
+  * Add ability to filter tasks to specific servers (host filtering). (@andytinycat)
+  * Add a command line option to control role filter (`--roles`) (@andytinycat)
+  * Use an SCM object with a pluggable strategy (@coffeeaddict)
+
+Big thanks to @Kriechi for his help.
+
+## `3.0.1`
+
+  * `capify` not listed as executable (@leehambley)
   * Confirm license as MIT (@leehambley)
   * Move the git ssh helper to application path (@mpapis)
 

data/CONTRIBUTING.md

@@ -0,0 +1,91 @@
+## CONTRIBUTING
+
+**The issue tracker is intended exclusively for things that are genuine bugs,
+or improvements to the code.**
+
+If you have a user support query, or you suspect that you might just be holding
+it wrong, drop us a line at [the mailing list]() or on [StackOverflow](). The
+mailing list is moderated to cut down on spam, so please be patient, if you use
+StackOverflow, make sure to tag your post with "Capistrano". (Not forgetting
+any other tags which might relate, rvm, rbenv, Ubuntu, etc.)
+
+Wherever you post please be sure to include the version of Capistrano you are
+using, which versions of any plugins (*capistrano-rvm*, *capistrano-bundler*,
+etc.). Proper logs are vital, if you need to redact them, go ahead, but be
+careful not to remove anything important. Please take care to format logs and
+code correctly, ideally wrapped to a sane line length, and in a mono spaced
+font. This all helps us to gather a clear understanding of what is going wrong.
+
+**If you really think that you found a bug, or want to enquire about a feature,
+or send us a patch to add a feature, or fix a bug, please keep a few things in
+mind:**
+
+## When Submitting An Issue:
+
+If you think there's a bug, please make sure it's really a bug in Capistrano.
+As Capistrano sits on the (sometimes rough) edges between SSH, Git, the
+network, Ruby, RVM, rbenv, chruby, Bundler, your Linux distribution, countless
+shell configuration files on your end, and the server… there's a good chance
+the problem lies somewhere else.
+
+Please make sure you have reviewed the FAQs at http://www.capistranorb.com/.
+
+It's really important to include as much information as possible, versions of
+everything involved, anything weird you might be doing that might be having
+side effects, include as much as you can in a [GitHub
+Gist](https://gist.github.com/) and link that from the issue, with tools such
+as Gist, we can link to individual lines and help work out what is going wrong.
+
+If you are an experienced Ruby programmer, take a few minutes to get our test
+suite running, and do what you can to get a test case written that fails, from
+there we can understand exactly what it takes to reproduce the issue (as it's
+documented with code)
+
+## When Requesting a Feature:
+
+We can't make everyone happy all of the time, and we've been around the block
+well enough to know when something doesn't work well, or when your proposed fix
+might impact other things.
+
+We prefer to [start with
+"no"](https://gettingreal.37signals.com/ch05_Start_With_No.php), and help you
+find a better way to solve your problem, sometimes the solution is to [build
+faster
+horses](http://blog.cauvin.org/2010/07/henry-fords-faster-horse-quote.html),
+sometimes the solution is to work around it in a neat way that you didn't know
+existed.
+
+Please don't be offended if we say no, and don't be afraid to fight your
+corner, try and avoid being one of the [poisonous
+people](https://www.youtube.com/watch?v=Q52kFL8zVoM)
+
+## Submitting A Pull Request:
+
+Pull requests are awesome, and if they arrive with decent tests, and conform to
+the guidelines below, we'll merge them in as soon as possible, we'll let you
+know which release we're planning them for (we adhere to
+[semver](http://semver.org/) so please don't be upset if we plan your changes
+for a later release)
+
+ * The code is MIT licenced, your code will fall under the same license if we merge it.
+ * We can't merge it without a [good commit
+   message](http://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message).
+   If you do this right, Github will use the commit message as the body of your
+   pull request, double win.
+ * If you are referencing an improvement to an existing issue (if we have not
+   yet merged it )
+ * Add an entry to the `CHANGELOG` under the `### master` section, but please
+   don't mess with the version.
+ * If you add a new feature, please make sure to document it, open a
+   corresponding pull request in [the
+   documentation](https://github.com/capistrano/documentation) and mention the
+   code change pull request over there, and Github will link everything up. If
+   it's a simple feature, or a new variable, or something changed, it may be
+   appropriate simply to document it in the generated `Capfile` or `deploy.rb`, or
+   in the `README`
+ * Take care to squash your commit into one single commit with a good message, it
+   saves us a lot of work in maintaining the CHANGELOG if we can generate it from
+   the commit messages between the release tags!
+ * Tests! It's tricky to test some parts of Capistrano, but do your best, it
+   might just serve as a starting point for us to build a reliable test on top of,
+   and help us understand where you are coming from.

data/Gemfile

@@ -2,3 +2,12 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in capistrano.gemspec
 gemspec
+
+group :cucumber do
+  gem 'kuroko'
+  gem 'cucumber'
+end
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+end

data/README.md

@@ -9,7 +9,7 @@
 Add this line to your application's Gemfile:
 
 ``` ruby
-gem 'capistrano', '~> 3.0.0'
+gem 'capistrano', '~> 3.0.1'
 ```
 
 And then execute:
@@ -65,7 +65,7 @@ server 'example.org', roles: [:db, :workers]
 desc "Report Uptimes"
 task :uptime do
   on roles(:all) do |host|
-    info "Host #{host} (#{host.roles.join(', ')}):\t#{capture(:uptime)}"
+    info "Host #{host} (#{host.roles.to_a.join(', ')}):\t#{capture(:uptime)}"
   end
 end
 ```
@@ -91,7 +91,7 @@ after :finishing, :notify do
 end
 ```
 
-If it makes sense for your use-case (often, that means *generating a file*)
+If it makes sense for your use case (often, that means *generating a file*)
 the Rake prerequisite mechanism can be used:
 
 ``` ruby
@@ -126,9 +126,9 @@ This method is widely used.
 ``` ruby
 desc "Ask about breakfast"
 task :breakfast do
-  breakfast = ask(:breakfast, "What would you like your colleagues to get you for breakfast?")
+  ask(:breakfast, "pancakes")
   on roles(:all) do |h|
-    execute "echo \"$(whoami) wants #{breakfast} for breakfast!\" | wall"
+    execute "echo \"$(whoami) wants #{fetch(:breakfast)} for breakfast!\""
   end
 end
 ```
@@ -184,7 +184,7 @@ DEBUG [9ce34809]  leehambley pts/0        2013-06-13 17:11 (port-11262.pppoe.wtn
 
 ## A word about PTYs
 
-There is a configuration option which asks the backend driver to as the remote host
+There is a configuration option which asks the backend driver to ask the remote host
 to assign the connection a *pty*. A *pty* is a pseudo-terminal, which in effect means
 *tell the backend that this is an **interactive** session*. This is normally a bad idea.
 
@@ -200,7 +200,7 @@ or at least they are being used incorrectly.
 Whilst, especially in the case of language runtimes (Ruby, Node, Python and friends in
 particular) there is a temptation to run multiple versions in parallel on a single server
 and to switch between them using environmental variables, this is an anti-pattern, and
-symptomatic of bad design (i.e. you're testing a second version of Ruby in production because
+symptomatic of bad design (e.g. you're testing a second version of Ruby in production because
 your company lacks the infrastructure to test this in a staging environment).
 
 ## Configuration
@@ -210,9 +210,7 @@ The following variables are settable:
 | Variable Name         | Description                                                          | Notes                                                           |
 |:---------------------:|----------------------------------------------------------------------|-----------------------------------------------------------------|
 | `:repo_url`           | The URL of your Git repository                                       | file://, https://, or ssh:// are all supported                  |
-| `:git_https_username` | The (optional) username for accessing your Git repository over HTTPS | if this is an SSH connection, this setting will have no effect. |
-| `:git_https_password` | The (optional) password for accessing your Git repository over HTTPS | if this is an SSH connection, this setting will have no effect. |
-| `:tmp_dir` | The (optional) temp directory that will be used (default: /tmp) | if you have a shared web host, this setting may need to be set (i.e. /home/user/tmp/capistrano). |
+| `:tmp_dir`            | The (optional) temp directory that will be used (default: /tmp)      | if you have a shared web host, this setting may need to be set (i.e. /home/user/tmp/capistrano). |
 
 __Support removed__ for following variables:
 
@@ -223,7 +221,7 @@ __Support removed__ for following variables:
 ## SSHKit
 
 [SSHKit](https://github.com/leehambley/sshkit) is the driver for SSH
-connections behind the scenes in Capistrano, depending how deep you dig, you
+connections behind the scenes in Capistrano. Depending on how deep you dig, you
 might run into interfaces that come directly from SSHKit (the configuration is
 a good example).
 

data/capistrano.gemspec

@@ -19,19 +19,16 @@ Gem::Specification.new do |gem|
 
   gem.licenses      = ['MIT']
 
-  gem.post_install_message = "If you're updating Capistrano from 2.x.x, we recommend you to read the upgrade guide: http://www.capistranorb.com/documentation/upgrading/"
+  gem.post_install_message = <<eos
+Capistrano 3.1 has some breaking changes, like `deploy:restart` callback should be added manually to your deploy.rb. Please, check the CHANGELOG: http://goo.gl/SxB0lr
 
-  #gem.signing_key = '/Volumes/SD Card/leehambley-private_key.pem'
-  #gem.cert_chain  = ['capistrano-public_cert.pem', 'leehambley-public_cert.pem']
+If you're upgrading Capistrano from 2.x, we recommend to read the upgrade guide: http://goo.gl/4536kB
+eos
 
-  gem.add_dependency 'sshkit', '>= 0.0.23'
+  gem.add_dependency 'sshkit', '~> 1.3'
   gem.add_dependency 'rake', '>= 10.0.0'
   gem.add_dependency 'i18n'
 
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'mocha'
-  gem.add_development_dependency 'vagrant', '~> 1.0.7'
-  gem.add_development_dependency 'kuroko'
-  gem.add_development_dependency 'cucumber'
-
 end

data/features/configuration.feature

@@ -0,0 +1,15 @@
+Feature: The path to the configuration can be changed, removing the need to
+  follow Ruby/Rails conventions
+
+  Background:
+    Given a test app with the default configuration
+    And servers with the roles app and web
+
+  Scenario: Deploying with configuration in default location
+    When I run "cap test"
+    Then the task is successful
+
+  Scenario: Deploying with configuration in a custom location
+    But the configuration is in a custom location
+    When I run "cap test"
+    Then the task is successful

data/features/deploy.feature

@@ -34,6 +34,7 @@ Feature: Deploy
     Then the task will be successful
 
   Scenario: Creating a release
+    Given I run cap "deploy:check:directories"
     When I run cap "git:create_release" as part of a release
     Then the repo is cloned
     And the release is created

data/features/deploy_failure.feature

@@ -0,0 +1,17 @@
+Feature: Deploy failure
+
+  Background:
+    Given a test app with the default configuration
+    And a custom task that will simulate a failure
+    And a custom task to run in the event of a failure
+    And servers with the roles app and web
+
+  Scenario: Triggering the custom task
+    When I run cap "deploy:starting"
+    But an error is raised
+    Then the failure task will not run
+
+  Scenario: Triggering the custom task
+    When I run cap "deploy"
+    But an error is raised
+    Then the failure task will run

data/features/step_definitions/assertions.rb

@@ -88,3 +88,22 @@ end
 Then(/^it will not recreate the file$/) do
   #
 end
+
+Then(/^the task is successful$/) do
+  expect(@success).to be_true
+end
+
+Then(/^the failure task will run$/) do
+  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')
+  !run_vagrant_command(test_file_exists(failed))
+end
+
+When(/^an error is raised$/) do
+  error = TestApp.shared_path.join('fail')
+  run_vagrant_command(test_file_exists(error))
+end

data/features/step_definitions/cap_commands.rb

@@ -1,8 +1,12 @@
 When(/^I run cap "(.*?)"$/) do |task|
-  TestApp.cap(task)
+  @success = TestApp.cap(task)
 end
 
 When(/^I run cap "(.*?)" as part of a release$/) do |task|
   TestApp.cap("deploy:new_release_path #{task}")
 end
 
+When(/^I run "(.*?)"$/) do |command|
+  @success = TestApp.run(command)
+end
+

data/features/step_definitions/setup.rb

@@ -23,3 +23,16 @@ Given(/^a custom task to generate a file$/) do
   TestApp.copy_task_to_test_app('spec/support/tasks/database.cap')
 end
 
+Given(/^the configuration is in a custom location$/) do
+  TestApp.move_configuration_to_custom_location('app')
+end
+
+Given(/^a custom task that will simulate a failure$/) do
+  safely_remove_file(TestApp.shared_path.join('failed'))
+  TestApp.copy_task_to_test_app('spec/support/tasks/fail.cap')
+end
+
+Given(/^a custom task to run in the event of a failure$/) do
+  safely_remove_file(TestApp.shared_path.join('failed'))
+  TestApp.copy_task_to_test_app('spec/support/tasks/failed.cap')
+end

data/features/support/remote_command_helpers.rb

@@ -15,6 +15,10 @@ module RemoteCommandHelpers
   def exists?(type, path)
     %{[ -#{type} "#{path}" ] && echo "#{path} exists." || echo "Error: #{path} does not exist."}
   end
+
+  def safely_remove_file(path)
+    run_vagrant_command("rm #{test_file}") rescue Vagrant::Errors::VagrantError
+  end
 end
 
 World(RemoteCommandHelpers)

data/lib/capistrano/application.rb

@@ -3,22 +3,24 @@ module Capistrano
 
     def initialize
       super
-      @name = "cap"
       @rakefiles = %w{capfile Capfile capfile.rb Capfile.rb} << capfile
     end
 
+    def name
+      "cap"
+    end
+
     def run
       Rake.application = self
       super
     end
 
     def sort_options(options)
-      options.push(version,dry_run)
+      options.push(version, roles, dry_run, hostfilter)
       super
     end
 
     def load_rakefile
-      @name = 'cap'
       super
     end
 
@@ -30,8 +32,25 @@ module Capistrano
       end
     end
 
+    def exit_because_of_exception(ex)
+      if deploying?
+        exit_deploy_because_of_exception(ex)
+      else
+        super
+      end
+    end
+
     private
 
+    def load_imports
+      if options.show_tasks
+        invoke 'load:defaults'
+        Dir[deploy_config_path, stage_definitions].each { |f| add_import f }
+      end
+
+      super
+    end
+
     # allows the `cap install` task to load without a capfile
     def capfile
       File.expand_path(File.join(File.dirname(__FILE__),'..','Capfile'))
@@ -55,6 +74,25 @@ module Capistrano
        }
       ]
     end
+
+    def roles
+      ['--roles ROLES', '-r',
+       "Filter command to only apply to these roles (separate multiple roles with a comma)",
+       lambda { |value|
+         Configuration.env.set(:filter, :roles => value.split(","))
+       }
+      ]
+    end
+
+    def hostfilter
+      ['--hosts HOSTS', '-z',
+       "Filter command to only apply to these hosts (separate multiple hosts with a comma)",
+       lambda { |value|
+         Configuration.env.set(:filter, :hosts => value.split(","))
+       }
+      ]
+    end
+
   end
 
 end