rake-remote_task 2.0.0

data/.autotest

@@ -0,0 +1,24 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+Autotest.add_hook :initialize do |at|
+  at.testlib = "minitest/autorun"
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,7 @@
+=== 2.0.0 / 2010-07-15
+
+* 1 major enhancement
+
+  * Split out from Vlad.
+
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/rake/remote_task.rb
+lib/rake/test_case.rb
+test/test_rake_remote_task.rb

data/README.txt

@@ -0,0 +1,56 @@
+= rake-remote_task
+
+* http://rubyhitsquad.com/
+* http://rubyforge.org/projects/hitsquad/
+
+== DESCRIPTION:
+
+Vlad the Deployer's sexy brainchild is rake-remote_task, extending
+Rake with remote task goodness.
+
+== FEATURES/PROBLEMS:
+
+* Run remote commands on one or more servers.
+* Mix and match local and remote tasks.
+* Uses ssh with your ssh settings already in place.
+* Uses rsync for efficient transfers.
+
+== SYNOPSIS:
+
+  remote_task :setup_app, :roles => :app do
+    # ...
+    run "umask #{umask} && mkdir -p #{dirs.join(' ')}"
+  end
+
+== REQUIREMENTS:
+
+* rake, >= 0.8
+
+== INSTALL:
+
+* sudo gem install rake-remote_task
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) Ryan Davis, RubyHitSquad
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,25 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+# HACK Hoe.plugin :isolate # fudging releases - work it out w/ release script
+Hoe.plugin :seattlerb
+
+Hoe.spec 'rake-remote_task' do
+  developer 'Ryan Davis',       'ryand-ruby@zenspider.com'
+  developer 'Eric Hodel',       'drbrain@segment7.net'
+  developer 'Wilson Bilkovich', 'wilson@supremetyrant.com'
+
+  self.rubyforge_name = 'hitsquad'
+
+  extra_deps << ['rake',  '~> 0.8.0']
+  extra_deps << ['open4', '~> 0.9.0']
+
+  extra_dev_deps << ['minitest', '~> 1.7.0']
+
+  # TODO: remove 1.9
+  multiruby_skip << "1.9" << "rubinius"
+end
+
+# vim: syntax=ruby

data/lib/rake/remote_task.rb

@@ -0,0 +1,630 @@
+require 'rubygems'
+require 'open4'
+require 'rake'
+
+$TESTING ||= false
+$TRACE = Rake.application.options.trace
+$-w = true if $TRACE # asshat, don't mess with my warn.
+
+[
+ ["Thread.current[:task]", :get, :put, :rsync, :run, :sudo, :target_host],
+ ["Rake::RemoteTask",      :host, :remote_task, :role, :set]
+].each do |methods|
+  receiver = methods.shift
+  methods.each do |method|
+    eval "def #{method} *args, █ #{receiver}.#{method}(*args, &block);end"
+  end
+end
+
+module Rake
+  ##
+  # Base error class for all Vlad errors.
+  class Error < RuntimeError; end
+
+  ##
+  # Raised when you have incorrectly configured Vlad.
+  class ConfigurationError < Error; end
+
+  ##
+  # Raised when a remote command fails.
+  class CommandFailedError < Error; end
+
+  ##
+  # Raised when an environment variable hasn't been set.
+  class FetchError < Error; end
+end
+
+##
+# Rake::RemoteTask is a subclass of Rake::Task that adds
+# remote_actions that execute in parallel on multiple hosts via ssh.
+
+class Rake::RemoteTask < Rake::Task
+
+  VERSION = "2.0.0"
+
+  @@current_roles = []
+
+  include Open4
+
+  ##
+  # Options for execution of this task.
+
+  attr_accessor :options
+
+  ##
+  # The host this task is running on during execution.
+
+  attr_reader :target_host
+
+  ##
+  # The directory on the host this task is running in during execution.
+
+  attr_reader :target_dir
+
+  ##
+  # An Array of Actions this host will perform during execution. Use
+  # enhance to add new actions to a task.
+
+  attr_reader :remote_actions
+
+  def self.current_roles
+    @@current_roles
+  end
+
+  ##
+  # Create a new task named +task_name+ attached to Rake::Application +app+.
+
+  def initialize(task_name, app)
+    super
+
+    @remote_actions = []
+    @happy = false # used for deprecation warnings on get/put/rsync
+  end
+
+  ##
+  # Add a local action to this task. This calls Rake::Task#enhance.
+
+  alias_method :original_enhance, :enhance
+
+  ##
+  # Add remote action +block+ to this task with dependencies +deps+. See
+  # Rake::Task#enhance.
+
+  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 this action. Local actions will be performed first, then remote
+  # actions will be performed in parallel on each host configured for this
+  # RemoteTask.
+
+  def execute(args = nil)
+    raise(Rake::ConfigurationError,
+          "No target hosts specified on task #{self.name} for roles #{options[:roles].inspect}") unless
+      defined_target_hosts?
+
+    super args
+
+    @remote_actions.each { |act| act.execute(target_hosts, self, args) }
+  end
+
+  ##
+  # Pull +files+ from the remote +host+ using rsync to +local_dir+.
+  # TODO: what if role has multiple hosts & the files overlap? subdirs?
+
+  def get local_dir, *files
+    @happy = true
+    host = target_host
+    rsync files.map { |f| "#{host}:#{f}" }, local_dir
+    @happy = false
+  end
+
+  ##
+  # 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).
+
+  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
+
+  ##
+  # 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.
+
+  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 Rake::CommandFailedError, "execution failed: #{cmdstr}" unless success
+  end
+
+  ##
+  # 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.
+
+  def run command
+    command = "cd #{target_dir} && #{command}" if target_dir
+    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(Rake::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
+
+  ##
+  # Returns an Array with every host configured.
+
+  def self.all_hosts
+    hosts_for(roles.keys)
+  end
+
+  ##
+  # The default environment values. Used for resetting (mostly for
+  # tests).
+
+  def self.default_env
+    @@default_env
+  end
+
+  def self.per_thread
+    @@per_thread
+  end
+
+  ##
+  # The vlad environment.
+
+  def self.env
+    @@env
+  end
+
+  ##
+  # Fetches environment variable +name+ from the environment using
+  # default +default+.
+
+  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 Rake::FetchError
+    end
+  end
+
+  ##
+  # 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'
+
+  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
+
+  ##
+  # Returns an Array of all hosts in +roles+.
+
+  def self.hosts_for *roles
+    roles.flatten.map { |r|
+      self.roles[r].keys
+    }.flatten.uniq.sort
+  end
+
+  def self.mandatory name, desc # :nodoc:
+    self.set(name) do
+      raise(Rake::ConfigurationError,
+            "Please specify the #{desc} via the #{name.inspect} variable")
+    end
+  end
+
+  ##
+  # Ensures exclusive access to +name+.
+
+  def self.protect_env name # :nodoc:
+    @@env_locks[name].synchronize do
+      yield
+    end
+  end
+
+  ##
+  # Adds a remote task named +name+ with options +options+ that will
+  # execute +block+.
+
+  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
+
+  ##
+  # Ensures +name+ does not conflict with an existing method.
+
+  def self.reserved_name? name # :nodoc:
+    !@@env.has_key?(name.to_s) && self.respond_to?(name)
+  end
+
+  ##
+  # Resets vlad, restoring all roles, tasks and environment variables
+  # to the defaults.
+
+  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
+
+  ##
+  # 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
+  # <tt>host</tt> method; provided for capistrano compatibility.
+
+  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
+
+  ##
+  # The configured roles.
+
+  def self.roles
+    host domain, :app, :web, :db if @@roles.empty?
+
+    @@roles
+  end
+
+  ##
+  # 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.
+
+  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
+
+  ##
+  # Sets all the default values. Should only be called once. Use reset
+  # if you need to restore values.
+
+  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,
+               :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',
+               :mkdirs,             [],
+               :shared_paths,       {})
+
+    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 Rake::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
+
+  def self.set_path(name, subdir) # :nodoc:
+    set(name) { File.join(deploy_to, subdir) }
+  end
+
+  def self.simple_set(*args) # :nodoc:
+    args = Hash[*args]
+    args.each do |k, v|
+      set k, v
+    end
+  end
+
+  ##
+  # The Rake::RemoteTask executing in this Thread.
+
+  def self.task
+    Thread.current[:task]
+  end
+
+  ##
+  # The configured Rake::RemoteTasks.
+
+  def self.tasks
+    @@tasks
+  end
+
+  ##
+  # Execute +command+ under sudo using run.
+
+  def sudo command
+    run [sudo_cmd, sudo_flags, command].flatten.compact.join(" ")
+  end
+
+  ##
+  # Sets the target host. Allows you to set an optional directory
+  # using the format:
+  #
+  #    host.domain:/dir
+
+  def target_host= host
+    if host =~ /^(.+):(.+?)$/
+      @target_host = $1
+      @target_dir  = $2
+    else
+      @target_host = host
+      @target_dir  = nil
+    end
+  end
+
+  ##
+  # 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
+
+  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
+
+  ##
+  # Similar to target_hosts, but returns true if user defined any hosts, even
+  # an empty list.
+
+  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
+
+  ##
+  # Action is used to run a task's remote_actions in parallel on each
+  # of its hosts. Actions are created automatically in
+  # Rake::RemoteTask#enhance.
+
+  class Action
+
+    ##
+    # The task this action is attached to.
+
+    attr_reader :task
+
+    ##
+    # The block this action will execute.
+
+    attr_reader :block
+
+    ##
+    # An Array of threads, one for each host this action executes on.
+
+    attr_reader :workers
+
+    ##
+    # Creates a new Action that will run +block+ for +task+.
+
+    def initialize task, block
+      @task  = task
+      @block = block
+      @workers = ThreadGroup.new
+    end
+
+    def == other # :nodoc:
+      return false unless Action === other
+      block == other.block && task == other.task
+    end
+
+    ##
+    # Execute this action on +hosts+ in parallel. Returns when block
+    # has completed for each host.
+
+    def execute hosts, task, args
+      hosts.each do |host|
+        t = task.clone
+        t.target_host = host
+        thread = Thread.new(t) do |task|
+          Thread.current[:task] = task
+          case block.arity
+          when 1
+            block.call task
+          else
+            block.call task, args
+          end
+          Thread.current[:task] = nil
+        end
+        @workers.add thread
+      end
+      @workers.list.each { |thr| thr.join }
+    end
+  end
+end
+
+Rake::RemoteTask.set_defaults

