fluent-plugin-google-cloud 0.6.19 → 0.6.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6d301ee1e5098270379065a452a62e1764d322e
-  data.tar.gz: 973c4d138bd5ac58f44c21a49afc3146949446d4
+  metadata.gz: 38cbf8464d2ca792e5d134d1edd66a2a4f6654ca
+  data.tar.gz: 2d15be19df0ca83a865c0cea38a4199f6ef42b7e
 SHA512:
-  metadata.gz: 2d5120e4508b5d218241cdca371b878e64d2d8da6c1a97bc712f845363886e2a8cd96807bc2098ab55232bcf2c7f97b103766ae446b71adea874aa713af5e7db
-  data.tar.gz: b4a3e052be29fe201d6c7ca3a10893ad53a292fe09ad309e20a04cc7af979d12548b483a3ca72d51734125bc27a35fdefa123d8d315ad210b7b011408597f9d9
+  metadata.gz: 04eaab1746f9d66c14cd402fb6f7960affbc2e36ac79ccecc84eb00c8af19e5793f7c591d94cfa1765f7a3f0d8e1807ecd24238a4209f99d29635a61a4793e68
+  data.tar.gz: 6a692ee7e882ce8b36e119432229b4fcc3f7aa855c59f1e806943885c465165a10d664b0a42baac1577277039d94ddb0d8f05a7fa035196a55b894d8ad606d1c

data/fluent-plugin-google-cloud.gemspec

@@ -10,7 +10,7 @@ eos
   gem.homepage      =
     'https://github.com/GoogleCloudPlatform/fluent-plugin-google-cloud'
   gem.license       = 'Apache-2.0'
-  gem.version       = '0.6.19'
+  gem.version       = '0.6.20'
   gem.authors       = ['Ling Huang', 'Igor Peshansky']
   gem.email         = ['stackdriver-agents@google.com']
   gem.required_ruby_version = Gem::Requirement.new('>= 2.2')

data/lib/fluent/plugin/out_google_cloud.rb

@@ -156,6 +156,7 @@ module Fluent
 
     # Internal constants.
     module InternalConstants
+      CREDENTIALS_PATH_ENV_VAR = 'GOOGLE_APPLICATION_CREDENTIALS'.freeze
       DEFAULT_LOGGING_API_URL = 'https://logging.googleapis.com'.freeze
 
       # The label name of local_resource_id in the json payload. When a record
@@ -226,7 +227,7 @@ module Fluent
     Fluent::Plugin.register_output('google_cloud', self)
 
     PLUGIN_NAME = 'Fluentd Google Cloud Logging plugin'.freeze
-    PLUGIN_VERSION = '0.6.19'.freeze
+    PLUGIN_VERSION = '0.6.20'.freeze
 
     # Name of the the Google cloud logging write scope.
     LOGGING_SCOPE = 'https://www.googleapis.com/auth/logging.write'.freeze
@@ -482,6 +483,12 @@ module Fluent
 
       @platform = detect_platform
 
+      # Treat an empty setting of the credentials file path environment variable
+      # as unset. This way the googleauth lib could fetch the credentials
+      # following the fallback path.
+      ENV.delete(CREDENTIALS_PATH_ENV_VAR) if
+        ENV[CREDENTIALS_PATH_ENV_VAR] == ''
+
       # Set required variables: @project_id, @vm_id, @vm_name and @zone.
       set_required_metadata_variables
 
@@ -804,11 +811,16 @@ module Fluent
 
       else
         # Assume it's a problem with the request itself and don't retry.
-        increment_failed_requests_count(error.code)
-        increment_dropped_entries_count(entries_count, error.code)
-        @log.error "Unknown response code #{error.code} from the server," \
+        error_code = if error.respond_to?(:code)
+                       error.code
+                     else
+                       GRPC::Core::StatusCodes::UNKNOWN
+                     end
+        increment_failed_requests_count(error_code)
+        increment_dropped_entries_count(entries_count, error_code)
+        @log.error "Unknown response code #{error_code} from the server," \
                    " dropping #{entries_count} log message(s)",
-                   error: error.to_s, error_code: error.code.to_s
+                   error: error.to_s, error_code: error_code.to_s
       end
 
     # Got an unexpected error (not Google::Gax::GaxError) from the
@@ -1451,6 +1463,7 @@ module Fluent
       end
     rescue StandardError => e
       @log.error "Error calling Metadata Agent at #{url}.", error: e
+      nil
     end
 
     # TODO: This functionality should eventually be available in another

data/test/plugin/base_test.rb

