首页 > Maven 阅读:229

Maven测试插件

Maven 项目中,用户基于 JUnit 或 TestNG 编写好了测试代码,接下来怎么执行,并且形成测试报告呢?具体执行测试代码,需要靠 maven-surefire-plugin 插件来实现。

Surefire 插件简介

Maven 本身虽然不是测试框架,但是 Maven 能够在构建执行到特定的生命周期阶段的时候,通过调用插件执行基于 JUnit 和 TestNG 编写好的测试用例。

这个插件就是 maven-surefire-plugin 插件,它能很好地兼容 JUnit 系列和 TestNG 测试框架。

在 Maven 的 default 生命周期的 test 阶段,绑定的默认插件是 maven-surefire-plugin。这是一个内置绑定,在默认情况下,maven-surefire-plugin 的 test 阶段会自动执行测试源代码路径下的所有符合命名模式的测试类。符合命名模式的规范是:
  • **/Test*.java:所有命名为 Test 开头的 Java 类。
  • **/*Test.java:所有命名为 Test 结尾的 Java 类。
  • **/*TestCase.java:所有命名为 TestCase 结尾的 Java 类。

只要测试类符合上面的命名模式,Maven 都会自动运行它们,不需要再定义测试集合来声明要执行哪些测试类。

如果测试代码是基于 TestNG 框架的,还可以通过配置文件灵活地指定需要运行的测试案例类。具体的写法请参考前面关于 TestNG 的介绍。

跳过测试

在实际项目中,要使 Maven 的构建过程暂时跳过测试环境(不运行测试案例),可以在执行 mvn 命令的后面通过添加 skipTests 参数实现,代码如下:

Mvn package -DskipTests

不过虽然可以通过该方式跳过测试阶段,但是这种操作和思路是不提倡的,因为发布和使用一个没有经过测试的构件有很大的风险。

除了可以在 mvn 命令后面通过指定 skipTests 参数标明跳过测试外,还可以在 pom 中的 maven-surefire-plugin 插件配置中进行声明,代码如下:
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>2.16</version>
    <configuration>
        <skipTests>true</skipTests>
    </configuration>
</plugin>
除了在 Maven 构建过程中跳过执行测试代码外,还可以直接跳过对测试的编译。

同样地,这里可以通过命令行指定,也可以通过 pom 的配置文件指定。

Maven 命令指定代码如下:

Mvn package -Dmaven.test.skip=true

其中,maven.test.skip 参数同时控制 maven-compile-plugin 和 maven-surefire-plugin 两个插件的行为:既跳过了测试代码的编译,也跳过了测试代码的运行。

pom 配置文件的指定代码如下:
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>2.1</version>
    <configuration>
        <skip>true</skip>
    </configuration>
</plugin>
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>2.16</version>
    <configuration>
        <skip>true</skip>
    </configuration>
</plugin>

个性化指定运行测试

在实际项目中,用户可能需要灵活地指定运行某些测试案例。这时候,就可以通过 mvn 命令的 test 参数来实现,代码如下:

Mvn test -Dtest=TestDemo

表示只执行 TestDemo 测试类。

同样地,还可以在 test 参数中,用“∗”通配符指定执行符合规则的所有测试类。例如:

Mvn test -Dtest=Test*Demo

表示执行类名为 Test 开头,Demo 结尾的所有测试类。

如果不嫌麻烦,也可以通过 test 参数明确指定要执行的测试类名。例如:

Mvn test -Dtest=TestDemo1,TestDemo2

表示执行类名为 TestDemo1 和 TestDemo2 的所有测试类。注意,指定的多个测试类之间要用逗号隔开。

同样,这里也可以将“∗”通配符和明确指定测试类的两种方式结合起来,以达到更灵活的效果。例如:

Mvn test -Dtest=TestA*,TestDemo1,TestDemo2

表示运行类名以 TestA 开头的所有的测试类和 TestDemo1、TestDemo2 测试类。

最后需要说明的是,如果 maven-surefire-plugin 根据 test 参数找不到任何匹配的测试类的话,会报测试失败。例如:

Mvn test -Dtest

这样的命令肯定找不到一个测试类,就会导致失败。

包含和排除测试

Maven 提倡约定优于配置原则,所以用户在写测试代码的时候,应尽量按规范的模式给测试类起名字。但是有时候难免会出现一些不符合模式的测试类名,而这些测试类又需要执行。这里可以通过如下方式,在 maven-surefire-plugin 中进行配置实现。
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>2.16</version>
    <configuration>
        <includes>
            <include>**/Demo*.java</include>
        </includes>
    </configuration>
</plugin>
通过上面的配置,Surefire 插件就会自动执行所有命名以 Demo 开头的测试类。同样地,可以通过 excludes 描述排除哪些测试类。例如:
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>2.16</version>
    <configuration>
        <excludes>
            <exclude>**/*abc.java</exclude>
            <exclude>**/Temp*.java</exclude>
        </excludes>
    </configuration>
</plugin>
表示不执行所有命名以 abc 结尾的测试类和以 Test 开头的测试类。

Java交流群:739993120(我们会不定期在群内分享Java知识,上传Java资料)

编程帮,一个分享编程知识的公众号。跟着站长一起学习,每天都有进步。

通俗易懂,深入浅出,一篇文章只讲一个知识点。

文章不深奥,不需要钻研,在公交、在地铁、在厕所都可以阅读,随时随地涨姿势。

文章不涉及代码,不烧脑细胞,人人都可以学习。

当你决定关注「编程帮」,你已然超越了90%的程序员!

编程帮二维码
微信扫描二维码关注