Skip to content

Check whether obsolete for installed plugins #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 7, 2025
Merged

Check whether obsolete for installed plugins #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion lib/fluent/plugin/obsolete_plugins_utils.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,12 @@ def self.obsolete_plugins_from_json(url, timeout: 5)
end
end

def self.installed_plugins
Gem::Specification.find_all.select { |x| x.name =~ /^fluent(d|-(plugin|mixin)-.*)$/ }.map(&:name)
end

def self.notify(logger, obsolete_plugins, raise_error: false)
plugins = Gem.loaded_specs.keys & obsolete_plugins.keys
plugins = Fluent::Plugin::ObsoletePluginsUtils.installed_plugins & obsolete_plugins.keys
plugins.each do |name|
logger.warn("#{name} is obsolete: #{obsolete_plugins[name].chomp}")
end
Expand Down
38 changes: 18 additions & 20 deletions test/plugin/test_filter_obsolete_plugins.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ class ObsoletePluginsFilterTest < Test::Unit::TestCase
]

test "no obsolete plugins" do
stub(Fluent::Plugin::ObsoletePluginsUtils).installed_plugins do
[]
end

d = create_driver(CONFIG_YAML)
d.run(default_tag: "test") do
d.feed({ message: "This is test message." })
Expand All @@ -32,12 +36,10 @@ class ObsoletePluginsFilterTest < Test::Unit::TestCase
end

test "obsolete plugins" do
mock(Gem).loaded_specs do
{
"fluent-plugin-tail-multiline" => nil,
"fluent-plugin-hostname" => nil
}
stub(Fluent::Plugin::ObsoletePluginsUtils).installed_plugins do
["fluent-plugin-tail-multiline", "fluent-plugin-hostname"]
end

d = create_driver(CONFIG_YAML)
d.run(default_tag: "test") do
d.feed({ message: "This is test message." })
Expand All @@ -52,11 +54,8 @@ class ObsoletePluginsFilterTest < Test::Unit::TestCase
end

test "raise error when detect obsolete plugins" do
mock(Gem).loaded_specs do
{
"fluent-plugin-tail-multiline" => nil,
"fluent-plugin-hostname" => nil
}
stub(Fluent::Plugin::ObsoletePluginsUtils).installed_plugins do
["fluent-plugin-tail-multiline", "fluent-plugin-hostname"]
end

ex = assert_raise(Fluent::ConfigError) do
Expand All @@ -72,6 +71,10 @@ class ObsoletePluginsFilterTest < Test::Unit::TestCase
]

test "no obsolete plugins" do
stub(Fluent::Plugin::ObsoletePluginsUtils).installed_plugins do
[]
end

d = create_driver(CONFIG_JSON)
d.run(default_tag: "test") do
d.feed({ message: "This is test message." })
Expand All @@ -81,12 +84,10 @@ class ObsoletePluginsFilterTest < Test::Unit::TestCase
end

test "obsolete plugins" do
mock(Gem).loaded_specs do
{
"fluent-plugin-tail-multiline" => nil,
"fluent-plugin-hostname" => nil
}
stub(Fluent::Plugin::ObsoletePluginsUtils).installed_plugins do
["fluent-plugin-tail-multiline", "fluent-plugin-hostname"]
end

d = create_driver(CONFIG_JSON)
d.run(default_tag: "test") do
d.feed({ message: "This is test message." })
Expand All @@ -100,11 +101,8 @@ class ObsoletePluginsFilterTest < Test::Unit::TestCase
end

test "raise error when detect obsolete plugins" do
mock(Gem).loaded_specs do
{
"fluent-plugin-tail-multiline" => nil,
"fluent-plugin-hostname" => nil
}
stub(Fluent::Plugin::ObsoletePluginsUtils).installed_plugins do
["fluent-plugin-tail-multiline", "fluent-plugin-hostname"]
end

ex = assert_raise(Fluent::ConfigError) do
Expand Down
19 changes: 9 additions & 10 deletions test/plugin/test_in_obsolete_plugins.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,21 @@ class ObsoletePluginsInputTest < Test::Unit::TestCase
]

test "no obsolete plugins" do
stub(Fluent::Plugin::ObsoletePluginsUtils).installed_plugins do
[]
end

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
}
stub(Fluent::Plugin::ObsoletePluginsUtils).installed_plugins do
["fluent-plugin-tail-multiline", "fluent-plugin-hostname"]
end

d = create_driver(CONFIG_JSON)
d.run
assert_equal([], d.events)
Expand All @@ -45,11 +47,8 @@ class ObsoletePluginsInputTest < Test::Unit::TestCase
end

test "raise error when detect obsolete plugins" do
stub(Gem).loaded_specs do
{
"fluent-plugin-tail-multiline" => nil,
"fluent-plugin-hostname" => nil
}
stub(Fluent::Plugin::ObsoletePluginsUtils).installed_plugins do
["fluent-plugin-tail-multiline", "fluent-plugin-hostname"]
end

ex = assert_raise(Fluent::ConfigError) do
Expand Down