Change default values and option data types

Author: oshando

swan-pipeline/src/main/java/de/fraunhofer/iem/swan/cli/CliRunner.java

@@ -2,14 +2,13 @@
 
 import picocli.CommandLine;
 
-import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.Callable;
 
 @CommandLine.Command(name = "SWAN CLI", mixinStandardHelpOptions = true,
         version = "SWAN 3.0.1", description = "")
-public
-class CliRunner implements Callable<Integer> {
+public class CliRunner implements Callable<Integer> {
 
     @CommandLine.Option(names = {"-test", "--test-data"}, description = {"Path of test JARs or class files"})
     private String testDataDir = "/input/test-data";
@@ -23,19 +22,19 @@ class CliRunner implements Callable<Integer> {
     @CommandLine.Option(names = {"-o", "--output"}, description = {"Directory to save output files"})
     private String outputDir = "/swan-output";
 
-    @CommandLine.Option(names = {"-f", "--feature"}, description = {"Feature set: 0 - SWAN; 1 - SWANDOC-AUTO; 2 - SWANDOC-MANUAL; 3 - SWAN-SWANDOC-MANUAL; 4 - SWAN-SWANDOC-AUTO"})
-    private String featureSet = "0";
+    @CommandLine.Option(names = {"-f", "--feature"}, description = {"Select one or more feature sets: all, code, doc-auto or doc-manual"})
+    private List<String> featureSet =  Collections.singletonList("code");
 
     @CommandLine.Option(names = {"-l", "--learning"}, description = {"Learning modes: manual, auto"})
     private String learningMode = "manual";
 
-    @CommandLine.Option(names = {"-s", "--srm"}, description = {"SRM: all, source, sink, sanitizer, authentication"})
-    private List<String> srmClasses = Arrays.asList("all");
+    @CommandLine.Option(names = {"-s", "--srm"}, description = {"SRM: all, source, sink, sanitizer, authentication, relevant"})
+    private List<String> srmClasses = Collections.singletonList("all");
 
     @CommandLine.Option(names = {"-c", "--cwe"}, description = {"CWE: all, cwe078, cwe079, cwe089, cwe306, cwe601, cwe862, cwe863"})
-    private List<String> cweClasses = Arrays.asList("all");
+    private List<String> cweClasses = Collections.singletonList("all");
 
-    @CommandLine.Option(names = {"-", "--arff-data"}, description = {"Export training ARFF files"})
+    @CommandLine.Option(names = {"-arff", "--arff-data"}, description = {"Export training ARFF files"})
     private boolean exportArffData = true;
 
     @CommandLine.Option(names = {"-doc", "--documented"}, description = {"Use only methods with Javadoc"})

swan-pipeline/src/main/java/de/fraunhofer/iem/swan/cli/SwanCli.java

@@ -22,12 +22,12 @@ public Integer run(SwanOptions options) throws Exception {
             options.setDatasetJson(fileUtility.getResourceFile(options.getDatasetJson()).getAbsolutePath());
         }
 
-        if (options.getTrainData().contentEquals("/input/train-data")) {
-            options.setTrainData(fileUtility.getResourceDirectory("/input/train-data").getAbsolutePath());
+        if (options.getTrainDataDir().contentEquals("/input/train-data")) {
+            options.setTrainDataDir(fileUtility.getResourceDirectory("/input/train-data").getAbsolutePath());
         }
 
-        if (options.getTestData().contentEquals("/input/test-data")) {
-            options.setTestData(fileUtility.getResourceDirectory("/input/test-data").getAbsolutePath());
+        if (options.getTestDataDir().contentEquals("/input/test-data")) {
+            options.setTestDataDir(fileUtility.getResourceDirectory("/input/test-data").getAbsolutePath());
         }
 
         if(options.getSrmClasses().contains("all")){
@@ -38,6 +38,10 @@ public Integer run(SwanOptions options) throws Exception {
             options.setCweClasses(Arrays.asList("cwe078", "cwe079", "cwe089", "cwe306", "cwe601", "cwe862", "cwe863"));
         }
 
+        if(options.getFeatureSet().contains("all")){
+            options.setFeatureSet(Arrays.asList("code", "doc-manual", "doc-auto"));
+        }
+
         logger.info("SWAN options: {}", options);
 
         try {

swan-pipeline/src/main/java/de/fraunhofer/iem/swan/cli/SwanOptions.java

@@ -7,11 +7,11 @@
  */
 public class SwanOptions {
 
-    private String testData;
-    private String trainData;
+    private String testDataDir;
+    private String trainDataDir;
     private String datasetJson;
     private String outputDir;
-    private String featureSet;
+    private List<String> featureSet;
     private String learningMode;
     private List<String> srmClasses;
     private List<String> cweClasses;
@@ -20,10 +20,11 @@ public class SwanOptions {
     private int iterations;
     private double trainTestSplit;
 
-    public SwanOptions(String testData, String trainData, String datasetJson, String outputDir, String featureSet,
-                       String learningMode, List<String> srmClasses, List<String> cweClasses, boolean exportArffData) {
-        this.testData = testData;
-        this.trainData = trainData;
+    public SwanOptions(String testDataDir, String trainDataDir, String datasetJson, String outputDir,
+                       List<String> featureSet, String learningMode, List<String> srmClasses, List<String> cweClasses,
+                       boolean exportArffData, boolean isDocumented, int iterations, double trainTestSplit) {
+        this.testDataDir = testDataDir;
+        this.trainDataDir = trainDataDir;
         this.datasetJson = datasetJson;
         this.outputDir = outputDir;
         this.featureSet = featureSet;
@@ -36,20 +37,20 @@ public SwanOptions(String testData, String trainData, String datasetJson, String
         this.trainTestSplit = trainTestSplit;
     }
 
-    public String getTestData() {
-        return testData;
+    public String getTestDataDir() {
+        return testDataDir;
     }
 
-    public void setTestData(String testData) {
-        this.testData = testData;
+    public void setTestDataDir(String testDataDir) {
+        this.testDataDir = testDataDir;
     }
 
-    public String getTrainData() {
-        return trainData;
+    public String getTrainDataDir() {
+        return trainDataDir;
     }
 
-    public void setTrainData(String trainData) {
-        this.trainData = trainData;
+    public void setTrainDataDir(String trainDataDir) {
+        this.trainDataDir = trainDataDir;
     }
 
     public String getDatasetJson() {
@@ -68,11 +69,11 @@ public void setOutputDir(String outputDir) {
         this.outputDir = outputDir;
     }
 
-    public String getFeatureSet() {
+    public List<String> getFeatureSet() {
         return featureSet;
     }
 
-    public void setFeatureSet(String featureSet) {
+    public void setFeatureSet(List<String> featureSet) {
         this.featureSet = featureSet;
     }
 
@@ -135,8 +136,8 @@ public void setTrainTestSplit(double trainTestSplit) {
     @Override
     public String toString() {
         return "SwanOptions{" +
-                "testData='" + testData + '\'' +
-                ", trainData='" + trainData + '\'' +
+                "testData='" + testDataDir + '\'' +
+                ", trainData='" + trainDataDir + '\'' +
                 ", datasetJson='" + datasetJson + '\'' +
                 ", outputDir='" + outputDir + '\'' +
                 ", featureSet='" + featureSet + '\'' +