pytest-json-ctrf 0.2.1__tar.gz → 0.3.0__tar.gz

{pytest_json_ctrf-0.2.1 → pytest_json_ctrf-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pytest-json-ctrf
-Version: 0.2.1
+Version: 0.3.0
 Summary: Pytest plugin to generate json report in CTRF (Common Test Report Format)
 Author: Oleksii Ostapov
 Project-URL: Infopulse, https://infopulse.com/
@@ -97,3 +97,6 @@ The `pytest_runtest_logreport` hook in the controller node is used to collect th
 - https://github.com/testomatio/pytestomatio -> Source of inspiration for creating pytest plugins
 - https://github.com/infopulse/Playwright-course-python -> The report will be used in the demo project as +1 report option
 
+### Roadmap
+- Add screenshots handling
+- Add hooks for the report extension

{pytest_json_ctrf-0.2.1 → pytest_json_ctrf-0.3.0}/README.md

@@ -82,3 +82,6 @@ The `pytest_runtest_logreport` hook in the controller node is used to collect th
 - https://github.com/testomatio/pytestomatio -> Source of inspiration for creating pytest plugins
 - https://github.com/infopulse/Playwright-course-python -> The report will be used in the demo project as +1 report option
 
+### Roadmap
+- Add screenshots handling
+- Add hooks for the report extension

{pytest_json_ctrf-0.2.1/plugin → pytest_json_ctrf-0.3.0/ctrf}/BaseMetadataReport.py

@@ -1,6 +1,5 @@
-from pytest import Config, hookimpl, Item, CallInfo, CollectReport, Function, TestReport, fixture, FixtureRequest
+from pytest import Config, hookimpl, Item
 from .Report import Report
-from collections import OrderedDict
 
 metadata = '_ctrf_metadata'
 

{pytest_json_ctrf-0.2.1/plugin → pytest_json_ctrf-0.3.0/ctrf}/CommonTestReportPlugin.py

@@ -1,5 +1,4 @@
-from pytest import Config, hookimpl, Item, CallInfo, CollectReport, Function, TestReport, fixture, FixtureRequest
-from .Report import Report
+from pytest import hookimpl, TestReport
 from collections import OrderedDict
 from .BaseMetadataReport import metadata, BaseMetadataReport
 

{pytest_json_ctrf-0.2.1/plugin → pytest_json_ctrf-0.3.0/ctrf}/Report.py

@@ -2,7 +2,7 @@ import os
 import pytest
 import time
 import json
-from pytest import Item, CallInfo, TestReport, Mark
+from pytest import TestReport
 from collections import OrderedDict
 from .TestObject import TestObject, TestStatus
 
@@ -27,13 +27,16 @@ class Report:
             "version": str(pytest.__version__)
         }
 
+    def list_tests_by_status(self, status: TestStatus) -> list:
+        return [test for test in self.prepared_tests.values() if test.status == status]
+
     def _get_summary(self) -> dict:
         return {
             'tests': len(self.prepared_tests),
-            'passed': len([test for test in self.prepared_tests.values() if test.status == TestStatus.PASSED]),
-            'failed': len([test for test in self.prepared_tests.values() if test.status == TestStatus.FAILED]),
-            'skipped': len([test for test in self.prepared_tests.values() if test.status == TestStatus.SKIPPED]),
-            'pending': len([test for test in self.prepared_tests.values() if test.status == TestStatus.PENDING]),
+            'passed': len(self.list_tests_by_status(TestStatus.PASSED)),
+            'failed': len(self.list_tests_by_status(TestStatus.FAILED)),
+            'skipped': len(self.list_tests_by_status(TestStatus.SKIPPED)),
+            'pending': len(self.list_tests_by_status(TestStatus.PENDING)),
             'other': 0,
             'start': self.start_time,
             'stop': self.stop_time
@@ -41,10 +44,11 @@ class Report:
 
     def collect(self, report: TestReport) -> None:
         if report.nodeid not in self.test_items.keys():
-            test = TestObject()
+            worker_id = getattr(report, 'worker_id', None)
+            test = TestObject(report, worker_id)
         else:
-            test = self.test_items.get(report.nodeid)
-        test.update(report, getattr(report, 'worker_id', None))
+            test = self.test_items.get(report.nodeid)  # type: ignore
+        test.update(report)
         self.test_items[report.nodeid] = test
 
     def process_retries(self) -> None:
@@ -58,12 +62,11 @@ class Report:
 
     def get_report(self) -> dict:
         self.process_retries()
-        return {'results':
-            {
-                "tool": self._get_tool(),
-                "summary": self._get_summary(),
-                "tests": [test.serialize() for test in self.prepared_tests.values()]
-            }
+        return {'results': {
+            "tool": self._get_tool(),
+            "summary": self._get_summary(),
+            "tests": [test.serialize() for test in self.prepared_tests.values()]
+        }
         }
 
     def save(self, report_file: str) -> None:

{pytest_json_ctrf-0.2.1/plugin → pytest_json_ctrf-0.3.0/ctrf}/TestObject.py

@@ -1,6 +1,9 @@
 from enum import Enum
+from typing import Any
+
 from pytest import TestReport
 
+
 class TestStatus(Enum):
     PASSED = "passed"
     FAILED = "failed"
@@ -10,24 +13,41 @@ class TestStatus(Enum):
 
 
 class TestObject:
-    name: str = None
-    status: TestStatus = TestStatus.PENDING
-    raw_status: str = None
+    name: str
+    status: TestStatus
+    raw_status: str
     duration: float = 0
-    start: float = None
-    stop: float = None
-    retries: int = 0
-    message: str = ''
+    start: float
+    stop: float
+    retries: int
+    message: str
+
+    worker_id: str
+    file_path: str
+    tags: list[str]
+    browser: str
+    trace: str
+
+    def __init__(self, report: TestReport, worker_id: str or None = None):
+        self.name = report.nodeid.split('[')[0]
+        self.status = TestStatus.PENDING
+        self.status = self.set_status(report)
+        self.raw_status = None
+        self.duration = 0
+        self.start = 0
+        self.stop = 0
+        self.retries = 0
+        self.message = None
 
-    worker_id: str = None
-    file_path: str = None
-    tags: list[str] = None
-    browser: str = None
-    trace: str = None
+        self.worker_id = worker_id
+        self.file_path = report.location[0]
+        self.tags = []
+        self.browser = None
+        self.trace = None
 
-    def set_status(self, report: TestReport) -> None:
+    def set_status(self, report: TestReport) -> TestStatus:
         if self.status in (TestStatus.SKIPPED, TestStatus.FAILED):
-            return
+            return self.status
         elif report.skipped:
             self.status = TestStatus.SKIPPED
         elif report.failed:
@@ -43,25 +63,23 @@ class TestObject:
             self.status = TestStatus.PASSED
         else:
             self.status = TestStatus.OTHER
+        return self.status
 
-    def update(self, report: TestReport, worker_id: str = None) -> None:
-        self.name = report.head_line.split('[')[0]
+    def update(self, report: TestReport) -> None:
         self.set_status(report)
         self.duration += report.duration
-        if report.when == "setup" and not self.start:
+        if report.when == "setup" and self.start == 0:
             self.start = report.start
-        if report.when == "teardown" and not self.stop:
+        if report.when == "teardown" and self.stop == 0:
             self.stop = report.stop
-        self.file_path = report.location[0]
         if report.longrepr and len(report.longreprtext) > 0:
             self.trace = report.longreprtext
         if hasattr(report, '_ctrf_metadata'):
             self.tags = report._ctrf_metadata.get('tags')
             self.browser = report._ctrf_metadata.get('browser')
-        self.worker_id = worker_id
 
     def serialize(self) -> dict:
-        result = {
+        result: dict[str, Any] = {
             'name': self.name,
             'status': self.status.value,
             'raw_status': self.raw_status,

{pytest_json_ctrf-0.2.1/plugin → pytest_json_ctrf-0.3.0/ctrf}/main.py

@@ -1,12 +1,13 @@
-from pytest import Config, Parser, FixtureRequest, fixture, Function
-from plugin.CommonTestReportPlugin import CTRF
-from plugin.BaseMetadataReport import BaseMetadataReport
+from pytest import Config, Parser, FixtureRequest, fixture
+from ctrf.CommonTestReportPlugin import CTRF
+from ctrf.BaseMetadataReport import BaseMetadataReport
 
 
 def pytest_addoption(parser: Parser):
-    parser.addoption('--ctrf',
-                     action='store',
-                     help='generate test report. Report file name is optional')
+    group = parser.getgroup('ctrf', 'generate test report in CTR format')
+    group.addoption('--ctrf',
+                    action='store',
+                    help='generate test report. Report file name is optional')
 
 
 def pytest_configure(config: Config):
@@ -17,15 +18,16 @@ def pytest_configure(config: Config):
     else:
         plugin = CTRF()
     setattr(config, '_ctrf', plugin)
-    config.pluginmanager.register(plugin, name='ctrf')
+    config.pluginmanager.register(plugin, name='ctrf_plugin')
+    pass
 
 
 def pytest_unconfigure(config: Config):
     ctrf = getattr(config, '_ctrf', None)
     if ctrf is not None:
         delattr(config, '_ctrf')
-    if config.pluginmanager.hasplugin('ctrf'):
-        config.pluginmanager.unregister(name='ctrf')
+    if config.pluginmanager.hasplugin('ctrf_plugin'):
+        config.pluginmanager.unregister(name='ctrf_plugin')
 
 
 @fixture(autouse=True)
@@ -38,4 +40,4 @@ def ctrf_json_metadata(request: FixtureRequest):
         browser = request.node.callspec.params.get('browser_name')
         if browser:
             request.node._ctrf_metadata.setdefault('browser', browser)
-    return request.node._ctrf_metadata
+    return request.node._ctrf_metadata

{pytest_json_ctrf-0.2.1 → pytest_json_ctrf-0.3.0}/pyproject.toml

@@ -3,11 +3,14 @@ requires = ["setuptools>=65.5.1", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools.packages.find]
-exclude = [".github", "tests", "build", "dist", ".venv", "pytestomatio.egg-info", ".env", ".gitignore", "CHANGELOG.md", "assets"]
+exclude = [
+    ".github", "tests", "build", "dist", ".venv",
+    "pytest_json_ctrf.egg-info", ".env", ".gitignore",
+    "CHANGELOG.md", "assets", "test-results"]
 
 [project]
 name = "pytest-json-ctrf"
-version = "0.2.1"
+version = "0.3.0"
 
 dependencies = [
     "pytest>6.0.0",
@@ -37,4 +40,4 @@ markers = [
 ]
 
 [project.entry-points.pytest11]
-pytestomatio = "plugin.main"
+ctrf = "ctrf.main"

{pytest_json_ctrf-0.2.1 → pytest_json_ctrf-0.3.0}/pytest_json_ctrf.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pytest-json-ctrf
-Version: 0.2.1
+Version: 0.3.0
 Summary: Pytest plugin to generate json report in CTRF (Common Test Report Format)
 Author: Oleksii Ostapov
 Project-URL: Infopulse, https://infopulse.com/
@@ -97,3 +97,6 @@ The `pytest_runtest_logreport` hook in the controller node is used to collect th
 - https://github.com/testomatio/pytestomatio -> Source of inspiration for creating pytest plugins
 - https://github.com/infopulse/Playwright-course-python -> The report will be used in the demo project as +1 report option
 
+### Roadmap
+- Add screenshots handling
+- Add hooks for the report extension

{pytest_json_ctrf-0.2.1 → pytest_json_ctrf-0.3.0}/pytest_json_ctrf.egg-info/SOURCES.txt

@@ -1,15 +1,16 @@
 README.md
 pyproject.toml
-plugin/BaseMetadataReport.py
-plugin/CommonTestReportPlugin.py
-plugin/Report.py
-plugin/TestObject.py
-plugin/__init__.py
-plugin/main.py
+ctrf/BaseMetadataReport.py
+ctrf/CommonTestReportPlugin.py
+ctrf/Report.py
+ctrf/TestObject.py
+ctrf/__init__.py
+ctrf/main.py
 pytest_json_ctrf.egg-info/PKG-INFO
 pytest_json_ctrf.egg-info/SOURCES.txt
 pytest_json_ctrf.egg-info/dependency_links.txt
 pytest_json_ctrf.egg-info/entry_points.txt
 pytest_json_ctrf.egg-info/requires.txt
 pytest_json_ctrf.egg-info/top_level.txt
-tests/test_example.py
+tests/test_example.py
+tests/test_plugin.py

pytest_json_ctrf-0.3.0/pytest_json_ctrf.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+ctrf = ctrf.main

pytest_json_ctrf-0.3.0/pytest_json_ctrf.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+build
+ctrf

pytest_json_ctrf-0.3.0/tests/test_plugin.py

@@ -0,0 +1,91 @@
+import json
+from pytest import Pytester, fixture
+
+pytest_plugins = ["pytester", "xdist", "ctrf"]
+test_file = "tests/test_example.py"
+basic_test_args = ["-k", "test_example"]
+
+
+@fixture
+def ctrf_report_sync(pytester: Pytester):
+    pytester.copy_example(test_file)
+    pytester.runpytest(*[*basic_test_args, "--ctrf", "report.json"])
+    with open(pytester.path / "report.json") as file:
+        yield json.load(file)
+
+
+@fixture
+def ctrf_report_xdist(pytester: Pytester):
+    pytester.copy_example(test_file)
+    pytester.runpytest(*[*basic_test_args, "--ctrf", "report.json", "-n", "3"])
+    with open(pytester.path / "report.json") as file:
+        yield json.load(file)
+
+
+def test_without_plugin_no_xdist(pytester: Pytester):
+    pytester.copy_example(test_file)
+    result = pytester.runpytest(*basic_test_args)
+    result.assert_outcomes(passed=9, skipped=1, failed=2, errors=2)
+
+
+def test_without_plugin_with_xdist(pytester: Pytester):
+    pytester.copy_example(test_file)
+    result = pytester.runpytest(*[*basic_test_args, "-n", "3"])
+    result.assert_outcomes(passed=9, skipped=1, failed=2, errors=2)
+    assert "created: 3/3 workers" in result.stdout.str()
+
+
+def test_with_markers(pytester: Pytester):
+    pytester.copy_example(test_file)
+    args = [*basic_test_args, "--ctrf", "report.json", "-m smoke"]
+    pytester.runpytest(*args)
+    with open(pytester.path / "report.json") as file:
+        report = json.load(file)
+    assert report["results"]["summary"]["tests"] == 1
+    assert report["results"]["summary"]["passed"] == 1
+    assert report["results"]["summary"]["failed"] == 0
+    assert report["results"]["summary"]["skipped"] == 0
+
+
+def test_with_plugin_no_xdist(ctrf_report_sync):
+    assert ctrf_report_sync["results"]["summary"]["tests"] == 9
+    assert ctrf_report_sync["results"]["summary"]["passed"] == 4
+    assert ctrf_report_sync["results"]["summary"]["failed"] == 4
+    assert ctrf_report_sync["results"]["summary"]["skipped"] == 1
+
+
+def test_with_plugin_failed_details(ctrf_report_sync):
+    for test in ctrf_report_sync["results"]["tests"]:
+        if test["status"] == "failed" and test.get("raw_status") == "call_failed":
+            assert test.get('trace') is not None
+            assert test.get("message") is not None
+            assert test.get("raw_status") is not None
+
+
+def test_any_test_has_timestamps(ctrf_report_sync):
+    for test in ctrf_report_sync["results"]["tests"]:
+        assert test.get("start") is not None
+        assert test.get("stop") is not None
+        assert test.get("duration") is not None
+
+
+def test_with_plugin_with_xdist(ctrf_report_xdist):
+    assert ctrf_report_xdist["results"]["summary"]["tests"] == 9
+    assert ctrf_report_xdist["results"]["summary"]["passed"] == 4
+    assert ctrf_report_xdist["results"]["summary"]["failed"] == 4
+    assert ctrf_report_xdist["results"]["summary"]["skipped"] == 1
+
+
+def test_with_plugin_failed_details_xdist(ctrf_report_xdist):
+    for test in ctrf_report_xdist["results"]["tests"]:
+        if test["status"] == "failed" and test.get("raw_status") == "call_failed":
+            assert test.get('trace') is not None
+            assert test.get("message") is not None
+            assert test.get("raw_status") is not None
+
+
+def test_any_test_has_timestamps_xdist(ctrf_report_xdist):
+    for test in ctrf_report_xdist["results"]["tests"]:
+        assert test.get("start") is not None
+        assert test.get("stop") is not None
+        assert test.get("duration") is not None

pytest_json_ctrf-0.2.1/pytest_json_ctrf.egg-info/entry_points.txt

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

pytest_json_ctrf-0.2.1/pytest_json_ctrf.egg-info/top_level.txt

@@ -1 +0,0 @@
-plugin