Refactor some test fixtures / setup (#205)

* Decouple test objects from mocked service side effects

In some of our fixtures, we'd return an example test object, but also specify
the returns of mocked side effects when that fixture was used. This made it
slightly more challenging to modify test fixtures. It also wasn't obvious that
the service mocking was happening when reading tests.

Now, we set the return values of mocked services in tests. This makes tests a
bit more verbose, but also makes them more explicit and obvious.

* Add a tests/fixtures/factories.py module to facilitate easy test object creation

These factory functions aren't perfect, and eventually it would be good to
use something like 1pydantic-factories1, but for now this is a good-enough
approach to easily make different examaple objects in tests.

* Move some action tests from test_configuration.py to test_models.py

Some of the Action tests in test_configuration.py were actually testing the
Action validators, so it seemed more appropriate to have them live in
test_models.py.

Author: grahamalama

tests/conftest.py

@@ -10,6 +10,13 @@
 from jbi.app import app
 from jbi.environment import Settings
 from jbi.models import Action, Actions, BugzillaWebhookComment, BugzillaWebhookRequest
+from tests.fixtures.factories import (
+    action_factory,
+    bug_factory,
+    webhook_event_factory,
+    webhook_factory,
+    webhook_user_factory,
+)
 
 
 @pytest.fixture
@@ -27,207 +34,95 @@ def settings():
 @pytest.fixture(autouse=True)
 def mocked_bugzilla():
     with mock.patch("jbi.services.rh_bugzilla.Bugzilla") as mocked_bz:
-        yield mocked_bz
+        yield mocked_bz()
 
 
 @pytest.fixture(autouse=True)
 def mocked_jira():
     with mock.patch("jbi.services.Jira") as mocked_jira:
-        yield mocked_jira
+        yield mocked_jira()
 
 
 @pytest.fixture
-def webhook_create_example(mocked_bugzilla) -> BugzillaWebhookRequest:
-    webhook_payload = BugzillaWebhookRequest.parse_obj(
-        {
-            "bug": {
-                "assigned_to": "[email protected]",
-                "comment": None,
-                "component": "General",
-                "creator": "[email protected]",
-                "flags": [],
-                "id": 654321,
-                "is_private": False,
-                "keywords": [],
-                "priority": "",
-                "product": "JBI",
-                "resolution": "",
-                "see_also": [],
-                "severity": "--",
-                "status": "NEW",
-                "summary": "JBI Test",
-                "type": "defect",
-                "whiteboard": "devtest",
-            },
-            "event": {
-                "action": "create",
-                "changes": None,
-                "routing_key": "bug.create",
-                "target": "bug",
-                "time": "2022-03-23T20:10:17.495000+00:00",
-                "user": {
-                    "id": 123456,
-                    "login": "[email protected]",
-                    "real_name": "Nobody [ :nobody ]",
-                },
-            },
-            "webhook_id": 34,
-            "webhook_name": "local-test",
-        }
-    )
-
-    mocked_bugzilla().getbug.return_value = webhook_payload.bug
-    mocked_bugzilla().get_comments.return_value = {
-        "bugs": {"654321": {"comments": [{"text": "Initial comment"}]}}
-    }
+def webhook_create_example() -> BugzillaWebhookRequest:
+    webhook_payload = webhook_factory()
 
     return webhook_payload
 
 
 @pytest.fixture
-def webhook_comment_example(webhook_create_example) -> BugzillaWebhookRequest:
-    webhook_comment_example: BugzillaWebhookRequest = webhook_create_example
-    webhook_comment_example.event.target = "comment"
-    webhook_comment_example.event.user.login = "[email protected]"  # type: ignore
-    assert webhook_comment_example.bug
-    webhook_comment_example.bug.comment = BugzillaWebhookComment.parse_obj(
-        {"number": 2, "body": "hello"}
+def webhook_comment_example() -> BugzillaWebhookRequest:
+    user = webhook_user_factory(login="[email protected]")
+    comment = BugzillaWebhookComment.parse_obj({"number": 2, "body": "hello"})
+    bug = bug_factory(
+        see_also=["https://mozilla.atlassian.net/browse/JBI-234"],
+        comment=comment,
     )
-    webhook_comment_example.bug.see_also = [
-        "https://mozilla.atlassian.net/browse/JBI-234"
-    ]
-    return webhook_comment_example
+    event = webhook_event_factory(target="comment", user=user)
+    webhook_payload = webhook_factory(bug=bug, event=event)
+
+    return webhook_payload
 
 
 @pytest.fixture
-def webhook_private_comment_example(
-    webhook_create_example, mocked_bugzilla
-) -> BugzillaWebhookRequest:
-    webhook_comment_example: BugzillaWebhookRequest = webhook_create_example
-    webhook_comment_example.event.target = "comment"
-    webhook_comment_example.event.user.login = "[email protected]"  # type: ignore
-    assert webhook_comment_example.bug
-    webhook_comment_example.bug.comment = BugzillaWebhookComment.parse_obj(
-        {"id": 344, "number": 2, "is_private": True}
+def webhook_private_comment_example() -> BugzillaWebhookRequest:
+    user = webhook_user_factory(login="[email protected]")
+    event = webhook_event_factory(target="comment", user=user)
+    bug = bug_factory(
+        comment={"id": 344, "number": 2, "is_private": True},
+        see_also=["https://mozilla.atlassian.net/browse/JBI-234"],
     )
-    webhook_comment_example.bug.see_also = [
-        "https://mozilla.atlassian.net/browse/JBI-234"
-    ]
-
-    # Call to Bugzilla returns the actual bug comments.
-    mocked_bugzilla().get_comments.return_value = {
-        "bugs": {
-            str(webhook_comment_example.bug.id): {
-                "comments": [
-                    {
-                        "id": 343,
-                        "text": "not this one",
-                        "bug_id": webhook_comment_example.bug.id,
-                        "count": 1,
-                        "is_private": True,
-                        "creator": "[email protected]",
-                    },
-                    {
-                        "id": 344,
-                        "text": "hello",
-                        "bug_id": webhook_comment_example.bug.id,
-                        "count": 2,
-                        "is_private": True,
-                        "creator": "[email protected]",
-                    },
-                    {
-                        "id": 345,
-                        "text": "or this one",
-                        "bug_id": webhook_comment_example.bug.id,
-                        "count": 3,
-                        "is_private": True,
-                        "creator": "[email protected]",
-                    },
-                ]
-            }
-        },
-        "comments": {},
-    }
-
-    return webhook_comment_example
+    webhook_payload = webhook_factory(bug=bug, event=event)
+    return webhook_payload
 
 
 @pytest.fixture
-def webhook_create_private_example(
-    webhook_create_example, mocked_bugzilla
-) -> BugzillaWebhookRequest:
-    private_bug = webhook_create_example.bug
-    private_bug.is_private = True
-    # Call to Bugzilla returns the actual bug object.
-    mocked_bugzilla().getbug.return_value = private_bug
-
-    # But webhook payload only contains private attribute.
-    webhook_create_private_example = BugzillaWebhookRequest.parse_obj(
-        {
-            **webhook_create_example.dict(),
-            "bug": {"id": private_bug.id, "is_private": True},
-        }
+def webhook_create_private_example() -> BugzillaWebhookRequest:
+    return webhook_factory(
+        event=webhook_event_factory(),
+        bug={"id": 654321, "is_private": True},
     )
-    return webhook_create_private_example
 
 
 @pytest.fixture
-def webhook_modify_example(webhook_create_example) -> BugzillaWebhookRequest:
-    webhook_modify_example: BugzillaWebhookRequest = webhook_create_example
-    assert webhook_modify_example.bug
-    webhook_modify_example.bug.see_also = [
-        "https://mozilla.atlassian.net/browse/JBI-234"
-    ]
-
-    webhook_modify_example.event.action = "modify"
-    webhook_modify_example.event.routing_key = "bug.modify:status"
-    return webhook_modify_example
+def webhook_modify_example() -> BugzillaWebhookRequest:
+    bug = bug_factory(see_also=["https://mozilla.atlassian.net/browse/JBI-234"])
+    event = webhook_event_factory(action="modify", routing_key="bug.modify:status")
+    webhook_payload = webhook_factory(bug=bug, event=event)
+    return webhook_payload
 
 
 @pytest.fixture
-def webhook_change_status_assignee(webhook_modify_example):
-    payload = webhook_modify_example.dict()
-    payload["event"]["routing_key"] = "bug.modify"
-    payload["event"]["changes"] = [
-        {"field": "status", "removed": "OPEN", "added": "FIXED"},
+def webhook_change_status_assignee():
+    changes = [
+        {
+            "field": "status",
+            "removed": "OPEN",
+            "added": "FIXED",
+        },
         {
             "field": "assignee",
             "removed": "[email protected]",
             "added": "[email protected]",
         },
     ]
-    return BugzillaWebhookRequest.parse_obj(payload)
+    event = webhook_event_factory(routing_key="bug.modify", changes=changes)
+    webhook_payload = webhook_factory(event=event)
+    return webhook_payload
 
 
 @pytest.fixture
-def webhook_modify_private_example(
-    webhook_modify_example, mocked_bugzilla
-) -> BugzillaWebhookRequest:
-    private_bug = webhook_modify_example.bug
-    private_bug.is_private = True
-    # Call to Bugzilla returns the actual bug object.
-    mocked_bugzilla().getbug.return_value = private_bug
-
-    # But webhook payload only contains private attribute.
-    webhook_modify_private_example = BugzillaWebhookRequest.parse_obj(
-        {
-            **webhook_modify_example.dict(),
-            "bug": {"id": private_bug.id, "is_private": True},
-        }
+def webhook_modify_private_example() -> BugzillaWebhookRequest:
+    event = webhook_event_factory(action="modify", routing_key="bug.modify:status")
+    webhook_payload = webhook_factory(
+        bug={"id": 654321, "is_private": True}, event=event
     )
-    return webhook_modify_private_example
+    return webhook_payload
 
 
 @pytest.fixture
 def action_example() -> Action:
-    return Action.parse_obj(
-        {
-            "whiteboard_tag": "devtest",
-            "contact": "[email protected]",
-            "description": "test config",
-            "module": "tests.fixtures.noop_action",
-        }
-    )
+    return action_factory()
 
 
 @pytest.fixture

tests/fixtures/factories.py

@@ -0,0 +1,88 @@
+from jbi.models import (
+    Action,
+    BugzillaBug,
+    BugzillaWebhookEvent,
+    BugzillaWebhookRequest,
+    BugzillaWebhookUser,
+)
+
+
+def action_factory(**overrides):
+    action = {
+        "whiteboard_tag": "devtest",
+        "contact": "tbd",
+        "description": "test config",
+        "module": "tests.fixtures.noop_action",
+        **overrides,
+    }
+    return Action.parse_obj(action)
+
+
+def bug_factory(**overrides):
+    bug = {
+        "assigned_to": "[email protected]",
+        "comment": None,
+        "component": "General",
+        "creator": "[email protected]",
+        "flags": [],
+        "id": 654321,
+        "is_private": False,
+        "keywords": [],
+        "priority": "",
+        "product": "JBI",
+        "resolution": "",
+        "see_also": [],
+        "severity": "--",
+        "status": "NEW",
+        "summary": "JBI Test",
+        "type": "defect",
+        "whiteboard": "devtest",
+        **overrides,
+    }
+    return BugzillaBug.parse_obj(bug)
+
+
+def webhook_user_factory(**overrides):
+    user = {
+        "id": 123456,
+        "login": "[email protected]",
+        "real_name": "Nobody [ :nobody ]",
+        **overrides,
+    }
+    return BugzillaWebhookUser.parse_obj(user)
+
+
+def webhook_event_factory(**overrides):
+    event = {
+        "action": "create",
+        "changes": None,
+        "routing_key": "bug.create",
+        "target": "bug",
+        "time": "2022-03-23T20:10:17.495000+00:00",
+        "user": webhook_user_factory(),
+        **overrides,
+    }
+    return BugzillaWebhookEvent.parse_obj(event)
+
+
+def webhook_factory(**overrides):
+    webhook_event = {
+        "bug": bug_factory(),
+        "event": webhook_event_factory(),
+        "webhook_id": 34,
+        "webhook_name": "local-test",
+        **overrides,
+    }
+    return BugzillaWebhookRequest.parse_obj(webhook_event)
+
+
+def comment_factory(**overrides):
+    return {
+        "id": 343,
+        "text": "comment text",
+        "bug_id": 654321,
+        "count": 1,
+        "is_private": True,
+        "creator": "[email protected]",
+        **overrides,
+    }