semantic_logger 2.16.0 → 2.17.0

data/test/appender/file_test.rb

@@ -0,0 +1,79 @@
+require_relative '../test_helper'
+require 'stringio'
+
+# Unit Test for SemanticLogger::Appender::File
+#
+module Appender
+  class FileTest < Minitest::Test
+    describe SemanticLogger::Appender::File do
+      before do
+        SemanticLogger.default_level = :trace
+        @time                        = Time.new
+        @io                          = StringIO.new
+        @appender                    = SemanticLogger::Appender::File.new(@io)
+        @hash                        = {session_id: 'HSSKLEU@JDK767', tracking_number: 12345}
+        @hash_str                    = @hash.inspect.sub("{", "\\{").sub("}", "\\}")
+        @thread_name                 = Thread.current.name
+      end
+
+      describe 'format logs into text form' do
+        it 'handle no message or payload' do
+          @appender.debug
+          assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ D \[\d+:#{@thread_name}\] SemanticLogger::Appender::File -- \n/, @io.string
+        end
+
+        it 'handle message' do
+          @appender.debug 'hello world'
+          assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ D \[\d+:#{@thread_name}\] SemanticLogger::Appender::File -- hello world\n/, @io.string
+        end
+
+        it 'handle message and payload' do
+          @appender.debug 'hello world', @hash
+          assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ D \[\d+:#{@thread_name}\] SemanticLogger::Appender::File -- hello world -- #{@hash_str}\n/, @io.string
+        end
+
+        it 'handle message, payload, and exception' do
+          @appender.debug 'hello world', @hash, StandardError.new('StandardError')
+          assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ D \[\d+:#{@thread_name}\] SemanticLogger::Appender::File -- hello world -- #{@hash_str} -- Exception: StandardError: StandardError\n\n/, @io.string
+        end
+
+        it 'handle exception only' do
+          @appender.debug StandardError.new('StandardError')
+          assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ D \[\d+:#{@thread_name}\] SemanticLogger::Appender::File -- #<StandardError: StandardError> -- Exception: StandardError: StandardError\n\n/, @io.string
+        end
+      end
+
+      describe 'for each log level' do
+        # Ensure that any log level can be logged
+        SemanticLogger::LEVELS.each do |level|
+          it "log #{level} information" do
+            @appender.send(level, 'hello world', @hash)
+            assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ \w \[\d+:#{@thread_name}\] SemanticLogger::Appender::File -- hello world -- #{@hash_str}\n/, @io.string
+          end
+        end
+      end
+
+      describe 'custom formatter' do
+        before do
+          @appender = SemanticLogger::Appender::File.new(@io) do |log|
+            tags = log.tags.collect { |tag| "[#{tag}]" }.join(' ') + ' ' if log.tags && (log.tags.size > 0)
+
+            message = log.message.to_s
+            message << ' -- ' << log.payload.inspect if log.payload
+            message << ' -- ' << "#{log.exception.class}: #{log.exception.message}\n#{(log.exception.backtrace || []).join("\n")}" if log.exception
+
+            duration_str = log.duration ? " (#{'%.1f' % log.duration}ms)" : ''
+
+            "#{SemanticLogger::Appender::Base.formatted_time(log.time)} #{log.level.to_s.upcase} [#{$$}:#{log.thread_name}] #{tags}#{log.name} -- #{message}#{duration_str}"
+          end
+        end
+
+        it 'format using formatter' do
+          @appender.debug
+          assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ DEBUG \[\d+:#{@thread_name}\] SemanticLogger::Appender::File -- \n/, @io.string
+        end
+      end
+
+    end
+  end
+end

data/test/appender/mongodb_test.rb

@@ -0,0 +1,105 @@
+require_relative '../test_helper'
+
+# Unit Test for SemanticLogger::Appender::MongoDB
+#
+module Appender
+  class MongoDBTest < Minitest::Test
+    describe SemanticLogger::Appender::MongoDB do
+      before do
+        @db                 = Mongo::Connection.new['test']
+        @appender           = SemanticLogger::Appender::MongoDB.new(
+          db:              @db,
+          collection_size: 10*1024**2, # 10MB
+          host_name:       'test',
+          application:     'test_application',
+          level:           :trace
+        )
+        @hash               = {tracking_number: 12345, session_id: 'HSSKLEU@JDK767'}
+        Thread.current.name = 'thread'
+      end
+
+      after do
+        @appender.purge_all if @appender
+      end
+
+      describe "format logs into documents" do
+
+        it "handle nil name, message and hash" do
+          @appender.debug
+          document = @appender.collection.find_one
+          assert_equal :debug, document['level']
+          assert_equal nil, document['message']
+          assert_equal 'thread', document['thread_name']
+          assert document['time'].is_a?(Time)
+          assert_equal nil, document['payload']
+          assert_equal $$, document['pid']
+          assert_equal 'test', document['host_name']
+          assert_equal 'test_application', document['application']
+        end
+
+        it "handle nil message and payload" do
+          @appender.debug(@hash)
+
+          document = @appender.collection.find_one
+          assert_equal :debug, document['level']
+          assert_equal @hash.inspect, document['message']
+          assert_equal 'thread', document['thread_name']
+          assert document['time'].is_a?(Time)
+          assert_nil document['payload']
+          assert_equal $$, document['pid']
+          assert_equal 'test', document['host_name']
+          assert_equal 'test_application', document['application']
+        end
+
+        it "handle message and payload" do
+          @appender.debug('hello world', @hash)
+
+          document = @appender.collection.find_one
+          assert_equal :debug, document['level']
+          assert_equal 'hello world', document['message']
+          assert_equal 'thread', document['thread_name']
+          assert document['time'].is_a?(Time)
+          assert_equal({"tracking_number" => 12345, "session_id" => 'HSSKLEU@JDK767'}, document['payload'])
+          assert_equal $$, document['pid']
+          assert_equal 'test', document['host_name']
+          assert_equal 'test_application', document['application']
+        end
+
+        it "handle message without payload" do
+          log = SemanticLogger::Base::Log.new(:debug)
+          @appender.debug('hello world')
+
+          document = @appender.collection.find_one
+          assert_equal :debug, document['level']
+          assert_equal 'hello world', document['message']
+          assert_equal 'thread', document['thread_name']
+          assert document['time'].is_a?(Time)
+          assert_equal nil, document['payload']
+          assert_equal $$, document['pid']
+          assert_equal 'test', document['host_name']
+          assert_equal 'test_application', document['application']
+        end
+      end
+
+      describe "for each log level" do
+        # Ensure that any log level can be logged
+        SemanticLogger::LEVELS.each do |level|
+          it "log #{level} information" do
+            @appender.send(level, 'hello world -- Calculations', @hash)
+            document = @appender.collection.find_one
+            assert_equal level, document['level']
+            assert_equal 'hello world -- Calculations', document['message']
+            assert_equal 'thread', document['thread_name']
+            assert document['time'].is_a?(Time)
+            assert_equal({"tracking_number" => 12345, "session_id" => 'HSSKLEU@JDK767'}, document['payload'])
+            assert_equal $$, document['pid']
+            assert_equal 'test', document['host_name']
+            assert_equal 'test_application', document['application']
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/test/appender/new_relic_test.rb

@@ -0,0 +1,64 @@
+# So that the NewRelic appender will load the mock
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require_relative '../test_helper'
+
+# Unit Test for SemanticLogger::Appender::NewRelic
+module Appender
+  class NewRelicTest < Minitest::Test
+    describe SemanticLogger::Appender::NewRelic do
+
+      before do
+        @appender = SemanticLogger::Appender::NewRelic.new(:error)
+        @message  = 'AppenderNewRelicTest log message'
+      end
+
+      (SemanticLogger::LEVELS - [:error, :fatal]).each do |level|
+        it "does not send :#{level.to_s} notifications to New Relic" do
+          exception = hash = nil
+          NewRelic::Agent.stub(:notice_error, -> exc, h { exception = exc; hash = h }) do
+            @appender.tagged('test') do
+              @appender.send(level, "AppenderNewRelicTest #{level.to_s} message")
+            end
+          end
+          assert_nil exception
+          assert_nil hash
+        end
+      end
+
+      [:error, :fatal].each do |level|
+        it "sends :#{level.to_s} notifications to New Relic" do
+          exception = hash = nil
+          NewRelic::Agent.stub(:notice_error, -> exc, h { exception = exc; hash = h }) do
+            @appender.tagged('test') do
+              @appender.send(level, @message)
+            end
+          end
+          assert_equal 'RuntimeError', exception.class.to_s
+          assert_equal @message, exception.message
+          assert_equal ['test'], hash[:custom_params][:tags]
+          assert_nil hash[:custom_params][:duration]
+          assert hash[:custom_params][:thread_name], hash.inspect
+        end
+      end
+
+      it 'send notification to New Relic with custom attributes' do
+        exception = hash = nil
+        NewRelic::Agent.stub(:notice_error, -> exc, h { exception = exc; hash = h }) do
+          @appender.tagged('test') do
+            @appender.with_payload({key1: 1, key2: 'a'}) do
+              @appender.benchmark(:error, @message) do
+                sleep 0.001
+              end
+            end
+          end
+        end
+        assert_equal 'RuntimeError', exception.class.to_s
+        assert_equal @message, exception.message
+        assert_equal ['test'], hash[:custom_params][:tags], hash
+        assert_equal({key1: 1, key2: 'a'}, hash[:custom_params][:payload], hash)
+        assert hash[:custom_params][:duration], hash
+        assert hash[:custom_params][:thread_name], hash
+      end
+    end
+  end
+end

data/test/appender/splunk_test.rb

@@ -0,0 +1,50 @@
+require_relative 'test_helper'
+
+# Unit Test for SemanticLogger::Appender::Splunk
+#
+module Appender
+  class SplunkTest < Minitest::Test
+    describe SemanticLogger::Appender::Splunk do
+
+      describe '#parse_options' do
+        describe 'argument errors' do
+          it 'raise argument error for missing username' do
+            error = assert_raises ArgumentError do
+              SemanticLogger::Appender::Splunk.new({})
+            end
+
+            assert_equal 'Must supply a username.', error.message
+          end
+
+          it 'raise argument error for missing password' do
+            error = assert_raises ArgumentError do
+              SemanticLogger::Appender::Splunk.new(username: 'username')
+            end
+
+            assert_equal 'Must supply a password.', error.message
+          end
+        end
+
+        describe 'set default values' do
+          it 'have default values' do
+            appender = Splunk.stub(:connect, Splunk::Service.new({})) do
+              Splunk::Service.stub_any_instance(:indexes, {}) do
+                SemanticLogger::Appender::Splunk.new(username: 'username', password: 'password')
+              end
+            end
+            config   = appender.config
+            # Default host
+            assert_equal 'localhost', config[:host]
+            # Default port
+            assert_equal 8089, config[:port]
+            # Default scheme
+            assert_equal :https, config[:scheme]
+            #Default index
+            assert_equal 'main', appender.index
+          end
+        end
+      end
+
+    end
+  end
+end

data/test/appender/syslog_test.rb

@@ -0,0 +1,63 @@
+require_relative '../test_helper'
+require 'net/tcp_client'
+
+# Unit Test for SemanticLogger::Appender::Syslog
+#
+module Appender
+  class SyslogTest < Minitest::Test
+    describe SemanticLogger::Appender::Syslog do
+
+      it 'handle local syslog' do
+        message = nil
+        Syslog.stub(:open, nil) do
+          Syslog.stub(:log, -> level, msg { message = msg }) do
+            syslog_appender = SemanticLogger::Appender::Syslog.new(level: :debug)
+            syslog_appender.debug 'AppenderSyslogTest log message'
+          end
+        end
+        assert_match /D (.*?) SemanticLogger::Appender::Syslog -- AppenderSyslogTest log message/, message
+      end
+
+      it 'handle remote syslog over TCP' do
+        message = nil
+        Net::TCPClient.stub_any_instance(:closed?, false) do
+          Net::TCPClient.stub_any_instance(:connect, nil) do
+            syslog_appender = SemanticLogger::Appender::Syslog.new(server: 'tcp://localhost:88888', level: :debug)
+            syslog_appender.remote_syslog.stub(:write, Proc.new { |data| message = data }) do
+              syslog_appender.debug 'AppenderSyslogTest log message'
+            end
+          end
+        end
+        assert_match /<70>(.*?)SemanticLogger::Appender::Syslog -- AppenderSyslogTest log message\r\n/, message
+      end
+
+      it 'handle remote syslog over UDP' do
+        message         = nil
+        syslog_appender = SemanticLogger::Appender::Syslog.new(server: 'udp://localhost:88888', level: :debug)
+        UDPSocket.stub_any_instance(:send, -> msg, num, host, port { message = msg }) do
+          syslog_appender.debug 'AppenderSyslogTest log message'
+        end
+        assert_match /<70>(.*?)SemanticLogger::Appender::Syslog -- AppenderSyslogTest log message/, message
+      end
+
+      # Should be able to log each level.
+      SemanticLogger::LEVELS.each do |level|
+        it "log #{level} information" do
+          Syslog.stub(:open, nil) do
+            Syslog.stub(:log, nil) do
+              syslog_appender = SemanticLogger::Appender::Syslog.new
+              syslog_appender.send(level, 'AppenderSyslogTest #{level.to_s} message')
+            end
+          end
+        end
+      end
+
+      it 'allow logging with %' do
+        message         = 'AppenderSyslogTest %test'
+        syslog_appender = SemanticLogger::Appender::Syslog.new
+        syslog_appender.debug(message)
+      end
+
+    end
+  end
+end

data/test/{appender_wrapper_test.rb → appender/wrapper_test.rb}

@@ -1,8 +1,9 @@
-require_relative 'test_helper'
+require_relative '../test_helper'
 
 # Unit Test for SemanticLogger::Appender::Wrapper
 #
-class AppenderWrapperTest < Minitest::Test
+module Appender
+class WrapperTest < Minitest::Test
   describe SemanticLogger::Appender::Wrapper do
     before do
       @time        = Time.new
@@ -12,8 +13,8 @@ class AppenderWrapperTest < Minitest::Test
       @hash_str    = @hash.inspect.sub("{", "\\{").sub("}", "\\}")
     end
 
-    describe "format logs into text form" do
-      it "handle nil name, message and payload" do
+    describe 'format logs into text form' do
+      it 'handle nil name, message and payload' do
         log       = SemanticLogger::Logger::Log.new
         log.time  = Time.now
         log.level = :debug
@@ -21,7 +22,7 @@ class AppenderWrapperTest < Minitest::Test
         assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ D \[\d+:\]  -- /, @mock_logger.message
       end
 
-      it "handle nil message and payload" do
+      it 'handle nil message and payload' do
         log       = SemanticLogger::Logger::Log.new
         log.time  = Time.now
         log.level = :debug
@@ -30,7 +31,7 @@ class AppenderWrapperTest < Minitest::Test
         assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ D \[\d+:\] class -- /, @mock_logger.message
       end
 
-      it "handle nil payload" do
+      it 'handle nil payload' do
         log         = SemanticLogger::Logger::Log.new
         log.time    = Time.now
         log.level   = :debug
@@ -40,7 +41,7 @@ class AppenderWrapperTest < Minitest::Test
         assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ D \[\d+:\] class -- hello world/, @mock_logger.message
       end
 
-      it "handle payload" do
+      it 'handle payload' do
         log         = SemanticLogger::Logger::Log.new
         log.time    = Time.now
         log.level   = :debug
@@ -52,7 +53,7 @@ class AppenderWrapperTest < Minitest::Test
       end
     end
 
-    describe "for each log level" do
+    describe 'for each log level' do
       # Ensure that any log level can be logged
       Logger::Severity.constants.each do |level|
         it "log #{level.downcase.to_sym} info" do
@@ -64,3 +65,4 @@ class AppenderWrapperTest < Minitest::Test
 
   end
 end
+end

data/test/loggable_test.rb

@@ -14,28 +14,38 @@ class AppenderFileTest < Minitest::Test
       @io                          = StringIO.new
       @appender                    = SemanticLogger::Appender::File.new(@io)
       SemanticLogger.default_level = :trace
-      SemanticLogger.add_appender(@appender)
-      @hash        = {session_id: 'HSSKLEU@JDK767', tracking_number: 12345}
-      @hash_str    = @hash.inspect.sub("{", "\\{").sub("}", "\\}")
-      @thread_name = Thread.current.name
+      @mock_logger                 = MockLogger.new
+      @appender                    = SemanticLogger.add_appender(@mock_logger)
+      @hash                        = {session_id: 'HSSKLEU@JDK767', tracking_number: 12345}
+      @hash_str                    = @hash.inspect.sub("{", "\\{").sub("}", "\\}")
+      @thread_name                 = Thread.current.name
     end
 
     after do
       SemanticLogger.remove_appender(@appender)
     end
 
-    describe "for each log level" do
+    describe 'for each log level' do
       # Ensure that any log level can be logged
       SemanticLogger::LEVELS.each do |level|
         it "log #{level} information with class attribute" do
-          TestAttribute.logger.send(level, "hello #{level}", @hash)
-          SemanticLogger.flush
-          assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ \w \[\d+:#{@thread_name}\] TestAttribute -- hello #{level} -- #{@hash_str}\n/, @io.string
+          SemanticLogger.stub(:backtrace_level_index, 0) do
+            SemanticLogger.stub(:appenders, [@appender]) do
+              TestAttribute.logger.send(level, "hello #{level}", @hash)
+              SemanticLogger.flush
+              assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ \w \[\d+:#{@thread_name} loggable_test.rb:\d+\] TestAttribute -- hello #{level} -- #{@hash_str}/, @mock_logger.message
+            end
+          end
         end
+
         it "log #{level} information with instance attribute" do
-          TestAttribute.new.logger.send(level, "hello #{level}", @hash)
-          SemanticLogger.flush
-          assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ \w \[\d+:#{@thread_name}\] TestAttribute -- hello #{level} -- #{@hash_str}\n/, @io.string
+          SemanticLogger.stub(:backtrace_level_index, 0) do
+            SemanticLogger.stub(:appenders, [@appender]) do
+              TestAttribute.new.logger.send(level, "hello #{level}", @hash)
+              SemanticLogger.flush
+              assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ \w \[\d+:#{@thread_name} loggable_test.rb:\d+\] TestAttribute -- hello #{level} -- #{@hash_str}/, @mock_logger.message
+            end
+          end
         end
       end
     end