运行集成测试
虽然您可以非常轻松地从您的测试(或测试套件)本身启动 Spring Boot 应用程序,但可能希望在构建本身中处理它。为了确保在集成测试周围正确管理 Spring Boot 应用程序的生命周期,您可以使用 start
和 stop
目标,如下例所示
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<executions>
<execution>
<id>pre-integration-test</id>
<goals>
<goal>start</goal>
</goals>
</execution>
<execution>
<id>post-integration-test</id>
<goals>
<goal>stop</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
此类设置现在可以使用 failsafe-plugin 来运行您的集成测试,就像您期望的那样。
应用程序在单独的进程中启动,并使用 JMX 与应用程序通信。默认情况下,插件使用端口 9001 。如果您需要配置 JMX 端口,请参阅 专用示例。 |
您还可以配置更高级的设置,以便在设置特定属性时跳过集成测试,请参阅 专用示例。
在没有 Spring Boot 的父 POM 的情况下使用 Failsafe
Spring Boot 的父 POM,spring-boot-starter-parent
,将 Failsafe 的 <classesDirectory>
配置为 ${project.build.outputDirectory}
。如果没有此配置,会导致 Failsafe 使用编译后的类而不是重新打包的 jar,Failsafe 无法加载应用程序的类。如果您没有使用父 POM,则应以相同的方式配置 Failsafe,如下例所示
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-failsafe-plugin</artifactId>
<configuration>
<classesDirectory>${project.build.outputDirectory}</classesDirectory>
</configuration>
</plugin>
spring-boot:start
org.springframework.boot:spring-boot-maven-plugin:3.3.5
启动一个 Spring 应用程序。与 run
目标相反,此目标不会阻塞并允许其他目标在应用程序上操作。此目标通常用于集成测试场景,其中应用程序在测试套件之前启动并在之后停止。
可选参数
名称 | 类型 | 默认值 |
---|---|---|
|
|
|
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
|
|
|
|
|
|
||
|
||
|
|
|
|
||
|
||
|
|
|
|
||
|
|
|
|
|
|
|
参数详情
addResources
将 Maven 资源直接添加到类路径中,这允许对资源进行实时就地编辑。从 target/classes
中删除重复的资源,以防止在调用 ClassLoader.getResources()
时出现两次。请考虑改为将 spring-boot-devtools
添加到您的项目中,因为它提供了此功能以及更多其他功能。
名称 |
|
---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自版本 |
|
additionalClasspathElements
应添加到类路径中的其他类路径元素。元素可以是包含类和资源的目录或 jar 文件。
名称 |
|
---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自版本 |
|
classesDirectory
包含用于运行应用程序的类和资源文件的目录。
名称 |
|
---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自版本 |
|
commandlineArguments
应传递给应用程序的命令行参数。使用空格分隔多个参数,并确保将多个值括在引号中。如果指定,则优先于 #arguments
。
名称 |
|
---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自版本 |
|
directories
应添加到类路径中的其他包含类或资源的目录。
名称 |
|
---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自版本 |
|
environmentVariables
应与用于运行应用程序的分叉进程关联的环境变量列表。
名称 |
|
---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自版本 |
|
excludeGroupIds
要排除的 groupId 名称的逗号分隔列表(完全匹配)。
名称 |
|
---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自版本 |
|
excludes
要排除的构件定义集合。Exclude
元素定义必需的 groupId
和 artifactId
组件以及可选的 classifier
组件。当配置为属性时,值应以逗号分隔,并以冒号分隔组件:groupId:artifactId,groupId:artifactId:classifier
名称 |
|
---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自版本 |
|
includes
要包含的构件定义集合。Include
元素定义必需的 groupId
和 artifactId
组件以及可选的 classifier
组件。当配置为属性时,值应以逗号分隔,并以冒号分隔组件:groupId:artifactId,groupId:artifactId:classifier
名称 |
|
---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自版本 |
|
jmxName
自动部署的 MBean 的 JMX 名称,该 MBean 管理 Spring 应用程序的生命周期。
名称 |
|
---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自版本 |
jvmArguments
应与用于运行应用程序的分叉进程关联的 JVM 参数。在命令行上,确保将多个值括在引号中。
名称 |
|
---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自版本 |
|
mainClass
主类的名称。如果未指定,则将使用找到的第一个包含“main”方法的已编译类。
名称 |
|
---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自版本 |
|
maxAttempts
检查 Spring 应用程序是否已准备好的最大尝试次数。结合“wait”参数,这提供了一个全局超时值(默认值为 30 秒)
名称 |
|
---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自版本 |
profiles
要激活的 Spring 配置文件。指定“spring.profiles.active”参数的便捷快捷方式。在命令行上,使用逗号分隔多个配置文件。
名称 |
|
---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自版本 |
|
systemPropertyVariables
要传递给进程的 JVM 系统属性列表。
名称 |
|
---|---|
类型 |
|
默认值 |
|
用户属性 |
|
自版本 |
|
spring-boot:stop
示例
集成测试的随机端口
Spring Boot 测试集成的的一个不错的功能是它可以为 Web 应用程序分配一个空闲端口。当使用插件的 start
目标时,Spring Boot 应用程序会单独启动,这使得难以将实际端口传递给集成测试本身。
以下示例展示了如何使用Build Helper Maven 插件实现相同的功能
<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId>
<executions>
<execution>
<id>reserve-tomcat-port</id>
<goals>
<goal>reserve-network-port</goal>
</goals>
<phase>process-resources</phase>
<configuration>
<portNames>
<portName>tomcat.http.port</portName>
</portNames>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<executions>
<execution>
<id>pre-integration-test</id>
<goals>
<goal>start</goal>
</goals>
<configuration>
<arguments>
<argument>--server.port=${tomcat.http.port}</argument>
</arguments>
</configuration>
</execution>
<execution>
<id>post-integration-test</id>
<goals>
<goal>stop</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-failsafe-plugin</artifactId>
<configuration>
<systemPropertyVariables>
<test.server.port>${tomcat.http.port}</test.server.port>
</systemPropertyVariables>
</configuration>
</plugin>
</plugins>
</build>
您现在可以在任何集成测试中检索 test.server.port
系统属性以创建到服务器的正确 URL
。
自定义 JMX 端口
jmxPort
属性允许自定义插件用于与 Spring Boot 应用程序通信的端口。
此示例显示了如果 9001
端口已被使用,如何自定义端口
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<jmxPort>9009</jmxPort>
</configuration>
<executions>
<execution>
<id>pre-integration-test</id>
<goals>
<goal>start</goal>
</goals>
</execution>
<execution>
<id>post-integration-test</id>
<goals>
<goal>stop</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
如果您需要配置 JMX 端口,请确保在全局配置中进行配置,如上所示,以便两个目标共享它。 |
跳过集成测试
skip
属性允许完全跳过 Spring Boot Maven 插件的执行。
此示例显示了如何使用命令行属性跳过集成测试,并确保 repackage
目标仍然运行
<project>
<properties>
<skip.it>false</skip.it>
</properties>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<executions>
<execution>
<id>pre-integration-test</id>
<goals>
<goal>start</goal>
</goals>
<configuration>
<skip>${skip.it}</skip>
</configuration>
</execution>
<execution>
<id>post-integration-test</id>
<goals>
<goal>stop</goal>
</goals>
<configuration>
<skip>${skip.it}</skip>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-failsafe-plugin</artifactId>
<configuration>
<skip>${skip.it}</skip>
</configuration>
</plugin>
</plugins>
</build>
</project>
默认情况下,集成测试将运行,但此设置允许您轻松地使用以下命令行禁用它们
$ mvn verify -Dskip.it=true