@@ -27,7 +27,7 @@ module BaseTest
   def setup
     Fluent::Test.setup
     # delete environment variables that googleauth uses to find credentials.
-    ENV.delete('GOOGLE_APPLICATION_CREDENTIALS')
+    ENV.delete(CREDENTIALS_PATH_ENV_VAR)
     # service account env.
     ENV.delete('PRIVATE_KEY_VAR')
     ENV.delete('CLIENT_EMAIL_VAR')
@@ -229,7 +229,7 @@ module BaseTest
       send("setup_#{platform}_metadata_stubs")
       [IAM_CREDENTIALS, NEW_STYLE_CREDENTIALS, LEGACY_CREDENTIALS].each \
       do |creds|
-        ENV['GOOGLE_APPLICATION_CREDENTIALS'] = creds[:path]
+        ENV[CREDENTIALS_PATH_ENV_VAR] = creds[:path]
         d = create_driver
         d.run
         assert_equal creds[:project_id], d.instance.project_id
@@ -249,7 +249,7 @@ module BaseTest
 
   def test_one_log_with_json_credentials
     setup_gce_metadata_stubs
-    ENV['GOOGLE_APPLICATION_CREDENTIALS'] = IAM_CREDENTIALS[:path]
+    ENV[CREDENTIALS_PATH_ENV_VAR] = IAM_CREDENTIALS[:path]
     setup_logging_stubs do
       d = create_driver
       d.emit('message' => log_entry(0))
@@ -263,7 +263,7 @@ module BaseTest
     %w(gce_metadata ec2_metadata no_metadata_service).each do |platform|
       send("setup_#{platform}_stubs")
       exception_count = 0
-      ENV['GOOGLE_APPLICATION_CREDENTIALS'] = INVALID_CREDENTIALS[:path]
+      ENV[CREDENTIALS_PATH_ENV_VAR] = INVALID_CREDENTIALS[:path]
       begin
         create_driver
       rescue RuntimeError => error
@@ -274,11 +274,21 @@ module BaseTest
     end
   end
 
+  def test_unset_or_empty_credentials_path_env_var
+    # An empty string should be treated as if it's not set.
+    [nil, ''].each do |value|
+      ENV[CREDENTIALS_PATH_ENV_VAR] = value
+      setup_gce_metadata_stubs
+      create_driver
+      assert_nil ENV[CREDENTIALS_PATH_ENV_VAR]
+    end
+  end
+
   def test_one_log_custom_metadata
     # don't set up any metadata stubs, so the test will fail if we try to
     # fetch metadata (and explicitly check this as well).
     Fluent::GoogleCloudOutput.any_instance.expects(:fetch_metadata).never
-    ENV['GOOGLE_APPLICATION_CREDENTIALS'] = IAM_CREDENTIALS[:path]
+    ENV[CREDENTIALS_PATH_ENV_VAR] = IAM_CREDENTIALS[:path]
     setup_logging_stubs do
       d = create_driver(NO_METADATA_SERVICE_CONFIG + CUSTOM_METADATA_CONFIG)
       d.emit('message' => log_entry(0))
@@ -288,7 +298,7 @@ module BaseTest
   end
 
   def test_one_log_ec2
-    ENV['GOOGLE_APPLICATION_CREDENTIALS'] = IAM_CREDENTIALS[:path]
+    ENV[CREDENTIALS_PATH_ENV_VAR] = IAM_CREDENTIALS[:path]
     setup_ec2_metadata_stubs
     setup_logging_stubs do
       d = create_driver(CONFIG_EC2_PROJECT_ID)
@@ -299,7 +309,7 @@ module BaseTest
   end
 
   def test_one_log_ec2_region
-    ENV['GOOGLE_APPLICATION_CREDENTIALS'] = IAM_CREDENTIALS[:path]
+    ENV[CREDENTIALS_PATH_ENV_VAR] = IAM_CREDENTIALS[:path]
     setup_ec2_metadata_stubs
     setup_logging_stubs do
       d = create_driver(CONFIG_EC2_PROJECT_ID_USE_REGION)

data/test/plugin/test_out_google_cloud_grpc.rb

@@ -40,7 +40,8 @@ class GoogleCloudOutputGRPCTest < Test::Unit::TestCase
       GRPC::Core::StatusCodes::ABORTED => 'Aborted',
       GRPC::Core::StatusCodes::UNAUTHENTICATED => 'Unauthenticated'
     }.each_with_index do |(code, message), index|
