dante 0.0.4 → 0.1.0

data/README.md

@@ -55,6 +55,8 @@ Be sure to properly make your bin executable:
 chmod +x bin/myapp
 ```
 
+### CLI
+
 This gives your binary several useful things for free:
 
 ```
@@ -81,7 +83,7 @@ will stop all daemonized processes for the specified pid file.
 
 Will return a useful help banner message explaining the simple usage.
 
-## Customization
+### Advanced
 
 In many cases, you will need to add custom flags/options or a custom description to your executable. You can do this
 easily by using `Dante::Runner` more explicitly:
@@ -122,6 +124,19 @@ Now you would be able to do:
 and the `opts` would contain the `:test` option for use in your script. In addition, help will now contain
 your customized description in the banner.
 
+You can also use dante programmatically to start, stop and restart arbitrary code:
+
+```ruby
+# daemon start
+Dante::Runner.new('gitdocs').execute(:daemonize => true, :pid_path => @pid) { something! }
+# daemon stop
+Dante::Runner.new('gitdocs').execute(:kill => true, :pid_path => @pid)
+# daemon restart
+Dante::Runner.new('gitdocs').execute(:daemonize => true, :restart => true, :pid_path => @pid) { something! }
+```
+
+so you can use dante as part of a more complex CLI executable.
+
 ## God
 
 Dante can be used well in conjunction with the excellent God process manager. Simply, use Dante to daemonize a process

data/lib/dante.rb

@@ -6,7 +6,7 @@ require "dante/runner"
   Dante.run("process-name") do
     begin
       # ...something here
-    rescue Abort
+    rescue Interrupt
       # ...shutdown here
     end
   end

data/lib/dante/runner.rb

@@ -15,8 +15,7 @@ This is a utility for setting up a binary executable for a service.
 
 module Dante
   class Runner
-    # Signal to application that the process is shutting down
-    class Abort < Exception; end
+    MAX_START_TRIES = 5
 
     attr_accessor :options, :name, :description
 
@@ -29,6 +28,7 @@ module Dante
     def initialize(name, defaults={}, &block)
       @name = name
       @startup_command = block
+      @debug = defaults.delete(:debug) || true
       @options = {
         :host => '0.0.0.0',
         :pid_path => "/var/run/#{@name}.pid"
@@ -44,12 +44,14 @@ module Dante
     # Executes the runner based on options
     # @runner.execute
     # @runner.execute { ... }
-    def execute(&block)
+    def execute(opts={}, &block)
       parse_options
+      self.options.merge!(opts)
 
       if options.include?(:kill)
-        kill_pid(options[:kill] || '*')
+        self.stop
       else # create process
+        self.stop if options.include?(:restart)
         Process.euid = options[:user] if options[:user]
         Process.egid = options[:group] if options[:group]
         @startup_command = block if block_given?
@@ -57,23 +59,64 @@ module Dante
       end
     end
 
+    def daemonize
+      return log("Process is already started") if self.daemon_running? # daemon already started
+
+      # Start process
+      pid = fork do
+        exit if fork
+        Process.setsid
+        exit if fork
+        store_pid(Process.pid)
+        File.umask 0000
+        STDIN.reopen "/dev/null"
+        STDOUT.reopen "/dev/null", "a"
+        STDERR.reopen STDOUT
+        start
+      end
+      # Ensure process is running
+      if until_true(MAX_START_TRIES) { self.daemon_running? }
+        log "Daemon has started successfully"
+        true
+      else # Failed to start
+        log "Daemonized process couldn't be started"
+        false
+      end
+    end
+
     def start
-      puts "Starting #{@name} service..."
+      log "Starting #{@name} service..."
 
       trap("INT") {
-        stop
+        interrupt
         exit
       }
       trap("TERM"){
-        stop
+        interrupt
         exit
       }
 
       @startup_command.call(self.options) if @startup_command
     end
 
-    def stop
-      raise Abort
+    # Stops a daemonized process
+    def stop(kill_arg=nil)
+      if self.daemon_running?
+        kill_pid(kill_arg || options[:kill])
+        until_true(MAX_START_TRIES) { self.daemon_stopped? }
+      else # not running
+        log "No #{@name} processes are running"
+        false
+      end
+    end
+
+    def restart
+      self.stop
+      self.start
+    end
+
+    def interrupt
+      raise Interrupt
       sleep(1)
     end
 
@@ -121,38 +164,54 @@ module Dante
       options
     end
 
-    private
+    protected
 
     def store_pid(pid)
-     FileUtils.mkdir_p(File.dirname(options[:pid_path]))
-     File.open(options[:pid_path], 'w'){|f| f.write("#{pid}\n")}
+      FileUtils.mkdir_p(File.dirname(options[:pid_path]))
+      File.open(options[:pid_path], 'w'){|f| f.write("#{pid}\n")}
     end
 
-    def kill_pid(k)
+    def kill_pid(k='*')
       Dir[options[:pid_path]].each do |f|
         begin
           pid = IO.read(f).chomp.to_i
           FileUtils.rm f
           Process.kill('INT', pid)
-          puts "killed PID: #{pid} at #{f}"
+          log "Stopped PID: #{pid} at #{f}"
         rescue => e
-          puts "Failed to kill! #{k}: #{e}"
+          log "Failed to stop! #{k}: #{e}"
         end
       end
     end
 
-    def daemonize
-      pid = fork do
-        exit if fork
-        Process.setsid
-        exit if fork
-        store_pid(Process.pid)
-        File.umask 0000
-        STDIN.reopen "/dev/null"
-        STDOUT.reopen "/dev/null", "a"
-        STDERR.reopen STDOUT
-        start
+    # Runs until the block condition is met or the timeout_seconds is exceeded
+    # until_true(10) { ...return_condition... }
+    def until_true(timeout_seconds, interval=1, &block)
+      elapsed_seconds = 0
+      while elapsed_seconds < timeout_seconds && block.call != true
+        elapsed_seconds += interval
+        sleep(interval)
       end
+      elapsed_seconds < timeout_seconds
+    end
+
+    # Returns true if process is not running
+    def daemon_stopped?
+      ! self.daemon_running?
+    end
+
+    # Returns running for the daemonized process
+    # self.daemon_running?
+    def daemon_running?
+      return false unless File.exist?(options[:pid_path])
+      Process.kill 0, File.read(options[:pid_path]).to_i
+      true
+    rescue Errno::ESRCH
+      false
+    end
+
+    def log(message)
+      puts message if @debug
     end
 
   end

data/lib/dante/version.rb

@@ -1,3 +1,3 @@
 module Dante
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/test/runner_test.rb

@@ -34,7 +34,7 @@ describe "dante runner" do
       sleep(1) # Wait to complete
       @output = File.read(@process.tmp_path)
       assert_match /Started on 8080!!/, @output
-      assert_match /Abort!!/, @output
+      assert_match /Interrupt!!/, @output
       assert_match /Closing!!/, @output
     end
 
@@ -44,7 +44,7 @@ describe "dante runner" do
       sleep(1) # Wait to complete
       @output = File.read(@process.tmp_path)
       assert_match /Started on 8080!!/, @output
-      assert_match /Abort!!/, @output
+      assert_match /Interrupt!!/, @output
       assert_match /Closing!!/, @output
     end
   end # daemonize
@@ -64,7 +64,7 @@ describe "dante runner" do
       sleep(1) # Wait to complete
       @output = File.read(@process.tmp_path)
       assert_match /Started on 8080!!/, @output
-      assert_match /Abort!!/, @output
+      assert_match /Interrupt!!/, @output
       assert_match /Closing!!/, @output
     end
   end # execute with block

data/test/test_helper.rb

@@ -45,8 +45,8 @@ class TestingProcess
       @tmp = File.new(@tmp_path, 'w')
       @tmp.print "Started on #{port}!!"
       sleep(100)
-    rescue Dante::Runner::Abort
-      @tmp.print "Abort!!"
+    rescue Interrupt
+      @tmp.print "Interrupt!!"
       exit
     ensure
       @tmp.print "Closing!!"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dante
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 4
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors: 
 - Nathan Esquenazi
@@ -15,10 +15,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-01 00:00:00 Z
+date: 2011-12-06 00:00:00 -08:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -27,12 +30,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id001
   type: :development
-  prerelease: false
-  name: rake
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  name: minitest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -41,12 +44,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id002
   type: :development
-  prerelease: false
-  name: minitest
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -55,10 +58,8 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id003
   type: :development
-  prerelease: false
-  name: mocha
+  version_requirements: *id003
 description: Turn any process into a demon.
 email: 
 - nesquena@gmail.com
@@ -81,6 +82,7 @@ files:
 - test/dante_test.rb
 - test/runner_test.rb
 - test/test_helper.rb
+has_rdoc: true
 homepage: https://github.com/bazaarlabs/dante
 licenses: []
 
@@ -110,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: dante
-rubygems_version: 1.8.10
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Turn any process into a demon