capistrano 3.2.1 → 3.3.3

data/lib/capistrano/configuration/servers.rb

@@ -1,26 +1,29 @@
 require 'set'
-require_relative 'servers/role_filter'
-require_relative 'servers/host_filter'
+require 'capistrano/configuration'
+require 'capistrano/configuration/filter'
+
 module Capistrano
   class Configuration
     class Servers
       include Enumerable
 
       def add_host(host, properties={})
-        servers.add server(host).with(properties)
+        servers.add server(host, properties).with(properties)
       end
 
       def add_role(role, hosts, options={})
-        Array(hosts).each { |host| add_host(host, options.merge(roles: role)) }
+        options_deepcopy = Marshal.dump(options.merge(roles: role))
+        Array(hosts).each { |host| add_host(host, Marshal.load(options_deepcopy)) }
       end
 
       def roles_for(names)
         options = extract_options(names)
-        fetch_roles(names, options)
+        s = Filter.new(:role, names).filter(servers)
+        s.select { |server| server.select?(options) }
       end
 
       def fetch_primary(role)
-        hosts = fetch(role)
+        hosts = roles_for([role])
         hosts.find(&:primary) || hosts.first
       end
 
@@ -30,29 +33,9 @@ module Capistrano
 
       private
 
-      def server(host)
-        servers.find { |server| server.matches? Server[host] } || Server[host]
-      end
-
-      def fetch(role)
-        servers.find_all { |server| server.has_role? role}
-      end
-
-      def fetch_roles(required, options)
-        filter_roles = RoleFilter.for(required, available_roles)
-        HostFilter.for(select(servers_with_roles(filter_roles), options))
-      end
-
-      def servers_with_roles(roles)
-        roles.flat_map { |role| fetch role }.uniq
-      end
-
-      def select(servers, options)
-        servers.select { |server| server.select?(options) }
-      end
-
-      def available_roles
-        servers.flat_map { |server| server.roles_array }.uniq
+      def server(host, properties)
+        new_host = Server[host].with(properties)
+        servers.find { |server| server.matches? new_host } || new_host
       end
 
       def servers

data/lib/capistrano/defaults.rb

@@ -1,12 +1,14 @@
-set :scm, :git
-set :branch, :master
-set :deploy_to, -> { "/var/www/#{fetch(:application)}" }
-set :tmp_dir, "/tmp"
+set_if_empty :scm, :git
+set_if_empty :branch, :master
+set_if_empty :deploy_to, -> { "/var/www/#{fetch(:application)}" }
+set_if_empty :tmp_dir, "/tmp"
 
-set :default_env, {}
-set :keep_releases, 5
+set_if_empty :default_env, {}
+set_if_empty :keep_releases, 5
 
-set :format, :pretty
-set :log_level, :debug
+set_if_empty :format, :pretty
+set_if_empty :log_level, :debug
 
-set :pty, false
+set_if_empty :pty, false
+
+set_if_empty :local_user, -> { Etc.getlogin }

data/lib/capistrano/deploy.rb

@@ -1,3 +1,4 @@
 require 'capistrano/framework'
+require 'capistrano-stats'
 
 load File.expand_path("../tasks/deploy.rake", __FILE__)

data/lib/capistrano/dsl.rb

@@ -3,6 +3,7 @@ require 'capistrano/dsl/task_enhancements'
 require 'capistrano/dsl/paths'
 require 'capistrano/dsl/stages'
 require 'capistrano/dsl/env'
+require 'capistrano/configuration/filter'
 
 module Capistrano
   module DSL
@@ -33,7 +34,7 @@ module Capistrano
           branch: fetch(:branch),
           user: local_user,
           sha: fetch(:current_revision),
-          release: release_timestamp)
+          release: fetch(:release_timestamp))
        )
     end
 
@@ -42,12 +43,22 @@ module Capistrano
     end
 
     def local_user
-      Etc.getlogin
+      fetch(:local_user)
     end
 
     def lock(locked_version)
       VersionValidator.new(locked_version).verify
     end
+
+    def on(hosts, options={}, &block)
+      subset = Configuration.env.filter hosts
+      SSHKit::Coordinator.new(subset).each(options, &block)
+    end
+
+    def run_locally(&block)
+      SSHKit::Backend::Local.new(&block).run
+    end
+
   end
 end
 self.extend Capistrano::DSL

data/lib/capistrano/dsl/env.rb

@@ -23,12 +23,16 @@ module Capistrano
         env.set(key, value)
       end
 
+      def set_if_empty(key, value)
+        env.set_if_empty(key, value)
+      end
+
       def delete(key)
         env.delete(key)
       end
 
-      def ask(key, value)
-        env.ask(key, value)
+      def ask(key, value, options={})
+        env.ask(key, value, options)
       end
 
       def role(name, servers, options={})

data/lib/capistrano/dsl/task_enhancements.rb

@@ -1,3 +1,5 @@
+require 'capistrano/upload_task'
+
 module Capistrano
   module TaskEnhancements
     def before(task, prerequisite, *args, &block)
@@ -19,12 +21,12 @@ module Capistrano
     end
 
     def define_remote_file_task(task, target_roles)
-      Rake::Task.define_task(task) do |t|
+      Capistrano::UploadTask.define_task(task) do |t|
         prerequisite_file = t.prerequisites.first
         file = shared_path.join(t.name)
 
         on roles(target_roles) do
-          unless test "[ -f #{file} ]"
+          unless test "[ -f #{file.to_s.shellescape} ]"
             info "Uploading #{prerequisite_file} to #{file}"
             upload! File.open(prerequisite_file), file
           end
@@ -51,7 +53,7 @@ module Capistrano
     end
 
     def exit_deploy_because_of_exception(ex)
-      warn t(:deploy_failed, ex: ex.inspect)
+      warn t(:deploy_failed, ex: ex.message)
       invoke 'deploy:failed'
       exit(false)
     end

data/lib/capistrano/git.rb

@@ -18,7 +18,7 @@ class Capistrano::Git < Capistrano::SCM
     end
 
     def check
-      test! :git, :'ls-remote -h', repo_url
+      git :'ls-remote -h', repo_url
     end
 
     def clone
@@ -30,7 +30,13 @@ class Capistrano::Git < Capistrano::SCM
     end
 
     def release
-      git :archive, fetch(:branch), '| tar -x -C', release_path
+      if tree = fetch(:repo_tree)
+        tree = tree.slice %r#^/?(.*?)/?$#, 1
+        components = tree.split('/').size
+        git :archive, fetch(:branch), tree, "| tar -x --strip-components #{components} -f - -C", release_path
+      else
+        git :archive, fetch(:branch), '| tar -x -f - -C', release_path
+      end
     end
 
     def fetch_revision

data/lib/capistrano/hg.rb

@@ -27,7 +27,13 @@ class Capistrano::Hg < Capistrano::SCM
     end
 
     def release
-      hg "archive", release_path, "--rev", fetch(:branch)
+      if tree = fetch(:repo_tree)
+        tree = tree.slice %r#^/?(.*?)/?$#, 1
+        components = tree.split('/').size
+        hg "archive --type tgz -p . -I", tree, "--rev", fetch(:branch), "| tar -x --strip-components #{components} -f - -C", release_path
+      else
+        hg "archive", release_path, "--rev", fetch(:branch)
+      end
     end
 
     def fetch_revision

data/lib/capistrano/svn.rb

@@ -28,11 +28,11 @@ class Capistrano::Svn < Capistrano::SCM
     end
 
     def release
-      svn :export, '.', release_path
+      svn :export, '--force', '.', release_path
     end
 
     def fetch_revision
-      context.capture(:svn, "log -r HEAD -q | tail -n 2 | head -n 1 | sed s/\ \|.*/''/")
+      context.capture(:svnversion, repo_path)
     end
   end
 end

data/lib/capistrano/tasks/deploy.rake

@@ -1,6 +1,7 @@
 namespace :deploy do
 
   task :starting do
