hardpy 0.6.1__py3-none-any.whl → 0.8.0__py3-none-any.whl

hardpy/pytest_hardpy/plugin.py

@@ -1,5 +1,6 @@
 # Copyright (c) 2024 Everypin
 # GNU General Public License v3.0 (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+from __future__ import annotations
 
 import signal
 from logging import getLogger
@@ -8,37 +9,38 @@ from platform import system
 from re import compile as re_compile
 from typing import Any, Callable
 
+from _pytest._code.code import (
+    ExceptionInfo,
+    ExceptionRepr,
+    ReprExceptionInfo,
+    ReprFileLocation,
+    TerminalRepr,
+)
 from natsort import natsorted
 from pytest import (
-    skip,
-    exit,
-    TestReport,
-    Item,
-    Session,
+    CallInfo,
     Config,
+    ExitCode,
+    Item,
     Parser,
+    Session,
+    TestReport,
+    exit,  # noqa: A004
     fixture,
-    ExitCode,
-)
-from _pytest._code.code import (
-    ExceptionRepr,
-    ReprFileLocation,
-    ExceptionInfo,
-    ReprExceptionInfo,
-    TerminalRepr,
+    skip,
 )
 
 from hardpy.pytest_hardpy.reporter import HookReporter
 from hardpy.pytest_hardpy.utils import (
-    TestStatus,
+    ConnectionData,
     NodeInfo,
     ProgressCalculator,
-    ConnectionData,
+    TestStatus,
 )
 from hardpy.pytest_hardpy.utils.node_info import TestDependencyInfo
 
 
-def pytest_addoption(parser: Parser):
+def pytest_addoption(parser: Parser) -> None:
     """Register argparse-style options."""
     con_data = ConnectionData()
     parser.addoption(
@@ -61,7 +63,7 @@ def pytest_addoption(parser: Parser):
     )
     parser.addoption(
         "--hardpy-clear-database",
-        action="store",
+        action="store_true",
         default=False,
         help="clear hardpy local database",
     )
@@ -74,7 +76,12 @@ def pytest_addoption(parser: Parser):
 
 
 # Bootstrapping hooks
-def pytest_load_initial_conftests(early_config, parser, args):
+def pytest_load_initial_conftests(
+    early_config: Config,
+    parser: Parser,  # noqa: ARG001
+    args: Any,  # noqa: ANN401
+) -> None:
+    """Load initial conftests."""
     if "--hardpy-pt" in args:
         plugin = HardpyPlugin()
         early_config.pluginmanager.register(plugin)
@@ -86,7 +93,7 @@ class HardpyPlugin:
     Extends hook functions from pytest API.
     """
 
-    def __init__(self):
+    def __init__(self) -> None:
         self._progress = ProgressCalculator()
         self._results = {}
         self._post_run_functions: list[Callable] = []
@@ -95,21 +102,20 @@ class HardpyPlugin:
         if system() == "Linux":
             signal.signal(signal.SIGTERM, self._stop_handler)
         elif system() == "Windows":
-            signal.signal(signal.SIGBREAK, self._stop_handler)
+            signal.signal(signal.SIGBREAK, self._stop_handler)  # type: ignore
         self._log = getLogger(__name__)
 
     # Initialization hooks
 
-    def pytest_configure(self, config: Config):
+    def pytest_configure(self, config: Config) -> None:
         """Configure pytest."""
         con_data = ConnectionData()
 
         database_url = config.getoption("--hardpy-db-url")
         if database_url:
-            con_data.database_url = str(database_url)
+            con_data.database_url = str(database_url)  # type: ignore
 
         is_clear_database = config.getoption("--hardpy-clear-database")
-        is_clear_statestore = is_clear_database == str(True)
 
         socket_port = config.getoption("--hardpy-sp")
         if socket_port:
@@ -117,19 +123,20 @@ class HardpyPlugin:
 
         socket_host = config.getoption("--hardpy-sh")
         if socket_host:
-            con_data.socket_host = str(socket_host)
+            con_data.socket_host = str(socket_host)  # type: ignore
 
         config.addinivalue_line("markers", "case_name")
         config.addinivalue_line("markers", "module_name")
         config.addinivalue_line("markers", "dependency")
+        config.addinivalue_line("markers", "attempt")
 
         # must be init after config data is set
         try:
-            self._reporter = HookReporter(is_clear_statestore)
+            self._reporter = HookReporter(bool(is_clear_database))
         except RuntimeError as exc:
             exit(str(exc), 1)
 
-    def pytest_sessionfinish(self, session: Session, exitstatus: int):
+    def pytest_sessionfinish(self, session: Session, exitstatus: int) -> None:
         """Call at the end of test session."""
         if "--collect-only" in session.config.invocation_params.args:
             return
@@ -146,8 +153,11 @@ class HardpyPlugin:
     # Collection hooks
 
     def pytest_collection_modifyitems(
-        self, session: Session, config: Config, items: list[Item]
-    ):
+        self,
+        session: Session,
+        config: Config,
+        items: list[Item],  # noqa: ARG002
+    ) -> None:
         """Call after collection phase."""
         self._reporter.init_doc(str(PurePath(config.rootpath).name))
 
@@ -163,8 +173,8 @@ class HardpyPlugin:
                 continue
             try:
                 node_info = NodeInfo(item)
-            except ValueError:
-                error_msg = f"Error creating NodeInfo for item: {item}\n"
+            except ValueError as exc:
+                error_msg = f"Error creating NodeInfo for item: {item}. {exc}"
                 exit(error_msg, 1)
 
             self._init_case_result(node_info.module_id, node_info.case_id)
@@ -184,7 +194,7 @@ class HardpyPlugin:
 
     # Test running (runtest) hooks
 
-    def pytest_runtestloop(self, session: Session):
+    def pytest_runtestloop(self, session: Session) -> bool | None:
         """Call at the start of test run."""
         self._progress.set_test_amount(session.testscollected)
         if session.config.option.collectonly:
@@ -194,8 +204,9 @@ class HardpyPlugin:
         # testrun entrypoint
         self._reporter.start()
         self._reporter.update_db_by_doc()
+        return None
 
-    def pytest_runtest_setup(self, item: Item):
+    def pytest_runtest_setup(self, item: Item) -> None:
         """Call before each test setup phase."""
         if item.parent is None:
             self._log.error(f"Test module name for test {item.name} not found.")
@@ -203,28 +214,68 @@ class HardpyPlugin:
 
         node_info = NodeInfo(item)
 
-        self._handle_dependency(node_info)
+        status = TestStatus.RUN
+        is_skip_test = self._is_skip_test(node_info)
+        if not is_skip_test:
+            self._reporter.set_module_start_time(node_info.module_id)
+            self._reporter.set_case_start_time(node_info.module_id, node_info.case_id)
+        else:
+            status = TestStatus.SKIPPED
+            self._results[node_info.module_id][node_info.case_id] = status
+            progress = self._progress.calculate(item.nodeid)
+            self._reporter.set_progress(progress)
 
-        self._reporter.set_module_status(node_info.module_id, TestStatus.RUN)
-        self._reporter.set_module_start_time(node_info.module_id)
-        self._reporter.set_case_status(
-            node_info.module_id,
-            node_info.case_id,
-            TestStatus.RUN,
-        )
-        self._reporter.set_case_start_time(
+        self._reporter.set_module_status(node_info.module_id, status)
+        self._reporter.set_case_status(node_info.module_id, node_info.case_id, status)
+        self._reporter.update_db_by_doc()
+
+        if is_skip_test:
+            skip(f"Test {item.nodeid} is skipped")
+
+    def pytest_runtest_call(self, item: Item) -> None:
+        """Call the test item."""
+        node_info = NodeInfo(item)
+        self._reporter.set_case_attempt(
             node_info.module_id,
             node_info.case_id,
+            1,
         )
         self._reporter.update_db_by_doc()
 
+    def pytest_runtest_makereport(self, item: Item, call: CallInfo) -> None:
+        """Call after call of each test item."""
+        if call.when != "call" or not call.excinfo:
+            return
+
+        node_info = NodeInfo(item)
+        attempt = node_info.attempt
+        module_id = node_info.module_id
+        case_id = node_info.case_id
+
+        # first attempt was in pytest_runtest_call
+        for current_attempt in range(2, attempt + 1):
+            self._reporter.set_module_status(module_id, TestStatus.RUN)
+            self._reporter.set_case_status(module_id, case_id, TestStatus.RUN)
+            self._reporter.set_case_attempt(module_id, case_id, current_attempt)
+            self._reporter.update_db_by_doc()
+
+            try:
+                item.runtest()
+                call.excinfo = None
+                self._reporter.set_case_status(module_id, case_id, TestStatus.PASSED)
+                break
+            except AssertionError:
+                self._reporter.set_case_status(module_id, case_id, TestStatus.FAILED)
+                if current_attempt == attempt:
+                    return
+
     # Reporting hooks
 
-    def pytest_runtest_logreport(self, report: TestReport):
+    def pytest_runtest_logreport(self, report: TestReport) -> bool | None:
         """Call after call of each test item."""
         if report.when != "call" and report.failed is False:
-            # ignore setup and teardown phase
-            # or continue processing setup and teardown failure (fixture exception handler)
+            # ignore setup and teardown phase or continue processing setup
+            # and teardown failure (fixture exception handler)
             return True
 
         module_id = Path(report.fspath).stem
@@ -243,11 +294,12 @@ class HardpyPlugin:
         assertion_msg = self._decode_assertion_msg(report.longrepr)
         self._reporter.set_assertion_msg(module_id, case_id, assertion_msg)
         self._reporter.set_progress(self._progress.calculate(report.nodeid))
-        self._results[module_id][case_id] = report.outcome  # noqa: WPS204
+        self._results[module_id][case_id] = report.outcome
 
         if None not in self._results[module_id].values():
             self._collect_module_result(module_id)
         self._reporter.update_db_by_doc()
+        return None
 
     # Fixture
 
@@ -265,10 +317,10 @@ class HardpyPlugin:
 
     # Not hooks
 
-    def _stop_handler(self, signum: int, frame: Any):
+    def _stop_handler(self, signum: int, frame: Any) -> None:  # noqa: ANN401, ARG002
         exit("Tests stopped by user")
 
-    def _init_case_result(self, module_id: str, case_id: str):
+    def _init_case_result(self, module_id: str, case_id: str) -> None:
         if self._results.get(module_id) is None:
             self._results[module_id] = {
                 "module_status": TestStatus.READY,
@@ -277,7 +329,7 @@ class HardpyPlugin:
         else:
             self._results[module_id][case_id] = None
 
-    def _collect_module_result(self, module_id: str):
+    def _collect_module_result(self, module_id: str) -> None:
         if TestStatus.ERROR in self._results[module_id].values():
             status = TestStatus.ERROR
         elif TestStatus.FAILED in self._results[module_id].values():
@@ -302,7 +354,7 @@ class HardpyPlugin:
             case _:
                 return TestStatus.ERROR
 
-    def _stop_tests(self):  # noqa: WPS231
+    def _stop_tests(self) -> None:
         """Update module and case statuses from READY or RUN to STOPPED."""
         for module_id, module_data in self._results.items():
             module_status = module_data["module_status"]
@@ -333,8 +385,8 @@ class HardpyPlugin:
 
     def _decode_assertion_msg(
         self,
-        error: (  # noqa: WPS320
-            ExceptionInfo[BaseException]  # noqa: DAR101,DAR201
+        error: (
+            ExceptionInfo[BaseException]
             | tuple[str, int, str]
             | str
             | TerminalRepr
@@ -348,57 +400,48 @@ class HardpyPlugin:
         match error:
             case str():
                 return error
-            case tuple() if len(error) == 3:
+            case tuple() if len(error) == 3:  # noqa: PLR2004
                 return error[2]
             case ExceptionInfo():
                 error_repr = error.getrepr()
                 if isinstance(error_repr, ReprExceptionInfo) and error_repr.reprcrash:
                     return error_repr.reprcrash.message
+                return None
             case TerminalRepr():
-                if isinstance(error, ExceptionRepr) and isinstance(  # noqa: WPS337
-                    error.reprcrash, ReprFileLocation
+                if isinstance(error, ExceptionRepr) and isinstance(
+                    error.reprcrash,
+                    ReprFileLocation,
                 ):
                     # remove ansi codes
                     ansi_pattern = re_compile(
-                        r"(?:\x1B[@-Z\\-_]|[\x80-\x9A\x9C-\x9F]|(?:\x1B\[|\x9B)[0-?]*[ -/]*[@-~])"  # noqa: E501
+                        r"(?:\x1B[@-Z\\-_]|[\x80-\x9A\x9C-\x9F]|(?:\x1B\[|\x9B)[0-?]*[ -/]*[@-~])",  # noqa: E501
                     )
                     return ansi_pattern.sub("", error.reprcrash.message)
                 return str(error)
             case _:
                 return None
 
-    def _handle_dependency(self, node_info: NodeInfo):
-        dependency = self._dependencies.get(
-            TestDependencyInfo(
-                node_info.module_id,
-                node_info.case_id,
-            )
+    def _is_skip_test(self, node_info: NodeInfo) -> bool:
+        """Is need to skip a test because it depends on another test."""
+        is_dependency_test_exist = self._dependencies.get(
+            TestDependencyInfo(node_info.module_id, node_info.case_id),
         )
-        if dependency and self._is_dependency_failed(dependency):
-            self._log.debug(f"Skipping test due to dependency: {dependency}")
-            self._results[node_info.module_id][node_info.case_id] = TestStatus.SKIPPED
-            self._reporter.set_progress(
-                self._progress.calculate(f"{node_info.module_id}::{node_info.case_id}")
-            )
-            skip(f"Test {node_info.module_id}::{node_info.case_id} is skipped")
-
-    def _is_dependency_failed(self, dependency) -> bool:
-        if isinstance(dependency, TestDependencyInfo):
-            incorrect_status = {
-                TestStatus.FAILED,
-                TestStatus.SKIPPED,
-                TestStatus.ERROR,
-            }
-            module_id, case_id = dependency
+        is_dependency_test_failed = False
+        if is_dependency_test_exist:
+            wrong_status = {TestStatus.FAILED, TestStatus.SKIPPED, TestStatus.ERROR}
+            module_id, case_id = is_dependency_test_exist
             if case_id is not None:
-                return self._results[module_id][case_id] in incorrect_status
-            return any(
-                status in incorrect_status
-                for status in set(self._results[module_id].values())
-            )
-        return False
-
-    def _add_dependency(self, node_info, nodes):
+                is_dependency_test_failed = (
+                    self._results[module_id][case_id] in wrong_status
+                )
+            else:
+                result_set = set(self._results[module_id].values())
+                is_dependency_test_failed = any(
+                    status in wrong_status for status in result_set
+                )
+        return bool(is_dependency_test_exist and is_dependency_test_failed)
+
+    def _add_dependency(self, node_info: NodeInfo, nodes: dict) -> None:
         dependency = node_info.dependency
         if dependency is None or dependency == "":
             return

hardpy/pytest_hardpy/pytest_call.py

@@ -1,29 +1,31 @@
 # Copyright (c) 2024 Everypin
 # GNU General Public License v3.0 (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+from __future__ import annotations
 
 import socket
-from os import environ
 from dataclasses import dataclass
-from typing import Optional, Any
+from os import environ
+from time import sleep
+from typing import Any
 from uuid import uuid4
 
 from pycouchdb.exceptions import NotFound
 from pydantic import ValidationError
 
 from hardpy.pytest_hardpy.db import (
-    DatabaseField as DF,
+    DatabaseField as DF,  # noqa: N817
     ResultRunStore,
     RunStore,
 )
+from hardpy.pytest_hardpy.reporter import RunnerReporter
 from hardpy.pytest_hardpy.utils import (
     ConnectionData,
-    DuplicateSerialNumberError,
+    DialogBox,
     DuplicatePartNumberError,
+    DuplicateSerialNumberError,
+    DuplicateTestStandLocationError,
     DuplicateTestStandNameError,
-    DuplicateDialogBoxError,
-    DialogBox,
 )
-from hardpy.pytest_hardpy.reporter import RunnerReporter
 
 
 @dataclass
@@ -42,7 +44,7 @@ def get_current_report() -> ResultRunStore | None:
     """
     runstore = RunStore()
     try:
-        return runstore.get_document()
+        return runstore.get_document()  # type: ignore
     except NotFound:
         return None
     except ValidationError:
@@ -51,7 +53,7 @@ def get_current_report() -> ResultRunStore | None:
         return None
 
 
-def set_dut_info(info: dict):
+def set_dut_info(info: dict) -> None:
     """Add DUT info to document.
 
     Args:
@@ -64,7 +66,7 @@ def set_dut_info(info: dict):
     reporter.update_db_by_doc()
 
 
-def set_dut_serial_number(serial_number: str):
+def set_dut_serial_number(serial_number: str) -> None:
     """Add DUT serial number to document.
 
     Args:
@@ -77,11 +79,14 @@ def set_dut_serial_number(serial_number: str):
     key = reporter.generate_key(DF.DUT, DF.SERIAL_NUMBER)
     if reporter.get_field(key):
         raise DuplicateSerialNumberError
-    reporter.set_doc_value(key, serial_number)
+    reporter.set_doc_value(
+        key,
+        serial_number if isinstance(serial_number, str) else str(serial_number),
+    )
     reporter.update_db_by_doc()
 
 
-def set_dut_part_number(part_number: str):
+def set_dut_part_number(part_number: str) -> None:
     """Add DUT part number to document.
 
     Args:
@@ -98,7 +103,7 @@ def set_dut_part_number(part_number: str):
     reporter.update_db_by_doc()
 
 
-def set_stand_name(name: str):
+def set_stand_name(name: str) -> None:
     """Add test stand name to document.
 
     Args:
@@ -115,7 +120,7 @@ def set_stand_name(name: str):
     reporter.update_db_by_doc()
 
 
-def set_stand_info(info: dict):
+def set_stand_info(info: dict) -> None:
     """Add test stand info to document.
 
     Args:
@@ -128,7 +133,21 @@ def set_stand_info(info: dict):
     reporter.update_db_by_doc()
 
 
-def set_message(msg: str, msg_key: Optional[str] = None) -> None:
+def set_stand_location(location: str) -> None:
+    """Add test stand location to document.
+
+    Args:
+        location (str): test stand location
+    """
+    reporter = RunnerReporter()
+    key = reporter.generate_key(DF.TEST_STAND, DF.LOCATION)
+    if reporter.get_field(key):
+        raise DuplicateTestStandLocationError
+    reporter.set_doc_value(key, location)
+    reporter.update_db_by_doc()
+
+
+def set_message(msg: str, msg_key: str | None = None) -> None:
     """Add or update message in current test.
 
     Args:
@@ -160,7 +179,7 @@ def set_message(msg: str, msg_key: Optional[str] = None) -> None:
     reporter.update_db_by_doc()
 
 
-def set_case_artifact(data: dict):
+def set_case_artifact(data: dict) -> None:
     """Add data to current test case.
 
     Artifact saves only in RunStore database
@@ -184,7 +203,7 @@ def set_case_artifact(data: dict):
     reporter.update_db_by_doc()
 
 
-def set_module_artifact(data: dict):
+def set_module_artifact(data: dict) -> None:
     """Add data to current test module.
 
     Artifact saves only in RunStore database
@@ -206,7 +225,7 @@ def set_module_artifact(data: dict):
     reporter.update_db_by_doc()
 
 
-def set_run_artifact(data: dict):
+def set_run_artifact(data: dict) -> None:
     """Add data to current test run.
 
     Artifact saves only in RunStore database
@@ -226,7 +245,7 @@ def set_run_artifact(data: dict):
 
 
 def set_driver_info(drivers: dict) -> None:
-    """Add or update drivers data.
+    """Add or update test stand drivers data.
 
     Driver data is stored in both StateStore and RunStore databases.
 
@@ -238,6 +257,7 @@ def set_driver_info(drivers: dict) -> None:
 
     for driver_name, driver_data in drivers.items():
         key = reporter.generate_key(
+            DF.TEST_STAND,
             DF.DRIVERS,
             driver_name,
         )
@@ -245,7 +265,7 @@ def set_driver_info(drivers: dict) -> None:
     reporter.update_db_by_doc()
 
 
-def run_dialog_box(dialog_box_data: DialogBox) -> Any:
+def run_dialog_box(dialog_box_data: DialogBox) -> Any:  # noqa: ANN401
     """Display a dialog box.
 
     Args:
@@ -257,6 +277,7 @@ def run_dialog_box(dialog_box_data: DialogBox) -> Any:
         - title_bar (str | None): The title bar of the dialog box.
           If the title_bar field is missing, it is the case name.
         - widget (DialogBoxWidget | None): Widget information.
