如何使用 requests_mock 对文件上传进行单元测试？

Question

我正在为 API 编写一个 Python (3) 包装器，我正在尝试对其中需要上传文件的部分进行单元测试。我想验证文件名和内容是否由我的客户正确发送。

我正在使用 Python 的 unittest library, along with requests and requests_mock 进行测试。

我计划解决这个问题的方法是有一个回调函数来验证文件是否已发送并且所有 headers 是否已正确设置。这是我目前所拥有的：

import unittest
import requests
import requests_mock

from my_class import my_class

from my_class.API import API

class  TestAPI(unittest.TestCase):

    def setUp(self):
        self.hostname = 'https://www.example.com'

    def validate_file_upload(self, request, context, filename, content):
        # self.assertEqual(something, something_else)
        # better solution goes here

    def test_submit_file(self):
        API_ENDPOINT = self.hostname + '/api/tasks/create/file/'
        DUMMY_FILE = 'file'
        DUMMY_CONTENT = 'here is the\ncontent of our\nfile'

        s = API(self.hostname)

        with open(DUMMY_FILE, 'w+') as f:
            f.write(DUMMY_CONTENT)

        with requests_mock.Mocker() as m:
            def json_callback(request, context):
                self.validate_file_upload(request, context, DUMMY_FILE,
                    DUMMY_CONTENT)
                return {}

            m.post(API_ENDPOINT, json=json_callback)
            s.upload_file(DUMMY_FILE)

我已经确定，在成功上传文件后，validate_file_upload 的 request 参数有几个相关的数据位，即 request.headers 和 request.text。下面是validate_file_upload函数调用后两者的内容：

request.headers

{'User-Agent': 'python-requests/2.19.1', 'Accept-Encoding': 'gzip, deflate', 'Accept': '*/*', 'Connection': 'keep-alive', 'Content-Length': '171', 'Content-Type': 'multipart/form-data; boundary=e1a0aa05f83735e85ddca089c450a21b'}

request.text

'--e1a0aa05f83735e85ddca089c450a21b\r\nContent-Disposition: form-data; name="file"; filename="file"\r\n\r\nhere is the\ncontent of our\nfile\r\n--e1a0aa05f83735e85ddca089c450a21b--\r\n'

现在，事情是这样的。我 知道我可以解析 request.text 字符串并获取我想要的数据；验证起来很容易。

但是，这种逻辑似乎真的不属于我的单元测试。我无法想象没有更好的解决方案；有人已经在不同的模块中实现了这个功能，或者我忽略了一些明显的东西。

我不应该为文件上传实现 来单元测试像文件上传这样简单的东西，对吧？有更好的方法吗？

这是 dir(request) 的输出：

['__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattr__', '__getattribute__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', '_allow_redirects', '_case_sensitive', '_cert', '_create', '_matcher', '_proxies', '_qs', '_request', '_stream', '_timeout', '_url_parts', '_url_parts_', '_verify', 'allow_redirects', 'cert', 'hostname', 'json', 'matcher', 'netloc', 'path', 'port', 'proxies', 'qs', 'query', 'scheme', 'stream', 'text', 'timeout', 'verify']

我已经检查了所有 non-underscore 属性以查找文件上传数据的任何其他表示，但无济于事。我也试过搜索 Whosebug and Google，但我离找到更好的方法还差得很远。这是唯一出现在任一搜索中的 post。

Answer 1

目前，我决定采用这种相当简单的方法：

def validate_file_upload(self, request, context, filename, content):
    self.assertTrue(filename in request.text)
    self.assertTrue(content in request.text)

虽然它并不完美，但它比解析 HTTP 请求的逻辑要少得多，而且似乎至少对文件上传是否正确进行了基本验证。正如我之前提到的，我正在使用 requests 库，所以我不太担心弄乱文件上传，无论如何，这在大多数情况下应该能解决问题。

为了防止将名称 file 与 request.text 中的其他名称错误匹配，我已将其更改为 rather_unique_filename。

Answer 2

我没有 my_class.API 来测试你的确切代码，但我相信你可以使用 cgi。

import cgi

body_file = io.BytesIO(request.body)
_, pdict = cgi.parse_header(request.headers['Content-Type'])
parsed = cgi.parse_multipart(fp=body_file, pdict=pdict)
# Now inspect `parsed`

如何使用 requests_mock 对文件上传进行单元测试？

How can I use requests_mock to unit test a file upload?

python

python-requests

python-unittest