easy-serve 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2989b3ccae0056e24b4e2c097ce9c15b0db1f5ee
+  data.tar.gz: 2f0b15aad79aad9ab35d467ce1a77ef2cf60ccef
+SHA512:
+  metadata.gz: 47c813e39f2b4f4824f20cdcf8036fb7a3c91f273eea99bcf3c6ad6af14a3d8be62511671aca3bdcd2800ff3b8c152221f43f2337298d0325091e21a341ce940
+  data.tar.gz: b7d53a73b898c9ba8b379146c67a7d49144d3a3e72a6cb01f375ceb182e0d0279e9b3e2071f282b9bfe5a123760d02f2ab3d797b74994fc67a6cb2aabb72d871

data/COPYING

@@ -0,0 +1,22 @@
+Copyright (c) 2013, Joel VanderWerf, vjoel@users.sourceforge.net
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met: 
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer. 
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution. 
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

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

data/examples/multi.rb

@@ -0,0 +1,40 @@
+require 'easy-serve'
+
+servers_file = ARGV.shift
+unless servers_file
+  abort "Usage: #$0 servers_file   # Run this in two or more shells"
+end
+
+EasyServe.start servers_file: servers_file do |ez|
+  log = ez.log
+  log.level = Logger::DEBUG
+  log.formatter = nil if $VERBOSE
+
+  ez.start_servers do
+    ez.server "simple-server", :unix do |svr|
+      log.debug {"starting server"}
+      Thread.new do
+        loop do
+          Thread.new(svr.accept) do |conn|
+            conn.write "hello from #{log.progname}"
+            conn.close_write
+            log.info conn.read
+            conn.close
+          end
+        end
+      end
+    end
+  end
+  
+  ez.client "simple-server" do |conn|
+    log.progname = "client with pid=#$$"
+    log.info conn.read
+    conn.write "hello from #{log.progname}"
+  end
+  
+  ez.local "simple-server" do |conn|
+    log.progname = "parent process"
+    log.info "PRESS RETURN TO STOP"
+    gets
+  end
+end

data/examples/remote.rb

@@ -0,0 +1,39 @@
+require 'easy-serve'
+
+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.
+  END
+end
+
+EasyServe.start servers_file: servers_file do |ez|
+  log = ez.log
+  log.level = Logger::DEBUG
+  log.formatter = nil if $VERBOSE
+
+  ez.start_servers do
+    ez.server "simple-server", :tcp, '0.0.0.0', 0 do |svr|
+      log.debug {"starting server"}
+      Thread.new do
+        loop do
+          Thread.new(svr.accept) do |conn|
+            conn.write "hello from #{log.progname}"
+            conn.close_write
+            log.info conn.read
+            conn.close
+          end
+        end
+      end
+    end
+  end
+  
+  ez.local "simple-server" do |conn|
+    log.progname = "parent process"
+    log.info conn.read
+    conn.write "hello from #{log.progname}"
+    log.info "PRESS RETURN TO STOP"
+    gets
+  end
+end

data/examples/simple.rb

@@ -0,0 +1,34 @@
+require 'easy-serve'
+
+EasyServe.start do |ez|
+  log = ez.log
+  log.level = Logger::DEBUG
+  log.formatter = nil if $VERBOSE
+  log.debug {"starting servers"}
+    
+  ez.start_servers do
+    ez.server "simple-server", :unix do |svr|
+      Thread.new do
+        loop do
+          conn = svr.accept
+          conn.write "hello from #{log.progname}"
+          conn.close_write
+          log.info conn.read
+          conn.close
+        end
+      end
+    end
+  end
+  
+  ez.client "simple-server" do |conn|
+    log.progname = "client 1"
+    log.info conn.read
+    conn.write "hello from #{log.progname}"
+  end
+  
+  ez.local "simple-server" do |conn|
+    log.progname = "parent process"
+    log.info conn.read
+    conn.write "hello from #{log.progname}"
+  end
+end

data/lib/easy-serve.rb

@@ -0,0 +1,253 @@
+require 'logger'
+require 'socket'
+require 'yaml'
+require 'fileutils'
+
+class EasyServe
+  class Server
+    attr_reader :name, :pid, :addr
+    
+    def initialize name, pid, addr
+      @name, @pid, @addr = name, pid, addr
+    end
+  end
+  
+  class EasyFormatter < Logger::Formatter
+    Format = "%s: %s: %s\n"
+
+    def call(severity, time, progname, msg)
+      Format % [severity[0..0], progname, msg2str(msg)]
+    end
+  end
+
+  def self.default_logger
+    log = Logger.new($stderr)
+    log.formatter = EasyFormatter.new
+    log
+  end
+  
+  def self.null_logger
+    log = Logger.new('/dev/null')
+    log.level = Logger::FATAL
+    log
+  end
+
+  attr_accessor :log
+  attr_accessor :servers
+  attr_reader :clients
+  attr_reader :servers_file
+  attr_reader :interactive
+  
+  def self.start(log: default_logger, **opts)
+    ez = new(**opts, log: log)
+    yield ez
+  rescue => ex
+    log.error ex
+    raise
+  ensure
+    ez.cleanup if ez
+  end
+
+  def initialize **opts
+    @servers_file = opts[:servers_file]
+    @interactive = opts[:interactive]
+    @log = opts[:log] || self.class.null_logger
+    @clients = [] # pid
+    @owner = false
+    @servers = nil # name => Server
+    
+    if servers_file
+      @servers =
+        begin
+          load_server_table
+        rescue Errno::ENOENT
+          init_server_table
+        end
+    else
+      init_server_table
+    end
+  end
+
+  def load_server_table
+    File.open(servers_file) do |f|
+      YAML.load(f)
+    end
+  end
+  
+  def init_server_table
+    @servers ||= begin
+      @owner = true
+      {}
+    end
+  end
+  
+  def cleanup
+    handler = trap("INT") do
+      trap("INT", handler)
+    end
+
+    clients.each do |pid|
+      log.debug {"waiting for client pid=#{pid} to stop"}
+      Process.waitpid pid
+    end
+    
+    if @owner
+      servers.each do |name, server|
+        log.info "stopping #{name}"
+        Process.kill "TERM", server.pid
+        Process.waitpid server.pid
+        if server.addr.kind_of? String
+          FileUtils.remove_entry server.addr
+        end
+      end
+
+      if servers_file
+        begin
+          FileUtils.rm servers_file
+        rescue Errno::ENOENT
+          log.warn "servers file at #{servers_file.inspect} was deleted already"
+        end
+      end
+    end
+    
+    clean_tmpdir
+  end
+  
+  def start_servers
+    if @owner
+      log.debug {"starting servers"}
+      yield
+
+      if servers_file
+        File.open(servers_file, "w") do |f|
+          YAML.dump(servers, f)
+        end
+      end
+    end
+  end
+  
+  def tmpdir
+    @tmpdir ||= begin
+      require 'tmpdir'
+      Dir.mktmpdir "easy-serve-"
+    end
+  end
+  
+  def clean_tmpdir
+    FileUtils.remove_entry @tmpdir if @tmpdir
+  end
+  
+  def choose_socket_filename name, base: nil
+    if base
+      "#{base}-#{name}"
+    else
+      File.join(tmpdir, "sock-#{name}")
+    end
+  end
+
+  def inc_socket_filename name
+    name =~ /-\d+\z/ ? name.succ : name + "-0"
+  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]
+      else raise ArgumentError, "Unknown socket protocol: #{proto.inspect}"
+      end
+
+    rd, wr = IO.pipe
+
+    pid = fork do
+      rd.close
+      log.progname = name
+      log.info "starting"
+
+      svr = server_for(server_class, *server_addr)
+      yield svr if block_given?
+      no_interrupt_if_interactive
+
+      addr =
+        case proto
+        when /unix/i; svr.addr[1]
+        when /tcp/i; svr.addr(false).values_at(2,1)
+        end
+      Marshal.dump addr, wr
+      wr.close
+      sleep
+    end
+
+    wr.close
+    addr = Marshal.load rd
+    rd.close
+    servers[name] = Server.new(name, pid, addr)
+  end
+
+  MAX_TRIES = 10
+
+  def server_for server_class, *server_addr
+    tries = 0
+    begin
+      server_class.new(*server_addr)
+    rescue Errno::EADDRINUSE => ex
+      if server_class == UNIXServer
+        if tries < MAX_TRIES
+          tries += 1
+          server_addr[0] = inc_socket_filename(server_addr[0])
+          log.warn {
+            "#{ex} -- trying again at path #{server_addr}, #{tries}/#{MAX_TRIES} times."
+          }
+          retry
+        end
+      elsif server_class == TCPServer
+        port = Integer(server_addr[1])
+        if port and tries < MAX_TRIES
+          tries += 1
+          port += 1
+          server_addr[1] = port
+          log.warn {
+            "#{ex} -- trying again at port #{port}, #{tries}/#{MAX_TRIES} times."
+          }
+          retry
+        end
+      else
+        raise ArgumentError, "unknown server_class: #{server_class.inspect}"
+      end
+      raise
+    end
+  end
+
+  def client *server_names
+    clients << fork do
+      conns = server_names.map {|sn| socket_for(*servers[sn].addr)}
+      yield(*conns) if block_given?
+      no_interrupt_if_interactive
+    end
+  end
+  
+  def local *server_names
+    conns = server_names.map {|sn| socket_for(*servers[sn].addr)}
+    yield(*conns) if block_given?
+  ensure
+    conns and conns.each do |conn|
+      conn.close unless conn.closed?
+    end
+    log.info "stopped local client"
+  end
+  
+  def socket_for *addr
+    socket_class =
+      case addr.size
+      when 1; UNIXSocket
+      else TCPSocket
+      end
+    socket_class.new(*addr)
+  end
+
+  # ^C in the irb session (parent process) should not kill the
+  # server (child process)
+  def no_interrupt_if_interactive
+    trap("INT") {} if interactive
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: easy-serve
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Joel VanderWerf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-12 00:00:00.000000000 Z
+dependencies: []
+description: Framework for starting tcp/unix servers and connected clients under one
+  parent process.
+email: vjoel@users.sourceforge.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- COPYING
+files:
+- README.md
+- COPYING
+- lib/easy-serve.rb
+- examples/simple.rb
+- examples/multi.rb
+- examples/remote.rb
+homepage: https://github.com/vjoel/easy-serve
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --quiet
+- --line-numbers
+- --inline-source
+- --title
+- easy-serve
+- --main
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.4
+signing_key: 
+specification_version: 4
+summary: Framework for starting tcp/unix servers and connected clients under one parent
+  process
+test_files: []
+has_rdoc: