add tests for close() in test_streamlit_panel

Author: Mike Prosser

tests/unit/test_panel_client.py

@@ -4,13 +4,13 @@
 from nipanel._panel_client import PanelClient
 
 
-def test___enumerate_is_empty(fake_panel_channel: grpc.Channel):
+def test___enumerate_is_empty(fake_panel_channel: grpc.Channel) -> None:
     client = create_panel_client(fake_panel_channel)
 
     assert client.enumerate_panels() == []
 
 
-def test___open_panels___enumerate_has_panels(fake_panel_channel: grpc.Channel):
+def test___open_panels___enumerate_has_panels(fake_panel_channel: grpc.Channel) -> None:
     client = create_panel_client(fake_panel_channel)
 
     client.open_panel("panel1", "uri1")
@@ -21,7 +21,7 @@ def test___open_panels___enumerate_has_panels(fake_panel_channel: grpc.Channel):
 
 def test___open_panels___close_panel_1___enumerate_has_panel_2(
     fake_panel_channel: grpc.Channel,
-):
+) -> None:
     client = create_panel_client(fake_panel_channel)
     client.open_panel("panel1", "uri1")
     client.open_panel("panel2", "uri2")
@@ -31,14 +31,14 @@ def test___open_panels___close_panel_1___enumerate_has_panel_2(
     assert client.enumerate_panels() == ["panel2"]
 
 
-def test___get_value_raises(fake_panel_channel: grpc.Channel):
+def test___get_unset_value_raises_exception(fake_panel_channel: grpc.Channel) -> None:
     client = create_panel_client(fake_panel_channel)
 
     with pytest.raises(Exception):
         client.get_value("panel1", "unset_id")
 
 
-def test___set_value___gets_value(fake_panel_channel: grpc.Channel):
+def test___set_value___gets_value(fake_panel_channel: grpc.Channel) -> None:
     client = create_panel_client(fake_panel_channel)
 
     client.set_value("panel1", "val1", "value1")

tests/unit/test_streamlit_panel.py

@@ -64,6 +64,35 @@ def test___opened_panel___accessor_set_value___panel_gets_same_value(
     assert panel.get_value(value_id) == string_value
 
 
+def test___opened_panel_with_value___close_without_reset___gets_value(
+    fake_panel_channel: grpc.Channel,
+) -> None:
+    panel = StreamlitPanel("my_panel", "path/to/script", grpc_channel=fake_panel_channel)
+    panel.open_panel()
+    value_id = "test_id"
+    string_value = "test_value"
+    panel.set_value(value_id, string_value)
+
+    panel.close_panel(reset=False)
+
+    assert panel.get_value(value_id) == string_value
+
+
+def test___opened_panel_with_value___close_with_reset___get_throws(
+    fake_panel_channel: grpc.Channel,
+) -> None:
+    panel = StreamlitPanel("my_panel", "path/to/script", grpc_channel=fake_panel_channel)
+    panel.open_panel()
+    value_id = "test_id"
+    string_value = "test_value"
+    panel.set_value(value_id, string_value)
+
+    panel.close_panel(reset=True)
+
+    with pytest.raises(grpc.RpcError):
+        panel.get_value(value_id)
+
+
 def test___first_open_panel_fails___open_panel___gets_value(
     fake_python_panel_service: FakePythonPanelService,
     fake_panel_channel: grpc.Channel,

tests/utils/_fake_python_panel_servicer.py

@@ -21,8 +21,8 @@ class FakePythonPanelServicer(PythonPanelServiceServicer):
 
     def __init__(self) -> None:
         """Initialize the fake PythonPanelServicer."""
-        self._values = {}
-        self._panel_ids = []
+        self._values: dict[str, Any] = {}
+        self._panel_ids: list[str] = []
         self._fail_next_open_panel = False
 
     def OpenPanel(self, request: OpenPanelRequest, context: Any) -> OpenPanelResponse:  # noqa: N802
@@ -38,6 +38,8 @@ def ClosePanel(  # noqa: N802
     ) -> ClosePanelResponse:
         """Trivial implementation for testing."""
         self._panel_ids.remove(request.panel_id)
+        if request.reset:
+            self._values.clear()
         return ClosePanelResponse()
 
     def EnumeratePanels(  # noqa: N802