capistrano 3.0.1 → 3.1.0

data/lib/capistrano/setup.rb

@@ -8,11 +8,12 @@ end
 
 stages.each do |stage|
   Rake::Task.define_task(stage) do
+    set(:stage, stage.to_sym)
+
     invoke 'load:defaults'
-    load 'config/deploy.rb'
-    load "config/deploy/#{stage}.rb"
+    load deploy_config_path
+    load stage_config_path.join("#{stage}.rb")
     load "capistrano/#{fetch(:scm)}.rb"
-    set(:stage, stage.to_sym)
     I18n.locale = fetch(:locale, :en)
     configure_backend
   end

data/lib/capistrano/tasks/console.rake

@@ -4,7 +4,15 @@ task :console do
   puts I18n.t('console.welcome', scope: :capistrano, stage: stage)
   loop do
     print "#{stage}> "
-    command = $stdin.gets.chomp
+
+    if input = $stdin.gets
+      command = input.chomp
+    else
+      command = 'exit'
+    end
+
+    next if command.empty?
+
     if %w{quit exit q}.include? command
       puts t('console.bye')
       break

data/lib/capistrano/tasks/deploy.rake

@@ -15,7 +15,6 @@ namespace :deploy do
 
   task :publishing do
     invoke 'deploy:symlink:release'
-    invoke 'deploy:restart'
   end
 
   task :finishing do
@@ -42,7 +41,7 @@ namespace :deploy do
   namespace :check do
     desc 'Check shared and release directories exist'
     task :directories do
-      on roles :all do
+      on release_roles :all do
         execute :mkdir, '-pv', shared_path, releases_path
       end
     end
@@ -50,15 +49,15 @@ namespace :deploy do
     desc 'Check directories to be linked exist in shared'
     task :linked_dirs do
       next unless any? :linked_dirs
-      on roles :app do
+      on release_roles :all do
         execute :mkdir, '-pv', linked_dirs(shared_path)
       end
     end
-    
+
     desc 'Check directories of files to be linked exist in shared'
     task :make_linked_dirs do
       next unless any? :linked_files
-      on roles :app do |host|
+      on release_roles :all do |host|
         execute :mkdir, '-pv', linked_file_dirs(shared_path)
       end
     end
@@ -66,7 +65,7 @@ namespace :deploy do
     desc 'Check files to be linked exist in shared'
     task :linked_files do
       next unless any? :linked_files
-      on roles :app do |host|
+      on release_roles :all do |host|
         linked_files(shared_path).each do |file|
           unless test "[ -f #{file} ]"
             error t(:linked_file_does_not_exist, file: file, host: host)
@@ -80,7 +79,7 @@ namespace :deploy do
   namespace :symlink do
     desc 'Symlink release to current'
     task :release do
-      on roles :all do
+      on release_roles :all do
         execute :rm, '-rf', current_path
         execute :ln, '-s', release_path, current_path
       end
@@ -95,7 +94,7 @@ namespace :deploy do
     desc 'Symlink linked directories'
     task :linked_dirs do
       next unless any? :linked_dirs
-      on roles :app do
+      on release_roles :all do
         execute :mkdir, '-pv', linked_dir_parents(release_path)
 
         fetch(:linked_dirs).each do |dir|
@@ -114,7 +113,7 @@ namespace :deploy do
     desc 'Symlink linked files'
     task :linked_files do
       next unless any? :linked_files
-      on roles :app do
+      on release_roles :all do
         execute :mkdir, '-pv', linked_file_dirs(release_path)
 
         fetch(:linked_files).each do |file|
@@ -133,7 +132,7 @@ namespace :deploy do
 
   desc 'Clean up old releases'
   task :cleanup do
-    on roles :all do |host|
+    on release_roles :all do |host|
       releases = capture(:ls, '-x', releases_path).split
       if releases.count >= fetch(:keep_releases)
         info t(:keeping_releases, host: host.to_s, keep_releases: fetch(:keep_releases), releases: releases.count)
