Consolidate event creation in test suite with faker-based fixture

Author: joshuadavidthomas

tests/conftest.py

@@ -12,6 +12,8 @@
 from django.test import override_settings
 from django.urls import clear_url_caches
 from django.urls import path
+from faker import Faker
+from gidgethub import sansio
 
 from django_github_app.conf import GITHUB_APP_SETTINGS_NAME
 from django_github_app.github import AsyncGitHubAPI
@@ -232,3 +234,39 @@ async def arepository(ainstallation, get_mock_github_api, baker):
     mock_github_api.installation_id = repository.installation.installation_id
     repository.get_gh_client = MagicMock(return_value=mock_github_api)
     return repository
+
+
+@pytest.fixture
+def faker():
+    return Faker()
+
+
+@pytest.fixture
+def create_event(faker):
+    def _create_event(event_type, delivery_id=None, **data):
+        if delivery_id is None:
+            delivery_id = seq.next()
+
+        if event_type == "issue_comment" and "comment" not in data:
+            data["comment"] = {"body": faker.sentence()}
+
+        if "comment" in data and isinstance(data["comment"], str):
+            # Allow passing just the comment body as a string
+            data["comment"] = {"body": data["comment"]}
+
+        if "comment" in data and "user" not in data["comment"]:
+            data["comment"]["user"] = {"login": faker.user_name()}
+
+        if "repository" not in data and event_type in [
+            "issue_comment",
+            "pull_request",
+            "push",
+        ]:
+            data["repository"] = {
+                "owner": {"login": faker.user_name()},
+                "name": faker.slug(),
+            }
+
+        return sansio.Event(data=data, event=event_type, delivery_id=delivery_id)
+
+    return _create_event

tests/events/test_ainstallation.py

@@ -2,7 +2,6 @@
 
 import pytest
 from asgiref.sync import sync_to_async
-from gidgethub.abc import sansio
 from model_bakery import baker
 
 from django_github_app.events.ainstallation import acreate_installation
@@ -20,7 +19,11 @@
 
 @pytest.mark.parametrize("app_settings_app_id_type", [int, str])
 async def test_acreate_installation(
-    app_settings_app_id_type, installation_id, repository_id, override_app_settings
+    app_settings_app_id_type,
+    installation_id,
+    repository_id,
+    override_app_settings,
+    create_event,
 ):
     data = {
         "installation": {
@@ -31,7 +34,7 @@ async def test_acreate_installation(
             {"id": repository_id, "node_id": "node1234", "full_name": "owner/repo"}
         ],
     }
-    event = sansio.Event(data, event="installation", delivery_id="1234")
+    event = create_event("installation", delivery_id="1234", **data)
 
     with override_app_settings(
         APP_ID=data["installation"]["app_id"]
@@ -47,13 +50,13 @@ async def test_acreate_installation(
     assert installation.data == data["installation"]
 
 
-async def test_adelete_installation(ainstallation):
+async def test_adelete_installation(ainstallation, create_event):
     data = {
         "installation": {
             "id": ainstallation.installation_id,
         }
     }
-    event = sansio.Event(data, event="installation", delivery_id="1234")
+    event = create_event("installation", delivery_id="1234", **data)
 
     await adelete_installation(event, None)
 
@@ -70,7 +73,7 @@ async def test_adelete_installation(ainstallation):
     ],
 )
 async def test_atoggle_installation_status_suspend(
-    status, action, expected, ainstallation
+    status, action, expected, ainstallation, create_event
 ):
     ainstallation.status = status
     await ainstallation.asave()
@@ -81,7 +84,7 @@ async def test_atoggle_installation_status_suspend(
             "id": ainstallation.installation_id,
         },
     }
-    event = sansio.Event(data, event="installation", delivery_id="1234")
+    event = create_event("installation", delivery_id="1234", **data)
 
     assert ainstallation.status != expected
 
@@ -91,13 +94,13 @@ async def test_atoggle_installation_status_suspend(
     assert ainstallation.status == expected
 
 
-async def test_async_installation_data(ainstallation):
+async def test_async_installation_data(ainstallation, create_event):
     data = {
         "installation": {
             "id": ainstallation.installation_id,
         },
     }
-    event = sansio.Event(data, event="installation", delivery_id="1234")
+    event = create_event("installation", delivery_id="1234", **data)
 
     assert ainstallation.data != data
 
@@ -107,7 +110,7 @@ async def test_async_installation_data(ainstallation):
     assert ainstallation.data == data["installation"]
 
 
-async def test_async_installation_repositories(ainstallation):
+async def test_async_installation_repositories(ainstallation, create_event):
     existing_repo = await sync_to_async(baker.make)(
         "django_github_app.Repository",
         installation=ainstallation,
@@ -131,7 +134,7 @@ async def test_async_installation_repositories(ainstallation):
             }
         ],
     }
