SONARJAVA-5291 Create rule S7177: @DirtiesContext should be properly configured #4610
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
leonardo-pilastri-sonarsource
force-pushed
the
rule/add-RSPEC-S7177
branch
from
3cdb736 to
4f435f1
Compare
leonardo-pilastri-sonarsource
changed the title
leonardo-pilastri-sonarsource
force-pushed
the
rule/add-RSPEC-S7177
branch
from
4f435f1 to
830a23e
Compare
rules/S7177/java/rule.adoc
Outdated
| [source,java,diff-id=1,diff-type=compliant] | ||
| ---- | ||
| @ContextConfiguration | ||
| @DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_CLASS) // Noncompliant, for class-level control, use classMode instead. |
There was a problem hiding this comment.
I think there is a typo, it should not be non compliant
rules/S7177/java/rule.adoc
Outdated
| @ContextConfiguration | ||
| @DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_CLASS) // Noncompliant, for class-level control, use classMode instead. | ||
| public class TestClass { | ||
| @DirtiesContext(methodMode = MethodMode.AFTER_METHOD) // Noncompliant, for method-level control use methodMode instead |
There was a problem hiding this comment.
I think there is a typo, it should not be non compliant
rules/S7177/java/rule.adoc
Outdated
| == Why is this an issue? | ||
|
|
||
| Misusing `@DirtiesContext` by selecting incorrect `classMode` and `methodMode` values can result in unnecessary context reloads. | ||
| For example, using `BEFORE_EACH_TEST_METHOD` at the class level along with `AFTER_METHOD` at the method level can result in the context being reloaded |
There was a problem hiding this comment.
| For example, using `BEFORE_EACH_TEST_METHOD` at the class level along with `AFTER_METHOD` at the method level can result in the context being reloaded | |
| For example, using `BEFORE_EACH_TEST_METHOD` at the class level with `AFTER_METHOD` at the method level triggers unnecessary context reloads increasing test execution time. |
I think we can be more direct it is not hypothetical and it is better to keep 1 sentence on the same line. It makes better diff afterwards in git.
leonardo-pilastri-sonarsource
changed the title
rules/S7177/java/metadata.json
Outdated
| @@ -0,0 +1,23 @@ | |||
| { | |||
| "title": "@DirtiesContext should be properly configured", | |||
There was a problem hiding this comment.
I think it would be clearer to use: Use appropriate @DirtiesContext mode or something similar
rules/S7177/java/rule.adoc
Outdated
| @@ -0,0 +1,45 @@ | |||
| The `@DirtiesContext` annotation configuration should make sense with the appropriate mode for the target scope. | |||
There was a problem hiding this comment.
I think, we can remove this part
rules/S7177/java/rule.adoc
Outdated
| This is important in tests that modify the context, such as altering the state of singleton beans or databases. | ||
|
|
||
| Misconfiguring `@DirtiesContext` by selecting incorrect `classMode` and `methodMode` values will make the annotation have no effect. | ||
| Setting the `methodMode` at the class level or the `classMode` at the method level does not have meaning and will not trigger the expected behavior. |
There was a problem hiding this comment.
I think we can merge the two sentences :
Misconfiguring @DirtiesContext by setting the methodMode at the class level or the classMode at the method level will make the annotation have no effect.
|
|
You can preview this rule here (updated a few minutes after each push).
Review
A dedicated reviewer checked the rule description successfully for: