运行集成测试

虽然你可以非常轻松地从测试(或测试套件)本身启动你的 Spring Boot 应用,但更推荐在构建过程中处理。为了确保你的 Spring Boot 应用的生命周期能够在集成测试前后得到适当管理,你可以使用 startstop 目标,如下例所示

<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 的 Parent POM 使用 Failsafe

Spring Boot 的 Parent POM,即 spring-boot-starter-parent,将 Failsafe 的 <classesDirectory> 配置为 ${project.build.outputDirectory}。没有这个配置(它使 Failsafe 使用编译后的类而不是重新打包的 jar),Failsafe 无法加载你的应用类。如果你没有使用 parent 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.4.5

启动一个 spring 应用。与 run 目标不同,这个目标不会阻塞,并允许其他目标操作应用。此目标通常用于集成测试场景,在测试套件之前启动应用并在之后停止。

必需参数

名称 类型 默认值

classesDirectory

File

${project.build.outputDirectory}

可选参数

名称 类型 默认值

addResources

boolean

false

additionalClasspathElements

String[]

agents

File[]

arguments

String[]

commandlineArguments

String

environmentVariables

Map

excludeGroupIds

String

excludes

List

includes

List

jmxName

String

org.springframework.boot:type=Admin,name=SpringApplication

jmxPort

int

9001

jvmArguments

String

mainClass

String

maxAttempts

int

60

noverify

boolean

profiles

String[]

skip

boolean

false

systemPropertyVariables

Map

useTestClasspath

Boolean

false

wait

long

500

workingDirectory

File

参数详情

addResources

直接将 Maven 资源添加到 classpath,这允许对资源进行实时就地编辑。重复的资源会从 target/classes 中移除,以防止在调用 ClassLoader.getResources() 时出现两次。请考虑在你的项目中添加 spring-boot-devtools,因为它提供了此功能以及更多其他功能。

名称

addResources

类型

boolean

默认值

false

用户属性

spring-boot.run.addResources

1.0.0

additionalClasspathElements

应添加到 classpath 的额外 classpath 元素。元素可以是包含类和资源的目录或 jar 文件。

名称

additionalClasspathElements

类型

java.lang.String[]

默认值

用户属性

spring-boot.run.additional-classpath-elements

3.2.0

agents

Agent jar 路径。

名称

agents

类型

java.io.File[]

默认值

用户属性

spring-boot.run.agents

2.2.0

arguments

应传递给应用的参数。

名称

arguments

类型

java.lang.String[]

默认值

用户属性

1.0.0

classesDirectory

包含应用于运行应用的类文件和资源文件的目录。

名称

classesDirectory

类型

java.io.File

默认值

${project.build.outputDirectory}

用户属性

1.0.0

commandlineArguments

应传递给应用的命令行参数。使用空格分隔多个参数,并确保将多个值用引号括起来。指定时,优先级高于 #arguments

名称

commandlineArguments

类型

java.lang.String

默认值

用户属性

spring-boot.run.arguments

2.2.3

environmentVariables

应与用于运行应用的分叉进程关联的环境变量列表。

名称

environmentVariables

类型

java.util.Map

默认值

用户属性

2.1.0

excludeGroupIds

要排除的 groupId 名称列表(逗号分隔,精确匹配)。

名称

excludeGroupIds

类型

java.lang.String

默认值

用户属性

spring-boot.excludeGroupIds

1.1.0

excludes

要排除的 artifact 定义集合。Exclude 元素定义了必需的 groupIdartifactId 组件以及可选的 classifier 组件。配置为属性时,值应以逗号分隔,组件以冒号分隔:groupId:artifactId,groupId:artifactId:classifier

名称

excludes

类型

java.util.List

默认值

用户属性

spring-boot.excludes

1.1.0

includes

要包含的 artifact 定义集合。Include 元素定义了必需的 groupIdartifactId 组件以及可选的 classifier 组件。配置为属性时,值应以逗号分隔,组件以冒号分隔:groupId:artifactId,groupId:artifactId:classifier

名称

includes

类型

java.util.List

默认值

用户属性

spring-boot.includes

1.2.0

jmxName

管理 spring 应用生命周期的自动部署 MBean 的 JMX 名称。

名称

jmxName

类型

java.lang.String

默认值

org.springframework.boot:type=Admin,name=SpringApplication

用户属性

jmxPort

用于暴露平台 MBeanServer 的端口。

名称

jmxPort

类型

int

默认值

9001

用户属性

jvmArguments

应与用于运行应用的分叉进程关联的 JVM 参数。在命令行上,确保将多个值用引号括起来。

名称

jvmArguments

类型

java.lang.String

默认值

用户属性

spring-boot.run.jvmArguments

1.1.0

mainClass

主类的名称。如果未指定,则使用找到的第一个包含 'main' 方法的编译类。

名称

mainClass

类型

java.lang.String

默认值

用户属性

spring-boot.run.main-class

1.0.0

maxAttempts

检查 spring 应用是否就绪的最大尝试次数。与 "wait" 参数结合使用,这会提供一个全局超时值(默认为 30 秒)。

名称

maxAttempts

类型

int

默认值

60

用户属性

spring-boot.start.maxAttempts

noverify

标记,表示 agent 需要 -noverify。

名称

noverify

类型

boolean

默认值

用户属性

spring-boot.run.noverify

1.0.0

profiles

要激活的 spring profile。这是指定 'spring.profiles.active' 参数的便捷快捷方式。在命令行上,使用逗号分隔多个 profile。

名称

profiles

类型

java.lang.String[]

默认值

用户属性

spring-boot.run.profiles

1.3.0

skip

跳过执行。

名称

skip

类型

boolean

默认值

false

用户属性

spring-boot.run.skip

1.3.2

systemPropertyVariables

要传递给进程的 JVM 系统属性列表。

名称

systemPropertyVariables

类型

java.util.Map

默认值

用户属性

2.1.0

useTestClasspath

运行时是否包含测试 classpath 的标记。

名称

useTestClasspath

类型

java.lang.Boolean

默认值

false

用户属性

spring-boot.run.useTestClasspath

wait

每次检查 spring 应用是否就绪之间的等待毫秒数。

名称

wait

类型

long

默认值

500

用户属性

spring-boot.start.wait

workingDirectory

应用使用的当前工作目录。如果未指定,将使用 basedir。

名称

workingDirectory

类型

java.io.File

默认值

用户属性

spring-boot.run.workingDirectory

1.5.0

spring-boot:stop

org.springframework.boot:spring-boot-maven-plugin:3.4.5

停止由 "start" 目标启动的应用。通常在测试套件完成后调用。

可选参数

名称 类型 默认值

jmxName

String

org.springframework.boot:type=Admin,name=SpringApplication

jmxPort

int

9001

skip

boolean

false

参数详情

jmxName

管理应用生命周期的自动部署 MBean 的 JMX 名称。

名称

jmxName

类型

java.lang.String

默认值

org.springframework.boot:type=Admin,name=SpringApplication

用户属性

jmxPort

用于查找平台 MBeanServer 的端口。

名称

jmxPort

类型

int

默认值

9001

用户属性

skip

跳过执行。

名称

skip

类型

boolean

默认值

false

用户属性

spring-boot.stop.skip

1.3.2

示例

集成测试的随机端口

Spring Boot 测试集成的一个不错特性是它可以为 Web 应用分配一个空闲端口。当使用插件的 start 目标时,Spring Boot 应用会单独启动,这使得将实际端口传递给集成测试本身变得困难。

以下示例展示了如何使用 Build Helper Maven Plugin 实现相同的功能

<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