uk-gov-mirror/hmcts.probate-back-office

w # Spring Boot application template

Purpose

The purpose of this template is to speed up the creation of new Spring applications within HMCTS and help keep the same standards across multiple teams. If you need to create a new app, you can simply use this one as a starting point and build on top of it.

What's inside

The template is a working application with a minimal setup. It contains:

application skeleton
common plugins and libraries
docker setup
code quality tools already set up
integration with Travis CI
Hystrix circuit breaker enabled
Hystrix dashboard
MIT license and contribution information

The application exposes health endpoint (http://localhost:4550/health) and metrics endpoint (http://localhost:4550/metrics).

Plugins

The template contains the following plugins:

checkstyle

https://docs.gradle.org/current/userguide/checkstyle_plugin.html

Performs quality checks on Java source files using Checkstyle and generates reports from these checks. The checks are included in gradle's check task (you can run them by executing gradle check command).
jacoco

https://docs.gradle.org/current/userguide/jacoco_plugin.html

Provides code coverage metrics for Java code via integration with JaCoCo. You can create the report by running the following command:
```
  ./gradlew jacocoTestReport
```
The report will be created in build/reports subdirectory in your project directory.
io.spring.dependency-management

https://github.com/spring-gradle-plugins/dependency-management-plugin

Provides Maven-like dependency management. Allows you to declare dependency management using dependency 'groupId:artifactId:version' or dependency group:'group', name:'name', version:version'.
org.springframework.boot

http://projects.spring.io/spring-boot/

Reduces the amount of work needed to create a Spring application
org.owasp.dependencycheck

https://jeremylong.github.io/DependencyCheck/dependency-check-gradle/index.html

Provides monitoring of the project's dependent libraries and creating a report of known vulnerable components that are included in the build. To run it execute gradle dependencyCheck command.
com.github.ben-manes.versions

https://github.com/ben-manes/gradle-versions-plugin

Provides a task to determine which dependencies have updates. Usage:
```
  ./gradlew dependencyUpdates -Drevision=release
```

Building and deploying the application

Building the application

The project uses Gradle as a build tool. It already contains ./gradlew wrapper script, so there's no need to install gradle.

To build the project execute the following command:

  ./gradlew build

Docker environment

Because the probate back office relies on CCD callbacks it must be run inside the docker-compose environment, and must be built before bringing the environment up. You will need to recompile after any code changes.

Build the jar with:

./gradlew assemble
docker-compose build

Bring up the environment:


# build the jar
./gradlew assemble

# first time only
npx @hmcts/probate-dev-env --create

# spin up the docker containers
npx @hmcts/probate-dev-env

# use local probate backoffice
docker-compose stop probate-back-office
./gradlew assemble
docker-compose up -d --build probate-back-office

If you would like to test a new CCD config locally, you should run:

./ccdImports/conversionScripts/createAllXLS.sh probate-back-office:4104
./ccdImports/conversionScripts/importAllXLS.sh

Full setup

Guidance on how to set up probate locally using the updated docker images.

1) Install https://stedolan.github.io/jq/

  sudo apt-get install jq

For mac

  brew install jq

NB. If you download the binary version it is called 'jq-osx-amd64' and the scripts later will fail because they are looking for 'jq'.

2) Login to azure

  az login
  az acr login --name hmctspublic --subscription DCD-CNP-Prod
  az acr login --name hmctsprivate --subscription DCD-CNP-Prod

3) Reset your docker images, containers etc.

   docker container rm $(docker container ls -a -q)
   docker image rm $(docker image ls -a -q)
   docker volume rm $(docker volume ls -q)

NB. Docker for desktop on a mac only allocates 2GB of memory by default, this is not enough I increased mine 16GB.

4) Run environments script

   ./ccd login

For linux/Mac

   source ./bin/linux-set-environment-variables.sh

4.1) setup logstash

In order to work locally on probate-frontend you will need to clone project ccd-logstash from github. Checkout the probate-conf branch and build the docker image

   git checkout probate-conf
   docker build . -t ccd-logstash:probate

In probate-back-office/compose/elasticsearch.yml replace image: hmcts/ccd-logstash:latest with image: "ccd-logstash:probate"

5) Start up docker

   docker network create compose_default
   ./ccd compose pull
   ./ccd compose build
   ./ccd compose up

6) Create blob store container

Once docker has started run

   ./bin/document-management-store-create-blob-store-container.sh

7) Restart dm-store container

Find id of dm-store container

   docker ps | grep dm-store_1

Use id to stop container

   docker stop compose_dm-store_1_id

Start the dm-store container

   ./ccd compose up -d dm-store

7.1) Restart other containers

On linux you may have to restart any failing containers. These often fail to start:

dm-store
fees-api
payments-api
sidam-api

