Merge pull request #72 from oslokommune/DP-1944-permission-client-tests

DP-1944 Add unit tests for the permission client

Author: simenheg

CHANGELOG.md

@@ -1,3 +1,7 @@
+## ?.?.?
+
+* Added support for the new [permission API](https://github.com/oslokommune/okdata-permission-api).
+
 ## 0.7.0
 
 * `Dataset.update_dataset` now supports partial metadata updates when the

okdata/sdk/permission/client.py

@@ -47,7 +47,15 @@ def update_permission(
         return self.put(url, data, retries=retries).json()
 
     def get_my_permissions(self, retries=0):
-        """Return a list of permissions associated with the current user."""
+        """Return a dictionary of permissions associated with the current user.
+
+        The dictionary is on the form:
+
+          {
+            "resource-name-1": {"scopes": ["scope-1", "scope-2"]},
+            "resource-name-2": ...
+          }
+        """
         url = f"{self.api_url}/my_permissions"
         log.info(f"SDK:Listing permissions from: {url}")
         return self.get(url, retries=retries).json()

tests/permission/test_client.py

@@ -0,0 +1,52 @@
+import re
+import json
+
+from okdata.sdk.permission.client import PermissionClient
+from okdata.sdk.permission.user_types import User
+
+
+def test_update_permission(requests_mock):
+    client = PermissionClient()
+    matcher = re.compile("permissions/okdata%3Adataset%3Afoo")
+    res = {
+        "resource_name": "okdata:dataset:foo",
+        "description": "Allows reading okdata:dataset:foo",
+        "scope": "okdata:dataset:read",
+        "teams": [],
+        "users": ["janedoe"],
+        "clients": [],
+    }
+    requests_mock.register_uri("PUT", matcher, text=json.dumps(res), status_code=200)
+    assert (
+        client.update_permission(
+            "okdata:dataset:foo", "okdata:dataset:read", add_users=[User("janedoe")]
+        )
+        == res
+    )
+
+
+def test_get_my_permissions(requests_mock):
+    client = PermissionClient()
+    matcher = re.compile("my_permissions")
+    res = {
+        "okdata:dataset:foo": {"scopes": ["okdata:dataset:read"]},
+    }
+    requests_mock.register_uri("GET", matcher, text=json.dumps(res), status_code=200)
+    assert client.get_my_permissions() == res
+
+
+def test_get_permissions(requests_mock):
+    client = PermissionClient()
+    matcher = re.compile("permissions/okdata%3Adataset%3Afoo")
+    res = [
+        {
+            "resource_name": "okdata:dataset:foo",
+            "description": "Allows reading okdata:dataset:foo",
+            "scope": "okdata:dataset:read",
+            "teams": [],
+            "users": ["janedoe"],
+            "clients": [],
+        }
+    ]
+    requests_mock.register_uri("GET", matcher, text=json.dumps(res), status_code=200)
+    assert client.get_permissions("okdata:dataset:foo") == res