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

hardpy/pytest_hardpy/db/__init__.py

@@ -1,18 +1,17 @@
 # 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.db.schema import ResultRunStore, ResultStateStore
-from hardpy.pytest_hardpy.db.statestore import StateStore
-from hardpy.pytest_hardpy.db.runstore import RunStore
 from hardpy.pytest_hardpy.db.base_store import BaseStore
 from hardpy.pytest_hardpy.db.const import DatabaseField
-
+from hardpy.pytest_hardpy.db.runstore import RunStore
+from hardpy.pytest_hardpy.db.schema import ResultRunStore, ResultStateStore
+from hardpy.pytest_hardpy.db.statestore import StateStore
 
 __all__ = [
     "BaseStore",
     "DatabaseField",
     "ResultRunStore",
     "ResultStateStore",
-    "StateStore",
     "RunStore",
+    "StateStore",
 ]

hardpy/pytest_hardpy/db/base_connector.py

@@ -1,10 +1,9 @@
 # Copyright (c) 2024 Everypin
 # GNU General Public License v3.0 (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
 
-from requests.exceptions import ConnectionError
-
 from pycouchdb.client import Database
 from pycouchdb.exceptions import Conflict, GenericError
+from requests.exceptions import ConnectionError  # noqa: A004
 
 from hardpy.pytest_hardpy.db.base_server import BaseServer
 
@@ -12,7 +11,7 @@ from hardpy.pytest_hardpy.db.base_server import BaseServer
 class BaseConnector(BaseServer):
     """Base class for CouchDB connector."""
 
-    def __init__(self, db_name: str):
+    def __init__(self, db_name: str) -> None:
         super().__init__()
         self._db_name = db_name
         self._db = self._init_db()
@@ -25,6 +24,8 @@ class BaseConnector(BaseServer):
             # database is already created
             return self._db_srv.database(self._db_name)
         except GenericError as exc:
-            raise RuntimeError(f"Error initializing database {exc}") from exc
+            msg = f"Error initializing database {exc}"
+            raise RuntimeError(msg) from exc
         except ConnectionError as exc:
-            raise RuntimeError(f"Error initializing database: {exc}") from exc
+            msg = f"Error initializing database: {exc}"
+            raise RuntimeError(msg) from exc

hardpy/pytest_hardpy/db/base_server.py

@@ -9,6 +9,6 @@ from hardpy.pytest_hardpy.utils import ConnectionData
 class BaseServer:
     """Base class for CouchDB server."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         con_data = ConnectionData()
         self._db_srv = DbServer(con_data.database_url)

hardpy/pytest_hardpy/db/base_store.py

@@ -9,23 +9,23 @@ from pycouchdb.exceptions import Conflict, NotFound
 from pydantic._internal._model_construction import ModelMetaclass
 
 from hardpy.pytest_hardpy.db.base_connector import BaseConnector
-from hardpy.pytest_hardpy.db.const import DatabaseField as DF
+from hardpy.pytest_hardpy.db.const import DatabaseField as DF  # noqa: N817
 
 
 class BaseStore(BaseConnector):
     """HardPy base storage interface for CouchDB."""
 
-    def __init__(self, db_name: str):
+    def __init__(self, db_name: str) -> None:
         super().__init__(db_name)
         self._log = getLogger(__name__)
         self._doc: dict = self._init_doc()
         self._schema: ModelMetaclass
 
-    def compact(self):
+    def compact(self) -> None:
         """Compact database."""
         self._db.compact()
 
-    def get_field(self, key: str) -> Any:
+    def get_field(self, key: str) -> Any:  # noqa: ANN401
         """Get field from the state store.
 
         Args:
@@ -36,7 +36,7 @@ class BaseStore(BaseConnector):
         """
         return glom(self._doc, key)
 
-    def update_doc(self, key: str, value):
+    def update_doc(self, key: str, value: Any) -> None:  # noqa: ANN401
         """Update document.
 
         HardPy collecting uses a simple key without dots.
@@ -52,7 +52,7 @@ class BaseStore(BaseConnector):
         else:
             self._doc[key] = value
 
-    def update_db(self):
+    def update_db(self) -> None:
         """Update database by current document."""
         try:
             self._doc = self._db.save(self._doc)
@@ -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)
@@ -82,18 +91,19 @@ class BaseStore(BaseConnector):
                     DF.INFO: {},
                 },
                 DF.TEST_STAND: {
+                    DF.HW_ID: None,
                     DF.NAME: None,
+                    DF.TIMEZONE: None,
+                    DF.LOCATION: None,
+                    DF.DRIVERS: {},
                     DF.INFO: {},
                 },
-                DF.DRIVERS: {},
             }
 
         # init document
         if DF.MODULES not in doc:
             doc[DF.MODULES] = {}
 
-        doc[DF.DRIVERS] = {}
-
         doc[DF.DUT] = {
             DF.SERIAL_NUMBER: None,
             DF.PART_NUMBER: None,
@@ -101,7 +111,11 @@ class BaseStore(BaseConnector):
         }
 
         doc[DF.TEST_STAND] = {
+            DF.HW_ID: None,
             DF.NAME: None,
+            DF.TIMEZONE: None,
+            DF.LOCATION: None,
+            DF.DRIVERS: {},
             DF.INFO: {},
         }
 

hardpy/pytest_hardpy/db/const.py

@@ -4,7 +4,7 @@
 from enum import Enum
 
 
-class DatabaseField(str, Enum):  # noqa: WPS600
+class DatabaseField(str, Enum):
     """Database field."""
 
     NAME = "name"
@@ -27,3 +27,5 @@ class DatabaseField(str, Enum):  # noqa: WPS600
     DIALOG_BOX = "dialog_box"
     OPERATOR_MSG = "operator_msg"
     ATTEMPT = "attempt"
+    LOCATION = "location"
+    HW_ID = "hw_id"

hardpy/pytest_hardpy/db/runstore.py

@@ -6,25 +6,23 @@ from logging import getLogger
 from pycouchdb.exceptions import Conflict, NotFound
 
 from hardpy.pytest_hardpy.db.base_store import BaseStore
-from hardpy.pytest_hardpy.db import ResultRunStore
-from hardpy.pytest_hardpy.utils import Singleton
+from hardpy.pytest_hardpy.db.schema import ResultRunStore
+from hardpy.pytest_hardpy.utils import SingletonMeta
 
 
-class RunStore(Singleton, BaseStore):
+class RunStore(BaseStore, metaclass=SingletonMeta):
     """HardPy run storage interface for CouchDB.
 
     Save state and case artifact.
     """
 
-    def __init__(self):
-        if not self._initialized:
-            super().__init__("runstore")
-            self._log = getLogger(__name__)
-            try:
-                # Clear the runstore database before each launch
-                self._db.delete(self._doc_id)
-            except (Conflict, NotFound):
-                self._log.debug("Runstore database will be created for the first time")
-            self._doc: dict = self._init_doc()
-            self._schema = ResultRunStore
-            self._initialized = True
+    def __init__(self) -> None:
+        super().__init__("runstore")
+        self._log = getLogger(__name__)
+        try:
+            # Clear the runstore database before each launch
+            self._db.delete(self._doc_id)
+        except (Conflict, NotFound):
+            self._log.debug("Runstore database will be created for the first time")
+        self._doc: dict = self._init_doc()
+        self._schema = ResultRunStore

hardpy/pytest_hardpy/db/schema/__init__.py

@@ -0,0 +1,9 @@
+# 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.db.schema.v1 import ResultRunStore, ResultStateStore
+
+__all__ = [
+    "ResultRunStore",
+    "ResultStateStore",
+]

hardpy/pytest_hardpy/db/{schema.py → schema/v1.py}

@@ -1,9 +1,12 @@
 # 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 pydantic import BaseModel, Field, ConfigDict
+from typing import ClassVar
 
-from hardpy.pytest_hardpy.utils import TestStatus as Status
+from pydantic import BaseModel, ConfigDict, Field
+
+from hardpy.pytest_hardpy.utils import TestStatus as Status  # noqa: TC001
 
 
 class IBaseResult(BaseModel):
@@ -21,7 +24,9 @@ class CaseStateStore(IBaseResult):
     """Test case description.
 
     Example:
-    "test_one": {
+    ```
+    {
+      "test_one": {
         "status": "passed",
         "name": "Test 2",
         "start_time": 1695817188,
@@ -39,7 +44,9 @@ class CaseStateStore(IBaseResult):
             "type": "textinput"
           }
         }
+      }
     }
+    ```
     """
 
     assertion_msg: str | None = None
@@ -52,44 +59,50 @@ class CaseRunStore(IBaseResult):
     """Test case description with artifact.
 
     Example:
-    "test_one": {
+    ```
+    {
+      "test_one": {
         "status": "passed",
         "name": "Test 2",
         "start_time": 1695817188,
         "stop_time": 1695817189,
         "assertion_msg": null,
         "msg": null,
-        "attempt": 1,
         "artifact": {}
+      }
     }
+    ```
     """
 
     assertion_msg: str | None = None
     msg: dict | None = None
     artifact: dict = {}
-    attempt: int = 0
 
 
 class ModuleStateStore(IBaseResult):
     """Test module description.
 
     Example:
-    "test_2_b": {
-      "status": "passed",
-      "name": "Module 2",
-      "start_time": 1695816886,
-      "stop_time": 1695817016,
-      "cases": {
-        "test_one": {
-          "status": "passed",
-          "name": "Test 1",
-          "start_time": 1695817015,
-          "stop_time": 1695817016,
-          "assertion_msg": null,
-          "msg": null
+    ```
+    {
+      "test_2_b": {
+        "status": "passed",
+        "name": "Module 2",
+        "start_time": 1695816886,
+        "stop_time": 1695817016,
+        "cases": {
+          "test_one": {
+            "status": "passed",
+            "name": "Test 1",
+            "start_time": 1695817015,
+            "stop_time": 1695817016,
+            "assertion_msg": null,
+            "msg": null
+          }
         }
       }
     }
+    ```
     """
 
     cases: dict[str, CaseStateStore] = {}
@@ -99,24 +112,28 @@ class ModuleRunStore(IBaseResult):
     """Test module description.
 
     Example:
-    "test_2_b": {
-      "status": "passed",
-      "name": "Module 2",
-      "start_time": 1695816886,
-      "stop_time": 1695817016,
-      "artifact": {},
-      "cases": {
-        "test_one": {
-          "status": "passed",
-          "name": "Test 1",
-          "start_time": 1695817015,
-          "stop_time": 1695817016,
-          "assertion_msg": null,
-          "msg": null,
-          "artifact": {}
+    ```
+    {
+      "test_2_b": {
+        "status": "passed",
+        "name": "Module 2",
+        "start_time": 1695816886,
+        "stop_time": 1695817016,
+        "artifact": {},
+        "cases": {
+          "test_one": {
+            "status": "passed",
+            "name": "Test 1",
+            "start_time": 1695817015,
+            "stop_time": 1695817016,
+            "assertion_msg": null,
+            "msg": null,
+            "artifact": {}
+          }
         }
       }
     }
+    ```
     """
 
     cases: dict[str, CaseRunStore] = {}
@@ -127,14 +144,18 @@ class Dut(BaseModel):
     """Device under test description.
 
     Example:
-    "dut": {
+    ```
+    {
+      "dut": {
         "serial_number": "a9ad8dca-2c64-4df8-a358-c21e832a32e4",
         "part_number": "part_number_1",
         "info": {
           "batch": "test_batch",
           "board_rev": "rev_1"
         }
-    },
+      }
+    }
+    ```
     """
 
     model_config = ConfigDict(extra="forbid")
@@ -148,33 +169,48 @@ class TestStand(BaseModel):
     """Test stand description.
 
     Example:
-    "test_stand": {
+    ```
+    {
+      "test_stand": {
+        "hw_id": "840982098ca2459a7b22cc608eff65d4",
         "name": "test_stand_1",
         "info": {
-          "geo": "Belgrade",
-        }
-    },
+          "geo": "Belgrade"
+        },
+        "timezone": "Europe/Belgrade",
+        "drivers": {
+          "driver_1": "driver info",
+          "driver_2": {
+            "state": "active",
+            "port": 8000
+          }
+        },
+        "location": "Belgrade_1"
+      }
+    }
+    ```
     """
 
     model_config = ConfigDict(extra="forbid")
 
-    name: str | None
+    hw_id: str | None = None
+    name: str | None = None
+    timezone: str | None = None
+    drivers: dict = {}
     info: dict = {}
+    location: str | None = None
 
 
 class ResultStateStore(IBaseResult):
     """Test run description.
 
     Example:
+    ```
     {
       "_rev": "44867-3888ae85c19c428cc46685845953b483",
       "_id": "current",
       "progress": 100,
       "stop_time": 1695817266,
-      "timezone": [
-        "CET",
-        "CET"
-      ],
       "start_time": 1695817263,
       "status": "failed",
       "name": "hardpy-stand",
@@ -187,15 +223,20 @@ class ResultStateStore(IBaseResult):
         }
       },
       "test_stand": {
-        "name": "Test stand 1"
-        "info": {}
-      },
-      "drivers": {
-        "driver_1": "driver info",
-        "driver_2": {
-          "state": "active",
-          "port": 8000
-        }
+        "hw_id": "840982098ca2459a7b22cc608eff65d4",
+        "name": "test_stand_1",
+        "info": {
+          "geo": "Belgrade"
+        },
+        "timezone": "Europe/Belgrade",
+        "drivers": {
+          "driver_1": "driver info",
+          "driver_2": {
+            "state": "active",
+            "port": 8000
+          }
+        },
+        "location": "Belgrade_1"
       },
       "operator_msg": {
         "msg": "Operator message",
@@ -238,11 +279,12 @@ class ResultStateStore(IBaseResult):
               "msg": [
                 "Current minute 21"
               ]
-            },
+            }
           }
-        },
+        }
       }
     }
+    ```
     """
 
     model_config = ConfigDict(extra="forbid")
