sponges 0.0.1 → 0.0.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c)  chatgris <jboyer@af83.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,119 @@
+# sponges
+
+When I build workers, I want them to be like an army of spongebobs, always
+stressed and eager to work. `sponges` helps you build this army of sponges, to
+control them, and, well, to kill them gracefully. Making them stressed and eager
+to work is your job. :)
+
+Internally, `sponges` strongly relies on Unix signals.
+
+## Is it any good?
+
+[Yes.](http://news.ycombinator.com/item?id=3067434)
+
+## Production ready ?
+
+Not yet, but soon.
+
+## Installation
+
+Ruby 1.9.2 (or superior) and Redis are required.
+
+Install it with rubygems:
+
+    gem install sponges
+
+With bundler, add it to your `Gemfile`:
+
+``` ruby
+gem "sponges"
+```
+
+## Usage
+In a file called `example.rb`:
+
+``` ruby
+# The worker class is the one you want to daemonize.
+#
+require 'sponges'
+
+class Worker
+  def run
+    # Trap the HUP signal, set a boolean to true.
+    trap(:HUP) {
+      Sponges.logger.info "HUP signal trapped, clean stop."
+      @hup = true
+    }
+    Sponges.logger.info Process.pid
+    if @hup # is true, we need to shutdown this worker
+      Sponges.logger.info "HUP signal trapped, shutdown..."
+      exit 0 # everything's fine, we can exit
+    else # this worker can continue its work
+      sleep rand(20)
+      run
+    end
+  end
+end
+
+Sponges.configure do |config|
+  config.worker        = Worker.new           # mandatory
+  config.worker_name   = "bob"                # mandatory
+  config.worker_method = :run                 # mandatory
+  config.worker_args   = {first: true}        # mandatory
+  config.logger        = MyCustomLogger.new   # optionnal
+  config.redis         = Redis.new            # optionnal
+end
+
+Sponges.start
+```
+See the help message :
+``` bash
+ruby example.rb
+```
+
+Start workers :
+``` bash
+ruby example.rb start
+```
+
+Start workers and daemonize them:
+``` bash
+ruby example.rb start -d
+```
+
+Start 8 instances of the worker and daemonize them:
+``` bash
+ruby example.rb start -d -s 8
+```
+
+Retart gracefully 4 instances of the worker and daemonize them:
+``` bash
+ruby example.rb restart -g -d -s 4
+```
+
+Stop workers with a `QUIT` signal :
+``` bash
+ruby example.rb stop
+```
+
+Stop workers with a `HUP` signal :
+``` bash
+ruby example.rb stop -g
+```
+In this case, you will have to trap the `HUP` signal, and handle a clean stop
+from each workers. The point is to wait for a task to be done before quitting.
+
+Show a list of workers and their children.
+``` bash
+ruby example.rb list
+```
+
+## TODO
+
+* Specing.
+* Increment / decrement workers pool size with `TTIN` and `TTOUT`.
+* Check on OSX.
+
+## Copyright
+
+MIT. See LICENSE for further details.

data/lib/sponges/cli.rb

@@ -1,19 +1,31 @@
 # encoding: utf-8
 module Sponges
+  # This class concern is to expose a nice CLI interface.
+  #
   class Cli  < Boson::Runner
     option :daemonize,  type: :boolean
     option :size,       type: :numeric
     desc "Start workers"
     def start(options = {})
       Sponges::Runner.new(Sponges::Configuration.worker_name, options).
-        work(Sponges::Configuration.worker, Sponges::Configuration.worker_method)
+        work(Sponges::Configuration.worker, Sponges::Configuration.worker_method,
+             Sponges::Configuration.worker_args)
     end
 
     option :gracefully, type: :boolean
     desc "Stop workers"
     def stop(options = {})
-      Sponges::Runner.new(Sponges::Configuration.worker_name, options).
-        rest
+      Sponges::Commander.new(Sponges::Configuration.worker_name, options).
+        stop
+    end
+
+    option :daemonize,  type: :boolean
+    option :size,       type: :numeric
+    option :gracefully, type: :boolean
+    desc "Restart workers"
+    def restart(options = {})
+      stop(options)
+      start(options)
     end
 
     desc "Show running processes"
@@ -28,13 +40,16 @@ module Sponges
     |_|                |___/
 }.gsub(/^\n/, '') + "\n"
       puts "Workers:"
