Add spotless to build pipeline

Signed-off-by: Rahul Krishna <[email protected]>

Author: rahlk

build.gradle

@@ -17,6 +17,7 @@ plugins {
     id 'application'
     id 'org.graalvm.buildtools.native' version '0.10.4'
     id 'org.jetbrains.kotlin.jvm'
+    id 'com.diffplug.spotless' version '6.25.0'
 }
 
 // Get the version from the property file first
@@ -145,6 +146,20 @@ test {
     systemProperty 'testcontainers.reuse.enable', 'true'
 }
 
+spotless {
+    java {
+        target 'src/**/*.java'
+        trimTrailingWhitespace()
+        endWithNewline()
+        importOrder()
+    }
+}
+
+compileJava.dependsOn spotlessApply
+
+// Optionally, automatically format before compilation
+// compileJava.dependsOn googleJavaFormat
+
 task fatJar(type: Jar) {
     archiveBaseName = 'codeanalyzer'
     duplicatesStrategy = DuplicatesStrategy.EXCLUDE

src/main/java/com/ibm/cldk/CodeAnalyzer.java

@@ -12,6 +12,17 @@
  */
 package com.ibm.cldk;
 
+import com.github.javaparser.Problem;
+import com.google.common.reflect.TypeToken;
+import com.google.gson.FieldNamingPolicy;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import com.google.gson.JsonElement;
+import com.google.gson.JsonObject;
+import com.google.gson.JsonParser;
+import com.ibm.cldk.entities.JavaCompilationUnit;
+import com.ibm.cldk.utils.BuildProject;
+import com.ibm.cldk.utils.Log;
 import java.io.File;
 import java.io.FileReader;
 import java.io.FileWriter;
@@ -23,21 +34,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.stream.Collectors;
-
 import org.apache.commons.lang3.tuple.Pair;
-
-import com.github.javaparser.Problem;
-import com.google.common.reflect.TypeToken;
-import com.google.gson.FieldNamingPolicy;
-import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
-import com.google.gson.JsonElement;
-import com.google.gson.JsonObject;
-import com.google.gson.JsonParser;
-import com.ibm.cldk.entities.JavaCompilationUnit;
-import com.ibm.cldk.utils.BuildProject;
-import com.ibm.cldk.utils.Log;
-
 import picocli.CommandLine;
 import picocli.CommandLine.Command;
 import picocli.CommandLine.Option;

src/main/java/com/ibm/cldk/SymbolTable.java

@@ -1,31 +1,19 @@
 package com.ibm.cldk;
 
-import java.io.IOException;
-import java.nio.file.Path;
-import java.nio.file.Paths;
-import java.util.*;
-import java.util.regex.Pattern;
-import java.util.stream.Collectors;
-import java.util.stream.IntStream;
-
 import com.github.javaparser.*;
 import com.github.javaparser.ast.*;
 import com.github.javaparser.ast.body.*;
 import com.github.javaparser.ast.comments.Comment;
 import com.github.javaparser.ast.comments.JavadocComment;
 import com.github.javaparser.ast.expr.*;
 import com.github.javaparser.ast.nodeTypes.NodeWithJavadoc;
-import com.github.javaparser.ast.stmt.*;
-import com.github.javaparser.printer.lexicalpreservation.LexicalPreservingPrinter;
-import com.github.javaparser.resolution.declarations.ResolvedMethodLikeDeclaration;
-import com.ibm.cldk.entities.*;
-import com.ibm.cldk.javaee.EntrypointsFinderFactory;
-import org.apache.commons.lang3.tuple.Pair;
-
 import com.github.javaparser.ast.nodeTypes.NodeWithName;
+import com.github.javaparser.ast.stmt.*;
 import com.github.javaparser.ast.type.ReferenceType;
 import com.github.javaparser.ast.type.Type;
+import com.github.javaparser.printer.lexicalpreservation.LexicalPreservingPrinter;
 import com.github.javaparser.resolution.declarations.ResolvedMethodDeclaration;
+import com.github.javaparser.resolution.declarations.ResolvedMethodLikeDeclaration;
 import com.github.javaparser.resolution.types.ResolvedType;
 import com.github.javaparser.symbolsolver.JavaSymbolSolver;
 import com.github.javaparser.symbolsolver.resolution.typesolvers.CombinedTypeSolver;
@@ -35,10 +23,20 @@
 import com.github.javaparser.utils.SourceRoot;
 import com.google.common.collect.Table;
 import com.google.common.collect.Tables;
+import com.ibm.cldk.entities.*;
 import com.ibm.cldk.javaee.CRUDFinderFactory;
+import com.ibm.cldk.javaee.EntrypointsFinderFactory;
 import com.ibm.cldk.javaee.utils.enums.CRUDOperationType;
 import com.ibm.cldk.javaee.utils.enums.CRUDQueryType;
 import com.ibm.cldk.utils.Log;
+import java.io.IOException;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.*;
+import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+import java.util.stream.IntStream;
+import org.apache.commons.lang3.tuple.Pair;
 
 @SuppressWarnings({"unchecked", "rawtypes"})
 public class SymbolTable {

src/main/java/com/ibm/cldk/SystemDependencyGraph.java

@@ -13,6 +13,9 @@
 
 package com.ibm.cldk;
 
+import static com.ibm.cldk.CodeAnalyzer.analysisLevel;
+import static com.ibm.cldk.utils.AnalysisUtils.*;
+
 import com.ibm.cldk.entities.*;
 import com.ibm.cldk.utils.AnalysisUtils;
 import com.ibm.cldk.utils.Log;
@@ -39,21 +42,17 @@
 import com.ibm.wala.util.graph.Graph;
 import com.ibm.wala.util.graph.GraphSlicer;
 import com.ibm.wala.util.graph.traverse.DFS;
-import lombok.Data;
-import lombok.EqualsAndHashCode;
-import org.apache.commons.io.output.NullOutputStream;
-import org.jgrapht.graph.DefaultDirectedGraph;
-import org.jgrapht.nio.json.JSONExporter;
-
 import java.io.IOException;
 import java.io.PrintStream;
 import java.util.*;
 import java.util.function.BiFunction;
 import java.util.function.Supplier;
 import java.util.stream.Collectors;
-
-import static com.ibm.cldk.CodeAnalyzer.analysisLevel;
-import static com.ibm.cldk.utils.AnalysisUtils.*;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import org.apache.commons.io.output.NullOutputStream;
+import org.jgrapht.graph.DefaultDirectedGraph;
+import org.jgrapht.nio.json.JSONExporter;
 
 
 @Data
@@ -238,4 +237,4 @@ public static List<Dependency> construct(
 
         return edges;
     }
-}
+}

src/main/java/com/ibm/cldk/entities/AbstractGraphEdge.java

@@ -13,17 +13,17 @@
 
 package com.ibm.cldk.entities;
 
+import static com.ibm.cldk.CodeAnalyzer.gson;
+
 import com.ibm.wala.ipa.callgraph.CGNode;
 import com.ibm.wala.ipa.slicer.Statement;
 import com.ibm.wala.shrike.shrikeCT.InvalidClassFileException;
 import com.ibm.wala.ssa.IR;
 import com.ibm.wala.ssa.SSAInstruction;
-import lombok.Getter;
-import org.jgrapht.nio.Attribute;
 import java.io.Serializable;
 import java.util.Map;
-
-import static com.ibm.cldk.CodeAnalyzer.gson;
+import lombok.Getter;
+import org.jgrapht.nio.Attribute;
 
 /**
  * The type Abstract graph edge.

src/main/java/com/ibm/cldk/entities/AbstractGraphVertex.java

@@ -1,9 +1,8 @@
 package com.ibm.cldk.entities;
 
-import org.jgrapht.nio.Attribute;
-
 import java.io.Serializable;
 import java.util.Map;
+import org.jgrapht.nio.Attribute;
 
 
 public abstract class AbstractGraphVertex implements Serializable {

src/main/java/com/ibm/cldk/entities/CRUDOperation.java

@@ -2,10 +2,10 @@
 
 import com.ibm.cldk.javaee.utils.enums.CRUDOperationType;
 import com.ibm.cldk.utils.annotations.NotImplemented;
+import java.util.List;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
-import java.util.List;
 
 @Data
 @NoArgsConstructor
@@ -22,4 +22,4 @@ public class CRUDOperation {
     private String condition;
     @NotImplemented
     private List<String> joinedTables;
-}
+}

src/main/java/com/ibm/cldk/entities/CRUDQuery.java

@@ -1,12 +1,11 @@
 package com.ibm.cldk.entities;
 
 import com.ibm.cldk.javaee.utils.enums.CRUDQueryType;
+import java.util.List;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
 
-import java.util.List;
-
 @Data
 @NoArgsConstructor
 @AllArgsConstructor

src/main/java/com/ibm/cldk/entities/CallEdge.java

@@ -13,11 +13,10 @@
 
 package com.ibm.cldk.entities;
 
-import org.jgrapht.nio.Attribute;
-import org.jgrapht.nio.DefaultAttribute;
-
 import java.util.LinkedHashMap;
 import java.util.Map;
+import org.jgrapht.nio.Attribute;
+import org.jgrapht.nio.DefaultAttribute;
 
 /**
  * The type Call edge.
@@ -73,4 +72,4 @@ public Map<String, String> getAttributesMap() {
         map.put("weight", String.valueOf(getWeight()));
         return map;
     }
-}
+}

src/main/java/com/ibm/cldk/entities/CallSite.java

@@ -1,10 +1,9 @@
 package com.ibm.cldk.entities;
 
-import lombok.Data;
-
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Optional;
+import lombok.Data;
 
 /**
  * Represents a call site within source code, encapsulating information about method invocations
@@ -86,4 +85,4 @@ public class CallSite {
 
     /** Ending column number of the call site in the source file */
     private int endColumn;
-}
+}