daemon-kit 0.1.7 → 0.1.7.4

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/log.rake

@@ -0,0 +1,8 @@
+namespace :log do
+  desc "Truncate all log files found in DAEMON_ROOT/log/"
+  task :truncate => 'environment' do
+    Dir[ "#{DaemonKit.root}/log/*.log" ].each do |l|
+      File.open( l, 'w+' ) { |f| f.write('') }
+    end
+  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/spec/argument_spec.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe DaemonKit::Arguments do
+
+  describe "parsing ARGV" do
+
+    it "should extract the given command" do
+      argv = [ 'start', '-f', 'foo' ]
+      res = DaemonKit::Arguments.parse( argv )
+
+      res.first.should == :start
+    end
+
+    it "should have a default command if missing" do
+      argv = [ '-h' ]
+      res = DaemonKit::Arguments.parse( argv )
+
+      res.first.should == :run
+    end
+
+    it "should extract explicit configuration options" do
+      argv = [ 'start', '--config', 'environment=development' ]
+      res = DaemonKit::Arguments.parse( argv )
+
+      res.shift
+      res.first.should == [ 'environment=development' ]
+
+      res.last.should == []
+    end
+
+    it "should extract implicit configuration options" do
+      argv = [ '-e', 'production' ]
+      res = DaemonKit::Arguments.parse( argv )
+
+      res.shift
+      res.first.should == ['environment=production']
+
+      res.last.should == []
+    end
+
+    it "should extract daemon options" do
+      argv = [ 'start', '-h' ]
+      res = DaemonKit::Arguments.parse( argv )
+
+      res.shift
+      res.first.should == []
+
+      res.last.should == [ '-h' ]
+    end
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,77 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe DaemonKit::Config do
+
+  describe "working with config data" do
+    before(:each) do
+      @config = DaemonKit::Config.new('foo' => 'bar')
+    end
+
+    it "should have string key access to values" do
+      @config['foo'].should == 'bar'
+    end
+
+    it "should have symbol key access to values" do
+      @config[:foo].should == 'bar'
+    end
+
+    it "should have instance accessors to values" do
+      @config.foo.should == 'bar'
+    end
+
+    it "should return the config as a has" do
+      @config.to_h.should == { 'foo' => 'bar' }
+    end
+
+    it "should be able to symbolize keys in returned hash" do
+      @config.to_h(true).should == { :foo => 'bar' }
+    end
+
+    it "should symbolize keys in a nested fashion"
+  end
+
+  describe "parsing files" do
+    before(:all) do
+      FileUtils.mkdir_p( DAEMON_ROOT + "/config" )
+      FileUtils.cp( File.dirname(__FILE__) + '/fixtures/env.yml', DAEMON_ROOT + '/config/' )
+      FileUtils.cp( File.dirname(__FILE__) + '/fixtures/noenv.yml', DAEMON_ROOT + '/config/' )
+    end
+
+    it "should parse env keys correctly" do
+      config = DaemonKit::Config.load('env')
+
+      config.test.should == 'yes!'
+      config.array.should_not be_empty
+    end
+
+    it "should not be worried about missing env keys" do
+      config = DaemonKit::Config.load('noenv')
+
+      config.string.should == 'value'
+    end
+
+    it "should accept symbol file names" do
+      config = DaemonKit::Config.load(:env)
+      config.test.should == 'yes!'
+    end
+
+    it "should bail on missing files" do
+      lambda {
+        DaemonKit::Config.load('missing')
+      }.should raise_error(ArgumentError)
+    end
+
+    it "should give direct hash access to a config" do
+      config = DaemonKit::Config.hash(:env)
+
+      config.should be_a_kind_of(Hash)
+      config.keys.should include('test')
+    end
+
+    it "should give direct symbolized hash access to a config" do
+      config = DaemonKit::Config.hash(:env, true)
+
+      config.keys.should include(:test)
+    end
+  end
+end

data/spec/daemon_kit_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
 
 describe DaemonKit do
-  
+
   it "should work"
-  
+
 end

data/spec/error_handlers_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe DaemonKit::Safety do
+end
+
+describe DaemonKit::ErrorHandlers::Mail do
+  it "should send an email report" do
+    conf = Object.new
+    conf.stubs(:daemon_name).returns('test')
+    DaemonKit.stubs(:configuration).returns(conf)
+
+    fake_smtp = Object.new
+    fake_smtp.expects(:start).with('localhost.localdomain', nil, nil, nil)
+    Net::SMTP.expects(:new).with('localhost', 25).returns(fake_smtp)
+
+    begin
+      raise RuntimeError, "specs don't fail :)"
+    rescue => e
+      handler = DaemonKit::ErrorHandlers::Mail.instance
+      handler.handle_exception( e )
+    end
+  end
+end

data/spec/fixtures/env.yml

@@ -0,0 +1,15 @@
+# Test ENV keys
+
+defaults: &defaults
+  string: value
+  array:
+    - entry
+    - entry
+
+development:
+  test: no!
+  <<: *defaults
+
+test:
+  test: yes!
+  <<: *defaults

data/spec/fixtures/noenv.yml

@@ -0,0 +1,4 @@
+string: value
+array:
+  - entry
+  - entry

data/spec/initializer_spec.rb

@@ -1,10 +1,11 @@
 require File.dirname(__FILE__) + '/spec_helper'
+require 'daemon_kit/initializer'
 
 describe DaemonKit::Configuration do
   before(:each) do
     @configuration = DaemonKit::Configuration.new
   end
-  
+
   it "should know our environment" do
     @configuration.environment.should_not be_nil
   end
@@ -16,7 +17,7 @@ describe DaemonKit::Configuration do
   it "should have a default log level" do
     @configuration.log_level.should_not be_nil
   end
-    
+
 end
 
 
@@ -27,5 +28,5 @@ describe DaemonKit::Initializer do
     DaemonKit::Initializer.run(:initialize_logger)
     DaemonKit.logger.should_not be_nil
   end
-  
+
 end

data/spec/spec_helper.rb

@@ -1,19 +1,16 @@
-begin
-  require 'spec'
-rescue LoadError
-  require 'rubygems'
-  gem 'rspec'
-  require 'spec'
-end
-
-$:.unshift(File.dirname(__FILE__) + '/../lib')
-require 'daemon_kit'
+require 'rubygems'
+gem 'rspec'
+require 'spec'
 
-gem 'mocha'
+require 'mocha'
 require 'fileutils'
 
+DAEMON_ENV  = "test"
 DAEMON_ROOT = "#{File.dirname(__FILE__)}/../tmp"
 
+$:.unshift( File.dirname(__FILE__) + '/../lib' )
+require 'daemon_kit'
+
 Spec::Runner.configure do |config|
   # == Mock Framework
   #

data/templates/god/god.erb

@@ -0,0 +1,69 @@
+#
+# This is a configuration template for 'god' process monitoring.
+#
+# More information can be found at http://god.rubyforge.org/
+#
+
+DAEMON_ROOT = "<%= DaemonKit.root %>"
+
+God.watch do |w|
+  w.name = '<%= DaemonKit.configuration.daemon_name %>'
+  w.interval = 30.seconds
+  w.start = "/usr/bin/env DAEMON_ENV=<%= DaemonKit.env %> <%= DaemonKit.root %>/bin/<%= DaemonKit.configuration.daemon_name %> start"
+  w.stop = "/usr/bin/env DAEMON_ENV=<%= DaemonKit.env %> <%= DaemonKit.root %>/bin/<%= DaemonKit.configuration.daemon_name %> stop"
+  w.start_grace = 10.seconds
+  w.stop_grace = 10.seconds
+  w.pid_file = "<%= DaemonKit.configuration.pid_file %>"
+  w.behavior(:clean_pid_file)
+  #w.uid = 'nobody'
+  #w.gid = 'nobody'
+
+  w.start_if do |start|
+    start.condition(:process_running) do |c|
+      c.interval = 30.seconds
+      c.running = false
+      c.notify = 'sysadmin'
+    end
+  end
+
+  w.restart_if do |restart|
+    restart.condition(:memory_usage) do |c|
+      c.above = 250.megabytes
+      c.times = [3, 5] # 3 out of 5 intervals
+      c.notify = 'sysadmin'
+    end
+
+    restart.condition(:cpu_usage) do |c|
+      c.above = 50.percent
+      c.times = 5
+      c.notify = 'sysadmin'
+    end
+  end
+
+  w.lifecycle do |on|
+    on.condition(:flapping) do |c|
+      c.to_state = [:start, :restart]
+      c.times = 5
+      c.within = 5.minute
+      c.transition = :unmonitored
+      c.retry_in = 10.minutes
+      c.retry_times = 5
+      c.retry_within = 2.hours
+      c.notify = 'sysadmin'
+    end
+  end
+end
+
+God::Contacts::Email.server_settings = {
+  :address => "smtp.gmail.com",
+  :port => 587,
+  :domain => "localhost",
+  :authentication => :plain,
+  :user_name => "you@gmail.com",
+  :password => "secret"
+}
+
+God.contact(:email) do |c|
+  c.name = 'sysadmin'
+  c.email = 'you@gmail.com'
+end