hydra 0.2.0 → 0.3.0

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/hydra.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hydra}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nick Gauthier"]
@@ -29,12 +29,15 @@ Gem::Specification.new do |s|
      "lib/hydra.rb",
      "lib/hydra/io.rb",
      "lib/hydra/message.rb",
-     "lib/hydra/message/runner_requests_file.rb",
+     "lib/hydra/message/runner_messages.rb",
      "lib/hydra/pipe.rb",
      "lib/hydra/runner.rb",
      "lib/hydra/ssh.rb",
      "test/echo_the_dolphin.rb",
      "test/helper.rb",
+     "test/sample_tests/assert_true.rb",
+     "test/sample_tests/write_file.rb",
+     "test/test_message.rb",
      "test/test_pipe.rb",
      "test/test_runner.rb",
      "test/test_ssh.rb"
@@ -47,8 +50,11 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/test_ssh.rb",
      "test/helper.rb",
+     "test/test_message.rb",
      "test/test_pipe.rb",
      "test/test_runner.rb",
+     "test/sample_tests/write_file.rb",
+     "test/sample_tests/assert_true.rb",
      "test/echo_the_dolphin.rb"
   ]
 

data/lib/hydra/io.rb

@@ -1,6 +1,12 @@
 module Hydra #:nodoc:
+  # Module that implemets methods that auto-serialize and deserialize messaging
+  # objects.
   module MessagingIO
-    # Read a line from the input IO object.
+    # Read a Message from the input IO object. Automatically build
+    # a message from the response and return it.
+    #
+    #  IO.gets
+    #    => Hydra::Message # or subclass
     def gets
       raise IOError unless @reader
       message = @reader.gets
@@ -8,7 +14,9 @@ module Hydra #:nodoc:
       return Message.build(eval(message.chomp))
     end
 
-    # Write a line to the output IO object
+    # Write a Message to the output IO object. It will automatically
+    # serialize a Message object.
+    #  IO.write Hydra::Message.new
     def write(message)
       raise IOError unless @writer
       raise UnprocessableMessage unless message.is_a?(Hydra::Message)
@@ -19,13 +27,18 @@ module Hydra #:nodoc:
       end
     end
 
+    # Closes the IO object.
     def close
       @reader.close if @reader
       @writer.close if @writer
     end
 
+    # IO will return this error if it cannot process a message.
+    # For example, if you tried to write a string, it would fail,
+    # because the string is not a message.
     class UnprocessableMessage < RuntimeError
       attr_accessor :message
+      # Allow a custom message for the exception.
       def initialize(message = "Message expected")
         @message = message    
       end

data/lib/hydra/message.rb

@@ -1,18 +1,44 @@
 module Hydra #:nodoc:
-  class Message #:nodoc:
+  # Base message object. Used to pass messages with parameters around
+  # via IO objects.
+  #   class MyMessage < Hydra::Message
+  #     attr_accessor :my_var
+  #     def serialize
+  #       super(:my_var => @my_var)
+  #     end
+  #   end
+  #   m = MyMessage.new(:my_var => 'my value')
+  #   m.my_var
+  #     => "my value"
+  #   m.serialize
+  #     => "{:class=>TestMessage::MyMessage, :my_var=>\"my value\"}"
+  #   Hydra::Message.build(eval(@m.serialize)).my_var
+  #     => "my value"
+  class Message
+    # Create a new message. Opts is a hash where the keys
+    # are attributes of the message and the values are
+    # set to the attribute.
     def initialize(opts = {})
-      opts.each do |k,v|
-        self.send(k,v)
+      opts.each do |variable,value|
+        self.send("#{variable}=",value)
       end
     end
+
+    # Build a message from a hash. The hash must contain
+    # the :class symbol, which is the class of the message
+    # that it will build to.
     def self.build(hash)
       hash.delete(:class).new(hash)
     end
 
+    # Serialize the message for output on an IO channel.
+    # This is really just a string representation of a hash
+    # with no newlines. It adds in the class automatically
     def serialize(opts = {})
-      opts[:class] = self.class
-      opts.inspect
+      opts.merge({:class => self.class}).inspect
     end
   end
 end
-require 'hydra/message/runner_requests_file'
+
+require 'hydra/message/runner_messages'
+

data/lib/hydra/message/runner_messages.rb