data/lib/rake/test_case.rb

@@ -0,0 +1,72 @@
+require 'minitest/autorun'
+require 'rake'
+require 'rake/remote_task'
+require 'stringio'
+
+class StringIO
+  def readpartial(size) read end # suck!
+end
+
+module Process
+  def self.expected status
+    @@expected ||= []
+    @@expected << status
+  end
+
+  class << self
+    alias :waitpid2_old :waitpid2
+
+    def waitpid2(pid)
+      [ @@expected.shift ]
+    end
+  end
+end
+
+class Rake::RemoteTask
+  attr_accessor :commands, :action, :input, :output, :error
+
+  Status = Struct.new :exitstatus
+
+  class Status
+    def success?() exitstatus == 0 end
+  end
+
+  def system *command
+    @commands << command
+    self.action ? self.action[command.join(' ')] : true
+  end
+
+  def popen4 *command
+    @commands << command
+
+    @input = StringIO.new
+    out = StringIO.new @output.shift.to_s
+    err = StringIO.new @error.shift.to_s
+
+    raise if block_given?
+
+    status = self.action ? self.action[command.join(' ')] : 0
+    Process.expected Status.new(status)
+
+    return 42, @input, out, err
+  end
+
+  def select reads, writes, errs, timeout
+    [reads, writes, errs]
+  end
+end
+
+class Rake::TestCase < MiniTest::Unit::TestCase
+  def setup
+    @rake = Rake::RemoteTask
+    @rake.reset
+    Rake.application.clear
+    @task_count = Rake.application.tasks.size
+    @rake.set :domain, "example.com"
+  end
+
+  def util_set_hosts
+    @rake.host "app.example.com", :app
+    @rake.host "db.example.com", :db
+  end
+end

