執行整合測試

雖然你可以非常輕鬆地從測試(或測試套件)本身啟動你的 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