@@ -0,0 +1,36 @@
+module Hydra #:nodoc:
+  module Messages #:nodoc:
+    module Runner #:nodoc:
+      # Message indicating that a Runner needs a file to run
+      class RequestFile < Hydra::Message
+      end
+
+      # Message telling the Runner to run a file
+      class RunFile < Hydra::Message
+        attr_accessor :file
+        def serialize #:nodoc:
+          super(:file => @file)
+        end
+        def handle(runner) #:nodoc:
+          runner.run_file(@file)
+        end
+      end
+
+      # Message for the Runner to respond with its results
+      class Results < Hydra::Message
+        attr_accessor :output
+        attr_accessor :file
+        def serialize #:nodoc:
+          super(:output => @output, :file => @file)
+        end
+      end
+
+      # Message to tell the Runner to shut down
+      class Shutdown < Hydra::Message
+        def handle(runner) #:nodoc:
+          runner.stop
+        end
+      end
+    end
+  end
+end

data/lib/hydra/pipe.rb

@@ -2,15 +2,19 @@ require 'hydra/io'
 module Hydra #:nodoc:
   # Read and write between two processes via pipes. For example:
   #   @pipe = Hydra::Pipe.new
-  #   Process.fork do
+  #   @child = Process.fork do
   #     @pipe.identify_as_child
-  #     sleep(1)
-  #     puts "A message from my parent:\n#{@pipe.gets}"
+  #     puts "A message from my parent:\n#{@pipe.gets.text}"
   #     @pipe.close
   #   end
   #   @pipe.identify_as_parent
-  #   @pipe.write "Hello, Child!"
+  #   @pipe.write Hydra::Messages::TestMessage.new(:text => "Hello!")
   #   @pipe.close
+  #
+  # Note that the TestMessage class is only available in tests, and
+  # not in Hydra by default.
+  #
+  #
   # When the process forks, the pipe is copied. When a pipe is
   # identified as a parent or child, it is choosing which ends
   # of the pipe to use.

data/lib/hydra/runner.rb

@@ -1,8 +1,32 @@
 module Hydra #:nodoc:
+  # Hydra class responsible for running test files
   class Runner
+    # Boot up a runner. It takes an IO object (generally a pipe from its
+    # parent) to send it messages on which files to execute.
     def initialize(io)
       @io = io
-      @io.write Hydra::Messages::RunnerRequestsFile.new
+      @io.write Hydra::Messages::Runner::RequestFile.new
+      process_messages
+    end
+
+    # The runner will continually read messages and handle them.
+    def process_messages
+      @running = true
+      while @running
+        message = @io.gets
+        message.handle(self) if message
+      end
+    end
+
+    # Run a test file and report the results
+    def run_file(file)
+      `ruby #{file}`
+      @io.write Hydra::Messages::Runner::Results.new(:output => "Finished", :file => file)
+    end
+
+    # Stop running
+    def stop
+      @running = false
     end
   end
 end

data/lib/hydra/ssh.rb

@@ -2,20 +2,17 @@ require 'open3'
 require 'hydra/io'
 module Hydra #:nodoc:
   # Read and write with an ssh connection. For example:
-  #  @ssh = Hydra::SSH.new('nick@nite')
-  #  @ssh.write("echo hi")
-  #  puts @ssh.gets
-  #    => hi
+  #   @ssh = Hydra::SSH.new(
+  #     'localhost', # connect to this machine
+  #     '/home/user', # move to the home directory
+  #     "ruby hydra/test/echo_the_dolphin.rb" # run the echo script
+  #   )
+  #   @message = Hydra::Messages::TestMessage.new("Hey there!")
+  #   @ssh.write @message
+  #   puts @ssh.gets.text
+  #     => "Hey there!"
   #
-  # You can also use this to launch an interactive process. For
-  # example:
-  #  @ssh = Hydra::SSH.new('nick@nite')
-  #  @ssh.write('irb')
-  #  @ssh.write("5+3")
-  #  @ssh.gets
-  #    => "5+3\n"       # because irb echoes commands
-  #  @ssh.gets
-  #    => "8"           # the output from irb
+  # Note that what ever process you run should respond with Hydra messages.
   class SSH
     include Open3
     include Hydra::MessagingIO

data/test/helper.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'test/unit'
 require 'shoulda'
+require 'tmpdir'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))

data/test/sample_tests/assert_true.rb

@@ -0,0 +1,7 @@
+require File.join(File.dirname(__FILE__), '..', 'helper')
+
+class TestAssertTrue < Test::Unit::TestCase
+  should "be true" do
+    assert true
+  end
+end

