easy-serve 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa7e317b0835fcccb71074755f7c440a36eb97c5
-  data.tar.gz: f1473351a5081398d0c1a8dc4fe424555cbe7a8b
+  metadata.gz: 969ade3d5e6c485793ca23d6ef8f7b0acb158d10
+  data.tar.gz: 41691d84a7c64a1d0139b2a7e2245df8828e4f19
 SHA512:
-  metadata.gz: 3f5ee396c21115e4d691c15409aa47f07ca9947a82753e33db9663f21e58ba0930f53541a193095b9705a44d14d96018ad6c03c38a187c407379d90196c7c1ac
-  data.tar.gz: b4027e51407e2070ec4039f70fda510cc5b8a22e5aae5396de86c360e2c2366840f9436bd84d313fc0b2ead5df016c4ff7cd4c83276d719512da868a82a64123
+  metadata.gz: 7d5ade10938afc5541a00fd21a4f6fd24ecae7834e2465d13cd6aac2956ae1d23ed5b3bb464f901364e56844638ce56f5c65d902e69f8c719b4f8937ac086061
+  data.tar.gz: 4d5896f0406a5a2d8ece78002ed7dccaaea1cfa233e685d0ed5c72d3b9434a9a8aeae0803437f56aec13d2c87e21ec0c35ee724043083f0881d40c3ce7f4814c

data/README.md

@@ -1,4 +1,4 @@
 easy-serve
 ==========
 
-Framework for starting tcp/unix servers and connected clients under one parent process.
+Framework for starting tcp/unix servers and connected clients under one parent process and on remote hosts.

data/examples/multi.rb

@@ -26,7 +26,7 @@ EasyServe.start servers_file: servers_file do |ez|
     end
   end
   
-  ez.client "simple-server" do |conn|
+  ez.child "simple-server" do |conn|
     log.progname = "client with pid=#$$"
     log.info conn.read
     conn.write "hello from #{log.progname}"

data/examples/passive.rb

@@ -21,7 +21,7 @@ EasyServe.start do |ez|
     end
   end
   
-  ez.client "simple-server", passive: true do |conn|
+  ez.child "simple-server", passive: true do |conn|
     log.progname = "client 1"
     log.info conn.read
     conn.write "hello from #{log.progname}, pid = #$$; sleeping..."
@@ -31,7 +31,7 @@ EasyServe.start do |ez|
   
   sleep 0.1
   
-  ez.client "simple-server" do |conn|
+  ez.child "simple-server" do |conn|
     log.progname = "client 2"
     log.info conn.read
     conn.write "hello from #{log.progname}, pid = #$$"

data/examples/remote-eval-passive.rb

@@ -0,0 +1,78 @@
+require 'easy-serve/remote'
+
+addr_there = ARGV.shift
+
+unless addr_there
+  abort <<-END
+
+    Usage: #$0 addr_there
+
+    The 'addr_there' is the remote address on which client code will run.
+    It must be a destination accepted by ssh, optionally including a user name:
+
+      [user@]hostname
+    
+    The 'hostname' may by any valid hostname or ssh alias.
+
+  END
+end
+
+EasyServe.start do |ez|
+  log = ez.log
+  log.level = Logger::INFO
+  log.formatter = nil if $VERBOSE
+
+  ez.start_servers do
+    ez.server "simple-server", :tcp, nil, 0 do |svr|
+      Thread.new do
+        loop do
+          Thread.new(svr.accept) do |conn|
+            log.info "accepted connection from #{conn.inspect}"
+            conn.write "hello from #{log.progname}"
+            log.info "wrote greeting"
+            conn.close_write
+            log.info "trying to read from #{conn.inspect}"
+            log.info "received: #{conn.read}"
+            conn.close
+          end
+        end
+      end
+    end
+  end
+
+  ez.remote "simple-server", host: addr_there, log: true, passive: true,
+    eval: %{
+    conn = conns[0]
+    # this code is executed on the remote host, connected by conn, not drb
+    log.progname = "eval remote 1 (passive) on \#{host}"
+    log.info "trying to read from \#{conn.inspect}"
+    log.info "received: \#{conn.read}"
+    conn.write "hello from \#{log.progname}"
+    conn.close
+    
+    sleep
+      # Without passive, this sleep would prevent the distributed app from
+      # exiting -- the simple-server above could not be safely stopped, since
+      # there's no guarantee that it is no longer needed. The passive
+      # declaration make it clear that this process can be stopped after all
+      # non-passive clients have finished, and then the server can be stopped.
+      # Of course, this also means that if all other clients execute very
+      # quickly, this client might never get a chance to run.
+  }
+  
+  sleep 1 # Ensure (for testing) that the above client runs.
+  
+  ez.remote "simple-server", host: addr_there, log: true, eval: %{
+    conn = conns[0]
+    # this code is executed on the remote host, connected by conn, not drb
+    log.progname = "eval remote 2 on \#{host}"
+    log.info "trying to read from \#{conn.inspect}"
+    log.info "received: \#{conn.read}"
+    conn.write "hello from \#{log.progname}"
+    conn.close
+  }
+  # Note use of \#{} to interpolate variables that are only available
+  # in the binding where the code is eval-ed. Alternately, use
+  #   eval: %Q{...}
+  # but then interpolation from this script is not posssible.
+end

data/examples/remote-eval.rb

@@ -40,7 +40,7 @@ EasyServe.start do |ez|
     end
   end
 
-  ez.remote "simple-server", host: addr_there, eval: %{
+  ez.remote "simple-server", host: addr_there, log: true, eval: %{
     conn = conns[0]
     # this code is executed on the remote host, connected by conn, not drb
     log.progname = "eval remote on \#{host}"

data/examples/remote-run-script.rb

@@ -10,7 +10,7 @@ class RemoteRunScript
   
   def run
     conn = conns[0]
-    log.progname = "run remote on #{host}"
+    log.progname = "run remote on #{host} with args #{args}"
     log.info "trying to read from #{conn.inspect}"
     log.info "received: #{conn.read}"
     conn.write "hello from #{log.progname}"

data/examples/remote-run.rb

@@ -49,5 +49,9 @@ EasyServe.start do |ez|
     file: "remote-run-script.rb",
       # 'file' passed to load, so can be rel to dir or ruby's $LOAD_PATH
     class_name: "RemoteRunScript",
-    args: []
+    args: ["foo", "bar", 1, 2, 3],
+    log: true # use the default logger, sending log messages back to local
+    #log: false # don't log
+    #log: ["remote-run.log", "weekly"]
+      # log to a remote file with rotation (like Logger.new(...) )
 end

data/examples/simple.rb

@@ -20,7 +20,7 @@ EasyServe.start do |ez|
     end
   end
   
-  ez.client "simple-server" do |conn|
+  ez.child "simple-server" do |conn|
     log.progname = "client 1"
     log.info conn.read
     conn.write "hello from #{log.progname}"

data/lib/easy-serve.rb

@@ -4,7 +4,7 @@ require 'yaml'
 require 'fileutils'
 
 class EasyServe
-  VERSION = "0.4"
+  VERSION = "0.5"
 
   class Server
     attr_reader :name, :pid, :addr
@@ -36,8 +36,8 @@ class EasyServe
 
   attr_accessor :log
   attr_accessor :servers
-  attr_reader :clients
-  attr_reader :passive_clients
+  attr_reader :children
+  attr_reader :passive_children
   attr_reader :servers_file
   attr_reader :interactive
   
@@ -55,9 +55,10 @@ class EasyServe
     @servers_file = opts[:servers_file]
     @interactive = opts[:interactive]
     @log = opts[:log] || self.class.null_logger
-    @clients = [] # pid
-    @passive_clients = [] # pid
+    @children = [] # pid
+    @passive_children = [] # pid
     @owner = false
+    @tmpdir = nil
     @servers = opts[:servers] # name => Server
     
     unless servers
@@ -92,7 +93,7 @@ class EasyServe
       trap("INT", handler)
     end
 
-    clients.each do |pid|
+    children.each do |pid|
       log.debug {"waiting for client pid=#{pid} to stop"}
       begin
         Process.waitpid pid
@@ -101,7 +102,7 @@ class EasyServe
       end
     end
 
-    passive_clients.each do |pid|
+    passive_children.each do |pid|
       log.debug {"stopping client pid=#{pid}"}
       Process.kill("TERM", pid)
       begin
@@ -251,20 +252,29 @@ class EasyServe
         raise ArgumentError, "unknown server_class: #{server_class.inspect}"
       end
       raise
+
+    rescue => ex
+      ex.message << "; addr=#{server_addr.inspect}"
+      raise
     end
   end
 
-  # A passive client may be stopped after all active clients exit.
-  def client *server_names, passive: false
+  # A passive client child may be stopped after all active clients exit.
+  def child *server_names, passive: false
     c = fork do
       conns = server_names.map {|sn| socket_for(*servers[sn].addr)}
       yield(*conns) if block_given?
       no_interrupt_if_interactive
     end
-    (passive ? passive_clients : clients) << c
+    (passive ? passive_children : children) << c
     c
   end
   
+  def client *args, &block
+    warn "EasyServe#client is deprecated; use #child"
+    child *args, &block
+  end
+  
   def local *server_names
     conns = server_names.map {|sn| socket_for(*servers[sn].addr)}
     yield(*conns) if block_given?
@@ -283,7 +293,7 @@ class EasyServe
       end
     socket_class.new(*addr)
   rescue => ex
-    ex.message << " addr=#{addr.inspect}"
+    ex.message << "; addr=#{addr.inspect}"
     raise
   end
 

data/lib/easy-serve/remote-drb.rb

@@ -1,9 +1,12 @@
 require 'drb'
 
 class EasyServe
-  # useful for testing only -- use _eval or _run for production
+  # useful for testing only -- use _eval or _run for production.
+  # Note: as with #local, the code block runs in the main thread, by default.
+  # It's up to you to start another thread inside the code block if you
+  # want more concurrency. This is for convenience when testing (cases in which
+  # concurrency needs to be controlled explicitly).
   def remote_drb *server_names, host: nil
-    ## passive option?
     ## remote logfile option?
 
     DRb.start_service("druby://#{host_name}:0", nil)

data/lib/easy-serve/remote-eval-mgr.rb

@@ -0,0 +1,66 @@
+require 'msgpack'
+require 'easy-serve'
+
+def manage_remote_eval_client msg
+  $VERBOSE = msg["verbose"]
+  server_names, servers_list, log_level, eval_string, host =
+    msg.values_at(*%w{server_names servers_list log_level eval_string host})
+
+  servers = {}
+  servers_list.each do |name, pid, addr|
+    servers[name] = EasyServe::Server.new(name, pid, addr)
+  end
+  
+  log_args = msg["log"]
+  log =
+    case log_args
+    when Array
+      Logger.new(*log_args)
+    when true
+      EasyServe.default_logger
+    when nil, false
+      EasyServe.null_logger
+    end
+
+  EasyServe.start servers: servers, log: log do |ez|
+    log = ez.log
+    log.level = log_level
+    log.formatter = nil if $VERBOSE
+
+    ez.local *server_names do |*conns|
+      begin
+        pr = eval "proc do |conns, host, log| #{eval_string}; end"
+        pr[conns, host, log]
+      rescue => ex
+        puts "ez error", ex, ex.backtrace
+      end
+    end
+    
+    log.info "done"
+  end
+rescue => ex
+  puts "ez error", ex, ex.backtrace
+end
+
+$stdout.sync = true
+
+def handle_remote_eval_messages
+  unpacker = MessagePack::Unpacker.new($stdin)
+  unpacker.each do |msg|
+    case
+    when msg["server_names"]
+      Thread.new {manage_remote_eval_client(msg); exit}
+    when msg["exit"]
+      puts "exiting"
+      exit
+    when msg["request"]
+      response = self.send(*msg["command"])
+      puts "response: #{response.inspect}"
+    else
+      puts "unhandled: #{msg.inspect}"
+    end
+  end
+
+rescue => ex
+  puts "ez error", ex, ex.backtrace
+end

data/lib/easy-serve/remote-eval.rb

@@ -1,63 +1,54 @@
+require 'msgpack'
+
 class EasyServe
   # useful simple cases in testing and in production, but long eval strings
-  # can be hard to debug -- use _run instead
-  def remote_eval *server_names, host: nil, **opts
-    ## passive option?
-    ## remote logfile option?
+  # can be hard to debug -- use _run instead. Returns pid of child managing
+  # the ssh connection.
+  #
+  # Note, unlike #local and #child, by default logging goes to the null logger.
+  # If you want too see logs from the remote, you need to choose:
+  #
+  # 1. Log to remote file: pass log: [args...] with args as in Logger.new
+  #
+  # 2. Log back over ssh: pass log: true.
+  #
+  def remote_eval *server_names, host: nil, passive: false, **opts
+    child_pid = fork do
+      log.progname = "remote_eval #{host}"
 
-    log.progname = "remote_eval #{host}"
+      IO.popen [
+        "ssh", host, "ruby",
+        "-r", "easy-serve/remote-eval-mgr",
+        "-e", "handle_remote_eval_messages"],
+               "w+" do |ssh|
+        ssh.sync = true
 
-    IO.popen ["ssh", host, "ruby"], "w+" do |ssh|
-      ssh.puts %Q{
-        $stdout.sync = true
-        begin
-          require 'yaml'
-          require 'easy-serve'
- 
-          class EasyServe
-            def binding_for_remote_eval conns, host, log
-              binding
-            end
-          end
-          
-          server_names = #{server_names.inspect}
-          servers = YAML.load(#{YAML.dump(servers).inspect})
-          log_level = #{log.level}
-          eval_string = #{opts[:eval].inspect}
-          host = #{host.inspect}
-          
-          EasyServe.start servers: servers do |ez|
-            log = ez.log
-            log.level = log_level
-            log.formatter = nil if $VERBOSE
+        servers_list = servers.map {|n, s| [s.name, s.pid, s.addr]}
 
-            ez.local *server_names do |*conns|
-              begin
-                eval eval_string, ez.binding_for_remote_eval(conns, host, log)
-              rescue => ex
-                puts "ez error", ex, ex.backtrace
-              end
-            end
-          end
-        rescue => ex
-          puts "ez error", ex, ex.backtrace
-        end
-      }
-      
-      ssh.close_write
-      result = ssh.gets
-      
-      if result
-        error = result[/ez error/]
-        if error
-          raise RemoteError, "error raised in remote: #{ssh.read}"
-        else
-          puts result
-          while s = ssh.gets
+        MessagePack.pack(
+          {
+            verbose:      $VERBOSE,
+            server_names: server_names,
+            servers_list: servers_list,
+            log_level:    log.level,
+            eval_string:  opts[:eval],
+            host:         host,
+            log:          opts[:log]
+          },
+          ssh)
+
+        while s = ssh.gets
+          case s
+          when /^ez error/
+            raise RemoteError, "error raised in remote: #{ssh.read}"
+          else
             puts s
           end
         end
       end
     end
+
+    (passive ? passive_children : children) << child_pid
+    child_pid
   end
 end

data/lib/easy-serve/remote-run-mgr.rb

@@ -0,0 +1,73 @@
+require 'msgpack'
+require 'easy-serve'
+
+def manage_remote_run_client msg
+  $VERBOSE = msg["verbose"]
+  server_names, servers_list, log_level, host, dir, file, class_name, args =
+    msg.values_at(*%w{
+      server_names servers_list log_level host
+      dir file class_name args
+    })
+
+  servers = {}
+  servers_list.each do |name, pid, addr|
+    servers[name] = EasyServe::Server.new(name, pid, addr)
+  end
+  
+  Dir.chdir(dir) if dir
+  load file
+
+  log_args = msg["log"]
+  log =
+    case log_args
+    when Array
+      Logger.new(*log_args)
+    when true, :default
+      EasyServe.default_logger
+    when nil, false
+      EasyServe.null_logger
+    end
+
+  EasyServe.start servers: servers, log: log do |ez|
+    log = ez.log
+    log.level = log_level
+    log.formatter = nil if $VERBOSE
+
+    ez.local *server_names do |*conns|
+      begin
+        cl = Object.const_get(class_name)
+        ro = cl.new(conns, host, log, *args)
+        ro.run
+      rescue => ex
+        puts "ez error", ex, ex.backtrace
+      end
+    end
+    
+    log.info "done"
+  end
+rescue => ex
+  puts "ez error", ex, ex.backtrace
+end
+
+$stdout.sync = true
+
+def handle_remote_run_messages
+  unpacker = MessagePack::Unpacker.new($stdin)
+  unpacker.each do |msg|
+    case
+    when msg["server_names"]
+      Thread.new {manage_remote_run_client(msg); exit}
+    when msg["exit"]
+      puts "exiting"
+      exit
+    when msg["request"]
+      response = self.send(*msg["command"])
+      puts "response: #{response.inspect}"
+    else
+      puts "unhandled: #{msg.inspect}"
+    end
+  end
+
+rescue => ex
+  puts "ez error", ex, ex.backtrace
+end

data/lib/easy-serve/remote-run.rb

@@ -1,61 +1,55 @@
+require 'msgpack'
+
 class EasyServe
-  # useful in production, though it requires remote lib files to be set up
-  def remote_run *server_names, host: nil, **opts
-    ## passive option?
-    ## remote logfile option?
+  # useful in production, though it requires remote lib files to be set up.
+  # Returns pid of child managing the ssh connection.
+  #
+  # Note, unlike #local and #child, by default logging goes to the null logger.
+  # If you want too see logs from the remote, you need to choose:
+  #
+  # 1. Log to remote file: pass log: [args...] with args as in Logger.new
+  #
+  # 2. Log back over ssh: pass log: true.
+  #
+  def remote_run *server_names, host: nil, passive: false, **opts
+    child_pid = fork do
+      log.progname = "remote_run #{host}"
 
-    log.progname = "remote_run #{host}"
+      IO.popen [
+        "ssh", host, "ruby",
+        "-r", "easy-serve/remote-run-mgr",
+        "-e", "handle_remote_run_messages"],
+               "w+" do |ssh|
+        ssh.sync = true
 
-    IO.popen ["ssh", host, "ruby"], "w+" do |ssh|
-      ssh.puts %Q{
-        $stdout.sync = true
-        begin
-          require 'yaml'
-          require 'easy-serve'
- 
-          server_names = #{server_names.inspect}
-          servers = YAML.load(#{YAML.dump(servers).inspect})
-          log_level = #{log.level}
-          host = #{host.inspect}
-          args = YAML.load(#{YAML.dump(opts[:args]).inspect})
-          
-          #{opts[:dir] && "Dir.chdir #{opts[:dir].inspect}"}
-          load #{opts[:file].inspect}
-          
-          EasyServe.start servers: servers do |ez|
-            log = ez.log
-            log.level = log_level
-            log.formatter = nil if $VERBOSE
+        servers_list = servers.map {|n, s| [s.name, s.pid, s.addr]}
+        MessagePack.pack(
+          {
+            verbose:      $VERBOSE,
+            server_names: server_names,
+            servers_list: servers_list,
+            log_level:    log.level,
+            host:         host,
+            dir:          opts[:dir],
+            file:         opts[:file],
+            class_name:   opts[:class_name],
+            args:         opts[:args],
+            log:          opts[:log]
+          },
+          ssh)
 
-            ez.local *server_names do |*conns|
-              begin
-                cl = Object.const_get(#{opts[:class_name].inspect})
-                ro = cl.new(conns, host, log, *args)
-                ro.run
-              rescue => ex
-                puts "ez error", ex, ex.backtrace
-              end
-            end
-          end
-        rescue => ex
-          puts "ez error", ex, ex.backtrace
-        end
-      }
-      
-      ssh.close_write
-      result = ssh.gets
-      
-      if result
-        error = result[/ez error/]
-        if error
-          raise RemoteError, "error raised in remote: #{ssh.read}"
-        else
-          puts result
-          while s = ssh.gets
+        while s = ssh.gets
+          case s
+          when /^ez error/
+            raise RemoteError, "error raised in remote: #{ssh.read}"
+          else
             puts s
           end
         end
       end
     end
+
+    (passive ? passive_children : children) << child_pid
+    child_pid
   end
 end

data/lib/easy-serve/remote.rb

@@ -8,15 +8,15 @@ class EasyServe
 
     if opts[:eval]
       require 'easy-serve/remote-eval'
-      remote_eval *server_names, host: host, **opts
+      remote_eval(*server_names, host: host, **opts)
 
     elsif opts[:file]
       require 'easy-serve/remote-run'
-      remote_run *server_names, host: host, **opts
+      remote_run(*server_names, host: host, **opts)
 
     elsif block_given?
       require 'easy-serve/remote-drb'
-      remote_drb *server_names, host: host, **opts, &Proc.new
+      remote_drb(*server_names, host: host, **opts, &Proc.new)
 
     else
       raise ArgumentError, "cannot select remote mode based on arguments"

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: easy-serve
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Joel VanderWerf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-26 00:00:00.000000000 Z
-dependencies: []
+date: 2013-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Framework for starting tcp/unix servers and connected clients under one
-  parent process.
+  parent process and on remote hosts.
 email: vjoel@users.sourceforge.net
 executables: []
 extensions: []
@@ -22,13 +36,16 @@ files:
 - README.md
 - COPYING
 - lib/easy-serve.rb
+- lib/easy-serve/remote-eval-mgr.rb
 - lib/easy-serve/remote-run.rb
 - lib/easy-serve/remote-drb.rb
 - lib/easy-serve/remote.rb
 - lib/easy-serve/remote-eval.rb
+- lib/easy-serve/remote-run-mgr.rb
 - examples/simple.rb
 - examples/remote-manual.rb
 - examples/multi.rb
+- examples/remote-eval-passive.rb
 - examples/remote-run.rb
 - examples/remote-drb.rb
 - examples/remote-run-script.rb
@@ -65,6 +82,6 @@ rubygems_version: 2.0.4
 signing_key: 
 specification_version: 4
 summary: Framework for starting tcp/unix servers and connected clients under one parent
-  process
+  process and on remote hosts
 test_files: []
 has_rdoc: