Upgrading ESR microservice libraries

Owned by david.hay (Unlicensed)
Last updated: 18 Jun 2020
2 min read

Here is a list of the ESR Microservice Projects

#

ESR Microservice

#

ESR Microservice

1

CDC Router

2

ESR Audit

3

ESR Reconciliation

4

ESR InboundDataReader

5

ESR InboundDataWriter

6

ESR AppRecordGenerator

7

ESR NotificationGenerator

8

ESR Export

They all depend on the rabbit-mongo-spring-boot-starter. The spring-boot-starter comes in 3 flavours:

  • If a project uses rabbit & mongo :

    • com.hee.tis.esr:hee-rabbit-mongo-transaction-spring-boot-starte

  • If a project uses rabbit but not mongo :

    • com.hee.tis.esr:hee-rabbit-spring-boot-starter

  • If a project uses mongo but not rabbit :

    • com.hee.tis.esr:hee-mongo-spring-boot-starter

The version number of the ‘spring-boot-starter' is something like 2.3.0-1.1 - the numbers before the dash refer to the base spring boot version.

It’s important that you don’t try and pull in spring boot libraries into the microservices that are not compatible with the spring boot version of the ESR ‘spring-boot-starter’.

The following libraries should have the same version when they are used in more than one ESR Microservice. They could have different versions but it’ll make maintenance easier if they are all the same.

library

version

Starter

Audit

Export

CDC

AppGen

NotGen

Reader

Writer

Recon

library

version

Starter

Audit

Export

CDC

AppGen

NotGen

Reader

Writer

Recon

org.testcontainers:testcontainers

1.14.3

Y

Y

Y

 

Y

Y

Y

Y

Y

org.testcontainers:localstack

1.13.0

 

 

Y

 

 

 

Y

 

 

org.testcontainers:junit-jupiter

1.14.3

Y

Y

Y

 

Y

Y

Y

Y

Y

com.playtika.testcontainers:embedded-rabbitmq

1.73

Y

Y

Y

 

Y

Y

Y

Y

Y

com.playtika.testcontainers:embedded-mongodb

1.73

Y

 

Y

 

Y

 

Y

Y

Y

org.springframework.clou:spring-cloud-starter-parent

Hoxton.SR5

Y

 

 

 

 

 

 

 

 

org.springframework.cloud:spring-cloud-starter

2.2.3.RELEASE

 

Y

Y

 

Y

Y

Y

Y

Y

org.springframework.cloud:spring-cloud-contract-wiremock

2.1.3.RELEASE

 

 

 

 

Y

Y

 

Y

Y

com.hee.tis.esr:hee-rabbit-spring-boot-starter

2.3.0-1.2

 

 

 

Y

Y

Y

 

 

 

com.hee.tis.esr:hee-rabbit-mongo-transaction-spring-boot-starte

2.3.0-1.2

 

Y

Y

 

 

 

Y

Y

Y

org.springframework.boot

2.3.0.RELEASE

 

Y

Y

Y

Y

Y

Y

Y

Y

com.github.everit-org.json-schema:org.everit.json.schema

1.12.1

Y

Y

Y

 

Y

 

Y

Y

Y

com.amazonaws:aws-java-sdk-bom

1.11.804

 

 

Y

 

 

 

Y

 

 

io.spring.dependency-management

1.0.9

 

Y

Y

Y

Y

Y

Y

Y

Y

org.apache.commons:commons-lang3

3.10

Y

Y

Y

Y

 

Y

Y

 

 

commons-io:commons-io

2.7

 

 

Y

 

 

 

 

 

 

com.opencsv:opencsv

5.2

 

Y

Y

 

 

 

Y

 

 

com.google.guava:guava

29.0-jre

 

 

Y

 

Y

Y

 

Y

Y

com.google.code.gson:gson

2.8.6

 

 

Y

Y

Y

Y

Y

Y

Y

commons-beanutils:commons-beanutils

1.9.4

 

 

 

 

Y

 

 

 

Y

com.transformuk.hee:keycloak-client

3.0.0

 

 

 

 

Y

Y

 

Y

Y

com.transformuk.hee.tis:tcs-client

5.3.2

 

 

 

 

Y

Y

 

Y

Y

org.projectlombok:lombok

1.18.12

 

Y

Y

Y

Y

Y

Y

Y

Y

org.neo4j.driver:neo4j-java-driver

4.0.2

 

Y

 

 

 

 

 

 

 

et.javacrumbs.shedlock:shedlock-spring

4.12.0

 

 

Y

 

 

 

 

 

 

net.javacrumbs.shedlock:shedlock-provider-mongo

4.12.0

 

 

Y

 

 

 

 

 

 

 

version

Starter

Audit

Export

CDC

AppGen

NotGen

Reader

Writer

Recon

 

The following libraries have given us some problems (which as of 18Jun2020 need further investigation)

  1. localstack - works on macbook with 1.14.3 but fails on Jenkins so went back to using 1.13.0. Requires further investigation.

  2. wiremock - we’re using Spring Cloud Starter 2.2.3.RELEASE but this version fails on macbook - works ok with 2.1.3.RELEASE Requires further investigation.

The spring-boot-version 2.3.0 in the starters is pulled in by the spring-cloud-starter-parent (Hoxton.SR5).

Many of the libraries go hand-in-hand with a spring-boot version. You will see in the microservices that we use org.springframework.boot @ 2.3.0.RELEASE but 'spring-cloud-starter' @ 2.2.3.RELEASE. This is normal. As of 18th June 2020 - the latest version of spring-cloud-starter is 2.2.3.RELEASE.

TIPS

Dependabot

Don’t just accept Dependabot PR suggestions without thinking about them. Make sure that the Dependabot PR branch has worked on Jenkins before merging.

Tests

Run the tests locally before pushing code to a feature branch.

Git feature branches will be compiled and tested on Jenkins automatically.

Git PRs are also tested on Jenkins automatically.

Jenkins

Note : please keep an eye on Jenkins if you submit code. Sometimes it looks like a Jenkins job has passed but it actually failed. Sometimes a build might fail because of high load on Jenkins. If you think something should have worked but didn’t - might be worth trying again.

ESR Spring Boot Starter changes

Any changes to the esr spring-boot-starter should be associated with an increase to its version number. Once the new esr spring-boot-starter version has been pushed to master branch and built successfully on Jenkins, each microservice needs to be updated to use it.

Dependency Trees

For gradle based projects, ./gradlew dependencyReport - will produce a dependency report.

For maven based projects, mvn dependency:tree - will output a dependency report to console.

There will be dependencies inherited from ESR spring-boot-starters that are repeated (or overridden) in each ESR microservice's build.gradle file. Test dependencies are NOT inherited from ESR spring-boot-starters.

 

 

 

 

 

 

 

 

 

 

 

Slack: https://hee-nhs-tis.slack.com/
Jira issues: https://hee-tis.atlassian.net/issues/?filter=14213