Maven构建中运行生成单元测试：Surefire插件配置指南

1. 问题背景与Maven测试生命周期

在maven项目中，我们常常利用代码生成器（如通过exec-maven-plugin在generate-test-sources阶段执行自定义java程序）生成单元测试代码。为了让maven能够编译这些生成的测试代码，通常会结合build-helper-maven-plugin将生成目录（例如target/generated-test-sources/somedir）添加为测试源目录。尽管这些生成的测试代码能够被成功编译到target/test-classes，并且在ide中（如eclipse）可以正常运行，但当执行mvn clean test命令时，maven却可能忽略它们，导致这些测试不被执行。

其根本原因在于Maven的测试执行机制，特别是maven-surefire-plugin（负责运行单元测试）的默认配置。

2. Maven Surefire插件的默认测试匹配规则

maven-surefire-plugin在执行单元测试时，会根据一套预定义的模式来识别和包含测试类。默认情况下，它会自动包含符合以下任意通配符模式的测试类：

• **/Test*.java：包含所有子目录中以“Test”开头的Java文件。
• **/*Test.java：包含所有子目录中以“Test”结尾的Java文件。
• **/*Tests.java：包含所有子目录中以“Tests”结尾的Java文件。
• **/*TestCase.java：包含所有子目录中以“TestCase”结尾的Java文件。

如果您的生成测试类不符合上述任何一种命名约定，maven-surefire-plugin将无法识别并执行它们，即使它们已经成功编译并位于正确的测试类路径下。

3. 解决方案：配置Surefire插件的包含/排除规则

要解决此问题，我们需要显式地配置maven-surefire-plugin，以包含那些不符合默认命名约定的生成测试类。这可以通过在pom.xml文件中，在maven-surefire-plugin的配置中添加<includes>或<excludes>部分来实现。

青柚面试

简单好用的日语面试辅助工具

57

查看详情

3.1 配置示例

假设您的生成测试类都以GeneratedTest_开头，或者位于特定的子目录target/generated-test-sources/somedir下，您可以这样配置maven-surefire-plugin：

<project>
  ...
  <build>
    <plugins>
      <!-- 其他插件，如exec-maven-plugin和build-helper-maven-plugin -->

      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
        <version>3.2.5</version> <!-- 推荐使用最新稳定版本 -->
        <configuration>
          <includes>
            <!-- 默认的包含规则，通常建议保留，除非您想完全自定义 -->
            <include>**/Test*.java</include>
            <include>**/*Test.java</include>
            <include>**/*Tests.java</include>
            <include>**/*TestCase.java</include>

            <!-- 添加自定义的生成测试类包含规则 -->
            <!-- 示例1：如果所有生成测试类都以 "GeneratedTest_" 开头 -->
            <include>**/GeneratedTest_*.java</include>

            <!-- 示例2：如果所有生成测试类都位于特定的子目录且有特定命名模式 -->
            <!-- 假设生成测试类在 target/generated-test-sources/somedir 下，
                 且文件名以 "MyGenerated" 结尾 -->
            <include>**/somedir/**/*MyGenerated.java</include>

            <!-- 示例3：如果您希望包含所有在某个特定目录下且不符合默认规则的Java文件 -->
            <!-- 请谨慎使用，这可能会包含非测试文件 -->
            <!-- <include>**/somedir/**/*.java</include> -->
          </includes>
          <!-- 您也可以使用 <excludes> 来明确排除某些测试类 -->
          <!-- <excludes>
            <exclude>**/*IntegrationTest.java</exclude>
          </excludes> -->
        </configuration>
      </plugin>
    </plugins>
  </build>
  ...
</project>

在上述配置中：

• <includes>标签用于指定需要包含的测试类模式。
• <include>子标签定义了具体的通配符模式。
• 我们添加了**/GeneratedTest_*.java和**/somedir/**/*MyGenerated.java作为示例，用于匹配自定义命名的生成测试类。请根据您实际的生成测试文件命名规则进行调整。
• 通常建议保留Surefire插件的默认包含规则，并在其基础上添加自定义规则，以确保项目中的所有测试（包括手动编写的和生成的）都能被正确执行。

3.2 注意事项

1. 版本选择：请确保maven-surefire-plugin使用最新的稳定版本，以获得更好的兼容性和功能。
2. 模式匹配：确保您在<include>中定义的模式与生成的测试类文件的实际名称和路径完全匹配。通配符**匹配零个或多个目录，*匹配零个或多个字符。
3. 与生成插件的协同：exec-maven-plugin和build-helper-maven-plugin负责生成测试源文件并将其添加到Maven的测试源路径中。maven-surefire-plugin则负责运行这些已编译的测试。这三个插件各司其职，缺一不可。
4. 官方文档：对于更复杂的包含/排除场景，或者需要了解更多高级配置选项，强烈建议查阅Maven Surefire Plugin官方文档。

4. 总结

当Maven构建中的生成单元测试未被执行时，核心问题往往出在maven-surefire-plugin的默认测试类匹配规则上。通过在pom.xml中明确配置maven-surefire-plugin的<includes>（或<excludes>）部分，并指定与生成测试类文件命名相符的通配符模式，可以确保这些测试能够被Maven正确识别并纳入自动化测试流程。这对于维护大型项目和依赖代码生成的工作流至关重要，它保证了测试覆盖的完整性，并有效避免了因命名不匹配导致的测试遗漏。

以上就是Maven构建中运行生成单元测试：Surefire插件配置指南的详细内容，更多请关注php中文网其它相关文章！