JUnit5测试InterruptedException捕获块时混合JUnit4用例随机报错如何解决

问题说明 #

• 业务代码存在InterruptedException捕获逻辑，捕获异常后执行自定义逻辑，重置当前线程中断标记（为满足代码规范检查要求），最终抛出自定义业务异常，代码片段如下：

...
} catch (InterruptedException e) {
    // 自定义业务处理逻辑
    Thread.currentThread().interrupt();
    throw new CustomException("Message", e);
}

• 为覆盖该异常分支，编写JUnit5测试用例，通过Mock框架让依赖方法抛出InterruptedException触发捕获逻辑，测试代码片段如下：

@Test
void someMethodShouldThrowInterruptedException() {
    // 测试前置逻辑
    when(someClass.doSomething()).thenThrow(InterruptedException.class);
    // 断言逻辑
}

• 异常表现：单独运行JUnit5测试全部通过，Maven构建执行完JUnit5用例、切换到JUnit4测试阶段时，会随机在JUnit4用例上抛出java.lang.RuntimeException: java.lang.InterruptedException；本地特性分支可全量通过单元测试，合并到dev分支后构建随机失败，临时处理方式为禁用该测试用例。
• 根因：maven-surefire-plugin执行测试时会复用工作线程，当前使用的junit-vintage-engine 5.5.2、junit-jupiter-engine 5.5.2、maven-surefire-plugin 2.22.2版本组合下，跨引擎切换时不会清理工作线程的中断标记，JUnit5用例执行后残留的中断标记被带到后续执行的JUnit4用例中，触发异常。单引擎场景下的同类中断标记泄漏问题已在官方版本中修复，跨引擎场景未覆盖。

可行解决方案 #

以下方案均不需要全量迁移测试到JUnit5，也不需要放弃该代码块的覆盖率：

• 方案1：测试方法执行后主动清理中断标记
  成本最低的修复方式，在对应JUnit5测试类中添加@AfterEach回调，测试执行完成后主动清除当前线程的中断标记，不影响原有测试断言逻辑：

  @AfterEach
  void clearThreadInterruptState() {
      // 清除当前线程残留的中断标记，该方法会返回中断状态同时重置标记
      Thread.interrupted();
  }
  

• 方案2：升级测试依赖版本
  将maven-surefire-plugin升级到3.0.0-M5及以上版本，同时将junit-jupiter、junit-vintage-engine升级到5.7.0及以上版本。新版本的Surefire插件在切换测试引擎时会主动清理工作线程的上下文状态，包括中断标记、线程本地变量等，从执行器层面解决线程复用带来的状态泄漏问题，升级后不需要修改现有测试代码。
• 方案3：隔离执行触发中断标记的测试用例
  若不想调整全局依赖版本，可将该测试用例单独分组，配置独立的fork进程执行，执行完成后直接销毁进程，避免和其他JUnit4测试共享线程池：
  1. 给目标测试方法/类加上@Tag("interrupt-sensitive")注解
  2. 修改maven-surefire-plugin配置，分两次执行测试，中断相关用例单独在不复用的fork进程中运行：

  <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-surefire-plugin</artifactId>
      <version>2.22.2</version>
      <executions>
          <execution>
              <id>run-interrupt-tests</id>
              <goals>
                  <goal>test</goal>
              </goals>
              <configuration>
                  <groups>interrupt-sensitive</groups>
                  <forkCount>1</forkCount>
                  <reuseForks>false</reuseForks>
              </configuration>
          </execution>
          <execution>
              <id>run-normal-tests</id>
              <goals>
                  <goal>test</goal>
              </goals>
              <configuration>
                  <excludedGroups>interrupt-sensitive</excludedGroups>
              </configuration>
          </execution>
      </executions>
  </plugin>
  

  该方案缺点是会少量增加测试执行时间，因为需要单独拉起JVM进程执行单组用例。
• 方案4：全局配置测试扩展自动清理中断标记
  实现JUnit5的测试执行回调扩展，所有JUnit5用例执行完成后自动清理线程中断标记，不需要每个测试类单独编写清理逻辑：

  import org.junit.jupiter.api.extension.AfterTestExecutionCallback;
  import org.junit.jupiter.api.extension.ExtensionContext;
  
  public class InterruptStateCleanExtension implements AfterTestExecutionCallback {
      @Override
      public void afterTestExecution(ExtensionContext context) {
          Thread.interrupted();
      }
  }
  

  可以在测试类上通过@ExtendWith(InterruptStateCleanExtension.class)注解手动引入，也可以通过Java SPI配置为全局自动生效，避免后续新增同类测试用例重复踩坑。

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