Changes related to ignore/revive functionality (AST-109612)

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

@@ -16,7 +16,7 @@
 public class CxConfig {
 
     private static final Pattern pattern = Pattern.compile("([^\"]\\S*|\".+?\")\\s*");
-
+    private String agentName;    //JETBRAINS 
     private String baseUri;
     private String baseAuthUri;
     private String tenant;
@@ -66,6 +66,10 @@ List<String> toArguments() {
             commands.add(CxConstants.BASE_AUTH_URI);
             commands.add(getBaseAuthUri());
         }
+        if (getAgentName() != null && !getAgentName().isEmpty()) {
+            commands.add("--agent");
+            commands.add(getAgentName()); 
+        }        
         if (getAdditionalParameters() != null)
             commands.addAll(getAdditionalParameters());
 

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

@@ -75,6 +75,8 @@ public final class CxConstants {
     static final String SUB_CMD_TENANT = "tenant";
     static final String IDE_SCANS_KEY = "scan.config.plugins.ideScans";
     static final String AI_MCP_SERVER_KEY = "scan.config.plugins.aiMcpServer";
+    static final String DEV_ASSIST_LICENSE_KEY = "scan.config.plugins.cxdevassist";
+    static final String ONE_ASSIST_LICENSE_KEY = "scan.config.plugins.cxoneassist";
     static final String IGNORED_FILE_PATH = "--ignored-file-path";
     static final String SUB_CMD_OSS_REALTIME = "oss-realtime";
     static final String SUB_CMD_IAC_REALTIME = "iac-realtime";
@@ -91,4 +93,8 @@ public final class CxConstants {
     static final String SCAN_TYPE_FLAG = "--scan-type";
     static final String STATUS = "--status";
     static final String TOTAL_COUNT = "--total-count";
+    static final String DOCKER = "docker";
+    static final String PODMAN = "podman";
+    static final String PODMAN_FALLBACK_PATH = "/usr/local/bin/podman";
+    static final String DOCKER_FALLBACK_PATH = "/usr/local/bin/docker";
 }

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

@@ -29,17 +29,22 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.io.File;
 import java.io.IOException;
 import java.nio.file.Files;
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Map;
-import java.util.UUID;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.*;
+
+import static com.checkmarx.ast.wrapper.Execution.*;
 
 public class CxWrapper {
 
     private static final CollectionType BRANCHES_TYPE = TypeFactory.defaultInstance()
             .constructCollectionType(List.class, String.class);
+    private static final String OS_LINUX = "linux";
+    private static final String OS_WINDOWS = "windows";
+    private static final String OS_MAC = "mac";
 
     @NonNull
     private final CxConfig cxConfig;
@@ -248,7 +253,7 @@ public List<Project> projectList(String filter) throws IOException, InterruptedE
         return Execution.executeCommand(withConfigArguments(arguments), logger, Project::listFromLine);
     }
 
-    public ScanResult ScanAsca(String fileSource, boolean ascaLatestVersion, String agent) throws IOException, InterruptedException, CxException {
+    public ScanResult ScanAsca(String fileSource, boolean ascaLatestVersion, String agent, String ignoredFilePath) throws IOException, InterruptedException, CxException {
         this.logger.info("Fetching ASCA scanResult");
 
         List<String> arguments = new ArrayList<>();
@@ -259,23 +264,27 @@ public ScanResult ScanAsca(String fileSource, boolean ascaLatestVersion, String
         if (ascaLatestVersion) {
             arguments.add(CxConstants.ASCA_LATEST_VERSION);
         }
+        if (StringUtils.isNotBlank(ignoredFilePath)) {
+            arguments.add(CxConstants.IGNORED_FILE_PATH);
+            arguments.add(ignoredFilePath);
+        }
+
 
-        appendAgentToArguments(agent, arguments);
 
         return Execution.executeCommand(withConfigArguments(arguments), logger, ScanResult::fromLine,
                 (args, ignored) ->
                         (args.size() >= 3 && args.get(1).equals(CxConstants.CMD_SCAN) && args.get(2).equals(CxConstants.SUB_CMD_ASCA)));
     }
 
-    private static void appendAgentToArguments(String agent, List<String> arguments) {
-        arguments.add(CxConstants.AGENT);
-        if (agent != null && !agent.isEmpty()){
-            arguments.add(agent);
-        }
-        else{
-            arguments.add("CLI-Java-Wrapper");
-        }
-    }
+    // private static void appendAgentToArguments(String agent, List<String> arguments) {
+    //     arguments.add(CxConstants.AGENT);
+    //     if (agent != null && !agent.isEmpty()){
+    //         arguments.add(agent);
+    //     }
+    //     else{
+    //         arguments.add("CLI-Java-Wrapper");
+    //     }
+    // }
 
     public List<String> projectBranches(@NonNull UUID projectId, String filter)
             throws CxException, IOException, InterruptedException {
@@ -345,10 +354,6 @@ public String results(@NonNull UUID scanId, ReportFormat reportFormat, String ag
         arguments.add(fileName);
         arguments.add(CxConstants.OUTPUT_PATH);
         arguments.add(tempDir);
-        if (agent != null) {
-            arguments.add(CxConstants.AGENT);
-            arguments.add(agent);
-        }
         return Execution.executeCommand(arguments,
                 logger, tempDir,
                 fileName + reportFormat.getExtension());
@@ -409,6 +414,68 @@ public KicsRealtimeResults kicsRealtimeScan(@NonNull String fileSources, String
         return Execution.executeCommand(withConfigArguments(arguments), logger, KicsRealtimeResults::fromLine);
     }
 
+    public String checkEngineExist(@NonNull String engineName) throws CxException, IOException, InterruptedException {
+             String osName = System.getProperty("os.name").toLowerCase(Locale.ENGLISH);
+             String osType=Execution.getOperatingSystemType(osName);
+                return this.checkEngine(engineName,osType);
+    }
+
+    private String verifyEngineOnMAC(String engineName,List<String>arguments) throws CxException, IOException, InterruptedException {
+        Exception lastException = null;
+        String enginePath;
+        try{
+            enginePath= Execution.executeCommand((arguments), logger, line->line);
+            return enginePath;
+        } catch (CxException | IOException e) {
+            lastException = e;
+        }
+        Path dockerPath = Paths.get(CxConstants.DOCKER_FALLBACK_PATH);
+        Path podmanPath = Paths.get(CxConstants.PODMAN_FALLBACK_PATH);
+        if (CxConstants.DOCKER.equalsIgnoreCase(engineName)) {
+            if (Files.isSymbolicLink(dockerPath)) {
+                return Files.readSymbolicLink(dockerPath).toAbsolutePath().toString();
+            }
+            else { return dockerPath.toAbsolutePath().toString(); }
+        }
+        else if (CxConstants.PODMAN.equalsIgnoreCase(engineName)) {
+            if (Files.exists(podmanPath)) {
+                if (Files.isSymbolicLink(podmanPath)) {
+                    return Files.readSymbolicLink(podmanPath).toAbsolutePath().toString();
+                }
+                else{
+                    return podmanPath.toAbsolutePath().toString();
+                }
+            }
+        }
+        throw new CxException( 1, "Engine '" + engineName + "' is not installed or not symlinked to /usr/local/bin." );
+    }
+
+    private  String checkEngine(String engineName, String osType ) throws CxException, IOException, InterruptedException {
+        List<String> arguments = new ArrayList<>();
+        switch (osType){
+            case OS_MAC:
+                arguments.add("/bin/sh");
+                arguments.add("-c");
+                arguments.add("command -v " + engineName);
+                return verifyEngineOnMAC(engineName,arguments);
+            case OS_WINDOWS:
+            case OS_LINUX:
+                arguments.add(engineName);
+                arguments.add("--version");
+                try {
+                    Execution.executeCommand(arguments, logger, line -> line);
+                    return engineName;
+                } catch (CxException | IOException e) {
+                    throw new CxException(
+                            1,engineName+" is not installed or is not accessible from the system PATH."
+                    );
+                }
+            default:
+                throw new IllegalArgumentException("Unsupported OS: " + osType);
+        }
+
+    }
+
     public <T> T realtimeScan(@NonNull String subCommand, @NonNull String sourcePath, String containerTool, String ignoredFilePath, java.util.function.Function<String, T> resultParser)
             throws IOException, InterruptedException, CxException {
         this.logger.info("Executing 'scan {}' command using the CLI.", subCommand);
@@ -495,7 +562,7 @@ public List<LearnMore> learnMore(String queryId) throws CxException, IOException
 
     public boolean ideScansEnabled() throws CxException, IOException, InterruptedException {
         List<TenantSetting> tenantSettings = tenantSettings();
-        if (tenantSettings == null) {
+        if (tenantSettings == null || tenantSettings.isEmpty()) {
             throw new CxException(1, "Unable to parse tenant settings");
         }
         return tenantSettings.stream()
@@ -526,6 +593,28 @@ public List<TenantSetting> tenantSettings() throws CxException, IOException, Int
         return Execution.executeCommand(withConfigArguments(arguments), logger, TenantSetting::listFromLine);
     }
 
+
+
+    public boolean getTenantSetting(String key) throws CxException, IOException, InterruptedException {
+        List<TenantSetting> tenantSettings = tenantSettings();
+        if (tenantSettings == null) {
+            throw new CxException(1, "Unable to parse tenant settings");
+        }
+        return tenantSettings.stream()
+                .filter(t -> t.getKey().equals(key))
+                .findFirst()
+                .map(t -> Boolean.parseBoolean(t.getValue()))
+                .orElse(false);
+    }
+    public boolean devAssistEnabled() throws CxException, IOException, InterruptedException {
+        return getTenantSetting(CxConstants.DEV_ASSIST_LICENSE_KEY);
+
+    }
+
+    public boolean oneAssistEnabled() throws CxException, IOException, InterruptedException {
+        return getTenantSetting(CxConstants.ONE_ASSIST_LICENSE_KEY);
+    }
+
     public MaskResult maskSecrets(@NonNull String filePath) throws CxException, IOException, InterruptedException {
         List<String> arguments = new ArrayList<>();
 
@@ -565,8 +654,6 @@ public String telemetryAIEvent(String aiProvider, String agent, String eventType
         arguments.add(CxConstants.SUB_CMD_TELEMETRY_AI);
         arguments.add(CxConstants.AI_PROVIDER);
         arguments.add(aiProvider);
-        arguments.add(CxConstants.AGENT);
-        arguments.add(agent);
         arguments.add(CxConstants.TYPE);
         arguments.add(eventType);
         arguments.add(CxConstants.SUB_TYPE);

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

@@ -1,5 +1,6 @@
 package com.checkmarx.ast.wrapper;
 
+import com.checkmarx.ast.kicsRealtimeResults.KicsRealtimeResults;
 import lombok.NonNull;
 import org.slf4j.Logger;
 
@@ -12,10 +13,7 @@
 import java.nio.file.Paths;
 import java.security.MessageDigest;
 import java.security.NoSuchAlgorithmException;
-import java.util.Arrays;
-import java.util.List;
-import java.util.Locale;
-import java.util.Objects;
+import java.util.*;
 import java.util.function.BiFunction;
 import java.util.function.Function;
 
@@ -171,7 +169,7 @@ private static String detectBinaryName(@NonNull Logger logger) {
         return fileName;
     }
 
-    private static String getOperatingSystemType(String osName) {
+    public static String getOperatingSystemType(String osName) {
         if (osName.contains(OS_LINUX)) {
             return OS_LINUX;
         } else if (osName.contains(OS_WINDOWS)) {
@@ -217,4 +215,6 @@ private static String md5(InputStream a) {
         }
         return md5;
     }
+
+
 }

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

@@ -25,7 +25,7 @@ void testScanShow() throws Exception {
 
     @Test
     void testScanAsca_WhenFileWithVulnerabilitiesIsSentWithAgent_ReturnSuccessfulResponseWithCorrectValues() throws Exception {
-        ScanResult scanResult = wrapper.ScanAsca("src/test/resources/python-vul-file.py", true, "vscode");
+        ScanResult scanResult = wrapper.ScanAsca("src/test/resources/python-vul-file.py", true, "vscode", null);
 
         // Assertions for the scan result
         Assertions.assertNotNull(scanResult.getRequestId(), "Request ID should not be null");
@@ -46,7 +46,7 @@ void testScanAsca_WhenFileWithVulnerabilitiesIsSentWithAgent_ReturnSuccessfulRes
 
     @Test
     void testScanAsca_WhenFileWithoutVulnerabilitiesIsSent_ReturnSuccessfulResponseWithCorrectValues() throws Exception {
-        ScanResult scanResult = wrapper.ScanAsca("src/test/resources/csharp-no-vul.cs", true, null);
+        ScanResult scanResult = wrapper.ScanAsca("src/test/resources/csharp-no-vul.cs", true, null, null);
         Assertions.assertNotNull(scanResult.getRequestId());
         Assertions.assertTrue(scanResult.isStatus());
         Assertions.assertNull(scanResult.getError());
@@ -55,12 +55,25 @@ void testScanAsca_WhenFileWithoutVulnerabilitiesIsSent_ReturnSuccessfulResponseW
 
     @Test
     void testScanAsca_WhenMissingFileExtension_ReturnFileExtensionIsRequiredFailure() throws Exception {
-        ScanResult scanResult = wrapper.ScanAsca("CODEOWNERS", true, null);
+        ScanResult scanResult = wrapper.ScanAsca("CODEOWNERS", true, null, null);
         Assertions.assertNotNull(scanResult.getRequestId());
         Assertions.assertNotNull(scanResult.getError());
         Assertions.assertEquals("The file name must have an extension.", scanResult.getError().getDescription());
     }
 
+    @Test
+    void testScanAsca_WithIgnoreFilePath_ShouldWorkCorrectly() throws Exception {
+        String ignoreFile = "src/test/resources/ignored-packages.json";
+
+        // Test with ignore file - should not break the scanning process
+        ScanResult scanResult = wrapper.ScanAsca("src/test/resources/python-vul-file.py", true, "test-agent", ignoreFile);
+
+        // Verify the scan completes successfully
+        Assertions.assertNotNull(scanResult.getRequestId(), "Request ID should not be null");
+        Assertions.assertTrue(scanResult.isStatus(), "Status should be true");
+        Assertions.assertNull(scanResult.getError(), "Error should be null when scan is successful");
+    }
+
     @Test
     void testScanList() throws Exception {
         List<Scan> cxOutput = wrapper.scanList("limit=10");

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

@@ -24,4 +24,14 @@ void testAiMcpServerEnabled() throws Exception {
         boolean enabled = Assertions.assertDoesNotThrow(() -> wrapper.aiMcpServerEnabled());
         Assertions.assertTrue(enabled, "AI MCP Server flag expected to be true");
     }
+
+    @Test
+    void testDevAssistEnabled() {
+        Assertions.assertDoesNotThrow(() -> wrapper.devAssistEnabled());
+    }
+
+    @Test
+    void testOneAssistEnabled() {
+        Assertions.assertDoesNotThrow(() -> wrapper.oneAssistEnabled());
+    }
 }