hardpy 0.7.0__py3-none-any.whl → 0.8.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/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):
@@ -177,7 +177,7 @@ class TestStand(BaseModel):
         "info": {
           "geo": "Belgrade"
         },
-        "timezone": "CET",
+        "timezone": "Europe/Belgrade",
         "drivers": {
           "driver_1": "driver info",
           "driver_2": {
@@ -228,7 +228,7 @@ class ResultStateStore(IBaseResult):
         "info": {
           "geo": "Belgrade"
         },
-        "timezone": "CET",
+        "timezone": "Europe/Belgrade",
         "drivers": {
           "driver_1": "driver info",
           "driver_2": {
@@ -324,7 +324,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

@@ -25,7 +25,7 @@ from pytest import (
     Parser,
     Session,
     TestReport,
-    exit,
+    exit,  # noqa: A004
     fixture,
     skip,
 )
@@ -63,7 +63,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 +116,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 +132,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 +214,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 +244,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 +252,22 @@ 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):
+            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 +421,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

@@ -79,7 +79,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 +277,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 +289,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:

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],

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",
 ]

hardpy/pytest_hardpy/utils/dialog_box.py

@@ -10,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):
@@ -21,7 +21,6 @@ class WidgetType(Enum):
     NUMERIC_INPUT = "numericinput"
     RADIOBUTTON = "radiobutton"
     CHECKBOX = "checkbox"
-    IMAGE = "image"
     STEP = "step"
     MULTISTEP = "multistep"
 
@@ -49,8 +48,11 @@ class IWidget(ABC):
 class BaseWidget(IWidget):
     """Widget info interface."""
 
-    def __init__(self, widget_type: WidgetType = WidgetType.BASE) -> None:  # noqa: ARG002
-        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: ARG002
         """Get base widget data, i.e. None.
@@ -121,6 +123,9 @@ class RadiobuttonWidget(IWidget):
         if not fields:
             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:
@@ -151,6 +156,9 @@ class CheckboxWidget(IWidget):
         if not fields:
             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:
@@ -168,57 +176,13 @@ class CheckboxWidget(IWidget):
             return None
 
 
-class ImageWidget(IWidget):
-    """Image widget."""
-
-    def __init__(self, address: str, format: str = "image", width: int = 100) -> None:  # noqa: A002
-        """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:
-            msg = "Width must be positive"
-            raise WidgetInfoError(msg)
-
-        self.info["address"] = address
-        self.info["format"] = format
-        self.info["width"] = width
-
-        try:
-            with open(address, "rb") as file:  # noqa: PTH123
-                file_data = file.read()
-        except FileNotFoundError:
-            msg = "The image address is invalid"
-            raise WidgetInfoError(msg)  # noqa: B904
-        self.info["base64"] = base64.b64encode(file_data).decode("utf-8")
-
-    def convert_data(self, input_data: str | None = None) -> bool:  # noqa: ARG002
-        """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.
@@ -228,17 +192,17 @@ class StepWidget(IWidget):
         self,
         title: str,
         text: str | None,
-        widget: ImageWidget | None,
+        image: ImageComponent | None = None,
     ) -> None:
         super().__init__(WidgetType.STEP)
-        if text is None and widget is None:
-            msg = "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:  # noqa: ARG002
         """Get the step widget data in the correct format.
@@ -268,8 +232,14 @@ class MultistepWidget(IWidget):
         if not steps:
             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:  # noqa: ARG002
@@ -284,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.
@@ -292,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__(
@@ -299,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
 
@@ -312,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

@@ -42,3 +42,9 @@ class WidgetInfoError(HardpyError):
 
     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)