semantic_logger 2.15.0 → 2.16.0

data/test/appender_file_test.rb

@@ -4,56 +4,56 @@ require 'stringio'
 # Unit Test for SemanticLogger::Appender::File
 #
 class AppenderFileTest < Minitest::Test
-  context SemanticLogger::Appender::File do
-    setup do
+  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
+      @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
 
-    context "format logs into text form" do
-      should "handle no message or payload" do
+    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
 
-      should "handle message" do
+      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
 
-      should "handle message and payload" do
+      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
 
-      should "handle message, payload, and exception" do
+      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
 
-      should "handle exception only" do
+      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
 
-    context "for each log level" do
+    describe "for each log level" do
       # Ensure that any log level can be logged
       SemanticLogger::LEVELS.each do |level|
-        should "log #{level} information" do
+        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
 
-    context "custom formatter" do
-      setup do
+    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)
 
@@ -67,11 +67,11 @@ class AppenderFileTest < Minitest::Test
         end
       end
 
-      should "format using formatter" do
+      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

@@ -3,27 +3,27 @@ require_relative 'test_helper'
 # Unit Test for SemanticLogger::Appender::MongoDB
 #
 class AppenderMongoDBTest < Minitest::Test
-  context SemanticLogger::Appender::MongoDB do
-    setup do
-      @db = Mongo::Connection.new['test']
-      @appender = SemanticLogger::Appender::MongoDB.new(
+  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'}
+      @hash               = {tracking_number: 12345, session_id: 'HSSKLEU@JDK767'}
       Thread.current.name = 'thread'
     end
 
-    teardown do
+    after do
       @appender.purge_all if @appender
     end
 
-    context "format logs into documents" do
+    describe "format logs into documents" do
 
-      should "handle nil name, message and hash" do
+      it "handle nil name, message and hash" do
         @appender.debug
         document = @appender.collection.find_one
         assert_equal :debug, document['level']
@@ -36,7 +36,7 @@ class AppenderMongoDBTest < Minitest::Test
         assert_equal 'test_application', document['application']
       end
 
-      should "handle nil message and payload" do
+      it "handle nil message and payload" do
         @appender.debug(@hash)
 
         document = @appender.collection.find_one
@@ -50,7 +50,7 @@ class AppenderMongoDBTest < Minitest::Test
         assert_equal 'test_application', document['application']
       end
 
-      should "handle message and payload" do
+      it "handle message and payload" do
         @appender.debug('hello world', @hash)
 
         document = @appender.collection.find_one
@@ -58,13 +58,13 @@ class AppenderMongoDBTest < Minitest::Test
         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({"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
 
-      should "handle message without payload" do
+      it "handle message without payload" do
         log = SemanticLogger::Base::Log.new(:debug)
         @appender.debug('hello world')
 
@@ -80,17 +80,17 @@ class AppenderMongoDBTest < Minitest::Test
       end
     end
 
-    context "for each log level" do
+    describe "for each log level" do
       # Ensure that any log level can be logged
       SemanticLogger::LEVELS.each do |level|
-        should "log #{level} information" do
+        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({"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']
@@ -100,4 +100,4 @@ class AppenderMongoDBTest < Minitest::Test
     end
 
   end
-end
+end

data/test/appender_new_relic_test.rb

@@ -5,11 +5,11 @@ require_relative 'test_helper'
 # Unit Test for SemanticLogger::Appender::NewRelic
 #
 class AppenderNewRelicTest < Minitest::Test
-  context SemanticLogger::Appender::NewRelic do
+  describe SemanticLogger::Appender::NewRelic do
 
-    setup do
-      @appender = SemanticLogger::Appender::NewRelic.new(:error)
-      @message  = 'AppenderNewRelicTest log message'
+    before do
+      @appender           = SemanticLogger::Appender::NewRelic.new(:error)
+      @message            = 'AppenderNewRelicTest log message'
       @multi_line_message = <<-EOSTR
 
 
@@ -22,7 +22,7 @@ class AppenderNewRelicTest < Minitest::Test
     end
 
     (SemanticLogger::LEVELS - [:error, :fatal]).each do |level|
-      should "not send :#{level.to_s} notifications to New Relic" do
+      it "not send :#{level.to_s} notifications to New Relic" do
         message = hash = nil
         NewRelic::Agent.stub(:notice_error, -> msg, h { message = msg; hash = h }) do
           @appender.tagged('test') do
@@ -35,7 +35,7 @@ class AppenderNewRelicTest < Minitest::Test
     end
 
     [:error, :fatal].each do |level|
-      should "send :#{level.to_s} notifications to New Relic" do
+      it "send :#{level.to_s} notifications to New Relic" do
         message = hash = nil
         NewRelic::Agent.stub(:notice_error, -> msg, h { message = msg; hash = h }) do
           @appender.tagged('test') do
@@ -50,11 +50,11 @@ class AppenderNewRelicTest < Minitest::Test
       end
     end
 
-    should 'send notification to New Relic with custom attributes' do
+    it 'send notification to New Relic with custom attributes' do
       message = hash = nil
       NewRelic::Agent.stub(:notice_error, -> msg, h { message = msg; hash = h }) do
         @appender.tagged('test') do
-          @appender.with_payload({:key1 => 1, :key2 => 'a'}) do
+          @appender.with_payload({key1: 1, key2: 'a'}) do
             @appender.benchmark(:error, @message) do
               sleep 0.001
             end
@@ -64,12 +64,12 @@ class AppenderNewRelicTest < Minitest::Test
       assert_equal @message, message
       assert_equal ['test'], hash[:custom_params][:tags], hash
       assert_equal "SemanticLogger::Appender::NewRelic/#{@message}", hash[:metric]
-      assert_equal({:key1 => 1, :key2 => 'a'}, hash[:custom_params][:payload], 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
 
-    should 'use the first non-blank line for a multi-line message' do
+    it 'use the first non-blank line for a multi-line message' do
       message = hash = nil
       NewRelic::Agent.stub(:notice_error, -> msg, h { message = msg; hash = h }) do
         @appender.tagged('test') do

data/test/appender_splunk_test.rb

@@ -3,11 +3,11 @@ require_relative 'test_helper'
 # Unit Test for SemanticLogger::Appender::Splunk
 #
 class AppenderSplunkTest < Minitest::Test
-  context SemanticLogger::Appender::Splunk do
+  describe SemanticLogger::Appender::Splunk do
 
-    context '#parse_options' do
-      context 'argument errors' do
-        should 'raise argument error for missing username' 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
@@ -15,39 +15,33 @@ class AppenderSplunkTest < Minitest::Test
           assert_equal 'Must supply a username.', error.message
         end
 
-        should 'raise argument error for missing password' do
+        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
-
-        should 'raise argument error for missing index' do
-          error = assert_raises ArgumentError do
-            SemanticLogger::Appender::Splunk.new(username: 'username', password: 'password')
-          end
-
-          assert_equal 'Must supply an index.', error.message
-        end
       end
 
-      context 'set default values' do
-        should 'have default values' do
+      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', index: 'index')
+              SemanticLogger::Appender::Splunk.new(username: 'username', password: 'password')
             end
           end
           config   = appender.config
           # Default host
           assert_equal 'localhost', config[:host]
-          # Default pot
+          # 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

@@ -4,9 +4,9 @@ require 'net/tcp_client'
 # Unit Test for SemanticLogger::Appender::Syslog
 #
 class AppenderSyslogTest < Minitest::Test
-  context SemanticLogger::Appender::Syslog do
+  describe SemanticLogger::Appender::Syslog do
 
-    should 'handle local syslog' do
+    it 'handle local syslog' do
       message = nil
       Syslog.stub(:open, nil) do
         Syslog.stub(:log, -> level, msg { message = msg }) do
@@ -17,7 +17,7 @@ class AppenderSyslogTest < Minitest::Test
       assert_match /D (.*?) SemanticLogger::Appender::Syslog -- AppenderSyslogTest log message/, message
     end
 
-    should 'handle remote syslog over TCP' do
+    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
@@ -30,8 +30,8 @@ class AppenderSyslogTest < Minitest::Test
       assert_match /<70>(.*?)SemanticLogger::Appender::Syslog -- AppenderSyslogTest log message\r\n/, message
     end
 
-    should 'handle remote syslog over UDP' do
-      message = nil
+    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'
@@ -41,7 +41,7 @@ class AppenderSyslogTest < Minitest::Test
 
     # Should be able to log each level.
     SemanticLogger::LEVELS.each do |level|
-      should "log #{level} information" do
+      it "log #{level} information" do
         Syslog.stub(:open, nil) do
           Syslog.stub(:log, nil) do
             syslog_appender = SemanticLogger::Appender::Syslog.new
@@ -51,8 +51,8 @@ class AppenderSyslogTest < Minitest::Test
       end
     end
 
-    should "allow logging with %" do
-      message = "AppenderSyslogTest %test"
+    it "allow logging with %" do
+      message         = "AppenderSyslogTest %test"
       syslog_appender = SemanticLogger::Appender::Syslog.new
       syslog_appender.debug(message)
     end

data/test/appender_wrapper_test.rb

@@ -3,48 +3,48 @@ require_relative 'test_helper'
 # Unit Test for SemanticLogger::Appender::Wrapper
 #
 class AppenderWrapperTest < Minitest::Test
-  context SemanticLogger::Appender::Wrapper do
-    setup do
-      @time = Time.new
+  describe SemanticLogger::Appender::Wrapper do
+    before do
+      @time        = Time.new
       @mock_logger = MockLogger.new
-      @appender = SemanticLogger::Appender::Wrapper.new(@mock_logger)
-      @hash = { :session_id => 'HSSKLEU@JDK767', :tracking_number => 12345 }
-      @hash_str = @hash.inspect.sub("{", "\\{").sub("}", "\\}")
+      @appender    = SemanticLogger::Appender::Wrapper.new(@mock_logger)
+      @hash        = {session_id: 'HSSKLEU@JDK767', tracking_number: 12345}
+      @hash_str    = @hash.inspect.sub("{", "\\{").sub("}", "\\}")
     end
 
-    context "format logs into text form" do
-      should "handle nil name, message and payload" do
-        log = SemanticLogger::Logger::Log.new
-        log.time = Time.now
+    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
         @appender.log(log)
         assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ D \[\d+:\]  -- /, @mock_logger.message
       end
 
-      should "handle nil message and payload" do
-        log = SemanticLogger::Logger::Log.new
-        log.time = Time.now
+      it "handle nil message and payload" do
+        log       = SemanticLogger::Logger::Log.new
+        log.time  = Time.now
         log.level = :debug
-        log.name = 'class'
+        log.name  = 'class'
         @appender.log(log)
         assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ D \[\d+:\] class -- /, @mock_logger.message
       end
 
-      should "handle nil payload" do
-        log = SemanticLogger::Logger::Log.new
-        log.time = Time.now
-        log.level = :debug
-        log.name = 'class'
+      it "handle nil payload" do
+        log         = SemanticLogger::Logger::Log.new
+        log.time    = Time.now
+        log.level   = :debug
+        log.name    = 'class'
         log.message = 'hello world'
         @appender.log(log)
         assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ D \[\d+:\] class -- hello world/, @mock_logger.message
       end
 
-      should "handle payload" do
-        log = SemanticLogger::Logger::Log.new
-        log.time = Time.now
-        log.level = :debug
-        log.name = 'class'
+      it "handle payload" do
+        log         = SemanticLogger::Logger::Log.new
+        log.time    = Time.now
+        log.level   = :debug
+        log.name    = 'class'
         log.message = 'hello world'
         log.payload = @hash
         @appender.log(log)
@@ -52,10 +52,10 @@ class AppenderWrapperTest < Minitest::Test
       end
     end
 
-    context "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|
-        should "log #{level.downcase.to_sym} info" do
+        it "log #{level.downcase.to_sym} info" do
           @appender.log SemanticLogger::Logger::Log.new(level.downcase.to_sym, 'thread', 'class', 'hello world', @hash, Time.now)
           assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ \w \[\d+:thread\] class -- hello world -- #{@hash_str}/, @mock_logger.message
         end
@@ -63,4 +63,4 @@ class AppenderWrapperTest < Minitest::Test
     end
 
   end
-end
+end