logging 0.1.0 → 0.2.0

data/test/appenders/test_rolling_file.rb

@@ -0,0 +1,141 @@
+# $Id: test_rolling_file.rb 22 2007-01-29 16:20:54Z tim_pease $
+
+require 'test/setup.rb'
+require 'fileutils'
+
+module TestLogging
+module TestAppenders
+
+  class TestRollingFile < Test::Unit::TestCase
+    include LoggingTestCase
+
+    TMP = 'tmp'
+
+    def setup
+      super
+      FileUtils.rm_rf TMP if File.exist?(TMP)
+      FileUtils.mkdir(TMP)
+      @fn = File.join(TMP, 'test.log')
+      @fn_fmt = File.join(TMP, 'test.%d.log')
+      @glob = File.join(TMP, '*.log')
+    end
+
+    def teardown
+      FileUtils.rm_rf TMP
+    end
+
+    def test_initialize
+      assert_equal [], Dir.glob(@glob)
+
+      # create a new appender
+      ap = ::Logging::Appenders::RollingFile.new('test', :filename => @fn)
+      assert File.exist?(@fn)
+      assert_equal 0, File.size(@fn)
+
+      ap << "Just a line of text\n"   # 20 bytes
+      ap.flush
+      assert_equal 20, File.size(@fn)
+      ap.close
+
+      # make sure we append to the current file (not truncate)
+      ap = ::Logging::Appenders::RollingFile.new('test', :filename => @fn)
+      assert_equal [@fn], Dir.glob(@glob)
+      assert_equal 20, File.size(@fn)
+
+      ap << "Just another line of text\n"   # 26 bytes
+      ap.flush
+      assert_equal 46, File.size(@fn)
+      ap.close
+
+      # setting the truncate option to true should roll the current log file
+      # and create a new one
+      ap = ::Logging::Appenders::RollingFile.new('test',
+               :filename => @fn, :truncate => true)
+
+      log1 = sprintf(@fn_fmt, 1)
+      assert_equal [log1, @fn], Dir.glob(@glob).sort
+      assert_equal 0, File.size(@fn)
+      assert_equal 46, File.size(log1)
+
+      ap << "Some more text in the new file\n"   # 31 bytes
+      ap.flush
+      assert_equal 31, File.size(@fn)
+      ap.close
+    end
+
+    def test_keep
+      assert_equal [], Dir.glob(@glob)
+
+      (1..12).each do |cnt|
+        name = sprintf(@fn_fmt, cnt)
+        File.open(name,'w') {|fd| fd.write 'X'*cnt}
+      end
+      FileUtils.touch(@fn)
+
+      # keep only five files
+      ap = ::Logging::Appenders::RollingFile.new('test',
+               :filename => @fn, :keep => 5)
+
+      # we still have 13 files because we did not truncate the log file,
+      # and hence, we did not roll all the log files
+      assert_equal 13, Dir.glob(@glob).length
+
+      # force the appender to roll the files
+      ap.send :roll
+      assert_equal 6, Dir.glob(@glob).length
+
+      (1..5).each do |cnt|
+        name = sprintf(@fn_fmt, cnt)
+        assert_equal cnt-1, File.size(name)
+      end
+      ap.close
+    end
+
+    def test_max_age
+      assert_equal [], Dir.glob(@glob)
+
+      ap = ::Logging::Appenders::RollingFile.new('test',
+               :filename => @fn, :max_age => 1)
+
+      ap << "random message\n"
+      assert_equal 1, Dir.glob(@glob).length
+
+      sleep 1
+      ap << "another random message\n"
+      assert_equal 2, Dir.glob(@glob).length
+
+      ap.close
+    end
+
+    def test_max_size
+      assert_equal [], Dir.glob(@glob)
+
+      ap = ::Logging::Appenders::RollingFile.new('test',
+               :filename => @fn, :max_size => 100)
+
+      ap << 'X' * 100; ap.flush
+      assert_equal 1, Dir.glob(@glob).length
+      assert_equal 100, File.size(@fn)
+
+      # this character is appended to the log file (bringing its size to 101)
+      # and THEN the file is rolled resulting in a new, empty log file
+      ap << 'X'
+      assert_equal 2, Dir.glob(@glob).length
+      assert_equal 0, File.size(@fn)
+
+      ap << 'X' * 100; ap.flush
+      assert_equal 2, Dir.glob(@glob).length
+      assert_equal 100, File.size(@fn)
+
+      ap << 'X'
+      assert_equal 3, Dir.glob(@glob).length
+      assert_equal 0, File.size(@fn)
+
+      ap.close
+    end
+
+  end  # class TestRollingFile
+end  # module TestAppenders
+end  # module TestLogging
+
+# EOF

data/test/config/test_yaml_configurator.rb

@@ -0,0 +1,47 @@
+# $Id: test_yaml_configurator.rb 22 2007-01-29 16:20:54Z tim_pease $
+
+require 'stringio'
+require 'yaml'
+require 'test/setup.rb'
+
+module TestLogging
+module TestConfig
+
+  class TestYamlConfigurator < Test::Unit::TestCase
+    include LoggingTestCase
+
+    def setup
+      super
+    end
+
+    def test_class_load
+      assert_raise(::Logging::Config::YamlConfigurator::Error) {
+        ::Logging::Config::YamlConfigurator.load(Object.new)
+      }
+
+      begin
+        fd = File.open('examples/logging.yaml','r')
+        assert_nothing_raised {
+          ::Logging::Config::YamlConfigurator.load(fd)
+        }
+      ensure
+        fd.close
+      end
+    end
+
+    def test_initialize
+      io = StringIO.new
+      io << YAML.dump({:one => 1, :two => 2, :three => 3})
+      io.seek 0
+
+      assert_raise(::Logging::Config::YamlConfigurator::Error) {
+        ::Logging::Config::YamlConfigurator.new(io)
+      }
+    end
+
+  end  # class TestYamlConfigurator
+
+end  # module TestConfig
+end  # module TestLogging
+
+# EOF

data/test/layouts/test_pattern.rb

@@ -1,4 +1,4 @@
-# $Id: test_pattern.rb 13 2007-01-15 17:19:37Z tim_pease $
+# $Id: test_pattern.rb 17 2007-01-20 18:47:43Z tim_pease $
 
 require 'test/setup.rb'
 
@@ -138,7 +138,7 @@ module TestLayouts
       assert_match %r/\A\d+\z/, @layout.format(event)
 
       @layout.pattern = '%t'
-      assert_match %r/\A\d+\z/, @layout.format(event)
+      assert_match %r/\A-?\d+\z/, @layout.format(event)
 
       @layout.pattern = '%%'
       assert_equal '%', @layout.format(event)

data/test/setup.rb

@@ -1,4 +1,4 @@
-# $Id: setup.rb 12 2007-01-14 20:03:40Z tim_pease $
+# $Id: setup.rb 22 2007-01-29 16:20:54Z tim_pease $
 
 require 'test/unit'
 
@@ -37,6 +37,8 @@ module TestLogging
           define_method(:instance, nonce::FirstInstanceCall)
         end
       end
+      
+      ::Logging::Appender.instance_variable_get(:@appenders).clear
     end
 
   end  # module LoggingTestCase

data/test/test_layout.rb

@@ -1,4 +1,4 @@
-# $Id: test_layout.rb 5 2007-01-09 23:02:57Z tim_pease $
+# $Id: test_layout.rb 17 2007-01-20 18:47:43Z tim_pease $
 
 require 'test/setup.rb'
 
@@ -21,13 +21,13 @@ module TestLogging
 
       assert_equal :string, obj_format[@layout]
 
-      @layout = ::Logging::Layout.new 'blah'
+      @layout = ::Logging::Layout.new 'format_as' => 'blah'
       assert_equal :string, obj_format[@layout]
 
