tests: improve github integration test coverage

Author: artcz

intbot/core/integrations/github.py

@@ -84,6 +84,8 @@ def fetch_github_item_details(item_id):
 
 
 class GithubProjectV2Item:
+    # NOTE: This might be something for pydantic schemas in the future
+
     def __init__(self, content: dict):
         self.content = content
 
@@ -107,30 +109,30 @@ def content_type(self):
         return self.content["projects_v2_item"]["content_type"]
 
     def node_id(self):
-        # NOTE(artcz): This is more relevant, because of how the graphql query
-        # above is constructed.
+        # NOTE(artcz): This is relevant, because of how the graphql query above
+        # is constructed.
         # Using node_id, which is an id of a ProjectV2Item we can get both
         # DraftIssue and Issue from one query.
-        # If we use the content_node_id we need to adjust the query as that ID
-        # points us directly either an Issue or DraftIssue
+        # If we use the content_node_id we would probably need two separate
+        # ways of getting that data.
         return self.content["projects_v2_item"]["node_id"]
 
-    def content_node_id(self):
-        return self.content["projects_v2_item"]["content_node_id"]
-
     def changes(self) -> dict:
         if "changes" in self.content:
             fv = self.content["changes"]["field_value"]
             field_name = fv["field_name"]
             field_type = fv["field_type"]
+
             if field_type == "date":
                 changed_from = (
                     fv["from"].split("T")[0] if fv["from"] is not None else "None"
                 )
                 changed_to = fv["to"].split("T")[0] if fv["to"] is not None else "None"
+
             elif field_type == "single_select":
                 changed_from = fv["from"]["name"] if fv["from"] is not None else "None"
                 changed_to = fv["to"]["name"] if fv["to"] is not None else "None"
+
             else:
                 changed_from = "None"
                 changed_to = "None"
@@ -152,8 +154,9 @@ def as_discord_message(self, github_object: GithubDraftIssue | GithubIssue) -> s
         changes = self.changes()
 
         if changes:
-            details = "**{field}** of **{obj}** from **{from}** to **{to}**".format
-            details = details(**{"obj": github_object.as_discord_message(), **changes})
+            details = "**{field}** of **{obj}** from **{from}** to **{to}**".format(
+                **{"obj": github_object.as_discord_message(), **changes}
+            )
 
         else:
             details = github_object.as_discord_message()

intbot/tests/test_integrations/test_github.py

@@ -0,0 +1,203 @@
+import pytest
+import respx
+from core.integrations.github import (
+    GITHUB_API_URL,
+    GithubProjectV2Item,
+    fetch_github_item_details,
+    parse_github_webhook,
+)
+from httpx import Response
+
+
+def test_parse_github_webhook_raises_value_error_for_unsupported():
+    headers = {"X-Github-Event": "random_event"}
+    content = {}
+
+    with pytest.raises(ValueError):
+        parse_github_webhook(headers, content)
+
+
+@pytest.fixture
+def mocked_github_response():
+    def _mock_response(item_type, content_data):
+        return {"data": {"node": {"content": content_data}}}
+
+    return _mock_response
+
+
+@pytest.fixture
+def sample_content():
+    return {
+        "sender": {"login": "testuser", "html_url": "https://github.com/testuser"},
+        "projects_v2_item": {
+            "content_type": "Issue",
+            "node_id": "test_node_id",
+        },
+    }
+
+
+@respx.mock
+def test_fetch_github_item_details(mocked_github_response):
+    mocked_response = mocked_github_response(
+        "Issue",
+        {
+            "id": "test_issue_id",
+            "title": "Test Issue",
+            "url": "https://github.com/test/repo/issues/1",
+        },
+    )
+    respx.post(GITHUB_API_URL).mock(return_value=Response(200, json=mocked_response))
+
+    result = fetch_github_item_details("test_node_id")
+
+    assert result["id"] == "test_issue_id"
+    assert result["title"] == "Test Issue"
+    assert result["url"] == "https://github.com/test/repo/issues/1"
+
+
+@respx.mock
+def test_github_project_created_event(mocked_github_response, sample_content):
+    sample_content["action"] = "created"
+    mocked_response = mocked_github_response(
+        "Issue",
+        {
+            "id": "test_issue_id",
+            "title": "Test Issue",
+            "url": "https://github.com/test/repo/issues/1",
+        },
+    )
+    respx.post(GITHUB_API_URL).mock(return_value=Response(200, json=mocked_response))
+
+    parser = GithubProjectV2Item(sample_content)
+    message = parser.as_str()
+
+    assert message == (
+        "[@testuser](https://github.com/testuser) created "
+        "[Test Issue](https://github.com/test/repo/issues/1)"
+    )
+
+
+@respx.mock
+def test_github_project_edited_event_for_status_change(
+    mocked_github_response, sample_content
+):
+    sample_content["action"] = "edited"
+    sample_content["changes"] = {
+        "field_value": {
+            "field_name": "Status",
+            "field_type": "single_select",
+            "from": {"name": "To Do"},
+            "to": {"name": "In Progress"},
+        }
+    }
+    mocked_response = mocked_github_response(
+        "Issue",
+        {
+            "id": "test_issue_id",
+            "title": "Test Issue",
+            "url": "https://github.com/test/repo/issues/1",
+        },
+    )
+    respx.post(GITHUB_API_URL).mock(return_value=Response(200, json=mocked_response))
+
+    parser = GithubProjectV2Item(sample_content)
+    message = parser.as_str()
+
+    assert message == (
+        "[@testuser](https://github.com/testuser) changed **Status** of "
+        "**[Test Issue](https://github.com/test/repo/issues/1)** "
+        "from **To Do** to **In Progress**"
+    )
+
+
+@respx.mock
+def test_github_project_edited_event_for_date_change(
+    mocked_github_response, sample_content
+):
+    sample_content["action"] = "edited"
+    sample_content["changes"] = {
+        "field_value": {
+            "field_name": "Deadline",
+            "field_type": "date",
+            "from": "2024-01-01T10:20:30",
+            "to": "2025-01-05T20:30:10",
+        }
+    }
+    mocked_response = mocked_github_response(
+        "Issue",
+        {
+            "id": "test_issue_id",
+            "title": "Test Issue",
+            "url": "https://github.com/test/repo/issues/1",
+        },
+    )
+    respx.post(GITHUB_API_URL).mock(return_value=Response(200, json=mocked_response))
+
+    parser = GithubProjectV2Item(sample_content)
+    message = parser.as_str()
+
+    assert message == (
+        "[@testuser](https://github.com/testuser) changed **Deadline** of "
+        "**[Test Issue](https://github.com/test/repo/issues/1)** "
+        "from **2024-01-01** to **2025-01-05**"
+    )
+
+
+@respx.mock
+def test_github_project_draft_issue_event(mocked_github_response, sample_content):
+    sample_content["action"] = "created"
+    sample_content["projects_v2_item"]["content_type"] = "DraftIssue"
+    mocked_response = mocked_github_response(
+        "DraftIssue",
+        {
+            "id": "draft_issue_id",
+            "title": "Draft Title",
+        },
+    )
+    respx.post(GITHUB_API_URL).mock(return_value=Response(200, json=mocked_response))
+
+    parser = GithubProjectV2Item(sample_content)
+    message = parser.as_str()
+
+    assert message == "[@testuser](https://github.com/testuser) created Draft Title"
+
+
+def test_github_project_unsupported_action(sample_content):
+    sample_content["action"] = "unsupported_action"
+
+    parser = GithubProjectV2Item(sample_content)
+
+    with pytest.raises(ValueError, match="Action unsupported unsupported_action"):
+        parser.action()
+
+
+@respx.mock
+def test_github_project_edited_event_no_changes(mocked_github_response, sample_content):
+    sample_content["action"] = "edited"
+    mocked_response = mocked_github_response(
+        "Issue",
+        {
+            "id": "test_issue_id",
+            "title": "Test Issue",
+            "url": "https://github.com/test/repo/issues/1",
+        },
+    )
+    respx.post(GITHUB_API_URL).mock(return_value=Response(200, json=mocked_response))
+
+    parser = GithubProjectV2Item(sample_content)
+    message = parser.as_str()
+
+    assert message == (
+        "[@testuser](https://github.com/testuser) changed "
+        "[Test Issue](https://github.com/test/repo/issues/1)"
+    )
+
+
+@respx.mock
+def test_fetch_github_item_details_api_error():
+    respx.post(GITHUB_API_URL).mock(
+        return_value=Response(500, json={"message": "Internal Server Error"})
+    )
+
+    with pytest.raises(Exception, match="GitHub API error: 500 - .*"):
+        fetch_github_item_details("test_node_id")

intbot/tests/test_tasks.py

@@ -41,7 +41,6 @@ def test_process_webhook_fails_if_unsupported_source():
     result = process_webhook.enqueue(str(wh.uuid))
 
     assert result.status == ResultStatus.FAILED
-    assert result._exception_class == ValueError
     assert result.traceback.endswith("ValueError: Unsupported source asdf\n")
 
 

pyproject.toml

@@ -21,13 +21,19 @@ dependencies = [
     "django-stubs>=5.1.1",
     "pdbpp>=0.10.3",
     "pytest-cov>=6.0.0",
+    "pytest-socket>=0.7.0",
+    "respx>=0.22.0",
 ]
 
 [tool.pytest.ini_options]
 pythonpath = [
     "intbot"
 ]
 
+# Disable attempts of using the internet in tests, but allow connection to the
+# database
+addopts = "--disable-socket --allow-unix-socket"
+
 [tool.coverage.run]
 branch = true
 omit = [