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

PYIC-7931: Add old+new address to CoI end audit event #2864

Merged
merged 2 commits into from
Jan 21, 2025
Merged

PYIC-7931: Add old+new address to CoI end audit event #2864

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91ab31b
PYIC-7931: Add old+new address to CoI end audit event
AmritSidhu Jan 13, 2025
1f51565
PYIC-7931: Update audit-event data for api-tests
AmritSidhu Jan 15, 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
26 changes: 26 additions & 0 deletions api-tests/data/audit-events/reprove-identity-journey.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,32 @@
"value": "1965-07-08"
}
],
"oldAddress": [
{
"addressCountry": "GB",
"uprn": 100120012077,
"buildingName": "",
"streetName": "HADLEY ROAD",
"postalCode": "BA2 5AA",
"buildingNumber": "8",
"addressLocality": "BATH",
"validFrom": "1000-01-01",
"subBuildingName": ""
}
],
"newAddress": [
{
"addressCountry": "GB",
"uprn": 100120012077,
"buildingName": "",
"streetName": "HADLEY ROAD",
"postalCode": "BA2 5AA",
"buildingNumber": "8",
"addressLocality": "BATH",
"validFrom": "1000-01-01",
"subBuildingName": ""
}
],
"device_information": {}
}
},
Expand Down
26 changes: 26 additions & 0 deletions api-tests/data/audit-events/update-name-and-address-journey.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,32 @@
"value": "1965-07-08"
}
],
"oldAddress": [
{
"addressCountry": "GB",
"uprn": 100120012077,
"buildingName": "",
"streetName": "HADLEY ROAD",
"postalCode": "BA2 5AA",
"buildingNumber": "8",
"addressLocality": "BATH",
"validFrom": "1000-01-01",
"subBuildingName": ""
}
],
"newAddress": [
{
"addressCountry": "GB",
"uprn": 100120012047,
"buildingName": "",
"streetName": "King Road",
"postalCode": "BS9 6NR",
"buildingNumber": "28",
"addressLocality": "BRISTOL",
"validFrom": "1000-01-01",
"subBuildingName": ""
}
],
"device_information": {}
}
},
Expand Down
10 changes: 10 additions & 0 deletions lambdas/check-coi/src/main/java/uk/gov/di/ipv/core/checkcoi/CheckCoiHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,11 @@
import uk.gov.di.ipv.core.library.service.IpvSessionService;
import uk.gov.di.ipv.core.library.service.UserIdentityService;
import uk.gov.di.ipv.core.library.verifiablecredential.service.SessionCredentialsService;
import uk.gov.di.model.PostalAddress;

import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Stream;

import static java.lang.Boolean.TRUE;
Expand Down Expand Up @@ -261,14 +263,22 @@ private AuditRestrictedCheckCoi getRestrictedCheckCoiAuditData(
List<VerifiableCredential> sessionVcs,
String deviceInformation)
throws HttpResponseExceptionWithErrorBody, CredentialParseException {

var oldIdentityClaim = userIdentityService.findIdentityClaim(oldVcs);
var sessionIdentityClaim = userIdentityService.findIdentityClaim(sessionVcs);

Optional<List<PostalAddress>> oldAddressClaim =
userIdentityService.generateAddressClaim(oldVcs);
Optional<List<PostalAddress>> sessionAddressClaim =
userIdentityService.generateAddressClaim(sessionVcs);

return new AuditRestrictedCheckCoi(
oldIdentityClaim.map(IdentityClaim::getName).orElse(null),
sessionIdentityClaim.map(IdentityClaim::getName).orElse(null),
oldIdentityClaim.map(IdentityClaim::getBirthDate).orElse(null),
sessionIdentityClaim.map(IdentityClaim::getBirthDate).orElse(null),
oldAddressClaim.orElse(null),
sessionAddressClaim.orElse(null),
new DeviceInformation(deviceInformation));
}

Expand Down
24 changes: 23 additions & 1 deletion lambdas/check-coi/src/test/java/uk/gov/di/ipv/core/checkcoi/CheckCoiHandlerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
import uk.gov.di.ipv.core.library.testhelpers.unit.LogCollector;
import uk.gov.di.ipv.core.library.verifiablecredential.service.SessionCredentialsService;
import uk.gov.di.model.NamePart;
import uk.gov.di.model.PostalAddress;

import java.util.List;
import java.util.Map;
Expand Down Expand Up @@ -126,6 +127,13 @@ class SuccessAndFailChecks {
void setup() throws Exception {
when(mockUserIdentityService.findIdentityClaim(any()))
.thenReturn(getMockIdentityClaim());

PostalAddress address = new PostalAddress();
address.setAddressCountry("AnyCountry");
address.setAddressLocality("AnyTown");
address.setAddressRegion("AnyRegion");
when(mockUserIdentityService.generateAddressClaim(any()))
.thenReturn(Optional.of(List.of(address)));
}

private Optional<IdentityClaim> getMockIdentityClaim() {
Expand All @@ -141,7 +149,7 @@ private Optional<IdentityClaim> getMockIdentityClaim() {
@DisplayName("Successful checks")
class SuccessfulChecks {
@Test
void shouldReturnPassedForSuccessfulNamesAndDobCheck() throws Exception {
void shouldReturnPassedForSuccessfulNamesAndDobAndAddressCheck() throws Exception {
when(mockUserIdentityService.areNamesAndDobCorrelated(
List.of(M1A_ADDRESS_VC, M1A_EXPERIAN_FRAUD_VC)))
.thenReturn(true);
Expand Down Expand Up @@ -179,6 +187,8 @@ void shouldReturnPassedForSuccessfulNamesAndDobCheck() throws Exception {
assertTrue(restrictedAuditData.has("oldName"));
assertTrue(restrictedAuditData.has("newBirthDate"));
assertTrue(restrictedAuditData.has("oldBirthDate"));
assertTrue(restrictedAuditData.has("oldAddress"));
assertTrue(restrictedAuditData.has("newAddress"));
assertTrue(restrictedAuditData.has("device_information"));
}

Expand Down Expand Up @@ -221,6 +231,8 @@ void shouldReturnPassedForSuccessfulFullNameAndDobCheck() throws Exception {
assertTrue(restrictedAuditData.has("oldName"));
assertTrue(restrictedAuditData.has("newBirthDate"));
assertTrue(restrictedAuditData.has("oldBirthDate"));
assertTrue(restrictedAuditData.has("oldAddress"));
assertTrue(restrictedAuditData.has("newAddress"));
assertTrue(restrictedAuditData.has("device_information"));
}

Expand Down Expand Up @@ -262,6 +274,8 @@ void shouldDoFullCheckIfReproveIdentityJourney() throws Exception {
assertTrue(restrictedAuditData.has("oldName"));
assertTrue(restrictedAuditData.has("newBirthDate"));
assertTrue(restrictedAuditData.has("oldBirthDate"));
assertTrue(restrictedAuditData.has("oldAddress"));
assertTrue(restrictedAuditData.has("newAddress"));
assertTrue(restrictedAuditData.has("device_information"));
}

Expand Down Expand Up @@ -307,6 +321,8 @@ void shouldDoFullCheckIfReproveIdentityJourney() throws Exception {
assertTrue(restrictedAuditData.has("oldName"));
assertTrue(restrictedAuditData.has("newBirthDate"));
assertTrue(restrictedAuditData.has("oldBirthDate"));
assertTrue(restrictedAuditData.has("oldAddress"));
assertTrue(restrictedAuditData.has("newAddress"));
assertTrue(restrictedAuditData.has("device_information"));
}

Expand Down Expand Up @@ -351,6 +367,8 @@ void shouldSendOnlyDeviceInformationInRestrictedDataIfNoIdentityClaimsFound()
assertFalse(restrictedAuditData.has("oldName"));
assertFalse(restrictedAuditData.has("newBirthDate"));
assertFalse(restrictedAuditData.has("oldBirthDate"));
assertTrue(restrictedAuditData.has("oldAddress"));
assertTrue(restrictedAuditData.has("newAddress"));
assertTrue(restrictedAuditData.has("device_information"));
}
}
Expand Down Expand Up @@ -397,6 +415,8 @@ void shouldReturnFailedForFailedGivenNamesAndDobCheck() throws Exception {
assertTrue(restrictedAuditData.has("oldName"));
assertTrue(restrictedAuditData.has("newBirthDate"));
assertTrue(restrictedAuditData.has("oldBirthDate"));
assertTrue(restrictedAuditData.has("oldAddress"));
assertTrue(restrictedAuditData.has("newAddress"));
assertTrue(restrictedAuditData.has("device_information"));
}

Expand Down Expand Up @@ -475,6 +495,8 @@ void shouldReturnFailedForFailedReverificationCheckAndReverificationStatusSetToF
assertTrue(restrictedAuditData.has("oldName"));
assertTrue(restrictedAuditData.has("newBirthDate"));
assertTrue(restrictedAuditData.has("oldBirthDate"));
assertTrue(restrictedAuditData.has("oldAddress"));
assertTrue(restrictedAuditData.has("newAddress"));
assertTrue(restrictedAuditData.has("device_information"));
}
}
Expand Down
10 changes: 10 additions & 0 deletions ...ty/src/main/java/uk/gov/di/ipv/core/processcandidateidentity/service/CheckCoiService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,10 @@
import uk.gov.di.ipv.core.library.service.EvcsService;
import uk.gov.di.ipv.core.library.service.IpvSessionService;
import uk.gov.di.ipv.core.library.service.UserIdentityService;
import uk.gov.di.model.PostalAddress;

import java.util.List;
import java.util.Optional;
import java.util.stream.Stream;

import static java.lang.Boolean.TRUE;
Expand Down Expand Up @@ -181,14 +183,22 @@ private AuditRestrictedCheckCoi getRestrictedCheckCoiAuditData(
List<VerifiableCredential> sessionVcs,
String deviceInformation)
throws HttpResponseExceptionWithErrorBody, CredentialParseException {

var oldIdentityClaim = userIdentityService.findIdentityClaim(oldVcs);
var sessionIdentityClaim = userIdentityService.findIdentityClaim(sessionVcs);

Optional<List<PostalAddress>> oldAddressClaim =
userIdentityService.generateAddressClaim(oldVcs);
Optional<List<PostalAddress>> sessionAddressClaim =
userIdentityService.generateAddressClaim(sessionVcs);

return new AuditRestrictedCheckCoi(
oldIdentityClaim.map(IdentityClaim::getName).orElse(null),
sessionIdentityClaim.map(IdentityClaim::getName).orElse(null),
oldIdentityClaim.map(IdentityClaim::getBirthDate).orElse(null),
sessionIdentityClaim.map(IdentityClaim::getBirthDate).orElse(null),
oldAddressClaim.orElse(null),
sessionAddressClaim.orElse(null),
new DeviceInformation(deviceInformation));
}
}
17 changes: 15 additions & 2 deletions ...rc/test/java/uk/gov/di/ipv/core/processcandidateidentity/service/CheckCoiServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import uk.gov.di.ipv.core.library.service.UserIdentityService;
import uk.gov.di.ipv.core.library.verifiablecredential.service.SessionCredentialsService;
import uk.gov.di.model.NamePart;
import uk.gov.di.model.PostalAddress;

import java.util.List;
import java.util.Optional;
Expand Down Expand Up @@ -76,10 +77,17 @@ void setup() throws Exception {
.thenReturn("some-component-id");

when(mockUserIdentityService.findIdentityClaim(any())).thenReturn(getMockIdentityClaim());

PostalAddress address = new PostalAddress();
address.setAddressCountry("AnyCountry");
address.setAddressLocality("AnyTown");
address.setAddressRegion("AnyRegion");
when(mockUserIdentityService.generateAddressClaim(any()))
.thenReturn(Optional.of(List.of(address)));
}

@Test
void shouldReturnTrueForSuccessfulNamesAndDobCheck() throws Exception {
void shouldReturnTrueForSuccessfulNamesAndDobAndAddressCheck() throws Exception {
// Arrange
when(mockUserIdentityService.areNamesAndDobCorrelated(any())).thenReturn(true);

Expand Down Expand Up @@ -121,12 +129,13 @@ void shouldReturnTrueForSuccessfulNamesAndDobCheck() throws Exception {
assertEquals(
new AuditExtensionCoiCheck(STANDARD, true),
auditEventsCaptured.get(1).getExtensions());

var restrictedAuditData = getRestrictedAuditDataNodeFromEvent(auditEventsCaptured.get(1));
assertTrue(restrictedAuditData.has("newName"));
assertTrue(restrictedAuditData.has("oldName"));
assertTrue(restrictedAuditData.has("newBirthDate"));
assertTrue(restrictedAuditData.has("oldBirthDate"));
assertTrue(restrictedAuditData.has("oldAddress"));
assertTrue(restrictedAuditData.has("newAddress"));
assertTrue(restrictedAuditData.has("device_information"));
}

Expand Down Expand Up @@ -273,6 +282,8 @@ void shouldSendOnlyDeviceInformationInRestrictedDataIfNoIdentityClaimsFound() th
assertFalse(restrictedAuditData.has("oldName"));
assertFalse(restrictedAuditData.has("newBirthDate"));
assertFalse(restrictedAuditData.has("oldBirthDate"));
assertTrue(restrictedAuditData.has("oldAddress"));
assertTrue(restrictedAuditData.has("newAddress"));
assertTrue(restrictedAuditData.has("device_information"));
}

Expand Down Expand Up @@ -325,6 +336,8 @@ void shouldReturnFalseForFailedGivenNamesAndDobCheck() throws Exception {
assertTrue(restrictedAuditData.has("oldName"));
assertTrue(restrictedAuditData.has("newBirthDate"));
assertTrue(restrictedAuditData.has("oldBirthDate"));
assertTrue(restrictedAuditData.has("oldAddress"));
assertTrue(restrictedAuditData.has("newAddress"));
assertTrue(restrictedAuditData.has("device_information"));
}

Expand Down
3 changes: 3 additions & 0 deletions ...src/main/java/uk/gov/di/ipv/core/library/auditing/restricted/AuditRestrictedCheckCoi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import uk.gov.di.ipv.core.library.annotations.ExcludeFromGeneratedCoverageReport;
import uk.gov.di.model.BirthDate;
import uk.gov.di.model.Name;
import uk.gov.di.model.PostalAddress;

import java.util.List;

Expand All @@ -14,6 +15,8 @@ public record AuditRestrictedCheckCoi(
@JsonInclude(JsonInclude.Include.NON_NULL) List<Name> newName,
@JsonInclude(JsonInclude.Include.NON_NULL) List<BirthDate> oldBirthDate,
@JsonInclude(JsonInclude.Include.NON_NULL) List<BirthDate> newBirthDate,
@JsonInclude(JsonInclude.Include.NON_NULL) List<PostalAddress> oldAddress,
@JsonInclude(JsonInclude.Include.NON_NULL) List<PostalAddress> newAddress,
@JsonProperty(value = "device_information", required = true)
DeviceInformation deviceInformation)
implements AuditRestrictedWithDeviceInformation {}
Loading