Merge remote-tracking branch 'origin/refactor-for-testing'

Author: anetz02

.github/workflows/build.yml

@@ -3,6 +3,7 @@ name: build
 on:
   push:
   pull_request:
+  workflow_dispatch:
 
 jobs:
   build:

pom.xml

@@ -117,6 +117,20 @@
             <scope>compile</scope>
         </dependency>
 
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-engine</artifactId>
+            <version>5.9.2</version>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <version>5.8.0</version>
+            <scope>test</scope>
+        </dependency>
+
     </dependencies>
     <properties>
         <maven.compiler.source>17</maven.compiler.source>
@@ -160,6 +174,12 @@
                     </execution>
                 </executions>
             </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>3.2.5</version>
+            </plugin>
         </plugins>
     </build>
 </project>

src/main/java/Main.java

@@ -6,6 +6,7 @@
 import api.GoblintService;
 import api.GoblintServiceLauncher;
 import api.messages.params.Params;
+import goblintserver.GoblintConfWatcher;
 import goblintserver.GoblintServer;
 import gobpie.GobPieConfReader;
 import gobpie.GobPieConfiguration;
@@ -17,7 +18,10 @@
 import org.eclipse.lsp4j.MessageParams;
 import org.eclipse.lsp4j.MessageType;
 import org.eclipse.lsp4j.jsonrpc.messages.Either;
+import util.FileWatcher;
+
 import java.io.File;
+import java.nio.file.Path;
 
 public class Main {
 
@@ -40,8 +44,11 @@ public static void main(String... args) {
             // Connect GoblintService and read configuration
             GoblintService goblintService = connectGoblintService(magpieServer, gobpieConfiguration, goblintServer);
 
+            // Create file watcher for Goblint configuration
+            GoblintConfWatcher goblintConfWatcher = getGoblintConfWatcher(magpieServer, goblintService, gobpieConfiguration);
+
             // Add analysis
-            addAnalysis(magpieServer, gobpieConfiguration, goblintServer, goblintService);
+            addAnalysis(magpieServer, gobpieConfiguration, goblintServer, goblintService, goblintConfWatcher);
 
             // Launch magpieServer
             magpieServer.configurationDone();
@@ -123,19 +130,24 @@ private static GoblintService connectGoblintService(MagpieServer magpieServer, G
         return goblintService;
     }
 
+    private static GoblintConfWatcher getGoblintConfWatcher(GoblintMagpieServer magpieServer, GoblintService goblintService, GobPieConfiguration gobpieConfiguration) {
+        FileWatcher fileWatcher = new FileWatcher(Path.of(gobpieConfiguration.getGoblintConf()));
+        return new GoblintConfWatcher(magpieServer, goblintService, gobpieConfiguration, fileWatcher);
+    }
+
 
     /**
      * Method for creating and adding Goblint analysis to MagpieBridge server.
      * <p>
      * Creates the GoblintAnalysis classes.
      */
     private static void addAnalysis(MagpieServer magpieServer, GobPieConfiguration gobpieConfiguration,
-                                    GoblintServer goblintServer, GoblintService goblintService) {
+                                    GoblintServer goblintServer, GoblintService goblintService, GoblintConfWatcher goblintConfWatcher) {
         // define language
         String language = "c";
 
         // add analysis to the MagpieServer
-        ServerAnalysis serverAnalysis = new GoblintAnalysis(magpieServer, goblintServer, goblintService, gobpieConfiguration);
+        ServerAnalysis serverAnalysis = new GoblintAnalysis(magpieServer, goblintServer, goblintService, gobpieConfiguration, goblintConfWatcher);
         magpieServer.addAnalysis(Either.forLeft(serverAnalysis), language);
 
         // add HTTP server for showing CFGs, only if the option is specified in the configuration

src/main/java/analysis/GoblintAnalysis.java

@@ -5,6 +5,7 @@
 import api.messages.params.AnalyzeParams;
 import api.messages.params.Params;
 import com.ibm.wala.classLoader.Module;
+import goblintserver.GoblintConfWatcher;
 import goblintserver.GoblintServer;
 import gobpie.GobPieConfiguration;
 import gobpie.GobPieException;
@@ -20,12 +21,9 @@
 import org.zeroturnaround.exec.InvalidExitValueException;
 import org.zeroturnaround.exec.ProcessExecutor;
 import org.zeroturnaround.exec.ProcessResult;
-import org.zeroturnaround.process.UnixProcess;
-import util.FileWatcher;
 
 import java.io.File;
 import java.io.IOException;
-import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
@@ -51,26 +49,22 @@
 
 public class GoblintAnalysis implements ServerAnalysis {
 
-    private final static int SIGINT = 2;
-
     private final MagpieServer magpieServer;
     private final GoblintServer goblintServer;
     private final GoblintService goblintService;
     private final GobPieConfiguration gobpieConfiguration;
-    private final FileWatcher goblintConfWatcher;
-
-    private static boolean configValid = false;
+    private final GoblintConfWatcher goblintConfWatcher;
     private static Future<?> lastAnalysisTask = null;
 
     private final Logger log = LogManager.getLogger(GoblintAnalysis.class);
 
 
-    public GoblintAnalysis(MagpieServer magpieServer, GoblintServer goblintServer, GoblintService goblintService, GobPieConfiguration gobpieConfiguration) {
+    public GoblintAnalysis(MagpieServer magpieServer, GoblintServer goblintServer, GoblintService goblintService, GobPieConfiguration gobpieConfiguration, GoblintConfWatcher goblintConfWatcher) {
         this.magpieServer = magpieServer;
         this.goblintServer = goblintServer;
         this.goblintService = goblintService;
         this.gobpieConfiguration = gobpieConfiguration;
-        this.goblintConfWatcher = new FileWatcher(Path.of(gobpieConfiguration.getGoblintConf()));
+        this.goblintConfWatcher = goblintConfWatcher;
     }
 
 
@@ -100,7 +94,7 @@ public void analyze(Collection<? extends Module> files, AnalysisConsumer consume
             return;
         }
 
-        if (!goblintServer.getGoblintRunProcess().getProcess().isAlive()) {
+        if (!goblintServer.isAlive()) {
             // Goblint server has crashed. Exit GobPie because without the server no analysis is possible.
             magpieServer.exit();
             return;
@@ -109,16 +103,14 @@ public void analyze(Collection<? extends Module> files, AnalysisConsumer consume
         if (lastAnalysisTask != null && !lastAnalysisTask.isDone()) {
             lastAnalysisTask.cancel(true);
             try {
-                abortAnalysis();
+                goblintServer.abortAnalysis();
                 log.info("--------------- This analysis has been aborted -------------");
             } catch (IOException e) {
                 log.error("Aborting analysis failed.");
             }
         }
 
-        refreshGoblintConfig();
-
-        if (!configValid) {
+        if (!goblintConfWatcher.refreshGoblintConfig()) {
             return;
         }
 
@@ -144,40 +136,6 @@ public void analyze(Collection<? extends Module> files, AnalysisConsumer consume
     }
 
 
-    /**
-     * Aborts the previous running analysis by sending a SIGINT signal to Goblint.
-     */
-    private void abortAnalysis() throws IOException {
-        Process goblintProcess = goblintServer.getGoblintRunProcess().getProcess();
-        int pid = Math.toIntExact(goblintProcess.pid());
-        UnixProcess unixProcess = new UnixProcess(pid);
-        unixProcess.kill(SIGINT);
-    }
-
-
-    /**
-     * Reloads Goblint config if it has been changed or is currently invalid.
-     */
-    private void refreshGoblintConfig() {
-        if (goblintConfWatcher.checkModified() || !configValid) {
-            configValid = goblintService.reset_config()
-                    .thenCompose(_res ->
-                            goblintService.read_config(new Params(new File(gobpieConfiguration.getGoblintConf()).getAbsolutePath())))
-                    .handle((_res, ex) -> {
-                        if (ex != null) {
-                            Throwable cause = ex instanceof CompletionException ? ex.getCause() : ex;
-                            String msg = "Goblint was unable to successfully read the new configuration: " + cause.getMessage();
-                            magpieServer.forwardMessageToClient(new MessageParams(MessageType.Error, msg));
-                            log.error(msg);
-                            return false;
-                        }
-                        return true;
-                    })
-                    .join();
-        }
-    }
-
-
     /**
      * The method that is triggered before each analysis.
      * <p>

src/main/java/api/messages/params/AnalyzeParams.java

@@ -1,5 +1,7 @@
 package api.messages.params;
 
+import java.util.Objects;
+
 public class AnalyzeParams {
 
     boolean reset;
@@ -8,4 +10,16 @@ public AnalyzeParams(boolean reset) {
         this.reset = reset;
     }
 
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        AnalyzeParams that = (AnalyzeParams) o;
+        return reset == that.reset;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(reset);
+    }
 }

src/main/java/goblintserver/GoblintConfWatcher.java

@@ -0,0 +1,57 @@
+package goblintserver;
+
+import api.GoblintService;
+import api.messages.params.Params;
+import gobpie.GobPieConfiguration;
+import magpiebridge.core.MagpieServer;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.eclipse.lsp4j.MessageParams;
+import org.eclipse.lsp4j.MessageType;
+import util.FileWatcher;
+
+import java.io.File;
+import java.nio.file.Path;
+import java.util.concurrent.CompletionException;
+
+public class GoblintConfWatcher {
+
+    private final FileWatcher fileWatcher;
+    private final MagpieServer magpieServer;
+    private final GoblintService goblintService;
+    private final GobPieConfiguration gobpieConfiguration;
+
+    public boolean configValid = false;
+
+    private final Logger log = LogManager.getLogger(GoblintConfWatcher.class);
+
+    public GoblintConfWatcher(MagpieServer magpieServer, GoblintService goblintService, GobPieConfiguration gobpieConfiguration, FileWatcher fileWatcher) {
+        this.magpieServer = magpieServer;
+        this.goblintService = goblintService;
+        this.gobpieConfiguration = gobpieConfiguration;
+        this.fileWatcher = fileWatcher;
+    }
+
+    /**
+     * Reloads Goblint config if it has been changed or is currently invalid.
+     */
+    public boolean refreshGoblintConfig() {
+        if (fileWatcher.checkModified() || !configValid) {
+            configValid = goblintService.reset_config()
+                    .thenCompose(_res ->
+                            goblintService.read_config(new Params(new File(gobpieConfiguration.getGoblintConf()).getAbsolutePath())))
+                    .handle((_res, ex) -> {
+                        if (ex != null) {
+                            Throwable cause = ex instanceof CompletionException ? ex.getCause() : ex;
+                            String msg = "Goblint was unable to successfully read the new configuration: " + cause.getMessage();
+                            magpieServer.forwardMessageToClient(new MessageParams(MessageType.Error, msg));
+                            log.error(msg);
+                            return false;
+                        }
+                        return true;
+                    })
+                    .join();
+        }
+        return configValid;
+    }
+}

src/main/java/goblintserver/GoblintServer.java

@@ -12,6 +12,7 @@
 import org.zeroturnaround.exec.ProcessExecutor;
 import org.zeroturnaround.exec.StartedProcess;
 import org.zeroturnaround.exec.listener.ProcessListener;
+import org.zeroturnaround.process.UnixProcess;
 
 import java.io.ByteArrayOutputStream;
 import java.io.File;
@@ -35,7 +36,7 @@
 public class GoblintServer {
 
     private static final String GOBLINT_SOCKET = "goblint.sock";
-
+    private static final int SIGINT = 2;
     private final MagpieServer magpieServer;
     private final GobPieConfiguration configuration;
     private final String[] goblintRunCommand;
@@ -51,8 +52,14 @@ public GoblintServer(MagpieServer magpieServer, GobPieConfiguration configuratio
         this.goblintRunCommand = constructGoblintRunCommand();
     }
 
-    public StartedProcess getGoblintRunProcess() {
-        return goblintRunProcess;
+    /**
+     * Aborts the previous running analysis by sending a SIGINT signal to Goblint.
+     */
+    public void abortAnalysis() throws IOException {
+        Process goblintProcess = goblintRunProcess.getProcess();
+        int pid = Math.toIntExact(goblintProcess.pid());
+        UnixProcess unixProcess = new UnixProcess(pid);
+        unixProcess.kill(SIGINT);
     }
 
     public String getGoblintSocket() {
@@ -102,6 +109,10 @@ public void startGoblintServer() {
         }
     }
 
+    public boolean isAlive() {
+        return goblintRunProcess.getProcess().isAlive();
+    }
+
 
     /**
      * Checks Goblint command reported version.