hardpy 0.7.0__py3-none-any.whl → 0.9.0__py3-none-any.whl

hardpy/pytest_hardpy/db/__init__.py

@@ -12,6 +12,6 @@ __all__ = [
     "DatabaseField",
     "ResultRunStore",
     "ResultStateStore",
-    "StateStore",
     "RunStore",
+    "StateStore",
 ]

hardpy/pytest_hardpy/db/base_connector.py

@@ -3,7 +3,7 @@
 
 from pycouchdb.client import Database
 from pycouchdb.exceptions import Conflict, GenericError
-from requests.exceptions import ConnectionError
+from requests.exceptions import ConnectionError  # noqa: A004
 
 from hardpy.pytest_hardpy.db.base_server import BaseServer
 

hardpy/pytest_hardpy/db/base_store.py

@@ -69,6 +69,15 @@ class BaseStore(BaseConnector):
         self._doc = self._db.get(self._doc_id)
         return self._schema(**self._doc)
 
+    def clear(self) -> None:
+        """Clear database."""
+        try:
+            # Clear statestore and runstore databases before each launch
+            self._db.delete(self._doc_id)
+        except (Conflict, NotFound):
+            self._log.debug("Database will be created for the first time")
+        self._doc: dict = self._init_doc()
+
     def _init_doc(self) -> dict:
         try:
             doc = self._db.get(self._doc_id)

hardpy/pytest_hardpy/db/const.py

@@ -29,3 +29,8 @@ class DatabaseField(str, Enum):
     ATTEMPT = "attempt"
     LOCATION = "location"
     HW_ID = "hw_id"
+    TITLE = "title"
+    VISIBLE = "visible"
+    IMAGE = "image"
+    ID = "id"
+    FONT_SIZE = "font_size"

hardpy/pytest_hardpy/db/schema/v1.py

@@ -6,7 +6,7 @@ from typing import ClassVar
 
 from pydantic import BaseModel, ConfigDict, Field
 
-from hardpy.pytest_hardpy.utils import TestStatus as Status  # noqa: TCH001
+from hardpy.pytest_hardpy.utils import TestStatus as Status  # noqa: TC001
 
 
 class IBaseResult(BaseModel):
@@ -42,7 +42,10 @@ class CaseStateStore(IBaseResult):
               "text": "some text"
             },
             "type": "textinput"
-          }
+          },
+          visible: true,
+          id: "af6ac3e7-7ce8-4a6b-bb9d-88c3e10b5c7a",
+          font_size: 14
         }
       }
     }
@@ -177,7 +180,7 @@ class TestStand(BaseModel):
         "info": {
           "geo": "Belgrade"
         },
-        "timezone": "CET",
+        "timezone": "Europe/Belgrade",
         "drivers": {
           "driver_1": "driver info",
           "driver_2": {
@@ -228,7 +231,7 @@ class ResultStateStore(IBaseResult):
         "info": {
           "geo": "Belgrade"
         },
-        "timezone": "CET",
+        "timezone": "Europe/Belgrade",
         "drivers": {
           "driver_1": "driver info",
           "driver_2": {
@@ -241,7 +244,8 @@ class ResultStateStore(IBaseResult):
       "operator_msg": {
         "msg": "Operator message",
         "title": "Message",
-        "visible": "True"
+        "visible": true,
+        "id": "f45ac1e7-2ce8-4a6b-bb9d-8863e30bcc78"
       },
       "modules": {
         "test_1_a": {
@@ -266,7 +270,10 @@ class ResultStateStore(IBaseResult):
                     "text": "some text"
                   },
                   "type": "textinput"
-                }
+                },
+                visible: true,
+                id: "f45bc1e7-2c18-4a4b-2b9d-8863e30bcc78",
+                font_size: 14
               }
             },
             "test_minute_parity": {
@@ -324,7 +331,7 @@ class ResultRunStore(IBaseResult):
         "info": {
           "geo": "Belgrade"
         },
-        "timezone": "CET",
+        "timezone": "Europe/Belgrade",
         "drivers": {
           "driver_1": "driver info",
           "driver_2": {

hardpy/pytest_hardpy/db/statestore.py

@@ -3,8 +3,6 @@
 
 from logging import getLogger
 
-from pycouchdb.exceptions import Conflict, NotFound
-
 from hardpy.pytest_hardpy.db.base_store import BaseStore
 from hardpy.pytest_hardpy.db.schema import ResultStateStore
 from hardpy.pytest_hardpy.utils import SingletonMeta
@@ -17,12 +15,3 @@ class StateStore(BaseStore, metaclass=SingletonMeta):
         super().__init__("statestore")
         self._log = getLogger(__name__)
         self._schema = ResultStateStore
-
-    def clear(self) -> None:
-        """Clear database."""
-        try:
-            # Clear the statestore database before each launch
-            self._db.delete(self._doc_id)
-        except (Conflict, NotFound):
-            self._log.debug("Statestore database will be created for the first time")
-        self._doc: dict = self._init_doc()

hardpy/pytest_hardpy/plugin.py

@@ -7,6 +7,7 @@ from logging import getLogger
 from pathlib import Path, PurePath
 from platform import system
 from re import compile as re_compile
+from time import sleep
 from typing import Any, Callable
 
 from _pytest._code.code import (
@@ -25,7 +26,7 @@ from pytest import (
     Parser,
     Session,
     TestReport,
-    exit,
+    exit,  # noqa: A004
     fixture,
     skip,
 )
@@ -63,7 +64,7 @@ def pytest_addoption(parser: Parser) -> None:
     )
     parser.addoption(
         "--hardpy-clear-database",
-        action="store",
+        action="store_true",
         default=False,
         help="clear hardpy local database",
     )
@@ -116,7 +117,6 @@ class HardpyPlugin:
             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:
@@ -133,7 +133,7 @@ class HardpyPlugin:
 
         # 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)
 
@@ -215,21 +215,24 @@ 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(
-            node_info.module_id,
-            node_info.case_id,
-        )
+        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)
@@ -242,7 +245,7 @@ class HardpyPlugin:
 
     def pytest_runtest_makereport(self, item: Item, call: CallInfo) -> None:
         """Call after call of each test item."""
-        if call.when != "call":
+        if call.when != "call" or not call.excinfo:
             return
 
         node_info = NodeInfo(item)
@@ -250,25 +253,25 @@ class HardpyPlugin:
         module_id = node_info.module_id
         case_id = node_info.case_id
 
-        if call.excinfo:
-            # 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()
-
-                # fmt: off
-                try:
-                    item.runtest()
-                    call.excinfo = None
-                    self._reporter.set_case_status(module_id, case_id, TestStatus.PASSED)  # noqa: E501
-                    break
-                except AssertionError:
-                    self._reporter.set_case_status(module_id, case_id, TestStatus.FAILED)  # noqa: E501
-                    if current_attempt == attempt:
-                        return
-                # fmt: on
+        # first attempt was in pytest_runtest_call
+        for current_attempt in range(2, attempt + 1):
+            # add pause between attempts to verify STOP condition
+            sleep(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
 
@@ -422,36 +425,25 @@ class HardpyPlugin:
             case _:
                 return None
 
-    def _handle_dependency(self, node_info: NodeInfo) -> None:
-        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: TestDependencyInfo) -> 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
+                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

hardpy/pytest_hardpy/pytest_call.py

@@ -5,7 +5,7 @@ from __future__ import annotations
 import socket
 from dataclasses import dataclass
 from os import environ
-from time import sleep
+from select import select
 from typing import Any
 from uuid import uuid4
 
@@ -25,6 +25,7 @@ from hardpy.pytest_hardpy.utils import (
     DuplicateSerialNumberError,
     DuplicateTestStandLocationError,
     DuplicateTestStandNameError,
+    ImageComponent,
 )
 
 
@@ -79,7 +80,10 @@ def set_dut_serial_number(serial_number: str) -> None:
     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()
 
 
@@ -274,6 +278,7 @@ def run_dialog_box(dialog_box_data: DialogBox) -> Any:  # noqa: ANN401
         - 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.
@@ -285,7 +290,6 @@ def run_dialog_box(dialog_box_data: DialogBox) -> Any:  # noqa: ANN401
         - NUMERIC_INPUT: float.
         - RADIOBUTTON: str.
         - CHECKBOX: list[str].
-        - IMAGE: bool.
         - MULTISTEP: bool.
 
     Raises:
@@ -303,52 +307,76 @@ def run_dialog_box(dialog_box_data: DialogBox) -> Any:  # noqa: ANN401
         current_test.case_id,
         DF.DIALOG_BOX,
     )
-
-    reporter.set_doc_value(key, {}, statestore_only=True)
-    reporter.update_db_by_doc()
-    debounce_time = 0.2
-    sleep(debounce_time)
+    _cleanup_widget(reporter, key)
 
     reporter.set_doc_value(key, dialog_box_data.to_dict(), statestore_only=True)
     reporter.update_db_by_doc()
 
+    # get socket data
     input_dbx_data = _get_socket_raw_data()
 
-    # cleanup widget
-    reporter.set_doc_value(key, {}, statestore_only=True)
-    reporter.update_db_by_doc()
+    _cleanup_widget(reporter, key)
     return dialog_box_data.widget.convert_data(input_dbx_data)
 
 
-def set_operator_message(msg: str, title: str | None = None) -> None:
+def set_operator_message(
+    msg: str,
+    title: str | None = None,
+    block: bool = True,
+    image: ImageComponent | None = None,
+    font_size: int = 14,
+) -> None:
     """Set operator message.
 
     The function should be used to handle events outside of testing.
     For messages to the operator during testing, there is the function `run_dialog_box`.
 
     Args:
-        msg (str): Message
-        title (str | None): Title
+        msg (str): message
+        title (str | None): title
+        image (ImageComponent | None): operator message info
+        block (bool): if True, the function will block until the message is closed
+        font_size (int): font size
     """
     reporter = RunnerReporter()
     key = reporter.generate_key(DF.OPERATOR_MSG)
+    _cleanup_widget(reporter, key)
 
-    reporter.set_doc_value(key, {}, statestore_only=True)
-    reporter.update_db_by_doc()
-    debounce_time = 0.2
-    sleep(debounce_time)
+    if font_size < 1:
+        msg = "The 'font_size' argument cannot be less than 1"
+        raise ValueError(msg)
 
-    msg_data = {"msg": msg, "title": title, "visible": True}
-    reporter.set_doc_value(key, msg_data, statestore_only=True)
-    reporter.update_db_by_doc()
-    is_msg_visible = _get_socket_raw_data()
-    msg_data["visible"] = is_msg_visible
+    msg_data = {
+        DF.MSG: msg,
+        DF.TITLE: title,
+        DF.VISIBLE: True,
+        DF.IMAGE: image.to_dict() if image else None,
+        DF.ID: str(uuid4()),
+        DF.FONT_SIZE: int(font_size),
+    }
     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()
+    if block:
+        # get socket data
+        is_msg_visible = _get_socket_raw_data()
+
+        msg_data[DF.VISIBLE] = is_msg_visible
+        reporter.set_doc_value(key, msg_data, statestore_only=True)
+        reporter.update_db_by_doc()
+
+        _cleanup_widget(reporter, key)
+
+
+def clear_operator_message() -> None:
+    """Clear operator message.
+
+    Clears the current message to the operator if it exists, otherwise does nothing.
+    """
+    reporter = RunnerReporter()
+    key = reporter.generate_key(DF.OPERATOR_MSG)
+
+    _cleanup_widget(reporter, key)
 
 
 def get_current_attempt() -> int:
@@ -388,25 +416,37 @@ def _get_current_test() -> CurrentTestInfo:
 
 def _get_socket_raw_data() -> str:
     # create socket connection
-    server = socket.socket()
-    server.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
-    con_data = ConnectionData()
-
-    try:
-        server.bind((con_data.socket_host, con_data.socket_port))
-    except OSError as exc:
-        msg = "Socket creating error"
+    with socket.socket() as server:
+        server.setblocking(False)
+        server.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+
+        con_data = ConnectionData()
+        try:
+            server.bind((con_data.socket_host, con_data.socket_port))
+        except OSError as exc:
+            msg = "Socket creating error"
+            server.close()
+            raise RuntimeError(msg) from exc
+        server.listen(1)
+
+        client = None
+        while True:
+            ready_to_read, _, _ = select([server], [], [], 0.5)
+            if ready_to_read:
+                client, _ = server.accept()
+                break
+
+        # receive data
+        max_input_data_len = 1024
+        socket_data = client.recv(max_input_data_len).decode("utf-8")
+
+        # close connection
+        client.close()
         server.close()
-        raise RuntimeError(msg) from exc
-    server.listen(1)
-    client, _ = server.accept()
 
-    # receive data
-    max_input_data_len = 1024
-    socket_data = client.recv(max_input_data_len).decode("utf-8")
+        return socket_data
 
-    # close connection
-    client.close()
-    server.close()
 
-    return socket_data
+def _cleanup_widget(reporter: RunnerReporter, key: str) -> None:
+    reporter.set_doc_value(key, {}, statestore_only=True)
+    reporter.update_db_by_doc()

hardpy/pytest_hardpy/pytest_wrapper.py

@@ -116,7 +116,6 @@ class PyTestWrapper:
 
         if is_clear_database:
             args.append("--hardpy-clear-database")
-            args.append(str(is_clear_database))
 
         subprocess.Popen(  # noqa: S603
             [self.python_executable, *args],
@@ -135,10 +134,10 @@ class PyTestWrapper:
             bool: True if dialog box was confirmed/closed, else False
         """
         try:
-            client = socket()
-            client.connect((self.config.socket.host, self.config.socket.port))
-            client.sendall(data.encode("utf-8"))
-            client.close()
+            with socket() as client:
+                client.connect((self.config.socket.host, self.config.socket.port))
+                client.sendall(data.encode("utf-8"))
+                client.close()
         except Exception:  # noqa: BLE001
             return False
         return True

hardpy/pytest_hardpy/reporter/__init__.py

@@ -5,6 +5,6 @@ from hardpy.pytest_hardpy.reporter.hook_reporter import HookReporter
 from hardpy.pytest_hardpy.reporter.runner_reporter import RunnerReporter
 
 __all__ = [
-    "RunnerReporter",
     "HookReporter",
+    "RunnerReporter",
 ]

hardpy/pytest_hardpy/reporter/hook_reporter.py

@@ -3,11 +3,11 @@
 from __future__ import annotations
 
 from copy import deepcopy
-from datetime import datetime
 from logging import getLogger
 from time import time
 
 from natsort import natsorted
+from tzlocal import get_localzone
 
 from hardpy.pytest_hardpy.db import DatabaseField as DF  # noqa: N817
 from hardpy.pytest_hardpy.reporter.base import BaseReporter
@@ -21,6 +21,7 @@ class HookReporter(BaseReporter):
         super().__init__()
         if is_clear_database:
             self._statestore.clear()
+            self._runstore.clear()
         self._log = getLogger(__name__)
 
     def init_doc(self, doc_name: str) -> None:
@@ -38,7 +39,7 @@ class HookReporter(BaseReporter):
         self.set_doc_value(DF.OPERATOR_MSG, {}, statestore_only=True)
 
         test_stand_tz = self.generate_key(DF.TEST_STAND, DF.TIMEZONE)
-        self.set_doc_value(test_stand_tz, datetime.now().astimezone().tzname())
+        self.set_doc_value(test_stand_tz, str(get_localzone().key))
 
         test_stand_id_key = self.generate_key(DF.TEST_STAND, DF.HW_ID)
         self.set_doc_value(test_stand_id_key, machine_id())

hardpy/pytest_hardpy/result/__init__.py

@@ -5,6 +5,6 @@ from hardpy.pytest_hardpy.result.report_loader.couchdb_loader import CouchdbLoad
 from hardpy.pytest_hardpy.result.report_reader.couchdb_reader import CouchdbReader
 
 __all__ = [
-    "CouchdbReader",
     "CouchdbLoader",
+    "CouchdbReader",
 ]

hardpy/pytest_hardpy/utils/__init__.py

@@ -4,9 +4,10 @@
 from hardpy.pytest_hardpy.utils.connection_data import ConnectionData
 from hardpy.pytest_hardpy.utils.const import TestStatus
 from hardpy.pytest_hardpy.utils.dialog_box import (
+    BaseWidget,
     CheckboxWidget,
     DialogBox,
-    ImageWidget,
+    ImageComponent,
     MultistepWidget,
     NumericInputWidget,
     RadiobuttonWidget,
@@ -18,6 +19,7 @@ from hardpy.pytest_hardpy.utils.exception import (
     DuplicateSerialNumberError,
     DuplicateTestStandLocationError,
     DuplicateTestStandNameError,
+    ImageError,
     WidgetInfoError,
 )
 from hardpy.pytest_hardpy.utils.machineid import machine_id
@@ -26,23 +28,25 @@ from hardpy.pytest_hardpy.utils.progress_calculator import ProgressCalculator
 from hardpy.pytest_hardpy.utils.singleton import SingletonMeta
 
 __all__ = [
-    "NodeInfo",
-    "ProgressCalculator",
-    "TestStatus",
-    "SingletonMeta",
+    "BaseWidget",
+    "CheckboxWidget",
     "ConnectionData",
-    "DuplicateSerialNumberError",
+    "DialogBox",
     "DuplicatePartNumberError",
+    "DuplicateSerialNumberError",
     "DuplicateTestStandLocationError",
     "DuplicateTestStandNameError",
-    "WidgetInfoError",
-    "DialogBox",
-    "TextInputWidget",
+    "ImageComponent",
+    "ImageError",
+    "MultistepWidget",
+    "NodeInfo",
     "NumericInputWidget",
-    "CheckboxWidget",
+    "ProgressCalculator",
     "RadiobuttonWidget",
-    "ImageWidget",
-    "MultistepWidget",
+    "SingletonMeta",
     "StepWidget",
+    "TestStatus",
+    "TextInputWidget",
+    "WidgetInfoError",
     "machine_id",
 ]