fluent-plugin-formatter-protobuf 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bcc9a5c80a25b6d30ebbabcbc6596db405738915dad875eb52570df1e793a0b
-  data.tar.gz: c05073cdb7b669ca81aa29b21fc46d2c50846072b38d3cd749f09666babc62f8
+  metadata.gz: f49ca0a97713b1a0771cb9c73b38f49660b5fb4103a6d3f989140013fbd21bab
+  data.tar.gz: d547aaeef78fb13b4d5747dcf26fa27f1912e33ee6b4f699db401f335525fa94
 SHA512:
-  metadata.gz: efd71e67d8f9388d487d2d6de036c012a29847960f8eab02c39d8c6d08e7b6a20fb4a1c7d622b8fbdb1a06d67666d9a2885edcef2bbb769fc7f3278400102d46
-  data.tar.gz: 79a3e80a85c12df566a4e59b764487e9cb7e4d66962b0fcb0bbda6f8e840e8c64cc58a407ab948e256e19bf62aea46e0a9fe481b1c445966e9f3c6c2fed39ffe
+  metadata.gz: c17daaf911ea6a58cdbd8bd39b25bdf500630a506ab29f384d1abcf01e178578bea74ecf4e9ebff6c0496bf67304324f49b00744d49911bd1db32177d7fbcaed
+  data.tar.gz: bc2167f0f05d20594b453a7a40ba25c8e72ae085ed6c72a14714e2cdf617e9050f650b1c1aa1b82b5626f2c83666ef4015c19149deed227c4e0d39d79df910f2

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,49 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  schedule:
+    - cron: '18 11 * * 4'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

data/README.md

@@ -18,7 +18,7 @@ $ gem install fluent-plugin-formatter-protobuf
 $ gem install \
   fluent-plugin-formatter-protobuf \
   --version "<version>" \
-  --source "https://rubygems.pkg.github.com/raytung"
+  --source "https://rubygems.pkg.github.com/fluent-plugins-nursery"
 ```
 
 ### Bundler (RubyGems)
@@ -32,7 +32,7 @@ gem "fluent-plugin-formatter-protobuf", "<version>"
 ### Bundler (GitHub RubyGems Registry),
 
 ```shell
-source "https://rubygems.pkg.github.com/raytung" do
+source "https://rubygems.pkg.github.com/fluent-plugins-nursery" do
   gem "fluent-plugin-formatter-protobuf", "<version>"
 end
 ```
@@ -43,11 +43,12 @@ And then execute:
 $ bundle
 ```
 
-## Not so quick start
+## Quick start
 
 1. Generate the protobuf ruby methods
    1. e.g `protoc --proto_path=. --ruby_out=. ./log.proto`
-2. Modify the `<format>` section to include `message_name`, which is your Protobuf message name, and `include_paths`, the path where the generated Ruby types are stored
+2. Modify the `<format>` section to include `class_name`, which is your Protobuf message name, and `include_paths`, the path where the generated Ruby types are stored
+   1. Given protobuf class `Your::Protobuf::Class::Name` class should be given as `Your.Protobuf.Class.Name` in `class_name`. The exact name can be found in the generated Ruby files
 
 
 ## Example
@@ -74,7 +75,7 @@ $ bundle
 
     <format>
         @type protobuf
-        message_name "Log"
+        class_name "Log"
         include_paths ["/opt/fluent-plugin-formatter-protobuf/log_pb.rb"]
     </format>
 </match>
@@ -82,13 +83,10 @@ $ bundle
 
 ## Configuration
 
-You can generate configuration template:
-
-```
-$ fluent-plugin-config-format formatter formatter-protobuf
-```
-
-You can copy and paste generated documents here.
+|parameter|type|description|default|
+|---|---|---|---|
+|include_paths|array (optional)| Generated Ruby Protobuf class files path |`[]`|
+|class_name|string (required)| Ruby Protobuf class name. Used to encode into Protobuf binary||
 
 ## Copyright
 

data/RELEASE.md

@@ -3,7 +3,7 @@
 ## Instructions
 To release the gem to Github package manager and Ruby Gems,
 
-1. Update `lib/fluent/version.rb`
-2. Update `Gemfile.lock`
-3. Create a pull request and merge it into `main`
-4. Manually creating a release on Github with a tag indicating the new version number e.g. `vMAJOR.MINOR.PATCH`
+1. Update `lib/fluent/plugin/version.rb`
+2. Create a pull request and merge it into `main`
+3. Manually creating a release on Github with a tag indicating the new version number e.g. `vMAJOR.MINOR.PATCH`
+4. GitHub Actions will automatically run and publish to RubyGems and GitHub repository

data/fluent-plugin-formatter-protobuf.gemspec

@@ -28,11 +28,11 @@ Gem::Specification.new do |spec|
   spec.test_files = test_files
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 2.2.22'
-  spec.add_development_dependency 'rake', '~> 13.0.3'
-  spec.add_development_dependency 'rubocop', '~> 1.22.1'
-  spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
-  spec.add_development_dependency 'test-unit', '~> 3.3.7'
+  spec.add_development_dependency 'bundler', '~> 2.2'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 1.22'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6'
+  spec.add_development_dependency 'test-unit', '~> 3.3'
   spec.add_runtime_dependency 'fluentd', ['>= 1.0', '< 2']
   spec.add_runtime_dependency 'google-protobuf', ['~> 3.18']
 end

data/lib/fluent/plugin/formatter_protobuf.rb

@@ -29,11 +29,9 @@ module Fluent
     class ProtobufFormatter < Fluent::Plugin::Formatter
       Fluent::Plugin.register_formatter('protobuf', self)
 
-      # Absolute paths to the generated Ruby protobuf files
-      config_param :include_paths, :array, default: []
+      config_param :include_paths, :array, default: [], desc: 'Generated Ruby Protobuf class files path'
 
-      # Protobuf message name
-      config_param :message_name, :string
+      config_param :class_name, :string, desc: 'Ruby Protobuf class name. Used to encode into Protobuf binary'
 
       def configure(conf)
         super(conf)
@@ -42,10 +40,10 @@ module Fluent
 
         @include_paths.each { |path| require_proto!(path) } unless @include_paths.empty?
 
-        message_lookup = Google::Protobuf::DescriptorPool.generated_pool.lookup(@message_name)
-        raise Fluent::ConfigError, "message name '#{@message_name}' not found" if message_lookup.nil?
+        class_lookup = Google::Protobuf::DescriptorPool.generated_pool.lookup(@class_name)
+        raise Fluent::ConfigError, "class name '#{@class_name}' not found" if class_lookup.nil?
 
-        @protobuf_class = message_lookup.msgclass
+        @protobuf_class = class_lookup.msgclass
       end
 
       def formatter_type
@@ -57,22 +55,14 @@ module Fluent
         @protobuf_class.encode(protobuf_msg)
       end
 
-      # @param [string] filename
-      # @return [void]
       def require_proto!(filename)
-        unless filename.end_with?('.rb')
-          raise Fluent::ConfigError, "Unable to load file '#{filename}'. It is not a Ruby file"
-        end
-
-        unless Pathname.new(filename).absolute?
-          raise Fluent::ConfigError, "Unable to load file '#{filename}'. Please provide absolute paths"
-        end
-
-        begin
+        if Pathname.new(filename).absolute?
           require filename
-        rescue LoadError => e
-          raise Fluent::ConfigError, "Unable to load file '#{filename}'. Reason: #{e.inspect}"
+        else
+          require_relative filename
         end
+      rescue LoadError => e
+        raise Fluent::ConfigError, "Unable to load file '#{filename}'. Reason: #{e.inspect}"
       end
     end
   end

data/lib/fluent/plugin/version.rb

@@ -2,6 +2,6 @@
 
 module Fluent
   module Plugin
-    VERSION = '0.0.5'
+    VERSION = '0.1.0'
   end
 end

data/test/plugin/test_formatter_protobuf.rb

@@ -8,31 +8,47 @@ class ProtobufFormatterTest < Test::Unit::TestCase
     Fluent::Test.setup
   end
 
-  VALID_INCLUDE_PATHS = [File.expand_path(File.join(__dir__, '..', 'proto', 'addressbook_pb.rb'))].freeze
+  VALID_INCLUDE_PATHS_ABSOLUTE = [File.expand_path(File.join(__dir__, '..', 'proto', 'addressbook_pb.rb'))].freeze
+
+  # Relative to the plugin file
+  VALID_INCLUDE_PATHS_RELATIVE = '../../../test/proto/addressbook_pb.rb'
 
   sub_test_case 'configure' do
     test 'fail if include_paths is empty' do
       assert_raise(Fluent::ConfigError) do
-        create_driver({ message_name: '', include_paths: [] })
+        create_driver({ class_name: '', include_paths: [] })
+      end
+    end
+
+    test 'fail if ruby files not found in the provided include paths' do
+      assert_raise(Fluent::ConfigError) do
+        create_driver({ class_name: 'tutorial.AddressBook', include_paths: ['some/random/path'] })
       end
     end
 
-    test 'fail if no protobuf class can be found with message_name' do
+    test 'fail if no protobuf class can be found with class_name' do
       assert_raise(Fluent::ConfigError) do
-        create_driver({ message_name: 'Some.Name', include_paths: VALID_INCLUDE_PATHS })
+        create_driver({ class_name: 'Some.Name', include_paths: VALID_INCLUDE_PATHS_ABSOLUTE })
+      end
+    end
+
+    test 'success if given valid relative paths in include paths' do
+      assert_nothing_raised do
+        create_driver({ class_name: 'tutorial.AddressBook', include_paths: [VALID_INCLUDE_PATHS_RELATIVE] })
       end
     end
 
     test 'passes on valid configuration' do
       assert_nothing_raised do
-        create_driver({ message_name: 'tutorial.AddressBook', include_paths: VALID_INCLUDE_PATHS })
+        create_driver({ class_name: 'tutorial.AddressBook', include_paths: VALID_INCLUDE_PATHS_ABSOLUTE })
       end
     end
   end
 
   sub_test_case 'format' do
     test 'encodes into Protobuf binary' do
-      formatter = create_formatter({ message_name: 'tutorial.AddressBook', include_paths: VALID_INCLUDE_PATHS })
+      formatter = create_formatter({ class_name: 'tutorial.AddressBook',
+                                     include_paths: VALID_INCLUDE_PATHS_ABSOLUTE })
 
       formatted = formatter.format('some-tag', 1234,
                                    { people: [{ name: 'Masahiro', id: 1337, email: 'repeatedly _at_ gmail.com' }] })

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-formatter-protobuf
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Ray Tung
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-24 00:00:00.000000000 Z
+date: 2021-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,70 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.22
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.22
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.3
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.3
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.22.1
+        version: '1.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.22.1
+        version: '1.22'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.7
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.7
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: fluentd
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +123,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/build-and-test.yml"
+- ".github/workflows/codeql-analysis.yml"
 - ".github/workflows/publish.yml"
 - ".gitignore"
 - ".rubocop.yml"