Merge pull request #29 from spt-development/feature/spring-boot-3.2.5-upgrade

Feature/spring boot 3.2.5 upgrade

Author: SimonTaylor

.github/maven-settings.xml

@@ -23,7 +23,6 @@
             </activation>
             <properties>
                 <gpg.executable>gpg</gpg.executable>
-                <gpg.passphrase>${env.GPG_PASSPHRASE}</gpg.passphrase>
             </properties>
        </profile>
     </profiles>

.github/workflows/build.yml

@@ -13,7 +13,7 @@ jobs:
           persist-credentials: false
 
       - name: Cache local Maven repository
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.m2/repository
           key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
@@ -68,7 +68,7 @@ jobs:
           OSSRH_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}
           GIT_HUB_USERNAME: ${{ secrets.GIT_HUB_USERNAME }}
           GIT_HUB_TOKEN: ${{ secrets.GIT_HUB_TOKEN }}
-          GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
+          MAVEN_GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
 
       - name: Create GitHub release
         id: create_release

.github/workflows/owasp.yml

@@ -16,7 +16,7 @@ jobs:
         shell: bash
 
       - name: Restore cached Maven dependencies
-        uses: actions/cache/restore@v3
+        uses: actions/cache/restore@v4
         with:
           path: ~/.m2/repository
           # Using datetime in cache key as OWASP database may change, without the pom changing
@@ -36,7 +36,7 @@ jobs:
 
       # Want the Maven dependencies to be cached even if the build fails as we want the OWASP database cached, regardless of whether vulnerabilities are found or not
       - name: Cache Maven dependencies
-        uses: actions/cache/save@v3
+        uses: actions/cache/save@v4
         if: always()
         with:
           path: ~/.m2/repository

README.md

@@ -11,7 +11,8 @@
 [![build_status](https://github.com/spt-development/spt-development-logging-spring/actions/workflows/build.yml/badge.svg)](https://github.com/spt-development/spt-development-logging-spring/actions)
 
 A library for adding logging (at the start, end and on exception) to public methods of classes annotated with 
-`@RestController`, `@Service` or `@Repository` or methods annotated with `@JmsListener`.
+`@RestController`, `@Service` or `@Repository` or methods annotated with `@JmsListener` or methods of sub-classes
+of `org.springframework.dao.support.DaoSupport`.
 
 Usage
 =====
@@ -21,6 +22,10 @@ Register the Aspects as Spring Beans manually or by adding the
 starter to your project's pom.
 
 ```java
+import com.spt.development.logging.spring.DaoSupportLogger;
+
+import java.beans.BeanProperty;
+
 @Bean
 public RestControllerLogger restControllerLogger() {
     return new RestControllerLogger();
@@ -40,8 +45,18 @@ public ServiceLogger serviceLogger() {
 public RepositoryLogger repositoryLogger() {
     return new RepositoryLogger();
 }
+
+@Bean
+public DaoSupportLogger daoSupportLogger() {
+    return new DaoSupportLogger();
+}
 ```
 
+*NOTE* The `DaoSupportLogger` will result in warnings such as the following being logged by `CglibAopProxy`:
+
+`Unable to proxy interface-implementing method [public final void org.springframework.dao.support.DaoSupport.afterPropertiesSet() throws java.lang.IllegalArgumentException,org.springframework.beans.factory.BeanInitializationException]
+because it is marked as final, consider using interface-based JDK proxies instead.`
+
 Building locally
 ================
 

config/pmd/rulesets/spt-default-rules.xml

@@ -19,7 +19,11 @@
     <rule ref="category/java/bestpractices.xml/DoubleBraceInitialization" />
     <rule ref="category/java/bestpractices.xml/ForLoopCanBeForeach" />
     <rule ref="category/java/bestpractices.xml/LiteralsFirstInComparisons" />
-    <rule ref="category/java/bestpractices.xml/LooseCoupling" />
+    <rule ref="category/java/bestpractices.xml/LooseCoupling">
+        <properties>
+            <property name="allowedTypes" value="org.springframework.core.annotation.AnnotationAttributes" />
+        </properties>
+    </rule>
     <rule ref="category/java/bestpractices.xml/MethodReturnsInternalArray" />
     <rule ref="category/java/bestpractices.xml/MissingOverride" />
     <rule ref="category/java/bestpractices.xml/OneDeclarationPerLine" />
@@ -101,7 +105,7 @@
     <rule ref="category/java/design.xml/SwitchDensity" />
     <rule ref="category/java/design.xml/UseUtilityClass">
         <properties>
-            <property name="violationSuppressXPath" value="//ClassOrInterfaceDeclaration/preceding-sibling::Annotation/MarkerAnnotation/Name[@Image='SpringBootApplication']" />
+            <property name="violationSuppressXPath" value=".[pmd-java:hasAnnotation('org.springframework.boot.autoconfigure.SpringBootApplication')]" />
         </properties>
     </rule>
     <rule ref="category/java/design.xml/UselessOverridingMethod" />

documentation/releases/release-3.1.0.md

@@ -0,0 +1,7 @@
+## New Features
+
+* Added logging for public methods of classes that extend `org.springframework.dao.support.DaoSupport`. 
+
+## Dependencies
+
+* Aligned dependencies with [Spring Boot 3.2.5](https://github.com/spring-projects/spring-boot/releases/tag/v3.2.5)

pom.xml

@@ -3,7 +3,7 @@
 
     <groupId>com.spt-development</groupId>
     <artifactId>spt-development-logging-spring</artifactId>
-    <version>3.0.17-SNAPSHOT</version>
+    <version>3.1.0-SNAPSHOT</version>
 
     <name>logging-spring</name>
     <description>A very simple library for getting/setting the current correlation ID, utilising ThreadLocal.</description>
@@ -38,13 +38,13 @@
         <spt-cid.version>2.0.14</spt-cid.version>
 
         <!-- Dependency versions, matched to Spring Boot -->
-        <aspectj.version>1.9.21</aspectj.version>
+        <aspectj.version>1.9.22</aspectj.version>
         <httpcore5.version>5.2.4</httpcore5.version>
-        <slf4j.version>2.0.12</slf4j.version>
-        <spring.version>6.1.5</spring.version>
+        <slf4j.version>2.0.13</slf4j.version>
+        <spring.version>6.1.6</spring.version>
 
         <!-- Test dependency versions -->
-        <spt-development-test.version>3.1.5</spt-development-test.version>
+        <spt-development-test.version>3.1.6</spt-development-test.version>
 
         <!-- Test dependency versions, matched to Spring Boot -->
         <hamcrest.version>2.2</hamcrest.version>
@@ -55,30 +55,31 @@
         <!-- Plugin versions -->
         <build-helper-maven-plugin.version>3.5.0</build-helper-maven-plugin.version>
         <checkstyle-maven-plugin.version>3.3.1</checkstyle-maven-plugin.version>
-        <dependency-check-maven.version>9.0.10</dependency-check-maven.version>
-        <jacoco-maven-plugin.version>0.8.11</jacoco-maven-plugin.version>
+        <dependency-check-maven.version>9.1.0</dependency-check-maven.version>
+        <jacoco-maven-plugin.version>0.8.12</jacoco-maven-plugin.version>
         <license-maven-plugin.version>2.4.0</license-maven-plugin.version>
         <maven-compiler-plugin.version>3.13.0</maven-compiler-plugin.version>
         <maven-dependency-plugin.version>3.6.1</maven-dependency-plugin.version>
         <maven-enforcer-plugin.version>3.4.1</maven-enforcer-plugin.version>
-        <maven-gpg-plugin.version>3.2.1</maven-gpg-plugin.version>
+        <maven-gpg-plugin.version>3.2.4</maven-gpg-plugin.version>
         <maven-javadoc-plugin.version>3.6.3</maven-javadoc-plugin.version>
         <maven-jxr-plugin.version>3.3.2</maven-jxr-plugin.version>
-        <maven-pmd-plugin.version>3.21.2</maven-pmd-plugin.version>
+        <maven-pmd-plugin.version>3.22.0</maven-pmd-plugin.version>
         <maven-release-plugin.version>3.0.1</maven-release-plugin.version>
-        <maven-scm-plugin.version>2.0.1</maven-scm-plugin.version>
-        <maven-source-plugin.version>3.3.0</maven-source-plugin.version>
+        <maven-scm-plugin.version>2.1.0</maven-scm-plugin.version>
+        <maven-source-plugin.version>3.3.1</maven-source-plugin.version>
         <maven-surefire-plugin.version>3.2.5</maven-surefire-plugin.version>
         <nexus-staging-plugin.version>1.6.13</nexus-staging-plugin.version>
-        <pitest-maven.version>1.15.8</pitest-maven.version>
-        <spotbugs.version>4.8.3.1</spotbugs.version>
+        <pitest-maven.version>1.16.0</pitest-maven.version>
+        <spotbugs.version>4.8.4.0</spotbugs.version>
         <versions-maven-plugin.version>2.16.2</versions-maven-plugin.version>
 
         <!-- Plugin dependencies -->
-        <checkstyle.version>10.14.2</checkstyle.version>
+        <checkstyle.version>10.15.0</checkstyle.version>
         <findbugs-slf4j-bug-pattern.version>1.5.0</findbugs-slf4j-bug-pattern.version>
         <findbugs-sec-bug-pattern.version>1.12.0</findbugs-sec-bug-pattern.version>
         <pitest-junit5-plugin.version>1.2.1</pitest-junit5-plugin.version>
+        <pmd.version>7.1.0</pmd.version>
     </properties>
 
     <dependencyManagement>
@@ -216,6 +217,28 @@
                 <plugin>
                     <artifactId>maven-pmd-plugin</artifactId>
                     <version>${maven-pmd-plugin.version}</version>
+                    <dependencies>
+                        <dependency>
+                            <groupId>net.sourceforge.pmd</groupId>
+                            <artifactId>pmd-core</artifactId>
+                            <version>${pmd.version}</version>
+                        </dependency>
+                        <dependency>
+                            <groupId>net.sourceforge.pmd</groupId>
+                            <artifactId>pmd-java</artifactId>
+                            <version>${pmd.version}</version>
+                        </dependency>
+                        <dependency>
+                            <groupId>net.sourceforge.pmd</groupId>
+                            <artifactId>pmd-javascript</artifactId>
+                            <version>${pmd.version}</version>
+                        </dependency>
+                        <dependency>
+                            <groupId>net.sourceforge.pmd</groupId>
+                            <artifactId>pmd-jsp</artifactId>
+                            <version>${pmd.version}</version>
+                        </dependency>
+                    </dependencies>
                 </plugin>
                 <plugin>
                     <artifactId>maven-source-plugin</artifactId>
@@ -439,7 +462,7 @@
                                              Any classes / packages excluded here, must have specific rules for them below,
                                              with reasons.
                                           -->
-                                        <exclude>com.spt.development.audit.spring.security.AuthenticationAdapterFactory</exclude>
+                                        <exclude>com.spt.development.logging.spring.LoggerAspect</exclude>
                                     </excludes>
                                 </rule>
                                 <rule>
@@ -448,15 +471,12 @@
                                         <limit>
                                             <counter>LINE</counter>
                                             <value>COVEREDRATIO</value>
-                                            <minimum>0.82</minimum>
+                                            <minimum>0.97</minimum>
                                         </limit>
                                     </limits>
                                     <includes>
-                                        <!--
-                                             Difficult to force the ClassNotFoundException when checking if authentication
-                                             object is an instance of OAuth2Authentication
-                                          -->
-                                        <include>com.spt.development.audit.spring.security.AuthenticationAdapterFactory</include>
+                                        <!-- Placeholder method for pointcut does not need to be explicitly covered by tests -->
+                                        <include>com.spt.development.logging.spring.LoggerAspect</include>
                                     </includes>
                                 </rule>
                             </rules>

src/main/java/com/spt/development/logging/spring/DaoSupportLogger.java

@@ -0,0 +1,55 @@
+package com.spt.development.logging.spring;
+
+import org.aspectj.lang.ProceedingJoinPoint;
+import org.aspectj.lang.annotation.Around;
+import org.aspectj.lang.annotation.Aspect;
+
+/**
+ * Logs calls to all public methods belonging to classes with the <code>org.springframework.stereotype.Repository</code>
+ * annotation.
+ */
+@Aspect
+public class DaoSupportLogger extends LoggerAspect {
+
+    /**
+     * Creates a new instance of the logger aspect. The log statements added by the aspect will include the current
+     * correlation ID; see {@link DaoSupportLogger#DaoSupportLogger(boolean)} to disable this behaviour.
+     */
+    public DaoSupportLogger() {
+        this(true);
+    }
+
+    /**
+     * Creates a new instance of the logger aspect.
+     *
+     * @param includeCorrelationIdInLogs a flag to determine whether the correlation ID should be explicitly included
+     *                                   in the log statements added by the aspect.
+     */
+    public DaoSupportLogger(final boolean includeCorrelationIdInLogs) {
+        super(includeCorrelationIdInLogs);
+    }
+
+    /**
+     * Outputs DEBUG level logging when a public method belonging to a class, extending
+     * <code>org.springframework.dao.support.DaoSupport</code> is called and when it returns (without
+     * exception). If TRACE level logging is enabled and the method has a non-<code>void</code> return type, the
+     * return value will be included in the logging. For example:
+     *
+     * <pre>
+     * [40872057-a1b6-4fdd-bce1-7882929bbce6] MyDao.read(4)
+     * ...
+     * [40872057-a1b6-4fdd-bce1-7882929bbce6] MyDao.read Returned: MyEntity(id=4, name=test)
+     * </pre>
+     *
+     * @param point the aspect join point required for implementing a {@link Around} aspect.
+     *
+     * @return the value returned from the method logged.
+     *
+     * @throws Throwable thrown if the method logged throws a {@link Throwable}.
+     */
+    @Override
+    @Around("execution(public * org.springframework.dao.support.DaoSupport+.*(..)) && !loggingDisabled()")
+    public Object log(final ProceedingJoinPoint point) throws Throwable {
+        return super.log(point);
+    }
+}

src/main/java/com/spt/development/logging/spring/JmsListenerLogger.java

@@ -49,9 +49,7 @@ public JmsListenerLogger(final boolean includeCorrelationIdInLogs) {
      * @throws Throwable thrown if the method logged throws a {@link Throwable}.
      */
     @Override
-    @Around("@annotation(org.springframework.jms.annotation.JmsListener) "
-        + "&& !@annotation(com.spt.development.logging.NoLogging) "
-        + "&& !@target(com.spt.development.logging.NoLogging)")
+    @Around("@annotation(org.springframework.jms.annotation.JmsListener) && !loggingDisabled()")
     public Object log(final ProceedingJoinPoint point) throws Throwable {
         return super.log(point);
     }

src/main/java/com/spt/development/logging/spring/LoggerAspect.java

@@ -2,6 +2,7 @@
 
 import com.spt.development.cid.CorrelationId;
 import org.aspectj.lang.ProceedingJoinPoint;
+import org.aspectj.lang.annotation.Pointcut;
 import org.aspectj.lang.reflect.MethodSignature;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -24,6 +25,9 @@ abstract class LoggerAspect {
         this.isStartAndCompleteMethodLoggedAtInfo = isStartAndCompleteMethodLoggedAtInfo;
     }
 
+    @Pointcut("@annotation(com.spt.development.logging.NoLogging) || @target(com.spt.development.logging.NoLogging)")
+    void loggingDisabled() {}
+
     Object log(final ProceedingJoinPoint point) throws Throwable {
         final MethodSignature signature = (MethodSignature) point.getSignature();
         final Logger log = LoggerFactory.getLogger(signature.getDeclaringType());