logging 0.5.3 → 0.6.0

data/{tasks → rakelib}/doc.rake

@@ -14,8 +14,8 @@ namespace :doc do
     excl = Regexp.new(PROJ.rdoc_exclude.join('|'))
     files = PROJ.files.find_all do |fn|
               case fn
-              when excl: false
-              when incl: true
+              when excl; false
+              when incl; true
               else false end
             end
     rd.rdoc_files.push(*files)

data/{tasks → rakelib}/gem.rake

@@ -25,7 +25,7 @@ namespace :gem do
     s.extensions = PROJ.files.grep %r/extconf\.rb$/
 
     s.bindir = 'bin'
-    dirs = Dir['{lib,ext}']
+    dirs = Dir["{#{PROJ.libs.join(',')}}"]
     s.require_paths = dirs unless dirs.empty?
 
     incl = Regexp.new(PROJ.rdoc_include.join('|'))
@@ -33,8 +33,8 @@ namespace :gem do
     excl = Regexp.new(excl.join('|'))
     rdoc_files = PROJ.files.find_all do |fn|
                    case fn
-                   when excl: false
-                   when incl: true
+                   when excl; false
+                   when incl; true
                    else false end
                  end
     s.rdoc_options = PROJ.rdoc_opts + ['--main', PROJ.rdoc_main]

data/{tasks → rakelib}/setup.rb

@@ -1,4 +1,4 @@
-# $Id: setup.rb 40 2007-10-26 20:25:23Z tim_pease $
+# $Id: setup.rb 63 2007-12-22 20:47:54Z tim_pease $
 
 require 'rubygems'
 require 'rake'
@@ -56,9 +56,6 @@ PROJ.dependencies = []
 PROJ.need_tar = true
 PROJ.need_zip = false
 
-# Import the rake tasks
-FileList['tasks/*.rake'].each {|task| import task}
-
 # Setup some constants
 WIN32 = %r/win32/ =~ RUBY_PLATFORM unless defined? WIN32
 

data/test/appenders/test_email.rb

@@ -0,0 +1,165 @@
+# $Id: test_email.rb 69 2007-12-26 20:53:33Z tim_pease $
+
+require 'test/setup.rb'
+require 'flexmock'
+
+module TestLogging
+module TestAppenders
+
+  class TestEmail < Test::Unit::TestCase
+    include FlexMock::TestCase
+    include LoggingTestCase
+
+    def setup
+      super
+      ::Logging.define_levels %w(debug info warn error fatal)
+      @levels = ::Logging::LEVELS
+
+      flexmock(Net::SMTP).new_instances do |m|
+        m.should_receive(:start).at_least.once.with(
+            'test.logging', 'test', 'test', :cram_md5, Proc).and_yield(m)
+        m.should_receive(:sendmail).at_least.once.with(String, 'me', ['you'])
+      end
+
+      @appender = ::Logging::Appenders::Email.new('email',
+          'from' => 'me', 'to' => 'you',
+          :buffsize => '3', :immediate_at => 'error, fatal',
+          :domain => 'test.logging', :acct => 'test', :passwd => 'test'
+      )
+    end
+
+    def test_initialize
+      assert_raise(ArgumentError, 'Must specify from address') {
+        ::Logging::Appenders::Email.new('email')
+      }
+      assert_raise(ArgumentError, 'Must specify to address') {
+        ::Logging::Appenders::Email.new('email', :from => 'me')
+      }
+      assert_nothing_raised {
+        ::Logging::Appenders::Email.new('email', :from => 'me', :to => 'you')
+      }
+
+      appender = ::Logging::Appenders::Email.new('email',
+          'from' => 'me', 'to' => 'you'
+      )
+
+      assert_equal(100, appender.instance_variable_get(:@buffsize))
+      assert_equal([], appender.instance_variable_get(:@immediate))
+      assert_equal('localhost', appender.server)
+      assert_equal(25, appender.port)
+      assert_equal(ENV['HOSTNAME'], appender.domain)
+      assert_equal(nil, appender.acct)
+      assert_equal(:cram_md5, appender.authtype)
+      assert_equal("Message of #{$0}", appender.subject)
+
+      appender = ::Logging::Appenders::Email.new('email',
+          'from' => 'lbrinn@gmail.com', 'to' => 'everyone',
+          :buffsize => '1000', :immediate_at => 'error, fatal',
+          :server => 'smtp.google.com', :port => '443',
+          :domain => 'google.com', :acct => 'lbrinn',
+          :passwd => '1234', :authtype => 'tls',
+          :subject => "I'm rich and you're not"
+      )
+
+      assert_equal('lbrinn@gmail.com', appender.instance_variable_get(:@from))
+      assert_equal(['everyone'], appender.instance_variable_get(:@to))
+      assert_equal(1000, appender.instance_variable_get(:@buffsize))
+      assert_equal('1234', appender.instance_variable_get(:@passwd))
+      assert_equal([nil, nil, nil, true, true],
+                   appender.instance_variable_get(:@immediate))
+      assert_equal('smtp.google.com', appender.server)
+      assert_equal(443, appender.port)
+      assert_equal('google.com', appender.domain)
+      assert_equal('lbrinn', appender.acct)
+      assert_equal(:tls, appender.authtype)
+      assert_equal("I'm rich and you're not", appender.subject)
+    end
+
+    def test_append
+      # with a buffer size of 0, mail will be sent each time a log event
+      # occurs
+      @appender.instance_variable_set(:@buffsize, 0)
+      event = ::Logging::LogEvent.new('TestLogger', @levels['warn'],
+                                      [1, 2, 3, 4], false)
+      @appender.append event
+      assert_not_equal(@levels.length, @appender.level)
+      assert_equal(0, @appender.queued_messages)
+
+      # increase the buffer size and log a few events
+      @appender.instance_variable_set(:@buffsize, 3)
+      @appender.append event
+      @appender.append event
+      assert_equal(2, @appender.queued_messages)
+
+      @appender.append event
+      assert_not_equal(@levels.length, @appender.level)
+      assert_equal(0, @appender.queued_messages)
+
+      # error and fatal messages should be send immediately (no buffering)
+      error = ::Logging::LogEvent.new('ErrLogger', @levels['error'],
+                                      'error message', false)
+      fatal = ::Logging::LogEvent.new('FatalLogger', @levels['fatal'],
+                                      'fatal message', false)
+
+      @appender.append event
+      @appender.append fatal
+      assert_not_equal(@levels.length, @appender.level)
+      assert_equal(0, @appender.queued_messages)
+
+      @appender.append error
+      assert_not_equal(@levels.length, @appender.level)
+      assert_equal(0, @appender.queued_messages)
+
+      @appender.append event
+      assert_equal(1, @appender.queued_messages)
+    end
+
+    def test_concat
+      # with a buffer size of 0, mail will be sent each time a log event
+      # occurs
+      @appender.instance_variable_set(:@buffsize, 0)
+      @appender << 'test message'
+      assert_not_equal(@levels.length, @appender.level)
+      assert_equal(0, @appender.queued_messages)
+
+      # increase the buffer size and log a few events
+      @appender.instance_variable_set(:@buffsize, 3)
+      @appender << 'another test message'
+      @appender << 'a second test message'
+      assert_equal(2, @appender.queued_messages)
+
+      @appender << 'a third test message'
+      assert_not_equal(@levels.length, @appender.level)
+      assert_equal(0, @appender.queued_messages)
+    end
+
+    def test_flush
+      event = ::Logging::LogEvent.new('TestLogger', @levels['info'],
+                                      [1, 2, 3, 4], false)
+      @appender.append event
+      @appender << 'test message'
+      assert_equal(2, @appender.queued_messages)
+
+      @appender.flush
+      assert_not_equal(@levels.length, @appender.level)
+      assert_equal(0, @appender.queued_messages)
+    end
+
+    def test_close
+      event = ::Logging::LogEvent.new('TestLogger', @levels['info'],
+                                      [1, 2, 3, 4], false)
+      @appender.append event
+      @appender << 'test message'
+      assert_equal(2, @appender.queued_messages)
+
+      @appender.close
+      assert_not_equal(@levels.length, @appender.level)
+      assert_equal(0, @appender.queued_messages)
+      assert(@appender.closed?)
+    end
+
+  end  # class TestEmail
+end  # module TestLogging
+end  # module TestAppenders
+
+# EOF

data/test/appenders/test_file.rb

@@ -1,4 +1,4 @@
-# $Id: test_file.rb 27 2007-02-01 16:58:11Z tim_pease $
+# $Id: test_file.rb 72 2007-12-26 21:59:58Z tim_pease $
 
 require 'test/setup.rb'
 require 'fileutils'
@@ -9,42 +9,41 @@ module TestAppenders
   class TestFile < Test::Unit::TestCase
     include LoggingTestCase
 
-    TMP = 'tmp'
     NAME = 'logfile'
 
     def setup
       super
-      FileUtils.rm_rf TMP if File.exist?(TMP)
-      FileUtils.mkdir(TMP)
+      ::Logging.define_levels %w(debug info warn error fatal)
+
       FileUtils.mkdir [File.join(TMP, 'dir'), File.join(TMP, 'uw_dir')]
       FileUtils.chmod 0555, File.join(TMP, 'uw_dir')
       FileUtils.touch File.join(TMP, 'uw_file')
       FileUtils.chmod 0444, File.join(TMP, 'uw_file')
     end
 
-    def teardown
-      cleanup
-      FileUtils.rm_rf TMP
-    end
-
-    def test_initialize
+    def test_class_assert_valid_logfile
       log = File.join(TMP, 'uw_dir', 'file.log')
       assert_raise(ArgumentError) do
-        ::Logging::Appenders::File.new(NAME, :filename => log)
+        ::Logging::Appenders::File.assert_valid_logfile(log)
       end
 
       log = File.join(TMP, 'dir')
       assert_raise(ArgumentError) do
-        ::Logging::Appenders::File.new(NAME, :filename => log)
+        ::Logging::Appenders::File.assert_valid_logfile(log)
       end
 
       log = File.join(TMP, 'uw_file')
       assert_raise(ArgumentError) do
-        ::Logging::Appenders::File.new(NAME, :filename => log)
+        ::Logging::Appenders::File.assert_valid_logfile(log)
       end
 
       log = File.join(TMP, 'file.log')
-      appender = ::Logging::Appenders::File.new NAME, 'filename' => log
+      assert ::Logging::Appenders::File.assert_valid_logfile(log)
+    end
+
+    def test_initialize
+      log = File.join(TMP, 'file.log')
+      appender = ::Logging::Appenders::File.new(NAME, 'filename' => log)
       assert_equal 'logfile', appender.name
       appender << "This will be the first line\n"
       appender << "This will be the second line\n"

data/test/appenders/test_growl.rb

@@ -0,0 +1,115 @@
+# $Id: test_growl.rb 69 2007-12-26 20:53:33Z tim_pease $
+
+require 'test/setup.rb'
+require 'flexmock'
+
+module TestLogging
+module TestAppenders
+
+  class TestGrowl < Test::Unit::TestCase
+    include FlexMock::TestCase
+    include LoggingTestCase
+
+    def setup
+      super
+      ::Logging.define_levels %w(debug info warn error fatal)
+      @levels = ::Logging::LEVELS
+
+      @appender = ::Logging::Appenders::Growl.new('growl',
+          :coalesce => true, :separator => "\000",
+          :layout => Logging::Layouts::Pattern.new(:pattern => "%5l - Test\000%m")
+      )
+      @appender.level = :all
+      @growl = @appender.instance_variable_get(:@growl).dup
+    end
+
+    def test_initialize
+      assert_equal('growlnotify -w -n "growl" -t "%s" -m "%s" -p %d &', 
+                   @appender.instance_variable_get(:@growl))
+      assert_equal(true, @appender.instance_variable_get(:@coalesce))
+      assert_equal("\000", @appender.instance_variable_get(:@title_sep))
+    end
+
+    def test_append
+      info = ::Logging::LogEvent.new('TestLogger', @levels['info'],
+                                     'info message', false)
+      warn = ::Logging::LogEvent.new('TestLogger', @levels['warn'],
+                                     'warning message', false)
+
+      flexmock(@appender).should_receive(:system).once.with(
+          @growl % ['WARN - Test', "warning message\nwarning message\nwarning message", 0])
+
+      flexmock(@appender).should_receive(:system).once.with(
+          @growl % ['INFO - Test', "info message\ninfo message", -1])
+
+      flexmock(@appender).should_receive(:system).once.with(
+          @growl % ['WARN - Test', "warning message", 0])
+
+      @appender.append warn
+      @appender.append warn
+      @appender.append warn
+      @appender.append info
+      @appender.append info
+      @appender.append warn
+      sleep 0.7  # give the coalescing thread time to run
+    end
+
+    def test_append_without_coalescing
+      @appender.instance_variable_set(:@coalesce, false)
+      event = ::Logging::LogEvent.new('TestLogger', @levels['warn'],
+                                      'warning message', false)
+
+      flexmock(@appender).should_receive(:system).twice.with(
+          @growl % ['WARN - Test', 'warning message', 0])
+
+      @appender.append event
+      @appender.append event
+    end
+
+    def test_concat
+      flexmock(@appender).should_receive(:system).once.with(
+          @growl % ['', "first message\nsecond message\nthird message", 0])
+
+      @appender << 'first message'
+      @appender << 'second message'
+      @appender << 'third message'
+      sleep 0.7  # give the coalescing thread time to run
+    end
+
+    def test_concat_without_coalescing
+      @appender.instance_variable_set(:@coalesce, false)
+
+      flexmock(@appender).should_receive(:system).twice.with(
+          @growl % ['', 'concat message', 0])
+
+      @appender << 'concat message'
+      @appender << 'concat message'
+    end
+
+    def test_map_eq
+      get_map = lambda {@appender.instance_variable_get(:@map)}
+      assert_equal([-2,-1,0,1,2], get_map.call)
+
+      @appender.map = {
+        'fatal' => '0',
+        :error => -2,
+        :warn => '2',
+        'INFO' => 1,
+        'Debug' => -1
+      }
+      assert_equal([-1,1,2,-2,0], get_map.call)
+
+      assert_raise(ArgumentError) do
+        @appender.map = {:fatal => 'not a number', :error => 2}
+      end
+
+      assert_raise(ArgumentError) do
+        @appender.map = {:fatal => -3, :error => 3}
+      end
+    end
+
+  end  # class TestGrowl
+end  # module TestLogging
+end  # module TestAppenders
+
+# EOF

data/test/appenders/test_io.rb

@@ -1,4 +1,4 @@
-# $Id: test_io.rb 53 2007-11-28 00:21:33Z tim_pease $
+# $Id: test_io.rb 67 2007-12-26 16:27:06Z tim_pease $
 
 require 'test/setup.rb'
 require 'stringio'
@@ -41,7 +41,8 @@ module TestAppenders
       event = ::Logging::LogEvent.new('TestLogger', @levels['warn'],
                                       [1, 2, 3, 4], false)
       assert_raise(IOError) {@appender.append event}
-      assert_equal true, @appender.closed?
+      assert_equal false, @appender.closed?
+      assert_equal 5, @appender.level
     end
 
     def test_close
@@ -78,7 +79,8 @@ module TestAppenders
     def test_concat_error
       @sio.close
       assert_raise(IOError) {@appender << 'oopsy'}
-      assert_equal true, @appender.closed?
+      assert_equal false, @appender.closed?
+      assert_equal 5, @appender.level
     end
 
     def test_flush

data/test/appenders/test_rolling_file.rb

@@ -1,4 +1,4 @@
-# $Id: test_rolling_file.rb 31 2007-02-22 23:16:17Z tim_pease $
+# $Id: test_rolling_file.rb 72 2007-12-26 21:59:58Z tim_pease $
 
 require 'test/setup.rb'
 require 'fileutils'
@@ -9,23 +9,17 @@ module TestAppenders
   class TestRollingFile < Test::Unit::TestCase
     include LoggingTestCase
 
-    TMP = 'tmp'
     NAME = 'roller'
 
     def setup
       super
-      FileUtils.rm_rf TMP if File.exist?(TMP)
-      FileUtils.mkdir(TMP)
+      ::Logging.define_levels %w(debug info warn error fatal)
+
       @fn = File.join(TMP, 'test.log')
       @fn_fmt = File.join(TMP, 'test.%d.log')
       @glob = File.join(TMP, '*.log')
     end
 
-    def teardown
-      cleanup
-      FileUtils.rm_rf TMP
-    end
-
     def test_initialize
       assert_equal [], Dir.glob(@glob)