hydra 0.1.1 → 0.2.0

data/TODO

@@ -0,0 +1,54 @@
+# runners = []
+# cores.each do |c|
+#   in = pipes[c][0]
+#   out = pipes[c][1]
+#   runners << TestRunner.new(in, out)
+# end
+#
+# files = [ ... ]
+# results = []
+#
+# runners.each do |r|
+#   Thread.new do
+#     while !files.empty?
+#       results << r.run_file(files.pop)
+#     end
+#     r.shutdown
+#   end
+# end
+#
+# puts results.join("\n")
+#
+
+
+# Master
+# boot up workers
+# listen for worker messages
+# add worker messages to message queue
+# process message queue
+# "reply" to a message allows sending a message back down to worker
+#
+# When worker asks for file but no files left, send shutdown message to worker
+# when worker connection breaks, end thread
+# wait on all threads
+# when all threads are done, all workers must be done
+#
+#
+# Worker
+# boot up runners
+# listen for runner messages
+# add runner messages to message queue
+# process message queue
+# "reply" to a message allows sending message back down to runner
+#
+# when a runner asks for file but master responds with shutdown, mark self
+#   as terminated, shut down runners. Any runner that asks for a file is
+#   auto-terminated
+# wait for runner threads to finish
+# then exit, breaking master connection
+#
+# Runner
+# when booted, ask for a file
+# then process messages on the queue
+# when it's a file, run it and send a results message
+# when it's a shutdown, break main loop

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/hydra.gemspec

@@ -5,16 +5,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hydra}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nick Gauthier"]
-  s.date = %q{2010-01-26}
+  s.date = %q{2010-01-27}
   s.description = %q{Spread your tests over multiple machines to test your code faster.}
   s.email = %q{nick@smartlogicsolutions.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.rdoc",
+     "TODO"
   ]
   s.files = [
     ".document",
@@ -22,14 +23,20 @@ Gem::Specification.new do |s|
      "LICENSE",
      "README.rdoc",
      "Rakefile",
+     "TODO",
      "VERSION",
      "hydra.gemspec",
      "lib/hydra.rb",
+     "lib/hydra/io.rb",
+     "lib/hydra/message.rb",
+     "lib/hydra/message/runner_requests_file.rb",
      "lib/hydra/pipe.rb",
+     "lib/hydra/runner.rb",
      "lib/hydra/ssh.rb",
      "test/echo_the_dolphin.rb",
      "test/helper.rb",
      "test/test_pipe.rb",
+     "test/test_runner.rb",
      "test/test_ssh.rb"
   ]
   s.homepage = %q{http://github.com/ngauthier/hydra}
@@ -41,6 +48,7 @@ Gem::Specification.new do |s|
     "test/test_ssh.rb",
      "test/helper.rb",
      "test/test_pipe.rb",
+     "test/test_runner.rb",
      "test/echo_the_dolphin.rb"
   ]
 

data/lib/hydra.rb

@@ -1,2 +1,5 @@
 require 'hydra/pipe'
 require 'hydra/ssh'
+require 'hydra/message'
+require 'hydra/runner'
+

data/lib/hydra/io.rb

@@ -0,0 +1,34 @@
+module Hydra #:nodoc:
+  module MessagingIO
+    # Read a line from the input IO object.
+    def gets
+      raise IOError unless @reader
+      message = @reader.gets
+      return nil unless message
+      return Message.build(eval(message.chomp))
+    end
+
+    # Write a line to the output IO object
+    def write(message)
+      raise IOError unless @writer
+      raise UnprocessableMessage unless message.is_a?(Hydra::Message)
+      begin
+        @writer.write(message.serialize+"\n")
+      rescue Errno::EPIPE
+        raise IOError
+      end
+    end
+
+    def close
+      @reader.close if @reader
+      @writer.close if @writer
+    end
+
+    class UnprocessableMessage < RuntimeError
+      attr_accessor :message
+      def initialize(message = "Message expected")
+        @message = message    
+      end
+    end
+  end
+end

data/lib/hydra/message.rb

@@ -0,0 +1,18 @@
+module Hydra #:nodoc:
+  class Message #:nodoc:
+    def initialize(opts = {})
+      opts.each do |k,v|
+        self.send(k,v)
+      end
+    end
+    def self.build(hash)
+      hash.delete(:class).new(hash)
+    end
+
+    def serialize(opts = {})
+      opts[:class] = self.class
+      opts.inspect
+    end
+  end
+end
+require 'hydra/message/runner_requests_file'

data/lib/hydra/message/runner_requests_file.rb

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

data/lib/hydra/pipe.rb

@@ -1,3 +1,4 @@
+require 'hydra/io'
 module Hydra #:nodoc:
   # Read and write between two processes via pipes. For example:
   #   @pipe = Hydra::Pipe.new
@@ -24,31 +25,11 @@ module Hydra #:nodoc:
   # One tube is for sending from parent to child, and the other
   # tube is for sending from child to parent.
   class Pipe
+    include Hydra::MessagingIO
     # Creates a new uninitialized pipe pair.
     def initialize
       @child_read, @parent_write = IO.pipe
       @parent_read, @child_write = IO.pipe
-      [@parent_write, @child_write].each{|io| io.sync = true}
-    end
-
-    # Read a line from a pipe. It will have a trailing newline.
-    def gets
-      force_identification
-      @reader.gets.chomp
-    end
-
-    # Write a line to a pipe. It must have a trailing newline.
-    def write(str)
-      force_identification
-      unless str =~ /\n$/
-        str += "\n"
-      end
-      begin
-        @writer.write(str)
-        return str
-      rescue Errno::EPIPE
-        raise Hydra::PipeError::Broken
-      end
     end
 
     # Identify this side of the pipe as the child.
@@ -66,43 +47,5 @@ module Hydra #:nodoc:
       @reader = @parent_read
       @writer = @parent_write
     end
-
-    # closes the pipes. Once a pipe is closed on one end, the other
-    # end will get a PipeError::Broken if it tries to write.
-    def close
-      done_reading
-      done_writing
-    end
-
-    private
-    def done_writing #:nodoc:
-      @writer.close unless @writer.closed?
-    end
-
-    def done_reading #:nodoc:
-      @reader.close unless @reader.closed?
-    end
-
-    def force_identification #:nodoc:
-      raise PipeError::Unidentified if @reader.nil? or @writer.nil?
-    end
-  end
-
-  module PipeError #:nodoc:
-    # Raised if you try to read or write to a pipe when it is unidentified.
-    # Use identify_as_parent and identify_as_child to identify a pipe.
-    class Unidentified < RuntimeError
-      def message #:nodoc:
-        "Must identify as child or parent"
-      end
-    end
-    # Raised when a pipe has been broken between two processes.
-    # This happens when a process exits, and is a signal that
-    # there is no more data to communicate.
-    class Broken < RuntimeError
-      def message #:nodoc:
-        "Other side closed the connection"
-      end
-    end
   end
 end

data/lib/hydra/runner.rb

@@ -0,0 +1,8 @@
+module Hydra #:nodoc:
+  class Runner
+    def initialize(io)
+      @io = io
+      @io.write Hydra::Messages::RunnerRequestsFile.new
+    end
+  end
+end

data/lib/hydra/ssh.rb

@@ -1,4 +1,5 @@
 require 'open3'
+require 'hydra/io'
 module Hydra #:nodoc:
   # Read and write with an ssh connection. For example:
   #  @ssh = Hydra::SSH.new('nick@nite')
@@ -17,6 +18,7 @@ module Hydra #:nodoc:
   #    => "8"           # the output from irb
   class SSH
     include Open3
+    include Hydra::MessagingIO
 
     # Initialize new SSH connection. The single parameters is passed
     # directly to ssh for starting a connection. So you can do:
@@ -24,25 +26,10 @@ module Hydra #:nodoc:
     #  Hydra::SSH.new('user@server.com')
     #  Hydra::SSH.new('-p 3022 user@server.com')
     # etc..
-    def initialize(connection_options)
-      @stdin, @stdout, @stderr = popen3("ssh #{connection_options}")
-    end
-
-    # Write a string to ssh. This method returns the string passed to
-    # ssh. Note that if you do not add a newline at the end, it adds
-    # one for you, and the modified string is returned
-    def write(str)
-      unless str =~ /\n$/
-        str += "\n"
-      end
-      @stdin.write(str)
-      return str
-    end
-
-    # Read a line from ssh. This call blocks when there is nothing
-    # to read.
-    def gets
-      @stdout.gets.chomp
+    def initialize(connection_options, directory, command)
+      @writer, @reader, @error = popen3("ssh #{connection_options}")
+      @writer.write("cd #{directory}\n")
+      @writer.write(command+"\n")
     end
   end
 end

data/test/echo_the_dolphin.rb

@@ -1,10 +1,6 @@
 #!/usr/bin/env ruby
-# read lines from stdin
-# echo each line back
-# on EOF, quit nicely
-
+# Echoes back to the sender
 $stdout.sync = true
-
 while line = $stdin.gets
   $stdout.write(line)
 end

data/test/helper.rb

@@ -8,3 +8,18 @@ require 'hydra'
 
 class Test::Unit::TestCase
 end
+
+module Hydra #:nodoc:
+  module Messages #:nodoc:
+    class TestMessage < Hydra::Message
+      attr_accessor :text
+      def initialize(opts = {})
+        @text = opts.fetch(:text){ "test" }
+      end
+      def serialize
+        super(:text => @text)
+      end
+    end
+  end
+end
+

data/test/test_pipe.rb

@@ -5,40 +5,34 @@ class TestPipe < Test::Unit::TestCase
     setup do
       @pipe = Hydra::Pipe.new
     end
+    teardown do
+      @pipe.close
+    end
     should "be able to write messages" do
-      Process.fork do
+      child = Process.fork do
         @pipe.identify_as_child
-        assert_equal "Test Message", @pipe.gets
-        @pipe.write "Message Received"
-        @pipe.write "Second Message"
-        @pipe.close
+        assert_equal "Test Message", @pipe.gets.text
+        @pipe.write Hydra::Messages::TestMessage.new(:text => "Message Received")
+        @pipe.write Hydra::Messages::TestMessage.new(:text => "Second Message")
       end
       @pipe.identify_as_parent
-      @pipe.write "Test Message"
-      assert_equal "Message Received", @pipe.gets
-      assert_equal "Second Message", @pipe.gets
-      assert_raise Hydra::PipeError::Broken do
-        @pipe.write "anybody home?"
+      @pipe.write Hydra::Messages::TestMessage.new(:text => "Test Message")
+      assert_equal "Message Received", @pipe.gets.text
+      assert_equal "Second Message", @pipe.gets.text
+      Process.wait(child) #ensure it quits, so there is nothing to write to
+      assert_raise IOError do
+        @pipe.write Hydra::Messages::TestMessage.new(:text => "anyone there?")
       end
-      @pipe.close
     end
     should "not allow writing if unidentified" do
-      assert_raise Hydra::PipeError::Unidentified do
-        @pipe.write "hey\n"
+      assert_raise IOError do
+        @pipe.write Hydra::Messages::TestMessage.new(:text => "Test Message")
       end
     end
     should "not allow reading if unidentified" do
-      assert_raise Hydra::PipeError::Unidentified do
+      assert_raise IOError do
         @pipe.gets
       end
     end
-    should "handle newlines" do
-      Process.fork do
-        @pipe.identify_as_child
-        @pipe.write "Message\n"
-      end
-      @pipe.identify_as_parent
-      assert_equal "Message", @pipe.gets
-    end
   end
 end

data/test/test_runner.rb

@@ -0,0 +1,24 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class TestRunner < Test::Unit::TestCase
+  context "a test runner" do
+    setup do
+      @pipe = Hydra::Pipe.new
+      @child = Process.fork do
+        @pipe.identify_as_child
+        Hydra::Runner.new(@pipe)
+      end
+      @pipe.identify_as_parent
+    end
+    teardown do
+      Process.wait(@child)
+    end
+    should "request a file on boot" do
+      assert @pipe.gets.is_a?(Hydra::Messages::RunnerRequestsFile)
+    end
+    should "return a result message after processing a file" do
+      
+    end
+    should "terminate when sent a shutdown message"
+  end
+end

data/test/test_ssh.rb

@@ -3,27 +3,19 @@ require File.join(File.dirname(__FILE__), 'helper')
 class TestSSH < Test::Unit::TestCase
   context "an ssh connection" do
     setup do
-      @ssh = Hydra::SSH.new('localhost')
-    end
-    should "be able to execute a command" do
-      @ssh.write "echo hi"
-      assert_equal "hi", @ssh.gets
+      @ssh = Hydra::SSH.new(
+        'localhost', # connect to this machine
+        File.expand_path(File.join(File.dirname(__FILE__))), # move to the test directory
+        "ruby ./echo_the_dolphin.rb"
+      )
+      @message = Hydra::Messages::TestMessage.new
     end
-    should "be able to execute a command with a newline" do
-      @ssh.write "echo hi\n"
-      assert_equal "hi", @ssh.gets
+    teardown do
+      @ssh.close
     end
-    should "be able to communicate with a process" do
-      pwd = File.dirname(__FILE__)
-      echo_the_dolphin = File.expand_path(
-        File.join(File.dirname(__FILE__), 'echo_the_dolphin.rb')
-      )
-      @ssh.write('ruby -e "puts \'Hello\'"')
-      assert_equal "Hello", @ssh.gets
-
-      @ssh.write("ruby #{echo_the_dolphin}")
-      @ssh.write("Hello Echo!")
-      assert_equal "Hello Echo!", @ssh.gets
+    should "be able to execute a command" do
+      @ssh.write @message 
+      assert_equal @message.text, @ssh.gets.text
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hydra
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Nick Gauthier
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-26 00:00:00 -05:00
+date: 2010-01-27 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,20 +41,27 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE
 - README.rdoc
+- TODO
 files: 
 - .document
 - .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
+- TODO
 - VERSION
 - hydra.gemspec
 - lib/hydra.rb
+- lib/hydra/io.rb
+- lib/hydra/message.rb
+- lib/hydra/message/runner_requests_file.rb
 - lib/hydra/pipe.rb
+- lib/hydra/runner.rb
 - lib/hydra/ssh.rb
 - test/echo_the_dolphin.rb
 - test/helper.rb
 - test/test_pipe.rb
+- test/test_runner.rb
 - test/test_ssh.rb
 has_rdoc: true
 homepage: http://github.com/ngauthier/hydra
@@ -88,4 +95,5 @@ test_files:
 - test/test_ssh.rb
 - test/helper.rb
 - test/test_pipe.rb
+- test/test_runner.rb
 - test/echo_the_dolphin.rb