logging 2.2.1 → 2.3.1

data/test/appenders/test_console.rb

@@ -20,11 +20,10 @@ module TestAppenders
 
       appender = Logging.appenders.stdout
       assert_equal 'stdout', appender.name
-      assert_same STDOUT, appender.instance_variable_get(:@io)
 
-      appender.close
-      assert_equal true, appender.closed?
-      assert_equal false, STDOUT.closed?
+      io = appender.instance_variable_get(:@io)
+      assert_same STDOUT, io
+      assert_equal STDOUT.fileno, io.fileno
 
       appender = Logging.appenders.stdout('foo')
       assert_equal 'foo', appender.name
@@ -38,7 +37,26 @@ module TestAppenders
       assert_equal 3, appender.level
     end
 
-  end  # class TestStdout
+    def test_reopen
+      Logging::Repository.instance
+
+      appender = Logging.appenders.stdout
+      io = appender.instance_variable_get(:@io)
+
+      appender.close
+      assert appender.closed?
+      refute io.closed?
+      refute STDOUT.closed?
+
+      appender.reopen
+      refute appender.closed?
+
+      new_io = appender.instance_variable_get(:@io)
+      assert_same io, new_io
+      refute new_io.closed?
+      refute io.closed?
+    end
+  end
 
   class TestStderr < Test::Unit::TestCase
     include LoggingTestCase
@@ -48,11 +66,10 @@ module TestAppenders
 
       appender = Logging.appenders.stderr
       assert_equal 'stderr', appender.name
-      assert_same STDERR, appender.instance_variable_get(:@io)
 
-      appender.close
-      assert_equal true, appender.closed?
-      assert_equal false, STDERR.closed?
+      io = appender.instance_variable_get(:@io)
+      assert_same STDERR, io
+      assert_equal STDERR.fileno, io.fileno
 
       appender = Logging.appenders.stderr('foo')
       assert_equal 'foo', appender.name
@@ -66,8 +83,26 @@ module TestAppenders
       assert_equal 3, appender.level
     end
 
-  end  # class TestStderr
+    def test_reopen
+      Logging::Repository.instance
 
-end  # module TestAppenders
-end  # module TestLogging
+      appender = Logging.appenders.stderr
+      io = appender.instance_variable_get(:@io)
+
+      appender.close
+      assert appender.closed?
+      refute io.closed?
+      refute STDERR.closed?
+
+      appender.reopen
+      refute appender.closed?
+
+      new_io = appender.instance_variable_get(:@io)
+      assert_same io, new_io
+      refute new_io.closed?
+      refute io.closed?
+    end
+  end
+end
+end
 

data/test/appenders/test_file.rb

@@ -14,10 +14,10 @@ module TestAppenders
       super
       Logging.init
 
-      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')
+      FileUtils.mkdir [File.join(@tmpdir, 'dir'), File.join(@tmpdir, 'uw_dir')]
+      FileUtils.chmod 0555, File.join(@tmpdir, 'uw_dir')
+      FileUtils.touch File.join(@tmpdir, 'uw_file')
+      FileUtils.chmod 0444, File.join(@tmpdir, 'uw_file')
     end
 
     def test_factory_method_validates_input
@@ -27,27 +27,27 @@ module TestAppenders
     end
 
     def test_class_assert_valid_logfile
-      log = File.join(TMP, 'uw_dir', 'file.log')
+      log = File.join(@tmpdir, 'uw_dir', 'file.log')
       assert_raise(ArgumentError) do
         Logging.appenders.file(log).class.assert_valid_logfile(log)
       end
 
-      log = File.join(TMP, 'dir')
+      log = File.join(@tmpdir, 'dir')
       assert_raise(ArgumentError) do
         Logging.appenders.file(log).class.assert_valid_logfile(log)
       end
 
-      log = File.join(TMP, 'uw_file')
+      log = File.join(@tmpdir, 'uw_file')
       assert_raise(ArgumentError) do
         Logging.appenders.file(log).class.assert_valid_logfile(log)
       end
 
-      log = File.join(TMP, 'file.log')
+      log = File.join(@tmpdir, 'file.log')
       assert Logging.appenders.file(log).class.assert_valid_logfile(log)
     end
 
     def test_initialize
-      log = File.join(TMP, 'file.log')
+      log = File.join(@tmpdir, 'file.log')
       appender = Logging.appenders.file(NAME, :filename => log)
       assert_equal 'logfile', appender.name
       assert_equal ::File.expand_path(log), appender.filename
@@ -87,7 +87,7 @@ module TestAppenders
     end
 
     def test_changing_directories
-      log = File.join(TMP, 'file.log')
+      log = File.join(@tmpdir, 'file.log')
       appender = Logging.appenders.file(NAME, :filename => log)
 
       assert_equal 'logfile', appender.name
@@ -95,29 +95,45 @@ module TestAppenders
 
       begin
         pwd = Dir.pwd
-        Dir.chdir TMP
+        Dir.chdir @tmpdir
         assert_nothing_raised { appender.reopen }
       ensure
         Dir.chdir pwd
       end
     end
 
-    if Object.const_defined? :Encoding
+    def test_encoding
+      log = File.join(@tmpdir, 'file-encoding.log')
+      appender = Logging.appenders.file(NAME, :filename => log, :encoding => 'ASCII')
 
-      def test_encoding
-        log = File.join(TMP, 'file-encoding.log')
-        appender = Logging.appenders.file(NAME, :filename => log, :encoding => 'ASCII')
+      appender << "A normal line of text\n"
+      appender << "ümlaut\n"
+      appender.close
 
-        appender << "A normal line of text\n"
-        appender << "ümlaut\n"
-        appender.close
+      lines = File.readlines(log, :encoding => 'UTF-8')
+      assert_equal "A normal line of text\n", lines[0]
+      assert_equal "ümlaut\n", lines[1]
 
-        lines = File.readlines(log, :encoding => 'UTF-8')
-        assert_equal "A normal line of text\n", lines[0]
-        assert_equal "ümlaut\n", lines[1]
+      cleanup
+    end
+
+    def test_reopening_should_not_truncate_the_file
+      log = File.join(@tmpdir, 'truncate.log')
+      appender = Logging.appenders.file(NAME, filename: log, truncate: true)
+
+      appender << "This will be the first line\n"
+      appender << "This will be the second line\n"
+      appender << "This will be the third line\n"
+      appender.reopen
 
-        cleanup
+      File.open(log, 'r') do |file|
+        assert_equal "This will be the first line\n", file.readline
+        assert_equal "This will be the second line\n", file.readline
+        assert_equal "This will be the third line\n", file.readline
+        assert_raise(EOFError) {file.readline}
       end
+
+      cleanup
     end
 
   private
@@ -127,7 +143,6 @@ module TestAppenders
         Logging.appenders[NAME] = nil
       end
     end
-
   end  # TestFile
 
 end  # TestAppenders

data/test/appenders/test_rolling_file.rb

@@ -13,9 +13,9 @@ module TestAppenders
       super
       Logging.init
 
-      @fn = File.expand_path('test.log', TMP)
-      @fn_fmt = File.expand_path('test.%d.log', TMP)
-      @glob = File.expand_path('*.log', TMP)
+      @fn = File.expand_path('test.log', @tmpdir)
+      @fn_fmt = File.expand_path('test.%d.log', @tmpdir)
+      @glob = File.expand_path('*.log', @tmpdir)
     end
 
     def test_factory_method_validates_input
@@ -93,8 +93,8 @@ module TestAppenders
     end
 
     def test_age
-      d_glob = File.join(TMP, 'test.*.log')
-      dt_glob = File.join(TMP, 'test.*-*.log')
+      d_glob = File.join(@tmpdir, 'test.*.log')
+      dt_glob = File.join(@tmpdir, 'test.*-*.log')
       age_fn = @fn + '.age'
 
       assert_equal [], Dir.glob(@glob)
@@ -205,7 +205,7 @@ module TestAppenders
 
       begin
         pwd = Dir.pwd
-        Dir.chdir TMP
+        Dir.chdir @tmpdir
 
         ap << 'X' * 100; ap.flush
         assert_equal 1, Dir.glob(@glob).length
@@ -249,9 +249,9 @@ module TestAppenders
     end
 
     def test_custom_numberd_filename
-      fn = File.expand_path('test.log{{.%d}}', TMP)
-      filename = File.expand_path('test.log', TMP)
-      glob = File.expand_path('test.log.*', TMP)
+      fn = File.expand_path('test.log{{.%d}}', @tmpdir)
+      filename = File.expand_path('test.log', @tmpdir)
+      glob = File.expand_path('test.log.*', @tmpdir)
 
       assert_equal [], Dir.glob(glob)
       ap = Logging.appenders.rolling_file(NAME, :filename => fn, :size => 100, :keep => 2)
@@ -285,10 +285,10 @@ module TestAppenders
     end
 
     def test_custom_timestamp_filename
-      fn = File.expand_path('test{{.%S:%M}}.log', TMP)
-      filename = File.expand_path('test.log', TMP)
+      fn = File.expand_path('test{{.%S:%M}}.log', @tmpdir)
+      filename = File.expand_path('test.log', @tmpdir)
       age_file = filename + '.age'
-      glob = File.expand_path('test.*.log', TMP)
+      glob = File.expand_path('test.*.log', @tmpdir)
 
       assert_equal [], Dir.glob(glob)
       ap = Logging.appenders.rolling_file(NAME, :filename => fn, :age => 1, :keep => 2)

data/test/layouts/test_json.rb

@@ -78,7 +78,7 @@ module TestLayouts
                                     'log message', false)
       event.file = 'test_file.rb'
       event.line = 123
-      event.method = 'method_name'
+      event.method_name = 'method_name'
 
       @layout.items = %w[logger]
       assert_equal %Q[{"logger":"TestLogger"}\n], @layout.format(event)

data/test/layouts/test_nested_exceptions.rb

@@ -7,46 +7,118 @@ module TestLogging
       include LoggingTestCase
 
       def test_basic_format_obj
+        err = nil
         begin
-          raise StandardError, 'nested exception'
-        rescue
-          raise Exception, 'root exception'
+          begin
+            raise ArgumentError, 'nested exception'
+          rescue
+            raise StandardError, 'root exception'
+          end
+        rescue => e
+          err = e
         end
-      rescue Exception => e
+
         layout = Logging.layouts.basic({})
-        log = layout.format_obj(e)
-        assert_not_nil log.index('<Exception> root exception')
+        log = layout.format_obj(err)
+        assert_not_nil log.index('<StandardError> root exception')
 
-        if defined? e.cause
-          assert_not_nil log.index('<StandardError> nested exception')
-          assert_operator log.index('<Exception> root exception'), :<, log.index('<StandardError> nested exception')
+        if err.respond_to?(:cause)
+          assert_not_nil log.index('<ArgumentError> nested exception')
+          assert(log.index('<StandardError> root exception') < log.index('<ArgumentError> nested exception'))
+        end
+      end
+
+      def test_cause_depth_limiting
+        err = nil
+        begin
+          begin
+            begin
+              raise TypeError, 'nested exception 2'
+            rescue
+              raise ArgumentError, 'nested exception 1'
+            end
+          rescue
+            raise StandardError, 'root exception'
+          end
+        rescue => e
+          err = e
+        end
+
+        layout = Logging.layouts.basic(cause_depth: 1)
+        log = layout.format_obj(err)
+        assert_not_nil log.index('<StandardError> root exception')
+
+        if err.respond_to?(:cause)
+          assert_not_nil log.index('<ArgumentError> nested exception 1')
+          assert_nil log.index('<TypeError> nested exception 2')
+          assert_equal '--- Further #cause backtraces were omitted ---', log.split("\n\t").last
         end
       end
 
       def test_parseable_format_obj
+        err = nil
         begin
-          raise StandardError, 'nested exception'
-        rescue
-          raise Exception, 'root exception'
+          begin
+            raise ArgumentError, 'nested exception'
+          rescue
+            raise StandardError, 'root exception'
+          end
+        rescue => e
+          err = e
         end
-      rescue Exception => e
+
         layout = Logging.layouts.parseable.new
-        log = layout.format_obj(e)
-        assert_equal Exception.name, log[:class]
+        log = layout.format_obj(err)
+        assert_equal 'StandardError', log[:class]
         assert_equal 'root exception', log[:message]
-        assert_operator log[:backtrace].size, :>, 0
+        assert log[:backtrace].size > 0
 
-        if defined? e.cause
+        if err.respond_to?(:cause)
           assert_not_nil log[:cause]
 
           log = log[:cause]
-          assert_equal StandardError.name, log[:class]
+          assert_equal 'ArgumentError', log[:class]
           assert_equal 'nested exception', log[:message]
           assert_nil log[:cause]
-          assert_operator log[:backtrace].size, :>, 0
+          assert log[:backtrace].size > 0
+        end
+      end
+
+      def test_parseable_cause_depth_limiting
+        err = nil
+        begin
+          begin
+            begin
+              raise TypeError, 'nested exception 2'
+            rescue
+              raise ArgumentError, 'nested exception 1'
+            end
+          rescue
+            raise StandardError, 'root exception'
+          end
+        rescue => e
+          err = e
+        end
+
+        layout = Logging.layouts.parseable.new(cause_depth: 1)
+        log = layout.format_obj(err)
+
+        assert_equal 'StandardError', log[:class]
+        assert_equal 'root exception', log[:message]
+        assert log[:backtrace].size > 0
+
+        if err.respond_to?(:cause)
+          assert_not_nil log[:cause]
+
+          log = log[:cause]
+          assert_equal 'ArgumentError', log[:class]
+          assert_equal 'nested exception 1', log[:message]
+          assert_equal({message: "Further #cause backtraces were omitted"}, log[:cause])
+          assert log[:backtrace].size > 0
         end
       end
     end
   end
 end
 
+require 'pp'

data/test/layouts/test_pattern.rb

@@ -105,7 +105,7 @@ module TestLayouts
                                     'log message', false)
       event.file = 'test_file.rb'
       event.line = '123'
-      event.method = 'method_name'
+      event.method_name = 'method_name'
 
       @layout.pattern = '%c'
       assert_equal 'TestLogger', @layout.format(event)

data/test/layouts/test_yaml.rb

@@ -68,7 +68,7 @@ module TestLayouts
                                     'log message', false)
       event.file = 'test_file.rb'
       event.line = 123
-      event.method = 'method_name'
+      event.method_name = 'method_name'
 
       @layout.items = %w[logger]
       assert_match %r/\A--- ?\nlogger: TestLogger\n/, @layout.format(event)

data/test/setup.rb

@@ -5,6 +5,12 @@ LOGGING_TEST_SETUP = true
 
 require "rubygems"
 require "test/unit"
+require "tmpdir"
+
+LOGGING_TEST_TMPDIR = Dir.mktmpdir("logging")
+Test::Unit.at_exit do
+  FileUtils.remove_entry(LOGGING_TEST_TMPDIR)
+end
 
 if Test::Unit::TestCase.respond_to? :test_order=
   Test::Unit::TestCase.test_order = :random
@@ -15,18 +21,16 @@ require File.expand_path("../../lib/logging", __FILE__)
 module TestLogging
   module LoggingTestCase
 
-    TMP = 'tmp'
-
     def setup
       super
       Logging.reset
-      FileUtils.rm_rf TMP
-      FileUtils.mkdir TMP
+      @tmpdir = LOGGING_TEST_TMPDIR
+      FileUtils.rm_rf(Dir.glob(File.join(@tmpdir, "*")))
     end
 
     def teardown
       super
-      FileUtils.rm_rf TMP
+      FileUtils.rm_rf(Dir.glob(File.join(@tmpdir, "*")))
     end
   end
 end

data/test/test_log_event.rb

@@ -68,12 +68,12 @@ module TestLogging
       assert_equal 'MyLogger', @event.logger
     end
 
-    def test_method
+    def test_method_name
       assert_equal '', @event.file
 
       @logger.caller_tracing = true
       @logger.debug 'debug message'
-      assert_equal 'test_method', @appender.event.method
+      assert_equal 'test_method_name', @appender.event.method_name
     end
 
   end  # class TestLogEvent

data/test/test_logging.rb

@@ -11,8 +11,8 @@ module TestLogging
       @levels = ::Logging::LEVELS
       @lnames = ::Logging::LNAMES
 
-      @fn = File.join(TMP, 'test.log')
-      @glob = File.join(TMP, '*.log')
+      @fn = File.join(@tmpdir, 'test.log')
+      @glob = File.join(@tmpdir, '*.log')
     end
 
     def test_backtrace
@@ -54,6 +54,24 @@ module TestLogging
       assert_raise(ArgumentError) {::Logging.utc_offset = "06:00"}
     end
 
+    def test_cause_depth
+      assert_equal ::Logging::DEFAULT_CAUSE_DEPTH, ::Logging.cause_depth
+
+      ::Logging.cause_depth = 0
+      assert_equal 0, ::Logging.cause_depth
+
+      ::Logging.cause_depth = nil
+      assert_equal ::Logging::DEFAULT_CAUSE_DEPTH, ::Logging.cause_depth
+
+      ::Logging.cause_depth = "1024"
+      assert_equal 1024, ::Logging.cause_depth
+
+      ::Logging.cause_depth = -1
+      assert_equal ::Logging::DEFAULT_CAUSE_DEPTH, ::Logging.cause_depth
+
+      assert_raise(ArgumentError) {::Logging.cause_depth = "foo"}
+    end
+
     def test_basepath
       assert_nil ::Logging.basepath
 
@@ -235,6 +253,31 @@ module TestLogging
       assert_match %r/\d+\.\d+\.\d+/, ::Logging.version
     end
 
-  end  # class TestLogging
-end  # module TestLogging
+    class Failer
+      class WriteError < StandardError ; end
+      def self.write(*args)
+        raise WriteError.new("Oh noooooo")
+      end
+    end
 
+    def test_error_handling
+      logger = ::Logging.logger Failer, 2, 100
+      logger.appenders.first.level = :debug
+
+      # No errors are raised by default
+      logger.fatal 'this is a debug message'
+      # Always reset the level; we disable appenders that raise by setting them
+      # to :off
+      logger.appenders.first.level = :debug
+
+      begin
+        Logging.raise_errors = true
+        assert_raises Failer::WriteError do
+          logger.fatal 'this fails because the file descriptor is closed'
+        end
+      ensure
+        Logging.raise_errors = false
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logging
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.1
 platform: ruby
 authors:
 - Tim Pease
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-04-10 00:00:00.000000000 Z
+date: 2022-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: little-plugger
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: bones-git
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.8.4
+        version: 3.8.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.8.4
+        version: 3.8.5
 description: |-
   **Logging** is a flexible logging library for use in Ruby programs based on the
   design of Java's log4j library. It features a hierarchical logging system,
@@ -179,7 +179,7 @@ files:
 homepage: http://rubygems.org/gems/logging
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -196,9 +196,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: logging
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A flexible and extendable logging library for Ruby
 test_files: