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
2026-06-18 22:59:50 +02:00
parent e5964ca5a9
commit adb758f5f5
5 changed files with 782 additions and 0 deletions
+228
View File
@@ -127,3 +127,231 @@ def update(
)
except GRMError as e:
raise click.ClickException(_("Update failed: {error}", error=e)) from e
@cli.command(help=_("Start and configure a Gitea Runner on a remote host."))
@click.argument("host")
@click.option(
"--user",
"-u",
default=lambda: os.getenv("GITEA_RUNNER_USER", os.getlogin()),
help=_("SSH user"),
)
@click.option("--name", "-n", help=_("Gitea Runner name (default: host)"))
@click.option(
"--mode",
"-m",
type=click.Choice(["docker", "binary"]),
default="docker",
help=_("Gitea Runner deployment mode (default: docker)"),
)
@click.option("--ask-become-pass", is_flag=True, help=_("Prompt for sudo password"))
def start(
host: str,
user: str,
name: str | None,
mode: str,
ask_become_pass: bool,
) -> None:
manager = RunnerManager()
try:
manager.start(
host=host,
user=user,
name=name,
mode=mode,
ask_become_pass=ask_become_pass,
)
except GRMError as e:
raise click.ClickException(_("Start failed: {error}", error=e)) from e
@cli.command(help=_("Stop a Gitea Runner on a remote host."))
@click.argument("host")
@click.option(
"--user",
"-u",
default=lambda: os.getenv("GITEA_RUNNER_USER", os.getlogin()),
help=_("SSH user"),
)
@click.option("--name", "-n", help=_("Gitea Runner name (default: host)"))
@click.option("--ask-become-pass", is_flag=True, help=_("Prompt for sudo password"))
def stop(
host: str,
user: str,
name: str | None,
ask_become_pass: bool,
) -> None:
manager = RunnerManager()
try:
manager.stop(
host=host,
user=user,
name=name,
ask_become_pass=ask_become_pass,
)
except GRMError as e:
raise click.ClickException(_("Stop failed: {error}", error=e)) from e
@cli.command(help=_("Enable a Gitea Runner to start on boot."))
@click.argument("host")
@click.option(
"--user",
"-u",
default=lambda: os.getenv("GITEA_RUNNER_USER", os.getlogin()),
help=_("SSH user"),
)
@click.option("--name", "-n", help=_("Gitea Runner name (default: host)"))
@click.option("--ask-become-pass", is_flag=True, help=_("Prompt for sudo password"))
def enable(
host: str,
user: str,
name: str | None,
ask_become_pass: bool,
) -> None:
manager = RunnerManager()
try:
manager.enable(
host=host,
user=user,
name=name,
ask_become_pass=ask_become_pass,
)
except GRMError as e:
raise click.ClickException(_("Enable failed: {error}", error=e)) from e
@cli.command(help=_("Disable a Gitea Runner and deregister it."))
@click.argument("host")
@click.option(
"--user",
"-u",
default=lambda: os.getenv("GITEA_RUNNER_USER", os.getlogin()),
help=_("SSH user"),
)
@click.option("--name", "-n", help=_("Gitea Runner name (default: host)"))
@click.option(
"--token",
"-t",
default=lambda: os.getenv("GITEA_REGISTRATION_TOKEN"),
help=_("Registration token (env: GITEA_REGISTRATION_TOKEN)"),
)
@click.option(
"--mode",
"-m",
type=click.Choice(["docker", "binary"]),
default="docker",
help=_("Gitea Runner deployment mode (default: docker)"),
)
@click.option("--ask-become-pass", is_flag=True, help=_("Prompt for sudo password"))
def disable(
host: str,
user: str,
name: str | None,
token: str | None,
mode: str,
ask_become_pass: bool,
) -> None:
gitea_url = os.getenv("GITEA_URL", "")
if not gitea_url:
raise click.ClickException(_("GITEA_URL must be set (or pass --url)"))
manager = RunnerManager()
try:
manager.disable(
host=host,
user=user,
name=name,
token=token,
gitea_url=gitea_url,
mode=mode,
ask_become_pass=ask_become_pass,
)
except GRMError as e:
raise click.ClickException(_("Disable failed: {error}", error=e)) from e
@cli.command(help=_("Check the status of a Gitea Runner."))
@click.argument("host")
@click.option(
"--user",
"-u",
default=lambda: os.getenv("GITEA_RUNNER_USER", os.getlogin()),
help=_("SSH user"),
)
@click.option("--name", "-n", help=_("Gitea Runner name (default: host)"))
@click.option(
"--mode",
"-m",
type=click.Choice(["docker", "binary"]),
default="docker",
help=_("Gitea Runner deployment mode (default: docker)"),
)
@click.option("--ask-become-pass", is_flag=True, help=_("Prompt for sudo password"))
def status(
host: str,
user: str,
name: str | None,
mode: str,
ask_become_pass: bool,
) -> None:
manager = RunnerManager()
try:
manager.status(
host=host,
user=user,
name=name,
mode=mode,
ask_become_pass=ask_become_pass,
)
except GRMError as e:
raise click.ClickException(_("Status check failed: {error}", error=e)) from e
@cli.command(help=_("Remove a Gitea Runner completely."))
@click.argument("host")
@click.option(
"--user",
"-u",
default=lambda: os.getenv("GITEA_RUNNER_USER", os.getlogin()),
help=_("SSH user"),
)
@click.option("--name", "-n", help=_("Gitea Runner name (default: host)"))
@click.option(
"--token",
"-t",
default=lambda: os.getenv("GITEA_REGISTRATION_TOKEN"),
help=_("Registration token (env: GITEA_REGISTRATION_TOKEN)"),
)
@click.option(
"--mode",
"-m",
type=click.Choice(["docker", "binary"]),
default="docker",
help=_("Gitea Runner deployment mode (default: docker)"),
)
@click.option("--ask-become-pass", is_flag=True, help=_("Prompt for sudo password"))
def remove(
host: str,
user: str,
name: str | None,
token: str | None,
mode: str,
ask_become_pass: bool,
) -> None:
gitea_url = os.getenv("GITEA_URL", "")
if not gitea_url:
raise click.ClickException(_("GITEA_URL must be set (or pass --url)"))
manager = RunnerManager()
try:
manager.remove(
host=host,
user=user,
name=name,
token=token,
gitea_url=gitea_url,
mode=mode,
ask_become_pass=ask_become_pass,
)
except GRMError as e:
raise click.ClickException(_("Remove failed: {error}", error=e)) from e
+126
View File
@@ -163,6 +163,132 @@ TRANSLATIONS: dict[str, dict[str, str]] = {
"ru": "Обновить бинарный файл Gitea Runner на удалённом хосте.",
"zh": "在远程主机上更新 Gitea Runner 二进制文件。",
},
"Start and configure a Gitea Runner on a remote host.": {
"en": "Start and configure a Gitea Runner on a remote host.",
"bg": "Стартиране и конфигуриране на Gitea Runner на отдалечен хост.",
"de": "Gitea Runner auf einem Remote-Host starten und konfigurieren.",
"ru": "Запустить и настроить Gitea Runner на удалённом хосте.",
"zh": "在远程主机上启动并配置 Gitea Runner。",
},
"Stop a Gitea Runner on a remote host.": {
"en": "Stop a Gitea Runner on a remote host.",
"bg": "Спиране на Gitea Runner на отдалечен хост.",
"de": "Gitea Runner auf einem Remote-Host stoppen.",
"ru": "Остановить Gitea Runner на удалённом хосте.",
"zh": "在远程主机上停止 Gitea Runner。",
},
"Enable a Gitea Runner to start on boot.": {
"en": "Enable a Gitea Runner to start on boot.",
"bg": "Активиране на Gitea Runner за стартиране при зареждане.",
"de": "Gitea Runner für den Start beim Booten aktivieren.",
"ru": "Включить автозапуск Gitea Runner при загрузке.",
"zh": "启用 Gitea Runner 开机自启。",
},
"Disable a Gitea Runner and deregister it.": {
"en": "Disable a Gitea Runner and deregister it.",
"bg": "Деактивиране на Gitea Runner и дерегистрация.",
"de": "Gitea Runner deaktivieren und abmelden.",
"ru": "Отключить Gitea Runner и отменить его регистрацию.",
"zh": "禁用 Gitea Runner 并注销其注册。",
},
"Check the status of a Gitea Runner.": {
"en": "Check the status of a Gitea Runner.",
"bg": "Проверка на състоянието на Gitea Runner.",
"de": "Status eines Gitea Runner prüfen.",
"ru": "Проверить состояние Gitea Runner.",
"zh": "检查 Gitea Runner 的状态。",
},
"Remove a Gitea Runner completely.": {
"en": "Remove a Gitea Runner completely.",
"bg": "Пълно премахване на Gitea Runner.",
"de": "Gitea Runner vollständig entfernen.",
"ru": "Полностью удалить Gitea Runner.",
"zh": "完全移除 Gitea Runner。",
},
"Starting Gitea Runner {name} on {host}": {
"en": "Starting Gitea Runner {name} on {host}",
"bg": "Стартиране на Gitea Runner {name} на {host}",
"de": "Starte Gitea Runner {name} auf {host}",
"ru": "Запуск Gitea Runner {name} на {host}",
"zh": "正在 {host} 上启动 Gitea Runner {name}",
},
"Stopping Gitea Runner {name} on {host}": {
"en": "Stopping Gitea Runner {name} on {host}",
"bg": "Спиране на Gitea Runner {name} на {host}",
"de": "Stoppe Gitea Runner {name} auf {host}",
"ru": "Остановка Gitea Runner {name} на {host}",
"zh": "正在 {host} 上停止 Gitea Runner {name}",
},
"Enabling Gitea Runner {name} on {host}": {
"en": "Enabling Gitea Runner {name} on {host}",
"bg": "Активиране на Gitea Runner {name} на {host}",
"de": "Aktiviere Gitea Runner {name} auf {host}",
"ru": "Включение Gitea Runner {name} на {host}",
"zh": "正在 {host} 上启用 Gitea Runner {name}",
},
"Disabling Gitea Runner {name} on {host}": {
"en": "Disabling Gitea Runner {name} on {host}",
"bg": "Деактивиране на Gitea Runner {name} на {host}",
"de": "Deaktiviere Gitea Runner {name} auf {host}",
"ru": "Отключение Gitea Runner {name} на {host}",
"zh": "正在 {host} 上禁用 Gitea Runner {name}",
},
"Checking status of Gitea Runner {name} on {host}": {
"en": "Checking status of Gitea Runner {name} on {host}",
"bg": "Проверка на състоянието на Gitea Runner {name} на {host}",
"de": "Prüfe Status von Gitea Runner {name} auf {host}",
"ru": "Проверка состояния Gitea Runner {name} на {host}",
"zh": "正在检查 {host} 上 Gitea Runner {name} 的状态",
},
"Removing Gitea Runner {name} from {host}": {
"en": "Removing Gitea Runner {name} from {host}",
"bg": "Премахване на Gitea Runner {name} от {host}",
"de": "Entferne Gitea Runner {name} von {host}",
"ru": "Удаление Gitea Runner {name} с {host}",
"zh": "正在从 {host} 移除 Gitea Runner {name}",
},
"Start failed: {error}": {
"en": "Start failed: {error}",
"bg": "Стартирането неуспешно: {error}",
"de": "Start fehlgeschlagen: {error}",
"ru": "Запуск не удался: {error}",
"zh": "启动失败: {error}",
},
"Stop failed: {error}": {
"en": "Stop failed: {error}",
"bg": "Спирането неуспешно: {error}",
"de": "Stop fehlgeschlagen: {error}",
"ru": "Остановка не удалась: {error}",
"zh": "停止失败: {error}",
},
"Enable failed: {error}": {
"en": "Enable failed: {error}",
"bg": "Активирането неуспешно: {error}",
"de": "Aktivierung fehlgeschlagen: {error}",
"ru": "Включение не удалось: {error}",
"zh": "启用失败: {error}",
},
"Disable failed: {error}": {
"en": "Disable failed: {error}",
"bg": "Деактивирането неуспешно: {error}",
"de": "Deaktivierung fehlgeschlagen: {error}",
"ru": "Отключение не удалось: {error}",
"zh": "禁用失败: {error}",
},
"Status check failed: {error}": {
"en": "Status check failed: {error}",
"bg": "Проверката на състоянието неуспешна: {error}",
"de": "Statusprüfung fehlgeschlagen: {error}",
"ru": "Проверка состояния не удалась: {error}",
"zh": "状态检查失败: {error}",
},
"Remove failed: {error}": {
"en": "Remove failed: {error}",
"bg": "Премахването неуспешно: {error}",
"de": "Entfernung fehlgeschlagen: {error}",
"ru": "Удаление не удалось: {error}",
"zh": "移除失败: {error}",
},
"Gitea Runner Manager — manage Gitea Actions runners.": {
"en": "Gitea Runner Manager — manage Gitea Actions runners.",
"bg": "Gitea Runner Manager — управление на Gitea Actions runners.",
@@ -62,6 +62,102 @@ class RunnerManager:
cmd = self._build_cmd("update-runner.yml", host, user, extra_vars, key, ask_become_pass)
self._executor.run(cmd, description=_("Updating Gitea Runner on {host}", host=host))
def start(
self,
host: str,
user: str,
name: str | None = None,
mode: str = "docker",
ask_become_pass: bool = False,
) -> None:
"""Start a runner instance on a remote host."""
if not name:
name = host
extra_vars = f"runner_name={name} runner_mode={mode}"
cmd = self._build_cmd("start-runner.yml", host, user, extra_vars, None, ask_become_pass)
self._executor.run(cmd, description=_("Starting Gitea Runner {name} on {host}", name=name, host=host))
def stop(
self,
host: str,
user: str,
name: str | None = None,
ask_become_pass: bool = False,
) -> None:
"""Stop a runner instance on a remote host."""
if not name:
name = host
extra_vars = f"runner_name={name}"
cmd = self._build_cmd("stop-runner.yml", host, user, extra_vars, None, ask_become_pass)
self._executor.run(cmd, description=_("Stopping Gitea Runner {name} on {host}", name=name, host=host))
def enable(
self,
host: str,
user: str,
name: str | None = None,
ask_become_pass: bool = False,
) -> None:
"""Enable a runner instance to start on boot."""
if not name:
name = host
extra_vars = f"runner_name={name}"
cmd = self._build_cmd("enable-runner.yml", host, user, extra_vars, None, ask_become_pass)
self._executor.run(cmd, description=_("Enabling Gitea Runner {name} on {host}", name=name, host=host))
def disable(
self,
host: str,
user: str,
name: str | None = None,
token: str | None = None,
gitea_url: str = "",
mode: str = "docker",
ask_become_pass: bool = False,
) -> None:
"""Disable and deregister a runner instance."""
if not name:
name = host
if not token:
raise AnsibleError(_("GITEA_REGISTRATION_TOKEN must be set (or pass --token)"))
extra_vars = f"runner_name={name} registration_token={token} gitea_url={gitea_url} runner_mode={mode}"
cmd = self._build_cmd("disable-runner.yml", host, user, extra_vars, None, ask_become_pass)
self._executor.run(cmd, description=_("Disabling Gitea Runner {name} on {host}", name=name, host=host))
def status(
self,
host: str,
user: str,
name: str | None = None,
mode: str = "docker",
ask_become_pass: bool = False,
) -> None:
"""Check the status of a runner instance."""
if not name:
name = host
extra_vars = f"runner_name={name} runner_mode={mode}"
cmd = self._build_cmd("status-runner.yml", host, user, extra_vars, None, ask_become_pass)
self._executor.run(cmd, description=_("Checking status of Gitea Runner {name} on {host}", name=name, host=host))
def remove(
self,
host: str,
user: str,
name: str | None = None,
token: str | None = None,
gitea_url: str = "",
mode: str = "docker",
ask_become_pass: bool = False,
) -> None:
"""Remove a runner instance completely."""
if not name:
name = host
if not token:
raise AnsibleError(_("GITEA_REGISTRATION_TOKEN must be set (or pass --token)"))
extra_vars = f"runner_name={name} registration_token={token} gitea_url={gitea_url} runner_mode={mode}"
cmd = self._build_cmd("remove-runner.yml", host, user, extra_vars, None, ask_become_pass)
self._executor.run(cmd, description=_("Removing Gitea Runner {name} from {host}", name=name, host=host))
def _build_cmd(
self,
playbook_name: str,
+192
View File
@@ -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
+140
View File
@@ -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: