如何在Helidon MP项目中Mock WebClient调用以进行单元测试

问题描述 #

请问是否可以Mock服务中的WebClient调用以进行单元测试？示例调用：以下代码片段是Helidon应用使用WebClient调用Consul服务的场景，也适用于其他调用外部服务的WebClient场景。

WebClientResponse webClientResponse = webClient.put().path(sessionRenewPath).submit().get();

我希望Mock该WebClient调用并获取WebClientResponse，同时想了解如何构建Mock的WebClientResponse。我尝试了以下代码，但未能成功：

@Mock
WebClientRequestBuilder webClientRequestBuilder;
@Mock
Single<WebClientResponse> webClientResponseSingle;
@Mock
WebClientResponse webClientResponse;

Mockito.when(webClient.post()).thenReturn(webClientRequestBuilder);
Mockito.doReturn(webClientRequestBuilder).when(webClientRequestBuilder).path(Mockito.any(String.class));
Mockito.doReturn(webClientResponseSingle).when(webClientRequestBuilder).submit();
Mockito.doReturn(webClientResponse).when(webClientResponseSingle).get();

解决方案 #

1. 修正核心Mock错误 #

你的代码中实际调用的是webClient.put()，但Mock的是webClient.post()，这是导致测试失败的直接原因，先修正这个方法对应关系。

2. 正确的Mock实现示例 #

基于JUnit 5 + Mockito的完整测试示例：

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import io.helidon.webclient.WebClient;
import io.helidon.webclient.WebClientRequestBuilder;
import io.helidon.webclient.WebClientResponse;
import io.reactivex.rxjava3.core.Single;

import static org.mockito.Mockito.*;

@ExtendWith(MockitoExtension.class)
public class WebClientMockTest {

    @Mock
    private WebClient webClient;

    @Mock
    private WebClientRequestBuilder requestBuilder;

    @Mock
    private WebClientResponse mockResponse;

    @Test
    void testWebClientCall() {
        // Mock 链式调用的每一步
        when(webClient.put()).thenReturn(requestBuilder);
        when(requestBuilder.path(anyString())).thenReturn(requestBuilder);
        
        // 用真实Single实例包装Mock响应，避免额外Mock Single方法
        Single<WebClientResponse> responseSingle = Single.just(mockResponse);
        when(requestBuilder.submit()).thenReturn(responseSingle);

        // 模拟业务代码中的调用
        WebClientResponse result = webClient.put().path("/consul/session/renew").submit().blockingGet();

        // 验证调用逻辑符合预期
        verify(webClient).put();
        verify(requestBuilder).path("/consul/session/renew");
        verify(requestBuilder).submit();
    }
}

3. 自定义Mock WebClientResponse #

如果需要Mock响应的具体属性（状态码、响应体等），直接Mock对应方法即可：

// Mock HTTP状态码
when(mockResponse.status()).thenReturn(HttpStatus.OK_200);

// Mock 响应体内容
when(mockResponse.content().as(String.class)).thenReturn(Single.just("{\"sessionId\":\"abc123\"}"));

// 同步获取响应体（模拟业务代码中的get()/blockingGet()）
String responseBody = mockResponse.content().as(String.class).blockingGet();

关键注意点 #

• 链式调用的每个方法必须返回正确的Mock对象，保证调用链不中断
• 对于RxJava的Single，优先用Single.just()创建真实实例，无需MockSingle自身的阻塞方法（原代码中MockSingle.get()是冗余操作）
• 确保Mockito版本与Helidon兼容，避免依赖冲突

内容的提问来源于stack exchange，提问作者Bhavin Zalavadia