Add some Markdown escaping for flaky tests

quarkusio · Sep 6, 2024 · 52fb0ff · 52fb0ff
1 parent 0dacd64
commit 52fb0ff
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/...ons/src/main/java/io/quarkus/bot/buildreporter/githubactions/WorkflowReportFormatter.java b/...ons/src/main/java/io/quarkus/bot/buildreporter/githubactions/WorkflowReportFormatter.java
@@ -67,5 +67,14 @@ public static String escapeHtml(String html) {
 
  return html.replace("&", "&amp;").replace("<", "&lt;").replace(">", "&gt;");
  }
+
+ /**
+ * Again very naive but should catch most issues.
+ */
+ public static String escapeMarkdown(String markdown) {
+ return markdown.replace("#", "\\#")
+ .replace("*", "\\*")
+ .replace("`", "\\`");
+ }
  }
 }
diff --git a/...-actions/src/main/resources/templates/WorkflowReportFormatter/checkRunReport.md b/...-actions/src/main/resources/templates/WorkflowReportFormatter/checkRunReport.md
@@ -80,7 +80,7 @@
 <p>✖ <code>{flakyTest.fullName.escapeHtml}</code>{#if develocityEnabled && develocityUrl} - <a href="{develocityUrl}scans/tests?tests.container={flakyTest.fullClassName}&tests.test={flakyTest.name}">History</a>{/if}</p>
 
 {#for flake : flakyTest.flakes}
-- `{flake.message}`{#if flake.type} - `{flake.type}`{/if}
+- `{flake.message.escapeMarkdown}`{#if flake.type} - `{flake.type.escapeMarkdown}`{/if}
 
 {#if flake.abbreviatedStackTrace.trim && includeStackTraces}
 <details>

diff --git a/...b-actions/src/main/resources/templates/WorkflowReportFormatter/commentReport.md b/...b-actions/src/main/resources/templates/WorkflowReportFormatter/commentReport.md
@@ -123,7 +123,7 @@ It should be safe to merge provided you have a look at the other checks in the s
 <p>✖ <code>{flakyTest.fullName.escapeHtml}</code>{#if develocityEnabled && develocityUrl} - <a href="{develocityUrl}scans/tests?tests.container={flakyTest.fullClassName}&tests.test={flakyTest.name}">History</a>{/if}</p>
 
 {#for flake : flakyTest.flakes}
-- `{flake.message}`{#if flake.type} - `{flake.type}`{/if}
+- `{flake.message.escapeMarkdown}`{#if flake.type} - `{flake.type.escapeMarkdown}`{/if}
 
 {#if flake.abbreviatedStackTrace.trim && includeStackTraces}
 <details>