edit test; fix typo; fix log

Author: Lingling Peng

synapseclient/models/curation.py

@@ -1013,7 +1013,7 @@ class GridCsvImportRequest(AsynchronousCommunicator):
     """The description of a csv for upload or download."""
 
     schema: Optional[List[Column]] = None
-    """The list of ColumnModel that describe the CSV file. Currently this is is required."""
+    """The list of ColumnModel that describe the CSV file. Currently this is required."""
 
     # Response fields (populated by fill_from_dict)
     total_count: Optional[int] = field(default=None, compare=False)
@@ -2110,13 +2110,15 @@ async def main():
             file_handle_id=file_handle_id,
             schema=all_columns,
         )
-        if csv_table_descriptor:
-            import_request.csv_descriptor = csv_table_descriptor
         import_response = await import_request.send_job_and_wait_async(
             timeout=timeout, synapse_client=synapse_client
         )
         client = Synapse.get_client(synapse_client=synapse_client)
         client.logger.info(
-            f"CSV import to grid session {self.session_id} completed successfully, total count: {import_response.total_count}, total created: {import_response.created_count}, total updated: {import_response.updated_count}"
+            f"CSV import to grid session {self.session_id} completed successfully, "
+            f"total count: {import_response.total_count}, "
+            f"total created: {import_response.created_count}, "
+            f"total updated: {import_response.updated_count}"
         )
+
         return self

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

@@ -185,7 +185,10 @@ async def test_delete_grid_session_validation_error_async(self) -> None:
             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]
+        self,
+        project_model,
+        record_set_fixture: RecordSet,
+        schedule_for_cleanup: Callable[..., None],
     ) -> None:
         """Test importing a CSV file into a grid session."""
 
@@ -208,18 +211,16 @@ async def test_import_csv_to_grid_session_async(
             }
         )
 
-        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
-            )
+            file = await File(
+                path=temp_csv.name, parent_id=project_model.id
+            ).store_async(synapse_client=self.syn)
+
+            schedule_for_cleanup(file.id)
 
         # WHEN: Importing the CSV into the grid session
         imported_grid = await created_grid.import_csv_async(
@@ -228,9 +229,6 @@ async def test_import_csv_to_grid_session_async(
             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
 

tests/unit/synapseclient/models/async/unit_test_curation_async.py

@@ -1,7 +1,7 @@
 """Unit tests for the CurationTask and Grid models."""
 
 import os
-from unittest.mock import AsyncMock, patch
+from unittest.mock import AsyncMock, MagicMock, patch
 
 import pytest
 
@@ -838,55 +838,79 @@ async def test_import_csv_async(self) -> None:
         # GIVEN a Grid with a session_id
         grid = Grid(session_id=SESSION_ID)
 
-        # Mock the CreateGridRequest's send_job_and_wait_async
         csv_table_descriptor = CsvTableDescriptor(
             separator=",",
             quote_character='"',
             escape_character="\\",
             line_end=os.linesep,
             is_first_line_header=True,
         )
-        mock_preview = UploadToTablePreviewRequest(
+        expected_columns = [Column(name="col1", column_type="STRING", maximum_size=50)]
+
+        # Mock preview response with suggested columns
+        mock_preview_response = UploadToTablePreviewRequest(
             csv_table_descriptor=csv_table_descriptor,
-            suggested_columns=[
-                Column(name="col1", column_type="STRING", maximum_size=50)
-            ],
+            suggested_columns=expected_columns,
             sample_rows=[["value1"]],
             rows_scanned=1,
         )
-        mock_import = GridCsvImportRequest(
+        # Mock import response with row counts
+        mock_import_response = GridCsvImportRequest(
             file_handle_id="1234567",
-            csv_descriptor=csv_table_descriptor,
-            schema=UploadToTablePreviewRequest.suggested_columns,
             total_count=1,
             created_count=1,
             updated_count=1,
         )
 
+        # Set up mock preview class: constructor returns a mock whose
+        # send_job_and_wait_async returns the mock_preview_response
+        mock_preview_instance = MagicMock()
+        mock_preview_instance.send_job_and_wait_async = AsyncMock(
+            return_value=mock_preview_response
+        )
+
+        # Set up mock import class: constructor returns a mock whose
+        # send_job_and_wait_async returns the mock_import_response
+        mock_import_instance = MagicMock()
+        mock_import_instance.send_job_and_wait_async = AsyncMock(
+            return_value=mock_import_response
+        )
+
         # WHEN I call import_csv_async
         with (
-            patch.object(
-                UploadToTablePreviewRequest,
-                "send_job_and_wait_async",
-                new_callable=AsyncMock,
-                return_value=mock_preview,
-            ),
-            patch.object(
-                GridCsvImportRequest,
-                "send_job_and_wait_async",
-                new_callable=AsyncMock,
-                return_value=mock_import,
-            ),
+            patch(
+                "synapseclient.models.curation.UploadToTablePreviewRequest",
+                return_value=mock_preview_instance,
+            ) as MockPreview,
+            patch(
+                "synapseclient.models.curation.GridCsvImportRequest",
+                return_value=mock_import_instance,
+            ) as MockImport,
             patch.object(self.syn, "logger") as mock_logger,
         ):
             result = await grid.import_csv_async(
-                synapse_client=self.syn, file_handle_id="1234567"
+                synapse_client=self.syn,
+                file_handle_id="1234567",
+                csv_table_descriptor=csv_table_descriptor,
             )
 
-        # THEN the grid should be populated with session data
+        # THEN the grid is returned with the same session
         assert result.session_id == SESSION_ID
 
-        # AND the log message should contain the import counts
+        # AND UploadToTablePreviewRequest was constructed with the right arguments
+        MockPreview.assert_called_once_with(
+            csv_table_descriptor=csv_table_descriptor,
+            upload_file_handle_id="1234567",
+        )
+
+        # AND GridCsvImportRequest was constructed with the schema from the preview
+        MockImport.assert_called_once_with(
+            session_id=SESSION_ID,
+            file_handle_id="1234567",
+            schema=expected_columns,
+        )
+
+        # AND the log message contains the import counts
         mock_logger.info.assert_called_once()
         log_message = mock_logger.info.call_args[0][0]
         assert "total count: 1" in log_message