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.



52
53
54
55
56
57
 
# File 'lib/rake_remote_task.rb', line 52

def initialize(task_name, app)
  super

  @remote_actions = []
  @happy = false # used for deprecation warnings on get/put/rsync
end

Instance Attribute Details

#options ⇒ Object

Options for execution of this task.



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

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.



43
44
45
 
# File 'lib/rake_remote_task.rb', line 43

def remote_actions
  @remote_actions
end

#target_host ⇒ Object

The host this task is running on during execution.



37
38
39
 
# File 'lib/rake_remote_task.rb', line 37

def target_host
  @target_host
end

Class Method Details

.all_hosts ⇒ Object

Returns an Array with every host configured.



205
206
207
 
# File 'lib/rake_remote_task.rb', line 205

def self.all_hosts
  hosts_for(roles.keys)
end

.current_roles ⇒ Object 



45
46
47
 
# File 'lib/rake_remote_task.rb', line 45

def self.current_roles
  @@current_roles
end

.default_env ⇒ Object

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



213
214
215
 
# File 'lib/rake_remote_task.rb', line 213

def self.default_env
  @@default_env
end

.env ⇒ Object

The vlad environment.



224
225
226
 
# File 'lib/rake_remote_task.rb', line 224

def self.env
  @@env
end

.fetch(name, default = nil) ⇒ Object

Fetches environment variable name from the environment using default default.



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/rake_remote_task.rb', line 232

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 unless per_thread[name]
      v = v.call if Proc === v
      v
    end
  elsif default || default == false
    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'



261
262
263
264
265
266
267
 
# File 'lib/rake_remote_task.rb', line 261

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.



272
273
274
275
276
 
# File 'lib/rake_remote_task.rb', line 272

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

.mandatory(name, desc) ⇒ Object

:nodoc:



278
279
280
281
282
283
 
# File 'lib/rake_remote_task.rb', line 278

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

.per_thread ⇒ Object 



217
218
219
 
# File 'lib/rake_remote_task.rb', line 217

def self.per_thread
  @@per_thread
end

.protect_env(name) ⇒ Object

Ensures exclusive access to name.



288
289
290
291
292
 
# File 'lib/rake_remote_task.rb', line 288

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.



298
299
300
301
302
303
304
305
 
# File 'lib/rake_remote_task.rb', line 298

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) 


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

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.



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/rake_remote_task.rb', line 318

def self.reset
  @@def_role_hash = {}                # official default role value
  @@env           = {}
  @@tasks         = {}
  @@roles         = Hash.new { |h,k| h[k] = @@def_role_hash }
  @@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 = nil, args = {}) ⇒ Object

Adds role role_name with host and args for that host. TODO: merge: Declare a role and assign a remote host to it. Equivalent to the host method; provided for capistrano compatibility.



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/rake_remote_task.rb', line 341

def self.role role_name, host = nil, args = {}
  if block_given? then
    raise ArgumentError, 'host not allowed with block' unless host.nil?

    begin
      current_roles << role_name
      yield
    ensure
      current_roles.delete role_name
    end
  else
    raise ArgumentError, 'host required' if host.nil?

    [*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
end

.roles ⇒ Object

The configured roles.



365
366
367
368
369
 
# File 'lib/rake_remote_task.rb', line 365

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) 


378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/rake_remote_task.rb', line 378

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

  name = name.to_s

  Rake::RemoteTask.per_thread[name] = true if
    default_block && value == :per_thread

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

  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.



402
403
404
405
406
407
408
409
410
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
 
# File 'lib/rake_remote_task.rb', line 402

def self.set_defaults
  @@default_env ||= {}
  @@per_thread  ||= {}
  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,         ['-p Password:'],
             :sudo_prompt,        /^Password:/,
             :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:



458
459
460
 
# File 'lib/rake_remote_task.rb', line 458

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

.simple_set(*args) ⇒ Object

:nodoc:



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

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.



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

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

.tasks ⇒ Object

The configured Rake::RemoteTasks.



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

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) 


517
518
519
520
521
522
523
524
525
526
 
# File 'lib/rake_remote_task.rb', line 517

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.



68
69
70
71
72
 
# File 'lib/rake_remote_task.rb', line 68

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:



79
80
81
82
83
84
85
86
87
 
# File 'lib/rake_remote_task.rb', line 79

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

#get(local_dir, *files) ⇒ Object

Pull files from the remote host using rsync to local_dir. TODO: what if role has multiple hosts & the files overlap? subdirs?



93
94
95
96
97
98
 
# File 'lib/rake_remote_task.rb', line 93

def get local_dir, *files
  @happy = true
  host = target_host
  rsync files.map { |f| "#{host}:#{f}" }, local_dir
  @happy = false
end

#original_enhance ⇒ Object

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



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

alias_method :original_enhance, :enhance

#put(remote_path, base_name = File.basename(remote_path)) ⇒ Object

Copy a (usually generated) file to remote_path. Contents of block are copied to remote_path and you may specify an optional base_name for the tempfile (aids in debugging).



105
106
107
108
109
110
111
112
113
114
 
# File 'lib/rake_remote_task.rb', line 105

def put remote_path, base_name = File.basename(remote_path)
  require 'tempfile'
  Tempfile.open base_name do |fp|
    fp.puts yield
    fp.flush
    @happy = true
    rsync fp.path, "#{target_host}:#{remote_path}"
    @happy = false
  end
end

#rsync(*args) ⇒ Object

Execute rsync with args. Tacks on pre-specified rsync_cmd and rsync_flags.

Favor #get and #put for most tasks. Old-style direct use where the target_host was implicit is now deprecated.

Raises:



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/rake_remote_task.rb', line 123

def rsync *args
  unless @happy || args[-1] =~ /:/ then
    warn "rsync deprecation: pass target_host:remote_path explicitly"
    args[-1] = "#{target_host}:#{args[-1]}"
  end

  cmd    = [rsync_cmd, rsync_flags, args].flatten.compact
  cmdstr = cmd.join ' '

  warn cmdstr if $TRACE

  success = system(*cmd)

  raise Vlad::CommandFailedError, "execution failed: #{cmdstr}" unless success
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.



143
144
145
146
147
148
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/rake_remote_task.rb', line 143

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

  trace = [ssh_cmd, ssh_flags, target_host, "'#{command}'"].flatten.join(' ')
  warn trace 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 =~ sudo_prompt 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
ensure
  inn.close rescue nil
  out.close rescue nil
  err.close rescue nil
end

#sudo(command) ⇒ Object

Execute command under sudo using run.



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

def sudo command
  run [sudo_cmd, sudo_flags, command].flatten.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



499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/rake_remote_task.rb', line 499

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