New health check CLI commands

(cherry picked from commit 07ec1b4)

Author: michaelklishin

deps/rabbitmq_cli/lib/rabbitmq/cli/diagnostics/commands/check_if_metadata_store_is_initialized_command.ex

@@ -0,0 +1,47 @@
+## This Source Code Form is subject to the terms of the Mozilla Public
+## License, v. 2.0. If a copy of the MPL was not distributed with this
+## file, You can obtain one at https://mozilla.org/MPL/2.0/.
+##
+## Copyright (c) 2007-2025 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.  All rights reserved.
+
+defmodule RabbitMQ.CLI.Diagnostics.Commands.CheckIfMetadataStoreIsInitializedCommand do
+  @moduledoc """
+  Exits with a non-zero code if the node reports that its metadata store
+  has finished its initialization procedure.
+
+  This command is meant to be used in health checks.
+  """
+
+  @behaviour RabbitMQ.CLI.CommandBehaviour
+
+  use RabbitMQ.CLI.Core.AcceptsDefaultSwitchesAndTimeout
+  use RabbitMQ.CLI.Core.MergesNoDefaults
+  use RabbitMQ.CLI.Core.AcceptsNoPositionalArguments
+
+  def run([], %{node: node_name, timeout: timeout}) do
+    :rabbit_misc.rpc_call(node_name, :rabbit_db, :is_init_finished, [], timeout)
+  end
+
+  def output(true, %{node: node_name} = _options) do
+    {:ok, "Metadata store on node #{node_name} has completed its initialization"}
+  end
+
+  def output(false, %{node: node_name} = _options) do
+    {:error,
+     "Metadata store on node #{node_name} reports to not yet have finished initialization"}
+  end
+
+  use RabbitMQ.CLI.DefaultOutput
+
+  def help_section(), do: :observability_and_health_checks
+
+  def description(),
+    do:
+      "Health check that exits with a non-zero code if the metadata store on target node has not yet finished initializing"
+
+  def usage, do: "check_if_metadata_store_initialized"
+
+  def banner([], %{node: node_name}) do
+    "Checking if metadata store on node #{node_name} has finished initializing ..."
+  end
+end

deps/rabbitmq_cli/lib/rabbitmq/cli/diagnostics/commands/check_if_metadata_store_is_initialized_with_data_command.ex

@@ -0,0 +1,67 @@
+## This Source Code Form is subject to the terms of the Mozilla Public
+## License, v. 2.0. If a copy of the MPL was not distributed with this
+## file, You can obtain one at https://mozilla.org/MPL/2.0/.
+##
+## Copyright (c) 2007-2025 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.  All rights reserved.
+
+defmodule RabbitMQ.CLI.Diagnostics.Commands.CheckIfMetadataStoreIsInitializedWithDataCommand do
+  @moduledoc """
+  Exits with a non-zero code if the node reports that its metadata store
+  has finished its initialization procedure.
+
+  This command is meant to be used in health checks.
+  """
+
+  @behaviour RabbitMQ.CLI.CommandBehaviour
+
+  use RabbitMQ.CLI.Core.AcceptsDefaultSwitchesAndTimeout
+  use RabbitMQ.CLI.Core.MergesNoDefaults
+  use RabbitMQ.CLI.Core.AcceptsNoPositionalArguments
+
+  def run([], %{node: node_name, timeout: timeout}) do
+    case :rabbit_misc.rpc_call(node_name, :rabbit_db, :is_init_finished, [], timeout) do
+      {:badrpc, _} = err ->
+        err
+
+      {:error, _} = err ->
+        err
+
+      {:error, _, _} = err ->
+        err
+
+      false -> false
+
+      true ->
+        case :rabbit_misc.rpc_call(node_name, :rabbit_db_vhost, :count_all, [], timeout) do
+          {:error, _} = err ->
+            err
+
+          {:ok, n} ->
+            (n > 0)
+        end
+    end
+  end
+
+  def output(true, %{node: node_name} = _options) do
+    {:ok, "Metadata store on node #{node_name} has completed its initialization"}
+  end
+
+  def output(false, %{node: node_name} = _options) do
+    {:error,
+     "Metadata store on node #{node_name} reports to not yet have finished initialization"}
+  end
+
+  use RabbitMQ.CLI.DefaultOutput
+
+  def help_section(), do: :observability_and_health_checks
+
+  def description(),
+    do:
+      "Health check that exits with a non-zero code if the metadata store on target node has not yet finished initializing"
+
+  def usage, do: "check_if_metadata_store_initialized"
+
+  def banner([], %{node: node_name}) do
+    "Checking if metadata store on node #{node_name} has finished initializing ..."
+  end
+end

deps/rabbitmq_cli/test/diagnostics/check_if_metadata_store_is_initialized_command_test.exs

@@ -0,0 +1,67 @@
+## This Source Code Form is subject to the terms of the Mozilla Public
+## License, v. 2.0. If a copy of the MPL was not distributed with this
+## file, You can obtain one at https://mozilla.org/MPL/2.0/.
+##
+## Copyright (c) 2007-2025 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.  All rights reserved.
+
+defmodule CheckIfMetadataStoreIsInitializedCommandTest do
+  use ExUnit.Case, async: false
+  import TestHelper
+
+  @command RabbitMQ.CLI.Diagnostics.Commands.CheckIfMetadataStoreIsInitializedCommand
+
+  setup_all do
+    RabbitMQ.CLI.Core.Distribution.start()
+
+    start_rabbitmq_app()
+
+    on_exit([], fn ->
+      start_rabbitmq_app()
+    end)
+
+    :ok
+  end
+
+  setup context do
+    {:ok,
+     opts: %{
+       node: get_rabbit_hostname(),
+       timeout: context[:test_timeout] || 30000
+     }}
+  end
+
+  test "merge_defaults: nothing to do" do
+    assert @command.merge_defaults([], %{}) == {[], %{}}
+  end
+
+  test "validate: treats positional arguments as a failure" do
+    assert @command.validate(["extra-arg"], %{}) == {:validation_failure, :too_many_args}
+  end
+
+  test "validate: treats empty positional arguments and default switches as a success" do
+    assert @command.validate([], %{}) == :ok
+  end
+
+  @tag test_timeout: 3000
+  test "run: targeting an unreachable node throws a badrpc", context do
+    assert match?(
+             {:badrpc, _},
+             @command.run([], Map.merge(context[:opts], %{node: :jake@thedog}))
+           )
+  end
+
+  test "run: when the RabbitMQ app is booted and started, returns true", context do
+    await_rabbitmq_startup()
+
+    assert @command.run([], context[:opts])
+  end
+
+  test "output: when the result is true, returns successfully", context do
+    assert match?({:ok, _}, @command.output(true, context[:opts]))
+  end
+
+  # this is a check command
+  test "output: when the result is false, returns an error", context do
+    assert match?({:error, _}, @command.output(false, context[:opts]))
+  end
+end

deps/rabbitmq_cli/test/diagnostics/check_if_metadata_store_is_initialized_with_data_command_test.exs

@@ -0,0 +1,67 @@
+## This Source Code Form is subject to the terms of the Mozilla Public
+## License, v. 2.0. If a copy of the MPL was not distributed with this
+## file, You can obtain one at https://mozilla.org/MPL/2.0/.
+##
+## Copyright (c) 2007-2025 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.  All rights reserved.
+
+defmodule CheckIfMetadataStoreIsInitializedWithDataCommandTest do
+  use ExUnit.Case, async: false
+  import TestHelper
+
+  @command RabbitMQ.CLI.Diagnostics.Commands.CheckIfMetadataStoreIsInitializedWithDataCommand
+
+  setup_all do
+    RabbitMQ.CLI.Core.Distribution.start()
+
+    start_rabbitmq_app()
+
+    on_exit([], fn ->
+      start_rabbitmq_app()
+    end)
+
+    :ok
+  end
+
+  setup context do
+    {:ok,
+     opts: %{
+       node: get_rabbit_hostname(),
+       timeout: context[:test_timeout] || 30000
+     }}
+  end
+
+  test "merge_defaults: nothing to do" do
+    assert @command.merge_defaults([], %{}) == {[], %{}}
+  end
+
+  test "validate: treats positional arguments as a failure" do
+    assert @command.validate(["extra-arg"], %{}) == {:validation_failure, :too_many_args}
+  end
+
+  test "validate: treats empty positional arguments and default switches as a success" do
+    assert @command.validate([], %{}) == :ok
+  end
+
+  @tag test_timeout: 3000
+  test "run: targeting an unreachable node throws a badrpc", context do
+    assert match?(
+             {:badrpc, _},
+             @command.run([], Map.merge(context[:opts], %{node: :jake@thedog}))
+           )
+  end
+
+  test "run: when the RabbitMQ app is booted and started, returns true", context do
+    await_rabbitmq_startup()
+
+    assert @command.run([], context[:opts])
+  end
+
+  test "output: when the result is true, returns successfully", context do
+    assert match?({:ok, _}, @command.output(true, context[:opts]))
+  end
+
+  # this is a check command
+  test "output: when the result is false, returns an error", context do
+    assert match?({:error, _}, @command.output(false, context[:opts]))
+  end
+end