Added status code handler

Author: Rasmus Oscar Welander

src/auth.py

@@ -3,14 +3,14 @@
 
 Authors: Rasmus Welander, Diogo Castro, Giuseppe Lo Presti.
 Emails: [email protected], [email protected], [email protected]
-Last updated: 01/08/2024
+Last updated: 19/08/2024
 """
 
 import grpc
 import jwt
 import datetime
 import logging
-import cs3.gateway.v1beta1.gateway_api_pb2 as gw
+from cs3.gateway.v1beta1.gateway_api_pb2 import AuthenticateRequest
 from cs3.auth.registry.v1beta1.registry_api_pb2 import ListAuthProvidersRequest
 from cs3.gateway.v1beta1.gateway_api_pb2_grpc import GatewayAPIStub
 from cs3.rpc.v1beta1.code_pb2 import CODE_OK
@@ -67,8 +67,8 @@ def get_token(self) -> tuple[str, str]:
         the credentials have expired.
 
         :return tuple: A tuple containing the header key and the token.
-                       May throw AuthenticationException (token expired, or failed to authenticate)
-                       or SecretNotSetException (neither token or client secret was set).
+        :raises: AuthenticationException (token expired, or failed to authenticate)
+        :raises: SecretNotSetException (neither token or client secret was set)
         """
 
         if not Auth._check_token(self._token):
@@ -81,7 +81,7 @@ def get_token(self) -> tuple[str, str]:
                 self._log.error("The provided token have expired")
                 raise AuthenticationException("The credentials have expired")
             # Create an authentication request
-            req = gw.AuthenticateRequest(
+            req = AuthenticateRequest(
                 type=self._config.auth_login_type,
                 client_id=self._config.auth_client_id,
                 client_secret=self._client_secret,
@@ -90,26 +90,25 @@ def get_token(self) -> tuple[str, str]:
             res = self._gateway.Authenticate(req)
 
             if res.status.code != CODE_OK:
-                self._log.error(
-                    f"Failed to authenticate user {self._config.auth_client_id}, error: {res.status.message}"
-                )
+                self._log.error(f"Failed to authenticate user {self._config.auth_client_id}, error: {res.status}")
                 raise AuthenticationException(
-                    f"Failed to authenticate user {self._config.auth_client_id}, error: {res.status.message}"
+                    f"Failed to authenticate user {self._config.auth_client_id}, error: {res.status}"
                 )
             self._token = res.token
+        self._log.debug(f'msg="Authenticated user" user="{self._config.auth_client_id}"')
         return ("x-access-token", self._token)
 
     def list_auth_providers(self) -> list[str]:
         """
         list authentication providers
 
         :return: a list of the supported authentication types
-                 May return ConnectionError (Could not connect to host)
+        :raises: ConnectionError (Could not connect to host)
         """
         try:
             res = self._gateway.ListAuthProviders(request=ListAuthProvidersRequest())
             if res.status.code != CODE_OK:
-                self._log.error(f"List auth providers request failed, error: {res.status.message}")
+                self._log.error(f"List auth providers request failed, error: {res.status}")
                 raise Exception(res.status.message)
         except grpc.RpcError as e:
             self._log.error("List auth providers request failed")

src/cs3client.py

@@ -3,7 +3,7 @@
 
 Authors: Rasmus Welander, Diogo Castro, Giuseppe Lo Presti.
 Emails: [email protected], [email protected], [email protected]
-Last updated: 01/08/2024
+Last updated: 19/08/2024
 """
 
 import grpc
@@ -14,6 +14,10 @@
 from auth import Auth
 from file import File
 from user import User
+from share import Share
+from statuscodehandler import StatusCodeHandler
+from app import App
+from checkpoint import Checkpoint
 from config import Config
 
 
@@ -39,10 +43,17 @@ def __init__(self, config: ConfigParser, config_category: str, log: logging.Logg
         except grpc.FutureTimeoutError as e:
             log.error(f'msg="Failed to connect to Reva via GRPC" error="{e}"')
             raise TimeoutError("Failed to connect to Reva via GRPC")
+
         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)
+        self._status_code_handler: StatusCodeHandler = StatusCodeHandler(self._log, self._config)
+        self.auth: Auth = Auth(self._config, self._log, self._gateway)
+        self.file: File = File(self._config, self._log, self._gateway, self.auth, self._status_code_handler)
+        self.user: User = User(self._config, self._log, self._gateway, self.auth, self._status_code_handler)
+        self.app: App = App(self._config, self._log, self._gateway, self.auth, self._status_code_handler)
+        self.checkpoint: Checkpoint = Checkpoint(
+            self._config, self._log, self._gateway, self.auth, self._status_code_handler
+        )
+        self.share = Share(self._config, self._log, self._gateway, self.auth, self._status_code_handler)
 
     def _create_channel(self) -> grpc.Channel:
         """

src/cs3resource.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: 19/08/2024
 """
 
 import cs3.storage.provider.v1beta1.resources_pb2 as cs3spr
@@ -94,7 +94,7 @@ def ref(self) -> cs3spr.Reference:
         absolute path, relative hybrid path, fully opaque fileid.
 
         :return: The cs3 reference.
-                 May throw ValueError (Invalid Resource)
+        :raises: ValueError (Invalid Resource)
         """
         if self._abs_path:
             return cs3spr.Reference(path=self._abs_path)
@@ -123,7 +123,7 @@ def recreate_endpoint_and_file(self) -> dict:
         Recreates the endpoint and file reference from the given resource
 
         :return: (dict) {"file": fileref, "endpoint": endpoint}
-                 May throw ValueError (invalid resource)
+        :raises: ValueError (invalid resource)
         """
         endpoint = self._storage_id
         if self._space_id:
@@ -139,11 +139,11 @@ def recreate_endpoint_and_file(self) -> dict:
     @classmethod
     def from_cs3_ref(cls, reference: cs3spr.Reference) -> "Resource":
         """
-        Alternate constructor that reverses a CS3 reference to obtain a resource.ß
+        Alternate constructor that reverses a CS3 reference to obtain a resource.
 
         :param reference: The CS3 reference.
         :return: Resource object.
-                 May throw ValueError (Invalid reference)
+        :raises: ValueError (Invalid reference)
         """
         rel_path = None
         opaque_id = None
@@ -161,7 +161,7 @@ def from_cs3_ref(cls, reference: cs3spr.Reference) -> "Resource":
             if reference.path and len(reference.path) > 1:
                 # It's a relative path (remove the "." in the relative path)
                 rel_path = reference.path[1:]
-                # The opaque_id is a parent id since it's a relative pathß
+                # The opaque_id is a parent id since it's a relative path
                 parent_id = reference.resource_id.opaque_id
             else:
                 opaque_id = reference.resource_id.opaque_id

src/exceptions/exceptions.py

@@ -38,8 +38,8 @@ def __init__(self, message: str = ""):
 
 class FileLockedException(IOError):
     """
-    Standard error thrown when attempting to overwrite a file/xattr or when
-    a lock operation cannot be performed because of failed preconditions
+    Standard error thrown when attempting to overwrite a file/xattr with a mistmatched lock,
+    or when a lock operation cannot be performed because of failed preconditions
     """
 
     def __init__(self, message: str = ""):
@@ -53,3 +53,12 @@ class UnknownException(Exception):
 
     def __init__(self, message: str = ""):
         super().__init__(message)
+
+
+class AlreadyExistsException(IOError):
+    """
+    Standard error thrown when attempting to create a resource that already exists
+    """
+
+    def __init__(self, message: str = ""):
+        super().__init__(message)