SONARJAVA-6405

java-checks-test-sources/default/src/test/java/checks/tests/OneBeforeEachAfterEachCheckSample.java

@@ -0,0 +1,25 @@
+package checks.tests;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.fail;
+
+class OneBeforeEachAfterEachCheckSample { // Noncompliant {{Only one method should be annotated @Before(Each).}}
+
+  @BeforeEach
+  void setUp1() {
+    // pass
+  }
+
+  @BeforeEach
+  void setUp2() {
+    // pass
+  }
+
+
+  @Test
+  void decoy() {
+    fail("not important");
+  }
+}

java-checks/src/main/java/org/sonar/java/checks/tests/OneBeforeEachAfterEachCheck.java

@@ -0,0 +1,61 @@
+/*
+ * SonarQube Java
+ * Copyright (C) SonarSource Sàrl
+ * mailto:info AT sonarsource DOT com
+ *
+ * You can redistribute and/or modify this program under the terms of
+ * the Sonar Source-Available License Version 1, as published by SonarSource Sàrl.
+ *
+ * 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.tests;
+
+import org.sonar.check.Rule;
+import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
+import org.sonar.plugins.java.api.tree.ClassTree;
+import org.sonar.plugins.java.api.tree.IdentifierTree;
+import org.sonar.plugins.java.api.tree.MethodTree;
+import org.sonar.plugins.java.api.tree.Tree;
+
+import java.util.List;
+
+// FIXME: get a rule id
+@Rule(key = "S3360")
+public class OneBeforeEachAfterEachCheck extends IssuableSubscriptionVisitor {
+
+  private static final String BEFORE_EACH = "org.junit.jupiter.api.BeforeEach";
+  private static final String BEFORE = "org.junit.Before";
+
+  @Override
+  public List<Tree.Kind> nodesToVisit() {
+    return List.of(Tree.Kind.CLASS);
+  }
+
+  @Override
+  public void visitNode(Tree tree) {
+    ClassTree classTree = (ClassTree) tree;
+    IdentifierTree className = classTree.simpleName();
+    if (className == null) {
+      return;
+    }
+    int beforeCount = countAnnotations(BEFORE, classTree);
+    int beforeEachCount = countAnnotations(BEFORE_EACH, classTree);
+    if (beforeCount > 1 || beforeEachCount > 1) {
+      reportIssue(className, "Only one method should be annotated @Before(Each).");
+    }
+  }
+
+  private int countAnnotations(String annotation, ClassTree classTree) {
+    return (int) classTree.members().stream()
+      .filter(member -> member.is(Tree.Kind.METHOD))
+      .map(MethodTree.class::cast)
+      .filter(method -> method.symbol().metadata().isAnnotatedWith(annotation))
+      .count();
+  }
+}

java-checks/src/test/java/org/sonar/java/checks/tests/OneBeforeEachAfterEachCheckTest.java

@@ -0,0 +1,32 @@
+/*
+ * SonarQube Java
+ * Copyright (C) SonarSource Sàrl
+ * mailto:info AT sonarsource DOT com
+ *
+ * You can redistribute and/or modify this program under the terms of
+ * the Sonar Source-Available License Version 1, as published by SonarSource Sàrl.
+ *
+ * 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.tests;
+
+import org.junit.jupiter.api.Test;
+import org.sonar.java.checks.verifier.CheckVerifier;
+
+import static org.sonar.java.checks.verifier.TestUtils.testCodeSourcesPath;
+
+class OneBeforeEachAfterEachCheckTest {
+  @Test
+  void test() {
+    CheckVerifier.newVerifier()
+      .onFile(testCodeSourcesPath("checks/tests/OneBeforeEachAfterEachCheckSample.java"))
+      .withCheck(new OneBeforeEachAfterEachCheck())
+      .verifyIssues();
+  }
+}

sonar-java-plugin/src/main/resources/org/sonar/l10n/java/rules/java/S3360.html

@@ -0,0 +1,19 @@
+<h2>Why is this an issue?</h2>
+<p>By default, the Maven Surefire plugin only executes test classes with names that end in "Test" or "TestCase". Name your class "TestClassX.java",
+for instance, and it will be skipped.</p>
+<p>This rule raises an issue for each test class with a name not ending in "Test" or "TestCase".</p>
+<h3>Noncompliant code example</h3>
+<pre>
+public class TestClassX {  // Noncompliant
+  @Test
+  public void testDoTheThing() {
+    //...
+</pre>
+<h3>Compliant solution</h3>
+<pre>
+public class ClassXTest {
+  @Test
+  public void testDoTheThing() {
+    //...
+</pre>
+

sonar-java-plugin/src/main/resources/org/sonar/l10n/java/rules/java/S3360.json

@@ -0,0 +1,23 @@
+{
+  "title": "Test class names should end with \"Test\" or \"TestCase\"",
+  "type": "CODE_SMELL",
+  "code": {
+    "impacts": {
+      "MAINTAINABILITY": "BLOCKER"
+    },
+    "attribute": "IDENTIFIABLE"
+  },
+  "status": "ready",
+  "remediation": {
+    "func": "Constant\/Issue",
+    "constantCost": "2min"
+  },
+  "tags": [
+    "tests"
+  ],
+  "defaultSeverity": "Blocker",
+  "ruleSpecification": "RSPEC-3360",
+  "sqKey": "S3360",
+  "scope": "Main",
+  "quickfix": "unknown"
+}