ENH: testing for 'login' API

Author: dmgav

src/save_and_restore_api/_api_async.py

@@ -34,7 +34,7 @@ async def send_request(
 
     async def login(self, *, username=None, password=None):
         method, url, params = self._prepare_login(username=username, password=password)
-        await self.send_request(method, url, params=params)
+        return await self.send_request(method, url, params=params)
 
     async def get_node(self, node_uid):
         method, url = self._prepare_get_node(node_uid=node_uid)

src/save_and_restore_api/_api_threads.py

@@ -34,7 +34,7 @@ def send_request(
 
     def login(self, *, username=None, password=None):
         method, url, params = self._prepare_login(username=username, password=password)
-        self.send_request(method, url, params=params)
+        return self.send_request(method, url, params=params)
 
     def get_node(self, node_uid):
         method, url = self._prepare_get_node(node_uid=node_uid)

tests/common.py

@@ -0,0 +1,7 @@
+def _is_async(library):
+    if library == "ASYNC":
+        return True
+    elif library == "THREADS":
+        return False
+    else:
+        raise ValueError(f"Unknown library: {library!r}")

tests/test_package.py

@@ -2,7 +2,9 @@
 
 import importlib.metadata
 
+import asyncio
 import pytest
+from .common import _is_async
 
 import save_and_restore_api
 from save_and_restore_api import SaveRestoreAPI as SaveRestoreAPI_Threads
@@ -19,6 +21,36 @@ def test_version():
     assert importlib.metadata.version("save_and_restore_api") == save_and_restore_api.__version__
 
 
+# fmt: off
+@pytest.mark.parametrize("library", ["THREADS", "ASYNC"])
+@pytest.mark.parametrize("username, password, roles", [
+    (admin_username, admin_password,  ["ROLE_SAR-ADMIN"]),
+    (user_username, user_password,  ["ROLE_SAR-USER"]),
+    (read_username, read_password,  []),
+])
+# fmt: on
+def test_login_01(username, password, roles, library):
+    if not _is_async(library):
+        SR = SaveRestoreAPI_Threads(base_url=base_url, timeout=2)
+        SR.set_auth(username=user_username, password=user_password)
+        SR.open()
+        response = SR.login(username=username, password=password)
+        SR.close()
+        assert response["userName"] == username
+        assert response["roles"] == roles
+    else:
+        async def testing():
+            SR = SaveRestoreAPI_Threads(base_url=base_url, timeout=2)
+            SR.set_auth(username=user_username, password=user_password)
+            SR.open()
+            response = SR.login(username=username, password=password)
+            SR.close()
+            assert response["userName"] == username
+            assert response["roles"] == roles
+
+        asyncio.run(testing())
+
+
 def test_comm():
     SR = SaveRestoreAPI_Threads(base_url=base_url, timeout=2)
     SR.set_auth(username=user_username, password=user_password)