orionis 0.437.0__py3-none-any.whl → 0.439.0__py3-none-any.whl

tests/foundation/config/logging/test_foundation_config_logging_channels.py

@@ -10,47 +10,48 @@ from orionis.test.cases.asynchronous import AsyncTestCase
 
 class TestFoundationConfigLoggingChannels(AsyncTestCase):
     """
-    Test cases for the Channels logging configuration class.
+    Unit tests for the `Channels` logging configuration class.
 
-    This class contains unit tests for the `Channels` class, ensuring correct
-    initialization, type validation, custom configuration, dictionary conversion,
-    hashability, and keyword-only initialization.
-
-    Attributes
-    ----------
-    None
+    This test class validates the correct initialization, type enforcement,
+    custom configuration, dictionary conversion, hashability, and keyword-only
+    initialization of the `Channels` class.
 
     Methods
     -------
     testDefaultValues()
-        Test that Channels instance is created with correct default values.
+        Verify that a Channels instance is initialized with the correct default values.
     testStackValidation()
-        Test stack attribute type validation.
+        Ensure that only Stack instances are accepted for the stack attribute.
     testHourlyValidation()
-        Test hourly attribute type validation.
+        Ensure that only Hourly instances are accepted for the hourly attribute.
     testDailyValidation()
-        Test daily attribute type validation.
+        Ensure that only Daily instances are accepted for the daily attribute.
     testWeeklyValidation()
-        Test weekly attribute type validation.
+        Ensure that only Weekly instances are accepted for the weekly attribute.
     testMonthlyValidation()
-        Test monthly attribute type validation.
+        Ensure that only Monthly instances are accepted for the monthly attribute.
     testChunkedValidation()
-        Test chunked attribute type validation.
+        Ensure that only Chunked instances are accepted for the chunked attribute.
     testCustomConfigurations()
-        Test that custom channel configurations are properly stored and validated.
+        Validate that custom channel configurations are correctly assigned and validated.
     testToDictMethod()
-        Test that toDict returns proper dictionary representation.
+        Check that the toDict method returns the correct dictionary representation.
     testHashability()
-        Test that Channels maintains hashability due to unsafe_hash=True.
+        Confirm that Channels instances are hashable due to unsafe_hash=True.
     testKwOnlyInitialization()
-        Test that Channels enforces keyword-only initialization.
+        Ensure that Channels enforces keyword-only initialization.
     """
 
     async def testDefaultValues(self):
         """
-        Test that Channels instance is created with correct default values.
+        Verify that a Channels instance is initialized with the correct default values.
+
+        Ensures that all channel configuration attributes are instances of their
+        respective classes upon default initialization.
 
-        Ensures all channel configurations are properly initialized with their default values.
+        Returns
+        -------
+        None
         """
         channels = Channels()
         self.assertIsInstance(channels.stack, Stack)
@@ -62,9 +63,7 @@ class TestFoundationConfigLoggingChannels(AsyncTestCase):
 
     async def testStackValidation(self):
         """
-        Test stack attribute type validation.
-
-        Verifies that only Stack instances are accepted for the stack attribute.
+        Ensure that only Stack instances are accepted for the stack attribute.
 
         Raises
         ------
@@ -82,7 +81,7 @@ class TestFoundationConfigLoggingChannels(AsyncTestCase):
 
     async def testHourlyValidation(self):
         """
-        Test hourly attribute type validation.
+        Ensure that only Hourly instances are accepted for the hourly attribute.
 
         Raises
         ------
@@ -98,7 +97,7 @@ class TestFoundationConfigLoggingChannels(AsyncTestCase):
 
     async def testDailyValidation(self):
         """
-        Test daily attribute type validation.
+        Ensure that only Daily instances are accepted for the daily attribute.
 
         Raises
         ------
@@ -114,7 +113,7 @@ class TestFoundationConfigLoggingChannels(AsyncTestCase):
 
     async def testWeeklyValidation(self):
         """
-        Test weekly attribute type validation.
+        Ensure that only Weekly instances are accepted for the weekly attribute.
 
         Raises
         ------
@@ -130,7 +129,7 @@ class TestFoundationConfigLoggingChannels(AsyncTestCase):
 
     async def testMonthlyValidation(self):
         """
-        Test monthly attribute type validation.
+        Ensure that only Monthly instances are accepted for the monthly attribute.
 
         Raises
         ------
@@ -146,7 +145,7 @@ class TestFoundationConfigLoggingChannels(AsyncTestCase):
 
     async def testChunkedValidation(self):
         """
