Added more tests

eadwinCode · eadwinCode · commit 672e10e2fa48 · 2023-09-24T06:31:06.000+01:00
diff --git a/ellar/common/params/resolvers/parameter.py b/ellar/common/params/resolvers/parameter.py
@@ -155,7 +155,7 @@ async def get_request_body(self, ctx: IExecutionContext) -> t.Any:
         except json.JSONDecodeError as e:
             request_logger.error("JSONDecodeError: ", exc_info=True)
             raise RequestValidationError([ErrorWrapper(e, ("body", e.pos))]) from e
-        except Exception as e:  # pragma: no cover
+        except Exception as e:
             request_logger.error("Unable to parse the body: ", exc_info=e)
             raise HTTPException(
                 status_code=400, detail="There was an error parsing the body"
diff --git a/ellar/common/responses/models/base.py b/ellar/common/responses/models/base.py
@@ -26,6 +26,17 @@ def serialize_if_pydantic_object(obj: t.Any) -> t.Any:
 
 
 class ResponseModelField(ModelField):
+    """
+    A representation of response schema defined in route function
+
+        @get('/', response={200: ASchema, 404: ErrorSchema})
+        def example():
+            pass
+
+    During module building, `ASchema` and `ErrorSchema` will be converted to ResponseModelField
+    types for the of validation and OPENAPI documentation
+    """
+
     def validate_object(self, obj: t.Any) -> t.Any:
         request_logger.debug(
             f"Validating Response Object - '{self.__class__.__name__}'"
@@ -52,6 +63,21 @@ def serialize(
 
 
 class BaseResponseModel(IResponseModel, ABC):
+    """
+    A base model representation of endpoint response. It provides essential information about a response type, just as
+    it is defined on the endpoint, the status code and schema plus description for OPENAPI documentation.
+
+    For example:
+
+        @get('/', response={200: ASchema, 404: ErrorSchema})
+        def example():
+            pass
+
+    From the Above example, two response models will be generated.
+    - response model for 200 status and ASchema and
+    - response model for 400 status and ErrorSchema
+    """
+
     __slots__ = (
         "_response_type",
         "_media_type",
@@ -126,10 +152,10 @@ def serialize(
     def create_response(
         self, context: IExecutionContext, response_obj: t.Any, status_code: int
     ) -> Response:
+        """Please override this function to create a custom response"""
         request_logger.debug(
             f"Creating Response from returned Handler value - '{self.__class__.__name__}'"
         )
-        """Cant create custom responses, Please override this function to create a custom response"""
         response_args, headers = self.get_context_response(
             context=context, status_code=status_code
         )
@@ -162,6 +188,16 @@ def get_context_response(
 
 
 class ResponseModel(BaseResponseModel):
+    """
+    Handles endpoint models with Response Type as schema
+
+        from starlette.responses import PlainTextResponse
+
+        @get('/', response={200: PlainTextResponse})
+        def example():
+            pass
+    """
+
     def serialize(
         self,
         response_obj: t.Any,
diff --git a/ellar/common/responses/models/route.py b/ellar/common/responses/models/route.py
@@ -1,9 +1,8 @@
-import logging
 import typing as t
 
 from ellar.common.constants import SCOPE_RESPONSE_STARTED
 from ellar.common.interfaces import IExecutionContext, IResponseModel
-from ellar.common.logger import request_logger
+from ellar.common.logger import logger, request_logger
 from pydantic import BaseModel
 
 from ..response_types import Response
@@ -12,8 +11,6 @@
 from .helper import create_response_model
 from .json import EmptyAPIResponseModel, JSONResponseModel
 
-logger = logging.getLogger("ellar")
-
 
 class RouteResponseModel:
     __slots__ = ("models",)
@@ -104,7 +101,8 @@ def process_response(
             return response_obj
         scope, _, _ = ctx.get_args()
 
-        if scope.get(SCOPE_RESPONSE_STARTED) is True:
+        if scope.get(SCOPE_RESPONSE_STARTED) is True:  # pragma: no cover
+            # Similar condition exists in EllarConsumer Manager
             request_logger.debug(
                 f"Stopped Processing Since `response.send` has been called - '{self.__class__.__name__}'"
             )
diff --git a/ellar/common/routing/base.py b/ellar/common/routing/base.py
@@ -41,11 +41,11 @@ def __init__(self, endpoint: t.Callable) -> None:
             t.Union[t.Type, t.Type["ControllerBase"]], _controller_type
         )
 
-    @t.no_type_check
-    def __call__(
-        self, context: IExecutionContext, *args: t.Any, **kwargs: t.Any
-    ) -> t.Any:
-        return self.endpoint(*args, **kwargs)
+    # @t.no_type_check
+    # def __call__(
+    #     self, context: IExecutionContext, *args: t.Any, **kwargs: t.Any
+    # ) -> t.Any:
+    #     return self.endpoint(*args, **kwargs)
 
     @abstractmethod
     def _load_model(self) -> None:
diff --git a/ellar/common/routing/controller/base.py b/ellar/common/routing/controller/base.py
@@ -19,10 +19,10 @@ def _get_controller_instance(self, ctx: IExecutionContext) -> ControllerBase:
         controller_instance.context = ctx
         return controller_instance
 
-    @t.no_type_check
-    def __call__(
-        self, context: IExecutionContext, *args: t.Any, **kwargs: t.Any
-    ) -> t.Any:
-        request_logger.debug("Calling Controller Endpoint manually")
-        controller_instance = self._get_controller_instance(ctx=context)
-        return self.endpoint(controller_instance, *args, **kwargs)
+    # @t.no_type_check
+    # def __call__(
+    #     self, context: IExecutionContext, *args: t.Any, **kwargs: t.Any
+    # ) -> t.Any:
+    #     request_logger.debug("Calling Controller Endpoint manually")
+    #     controller_instance = self._get_controller_instance(ctx=context)
+    #     return self.endpoint(controller_instance, *args, **kwargs)
diff --git a/ellar/core/interceptors/consumer.py b/ellar/core/interceptors/consumer.py
@@ -3,6 +3,7 @@
 
 from ellar.common import EllarInterceptor, IExecutionContext, IInterceptorsConsumer
 from ellar.common.constants import ROUTE_INTERCEPTORS, SCOPE_RESPONSE_STARTED
+from ellar.common.logger import request_logger
 from ellar.di import injectable
 
 if t.TYPE_CHECKING:  # pragma: no cover
@@ -51,6 +52,8 @@ async def handler(idx: int) -> t.Any:
             res = await route_operation.handle_request(context=context)
 
         if context.get_args()[0][SCOPE_RESPONSE_STARTED]:
-            print("\nResponse Started")
+            request_logger.debug(
+                f"Stopped Processing Since `response.send` has been called - '{self.__class__.__name__}'"
+            )
             return
         await route_operation.handle_response(context, res)
diff --git a/ellar/core/lifespan.py b/ellar/core/lifespan.py
@@ -1,7 +1,7 @@
 import typing as t
 
 from anyio import create_task_group
-from ellar.common import IApplicationShutdown, IApplicationStartup
+from ellar.common import IApplicationShutdown, IApplicationStartup, logger
 from ellar.reflect import asynccontextmanager
 
 if t.TYPE_CHECKING:  # pragma: no cover
@@ -51,12 +51,16 @@ async def run_all_shutdown_actions(self, app: "App") -> None:
 
     @asynccontextmanager
     async def lifespan(self, app: "App") -> t.AsyncIterator[t.Any]:
+        logger.logger.debug("Executing Modules Startup Handlers")
+
         async with create_task_group() as tg:
             tg.start_soon(self.run_all_startup_actions, app)
 
         try:
             async with self._lifespan_context(app) as ctx:  # type:ignore[attr-defined]
                 yield ctx
         finally:
+
+            logger.logger.debug("Executing Modules Shutdown Handlers")
             async with create_task_group() as tg:
                 tg.start_soon(self.run_all_shutdown_actions, app)
diff --git a/ellar/core/main.py b/ellar/core/main.py
@@ -5,7 +5,7 @@
 from ellar.auth import IIdentitySchemes
 from ellar.auth.handlers import AuthenticationHandlerType
 from ellar.common.compatible import cached_property
-from ellar.common.constants import LOG_LEVELS
+from ellar.common.constants import ELLAR_LOG_FMT_STRING, LOG_LEVELS
 from ellar.common.datastructures import State, URLPath
 from ellar.common.interfaces import IExceptionHandler, IExceptionMiddlewareService
 from ellar.common.logger import logger
@@ -92,7 +92,7 @@ def _config_logging(self) -> None:
         )
         logger_ = logging.getLogger("ellar")
         if not logger_.handlers:
-            formatter = logging.Formatter("%(levelname)s: [%(name)s] %(message)s")
+            formatter = logging.Formatter(ELLAR_LOG_FMT_STRING)
             stream_handler = logging.StreamHandler()
             # file_handler = logging.FileHandler("my_app.log")
             # file_handler.setFormatter(formatter)
diff --git a/ellar/reflect/_reflect.py b/ellar/reflect/_reflect.py
@@ -7,7 +7,7 @@
 from .constants import REFLECT_TYPE
 from .contextmanager_fix import asynccontextmanager
 
-logger = logging.getLogger(__name__)
+logger = logging.getLogger("ellar")
 
 
 def _get_actual_target(
diff --git a/tests/test_controller/test_controller_type.py b/tests/test_controller/test_controller_type.py
@@ -3,10 +3,10 @@
 
 
 @Controller()
-class CarsController(ControllerBase, controller_name="CarSample"):
+class CarController(ControllerBase, controller_name="CarSample"):
     pass
 
 
 def test_car_controller_name_changed():
-    controller_name = reflect.get_metadata("name", CarsController)
+    controller_name = reflect.get_metadata("name", CarController)
     assert controller_name == "carsample"
diff --git a/tests/test_controller/test_module_router.py b/tests/test_controller/test_module_router.py
@@ -8,8 +8,8 @@
 
 
 @another_router.get("/sample")
-def some_example(self):
-    pass
+def some_example():
+    return {"message": "okay"}
 
 
 @another_router.get("/sample")
diff --git a/tests/test_response/test_defined_response_model.py b/tests/test_response/test_defined_response_model.py
@@ -1,8 +1,9 @@
 from typing import List, Optional
 
-from ellar.common import ModuleRouter
+from ellar.common import Context, ModuleRouter
 from ellar.core import AppFactory
 from pydantic import BaseModel
+from starlette.responses import PlainTextResponse
 
 mr = ModuleRouter("")
 
@@ -42,6 +43,22 @@ def get_not_found_res_model():
     return 301, {"name": "baz", "price": 2.0, "owner_ids": [1, 2, 3]}
 
 
+@mr.get("/items/text-case-1", response=PlainTextResponse)
+def get_plain_text_case_1():
+    return '301, {"name": "baz", "price": 2.0, "owner_ids": [1, 2, 3]}'
+
+
+@mr.get("/items/text-case-2", response={200: PlainTextResponse, 201: Item})
+def get_plain_text_case_2():
+    return '301, {"name": "baz", "price": 2.0, "owner_ids": [1, 2, 3]}'
+
+
+@mr.get("/items/text-case-3", response={200: PlainTextResponse})
+async def get_plain_text_case_3(ctx=Context()):
+    res = PlainTextResponse("Sent Response with going through response process")
+    await res(*ctx.get_args())
+
+
 app = AppFactory.create_app(routers=(mr,))
 
 
@@ -82,3 +99,25 @@ def test_validlist(test_client_factory):
         {"name": "bar", "price": 1.0, "owner_ids": None},
         {"name": "baz", "price": 2.0, "owner_ids": [1, 2, 3]},
     ]
+
+
+def test_plain_test_case_1(test_client_factory):
+    client = test_client_factory(app)
+    response = client.get("/items/text-case-1")
+    response.raise_for_status()
+    assert "text/plain" in str(response.headers["content-type"])
+    assert response.text == '301, {"name": "baz", "price": 2.0, "owner_ids": [1, 2, 3]}'
+
+
+def test_plain_test_case_2(test_client_factory):
+    client = test_client_factory(app)
+    response = client.get("/items/text-case-2")
+    assert "text/plain" in str(response.headers["content-type"])
+    assert response.text == '301, {"name": "baz", "price": 2.0, "owner_ids": [1, 2, 3]}'
+
+
+def test_sent_without_response_model_response(test_client_factory):
+    client = test_client_factory(app)
+    response = client.get("/items/text-case-3")
+    assert "text/plain" in str(response.headers["content-type"])
+    assert response.text == "Sent Response with going through response process"
diff --git a/tests/test_routing/test_body_union_schema.py b/tests/test_routing/test_body_union_schema.py
@@ -1,7 +1,9 @@
 from typing import Union
+from unittest.mock import patch
 
 from ellar.common import Body, post
 from ellar.common.serializer import serialize_object
+from ellar.core import Request
 from ellar.openapi import OpenAPIDocumentBuilder
 from ellar.testing import Test
 
@@ -154,3 +156,18 @@ def test_embed_body():
     response = _client.post("/items/embed", json={"qty": 232})
     assert response.status_code == 200, response.text
     assert response.json() == {"qty": 232}
+
+
+@patch.object(Request, "body")
+def test_body_resolution_fails(mock_form):
+    async def raise_exception():
+        raise Exception()
+
+    mock_form.return_value = raise_exception
+    response = client.post("/items/", json={"item": {"price": 100}})
+
+    assert response.status_code == 400
+    assert response.json() == {
+        "detail": "There was an error parsing the body",
+        "status_code": 400,
+    }
diff --git a/tests/test_routing/test_forms.py b/tests/test_routing/test_forms.py
@@ -1,4 +1,7 @@
+from unittest.mock import patch
+
 from ellar.common import Form, ModuleRouter
+from ellar.core import Request
 from ellar.testing import Test
 
 router = ModuleRouter("")
@@ -19,6 +22,11 @@ def post_form_param_tuple(items: tuple = Form(...)):
     return items
 
 
+@router.post("/form/python-tuple-failed")
+def cause_form_to_fail(items: tuple = Form(...)):
+    return items
+
+
 tm = Test.create_test_module(routers=(router,))
 client = tm.get_test_client()
 
@@ -45,3 +53,19 @@ def test_python_tuple_param_as_form():
     )
     assert response.status_code == 200, response.text
     assert response.json() == ["first", "second", "third"]
+
+
+@patch.object(Request, "form")
+def test_form_resolution_fails(mock_form):
+    async def raise_exception():
+        raise Exception()
+
+    mock_form.return_value = raise_exception
+    response = client.post(
+        "/form/python-tuple-failed", data={"items": ["first", "second", "third"]}
+    )
+    assert response.status_code == 400
+    assert response.json() == {
+        "detail": "There was an error parsing the body",
+        "status_code": 400,
+    }
