merged in main

Author: karlfosterBCL

.github/workflows/security_owasp.yml

@@ -1,8 +1,8 @@
-# hmpps-breach-notice-api
+# HMPPS Breach Notice API
 
 [![repo standards badge](https://img.shields.io/badge/endpoint.svg?&style=flat&logo=github&url=https%3A%2F%2Foperations-engineering-reports.cloud-platform.service.justice.gov.uk%2Fapi%2Fv1%2Fcompliant_public_repositories%2Fhmpps-breach-notice-api)](https://operations-engineering-reports.cloud-platform.service.justice.gov.uk/public-report/hmpps-breach-notice-api "Link to report")
 [![Docker Repository on ghcr](https://img.shields.io/badge/ghcr.io-repository-2496ED.svg?logo=docker)](https://ghcr.io/ministryofjustice/hmpps-breach-notice-api)
-[![API docs](https://img.shields.io/badge/API_docs_-view-85EA2D.svg?logo=swagger)](https://hmpps-breach-notice-api-dev.hmpps.service.justice.gov.uk/webjars/swagger-ui/index.html?configUrl=/v3/api-docs)
+[![API docs](https://img.shields.io/badge/API_docs_-view-85EA2D.svg?logo=swagger)](https://breach-notice-api-dev.hmpps.service.justice.gov.uk/swagger-ui/index.html)
 
 API back-end for the [HMPPS Breach Notice](https://github.com/ministryofjustice/hmpps-breach-notice-ui) service.
 

README.md

@@ -83,3 +83,4 @@ gotenberg:
 
 generic-prometheus-alerts:
   targetApplication: hmpps-breach-notice-api
+  alertSeverity: breach-notice-notifications

helm_deploy/hmpps-breach-notice-api/values.yaml

@@ -70,4 +70,5 @@ data class BreachNoticeEntity(
   var optionalNumber: String? = null,
   var reviewRequiredDate: LocalDateTime? = null,
   var reviewEvent: String? = null,
+  val conditionBeingEnforced: String? = null,
 )

src/main/kotlin/uk/gov/justice/digital/hmpps/breachnoticeapi/entity/BreachNoticeEntity.kt

@@ -12,6 +12,7 @@ import org.springframework.data.annotation.CreatedDate
 import org.springframework.data.annotation.LastModifiedBy
 import org.springframework.data.annotation.LastModifiedDate
 import org.springframework.data.jpa.domain.support.AuditingEntityListener
+import java.time.LocalDate
 import java.time.LocalDateTime
 import java.util.*
 
@@ -29,6 +30,8 @@ data class BreachNoticeRequirementEntity(
   val requirementTypeMainCategoryDescription: String? = null,
   val requirementTypeSubCategoryDescription: String? = null,
   val rejectionReason: String? = null,
+  val fromDate: LocalDate? = null,
+  val toDate: LocalDate? = null,
   @CreatedBy
   var createdByUser: String? = null,
   @CreatedDate

src/main/kotlin/uk/gov/justice/digital/hmpps/breachnoticeapi/entity/BreachNoticeRequirementEntity.kt

@@ -47,7 +47,7 @@ class DomainEventsListener(
           message.targetCrn?.let { it1 -> breachNoticeService.updateBreachNoticeCrn(it, it1) }
         }
 
-        updateReviewEvent(ReviewEventType.UNMERGE, breachNotices, message.occurredAt)
+        updateReviewEvent(ReviewEventType.MERGE, breachNotices, message.occurredAt)
       }
 
       "probation-case.unmerge.completed" -> {

src/main/kotlin/uk/gov/justice/digital/hmpps/breachnoticeapi/listener/DomainEventsListener.kt

@@ -43,4 +43,5 @@ data class BreachNotice(
   val optionalNumber: String? = null,
   var reviewRequiredDate: LocalDateTime? = null,
   var reviewEvent: String? = null,
+  val conditionBeingEnforced: String? = null,
 )

src/main/kotlin/uk/gov/justice/digital/hmpps/breachnoticeapi/model/BreachNotice.kt

@@ -12,7 +12,7 @@ data class BreachNoticeDetails(
   val titleAndFullName: String? = null,
   val dateOfLetter: LocalDate? = null,
   val referenceNumber: String? = null,
-  val responseRequiredByDate: LocalDate? = null,
+  val responseRequiredDate: LocalDate? = null,
   val breachNoticeTypeCode: String? = null,
   val breachNoticeTypeDescription: String? = null,
   val breachConditionTypeCode: String? = null,
@@ -43,4 +43,5 @@ data class BreachNoticeDetails(
   val optionalNumber: String? = null,
   var reviewRequiredDate: LocalDateTime? = null,
   var reviewEvent: String? = null,
+  val conditionBeingEnforced: String? = null,
 )

src/main/kotlin/uk/gov/justice/digital/hmpps/breachnoticeapi/model/BreachNoticeDetails.kt

@@ -1,5 +1,6 @@
 package uk.gov.justice.digital.hmpps.breachnoticeapi.model
 
+import java.time.LocalDate
 import java.util.*
 
 data class BreachNoticeRequirement(
@@ -8,6 +9,6 @@ data class BreachNoticeRequirement(
   val requirementTypeMainCategoryDescription: String? = null,
   val requirementTypeSubCategoryDescription: String? = null,
   val rejectionReason: String? = null,
-  val fromDate: String? = null,
-  val toDate: String? = null,
+  val fromDate: LocalDate? = null,
+  val toDate: LocalDate? = null,
 )

src/main/kotlin/uk/gov/justice/digital/hmpps/breachnoticeapi/model/BreachNoticeRequirement.kt

@@ -81,6 +81,7 @@ class BreachNoticeService(
     useDefaultReplyAddress = useDefaultReplyAddress,
     reviewRequiredDate =  reviewRequiredDate,
     reviewEvent = reviewEvent,
+    conditionBeingEnforced = conditionBeingEnforced,
     breachNoticeContactList = breachNoticeContactList.map {
       it.toEntity(
         existingEntity.breachNoticeContactList.find { existingContactEnitiy ->
@@ -168,6 +169,7 @@ class BreachNoticeService(
     optionalNumber = optionalNumber,
     reviewRequiredDate =  reviewRequiredDate,
     reviewEvent = reviewEvent,
+    conditionBeingEnforced = conditionBeingEnforced,
   )
 
   fun getBreachNoticeById(uuid: UUID) = breachNoticeRepository.findById(uuid).getOrNull()?.let {
@@ -177,7 +179,7 @@ class BreachNoticeService(
       titleAndFullName = it.titleAndFullName,
       dateOfLetter = it.dateOfLetter,
       referenceNumber = it.referenceNumber,
-      responseRequiredByDate = it.responseRequiredDate,
+      responseRequiredDate = it.responseRequiredDate,
       breachNoticeTypeCode = it.breachNoticeTypeCode,
       breachNoticeTypeDescription = it.breachNoticeTypeDescription,
       breachConditionTypeCode = it.breachConditionTypeCode,
@@ -206,6 +208,7 @@ class BreachNoticeService(
       optionalNumber = it.optionalNumber,
       reviewRequiredDate =  it.reviewRequiredDate,
       reviewEvent = it.reviewEvent,
+      conditionBeingEnforced = it.conditionBeingEnforced,
     )
   }
 
@@ -268,18 +271,24 @@ class BreachNoticeService(
     requirementTypeMainCategoryDescription = requirementTypeMainCategoryDescription,
     requirementTypeSubCategoryDescription = requirementTypeSubCategoryDescription,
     rejectionReason = rejectionReason,
+    fromDate = fromDate,
+    toDate = toDate,
   )
 
   private fun BreachNoticeRequirement.toEntity(existingEntity: BreachNoticeRequirementEntity? = null) = existingEntity?.copy(
     requirementId = requirementId,
     requirementTypeMainCategoryDescription = requirementTypeMainCategoryDescription,
     requirementTypeSubCategoryDescription = requirementTypeSubCategoryDescription,
     rejectionReason = rejectionReason,
+    fromDate = fromDate,
+    toDate = toDate,
   ) ?: BreachNoticeRequirementEntity(
     requirementId = requirementId,
     requirementTypeMainCategoryDescription = requirementTypeMainCategoryDescription,
     requirementTypeSubCategoryDescription = requirementTypeSubCategoryDescription,
     rejectionReason = rejectionReason,
+    fromDate = fromDate,
+    toDate = toDate,
   )
 
   fun getBreachNoticeAsPdf(id: UUID, breachNoticeDetails: BreachNoticeDetails?, draft: Boolean): ByteArray? {

src/main/kotlin/uk/gov/justice/digital/hmpps/breachnoticeapi/service/BreachNoticeService.kt

@@ -0,0 +1,3 @@
+ALTER TABLE public.breach_notice_requirement ADD from_date timestamp without time zone NULL;
+ALTER TABLE public.breach_notice_requirement ADD to_date timestamp without time zone NULL;
+

src/main/resources/db/migration/V1_2__domain_event_fields.sql

@@ -0,0 +1 @@
+ALTER TABLE public.breach_notice ADD condition_being_enforced varchar(200) NULL;

src/main/resources/db/migration/V1_2__requirement_date_range.sql

@@ -0,0 +1,4 @@
+ALTER TABLE public.breach_notice ADD review_required_date timestamp without time zone NULL;
+ALTER TABLE public.breach_notice ADD review_event varchar(100) NULL;
+
+

src/main/resources/db/migration/V1_3__condition_being_enforced.sql

@@ -230,7 +230,7 @@
 <p lang="en-US" class="western" align="justify" style="line-height: 100%; margin-bottom: 0cm">
 <font face="Arial, serif"><span lang="en-GB">You must contact me
 immediately to explain your reason (s) AND provide me with acceptable
-supporting evidence for your breach, by <span th:text="${#temporals.format(breachNotice.responseRequiredByDate, 'dd/MM/yyyy')}">{responseDate}</span>.  If
+supporting evidence for your breach, by <span th:text="${#temporals.format(breachNotice.responseRequiredDate, 'dd/MM/yyyy')}">{responseDate}</span>.  If
 you do not provide me with an acceptable reason and acceptable
 supporting evidence by this date, your failure to comply will remain
 as a breach of this Order.</span></font></p>