Mark all pydantic models as frozen (#796)

* Update pydantic factories to allow us to use `model_construct`

This is useful for when we want to build a model with invalid data, then dump it to JSON to use with the test client

* Update tests to account for frozen models

* When instantiating factory with no args, use fixture directly

* Use provided `BugzillaWebhookFactory` fixture instead of alias

Author: grahamalama

jbi/bugzilla/service.py

@@ -93,11 +93,11 @@ def get_description(self, bug_id: int):
     def refresh_bug_data(self, bug: BugzillaBug):
         """Re-fetch a bug to ensure we have the most up-to-date data"""
 
-        updated_bug = self.client.get_bug(bug.id)
+        refreshed_bug_data = self.client.get_bug(bug.id)
         # When bugs come in as webhook payloads, they have a "comment"
         # attribute, but this field isn't available when we get a bug by ID.
         # So, we make sure to add the comment back if it was present on the bug.
-        updated_bug.comment = bug.comment
+        updated_bug = refreshed_bug_data.model_copy(update={"comment": bug.comment})
         return updated_bug
 
     def list_webhooks(self):

jbi/log.py

@@ -78,7 +78,7 @@ def filter(self, record) -> bool:
 }
 
 
-class RequestSummary(BaseModel):
+class RequestSummary(BaseModel, frozen=True):
     """Request summary as specified by MozLog format"""
 
     agent: str

jbi/models.py

@@ -29,7 +29,7 @@
 JIRA_HOSTNAMES = ("jira", "atlassian")
 
 
