pythonflaskpython-unittestweb-api-testingmultiple-file-upload

How do I upload multiple files using the Flask test_client?


How can I use the Flask test_client to upload multiple files to one API endpoint?

I'm trying to use the Flask test_client to upload multiple files to a web service that accepts multiple files to combine them into one large file.

My controller looks like this:

@app.route("/combine/file", methods=["POST"])
@flask_login.login_required
def combine_files():

  user = flask_login.current_user

  combined_file_name = request.form.get("file_name")

  # Store file locally
  file_infos = []
  for file_data in request.files.getlist('file[]'):

    # Get the content of the file
    file_temp_path="/tmp/{}-request.csv".format(file_id)
    file_data.save(file_temp_path)

    # Create a namedtuple with information about the file
    FileInfo = namedtuple("FileInfo", ["id", "name", "path"])
    file_infos.append(
      FileInfo(
        id=file_id,
        name=file_data.filename,
        path=file_temp_path
      )
    )
    ...

My test code looks like this:

def test_combine_file(get_project_files):

project = get_project_files["project"]

r = web_client.post(
    "/combine/file",
    content_type='multipart/form-data',
    buffered=True,
    follow_redirects=True,
    data={
        "project_id": project.project_id,
        "file_name": "API Test Combined File",
        "file": [
            (open("data/CC-Th0-MolsPerCell.csv", "rb"), "CC-Th0-MolsPerCell.csv"),
            (open("data/CC-Th1-MolsPerCell.csv", "rb"), "CC-Th1-MolsPerCell.csv")
]})
response_data = json.loads(r.data)

assert "status" in response_data
assert response_data["status"] == "OK"

However, I can't get the test_client to actually upload both files. With more than one file specified, the file_data is empty when the API code loops. I have tried my own ImmutableDict with two "file" entries, a list of file tuples, a tuple of file tuples, anything I could think of.

What is the API to specify multiple files for upload in the Flask test_client? I can't find this anywhere on the web! :(


Solution

  • The test client takes a list of file objects (as returned by open()), so this is the testing utility I use:

    def multi_file_upload(test_client, src_file_paths, dest_folder):
        files = []
        try:
            files = [open(fpath, 'rb') for fpath in src_file_paths]
            return test_client.post('/api/upload/', data={
                'files': files,
                'dest': dest_folder
            })
        finally:
            for fp in files:
                fp.close()
    

    I think if you lose your tuples (but keeping the open()s) then your code might work.