@@ -250,11 +292,9 @@ class ResultStateStore(IBaseResult):
     rev: str = Field(..., alias="_rev")
     id: str = Field(..., alias="_id")
     progress: int
-    timezone: tuple[str, str] | None = None
     test_stand: TestStand
     dut: Dut
     modules: dict[str, ModuleStateStore] = {}
-    drivers: dict = {}
     operator_msg: dict = {}
 
 
@@ -262,15 +302,11 @@ class ResultRunStore(IBaseResult):
     """Test run description.
 
     Example:
+    ```
     {
       "_rev": "44867-3888ae85c19c428cc46685845953b483",
       "_id": "current",
-      "progress": 100,
       "stop_time": 1695817266,
-      "timezone": [
-        "CET",
-        "CET"
-      ],
       "start_time": 1695817263,
       "status": "failed",
       "name": "hardpy-stand",
@@ -283,15 +319,20 @@ class ResultRunStore(IBaseResult):
         }
       },
       "test_stand": {
-        "name": "Test stand 1"
-        "info": {}
-      },
-      "drivers": {
-        "driver_1": "driver info",
-        "driver_2": {
-          "state": "active",
-          "port": 8000
-        }
+        "hw_id": "840982098ca2459a7b22cc608eff65d4",
+        "name": "test_stand_1",
+        "info": {
+          "geo": "Belgrade"
+        },
+        "timezone": "Europe/Belgrade",
+        "drivers": {
+          "driver_1": "driver info",
+          "driver_2": {
+            "state": "active",
+            "port": 8000
+          }
+        },
+        "location": "Belgrade_1"
       },
       "artifact": {},
       "modules": {
@@ -309,7 +350,6 @@ class ResultRunStore(IBaseResult):
               "stop_time": 1695817264,
               "assertion_msg": null,
               "msg": null,
-              "attempt": 1,
               "artifact": {}
             },
             "test_minute_parity": {
@@ -321,7 +361,6 @@ class ResultRunStore(IBaseResult):
               "msg": [
                 "Current minute 21"
               ],
-              "attempt": 1,
               "artifact": {
                 "data_str": "123DATA",
                 "data_int": 12345,
@@ -329,21 +368,23 @@ class ResultRunStore(IBaseResult):
                   "test_key": "456DATA"
                 }
               }
-            },
+            }
           }
-        },
+        }
       }
     }
+    ```
     """
 
     model_config = ConfigDict(extra="forbid")
+    # Create the new schema class with version update
+    # when you change this class or fields in this class.
+    __version__: ClassVar[int] = 1
 
     rev: str = Field(..., alias="_rev")
     id: str = Field(..., alias="_id")
-    progress: int
-    timezone: tuple[str, str] | None = None
+
     test_stand: TestStand
     dut: Dut
     modules: dict[str, ModuleRunStore] = {}
-    drivers: dict = {}
     artifact: dict = {}

hardpy/pytest_hardpy/db/statestore.py

@@ -3,28 +3,15 @@
 
 from logging import getLogger
 
-from pycouchdb.exceptions import Conflict, NotFound
-
 from hardpy.pytest_hardpy.db.base_store import BaseStore
-from hardpy.pytest_hardpy.db import ResultStateStore
-from hardpy.pytest_hardpy.utils import Singleton
+from hardpy.pytest_hardpy.db.schema import ResultStateStore
+from hardpy.pytest_hardpy.utils import SingletonMeta
 
 
-class StateStore(Singleton, BaseStore):
+class StateStore(BaseStore, metaclass=SingletonMeta):
     """HardPy state storage interface for CouchDB."""
 
-    def __init__(self):
-        if not self._initialized:
-            super().__init__("statestore")
-            self._log = getLogger(__name__)
-            self._schema = ResultStateStore
-            self._initialized = True
-
-    def clear(self):
-        """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()
+    def __init__(self) -> None:
+        super().__init__("statestore")
+        self._log = getLogger(__name__)
+        self._schema = ResultStateStore