data/test/sample_tests/write_file.rb

@@ -0,0 +1,10 @@
+require File.join(File.dirname(__FILE__), '..', 'helper')
+
+class TestWriteFile < Test::Unit::TestCase
+  should "write file" do
+    File.open(File.join(Dir.tmpdir, 'hydra_test.txt'), 'w') do |f|
+      f.write "HYDRA"
+    end
+  end
+end
+

data/test/test_message.rb

@@ -0,0 +1,31 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class TestMessage < Test::Unit::TestCase
+  class MyMessage < Hydra::Message
+    attr_accessor :my_var
+    def serialize
+      super(:my_var => @my_var)
+    end
+  end
+
+  context "with a message" do
+    setup do
+      @m = MyMessage.new(:my_var => 'my value')
+    end
+    should "set values" do
+      assert_equal 'my value', @m.my_var
+    end
+    should "serialize" do
+      assert_equal(
+        {:class=>TestMessage::MyMessage, :my_var=>"my value"},
+        eval(@m.serialize)
+      )
+    end
+    should "build from serialization" do
+      assert_equal(
+        @m.my_var,
+        Hydra::Message.build(eval(@m.serialize)).my_var
+      )
+    end
+  end
+end

data/test/test_runner.rb

@@ -11,14 +11,32 @@ class TestRunner < Test::Unit::TestCase
       @pipe.identify_as_parent
     end
     teardown do
+      @pipe.close
       Process.wait(@child)
     end
-    should "request a file on boot" do
-      assert @pipe.gets.is_a?(Hydra::Messages::RunnerRequestsFile)
+    should "boot and run a file and shut down" do
+      assert @pipe.gets.is_a?(Hydra::Messages::Runner::RequestFile)
+
+      file = File.join(File.dirname(__FILE__), 'sample_tests', 'assert_true.rb')
+      @pipe.write(Hydra::Messages::Runner::RunFile.new(:file => file))
+      response = @pipe.gets
+      assert response.is_a?(Hydra::Messages::Runner::Results)
+      assert response.output =~ /Finished/
+      assert_equal file, response.file
+      @pipe.write(Hydra::Messages::Runner::Shutdown.new)
     end
-    should "return a result message after processing a file" do
-      
+
+    should "run a test" do
+      target = File.join(Dir.tmpdir, 'hydra_test.txt')
+      FileUtils.rm_f(target)
+      assert !File.exists?(target)
+      file = File.join(File.dirname(__FILE__), 'sample_tests', 'write_file.rb')
+      assert @pipe.gets.is_a?(Hydra::Messages::Runner::RequestFile)
+      @pipe.write(Hydra::Messages::Runner::RunFile.new(:file => file))
+      response = @pipe.gets
+      @pipe.write(Hydra::Messages::Runner::Shutdown.new)
+      assert File.exists?(target)
+      assert_equal "HYDRA", File.read(target)
     end
-    should "terminate when sent a shutdown message"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hydra
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Nick Gauthier
@@ -54,12 +54,15 @@ files:
 - lib/hydra.rb
 - lib/hydra/io.rb
 - lib/hydra/message.rb
-- lib/hydra/message/runner_requests_file.rb
+- lib/hydra/message/runner_messages.rb
 - lib/hydra/pipe.rb
 - lib/hydra/runner.rb
 - lib/hydra/ssh.rb
 - test/echo_the_dolphin.rb
 - test/helper.rb
+- test/sample_tests/assert_true.rb
+- test/sample_tests/write_file.rb
+- test/test_message.rb
 - test/test_pipe.rb
 - test/test_runner.rb
 - test/test_ssh.rb
@@ -94,6 +97,9 @@ summary: Distributed testing toolkit
 test_files: 
 - test/test_ssh.rb
 - test/helper.rb
+- test/test_message.rb
 - test/test_pipe.rb
 - test/test_runner.rb
+- test/sample_tests/write_file.rb
+- test/sample_tests/assert_true.rb
 - test/echo_the_dolphin.rb

data/lib/hydra/message/runner_requests_file.rb

@@ -1,7 +0,0 @@
-module Hydra #:nodoc:
-  module Messages #:nodoc:
-    # Message indicating that a Runner needs a file to run
-    class RunnerRequestsFile < Hydra::Message
-    end
-  end
-end