orionis 0.436.0__py3-none-any.whl → 0.438.0__py3-none-any.whl

tests/foundation/config/session/test_foundation_config_session.py

@@ -7,11 +7,16 @@ class TestFoundationConfigSession(AsyncTestCase):
 
     async def testDefaultInitialization(self):
         """
-        Test that Session instance is initialized with correct default values.
+        Test default initialization of the Session instance.
+
+        Returns
+        -------
+        None
 
         Notes
         -----
-        Verifies default values for all attributes including secret_key generation.
+        Checks that all attributes of the Session instance are set to their correct default values,
+        including the generation of the secret_key.
         """
         session = Session()
         self.assertIsInstance(session.secret_key, str)
@@ -24,11 +29,15 @@ class TestFoundationConfigSession(AsyncTestCase):
 
     async def testSecretKeyValidation(self):
         """
-        Test validation for secret_key attribute.
+        Test validation of the secret_key attribute.
+
+        Returns
+        -------
+        None
 
         Notes
         -----
-        Verifies that invalid secret keys raise OrionisIntegrityException.
+        Ensures that providing an invalid secret_key raises an OrionisIntegrityException.
         """
         with self.assertRaises(OrionisIntegrityException):
             Session(secret_key="")  # Empty string
@@ -37,11 +46,15 @@ class TestFoundationConfigSession(AsyncTestCase):
 
     async def testSessionCookieValidation(self):
         """
-        Test validation for session_cookie attribute.
+        Test validation of the session_cookie attribute.
+
+        Returns
+        -------
+        None
 
         Notes
         -----
-        Verifies invalid cookie names raise OrionisIntegrityException.
+        Ensures that invalid session_cookie values raise an OrionisIntegrityException.
         """
         with self.assertRaises(OrionisIntegrityException):
             Session(session_cookie="")  # Empty string
@@ -52,11 +65,16 @@ class TestFoundationConfigSession(AsyncTestCase):
 
     async def testMaxAgeValidation(self):
         """
-        Test validation for max_age attribute.
+        Test validation of the max_age attribute.
+
+        Returns
+        -------
+        None
 
         Notes
         -----
-        Verifies invalid max_age values raise OrionisIntegrityException.
+        Ensures that invalid max_age values raise an OrionisIntegrityException.
+        Also verifies that None is accepted as a valid value.
         """
         with self.assertRaises(OrionisIntegrityException):
             Session(max_age="3600")  # String instead of int
@@ -68,11 +86,16 @@ class TestFoundationConfigSession(AsyncTestCase):
 
     async def testSameSiteValidation(self):
         """
-        Test validation and normalization for same_site attribute.
+        Test validation and normalization of the same_site attribute.
+
+        Returns
+        -------
+        None
 
         Notes
         -----
-        Verifies both string and enum inputs are properly handled.
+        Ensures that both string and enum inputs for same_site are handled correctly.
+        Also checks that invalid values raise an OrionisIntegrityException.
         """
         # Test string inputs (case-insensitive)
         session1 = Session(same_site="strict")
@@ -92,11 +115,15 @@ class TestFoundationConfigSession(AsyncTestCase):
 
     async def testPathValidation(self):
         """
-        Test validation for path attribute.
+        Test validation of the path attribute.
+
+        Returns
+        -------
+        None
 
         Notes
         -----
-        Verifies invalid paths raise OrionisIntegrityException.
+        Ensures that invalid path values raise an OrionisIntegrityException.
         """
         with self.assertRaises(OrionisIntegrityException):
             Session(path="")  # Empty string
@@ -107,11 +134,15 @@ class TestFoundationConfigSession(AsyncTestCase):
 
     async def testHttpsOnlyValidation(self):
         """
-        Test validation for https_only attribute.
+        Test validation of the https_only attribute.
+
+        Returns
+        -------
+        None
 
         Notes
         -----
-        Verifies non-boolean values raise OrionisIntegrityException.
+        Ensures that non-boolean values for https_only raise an OrionisIntegrityException.
         """
         with self.assertRaises(OrionisIntegrityException):
             Session(https_only="true")  # String instead of bool
@@ -120,11 +151,16 @@ class TestFoundationConfigSession(AsyncTestCase):
 
     async def testDomainValidation(self):
         """
-        Test validation for domain attribute.
+        Test validation of the domain attribute.
+
+        Returns
+        -------
+        None
 
         Notes
         -----
-        Verifies invalid domains raise OrionisIntegrityException.
+        Ensures that invalid domain values raise an OrionisIntegrityException.
+        Also verifies that None is accepted as a valid value.
         """
         with self.assertRaises(OrionisIntegrityException):
             Session(domain=".example.com")  # Starts with dot
@@ -139,11 +175,15 @@ class TestFoundationConfigSession(AsyncTestCase):
 
     async def testToDictMethod(self):
         """
-        Test the toDict method returns proper dictionary representation.
+        Test the toDict method of the Session instance.
+
+        Returns
+        -------
+        None
 
         Notes
         -----
-        Verifies all fields are included with correct values.
+        Ensures that the toDict method returns a dictionary containing all fields with correct values.
         """
         session = Session()
         result = session.toDict()
@@ -158,11 +198,16 @@ class TestFoundationConfigSession(AsyncTestCase):
 
     async def testKwOnlyInitialization(self):
         """
-        Test that Session requires keyword arguments for initialization.
+        Test enforcement of keyword-only initialization for Session.
+
+        Returns
+        -------
+        None
 
         Notes
         -----
-        Verifies the class enforces kw_only=True in its dataclass decorator.
+        Ensures that the Session class enforces keyword-only arguments during initialization
+        by raising a TypeError when positional arguments are provided.
         """
         with self.assertRaises(TypeError):
             Session("key", "session")

tests/foundation/config/startup/test_foundation_config_startup.py

@@ -18,33 +18,35 @@ from unittest.mock import Mock
 
 class TestFoundationConfigStartup(AsyncTestCase):
     """
-    Test suite for the Configuration dataclass.
+    Test suite for the `Configuration` dataclass, validating its structure, initialization,
+    type enforcement, mutability, equality, and dictionary conversion.
 
     Methods
     -------
-    testConfigurationIsDataclass()
-        Test that Configuration is a dataclass.
-    testDefaultInitialization()
-        Test default initialization of Configuration.
-    testAllSectionsHaveDefaultFactories()
-        Test that all fields have default factories.
-    testTypeValidationInPostInit()
-        Test type validation and dict conversion in __post_init__.
-    testToDictReturnsCompleteDictionary()
-        Test that toDict() returns all configuration sections.
-    testToDictReturnsNestedStructures()
-        Test that toDict() returns nested structures as dicts.
-    testMetadataIsAccessible()
-        Test that field metadata is accessible and correct.
-    testConfigurationIsMutable()
-        Test that Configuration is mutable.
-    testConfigurationEquality()
-        Test equality of Configuration instances.
+    testConfigurationIsDataclass
+        Verify that `Configuration` is a dataclass.
+    testDefaultInitialization
+        Ensure all fields of `Configuration` are initialized with their default factories and correct types.
+    testAllSectionsHaveDefaultFactories
+        Check that every field in `Configuration` has a callable default factory.
+    testTypeValidationInPostInit
+        Confirm that type validation and dictionary conversion occur in `__post_init__`,
+        and that invalid types raise `OrionisIntegrityException`.
+    testToDictReturnsCompleteDictionary
+        Assert that `toDict()` returns a dictionary containing all configuration sections.
+    testToDictReturnsNestedStructures
+        Ensure that nested configuration sections are represented as dictionaries in `toDict()` output.
+    testMetadataIsAccessible
+        Validate that field metadata is accessible and contains required keys and types.
+    testConfigurationIsMutable
+        Check that attributes of `Configuration` can be modified after initialization.
+    testConfigurationEquality
+        Test equality comparison between `Configuration` instances, especially with differing keys.
     """
 
     def testConfigurationIsDataclass(self):
         """
-        Test that Configuration is a dataclass.
+        Verify that `Configuration` is implemented as a dataclass.
 
         Returns
         -------
@@ -54,9 +56,8 @@ class TestFoundationConfigStartup(AsyncTestCase):
 
     def testDefaultInitialization(self):
         """
-        Test default initialization of Configuration.
-
-        Ensures all fields are initialized with their default factories.
+        Ensure all fields of `Configuration` are initialized with their default factories
+        and are instances of their respective entity classes.
 
         Returns
         -------
