- 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
326 lines
13 KiB
Python
326 lines
13 KiB
Python
"""Unit tests for runner_manager module."""
|
|
|
|
from pathlib import Path
|
|
from unittest.mock import MagicMock, patch
|
|
|
|
import pytest
|
|
|
|
from gitea_runner_manager.exceptions import AnsibleError
|
|
from gitea_runner_manager.runner_manager import RunnerManager
|
|
|
|
|
|
class TestRunnerManager:
|
|
def test_init(self) -> None:
|
|
manager = RunnerManager()
|
|
assert manager is not None
|
|
assert manager._executor is not None
|
|
|
|
def test_install_basic(self) -> None:
|
|
manager = RunnerManager()
|
|
mock_executor = MagicMock()
|
|
manager._executor = mock_executor
|
|
|
|
manager.install("192.168.1.10", "ubuntu", token="tok", gitea_url="https://git.example.com")
|
|
mock_executor.run.assert_called_once()
|
|
cmd = mock_executor.run.call_args.args[0]
|
|
cmd_str = " ".join(cmd)
|
|
assert "ansible-playbook" in cmd_str
|
|
assert "192.168.1.10," in cmd_str
|
|
assert "-u" in cmd_str
|
|
assert "ubuntu" in cmd_str
|
|
assert "registration_token=tok" in cmd_str
|
|
assert "runner_name=192.168.1.10" in cmd_str
|
|
assert "gitea_url=https://git.example.com" in cmd_str
|
|
assert "runner_mode=docker" in cmd_str
|
|
assert "Installing Gitea Runner on 192.168.1.10" in mock_executor.run.call_args.kwargs["description"]
|
|
|
|
def test_install_with_name_and_key(self) -> None:
|
|
manager = RunnerManager()
|
|
mock_executor = MagicMock()
|
|
manager._executor = mock_executor
|
|
|
|
manager.install(
|
|
"host1", "root", key="/key", name="my-runner", token="preset", gitea_url="https://git.example.com"
|
|
)
|
|
cmd = mock_executor.run.call_args.args[0]
|
|
cmd_str = " ".join(cmd)
|
|
assert "--private-key" in cmd_str
|
|
assert "/key" in cmd_str
|
|
assert "registration_token=preset" in cmd_str
|
|
assert "runner_name=my-runner" in cmd_str
|
|
assert "runner_mode=docker" in cmd_str
|
|
assert "--ask-become-pass" not in cmd_str
|
|
|
|
def test_install_ask_become_pass(self) -> None:
|
|
manager = RunnerManager()
|
|
mock_executor = MagicMock()
|
|
manager._executor = mock_executor
|
|
|
|
manager.install("host1", "root", token="tok", gitea_url="https://git.example.com", ask_become_pass=True)
|
|
cmd = mock_executor.run.call_args.args[0]
|
|
cmd_str = " ".join(cmd)
|
|
assert "--ask-become-pass" in cmd_str
|
|
assert "runner_mode=docker" in cmd_str
|
|
|
|
def test_install_binary_mode(self) -> None:
|
|
manager = RunnerManager()
|
|
mock_executor = MagicMock()
|
|
manager._executor = mock_executor
|
|
|
|
manager.install("host1", "root", token="tok", gitea_url="https://git.example.com", mode="binary")
|
|
cmd = mock_executor.run.call_args.args[0]
|
|
cmd_str = " ".join(cmd)
|
|
assert "runner_mode=binary" in cmd_str
|
|
|
|
def test_install_missing_token(self) -> None:
|
|
manager = RunnerManager()
|
|
with pytest.raises(AnsibleError, match="GITEA_REGISTRATION_TOKEN must be set"):
|
|
manager.install("host", "user", gitea_url="https://git.example.com")
|
|
|
|
def test_install_playbook_not_found(self) -> None:
|
|
manager = RunnerManager()
|
|
with patch.object(Path, "exists", return_value=False):
|
|
with pytest.raises(AnsibleError, match="Playbook not found"):
|
|
manager.install("host", "user", token="tok")
|
|
|
|
def test_install_with_admin_token(self) -> None:
|
|
manager = RunnerManager()
|
|
mock_executor = MagicMock()
|
|
manager._executor = mock_executor
|
|
|
|
manager.install("host1", "root", token="tok", gitea_url="https://git.example.com", admin_token="admin-tok")
|
|
cmd = mock_executor.run.call_args.args[0]
|
|
cmd_str = " ".join(cmd)
|
|
assert "gitea_admin_token=admin-tok" in cmd_str
|
|
|
|
def test_install_ansible_failure(self) -> None:
|
|
manager = RunnerManager()
|
|
mock_executor = MagicMock()
|
|
manager._executor = mock_executor
|
|
mock_executor.run.side_effect = AnsibleError("Ansible failed with exit code 1. See full log: /tmp/test.log")
|
|
with pytest.raises(AnsibleError, match="Ansible failed with exit code 1"):
|
|
manager.install("host", "user", token="tok")
|
|
|
|
def test_update(self) -> None:
|
|
manager = RunnerManager()
|
|
mock_executor = MagicMock()
|
|
manager._executor = mock_executor
|
|
|
|
manager.update("host", "user", key="/key", version="v0.2.0")
|
|
cmd = mock_executor.run.call_args.args[0]
|
|
cmd_str = " ".join(cmd)
|
|
assert "update-runner.yml" in cmd_str
|
|
assert "--private-key" in cmd_str
|
|
assert "/key" in cmd_str
|
|
assert "gitea_runner_version=v0.2.0" in cmd_str
|
|
assert "runner_mode=docker" in cmd_str
|
|
assert "--ask-become-pass" not in cmd_str
|
|
assert "Updating Gitea Runner on host" in mock_executor.run.call_args.kwargs["description"]
|
|
|
|
def test_update_ask_become_pass(self) -> None:
|
|
manager = RunnerManager()
|
|
mock_executor = MagicMock()
|
|
manager._executor = mock_executor
|
|
|
|
manager.update("host", "user", ask_become_pass=True)
|
|
cmd = mock_executor.run.call_args.args[0]
|
|
cmd_str = " ".join(cmd)
|
|
assert "--ask-become-pass" in cmd_str
|
|
assert "runner_mode=docker" in cmd_str
|
|
|
|
def test_update_binary_mode(self) -> None:
|
|
manager = RunnerManager()
|
|
mock_executor = MagicMock()
|
|
manager._executor = mock_executor
|
|
|
|
manager.update("host", "user", mode="binary")
|
|
cmd = mock_executor.run.call_args.args[0]
|
|
cmd_str = " ".join(cmd)
|
|
assert "runner_mode=binary" in cmd_str
|
|
|
|
def test_update_playbook_not_found(self) -> None:
|
|
manager = RunnerManager()
|
|
with patch.object(Path, "exists", return_value=False):
|
|
with pytest.raises(AnsibleError, match="Playbook not found"):
|
|
manager.update("host", "user")
|
|
|
|
def test_update_ansible_failure(self) -> None:
|
|
manager = RunnerManager()
|
|
mock_executor = MagicMock()
|
|
manager._executor = mock_executor
|
|
mock_executor.run.side_effect = AnsibleError("Ansible failed with exit code 2. See full log: /tmp/test.log")
|
|
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:
|
|
manager = RunnerManager()
|
|
with patch.object(Path, "exists", return_value=True):
|
|
cmd = manager._build_cmd("test.yml", "host1", "user1", "foo=bar")
|
|
cmd_str = " ".join(cmd)
|
|
assert "ansible-playbook" in cmd_str
|
|
assert "test.yml" in cmd_str
|
|
assert "host1," in cmd_str
|
|
assert "user1" in cmd_str
|
|
assert "foo=bar" in cmd_str
|
|
|
|
def test_build_cmd_with_key(self) -> None:
|
|
manager = RunnerManager()
|
|
with patch.object(Path, "exists", return_value=True):
|
|
cmd = manager._build_cmd("test.yml", "host1", "user1", "foo=bar", key="/key")
|
|
assert "--private-key" in cmd
|
|
assert "/key" in cmd
|
|
|
|
def test_build_cmd_ask_become_pass(self) -> None:
|
|
manager = RunnerManager()
|
|
with patch.object(Path, "exists", return_value=True):
|
|
cmd = manager._build_cmd("test.yml", "host1", "user1", "foo=bar", ask_become_pass=True)
|
|
assert "--ask-become-pass" in cmd
|
|
|
|
def test_build_cmd_playbook_not_found(self) -> None:
|
|
manager = RunnerManager()
|
|
with patch.object(Path, "exists", return_value=False):
|
|
with pytest.raises(AnsibleError, match="Playbook not found"):
|
|
manager._build_cmd("missing.yml", "host1", "user1", "foo=bar")
|