orionis 0.314.0__py3-none-any.whl → 0.315.0__py3-none-any.whl

orionis/metadata/framework.py

@@ -5,7 +5,7 @@
 NAME = "orionis"
 
 # Current version of the framework
-VERSION = "0.314.0"
+VERSION = "0.315.0"
 
 # Full name of the author or maintainer of the project
 AUTHOR = "Raul Mauricio Uñate Castro"

orionis/test/contracts/printer.py

@@ -0,0 +1,188 @@
+from abc import ABC, abstractmethod
+from typing import Any, Dict
+
+class ITestPrinter(ABC):
+
+    @abstractmethod
+    def print(
+        self,
+        value: Any
+    ) -> None:
+        """
+        Prints a value to the console using the rich console.
+        Parameters
+        ----------
+        value : Any
+            The value to be printed. It can be a string, object, or any other type.
+        Notes
+        -----
+        - If the value is a string, it is printed directly.
+        - If the value is an object, its string representation is printed.
+        - If the value is a list, each item is printed on a new line.
+        """
+        pass
+
+    @abstractmethod
+    def startMessage(
+        self,
+        *,
+        print_result: bool,
+        length_tests: int,
+        execution_mode: str,
+        max_workers: int
+    ):
+        """
+        Displays a formatted start message for the test execution session.
+
+        Parameters
+        ----------
+        print_result : bool
+            Whether to print the start message.
+        length_tests : int
+            The total number of tests to be executed.
+        execution_mode : str
+            The mode of execution, either "parallel" or "sequential".
+        max_workers : int
+            The number of worker threads/processes for parallel execution.
+
+        Side Effects
+        ------------
+        Prints a styled panel with test session information to the console if `print_result` is True.
+        """
+        pass
+
+    @abstractmethod
+    def finishMessage(
+        self,
+        *,
+        print_result: bool,
+        summary: Dict[str, Any]
+    ) -> None:
+        """
+        Display a summary message for the test suite execution.
+
+        Parameters
+        ----------
+        summary : dict
+            Dictionary containing the test suite summary, including keys such as
+            'failed', 'errors', and 'total_time'.
+
+        Notes
+        -----
+        - If `self.print_result` is False, the method returns without displaying anything.
+        - Shows a status icon (✅ for success, ❌ for failure) based on the presence of
+          failures or errors in the test suite.
+        - Formats and prints the message within a styled panel using the `rich` library.
+        """
+        pass
+
+    @abstractmethod
+    def executePanel(
+        self,
+        *,
+        print_result: bool,
+        flatten_test_suite: list,
+        callable: callable
+    ):
+        """
+        Executes a test suite panel with optional live console output.
+
+        Parameters
+        ----------
+        print_result : bool
+            If True, displays a running message panel while executing the test suite.
+        flatten_test_suite : list
+            The flattened list of test cases or test suite items to be executed.
+        callable : callable
+            The function or method to execute the test suite.
+
+        Returns
+        -------
+        Any
+            The result returned by the provided callable after execution.
+
+        Notes
+        -----
+        This method manages the display of a running message panel using the Rich library,
+        depending on whether debugging is enabled in the test suite and whether results should be printed.
+        If debugging or dump calls are detected in the test code, a live console is used to display
+        real-time updates. Otherwise, a static panel is shown before executing the test suite.
+        """
+        pass
+
+    @abstractmethod
+    def linkWebReport(
+        self,
+        path: str
+    ):
+        """
+        Prints an elegant invitation to view the test results, with an underlined path.
+
+        Parameters
+        ----------
+        path : str or Path
+            The path to the test results report.
+        """
+        pass
+
+    @abstractmethod
+    def summaryTable(
+        self,
+        summary: Dict[str, Any]
+    ) -> None:
+        """
+        Prints a summary table of test results using the Rich library.
+
+        Parameters
+        ----------
+        summary : dict
+            Dictionary with the test summary data. Must contain the following keys:
+            total_tests : int
+                Total number of tests executed.
+            passed : int
+                Number of tests that passed.
+            failed : int
+                Number of tests that failed.
+            errors : int
+                Number of tests that had errors.
+            skipped : int
+                Number of tests that were skipped.
+            total_time : float
+                Total duration of the test execution in seconds.
+            success_rate : float
+                Percentage of tests that passed.
+
+        Returns
+        -------
+        None
+        """
+        pass
+
+    @abstractmethod
+    def displayResults(
+        self,
+        *,
+        print_result: bool,
+        summary: Dict[str, Any]
+    ) -> None:
+        """
+        Display the results of the test execution, including a summary table and detailed
+        information about failed or errored tests grouped by their test classes.
+
+        Parameters
+        ----------
+        summary : dict
+            Dictionary containing the summary of the test execution, including test details,
+            statuses, and execution times.
+
+        Notes
+        -----
+        - Prints a summary table of the test results.
+        - Groups failed and errored tests by their test class and displays them in a structured
+          format using panels.
+        - For each failed or errored test, displays the traceback in a syntax-highlighted panel
+          with additional metadata such as the test method name and execution time.
+        - Uses different icons and border colors to distinguish between failed and errored tests.
+        - Calls a finishing message method after displaying all results.
+        """
+        pass

orionis/test/contracts/test_unit.py

@@ -1,5 +1,6 @@
 from abc import ABC, abstractmethod
 from typing import Any, Dict, List, Optional
+from orionis.services.system.workers import Workers
 from orionis.test.enums.test_mode import ExecutionMode
 
 class IUnitTest(ABC):
@@ -7,11 +8,12 @@ class IUnitTest(ABC):
     @abstractmethod
     def configure(
             self,
-            verbosity: int = None,
-            execution_mode: str | ExecutionMode = None,
-            max_workers: int = None,
-            fail_fast: bool = None,
-            print_result: bool = None,
+            *,
+            verbosity: int = 2,
+            execution_mode: str | ExecutionMode = ExecutionMode.SEQUENTIAL,
+            max_workers: int = Workers().calculate(),
+            fail_fast: bool = False,
+            print_result: bool = True,
             throw_exception: bool = False,
             persistent: bool = False,
             persistent_driver: str = 'sqlite',
@@ -49,8 +51,9 @@ class IUnitTest(ABC):
     @abstractmethod
     def discoverTestsInFolder(
         self,
-        folder_path: str,
+        *,
         base_path: str = "tests",
+        folder_path: str,
         pattern: str = "test_*.py",
         test_name_pattern: Optional[str] = None,
         tags: Optional[List[str]] = None
@@ -86,7 +89,12 @@ class IUnitTest(ABC):
         pass
 
     @abstractmethod
-    def discoverTestsInModule(self, module_name: str, test_name_pattern: Optional[str] = None):
+    def discoverTestsInModule(
+        self,
+        *,
+        module_name: str,
+        test_name_pattern: Optional[str] = None
+    ):
         """
         Discovers and loads tests from a specified module, optionally filtering by a test name pattern, and adds them to the test suite.
 
@@ -110,7 +118,9 @@ class IUnitTest(ABC):
         pass
 
     @abstractmethod
-    def run(self, print_result: bool = None, throw_exception: bool = None) -> Dict[str, Any]:
+    def run(
+        self
+    ) -> Dict[str, Any]:
         """
         Executes the test suite and processes the results.
 
@@ -134,7 +144,9 @@ class IUnitTest(ABC):
         pass
 
     @abstractmethod
-    def getTestNames(self) -> List[str]:
+    def getTestNames(
+        self
+    ) -> List[str]:
         """
         Get a list of test names (unique identifiers) from the test suite.
 
@@ -146,7 +158,9 @@ class IUnitTest(ABC):
         pass
 
     @abstractmethod
-    def getTestCount(self) -> int:
+    def getTestCount(
+        self
+    ) -> int:
         """
         Returns the total number of test cases in the test suite.
 
@@ -158,7 +172,9 @@ class IUnitTest(ABC):
         pass
 
     @abstractmethod
-    def clearTests(self) -> None:
+    def clearTests(
+        self
+    ) -> None:
         """
         Clear all tests from the current test suite.
 
@@ -167,7 +183,9 @@ class IUnitTest(ABC):
         pass
 
     @abstractmethod
-    def getResult(self) -> dict:
+    def getResult(
+        self
+    ) -> dict:
         """
         Returns the results of the executed test suite.
 
@@ -179,7 +197,9 @@ class IUnitTest(ABC):
         pass
 
     @abstractmethod
-    def getOutputBuffer(self) -> int:
+    def getOutputBuffer(
+        self
+    ) -> int:
         """
         Returns the output buffer used for capturing test results.
         This method returns the internal output buffer that collects the results of the test execution.
@@ -191,7 +211,9 @@ class IUnitTest(ABC):
         pass
 
     @abstractmethod
-    def printOutputBuffer(self) -> None:
+    def printOutputBuffer(
+        self
+    ) -> None:
         """
         Prints the contents of the output buffer to the console.
         This method retrieves the output buffer and prints its contents using the rich console.
@@ -199,7 +221,9 @@ class IUnitTest(ABC):
         pass
 
     @abstractmethod
-    def getErrorBuffer(self) -> int:
+    def getErrorBuffer(
+        self
+    ) -> int:
         """
         Returns the error buffer used for capturing test errors.
         This method returns the internal error buffer that collects any errors encountered during test execution.
@@ -211,7 +235,9 @@ class IUnitTest(ABC):
         pass
 
     @abstractmethod
-    def printErrorBuffer(self) -> None:
+    def printErrorBuffer(
+        self
+    ) -> None:
         """
         Prints the contents of the error buffer to the console.
         This method retrieves the error buffer and prints its contents using the rich console.