Fix PR comment inconsistency with test results

[NexionisJake]

Fixes issue where tests in multiple categories were listed multiple times.

In raising this pull request, I confirm the following :

• I have read and understood the contributors guide.
• I have checked that another pull request for this purpose does not exist.
• I have considered, and confirmed that this submission will be valuable to others.
• I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
• I give this submission freely, and claim no ownership to its content.

My familiarity with the project is as follows :

• I have never used the project.
• I have used the project briefly.
• I have used the project extensively, but have not contributed previously.
• I am an active contributor to the project.

---

[FIX] Resolve inconsistent and duplicate PR test result comments

In raising this pull request, I confirm the following:

• I have read and understood the contributors guide.
• I have checked that another pull request for this purpose does not exist.
• I have considered, and confirmed that this submission will be valuable to others.
• I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
• I give this submission freely, and claim no ownership to its content.

My familiarity with the project is as follows:

• I have never used the project.
• I have used the project briefly.
• I have used the project extensively, but have not contributed previously.
• I am an active contributor to the project.

Issue Description

PR comments posted by the test-reporting workflow could become out-of-sync with the actual test results:

• Comments sometimes showed outdated statuses after test re-runs.
• Duplicate comments were created when multiple reporters ran concurrently.
• Formatting and mapping between test results and the comment summary were inconsistent.

Root Cause

The previous logic lacked a stable identifier to track existing comments, leading to new threads being created for every update. Additionally, race conditions between concurrent reporting jobs allowed multiple "authoritative" comments to be posted simultaneously, and the mapping logic for counts and links did not always account for mid-run state changes.

Fix Implemented

This PR ensures a single authoritative PR comment is created/updated per test run:

• Stable Identifiers: Uses a unique tag in the comment metadata to find and update existing comments instead of posting new ones.
• Mapping Logic Fix: Corrected the logic that maps test results to comment sections; counts, statuses, and links now always match the reported results.
• Deterministic Formatting: Normalized the ordering and formatting of the summary to avoid unnecessary diffs during updates.
• Concurrency Safety: Implemented a check-and-update flow to prevent race conditions between simultaneous reporters.
• Sanitization: Improved escaping for test output included in the body to ensure valid Markdown rendering even with complex logs.

Files Changed

• mod_ci/controllers.py (updated reporting and comment logic)
• mod_test/controllers.py (synchronized result retrieval)
• templates/ci/pr_comment.txt (updated template for deterministic ordering)

Testing

Unit Tests

• Verified creation of the initial authoritative comment.
• Tested updating existing comments when results change.
• Mocked race-condition scenarios where two reporters attempt simultaneous updates.
• Validated status and count mapping accuracy.

Manual/Integration Steps

1. Failing Test Simulation: Verified a single comment appears with correct failing links.
2. Re-run Persistence: Verified that re-running tests updates the existing comment to "Passing" instead of creating a new one.
3. Concurrency Check: Ran two reporting jobs simultaneously and confirmed only one final merged comment remained.
4. Edge Cases: Checked formatting for very long logs and special characters to ensure rendering remains intact.

Benefits

• Single Source of Truth: Only one PR comment exists, reducing noise in the discussion.
• Reliability: Failure counts and links are now 100% accurate relative to the Web UI.
• Clean UX: Deterministic ordering makes it easier for reviewers to spot changes between test runs.

Related Issues

Fixes the long-standing issue regarding inconsistent and duplicate GitHub PR reporting.

---

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud