SONARJAVA-5291 Create rule S7177: @DirtiesContext should be properly configured

rules/S7177/java/metadata.json

@@ -0,0 +1,23 @@
+{
+  "title": "@DirtiesContext should be properly configured",
+  "type": "CODE_SMELL",
+  "status": "ready",
+  "remediation": {
+    "func": "Constant\/Issue",
+    "constantCost": "5min"
+  },
+  "tags": [
+  ],
+  "defaultSeverity": "Major",
+  "ruleSpecification": "RSPEC-7177",
+  "sqKey": "S7177",
+  "scope": "Tests",
+  "defaultQualityProfiles": ["Sonar way"],
+  "quickfix": "unknown",
+  "code": {
+    "impacts": {
+      "RELIABILITY": "MEDIUM"
+    },
+    "attribute": "LOGICAL"
+  }
+}

rules/S7177/java/rule.adoc

@@ -0,0 +1,50 @@
+The `@DirtiesContext` annotation configuration should make sense with the appropriate mode for the target scope.
+
+== Why is this an issue?
+
+The `@DirtiesContext` annotation marks the ApplicationContext as dirty and indicates that it should be cleared and recreated. 
+This is important in tests that modify the context, such as altering the state of singleton beans or databases. 
+However, improper use of the test phase configurations (such as `classMode` or `methodMode`) can lead to redundant or unnecessary context reloads, 
+potentially impacting performance or leading to incorrect test behavior.
+
+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 triggers unnecessary context reloads increasing test execution time.
+This redundancy wastes resources, increases test execution time, and could lead to unexpected test failures.
+
+Also, configuring the `methodMode` at the class level or the `classMode` at the method level does not have meaning and will not have the expected behavior.
+
+This rule will raise an issue when the incorrect mode is configured on a @DirtiesContext annotation targeting a different scope.
+
+== How to fix it
+
+=== Code examples
+
+==== Noncompliant code example
+
+[source,java,diff-id=1,diff-type=noncompliant]
+----
+@ContextConfiguration
+@DirtiesContext(methodMode = MethodMode.AFTER_METHOD) // Noncompliant, for class-level control, use classMode instead.
+public class TestClass {
+  @DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_CLASS) // Non compliant, for method-level control use methodMode instead
+  public void test() {...}
+}
+----
+
+==== Compliant solution
+
+[source,java,diff-id=1,diff-type=compliant]
+----
+@ContextConfiguration
+@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_CLASS)
+public class TestClass {
+  @DirtiesContext(methodMode = MethodMode.AFTER_METHOD)
+  public void test() {...}
+}
+----
+
+== Resources
+
+=== Documentation
+
+* Spring documentation - https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/test/annotation/DirtiesContext.html[@DirtiesContext]

rules/S7177/metadata.json

@@ -0,0 +1,2 @@
+{
+}