Class: Capistrano::Actor

Inherits:
Object
  • Object
show all
Defined in:
lib/capistrano/actor.rb

Overview

An Actor is the entity that actually does the work of determining which servers should be the target of a particular task, and of executing the task on each of them in parallel. An Actor is never instantiated directly–rather, you create a new Configuration instance, and access the new actor via Configuration#actor.

Defined Under Namespace

Classes: DefaultConnectionFactory, Task, TaskCallFrame

Class Attribute Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ Actor

:nodoc:



108
109
110
111
112
113
114
 
# File 'lib/capistrano/actor.rb', line 108

def initialize(config) #:nodoc:
  @configuration = config
  @tasks = {}
  @task_call_frames = []
  @sessions = {}
  @factory = self.class.connection_factory.new(configuration)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(sym, *args, &block) ⇒ Object (private) 



429
430
431
432
433
434
435
 
# File 'lib/capistrano/actor.rb', line 429

def method_missing(sym, *args, &block)
  if @configuration.respond_to?(sym)
    @configuration.send(sym, *args, &block)
  else
    super
  end
end

Class Attribute Details

.command_factory ⇒ Object

Returns the value of attribute command_factory.



31
32
33
 
# File 'lib/capistrano/actor.rb', line 31

def command_factory
  @command_factory
end

.connection_factory ⇒ Object

Returns the value of attribute connection_factory.



30
31
32
 
# File 'lib/capistrano/actor.rb', line 30

def connection_factory
  @connection_factory
end

.default_io_proc ⇒ Object

Returns the value of attribute default_io_proc.



33
34
35
 
# File 'lib/capistrano/actor.rb', line 33

def default_io_proc
  @default_io_proc
end

.transfer_factory ⇒ Object

Returns the value of attribute transfer_factory.



32
33
34
 
# File 'lib/capistrano/actor.rb', line 32

def transfer_factory
  @transfer_factory
end

Instance Attribute Details

#configuration ⇒ Object (readonly)

The configuration instance associated with this actor.



46
47
48
 
# File 'lib/capistrano/actor.rb', line 46

def configuration
  @configuration
end

#sessions ⇒ Object (readonly)

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.



56
57
58
 
# File 'lib/capistrano/actor.rb', line 56

def sessions
  @sessions
end

#task_call_frames ⇒ Object (readonly)

The call stack of the tasks. The currently executing task may inspect this to see who its caller was. The current task is always the last element of this stack.



61
62
63
 
# File 'lib/capistrano/actor.rb', line 61

def task_call_frames
  @task_call_frames
end

#task_call_history ⇒ Object (readonly)

The history of executed tasks. This will be an array of all tasks that have been executed, in the order in which they were called.



65
66
67
 
# File 'lib/capistrano/actor.rb', line 65

def task_call_history
  @task_call_history
end

#tasks ⇒ Object (readonly)

A hash of the tasks known to this actor, keyed by name. The values are instances of Actor::Task.



50
51
52
 
# File 'lib/capistrano/actor.rb', line 50

def tasks
  @tasks
end

Instance Method Details

#connect!(options = {}) ⇒ Object

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.



365
366
367
 
# File 'lib/capistrano/actor.rb', line 365

def connect!(options={})
  execute_on_servers(options) { }
end

#current_release ⇒ Object

Returns the most recent deployed release



309
310
311
 
# File 'lib/capistrano/actor.rb', line 309

def current_release
  release_path(releases.last)
end

#current_task ⇒ Object 



369
370
371
372
 
# File 'lib/capistrano/actor.rb', line 369

def current_task
  return nil if task_call_frames.empty?
  tasks[task_call_frames.last.name]
end

#default_io_proc ⇒ Object

An instance-level reader for the class’ #default_io_proc attribute.



357
358
359
 
# File 'lib/capistrano/actor.rb', line 357

def default_io_proc
  self.class.default_io_proc
end

#define_task(name, options = {}, &block) ⇒ Object

Define a new task for this actor. The block will be invoked when this task is called.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/capistrano/actor.rb', line 118

def define_task(name, options={}, &block)
  @tasks[name] = (options[:task_class] || Task).new(name, self, options)
  define_method(name) do
    send "before_#{name}" if respond_to? "before_#{name}"
    logger.debug "executing task #{name}"
    begin
      push_task_call_frame name
      result = instance_eval(&block)
    ensure
      pop_task_call_frame
    end
    send "after_#{name}" if respond_to? "after_#{name}"
    result
  end
end

#delete(path, options = {}) ⇒ Object

Deletes the given file from all servers targetted by the current task. If :recursive => true is specified, it may be used to remove directories.



183
184
185
186
 
# File 'lib/capistrano/actor.rb', line 183

def delete(path, options={})
  cmd = "rm -%sf #{path}" % (options[:recursive] ? "r" : "")
  run(cmd, options)
end

#dump_tasks ⇒ Object

Dump all tasks and (brief) descriptions in YAML format for consumption by other processes. Returns a string containing the YAML-formatted data.



151
152
153
154
155
156
157
158
159
 
# File 'lib/capistrano/actor.rb', line 151

def dump_tasks
  data = ""
  each_task do |info|
    desc = info[:desc].split(/\. /).first || ""
    desc << "." if !desc.empty? && desc[-1] != ?.
    data << "#{info[:task]}: #{desc}\n"
  end
  data
end

#each_task ⇒ Object

Iterates over each task, in alphabetical order. A hash object is yielded for each task, which includes the task’s name (:name), the length of the longest task name (:longest), and the task’s description, reformatted as a single line (:desc).



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/capistrano/actor.rb', line 138

def each_task
  keys = tasks.keys.sort_by { |a| a.to_s }
  longest = keys.inject(0) { |len,key| key.to_s.length > len ? key.to_s.length : len } + 2

  keys.sort_by { |a| a.to_s }.each do |key|
    desc = (tasks[key].options[:desc] || "").gsub(/(?:\r?\n)+[ \t]*/, " ").strip
    info = { :task => key, :longest => longest, :desc => desc }
    yield info
  end
end

#metaclass ⇒ Object 



374
375
376
 
# File 'lib/capistrano/actor.rb', line 374

def metaclass
  class << self; self; end
end

#on_rollback(&block) ⇒ Object

Specifies an on_rollback hook for the currently executing task. If this or any subsequent task then fails, and a transaction is active, this hook will be executed.



352
353
354
 
# File 'lib/capistrano/actor.rb', line 352

def on_rollback(&block)
  task_call_frames.last.rollback = block
end

#previous_release ⇒ Object

Returns the release immediately before the currently deployed one



314
315
316
 
# File 'lib/capistrano/actor.rb', line 314

def previous_release
  release_path(releases[-2])
end

#put(data, path, options = {}) ⇒ Object

Store the given data at the given location on all servers targetted by the current task. If :mode is specified it is used to set the mode on the file.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/capistrano/actor.rb', line 191

def put(data, path, options={})
  if Capistrano::SFTP
    execute_on_servers(options) do |servers|
      transfer = self.class.transfer_factory.new(servers, self, path, :data => data,
        :mode => options[:mode])
      transfer.process!
    end
  else
    # Poor-man's SFTP... just run a cat on the remote end, and send data
    # to it.

    cmd = "cat > #{path}"
    cmd << " && chmod #{options[:mode].to_s(8)} #{path}" if options[:mode]
    run(cmd, options.merge(:data => data + "\n\4")) do |ch, stream, out|
      logger.important out, "#{stream} :: #{ch[:host]}" if stream == :err
    end
  end
end

#releases ⇒ Object

Inspects the remote servers to determine the list of all released versions of the software. Releases are sorted with the most recent release last.



295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/capistrano/actor.rb', line 295

def releases
  unless @releases
    buffer = ""
    run "ls -x1 #{releases_path}", :once => true do |ch, str, out|
      buffer << out if str == :out
      raise "could not determine releases #{out.inspect}" if str == :err
    end
    @releases = buffer.split.sort
  end

  @releases
end

#render(*args) ⇒ Object

Renders an ERb template and returns the result. This is useful for dynamically building documents to store on the remote servers.

Usage:

render("something", :foo => "hello")
  look for "something.rhtml" in the current directory, or in the
  capistrano/recipes/templates directory, and render it with
  foo defined as a local variable with the value "hello".

render(:file => "something", :foo => "hello")
  same as above

render(:template => "<%= foo %> world", :foo => "hello")
  treat the given string as an ERb template and render it with
  the given hash of local variables active.

Raises:

  • (ArgumentError) 


255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/capistrano/actor.rb', line 255

def render(*args)
  options = args.last.is_a?(Hash) ? args.pop : {}
  options[:file] = args.shift if args.first.is_a?(String)
  raise ArgumentError, "too many parameters" unless args.empty?

  case
    when options[:file]
      file = options.delete :file
      unless file[0] == ?/
        dirs = [".",
          File.join(File.dirname(__FILE__), "recipes", "templates")]
        dirs.each do |dir|
          if File.file?(File.join(dir, file))
            file = File.join(dir, file)
            break
          elsif File.file?(File.join(dir, file + ".rhtml"))
            file = File.join(dir, file + ".rhtml")
            break
          end
        end
      end

      render options.merge(:template => File.read(file))

    when options[:template]
      erb = ERB.new(options[:template])
      b = Proc.new { binding }.call
      options.each do |key, value|
        next if key == :template
        eval "#{key} = options[:#{key}]", b
      end
      erb.result(b)

    else
      raise ArgumentError, "no file or template given for rendering"
  end
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.

If pretend mode is active, this does nothing.



169
170
171
172
173
174
175
176
177
178
 
# File 'lib/capistrano/actor.rb', line 169

def run(cmd, options={}, &block)
  block ||= default_io_proc
  logger.debug "executing #{cmd.strip.inspect}"

  execute_on_servers(options) do |servers|
    # execute the command on each server in parallel
    command = self.class.command_factory.new(servers, cmd, block, options, self)
    command.process! # raises an exception if command fails on any server
  end
end

#sudo(command, options = {}, &block) ⇒ Object

Like #run, but executes the command via sudo. This assumes that the sudo password (if required) is the same as the password for logging in to the server.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/capistrano/actor.rb', line 213

def sudo(command, options={}, &block)
  block ||= default_io_proc

  # 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
  
  run "sudo #{command}", options do |ch, stream, out|
    if out =~ /^Password:/
      ch.send_data "#{password}\n"
    elsif out =~ /try again/
      if prompt_host.nil? || prompt_host == ch[:host]
        prompt_host = ch[:host]
        logger.important out, "#{stream} :: #{ch[:host]}"
        # reset the password to it's original value and prepare for another
        # pass (the reset allows the password prompt to be attempted again
        # if the password variable was originally a proc (the default)
        set :password, self[:original_value][:password] || self[:password]
      end
    else
      block.call(ch, stream, out)
    end
  end
end

#transaction ⇒ Object

Invoke a set of tasks in a transaction. If any task fails (raises an exception), all tasks executed within the transaction are inspected to see if they have an associated on_rollback hook, and if so, that hook is called.



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/capistrano/actor.rb', line 322

def transaction
  if task_call_history
    yield
  else
    logger.info "transaction: start"
    begin
      @task_call_history = []
      yield
      logger.info "transaction: commit"
    rescue Object => e
      current = task_call_history.last
      logger.important "transaction: rollback", current ? current.name : "transaction start"
      task_call_history.reverse.each do |task|
        begin
          logger.debug "rolling back", task.name
          task.rollback.call if task.rollback
        rescue Object => e
          logger.info "exception while rolling back: #{e.class}, #{e.message}", task.name
        end
      end
      raise
    ensure
      @task_call_history = nil
    end
  end
end