-        Test chunked attribute type validation.
+        Ensure that only Chunked instances are accepted for the chunked attribute.
 
         Raises
         ------
@@ -162,10 +161,14 @@ class TestFoundationConfigLoggingChannels(AsyncTestCase):
 
     async def testCustomConfigurations(self):
         """
-        Test that custom channel configurations are properly stored and validated.
+        Validate that custom channel configurations are correctly assigned and validated.
 
-        Ensures that custom channel instances are correctly assigned and their
-        properties are properly set.
+        Ensures that custom channel instances are properly set and their properties
+        are accurately assigned.
+
+        Returns
+        -------
+        None
         """
         custom_stack = Stack(path="custom/stack.log")
         custom_hourly = Hourly(path="custom/hourly.log")
@@ -191,9 +194,14 @@ class TestFoundationConfigLoggingChannels(AsyncTestCase):
 
     async def testToDictMethod(self):
         """
-        Test that toDict returns proper dictionary representation.
+        Check that the toDict method returns the correct dictionary representation.
+
+        Ensures that the `toDict` method produces a dictionary with the expected
+        structure and types for each channel.
 
-        Ensures that the `toDict` method returns a dictionary with the correct structure.
+        Returns
+        -------
+        None
         """
         channels = Channels()
         channels_dict = channels.toDict()
@@ -207,9 +215,13 @@ class TestFoundationConfigLoggingChannels(AsyncTestCase):
 
     async def testHashability(self):
         """
-        Test that Channels maintains hashability due to unsafe_hash=True.
+        Confirm that Channels instances are hashable due to unsafe_hash=True.
+
+        Ensures that Channels objects can be used in sets and as dictionary keys.
 
-        Ensures that Channels instances can be used in sets and as dictionary keys.
+        Returns
+        -------
+        None
         """
         channels1 = Channels()
         channels2 = Channels()
@@ -223,7 +235,7 @@ class TestFoundationConfigLoggingChannels(AsyncTestCase):
 
     async def testKwOnlyInitialization(self):
         """
-        Test that Channels enforces keyword-only initialization.
+        Ensure that Channels enforces keyword-only initialization.
 
         Raises
         ------

tests/foundation/config/logging/test_foundation_config_logging_monthly.py

@@ -5,24 +5,26 @@ from orionis.test.cases.asynchronous import AsyncTestCase
 
 class TestFoundationConfigLoggingMonthly(AsyncTestCase):
     """
-    Test cases for the Monthly logging configuration class.
+    Test suite for the `Monthly` logging configuration class.
 
-    Notes
-    -----
-    This test suite verifies the correct behavior of the `Monthly` logging configuration,
-    including default values, attribute validation, dictionary conversion, hashability,
-    and keyword-only initialization.
+    This class contains asynchronous test cases to validate the behavior of the
+    `Monthly` logging configuration, including default values, attribute validation,
+    dictionary conversion, hashability, and keyword-only initialization.
     """
 
     async def testDefaultValues(self):
         """
-        Test that Monthly instance is created with correct default values.
+        Test the default attribute values of a Monthly instance.
 
-        Verifies
-        --------
-        - Default path is "storage/log/application.log".
-        - Default level is `Level.INFO.value`.
-        - Default retention_months is 4.
+        Returns
+        -------
+        None
+
+        Asserts
+        -------
+        - The default path is "storage/log/monthly.log".
+        - The default level is `Level.INFO.value`.
+        - The default retention_months is 4.
         """
         monthly = Monthly()
         self.assertEqual(monthly.path, "storage/log/monthly.log")
@@ -31,12 +33,16 @@ class TestFoundationConfigLoggingMonthly(AsyncTestCase):
 
     async def testPathValidation(self):
         """
-        Test path attribute validation.
+        Validate the `path` attribute for correct and incorrect values.
+
+        Returns
+        -------
+        None
 
-        Verifies
-        --------
-        - Empty or non-string paths raise `OrionisIntegrityException`.
-        - Valid string paths do not raise exceptions.
+        Asserts
+        -------
+        - Raises OrionisIntegrityException for empty or non-string paths.
+        - Does not raise for valid string paths.
         """
         with self.assertRaises(OrionisIntegrityException):
             Monthly(path="")
@@ -49,12 +55,16 @@ class TestFoundationConfigLoggingMonthly(AsyncTestCase):
 
     async def testLevelValidation(self):
         """
-        Test level attribute validation with different input types.
+        Validate the `level` attribute with various input types.
+
+        Returns
+        -------
+        None
 
-        Verifies
-        --------
+        Asserts
+        -------
         - Accepts string, int, and enum values for level.
-        - Invalid level values raise `OrionisIntegrityException`.
+        - Raises OrionisIntegrityException for invalid level values.
         """
         # Test string level
         monthly = Monthly(level="debug")
@@ -78,12 +88,16 @@ class TestFoundationConfigLoggingMonthly(AsyncTestCase):
 
     async def testRetentionMonthsValidation(self):
         """
-        Test retention_months attribute validation.
+        Validate the `retention_months` attribute for correct and incorrect values.
 
-        Verifies
-        --------
+        Returns
+        -------
+        None
+
+        Asserts
+        -------
         - Accepts valid integer values for retention_months.
-        - Invalid values raise `OrionisIntegrityException`.
+        - Raises OrionisIntegrityException for invalid values.
         """
         # Test valid values
         try:
@@ -105,9 +119,16 @@ class TestFoundationConfigLoggingMonthly(AsyncTestCase):
 
     async def testWhitespaceHandling(self):
         """
-        Test whitespace handling in path and level attributes.
-        """
+        Test handling of leading and trailing whitespace in `path` and `level` attributes.
+
+        Returns
+        -------
+        None
 
+        Asserts
+        -------
+        - Raises OrionisIntegrityException if whitespace is not properly handled.
+        """
         with self.assertRaises(OrionisIntegrityException):
             monthly = Monthly(path="  logs/app.log  ", level="  debug  ")
             self.assertEqual(monthly.path, "  logs/app.log  ")
@@ -115,11 +136,15 @@ class TestFoundationConfigLoggingMonthly(AsyncTestCase):
 
     async def testToDictMethod(self):
         """
-        Test that toDict returns proper dictionary representation.
+        Test the `toDict` method for correct dictionary representation.
+
+        Returns
+        -------
+        None
 
-        Verifies
-        --------
-        - Output is a dictionary with correct keys and values.
+        Asserts
+        -------
+        - The output is a dictionary with correct keys and values.
         """
         monthly = Monthly()
         monthly_dict = monthly.toDict()
