Updates to java wrapper (#2)

* Added exception for null CxScanConfig object , formatted the code

Author: jay-nanduri

.github/workflows/main.yml

@@ -0,0 +1,35 @@
+
+name: Integration Tests
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request:
+    types: [opened, reopened, synchronize] 
+    branches:
+      - master
+      - main   
+
+jobs:
+  run_tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v2
+      - name: Set up JDK 11
+        uses: actions/setup-java@v1
+        with:
+          java-version: 11
+      - name: Copy executable
+        run: cp ./src/main/resources/cx-exe /tmp/
+      - name: Permissions to executable
+        run: sudo chmod 777 /tmp/cx-exe
+      - name: Run tests with Maven
+        env:
+          CX_CLIENT_ID: ${{ secrets.CLIENT_ID}}
+          CX_CLIENT_SECRET: ${{ secrets.CLIENT_SECRET}}
+          CX_BASE_URI	: ${{ secrets.BASE_URI }}
+          PATH_TO_EXECUTABLE: /tmp/cx-exe
+        run: mvn -B test --file pom.xml

.github/workflows/maven-publish.yml

@@ -5,7 +5,7 @@ name: Maven Package
 
 on:
   release:
-    types: [created]
+    types: [created] 
 
 jobs:
   build:
@@ -17,15 +17,23 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up JDK 8
+    - name: Set up JDK 11
       uses: actions/setup-java@v2
       with:
-        java-version: '8'
+        java-version: '11'
         distribution: 'adopt'
         server-id: github # Value of the distributionManagement/repository/id field of the pom.xml
         settings-path: ${{ github.workspace }} # location for the settings.xml file
-
+    - name: Copy executable
+      run: cp ./src/main/resources/cx-exe /tmp/
+    - name: Permissions to executable
+      run: sudo chmod 777 /tmp/cx-exe
     - name: Build with Maven
+      env:
+          CX_CLIENT_ID: ${{ secrets.CLIENT_ID}}
+          CX_CLIENT_SECRET: ${{ secrets.CLIENT_SECRET}}
+          CX_BASE_URI	: ${{ secrets.BASE_URI }}
+          PATH_TO_EXECUTABLE: /tmp/cx-exe
       run: mvn -B package --file pom.xml
 
     - name: Publish to GitHub Packages Apache Maven

pom.xml

@@ -4,7 +4,7 @@
 
   <groupId>com.checkmarx.ast</groupId>
   <artifactId>ast-cli-java-wrapper</artifactId>
-  <version>1.0.0</version>
+  <version>1.0.1</version>
   <packaging>jar</packaging>
 
   <dependencies>
@@ -56,6 +56,12 @@
           <version>RELEASE</version>
           <scope>test</scope>
       </dependency>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.13.1</version>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <build>
@@ -92,14 +98,10 @@
       <name>CheckmarxDev</name>
       <url>https://maven.pkg.github.com/CheckmarxDev/ast-cli-java-wrapper</url>
     </repository>
-    <repository>
-      <id>ossrh</id>
-      <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
-    </repository>
   </distributionManagement>
     <properties>
-        <maven.compiler.source>8</maven.compiler.source>
-        <maven.compiler.target>8</maven.compiler.target>
+        <maven.compiler.source>11</maven.compiler.source>
+        <maven.compiler.target>11</maven.compiler.target>
     </properties>
   <developers>
     <developer>

src/main/java/com/checkmarx/ast/CheckmarxExeception.java

@@ -0,0 +1,7 @@
+package com.checkmarx.ast;
+
+public class CheckmarxExeception extends RuntimeException{
+    public  CheckmarxExeception(String errorMessage) {
+        super(errorMessage);
+    }
+}

src/main/java/com/checkmarx/ast/CxAuth.java

@@ -22,43 +22,37 @@
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipFile;
 
-
 public class CxAuth {
     private Logger log = LoggerFactory.getLogger(CxAuth.class.getName());
     private String baseuri;
     private String key;
     private String secret;
-    private String token;
-    private  URI executable = null;
+    private String apikey;
+    private URI executable = null;
     private static final Gson gson = new Gson();
 
-    public CxAuth(CxScanConfig scanConfig, Logger log) throws InterruptedException, IOException, URISyntaxException {
-        if(scanConfig != null) {
-            this.baseuri = scanConfig.getBaseuri();
-            if(scanConfig.getKey() != null && scanConfig.getSecret() != null) {
-                this.key = scanConfig.getKey();
-                this.secret = scanConfig.getSecret();
-            }
-            else if (scanConfig.getToken() != null) {
-                this.token = scanConfig.getToken();
-            }
-            else {
-                log.info("Did not receive Key/Secret/Token");
-            }
-            if(scanConfig.getPathToExecutable() != null && !scanConfig.getPathToExecutable().isEmpty()) {
-                File file = new File(scanConfig.getPathToExecutable());
-                this.executable = file.toURI();
-            }
-            else {
-                this.executable = packageExecutable();
-            }
+    public CxAuth(CxScanConfig scanConfig, Logger log)
+            throws InterruptedException, IOException, URISyntaxException, CxExeception {
+        if (scanConfig == null) throw new CxExeception("CxScanConfig object returned as null!");   
+        this.baseuri = scanConfig.getBaseuri();
+        if (scanConfig.getClientId() != null && scanConfig.getClientSecret() != null) {
+            this.key = scanConfig.getClientId();
+            this.secret = scanConfig.getClientSecret();
+        } else if (scanConfig.getApikey() != null) {
+            this.apikey = scanConfig.getApikey();
+        }
+        if (scanConfig.getPathToExecutable() != null && !scanConfig.getPathToExecutable().isEmpty()) {
+            File file = new File(scanConfig.getPathToExecutable());
+            this.executable = file.toURI();
+        } else {
+            this.executable = packageExecutable();
         }
-        if(log != null) {
+
+        if (log != null) {
             this.log = log;
         }
     }
 
-
     private URI packageExecutable() throws IOException, URISyntaxException {
         String osName = System.getProperty("os.name");
 
@@ -89,8 +83,7 @@ private URI getJarURI() throws URISyntaxException {
         return (uri);
     }
 
-    private URI getFile( URI jarLocation, final String fileName)
-            throws IOException {
+    private URI getFile(URI jarLocation, final String fileName) throws IOException {
         final File location;
         final URI fileURI;
         location = new File(jarLocation);
@@ -113,20 +106,18 @@ private URI getFile( URI jarLocation, final String fileName)
         return (fileURI);
     }
 
-    private static URI extract(final ZipFile zipFile, final String fileName)
-            throws IOException {
+    private static URI extract(final ZipFile zipFile, final String fileName) throws IOException {
         final File tempFile;
         final ZipEntry entry;
         final InputStream zipStream;
         OutputStream fileStream;
 
-        tempFile = File.createTempFile(fileName," ");
+        tempFile = File.createTempFile(fileName, " ");
         tempFile.deleteOnExit();
         entry = zipFile.getEntry(fileName);
 
         if (entry == null) {
-            throw new FileNotFoundException("cannot find file: " + fileName
-                    + " in archive: " + zipFile.getName());
+            throw new FileNotFoundException("cannot find file: " + fileName + " in archive: " + zipFile.getName());
         }
 
         zipStream = zipFile.getInputStream(entry);
@@ -162,13 +153,13 @@ private static void close(final Closeable stream) {
     }
 
     public CxScan cxScanShow(String id) throws IOException, InterruptedException {
-        log.info("Initialized scan retrieval for id: " +  id);
+        log.info("Initialized scan retrieval for id: " + id);
         List<String> commands = initialCommands();
         commands.add("scan");
         commands.add("show");
         commands.add(id);
         CxScan scanObject = runExecutionCommands(commands);
-        if(scanObject != null)
+        if (scanObject != null)
             log.info("Scan retrieved");
         else
             log.info("Did not receive the scan");
@@ -183,14 +174,14 @@ private CxScan runExecutionCommands(List<String> commands) throws IOException, I
         CxScan scanObject = null;
         while ((line = br.readLine()) != null) {
             log.info(line);
-            if(isJSONValid(line,CxScan.class))
+            if (isJSONValid(line, CxScan.class))
                 scanObject = transformToCxScanObject(line);
         }
         log.info("Process returned from the executor");
         return scanObject;
     }
 
-    private CxScan transformToCxScanObject(String line)  {
+    private CxScan transformToCxScanObject(String line) {
         ObjectMapper objectMapper = new ObjectMapper();
         CxScan scanObject;
         try {
@@ -224,11 +215,11 @@ public List<CxScan> cxAstScanList() throws IOException, InterruptedException {
         String line;
         List<CxScan> list = new ArrayList<>();
         while ((line = br.readLine()) != null) {
-            if(isJSONValid(line,List.class) && !line.isEmpty())
+            if (isJSONValid(line, List.class) && !line.isEmpty())
                 list = transformToCxScanList(line);
         }
         br.close();
-        if(list != null && !list.isEmpty())
+        if (list != null && !list.isEmpty())
             log.info("Retrieved scan list with size: " + list.size());
         else
             log.info("Not able to retrieve scan list");
@@ -242,22 +233,20 @@ public CxScan cxScanCreate(Map<CxParamType, String> params) throws IOException,
         commands.add("create");
 
         for (Map.Entry<CxParamType, String> param : params.entrySet()) {
-            if(param.getKey() == CxParamType.ADDITIONAL_PARAMETERS && param.getValue() != null){
+            if (param.getKey() == CxParamType.ADDITIONAL_PARAMETERS && param.getValue() != null) {
                 addIndividualParams(commands, param.getValue());
-            }
-            else if(param.getKey().toString().length() == 1 ) {
+            } else if (param.getKey().toString().length() == 1) {
                 commands.add("-" + param.getKey().toString().toLowerCase());
-                if(param.getValue() != null)
+                if (param.getValue() != null)
                     commands.add(param.getValue());
                 else
                     commands.add(" ");
 
-            }
-            else if(param.getKey() != CxParamType.ADDITIONAL_PARAMETERS) {
+            } else if (param.getKey() != CxParamType.ADDITIONAL_PARAMETERS) {
                 String paramValue = param.getKey().toString();
-                paramValue = "--" + paramValue.replace("_","-").toLowerCase();
+                paramValue = "--" + paramValue.replace("_", "-").toLowerCase();
                 commands.add(paramValue);
-                if(param.getValue() != null)
+                if (param.getValue() != null)
                     commands.add(param.getValue());
                 else
                     commands.add(" ");
@@ -270,22 +259,20 @@ else if(param.getKey() != CxParamType.ADDITIONAL_PARAMETERS) {
 
     private void addIndividualParams(List<String> commands, String value) {
         Matcher m = Pattern.compile("([^\"]\\S*|\".+?\")\\s*").matcher(value);
-        while(m.find())
+        while (m.find())
             commands.add(m.group(1));
     }
 
     private void addAuthCredentials(List<String> commands) {
-        if(key != null && secret != null) {
+        if (key != null && secret != null) {
             commands.add("--client-id");
             commands.add(key);
-            commands.add("--secret");
+            commands.add("--client-secret");
             commands.add(secret);
-        }
-        else if(token != null) {
-            commands.add("--token");
-            commands.add(token);
-        }
-        else {
+        } else if (apikey != null) {
+            commands.add("--apikey");
+            commands.add(apikey);
+        } else {
             log.info("KEY/SECRET/TOKEN not received");
         }
     }
@@ -296,23 +283,20 @@ private List<CxScan> transformToCxScanList(String line) throws IOException {
         try {
             scanList = objectMapper.readValue(line, new TypeReference<List<CxScan>>() {
             });
-        }
-        catch(JsonProcessingException e) {
+        } catch (JsonProcessingException e) {
             return null;
         }
         return scanList;
 
     }
 
-    private boolean isJSONValid(String jsonInString , Object object) {
+    private boolean isJSONValid(String jsonInString, Object object) {
         try {
             gson.fromJson(jsonInString, (Type) object);
             return true;
-        } catch(com.google.gson.JsonSyntaxException ex) {
+        } catch (com.google.gson.JsonSyntaxException ex) {
             return false;
         }
     }
 
 }
-
-

src/main/java/com/checkmarx/ast/CxAuthType.java

@@ -1,9 +1,6 @@
 package com.checkmarx.ast;
 
 public enum CxAuthType {
-	TOKEN,
-	KEYSECRET,
-	ENVIRONMENT
-	
-}
+	TOKEN, KEYSECRET, ENVIRONMENT
 
+}

src/main/java/com/checkmarx/ast/CxExeception.java

@@ -0,0 +1,7 @@
+package com.checkmarx.ast;
+
+public class CxExeception extends RuntimeException{
+    public  CxExeception(String errorMessage) {
+        super(errorMessage);
+    }
+}

src/main/java/com/checkmarx/ast/CxParamType.java

@@ -1,15 +1,5 @@
 package com.checkmarx.ast;
 
 public enum CxParamType {
-    S,
-    V,
-    G,
-    D,
-    PROJECT_NAME,
-    SCAN_TYPES,
-    PRESET_NAME,
-    FILTER,
-    DIRECTORY,
-    ADDITIONAL_PARAMETERS,
-    AGENT
+    S, V, G, D, PROJECT_NAME, SCAN_TYPES, SAST_PRESET_NAME, FILTER, DIRECTORY, ADDITIONAL_PARAMETERS, AGENT
 }