data/test/test_rake_remote_task.rb

@@ -0,0 +1,272 @@
+require 'rake/test_case'
+
+class TestRakeRemoteTask < Rake::TestCase
+  # TODO: move to minitest
+  def assert_silent
+    out, err = capture_io do
+      yield
+    end
+
+    assert_empty err
+    assert_empty out
+  end
+
+  def test_enhance
+    util_set_hosts
+    body = Proc.new { 5 }
+    task = @rake.remote_task(:some_task => :foo, &body)
+    action = Rake::RemoteTask::Action.new(task, body)
+    assert_equal [action], task.remote_actions
+    assert_equal task, action.task
+    assert_equal ["foo"], task.prerequisites
+  end
+
+  def test_enhance_with_no_task_body
+    util_set_hosts
+    util_setup_task
+    assert_equal [], @task.remote_actions
+    assert_equal [], @task.prerequisites
+  end
+
+  def test_execute
+    util_set_hosts
+    set :some_variable, 1
+    set :can_set_nil, nil
+    set :lies_are, false
+    x = 5
+    task = @rake.remote_task(:some_task) { x += some_variable }
+    task.execute nil
+    assert_equal 1, task.some_variable
+    assert_equal 7, x
+    assert task.can_set_nil.nil?
+    assert_equal false, task.lies_are
+  end
+
+  def test_set_false
+    set :can_set_nil, nil
+    set :lies_are, false
+
+    assert_equal nil,   task.can_set_nil
+
+    assert_equal false, task.lies_are
+    assert_equal false, Rake::RemoteTask.fetch(:lies_are)
+  end
+
+
+  def test_fetch_false
+    assert_equal false, Rake::RemoteTask.fetch(:unknown, false)
+  end
+
+  def test_execute_exposes_target_host
+    host "app.example.com", :app
+    task = remote_task(:target_task) { set(:test_target_host, target_host) }
+    task.execute nil
+    assert_equal "app.example.com", Rake::RemoteTask.fetch(:test_target_host)
+  end
+
+  def test_execute_with_no_hosts
+    @rake.host "app.example.com", :app
+    t = @rake.remote_task(:flunk, :roles => :db) { flunk "should not have run" }
+    e = assert_raises(Rake::ConfigurationError) { t.execute nil }
+    assert_equal "No target hosts specified on task flunk for roles [:db]",
+                 e.message
+  end
+
+  def test_execute_with_no_roles
+    t = @rake.remote_task(:flunk, :roles => :junk) { flunk "should not have run" }
+    e = assert_raises(Rake::ConfigurationError) { t.execute nil }
+    assert_equal "No target hosts specified on task flunk for roles [:junk]",
+                 e.message
+  end
+
+  def test_execute_with_roles
+    util_set_hosts
+    set :some_variable, 1
+    x = 5
+    task = @rake.remote_task(:some_task, :roles => :db) { x += some_variable }
+    task.execute nil
+    assert_equal 1, task.some_variable
+    assert_equal 6, x
+  end
+
+  def test_rsync
+    util_setup_task
+    @task.target_host = "app.example.com"
+
+    assert_silent do
+      @task.rsync 'localfile', 'host:remotefile'
+    end
+
+    commands = @task.commands
+
+    assert_equal 1, commands.size, 'not enough commands'
+    assert_equal(%w[rsync -azP --delete localfile host:remotefile],
+                 commands.first)
+  end
+
+  def test_rsync_fail
+    util_setup_task
+    @task.target_host = "app.example.com"
+    @task.action = lambda { false }
+
+    e = assert_raises Rake::CommandFailedError do
+      assert_silent do
+        @task.rsync 'local', 'host:remote'
+      end
+    end
+    exp = "execution failed: rsync -azP --delete local host:remote"
+    assert_equal exp, e.message
+  end
+
+  def test_rsync_deprecation
+    util_setup_task
+    @task.target_host = "app.example.com"
+
+    out, err = capture_io do
+      @task.rsync 'localfile', 'remotefile'
+    end
+
+    commands = @task.commands
+
+    assert_equal 1, commands.size, 'not enough commands'
+    assert_equal(%w[rsync -azP --delete localfile app.example.com:remotefile],
+                 commands.first)
+
+    assert_equal("rsync deprecation: pass target_host:remote_path explicitly\n",
+                 err)
+    assert_empty out
+    # flunk "not yet"
+  end
+
+  def test_get
+    util_setup_task
+    @task.target_host = "app.example.com"
+
+    assert_silent do
+      @task.get 'tmp', "remote1", "remote2"
+    end
+
+    commands = @task.commands
+
+    expected = %w[rsync -azP --delete app.example.com:remote1 app.example.com:remote2 tmp]
+
+    assert_equal 1, commands.size
+    assert_equal expected, commands.first
+  end
+
+  def test_put
+    util_setup_task
+    @task.target_host = "app.example.com"
+
+    assert_silent do
+      @task.put 'dest' do
+        "whatever"
+      end
+    end
+
+    commands = @task.commands
+
+    expected  = %w[rsync -azP --delete HAPPY app.example.com:dest]
+    commands.first[3] = 'HAPPY'
+
+    assert_equal 1, commands.size
+    assert_equal expected, commands.first
+  end
+
+  def test_run
+    util_setup_task
+    @task.output << "file1\nfile2\n"
+    @task.target_host = "app.example.com"
+    result = nil
+
+    out, err = capture_io do
+      result = @task.run("ls")
+    end
+
+    commands = @task.commands
+
+    assert_equal 1, commands.size, 'not enough commands'
+    assert_equal ["ssh", "app.example.com", "ls"],
+                 commands.first, 'app'
+    assert_equal "file1\nfile2\n", result
+
+    assert_equal "file1\nfile2\n", out
+    assert_equal '', err
+  end
+
+  def test_run_dir
+    util_setup_task
+    @task.target_host = "app.example.com:/www/dir1"
+
+    @task.run("ls")
+
+    commands = @task.commands
+
+    assert_equal 1, commands.size, 'not enough commands'
+    assert_equal [["ssh", "app.example.com", "cd /www/dir1 && ls"]], commands
+  end
+
+  def test_run_failing_command
+    util_set_hosts
+    util_setup_task
+    @task.input = StringIO.new "file1\nfile2\n"
+    @task.target_host =  'app.example.com'
+    @task.action = lambda { 1 }
+
+    e = assert_raises(Rake::CommandFailedError) { @task.run("ls") }
+    assert_equal "execution failed with status 1: ssh app.example.com ls", e.message
+
+    assert_equal 1, @task.commands.size
+  end
+
+  def test_run_sudo
+    util_setup_task
+    @task.output << "file1\nfile2\n"
+    @task.error << 'Password:'
+    @task.target_host = "app.example.com"
+    def @task.sudo_password() "my password" end # gets defined by set
+    result = nil
+
+    out, err = capture_io do
+      result = @task.run("sudo ls")
+    end
+
+    commands = @task.commands
+
+    assert_equal 1, commands.size, 'not enough commands'
+    assert_equal ['ssh', 'app.example.com', 'sudo ls'],
+                 commands.first
+
+    assert_equal "my password\n", @task.input.string
+
+    # WARN: Technically incorrect, the password line should be
+    # first... this is an artifact of changes to the IO code in run
+    # and the fact that we have a very simplistic (non-blocking)
+    # testing model.
+    assert_equal "file1\nfile2\nPassword:\n", result
+
+    assert_equal "file1\nfile2\n", out
+    assert_equal "Password:\n", err
+  end
+
+  def test_sudo
+    util_setup_task
+    @task.target_host = "app.example.com"
+    @task.sudo "ls"
+
+    commands = @task.commands
+
+    assert_equal 1, commands.size, 'wrong number of commands'
+    assert_equal ["ssh", "app.example.com", "sudo -p Password: ls"],
+                 commands.first, 'app'
+  end
+
+  def util_setup_task(options = {})
+    @task = @rake.remote_task :test_task, options
+    @task.commands = []
+    @task.output = []
+    @task.error = []
+    @task.action = nil
+    @task
+  end
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification 
+name: rake-remote_task
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 2
+  - 0
+  - 0
+  version: 2.0.0
+platform: ruby
+authors: 
+- Ryan Davis
+- Eric Hodel
+- Wilson Bilkovich
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDPjCCAiagAwIBAgIBADANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
+  ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
+  GRYDY29tMB4XDTA5MDMwNjE4NTMxNVoXDTEwMDMwNjE4NTMxNVowRTETMBEGA1UE
+  AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
+  JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
+  b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
+  taCPaLmfYIaFcHHCSY4hYDJijRQkLxPeB3xbOfzfLoBDbjvx5JxgJxUjmGa7xhcT
+  oOvjtt5P8+GSK9zLzxQP0gVLS/D0FmoE44XuDr3iQkVS2ujU5zZL84mMNqNB1znh
+  GiadM9GHRaDiaxuX0cIUBj19T01mVE2iymf9I6bEsiayK/n6QujtyCbTWsAS9Rqt
+  qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
+  gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
+  HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBBQUAA4IB
+  AQAY59gYvDxqSqgC92nAP9P8dnGgfZgLxP237xS6XxFGJSghdz/nI6pusfCWKM8m
+  vzjjH2wUMSSf3tNudQ3rCGLf2epkcU13/rguI88wO6MrE0wi4ZqLQX+eZQFskJb/
+  w6x9W1ur8eR01s397LSMexySDBrJOh34cm2AlfKr/jokKCTwcM0OvVZnAutaovC0
+  l1SVZ0ecg88bsWHA0Yhh7NFxK1utWoIhtB6AFC/+trM0FQEB/jZkIS8SaNzn96Rl
+  n0sZEf77FLf5peR8TP/PtmIg7Cyqz23sLM4mCOoTGIy5OcZ8TdyiyINUHtb5ej/T
+  FBHgymkyj/AOSqKRIpXPhjC6
+  -----END CERTIFICATE-----
+
+date: 2010-07-15 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 8
+        - 0
+        version: 0.8.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: open4
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 9
+        - 0
+        version: 0.9.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 7
+        - 0
+        version: 1.7.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 7
+        - 0
+        version: 1.7.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 6
+        - 1
+        version: 2.6.1
+  type: :development
+  version_requirements: *id006
+description: |-
+  Vlad the Deployer's sexy brainchild is rake-remote_task, extending
+  Rake with remote task goodness.
+email: 
+- ryand-ruby@zenspider.com
+- drbrain@segment7.net
+- wilson@supremetyrant.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- .autotest
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/rake/remote_task.rb
+- lib/rake/test_case.rb
+- test/test_rake_remote_task.rb
+has_rdoc: true
+homepage: http://rubyhitsquad.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: hitsquad
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Vlad the Deployer's sexy brainchild is rake-remote_task, extending Rake with remote task goodness.
+test_files: 
+- test/test_rake_remote_task.rb