-class ActionSteps(BaseModel):
+class ActionSteps(BaseModel, frozen=True):
     """Step functions to run for each type of Bugzilla webhook payload"""
 
     new: list[str] = [
@@ -63,7 +63,7 @@ def validate_steps(cls, function_names: list[str]):
         return function_names
 
 
-class JiraComponents(BaseModel):
+class JiraComponents(BaseModel, frozen=True):
     """Controls how Jira components are set on issues in the `maybe_update_components` step."""
 
     use_bug_component: bool = True
@@ -72,7 +72,7 @@ class JiraComponents(BaseModel):
     set_custom_components: list[str] = []
 
 
-class ActionParams(BaseModel):
+class ActionParams(BaseModel, frozen=True):
     """Params passed to Action step functions"""
 
     jira_project_key: str
@@ -84,7 +84,7 @@ class ActionParams(BaseModel):
     issue_type_map: dict[str, str] = {"task": "Task", "defect": "Bug"}
 
 
-class Action(BaseModel):
+class Action(BaseModel, frozen=True):
     """
     Action is the inner model for each action in the configuration file"""
 
@@ -164,25 +164,23 @@ def validate_actions(cls, actions: list[Action]):
     model_config = ConfigDict(ignored_types=(functools.cached_property,))
 
 
-class BugzillaWebhookUser(BaseModel):
+class BugzillaWebhookUser(BaseModel, frozen=True):
     """Bugzilla User Object"""
 
     id: int
     login: str
     real_name: str
 
 
-class BugzillaWebhookEventChange(BaseModel):
+class BugzillaWebhookEventChange(BaseModel, frozen=True, coerce_numbers_to_str=True):
     """Bugzilla Change Object"""
 
-    model_config = ConfigDict(coerce_numbers_to_str=True)
-
     field: str
     removed: str
     added: str
 
 
-class BugzillaWebhookEvent(BaseModel):
+class BugzillaWebhookEvent(BaseModel, frozen=True):
     """Bugzilla Event Object"""
 
     action: str
@@ -198,7 +196,7 @@ def changed_fields(self) -> list[str]:
         return [c.field for c in self.changes] if self.changes else []
 
 
-class BugzillaWebhookComment(BaseModel):
+class BugzillaWebhookComment(BaseModel, frozen=True):
     """Bugzilla Comment Object"""
 
     body: Optional[str] = None
@@ -208,7 +206,7 @@ class BugzillaWebhookComment(BaseModel):
     creation_time: Optional[datetime.datetime] = None
 
 
-class BugzillaBug(BaseModel):
+class BugzillaBug(BaseModel, frozen=True):
     """Bugzilla Bug Object"""
 
     id: int
@@ -293,7 +291,7 @@ def lookup_action(self, actions: Actions) -> Action:
         raise ActionNotFoundError(", ".join(actions.by_tag.keys()))
 
 
-class BugzillaWebhookRequest(BaseModel):
+class BugzillaWebhookRequest(BaseModel, frozen=True):
     """Bugzilla Webhook Request Object"""
 
     webhook_id: int
@@ -302,7 +300,7 @@ class BugzillaWebhookRequest(BaseModel):
     bug: BugzillaBug
 
 
-class BugzillaComment(BaseModel):
+class BugzillaComment(BaseModel, frozen=True):
     """Bugzilla Comment"""
 
     id: int
@@ -314,14 +312,14 @@ class BugzillaComment(BaseModel):
 BugzillaComments = TypeAdapter(list[BugzillaComment])
 
 
-class BugzillaApiResponse(BaseModel):
+class BugzillaApiResponse(BaseModel, frozen=True):
     """Bugzilla Response Object"""
 
     faults: Optional[list] = None
     bugs: Optional[list[BugzillaBug]] = None
 
 
-class BugzillaWebhook(BaseModel):
+class BugzillaWebhook(BaseModel, frozen=True):
     """Bugzilla Webhook"""
 
     id: int
@@ -343,13 +341,13 @@ def slug(self):
         return f"{self.id}-{name}-{product}"
 
 
-class BugzillaWebhooksResponse(BaseModel):
+class BugzillaWebhooksResponse(BaseModel, frozen=True):
     """Bugzilla Webhooks List Response Object"""
 
     webhooks: Optional[list[BugzillaWebhook]] = None
 
 
-class Context(BaseModel):
+class Context(BaseModel, frozen=True):
     """Generic log context throughout JBI"""
 
     def update(self, **kwargs):

tests/conftest.py

@@ -12,7 +12,6 @@
 import tests.fixtures.factories as factories
 from jbi import Operation, bugzilla, jira
 from jbi.app import app
-from jbi.configuration import get_actions
 from jbi.environment import Settings
 from jbi.models import ActionContext
 
@@ -56,7 +55,7 @@ def mocked_statsd():
 
 register(factories.ActionContextFactory)
 register(factories.ActionFactory)
-register(factories.ActionsFactory)
+register(factories.ActionsFactory, "_actions")
 register(factories.ActionParamsFactory)
 register(factories.BugFactory)
 register(factories.BugzillaWebhookFactory)
@@ -71,7 +70,6 @@ def mocked_statsd():
 register(
     factories.ActionContextFactory, "context_create_example", operation=Operation.CREATE
 )
-register(factories.WebhookFactory, "webhook_create_example")
 
 
 @pytest.fixture
@@ -86,9 +84,9 @@ def settings():
     return Settings()
 
 
-@pytest.fixture(autouse=True)
-def actions():
-    return get_actions()
+@pytest.fixture()
+def actions(actions_factory):
+    return actions_factory()
 
 
 @pytest.fixture(autouse=True)

tests/fixtures/factories.py

@@ -3,7 +3,24 @@
 from jbi import Operation, models
 
 
-class ActionParamsFactory(factory.Factory):
+class PydanticFactory(factory.Factory):
+    """
+    - factory_instance(**kwargs) -> Model(**kwargs)
+    - factory_instance.create(**kwargs) -> Model(**kwargs)
+    - factory_instance.build(**kwargs) -> Model.model_construct(**kwargs)
+
+    https://docs.pydantic.dev/latest/api/base_model/#pydantic.main.BaseModel.model_construct
+    """
+
+    class Meta:
+        abstract = True
+
+    @classmethod
+    def _build(cls, model_class, *args, **kwargs):
+        return model_class.model_construct(**kwargs)
+
+
+class ActionParamsFactory(PydanticFactory):
     class Meta:
         model = models.ActionParams
 
@@ -15,7 +32,7 @@ class Meta:
     issue_type_map = {"task": "Task", "defect": "Bug"}
 
 
-class ActionFactory(factory.Factory):
+class ActionFactory(PydanticFactory):
     class Meta:
         model = models.Action
 
@@ -25,14 +42,14 @@ class Meta:
     parameters = factory.SubFactory(ActionParamsFactory)
 
 
-class ActionsFactory(factory.Factory):
+class ActionsFactory(PydanticFactory):
     class Meta:
         model = models.Actions
 
     root = factory.List([factory.SubFactory(ActionFactory)])
 
 
-class BugzillaWebhookCommentFactory(factory.Factory):
+class BugzillaWebhookCommentFactory(PydanticFactory):
     class Meta:
         model = models.BugzillaWebhookComment
 
@@ -43,7 +60,7 @@ class Meta:
     creation_time = None
 
 
-class BugFactory(factory.Factory):
+class BugFactory(PydanticFactory):
     class Meta:
         model = models.BugzillaBug
 
@@ -71,7 +88,7 @@ class Params:
     whiteboard = "[devtest]"
 
 
-class WebhookUserFactory(factory.Factory):
+class WebhookUserFactory(PydanticFactory):
     class Meta:
         model = models.BugzillaWebhookUser
 
@@ -80,7 +97,7 @@ class Meta:
     real_name = "Nobody [ :nobody ]"
 
 
-class WebhookEventChangeFactory(factory.Factory):
+class WebhookEventChangeFactory(PydanticFactory):
     class Meta:
         model = models.BugzillaWebhookEventChange
 
@@ -89,7 +106,7 @@ class Meta:
     added = "new value"
 
 
-class WebhookEventFactory(factory.Factory):
+class WebhookEventFactory(PydanticFactory):
     class Meta:
         model = models.BugzillaWebhookEvent
 
@@ -101,7 +118,7 @@ class Meta:
     user = factory.SubFactory(WebhookUserFactory)
 
 
-class WebhookFactory(factory.Factory):
+class WebhookFactory(PydanticFactory):
     class Meta:
         model = models.BugzillaWebhookRequest
 
@@ -111,7 +128,7 @@ class Meta:
     webhook_name = "local-test"
 
 
-class CommentFactory(factory.Factory):
+class CommentFactory(PydanticFactory):
     class Meta:
         model = models.BugzillaComment
 
@@ -123,7 +140,7 @@ class Meta:
     creator = "[email protected]"
 
 
-class JiraContextFactory(factory.Factory):
+class JiraContextFactory(PydanticFactory):
     class Meta:
         model = models.JiraContext
 
@@ -132,7 +149,7 @@ class Meta:
     labels = []
 
 
-class ActionContextFactory(factory.Factory):
+class ActionContextFactory(PydanticFactory):
     class Meta:
         model = models.ActionContext
 
@@ -143,7 +160,7 @@ class Meta:
     jira = factory.SubFactory(JiraContextFactory)
 
 
-class BugzillaWebhookFactory(factory.Factory):
+class BugzillaWebhookFactory(PydanticFactory):
     class Meta:
         model = models.BugzillaWebhook
 
@@ -156,19 +173,3 @@ class Meta:
     name = "Test Webhooks"
     product = "Firefox"
     url = "http://server.example.com/bugzilla_webhook"
-
-
-__all__ = [
-    "ActionContextFactory",
-    "ActionFactory",
-    "ActionParamsFactory",
-    "ActionsFactory",
-    "BugFactory",
-    "BugzillaWebhookFactory",
-    "CommentFactory",
-    "JiraContextFactory",
-    "WebhookEventChangeFactory",
-    "WebhookEventFactory",
-    "WebhookFactory",
-    "WebhookUserFactory",
-]

tests/unit/jira/test_client.py

@@ -79,10 +79,7 @@ def test_paginated_projects_no_keys(settings, jira_client, mocked_responses):
     assert resp == mocked_response_data
 
 
-def test_paginated_projects_with_keys(
-    settings, jira_client, mocked_responses, action_factory
-):
-    action_factory()
+def test_paginated_projects_with_keys(settings, jira_client, mocked_responses):
     url = f"{settings.jira_base_url}rest/api/2/project/search"
     mocked_response_data = {"some": "data"}
     mocked_responses.add(