increase test coverage

Author: eadwinCode

ellar/core/conf/config.py

@@ -50,7 +50,7 @@ def set_defaults(self, **kwargs: t.Any) -> "Config":
             self._data.setdefault(k, v)
         return self
 
-    def __repr__(self) -> str:
+    def __repr__(self) -> str:  # pragma: no cover
         hidden_values = {key: "..." for key in self._data.keys()}
         return f"<Configuration {repr(hidden_values)}, settings_module: {self.config_module}>"
 

ellar/core/conf/mixins.py

@@ -52,9 +52,9 @@ def validate(cls: t.Type["TExceptionHandler"], v: t.Any) -> t.Any:
             return v
 
         if inspect.isclass(v):
-            raise ValueError(f"Expected TExceptionHandler, received: {v}")
+            raise ValueError(f"Expected 'ExceptionHandler', received: {v}")
 
-        raise ValueError(f"Expected TExceptionHandler, received: {type(v)}")
+        raise ValueError(f"Expected 'ExceptionHandler', received: {type(v)}")
 
 
 class TVersioning(BaseAPIVersioning):
@@ -81,7 +81,9 @@ def __get_validators__(
     @classmethod
     def validate(cls: t.Type["Middleware"], v: t.Any) -> t.Any:
         if not isinstance(v, Middleware):
-            raise ValueError(f"Expected Middleware, received: {type(v)}")
+            raise ValueError(
+                f"Expected Type/instance of Middleware, received: {type(v)}"
+            )
         return v
 
 

tests/test_cache/test_operation_cache.py

@@ -53,8 +53,9 @@ async def homepage():
             mr,
         ]
     ).get_client()
-
     res = client.get("/index")
+    for i in range(2):
+        res = client.get("/index")
 
     assert res.json() == dict(message="Response Information cached Async")
     assert res.status_code == 200

tests/test_conf/test_default_conf.py

@@ -93,18 +93,30 @@ def test_configuration_settings_can_be_loaded_through_constructor():
     assert config.REDIRECT_SLASHES is True
     assert config.STATIC_MOUNT_PATH == "/static-changed"
 
+    config.set_defaults(
+        DEBUG=False, SECRET_KEY="your-secret-key-changed-again", NEW_KEY="Some new key"
+    )
+    assert config.DEBUG  # not changed
+    assert config.SECRET_KEY == "your-secret-key-changed"  # not changed
+    assert config.NEW_KEY == "Some new key"  # Added since its doesn't exist
+
 
 def test_configuration_can_be_changed_during_instantiation():
+    def int_encode(value):
+        pass
+
     config = Config(
         config_module=overriding_settings_path,
         DEBUG=False,
         SOME_NEW_CONFIGS="some new configuration values",
         JINJA_TEMPLATES_OPTIONS={"auto_reload": False},
+        SERIALIZER_CUSTOM_ENCODER={int: int_encode},
     )
 
     assert config.DEBUG is False
     assert config.JINJA_TEMPLATES_OPTIONS == {"auto_reload": False}
     assert config.SOME_NEW_CONFIGS == "some new configuration values"
+    assert config.SERIALIZER_CUSTOM_ENCODER[int] == int_encode
 
 
 def test_can_set_defaults_a_configuration_instance_once():

tests/test_conf/test_mixins.py

