Maven Surefire Plugin

pumpkin84514

于 2024-09-29 20:16:36 发布

阅读量422

点赞数 18

文章标签： maven 测试工具 java

本文链接：https://blog.csdn.net/pumpkin84514/article/details/142642832

版权

java 专栏收录该内容

17 篇文章 0 订阅

订阅专栏

Maven Surefire Plugin 最新版本新特性详解

Maven Surefire Plugin 是用于运行单元测试和集成测试的重要工具，支持 JUnit、TestNG 等测试框架。插件的新版本引入了许多新特性和配置选项，这些功能提升了测试执行的性能、灵活性和并发能力。在本节中，我们将详细介绍 Surefire Plugin 的各个配置选项及其用途，并结合实际使用场景和示例进行讲解。

1. forkCount

作用：

forkCount 选项指定在测试过程中 JVM fork 的数量。多 JVM 并行可以提升测试执行的性能，特别适合在多核机器上运行测试。

默认值: 1
配置值: 具体数值，或者用 C 后缀表示 CPU 核心数的占比（如 1C，2C）。
- 1C: 表示使用一个 CPU 核心。
- 2C: 表示使用两个 CPU 核心。

示例配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>3.0.0-M9</version> <!-- 最新版本 -->
            <configuration>
                <forkCount>2C</forkCount> <!-- 使用两个 CPU 核心并行执行测试 -->
            </configuration>
        </plugin>
    </plugins>
</build>

配置解释：

forkCount=2C 表示会根据机器的 CPU 核心数启动 2 个 JVM 实例，来并行执行测试，提升测试速度。

2. reuseForks

作用：

reuseForks 控制测试过程中是否重用已经 fork 出来的 JVM 实例。该配置可以避免每次测试都启动新的 JVM，从而减少开销。

默认值: true
配置选项:
- true: JVM 会被重用，适合大部分场景。
- false: 每次测试都会启动新的 JVM，这可以确保每个测试类有一个全新的 JVM 环境。

示例配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>3.0.0-M9</version>
            <configuration>
                <forkCount>2</forkCount>
                <reuseForks>true</reuseForks> <!-- 启用 JVM 重用 -->
            </configuration>
        </plugin>
    </plugins>
</build>

配置解释：

reuseForks=true 会复用 JVM 实例，避免频繁启动 JVM，显著提升测试性能。

3. forkMode（已弃用）

作用：

forkMode 曾用于控制 JVM fork 的模式，现在已被 forkCount 和 reuseForks 取代。主要的模式有：

once: 仅创建一个 JVM 进程，所有测试在同一个进程中执行。
always: 每个测试类启动一个新的 JVM。

示例配置（历史配置）：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>2.12</version>
            <configuration>
                <forkMode>once</forkMode> <!-- 旧版本配置，已被弃用 -->
            </configuration>
        </plugin>
    </plugins>
</build>

4. argLine

作用：

argLine 用于向 fork 出来的 JVM 添加命令行参数，可以指定 JVM 参数、系统属性、内存限制等。

示例配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>3.0.0-M9</version>
            <configuration>
                <argLine>-Xmx1024m -Duser.timezone=UTC</argLine> <!-- 设置 JVM 参数和系统属性 -->
            </configuration>
        </plugin>
    </plugins>
</build>

配置解释：

argLine=-Xmx1024m 表示设置 JVM 堆内存最大为 1024MB。
-Duser.timezone=UTC 设置 JVM 的时区为 UTC。

5. parallel

作用：

parallel 选项允许并行执行测试类或测试方法，提高测试执行速度。可以根据类或方法并行，也可以两者都并行。

配置选项:
- methods: 并行执行同一个测试类中的不同测试方法。
- classes: 并行执行不同的测试类。
- both: 类和方法都并行执行。

示例配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>3.0.0-M9</version>
            <configuration>
                <parallel>both</parallel> <!-- 同时并行执行类和方法 -->
                <threadCount>4</threadCount> <!-- 并行线程数为4 -->
            </configuration>
        </plugin>
    </plugins>
</build>

配置解释：

parallel=both 表示测试类和测试方法会同时并行执行。
threadCount=4 配置了 4 个并行线程来处理测试任务。

6. includes 和 excludes

作用：

includes 和 excludes 用于指定哪些测试类应该包含在测试执行中，哪些类应该排除。

示例配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>3.0.0-M9</version>
            <configuration>
                <includes>
                    <include>**/*Test.java</include> <!-- 包含所有 Test 结尾的测试类 -->
                </includes>
                <excludes>
                    <exclude>**/Legacy*.java</exclude> <!-- 排除所有以 Legacy 开头的类 -->
                </excludes>
            </configuration>
        </plugin>
    </plugins>
</build>

配置解释：

includes：包含所有以 Test 结尾的测试类。
excludes：排除所有以 Legacy 开头的类。

7. runOrder

作用：

runOrder 用于指定测试类或测试方法的执行顺序。

配置选项:
- alphabetical: 按字母顺序执行。
- reversealphabetical: 按字母倒序执行。
- random: 随机顺序执行。
- filesystem: 根据文件系统中的顺序执行。
- hourly: 每小时随机顺序发生变化。

示例配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>3.0.0-M9</version>
            <configuration>
                <runOrder>random</runOrder> <!-- 随机顺序执行测试 -->
            </configuration>
        </plugin>
    </plugins>
</build>

配置解释：

runOrder=random：测试类和方法将按照随机顺序执行，有助于确保测试的独立性。

8. skipTests 与 skipITs

skipTests：跳过所有单元测试。
skipITs：跳过集成测试。

示例配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>3.0.0-M9</version>
            <configuration>
                <skipTests>true</skipTests> <!-- 跳过单元测试 -->
                <skipITs>false</skipITs> <!-- 执行集成测试 -->
            </configuration>
        </plugin>
    </plugins>
</build>

配置解释：

skipTests=true：跳过所有的单元测试，适合快速构建项目时使用。
skipITs=false：确保集成测试不会被跳过。

9. reportFormat

作用：

reportFormat 用于指定测试报告的格式，通常为 brief 或 plain。

示例配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
           

 <version>3.0.0-M9</version>
            <configuration>
                <reportFormat>brief</reportFormat> <!-- 使用简洁格式生成报告 -->
            </configuration>
        </plugin>
    </plugins>
</build>