Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DMP-3396: Implement get audio versions endpoint #2641

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

DMP-3396: Implement get audio versions endpoint #2641

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6ec4c45
Main Implementation + Unit tests
Ben-Edwards-cgi Feb 25, 2025
ea7d204
Added remaining tests + Rejigged some current version logic
Ben-Edwards-cgi Feb 25, 2025
c004ca2
Fixed merge issues
Ben-Edwards-cgi Feb 27, 2025
3b0e887
Review comments
Ben-Edwards-cgi Feb 27, 2025
09470f5
Fixed issue where incorrect currentVersion was being grabbed
Ben-Edwards-cgi Feb 27, 2025
448a47b
Merge branch 'master' into DMP-3396
Ben-Edwards-cgi Feb 28, 2025
b5d8352
Updated unit tests
Ben-Edwards-cgi Feb 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
220 changes: 220 additions & 0 deletions .../uk/gov/hmcts/darts/audio/controller/AudioControllerGetAdminMediaVersionsByIdIntTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,220 @@
package uk.gov.hmcts.darts.audio.controller;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.EnumSource;
import org.skyscreamer.jsonassert.JSONAssert;
import org.skyscreamer.jsonassert.JSONCompareMode;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.MvcResult;
import uk.gov.hmcts.darts.common.entity.MediaEntity;
import uk.gov.hmcts.darts.common.enums.SecurityRoleEnum;
import uk.gov.hmcts.darts.testutils.GivenBuilder;
import uk.gov.hmcts.darts.testutils.IntegrationBase;
import uk.gov.hmcts.darts.testutils.stubs.DartsDatabaseStub;

import java.time.Duration;
import java.time.OffsetDateTime;
import java.time.format.DateTimeFormatter;

import static org.junit.jupiter.params.provider.EnumSource.Mode.EXCLUDE;
import static org.junit.jupiter.params.provider.EnumSource.Mode.INCLUDE;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
import static uk.gov.hmcts.darts.test.common.TestUtils.getContentsFromFile;

