royw-drbman 0.0.2 → 0.0.3

data/README.rdoc

@@ -3,11 +3,47 @@
 Support for running ruby tasks via drb (druby) on multiple cores and/or systems.
 
 Drbman provides:
-* the infrastructure for pushing ruby code to remote systems,
-* installing remote gems
+* the infrastructure for pushing drb servers to remote systems,
+* checking that gems are installed on remote systems,
 * starting and stopping the remote drb server(s)
-* cleaning up the remote system by removing any artifacts used
+* cleaning up the remote system by stopping and removing drb servers
 
+== Usage
+
+An article on using drbman is available at: http://royw.wordpress.com/2009/07/15/a-manager-for-drb/
+
+In a nut shell, write your drb server object then add:
+
+  require 'drbman_server'
+  
+  class YourServer
+    include DrbmanServer
+    ...
+  end
+  DrbmanServer.start_service(YourServer)
+
+
+Next in your client app set up: choices[:hosts], choices[:dirs], choices[:run], choices[:gems]
+
+Then create a Drbman instance and use it:
+
+  Drbman.new(@logger, choices) do |drbman|
+    loop do
+      drbman.get_object do |your_drb_server|
+        your_drb_server.your_method
+      end
+    end
+  end
+
+== Installation
+
+sudo gem install royw-drbman --source http://gems.github.com
+
+== Notes
+
+drbman uses yard comments so you can generate yard documents using:
+
+rake yardoc
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/drbman.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{drbman}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Roy Wright"]
-  s.date = %q{2009-07-16}
+  s.date = %q{2009-07-17}
   s.default_executable = %q{drbman}
   s.email = %q{roy@wright.org}
   s.executables = ["drbman"]
@@ -23,6 +23,8 @@ Gem::Specification.new do |s|
      "VERSION",
      "bin/drbman",
      "drbman.gemspec",
+     "examples/primes/LICENSE",
+     "examples/primes/README.rdoc",
      "examples/primes/VERSION",
      "examples/primes/bin/primes",
      "examples/primes/lib/drb_server/prime_helper.rb",
@@ -34,6 +36,7 @@ Gem::Specification.new do |s|
      "examples/primes/spec/primes_spec.rb",
      "examples/primes/spec/spec_helper.rb",
      "examples/primes/stress_test.rb",
+     "lib/drb_server/drbman_server.rb",
      "lib/drbman.rb",
      "lib/drbman/cli.rb",
      "lib/drbman/drb_pool.rb",

data/examples/primes/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Roy Wright
+
+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/examples/primes/README.rdoc

@@ -0,0 +1,42 @@
+= primes
+
+Primes is an example of using drbman to parallelize part of an application across one or more systems.
+
+== Usage
+
+N is the upper bound on the primes you want to find.  For example to
+find all primes below 200, N would be 200.
+
+single drb instance on localhost using ssh public key authentication:
+  bin/primes N
+or
+  bin/primes N -H localhost
+
+two drb instances on localhost using ssh public key authentication:
+  bin/primes N -H localhost,localhost
+
+three drb instances on remote hosts using ssh public key authentication:
+  bin/primes N -H one.example.com,two.example.com,three.example.com
+
+single drb instance on remote host using different account and ssh public key authentication:
+  bin/primes H -H username@example.com
+
+single drb instance on remote host using ssh passward authentication:
+  bin/primes H -H username:sekret@example.com
+
+help
+  bin/primes --help
+
+== Installation
+
+primes is installed as an example in drbman
+
+== Notes
+
+primes uses yard comments so you can generate yard documents using:
+
+rake yardoc
+
+== Copyright
+
+Copyright (c) 2009 Roy Wright. See LICENSE for details.

data/examples/primes/lib/drb_server/prime_helper.rb

@@ -1,4 +1,4 @@
-require 'drb'
+require 'drbman_server'
 
 # A helper object for calculating primes using the Sieve of Eratosthenes
 #
@@ -13,7 +13,7 @@ require 'drb'
 # will run the service as: druby://localhost:9000
 #
 class PrimeHelper
