feat: Add more information in SD description (#44)

Author: sdn4z

src/lightman_ai/main.py

@@ -28,10 +28,11 @@ def _create_service_desk_issues(
 ) -> None:
     async def schedule_task(article: SelectedArticle) -> None:
         try:
+            description = f"*Why is relevant:*\n{article.why_is_relevant}\n\n*Source:* {article.link}\n\n*Score:* {article.relevance_score}/10"
             await service_desk_client.create_request_of_type(
                 project_key=project_key,
                 summary=article.title,
-                description=article.link,
+                description=description,
                 request_id_type=request_id_type,
             )
             logger.info("Created issue for article %s", article.link)
@@ -80,7 +81,7 @@ def lightman(
 
     if not dry_run:
         if not project_key or not request_id_type:
-            raise ValueError("Missing Service Desk's project key or issue id type")
+            raise ValueError("Missing Service Desk's project key or request id type")
 
         service_desk_client = ServiceDeskIntegration.from_env()
         _create_service_desk_issues(

tests/conftest.py

@@ -2,11 +2,12 @@
 from collections.abc import Generator, Iterator
 from contextlib import contextmanager
 from typing import Any
-from unittest.mock import patch
+from unittest.mock import AsyncMock, Mock, patch
 
 import pytest
 import stamina
-from lightman_ai.article.models import ArticlesList
+from lightman_ai.article.models import ArticlesList, SelectedArticle
+from lightman_ai.integrations.service_desk.integration import ServiceDeskIntegration
 from lightman_ai.sources.the_hacker_news import TheHackerNewsSource
 from stamina._core import _RetryContextIterator
 
@@ -28,6 +29,33 @@ def patched_retry_context(*args: Any, **kwargs: Any) -> _RetryContextIterator:
         yield mock
 
 
+@pytest.fixture
+def selected_articles() -> list[SelectedArticle]:
+    """Create test articles for service desk issue creation."""
+    return [
+        SelectedArticle(
+            title="Critical Security Vulnerability in Popular Library",
+            link="https://example.com/article1",
+            why_is_relevant="This affects our production systems",
+            relevance_score=9,
+        ),
+        SelectedArticle(
+            title="New Attack Vector Discovered",
+            link="https://example.com/article2",
+            why_is_relevant="Could impact our infrastructure",
+            relevance_score=8,
+        ),
+    ]
+
+
+@pytest.fixture
+def mock_service_desk() -> Mock:
+    """Create a mock ServiceDeskIntegration."""
+    mock = Mock(spec=ServiceDeskIntegration)
+    mock.create_request_of_type = AsyncMock(return_value="PROJ-123")
+    return mock
+
+
 @pytest.fixture
 def thn_xml() -> str:
     return """<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?><rss xmlns:atom=\"http://www.w3.org/2005/Atom\"

tests/integrations/test_service_desk.py

@@ -150,7 +150,7 @@ async def test_create_request_of_type_payload(self, service_desk_integration: Se
                 project_key="PROJ", summary="summary", description="desc", request_id_type="REQ_TYPE"
             )
             post_mock.assert_called_once()
-            args, kwargs = post_mock.call_args
+            _, kwargs = post_mock.call_args
             assert kwargs["json"] == {
                 "serviceDeskId": "PROJ",
                 "requestTypeId": "REQ_TYPE",

tests/test_main.py

@@ -1,9 +1,10 @@
 import logging
 from typing import Any
-from unittest.mock import AsyncMock, patch
+from unittest.mock import AsyncMock, Mock, patch
 
+import pytest
 from lightman_ai.article.models import SelectedArticle, SelectedArticlesList
-from lightman_ai.main import lightman
+from lightman_ai.main import _create_service_desk_issues, lightman
 from tests.utils import patch_agent
 
 
@@ -70,3 +71,106 @@ def test_lightman_no_publish_if_dry_run(self, caplog: Any, test_prompt: str, thn
         # Check ServiceDesk integration is NOT called in dry_run mode
         mock_service_desk_env.assert_not_called()
         assert mock_service_desk.create_request_of_type.call_count == 0
+
+
+class TestCreateServiceDeskIssues:
+    """Tests for the _create_service_desk_issues function."""
+
+    def test_create_service_desk_issues_success(
+        self, selected_articles: list[SelectedArticle], mock_service_desk: Mock, caplog: pytest.LogCaptureFixture
+    ) -> None:
+        """Test successful creation of service desk issues for all articles."""
+        with caplog.at_level(logging.INFO):
+            _create_service_desk_issues(
+                selected_articles=selected_articles,
+                service_desk_client=mock_service_desk,
+                project_key="TEST",
+                request_id_type="10001",
+            )
+
+        # Verify service desk client was called for each article
+        assert mock_service_desk.create_request_of_type.call_count == 2
+
+        # Check the calls were made with correct parameters
+        calls = mock_service_desk.create_request_of_type.call_args_list
+
+        # First article call
+        first_call = calls[0]
+        assert first_call.kwargs["project_key"] == "TEST"
+        assert first_call.kwargs["summary"] == "Critical Security Vulnerability in Popular Library"
+        assert first_call.kwargs["request_id_type"] == "10001"
+        expected_desc_1 = "*Why is relevant:*\nThis affects our production systems\n\n*Source:* https://example.com/article1\n\n*Score:* 9/10"
+        assert first_call.kwargs["description"] == expected_desc_1
+
+        # Second article call
+        second_call = calls[1]
+        assert second_call.kwargs["project_key"] == "TEST"
+        assert second_call.kwargs["summary"] == "New Attack Vector Discovered"
+        assert second_call.kwargs["request_id_type"] == "10001"
+        expected_desc_2 = "*Why is relevant:*\nCould impact our infrastructure\n\n*Source:* https://example.com/article2\n\n*Score:* 8/10"
+        assert second_call.kwargs["description"] == expected_desc_2
+
+        # Check success log messages
+        assert "Created issue for article https://example.com/article1" in caplog.text
+        assert "Created issue for article https://example.com/article2" in caplog.text
+
+    def test_create_service_desk_issues_single_failure(
+        self, selected_articles: list[SelectedArticle], mock_service_desk: Mock, caplog: pytest.LogCaptureFixture
+    ) -> None:
+        """Test handling when one article fails to create service desk issue."""
+        # Make the first call succeed, second call fail
+        mock_service_desk.create_request_of_type.side_effect = [
+            "PROJ-123",  # Success for first article
+            Exception("Service desk unavailable"),  # Failure for second article
+        ]
+
+        with caplog.at_level(logging.INFO), pytest.raises(ExceptionGroup) as exc_info:
+            _create_service_desk_issues(
+                selected_articles=selected_articles,
+                service_desk_client=mock_service_desk,
+                project_key="TEST",
+                request_id_type="10001",
+            )
+
+        # Verify both calls were attempted
+        assert mock_service_desk.create_request_of_type.call_count == 2
+
+        # Check that ExceptionGroup contains the failure
+        assert "Could not create all ServiceDesk issues" in str(exc_info.value)
+        assert len(exc_info.value.exceptions) == 1
+        assert "Service desk unavailable" in str(exc_info.value.exceptions[0])
+
+        # Check that success was logged for the first article
+        assert "Created issue for article https://example.com/article1" in caplog.text
+
+    def test_create_service_desk_issues_all_failures(
+        self, selected_articles: list[SelectedArticle], mock_service_desk: Mock, caplog: pytest.LogCaptureFixture
+    ) -> None:
+        """Test handling when all articles fail to create service desk issues."""
+        # Make all calls fail
+        mock_service_desk.create_request_of_type.side_effect = Exception("Service desk down")
+
+        with caplog.at_level(logging.ERROR), pytest.raises(ExceptionGroup) as exc_info:
+            _create_service_desk_issues(
+                selected_articles=selected_articles,
+                service_desk_client=mock_service_desk,
+                project_key="TEST",
+                request_id_type="10001",
+            )
+
+        # Verify both calls were attempted
+        assert mock_service_desk.create_request_of_type.call_count == 2
+
+        # Check that ExceptionGroup contains all failures
+        assert "Could not create all ServiceDesk issues" in str(exc_info.value)
+        assert len(exc_info.value.exceptions) == 2
+
+        # Check error logging
+        assert (
+            "Could not create ServiceDesk issue: Critical Security Vulnerability in Popular Library, https://example.com/article1"
+            in caplog.text
+        )
+        assert (
+            "Could not create ServiceDesk issue: New Attack Vector Discovered, https://example.com/article2"
+            in caplog.text
+        )