Fixed some failing tests

Author: eadwinCode

ellar/common/decorators/modules.py

@@ -60,7 +60,7 @@ def Module(
     template_folder: t.Optional[str] = "templates",
     base_directory: t.Optional[t.Union[Path, str]] = None,
     static_folder: str = "static",
-    modules: t.Sequence[t.Type] = tuple(),
+    modules: t.Sequence[t.Union[t.Type, t.Any]] = tuple(),
     commands: t.Sequence[t.Union[t.Callable, "EllarTyper"]] = tuple(),
 ) -> t.Callable:
     """
@@ -82,11 +82,11 @@ def Module(
 
     :param static_folder: Module static folder name
 
-    :param modules: List of Module Types - t.Type[MODULEBASE]
+    :param modules: List of Module Types - t.Type[ModuleBase]
 
     :param commands: List of Command Decorated functions and EllarTyper
 
-    :return: t.TYPE[MODULEBASE]
+    :return: t.TYPE[ModuleBase]
     """
     kwargs = AttributeDict(
         name=name,

tests/test_application/test_application_factory.py

@@ -1,7 +1,7 @@
 from starlette.routing import Host, Mount
 
 from ellar.common import Module
-from ellar.core import AppFactory, Config, ModuleBase, TestClient
+from ellar.core import AppFactory, Config, ModuleBase, ModuleConfigure, TestClient
 from ellar.di import EllarInjector
 
 from .sample import (
@@ -26,17 +26,17 @@ class BModule:
 
 
 def test_factory__read_all_module():
-    modules_dict = AppFactory.read_all_module(module=BModule)
+    modules_dict = AppFactory.read_all_module(ModuleConfigure(BModule))
     assert len(modules_dict) == 2
-    assert list(modules_dict.values())[0] is AModule
-    assert list(modules_dict.values())[1] is ApplicationModule
+    assert list(modules_dict.values())[0].module is AModule
+    assert list(modules_dict.values())[1].module is ApplicationModule
 
-    modules_list = AppFactory.get_all_modules(module=AModule)
+    modules_list = AppFactory.get_all_modules(ModuleConfigure(AModule))
     assert len(modules_list) == 2
-    assert modules_list[0] is AModule
-    assert modules_list[1] is ApplicationModule
+    assert modules_list[0].module is AModule
+    assert modules_list[1].module is ApplicationModule
 
-    modules_dict = AppFactory.read_all_module(module=ApplicationModule)
+    modules_dict = AppFactory.read_all_module(ModuleConfigure(ApplicationModule))
     assert len(modules_dict) == 0
 
 

tests/test_application/test_application_functions.py

@@ -126,6 +126,7 @@ def run_cleanup():
         app = App(
             config=Config(),
             injector=EllarInjector(),
+            routes=[],
             on_startup_event_handlers=[EventHandler(run_startup)],
             on_shutdown_event_handlers=[EventHandler(run_cleanup)],
         )
@@ -149,7 +150,9 @@ async def lifespan(app):
             yield
             cleanup_complete = True
 
-        app = App(config=Config(), injector=EllarInjector(), lifespan=lifespan)
+        app = App(
+            config=Config(), injector=EllarInjector(), lifespan=lifespan, routes=[]
+        )
 
         assert not startup_complete
         assert not cleanup_complete
@@ -214,7 +217,7 @@ def test_app_staticfiles_route(self, tmpdir):
         injector = EllarInjector()
         CoreServiceRegistration(injector, config=Config()).register_all()
         injector.container.register_instance(config)
-        app = App(injector=injector, config=config)
+        app = App(injector=injector, config=config, routes=[])
         client = TestClient(app)
 
         response = client.get("/static/example.txt")
@@ -236,7 +239,7 @@ def test_app_staticfiles_with_different_static_path(self, tmpdir):
         injector = EllarInjector()
         CoreServiceRegistration(injector, config=Config()).register_all()
         injector.container.register_instance(config)
-        app = App(injector=injector, config=config)
+        app = App(injector=injector, config=config, routes=[])
         client = TestClient(app)
 
         response = client.get("/static-modified/example.txt")
@@ -255,15 +258,15 @@ def test_app_install_module(self):
         assert module_instance is module_instance2
 
     def test_has_static_files(self, tmpdir):
-        app = App(injector=EllarInjector(), config=Config())
+        app = App(injector=EllarInjector(), config=Config(), routes=[])
         assert app.has_static_files is False
 
         config = Config(STATIC_DIRECTORIES=[tmpdir])
-        app = App(injector=EllarInjector(), config=config)
+        app = App(injector=EllarInjector(), config=config, routes=[])
         assert app.has_static_files
 
     def test_app_enable_versioning_and_versioning_scheme(self):
-        app = App(injector=EllarInjector(), config=Config())
+        app = App(injector=EllarInjector(), config=Config(), routes=[])
         assert app.config.VERSIONING_SCHEME
         assert isinstance(app.config.VERSIONING_SCHEME, DefaultAPIVersioning)
 
@@ -287,7 +290,7 @@ def test_app_initialization_completion(self):
         CoreServiceRegistration(injector, config=Config()).register_all()
         injector.container.register_instance(config)
 
-        app = App(config=config, injector=injector)
+        app = App(config=config, injector=injector, routes=[])
         assert injector.get(Reflector)
         assert injector.get(Config) is config
         assert injector.get(Environment) is app.jinja_environment
@@ -310,7 +313,7 @@ async def catch(
         )  # will raise an exception is service is not registered
         CoreServiceRegistration(injector, config=Config()).register_all()
         injector.container.register_instance(config)
-        app = App(config=config, injector=injector)
+        app = App(config=config, injector=injector, routes=[])
         app.add_exception_handler(CustomExceptionHandler())
 
         @get("/404")
@@ -361,7 +364,7 @@ def test_app_create_static_app(self, tmpdir):
             file.write("<file content>")
 
         config = Config(STATIC_DIRECTORIES=[tmpdir])
-        app = App(injector=EllarInjector(), config=config)
+        app = App(injector=EllarInjector(), config=config, routes=[])
         static_app = app.create_static_app()
         assert isinstance(static_app, StaticFiles)
         client = TestClient(static_app)
@@ -383,7 +386,7 @@ def test_app_reload_static_app(self, tmpdir):
             file.write("<file content>")
 
         config = Config(STATIC_DIRECTORIES=[tmpdir])
-        app = App(injector=EllarInjector(), config=config)
+        app = App(injector=EllarInjector(), config=config, routes=[])
         static_app_old = app._static_app
 
         app.reload_static_app()
@@ -396,7 +399,7 @@ def test_app_reload_static_app(self, tmpdir):
         assert res.text == "<file content>"
 
     def test_app_template_filter(self):
-        app = App(injector=EllarInjector(), config=Config())
+        app = App(injector=EllarInjector(), config=Config(), routes=[])
 
         @app.template_filter()
         def square(value):
@@ -421,7 +424,7 @@ def triple_function(value):
         assert result == "<html>filter square: 4, filter triple_function: 27</html>"
 
     def test_app_template_global(self):
-        app = App(injector=EllarInjector(), config=Config())
+        app = App(injector=EllarInjector(), config=Config(), routes=[])
 
         @app.template_global()
         def square(value):

tests/test_modules/test_module_ref.py

@@ -324,22 +324,16 @@ def test_run_application_ready_works():
     @Module()
     class TestModuleCycleExample(ModuleBase):
         _before_init_called = False
-        _app_ready_called = False
 
         @classmethod
         def before_init(cls, config: Config) -> None:
             cls._before_init_called = True
 
-        def application_ready(self, app) -> None:
-            self.__class__._app_ready_called = True
-
     assert TestModuleCycleExample._before_init_called is False
-    assert TestModuleCycleExample._app_ready_called is False
 
     AppFactory.create_from_app_module(TestModuleCycleExample)
 
     assert TestModuleCycleExample._before_init_called
-    assert TestModuleCycleExample._app_ready_called
 
 
 def test_module_request_events():

tests/test_openapi/test_module.py

@@ -9,7 +9,12 @@
 )
 from ellar.core.modules.ref import create_module_ref_factor
 from ellar.di import EllarInjector
-from ellar.openapi import OpenAPIDocumentBuilder, OpenAPIDocumentModule
+from ellar.openapi import (
+    OpenAPIDocumentBuilder,
+    OpenAPIDocumentModule,
+    ReDocDocumentGenerator,
+    SwaggerDocumentGenerator,
+)
 
 
 class CustomDocsGuard(GuardCanActivate):
@@ -37,35 +42,49 @@ def test_openapi_module_template_path_exist():
     assert len(list_of_html_contained_in_path) == 0
 
 
-def test_openapi_module_with_openapi_url_doesnot_exist_new_openapi_url():
+def test_openapi_module_with_openapi_url_doesnot_create_new_openapi_url():
     app = AppFactory.create_app()
+    client = TestClient(app)
     document = OpenAPIDocumentBuilder().build_document(app)
 
-    module_instance = app.install_module(
-        OpenAPIDocumentModule, openapi_url="/openapi_url.json", document=document
+    module_config = OpenAPIDocumentModule.module_configure(
+        openapi_url="/openapi_url.json",
+        document=document,
+        document_generator=SwaggerDocumentGenerator(),
     )
-    assert module_instance._openapi_url == "/openapi_url.json"
+    app.install_module(module_config)
+    res = client.get("/docs")
+    assert res.status_code == 200
+    assert "/openapi_url.json" in res.text
 
 
 def test_openapi_module_creates_openapi_url():
     app = AppFactory.create_app()
     document = OpenAPIDocumentBuilder().build_document(app)
+    client = TestClient(app)
+
+    module_config = OpenAPIDocumentModule.module_configure(
+        document=document, document_generator=SwaggerDocumentGenerator()
+    )
+    app.install_module(module_config)
+    res = client.get("/docs")
 
-    module_instance = app.install_module(OpenAPIDocumentModule, document=document)
-    assert module_instance._openapi_url == "/openapi.json"
+    assert res.status_code == 200
+    assert "/openapi.json" in res.text
 
 
 def test_openapi_module_creates_swagger_endpoint():
     app = AppFactory.create_app()
     document = OpenAPIDocumentBuilder().build_document(app)
 
-    module_instance = app.install_module(
-        OpenAPIDocumentModule, document=document, openapi_url="/openapi_url.json"
-    )
-
-    module_instance.setup_swagger_doc(
-        title="Swagger Doc Test", path="docs-swagger-test"
+    module_config = OpenAPIDocumentModule.module_configure(
+        openapi_url="/openapi_url.json",
+        document=document,
+        document_generator=SwaggerDocumentGenerator(
+            title="Swagger Doc Test", path="docs-swagger-test"
+        ),
     )
+    app.install_module(module_config)
     client = TestClient(app)
     response = client.get("docs-swagger-test")
     assert response.status_code == 200
@@ -78,13 +97,16 @@ def test_openapi_module_creates_swagger_endpoint():
 def test_openapi_module_creates_redocs_endpoint():
     app = AppFactory.create_app()
     document = OpenAPIDocumentBuilder().build_document(app)
-
-    module_instance = app.install_module(
-        OpenAPIDocumentModule, document=document, openapi_url="/openapi_url.json"
+    module_config = OpenAPIDocumentModule.module_configure(
+        openapi_url="/openapi_url.json",
+        document=document,
+        document_generator=ReDocDocumentGenerator(
+            title="Redocs Doc Test", path="docs-redocs-test"
+        ),
     )
-
-    module_instance.setup_redocs(title="Redocs Doc Test", path="docs-redocs-test")
+    app.install_module(module_config)
     client = TestClient(app)
+
     response = client.get("docs-redocs-test")
     assert response.status_code == 200
 
@@ -97,11 +119,12 @@ def test_openapi_module_with_route_guards():
     app = AppFactory.create_app(providers=[CustomDocsGuard])
     document = OpenAPIDocumentBuilder().build_document(app)
 
-    module_instance = app.install_module(
-        OpenAPIDocumentModule, document=document, guards=[CustomDocsGuard]
+    module_config = OpenAPIDocumentModule.module_configure(
+        document=document,
+        guards=[CustomDocsGuard],
+        document_generator=(SwaggerDocumentGenerator(), ReDocDocumentGenerator()),
     )
-    module_instance.setup_redocs()
-    module_instance.setup_swagger_doc()
+    app.install_module(module_config)
     client = TestClient(app)
 
     response = client.get("openapi.json")