mbailey-capistrano 2.5.5

data/lib/capistrano/configuration/actions/invocation.rb

@@ -0,0 +1,293 @@
+require 'capistrano/command'
+
+module Capistrano
+  class Configuration
+    module Actions
+      module Invocation
+        def self.included(base) #:nodoc:
+          base.extend(ClassMethods)
+
+          base.send :alias_method, :initialize_without_invocation, :initialize
+          base.send :alias_method, :initialize, :initialize_with_invocation
+
+          base.default_io_proc = Proc.new do |ch, stream, out|
+            level = stream == :err ? :important : :info
+            ch[:options][:logger].send(level, out, "#{stream} :: #{ch[:server]}")
+          end
+        end
+
+        module ClassMethods
+          attr_accessor :default_io_proc
+        end
+
+        def initialize_with_invocation(*args) #:nodoc:
+          initialize_without_invocation(*args)
+          set :default_environment, {}
+          set :default_run_options, {}
+        end
+
+        # Executes different commands in parallel. This is useful for commands
+        # that need to be different on different hosts, but which could be
+        # otherwise run in parallel.
+        #
+        # The +options+ parameter is currently unused.
+        #
+        # Example:
+        #
+        #   task :restart_everything do
+        #     parallel do |session|
+        #       session.when "in?(:app)", "/path/to/restart/mongrel"
+        #       session.when "in?(:web)", "/path/to/restart/apache"
+        #       session.when "in?(:db)", "/path/to/restart/mysql"
+        #     end
+        #   end
+        #
+        # Each command may have its own callback block, for capturing and
+        # responding to output, with semantics identical to #run:
+        #
+        #   session.when "in?(:app)", "/path/to/restart/mongrel" do |ch, stream, data|
+        #     # ch is the SSH channel for this command, used to send data
+        #     #    back to the command (e.g. ch.send_data("password\n"))
+        #     # stream is either :out or :err, for which stream the data arrived on
+        #     # data is a string containing data sent from the remote command
+        #   end
+        #
+        # Also, you can specify a fallback command, to use when none of the
+        # conditions match a server:
+        #
+        #   session.else "/execute/something/else"
+        #
+        # The string specified as the first argument to +when+ may be any valid
+        # Ruby code. It has access to the following variables and methods:
+        # 
+        # * +in?(role)+ returns true if the server participates in the given role
+        # * +server+ is the ServerDefinition object for the server. This can be
+        #   used to get the host-name, etc.
+        # * +configuration+ is the current Capistrano::Configuration object, which
+        #   you can use to get the value of variables, etc.
+        #
+        # For example:
+        #
+        #   session.when "server.host =~ /app/", "/some/command"
+        #   session.when "server.host == configuration[:some_var]", "/another/command"
+        #   session.when "in?(:web) || in?(:app)", "/more/commands"
+        #
+        # See #run for a description of the valid +options+.
+        def parallel(options={})
+          raise ArgumentError, "parallel() requires a block" unless block_given?
+          tree = Command::Tree.new(self) { |t| yield t }
+          run_tree(tree, options)
+        end
+
+        # Invokes the given command. If a +via+ key is given, it will be used
+        # to determine what method to use to invoke the command. It defaults
+        # to :run, but may be :sudo, or any other method that conforms to the
+        # same interface as run and sudo.
+        def invoke_command(cmd, options={}, &block)
+          options = options.dup
+          via = options.delete(:via) || :run
+          send(via, cmd, options, &block)
+        end
+
+        # Execute the given command on all servers that are the target of the
+        # current task. If a block is given, it is invoked for all output
+        # generated by the command, and should accept three parameters: the SSH
+        # channel (which may be used to send data back to the remote process),
+        # the stream identifier (<tt>:err</tt> for stderr, and <tt>:out</tt> for
+        # stdout), and the data that was received.
+        #
+        # The +options+ hash may include any of the following keys:
+        #
+        # * :hosts - this is either a string (for a single target host) or an array
+        #   of strings, indicating which hosts the command should run on. By default,
+        #   the hosts are determined from the task definition.
+        # * :roles - this is either a string or symbol (for a single target role) or
+        #   an array of strings or symbols, indicating which roles the command should
+        #   run on. If :hosts is specified, :roles will be ignored.
+        # * :only - specifies a condition limiting which hosts will be selected to
+        #   run the command. This should refer to values set in the role definition.
+        #   For example, if a role is defined with :primary => true, then you could
+        #   select only hosts with :primary true by setting :only => { :primary => true }.
+        # * :except - specifies a condition limiting which hosts will be selected to
+        #   run the command. This is the inverse of :only (hosts that do _not_ match
+        #   the condition will be selected).
+        # * :once - if true, only the first matching server will be selected. The default
+        #   is false (all matching servers will be selected).
+        # * :max_hosts - specifies the maximum number of hosts that should be selected
+        #   at a time. If this value is less than the number of hosts that are selected
+        #   to run, then the hosts will be run in groups of max_hosts. The default is nil,
+        #   which indicates that there is no maximum host limit.
+        # * :shell - says which shell should be used to invoke commands. This
+        #   defaults to "sh". Setting this to false causes Capistrano to invoke
+        #   the commands directly, without wrapping them in a shell invocation.
+        # * :data - if not nil (the default), this should be a string that will
+        #   be passed to the command's stdin stream.
+        # * :pty - if true, a pseudo-tty will be allocated for each command. The
+        #   default is false. Note that there are benefits and drawbacks both ways.
+        #   Empirically, it appears that if a pty is allocated, the SSH server daemon
+        #   will _not_ read user shell start-up scripts (e.g. bashrc, etc.). However,
+        #   if a pty is _not_ allocated, some commands will refuse to run in
+        #   interactive mode and will not prompt for (e.g.) passwords.
+        # * :env - a hash of environment variable mappings that should be made
+        #   available to the command. The keys should be environment variable names,
+        #   and the values should be their corresponding values. The default is
+        #   empty, but may be modified by changing the +default_environment+
+        #   Capistrano variable.
+        #
+        # Note that if you set these keys in the +default_run_options+ Capistrano
+        # variable, they will apply for all invocations of #run, #invoke_command,
+        # and #parallel.
+        def run(cmd, options={}, &block)
+          block ||= self.class.default_io_proc
+          tree = Command::Tree.new(self) { |t| t.else(cmd, &block) }
+          run_tree(tree, options)
+        end
+
+        # Executes a Capistrano::Command::Tree object. This is not for direct
+        # use, but should instead be called indirectly, via #run or #parallel,
+        # or #invoke_command.
+        def run_tree(tree, options={}) #:nodoc:
+          if tree.branches.empty? && tree.fallback
+            logger.debug "executing #{tree.fallback}"
+          elsif tree.branches.any?
+            logger.debug "executing multiple commands in parallel"
+            tree.each do |branch|
+              logger.trace "-> #{branch}"
+            end
+          else
+            raise ArgumentError, "attempt to execute without specifying a command"
+          end
+
+          return if dry_run || (debug && continue_execution(tree) == false)
+
+          options = add_default_command_options(options)
+
+          tree.each do |branch|
+            if branch.command.include?(sudo)
+              branch.callback = sudo_behavior_callback(branch.callback)
+            end
+          end
+
+          execute_on_servers(options) do |servers|
+            targets = servers.map { |s| sessions[s] }
+            Command.process(tree, targets, options.merge(:logger => logger))
+          end
+        end
+
+        # Returns the command string used by capistrano to invoke a comamnd via
+        # sudo.
+        #
+        #   run "#{sudo :as => 'bob'} mkdir /path/to/dir"
+        #
+        # It can also be invoked like #run, but executing the command via sudo.
+        # This assumes that the sudo password (if required) is the same as the
+        # password for logging in to the server.
+        #
+        #   sudo "mkdir /path/to/dir"
+        #
+        # Also, this method understands a <tt>:sudo</tt> configuration variable,
+        # which (if specified) will be used as the full path to the sudo
+        # executable on the remote machine:
+        #
+        #   set :sudo, "/opt/local/bin/sudo"
+        #
+        # If you know what you're doing, you can also set <tt>:sudo_prompt</tt>,
+        # which tells capistrano which prompt sudo should use when asking for
+        # a password. (This is so that capistrano knows what prompt to look for
+        # in the output.) If you set :sudo_prompt to an empty string, Capistrano
+        # will not send a preferred prompt.
+        def sudo(*parameters, &block)
+          options = parameters.last.is_a?(Hash) ? parameters.pop.dup : {}
+          command = parameters.first
+          user = options[:as] && "-u #{options.delete(:as)}"
+
+          sudo_prompt_option = "-p '#{sudo_prompt}'" unless sudo_prompt.empty?
+          sudo_command = [fetch(:sudo, "sudo"), sudo_prompt_option, user].compact.join(" ")
+
+          if command
+            command = sudo_command + " " + command
+            run(command, options, &block)
+          else
+            return sudo_command
+          end
+        end
+
+        # Returns a Proc object that defines the behavior of the sudo
+        # callback. The returned Proc will defer to the +fallback+ argument
+        # (which should also be a Proc) for any output it does not
+        # explicitly handle.
+        def sudo_behavior_callback(fallback) #:nodoc:
+          # in order to prevent _each host_ from prompting when the password
+          # was wrong, let's track which host prompted first and only allow
+          # subsequent prompts from that host.
+          prompt_host = nil
+
+          Proc.new do |ch, stream, out|
+            if out =~ /^Sorry, try again/
+              if prompt_host.nil? || prompt_host == ch[:server]
+                prompt_host = ch[:server]
+                logger.important out, "#{stream} :: #{ch[:server]}"
+                reset! :password
+              end
+            end
+
+            if out =~ /^#{Regexp.escape(sudo_prompt)}/
+              ch.send_data "#{self[:password]}\n"
+            elsif fallback
+              fallback.call(ch, stream, out)
+            end
+          end
+        end
+
+        # Merges the various default command options into the options hash and
+        # returns the result. The default command options that are understand
+        # are:
+        #
+        # * :default_environment: If the :env key already exists, the :env
+        #   key is merged into default_environment and then added back into
+        #   options.
+        # * :default_shell: if the :shell key already exists, it will be used.
+        #   Otherwise, if the :default_shell key exists in the configuration,
+        #   it will be used. Otherwise, no :shell key is added.
+        def add_default_command_options(options)
+          defaults = self[:default_run_options]
+          options = defaults.merge(options)
+
+          env = self[:default_environment]
+          env = env.merge(options[:env]) if options[:env]
+          options[:env] = env unless env.empty?
+
+          shell = options[:shell] || self[:default_shell]
+          options[:shell] = shell unless shell.nil?
+
+          options
+        end
+
+        # Returns the prompt text to use with sudo
+        def sudo_prompt
+          fetch(:sudo_prompt, "sudo password: ")
+        end
+        
+        def continue_execution(tree)
+          if tree.branches.length == 1
+            continue_execution_for_branch(tree.branches.first)
+          else
+            tree.each { |branch| branch.skip! unless continue_execution_for_branch(branch) }
+            tree.any? { |branch| !branch.skip? }
+          end
+        end
+
+        def continue_execution_for_branch(branch)
+          case Capistrano::CLI.debug_prompt(branch)
+            when "y"
+              true
+            when "n"
+              false
+            when "a"
+              exit(-1)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/configuration/callbacks.rb

@@ -0,0 +1,148 @@
+require 'capistrano/callback'
+
+module Capistrano
+  class Configuration
+    module Callbacks
+      def self.included(base) #:nodoc:
+        %w(initialize invoke_task_directly).each do |method|
+          base.send :alias_method, "#{method}_without_callbacks", method
+          base.send :alias_method, method, "#{method}_with_callbacks"
+        end
+      end
+
+      # The hash of callbacks that have been registered for this configuration
+      attr_reader :callbacks
+
+      def initialize_with_callbacks(*args) #:nodoc:
+        initialize_without_callbacks(*args)
+        @callbacks = {}
+      end
+
+      def invoke_task_directly_with_callbacks(task) #:nodoc:
+        before = find_hook(task, :before)
+        execute_task(before) if before
+
+        trigger :before, task
+
+        result = invoke_task_directly_without_callbacks(task)
+
+        trigger :after, task
+
+        after = find_hook(task, :after)
+        execute_task(after) if after
+
+        return result
+      end
+
+      # Defines a callback to be invoked before the given task. You must
+      # specify the fully-qualified task name, both for the primary task, and
+      # for the task(s) to be executed before. Alternatively, you can pass a
+      # block to be executed before the given task.
+      #
+      #   before "deploy:update_code", :record_difference
+      #   before :deploy, "custom:log_deploy"
+      #   before :deploy, :this, "then:this", "and:then:this"
+      #   before :some_task do
+      #     puts "an anonymous hook!"
+      #   end
+      #
+      # This just provides a convenient interface to the more general #on method.
+      def before(task_name, *args, &block)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        args << options.merge(:only => task_name)
+        on :before, *args, &block
+      end
+
+      # Defines a callback to be invoked after the given task. You must
+      # specify the fully-qualified task name, both for the primary task, and
+      # for the task(s) to be executed after. Alternatively, you can pass a
+      # block to be executed after the given task.
+      #
+      #   after "deploy:update_code", :log_difference
+      #   after :deploy, "custom:announce"
+      #   after :deploy, :this, "then:this", "and:then:this"
+      #   after :some_task do
+      #     puts "an anonymous hook!"
+      #   end
+      #
+      # This just provides a convenient interface to the more general #on method.
+      def after(task_name, *args, &block)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        args << options.merge(:only => task_name)
+        on :after, *args, &block
+      end
+
+      # Defines one or more callbacks to be invoked in response to some event.
+      # Capistrano currently understands the following events:
+      #
+      # * :before, triggered before a task is invoked
+      # * :after, triggered after a task is invoked
+      # * :start, triggered before a top-level task is invoked via the command-line
+      # * :finish, triggered when a top-level task completes
+      # * :load, triggered after all recipes have loaded
+      # * :exit, triggered after all tasks have completed
+      #
+      # Specify the (fully-qualified) task names that you want invoked in
+      # response to the event. Alternatively, you can specify a block to invoke
+      # when the event is triggered. You can also pass a hash of options as the
+      # last parameter, which may include either of two keys:
+      #
+      # * :only, should specify an array of task names. Restricts this callback
+      #   so that it will only fire when the event applies to those tasks.
+      # * :except, should specify an array of task names. Restricts this callback
+      #   so that it will never fire when the event applies to those tasks.
+      #
+      # Usage:
+      #
+      #  on :before, "some:hook", "another:hook", :only => "deploy:update"
+      #  on :after, "some:hook", :except => "deploy:symlink"
+      #  on :before, "global:hook"
+      #  on :after, :only => :deploy do
+      #    puts "after deploy here"
+      #  end
+      def on(event, *args, &block)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        callbacks[event] ||= []
+
+        if args.empty? && block.nil?
+          raise ArgumentError, "please specify either a task name or a block to invoke"
+        elsif args.any? && block
+          raise ArgumentError, "please specify only a task name or a block, but not both"
+        elsif block
+          callbacks[event] << ProcCallback.new(block, options)
+        else
+          args.each do |name|
+            callbacks[event] << TaskCallback.new(self, name, options)
+          end
+        end
+      end
+
+      # Trigger the named event for the named task. All associated callbacks
+      # will be fired, in the order they were defined.
+      def trigger(event, task=nil)
+        pending = Array(callbacks[event]).select { |c| c.applies_to?(task) }
+        if pending.any?
+          msg = "triggering #{event} callbacks"
+          msg << " for `#{task.fully_qualified_name}'" if task
+          logger.trace(msg)
+          pending.each { |callback| callback.call }
+        end
+      end
+
+      private
+
+        # Looks for before_foo or after_foo tasks. This method of extending tasks
+        # is now discouraged (though not formally deprecated). You should use the
+        # before and after methods to declare hooks for such callbacks.
+        def find_hook(task, hook)
+          if task == task.namespace.default_task
+            result = task.namespace.search_task("#{hook}_#{task.namespace.name}")
+            return result if result
+          end
+
+          task.namespace.search_task("#{hook}_#{task.name}")
+        end
+
+    end
+  end
+end

