SONARJAVA-6093 Implement S3051 checking the signature of the main method. (#5442)

Author: tomasz-tylenda-sonarsource

its/autoscan/src/test/resources/autoscan/diffs/diff_S3051.json

@@ -0,0 +1,6 @@
+{
+  "ruleKey": "S3051",
+  "hasTruePositives": true,
+  "falseNegatives": 0,
+  "falsePositives": 0
+}

java-checks-test-sources/default/src/main/java/checks/mainSignature/CompactSource.java

@@ -0,0 +1,7 @@
+void main() {
+  IO.println("compact source");
+}
+
+int main(int i) { // Noncompliant
+  return i * 2;
+}

java-checks-test-sources/default/src/main/java/checks/mainSignature/MainJava21.java

@@ -0,0 +1,12 @@
+package checks.mainSignature;
+
+public class MainJava21 {
+  public static void main(String[] args) { // Compliant
+  }
+
+  void main() { // Noncompliant
+  }
+
+  void main(int args) { // Noncompliant
+  }
+}

java-checks-test-sources/default/src/main/java/checks/mainSignature/NonInstantiable.java

@@ -0,0 +1,15 @@
+package checks.mainSignature;
+
+interface NonInstantiable {
+  int multiply(int a, int b);
+
+  default void main() { // Compliant
+    System.out.println("default");
+  }
+
+  int main(int a); // Noncompliant
+
+  static void main(String[] arg) { // Compliant
+    System.out.println("yep, inside an interface");
+  }
+}

java-checks-test-sources/default/src/main/java/checks/mainSignature/PrivateMain.java

@@ -0,0 +1,9 @@
+package checks.mainSignature;
+
+public class PrivateMain {
+  private static void main(String[] args) { // Noncompliant
+  }
+
+  private void main() { // Noncompliant
+  }
+}

java-checks-test-sources/default/src/main/java/checks/mainSignature/Sample.java

@@ -0,0 +1,66 @@
+package checks.mainSignature;
+
+public class Sample {
+  public static class Traditional {
+    public static void main(String[] args) { // Compliant
+      System.out.println("traditional");
+    }
+  }
+
+  public static class NoArg {
+    public static void main() { // Compliant
+      System.out.println("no arg");
+    }
+  }
+
+  public static class Instance {
+    void main(String[] args) { // Compliant
+      System.out.println("instance");
+    }
+  }
+
+  public static class Wrong {
+    public static void main(String[] args) {
+      System.out.println(new Wrong().main(42));
+    }
+
+    int main(int x) { // Noncompliant
+//      ^^^^
+      return x * x;
+    }
+
+    String main(String x, String y) { // Noncompliant
+//         ^^^^
+      return "";
+    }
+  }
+
+  public static class WrongReturn {
+    public static int main(String[] args) { // Noncompliant
+//                    ^^^^
+      return 1;
+    }
+  }
+
+  @interface MyAnnotation {
+    String main() default ""; // Noncompliant
+//         ^^^^
+  }
+
+  enum MyEnum {
+    A, B;
+
+    void main(int x) { // Noncompliant
+//       ^^^^
+    }
+  }
+
+  record MyRecord(int value) {
+    void main(int x) { // Noncompliant
+//       ^^^^
+    }
+
+    static void main(String[] args) {
+    }
+  }
+}

java-checks-test-sources/default/src/main/java/checks/mainSignature/Varargs.java

@@ -0,0 +1,10 @@
+package checks.mainSignature;
+
+public class Varargs {
+  void main(String... args) {
+  }
+
+  void main(int i, String ... args) { // Noncompliant
+
+  }
+}

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

@@ -0,0 +1,10 @@
+package checks.mainSignature;
+
+// This one is really weird. Doesn't really matter what we report,
+// as long as nothing crashes.
+
+public class main {
+  public main() {}
+
+  public main(String[] args) {}
+}

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

@@ -0,0 +1,51 @@
+/*
+ * SonarQube Java
+ * Copyright (C) 2012-2025 SonarSource Sàrl
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the Sonar Source-Available License for more details.
+ *
+ * You should have received a copy of the Sonar Source-Available License
+ * along with this program; if not, see https://sonarsource.com/license/ssal/
+ */
+package org.sonar.java.checks;
+
+import java.util.List;
+import org.sonar.check.Rule;
+import org.sonar.java.checks.helpers.MethodTreeUtils;
+import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
+import org.sonar.plugins.java.api.tree.MethodTree;
+import org.sonar.plugins.java.api.tree.Tree;
+
+
+/**
+ * Checks that the "main" method has the correct signature for a program entry point.
+ *
+ * <p>Note, that even with a correct signature, the "main" method may not be valid entry point.
+ * For example, it may be declared in an abstract class or an interface.
+ */
+@Rule(key = "S3051")
+public class MainMethodSignatureCheck extends IssuableSubscriptionVisitor {
+
+  private static final String MESSAGE = "\"main\" method should only be used for the program entry point and should have appropriate signature.";
+
+  @Override
+  public List<Tree.Kind> nodesToVisit() {
+    return List.of(Tree.Kind.METHOD);
+  }
+
+  @Override
+  public void visitNode(Tree tree) {
+    MethodTree methodTree = (MethodTree) tree;
+    if ("main".equals(methodTree.simpleName().name())
+      && !MethodTreeUtils.isMainMethod(methodTree, context.getJavaVersion())) {
+      reportIssue(methodTree.simpleName(), MESSAGE);
+    }
+  }
+}

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

@@ -0,0 +1,89 @@
+/*
+ * SonarQube Java
+ * Copyright (C) 2012-2025 SonarSource Sàrl
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the Sonar Source-Available License for more details.
+ *
+ * You should have received a copy of the Sonar Source-Available License
+ * along with this program; if not, see https://sonarsource.com/license/ssal/
+ */
+package org.sonar.java.checks;
+
+import org.junit.jupiter.api.Test;
+import org.sonar.java.checks.verifier.CheckVerifier;
+
+import static org.sonar.java.checks.verifier.TestUtils.mainCodeSourcesPath;
+
+class MainMethodSignatureCheckTest {
+
+  private static final MainMethodSignatureCheck CHECK = new MainMethodSignatureCheck();
+
+  @Test
+  void test() {
+    CheckVerifier.newVerifier()
+      .onFile(mainCodeSourcesPath("checks/mainSignature/Sample.java"))
+      .withCheck(CHECK)
+      .withJavaVersion(25)
+      .verifyIssues();
+  }
+
+  @Test
+  void test_java21() {
+    CheckVerifier.newVerifier()
+      .onFile(mainCodeSourcesPath("checks/mainSignature/MainJava21.java"))
+      .withCheck(CHECK)
+      .withJavaVersion(21)
+      .verifyIssues();
+  }
+
+  @Test
+  void nonInstantiable() {
+    CheckVerifier.newVerifier()
+      .onFile(mainCodeSourcesPath("checks/mainSignature/NonInstantiable.java"))
+      .withCheck(CHECK)
+      .withJavaVersion(25)
+      .verifyIssues();
+  }
+
+  @Test
+  void privateMain() {
+    CheckVerifier.newVerifier()
+      .onFile(mainCodeSourcesPath("checks/mainSignature/PrivateMain.java"))
+      .withCheck(CHECK)
+      .verifyIssues();
+  }
+
+  @Test
+  void compactSource() {
+    CheckVerifier.newVerifier()
+      .onFile(mainCodeSourcesPath("checks/mainSignature/CompactSource.java"))
+      .withCheck(CHECK)
+      .withJavaVersion(25)
+      .verifyIssues();
+  }
+
+  @Test
+  void varargs() {
+    CheckVerifier.newVerifier()
+      .onFile(mainCodeSourcesPath("checks/mainSignature/Varargs.java"))
+      .withCheck(CHECK)
+      .withJavaVersion(25)
+      .verifyIssues();
+  }
+
+  @Test
+  void constructor() {
+    // The check will not run, because it does not visit constructor nodes.
+    CheckVerifier.newVerifier()
+      .onFile(mainCodeSourcesPath("checks/mainSignature/main.java"))
+      .withCheck(CHECK)
+      .verifyNoIssues();
+  }
+}