capistrano 3.2.1 → 3.3.3

data/features/step_definitions/cap_commands.rb

@@ -1,5 +1,5 @@
 When(/^I run cap "(.*?)"$/) do |task|
-  @success = TestApp.cap(task)
+  @success, @output = TestApp.cap(task)
 end
 
 When(/^I run cap "(.*?)" as part of a release$/) do |task|

data/features/step_definitions/setup.rb

@@ -6,17 +6,21 @@ Given(/^servers with the roles app and web$/) do
   vagrant_cli_command('up') rescue nil
 end
 
-Given(/^a required file$/) do
+Given(/^a linked file "(.*?)"$/) do |file|
+  # ignoring other linked files
+  TestApp.append_to_deploy_file("set :linked_files, ['#{file}']")
 end
 
-Given(/^that file exists$/) do
-  run_vagrant_command("touch #{TestApp.linked_file}")
+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("touch #{file_shared_path}")
 end
 
-Given(/^the file does not exist$/) do
-  pending
-  file = TestApp.linked_file
-  run_vagrant_command("[ -f #{file} ] && rm #{file}")
+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}")
+  run_vagrant_command("touch #{file_shared_path} && rm #{file_shared_path}")
 end
 
 Given(/^a custom task to generate a file$/) do

data/features/support/env.rb

@@ -1,12 +1,11 @@
-require 'kuroko'
-
-project_root = File.expand_path('../../../', __FILE__)
-vagrant_root = File.join(project_root, 'spec/support')
-
-Kuroko.configure do |config|
-  config.vagrant_root = 'spec/support'
+PROJECT_ROOT = File.expand_path('../../../', __FILE__)
+VAGRANT_ROOT = File.join(PROJECT_ROOT, 'spec/support')
+VAGRANT_BIN = ENV['VAGRANT_BIN'] || "vagrant"
+
+at_exit do
+  if ENV['KEEP_RUNNING']
+    VagrantHelpers.run_vagrant_command("rm -rf /home/vagrant/var")
+  end
 end
 
-puts vagrant_root.inspect
-
 require_relative '../../spec/support/test_app'

data/features/support/remote_command_helpers.rb

@@ -1,5 +1,4 @@
 module RemoteCommandHelpers
-
   def test_dir_exists(path)
     exists?('d', path)
   end
@@ -13,11 +12,11 @@ module RemoteCommandHelpers
   end
 
   def exists?(type, path)
