Module: Capistrano::Configuration::Actions::Invocation

Included in:
Capistrano::Configuration
Defined in:
lib/capistrano/configuration/actions/invocation.rb

Defined Under Namespace

Modules: ClassMethods

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object

:nodoc:



7
8
9
10
11
12
13
14
15
16
17
 
# File 'lib/capistrano/configuration/actions/invocation.rb', line 7

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

Instance Method Details

#add_default_command_options(options) ⇒ Object

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.



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/capistrano/configuration/actions/invocation.rb', line 252

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

#continue_execution(tree) ⇒ Object 



271
272
273
274
275
276
277
278
 
# File 'lib/capistrano/configuration/actions/invocation.rb', line 271

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

#continue_execution_for_branch(branch) ⇒ Object 



280
281
282
283
284
285
286
287
288
289
 
# File 'lib/capistrano/configuration/actions/invocation.rb', line 280

def continue_execution_for_branch(branch)
  case Capistrano::CLI.debug_prompt(branch)
    when "y"
      true
    when "n"
      false
    when "a"
      exit(-1)
  end
end

#initialize_with_invocation(*args) ⇒ Object

:nodoc:



23
24
25
26
27
 
# File 'lib/capistrano/configuration/actions/invocation.rb', line 23

def initialize_with_invocation(*args) #:nodoc:
  initialize_without_invocation(*args)
  set :default_environment, {}
  set :default_run_options, {}
end

#invoke_command(cmd, options = {}, &block) ⇒ Object

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.



86
87
88
89
90
 
# File 'lib/capistrano/configuration/actions/invocation.rb', line 86

def invoke_command(cmd, options={}, &block)
  options = options.dup
  via = options.delete(:via) || :run
  send(via, cmd, options, &block)
end

#parallel(options = {}) ⇒ Object

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.

Raises:

  • (ArgumentError) 


76
77
78
79
80
 
# File 'lib/capistrano/configuration/actions/invocation.rb', line 76

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

#run(cmd, options = {}, &block) ⇒ Object

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 (:err for stderr, and :out 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.



140
141
142
143
144
 
# File 'lib/capistrano/configuration/actions/invocation.rb', line 140

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

#run_tree(tree, options = {}) ⇒ Object

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.



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/capistrano/configuration/actions/invocation.rb', line 149

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

#sudo(*parameters, &block) ⇒ Object

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 :sudo 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 :sudo_prompt, 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.



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/capistrano/configuration/actions/invocation.rb', line 199

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

#sudo_behavior_callback(fallback) ⇒ Object

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.



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/capistrano/configuration/actions/invocation.rb', line 219

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

#sudo_prompt ⇒ Object

Returns the prompt text to use with sudo



267
268
269
 
# File 'lib/capistrano/configuration/actions/invocation.rb', line 267

def sudo_prompt
  fetch(:sudo_prompt, "sudo password: ")
end