Hotfix marshmallow

Author: NatSquared

api/src/api/schemas/widget_documents.py

@@ -1,15 +1,16 @@
 """Widget schema class."""
 
-from marshmallow import Schema
-
 from api.models.widget_documents import WidgetDocuments as WidgetDocumentModel
 
+from .base_schema import BaseSchema
+
 
-class WidgetDocumentsSchema(Schema):
+class WidgetDocumentsSchema(BaseSchema):
     """Widget Documents schema."""
 
-    class Meta:  # pylint: disable=too-few-public-methods
+    class Meta(BaseSchema.Meta):  # pylint: disable=too-few-public-methods
         """Exclude unknown fields in the deserialized output."""
 
         model = WidgetDocumentModel
+        include_fk = True
         fields = ('id', 'title', 'type', 'parent_document_id', 'url', 'sort_index', 'is_uploaded')

api/src/api/schemas/widget_image.py

@@ -15,16 +15,17 @@
 
 from api.models.widget_image import WidgetImage as WidgetImageModel
 
-from marshmallow import Schema
+from .base_schema import BaseSchema
 
 
-class WidgetImageSchema(Schema):
+class WidgetImageSchema(BaseSchema):
     """This is the schema for the image model."""
 
-    class Meta:  # pylint: disable=too-few-public-methods
+    class Meta(BaseSchema.Meta):  # pylint: disable=too-few-public-methods
         """Images all of the Widget Image fields to a default schema."""
 
         model = WidgetImageModel
+        include_fk = True
         fields = (
             'id',
             'widget_id',

api/src/api/schemas/widget_listening.py

@@ -15,14 +15,15 @@
 
 from api.models.widget_listening import WidgetListening as WidgetListeningModel
 
-from marshmallow import Schema
+from .base_schema import BaseSchema
 
 
-class WidgetListeningSchema(Schema):  # pylint: disable=too-many-ancestors, too-few-public-methods
+class WidgetListeningSchema(BaseSchema):  # pylint: disable=too-many-ancestors, too-few-public-methods
     """This is the schema for the widget listening model."""
 
-    class Meta:  # pylint: disable=too-few-public-methods
+    class Meta(BaseSchema.Meta):  # pylint: disable=too-few-public-methods
         """All of the fields in the Widget Listening schema."""
 
         model = WidgetListeningModel
+        include_fk = True
         fields = ('id', 'engagement_id', 'widget_id', 'description')

api/src/api/schemas/widget_map.py

@@ -15,14 +15,15 @@
 
 from api.models.widget_map import WidgetMap as WidgetMapModel
 
-from marshmallow import Schema
+from .base_schema import BaseSchema
 
 
-class WidgetMapSchema(Schema):  # pylint: disable=too-many-ancestors, too-few-public-methods
+class WidgetMapSchema(BaseSchema):  # pylint: disable=too-many-ancestors, too-few-public-methods
     """This is the schema for the map model."""
 
-    class Meta:  # pylint: disable=too-few-public-methods
+    class Meta(BaseSchema.Meta):  # pylint: disable=too-few-public-methods
         """Maps all of the Widget Map fields to a default schema."""
 
         model = WidgetMapModel
+        include_fk = True
         fields = ('id', 'widget_id', 'engagement_id', 'marker_label', 'latitude', 'longitude', 'geojson', 'file_name')

api/src/api/schemas/widget_poll.py

@@ -1,37 +1,39 @@
 """Schema for Widget Poll."""
 from api.models.widget_poll import Poll as PollModel
 from api.models.poll_answers import PollAnswer as PollAnswerModel
-from marshmallow import Schema
 from marshmallow_sqlalchemy.fields import Nested
+from .base_schema import BaseSchema
 
 
-class PollAnswerSchema(Schema):
+class PollAnswerSchema(BaseSchema):
     """
     Schema for serializing and deserializing Poll Answer data.
 
     This schema is used to represent poll answers in a structured format,
     facilitating operations like loading from and dumping to JSON.
     """
 
-    class Meta:
+    class Meta(BaseSchema.Meta):
         """Meta class for PollAnswerSchema options."""
 
         model = PollAnswerModel  # The model representing Poll Answer.
+        include_fk = True
         fields = ('id', 'answer_text', 'poll_id')  # Fields to include in the schema.
 
 
-class WidgetPollSchema(Schema):
+class WidgetPollSchema(BaseSchema):
     """
     Schema for serializing and deserializing Widget Poll data.
 
     This schema is designed to handle Widget Poll data, enabling easy conversion
     between Python objects and JSON representation, specifically for Widget Polls.
     """
 
-    class Meta:
+    class Meta(BaseSchema.Meta):
         """Meta class for WidgetPollSchema options."""
 
         model = PollModel  # The model representing Widget Poll.
+        include_fk = True
         fields = ('id', 'title', 'description', 'status', 'widget_id', 'engagement_id', 'answers')
 
     answers = Nested(PollAnswerSchema, many=True)

api/src/api/schemas/widget_timeline.py

@@ -16,27 +16,29 @@
 from api.models.widget_timeline import WidgetTimeline as WidgetTimelineModel
 from api.models.timeline_event import TimelineEvent as TimelineEventModel
 
-from marshmallow import Schema
 from marshmallow_sqlalchemy.fields import Nested
+from .base_schema import BaseSchema
 
 
-class TimelineEventSchema(Schema):  # pylint: disable=too-many-ancestors, too-few-public-methods
+class TimelineEventSchema(BaseSchema):  # pylint: disable=too-many-ancestors, too-few-public-methods
     """This is the schema for the timeline event model."""
 
-    class Meta:  # pylint: disable=too-few-public-methods
+    class Meta(BaseSchema.Meta):  # pylint: disable=too-few-public-methods
         """All of the fields in the Timeline Event schema."""
 
         model = TimelineEventModel
+        include_fk = True
         fields = ('id', 'engagement_id', 'widget_id', 'timeline_id', 'description', 'time', 'position', 'status')
 
 
-class WidgetTimelineSchema(Schema):  # pylint: disable=too-many-ancestors, too-few-public-methods
+class WidgetTimelineSchema(BaseSchema):  # pylint: disable=too-many-ancestors, too-few-public-methods
     """This is the schema for the widget timeline model."""
 
-    class Meta:  # pylint: disable=too-few-public-methods
+    class Meta(BaseSchema.Meta):  # pylint: disable=too-few-public-methods
         """All of the fields in the Widget Timeline schema."""
 
         model = WidgetTimelineModel
+        include_fk = True
         fields = ('id', 'engagement_id', 'widget_id', 'title', 'description', 'events')
 
     events = Nested(TimelineEventSchema, many=True)

api/src/api/schemas/widget_video.py

@@ -15,14 +15,15 @@
 
 from api.models.widget_video import WidgetVideo as WidgetVideoModel
 
-from marshmallow import Schema
+from .base_schema import BaseSchema
 
 
-class WidgetVideoSchema(Schema):  # pylint: disable=too-many-ancestors, too-few-public-methods
+class WidgetVideoSchema(BaseSchema):  # pylint: disable=too-many-ancestors, too-few-public-methods
     """This is the schema for the video model."""
 
-    class Meta:  # pylint: disable=too-few-public-methods
+    class Meta(BaseSchema.Meta):  # pylint: disable=too-few-public-methods
         """Videos all of the Widget Video fields to a default schema."""
 
         model = WidgetVideoModel
+        include_fk = True
         fields = ('id', 'widget_id', 'engagement_id', 'video_url', 'description')

api/tests/unit/services/test_engagement.py

@@ -104,8 +104,9 @@ def test_patch_engagement(session, monkeypatch):  # pylint:disable=unused-argume
         assert updated_engagement_record.created_date.strftime(date_format) == engagement_edits.get('created_date')
 
 
-def test_delete_success(session, mocker):
+def test_delete_success(session, mocker, monkeypatch):
     """Assert that an engagement can be deleted."""
+    monkeypatch.setenv('ENV', 'dev')
     eng = factory_engagement_model(status=Status.Draft.value)
     db.session.add(eng)
     db.session.commit()
@@ -116,8 +117,9 @@ def test_delete_success(session, mocker):
     assert isinstance(result, dict) and result.get('id') == eid
 
 
-def test_delete_failure_engagement_published(session, mocker):
+def test_delete_failure_engagement_published(session, mocker, monkeypatch):
     """Assert that an engagement cannot be deleted if it is published."""
+    monkeypatch.setenv('ENV', 'dev')
     eng = factory_engagement_model(status=Status.Published.value)
     db.session.add(eng)
     db.session.commit()