added project_custom_field tests

Author: Narek Mkhitaryan

src/superannotate/lib/core/serviceproviders.py

@@ -105,6 +105,12 @@ def list_workflow_roles(self, project_id: int, workflow_id: int):
     def list_project_custom_field_templates(self):
         raise NotImplementedError
 
+    def create_project_custom_field_template(self, data: dict):
+        raise NotImplementedError
+
+    def delete_project_custom_field_template(self, pk: int):
+        raise NotImplementedError
+
     @abstractmethod
     def list_project_custom_entities(self, project_id: int):
         raise NotImplementedError

src/superannotate/lib/core/usecases/projects.py

@@ -227,9 +227,11 @@ def execute(self):
                 raise AppException("Invalid custom field value provided.")
         patch_data = {custom_field_id: self._value}
         # TODO add error handling
-        self._service_provider.work_management.set_project_custom_field_value(
+        res = self._service_provider.work_management.set_project_custom_field_value(
             project_id=self._project.id, data=patch_data
         )
+        if res.error:
+            raise AppException(res.error)
 
 
 class CreateProjectUseCase(BaseUseCase):

src/superannotate/lib/infrastructure/controller.py

@@ -318,7 +318,7 @@ def list_projects(
         include: List[str] = None,
         **filters: Unpack[ProjectFilters],
     ) -> List[ProjectEntity]:
-        if "custom_fields" in include:
+        if include and "custom_fields" in include:
             body_query = self._build_body_query(filters)
             response = self.service_provider.work_management.list_projects(
                 body_query=body_query

src/superannotate/lib/infrastructure/services/work_management.py

@@ -18,6 +18,7 @@ class WorkManagementService(BaseWorkManagementService):
     URL_CREATE_ROLE = "roles"
     URL_CREATE_STATUS = "statuses"
     URL_CUSTOM_FIELD_TEMPLATES = "customfieldtemplates"
+    URL_CUSTOM_FIELD_TEMPLATE_DELETE = "customfieldtemplates/{template_id}"
     URL_PROJECT_CUSTOM_ENTITIES = "customentities/{project_id}"
     LIST_PROJECTS = "customentities/search"
 
@@ -116,6 +117,37 @@ def list_project_custom_field_templates(self):
             },
         )
 
