JUnit5如何避免重复配置ExtendWith扩展及相关方案咨询

问题描述 #

我在使用Gradle配合JUnit5进行测试开发时，每个测试方法都需要重复添加相同的扩展配置：

@ExtendWith({FishTaggingExtension.class, AllureAttachmentsExtension.class, BStackContextExtension.class})

想请教：

• 有没有办法避免在每个测试方法中重复该配置？
• 能否通过基类配置，让继承它的类中所有测试自动应用该扩展？
• 或者是否可以编写检查逻辑，当测试未按此配置扩展时抛出错误？

可行解决方案 #

1. 基类配置 #

可以创建一个抽象基类，在类级别添加@ExtendWith注解。所有测试类继承该基类后，类内的所有测试方法都会自动应用这些扩展：

@ExtendWith({FishTaggingExtension.class, AllureAttachmentsExtension.class, BStackContextExtension.class})
public abstract class BaseTest {
    // 可添加通用测试逻辑、初始化或清理代码
}

后续编写测试类时，只需继承BaseTest，无需在每个方法或类上重复添加扩展注解：

public class UserServiceTest extends BaseTest {
    @Test
    void testUserCreation() {
        // 测试逻辑自动应用基类的扩展
    }
}

2. 自定义元注解（已实现方案） #

通过自定义元注解整合多个@ExtendWith和其他必要注解，是更灵活的方式。你已经通过这种方式解决了问题，示例代码如下：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@ExtendWith({FishTaggingExtension.class, AllureAttachmentsExtension.class, BStackContextExtension.class})
@ArgumentsSource(TestDataJsonRead.class)
public @interface ProjectTest {
}

之后只需在测试方法上标注@ProjectTest，就能自动应用所有整合的扩展和参数源：

public class OrderServiceTest {
    @ProjectTest
    void testOrderPayment() {
        // 测试逻辑
    }
}

3. 检查未配置扩展的逻辑 #

如果需要确保所有测试都应用指定扩展，有两种实现方式：

• JUnit5 TestExecutionListener：实现TestExecutionListener接口，在测试执行前检查测试方法或类是否包含目标扩展，若未包含则抛出异常：

public class ExtensionEnforcementListener implements TestExecutionListener {
    @Override
    public void beforeTestExecution(TestExecutionContext context) throws Exception {
        Method testMethod = context.getTestMethod().orElseThrow();
        // 检查方法、类是否标注了目标扩展，或自定义元注解
        boolean hasRequiredExtensions = testMethod.isAnnotationPresent(ExtendWith.class) 
                || testMethod.getDeclaringClass().isAnnotationPresent(ExtendWith.class)
                || testMethod.isAnnotationPresent(ProjectTest.class);
        
        if (!hasRequiredExtensions) {
            throw new IllegalStateException("测试方法 " + testMethod.getName() + " 未配置必要的扩展");
        }
    }
}

然后在src/test/resources/META-INF/services/org.junit.platform.launcher.TestExecutionListener文件中添加该类的全限定名，让JUnit自动加载这个监听器。

• 静态代码检查：借助SonarQube自定义规则，或IDE的代码检查配置，强制要求测试方法/类必须标注指定注解或扩展。

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