chore: Support spotbugs running anywhere (#1537)

* Allow spotbugs & checkstyle to run from any subdirectory
* Clean up spotbugs-exclude

Author: scottgerring

.mvn/README

@@ -0,0 +1,2 @@
+This is here purely so that we can get the root directory using maven.multiModuleProjectDirectory
+

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>
 

examples/spotbugs-exclude.xml

@@ -110,6 +110,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>
 
     <dependencyManagement>
@@ -544,7 +548,7 @@
                         </executions>
                         <configuration>
                             <xmlOutput>true</xmlOutput>
-                            <excludeFilterFile>../spotbugs-exclude.xml</excludeFilterFile>
+                            <excludeFilterFile>${project.rootdir}/spotbugs-exclude.xml</excludeFilterFile>
                         </configuration>
                     </plugin>
                 </plugins>
@@ -641,6 +645,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>

pom.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-->
@@ -58,6 +85,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 +142,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 +230,5 @@
                 <Method name="threadOption1"/>
             </And>
         </Or>
-    </Match>    
-</FindBugsFilter>
+    </Match>
+</FindBugsFilter>