Class: SwitchTower::Actor
- Inherits:
-
Object
- Object
- SwitchTower::Actor
- Defined in:
- lib/switchtower/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
-
.command_factory ⇒ Object
Returns the value of attribute command_factory.
-
.connection_factory ⇒ Object
Returns the value of attribute connection_factory.
-
.transfer_factory ⇒ Object
Returns the value of attribute transfer_factory.
Instance Attribute Summary collapse
-
#configuration ⇒ Object
readonly
The configuration instance associated with this actor.
-
#sessions ⇒ Object
readonly
A hash of the SSH sessions that are currently open and available.
-
#task_call_frames ⇒ Object
readonly
The call stack of the tasks.
-
#task_call_history ⇒ Object
readonly
The history of executed tasks.
-
#tasks ⇒ Object
readonly
A hash of the tasks known to this actor, keyed by name.
Instance Method Summary collapse
-
#current_release ⇒ Object
Returns the most recent deployed release.
-
#define_task(name, options = {}, &block) ⇒ Object
Define a new task for this actor.
-
#delete(path, options = {}) ⇒ Object
Deletes the given file from all servers targetted by the current task.
-
#initialize(config) ⇒ Actor
constructor
:nodoc:.
-
#on_rollback(&block) ⇒ Object
Specifies an on_rollback hook for the currently executing task.
-
#previous_release ⇒ Object
Returns the release immediately before the currently deployed one.
-
#put(data, path, options = {}) ⇒ Object
Store the given data at the given location on all servers targetted by the current task.
-
#releases ⇒ Object
Inspects the remote servers to determine the list of all released versions of the software.
-
#render(*args) ⇒ Object
Renders an ERb template and returns the result.
-
#run(cmd, options = {}, &block) ⇒ Object
Execute the given command on all servers that are the target of the current task.
-
#sudo(command, options = {}, &block) ⇒ Object
Like #run, but executes the command via
sudo
. -
#transaction ⇒ Object
Invoke a set of tasks in a transaction.
Constructor Details
#initialize(config) ⇒ Actor
:nodoc:
97 98 99 100 101 102 103 |
# File 'lib/switchtower/actor.rb', line 97 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)
372 373 374 375 376 377 378 |
# File 'lib/switchtower/actor.rb', line 372 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.
30 31 32 |
# File 'lib/switchtower/actor.rb', line 30 def command_factory @command_factory end |
.connection_factory ⇒ Object
Returns the value of attribute connection_factory.
29 30 31 |
# File 'lib/switchtower/actor.rb', line 29 def connection_factory @connection_factory end |
.transfer_factory ⇒ Object
Returns the value of attribute transfer_factory.
31 32 33 |
# File 'lib/switchtower/actor.rb', line 31 def transfer_factory @transfer_factory end |
Instance Attribute Details
#configuration ⇒ Object (readonly)
The configuration instance associated with this actor.
39 40 41 |
# File 'lib/switchtower/actor.rb', line 39 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.
49 50 51 |
# File 'lib/switchtower/actor.rb', line 49 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.
54 55 56 |
# File 'lib/switchtower/actor.rb', line 54 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.
58 59 60 |
# File 'lib/switchtower/actor.rb', line 58 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.
43 44 45 |
# File 'lib/switchtower/actor.rb', line 43 def tasks @tasks end |
Instance Method Details
#current_release ⇒ Object
Returns the most recent deployed release
276 277 278 |
# File 'lib/switchtower/actor.rb', line 276 def current_release release_path(releases.last) end |
#define_task(name, options = {}, &block) ⇒ Object
Define a new task for this actor. The block will be invoked when this task is called.
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
# File 'lib/switchtower/actor.rb', line 107 def define_task(name, ={}, &block) @tasks[name] = Task.new(name, ) define_method(name) do send "before_#{name}" if respond_to? "before_#{name}" logger.trace "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.
148 149 150 151 |
# File 'lib/switchtower/actor.rb', line 148 def delete(path, ={}) cmd = "rm -%sf #{path}" % ([:recursive] ? "r" : "") run(cmd, ) 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.
319 320 321 |
# File 'lib/switchtower/actor.rb', line 319 def on_rollback(&block) task_call_frames.last.rollback = block end |
#previous_release ⇒ Object
Returns the release immediately before the currently deployed one
281 282 283 |
# File 'lib/switchtower/actor.rb', line 281 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.
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 |
# File 'lib/switchtower/actor.rb', line 156 def put(data, path, ={}) if SwitchTower::SFTP execute_on_servers() do |servers| transfer = self.class.transfer_factory.new(servers, self, path, :data => data, :mode => [: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 #{[:mode].to_s(8)} #{path}" if [:mode] run(cmd, .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.
262 263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/switchtower/actor.rb', line 262 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
switchtower/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.
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 |
# File 'lib/switchtower/actor.rb', line 222 def render(*args) = args.last.is_a?(Hash) ? args.pop : {} [:file] = args.shift if args.first.is_a?(String) raise ArgumentError, "too many parameters" unless args.empty? case when [:file] file = .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 .merge(:template => File.read(file)) when [:template] erb = ERB.new([:template]) b = Proc.new { binding }.call .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.
131 132 133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/switchtower/actor.rb', line 131 def run(cmd, ={}, &block) block ||= Proc.new do |ch, stream, out| logger.debug(out, "#{stream} :: #{ch[:host]}") end logger.debug "executing #{cmd.strip.inspect}" execute_on_servers() do |servers| # execute the command on each server in parallel command = self.class.command_factory.new(servers, cmd, block, , 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.
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'lib/switchtower/actor.rb', line 178 def sudo(command, ={}, &block) block ||= Proc.new do |ch, stream, out| logger.debug(out, "#{stream} :: #{ch[:host]}") end # 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}", 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.
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 |
# File 'lib/switchtower/actor.rb', line 289 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.}", task.name end end raise ensure @task_call_history = nil end end end |