TST: add unit test for 'restore_items' API

Author: dmgav

src/save_and_restore_api/_api_threads.py

@@ -282,6 +282,8 @@ def restore_node(self, nodeId, *, auth=None):
         """
         Restore PVs based on the data from an existing snapshot node specified by nodeId.
 
+        Returns a list of snapshotItems that were NOT restored. Ideally the list should be empty.
+
         API: POST /restore/node
         """
         method, url, url_params = self._prepare_restore_node(nodeId=nodeId)
@@ -292,6 +294,8 @@ def restore_items(self, *, snapshotItems, auth=None):
         Restore PVs based on the list of snapshot items passed with the request. The list
         format matches the format of ``snapshotData["snapshotItems"]``
 
+        Returns a list of snapshotItems that were NOT restored. Ideally the list should be empty.
+
         API: POST /restore/items
         """
         method, url, params = self._prepare_restore_items(snapshotItems=snapshotItems)

tests/test_snapshot_control.py

@@ -334,12 +334,13 @@ async def testing():
 # =============================================================================================
 
 # fmt: off
+@pytest.mark.parametrize("restorenode", [True, False])
 @pytest.mark.parametrize("usesetauth", [True, False])
 @pytest.mark.parametrize("library", ["THREADS", "ASYNC"])
 # fmt: on
-def test_restore_node_01(clear_sar, library, usesetauth):  # noqa: F811
+def test_restore_node_01(clear_sar, library, usesetauth, restorenode):  # noqa: F811
     """
-    Basic tests for the 'restore_node' API.
+    Basic tests for the 'restore_node' and 'restore_items' API.
     """
     root_folder_uid = create_root_folder()
     name, comment = "test snapshot", "This is a test snapshot"
@@ -369,9 +370,13 @@ def test_restore_node_01(clear_sar, library, usesetauth):  # noqa: F811
             for pv in ioc_pvs.keys():
                 caput(pv, "0")
 
-            response = SR.restore_node(shot_uid, **auth)
+            if restorenode:
+                response = SR.restore_node(shot_uid, **auth)
+            else:
+                response = SR.restore_items(snapshotItems=snapshotData["snapshotItems"], **auth)
+
             print(f"response: {response}")
-            assert len(response) == 0  # Empty if restoration succeeded
+            assert len(response) == 0
 
             for pv, v in ioc_pvs.items():
                 assert int(caget(pv, "0")) == int(v), f"PV {pv} has value {caget(pv)}, expected {v}"
@@ -402,7 +407,11 @@ async def testing():
                 for pv in ioc_pvs.keys():
                     caput(pv, "0")
 
-                response = await SR.restore_node(shot_uid, **auth)
+                if restorenode:
+                    response = await SR.restore_node(shot_uid, **auth)
+                else:
+                    response = await SR.restore_items(snapshotItems=snapshotData["snapshotItems"], **auth)
+
                 print(f"response: {response}")
                 assert len(response) == 0  # Empty if restoration succeeded