-  attr_accessor :name
+  include DrbmanServer
   
   # Find the multiples of the give prime number that are less than the 
   # given maximum.
@@ -27,18 +27,6 @@ class PrimeHelper
     2.upto((maximum - 1) / prime) { |i| a << (i * prime) }
     a
   end
-  
-  # Stop the DRb service
-  def stop_service
-    DRb.stop_service
-  end
 end
 
-machine = 'localhost'
-machine = ARGV[0] unless ARGV.length < 1
-port = 9000
-port = ARGV[1] unless ARGV.length < 2
-server = PrimeHelper.new
-server.name = "druby://#{machine}:#{port}"
-DRb.start_service(server.name, server)
-DRb.thread.join
+DrbmanServer.start_service(PrimeHelper)

data/examples/primes/lib/primes/cli.rb

@@ -1,3 +1,4 @@
+# The command line interface for running Primes
 class CLI < UserChoices::Command
   include UserChoices
   include Singleton

data/examples/primes/lib/primes/kernel_extensions.rb

@@ -1,4 +1,7 @@
 module Kernel
+  # adds a elapse time method
+  # @yield the block to find the execution elapsed time of
+  # @return [Float] the number of seconds the block took to execute
   def elapse(&block)
     seconds = 0
     unless block.nil?

data/examples/primes/lib/primes/primes.rb

@@ -1,7 +1,19 @@
-
+# == Synopsis
+# Calculate the prime numbers less than a given maximum integer.
+#
+#  @example
+#    choices = {}
+#    choices[:max_integer] = 20
+#    sieve = Primes.new(@logger, choices)
+#    primes = sieve.execute
+#    # primes => [2,3,5,7,11,13,17,19]
+#
+# Note, uses the Command design pattern
 class Primes 
   attr_reader :primes_elapse_time
-  
+
+  # @param [Logger] logger the logger to use
+  # @param choices {see SieveOfEratosthenes#Initialize}
   def initialize(logger, choices)
     @logger = logger
     @user_choices = choices
@@ -14,6 +26,4 @@ class Primes
     @primes_elapse_time = sieve.primes_elapse_time
     result
   end
-  
-
 end

data/examples/primes/lib/primes/sieve_of_eratosthenes.rb

@@ -52,6 +52,10 @@ class SieveOfEratosthenes
   
   private
   
+  # recursive prime calculation
+  # @param maximum (see #initialize)
+  # @param [Drbman] drbman the drb manager instance
+  # @return [Array<Integer>] the array of primes
   def primes(maximum, drbman)
     indices = []
     if maximum > 2
@@ -62,11 +66,14 @@ class SieveOfEratosthenes
     indices
   end
 
-  # when n = 20
-  # sqr_primes = [2,3]
-  # composites = [[2*2, 2*3, 2*4,...,2*9], [3*2, 3*3, 3*4,...,3*6]]
-  # returns Array
+  # find the composites array
+  # @param maximum (see #initialize)
+  # @param drbman (see #primes)
+  # @return [Array<Integer>] the composites array
   def calc_composites(maximum, drbman)
+    # when n = 20
+    # sqr_primes = [2,3]
+    # composites = [[2*2, 2*3, 2*4,...,2*9], [3*2, 3*3, 3*4,...,3*6]]
     sqr_primes = primes(Math.sqrt(maximum).to_i, drbman)
     composites = []
     threads = []
@@ -87,6 +94,9 @@ class SieveOfEratosthenes
     composites
   end
   
+  # sift the indices to find the primes
+  # @param [Array<Integer>] flat_comps the flattened composites array
+  # @param maximum (see #initialize)
   def calc_indices(flat_comps, maximum)
     indices = []
     flags = Array.new(maximum, true)

data/lib/drb_server/drbman_server.rb

@@ -0,0 +1,22 @@
+require 'drb'
+
+module DrbmanServer
+  attr_accessor :name
+  # Stop the DRb service
+  def stop_service
+    DRb.stop_service
+  end
+  
+  def start_service(klass)
+    machine = 'localhost'
+    machine = ARGV[0] unless ARGV.length < 1
+    port = 9000
+    port = ARGV[1] unless ARGV.length < 2
+    server = klass.new
+    server.name = "druby://#{machine}:#{port}"
+    # puts server.inspect
+    DRb.start_service(server.name, server)
+    DRb.thread.join
+  end
+  module_function :start_service
+end

data/lib/drbman.rb

@@ -20,6 +20,7 @@ require 'net/ssh'
 require 'net/scp'
 require 'daemons'
 require 'uuidtools'
+require 'tempfile'
 
 # require all of the .rb files in the drbman/ subdirectory
 Dir.glob(File.join(File.dirname(__FILE__), 'drbman/**/*.rb')).each do |name| 

data/lib/drbman/cli.rb

@@ -1,7 +1,7 @@
 # require 'commandline/optionparser'
 
 # == Synopsis
-# The Command Line Interface
+# The Command Line Interface for Drbman
 class CLI < UserChoices::Command
   include UserChoices
   include Singleton

data/lib/drbman/drbman.rb

@@ -164,14 +164,20 @@ class Drbman
       end
     end
   end
-
+  
   # Create the daemon controller on the host machine
   # @param [HostMachine] host the host machine
   def create_controller(host)
     unless @user_choices[:run].blank?
       host.controller = File.basename(@user_choices[:run], '.*') + '_controller.rb'
-      controller = "require 'rubygems' ; require 'daemons' ; Daemons.run('#{@user_choices[:run]}')"
-      host.sh("cd #{host.dir};echo \"#{controller}\" > #{host.controller}")
+      tempfile = Tempfile.new('controller')
+      tempfile.puts "require 'rubygems'"
+      tempfile.puts "require 'daemons'"
+      tempfile.puts "$LOAD_PATH.unshift(File.expand_path(File.dirname('#{@user_choices[:run]}')))"
+      tempfile.puts "Daemons.run('#{@user_choices[:run]}')"
+      tempfile.close
+      host.upload(tempfile.path, host.dir)
+      host.sh("cd #{host.dir};mv #{File.basename(tempfile.path)} #{host.controller}")
     end
   end
   
@@ -180,9 +186,11 @@ class Drbman
   # @param [HostMachine] host the host machine
   def upload_dirs(host)
     unless @user_choices[:dirs].blank?
+      drb_server_file = File.join(File.dirname(__FILE__), "../drb_server/drbman_server.rb")
       @user_choices[:dirs].each do |name|
         if File.directory?(name)
           host.upload(name, "#{host.dir}/#{File.basename(name)}")
+          host.upload(drb_server_file, "#{host.dir}/#{File.basename(name)}")
         else
           @logger.error { "\"#{name}\" is not a directory" }
         end

data/lib/drbman/host_machine.rb

@@ -73,6 +73,8 @@ class HostMachine
         connect
       end
       yield self
+    rescue Net::SSH::AuthenticationFailed => e
+      @logger.error { "Authentication Failed" }
     rescue Exception => e
       @logger.error { e }
       @logger.error { e.backtrace.join("\n") }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: royw-drbman
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Roy Wright
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-16 00:00:00 -07:00
+date: 2009-07-17 00:00:00 -07:00
 default_executable: drbman
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -90,6 +90,8 @@ files:
 - VERSION
 - bin/drbman
 - drbman.gemspec
+- examples/primes/LICENSE
+- examples/primes/README.rdoc
 - examples/primes/VERSION
 - examples/primes/bin/primes
 - examples/primes/lib/drb_server/prime_helper.rb
@@ -101,6 +103,7 @@ files:
 - examples/primes/spec/primes_spec.rb
 - examples/primes/spec/spec_helper.rb
 - examples/primes/stress_test.rb
+- lib/drb_server/drbman_server.rb
 - lib/drbman.rb
 - lib/drbman/cli.rb
 - lib/drbman/drb_pool.rb