Class: Rake::RemoteTask

Inherits:
Task
  • Object
show all
Includes:
Open4
Defined in:
lib/rake_remote_task.rb

Overview

Rake::RemoteTask is a subclass of Rake::Task that adds remote_actions that execute in parallel on multiple hosts via ssh.

Defined Under Namespace

Classes: Action

Constant Summary collapse

@@current_roles = 
[]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(task_name, app) ⇒ RemoteTask

Create a new task named task_name attached to Rake::Application app.



129
130
131
132
 
# File 'lib/rake_remote_task.rb', line 129

def initialize(task_name, app)
  super
  @remote_actions = []
end

Instance Attribute Details

#options ⇒ Object

Options for execution of this task.



109
110
111
 
# File 'lib/rake_remote_task.rb', line 109

def options
  @options
end

#remote_actions ⇒ Object (readonly)

An Array of Actions this host will perform during execution. Use enhance to add new actions to a task.



120
121
122
 
# File 'lib/rake_remote_task.rb', line 120

def remote_actions
  @remote_actions
end

#target_host ⇒ Object

The host this task is running on during execution.



114
115
116
 
# File 'lib/rake_remote_task.rb', line 114

def target_host
  @target_host
end

Class Method Details

.all_hosts ⇒ Object

Returns an Array with every host configured.



241
242
243
 
# File 'lib/rake_remote_task.rb', line 241

def self.all_hosts
  hosts_for(roles.keys)
end

.current_roles ⇒ Object 



122
123
124
 
# File 'lib/rake_remote_task.rb', line 122

def self.current_roles
  @@current_roles
end

.default_env ⇒ Object

The default environment values. Used for resetting (mostly for tests).



249
250
251
 
# File 'lib/rake_remote_task.rb', line 249

def self.default_env
  @@default_env
end

.env ⇒ Object

The vlad environment.



256
257
258
 
# File 'lib/rake_remote_task.rb', line 256

def self.env
  @@env
end

.fetch(name, default = nil) ⇒ Object

Fetches environment variable name from the environment using default default.



264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/rake_remote_task.rb', line 264

def self.fetch name, default = nil
  name = name.to_s if Symbol === name
  if @@env.has_key? name then
    protect_env(name) do
      v = @@env[name]
      v = @@env[name] = v.call if Proc === v
      v
    end
  elsif default
    v = @@env[name] = default
  else
    raise Vlad::FetchError
  end
end

.host(host_name, *roles) ⇒ Object

Add host host_name that belongs to roles. Extra arguments may be specified for the host as a hash as the last argument.

host is the inversion of role:

host 'db1.example.com', :db, :master_db

Is equivalent to:

role :db, 'db1.example.com'
role :master_db, 'db1.example.com'



292
293
294
295
296
297
298
 
# File 'lib/rake_remote_task.rb', line 292

def self.host host_name, *roles
  opts = Hash === roles.last ? roles.pop : {}

  roles.each do |role_name|
    role role_name, host_name, opts.dup
  end
end

.hosts_for(*roles) ⇒ Object

Returns an Array of all hosts in roles.



303
304
305
306
307
 
# File 'lib/rake_remote_task.rb', line 303

def self.hosts_for *roles
  roles.flatten.map { |r|
    self.roles[r].keys
  }.flatten.uniq.sort
end

.mandatory(name, desc) ⇒ Object

:nodoc:



309
310
311
312
313
314
 
# File 'lib/rake_remote_task.rb', line 309

def self.mandatory name, desc # :nodoc:
  self.set(name) do
    raise(Vlad::ConfigurationError,
          "Please specify the #{desc} via the #{name.inspect} variable")
  end
end

.protect_env(name) ⇒ Object

Ensures exclusive access to name.



319
320
321
322
323
 
# File 'lib/rake_remote_task.rb', line 319

def self.protect_env name # :nodoc:
  @@env_locks[name].synchronize do
    yield
  end
end

.remote_task(name, *args, &block) ⇒ Object

Adds a remote task named name with options options that will execute block.



329
330
331
332
333
334
335
336
 
# File 'lib/rake_remote_task.rb', line 329

def self.remote_task name, *args, &block
  options = (Hash === args.last) ? args.pop : {}
  t = Rake::RemoteTask.define_task(name, *args, &block)
  options[:roles] = Array options[:roles]
  options[:roles] |= @@current_roles
  t.options = options
  t
end

.reserved_name?(name) ⇒ Boolean

Ensures name does not conflict with an existing method.

Returns:

  • (Boolean) 


341
342
343
 
# File 'lib/rake_remote_task.rb', line 341

def self.reserved_name? name # :nodoc:
  !@@env.has_key?(name.to_s) && self.respond_to?(name)
