svutil 0.9.1 → 0.9.2

data/Rakefile

@@ -19,6 +19,7 @@ $hoe = Hoe.spec('svutil') do |p|
   p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
   p.rsync_args = '-av --delete --ignore-errors'
   p.readme_file = "README.rdoc"
+  p.require_ruby_version(">= 1.9.0")
 end
 
 require 'newgem/tasks' # load /tasks/*.rake

data/lib/svutil.rb

@@ -6,5 +6,5 @@ require 'svutil/log'
 require 'svutil/process_manager'
 
 module SVUtil
-  VERSION = '0.9.1'
+  VERSION = '0.9.2'
 end

data/lib/svutil/config.rb

@@ -4,11 +4,9 @@ require 'ostruct'
 require 'pp'
 
 module SVUtil
-  def self.config
-    Config.config_class
-  end
-
   class Defaults
+    attr_reader :attrs
+
     def initialize
       @attrs = {}
     end
@@ -27,41 +25,38 @@ module SVUtil
   end
 
   class Config
-      
-    class << self
-      attr_writer :config_file
-      attr_reader :attrs
-      attr_reader :defaults
-      # Used mainly for testing
-      attr_accessor :option_source
+    attr_writer :config_file
+    attr_reader :attrs
 
-      attr_accessor :cli_options
-      attr_accessor :cli_option_handlers
-
-      def config_class
-      	subclasses_of(self).first || self
+    def initialize
+      @cli_options = {}
+      @attrs = if self.class.defaults
+        self.class.defaults.attrs.clone
+      else
+        {}
       end
+    end
 
-      def set(options = {})
-        @attrs ||= {}
-        if block_given?
-          yield self
-        end
-        self.validate
+    def set(options = {})
+      if block_given?
+        yield self
       end
+      self.validate
+    end
 
-      def defaults(&block)
-        @defaults ||= Defaults.new
-        yield @defaults
-      end
+    def config_file
+      @config_file ||= "settings"
+    end
 
-      def config_file
-        @config_file ||= "settings"
-      end
+    # TODO: Put in module and extend
+    class << self
+      attr_reader :cli_option_handlers
+      attr_reader :validate_block
 
-      def set_cli_option(option, value)
-        @cli_options ||= {}
-        @cli_options[option.to_s] = value
+      def defaults
+        @defaults ||= Defaults.new
+        yield @defaults if block_given?
+        return @defaults
       end
 
       def handle_options(&block)
@@ -72,102 +67,101 @@ module SVUtil
       def validator(&block)
         @validate_block = block
       end
+    end
 
-      def validate
-	      # TODO: Check file perms
-        if ((pid_file.nil? or pid_file.empty? or File.directory?(pid_file)) && self.daemon)
-          err("PID file must be a writable file")
-        end
-        # TODO: Validate the writability of the log file
-        @validate_block.call(self) unless @validate_block.nil?
-        true
-      end
+    def set_cli_option(option, value)
+      @cli_options ||= {}
+      @cli_options[option.to_s] = value
+    end
 
-      def init
-        set do |c|
-          self.config_provided_on_cli = false
-          OptionParser.new do |opts|
-            opts.on("-f", "--config [filename]", "Config file to use (default 'settings')") do |filename|
-              self.config_file = filename.strip
-              self.config_provided_on_cli = true
-            end
-            opts.on("-d", "--daemon", "Run in the background as a daemon") do
-              set_cli_option(:daemon, true)
-            end
-            opts.on("-l", "--debug-log [log-file]", "Debug Log File") do |log|
-              set_cli_option(:log_file, log)
-            end
-            opts.on("-T", "--trace", "Display backtrace on errors") do
-              set_cli_option(:trace, true)
-            end
-            opts.on("-P", "--pid [pid-file]", "PID File") do |pid|
-              set_cli_option(:pid_file, pid)
-            end
-            # Handle CLI passed options
-            (cli_option_handlers || []).each do |handler|
-              handler.call(opts)
-            end
-          end.parse!(self.option_source || ARGV)
+    def validate
+      # TODO: Check file perms
+      if ((pid_file.nil? or pid_file.empty? or File.directory?(pid_file)) && self.daemon)
+        err("PID file must be a writable file")
+      end
+      # TODO: Validate the writability of the log file
+      self.instance_exec(self, &self.class.validate_block) unless self.class.validate_block.nil?
+      true
+    end
 
-          # Process the config file
-          if (self.config_file && File.exists?(self.config_file)) || self.config_provided_on_cli
-            load_config_file
+    def init(test_options = nil)
+      set do |c|
+        self.config_provided_on_cli = false
+        OptionParser.new do |opts|
+          opts.on("-f", "--config [filename]", "Config file to use (default 'settings')") do |filename|
+            self.config_file = filename.strip
+            self.config_provided_on_cli = true
           end
-
-          # Finally apply any CLI options
-          (cli_options || {}).each do |(k,v)|
-            c.send("#{k}=", v)
+          opts.on("-d", "--daemon", "Run in the background as a daemon") do
+            set_cli_option(:daemon, true)
+          end
+          opts.on("-l", "--debug-log [log-file]", "Debug Log File") do |log|
+            set_cli_option(:log_file, log)
+          end
+          opts.on("-T", "--trace", "Display backtrace on errors") do
+            set_cli_option(:trace, true)
+          end
+          opts.on("-P", "--pid [pid-file]", "PID File") do |pid|
+            set_cli_option(:pid_file, pid)
+          end
+          # Handle CLI passed options
+          (self.class.cli_option_handlers || []).each do |handler|
+            self.instance_exec(opts, &handler)
           end
+        end.parse!(test_options || ARGV)
+
+
+        # Process the config file
+        if (self.config_file && File.exists?(self.config_file)) || self.config_provided_on_cli
+          load_config_file
+        end
+
+        # Finally apply any CLI options
+        (@cli_options || {}).each do |(k,v)|
+          @attrs[k.to_s] = v
         end
       end
+    end
 
-      private
-        def method_missing(method_id, *args)
-          @defaults ||= Defaults.new
-          @attrs ||= {}
-          if method_id.to_s =~ /=$/
-            @attrs[method_id.to_s[0...-1]] = args.first
-          else
-            value = @attrs[method_id.to_s]
-            if !value && @defaults
-              @defaults.default_for(method_id.to_s)
-            else
-              value
-            end
-          end
+    private
+      def method_missing(method_id, *args)
+        if method_id.to_s =~ /=$/
+          @attrs[method_id.to_s[0...-1]] = args.first
+        else
+          value = @attrs[method_id.to_s]
         end
+      end
 
-        def load_config_file
-          contents = ""
-          File.open(config_file, "r") { |file| contents << file.read }
-          contents.split("\n").each_with_index do |line, index|
-            pair = line.split("=")
-            if pair.size != 2
-              err("Invalid config file '#{config_file}'. Syntax error at line #{index + 1}")
-            end
-            self.send("#{pair[0].strip}=", pair[1].strip)
+      def load_config_file
+        contents = ""
+        File.open(config_file, "r") { |file| contents << file.read }
+        contents.split("\n").each_with_index do |line, index|
+          pair = line.split("=")
+          if pair.size != 2
+            err("Invalid config file '#{config_file}'. Syntax error at line #{index + 1}")
           end
+          self.send("#{pair[0].strip}=", pair[1].strip)
         end
+      end
 
-        # TODO: This should be moved out to a Validator class
-        def err(message)
-          STDERR.puts(message)
-          exit 1
-        end
+      # TODO: This should be moved out to a Validator class
+      def err(message)
+        STDERR.puts(message)
+        exit 1
+      end
 
-        def subclasses_of(*superclasses) #:nodoc:
-          subclasses = []
-          superclasses.each do |sup|
-            ObjectSpace.each_object(Class) do |k|
-              if superclasses.any? { |superclass| k < superclass } &&
-               	(k.name.nil? || k.name.empty? || eval("defined?(::#{k}) && ::#{k}.object_id == k.object_id"))
-  	            subclasses << k
-              end
+      def subclasses_of(*superclasses) #:nodoc:
+        subclasses = []
+        superclasses.each do |sup|
+          ObjectSpace.each_object(Class) do |k|
+            if superclasses.any? { |superclass| k < superclass } &&
+              (k.name.nil? || k.name.empty? || eval("defined?(::#{k}) && ::#{k}.object_id == k.object_id"))
+              subclasses << k
             end
-            subclasses.uniq!
           end
-          subclasses
+          subclasses.uniq!
         end
-    end
+        subclasses
+      end
   end
 end

data/lib/svutil/process_manager.rb

@@ -1,6 +1,10 @@
 module SVUtil
   class ProcessManager
-    def initialize(klass)
+    def initialize(klass, config)
+      @klass = klass
+      @config = config
+      @server_instance = @klass.new
+
       # TODO: Add ability for users to specify these signals
       Signal.trap("INT") { shutdown('Interupted', 1) }
       Signal.trap("TERM") { shutdown('Terminated', 2) }
@@ -11,20 +15,18 @@ module SVUtil
         STDERR.puts "There is already a '#{$0}' process running"
         exit 1
       end
-      daemonize if SVUtil::config.daemon
-      write_pid_file
-      @klass = klass
-      @server_instance = @klass.new
     end
 
     def start
       begin
+        daemonize if @config.daemon
+        write_pid_file
         @server_instance.run
       rescue SystemExit => e
         shutdown("System Exited")
       rescue Exception => e
         Log.error(e.message)
-        Log.error(e.backtrace.join("\n")) if SVUtil::config.trace
+        Log.error(e.backtrace.join("\n")) if @config.trace
         shutdown("Process Completed with Error", 1)
       end
       shutdown("Process Completed")
@@ -35,9 +37,9 @@ module SVUtil
         Log.info "Shutting Down (#{reason})"
         begin
           @server_instance.shutdown if @server_instance.respond_to?(:shutdown)
-        rescue => e
+        rescue Exception => e
           Log.error("Shutdown Callback threw error: #{e.message}")
-          Log.error("Shutdown Callback threw error: #{e.backtrace}") if SVUtil::config.trace
+          Log.error("Shutdown Callback threw error: #{e.backtrace}") if @config.trace
           Log.info("Shuting down anyway")
         end
         remove_pid_file
@@ -45,20 +47,20 @@ module SVUtil
       end
 
       def running?
-        pid_file = SVUtil::config.pid_file
+        pid_file = @config.pid_file
         return false unless pid_file
         File.exist?(pid_file)
       end
 
       def write_pid_file
-        pid_file = SVUtil::config.pid_file
+        pid_file = @config.pid_file
         return unless pid_file
         File.open(pid_file, "w") { |f| f.write(Process.pid) }
         File.chmod(0644, pid_file)
       end
 
       def remove_pid_file
-        pid_file = SVUtil::config.pid_file
+        pid_file = @config.pid_file
         return unless pid_file
         File.unlink(pid_file) if File.exists?(pid_file)
       end

data/test/test_config.rb

@@ -3,6 +3,7 @@ require File.expand_path(File.dirname(__FILE__) + '/test_helper.rb')
 class CustomConfig < SVUtil::Config
   defaults do |c|
     c.foo = 'bar'
+    c.manager = 'daniel'
   end
 end
 
@@ -10,77 +11,75 @@ class TestConfig < Test::Unit::TestCase
   include SVUtil
 
   def setup
+    @custom_config = CustomConfig.new
   end
   
   def test_set
-    assert !CustomConfig.my_symbol
-    CustomConfig.my_symbol = 'abc'
-    assert_equal 'abc', CustomConfig.my_symbol
-    CustomConfig.my_var = 10
-    assert_equal 10, CustomConfig.my_var
+    assert !@custom_config.my_symbol
+    @custom_config.my_symbol = 'abc'
+    assert_equal 'abc', @custom_config.my_symbol
+    @custom_config.my_var = 10
+    assert_equal 10, @custom_config.my_var
   end
 
   def test_set_with_block
-    CustomConfig.expects(:validate).times(1)
-    CustomConfig.set do |c|
+    @custom_config.expects(:validate).times(1)
+    @custom_config.set do |c|
       c.another = 'abc'
       c.some_var = 123
       c.foobar = true
     end
-    assert_equal 'abc', CustomConfig.another
-    assert_equal 123, CustomConfig.some_var
-    assert CustomConfig.foobar
+    assert_equal 'abc', @custom_config.another
+    assert_equal 123, @custom_config.some_var
+    assert @custom_config.foobar
   end
 
   def test_standard_cli_options
