Maven Surefire Plugin 测试执行不完整问题解析与解决方案

本文深入探讨maven surefire plugin在不同版本下测试执行行为的差异，特别是从2.7版本开始引入的测试发现机制变更。当升级surefire版本后发现部分junit测试未能执行时，这通常是由于测试不再满足新的“有效junit测试”定义所致。文章将指导如何使用-dsurefire.junit4.upgradecheck参数诊断问题，并提供相应的解决思路，确保所有预期测试都能正确运行。

理解 Maven Surefire Plugin 与测试执行

Maven Surefire Plugin 是 Apache Maven 项目中用于在构建生命周期中执行单元测试的插件。它负责发现、执行项目中的测试，并生成测试报告。通常情况下，开发者只需在 pom.xml 中声明该插件，Maven 就会自动处理测试的执行。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.example</groupId>
    <artifactId>weatherProject</artifactId>
    <version>1.0-SNAPSHOT</version>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>2.22.1</version> <!-- 示例中使用的版本 -->
            </plugin>
        </plugins>
    </build>
    <!-- ... 其他项目配置 ... -->
</project>

然而，在升级 maven-surefire-plugin 版本时，可能会遇到一些测试不再执行的问题，例如从 2.20 升级到 2.22.1 后，原本运行的集成测试和单元测试突然只执行了部分（如 Mock 和 Smoke 测试）。这通常不是插件的 Bug，而是其测试发现机制发生了变化。

Surefire 2.7+ 版本的测试发现机制变更

问题的根源在于 Surefire Plugin 从 2.7 版本开始，其选择执行测试的算法发生了重大改变。

• 旧版本 (2.7 之前): 可能会执行那些仅仅满足命名约定（例如以 Test 结尾的类）但并非严格意义上“有效”的 JUnit 测试。
• 新版本 (2.7 及之后): 仅运行 有效 的 JUnit 测试。这意味着如果一个类虽然符合命名约定，但没有正确的 JUnit 注解（如 @Test）或者不符合 JUnit 的测试类结构要求，它将不会被执行。

这种变化旨在提高测试执行的准确性和效率，避免执行那些实际上不是测试的类。因此，当从一个较旧的 Surefire 版本升级到 2.7 或更高版本时，如果项目中存在一些“非标准”的 JUnit 测试，它们就可能不再被 Surefire 识别和执行。

诊断未运行测试：使用 surefire.junit4.upgradecheck

为了帮助开发者在升级 Surefire 版本时识别这些潜在的问题测试，Surefire Plugin 提供了一个非常有用的诊断工具：-Dsurefire.junit4.upgradecheck 标志。

作用: 当使用 Surefire 2.7 或更高版本时，通过此标志运行 Maven 构建，插件会执行一个检查，识别出那些在旧版本中可能被执行，但在当前版本中因不符合“有效 JUnit 测试”标准而不会被执行的测试。

行为: 如果发现任何此类“无效”测试，构建将会失败，并输出详细的警告信息，指示哪些测试类或方法存在问题。这使得开发者能够明确地知道哪些测试需要修改以适应新的 Surefire 行为。

AI建筑知识问答

用人工智能ChatGPT帮你解答所有建筑问题

22

查看详情

使用方法:

在命令行中执行 Maven 测试时，添加此系统属性：

mvn test -Dsurefire.junit4.upgradecheck

注意事项:

• 这个标志仅作为升级时的诊断工具。它是一个过渡性功能，未来版本的 Surefire 可能会移除它。
• 一旦识别并修复了所有问题测试，就不再需要使用此标志。

解决测试未运行问题

当 surefire.junit4.upgradecheck 标志帮助你识别出未运行的测试后，接下来的步骤是根据诊断信息修正这些测试：

1. 检查 JUnit 注解: 确保所有测试方法都正确地使用了 @Test 注解。对于 JUnit 4，测试类通常需要有 @RunWith 注解（例如 @RunWith(JUnit4.class) 或 @RunWith(SpringRunner.class) 等），尽管对于简单的测试类这不是强制的。对于 JUnit 5，测试类和方法需要使用 org.junit.jupiter.api.Test 等注解。
2. 验证测试类结构:
   • 测试类通常应该是公共的 (public)。
   • 测试方法也应该是公共的 (public)，且没有参数。
   • 确保没有将测试类或测试方法标记为 abstract。
   • 对于 JUnit 4，确保测试类没有构造函数，或者有一个无参数的公共构造函数。
3. 遵循命名约定 (辅助): 虽然 Surefire 2.7+ 版本更注重有效性而非仅仅命名，但遵循标准的命名约定（如 *Test.java、Test*.java、*TestCase.java）仍然是一个良好的实践，可以帮助 Surefire 插件更有效地发现测试。
4. 检查依赖: 确保项目中包含了正确版本的 JUnit 依赖，并且没有版本冲突。

总结

当 maven-surefire-plugin 升级后出现部分测试不执行的问题时，通常是由于 Surefire 2.7 版本引入的测试发现机制变更所致。通过利用 -Dsurefire.junit4.upgradecheck 诊断标志，可以有效地定位并修复那些不符合“有效 JUnit 测试”标准的测试。遵循 JUnit 的最佳实践，确保测试代码结构和注解的正确性，是避免此类问题的关键。在进行插件版本升级时，查阅官方文档中的变更日志也是一个不可或缺的步骤。

以上就是Maven Surefire Plugin 测试执行不完整问题解析与解决方案的详细内容，更多请关注php中文网其它相关文章！