rexec 1.1.10

data/lib/rexec/version.rb

@@ -0,0 +1,24 @@
+# Copyright (c) 2007 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module RExec
+  module VERSION #:nodoc:
+    MAJOR = 1
+    MINOR = 1
+    TINY  = 10
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/test/client.rb

@@ -0,0 +1,31 @@
+# Copyright (c) 2007 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+$connection.run do |object|
+  case(object[0])
+  when :bounce
+    $stderr.puts("Bouncing #{object[1].inspect}...")
+    $connection.send_object(object[1])
+  when :exception
+    $stderr.puts("Raising exception...")
+    raise Exception.new("I love exceptions!")
+  when :stop
+    $stderr.puts("Stopping connection manually...")
+    $connection.stop
+  when :stderr
+    $stderr.puts object[1]
+    $stderr.flush
+  end
+end

data/test/daemon.rb

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2007, 2009 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'rubygems'
+
+require 'pathname'
+
+require 'rexec'
+require 'rexec/daemon'
+
+require 'webrick'
+require 'webrick/https'
+require 'xmlrpc/server'
+
+# Very simple XMLRPC daemon
+class TestDaemon < RExec::Daemon::Base
+  @@var_directory = "/tmp/ruby-test/var"
+  
+  def self.run
+    puts "Starting server..."
+    
+    @@rpc_server = WEBrick::HTTPServer.new(
+      :Port => 11235,
+      :BindAddress => "0.0.0.0",
+      :SSLEnable => true,
+      :SSLVerifyClient => OpenSSL::SSL::VERIFY_NONE,
+      :SSLCertName => [["CN", WEBrick::Utils::getservername]])
+    
+    @@listener = XMLRPC::WEBrickServlet.new
+    
+    @@listener.add_handler("add") do |amount|
+      @@count ||= 0
+      @@count += amount
+    end
+    
+    @@listener.add_handler("total") do
+      @@count
+    end
+    
+    @@rpc_server.mount("/RPC2", @@listener)
+    
+    $stdout.flush
+    $stderr.flush
+    
+    @@rpc_server.start
+  end
+  
+  def self.shutdown
+		puts "Shutting down server..."
+    @@rpc_server.shutdown
+  end
+end
+
+TestDaemon.daemonize

data/test/daemon_test.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2007, 2009 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'rubygems'
+require 'pathname'
+require 'xmlrpc/client'
+require 'test/unit'
+
+class DaemonTest < Test::Unit::TestCase
+  DAEMON = (Pathname.new(__FILE__).dirname + "./daemon.rb").realpath
+  def setup
+    system(DAEMON, "start")
+    
+    # Daemon takes a moment to become fully operational
+    sleep(5)
+  end
+  
+  def teardown
+    system(DAEMON, "stop")
+  end
+
+  def test_connection
+    rpc = XMLRPC::Client.new_from_uri("https://localhost:11235")
+    rpc.call("add", 10)
+    
+    total = rpc.call("total")
+    
+    assert_equal 10, total
+  end
+end

data/test/listing_example.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2007, 2009 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'rubygems'
+require 'rexec'
+
+CLIENT = <<EOF
+
+$connection.run do |path|
+  listing = []
+
+  IO.popen("ls -la " + path.dump, "r+") do |ls|
+    listing = ls.readlines
+  end
+
+  $connection.send_object(listing)
+end
+
+EOF
+
+command = ARGV[0] || "ruby"
+
+puts "Starting server..."
+RExec::start_server(CLIENT, command) do |conn, pid|
+  puts "Sending path..."
+  conn.send_object("/")
+
+  puts "Waiting for response..."
+  listing = conn.receive_object
+
+  puts "Received listing:"
+  listing.each do |entry|
+    puts "\t#{entry}"
+  end
+end

