Fixed SDK | Wrong log for create_folder

Author: Vaghinak Basentsyan

src/superannotate/lib/app/interface/sdk_interface.py

@@ -334,7 +334,7 @@ def create_folder(project: NotEmptyStr, folder_name: NotEmptyStr):
             logger.warning(
                 f"Created folder has name {folder.name}, since folder with name {folder_name} already existed.",
             )
-        logger.info(f"Folder {folder_name} created in project {project}")
+        logger.info(f"Folder {folder.name} created in project {project}")
         return folder.to_dict()
     if res.errors:
         raise AppException(res.errors)
@@ -389,7 +389,7 @@ def get_folder_metadata(project: NotEmptyStr, folder_name: NotEmptyStr):
     """
     result = controller.get_folder(project_name=project, folder_name=folder_name).data
     if not result:
-        raise EmptyOutputError("Folder not found.")
+        raise AppException("Folder not found.")
     return result.to_dict()
 
 
@@ -447,7 +447,7 @@ def rename_folder(project: Union[NotEmptyStr, dict], new_folder_name: NotEmptySt
     if res.errors:
         raise AppException(res.errors)
     logger.info(
-        f"Folder {folder_name} renamed to {new_folder_name} in project {project_name}"
+        f"Folder {folder_name} renamed to {res.data.name} in project {project_name}"
     )
 
 

src/superannotate/lib/core/usecases.py

@@ -316,7 +316,7 @@ def validate_project_name(self):
             if self._projects.get_all(condition):
                 logger.error("There are duplicated names.")
                 raise AppValidationException(
-                    f"Project name {self._project.name} is not unique. "
+                    f"Project name {self._project_data['name']} is not unique. "
                     f"To use SDK please make project names unique."
                 )
 
@@ -667,26 +667,25 @@ def __init__(
     def validate_folder(self):
         if not self._folder.name:
             raise AppValidationException("Folder name cannot be empty.")
-
-    def execute(self):
-        if self.is_valid():
-            if (
+        if (
                 len(
                     set(self._folder.name).intersection(
                         constances.SPECIAL_CHARACTERS_IN_PROJECT_FOLDER_NAMES
                     )
                 )
                 > 0
-            ):
-                self._folder.name = "".join(
-                    "_"
-                    if char in constances.SPECIAL_CHARACTERS_IN_PROJECT_FOLDER_NAMES
-                    else char
-                    for char in self._folder.name
-                )
-                logger.warning(
-                    "New folder name has special characters. Special characters will be replaced by underscores."
-                )
+        ):
+            self._folder.name = "".join(
+                "_"
+                if char in constances.SPECIAL_CHARACTERS_IN_PROJECT_FOLDER_NAMES
+                else char
+                for char in self._folder.name
+            )
+            logger.warning(
+                "New folder name has special characters. Special characters will be replaced by underscores."
+            )
+    def execute(self):
+        if self.is_valid():
             self._folder.project_id = self._project.uuid
             self._response.data = self._folders.insert(self._folder)
         return self._response
@@ -1009,11 +1008,33 @@ def __init__(
         self._folders = folders
         self._folder = folder
 
+    def validate_folder(self):
+        if not self._folder.name:
+            raise AppValidationException("Folder name cannot be empty.")
+        if (
+                len(
+                    set(self._folder.name).intersection(
+                        constances.SPECIAL_CHARACTERS_IN_PROJECT_FOLDER_NAMES
+                    )
+                )
+                > 0
+        ):
+            self._folder.name = "".join(
+                "_"
+                if char in constances.SPECIAL_CHARACTERS_IN_PROJECT_FOLDER_NAMES
+                else char
+                for char in self._folder.name
+            )
+            logger.warning(
+                "New folder name has special characters. Special characters will be replaced by underscores."
+            )
+
     def execute(self):
-        is_updated = self._folders.update(self._folder)
-        if not is_updated:
-            self._response.errors = AppException("Couldn't rename folder.")
-        self._response.data = self._folder
+        if self.is_valid():
+            is_updated = self._folders.update(self._folder)
+            if not is_updated:
+                self._response.errors = AppException("Couldn't rename folder.")
+            self._response.data = self._folder
         return self._response
 
 

tests/integration/test_folders.py

@@ -13,6 +13,7 @@ class TestFolders(BaseTestCase):
     TEST_FOLDER_PATH = "data_set/sample_project_vector"
     PROJECT_DESCRIPTION = "desc"
     PROJECT_TYPE = "Vector"
+    SPECIAL_CHARS = "/\:*?“<>|"
     TEST_FOLDER_NAME_1 = "folder_1"
     TEST_FOLDER_NAME_2 = "folder_2"
     EXAMPLE_IMAGE_1_NAME = "example_image_1"
@@ -505,3 +506,17 @@ def test_folder_misnamed(self):
         self.assertTrue(
             f"{self.TEST_FOLDER_NAME_2}_" in sa.search_folders(self.PROJECT_NAME)
         )
+
+    def test_create_folder_with_special_chars(self):
+        sa.create_folder(self.PROJECT_NAME, self.SPECIAL_CHARS)
+        folder = sa.get_folder_metadata(self.PROJECT_NAME, "_"*len(self.SPECIAL_CHARS))
+        self.assertIsNotNone(folder)
+
+    def test_rename_folder_to_existing_name(self):
+        sa.create_folder(self.PROJECT_NAME, self.TEST_FOLDER_NAME_1)
+        sa.create_folder(self.PROJECT_NAME, "_"*len(self.SPECIAL_CHARS))
+        sa.rename_folder(f"{self.PROJECT_NAME}/{self.TEST_FOLDER_NAME_1}", self.SPECIAL_CHARS)
+        folder = sa.get_folder_metadata(self.PROJECT_NAME, "_" * len(self.SPECIAL_CHARS) + " (1)")
+        self.assertIsNotNone(folder)
+
+