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

fix: [DHIS2-15272] Fix program expiryDays check with periodType for events #19297

Merged
merged 7 commits into from
Nov 27, 2024
Merged

fix: [DHIS2-15272] Fix program expiryDays check with periodType for events #19297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d1441a7
fix: [DHIS2-15272] Fix program expiryDays check with periodType for e…
ameenhere Nov 26, 2024
757553b
Merge branch 'master' into DHIS2-15272
ameenhere Nov 26, 2024
4c84aac
Spotless fix
ameenhere Nov 26, 2024
578c2da
Fix review comments
ameenhere Nov 26, 2024
53c0ddc
Merge branch 'master' into DHIS2-15272
ameenhere Nov 26, 2024
33d3b6b
Fix review comments
ameenhere Nov 27, 2024
757aaee
Merge branch 'master' into DHIS2-15272
ameenhere Nov 27, 2024
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
16 changes: 10 additions & 6 deletions ...src/main/java/org/hisp/dhis/tracker/imports/validation/validator/event/DateValidator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ public void validate(Reporter reporter, TrackerBundle bundle, Event event) {
}

validateCompletedDateIsSetOnlyForSupportedStatus(reporter, event);
validateExpiryDays(reporter, event, program, bundle.getUser());
validatePeriodType(reporter, event, program);
validateCompletionExpiryDays(reporter, event, program, bundle.getUser());
validateExpiryPeriodType(reporter, event, program);
}

private void validateCompletedDateIsSetOnlyForSupportedStatus(Reporter reporter, Event event) {
Expand All @@ -81,7 +81,7 @@ private void validateCompletedDateIsSetOnlyForSupportedStatus(Reporter reporter,
}
}

private void validateExpiryDays(
private void validateCompletionExpiryDays(
Reporter reporter, Event event, Program program, UserDetails user) {
if (event.getCompletedAt() == null || user.isAuthorized(Authorities.F_EDIT_EXPIRED.name())) {
return;
Expand All @@ -95,7 +95,7 @@ && now()
}
}

private void validatePeriodType(Reporter reporter, Event event, Program program) {
private void validateExpiryPeriodType(Reporter reporter, Event event, Program program) {
PeriodType periodType = program.getExpiryPeriodType();

if (periodType == null || program.getExpiryDays() == 0) {
Expand All @@ -111,9 +111,13 @@ private void validatePeriodType(Reporter reporter, Event event, Program program)
return;
}

Period period = periodType.createPeriod(new Date());
Period eventPeriod = periodType.createPeriod(Date.from(referenceDate));

if (referenceDate.isBefore(period.getStartDate().toInstant())) {
if (eventPeriod
.getEndDate()
.toInstant()
.plus(ofDays(program.getExpiryDays()))
.isBefore(Instant.now())) {
reporter.addError(event, E1047, event);
}
}
Expand Down
79 changes: 44 additions & 35 deletions ...test/java/org/hisp/dhis/tracker/imports/validation/validator/event/DateValidatorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,94 +90,78 @@ public void setUp() {

@Test
void testEventIsValid() {
// given
when(preheat.getProgram(MetadataIdentifier.ofUid(PROGRAM_WITHOUT_REGISTRATION_ID)))
.thenReturn(getProgramWithoutRegistration());
Event event = new Event();
event.setProgram(MetadataIdentifier.ofUid(PROGRAM_WITHOUT_REGISTRATION_ID));
event.setOccurredAt(now());
event.setStatus(EventStatus.ACTIVE);

// when
validator.validate(reporter, bundle, event);

// then
assertIsEmpty(reporter.getErrors());
}

@Test
void testEventIsNotValidWhenOccurredDateIsNotPresentAndProgramIsWithoutRegistration() {
// given
when(preheat.getProgram(MetadataIdentifier.ofUid(PROGRAM_WITHOUT_REGISTRATION_ID)))
.thenReturn(getProgramWithoutRegistration());
Event event = new Event();
event.setEvent(UID.generate());
event.setProgram(MetadataIdentifier.ofUid(PROGRAM_WITHOUT_REGISTRATION_ID));

// when
validator.validate(reporter, bundle, event);

// then
assertHasError(reporter, event, E1031);
}

@Test
void testEventIsNotValidWhenOccurredDateIsNotPresentAndEventIsActive() {
// given
when(preheat.getProgram(MetadataIdentifier.ofUid(PROGRAM_WITH_REGISTRATION_ID)))
.thenReturn(getProgramWithRegistration());
.thenReturn(getProgramWithRegistration(5));
Event event = new Event();
event.setEvent(UID.generate());
event.setProgram(MetadataIdentifier.ofUid(PROGRAM_WITH_REGISTRATION_ID));
event.setStatus(EventStatus.ACTIVE);

// when
validator.validate(reporter, bundle, event);

// then
assertHasError(reporter, event, E1031);
}

@Test
void testEventIsNotValidWhenOccurredDateIsNotPresentAndEventIsCompleted() {
// given
when(preheat.getProgram(MetadataIdentifier.ofUid(PROGRAM_WITH_REGISTRATION_ID)))
.thenReturn(getProgramWithRegistration());
.thenReturn(getProgramWithRegistration(5));
Event event = new Event();
event.setEvent(UID.generate());
event.setProgram(MetadataIdentifier.ofUid(PROGRAM_WITH_REGISTRATION_ID));
event.setStatus(EventStatus.COMPLETED);

// when
validator.validate(reporter, bundle, event);

// then
assertHasError(reporter, event, E1031);
}

@Test
void testEventIsNotValidWhenScheduledDateIsNotPresentAndEventIsSchedule() {
// given
when(preheat.getProgram(MetadataIdentifier.ofUid(PROGRAM_WITH_REGISTRATION_ID)))
.thenReturn(getProgramWithRegistration());
.thenReturn(getProgramWithRegistration(5));
Event event = new Event();
event.setEvent(UID.generate());
event.setProgram(MetadataIdentifier.ofUid(PROGRAM_WITH_REGISTRATION_ID));
event.setOccurredAt(Instant.now());
event.setStatus(EventStatus.SCHEDULE);

// when
validator.validate(reporter, bundle, event);

// then
assertHasError(reporter, event, E1050);
}

@Test
void shouldFailWhenCompletedAtIsPresentAndStatusIsNotCompleted() {
// given
when(preheat.getProgram(MetadataIdentifier.ofUid(PROGRAM_WITH_REGISTRATION_ID)))
.thenReturn(getProgramWithRegistration());
.thenReturn(getProgramWithRegistration(5));
Event event = new Event();
event.setEvent(UID.generate());
event.setProgram(MetadataIdentifier.ofUid(PROGRAM_WITH_REGISTRATION_ID));
Expand All @@ -192,66 +176,87 @@ void shouldFailWhenCompletedAtIsPresentAndStatusIsNotCompleted() {

@Test
void testEventIsNotValidWhenCompletedAtIsTooSoonAndEventIsCompleted() {
// given
when(preheat.getProgram(MetadataIdentifier.ofUid(PROGRAM_WITH_REGISTRATION_ID)))
.thenReturn(getProgramWithRegistration());
.thenReturn(getProgramWithRegistration(5));
Event event = new Event();
event.setEvent(UID.generate());
event.setProgram(MetadataIdentifier.ofUid(PROGRAM_WITH_REGISTRATION_ID));
event.setOccurredAt(now());
event.setCompletedAt(sevenDaysAgo());
event.setStatus(EventStatus.COMPLETED);

// when
validator.validate(reporter, bundle, event);

// then
assertHasError(reporter, event, E1043);
}

@Test
void testEventIsNotValidWhenOccurredAtAndScheduledAtAreNotPresent() {
// given
when(preheat.getProgram(MetadataIdentifier.ofUid(PROGRAM_WITH_REGISTRATION_ID)))
.thenReturn(getProgramWithRegistration());
.thenReturn(getProgramWithRegistration(5));
Event event = new Event();
event.setEvent(UID.generate());
event.setProgram(MetadataIdentifier.ofUid(PROGRAM_WITH_REGISTRATION_ID));
event.setOccurredAt(null);
event.setScheduledAt(null);
event.setStatus(EventStatus.SKIPPED);

// when
validator.validate(reporter, bundle, event);

// then
assertHasError(reporter, event, E1046);
}

@Test
void testEventIsNotValidWhenDateBelongsToExpiredPeriod() {
// given
void shouldFailValidationForEventWhenDateBelongsToExpiredPeriod() {
when(preheat.getProgram(MetadataIdentifier.ofUid(PROGRAM_WITH_REGISTRATION_ID)))
.thenReturn(getProgramWithRegistration());
.thenReturn(getProgramWithRegistration(5));
Event event = new Event();
event.setEvent(UID.generate());
event.setProgram(MetadataIdentifier.ofUid(PROGRAM_WITH_REGISTRATION_ID));
event.setOccurredAt(sevenDaysAgo());
event.setStatus(EventStatus.ACTIVE);

// when
validator.validate(reporter, bundle, event);

// then
assertHasError(reporter, event, E1047);
}

private Program getProgramWithRegistration() {
@Test
void shouldPassValidationForEventWhenDateBelongsToPastPeriodWithZeroExpiryDays() {
when(preheat.getProgram(MetadataIdentifier.ofUid(PROGRAM_WITH_REGISTRATION_ID)))
.thenReturn(getProgramWithRegistration(0));
Event event = new Event();
event.setEvent(UID.generate());
event.setProgram(MetadataIdentifier.ofUid(PROGRAM_WITH_REGISTRATION_ID));
event.setOccurredAt(sevenDaysAgo());
event.setStatus(EventStatus.ACTIVE);

validator.validate(reporter, bundle, event);

assertIsEmpty(reporter.getErrors());
}

@Test
void shouldPassValidationForEventWhenScheduledDateBelongsToFuturePeriod() {
when(preheat.getProgram(MetadataIdentifier.ofUid(PROGRAM_WITH_REGISTRATION_ID)))
.thenReturn(getProgramWithRegistration(5));
Event event = new Event();
event.setEvent(UID.generate());
event.setProgram(MetadataIdentifier.ofUid(PROGRAM_WITH_REGISTRATION_ID));
event.setScheduledAt(sevenDaysLater());
event.setStatus(EventStatus.SCHEDULE);

validator.validate(reporter, bundle, event);

assertIsEmpty(reporter.getErrors());
}

private Program getProgramWithRegistration(int expiryDays) {
Program program = createProgram('A');
program.setUid(PROGRAM_WITH_REGISTRATION_ID);
program.setProgramType(ProgramType.WITH_REGISTRATION);
program.setCompleteEventsExpiryDays(5);
program.setExpiryDays(5);
program.setExpiryDays(expiryDays);
program.setExpiryPeriodType(new DailyPeriodType());
return program;
}
Expand All @@ -270,4 +275,8 @@ private Instant now() {
private Instant sevenDaysAgo() {
return LocalDateTime.now().minusDays(7).toInstant(ZoneOffset.UTC);
}

private Instant sevenDaysLater() {
return LocalDateTime.now().plusDays(7).toInstant(ZoneOffset.UTC);
}
}
Loading