From f2085da26687ce1416bad15816c720b71f1b370c Mon Sep 17 00:00:00 2001
From: Scott Gerring <gerrings@amazon.com>
Date: Tue, 12 Dec 2023 15:35:56 +0100
Subject: [PATCH 1/3] Allow spotbugs to run from any subdirectory

---
 .mvn/README    | 2 ++
 checkstyle.xml | 2 +-
 pom.xml        | 7 ++++++-
 3 files changed, 9 insertions(+), 2 deletions(-)
 create mode 100644 .mvn/README

diff --git a/.mvn/README b/.mvn/README
new file mode 100644
index 000000000..a851f5e55
--- /dev/null
+++ b/.mvn/README
@@ -0,0 +1,2 @@
+This is here purely so that we can get the root directory using maven.multiModuleProjectDirectory
+
diff --git a/checkstyle.xml b/checkstyle.xml
index 34ef98ef2..680d8808c 100644
--- a/checkstyle.xml
+++ b/checkstyle.xml
@@ -51,7 +51,7 @@
   <module name="FileLength"/>
 
   <module name="Header">
-    <property name="headerFile" value="license-header"/>
+    <property name="headerFile" value="${basedir}/license-header"/>
     <property name="severity" value="error"/>
   </module>
 
diff --git a/pom.xml b/pom.xml
index b7227cf8a..5e3d74d86 100644
--- a/pom.xml
+++ b/pom.xml
@@ -101,6 +101,10 @@
         <aws-embedded-metrics.version>1.0.6</aws-embedded-metrics.version>
         <jmespath.version>0.6.0</jmespath.version>
         <elastic.version>1.5.0</elastic.version>
+
+        <!-- As we have a .mvn directory at the root of the project, this will evaluate to the root directory
+            regardless of where maven is run - sub-module, or root. -->
+        <project.rootdir>${maven.multiModuleProjectDirectory}</project.rootdir>
     </properties>
 
     <distributionManagement>
@@ -542,7 +546,7 @@
                         </executions>
                         <configuration>
                             <xmlOutput>true</xmlOutput>
-                            <excludeFilterFile>../spotbugs-exclude.xml</excludeFilterFile>
+                            <excludeFilterFile>${project.rootdir}/spotbugs-exclude.xml</excludeFilterFile>
                         </configuration>
                     </plugin>
                 </plugins>
@@ -639,6 +643,7 @@
                         <artifactId>maven-checkstyle-plugin</artifactId>
                         <version>3.3.0</version>
                         <configuration>
+                            <propertyExpansion>basedir=${project.rootdir}</propertyExpansion>
                             <configLocation>checkstyle.xml</configLocation>
                             <consoleOutput>true</consoleOutput>
                             <failsOnError>true</failsOnError>

From 45144e441255d344cf354f797d95c7607cd4fee8 Mon Sep 17 00:00:00 2001
From: Scott Gerring <gerrings@amazon.com>
Date: Tue, 12 Dec 2023 16:29:02 +0100
Subject: [PATCH 2/3] Clean up spotbugs-exclude

---
 examples/spotbugs-exclude.xml              | 20 ------
 powertools-logging/spotbugs-exclude.xml    | 30 --------
 powertools-parameters/spotbugs-exclude.xml | 82 ----------------------
 spotbugs-exclude.xml                       | 36 +++++++++-
 4 files changed, 34 insertions(+), 134 deletions(-)
 delete mode 100644 examples/spotbugs-exclude.xml
 delete mode 100644 powertools-logging/spotbugs-exclude.xml
 delete mode 100644 powertools-parameters/spotbugs-exclude.xml

