daemon-spawn 0.2.0 → 0.3.0

data/.autotest

@@ -0,0 +1,16 @@
+Autotest.add_hook(:initialize) do |at|
+  at.clear_mappings
+
+  at.add_mapping(/.*flymake/) do |f, _|
+    []
+  end
+
+  at.add_mapping(%r[lib/daemon-spawn.rb]) do |f, _|
+    at.files_matching /^test\/.*_test\.rb$/
+  end
+
+  at.add_mapping(/^test\/.*_test\.rb$/) do |filename, _|
+    filename
+  end
+
+end

data/.gitignore

@@ -0,0 +1,2 @@
+doc
+pkg

data/History.txt

@@ -1,3 +1,12 @@
+=== 0.3.0 / 2010-04-18
+
+* Typo fix and internal refactoring patches from Emmanuel Gomez
+* Added multi-process spawning and management (inspired by Jontathan Tropper's
+  patches)
+* Added LSB-compliance patches from  Woody Peterson
+* Added some actual test-coverage :-P
+* Moved examples from "examples" directory to "test/servers"
+
 === 0.2.0 / 2009-04-22
 
 * Allow specification of args instead of ARGV so that scripts can

data/Manifest.txt

@@ -2,6 +2,8 @@ History.txt
 Manifest.txt
 README.txt
 Rakefile
-lib/daemon-spawn.rb
-test/test_daemon-spawn.rb
-examples/echo_server.rb
+lib/daemon_spawn.rb
+test/daemon_spawn_test.rb
+test/multi_daemon_spawn_test.rb
+test/servers/echo_server.rb
+test/servers/simple_server.rb

data/README.txt

@@ -46,7 +46,10 @@ The <tt>spawn!</tt> method takes a hash of symbolized keys. At a minimum you
 _must_ specify the <tt>:working_dir</tt> option. You can also override
 the default locations for the log and PID files.
 
-See the <tt>examples</tt> directory for working examples.
+If you pass a <tt>:processes</tt> option to the <tt>spawn!</tt>,
+daemon spawn will start that number of processes.
+
+See the <tt>test/servers</tt> directory for working examples.
 
 === RUNNING A DAEMON:
 
@@ -68,6 +71,12 @@ method of an instance of your daemon class.
 
 None!
 
+== CONTRIBUTIONS:
+
+Feel free to fork this project and send me pull requests with any
+changes that you have. Please note that I won't accept any patches
+with significant formatting changes or ones without tests.
+
 == INSTALL:
 
 * sudo gem install daemon-spawn

data/Rakefile

@@ -1,12 +1,25 @@
 # -*- ruby -*-
 
 require 'rubygems'
-require 'hoe'
-require './lib/daemon-spawn.rb'
+require 'jeweler'
+require './lib/daemon_spawn.rb'
 
-Hoe.spec('daemon-spawn') do |p|
-  p.developer('Alex Vollmer', 'alex.vollmer@gmail.com')
-  p.rubyforge_name = 'daemon-spawn'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "daemon-spawn"
+    gemspec.summary = "Daemon launching and management made dead simple"
+    gemspec.description = %Q[With daemon-spawn you can start, stop and restart processes that run
+    in the background. Processed are tracked by a simple PID file written
+    to disk.]
+    gemspec.rubyforge_project = "daemon-spawn"
+    gemspec.email = "alex.vollmer@gmail.com"
+    gemspec.homepage = "http://github.com/alexvollmer/daemon-spawn"
+    gemspec.authors = ["Alex Vollmer"]
+    Jeweler::GemcutterTasks.new
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
 end
 
 # vim: syntax=Ruby

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/daemon-spawn.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{daemon-spawn}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alex Vollmer"]
+  s.date = %q{2010-05-20}
+  s.description = %q{With daemon-spawn you can start, stop and restart processes that run
+    in the background. Processed are tracked by a simple PID file written
+    to disk.}
+  s.email = %q{alex.vollmer@gmail.com}
+  s.extra_rdoc_files = [
+    "README.txt"
+  ]
+  s.files = [
+    ".autotest",
+     ".gitignore",
+     "History.txt",
+     "Manifest.txt",
+     "README.txt",
+     "Rakefile",
+     "VERSION",
+     "daemon-spawn.gemspec",
+     "lib/daemon_spawn.rb",
+     "test/daemon_spawn_test.rb",
+     "test/multi_daemon_spawn_test.rb",
+     "test/servers/echo_server.rb",
+     "test/servers/simple_server.rb"
+  ]
+  s.homepage = %q{http://github.com/alexvollmer/daemon-spawn}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{daemon-spawn}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Daemon launching and management made dead simple}
+  s.test_files = [
+    "test/daemon_spawn_test.rb",
+     "test/multi_daemon_spawn_test.rb",
+     "test/servers/echo_server.rb",
+     "test/servers/simple_server.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/{daemon-spawn.rb → daemon_spawn.rb}

@@ -1,9 +1,8 @@
-require "fileutils"
+require 'fileutils'
 
 # Large portions of this were liberally stolen from the
 # 'simple-daemon' project at http://simple-daemon.rubyforge.org/
 module DaemonSpawn
-  VERSION = '0.2.0'
 
   def self.usage(msg=nil) #:nodoc:
     print "#{msg}, " if msg
@@ -19,16 +18,16 @@ module DaemonSpawn
     end
 
     if !File.writable?(File.dirname(daemon.pid_file))
-      STDERR.puts "Unable to write log file to #{daemon.pid_file}"
+      STDERR.puts "Unable to write PID file to #{daemon.pid_file}"
       exit 1
     end
 
     if daemon.alive? && daemon.singleton
-      STDERR.puts "An instance of #{daemon.classname} is already " +
+      STDERR.puts "An instance of #{daemon.app_name} is already " +
         "running (PID #{daemon.pid})"
-      exit 1
+      exit 0
     end
-    
+
     fork do
       Process.setsid
       exit if fork
@@ -43,7 +42,7 @@ module DaemonSpawn
       trap("TERM") {daemon.stop; exit}
       daemon.start(args)
     end
-    puts "#{daemon.classname} started."
+    puts "#{daemon.app_name} started."
   end
 
   def self.stop(daemon) #:nodoc:
@@ -55,30 +54,30 @@ module DaemonSpawn
       rescue Errno::ECHILD
       end
     else
-      puts "Pid file not found. Is the daemon started?"
-      exit
+      puts "PID file not found. Is the daemon started?"
     end
   rescue Errno::ESRCH
-    puts "Pid file found, but process was not running. The daemon may have died."
+    puts "PID file found, but process was not running. The daemon may have died."
   end
 
   def self.status(daemon) #:nodoc:
-    if daemon.alive?
-      puts "#{daemon.classname} is running (PID #{PidFile.recall(daemon)})"
-    else
-      puts "#{daemon.classname} is NOT running"
-    end
+    puts "#{daemon.app_name} is #{daemon.alive? ? "" : "NOT "}running (PID #{daemon.pid})"
   end
 
   class Base
-    attr_accessor :log_file, :pid_file, :sync_log, :working_dir, :singleton
+    attr_accessor :log_file, :pid_file, :sync_log, :working_dir, :app_name, :singleton, :index
 
-    def initialize(opts={ })
-      raise "You must specify a :working_dir" unless opts[:working_dir]
+    def initialize(opts = {})
+      raise 'You must specify a :working_dir' unless opts[:working_dir]
       self.working_dir = opts[:working_dir]
-
-      self.log_file = opts[:log_file] || File.join(self.working_dir, 'logs', self.classname + '.log')
-      self.pid_file = opts[:pid_file] || File.join(self.working_dir, 'run', self.classname + '.pid')
+      self.app_name = opts[:application] || classname
+      self.pid_file = opts[:pid_file] || File.join(working_dir, 'tmp', 'pids', app_name + extension)
+      self.log_file = opts[:log_file] || File.join(working_dir, 'logs', app_name + '.log')
+      self.index = opts[:index] || 0
+      if self.index > 0
+        self.pid_file += ".#{self.index}"
+        self.log_file += ".#{self.index}"
+      end
       self.sync_log = opts[:sync_log]
       self.singleton = opts[:singleton] || false
     end
@@ -116,6 +115,22 @@ module DaemonSpawn
       IO.read(self.pid_file).to_i rescue nil
     end
 
+    def self.build(options)
+      count = options.delete(:processes) || 1
+      daemons = []
+      count.times do |index|
+        daemons << new(options.merge(:index => index))
+      end
+      daemons
+    end
+
+    def self.find(options)
+      pid_file = new(options).pid_file
+      basename = File.basename(pid_file).split('.').first
+      pid_files = Dir.glob(File.join(File.dirname(pid_file), "#{basename}.*pid*"))
+      pid_files.map { |f| new(options.merge(:pid_file => f)) }
+    end
+
     # Invoke this method to process command-line args and dispatch
     # appropriately. Valid options include the following _symbols_:
     # - <tt>:working_dir</tt> -- the working directory (required)
@@ -127,25 +142,10 @@ module DaemonSpawn
     # args must begin with 'start', 'stop', 'status', or 'restart'.
     # The first token will be removed and any remaining arguments
     # passed to the daemon's start method.
-    def self.spawn!(opts={ }, args=ARGV)
-      case args.size > 0 && args.shift
-      when 'start'
-        daemon = self.new(opts)
-        DaemonSpawn.start(daemon, args)
-      when 'stop'
-        daemon = self.new(opts)
-        DaemonSpawn.stop(daemon)
-      when 'status'
-        daemon = self.new(opts)
-        if daemon.alive?
-          puts "#{daemon.classname} is running (#{daemon.pid})"
-        else
-          puts "#{daemon.classname} is NOT running"
-        end
-      when 'restart'
-        daemon = self.new(opts)
-        DaemonSpawn.stop(daemon)
-        DaemonSpawn.start(daemon, args)
+    def self.spawn!(opts = {}, args = ARGV)
+      case args.any? and command = args.shift
+      when 'start', 'stop', 'status', 'restart'
+        send(command, opts, args)
       when '-h', '--help', 'help'
         DaemonSpawn.usage
         exit
@@ -154,5 +154,43 @@ module DaemonSpawn
         exit 1
       end
     end
+
+    def self.start(opts, args)
+      daemons = find(opts)
+      if daemons.empty?
+        daemons = build(opts)
+        daemons.map { |d| DaemonSpawn.start(d, args) }
+      else
+        puts "Daemons already started! PIDS: #{daemons.map {|d| d.pid}.join(', ')}"
+        exit 1
+      end
+    end
+
+    def self.stop(opts, args)
+      daemons = find(opts)
+      if daemons.empty?
+        puts "No PID files found. Is the daemon started?"
+        exit 1
+      else
+        daemons.each { |d| DaemonSpawn.stop(d) }
+      end
+    end
+
+    def self.status(opts, args)
+      daemons = find(opts)
+      if daemons.empty?
+        puts 'No PIDs found'
+      else
+        daemons.each { |d| DaemonSpawn.status(d) }
+      end
+    end
+
+    def self.restart(opts, args)
+      daemons = find(opts)
+      daemons.map do |daemon|
+        DaemonSpawn.stop(daemon)
+        DaemonSpawn.start(daemon, args)
+      end
+    end
   end
 end

data/test/daemon_spawn_test.rb

@@ -0,0 +1,102 @@
+require "socket"
+require "test/unit"
+
+class DaemonSpawnTest < Test::Unit::TestCase
+
+  SERVERS = File.join(File.dirname(__FILE__), "servers")
+
+  def with_socket
+    socket = TCPSocket.new('localhost', 5150)
+    socket.setsockopt(Socket::SOL_SOCKET,
+                      Socket::SO_RCVTIMEO,
+                      [1, 0].pack("l_2"))
+
+    begin
+      yield(socket) if block_given?
+    ensure
+      socket.close
+    end
+  end
+
+  def echo_server(*args)
+    `./echo_server.rb #{args.join(' ')}`
+  end
+
+  def while_running
+    Dir.chdir(SERVERS) do
+      `./echo_server.rb stop`
+      assert_match(/EchoServer started./, `./echo_server.rb start 5150`)
+      sleep 1
+      begin
+        with_socket
+      ensure
+        assert_match(//, `./echo_server.rb stop`)
+        assert_raises(Errno::ECONNREFUSED) { TCPSocket.new('localhost', 5150) }
+      end
+    end
+  end
+
+  def test_daemon_running
+    while_running do |socket|
+      socket << "foobar\n"
+      assert_equal "foobar\n", socket.readline
+    end
+  end
+
+  def test_status_running
+    while_running do |socket|
+      assert_match(/EchoServer is running/, `./echo_server.rb status`)
+    end
+  end
+
+  def test_status_not_running
+    Dir.chdir(SERVERS) do
+      assert_match(/No PIDs found/, `./echo_server.rb status`)
+    end
+  end
+
+  def test_start_after_started
+    while_running do
+      pid = echo_server("status").match(/PID (\d+)/)[1]
+      assert_match(/Daemons already started! PIDS: #{pid}/,
+                   echo_server("start"))
+    end
+  end
+
+  def test_stop_after_stopped
+    Dir.chdir(SERVERS) do
+      assert_match("No PID files found. Is the daemon started?",
+                   `./echo_server.rb stop`)
+    end
+  end
+
+  def test_restart_after_stopped
+    Dir.chdir(SERVERS) do
+      assert_match(/EchoServer started/, `./echo_server.rb restart 5150`)
+      assert_equal(0, $?.exitstatus)
+      sleep 1
+      with_socket do |socket|
+        socket << "foobar\n"
+        assert_equal "foobar\n", socket.readline
+      end
+    end
+  end
+
+  def test_restart_after_started
+    Dir.chdir(SERVERS) do
+      assert_match(/EchoServer started/, `./echo_server.rb start 5150`)
+      assert_equal(0, $?.exitstatus)
+      sleep 1
+
+      assert_match(/EchoServer started/, `./echo_server.rb restart 5150`)
+      assert_equal(0, $?.exitstatus)
+      sleep 1
+
+      with_socket do |socket|
+        socket << "foobar\n"
+        assert_equal "foobar\n", socket.readline
+      end
+    end
+  end
+
+end

data/test/multi_daemon_spawn_test.rb

@@ -0,0 +1,111 @@
+require "test/unit"
+require "tempfile"
+
+class MultiDaemonSpawnTest < Test::Unit::TestCase
+
+  SERVERS = File.join(File.dirname(__FILE__), "servers")
+
+  def setup
+    @tmpfile = Tempfile.new("multi_daemon_spawn_test")
+  end
+
+  def tear_down
+    @tmpfile.delete
+  end
+
+  def simple_server(*args)
+    `./simple_server.rb #{args.join(" ")}`
+  end
+
+  def current_pids
+    regexp = /SimpleServer is running \(PID (\d+)\)/
+    pids = simple_server("status").split("\n").map do |line|
+      if m = regexp.match(line)
+        m[1]
+      else
+        nil
+      end
+    end.compact
+  end
+
+  def while_running
+    Dir.chdir(SERVERS) do
+      simple_server "stop"
+      simple_server "start", @tmpfile.path
+      sleep 1
+      begin
+        yield if block_given?
+      ensure
+        simple_server "stop"
+      end
+    end
+  end
+
+  def test_start_multiple
+    while_running do
+      lines = open(@tmpfile.path).readlines
+      assert_equal 2, lines.size
+      assert lines.member?("SimpleServer (0) started\n")
+      assert lines.member?("SimpleServer (1) started\n")
+    end
+  end
+
+  def test_status_multiple
+    while_running do
+      lines = simple_server("status").split("\n")
+      lines.each do |line|
+        assert_match /SimpleServer is running/, line
+      end
+    end
+  end
+
+  def test_stop_multiple
+    while_running
+    Dir.chdir(SERVERS) do
+      assert_match /No PIDs found/, simple_server("status")
+    end
+  end
+
+  def test_restart_multiple
+    while_running do
+      pids = current_pids
+      simple_server "restart"
+      new_pids = current_pids
+      assert_not_equal pids.sort, new_pids.sort
+    end
+  end
+
+  def test_status_with_one_dead_process
+    while_running do
+      pids = current_pids
+      Process.kill(9, pids[0].to_i)
+
+      lines = simple_server("status").split("\n")
+      assert_equal 2, lines.size
+      assert lines.member?("SimpleServer is NOT running (PID #{pids[0]})")
+      assert lines.member?("SimpleServer is running (PID #{pids[1]})")
+    end
+  end
+
+  def test_restart_with_one_dead_process
+    while_running do
+      pids = current_pids
+      Process.kill(9, pids[0].to_i)
+
+      lines = simple_server("restart").split("\n")
+      assert lines.member?("PID file found, but process was not running. The daemon may have died."), lines.inspect
+      assert_equal 2, lines.select { |l| l == "SimpleServer started." }.size
+
+      new_pids = current_pids
+      assert_not_equal new_pids, pids
+    end
+  end
+
+  def test_start_after_started
+    while_running do
+      pids = current_pids
+      assert_match(/Daemons already started! PIDS: #{pids.join(', ')}/,
+                   simple_server("start"))
+    end
+  end
+end

data/{examples → test/servers}/echo_server.rb

@@ -1,8 +1,9 @@
 #!/usr/bin/env ruby
 
+$:.unshift(File.join(File.dirname(__FILE__), "..", "..", "lib"))
+
+require "daemon_spawn"
 require "socket"
-require "rubygems"
-require "daemon-spawn"
 
 # An echo server using daemon-spawn. It starts up local TCP server
 # socket and repeats each line it receives on the connection. To fire
@@ -21,13 +22,18 @@ class EchoServer < DaemonSpawn::Base
   def start(args)
     port = args.empty? ? 0 : args.first.to_i
     self.server_socket = TCPServer.new('127.0.0.1', port)
+    self.server_socket.setsockopt(Socket::SOL_SOCKET,
+                                  Socket::SO_REUSEADDR,
+                                  true)
     port = self.server_socket.addr[1]
     puts "EchoServer started on port #{port}"
     loop do
       begin
         client = self.server_socket.accept
+        puts "Got a connection from #{client}"
         while str = client.gets
           client.write(str)
+          puts "Echoed '#{str}' to #{client}"
         end
       rescue Errno::ECONNRESET => e
         STDERR.puts "Client reset connection"
@@ -41,7 +47,7 @@ class EchoServer < DaemonSpawn::Base
   end
 end
 
-EchoServer.spawn!(:working_dir => File.join(File.dirname(__FILE__), '..'),
+EchoServer.spawn!(:working_dir => File.join(File.dirname(__FILE__), '..', '..'),
                   :log_file => '/tmp/echo_server.log',
                   :pid_file => '/tmp/echo_server.pid',
                   :sync_log => true,

data/test/servers/simple_server.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "..", "lib"))
+
+require "daemon_spawn"
+
+class SimpleServer < DaemonSpawn::Base
+
+  attr_accessor :outfile
+
+  def start(args)
+    abort "USAGE: phrase_server.rb LOGFILE" if args.empty?
+    @outfile = args.first
+    self.puts "SimpleServer (#{self.index}) started"
+    while true                  # keep running like a real daemon
+      sleep 5
+    end
+  end
+
+  def puts(str)
+    open(@outfile, "a") { |f| f.puts str }
+  end
+
+  def stop
+    self.puts "SimpleServer (#{self.index}) stopped"
+  end
+
+end
+
+SimpleServer.spawn!(:working_dir => File.join(File.dirname(__FILE__), '..', '..'),
+                    :log_file => '/tmp/simple_server.log',
+                    :pid_file => '/tmp/simple_server.pid',
+                    :sync_log => true,
+                    :processes => 2)

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: daemon-spawn
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Alex Vollmer
@@ -9,75 +15,71 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-01 01:00:00 -07:00
+date: 2010-05-20 00:00:00 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.3.3
-    version: 
+dependencies: []
+
 description: |-
-  Daemon launching and management made dead simple.
-  
   With daemon-spawn you can start, stop and restart processes that run
-  in the background. Processed are tracked by a simple PID file written
-  to disk.
-  
-  In addition, you can choose to either execute ruby in your daemonized
-  process or 'exec' another process altogether (handy for wrapping other
-  services).
-email: 
-- alex.vollmer@gmail.com
+      in the background. Processed are tracked by a simple PID file written
+      to disk.
+email: alex.vollmer@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- Manifest.txt
 - README.txt
 files: 
+- .autotest
+- .gitignore
 - History.txt
 - Manifest.txt
 - README.txt
 - Rakefile
-- lib/daemon-spawn.rb
-- test/test_daemon-spawn.rb
-- examples/echo_server.rb
+- VERSION
+- daemon-spawn.gemspec
+- lib/daemon_spawn.rb
+- test/daemon_spawn_test.rb
+- test/multi_daemon_spawn_test.rb
+- test/servers/echo_server.rb
+- test/servers/simple_server.rb
 has_rdoc: true
 homepage: http://github.com/alexvollmer/daemon-spawn
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --main
-- README.txt
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: daemon-spawn
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Daemon launching and management made dead simple
 test_files: 
-- test/test_daemon-spawn.rb
+- test/daemon_spawn_test.rb
+- test/multi_daemon_spawn_test.rb
+- test/servers/echo_server.rb
+- test/servers/simple_server.rb