Refactor Continuous Testing RPC service and UI

- merge observers for test state and results - replace direct rendering of results and state by custom API object (DTO) - optimize size and structure of JSON message resolves #43067
quarkusio · Sep 19, 2024 · 093e274 · 093e274
1 parent 1c8464b
commit 093e274
Show file tree

Hide file tree

Showing 10 changed files with 522 additions and 172 deletions.
diff --git a/core/deployment/src/main/java/io/quarkus/deployment/dev/testing/TestClassResult.java b/core/deployment/src/main/java/io/quarkus/deployment/dev/testing/TestClassResult.java
@@ -3,31 +3,39 @@
 import java.util.ArrayList;
 import java.util.List;
 
-public class TestClassResult implements Comparable<TestClassResult> {
+import io.quarkus.dev.testing.results.TestClassResultInterface;
+import io.quarkus.dev.testing.results.TestResultInterface;
+
+public class TestClassResult implements TestClassResultInterface {
     final String className;
     final List<TestResult> passing;
     final List<TestResult> failing;
     final List<TestResult> skipped;
     final long latestRunId;
     final long time;
 
-    public TestClassResult(String className, List<TestResult> passing, List<TestResult> failing, List<TestResult> skipped,
+    public TestClassResult(
+            String className,
+            List<TestResult> passing,
+            List<TestResult> failing,
+            List<TestResult> skipped,
             long time) {
         this.className = className;
         this.passing = passing;
         this.failing = failing;
         this.skipped = skipped;
         this.time = time;
         long runId = 0;
-        for (TestResult i : passing) {
-            runId = Math.max(i.runId, runId);
+        for (TestResultInterface i : passing) {
+            runId = Math.max(i.getRunId(), runId);
         }
-        for (TestResult i : failing) {
-            runId = Math.max(i.runId, runId);
+        for (TestResultInterface i : failing) {
+            runId = Math.max(i.getRunId(), runId);
         }
         latestRunId = runId;
     }
 
+    @Override
     public String getClassName() {
         return className;
     }
@@ -53,15 +61,12 @@ public long getTime() {
     }
 
     @Override
-    public int compareTo(TestClassResult o) {
-        return className.compareTo(o.className);
-    }
-
     public List<TestResult> getResults() {
         List<TestResult> ret = new ArrayList<>();
         ret.addAll(passing);
         ret.addAll(failing);
         ret.addAll(skipped);
         return ret;
     }
+
 }
diff --git a/core/deployment/src/main/java/io/quarkus/deployment/dev/testing/TestResult.java b/core/deployment/src/main/java/io/quarkus/deployment/dev/testing/TestResult.java
@@ -7,7 +7,9 @@
 import org.junit.platform.engine.TestExecutionResult;
 import org.junit.platform.engine.UniqueId;
 
-public class TestResult {
+import io.quarkus.dev.testing.results.TestResultInterface;
+
+public class TestResult implements TestResultInterface {
 
     final String displayName;
     final String testClass;
@@ -49,18 +51,22 @@ public TestExecutionResult getTestExecutionResult() {
         return testExecutionResult;
     }
 
+    @Override
     public List<String> getLogOutput() {
         return logOutput;
     }
 
+    @Override
     public String getDisplayName() {
         return displayName;
     }
 
+    @Override
     public String getTestClass() {
         return testClass;
     }
 
+    @Override
     public List<String> getTags() {
         return tags;
     }
@@ -69,23 +75,42 @@ public UniqueId getUniqueId() {
         return uniqueId;
     }
 
+    @Override
     public boolean isTest() {
         return test;
     }
 
+    @Override
+    public String getId() {
+        return uniqueId.toString();
+    }
+
+    @Override
     public long getRunId() {
         return runId;
     }
 
+    @Override
     public long getTime() {
         return time;
     }
 
+    @Override
     public List<Throwable> getProblems() {
         return problems;
     }
 
+    @Override
     public boolean isReportable() {
         return reportable;
     }
+
+    @Override
+    public State getState() {
+        return switch (testExecutionResult.getStatus()) {
+            case FAILED -> State.FAILED;
+            case ABORTED -> State.SKIPPED;
+            case SUCCESSFUL -> State.PASSED;
+        };
+    }
 }
diff --git a/core/deployment/src/main/java/io/quarkus/deployment/dev/testing/TestRunResults.java b/core/deployment/src/main/java/io/quarkus/deployment/dev/testing/TestRunResults.java
@@ -7,8 +7,10 @@
 import java.util.Map;
 
 import io.quarkus.deployment.dev.ClassScanResult;
+import io.quarkus.dev.testing.results.TestResultInterface;
+import io.quarkus.dev.testing.results.TestRunResultsInterface;
 
-public class TestRunResults {
+public class TestRunResults implements TestRunResultsInterface {
 
     /**
      * The run id
@@ -28,7 +30,7 @@ public class TestRunResults {
     private final long started;
     private final long completed;
 
-    private final Map<String, TestClassResult> results;
+    private final Map<String, ? extends TestClassResult> results;
     private final Map<String, TestClassResult> currentFailing = new HashMap<>();
     private final Map<String, TestClassResult> historicFailing = new HashMap<>();
     private final Map<String, TestClassResult> currentPassing = new HashMap<>();
@@ -58,9 +60,9 @@ public TestRunResults(long id, ClassScanResult trigger, boolean full, long start
         long currentFailedCount = 0;
         long currentSkippedCount = 0;
         for (Map.Entry<String, TestClassResult> i : results.entrySet()) {
-            passedCount += i.getValue().getPassing().stream().filter(TestResult::isTest).count();
-            failedCount += i.getValue().getFailing().stream().filter(TestResult::isTest).count();
-            skippedCount += i.getValue().getSkipped().stream().filter(TestResult::isTest).count();
+            passedCount += i.getValue().getPassing().stream().filter(TestResultInterface::isTest).count();
+            failedCount += i.getValue().getFailing().stream().filter(TestResultInterface::isTest).count();
+            skippedCount += i.getValue().getSkipped().stream().filter(TestResultInterface::isTest).count();
             currentPassedCount += i.getValue().getPassing().stream().filter(s -> s.isTest() && s.getRunId() == id).count();
             currentFailedCount += i.getValue().getFailing().stream().filter(s -> s.isTest() && s.getRunId() == id).count();
             currentSkippedCount += i.getValue().getSkipped().stream().filter(s -> s.isTest() && s.getRunId() == id).count();
@@ -98,6 +100,7 @@ public TestRunResults(long id, ClassScanResult trigger, boolean full, long start
         this.currentSkippedCount = currentSkippedCount;
     }
 
+    @Override
     public long getId() {
         return id;
     }
@@ -110,6 +113,7 @@ public boolean isFull() {
         return full;
     }
 
+    @Override
     public Map<String, TestClassResult> getResults() {
         return Collections.unmodifiableMap(results);
     }
@@ -130,14 +134,17 @@ public Map<String, TestClassResult> getHistoricPassing() {
         return historicPassing;
     }
 
+    @Override
     public long getStartedTime() {
         return started;
     }
 
+    @Override
     public long getCompletedTime() {
         return completed;
     }
 
+    @Override
     public long getTotalTime() {
         return completed - started;
     }
@@ -154,34 +161,42 @@ public List<TestClassResult> getSkipped() {
         return skipped;
     }
 
+    @Override
     public long getPassedCount() {
         return passedCount;
     }
 
+    @Override
     public long getFailedCount() {
         return failedCount;
     }
 
+    @Override
     public long getSkippedCount() {
         return skippedCount;
     }
 
+    @Override
     public long getCurrentPassedCount() {
         return currentPassedCount;
     }
 
+    @Override
     public long getCurrentFailedCount() {
         return currentFailedCount;
     }
 
+    @Override
     public long getCurrentSkippedCount() {
         return currentSkippedCount;
     }
 
+    @Override
     public long getTotalCount() {
         return getPassedCount() + getFailedCount() + getSkippedCount();
     }
 
+    @Override
     public long getCurrentTotalCount() {
         return getCurrentPassedCount() + getCurrentFailedCount() + getCurrentSkippedCount();
     }

diff --git a/core/devmode-spi/src/main/java/io/quarkus/dev/testing/results/TestClassResultInterface.java b/core/devmode-spi/src/main/java/io/quarkus/dev/testing/results/TestClassResultInterface.java
@@ -0,0 +1,16 @@
+package io.quarkus.dev.testing.results;
+
+import java.util.List;
+
+public interface TestClassResultInterface extends Comparable<TestClassResultInterface> {
+
+    String getClassName();
+
+    List<? extends TestResultInterface> getResults();
+
+    @Override
+    default int compareTo(TestClassResultInterface o) {
+        return getClassName().compareTo(o.getClassName());
+    }
+
+}
diff --git a/core/devmode-spi/src/main/java/io/quarkus/dev/testing/results/TestResultInterface.java b/core/devmode-spi/src/main/java/io/quarkus/dev/testing/results/TestResultInterface.java
@@ -0,0 +1,34 @@
+package io.quarkus.dev.testing.results;
+
+import java.util.List;
+
+public interface TestResultInterface {
+    List<String> getLogOutput();
+
+    String getDisplayName();
+
+    String getTestClass();
+
+    List<String> getTags();
+
+    boolean isTest();
+
+    String getId();
+
+    long getRunId();
+
+    long getTime();
+
+    List<Throwable> getProblems();
+
+    boolean isReportable();
+
+    State getState();
+
+    enum State {
+        PASSED,
+        FAILED,
+        SKIPPED
+    }
+
+}
diff --git a/core/devmode-spi/src/main/java/io/quarkus/dev/testing/results/TestRunResultsInterface.java b/core/devmode-spi/src/main/java/io/quarkus/dev/testing/results/TestRunResultsInterface.java
@@ -0,0 +1,31 @@
+package io.quarkus.dev.testing.results;
+
+import java.util.Map;
+
+public interface TestRunResultsInterface {
+    long getId();
+
+    Map<String, ? extends TestClassResultInterface> getResults();
+
+    long getStartedTime();
+
+    long getCompletedTime();
+
+    long getTotalTime();
+
+    long getPassedCount();
+
+    long getFailedCount();
+
+    long getSkippedCount();
+
+    long getCurrentPassedCount();
+
+    long getCurrentFailedCount();
+
+    long getCurrentSkippedCount();
+
+    long getTotalCount();
+
+    long getCurrentTotalCount();
+}
diff --git a/...deployment/src/main/java/io/quarkus/devui/deployment/menu/ContinuousTestingProcessor.java b/...deployment/src/main/java/io/quarkus/devui/deployment/menu/ContinuousTestingProcessor.java
@@ -16,6 +16,7 @@
 import io.quarkus.deployment.dev.testing.TestRunResults;
 import io.quarkus.deployment.dev.testing.TestSupport;
 import io.quarkus.dev.spi.DevModeType;
+import io.quarkus.dev.testing.results.TestRunResultsInterface;
 import io.quarkus.devui.deployment.InternalPageBuildItem;
 import io.quarkus.devui.runtime.continuoustesting.ContinuousTestingJsonRPCService;
 import io.quarkus.devui.runtime.continuoustesting.ContinuousTestingRecorder;
@@ -237,7 +238,7 @@ private void registerGetStatusMethod(LaunchModeBuildItem launchModeBuildItem, Bu
     }
 
     private void registerGetResultsMethod(LaunchModeBuildItem launchModeBuildItem, BuildTimeActionBuildItem actions) {
-        actions.addAction("getResults", ignored -> {
+        actions.<TestRunResultsInterface> addAction("getResults", ignored -> {
             try {
                 Optional<TestSupport> ts = TestSupport.instance();
                 if (testsDisabled(launchModeBuildItem, ts)) {