執行整合測試

雖然您可以很容易地從測試(或測試套件)本身啟動您的 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 父 POM 的 Failsafe

Spring Boot 的父 POM,spring-boot-starter-parent,將 Failsafe 的 <classesDirectory> 配置為 ${project.build.outputDirectory}。如果沒有此配置,Failsafe 將無法載入您的應用程式類,因為它會導致 Failsafe 使用已編譯的類而不是重新打包的 jar。如果您不使用父 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:4.0.0

啟動一個 Spring 應用程式。與 run 目標相反,這不會阻塞,並允許其他目標在應用程式上執行。此目標通常用於整合測試場景,其中應用程式在測試套件之前啟動並在之後停止。

所需引數

名稱 型別 預設值

classesDirectory

檔案

${project.build.outputDirectory}

可選引數

名稱 型別 預設值

addResources

布林值

additionalClasspathElements

String[]

agents

File[]

arguments

String[]

commandlineArguments

字串

environmentVariables

Map

excludeGroupIds

字串

excludes

List

includes

List

jmxName

字串

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

jmxPort

int

9001

jvmArguments

字串

mainClass

字串

maxAttempts

int

60

noverify

布林值

profiles

String[]

skip

布林值

systemPropertyVariables

Map

useTestClasspath

布林值

wait

long

500

workingDirectory

檔案

引數詳情

addResources

直接將 Maven 資源新增到類路徑,這允許即時原地編輯資源。重複的資源將從 target/classes 中移除,以防止在呼叫 ClassLoader.getResources() 時它們出現兩次。請考慮將 spring-boot-devtools 新增到您的專案中,因為它提供了此功能以及更多功能。

名稱

addResources

型別

布林值

預設值

使用者屬性

spring-boot.run.addResources

1.0.0

additionalClasspathElements

應新增到類路徑的額外類路徑元素。一個元素可以是包含類和資源的目錄,也可以是 jar 檔案。

名稱

additionalClasspathElements

型別

java.lang.String[]

預設值

使用者屬性

spring-boot.run.additional-classpath-elements

3.2.0

agents

代理 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

自動部署的 MBean 的 JMX 名稱,用於管理 Spring 應用程式的生命週期。

名稱

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

指示代理需要 -noverify 的標誌。

名稱

noverify

型別

布林值

預設值

使用者屬性

spring-boot.run.noverify

1.0.0

profiles

要啟用的 Spring 配置檔案。指定 'spring.profiles.active' 引數的便捷快捷方式。在命令列上使用逗號分隔多個配置檔案。

名稱

profiles

型別

java.lang.String[]

預設值

使用者屬性

spring-boot.run.profiles

1.3.0

skip

跳過執行。

名稱

skip

型別

布林值

預設值

使用者屬性

spring-boot.run.skip

1.3.2

systemPropertyVariables

要傳遞給程序的 JVM 系統屬性列表。

名稱

systemPropertyVariables

型別

java.util.Map

預設值

使用者屬性

2.1.0

useTestClasspath

執行時代包含測試類路徑的標誌。

名稱

useTestClasspath

型別

布林值

預設值

使用者屬性

spring-boot.run.useTestClasspath

wait

每次嘗試檢查 Spring 應用程式是否準備就緒之間等待的毫秒數。

名稱

wait

型別

long

預設值

500

使用者屬性

spring-boot.start.wait

workingDirectory

應用程式使用的當前工作目錄。如果未指定,將使用基於目錄。

名稱

workingDirectory

型別

java.io.File

預設值

使用者屬性

spring-boot.run.workingDirectory

1.5.0

spring-boot:stop

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

停止已由“start”目標啟動的應用程式。通常在測試套件完成後呼叫。

可選引數

名稱 型別 預設值

jmxName

字串

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

jmxPort

int

9001

skip

布林值

引數詳情

jmxName

管理應用程式生命週期的自動部署 MBean 的 JMX 名稱。

名稱

jmxName

型別

java.lang.String

預設值

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

使用者屬性

jmxPort

用於查詢平臺 MBeanServer 的埠。

名稱

jmxPort

型別

int

預設值

9001

使用者屬性

skip

跳過執行。

名稱

skip

型別

布林值

預設值

使用者屬性

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
© . This site is unofficial and not affiliated with VMware.