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

hardpy/pytest_hardpy/db/const.py

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

hardpy/pytest_hardpy/db/schema/v1.py

@@ -42,7 +42,10 @@ class CaseStateStore(IBaseResult):
               "text": "some text"
             },
             "type": "textinput"
-          }
+          },
+          visible: true,
+          id: "af6ac3e7-7ce8-4a6b-bb9d-88c3e10b5c7a",
+          font_size: 14
         }
       }
     }
@@ -214,6 +217,7 @@ class ResultStateStore(IBaseResult):
       "start_time": 1695817263,
       "status": "failed",
       "name": "hardpy-stand",
+      "alert": "",
       "dut": {
         "serial_number": "92c5a4bb-ecb0-42c5-89ac-e0caca0919fd",
         "part_number": "part_1",
@@ -241,7 +245,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 +271,10 @@ class ResultStateStore(IBaseResult):
                     "text": "some text"
                   },
                   "type": "textinput"
-                }
+                },
+                visible: true,
+                id: "f45bc1e7-2c18-4a4b-2b9d-8863e30bcc78",
+                font_size: 14
               }
             },
             "test_minute_parity": {
@@ -296,6 +304,7 @@ class ResultStateStore(IBaseResult):
     dut: Dut
     modules: dict[str, ModuleStateStore] = {}
     operator_msg: dict = {}
+    alert: str
 
 
 class ResultRunStore(IBaseResult):

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 (
@@ -30,6 +31,7 @@ from pytest import (
     skip,
 )
 
+from hardpy.common.stand_cloud.connector import StandCloudConnector, StandCloudError
 from hardpy.pytest_hardpy.reporter import HookReporter
 from hardpy.pytest_hardpy.utils import (
     ConnectionData,
@@ -39,6 +41,11 @@ from hardpy.pytest_hardpy.utils import (
 )
 from hardpy.pytest_hardpy.utils.node_info import TestDependencyInfo
 
+if __debug__:
+    from urllib3 import disable_warnings
+    from urllib3.exceptions import InsecureRequestWarning
+
+    disable_warnings(InsecureRequestWarning)
 
 def pytest_addoption(parser: Parser) -> None:
     """Register argparse-style options."""
@@ -73,6 +80,18 @@ def pytest_addoption(parser: Parser) -> None:
         default=False,
         help="enable pytest-hardpy plugin",
     )
+    parser.addoption(
+        "--sc-address",
+        action="store",
+        default=con_data.sc_address,
+        help="StandCloud address",
+    )
+    parser.addoption(
+        "--sc-connection-only",
+        action="store_true",
+        default=con_data.sc_connection_only,
+        help="check StandCloud availability",
+    )
 
 
 # Bootstrapping hooks
@@ -125,6 +144,14 @@ class HardpyPlugin:
         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
+
+        sc_connection_only = config.getoption("--sc-connection-only")
+        if sc_connection_only:
+            con_data.sc_connection_only = bool(sc_connection_only)  # type: ignore
+
         config.addinivalue_line("markers", "case_name")
         config.addinivalue_line("markers", "module_name")
         config.addinivalue_line("markers", "dependency")
@@ -201,6 +228,27 @@ class HardpyPlugin:
             # ignore collect only mode
             return True
 
+        con_data = ConnectionData()
+
+        if con_data.sc_connection_only:  # check
+            try:
+                sc_connector = StandCloudConnector(addr=con_data.sc_address)
+            except StandCloudError as exc:
+                msg = str(exc)
+                self._reporter.set_alert(msg)
+                exit(msg)
+            try:
+                sc_connector.healthcheck()
+            except Exception:  # noqa: BLE001
+                addr = con_data.sc_address
+                msg = (
+                    f"StandCloud service at the address {addr} "
+                    "not available or HardPy user is not authorized"
+                )
+                self._reporter.set_alert(msg)
+                self._reporter.update_db_by_doc()
+                exit(msg)
+
         # testrun entrypoint
         self._reporter.start()
         self._reporter.update_db_by_doc()
@@ -254,6 +302,9 @@ class HardpyPlugin:
 
         # 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)
@@ -330,9 +381,10 @@ class HardpyPlugin:
             self._results[module_id][case_id] = None
 
     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():
+        if (
+            TestStatus.FAILED in self._results[module_id].values()
+            or TestStatus.ERROR in self._results[module_id].values()
+        ):
             status = TestStatus.FAILED
         elif TestStatus.SKIPPED in self._results[module_id].values():
             status = TestStatus.SKIPPED
@@ -352,7 +404,7 @@ class HardpyPlugin:
                 self._stop_tests()
                 return TestStatus.STOPPED
             case _:
-                return TestStatus.ERROR
+                return TestStatus.FAILED
 
     def _stop_tests(self) -> None:
         """Update module and case statuses from READY or RUN to STOPPED."""

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,
 )
 
 
@@ -306,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:
@@ -391,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

@@ -47,6 +47,11 @@ class PyTestWrapper:
                     str(self.config.socket.port),
                     "--hardpy-sh",
                     self.config.socket.host,
+                    "--sc-address",
+                    self.config.stand_cloud.address,
+                    "--sc-connection-only"
+                    if self.config.stand_cloud.connection_only
+                    else "",
                     "--hardpy-pt",
                 ],
                 cwd=ConfigManager().get_tests_path(),
@@ -63,6 +68,11 @@ class PyTestWrapper:
                     str(self.config.socket.port),
                     "--hardpy-sh",
                     self.config.socket.host,
+                    "--sc-address",
+                    self.config.stand_cloud.address,
+                    "--sc-connection-only"
+                    if self.config.stand_cloud.connection_only
+                    else "",
                     "--hardpy-pt",
                 ],
                 cwd=ConfigManager().get_tests_path(),
@@ -134,10 +144,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/hook_reporter.py

@@ -37,6 +37,7 @@ class HookReporter(BaseReporter):
         self.set_doc_value(DF.PROGRESS, 0, statestore_only=True)
         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)
 
         test_stand_tz = self.generate_key(DF.TEST_STAND, DF.TIMEZONE)
         self.set_doc_value(test_stand_tz, str(get_localzone().key))
@@ -51,6 +52,7 @@ class HookReporter(BaseReporter):
         self.set_doc_value(DF.START_TIME, start_time)
         self.set_doc_value(DF.STATUS, TestStatus.RUN)
         self.set_doc_value(DF.PROGRESS, 0, statestore_only=True)
+        self.set_doc_value(DF.ALERT, "", statestore_only=True)
 
     def finish(self, status: TestStatus) -> None:
         """Finish test.
@@ -185,6 +187,14 @@ class HookReporter(BaseReporter):
         )
         self.set_doc_value(key, attempt, statestore_only=True)
 
+    def set_alert(self, alert: str) -> None:
+        """Set alert message.
+
+        Args:
+            alert (str): alert message
+        """
+        self.set_doc_value(DF.ALERT, alert, statestore_only=True)
+
     def update_node_order(self, nodes: dict) -> None:
         """Update node order.
 

hardpy/pytest_hardpy/result/__init__.py

@@ -2,9 +2,13 @@
 # GNU General Public License v3.0 (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
 
 from hardpy.pytest_hardpy.result.report_loader.couchdb_loader import CouchdbLoader
+from hardpy.pytest_hardpy.result.report_loader.stand_cloud_loader import (
+    StandCloudLoader,
+)
 from hardpy.pytest_hardpy.result.report_reader.couchdb_reader import CouchdbReader
 
 __all__ = [
     "CouchdbLoader",
     "CouchdbReader",
+    "StandCloudLoader",
 ]

hardpy/pytest_hardpy/result/report_loader/__init__.py

@@ -4,7 +4,11 @@
 from hardpy.pytest_hardpy.result.report_loader.couchdb_loader import (
     CouchdbLoader,
 )
+from hardpy.pytest_hardpy.result.report_loader.stand_cloud_loader import (
+    StandCloudLoader,
+)
 
 __all__ = [
     "CouchdbLoader",
+    "StandCloudLoader",
 ]

hardpy/pytest_hardpy/result/report_loader/stand_cloud_loader.py

@@ -0,0 +1,72 @@
+# 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
+
+from typing import TYPE_CHECKING
+
+from oauthlib.oauth2.rfc6749.errors import InvalidGrantError, TokenExpiredError
+from requests.exceptions import HTTPError
+from requests_oauth2client.tokens import ExpiredAccessToken
+
+from hardpy.common.stand_cloud.connector import StandCloudConnector, StandCloudError
+from hardpy.pytest_hardpy.utils import ConnectionData
+
+if TYPE_CHECKING:
+    from requests import Response
+
+    from hardpy.pytest_hardpy.db.schema import ResultRunStore
+
+
+class StandCloudLoader:
+    """StandCloud report generator."""
+
+    def __init__(self, address: str | None = None) -> None:
+        """Create StandCLoud loader.
+
+        Args:
+            address (str | None, optional): StandCloud address.
+                     Defaults to None (the value is taken from the.toml).
+                     Can be used outside of HardPy applications.
+        """
+        self._verify_ssl = not __debug__
+        connection_data = ConnectionData()
+        sc_addr = address if address else connection_data.sc_address
+        self._sc_connector = StandCloudConnector(sc_addr)
+
+    def load(self, report: ResultRunStore) -> Response:
+        """Load report to the StandCloud.
+
+        Args:
+            report (ResultRunStore): report
+
+        Returns:
+            Response: StandCloud load response, must be 201
+
+        Raises:
+            StandCloudError: if report not uploaded to StandCloud
+        """
+        api = self._sc_connector.get_api("api/test_run")
+
+        try:
+            resp = api.post(verify=self._verify_ssl, json=report.model_dump())
+        except ExpiredAccessToken as exc:
+            raise StandCloudError(str(exc))  # type: ignore
+        except TokenExpiredError as exc:
+            raise StandCloudError(exc.description)
+        except InvalidGrantError as exc:
+            raise StandCloudError(exc.description)
+        except HTTPError as exc:
+            return exc.response  # type: ignore
+
+        return resp
+
+    def healthcheck(self) -> Response:
+        """Healthcheck of StandCloud API.
+
+        Returns:
+            Response: StandCloud healthcheck response, must be 200
+
+        Raises:
+            StandCloudError: if StandCloud is unavailable
+        """
+        return self._sc_connector.healthcheck()

hardpy/pytest_hardpy/utils/connection_data.py

@@ -13,3 +13,5 @@ class ConnectionData(metaclass=SingletonMeta):
         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

@@ -9,6 +9,7 @@ from copy import deepcopy
 from dataclasses import dataclass
 from enum import Enum
 from typing import Any, Final
+from uuid import uuid4
 
 from hardpy.pytest_hardpy.utils.exception import ImageError, WidgetInfoError
 
@@ -315,6 +316,7 @@ class DialogBox:
         title_bar (str | None): title bar
         widget (IWidget | None): widget info
         image (ImageComponent | None): image
+        font_size (int): font size
     """
 
     def __init__(
@@ -323,11 +325,19 @@ class DialogBox:
         title_bar: str | None = None,
         widget: IWidget | None = None,
         image: ImageComponent | None = None,
+        font_size: int = 14,
     ) -> None:
         self.widget: IWidget = BaseWidget() if widget is None else widget
         self.image: ImageComponent | None = image
         self.dialog_text: str = dialog_text
         self.title_bar: str | None = title_bar
+        self.visible: bool = True
+        self.id = str(uuid4())
+        self.font_size = font_size
+
+        if font_size < 1:
+            msg = "The 'font_size' argument cannot be less than 1"
+            raise ValueError(msg)
 
     def to_dict(self) -> dict:
         """Convert DialogBox to dictionary.

{hardpy-0.8.0.dist-info → hardpy-0.10.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: hardpy
-Version: 0.8.0
+Version: 0.10.0
 Summary: HardPy library for device testing
 Project-URL: Homepage, https://github.com/everypinio/hardpy/
 Project-URL: Documentation, https://everypinio.github.io/hardpy/
@@ -18,6 +18,7 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Testing
 Classifier: Topic :: Software Development :: Testing :: Acceptance
@@ -25,11 +26,17 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.10
 Requires-Dist: fastapi>=0.100.1
 Requires-Dist: glom>=23.3.0
+Requires-Dist: jinja2<4,>=3
+Requires-Dist: keyring<26,>=25.0.0
 Requires-Dist: natsort>=8.4.0
+Requires-Dist: oauthlib<4,>=3.1.0
 Requires-Dist: py-machineid~=0.6.0
 Requires-Dist: pycouchdb<2,>=1.14.2
 Requires-Dist: pydantic<3,>=2.4.0
 Requires-Dist: pytest<9,>=7
+Requires-Dist: requests-oauth2client<2,>=1.5.0
+Requires-Dist: requests-oauthlib<3,>=2.0.0
+Requires-Dist: requests<3,>=2.30.0
 Requires-Dist: tomli-w<2,>=1.1.0
 Requires-Dist: tomli<3,>=2.0.1
 Requires-Dist: typer<1,>=0.12