orionis 0.291.0__py3-none-any.whl → 0.293.0__py3-none-any.whl

orionis/metadata/framework.py

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

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/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.291.0.dist-info → orionis-0.293.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orionis
-Version: 0.291.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.291.0.dist-info → orionis-0.293.0.dist-info}/RECORD

@@ -226,7 +226,7 @@ orionis/foundation/config/testing/entities/testing.py,sha256=m_i9jZlOXs_AzNKNNf0
 orionis/foundation/config/testing/enums/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/foundation/config/testing/enums/test_mode.py,sha256=IbFpauu7J-iSAfmC8jDbmTEYl8eZr-AexL-lyOh8_74,337
 orionis/metadata/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-orionis/metadata/framework.py,sha256=gFGa1P4sgpUA5AUIlQeePV9NZLz4zPtOpg5N1Z_7yI8,4960
+orionis/metadata/framework.py,sha256=QmC-g5i6UhTE0QWIF78bMyfW6Dm4d4521_PuYknYoGQ,4960
 orionis/metadata/package.py,sha256=tqLfBRo-w1j_GN4xvzUNFyweWYFS-qhSgAEc-AmCH1M,5452
 orionis/patterns/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/patterns/singleton/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -345,13 +345,13 @@ orionis/test/output/contracts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5N
 orionis/test/output/contracts/dumper.py,sha256=5OqGc4GEXCXX76sCX185giQMyKwwZvlOv3I7tTwV2fQ,1324
 orionis/test/suites/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/test/suites/test_suite.py,sha256=fdVmC56PJfWDuYeekY7oN-04AEHMqxwLI5mZNJAuOZI,5261
-orionis/test/suites/test_unit.py,sha256=ZkpRyUEHsxnbto3FBmvPfFHHRyOgv4NBIcS2LF1-Y_s,49374
+orionis/test/suites/test_unit.py,sha256=JAla82Uc2OEvvBTE8oI8BT0hxeb03FJB1bdKU7G2xlA,51293
 orionis/test/suites/contracts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/test/suites/contracts/test_suite.py,sha256=eluzYwkNBbKjxYStj_tHN_Fm3YDPpGQdqMu5eiluh-E,1059
 orionis/test/suites/contracts/test_unit.py,sha256=l1LQllODyvcSByXMl1lGrUkoLsXbBHZZLWZI4A-mlQg,5881
 orionis/test/view/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-orionis/test/view/index.html,sha256=U4XYO4hA-mAJCK1gcVRgIysmISK3g3Vgi2ntLofFAhE,6592
-orionis-0.291.0.dist-info/licenses/LICENCE,sha256=-_4cF2EBKuYVS_SQpy1uapq0oJPUU1vl_RUWSy2jJTo,1111
+orionis/test/view/render.py,sha256=jXZkbITBknbUwm_mD8bcTiwLDvsFkrO9qrf0ZgPwqxc,4903
+orionis-0.293.0.dist-info/licenses/LICENCE,sha256=-_4cF2EBKuYVS_SQpy1uapq0oJPUU1vl_RUWSy2jJTo,1111
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/example/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/example/test_example.py,sha256=byd_lI6tVDgGPEIrr7PLZbBu0UoZOymmdmyA_4u-QUw,601
@@ -455,8 +455,8 @@ tests/support/inspection/fakes/fake_reflection_instance_with_abstract.py,sha256=
 tests/testing/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/testing/test_testing_result.py,sha256=MrGK3ZimedL0b5Ydu69Dg8Iul017AzLTm7VPxpXlpfU,4315
 tests/testing/test_testing_unit.py,sha256=A6QkiOkP7GPC1Szh_GqsrV7GxjWjK8cIwFez6YfrzmM,7683
-orionis-0.291.0.dist-info/METADATA,sha256=dKe4TtuURAwVqliKd4odPuHJFE2TplRgxVek6i-jd9A,4772
-orionis-0.291.0.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
-orionis-0.291.0.dist-info/top_level.txt,sha256=2bdoHgyGZhOtLAXS6Om8OCTmL24dUMC_L1quMe_ETbk,14
-orionis-0.291.0.dist-info/zip-safe,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
-orionis-0.291.0.dist-info/RECORD,,
+orionis-0.293.0.dist-info/METADATA,sha256=VYamMjDShBXxI6Quu-380uo1bp772T2nDaTlWcmJdwI,4772
+orionis-0.293.0.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
+orionis-0.293.0.dist-info/top_level.txt,sha256=2bdoHgyGZhOtLAXS6Om8OCTmL24dUMC_L1quMe_ETbk,14
+orionis-0.293.0.dist-info/zip-safe,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
+orionis-0.293.0.dist-info/RECORD,,

orionis/test/view/index.html

@@ -1,127 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-
-<head>
-    <meta charset="UTF-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Orionis Test Dashboard</title>
-    <script src="https://cdn.tailwindcss.com"></script>
-    <link rel="icon" href="https://orionis-framework.com/svg/logo.svg" />
-    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/font/bootstrap-icons.min.css">
-</head>
-
-<body class="bg-gray-100 text-gray-800 font-sans">
-    <div class="max-w-7xl mx-auto px-4 sm:px-6 py-8">
-
-        <!-- Header -->
-        <header class="bg-gradient-to-r from-blue-900 to-cyan-400 text-white rounded-2xl shadow-xl p-6 mb-10">
-            <div class="flex flex-col md:flex-row justify-between items-center gap-4">
-                <div class="flex items-center gap-4">
-                    <img src="https://orionis-framework.com/svg/logo.svg" alt="Orionis Logo"
-                        class="h-10 brightness-0 invert" />
-                    <h1 class="text-2xl font-light tracking-wider">Orionis Testing Results Dashboard</h1>
-                </div>
-                <div id="timestamp" class="text-sm text-white/90"></div>
-            </header>
-
-            <!-- Execution Summary Card -->
-            <div class="w-full mb-10">
-                <div class="bg-white rounded-2xl shadow-lg p-6 border-t-4 border-indigo-500 flex flex-col sm:flex-row items-center justify-between gap-4">
-                    <div>
-                        <div class="text-xs font-semibold text-gray-500 uppercase">Resumen de Ejecución</div>
-                        <div class="text-lg font-bold text-gray-800 mt-2" id="execution-summary-title">Ejecución Completa</div>
-                        <div class="text-sm text-gray-600 mt-1" id="execution-summary-desc">Todos los tests han sido ejecutados correctamente.</div>
-                    </div>
-                    <div class="flex items-center gap-4">
-                        <div class="flex items-center gap-1 text-gray-700">
-                            <i class="bi bi-clock-history text-xl text-indigo-500"></i>
-                            <span id="execution-time">Duración: 00:00:00</span>
-                        </div>
-                    </div>
-                </div>
-            </div>
-
-            <!-- Summary Cards -->
-            <div class="grid grid-cols-1 sm:grid-cols-2 md:grid-cols-3 lg:grid-cols-4 gap-6 mb-10">
-
-            <div class="bg-white rounded-2xl shadow-lg p-6 border-t-4 border-green-500">
-                <div class="text-xs font-semibold text-gray-500 uppercase">Passed</div>
-                <div class="text-4xl font-bold text-gray-800 mt-2" id="passed">0</div>
-                <div class="mt-4 bg-gray-200 rounded-full h-2">
-                    <div class="bg-green-500 h-2 rounded-full" id="passed-progress" style="width: 0%"></div>
-                </div>
-            </div>
-
-            <div class="bg-white rounded-2xl shadow-lg p-6 border-t-4 border-red-500">
-                <div class="text-xs font-semibold text-gray-500 uppercase">Failed</div>
-                <div class="text-4xl font-bold text-gray-800 mt-2" id="failed">0</div>
-            </div>
-
-            <div class="bg-white rounded-2xl shadow-lg p-6 border-t-4 border-yellow-500">
-                <div class="text-xs font-semibold text-gray-500 uppercase">Errors</div>
-                <div class="text-4xl font-bold text-gray-800 mt-2" id="errors">0</div>
-            </div>
-
-            <div class="bg-white rounded-2xl shadow-lg p-6 border-t-4 border-blue-500">
-                <div class="text-xs font-semibold text-gray-500 uppercase">Skipped</div>
-                <div class="text-4xl font-bold text-gray-800 mt-2" id="skipped">0</div>
-            </div>
-
-        </div>
-
-        <!-- Download Buttons & Select -->
-        <div class="flex flex-wrap justify-between items-center mb-10 gap-4">
-            <!-- Buttons to the left -->
-            <div class="flex flex-wrap gap-4">
-                <button id="download-json"
-                    class="flex items-center gap-2 bg-blue-600 hover:bg-blue-700 text-white px-4 py-2 rounded shadow">
-                    <i class="bi bi-file-earmark-code-fill text-lg"></i>
-                    <span>Download JSON</span>
-                </button>
-                <button id="download-excel"
-                    class="flex items-center gap-2 bg-green-600 hover:bg-green-700 text-white px-4 py-2 rounded shadow">
-                    <i class="bi bi-file-earmark-excel-fill text-lg"></i>
-                    <span>Download Excel</span>
-                </button>
-                <button id="download-pdf"
-                    class="flex items-center gap-2 bg-red-600 hover:bg-red-700 text-white px-4 py-2 rounded shadow">
-                    <i class="bi bi-file-earmark-pdf-fill text-lg"></i>
-                    <span>Download PDF</span>
-                </button>
-            </div>
-            <!-- Elegant Select to the right -->
-            <div>
-                <select
-                    class="appearance-none bg-white border border-gray-300 text-gray-700 py-2 px-4 pr-10 rounded-lg shadow focus:outline-none focus:ring-2 focus:ring-blue-400 focus:border-blue-400 transition text-base font-medium">
-                    <option selected disabled>Selecciona una opción</option>
-                    <option>Opción 1</option>
-                    <option>Opción 2</option>
-                    <option>Opción 3</option>
-                </select>
-            </div>
-        </div>
-
-        <!-- JSON Viewer Panel -->
-        <div class="bg-white rounded-2xl shadow-xl p-6">
-            <h2 class="text-xl font-semibold mb-4">Test Report JSON</h2>
-            <pre id="json-data"
-                class="whitespace-pre-wrap text-sm text-gray-800 bg-gray-100 p-4 rounded-xl overflow-x-auto"></pre>
-        </div>
-
-        <!-- Footer -->
-        <footer class="mt-12 text-center text-gray-500 text-sm py-6">
-            Developed with the power of
-            <a href="https://orionis-framework.com/" target="_blank" rel="noopener"
-                class="font-semibold text-blue-700 hover:underline">
-                Orionis Framework
-            </a>
-            <i class="bi bi-stars text-yellow-400 align-middle ml-1"></i>
-        </footer>
-
-        <script>
-            // Placeholder JS logic
-            document.getElementById("timestamp").textContent = new Date().toLocaleString();
-        </script>
-</body>
-
-</html>