RSocket 的“Wiremock”

工程 | Dave Syer | 2021 年 6 月 2 日 | ...

如果您有一个应用程序在运行时连接到 RSocket 服务器,您将如何测试它?我们需要一种方式来启动服务器并告知其监听的地址,然后我们需要能够注册请求和响应示例(也称为“契约”)。这就是这个 项目所提供的——它就像 RSocket 的 Wiremock。

入门

使用该项目的最简单方法是将其作为 JUnit (Jupiter) 扩展,例如:

@SpringBootTest
@ExtendWith(RSocketServerExtension.class)
class SocketsApplicationTests {
	...
}

安装此扩展后,Spring Boot 测试将使用 RSocket 服务器运行,该服务器侦听由 test.rsocket.server.port 指定的端口,以便测试可以直接连接到它,或者(更有可能的是)它正在测试的代码将连接到它。您可能需要通过 @SpringBootTest 注解告诉它连接到哪里,例如,如果应用程序在运行时查找名为 rsocket.port 的属性。

@SpringBootTest("rsocket.port=${test.rsocket.server.port}")
@ExtendWith(RSocketServerExtension.class)
class SocketsApplicationTests {
	...
}

在 JSON 中定义消息映射

测试方法可以注入 RSocketMessageCatalogRSocketMessageRegistry,然后使用它们来设置或检查服务器的状态。默认情况下,服务器从类路径中 /catalog/*.json 的位置读取 JSON 合同,因此您可以在本地或在与服务器共享的测试库中设置这些合同。JSON 的结构反映了存储在 RSocketMessageCatalog 中的 MessageMapping。这是一个例子(请求和响应只是 JSON 对象)。

{
	"pattern": "events.response.*",
	"frameType": "REQUEST_RESPONSE",
	"request": {
		"origin": "Client"
	},
	"response": {
		"origin": "Server",
		"interaction": "Response",
		"index": 0
	}
}

此映射将匹配路由模式的任何 REQUEST_RESPONSE 帧类型,并且请求中还有一个字段“origin”等于“Client”。您还可以通过添加通配符来匹配请求字段中的模式。或者,您可以省略请求以仅根据路由进行匹配。如果帧类型是 REQUEST_RESPONSE,则响应是单值的。如果帧类型是 REQUEST_STREAM,您可以提供一个多值的“responses”,例如

{
	"pattern": "my.stream.route",
	"frameType": "REQUEST_STREAM",
	"responses": [
		{
			"origin": "Server",
			"interaction": "Stream",
			"index": 0
		},
		{
			"origin": "Server",
			"interaction": "Stream",
			"index": 1
		},
		{
			"origin": "Server",
			"interaction": "Stream",
			"index": 2
		}
	]
}

此外,您还可以指定一个整数字段“repeat”来重复响应以形成更长的流。如果帧类型是 REQUEST_FNF,则没有响应,请求将被忽略。最后,如果帧类型是 REQUEST_CHANNEL,则映射 JSON 的格式与 REQUEST_STREAM 相同,除了每次从输入流接收到消息时,都会再次发出输出流。

操作和检查消息目录

如果您需要更灵活的规则处理,可以通过接口中方便的静态工厂方法创建自己的 MessageMapping。您可以提供一个处理函数(除了“fire and forget”情况),一个匹配的模式,以及可选的匹配请求。这些方法可用于动态注册映射,以在运行时定义服务器的预期行为。

您可以通过从目录中获取 MessageMapping,然后调用其中一个 drain() 方法来排出收到的请求,从而检查服务器的状态。例如

@SpringBootTest
@ExtendWith(RSocketServerExtension.class)
class DynamicRouteTests {

	private RSocketRequester rsocketRequester;

	public DynamicRouteTests(@Autowired RSocketRequester.Builder rsocketRequesterBuilder,
			@Value("${test.rsocket.server.port:7000}") int port) {
		rsocketRequester = rsocketRequesterBuilder.tcp("localhost", port);
	}

	@Test
	void response(RSocketMessageRegistry catalog) {
		MessageMapping response = MessageMapping.response("response")
				.response(new Foo("Server", "Response"));
		catalog.register(response);
		assertThat(rsocketRequester.route("response").data(new Foo("Client", "Request"))
				.retrieveMono(Foo.class).doOnNext(foo -> {
					System.err.println(foo);
					assertThat(foo.getOrigin()).isEqualTo("Server");
				}).block()).isNotNull();
		assertThat(response.drain()).hasSize(1);
		assertThat(response.drain()).hasSize(0);
	}

}

这里的代码仍然是一个原型,但它已经可能非常有用了。所以尝试一下,并发送反馈,也许我们可以将其成熟到可以发布的程度。

获取 Spring 新闻通讯

通过 Spring 新闻通讯保持联系

订阅

领先一步

VMware 提供培训和认证,助您加速进步。

了解更多

获得支持

Tanzu Spring 提供 OpenJDK™、Spring 和 Apache Tomcat® 的支持和二进制文件,只需一份简单的订阅。

了解更多

即将举行的活动

查看 Spring 社区所有即将举行的活动。

查看所有