+    invoke 'metrics:collect'
     invoke 'deploy:check'
     invoke 'deploy:set_previous_revision'
   end
@@ -44,7 +45,7 @@ namespace :deploy do
     desc 'Check shared and release directories exist'
     task :directories do
       on release_roles :all do
-        execute :mkdir, '-pv', shared_path, releases_path
+        execute :mkdir, '-p', shared_path, releases_path
       end
     end
 
@@ -52,7 +53,7 @@ namespace :deploy do
     task :linked_dirs do
       next unless any? :linked_dirs
       on release_roles :all do
-        execute :mkdir, '-pv', linked_dirs(shared_path)
+        execute :mkdir, '-p', linked_dirs(shared_path)
       end
     end
 
@@ -60,7 +61,7 @@ namespace :deploy do
     task :make_linked_dirs do
       next unless any? :linked_files
       on release_roles :all do |host|
-        execute :mkdir, '-pv', linked_file_dirs(shared_path)
+        execute :mkdir, '-p', linked_file_dirs(shared_path)
       end
     end
 
@@ -82,8 +83,9 @@ namespace :deploy do
     desc 'Symlink release to current'
     task :release do
       on release_roles :all do
-        execute :rm, '-rf', current_path
-        execute :ln, '-s', release_path, current_path
+        tmp_current_path = release_path.parent.join(current_path.basename)
+        execute :ln, '-s', release_path, tmp_current_path
+        execute :mv, tmp_current_path, current_path.parent
       end
     end
 
@@ -97,7 +99,7 @@ namespace :deploy do
     task :linked_dirs do
       next unless any? :linked_dirs
       on release_roles :all do
-        execute :mkdir, '-pv', linked_dir_parents(release_path)
+        execute :mkdir, '-p', linked_dir_parents(release_path)
 
         fetch(:linked_dirs).each do |dir|
           target = release_path.join(dir)
@@ -116,7 +118,7 @@ namespace :deploy do
     task :linked_files do
       next unless any? :linked_files
       on release_roles :all do
-        execute :mkdir, '-pv', linked_file_dirs(release_path)
+        execute :mkdir, '-p', linked_file_dirs(release_path)
 
         fetch(:linked_files).each do |file|
           target = release_path.join(file)
@@ -135,7 +137,7 @@ namespace :deploy do
   desc 'Clean up old releases'
   task :cleanup do
     on release_roles :all do |host|
-      releases = capture(:ls, '-x', releases_path).split
+      releases = capture(:ls, '-xtr', 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)
         directories = (releases - releases.last(fetch(:keep_releases)))
@@ -154,7 +156,7 @@ namespace :deploy do
   desc 'Remove and archive rolled-back release.'
   task :cleanup_rollback do
     on release_roles(:all) do
-      last_release = capture(:ls, '-xr', releases_path).split.first
+      last_release = capture(:ls, '-xt', releases_path).split.first
       last_release_path = releases_path.join(last_release)
       if test "[ `readlink #{current_path}` != #{last_release_path} ]"
         execute :tar, '-czf',
@@ -189,7 +191,7 @@ namespace :deploy do
 
   task :rollback_release_path do
     on release_roles(:all) do
-      releases = capture(:ls, '-xr', releases_path).split
+      releases = capture(:ls, '-xt', releases_path).split
       if releases.count < 2
         error t(:cannot_rollback)
         exit 1

data/lib/capistrano/tasks/git.rake

@@ -25,7 +25,7 @@ namespace :git do
     fetch(:branch)
     on release_roles :all do
       with fetch(:git_environmental_variables) do
-        exit 1 unless strategy.check
+        strategy.check
       end
     end
   end

data/lib/capistrano/tasks/install.rake

@@ -14,25 +14,28 @@ task :install do
 
   mkdir_p deploy_dir
 
