hardpy 0.10.1__py3-none-any.whl → 0.11.0__py3-none-any.whl

hardpy/pytest_hardpy/db/base_store.py

@@ -36,8 +36,8 @@ class BaseStore(BaseConnector):
         """
         return glom(self._doc, key)
 
-    def update_doc(self, key: str, value: Any) -> None:  # noqa: ANN401
-        """Update document.
+    def update_doc_value(self, key: str, value: Any) -> None:  # noqa: ANN401
+        """Update document value.
 
         HardPy collecting uses a simple key without dots.
         Assign is used to update a document.
@@ -60,6 +60,11 @@ class BaseStore(BaseConnector):
             self._doc["_rev"] = self._db.get(self._doc_id)["_rev"]
             self._doc = self._db.save(self._doc)
 
+    def update_doc(self) -> None:
+        """Update current document by database."""
+        self._doc["_rev"] = self._db.get(self._doc_id)["_rev"]
+        self._doc = self._db.get(self._doc_id)
+
     def get_document(self) -> ModelMetaclass:
         """Get document by schema.
 

hardpy/pytest_hardpy/db/const.py

@@ -32,6 +32,9 @@ class DatabaseField(str, Enum):
     TITLE = "title"
     VISIBLE = "visible"
     IMAGE = "image"
+    HTML = "html"
     ID = "id"
     FONT_SIZE = "font_size"
     ALERT = "alert"
+    OPERATOR_DATA = "operator_data"
+    DIALOG = "dialog"

hardpy/pytest_hardpy/db/schema/v1.py

@@ -204,6 +204,24 @@ class TestStand(BaseModel):
     location: str | None = None
 
 
+class OperatorData(BaseModel):
+    """Operator data from operator panel.
+
+    Example:
+    ```
+    {
+      "operator_data": {
+        "dialog": "hello",
+      }
+    }
+    ```
+    """
+
+    model_config = ConfigDict(extra="forbid")
+
+    dialog: str | None = None
+
+
 class ResultStateStore(IBaseResult):
     """Test run description.
 
@@ -218,6 +236,9 @@ class ResultStateStore(IBaseResult):
       "status": "failed",
       "name": "hardpy-stand",
       "alert": "",
+      "operator_data": {
+        "dialog": ""
+      },
       "dut": {
         "serial_number": "92c5a4bb-ecb0-42c5-89ac-e0caca0919fd",
         "part_number": "part_1",
@@ -305,6 +326,7 @@ class ResultStateStore(IBaseResult):
     modules: dict[str, ModuleStateStore] = {}
     operator_msg: dict = {}
     alert: str
+    operator_data: OperatorData
 
 
 class ResultRunStore(IBaseResult):

hardpy/pytest_hardpy/plugin.py

@@ -56,17 +56,17 @@ def pytest_addoption(parser: Parser) -> None:
         default=con_data.database_url,
         help="database url",
     )
+    # TODO (xorialexandrov): Remove --hardpy-sp and --hardpy-sh in HardPy major version.
+    # Addoptions left for compatibility with version 0.10.1 and below
     parser.addoption(
         "--hardpy-sp",
         action="store",
-        default=con_data.socket_port,
-        help="internal socket port",
+        help="DEPRECATED, UNUSED: internal socket port",
     )
     parser.addoption(
         "--hardpy-sh",
         action="store",
-        default=con_data.socket_host,
-        help="internal socket host",
+        help="DEPRECATED, UNUSED: internal socket host",
     )
     parser.addoption(
         "--hardpy-clear-database",
@@ -136,14 +136,6 @@ class HardpyPlugin:
 
         is_clear_database = config.getoption("--hardpy-clear-database")
 
-        socket_port = config.getoption("--hardpy-sp")
-        if socket_port:
-            con_data.socket_port = int(socket_port)  # type: ignore
-
-        socket_host = config.getoption("--hardpy-sh")
-        if socket_host:
-            con_data.socket_host = str(socket_host)  # type: ignore
-
         sc_address = config.getoption("--sc-address")
         if sc_address:
             con_data.sc_address = str(sc_address)  # type: ignore

hardpy/pytest_hardpy/pytest_call.py

@@ -2,10 +2,9 @@
 # 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 dataclasses import dataclass
 from os import environ
-from select import select
+from time import sleep
 from typing import Any
 from uuid import uuid4
 
@@ -19,12 +18,12 @@ from hardpy.pytest_hardpy.db import (
 )
 from hardpy.pytest_hardpy.reporter import RunnerReporter
 from hardpy.pytest_hardpy.utils import (
-    ConnectionData,
     DialogBox,
     DuplicatePartNumberError,
     DuplicateSerialNumberError,
     DuplicateTestStandLocationError,
     DuplicateTestStandNameError,
+    HTMLComponent,
     ImageComponent,
 )
 
@@ -279,6 +278,7 @@ def run_dialog_box(dialog_box_data: DialogBox) -> Any:  # noqa: ANN401
           If the title_bar field is missing, it is the case name.
         - widget (DialogBoxWidget | None): Widget information.
         - image (ImageComponent | None): Image information.
+        - html (HTMLComponent | None): HTML information.
 
     Returns:
         Any: An object containing the user's response.
@@ -312,18 +312,18 @@ def run_dialog_box(dialog_box_data: DialogBox) -> Any:  # noqa: ANN401
     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()
+    input_dbx_data = _get_operator_data()
 
     _cleanup_widget(reporter, key)
     return dialog_box_data.widget.convert_data(input_dbx_data)
 
 
-def set_operator_message(
+def set_operator_message(  # noqa: PLR0913
     msg: str,
     title: str | None = None,
     block: bool = True,
     image: ImageComponent | None = None,
+    html: HTMLComponent | None = None,
     font_size: int = 14,
 ) -> None:
     """Set operator message.
@@ -334,7 +334,8 @@ def set_operator_message(
     Args:
         msg (str): message
         title (str | None): title
-        image (ImageComponent | None): operator message info
+        image (ImageComponent | None): operator message image
+        html (HTMLComponent | None): operator message html page
         block (bool): if True, the function will block until the message is closed
         font_size (int): font size
     """
@@ -351,6 +352,7 @@ def set_operator_message(
         DF.TITLE: title,
         DF.VISIBLE: True,
         DF.IMAGE: image.to_dict() if image else None,
+        DF.HTML: html.to_dict() if html else None,
         DF.ID: str(uuid4()),
         DF.FONT_SIZE: int(font_size),
     }
@@ -358,10 +360,9 @@ def set_operator_message(
     reporter.update_db_by_doc()
 
     if block:
-        # get socket data
-        is_msg_visible = _get_socket_raw_data()
-
+        is_msg_visible = _get_operator_data()
         msg_data[DF.VISIBLE] = is_msg_visible
+
         reporter.set_doc_value(key, msg_data, statestore_only=True)
         reporter.update_db_by_doc()
 
@@ -414,37 +415,25 @@ def _get_current_test() -> CurrentTestInfo:
     return CurrentTestInfo(module_id=module_id, case_id=case_id)
 
 
-def _get_socket_raw_data() -> str:
-    # create socket connection
-    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()
-
-        return socket_data
+def _get_operator_data() -> str:
+    """Get operator panel data.
+
+    Returns:
+        str: operator panel data
+    """
+    reporter = RunnerReporter()
+
+    data = ""
+    key = reporter.generate_key(DF.OPERATOR_DATA, DF.DIALOG)
+    while not data:
+        reporter.update_doc_by_db()
+
+        data = reporter.get_field(key)
+        if data:
+            reporter.set_doc_value(key, "", statestore_only=True)
+            break
+        sleep(0.1)
+    return data
 
 
 def _cleanup_widget(reporter: RunnerReporter, key: str) -> None:

hardpy/pytest_hardpy/pytest_wrapper.py

@@ -6,9 +6,10 @@ import signal
 import subprocess
 import sys
 from platform import system
-from socket import socket
 
 from hardpy.common.config import ConfigManager
+from hardpy.pytest_hardpy.db import DatabaseField as DF  # noqa: N817
+from hardpy.pytest_hardpy.reporter import RunnerReporter
 
 
 class PyTestWrapper:
@@ -16,6 +17,7 @@ class PyTestWrapper:
 
     def __init__(self) -> None:
         self._proc = None
+        self._reporter = RunnerReporter()
         self.python_executable = sys.executable
 
         # Make sure test structure is stored in DB
@@ -43,10 +45,6 @@ class PyTestWrapper:
                     "pytest",
                     "--hardpy-db-url",
                     self.config.database.connection_url(),
-                    "--hardpy-sp",
-                    str(self.config.socket.port),
-                    "--hardpy-sh",
-                    self.config.socket.host,
                     "--sc-address",
                     self.config.stand_cloud.address,
                     "--sc-connection-only"
@@ -64,10 +62,6 @@ class PyTestWrapper:
                     "pytest",
                     "--hardpy-db-url",
                     self.config.database.connection_url(),
-                    "--hardpy-sp",
-                    str(self.config.socket.port),
-                    "--hardpy-sh",
-                    self.config.socket.host,
                     "--sc-address",
                     self.config.stand_cloud.address,
                     "--sc-connection-only"
@@ -117,10 +111,6 @@ class PyTestWrapper:
             "--collect-only",
             "--hardpy-db-url",
             self.config.database.connection_url(),
-            "--hardpy-sp",
-            str(self.config.socket.port),
-            "--hardpy-sh",
-            self.config.socket.host,
             "--hardpy-pt",
         ]
 
@@ -144,10 +134,10 @@ class PyTestWrapper:
             bool: True if dialog box was confirmed/closed, else False
         """
         try:
-            with socket() as client:
-                client.connect((self.config.socket.host, self.config.socket.port))
-                client.sendall(data.encode("utf-8"))
-                client.close()
+            self._reporter.update_doc_by_db()
+            key = self._reporter.generate_key(DF.OPERATOR_DATA, DF.DIALOG)
+            self._reporter.set_doc_value(key, data, statestore_only=True)
+            self._reporter.update_db_by_doc()
         except Exception:  # noqa: BLE001
             return False
         return True

hardpy/pytest_hardpy/reporter/base.py

@@ -45,19 +45,24 @@ class BaseReporter:
             msg = "Both runstore_only and statestore_only cannot be True"
             raise ValueError(msg)
         if runstore_only:
-            self._runstore.update_doc(key, value)
+            self._runstore.update_doc_value(key, value)
             return
         if statestore_only:
-            self._statestore.update_doc(key, value)
+            self._statestore.update_doc_value(key, value)
             return
-        self._runstore.update_doc(key, value)
-        self._statestore.update_doc(key, value)
+        self._runstore.update_doc_value(key, value)
+        self._statestore.update_doc_value(key, value)
 
     def update_db_by_doc(self) -> None:
         """Update database by current document."""
         self._statestore.update_db()
         self._runstore.update_db()
 
+    def update_doc_by_db(self) -> None:
+        """Update document by current database."""
+        self._statestore.update_doc()
+        self._runstore.update_doc()
+
     def generate_key(self, *args: Any) -> str:  # noqa: ANN401
         """Generate key for database.
 

hardpy/pytest_hardpy/reporter/hook_reporter.py

@@ -38,6 +38,7 @@ class HookReporter(BaseReporter):
         self.set_doc_value(DF.ARTIFACT, {}, runstore_only=True)
         self.set_doc_value(DF.OPERATOR_MSG, {}, statestore_only=True)
         self.set_doc_value(DF.ALERT, "", statestore_only=True)
+        self.set_doc_value(DF.OPERATOR_DATA, {}, statestore_only=True)
 
         test_stand_tz = self.generate_key(DF.TEST_STAND, DF.TIMEZONE)
         self.set_doc_value(test_stand_tz, str(get_localzone().key))
@@ -45,6 +46,9 @@ class HookReporter(BaseReporter):
         test_stand_id_key = self.generate_key(DF.TEST_STAND, DF.HW_ID)
         self.set_doc_value(test_stand_id_key, machine_id())
 
+        operator_data_key = self.generate_key(DF.OPERATOR_DATA, DF.DIALOG)
+        self.set_doc_value(operator_data_key, "", statestore_only=True)
+
     def start(self) -> None:
         """Start test."""
         self._log.debug("Starting test run.")
@@ -54,6 +58,9 @@ class HookReporter(BaseReporter):
         self.set_doc_value(DF.PROGRESS, 0, statestore_only=True)
         self.set_doc_value(DF.ALERT, "", statestore_only=True)
 
+        operator_data_key = self.generate_key(DF.OPERATOR_DATA, DF.DIALOG)
+        self.set_doc_value(operator_data_key, "", statestore_only=True)
+
     def finish(self, status: TestStatus) -> None:
         """Finish test.
 

hardpy/pytest_hardpy/utils/__init__.py

@@ -7,6 +7,7 @@ from hardpy.pytest_hardpy.utils.dialog_box import (
     BaseWidget,
     CheckboxWidget,
     DialogBox,
+    HTMLComponent,
     ImageComponent,
     MultistepWidget,
     NumericInputWidget,
@@ -36,6 +37,7 @@ __all__ = [
     "DuplicateSerialNumberError",
     "DuplicateTestStandLocationError",
     "DuplicateTestStandNameError",
+    "HTMLComponent",
     "ImageComponent",
     "ImageError",
     "MultistepWidget",

hardpy/pytest_hardpy/utils/connection_data.py

@@ -1,8 +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 socket import gethostname
-
 from hardpy.pytest_hardpy.utils.singleton import SingletonMeta
 
 
@@ -11,7 +9,5 @@ class ConnectionData(metaclass=SingletonMeta):
 
     def __init__(self) -> None:
         self.database_url: str = "http://dev:dev@localhost:5984/"
-        self.socket_host: str = gethostname()
-        self.socket_port: int = 6525
         self.sc_address: str = ""
         self.sc_connection_only: bool = False

hardpy/pytest_hardpy/utils/dialog_box.py

@@ -184,6 +184,7 @@ class StepWidget(IWidget):
         title (str): Step title
         text (str | None): Step text
         image (ImageComponent | None): Step image
+        html (HTMLComponent | None): Step html
 
     Raises:
         WidgetInfoError: If the text or widget are not provided.
@@ -194,16 +195,19 @@ class StepWidget(IWidget):
         title: str,
         text: str | None,
         image: ImageComponent | None = None,
+        html: HTMLComponent | None = None,
     ) -> None:
         super().__init__(WidgetType.STEP)
-        if text is None and image is None:
-            msg = "Text or image must be provided"
+        if text is None and image is None and html is None:
+            msg = "Text, image and html must be provided"
             raise WidgetInfoError(msg)
         self.info["title"] = title
         if isinstance(text, str):
             self.info["text"] = text
         if isinstance(image, ImageComponent):
             self.info["image"] = image.__dict__
+        if isinstance(html, HTMLComponent):
+            self.info["html"] = html.__dict__
 
     def convert_data(self, input_data: str) -> bool:  # noqa: ARG002
         """Get the step widget data in the correct format.
@@ -264,7 +268,7 @@ class ImageComponent:
         width: int = 100,
         border: int = 0,
     ) -> None:
-        """Validate the image fields and defines the base64 if it does not exist.
+        """Initialize the image component.
 
         Args:
             address (str): image address
@@ -272,7 +276,7 @@ class ImageComponent:
             border (int): image border
 
         Raises:
-            ImageError: If both address and base64data are specified.
+            ImageError: If both address and base64data are specified
         """
         if width < 1:
             msg = "Width must be positive"
@@ -297,7 +301,7 @@ class ImageComponent:
         """Convert ImageComponent to dictionary.
 
         Returns:
-            dict: ImageComponent dictionary.
+            dict: ImageComponent dictionary
         """
         return {
             "address": self.address,
@@ -307,6 +311,51 @@ class ImageComponent:
         }
 
 
+class HTMLComponent:
+    """HTML component."""
+
+    def __init__(
+        self,
+        html: str,
+        width: int = 100,
+        border: int = 0,
+        is_raw_html: bool = True,
+    ) -> None:
+        """Initialize the HTML component.
+
+        Args:
+            html (str): html string or URL
+            width (int): html component width
+            border (int): html component border
+            is_raw_html (bool): True if the html code is raw, else False
+        """
+        if width < 1:
+            msg = "Width must be positive"
+            raise WidgetInfoError(msg)
+
+        if border < 0:
+            msg = "Border must be non-negative"
+            raise WidgetInfoError(msg)
+
+        self.code_or_url = html
+        self.width = width
+        self.border = border
+        self.is_raw_html = is_raw_html
+
+    def to_dict(self) -> dict:
+        """Convert HtmlComponent to dictionary.
+
+        Returns:
+            dict: HtmlComponent dictionary.
+        """
+        return {
+            "code_or_url": self.code_or_url,
+            "width": self.width,
+            "border": self.border,
+            "is_raw_html": self.is_raw_html,
+        }
+
+
 @dataclass
 class DialogBox:
     """Dialog box data.
@@ -319,16 +368,18 @@ class DialogBox:
         font_size (int): font size
     """
 
-    def __init__(
+    def __init__(  # noqa: PLR0913
         self,
         dialog_text: str,
         title_bar: str | None = None,
         widget: IWidget | None = None,
         image: ImageComponent | None = None,
+        html: HTMLComponent | None = None,
         font_size: int = 14,
     ) -> None:
         self.widget: IWidget = BaseWidget() if widget is None else widget
         self.image: ImageComponent | None = image
+        self.html: HTMLComponent | None = html
         self.dialog_text: str = dialog_text
         self.title_bar: str | None = title_bar
         self.visible: bool = True
@@ -349,4 +400,6 @@ class DialogBox:
         dbx_dict["widget"] = deepcopy(self.widget.__dict__)
         if self.image:
             dbx_dict["image"] = deepcopy(self.image.__dict__)
+        if self.html:
+            dbx_dict["html"] = deepcopy(self.html.__dict__)
         return dbx_dict

hardpy/pytest_hardpy/utils/exception.py

@@ -43,6 +43,7 @@ class WidgetInfoError(HardpyError):
     def __init__(self, message: str) -> None:
         super().__init__(message)
 
+
 class ImageError(HardpyError):
     """The image info is not correct."""
 

{hardpy-0.10.1.dist-info → hardpy-0.11.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hardpy
-Version: 0.10.1
+Version: 0.11.0
 Summary: HardPy library for device testing
 Project-URL: Homepage, https://github.com/everypinio/hardpy/
 Project-URL: Documentation, https://everypinio.github.io/hardpy/