add basic tests

Author: Mike Prosser

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

src/nipanel/__init__.py

@@ -1 +1,3 @@
 """The NI Panel."""
+from nipanel.nipanel import NiPanel
+__all__ = ["NiPanel"]

src/nipanel/nipanel.py

@@ -4,19 +4,22 @@
 import ni.pythonpanel.v1.python_panel_service_pb2 as python_panel_service_pb2
 import ni.pythonpanel.v1.python_panel_service_pb2_grpc as python_panel_service_pb2_grpc
 
+
 class NiPanel:
     """
     This class allows you to access controls on the panel
     """
+
     def __init__(self):
-        self._stub = None # will be a PythonPanelServiceStub
+        self._stub = None  # will be a PythonPanelServiceStub
         self.panel_uri = None
         self.panel_id = None
 
     def __enter__(self):
         self.connect()
+        return self
 
-    def __exit__(self):
+    def __exit__(self, exc_type, exc_value, exc_traceback):
         self.disconnect()
 
     @classmethod
@@ -35,10 +38,10 @@ def streamlit_panel(cls, streamlit_script_path: str):
         panel.panel_id = str(uuid.uuid4())
         return panel
 
-    def connect(self): 
+    def connect(self):
         """
         Connect to the panel and open it.
-        """       
+        """
         # TODO: AB#3095680 - Use gRPC pool management from the Measurement Plugin SDK, create the _stub, and call _stub.Connect
         pass
 
@@ -71,4 +74,4 @@ def set_value(self, value_id: str, value):
             value: The value
         """
         # TODO: AB#3095681 - Convert the value to an Any and pass it to _stub.SetValue
-        pass
+        pass

tests/__init__.py

@@ -0,0 +1 @@
+"""Tests for the `nipanel` package."""

tests/unit/test_nipanel.py

@@ -0,0 +1,17 @@
+from nipanel import NiPanel
+
+def test_streamlit_panel() -> None:
+    panel = NiPanel.streamlit_panel("path/to/script")
+    assert panel.panel_uri == "path/to/script"
+    assert panel.panel_id is not None
+    panel.connect() # not implemented, but should not raise an error
+    panel.set_value("test_id", "test_value") # not implemented, but should not raise an error
+    assert panel.get_value("test_id") == "placeholder value" # not implemented, but should not raise an error
+    panel.disconnect() # not implemented, but should not raise an error
+
+def test_with_streamlit_panel() -> None:
+    with NiPanel.streamlit_panel("path/to/script") as panel:
+        assert panel.panel_uri == "path/to/script"
+        assert panel.panel_id is not None
+        panel.set_value("test_id", "test_value") # not implemented, but should not raise an error
+        assert panel.get_value("test_id") == "placeholder value" # not implemented, but should not raise an error