-      setup_logging_stubs(true, code, message) do
+      setup_logging_stubs(
+        GRPC::BadStatus.new_status_exception(code, message)) do
         d = create_driver(USE_GRPC_CONFIG, 'test')
         # The API Client should not retry this and the plugin should consume the
         # exception.
@@ -51,12 +52,24 @@ class GoogleCloudOutputGRPCTest < Test::Unit::TestCase
     end
   end
 
+  def test_invalid_error
+    setup_gce_metadata_stubs
+    setup_logging_stubs(RuntimeError.new('Some non-gRPC error')) do
+      d = create_driver(USE_GRPC_CONFIG, 'test')
+      # The API Client should not retry this and the plugin should consume the
+      # exception.
+      d.emit('message' => log_entry(0))
+      d.run
+    end
+    assert_equal 1, @failed_attempts.size
+  end
+
   def test_partial_success
     setup_gce_metadata_stubs
     setup_prometheus
     setup_logging_stubs(
-      true, GRPC::Core::StatusCodes::PERMISSION_DENIED,
-      'User not authorized.', PARTIAL_SUCCESS_GRPC_METADATA) do
+      GRPC::PermissionDenied.new('User not authorized.',
+                                 PARTIAL_SUCCESS_GRPC_METADATA)) do
       # The API Client should not retry this and the plugin should consume
       # the exception.
       d = create_driver(ENABLE_PROMETHEUS_CONFIG)
@@ -93,7 +106,8 @@ class GoogleCloudOutputGRPCTest < Test::Unit::TestCase
       GRPC::Core::StatusCodes::UNAVAILABLE => 'Unavailable'
     }.each_with_index do |(code, message), index|
       exception_count = 0
-      setup_logging_stubs(true, code, message) do
+      setup_logging_stubs(
+        GRPC::BadStatus.new_status_exception(code, message)) do
         d = create_driver(USE_GRPC_CONFIG, 'test')
         # The API client should retry this once, then throw an exception which
         # gets propagated through the plugin
@@ -130,7 +144,10 @@ class GoogleCloudOutputGRPCTest < Test::Unit::TestCase
     ].each do |should_fail, code, request_count, entry_count, metric_values|
       setup_prometheus
       (1..request_count).each do
-        setup_logging_stubs(should_fail, code, 'SomeMessage') do
+        setup_logging_stubs(
+          if should_fail
+            GRPC::BadStatus.new_status_exception(code, 'SomeMessage')
+          end) do
           d = create_driver(USE_GRPC_CONFIG + ENABLE_PROMETHEUS_CONFIG, 'test')
           (1..entry_count).each do |i|
             d.emit('message' => log_entry(i.to_s))
@@ -311,10 +328,8 @@ class GoogleCloudOutputGRPCTest < Test::Unit::TestCase
   # GRPC logging mock that fails and returns server side or client side errors.
   class GRPCLoggingMockFailingService <
       Google::Cloud::Logging::V2::LoggingServiceV2Client
-    def initialize(code, message, metadata, failed_attempts)
-      @code = code
-      @message = message
-      @metadata = metadata
+    def initialize(error, failed_attempts)
+      @error = error
       @failed_attempts = failed_attempts
       super()
     end
@@ -327,7 +342,7 @@ class GoogleCloudOutputGRPCTest < Test::Unit::TestCase
                           partial_success: nil)
       @failed_attempts << 1
       begin
-        raise GRPC::BadStatus.new_status_exception(@code, @message, @metadata)
+        raise @error
       rescue
         # Google::Gax::GaxError will wrap the latest thrown exception as @cause.
         raise Google::Gax::GaxError, @message
@@ -337,17 +352,13 @@ class GoogleCloudOutputGRPCTest < Test::Unit::TestCase
   end
 
   # Set up grpc stubs to mock the external calls.
-  def setup_logging_stubs(should_fail = false,
-                          code = nil,
-                          message = nil,
-                          metadata = {})
-    if should_fail
-      @failed_attempts = []
-      @grpc_stub = GRPCLoggingMockFailingService.new(
-        code, message, metadata, @failed_attempts)
-    else
+  def setup_logging_stubs(error = nil)
+    if error.nil?
       @requests_sent = []
       @grpc_stub = GRPCLoggingMockService.new(@requests_sent)
+    else
+      @failed_attempts = []
+      @grpc_stub = GRPCLoggingMockFailingService.new(error, @failed_attempts)
     end
     yield
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-google-cloud
 version: !ruby/object:Gem::Version
-  version: 0.6.19
+  version: 0.6.20
 platform: ruby
 authors:
 - Ling Huang
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-08 00:00:00.000000000 Z
+date: 2018-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd