Maven运行测试用例

待我称王封你为后i 2023-05-22 04:39 13阅读 0赞

maven 中对应 test 的插件是 `maven-surefire-plugin`，该插件会自动执行测试源码路径下的所有符合下面命名模式的测试类。

1.  `**/Test*.java`：任何子目录下所有命名以`Test`开头的`java`类
2.  `**/*Test.java`：任何子目录下所有命名以`Test`结尾的`java`类
3.  `**/*TestCase.java`：任何子目录下所有命名以`TestCase`结尾的`java`类

### 跳过测试 ###

mvn package -DskipTests

也可以跳过测试代码的编译，`maven.test.skip`同时控制了`maven-compiler-plugin`和`maven-surefire-plugin`两个插件的行为，测试代码编译和运行都跳过了。

mvn package -Dmaven.test.skip=true

### 动态指定要运行的测试用例 ###

如果只想运行`RandomGeneratorTest`，可以使用下面的命令。

mvn test -Dtest=RandomGeneratorTest
    # *号匹配0个或多个字符
    mvn test -Dtest=Random*Test
    # 使用逗号指定多个测试用例
    mvn test -Dtest=RandomGeneratorTest,CaptchaServiceTest
    # 也可以混用
    mvn test -Dtest=Random*Test,CaptchaServiceTest

### 包含与排除测试用例 ###

由于历史原因，有些项目所有测试类名称都已`Tests`结尾，这样的名字不符合默认的`3`中模式，因此不会运行。`maven`提供了如下配置，可以自动运行这些测试。

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
        <version>2.5</version>
        <configuration>
            <includes>
                <include>**/*Tests.java</include>
            </includes>
        </configuration>
    </plugin>

类似的，也可以使用`excludes`元素排除一些符合默认命名模式的测试类。

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
        <version>2.5</version>
        <configuration>
            <excludes>
                <exclude>**/*ServiceTest.java</exclude>
                <exclude>**/*DaoTest.java</exclude>
            </excludes>
        </configuration>
    </plugin>

### 测试报告 ###

默认情况下，`maven-surefire-plugin`会在项目的`target/surefire-reports`目录下生成两种格式的错误报告：

*  简写文本`txt`格式
 *  与`JUnit`兼容的`XML`格式

测试报告覆盖率是衡量项目代码质量的一个重要参考指标。`Cobertura`是一个优秀的开源测试覆盖率统计工具，`maven`通过`cobertura-maven-plugin`与之集成，可以通过命令来生成测试覆盖率报告。

mvn cobertura:cobertura

打开`target/site/cobertura/`下的`index.html`文件，可以看到测试覆盖报告。

### 重用测试代码 ###

通过配置 `maven-jar-plugin`将测试类打包。

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-jar-plugin</artifactId>
         <version>2.2</version>
         <executions>
             <execution>
                 <goals>
                     <goal>test-jar</goal>
                 </goals>
             </execution>
         </executions>
     </plugin>

`maven-jar-plugin` 有两个目标，分别是`jar`和`test-jar`，前者通过`maven`的内置绑定在`default`生命周期的`package`阶段运行，目的是对主代码进行打包，而后者并没有内置绑定，所以需要显示声明该目标来打包测试代码。`test-jar`绑定的生命周期阶段是`package`。所以运行`mvn clean package`的时候会对测试代码进行打包。

测试包构件的依赖配置。

<dependency>
       <groupId>com.juvenxu.mvnbook.account</groupId>
        <artifactId>account-captcha</artifactId>
        <version>1.0.0-SNAPSHOT</version>
        <type>test-jar</type>
        <scopt>test</scope>
    </dependency>

所有测试包构件都是使用特殊的 `test-jar` 打包类型，这一类型的依赖同样都使用`test`依赖范围。