kennethkalmer-daemon-kit 0.1.6 → 0.1.7.3

data/lib/daemon_kit/initializer.rb

@@ -3,7 +3,15 @@ require 'pathname'
 
 DAEMON_ENV = (ENV['DAEMON_ENV'] || 'development').dup unless defined?(DAEMON_ENV)
 
-$:.unshift File.dirname(__FILE__) + '/..'
+# Absolute paths to the daemon_kit libraries added to $:
+incdir = ( File.dirname(__FILE__) + '/..' )
+absincdir = if RUBY_PLATFORM =~ /(:?mswin|mingw)/
+              File.expand_path( incdir )
+            else
+              File.expand_path( Pathname.new( incdir ).realpath.to_s )
+            end
+$:.unshift absincdir unless $:.include?( absincdir )
+
 require 'daemon_kit'
 
 module DaemonKit
@@ -26,17 +34,29 @@ module DaemonKit
       @configuration = configuration
     end
 
+    def arguments
+      @arguments
+    end
+
+    def arguments=( args )
+      @arguments = args
+    end
+
     def trap( *args, &block )
       self.configuration.trap( *args, &block )
     end
 
     def framework_root
-      File.join( File.dirname(__FILE__), '..', '..' )
+      @framework_root ||= File.join( File.dirname(__FILE__), '..', '..' ).to_absolute_path
     end
 
     def root
       DAEMON_ROOT
     end
+
+    def env
+      DAEMON_ENV
+    end
   end
 
 
@@ -46,7 +66,9 @@ module DaemonKit
 
     attr_reader :configuration
 
-    def self.run( configuration = Configuration.new )
+    def self.run
+      configuration = DaemonKit.configuration || Configuration.new
+
       yield configuration if block_given?
       initializer = new configuration
       initializer.before_daemonize
@@ -83,6 +105,8 @@ module DaemonKit
 
       include_core_lib
       load_postdaemonize_configs
+
+      set_process_name
     end
 
     def set_load_path
@@ -96,9 +120,7 @@ module DaemonKit
     end
 
     def load_patches
-      if !!configuration.force_kill_wait
-        require 'daemon_kit/patches/force_kill_wait'
-      end
+
     end
 
     def load_environment
@@ -159,6 +181,10 @@ module DaemonKit
         require core_lib
       end
     end
+
+    def set_process_name
+      $0 = configuration.daemon_name
+    end
   end
 
   # Holds our various configuration values
@@ -175,21 +201,15 @@ module DaemonKit
     # Path to the log file, defaults to 'log/<environment>.log'
     attr_accessor :log_path
 
-    # :system,
-    attr_accessor :dir_mode
-
-    # Path to the log file, defaults to 'log/<environment>.log'
-    attr_accessor :dir
-
     # Provide a custom logger to use
     attr_accessor :logger
 
+    # Path to the pid file, defaults to 'log/<daemon_name>.pid'
+    attr_accessor :pid_file
+
     # The application name
     attr_accessor :daemon_name
 
-    # Allow multiple copies to run?
-    attr_accessor :multiple
-
     # Use the force kill patch? Give the number of seconds
     attr_accessor :force_kill_wait
 
@@ -200,6 +220,8 @@ module DaemonKit
     attr_accessor :safety_net
 
     def initialize
+      parse_arguments!
+
       set_root_path!
       set_daemon_defaults!
 
@@ -207,7 +229,6 @@ module DaemonKit
       self.log_level  = default_log_level
       self.log_path   = default_log_path
 
-      self.multiple = false
       self.force_kill_wait = false
 
       self.safety_net = DaemonKit::Safety.instance
@@ -240,6 +261,10 @@ module DaemonKit
       @signal_traps[signal].unshift( proc || block )
     end
 
+    def pid_file
+      @pid_file ||= "#{File.dirname(self.log_path)}/#{self.daemon_name}.pid"
+    end
+
     protected
 
     def run_traps( signal )
@@ -255,28 +280,55 @@ module DaemonKit
       Signal.trap( signal, Proc.new { self.run_traps( signal ) } )
     end
 
+    def parse_arguments!
+      configs = Arguments.configuration( ARGV ).first
+      @unused_arguments = {}
+
+      configs.each do |c|
+        k,v = c.split('=')
+
+        if v.nil?
+          error( "#{k} has no value" )
+          next
+        end
+
+        begin
+          if self.respond_to?( k )
+            self.send( "#{k}=", v ) # pid_file = /var/run/foo.pid
+          else
+            @unused_arguments[ k ] = v
+          end
+        rescue => e
+          error( "Couldn't set `#{k}' to `#{v}': #{e.message}" )
+        end
+      end
+    end
+
+    # DANGEROUS: Change the value of DAEMON_ENV
+    def environment=( env )
+      ::DAEMON_ENV.replace( env )
+    end
+
     def set_root_path!
       raise "DAEMON_ROOT is not set" unless defined?(::DAEMON_ROOT)
-      raise "DAEMON_ROOT is not a directory" unless defined?(::DAEMON_ROOT)
+      raise "DAEMON_ROOT is not a directory" unless File.directory?(::DAEMON_ROOT)
 
-      @root_path =
+      @root_path = ::DAEMON_ROOT.to_absolute_path
         # Pathname is incompatible with Windows, but Windows doesn't have
         # real symlinks so File.expand_path is safe.
-        if RUBY_PLATFORM =~ /(:?mswin|mingw)/
-          File.expand_path(::DAEMON_ROOT)
+        #if RUBY_PLATFORM =~ /(:?mswin|mingw)/
+        #  File.expand_path(::DAEMON_ROOT)
 
         # Otherwise use Pathname#realpath which respects symlinks.
-        else
-          Pathname.new(::DAEMON_ROOT).realpath.to_s
-        end
+        #else
+        #  File.expand_path( Pathname.new(::DAEMON_ROOT).realpath.to_s )
+        #end
 
       Object.const_set(:RELATIVE_DAEMON_ROOT, ::DAEMON_ROOT.dup) unless defined?(::RELATIVE_DAEMON_ROOT)
       ::DAEMON_ROOT.replace @root_path
     end
 
     def set_daemon_defaults!
-      self.dir_mode = :normal
-      self.dir      = File.join( DAEMON_ROOT, 'log' )
     end
 
     def default_load_paths
@@ -290,6 +342,16 @@ module DaemonKit
     def default_log_level
       environment == 'production' ? Logger::INFO : Logger::DEBUG
     end
+
+    def error( msg )
+      msg = "[E] Configuration: #{msg}"
+
+      if DaemonKit.logger
+        DaemonKit.logger.error( msg )
+      else
+        STDERR.puts msg
+      end
+    end
   end
 
 

data/lib/daemon_kit/pid_file.rb

@@ -0,0 +1,61 @@
+module DaemonKit
+
+  # Simple pidfile handling for daemon processes
+  class PidFile
+
+    def initialize( path )
+      @path = path.to_absolute_path
+    end
+
+    def exists?
+      File.exists?( @path )
+    end
+
+    # Returns true if the process is running
+    def running?
+      return false unless self.exists?
+
+      # Check if process is in existence
+      # The simplest way to do this is to send signal '0'
+      # (which is a single system call) that doesn't actually
+      # send a signal
+      begin
+        Process.kill(0, self.pid)
+        return true
+      rescue Errno::ESRCH
+        return false
+      rescue ::Exception   # for example on EPERM (process exists but does not belong to us)
+        return true
+      #rescue Errno::EPERM
+      #  return false
+      end
+    end
+
+    # Return the pid contained in the pidfile, or nil
+    def pid
+      return nil unless self.exists?
+
+      File.open( @path ) { |f|
+        return f.gets.to_i
+      }
+    end
+
+    def ensure_stopped!
+      if self.running?
+        puts "Process already running with id #{self.pid}"
+        exit 1
+      end
+    end
+
+    def cleanup
+      File.delete( @path ) rescue Errno::ENOENT
+    end
+    alias zap cleanup
+
+    def write!
+      File.open( @path, 'w' ) { |f|
+        f.puts Process.pid
+      }
+    end
+  end
+end

data/lib/daemon_kit/tasks/environment.rake

@@ -1,9 +1,10 @@
 task :environment do
-  # This relies on the fact that rake changes the currect working
-  # directory to the directory where the Rakefile is located, thus
-  # implying DAEMON_ROOT.
-  DAEMON_ROOT = '.'
   $daemon_kit_rake_task = true
 
   require 'config/environment'
 end
+
+task "Execute system commands in other tasks with sudo"
+task :sudo do
+  $RAKE_USE_SUDO = true
+end

data/lib/daemon_kit/tasks/framework.rake

@@ -76,7 +76,7 @@ namespace :daemon_kit do
   desc "Upgrade your local files for a daemon after upgrading daemon-kit"
   task :upgrade => 'environment' do
     # Run these
-    %w{ initializers }.each do |t|
+    %w{ initializers rakefile scripts }.each do |t|
       Rake::Task["daemon_kit:upgrade:#{t}"].invoke
     end
 
@@ -87,6 +87,8 @@ namespace :daemon_kit do
   namespace :upgrade do
     # Upgrade the initializers
     task :initializers do
+      copy_framework_template( 'config/boot.rb', 'config/boot.rb' )
+
       if File.directory?( File.join(DaemonKit.root, 'config', 'initializers') )
         mv File.join(DaemonKit.root, 'config', 'initializers'), File.join(DAEMON_ROOT, 'config', 'pre-daemonize')
         copy_framework_template( 'config', 'pre-daemonize', 'readme' )
@@ -97,6 +99,18 @@ namespace :daemon_kit do
         copy_framework_template( 'config', 'post-daemonize', 'readme' )
       end
     end
+
+    # Upgrade the Rakefile
+    task :rakefile do
+      copy_framework_template( 'Rakefile' )
+    end
+
+    # Upgrade the scripts
+    task :scripts do
+      %w{ console destroy generate }.each do |s|
+        copy_framework_template( "script", s )
+      end
+    end
   end
 end
 

data/lib/daemon_kit/tasks/god.rake

@@ -0,0 +1,62 @@
+require 'erb'
+
+namespace :god do
+  desc "Generate a stub god config file template for the daemon"
+  task :template => 'environment' do
+    # Preserve local changes
+    if File.exists?( "#{DaemonKit.root}/config/god.erb" ) && ENV['FORCE'].nil?
+      puts "Template already exists, use FORCE=1 to overwrite."
+      exit 1
+    end
+
+    cp "#{DaemonKit.framework_root}/templates/god/god.erb", "#{DaemonKit.root}/config/god.erb"
+  end
+
+  desc "Parse the god config template into a god config file"
+  task :generate => 'environment' do
+
+    unless File.exists?( "#{DaemonKit.root}/config/god.erb" )
+      Rake::Task["god:template"].invoke
+    end
+
+    name = DaemonKit.configuration.daemon_name
+
+    File.open( "#{DaemonKit.root}/config/#{name}.god", "w+" ) do |f|
+      t = File.read( "#{DaemonKit.root}/config/god.erb" )
+      f.write( ERB.new( t ).result( binding )  )
+    end
+
+    puts "Monit config generated in config/#{name}.god"
+  end
+
+  desc "Load the god file into god"
+  task :load => 'environment' do
+    name = DaemonKit.configuration.daemon_name
+
+    sh "#{$RAKE_USE_SUDO ? 'sudo' : ''} god load #{DaemonKit.root}/config/#{name}.god"
+  end
+
+  desc "Refresh the god config file in the running god"
+  task :refresh => 'environment' do
+    name = DaemonKit.configuration.daemon_name
+
+    sh "#{$RAKE_USE_SUDO ? 'sudo' : ''} god unmonitor #{name}"
+    sh "#{$RAKE_USE_SUDO ? 'sudo' : ''} god remove #{name}"
+    sh "#{$RAKE_USE_SUDO ? 'sudo' : ''} god load #{DaemonKit.root}/config/#{name}.god"
+    sh "#{$RAKE_USE_SUDO ? 'sudo' : ''} god monitor #{name}"
+  end
+
+  desc "Start god monitoring of the config file"
+  task :monitor => 'environment' do
+    name = DaemonKit.configuration.daemon_name
+
+    sh "#{$RAKE_USE_SUDO ? 'sudo' : ''} god monitor #{name}"
+  end
+
+  desc "Stop god monitoring of the config file"
+  task :unmonitor => 'environment' do
+    name = DaemonKit.configuration.daemon_name
+
+    sh "#{$RAKE_USE_SUDO ? 'sudo' : ''} god unmonitor #{name}"
+  end
+end

data/lib/daemon_kit/tasks/monit.rake

@@ -0,0 +1,29 @@
+require 'erb'
+
+namespace :monit do
+  desc "Generate a stub monit config file template for the daemon"
+  task :template => 'environment' do
+    # Preserve local changes
+    if File.exists?( "#{DaemonKit.root}/config/monit.erb" ) && ENV['FORCE'].nil?
+      puts "Template already exists, use FORCE=1 to overwrite."
+      exit 1
+    end
+
+    cp "#{DaemonKit.framework_root}/templates/monit/monit.erb", "#{DaemonKit.root}/config/monit.erb"
+  end
+
+  desc "Parse the monit config template into a monit config file"
+  task :generate => 'environment' do
+
+    unless File.exists?( "#{DaemonKit.root}/config/monit.erb" )
+      Rake::Task["monit:template"].invoke
+    end
+
+    File.open( "#{DaemonKit.root}/config/monit.conf", "w+" ) do |f|
+      t = File.read( "#{DaemonKit.root}/config/monit.erb" )
+      f.write( ERB.new( t ).result( binding )  )
+    end
+
+    puts "Monit config generated in config/monit.conf"
+  end
+end

data/lib/daemon_kit.rb

@@ -1,17 +1,23 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
+# TODO: Strip this out eventually so we can run without rubygems
 require 'rubygems'
 
+require File.dirname(__FILE__) + '/daemon_kit/core_ext'
+
+$:.unshift( File.dirname(__FILE__).to_absolute_path ) unless
+  $:.include?( File.dirname(__FILE__).to_absolute_path )
+
 module DaemonKit
-  VERSION = '0.1.6'
+  VERSION = '0.1.7.3'
 
   autoload :Initializer, 'daemon_kit/initializer'
   autoload :Application, 'daemon_kit/application'
+  autoload :Arguments,   'daemon_kit/arguments'
   autoload :Config,      'daemon_kit/config'
+  autoload :Safety,      'daemon_kit/safety'
+  autoload :PidFile,     'daemon_kit/pid_file'
+
   autoload :Cron,        'daemon_kit/cron'
   autoload :Jabber,      'daemon_kit/jabber'
   autoload :AMQP,        'daemon_kit/amqp'
   autoload :Nanite,      'daemon_kit/nanite'
-  autoload :Safety,      'daemon_kit/safety'
 end