From 7843cf102839fc613054f10c920de0388fe302e7 Mon Sep 17 00:00:00 2001
From: Kentaro Hayashi <kenhys@gmail.com>
Date: Tue, 22 Aug 2023 16:56:47 +0900
Subject: [PATCH] Add script to check supplementary installed plugin

Examples:

  Preinstalled plugins: (bundled by default)

   * fluent-plugin-calyptia-monitoring
   * fluent-plugin-concat
...

   * fluent-plugin-utmpx
   * fluent-plugin-webhdfs

  Currently Installed Plugins:

   * fluent-plugin-calyptia-monitoring
   * fluent-plugin-elasticsearch
...
   * fluent-plugin-utmpx
   * fluent-plugin-webhdfs

  Manually Installed Plugins:

   * fluent-plugin-concat

Signed-off-by: Kentaro Hayashi <kenhys@gmail.com>
---
 fluent-package/Rakefile                       |  1 +
 .../usr/sbin/fluent-gem-supplemental-list.erb | 59 +++++++++++++++++++
 fluent-package/yum/fluent-package.spec.in     |  1 +
 3 files changed, 61 insertions(+)
 create mode 100755 fluent-package/templates/usr/sbin/fluent-gem-supplemental-list.erb

diff --git a/fluent-package/Rakefile b/fluent-package/Rakefile
index 1d1e21fb..9cd7d7fd 100755
--- a/fluent-package/Rakefile
+++ b/fluent-package/Rakefile
@@ -518,6 +518,7 @@ class BuildTask
           "usr/bin/td",
           "usr/sbin/#{SERVICE_NAME}",
           "usr/sbin/#{PACKAGE_DIR}-gem",
+          "usr/sbin/#{PACKAGE_DIR}-gem-supplemental-list",
         ]
         scripts.each do |script|
           src = template_path("#{script}.erb")
diff --git a/fluent-package/templates/usr/sbin/fluent-gem-supplemental-list.erb b/fluent-package/templates/usr/sbin/fluent-gem-supplemental-list.erb
new file mode 100755
index 00000000..327c054d
--- /dev/null
+++ b/fluent-package/templates/usr/sbin/fluent-gem-supplemental-list.erb
@@ -0,0 +1,59 @@
+#!<%= install_path %>/bin/ruby
+ENV["GEM_HOME"]="<%= gem_install_path %>/"
+ENV["GEM_PATH"]="<%= gem_install_path %>/"
+
+require "bundler"
+require "open3"
+require "etc"
+
+def installed_plugins
+  stdout, stderr, status = Open3.capture3("<%= install_path %>/bin/fluent-gem list | grep fluent-plugin")
+  gem_list = []
+  if status.success?
+    lines = stdout.split(/\n/)
+    lines.each do |line|
+      gem_list << line.split.first
+    end
+  end
+  gem_list
+end
+
+begin
+  if Process.uid != 0
+    puts(<<EOS)
+Failed to execute #{__FILE__}.
+You must execute this script with administrator privileges.
+
+Usage: sudo #{__FILE__}
+EOS
+    exit 1
+  end
+  gemfile_path = "<%= install_path %>/share/Gemfile"
+  lockfile_path = "<%= install_path %>/share/Gemfile.lock"
+  bundler_def = Bundler::Definition.build(gemfile_path, lockfile_path, nil)
+
+  bundled_plugins = bundler_def.locked_gems.dependencies.keys.select do |gem_name|
+    gem_name.start_with?("fluent-plugin-")
+  end
+
+  puts(<<EOS)
+Preinstalled plugins: (bundled by default)
+
+ * #{bundled_plugins.sort.join("\n * ")}
+
+Currently Installed Plugins:
+
+ * #{installed_plugins.sort.join("\n * ")}
+
+EOS
+  unless (installed_plugins - bundled_plugins).empty?
+puts(<<EOS)
+Manually Installed Plugins:
+
+ * #{(installed_plugins - bundled_plugins).sort.join("\n * ")}
+
+EOS
+  end
+rescue Bundler::Dsl::DSLError
+  puts("failed to collect supplemental gem list")
+end
diff --git a/fluent-package/yum/fluent-package.spec.in b/fluent-package/yum/fluent-package.spec.in
index 21e876c6..93a16d23 100644
--- a/fluent-package/yum/fluent-package.spec.in
+++ b/fluent-package/yum/fluent-package.spec.in
@@ -359,6 +359,7 @@ fi
 %{_bindir}/td
 %{_sbindir}/@SERVICE_NAME@
 %{_sbindir}/fluent-gem
+%{_sbindir}/fluent-gem-supplemental-list
 %{_mandir}/man1/td*
 %{_mandir}/man1/fluent*
 %config(noreplace) %{_sysconfdir}/sysconfig/@SERVICE_NAME@