testhide-pytest-plugin 0.1.0__tar.gz

testhide_pytest_plugin-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 thuesdays
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

testhide_pytest_plugin-0.1.0/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: testhide-pytest-plugin
+Version: 0.1.0
+Summary: A pytest plugin for creating incremental XML test reports for Testhide system.
+Author-email: Mykola Kovhanko <thuesdays@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 thuesdays
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Project-URL: Homepage, https://github.com/thuesdays/testhide-pytest-plugin
+Project-URL: Bug Tracker, https://github.com/thuesdays/testhide-pytest-plugin/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Framework :: Pytest
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pytest>=7.0
+Dynamic: license-file
+
+# Testhide Pytest Plugin
+
+A pytest plugin for creating incremental XML test reports. This plugin is designed to be extensible, allowing other plugins to inject metadata and test attachments.
+
+## Installation
+
+```bash
+pip install testhide-pytest-plugin

testhide_pytest_plugin-0.1.0/README.md

@@ -0,0 +1,8 @@
+# Testhide Pytest Plugin
+
+A pytest plugin for creating incremental XML test reports. This plugin is designed to be extensible, allowing other plugins to inject metadata and test attachments.
+
+## Installation
+
+```bash
+pip install testhide-pytest-plugin

testhide_pytest_plugin-0.1.0/pyproject.toml

@@ -0,0 +1,32 @@
+# pyproject.toml
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "testhide-pytest-plugin"
+version = "0.1.0"
+authors = [
+  { name="Mykola Kovhanko", email="thuesdays@gmail.com" },
+]
+description = "A pytest plugin for creating incremental XML test reports for Testhide system."
+readme = "README.md"
+license = { file="LICENSE" }
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Framework :: Pytest",
+]
+dependencies = [
+    "pytest>=7.0",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/thuesdays/testhide-pytest-plugin"
+"Bug Tracker" = "https://github.com/thuesdays/testhide-pytest-plugin/issues"
+
+[project.entry-points."pytest11"]
+testhide_plugin = "testhide_plugin.plugin"

testhide_pytest_plugin-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

testhide_pytest_plugin-0.1.0/src/testhide_plugin/plugin.py

@@ -0,0 +1,174 @@
+# -*- coding: utf-8 -*-
+
+__author__ = 'thuesdays@gmail.com'
+
+import sys
+import socket
+import xml.etree.ElementTree as ET
+from datetime import datetime
+
+import pytest
+from pytest import hookspec
+
+
+# --- Custom Hooks Specifications ---
+@hookspec
+def pytest_testhide_add_session_properties(plugin):
+    """
+    Hook for adding session-level metadata properties to the report.
+    These are added at the end of the <testsuites> block.
+    Should return a list of (name, value) tuples.
+    """
+
+
+@hookspec
+def pytest_testhide_get_test_case_properties(item, report) -> list:
+    """
+    Hook for getting per-test-case properties (docstr, info, attachments).
+    These are added inside the <testcase>'s own <properties> block.
+    Should return a list of (name, value) tuples.
+    """
+
+
+class TesthidePlugin:
+    """
+    A pytest plugin to create an incremental XML report with a structure
+    matching the provided example.
+    """
+    
+    def __init__(self, config):
+        self.config = config
+        self.report_xml_path = config.option.report_xml
+        self.xml_report_root = None
+        self.xml_main_testsuite = None
+        self.test_reports = {}
+    
+    def _write_xml_report(self):
+        """Writes the current XML tree to the report file."""
+        if self.xml_report_root is None or not self.report_xml_path: return
+        try:
+            tree = ET.ElementTree(self.xml_report_root)
+            ET.indent(tree, space="\t", level=0)  # Using tabs to match example
+            tree.write(self.report_xml_path, encoding='utf-8', xml_declaration=True)
+        except Exception as e:
+            self.config.warn('TESHIDE_PLUGIN_ERROR', f"TesthidePlugin failed to write XML report: {e}")
+    
+    # --- Pytest Hooks Implementation ---
+    
+    def pytest_sessionstart(self, session):
+        """Initializes the main report structure at the start."""
+        self.xml_report_root = ET.Element('testsuites')
+        self.xml_main_testsuite = ET.SubElement(
+            self.xml_report_root, 'testsuite',
+            name='pytest',  # As per example
+            timestamp=datetime.utcnow().strftime("%Y-%m-%dT%H:%M:%S.%f")[:-3],
+            hostname=socket.gethostname()
+        )
+        # Session properties are now added at the end in pytest_sessionfinish
+    
+    def pytest_runtest_logreport(self, report):
+        """Captures the test result object."""
+        if report.when == 'call' or (report.when == 'setup' and report.failed):
+            self.test_reports[report.nodeid] = report
+    
+    def pytest_runtest_teardown(self, item):
+        """Adds the completed test case to the XML report."""
+        if item.nodeid not in self.test_reports: return
+        report = self.test_reports[item.nodeid]
+        
+        # Get all necessary attributes for <testcase>
+        classname = f"{item.module.__name__}.{item.cls.__name__}" if item.cls else item.module.__name__
+        filepath = item.location[0]
+        line = str(item.location[1])
+        
+        testcase_attrs = {
+            'classname': classname,
+            'name': item.name,
+            'file': filepath,
+            'line': line,
+            'time': f"{report.duration:.3f}"
+        }
+        testcase = ET.Element('testcase', **testcase_attrs)
+        
+        # Add failure/skipped tags if necessary
+        if report.failed:
+            tag = 'error' if report.when == 'setup' else 'failure'
+            failure_element = ET.SubElement(testcase, tag, message=str(report.longrepr.reprcrash))
+            failure_element.text = str(report.longrepr)
+        elif report.skipped:
+            skipped_attrs = {'type': 'pytest.skip', 'message': report.longrepr[2]}
+            ET.SubElement(testcase, 'skipped',
+                          **skipped_attrs).text = f"{report.longrepr[0]}:{report.longrepr[1]}: {report.longrepr[2]}"
+        
+        # --- Call custom hook to get per-test properties (docstr, info, attachments) ---
+        all_properties = self.config.hook.pytest_testhide_get_test_case_properties(item=item, report=report)
+        flat_properties = [prop for sublist in all_properties for prop in sublist]
+        
+        if flat_properties:
+            properties_element = ET.SubElement(testcase, 'properties')
+            for name, value in flat_properties:
+                ET.SubElement(properties_element, 'property', name=name).text = str(value)
+        
+        self.xml_main_testsuite.append(testcase)
+        # To ensure data is saved if the run is aborted, we write after each test.
+        # This has a performance cost. For very large test suites, consider
+        # moving this call to pytest_sessionfinish only.
+        self._update_suite_summary_and_write()
+    
+    def _update_suite_summary_and_write(self):
+        """Updates the main testsuite summary attributes and writes the file."""
+        if self.xml_main_testsuite is None: return
+        
+        testcases = self.xml_main_testsuite.findall('testcase')
+        self.xml_main_testsuite.set('tests', str(len(testcases)))
+        self.xml_main_testsuite.set('failures', str(len(self.xml_main_testsuite.findall('.//failure'))))
+        self.xml_main_testsuite.set('errors', str(len(self.xml_main_testsuite.findall('.//error'))))
+        self.xml_main_testsuite.set('skipped', str(len(self.xml_main_testsuite.findall('.//skipped'))))
+        total_time = sum(float(tc.get('time', 0)) for tc in testcases)
+        self.xml_main_testsuite.set('time', f"{total_time:.3f}")
+        
+        self._write_xml_report()
+    
+    def pytest_sessionfinish(self, session):
+        """Adds final session properties and performs the final write."""
+        
+        # --- Add mandatory properties ---
+        session_properties = [
+            ('ip_address', socket.gethostbyname(socket.gethostname())),
+            ('hostname', socket.gethostname())
+        ]
+        
+        # --- Call custom hook to get user-defined session properties ---
+        all_user_properties = self.config.hook.pytest_testhide_add_session_properties(plugin=self)
+        for prop_list in all_user_properties:
+            session_properties.extend(prop_list)
+        
+        # Create the final <properties> block under <testsuites>
+        properties_element = ET.SubElement(self.xml_report_root, 'properties')
+        for name, value in session_properties:
+            ET.SubElement(properties_element, 'property', name=str(name), value=str(value))
+        
+        # Perform the final write
+        self._update_suite_summary_and_write()
+
+
+# --- Functions that register the plugin and its hooks with pytest ---
+def pytest_addoption(parser):
+    group = parser.getgroup('testhide-reporting', 'Testhide Incremental Reporting')
+    group.addoption('--report-xml', action='store', default=None,
+                    help='Enable incremental XML reporting to the specified file.')
+
+
+def pytest_configure(config):
+    config.pluginmanager.add_hookspecs(sys.modules[__name__])
+    if config.option.report_xml:
+        plugin = TesthidePlugin(config)
+        config._testhide_plugin = plugin
+        config.pluginmanager.register(plugin, "testhide_plugin")
+
+
+def pytest_unconfigure(config):
+    plugin = getattr(config, '_testhide_plugin', None)
+    if plugin:
+        del config._testhide_plugin
+        config.pluginmanager.unregister(plugin)

testhide_pytest_plugin-0.1.0/src/testhide_pytest_plugin.egg-info/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: testhide-pytest-plugin
+Version: 0.1.0
+Summary: A pytest plugin for creating incremental XML test reports for Testhide system.
+Author-email: Mykola Kovhanko <thuesdays@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 thuesdays
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Project-URL: Homepage, https://github.com/thuesdays/testhide-pytest-plugin
+Project-URL: Bug Tracker, https://github.com/thuesdays/testhide-pytest-plugin/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Framework :: Pytest
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pytest>=7.0
+Dynamic: license-file
+
+# Testhide Pytest Plugin
+
+A pytest plugin for creating incremental XML test reports. This plugin is designed to be extensible, allowing other plugins to inject metadata and test attachments.
+
+## Installation
+
+```bash
+pip install testhide-pytest-plugin

testhide_pytest_plugin-0.1.0/src/testhide_pytest_plugin.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+src/testhide_plugin/__init__.py
+src/testhide_plugin/plugin.py
+src/testhide_pytest_plugin.egg-info/PKG-INFO
+src/testhide_pytest_plugin.egg-info/SOURCES.txt
+src/testhide_pytest_plugin.egg-info/dependency_links.txt
+src/testhide_pytest_plugin.egg-info/entry_points.txt
+src/testhide_pytest_plugin.egg-info/requires.txt
+src/testhide_pytest_plugin.egg-info/top_level.txt

testhide_pytest_plugin-0.1.0/src/testhide_pytest_plugin.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

testhide_pytest_plugin-0.1.0/src/testhide_pytest_plugin.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+testhide_plugin = testhide_plugin.plugin

testhide_pytest_plugin-0.1.0/src/testhide_pytest_plugin.egg-info/requires.txt

@@ -0,0 +1 @@
+pytest>=7.0

testhide_pytest_plugin-0.1.0/src/testhide_pytest_plugin.egg-info/top_level.txt

@@ -0,0 +1 @@
+testhide_plugin