data/test/remote_server_test.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2007 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# This script is used to test actual remote connections
+# e.g. ./test_remote.rb "ssh haru.oriontransfer.org"
+
+require 'rubygems'
+
+require 'test/unit'
+require 'fileutils'
+require 'pathname'
+require 'rexec'
+
+if $0.match("remote_server_test.rb") and ARGV.size > 0
+	COMMAND = ARGV.join(" ")
+else
+	COMMAND = "ruby"
+end
+
+BOUNCE = "Apples and Oranges"
+
+class RemoteServerTest < Test::Unit::TestCase
+  def test_block_execution
+    code = Pathname.new(__FILE__).dirname + "./client.rb"
+    
+    RExec::start_server(code.read, COMMAND, :passthrough => []) do |conn, pid|
+      conn.send_object([:bounce, BOUNCE])
+
+      assert_equal BOUNCE, conn.receive_object
+
+      conn.dump_errors
+
+      conn.stop
+    end
+  end
+  
+  def test_result_execution
+    code = Pathname.new(__FILE__).dirname + "./client.rb"
+    
+    conn, pid = RExec::start_server(code.read, COMMAND, :passthrough => [])
+    
+    conn.send_object([:bounce, BOUNCE])
+    assert_equal BOUNCE, conn.receive_object
+    
+    conn.dump_errors
+
+    conn.stop
+  end
+end

data/test/server_test.rb

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2007 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'rubygems'
+
+require 'test/unit'
+require 'fileutils'
+require 'pathname'
+require 'rexec'
+
+class ServerTest < Test::Unit::TestCase
+  def test_local_execution
+    code = Pathname.new(__FILE__).dirname + "./client.rb"
+    sobj = [1, 2, "three", 4]
+    stderr_text = "There was no error.. maybe?"
+    connection_started = false
+    object_received = false
+
+    RExec::start_server(code.read, "ruby", :passthrough => []) do |conn, pid|
+      connection_started = true
+      conn.send_object([:bounce, sobj])
+
+      assert_equal sobj, conn.receive_object
+
+      assert_raises(Exception) do
+        conn.send_object([:exception])
+        obj = conn.receive_object
+        
+        puts "Received object which should have been exception: #{obj.inspect}"
+      end
+
+      conn.dump_errors
+      conn.send_object([:stderr, stderr_text])
+
+      puts "Attemping to read from #{conn.error.to_i}..."
+      assert_equal stderr_text, conn.error.readline.chomp
+
+      conn.stop
+    end
+
+    assert(connection_started, "Connection started")
+  end
+  
+  def test_shell_execution
+    connection_started = false
+    code = Pathname.new(__FILE__).dirname + "client.rb"
+
+    test_obj = [1, 2, 3, 4, "five"]
+
+    RExec::start_server(code.read, "/bin/sh -c ruby", :passthrough => []) do |conn, pid|
+      connection_started = true
+      conn.send_object([:bounce, test_obj])
+
+      assert_equal test_obj, conn.receive_object
+
+      conn.stop
+    end
+
+    assert(connection_started, "Connection started")
+  end
+  
+  def test_shell_execution_non_block
+    connection_started = false
+    code = Pathname.new(__FILE__).dirname + "client.rb"
+
+    test_obj = [1, 2, 3, 4, "five"]
+
+    conn, pid = RExec::start_server(code.read, "/bin/sh -c ruby", :passthrough => [])
+    conn.send_object([:bounce, test_obj])
+
+    assert_equal test_obj, conn.receive_object
+
+    conn.stop
+  end
+end

data/test/task.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2007 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+input = $stdin.readline.chomp
+
+$stdout.puts("STDOUT: " + input)
+$stdout.flush
+
+$stderr.puts("STDERR: " + input)
+$stderr.flush

data/test/task_test.rb

@@ -0,0 +1,165 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2007 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'rubygems'
+
+require 'test/unit'
+require 'fileutils'
+require 'pathname'
+require 'rexec'
+
+require 'timeout'
+
+class TaskTest < Test::Unit::TestCase
+  TASK_PATH = Pathname.new(__FILE__).dirname + "./task.rb"
+  TEXT = "The quick brown fox jumped over the lazy dog."
+  STDOUT_TEXT = "STDOUT: " + TEXT
+  STDERR_TEXT = "STDERR: " + TEXT
+  
+  def test_script_execution
+    RExec::Task.open(TASK_PATH) do |task|
+      task.input.puts(TEXT)
+      task.input.close
+      
+      assert_equal STDOUT_TEXT, task.output.readline.chomp
+      assert_equal STDERR_TEXT, task.error.readline.chomp
+    end
+  end
+  
+  def test_ruby_execution
+    RExec::Task.open("ruby") do |task|
+      task.input.puts(TASK_PATH.read)
+      task.input.puts("\004")
+      
+      task.input.puts(TEXT)
+      task.input.close
+      
+      assert_equal STDOUT_TEXT, task.output.readline.chomp
+      assert_equal STDERR_TEXT, task.error.readline.chomp
+    end
+  end
+  
+  def test_spawn_child
+    rd, wr = IO.pipe
+    pid = RExec::Task.spawn_child do
+      rd.close
+      wr.write(TEXT)
+      wr.close
+      exit(10)
+    end
+    
+    wr.close
+    
+    pid, status = Process.wait2(pid)
+    
+    assert_equal rd.read, TEXT
+    assert_equal status, status
+  end
+  
+  def test_spawn_daemon
+    rd, wr = IO.pipe
+    
+    # We launch one daemon to start another. The first daemon will exit, but the second will keep on running.
+    ppid = RExec::Task.spawn_daemon do
+      RExec::Task.spawn_daemon do
+        rd.close
+        sleep 0.5
+        wr.puts(TEXT, Process.pid)
+        wr.close
+        sleep 0.5
+      end
+    end
+    
+    wr.close
+    
+    Timeout::timeout(5) do
+      until !RExec::Task.running?(ppid) do
+        sleep(0.1)
+      end
+      
+      text = rd.readline.chomp
+      pid = rd.readline.chomp.to_i
+      
+      assert_raises(EOFError) do
+        rd.readline
+      end
+      
+      assert_equal text, TEXT
+      assert RExec::Task.running?(pid)
+      
+      until !RExec::Task.running?(pid) do
+        sleep(0.1)
+      end
+    end
+  end
+  
+  def test_task
+    test_results = Proc.new do |input, output, error|
+      input.puts TEXT
+      input.flush
+      
+      assert_equal output.readline.chomp, STDOUT_TEXT
+      assert_equal error.readline.chomp, STDERR_TEXT
+    end
+    
+    RExec::Task.open(TASK_PATH) do |task|
+      test_results.call(task.input, task.output, task.error)
+    end
+    
+    rd, wr = IO.pipe
+    
+    RExec::Task.open(TASK_PATH, :in => rd) do |task|
+      test_results.call(wr, task.output, task.error)
+    end
+    
+    assert rd.closed?
+    
+    assert_raises(Errno::EPIPE) do
+      wr.puts "The pipe is closed on the other side.."
+    end
+    
+    in_rd, in_wr = IO.pipe
+    out_rd, out_wr = IO.pipe
+    err_rd, err_wr = IO.pipe
+    
+    spawn_child_daemon = Proc.new do
+      task = RExec::Task.open(TASK_PATH, :in => in_rd, :out => out_wr, :err => err_wr, :daemonize => true)
+    end
+    
+    task = RExec::Task.open(spawn_child_daemon, :daemonize => true)
+    
+    until !task.running? do
+      sleep 0.1
+    end
+    
+    test_results.call(in_wr, out_rd, err_rd)
+    
+    assert !task.running?
+  end
+  
+  def test_task_passthrough
+    script = "echo " + "Hello World!".dump + " | #{TASK_PATH.realpath.to_s.dump}"
+    
+    RExec::Task.open(script, :passthrough => :all) do
+      
+    end
+
+    [$stdin, $stdout, $stderr].each do |io|
+      assert !io.closed?
+    end
+  end
+end