zbatery 0.0.0

data/lib/zbatery.rb

@@ -0,0 +1,154 @@
+# -*- encoding: binary -*-
+require 'rainbows'
+
+module Zbatery
+
+  # current version of Zbatery
+  VERSION = "0.0.0"
+
+  class << self
+
+    # runs the Zbatery HttpServer with +app+ and +options+ and does
+    # not return until the server has exited.
+    def run(app, options = {})
+      HttpServer.new(app, options).start.join
+    end
+  end
+
+  Rainbows::Const::RACK_DEFAULTS["SERVER_SOFTWARE"] = "Zbatery #{VERSION}"
+
+  # true if our Ruby implementation supports unlinked files
+  UnlinkedIO = begin
+    tmp = Unicorn::Util.tmpio
+    tmp.chmod(0)
+    tmp.close
+    true
+  rescue
+    false
+  end
+
+  # we don't actually fork workers, but allow using the
+  # {before,after}_fork hooks found in Unicorn/Rainbows!
+  # config files...
+  FORK_HOOK = lambda { |_,_| }
+
+  class HttpServer < Rainbows::HttpServer
+
+    # only used if no concurrency model is specified
+    def worker_loop(worker)
+      init_worker_process(worker)
+      begin
+        ret = IO.select(LISTENERS, nil, nil, nil) and
+        ret.first.each do |sock|
+          begin
+            process_client(sock.accept_nonblock)
+          rescue Errno::EAGAIN, Errno::ECONNABORTED
+          end
+        end
+      rescue Errno::EINTR
+      rescue Errno::EBADF, TypeError
+        break
+      rescue => e
+        Rainbows::Error.listen_loop(e)
+      end while G.alive
+    end
+
+    # no-op
+    def maintain_worker_count; end
+
+    # can't just do a graceful exit if reopening logs fails, so we just
+    # continue on...
+    def reopen_logs
+      logger.info "reopening logs"
+      Unicorn::Util.reopen_logs
+      logger.info "done reopening logs"
+      rescue => e
+        logger.error "failed reopening logs #{e.message}"
+    end
+
+    def join
+      begin
+        trap(:INT) { stop(false) } # Mongrel trapped INT for Win32...
+
+        # try these anyways regardless of platform...
+        trap(:TERM) { stop(false) }
+        trap(:QUIT) { stop }
+        trap(:USR1) { reopen_logs }
+        trap(:USR2) { reexec }
+
+        # no other way to reliably switch concurrency models...
+        trap(:HUP) { reexec; stop }
+
+        # technically feasible in some cases, just not sanely supportable:
+        %w(TTIN TTOU WINCH).each do |sig|
+          trap(sig) { logger.info "SIG#{sig} is not handled by Zbatery" }
+        end
+      rescue => e # hopefully ignores errors on Win32...
+        logger.error "failed to setup signal handler: #{e.message}"
+      end
+      worker = Worker.new(0, $stdout)
+      before_fork.call(self, worker)
+      worker_loop(worker) # runs forever
+    end
+
+    def stop(graceful = true)
+      Rainbows::G.quit!
+      exit!(0) unless graceful
+    end
+
+    def before_fork
+      hook = super
+      hook == FORK_HOOK or
+        logger.warn "calling before_fork without forking"
+      hook
+    end
+
+    def after_fork
+      hook = super
+      hook == FORK_HOOK or
+        logger.warn "calling after_fork without having forked"
+      hook
+    end
+  end
+end
+
+# :stopdoc:
+# override stuff we don't need or can't use portably
+module Rainbows
+
+  module Base
+    # master == worker in our case
+    def init_worker_process(worker)
+      after_fork.call(self, worker)
+      build_app! unless preload_app
+      logger.info "Zbatery #@use worker_connections=#@worker_connections"
+    end
+  end
+
+  # we can't/don't need to do the fchmod heartbeat Unicorn/Rainbows! does
+  def G.tick
+    alive
+  end
+end
+
+module Unicorn
+
+  class Configurator
+    DEFAULTS[:before_fork] = DEFAULTS[:after_fork] = Zbatery::FORK_HOOK
+  end
+
+  unless Zbatery::UnlinkedIO
+    require 'tempfile'
+    class Util
+
+      # Tempfiles should get automatically unlinked by GC
+      def self.tmpio
+        fp = Tempfile.new("zbatery")
+        fp.binmode
+        fp.sync = true
+        fp
+      end
+    end
+  end
+
+end

data/local.mk.sample

@@ -0,0 +1,78 @@
+
+# this is the local.mk file used by Eric Wong on his dev boxes.
+# GNUmakefile will source local.mk in the top-level source tree
+# if it is present.
+#
+# This is depends on a bunch of GNU-isms from bash, sed, touch.
+
+RSYNC = rsync
+DLEXT := so
+gems := rack-1.0.1
+# gems += unicorn-0.95.2 # installed via setup.rb
+# gems += rainbows-0.8.0 # installed via setup.rb
+gems += rev-0.3.1
+gems += iobuffer-0.1.1
+gems += eventmachine-0.12.10
+gems += async_sinatra-0.1.5 sinatra-0.9.4
+
+# Avoid loading rubygems to speed up tests because gmake is
+# fork+exec heavy with Ruby.
+prefix = $(HOME)
+ifeq ($(r19),)
+  RUBY := $(prefix)/bin/ruby
+  gem_paths := $(addprefix $(prefix)/lib/ruby/gems/1.8/gems/,$(gems))
+else
+  prefix := $(prefix)/ruby-1.9
+  export PATH := $(prefix)/bin:$(PATH)
+  RUBY := $(prefix)/bin/ruby --disable-gems
+  gems += case-0.5 revactor-0.1.5
+  gem_paths := $(addprefix $(prefix)/lib/ruby/gems/1.9.1/gems/,$(gems))
+endif
+
+ifdef gem_paths
+  sp :=
+  sp +=
+  export RUBYLIB := $(subst $(sp),:,$(addsuffix /lib,$(gem_paths)))
+endif
+
+# pipefail is THE reason to use bash (v3+) or never revisions of ksh93
+# SHELL := /bin/bash -e -o pipefail
+SHELL := /bin/ksh93 -e -o pipefail
+
+# trace execution of tests
+# TRACER = strace -f -o $(t_pfx).strace -s 100000
+TRACER = /usr/bin/time -v -o $(t_pfx).time
+
+full-test: test-18 test-19
+test-18:
+	$(MAKE) test 2>&1 | sed -e 's!^!1.8 !'
+test-19:
+	$(MAKE) test r19=t 2>&1 | sed -e 's!^!1.9 !'
+
+latest: NEWS
+	@awk 'BEGIN{RS="=== ";ORS=""}NR==2{sub(/\n$$/,"");print RS""$$0 }' < $<
+
+# publishes docs to http://zbatery.bogomip.org/
+publish_doc:
+	-git set-file-times
+	$(RM) -r doc ChangeLog NEWS
+	$(MAKE) doc LOG_VERSION=$(shell git tag -l | tail -1)
+	$(MAKE) -s latest > doc/LATEST
+	find doc/images doc/js -type f | \
+		TZ=UTC xargs touch -d '1970-01-01 00:00:00' doc/rdoc.css
+	$(MAKE) doc_gz
+	chmod 644 $$(find doc -type f)
+	$(RSYNC) -av doc/ dcvr:/srv/zbatery/
+	git ls-files | xargs touch
+
+# Create gzip variants of the same timestamp as the original so nginx
+# "gzip_static on" can serve the gzipped versions directly.
+doc_gz: docs = $(shell find doc -type f ! -regex '^.*\.\(gif\|jpg\|png\|gz\)$$')
+doc_gz:
+	touch doc/NEWS.atom.xml -d "$$(awk 'NR==1{print $$4,$$5,$$6}' NEWS)"
+	for i in $(docs); do \
+	  gzip --rsyncable -9 < $$i > $$i.gz; touch -r $$i $$i.gz; done
+
+# launches any of the following shells with RUBYLIB set
+irb sh bash ksh:
+	$@

data/man/man1/zbatery.1

@@ -0,0 +1,187 @@
+.TH zbatery 1 "December 9, 2009" "Zbatery User Manual"
+.SH NAME
+.PP
+zbatery - rackup-like command to launch Zbatery
+.SH SYNOPSIS
+.PP
+zbatery [-c CONFIG_FILE] [-E RACK_ENV] [-D] [RACKUP_FILE]
+.SH DESCRIPTION
+.PP
+A rackup(1)-like command to launch Rack applications using Zbatery.
+It is expected to be started in your application root (APP_ROOT),
+but \[lq]Dir.chdir\[rq] may also be executed in the CONFIG_FILE or
+RACKUP_FILE.
+.PP
+While Zbatery takes a myriad of command-line options for
+compatibility with ruby(1) and rackup(1), it is recommended to
+stick to the few command-line options specified in the SYNOPSIS and
+use the CONFIG_FILE as much as possible.
+.SH RACKUP FILE
+.PP
+This defaults to "config.ru" in APP_ROOT.
+It should be the same file used by rackup(1) and other Rack
+launchers, it uses the \f[I]Rack::Builder\f[] DSL.
+.PP
+Embedded command-line options are mostly parsed for compatibility
+with rackup(1) but strongly discouraged.
+.SH UNICORN OPTIONS
+.TP
+.B -c, --config-file CONFIG_FILE
+Path to the Unicorn-specific config file.
+The config file is implemented as a Ruby DSL, so Ruby code may
+executed (e.g.
+\[lq]Dir.chdir\[rq], \[lq]Process::UID.change_privilege\[rq]).
+See the RDoc/ri for the \f[I]Unicorn::Configurator\f[] class for
+the full list of directives available from the DSL.
+.RS
+.RE
+.TP
+.B -D, --daemonize
+Run daemonized in the background.
+The process is detached from the controlling terminal and stdin is
+redirected to \[lq]/dev/null\[rq].
+Unlike many common UNIX daemons, we do not chdir to "/" upon
+daemonization to allow more control over the startup/upgrade
+process.
+Unless specified in the CONFIG_FILE, stderr and stdout will also be
+redirected to \[lq]/dev/null\[rq].
+.RS
+.RE
+.TP
+.B -E, --env RACK_ENV
+Run under the given RACK_ENV.
+See the RACK ENVIRONMENT section for more details.
+.RS
+.RE
+.TP
+.B -l, --listen ADDRESS
+Listens on a given ADDRESS.
+ADDRESS may be in the form of HOST:PORT or PATH, HOST:PORT is taken
+to mean a TCP socket and PATH is meant to be a path to a UNIX
+domain socket.
+Defaults to \[lq]0.0.0.0:8080\[rq] (all addresses on TCP port 8080)
+For production deployments, specifying the \[lq]listen\[rq]
+directive in CONFIG_FILE is recommended as it allows fine-tuning of
+socket options.
+.RS
+.RE
+.SH RACKUP COMPATIBILITY OPTIONS
+.TP
+.B -o, --host HOST
+Listen on a TCP socket belonging to HOST, default is
+\[lq]0.0.0.0\[rq] (all addresses).
+If specified multiple times on the command-line, only the
+last-specified value takes effect.
+This option only exists for compatibility with the rackup(1)
+command, use of \[lq]-l\[rq]/\[lq]--listen\[rq] switch is
+recommended instead.
+.RS
+.RE
+.TP
+.B -p, --port PORT
+Listen on the specified TCP PORT, default is 8080.
+If specified multiple times on the command-line, only the
+last-specified value takes effect.
+This option only exists for compatibility with the rackup(1)
+command, use of \[lq]-l\[rq]/\[lq]--listen\[rq] switch is
+recommended instead.
+.RS
+.RE
+.TP
+.B -s, --server SERVER
+No-op, this exists only for compatibility with rackup(1).
+.RS
+.RE
+.SH RUBY OPTIONS
+.TP
+.B -e, --eval LINE
+Evaluate a LINE of Ruby code.
+This evaluation happens immediately as the command-line is being
+parsed.
+.RS
+.RE
+.TP
+.B -d, --debug
+Turn on debug mode, the $DEBUG variable is set to true.
+.RS
+.RE
+.TP
+.B -w, --warn
+Turn on verbose warnings, the $VERBOSE variable is set to true.
+.RS
+.RE
+.TP
+.B -I, --include PATH
+specify $LOAD_PATH.
+PATH will be prepended to $LOAD_PATH.
+The \[aq]:\[aq] character may be used to delimit multiple
+directories.
+This directive may be used more than once.
+Modifications to $LOAD_PATH take place immediately and in the order
+they were specified on the command-line.
+.RS
+.RE
+.TP
+.B -r, --require LIBRARY
+require a specified LIBRARY before executing the application.
+The "require" statement will be executed immediately and in the
+order they were specified on the command-line.
+.RS
+.RE
+.SH SIGNALS
+.PP
+The following UNIX signals may be sent to Zbatery (only supported
+on UNIX):
+.IP \[bu] 2
+HUP - reexecute the binary and exit the current one
+.IP \[bu] 2
+INT/TERM - quick shutdown, quit immediately
+.IP \[bu] 2
+QUIT - graceful shutdown, waits for current requests before exiting
+.IP \[bu] 2
+USR1 - reopen all logs owned by the master and all workers See
+Unicorn::Util.reopen_logs for what is considered a log.
+.IP \[bu] 2
+USR2 - reexecute the running binary.
+A separate QUIT should be sent to the original process once the
+child is verified to be up and running.
+.SH RACK ENVIRONMENT
+.PP
+Accepted values of RACK_ENV and the middleware they automatically
+load (outside of RACKUP_FILE) are exactly as those in rackup(1):
+.IP \[bu] 2
+development - loads Rack::CommonLogger, Rack::ShowExceptions, and
+Rack::Lint middleware
+.IP \[bu] 2
+deployment - loads Rack::CommonLogger middleware
+.IP \[bu] 2
+none - loads no middleware at all, relying entirely on RACKUP_FILE
+.PP
+All unrecognized values for RACK_ENV are assumed to be
+\[lq]none\[rq].
+Production deployments are strongly encouraged to use
+\[lq]deployment\[rq] or \[lq]none\[rq] for maximum performance.
+.PP
+Note that the Rack::ContentLength and Rack::Chunked middlewares are
+never loaded by default.
+If needed, they should be individually specified in the
+RACKUP_FILE, some frameworks do not require them.
+.SH SEE ALSO
+.IP \[bu] 2
+unicorn(1)
+.IP \[bu] 2
+rainbows(1)
+.IP \[bu] 2
+\f[I]Rack::Builder\f[] ri/RDoc
+.IP \[bu] 2
+\f[I]Unicorn::Configurator\f[] ri/RDoc
+.IP \[bu] 2
+Zbatery RDoc (http://zbatery.bogomip.org/)
+.IP \[bu] 2
+Rack RDoc (http://rack.rubyforge.org/doc/)
+.IP \[bu] 2
+Rackup HowTo (http://wiki.github.com/rack/rack/tutorial-rackup-howto)
+.IP \[bu] 2
+Rainbows! RDoc (http://rainbows.rubyforge.org/)
+.SH AUTHOR
+Zbatery hackers <rainbows-talk@rubyforge.org>