@@ -130,11 +155,15 @@ class TestFoundationConfigLoggingMonthly(AsyncTestCase):
 
     async def testCustomValuesToDict(self):
         """
-        Test that custom values are properly included in dictionary.
+        Test that custom attribute values are reflected in the dictionary output.
+
+        Returns
+        -------
+        None
 
-        Verifies
-        --------
-        - Custom path, level, and retention_months are reflected in the output dictionary.
+        Asserts
+        -------
+        - Custom path, level, and retention_months are present in the output dictionary.
         """
         custom_monthly = Monthly(
             path="custom/logs/app.log",
@@ -148,11 +177,16 @@ class TestFoundationConfigLoggingMonthly(AsyncTestCase):
 
     async def testHashability(self):
         """
-        Test that Monthly maintains hashability due to unsafe_hash=True.
+        Test that Monthly instances are hashable and can be used in sets.
 
-        Verifies
-        --------
-        - Monthly instances can be added to a set and compared by value.
+        Returns
+        -------
+        None
+
+        Asserts
+        -------
+        - Monthly instances with identical attributes are considered equal in a set.
+        - Monthly instances with different attributes are considered distinct.
         """
         monthly1 = Monthly()
         monthly2 = Monthly()
@@ -168,9 +202,13 @@ class TestFoundationConfigLoggingMonthly(AsyncTestCase):
         """
         Test that Monthly enforces keyword-only initialization.
 
-        Verifies
-        --------
-        - Positional arguments raise TypeError.
+        Returns
+        -------
+        None
+
+        Asserts
+        -------
+        - Raises TypeError when positional arguments are used.
         """
         with self.assertRaises(TypeError):
             Monthly("path.log", "info", 4)

tests/foundation/config/logging/test_foundation_config_logging_stack.py

@@ -5,19 +5,23 @@ from orionis.test.cases.asynchronous import AsyncTestCase
 
 class TestFoundationConfigLoggingStack(AsyncTestCase):
     """
-    Test cases for the Stack logging configuration class.
+    Asynchronous unit tests for the Stack logging configuration class.
 
-    This class contains asynchronous unit tests for the Stack class, 
-    validating default values, attribute validation, dictionary representation, 
-    hashability, and keyword-only initialization.
+    This test class validates the behavior of the Stack class, including default values,
+    attribute validation, dictionary conversion, hashability, and enforcement of keyword-only
+    initialization.
     """
 
     async def testDefaultValues(self):
         """
-        Test default values of Stack.
+        Test that Stack initializes with correct default values.
 
-        Ensures that a Stack instance is created with the correct default values.
-        Verifies that the default path and level match the expected values from the class definition.
+        Checks that the default path and level attributes of a Stack instance match
+        the expected class defaults.
+
+        Returns
+        -------
+        None
         """
         stack = Stack()
         self.assertEqual(stack.path, "storage/log/stack.log")
@@ -25,9 +29,10 @@ class TestFoundationConfigLoggingStack(AsyncTestCase):
 
     async def testPathValidation(self):
         """
-        Test validation of the path attribute.
+        Validate the path attribute for correct type and non-emptiness.
 
-        Checks that empty or non-string paths raise exceptions, and that valid paths are accepted.
+        Ensures that providing an empty string or a non-string value for the path
+        raises an OrionisIntegrityException, while a valid string path is accepted.
 
         Raises
         ------
@@ -48,9 +53,10 @@ class TestFoundationConfigLoggingStack(AsyncTestCase):
 
     async def testLevelValidation(self):
         """
-        Test validation of the level attribute with different input types.
+        Validate the level attribute with various input types.
 
-        Verifies that string, int, and enum level values are properly handled.
+        Verifies that the level attribute accepts string, integer, and enum values
+        corresponding to valid logging levels, and raises exceptions for invalid values.
 
         Raises
         ------
@@ -84,8 +90,15 @@ class TestFoundationConfigLoggingStack(AsyncTestCase):
     async def testWhitespaceHandling(self):
         """
         Test handling of whitespace in path and level attributes.
-        """
 
+        Ensures that leading or trailing whitespace in the path attribute is not accepted
+        and raises an OrionisIntegrityException.
+
+        Raises
+        ------
+        OrionisIntegrityException
+            If the path contains leading or trailing whitespace.
+        """
         with self.assertRaises(OrionisIntegrityException):
             spaced_path = "  logs/app.log  "
             stack = Stack(path=spaced_path)
@@ -93,14 +106,14 @@ class TestFoundationConfigLoggingStack(AsyncTestCase):
 
     async def testToDictMethod(self):
         """
-        Test the toDict method for dictionary representation.
+        Test the toDict method for correct dictionary representation.
 
-        Ensures that both path and level are correctly included in the dictionary.
+        Verifies that the dictionary returned by toDict contains the correct path and
+        level values for a Stack instance with default attributes.
 
         Returns
         -------
-        dict
-            Dictionary representation of the Stack instance.
+        None
         """
         stack = Stack()
         stack_dict = stack.toDict()
@@ -111,9 +124,14 @@ class TestFoundationConfigLoggingStack(AsyncTestCase):
 
     async def testCustomValuesToDict(self):
         """
-        Test custom values in dictionary representation.
+        Test dictionary representation with custom attribute values.
+
+        Ensures that custom path and level values are accurately reflected in the
+        dictionary returned by toDict.
 
-        Ensures that custom path and level values are properly included in the dictionary.
+        Returns
+        -------
+        None
         """
         custom_stack = Stack(
             path="custom/logs/app.log",
@@ -125,9 +143,14 @@ class TestFoundationConfigLoggingStack(AsyncTestCase):
 
     async def testHashability(self):
         """
-        Test hashability of Stack instances.
+        Test that Stack instances are hashable.
 
-        Ensures that Stack instances can be used in sets and as dictionary keys due to unsafe_hash=True.
+        Verifies that Stack instances can be added to sets and used as dictionary keys,
+        and that instances with identical attributes are considered equal.
+
+        Returns
+        -------
+        None
         """
         stack1 = Stack()
         stack2 = Stack()
@@ -141,9 +164,10 @@ class TestFoundationConfigLoggingStack(AsyncTestCase):
 
     async def testKwOnlyInitialization(self):
         """
-        Test enforcement of keyword-only initialization.
+        Test enforcement of keyword-only initialization for Stack.
 
-        Ensures that Stack cannot be initialized with positional arguments.
+        Ensures that attempting to initialize Stack with positional arguments raises
+        a TypeError.
 
         Raises
         ------

tests/foundation/config/queue/test_foundation_config_queue_brokers.py

@@ -4,6 +4,7 @@ from orionis.foundation.exceptions.integrity import OrionisIntegrityException
 from orionis.test.cases.asynchronous import AsyncTestCase
 
 class TestFoundationConfigQueueBrokers(AsyncTestCase):
+
     async def testDefaultInitialization(self):
         """
         Test that Brokers instance is initialized with correct default values.

tests/foundation/config/root/test_foundation_config_root_paths.py

@@ -4,42 +4,36 @@ from orionis.test.cases.asynchronous import AsyncTestCase
 
 class TestFoundationConfigRootPaths(AsyncTestCase):
     """
-    Test suite for the Paths dataclass which defines the project directory structure.
-
-    This class verifies the integrity of path definitions, default values,
-    and the behavior of accessor methods.
-
-    Methods
-    -------
-    testDefaultPathsInstantiation()
-        Test that a Paths instance can be created with default values.
-    testAllPathsAreStrings()
-        Test that all path attributes are strings.
-    testPathValidationRejectsNonStringValues()
-        Test that non-string path values raise OrionisIntegrityException.
-    testToDictReturnsCompleteDictionary()
-        Test that toDict() returns a complete dictionary of all paths.
-    testFrozenDataclassBehavior()
-        Test that the dataclass is truly frozen (immutable).
-    testPathMetadataIsAccessible()
-        Test that path metadata is properly defined and accessible.
+    Test suite for the `Paths` dataclass, which defines the project directory structure.
+
+    This class contains asynchronous unit tests to verify the integrity, default values,
+    type constraints, immutability, and metadata accessibility of the `Paths` dataclass.
     """
 
     def testDefaultPathsInstantiation(self):
         """
-        Test that a Paths instance can be created with default values.
+        Test instantiation of `Paths` with default values.
+
+        Ensures that a `Paths` instance can be created using default arguments and
+        that the resulting object is an instance of `Paths`.
 
-        Ensures that all default paths are correctly initialized and
-        the instance is properly constructed.
+        Returns
+        -------
+        None
         """
         paths = Paths()
         self.assertIsInstance(paths, Paths)
 
     def testAllPathsAreStrings(self):
         """
-        Test that all path attributes are strings.
+        Verify that all attributes of `Paths` are strings.
+
+        Iterates through all fields of the `Paths` dataclass and asserts that each
+        attribute is a non-empty string.
 
-        Ensures that every field in Paths is a string by default.
+        Returns
+        -------
+        None
         """
         paths = Paths()
         for field_name in paths.__dataclass_fields__:
@@ -49,25 +43,24 @@ class TestFoundationConfigRootPaths(AsyncTestCase):
 
     def testPathValidationRejectsNonStringValues(self):
         """
-        Test that non-string path values raise OrionisIntegrityException.
+        Ensure non-string path values raise `OrionisIntegrityException`.
 
-        Verifies that the __post_init__ validation rejects non-string values
-        for all path fields.
+        Attempts to instantiate `Paths` with a non-string value for a path field
+        and asserts that an `OrionisIntegrityException` is raised.
 
-        Raises
-        ------
-        OrionisIntegrityException
-            If a non-string value is provided.
+        Returns
+        -------
+        None
         """
         with self.assertRaises(OrionisIntegrityException):
             Paths(console_scheduler=123)
 
     def testToDictReturnsCompleteDictionary(self):
         """
-        Test that toDict() returns a complete dictionary of all paths.
+        Test that `toDict()` returns a complete dictionary of all path fields.
 
-        Verifies that the returned dictionary contains all path fields
-        with their current values.
+        Asserts that the dictionary returned by `toDict()` contains all fields
+        defined in the `Paths` dataclass and that the dictionary has the correct length.
 
         Returns
         -------
@@ -82,15 +75,14 @@ class TestFoundationConfigRootPaths(AsyncTestCase):
 
     def testFrozenDataclassBehavior(self):
         """
-        Test that the dataclass is truly frozen (immutable).
+        Verify that the `Paths` dataclass is immutable (frozen).
 
-        Verifies that attempts to modify attributes after creation
-        raise exceptions.
+        Attempts to modify an attribute of a `Paths` instance after creation and
+        asserts that an exception is raised due to immutability.
 
-        Raises
-        ------
-        Exception
-            If an attempt is made to modify a frozen dataclass.
+        Returns
+        -------
+        None
         """
         paths = Paths()
         with self.assertRaises(Exception):
@@ -98,10 +90,11 @@ class TestFoundationConfigRootPaths(AsyncTestCase):
 
     def testPathMetadataIsAccessible(self):
         """
-        Test that path metadata is properly defined and accessible.
+        Check accessibility and structure of path field metadata.
 
-        Verifies that each path field has the expected metadata structure
-        with description and default fields.
+        Iterates through all fields of the `Paths` dataclass and asserts that each
+        field's metadata contains both 'description' and 'default' keys, and that
+        their values are of the expected types.
 
         Returns
         -------