bluepill 0.0.51 → 0.0.52

data/.gitignore

@@ -1,8 +1,10 @@
 *.sw?
 .DS_Store
-coverage
-rdoc
-pkg/*
+coverage/
+.yardoc/
+doc/
+pkg/
 *.gem
-.bundle
+.bundle/
 Gemfile.lock
+.idea

data/.rspec

@@ -0,0 +1 @@
+-r ./spec/spec_helper.rb -c -f progress

data/Gemfile

@@ -2,3 +2,9 @@ source :rubygems
 
 # Specify your gem's dependencies in bluepill.gemspec
 gemspec
+
+# YARD helper for ruby 1.8 (already embedded into ruby 1.9)
+gem "ripper", :platforms => :ruby_18, :group => :development
+
+# Code coverage tool that works on Ruby 1.9
+gem "simplecov", ">= 0.4.0", :platforms => :ruby_19, :group => :test

data/README.md

@@ -119,6 +119,23 @@ If you want to run the process as someone other than root:
     end
 ```
 
+If you want to include one or more supplementary groups:
+
+```ruby
+    Bluepill.application("app_name") do |app|
+      app.process("process_name") do |process|
+        process.start_command = "/usr/bin/some_start_command"
+        process.pid_file = "/tmp/some_pid_file.pid"
+        process.uid = "deploy"
+        process.gid = "deploy"
+        process.supplementary_groups = ['rvm']
+
+        process.checks :cpu_usage, :every => 10.seconds, :below => 5, :times => 3
+        process.checks :mem_usage, :every => 10.seconds, :below => 100.megabytes, :times => [3,5]
+      end
+    end
+```
+
 You can also set an app-wide uid/gid:
 
 ```ruby
@@ -164,6 +181,35 @@ You can also have an app-wide working directory:
 
 Note: We also set the PWD in the environment to the working dir you specify. This is useful for when the working dir is a symlink. Unicorn in particular will cd into the environment variable in PWD when it re-execs to deal with a change in the symlink.
 
+By default, bluepill will send a SIGTERM to your process when stopping.
+To change the stop command:
+
+```ruby
+    Bluepill.application("app_name") do |app|
+      app.process("process_name") do |process|
+        process.start_command = "/usr/bin/some_start_command"
+        process.pid_file = "/tmp/some_pid_file.pid"
+        process.stop_command = "/user/bin/some_stop_command"
+      end
+    end
+```
+
+If you'd like to send a signal or signals to your process to stop it:
+
+```ruby
+    Bluepill.application("app_name") do |app|
+      app.process("process_name") do |process|
+        process.start_command = "/usr/bin/some_start_command"
+        process.pid_file = "/tmp/some_pid_file.pid"
+        process.stop_signals = [:quit, 30.seconds, :term, 5.seconds, :kill]
+      end
+    end
+```
+
+We added a line that will send a SIGQUIT, wait 30 seconds and check to
+see if the process is still up, send a SIGTERM, wait 5 seconds and check
+to see if the process is still up, and finally send a SIGKILL.
+
 And lastly, to monitor child processes:
 
 ```ruby

data/Rakefile

@@ -7,3 +7,32 @@ rescue LoadError
   $stderr.puts "Bundler not installed. You should install it with: gem install bundler"
 end
 
+$LOAD_PATH << File.expand_path('./lib', File.dirname(__FILE__))
+require 'bluepill/version'
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+
+  if RUBY_VERSION >= '1.9'
+    RSpec::Core::RakeTask.new(:cov) do |t|
+      ENV['ENABLE_SIMPLECOV'] = '1'
+      t.ruby_opts = '-w'
+      t.rcov_opts = %q[-Ilib --exclude "spec/*,gems/*"]
+    end
+  end
+rescue LoadError
+  $stderr.puts "RSpec not available. Install it with: gem install rspec-core rspec-expectations rr faker"
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |yard|
+    yard.options << "--title='bluepill #{Bluepill::VERSION}'"
+
+  end
+rescue LoadError
+  $stderr.puts "Please install YARD with: gem install yard"
+end
+

data/bin/bluepill

@@ -2,11 +2,20 @@
 require 'optparse'
 require 'bluepill'
 
+begin
+  require 'rbconfig'
+rescue LoadError
+end
+
+RbConfig = Config unless Object.const_defined?(:RbConfig)
+
 # Default options
 options = {
   :log_file   => "/var/log/bluepill.log",
-  :base_dir   => "/var/bluepill",
-  :privileged => true
+  :base_dir   => "/var/run/bluepill",
+  :privileged => true,
+  :timeout    => 10,
+  :attempts   => 1
 }
 
 OptionParser.new do |opts|
@@ -32,6 +41,10 @@ OptionParser.new do |opts|
     options[:timeout] = timeout
   end
 
+  opts.on('--attempts Count', Integer, "Attempts for commands sent to the daemon, in seconds. Defaults to 1.") do |attempts|
+    options[:attempts] = attempts
+  end
+
   help = proc do
     puts opts
     puts
@@ -95,8 +108,7 @@ if options[:command] == "load"
   if File.exists?(file)
     # Restart the ruby interpreter for the config file so that anything loaded here
     # does not stay in memory for the daemon
-    require 'rbconfig'
-    ruby = File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name'])
+    ruby = File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])
     load_path = File.expand_path("#{File.dirname(__FILE__)}/../lib")
     file_path = File.expand_path(file)
 
@@ -109,3 +121,4 @@ else
   target = ARGV.shift
   controller.handle_command(options[:application], options[:command], target)
 end
+

data/bluepill.gemspec

@@ -15,11 +15,17 @@ Gem::Specification.new do |s|
   s.description = %q{Bluepill keeps your daemons up while taking up as little resources as possible. After all you probably want the resources of your server to be used by whatever daemons you are running rather than the thing that's supposed to make sure they are brought back up, should they die or misbehave.}
 
   s.add_dependency 'daemons', '~> 1.1.0'
-  s.add_dependency 'state_machine', '~> 0.9.4'
+  s.add_dependency 'state_machine', '~> 1.1.0'
   s.add_dependency 'activesupport', '>= 3.0.0'
   s.add_dependency 'i18n', '>= 0.5.0'
 
   s.add_development_dependency 'bundler', '>= 1.0.10'
+  s.add_development_dependency 'rake', '!= 0.9.0'
+  s.add_development_dependency 'rspec-core', '~> 2.0'
+  s.add_development_dependency 'rspec-expectations', '~> 2.0'
+  s.add_development_dependency 'rr', '~> 1.0'
+  s.add_development_dependency 'faker', '~> 0.9'
+  s.add_development_dependency 'yard', '~> 0.7'
 
   s.files            = `git ls-files`.split("\n")
   s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -27,3 +33,4 @@ Gem::Specification.new do |s|
   s.require_paths    = ["lib"]
   s.extra_rdoc_files = ["LICENSE", "README.md"]
 end
+

data/lib/bluepill/application.rb

@@ -14,7 +14,7 @@ module Bluepill
 
       @foreground   = options[:foreground]
       self.log_file = options[:log_file]
-      self.base_dir = options[:base_dir] || '/var/bluepill'
+      self.base_dir = options[:base_dir] || '/var/run/bluepill'
       self.pid_file = File.join(self.base_dir, 'pids', self.name + ".pid")
       self.pids_dir = File.join(self.base_dir, 'pids', self.name)
 

data/lib/bluepill/dsl/process_factory.rb

@@ -74,6 +74,41 @@ module Bluepill
       else
         @@pid_files[pid_key] = 0
       end
+
+      #validate stop_signals array
+      stop_grace_time = process.attributes[:stop_grace_time]
+      stop_signals = process.attributes[:stop_signals]
+
+      unless stop_signals.nil?
+        #Start with the more helpful error messages before the 'odd number' message.
+        delay_sum = 0
+        stop_signals.each_with_index do |s_or_d, i|
+          if i % 2 == 0
+            signal = s_or_d
+            unless signal.is_a? Symbol
+              $stderr.puts "Config Error: Invalid stop_signals!  Expected a symbol (signal) at position #{i} instead of '#{signal}'."
+              exit(6)
+            end
+          else
+            delay = s_or_d
+            unless delay.is_a? Fixnum
+              $stderr.puts "Config Error: Invalid stop_signals!  Expected a number (delay) at position #{i} instead of '#{delay}'."
+              exit(6)
+            end
+            delay_sum += delay
+          end
+        end
+
+        unless stop_signals.size % 2 == 1
+          $stderr.puts "Config Error: Invalid stop_signals!  Expected an odd number of elements."
+          exit(6)
+        end
+
+        if stop_grace_time.nil? || stop_grace_time <= delay_sum
+          $stderr.puts "Config Error: Stop_grace_time should be greater than the sum of stop_signals delays!"
+          exit(6)
+        end
+      end
     end
 
     def validate_child_process!(child)

data/lib/bluepill/process.rb

@@ -35,7 +35,11 @@ module Bluepill
       :child_process_factory,
 
       :pid_command,
-      :auto_start
+      :auto_start,
+
+      :supplementary_groups,
+
+      :stop_signals
     ]
 
     attr_accessor :name, :watches, :triggers, :logger, :skip_ticks_until, :process_running
@@ -87,6 +91,7 @@ module Bluepill
       end
 
       before_transition any => any, :do => :notify_triggers
+      before_transition :stopping => any, :do => :clean_threads
 
       after_transition any => :starting, :do => :start_process
       after_transition any => :stopping, :do => :stop_process
@@ -101,6 +106,7 @@ module Bluepill
       @watches = []
       @triggers = []
       @children = []
+      @threads = []
       @statistics = ProcessStatistics.new
       @actual_pid = options[:actual_pid]
       self.logger = options[:logger]
@@ -134,6 +140,9 @@ module Bluepill
       # clear the memoization per tick
       @process_running = nil
 
+      # Deal with thread cleanup here since the stopping state isn't used
+      clean_threads if self.unmonitored?
+
       # run state machine transitions
       super
 
@@ -288,6 +297,30 @@ module Bluepill
           end
         end
 
+      elsif stop_signals
+        # issue stop signals with configurable delay between each
+        logger.warning "Sending stop signals to #{actual_pid}"
+        @threads << Thread.new(self, stop_signals.clone) do |process, stop_signals|
+          signal = stop_signals.shift
+          logger.info "Sending signal #{signal} to #{process.actual_pid}"
+          process.signal_process(signal.upcase) # send first signal
+
+          until stop_signals.empty?
+            # we already checked to make sure stop_signals had an odd number of items
+            delay = stop_signals.shift
+            signal = stop_signals.shift
+
+            logger.debug "Sleeping for #{delay} seconds"
+            sleep delay
+            #break unless signal_process(0) #break unless the process can be reached
+            unless process.signal_process(0)
+              logger.debug "Process has terminated."
+              break
+            end
+            logger.info "Sending signal #{signal} to #{process.actual_pid}"
+            process.signal_process(signal.upcase)
+          end
+        end
       else
         logger.warning "Executing default stop command. Sending TERM signal to #{actual_pid}"
         signal_process("TERM")
@@ -320,6 +353,11 @@ module Bluepill
       end
     end
 
+    def clean_threads
+      @threads.each { |t| t.kill }
+      @threads.clear
+    end
+
     def daemonize?
       !!self.daemonize
     end
@@ -422,7 +460,8 @@ module Bluepill
         :logger      => self.logger,
         :stdin       => self.stdin,
         :stdout      => self.stdout,
-        :stderr      => self.stderr
+        :stderr      => self.stderr,
+        :supplementary_groups => self.supplementary_groups
       }
     end
 

data/lib/bluepill/process_statistics.rb

@@ -1,19 +1,22 @@
 # -*- encoding: utf-8 -*-
 module Bluepill
   class ProcessStatistics
-    STRFTIME = "%m/%d/%Y %H:%I:%S"
+    STRFTIME = "%m/%d/%Y %H:%I:%S".freeze
+    EVENTS_TO_PERSIST = 10
+
+    attr_reader :events
 
     # possibly persist this data.
     def initialize
-      @events = Util::RotationalArray.new(10)
+      @events = Util::RotationalArray.new(EVENTS_TO_PERSIST)
     end
 
     def record_event(event, reason)
-      @events.push([event, reason, Time.now])
+      events.push([event, reason, Time.now])
     end
 
     def to_s
-      str = @events.reverse.map do |(event, reason, time)|
+      str = events.reverse.map do |(event, reason, time)|
         "  #{event} at #{time.strftime(STRFTIME)} - #{reason || "unspecified"}"
       end.join("\n")
 
@@ -21,3 +24,4 @@ module Bluepill
     end
   end
 end
+

data/lib/bluepill/socket.rb

@@ -4,22 +4,33 @@ require 'socket'
 module Bluepill
   module Socket
     TIMEOUT = 60 # Used for client commands
+    MAX_ATTEMPTS = 5
 
     extend self
 
-    def client(base_dir, name, &b)
-      UNIXSocket.open(socket_path(base_dir, name), &b)
+    def client(base_dir, name, &block)
+      UNIXSocket.open(socket_path(base_dir, name), &block)
     end
 
     def client_command(base_dir, name, command)
-      client(base_dir, name) do |socket|
-        Timeout.timeout(TIMEOUT) do
-          socket.puts command
-          Marshal.load(socket)
+      res = nil
+      MAX_ATTEMPTS.times do |current_attempt|
+        begin
+          client(base_dir, name) do |socket|
+            Timeout.timeout(TIMEOUT) do
+              socket.puts command
+              res = Marshal.load(socket.read)
+            end
+          end
+          break
+        rescue EOFError, Timeout::Error
+          if current_attempt == MAX_ATTEMPTS - 1
+            abort("Socket Timeout: Server may not be responding")
+          end
+          puts "Retry #{current_attempt + 1} of #{MAX_ATTEMPTS}"
         end
       end
-    rescue EOFError, Timeout::Error
-      abort("Socket Timeout: Server may not be responding")
+      res
     end
 
     def server(base_dir, name)

data/lib/bluepill/system.rb

@@ -62,7 +62,7 @@ module Bluepill
         # child
         rd.close
 
-        drop_privileges(options[:uid], options[:gid])
+        drop_privileges(options[:uid], options[:gid], options[:supplementary_groups])
 
         # if we cannot write the pid file as the provided user, err out
         exit unless can_write_pid_file(options[:pid_file], options[:logger])
@@ -113,7 +113,7 @@ module Bluepill
 
         pid = fork {
           # grandchild
-          drop_privileges(options[:uid], options[:gid])
+          drop_privileges(options[:uid], options[:gid], options[:supplementary_groups])
 
           Dir.chdir(ENV["PWD"] = options[:working_dir]) if options[:working_dir]
           options[:environment].each { |key, value| ENV[key.to_s] = value.to_s } if options[:environment]
@@ -192,14 +192,22 @@ module Bluepill
 
     # be sure to call this from a fork otherwise it will modify the attributes
     # of the bluepill daemon
-    def drop_privileges(uid, gid)
+    def drop_privileges(uid, gid, supplementary_groups)
       if ::Process::Sys.geteuid == 0
         uid_num = Etc.getpwnam(uid).uid if uid
         gid_num = Etc.getgrnam(gid).gid if gid
 
+        supplementary_groups ||= []
+
+        group_nums = supplementary_groups.map do |group|
+          Etc.getgrnam(group).gid
+        end
+
         ::Process.groups = [gid_num] if gid
+        ::Process.groups |= group_nums unless group_nums.empty?
         ::Process::Sys.setgid(gid_num) if gid
         ::Process::Sys.setuid(uid_num) if uid
+        ENV['HOME'] = Etc.getpwuid(uid_num).try(:dir) || ENV['HOME'] if uid
       end
     end
 

data/lib/bluepill/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding: utf-8 -*-
 module Bluepill
-  VERSION = "0.0.51".freeze
+  VERSION = "0.0.52".freeze
 end

data/spec/lib/bluepill/logger_spec.rb

@@ -0,0 +1,3 @@
+describe Bluepill::Logger do
+
+end

data/spec/lib/bluepill/process_statistics_spec.rb

@@ -0,0 +1,24 @@
+describe Bluepill::ProcessStatistics do
+  before(:each) do
+    @stats = Bluepill::ProcessStatistics.new
+  end
+
+  it "should record events" do
+    @stats.record_event('some event', 'some reason')
+    @stats.record_event('another event', 'another reason')
+    @stats.events.should have(2).events
+  end
+
+  it "should record #EVENTS_TO_PERSIST events" do
+    (2 * Bluepill::ProcessStatistics::EVENTS_TO_PERSIST).times do
+      @stats.record_event('some event', 'some reason')
+    end
+    @stats.events.should have(Bluepill::ProcessStatistics::EVENTS_TO_PERSIST).events
+  end
+
+  it "should return event history" do
+    @stats.record_event('some event', 'some reason')
+    @stats.to_s.should match(/some reason/)
+    @stats.to_s.should match(/event history/)
+  end
+end

data/spec/lib/bluepill/system_spec.rb

@@ -0,0 +1,36 @@
+describe Bluepill::System do
+  describe :pid_alive? do
+    it "should be true if process responds to zero signal" do
+      mock(::Process).kill(0, 555)
+      Bluepill::System.should be_pid_alive(555)
+    end
+
+    it "should be false if process throws exception on zero signal" do
+      mock(::Process).kill(0, 555) { raise Errno::ESRCH.new  }
+      Bluepill::System.should_not be_pid_alive(555)
+    end
+  end
+
+  describe :store do
+    it "should be Hash" do
+      Bluepill::System.store.should be_kind_of(Hash)
+    end
+
+    it "should return same Hash or every call" do
+      Bluepill::System.store.should be_equal(Bluepill::System.store) 
+    end
+
+    it "should store assigned pairs" do
+      Bluepill::System.store[:somekey] = 10
+      Bluepill::System.store[:somekey].should be_eql(10) 
+    end
+  end
+
+  describe :reset_data do
+    it 'should clear the #store' do
+      Bluepill::System.store[:anotherkey] = Faker::Lorem.sentence
+      Bluepill::System.reset_data
+      Bluepill::System.store.should be_empty
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+if RUBY_VERSION >= '1.9'
+  if ENV['ENABLE_SIMPLECOV']
+    require 'simplecov'
+    SimpleCov.start
+  end
+else
+  require 'rubygems'
+end
+
+require 'faker'
+require 'rspec/core'
+
+$LOAD_PATH.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+
+RSpec.configure do |conf|
+  conf.mock_with :rr
+end
+
+require 'bluepill'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bluepill
 version: !ruby/object:Gem::Version 
-  hash: 121
-  prerelease: 
+  hash: 119
+  prerelease: false
   segments: 
   - 0
   - 0
-  - 51
-  version: 0.0.51
+  - 52
+  version: 0.0.52
 platform: ruby
 authors: 
 - Arya Asemanfar
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-01 00:00:00 +04:00
+date: 2011-12-13 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,12 +44,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 51
+        hash: 19
         segments: 
+        - 1
+        - 1
         - 0
-        - 9
-        - 4
-        version: 0.9.4
+        version: 1.1.0
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -100,6 +100,97 @@ dependencies:
         version: 1.0.10
   type: :development
   version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "!="
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 9
+        - 0
+        version: 0.9.0
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec-core
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rspec-expectations
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: faker
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :development
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 7
+        version: "0.7"
+  type: :development
+  version_requirements: *id011
 description: Bluepill keeps your daemons up while taking up as little resources as possible. After all you probably want the resources of your server to be used by whatever daemons you are running rather than the thing that's supposed to make sure they are brought back up, should they die or misbehave.
 email: 
 - entombedvirus@gmail.com
@@ -114,6 +205,7 @@ extra_rdoc_files:
 - README.md
 files: 
 - .gitignore
+- .rspec
 - DESIGN.md
 - Gemfile
 - LICENSE
@@ -153,6 +245,10 @@ files:
 - lib/bluepill/triggers/flapping.rb
 - lib/bluepill/util/rotational_array.rb
 - lib/bluepill/version.rb
+- spec/lib/bluepill/logger_spec.rb
+- spec/lib/bluepill/process_statistics_spec.rb
+- spec/lib/bluepill/system_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/arya/bluepill
 licenses: []
@@ -183,9 +279,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A process monitor written in Ruby with stability and minimalism in mind.
-test_files: []
-
+test_files: 
+- spec/lib/bluepill/logger_spec.rb
+- spec/lib/bluepill/process_statistics_spec.rb
+- spec/lib/bluepill/system_spec.rb
+- spec/spec_helper.rb