-
Notifications
You must be signed in to change notification settings - Fork 288
Add analyzer to detect assertions in catch blocks (MSTEST0058) #6801
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Copilot
wants to merge
12
commits into
main
Choose a base branch
from
copilot/remove-asserts-in-catch-blocks
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+607
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Evangelink <[email protected]>
Co-authored-by: Evangelink <[email protected]>
Copilot
AI
changed the title
[WIP] Refactor analyzer to disallow asserts in catch blocks
Add analyzer to detect assertions in catch blocks (MSTEST0058)
Oct 26, 2025
Copilot finished work on behalf of
Evangelink
October 26, 2025 10:01
Evangelink
reviewed
Oct 26, 2025
src/Analyzers/MSTest.Analyzers/AvoidAssertsInCatchBlocksAnalyzer.cs
Outdated
Show resolved
Hide resolved
Youssef1313
reviewed
Oct 26, 2025
src/Analyzers/MSTest.Analyzers/AvoidAssertsInCatchBlocksAnalyzer.cs
Outdated
Show resolved
Hide resolved
Youssef1313
reviewed
Oct 26, 2025
Co-authored-by: Youssef Victor <[email protected]>
Evangelink
reviewed
Oct 27, 2025
nohwnd
reviewed
Oct 27, 2025
Co-authored-by: Jakub Jareš <[email protected]>
Co-authored-by: Evangelink <[email protected]>
Copilot finished work on behalf of
Evangelink
October 27, 2025 12:43
…ub.com/microsoft/testfx into copilot/remove-asserts-in-catch-blocks
Evangelink
approved these changes
Oct 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Developers commonly write assertions inside catch blocks intending to verify exception behavior. This pattern is flawed: if no exception is thrown, the test passes silently since the catch block never executes.
Changes
AvoidAssertsInCatchBlocksAnalyzerdetectsAssert,StringAssert, andCollectionAssertcalls within catch blocks by walking theIOperationtree to findICatchClauseOperationancestorsDiagnostic Details
ID: MSTEST0058
Severity: Info (informational diagnostic, not a warning)
Message: "Do not use asserts in catch blocks because they may not fail the test if no exception is thrown"
Recommendation: Use
Assert.ThrowsExceptionorAssert.ThrowsExceptionAsyncto verify exceptions, then assert on the returned exception object outside the try-catch blockOriginal prompt
<issue_description>I have seen developers doing this pattern a lot.
The developer intent is usually "assert that the code throws, and assert some stuff later" (assertions may or may not use the exception object).
The reality is, this doesn't really assert that the code throws. If the code didn't throw at all, the test will still pass.
Such patterns make the tests very hard to read and understand, and can easily lead to bugs in production that are not caught by tests.
FYI @stan-sz :)</issue_description>
Comments on the Issue (you are @copilot in this section)
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.