-    CustomConfig.expects(:validate).times(1)
-    CustomConfig.option_source = [ "-f", "test/settings", "-d", "-l", "debug", "-T" ]
-    CustomConfig.init
-    assert_equal "test/settings", CustomConfig.config_file
-    assert_equal "debug", CustomConfig.log_file
-    assert CustomConfig.daemon
-    assert CustomConfig.trace
+    @custom_config = CustomConfig.new
+    @custom_config.expects(:validate).times(1)
+    #@custom_config.option_source = [ "-f", "test/settings", "-d", "-l", "debug", "-T" ]
+    @custom_config.init([ "-f", "test/settings", "-d", "-l", "debug", "-T" ])
+    assert_equal "test/settings", @custom_config.config_file
+    assert_equal "debug", @custom_config.log_file
+    assert @custom_config.daemon
+    assert @custom_config.trace
   end
 
   def test_config_file
-    CustomConfig.expects(:validate).times(1)
-    CustomConfig.config_file = "test/settings"
-    CustomConfig.init
-    assert_equal 'bar', CustomConfig.foo
+    @custom_config.expects(:validate).times(1)
+    @custom_config.config_file = "test/settings"
+    @custom_config.init
+    assert_equal 'bar', @custom_config.foo
   end
 
   def test_load_config_file
-    CustomConfig.expects(:load_config_file).times(1)
-    CustomConfig.config_file = "test/settings"
-    CustomConfig.init
-    assert_equal 'bar', CustomConfig.foo
+    @custom_config.expects(:load_config_file).times(1)
+    @custom_config.config_file = "test/settings"
+    @custom_config.init
+    assert_equal 'bar', @custom_config.foo
   end
 
   def test_validations_on_cli_with_no_config_file
-    CustomConfig.expects(:validate).times(1)
-    CustomConfig.config_file = nil
-    CustomConfig.init
+    @custom_config.expects(:validate).times(1)
+    @custom_config.config_file = nil
+    @custom_config.init
   end
 
   # Command Line wins!
   def test_file_overide
-    CustomConfig.expects(:validate).times(1)
-    CustomConfig.config_file = "test/settings"
-    CustomConfig.option_source = [ "-l", "logfile_set_on_cli" ]
-    CustomConfig.init
-    assert_equal "logfile_set_on_cli", CustomConfig.log_file
+    @custom_config.expects(:validate).times(1)
+    @custom_config.config_file = "test/settings"
+    @custom_config.init([ "-l", "logfile_set_on_cli" ])
+    assert_equal "logfile_set_on_cli", @custom_config.log_file
   end
 
   def test_defaults
-    CustomConfig.defaults do |c|
-      c.manager = 'daniel'
-    end
-    assert_equal 'daniel', CustomConfig.manager
-    CustomConfig.manager = 'james'
-    assert_equal 'james', CustomConfig.manager
+    assert_equal 'daniel', @custom_config.manager
+    @custom_config.manager = 'james'
+    assert_equal 'james', @custom_config.manager
   end
 
   def test_custom_defaults
-    assert_equal 'bar', CustomConfig.foo
+    assert_equal 'bar', @custom_config.foo
   end
 end

data/test/test_config_handle_options.rb

@@ -15,19 +15,18 @@ class TestConfigHandleOptions < Test::Unit::TestCase
   include SVUtil
 
   def setup
+    @my_config = MyConfig.new
   end
   
   def test_handle_options
-    MyConfig.option_source = [ "-P", "foo", "-x", "12345", "-Q" ]
-    MyConfig.init
-    assert MyConfig.pid_file = "foo"
-    assert MyConfig.x = '1234'
-    assert MyConfig.restless
+    @my_config.init([ "-P", "foo", "-x", "12345", "-Q" ])
+    assert @my_config.pid_file = "foo"
+    assert @my_config.x = '1234'
+    assert @my_config.restless
   end
 
   def test_built_in_options
-    MyConfig.option_source = [ "-d", "-P", "foo" ]
-    MyConfig.init
-    assert MyConfig.daemon
+    @my_config.init([ "-d", "-P", "foo" ])
+    assert @my_config.daemon
   end
 end

data/test/test_helper.rb

@@ -3,3 +3,15 @@ require 'stringio'
 require 'test/unit'
 require 'mocha'
 require File.dirname(__FILE__) + '/../lib/svutil'
+
+class Test::Unit::TestCase
+  def assert_exit
+    exited = false
+    begin
+      yield if block_given?
+    rescue SystemExit => e
+      exited = true
+    end
+    assert(exited, "Did not exit")
+  end
+end

