Provider Contract Testing with Stubs in Artifactory for a non-Spring Application
在这个页面里,你将学习如何对非 Spring 应用程序和已上传到 Artifactory 的存根执行提供者合同测试。
The Flow
您可以阅读 Developing Your First Spring Cloud Contract-based Application 以查看在 Nexus 或 Artifactory 中使用存根进行提供者合同测试的流程。
Setting up the Consumer
对于消费者端,你可以使用 JUnit 规则。通过这种方式,你不需要启动 Spring 上下文。以下列表展示了该规则(在 JUnit4 和 JUnit 5 中);
- ===JUnit 4 Rule
-
@Rule public StubRunnerRule rule = new StubRunnerRule() .downloadStub("com.example","artifact-id", "0.0.1") .repoRoot("git://git@github.com: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://git@github.com:spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git") .stubsMode(StubRunnerProperties.StubsMode.REMOTE);
===
Setting up the Producer
默认情况下,Spring Cloud Contract 插件为已生成的测试使用 Rest Assured 的 MockMvc
设置。由于非 Spring 应用程序不使用 MockMvc
,你可以将 testMode
更改为 EXPLICIT
,以便向绑定到特定端口的应用程序发送真实请求。
在此示例中,我们使用名为 Javalin 的框架来启动非 Spring HTTP 服务器。
假设我们拥有以下应用程序:
package com.example.demo;
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 = "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 Cloud Contract插件,以使用`EXPLICIT`模式发送实际请求,而不是模拟请求。
-
我们已定义一个基类,用于:
-
在每个测试的随机端口上启动HTTP服务器。
-
将REST Assured设置为向该端口发送请求。
-
在每个测试之后关闭HTTP服务器。
-