Standardized error messages

Author: glpatcern

cs3client/exceptions/exceptions.py

@@ -2,6 +2,7 @@
 exceptions.py
 
 Custom exception classes for the CS3 client.
+Where applicable, the default values correspond to the Linux standard error strings.
 
 Authors: Rasmus Welander, Diogo Castro, Giuseppe Lo Presti.
 Emails: rasmus.oscar.welander@cern.ch, diogo.castro@cern.ch, giuseppe.lopresti@cern.ch
@@ -14,7 +15,7 @@ class AuthenticationException(Exception):
     Standard error thrown when attempting an operation without the required access rights
     """
 
-    def __init__(self, message: str = ""):
+    def __init__(self, message: str = "Operation not permitted"):
         super().__init__(message)
 
 
@@ -23,7 +24,7 @@ class NotFoundException(IOError):
     Standard file missing message
     """
 
-    def __init__(self, message: str = ""):
+    def __init__(self, message: str = "No such file or directory"):
         super().__init__(message)
 
 
@@ -32,7 +33,7 @@ class SecretNotSetException(Exception):
     Standard file missing message
     """
 
-    def __init__(self, message: str = ""):
+    def __init__(self, message: str = "Secret was not set, unable to authenticate"):
         super().__init__(message)
 
 
@@ -42,7 +43,7 @@ class FileLockedException(IOError):
     or when a lock operation cannot be performed because of failed preconditions
     """
 
-    def __init__(self, message: str = ""):
+    def __init__(self, message: str = "Lock mismatch"):
         super().__init__(message)
 
 
@@ -60,7 +61,7 @@ class AlreadyExistsException(IOError):
     Standard error thrown when attempting to create a resource that already exists
     """
 
-    def __init__(self, message: str = ""):
+    def __init__(self, message: str = "File exists"):
         super().__init__(message)
 
 
@@ -69,5 +70,5 @@ class UnimplementedException(Exception):
     Standard error thrown when attempting to use a feature that is not implemented
     """
 
-    def __init__(self, message: str = ""):
+    def __init__(self, message: str = "Not implemented"):
         super().__init__(message)

cs3client/statuscodehandler.py

@@ -75,31 +75,23 @@ def handle_errors(self, status: cs3status.Status, operation: str, msg: str = Non
 
         if status.code == cs3code.CODE_FAILED_PRECONDITION or status.code == cs3code.CODE_ABORTED:
             self._log_precondition_info(status, operation, status_message, msg)
-            raise FileLockedException(f'Failed precondition: operation="{operation}" '
-                                      f'status_code="{status.code}"  message="{status.message}"')
+            raise FileLockedException
         if status.code == cs3code.CODE_ALREADY_EXISTS:
             self._log_already_exists(status, operation, status_message, msg)
-            raise AlreadyExistsException(f'Resource already exists: operation="{operation}" '
-                                         f'status_code="{status.code}" message="{status.message}"')
+            raise AlreadyExistsException
         if status.code == cs3code.CODE_UNIMPLEMENTED:
             self._log.info(f'msg="Invoked {operation} on unimplemented feature" ')
-            raise UnimplementedException(f'Unimplemented feature: operation="{operation}" '
-                                         f'status_code="{status.code}" message="{status.message}"')
+            raise UnimplementedException
         if status.code == cs3code.CODE_NOT_FOUND:
             self._log_not_found_info(status, operation, status_message, msg)
-            raise NotFoundException(f'Not found: operation="{operation}" '
-                                    f'status_code="{status.code}" message="{status.message}"')
+            raise NotFoundException
         if status.code == cs3code.CODE_UNAUTHENTICATED:
             self._log_authentication_error(status, operation, status_message, msg)
-            raise AuthenticationException(f'Operation not permitted: operation="{operation}" '
-                                          f'status_code="{status.code}" message="{status.message}"')
+            raise AuthenticationException
         if status.code != cs3code.CODE_OK:
             if "path not found" in str(status.message).lower():
                 self._log.info(f'msg="Invoked {operation} on missing file" ')
-                raise NotFoundException(
-                    message=f'No such file or directory: operation="{operation}" '
-                            f'status_code="{status.code}" message="{status.message}"'
-                )
+                raise NotFoundException
             self._log_unknown_error(status, operation, status_message, msg)
             raise UnknownException(f'Unknown Error: operation="{operation}" status_code="{status.code}" '
                                    f'message="{status.message}"')