如何在Python单元测试中Mock文件保存函数以避免磁盘写入？

问题分析 #

你当前的测试会向磁盘写入文件，想要MockFileStorage.save方法避免实际IO操作，但之前的尝试没有生效，原因有两点：

1. 你patch的是werkzeug.datastructures.FileStorage类本身，但服务端使用的是请求解析后生成的实例，类级别的mock不会作用到已存在的实例上。
2. 手动给构造的FileStorage实例赋值save=MagicMock，但Flask测试客户端在处理multipart/form-data请求时，会重新解析生成新的FileStorage实例，导致你的mock不会被服务端调用。

正确解决方案 #

方案一：Patch服务端模块中的FileStorage.save方法 #

这是最可靠的方式，直接拦截服务端代码中调用的save方法，不管请求如何构造都能生效。

假设你的服务端代码位于app/resources/upload.py（替换成你实际的模块路径），测试代码如下：

from io import BytesIO
from unittest.mock import patch

def test_upload_file_post_success(client):
    # Patch服务端模块中使用的FileStorage.save方法
    with patch('app.resources.upload.FileStorage.save') as mocked_save, \
         patch('app.resources.upload.validate_file_content') as mocked_validate:
        # 配置mock的返回值
        mocked_save.return_value = None
        mocked_validate.return_value = None  # 模拟文件验证成功

        data = {
            'fields': 'somefield',
            'file': (BytesIO(b'FILE CONTENT'), 'test.csv')
        }
        response = client.post(
            '/file-upload',
            content_type='multipart/form-data',
            data=data
        )

        # 验证响应状态
        assert response.status_code == 200
        # 验证save方法被调用一次
        mocked_save.assert_called_once()
        # 可选：验证save的参数是否符合预期
        # expected_path = os.path.join('api/upload/datasets', 'test.csv')
        # mocked_save.assert_called_once_with(expected_path)
        # 验证文件验证函数被调用
        mocked_validate.assert_called_once()

方案二：传递Mock的FileStorage实例给测试客户端 #

如果需要更精准控制单个文件实例的mock，可以直接构造带mocksave方法的FileStorage对象，注意要确保客户端不会重新解析该对象：

from io import BytesIO
from werkzeug.datastructures import FileStorage
from unittest.mock import MagicMock, patch

def test_upload_file_post_success(client):
    # 构造带mock save方法的FileStorage实例
    mock_file = FileStorage(
        stream=BytesIO(b'FILE CONTENT'),
        filename='test.csv',
        content_type='text/csv'
    )
    mock_file.save = MagicMock(return_value=None)

    # 同时mock文件验证函数，避免因找不到实际文件报错
    with patch('app.resources.upload.validate_file_content') as mocked_validate:
        mocked_validate.return_value = None

        data = {
            'fields': 'somefield',
            'file': mock_file
        }
        response = client.post(
            '/file-upload',
            content_type='multipart/form-data',
            data=data
        )

        assert response.status_code == 200
        mock_file.save.assert_called_once()
        mocked_validate.assert_called_once()

关键注意点 #

• 必须Mockvalidate_file_content函数：因为服务端在调用file.save后会尝试读取文件内容进行验证，若没有实际写入文件，该函数会因找不到文件报错。
• Patch路径要准确：方案一中的patch路径必须是服务端代码所在模块中导入FileStorage的路径，而不是原始的werkzeug.datastructures.FileStorage，否则mock不会生效。

内容的提问来源于stack exchange，提问作者Ap-Mich