data/lib/capistrano/configuration/connections.rb

@@ -0,0 +1,200 @@
+require 'enumerator'
+require 'net/ssh/gateway'
+require 'capistrano/ssh'
+require 'capistrano/errors'
+
+module Capistrano
+  class Configuration
+    module Connections
+      def self.included(base) #:nodoc:
+        base.send :alias_method, :initialize_without_connections, :initialize
+        base.send :alias_method, :initialize, :initialize_with_connections
+      end
+
+      class DefaultConnectionFactory #:nodoc:
+        def initialize(options)
+          @options = options
+        end
+
+        def connect_to(server)
+          SSH.connect(server, @options)
+        end
+      end
+
+      class GatewayConnectionFactory #:nodoc:
+        def initialize(gateway, options)
+          @options = options
+          @options[:logger].debug "Creating gateway using #{[*gateway].join(', ')}" if @options[:logger]
+          Thread.abort_on_exception = true
+          @gateways = [*gateway].collect { |g| ServerDefinition.new(g) }
+          tunnel = SSH.connection_strategy(@gateways[0], @options) do |host, user, connect_options|
+            Net::SSH::Gateway.new(host, user, connect_options)
+          end
+          @gateway = (@gateways[1..-1]).inject(tunnel) do |tunnel, destination|
+            @options[:logger].debug "Creating tunnel to #{destination}" if @options[:logger]
+            local_host = ServerDefinition.new("127.0.0.1", :user => destination.user, :port => tunnel.open(destination.host, (destination.port || 22)))
+            SSH.connection_strategy(local_host, @options) do |host, user, connect_options|
+              Net::SSH::Gateway.new(host, user, connect_options)
+            end
+          end
+        end
+        
+        def connect_to(server)
+          @options[:logger].debug "establishing connection to `#{server}' via gateway" if @options[:logger]
+          local_host = ServerDefinition.new("127.0.0.1", :user => server.user, :port => @gateway.open(server.host, server.port || 22))
+          session = SSH.connect(local_host, @options)
+          session.xserver = server
+          session
+        end
+      end
+
+      # A hash of the SSH sessions that are currently open and available.
+      # Because sessions are constructed lazily, this will only contain
+      # connections to those servers that have been the targets of one or more
+      # executed tasks.
+      attr_reader :sessions
+
+      def initialize_with_connections(*args) #:nodoc:
+        initialize_without_connections(*args)
+        @sessions = {}
+        @failed_sessions = []
+      end
+
+      # Indicate that the given server could not be connected to.
+      def failed!(server)
+        @failed_sessions << server
+      end
+
+      # Query whether previous connection attempts to the given server have
+      # failed.
+      def has_failed?(server)
+        @failed_sessions.include?(server)
+      end
+
+      # Used to force connections to be made to the current task's servers.
+      # Connections are normally made lazily in Capistrano--you can use this
+      # to force them open before performing some operation that might be
+      # time-sensitive.
+      def connect!(options={})
+        execute_on_servers(options) { }
+      end
+
+      # Returns the object responsible for establishing new SSH connections.
+      # The factory will respond to #connect_to, which can be used to
+      # establish connections to servers defined via ServerDefinition objects.
+      def connection_factory
+        @connection_factory ||= begin
+          if exists?(:gateway)
+            logger.debug "establishing connection to gateway `#{fetch(:gateway)}'"
+            GatewayConnectionFactory.new(fetch(:gateway), self)
+          else
+            DefaultConnectionFactory.new(self)
+          end
+        end
+      end
+
+      # Ensures that there are active sessions for each server in the list.
+      def establish_connections_to(servers)
+        failed_servers = []
+
+        # force the connection factory to be instantiated synchronously,
+        # otherwise we wind up with multiple gateway instances, because
+        # each connection is done in parallel.
+        connection_factory
+
+        threads = Array(servers).map { |server| establish_connection_to(server, failed_servers) }
+        threads.each { |t| t.join }
+
+        if failed_servers.any?
+          errors = failed_servers.map { |h| "#{h[:server]} (#{h[:error].class}: #{h[:error].message})" }
+          error = ConnectionError.new("connection failed for: #{errors.join(', ')}")
+          error.hosts = failed_servers.map { |h| h[:server] }
+          raise error
+        end
+      end
+
+      # Destroys sessions for each server in the list.
+      def teardown_connections_to(servers)
+        servers.each do |server|
+           @sessions[server].close
+           @sessions.delete(server)
+         end
+      end
+
+      # Determines the set of servers within the current task's scope and
+      # establishes connections to them, and then yields that list of
+      # servers.
+      def execute_on_servers(options={})
+        raise ArgumentError, "expected a block" unless block_given?
+
+        if task = current_task
+          servers = find_servers_for_task(task, options)
+
+          if servers.empty?
+            if ENV['HOSTFILTER']
+              logger.info "skipping `#{task.fully_qualified_name}' because no servers matched"
+              return
+            else
+              raise Capistrano::NoMatchingServersError, "`#{task.fully_qualified_name}' is only run for servers matching #{task.options.inspect}, but no servers matched"
+            end
+          end
+
+          if task.continue_on_error?
+            servers.delete_if { |s| has_failed?(s) }
+            return if servers.empty?
+          end
+        else
+          servers = find_servers(options)
+          raise Capistrano::NoMatchingServersError, "no servers found to match #{options.inspect}" if servers.empty?
+        end
+
+        servers = [servers.first] if options[:once]
+        logger.trace "servers: #{servers.map { |s| s.host }.inspect}"
+
+        max_hosts = (options[:max_hosts] || (task && task.max_hosts) || servers.size).to_i
+        is_subset = max_hosts < servers.size
+
+        # establish connections to those servers in groups of max_hosts, as necessary
+        servers.each_slice(max_hosts) do |servers_slice|
+          begin
+            establish_connections_to(servers_slice)
+          rescue ConnectionError => error
+            raise error unless task && task.continue_on_error?
+            error.hosts.each do |h|
+              servers_slice.delete(h)
+              failed!(h)
+            end
+          end
+
+          begin
+            yield servers_slice
+          rescue RemoteError => error
+            raise error unless task && task.continue_on_error?
+            error.hosts.each { |h| failed!(h) }
+          end
+
+          # if dealing with a subset (e.g., :max_hosts is less than the
+          # number of servers available) teardown the subset of connections
+          # that were just made, so that we can make room for the next subset.
+          teardown_connections_to(servers_slice) if is_subset
+        end
+      end
+
+      private
+
+        # We establish the connection by creating a thread in a new method--this
+        # prevents problems with the thread's scope seeing the wrong 'server'
+        # variable if the thread just happens to take too long to start up.
+        def establish_connection_to(server, failures=nil)
+          Thread.new { safely_establish_connection_to(server, failures) }
+        end
+
+        def safely_establish_connection_to(server, failures=nil)
+          sessions[server] ||= connection_factory.connect_to(server)
+        rescue Exception => err
+          raise unless failures
+          failures << { :server => server, :error => err }
+        end
+    end
+  end
+end