Merge pull request #25 from tls-attacker/summarizable-result

Implement Summarizable and Detailed Results

src/main/java/de/rub/nds/scanner/core/probe/result/DetailedResult.java

@@ -0,0 +1,56 @@
+/*
+ * Scanner Core - A modular framework for probe definition, execution, and result analysis.
+ *
+ * Copyright 2017-2023 Ruhr University Bochum, Paderborn University, Technology Innovation Institute, and Hackmanit GmbH
+ *
+ * Licensed under Apache License, Version 2.0
+ * http://www.apache.org/licenses/LICENSE-2.0.txt
+ */
+package de.rub.nds.scanner.core.probe.result;
+
+import java.io.Serializable;
+
+public class DetailedResult<T extends Serializable> implements SummarizableTestResult {
+
+    public static <T extends Serializable> DetailedResult<T> TRUE() {
+        return new DetailedResult<>(TestResults.TRUE);
+    }
+
+    public static <T extends Serializable> DetailedResult<T> TRUE(T details) {
+        return new DetailedResult<>(TestResults.TRUE, details);
+    }
+
+    public static <T extends Serializable> DetailedResult<T> FALSE() {
+        return new DetailedResult<>(TestResults.FALSE);
+    }
+
+    public static <T extends Serializable> DetailedResult<T> FALSE(T details) {
+        return new DetailedResult<>(TestResults.FALSE, details);
+    }
+
+    private final T details;
+    private final TestResults summary;
+
+    public DetailedResult(TestResults summary, T details) {
+        this.details = details;
+        this.summary = summary;
+    }
+
+    public DetailedResult(TestResults summary) {
+        this(summary, null);
+    }
+
+    public T getDetails() {
+        return details;
+    }
+
+    @Override
+    public TestResults getSummarizedResult() {
+        return summary;
+    }
+
+    @Override
+    public boolean isExplicitSummary() {
+        return true;
+    }
+}

src/main/java/de/rub/nds/scanner/core/probe/result/SummarizableTestResult.java

@@ -0,0 +1,36 @@
+/*
+ * Scanner Core - A modular framework for probe definition, execution, and result analysis.
+ *
+ * Copyright 2017-2023 Ruhr University Bochum, Paderborn University, Technology Innovation Institute, and Hackmanit GmbH
+ *
+ * Licensed under Apache License, Version 2.0
+ * http://www.apache.org/licenses/LICENSE-2.0.txt
+ */
+package de.rub.nds.scanner.core.probe.result;
+
+/**
+ * A complex test result that can still be summarized into a single TestResults. This summary might
+ * be generated on the fly (from the contained details), or set explicitly (e.g. in case of an
+ * error)
+ */
+public interface SummarizableTestResult extends TestResult {
+    TestResults getSummarizedResult();
+
+    /**
+     * @return Whether the summary was explicitly set instead of generated on the fly.
+     */
+    boolean isExplicitSummary();
+
+    @Override
+    default boolean equalsExpectedResult(TestResult other) {
+        if (other instanceof TestResults) {
+            return getSummarizedResult().equals(other);
+        }
+        return this.equals(other);
+    }
+
+    @Override
+    default String getName() {
+        return getSummarizedResult().getName();
+    }
+}

src/main/java/de/rub/nds/scanner/core/probe/result/TestResult.java

@@ -8,8 +8,10 @@
  */
 package de.rub.nds.scanner.core.probe.result;
 
+import java.io.Serializable;
+
 /** The interface for TestResults */
-public interface TestResult {
+public interface TestResult extends Serializable {
 
     /**
      * @return the name of the TestResult.

src/main/java/de/rub/nds/scanner/core/probe/result/TestResults.java

@@ -22,7 +22,7 @@
 @JsonIncludeProperties({"type", "value"})
 @JsonPropertyOrder({"type", "value"})
 @JsonFormat(shape = JsonFormat.Shape.OBJECT)
-public enum TestResults implements TestResult {
+public enum TestResults implements SummarizableTestResult {
     TRUE,
     FALSE,
     PARTIALLY,
@@ -48,4 +48,14 @@ public String getName() {
     public static TestResults of(boolean value) {
         return value ? TRUE : FALSE;
     }
+
+    @Override
+    public TestResults getSummarizedResult() {
+        return this;
+    }
+
+    @Override
+    public boolean isExplicitSummary() {
+        return true;
+    }
 }