easy-serve 0.3 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: affa8e536ee5d6c7d9b703a45267bcc7fec96535
-  data.tar.gz: d389e400e0e5408ac08400cfd61661befeaaf514
+  metadata.gz: fa7e317b0835fcccb71074755f7c440a36eb97c5
+  data.tar.gz: f1473351a5081398d0c1a8dc4fe424555cbe7a8b
 SHA512:
-  metadata.gz: 5f552e68ca9612ebaacbef58ce31395b7da8121a6753855aebb3bfac58bf07fb435f45dc0f4184395a02d3c9e8590249785307b79f603472e29adaa4f97b0f6f
-  data.tar.gz: 07aedd1e1b46b0ce875e5dee6cc37220e8e90ca929ebf6bff445a7e6f234733ad07b81416a9b89d14dd04be703bc728599ac18d73eef1762bdc0f00196cf44d1
+  metadata.gz: 3f5ee396c21115e4d691c15409aa47f07ca9947a82753e33db9663f21e58ba0930f53541a193095b9705a44d14d96018ad6c03c38a187c407379d90196c7c1ac
+  data.tar.gz: b4027e51407e2070ec4039f70fda510cc5b8a22e5aae5396de86c360e2c2366840f9436bd84d313fc0b2ead5df016c4ff7cd4c83276d719512da868a82a64123

data/examples/remote-drb.rb

@@ -0,0 +1,55 @@
+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' must be a valid hostname (not just an ssh alias), since it
+    will be used for the drb connection as well.
+
+  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 do |conn|
+    # this block runs locally, but calls methods on the remote using drb
+    log.progname = "druby remote on #{addr_there}"
+    log.info "trying to read from #{conn.inspect}"
+    log.info "received: #{conn.read}"
+      # note: conn is drb proxy to real conn on remote host, so after the
+      # string is read from the socket in the remote, it is then serialized
+      # by drb back to this (local) process. Don't do this in production!
+    conn.write "hello from #{log.progname}"
+    conn.close
+  end
+end

data/examples/remote-eval.rb

@@ -0,0 +1,56 @@
+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, eval: %{
+    conn = conns[0]
+    # this code is executed on the remote host, connected by conn, not drb
+    log.progname = "eval remote 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.rb → remote-manual.rb}

@@ -4,7 +4,8 @@ servers_file = ARGV.shift
 unless servers_file
   abort <<-END
     Usage: #$0 servers_file
-    For the client, copy the generated servers_file to the client host.
+    For the client, copy the generated servers_file to the client host, and
+    run with the same command.
   END
 end
 

data/examples/remote-run-script.rb

@@ -0,0 +1,19 @@
+class RemoteRunScript
+  attr_reader :conns, :host, :log, :args
+  
+  def initialize conns, host, log, *args
+    @conns = conns
+    @host = host
+    @log = log
+    @args = args
+  end
+  
+  def run
+    conn = conns[0]
+    log.progname = "run remote on #{host}"
+    log.info "trying to read from #{conn.inspect}"
+    log.info "received: #{conn.read}"
+    conn.write "hello from #{log.progname}"
+    conn.close
+  end
+end

data/examples/remote-run.rb

@@ -0,0 +1,53 @@
+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.
+
+    Note: you must set up the remote by doing
+    
+      scp examples/remote-run-script.rb addr_there:/tmp/
+
+  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,
+    dir: "/tmp",
+    file: "remote-run-script.rb",
+      # 'file' passed to load, so can be rel to dir or ruby's $LOAD_PATH
+    class_name: "RemoteRunScript",
+    args: []
+end

data/lib/easy-serve.rb

@@ -4,7 +4,7 @@ require 'yaml'
 require 'fileutils'
 
 class EasyServe
-  VERSION = "0.3"
+  VERSION = "0.4"
 
   class Server
     attr_reader :name, :pid, :addr
@@ -58,17 +58,19 @@ class EasyServe
     @clients = [] # pid
     @passive_clients = [] # pid
     @owner = false
-    @servers = nil # name => Server
+    @servers = opts[:servers] # name => Server
     
-    if servers_file
-      @servers =
-        begin
-          load_server_table
-        rescue Errno::ENOENT
-          init_server_table
-        end
-    else
-      init_server_table
+    unless servers
+      if servers_file
+        @servers =
+          begin
+            load_server_table
+          rescue Errno::ENOENT
+            init_server_table
+          end
+      else
+        init_server_table
+      end
     end
   end
 
@@ -167,11 +169,27 @@ class EasyServe
     name =~ /-\d+\z/ ? name.succ : name + "-0"
   end
   
+  def host_name
+    @host_name ||= begin
+      hn = Socket.gethostname
+      begin
+        official_hostname = Socket.gethostbyname(hn)[0]
+        if /\./ =~ official_hostname
+          official_hostname
+        else
+          official_hostname + ".local"
+        end
+      rescue
+        'localhost'
+      end
+    end
+  end
+  
   def server name, proto = :unix, host = nil, port = nil
     server_class, *server_addr =
       case proto
       when /unix/i; [UNIXServer, choose_socket_filename(name, base: host)]
-      when /tcp/i;  [TCPServer, host || '127.0.0.1', port || 0]
+      when /tcp/i;  [TCPServer, host || host_name, port || 0]
       else raise ArgumentError, "Unknown socket protocol: #{proto.inspect}"
       end
 
@@ -264,6 +282,9 @@ class EasyServe
       else TCPSocket
       end
     socket_class.new(*addr)
+  rescue => ex
+    ex.message << " addr=#{addr.inspect}"
+    raise
   end
 
   # ^C in the irb session (parent process) should not kill the

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

@@ -0,0 +1,94 @@
+require 'drb'
+
+class EasyServe
+  # useful for testing only -- use _eval or _run for production
+  def remote_drb *server_names, host: nil
+    ## passive option?
+    ## remote logfile option?
+
+    DRb.start_service("druby://#{host_name}:0", nil)
+
+    hostname = host.sub(/.*@/,"")
+    host_uri = "druby://#{hostname}:0"
+
+    log.progname = "remote_drb #{host}"
+
+    IO.popen ["ssh", host, "ruby"], "w+" do |ssh|
+      ssh.puts %Q{
+        $stdout.sync = true
+        begin
+          require 'drb'
+          require 'yaml'
+          require 'easy-serve'
+          
+          server_names = #{server_names.inspect}
+          servers = YAML.load(#{YAML.dump(servers).inspect})
+          log_level = #{log.level}
+          host_uri = #{host_uri.inspect}
+          
+          EasyServe.start servers: servers do |ez|
+            log = ez.log
+            log.level = log_level
+            log.formatter = nil if $VERBOSE
+
+            ez.local *server_names do |*conns|
+              begin
+                DRb.start_service(host_uri, {conns: conns})
+                puts DRb.uri
+                
+                Thread.new do
+                  loop do
+                    sleep 1
+                    begin
+                      puts "."
+                    rescue
+                      exit
+                    end
+                  end
+                end
+                
+                DRb.thread.join
+
+              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
+        raise RemoteError, "problem with ssh connection to remote"
+      else
+        error = result[/ez error/]
+        if error
+          raise RemoteError, "error raised in remote: #{ssh.read}"
+        else
+          uri = result[/druby:\/\/\S+/]
+          if uri
+            Thread.new do
+              loop do
+                ssh.gets # consume the "."
+              end
+            end
+          
+            log.debug "remote is at #{uri}"
+            ro = DRbObject.new_with_uri(uri)
+            conns = ro[:conns]
+            conns_ary = []
+            conns.each {|c| conns_ary << c} # needed because it's a DRbObject
+            yield(*conns_ary) if block_given?
+          else
+            raise RemoteError,
+              "no druby uri in string from remote: #{result.inspect}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+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?
+
+    log.progname = "remote_eval #{host}"
+
+    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
+
+            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
+            puts s
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+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?
+
+    log.progname = "remote_run #{host}"
+
+    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
+
+            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
+            puts s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/easy-serve/remote.rb

@@ -0,0 +1,25 @@
+require 'easy-serve'
+
+class EasyServe
+  class RemoteError < RuntimeError; end
+
+  def remote *server_names, host: nil, **opts
+    raise ArgumentError, "no host specified" unless host
+
+    if opts[:eval]
+      require 'easy-serve/remote-eval'
+      remote_eval *server_names, host: host, **opts
+
+    elsif opts[:file]
+      require 'easy-serve/remote-run'
+      remote_run *server_names, host: host, **opts
+
+    elsif block_given?
+      require 'easy-serve/remote-drb'
+      remote_drb *server_names, host: host, **opts, &Proc.new
+
+    else
+      raise ArgumentError, "cannot select remote mode based on arguments"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy-serve
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
 platform: ruby
 authors:
 - Joel VanderWerf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-31 00:00:00.000000000 Z
+date: 2013-08-26 00:00:00.000000000 Z
 dependencies: []
 description: Framework for starting tcp/unix servers and connected clients under one
   parent process.
@@ -22,9 +22,17 @@ files:
 - README.md
 - COPYING
 - lib/easy-serve.rb
+- lib/easy-serve/remote-run.rb
+- lib/easy-serve/remote-drb.rb
+- lib/easy-serve/remote.rb
+- lib/easy-serve/remote-eval.rb
 - examples/simple.rb
+- examples/remote-manual.rb
 - examples/multi.rb
-- examples/remote.rb
+- examples/remote-run.rb
+- examples/remote-drb.rb
+- examples/remote-run-script.rb
+- examples/remote-eval.rb
 - examples/passive.rb
 homepage: https://github.com/vjoel/easy-serve
 licenses: