如何在Ballerina单元测试中动态模拟HTTP Client？

核心思路 #

针对动态创建的HTTP客户端（无固定预定义端点），无法直接使用特定客户端实例的mock方案，可通过测试拦截器或自定义mock客户端工厂两种方式实现：前者全局拦截所有HTTP客户端调用，后者在客户端创建阶段动态注入mock逻辑，满足不同粒度的测试需求。

实现方法1：测试拦截器全局拦截 #

通过test:Interceptor捕获所有http:Client的远程调用，无论端点是什么，都能返回预设响应。

代码示例 #

import ballerina/http;
import ballerina/test;

// 定义拦截器，处理所有HTTP客户端请求
type MockHttpInterceptor test:Interceptor = object {
    *test:Interceptor;

    function intercept(string|http:Caller caller, string method, string path, 
                      http:Request request, map<string|string[]> headers) returns test:InterceptorResult {
        // 根据请求的路径/方法返回对应模拟响应
        http:Response mockResponse = new;
        mockResponse.statusCode = 200;
        mockResponse.setPayload({"data": "动态端点的模拟响应"});
        
        return {response: mockResponse};
    }
};

// 测试用例
@test:Config
function testDynamicHttpClientCall() {
    // 注册拦截器，生效全局HTTP客户端调用拦截
    test:registerInterceptor(new MockHttpInterceptor());

    // 调用目标资源函数（内部会动态创建HTTP客户端发起请求）
    http:Response serviceResponse = myHttpService->myResourceFunction();

    // 断言结果符合预期
    test:assertEquals(serviceResponse.statusCode, 200);
    test:assertEquals(serviceResponse.getPayload(), {"data": "动态端点的模拟响应"});
}

实现方法2：动态注入Mock客户端 #

通过抽象客户端创建逻辑，在测试环境下替换为mock客户端，支持针对不同动态端点返回差异化响应。

业务代码抽象（客户端创建） #

import ballerina/http;

// 抽离客户端创建逻辑，方便测试替换
function createHttpClient(string endpointUrl) returns http:Client {
    // 测试环境返回mock客户端，生产环境返回真实客户端
    if test:isRunning() {
        return test:mock(http:Client, mockClientImpl);
    }
    return check new http:Client(endpointUrl);
}

// 定义mock客户端的具体实现
http:Client mockClientImpl = object {
    *http:Client;

    function get(string path) returns http:Response|error {
        // 根据请求路径返回对应模拟数据
        http:Response res = new;
        res.statusCode = 200;
        res.setPayload({"dynamic_data": "针对" + path + "的模拟响应"});
        return res;
    }

    // 按需实现其他需要模拟的HTTP方法（post/put等）
};

测试用例 #

import ballerina/test;

@test:Config
function testDynamicEndpointCall() {
    // 调用业务逻辑，此时自动使用mock客户端
    http:Response response = myResourceLogic("https://dynamic-endpoint.com/api");
    test:assertEquals(response.statusCode, 200);
    test:assertEquals(response.getPayload(), {"dynamic_data": "针对/api的模拟响应"});
}

关键注意事项 #

• 拦截器方式无需修改业务代码，适合快速验证整体流程，但粒度较粗；
• 动态注入方式灵活性更高，可针对不同端点定制响应，但需要对业务代码做少量抽象；
• 确保测试逻辑仅在test:isRunning()为真时生效，避免影响生产环境代码执行。

内容的提问来源于stack exchange，提问作者Minuli Kannangara