Performing GET requests (with parameter) in pytest

Question

I have written an endpoint in my flask server, that when triggered, with a GET request, and a parameter, the server will parse the parameter, and serve the file (specified in the parameter) to the user to download.

This is the server's code:

@app.route('/getfile', methods=['GET'])
def dl_file():
   requestedFile = request.args.get('id')
   allFiles = os.listdir('myFiles')
   if requestedFile not in allFiles:
      return make_response(json.dumps({'error_message': 'item does not exist'}), 400)
   else:
      return send_file(pathAndFilename, as_attachment=True, attachment_filename = requestedFile)

I am able to trigger this with:

curl -X GET "0000:5000/getfile?id=myFile.txt"

How do i trigger this in pytest?

But i do not know how to pass the parameter in the GET request, and how to grab the server's response.

score 1 · Accepted Answer · edited Mar 23 '21 at 10:07

1

You should be able to pass those parameters as you do when performing curl requests, ie.

response = client.get('/getfile?id=myFile.txt')

Alternatively, you can use Python's standard library, urllib and its urlencode method.

In [1]: import urllib

In [2]: data = {'id': 'myFile.txt'}

In [3]: urllib.parse.urlencode(data)
Out[3]: 'id=myFile.txt'

This can be combined together:

import urllib

@pytest.mark.parametrize("filename, status, error_message_template", [
        ('myFile.txt', 200, 'null'),
        ('does_not_exist.txt', 400, 'item does not exist')
            ])

def test_dl_file(change_directory, filename, status, error_message_template):
   client = app.test_client()
   data = {"id": filename}
   query = urllib.parse.urlencode(data)
   response = client.get('/getfile' + query)

edited Mar 23 '21 at 10:07

user1584421

3,499
11
46
86

answered Mar 16 '21 at 15:16

gonczor

3,994
1
21
46

Thanks. But what if the parameter is not always a string, but a variable? – user1584421 Mar 16 '21 at 15:20
@user1584421 I've updated the answer. You can automate this proces now ;-) – gonczor Mar 16 '21 at 15:24
Thank you! But still, how do i trigger the server with a GET request, in the specified endpoint and still use urllib.parse.urlencode()? – user1584421 Mar 16 '21 at 15:28
@user1584421 I've updated the answer. Is it more clear now? – gonczor Mar 16 '21 at 15:30
For some reason, when i trigger the server like this from pytest, i always get ` \n404 Not Found\n
Not Found
\n
The requested URL was not found on the server`. I don't know why.
– user1584421 Mar 23 '21 at 14:12
Check the path you pass to the client. Query parameters should not be able to give 404. – gonczor Mar 24 '21 at 05:51

Performing GET requests (with parameter) in pytest

1 Answers1

Not Found