Renamed the format flag to support the new name 'scan-info-format' (#64)

Mithilesh Pawar · web-flow · commit e10b2b6407db · 2022-01-27T19:36:53.000-05:00
* Renamed the format flag to support the new name 'scan-info-format'

* Github Actions: JDK Distributions set to 'temurin'.
Previously used 'adopt' wont be receving any updates.

* Added encoding property to avoid the warning in the log.

* Removed the redundant test

* Changed the name of the AST project for tests.
Also added an agent name for the same project.

* Updated the logger messages.

* Tests migrated to Junit5

* Updated maven-source-plugin to 3.2.1

* Updated nexus-staging-maven-plugin from 1.6.7 to 1.6.8
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -12,6 +12,7 @@ jobs:
       - name: Set up JDK 8
         uses: actions/setup-java@v2.5.0
         with:
+          distribution: 'temurin'
           java-version: 8
 
       - name: Cache local Maven repository
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -29,7 +29,7 @@ jobs:
         uses: actions/setup-java@v2.5.0
         with:
           java-version: '11'
-          distribution: 'adopt'
+          distribution: 'temurin'
           server-id: ossrh
           server-username: MAVEN_USERNAME
           server-password: MAVEN_PASSWORD
diff --git a/pom.xml b/pom.xml
@@ -13,6 +13,7 @@
     <url>https://www.checkmarx.com</url>
 
     <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <ast.wrapper.version>dev</ast.wrapper.version>
         <maven.compiler.source>8</maven.compiler.source>
         <maven.compiler.target>8</maven.compiler.target>
@@ -40,12 +41,6 @@
             <version>1.2.6</version>
             <scope>test</scope>
         </dependency>
-        <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
-            <version>4.13.1</version>
-            <scope>test</scope>
-        </dependency>
         <dependency>
             <groupId>org.projectlombok</groupId>
             <artifactId>lombok</artifactId>
@@ -64,13 +59,18 @@
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter</artifactId>
-            <version>5.7.2</version>
+            <version>5.8.2</version>
             <scope>test</scope>
         </dependency>
     </dependencies>
 
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>2.22.2</version>
+            </plugin>
             <plugin>
                 <groupId>org.codehaus.mojo</groupId>
                 <artifactId>exec-maven-plugin</artifactId>
@@ -99,7 +99,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-source-plugin</artifactId>
-                <version>3.0.1</version>
+                <version>3.2.1</version>
                 <executions>
                     <execution>
                         <id>attach-sources</id>
@@ -112,7 +112,7 @@
             <plugin>
                 <groupId>org.sonatype.plugins</groupId>
                 <artifactId>nexus-staging-maven-plugin</artifactId>
-                <version>1.6.7</version>
+                <version>1.6.8</version>
                 <extensions>true</extensions>
                 <configuration>
                     <serverId>ossrh</serverId>
diff --git a/src/main/java/com/checkmarx/ast/wrapper/CxConstants.java b/src/main/java/com/checkmarx/ast/wrapper/CxConstants.java
@@ -30,6 +30,7 @@ public final class CxConstants {
     static final String SUB_CMD_UPDATE = "update";
     static final String CMD_RESULT = "result";
     static final String FORMAT = "--format";
+    static final String SCAN_INFO_FORMAT = "--scan-info-format";
     static final String FORMAT_JSON = "json";
     static final String FILTER = "--filter";
     static final String SCAN_ID = "--scan-id";
diff --git a/src/main/java/com/checkmarx/ast/wrapper/CxThinWrapper.java b/src/main/java/com/checkmarx/ast/wrapper/CxThinWrapper.java
@@ -23,11 +23,11 @@ public CxThinWrapper() throws IOException {
     public CxThinWrapper(@NonNull Logger logger) throws IOException {
         this.logger = logger;
         this.executable = Execution.getTempBinary();
-        this.logger.info("using executable: " + executable);
+        this.logger.info("Executable path: " + executable);
     }
 
     public String run(@NonNull String arguments) throws CxException, IOException, InterruptedException {
-        this.logger.info("executing thin wrapper command");
+        this.logger.info("Executing commands with thin wrapper.");
         List<String> argv = new ArrayList<>();
         argv.add(executable);
         argv.addAll(Arrays.asList(arguments.split(" ")));
diff --git a/src/main/java/com/checkmarx/ast/wrapper/CxWrapper.java b/src/main/java/com/checkmarx/ast/wrapper/CxWrapper.java
@@ -46,11 +46,11 @@ public CxWrapper(@NonNull CxConfig cxConfig, @NonNull Logger logger) throws CxCo
         this.executable = StringUtils.isBlank(this.cxConfig.getPathToExecutable())
                           ? Execution.getTempBinary()
                           : this.cxConfig.getPathToExecutable();
-        this.logger.info("using executable: " + executable);
+        this.logger.info("Executable path: " + executable);
     }
 
     public String authValidate() throws IOException, InterruptedException, CxException {
-        this.logger.info("initialized authentication validation command");
+        this.logger.info("Executing 'auth validate' command using the CLI.");
 
         List<String> arguments = new ArrayList<>();
         arguments.add(CxConstants.CMD_AUTH);
@@ -60,7 +60,7 @@ public String authValidate() throws IOException, InterruptedException, CxExcepti
     }
 
     public Scan scanShow(@NonNull UUID scanId) throws IOException, InterruptedException, CxException {
-        this.logger.info("initialized scan retrieval for id: {}", scanId);
+        this.logger.info("Retrieving the details for scan id: {}", scanId);
 
         List<String> arguments = new ArrayList<>();
         arguments.add(CxConstants.CMD_SCAN);
@@ -77,7 +77,7 @@ public List<Scan> scanList() throws IOException, InterruptedException, CxExcepti
     }
 
     public List<Scan> scanList(String filter) throws IOException, InterruptedException, CxException {
-        this.logger.info("initialized retrieval for scan list {}", filter);
+        this.logger.info("Fetching the scan list using the filter: {}", filter);
 
         List<String> arguments = new ArrayList<>();
         arguments.add(CxConstants.CMD_SCAN);
@@ -94,12 +94,13 @@ public Scan scanCreate(@NonNull Map<String, String> params) throws IOException,
 
     public Scan scanCreate(@NonNull Map<String, String> params, String additionalParameters)
             throws IOException, InterruptedException, CxException {
-        this.logger.info("initialized scan create command");
+        this.logger.info("Executing 'scan create' command using the CLI.");
 
         List<String> arguments = new ArrayList<>();
         arguments.add(CxConstants.CMD_SCAN);
         arguments.add(CxConstants.SUB_CMD_CREATE);
-        arguments.addAll(jsonArguments());
+        arguments.add(CxConstants.SCAN_INFO_FORMAT);
+        arguments.add(CxConstants.FORMAT_JSON);
 
         for (Map.Entry<String, String> param : params.entrySet()) {
             arguments.add(param.getKey());
@@ -112,7 +113,8 @@ public Scan scanCreate(@NonNull Map<String, String> params, String additionalPar
     }
 
     public List<Predicate> triageShow(@NonNull UUID projectId, String similarityId, String scanType) throws IOException, InterruptedException, CxException {
-        this.logger.info("initialized triage for project with id: {}", projectId);
+        this.logger.info("Executing 'triage show' command using the CLI.");
+        this.logger.info("Fetching the list of predicates for projectId {} , similarityId {} and scan-type {}.,", projectId, similarityId, scanType);
 
         List<String> arguments = new ArrayList<>();
         arguments.add(CxConstants.CMD_TRIAGE);
@@ -130,7 +132,8 @@ public List<Predicate> triageShow(@NonNull UUID projectId, String similarityId,
     }
 
     public void triageUpdate(@NonNull UUID projectId, String similarityId, String scanType, String state, String comment, String severity) throws IOException, InterruptedException, CxException {
-        this.logger.info("initialized triage update project with id: {}", projectId);
+        this.logger.info("Executing 'triage update' command using the CLI.");
+        this.logger.info("Updating the similarityId {} with state {} and severity {}.", similarityId, state, severity);
 
         List<String> arguments = new ArrayList<>();
         arguments.add(CxConstants.CMD_TRIAGE);
@@ -154,7 +157,7 @@ public void triageUpdate(@NonNull UUID projectId, String similarityId, String sc
     }
 
     public Project projectShow(@NonNull UUID projectId) throws IOException, InterruptedException, CxException {
-        this.logger.info("initialized project retrieval for id: {}", projectId);
+        this.logger.info("Retrieving the details for project id: {}", projectId);
 
         List<String> arguments = new ArrayList<>();
         arguments.add(CxConstants.CMD_PROJECT);
@@ -171,7 +174,7 @@ public List<Project> projectList() throws IOException, InterruptedException, CxE
     }
 
     public List<Project> projectList(String filter) throws IOException, InterruptedException, CxException {
-        this.logger.info("initialized retrieval for project list {}", filter);
+        this.logger.info("Fetching the project list using the filter: {}", filter);
 
         List<String> arguments = new ArrayList<>();
         arguments.add(CxConstants.CMD_PROJECT);
@@ -184,7 +187,7 @@ public List<Project> projectList(String filter) throws IOException, InterruptedE
 
     public List<String> projectBranches(@NonNull UUID projectId, String filter)
             throws CxException, IOException, InterruptedException {
-        this.logger.info("initialized retrieval for project branches {}", filter);
+        this.logger.info("Fetching the branches for project id {} using the filter: {}", projectId, filter);
 
         List<String> arguments = new ArrayList<>();
         arguments.add(CxConstants.CMD_PROJECT);
@@ -212,7 +215,7 @@ public Results results(@NonNull UUID scanId) throws IOException, InterruptedExce
 
     public String results(@NonNull UUID scanId, ReportFormat reportFormat)
             throws IOException, InterruptedException, CxException {
-        this.logger.info("initialized results command {}", reportFormat);
+        this.logger.info("Retrieving the scan result for scan id {}", scanId);
 
         String tempDir = Files.createTempDirectory("cx").toAbsolutePath().toString();
         String fileName = Long.toString(System.nanoTime());
diff --git a/src/test/java/com/checkmarx/ast/AuthTest.java b/src/test/java/com/checkmarx/ast/AuthTest.java
@@ -4,21 +4,22 @@
 import com.checkmarx.ast.wrapper.CxException;
 import com.checkmarx.ast.wrapper.CxWrapper;
 import org.junit.Assert;
-import org.junit.Test;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
 
 import java.io.IOException;
 
 public class AuthTest extends BaseTest {
 
     @Test
     public void testAuthValidate() throws CxException, IOException, InterruptedException {
-        Assert.assertNotNull(wrapper.authValidate());
+        Assertions.assertNotNull(wrapper.authValidate());
     }
 
     @Test
     public void testAuthFailure() {
         CxConfig cxConfig = getConfig();
         cxConfig.setBaseAuthUri("wrongAuth");
-        Assert.assertThrows(CxException.class, () -> new CxWrapper(cxConfig, getLogger()).authValidate());
+        Assertions.assertThrows(CxException.class, () -> new CxWrapper(cxConfig, getLogger()).authValidate());
     }
 }
diff --git a/src/test/java/com/checkmarx/ast/BaseTest.java b/src/test/java/com/checkmarx/ast/BaseTest.java
@@ -3,7 +3,7 @@
 import com.checkmarx.ast.wrapper.CxConfig;
 import com.checkmarx.ast.wrapper.CxConstants;
 import com.checkmarx.ast.wrapper.CxWrapper;
-import org.junit.Before;
+import org.junit.jupiter.api.BeforeEach;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -13,8 +13,9 @@
 public abstract class BaseTest {
 
     protected CxWrapper wrapper;
+    private String projectId;
 
-    @Before
+    @BeforeEach
     public void init() throws Exception {
         wrapper = new CxWrapper(getConfig(), getLogger());
     }
@@ -35,15 +36,15 @@ protected Logger getLogger() {
 
     protected static CxConfig getConfig() {
         return CxConfig.builder()
-                       .baseUri(CX_BASE_URI)
-                       .baseAuthUri(CX_BASE_AUTH_URI)
-                       .tenant(CX_TENANT)
-                       .apiKey(CX_APIKEY)
-                       .clientId(CX_CLIENT_ID)
-                       .clientSecret(CX_CLIENT_SECRET)
-                       .additionalParameters(CX_ADDITIONAL_PARAMETERS)
-                       .pathToExecutable(PATH_TO_EXECUTABLE)
-                       .build();
+                .baseUri(CX_BASE_URI)
+                .baseAuthUri(CX_BASE_AUTH_URI)
+                .tenant(CX_TENANT)
+                .apiKey(CX_APIKEY)
+                .clientId(CX_CLIENT_ID)
+                .clientSecret(CX_CLIENT_SECRET)
+                .additionalParameters(CX_ADDITIONAL_PARAMETERS)
+                .pathToExecutable(PATH_TO_EXECUTABLE)
+                .build();
     }
 
     private static String getEnvOrNull(String key) {
@@ -52,11 +53,12 @@ private static String getEnvOrNull(String key) {
 
     protected Map<String, String> commonParams() {
         Map<String, String> params = new HashMap<>();
-        params.put(CxConstants.PROJECT_NAME, "JavaWrapperTestCases");
+        params.put(CxConstants.PROJECT_NAME, "AST-CLI-Java-Wrapper-Tests");
         params.put(CxConstants.SOURCE, ".");
-        params.put(CxConstants.FILE_FILTER, "*.java");
+        params.put(CxConstants.FILE_FILTER, "!test");
         params.put(CxConstants.BRANCH, "main");
         params.put(CxConstants.SAST_PRESET_NAME, "Checkmarx Default");
+        params.put(CxConstants.AGENT, "AST-CLI-Java-Wrapper");
         return params;
     }
 }
diff --git a/src/test/java/com/checkmarx/ast/PredicateTest.java b/src/test/java/com/checkmarx/ast/PredicateTest.java
@@ -1,13 +1,12 @@
 package com.checkmarx.ast;
 
 import com.checkmarx.ast.predicate.Predicate;
-import com.checkmarx.ast.project.Project;
 import com.checkmarx.ast.results.Results;
 import com.checkmarx.ast.results.result.Result;
 import com.checkmarx.ast.scan.Scan;
 import com.checkmarx.ast.wrapper.CxConstants;
-import org.junit.Assert;
-import org.junit.Test;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
 
 import java.util.List;
 import java.util.UUID;
@@ -20,22 +19,22 @@ public class PredicateTest extends BaseTest {
     public void testTriageShow() throws Exception {
         List<Scan> scanList = wrapper.scanList(String.format("statuses=Completed"));
         Scan scan = scanList.get(0);
-        Assert.assertTrue(scanList.size() > 0);
+        Assertions.assertTrue(scanList.size() > 0);
         String scanId = scanList.get(0).getID();
 
         Results results = wrapper.results(UUID.fromString(scanId));
         Result result = results.getResults().stream().filter(res -> res.getType().equalsIgnoreCase(CxConstants.SAST)).findFirst().get();
 
         List<Predicate> predicates = wrapper.triageShow(UUID.fromString(scan.getProjectID()), result.getSimilarityId(), result.getType());
 
-        Assert.assertNotNull(predicates);
+        Assertions.assertNotNull(predicates);
     }
 
     @Test
     public void testTriageUpdate() throws Exception {
         List<Scan> scanList = wrapper.scanList(String.format("statuses=Completed"));
         Scan scan = scanList.get(0);
-        Assert.assertTrue(scanList.size() > 0);
+        Assertions.assertTrue(scanList.size() > 0);
         String scanId = scanList.get(0).getID();
 
         Results results = wrapper.results(UUID.fromString(scanId));
@@ -44,7 +43,7 @@ public void testTriageUpdate() throws Exception {
         try {
             wrapper.triageUpdate(UUID.fromString(scan.getProjectID()), result.getSimilarityId(), result.getType(), "to_verify", "Edited via Java Wrapper", "high");
         } catch (Exception e) {
-            fail("Triage update failed. Should not throw exception");
+            Assertions.fail("Triage update failed. Should not throw exception");
         }
     }
 }
diff --git a/src/test/java/com/checkmarx/ast/ProjectTest.java b/src/test/java/com/checkmarx/ast/ProjectTest.java
@@ -3,8 +3,8 @@
 import com.checkmarx.ast.project.Project;
 import com.checkmarx.ast.scan.Scan;
 import com.checkmarx.ast.wrapper.CxConstants;
-import org.junit.Assert;
-import org.junit.Test;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
 
 import java.util.List;
 import java.util.Map;
@@ -15,15 +15,15 @@ public class ProjectTest extends BaseTest {
     @Test
     public void testProjectShow() throws Exception {
         List<Project> projectList = wrapper.projectList();
-        Assert.assertTrue(projectList.size() > 0);
+        Assertions.assertTrue(projectList.size() > 0);
         Project project = wrapper.projectShow(UUID.fromString(projectList.get(0).getID()));
-        Assert.assertEquals(projectList.get(0).getID(), project.getID());
+        Assertions.assertEquals(projectList.get(0).getID(), project.getID());
     }
 
     @Test
     public void testProjectList() throws Exception {
         List<Project> projectList = wrapper.projectList("limit=10");
-        Assert.assertTrue(projectList.size() <= 10);
+        Assertions.assertTrue(projectList.size() <= 10);
     }
 
     @Test
@@ -32,7 +32,7 @@ public void testProjectBranches() throws Exception {
         params.put(CxConstants.BRANCH, "test");
         Scan scan = wrapper.scanCreate(params);
         List<String> branches = wrapper.projectBranches(UUID.fromString(scan.getProjectID()), "");
-        Assert.assertTrue(branches.size() >= 1);
-        Assert.assertTrue(branches.contains("test"));
+        Assertions.assertTrue(branches.size() >= 1);
+        Assertions.assertTrue(branches.contains("test"));
     }
 }
diff --git a/src/test/java/com/checkmarx/ast/ResultTest.java b/src/test/java/com/checkmarx/ast/ResultTest.java
diff --git a/src/test/java/com/checkmarx/ast/ScanTest.java b/src/test/java/com/checkmarx/ast/ScanTest.java
diff --git a/src/test/java/com/checkmarx/ast/ThinWrapperTest.java b/src/test/java/com/checkmarx/ast/ThinWrapperTest.java