-  template = File.read(deploy_rb)
-  file = config_dir.join('deploy.rb')
-  File.open(file, 'w+') do |f|
-    f.write(ERB.new(template).result(binding))
-    puts I18n.t(:written_file, scope: :capistrano, file: file)
-  end
-
-  template = File.read(stage_rb)
-  envs.split(',').each do |stage|
-    file = deploy_dir.join("#{stage}.rb")
-    File.open(file, 'w+') do |f|
-      f.write(ERB.new(template).result(binding))
-      puts I18n.t(:written_file, scope: :capistrano, file: file)
+  entries = [{template: deploy_rb, file: config_dir.join('deploy.rb')}]
+  entries += envs.split(',').map { |stage| {template: stage_rb, file: deploy_dir.join("#{stage}.rb")} }
+
+  entries.each do |entry|
+    if File.exists?(entry[:file])
+      warn "[skip] #{entry[:file]} already exists"
+    else
+      File.open(entry[:file], 'w+') do |f|
+        f.write(ERB.new(File.read(entry[:template])).result(binding))
+        puts I18n.t(:written_file, scope: :capistrano, file: entry[:file])
+      end
     end
   end
 
   mkdir_p tasks_dir
 
-  FileUtils.cp(capfile, 'Capfile')
+  if File.exists?('Capfile')
+    warn "[skip] Capfile already exists"
+  else
+    FileUtils.cp(capfile, 'Capfile')
+    puts I18n.t(:written_file, scope: :capistrano, file: 'Capfile')
+  end
 
 
   puts I18n.t :capified, scope: :capistrano

data/lib/capistrano/templates/Capfile

@@ -1,10 +1,10 @@
-# Load DSL and Setup Up Stages
+# Load DSL and set up stages
 require 'capistrano/setup'
 
-# Includes default deployment tasks
+# Include default deployment tasks
 require 'capistrano/deploy'
 
-# Includes tasks from other gems included in your Gemfile
+# Include tasks from other gems included in your Gemfile
 #
 # For documentation on these, see for example:
 #
@@ -13,6 +13,7 @@ require 'capistrano/deploy'
 #   https://github.com/capistrano/chruby
 #   https://github.com/capistrano/bundler
 #   https://github.com/capistrano/rails
+#   https://github.com/capistrano/passenger
 #
 # require 'capistrano/rvm'
 # require 'capistrano/rbenv'
@@ -20,6 +21,7 @@ require 'capistrano/deploy'
 # require 'capistrano/bundler'
 # require 'capistrano/rails/assets'
 # require 'capistrano/rails/migrations'
+# require 'capistrano/passenger'
 
-# Loads custom tasks from `lib/capistrano/tasks' if you have any defined.
+# Load custom tasks from `lib/capistrano/tasks' if you have any defined
 Dir.glob('lib/capistrano/tasks/*.rake').each { |r| import r }

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

@@ -1,4 +1,4 @@
-# config valid only for Capistrano 3.1
+# config valid only for current version of Capistrano
 lock '<%= Capistrano::VERSION %>'
 
 set :application, 'my_app_name'
@@ -7,8 +7,8 @@ set :repo_url, 'git@example.com:me/my_repo.git'
 # Default branch is :master
 # ask :branch, proc { `git rev-parse --abbrev-ref HEAD`.chomp }.call
 
-# Default deploy_to directory is /var/www/my_app
-# set :deploy_to, '/var/www/my_app'
+# Default deploy_to directory is /var/www/my_app_name
+# set :deploy_to, '/var/www/my_app_name'
 
 # Default value for :scm is :git
 # set :scm, :git
@@ -23,10 +23,10 @@ set :repo_url, 'git@example.com:me/my_repo.git'
 # set :pty, true
 
 # Default value for :linked_files is []
-# set :linked_files, %w{config/database.yml}
+# set :linked_files, fetch(:linked_files, []).push('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}
+# set :linked_dirs, fetch(:linked_dirs, []).push('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" }
@@ -36,16 +36,6 @@ set :repo_url, 'git@example.com:me/my_repo.git'
 
 namespace :deploy do
 
-  desc 'Restart application'
-  task :restart do
-    on roles(:app), in: :sequence, wait: 5 do
-      # Your restart mechanism here, for example:
-      # execute :touch, release_path.join('tmp/restart.txt')
-    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: