Improve Markdown of test failures.

uhafner · Nov 21, 2023 · 01e0c81 · 01e0c81
1 parent 815b735
commit 01e0c81
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 6 deletions.
diff --git a/src/main/java/edu/hm/hafner/grading/TestMarkdown.java b/src/main/java/edu/hm/hafner/grading/TestMarkdown.java
@@ -2,6 +2,8 @@
 
 import java.util.function.Function;
 
+import org.apache.commons.lang3.StringUtils;
+
 import edu.hm.hafner.coverage.TestCase;
 
 /**
@@ -89,13 +91,22 @@ else if (!stringBuilder.toString().endsWith(TRUNCATED_MESSAGE)) {
     }
 
     private String renderFailure(final TestCase issue) {
-        return String.format("<details>%n"
-                + "<summary>%s:%s</summary>"
+        return String.format("__%s:%s__%n"
+                + getMessage(issue)
+                + "<details>%n"
+                + "<summary>Stack Trace</summary>"
                 + "%n%n"
                 + "```text%n"
                 + "%s%n"
                 + "```"
                 + "%n"
-                + "</details>%n", issue.getClassName(), issue.getMessage(), issue.getDescription());
+                + "</details>%n%n", issue.getClassName(), issue.getTestName(), issue.getDescription());
+    }
+
+    private String getMessage(final TestCase issue) {
+        if (issue.getMessage().isBlank()) {
+            return StringUtils.EMPTY;
+        }
+        return issue.getMessage() + "%n";
     }
 }
diff --git a/src/test/java/edu/hm/hafner/grading/TestMarkdownTest.java b/src/test/java/edu/hm/hafner/grading/TestMarkdownTest.java
@@ -184,9 +184,13 @@ void shouldShowScoreWithTwoResults() {
                         "|Modultests|0|0|10|-30",
                         "*:moneybag:*|*1*|*2*|*3*|*:ledger:*",
                         "*:moneybag:*|*-1*|*-2*|*-3*|*:ledger:*",
-                        "<summary>test-class-failed-0:failed-message-0</summary>",
-                        "<summary>test-class-failed-1:failed-message-1</summary>",
-                        "<summary>test-class-failed-2:failed-message-2</summary>",
+                        "__test-class-failed-0:test-failed-0__",
+                        "__test-class-failed-1:test-failed-1__",
+                        "__test-class-failed-2:test-failed-2__",
+                        "failed-message-0",
+                        "failed-message-1",
+                        "failed-message-2",
+                        "<summary>Stack Trace</summary>",
                         "```text\nStackTrace-0\n```",
                         "```text\nStackTrace-1\n```",
                         "```text\nStackTrace-2\n```")