cloudbeat-pytest 0.0.1__py3-none-any.whl

cloudbeat_pytest/context.py

@@ -0,0 +1,42 @@
+from cloudbeat_pytest.pytest_reporter import CbPyTestReporter
+import importlib
+import sys
+
+
+class CbContext:
+    class __CbContext:
+        _reporter: CbPyTestReporter = None
+
+        def __init__(self, reporter: CbPyTestReporter):
+            self._reporter = reporter
+
+        def get_webdriver_listener(self):
+            pass
+
+    instance = None
+
+    def __new__(cls):  # __new__ always a classmethod
+        if not CbContext.instance:
+            CbContext.instance = CbContext.__Report()
+        return CbContext.instance
+
+    def __getattr__(self, name):
+        return getattr(self.instance, name)
+
+    # def __setattr__(self, name):
+    #    return setattr(self.instance, name)
+
+    @staticmethod
+    def init(reporter: CbPyTestReporter):
+        if not CbContext.instance:
+            CbContext.instance = CbContext.__CbContext(reporter)
+            print(sys.modules)
+            if "cloudbeat_playwright" in sys.modules:
+                pw_module = importlib.import_module(".wrapper", "cloudbeat_playwright")
+                pw_wrapper_class = getattr(pw_module, "CbPlaywrightWrapper")
+                CbContext.instance.__setattr__("pw", pw_wrapper_class(reporter))
+            if "cloudbeat_selenium" in sys.modules:
+                se_module = importlib.import_module("wrapper", "cloudbeat_selenium")
+                se_wrapper_class = getattr(se_module, "CbSeleniumWrapper")
+                CbContext.instance.__setattr__("se", se_wrapper_class(reporter))
+        return CbContext.instance

cloudbeat_pytest/helpers.py

@@ -0,0 +1,84 @@
+import sys
+from itertools import chain, islice
+
+from _pytest.doctest import DoctestItem
+from _pytest.nodes import Item
+from _pytest.python import Class, Function, Module
+from _pytest.reports import TestReport
+from cloudbeat_common.models import TestStatus
+
+
+def get_module_details(item: Item):
+    head, maybe_class, tail = islice(chain(item.nodeid.split('::'), [None], [None]), 3)
+    class_name = maybe_class if tail else None
+    file_name, path = islice(chain(reversed(head.rsplit('/', 1)), [None]), 2)
+    module_name = file_name.split('.')[0]
+    package_name = path.replace('/', '.') if path else None
+    fqn = f"{package_name + '.' if package_name is not None else ''}{module_name}"
+    return {
+        "package_name": package_name,
+        "module_name": module_name,
+        "class_name": class_name,
+        "fqn": fqn
+    }
+
+
+def get_test_details(item: Item):
+    return {
+        "fqn": item.nodeid,
+        "name": item.name
+    }
+
+
+def calculate_status(result: TestReport):
+    if result.skipped:
+        return TestStatus.SKIPPED
+    elif result.failed:
+        return TestStatus.FAILED
+    return TestStatus.PASSED
+
+
+def get_description(item):
+    if isinstance(item, (Class, Function, Module, Item)):
+        if hasattr(item, "obj"):
+            doc = item.obj.__doc__
+            if doc is not None:
+                return trim_docstring(doc)
+    if isinstance(item, DoctestItem):
+        return item.reportinfo()[2]
+
+
+def trim_docstring(docstring: str) -> str:
+    """
+    Convert docstring.
+
+    :param docstring: input docstring
+    :return: trimmed docstring
+    """
+    if not docstring:
+        return ''
+    # Convert tabs to spaces (following the normal Python rules)
+    # and split into a list of lines:
+    lines = docstring.expandtabs().splitlines()
+    # Determine minimum indentation (first line doesn't count):
+    indent = sys.maxsize
+    for line in lines[1:]:
+        stripped = line.lstrip()
+        if stripped:
+            indent = min(indent, len(line) - len(stripped))
+    # Remove indentation (first line is special):
+    trimmed = [lines[0].strip()]
+    if indent < sys.maxsize:
+        for line in lines[1:]:
+            trimmed.append(line[indent:].rstrip())
+    # Strip off trailing and leading blank lines:
+    while trimmed and not trimmed[-1]:
+        trimmed.pop()
+    while trimmed and not trimmed[0]:
+        trimmed.pop(0)
+    # Return a single string:
+    return '\n'.join(trimmed)
+
+
+def get_test_parameters(item: Item):
+    return item.callspec.params if hasattr(item, 'callspec') else None

cloudbeat_pytest/listener.py

@@ -0,0 +1,54 @@
+import pytest
+
+from cloudbeat_pytest.pytest_reporter import CbPyTestReporter
+
+
+class CbTestListener:
+
+    def __init__(self, config):
+        self.config = config
+
+    @pytest.hookimpl(hookwrapper=True, tryfirst=True)
+    def pytest_runtest_protocol(self, item):
+        reporter: CbPyTestReporter = item.config.cb_reporter
+        print(f"Starting protocol: {item.name}")
+        reporter.start_protocol(item)
+        result = (yield).get_result()
+        reporter.end_protocol(item)
+        print(f"Finished protocol: {item.name}")
+
+    @pytest.hookimpl(hookwrapper=True)
+    def pytest_runtest_setup(self, item):
+        reporter: CbPyTestReporter = item.config.cb_reporter
+        reporter.start_setup(item)
+        print(f"Starting setup hook: {item.name}")
+        yield
+        print(f"Finished setup hook: {item.name}")
+
+    @pytest.hookimpl(hookwrapper=True)
+    def pytest_runtest_teardown(self, item):
+        reporter: CbPyTestReporter = item.config.cb_reporter
+        reporter.start_teardown(item)
+        print(f"Starting teardown hook: {item.name}")
+        yield
+        print(f"Finished teardown hook: {item.name}")
+
+    @pytest.hookimpl(hookwrapper=True)
+    def pytest_runtest_call(self, item):
+        print(f"Starting call hook: {item.name}")
+        yield
+        print(f"Finished call hook: {item.name}")
+
+    @pytest.hookimpl(hookwrapper=True)
+    def pytest_runtest_makereport(self, item, call):
+        reporter: CbPyTestReporter = item.config.cb_reporter
+        print(f"Starting makereport hook: {item.name}")
+        result = (yield).get_result()
+        if call.when == "call":
+            reporter.end_call(item, result)
+        elif call.when == "setup":
+            reporter.end_setup(item, result)
+        elif call.when == "teardown":
+            reporter.end_teardown(item, result)
+        # call.when
+        print(f"Finished makereport hook: {item.name}")

cloudbeat_pytest/plugin.py

@@ -0,0 +1,71 @@
+import os
+
+import pytest
+from cloudbeat_common.models import CbConfig
+
+from cloudbeat_pytest.listener import CbTestListener
+from cloudbeat_pytest.pytest_reporter import CbPyTestReporter
+
+from cloudbeat_pytest.context import CbContext
+
+
+def pytest_addoption(parser):
+    group = parser.getgroup("cloudbeat")
+    group.addoption(
+        "--name",
+        action="store",
+        dest="name",
+        default="World",
+        help='Default "name" for hello().',
+    )
+
+
+def get_cb_config(config):
+    cb_config = CbConfig()
+    # if os.environ.get("CB_AGENT") is not None and os.environ["CB_AGENT"] == "true":
+    #     cb_config.is_ready = True
+    cb_config.is_ready = True
+    cb_config.run_id = os.environ.get("CB_RUN_ID")
+    cb_config.instance_id = os.environ.get("CB_INSTANCE_ID")
+    cb_config.project_id = os.environ.get("CB_PROJECT_ID")
+    cb_config.api_endpoint_url = os.environ.get("CB_API_URL")
+    cb_config.api_token = os.environ.get("CB_API_KEY")
+    cb_config.selenium_url = os.environ.get("CB_SELENIUM_URL")
+    cb_config.appium_url = os.environ.get("CB_APPIUM_URL")
+    if os.environ.get("CB_BROWSER_NAME") is not None:
+        cb_config.capabilities["browserName"] = os.environ["CB_BROWSER_NAME"]
+    return cb_config
+
+
+def pytest_configure(config):
+    print("--- pytest_configure")
+    # if not config.option.cb_enabled:
+    #    return
+    cb_config: CbConfig = get_cb_config(config)
+    if not cb_config.is_ready:
+        return
+    config.cb_reporter = CbPyTestReporter(cb_config)
+    test_listener = CbTestListener(config)
+    config.pluginmanager.register(test_listener, 'cloudbeat_listener')
+
+
+def pytest_sessionstart(session):
+    if session.config.cb_reporter is None:
+        return
+    reporter: CbPyTestReporter = session.config.cb_reporter
+    reporter.start_instance()
+
+
+def pytest_sessionfinish(session):
+    if session.config.cb_reporter is None:
+        return
+    reporter: CbPyTestReporter = session.config.cb_reporter
+    reporter.end_instance()
+
+
+@pytest.fixture(scope="session")
+# instantiates ini file parses object
+def cbx(request) -> CbContext:
+    reporter = request.session.config.cb_reporter
+    context = CbContext.init(reporter)
+    return context

cloudbeat_pytest/pytest_reporter.py

@@ -0,0 +1,53 @@
+from cloudbeat_common.reporter import CbTestReporter
+from cloudbeat_common.models import TestStatus
+from _pytest.nodes import Item
+from _pytest.reports import TestReport
+from cloudbeat_pytest.helpers import get_module_details, get_test_details, calculate_status, get_description, get_test_parameters
+
+
+class CbPyTestReporter(CbTestReporter):
+    def start_protocol(self, item: Item):
+        # Check if current test's module has already a related suite result
+        module_details = get_module_details(item)
+        current_suite_result = self._context["suite"] if "suite" in self._context else None
+        if current_suite_result is None or current_suite_result.fqn != module_details["fqn"]:
+            CbTestReporter.start_suite(self, module_details["module_name"], module_details["fqn"])
+        test_details = get_test_details(item)
+        case_result = CbTestReporter.start_case(self, test_details["name"], test_details["fqn"])
+        # Set case status as SKIPPED by default, because if the test is skipped,
+        # pytest_runtest_call hook won't be called and we won't get any indication
+        # if the test has been skipped
+        case_result.status = TestStatus.SKIPPED
+        case_result.description = get_description(item)
+        test_parameters = get_test_parameters(item)
+        if test_parameters is not None and len(test_parameters) > 0:
+            case_result.add_parameters(test_parameters)
+
+    def end_protocol(self, item: Item):
+        # Call end_case again (previously called in end_call),
+        # so end_time will include teardown hook
+        CbTestReporter.end_case(self)
+        # Check if current test's module has already a related suite result
+        module_details = get_module_details(item)
+        suite_result = self._context["suite"] if "suite" in self._context else None
+        if suite_result is None or suite_result.fqn != module_details["fqn"]:
+            next(suite_result for suite in self.result.suites if suite.fqn == module_details["fqn"])
+        if suite_result is None:
+            return
+        suite_result.end()
+
+    def start_setup(self, item: Item):
+        CbTestReporter.start_case_hook(self, "setup")
+
+    def end_setup(self, item: Item, result: TestReport):
+        CbTestReporter.end_case_hook(self)
+
+    def start_teardown(self, item: Item):
+        CbTestReporter.start_case_hook(self, "teardown")
+
+    def end_teardown(self, item: Item, result: TestReport):
+        CbTestReporter.end_case_hook(self)
+
+    def end_call(self, item: Item, result: TestReport):
+        status = calculate_status(result)
+        CbTestReporter.end_case(self, status)

cloudbeat_pytest-0.0.1.dist-info/METADATA

@@ -0,0 +1,36 @@
+Metadata-Version: 2.4
+Name: cloudbeat-pytest
+Version: 0.0.1
+Summary: CloudBeat Pytest Kit
+Home-page: https://cloudbeat.io/
+Author: CBNR Cloud Solutions LTD
+Author-email: info@cloudbeat.io
+License: Apache-2.0
+Project-URL: Source, https://github.com/cloudbeat-io/cb-kit-python
+Keywords: cloudbeat testing reporting python pytest
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: project-url
+Dynamic: requires-python
+Dynamic: summary

cloudbeat_pytest-0.0.1.dist-info/RECORD

@@ -0,0 +1,11 @@
+cloudbeat_pytest/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cloudbeat_pytest/context.py,sha256=RoFiI588QdW4fpOjz5b_CjO7-hzWzM9pBdZYvyEFsSo,1507
+cloudbeat_pytest/helpers.py,sha256=iDLztVjMm_MEciIv46tm3RSpDl_iVRFzUwzTSBDdaws,2549
+cloudbeat_pytest/listener.py,sha256=3NIlETBcdCzrlp1iBkRdN6p-Wt79jk_hhEz8lp3D1qM,1894
+cloudbeat_pytest/plugin.py,sha256=gMbVnNag3g090SlXcVkH8qkf0AexEgsStL02mvooNF0,2198
+cloudbeat_pytest/pytest_reporter.py,sha256=p6b9AQfI1EftPBcXrJBuslsdiH-jfssBY9i5FYKlJ8I,2625
+cloudbeat_pytest-0.0.1.dist-info/METADATA,sha256=ti9pSrcplXtf5AVThyE6638HXrEPsIEd489IhWr-svg,1353
+cloudbeat_pytest-0.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+cloudbeat_pytest-0.0.1.dist-info/entry_points.txt,sha256=VjdlGQ940f-bUu7dnl-_7IH1X1Pq5Z6H0S1ycHBaWSQ,54
+cloudbeat_pytest-0.0.1.dist-info/top_level.txt,sha256=8_w40urWHZTezqXKQqqDvJgqIV8U-XfIotH-ppu4hzQ,17
+cloudbeat_pytest-0.0.1.dist-info/RECORD,,

cloudbeat_pytest-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

cloudbeat_pytest-0.0.1.dist-info/entry_points.txt

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

cloudbeat_pytest-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+cloudbeat_pytest