+    def create_project_custom_field_template(self, data: dict):
+        return self.client.request(
+            url=self.URL_CUSTOM_FIELD_TEMPLATES,
+            method="post",
+            data=data,
+            headers={
+                "x-sa-entity-context": base64.b64encode(
+                    f'{{"team_id":{self.client.team_id}}}'.encode("utf-8")
+                ).decode()
+            },
+            params={
+                "entity": "Project",
+                "parentEntity": "Team",
+            },
+        )
+
+    def delete_project_custom_field_template(self, pk: int):
+        return self.client.request(
+            url=self.URL_CUSTOM_FIELD_TEMPLATE_DELETE.format(template_id=pk),
+            method="delete",
+            headers={
+                "x-sa-entity-context": base64.b64encode(
+                    f'{{"team_id":{self.client.team_id}}}'.encode("utf-8")
+                ).decode()
+            },
+            params={
+                "entity": "Project",
+                "parentEntity": "Team",
+            },
+        )
+
     def list_project_custom_entities(self, project_id: int):
         return self.client.request(
             url=self.URL_PROJECT_CUSTOM_ENTITIES.format(project_id=project_id),

src/superannotate/lib/infrastructure/utils.py

@@ -129,7 +129,7 @@ def get_role_id(self, project: entities.ProjectEntity, role_name: str) -> int:
         raise AppException("Invalid assignments role provided.")
 
     def get_role_name(self, project: entities.ProjectEntity, role_id: int) -> str:
-        self._sync(project, "roles")
+        self._sync_project_data(project, "roles")
         mapping = self._role_id_name_map.get(project.id, {})
         if role_id in mapping:
             return mapping[role_id]

tests/integration/projects/test_project_custom_fields.py

@@ -0,0 +1,225 @@
+import time
+from typing import Any
+from typing import Dict
+
+from lib.core.entities.work_managament import ProjectCustomFieldType
+from src.superannotate import SAClient
+from tests.integration.base import BaseTestCase
+
+sa = SAClient()
+
+
+class TestProjectCustomFields(BaseTestCase):
+    PROJECT_NAME = "TestProjectCustomFields"
+    PROJECT_TYPE = "Vector"
+    PROJECT_DESCRIPTION = "DESCRIPTION"
+    CUSTOM_FIELD_PAYLOADS = [
+        {
+            "name": "SDK_test_text",
+            "access": {},
+            "component_id": ProjectCustomFieldType.Text.value,
+        },
+        {
+            "name": "SDK_test_date_picker",
+            "access": {},
+            "component_id": ProjectCustomFieldType.DATE_PICKER.value,
+        },
+        {
+            "name": "SDK_test_numeric",
+            "access": {},
+            "component_payload": {
+                "configs": {"min": None, "max": None, "step": None, "suffix": None}
+            },
+            "component_id": ProjectCustomFieldType.NUMERIC.value,
+        },
+        {
+            "name": "SDK_test_single_select",
+            "access": {},
+            "component_id": ProjectCustomFieldType.SINGLE_SELECT.value,
+            "component_payload": {
+                "options": [{"value": "option1"}, {"value": "option2"}]
+            },
+        },
+        {
+            "name": "SDK_test_multy_select",
+            "access": {},
+            "component_id": ProjectCustomFieldType.MULTI_SELECT.value,
+            "component_payload": {
+                "options": [{"value": "option1"}, {"value": "option2"}]
+            },
+        },
+    ]
+    FIELD_VALUE_MAP = {
+        "SDK_test_text": "test_text_value",
+        "SDK_test_date_picker": float(int(time.time())),
+        "SDK_test_numeric": 123,
+        "SDK_test_single_select": "option1",
+        "SDK_test_multy_select": ["option1", "option2"],
+    }
+
+    @classmethod
+    def setUpClass(cls, *args, **kwargs) -> None:
+        # setup custom fields for test
+        cls.tearDownClass()
+        for data in cls.CUSTOM_FIELD_PAYLOADS:
+            req = sa.controller.service_provider.work_management.create_project_custom_field_template(
+                data
+            )
+            assert req.status_code == 201
+
+    @classmethod
+    def tearDownClass(cls) -> None:
+        # cleanup test custom fields
+        bed_custom_fields_name_id_map = {
+            i["name"]: i["id"]
+            for i in sa.controller.service_provider.work_management.list_project_custom_field_templates().data[
+                "data"
+            ]
+        }
+        for data in cls.CUSTOM_FIELD_PAYLOADS:
+            if data["name"] in bed_custom_fields_name_id_map.keys():
+                req = sa.controller.service_provider.work_management.delete_project_custom_field_template(
+                    bed_custom_fields_name_id_map[data["name"]]
+                )
+                assert req.status_code == 200
+
+    def _set_custom_field_values(self, field_value_map: Dict[str, Any] = None) -> None:
+        if not field_value_map:
+            field_value_map = self.FIELD_VALUE_MAP
+        for k, v in field_value_map.items():
+            sa.set_project_custom_field(self.PROJECT_NAME, k, v)
+
+    def test_get_project_metadata_without_custom_fields(self):
+        project_metadata = sa.get_project_metadata(
+            self.PROJECT_NAME, include_custom_fields=False
+        )
+        assert project_metadata["custom_fields"] == {}
+
+    def test_set_project_custom_field(self):
+        # project metadata before set custom field values
+        project_metadata = sa.get_project_metadata(
+            self.PROJECT_NAME, include_custom_fields=True
+        )
+        for data in self.CUSTOM_FIELD_PAYLOADS:
+            assert data["name"] in project_metadata["custom_fields"].keys()
+            assert not project_metadata["custom_fields"][data["name"]]
+
+        # project metadata after set custom field values
+        self._set_custom_field_values()
+
+        project_metadata = sa.get_project_metadata(
+            self.PROJECT_NAME, include_custom_fields=True
+        )
+        for data in self.CUSTOM_FIELD_PAYLOADS:
+            assert data["name"] in project_metadata["custom_fields"].keys()
+            assert (
+                project_metadata["custom_fields"][data["name"]]
+                == self.FIELD_VALUE_MAP[data["name"]]
+            )
+
+    def test_list_projects_by_native_fields(self):
+        projects = sa.list_projects(include=["custom_fields"], name=self.PROJECT_NAME)
+        assert len(projects) == 1
+        assert projects[0]["name"] == self.PROJECT_NAME
+        for data in self.CUSTOM_FIELD_PAYLOADS:
+            assert data["name"] in projects[0]["custom_fields"].keys()
+            assert not projects[0]["custom_fields"][data["name"]]
+
+        assert not sa.list_projects(
+            include=["custom_fields"], name__in=["invalid_name_1", "invalid_name_2"]
+        )
+        assert (
+            len(
+                sa.list_projects(
+                    include=["custom_fields"], name__contains="TestProjectCustomFie"
+                )
+            )
+            == 1
+        )
+        assert (
+            len(
+                sa.list_projects(
+                    include=["custom_fields"],
+                    name__in=[self.PROJECT_NAME, "other_name"],
+                )
+            )
+            == 1
+        )
+        assert not sa.list_projects(
+            include=["custom_fields"],
+            name__in=[self.PROJECT_NAME, "other_name"],
+            status="Completed",
+        )
+        assert (
+            len(
+                sa.list_projects(
+                    include=["custom_fields"],
+                    name__in=[self.PROJECT_NAME, "other_name"],
+                    status__in=["NotStarted"],
+                )
+            )
+            == 1
+        )
+
+    def test_list_projects_by_custom_fields(self):
+        # project metadata after set custom field values
+        self._set_custom_field_values()
+        projects = sa.list_projects(
+            include=["custom_fields"], custom_field__SDK_test_numeric=123
+        )
+        assert len(projects) == 1
+        assert projects[0]["name"] == self.PROJECT_NAME
+        for data in self.CUSTOM_FIELD_PAYLOADS:
+            assert data["name"] in projects[0]["custom_fields"].keys()
+            assert (
+                projects[0]["custom_fields"][data["name"]]
+                == self.FIELD_VALUE_MAP[data["name"]]
+            )
+
+        assert not sa.list_projects(
+            include=["custom_fields"], custom_field__SDK_test_numeric=1
+        )
+        for p in sa.list_projects(
+            include=["custom_fields"], custom_field__SDK_test_numeric__ne=123
+        ):
+            assert not p["name"] == self.PROJECT_NAME
+        assert (
+            len(
+                sa.list_projects(
+                    include=["custom_fields"],
+                    custom_field__SDK_test_multy_select__in=["option1", "option2"],
+                )
+            )
+            == 1
+        )
+        assert (
+            len(
+                sa.list_projects(
+                    include=["custom_fields"],
+                    custom_field__SDK_test_single_select="option1",
+                )
+            )
+            == 1
+        )
+        assert (
+            len(
+                sa.list_projects(
+                    include=["custom_fields"],
+                    custom_field__SDK_test_multy_select__contains="option2",
+                )
+            )
+            == 1
+        )
+        assert not sa.list_projects(
+            include=["custom_fields"],
+            custom_field__SDK_test_multy_select__contains="invalid_option",
+        )
+        assert (
+            len(
+                sa.list_projects(
+                    include=["custom_fields"],
+                    custom_field__SDK_test_text__contains="test_text_v",
+                )
+            )
+            == 1
+        )