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

hardpy/pytest_hardpy/result/report_reader/couchdb_reader.py

@@ -1,17 +1,21 @@
 # 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 logging import getLogger
 from dataclasses import dataclass
-from typing import List, Optional
+from logging import getLogger
+from typing import TYPE_CHECKING
 
 from pycouchdb import Server as DbServer
-from pycouchdb.client import Database
 from pycouchdb.exceptions import NotFound
 
-from hardpy.pytest_hardpy.db import DatabaseField as DF
+from hardpy.pytest_hardpy.db import DatabaseField as DF  # noqa: N817
 from hardpy.pytest_hardpy.utils.const import TestStatus
-from hardpy.pytest_hardpy.result.couchdb_config import CouchdbConfig
+
+if TYPE_CHECKING:
+    from pycouchdb.client import Database
+
+    from hardpy.pytest_hardpy.result.couchdb_config import CouchdbConfig
 
 
 @dataclass
@@ -22,14 +26,14 @@ class ReportInfo:
     status: str
     start_time: str
     end_time: str
-    first_failed_test_name: Optional[str]
-    first_failed_test_id: Optional[str]
+    first_failed_test_name: str | None
+    first_failed_test_id: str | None
 
 
 class CouchdbReader:
     """CouchDB report info reader."""
 
-    def __init__(self, config: CouchdbConfig):
+    def __init__(self, config: CouchdbConfig) -> None:
         self._log = getLogger(__name__)
         self._config = config
         self._db_srv = DbServer(config.connection_string)
@@ -58,13 +62,14 @@ class CouchdbReader:
             int: number of reports
         """
         if start_time < 0 or end_time < 0:
-            raise ValueError("Start time and end time must be positive values")
+            msg = "Start time and end time must be positive values"
+            raise ValueError(msg)
         return sum(
             1
             for report in self._db.all()
             if self._is_in_timeframe(
-                self._get_start_time_from_db(report[self._doc_id]),
-                self._get_stop_time_from_db(report[self._doc_id]),
+                self._get_start_time_from_db(report[self._doc_id]),  # type: ignore
+                self._get_stop_time_from_db(report[self._doc_id]),  # type: ignore
                 start_time,
                 end_time,
             )
@@ -85,10 +90,11 @@ class CouchdbReader:
         doc = self._db.get(report_name)
         status = doc[DF.STATUS]
         if status not in {TestStatus.PASSED, TestStatus.FAILED, TestStatus.SKIPPED}:
-            raise ValueError("Invalid report status")
+            msg = "Invalid report status"
+            raise ValueError(msg)
         return status
 
-    def get_report_infos(self) -> List[ReportInfo]:
+    def get_report_infos(self) -> list[ReportInfo]:
         """Get a list of information about all reports in the database.
 
         Returns:
@@ -102,8 +108,10 @@ class CouchdbReader:
         return reports_info
 
     def get_report_infos_in_timeframe(
-        self, start_time: int, end_time: int
-    ) -> List[ReportInfo]:
+        self,
+        start_time: int,
+        end_time: int,
+    ) -> list[ReportInfo]:
         """Get a list of information about reports in a timeframe in the database.
 
         Args:
@@ -117,14 +125,15 @@ class CouchdbReader:
             List[ReportInfo]: list of report information
         """
         if start_time < 0 or end_time < 0:
-            raise ValueError("Start time and end time must be positive values")
+            msg = "Start time and end time must be positive values"
+            raise ValueError(msg)
 
         reports_info = []
         reports = self._db.all()
         for report in reports:
             start_t_db = self._get_start_time_from_db(report[self._doc_id])
             stop_t_db = self._get_stop_time_from_db(report[self._doc_id])
-            if self._is_in_timeframe(start_t_db, stop_t_db, start_time, end_time):
+            if self._is_in_timeframe(start_t_db, stop_t_db, start_time, end_time):  # type: ignore
                 report_info = self._get_single_report_info(report)
                 reports_info.append(report_info)
         return reports_info
@@ -134,7 +143,8 @@ class CouchdbReader:
             return self._db_srv.database(self._config.db_name)
         except NotFound as exc:
             self._log.error(f"Error initializing database: {exc}")
-            raise RuntimeError("Error initializing database") from exc
+            msg = "Error initializing database"
+            raise RuntimeError(msg) from exc
 
     def _get_start_time_from_db(self, doc: dict) -> str:
         return doc[DF.START_TIME]
@@ -146,7 +156,7 @@ class CouchdbReader:
         first_failed_test_name = None
         first_failed_test_id = None
         report_doc = report[self._doc_id]
-        for _module_name, module_info in report_doc[DF.MODULES].items():
+        for module_info in report_doc[DF.MODULES].values():
             for case_name, case_info in module_info[DF.CASES].items():
                 if case_info[DF.STATUS] == TestStatus.FAILED:
                     first_failed_test_name = case_info[DF.NAME]
@@ -160,5 +170,11 @@ class CouchdbReader:
             first_failed_test_id=first_failed_test_id,
         )
 
-    def _is_in_timeframe(self, start, end, timeframe_start, timeframe_end):
+    def _is_in_timeframe(
+        self,
+        start: int,
+        end: int,
+        timeframe_start: int,
+        timeframe_end: int,
+    ) -> bool:
         return timeframe_start <= start and end <= timeframe_end

hardpy/pytest_hardpy/utils/__init__.py

@@ -1,47 +1,52 @@
 # 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.node_info import NodeInfo
-from hardpy.pytest_hardpy.utils.progress_calculator import ProgressCalculator
-from hardpy.pytest_hardpy.utils.const import TestStatus
-from hardpy.pytest_hardpy.utils.singleton import Singleton
 from hardpy.pytest_hardpy.utils.connection_data import ConnectionData
-from hardpy.pytest_hardpy.utils.exception import (
-    DuplicateSerialNumberError,
-    DuplicatePartNumberError,
-    DuplicateTestStandNameError,
-    DuplicateDialogBoxError,
-    WidgetInfoError,
-)
+from hardpy.pytest_hardpy.utils.const import TestStatus
 from hardpy.pytest_hardpy.utils.dialog_box import (
+    BaseWidget,
+    CheckboxWidget,
     DialogBox,
-    TextInputWidget,
+    ImageComponent,
+    MultistepWidget,
     NumericInputWidget,
-    CheckboxWidget,
     RadiobuttonWidget,
-    ImageWidget,
-    MultistepWidget,
     StepWidget,
+    TextInputWidget,
 )
-
+from hardpy.pytest_hardpy.utils.exception import (
+    DuplicatePartNumberError,
+    DuplicateSerialNumberError,
+    DuplicateTestStandLocationError,
+    DuplicateTestStandNameError,
+    ImageError,
+    WidgetInfoError,
+)
+from hardpy.pytest_hardpy.utils.machineid import machine_id
+from hardpy.pytest_hardpy.utils.node_info import NodeInfo
+from hardpy.pytest_hardpy.utils.progress_calculator import ProgressCalculator
+from hardpy.pytest_hardpy.utils.singleton import SingletonMeta
 
 __all__ = [
-    "NodeInfo",
-    "ProgressCalculator",
-    "TestStatus",
-    "Singleton",
+    "BaseWidget",
+    "CheckboxWidget",
     "ConnectionData",
-    "DuplicateSerialNumberError",
+    "DialogBox",
     "DuplicatePartNumberError",
+    "DuplicateSerialNumberError",
+    "DuplicateTestStandLocationError",
     "DuplicateTestStandNameError",
-    "DuplicateDialogBoxError",
-    "WidgetInfoError",
-    "DialogBox",
-    "TextInputWidget",
+    "ImageComponent",
+    "ImageError",
+    "MultistepWidget",
+    "NodeInfo",
     "NumericInputWidget",
-    "CheckboxWidget",
+    "ProgressCalculator",
     "RadiobuttonWidget",
-    "ImageWidget",
-    "MultistepWidget",
-    "StepWidget"
+    "SingletonMeta",
+    "StepWidget",
+    "TestStatus",
+    "TextInputWidget",
+    "WidgetInfoError",
+    "machine_id",
 ]

hardpy/pytest_hardpy/utils/connection_data.py

@@ -3,15 +3,13 @@
 
 from socket import gethostname
 
-from hardpy.pytest_hardpy.utils.singleton import Singleton
+from hardpy.pytest_hardpy.utils.singleton import SingletonMeta
 
 
-class ConnectionData(Singleton):
+class ConnectionData(metaclass=SingletonMeta):
     """Connection data storage."""
 
-    def __init__(self):
-        if not self._initialized:
-            self.database_url: str = "http://dev:dev@localhost:5984/"
-            self.socket_host: str = gethostname()
-            self.socket_port: int = 6525
-            self._initialized = True
+    def __init__(self) -> None:
+        self.database_url: str = "http://dev:dev@localhost:5984/"
+        self.socket_host: str = gethostname()
+        self.socket_port: int = 6525

hardpy/pytest_hardpy/utils/const.py

@@ -4,7 +4,7 @@
 from enum import Enum
 
 
-class TestStatus(str, Enum):  # noqa: WPS600
+class TestStatus(str, Enum):
     """Pytest test status.
 
     Statuses, that can be returned by Pytest.

hardpy/pytest_hardpy/utils/dialog_box.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 base64
 from abc import ABC, abstractmethod
@@ -9,7 +10,7 @@ from dataclasses import dataclass
 from enum import Enum
 from typing import Any, Final
 
-from hardpy.pytest_hardpy.utils.exception import WidgetInfoError
+from hardpy.pytest_hardpy.utils.exception import ImageError, WidgetInfoError
 
 
 class WidgetType(Enum):
@@ -20,7 +21,6 @@ class WidgetType(Enum):
     NUMERIC_INPUT = "numericinput"
     RADIOBUTTON = "radiobutton"
     CHECKBOX = "checkbox"
-    IMAGE = "image"
     STEP = "step"
     MULTISTEP = "multistep"
 
@@ -28,12 +28,12 @@ class WidgetType(Enum):
 class IWidget(ABC):
     """Dialog box widget interface."""
 
-    def __init__(self, widget_type: WidgetType):
+    def __init__(self, widget_type: WidgetType) -> None:
         self.type: Final[str] = widget_type.value
         self.info: dict = {}
 
     @abstractmethod
-    def convert_data(self, input_data: str | None) -> Any | None:
+    def convert_data(self, input_data: str | None) -> Any | None:  # noqa: ANN401
         """Get the widget data in the correct format.
 
         Args:
@@ -48,10 +48,13 @@ class IWidget(ABC):
 class BaseWidget(IWidget):
     """Widget info interface."""
 
-    def __init__(self, widget_type: WidgetType = WidgetType.BASE):
-        super().__init__(WidgetType.BASE)
+    def __init__(
+        self,
+        widget_type: WidgetType = WidgetType.BASE,
+    ) -> None:
+        super().__init__(widget_type)
 
-    def convert_data(self, input_data: str | None = None) -> bool:  # noqa: WPS324
+    def convert_data(self, input_data: str | None = None) -> bool:  # noqa: ARG002
         """Get base widget data, i.e. None.
 
         Args:
@@ -66,7 +69,7 @@ class BaseWidget(IWidget):
 class TextInputWidget(IWidget):
     """Text input widget."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         """Initialize the TextInputWidget."""
         super().__init__(WidgetType.TEXT_INPUT)
 
@@ -85,7 +88,7 @@ class TextInputWidget(IWidget):
 class NumericInputWidget(IWidget):
     """Numeric input widget."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         """Initialize the NumericInputWidget."""
         super().__init__(WidgetType.NUMERIC_INPUT)
 
@@ -107,7 +110,7 @@ class NumericInputWidget(IWidget):
 class RadiobuttonWidget(IWidget):
     """Radiobutton widget."""
 
-    def __init__(self, fields: list[str]):
+    def __init__(self, fields: list[str]) -> None:
         """Initialize the RadiobuttonWidget.
 
         Args:
@@ -118,7 +121,11 @@ class RadiobuttonWidget(IWidget):
         """
         super().__init__(WidgetType.RADIOBUTTON)
         if not fields:
-            raise ValueError("RadiobuttonWidget must have at least one field")
+            msg = "RadiobuttonWidget must have at least one field"
+            raise ValueError(msg)
+        if len(fields) != len(set(fields)):
+            msg = "RadiobuttonWidget fields must be unique"
+            raise ValueError(msg)
         self.info["fields"] = fields
 
     def convert_data(self, input_data: str) -> str:
@@ -136,7 +143,7 @@ class RadiobuttonWidget(IWidget):
 class CheckboxWidget(IWidget):
     """Checkbox widget."""
 
-    def __init__(self, fields: list[str]):
+    def __init__(self, fields: list[str]) -> None:
         """Initialize the CheckboxWidget.
 
         Args:
@@ -147,7 +154,11 @@ class CheckboxWidget(IWidget):
         """
         super().__init__(WidgetType.CHECKBOX)
         if not fields:
-            raise ValueError("Checkbox must have at least one field")
+            msg = "Checkbox must have at least one field"
+            raise ValueError(msg)
+        if len(fields) != len(set(fields)):
+            msg = "CheckboxWidget fields must be unique"
+            raise ValueError(msg)
         self.info["fields"] = fields
 
     def convert_data(self, input_data: str) -> list[str] | None:
@@ -165,71 +176,35 @@ class CheckboxWidget(IWidget):
             return None
 
 
-class ImageWidget(IWidget):
-    """Image widget."""
-
-    def __init__(self, address: str, format: str = "image", width: int = 100):
-        """Validate the image fields and defines the base64 if it does not exist.
-
-        Args:
-            address (str): image address
-            format (str): image format
-            width (int): image width
-
-        Raises:
-            WidgetInfoError: If both address and base64 are specified.
-        """
-        super().__init__(WidgetType.IMAGE)
-
-        if width < 1:
-            raise WidgetInfoError("Width must be positive")
-
-        self.info["address"] = address
-        self.info["format"] = format
-        self.info["width"] = width
-
-        try:
-            with open(address, "rb") as file:
-                file_data = file.read()
-        except FileNotFoundError:
-            raise WidgetInfoError("The image address is invalid")
-        self.info["base64"] = base64.b64encode(file_data).decode("utf-8")
-
-    def convert_data(self, input_data: str | None = None) -> bool:
-        """Get the image widget data, i.e. None.
-
-        Args:
-            input_data (str | None): input string or nothing.
-
-        Returns:
-            bool: True if confirm button is pressed
-        """
-        return True
-
-
 class StepWidget(IWidget):
     """Step widget.
 
     Args:
         title (str): Step title
         text (str | None): Step text
-        widget (ImageWidget | None): Step widget
+        image (ImageComponent | None): Step image
 
     Raises:
         WidgetInfoError: If the text or widget are not provided.
     """
 
-    def __init__(self, title: str, text: str | None, widget: ImageWidget | None):
+    def __init__(
+        self,
+        title: str,
+        text: str | None,
+        image: ImageComponent | None = None,
+    ) -> None:
         super().__init__(WidgetType.STEP)
-        if text is None and widget is None:
-            raise WidgetInfoError("Text or widget must be provided")
+        if text is None and image is None:
+            msg = "Text or image must be provided"
+            raise WidgetInfoError(msg)
         self.info["title"] = title
         if isinstance(text, str):
             self.info["text"] = text
-        if isinstance(widget, ImageWidget):
-            self.info["widget"] = widget.__dict__
+        if isinstance(image, ImageComponent):
+            self.info["image"] = image.__dict__
 
-    def convert_data(self, input_data: str) -> bool:
+    def convert_data(self, input_data: str) -> bool:  # noqa: ARG002
         """Get the step widget data in the correct format.
 
         Args:
@@ -244,7 +219,7 @@ class StepWidget(IWidget):
 class MultistepWidget(IWidget):
     """Multistep widget."""
 
-    def __init__(self, steps: list[StepWidget]):
+    def __init__(self, steps: list[StepWidget]) -> None:
         """Initialize the MultistepWidget.
 
         Args:
@@ -255,12 +230,19 @@ class MultistepWidget(IWidget):
         """
         super().__init__(WidgetType.MULTISTEP)
         if not steps:
-            raise ValueError("MultistepWidget must have at least one step")
+            msg = "MultistepWidget must have at least one step"
+            raise ValueError(msg)
+        title_set = set()
         self.info["steps"] = []
         for step in steps:
+            title = step.info["title"]
+            if title in title_set:
+                msg = "MultistepWidget must have unique step titles"
+                raise ValueError(msg)
+            title_set.add(title)
             self.info["steps"].append(step.__dict__)
 
-    def convert_data(self, input_data: str) -> bool:
+    def convert_data(self, input_data: str) -> bool:  # noqa: ARG002
         """Get the multistep widget data in the correct format.
 
         Args:
@@ -272,6 +254,58 @@ class MultistepWidget(IWidget):
         return True
 
 
+class ImageComponent:
+    """Image component."""
+
+    def __init__(
+        self,
+        address: str,
+        width: int = 100,
+        border: int = 0,
+    ) -> None:
+        """Validate the image fields and defines the base64 if it does not exist.
+
+        Args:
+            address (str): image address
+            width (int): image width
+            border (int): image border
+
+        Raises:
+            ImageError: If both address and base64data are specified.
+        """
+        if width < 1:
+            msg = "Width must be positive"
+            raise WidgetInfoError(msg)
+
+        if border < 0:
+            msg = "Border must be non-negative"
+            raise WidgetInfoError(msg)
+
+        try:
+            with open(address, "rb") as file:  # noqa: PTH123
+                file_data = file.read()
+        except FileNotFoundError:
+            msg = "The image address is invalid"
+            raise ImageError(msg)  # noqa: B904
+        self.address = address
+        self.width = width
+        self.border = border
+        self.base64 = base64.b64encode(file_data).decode("utf-8")
+
+    def to_dict(self) -> dict:
+        """Convert ImageComponent to dictionary.
+
+        Returns:
+            dict: ImageComponent dictionary.
+        """
+        return {
+            "address": self.address,
+            "width": self.width,
+            "base64": self.base64,
+            "border": self.border,
+        }
+
+
 @dataclass
 class DialogBox:
     """Dialog box data.
@@ -280,6 +314,7 @@ class DialogBox:
         dialog_text (str): dialog text
         title_bar (str | None): title bar
         widget (IWidget | None): widget info
+        image (ImageComponent | None): image
     """
 
     def __init__(
@@ -287,8 +322,10 @@ class DialogBox:
         dialog_text: str,
         title_bar: str | None = None,
         widget: IWidget | None = None,
-    ):
+        image: ImageComponent | None = None,
+    ) -> 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
 
@@ -300,4 +337,6 @@ class DialogBox:
         """
         dbx_dict = deepcopy(self.__dict__)
         dbx_dict["widget"] = deepcopy(self.widget.__dict__)
+        if self.image:
+            dbx_dict["image"] = deepcopy(self.image.__dict__)
         return dbx_dict

hardpy/pytest_hardpy/utils/exception.py

@@ -5,40 +5,46 @@
 class HardpyError(Exception):
     """Base HardPy exception."""
 
-    def __init__(self, msg: str):
+    def __init__(self, msg: str) -> None:
         super().__init__(f"HardPy error: {msg}")
 
 
 class DuplicateSerialNumberError(HardpyError):
     """The serial number has already been determined."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__(self.__doc__)  # type: ignore
 
 
 class DuplicatePartNumberError(HardpyError):
     """The part number has already been determined."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__(self.__doc__)  # type: ignore
 
 
 class DuplicateTestStandNameError(HardpyError):
     """The test stand name has already been determined."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__(self.__doc__)  # type: ignore
 
 
-class DuplicateDialogBoxError(HardpyError):
-    """The dialog box has already been determined."""
+class DuplicateTestStandLocationError(HardpyError):
+    """The test stand location has already been determined."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__(self.__doc__)  # type: ignore
 
 
 class WidgetInfoError(HardpyError):
     """The widget info is not correct."""
 
-    def __init__(self, message):
+    def __init__(self, message: str) -> None:
+        super().__init__(message)
+
+class ImageError(HardpyError):
+    """The image info is not correct."""
+
+    def __init__(self, message: str) -> None:
         super().__init__(message)

hardpy/pytest_hardpy/utils/machineid.py

@@ -0,0 +1,15 @@
+from platform import node as platform_node
+
+import machineid
+
+
+def machine_id() -> str:
+    """Get machine id.
+
+    Returns:
+        str: id, if available, otherwise MAC address
+    """
+    try:
+        return machineid.id()
+    except machineid.MachineIdNotFound:
+        return platform_node()