Python中了解botocore.stubStubber()的必备知识

在Python中，botocore.stub.Stubber 类提供了一种方便的方式来模拟 AWS 服务的行为。Stubber 可以用于编写单元测试和集成测试，以便测试代码在调用实际 AWS 服务之前是否正确地准备了请求并处理了响应。 Stubber 提供了多个方法来配置预期请求和对应的响应，并将其用于测试代码中的实例。

Stubber 类基于 botocore.client.BaseClient 类进行构建，它是 botocore 框架的低级原语之一。对于要模拟的 AWS 服务，可以使用 botocore.session.get_session() 方法创建一个 session，然后创建一个 client。

以下是 botocore.stub.Stubber 的常用方法和使用示例：

1. add_response(method, response, expected_params=None)：

- 用于添加对应给定方法 (method) 的预期响应 (response)。

- 可选地，可以提供期望的请求参数 (expected_params)，以确保只有匹配的请求才会返回预期响应。

- 示例：

     import botocore.stub

     def test_add_response():
         stubber = botocore.stub.Stubber(client)
         response = {...}
         stubber.add_response('list_objects', response, expected_params={'Bucket': 'test-bucket'})
         stubber.activate()
         client.list_objects(...)
     

2. add_client_error(method_name, error_code, service_error_code=None, expected_params=None)：

- 用于添加对应给定方法 (method_name) 的服务错误 (error_code)。

- 可选地，可以提供服务错误的错误代码 (service_error_code)。

- 可选地，可以提供期望的请求参数 (expected_params)，以确保只有匹配的请求才会返回服务错误。

- 示例：

     def test_add_client_error():
         stubber = botocore.stub.Stubber(client)
         stubber.add_client_error('get_object', 'NoSuchKey', expected_params={'Bucket': 'test-bucket', 'Key': 'test-key'})
         stubber.activate()
         client.get_object(...)
     

3. activate()：

- 在 stubber 配置完成后，用于激活 Stubber 以开始拦截实际 AWS 服务的请求和响应。

- 示例：

     def test_activate():
         stubber = botocore.stub.Stubber(client)
         stubber.activate()
         client.list_objects(...)
     

4. deactivate()：

- 在使用 Stubber 后，用于取消激活 Stubber，以便请求和响应将发送到实际的 AWS 服务。

- 示例：

     def test_deactivate():
         stubber = botocore.stub.Stubber(client)
         stubber.activate()
         client.list_objects(...)
         stubber.deactivate()
         client.list_objects(...)
     

5. assert_no_pending_responses()：

- 断言确认所有预期请求都已经被显式处理。

- 示例：

     def test_assert_no_pending_responses():
         stubber = botocore.stub.Stubber(client)
         response = {...}
         stubber.add_response('list_objects', response, expected_params={'Bucket': 'test-bucket'})
         stubber.activate()
         client.list_objects(...)
         stubber.assert_no_pending_responses()
     

使用 botocore.stub.Stubber，你可以完全控制模拟 AWS 服务的行为，并确保代码在与实际 AWS 服务进行交互之前正确地准备请求和处理响应。