非 Spring 應用中使用 Artifactory 中的 Stubs 進行提供者契約測試

在本頁中，你將學習如何在非 Spring 應用中使用上傳到 Artifactory 的 stubs 進行提供者契約測試。

流程

你可以閱讀開發你的第一個基於 Spring Cloud Contract 的應用來檢視如何使用 Nexus 或 Artifactory 中的 stubs 進行提供者契約測試的流程。

設定消費者端

對於消費者端，你可以使用 JUnit rule。這樣，你就不需要啟動 Spring 上下文。下面的列表展示了這樣的一個 rule（在 JUnit4 和 JUnit 5 中）；

JUnit 4 Rule

@Rule
	public StubRunnerRule rule = new StubRunnerRule()
			.downloadStub("com.example","artifact-id", "0.0.1")
			.repoRoot("git://[email protected]:spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git")
			.stubsMode(StubRunnerProperties.StubsMode.REMOTE);

JUnit 5 Extension

@RegisterExtension
	public StubRunnerExtension stubRunnerExtension = new StubRunnerExtension()
			.downloadStub("com.example","artifact-id", "0.0.1")
			.repoRoot("git://[email protected]:spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git")
			.stubsMode(StubRunnerProperties.StubsMode.REMOTE);

設定生產者端

預設情況下，Spring Cloud Contract Plugin 使用 Rest Assured 的 MockMvc 設定來生成測試。由於非 Spring 應用不使用 MockMvc，你可以將 testMode 修改為 EXPLICIT 以向繫結在特定埠的應用傳送真實請求。

在此示例中，我們使用一個名為 Javalin 的框架來啟動一個非 Spring HTTP 伺服器。

假設我們有以下應用

import io.javalin.Javalin;

public class DemoApplication {

	public static void main(String[] args) {
		new DemoApplication().run(7000);
	}

	public Javalin start(int port) {
		return Javalin.create().start(port);
	}

	public Javalin registerGet(Javalin app) {
		return app.get("/", ctx -> ctx.result("Hello World"));
	}

	public Javalin run(int port) {
		return registerGet(start(port));
	}

}

考慮到這個應用，我們可以設定外掛使用 EXPLICIT 模式（即向真實埠傳送請求），如下所示

Maven

<plugin>
	<groupId>org.springframework.cloud</groupId>
	<artifactId>spring-cloud-contract-maven-plugin</artifactId>
	<version>${spring-cloud-contract.version}</version>
	<extensions>true</extensions>
	<configuration>
		<baseClassForTests>com.example.demo.BaseClass</baseClassForTests>
		<!-- This will setup the EXPLICIT mode for the tests -->
		<testMode>EXPLICIT</testMode>
	</configuration>
</plugin>

Gradle

contracts {
	// This will setup the EXPLICIT mode for the tests
	testMode = "EXPLICIT"
	baseClassForTests = "com.example.demo.BaseClass"
}

基類可能如下所示

import io.javalin.Javalin;
import io.restassured.RestAssured;
import org.junit.After;
import org.junit.Before;
import org.springframework.cloud.test.TestSocketUtils;

public class BaseClass {

	Javalin app;

	@Before
	public void setup() {
		// pick a random port
		int port = TestSocketUtils.findAvailableTcpPort();
		// start the application at a random port
		this.app = start(port);
		// tell Rest Assured where the started application is
		RestAssured.baseURI = "https://:" + port;
	}

	@After
	public void close() {
		// stop the server after each test
		this.app.stop();
	}

	private Javalin start(int port) {
		// reuse the production logic to start a server
		return new DemoApplication().run(port);
	}
}

透過這樣的設定

我們已經設定 Spring Cloud Contract 外掛使用 EXPLICIT 模式來發送真實請求，而不是模擬請求。
我們已經定義了一個基類，它會
- 為每個測試在隨機埠啟動 HTTP 伺服器。
- 設定 Rest Assured 向該埠傳送請求。
- 在每個測試後關閉 HTTP 伺服器。