add integration test

Author: Lingling Peng

docs/reference/experimental/async/curator.md

@@ -56,6 +56,7 @@ at your own risk.
         members:
             - create_async
             - export_to_record_set_async
+            - import_csv_async
 ---
 [](){ #query-reference-async }
 ::: synapseclient.models.Query

synapseclient/models/curation.py

@@ -38,12 +38,7 @@
 from synapseclient.core.utils import delete_none_keys, merge_dataclass_entities
 from synapseclient.models.mixins.asynchronous_job import AsynchronousCommunicator
 from synapseclient.models.recordset import ValidationSummary
-from synapseclient.models.table_components import (
-    Column,
-    ColumnType,
-    CsvTableDescriptor,
-    Query,
-)
+from synapseclient.models.table_components import Column, CsvTableDescriptor, Query
 
 
 @dataclass
@@ -2106,15 +2101,10 @@ async def main():
         )
 
         preview_response = await upload_to_table_preview.send_job_and_wait_async(
-            timeout=timeout
+            timeout=timeout, synapse_client=synapse_client
         )
 
-        # ROW_ID and ROW_VERSION must be prepended to the schema to avoid:
-        # SynapseHTTPError: 400 Client Error: The CSV header does not match the schema size.
-        all_columns = [
-            Column(name="ROW_ID", column_type=ColumnType.STRING),
-            Column(name="ROW_VERSION", column_type=ColumnType.STRING),
-        ] + preview_response.suggested_columns
+        all_columns = preview_response.suggested_columns
         import_request = GridCsvImportRequest(
             session_id=self.session_id,
             file_handle_id=file_handle_id,
@@ -2123,7 +2113,7 @@ async def main():
         if csv_table_descriptor:
             import_request.csv_descriptor = csv_table_descriptor
         import_response = await import_request.send_job_and_wait_async(
-            synapse_client=synapse_client, timeout=timeout
+            timeout=timeout, synapse_client=synapse_client
         )
         client = Synapse.get_client(synapse_client=synapse_client)
         client.logger.info(

tests/integration/synapseclient/models/async/test_grid_async.py

@@ -9,7 +9,7 @@
 import pytest
 
 from synapseclient import Synapse
-from synapseclient.models import Grid, Project, RecordSet
+from synapseclient.models import File, Grid, Project, RecordSet
 from tests.integration import ASYNC_JOB_TIMEOUT_SEC
 
 
@@ -183,3 +183,65 @@ async def test_delete_grid_session_validation_error_async(self) -> None:
             match="session_id is required to delete a GridSession",
         ):
             await grid.delete_async(synapse_client=self.syn)
+
+    async def test_import_csv_to_grid_session_async(
+        self, record_set_fixture: RecordSet, schedule_for_cleanup: Callable[..., None]
+    ) -> None:
+        """Test importing a CSV file into a grid session."""
+
+        # GIVEN: Create a grid session first
+        grid = Grid(record_set_id=record_set_fixture.id)
+        created_grid = await grid.create_async(
+            timeout=ASYNC_JOB_TIMEOUT_SEC, synapse_client=self.syn
+        )
+
+        assert created_grid.session_id is not None
+
+        # AND a CSV file uploaded to Synapse
+        test_data = pd.DataFrame(
+            {
+                "id": [6, 7, 8, 9, 10],
+                "name": ["Alpha", "Beta", "Gamma", "Delta", "Epsilon"],
+                "value": [10.5, 20.3, 30.7, 40.1, 50.9],
+                "category": ["A", "B", "A", "C", "B"],
+                "active": [True, False, False, True, True],
+            }
+        )
+
+        project_name = str(uuid.uuid4())
+        project = Project(name=project_name)
+        project = await project.store_async(synapse_client=self.syn)
+
+        # Create a temporary CSV file
+        with tempfile.NamedTemporaryFile("w", suffix=".csv", delete=False) as temp_csv:
+            test_data.to_csv(temp_csv.name, index=False)
+            self.schedule_for_cleanup(temp_csv.name)
+
+            file = await File(path=temp_csv.name, parent_id=project.id).store_async(
+                synapse_client=self.syn
+            )
+
+        # WHEN: Importing the CSV into the grid session
+        imported_grid = await created_grid.import_csv_async(
+            file_handle_id=file.file_handle.id,
+            timeout=ASYNC_JOB_TIMEOUT_SEC,
+            synapse_client=self.syn,
+        )
+
+        schedule_for_cleanup(file.id)
+        schedule_for_cleanup(project.id)
+
+        # THEN: The import should complete and return the Grid with the same session
+        assert imported_grid.session_id == created_grid.session_id
+
+        # WHEN: Exporting the grid back to the record set
+        exported_grid = await imported_grid.export_to_record_set_async(
+            timeout=ASYNC_JOB_TIMEOUT_SEC, synapse_client=self.syn
+        )
+
+        # THEN: The export should contain 10 total rows
+        # (5 from the original record set + 5 imported)
+        assert exported_grid.validation_summary_statistics is not None
+        assert (
+            exported_grid.validation_summary_statistics.total_number_of_children == 10
+        )