moved util into a utils file

Author: andrewelamb

synapseclient/extensions/curator/file_based_metadata_task.py

@@ -10,6 +10,7 @@
 from synapseclient import Synapse  # type: ignore
 from synapseclient import Wiki  # type: ignore
 from synapseclient.core.exceptions import SynapseHTTPError  # type: ignore
+from synapseclient.extensions.curator.utils import project_id_from_entity_id
 from synapseclient.models import (  # type: ignore
     Column,
     ColumnType,
@@ -430,9 +431,6 @@ def create_file_based_metadata_task(
     synapse_client.logger.info(
         "Attempting to get the Synapse ID of the provided folders project."
     )
-    from synapseclient.extensions.curator.record_based_metadata_task import (
-        project_id_from_entity_id,
-    )
 
     project_id = project_id_from_entity_id(folder_id, synapse_client=synapse_client)
     synapse_client.logger.info("Got the Synapse ID of the provided folders project.")

synapseclient/extensions/curator/record_based_metadata_task.py

@@ -11,15 +11,14 @@
 from synapseclient import Synapse
 from synapseclient.core.typing_utils import DataFrame as DATA_FRAME_TYPE
 from synapseclient.core.utils import test_import_pandas
+from synapseclient.extensions.curator.utils import project_id_from_entity_id
 from synapseclient.models import (
     CurationTask,
     Grid,
     JSONSchema,
-    Project,
     RecordBasedMetadataTaskProperties,
     RecordSet,
 )
-from synapseclient.operations import get
 
 
 def extract_property_titles(schema_data: Dict[str, Any]) -> List[str]:
@@ -294,29 +293,3 @@ def create_record_based_metadata_task(
         raise e
 
     return record_set_with_data, curation_task, curation_grid
-
-
-def project_id_from_entity_id(entity_id: str, synapse_client: Synapse) -> str:
-    """
-    Retrieves the project ID from a given entity ID by traversing up the folder hierarchy
-
-    Args:
-        entity_id: The Synapse ID of the entity (e.g., folder, file) to start from.
-        synapse_client: Authenticated Synapse client instance
-
-    Returns:
-        The Synapse ID of the project that the entity belongs to.
-
-    Raises:
-        ValueError: If the project ID cannot be found within 1000 iterations.
-    """
-
-    # Get the project ID from the folder ID
-    current_obj = get(entity_id, synapse_client=synapse_client)
-    iterations = 0
-    while not isinstance(current_obj, Project):
-        current_obj = get(current_obj.parent_id, synapse_client=synapse_client)
-        iterations += 1
-        if iterations > 1000:
-            raise ValueError("Could not find project ID in folder hierarchy")
-    return current_obj.id

synapseclient/extensions/curator/utils.py

@@ -0,0 +1,29 @@
+from synapseclient import Synapse
+from synapseclient.models import Project
+from synapseclient.operations import get
+
+
+def project_id_from_entity_id(entity_id: str, synapse_client: Synapse) -> str:
+    """
+    Retrieves the project ID from a given entity ID by traversing up the folder hierarchy
+
+    Args:
+        entity_id: The Synapse ID of the entity (e.g., folder, file) to start from.
+        synapse_client: Authenticated Synapse client instance
+
+    Returns:
+        The Synapse ID of the project that the entity belongs to.
+
+    Raises:
+        ValueError: If the project ID cannot be found within 1000 iterations.
+    """
+
+    # Get the project ID from the folder ID
+    current_obj = get(entity_id, synapse_client=synapse_client)
+    iterations = 0
+    while not isinstance(current_obj, Project):
+        current_obj = get(current_obj.parent_id, synapse_client=synapse_client)
+        iterations += 1
+        if iterations > 1000:
+            raise ValueError("Could not find project ID in folder hierarchy")
+    return current_obj.id

tests/integration/synapseclient/extensions/curator/test_record_based_metadata_task.py

@@ -8,7 +8,10 @@
 
 from synapseclient import Synapse
 from synapseclient.extensions.curator import bind_jsonschema, register_jsonschema
-from synapseclient.models import File, Folder, Project, SchemaOrganization
+from synapseclient.extensions.curator.record_based_metadata_task import (
+    project_id_from_entity_id,
+)
+from synapseclient.models import Folder, Project, SchemaOrganization
 
 
 def create_test_name():
@@ -259,3 +262,37 @@ def test_complete_workflow(
             # Cleanup: unbind schema before deleting folder
             folder.unbind_schema(synapse_client=syn)
             syn.delete(folder.id)
+
+
+class TestProjectIDFromEntityID:
+    @pytest.fixture(scope="module")
+    def temp_hierarchy(self, syn: Synapse, request) -> tuple[str, str, str]:
+        """Creates a Project -> Folder -> Folder hierarchy for testing."""
+        project = Project(name=create_test_name()).store(synapse_client=syn)
+        folder1 = Folder(name=create_test_name(), parent_id=project.id).store(
+            synapse_client=syn
+        )
+        folder2 = Folder(name=create_test_name(), parent_id=folder1.id).store(
+            synapse_client=syn
+        )
+
+        def delete_project():
+            project.delete(synapse_client=syn)
+
+        request.addfinalizer(delete_project)
+        return project.id, folder1.id, folder2.id
+
+    def test_project_id_from_folder(self, syn, temp_hierarchy):
+        """Test finding project id when input id is from a nested folder."""
+        folder_id = temp_hierarchy[2]
+        expected_project_id = temp_hierarchy[0]
+
+        result = project_id_from_entity_id(folder_id, syn)
+        assert result == expected_project_id
+
+    def test_project_id_from_project(self, syn, temp_hierarchy):
+        """Test finding project id when input id is for a project"""
+        project_id = temp_hierarchy[0]
+
+        result = project_id_from_entity_id(project_id, syn)
+        assert result == project_id