hardpy 0.13.0__py3-none-any.whl → 0.15.0__py3-none-any.whl

hardpy/pytest_hardpy/pytest_call.py

@@ -6,7 +6,7 @@ from dataclasses import dataclass
 from inspect import stack
 from os import environ
 from time import sleep
-from typing import Any
+from typing import TYPE_CHECKING, Any
 from uuid import uuid4
 
 from pycouchdb.exceptions import NotFound
@@ -19,17 +19,22 @@ from hardpy.pytest_hardpy.db import (
 )
 from hardpy.pytest_hardpy.reporter import RunnerReporter
 from hardpy.pytest_hardpy.utils import (
+    Chart,
     DialogBox,
-    DuplicatePartNumberError,
-    DuplicateSerialNumberError,
-    DuplicateTestStandLocationError,
-    DuplicateTestStandNameError,
-    DuplicateTestStandNumberError,
+    DuplicateParameterError,
     HTMLComponent,
     ImageComponent,
+    Instrument,
+    NumericMeasurement,
+    StringMeasurement,
+    SubUnit,
     TestStandNumberError,
 )
 
+if TYPE_CHECKING:
+    from collections.abc import Mapping
+    from datetime import datetime
+
 
 @dataclass
 class CurrentTestInfo:
@@ -39,6 +44,42 @@ class CurrentTestInfo:
     case_id: str
 
 
+class ErrorCodeMeta(type):
+    """Error code metaclass."""
+
+    def __call__(cls, code: int, message: str | None = None) -> str | None:
+        """Add error code to document.
+
+        Args:
+            code (int): non-negative error code.
+            message (str | None): error message.
+
+        Returns:
+            str | None: error message
+        """
+        if code < 0:
+            msg = "error code must be greater than 0"
+            raise ValueError(msg)
+        reporter = RunnerReporter()
+        key = reporter.generate_key(DF.ERROR_CODE)
+        if reporter.get_field(key) is None:
+            reporter.set_doc_value(key, code)
+            reporter.update_db_by_doc()
+        if message:  # noqa: RET503
+            return message
+
+
+class ErrorCode(metaclass=ErrorCodeMeta):
+    """Save error code and return error message.
+
+    It must be called from an assert.
+
+    Args:
+        code (int): error code.
+        message (str): error message.
+    """
+
+
 def get_current_report() -> ResultRunStore | None:
     """Get current report from runstore database.
 
@@ -56,11 +97,68 @@ def get_current_report() -> ResultRunStore | None:
         return None
 
 
-def set_dut_info(info: dict) -> None:
-    """Add DUT info to document.
+def set_user_name(name: str) -> None:
+    """Set operator panel user name.
+
+    Args:
+        name (str): user name
+
+    Raises:
+        DuplicateParameterError: if user name is already set
+    """
+    reporter = RunnerReporter()
+    key = reporter.generate_key(DF.USER)
+    if reporter.get_field(key):
+        msg = "user_name"
+        raise DuplicateParameterError(msg)
+    reporter.set_doc_value(key, name)
+    reporter.update_db_by_doc()
+
+
+def set_batch_serial_number(serial_number: str) -> None:
+    """Add batch serial number to document.
+
+    Args:
+        serial_number (str): batch serial number
+
+    Raises:
+        DuplicateParameterError: if batch serial number is already set
+    """
+    reporter = RunnerReporter()
+    key = reporter.generate_key(DF.BATCH_SN)
+    if reporter.get_field(key):
+        msg = "batch_serial_number"
+        raise DuplicateParameterError(msg)
+    reporter.set_doc_value(key, serial_number)
+    reporter.update_db_by_doc()
+
+
+def set_dut_sub_unit(sub_unit: SubUnit) -> int:
+    """Add sub unit to DUT sub units list.
+
+    Args:
+        sub_unit (SubUnit): Sub unit object of DUT.
+
+    Returns:
+        int: sub unit index
+    """
+    reporter = RunnerReporter()
+    key = reporter.generate_key(DF.DUT, DF.SUB_UNITS)
+
+    sub_units = reporter.get_field(key) or []
+    sub_units.append({k: v for k, v in vars(sub_unit).items() if v is not None})
+
+    reporter.set_doc_value(key, sub_units)
+    reporter.update_db_by_doc()
+
+    return len(sub_units) - 1
+
+
+def set_dut_info(info: Mapping[str, str | int | float | datetime]) -> None:
+    """Set DUT info to document.
 
     Args:
-        info (dict): DUT info
+        info (Mapping): DUT info
     """
     reporter = RunnerReporter()
     for dut_key, dut_value in info.items():
@@ -76,12 +174,13 @@ def set_dut_serial_number(serial_number: str) -> None:
         serial_number (str): DUT serial number
 
     Raises:
-        DuplicateSerialNumberError: if serial number is already set
+        DuplicateParameterError: if serial number is already set
     """
     reporter = RunnerReporter()
     key = reporter.generate_key(DF.DUT, DF.SERIAL_NUMBER)
     if reporter.get_field(key):
-        raise DuplicateSerialNumberError
+        msg = "dut_serial_number"
+        raise DuplicateParameterError(msg)
     reporter.set_doc_value(
         key,
         serial_number if isinstance(serial_number, str) else str(serial_number),
@@ -96,16 +195,71 @@ def set_dut_part_number(part_number: str) -> None:
         part_number (str): DUT part number
 
     Raises:
-        DuplicatePartNumberError: if part number is already set
+        DuplicateParameterError: if part number is already set
     """
     reporter = RunnerReporter()
     key = reporter.generate_key(DF.DUT, DF.PART_NUMBER)
     if reporter.get_field(key):
-        raise DuplicatePartNumberError
+        msg = "dut_part_number"
+        raise DuplicateParameterError(msg)
     reporter.set_doc_value(key, part_number)
     reporter.update_db_by_doc()
 
 
+def set_dut_name(name: str) -> None:
+    """Set DUT name to document.
+
+    Args:
+        name (str): DUT name
+
+    Raises:
+        DuplicateParameterError: if DUT name is already set
+    """
+    reporter = RunnerReporter()
+    key = reporter.generate_key(DF.DUT, DF.NAME)
+    if reporter.get_field(key):
+        msg = "dut_name"
+        raise DuplicateParameterError(msg)
+    reporter.set_doc_value(key, name)
+    reporter.update_db_by_doc()
+
+
+def set_dut_type(dut_type: str) -> None:
+    """Set DUT type to document.
+
+    Args:
+        dut_type (str): DUT type
+
+    Raises:
+        DuplicateParameterError: if DUT type is already set
+    """
+    reporter = RunnerReporter()
+    key = reporter.generate_key(DF.DUT, DF.TYPE)
+    if reporter.get_field(key):
+        msg = "dut_type"
+        raise DuplicateParameterError(msg)
+    reporter.set_doc_value(key, dut_type)
+    reporter.update_db_by_doc()
+
+
+def set_dut_revision(revision: str) -> None:
+    """Set DUT revision to document.
+
+    Args:
+        revision (str): DUT revision
+
+    Raises:
+        DuplicateParameterError: if DUT revision is already set
+    """
+    reporter = RunnerReporter()
+    key = reporter.generate_key(DF.DUT, DF.REVISION)
+    if reporter.get_field(key):
+        msg = "dut_revision"
+        raise DuplicateParameterError(msg)
+    reporter.set_doc_value(key, revision)
+    reporter.update_db_by_doc()
+
+
 def set_stand_name(name: str) -> None:
     """Add test stand name to document.
 
@@ -113,22 +267,24 @@ def set_stand_name(name: str) -> None:
         name (str): test stand name
 
     Raises:
-        DuplicateTestStandNameError: if test stand name is already set
+        DuplicateParameterError: if test stand name is already set
     """
     reporter = RunnerReporter()
     key = reporter.generate_key(DF.TEST_STAND, DF.NAME)
     if reporter.get_field(key):
-        raise DuplicateTestStandNameError
+        msg = "stand_name"
+        raise DuplicateParameterError(msg)
     reporter.set_doc_value(key, name)
     reporter.update_db_by_doc()
 
 
-def set_stand_info(info: dict) -> None:
+def set_stand_info(info: Mapping[str, str | int | float | datetime]) -> None:
     """Add test stand info to document.
 
     Args:
-        info (dict): test stand info
-    """
+        info (Mapping[str, str | int | float | datetime]): test stand info as a mapping
+            where keys are strings and values can be strings, integers, floats or datetime objects
+    """  # noqa: E501
     reporter = RunnerReporter()
     for stand_key, stand_value in info.items():
         key = reporter.generate_key(DF.TEST_STAND, DF.INFO, stand_key)
@@ -143,12 +299,13 @@ def set_stand_location(location: str) -> None:
         location (str): test stand location
 
     Raises:
-        DuplicateTestStandLocationError: if test stand location is already set
+        DuplicateParameterError: if test stand location is already set
     """
     reporter = RunnerReporter()
     key = reporter.generate_key(DF.TEST_STAND, DF.LOCATION)
     if reporter.get_field(key):
-        raise DuplicateTestStandLocationError
+        msg = "stand_location"
+        raise DuplicateParameterError(msg)
     reporter.set_doc_value(key, location)
     reporter.update_db_by_doc()
 
@@ -160,7 +317,7 @@ def set_stand_number(number: int) -> None:
         number (int): test stand number (non negative integer)
 
     Raises:
-        DuplicateTestStandNumberError: if stand number is already set
+        DuplicateParameterError: if stand number is already set
         TestStandNumberError: if stand number is incorrect (negative or non integer)
     """
     reporter = RunnerReporter()
@@ -168,11 +325,30 @@ def set_stand_number(number: int) -> None:
     if not isinstance(number, int) or number < 0:
         raise TestStandNumberError
     if reporter.get_field(key):
-        raise DuplicateTestStandNumberError
+        msg = "stand_number"
+        raise DuplicateParameterError(msg)
     reporter.set_doc_value(key, number)
     reporter.update_db_by_doc()
 
 
+def set_stand_revision(revision: str) -> None:
+    """Add test stand revision to document.
+
+    Args:
+        revision (str): test stand revision
+
+    Raises:
+        DuplicateParameterError: if test stand revision is already set
+    """
+    reporter = RunnerReporter()
+    key = reporter.generate_key(DF.TEST_STAND, DF.REVISION)
+    if reporter.get_field(key):
+        msg = "stand_revision"
+        raise DuplicateParameterError(msg)
+    reporter.set_doc_value(key, revision)
+    reporter.update_db_by_doc()
+
+
 def set_message(msg: str, msg_key: str | None = None) -> None:
     """Add or update message in current test.
 
@@ -291,6 +467,135 @@ def set_driver_info(drivers: dict) -> None:
     reporter.update_db_by_doc()
 
 
+def set_instrument(instrument: Instrument) -> int:
+    """Add instrument to test stand instruments list.
+
+    Args:
+        instrument (Instrument): Instrument object containing all instrument data
+
+    Returns:
+        int: instrument index
+    """
+    reporter = RunnerReporter()
+    key = reporter.generate_key(DF.TEST_STAND, DF.INSTRUMENTS)
+
+    instruments = reporter.get_field(key) or []
+    instruments.append({k: v for k, v in vars(instrument).items() if v is not None})
+
+    reporter.set_doc_value(key, instruments)
+    reporter.update_db_by_doc()
+
+    return len(instruments) - 1
+
+
+def set_process_name(name: str) -> None:
+    """Set process name to document.
+
+    Args:
+        name (str): process name
+
+    Raises:
+        DuplicateParameterError: if process name is already set
+    """
+    reporter = RunnerReporter()
+    key = reporter.generate_key(DF.PROCESS, DF.NAME)
+    if reporter.get_field(key):
+        msg = "process_name"
+        raise DuplicateParameterError(msg)
+    reporter.set_doc_value(key, name)
+    reporter.update_db_by_doc()
+
+
+def set_process_number(number: int) -> None:
+    """Set process number to document.
+
+    Args:
+        number (int): process number
+
+    Raises:
+        DuplicateParameterError: if process number is already set
+    """
+    reporter = RunnerReporter()
+    key = reporter.generate_key(DF.PROCESS, DF.NUMBER)
+    if reporter.get_field(key):
+        msg = "process_number"
+        raise DuplicateParameterError(msg)
+    reporter.set_doc_value(key, number)
+    reporter.update_db_by_doc()
+
+
+def set_process_info(info: Mapping[str, str | int | float | datetime]) -> None:
+    """Set process info to document.
+
+    Args:
+        info (Mapping): process info
+    """
+    reporter = RunnerReporter()
+    for key, value in info.items():
+        full_key = reporter.generate_key(DF.PROCESS, DF.INFO, key)
+        reporter.set_doc_value(full_key, value)
+    reporter.update_db_by_doc()
+
+
+def set_case_measurement(measurement: NumericMeasurement | StringMeasurement) -> int:
+    """Add measurement to document.
+
+    Args:
+        measurement (NumericMeasurement | StringMeasurement): measurement object
+
+    Returns:
+        int: measurement index from measurements list
+    """
+    current_test = _get_current_test()
+    reporter = RunnerReporter()
+
+    key = reporter.generate_key(
+        DF.MODULES,
+        current_test.module_id,
+        DF.CASES,
+        current_test.case_id,
+        DF.MEASUREMENTS,
+    )
+
+    measurements = reporter.get_field(key) or []
+    measurements.append({k: v for k, v in vars(measurement).items() if v is not None})
+
+    reporter.set_doc_value(key, measurements)
+    reporter.update_db_by_doc()
+
+    return len(measurements) - 1
+
+
+def set_case_chart(chart: Chart) -> None:
+    """Add chart to document.
+
+    Args:
+        chart (Chart): chart object
+    """
+    if not chart.x_data or not chart.y_data:
+        msg = "x_data and y_data must be set"
+        raise ValueError(msg)
+    current_test = _get_current_test()
+    reporter = RunnerReporter()
+
+    key = reporter.generate_key(
+        DF.MODULES,
+        current_test.module_id,
+        DF.CASES,
+        current_test.case_id,
+        DF.CHART,
+    )
+
+    if reporter.get_field(key):
+        msg = "chart"
+        raise DuplicateParameterError(msg)
+
+    chart_dict = {k: v for k, v in vars(chart).items() if v is not None}
+
+    reporter.set_doc_value(key, chart_dict)
+    reporter.update_db_by_doc()
+
+
 def run_dialog_box(dialog_box_data: DialogBox) -> Any:  # noqa: ANN401
     """Display a dialog box.
 
@@ -373,6 +678,10 @@ def set_operator_message(  # noqa: PLR0913
         msg = "The 'font_size' argument cannot be less than 1"
         raise ValueError(msg)
 
+    if not msg:
+        msg = "The 'msg' argument cannot be empty"
+        raise ValueError(msg)
+
     msg_data = {
         DF.MSG: msg,
         DF.TITLE: title,

hardpy/pytest_hardpy/pytest_wrapper.py

@@ -25,7 +25,7 @@ class PyTestWrapper:
         self.config = ConfigManager().get_config()
         self.collect(is_clear_database=True)
 
-    def start(self) -> bool:
+    def start(self, start_args: dict | None = None) -> bool:
         """Start pytest subprocess.
 
         Returns:
@@ -37,44 +37,35 @@ class PyTestWrapper:
         if self.is_running():
             return False
 
-        if system() == "Linux":
+        cmd = [
+            self.python_executable,
+            "-m",
+            "pytest",
+            "--hardpy-db-url",
+            self.config.database.connection_url(),
+            "--hardpy-tests-name",
+            self.config.tests_name,
+            "--sc-address",
+            self.config.stand_cloud.address,
+        ]
+        if self.config.stand_cloud.connection_only:
+            cmd.append("--sc-connection-only")
+        cmd.append("--hardpy-pt")
+        if start_args:
+            for key, value in start_args.items():
+                arg_str = f"{key}={value}"
+                cmd.extend(["--hardpy-start-arg", arg_str])
+
+        if system() == "Windows":
             self._proc = subprocess.Popen(  # noqa: S603
-                [
-                    self.python_executable,
-                    "-m",
-                    "pytest",
-                    "--hardpy-db-url",
-                    self.config.database.connection_url(),
-                    "--hardpy-tests-name",
-                    self.config.tests_name,
-                    "--sc-address",
-                    self.config.stand_cloud.address,
-                    "--sc-connection-only"
-                    if self.config.stand_cloud.connection_only
-                    else "",
-                    "--hardpy-pt",
-                ],
+                cmd,
                 cwd=ConfigManager().get_tests_path(),
+                creationflags=subprocess.CREATE_NEW_PROCESS_GROUP,
             )
-        elif system() == "Windows":
+        if system() == "Linux":
             self._proc = subprocess.Popen(  # noqa: S603
-                [
-                    self.python_executable,
-                    "-m",
-                    "pytest",
-                    "--hardpy-db-url",
-                    self.config.database.connection_url(),
-                    "--hardpy-tests-name",
-                    self.config.tests_name,
-                    "--sc-address",
-                    self.config.stand_cloud.address,
-                    "--sc-connection-only"
-                    if self.config.stand_cloud.connection_only
-                    else "",
-                    "--hardpy-pt",
-                ],
+                cmd,
                 cwd=ConfigManager().get_tests_path(),
-                creationflags=subprocess.CREATE_NEW_PROCESS_GROUP,  # type: ignore
             )
 
         return True

hardpy/pytest_hardpy/reporter/hook_reporter.py

@@ -31,6 +31,10 @@ class HookReporter(BaseReporter):
             doc_name (str): test run name
         """
         self.set_doc_value(DF.NAME, doc_name)
+        self.set_doc_value(DF.USER, None)
+        self.set_doc_value(DF.BATCH_SN, None)
+        self.set_doc_value(DF.CAUSED_DUT_FAILURE_ID, None)
+        self.set_doc_value(DF.ERROR_CODE, None)
         self.set_doc_value(DF.STATUS, TestStatus.READY)
         self.set_doc_value(DF.START_TIME, None)
         self.set_doc_value(DF.STOP_TIME, None)
@@ -217,7 +221,7 @@ class HookReporter(BaseReporter):
             case_id,
             DF.ATTEMPT,
         )
-        self.set_doc_value(key, attempt, statestore_only=True)
+        self.set_doc_value(key, attempt)
 
     def get_module_start_time(self, module_id: str) -> int:
         """Get module start time.
@@ -237,6 +241,26 @@ class HookReporter(BaseReporter):
         key = self.generate_key(DF.MODULES, module_id, DF.CASES, case_id, DF.START_TIME)
         return self._statestore.get_field(key)
 
+    def set_caused_dut_failure_id(self, module_id: str, case_id: str) -> None:
+        """Set caused DUT failure id.
+
+        Args:
+            module_id (str): module id
+            case_id (str): case id
+        """
+        key = self.generate_key(DF.CAUSED_DUT_FAILURE_ID)
+        failure_id = f"{module_id}::{case_id}"
+        self.set_doc_value(key, failure_id)
+
+    def get_caused_dut_failure_id(self) -> str | None:
+        """Get caused DUT failure id.
+
+        Returns:
+            str | None: failure id
+        """
+        key = self.generate_key(DF.CAUSED_DUT_FAILURE_ID)
+        return self._statestore.get_field(key)
+
     def update_node_order(self, nodes: dict) -> None:
         """Update node order.
 
@@ -267,6 +291,7 @@ class HookReporter(BaseReporter):
         module_default = {
             DF.STATUS: TestStatus.READY,
             DF.NAME: self._get_module_name(node_info),
+            DF.GROUP: self._get_module_group(node_info),
             DF.START_TIME: None,
             DF.STOP_TIME: None,
             DF.CASES: {},
@@ -274,10 +299,14 @@ class HookReporter(BaseReporter):
         case_default = {
             DF.STATUS: TestStatus.READY,
             DF.NAME: self._get_case_name(node_info),
+            DF.GROUP: self._get_case_group(node_info),
             DF.START_TIME: None,
             DF.STOP_TIME: None,
             DF.ASSERTION_MSG: None,
             DF.MSG: None,
+            DF.ATTEMPT: 0,
+            DF.MEASUREMENTS: [],
+            DF.CHART: None,
         }
 
         if item.get(node_info.module_id) is None:
@@ -287,6 +316,7 @@ class HookReporter(BaseReporter):
         else:
             item[node_info.module_id][DF.STATUS] = TestStatus.READY
             item[node_info.module_id][DF.NAME] = self._get_module_name(node_info)
+            item[node_info.module_id][DF.GROUP] = self._get_module_group(node_info)
             item[node_info.module_id][DF.START_TIME] = None
             item[node_info.module_id][DF.STOP_TIME] = None
         item[node_info.module_id][DF.NAME] = self._get_module_name(node_info)
@@ -296,7 +326,6 @@ class HookReporter(BaseReporter):
 
         if is_only_statestore:
             case_default[DF.DIALOG_BOX] = {}
-            case_default[DF.ATTEMPT] = 0
         item[node_info.module_id][DF.CASES][node_info.case_id] = case_default
 
     def _remove_outdate_node(
@@ -378,6 +407,28 @@ class HookReporter(BaseReporter):
         """
         return node_info.module_name if node_info.module_name else node_info.module_id
 
+    def _get_module_group(self, node_info: NodeInfo) -> str:
+        """Get module group from markers or use default.
+
+        Args:
+            node_info (NodeInfo): node info
+
+        Returns:
+            str: module group
+        """
+        return node_info.module_group
+
+    def _get_case_group(self, node_info: NodeInfo) -> str:
+        """Get case group from markers or use default.
+
+        Args:
+            node_info (NodeInfo): node info
+
+        Returns:
+            str: case group
+        """
+        return node_info.case_group
+
     def _get_case_name(self, node_info: NodeInfo) -> str:
         """Get case name from markers or use default.
 

hardpy/pytest_hardpy/result/report_loader/stand_cloud_loader.py

@@ -32,11 +32,13 @@ class StandCloudLoader:
         sc_addr = address if address else connection_data.sc_address
         self._sc_connector = StandCloudConnector(sc_addr)
 
-    def load(self, report: ResultRunStore) -> Response:
+    def load(self, report: ResultRunStore, timeout: int = 20) -> Response:
         """Load report to the StandCloud.
 
         Args:
             report (ResultRunStore): report
+            timeout (int, optional): post timeout in seconds. Defaults to 20.
+                                    High timeout value on poor network connections.
 
         Returns:
             Response: StandCloud load response, must be 201
@@ -47,7 +49,11 @@ class StandCloudLoader:
         api = self._sc_connector.get_api("test_report")
 
         try:
-            resp = api.post(verify=self._verify_ssl, json=report.model_dump())
+            resp = api.post(
+                verify=self._verify_ssl,
+                json=report.model_dump(),
+                timeout=timeout,
+            )
         except RuntimeError as exc:
             raise StandCloudError(str(exc)) from exc
         except OAuth2Error as exc:

hardpy/pytest_hardpy/result/report_reader/couchdb_reader.py

@@ -88,11 +88,7 @@ class CouchdbReader:
             str: report status
         """
         doc = self._db.get(report_name)
-        status = doc[DF.STATUS]
-        if status not in {TestStatus.PASSED, TestStatus.FAILED, TestStatus.SKIPPED}:
-            msg = "Invalid report status"
-            raise ValueError(msg)
-        return status
+        return doc[DF.STATUS]
 
     def get_report_infos(self) -> list[ReportInfo]:
         """Get a list of information about all reports in the database.