feat: unit tests for sendgrid

apps/api/tests/test_sendgrid_handler.py

@@ -0,0 +1,83 @@
+from unittest.mock import AsyncMock, patch
+
+import pytest
+from aiosendgrid import AsyncSendGridClient
+from httpx import HTTPStatusError, Request, Response
+
+from services import sendgrid_handler
+
+SAMPLE_SENDER = ("[email protected]", "No Reply IrvineHacks")
+SAMPLE_RECIPIENTS = [
+    {"email": "[email protected]", "name": "Hacker Zero"},
+    {"email": "[email protected]", "name": "Hacker One"},
+]
+
+
+@patch("aiosendgrid.AsyncSendGridClient")
+async def test_send_single_email(mock_AsyncClient: AsyncMock) -> None:
+    """Tests that sending a single email calls the AsyncClient as expected"""
+    mock_client = AsyncMock(AsyncSendGridClient)
+    mock_client.send_mail_v3.return_value = Response(202)
+    mock_AsyncClient.return_value.__aenter__.return_value = mock_client
+
+    recipient_data = SAMPLE_RECIPIENTS[0]
+
+    await sendgrid_handler.send_email("my-template-id", SAMPLE_SENDER, recipient_data)
+    mock_client.send_mail_v3.assert_awaited_once_with(
+        body={
+            "from": {"email": SAMPLE_SENDER},
+            "personalizations": [
+                {
+                    "to": [{"email": recipient_data["email"]}],
+                    "dynamic_template_data": recipient_data,
+                }
+            ],
+            "template_id": "my-template-id",
+        }
+    )
+
+
+@patch("aiosendgrid.AsyncSendGridClient")
+async def test_send_multiple_emails(mock_AsyncClient: AsyncMock) -> None:
+    """Tests that sending multiple emails calls the AsyncClient as expected"""
+    mock_client = AsyncMock(AsyncSendGridClient)
+    mock_client.send_mail_v3.return_value = Response(202)
+    mock_AsyncClient.return_value.__aenter__.return_value = mock_client
+
+    await sendgrid_handler.send_email(
+        "my-template-id", SAMPLE_SENDER, SAMPLE_RECIPIENTS, True
+    )
+    mock_client.send_mail_v3.assert_awaited_once_with(
+        body={
+            "from": {"email": SAMPLE_SENDER},
+            "personalizations": [
+                {
+                    "to": [{"email": SAMPLE_RECIPIENTS[1]["email"]}],
+                    "dynamic_template_data": SAMPLE_RECIPIENTS[1],
+                },
+                {
+                    "to": [{"email": SAMPLE_RECIPIENTS[0]["email"]}],
+                    "dynamic_template_data": SAMPLE_RECIPIENTS[0],
+                },
+            ],
+            "template_id": "my-template-id",
+        }
+    )
+
+
+@patch("aiosendgrid.AsyncSendGridClient")
+async def test_sendgrid_error_causes_runtime_error(mock_AsyncClient: AsyncMock) -> None:
+    """Test that an issue with SendGrid causes a RuntimeError"""
+    mock_client = AsyncMock(AsyncSendGridClient)
+    mock_client.send_mail_v3.side_effect = HTTPStatusError(
+        "SendGrid error",
+        request=Request("POST", "/v3/mail/send"),
+        response=Response(500),
+    )
+
+    mock_AsyncClient.return_value.__aenter__.return_value = mock_client
+
+    with pytest.raises(RuntimeError):
+        await sendgrid_handler.send_email(
+            "my-template-id", SAMPLE_SENDER, SAMPLE_RECIPIENTS, True
+        )