end

.reset ⇒ Object

Resets vlad, restoring all roles, tasks and environment variables to the defaults.



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/rake_remote_task.rb', line 349

def self.reset
  @@def_role_hash = {}                # official default role value
  @@roles = Hash.new { |h,k| h[k] = @@def_role_hash }
  @@env = {}
  @@tasks = {}
  @@env_locks = Hash.new { |h,k| h[k] = Mutex.new }

  @@default_env.each do |k,v|
    case v
    when Symbol, Fixnum, nil, true, false, 42 then # ummmm... yeah. bite me.
      @@env[k] = v
    else
      @@env[k] = v.dup
    end
  end
end

.role(role_name, host, args = {}) ⇒ Object

Adds role role_name with host and args for that host.



369
370
371
372
373
374
375
 
# File 'lib/rake_remote_task.rb', line 369

def self.role role_name, host, args = {}
  [*host].each do |hst|
    raise ArgumentError, "invalid host: #{hst}" if hst.nil? or hst.empty?
  end
  @@roles[role_name] = {} if @@def_role_hash.eql? @@roles[role_name]
  @@roles[role_name][host] = args
end

.roles ⇒ Object

The configured roles.



380
381
382
383
384
 
# File 'lib/rake_remote_task.rb', line 380

def self.roles
  host domain, :app, :web, :db if @@roles.empty?

  @@roles
end

.set(name, value = nil, &default_block) ⇒ Object

Set environment variable name to value or default_block.

If default_block is defined, the block will be executed the first time the variable is fetched, and the value will be used for every subsequent fetch.

Raises:

  • (ArgumentError) 


393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/rake_remote_task.rb', line 393

def self.set name, value = nil, &default_block
  raise ArgumentError, "cannot provide both a value and a block" if
    value and default_block
  raise ArgumentError, "cannot set reserved name: '#{name}'" if
    Rake::RemoteTask.reserved_name?(name) unless $TESTING

  Rake::RemoteTask.default_env[name.to_s] = Rake::RemoteTask.env[name.to_s] =
    value || default_block

  Object.send :define_method, name do
    Rake::RemoteTask.fetch name
  end
end

.set_defaults ⇒ Object

Sets all the default values. Should only be called once. Use reset if you need to restore values.



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/rake_remote_task.rb', line 411

def self.set_defaults
  @@default_env ||= {}
  self.reset

  mandatory :repository, "repository path"
  mandatory :deploy_to,  "deploy path"
  mandatory :domain,     "server domain"

  simple_set(:deploy_timestamped, true,
             :deploy_via,         :export,
             :keep_releases,      5,
             :migrate_args,       "",
             :migrate_target,     :latest,
             :rails_env,          "production",
             :rake_cmd,           "rake",
             :revision,           "head",
             :rsync_cmd,          "rsync",
             :rsync_flags,        ['-azP', '--delete'],
             :ssh_cmd,            "ssh",
             :ssh_flags,          [],
             :sudo_cmd,           "sudo",
             :sudo_flags,         nil,
             :umask,              '02')

  set(:current_release)    { File.join(releases_path, releases[-1]) }
  set(:latest_release)     { deploy_timestamped ?release_path: current_release }
  set(:previous_release)   { File.join(releases_path, releases[-2]) }
  set(:release_name)       { Time.now.utc.strftime("%Y%m%d%H%M%S") }
  set(:release_path)       { File.join(releases_path, release_name) }
  set(:releases)           { task.run("ls -x #{releases_path}").split.sort }

  set_path :current_path,  "current"
  set_path :releases_path, "releases"
  set_path :scm_path,      "scm"
  set_path :shared_path,   "shared"

  set(:sudo_password) do
    state = `stty -g`

    raise Vlad::Error, "stty(1) not found" unless $?.success?

    begin
      system "stty -echo"
      $stdout.print "sudo password: "
      $stdout.flush
      sudo_password = $stdin.gets
      $stdout.puts
    ensure
      system "stty #{state}"
    end
    sudo_password
  end
end

.set_path(name, subdir) ⇒ Object

:nodoc:



465
466
467
 
# File 'lib/rake_remote_task.rb', line 465

def self.set_path(name, subdir) # :nodoc:
  set(name) { File.join(deploy_to, subdir) }
end

.simple_set(*args) ⇒ Object

:nodoc:



469
470
471
472
473
474
 
# File 'lib/rake_remote_task.rb', line 469

def self.simple_set(*args) # :nodoc:
  args = Hash[*args]
  args.each do |k, v|
    set k, v
  end
end

.task ⇒ Object

The Rake::RemoteTask executing in this Thread.



479
480
481
 
# File 'lib/rake_remote_task.rb', line 479

def self.task
  Thread.current[:task]
end

.tasks ⇒ Object

The configured Rake::RemoteTasks.



486
487
488
 
# File 'lib/rake_remote_task.rb', line 486

def self.tasks
  @@tasks
end

Instance Method Details

#defined_target_hosts? ⇒ Boolean

Similar to target_hosts, but returns true if user defined any hosts, even an empty list.

Returns:

  • (Boolean) 


524
525
526
527
528
529
530
531
532
533
 
# File 'lib/rake_remote_task.rb', line 524

def defined_target_hosts?
  return true if ENV["HOSTS"]
  roles = Array options[:roles]
  return true if roles.empty?
  # borrowed from hosts_for:
  roles.flatten.each { |r|
    return true unless @@def_role_hash.eql? Rake::RemoteTask.roles[r] 
  }
  return false
end

#enhance(deps = nil, &block) ⇒ Object

Add remote action block to this task with dependencies deps. See Rake::Task#enhance.



143
144
145
146
147
 
# File 'lib/rake_remote_task.rb', line 143

def enhance(deps=nil, &block)
  original_enhance(deps) # can't use super because block passed regardless.
  @remote_actions << Action.new(self, block) if block_given?
  self
end

#execute(args = nil) ⇒ Object

Execute this action. Local actions will be performed first, then remote actions will be performed in parallel on each host configured for this RemoteTask.

Raises:



154
155
156
157
158
159
160
161
162
 
# File 'lib/rake_remote_task.rb', line 154

def execute(args = nil)
  raise(Vlad::ConfigurationError,
        "No target hosts specified on task #{self.name} for roles #{options[:roles].inspect}") if
    ! defined_target_hosts?

  super args

  @remote_actions.each { |act| act.execute(target_hosts, self, args) }
end

#original_enhance ⇒ Object

Add a local action to this task. This calls Rake::Task#enhance.



137
 
# File 'lib/rake_remote_task.rb', line 137

alias_method :original_enhance, :enhance

#rsync(local, remote) ⇒ Object

Use rsync to send local to remote on target_host.



167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/rake_remote_task.rb', line 167

def rsync local, remote
  cmd = [rsync_cmd, rsync_flags, local, "#{@target_host}:#{remote}"]
  cmd = cmd.flatten.compact

  warn cmd.join(' ') if $TRACE

  success = system(*cmd)

  unless success then
    raise Vlad::CommandFailedError, "execution failed: #{cmd.join ' '}"
  end
end

#run(command) ⇒ Object

Use ssh to execute command on target_host. If command uses sudo, the sudo password will be prompted for then saved for subsequent sudo commands.



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/rake_remote_task.rb', line 184

def run command
  cmd = [ssh_cmd, ssh_flags, target_host, command].flatten
  result = []

  warn cmd.join(' ') if $TRACE

  pid, inn, out, err = popen4(*cmd)

  inn.sync   = true
  streams    = [out, err]
  out_stream = {
    out => $stdout,
    err => $stderr,
  }

  # Handle process termination ourselves
  status = nil
  Thread.start do
    status = Process.waitpid2(pid).last
  end

  until streams.empty? do
    # don't busy loop
    selected, = select streams, nil, nil, 0.1

    next if selected.nil? or selected.empty?

    selected.each do |stream|
      if stream.eof? then
        streams.delete stream if status # we've quit, so no more writing
        next
      end

      data = stream.readpartial(1024)
      out_stream[stream].write data

      if stream == err and data =~ /^Password:/ then
        inn.puts sudo_password
        data << "\n"
        $stderr.write "\n"
      end

      result << data
    end
  end

  unless status.success? then
    raise(Vlad::CommandFailedError,
          "execution failed with status #{status.exitstatus}: #{cmd.join ' '}")
  end

  result.join
end

#sudo(command) ⇒ Object

Execute command under sudo using run.



493
494
495
 
# File 'lib/rake_remote_task.rb', line 493

def sudo command
  run [sudo_cmd, sudo_flags, command].compact.join(" ")
end

#target_hosts ⇒ Object

The hosts this task will execute on. The hosts are determined from the role this task belongs to.

The target hosts may be overridden by providing a comma-separated list of commands to the HOSTS environment variable:

rake my_task HOSTS=app1.example.com,app2.example.com



506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/rake_remote_task.rb', line 506

def target_hosts
  if hosts = ENV["HOSTS"] then
    hosts.strip.gsub(/\s+/, '').split(",")
  else
    roles = Array options[:roles]

    if roles.empty? then
      Rake::RemoteTask.all_hosts
    else
      Rake::RemoteTask.hosts_for roles
    end
  end
end