orionis 0.292.0__tar.gz → 0.293.0__tar.gz

{orionis-0.292.0/orionis.egg-info → orionis-0.293.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orionis
-Version: 0.292.0
+Version: 0.293.0
 Summary: Orionis Framework – Elegant, Fast, and Powerful.
 Home-page: https://github.com/orionis-framework/framework
 Author: Raul Mauricio Uñate Castro

{orionis-0.292.0 → orionis-0.293.0}/orionis/metadata/framework.py

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

{orionis-0.292.0 → orionis-0.293.0}/orionis/test/suites/test_unit.py

@@ -25,6 +25,8 @@ from orionis.test.exceptions.test_failure_exception import OrionisTestFailureExc
 from orionis.test.exceptions.test_value_error import OrionisTestValueError
 from orionis.test.logs.history import TestHistory
 from orionis.test.suites.contracts.test_unit import IUnitTest
+from orionis.test.view.render import TestingResultRender
+from rich.text import Text
 
 class UnitTest(IUnitTest):
     """
@@ -757,6 +759,15 @@ class UnitTest(IUnitTest):
         if self.persistent:
             self._persistTestResults(report)
 
+        # Handle Web Report Rendering
+        path = self._webReport(report)
+
+        # Elegant invitation to view the results, with underlined path
+        invite_text = Text("Test results saved. ", style="green")
+        invite_text.append("View report: ", style="bold green")
+        invite_text.append(str(path), style="underline blue")
+        self.rich_console.print(invite_text)
+
         # Return the summary
         return {
             "total_tests": result.testsRun,
@@ -769,6 +780,45 @@ class UnitTest(IUnitTest):
             "test_details": test_details
         }
 
+    def _webReport(self, summary: Dict[str, Any]) -> None:
+        """
+        Generates a web report for the test results summary.
+
+        Parameters
+        ----------
+        summary : dict
+            The summary of test results to generate a web report for.
+
+        Returns
+        -------
+        str
+            The path to the generated web report.
+
+        Notes
+        -----
+        - Determines the storage path based on the current working directory and base_path.
+        - Uses TestingResultRender to generate the report.
+        - If persistence is enabled and the driver is 'sqlite', the report is marked as persistent.
+        - Returns the path to the generated report for further use.
+        """
+        # Determine the absolute path for storing results
+        project = os.path.basename(os.getcwd())
+        storage_path = os.path.abspath(os.path.join(os.getcwd(), self.base_path))
+
+        # Only use storage_path if project is recognized
+        if project not in ['framework', 'orionis']:
+            storage_path = None
+
+        # Create the TestingResultRender instance with the storage path and summary
+        render = TestingResultRender(
+            storage_path=storage_path,
+            result=summary,
+            persist=self.persistent and self.persistent_driver == 'sqlite'
+        )
+
+        # Render the report and return the path
+        return render.render()
+
     def _persistTestResults(self, summary: Dict[str, Any]) -> None:
         """
         Persist the test results summary using the configured persistent driver.
@@ -793,13 +843,13 @@ class UnitTest(IUnitTest):
         """
 
         try:
-            if self.persistent_driver == 'sqlite':
+            # Determine the absolute path for storing results
+            project = os.getcwd().split(os.sep)[-1]
+            storage_path = None
+            if project in ['framework', 'orionis']:
+                storage_path = os.path.abspath(os.path.join(os.getcwd(), self.base_path))
 
-                # Determine the absolute path for storing results
-                project = os.getcwd().split(os.sep)[-1]
-                storage_path = None
-                if project in ['framework', 'orionis']:
-                    storage_path = os.path.abspath(os.path.join(os.getcwd(), self.base_path))
+            if self.persistent_driver == 'sqlite':
 
                 # Initialize the TestHistory class for database operations
                 history = TestHistory(
@@ -813,14 +863,14 @@ class UnitTest(IUnitTest):
 
             elif self.persistent_driver == 'json':
 
+                # Ensure the base path exists and write the summary to a JSON file
+                os.makedirs(storage_path, exist_ok=True)
+
                 # Get the current timestamp for the log file name
                 timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
 
-                # Ensure the base path exists and write the summary to a JSON file
-                os.makedirs(self.base_path, exist_ok=True)
-
                 # Create the log file path with the timestamp
-                log_path = os.path.join(self.base_path, f'test_{timestamp}.json')
+                log_path = os.path.abspath(os.path.join(storage_path, f'test_{timestamp}.json'))
 
                 # Write the summary to the JSON file
                 with open(log_path, 'w', encoding='utf-8') as log:

orionis-0.293.0/orionis/test/view/render.py

@@ -0,0 +1,128 @@
+import json
+import os
+from pathlib import Path
+from orionis.services.environment.env import Env
+from orionis.test.logs.history import TestHistory
+
+class TestingResultRender:
+
+    def __init__(
+        self,
+        result,
+        storage_path:str = None,
+        persist=False
+    ):
+        """
+        Initialize the TestingResultRender object.
+
+        Parameters
+        ----------
+        result : Any
+            The test result data to be processed or stored.
+        storage_path : str, optional
+            Custom path to store the test report. If not provided, uses the environment variable
+            'TEST_REPORT_PATH' or defaults to a local storage path.
+        persist : bool, optional
+            Whether to persist the report. Defaults to False.
+
+        Notes
+        -----
+        - Determines the file path for the test report based on the provided storage_path, environment variable,
+          or a default location.
+        - Ensures the parent directory for the report exists.
+        - Stores the resolved report path in the environment variable 'TEST_REPORT_PATH'.
+        """
+
+        # Initialize instance variables
+        self.__filename = 'test-results.html'
+        self.__result = result
+        self.__persist = persist
+
+        # Determine file path
+        db_path = None
+        if storage_path:
+            db_path = Path(storage_path).expanduser().resolve()
+            if db_path.is_dir():
+                db_path = db_path / self.__filename
+        else:
+            env_path = Env.get("TEST_REPORT_PATH", None)
+            if env_path:
+                db_path = Path(env_path).expanduser().resolve()
+                if db_path.is_dir():
+                    db_path = db_path / self.__filename
+            else:
+                db_path = Path.cwd() / 'storage/framework/testing' / self.__filename
+
+        # Ensure parent directory exists
+        db_path.parent.mkdir(parents=True, exist_ok=True)
+
+        # Store path in environment
+        Env.set("TEST_REPORT_PATH", str(db_path), 'path')
+        self.__report_path = db_path
+
+    def render(self):
+        """
+        Otherwise, uses the current test result stored in memory. The method replaces placeholders in a
+        template file with the test results and the persistence mode, then writes the rendered content
+        to a report file.
+
+        Parameters
+        ----------
+        None
+
+        Returns
+        -------
+        str
+            The full path to the generated report file.
+
+        Notes
+        -----
+        - If persistence is enabled, the last 10 reports are fetched from the SQLite database.
+        - If persistence is not enabled, only the current test result in memory is used.
+        - The method reads a template file, replaces placeholders with the test results and persistence mode,
+          and writes the final content to the report file.
+        """
+
+        # Determine the source of test results based on persistence mode
+        if self.__persist:
+            # If persistence is enabled, fetch the last 10 reports from SQLite
+            logs = TestHistory()
+            reports = logs.get(last=10)
+            # Parse each report's JSON data into a list
+            results_list = [json.loads(report[1]) for report in reports]
+        else:
+            # If not persistent, use only the current in-memory result
+            results_list = [self.__result]
+
+        # Set placeholder values for the template
+        persistence_mode = 'SQLite' if self.__persist else 'Static'
+        test_results_json = json.dumps(results_list, ensure_ascii=False, indent=None)
+
+        # Locate the HTML template file
+        template_path = Path(__file__).parent / 'report.stub'
+
+        # Read the template content
+        with open(template_path, 'r', encoding='utf-8') as template_file:
+            template_content = template_file.read()
+
+        # Replace placeholders with actual values
+        rendered_content = template_content.replace(
+            '{{orionis-testing-result}}',
+            test_results_json
+        ).replace(
+            '{{orionis-testing-persistent}}',
+            persistence_mode
+        )
+
+        # Write the rendered HTML report to the specified path
+        with open(self.__report_path, 'w', encoding='utf-8') as report_file:
+            report_file.write(rendered_content)
+
+        # Open the generated report in the default web browser if running on Windows or macOS.
+        # This provides immediate feedback to the user after report generation.
+        if os.name == 'nt' or os.name == 'posix' and sys.platform == 'darwin':
+            import webbrowser
+            webbrowser.open(self.__report_path.as_uri())
+
+        # Return the absolute path to the generated report
+        return str(self.__report_path)

{orionis-0.292.0 → orionis-0.293.0/orionis.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orionis
-Version: 0.292.0
+Version: 0.293.0
 Summary: Orionis Framework – Elegant, Fast, and Powerful.
 Home-page: https://github.com/orionis-framework/framework
 Author: Raul Mauricio Uñate Castro

{orionis-0.292.0 → orionis-0.293.0}/orionis.egg-info/SOURCES.txt

@@ -360,7 +360,7 @@ orionis/test/suites/contracts/__init__.py
 orionis/test/suites/contracts/test_suite.py
 orionis/test/suites/contracts/test_unit.py
 orionis/test/view/__init__.py
-orionis/test/view/index.html
+orionis/test/view/render.py
 tests/__init__.py
 tests/example/__init__.py
 tests/example/test_example.py

{orionis-0.292.0 → orionis-0.293.0}/tests/example/test_example.py

@@ -17,7 +17,7 @@ class TestExample(TestCase):
             Ensures that the integer 2 is equal to itself.
         """
         # Check if 1 equals 1
-        self.assertEqual(1, 2)
+        self.assertEqual(1, 1)
 
         # Check if 2 equals 2
         self.assertEqual(2, 2)