fluent-plugin-scalyr 0.8.10 → 0.8.11

data/lib/fluent/plugin/{scalyr-exceptions.rb → scalyr_exceptions.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Scalyr Output Plugin for Fluentd
 #
@@ -15,8 +17,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-
-
 module Scalyr
   class ClientError < StandardError; end
   class Client4xxError < StandardError; end

data/test/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Scalyr Output Plugin for Fluentd
 #
@@ -15,9 +17,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "fluent/test"
+require "fluent/test/helpers"
+require "fluent/test/log"
+require "fluent/test/driver/output"
+require "fluent/plugin/out_scalyr"
 
-require 'fluent/test'
-require 'fluent/plugin/out_scalyr'
+include Fluent::Test::Helpers # rubocop:disable Style/MixinUsage
 
 module Scalyr
   class ScalyrOutTest < Test::Unit::TestCase
@@ -25,13 +31,13 @@ module Scalyr
       Fluent::Test.setup
     end
 
-    CONFIG = %[
+    CONFIG = %(
       api_write_token test_token
       ssl_ca_bundle_path /etc/ssl/certs/ca-certificates.crt
-    ]
+    )
 
-    def create_driver( conf = CONFIG )
-      Fluent::Test::BufferedOutputTestDriver.new( Scalyr::ScalyrOut ).configure( conf )
+    def create_driver(conf=CONFIG)
+      Fluent::Test::Driver::Output.new(Scalyr::ScalyrOut).configure(conf)
     end
   end
 end

data/test/test_config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Scalyr Output Plugin for Fluentd
 #
@@ -15,58 +17,45 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "helper"
+require "socket"
 
-require 'helper'
-require 'socket'
-
-class ConfigTest  < Scalyr::ScalyrOutTest
-
-  def test_default_params
-    d = create_driver
-    hostname = Socket.gethostname
-    assert_not_nil( d.instance.server_attributes, "Default server_attributes should not be nil" )
-    assert_equal( hostname, d.instance.server_attributes['serverHost'], "Default serverHost is not hostname" )
-    assert( d.instance.ssl_verify_peer, "Default ssl_verify_peer should be true" )
-
-    #check default buffer limits because they are set outside of the config_set_default
-    assert_equal( 100*1024, d.instance.buffer.buffer_chunk_limit, "Buffer chunk limit should be 100k" )
-    assert_equal( 1024, d.instance.buffer.buffer_queue_limit, "Buffer queue limit should be 1024" )
-  end
-
+# rubocop:disable Layout/LineLength
+class ConfigTest < Scalyr::ScalyrOutTest
   def test_custom_serverhost_not_overwritten
     hostname = "customHost"
     d = create_driver CONFIG + "server_attributes { \"serverHost\":\"#{hostname}\" }\nuse_hostname_for_serverhost true"
-    assert_equal( hostname, d.instance.server_attributes['serverHost'], "Custom serverHost should not be overwritten" )
+    assert_equal(hostname, d.instance.server_attributes["serverHost"], "Custom serverHost should not be overwritten")
   end
 
   def test_configure_use_hostname_for_serverhost
-    d = create_driver CONFIG + 'use_hostname_for_serverhost false'
-    assert_nil( d.instance.server_attributes, "Default server_attributes should be nil" )
+    d = create_driver CONFIG + "use_hostname_for_serverhost false"
+    assert_nil(d.instance.server_attributes, "Default server_attributes should be nil")
   end
 
   def test_configure_ssl_verify_peer
-    d = create_driver CONFIG + 'ssl_verify_peer false'
-    assert( !d.instance.ssl_verify_peer, "Config failed to set ssl_verify_peer" )
+    d = create_driver CONFIG + "ssl_verify_peer false"
+    assert(!d.instance.ssl_verify_peer, "Config failed to set ssl_verify_peer")
   end
 
   def test_scalyr_server_adding_trailing_slash
-    d = create_driver CONFIG + 'scalyr_server http://www.example.com'
-    assert_equal( "http://www.example.com/", d.instance.scalyr_server, "Missing trailing slash for scalyr_server" )
+    d = create_driver CONFIG + "scalyr_server http://www.example.com"
+    assert_equal("http://www.example.com/", d.instance.scalyr_server, "Missing trailing slash for scalyr_server")
   end
 
   def test_configure_ssl_ca_bundle_path
-    d = create_driver CONFIG + 'ssl_ca_bundle_path /test/ca-bundle.crt'
-    assert_equal( "/test/ca-bundle.crt", d.instance.ssl_ca_bundle_path, "Config failed to set ssl_ca_bundle_path" )
+    d = create_driver CONFIG + "ssl_ca_bundle_path /test/ca-bundle.crt"
+    assert_equal("/test/ca-bundle.crt", d.instance.ssl_ca_bundle_path, "Config failed to set ssl_ca_bundle_path")
   end
 
   def test_configure_ssl_verify_depth
-    d = create_driver CONFIG + 'ssl_verify_depth 10'
-    assert_equal( 10, d.instance.ssl_verify_depth, "Config failed to set ssl_verify_depth" )
+    d = create_driver CONFIG + "ssl_verify_depth 10"
+    assert_equal(10, d.instance.ssl_verify_depth, "Config failed to set ssl_verify_depth")
   end
 
   def test_configure_server_attributes
     d = create_driver CONFIG + 'server_attributes { "test":"value" }'
-    assert_equal( "value", d.instance.server_attributes["test"], "Config failed to set server_attributes" )
+    assert_equal("value", d.instance.server_attributes["test"], "Config failed to set server_attributes")
   end
 end
-
+# rubocop:enable Layout/LineLength

data/test/test_events.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Scalyr Output Plugin for Fluentd
 #
@@ -15,234 +17,234 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-
-require 'helper'
-require 'fluent/event'
+require "helper"
+require "flexmock/test_unit"
+require "fluent/event"
 
 class EventsTest < Scalyr::ScalyrOutTest
-
   def test_format
     d = create_driver
-    response = flexmock( Net::HTTPResponse, :code => '200', :body =>'{ "status":"success" }'  )
-    mock = flexmock( d.instance )
-    mock.should_receive( :post_request ).with_any_args.and_return( response )
-
-    time = Time.parse("2015-04-01 10:00:00 UTC").to_i
-    d.emit( { "a" => 1 }, time )
-    d.expect_format [ "test", time, { "a" => 1 } ].to_msgpack
-    d.run
+
+    time = event_time("2015-04-01 10:00:00 UTC")
+
+    response = flexmock(Net::HTTPResponse, code: "200", body: '{ "status":"success" }')
+    mock = flexmock(d.instance)
+    mock.should_receive(:post_request).with_any_args.and_return(response)
+
+    d.run(default_tag: "test") do
+      d.feed(time, {"a" => 1})
+    end
+
+    expected = [
+      ["test", time.sec, time.nsec, {"a" => 1}].to_msgpack
+    ]
+
+    assert_equal(expected, d.formatted)
   end
 
   def test_build_add_events_body_basic_values
     d = create_driver
-    response = flexmock( Net::HTTPResponse, :code => '200', :body =>'{ "status":"success" }'  )
-    mock = flexmock( d.instance )
 
-    time = Time.parse("2015-04-01 10:00:00 UTC").to_i
-    attrs = { "a" => 1 }
-    d.emit( attrs, time )
+    time = event_time("2015-04-01 10:00:00 UTC")
+    attrs = {"a" => 1}
+    attrs["logfile"] = "/fluentd/test"
 
-    attrs["logfile"] = "/fluentd/test";
+    response = flexmock(Net::HTTPResponse, code: "200", body: '{ "status":"success" }')
+    mock = flexmock(d.instance)
 
-    mock.should_receive( :post_request ).with( 
+    mock_called = false
+
+    mock.should_receive(:post_request).with(
       URI,
-      on { |request_body|
-        body = JSON.parse( request_body )
-        assert( body.key?( "token" ), "Missing token field"  )
-        assert( body.key?( "client_timestamp" ), "Missing client_timestamp field" )
-        assert( body.key?( "session" ), "Missing session field" )
-        assert( !body.key?( "sessionInfo"), "sessionInfo field set, but no sessionInfo" )
-        assert( body.key?( "events" ), "missing events field" )
-        assert( body.key?( "threads" ), "missing threads field" )
-        assert_equal( 1, body['events'].length, "Only expecting 1 event" )
-        assert_equal( d.instance.to_nanos( time ), body['events'][0]['ts'].to_i, "Event timestamp differs" )
-        assert_equal( attrs, body['events'][0]['attrs'], "Value of attrs differs from log" )
-        true
+      on {|request_body|
+        body = JSON.parse(request_body)
+        assert(body.key?("token"), "Missing token field")
+        assert(body.key?("client_timestamp"), "Missing client_timestamp field")
+        assert(body.key?("sessionInfo"), "sessionInfo field set, but no sessionInfo")
+        assert(body.key?("events"), "missing events field")
+        assert(body.key?("threads"), "missing threads field")
+        assert_equal(1, body["events"].length, "Only expecting 1 event")
+        assert_equal(time.sec * 1_000_000_000, body["events"][0]["ts"].to_i,
+                     "Event timestamp differs")
+        assert_equal(attrs, body["events"][0]["attrs"], "Value of attrs differs from log")
+        mock_called = true
       }
-      ).and_return( response )
+    ).once.and_return(response)
 
-    d.run
+    d.run(default_tag: "test") do
+      d.feed(time, attrs)
+    end
+
+    assert_equal(mock_called, true, "mock method was never called!")
   end
 
   def test_build_add_events_body_dont_override_logfile_field
     d = create_driver
-    response = flexmock( Net::HTTPResponse, :code => '200', :body =>'{ "status":"success" }'  )
-    mock = flexmock( d.instance )
 
-    time = Time.parse("2015-04-01 10:00:00 UTC").to_i
-    attrs = { "a" => 1 }
-    attrs["logfile"] = "/some/log/file";
-    d.emit( attrs, time )
+    time = event_time("2015-04-01 10:00:00 UTC")
+    attrs = {"a" => 1}
+    attrs["logfile"] = "/some/log/file"
+
+    response = flexmock(Net::HTTPResponse, code: "200", body: '{ "status":"success" }')
+    mock = flexmock(d.instance)
+
+    mock_called = false
 
-    mock.should_receive( :post_request ).with(
+    mock.should_receive(:post_request).with(
       URI,
-      on { |request_body|
-        body = JSON.parse( request_body )
-        assert_equal( attrs, body['events'][0]['attrs'], "Value of attrs differs from log" )
+      on {|request_body|
+        body = JSON.parse(request_body)
+        assert_equal(attrs, body["events"][0]["attrs"], "Value of attrs differs from log")
+        mock_called = true
         true
       }
-      ).and_return( response )
+    ).once.and_return(response)
 
-    d.run
+    d.run(default_tag: "test") do
+      d.feed(time, attrs)
+    end
+
+    assert_equal(mock_called, true, "mock method was never called!")
   end
 
   def test_build_add_events_body_with_server_attributes
     d = create_driver CONFIG + 'server_attributes { "test":"value" }'
 
-    response = flexmock( Net::HTTPResponse, :code => '200', :body =>'{ "status":"success" }'  )
-    mock = flexmock( d.instance )
-
-    time = Time.parse("2015-04-01 10:00:00 UTC").to_i
-    attrs = { "a" => 1 }
-    d.emit( attrs, time )
-
-    mock.should_receive( :post_request ).with( 
-      URI,
-      on { |request_body|
-        body = JSON.parse( request_body )
-        assert( body.key?( "sessionInfo"), "sessionInfo field set, but no sessionInfo" )
-        assert_equal( "value", body["sessionInfo"]["test"] )
-        true
-      }
-      ).and_return( response )
-
-    d.run
-  end
-
-  def test_build_add_events_body_incrementing_timestamps
-    d = create_driver
-    response = flexmock( Net::HTTPResponse, :code => '200', :body =>'{ "status":"success" }'  )
-    mock = flexmock( d.instance )
+    time = event_time("2015-04-01 10:00:00 UTC")
+    attrs = {"a" => 1}
 
-    time = Time.parse("2015-04-01 10:00:00 UTC").to_i
-    d.emit( { "a" => 1 }, time )
-    d.emit( { "a" => 2 }, time )
+    response = flexmock(Net::HTTPResponse, code: "200", body: '{ "status":"success" }')
+    mock = flexmock(d.instance)
 
-    time = Time.parse("2015-04-01 09:59:00 UTC").to_i
-    d.emit( { "a" => 3 }, time )
+    mock_called = false
 
-    mock.should_receive( :post_request ).with( 
+    mock.should_receive(:post_request).with(
       URI,
-      on { |request_body|
-        body = JSON.parse( request_body )
-        events = body['events']
-        assert_equal( 3, events.length, "Expecting 3 events" )
-        #test equal timestamps are increased
-        assert events[1]['ts'].to_i > events[0]['ts'].to_i, "Event timestamps must increase"
-
-        #test earlier timestamps are increased
-        assert events[2]['ts'].to_i > events[1]['ts'].to_i, "Event timestamps must increase"
-
+      on {|request_body|
+        body = JSON.parse(request_body)
+        assert(body.key?("sessionInfo"), "sessionInfo field set, but no sessionInfo")
+        assert_equal("value", body["sessionInfo"]["test"])
+        mock_called = true
         true
       }
-      ).and_return( response )
+    ).once.and_return(response)
+
+    d.run(default_tag: "test") do
+      d.feed(time, attrs)
+    end
 
-    d.run
+    assert_equal(mock_called, true, "mock method was never called!")
   end
 
-  def test_build_add_events_body_thread_ids
+  def test_build_add_events_body_incrementing_timestamps
     d = create_driver
-    response = flexmock( Net::HTTPResponse, :code => '200', :body =>'{ "status":"success" }'  )
-    mock = flexmock( d.instance )
-
-    entries = []
 
-    time = Time.parse("2015-04-01 10:00:00 UTC").to_i
-    entries << [time, { "a" => 1 }]
+    time1 = event_time("2015-04-01 10:00:00 UTC")
+    time2 = event_time("2015-04-01 09:59:00 UTC")
 
-    es = Fluent::ArrayEventStream.new(entries)
-    buffer = d.instance.format_stream("test1", es)
+    response = flexmock(Net::HTTPResponse, code: "200", body: '{ "status":"success" }')
+    mock = flexmock(d.instance)
 
-    chunk = d.instance.buffer.new_chunk('')
-    chunk << buffer
+    mock_called = false
 
-    buffer = d.instance.format_stream("test2", es)
-    chunk << buffer
-
-    mock.should_receive( :post_request ).with( 
+    mock.should_receive(:post_request).with(
       URI,
-      on { |request_body|
-        body = JSON.parse( request_body )
-        events = body['events']
-        threads = body['threads']
-
-        assert_equal( 2, threads.length, "Expecting 2 threads, #{threads.length} found" )
-        assert_equal( 2, events.length, "Expecting 2 events, #{events.length} found" )
-        assert_equal( events[0]['thread'], threads[0]['id'].to_s, "thread id should match event thread id" )
-        assert_equal( events[1]['thread'], threads[1]['id'].to_s, "thread id should match event thread id" )
+      on {|request_body|
+        body = JSON.parse(request_body)
+        events = body["events"]
+        assert_equal(3, events.length, "Expecting 3 events")
+        # Since 0.8.10 timestamps dont need to increase anymore
+        assert events[1]["ts"].to_i == events[0]["ts"].to_i, "Event timestamps must be the same"
+        assert events[2]["ts"].to_i < events[0]["ts"].to_i, "Event timestamps must be less"
+        mock_called = true
         true
       }
-      ).at_least.once.and_return( response )
+    ).once.and_return(response)
+
+    d.run(default_tag: "test") do
+      d.feed(time1, {"a" => 1})
+      d.feed(time1, {"a" => 2})
+      d.feed(time2, {"a" => 3})
+    end
 
-    d.instance.start
-    d.instance.write( chunk )
-    d.instance.shutdown
+    assert_equal(mock_called, true, "mock method was never called!")
   end
 
   def test_default_message_field
     d = create_driver CONFIG
 
-    response = flexmock( Net::HTTPResponse, :code => '200', :body =>'{ "status":"success" }'  )
-    mock = flexmock( d.instance )
+    time = event_time("2015-04-01 10:00:00 UTC")
+    attrs = {"log" => "this is a test", "logfile" => "/fluentd/test"}
+
+    response = flexmock(Net::HTTPResponse, code: "200", body: '{ "status":"success" }')
+    mock = flexmock(d.instance)
 
-    time = Time.parse("2015-04-01 10:00:00 UTC").to_i
-    attrs = { "log" => "this is a test", "logfile" => "/fluentd/test" }
-    d.emit( attrs, time )
+    mock_called = false
 
-    mock.should_receive( :post_request ).with(
+    mock.should_receive(:post_request).with(
       URI,
-      on { |request_body|
-        body = JSON.parse( request_body )
-        events = body['events']
-        assert_equal( attrs, body['events'][0]['attrs'], "Value of attrs differs from log" )
+      on {|request_body|
+        body = JSON.parse(request_body)
+        assert_equal(attrs, body["events"][0]["attrs"], "Value of attrs differs from log")
+        mock_called = true
         true
       }
-      ).and_return( response )
+    ).once.and_return(response)
 
-    d.run
+    d.run(default_tag: "test") do
+      d.feed(time, attrs)
+    end
+
+    assert_equal(mock_called, true, "mock method was never called!")
   end
 
   def test_different_message_field
-    d = create_driver CONFIG + 'message_field log'
+    d = create_driver CONFIG + "message_field log"
+
+    time = event_time("2015-04-01 10:00:00 UTC")
+    attrs = {"log" => "this is a test"}
 
-    response = flexmock( Net::HTTPResponse, :code => '200', :body =>'{ "status":"success" }'  )
-    mock = flexmock( d.instance )
+    response = flexmock(Net::HTTPResponse, code: "200", body: '{ "status":"success" }')
+    mock = flexmock(d.instance)
 
-    time = Time.parse("2015-04-01 10:00:00 UTC").to_i
-    attrs = { "log" => "this is a test" }
-    d.emit( attrs, time )
+    mock_called = false
 
-    mock.should_receive( :post_request ).with(
+    mock.should_receive(:post_request).with(
       URI,
-      on { |request_body|
-        body = JSON.parse( request_body )
-        events = body['events']
-        assert( events[0]['attrs'].key?( 'message'), "'message' field not found in event" )
-        assert_equal( "this is a test", events[0]['attrs']['message'], "'message' field incorrect" )
-        assert( !events[0]['attrs'].key?( 'log' ), "'log' field should no longer exist in event" )
+      on {|request_body|
+        body = JSON.parse(request_body)
+        events = body["events"]
+        assert(events[0]["attrs"].key?("message"), "'message' field not found in event")
+        assert_equal("this is a test", events[0]["attrs"]["message"], "'message' field incorrect")
+        assert(!events[0]["attrs"].key?("log"), "'log' field should no longer exist in event")
+        mock_called = true
         true
       }
-      ).and_return( response )
+    ).once.and_return(response)
 
-    d.run
+    d.run(default_tag: "test") do
+      d.feed(time, attrs)
+    end
+
+    assert_equal(mock_called, true, "mock method was never called!")
   end
 
   def test_different_message_field_message_already_exists
-    d = create_driver CONFIG + 'message_field log'
+    d = create_driver CONFIG + "message_field log"
 
-    response = flexmock( Net::HTTPResponse, :code => '200', :body =>'{ "status":"success" }'  )
-    mock = flexmock( d.instance )
-    mock.should_receive( :post_request ).and_return( response )
+    time = event_time("2015-04-01 10:00:00 UTC")
+    attrs = {"log" => "this is a test", "message" => "uh oh"}
 
-    time = Time.parse("2015-04-01 10:00:00 UTC").to_i
-    attrs = { "log" => "this is a test", "message" => "uh oh" }
-    d.emit( attrs, time )
+    response = flexmock(Net::HTTPResponse, code: "200", body: '{ "status":"success" }')
+    mock = flexmock(d.instance)
 
-    logger = flexmock( $log )
-    logger.should_receive( :warn ).with( /overwriting log record field 'message'/i ).at_least().once()
+    mock.should_receive(:post_request).once.and_return(response)
 
-    d.run
-  end
+    logger = flexmock($log)
+    logger.should_receive(:warn).with(/overwriting log record field 'message'/i).at_least.once
 
+    d.run(default_tag: "test") do
+      d.feed(time, attrs)
+    end
+  end
 end
-