add project branches and branch to scan (#33)

Author: diogopcx

src/main/java/com/checkmarx/ast/scan/Scan.java

@@ -26,17 +26,20 @@ public class Scan extends CxBaseObject {
     String Status;
     String Initiator;
     String Origin;
+    String Branch;
 
     @JsonCreator
     public Scan(@JsonProperty("ID") String ID, @JsonProperty("ProjectID") String ProjectID,
                 @JsonProperty("Status") String Status, @JsonProperty("CreatedAt") String CreatedAt,
                 @JsonProperty("UpdatedAt") String UpdatedAt, @JsonProperty("Tags") Map<String, String> Tags,
-                @JsonProperty("Initiator") String Initiator, @JsonProperty("Origin") String Origin) {
+                @JsonProperty("Initiator") String Initiator, @JsonProperty("Origin") String Origin,
+                @JsonProperty("Branch") String Branch) {
         super(ID, CreatedAt, UpdatedAt, Tags);
         this.ProjectID = ProjectID;
         this.Status = Status;
         this.Initiator = Initiator;
         this.Origin = Origin;
+        this.Branch = Branch;
     }
 
     public static <T> T fromLine(String line) {

src/main/java/com/checkmarx/ast/wrapper/CxConstants.java

@@ -20,6 +20,7 @@ public final class CxConstants {
     static final String CMD_AUTH = "auth";
     static final String SUB_CMD_VALIDATE = "validate";
     static final String CMD_PROJECT = "project";
+    static final String SUB_CMD_BRANCHES = "branches";
     static final String CMD_SCAN = "scan";
     static final String SUB_CMD_SHOW = "show";
     static final String SUB_CMD_LIST = "list";

src/main/java/com/checkmarx/ast/wrapper/CxWrapper.java

@@ -5,6 +5,8 @@
 import com.checkmarx.ast.results.Results;
 import com.checkmarx.ast.scan.Scan;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.type.CollectionType;
+import com.fasterxml.jackson.databind.type.TypeFactory;
 import lombok.NonNull;
 import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
@@ -22,6 +24,9 @@
 
 public class CxWrapper {
 
+    private static final CollectionType BRANCHES_TYPE = TypeFactory.defaultInstance()
+                                                                   .constructCollectionType(List.class, String.class);
+
     @NonNull
     private final CxConfig cxConfig;
     @NonNull
@@ -79,10 +84,7 @@ public List<Scan> scanList(String filter) throws IOException, InterruptedExcepti
         arguments.add(CxConstants.CMD_SCAN);
         arguments.add(CxConstants.SUB_CMD_LIST);
         arguments.addAll(jsonArguments());
-        if (StringUtils.isNotBlank(filter)) {
-            arguments.add(CxConstants.FILTER);
-            arguments.add(filter);
-        }
+        arguments.addAll(filterArguments(filter));
 
         return Execution.executeCommand(withConfigArguments(arguments), logger, Scan::listFromLine);
     }
@@ -133,15 +135,28 @@ public List<Project> projectList(String filter) throws IOException, InterruptedE
         List<String> arguments = new ArrayList<>();
         arguments.add(CxConstants.CMD_PROJECT);
         arguments.add(CxConstants.SUB_CMD_LIST);
-        if (StringUtils.isNotBlank(filter)) {
-            arguments.add(CxConstants.FILTER);
-            arguments.add(filter);
-        }
+        arguments.addAll(filterArguments(filter));
         arguments.addAll(jsonArguments());
 
         return Execution.executeCommand(withConfigArguments(arguments), logger, Project::listFromLine);
     }
 
+    public List<String> projectBranches(@NonNull UUID projectId, String filter)
+            throws CxException, IOException, InterruptedException {
+        this.logger.info("initialized retrieval for project branches {}", filter);
+
+        List<String> arguments = new ArrayList<>();
+        arguments.add(CxConstants.CMD_PROJECT);
+        arguments.add(CxConstants.SUB_CMD_BRANCHES);
+        arguments.add(CxConstants.PROJECT_ID);
+        arguments.add(projectId.toString());
+        arguments.addAll(filterArguments(filter));
+
+        return Execution.executeCommand(withConfigArguments(arguments),
+                                        logger,
+                                        (line) -> CxBaseObject.parse(line, BRANCHES_TYPE));
+    }
+
     public Results results(@NonNull UUID scanId) throws IOException, InterruptedException, CxException {
         return new ObjectMapper()
                 .readerFor(Results.class)
@@ -189,4 +204,15 @@ private List<String> jsonArguments() {
 
         return arguments;
     }
+
+    private List<String> filterArguments(String filter) {
+        List<String> arguments = new ArrayList<>();
+
+        if (StringUtils.isNotBlank(filter)) {
+            arguments.add(CxConstants.FILTER);
+            arguments.add(filter);
+        }
+
+        return arguments;
+    }
 }

src/test/java/com/checkmarx/ast/BaseTest.java

@@ -1,11 +1,15 @@
 package com.checkmarx.ast;
 
 import com.checkmarx.ast.wrapper.CxConfig;
+import com.checkmarx.ast.wrapper.CxConstants;
 import com.checkmarx.ast.wrapper.CxWrapper;
 import org.junit.Before;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.util.HashMap;
+import java.util.Map;
+
 public abstract class BaseTest {
 
     protected CxWrapper wrapper;
@@ -45,4 +49,13 @@ protected static CxConfig getConfig() {
     private static String getEnvOrNull(String key) {
         return System.getenv().getOrDefault(key, null);
     }
+
+    protected Map<String, String> commonParams() {
+        Map<String, String> params = new HashMap<>();
+        params.put(CxConstants.PROJECT_NAME, "JavaWrapperTestCases");
+        params.put(CxConstants.SOURCE, ".");
+        params.put(CxConstants.FILE_FILTER, "*.java");
+        params.put(CxConstants.SAST_PRESET_NAME, "Checkmarx Default");
+        return params;
+    }
 }

src/test/java/com/checkmarx/ast/ProjectTest.java

@@ -1,10 +1,13 @@
 package com.checkmarx.ast;
 
 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 java.util.List;
+import java.util.Map;
 import java.util.UUID;
 
 public class ProjectTest extends BaseTest {
@@ -22,4 +25,14 @@ public void testProjectList() throws Exception {
         List<Project> projectList = wrapper.projectList("limit=10");
         Assert.assertTrue(projectList.size() <= 10);
     }
+
+    @Test
+    public void testProjectBranches() throws Exception {
+        Map<String, String> params = commonParams();
+        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"));
+    }
 }

src/test/java/com/checkmarx/ast/ScanTest.java

@@ -6,23 +6,12 @@
 import org.junit.Assert;
 import org.junit.Test;
 
-import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.UUID;
 
 public class ScanTest extends BaseTest {
 
-
-    private Map<String, String> commonParams() {
-        Map<String, String> params = new HashMap<>();
-        params.put(CxConstants.PROJECT_NAME, "JavaWrapperTestCases");
-        params.put(CxConstants.SOURCE, ".");
-        params.put(CxConstants.FILE_FILTER, "*.java");
-        params.put(CxConstants.SAST_PRESET_NAME, "Checkmarx Default");
-        return params;
-    }
-
     @Test
     public void testScanShow() throws Exception {
         List<Scan> scanList = wrapper.scanList();