-    event = sansio.Event(data, event="installation", delivery_id="1234")
+    event = create_event("installation", delivery_id="1234", **data)
 
     assert await Repository.objects.filter(
         repository_id=data["repositories_removed"][0]["id"]

tests/events/test_arepository.py

@@ -2,7 +2,6 @@
 
 import pytest
 from asgiref.sync import sync_to_async
-from gidgethub import sansio
 from model_bakery import baker
 
 from django_github_app.events.arepository import arename_repository
@@ -12,7 +11,7 @@
 pytestmark = [pytest.mark.asyncio, pytest.mark.django_db]
 
 
-async def test_arename_repository(ainstallation, repository_id):
+async def test_arename_repository(ainstallation, repository_id, create_event):
     repository = await sync_to_async(baker.make)(
         "django_github_app.Repository",
         installation=ainstallation,
@@ -26,7 +25,7 @@ async def test_arename_repository(ainstallation, repository_id):
             "full_name": f"owner/new_name_{seq.next()}",
         },
     }
-    event = sansio.Event(data, event="repository", delivery_id="1234")
+    event = create_event("repository", delivery_id="1234", **data)
 
     assert not await Repository.objects.filter(
         full_name=data["repository"]["full_name"]

tests/events/test_installation.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import pytest
-from gidgethub.abc import sansio
 from model_bakery import baker
 
 from django_github_app.events.installation import create_installation
@@ -19,7 +18,11 @@
 
 @pytest.mark.parametrize("app_settings_app_id_type", [int, str])
 def test_create_installation(
-    app_settings_app_id_type, installation_id, repository_id, override_app_settings
+    app_settings_app_id_type,
+    installation_id,
+    repository_id,
+    override_app_settings,
+    create_event,
 ):
     data = {
         "installation": {
@@ -30,7 +33,7 @@ def test_create_installation(
             {"id": repository_id, "node_id": "node1234", "full_name": "owner/repo"}
         ],
     }
-    event = sansio.Event(data, event="installation", delivery_id="1234")
+    event = create_event("installation", delivery_id="1234", **data)
 
     with override_app_settings(
         APP_ID=data["installation"]["app_id"]
@@ -44,13 +47,13 @@ def test_create_installation(
     assert installation.data == data["installation"]
 
 
-def test_delete_installation(installation):
+def test_delete_installation(installation, create_event):
     data = {
         "installation": {
             "id": installation.installation_id,
         }
     }
-    event = sansio.Event(data, event="installation", delivery_id="1234")
+    event = create_event("installation", delivery_id="1234", **data)
 
     delete_installation(event, None)
 
@@ -66,7 +69,9 @@ def test_delete_installation(installation):
         (InstallationStatus.INACTIVE, "unsuspend", InstallationStatus.ACTIVE),
     ],
 )
-def test_toggle_installation_status_suspend(status, action, expected, installation):
+def test_toggle_installation_status_suspend(
+    status, action, expected, installation, create_event
+):
     installation.status = status
     installation.save()
 
@@ -76,7 +81,7 @@ def test_toggle_installation_status_suspend(status, action, expected, installati
             "id": installation.installation_id,
         },
     }
-    event = sansio.Event(data, event="installation", delivery_id="1234")
+    event = create_event("installation", delivery_id="1234", **data)
 
     assert installation.status != expected
 
@@ -86,13 +91,13 @@ def test_toggle_installation_status_suspend(status, action, expected, installati
     assert installation.status == expected
 
 
-def test_sync_installation_data(installation):
+def test_sync_installation_data(installation, create_event):
     data = {
         "installation": {
             "id": installation.installation_id,
         },
     }
-    event = sansio.Event(data, event="installation", delivery_id="1234")
+    event = create_event("installation", delivery_id="1234", **data)
 
     assert installation.data != data
 
@@ -102,7 +107,7 @@ def test_sync_installation_data(installation):
     assert installation.data == data["installation"]
 
 
-def test_sync_installation_repositories(installation):
+def test_sync_installation_repositories(installation, create_event):
     existing_repo = baker.make(
         "django_github_app.Repository",
         installation=installation,
@@ -126,7 +131,7 @@ def test_sync_installation_repositories(installation):
             }
         ],
     }
-    event = sansio.Event(data, event="installation", delivery_id="1234")
+    event = create_event("installation", delivery_id="1234", **data)
 
     assert Repository.objects.filter(
         repository_id=data["repositories_removed"][0]["id"]

tests/events/test_repository.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import pytest
-from gidgethub import sansio
 from model_bakery import baker
 
 from django_github_app.events.repository import rename_repository
@@ -11,7 +10,7 @@
 pytestmark = [pytest.mark.django_db]
 
 
-def test_rename_repository(installation, repository_id):
+def test_rename_repository(installation, repository_id, create_event):
     repository = baker.make(
         "django_github_app.Repository",
         installation=installation,
@@ -25,7 +24,7 @@ def test_rename_repository(installation, repository_id):
             "full_name": f"owner/new_name_{seq.next()}",
         },
     }
-    event = sansio.Event(data, event="repository", delivery_id="1234")
+    event = create_event("repository", delivery_id="1234", **data)
 
     assert not Repository.objects.filter(
         full_name=data["repository"]["full_name"]