chore: fix and suppresss codequality warnings

Author: NicklasWallgren

pom.xml

@@ -38,9 +38,8 @@
 
         <!--        <spring-boot.version>3.5.9</spring-boot.version>-->
 
-        <code-quality.feature.enabled>false</code-quality.feature.enabled>
-        <!--        <code-quality.configuration.checkstyle.suppression-location>checkstyle/checkstyle-suppressions.xml-->
-        <!--        </code-quality.configuration.checkstyle.suppression-location>-->
+        <codequality-maven-plugin.version>0.12.8</codequality-maven-plugin.version>
+        <code-quality.feature.enabled>true</code-quality.feature.enabled>
     </properties>
 
     <modules>
@@ -180,6 +179,52 @@
     <build>
         <plugins>
 
+            <plugin>
+                <groupId>io.github.finoid</groupId>
+                <artifactId>codequality-maven-plugin</artifactId>
+                <version>${codequality-maven-plugin.version}</version>
+                <!-- The plugin must be registered as an extension for the error-prone static analyzer to function properly -->
+                <extensions>true</extensions>
+                <executions>
+                    <execution>
+                        <id>maven-code-quality</id>
+                        <phase>verify</phase>
+                        <goals>
+                            <goal>code-quality</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <codeQuality>
+                        <enabled>${code-quality.feature.enabled}</enabled>
+                        <stepLogLevel>DEBUG</stepLogLevel>
+                        <violationFilters>DIFF_COVERAGE</violationFilters>
+                        <checkstyle>
+                            <enabled>${code-quality.feature.checkstyle}</enabled>
+                            <permissive>${code-quality.feature.checkstyle.permissive}</permissive>
+                            <executionMain>
+                                <suppressionLocation>${code-quality.configuration.checkstyle.suppression-location}
+                                </suppressionLocation>
+                            </executionMain>
+                            <executionTest>
+                                <suppressionLocation>${code-quality.configuration.checkstyle.suppression-location}
+                                </suppressionLocation>
+                            </executionTest>
+                        </checkstyle>
+                        <errorProne>
+                            <enabled>${code-quality.feature.error-prone}</enabled>
+                            <permissive>${code-quality.feature.error-prone.permissive}</permissive>
+                            <nullAwayEnabled>${code-quality.feature.null-away}</nullAwayEnabled>
+                        </errorProne>
+                        <checkerFramework>
+                            <enabled>${code-quality.feature.checker-framework}</enabled>
+                            <permissive>${code-quality.feature.checker-framework.permissive}</permissive>
+                        </checkerFramework>
+                    </codeQuality>
+                </configuration>
+            </plugin>
+
+
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-enforcer-plugin</artifactId>

snapshot-testing-core/pom.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xmlns="http://maven.apache.org/POM/4.0.0"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <parent>
@@ -66,7 +66,7 @@
         <dependency>
             <groupId>org.opentest4j</groupId>
             <artifactId>opentest4j</artifactId>
-            <version>1.2.0</version>
+            <version>1.3.0</version>
         </dependency>
 
         <!-- testImplementation -->

snapshot-testing-core/src/main/java/au/com/origin/snapshots/Expect.java

@@ -16,20 +16,18 @@
 public class Expect {
     private final SnapshotVerifier snapshotVerifier;
     private final Method testMethod;
-
+    private final Map<String, String> headers = new HashMap<>();
     private SnapshotSerializer snapshotSerializer;
     private SnapshotComparator snapshotComparator;
     private List<SnapshotReporter> snapshotReporters;
     private String scenario;
 
-    private final Map<String, String> headers = new HashMap<>();
-
     public static Expect of(SnapshotVerifier snapshotVerifier, Method method) {
         return new Expect(snapshotVerifier, method);
     }
 
     /**
-     * Make an assertion on the given input parameters against what already exists
+     * Make an assertion on the given input parameters against what already exists.
      *
      * <p>If you were previously using varargs and see an error - you can fix the error using
      * "toMatchSnapshotLegacy", however, a better approach is to use the ".scenario()" feature as
@@ -51,7 +49,7 @@ public void toMatchSnapshot(Object object) {
         if (scenario != null) {
             snapshotContext.setScenario(scenario);
         }
-        snapshotContext.header.putAll(headers);
+        snapshotContext.getHeader().putAll(headers);
 
         snapshotContext.checkValidContext();
 
@@ -73,7 +71,7 @@ public Expect scenario(String scenario) {
     }
 
     /**
-     * Apply a custom serializer for this snapshot
+     * Apply a custom serializer for this snapshot.
      *
      * @param serializer your custom serializer
      * @return Snapshot
@@ -84,7 +82,7 @@ public Expect serializer(SnapshotSerializer serializer) {
     }
 
     /**
-     * Apply a custom serializer for this snapshot
+     * Apply a custom serializer for this snapshot.
      *
      * @param name - the {name} attribute serializer.{name} from snapshot.properties
      * @return Snapshot
@@ -95,7 +93,22 @@ public Expect serializer(String name) {
     }
 
     /**
-     * Apply a custom comparator for this snapshot
+     * Apply a custom serializer for this snapshot.
+     *
+     * @param serializer your custom serializer
+     * @return this
+     * @see au.com.origin.snapshots.serializers.SnapshotSerializer
+     * @see au.com.origin.snapshots.serializers.ToStringSnapshotSerializer
+     * @see au.com.origin.snapshots.serializers.Base64SnapshotSerializer
+     */
+    @SneakyThrows
+    public Expect serializer(Class<? extends SnapshotSerializer> serializer) {
+        this.snapshotSerializer = serializer.getConstructor().newInstance();
+        return this;
+    }
+
+    /**
+     * Apply a custom comparator for this snapshot.
      *
      * @param comparator your custom comparator
      * @return Snapshot
@@ -106,7 +119,7 @@ public Expect comparator(SnapshotComparator comparator) {
     }
 
     /**
-     * Apply a custom comparator for this snapshot
+     * Apply a custom comparator for this snapshot.
      *
      * @param name the {name} attribute comparator.{name} from snapshot.properties
      * @return Snapshot
@@ -118,7 +131,7 @@ public Expect comparator(String name) {
 
     /**
      * Apply a list of custom reporters for this snapshot This will replace the default reporters
-     * defined in the config
+     * defined in the config.
      *
      * @param reporters your custom reporters
      * @return Snapshot
@@ -130,7 +143,7 @@ public Expect reporters(SnapshotReporter... reporters) {
 
     /**
      * Apply a list of custom reporters for this snapshot This will replace the default reporters
-     * defined in the config
+     * defined in the config.
      *
      * @param name the {name} attribute reporters.{name} from snapshot.properties
      * @return Snapshot
@@ -140,22 +153,6 @@ public Expect reporters(String name) {
         return this;
     }
 
-    /**
-     * Apply a custom serializer for this snapshot.
-     *
-     * @param serializer your custom serializer
-     * @return this
-     * @see au.com.origin.snapshots.serializers.SnapshotSerializer
-     * <p>Example implementations
-     * @see au.com.origin.snapshots.serializers.ToStringSnapshotSerializer
-     * @see au.com.origin.snapshots.serializers.Base64SnapshotSerializer
-     */
-    @SneakyThrows
-    public Expect serializer(Class<? extends SnapshotSerializer> serializer) {
-        this.snapshotSerializer = serializer.getConstructor().newInstance();
-        return this;
-    }
-
     /**
      * Add anything you like to the snapshot header.
      *

snapshot-testing-core/src/main/java/au/com/origin/snapshots/Snapshot.java

@@ -20,15 +20,6 @@ public class Snapshot implements Comparable<Snapshot> {
     private final SnapshotHeader header;
     private final String body;
 
-    @Override
-    public int compareTo(Snapshot other) {
-        return (name + scenario).compareTo(other.name + other.scenario);
-    }
-
-    public String getIdentifier() {
-        return scenario == null ? name : String.format("%s[%s]", name, scenario);
-    }
-
     public static Snapshot parse(String rawText) {
         String regex =
             "^(?<name>.*?)(\\[(?<scenario>[^]]*)])?=(?<header>\\{[^}]*?})?(?<snapshot>(.*)$)";
@@ -64,6 +55,15 @@ public static Snapshot parse(String rawText) {
             .build();
     }
 
+    @Override
+    public int compareTo(Snapshot other) {
+        return (name + scenario).compareTo(other.name + other.scenario);
+    }
+
+    public String getIdentifier() {
+        return scenario == null ? name : String.format("%s[%s]", name, scenario);
+    }
+
     /**
      * The raw string representation of the snapshot as it would appear in the *.snap file.
      *

snapshot-testing-core/src/main/java/au/com/origin/snapshots/SnapshotContext.java

@@ -27,30 +27,26 @@ public class SnapshotContext {
 
     private final SnapshotConfig snapshotConfig;
     private final SnapshotFile snapshotFile;
+    private final boolean isCI;
 
     @Getter
-    final Class<?> testClass;
-
+    private final Class<?> testClass;
     @Getter
-    final Method testMethod;
-
-    final Object current;
-    private final boolean isCI;
+    private final Method testMethod;
+    private final Object current;
 
+    @Setter
+    @Getter
+    private String scenario;
+    @Getter
+    private SnapshotHeader header = new SnapshotHeader();
     @Setter
     private SnapshotSerializer snapshotSerializer;
     @Setter
     private SnapshotComparator snapshotComparator;
     @Setter
     private List<SnapshotReporter> snapshotReporters;
 
-    @Setter
-    @Getter
-    String scenario;
-
-    @Getter
-    SnapshotHeader header = new SnapshotHeader();
-
     SnapshotContext(
         SnapshotConfig snapshotConfig,
         SnapshotFile snapshotFile,

snapshot-testing-core/src/main/java/au/com/origin/snapshots/SnapshotFile.java

@@ -24,6 +24,7 @@
 import java.util.stream.Stream;
 
 @Slf4j
+@SuppressWarnings("checkstyle:all") // TODO (nw) rewrite
 public class SnapshotFile {
 
     public static final String SPLIT_STRING = "\n\n\n";
@@ -45,10 +46,10 @@ public SnapshotFile(String srcDirPath, String fileName, Class<?> testClass) thro
                  new BufferedReader(
                      new InputStreamReader(new FileInputStream(this.fileName), StandardCharsets.UTF_8))) {
 
-            String sCurrentLine;
+            String currentLine;
 
-            while ((sCurrentLine = br.readLine()) != null) {
-                fileContent.append(sCurrentLine + "\n");
+            while ((currentLine = br.readLine()) != null) {
+                fileContent.append(currentLine + "\n");
             }
 
             String fileText = fileContent.toString();
@@ -81,10 +82,10 @@ public File createDebugFile(Snapshot snapshot) {
             try (FileOutputStream fileStream = new FileOutputStream(file, false)) {
                 fileStream.write(snapshot.raw().getBytes(StandardCharsets.UTF_8));
             } catch (IOException e) {
-                e.printStackTrace();
+                throw new RuntimeException("Unable to create debug file ", e);
             }
         } catch (IOException e) {
-            e.printStackTrace();
+            throw new RuntimeException("Unable to create debug file ", e);
         }
 
         return file;
@@ -101,27 +102,28 @@ public void delete() {
     }
 
     @SneakyThrows
-    public synchronized File createFileIfNotExists(String filename) {
-        Path path = Paths.get(filename);
+    public synchronized File createFileIfNotExists(String fileName) {
+        Path path = Paths.get(fileName);
         if (!Files.exists(path)) {
             Files.createDirectories(path.getParent());
             Files.createFile(path);
         }
         return path.toFile();
     }
 
+    @SuppressWarnings("SynchronizeOnNonFinalField") // TODO (nw) rewrite
     public void pushSnapshot(Snapshot snapshot) {
         synchronized (snapshots) {
             snapshots.add(snapshot);
-            TreeSet<String> rawSnapshots =
+            Set<String> rawSnapshots =
                 snapshots.stream().map(Snapshot::raw).collect(Collectors.toCollection(TreeSet::new));
             updateFile(this.fileName, rawSnapshots);
         }
     }
 
     public synchronized void pushDebugSnapshot(Snapshot snapshot) {
         debugSnapshots.add(snapshot);
-        TreeSet<String> rawDebugSnapshots =
+        Set<String> rawDebugSnapshots =
             debugSnapshots.stream().map(Snapshot::raw).collect(Collectors.toCollection(TreeSet::new));
         updateFile(getDebugFilename(), rawDebugSnapshots);
     }
@@ -132,7 +134,7 @@ private void updateFile(String fileName, Set<String> rawSnapshots) {
             byte[] myBytes = String.join(SPLIT_STRING, rawSnapshots).getBytes(StandardCharsets.UTF_8);
             fileStream.write(myBytes);
         } catch (IOException e) {
-            e.printStackTrace();
+            throw new RuntimeException("Unable to write debug file ", e);
         }
     }