ministryofjustice / hmpps-probation-estate-api

HMPPS Probation Estate API

hmpps-probation-estate-api

This is the HMPPS Probation Estate API. This is used to serve Probation estate information

How to run locally

Run docker and launch the service in Intellij

• We need a postgres database to back the application and we can use a local docker one. The flyway scripts will deploy the schema and all lookup data we need for this application
• To launch the postgres docker container run the following:

docker compose up -d

• Open this repo in Intellij
• Right-click and Run uk.gov.justice.digital.hmpps.hmppsprobationestateapi.HmppsProbationEstateApi
• This will fail initially but will have created a Run Configuration called HmppsProbationEstateApi in the configuration dropdown next to the Run and Debug buttons
• Click on the HmppsProbationEstateApi configuration > Edit Configuration
• In the VM Options box paste the following:

-Dspring.profiles.active=local

• Save the configuration with the following:
  • Click Apply
  • Click OK
• You should now be able to Run and Debug the application using this configuration by hitting the Run and Debug buttons next to the configuration
• One the application is up and running

Run service in Terminal

Execute the following command:

docker compose up -d
./gradlew bootRun -Dspring.profiles.active=local

How to run the tests locally

These tests are defaults from the template, and the app only serves to run the flyway scripts. This allows you to test that the scripts work locally against postgresql in docker

docker compose up -d
./gradlew clean check

Code style & formatting

./gradlew ktlintApplyToIdea addKtlintFormatGitPreCommitHook

will apply ktlint styles to intellij and also add a pre-commit hook to format all changed kotlin files.

hmpps-probation-estate-api's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Pin hmpps orb to 8.1.0
• Update Helm release generic-prometheus-alerts to v1.3.3
• Update plugin org.jetbrains.kotlin.plugin.spring to v1.9.22
• Update dependency gradle to v8.5
• Update dependency org.postgresql:postgresql to v42.7.1
• Update dependency org.springdoc:springdoc-openapi-starter-webflux-ui to v2.3.0
• Update plugin uk.gov.justice.hmpps.gradle-spring-boot to v5.14.1
• Update eclipse-temurin Docker tag to v21
• Update postgres Docker tag to v16
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

circleci

.circleci/config.yml

• hmpps 8

docker-compose

docker-compose.yml

• postgres 14

dockerfile

Dockerfile

• eclipse-temurin 18-jre-jammy
• eclipse-temurin 18-jre-jammy

gradle

gradle.properties

settings.gradle.kts

build.gradle.kts

• uk.gov.justice.hmpps.gradle-spring-boot 5.10.0
• org.jetbrains.kotlin.plugin.spring 1.9.10
• org.jetbrains.kotlinx:kotlinx-coroutines-core 1.7.3
• org.jetbrains.kotlinx:kotlinx-coroutines-reactor 1.7.3
• org.springdoc:springdoc-openapi-starter-webflux-ui 2.2.0
• org.postgresql:r2dbc-postgresql 1.0.4.RELEASE
• org.postgresql:postgresql 42.6.0
• org.jetbrains.kotlinx:kotlinx-coroutines-test 1.7.3

gradle-wrapper

gradle/wrapper/gradle-wrapper.properties

• gradle 8.3

helm-values

helm_deploy/hmpps-probation-estate-api/values.yaml

helmv3

helm_deploy/hmpps-probation-estate-api/Chart.yaml

• generic-service 2.9
• generic-prometheus-alerts 1.3.2

---

• Check this box to trigger a request for Renovate to run again on this repository

User access removed, access is now via a team

Hi there

The user bjpirt had Direct Member access to this repository and access via a team.

Access is now only via a team.

You may have less access it is dependant upon the teams access to the repo.

If you have any questions, please post in #ask-operations-engineering on Slack.

This issue can be closed.