-    %{[ -#{type} "#{path}" ] && echo "#{path} exists." || echo "Error: #{path} does not exist."}
+    %{[ -#{type} "#{path}" ]}
   end
 
   def safely_remove_file(path)
-    run_vagrant_command("rm #{test_file}") rescue Vagrant::Errors::VagrantError
+    run_vagrant_command("rm #{test_file}") rescue VagrantHelpers::VagrantSSHCommandError
   end
 end
 

data/features/support/vagrant_helpers.rb

@@ -0,0 +1,35 @@
+module VagrantHelpers
+  extend self
+
+  class VagrantSSHCommandError < RuntimeError; end
+
+  at_exit do
+    if ENV['KEEP_RUNNING']
+      puts "Vagrant vm will be left up because KEEP_RUNNING is set."
+      puts "Rerun without KEEP_RUNNING set to cleanup the vm."
+    else
+      vagrant_cli_command("destroy -f")
+    end
+  end
+
+  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
+    end
+    $?
+  end
+
+  def run_vagrant_command(command)
+    if (status = vagrant_cli_command("ssh -c #{command.inspect}")).success?
+      true
+    else
+      fail VagrantSSHCommandError, status
+    end
+  end
+
+end
+
+World(VagrantHelpers)

data/lib/capistrano/all.rb

@@ -1,6 +1,7 @@
 require 'rake'
 require 'sshkit'
-require 'sshkit/dsl'
+
+require 'io/console'
 
 Rake.application.options.trace = true
 

data/lib/capistrano/application.rb

@@ -16,10 +16,43 @@ module Capistrano
     end
 
     def sort_options(options)
-      options.push(version, roles, dry_run, hostfilter)
-      super
+      not_applicable_to_capistrano = %w(quiet silent verbose)
+      options.reject! do |(switch, *)|
+        switch =~ /--#{Regexp.union(not_applicable_to_capistrano)}/
+      end
+
+      super.push(version, dry_run, roles, hostfilter)
+    end
+
+    def handle_options
+      options.rakelib = ['rakelib']
+      options.trace_output = $stderr
+
+      OptionParser.new do |opts|
+        opts.banner = "See full documentation at http://capistranorb.com/."
+        opts.separator ""
+        opts.separator "Install capistrano in a project:"
+        opts.separator "    bundle exec cap install [STAGES=qa,staging,production,...]"
+        opts.separator ""
+        opts.separator "Show available tasks:"
+        opts.separator "    bundle exec cap -T"
+        opts.separator ""
+        opts.separator "Invoke (or simulate invoking) a task:"
+        opts.separator "    bundle exec cap [--dry-run] STAGE TASK"
+        opts.separator ""
+        opts.separator "Advanced options:"
+
+        opts.on_tail("-h", "--help", "-H", "Display this help message.") do
+          puts opts
+          exit
+        end
+
+        standard_rake_options.each { |args| opts.on(*args) }
+        opts.environment('RAKEOPT')
+      end.parse!
     end
 
+
     def top_level_tasks
       if tasks_without_stage_dependency.include?(@top_level_tasks.first)
         @top_level_tasks
@@ -28,6 +61,18 @@ module Capistrano
       end
     end
 
+    def display_error_message(ex)
+      unless options.backtrace
+        if loc = Rake.application.find_rakefile_location
+          whitelist = (@imported.dup << loc[0]).map{|f| File.absolute_path(f, loc[1])}
+          pattern = %r@^(?!#{whitelist.map{|p| Regexp.quote(p)}.join('|')})@
+          Rake.application.options.suppress_backtrace_pattern = pattern
+        end
+        trace "(Backtrace restricted to imported tasks)"
+      end
+      super
+    end
+
     def exit_because_of_exception(ex)
       if respond_to?(:deploying?) && deploying?
         exit_deploy_because_of_exception(ex)
@@ -42,7 +87,7 @@ module Capistrano
       if options.show_tasks
         invoke 'load:defaults'
         set(:stage, '')
-        Dir[deploy_config_path, stage_definitions].each { |f| add_import f }
+        Dir[deploy_config_path].each { |f| add_import f }
       end
 
       super
@@ -74,18 +119,18 @@ module Capistrano
 
     def roles
       ['--roles ROLES', '-r',
-       "Filter command to only apply to these roles (separate multiple roles with a comma)",
+       "Run SSH commands only on hosts matching these roles",
        lambda { |value|
-         Configuration.env.set(:filter, roles: value.split(","))
+         Configuration.env.add_cmdline_filter(:role, value)
        }
       ]
     end
 
     def hostfilter
       ['--hosts HOSTS', '-z',
-       "Filter command to only apply to these hosts (separate multiple hosts with a comma)",
+       "Run SSH commands only on matching hosts",
        lambda { |value|
-         Configuration.env.set(:filter, hosts: value.split(","))
+         Configuration.env.add_cmdline_filter(:host, value)
        }
       ]
     end

data/lib/capistrano/configuration.rb

@@ -1,22 +1,25 @@
+require_relative 'configuration/filter'
 require_relative 'configuration/question'
-require_relative 'configuration/servers'
 require_relative 'configuration/server'
+require_relative 'configuration/servers'
 
 module Capistrano
   class Configuration
 
-    class << self
-      def env
-        @env ||= new
-      end
+    def initialize(config = nil)
+      @config ||= config
+    end
 
-      def reset!
-        @env = new
-      end
+    def self.env
+      @env ||= new
     end
 
-    def ask(key, default=nil)
-      question = Question.new(self, key, default)
+    def self.reset!
+      @env = new
+    end
+
+    def ask(key, default=nil, options={})
+      question = Question.new(key, default, options)
       set(key, question)
     end
 
@@ -24,6 +27,10 @@ module Capistrano
       config[key] = value
     end
 
+    def set_if_empty(key, value)
+      config[key] = value unless config.has_key? key
+    end
+
     def delete(key)
       config.delete(key)
     end
@@ -84,8 +91,30 @@ module Capistrano
       @timestamp ||= Time.now.utc
     end
 
+    def setup_filters
+      @filters = cmdline_filters.clone
+      @filters << Filter.new(:role, ENV['ROLES']) if ENV['ROLES']
+      @filters << Filter.new(:host, ENV['HOSTS']) if ENV['HOSTS']
+      fh = fetch_for(:filter,{})
+      @filters << Filter.new(:host, fh[:host]) if fh[:host]
+      @filters << Filter.new(:role, fh[:role]) if fh[:role]
+    end
+
+    def add_cmdline_filter(type, values)
+      cmdline_filters << Filter.new(type, values)
+    end
+
+    def filter list
+      setup_filters if @filters.nil?
+      @filters.reduce(list) { |l,f| f.filter l }
+    end
+
     private
 
+    def cmdline_filters
+      @cmdline_filters ||= []
+    end
+
     def servers
       @servers ||= Servers.new
     end

data/lib/capistrano/configuration/filter.rb

@@ -0,0 +1,56 @@
+require 'capistrano/configuration'
+
+module Capistrano
+  class Configuration
+    class Filter
+      def initialize type, values = nil
+        raise "Invalid filter type #{type}" unless [:host,:role].include? type
+        av = Array(values)
+        @mode = case
+                when av.size == 0 then :none
+                when av.include?(:all) then :all
+                else type
+                end
+        @rex = case @mode
+          when :host
+            av.map!{|v| (v.is_a?(String) && v =~ /^(?<name>[-A-Za-z0-9.]+)(,\g<name>)*$/) ? v.split(',') : v }
+            av.flatten!
+            av.map! do |v|
+              case v
+              when Regexp then v
+              else
+                vs = v.to_s
+                vs =~ /^[-A-Za-z0-9.]+$/ ? vs : Regexp.new(vs)
+              end
+            end
+            Regexp.union av
+          when :role
+            av.map!{|v| v.is_a?(String) ? v.split(',') : v }
+            av.flatten!
+            av.map! do |v|
+              case v
+              when Regexp then v
+              else
+                vs = v.to_s
+                vs =~ %r{^/(.+)/$} ? Regexp.new($1) : vs
+              end
+            end
+            Regexp.union av
+          else
+            nil
+          end
+      end
+      def filter servers
+        as = Array(servers)
+        case @mode
+        when :none then return []
+        when :all  then return servers
+        when :host
+          as.select {|s| @rex.match s.hostname}
+        when :role
+          as.select {|s| s.roles.any? {|r| @rex.match r} }
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/configuration/question.rb

@@ -2,27 +2,23 @@ module Capistrano
   class Configuration
     class Question
 
-      def initialize(env, key, default)
-        @env, @key, @default = env, key, default
+      def initialize(key, default, options = {})
+        @key, @default, @options = key, default, options
       end
 
       def call
         ask_question
-        save_response
+        value_or_default
       end
 
       private
-      attr_reader :env, :key, :default
+      attr_reader :key, :default, :options
 
       def ask_question
         $stdout.print question
       end
 
-      def save_response
-        env.set(key, value)
-      end
-
-      def value
+      def value_or_default
         if response.empty?
           default
         else
@@ -31,12 +27,28 @@ module Capistrano
       end
 
       def response
-        @response ||= $stdin.gets.chomp
+        return @response if defined? @response
+        
+        @response = (gets || "").chomp
       end
-
+      
+      def gets
+        if echo?
+          $stdin.gets
+        else
+          $stdin.noecho(&:gets).tap{ $stdout.print "\n" }
+        end
+      rescue Errno::EIO
+        # when stdio gets closed
+      end
+        
       def question
         I18n.t(:question, key: key, default_value: default, scope: :capistrano)
       end
+
+      def echo?
+        (options || {}).fetch(:echo, true)
+      end
     end
   end
 end

data/lib/capistrano/configuration/server.rb

@@ -11,11 +11,13 @@ module Capistrano
 
       def add_roles(roles)
         Array(roles).each { |role| add_role(role) }
+        self
       end
       alias roles= add_roles
 
       def add_role(role)
         roles.add role.to_sym
+        self
       end
 
       def has_role?(role)
@@ -40,11 +42,9 @@ module Capistrano
         @properties ||= Properties.new
       end
 
-      def netssh_options_with_options
-        @netssh_options ||= netssh_options_without_options.merge( fetch(:ssh_options) || {} )
+      def netssh_options
+        @netssh_options ||= super.merge( fetch(:ssh_options) || {} )
       end
-      alias_method :netssh_options_without_options, :netssh_options
-      alias_method :netssh_options, :netssh_options_with_options
 
       def roles_array
         roles.to_a
@@ -71,7 +71,16 @@ module Capistrano
         end
 
         def set(key, value)
-          @properties[key] = value
+          pval = @properties[key]
+          if pval.is_a? Hash and value.is_a? Hash
+            pval.merge!(value)
+          elsif pval.is_a? Set and value.is_a? Set
+            pval.merge(value)
+          elsif pval.is_a? Array and value.is_a? Array
+            pval.concat value
+          else
+            @properties[key] = value
+          end
         end
 
         def fetch(key)