SaloonPHP中如何为同一请求类配置不同的Mock响应

在API测试和开发过程中，SaloonPHP是一个非常实用的PHP HTTP客户端库。本文将深入探讨如何在SaloonPHP测试中为同一个请求类配置不同的Mock响应，这是API测试中一个常见且重要的需求场景。

问题背景

在编写API测试时，我们经常会遇到这样的情况：同一个请求类会在测试中被多次调用，但每次调用需要返回不同的响应数据。例如：

• 创建多个网络资源时，每个创建请求可能需要返回不同的网络ID和配置
• 批量创建服务器时，每个创建请求可能需要返回不同的服务器信息

直接使用MockClient的全局配置时，如果简单地为同一个请求类定义多个Mock响应，只有最后一个定义会生效，这显然无法满足我们的测试需求。

解决方案

SaloonPHP提供了两种灵活的方式来解决这个问题：

方法一：分阶段配置MockClient

// 第一阶段配置
MockClient::global([
    NetworkCreatePrivateRequest::class => MockResponse::fixture("create_private_network_request"),
    CreateServer::class => MockResponse::fixture("create_server_1")
]);

// 执行第一阶段测试

// 第二阶段配置
MockClient::global([
    NetworkCreatePrivateRequest::class => MockResponse::fixture("create_vm_network_request"),
    CreateServer::class => MockResponse::fixture("create_server_2")
]);

// 执行第二阶段测试

这种方法简单直接，适合测试流程明确分阶段的情况。通过在不同测试阶段重新配置MockClient，可以实现不同阶段返回不同响应。

方法二：使用闭包动态返回响应

MockClient::global([
    NetworkCreatePrivateRequest::class => function (PendingRequest $pendingRequest) {
        $request = $pendingRequest->getRequest();
        $networkName = $request->name; // 从请求中获取标识参数
        
        return MockResponse::fixture("create_{$networkName}_network_request");
    },
    CreateServer::class => function (PendingRequest $pendingRequest) {
        // 可根据请求内容决定返回哪个fixture
        return MockResponse::fixture("create_server_".rand(1,3));
    }
]);

这种方法更加灵活，它通过闭包函数动态决定返回哪个Mock响应。我们可以：

1. 从请求对象中获取标识参数（如请求体中的名称、ID等）
2. 根据业务逻辑决定返回哪个fixture文件
3. 甚至可以实现随机返回或条件判断

最佳实践建议

1. 合理命名fixture文件：采用有意义的命名约定，如"create_network_vm1"、"create_server_web"等，便于维护

2. 保持fixture数据最小化：每个fixture只包含必要的测试数据，避免冗余

3. 考虑使用请求参数：充分利用请求中的参数（如查询参数、请求体）来动态决定响应

4. 文档记录：在测试代码中添加注释，说明不同fixture的使用场景

5. 异常情况测试：可以配置某些条件下返回错误响应，测试异常处理逻辑

总结

SaloonPHP提供了灵活的Mock响应配置方式，特别是闭包函数的支持，使得我们能够轻松实现同一请求类在不同场景下返回不同响应。这种能力对于编写全面、可靠的API测试至关重要。开发者可以根据具体测试需求选择分阶段配置或动态闭包的方式，构建出更加健壮的测试套件。