在 Artifactory 中使用非 Spring 应用程序的存根进行提供者合同测试

在本页中,您将学习如何使用上传到 Artifactory 的非 Spring 应用程序和存根进行提供者协定测试。spring-doc.cn

流程

您可以阅读开发您的第一个 Spring Cloud 基于契约的应用程序,以查看在 Nexus 或 Artifactor 中使用存根进行提供商契约测试的流程。spring-doc.cn

设置 Consumer

对于使用者端,您可以使用 JUnit 规则。这样,你就不需要启动 Spring 上下文。下面的清单显示了这样的规则(在 JUnit4 和 JUnit 5 中);spring-doc.cn

JUnit 4 规则
@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 扩展
@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);

设置 Producer

默认情况下,Spring Cloud Contract 插件使用 Rest Assure 的 生成的测试。由于非 Spring 应用程序不使用,因此您可以更改 to 以将实际请求发送到绑定到特定端口的应用程序。MockMvcMockMvctestModeEXPLICITspring-doc.cn

在此示例中,我们使用一个名为 Javalin 的框架来启动 非 Spring HTTP 服务器。spring-doc.cn

假设我们有以下应用程序:spring-doc.cn

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));
	}

}

给定该应用程序,我们可以将插件设置为使用模式(即 向真实端口发送请求),如下所示:EXPLICITspring-doc.cn

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"
}

基类可能类似于以下内容:spring-doc.cn

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 = "http://localhost:" + 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-doc.cn

  • 我们已经搭建了 Spring Cloud Contract 插件,使用该模式发送真实 requests 而不是 mock 的。EXPLICITspring-doc.cn

  • 我们定义了一个基类:spring-doc.cn

    • 在每个测试的随机端口上启动 HTTP 服务器。spring-doc.cn

    • 将 Rest Assured 设置为向该端口发送请求。spring-doc.cn

    • 在每次测试后关闭 HTTP 服务器。spring-doc.cn