如何通过CustomListener选择性标记JUnit测试为失败或跳过

看起来你已经有了自定义监听器的基础，现在只需要加一点逻辑来区分哪些测试要跳过、哪些要失败就行。核心思路是用自定义注解标记需要跳过的测试，然后在监听器里结合你的some_condition来分别处理。

下面分JUnit 4和JUnit 5两种常见场景给出实现步骤：

1. 第一步：创建自定义注解 #

先定义一个注解，用来标记那些在some_condition为true时需要跳过的测试方法：

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME) // 运行时可读取
@Target(ElementType.METHOD) // 只能标记在测试方法上
public @interface SkipWhenCondition {
}

2. 第二步：修改自定义监听器 #

根据你使用的JUnit版本，调整监听器的逻辑：

针对JUnit 4（RunListener） #

在testStarted方法里，判断当前测试是否带有@SkipWhenCondition注解，结合some_condition来决定抛出跳过异常还是失败异常：

import org.junit.runner.Description;
import org.junit.runner.notification.RunListener;

public class CustomListener extends RunListener {

    // 这里可以换成从外部读取的条件，比如系统属性
    private boolean some_condition = Boolean.getBoolean("some.condition");

    @Override
    public void testStarted(Description description) throws Exception {
        super.testStarted(description);
        
        if (some_condition) {
            // 检查当前测试方法是否标记了跳过注解
            if (description.getAnnotation(SkipWhenCondition.class) != null) {
                // JUnit会把AssumptionViolatedException识别为"跳过"
                throw new org.junit.AssumptionViolatedException("Skipping test: some_condition is true");
            } else {
                // 抛出AssertionError会被标记为"失败"
                throw new AssertionError("Failing test: some_condition is true");
            }
        }
    }
}

针对JUnit 5（TestExecutionListener） #

JUnit 5的监听器API略有不同，我们在testExecutionStarted方法里处理：

import org.junit.platform.engine.support.descriptor.MethodSource;
import org.junit.platform.launcher.TestExecutionListener;
import org.junit.platform.launcher.TestIdentifier;

import java.lang.reflect.Method;

public class CustomListener implements TestExecutionListener {

    private boolean some_condition = Boolean.getBoolean("some.condition");

    @Override
    public void testExecutionStarted(TestIdentifier testIdentifier) {
        super.testExecutionStarted(testIdentifier);
        
        if (some_condition && testIdentifier.isTest()) {
            // 获取当前测试方法的反射对象
            testIdentifier.getSource().filter(MethodSource.class::isInstance)
                    .map(MethodSource::getJavaMethod)
                    .ifPresent(method -> {
                        if (method.isAnnotationPresent(SkipWhenCondition.class)) {
                            // JUnit 5的跳过异常
                            throw new org.junit.jupiter.api.Assumptions.AssumptionViolatedException("Skipping test due to active condition");
                        } else {
                            // 标记为失败
                            throw new AssertionError("Failing test due to active condition");
                        }
                    });
        }
    }
}

3. 第三步：在测试类中使用注解 #

现在你可以给需要跳过的测试方法加上@SkipWhenCondition注解，其他方法默认会被标记为失败：

import org.junit.Test; // JUnit4的导入，JUnit5用org.junit.jupiter.api.Test

public class YourTestClass {

    // 这个测试在some_condition为true时会失败
    @Test
    public void testShouldFail() {
        // 原测试逻辑
    }

    // 这个测试在some_condition为true时会被跳过
    @Test
    @SkipWhenCondition
    public void testShouldSkip() {
        // 原测试逻辑
    }
}

4. 确认Maven配置 #

确保你的Maven Surefire插件已经正确配置了监听器（你说之前已经能工作，这里只是确认）：

JUnit4的Surefire配置 #

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>2.22.2</version> <!-- 使用适合的版本 -->
            <configuration>
                <properties>
                    <property>
                        <name>listener</name>
                        <value>com.yourpackage.CustomListener</value>
                    </property>
                </properties>
            </configuration>
        </plugin>
    </plugins>
</build>

JUnit5的Surefire配置 #

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>3.0.0-M7</version> <!-- 使用适合的版本 -->
            <configuration>
                <listeners>
                    <listener>com.yourpackage.CustomListener</listener>
                </listeners>
            </configuration>
        </plugin>
    </plugins>
</build>

额外技巧：外部控制some_condition #

如果你想通过Maven命令行来开关这个条件，可以把some_condition改成读取系统属性：

private boolean some_condition = Boolean.getBoolean("some.condition");

然后运行测试时传入参数：

# 开启条件，触发跳过/失败逻辑
mvn test -Dsome.condition=true

# 关闭条件，正常运行测试
mvn test -Dsome.condition=false

这样就可以灵活控制测试的行为了！

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