PI-2543 Create initial project for appointment-reminders-and-delius (#…

…4334)

* PI-2543 Create initial project for appointment-reminders-and-delius

* Update access.yml

---------

Co-authored-by: probation-integration-bot[bot] <177347787+probation-integration-bot[bot]@users.noreply.github.com>
Co-authored-by: Marcus Aspin <[email protected]>

.github/workflows/access.yml

@@ -56,6 +56,7 @@ on:
           - '["subject-access-requests-and-delius"]'
           - '["common-platform-and-delius"]'
           - '["ims-and-delius"]'
+          - '["appointment-reminders-and-delius"]'
           # ^ add new projects here
           # GitHub Actions doesn't support dynamic choices, we must add each project here to enable manual deployments
           # See https://github.com/community/community/discussions/11795

.github/workflows/build.yml

@@ -79,6 +79,7 @@ jobs:
           - subject-access-requests-and-delius
           - common-platform-and-delius
           - ims-and-delius
+          - appointment-reminders-and-delius
           # ^ add new projects here
           # GitHub Actions doesn't support dynamic choices, we must add each project here to enable manual deployments
           # See https://github.com/community/community/discussions/11795

.github/workflows/deploy.yml

@@ -71,6 +71,7 @@ on:
           - '["subject-access-requests-and-delius"]'
           - '["common-platform-and-delius"]'
           - '["ims-and-delius"]'
+          - '["appointment-reminders-and-delius"]'
           # ^ add new projects here
           # GitHub Actions doesn't support dynamic choices, we must add each project here to enable manual deployments
           # See https://github.com/community/community/discussions/11795

.github/workflows/service-catalogue.yml

@@ -56,6 +56,7 @@ on:
           - '["subject-access-requests-and-delius"]'
           - '["common-platform-and-delius"]'
           - '["ims-and-delius"]'
+          - '["appointment-reminders-and-delius"]'
           # ^ add new projects here
           # GitHub Actions doesn't support dynamic choices, we must add each project here to enable manual deployments
           # See https://github.com/community/community/discussions/11795

doc/tech-docs/source/services.html.md.erb

@@ -83,4 +83,5 @@ weight: 20
 * [Subject Access Requests And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/subject-access-requests-and-delius)
 * [Common Platform And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/common-platform-and-delius)
 * [Ims And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/ims-and-delius)
+* [Appointment Reminders And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/appointment-reminders-and-delius)
 <li style="display: none">^ add new projects here</li>

projects/appointment-reminders-and-delius/README.md

@@ -0,0 +1,3 @@
+# appointment-reminders-and-delius
+
+// TODO Describe the service

projects/appointment-reminders-and-delius/applicationinsights.json

@@ -0,0 +1,62 @@
+{
+  "role": {
+    "name": "appointment-reminders-and-delius"
+  },
+  "customDimensions": {
+    "service.version": "${VERSION}",
+    "service.team": "probation-integration"
+  },
+  "instrumentation": {
+    "logging": {
+      "level": "DEBUG"
+    },
+    "springScheduling": {
+      "enabled": false
+    }
+  },
+  "selfDiagnostics": {
+    "destination": "console"
+  },
+  "sampling": {
+    "percentage": 100
+  },
+  "preview": {
+    "sampling": {
+      "overrides": [
+        {
+          "telemetryType": "request",
+          "attributes": [
+            {
+              "key": "http.url",
+              "value": "https?://[^/]+/health/?.*",
+              "matchType": "regexp"
+            }
+          ],
+          "percentage": 0
+        },
+        {
+          "telemetryType": "request",
+          "attributes": [
+            {
+              "key": "http.url",
+              "value": "https?://[^/]+/info/?.*",
+              "matchType": "regexp"
+            }
+          ],
+          "percentage": 0
+        },
+        {
+          "telemetryType": "dependency",
+          "attributes": [
+            {
+              "key": "db.operation",
+              "value": "SELECT",
+              "matchType": "strict"
+            }
+          ],
+          "percentage": 10
+        }
+      ]
+    }
+  }
+}

projects/appointment-reminders-and-delius/build.gradle.kts

@@ -0,0 +1,36 @@
+import uk.gov.justice.digital.hmpps.extensions.ClassPathExtension
+
+apply(plugin = "com.google.cloud.tools.jib")
+
+dependencies {
+    implementation(project(":libs:audit"))
+    implementation(project(":libs:commons"))
+    implementation(project(":libs:oauth-server"))
+
+    implementation("org.springframework.boot:spring-boot-starter-actuator")
+    implementation("org.springframework.boot:spring-boot-starter-data-jpa")
+    implementation("org.springframework.boot:spring-boot-starter-security")
+    implementation("org.springframework.boot:spring-boot-starter-validation")
+    implementation("org.springframework.boot:spring-boot-starter-web")
+    implementation("org.jetbrains.kotlin:kotlin-reflect")
+    implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
+    implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
+    implementation(libs.springdoc)
+
+    dev(project(":libs:dev-tools"))
+    dev("com.h2database:h2")
+    dev("org.testcontainers:oracle-xe")
+
+    runtimeOnly("com.oracle.database.jdbc:ojdbc11")
+
+    testImplementation("org.springframework.boot:spring-boot-starter-test")
+    testImplementation(libs.bundles.mockito)
+}
+
+configure<ClassPathExtension> {
+    jacocoExclusions = listOf(
+        "**/config/**",
+        "**/entity/**",
+        "**/AppKt.class"
+    )
+}

projects/appointment-reminders-and-delius/deploy/Chart.yaml

@@ -0,0 +1,13 @@
+apiVersion: v2
+appVersion: '1.0'
+description: A Helm chart for Kubernetes
+name: appointment-reminders-and-delius
+version: 1.0.0
+
+dependencies:
+  - name: generic-service
+    version: "3.2"
+    repository: https://ministryofjustice.github.io/hmpps-helm-charts
+  - name: generic-prometheus-alerts
+    version: "1.4"
+    repository: https://ministryofjustice.github.io/hmpps-helm-charts

projects/appointment-reminders-and-delius/deploy/database/access.yml

@@ -0,0 +1,9 @@
+database:
+  access:
+    username_key: /appointment-reminders-and-delius/db-username
+    password_key: /appointment-reminders-and-delius/db-password
+
+  audit:
+    username: AppointmentRemindersAndDelius
+    forename: Appointment Reminders
+    surname: Service

projects/appointment-reminders-and-delius/deploy/values-dev.yml

@@ -0,0 +1,17 @@
+enabled: false # TODO set this to true when you're ready to deploy your service
+
+generic-service:
+  ingress:
+    host: appointment-reminders-and-delius-dev.hmpps.service.justice.gov.uk
+
+  scheduledDowntime:
+    enabled: true
+
+  env:
+    SENTRY_ENVIRONMENT: dev
+    LOGGING_LEVEL_UK_GOV_DIGITAL_JUSTICE_HMPPS: DEBUG
+    SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_JWK_SET_URI: https://sign-in-dev.hmpps.service.justice.gov.uk/auth/.well-known/jwks.json
+    SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_ISSUER_URI: https://sign-in-dev.hmpps.service.justice.gov.uk/auth/issuer
+
+generic-prometheus-alerts:
+  businessHoursOnly: true

projects/appointment-reminders-and-delius/deploy/values-preprod.yml

@@ -0,0 +1,16 @@
+enabled: false # TODO set this to true when you're ready to deploy your service
+
+generic-service:
+  ingress:
+    host: appointment-reminders-and-delius-preprod.hmpps.service.justice.gov.uk
+
+  scheduledDowntime:
+    enabled: true
+
+  env:
+    SENTRY_ENVIRONMENT: preprod
+    SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_JWK_SET_URI: https://sign-in-preprod.hmpps.service.justice.gov.uk/auth/.well-known/jwks.json
+    SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_ISSUER_URI: https://sign-in-preprod.hmpps.service.justice.gov.uk/auth/issuer
+
+generic-prometheus-alerts:
+  businessHoursOnly: true

projects/appointment-reminders-and-delius/deploy/values-prod.yml

@@ -0,0 +1,10 @@
+enabled: false # TODO set this to true when you're ready to deploy your service
+
+generic-service:
+  ingress:
+    host: appointment-reminders-and-delius.hmpps.service.justice.gov.uk
+
+  env:
+    SENTRY_ENVIRONMENT: prod
+    SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_JWK_SET_URI: https://sign-in.hmpps.service.justice.gov.uk/auth/.well-known/jwks.json
+    SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_ISSUER_URI: https://sign-in.hmpps.service.justice.gov.uk/auth/issuer

projects/appointment-reminders-and-delius/deploy/values.yaml