data/test/test_process_manager.rb

@@ -0,0 +1,74 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper.rb')
+
+class ServerConfig < SVUtil::Config
+end
+
+class TestProcesManager < Test::Unit::TestCase
+  include SVUtil
+
+  def setup
+    Signal.stubs(:trap)
+    Log.stubs(:info)
+    @instance = mock()
+    @klass = mock
+    @klass.expects(:new).returns(@instance)
+  end
+  
+  def test_initialize
+    config = ServerConfig.new
+    ProcessManager.new(@klass, config)
+  end
+
+  # TODO: Could probably test this better by actually forking
+  def test_start_as_daemon
+    config = ServerConfig.new
+    config.daemon = true
+    pm = ProcessManager.new(@klass, config)
+    pm.expects(:daemonize)
+    pm.expects(:write_pid_file)
+    pm.expects(:shutdown)
+    @instance.expects(:run)
+    pm.start
+  end
+
+  def test_start_with_trace
+    config = ServerConfig.new
+    config.trace = true
+    pm = ProcessManager.new(@klass, config)
+    pm.expects(:write_pid_file)
+    @instance.expects(:run).raises(Exception)
+    Log.expects(:error).times(2)
+    assert_exit { pm.start }
+  end
+
+  def test_shutdown
+    config = ServerConfig.new
+    pm = ProcessManager.new(@klass, config)
+    pm.expects(:write_pid_file)
+    @instance.expects(:run)
+    assert_exit { pm.start }
+
+    # Shutdown
+    @instance.expects(:shutdown)
+    pm.expects(:remove_pid_file)
+    assert_exit { pm.send(:shutdown) }
+  end
+
+  def test_shutdown_with_trace
+    config = ServerConfig.new
+    config.trace = true
+    pm = ProcessManager.new(@klass, config)
+    pm.expects(:write_pid_file)
+    @instance.expects(:run)
+    assert_exit { pm.start }
+
+    # Shutdown
+    @instance.expects(:shutdown).raises(Exception)
+    Log.expects(:error).times(2)
+    pm.expects(:remove_pid_file)
+    assert_exit { pm.send(:shutdown) }
+  end
+
+
+  # TODO: Test all of the exceptions
+end

data/test/test_validations.rb

@@ -10,17 +10,18 @@ class TestValidations < Test::Unit::TestCase
   include SVUtil
 
   def setup
+    @validated_config = ValidatedConfig.new
   end
   
   def test_custom_validation_error
-    ValidatedConfig.expects(:err).times(1)
-    ValidatedConfig.output_dir = nil
-    ValidatedConfig.validate
+    @validated_config.expects(:err).times(1)
+    @validated_config.output_dir = nil
+    @validated_config.validate
   end
   
   def test_custom_validation
-    ValidatedConfig.expects(:err).never
-    ValidatedConfig.output_dir = "foo"
-    assert ValidatedConfig.validate
+    @validated_config.expects(:err).never
+    @validated_config.output_dir = "foo"
+    assert @validated_config.validate
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: svutil
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-03 00:00:00.000000000Z
+date: 2012-01-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: newgem
-  requirement: &70271851866620 !ruby/object:Gem::Requirement
+  requirement: &70111340337380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.5.3
   type: :development
   prerelease: false
-  version_requirements: *70271851866620
+  version_requirements: *70111340337380
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &70271851851080 !ruby/object:Gem::Requirement
+  requirement: &70111340336180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.12'
   type: :development
   prerelease: false
-  version_requirements: *70271851851080
+  version_requirements: *70111340336180
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70271847828620 !ruby/object:Gem::Requirement
+  requirement: &70111336070020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *70271847828620
+  version_requirements: *70111336070020
 description: A simple managed process builder for Ruby projects
 email:
 - daniel@netfox.com
@@ -68,6 +68,7 @@ files:
 - test/test_config.rb
 - test/test_config_handle_options.rb
 - test/test_defaults.rb
+- test/test_process_manager.rb
 - test/test_validations.rb
 - .gemtest
 homepage: http://svutil.rubyforge.org
@@ -83,7 +84,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -101,5 +102,6 @@ test_files:
 - test/test_config_handle_options.rb
 - test/test_defaults.rb
 - test/test_helper.rb
+- test/test_process_manager.rb
 - test/test_svutil.rb
 - test/test_validations.rb