构建与依赖 / 系统课时

配置 Surefire 测试插件

配置 Surefire 测试插件

这一课把 Surefire 的四类常用控制一次配清:哪些测试要跑、测试进程收到哪些系统属性、JUnit 5 如何并行执行,以及失败后构建该怎么停。完成后你能用一次 mvn test 验证配置是否真正生效。

学习目标

  • 用 includes、excludes 精确控制测试类匹配范围。
  • 通过 systemPropertyVariables 向测试 JVM 传入环境参数。
  • 为 JUnit 5 设置固定并行度,并配置失败即停与空测试保护。

先确定哪些测试会被执行

Surefire 默认会匹配 **/Test*.java、**/*Test.java、**/*Tests.java 和 **/*TestCase.java。项目如果采用 *UnitTest、*SlowUnitTest 这类命名,应显式写规则,避免测试文件存在却没有被执行。

下面的规则只执行以 UnitTest 结尾的测试,并排除慢测试:

配置项 取值 作用
includes **/*UnitTest.java 只纳入单元测试命名
excludes **/*SlowUnitTest.java 排除慢测试
failIfNoTests true 一个测试都没匹配时直接让构建失败

failIfNoTests=true 很适合 CI:如果有人误改了命名规则,流水线不会以“0 个测试、构建成功”的方式悄悄通过。

一份可直接放进 POM 的配置

片段示例:把下面的 plugin 放进已有项目的 <build><plugins>。示例使用 Surefire 3.6.0;JUnit 5 的并行开关通过 JUnit Platform 配置参数传入,而不是依赖 Surefire 的 JUnit 4 并行参数。

xml
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-surefire-plugin</artifactId>
  <version>3.6.0</version>
  <configuration>
    <includes>
      <include>**/*UnitTest.java</include>
    </includes>
    <excludes>
      <exclude>**/*SlowUnitTest.java</exclude>
    </excludes>

    <systemPropertyVariables>
      <app.env>test</app.env>
      <feature.cache>false</feature.cache>
    </systemPropertyVariables>

    <properties>
      <configurationParameters>
        junit.jupiter.execution.parallel.enabled = true
        junit.jupiter.execution.parallel.mode.default = concurrent
        junit.jupiter.execution.parallel.config.strategy = fixed
        junit.jupiter.execution.parallel.config.fixed.parallelism = 4
      </configurationParameters>
    </properties>

    <skipAfterFailureCount>1</skipAfterFailureCount>
    <failIfNoTests>true</failIfNoTests>
    <testFailureIgnore>false</testFailureIgnore>
  </configuration>
</plugin>

测试代码里可通过 System.getProperty("app.env") 读取到 test。feature.cache 同理得到字符串 false;如果测试框架或业务代码需要布尔值,再自行调用 Boolean.parseBoolean。

并行和失败策略怎么取值

示例固定为 4 个并行执行单元,适合 4 核以上的开发机作为起点。测试大量访问同一个数据库、固定端口或共享静态变量时,先把并行度改成 1,确认测试本身没有竞态,再逐步提高到 2 或 4。

skipAfterFailureCount=1 表示出现第一个失败或错误后跳过剩余测试,但并行执行时已经启动的测试可能继续完成,因此它不是严格的“瞬间停止”。testFailureIgnore=false 则保证测试失败会让 Maven 构建失败;CI 中通常不要改成 true。

运行并检查是否生效

在项目根目录执行测试:

bash
mvn test

预期输出中应出现 Surefire 执行记录、实际测试统计和最终构建结果;数量会随项目变化:

text
[INFO] --- surefire:3.6.0:test (default-test) @ <ID> ---
[INFO] Tests run: <COUNT>, Failures: 0, Errors: 0, Skipped: <COUNT>
[INFO] BUILD SUCCESS

如果日志显示 No tests to run,而你确认测试文件存在,先核对类名是否满足 **/*UnitTest.java,再检查测试是否位于默认的 src/test/java。如果测试失败后仍有少量用例完成,在并行模式下属于正常现象;需要严格串行时把并行配置关闭或固定并行度设为 1。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

配置 Surefire 测试插件

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通