用于从 S3 下载文件的模拟 boto3 响应

Question

我有使用boto3从 S3 存储桶下载文件的代码。

# foo.py
def dl(src_f, dest_f):
  s3 = boto3.resource('s3')
  s3.Bucket('mybucket').download_file(src_f, dest_f)

我现在想编写一个dl()使用 pytest的单元测试，并使用 botocore 中提供的存根模拟与 AWS 的交互。

@pytest.fixture
def s3_client():
    yield boto3.client("s3")

from foo import dl
def test_dl(s3_client):

  with Stubber(s3_client) as stubber:
    params = {"Bucket": ANY, "Key": ANY}
    response = {"Body": "lorem"}
    stubber.add_response(SOME_OBJ, response, params)
    dl('bucket_file.txt', 'tmp/bucket_file.txt')
    assert os.path.isfile('tmp/bucket_file.txt')

我不确定对此的正确方法。如何添加bucket_file.txt到存根响应中？我需要什么对象add_response()（显示为SOME_OBJ）？

Answer 1

您是否考虑过使用moto3？
您的代码可能看起来与现在相同：

# foo.py
def dl(src_f, dest_f):
  s3 = boto3.resource('s3')
  s3.Bucket('mybucket').download_file(src_f, dest_f)

和测试：

import boto3
import os
from moto import mock_s3

@mock_s3
def test_dl():
    s3 = boto3.client('s3', region_name='us-east-1')
    # We need to create the bucket since this is all in Moto's 'virtual' AWS account
    s3.create_bucket(Bucket='mybucket')
    
    s3.put_object(Bucket='mybucket', Key= 'bucket_file.txt', Body='')
    dl('bucket_file.txt', 'bucket_file.txt')

    assert os.path.isfile('bucket_file.txt')

代码的意图变得更加明显，因为您只是像往常一样使用 s3，除了方法调用后面没有真正的 s3。