@@ -0,0 +1,45 @@
+import pytest
+
+from ellar.cache.backends.local_cache import LocalMemCacheBackend
+from ellar.core import Config
+
+
+def test_invalid_cached_backend_config():
+    with pytest.raises(ValueError, match="Expected BaseCacheBackend, received:"):
+        Config(CACHES={"default": type("whatever", (), {})})
+
+
+def test_cache_backend_without_default_raise_exception():
+    with pytest.raises(
+        ValueError, match="CACHES configuration must have a 'default' key"
+    ):
+        Config(CACHES={"local": LocalMemCacheBackend()})
+
+
+def test_invalid_exception_handler_config():
+    invalid_type = type("whatever", (), {})
+    with pytest.raises(ValueError, match="Expected 'ExceptionHandler', received:"):
+        Config(EXCEPTION_HANDLERS=[invalid_type])
+
+    with pytest.raises(ValueError, match="Expected 'ExceptionHandler', received:"):
+        Config(EXCEPTION_HANDLERS=[invalid_type()])
+
+
+def test_invalid_versioning_config():
+    invalid_type = type("whatever", (), {})
+    with pytest.raises(ValueError, match=r"Expected BaseAPIVersioning, received: "):
+        Config(VERSIONING_SCHEME=invalid_type())
+
+
+def test_invalid_middleware_config():
+    invalid_type = type("whatever", (), {})
+    with pytest.raises(
+        ValueError, match=r"Expected Type/instance of Middleware, received: "
+    ):
+        Config(MIDDLEWARE=[invalid_type()])
+
+
+def test_invalid_event_handler_config():
+    invalid_type = type("whatever", (), {})
+    with pytest.raises(ValueError, match=r"Expected EventHandler, received:"):
+        Config(ON_REQUEST_STARTUP=[invalid_type()])

tests/test_events.py

@@ -1,6 +1,7 @@
 import pytest
 
 from ellar.constants import NOT_SET
+from ellar.core import Config
 from ellar.core.events import EventHandler, RouterEventManager
 
 
@@ -54,3 +55,15 @@ def another_function():
     route_manager -= valid_function_2
 
     assert len(route_manager) == 1
+
+
+async def test_valid_event_config(anyio_backend):
+    called = 0
+
+    def valid_function_1():
+        nonlocal called
+        called += 1
+
+    config = Config(ON_REQUEST_STARTUP=[EventHandler(valid_function_1)])
+    await config.ON_REQUEST_STARTUP[0].run()
+    assert called == 1

tests/test_exceptions/test_custom_exceptions.py

@@ -74,12 +74,14 @@ def error_500(ctx: IHostContext, exc: Exception):
 
 def test_invalid_handler_raise_exception():
     with pytest.raises(ValidationError) as ex:
-        Config(EXCEPTION_HANDLERS=[InvalidExceptionHandler])
+        Config(
+            EXCEPTION_HANDLERS=[InvalidExceptionHandler, OverrideAPIExceptionHandler()]
+        )
 
     assert ex.value.errors() == [
         {
             "loc": ("EXCEPTION_HANDLERS", 0),
-            "msg": "Expected TExceptionHandler, received: <class 'tests.test_exceptions.test_custom_exceptions.InvalidExceptionHandler'>",
+            "msg": "Expected 'ExceptionHandler', received: <class 'tests.test_exceptions.test_custom_exceptions.InvalidExceptionHandler'>",
             "type": "value_error",
         }
     ]
@@ -90,7 +92,7 @@ def test_invalid_handler_raise_exception():
     assert ex.value.errors() == [
         {
             "loc": ("EXCEPTION_HANDLERS", 0),
-            "msg": "Expected TExceptionHandler, received: "
+            "msg": "Expected 'ExceptionHandler', received: "
             "<class 'tests.test_exceptions.test_custom_exceptions.InvalidExceptionHandler'>",
             "type": "value_error",
         }
@@ -114,7 +116,7 @@ class InvalidExceptionSetup(IExceptionHandler):
             exception_type_or_code = ""
 
             def catch(self, ctx: IHostContext, exc: t.Any) -> t.Union[Response, t.Any]:
-                pass
+                """do nothing"""
 
         assert "'exception_type_or_code' must be defined" in str(ex.value)
 
@@ -124,7 +126,7 @@ class InvalidExceptionSetup2(IExceptionHandler):
             exception_type_or_code = InvalidExceptionHandler
 
             def catch(self, ctx: IHostContext, exc: t.Any) -> t.Union[Response, t.Any]:
-                pass
+                """do nothing"""
 
         assert "'exception_type_or_code' is not a valid type" in str(ex.value)