Merge pull request #171 from ral-facilities/DSEGOG-392-Ensure-there-is-a-12-bit-record-in-the-dev-server-data_delete_subdirectories

Update delete_by_record_id to use subdirectories

Author: patrick-austin

operationsgateway_api/src/routes/records.py

@@ -274,9 +274,17 @@ async def delete_record_by_id(
 
     await Record.delete_record(id_)
     echo = EchoInterface()
+    # In principle historic data might be in the old directory format on Echo, so delete
+    # in both locations
+    sub_directories = EchoInterface.format_record_id(record_id=id_)
+    directory = EchoInterface.format_record_id(record_id=id_, use_subdirectories=False)
+
     log.info("Deleting waveforms for record ID '%s'", id_)
-    echo.delete_directory(f"{Waveform.echo_prefix}/{id_}/")
+    echo.delete_directory(f"{Waveform.echo_prefix}/{sub_directories}/")
+    echo.delete_directory(f"{Waveform.echo_prefix}/{directory}/")
+
     log.info("Deleting images for record ID '%s'", id_)
-    echo.delete_directory(f"{Image.echo_prefix}/{id_}/")
+    echo.delete_directory(f"{Image.echo_prefix}/{sub_directories}/")
+    echo.delete_directory(f"{Image.echo_prefix}/{directory}/")
 
     return Response(status_code=HTTPStatus.NO_CONTENT.value)

test/endpoints/conftest.py

@@ -112,7 +112,7 @@ async def remove_experiment_fixture():
 
 
 @pytest_asyncio.fixture(scope="function")
-async def data_for_delete_records():
+async def record_for_delete_records():
     record_id = "19000000000011"
     test_record = {
         "_id": record_id,
@@ -142,25 +142,51 @@ async def data_for_delete_records():
     record_instance = Record(test_record)
     await record_instance.insert()
 
+    yield record_id
+
+    await Record.delete_record(record_id)
+
+
+@pytest_asyncio.fixture(scope="function")
+async def data_for_delete_records(record_for_delete_records: str):
     echo = EchoInterface()
+    image_file = "test-image-channel-id.png"
+    image_path = f"{Image.echo_prefix}/{record_for_delete_records}/{image_file}"
     with open("test/images/original_image.png", "rb") as f:
-        echo.upload_file_object(
-            f,
-            f"{Image.echo_prefix}/{record_id}/test-image-channel-id.png",
-        )
+        echo.upload_file_object(f, image_path)
+
     waveform = Waveform(WaveformModel(x=[1.0, 2.0, 3.0], y=[1.0, 2.0, 3.0]))
     waveform_bytes = waveform.to_json()
-    echo.upload_file_object(
-        waveform_bytes,
-        f"{Waveform.echo_prefix}/{record_id}/test-waveform-channel-id.json",
+    waveform_file = "test-waveform-channel-id.json"
+    waveform_path = (
+        f"{Waveform.echo_prefix}/{record_for_delete_records}/{waveform_file}"
     )
+    echo.upload_file_object(waveform_bytes, waveform_path)
 
-    yield
+    yield record_for_delete_records
 
-    await Record.delete_record(record_id)
-    echo.delete_file_object(
-        f"{Image.echo_prefix}/{record_id}/test-image-channel-id.png",
-    )
-    echo.delete_file_object(
-        f"{Waveform.echo_prefix}/{record_id}/test-waveform-channel-id.json",
-    )
+    await Record.delete_record(record_for_delete_records)
+    echo.delete_file_object(image_path)
+    echo.delete_file_object(waveform_path)
+
+
+@pytest_asyncio.fixture(scope="function")
+async def data_for_delete_records_subdirectories(record_for_delete_records: str):
+    echo = EchoInterface()
+    subdirectories = EchoInterface.format_record_id(record_for_delete_records)
+    image_file = "test-image-channel-id.png"
+    image_path = f"{Image.echo_prefix}/{subdirectories}/{image_file}"
+    with open("test/images/original_image.png", "rb") as f:
+        echo.upload_file_object(f, image_path)
+
+    waveform = Waveform(WaveformModel(x=[1.0, 2.0, 3.0], y=[1.0, 2.0, 3.0]))
+    waveform_bytes = waveform.to_json()
+    waveform_file = "test-waveform-channel-id.json"
+    waveform_path = f"{Waveform.echo_prefix}/{subdirectories}/{waveform_file}"
+    echo.upload_file_object(waveform_bytes, waveform_path)
+
+    yield record_for_delete_records
+
+    await Record.delete_record(record_for_delete_records)
+    echo.delete_file_object(image_path)
+    echo.delete_file_object(waveform_path)

test/endpoints/test_delete_record.py

@@ -38,3 +38,35 @@ async def test_delete_record_success(
             Prefix=f"{Image.echo_prefix}/{record_id}/",
         )
         assert list(image_query) == []
+
+    @pytest.mark.asyncio
+    async def test_delete_record_subdirectories_success(
+        self,
+        test_app: TestClient,
+        login_and_get_token,
+        data_for_delete_records_subdirectories: str,
+    ):
+        delete_response = test_app.delete(
+            f"/records/{data_for_delete_records_subdirectories}",
+            headers={"Authorization": f"Bearer {login_and_get_token}"},
+        )
+
+        assert delete_response.status_code == 204
+        # Checks the record has been deleted from the database
+        with pytest.raises(MissingDocumentError):
+            await Record.find_record_by_id(data_for_delete_records_subdirectories, {})
+
+        # Check that waveform and image have been removed from Echo
+        echo = EchoInterface()
+        subdirectories = EchoInterface.format_record_id(
+            data_for_delete_records_subdirectories,
+        )
+        waveform_query = echo.bucket.objects.filter(
+            Prefix=f"{Waveform.echo_prefix}/{subdirectories}/",
+        )
+        assert list(waveform_query) == []
+
+        image_query = echo.bucket.objects.filter(
+            Prefix=f"{Image.echo_prefix}/{subdirectories}/",
+        )
+        assert list(image_query) == []