@@ -152,7 +151,7 @@ namespace :deploy do
 
   desc 'Remove and archive rolled-back release.'
   task :cleanup_rollback do
-    on roles(:all) do
+    on release_roles(:all) do
       last_release = capture(:ls, '-xr', releases_path).split.first
       last_release_path = releases_path.join(last_release)
       if test "[ `readlink #{current_path}` != #{last_release_path} ]"
@@ -168,7 +167,7 @@ namespace :deploy do
 
   desc 'Log details of the deploy'
   task :log_revision do
-    on roles(:all) do
+    on release_roles(:all) do
       within releases_path do
         execute %{echo "#{revision_log_message}" >> #{revision_log}}
       end
@@ -177,7 +176,7 @@ namespace :deploy do
 
   desc 'Revert to previous release timestamp'
   task :revert_release => :rollback_release_path do
-    on roles(:all) do
+    on release_roles(:all) do
       set(:revision_log_message, rollback_log_message)
     end
   end
@@ -187,18 +186,21 @@ namespace :deploy do
   end
 
   task :last_release_path do
-    on roles(:all) do
+    on release_roles(:all) do
       last_release = capture(:ls, '-xr', releases_path).split[1]
       set_release_path(last_release)
     end
   end
 
   task :rollback_release_path do
-    on roles(:all) do
+    on release_roles(:all) do
       last_release = capture(:ls, '-xr', releases_path).split[1]
       set_release_path(last_release)
       set(:rollback_timestamp, last_release)
     end
   end
 
+  task :restart
+  task :failed
+
 end

data/lib/capistrano/tasks/framework.rake

@@ -57,6 +57,7 @@ end
 
 desc 'Deploy a new release.'
 task :deploy do
+  set(:deploying, true)
   %w{ starting started
       updating updated
       publishing published

data/lib/capistrano/tasks/git.rake

@@ -1,5 +1,9 @@
 namespace :git do
 
+  def strategy
+    @strategy ||= Capistrano::Git.new(self, fetch(:git_strategy, Capistrano::Git::DefaultStrategy))
+  end
+
   set :git_environmental_variables, ->() {
     {
       git_askpass: "/bin/echo",
@@ -9,7 +13,7 @@ namespace :git do
 
   desc 'Upload the git wrapper script, this script guarantees that we can script git without getting an interactive prompt'
   task :wrapper do
-    on roles :all do
+    on release_roles :all do
       execute :mkdir, "-p", "#{fetch(:tmp_dir)}/#{fetch(:application)}/"
       upload! StringIO.new("#!/bin/sh -e\nexec /usr/bin/ssh -o PasswordAuthentication=no -o StrictHostKeyChecking=no \"$@\"\n"), "#{fetch(:tmp_dir)}/#{fetch(:application)}/git-ssh.sh"
       execute :chmod, "+x", "#{fetch(:tmp_dir)}/#{fetch(:application)}/git-ssh.sh"
@@ -19,22 +23,22 @@ namespace :git do
   desc 'Check that the repository is reachable'
   task check: :'git:wrapper' do
     fetch(:branch)
-    on roles :all do
+    on release_roles :all do
       with fetch(:git_environmental_variables) do
-        exit 1 unless test :git, :'ls-remote', repo_url
+        exit 1 unless strategy.check
       end
     end
   end
 
   desc 'Clone the repo to the cache'
   task clone: :'git:wrapper' do
-    on roles :all do
-      if test " [ -f #{repo_path}/HEAD ] "
+    on release_roles :all do
+      if strategy.test
         info t(:mirror_exists, at: repo_path)
       else
         within deploy_path do
           with fetch(:git_environmental_variables) do
-            execute :git, :clone, '--mirror', repo_url, repo_path
+            strategy.clone
           end
         end
       end
@@ -43,20 +47,22 @@ namespace :git do
 
   desc 'Update the repo mirror to reflect the origin state'
   task update: :'git:clone' do
-    on roles :all do
+    on release_roles :all do
       within repo_path do
-        execute :git, :remote, :update
+        capturing_revisions do
+          strategy.update
+        end
       end
     end
   end
 
   desc 'Copy repo to releases'
   task create_release: :'git:update' do
-    on roles :all do
+    on release_roles :all do
       with fetch(:git_environmental_variables) do
         within repo_path do
           execute :mkdir, '-p', release_path
-          execute :git, :archive, fetch(:branch), '| tar -x -C', release_path
+          strategy.release
         end
       end
     end

data/lib/capistrano/tasks/hg.rake

@@ -1,19 +1,23 @@
 namespace :hg do
+  def strategy
+    @strategy ||= Capistrano::Hg.new(self, fetch(:hg_strategy, Capistrano::Hg::DefaultStrategy))
+  end
+
   desc 'Check that the repo is reachable'
   task :check do
-    on roles :all do
-      execute "hg", "id", repo_url
+    on release_roles :all do
+      strategy.check
     end
   end
 
   desc 'Clone the repo to the cache'
   task :clone do
-    on roles :all do
-      if test " [ -d #{repo_path}/.hg ] "
+    on release_roles :all do
+      if strategy.test
         info t(:mirror_exists, at: repo_path)
       else
         within deploy_path do
-          execute "hg", "clone", "--noupdate", repo_url, repo_path
+          strategy.clone
         end
       end
     end
@@ -21,18 +25,18 @@ namespace :hg do
 
   desc 'Pull changes from the remote repo'
   task :update => :'hg:clone' do
-    on roles :all do
+    on release_roles :all do
       within repo_path do
-        execute "hg", "pull"
+        strategy.update
       end
     end
   end
 
   desc 'Copy repo to releases'
   task :create_release => :'hg:update' do
-    on roles :all do
+    on release_roles :all do
       within repo_path do
-        execute "hg", "archive", release_path, "--rev", fetch(:branch)
+        strategy.release
       end
     end
   end

data/lib/capistrano/templates/Capfile

@@ -12,8 +12,7 @@ require 'capistrano/deploy'
 #   https://github.com/capistrano/rbenv
 #   https://github.com/capistrano/chruby
 #   https://github.com/capistrano/bundler
-#   https://github.com/capistrano/rails/tree/master/assets
-#   https://github.com/capistrano/rails/tree/master/migrations
+#   https://github.com/capistrano/rails
 #
 # require 'capistrano/rvm'
 # require 'capistrano/rbenv'

data/lib/capistrano/templates/deploy.rb.erb

@@ -1,19 +1,37 @@
+# config valid only for Capistrano 3.1
+lock '<%= Capistrano::VERSION %>'
+
 set :application, 'my_app_name'
 set :repo_url, 'git@example.com:me/my_repo.git'
 
+# Default branch is :master
 # ask :branch, proc { `git rev-parse --abbrev-ref HEAD`.chomp }
 
+# Default deploy_to directory is /var/www/my_app
 # set :deploy_to, '/var/www/my_app'
+
+# Default value for :scm is :git
 # set :scm, :git
 
+# Default value for :format is :pretty
 # set :format, :pretty
+
+# Default value for :log_level is :debug
 # set :log_level, :debug
+
+# Default value for :pty is false
 # set :pty, true
 
+# Default value for :linked_files is []
 # set :linked_files, %w{config/database.yml}
+
+# Default value for linked_dirs is []
 # set :linked_dirs, %w{bin log tmp/pids tmp/cache tmp/sockets vendor/bundle public/system}
 
+# Default value for default_env is {}
 # set :default_env, { path: "/opt/ruby/bin:$PATH" }
+
+# Default value for keep_releases is 5
 # set :keep_releases, 5
 
 namespace :deploy do
@@ -26,6 +44,8 @@ namespace :deploy do
     end
   end
 
+  after :publishing, :restart
+
   after :restart, :clear_cache do
     on roles(:web), in: :groups, limit: 3, wait: 10 do
       # Here we can do anything such as:
@@ -35,6 +55,4 @@ namespace :deploy do
     end
   end
 
-  after :finishing, 'deploy:cleanup'
-
 end

data/lib/capistrano/templates/stage.rb.erb

@@ -1,10 +1,9 @@
-set :stage, :<%= stage %>
-
 # Simple Role Syntax
 # ==================
 # Supports bulk-adding hosts to roles, the primary
 # server in each group is considered to be the first
 # unless any hosts have the primary property set.
+# Don't declare `role :all`, it's a meta role
 role :app, %w{deploy@example.com}
 role :web, %w{deploy@example.com}
 role :db,  %w{deploy@example.com}
@@ -38,5 +37,3 @@ server 'example.com', user: 'deploy', roles: %w{web app}, my_property: :my_value
 #     # password: 'please use keys'
 #   }
 # setting per server overrides global ssh_options
-
-# fetch(:default_env).merge!(rails_env: :<%= stage %>)

data/lib/capistrano/version.rb

@@ -1,3 +1,3 @@
 module Capistrano
-  VERSION = "3.0.1"
+  VERSION = "3.1.0"
 end

data/spec/integration/dsl_spec.rb

@@ -4,6 +4,10 @@ describe Capistrano::DSL do
 
   let(:dsl) { Class.new.extend Capistrano::DSL }
 
+  before do
+    Capistrano::Configuration.reset!
+  end
+
   describe 'setting and fetching hosts' do
     describe 'when defining a host using the `server` syntax' do
       before do
@@ -11,13 +15,33 @@ describe Capistrano::DSL do
         dsl.server 'example2.com', roles: %w{web}
         dsl.server 'example3.com', roles: %w{app web}, active: true
         dsl.server 'example4.com', roles: %w{app}, primary: true
+        dsl.server 'example5.com', roles: %w{db}, no_release: true
       end
 
       describe 'fetching all servers' do
         subject { dsl.roles(:all) }
 
         it 'returns all servers' do
-          expect(subject.map(&:hostname)).to eq %w{example1.com example2.com example3.com example4.com}
+          expect(subject.map(&:hostname)).to eq %w{example1.com example2.com example3.com example4.com example5.com}
+        end
+      end
+
+      describe 'fetching all release servers' do
+
+        context 'with no additional options' do
+          subject { dsl.release_roles(:all) }
+
+          it 'returns all release servers' do
+            expect(subject.map(&:hostname)).to eq %w{example1.com example2.com example3.com example4.com}
+          end
+        end
+
+        context 'with filter options' do
+          subject { dsl.release_roles(:all, filter: :active) }
+
+          it 'returns all release servers that match the filter' do
+            expect(subject.map(&:hostname)).to eq %w{example1.com example3.com}
+          end
         end
       end
 
@@ -36,6 +60,14 @@ describe Capistrano::DSL do
         end
       end
 
+      describe 'fetching servers by an array of roles' do
+        subject { dsl.roles([:app]) }
+
+        it 'returns the servers' do
+          expect(subject.map(&:hostname)).to eq %w{example3.com example4.com}
+        end
+      end
+
       describe 'fetching filtered servers by role' do
         subject { dsl.roles(:app, filter: :active) }
 
@@ -70,6 +102,14 @@ describe Capistrano::DSL do
 
     end
 
+    describe 'when defining role with reserved name' do
+      it 'fails with ArgumentError' do
+        expect {
+          dsl.role :all, %w{example1.com}
+        }.to raise_error(ArgumentError, "all reserved name for role. Please choose another name")
+      end
+    end
+
     describe 'when defining hosts using the `role` syntax' do
       before do
         dsl.role :web, %w{example1.com example2.com example3.com}
@@ -77,16 +117,37 @@ describe Capistrano::DSL do
         dsl.role :app, %w{example3.com example4.com}
         dsl.role :app, %w{example3.com}, active: true
         dsl.role :app, %w{example4.com}, primary: true
+        dsl.role :db, %w{example5.com}, no_release: true
       end
 
       describe 'fetching all servers' do
         subject { dsl.roles(:all) }
 
         it 'returns all servers' do
-          expect(subject.map(&:hostname)).to eq %w{example1.com example2.com example3.com example4.com}
+          expect(subject.map(&:hostname)).to eq %w{example1.com example2.com example3.com example4.com example5.com}
         end
       end
 
+      describe 'fetching all release servers' do
+
+        context 'with no additional options' do
+          subject { dsl.release_roles(:all) }
+
+          it 'returns all release servers' do
+            expect(subject.map(&:hostname)).to eq %w{example1.com example2.com example3.com example4.com}
+          end
+        end
+
+        context 'with filter options' do
+          subject { dsl.release_roles(:all, filter: :active) }
+
+          it 'returns all release servers that match the filter' do
+            expect(subject.map(&:hostname)).to eq %w{example1.com example3.com}
+          end
+        end
+      end
+
+
       describe 'fetching servers by role' do
         subject { dsl.roles(:app) }
 
@@ -95,6 +156,14 @@ describe Capistrano::DSL do
         end
       end
 
+      describe 'fetching servers by an array of roles' do
+        subject { dsl.roles([:app]) }
+
+        it 'returns the servers' do
+          expect(subject.map(&:hostname)).to eq %w{example3.com example4.com}
+        end
+      end
+
       describe 'fetching filtered servers by role' do
         subject { dsl.roles(:app, filter: :active) }
 
@@ -129,6 +198,34 @@ describe Capistrano::DSL do
 
     end
 
+    describe 'when defining a host using a combination of the `server` and `role` syntax' do
+
+      before do
+        dsl.server 'example1.com:1234', roles: %w{web}, active: true
+        dsl.server 'example1.com:5678', roles: %w{web}, active: true
+        dsl.role :app, %w{example1.com:5678}
+      end
+
+      describe 'fetching all servers' do
+        subject { dsl.roles(:all).map { |server| "#{server.hostname}:#{server.port}" } }
+
+        it 'creates a server instance for each unique host:port combination' do
+          expect(subject).to eq %w{example1.com:1234 example1.com:5678}
+        end
+      end
+
+      describe 'fetching servers for a role' do
+        it 'roles defined using the `server` syntax are included' do
+          expect(dsl.roles(:web)).to have(2).items
+        end
+
+        it 'roles defined using the `role` syntax are included' do
+          expect(dsl.roles(:app)).to have(1).items
+        end
+      end
+
+    end
+
   end
 
   describe 'setting and fetching variables' do
@@ -340,5 +437,53 @@ describe Capistrano::DSL do
       end
     end
 
+    describe 'setting deploy configuration path' do
+      subject { dsl.deploy_config_path.to_s }
+
+      context 'where no config path is set' do
+        before do
+          dsl.delete(:deploy_config_path)
+        end
+
+        it 'returns "config/deploy.rb"' do
+          expect(subject).to eq 'config/deploy.rb'
+        end
+      end
+
+      context 'where a custom path is set' do
+        before do
+          dsl.set(:deploy_config_path, 'my/custom/path.rb')
+        end
+
+        it 'returns the custom path' do
+          expect(subject).to eq 'my/custom/path.rb'
+        end
+      end
+    end
+
+    describe 'setting stage configuration path' do
+      subject { dsl.stage_config_path.to_s }
+
+      context 'where no config path is set' do
+
+        before do
+          dsl.delete(:stage_config_path)
+        end
+
+        it 'returns "config/deploy"' do
+          expect(subject).to eq 'config/deploy'
+        end
+      end
+
+      context 'where a custom path is set' do
+        before do
+          dsl.set(:stage_config_path, 'my/custom/path')
+        end
+
+        it 'returns the custom path' do
+          expect(subject).to eq 'my/custom/path'
+        end
+      end
+    end
   end
 end