Leverage marshmallow_dataclass for input dto validation

Author: Enforcer

auctioning_platform/requirements.txt

@@ -15,7 +15,7 @@ click==7.1.2              # via flask, rq
 dnspython==2.0.0          # via email-validator
 email-validator==1.1.1    # via -r ./web_app/requirements.txt
 factory-boy==3.1.0        # via -r ./auctions/requirements-dev.txt, -r ./web_app/requirements-dev.txt
-faker==4.14.0              # via -r ./shipping_infrastructure/requirements.txt, factory-boy, pytest-faker
+faker==4.14.0             # via -r ./shipping_infrastructure/requirements.txt, factory-boy, pytest-faker
 flask-babelex==0.9.4      # via flask-security
 flask-injector==0.12.0    # via -r ./web_app/requirements.txt
 flask-login==0.5.0        # via -r ./web_app/requirements.txt, flask-security
@@ -31,7 +31,9 @@ injector==0.18.4          # via -r ./auctions/requirements.txt, -r ./auctions_in
 itsdangerous==1.1.0       # via flask, flask-security, flask-wtf
 jinja2==2.11.2            # via flask, flask-babelex
 markupsafe==1.1.1         # via jinja2, wtforms
-marshmallow==3.8.0        # via -r ./web_app/requirements.txt
+marshmallow-dataclass==8.1.0  # via -r ./web_app/requirements.txt
+marshmallow==3.8.0        # via -r ./web_app/requirements.txt, marshmallow-dataclass
+mypy-extensions==0.4.3    # via typing-inspect
 packaging==20.4           # via pytest
 passlib==1.7.4            # via flask-security
 pluggy==0.13.1            # via pytest
@@ -42,9 +44,9 @@ pyparsing==2.4.7          # via packaging
 pytest-faker==2.0.0       # via -r ./auctions/requirements-dev.txt
 pytest-freezegun==0.4.2   # via -r ./processes/requirements-dev.txt
 pytest-sqlalchemy==0.2.1  # via -r ./db_infrastructure/requirements.txt
-pytest==6.1.1             # via -r ./auctions/requirements-dev.txt, -r ./auctions_infrastructure/requirements-dev.txt, -r ./customer_relationship/requirements-dev.txt, -r ./foundation/requirements-dev.txt, -r ./payments/requirements-dev.txt, -r ./processes/requirements-dev.txt, -r ./shipping/requirements-dev.txt, -r ./shipping_infrastructure/requirements-dev.txt, -r ./web_app/requirements-dev.txt, pytest-freezegun, pytest-sqlalchemy
+pytest==6.1.2             # via -r ./auctions/requirements-dev.txt, -r ./auctions_infrastructure/requirements-dev.txt, -r ./customer_relationship/requirements-dev.txt, -r ./foundation/requirements-dev.txt, -r ./payments/requirements-dev.txt, -r ./processes/requirements-dev.txt, -r ./shipping/requirements-dev.txt, -r ./shipping_infrastructure/requirements-dev.txt, -r ./web_app/requirements-dev.txt, pytest-freezegun, pytest-sqlalchemy
 python-dateutil==2.8.1    # via faker, freezegun
-python-dotenv==0.14.0     # via -r ./main/requirements.txt
+python-dotenv==0.15.0     # via -r ./main/requirements.txt
 pytz==2019.3              # via -r ./auctions_infrastructure/requirements.txt, babel
 redis==3.5.3              # via -r ./main/requirements.txt, rq
 requests==2.22.0          # via -r ./payments/requirements.txt, stripe
@@ -55,9 +57,10 @@ sqlalchemy-utils==0.36.8  # via pytest-sqlalchemy
 sqlalchemy==1.3.19        # via -r ./auctions_infrastructure/requirements.txt, -r ./customer_relationship/requirements.txt, -r ./db_infrastructure/requirements.txt, -r ./main/requirements.txt, -r ./payments/requirements.txt, -r ./processes/requirements.txt, -r ./shipping_infrastructure/requirements.txt, -r ./web_app/requirements.txt, -r ./web_app_models/requirements.txt, pytest-sqlalchemy, sqlalchemy-utils
 stripe==2.54.0            # via -r ./payments/requirements.txt
 text-unidecode==1.3       # via faker
-toml==0.10.1              # via pytest
-typing-extensions==3.7.4.3  # via -r ./foundation/requirements.txt, -r ./processes/requirements.txt, injector
+toml==0.10.2              # via pytest
+typing-extensions==3.7.4.3  # via -r ./foundation/requirements.txt, -r ./processes/requirements.txt, typing-inspect
+typing-inspect==0.6.0     # via marshmallow-dataclass
 typing==3.7.4.3           # via flask-injector
-urllib3==1.25.10          # via requests
+urllib3==1.25.11          # via requests
 werkzeug==1.0.1           # via flask
 wtforms==2.3.3            # via flask-wtf

auctioning_platform/web_app/requirements.txt

@@ -4,5 +4,6 @@ Flask-Injector==0.12.0
 Flask==1.1.2
 bcrypt==3.1.7
 marshmallow==3.8.0
+marshmallow-dataclass==8.1.0
 Flask-Login==0.5.0
 SQLAlchemy==1.3.19

auctioning_platform/web_app/web_app/blueprints/auctions.py

@@ -2,7 +2,6 @@
 import flask_injector
 from flask_login import current_user
 import injector
-from marshmallow import Schema, post_load
 
 from auctions import (
     AuctionId,
@@ -13,8 +12,7 @@
     PlacingBidOutputBoundary,
     PlacingBidOutputDto,
 )
-from web_app.serialization.dto import get_input_dto
-from web_app.serialization.fields import Dollars
+from web_app.serialization.dto import get_dto
 
 auctions_blueprint = Blueprint("auctions_blueprint", __name__)
 
@@ -41,20 +39,12 @@ def place_bid(auction_id: AuctionId, placing_bid_uc: PlacingBid, presenter: Plac
     if not current_user.is_authenticated:
         abort(403)
 
-    dto = get_input_dto(request, PlacingBidSchema, context={"auction_id": auction_id, "bidder_id": current_user.id})
+    dto = get_dto(request, PlacingBidInputDto, context={"auction_id": auction_id, "bidder_id": current_user.id})
 
     placing_bid_uc.execute(dto)
     return presenter.response  # type: ignore
 
 
-class PlacingBidSchema(Schema):
-    amount = Dollars()
-
-    @post_load
-    def make_dto(self, data: dict, **_kwargs: dict) -> PlacingBidInputDto:
-        return PlacingBidInputDto(**self.context, **data)
-
-
 class PlacingBidPresenter(PlacingBidOutputBoundary):
     response: Response
 

auctioning_platform/web_app/web_app/serialization/dto.py

@@ -2,13 +2,23 @@
 
 from flask import Request, abort, jsonify, make_response
 from marshmallow import Schema, exceptions
+from marshmallow_dataclass import class_schema
 
-TSchema = TypeVar("TSchema", bound=Schema)
+from foundation.value_objects import Money
 
+from web_app.serialization.fields import Dollars
 
-def get_input_dto(request: Request, schema_cls: Type[TSchema], context: dict) -> TSchema:
-    schema = schema_cls(context=context)
+TDto = TypeVar("TDto")
+
+
+class BaseSchema(Schema):
+    TYPE_MAPPING = {Money: Dollars}
+
+
+def get_dto(request: Request, dto_cls: Type[TDto], context: dict) -> TDto:
+    schema_cls = class_schema(dto_cls, base_schema=BaseSchema)
+    schema = schema_cls()
     try:
-        return cast(TSchema, schema.load(request.json))
+        return cast(TDto, schema.load(dict(context, **request.json)))
     except exceptions.ValidationError as exc:
         abort(make_response(jsonify(exc.messages), 400))