SONARJAVA-5982 Do not raise S106 on compact source files (#5413)

Author: tomasz-tylenda-sonarsource

java-checks-test-sources/default/src/main/java/checks/SystemOutOrErrUsageCheckCompactOnlyMainSample.java

@@ -0,0 +1,5 @@
+void main() {
+  String name = IO.readln("Enter your name: ");
+  IO.println("Hello " + name + "!");
+  System.out.println("Goodbye " + name + "!");
+}

java-checks-test-sources/default/src/main/java/checks/SystemOutOrErrUsageCheckCompactWithClassSample.java

@@ -0,0 +1,21 @@
+void main() {
+  String name = IO.readln("Enter your name: ");
+  IO.println("Hello " + name + "!");
+  System.out.println("Goodbye " + name + "!");
+
+  System.out.println(f(6, 7));
+
+  RegularClass rc = new RegularClass();
+  rc.log("This is a log message.");
+}
+
+int f(int x, int y) {
+  System.err.println("Error: x=" + x + ", y=" + y);
+  return x + y;
+}
+
+class RegularClass {
+  void log(String message) {
+    System.out.println(message);
+  }
+}

java-checks/src/main/java/org/sonar/java/checks/SystemOutOrErrUsageCheck.java

@@ -29,20 +29,36 @@
 @Rule(key = "S106")
 public class SystemOutOrErrUsageCheck extends IssuableSubscriptionVisitor {
 
+  private boolean isCompactSourceFile = false;
+
   @Override
   public List<Tree.Kind> nodesToVisit() {
-    return Collections.singletonList(Tree.Kind.MEMBER_SELECT);
+    return List.of(
+      Tree.Kind.COMPILATION_UNIT,
+      Tree.Kind.IMPLICIT_CLASS,
+      Tree.Kind.MEMBER_SELECT
+    );
   }
 
   @Override
   public void visitNode(Tree tree) {
-    MemberSelectExpressionTree mset = (MemberSelectExpressionTree) tree;
+    if (tree.is(Tree.Kind.COMPILATION_UNIT)) {
+      isCompactSourceFile = false;
+    } else if (tree.is(Tree.Kind.IMPLICIT_CLASS)) {
+      // System.out or System.err is allowed in compact source files.
+      isCompactSourceFile = true;
+    } else if (!isCompactSourceFile && tree instanceof MemberSelectExpressionTree mset) {
+      visitMemberSelectExpression(mset);
+    }
+  }
+
+  private void visitMemberSelectExpression(MemberSelectExpressionTree mset) {
     String name = mset.identifier().name();
 
     if ("out".equals(name) && isSystem(mset.expression())) {
-      reportIssue(tree, "Replace this use of System.out by a logger.");
+      reportIssue(mset, "Replace this use of System.out by a logger.");
     } else if ("err".equals(name) && isSystem(mset.expression())) {
-      reportIssue(tree, "Replace this use of System.err by a logger.");
+      reportIssue(mset, "Replace this use of System.err by a logger.");
     }
   }
 

java-checks/src/test/java/org/sonar/java/checks/SystemOutOrErrUsageCheckTest.java

@@ -29,4 +29,20 @@ void test() {
       .withCheck(new SystemOutOrErrUsageCheck())
       .verifyIssues();
   }
+
+  @Test
+  void test_compact_source_file() {
+    CheckVerifier.newVerifier()
+      .onFile(mainCodeSourcesPath("checks/SystemOutOrErrUsageCheckCompactOnlyMainSample.java"))
+      .withCheck(new SystemOutOrErrUsageCheck())
+      .verifyNoIssues();
+  }
+
+  @Test
+  void test_compact_source_file_with_regular_class() {
+    CheckVerifier.newVerifier()
+      .onFile(mainCodeSourcesPath("checks/SystemOutOrErrUsageCheckCompactWithClassSample.java"))
+      .withCheck(new SystemOutOrErrUsageCheck())
+      .verifyNoIssues();
+  }
 }