dctl 1.0.2 → 1.0.3

data/CHANGELOG

@@ -1,3 +1,12 @@
+*1.0.3* (20th April, 2005)		Bruno Carnazzi		<mailto:bcarnazzi@gmail.com>
+	* added a new daemon state : unhandled
+	* status with no arg gives all daemon states
+	* status is the default command when no command is given
+	* status can handle multiple args, each as a daemon to check
+	* environment variables DCTL_DIR, DCTL_IN, DCTL_OUT, DCTL_ERR now override defaults
+	* strongly refactored command hierarchy
+	* added some examples
+
 *1.0.2* (18th April, 2005)		Bruno Carnazzi		<mailto:bcarnazzi@gmail.com>
 	* better gem dependency support for cmdparse (>=1.0.1 required)
 	* added a check for incomplete command

data/README

@@ -9,7 +9,7 @@ It is designed to be small and smart ("less-is-more" philosophy), generic, and w
 Major features:
 * Convert any executable file with endless lifecycle into a controllable daemon
 * Automatic handling of pidfiles
-* Command-oriented style (dctl requires cmdparser)
+* Command-oriented style (dctl requires cmdparser >= 1.0.1)
 
 
 == Examples
@@ -17,12 +17,15 @@ Major features:
 === Start a daemon with redirection of stdout in file 'out'
   % dctl start -oout test/infinite.sh
 
-=== Get the status of a daemon
-  % dctl status test/infinite.sh
+=== Get the status of some daemons (here, infinite.sh and sleep)
+  % dctl status test/infinite.sh sleep
 
 === Stop a daemon
   % dctl stop test/infinite.sh
 
+=== Get the status of all daemons
+  % dctl
+
 
 == Download
 

data/TODO

@@ -3,3 +3,4 @@
 - write a 'status' command -> DONE (05/04/05)
 - write a 'rakefile' -> DONE (08/04/05)
 - package as a gem -> DONE (08/04/05)
+- handle of YAML configuration files per daemon

data/lib/dctl.rb

@@ -7,7 +7,7 @@ class DctlApp
     begin
       Dctl::CommandLineParser.parse!(File.basename($0, '.*'), ARGV)
     rescue
-      puts $!
+      puts $!.to_s.gsub(/:\W*$/, '.')
       puts 'Use -h or --help for usage.'
       exit 1
     end

data/lib/dctl/cmdparser.rb

@@ -31,7 +31,7 @@ module Dctl
       cmd_parser.add_command Dctl::Command::RunCommand.new
       cmd_parser.add_command Dctl::Command::RestartCommand.new
       cmd_parser.add_command Dctl::Command::ZapCommand.new
-      cmd_parser.add_command Dctl::Command::StatusCommand.new
+      cmd_parser.add_command Dctl::Command::StatusCommand.new, true
       cmd_parser.add_command CommandParser::HelpCommand.new
       cmd_parser.add_command CommandParser::VersionCommand.new
       

data/lib/dctl/command.rb

@@ -14,9 +14,15 @@ module Dctl
   # This module contains all possible commands allowed by Dctl
   module Command
   
-    # This module is used by command that redirect their standard io streams.
-    module Redirectible
-      def std_init
+    class SmartCommand < CommandParser::Command
+      def initialize
+        super self.class.to_s.gsub(/\w+::/, '').gsub(/Command$/, '').downcase
+      end
+    end
+    
+    class RedirectibleCommand < SmartCommand
+      def initialize
+        super
         @stdin = $IN
         @stdout = $OUT
         @stderr = $ERR
@@ -26,15 +32,15 @@ module Dctl
         options.on('-e', '--stderr FILE', "Use FILE as stderr when daemonized (default is '#{@stderr}').") { |@stderr| }
       end
     end
-        
-    class StartCommand < CommandParser::Command
-      include Redirectible
     
+    class NonRedirectibleCommand < SmartCommand
       def initialize
-        super 'start'
-        std_init
+        super
+        options.separator "Options:"
       end
-      
+    end
+            
+    class StartCommand < RedirectibleCommand   
       def description
         'Start a new daemonized instance of a specified application.'
       end
@@ -46,14 +52,7 @@ module Dctl
       end
     end
 
-    class RestartCommand < CommandParser::Command
-      include Redirectible
-    
-      def initialize
-        super 'restart'
-        std_init
-      end
-      
+    class RestartCommand < RedirectibleCommand
       def description
         'Restart a daemonized instance of a specified application with new arguments.'
       end
@@ -65,12 +64,7 @@ module Dctl
       end
     end
     
-    class StopCommand < CommandParser::Command
-      def initialize
-        super 'stop'
-        options.separator "Options:"
-      end
-      
+    class StopCommand < NonRedirectibleCommand
       def description
         'Stop a daemonized instance of a specified application.'
       end
@@ -81,12 +75,7 @@ module Dctl
       end
     end
 
-    class ZapCommand < CommandParser::Command
-      def initialize
-        super 'zap'
-        options.separator "Options:"
-      end
-      
+    class ZapCommand < NonRedirectibleCommand
       def description
         "Manually set a daemonized instance of a specified application to 'stopped' state."
       end
@@ -97,12 +86,7 @@ module Dctl
       end
     end
 
-    class RunCommand < CommandParser::Command
-      def initialize
-        super 'run'
-        options.separator "Options:"
-      end
-      
+    class RunCommand < NonRedirectibleCommand
       def description
         'Run a new un-daemonized instance of a specified application.'
       end
@@ -114,19 +98,21 @@ module Dctl
       end
     end
     
-    class StatusCommand < CommandParser::Command
-      def initialize
-        super 'status'
-        options.separator "Options:"
-      end
-      
+    class StatusCommand < NonRedirectibleCommand
       def description
-        "Get the state of a specified application."
+        "Get the state of specified applications (one or more)."
       end
       
       def execute(cmd_parser, args)
-        cmd = args[0] || raise(OptionParser::MissingArgument)
-        puts "#{File.basename cmd}: #{Dctl::Daemon.new(cmd, $DIR).status}"
+        if args.length > 0
+          args.each { |cmd| puts status(cmd) rescue puts $! }
+        else
+          Dir[File.join($DIR, '*.pid')].collect { |p| File.basename(p, '.*')}.each { |cmd| puts status(cmd) } # BUG ! if cmd not in PATH !
+        end
+      end
+      
+      def status(cmd)
+        "#{cmd}: #{File.basename(Dctl::Daemon.new(cmd, $DIR, false).status.id2name)}"
       end
     end
     

data/lib/dctl/daemon.rb

@@ -7,11 +7,13 @@ module Dctl
   class Daemon
     include Daemonize
     
-    def initialize(cmd, pidpath)
-      @app_path = Daemon::which(cmd) || File.expand_path(cmd)
-      raise Errno::EISDIR, @app_path if File.directory? @app_path
-      raise Errno::ENOENT, @app_path until File.file? @app_path
-      raise Errno::EACCES, @app_path until File.executable? @app_path
+    def initialize(cmd, pidpath, check=true)
+      @app_path = File.expand_path(Daemon::which(cmd) || cmd)
+      if check
+        raise Errno::EISDIR, @app_path if File.directory? @app_path
+        raise Errno::ENOENT, @app_path until File.file? @app_path
+        raise Errno::EACCES, @app_path until File.executable? @app_path
+      end
       @pidfile = PidFile.new pidpath, File.basename(cmd)
     end
     
@@ -45,8 +47,9 @@ module Dctl
     end
     
     def status
-      Process.kill 0, @pidfile.read rescue return "not running"
-      "running"
+      (pid = @pidfile.read) rescue return :unhandled
+      Process.kill 0, pid rescue return :not_running
+      :running
     end
   end
 

data/lib/dctl/defaults.rb

@@ -1,7 +1,7 @@
 # This file contains Dctl default values.
 
-$DIR = Process.uid == 0 ? '/var/run' : '.'
+$DIR = ENV['DCTL_DIR'] || (Process.uid == 0 ? '/var/run' : '.')
 
-$IN = '/dev/null'
-$OUT = '/dev/null'
-$ERR = '/dev/null'
+$IN = ENV['DCTL_IN'] || '/dev/null'
+$OUT = ENV['DCTL_OUT'] || '/dev/null'
+$ERR = ENV['DCTL_ERR'] || '/dev/null'

data/lib/dctl/metainf.rb

@@ -1,6 +1,6 @@
 # This file contains informations about Dctl current release.
 
 module Dctl
-  VERSION = [1, 0, 2]
+  VERSION = [1, 0, 3]
   RELEASE = 'Leonard release'
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: dctl
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
-date: 2005-04-18
+  version: 1.0.3
+date: 2005-04-20
 summary: "dctl - a daemon controller written in Ruby"
 require_paths: 
   - lib