Add run SecuCheck action, notifier and background task

Author: oshando

swan-assist/src/main/java/de/fraunhofer/iem/swan/assist/actions/RunSecucheckAction.java

@@ -0,0 +1,26 @@
+package de.fraunhofer.iem.swan.assist.actions;
+
+import com.intellij.openapi.actionSystem.AnAction;
+import com.intellij.openapi.actionSystem.AnActionEvent;
+import com.intellij.openapi.actionSystem.CommonDataKeys;
+import com.intellij.openapi.progress.PerformInBackgroundOption;
+import com.intellij.openapi.progress.ProgressManager;
+import com.intellij.openapi.project.Project;
+import de.fraunhofer.iem.swan.assist.analysis.SecucheckBackgroundTask;
+import de.fraunhofer.iem.swan.assist.comm.SecucheckNotifier;
+import org.jetbrains.annotations.NotNull;
+
+public class RunSecucheckAction extends AnAction {
+
+    @Override
+    public void actionPerformed(@NotNull AnActionEvent e) {
+        final Project project = e.getRequiredData(CommonDataKeys.PROJECT);
+
+        ProgressManager.getInstance().run(new SecucheckBackgroundTask(project, "Running Taint Analysis with SecuCheck", true,
+                PerformInBackgroundOption.ALWAYS_BACKGROUND));
+
+        SecucheckNotifier publisher = project.getMessageBus().syncPublisher(SecucheckNotifier.START_SECUCHECK_PROCESS_TOPIC);
+        publisher.launchSecuCheck();
+
+    }
+}

swan-assist/src/main/java/de/fraunhofer/iem/swan/assist/analysis/SecucheckBackgroundTask.java

@@ -0,0 +1,68 @@
+package de.fraunhofer.iem.swan.assist.analysis;
+
+import com.intellij.openapi.progress.PerformInBackgroundOption;
+import com.intellij.openapi.progress.ProgressIndicator;
+import com.intellij.openapi.progress.Task;
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.util.NlsContexts;
+import com.intellij.util.messages.MessageBus;
+import de.fraunhofer.iem.swan.assist.comm.SecucheckNotifier;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;
+import java.util.HashMap;
+import java.util.concurrent.TimeUnit;
+
+public class SecucheckBackgroundTask extends Task.Backgroundable {
+
+    private Project project;
+    private HashMap<String, String> parameters;
+    private long duration;
+
+    public SecucheckBackgroundTask(@Nullable Project project, @NlsContexts.ProgressTitle @NotNull String title, boolean canBeCancelled, @Nullable PerformInBackgroundOption backgroundOption) {
+        super(project, title, canBeCancelled, backgroundOption);
+        this.project = project;
+    }
+
+    @Override
+    public void run(@NotNull ProgressIndicator indicator) {
+
+        long start = System.currentTimeMillis();
+
+        //TODO add implementation to run SecuCheck
+        indicator.setText("Generating fluentTQL Specifications");
+
+        indicator.setText("Configuring SecuCheck");
+
+        try {
+            TimeUnit.SECONDS.sleep(2);
+        } catch (InterruptedException e) {
+            throw new RuntimeException(e);
+        }
+        indicator.setText("Configuring analysis");
+
+        try {
+            TimeUnit.SECONDS.sleep(2);
+        } catch (InterruptedException e) {
+            throw new RuntimeException(e);
+        }
+        indicator.setText("Exporting analysis results");
+
+        MessageBus messageBus = project.getMessageBus();
+        SecucheckNotifier publisher = messageBus.syncPublisher(SecucheckNotifier.END_SECUCHECK_PROCESS_TOPIC);
+        publisher.launchSecuCheck();
+    }
+
+    /**
+     * Get the timestamp in a specified format.
+     *
+     * @return Formatted date
+     */
+    private String getCurrentTimestamp() {
+
+        DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd-HHmmss");
+        return LocalDateTime.now().format(formatter);
+    }
+}

swan-assist/src/main/java/de/fraunhofer/iem/swan/assist/comm/SecucheckNotifier.java

@@ -0,0 +1,26 @@
+/*******************************************************************************
+ * Copyright (c) 2018 Fraunhofer IEM, Paderborn, Germany.
+ *
+ * Contributors:
+ * Oshando Johnson (oshando.johnson@iem.fraunhofer.de ) - initial implementation
+ ******************************************************************************/
+
+package de.fraunhofer.iem.swan.assist.comm;
+
+import com.intellij.util.messages.Topic;
+
+import java.util.HashMap;
+
+/**
+ * Provides notifications about SWAN.
+ */
+public interface SecucheckNotifier {
+
+    Topic<SecucheckNotifier> START_SECUCHECK_PROCESS_TOPIC = Topic.create("Start SecuCheck", SecucheckNotifier.class);
+    Topic<SecucheckNotifier> END_SECUCHECK_PROCESS_TOPIC = Topic.create("Stop SecuCheck", SecucheckNotifier.class);
+
+    /**
+     * Provides settings used to start SWAN or to access program logs/reports.
+     */
+    void launchSecuCheck();
+}

swan-assist/src/main/java/de/fraunhofer/iem/swan/assist/ui/MethodListTree.java

@@ -385,6 +385,17 @@ public void launchSwan(HashMap<String, String> values) {
             }
         });
 
+        //Update notification button when SWAN completes running
+        bus.connect().subscribe(SecucheckNotifier.END_SECUCHECK_PROCESS_TOPIC, new SecucheckNotifier() {
+            @Override
+            public void launchSecuCheck() {
+                Notification analysisCompleted = TOOL_GROUP.createNotification("",
+                        "SecuCheck results exported to "+PropertiesComponent.getInstance(project).getValue(Constants.OUTPUT_DIRECTORY),
+                        NotificationType.INFORMATION);
+                Notifications.Bus.notify(analysisCompleted, project);
+            }
+        });
+
         //Notify user that Suggest method process started or that the methods were generated
         bus.connect().subscribe(SuggestNotifier.SUGGEST_METHOD_TOPIC, new SuggestNotifier() {
 

swan-assist/src/main/java/de/fraunhofer/iem/swan/assist/util/Constants.java

@@ -26,6 +26,7 @@ public class Constants {
     public final static String TRAIN_DIRECTORY = PLUGIN_ID + "trainingPath";
     public final static String SOURCE_DIRECTORY = PLUGIN_ID + "projectJarFiles"; //Test Library (or the project)
     public final static String CONFIGURATION_FILE = PLUGIN_ID + "configurationFile";
+    public final static String LAST_SRM_LIST = PLUGIN_ID + "lastSrmList";
     public final static String SWAN_SETTINGS = PLUGIN_ID + "projectConfigured";
     public final static String OUTPUT_DIRECTORY = PLUGIN_ID + "outputPath";
     public final static String OUTPUT_FILE = PLUGIN_ID + "outputFile";

swan-assist/src/main/resources/META-INF/plugin.xml

@@ -28,7 +28,7 @@
         <group id="SWAN_Assist.ActionBar" text="SWAN_Assist" popup="false" >
 
             <action id="SWAN_Assist.LaunchSWANAction"
-                    class="de.fraunhofer.iem.swan.assist.actions.RunSwanAnalysisAction"
+                    class="de.fraunhofer.iem.swan.assist.actions.RunSwanAction"
                     icon="AllIcons.Toolwindows.ToolWindowRun"
                     text="Run Analysis">
             </action>
@@ -49,19 +49,9 @@
             </action>
             <separator/>
 
-            <separator/>
-            <action id="SWAN_Assist.ImportAction" class="de.fraunhofer.iem.swan.assist.actions.ImportAction"
-                    text="Import File"
-                    icon="PluginIcons.IMPORT_ACTION"
-                    description="Import configuration file">
-                    icon="AllIcons.ToolbarDecorator.Export"
-            </action>
-
-            <action id="SWAN_Assist.ExportAction"
-                    class="de.fraunhofer.iem.swan.assist.actions.ExportAction"
-                    icon="PluginIcons.EXPORT_ACTION"
-                    text="Export File"
-                    description="Export configuration file">
+            <action id="SWAN_Assist.RunSecuCheck"
+                   class="de.fraunhofer.iem.swan.assist.actions.RunSecucheckAction"
+                   text="Run Taint Analysis"
                    popup="true" icon="AllIcons.Actions.RunAll">
             </action>