fluent-plugin-gcloud-pubsub-custom 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51c4af6bf7aee07e04161734152a796864a9a21924eab0e2434e45d177b4be0d
-  data.tar.gz: cd0bb6ec1e0b769b0e7792c5c8d5a797a5407ffca3dbe66f37bd1010959194ce
+  metadata.gz: 374946914ce3cfc2d8118fc8f0b4f98d9b3b9a588f2a44b05f540cf39f79b416
+  data.tar.gz: b593cb71d7b4305d3bb230829a7a7653038dbd33f180ba0f1d1903429203dddf
 SHA512:
-  metadata.gz: 4f6f11c50da0f9396275e757a18cec552fdeeb8718e290a1388a2190bd26cb327704e6424848bf65a656e545f8cd6364ae571c285774cf82735a5512f0a57cd4
-  data.tar.gz: 62840bd5232d0f756c5ea09449f9821b2a55cee69d2fe0c048bfe764c4673fb389cde7b2b8c1b6d671a3f6def5d0d11587b080b15011fee1868079df7c35a4e8
+  metadata.gz: a926442360078e78350dae24fef50412bbd9fbca6bbfd5a0ede662c47c9e2b5eef815ad5da6b23e5ffe76014b22138f530768add2dbdb39d0dface069f1315f9
+  data.tar.gz: 7aa23e9902f6720b8e755031bcba63a49c69fb43d1f6600fb69d681197dbe8b25fcdbbaba48bac844ab331254c01307da5ea4c999f7cb13ca49ff65682e53ef7

data/.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: Test
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['2.4', '2.5', '2.6', '2.7']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake test

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## ChangeLog
 
+### Release 1.5.0 - 2021/01/26
+
+- Bump up google-cloud-pubsub to v2.3.x
+- Add `endpoint` parameter
+- Add gzip compression/decompression feature
+
 ### Release 1.4.0 - 2020/08/11
 
 - Bump up google-cloud-pubsub to v0.39.x

data/README.md

@@ -1,6 +1,6 @@
 # fluent-plugin-gcloud-pubsub-custom
 
-[![Build Status](https://travis-ci.org/mia-0032/fluent-plugin-gcloud-pubsub-custom.svg?branch=master)](https://travis-ci.org/mia-0032/fluent-plugin-gcloud-pubsub-custom)
+![Test](https://github.com/mia-0032/fluent-plugin-gcloud-pubsub-custom/workflows/Test/badge.svg)
 [![Gem Version](https://badge.fury.io/rb/fluent-plugin-gcloud-pubsub-custom.svg)](http://badge.fury.io/rb/fluent-plugin-gcloud-pubsub-custom)
 
 This plugin is forked from https://github.com/mdoi/fluent-plugin-gcloud-pubsub
@@ -60,6 +60,7 @@ Use `gcloud_pubsub` output plugin.
   max_messages 1000
   max_total_size 9800000
   max_message_size 4000000
+  endpoint <Endpoint URL>
   <buffer>
     @type memory
     flush_interval 1s
@@ -95,6 +96,10 @@ Use `gcloud_pubsub` output plugin.
   - Messages exceeding `max_message_size` are not published because Pub/Sub clients cannot receive it.
 - `attribute_keys` (optional, default: `[]`)
   - Publishing the set fields as attributes.
+- `endpoint`(optional)
+  - Set Pub/Sub service endpoint. For more information, see [Service Endpoints](https://cloud.google.com/pubsub/docs/reference/service_apis_overview#service_endpoints)
+- `compression` (optional, default: `nil`)
+  - If set to `gzip`, messages will be compressed with gzip.
 
 ### Pull messages
 
@@ -160,6 +165,8 @@ Use `gcloud_pubsub` input plugin.
   - Bind IP address for HTTP RPC.
 - `rpc_port` (optional, default: `24680`)
   - Port for HTTP RPC.
+- `decompression` (optional, default: `nil`)
+  - If set to `gzip`, messages will be decompressed with gzip.
 
 ## Contributing
 

data/Rakefile

@@ -7,6 +7,7 @@ Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
   test.test_files = FileList['test/plugin/test_*.rb']
   test.verbose = true
+  test.warning = false
 end
 
 task :default => [:build]

data/fluent-plugin-gcloud-pubsub-custom.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |gem|
   gem.license     = "MIT"
   gem.homepage    = "https://github.com/mia-0032/fluent-plugin-gcloud-pubsub-custom"
   gem.summary     = gem.description
-  gem.version     = "1.4.0"
+  gem.version     = "1.5.0"
   gem.authors     = ["Yoshihiro MIYAI"]
   gem.email       = "msparrow17@gmail.com"
   gem.files       = `git ls-files`.split("\n")
@@ -16,7 +16,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_runtime_dependency "fluentd", [">= 0.14.15", "< 2"]
-  gem.add_runtime_dependency "google-cloud-pubsub", "~> 0.39.0"
+  gem.add_runtime_dependency "google-cloud-pubsub", "~> 2.3.1"
 
   gem.add_development_dependency "bundler"
   gem.add_development_dependency "rake"

data/lib/fluent/plugin/gcloud_pubsub/client.rb

@@ -24,8 +24,8 @@ module Fluent
     end
 
     class Publisher
-      def initialize(project, key, autocreate_topic, dest_project)
-        @pubsub = Google::Cloud::Pubsub.new project_id: project, credentials: key
+      def initialize(project, key, autocreate_topic, dest_project, endpoint)
+        @pubsub = Google::Cloud::Pubsub.new project_id: project, credentials: key, endpoint: endpoint
         @autocreate_topic = autocreate_topic
         @dest_project = dest_project
         @topics = {}

data/lib/fluent/plugin/in_gcloud_pubsub.rb

@@ -1,6 +1,7 @@
 require 'json'
 require 'webrick'
 
+require 'fluent/plugin/compressable'
 require 'fluent/plugin/input'
 require 'fluent/plugin/parser'
 
@@ -8,6 +9,8 @@ require 'fluent/plugin/gcloud_pubsub/client'
 
 module Fluent::Plugin
   class GcloudPubSubInput < Input
+    include Fluent::Plugin::Compressable
+
     Fluent::Plugin.register_input('gcloud_pubsub', self)
 
     helpers :compat_parameters, :parser, :thread
@@ -48,6 +51,8 @@ module Fluent::Plugin
     config_param :rpc_bind,           :string,  default: '0.0.0.0'
     desc 'Port for HTTP RPC.'
     config_param :rpc_port,           :integer, default: 24680
+    desc 'Decompress messages'
+    config_param :decompression,      :string,  default: nil
 
     config_section :parse do
       config_set_default :@type, DEFAULT_PARSER_TYPE
@@ -114,6 +119,11 @@ module Fluent::Plugin
                      end
 
       @parser = parser_create
+      @decompress = if @decompression == 'gzip'
+                      method(:gzip_decompress)
+                    else
+                      method(:no_decompress)
+                    end
     end
 
     def start
@@ -168,6 +178,14 @@ module Fluent::Plugin
       record.delete(@tag_key) || @tag
     end
 
+    def gzip_decompress(message)
+      decompress message
+    end
+
+    def no_decompress(message)
+      message
+    end
+
     def start_rpc
       log.info "listening http rpc server on http://#{@rpc_bind}:#{@rpc_port}/"
       @rpc_srv = WEBrick::HTTPServer.new(
@@ -221,7 +239,7 @@ module Fluent::Plugin
       end
 
       messages.each do |m|
-        line = m.message.data.chomp
+        line = @decompress.call(m.message.data).chomp
         attributes = m.attributes
         @parser.parse(line) do |time, record|
           if time && record

data/lib/fluent/plugin/out_gcloud_pubsub.rb

@@ -1,9 +1,11 @@
+require 'fluent/plugin/compressable'
 require 'fluent/plugin/output'
 require 'fluent/plugin/gcloud_pubsub/client'
 require 'fluent/plugin_helper/inject'
 
 module Fluent::Plugin
   class GcloudPubSubOutput < Output
+    include Fluent::Plugin::Compressable
     include Fluent::PluginHelper::Inject
 
     Fluent::Plugin.register_output('gcloud_pubsub', self)
@@ -31,6 +33,10 @@ module Fluent::Plugin
     config_param :max_message_size,   :integer, :default => 4000000  # 4MB
     desc 'Publishing the set field as an attribute'
     config_param :attribute_keys,     :array,   :default => []
+    desc 'Set service endpoint'
+    config_param :endpoint, :string, :default => nil
+    desc 'Compress messages'
+    config_param :compression, :string, :default => nil
 
     config_section :buffer do
       config_set_default :@type, DEFAULT_BUFFER_TYPE
@@ -45,11 +51,16 @@ module Fluent::Plugin
       super
       placeholder_validate!(:topic, @topic)
       @formatter = formatter_create
+      @compress = if @compression == 'gzip'
+                    method(:gzip_compress)
+                  else
+                    method(:no_compress)
+                  end
     end
 
     def start
       super
-      @publisher = Fluent::GcloudPubSub::Publisher.new @project, @key, @autocreate_topic, @dest_project
+      @publisher = Fluent::GcloudPubSub::Publisher.new @project, @key, @autocreate_topic, @dest_project, @endpoint
     end
 
     def format(tag, time, record)
@@ -58,7 +69,7 @@ module Fluent::Plugin
       @attribute_keys.each do |key|
         attributes[key] = record.delete(key)
       end
-      [@formatter.format(tag, time, record), attributes].to_msgpack
+      [@compress.call(@formatter.format(tag, time, record)), attributes].to_msgpack
     end
 
     def formatted_to_msgpack_binary?
@@ -108,5 +119,13 @@ module Fluent::Plugin
       log.debug "send message topic:#{topic} length:#{messages.length} size:#{messages.map(&:bytesize).inject(:+)}"
       @publisher.publish(topic, messages)
     end
+
+    def gzip_compress(message)
+      compress message
+    end
+
+    def no_compress(message)
+      message
+    end
   end
 end

data/test/{test_helper.rb → helper.rb}

@@ -10,22 +10,14 @@ end
 require 'test/unit'
 require "test/unit/rr"
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.expand_path("../../", __FILE__))
 
-require 'fluent/test'
-unless ENV.has_key?('VERBOSE')
-  nulllogger = Object.new
-  nulllogger.instance_eval {|obj|
-    def method_missing(method, *args)
-      # pass
-    end
-  }
-  $log = nulllogger
-end
+require "fluent/test"
+require "fluent/test/driver/output"
+require "fluent/test/helpers"
 
 require 'fluent/plugin/in_gcloud_pubsub'
 require 'fluent/plugin/out_gcloud_pubsub'
 
-class Test::Unit::TestCase
-end
+Test::Unit::TestCase.include(Fluent::Test::Helpers)
+Test::Unit::TestCase.extend(Fluent::Test::Helpers)

data/test/plugin/test_in_gcloud_pubsub.rb

@@ -1,7 +1,8 @@
 require 'net/http'
 require 'json'
 
-require_relative "../test_helper"
+require_relative "../helper"
+require 'fluent/plugin/compressable'
 require "fluent/test/driver/input"
 
 class GcloudPubSubInputTest < Test::Unit::TestCase
@@ -164,6 +165,22 @@ class GcloudPubSubInputTest < Test::Unit::TestCase
       end
     end
 
+    class DummyMsgDataGzipped
+      include Fluent::Plugin::Compressable
+
+      def data
+        compress '{"foo": "bar"}'
+      end
+    end
+    class DummyMessageGzipped
+      def message
+        DummyMsgDataGzipped.new
+      end
+      def attributes
+        {"attr_1" => "a", "attr_2" => "b"}
+      end
+    end
+
     setup do
       @subscriber = mock!
       @topic_mock = mock!.subscription('subscription-test') { @subscriber }
@@ -263,6 +280,22 @@ class GcloudPubSubInputTest < Test::Unit::TestCase
       end
     end
 
+    test 'with gzip decompression' do
+      messages = Array.new(1, DummyMessageGzipped.new)
+      @subscriber.pull(immediate: true, max: 100).at_least(1) { messages }
+      @subscriber.acknowledge(messages).at_least(1)
+
+      d = create_driver("#{CONFIG}\ndecompression gzip")
+      d.run(expect_emits: 1, timeout: 3)
+      emits = d.events
+
+      assert_equal(1, emits.length)
+      emits.each do |tag, time, record|
+        assert_equal("test", tag)
+        assert_equal({"foo" => "bar"}, record)
+      end
+    end
+
     test 'invalid messages with parse_error_action warning' do
       messages = Array.new(1, DummyInvalidMessage.new)
       @subscriber.pull(immediate: true, max: 100).at_least(1) { messages }

data/test/plugin/test_out_gcloud_pubsub.rb

@@ -1,10 +1,12 @@
 # coding: utf-8
-require_relative "../test_helper"
+require_relative "../helper"
+require 'fluent/plugin/compressable'
 require "fluent/test/driver/output"
 require "fluent/test/helpers"
 
 class GcloudPubSubOutputTest < Test::Unit::TestCase
   include Fluent::Test::Helpers
+  include Fluent::Plugin::Compressable
 
   CONFIG = %[
     project project-test
@@ -80,6 +82,13 @@ class GcloudPubSubOutputTest < Test::Unit::TestCase
       @publisher = mock!
       @pubsub_mock = mock!
       stub(Google::Cloud::Pubsub).new { @pubsub_mock }
+
+      @old_report_on_exception = Thread.report_on_exception
+      Thread.report_on_exception = false
+    end
+
+    teardown do
+      Thread.report_on_exception = @old_report_on_exception
     end
 
     test '"autocreate_topic" is enabled' do
@@ -173,6 +182,13 @@ class GcloudPubSubOutputTest < Test::Unit::TestCase
       @publisher = mock!
       @pubsub_mock = mock!.topic(anything) { @publisher }
       stub(Google::Cloud::Pubsub).new { @pubsub_mock }
+
+      @old_report_on_exception = Thread.report_on_exception
+      Thread.report_on_exception = false
+    end
+
+    teardown do
+      Thread.report_on_exception = @old_report_on_exception
     end
 
     test 'messages are divided into "max_messages"' do
@@ -248,5 +264,22 @@ class GcloudPubSubOutputTest < Test::Unit::TestCase
       end
       assert_equal({"tag" => 'test', "foo" => "bar"}, JSON.parse(MessagePack.unpack(d.formatted.first)[0]))
     end
+
+    test 'with gzip compression' do
+      d = create_driver(%[
+        project project-test
+        topic topic-test
+        key key-test
+        compression gzip
+      ])
+      test_msg = {"a" => "abc"}
+
+      @publisher.publish.once
+      d.run(default_tag: "test") do
+        d.feed(test_msg)
+      end
+
+      assert_equal(test_msg, JSON.parse(decompress(MessagePack.unpack(d.formatted.first)[0])))
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-gcloud-pubsub-custom
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Yoshihiro MIYAI
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
+date: 2021-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.39.0
+        version: 2.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.39.0
+        version: 2.3.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -106,8 +106,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -117,9 +117,9 @@ files:
 - lib/fluent/plugin/gcloud_pubsub/client.rb
 - lib/fluent/plugin/in_gcloud_pubsub.rb
 - lib/fluent/plugin/out_gcloud_pubsub.rb
+- test/helper.rb
 - test/plugin/test_in_gcloud_pubsub.rb
 - test/plugin/test_out_gcloud_pubsub.rb
-- test/test_helper.rb
 homepage: https://github.com/mia-0032/fluent-plugin-gcloud-pubsub-custom
 licenses:
 - MIT
@@ -144,6 +144,6 @@ signing_key:
 specification_version: 4
 summary: Google Cloud Pub/Sub input/output plugin for Fluentd event collector
 test_files:
+- test/helper.rb
 - test/plugin/test_in_gcloud_pubsub.rb
 - test/plugin/test_out_gcloud_pubsub.rb
-- test/test_helper.rb

data/.travis.yml

@@ -1,24 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-  - ruby-head
-
-gemfile:
- - Gemfile
-
-branches:
-  only:
-    - master
-
-before_install: gem update bundler
-script: bundle exec rake test
-
-sudo: false
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head