From e42c5362c12bd65e37647b924fe190a9b33af29e Mon Sep 17 00:00:00 2001
From: Alex McAusland <alex.mcausland@gmail.com>
Date: Fri, 17 Apr 2020 10:39:19 +0100
Subject: [PATCH 1/3] Integrate HMCTS Java Plugin

Handles configuration of checkstyle, PMD and dependency checker. See
https://github.com/hmcts/gradle-java-plugin/blob/master/README.md
---
 build.gradle                     |  31 +---
 config/checkstyle/checkstyle.xml | 251 -------------------------------
 config/pmd/ruleset.xml           |  72 ---------
 3 files changed, 5 insertions(+), 349 deletions(-)
 delete mode 100644 config/checkstyle/checkstyle.xml
 delete mode 100644 config/pmd/ruleset.xml

diff --git a/build.gradle b/build.gradle
index c99b8e17..60db64ac 100644
--- a/build.gradle
+++ b/build.gradle
@@ -1,11 +1,13 @@
 plugins {
   id 'application'
-  id 'checkstyle'
-  id 'pmd'
   id 'jacoco'
+  /*
+      Applies analysis tools including checkstyle, PMD and OWASP Dependency checker.
+      See https://github.com/hmcts/gradle-java-plugin
+   */
+  id 'uk.gov.hmcts.java' version '0.4.2'
   id 'io.spring.dependency-management' version '1.0.9.RELEASE'
   id 'org.springframework.boot' version '2.2.6.RELEASE'
-  id 'org.owasp.dependencycheck' version '5.3.2.1'
   id 'com.github.ben-manes.versions' version '0.28.0'
   id 'org.sonarqube' version '2.8'
 }
@@ -84,21 +86,6 @@ task smoke(type: Test) {
   classpath = sourceSets.smokeTest.runtimeClasspath
 }
 
-checkstyle {
-  maxWarnings = 0
-  toolVersion = '8.29'
-  getConfigDirectory().set(new File(rootDir, 'config/checkstyle'))
-}
-
-pmd {
-  toolVersion = "6.18.0"
-  sourceSets = [sourceSets.main, sourceSets.test, sourceSets.functionalTest, sourceSets.integrationTest, sourceSets.smokeTest]
-  reportsDir = file("$project.buildDir/reports/pmd")
-  // https://github.com/pmd/pmd/issues/876
-  ruleSets = []
-  ruleSetFiles = files("config/pmd/ruleset.xml")
-}
-
 jacocoTestReport {
   executionData(test, integration)
   reports {
@@ -132,15 +119,7 @@ dependencyUpdates {
 
 // https://jeremylong.github.io/DependencyCheck/dependency-check-gradle/configuration.html
 dependencyCheck {
-  // Specifies if the build should be failed if a CVSS score above a specified level is identified.
-  // range of 0-10 fails the build, anything greater and it doesn't fail the build
-  failBuildOnCVSS = System.getProperty('dependencyCheck.failBuild') == 'true' ? 0 : 11
   suppressionFile = 'config/owasp/suppressions.xml'
-
-  analyzers {
-    // Disable scanning of .NET related binaries
-    assemblyEnabled = false
-  }
 }
 
 dependencyManagement {
diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml
deleted file mode 100644
index 25743d96..00000000
--- a/config/checkstyle/checkstyle.xml
+++ /dev/null
@@ -1,251 +0,0 @@
-<?xml version="1.0"?>
-<!DOCTYPE module PUBLIC
-  "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
-  "https://checkstyle.org/dtds/configuration_1_3.dtd">
-
-<!--
-    Checkstyle configuration that checks the Google coding conventions from Google Java Style
-    that can be found at https://google.github.io/styleguide/javaguide.html.
-
-    Checkstyle is very configurable. Be sure to read the documentation at
-    http://checkstyle.sf.net (or in your downloaded distribution).
-
-    To completely disable a check, just comment it out or delete it from the file.
-
-    Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
- -->
-
-<module name = "Checker">
-  <property name="charset" value="UTF-8"/>
-
-  <property name="severity" value="warning"/>
-
-  <property name="fileExtensions" value="java, properties, xml"/>
-  <!-- Checks for whitespace                               -->
-  <!-- See http://checkstyle.sf.net/config_whitespace.html -->
-  <module name="FileTabCharacter">
-    <property name="eachLine" value="true"/>
-  </module>
-
-  <module name="SuppressWarningsFilter" />
-  <module name="LineLength">
-    <property name="max" value="120"/>
-    <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
-  </module>
-  <module name="TreeWalker">
-    <module name="UnusedImports"/>
-    <module name="HideUtilityClassConstructor"/>
-    <module name="SuppressWarningsHolder" />
-    <module name="OuterTypeFilename"/>
-    <module name="IllegalTokenText">
-      <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
-      <property name="format"
-                value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
-      <property name="message"
-                value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
-    </module>
-    <module name="AvoidEscapedUnicodeCharacters">
-      <property name="allowEscapesForControlCharacters" value="true"/>
-      <property name="allowByTailComment" value="true"/>
-      <property name="allowNonPrintableEscapes" value="true"/>
-    </module>
-    <module name="AvoidStarImport"/>
-    <module name="OneTopLevelClass"/>
-    <module name="NoLineWrap"/>
-    <module name="EmptyBlock">
-      <property name="option" value="TEXT"/>
-      <property name="tokens"
-                value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
-    </module>
-    <module name="NeedBraces"/>
-    <module name="LeftCurly"/>
-    <module name="RightCurly">
-      <property name="id" value="RightCurlySame"/>
-      <property name="tokens"
-                value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE,
-                    LITERAL_DO"/>
-    </module>
-    <module name="RightCurly">
-      <property name="id" value="RightCurlyAlone"/>
-      <property name="option" value="alone"/>
-      <property name="tokens"
-                value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT,
-                    INSTANCE_INIT"/>
-    </module>
-    <module name="WhitespaceAround">
-      <property name="allowEmptyConstructors" value="true"/>
-      <property name="allowEmptyMethods" value="true"/>
-      <property name="allowEmptyTypes" value="true"/>
-      <property name="allowEmptyLoops" value="true"/>
-      <message key="ws.notFollowed"
-               value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
-      <message key="ws.notPreceded"
-               value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
-    </module>
-    <module name="OneStatementPerLine"/>
-    <module name="MultipleVariableDeclarations"/>
-    <module name="ArrayTypeStyle"/>
-    <module name="MissingSwitchDefault"/>
-    <module name="FallThrough"/>
-    <module name="UpperEll"/>
-    <module name="ModifierOrder"/>
-    <module name="EmptyLineSeparator">
-      <property name="allowNoEmptyLineBetweenFields" value="true"/>
-    </module>
-    <module name="SeparatorWrap">
-      <property name="id" value="SeparatorWrapDot"/>
-      <property name="tokens" value="DOT"/>
-      <property name="option" value="nl"/>
-    </module>
-    <module name="SeparatorWrap">
-      <property name="id" value="SeparatorWrapComma"/>
-      <property name="tokens" value="COMMA"/>
-      <property name="option" value="EOL"/>
-    </module>
-    <module name="SeparatorWrap">
-      <!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/258 -->
-      <property name="id" value="SeparatorWrapEllipsis"/>
-      <property name="tokens" value="ELLIPSIS"/>
-      <property name="option" value="EOL"/>
-    </module>
-    <module name="SeparatorWrap">
-      <!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/259 -->
-      <property name="id" value="SeparatorWrapArrayDeclarator"/>
-      <property name="tokens" value="ARRAY_DECLARATOR"/>
-      <property name="option" value="EOL"/>
-    </module>
-    <module name="SeparatorWrap">
-      <property name="id" value="SeparatorWrapMethodRef"/>
-      <property name="tokens" value="METHOD_REF"/>
-      <property name="option" value="nl"/>
-    </module>
-    <module name="PackageName">
-      <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
-      <message key="name.invalidPattern"
-               value="Package name ''{0}'' must match pattern ''{1}''."/>
-    </module>
-    <module name="TypeName">
-      <message key="name.invalidPattern"
-               value="Type name ''{0}'' must match pattern ''{1}''."/>
-    </module>
-    <module name="MemberName">
-      <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
-      <message key="name.invalidPattern"
-               value="Member name ''{0}'' must match pattern ''{1}''."/>
-    </module>
-    <module name="ParameterName">
-      <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
-      <message key="name.invalidPattern"
-               value="Parameter name ''{0}'' must match pattern ''{1}''."/>
-    </module>
-    <module name="CatchParameterName">
-      <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
-      <message key="name.invalidPattern"
-               value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
-    </module>
-    <module name="LocalVariableName">
-      <property name="tokens" value="VARIABLE_DEF"/>
-      <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
-      <message key="name.invalidPattern"
-               value="Local variable name ''{0}'' must match pattern ''{1}''."/>
-    </module>
-    <module name="ClassTypeParameterName">
-      <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
-      <message key="name.invalidPattern"
-               value="Class type name ''{0}'' must match pattern ''{1}''."/>
-    </module>
-    <module name="MethodTypeParameterName">
-      <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
-      <message key="name.invalidPattern"
-               value="Method type name ''{0}'' must match pattern ''{1}''."/>
-    </module>
-    <module name="InterfaceTypeParameterName">
-      <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
-      <message key="name.invalidPattern"
-               value="Interface type name ''{0}'' must match pattern ''{1}''."/>
-    </module>
-    <module name="NoFinalizer"/>
-    <module name="GenericWhitespace">
-      <message key="ws.followed"
-               value="GenericWhitespace ''{0}'' is followed by whitespace."/>
-      <message key="ws.preceded"
-               value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
-      <message key="ws.illegalFollow"
-               value="GenericWhitespace ''{0}'' should followed by whitespace."/>
-      <message key="ws.notPreceded"
-               value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
-    </module>
-    <module name="Indentation">
-      <property name="basicOffset" value="4"/>
-      <property name="braceAdjustment" value="0"/>
-      <property name="caseIndent" value="4"/>
-      <property name="throwsIndent" value="4"/>
-      <property name="lineWrappingIndentation" value="4"/>
-      <property name="arrayInitIndent" value="4"/>
-    </module>
-    <module name="AbbreviationAsWordInName">
-      <property name="ignoreFinal" value="false"/>
-      <property name="allowedAbbreviationLength" value="1"/>
-    </module>
-    <module name="OverloadMethodsDeclarationOrder"/>
-    <module name="VariableDeclarationUsageDistance"/>
-    <module name="CustomImportOrder">
-      <property name="sortImportsInGroupAlphabetically" value="true"/>
-      <property name="separateLineBetweenGroups" value="true"/>
-      <property name="customImportOrderRules" value="THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE###STATIC"/>
-    </module>
-    <module name="MethodParamPad"/>
-    <module name="NoWhitespaceBefore">
-      <property name="tokens"
-                value="COMMA, SEMI, POST_INC, POST_DEC, DOT, ELLIPSIS, METHOD_REF"/>
-      <property name="allowLineBreaks" value="true"/>
-    </module>
-    <module name="ParenPad"/>
-    <module name="OperatorWrap">
-      <property name="option" value="NL"/>
-      <property name="tokens"
-                value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR,
-                    LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF "/>
-    </module>
-    <module name="AnnotationLocation">
-      <property name="id" value="AnnotationLocationMostCases"/>
-      <property name="tokens"
-                value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
-    </module>
-    <module name="AnnotationLocation">
-      <property name="id" value="AnnotationLocationVariables"/>
-      <property name="tokens" value="VARIABLE_DEF"/>
-      <property name="allowSamelineMultipleAnnotations" value="true"/>
-    </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"/>
-      <property name="target"
-                value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
-    </module>
-    <module name="JavadocMethod">
-      <property name="scope" value="nothing"/>
-      <property name="allowMissingParamTags" value="true"/>
-      <property name="allowMissingReturnTag" value="true"/>
-      <property name="allowedAnnotations" value="Override, Test"/>
-    </module>
-    <module name="MethodName">
-      <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
-      <message key="name.invalidPattern"
-               value="Method name ''{0}'' must match pattern ''{1}''."/>
-    </module>
-    <module name="SingleLineJavadoc">
-      <property name="ignoreInlineTags" value="false"/>
-    </module>
-    <module name="EmptyCatchBlock">
-      <property name="exceptionVariableName" value="expected"/>
-    </module>
-    <module name="CommentsIndentation"/>
-  </module>
-</module>
diff --git a/config/pmd/ruleset.xml b/config/pmd/ruleset.xml
deleted file mode 100644
index 03b66c19..00000000
--- a/config/pmd/ruleset.xml
+++ /dev/null
@@ -1,72 +0,0 @@
-<?xml version="1.0"?>
-<ruleset name="PMD rule set"
-         xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
-
-  <description>HMCTS PMD rule set</description>
-
-  <rule ref="category/java/bestpractices.xml">
-    <exclude name="GuardLogStatement"/>
-    <exclude name="JUnitTestContainsTooManyAsserts"/>
-  </rule>
-  <rule ref="category/java/codestyle.xml">
-    <exclude name="AtLeastOneConstructor"/>
-    <exclude name="LocalVariableCouldBeFinal"/>
-    <exclude name="LongVariable"/>
-    <exclude name="MethodArgumentCouldBeFinal"/>
-    <exclude name="OnlyOneReturn"/>
-    <exclude name="TooManyStaticImports"/>
-    <exclude name="DefaultPackage"/>
-    <exclude name="CommentDefaultAccessModifier"/>
-  </rule>
-  <rule ref="category/java/codestyle.xml/ClassNamingConventions">
-    <properties>
-      <!-- same as any other class -->
-      <property name="utilityClassPattern" value="[A-Z][a-zA-Z]+"/>
-    </properties>
-  </rule>
-  <rule ref="category/java/codestyle.xml/MethodNamingConventions">
-    <properties>
-      <property name="junit4TestPattern" value="[a-z][a-zA-Z0-9_]+"/>
-    </properties>
-  </rule>
-  <rule ref="category/java/codestyle.xml/ShortVariable">
-    <properties>
-      <property name="minimum" value="2"/>
-    </properties>
-  </rule>
-  <rule ref="category/java/design.xml">
-    <exclude name="AvoidCatchingGenericException"/>
-    <exclude name="UseUtilityClass"/>
-    <exclude name="LoosePackageCoupling"/>
-    <exclude name="DataClass"/>
-  </rule>
-  <rule ref="category/java/design.xml/ExcessiveImports">
-    <properties>
-      <property name="minimum" value="35"/><!-- should be reduced -->
-    </properties>
-  </rule>
-  <rule ref="category/java/design.xml/LawOfDemeter">
-    <properties>
-      <property name="violationSuppressRegex" value="(.*method chain calls.*|.*object not created locally.*)"/>
-    </properties>
-  </rule>
-  <rule ref="category/java/design.xml/SignatureDeclareThrowsException">
-    <properties>
-      <property name="IgnoreJUnitCompletely" value="true"/>
-    </properties>
-  </rule>
-  <rule ref="category/java/documentation.xml">
-    <exclude name="CommentRequired"/>
-    <exclude name="CommentSize"/>
-    <exclude name="UncommentedEmptyMethodBody"/>
-  </rule>
-  <rule ref="category/java/errorprone.xml">
-    <exclude name="BeanMembersShouldSerialize"/>
-  </rule>
-  <rule ref="category/java/multithreading.xml"/>
-  <rule ref="category/java/performance.xml"/>
-  <rule ref="category/java/security.xml"/>
-
-</ruleset>

From 32587c7635e38ea1d468a17ed7abc8cd2a5e5cb5 Mon Sep 17 00:00:00 2001
From: Alex McAusland <alex.mcausland@gmail.com>
Date: Fri, 17 Apr 2020 13:07:40 +0100
Subject: [PATCH 2/3] Update Readme

Provide details of HMCTS Java plugin.
---
 README.md | 35 +++++++++++++++++++++--------------
 1 file changed, 21 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 8df0a29c..2d0fa647 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,7 @@ The template is a working application with a minimal setup. It contains:
  * application skeleton
  * setup script to prepare project
  * common plugins and libraries
+ * [HMCTS Java plugin](https://github.com/hmcts/gradle-java-plugin)
  * docker setup
  * swagger configuration for api documentation ([see how to publish your api documentation to shared repository](https://github.com/hmcts/reform-api-docs#publish-swagger-docs))
  * code quality tools already set up
@@ -29,19 +30,32 @@ The application exposes health endpoint (http://localhost:4550/health) and metri
 
 The template contains the following plugins:
 
-  * checkstyle
+  * HMCTS Java plugin
 
-    https://docs.gradle.org/current/userguide/checkstyle_plugin.html
+    Applies code analysis tools with HMCTS default settings. See the [project repository](https://github.com/hmcts/gradle-java-plugin) for details.
 
-    Performs code style 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 `./gradlew check` command).
+    Analysis tools include:
 
-  * pmd
+    * checkstyle
 
-    https://docs.gradle.org/current/userguide/pmd_plugin.html
+        https://docs.gradle.org/current/userguide/checkstyle_plugin.html
 
-    Performs static code analysis to finds common programming flaws. Included in gradle `check` task.
+        Performs code style 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 `./gradlew check` command).
 
+    * pmd
+
+        https://docs.gradle.org/current/userguide/pmd_plugin.html
+
+        Performs static code analysis to finds common programming flaws. Included in gradle `check` task.
+
+    * 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.
 
   * jacoco
 
@@ -70,13 +84,6 @@ The template contains the following plugins:
 
     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
 

From 8555fb5dba0a1eeb649793c55b68e4874da539c3 Mon Sep 17 00:00:00 2001
From: Alex McAusland <alex.mcausland@gmail.com>
Date: Mon, 20 Apr 2020 10:54:09 +0100
Subject: [PATCH 3/3] Bump gradle-java-plugin to 0.5.0

---
 README.md    | 6 ------
 build.gradle | 4 ++--
 2 files changed, 2 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 2d0fa647..365d1322 100644
--- a/README.md
+++ b/README.md
@@ -43,12 +43,6 @@ The template contains the following plugins:
         Performs code style 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 `./gradlew check` command).
 
-    * pmd
-
-        https://docs.gradle.org/current/userguide/pmd_plugin.html
-
-        Performs static code analysis to finds common programming flaws. Included in gradle `check` task.
-
     * org.owasp.dependencycheck
 
         https://jeremylong.github.io/DependencyCheck/dependency-check-gradle/index.html
diff --git a/build.gradle b/build.gradle
index ad23d7b4..e3a1c1c8 100644
--- a/build.gradle
+++ b/build.gradle
@@ -2,10 +2,10 @@ plugins {
   id 'application'
   id 'jacoco'
   /*
-      Applies analysis tools including checkstyle, PMD and OWASP Dependency checker.
+      Applies analysis tools including checkstyle and OWASP Dependency checker.
       See https://github.com/hmcts/gradle-java-plugin
    */
-  id 'uk.gov.hmcts.java' version '0.4.2'
+  id 'uk.gov.hmcts.java' version '0.5.0'
   id 'io.spring.dependency-management' version '1.0.9.RELEASE'
   id 'org.springframework.boot' version '2.2.6.RELEASE'
   id 'com.github.ben-manes.versions' version '0.28.0'