Merge pull request #104 from codellm-devkit/issue-86-entrypoints

Issue 86 entrypoints

Author: rahlk

build.gradle

@@ -15,7 +15,7 @@ plugins {
     // Apply the application plugin to add support for building a CLI application in Java.
     id 'eclipse'
     id 'application'
-    id 'org.graalvm.buildtools.native' version '0.9.28'
+    id 'org.graalvm.buildtools.native' version '0.10.4'
 }
 
 // Get the version from the property file first

gradle.properties

@@ -1 +1 @@
-version=2.0.2
+version=2.1.0-dev

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

@@ -0,0 +1,48 @@
+package com.ibm.cldk.entities;
+
+import com.ibm.cldk.utils.annotations.NotImplemented;
+import com.ibm.cldk.utils.annotations.Todo;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import java.util.List;
+
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+@NotImplemented
+public class CRUDOperation {
+    public enum OperationType {
+        CREATE,
+        READ,
+        UPDATE,
+        DELETE,
+        UNKNOWN
+    }
+
+    @Todo(comment = "Add more frameworks, and consider moving this outside because this may be generic.")
+    @NotImplemented
+    public enum JavaFramework {
+        JPA,
+        SPRING
+    }
+
+    private OperationType operationType;
+    private String targetTable;
+    private int lineNumber;
+    private int startPosition;
+    private int endPosition;
+
+    @NotImplemented
+    private String operationString;
+    @NotImplemented
+    private List<String> involvedFields;
+    @NotImplemented
+    private String condition;
+    @NotImplemented
+    private List<String> joinedTables;
+    @NotImplemented
+    private JavaFramework framework;
+    @NotImplemented
+    private boolean isBatchOperation = false;
+}

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

@@ -2,6 +2,7 @@
 
 import lombok.Data;
 
+import java.util.ArrayList;
 import java.util.List;
 
 @Data
@@ -25,4 +26,6 @@ public class Callable {
     private List<CallSite> callSites;
     private List<VariableDeclaration> variableDeclarations;
     private int cyclomaticComplexity;
+    private boolean isEntrypoint = false;
+    private List<CRUDOperation> crudOperations = null;
 }

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

@@ -25,4 +25,5 @@ public class Type {
     private Map<String, Callable> callableDeclarations;
     private List<Field> fieldDeclarations;
     private List<EnumConstant> enumConstants;
+    private boolean isEntrypointClass = false;
 }

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

@@ -234,18 +234,18 @@ public static boolean downloadLibraryDependencies(String projectPath, String pro
             String[] mavenCommand = {MAVEN_CMD, "--no-transfer-progress", "-f", Paths.get(projectRoot, "pom.xml").toString(), "dependency:copy-dependencies", "-DoutputDirectory=" + libDownloadPath.toString()};
             return buildWithTool(mavenCommand);
         } else if (new File(projectRoot, "build.gradle").exists() || new File(projectRoot, "build.gradle.kts").exists()) {
-            if (GRADLE_CMD == null || !commandExists(new File(GRADLE_CMD)).getKey()) {
-                libDownloadPath = Paths.get(projectPath, "build", LIB_DEPS_DOWNLOAD_DIR).toAbsolutePath();
+            libDownloadPath = Paths.get(projectPath, "build", LIB_DEPS_DOWNLOAD_DIR).toAbsolutePath();
                 if (mkLibDepDirs(projectPath))
                     Log.debug("Dependencies found/created in " + libDownloadPath);
                 else
                     throw new IllegalStateException("Error creating library dependency directory in " + libDownloadPath);
 
+            if (GRADLE_CMD == null || !commandExists(new File(GRADLE_CMD)).getKey()) {
                 String msg = GRADLE_CMD == null ?
                         "Could not find Gradle or valid Gradle Wrapper" :
                         MessageFormat.format("Could not verify that {0} exists", GRADLE_CMD);
                 Log.error(msg);
-                throw new IllegalStateException("Unable to execute Maven command. " +
+                throw new IllegalStateException("Unable to execute Gradle command. " +
                         (GRADLE_CMD == null ?
                                 "Could not find Gradle or valid Gradle Wrapper" :
                                 "Attempt failed with message\n" + commandExists(new File(GRADLE_CMD)).getValue()

src/main/java/com/ibm/cldk/utils/BuildProject.java

@@ -0,0 +1,13 @@
+package com.ibm.cldk.utils.annotations;
+
+import java.lang.annotation.*;
+
+@Documented
+@Target({ElementType.METHOD, ElementType.FIELD, ElementType.TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+public @interface NotImplemented {
+    String value() default "";
+    String since() default "";
+    String issue() default "";
+    String comment() default "";
+}

src/main/java/com/ibm/cldk/utils/annotations/NotImplemented.java

@@ -0,0 +1,12 @@
+package com.ibm.cldk.utils.annotations;
+
+import java.lang.annotation.*;
+
+@Documented
+@Target({ElementType.METHOD, ElementType.FIELD, ElementType.TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Todo {
+    String value() default "";
+    String issue() default "";
+    String comment() default "";
+}

src/main/java/com/ibm/cldk/utils/annotations/Todo.java

@@ -1,5 +1,8 @@
 package com.ibm.cldk;
 
+import com.google.gson.Gson;
+import com.google.gson.JsonElement;
+import com.google.gson.JsonObject;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.Assertions;
@@ -15,8 +18,11 @@
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.text.MessageFormat;
+import java.util.Map;
 import java.util.Properties;
 
+import static com.ibm.cldk.CodeAnalyzer.gson;
+import static org.junit.Assert.assertTrue;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 
 @Testcontainers
@@ -61,7 +67,8 @@ public class CodeAnalyzerIntegrationTest {
             .withCommand("-c", "while true; do sleep 1; done")
             .withCopyFileToContainer(MountableFile.forHostPath(Paths.get(System.getProperty("user.dir")).resolve("build/libs")), "/opt/jars")
             .withCopyFileToContainer(MountableFile.forHostPath(Paths.get(System.getProperty("user.dir")).resolve("src/test/resources/test-applications/mvnw-corrupt-test")), "/test-applications/mvnw-corrupt-test")
-            .withCopyFileToContainer(MountableFile.forHostPath(Paths.get(System.getProperty("user.dir")).resolve("src/test/resources/test-applications/mvnw-working-test")), "/test-applications/mvnw-working-test");
+            .withCopyFileToContainer(MountableFile.forHostPath(Paths.get(System.getProperty("user.dir")).resolve("src/test/resources/test-applications/mvnw-working-test")), "/test-applications/mvnw-working-test")
+            .withCopyFileToContainer(MountableFile.forHostPath(Paths.get(System.getProperty("user.dir")).resolve("src/test/resources/test-applications/daytrader8")), "/test-applications/daytrader8");
 
 
     @BeforeAll
@@ -145,4 +152,17 @@ void corruptMavenShouldNotTerminateWithErrorWhenMavenIsNotPresentUnlessAnalysisL
         Assertions.assertEquals(1, runCodeAnalyzer.getExitCode());
         Assertions.assertTrue(runCodeAnalyzer.getStderr().contains("java.lang.RuntimeException"));
     }
+
+    @Test
+    void shouldBeAbleToGenerateAnalysisArtifactForDaytrader8() throws Exception {
+        var runCodeAnalyzerOnDaytrader8 = mavenContainer.execInContainer(
+                "java",
+                "-jar",
+                String.format("/opt/jars/codeanalyzer-%s.jar", codeanalyzerVersion),
+                "--input=/test-applications/daytrader8",
+                "--analysis-level=1"
+        );
+        Assertions.assertTrue(runCodeAnalyzerOnDaytrader8.getStdout().contains("\"is_entrypoint_class\": true"), "No entry point classes found");
+        Assertions.assertTrue(runCodeAnalyzerOnDaytrader8.getStdout().contains("\"is_entrypoint\": true"), "No entry point methods found");
+    }
 }