Maven Surefire Plugin升级后测试未全部运行的排查与解决

maven surefire插件在2.7及更高版本中，其测试发现机制变得更加严格，只运行有效的junit测试，这可能导致从旧版本升级后部分非标准测试被跳过。本文将深入解析这一行为变更的原因，并提供使用-dsurefire.junit4.upgradecheck参数来诊断并识别不符合新规范的测试用例的方法，确保测试套件的完整性。

Maven Surefire Plugin测试发现机制的演进

Maven Surefire Plugin是Maven项目用于运行单元测试的核心插件。然而，在不同版本之间，其测试发现和执行的算法发生了显著变化。理解这些变化对于排查测试未全部运行的问题至关重要。

在Surefire Plugin 2.7版本之前，插件在识别和运行测试时采取了相对宽松的策略。它不仅会运行符合JUnit规范的测试，还会执行那些仅仅满足特定命名约定（例如，以Test结尾的类或方法）但可能并非完全有效的JUnit测试。这种宽松性在某些情况下可能导致执行一些非预期的代码，或者掩盖了测试本身存在的问题。

然而，自Surefire Plugin 2.7版本及其后续版本起，测试发现算法进行了重大调整。新算法的核心原则是：只运行有效的JUnit测试。这意味着，如果一个类或方法不符合JUnit（无论是JUnit 4.x还是JUnit 5）的规范，即使它满足了旧版本的命名约定，新版本的Surefire插件也可能将其忽略。这一改变旨在提高测试的质量和一致性，确保只有结构良好、符合标准的测试才会被执行。

升级Surefire版本后测试缺失的原因

当您将maven-surefire-plugin从2.7之前的版本（例如2.20）升级到2.7或更高版本（例如2.22.1或最新版本）时，可能会遇到部分测试（如Java集成测试和单元测试）不再运行的问题，而其他测试（如Mock和Smoke测试）可能仍然正常执行。这并非插件的错误，而是其行为变更的直接体现。

具体来说，在旧版本中能够运行的“非标准”JUnit测试，由于不符合新版本Surefire对“有效JUnit测试”的严格定义，在升级后就会被跳过。例如，一个没有正确使用@Test注解、或者测试类不是公共的、或者测试方法没有正确签名（例如，非公共方法或带参数的方法）的JUnit 4测试，在2.20版本中可能因其命名约定而被执行，但在2.22.1版本中则会被忽略。

诊断工具：surefire.junit4.upgradecheck参数

为了帮助开发者顺利从旧版Surefire升级并识别那些可能被新版插件忽略的测试，Surefire Plugin提供了一个非常有用的诊断参数：-Dsurefire.junit4.upgradecheck。

该参数的目的是在升级过程中执行一次检查，识别出那些在Surefire 2.7及更高版本中将不再运行的“无效”JUnit 4测试。当启用此参数运行Maven构建时，如果发现任何不符合新规范的测试，构建过程将会失败，并会输出详细的报告，明确指出哪些测试将被跳过以及原因。这使得开发者可以有针对性地修改这些测试，使其符合JUnit规范。

需要注意的是，-Dsurefire.junit4.upgradecheck是一个过渡性功能。它主要设计用于辅助升级过程中的兼容性检查，未来版本的Surefire插件可能会移除此功能。因此，一旦通过此参数识别并修正了所有问题测试，就不应再常规使用它。

白瓜面试

白瓜面试 - AI面试助手,辅助笔试面试神器

40

查看详情

示例：配置与诊断

假设您的pom.xml中配置了maven-surefire-plugin，并已升级到较新版本，例如2.22.1：

<?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>

    <properties>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>2.22.1</version> <!-- 升级后的版本 -->
            </plugin>
        </plugins>
    </build>

    <dependencies>
        <!-- 假设您正在使用JUnit 4 -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13.2</version>
            <scope>test</scope>
        </dependency>
        <!-- 其他依赖 -->
    </dependencies>
</project>

为了诊断哪些测试可能被跳过，您可以在命令行中使用以下命令运行Maven测试：

mvn test -Dsurefire.junit4.upgradecheck

执行此命令后，如果存在不符合JUnit 4规范的测试，Maven构建将失败，并在控制台输出类似以下内容的错误信息：

[INFO] --- maven-surefire-plugin:2.22.1:test (default-test) @ weatherProject ---
[ERROR] There are test failures.
...
[ERROR] Failures:
[ERROR]   MyInvalidTest.someMethodThatIsNotAnnotatedCorrectly: The test class 'MyInvalidTest' or test method 'someMethodThatIsNotAnnotatedCorrectly' is not a valid JUnit 4 test. It will not be run by Surefire 2.7+.
...
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------

通过这些错误信息，您可以准确地定位到需要修改的测试类和方法，然后根据JUnit 4或JUnit 5的规范进行调整。

确保测试有效性的最佳实践

为了避免在Surefire版本升级时出现测试缺失的问题，并确保测试套件的健壮性，建议遵循以下JUnit测试的最佳实践：

1. 使用正确的注解： 确保所有测试方法都使用@org.junit.Test（JUnit 4）或@org.junit.jupiter.api.Test（JUnit 5）注解。
2. 公共类和方法： 测试类和测试方法通常需要是public的。对于JUnit 4，测试类需要有公共的无参构造函数（或者没有显式构造函数）。
3. 无参方法： JUnit 4的测试方法不能有参数。JUnit 5支持参数化测试，但需要特定的注解和提供者。
4. 避免静态方法： 测试方法通常不应是静态的。
5. 遵循命名约定（辅助）： 虽然新版Surefire不再完全依赖命名约定，但为了代码可读性和工具识别，仍然建议遵循如*Test.java、Test*.java、*TestCase.java的命名模式。
6. 引入正确的依赖： 确保pom.xml中正确引入了JUnit的test范围依赖。

总结

Maven Surefire Plugin在2.7版本后对测试发现机制的严格化是一项旨在提升测试质量和规范性的改进。当从旧版本升级时，如果发现部分测试不再运行，很可能是因为这些测试不符合新版本对“有效JUnit测试”的定义。通过利用-Dsurefire.junit4.upgradecheck诊断参数，开发者可以有效地识别并修正这些不规范的测试，确保测试套件在升级后依然完整且可靠。遵循JUnit的最佳实践，从一开始就编写规范的测试，是避免此类问题的根本之道。

以上就是Maven Surefire Plugin升级后测试未全部运行的排查与解决的详细内容，更多请关注php中文网其它相关文章！