Add descriptive text to intermittent comment when we have available runcount data. (#8835)

Author: jmaher

tests/intermittents_commenter/expected_comment.text

@@ -9,5 +9,7 @@ This is the #1 most frequent failure this week.
 |---|:-:|:-:|:-:|
 |**macosx1015-x86_64/debug**| | |1/22|
 
+* x/y indicates test failures and total runs; only x means number of runs is unknown.
+
 ## For more details, see:
 https://treeherder.mozilla.org/intermittent-failures/bugdetails?bug=1&startday=2022-05-09&endday=2025-05-10&tree=all

tests/intermittents_commenter/expected_comment_no_runcount.text

@@ -0,0 +1,14 @@
+3 failures were associated with this bug in the last 7 days.
+This is the #1 most frequent failure this week.
+
+## Repository breakdown:
+* mozilla-central: 3
+
+## Table
+| |**a11y_checks+swgl**|**no_variant**|**socketprocess_networking**|**spi-nw**|**swgl**|
+|---|:-:|:-:|:-:|:-:|:-:|
+|**linux1804-x86_64/debug**| | | |1| |
+|**macosx1015-x86_64/debug**| | | |2| |
+
+## For more details, see:
+https://treeherder.mozilla.org/intermittent-failures/bugdetails?bug=1&startday=2025-01-01&endday=2025-05-10&tree=all

tests/intermittents_commenter/expected_comment_with_5_failures.text

@@ -10,5 +10,7 @@ This is the #1 most frequent failure this week.
 |**linux1804-x86_64/debug**| |1| |2/92| |
 |**macosx1015-x86_64/debug**| | | |2/22| |
 
+* x/y indicates test failures and total runs; only x means number of runs is unknown.
+
 ## For more details, see:
 https://treeherder.mozilla.org/intermittent-failures/bugdetails?bug=1&startday=2022-05-09&endday=2025-05-10&tree=all

tests/intermittents_commenter/test_commenter.py

@@ -92,6 +92,50 @@ def test_intermittents_commenter_with_failures(
     assert comment_params[0]["changes"]["comment"]["body"] == expected_comment
 
 
+@responses.activate
+def test_intermittents_commenter_with_no_runcount(
+    bug_data_with_5_failures,
+    mock_test_variants_firefoxci_request,
+    mock_test_manifests_firefoxci_request,
+    mock_testrun_matrix_firefoxci_request,
+    mock_summary_groups_request,
+):
+    startday = "2025-01-01"
+    endday = "2025-05-10"
+    alt_startday = startday
+    alt_endday = endday
+
+    process = Commenter(weekly_mode=True, dry_run=True)
+    params = {"include_fields": "product%2C+component%2C+priority%2C+whiteboard%2C+id"}
+    url = "{}/rest/bug?id={}&include_fields={}".format(
+        settings.BZ_API_URL, bug_data_with_5_failures["bug_id"], params["include_fields"]
+    )
+
+    content = {
+        "bugs": [
+            {
+                "component": "General",
+                "priority": "P3",
+                "product": "Testing",
+                "whiteboard": "[stockwell infra] [see summary at comment 92]",
+                "id": bug_data_with_5_failures["bug_id"],
+            }
+        ],
+        "faults": [],
+    }
+
+    responses.add(responses.Response(method="GET", url=url, json=content, status=200))
+
+    resp = process.fetch_bug_details(bug_data_with_5_failures["bug_id"])
+    assert resp == content["bugs"]
+
+    comment_params = process.generate_bug_changes(startday, endday, alt_startday, alt_endday)
+
+    with open("tests/intermittents_commenter/expected_comment_no_runcount.text") as comment:
+        expected_comment = comment.read()
+    assert comment_params[0]["changes"]["comment"]["body"] == expected_comment
+
+
 def test_get_test_variants(mock_test_variants_firefoxci_request):
     process = Commenter(weekly_mode=True, dry_run=True)
     test_suite = "mochitest-browser-chrome-spi-nw-10"

treeherder/intermittents_commenter/comment.template

@@ -46,5 +46,8 @@ This is the #{{rank}} most frequent failure this week.{% endif %}
     {%- endif -%}
   {%- endfor %}
 {% endfor %}
+{% if has_runcount -%}
+{{"* x/y indicates test failures and total runs; only x means number of runs is unknown.\n"}}
+{% endif -%}
 ## For more details, see:
 https://treeherder.mozilla.org/intermittent-failures/bugdetails?bug={{bug_id}}&startday={{startday}}&endday={{endday}}&tree=all

treeherder/intermittents_commenter/commenter.py

@@ -44,6 +44,7 @@ class BugRunInfo:
 class BugsDetails:
     run_count: dict[str, int] = field(default_factory=dict)  # {job_name: run_count}
     total: int = 0
+    has_runcount: bool = False
     test_variants: set = field(default_factory=set)
     per_repositories: dict[str, int] = field(default_factory=dict)  # {repo1: 1, repo2: 2, ...}
     data_table: dict[str, dict[str, int]] = field(
@@ -148,6 +149,7 @@ def generate_bug_changes(self, startday, endday, alt_startday, alt_endday):
                 repositories=counts.per_repositories,
                 test_variants=sorted(list(counts.test_variants)),
                 data_table=counts.data_table,
+                has_runcount=bug_map[bug_id].has_runcount,
                 startday=startday,
                 endday=endday.split()[0],
                 weekly_mode=self.weekly_mode,
@@ -485,6 +487,8 @@ def build_bug_map(self, bugs, option_collection_map, days):
                 bug_infos.data_table[platform_and_build] = {
                     test_variant: {"count": 1, "runs": run_count},
                 }
+                if run_count > 0:
+                    bug_infos.has_runcount = True
                 bug_map[bug_id] = bug_infos
             else:
                 bug_infos = bug_map[bug_id]
@@ -500,6 +504,8 @@ def build_bug_map(self, bugs, option_collection_map, days):
                     "count": platform_and_build_data.get(test_variant, {}).get("count", 0) + 1,
                     "runs": run_count,
                 }
+                if run_count > 0:
+                    bug_infos.has_runcount = True
 
         return bug_map