-      @layout = ::Logging::Layout.new :inspect
+      @layout = ::Logging::Layout.new :format_as => :inspect
       assert_equal :inspect, obj_format[@layout]
 
-      @layout = ::Logging::Layout.new :yaml
+      @layout = ::Logging::Layout.new 'format_as' => :yaml
       assert_equal :yaml, obj_format[@layout]
 
       @layout = ::Logging::Layout.new
@@ -70,16 +70,16 @@ module TestLogging
       assert_equal '<Array> 1234', r
 
       obj = %w( one two three four )
-      @layout = ::Logging::Layout.new :inspect
+      @layout = ::Logging::Layout.new :format_as => :inspect
       r = @layout.send :format_obj, obj
       assert_equal '<Array> ["one", "two", "three", "four"]', r
 
-      @layout = ::Logging::Layout.new :yaml
+      @layout = ::Logging::Layout.new :format_as => :yaml
       r = @layout.send :format_obj, obj
       assert_equal "<Array> \n--- \n- one\n- two\n- three\n- four\n", r
     end
 
-  end  # class TestAppender
+  end  # class TestLayout
 end  # module TestLogging
 
 # EOF

data/test/test_log_event.rb

@@ -1,10 +1,10 @@
-# $Id: test_log_event.rb 9 2007-01-11 23:51:41Z tim_pease $
+# $Id: test_log_event.rb 22 2007-01-29 16:20:54Z tim_pease $
 
 require 'test/setup.rb'
 
 module TestLogging
 
-  class TestEvent < Test::Unit::TestCase
+  class TestLogEvent < Test::Unit::TestCase
     include LoggingTestCase
 
     def setup
@@ -69,7 +69,7 @@ module TestLogging
       assert_equal 'test_method', @appender.event.method
     end
 
-  end  # class TestLogger
+  end  # class TestLogEvent
 
   class EventAppender < ::Logging::Appender
     attr_reader :event

data/test/test_logger.rb

@@ -1,4 +1,4 @@
-# $Id: test_logger.rb 15 2007-01-15 19:03:45Z tim_pease $
+# $Id: test_logger.rb 22 2007-01-29 16:20:54Z tim_pease $
 
 require 'test/setup.rb'
 require 'stringio'
@@ -69,6 +69,20 @@ module TestLogging
 
       log.additive = false
       assert_equal false, log.additive
+
+      log.additive = true
+      assert_equal true, log.additive
+
+      log.additive = 'false'
+      assert_equal false, log.additive
+
+      log.additive = 'true'
+      assert_equal true, log.additive
+
+      log.additive = nil
+      assert_equal true, log.additive
+
+      assert_raise(ArgumentError) {log.additive = Object}
     end
 
     def test_appenders_eq
@@ -444,6 +458,28 @@ module TestLogging
       assert_equal true, log.trace
     end
 
+    def test_trace_eq
+      log = ::Logging::Logger.new 'A'
+      assert_equal false, log.trace
+
+      log.trace = true
+      assert_equal true, log.trace
+
+      log.trace = false
+      assert_equal false, log.trace
+
+      log.trace = 'true'
+      assert_equal true, log.trace
+
+      log.trace = 'false'
+      assert_equal false, log.trace
+
+      log.trace = nil
+      assert_equal false, log.trace
+
+      assert_raise(ArgumentError) {log.trace = Object}
+    end
+
   end  # class TestLogger
 
   class SioAppender < ::Logging::Appenders::IO

data/test/test_logging.rb

@@ -1,4 +1,4 @@
-# $Id: test_logging.rb 12 2007-01-14 20:03:40Z tim_pease $
+# $Id: test_logging.rb 22 2007-01-29 16:20:54Z tim_pease $
 
 require 'test/setup.rb'
 
@@ -13,6 +13,71 @@ module TestLogging
       @lnames = ::Logging::LNAMES
     end
 
+    def test_configure
+      assert_raise(ArgumentError) {::Logging.configure 'blah.txt'}
+
+      ::Logging.configure 'examples/logging.yaml'
+
+      names = {
+        0 => 'DEB', 1 => 'INF', 2 => 'PRT',
+        3 => 'WRN', 4 => 'ERR', 5 => 'FAT'
+      }
+      assert_equal names, ::Logging::LNAMES
+      assert_equal :inspect, ::Logging::OBJ_FORMAT
+      assert_equal 3, ::Logging::Logger.root.level
+
+      # verify the appenders
+      h = ::Logging::Appender.instance_variable_get :@appenders
+      assert_equal ['logfile', 'stderr'], h.keys.sort
+
+      # start with the File appender
+      logfile = ::Logging::Appender['logfile']
+      assert_instance_of ::Logging::Appenders::File, logfile
+      assert_equal 0, logfile.level
+      assert_equal 'temp.log', logfile.instance_variable_get(:@fn)
+
+      layout = logfile.layout
+      assert_instance_of ::Logging::Layouts::Pattern, layout
+      assert_equal '[%d] %l  %c : %m\\n', layout.pattern
+      assert_equal 'to_s', layout.date_method
+      assert_nil layout.date_pattern
+
+      # and now the Stderr appender
+      stderr = ::Logging::Appender['stderr']
+      assert_instance_of ::Logging::Appenders::Stderr, stderr
+      assert_equal 0, stderr.level
+
+      layout = stderr.layout
+      assert_instance_of ::Logging::Layouts::Basic, layout
+
+      # verify the loggers
+      h = ::Logging::Repository.instance.instance_variable_get :@h
+      assert_equal 3, h.length
+
+      # mylogger
+      mylogger = ::Logging::Logger['mylogger']
+      assert_equal 0, mylogger.level
+      assert_equal false, mylogger.additive
+      assert_equal false, mylogger.trace
+
+      appenders = mylogger.instance_variable_get :@appenders
+      assert_equal 2, appenders.length
+      assert_equal ['logfile', 'stderr'], appenders.map {|a| a.name}.sort
+
+      # yourlogger
+      yourlogger = ::Logging::Logger['yourlogger']
+      assert_equal 1, yourlogger.level
+      assert_equal true, yourlogger.additive
+      assert_equal false, yourlogger.trace
+
+      appenders = yourlogger.instance_variable_get :@appenders
+      assert_equal 2, appenders.length
+      assert_equal ['logfile', 'stderr'], appenders.map {|a| a.name}.sort
+
+      # cleanup
+      File.delete('temp.log') if File.exist?('temp.log')
+    end
+
     def test_define_levels_default
       empty = {}
       assert_equal empty, @levels
@@ -91,7 +156,7 @@ module TestLogging
     def test_format_as
       assert_equal false, ::Logging.const_defined?('OBJ_FORMAT')
 
-      assert_raises(ArgumentError) {::Logging.format_as 'string'}
+      assert_raises(ArgumentError) {::Logging.format_as 'bob'}
       assert_raises(ArgumentError) {::Logging.format_as String}
       assert_raises(ArgumentError) {::Logging.format_as :what?}
       
@@ -113,6 +178,21 @@ module TestLogging
       assert ::Logging.const_defined?('OBJ_FORMAT')
       assert_equal :yaml, ::Logging::OBJ_FORMAT
       remove_const[:OBJ_FORMAT]
+
+      ::Logging.format_as 'string'
+      assert ::Logging.const_defined?('OBJ_FORMAT')
+      assert_equal :string, ::Logging::OBJ_FORMAT
+      remove_const[:OBJ_FORMAT]
+
+      ::Logging.format_as 'inspect'
+      assert ::Logging.const_defined?('OBJ_FORMAT')
+      assert_equal :inspect, ::Logging::OBJ_FORMAT
+      remove_const[:OBJ_FORMAT]
+
+      ::Logging.format_as 'yaml'
+      assert ::Logging.const_defined?('OBJ_FORMAT')
+      assert_equal :yaml, ::Logging::OBJ_FORMAT
+      remove_const[:OBJ_FORMAT]
     end
 
   end  # class TestLogging