fix: make sure code block has copy button

services/test_results.py

@@ -157,8 +157,28 @@
     return f"\n{result}\n"
 
 
+def properly_backtick(content: str) -> str:
+    max_backtick_count = 0
+    curr_backtick_count = 0
+    prev_char = None
+    for char in content:
+        if char == "`":
+            curr_backtick_count += 1
+        else:
+            curr_backtick_count = 0
+
+        if curr_backtick_count > max_backtick_count:
+            max_backtick_count = curr_backtick_count
+
+    backticks = "`" * (max_backtick_count + 1)
+    return f"{backticks}\n{content}\n{backticks}"
+
+
 def wrap_in_code(content: str) -> str:
-    return f"<pre>\n{content}\n</pre>"
+    if "```" in content:
+        return properly_backtick(content)
+    else:
+        return f"\n```\n{content}\n```\n"
 
 
 def display_duration(f: float) -> str:
@@ -177,10 +197,11 @@
     else:
         failure_message = "No failure message available"
 
+    failure_message = wrap_in_code(failure_message)
     if fail.build_url:
-        return f"<pre>{failure_message}</pre>\n[View]({fail.build_url}) the CI Build"
+        return f"{failure_message}\n[View]({fail.build_url}) the CI Build"
     else:
-        return f"<pre>{failure_message}</pre>"
+        return failure_message
 
 
 def generate_view_test_analytics_line(commit: Commit) -> str:
@@ -192,7 +213,7 @@
 def messagify_failure(
     failure: TestResultsNotificationFailure,
 ) -> str:
-    test_name = wrap_in_code(failure.testname)
+    test_name = wrap_in_code(failure.testname.replace("\x1f", " "))
     formatted_duration = display_duration(failure.duration_seconds)
     stack_trace_summary = f"Stack Traces | {formatted_duration}s run time"
     stack_trace = wrap_in_details(
@@ -206,7 +227,7 @@
     flaky_failure: TestResultsNotificationFailure,
     flake_info: FlakeInfo,
 ) -> str:
-    test_name = wrap_in_code(flaky_failure.testname)
+    test_name = wrap_in_code(flaky_failure.testname.replace("\x1f", " "))
     formatted_duration = display_duration(flaky_failure.duration_seconds)
     flake_rate = flake_info.failed / flake_info.count * 100
     flake_rate_section = f"**Flake rate in main:** {flake_rate}% (Passed {flake_info.count - flake_info.failed} times, Failed {flake_info.failed} times)"

tasks/test_results_finisher.py

@@ -34,13 +34,7 @@
 test_results_finisher_task_name = "app.tasks.test_results.TestResultsFinisherTask"
 
 ESCAPE_FAILURE_MESSAGE_DEFN = [
-    Replacement(['"'], """, EscapeEnum.REPLACE),
-    Replacement(["'"], "'", EscapeEnum.REPLACE),
-    Replacement(["<"], "&lt;", EscapeEnum.REPLACE),
-    Replacement([">"], "&gt;", EscapeEnum.REPLACE),
-    Replacement(["?"], "&amp;", EscapeEnum.REPLACE),
     Replacement(["\r"], "", EscapeEnum.REPLACE),
-    Replacement(["\n"], "<br>", EscapeEnum.REPLACE),
 ]
 QUEUE_NOTIFY_KEY = "queue_notify"
 

tasks/tests/unit/test_test_results_finisher.py

@@ -70,9 +70,9 @@ def test_results_setup(mocker, dbsession):
         message="hello world",
         commitid="cd76b0821854a780b60012aed85af0a8263004ad",
         repository__owner__unencrypted_oauth_token="test7lk5ndmtqzxlx06rip65nac9c7epqopclnoy",
-        repository__owner__username="joseph-sentry",
+        repository__owner__username="test-username",
         repository__owner__service="github",
-        repository__name="codecov-demo",
+        repository__name="test-repo-name",
     )
     commit.branch = "main"
     dbsession.add(commit)
@@ -176,14 +176,14 @@ def test_results_setup(mocker, dbsession):
         TestInstance(
             test_id=test_id2,
             outcome=str(Outcome.Failure),
-            failure_message="Shared failure message",
+            failure_message="Shared \n\n\n\n <pre> ````````\n \r\n\r\n | test | test | test </pre>failure message",
             duration_seconds=2.0,
             upload_id=uploads[1].id,
         ),
         TestInstance(
             test_id=test_id3,
             outcome=str(Outcome.Failure),
-            failure_message="Shared failure message",
+            failure_message="Shared \n\n\n\n <pre> \n  ````````  \n \r\n\r\n | test | test | test </pre>failure message",
             duration_seconds=3.0,
             upload_id=uploads[2].id,
         ),
@@ -351,7 +351,7 @@ def test_upload_finisher_task_call(
         assert expected_result == result
         mock_repo_provider_comments.post_comment.assert_called_with(
             pull.pullid,
-            "### :x: 4 Tests Failed:\n| Tests completed | Failed | Passed | Skipped |\n|---|---|---|---|\n| 4 | 4 | 0 | 0 |\n<details><summary>View the top 3 failed tests by shortest run time</summary>\n\n> <pre>\n> test_name1\n> </pre>\n> <details><summary>Stack Traces | 2s run time</summary>\n> \n> > <pre>Shared failure message</pre>\n> > [View](https://example.com/build_url_1) the CI Build\n> \n> </details>\n\n\n> <pre>\n> Other Class Name\x1ftest_name2\n> </pre>\n> <details><summary>Stack Traces | 3s run time</summary>\n> \n> > <pre>Shared failure message</pre>\n> > [View](https://example.com/build_url_2) the CI Build\n> \n> </details>\n\n\n> <pre>\n> Class Name\x1ftest_name0\n> </pre>\n> <details><summary>Stack Traces | 4s run time</summary>\n> \n> > <pre>&lt;pre&gt;Fourth <br><br>&lt;/pre&gt; | test  | instance |</pre>\n> > [View](https://example.com/build_url_3) the CI Build\n> \n> </details>\n\n</details>\n\nTo view individual test run time comparison to the main branch, go to the [Test Analytics Dashboard](https://app.codecov.io/gh/joseph-sentry/codecov-demo/tests/main)",
+            "### :x: 4 Tests Failed:\n| Tests completed | Failed | Passed | Skipped |\n|---|---|---|---|\n| 4 | 4 | 0 | 0 |\n<details><summary>View the top 3 failed tests by shortest run time</summary>\n\n> ```\n> test_name1\n> ```\n> <details><summary>Stack Traces | 2s run time</summary>\n> \n> > ```\n> > Shared \n> > \n> > \n> > \n> >  &lt;pre&gt; \n> >  \n> > \n> >  | test | test | test &lt;/pre&gt;failure message\n> > ```\n> > [View](https://example.com/build_url_1) the CI Build\n> \n> </details>\n\n\n> ```\n> Other Class Name test_name2\n> ```\n> <details><summary>Stack Traces | 3s run time</summary>\n> \n> > ```\n> > Shared \n> > \n> > \n> > \n> >  &lt;pre&gt; \n> >  \n> > \n> >  | test | test | test &lt;/pre&gt;failure message\n> > ```\n> > [View](https://example.com/build_url_2) the CI Build\n> \n> </details>\n\n\n> ```\n> Class Name test_name0\n> ```\n> <details><summary>Stack Traces | 4s run time</summary>\n> \n> > ```\n> > &lt;pre&gt;Fourth \n> > \n> > &lt;/pre&gt; | test  | instance |\n> > ```\n> > [View](https://example.com/build_url_3) the CI Build\n> \n> </details>\n\n</details>\n\nTo view individual test run time comparison to the main branch, go to the [Test Analytics Dashboard](https://app.codecov.io/gh/test-username/test-repo-name/tests/main)",
         )
 
         mock_metrics.incr.assert_has_calls(
@@ -551,7 +551,7 @@ def test_upload_finisher_task_call_existing_comment(
         mock_repo_provider_comments.edit_comment.assert_called_with(
             pull.pullid,
             1,
-            "### :x: 4 Tests Failed:\n| Tests completed | Failed | Passed | Skipped |\n|---|---|---|---|\n| 4 | 4 | 0 | 0 |\n<details><summary>View the top 3 failed tests by shortest run time</summary>\n\n> <pre>\n> test_name1\n> </pre>\n> <details><summary>Stack Traces | 2s run time</summary>\n> \n> > <pre>Shared failure message</pre>\n> > [View](https://example.com/build_url_1) the CI Build\n> \n> </details>\n\n\n> <pre>\n> Other Class Name\x1ftest_name2\n> </pre>\n> <details><summary>Stack Traces | 3s run time</summary>\n> \n> > <pre>Shared failure message</pre>\n> > [View](https://example.com/build_url_2) the CI Build\n> \n> </details>\n\n\n> <pre>\n> Class Name\x1ftest_name0\n> </pre>\n> <details><summary>Stack Traces | 4s run time</summary>\n> \n> > <pre>&lt;pre&gt;Fourth <br><br>&lt;/pre&gt; | test  | instance |</pre>\n> > [View](https://example.com/build_url_3) the CI Build\n> \n> </details>\n\n</details>\n\nTo view individual test run time comparison to the main branch, go to the [Test Analytics Dashboard](https://app.codecov.io/gh/joseph-sentry/codecov-demo/tests/main)",
+            "### :x: 4 Tests Failed:\n| Tests completed | Failed | Passed | Skipped |\n|---|---|---|---|\n| 4 | 4 | 0 | 0 |\n<details><summary>View the top 3 failed tests by shortest run time</summary>\n\n> ```\n> test_name1\n> ```\n> <details><summary>Stack Traces | 2s run time</summary>\n> \n> > ```\n> > Shared \n> > \n> > \n> > \n> >  &lt;pre&gt; \n> >  \n> > \n> >  | test | test | test &lt;/pre&gt;failure message\n> > ```\n> > [View](https://example.com/build_url_1) the CI Build\n> \n> </details>\n\n\n> ```\n> Other Class Name test_name2\n> ```\n> <details><summary>Stack Traces | 3s run time</summary>\n> \n> > ```\n> > Shared \n> > \n> > \n> > \n> >  &lt;pre&gt; \n> >  \n> > \n> >  | test | test | test &lt;/pre&gt;failure message\n> > ```\n> > [View](https://example.com/build_url_2) the CI Build\n> \n> </details>\n\n\n> ```\n> Class Name test_name0\n> ```\n> <details><summary>Stack Traces | 4s run time</summary>\n> \n> > ```\n> > &lt;pre&gt;Fourth \n> > \n> > &lt;/pre&gt; | test  | instance |\n> > ```\n> > [View](https://example.com/build_url_3) the CI Build\n> \n> </details>\n\n</details>\n\nTo view individual test run time comparison to the main branch, go to the [Test Analytics Dashboard](https://app.codecov.io/gh/test-username/test-repo-name/tests/main)",
         )
 
         assert expected_result == result
@@ -677,7 +677,7 @@ def test_upload_finisher_task_call_with_flaky(
 
         mock_repo_provider_comments.post_comment.assert_called_with(
             pull.pullid,
-            "### :x: 4 Tests Failed:\n| Tests completed | Failed | Passed | Skipped |\n|---|---|---|---|\n| 4 | 4 | 0 | 0 |\n<details><summary>View the top 2 failed tests by shortest run time</summary>\n\n> <pre>\n> test_name1\n> </pre>\n> <details><summary>Stack Traces | 2s run time</summary>\n> \n> > <pre>Shared failure message</pre>\n> > [View](https://example.com/build_url_1) the CI Build\n> \n> </details>\n\n\n> <pre>\n> Class Name\x1ftest_name0\n> </pre>\n> <details><summary>Stack Traces | 4s run time</summary>\n> \n> > <pre>&lt;pre&gt;Fourth <br><br>&lt;/pre&gt; | test  | instance |</pre>\n> > [View](https://example.com/build_url_3) the CI Build\n> \n> </details>\n\n</details>\n<details><summary>View the full list of 1 :snowflake: flaky tests</summary>\n\n> <pre>\n> Other Class Name\x1ftest_name2\n> </pre>\n> **Flake rate in main:** 40.0% (Passed 3 times, Failed 2 times)\n> <details><summary>Stack Traces | 3s run time</summary>\n> \n> > <pre>Shared failure message</pre>\n> > [View](https://example.com/build_url_2) the CI Build\n> \n> </details>\n\n</details>\n\nTo view individual test run time comparison to the main branch, go to the [Test Analytics Dashboard](https://app.codecov.io/gh/joseph-sentry/codecov-demo/tests/main)",
+            "### :x: 4 Tests Failed:\n| Tests completed | Failed | Passed | Skipped |\n|---|---|---|---|\n| 4 | 4 | 0 | 0 |\n<details><summary>View the top 2 failed tests by shortest run time</summary>\n\n> ```\n> test_name1\n> ```\n> <details><summary>Stack Traces | 2s run time</summary>\n> \n> > ```\n> > Shared \n> > \n> > \n> > \n> >  &lt;pre&gt; \n> >  \n> > \n> >  | test | test | test &lt;/pre&gt;failure message\n> > ```\n> > [View](https://example.com/build_url_1) the CI Build\n> \n> </details>\n\n\n> ```\n> Class Name test_name0\n> ```\n> <details><summary>Stack Traces | 4s run time</summary>\n> \n> > ```\n> > &lt;pre&gt;Fourth \n> > \n> > &lt;/pre&gt; | test  | instance |\n> > ```\n> > [View](https://example.com/build_url_3) the CI Build\n> \n> </details>\n\n</details>\n<details><summary>View the full list of 1 :snowflake: flaky tests</summary>\n\n> ```\n> Other Class Name test_name2\n> ```\n> **Flake rate in main:** 40.0% (Passed 3 times, Failed 2 times)\n> <details><summary>Stack Traces | 3s run time</summary>\n> \n> > ```\n> > Shared \n> > \n> > \n> > \n> >  &lt;pre&gt; \n> >  \n> > \n> >  | test | test | test &lt;/pre&gt;failure message\n> > ```\n> > [View](https://example.com/build_url_2) the CI Build\n> \n> </details>\n\n</details>\n\nTo view individual test run time comparison to the main branch, go to the [Test Analytics Dashboard](https://app.codecov.io/gh/test-username/test-repo-name/tests/main)",
         )
 
         mock_metrics.incr.assert_has_calls(