GRM-15: feat: add lifecycle CLI commands and RunnerManager extensions
- Add start, stop, enable, disable, status, remove methods to RunnerManager - Add corresponding CLI subcommands: grm start/stop/enable/disable/status/remove - Add i18n translations for lifecycle commands across all supported languages - Add comprehensive unit tests for lifecycle methods and CLI commands - Fix environment variable leakage in CLI tests for GITEA_URL
This commit is contained in:
Emil Simeonov
@@ -222,3 +222,195 @@ class TestCLI:
|
||||
result = runner.invoke(cli, ["update", "host1", "--user", "ubuntu"])
|
||||
assert result.exit_code != 0
|
||||
assert "fail" in result.output
|
||||
|
||||
@patch("gitea_runner_manager.cli.RunnerManager")
|
||||
def test_start(self, mock_manager_class: MagicMock) -> None:
|
||||
mock_manager = MagicMock()
|
||||
mock_manager_class.return_value = mock_manager
|
||||
|
||||
runner = CliRunner()
|
||||
result = runner.invoke(cli, ["start", "host1", "--user", "ubuntu", "--name", "r1"])
|
||||
assert result.exit_code == 0
|
||||
mock_manager.start.assert_called_once_with(
|
||||
host="host1",
|
||||
user="ubuntu",
|
||||
name="r1",
|
||||
mode="docker",
|
||||
ask_become_pass=False,
|
||||
)
|
||||
|
||||
@patch("gitea_runner_manager.cli.RunnerManager")
|
||||
def test_stop(self, mock_manager_class: MagicMock) -> None:
|
||||
mock_manager = MagicMock()
|
||||
mock_manager_class.return_value = mock_manager
|
||||
|
||||
runner = CliRunner()
|
||||
result = runner.invoke(cli, ["stop", "host1", "--user", "ubuntu", "--name", "r1"])
|
||||
assert result.exit_code == 0
|
||||
mock_manager.stop.assert_called_once_with(
|
||||
host="host1",
|
||||
user="ubuntu",
|
||||
name="r1",
|
||||
ask_become_pass=False,
|
||||
)
|
||||
|
||||
@patch("gitea_runner_manager.cli.RunnerManager")
|
||||
def test_enable(self, mock_manager_class: MagicMock) -> None:
|
||||
mock_manager = MagicMock()
|
||||
mock_manager_class.return_value = mock_manager
|
||||
|
||||
runner = CliRunner()
|
||||
result = runner.invoke(cli, ["enable", "host1", "--user", "ubuntu", "--name", "r1"])
|
||||
assert result.exit_code == 0
|
||||
mock_manager.enable.assert_called_once_with(
|
||||
host="host1",
|
||||
user="ubuntu",
|
||||
name="r1",
|
||||
ask_become_pass=False,
|
||||
)
|
||||
|
||||
@patch("gitea_runner_manager.cli.RunnerManager")
|
||||
def test_disable(self, mock_manager_class: MagicMock) -> None:
|
||||
mock_manager = MagicMock()
|
||||
mock_manager_class.return_value = mock_manager
|
||||
|
||||
runner = CliRunner(env={"GITEA_URL": "https://git.example.com"})
|
||||
result = runner.invoke(cli, ["disable", "host1", "--user", "ubuntu", "--name", "r1", "--token", "tok"])
|
||||
assert result.exit_code == 0
|
||||
mock_manager.disable.assert_called_once_with(
|
||||
host="host1",
|
||||
user="ubuntu",
|
||||
name="r1",
|
||||
token="tok",
|
||||
gitea_url="https://git.example.com",
|
||||
mode="docker",
|
||||
ask_become_pass=False,
|
||||
)
|
||||
|
||||
@patch("gitea_runner_manager.cli.RunnerManager")
|
||||
def test_disable_missing_url(self, mock_manager_class: MagicMock) -> None:
|
||||
with patch.dict("os.environ", {"GITEA_REGISTRATION_TOKEN": "tok"}, clear=True):
|
||||
runner = CliRunner()
|
||||
result = runner.invoke(cli, ["disable", "host1", "--user", "ubuntu", "--token", "tok"])
|
||||
assert result.exit_code != 0
|
||||
assert "GITEA_URL must be set" in result.output
|
||||
|
||||
@patch("gitea_runner_manager.cli.RunnerManager")
|
||||
def test_disable_error(self, mock_manager_class: MagicMock) -> None:
|
||||
mock_manager = MagicMock()
|
||||
from gitea_runner_manager.exceptions import AnsibleError
|
||||
|
||||
mock_manager.disable.side_effect = AnsibleError("fail")
|
||||
mock_manager_class.return_value = mock_manager
|
||||
|
||||
runner = CliRunner(env={"GITEA_URL": "https://git.example.com"})
|
||||
result = runner.invoke(cli, ["disable", "host1", "--user", "ubuntu", "--token", "tok"])
|
||||
assert result.exit_code != 0
|
||||
assert "fail" in result.output
|
||||
|
||||
@patch("gitea_runner_manager.cli.RunnerManager")
|
||||
def test_status(self, mock_manager_class: MagicMock) -> None:
|
||||
mock_manager = MagicMock()
|
||||
mock_manager_class.return_value = mock_manager
|
||||
|
||||
runner = CliRunner()
|
||||
result = runner.invoke(cli, ["status", "host1", "--user", "ubuntu", "--name", "r1"])
|
||||
assert result.exit_code == 0
|
||||
mock_manager.status.assert_called_once_with(
|
||||
host="host1",
|
||||
user="ubuntu",
|
||||
name="r1",
|
||||
mode="docker",
|
||||
ask_become_pass=False,
|
||||
)
|
||||
|
||||
@patch("gitea_runner_manager.cli.RunnerManager")
|
||||
def test_remove(self, mock_manager_class: MagicMock) -> None:
|
||||
mock_manager = MagicMock()
|
||||
mock_manager_class.return_value = mock_manager
|
||||
|
||||
runner = CliRunner(env={"GITEA_URL": "https://git.example.com"})
|
||||
result = runner.invoke(cli, ["remove", "host1", "--user", "ubuntu", "--name", "r1", "--token", "tok"])
|
||||
assert result.exit_code == 0
|
||||
mock_manager.remove.assert_called_once_with(
|
||||
host="host1",
|
||||
user="ubuntu",
|
||||
name="r1",
|
||||
token="tok",
|
||||
gitea_url="https://git.example.com",
|
||||
mode="docker",
|
||||
ask_become_pass=False,
|
||||
)
|
||||
|
||||
@patch("gitea_runner_manager.cli.RunnerManager")
|
||||
def test_start_error(self, mock_manager_class: MagicMock) -> None:
|
||||
mock_manager = MagicMock()
|
||||
from gitea_runner_manager.exceptions import AnsibleError
|
||||
|
||||
mock_manager.start.side_effect = AnsibleError("fail")
|
||||
mock_manager_class.return_value = mock_manager
|
||||
|
||||
runner = CliRunner()
|
||||
result = runner.invoke(cli, ["start", "host1", "--user", "ubuntu"])
|
||||
assert result.exit_code != 0
|
||||
assert "fail" in result.output
|
||||
|
||||
@patch("gitea_runner_manager.cli.RunnerManager")
|
||||
def test_stop_error(self, mock_manager_class: MagicMock) -> None:
|
||||
mock_manager = MagicMock()
|
||||
from gitea_runner_manager.exceptions import AnsibleError
|
||||
|
||||
mock_manager.stop.side_effect = AnsibleError("fail")
|
||||
mock_manager_class.return_value = mock_manager
|
||||
|
||||
runner = CliRunner()
|
||||
result = runner.invoke(cli, ["stop", "host1", "--user", "ubuntu"])
|
||||
assert result.exit_code != 0
|
||||
assert "fail" in result.output
|
||||
|
||||
@patch("gitea_runner_manager.cli.RunnerManager")
|
||||
def test_enable_error(self, mock_manager_class: MagicMock) -> None:
|
||||
mock_manager = MagicMock()
|
||||
from gitea_runner_manager.exceptions import AnsibleError
|
||||
|
||||
mock_manager.enable.side_effect = AnsibleError("fail")
|
||||
mock_manager_class.return_value = mock_manager
|
||||
|
||||
runner = CliRunner()
|
||||
result = runner.invoke(cli, ["enable", "host1", "--user", "ubuntu"])
|
||||
assert result.exit_code != 0
|
||||
assert "fail" in result.output
|
||||
|
||||
@patch("gitea_runner_manager.cli.RunnerManager")
|
||||
def test_status_error(self, mock_manager_class: MagicMock) -> None:
|
||||
mock_manager = MagicMock()
|
||||
from gitea_runner_manager.exceptions import AnsibleError
|
||||
|
||||
mock_manager.status.side_effect = AnsibleError("fail")
|
||||
mock_manager_class.return_value = mock_manager
|
||||
|
||||
runner = CliRunner()
|
||||
result = runner.invoke(cli, ["status", "host1", "--user", "ubuntu"])
|
||||
assert result.exit_code != 0
|
||||
assert "fail" in result.output
|
||||
|
||||
@patch("gitea_runner_manager.cli.RunnerManager")
|
||||
def test_remove_missing_url(self, mock_manager_class: MagicMock) -> None:
|
||||
with patch.dict("os.environ", {"GITEA_REGISTRATION_TOKEN": "tok"}, clear=True):
|
||||
runner = CliRunner()
|
||||
result = runner.invoke(cli, ["remove", "host1", "--user", "ubuntu", "--token", "tok"])
|
||||
assert result.exit_code != 0
|
||||
assert "GITEA_URL must be set" in result.output
|
||||
|
||||
@patch("gitea_runner_manager.cli.RunnerManager")
|
||||
def test_remove_error(self, mock_manager_class: MagicMock) -> None:
|
||||
mock_manager = MagicMock()
|
||||
from gitea_runner_manager.exceptions import AnsibleError
|
||||
|
||||
mock_manager.remove.side_effect = AnsibleError("fail")
|
||||
mock_manager_class.return_value = mock_manager
|
||||
|
||||
runner = CliRunner(env={"GITEA_URL": "https://git.example.com"})
|
||||
result = runner.invoke(cli, ["remove", "host1", "--user", "ubuntu", "--token", "tok"])
|
||||
assert result.exit_code != 0
|
||||
assert "fail" in result.output
|
||||
|
||||
@@ -152,6 +152,146 @@ class TestRunnerManager:
|
||||
with pytest.raises(AnsibleError, match="Ansible failed with exit code 2"):
|
||||
manager.update("host", "user")
|
||||
|
||||
def test_start(self) -> None:
|
||||
manager = RunnerManager()
|
||||
mock_executor = MagicMock()
|
||||
manager._executor = mock_executor
|
||||
|
||||
manager.start("host", "user", name="r1", mode="docker")
|
||||
cmd = mock_executor.run.call_args.args[0]
|
||||
cmd_str = " ".join(cmd)
|
||||
assert "start-runner.yml" in cmd_str
|
||||
assert "runner_name=r1" in cmd_str
|
||||
assert "runner_mode=docker" in cmd_str
|
||||
assert "Starting Gitea Runner r1 on host" in mock_executor.run.call_args.kwargs["description"]
|
||||
|
||||
def test_start_default_name(self) -> None:
|
||||
manager = RunnerManager()
|
||||
mock_executor = MagicMock()
|
||||
manager._executor = mock_executor
|
||||
|
||||
manager.start("myhost", "user")
|
||||
cmd = mock_executor.run.call_args.args[0]
|
||||
cmd_str = " ".join(cmd)
|
||||
assert "runner_name=myhost" in cmd_str
|
||||
|
||||
def test_stop(self) -> None:
|
||||
manager = RunnerManager()
|
||||
mock_executor = MagicMock()
|
||||
manager._executor = mock_executor
|
||||
|
||||
manager.stop("host", "user", name="r1")
|
||||
cmd = mock_executor.run.call_args.args[0]
|
||||
cmd_str = " ".join(cmd)
|
||||
assert "stop-runner.yml" in cmd_str
|
||||
assert "runner_name=r1" in cmd_str
|
||||
assert "Stopping Gitea Runner r1 on host" in mock_executor.run.call_args.kwargs["description"]
|
||||
|
||||
def test_enable(self) -> None:
|
||||
manager = RunnerManager()
|
||||
mock_executor = MagicMock()
|
||||
manager._executor = mock_executor
|
||||
|
||||
manager.enable("host", "user", name="r1")
|
||||
cmd = mock_executor.run.call_args.args[0]
|
||||
cmd_str = " ".join(cmd)
|
||||
assert "enable-runner.yml" in cmd_str
|
||||
assert "runner_name=r1" in cmd_str
|
||||
assert "Enabling Gitea Runner r1 on host" in mock_executor.run.call_args.kwargs["description"]
|
||||
|
||||
def test_disable(self) -> None:
|
||||
manager = RunnerManager()
|
||||
mock_executor = MagicMock()
|
||||
manager._executor = mock_executor
|
||||
|
||||
manager.disable("host", "user", name="r1", token="tok", gitea_url="https://git.example.com", mode="docker")
|
||||
cmd = mock_executor.run.call_args.args[0]
|
||||
cmd_str = " ".join(cmd)
|
||||
assert "disable-runner.yml" in cmd_str
|
||||
assert "runner_name=r1" in cmd_str
|
||||
assert "registration_token=tok" in cmd_str
|
||||
assert "gitea_url=https://git.example.com" in cmd_str
|
||||
assert "runner_mode=docker" in cmd_str
|
||||
assert "Disabling Gitea Runner r1 on host" in mock_executor.run.call_args.kwargs["description"]
|
||||
|
||||
def test_disable_missing_token(self) -> None:
|
||||
manager = RunnerManager()
|
||||
with pytest.raises(AnsibleError, match="GITEA_REGISTRATION_TOKEN must be set"):
|
||||
manager.disable("host", "user", name="r1")
|
||||
|
||||
def test_status(self) -> None:
|
||||
manager = RunnerManager()
|
||||
mock_executor = MagicMock()
|
||||
manager._executor = mock_executor
|
||||
|
||||
manager.status("host", "user", name="r1", mode="binary")
|
||||
cmd = mock_executor.run.call_args.args[0]
|
||||
cmd_str = " ".join(cmd)
|
||||
assert "status-runner.yml" in cmd_str
|
||||
assert "runner_name=r1" in cmd_str
|
||||
assert "runner_mode=binary" in cmd_str
|
||||
assert "Checking status of Gitea Runner r1 on host" in mock_executor.run.call_args.kwargs["description"]
|
||||
|
||||
def test_remove(self) -> None:
|
||||
manager = RunnerManager()
|
||||
mock_executor = MagicMock()
|
||||
manager._executor = mock_executor
|
||||
|
||||
manager.remove("host", "user", name="r1", token="tok", gitea_url="https://git.example.com", mode="docker")
|
||||
cmd = mock_executor.run.call_args.args[0]
|
||||
cmd_str = " ".join(cmd)
|
||||
assert "remove-runner.yml" in cmd_str
|
||||
assert "runner_name=r1" in cmd_str
|
||||
assert "registration_token=tok" in cmd_str
|
||||
assert "gitea_url=https://git.example.com" in cmd_str
|
||||
assert "runner_mode=docker" in cmd_str
|
||||
assert "Removing Gitea Runner r1 from host" in mock_executor.run.call_args.kwargs["description"]
|
||||
|
||||
def test_remove_missing_token(self) -> None:
|
||||
manager = RunnerManager()
|
||||
with pytest.raises(AnsibleError, match="GITEA_REGISTRATION_TOKEN must be set"):
|
||||
manager.remove("host", "user", name="r1")
|
||||
|
||||
def test_stop_default_name(self) -> None:
|
||||
manager = RunnerManager()
|
||||
mock_executor = MagicMock()
|
||||
manager._executor = mock_executor
|
||||
manager.stop("myhost", "user")
|
||||
cmd = mock_executor.run.call_args.args[0]
|
||||
assert "runner_name=myhost" in " ".join(cmd)
|
||||
|
||||
def test_enable_default_name(self) -> None:
|
||||
manager = RunnerManager()
|
||||
mock_executor = MagicMock()
|
||||
manager._executor = mock_executor
|
||||
manager.enable("myhost", "user")
|
||||
cmd = mock_executor.run.call_args.args[0]
|
||||
assert "runner_name=myhost" in " ".join(cmd)
|
||||
|
||||
def test_disable_default_name(self) -> None:
|
||||
manager = RunnerManager()
|
||||
mock_executor = MagicMock()
|
||||
manager._executor = mock_executor
|
||||
manager.disable("myhost", "user", token="tok")
|
||||
cmd = mock_executor.run.call_args.args[0]
|
||||
assert "runner_name=myhost" in " ".join(cmd)
|
||||
|
||||
def test_status_default_name(self) -> None:
|
||||
manager = RunnerManager()
|
||||
mock_executor = MagicMock()
|
||||
manager._executor = mock_executor
|
||||
manager.status("myhost", "user")
|
||||
cmd = mock_executor.run.call_args.args[0]
|
||||
assert "runner_name=myhost" in " ".join(cmd)
|
||||
|
||||
def test_remove_default_name(self) -> None:
|
||||
manager = RunnerManager()
|
||||
mock_executor = MagicMock()
|
||||
manager._executor = mock_executor
|
||||
manager.remove("myhost", "user", token="tok")
|
||||
cmd = mock_executor.run.call_args.args[0]
|
||||
assert "runner_name=myhost" in " ".join(cmd)
|
||||
|
||||
|
||||
class TestBuildCmd:
|
||||
def test_build_cmd_basic(self) -> None:
|
||||
|
||||
Reference in New Issue
Block a user