SONARJAVA-4557 Add missing dependencies to Writing Custom Java Rules 101

irina-batinic-sonarsource · web-flow · commit 99bb080aff0f · 2023-08-01T10:05:27.000+02:00
diff --git a/docs/java-custom-rules-example/pom.xml b/docs/java-custom-rules-example/pom.xml
@@ -24,18 +24,14 @@
     <dependency>
       <groupId>org.sonarsource.api.plugin</groupId>
       <artifactId>sonar-plugin-api</artifactId>
+      <version>9.9.0.229</version>
       <scope>provided</scope>
     </dependency>
     <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-api</artifactId>
       <scope>provided</scope>
     </dependency>
-    <dependency>
-      <groupId>org.sonarsource.api.plugin</groupId>
-      <artifactId>sonar-plugin-api-test-fixtures</artifactId>
-      <scope>test</scope>
-    </dependency>
     <dependency>
       <groupId>org.sonarsource.java</groupId>
       <artifactId>sonar-java-plugin</artifactId>
@@ -63,6 +59,12 @@
       <scope>test</scope>
     </dependency>
 
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-migrationsupport</artifactId>
+      <scope>test</scope>
+    </dependency>
+
     <dependency>
       <groupId>org.assertj</groupId>
       <artifactId>assertj-core</artifactId>
diff --git a/docs/java-custom-rules-example/src/main/java/org/sonar/samples/java/checks/AvoidBrandInMethodNamesRule.java b/docs/java-custom-rules-example/src/main/java/org/sonar/samples/java/checks/AvoidBrandInMethodNamesRule.java
@@ -5,8 +5,8 @@
 package org.sonar.samples.java.checks;
 
 import java.util.Locale;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.sonar.api.utils.log.Logger;
+import org.sonar.api.utils.log.Loggers;
 import org.sonar.check.Rule;
 import org.sonar.plugins.java.api.JavaFileScanner;
 import org.sonar.plugins.java.api.JavaFileScannerContext;
@@ -17,7 +17,7 @@
 @Rule(key = "AvoidBrandInMethodNames")
 public class AvoidBrandInMethodNamesRule extends BaseTreeVisitor implements JavaFileScanner {
 
-  private static final Logger LOGGER = LoggerFactory.getLogger(AvoidBrandInMethodNamesRule.class);
+  private static final Logger LOGGER = Loggers.get(AvoidBrandInMethodNamesRule.class);
 
   private JavaFileScannerContext context;
 
diff --git a/docs/java-custom-rules-example/src/main/java/org/sonar/samples/java/checks/SecurityAnnotationMandatoryRule.java b/docs/java-custom-rules-example/src/main/java/org/sonar/samples/java/checks/SecurityAnnotationMandatoryRule.java
@@ -5,8 +5,8 @@
 package org.sonar.samples.java.checks;
 
 import java.util.List;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.sonar.api.utils.log.Logger;
+import org.sonar.api.utils.log.Loggers;
 import org.sonar.check.Rule;
 import org.sonar.check.RuleProperty;
 import org.sonar.plugins.java.api.JavaFileScanner;
@@ -26,7 +26,7 @@
 @Rule(key = "SecurityAnnotationMandatory")
 public class SecurityAnnotationMandatoryRule extends BaseTreeVisitor implements JavaFileScanner {
 
-  private static final Logger LOGGER = LoggerFactory.getLogger(SecurityAnnotationMandatoryRule.class);
+  private static final Logger LOGGER = Loggers.get(SecurityAnnotationMandatoryRule.class);
 
   private static final String DEFAULT_VALUE = "MySecurityAnnotation";
 
diff --git a/docs/java-custom-rules-example/src/test/java/org/sonar/samples/java/checks/AvoidBrandInMethodNamesRuleTest.java b/docs/java-custom-rules-example/src/test/java/org/sonar/samples/java/checks/AvoidBrandInMethodNamesRuleTest.java
@@ -4,17 +4,19 @@
  */
 package org.sonar.samples.java.checks;
 
+import org.junit.Rule;
 import org.junit.jupiter.api.Test;
-import org.junit.jupiter.api.extension.RegisterExtension;
-import org.slf4j.event.Level;
-import org.sonar.api.testfixtures.log.LogTesterJUnit5;
+import org.junit.jupiter.migrationsupport.rules.EnableRuleMigrationSupport;
+import org.sonar.api.utils.log.LogTester;
+import org.sonar.api.utils.log.LoggerLevel;
 import org.sonar.java.checks.verifier.CheckVerifier;
 
+@EnableRuleMigrationSupport
 class AvoidBrandInMethodNamesRuleTest {
 
   // Set a LogTester to see the Syntax Tree when running tests and executing the rule
-  @RegisterExtension
-  public LogTesterJUnit5 logTester = new LogTesterJUnit5().setLevel(Level.DEBUG);
+  @Rule
+  public LogTester logTester = new LogTester().setLevel(LoggerLevel.DEBUG);
 
   @Test
   void detected() {
diff --git a/docs/java-custom-rules-example/src/test/java/org/sonar/samples/java/checks/SecurityAnnotationMandatoryRuleTest.java b/docs/java-custom-rules-example/src/test/java/org/sonar/samples/java/checks/SecurityAnnotationMandatoryRuleTest.java
@@ -4,17 +4,19 @@
  */
 package org.sonar.samples.java.checks;
 
+import org.junit.Rule;
 import org.junit.jupiter.api.Test;
-import org.junit.jupiter.api.extension.RegisterExtension;
-import org.slf4j.event.Level;
-import org.sonar.api.testfixtures.log.LogTesterJUnit5;
+import org.junit.jupiter.migrationsupport.rules.EnableRuleMigrationSupport;
+import org.sonar.api.utils.log.LogTester;
+import org.sonar.api.utils.log.LoggerLevel;
 import org.sonar.java.checks.verifier.CheckVerifier;
 
+@EnableRuleMigrationSupport
 class SecurityAnnotationMandatoryRuleTest {
 
   // Set a LogTester to see the Syntax Tree when running tests and executing the rule
-  @RegisterExtension
-  public LogTesterJUnit5 logTester = new LogTesterJUnit5().setLevel(Level.DEBUG);
+  @Rule
+  public LogTester logTester = new LogTester().setLevel(LoggerLevel.DEBUG);
 
   @Test
   void detected() {