Restart in that order

8) Setup IDAM data.

   ./bin/idam-client-setup.sh

To check the IDAM data, you can log into IDAM-web http://localhost:8082/login with idamOwner@hmcts.net/Ref0rmIsFun.

9) Generate roles, json->xls and import

Create roles and users

   ./bin/ccd-add-all-roles.sh

You can check the user and roles on the IDAM-web by searching for ProbateSolCW1@gmail.com on Manager Users page.

Generate xls

For mac

   ./ccdImports/conversionScripts/createAllXLS.sh docker.for.mac.localhost:4104

For Windows 10

   ./ccdImports/conversionScripts/createAllXLS.sh docker.for.win.localhost:4104

For linux (replace ip with your own ip)

   ./ccdImports/conversionScripts/createAllXLS.sh probate-back-office:4104

Import xls

   ./ccdImports/conversionScripts/importAllXLS.sh

10) Start your local service

Pull probate specific ccd-logstash

pull ccd-logstash branch probate-conf locally then

docker build . -t ccd-logstash:probate

Probate-back-office

Login to ccd on http://localhost:3451. Caseworker: ProbateSolCW1@gmail.com / Pa55word11. Solicitor ProbateSolicitor1@gmail.com / Pa55word11.

Start logstash-probateman (for legacy cases)

   sudo /usr/share/logstash/bin/logstash -f logstash/legacy-case-data-local.conf

Run probate-back-office app.

loging into to ccd-ui

For a solicitor use ProbateSolicitor1@gmail.com : password
Alternatively, for a caseworker use
ProbateSolCW1@gmail.com : password

local document-store

You can go to a doc in dm by going to localhost:3453/documents/[**ID**]/binary .

Using Payments and fees

Add keywords to fees database

    ./bin/fees-add-keyword.sh

Running Back Office Puppeteer End To End Tests

The tests are located at src/test/end-to-end and must be maintainend and run, as they are run as part of the nightly Jenkins CI build. Configuration is set by default to be able to run in an npx created local environment without amendment.

Config is by environment variables with defaults if not present. The .env file does not contain environment variables, and so default values will be used for local run. These can be found in src/test/config.js, and are used by codecept config file src/test/end-to-end/codecept.conf.js.

The tests are node.js and best run in vs code. A launch vs code configuration has been provided to run the yarn script test:fullfunctional (not to be confused with functional tests).

To see if it's running ok, change config value TestShowBrowserWindow in config.js from false to true and the browser will show, allowing you to see what's going on.

The default test configuration runs all end to end tests, however, often we just want to run the ones that are failing. As a step towards running an individual test, a new env var has been added for local use: process.env.E2E_TEST_PATH (see config.js).

This defaults to './paths/**/*.js', which the Jenkins nightly build will use. However you can set this to a specific .js file path in src/test/paths to narrow down to a failing area.

Complete setup for local FE + e2e development

probate-frontend

set following in default.yml

  useIDAM: 'true'
  requireCcdCaseId: 'true'

you shoud then be able to use a citizen user of

testusername@test.com/Pa55word11

add a dev.yaml file to the /config folder with contents

featureToggles:
  launchDarklyKey: 'sdk-4d50eb6e-8400-4aa7-b4c5-8bdfc8b1d844'

emails can be monitored at:

http://localhost:8025

run FE using

yarn start:ld

You should also be able to debug on intellij by starting server.js

probate-caveats-frontend

no changes

probate-orchestrator

no changes

probate-business-service

set the following application.yml

  port: 8081

set the following application.yml

document_management:
  url: http://localhost:5006

probate-submit-service

no changes

probate-backoffice

You will need to run with payments and fees docker images if you are expecting to make non-zero payments

Running the application as a docker image

Create the image of the application by executing the following command:

  ./gradlew installDist

Create docker image:

  docker-compose build

Run the distribution (created in build/install/spring-boot-template directory) by executing the following command:

  docker-compose up

This will start the API container exposing the application's port (set to 4550 in this template app).

In order to test if the application is up, you can call its health endpoint:

  curl http://localhost:4550/health

You should get a response similar to this:

  {"status":"UP","diskSpace":{"status":"UP","total":249644974080,"free":137188298752,"threshold":10485760}}

Linking to a Probate-frontend PR

You must link a probate-frontend pr to a probate-orchestrator pr and that to your probate-backoffice pr

Create a PR off master for probate-orchestrator-service
Use the PR number of the BO build in values.yml. Replace:

BACK_OFFICE_API_URL: "http://probate-back-office-pr-1101.service.core-compute-preview.internal"

upgrade the Chart.yaml version in probate-orchestrator-service

version: 1.0.1

Create a PR off master for probate-frontend
Use the PR number of the Orchestrator build in values.yml. Replace:

ORCHESTRATOR_SERVICE_URL : http://probate-orchestrator-service-pr-334.service.core-compute-preview.internal

upgrade the Chart.yaml version in probate-frontend

version: 2.0.14

Build the 2 PRs above
For probate-frontend access, go to (use the pr number you just created for fe):

https://probate-frontend-pr-1218.service.core-compute-preview.internal/start-eligibility

VPN and proxy will be needed to access this

#####REMEMBER ######Remove your unwanted FE/ORCH PRs when you have finished QA

Linking to a Caveats Frontend PR

Exactly the same as above, except you need to link on the probate-caveats-frontend PR

Create a PR off master for probate-orchestrator-service
Use the PR number of the BO build in values.yml. Replace:

BACK_OFFICE_API_URL: "http://probate-back-office-pr-1101.service.core-compute-preview.internal"

upgrade the Chart.yaml version in probate-orchestrator-service

version: 1.0.1

Create a PR off master for probate-caveats-frontend
Use the PR number of the Orchestrator build in values.yml. Replace:

ORCHESTRATOR_SERVICE_URL : http://probate-orchestrator-service-pr-334.service.core-compute-preview.internal

upgrade the Chart.yaml version in probate-caveats-frontend

version: 2.0.14

Build the 2 PRs above
For probate-caveats-frontend access, go to (use the pr number you just created for fe):

https://probate-caveats-fe-pr-276.service.core-compute-preview.internal/caveats/start-apply

VPN and proxy will be needed to access this

PR Health urls

example PR urls

replace pr-{NUMBER} as appropriate

https://probate-frontend-pr-1218.service.core-compute-preview.internal/health
https://probate-caveats-fe-pr-276.service.core-compute-preview.internal/caveats/health
http://probate-orchestrator-service-pr-334.service.core-compute-preview.internal/health
http://probate-submit-service-pr-334.service.core-compute-preview.internal/health
http://probate-submit-service-pr-334.service.core-compute-preview.internal/health
http://probate-business-service-pr-334.service.core-compute-preview.internal/health
http://probate-back-office-pr-1101.service.core-compute-preview.internal/health

When the containers are restarted, ccd data has to be reloaded The user token expires approx every 4 hours

Mac users

You will need to reconfigure your docker settings to allow at least 6.5Gb

Hystrix

Hystrix is a library that helps you control the interactions between your application and other services by adding latency tolerance and fault tolerance logic. It does this by isolating points of access between the services, stopping cascading failures across them, and providing fallback options. We recommend you to use Hystrix in your application if it calls any services.

Hystrix circuit breaker

This template API has Hystrix Circuit Breaker already enabled. It monitors and manages all the@HystrixCommand or HystrixObservableCommand annotated methods inside @Component or @Service annotated classes.

Hystrix dashboard

When this API is running, you can monitor Hystrix metrics in real time using Hystrix Dashboard. In order to do this, visit http://localhost:4550/hystrix and provide http://localhost:4550/hystrix.stream as the Hystrix event stream URL. Keep in mind that you'll only see data once some of your Hystrix commands have been executed. Otherwise Loading ... message will be displayed on the monitoring page.

Other

Hystrix offers much more than Circuit Breaker pattern implementation or command monitoring. Here are some other functionalities it provides:

Separate, per-dependency thread pools
Semaphores, which you can use to limit the number of concurrent calls to any given dependency
Request caching, allowing different code paths to execute Hystrix Commands without worrying about duplicating work

License

This project is licensed under the MIT License - see the LICENSE file for details

Purpose

What's inside

Plugins

Building and deploying the application

Building the application

Docker environment

Full setup

1) Install https://stedolan.github.io/jq/

2) Login to azure

3) Reset your docker images, containers etc.

4) Run environments script

4.1) setup logstash

5) Start up docker

6) Create blob store container

7) Restart dm-store container

7.1) Restart other containers

8) Setup IDAM data.

9) Generate roles, json->xls and import

Create roles and users

Generate xls

Import xls

10) Start your local service

Pull probate specific ccd-logstash

Probate-back-office

loging into to ccd-ui

local document-store

Using Payments and fees

Running Back Office Puppeteer End To End Tests

Complete setup for local FE + e2e development

probate-frontend

probate-caveats-frontend

no changes

probate-orchestrator

no changes

probate-business-service

probate-submit-service

no changes

probate-backoffice

Running the application as a docker image

Linking to a Probate-frontend PR

VPN and proxy will be needed to access this

Linking to a Caveats Frontend PR

VPN and proxy will be needed to access this

PR Health urls

example PR urls

Mac users

Hystrix

Hystrix circuit breaker

Hystrix dashboard

Other

License

About

Languages