如何让SonarQube忽略继承测试方法的空JUnit测试类？

问题场景 #

我有多个实现Handler接口的生产类：NaiveHandler、SmartHandler、AnotherHandler，它们存在大量重复代码，因此我提取了抽象类AbstractHandler封装核心逻辑，让子类继承复用。

对应地，测试类也存在大量重复测试逻辑，于是我将通用测试方法和初始化逻辑移至抽象测试类HandlerTestBase：

abstract class HandlerTestBase {

  protected Handler cut;
  protected SomeDependency x;

  protected abstract Handler getCutInstance(SomeDependency x);

  @BeforeEach
  void setup() {
    x = Mockito.mock(SomeDependency.class);
    cut = getCutInstance(x);
  }

  @Test
  void providesTheRightThing() {
    when(x.getSomeValue()).thenReturn("zzz");
    var result = cut.doSomething("a");
    assertThat(result).isEqualTo("b");
  }

  // 更多验证AbstractHandler通用逻辑的测试方法

}

这个抽象类无法独立运行，名称末尾的"Base"也能避免Maven执行它。实际运行的是各个子类测试类，例如SmartHandlerTest：

class SmartHandlerTest extends HandlerTestBase {

  @Override
  protected Handler getCutInstance(SomeDependency x) {
    return new SmartHandler(x);
  }

  // 仅属于SmartHandler的特定测试方法
  @Test
  void specificClassDoesTheRightThing() {
    when(x.getSomeValue()).thenReturn("12345");
    var result = cut.doSomething("a");
    assertThat(result).isEqualTo("y");
  }

}

但NaiveHandlerTest没有自定义测试方法，仅继承父类测试并实现抽象方法：

class NaiveHandlerTest extends HandlerTestBase {

  @Override
  protected Handler getCutInstance(SomeDependency x) {
    return new NaiveHandler(x);
  }

}

SonarQube无法识别该类继承的父类测试方法，触发代码异味规则java:S2187，提示"无测试方法的JUnit测试类毫无意义"。除了标记误报或添加@SuppressWarnings("java:S2187")，还有以下更优的设计调整方案：

优化方案 #

1. 添加显式的测试方法转发 #

在NaiveHandlerTest中显式重写父类的测试方法并调用父类实现，让SonarQube能直接识别到类中的@Test方法：

class NaiveHandlerTest extends HandlerTestBase {

  @Override
  protected Handler getCutInstance(SomeDependency x) {
    return new NaiveHandler(x);
  }

  @Test
  @Override
  void providesTheRightThing() {
    super.providesTheRightThing();
  }

  // 若父类有多个通用测试，可按需重写转发
}

这种方式简单直接，既保留了继承复用的逻辑，又能让代码检测工具识别到测试方法。

2. 改用参数化测试替代子类继承 #

将通用测试逻辑整合到一个参数化测试类中，直接遍历所有Handler实现进行测试，避免创建空的测试子类：

import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.MethodSource;
import java.util.stream.Stream;

class HandlerTests {

  private SomeDependency x;
  private Handler cut;

  @BeforeEach
  void setup() {
    x = Mockito.mock(SomeDependency.class);
  }

  @ParameterizedTest
  @MethodSource("handlerProviders")
  void providesTheRightThing(Handler handler) {
    this.cut = handler;
    when(x.getSomeValue()).thenReturn("zzz");
    var result = cut.doSomething("a");
    assertThat(result).isEqualTo("b");
  }

  private static Stream<Handler> handlerProviders() {
    SomeDependency mockDep = Mockito.mock(SomeDependency.class);
    return Stream.of(
      new NaiveHandler(mockDep),
      new SmartHandler(mockDep),
      new AnotherHandler(mockDep)
    );
  }

  // 针对SmartHandler的特定测试单独编写
  @Test
  void smartHandlerSpecificBehavior() {
    cut = new SmartHandler(x);
    when(x.getSomeValue()).thenReturn("12345");
    var result = cut.doSomething("a");
    assertThat(result).isEqualTo("y");
  }
}

这种方案减少了测试类的数量，逻辑更集中，同时SonarQube能完全识别所有测试方法。

3. 调整抽象测试类的JUnit注解（辅助优化） #

确保抽象测试类HandlerTestBase带有JUnit的扩展注解（如JUnit 5的@ExtendWith），帮助SonarQube更好地识别子类继承的测试方法：

import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.junit.jupiter.MockitoExtension;

@ExtendWith(MockitoExtension.class)
abstract class HandlerTestBase {
  // 原有代码逻辑
}

部分代码检测工具对带有扩展注解的抽象测试类的子类识别更准确，可作为辅助手段配合其他方案使用。

4. 配置SonarQube规则例外（非代码调整） #

如果不想修改代码，可以在SonarQube的规则配置中，给java:S2187规则添加例外：允许继承自HandlerTestBase的测试类跳过该检查，或者调整规则的检测逻辑，使其识别继承的测试方法。这种方式无需改动代码，但需要依赖SonarQube的配置权限。

内容的提问来源于stack exchange，提问作者Florian