hardpy 0.3.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

hardpy/hardpy_panel/runner.py

@@ -21,6 +21,8 @@ def run():
     parser.add_argument("-dbh", "--db_host", type=str, default=config.db_host, help="database hostname")  # noqa: E501
     parser.add_argument("-wh", "--web_host", type=str, default=config.web_host, help="web operator panel hostname")  # noqa: E501
     parser.add_argument("-wp", "--web_port", type=str, default=config.web_port, help="web operator panel port")  # noqa: E501
+    parser.add_argument("-sp", "--sck_port", type=int, default=config.socket_port, help="internal socket port")  # noqa: E501
+    parser.add_argument("-sa", "--sck_addr", type=int, default=config.socket_port, help="internal socket address")  # noqa: E501
     parser.add_argument("path", type=str, nargs='?', help="path to test directory")
     # fmt: on
 

hardpy/pytest_hardpy/db/const.py

@@ -23,3 +23,4 @@ class DatabaseField(str, Enum):  # noqa: WPS600
     TEST_STAND = "test_stand"
     SERIAL_NUMBER = "serial_number"
     DRIVERS = "drivers"
+    DIALOG_BOX = "dialog_box"

hardpy/pytest_hardpy/db/schema.py

@@ -29,12 +29,23 @@ class CaseStateStore(IBaseResult):
         "start_time": 1695817188,
         "stop_time": 1695817189,
         "assertion_msg": null,
-        "msg": null
+        "msg": null,
+        "dialog_box": {
+          "title_bar": "Example of text input",
+          "dialog_text": "Type some text and press the Confirm button",
+          "widget": {
+            "info": {
+              "text": "some text"
+            },
+            "type": "textinput"
+          }
+        }
     }
     """
 
     assertion_msg: str | None = None
     msg: dict | None = None
+    dialog_box: dict = {}
 
 
 class CaseRunStore(IBaseResult):
@@ -175,7 +186,17 @@ class ResultStateStore(IBaseResult):
               "start_time": 1695817263,
               "stop_time": 1695817264,
               "assertion_msg": null,
-              "msg": null
+              "msg": null,
+              "dialog_box": {
+                "title_bar": "Example of text input",
+                "dialog_text": "Type some text and press the Confirm button",
+                "widget": {
+                  "info": {
+                    "text": "some text"
+                  },
+                  "type": "textinput"
+                }
+              }
             },
             "test_minute_parity": {
               "status": "failed",

hardpy/pytest_hardpy/plugin.py

@@ -6,6 +6,7 @@ from typing import Any, Callable
 from logging import getLogger
 from pathlib import Path, PurePath
 from platform import system
+from re import compile as re_compile
 
 from natsort import natsorted
 from pytest import (
@@ -19,6 +20,13 @@ from pytest import (
     fixture,
     ExitCode,
 )
+from _pytest._code.code import (
+    ExceptionRepr,
+    ReprFileLocation,
+    ExceptionInfo,
+    ReprExceptionInfo,
+    TerminalRepr,
+)
 
 from hardpy.pytest_hardpy.reporter import HookReporter
 from hardpy.pytest_hardpy.utils import (
@@ -40,6 +48,8 @@ def pytest_addoption(parser: Parser):
     parser.addoption("--hardpy-dbp", action="store", default=config_data.db_port, help="database port number")  # noqa: E501
     parser.addoption("--hardpy-dbh", action="store", default=config_data.db_host, help="database hostname")  # noqa: E501
     parser.addoption("--hardpy-pt", action="store_true", default=False, help="enable pytest-hardpy plugin")  # noqa: E501
+    parser.addoption("--hardpy-sp", action="store", default=config_data.socket_port, help="internal socket port")  # noqa: E501
+    parser.addoption("--hardpy-sa", action="store", default=config_data.socket_addr, help="internal socket address")  # noqa: E501
     # fmt: on
 
 
@@ -77,6 +87,8 @@ class HardpyPlugin(object):
         config_data.db_host = config.getoption("--hardpy-dbh")
         config_data.db_pswd = config.getoption("--hardpy-dbpw")
         config_data.db_port = config.getoption("--hardpy-dbp")
+        config_data.socket_port = int(config.getoption("--hardpy-sp"))
+        config_data.socket_addr = config.getoption("--hardpy-sa")
 
         config.addinivalue_line("markers", "case_name")
         config.addinivalue_line("markers", "module_name")
@@ -183,8 +195,9 @@ class HardpyPlugin(object):
 
     def pytest_runtest_logreport(self, report: TestReport):
         """Call after call of each test item."""
-        if report.when != "call":
+        if report.when != "call" and report.failed is False:
             # ignore setup and teardown phase
+            # or continue processing setup and teardown failure (fixture exception handler)
             return True
 
         module_id = Path(report.fspath).stem
@@ -200,7 +213,7 @@ class HardpyPlugin(object):
             case_id,
         )
 
-        assertion_msg = self._decode_assertion_msg(report.longreprtext)
+        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
@@ -261,15 +274,41 @@ class HardpyPlugin(object):
             case _:
                 return RunStatus.ERROR
 
-    def _decode_assertion_msg(self, msg: str) -> str | None:
-        assertion_str = "AssertionError: "
-
-        if assertion_str in msg:
-            index = msg.find(assertion_str)
-            report = msg[index + len(assertion_str) :]
-            index = report.find("\nE")
-            return report[:index]
-        return None
+    def _decode_assertion_msg(
+        self,
+        error: (  # noqa: WPS320
+            ExceptionInfo[BaseException]  # noqa: DAR101,DAR201
+            | tuple[str, int, str]
+            | str
+            | TerminalRepr
+            | None
+        ),
+    ) -> str | None:
+        """Parse pytest assertion error message."""
+        if error is None:
+            return None
+
+        match error:
+            case str():
+                return error
+            case tuple() if len(error) == 3:
+                return error[2]
+            case ExceptionInfo():
+                error_repr = error.getrepr()
+                if isinstance(error_repr, ReprExceptionInfo) and error_repr.reprcrash:
+                    return error_repr.reprcrash.message
+            case TerminalRepr():
+                if isinstance(error, ExceptionRepr) and isinstance(  # noqa: WPS337
+                    error.reprcrash, ReprFileLocation
+                ):
+                    # remove ansi codes
+                    ansi_pattern = re_compile(
+                        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(

hardpy/pytest_hardpy/pytest_call.py

@@ -1,9 +1,10 @@
 # Copyright (c) 2024 Everypin
 # GNU General Public License v3.0 (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
 
+import socket
 from os import environ
 from dataclasses import dataclass
-from typing import Optional
+from typing import Optional, Any
 from uuid import uuid4
 
 from pycouchdb.exceptions import NotFound
@@ -14,7 +15,12 @@ from hardpy.pytest_hardpy.db import (
     ResultRunStore,
     RunStore,
 )
-from hardpy.pytest_hardpy.utils import DuplicateSerialNumberError
+from hardpy.pytest_hardpy.utils import (
+    DuplicateSerialNumberError,
+    DuplicateDialogBoxError,
+    DialogBox,
+    ConfigData,
+)
 from hardpy.pytest_hardpy.reporter import RunnerReporter
 
 
@@ -184,7 +190,7 @@ def set_run_artifact(data: dict):
 
 
 def set_driver_info(drivers: dict) -> None:
-    """Adds or updates drivers data.
+    """Add or update drivers data.
 
     Driver data is stored in both StateStore and RunStore databases.
 
@@ -203,6 +209,58 @@ def set_driver_info(drivers: dict) -> None:
     reporter.update_db_by_doc()
 
 
+def run_dialog_box(dialog_box_data: DialogBox) -> Any:
+    """Display a dialog box.
+
+    Args:
+        dialog_box_data (DialogBox): Data for creating the dialog box.
+
+        DialogBox attributes:
+
+        - dialog_text (str): The text of the dialog box.
+        - 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.
+
+    Returns:
+        Any: An object containing the user's response.
+
+        The type of the return value depends on the widget type:
+
+        - BASE: bool.
+        - TEXT_INPUT: str.
+        - 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.")
+
+    current_test = _get_current_test()
+    reporter = RunnerReporter()
+    key = reporter.generate_key(
+        DF.MODULES,
+        current_test.module_id,
+        DF.CASES,
+        current_test.case_id,
+        DF.DIALOG_BOX,
+    )
+    if reporter.get_field(key):
+        raise DuplicateDialogBoxError
+
+    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()
+    return dialog_box_data.widget.convert_data(input_dbx_data)
+
+
 def _get_current_test() -> CurrentTestInfo:
     current_node = environ.get("PYTEST_CURRENT_TEST")
 
@@ -224,3 +282,26 @@ def _get_current_test() -> CurrentTestInfo:
     case_id = case_with_stage[:case_id_end_index]
 
     return CurrentTestInfo(module_id=module_id, case_id=case_id)
+
+
+def _get_socket_raw_data() -> str:
+    # create socket connection
+    server = socket.socket()
+    server.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+    config_data = ConfigData()
+    try:
+        server.bind((config_data.socket_addr, config_data.socket_port))
+    except socket.error as exc:
+        raise RuntimeError(f"Error creating socket: {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")
+
+    # close connection
+    client.close()
+    server.close()
+
+    return socket_data

hardpy/pytest_hardpy/pytest_wrapper.py

@@ -4,6 +4,7 @@
 import sys
 import signal
 import subprocess
+from socket import socket
 from platform import system
 
 from hardpy.pytest_hardpy.utils.config_data import ConfigData
@@ -46,6 +47,10 @@ class PyTestWrapper(object):
                     self.config.db_user,
                     "--hardpy-dbpw",
                     self.config.db_pswd,
+                    "--hardpy-sp",
+                    str(self.config.socket_port),
+                    "--hardpy-sa",
+                    self.config.socket_addr,
                     "--hardpy-pt",
                 ],
                 cwd=self.config.tests_dir.absolute(),
@@ -64,6 +69,10 @@ class PyTestWrapper(object):
                     self.config.db_user,
                     "--hardpy-dbpw",
                     self.config.db_pswd,
+                    "--hardpy-sp",
+                    str(self.config.socket_port),
+                    "--hardpy-sa",
+                    self.config.socket_addr,
                     "--hardpy-pt",
                 ],
                 cwd=self.config.tests_dir.absolute(),
@@ -115,6 +124,26 @@ class PyTestWrapper(object):
         )
         return True
 
+    def confirm_dialog_box(self, dialog_box_output: str):
+        """Set dialog box data to pytest subprocess.
+
+        Args:
+            dialog_box_output (str): dialog box output data
+
+        Returns:
+            bool: True if dialog box was confirmed, else False
+        """
+        config_data = ConfigData()
+
+        try:
+            client = socket()
+            client.connect((config_data.socket_addr, config_data.socket_port))
+            client.sendall(dialog_box_output.encode("utf-8"))
+            client.close()
+        except Exception:
+            return False
+        return True
+
     def is_running(self) -> bool | None:
         """Check if pytest is running."""
         return self._proc and self._proc.poll() is None

hardpy/pytest_hardpy/reporter/hook_reporter.py

@@ -90,8 +90,8 @@ class HookReporter(BaseReporter):
         item_statestore = self._statestore.get_field(key)
         item_runstore = self._runstore.get_field(key)
 
-        self._init_case(item_statestore, node_info)
-        self._init_case(item_runstore, node_info, is_use_artifact=True)
+        self._init_case(item_statestore, node_info, is_only_statestore=True)
+        self._init_case(item_runstore, node_info, is_only_runstore=True)
 
         self.set_doc_value(key, item_statestore, statestore_only=True)
         self.set_doc_value(key, item_runstore, runstore_only=True)
@@ -176,7 +176,11 @@ class HookReporter(BaseReporter):
             self.set_doc_value(key, int(time()))
 
     def _init_case(
-        self, item: dict, node_info: NodeInfo, is_use_artifact: bool = False
+        self,
+        item: dict,
+        node_info: NodeInfo,
+        is_only_runstore: bool = False,
+        is_only_statestore: bool = False,
     ):
         module_default = {  # noqa: WPS204
             DF.STATUS: TestStatus.READY,
@@ -195,7 +199,7 @@ class HookReporter(BaseReporter):
         }
 
         if item.get(node_info.module_id) is None:  # noqa: WPS204
-            if is_use_artifact:
+            if is_only_runstore:
                 module_default[DF.ARTIFACT] = {}
             item[node_info.module_id] = module_default  # noqa: WPS204
         else:
@@ -205,8 +209,11 @@ class HookReporter(BaseReporter):
             item[node_info.module_id][DF.STOP_TIME] = None
         item[node_info.module_id][DF.NAME] = self._get_module_name(node_info)
 
-        if is_use_artifact:
+        if is_only_runstore:
             case_default[DF.ARTIFACT] = {}
+
+        if is_only_statestore:
+            case_default[DF.DIALOG_BOX] = {}
         item[node_info.module_id][DF.CASES][node_info.case_id] = case_default
 
     def _remove_outdate_node(

hardpy/pytest_hardpy/utils/__init__.py

@@ -6,7 +6,22 @@ from hardpy.pytest_hardpy.utils.progress_calculator import ProgressCalculator
 from hardpy.pytest_hardpy.utils.const import TestStatus, RunStatus
 from hardpy.pytest_hardpy.utils.singleton import Singleton
 from hardpy.pytest_hardpy.utils.config_data import ConfigData
-from hardpy.pytest_hardpy.utils.exception import DuplicateSerialNumberError
+from hardpy.pytest_hardpy.utils.exception import (
+    DuplicateSerialNumberError,
+    DuplicateDialogBoxError,
+    WidgetInfoError,
+)
+from hardpy.pytest_hardpy.utils.dialog_box import (
+    DialogBox,
+    TextInputWidget,
+    NumericInputWidget,
+    CheckboxWidget,
+    RadiobuttonWidget,
+    ImageWidget,
+    MultistepWidget,
+    StepWidget,
+)
+
 
 __all__ = [
     "NodeInfo",
@@ -16,4 +31,14 @@ __all__ = [
     "Singleton",
     "ConfigData",
     "DuplicateSerialNumberError",
+    "DuplicateDialogBoxError",
+    "WidgetInfoError",
+    "DialogBox",
+    "TextInputWidget",
+    "NumericInputWidget",
+    "CheckboxWidget",
+    "RadiobuttonWidget",
+    "ImageWidget",
+    "MultistepWidget",
+    "StepWidget"
 ]

hardpy/pytest_hardpy/utils/config_data.py

@@ -1,9 +1,11 @@
 # Copyright (c) 2024 Everypin
 # GNU General Public License v3.0 (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
 
-from hardpy.pytest_hardpy.utils.singleton import Singleton
+from socket import gethostname
 from pathlib import Path
 
+from hardpy.pytest_hardpy.utils.singleton import Singleton
+
 
 class ConfigData(Singleton):
     """Web connection data storage."""
@@ -17,6 +19,8 @@ class ConfigData(Singleton):
             self.web_host: str = "0.0.0.0"
             self.web_port: int = 8000
             self.tests_dir = Path.cwd()
+            self.socket_port: int = 6525
+            self.socket_addr: str = gethostname()
             self._initialized = True
 
     @property