Fix S3431 FP: Don't raise if assertions are done in catch or finally #9615
Conversation
This file contains 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
analyzers/src/SonarAnalyzer.CSharp/Rules/ExpectedExceptionAttributeShouldNotBeUsed.cs
Outdated
Show resolved
Hide resolved
...yzers/tests/SonarAnalyzer.Test/TestCases/ExpectedExceptionAttributeShouldNotBeUsed.MsTest.cs
Outdated
Show resolved
Hide resolved
zsolt-kolbay-sonarsource
suggested changes
Aug 8, 2024
analyzers/src/SonarAnalyzer.CSharp/Rules/ExpectedExceptionAttributeShouldNotBeUsed.cs
Outdated
Show resolved
Hide resolved
| @@ -35,6 +36,7 @@ public abstract class ExpectedExceptionAttributeShouldNotBeUsedBase<TSyntaxKind> | |||
| context.RegisterNodeAction(Language.GeneratedCodeRecognizer, c => | |||
| { | |||
| if (HasMultiLineBody(c.Node) | |||
| && !AssertInCatchFinallyBlock(c.Node) | |||
There was a problem hiding this comment.
The rule will go through every method in a project and do this check with syntax walkers. Even though methods marked with ExpectedException are quite rare.
I'd optimize this rule in two places (this can be done in a separate PR):
- Before calling
AssertInCatchFinallyBlock()check if the method declaration has any attributes calledExpectedException. This can be done on the syntax level. We're going to get a couple of FNs/FPs for some exotic scenarios: aliased attribute, partial test methods. These are quite rare, so I think it's ok. - Before you register the analyzer, check if the project references MsTest or NUnit (with version < 3.0.0).
There was a problem hiding this comment.
I will do in another PR.
analyzers/tests/SonarAnalyzer.Test/Rules/ExpectedExceptionAttributeShouldNotBeUsedTest.cs
Outdated
Show resolved
Hide resolved
analyzers/tests/SonarAnalyzer.Test/Rules/ExpectedExceptionAttributeShouldNotBeUsedTest.cs
Outdated
Show resolved
Hide resolved
...yzers/tests/SonarAnalyzer.Test/TestCases/ExpectedExceptionAttributeShouldNotBeUsed.MsTest.cs
Outdated
Show resolved
Hide resolved
...yzers/tests/SonarAnalyzer.Test/TestCases/ExpectedExceptionAttributeShouldNotBeUsed.MsTest.cs
Outdated
Show resolved
Hide resolved
...yzers/tests/SonarAnalyzer.Test/TestCases/ExpectedExceptionAttributeShouldNotBeUsed.MsTest.cs
Outdated
Show resolved
Hide resolved
analyzers/src/SonarAnalyzer.VisualBasic/Rules/ExpectedExceptionAttributeShouldNotBeUsed.cs
Show resolved
Hide resolved
analyzers/src/SonarAnalyzer.VisualBasic/Rules/ExpectedExceptionAttributeShouldNotBeUsed.cs
Outdated
Show resolved
Hide resolved
analyzers/src/SonarAnalyzer.CSharp/Rules/ExpectedExceptionAttributeShouldNotBeUsed.cs
Outdated
Show resolved
Hide resolved
|
|
zsolt-kolbay-sonarsource
approved these changes
Aug 9, 2024
There was a problem hiding this comment.
LGTM. There's one unresolved comment left. You can either address it here or in a separate PR.
Merged
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.
Fixes #8300
RSPEC PR: SonarSource/rspec#4127