diff options
author | Loïc Hoguin <lhoguin@vmware.com> | 2021-03-03 11:28:54 +0100 |
---|---|---|
committer | Loïc Hoguin <lhoguin@vmware.com> | 2021-03-03 11:28:54 +0100 |
commit | 5c829ff599f1e50292744d21935d66a395fa232e (patch) | |
tree | 533e90500c63c836a833191efa2e82a32758337b | |
parent | 4bc2bb00de990eb76d59c61bb3855d5e2fe98b60 (diff) | |
download | rabbitmq-server-git-5c829ff599f1e50292744d21935d66a395fa232e.tar.gz |
Add rabbitmq-diagnostics remote_shell
-rw-r--r-- | deps/rabbitmq_cli/lib/rabbitmq/cli/diagnostics/commands/remote_shell_command.ex | 38 | ||||
-rw-r--r-- | deps/rabbitmq_cli/test/diagnostics/remote_shell_command_test.exs | 40 |
2 files changed, 78 insertions, 0 deletions
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/diagnostics/commands/remote_shell_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/diagnostics/commands/remote_shell_command.ex new file mode 100644 index 0000000000..bd4a04d75c --- /dev/null +++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/diagnostics/commands/remote_shell_command.ex @@ -0,0 +1,38 @@ +## 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-2021 VMware, Inc. or its affiliates. All rights reserved. + +defmodule RabbitMQ.CLI.Diagnostics.Commands.RemoteShellCommand do + @behaviour RabbitMQ.CLI.CommandBehaviour + use RabbitMQ.CLI.DefaultOutput + + def merge_defaults(args, opts) do + {args, opts} + end + + + use RabbitMQ.CLI.Core.AcceptsNoPositionalArguments + + def run([], %{node: node_name}) do + _ = Supervisor.terminate_child(:kernel_sup, :user) + Process.flag(:trap_exit, true) + user_drv = :user_drv.start(['tty_sl -c -e', {node_name, :shell, :start, []}]) + Process.link(user_drv) + receive do + {'EXIT', user_drv, _} -> + {:ok, "Disconnected from #{node_name}."} + end + end + + def help_section(), do: :observability_and_health_checks + + def description(), do: "Starts a shell on the target node" + + def usage, do: "remote_shell" + + def banner(_, %{node: node_name}) do + "Starting a shell on node #{node_name}... Press 'Ctrl+G' then 'q' to exit." + end +end diff --git a/deps/rabbitmq_cli/test/diagnostics/remote_shell_command_test.exs b/deps/rabbitmq_cli/test/diagnostics/remote_shell_command_test.exs new file mode 100644 index 0000000000..ad03cd06f4 --- /dev/null +++ b/deps/rabbitmq_cli/test/diagnostics/remote_shell_command_test.exs @@ -0,0 +1,40 @@ +## 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-2020 VMware, Inc. or its affiliates. All rights reserved. + + +defmodule RemoteShellCommandTest do + use ExUnit.Case, async: false + import TestHelper + + @command RabbitMQ.CLI.Diagnostics.Commands.RemoteShellCommand + + setup_all do + RabbitMQ.CLI.Core.Distribution.start() + + :ok + end + + setup context do + {:ok, opts: %{ + node: get_rabbit_hostname(), + timeout: context[:test_timeout] || 15000 + }} + 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 + + # Unreachable nodes will leave the remote_shell open with an error. +end |