Internal Report Viewer: host and use the the report viewer locally

.github/workflows/maven.yml

@@ -41,7 +41,7 @@ jobs:
     - name: Set up JDK
       uses: actions/setup-java@v3
       with:
-        java-version: 17
+        java-version: 20
         distribution: 'temurin'
 
     - name: Run Tests

.github/workflows/publish.yml

@@ -10,7 +10,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-java@v3
         with:
-          java-version: '17'
+          java-version: '20'
           distribution: 'temurin'
       - name: Set maven settings.xml
         uses: whelk-io/maven-settings-xml-action@v21

.github/workflows/sonarcloud-branch.yml

@@ -28,7 +28,7 @@ jobs:
         uses: actions/setup-java@v3
         with:
           distribution: 'temurin'
-          java-version: 17
+          java-version: 20
 
       - name: Cache SonarCloud packages
         uses: actions/cache@v3

.github/workflows/sonarcloud-pr.yml

@@ -51,7 +51,7 @@ jobs:
         uses: actions/setup-java@v3
         with:
           distribution: 'temurin'
-          java-version: 17
+          java-version: 20
 
       - name: Cache SonarCloud packages
         uses: actions/cache@v3

.github/workflows/spotless.yml

@@ -41,7 +41,7 @@ jobs:
     - name: Set up JDK
       uses: actions/setup-java@v3
       with:
-        java-version: 17
+        java-version: 20
         distribution: 'temurin'
 
     - name: Check with Spotless

cli/pom.xml

@@ -7,6 +7,7 @@
         <version>${revision}</version>
     </parent>
     <artifactId>cli</artifactId>
+
     <dependencies>
         <!-- IMPORTANT: For Coverage testing, you have to add dependencies to the coverage-report project ! -->
 
@@ -123,8 +124,20 @@
             <artifactId>picocli</artifactId>
             <version>4.7.5</version>
         </dependency>
+
+        <dependency>
+            <groupId>org.jline</groupId>
+            <artifactId>jline</artifactId>
+            <version>3.23.0</version>
+        </dependency>
     </dependencies>
     <build>
+        <resources>
+            <resource>
+                <targetPath>report-viewer</targetPath>
+                <directory>../report-viewer/dist</directory>
+            </resource>
+        </resources>
         <plugins>
             <plugin>
                 <artifactId>maven-jar-plugin</artifactId>
@@ -156,4 +169,53 @@
             </plugin>
         </plugins>
     </build>
+
+    <profiles>
+        <profile>
+            <id>build-report-viewer</id>
+            <activation>
+                <activeByDefault>true</activeByDefault>
+            </activation>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.codehaus.mojo</groupId>
+                        <artifactId>exec-maven-plugin</artifactId>
+                        <version>1.3.2</version>
+                        <executions>
+                            <execution>
+                                <id>npm install</id>
+                                <goals>
+                                    <goal>exec</goal>
+                                </goals>
+                                <phase>generate-resources</phase>
+                                <configuration>
+                                    <executable>npm</executable>
+                                    <workingDirectory>../report-viewer</workingDirectory>
+                                    <arguments>
+                                        <argument>install</argument>
+                                    </arguments>
+                                </configuration>
+                            </execution>
+                            <execution>
+                                <id>npm build</id>
+                                <goals>
+                                    <goal>exec</goal>
+                                </goals>
+                                <phase>generate-resources</phase>
+                                <configuration>
+                                    <executable>npm</executable>
+                                    <workingDirectory>../report-viewer</workingDirectory>
+                                    <arguments>
+                                        <argument>run</argument>
+                                        <argument>build</argument>
+                                    </arguments>
+                                </configuration>
+                            </execution>
+                        </executions>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+    </profiles>
 </project>

cli/src/main/java/de/jplag/cli/CLI.java

@@ -4,14 +4,19 @@
 import static picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_OPTION_LIST;
 import static picocli.CommandLine.Model.UsageMessageSpec.SECTION_KEY_SYNOPSIS;
 
+import java.awt.*;
 import java.io.File;
+import java.io.IOException;
+import java.net.URI;
 import java.security.SecureRandom;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Random;
 import java.util.Set;
 import java.util.stream.Collectors;
 
+import org.jline.terminal.Terminal;
+import org.jline.terminal.TerminalBuilder;
 import org.slf4j.ILoggerFactory;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -20,6 +25,7 @@
 import de.jplag.JPlagResult;
 import de.jplag.Language;
 import de.jplag.cli.logger.CollectedLoggerFactory;
+import de.jplag.cli.server.ReportViewer;
 import de.jplag.clustering.ClusteringOptions;
 import de.jplag.clustering.Preprocessing;
 import de.jplag.exceptions.ExitException;
@@ -74,12 +80,13 @@ public static void main(String[] args) {
             ParseResult parseResult = cli.parseOptions(args);
 
             if (!parseResult.isUsageHelpRequested() && !(parseResult.subcommand() != null && parseResult.subcommand().isUsageHelpRequested())) {
-                JPlagOptions options = cli.buildOptionsFromArguments(parseResult);
-                JPlagResult result = JPlag.run(options);
-                ReportObjectFactory reportObjectFactory = new ReportObjectFactory();
-                reportObjectFactory.createAndSaveReport(result, cli.getResultFolder());
+                switch (cli.options.mode) {
+                    case RUN -> cli.runJPlag(parseResult);
+                    case VIEWER -> cli.runViewer(null);
+                    case RUN_AND_VIEW -> cli.runViewer(cli.runJPlag(parseResult));
+                }
             }
-        } catch (ExitException exception) {
+        } catch (ExitException | IOException exception) {
             logger.error(exception.getMessage()); // do not pass exception here to keep log clean
             finalizeLogger();
             System.exit(1);
@@ -110,6 +117,27 @@ public CLI() {
         this.commandLine.setAllowSubcommandsAsOptionParameters(true);
     }
 
+    public File runJPlag(ParseResult parseResult) throws ExitException {
+        JPlagOptions options = buildOptionsFromArguments(parseResult);
+        JPlagResult result = JPlag.run(options);
+        ReportObjectFactory reportObjectFactory = new ReportObjectFactory();
+        return reportObjectFactory.createAndSaveReport(result, getResultFolder());
+    }
+
+    public void runViewer(File zipFile) throws IOException {
+        ReportViewer reportViewer = new ReportViewer(zipFile);
+        int port = reportViewer.start();
+        logger.info("ReportViewer started on port http://localhost:{}", port);
+        Desktop.getDesktop().browse(URI.create("http://localhost:" + port + "/"));
+
+        Terminal terminal = TerminalBuilder.terminal();
+        terminal.writer().print("Press any key to exit...");
+        terminal.writer().flush();
+        terminal.enterRawMode();
+        terminal.reader().read();
+        reportViewer.stop();
+    }
+
     private List<CommandSpec> buildSubcommands() {
         return LanguageLoader.getAllAvailableLanguages().values().stream().map(language -> {
             CommandSpec command = CommandSpec.create().name(language.getIdentifier());

cli/src/main/java/de/jplag/cli/CliOptions.java

@@ -53,6 +53,9 @@ public class CliOptions implements Runnable {
             "--result-directory"}, description = "Name of the directory in which the comparison results will be stored (default: result)%n")
     public String resultFolder = "results";
 
+    @Option(names = {"--mode"}, description = "The mode to run jplag in")
+    public JPlagMode mode = JPlagMode.RUN_AND_VIEW;
+
     @ArgGroup(heading = "Advanced%n", exclusive = false)
     public Advanced advanced = new Advanced();
 

cli/src/main/java/de/jplag/cli/JPlagMode.java

@@ -0,0 +1,7 @@
+package de.jplag.cli;
+
+public enum JPlagMode {
+    RUN,
+    VIEWER,
+    RUN_AND_VIEW
+}

cli/src/main/java/de/jplag/cli/server/ContentType.java

@@ -0,0 +1,31 @@
+package de.jplag.cli.server;
+
+public enum ContentType {
+    HTML("text/html; charset=utf-8"),
+    JS("application/javascript; charset=utf-8"),
+    CSS("text/css; charset=utf-8"),
+    PNG("image/png"),
+    PLAIN("text/plain; charset=utf-8"),
+    ZIP("application/zip");
+
+    private final String value;
+
+    ContentType(String value) {
+        this.value = value;
+    }
+
+    public String getValue() {
+        return value;
+    }
+
+    public static ContentType fromPath(String path) {
+        return switch (path.substring(path.lastIndexOf('.'))) {
+            case ".html" -> ContentType.HTML;
+            case ".js" -> ContentType.JS;
+            case ".css" -> ContentType.CSS;
+            case ".png" -> ContentType.PNG;
+            case ".zip" -> ContentType.ZIP;
+            default -> ContentType.PLAIN;
+        };
+    }
+}

cli/src/main/java/de/jplag/cli/server/HttpMethod.java

@@ -0,0 +1,26 @@
+package de.jplag.cli.server;
+
+public enum HttpMethod {
+    GET("GET"),
+    POST("POST");
+
+    private final String name;
+
+    HttpMethod(String name) {
+        this.name = name;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public static HttpMethod fromName(String name) {
+        for (HttpMethod value : HttpMethod.values()) {
+            if (value.name.equals(name)) {
+                return value;
+            }
+        }
+
+        return null;
+    }
+}

cli/src/main/java/de/jplag/cli/server/ReportViewer.java

@@ -0,0 +1,86 @@
+package de.jplag.cli.server;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.InetAddress;
+import java.net.InetSocketAddress;
+
+import org.apache.commons.lang3.ArrayUtils;
+import org.apache.commons.lang3.tuple.Pair;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.sun.net.httpserver.HttpExchange;
+import com.sun.net.httpserver.HttpHandler;
+import com.sun.net.httpserver.HttpServer;
+
+public class ReportViewer implements HttpHandler {
+    private static final Logger logger = LoggerFactory.getLogger(ReportViewer.class);
+    private static final int SUCCESS_RESPONSE = 200;
+    private static final int NOT_FOUND_RESPONSE = 404;
+
+    private final RoutingTree routingTree;
+
+    private HttpServer server;
+
+    public ReportViewer(File zipFile) throws IOException {
+        this.routingTree = new RoutingTree();
+
+        this.routingTree.insertRouting("", new RoutingResources("report-viewer").or(new RoutingAlias("index.html")));
+        this.routingTree.insertRouting("results.zip", new RoutingStaticFile(zipFile, ContentType.ZIP));
+    }
+
+    public int start() throws IOException {
+        if (server != null) {
+            throw new IllegalStateException("Server already started");
+        }
+        server = HttpServer.create(new InetSocketAddress(InetAddress.getLoopbackAddress(), 0), 0);
+        server.createContext("/", this);
+        server.setExecutor(null);
+        server.start();
+
+        return server.getAddress().getPort();
+    }
+
+    public void stop() {
+        server.stop(0);
+    }
+
+    public void handle(HttpExchange exchange) throws IOException {
+        RoutingPath path = new RoutingPath(exchange.getRequestURI().getPath());
+        Pair<RoutingPath, Routing> resolved = this.routingTree.resolveRouting(path);
+        HttpMethod method = HttpMethod.fromName(exchange.getRequestMethod());
+
+        if (resolved == null || !ArrayUtils.contains(resolved.getRight().allowedMethods(), method)) {
+            exchange.sendResponseHeaders(NOT_FOUND_RESPONSE, 0);
+            exchange.close();
+            return;
+        }
+
+        logger.debug("Serving {}", path);
+
+        ResponseData responseData = resolved.getRight().fetchData(resolved.getLeft(), exchange, this);
+        if (responseData == null) {
+            exchange.sendResponseHeaders(NOT_FOUND_RESPONSE, 0);
+            exchange.close();
+            return;
+        }
+
+        InputStream inputStream = responseData.stream();
+
+        if (responseData.contentType() != null) {
+            exchange.getResponseHeaders().set("Content-Type", responseData.contentType().getValue());
+        }
+        exchange.sendResponseHeaders(SUCCESS_RESPONSE, responseData.size());
+
+        inputStream.transferTo(exchange.getResponseBody());
+        exchange.getResponseBody().flush();
+        exchange.getResponseBody().close();
+        inputStream.close();
+    }
+
+    public RoutingTree getRoutingTree() {
+        return routingTree;
+    }
+}