Folder tests update

Author: VaghinakDev

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

@@ -24,7 +24,6 @@
     from typing import TypedDict, NotRequired, Required  # noqa
 
 import boto3
-from pydantic import StrictBool
 from pydantic import conlist
 from pydantic import constr
 from pydantic import parse_obj_as
@@ -388,10 +387,10 @@ def clone_project(
         project_name: Union[NotEmptyStr, dict],
         from_project: Union[NotEmptyStr, dict],
         project_description: Optional[NotEmptyStr] = None,
-        copy_annotation_classes: Optional[StrictBool] = True,
-        copy_settings: Optional[StrictBool] = True,
-        copy_workflow: Optional[StrictBool] = False,
-        copy_contributors: Optional[StrictBool] = False,
+        copy_annotation_classes: Optional[bool] = True,
+        copy_settings: Optional[bool] = True,
+        copy_workflow: Optional[bool] = False,
+        copy_contributors: Optional[bool] = False,
     ):
         """Create a new project in the team using annotation classes and settings from from_project.
 
@@ -578,7 +577,7 @@ def search_folders(
         project: NotEmptyStr,
         folder_name: Optional[NotEmptyStr] = None,
         status: Optional[Union[FOLDER_STATUS, List[FOLDER_STATUS]]] = None,
-        return_metadata: Optional[StrictBool] = False,
+        return_metadata: Optional[bool] = False,
     ):
         """Folder name based case-insensitive search for folders in project.
 
@@ -625,11 +624,11 @@ def search_folders(
     def get_project_metadata(
         self,
         project: Union[NotEmptyStr, dict],
-        include_annotation_classes: Optional[StrictBool] = False,
-        include_settings: Optional[StrictBool] = False,
-        include_workflow: Optional[StrictBool] = False,
-        include_contributors: Optional[StrictBool] = False,
-        include_complete_item_count: Optional[StrictBool] = False,
+        include_annotation_classes: Optional[bool] = False,
+        include_settings: Optional[bool] = False,
+        include_workflow: Optional[bool] = False,
+        include_contributors: Optional[bool] = False,
+        include_complete_item_count: Optional[bool] = False,
     ):
         """Returns project metadata
 
@@ -809,7 +808,7 @@ def pin_image(
         self,
         project: Union[NotEmptyStr, dict],
         image_name: str,
-        pin: Optional[StrictBool] = True,
+        pin: Optional[bool] = True,
     ):
         """Pins (or unpins) image
 
@@ -966,7 +965,7 @@ def upload_images_from_folder_to_project(
         exclude_file_patterns: Optional[
             Iterable[NotEmptyStr]
         ] = constants.DEFAULT_FILE_EXCLUDE_PATTERNS,
-        recursive_subfolders: Optional[StrictBool] = False,
+        recursive_subfolders: Optional[bool] = False,
         image_quality_in_editor: Optional[str] = None,
     ):
         """Uploads all images with given extensions from folder_path to the project.
@@ -1103,7 +1102,7 @@ def download_image_annotations(
         return res.data
 
     def get_exports(
-        self, project: NotEmptyStr, return_metadata: Optional[StrictBool] = False
+        self, project: NotEmptyStr, return_metadata: Optional[bool] = False
     ):
         """Get all prepared exports of the project.
 
@@ -1125,7 +1124,7 @@ def prepare_export(
         project: Union[NotEmptyStr, dict],
         folder_names: Optional[List[NotEmptyStr]] = None,
         annotation_statuses: Optional[List[ANNOTATION_STATUS]] = None,
-        include_fuse: Optional[StrictBool] = False,
+        include_fuse: Optional[bool] = False,
         only_pinned=False,
     ):
         """Prepare annotations and classes.json for export. Original and fused images for images with
@@ -1180,7 +1179,7 @@ def upload_videos_from_folder_to_project(
             Union[Tuple[NotEmptyStr], List[NotEmptyStr]]
         ] = constants.DEFAULT_VIDEO_EXTENSIONS,
         exclude_file_patterns: Optional[List[NotEmptyStr]] = (),
-        recursive_subfolders: Optional[StrictBool] = False,
+        recursive_subfolders: Optional[bool] = False,
         target_fps: Optional[int] = None,
         start_time: Optional[float] = 0.0,
         end_time: Optional[float] = None,
@@ -1513,7 +1512,7 @@ def download_export(
         project: Union[NotEmptyStr, dict],
         export: Union[NotEmptyStr, dict],
         folder_path: Union[str, Path],
-        extract_zip_contents: Optional[StrictBool] = True,
+        extract_zip_contents: Optional[bool] = True,
         to_s3_bucket=None,
     ):
         """Download prepared export.
@@ -1572,9 +1571,9 @@ def download_image(
         project: Union[NotEmptyStr, dict],
         image_name: NotEmptyStr,
         local_dir_path: Optional[Union[str, Path]] = "./",
-        include_annotations: Optional[StrictBool] = False,
-        include_fuse: Optional[StrictBool] = False,
-        include_overlay: Optional[StrictBool] = False,
+        include_annotations: Optional[bool] = False,
+        include_fuse: Optional[bool] = False,
+        include_overlay: Optional[bool] = False,
         variant: Optional[str] = "original",
     ):
         """Downloads the image (and annotation if not None) to local_dir_path
@@ -1659,7 +1658,7 @@ def upload_annotations_from_folder_to_project(
         project: Union[NotEmptyStr, dict],
         folder_path: Union[str, Path],
         from_s3_bucket=None,
-        recursive_subfolders: Optional[StrictBool] = False,
+        recursive_subfolders: Optional[bool] = False,
         keep_status=False,
     ):
         """Finds and uploads all JSON files in the folder_path as annotations to the project.
@@ -1733,7 +1732,7 @@ def upload_image_annotations(
         image_name: str,
         annotation_json: Union[str, Path, dict],
         mask: Optional[Union[str, Path, bytes]] = None,
-        verbose: Optional[StrictBool] = True,
+        verbose: Optional[bool] = True,
         keep_status: bool = False,
     ):
         """Upload annotations from JSON (also mask for pixel annotations)
@@ -1948,7 +1947,7 @@ def search_models(
         type_: Optional[NotEmptyStr] = None,  # noqa
         project_id: Optional[int] = None,
         task: Optional[NotEmptyStr] = None,
-        include_global: Optional[StrictBool] = True,
+        include_global: Optional[bool] = True,
     ):
         r"""Search for ML models.
 
@@ -2164,7 +2163,7 @@ def add_contributors_to_project(
         return response.data
 
     def invite_contributors_to_team(
-        self, emails: conlist(EmailStr, min_items=1), admin: StrictBool = False
+        self, emails: conlist(EmailStr, min_items=1), admin: bool = False
     ) -> Tuple[List[str], List[str]]:
         """Invites contributors to the team.
 
@@ -2575,7 +2574,7 @@ def copy_items(
         source: Union[NotEmptyStr, dict],
         destination: Union[NotEmptyStr, dict],
         items: Optional[List[NotEmptyStr]] = None,
-        include_annotations: Optional[StrictBool] = True,
+        include_annotations: Optional[bool] = True,
     ):
         """Copy images in bulk between folders in a project
 

src/superannotate/lib/core/entities/folder.py

@@ -11,11 +11,10 @@ class FolderEntity(TimedBaseModel):
     name: Optional[str]
     status: Optional[FolderStatus]
     project_id: Optional[int]
-    parent_id: Optional[int]
     team_id: Optional[int]
     is_root: Optional[bool] = (False,)
     folder_users: Optional[List[dict]]
     completedCount: Optional[int]
 
     class Config:
-        extra = Extra.allow
+        extra = Extra.ignore

src/superannotate/lib/core/entities/project.py

@@ -185,3 +185,6 @@ class TeamEntity(BaseModel):
     users: Optional[List[UserEntity]]
     pending_invitations: Optional[List[Any]]
     creator_id: Optional[str]
+
+    class Config:
+        extra = Extra.ignore

tests/integration/folders/__init__.py

@@ -0,0 +1,10 @@
+FOLDER_KEYS = [
+    "createdAt",
+    "updatedAt",
+    "id",
+    "name",
+    "status",
+    "project_id",
+    "team_id",
+    "folder_users",
+]

tests/integration/folders/test_create_folder.py

@@ -0,0 +1,31 @@
+from src.superannotate import AppException
+from src.superannotate import SAClient
+from tests.integration.base import BaseTestCase
+
+sa = SAClient()
+
+
+class TestCreateFolder(BaseTestCase):
+    PROJECT_NAME = "test TestCreateFolder"
+    PROJECT_DESCRIPTION = "desc"
+    PROJECT_TYPE = "Vector"
+    SPECIAL_CHARS = r"/\:*?“<>|"
+    TEST_FOLDER_NAME = "folder_"
+
+    def test_create_long_name(self):
+        err_msg = "The folder name is too long. The maximum length for this field is 80 characters."
+        with self.assertRaisesRegexp(AppException, err_msg):
+            sa.create_folder(
+                self.PROJECT_NAME,
+                "A while back I needed to count the amount of letters that "
+                "a piece of text in an email template had (to avoid passing any)",
+            )
+
+    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)
+        assert "completedCount" not in folder.keys()
+        assert "is_root" not in folder.keys()

tests/integration/folders/test_delete_folders.py

@@ -0,0 +1,44 @@
+from src.superannotate import AppException
+from src.superannotate import SAClient
+from tests.integration.base import BaseTestCase
+
+
+sa = SAClient()
+
+
+class TestDeleteFolders(BaseTestCase):
+    PROJECT_NAME = "test TestDeleteFolders"
+    PROJECT_DESCRIPTION = "desc"
+    PROJECT_TYPE = "Vector"
+    SPECIAL_CHARS = r"/\:*?“<>|"
+    TEST_FOLDER_NAME_1 = "folder_1"
+    TEST_FOLDER_NAME_2 = "folder_2"
+
+    def test_search_folders(self):
+        sa.create_folder(self.PROJECT_NAME, self.TEST_FOLDER_NAME_1)
+        sa.create_folder(self.PROJECT_NAME, self.TEST_FOLDER_NAME_2)
+        sa.delete_folders(self.PROJECT_NAME, folder_names=[self.TEST_FOLDER_NAME_1])
+        folders = sa.search_folders(self.PROJECT_NAME)
+        assert len(folders) == 1
+
+        sa.delete_folders(self.PROJECT_NAME, folder_names=[self.TEST_FOLDER_NAME_2])
+        folders = sa.search_folders(self.PROJECT_NAME)
+        assert len(folders) == 0
+
+        # test delete multiple
+        folder_names = [f"folder_{i}" for i in range(5)]
+        [
+            sa.create_folder(self.PROJECT_NAME, folder_name)
+            for folder_name in folder_names
+        ]
+
+        with self.assertRaisesRegexp(AppException, "There is no folder to delete."):
+            sa.delete_folders(self.PROJECT_NAME, [])
+        pattern = r"(\s+)folder_names(\s+)none is not an allowed value"
+
+        with self.assertRaisesRegexp(AppException, pattern):
+            sa.delete_folders(self.PROJECT_NAME, None)  # noqa
+
+        sa.delete_folders(self.PROJECT_NAME, folder_names)
+        folders = sa.search_folders(self.PROJECT_NAME)
+        assert len(folders) == 0