Replace the outdated HTML report generation #192

.github/dependabot.yml

@@ -23,4 +23,16 @@ updates:
     labels:
       - "dependencies"
       - "minor"
+  - package-ecosystem: "npm"
+    directory: "/report-viewer"
+    schedule:
+      interval: "weekly"
+      day: "wednesday"
+      time: "11:00"
+      timezone: "Europe/Berlin"
+    commit-message:
+      prefix: "Dependency"
+      include: "scope"
+
+
 

.github/workflows/report-viewer.yml

@@ -0,0 +1,30 @@
+name: Report Viewer Deployment Workflow
+
+on:
+ workflow_dispatch: # Use this to dispatch from the Actions Tab
+ push:
+    branches:
+      - 192-webreport # you might change that to main/master later on
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/[email protected]
+
+      - uses: actions/setup-node@v2
+        with:
+          node-version: "16"
+
+      - name: Install and Build 🔧
+        working-directory: report-viewer
+        run: |
+          npm install
+          npm run build
+
+      - name: Deploy 🚀
+        uses: JamesIves/[email protected]
+        with:
+          branch: gh-pages
+          folder: report-viewer/dist

jplag/pom.xml

@@ -20,6 +20,11 @@
             <artifactId>system-rules</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>2.13.0</version>
+        </dependency>
         <dependency>
             <groupId>org.apache.commons</groupId>
             <artifactId>commons-math3</artifactId>

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

@@ -2,7 +2,6 @@
 
 import static de.jplag.CommandLineArgument.*;
 
-import java.io.File;
 import java.util.Optional;
 import java.util.Random;
 
@@ -20,7 +19,8 @@
 import de.jplag.options.LanguageOption;
 import de.jplag.options.SimilarityMetric;
 import de.jplag.options.Verbosity;
-import de.jplag.reporting.Report;
+import de.jplag.reporting2.JsonReport;
+import de.jplag.reporting2.Report;
 import de.jplag.strategy.ComparisonMode;
 
 /**
@@ -53,9 +53,8 @@ public static void main(String[] args) {
             JPlag program = new JPlag(options);
             System.out.println("JPlag initialized");
             JPlagResult result = program.run();
-            File reportDir = new File(arguments.getString(RESULT_FOLDER.flagWithoutDash()));
-            Report report = new Report(reportDir, options);
-            report.writeResult(result);
+            Report report = new JsonReport();
+            report.saveReport(result, arguments.getString(RESULT_FOLDER.flagWithoutDash()));
         } catch (ExitException exception) {
             System.out.println("Error: " + exception.getMessage());
             System.exit(1);

jplag/src/main/java/de/jplag/reporting2/JsonReport.java

@@ -0,0 +1,36 @@
+package de.jplag.reporting2;
+
+import java.io.File;
+import java.util.List;
+
+import de.jplag.JPlagResult;
+import de.jplag.reporting2.jsonfactory.JsonFactory;
+import de.jplag.reporting2.reportobject.ReportObjectFactory;
+import de.jplag.reporting2.reportobject.model.JPlagReport;
+
+// ReportImplementation -> JsonReport
+
+/**
+ * A report generator which reports the JPlagResult in Json format.
+ */
+public class JsonReport implements Report {
+
+    @Override
+    public List<String> getReportStrings(JPlagResult result) {
+        JPlagReport report = ReportObjectFactory.getReportObject(result);
+        return JsonFactory.getJsonStrings(report);
+    }
+
+    @Override
+    public boolean saveReport(JPlagResult result, String path) {
+        JPlagReport report = ReportObjectFactory.getReportObject(result);
+        File dir = new File(path);
+        if (!dir.exists()) {
+            if (!dir.mkdir()) {
+                System.out.println("Failed to create dir.");
+            }
+        }
+        return JsonFactory.saveJsonFiles(report, path);
+    }
+
+}

jplag/src/main/java/de/jplag/reporting2/Report.java

@@ -0,0 +1,29 @@
+package de.jplag.reporting2;
+
+import java.util.List;
+
+import de.jplag.JPlagResult;
+
+// ReportStrategy -> Report
+
+/**
+ * Strategy interface for reporting. A report generator should implement this interface.
+ */
+public interface Report {
+
+    /**
+     * This function returns a list containing the report objects as simple strings. The first element is the string of the
+     * overview object. Each following element is a string of a comparison report object.
+     * @param result The result of a JPlag comparison
+     * @return A list containing report objects to string. First element is Overview. Other elements are comparisons.
+     */
+    List<String> getReportStrings(JPlagResult result);
+
+    /**
+     * Creates and saves JPlag report files to the disk.
+     * @param result The result of a JPlag comparison.
+     * @param path Path to the directory where the report should be saved.
+     * @return True if the process is successful, otherwise false.
+     */
+    boolean saveReport(JPlagResult result, String path);
+}

jplag/src/main/java/de/jplag/reporting2/jsonfactory/JsonFactory.java

@@ -0,0 +1,57 @@
+package de.jplag.reporting2.jsonfactory;
+
+import java.io.IOException;
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.List;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import de.jplag.reporting2.reportobject.model.ComparisonReport;
+import de.jplag.reporting2.reportobject.model.JPlagReport;
+
+/**
+ * Factory class, responsible for creating Json strings and writing them to files.
+ */
+public class JsonFactory {
+
+    private static final ObjectMapper mapper = new ObjectMapper();
+
+    /**
+     * Uses Jackson to create Json Strings from JPlagReport object.
+     * @return A list, first element is Json String of Overview object. The rest elements are Json Strings of Comparison
+     * objects.
+     */
+    public static List<String> getJsonStrings(JPlagReport jPlagReport) {
+        List<String> jsonReports = new ArrayList<>();
+        try {
+            jsonReports.add(mapper.writeValueAsString(jPlagReport.getOverviewReport()));
+            for (ComparisonReport comparisonReport : jPlagReport.getComparisons()) {
+                jsonReports.add(mapper.writeValueAsString(comparisonReport));
+            }
+        } catch (JsonProcessingException e) {
+            System.out.println("Error converting object to json " + e.getMessage());
+        }
+        return jsonReports;
+    }
+
+    /**
+     * Creates Json Files for the given JPlagReport and saves them in the given folder.
+     * @return A boolean, representing whether the process was successful.
+     */
+    public static boolean saveJsonFiles(JPlagReport jPlagReport, String folderPath) {
+        try {
+            ObjectMapper mapper = new ObjectMapper();
+            mapper.writeValue(Path.of(folderPath, "overview.json").toFile(), jPlagReport.getOverviewReport());
+            for (ComparisonReport report : jPlagReport.getComparisons()) {
+                String name = report.getFirstSubmissionId().concat("-").concat(report.getSecondSubmissionId()).concat(".json");
+                mapper.writeValue(Path.of(folderPath, name).toFile(), report);
+            }
+        } catch (IOException e) {
+            System.out.println("Failed to save json files: " + e.getMessage());
+            return false;
+        }
+        return true;
+    }
+}