Merge pull request #9 from harp-tech/gl-dev

Add unit tests for io module

Author: glopesdev

.gitignore

@@ -9,4 +9,4 @@ __pycache__
 dist
 
 # Data files
-data
+/data

pyproject.toml

@@ -31,6 +31,7 @@ classifiers = [
 [project.optional-dependencies]
 dev = [
     "datamodel-code-generator",
+    "pytest",
     "black"
 ]
 jupyter = [

tests/data/device_0.bin

@@ -0,0 +1,63 @@
+import pytest
+import numpy as np
+from typing import Optional, Type
+from contextlib import nullcontext
+from pytest import mark
+from pathlib import Path
+from dataclasses import dataclass
+from harp.io import read
+
+datapath = Path(__file__).parent
+
+
+@dataclass
+class DataFileParam:
+    path: str
+    expected_rows: int
+    expected_address: Optional[int] = None
+    expected_dtype: Optional[np.dtype] = None
+    expected_length: Optional[int] = None
+    expected_error: Optional[Type[BaseException]] = None
+
+    def __post_init__(self):
+        self.path = datapath / self.path
+
+
+testdata = [
+    DataFileParam(path="data/device_0.bin", expected_rows=1),
+    DataFileParam(
+        path="data/device_0.bin",
+        expected_rows=1,
+        expected_address=1,  # actual address is 0
+        expected_error=ValueError,
+    ),
+    DataFileParam(
+        path="data/device_0.bin",
+        expected_rows=1,
+        expected_dtype="uint8",  # actual dtype is uint16
+        expected_error=ValueError,
+    ),
+    DataFileParam(
+        path="data/device_0.bin",
+        expected_rows=1,
+        expected_length=2,  # actual length is 1
+        expected_error=ValueError,
+    ),
+]
+
+
+@mark.parametrize("dataFile", testdata)
+def test_read(dataFile: DataFileParam):
+    context = pytest.raises if dataFile.expected_error is not None else nullcontext
+    with context(dataFile.expected_error):
+        data = read(
+            dataFile.path,
+            address=dataFile.expected_address,
+            dtype=dataFile.expected_dtype,
+            length=dataFile.expected_length,
+        )
+        assert len(data) == dataFile.expected_rows
+
+
+if __name__ == "__main__":
+    pytest.main()