-      Array(redis[:workers].smembers).each do |worker|
-        puts worker.rjust(6)
-        puts "supervisor".rjust(15)
-        puts redis[:worker][worker][:supervisor].get.rjust(12)
-        puts "children".rjust(13)
-        Array(redis[:worker][worker][:pids].smembers).each do |pid|
-          puts pid.rjust(12)
+      Array(redis[:hostnames].smembers).each do |hostname|
+        puts hostname.rjust(6)
+        Array(redis[hostname][:workers].smembers).each do |worker|
+          puts worker.rjust(6)
+          puts "supervisor".rjust(15)
+          puts redis[hostname][:worker][worker][:supervisor].get.rjust(12)
+          puts "children".rjust(13)
+          Array(redis[hostname][:worker][worker][:pids].smembers).each do |pid|
+            puts pid.rjust(12)
+          end
         end
       end
       puts "\n"

data/lib/sponges/commander.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+module Sponges
+  # This class concern is to send messages to supervisor. It's used to send
+  # messages like 'stop' or 'restart'
+  #
+  class Commander
+    def initialize(name, options = {})
+      @name, @options = name, options
+      @redis = Nest.new('sponges', Configuration.redis || Redis.new)[Socket.gethostname]
+    end
+
+    def stop
+      Sponges.logger.info "Runner #{@name} stop message received."
+      if pid = @redis[:worker][@name][:supervisor].get
+        begin
+          Process.kill gracefully? ? :HUP : :QUIT, pid.to_i
+          while alive?(pid.to_i) do
+            Sponges.logger.info "Supervisor #{pid} still alive"
+            sleep 0.5
+          end
+          Sponges.logger.info "Supervisor #{pid} has stopped."
+        rescue Errno::ESRCH => e
+          Sponges.logger.error e
+        end
+      else
+        Sponges.logger.info "No supervisor found."
+      end
+    end
+
+    private
+
+    def alive?(pid)
+      begin
+        Process.kill 0, pid
+        true
+      rescue Errno::ESRCH => e
+        false
+      end
+    end
+
+    def gracefully?
+      !!@options[:gracefully]
+    end
+  end
+end

data/lib/sponges/configuration.rb

@@ -1,8 +1,10 @@
 # encoding: utf-8
 module Sponges
+  # This class concern is to provide a global object for configuration needs.
+  #
   class Configuration
     class << self
-      ACCESSOR = [:worker_name, :worker, :worker_method, :logger]
+      ACCESSOR = [:worker_name, :worker, :worker_method, :worker_args, :logger, :redis]
       attr_accessor *ACCESSOR
 
       def configure

data/lib/sponges/cpu_infos.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 class CpuInfo
+  # This class concern is to grab some informations about hardware.
+  #
   class << self
     def cores_size
       `grep -c processor /proc/cpuinfo`.to_i

data/lib/sponges/runner.rb

@@ -1,16 +1,19 @@
 # encoding: utf-8
 module Sponges
+  # This class concern is to create a Supervisor, set some signals handlers and
+  # watch over the supervisor.
+  #
   class Runner
     def initialize(name, options = {})
       @name = name
       @options = default_options.merge options
-      @redis = Nest.new('sponges')
+      @redis = Nest.new('sponges', Configuration.redis || Redis.new)
+      @redis[:hostnames].sadd Socket.gethostname
     end
 
     def work(worker, method, *args, &block)
       Sponges.logger.info "Runner #{@name} start message received."
       @supervisor = fork_supervisor(worker, method, *args, &block)
-      @redis[:worker][@name][:supervisor].set @supervisor
       trap_signals
       Sponges.logger.info "Supervisor started with #{@supervisor} pid."
       if daemonize?
@@ -21,19 +24,6 @@ module Sponges
       end
     end
 
