From c9bae773a3d917a3df704c65f702c55489112ef1 Mon Sep 17 00:00:00 2001
From: kiarash kiani <kiarash@datachef.co>
Date: Thu, 1 Aug 2024 17:34:53 +0200
Subject: [PATCH] feat(object_storage): improved the error handlings

---
 src/damavand/cloud/aws/bucket.py | 60 ++++++++++++++++++++++----------
 src/damavand/errors.py           | 28 +++++++++++++--
 src/damavand/utils.py            |  6 ++++
 3 files changed, 74 insertions(+), 20 deletions(-)

diff --git a/src/damavand/cloud/aws/bucket.py b/src/damavand/cloud/aws/bucket.py
index db8e9c9..1d617a5 100644
--- a/src/damavand/cloud/aws/bucket.py
+++ b/src/damavand/cloud/aws/bucket.py
@@ -6,9 +6,15 @@
 from pulumi_aws import s3
 from pulumi import Resource as PulumiResource
 
-from damavand.errors import BuildtimeError
+from damavand import utils
 from damavand.resource import BaseObjectStorage
 from damavand.resource.resource import buildtime, runtime
+from damavand.errors import (
+    CallResourceBeforeProvision,
+    RuntimeException,
+    ObjectNotFound,
+    ResourceAccessDenied,
+)
 
 
 logger = logging.getLogger(__name__)
@@ -50,8 +56,12 @@ def write(self, object: bytes, path: str):
                 Key=path,
             )
         except ClientError as e:
-            logger.error(f"Failed to add object to bucket `{self.name}`: {e}")
-            raise RuntimeError(e)
+            match utils.error_code_from_boto3(e):
+                case "AccessDenied":
+                    raise ResourceAccessDenied(name=self.name)
+                case _:
+                    logger.exception("Failed to write the object to AWS.")
+                    raise RuntimeException()
 
     @runtime
     def read(self, path: str) -> bytes:
@@ -63,16 +73,26 @@ def read(self, path: str) -> bytes:
 
             return buffer.getvalue()
         except ClientError as e:
-            logger.error(f"Failed to read object at `{path}`: {e}")
-            raise RuntimeError(e)
+            match utils.error_code_from_boto3(e):
+                case "AccessDenied":
+                    raise ResourceAccessDenied(name=self.name)
+                case "NoSuchKey":
+                    raise ObjectNotFound(name=path)
+                case _:
+                    logger.exception("Failed to read the object from AWS")
+                    raise RuntimeException()
 
     @runtime
     def delete(self, path: str):
         try:
             self.__s3_client.delete_object(Bucket=self.name, Key=path)
         except ClientError as e:
-            logger.error(f"Failed to delete object at `{path}`: {e}")
-            raise RuntimeError(e)
+            match utils.error_code_from_boto3(e):
+                case "AccessDenied":
+                    raise ResourceAccessDenied(name=self.name)
+                case _:
+                    logger.exception("Failed to delete the object from AWS.")
+                    raise RuntimeException()
 
     @runtime
     def list(self) -> Iterable[str]:
@@ -87,8 +107,12 @@ def list(self) -> Iterable[str]:
                 for obj in page.get("Contents", []):
                     yield obj["Key"]
         except ClientError as e:
-            logger.error(f"Failed to list objects in storage `{self.name}`: {e}")
-            raise RuntimeError(e)
+            match utils.error_code_from_boto3(e):
+                case "AccessDenied":
+                    raise ResourceAccessDenied(name=self.name)
+                case _:
+                    logger.exception("Failed to list objects from AWS.")
+                    raise RuntimeException()
 
     @runtime
     def exist(self, path: str) -> bool:
@@ -97,18 +121,18 @@ def exist(self, path: str) -> bool:
             self.__s3_client.head_object(Bucket=self.name, Key=path)
             return True
         except ClientError as e:
-            error_code = e.response.get("Error", {}).get("Code")
-            if error_code == "404":
-                return False
-            else:
-                logger.error(f"Failed to check object existence at `{path}`: {e}")
-                raise RuntimeError(e)
+            match utils.error_code_from_boto3(e):
+                case "NoSuchKey":
+                    return False
+                case "AccessDenied":
+                    raise ResourceAccessDenied(name=self.name)
+                case _:
+                    logger.exception("Failed to check the object existence in AWS.")
+                    raise RuntimeException()
 
     @buildtime
     def to_pulumi(self) -> PulumiResource:
         if self._pulumi_object is None:
-            raise BuildtimeError(
-                "Resource not provisioned yet. Call `provision` method first."
-            )
+            raise CallResourceBeforeProvision()
 
         return self._pulumi_object
diff --git a/src/damavand/errors.py b/src/damavand/errors.py
index f938223..0b0a2dc 100644
--- a/src/damavand/errors.py
+++ b/src/damavand/errors.py
@@ -1,2 +1,26 @@
-class BuildtimeError(Exception):
-    pass
+class DamavandException(Exception):
+    fmt = "An unknown error occurred."
+
+    def __init__(self, **kwargs: str) -> None:
+        msg = self.fmt.format(**kwargs)
+        super().__init__(msg)
+
+
+class BuildtimeException(DamavandException):
+    fmt = "An unknown error occurred during buildtime."
+
+
+class CallResourceBeforeProvision(BuildtimeException):
+    fmt = "Resource called before provision. Call `provision` method first."
+
+
+class RuntimeException(DamavandException):
+    fmt = "An unknown error occurred happend during runtime."
+
+
+class ResourceAccessDenied(RuntimeException):
+    fmt = "Access to resource `{name}` is denied."
+
+
+class ObjectNotFound(RuntimeException):
+    fmt = "Object `{name}` not found in the storage."
diff --git a/src/damavand/utils.py b/src/damavand/utils.py
index 6b2893c..4c747c9 100644
--- a/src/damavand/utils.py
+++ b/src/damavand/utils.py
@@ -5,3 +5,9 @@ def is_building():
     """Check if the application is being built or run"""
 
     return os.environ.get("MODE", "RUN") == "BUILD"
+
+
+def error_code_from_boto3(e):
+    """Extract error code from boto3 exception"""
+
+    return e.response.get("Error", {}).get("Code")