Merge pull request #296 from superannotateai/validations_interface_function

Validations interface function

Author: dshabin

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

@@ -3638,12 +3638,23 @@ def attach_document_urls_to_project(
 def validate_annotations(
     project_type: ProjectTypes, annotations_json: Union[NotEmptyStr, Path]
 ):
+    """
+    Validates given annotation JSON.
+        :param project_type: project_type (str) – the project type Vector, Pixel, Video or Document
+        :type project_type: str
+        :param annotation_json: path to annotation JSON
+        :type annotation_json: Path-like (str or Path)
+
+        :return: The success of the validation
+        :rtype: bool
+        """
     with open(annotations_json) as file:
         annotation_data = json.loads(file.read())
         response = controller.validate_annotations(project_type, annotation_data)
         if response.errors:
             raise AppException(response.errors)
-        if response.data:
+        is_valid, _ = response.data
+        if is_valid:
             return True
         print(response.report)
         return False

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

@@ -4,7 +4,7 @@
 from typing import List
 from typing import Optional
 
-from pydantic import BaseModel
+from pydantic import BaseModel as PyDanticBaseModel
 from pydantic import conlist
 from pydantic import constr
 from pydantic import EmailStr
@@ -18,6 +18,16 @@
 NotEmptyStr = constr(strict=True, min_length=1)
 
 
+class BaseModel(PyDanticBaseModel):
+    class Config:
+        use_enum_values = True
+        error_msg_templates = {
+            "type_error.integer": "integer type expected",
+            "type_error.string": "str type expected",
+            "value_error.missing": "field required",
+        }
+        
+
 class StringDate(datetime):
     @classmethod
     def __get_validators__(cls):
@@ -28,6 +38,7 @@ def __get_validators__(cls):
     def validate(cls, v: datetime):
         return f'{v.replace(tzinfo=None).strftime("%Y-%m-%dT%H:%M:%S.%f")[:-3]}Z'
 
+      
 class VectorAnnotationTypeEnum(str, Enum):
     BBOX = "bbox"
     ELLIPSE = "ellipse"
@@ -107,6 +118,10 @@ class TrackableModel(BaseModel):
     updated_by: Optional[UserAction] = Field(None, alias="updatedBy")
     creation_type: Optional[CreationTypeEnum] = Field(CreationTypeEnum.PRE_ANNOTATION.value, alias="creationType")
 
+    @validator("creation_type")
+    def clean_creation_type(cls, value):
+        return value or CreationTypeEnum.PRE_ANNOTATION.value
+
 
 class LastUserAction(BaseModel):
     email: EmailStr

tests/integration/annotations/test_annotations_pre_processing.py

@@ -0,0 +1,54 @@
+import tempfile
+from collections import defaultdict
+from pathlib import Path
+import os
+from os.path import join
+import json
+import pytest
+from unittest.mock import patch
+from unittest.mock import MagicMock
+
+import src.superannotate as sa
+from src.superannotate.lib.core.entities.utils import CreationTypeEnum
+from tests.integration.base import BaseTestCase
+
+
+class TestAnnotationUploadVector(BaseTestCase):
+    PROJECT_NAME = "TestAnnotationUploadVector"
+    PROJECT_DESCRIPTION = "Desc"
+    PROJECT_TYPE = "Vector"
+    S3_FOLDER_PATH = "sample_project_pixel"
+    TEST_FOLDER_PATH = "data_set/sample_project_vector"
+    IMAGE_NAME = "example_image_1.jpg"
+
+    @property
+    def folder_path(self):
+        return os.path.join(Path(__file__).parent.parent.parent, self.TEST_FOLDER_PATH)
+
+    @pytest.mark.flaky(reruns=2)
+    @patch("lib.infrastructure.controller.Reporter")
+    def test_annotation_last_action_and_creation_type(self, reporter):
+        reporter_mock = MagicMock()
+        reporter.return_value = reporter_mock
+        annotation_path = join(self.folder_path, f"{self.IMAGE_NAME}___objects.json")
+        sa.upload_image_to_project(self.PROJECT_NAME, join(self.folder_path, self.IMAGE_NAME))
+        sa.upload_image_annotations(self.PROJECT_NAME, self.IMAGE_NAME, annotation_path)
+        call_groups = defaultdict(list)
+        reporter_calls = reporter_mock.method_calls
+        for call in reporter_calls:
+            call_groups[call[0]].append(call[1])
+        self.assertEqual(len(call_groups["log_warning"]), len(call_groups["store_message"]))
+        with tempfile.TemporaryDirectory() as tmp_dir:
+            sa.download_image_annotations(self.PROJECT_NAME, self.IMAGE_NAME, tmp_dir)
+            annotation = json.load(open(join(tmp_dir, f"{self.IMAGE_NAME}___objects.json")))
+            for instance in annotation["instances"]:
+                self.assertEqual(instance["creationType"], CreationTypeEnum.PRE_ANNOTATION.value)
+            self.assertEqual(
+                type(annotation["metadata"]["lastAction"]["email"]),
+                type(sa.controller.team_data.data.creator_id)
+            )
+            self.assertEqual(
+                type(annotation["metadata"]["lastAction"]["timestamp"]),
+                int
+            )
+