pipemaster 0.4.0 → 0.4.1

data/CHANGELOG

@@ -1,3 +1,12 @@
+0.4.1
+* Added: Service control file in etc/pipemaster (puts this in your /etc/init.d directory)
+* Added: pipe command gets --retcode/-c option to return exit code in case of failure.
+* Added: Pipefile uses app { } for application loading block.
+* Changed: Return status for errors is 127.
+* Fixed: pipemaster command always defaulting to run as daemon.
+* Fixed: Added time delay when retrying after master loop exception (typically, failure to bind on port).
+* Fixed: Can't stop server.
+
 0.4.0 (2010-02-19)
 * Added: pipe command (client).
 * Added: Pipemaster::Client gets pipe and capture methods, global address setting.

data/bin/pipe

@@ -5,6 +5,7 @@ require "optparse"
 
 ENV["PIPE_ENV"] ||= "development"
 address = nil
+ret_code = nil
 tty = false
 
 opts = OptionParser.new("", 24, '  ') do |opts|
@@ -20,6 +21,10 @@ opts = OptionParser.new("", 24, '  ') do |opts|
     address = a
   end
 
+  opts.on("-c", "--retcode CODE", "return code in case of failure (default: raise exception)") do |r|
+    ret_code = r
+  end
+
   opts.on("-h", "--help", "Show this message") do
     puts opts.to_s.gsub(/^.*DEPRECATED.*$/s, '')
     exit
@@ -33,5 +38,13 @@ opts = OptionParser.new("", 24, '  ') do |opts|
   opts.parse! ARGV
 end
 
-input = $stdin if tty || !$stdin.isatty 
-exit Pipemaster::Client.new(address).capture(input, $stdout).run(*ARGV)
+begin
+  input = $stdin if tty || !$stdin.isatty 
+  exit Pipemaster::Client.new(address).capture(input, $stdout).run(*ARGV)
+rescue Exception=>ex
+  if ret_code
+    exit ret_code.to_i
+  else
+    raise
+  end
+end

data/bin/pipemaster

@@ -76,5 +76,5 @@ config = ARGV[0] || "Pipefile"
 abort "configuration file #{config} not found" unless File.exist?(config)
 options[:config_file] = config
 options[:working_directory] = File.dirname(config)
-Pipemaster::Launcher.daemonize!(options)
+Pipemaster::Launcher.daemonize!(options) if daemonize
 Pipemaster::Server.run(options)

data/etc/pipemaster

@@ -0,0 +1,50 @@
+#!/bin/sh
+APP_ROOT=/var/myapp
+ENV=production
+# Remember to use same PID path in your Pipefile.
+PID=/var/run/pipemaster.pid
+CMD="pipemaster -D -E $ENV"
+ 
+old_pid="$PID.oldbin"
+ 
+cd $APP_ROOT || exit 1
+ 
+sig () {
+    test -s "$PID" && kill -$1 `cat $PID`
+}
+oldsig () {
+    test -s $old_pid && kill -$1 `cat $old_pid`
+}
+ 
+case $1 in
+start)
+	sig 0 && echo >&2 "Already running" && exit 0
+	$CMD
+	;;
+stop)
+	sig QUIT && exit 0
+	echo >&2 "Not running"
+	;;
+force-stop)
+	sig TERM && exit 0
+	echo >&2 "Not running"
+	;;
+restart|reload)
+	sig HUP && echo reloaded OK && exit 0
+	echo >&2 "Couldn't reload, starting '$CMD' instead"
+	$CMD
+	;;
+upgrade)
+	sig USR2 && sleep 3 && sig 0 && oldsig QUIT && exit 0
+	echo >&2 "Couldn't upgrade, starting '$CMD' instead"
+	$CMD
+	;;
+status)
+    sig 0 && echo >&2 "Running" && exit 0
+	echo >&2 "Not running"
+    ;;
+*)
+	echo >&2 "Usage: $0 <start|stop|status|restart|upgrade|force-stop>"
+	exit 1
+	;;
+esac

data/lib/pipemaster/configurator.rb

@@ -116,6 +116,12 @@ module Pipemaster
       Server::START_CTX[:cwd] = ENV["PWD"] = path
     end
 
+    # Application is a block we run at startup.  This is the heavy stuff (e.g.
+    # starting up ActiveRecord) we want to run once and fork from.
+    def app(*args, &block)
+      set_hook(:app, block_given? ? block : args[0], 0)
+    end
+
     # Sets after_fork hook to a given block.  This block will be called by
     # the worker after forking.
     def after_fork(*args, &block)

data/lib/pipemaster/server.rb

@@ -7,7 +7,7 @@ require "pipemaster/socket_helper"
 module Pipemaster
 
   class Server < Struct.new(:listener_opts, :timeout, :logger,
-                            :before_fork, :after_fork, :before_exec,
+                            :app, :before_fork, :after_fork, :before_exec,
                             :pid, :reexec_pid, :init_listeners,
                             :master_pid, :config, :ready_pipe)
 
@@ -78,28 +78,30 @@ module Pipemaster
     attr_accessor :commands
 
     def start
+      self.master_pid = $$
       trap(:QUIT) { stop }
       [:TERM, :INT].each { |sig| trap(sig) { stop false } }
       self.pid = config[:pid]
-
-      proc_name "pipemaster"
-      logger.info "master process ready" # test_exec.rb relies on this message
-      if ready_pipe
-        ready_pipe.syswrite($$.to_s)
-        ready_pipe.close rescue nil
-        self.ready_pipe = nil
-      end
-
       trap(:CHLD) { reap_all_workers }
       trap :USR1 do
         logger.info "master reopening logs..."
         Pipemaster::Util.reopen_logs
         logger.info "master done reopening logs"
       end
-      reloaded = nil
       trap(:HUP)  { reloaded = true ; load_config! }
       trap(:USR2) { reexec }
 
+      proc_name "pipemaster"
+      logger.info "loading application"
+      app.call if app
+
+      logger.info "master process ready" # test_exec.rb relies on this message
+      if ready_pipe
+        ready_pipe.syswrite($$.to_s)
+        ready_pipe.close rescue nil
+        self.ready_pipe = nil
+      end
+
       config_listeners = config[:listeners].dup
       if config_listeners.empty? && LISTENERS.empty?
         config_listeners << DEFAULT_LISTEN
@@ -108,6 +110,7 @@ module Pipemaster
       end
       config_listeners.each { |addr| listen(addr) }
 
+      reloaded = nil
       begin
         reloaded = false
         while selected = Kernel.select(LISTENERS)
@@ -125,6 +128,7 @@ module Pipemaster
       rescue => ex
         logger.error "Unhandled master loop exception #{ex.inspect}."
         logger.error ex.backtrace.join("\n")
+        sleep 1 # This is often failure to bind, so wait a bit
         retry
       end
       self
@@ -135,6 +139,23 @@ module Pipemaster
       logger.info "master complete"
       unlink_pid_safe(pid) if pid
     end
+    
+    # Terminates all workers, but does not exit master process
+    def stop(graceful = true)
+      self.listeners = []
+      limit = Time.now + timeout
+      until WORKERS.empty? || Time.now > limit
+        kill_each_worker(graceful ? :QUIT : :TERM)
+        sleep(0.1)
+        reap_all_workers
+      end
+      kill_each_worker(:KILL)
+    end
+
+    # delivers a signal to each worker
+    def kill_each_worker(signal)
+      WORKERS.keys.each { |wpid| kill_worker(signal, wpid) }
+    end
 
     # replaces current listener set with +listeners+.  This will
     # close the socket if it will not exist in the new listener set
@@ -389,7 +410,7 @@ module Pipemaster
       rescue Exception => ex
         logger.info "#{Process.pid} failed: #{ex.message}" 
         socket.write "#{ex.class.name}: #{ex.message}\n"
-        socket.write 1.chr
+        socket.write 127.chr
       ensure
         socket.close_write
         socket.close

data/pipemaster.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |spec|
   spec.name           = "pipemaster"
-  spec.version        = "0.4.0"
+  spec.version        = "0.4.1"
   spec.author         = "Assaf Arkin"
   spec.email          = "assaf@labnotes.org"
   spec.homepage       = "http://github.com/assaf/pipemaster"
   spec.summary        = "Use the fork"
   spec.post_install_message = "To get started run pipemaster --help"
 
