fluent-plugin-obsolete-plugins 0.1.1 → 0.2.0

data/test/helper.rb

@@ -3,7 +3,6 @@ require "test-unit"
 require "test/unit/rr"
 require "timecop"
 require "fluent/test"
-require "fluent/test/driver/filter"
 require "fluent/test/helpers"
 
 Test::Unit::TestCase.include(Fluent::Test::Helpers)

data/test/plugin/test_filter_obsolete_plugins.rb

@@ -1,14 +1,11 @@
 require "helper"
-require "fluent/plugin/filter_obsolete_plugins.rb"
+require "fluent/test/driver/filter"
+require "fluent/plugin/filter_obsolete_plugins"
 
 class ObsoletePluginsFilterTest < Test::Unit::TestCase
-  CONFIG = %[
-    obsolete_plugins_yml #{fixture_path("obsolete-plugins.yml")}
-  ]
 
   setup do
     Fluent::Test.setup
-    $log = Fluent::Test::TestLogger.new
     @time = Time.now
     Timecop.freeze(@time)
   end
@@ -17,46 +14,138 @@ class ObsoletePluginsFilterTest < Test::Unit::TestCase
     Timecop.return
   end
 
-  test "no obsolete plugins" do
-    d = create_driver(CONFIG)
-    d.run(default_tag: "test") do
-      d.feed({ message: "This is test message." })
+  sub_test_case "obsolete_plugins_yml" do
+    CONFIG_YAML = %[
+      obsolete_plugins_yml #{fixture_path("obsolete-plugins.yml")}
+    ]
+
+    test "no obsolete plugins" do
+      d = create_driver(CONFIG_YAML)
+      d.run(default_tag: "test") do
+        d.feed({ message: "This is test message." })
+      end
+      assert_equal([{ message: "This is test message." }], d.filtered_records)
+      expected_logs = [
+        "#{@time} [warn]: 'obsolete_plugins_yml' parameter is deprecated: use plugins_json parameter instead\n",
+      ]
+      assert_equal(expected_logs, d.logs)
     end
-    assert_equal([{ message: "This is test message." }], d.filtered_records)
-    assert_equal([], d.logs)
-  end
 
-  test "obsolete plugins" do
-    mock(Gem).loaded_specs do
-      {
-        "fluent-plugin-tail-multiline" => nil,
-        "fluent-plugin-hostname" => nil
-      }
+    test "obsolete plugins" do
+      mock(Gem).loaded_specs do
+        {
+          "fluent-plugin-tail-multiline" => nil,
+          "fluent-plugin-hostname" => nil
+        }
+      end
+      d = create_driver(CONFIG_YAML)
+      d.run(default_tag: "test") do
+        d.feed({ message: "This is test message." })
+      end
+      assert_equal([{ message: "This is test message." }], d.filtered_records)
+      expected_logs = [
+        "#{@time} [warn]: 'obsolete_plugins_yml' parameter is deprecated: use plugins_json parameter instead\n",
+        "#{@time} [warn]: fluent-plugin-tail-multiline is obsolete: Merged in in_tail in Fluentd v0.10.45. [fluent/fluentd#269](https://github.com/fluent/fluentd/issues/269)\n",
+        "#{@time} [warn]: fluent-plugin-hostname is obsolete: Use [filter\\_record\\_transformer](http://docs.fluentd.org/v0.12/articles/filter_record_transformer) instead.\n"
+      ]
+      assert_equal(expected_logs, d.logs)
     end
-    d = create_driver(CONFIG)
-    d.run(default_tag: "test") do
-      d.feed({ message: "This is test message." })
+
+    test "raise error when detect obsolete plugins" do
+      mock(Gem).loaded_specs do
+        {
+          "fluent-plugin-tail-multiline" => nil,
+          "fluent-plugin-hostname" => nil
+        }
+      end
+
+      ex = assert_raise(Fluent::ConfigError) do
+        create_driver(CONFIG_YAML + "raise_error yes")
+      end
+      assert_equal("Detected obsolete plugins", ex.message)
     end