@@ -79,7 +80,7 @@ class TestFoundationConfigStartup(AsyncTestCase):
 
     def testAllSectionsHaveDefaultFactories(self):
         """
-        Test that all fields have default factories.
+        Check that every field in `Configuration` has a callable default factory.
 
         Returns
         -------
@@ -92,9 +93,9 @@ class TestFoundationConfigStartup(AsyncTestCase):
 
     def testTypeValidationInPostInit(self):
         """
-        Test type validation and dict conversion in __post_init__.
-
-        Ensures that dicts are converted to entities and wrong types raise OrionisIntegrityException.
+        Confirm that type validation and dictionary conversion occur in `__post_init__`.
+        Validates that dictionaries are converted to entity instances and invalid types
+        raise `OrionisIntegrityException`.
 
         Returns
         -------
@@ -104,7 +105,7 @@ class TestFoundationConfigStartup(AsyncTestCase):
         config = Configuration(app={"name": "TestApp"})
         self.assertIsInstance(config.app, App)
 
-        # Invalid types
+        # Invalid types for each section should raise an exception
         sections = [
             ('app', 123),
             ('auth', 123),
@@ -127,7 +128,7 @@ class TestFoundationConfigStartup(AsyncTestCase):
 
     def testToDictReturnsCompleteDictionary(self):
         """
-        Test that toDict() returns all configuration sections.
+        Assert that `toDict()` returns a dictionary containing all configuration sections.
 
         Returns
         -------
@@ -140,7 +141,8 @@ class TestFoundationConfigStartup(AsyncTestCase):
 
     def testToDictReturnsNestedStructures(self):
         """
-        Test that toDict() returns nested structures as dicts.
+        Ensure that nested configuration sections are represented as dictionaries
+        in the output of `toDict()`.
 
         Returns
         -------
@@ -155,7 +157,8 @@ class TestFoundationConfigStartup(AsyncTestCase):
 
     def testMetadataIsAccessible(self):
         """
-        Test that field metadata is accessible and correct.
+        Validate that field metadata is accessible and contains the 'description' key
+        as a string and the 'default' key.
 
         Returns
         -------
@@ -170,7 +173,7 @@ class TestFoundationConfigStartup(AsyncTestCase):
 
     def testConfigurationIsMutable(self):
         """
-        Test that Configuration is mutable.
+        Check that attributes of `Configuration` can be modified after initialization.
 
         Returns
         -------
@@ -185,7 +188,8 @@ class TestFoundationConfigStartup(AsyncTestCase):
 
     def testConfigurationEquality(self):
         """
-        Test equality of Configuration instances.
+        Test equality comparison between `Configuration` instances, ensuring that
+        instances with differing keys are not considered equal.
 
         Returns
         -------

tests/services/introspection/dependencies/test_reflect_dependencies.py

@@ -13,21 +13,52 @@ from tests.services.introspection.dependencies.mocks.mock_users_permissions impo
 
 class TestReflectDependencies(AsyncTestCase):
     """
-    Test suite for verifying the functionality of the ReflectDependencies class in resolving and reflecting dependencies for class constructors and methods.
-    This test class covers:
-        - Retrieval and resolution of constructor dependencies for the UserController class.
-        - Validation that constructor dependencies are correctly identified as instances of ClassDependency.
-        - Verification that resolved dependencies (such as 'user_repository') are instances of KnownDependency and have the expected module name, class name, full class path, and type.
-        - Reflection and resolution of method dependencies for specific methods (e.g., 'createUserWithPermissions').
-        - Validation that method dependencies are correctly identified as instances of MethodDependency.
-        - Verification that resolved method dependencies (such as 'user_permissions' and 'permissions') are instances of KnownDependency and have the expected attributes.
-        - Ensuring that unresolved dependencies lists are empty where appropriate.
+    Test suite for the ReflectDependencies class, which provides utilities for introspecting and resolving dependencies
+    in class constructors, methods, and callables.
+
+    This class contains asynchronous test cases that validate:
+        - The correct retrieval and resolution of constructor dependencies for the UserController class.
+        - The identification of constructor dependencies as instances of ClassDependency.
+        - The resolution of dependencies such as 'user_repository' as KnownDependency instances, including validation
+          of their module name, class name, full class path, and type.
+        - The reflection and resolution of method dependencies for specific methods (e.g., 'createUserWithPermissions'),
+          ensuring they are identified as MethodDependency instances.
+        - The resolution of method dependencies such as 'user_permissions' and 'permissions' as KnownDependency instances,
+          with correct attributes.
+        - That unresolved dependency lists are empty when all dependencies are resolved.
+
+    Attributes
+    ----------
+    Inherits from AsyncTestCase.
+
+    Methods
+    -------
+    testReflectionDependenciesGetConstructorDependencies()
+        Tests retrieval and validation of constructor dependencies for UserController.
+
+    testReflectionDependenciesGetMethodDependencies()
+        Tests retrieval and validation of method dependencies for the 'createUserWithPermissions' method.
+
+    testReflectionDependenciesGetCallableDependencies()
+        Tests retrieval and validation of dependencies for a sample asynchronous callable.
     """
 
     async def testReflectionDependenciesGetConstructorDependencies(self):
         """
-        Test that ReflectDependencies correctly retrieves and resolves constructor dependencies for the UserController class.
-        This test verifies:
+        Retrieves and validates the constructor dependencies for the UserController class using the ReflectDependencies utility.
+
+        Parameters
+        ----------
+        self : TestReflectDependencies
+            The test case instance.
+
+        Returns
+        -------
+        None
+
+        Notes
+        -----
+        This test ensures that:
             - The returned constructor dependencies are an instance of ClassDependency.
             - The list of unresolved dependencies is empty.
             - The 'user_repository' dependency is resolved as an instance of KnownDependency.
@@ -55,15 +86,25 @@ class TestReflectDependencies(AsyncTestCase):
 
     async def testReflectionDependenciesGetMethodDependencies(self):
         """
-        Tests the `getMethodDependencies` method of the `ReflectDependencies` class for the 'createUserWithPermissions' method
-        of the `UserController`.
-        This test verifies:
-            - The returned object is an instance of `MethodDependency`.
-            - There are no unresolved dependencies.
-            - The 'user_permissions' dependency is correctly resolved as an instance of `KnownDependency` with the expected
-              module name, class name, full class path, and type (`FakeUserWithPermissions`).
-            - The 'permissions' dependency is correctly resolved as an instance of `KnownDependency` with the expected
-              module name, class name, full class path, and type (`list[str]`).
+        Retrieves and validates the dependencies for the 'createUserWithPermissions' method of the UserController class
+        using the ReflectDependencies utility.
+
+        This test ensures that:
+            - The returned object is an instance of MethodDependency.
+            - The unresolved dependencies list is empty.
+            - The 'user_permissions' dependency is resolved as a KnownDependency with the expected module name,
+              class name, full class path, and type (FakeUserWithPermissions).
+            - The 'permissions' dependency is resolved as a KnownDependency with the expected module name,
+              class name, full class path, and type (list[str]).
+
+        Parameters
+        ----------
+        self : TestReflectDependencies
+            The test case instance.
+
+        Returns
+        -------
+        None
         """
 
         depend = ReflectDependencies(UserController)
@@ -97,12 +138,23 @@ class TestReflectDependencies(AsyncTestCase):
 
     async def testReflectionDependenciesGetCallableDependencies(self):
         """
-        Tests the `getCallableDependencies` method of the `ReflectDependencies` class for a callable function.
-        This test verifies:
-            - The returned dependencies are an instance of `MethodDependency`.
+        Tests the `getCallableDependencies` method of the `ReflectDependencies` class for a given asynchronous function.
+
+        Parameters
+        ----------
+        self : TestReflectDependencies
+            The test case instance.
+
+        Returns
+        -------
+        None
+
+        Notes
+        -----
+        This test checks that:
+            - The returned dependencies are an instance of `CallableDependency`.
             - There are no unresolved dependencies.
-            - The 'x' and 'y' parameters are correctly resolved as instances of `KnownDependency` with the expected
-              module name, class name, full class path, and type (`int`).
+            - The 'x' and 'y' parameters are resolved to their default integer values (3 and 4, respectively).
         """
 
         async def fake_function(x: int = 3, y: int = 4) -> int: