Added user class, tests, example and some minor changes

Author: Rasmus Oscar Welander

examples/file_api_example.py

@@ -1,5 +1,5 @@
 """
-example.py
+file_api_example.py
 
 Example script to demonstrate the usage of the CS3Client class.
 Start with an empty directory and you should end up with a directory structure like this:
@@ -13,7 +13,7 @@
 
 Authors: Rasmus Welander, Diogo Castro, Giuseppe Lo Presti.
 Emails: [email protected], [email protected], [email protected]
-Last updated: 29/07/2024
+Last updated: 01/08/2024
 """
 
 import logging
@@ -28,7 +28,9 @@
 log = logging.getLogger(__name__)
 
 client = CS3Client(config, "cs3client", log)
-client.auth.set_client_secret("relativity")
+client.auth.set_token("<your_token_here>")
+# OR
+# client.auth.set_client_secret("<your_client_secret_here>")
 
 # Authentication
 print(client.auth.get_token())

examples/user_api_example.py

@@ -0,0 +1,55 @@
+"""
+user_api_example.py
+
+Example script to demonstrate the usage of the CS3Client class.
+
+
+Authors: Rasmus Welander, Diogo Castro, Giuseppe Lo Presti.
+Emails: [email protected], [email protected], [email protected]
+Last updated: 02/08/2024
+"""
+
+import logging
+import configparser
+from cs3client import CS3Client
+
+config = configparser.ConfigParser()
+with open("default.conf") as fdef:
+    config.read_file(fdef)
+# log
+log = logging.getLogger(__name__)
+
+client = CS3Client(config, "cs3client", log)
+# client.auth.set_token("<your_token_here>")
+# OR
+client.auth.set_client_secret("<your_client_secret_here>")
+
+
+res = None
+
+# find_user
+res = client.user.find_users("rwel")
+if res is not None:
+    print(res)
+
+# get_user
+res = client.user.get_user("https://auth.cern.ch/auth/realms/cern", "asdoiqwe")
+
+if res is not None:
+    print(res)
+
+# get_user_groups
+res = client.user.get_user_groups("https://auth.cern.ch/auth/realms/cern", "rwelande")
+
+if res is not None:
+    print(res)
+
+# get_user_by_claim (mail)
+res = client.user.get_user_by_claim("mail", "[email protected]")
+if res is not None:
+    print(res)
+
+# get_user_by_claim (username)
+res = client.user.get_user_by_claim("username", "rwelande")
+if res is not None:
+    print(res)

src/auth.py

@@ -3,10 +3,9 @@
 
 Authors: Rasmus Welander, Diogo Castro, Giuseppe Lo Presti.
 Emails: [email protected], [email protected], [email protected]
-Last updated: 29/07/2024
+Last updated: 01/08/2024
 """
 
-from typing import List
 import grpc
 import jwt
 import datetime
@@ -76,7 +75,7 @@ def get_token(self) -> tuple[str, str]:
             # Check that client secret or token is set
             if not self._client_secret and not self._token:
                 self._log.error("Attempted to authenticate, neither client secret or token was set.")
-                raise SecretNotSetException("")
+                raise SecretNotSetException("The client secret (e.g. token, passowrd) is not set")
             elif not self._client_secret and self._token:
                 # Case where ONLY a token is provided but it has expired
                 self._log.error("The provided token have expired")
@@ -100,7 +99,7 @@ def get_token(self) -> tuple[str, str]:
             self._token = res.token
         return ("x-access-token", self._token)
 
-    def list_auth_providers(self) -> List[str]:
+    def list_auth_providers(self) -> list[str]:
         """
         list authentication providers
 

src/cs3client.py

@@ -3,7 +3,7 @@
 
 Authors: Rasmus Welander, Diogo Castro, Giuseppe Lo Presti.
 Emails: [email protected], [email protected], [email protected]
-Last updated: 29/07/2024
+Last updated: 01/08/2024
 """
 
 import grpc
@@ -13,6 +13,7 @@
 from configparser import ConfigParser
 from auth import Auth
 from file import File
+from user import User
 from config import Config
 
 
@@ -41,6 +42,7 @@ def __init__(self, config: ConfigParser, config_category: str, log: logging.Logg
         self._gateway: cs3gw_grpc.GatewayAPIStub = cs3gw_grpc.GatewayAPIStub(self.channel)
         self.auth = Auth(self._config, self._log, self._gateway)
         self.file = File(self._config, self._log, self._gateway, self.auth)
+        self.user = User(self._config, self._log, self._gateway, self.auth)
 
     def _create_channel(self) -> grpc.Channel:
         """

src/exceptions/exceptions.py

@@ -5,7 +5,7 @@
 
 Authors: Rasmus Welander, Diogo Castro, Giuseppe Lo Presti.
 Emails: [email protected], [email protected], [email protected]
-Last updated: 29/07/2024
+Last updated: 01/08/2024
 """
 
 
@@ -15,7 +15,7 @@ class AuthenticationException(Exception):
     """
 
     def __init__(self, message: str = ""):
-        super().__init__("Operation not permitted" + " " + message)
+        super().__init__(message)
 
 
 class NotFoundException(IOError):
@@ -24,7 +24,7 @@ class NotFoundException(IOError):
     """
 
     def __init__(self, message: str = ""):
-        super().__init__("No such file or directory" + " " + message)
+        super().__init__(message)
 
 
 class SecretNotSetException(Exception):
@@ -33,17 +33,17 @@ class SecretNotSetException(Exception):
     """
 
     def __init__(self, message: str = ""):
-        super().__init__("The client secret (e.g. token, passowrd) is not set" + " " + message)
+        super().__init__(message)
 
 
 class FileLockedException(IOError):
     """
-    Standard error thrown when attempting to overwrite a file/xattr in O_EXCL mode
-    or when a lock operation cannot be performed because of failed preconditions
+    Standard error thrown when attempting to overwrite a file/xattr or when
+    a lock operation cannot be performed because of failed preconditions
     """
 
     def __init__(self, message: str = ""):
-        super().__init__("File/xattr exists but EXCL mode requested, lock mismatch or lock expired" + " " + message)
+        super().__init__(message)
 
 
 class UnknownException(Exception):

src/file.py

@@ -3,7 +3,7 @@
 
 Authors: Rasmus Welander, Diogo Castro, Giuseppe Lo Presti.
 Emails: [email protected], [email protected], [email protected]
-Last updated: 29/07/2024
+Last updated: 02/08/2024
 """
 
 import time
@@ -47,41 +47,40 @@ def _log_not_found_info(self, resource: Resource, res: any, operation: str) -> N
     def _log_precondition_info(self, resource: Resource, res: any, operation: str) -> None:
         self._log.info(
             f'msg="Failed precondition on {operation}" {resource.get_file_ref_str()} '
-            f'userid="{self._config.auth_client_id}" trace="{res.status.trace}"'
+            f'userid="{self._config.auth_client_id}" trace="{res.status.trace}" '
             f'reason="{res.status.message.replace('"', "'")}"'
         )
 
     def _log_authentication_error(self, resource: Resource, res: any, operation: str) -> None:
         self._log.error(
             f'msg="Authentication failed on {operation}" {resource.get_file_ref_str()} '
-            f'userid="{self._config.auth_client_id}" trace="{res.status.trace}"'
+            f'userid="{self._config.auth_client_id}" trace="{res.status.trace}" '
             f'reason="{res.status.message.replace('"', "'")}"'
         )
 
     def _log_unknown_error(self, resource: Resource, res: any, operation: str) -> None:
         self._log.error(
             f'msg="Failed to {operation}, unknown error" {resource.get_file_ref_str()} '
-            f'userid="{self._config.auth_client_id}" trace="{res.status.trace}"'
+            f'userid="{self._config.auth_client_id}" trace="{res.status.trace}" '
             f'reason="{res.status.message.replace('"', "'")}"'
         )
 
-    def _handle_errors(self, resource: Resource, res: any, operation: str, msg: str = "") -> None:
+    def _handle_errors(self, resource: Resource, res: any, operation: str) -> None:
         if res.status.code == cs3code.CODE_NOT_FOUND:
             self._log_not_found_info(resource, res, operation)
-            self._log.info(f'msg="Invoked {operation} on missing file" {resource.get_file_ref_str()}')
-            raise NotFoundException(message=msg)
+            raise NotFoundException(message=f"No such file or directory: {res.status.message}")
         if res.status.code in [cs3code.CODE_FAILED_PRECONDITION, cs3code.CODE_ABORTED]:
             self._log_precondition_info(resource, res, operation)
-            raise FileLockedException(message=msg)
+            raise FileLockedException(message=f"Lock mismatch or lock expired:  {res.status.message}")
         if res.status.code == cs3code.CODE_UNAUTHENTICATED:
             self._log_authentication_error(resource, res, operation)
-            raise AuthenticationException(message=msg)
+            raise AuthenticationException(message=f"Operation not permitted:  {res.status.message}")
         if res.status.code != cs3code.CODE_OK:
             if "path not found" in str(res):
                 self._log.info(f'msg="Invoked {operation} on missing file" {resource.get_file_ref_str()}')
-                raise NotFoundException(message=msg)
+                raise NotFoundException(message=f"No such file or directory:  {res.status.message}")
             self._log_unknown_error(resource, res, operation)
-            raise UnknownException(res.status.message)
+            raise UnknownException(message=f"Unknown error:  {res.status.message}")
 
     def stat(self, resource: Resource) -> cs3spr.ResourceInfo:
         """
@@ -154,7 +153,7 @@ def rename_file(self, resource: Resource, newresource: Resource) -> None:
         """
         req = cs3sp.MoveRequest(source=resource.ref, destination=newresource.ref)
         res = self._gateway.Move(request=req, metadata=[self._auth.get_token()])
-        self._handle_errors(resource, res, "rename_file")
+        self._handle_errors(resource, res, "rename file")
         self._log.debug(f'msg="Invoked renamefile" result="{res}"')
 
     def remove_file(self, resource: Resource) -> None:
@@ -254,10 +253,10 @@ def write_file(self, resource: Resource, content: str | bytes, size: int) -> Non
             self._log.info(
                 f'msg="Got conflict on PUT, file is locked" reason="{putres.reason}" {resource.get_file_ref_str()}'
             )
-            raise FileLockedException()
+            raise FileLockedException(f"Lock mismatch or lock expired: {putres.reason}")
         if putres.status_code == http.client.UNAUTHORIZED:
             self._log_authentication_error(resource, putres, "write")
-            raise AuthenticationException()
+            raise AuthenticationException(f"Operation not permitted: {putres.reason}")
         if putres.status_code != http.client.OK:
             if (
                 size == 0