-    assert_equal([{ message: "This is test message." }], d.filtered_records)
-    expected_logs = [
-      "#{@time} [warn]: fluent-plugin-tail-multiline is obsolete: Merged in in_tail in Fluentd v0.10.45. [fluent/fluentd#269](https://github.com/fluent/fluentd/issues/269)\n",
-      "#{@time} [warn]: fluent-plugin-hostname is obsolete: Use [filter\\_record\\_transformer](http://docs.fluentd.org/v0.12/articles/filter_record_transformer) instead.\n"
+  end
+
+  sub_test_case "plugins_json" do
+    CONFIG_JSON = %[
+      plugins_json #{fixture_path("plugins.json")}
     ]
-    assert_equal(expected_logs, d.logs)
+
+    test "no obsolete plugins" do
+      d = create_driver(CONFIG_JSON)
+      d.run(default_tag: "test") do
+        d.feed({ message: "This is test message." })
+      end
+      assert_equal([{ message: "This is test message." }], d.filtered_records)
+      assert_equal([], d.logs)
+    end
+
+    test "obsolete plugins" do
+      mock(Gem).loaded_specs do
+        {
+          "fluent-plugin-tail-multiline" => nil,
+          "fluent-plugin-hostname" => nil
+        }
+      end
+      d = create_driver(CONFIG_JSON)
+      d.run(default_tag: "test") do
+        d.feed({ message: "This is test message." })
+      end
+      assert_equal([{ message: "This is test message." }], d.filtered_records)
+      expected_logs = [
+        "#{@time} [warn]: fluent-plugin-tail-multiline is obsolete: Merged in in_tail in Fluentd v0.10.45. [fluent/fluentd#269](https://github.com/fluent/fluentd/issues/269)\n",
+        "#{@time} [warn]: fluent-plugin-hostname is obsolete: Use [filter\\_record\\_transformer](http://docs.fluentd.org/v0.12/articles/filter_record_transformer) instead.\n"
+      ]
+      assert_equal(expected_logs, d.logs)
+    end
+
+    test "raise error when detect obsolete plugins" do
+      mock(Gem).loaded_specs do
+        {
+          "fluent-plugin-tail-multiline" => nil,
+          "fluent-plugin-hostname" => nil
+        }
+      end
+
+      ex = assert_raise(Fluent::ConfigError) do
+        create_driver(CONFIG_JSON + "raise_error yes")
+      end
+      assert_equal("Detected obsolete plugins", ex.message)
+    end
   end
 
-  test "raise error when detect obsolete plugins" do
-    mock(Gem).loaded_specs do
-      {
-        "fluent-plugin-tail-multiline" => nil,
-        "fluent-plugin-hostname" => nil
-      }
+  sub_test_case "error handling" do
+    test "invalid json" do
+      d = create_driver("plugins_json #{fixture_path('invalid.json')}")
+
+      expected_logs = [
+        "#{@time} [info]: Failed to notify obsolete plugins error_class=JSON::ParserError error=\"expected ',' or '}' after object value, got: EOF at line 11 column 1\"\n",
+      ]
+
+      assert_equal(expected_logs, d.logs)
     end
-    
-    ex = assert_raise(Fluent::ConfigError) do
-      create_driver(CONFIG + "raise_error yes")
+
+    test "timeout with slow server" do
+      server = create_slow_webserver(port: 12345)
+
+      mock(Fluent::Plugin::ObsoletePluginsUtils).notify.never
+
+      d = create_driver(%[
+        plugins_json http://localhost:12345/plugins.json
+        timeout 1
+      ])
+
+      sleep 2
+
+      expected_logs = [
+        "#{@time} [info]: Failed to notify obsolete plugins error_class=Timeout::Error error=\"execution expired\"\n",
+      ]
+
+      assert_equal(expected_logs, d.logs)
+    ensure
+      server.shutdown
     end
-    assert_equal("Detected obsolete plugins", ex.message)
+
   end
 
   private
@@ -64,4 +153,18 @@ class ObsoletePluginsFilterTest < Test::Unit::TestCase
   def create_driver(conf)
     Fluent::Test::Driver::Filter.new(Fluent::Plugin::ObsoletePluginsFilter).configure(conf)
   end
+
+  def create_slow_webserver(port: 12345)
+    require "webrick"
+
+    server = WEBrick::HTTPServer.new(Port: port)
+    server.mount_proc '/' do |req, res|
+      sleep 60
+
+      res['Content-Type'] = 'application/json'
+      res.body = File.read(fixture_path("plugins.json"))
+    end
+
+    server
+  end
 end

data/test/plugin/test_in_obsolete_plugins.rb

@@ -0,0 +1,115 @@
+require "helper"
+require "fluent/test/driver/input"
+require "fluent/plugin/in_obsolete_plugins"
+require "fluent/plugin/obsolete_plugins_utils"
+
+class ObsoletePluginsInputTest < Test::Unit::TestCase
+
+  setup do
+    Fluent::Test.setup
+    @time = Time.now
+    Timecop.freeze(@time)
+  end
+
+  teardown do
+    Timecop.return
+  end
+
+  sub_test_case "plugins_json" do
+    CONFIG_JSON = %[
+      plugins_json #{fixture_path("plugins.json")}
+    ]
+
+    test "no obsolete plugins" do
+      d = create_driver(CONFIG_JSON)
+      d.run
+      assert_equal([], d.events)
+      assert_equal([], d.logs)
+    end
+
+    test "obsolete plugins" do
+      stub(Gem).loaded_specs do
+        {
+          "fluent-plugin-tail-multiline" => nil,
+          "fluent-plugin-hostname" => nil
+        }
+      end
+      d = create_driver(CONFIG_JSON)
+      d.run
+      assert_equal([], d.events)
+      expected_logs = [
+        "#{@time} [warn]: fluent-plugin-tail-multiline is obsolete: Merged in in_tail in Fluentd v0.10.45. [fluent/fluentd#269](https://github.com/fluent/fluentd/issues/269)\n",
+        "#{@time} [warn]: fluent-plugin-hostname is obsolete: Use [filter\\_record\\_transformer](http://docs.fluentd.org/v0.12/articles/filter_record_transformer) instead.\n"
+      ]
+      assert_equal(expected_logs, d.logs)
+    end
+
+    test "raise error when detect obsolete plugins" do
+      stub(Gem).loaded_specs do
+        {
+          "fluent-plugin-tail-multiline" => nil,
+          "fluent-plugin-hostname" => nil
+        }
+      end
+
+      ex = assert_raise(Fluent::ConfigError) do
+        create_driver(CONFIG_JSON + "raise_error yes")
+      end
+      assert_equal("Detected obsolete plugins", ex.message)
+    end
+  end
+
+  sub_test_case "error handling" do
+    test "invalid json" do
+      d = create_driver("plugins_json #{fixture_path('invalid.json')}")
+
+      expected_logs = [
+        "#{@time} [info]: Failed to notify obsolete plugins error_class=JSON::ParserError error=\"expected ',' or '}' after object value, got: EOF at line 11 column 1\"\n",
+      ]
+
+      assert_equal(expected_logs, d.logs)
+    end
+
+    test "timeout with slow server" do
+      server = create_slow_webserver(port: 12345)
+
+      mock(Fluent::Plugin::ObsoletePluginsUtils).notify.never
+
+      d = create_driver(%[
+        plugins_json http://localhost:12345/plugins.json
+        timeout 1
+      ])
+
+      sleep 2
+
+      expected_logs = [
+        "#{@time} [info]: Failed to notify obsolete plugins error_class=Timeout::Error error=\"execution expired\"\n",
+      ]
+
+      assert_equal(expected_logs, d.logs)
+    ensure
+      server.shutdown
+    end
+
+  end
+
+  private
+
+  def create_driver(conf)
+    Fluent::Test::Driver::Input.new(Fluent::Plugin::ObsoletePluginsInput).configure(conf)
+  end
+
+  def create_slow_webserver(port: 12345)
+    require "webrick"
+
+    server = WEBrick::HTTPServer.new(Port: port)
+    server.mount_proc '/' do |req, res|
+      sleep 60
+
+      res['Content-Type'] = 'application/json'
+      res.body = File.read(fixture_path("plugins.json"))
+    end
+
+    server
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-obsolete-plugins
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - okkez
 bindir: bin
 cert_chain: []
-date: 2025-04-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,9 +114,14 @@ files:
 - Rakefile
 - fluent-plugin-obsolete-plugins.gemspec
 - lib/fluent/plugin/filter_obsolete_plugins.rb
+- lib/fluent/plugin/in_obsolete_plugins.rb
+- lib/fluent/plugin/obsolete_plugins_utils.rb
+- test/fixtures/invalid.json
 - test/fixtures/obsolete-plugins.yml
+- test/fixtures/plugins.json
 - test/helper.rb
 - test/plugin/test_filter_obsolete_plugins.rb
+- test/plugin/test_in_obsolete_plugins.rb
 homepage: https://github.com/okkez/fluent-plugin-obsolete-plugins
 licenses:
 - Apache-2.0
@@ -135,10 +140,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.7.0
 specification_version: 4
 summary: Report obsolete plugins on boot
 test_files:
+- test/fixtures/invalid.json
 - test/fixtures/obsolete-plugins.yml
+- test/fixtures/plugins.json
 - test/helper.rb
 - test/plugin/test_filter_obsolete_plugins.rb
+- test/plugin/test_in_obsolete_plugins.rb