Merge pull request #10875 from Ayanda-D/test-server-10865-and-10870

Tests for rabbitmq-plugins list: --silent and --quiet options

Author: michaelklishin

deps/rabbitmq_cli/lib/rabbitmq/cli/plugins/commands/list_command.ex

@@ -122,7 +122,7 @@ defmodule RabbitMQ.CLI.Plugins.Commands.ListCommand do
       ["--verbose", "output more information"],
       [
         "--minimal",
-        "only print plugin names. Most useful in compbination with --silent and --enabled."
+        "only print plugin names. Most useful in combination with --silent and --enabled."
       ],
       ["--enabled", "only list enabled plugins"],
       ["--implicitly-enabled", "include plugins enabled as dependencies of other plugins"]

deps/rabbitmq_cli/lib/rabbitmq/cli/plugins/plugins_helpers.ex

@@ -195,7 +195,9 @@ defmodule RabbitMQ.CLI.Plugins.Helpers do
     all_plugin_names = Enum.map(all, &plugin_name/1)
     missing = MapSet.difference(MapSet.new(plugins), MapSet.new(all_plugin_names))
 
-    case Enum.empty?(missing) do
+    hard_write = Map.get(opts, :hard_write, false)
+
+    case Enum.empty?(missing) or hard_write do
       true ->
         case :rabbit_file.write_term_file(to_charlist(plugins_file), [plugins]) do
           :ok ->

deps/rabbitmq_cli/test/plugins/list_plugins_command_test.exs

@@ -7,6 +7,7 @@
 defmodule ListPluginsCommandTest do
   use ExUnit.Case, async: false
   import TestHelper
+  import ExUnit.CaptureIO
 
   @command RabbitMQ.CLI.Plugins.Commands.ListCommand
 
@@ -444,4 +445,126 @@ defmodule ListPluginsCommandTest do
 
     assert_plugin_states(actual_plugins2, expected_plugins2)
   end
+
+  test "run: lists all plugins with missing plugins warning control using --silent", context do
+    opts =
+      context[:opts]
+      |> Map.put_new(:silent, true)
+      |> Map.put_new(:hard_write, true)
+
+    context = Map.replace(context, :opts, opts)
+
+    missing_plugin = :rabbitmq_non_existent
+
+    reset_enabled_plugins_to_preconfigured_defaults(context)
+
+    set_enabled_plugins(
+      [:rabbitmq_federation, missing_plugin],
+      :online,
+      context[:opts][:node],
+      context[:opts]
+    )
+
+    on_exit(fn ->
+      opts =
+        context[:opts]
+        |> Map.delete(:silent)
+        |> Map.delete(:hard_write)
+
+      context = Map.replace(context, :opts, opts)
+
+      set_enabled_plugins(
+        [:rabbitmq_stomp, :rabbitmq_federation],
+        :online,
+        context[:opts][:node],
+        context[:opts]
+      )
+    end)
+
+    expected_plugins = [
+      %{name: :rabbitmq_federation, enabled: :enabled, running: true},
+      %{name: :rabbitmq_stomp, enabled: :not_enabled, running: false}
+    ]
+
+    opts = context[:opts]
+
+    assert capture_io(fn ->
+             %{
+               plugins: actual_plugins
+             } = @command.run([".*"], opts)
+
+             assert_plugin_states(actual_plugins, expected_plugins)
+           end) =~ ~s//
+
+    opts = Map.replace(opts, :silent, false)
+
+    assert capture_io(fn ->
+             %{
+               plugins: actual_plugins
+             } = @command.run([".*"], opts)
+
+             assert_plugin_states(actual_plugins, expected_plugins)
+           end) =~ ~s/WARNING - plugins currently enabled but missing: #{missing_plugin}\n/
+  end
+
+  test "run: lists all plugins with missing plugins warning control using --quiet", context do
+    opts =
+      context[:opts]
+      |> Map.put_new(:quiet, true)
+      |> Map.put_new(:hard_write, true)
+
+    context = Map.replace(context, :opts, opts)
+
+    missing_plugin = :rabbitmq_non_existent
+
+    reset_enabled_plugins_to_preconfigured_defaults(context)
+
+    set_enabled_plugins(
+      [:rabbitmq_federation, missing_plugin],
+      :online,
+      context[:opts][:node],
+      context[:opts]
+    )
+
+    on_exit(fn ->
+      opts =
+        context[:opts]
+        |> Map.delete(:quiet)
+        |> Map.delete(:hard_write)
+
+      context = Map.replace(context, :opts, opts)
+
+      set_enabled_plugins(
+        [:rabbitmq_stomp, :rabbitmq_federation],
+        :online,
+        context[:opts][:node],
+        context[:opts]
+      )
+    end)
+
+    expected_plugins = [
+      %{name: :rabbitmq_federation, enabled: :enabled, running: true},
+      %{name: :rabbitmq_stomp, enabled: :not_enabled, running: false}
+    ]
+
+    opts = context[:opts]
+
+    assert capture_io(fn ->
+             %{
+               plugins: actual_plugins
+             } = @command.run([".*"], opts)
+
+             assert_plugin_states(actual_plugins, expected_plugins)
+           end) =~ ~s//
+
+    opts = Map.replace(opts, :quiet, false)
+
+    assert capture_io(fn ->
+             %{
+               plugins: actual_plugins
+             } = @command.run([".*"], opts)
+
+             assert_plugin_states(actual_plugins, expected_plugins)
+           end) =~ ~s/WARNING - plugins currently enabled but missing: #{missing_plugin}\n/
+  end
 end