-  spec.files          = Dir["{bin,lib,test}/**/*", "CHANGELOG", "LICENSE", "README.rdoc", "Rakefile", "Gemfile", "pipemaster.gemspec"]
+  spec.files          = Dir["{bin,lib,test,etc}/**/*", "CHANGELOG", "LICENSE", "README.rdoc", "Rakefile", "Gemfile", "pipemaster.gemspec"]
   spec.executables    = %w{pipe pipemaster}
 
   spec.has_rdoc         = true

data/test/unit/test_server.rb

@@ -48,16 +48,38 @@ class ServerTest < Test::Unit::TestCase
 
   def test_no_command
     start
-    results = hit("127.0.0.1:#@port", "test")
-    assert_equal 1, results.first
+    result = hit("127.0.0.1:#@port", :nosuch)
+    assert_equal 127, result.first
+    assert_equal "ArgumentError: No command nosuch\n", result.last
   end
 
   def test_arguments
     start :commands => { :args => lambda { |x,y| $stdout << "#{x} - #{y}" } }
-    results = hit("127.0.0.1:#@port", "args", "foo", "bar")
-    assert_equal "foo - bar", results.last
+    result = hit("127.0.0.1:#@port", :args, "foo", "bar")
+    assert_equal "foo - bar", result.last
   end
 
+  def test_return_code
+    start :commands => { :success => lambda { "hi" }, :fail => lambda { fail }, :exit => lambda { exit 5 } }
+    assert_equal 0, hit("127.0.0.1:#@port", :success).first
+    assert_equal 127, hit("127.0.0.1:#@port", :fail).first
+    assert_equal 5, hit("127.0.0.1:#@port", :exit).first
+  end
+
+  def test_exit
+    start :commands => { :exit => lambda { exit 6 } }
+    result = hit("127.0.0.1:#@port", :exit)
+    assert_equal 6, result.first
+    assert_equal "", result.last
+  end
+
+  def test_error
+    start :commands => { :fail => lambda { fail "oops" } }
+    result = hit("127.0.0.1:#@port", :fail)
+    assert_equal 127, result.first
+    assert_equal "RuntimeError: oops\n", result.last
+  end
+  
   def test_streams
     start :commands => { :reverse => lambda { $stdout << $stdin.read.reverse } }
     client = Pipemaster::Client.new("127.0.0.1:#@port")
@@ -73,4 +95,17 @@ class ServerTest < Test::Unit::TestCase
     tmp.close!
   end
 
+  def test_loading_app
+    iam = "sad"
+    start :app => lambda { iam.replace "happy" }, :commands => { :iam => lambda { $stdout << iam } }
+    assert_equal "happy", hit("127.0.0.1:#@port", :iam).last
+  end
+
+  def test_reloading_app
+    text = "foo"
+    start :app => lambda { text << "bar" }, :commands => { :text => lambda { $stdout << text } }
+    assert_equal "foobar", hit("127.0.0.1:#@port", :text).last
+    Process.kill "HUP", @pid 
+    assert_equal "foobar", hit("127.0.0.1:#@port", :text).last
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pipemaster
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors: 
 - Assaf Arkin
@@ -26,7 +26,6 @@ extra_rdoc_files:
 files: 
 - bin/pipe
 - bin/pipemaster
-- lib/pipemaster
 - lib/pipemaster/client.rb
 - lib/pipemaster/configurator.rb
 - lib/pipemaster/launcher.rb
@@ -36,9 +35,9 @@ files:
 - lib/pipemaster/worker.rb
 - lib/pipemaster.rb
 - test/test_helper.rb
-- test/unit
 - test/unit/test_configurator.rb
 - test/unit/test_server.rb
+- etc/pipemaster
 - CHANGELOG
 - LICENSE
 - README.rdoc
@@ -47,10 +46,12 @@ files:
 - pipemaster.gemspec
 has_rdoc: true
 homepage: http://github.com/assaf/pipemaster
+licenses: []
+
 post_install_message: To get started run pipemaster --help
 rdoc_options: 
 - --title
-- Pipemaster 0.4.0
+- Pipemaster 0.4.1
 - --main
 - README.rdoc
 - --webcvs
@@ -72,9 +73,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Use the fork
 test_files: []