Maven Surefire插件升级后测试未执行排查指南

在文章实战开发的过程中，我们经常会遇到一些这样那样的问题，然后要卡好半天，等问题解决了才发现原来一些细节知识点还是没有掌握好。今天golang学习网就整理分享《Maven Surefire插件升级后测试未执行排查指南》，聊聊，希望可以帮助到正在努力赚钱的你。

Maven Surefire插件在2.7及更高版本中改变了测试发现算法，现在仅执行符合JUnit规范的有效测试，这可能导致升级后部分原本运行的测试被跳过。本文将深入分析此变更，并提供使用`-Dsurefire.junit4.upgradecheck`标志诊断和解决测试未运行问题的专业指南。

1. 问题概述

在使用Maven构建项目时，开发者可能会遇到一个常见问题：升级maven-surefire-plugin版本后，原先所有正常运行的单元测试和集成测试突然只执行了部分，例如仅运行了Mock和Smoke测试，而其他重要的测试（如Java集成测试和单元测试）被跳过。这种现象尤其在使用2.22.1或更高版本时更为明显，而较旧版本如2.20可能不会出现此问题。

典型的pom.xml配置可能如下所示：

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

2. 核心原因分析：Surefire插件的测试发现机制变更

此问题的根源在于maven-surefire-plugin从版本2.7开始，其测试发现算法发生了重大变化。

• 旧版本 (2.7以前)：这些版本在发现测试时更为宽松。只要测试类满足一定的命名约定（例如以Test结尾），即使它们在技术上不完全符合JUnit规范，也可能会被执行。
• 新版本 (2.7及以后)：从2.7版本开始，Surefire插件变得更加严格。它现在只执行有效的JUnit测试。这意味着如果一个测试类或方法虽然符合命名约定，但由于缺少正确的JUnit注解（如@Test）或不符合JUnit的生命周期规范，它将被视为无效测试并被跳过。

因此，当您从一个旧版本升级到2.22.1或更高版本时，那些在旧版本中因宽松规则而被执行的“无效”测试，在新版本中将不再运行。

3. 诊断与解决方案

为了诊断哪些测试被视为无效并因此被跳过，Surefire插件提供了一个非常有用的过渡性标志：-Dsurefire.junit4.upgradecheck。

3.1 使用诊断标志

在执行Maven测试时，可以通过在命令行添加此标志来运行构建：

mvn test -Dsurefire.junit4.upgradecheck

工作原理：

当设置了-Dsurefire.junit4.upgradecheck标志后，Surefire插件会执行一个升级检查。它会识别出那些在新版本中不会运行，但在旧版本（2.7以前）中可能会运行的“无效”JUnit测试。如果发现任何此类测试，构建将失败，并在控制台输出详细的报告，明确指出哪些测试文件存在问题，以及它们为何被视为无效。

3.2 解决无效测试

一旦通过诊断标志识别出无效测试，接下来的步骤是根据报告修正这些测试：

1. 检查JUnit注解：确保所有预期运行的测试方法都正确使用了@Test注解。
2. 检查类结构：确保测试类是公共的，并且具有公共的无参构造函数（如果适用）。
3. 检查JUnit版本兼容性：确保项目使用的JUnit版本与maven-surefire-plugin版本兼容。例如，JUnit 4和JUnit 5（通过surefire-junit4或surefire-junit5引擎）的测试编写规范有所不同。
4. 遵循JUnit规范：仔细审查测试代码，确保它们完全符合所使用JUnit版本的最佳实践和规范。

4. 注意事项

• 过渡性功能：-Dsurefire.junit4.upgradecheck标志是一个过渡性功能，旨在帮助用户从旧版本升级时诊断问题。它将在未来的Surefire版本中被移除，因此不应将其作为永久解决方案。其主要目的是提供一次性的诊断报告。
• 官方文档：始终建议查阅maven-surefire-plugin的官方文档（例如Maven Surefire Plugin Examples: JUnit），以获取最新的功能说明、配置选项和升级指南。
• 依赖管理：确保您的pom.xml中JUnit及相关测试框架的依赖配置正确无误，并且版本与Surefire插件兼容。

5. 总结

maven-surefire-plugin从2.7版本开始对测试发现机制的改变，是为了提升测试执行的严谨性和准确性，确保只有符合JUnit规范的有效测试才会被运行。当您在升级Surefire插件版本后发现部分测试未执行时，这通常不是插件的bug，而是您的测试代码不完全符合新版本插件的严格要求。通过利用-Dsurefire.junit4.upgradecheck诊断标志，您可以快速定位并修正这些“无效”测试，从而确保所有预期的测试都能在新版本的Surefire插件下正常运行。理解并适应这些变化是维护健壮Maven构建的关键。

文中关于的知识介绍，希望对你的学习有所帮助！若是受益匪浅，那就动动鼠标收藏这篇《Maven Surefire插件升级后测试未执行排查指南》文章吧，也可关注golang学习网公众号了解相关技术文章。