+        - image (ImageComponent | None): Image information.
 
     Returns:
         Any: An object containing the user's response.
@@ -268,16 +289,14 @@ def run_dialog_box(dialog_box_data: DialogBox) -> Any:
         - NUMERIC_INPUT: float.
         - RADIOBUTTON: str.
         - CHECKBOX: list[str].
-        - IMAGE: bool.
         - MULTISTEP: bool.
 
     Raises:
         ValueError: If the 'message' argument is empty.
-        DuplicateDialogBoxError: If the dialog box is already caused.
     """
     if not dialog_box_data.dialog_text:
-        raise ValueError("The 'dialog_text' argument cannot be empty.")
-
+        msg = "The 'dialog_text' argument cannot be empty."
+        raise ValueError(msg)
     current_test = _get_current_test()
     reporter = RunnerReporter()
     key = reporter.generate_key(
@@ -287,13 +306,20 @@ def run_dialog_box(dialog_box_data: DialogBox) -> Any:
         current_test.case_id,
         DF.DIALOG_BOX,
     )
-    if reporter.get_field(key):
-        raise DuplicateDialogBoxError
+
+    reporter.set_doc_value(key, {}, statestore_only=True)
+    reporter.update_db_by_doc()
+    debounce_time = 0.2
+    sleep(debounce_time)
 
     reporter.set_doc_value(key, dialog_box_data.to_dict(), statestore_only=True)
     reporter.update_db_by_doc()
 
     input_dbx_data = _get_socket_raw_data()
+
+    # cleanup widget
+    reporter.set_doc_value(key, {}, statestore_only=True)
+    reporter.update_db_by_doc()
     return dialog_box_data.widget.convert_data(input_dbx_data)
 
 
@@ -308,9 +334,13 @@ def set_operator_message(msg: str, title: str | None = None) -> None:
         title (str | None): Title
     """
     reporter = RunnerReporter()
-    key = reporter.generate_key(
-        DF.OPERATOR_MSG,
-    )
+    key = reporter.generate_key(DF.OPERATOR_MSG)
+
+    reporter.set_doc_value(key, {}, statestore_only=True)
+    reporter.update_db_by_doc()
+    debounce_time = 0.2
+    sleep(debounce_time)
+
     msg_data = {"msg": msg, "title": title, "visible": True}
     reporter.set_doc_value(key, msg_data, statestore_only=True)
     reporter.update_db_by_doc()
@@ -319,12 +349,28 @@ def set_operator_message(msg: str, title: str | None = None) -> None:
     reporter.set_doc_value(key, msg_data, statestore_only=True)
     reporter.update_db_by_doc()
 
+    # cleanup widget
+    reporter.set_doc_value(key, {}, statestore_only=True)
+    reporter.update_db_by_doc()
+
+
+def get_current_attempt() -> int:
+    """Get current attempt.
+
+    Returns:
+        int: current attempt
+    """
+    reporter = RunnerReporter()
+    module_id, case_id = _get_current_test().module_id, _get_current_test().case_id
+    return reporter.get_current_attempt(module_id, case_id)
+
 
 def _get_current_test() -> CurrentTestInfo:
     current_node = environ.get("PYTEST_CURRENT_TEST")
 
     if current_node is None:
-        raise RuntimeError("PYTEST_CURRENT_TEST variable is not set")
+        msg = "PYTEST_CURRENT_TEST variable is not set"
+        raise RuntimeError(msg)
 
     module_delimiter = ".py::"
     module_id_end_index = current_node.find(module_delimiter)
@@ -351,8 +397,10 @@ def _get_socket_raw_data() -> str:
 
     try:
         server.bind((con_data.socket_host, con_data.socket_port))
-    except socket.error as exc:
-        raise RuntimeError(f"Error creating socket: {exc}")
+    except OSError as exc:
+        msg = "Socket creating error"
+        server.close()
+        raise RuntimeError(msg) from exc
     server.listen(1)
     client, _ = server.accept()