fix spotbugs for multiple modules - multiple spotbugs files

aws-powertools · Nov 9, 2023 · a9ef2c4 · a9ef2c4
1 parent d71f9ac
commit a9ef2c4
Show file tree

Hide file tree

Showing 16 changed files with 47 additions and 75 deletions.
diff --git a/pom.xml b/pom.xml
@@ -92,7 +92,6 @@
         <junit.version>5.10.0</junit.version>
         <aws-embedded-metrics.version>1.0.6</aws-embedded-metrics.version>
         <jmespath.version>0.5.1</jmespath.version>
-        <parentproject.basedir>${project.basedir}</parentproject.basedir>
     </properties>
 
     <distributionManagement>
@@ -509,7 +508,7 @@
                         </executions>
                         <configuration>
                             <xmlOutput>true</xmlOutput>
-                            <excludeFilterFile>${parentproject.basedir}/spotbugs-exclude.xml</excludeFilterFile>
+                            <excludeFilterFile>../spotbugs-exclude.xml</excludeFilterFile>
                         </configuration>
                     </plugin>
                 </plugins>

diff --git a/powertools-batch/pom.xml b/powertools-batch/pom.xml
@@ -26,10 +26,6 @@
 
     <artifactId>powertools-batch</artifactId>
 
-    <properties>
-        <parentproject.basedir>${project.parent.basedir}</parentproject.basedir>
-    </properties>
-
     <dependencies>
         <dependency>
             <groupId>com.amazonaws</groupId>

diff --git a/powertools-cloudformation/pom.xml b/powertools-cloudformation/pom.xml
@@ -55,10 +55,6 @@
         </snapshotRepository>
     </distributionManagement>
 
-    <properties>
-        <parentproject.basedir>${project.parent.basedir}</parentproject.basedir>
-    </properties>
-
     <dependencies>
         <dependency>
             <groupId>software.amazon.awssdk</groupId>

diff --git a/powertools-common/pom.xml b/powertools-common/pom.xml
@@ -53,10 +53,6 @@
         </snapshotRepository>
     </distributionManagement>
 
-    <properties>
-        <parentproject.basedir>${project.parent.basedir}</parentproject.basedir>
-    </properties>
-
     <dependencies>
         <dependency>
             <groupId>com.amazonaws</groupId>

diff --git a/powertools-e2e-tests/pom.xml b/powertools-e2e-tests/pom.xml
@@ -32,7 +32,6 @@
         <maven.compiler.target>1.8</maven.compiler.target>
         <constructs.version>10.3.0</constructs.version>
         <cdk.version>2.100.0</cdk.version>
-        <parentproject.basedir>${project.parent.basedir}</parentproject.basedir>
     </properties>
 
     <dependencies>

diff --git a/powertools-idempotency/powertools-idempotency-core/pom.xml b/powertools-idempotency/powertools-idempotency-core/pom.xml
@@ -32,10 +32,6 @@
         Idempotency module common implementation
     </description>
 
-    <properties>
-        <parentproject.basedir>${project.parent.parent.basedir}</parentproject.basedir>
-    </properties>
-
     <dependencies>
         <dependency>
             <groupId>software.amazon.lambda</groupId>

diff --git a/powertools-idempotency/powertools-idempotency-dynamodb/pom.xml b/powertools-idempotency/powertools-idempotency-dynamodb/pom.xml
@@ -32,10 +32,6 @@
         DynamoDB implementation for the idempotency module
     </description>
 
-    <properties>
-        <parentproject.basedir>${project.parent.parent.basedir}</parentproject.basedir>
-    </properties>
-
     <dependencies>
         <dependency>
             <groupId>software.amazon.lambda</groupId>

diff --git a/powertools-idempotency/spotbugs-exclude.xml b/powertools-idempotency/spotbugs-exclude.xml
@@ -0,0 +1,46 @@
+<!-- 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>
+    <!-- Internals of Log event for apache log4j-->
+    <Match>
+        <Bug pattern="EI_EXPOSE_REP"/>
+        <Or>
+            <And>
+                <Class name="software.amazon.lambda.powertools.idempotency.Idempotency"/>
+                <Method name="getPersistenceStore"/>
+            </And>
+            <And>
+                <Class name="software.amazon.lambda.powertools.idempotency.Idempotency"/>
+                <Method name="getConfig"/>
+            </And>
+        </Or>
+    </Match>
+    <Match>
+        <Bug pattern="EI_EXPOSE_REP2"/>
+        <Or>
+            <And>
+                <Class name="software.amazon.lambda.powertools.idempotency.Idempotency$Config"/>
+                <Field name="store"/>
+            </And>
+            <And>
+                <Class name="software.amazon.lambda.powertools.idempotency.Idempotency$Config"/>
+                <Field name="config"/>
+            </And>
+            <And>
+                <Class name="software.amazon.lambda.powertools.idempotency.internal.IdempotencyHandler"/>
+                <Field name="pjp"/>
+            </And>
+            <And>
+                <Class name="software.amazon.lambda.powertools.idempotency.persistence.dynamodb.DynamoDBPersistenceStore$Builder"/>
+                <Field name="dynamoDbClient"/>
+            </And>
+        </Or>
+    </Match>
+</FindBugsFilter>
diff --git a/powertools-large-messages/pom.xml b/powertools-large-messages/pom.xml
@@ -53,10 +53,6 @@
         </snapshotRepository>
     </distributionManagement>
 
-    <properties>
-        <parentproject.basedir>${project.parent.basedir}</parentproject.basedir>
-    </properties>
-
     <dependencies>
         <dependency>
             <groupId>software.amazon.lambda</groupId>

diff --git a/powertools-logging/pom.xml b/powertools-logging/pom.xml
@@ -54,10 +54,6 @@
         </snapshotRepository>
     </distributionManagement>
 
-    <properties>
-        <parentproject.basedir>${project.parent.basedir}</parentproject.basedir>
-    </properties>
-
     <dependencies>
         <dependency>
             <groupId>software.amazon.lambda</groupId>

diff --git a/powertools-metrics/pom.xml b/powertools-metrics/pom.xml
@@ -55,10 +55,6 @@
         </snapshotRepository>
     </distributionManagement>
 
-    <properties>
-        <parentproject.basedir>${project.parent.basedir}</parentproject.basedir>
-    </properties>
-
     <dependencies>
         <dependency>
             <groupId>software.amazon.lambda</groupId>

diff --git a/powertools-parameters/pom.xml b/powertools-parameters/pom.xml
@@ -54,10 +54,6 @@
         </snapshotRepository>
     </distributionManagement>
 
-    <properties>
-        <parentproject.basedir>${project.parent.basedir}</parentproject.basedir>
-    </properties>
-
     <dependencies>
         <dependency>
             <groupId>software.amazon.lambda</groupId>

diff --git a/powertools-serialization/pom.xml b/powertools-serialization/pom.xml
@@ -54,10 +54,6 @@
         </snapshotRepository>
     </distributionManagement>
 
-    <properties>
-        <parentproject.basedir>${project.parent.basedir}</parentproject.basedir>
-    </properties>
-
     <dependencies>
         <dependency>
             <groupId>io.burt</groupId>

diff --git a/powertools-tracing/pom.xml b/powertools-tracing/pom.xml
@@ -55,10 +55,6 @@
         </snapshotRepository>
     </distributionManagement>
 
-    <properties>
-        <parentproject.basedir>${project.parent.basedir}</parentproject.basedir>
-    </properties>
-
     <dependencies>
         <dependency>
             <groupId>software.amazon.lambda</groupId>

diff --git a/powertools-validation/pom.xml b/powertools-validation/pom.xml
@@ -55,10 +55,6 @@
         </snapshotRepository>
     </distributionManagement>
 
-    <properties>
-        <parentproject.basedir>${project.parent.basedir}</parentproject.basedir>
-    </properties>
-
     <dependencies>
         <dependency>
             <groupId>software.amazon.lambda</groupId>

diff --git a/spotbugs-exclude.xml b/spotbugs-exclude.xml
@@ -28,14 +28,6 @@
                 <Class name="software.amazon.lambda.powertools.logging.internal.AbstractJacksonLayoutCopy$LogEventWithAdditionalFields"/>
                 <Method name="getAdditionalFields"/>
             </And>
-            <And>
-                <Class name="software.amazon.lambda.powertools.idempotency.Idempotency"/>
-                <Method name="getPersistenceStore"/>
-            </And>
-            <And>
-                <Class name="software.amazon.lambda.powertools.idempotency.Idempotency"/>
-                <Method name="getConfig"/>
-            </And>
             <And>
                 <Class name="software.amazon.lambda.powertools.largemessages.LargeMessageConfig"/>
                 <Method name="getS3Client"/>
@@ -73,22 +65,6 @@
                 <Class name="software.amazon.lambda.powertools.parameters.transform.TransformationManager"/>
                 <Field name="transformer"/>
             </And>
-            <And>
-                <Class name="software.amazon.lambda.powertools.idempotency.Idempotency$Config"/>
-                <Field name="store"/>
-            </And>
-            <And>
-                <Class name="software.amazon.lambda.powertools.idempotency.Idempotency$Config"/>
-                <Field name="config"/>
-            </And>
-            <And>
-                <Class name="software.amazon.lambda.powertools.idempotency.internal.IdempotencyHandler"/>
-                <Field name="pjp"/>
-            </And>
-            <And>
-                <Class name="software.amazon.lambda.powertools.idempotency.persistence.dynamodb.DynamoDBPersistenceStore$Builder"/>
-                <Field name="dynamoDbClient"/>
-            </And>
             <And>
                 <Class name="software.amazon.lambda.powertools.utilities.EventDeserializer$EventPart"/>
                 <Field name="contentMap"/>