@@ -0,0 +1,23 @@
+# Common values
+generic-service:
+  productId: HMPPS518
+  nameOverride: appointment-reminders-and-delius
+
+  image:
+    repository: ghcr.io/ministryofjustice/hmpps-probation-integration-services/appointment-reminders-and-delius
+
+  ingress:
+    tlsSecretName: appointment-reminders-and-delius-cert
+
+  namespace_secrets:
+    common:
+      SPRING_DATASOURCE_URL: DB_URL
+    appointment-reminders-and-delius-database:
+      SPRING_DATASOURCE_USERNAME: DB_USERNAME
+      SPRING_DATASOURCE_PASSWORD: DB_PASSWORD
+    appointment-reminders-and-delius-sentry:
+      SENTRY_DSN: SENTRY_DSN
+
+generic-prometheus-alerts:
+  targetApplication: appointment-reminders-and-delius
+

projects/appointment-reminders-and-delius/settings.gradle.kts

@@ -0,0 +1 @@
+rootProject.name = "appointment-reminders-and-delius"

projects/appointment-reminders-and-delius/src/dev/kotlin/uk/gov/justice/digital/hmpps/data/DataLoader.kt

@@ -0,0 +1,25 @@
+package uk.gov.justice.digital.hmpps.data
+
+import jakarta.annotation.PostConstruct
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty
+import org.springframework.boot.context.event.ApplicationReadyEvent
+import org.springframework.context.ApplicationListener
+import org.springframework.stereotype.Component
+import uk.gov.justice.digital.hmpps.data.generator.UserGenerator
+import uk.gov.justice.digital.hmpps.user.AuditUserRepository
+
+@Component
+@ConditionalOnProperty("seed.database")
+class DataLoader(
+    private val auditUserRepository: AuditUserRepository
+) : ApplicationListener<ApplicationReadyEvent> {
+
+    @PostConstruct
+    fun saveAuditUser() {
+        auditUserRepository.save(UserGenerator.AUDIT_USER)
+    }
+
+    override fun onApplicationEvent(are: ApplicationReadyEvent) {
+        // Perform dev/test database setup here, using JPA repositories and generator classes...
+    }
+}

projects/appointment-reminders-and-delius/src/dev/kotlin/uk/gov/justice/digital/hmpps/data/generator/UserGenerator.kt

@@ -0,0 +1,7 @@
+package uk.gov.justice.digital.hmpps.data.generator
+
+import uk.gov.justice.digital.hmpps.user.AuditUser
+
+object UserGenerator {
+    val AUDIT_USER = AuditUser(IdGenerator.getAndIncrement(), "AppointmentRemindersAndDelius")
+}

projects/appointment-reminders-and-delius/src/integrationTest/kotlin/uk/gov/justice/digital/hmpps/IntegrationTest.kt

@@ -0,0 +1,30 @@
+package uk.gov.justice.digital.hmpps
+
+import org.junit.jupiter.api.Test
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc
+import org.springframework.boot.test.context.SpringBootTest
+import org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT
+import org.springframework.boot.test.mock.mockito.MockBean
+import org.springframework.test.web.servlet.MockMvc
+import org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get
+import org.springframework.test.web.servlet.result.MockMvcResultMatchers.status
+import uk.gov.justice.digital.hmpps.test.MockMvcExtensions.withToken
+import uk.gov.justice.digital.hmpps.telemetry.TelemetryService
+
+@AutoConfigureMockMvc
+@SpringBootTest(webEnvironment = RANDOM_PORT)
+internal class IntegrationTest {
+    @Autowired
+    lateinit var mockMvc: MockMvc
+
+    @MockBean
+    lateinit var telemetryService: TelemetryService
+
+    @Test
+    fun `API call retuns a success response`() {
+        mockMvc
+            .perform(get("/example/123").withToken())
+            .andExpect(status().is2xxSuccessful)
+    }
+}

projects/appointment-reminders-and-delius/src/main/kotlin/uk/gov/justice/digital/hmpps/App.kt

@@ -0,0 +1,11 @@
+package uk.gov.justice.digital.hmpps
+
+import org.springframework.boot.autoconfigure.SpringBootApplication
+import org.springframework.boot.runApplication
+
+@SpringBootApplication
+class App
+
+fun main(args: Array<String>) {
+    runApplication<App>(*args)
+}

projects/appointment-reminders-and-delius/src/main/kotlin/uk/gov/justice/digital/hmpps/controller/ApiController.kt

@@ -0,0 +1,17 @@
+package uk.gov.justice.digital.hmpps.controller
+
+import org.springframework.security.access.prepost.PreAuthorize
+import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.PathVariable
+import org.springframework.web.bind.annotation.RestController
+
+@RestController
+class ApiController {
+    @PreAuthorize("hasRole('EXAMPLE')")
+    @GetMapping(value = ["/example/{inputId}"])
+    fun handle(
+        @PathVariable("inputId") inputId: String
+    ) {
+        // TODO Not yet implemented
+    }
+}