Merge branch 'master' of github.com:AnetteTaivere/GobPie_

Author: karoliineh

gobpie-0.0.4.vsix:Zone.Identifier

@@ -7,6 +7,54 @@
     <version>0.0.4-SNAPSHOT</version>
     <dependencies>
 
+        <!-- https://mvnrepository.com/artifact/ch.qos.logback/logback-classic -->
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-classic</artifactId>
+            <version>1.3.14</version>
+            <scope>test</scope>
+        </dependency>
+
+        <!-- https://mvnrepository.com/artifact/io.github.hakky54/logcaptor -->
+        <dependency>
+            <groupId>io.github.hakky54</groupId>
+            <artifactId>logcaptor</artifactId>
+            <version>2.9.2</version>
+            <scope>test</scope>
+        </dependency>
+
+        <!-- https://mvnrepository.com/artifact/org.mockito/mockito-core -->
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <version>5.8.0</version>
+            <scope>test</scope>
+        </dependency>
+
+        <!-- https://mvnrepository.com/artifact/org.junit.jupiter/junit-jupiter-api -->
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-api</artifactId>
+            <version>5.10.2</version>
+            <scope>test</scope>
+        </dependency>
+
+        <!-- https://mvnrepository.com/artifact/org.junit.jupiter/junit-jupiter-engine -->
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-engine</artifactId>
+            <version>5.10.0</version>
+            <scope>test</scope>
+        </dependency>
+
+        <!-- https://mvnrepository.com/artifact/uk.org.webcompere/system-stubs-jupiter -->
+        <dependency>
+            <groupId>uk.org.webcompere</groupId>
+            <artifactId>system-stubs-jupiter</artifactId>
+            <version>2.1.6</version>
+            <scope>test</scope>
+        </dependency>
+
         <!-- lsp4j DAP -->
         <dependency>
             <groupId>org.eclipse.lsp4j</groupId>
@@ -132,6 +180,19 @@
                     </execution>
                 </executions>
             </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>3.2.5</version>
+                <dependencies>
+                    <dependency>
+                        <groupId>org.junit.jupiter</groupId>
+                        <artifactId>junit-jupiter-engine</artifactId>
+                        <version>5.10.0</version>
+                    </dependency>
+                </dependencies>
+            </plugin>
         </plugins>
     </build>
 </project>

pom.xml

@@ -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/Main.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,24 @@
 
 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);
+    //private final Logger log = LogManager.getLogger(GoblintAnalysis.class);
+    private  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 +96,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,29 +105,31 @@ 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;
         }
 
         magpieServer.forwardMessageToClient(new MessageParams(MessageType.Info, source() + " started analyzing the code."));
-
-        preAnalyse();
-
+        goblintServer.preAnalyse();
         log.info("---------------------- Analysis started ----------------------");
+
         lastAnalysisTask = reanalyse().thenAccept(response -> {
+            for (AnalysisResult analysisResult : response) {
+                System.out.println(analysisResult.toString());
+            }
             consumer.consume(new ArrayList<>(response), source());
+
             log.info("--------------------- Analysis finished ----------------------");
             magpieServer.forwardMessageToClient(new MessageParams(MessageType.Info, source() + " finished analyzing the code."));
         }).exceptionally(ex -> {
+
             Throwable cause = ex instanceof CompletionException ? ex.getCause() : ex;
             // TODO: handle closed socket exceptions:
             //      org.eclipse.lsp4j.jsonrpc.JsonRpcException: java.net.SocketException: Broken pipe; errno=32
@@ -144,59 +142,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>
-     * preAnalyzeCommand is read from the GobPie configuration file.
-     * Can be used for automating the compilation database generation.
-     */
-    private void preAnalyse() {
-        String[] preAnalyzeCommand = gobpieConfiguration.getPreAnalyzeCommand();
-        if (preAnalyzeCommand != null) {
-            try {
-                log.info("Preanalyze command ran: \"" + Arrays.toString(preAnalyzeCommand) + "\"");
-                runCommand(new File(System.getProperty("user.dir")), preAnalyzeCommand);
-                log.info("Preanalyze command finished.");
-            } catch (IOException | InvalidExitValueException | InterruptedException | TimeoutException e) {
-                this.magpieServer.forwardMessageToClient(
-                        new MessageParams(MessageType.Warning, "Running preanalysis command failed. " + e.getMessage()));
-            }
-        }
-    }
 
     /**
      * Sends the requests to Goblint server and gets their results.
@@ -207,7 +152,8 @@ private void preAnalyse() {
      * @return a CompletableFuture of a collection of warning messages and cfg code lenses if request was successful.
      * @throws GobPieException in case the analysis was aborted or returned a VerifyError.
      */
-    private CompletableFuture<Collection<AnalysisResult>> reanalyse() {
+    public CompletableFuture<Collection<AnalysisResult>> reanalyse() {
+        //return goblintService.analyze(new AnalyzeParams(true))
         return goblintService.analyze(new AnalyzeParams(!gobpieConfiguration.useIncrementalAnalysis()))
                 .thenCompose(this::getComposedAnalysisResults);
     }

src/main/java/analysis/GoblintAnalysis.java

@@ -9,6 +9,7 @@
 
 import java.util.ArrayList;
 import java.util.Collections;
+import java.util.Objects;
 
 /**
  * The Class GoblintCFGAnalysisResult.
@@ -72,4 +73,28 @@ public Pair<Position, String> repair() {
     public String code() {
         return null;
     }
+
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        GoblintCFGAnalysisResult that = (GoblintCFGAnalysisResult) o;
+        return Objects.equals(pos, that.pos) && Objects.equals(title, that.title) && Objects.equals(funName, that.funName) && Objects.equals(related, that.related);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(pos, title, funName, related);
+    }
+
+    @Override
+    public String toString() {
+        return "GoblintCFGAnalysisResult{" +
+                "pos=" + pos +
+                ", title='" + title + '\'' +
+                ", funName='" + funName + '\'' +
+                ", related=" + related +
+                '}';
+    }
 }

src/main/java/analysis/GoblintCFGAnalysisResult.java

@@ -8,6 +8,7 @@
 import org.eclipse.lsp4j.DiagnosticSeverity;
 
 import java.util.ArrayList;
+import java.util.Objects;
 
 /**
  * The Class GoblintMessagesAnalysisResult.
@@ -108,4 +109,27 @@ public String code() {
         return null;
     }
 
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        GoblintMessagesAnalysisResult that = (GoblintMessagesAnalysisResult) o;
+        return Objects.equals(group_text, that.group_text) && Objects.equals(text, that.text) && Objects.equals(pos, that.pos) && Objects.equals(severity, that.severity) && Objects.equals(related, that.related);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(group_text, text, pos, severity, related);
+    }
+
+    @Override
+    public String toString() {
+        return "GoblintMessagesAnalysisResult{" +
+                "group_text='" + group_text + '\'' +
+                ", text='" + text + '\'' +
+                ", pos=" + pos.toString() +
+                ", severity='" + severity + '\'' +
+                ", related=" + related +
+                '}';
+    }
 }