fluent-plugin-remote_syslog 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5b7602139f0aea954fe6d7fbfe8ea83aedc6a218
-  data.tar.gz: 041633a7947a2d028a91a91cc4b8fb60d1255990
+SHA256:
+  metadata.gz: 34d4b7218edc54b5340ea9d168603f72d50ed038cc6b262b22a5a2045c00aa50
+  data.tar.gz: 3f2340c1507f45567d45e6b57c2129978ee2e01809567a68dc8438ce6fc1eec0
 SHA512:
-  metadata.gz: e6582e74ecb339c7d39a862ca5122b935271940d8c8322ec214aada1adcb2d13f79a9a11ef8571fa87e9028d27b1c5f3c0f88d74d21dcdc2076fac1323eabb74
-  data.tar.gz: 443286f184920a6f0a35bab20e58fa6b1c837ee2246d044ff66f2c3ad93e31d62741ab8a145535e77badbfa13c7d7bffab1c65c8e000f74ea4b248876255292b
+  metadata.gz: f6fca5b050b67064465bdf08bdb53e650d5aa73f53b9d8cfc847717fdda4c2bf18f6ba9ad67a835430b8a1e88eedbcf138f77c85132d11813f109dd7aa5412e0
+  data.tar.gz: fbaf7442c5e3bc25618678250bad84d2099dc7216c21938f5c5d083b4788f9e9446fdaa2a027ddd76376d0d1d93509f4bdd6983b43fe0176122b443c6b91d4d6

data/.github/workflows/test.yaml

@@ -0,0 +1,26 @@
+on:
+  - push
+  - pull_request
+name: Unit test
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.7', '3.1' ]
+        os:
+          - windows-latest
+          - ubuntu-latest
+          - macos-latest
+    name: Test on ${{ matrix.os }} with Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: bundle
+      - name: Run tests
+        run: bundle exec rake test

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.1.0
+
+* Up rake dependency version for CVE-2020-8130
+* Support "warning" Severity in addition to "warn" [#51](https://github.com/fluent-plugins-nursery/fluent-plugin-remote_syslog/pull/51)
+* Make `packet_size` option valid to UDP [#46](https://github.com/fluent-plugins-nursery/fluent-plugin-remote_syslog/pull/46)
+
 ## 1.0.0
 
 * Support fluentd-0.14 or later features [#24](https://github.com/dlackty/fluent-plugin-remote_syslog/pull/24)

data/Gemfile

@@ -1,6 +1,4 @@
 source 'https://rubygems.org'
 
-gem 'remote_syslog_sender', github: "reproio/remote_syslog_logger"
-
 # Specify your gem's dependencies in fluent-plugin-remote_syslog.gemspec
 gemspec

data/README.md

@@ -13,8 +13,16 @@
 
 ## Installation
 
+* Fluentd
+
+```bash
+$ fluent-gem install fluent-plugin-remote_syslog
+```
+
+* td-agent
+
 ```bash
- fluent-gem install fluent-plugin-remote_syslog
+$ td-agent-gem install fluent-plugin-remote_syslog
 ```
 
 ## Usage
@@ -33,7 +41,7 @@
 
   <format>
     @type single_value
-    message_key msg
+    message_key message
   </format>
 </match>
 ```
@@ -80,4 +88,7 @@
 
 ## License
 
-Copyright (c) 2014-2017 Richard Lee. See LICENSE for details.
+Copyright (c) 2014-2017 Richard Lee.  
+Copyright (c) 2022 Daijiro Fukuda.
+
+See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/fluent-plugin-remote_syslog.gemspec

@@ -5,8 +5,8 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-remote_syslog"
   spec.version       = File.read("VERSION").strip
-  spec.authors       = ["Richard Lee"]
-  spec.email         = ["dlackty@gmail.com"]
+  spec.authors       = ["Richard Lee", "Daijiro Fukuda"]
+  spec.email         = ["dlackty@gmail.com", "fukuda@clear-code.com"]
   spec.summary       = %q{Fluentd output plugin for remote syslog}
   spec.description   = spec.description
   spec.homepage      = "https://github.com/dlackty/fluent-plugin-remote_syslog"
@@ -16,7 +16,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", '~> 2.0'
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "test-unit"
   spec.add_development_dependency "test-unit-rr"
 

data/lib/fluent/plugin/out_remote_syslog.rb

@@ -96,6 +96,8 @@ module Fluent
         program = extract_placeholders(@program, chunk.metadata)
         hostname = extract_placeholders(@hostname, chunk.metadata)
 
+        severity = SeverityMapper.map(severity)
+
         packet_options = {facility: facility, severity: severity, program: program}
         packet_options[:hostname] = hostname unless hostname.empty?
 
@@ -144,11 +146,28 @@ module Fluent
             port,
             whinyerrors: true,
             program: @program,
+            packet_size: @packet_size,
           )
         end
         @senders << sender
         sender
       end
+
+      # Convert some Severity values that is not supported in `syslog_protocol` library:
+      #   https://github.com/eric/syslog_protocol
+      # We want to fix `syslog_protocol` itself, but it seems to be not maintained for a while.
+      # If the following PR is merged, we can remove this implementaion.
+      #   https://github.com/eric/syslog_protocol/pull/9
+      module SeverityMapper
+        DICT = {
+          # "warning" is not supported, but we should use it since "warn" is deprecated.
+          "warning" => "warn", 
+        }
+
+        def self.map(severity)
+          DICT[severity] || severity
+        end
+      end
     end
   end
 end

data/test/plugin/out_remote_syslog.rb

@@ -1,17 +1,23 @@
 require "test_helper"
 require "fluent/plugin/out_remote_syslog"
+require "fluent/plugin/in_syslog"
+require 'fluent/test/driver/input'
 
 class RemoteSyslogOutputTest < Test::Unit::TestCase
   def setup
     Fluent::Test.setup
   end
 
-  def create_driver(conf = CONFIG)
+  def create_driver_out_syslog(conf)
     Fluent::Test::Driver::Output.new(Fluent::Plugin::RemoteSyslogOutput).configure(conf)
   end
 
+  def create_driver_in_syslog(conf)
+    Fluent::Test::Driver::Input.new(Fluent::Plugin::SyslogInput).configure(conf)
+  end
+
   def test_configure
-    d = create_driver %[
+    d = create_driver_out_syslog %[
       @type remote_syslog
       hostname foo.com
       host example.com
@@ -28,13 +34,16 @@ class RemoteSyslogOutputTest < Test::Unit::TestCase
     assert_equal "debug", d.instance.instance_variable_get(:@severity)
   end
 
-  def test_write
-    d = create_driver %[
+  data("debug", {severity: "debug"})
+  data("warn", {severity: "warn"})
+  data("warning", {severity: "warning", expected_severity: "warn"})
+  def test_write_udp(data)
+    out_driver = create_driver_out_syslog %[
       @type remote_syslog
       hostname foo.com
-      host example.com
+      host localhost
       port 5566
-      severity debug
+      severity #{data[:severity]}
       program minitest
 
       <format>
@@ -43,22 +52,41 @@ class RemoteSyslogOutputTest < Test::Unit::TestCase
       </format>
     ]
 
-    mock.proxy(RemoteSyslogSender::UdpSender).new("example.com", 5566, whinyerrors: true, program: "minitest") do |sender|
-      mock.proxy(sender).transmit("foo",  facility: "user", severity: "debug", program: "minitest", hostname: "foo.com")
-    end
+    in_driver = create_driver_in_syslog %[
+      @type syslog
+      tag tag
+      port 5566
+      bind 127.0.0.1
+    ]
 
-    d.run do
-      d.feed("tag", Fluent::EventTime.now, {"message" => "foo"})
+    in_driver.run(expect_records: 1, timeout: 5) do
+      out_driver.run do
+        out_driver.feed("tag", Fluent::EventTime.now, {"message" => "This is a test message."})
+      end
     end
+
+    assert_equal 1, in_driver.events.length
+
+    tag, _, msg = in_driver.events[0]
+
+    expected_facility = "user"
+    expected_severity = data[:expected_severity] || data[:severity]
+    assert_equal("tag.#{expected_facility}.#{expected_severity}", tag)
+    assert_equal("foo.com", msg["host"])
+    assert_equal("minitest", msg["ident"])
+    assert_equal("This is a test message.", msg["message"])
   end
 
-  def test_write_tcp
-    d = create_driver %[
+  data("debug", {severity: "debug"})
+  data("warn", {severity: "warn"})
+  data("warning", {severity: "warning", expected_severity: "warn"})
+  def test_write_tcp(data)
+    out_driver = create_driver_out_syslog %[
       @type remote_syslog
       hostname foo.com
-      host example.com
+      host localhost
       port 5566
-      severity debug
+      severity #{data[:severity]}
       program minitest
 
       protocol tcp
@@ -69,16 +97,44 @@ class RemoteSyslogOutputTest < Test::Unit::TestCase
       </format>
     ]
 
-    any_instance_of(RemoteSyslogSender::TcpSender) do |klass|
-      mock(klass).connect
-    end
+    in_driver = create_driver_in_syslog %[
+      @type syslog
+      tag tag
+      port 5566
+      bind 127.0.0.1
+      protocol_type tcp
+    ]
 
-    mock.proxy(RemoteSyslogSender::TcpSender).new("example.com", 5566, whinyerrors: true, program: "minitest", tls: false, packet_size: 1024, timeout: nil, timeout_exception: false, keep_alive: false, keep_alive_cnt: nil, keep_alive_idle: nil, keep_alive_intvl: nil) do |sender|
-      mock(sender).transmit("foo",  facility: "user", severity: "debug", program: "minitest", hostname: "foo.com")
+    in_driver.run(expect_records: 1, timeout: 5) do
+      out_driver.run do
+        out_driver.feed("tag", Fluent::EventTime.now, {"message" => "This is a test message."})
+      end
     end
 
-    d.run do
-      d.feed("tag", Fluent::EventTime.now, {"message" => "foo"})
-    end
+    assert_equal 1, in_driver.events.length
+
+    tag, _, msg = in_driver.events[0]
+
+    expected_facility = "user"
+    expected_severity = data[:expected_severity] || data[:severity]
+    assert_equal("tag.#{expected_facility}.#{expected_severity}", tag)
+    assert_equal("foo.com", msg["host"])
+    assert_equal("minitest", msg["ident"])
+    assert_equal("This is a test message.", msg["message"])
+  end
+
+  data("emerg", {in: "emerg", out: "emerg"})
+  data("alert", {in: "alert", out: "alert"})
+  data("crit", {in: "crit", out: "crit"})
+  data("err", {in: "err", out: "err"})
+  data("warn", {in: "warn", out: "warn"})
+  data("warning", {in: "warning", out: "warn"})
+  data("notice", {in: "notice", out: "notice"})
+  data("info", {in: "info", out: "info"})
+  data("debug", {in: "debug", out: "debug"})
+  data("wrong", {in: "wrong", out: "wrong"})
+  def test_severity_mapper(data)
+    out = Fluent::Plugin::RemoteSyslogOutput::SeverityMapper.map(data[:in])
+    assert_equal(data[:out], out)
   end
 end

metadata

@@ -1,29 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-remote_syslog
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Richard Lee
+- Daijiro Fukuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-22 00:00:00.000000000 Z
+date: 2022-09-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -83,10 +98,12 @@ dependencies:
 description: ''
 email:
 - dlackty@gmail.com
+- fukuda@clear-code.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yaml"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
@@ -118,8 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Fluentd output plugin for remote syslog