【maven实战】37-maven-surefire-plugin介绍

最新推荐文章于 2025-02-27 12:34:00 发布

一直不懂

最新推荐文章于 2025-02-27 12:34:00 发布

阅读量2.1k

点赞数

分类专栏： maven实战

maven实战专栏收录该内容

46 篇文章

订阅专栏

本文介绍了如何使用Maven进行单元测试配置，包括跳过测试、指定测试用例、包含与排除测试类等操作。了解maven-surefire-plugin的使用方法，掌握命令行参数和POM配置。

摘要由CSDN通过智能技术生成

maven本身并不是一个单元测试框架，java中主流的单元测试框架为JUnit和TestNG。Maven所做的只是在构建执行到特定生命周期阶段的时候通过插件来执行JUnit或TestNG的测试用例。这一插件就是maven-surefire-plugin，可以称之为测试运行器，它能很好地兼容JUnit3,JUnit4以及TestNG。

回顾一下default生命周期，其中的test阶段被定义为使用单元测试框架运行测试。我们知道生命周期阶段需要绑定到某个插件的目标才能完成真正的工作，test阶段正是maven-surefire-plugin的test目标绑定了，这是一个内置的绑定。在默认情况下，maven-surefire-plugin的test目标会自动执行测试源码路径(默认为src/test/java/)下所有符合一组命名模式的测试类，这组模式为:

**/Test*.java：任何子目录下所有命名以Test开关的Java类。
**/*Test.java：任何子目录下所有命名以Test结尾的Java类。
**/*TestCase.java：任何子目录下所有命名以TestCase结尾的Java类。

跳过测试:在命令行中加入参数skipTests就可以了。

mvn package -DskipTests

当然也可以在POM中配置maven-surefire-plugin插件来提供该属性，不推荐这种做法，如果配置POM让项目长时间跳过测试，还要测试代码做什么呢?

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>2.5</version>
    <configuration>
  <skipTests>true</skipTests>
    </configuration>
</plugin> <skipTests>true</skipTests>
    </configuration>
</plugin>

有时候用户不仅仅想跳过测试运行，还想临时性地跳过测试代码的编译，Maven也允许你这么做，但记住这是不推荐的:

mvn package -Dmaven.test.skip=true

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

对于命令行参数maven.test.skip的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.5</version>
    <configuration>
   <skip>true</skip>
    </configuration>
</plugin>

实际上maven-compiler-plugin的testCompile目标和maven-surefire-plugin的test目标都提供了一个参数skip用来跳过测试编译和测试运行，而这个参数对应的命令行表达式为maven.test.skip

动态指定要运行的测试用例:maven-surefire-plugin提供了一个test参数让maven用户能够在命令行指定要运行的测试用例就可以使用如下命令:

mvn test -Dtest=RandomTest

这里test参数的值是测试用例的类名，这行命令的效果就是只有RandomTest这一个测试类得到运行。

maven-surefire-plugin的test参数还支持高级一些的赋值方式，能让用户更灵活地指定需要运行的测试用例。如:

mvn test -Dtest=Random*Test

星号可以匹配零个或多个字符，上述命令会运行项目中所有类名以Random开头Test结尾的测试类。

除了星号匹配还可以使用逗号指定多个测试用例:

mvn test -Dtest=Random1Test,Random2Test

当然也可以结合星号和逗号。

mvn test -Dtest=Random*Test,Random2Test

如果maven-surefire-plugin找不到任何匹配的测试类，就会报错并导致构建失败，可以加上-DfailIfNoTests=false，告诉maven-surefire-plugin即使没有任何测试也不要报错:

mvn test -Dtest -DfailIfNoTests=false

包含与排除测试用例:Maven提倡约定优于配置原则，因此用户应该尽量遵守这一族模式来为测试类命名。即便如此maven-surefire-plugin还是允许用户通过额外的配置来自定义包含一些其他测试类，或者排除一些符合默认命名模式的测试类。

例如由于历史原因有些项目所有测试类名称都以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>
 <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>**/*Tests.java</exclude>
    </excludes>
    </configuration>
</plugin>