@AutoConfigureMockMvc
class AudioControllerGetAdminMediaVersionsByIdIntTest extends IntegrationBase {
@Autowired
private GivenBuilder given;

@Autowired
private MockMvc mockMvc;

@Autowired
private DartsDatabaseStub databaseStub;

private static final String ENDPOINT_URL = "/admin/medias/{id}/versions";
private static final String COURTHOUSE_NAME = "TESTCOURTHOUSE";
private static final String COURTROOM_NAME = "TESTCOURTROOM";
private static final OffsetDateTime HEARING_START_AT = OffsetDateTime.parse("2024-01-01T12:10:10Z");
private static final OffsetDateTime MEDIA_START_AT = HEARING_START_AT;
private static final OffsetDateTime MEDIA_END_AT = MEDIA_START_AT.plusHours(1);
private static final String RETAIN_UNTIL = "2200-02-01T00:00:00Z";


@ParameterizedTest
@EnumSource(value = SecurityRoleEnum.class, names = {"SUPER_USER", "SUPER_ADMIN"}, mode = INCLUDE)
void shouldReturn200_whenChronicleIdHasBothCurrentAndNonCurrentVersions(SecurityRoleEnum role) throws Exception {
final String chronicleId = "chronicleId";
MediaEntity currentMediaEntity = createAndSaveMediaEntity(true, chronicleId, Duration.ofDays(3));
MediaEntity versionedMediaEntity1 = createAndSaveMediaEntity(false, chronicleId, Duration.ofDays(2));
MediaEntity versionedMediaEntity2 = createAndSaveMediaEntity(false, chronicleId, Duration.ofDays(1));
//Craeted unrelated media to ensure not returned
createAndSaveMediaEntity(true, "unrealted");

given.anAuthenticatedUserWithGlobalAccessAndRole(role);

// When
MvcResult mvcResult = mockMvc.perform(get(ENDPOINT_URL, currentMediaEntity.getId()))
.andExpect(status().isOk())
.andReturn();

String expectedResponse = getContentsFromFile(
"tests/audio/AudioControllerGetAdminMediaVersionsByIdIntTest/expectedResponseTypical.json")
.replace("<created_at_current>", currentMediaEntity.getCreatedDateTime().format(DateTimeFormatter.ISO_DATE_TIME))
.replace("<versioned_at_current_1>", versionedMediaEntity2.getCreatedDateTime().format(DateTimeFormatter.ISO_DATE_TIME))
.replace("<versioned_at_current_2>", versionedMediaEntity1.getCreatedDateTime().format(DateTimeFormatter.ISO_DATE_TIME));
JSONAssert.assertEquals(expectedResponse, mvcResult.getResponse().getContentAsString(), JSONCompareMode.STRICT);
}

@Test
void shouldReturn200_whenMediaIdPassedIsNotCurrent_shouldReturnTheCorrectCorrentVersion() throws Exception {
final String chronicleId = "chronicleId";
MediaEntity currentMediaEntity = createAndSaveMediaEntity(true, chronicleId, Duration.ofDays(3));
MediaEntity versionedMediaEntity1 = createAndSaveMediaEntity(false, chronicleId, Duration.ofDays(2));
MediaEntity versionedMediaEntity2 = createAndSaveMediaEntity(false, chronicleId, Duration.ofDays(1));
//Craeted unrelated media to ensure not returned
createAndSaveMediaEntity(true, "unrealted");

given.anAuthenticatedUserWithGlobalAccessAndRole(SecurityRoleEnum.SUPER_ADMIN);

// When
MvcResult mvcResult = mockMvc.perform(get(ENDPOINT_URL, versionedMediaEntity1.getId()))
.andExpect(status().isOk())
.andReturn();

String expectedResponse = getContentsFromFile(
"tests/audio/AudioControllerGetAdminMediaVersionsByIdIntTest/expectedResponseTypical.json")
.replace("<created_at_current>", currentMediaEntity.getCreatedDateTime().format(DateTimeFormatter.ISO_DATE_TIME))
.replace("<versioned_at_current_1>", versionedMediaEntity2.getCreatedDateTime().format(DateTimeFormatter.ISO_DATE_TIME))
.replace("<versioned_at_current_2>", versionedMediaEntity1.getCreatedDateTime().format(DateTimeFormatter.ISO_DATE_TIME));
JSONAssert.assertEquals(expectedResponse, mvcResult.getResponse().getContentAsString(), JSONCompareMode.STRICT);
}

@Test
void shouldReturn200_whenChronicleIdHasOnlyCurrentAndNoVersions() throws Exception {
final String chronicleId = "chronicleId";
MediaEntity currentMediaEntity = createAndSaveMediaEntity(true, chronicleId, Duration.ofDays(3));
//Craeted unrelated media to ensure not returned
createAndSaveMediaEntity(true, "unrealted");

given.anAuthenticatedUserWithGlobalAccessAndRole(SecurityRoleEnum.SUPER_ADMIN);

// When
MvcResult mvcResult = mockMvc.perform(get(ENDPOINT_URL, currentMediaEntity.getId()))
.andExpect(status().isOk())
.andReturn();

String expectedResponse = getContentsFromFile(
"tests/audio/AudioControllerGetAdminMediaVersionsByIdIntTest/expectedResponseNoVersions.json")
.replace("<created_at_current>", currentMediaEntity.getCreatedDateTime().format(DateTimeFormatter.ISO_DATE_TIME));
JSONAssert.assertEquals(expectedResponse, mvcResult.getResponse().getContentAsString(), JSONCompareMode.STRICT);
}

@ParameterizedTest
@EnumSource(value = SecurityRoleEnum.class, names = {"SUPER_USER", "SUPER_ADMIN"}, mode = INCLUDE)
void shouldReturn404_WhenMediaRecordDoesNotExist(SecurityRoleEnum role) throws Exception {
// Given
given.anAuthenticatedUserWithGlobalAccessAndRole(role);

// When
MvcResult mvcResult = mockMvc.perform(get(ENDPOINT_URL, "123456789"))
.andExpect(status().isNotFound())
.andReturn();

// Then
var jsonString = mvcResult.getResponse().getContentAsString();
JSONAssert.assertEquals("""
{
"type": "AUDIO_102",
"title": "The requested media cannot be found",
"status": 404
}
""", jsonString, JSONCompareMode.STRICT);
}

@ParameterizedTest
@EnumSource(value = SecurityRoleEnum.class, names = {"SUPER_USER", "SUPER_ADMIN"}, mode = INCLUDE)
void shouldReturn404_WhenMediaRecordIsDeleted(SecurityRoleEnum role) throws Exception {
// Given
given.anAuthenticatedUserWithGlobalAccessAndRole(role);


var mediaEntity = createAndSaveMediaEntity(true, true, "chronicleId", Duration.ofMillis(0));
// When
MvcResult mvcResult = mockMvc.perform(get(ENDPOINT_URL, String.valueOf(mediaEntity.getId())))
.andExpect(status().isNotFound())
.andReturn();

// Then
var jsonString = mvcResult.getResponse().getContentAsString();
JSONAssert.assertEquals("""
{
"type": "AUDIO_102",
"title": "The requested media cannot be found",
"status": 404
}
""", jsonString, JSONCompareMode.STRICT);

}

@ParameterizedTest
@EnumSource(value = SecurityRoleEnum.class, names = {"SUPER_USER", "SUPER_ADMIN"}, mode = EXCLUDE)
void shouldDenyAccess_whenNotAuthorised(SecurityRoleEnum role) throws Exception {
// Given
given.anAuthenticatedUserWithGlobalAccessAndRole(role);

// When
MvcResult mvcResult = mockMvc.perform(get(ENDPOINT_URL, "123456789"))
.andExpect(status().isForbidden())
.andReturn();

// Then
var jsonString = mvcResult.getResponse().getContentAsString();
JSONAssert.assertEquals("""
{
"type": "AUTHORISATION_109",
"title": "User is not authorised for this endpoint",
"status": 403
}
""", jsonString, JSONCompareMode.STRICT);
}

private MediaEntity createAndSaveMediaEntity(boolean isCurrent, String chronicleId) {
return createAndSaveMediaEntity(false, isCurrent, chronicleId, Duration.ofMillis(0));
}

private MediaEntity createAndSaveMediaEntity(boolean isCurrent, String chronicleId, Duration timeOffset) {
return createAndSaveMediaEntity(false, isCurrent, chronicleId, timeOffset);
}

private MediaEntity createAndSaveMediaEntity(boolean isDeleted, boolean isCurrent, String chronicleId, Duration timeOffset) {
MediaEntity mediaEntity = databaseStub.createMediaEntity(COURTHOUSE_NAME,
COURTROOM_NAME,
MEDIA_START_AT.plus(timeOffset),
MEDIA_END_AT.plus(timeOffset),
2);
var userAccountEntity = databaseStub.getUserAccountRepository().findAll().stream()
.findFirst()
.orElseThrow();
mediaEntity.setLegacyObjectId("object-id-value");
mediaEntity.setContentObjectId("content-id-value");
mediaEntity.setClipId("clip-id-value");
mediaEntity.setMediaStatus("media-status-value");
mediaEntity.setHidden(true);
mediaEntity.setDeleted(isDeleted);
mediaEntity.setLegacyVersionLabel("version-label-value");
mediaEntity.setChronicleId(chronicleId);
mediaEntity.setAntecedentId("antecedent-value");
mediaEntity.setRetainUntilTs(OffsetDateTime.parse(RETAIN_UNTIL));
mediaEntity.setCreatedBy(userAccountEntity);
mediaEntity.setLastModifiedBy(userAccountEntity);
mediaEntity.setIsCurrent(isCurrent);

return databaseStub.getMediaRepository()
.saveAndFlush(mediaEntity);
}
}
22 changes: 22 additions & 0 deletions ...sts/audio/AudioControllerGetAdminMediaVersionsByIdIntTest/expectedResponseNoVersions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"media_object_id": "object-id-value",
"current_version": {
"id": 1,
"courthouse": {
"id": 1,
"display_name": "TESTCOURTHOUSE"
},
"courtroom": {
"id": 1,
"name": "TESTCOURTROOM"
},
"start_at": "2024-01-04T12:10:10Z",
"end_at": "2024-01-04T13:10:10Z",
"channel": 2,
"chronicle_id": "chronicleId",
"antecedent_id": "antecedent-value",
"is_current": true,
"created_at": "<created_at_current>"
},
"previous_versions": []
}
59 changes: 59 additions & 0 deletions .../tests/audio/AudioControllerGetAdminMediaVersionsByIdIntTest/expectedResponseTypical.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
{
"media_object_id": "object-id-value",
"current_version": {
"id": 1,
"courthouse": {
"id": 1,
"display_name": "TESTCOURTHOUSE"
},
"courtroom": {
"id": 1,
"name": "TESTCOURTROOM"
},
"start_at": "2024-01-04T12:10:10Z",
"end_at": "2024-01-04T13:10:10Z",
"channel": 2,
"chronicle_id": "chronicleId",
"antecedent_id": "antecedent-value",
"is_current": true,
"created_at": "<created_at_current>"
},
"previous_versions": [
{
"id": 3,
"courthouse": {
"id": 1,
"display_name": "TESTCOURTHOUSE"
},
"courtroom": {
"id": 1,
"name": "TESTCOURTROOM"
},
"start_at": "2024-01-02T12:10:10Z",
"end_at": "2024-01-02T13:10:10Z",
"channel": 2,
"chronicle_id": "chronicleId",
"antecedent_id": "antecedent-value",
"is_current": false,
"created_at": "<versioned_at_current_1>"
},
{
"id": 2,
"courthouse": {
"id": 1,
"display_name": "TESTCOURTHOUSE"
},
"courtroom": {
"id": 1,
"name": "TESTCOURTROOM"
},
"start_at": "2024-01-03T12:10:10Z",
"end_at": "2024-01-03T13:10:10Z",
"channel": 2,
"chronicle_id": "chronicleId",
"antecedent_id": "antecedent-value",
"is_current": false,
"created_at": "<versioned_at_current_2>"
}
]
}
8 changes: 8 additions & 0 deletions src/main/java/uk/gov/hmcts/darts/audio/controller/AudioController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import uk.gov.hmcts.darts.audio.mapper.TransformedMediaMapper;
import uk.gov.hmcts.darts.audio.model.AddAudioMetadataRequestWithStorageGUID;
import uk.gov.hmcts.darts.audio.model.AdminMediaResponse;
import uk.gov.hmcts.darts.audio.model.AdminVersionedMediaResponse;
import uk.gov.hmcts.darts.audio.model.AudioMetadata;
import uk.gov.hmcts.darts.audio.model.AudioPreview;
import uk.gov.hmcts.darts.audio.model.GetAdminMediaResponseItem;
Expand Down Expand Up @@ -164,6 +165,13 @@ public ResponseEntity<AdminMediaResponse> getAdminMediasById(Integer id) {
return new ResponseEntity<>(adminMediaService.getMediasById(id), HttpStatus.OK);
}

@Override
@SecurityRequirement(name = SECURITY_SCHEMES_BEARER_AUTH)
@Authorisation(contextId = ANY_ENTITY_ID, globalAccessSecurityRoles = {SUPER_USER, SUPER_ADMIN})
public ResponseEntity<AdminVersionedMediaResponse> getAdminMediaVersionsById(Integer id) {
return new ResponseEntity<>(adminMediaService.getMediaVersionsById(id), HttpStatus.OK);
}

@Override
@SecurityRequirement(name = SECURITY_SCHEMES_BEARER_AUTH)
@Authorisation(contextId = ANY_ENTITY_ID, globalAccessSecurityRoles = {SUPER_USER, SUPER_ADMIN})
Expand Down
Loading