logstash-input-google_pubsub 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 939bc59bb6733b670afef19f24a3c651ed5fd984d180dbf89ceb206ee2c633ff
-  data.tar.gz: f982db5ce84342d6c633131f7cba49e54102ece37d9ec829e7075a3830b39e91
+  metadata.gz: 9b4696d6b9d4edf149cfe2e20e95f1e60fe325abfef7b270d75ffc5abfb35b6c
+  data.tar.gz: 2aea3006b94752de7e74d2e514ec47d4ce26849f950f80d359c59bbdaef6ad4b
 SHA512:
-  metadata.gz: 6c79cc1cadb234005cce5b9ed09782c18a030919c42ea8c3bf097e3d2b178f7395362548034f0092d477e8eb9c84ad9c3c54e02aa2e855ff731e1b3f298a589f
-  data.tar.gz: 5f7b2241d2ab581d56311129b9e7947e589d99264ee3769e07eb5ac53f040cd063bb47f831830fdfc794dcaf2c2bf94a31d8a2f3c27178fec08b4eb590479084
+  metadata.gz: 26183a428dc24b48bec30ab50181422b38805ebe9723527a9a9543a587f75b99318ac25f97d885d52f1528e148d492e868e7a79798941817ce6bb26ce4ca6368
+  data.tar.gz: a05ce16d125d82202bdd1fb10e4ff452ce519aebace71390dd5d534db343b62f6e06b2bb313e83d81b300f622efb6a9650e171fa2e48de9d658532913db4a0e5

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.4.0
+ - Added optional field json_key_file_content to get Service Account JSON key as an String input. [#68](https://github.com/logstash-plugins/logstash-input-google_pubsub/pull/68)
+
 ## 1.3.0
  - Updated plugins dependencies [#62](https://github.com/logstash-plugins/logstash-input-google_pubsub/pull/62)
 

data/README.md

@@ -49,7 +49,9 @@ You have two options for authentication depending on where you run Logstash.
 
 1. If you are running Logstash outside of Google Cloud Platform, then you will
 need to create a Google Cloud Platform Service Account and specify the full
-path to the JSON private key file in your config. You must assign sufficient
+path to the JSON private key file in your config in `json_key_file` setting.
+If you don't want to upload the file and use its content as a string, then add the content 
+of JSON private key in `json_key_file_content` setting. You must assign sufficient
 roles to the Service Account to create a subscription and to pull messages
 from the subscription. Learn more about GCP Service Accounts and IAM roles
 here:
@@ -58,7 +60,7 @@ here:
   - Creating Service Accounts [overview](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
   - Granting Roles [overview](https://cloud.google.com/iam/docs/granting-roles-to-service-accounts)
 
-1. If you are running Logstash on a Google Compute Engine instance, you may opt
+2. If you are running Logstash on a Google Compute Engine instance, you may opt
 to use Application Default Credentials. In this case, you will not need to
 specify a JSON private key file in your config.
 

data/docs/index.asciidoc

@@ -79,8 +79,9 @@ plugin will return the raw text in as `raw_message` in the logstash `event`.
 You have two options for authentication depending on where you run Logstash. 
 
 1. If you are running Logstash outside of Google Cloud Platform, then you will 
-need to create a Google Cloud Platform Service Account and specify the full 
-path to the JSON private key file in your config. You must assign sufficient 
+path to the JSON private key file in your config in `json_key_file` setting.
+If you don't want to upload the file and use its content as a string, then add the content 
+of JSON private key in `json_key_file_content` setting. You must assign sufficient
 roles to the Service Account to create a subscription and to pull messages 
 from the subscription. Learn more about GCP Service Accounts and IAM roles 
 here:

data/lib/logstash/inputs/google_pubsub.rb

@@ -200,10 +200,18 @@ class LogStash::Inputs::GooglePubSub < LogStash::Inputs::Base
   config :subscription, :validate => :string, :required => true
   config :max_messages, :validate => :number, :required => true, :default => 5
 
-  # If logstash is running within Google Compute Engine, the plugin will use
-  # GCE's Application Default Credentials. Outside of GCE, you will need to
-  # specify a Service Account JSON key file.
+  # If Logstash is running within Google Compute Engine (GCE), the plugin will use
+  # GCE's Application Default Credentials. When running outside of GCE, you must 
+  # provide a Service Account JSON key. This can be done in one of two ways:
+  #
+  # 1. Specify the file path to the JSON key file using the `json_key_file` option.
+  # 2. Provide the JSON key as a base64-encoded string using the `json_key_file_content` option.
+  #
+  # Both `json_key_file` and `json_key_file_content` are optional, but you must 
+  # specify one of them if Logstash is running outside of GCE. It is invalid to 
+  # provide both options simultaneously. 
   config :json_key_file, :validate => :path, :required => false
+  config :json_key_file_content, :validate => :string, :required => false
 
   # If set true, will include the full message data in the `[@metadata][pubsub_message]` field.
   config :include_metadata, :validate => :boolean, :required => false, :default => false
@@ -221,11 +229,20 @@ class LogStash::Inputs::GooglePubSub < LogStash::Inputs::Base
     @logger.debug("Registering Google PubSub Input: project_id=#{@project_id}, topic=#{@topic}, subscription=#{@subscription}")
     @subscription_id = "projects/#{@project_id}/subscriptions/#{@subscription}"
 
+    if json_key_file && json_key_file_content
+      raise LogStash::ConfigurationError, "Specify either 'json_key_file' or 'json_key_file_content', defining both simultanously is not permitted."
+    end
+
     if @json_key_file
       @credentialsProvider = FixedCredentialsProvider.create(
         ServiceAccountCredentials.fromStream(java.io.FileInputStream.new(@json_key_file))
       )
+    elsif @json_key_file_content
+      @credentialsProvider = FixedCredentialsProvider.create(
+        ServiceAccountCredentials.fromStream(java.io.ByteArrayInputStream.new((@json_key_file_content).to_java_bytes))
+      )
     end
+
     @topic_name = ProjectTopicName.of(@project_id, @topic)
     @subscription_name = ProjectSubscriptionName.of(@project_id, @subscription)
   end

data/lib/logstash-input-google_pubsub_jars.rb

@@ -51,4 +51,4 @@ require_jar('org.checkerframework', 'checker-qual', '3.33.0')
 require_jar('org.codehaus.mojo', 'animal-sniffer-annotations', '1.23')
 require_jar('org.conscrypt', 'conscrypt-openjdk-uber', '2.5.2')
 require_jar('org.threeten', 'threetenbp', '1.6.8')
-require_jar('org.logstash.inputs', 'plugin', '1.3.0')
+require_jar('org.logstash.inputs', 'plugin', '1.4.0')

data/spec/inputs/google_pubsub_spec.rb

@@ -34,4 +34,12 @@ describe LogStash::Inputs::GooglePubSub do
       plugin = LogStash::Inputs::GooglePubSub.new(bad3)
     }.to raise_error(LogStash::ConfigurationError)
   end
+
+  let(:file_and_content_config_settings) { { 'project_id' => 'myproj', 'subscription' => 'foo', 'topic' => 'bar', 'json_key_file' => 'spec/inputs/test.json', 'json_key_file_content' => '{}' } }
+  it "raise a configuration error if both 'json_key_file' and 'json_key_file_content' are present" do
+    expect { 
+      plugin = LogStash::Inputs::GooglePubSub.new(file_and_content_config_settings)
+      plugin.register()
+    }.to raise_error(LogStash::ConfigurationError)
+  end
 end

data/spec/inputs/test.json

@@ -0,0 +1,14 @@
+{
+    "type": "service_account",
+    "project_id": "test-project-id",
+    "private_key_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+    "private_key": "-----BEGIN PRIVATE KEY-----\nxxxxxxxxxxx\n-----END PRIVATE KEY-----\n",
+    "client_email": "test-username@test-project-id.iam.gserviceaccount.com",
+    "client_id": "111111111111111111111",
+    "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+    "token_uri": "https://oauth2.googleapis.com/token",
+    "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+    "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/apachesolrgcp-pubsub%40charged-mind-281913.iam.gserviceaccount.com",
+    "universe_domain": "googleapis.com"
+}
+  

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-google_pubsub
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Eric Johnson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-22 00:00:00.000000000 Z
+date: 2024-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -17,8 +17,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 8.2.0
   name: logstash-core
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -34,8 +34,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.99'
   name: logstash-core-plugin-api
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -51,8 +51,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: logstash-codec-plain
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -65,8 +65,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.0.22
   name: stud
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -79,8 +79,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: logstash-devutils
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -93,8 +93,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.4'
   name: jar-dependencies
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -120,6 +120,7 @@ files:
 - lib/logstash/inputs/google_pubsub.rb
 - logstash-input-google_pubsub.gemspec
 - spec/inputs/google_pubsub_spec.rb
+- spec/inputs/test.json
 - vendor/jar-dependencies/com/google/android/annotations/4.1.1.4/annotations-4.1.1.4.jar
 - vendor/jar-dependencies/com/google/api/api-common/2.15.0/api-common-2.15.0.jar
 - vendor/jar-dependencies/com/google/api/gax-grpc/2.32.0/gax-grpc-2.32.0.jar
@@ -169,7 +170,7 @@ files:
 - vendor/jar-dependencies/org/checkerframework/checker-qual/3.33.0/checker-qual-3.33.0.jar
 - vendor/jar-dependencies/org/codehaus/mojo/animal-sniffer-annotations/1.23/animal-sniffer-annotations-1.23.jar
 - vendor/jar-dependencies/org/conscrypt/conscrypt-openjdk-uber/2.5.2/conscrypt-openjdk-uber-2.5.2.jar
-- vendor/jar-dependencies/org/logstash/inputs/plugin/1.3.0/plugin-1.3.0.jar
+- vendor/jar-dependencies/org/logstash/inputs/plugin/1.4.0/plugin-1.4.0.jar
 - vendor/jar-dependencies/org/threeten/threetenbp/1.6.8/threetenbp-1.6.8.jar
 homepage: https://cloud.google.com/pubsub/overview
 licenses:
@@ -199,9 +200,10 @@ requirements:
 - jar 'com.google.guava:guava', '20.0'
 - jar 'com.google.api:api-common', '1.2.0'
 - jar 'com.google.auth:google-auth-library-oauth2-http', '0.9.0'
-rubygems_version: 3.2.33
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Consume events from a Google Cloud PubSub service
 test_files:
 - spec/inputs/google_pubsub_spec.rb
+- spec/inputs/test.json