Moved TestClientFactory from core to testing package and refactored testing module

Author: eadwinCode

ellar/core/__init__.py

@@ -20,7 +20,6 @@
     UJSONResponse,
 )
 from .templating import render_template, render_template_string
-from .testclient import TestClient, TestClientFactory
 
 __all__ = [
     "App",
@@ -40,8 +39,6 @@
     "BaseHttpAuth",
     "GuardCanActivate",
     "Config",
-    "TestClientFactory",
-    "TestClient",
     "JSONResponse",
     "UJSONResponse",
     "ORJSONResponse",

ellar/core/services.py renamed to ellar/core/_services_util.py

@@ -15,7 +15,7 @@
 from .exceptions.service import ExceptionMiddlewareService
 
 
-class CoreServiceRegistration:
+class _CoreServiceRegistration:
     """Create Binding for all application service"""
 
     __slots__ = ("injector", "config")

ellar/core/factory.py

@@ -12,7 +12,7 @@
 from ellar.di import EllarInjector, ProviderConfig
 from ellar.reflect import reflect
 
-from .services import CoreServiceRegistration
+from ._services_util import _CoreServiceRegistration
 
 if t.TYPE_CHECKING:  # pragma: no cover
     from ellar.commands import EllarTyper
@@ -133,7 +133,7 @@ def _get_config_kwargs() -> t.Dict:
         config = Config(app_configured=True, **_get_config_kwargs())
         injector = EllarInjector(auto_bind=config.INJECTOR_AUTO_BIND)
         injector.container.register_instance(config, concrete_type=Config)
-        CoreServiceRegistration(injector, config).register_all()
+        _CoreServiceRegistration(injector, config).register_all()
 
         cls._build_modules(app_module=module, injector=injector, config=config)
 

ellar/core/routing/operation_definitions.py

@@ -124,7 +124,7 @@ def get(
         name: str = None,
         include_in_schema: bool = True,
         response: t.Union[
-            t.Dict[int, t.Type], t.List[t.Tuple[int, t.Type]], t.Type
+            t.Dict[int, t.Type], t.List[t.Tuple[int, t.Type]], t.Type, t.Any
         ] = None,
     ) -> t.Callable[[TCallable], t.Union[TOperation, TCallable]]:
         methods = [GET]
@@ -144,7 +144,7 @@ def post(
         name: str = None,
         include_in_schema: bool = True,
         response: t.Union[
-            t.Dict[int, t.Type], t.List[t.Tuple[int, t.Type]], t.Type, None
+            t.Dict[int, t.Type], t.List[t.Tuple[int, t.Type]], t.Type, t.Any
         ] = None,
     ) -> t.Callable[[TCallable], t.Union[TOperation, TCallable]]:
         methods = [POST]
@@ -164,7 +164,7 @@ def put(
         name: str = None,
         include_in_schema: bool = True,
         response: t.Union[
-            t.Dict[int, t.Type], t.List[t.Tuple[int, t.Type]], t.Type, None
+            t.Dict[int, t.Type], t.List[t.Tuple[int, t.Type]], t.Type, t.Any
         ] = None,
     ) -> t.Callable[[TCallable], t.Union[TOperation, TCallable]]:
         methods = [PUT]
@@ -184,7 +184,7 @@ def patch(
         name: str = None,
         include_in_schema: bool = True,
         response: t.Union[
-            t.Dict[int, t.Type], t.List[t.Tuple[int, t.Type]], t.Type, None
+            t.Dict[int, t.Type], t.List[t.Tuple[int, t.Type]], t.Type, t.Any
         ] = None,
     ) -> t.Callable[[TCallable], t.Union[TOperation, TCallable]]:
         methods = [PATCH]
@@ -204,7 +204,7 @@ def delete(
         name: str = None,
         include_in_schema: bool = True,
         response: t.Union[
-            t.Dict[int, t.Type], t.List[t.Tuple[int, t.Type]], t.Type, None
+            t.Dict[int, t.Type], t.List[t.Tuple[int, t.Type]], t.Type, t.Any
         ] = None,
     ) -> t.Callable[[TCallable], t.Union[TOperation, TCallable]]:
         methods = [DELETE]
@@ -224,7 +224,7 @@ def head(
         name: str = None,
         include_in_schema: bool = True,
         response: t.Union[
-            t.Dict[int, t.Type], t.List[t.Tuple[int, t.Type]], t.Type, None
+            t.Dict[int, t.Type], t.List[t.Tuple[int, t.Type]], t.Type, t.Any
         ] = None,
     ) -> t.Callable[[TCallable], t.Union[TOperation, TCallable]]:
         methods = [HEAD]
@@ -244,7 +244,7 @@ def options(
         name: str = None,
         include_in_schema: bool = True,
         response: t.Union[
-            t.Dict[int, t.Type], t.List[t.Tuple[int, t.Type]], t.Type, None
+            t.Dict[int, t.Type], t.List[t.Tuple[int, t.Type]], t.Type, t.Any
         ] = None,
     ) -> t.Callable[[TCallable], t.Union[TOperation, TCallable]]:
         methods = [OPTIONS]
@@ -264,7 +264,7 @@ def trace(
         name: str = None,
         include_in_schema: bool = True,
         response: t.Union[
-            t.Dict[int, t.Type], t.List[t.Tuple[int, t.Type]], t.Type, None
+            t.Dict[int, t.Type], t.List[t.Tuple[int, t.Type]], t.Type, t.Any
         ] = None,
     ) -> t.Callable[[TCallable], t.Union[TOperation, TCallable]]:
         methods = [TRACE]
@@ -285,7 +285,7 @@ def http_route(
         name: str = None,
         include_in_schema: bool = True,
         response: t.Union[
-            t.Dict[int, t.Type], t.List[t.Tuple[int, t.Type]], t.Type, None
+            t.Dict[int, t.Type], t.List[t.Tuple[int, t.Type]], t.Type, t.Any
         ] = None,
     ) -> t.Callable[[TCallable], t.Union[TOperation, TCallable]]:
         def _decorator(endpoint_handler: TCallable) -> TCallable:

tests/test_application/test_application_factory.py

@@ -2,8 +2,9 @@
 from starlette.routing import Host, Mount
 
 from ellar.common import Module
-from ellar.core import AppFactory, Config, ModuleBase, ModuleSetup, TestClient
+from ellar.core import AppFactory, Config, ModuleBase, ModuleSetup
 from ellar.di import EllarInjector
+from ellar.testing import TestClient
 
 from .sample import (
     AppAPIKey,

tests/test_application/test_application_functions.py

@@ -5,20 +5,13 @@
 
 from ellar.common import Module, get, template_filter, template_global
 from ellar.compatible import asynccontextmanager
-from ellar.core import (
-    App,
-    AppFactory,
-    Config,
-    ModuleBase,
-    TestClient,
-    TestClientFactory,
-)
+from ellar.core import App, AppFactory, Config, ModuleBase
+from ellar.core._services_util import _CoreServiceRegistration
 from ellar.core.connection import Request
 from ellar.core.context import IExecutionContext
 from ellar.core.events import EventHandler
 from ellar.core.exceptions.interfaces import IExceptionHandler
 from ellar.core.modules import ModuleTemplateRef
-from ellar.core.services import CoreServiceRegistration
 from ellar.core.staticfiles import StaticFiles
 from ellar.core.templating import Environment
 from ellar.core.versioning import (
@@ -30,18 +23,19 @@
 from ellar.helper.importer import get_class_import
 from ellar.openapi import OpenAPIDocumentModule
 from ellar.services.reflector import Reflector
+from ellar.testing import Test, TestClient
 
 from .config import ConfigTrustHostConfigure
 from .sample import AppAPIKey, ApplicationModule
 
-test_module = TestClientFactory.create_test_module_from_module(
+test_module = Test.create_test_module_from_module(
     module=ApplicationModule, config_module=get_class_import(ConfigTrustHostConfigure)
 )
 
 
 class TestStarletteCompatibility:
     def test_func_route(self):
-        client = test_module.get_client()
+        client = test_module.get_test_client()
         response = client.get("/func")
         assert response.status_code == 200
         assert response.text == "Hello, world!"
@@ -51,50 +45,50 @@ def test_func_route(self):
         assert response.text == ""
 
     def test_async_route(self):
-        client = test_module.get_client()
+        client = test_module.get_test_client()
         response = client.get("/async")
         assert response.status_code == 200
         assert response.text == "Hello, world!"
 
     def test_class_route(self):
-        client = test_module.get_client()
+        client = test_module.get_test_client()
         response = client.get("/classbase/class")
         assert response.status_code == 200
         assert response.text == "Hello, world!"
 
     def test_mounted_route(self):
-        client = test_module.get_client()
+        client = test_module.get_test_client()
         response = client.get("/users/")
         assert response.status_code == 200
         assert response.text == "Hello, everyone!"
 
     def test_mounted_route_path_params(self):
-        client = test_module.get_client()
+        client = test_module.get_test_client()
         response = client.get("/users/tomchristie")
         assert response.status_code == 200
         assert response.text == "Hello, tomchristie!"
 
     def test_subdomain_route(self):
-        client = test_module.get_client(base_url="https://foo.example.org/")
+        client = test_module.get_test_client(base_url="https://foo.example.org/")
 
         response = client.get("/")
         assert response.status_code == 200
         assert response.text == "Subdomain: foo"
 
     def test_websocket_route(self):
-        client = test_module.get_client()
+        client = test_module.get_test_client()
         with client.websocket_connect("/ws") as session:
             text = session.receive_text()
             assert text == "Hello, world!"
 
     def test_400(self):
-        client = test_module.get_client()
+        client = test_module.get_test_client()
         response = client.get("/404")
         assert response.status_code == 404
         assert response.json() == {"detail": "Not Found"}
 
     def test_405(self):
-        client = test_module.get_client()
+        client = test_module.get_test_client()
         response = client.post("/func")
         assert response.status_code == 405
         assert response.json() == {"detail": "Custom message"}
@@ -104,13 +98,13 @@ def test_405(self):
         assert response.json() == {"detail": "Custom message"}
 
     def test_500(self):
-        client = test_module.get_client(raise_server_exceptions=False)
+        client = test_module.get_test_client(raise_server_exceptions=False)
         response = client.get("/classbase/500")
         assert response.status_code == 500
         assert response.json() == {"detail": "Server Error"}
 
     def test_middleware(self):
-        client = test_module.get_client(base_url="http://incorrecthost")
+        client = test_module.get_test_client(base_url="http://incorrecthost")
         response = client.get("/func")
         assert response.status_code == 400
         assert response.text == "Invalid host header"
@@ -216,7 +210,7 @@ def test_app_staticfiles_route(self, tmpdir):
 
         config = Config(STATIC_DIRECTORIES=[tmpdir])
         injector = EllarInjector()
-        CoreServiceRegistration(injector, config=Config()).register_all()
+        _CoreServiceRegistration(injector, config=Config()).register_all()
         injector.container.register_instance(config)
         app = App(injector=injector, config=config)
         client = TestClient(app)
@@ -238,7 +232,7 @@ def test_app_staticfiles_with_different_static_path(self, tmpdir):
             STATIC_MOUNT_PATH="/static-modified", STATIC_DIRECTORIES=[tmpdir]
         )
         injector = EllarInjector()
-        CoreServiceRegistration(injector, config=Config()).register_all()
+        _CoreServiceRegistration(injector, config=Config()).register_all()
         injector.container.register_instance(config)
         app = App(injector=injector, config=config)
         client = TestClient(app)
@@ -288,7 +282,7 @@ def test_app_initialization_completion(self):
         injector = EllarInjector(
             auto_bind=False
         )  # will raise an exception is service is not registered
-        CoreServiceRegistration(injector, config=Config()).register_all()
+        _CoreServiceRegistration(injector, config=Config()).register_all()
         injector.container.register_instance(config)
 
         app = App(config=config, injector=injector)
@@ -312,7 +306,7 @@ async def catch(
         injector = EllarInjector(
             auto_bind=False
         )  # will raise an exception is service is not registered
-        CoreServiceRegistration(injector, config=Config()).register_all()
+        _CoreServiceRegistration(injector, config=Config()).register_all()
         injector.container.register_instance(config)
         app = App(config=config, injector=injector)
         app.add_exception_handler(CustomExceptionHandler())