Files
grm/tests/unit/test_notify_failure.py
T

169 lines
7.1 KiB
Python

"""Unit tests for scripts/ci/notify_failure.py."""
import http
from unittest.mock import MagicMock, patch
from click.testing import CliRunner
from gitea_runner_manager.exceptions import APIError
from scripts.ci.notify_failure import main
from scripts.gitea_cli import TeaCLIError
class TestNotifyFailure:
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
@patch("scripts.ci.notify_failure.shutil.which", return_value="/usr/bin/tea")
@patch("scripts.gitea_cli.TeaCLI")
def test_creates_issue_with_tea(self, mock_tea_cls: MagicMock, mock_which: MagicMock) -> None:
mock_tea = MagicMock()
mock_tea.list_labels.return_value = [{"id": 5, "name": "bug"}]
mock_tea.create_issue.return_value = {"index": 42, "title": "test"}
mock_tea_cls.return_value = mock_tea
runner = CliRunner()
result = runner.invoke(
main,
[
"--repo",
"owner/repo",
"--run-id",
"123",
"--workflow",
"release",
"--commit",
"abc123def456",
],
)
assert result.exit_code == 0
assert "issue #42" in result.output
mock_tea.create_issue.assert_called_once()
mock_tea.add_label.assert_called_once_with("owner/repo", 42, ["bug"])
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
@patch("scripts.ci.notify_failure.shutil.which", return_value="/usr/bin/tea")
@patch("scripts.gitea_cli.TeaCLI")
def test_tea_creates_issue_without_bug_label(self, mock_tea_cls: MagicMock, mock_which: MagicMock) -> None:
mock_tea = MagicMock()
mock_tea.list_labels.return_value = [{"id": 1, "name": "enhancement"}]
mock_tea.create_issue.return_value = {"index": 43, "title": "test"}
mock_tea_cls.return_value = mock_tea
runner = CliRunner()
result = runner.invoke(
main,
["--repo", "owner/repo", "--run-id", "124", "--workflow", "publish", "--commit", "def789"],
)
assert result.exit_code == 0
assert "issue #43" in result.output
mock_tea.add_label.assert_not_called()
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
@patch("scripts.ci.notify_failure.shutil.which", return_value="/usr/bin/tea")
@patch("scripts.gitea_cli.TeaCLI")
def test_tea_error_falls_back_to_client(self, mock_tea_cls: MagicMock, mock_which: MagicMock) -> None:
"""When tea fails, fall back to GiteaClient."""
mock_tea = MagicMock()
mock_tea.list_labels.side_effect = TeaCLIError("network error")
mock_tea.create_issue.side_effect = TeaCLIError("network error")
mock_tea_cls.return_value = mock_tea
with patch("scripts.ci.notify_failure.GiteaClient") as mock_client_cls:
mock_client = MagicMock()
mock_client.list_labels.return_value = [{"id": 5, "name": "bug"}]
mock_client.create_issue.return_value = {"id": 50}
mock_client_cls.return_value = mock_client
runner = CliRunner()
result = runner.invoke(
main,
["--repo", "owner/repo", "--run-id", "125", "--workflow", "release", "--commit", "abc"],
)
assert result.exit_code == 0
assert "issue #50" in result.output
mock_client.create_issue.assert_called_once()
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
@patch("scripts.ci.notify_failure.shutil.which", return_value=None)
@patch("scripts.ci.notify_failure.GiteaClient")
def test_tea_not_installed_uses_client(self, mock_client_cls: MagicMock, mock_which: MagicMock) -> None:
"""When tea is not installed, use GiteaClient directly."""
mock_client = MagicMock()
mock_client.list_labels.return_value = [{"id": 5, "name": "bug"}]
mock_client.create_issue.return_value = {"id": 51}
mock_client_cls.return_value = mock_client
runner = CliRunner()
result = runner.invoke(
main,
["--repo", "owner/repo", "--run-id", "126", "--workflow", "release", "--commit", "abc"],
)
assert result.exit_code == 0
assert "issue #51" in result.output
mock_client.create_issue.assert_called_once()
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
@patch("scripts.ci.notify_failure.shutil.which", return_value=None)
@patch("scripts.ci.notify_failure.GiteaClient")
def test_client_api_error_raises(self, mock_client_cls: MagicMock, mock_which: MagicMock) -> None:
mock_client = MagicMock()
mock_client.list_labels.return_value = []
mock_client.create_issue.side_effect = APIError(http.HTTPStatus.FORBIDDEN, "forbidden")
mock_client_cls.return_value = mock_client
runner = CliRunner()
result = runner.invoke(
main,
["--repo", "owner/repo", "--run-id", "127", "--workflow", "release", "--commit", "abc"],
)
assert result.exit_code == 1
assert "403" in result.output
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
@patch("scripts.ci.notify_failure.shutil.which", return_value="/usr/bin/tea")
@patch("scripts.gitea_cli.TeaCLI")
def test_tea_list_labels_error_continues_without_labels(
self, mock_tea_cls: MagicMock, mock_which: MagicMock
) -> None:
"""If listing labels fails via tea, issue is still created without labels."""
mock_tea = MagicMock()
mock_tea.list_labels.side_effect = TeaCLIError("network error")
mock_tea.create_issue.return_value = {"index": 50, "title": "test"}
mock_tea_cls.return_value = mock_tea
runner = CliRunner()
result = runner.invoke(
main,
["--repo", "owner/repo", "--run-id", "128", "--workflow", "release", "--commit", "abc"],
)
assert result.exit_code == 0
assert "issue #50" in result.output
@patch.dict("os.environ", {"REPO_TOKEN": "tok"})
@patch("scripts.ci.notify_failure.shutil.which", return_value="/usr/bin/tea")
@patch("scripts.gitea_cli.TeaCLI")
def test_tea_add_label_error_is_ignored(self, mock_tea_cls: MagicMock, mock_which: MagicMock) -> None:
"""If adding label fails via tea, issue is still reported as created."""
mock_tea = MagicMock()
mock_tea.list_labels.return_value = [{"id": 5, "name": "bug"}]
mock_tea.create_issue.return_value = {"index": 51, "title": "test"}
mock_tea.add_label.side_effect = TeaCLIError("permission denied")
mock_tea_cls.return_value = mock_tea
runner = CliRunner()
result = runner.invoke(
main,
["--repo", "owner/repo", "--run-id", "129", "--workflow", "release", "--commit", "abc"],
)
assert result.exit_code == 0
assert "issue #51" in result.output
@patch.dict("os.environ", {"REPO_TOKEN": ""}, clear=True)
def test_missing_token_exits(self) -> None:
runner = CliRunner()
result = runner.invoke(
main,
["--repo", "owner/repo", "--run-id", "1", "--workflow", "release", "--commit", "abc"],
)
assert result.exit_code == 1
assert "REPO_TOKEN" in result.output