ENH: add implementations for add_node, delete_nodes, get_children API

Author: dmgav

src/save_and_restore_api/_api_async.py

@@ -46,3 +46,17 @@ async def login(self, *, username=None, password=None):
     async def get_node(self, node_uid):
         method, url = self._prepare_get_node(node_uid=node_uid)
         return await self.send_request(method, url)
+
+    async def add_node(self, parentNodeId, *, name, nodeType, **kwargs):
+        method, url, params = self._prepare_add_node(
+            parentNodeId=parentNodeId, name=name, nodeType=nodeType, **kwargs
+        )
+        return await self.send_request(method, url, params=params)
+
+    async def delete_nodes(self, uniqueIds):
+        method, url, params = self._prepare_delete_nodes(uniqueIds=uniqueIds)
+        return await self.send_request(method, url, params=params)
+
+    async def get_children(self, node_uid):
+        method, url = self._prepare_get_children(node_uid=node_uid)
+        return await self.send_request(method, url)

src/save_and_restore_api/_api_base.py

@@ -86,7 +86,7 @@ def set_auth(self, *, username, password):
 
     def _process_response(self, *, client_response):
         client_response.raise_for_status()
-        response = client_response.json()
+        response = client_response.json() if client_response.content else ""
         return response
 
     def _process_comm_exception(self, *, method, params, client_response):
@@ -147,8 +147,23 @@ def _prepare_get_node(self, *, node_uid):
         method, url = "GET", f"/node/{node_uid}"
         return method, url
 
-    def get_children(self, node_uid):
-        return self.send_request("GET", f"/node/{node_uid}/children")
+    def _prepare_add_node(self, *, parentNodeId, name, nodeType, **kwargs):
+        node_types = ("FOLDER", "CONFIGURATION")
+        if nodeType not in node_types:
+            raise self.RequestParameterError(f"Invalid nodeType: {nodeType!r}. Supported types: {node_types}.")
+        method, url = "PUT", f"/node?parentNodeId={parentNodeId}"
+        params = kwargs
+        params.update({"name": name, "nodeType": nodeType})
+        return method, url, params
+
+    def _prepare_delete_nodes(self, *, uniqueIds):
+        method, url = "DELETE", "/node"
+        params = uniqueIds
+        return method, url, params
+
+    def _prepare_get_children(self, *, node_uid):
+        method, url = "GET", f"/node/{node_uid}/children"
+        return method, url
 
     def create_config(self, parent_node_uid, name, pv_list):
         config_dict = {

src/save_and_restore_api/_api_threads.py

@@ -44,5 +44,22 @@ def login(self, *, username=None, password=None):
         return self.send_request(method, url, params=params)
 
     def get_node(self, node_uid):
+        """
+        Returns the node with specified node UID.
+        """
         method, url = self._prepare_get_node(node_uid=node_uid)
         return self.send_request(method, url)
+
+    def add_node(self, parentNodeId, *, name, nodeType, **kwargs):
+        method, url, params = self._prepare_add_node(
+            parentNodeId=parentNodeId, name=name, nodeType=nodeType, **kwargs
+        )
+        return self.send_request(method, url, params=params)
+
+    def delete_nodes(self, uniqueIds):
+        method, url, params = self._prepare_delete_nodes(uniqueIds=uniqueIds)
+        return self.send_request(method, url, params=params)
+
+    def get_children(self, node_uid):
+        method, url = self._prepare_get_children(node_uid=node_uid)
+        return self.send_request(method, url)

tests/common.py

@@ -1,7 +1,53 @@
+import pytest
+
+from save_and_restore_api import SaveRestoreAPI
+
+base_url = "http://localhost:8080/save-restore"
+
+admin_username, admin_password = "admin", "adminPass"
+user_username, user_password = "user", "userPass"
+read_username, read_password = "johndoe", "1234"
+
+
 def _is_async(library):
     if library == "ASYNC":
         return True
     elif library == "THREADS":
         return False
     else:
         raise ValueError(f"Unknown library: {library!r}")
+
+
+@pytest.fixture
+def clear_sar():
+    """
+    Clear save-and-restore database before and after the experiment.
+    """
+
+    def _clear():
+        """
+        Remove all nodes from the database.
+        """
+        with SaveRestoreAPI(base_url=base_url, timeout=2) as SR:
+            SR.set_auth(username=user_username, password=user_password)
+
+            # Create all nodes. Children always follow the parent
+            n_uid = 0
+            uids = [SR.ROOT_NODE_UID]
+            while n_uid < len(uids):
+                uid = uids[n_uid]
+                res_1 = SR.get_node(uid)
+                if res_1["nodeType"] == "FOLDER":
+                    res_2 = SR.get_children(uid)
+                    ch_uids = [_["uniqueId"] for _ in res_2]
+                    if ch_uids:
+                        uids.extend(ch_uids)
+                n_uid += 1
+
+            # Delete all nodes starting with children
+            for uid in reversed(uids[1:]):
+                SR.delete_nodes([uid])
+
+    _clear()
+    yield
+    _clear()

tests/test_package.py

@@ -9,13 +9,17 @@
 from save_and_restore_api import SaveRestoreAPI as SaveRestoreAPI_Threads
 from save_and_restore_api.aio import SaveRestoreAPI as SaveRestoreAPI_Async
 
-from .common import _is_async
-
-admin_username, admin_password = "admin", "adminPass"
-user_username, user_password = "user", "userPass"
-read_username, read_password = "johndoe", "1234"
-
-base_url = "http://localhost:8080/save-restore"
+from .common import (
+    _is_async,
+    admin_password,
+    admin_username,
+    base_url,
+    clear_sar,  # noqa: F401
+    read_password,
+    read_username,
+    user_password,
+    user_username,
+)
 
 
 def test_version_01():
@@ -77,7 +81,6 @@ def test_login_01(username, password, roles, library, code):
     """
     if not _is_async(library):
         with SaveRestoreAPI_Threads(base_url=base_url, timeout=2) as SR:
-            SR.open()
             if code == 200:
                 response = SR.login(username=username, password=password)
                 assert response["userName"] == username
@@ -88,7 +91,6 @@ def test_login_01(username, password, roles, library, code):
     else:
         async def testing():
             async with SaveRestoreAPI_Async(base_url=base_url, timeout=2) as SR:
-                SR.open()
                 if code == 200:
                     response = await SR.login(username=username, password=password)
                     assert response["userName"] == username
@@ -107,13 +109,12 @@ async def testing():
     ("abc", 404),
 ])
 # fmt: on
-def test_get_node_01(node_uid, library, code):
+def test_get_node_01(clear_sar, node_uid, library, code):  # noqa: F811
     """
     Tests for the 'login' API.
     """
     if not _is_async(library):
         with SaveRestoreAPI_Threads(base_url=base_url, timeout=2) as SR:
-            SR.open()
             if code == 200:
                 response = SR.get_node(node_uid)
                 assert response["uniqueId"] == node_uid
@@ -123,7 +124,6 @@ def test_get_node_01(node_uid, library, code):
     else:
         async def testing():
             async with SaveRestoreAPI_Async(base_url=base_url, timeout=2) as SR:
-                SR.open()
                 if code == 200:
                     response = await SR.get_node(node_uid)
                     assert response["uniqueId"] == node_uid
@@ -134,8 +134,62 @@ async def testing():
         asyncio.run(testing())
 
 
+# fmt: off
+@pytest.mark.parametrize("library", ["THREADS", "ASYNC"])
+# fmt: on
+def test_add_node_01(clear_sar, library):  # noqa: F811
+    """
+    Tests for the 'add_node' API.
+    """
+    if not _is_async(library):
+        with SaveRestoreAPI_Threads(base_url=base_url, timeout=2) as SR:
+            SR.set_auth(username=user_username, password=user_password)
+
+            response = SR.add_node(SR.ROOT_NODE_UID, name="Test Folder", nodeType="FOLDER")
+            assert response["name"] == "Test Folder"
+            assert response["nodeType"] == "FOLDER"
+            folder_uid = response["uniqueId"]
+
+            response = SR.add_node(folder_uid, name="Test Config 1", nodeType="CONFIGURATION")
+            assert response["name"] == "Test Config 1"
+            assert response["nodeType"] == "CONFIGURATION"
+            node_uid_1 = response["uniqueId"]
+
+            response = SR.add_node(folder_uid, name="Test Config 2", nodeType="CONFIGURATION")
+            assert response["name"] == "Test Config 2"
+            assert response["nodeType"] == "CONFIGURATION"
+            node_uid_2 = response["uniqueId"]
+
+            SR.delete_nodes([node_uid_1, node_uid_2])
+            SR.delete_nodes([folder_uid])
+
+    else:
+        async def testing():
+            async with SaveRestoreAPI_Async(base_url=base_url, timeout=2) as SR:
+                SR.set_auth(username=user_username, password=user_password)
+
+                response = await SR.add_node(SR.ROOT_NODE_UID, name="Test Folder", nodeType="FOLDER")
+                assert response["name"] == "Test Folder"
+                assert response["nodeType"] == "FOLDER"
+                folder_uid = response["uniqueId"]
+
+                response = await SR.add_node(folder_uid, name="Test Config 1", nodeType="CONFIGURATION")
+                assert response["name"] == "Test Config 1"
+                assert response["nodeType"] == "CONFIGURATION"
+                node_uid_1 = response["uniqueId"]
+
+                response = await SR.add_node(folder_uid, name="Test Config 2", nodeType="CONFIGURATION")
+                assert response["name"] == "Test Config 2"
+                assert response["nodeType"] == "CONFIGURATION"
+                node_uid_2 = response["uniqueId"]
+
+                await SR.delete_nodes([node_uid_1, node_uid_2])
+                await SR.delete_nodes([folder_uid])
+
+        asyncio.run(testing())
+
 
-def test_comm():
+def test_comm(clear_sar):  # noqa: F811
     SR = SaveRestoreAPI_Threads(base_url=base_url, timeout=2)
     SR.set_auth(username=user_username, password=user_password)
     SR.open()