fluent-plugin-scalyr 0.8.10 → 0.8.15

data/lib/fluent/plugin/scalyr_utils.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+#
+# Scalyr Output Plugin for Fluentd
+#
+# Copyright (C) 2020 Scalyr, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Scalyr
+  def sanitize_and_reencode_value(value)
+    # Method which recursively sanitizes the provided value and tries to re-encode all the strings as
+    # UTF-8 ignoring any bad unicode sequences
+    case value
+    when Hash
+      return sanitize_and_reencode_hash(value)
+    when Array
+      return sanitize_and_reencode_array(value)
+    when String
+      value = sanitize_and_reencode_string(value)
+      return value
+    end
+
+    # We only need to re-encode strings, for other value types (ints, nils,
+    # etc. no reencoding is needed)
+    value
+  end
+
+  def sanitize_and_reencode_array(array)
+    array.each_with_index do |value, index|
+      value = sanitize_and_reencode_value(value)
+      array[index] = value
+    end
+
+    array
+  end
+
+  def sanitize_and_reencode_hash(hash)
+    hash.each do |key, value|
+      hash[key] = sanitize_and_reencode_value(value)
+    end
+
+    hash
+  end
+
+  def sanitize_and_reencode_string(value)
+    # Function which sanitized the provided string value and tries to re-encode it as UTF-8
+    # ignoring any encoding error which could arise due to bad or partial unicode sequence
+    begin # rubocop:disable Style/RedundantBegin
+      value.encode("UTF-8", invalid: :replace, undef: :replace, replace: "<?>").force_encoding("UTF-8") # rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective
+    rescue # rubocop:disable Style/RescueStandardError
+      "failed-to-reencode-as-utf8"
+    end
+  end
+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,50 @@
 # 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
 
+  def test_configure_parser
+    d = create_driver CONFIG + "parser access_log"
+    assert_equal("access_log", d.instance.parser, "Config failed to set parser")
+  end
+end
+# rubocop:enable Layout/LineLength