SONARJAVA-3703 Drop 'sysout' calls in favor of loggers and move PrinterVisitor

Wohops · quentin-jaquier-sonarsource · commit e71d4b501cfd · 2021-03-09T17:19:30.000+01:00
diff --git a/docs/java-custom-rules-example/src/main/java/org/sonar/samples/java/checks/AvoidAnnotationRule.java b/docs/java-custom-rules-example/src/main/java/org/sonar/samples/java/checks/AvoidAnnotationRule.java
@@ -50,10 +50,7 @@ public class AvoidAnnotationRule extends BaseTreeVisitor implements JavaFileScan
   @Override
   public void scanFile(JavaFileScannerContext context) {
     this.context = context;
-
     scan(context.getTree());
-
-    System.out.println(PrinterVisitor.print(context.getTree()));
   }
 
   @Override
@@ -63,8 +60,6 @@ public void visitMethod(MethodTree tree) {
       TypeTree annotationType = annotationTree.annotationType();
       if (annotationType.is(Tree.Kind.IDENTIFIER)) {
         IdentifierTree identifier = (IdentifierTree) annotationType;
-        System.out.println(identifier.name());
-
         if (identifier.name().equals(name)) {
           context.reportIssue(this, identifier, String.format("Avoid using annotation @%s", name));
         }
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
@@ -20,15 +20,20 @@
 package org.sonar.samples.java.checks;
 
 import java.util.Locale;
+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;
 import org.sonar.plugins.java.api.tree.BaseTreeVisitor;
 import org.sonar.plugins.java.api.tree.MethodTree;
+import org.sonar.samples.java.utils.PrinterVisitor;
 
 @Rule(key = "AvoidBrandInMethodNames")
 public class AvoidBrandInMethodNamesRule extends BaseTreeVisitor implements JavaFileScanner {
 
+  private static final Logger LOGGER = Loggers.get(AvoidBrandInMethodNamesRule.class);
+
   private JavaFileScannerContext context;
 
   protected static final String COMPANY_NAME = "MyCompany";
@@ -41,7 +46,7 @@ public void scanFile(JavaFileScannerContext context) {
     scan(context.getTree());
 
     // For debugging purpose, you can print out the entire AST of the analyzed file
-    System.out.println(PrinterVisitor.print(context.getTree()));
+    PrinterVisitor.print(context.getTree(), LOGGER::debug);
   }
 
   /**
diff --git a/docs/java-custom-rules-example/src/main/java/org/sonar/samples/java/checks/AvoidMethodDeclarationRule.java b/docs/java-custom-rules-example/src/main/java/org/sonar/samples/java/checks/AvoidMethodDeclarationRule.java
@@ -52,9 +52,6 @@ public void scanFile(JavaFileScannerContext context) {
 
     // The call to the scan method on the root of the tree triggers the visit of the AST by this visitor
     scan(context.getTree());
-
-    // For debugging purpose, you can print out the entire AST of the analyzed file
-    System.out.println(PrinterVisitor.print(context.getTree()));
   }
 
   /**
diff --git a/docs/java-custom-rules-example/src/main/java/org/sonar/samples/java/utils/PrinterVisitor.java b/docs/java-custom-rules-example/src/main/java/org/sonar/samples/java/utils/PrinterVisitor.java
@@ -17,16 +17,15 @@
  * along with this program; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
-package org.sonar.samples.java.checks;
+package org.sonar.samples.java.utils;
 
 import java.util.List;
+import java.util.function.Consumer;
 import javax.annotation.Nullable;
 import org.sonar.plugins.java.api.tree.BaseTreeVisitor;
 import org.sonar.plugins.java.api.tree.Tree;
-import org.sonar.samples.java.utils.StringUtils;
 
 public class PrinterVisitor extends BaseTreeVisitor {
-
   private static final int INDENT_SPACES = 2;
 
   private final StringBuilder sb;
@@ -37,10 +36,10 @@ public PrinterVisitor() {
     indentLevel = 0;
   }
 
-  public static String print(Tree tree) {
+  public static void print(Tree tree, Consumer<String> output) {
     PrinterVisitor pv = new PrinterVisitor();
     pv.scan(tree);
-    return pv.sb.toString();
+    output.accept(pv.sb.toString());
   }
 
   private StringBuilder indent() {
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
@@ -20,10 +20,19 @@
 package org.sonar.samples.java.checks;
 
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+import org.sonar.api.utils.log.LogTesterJUnit5;
+import org.sonar.api.utils.log.LoggerLevel;
 import org.sonar.java.checks.verifier.JavaCheckVerifier;
 
+import static org.assertj.core.api.Assertions.assertThat;
+
 class AvoidBrandInMethodNamesRuleTest {
 
+  // Register the logTester, to see the Syntax Tree when running tests and executing the rule
+  @RegisterExtension
+  LogTesterJUnit5 logTester = new LogTesterJUnit5();
+
   @Test
   void detected() {
     // Verifies that the check will raise the adequate issues with the expected message.
@@ -34,4 +43,49 @@ void detected() {
       .withCheck(new AvoidBrandInMethodNamesRule())
       .verifyIssues();
   }
+
+  @Test
+  void printingTreeInDebug() {
+    // Make sure logs are visible during the tests, and at DEBUG level in production
+    logTester.setLevel(LoggerLevel.DEBUG);
+
+    // re-execute the test
+    JavaCheckVerifier.newVerifier()
+    .onFile("src/test/files/AvoidBrandInMethodNamesRule.java")
+    .withCheck(new AvoidBrandInMethodNamesRule())
+    .verifyIssues();
+
+    // verify that the tree has been correctly displayed in DEBUG
+    assertThat(logTester.logs(LoggerLevel.DEBUG))
+      .hasSize(1)
+      .containsOnly("CompilationUnitTree : [\n"
+        + "  ClassTree\n"
+        + "    ModifiersTree\n"
+        + "    IdentifierTree\n"
+        + "    TypeParameters : [\n"
+        + "    VariableTree\n"
+        + "      ModifiersTree\n"
+        + "      PrimitiveTypeTree\n"
+        + "      IdentifierTree\n"
+        + "    MethodTree\n"
+        + "      ModifiersTree\n"
+        + "      TypeParameters\n"
+        + "      PrimitiveTypeTree\n"
+        + "      IdentifierTree\n"
+        + "      BlockTree\n"
+        + "    MethodTree\n"
+        + "      ModifiersTree\n"
+        + "      TypeParameters\n"
+        + "      PrimitiveTypeTree\n"
+        + "      IdentifierTree\n"
+        + "      BlockTree\n"
+        + "    MethodTree\n"
+        + "      ModifiersTree\n"
+        + "      TypeParameters\n"
+        + "      PrimitiveTypeTree\n"
+        + "      IdentifierTree\n"
+        + "      BlockTree\n"
+        + "    ]\n"
+        + "  ]\n");
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -52,9 +52,6 @@ public void scanFile(JavaFileScannerContext context) {`
`52`	`52`
`53`	`53`	`// The call to the scan method on the root of the tree triggers the visit of the AST by this visitor`
`54`	`54`	`scan(context.getTree());`
`55`		`-`
`56`		`- // For debugging purpose, you can print out the entire AST of the analyzed file`
`57`		`- System.out.println(PrinterVisitor.print(context.getTree()));`
`58`	`55`	`}`
`59`	`56`
`60`	`57`	`/**`