Merge pull request #12 from hmcts/refactor/improve-health-indicator-reseliance

ROC-7707: Improve health indicator resilience

Author: sabahirfan

build.gradle

@@ -1,8 +1,8 @@
 plugins {
     id 'checkstyle'
-    id 'io.spring.dependency-management' version '1.0.8.RELEASE'
-    id 'org.springframework.boot' version '2.1.7.RELEASE'
-    id 'com.github.ben-manes.versions' version '0.22.0'
+    id 'io.spring.dependency-management' version '1.0.9.RELEASE'
+    id 'org.springframework.boot' version '2.2.5.RELEASE'
+    id 'com.github.ben-manes.versions' version '0.28.0'
     id 'com.jfrog.bintray' version '1.8.4'
     id 'java-library'
     id 'maven'
@@ -29,11 +29,13 @@ dependencyUpdates.resolutionStrategy = {
     }
 }
 
-def springBootVersion = '2.1.6.RELEASE'
+def springBootVersion = '2.2.5.RELEASE'
 
 checkstyle {
     maxWarnings = 0
-    toolVersion = '8.24'
+    toolVersion = '8.29'
+    // need to set configDir to rootDir otherwise submodule will use submodule/config/checkstyle
+    configDir = new File(rootDir, 'config/checkstyle')
 }
 
 sourceCompatibility = 1.8
@@ -85,16 +87,16 @@ test {
 }
 
 ext {
-    lombokVersion = '1.18.8'
-    springCloudVersion = 'Greenwich.SR2'
+    lombokVersion = '1.18.12'
+    springCloudVersion = 'Hoxton.SR2'
     feignVersion = '10.3.0'
 }
 
 def versions = [
         logback          : '1.2.3',
         springBoot       : springBootVersion,
         reformJavaLogging: '5.0.1',
-        junitJupiter     : '5.5.1'
+        junitJupiter     : '5.5.2'
 ]
 
 dependencyManagement {
@@ -143,7 +145,7 @@ dependencies {
     compile group: 'ch.qos.logback', name: 'logback-core', version: versions.logback
     compile group: 'uk.gov.hmcts.reform', name: 'java-logging', version: versions.reformJavaLogging
 
-    compile group: 'uk.gov.hmcts.reform', name: 'service-auth-provider-client', version: '3.0.0'
+    compile group: 'uk.gov.hmcts.reform', name: 'service-auth-provider-client', version: '3.1.1'
 
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter', version: versions.junitJupiter
     testImplementation group: 'org.springframework.boot', name: 'spring-boot-starter-test'
@@ -154,7 +156,7 @@ dependencies {
     testImplementation group: 'com.github.tomakehurst', name: 'wiremock', version: '2.24.1'
     testImplementation group: 'org.springframework.cloud', name: 'spring-cloud-contract-wiremock'
 
-    functionalTestImplementation group: 'uk.gov.hmcts.reform', name: 'service-auth-provider-client', version: '2.0.1'
+    functionalTestImplementation group: 'uk.gov.hmcts.reform', name: 'service-auth-provider-client', version: '3.1.1'
     functionalTestCompileOnly group: 'org.projectlombok', name: 'lombok', version: lombokVersion
     functionalTestAnnotationProcessor group: 'org.projectlombok', name: 'lombok', version: lombokVersion
 }

config/checkstyle/checkstyle.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <!DOCTYPE module PUBLIC
-        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
-        "https://checkstyle.org/dtds/configuration_1_3.dtd">
+        "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
+        "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
 
 <!--
     Checkstyle configuration that checks the Google coding conventions from Google Java Style
@@ -31,9 +31,8 @@
     <property name="max" value="120"/>
     <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
   </module>
-  <module name="SuppressionFilter">
-    <property name="file" value="config/checkstyle/suppressions.xml"/>
-  </module>
+
+  <module name="SuppressWarningsFilter" />
   <module name="TreeWalker">
     <module name="UnusedImports"/>
     <module name="HideUtilityClassConstructor"/>
@@ -77,6 +76,9 @@
       <message key="ws.notPreceded"
                value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
     </module>
+    <module name="WhitespaceAfter">
+      <property name="tokens" value="COMMA, SEMI"/>
+    </module>
     <module name="OneStatementPerLine"/>
     <module name="MultipleVariableDeclarations"/>
     <module name="ArrayTypeStyle"/>
@@ -86,6 +88,8 @@
     <module name="ModifierOrder"/>
     <module name="EmptyLineSeparator">
       <property name="allowNoEmptyLineBetweenFields" value="true"/>
+      <property name="allowMultipleEmptyLines" value="false"/>
+      <property name="allowMultipleEmptyLinesInsideClassMembers" value="false"/>
     </module>
     <module name="SeparatorWrap">
       <property name="tokens" value="DOT"/>
@@ -209,6 +213,9 @@
     </module>
     <module name="NonEmptyAtclauseDescription"/>
     <module name="JavadocTagContinuationIndentation"/>
+    <module name="SummaryJavadoc">
+      <property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
+    </module>
     <module name="JavadocParagraph"/>
     <module name="AtclauseOrder">
       <property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
@@ -217,11 +224,8 @@
     <module name="JavadocMethod">
       <property name="scope" value="nothing"/>
       <property name="allowMissingParamTags" value="true"/>
-      <property name="allowMissingThrowsTags" value="true"/>
       <property name="allowMissingReturnTag" value="true"/>
-      <property name="minLineCount" value="2"/>
       <property name="allowedAnnotations" value="Override, Test"/>
-      <property name="allowThrowsTagsForSubclasses" value="true"/>
     </module>
     <module name="MethodName">
       <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
@@ -235,5 +239,6 @@
       <property name="exceptionVariableName" value="expected"/>
     </module>
     <module name="CommentsIndentation"/>
+    <module name="ParameterAssignment"/>
   </module>
 </module>

config/checkstyle/suppressions.xml

@@ -18,22 +18,22 @@ public class IdamService {
     private String[] allowedRoles;
 
     /**
-     * The description of the service
+     * The description of the service.
      */
     private String description;
 
     /**
-     * Short Identifier for the Service
+     * Short Identifier for the Service.
      */
     private String label;
 
     /**
-     * The Oauth2 Client Id
+     * The Oauth2 Client Id.
      */
     private String oauth2ClientId;
 
     /**
-     * The Oauth2 Client secret
+     * The Oauth2 Client secret.
      */
     private String oauth2ClientSecret;
 
@@ -42,7 +42,7 @@ public class IdamService {
     private String oauth2Scope;
 
     /**
-     * The endpoint used to notify the service about users on-boarding
+     * The endpoint used to notify the service about users on-boarding.
      */
     private String onboardingEndpoint;
 

src/functionalTest/java/uk/gov/hmcts/reform/payments/client/functional/env/IdamService.java

@@ -1,29 +1,19 @@
 package uk.gov.hmcts.reform.payments.client.health;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Getter;
 import org.springframework.boot.actuate.health.Status;
 
-import java.util.Map;
-
+@Getter
+@JsonIgnoreProperties(ignoreUnknown = true)
 public class InternalHealth {
+
     private final Status status;
-    private final Map<String, Object> details;
 
     @JsonCreator
-    public InternalHealth(
-            @JsonProperty("status") Status status,
-            @JsonProperty("details") Map<String, Object> details
-    ) {
+    public InternalHealth(@JsonProperty("status") Status status) {
         this.status = status;
-        this.details = details;
-    }
-
-    public Status getStatus() {
-        return status;
-    }
-
-    public Map<String, Object> getDetails() {
-        return details;
     }
 }