diff --git a/examples/spotbugs-exclude.xml b/examples/spotbugs-exclude.xml
deleted file mode 100644
index e33e65478..000000000
--- a/examples/spotbugs-exclude.xml
+++ /dev/null
@@ -1,20 +0,0 @@
-<!-- This file specifies a spotbugs filter for excluding reports that
-     should not be considered errors.
-     The format of this file is documented at:
-       https://spotbugs.readthedocs.io/en/latest/filter.html
-     When possible, please specify the full names of the bug codes,
-     using the pattern attribute, to make it clearer what reports are
-     being suppressed.  You can find a listing of codes at:
-       https://spotbugs.readthedocs.io/en/latest/bugDescriptions.html
-  -->
-<FindBugsFilter>
-    <Match>
-        <Bug pattern="DMI_THREAD_PASSED_WHERE_RUNNABLE_EXPECTED"/>
-        <Or>
-            <And>
-                <Class name="helloworld.App"/>
-                <Method name="threadOption1"/>
-            </And>
-        </Or>
-    </Match>
-</FindBugsFilter>
\ No newline at end of file
diff --git a/powertools-logging/spotbugs-exclude.xml b/powertools-logging/spotbugs-exclude.xml
deleted file mode 100644
index 0437849ae..000000000
--- a/powertools-logging/spotbugs-exclude.xml
+++ /dev/null
@@ -1,30 +0,0 @@
-<!-- This file specifies a spotbugs filter for excluding reports that
-     should not be considered errors.
-     The format of this file is documented at:
-       https://spotbugs.readthedocs.io/en/latest/filter.html
-     When possible, please specify the full names of the bug codes,
-     using the pattern attribute, to make it clearer what reports are
-     being suppressed.  You can find a listing of codes at:
-       https://spotbugs.readthedocs.io/en/latest/bugDescriptions.html
-  -->
-<FindBugsFilter>
-    <Match>
-        <Bug pattern="EI_EXPOSE_REP2"/>
-        <Or>
-            <And>
-                <Class name="software.amazon.lambda.powertools.logging.logback.LambdaJsonEncoder"/>
-                <Field name="throwableConverter"/>
-            </And>
-            <And>
-                <Class name="software.amazon.lambda.powertools.logging.logback.LambdaEcsEncoder"/>
-                <Field name="throwableConverter"/>
-            </And>
-        </Or>
-    </Match>
-    <!--False positive https://github.com/spotbugs/spotbugs/issues/1539-->
-    <Match>
-        <Bug pattern="DMI_RANDOM_USED_ONLY_ONCE"/>
-        <Class name="software.amazon.lambda.powertools.logging.internal.LambdaLoggingAspect"/>
-        <Method name="setLogLevelBasedOnSamplingRate"/>
-    </Match>
-</FindBugsFilter>
\ No newline at end of file
diff --git a/powertools-parameters/spotbugs-exclude.xml b/powertools-parameters/spotbugs-exclude.xml
deleted file mode 100644
index d48e9bee1..000000000
--- a/powertools-parameters/spotbugs-exclude.xml
+++ /dev/null
@@ -1,82 +0,0 @@
-<!-- This file specifies a spotbugs filter for excluding reports that
-     should not be considered errors.
-     The format of this file is documented at:
-       https://spotbugs.readthedocs.io/en/latest/filter.html
-     When possible, please specify the full names of the bug codes,
-     using the pattern attribute, to make it clearer what reports are
-     being suppressed.  You can find a listing of codes at:
-       https://spotbugs.readthedocs.io/en/latest/bugDescriptions.html
-  -->
-<FindBugsFilter>
-    <Match>
-        <Bug pattern="EI_EXPOSE_REP2"/>
-        <Or>
-            <And>
-                <Class name="software.amazon.lambda.powertools.parameters.BaseProvider"/>
-                <Field name="cacheManager"/>
-            </And>
-            <And>
-                <Class name="software.amazon.lambda.powertools.parameters.BaseProvider"/>
-                <Field name="transformationManager"/>
-            </And>
-            <And>
-                <Class name="software.amazon.lambda.powertools.parameters.transform.TransformationManager"/>
-                <Field name="transformation"/>
-            </And>
-            <And>
-                <Class name="software.amazon.lambda.powertools.parameters.BaseProvider"/>
-                <Field name="transformationManager"/>
-            </And>
-            <And>
-                <Class name="software.amazon.lambda.powertools.parameters.ssm.SSMProviderBuilder"/>
-                <Field name="transformationManager"/>
-            </And>
-            <And>
-                <Class name="software.amazon.lambda.powertools.parameters.ssm.SSMProviderBuilder"/>
-                <Field name="cacheManager"/>
-            </And>
-            <And>
-                <Class name="software.amazon.lambda.powertools.parameters.ssm.SSMProviderBuilder"/>
-                <Field name="transformationManager"/>
-            </And>
-            <And>
-                <Class name="software.amazon.lambda.powertools.parameters.ssm.SSMProviderBuilder"/>
-                <Field name="client"/>
-            </And>
-            <And>
-                <Class name="software.amazon.lambda.powertools.parameters.secrets.SecretsProviderBuilder"/>
-                <Field name="cacheManager"/>
-            </And>
-            <And>
-                <Class name="software.amazon.lambda.powertools.parameters.secrets.SecretsProviderBuilder"/>
-                <Field name="transformationManager"/>
-            </And>
-            <And>
-                <Class name="software.amazon.lambda.powertools.parameters.secrets.SecretsProviderBuilder"/>
-                <Field name="client"/>
-            </And>
-            <And>
-                <Class name="software.amazon.lambda.powertools.parameters.appconfig.AppConfigProviderBuilder"/>
-                <Field name="cacheManager"/>
-            </And>
-            <And>
-                <Class name="software.amazon.lambda.powertools.parameters.appconfig.AppConfigProviderBuilder"/>
-                <Field name="transformationManager"/>
-            </And>
-
-            <And>
-                <Class name="software.amazon.lambda.powertools.parameters.dynamodb.DynamoDbProviderBuilder"/>
-                <Field name="cacheManager"/>
-            </And>
-            <And>
-                <Class name="software.amazon.lambda.powertools.parameters.dynamodb.DynamoDbProviderBuilder"/>
-                <Field name="transformationManager"/>
-            </And>
-            <And>
-                <Class name="software.amazon.lambda.powertools.parameters.dynamodb.DynamoDbProviderBuilder"/>
-                <Field name="client"/>
-            </And>
-
-        </Or>
-    </Match>
-</FindBugsFilter>
\ No newline at end of file
diff --git a/spotbugs-exclude.xml b/spotbugs-exclude.xml
index 2d61cc68d..dfdfcd44f 100644
--- a/spotbugs-exclude.xml
+++ b/spotbugs-exclude.xml
@@ -58,6 +58,18 @@
                 <Class name="software.amazon.lambda.powertools.largemessages.LargeMessageConfig"/>
                 <Method name="getS3Client"/>
             </And>
+            <And>
+                <Class name="software.amazon.lambda.powertools.logging.internal.AbstractJacksonLayoutCopy$Builder" />
+                <Method name="getAdditionalFields"/>
+            </And>
+            <And>
+                <Class name="software.amazon.lambda.powertools.logging.internal.AbstractJacksonLayoutCopy$LogEventWithAdditionalFields" />
+                <Method name="getAdditionalFields"/>
+            </And>
+            <And>
+                <Class name="software.amazon.lambda.powertools.logging.internal.LambdaJsonLayout$LogEventWithAdditionalFields" />
+                <Method name="getAdditionalFields"/>
+            </And>
         </Or>
     </Match>
     <Match>
@@ -103,6 +115,26 @@
                 <Class name="software.amazon.lambda.powertools.largemessages.LargeMessageConfig"/>
                 <Field name="s3Client"/>
             </And>
+            <And>
+                <Class name="software.amazon.lambda.powertools.logging.internal.AbstractJacksonLayoutCopy" />
+                <Method name="LogEventWithAdditionalFields"/>
+            </And>
+            <And>
+                <Class name="software.amazon.lambda.powertools.logging.internal.AbstractJacksonLayoutCopy$Builder" />
+                <Method name="setAdditionalFields"/>
+            </And>
+            <And>
+                <Class name="software.amazon.lambda.powertools.logging.internal.LambdaJsonLayout" />
+                <Method name="LogEventWithAdditionalFields"/>
+            </And>
+            <And>
+                <Class name="software.amazon.lambda.powertools.logging.LambdaEcsEncoder" />
+                <Method name="setThrowableConverter"/>
+            </And>
+            <And>
+                <Class name="software.amazon.lambda.powertools.logging.LambdaJsonEncoder" />
+                <Method name="setThrowableConverter"/>
+            </And>
         </Or>
     </Match>
     <!--Functionally needed-->
@@ -171,5 +203,5 @@
                 <Method name="threadOption1"/>
             </And>
         </Or>
-    </Match>    
-</FindBugsFilter>
\ No newline at end of file
+    </Match>
+</FindBugsFilter>

From 5348252a5a7485b34c1fc0fd0188c606950425c4 Mon Sep 17 00:00:00 2001
From: Scott Gerring <gerrings@amazon.com>
Date: Tue, 12 Dec 2023 16:37:08 +0100
Subject: [PATCH 3/3] Missed some

---
 spotbugs-exclude.xml | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

diff --git a/spotbugs-exclude.xml b/spotbugs-exclude.xml
index dfdfcd44f..747752130 100644
--- a/spotbugs-exclude.xml
+++ b/spotbugs-exclude.xml
@@ -39,7 +39,34 @@
                 <Class name="software.amazon.lambda.powertools.parameters.secrets.SecretsProviderBuilder"/>
                 <Field name="client"/>
             </And>
-
+            <And>
+                <Class name="software.amazon.lambda.powertools.parameters.ssm.SSMProviderBuilder"/>
+                <Field name="client"/>
+            </And>
+            <And>
+                <Class name="software.amazon.lambda.powertools.parameters.ssm.SSMProviderBuilder"/>
+                <Field name="cacheManager"/>
+            </And>
+            <And>
+                <Class name="software.amazon.lambda.powertools.parameters.dynamodb.DynamoDbProviderBuilder"/>
+                <Field name="cacheManager"/>
+            </And>
+            <And>
+                <Class name="software.amazon.lambda.powertools.parameters.dynamodb.DynamoDbProviderBuilder"/>
+                <Field name="client"/>
+            </And>
+            <And>
+                <Class name="software.amazon.lambda.powertools.parameters.dynamodb.DynamoDbProviderBuilder"/>
+                <Field name="transformationManager"/>
+            </And>
+            <And>
+                <Class name="software.amazon.lambda.powertools.parameters.appconfig.AppConfigProviderBuilder"/>
+                <Field name="cacheManager"/>
+            </And>
+            <And>
+                <Class name="software.amazon.lambda.powertools.parameters.appconfig.AppConfigProviderBuilder"/>
+                <Field name="transformationManager"/>
+            </And>
         </Or>
     </Match>
     <!-- Internals of Log event for apache log4j-->