pytest-plugins 0.3.4__tar.gz → 0.3.6__tar.gz

{pytest_plugins-0.3.4/pytest_plugins.egg-info → pytest_plugins-0.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-plugins
-Version: 0.3.4
+Version: 0.3.6
 Summary: A Python package for managing pytest plugins.
 Home-page: https://github.com/aviz92/pytest-plugins
 Author: Avi Zaguri
@@ -43,8 +43,11 @@ generate `execution_results.json`, `test_results.json`, and `test_report`.md und
     - `--output-dir`: Specify the output directory for the report files (default is `root_project/results_output/`).
     - `--traceback`: Include detailed traceback information in the report.
     - `--md-report`: Generate a Markdown report of the test results.
+    - `repo-name`: Specify the git repository name for the report.
     - `--pr-number`: Include a pull request number in the report for better traceability.
     - `--mr-number`: Include a merge request number in the report for better traceability.
+    - `--pipeline-number`: Include a CI pipeline number in the report for better traceability.
+    - `--commit`: Include the commit hash in the report for better traceability.
     - `--add-parameters`: Add the test parameters as fields to the test results.
     - `--pytest-command`: Add the detailed information about the pytest command-line to the "execution_results.json" file
 <br> <br>

{pytest_plugins-0.3.4 → pytest_plugins-0.3.6}/README.md

@@ -12,8 +12,11 @@ generate `execution_results.json`, `test_results.json`, and `test_report`.md und
     - `--output-dir`: Specify the output directory for the report files (default is `root_project/results_output/`).
     - `--traceback`: Include detailed traceback information in the report.
     - `--md-report`: Generate a Markdown report of the test results.
+    - `repo-name`: Specify the git repository name for the report.
     - `--pr-number`: Include a pull request number in the report for better traceability.
     - `--mr-number`: Include a merge request number in the report for better traceability.
+    - `--pipeline-number`: Include a CI pipeline number in the report for better traceability.
+    - `--commit`: Include the commit hash in the report for better traceability.
     - `--add-parameters`: Add the test parameters as fields to the test results.
     - `--pytest-command`: Add the detailed information about the pytest command-line to the "execution_results.json" file
 <br> <br>

{pytest_plugins-0.3.4 → pytest_plugins-0.3.6}/pytest_plugins/better_report.py

@@ -20,7 +20,7 @@ from pytest_plugins.utils.pytest_helper import (
     get_test_full_name,
     get_test_name_without_parameters,
     get_test_full_path,
-    get_pytest_test_name
+    get_pytest_test_name, log_test_results
 )
 from pytest_plugins.utils.create_report import generate_md_report
 
@@ -56,6 +56,12 @@ def pytest_addoption(parser: Parser) -> None:
         default=False,
         help="Generate a markdown report of the test results"
     )
+    parser.addoption(
+        "--repo-name",
+        action="store",
+        default=None,
+        help="Git Repository Name"
+    )
     parser.addoption(
         "--pr-number",
         action="store",
@@ -68,6 +74,18 @@ def pytest_addoption(parser: Parser) -> None:
         default=None,
         help="Merge Request Number"
     )
+    parser.addoption(
+        "--pipeline-number",
+        action="store",
+        default=None,
+        help="CI Pipeline Number"
+    )
+    parser.addoption(
+        "--commit",
+        action="store",
+        default=None,
+        help="Commit Hash (SHA-1) of the repository at the time of test execution"
+    )
     parser.addoption(
         "--add-parameters",
         action="store_true",
@@ -108,9 +126,12 @@ def pytest_sessionstart(session: Session) -> None:
     execution_results["execution_info"] = ExecutionData(
         execution_status=ExecutionStatus.STARTED,
         revision=datetime.now(timezone.utc).strftime("%Y%m%d%H%M%S%f"),
+        execution_start_time=datetime.now(timezone.utc).isoformat(),
+        repo_name=session.config.getoption("--repo-name", None),
         pull_request_number=session.config.getoption("--pr-number", None),
         merge_request_number=session.config.getoption("--mr-number", None),
-        execution_start_time=datetime.now(timezone.utc).isoformat(),
+        pipeline_number=session.config.getoption("--pipeline-number", None),
+        commit=session.config.getoption("--commit", None),
     )
 
     if session.config.getoption("--pytest-command"):
@@ -190,19 +211,6 @@ def session_setup_teardown(request: FixtureRequest) -> Generator[None, Any, None
     logger.info("Better report: Execution results saved")
 
 
-@pytest.fixture(autouse=True)
-def log_test_results(request: FixtureRequest) -> None:
-    if not getattr(request.config, '_better_report_enabled', None):
-        return
-
-    test_item = request.node
-    test_full_name = get_test_full_name(item=test_item)
-    if test_full_name in test_results:
-        logger.debug(f'Test Results: \n{json.dumps(test_results[test_full_name], indent=4, default=serialize_data)}')
-    else:
-        logger.warning(f"Test {test_full_name} missing in test_results during report")
-
-
 def pytest_runtest_teardown(item: Function) -> None:
     if not getattr(item.config, '_better_report_enabled', None):
         return
@@ -262,6 +270,8 @@ def pytest_runtest_makereport(item: Function, call: Any) -> Generator[None, Any,
     else:
         test_item.exception_message = None
 
+    log_test_results(item=item, test_results=test_results)
+
 
 def pytest_sessionfinish(session: Session) -> None:
     if session.config.getoption("--collect-only") or not getattr(session.config, '_better_report_enabled', None):

{pytest_plugins-0.3.4 → pytest_plugins-0.3.6}/pytest_plugins/models/execution_data.py

@@ -8,9 +8,14 @@ from pytest_plugins.models.status import ExecutionStatus
 class ExecutionData:
     execution_status: ExecutionStatus
     revision: Optional[str]
-    pull_request_number: Optional[str]
-    merge_request_number: Optional[str]
     execution_start_time: Optional[str] = None
     execution_end_time: Optional[str] = None
     execution_duration_sec: Optional[str] = None
+
+    repo_name: Optional[str] = None
+    pull_request_number: Optional[str] = None
+    merge_request_number: Optional[str] = None
+    pipeline_number: Optional[str] = None
+    commit: Optional[str] = None
+
     test_list: Optional[list] = None

{pytest_plugins-0.3.4 → pytest_plugins-0.3.6}/pytest_plugins/utils/helper.py

@@ -19,6 +19,8 @@ def serialize_data(obj):
         return obj.value
     if is_dataclass(obj):
         return obj.__dict__
+    if isinstance(obj, type):
+        return obj.__name__
     logger.error(f'Object is not serializable: {obj}')
     raise TypeError(f"Type {type(obj)} not serializable")
 

{pytest_plugins-0.3.4 → pytest_plugins-0.3.6}/pytest_plugins/utils/pytest_helper.py

@@ -1,7 +1,10 @@
+import json
 import logging
 
 from _pytest.python import Function
 
+from pytest_plugins.utils.helper import serialize_data
+
 logger = logging.getLogger()
 
 
@@ -30,3 +33,14 @@ def get_test_full_path(item: Function) -> str:
     """Get the full name of the test, including parameters if available."""
     test_name = get_test_path_without_parameters(item=item)
     return f"{test_name}[{item.callspec.params}]" if getattr(item, 'callspec', None) else test_name
+
+
+def log_test_results(item: Function, test_results: dict) -> None:
+    if not getattr(item.config, '_better_report_enabled', None):
+        return
+
+    test_full_name = get_test_full_name(item=item)
+    if test_full_name in test_results:
+        logger.debug(f'Test Results: \n{json.dumps(test_results[test_full_name], indent=4, default=serialize_data)}')
+    else:
+        logger.warning(f"Test {test_full_name} missing in test_results during report")

{pytest_plugins-0.3.4 → pytest_plugins-0.3.6/pytest_plugins.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-plugins
-Version: 0.3.4
+Version: 0.3.6
 Summary: A Python package for managing pytest plugins.
 Home-page: https://github.com/aviz92/pytest-plugins
 Author: Avi Zaguri
@@ -43,8 +43,11 @@ generate `execution_results.json`, `test_results.json`, and `test_report`.md und
     - `--output-dir`: Specify the output directory for the report files (default is `root_project/results_output/`).
     - `--traceback`: Include detailed traceback information in the report.
     - `--md-report`: Generate a Markdown report of the test results.
+    - `repo-name`: Specify the git repository name for the report.
     - `--pr-number`: Include a pull request number in the report for better traceability.
     - `--mr-number`: Include a merge request number in the report for better traceability.
+    - `--pipeline-number`: Include a CI pipeline number in the report for better traceability.
+    - `--commit`: Include the commit hash in the report for better traceability.
     - `--add-parameters`: Add the test parameters as fields to the test results.
     - `--pytest-command`: Add the detailed information about the pytest command-line to the "execution_results.json" file
 <br> <br>

{pytest_plugins-0.3.4 → pytest_plugins-0.3.6}/setup.py

@@ -1,6 +1,6 @@
 from setuptools import setup, find_packages
 
-package_version = '0.3.4'
+package_version = '0.3.6'
 
 package_name = 'pytest-plugins'
 package_description = 'A Python package for managing pytest plugins.'