-    def rest
-      Sponges.logger.info "Runner #{@name} stop message received."
-      if pid = @redis[:worker][@name][:supervisor].get
-        begin
-          Process.kill gracefully? ? :HUP : :QUIT, pid.to_i
-        rescue Errno::ESRCH => e
-          Sponges.logger.error e
-        end
-      else
-        Sponges.logger.info "No supervisor found."
-      end
-    end
-
     private
 
     def trap_signals
@@ -63,9 +53,5 @@ module Sponges
     def daemonize?
       !!@options[:daemonize]
     end
-
-    def gracefully?
-      !!@options[:gracefully]
-    end
   end
 end

data/lib/sponges/supervisor.rb

@@ -4,8 +4,9 @@ module Sponges
     def initialize(name, options, worker, method, *args, &block)
       @name, @options = name, options
       @worker, @method, @args, @block = worker, method, args, block
-      @redis = Nest.new('sponges')
+      @redis = Nest.new('sponges', Configuration.redis || Redis.new)[Socket.gethostname]
       @redis[:workers].sadd name
+      @redis[:worker][@name][:supervisor].set Process.pid
       @pids = @redis[:worker][name][:pids]
       @children_seen = 0
     end
@@ -15,6 +16,10 @@ module Sponges
         fork_children
       end
       trap_signals
+      at_exit do
+        Sponges.logger.info "Supervisor exits."
+      end
+      Sponges.logger.info "Supervisor started, waiting for messages."
       sleep
     end
 
@@ -50,7 +55,7 @@ module Sponges
               fork_children
             end
           rescue Errno::ECHILD => e
-            Sponges.logger.error e
+            # Don't panic
           end
         end
       end
@@ -62,7 +67,10 @@ module Sponges
       Process.waitall
       Sponges.logger.info "Children shutdown complete."
       Sponges.logger.info "Supervisor shutdown. Exiting..."
-      Process.kill :USR1, @redis[:worker][@name][:supervisor].to_i
+      pid = @redis[:worker][@name][:supervisor]
+      @redis[:worker][@name][:supervisor].del
+      @redis[:workers].srem @name
+      Process.kill :USR1, pid.to_i
     end
 
     def kill_them_all(signal)

data/lib/sponges/version.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module Sponges
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/sponges/worker_builder.rb

@@ -1,5 +1,8 @@
 # encoding: utf-8
 module Sponges
+  # This class concern is to build a worker instance, set some signals handlers
+  # and make it start its job.
+  #
   class WorkerBuilder
     def initialize(worker, method, *args, &block)
       @worker, @method, @args, @block = worker, method, args, block
@@ -7,6 +10,9 @@ module Sponges
 
     def start
       trap_signals
+      at_exit do
+        Sponges.logger.info "Child exits."
+      end
       @worker.send(@method, *@args, &@block)
     end
 

data/lib/sponges.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 require 'boson/runner'
+require 'socket'
 require 'logger'
 require 'nest'
 require_relative 'sponges/configuration'
@@ -7,6 +8,7 @@ require_relative 'sponges/cpu_infos'
 require_relative 'sponges/worker_builder'
 require_relative 'sponges/supervisor'
 require_relative 'sponges/runner'
+require_relative 'sponges/commander'
 require_relative 'sponges/cli'
 
 module Sponges
@@ -17,8 +19,8 @@ module Sponges
   end
   module_function :configure
 
-  def start
-    Sponges::Cli.start
+  def start(options = ARGV)
+    Sponges::Cli.start(options)
   end
   module_function :start
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sponges
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-26 00:00:00.000000000 Z
+date: 2012-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: boson
@@ -43,6 +43,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: sys-proctable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: When I build some worker, I want them to be like an army of spongebob,
   always stressed and eager to work. sponges helps you to build this army of sponge,
   to control them, and, well, kill them gracefully.
@@ -52,8 +84,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/sponges.rb
 - lib/sponges/cli.rb
+- lib/sponges/commander.rb
 - lib/sponges/configuration.rb
 - lib/sponges/cpu_infos.rb
 - lib/sponges/runner.rb