add separate sync upload test and nits

Author: Drew Kaul

nucleus/constants.py

@@ -29,6 +29,7 @@
 ERROR_CODES = "error_codes"
 ERROR_ITEMS = "upload_errors"
 ERROR_PAYLOAD = "error_payload"
+FRAMES = "frames"
 GEOMETRY_KEY = "geometry"
 HEIGHT_KEY = "height"
 IGNORED_ITEMS = "ignored_items"

nucleus/dataset.py

@@ -23,6 +23,7 @@
     DATASET_SLICES_KEY,
     DEFAULT_ANNOTATION_UPDATE_MODE,
     EXPORTED_ROWS,
+    FRAMES,
     JOB_ID_KEY,
     NAME_KEY,
     REFERENCE_IDS_KEY,
@@ -253,9 +254,23 @@ def upload_scene(
         update: Optional[bool] = False,
         asynchronous: bool = False,
     ) -> Union[dict, AsyncJob]:
-        """TODO: add docstring here"""
+        """
+        Uploads scene with given frames to the dataset
+
+        Parameters:
+        :param payload: dictionary containing frames to be uploaded as a scene
+        :param update: if True, overwrite scene on collision
+        :param aynchronous: if True, return a job object representing asynchronous ingestion job
+        :return:
+        {
+            'dataset_id': str,
+            'new_items': int,
+            'updated_items': int,
+            'ignored_items': int,
+        }
+        """
         if asynchronous:
-            check_all_frame_paths_remote(payload["frames"])
+            check_all_frame_paths_remote(payload[FRAMES])
             request_id = serialize_and_write_to_presigned_url(
                 [payload], self.id, self._client
             )

tests/test_scene.py

@@ -21,7 +21,6 @@ def dataset(CLIENT):
     assert response == {"message": "Beginning dataset deletion..."}
 
 
-@pytest.mark.integration
 def test_scene_upload_sync(dataset):
     payload = TEST_LIDAR_FRAMES
     response = dataset.upload_scene(payload)
@@ -31,6 +30,17 @@ def test_scene_upload_sync(dataset):
     assert response["updated_items"] == 0
     assert response["ignored_items"] == 0
 
+
+@pytest.mark.integration
+def test_scene_and_cuboid_upload_sync(dataset):
+    payload = TEST_LIDAR_FRAMES
+    response = dataset.upload_scene(payload)
+
+    assert response["dataset_id"] == dataset.id
+    assert response["new_items"] == 1
+    assert response["updated_items"] == 0
+    assert response["ignored_items"] == 0
+
     TEST_CUBOID_ANNOTATIONS[0]["dataset_item_id"] = dataset.items[0].item_id
     annotation = CuboidAnnotation.from_json(TEST_CUBOID_ANNOTATIONS[0])
     response = dataset.annotate(annotations=[annotation])