oblachno-oss/grm
3
0
Fork 0
Code Issues 31 Pull Requests Actions Packages Projects Releases 19 Wiki Activity

GRM-9: feat: add runner registry for simplified CLI UX

Browse Source
This commit is contained in:
Emil Simeonov
2026-06-19 00:57:26 +02:00
parent a575a89026
commit 4c08606d0c
10 changed files with 869 additions and 244 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/unit/test_runner_manager.py
+177 -56
View File
@@ -14,9 +14,11 @@ class TestRunnerManager:
manager = RunnerManager()
assert manager is not None
assert manager._executor is not None
assert manager._registry is not None
def test_install_basic(self) -> None:
manager = RunnerManager()
mock_registry = MagicMock()
manager = RunnerManager(registry=mock_registry)
mock_executor = MagicMock()
manager._executor = mock_executor
@@ -33,9 +35,18 @@ class TestRunnerManager:
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"]
mock_registry.add.assert_called_once_with(
name="192.168.1.10",
host="192.168.1.10",
user="ubuntu",
key=None,
mode="docker",
gitea_url="https://git.example.com",
)
def test_install_with_name_and_key(self) -> None:
manager = RunnerManager()
mock_registry = MagicMock()
manager = RunnerManager(registry=mock_registry)
mock_executor = MagicMock()
manager._executor = mock_executor
@@ -50,9 +61,18 @@ class TestRunnerManager:
assert "runner_name=my-runner" in cmd_str
assert "runner_mode=docker" in cmd_str
assert "--ask-become-pass" not in cmd_str
mock_registry.add.assert_called_once_with(
name="my-runner",
host="host1",
user="root",
key="/key",
mode="docker",
gitea_url="https://git.example.com",
)
def test_install_ask_become_pass(self) -> None:
manager = RunnerManager()
mock_registry = MagicMock()
manager = RunnerManager(registry=mock_registry)
mock_executor = MagicMock()
manager._executor = mock_executor
@@ -63,7 +83,8 @@ class TestRunnerManager:
assert "runner_mode=docker" in cmd_str
def test_install_binary_mode(self) -> None:
manager = RunnerManager()
mock_registry = MagicMock()
manager = RunnerManager(registry=mock_registry)
mock_executor = MagicMock()
manager._executor = mock_executor
@@ -71,6 +92,9 @@ class TestRunnerManager:
cmd = mock_executor.run.call_args.args[0]
cmd_str = " ".join(cmd)
assert "runner_mode=binary" in cmd_str
mock_registry.add.assert_called_once_with(
name="host1", host="host1", user="root", key=None, mode="binary", gitea_url="https://git.example.com"
)
def test_install_missing_token(self) -> None:
manager = RunnerManager()
@@ -84,7 +108,8 @@ class TestRunnerManager:
manager.install("host", "user", token="tok")
def test_install_with_admin_token(self) -> None:
manager = RunnerManager()
mock_registry = MagicMock()
manager = RunnerManager(registry=mock_registry)
mock_executor = MagicMock()
manager._executor = mock_executor
@@ -94,12 +119,14 @@ class TestRunnerManager:
assert "gitea_admin_token=admin-tok" in cmd_str
def test_install_ansible_failure(self) -> None:
manager = RunnerManager()
mock_registry = MagicMock()
manager = RunnerManager(registry=mock_registry)
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")
mock_registry.add.assert_not_called()
def test_update(self) -> None:
manager = RunnerManager()
@@ -152,12 +179,52 @@ class TestRunnerManager:
with pytest.raises(AnsibleError, match="Ansible failed with exit code 2"):
manager.update("host", "user")
def test_resolve_runner_from_registry(self) -> None:
mock_registry = MagicMock()
mock_registry.get.return_value = {"host": "10.0.0.1", "user": "ubuntu", "key": "/key", "mode": "docker"}
manager = RunnerManager(registry=mock_registry)
host, user, key, mode = manager._resolve_runner("r1")
assert host == "10.0.0.1"
assert user == "ubuntu"
assert key == "/key"
assert mode == "docker"
mock_registry.get.assert_called_once_with("r1")
def test_resolve_runner_explicit_host_user(self) -> None:
mock_registry = MagicMock()
mock_registry.get.return_value = None
manager = RunnerManager(registry=mock_registry)
host, user, key, mode = manager._resolve_runner("r1", host="10.0.0.2", user="root")
assert host == "10.0.0.2"
assert user == "root"
assert key is None
assert mode == "docker"
def test_resolve_runner_override(self) -> None:
mock_registry = MagicMock()
mock_registry.get.return_value = {"host": "10.0.0.1", "user": "ubuntu", "key": "/key", "mode": "docker"}
manager = RunnerManager(registry=mock_registry)
host, user, key, mode = manager._resolve_runner("r1", host="10.0.0.2", user="root", key="/new", mode="binary")
assert host == "10.0.0.2"
assert user == "root"
assert key == "/new"
assert mode == "binary"
def test_resolve_runner_not_found(self) -> None:
mock_registry = MagicMock()
mock_registry.get.return_value = None
manager = RunnerManager(registry=mock_registry)
with pytest.raises(AnsibleError, match="not found in registry"):
manager._resolve_runner("missing")
def test_start(self) -> None:
manager = RunnerManager()
mock_registry = MagicMock()
mock_registry.get.return_value = {"host": "host", "user": "user", "key": None, "mode": "docker"}
manager = RunnerManager(registry=mock_registry)
mock_executor = MagicMock()
manager._executor = mock_executor
manager.start("host", "user", name="r1", mode="docker")
manager.start("r1")
cmd = mock_executor.run.call_args.args[0]
cmd_str = " ".join(cmd)
assert "start-runner.yml" in cmd_str
@@ -165,22 +232,40 @@ class TestRunnerManager:
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()
def test_start_with_override(self) -> None:
mock_registry = MagicMock()
mock_registry.get.return_value = {"host": "host", "user": "user", "key": None, "mode": "docker"}
manager = RunnerManager(registry=mock_registry)
mock_executor = MagicMock()
manager._executor = mock_executor
manager.start("myhost", "user")
manager.start("r1", host="newhost", user="newuser", mode="binary")
cmd = mock_executor.run.call_args.args[0]
cmd_str = " ".join(cmd)
assert "runner_name=myhost" in cmd_str
assert "newhost," in cmd_str
assert "newuser" in cmd_str
assert "runner_mode=binary" in cmd_str
def test_stop(self) -> None:
manager = RunnerManager()
def test_start_no_registry_with_explicit(self) -> None:
mock_registry = MagicMock()
mock_registry.get.return_value = None
manager = RunnerManager(registry=mock_registry)
mock_executor = MagicMock()
manager._executor = mock_executor
manager.stop("host", "user", name="r1")
manager.start("r1", host="host", user="user", mode="docker")
cmd = mock_executor.run.call_args.args[0]
cmd_str = " ".join(cmd)
assert "start-runner.yml" in cmd_str
def test_stop(self) -> None:
mock_registry = MagicMock()
mock_registry.get.return_value = {"host": "host", "user": "user", "key": None, "mode": "docker"}
manager = RunnerManager(registry=mock_registry)
mock_executor = MagicMock()
manager._executor = mock_executor
manager.stop("r1")
cmd = mock_executor.run.call_args.args[0]
cmd_str = " ".join(cmd)
assert "stop-runner.yml" in cmd_str
@@ -188,11 +273,13 @@ class TestRunnerManager:
assert "Stopping Gitea Runner r1 on host" in mock_executor.run.call_args.kwargs["description"]
def test_enable(self) -> None:
manager = RunnerManager()
mock_registry = MagicMock()
mock_registry.get.return_value = {"host": "host", "user": "user", "key": None, "mode": "docker"}
manager = RunnerManager(registry=mock_registry)
mock_executor = MagicMock()
manager._executor = mock_executor
manager.enable("host", "user", name="r1")
manager.enable("r1")
cmd = mock_executor.run.call_args.args[0]
cmd_str = " ".join(cmd)
assert "enable-runner.yml" in cmd_str
@@ -200,11 +287,13 @@ class TestRunnerManager:
assert "Enabling Gitea Runner r1 on host" in mock_executor.run.call_args.kwargs["description"]
def test_disable(self) -> None:
manager = RunnerManager()
mock_registry = MagicMock()
mock_registry.get.return_value = {"host": "host", "user": "user", "key": None, "mode": "docker"}
manager = RunnerManager(registry=mock_registry)
mock_executor = MagicMock()
manager._executor = mock_executor
manager.disable("host", "user", name="r1", token="tok", gitea_url="https://git.example.com", mode="docker")
manager.disable("r1", token="tok", gitea_url="https://git.example.com")
cmd = mock_executor.run.call_args.args[0]
cmd_str = " ".join(cmd)
assert "disable-runner.yml" in cmd_str
@@ -215,16 +304,20 @@ class TestRunnerManager:
assert "Disabling Gitea Runner r1 on host" in mock_executor.run.call_args.kwargs["description"]
def test_disable_missing_token(self) -> None:
manager = RunnerManager()
mock_registry = MagicMock()
mock_registry.get.return_value = {"host": "host", "user": "user"}
manager = RunnerManager(registry=mock_registry)
with pytest.raises(AnsibleError, match="GITEA_REGISTRATION_TOKEN must be set"):
manager.disable("host", "user", name="r1")
manager.disable("r1")
def test_status(self) -> None:
manager = RunnerManager()
mock_registry = MagicMock()
mock_registry.get.return_value = {"host": "host", "user": "user", "key": None, "mode": "binary"}
manager = RunnerManager(registry=mock_registry)
mock_executor = MagicMock()
manager._executor = mock_executor
manager.status("host", "user", name="r1", mode="binary")
manager.status("r1")
cmd = mock_executor.run.call_args.args[0]
cmd_str = " ".join(cmd)
assert "status-runner.yml" in cmd_str
@@ -233,11 +326,13 @@ class TestRunnerManager:
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_registry = MagicMock()
mock_registry.get.return_value = {"host": "host", "user": "user", "key": None, "mode": "docker"}
manager = RunnerManager(registry=mock_registry)
mock_executor = MagicMock()
manager._executor = mock_executor
manager.remove("host", "user", name="r1", token="tok", gitea_url="https://git.example.com", mode="docker")
manager.remove("r1", token="tok", gitea_url="https://git.example.com")
cmd = mock_executor.run.call_args.args[0]
cmd_str = " ".join(cmd)
assert "remove-runner.yml" in cmd_str
@@ -246,51 +341,77 @@ class TestRunnerManager:
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"]
mock_registry.remove.assert_called_once_with("r1")
def test_remove_missing_token(self) -> None:
manager = RunnerManager()
mock_registry = MagicMock()
mock_registry.get.return_value = {"host": "host", "user": "user"}
manager = RunnerManager(registry=mock_registry)
with pytest.raises(AnsibleError, match="GITEA_REGISTRATION_TOKEN must be set"):
manager.remove("host", "user", name="r1")
manager.remove("r1")
def test_stop_default_name(self) -> None:
manager = RunnerManager()
def test_remove_registry_deleted_on_failure(self) -> None:
mock_registry = MagicMock()
mock_registry.get.return_value = {"host": "host", "user": "user"}
manager = RunnerManager(registry=mock_registry)
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)
mock_executor.run.side_effect = AnsibleError("fail")
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)
with pytest.raises(AnsibleError):
manager.remove("r1", token="tok")
mock_registry.remove.assert_not_called()
def test_disable_default_name(self) -> None:
manager = RunnerManager()
def test_list_runners(self) -> None:
mock_registry = MagicMock()
mock_registry.list.return_value = {
"r1": {"host": "10.0.0.1", "user": "ubuntu", "key": "/key", "mode": "docker"},
}
manager = RunnerManager(registry=mock_registry)
mock_executor = MagicMock()
mock_executor.run_ad_hoc.return_value = "active"
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)
runners = manager.list_runners()
assert len(runners) == 1
assert runners[0]["name"] == "r1"
assert runners[0]["host"] == "10.0.0.1"
assert runners[0]["status"] == "active"
mock_executor.run_ad_hoc.assert_called_once_with(
"10.0.0.1", "ubuntu", "/key", "shell", "systemctl is-active gitea-runner@r1"
)
def test_remove_default_name(self) -> None:
manager = RunnerManager()
def test_list_runners_empty(self) -> None:
mock_registry = MagicMock()
mock_registry.list.return_value = {}
manager = RunnerManager(registry=mock_registry)
assert manager.list_runners() == []
def test_list_runners_unknown_status(self) -> None:
mock_registry = MagicMock()
mock_registry.list.return_value = {
"r1": {"host": "10.0.0.1", "user": "ubuntu", "key": None, "mode": "docker"},
}
manager = RunnerManager(registry=mock_registry)
mock_executor = MagicMock()
mock_executor.run_ad_hoc.return_value = ""
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)
runners = manager.list_runners()
assert runners[0]["status"] == "unknown"
def test_list_runners_ad_hoc_error(self) -> None:
mock_registry = MagicMock()
mock_registry.list.return_value = {
"r1": {"host": "10.0.0.1", "user": "ubuntu", "key": None, "mode": "docker"},
}
manager = RunnerManager(registry=mock_registry)
mock_executor = MagicMock()
mock_executor.run_ad_hoc.side_effect = Exception("ssh fail")
manager._executor = mock_executor
runners = manager.list_runners()
assert runners[0]["status"] == "unknown"
class TestBuildCmd: