sanic/tests/test_requests.py

967 lines
26 KiB
Python
Raw Normal View History

import logging
2017-03-03 16:44:50 +00:00
import os
import ssl
from json import dumps as json_dumps
from json import loads as json_loads
from urllib.parse import urlparse
import pytest
from sanic import Blueprint, Sanic
from sanic.exceptions import ServerError
from sanic.request import DEFAULT_HTTP_CONTENT_TYPE, RequestParameters
from sanic.response import json, text
2018-03-16 04:28:52 +00:00
from sanic.testing import HOST, PORT
# ------------------------------------------------------------ #
# GET
# ------------------------------------------------------------ #
2018-12-30 11:18:06 +00:00
def test_sync(app):
@app.route("/")
def handler(request):
2018-12-30 11:18:06 +00:00
return text("Hello")
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/")
2018-12-30 11:18:06 +00:00
assert response.text == "Hello"
2018-08-26 15:43:14 +01:00
2019-05-21 23:42:19 +01:00
@pytest.mark.asyncio
async def test_sync_asgi(app):
@app.route("/")
def handler(request):
return text("Hello")
request, response = await app.asgi_client.get("/")
assert response.text == "Hello"
def test_ip(app):
2018-12-30 11:18:06 +00:00
@app.route("/")
2017-10-24 05:01:44 +01:00
def handler(request):
return text("{}".format(request.ip))
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/")
2017-10-24 05:01:44 +01:00
2018-12-30 11:18:06 +00:00
assert response.text == "127.0.0.1"
2018-08-26 15:43:14 +01:00
2019-05-21 23:42:19 +01:00
@pytest.mark.asyncio
async def test_ip_asgi(app):
@app.route("/")
def handler(request):
return text("{}".format(request.ip))
request, response = await app.asgi_client.get("/")
assert response.text == "mockserver"
2018-08-26 15:43:14 +01:00
def test_text(app):
2018-12-30 11:18:06 +00:00
@app.route("/")
async def handler(request):
2018-12-30 11:18:06 +00:00
return text("Hello")
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/")
2018-12-30 11:18:06 +00:00
assert response.text == "Hello"
2018-08-26 15:43:14 +01:00
def test_headers(app):
2018-12-30 11:18:06 +00:00
@app.route("/")
2016-12-14 05:24:26 +00:00
async def handler(request):
headers = {"spam": "great"}
2018-12-30 11:18:06 +00:00
return text("Hello", headers=headers)
2016-12-14 05:24:26 +00:00
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/")
2016-12-14 05:24:26 +00:00
2018-12-30 11:18:06 +00:00
assert response.headers.get("spam") == "great"
2016-12-14 05:24:26 +00:00
2018-08-26 15:43:14 +01:00
def test_non_str_headers(app):
2018-12-30 11:18:06 +00:00
@app.route("/")
2016-12-14 05:24:26 +00:00
async def handler(request):
headers = {"answer": 42}
2018-12-30 11:18:06 +00:00
return text("Hello", headers=headers)
2016-12-14 05:24:26 +00:00
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/")
2016-12-14 05:24:26 +00:00
2018-12-30 11:18:06 +00:00
assert response.headers.get("answer") == "42"
Fix sanic_endpoint_test working with redirects Before fix, it raises error like: ``` tests/test_utils.py F ================================= FAILURES ================================= ______________________________ test_redirect _______________________________ app = <sanic.sanic.Sanic object at 0x1045fda20>, method = 'get', uri = '/1', gather_request = True, debug = False server_kwargs = {}, request_args = (), request_kwargs = {} _collect_request = <function sanic_endpoint_test.<locals>._collect_request at 0x1045ec950> _collect_response = <function sanic_endpoint_test.<locals>._collect_response at 0x1045ec7b8> def sanic_endpoint_test(app, method='get', uri='/', gather_request=True, debug=False, server_kwargs={}, *request_args, **request_kwargs): results = [] exceptions = [] if gather_request: def _collect_request(request): results.append(request) app.request_middleware.appendleft(_collect_request) async def _collect_response(sanic, loop): try: response = await local_request(method, uri, *request_args, **request_kwargs) results.append(response) except Exception as e: exceptions.append(e) app.stop() app.run(host=HOST, debug=debug, port=PORT, after_start=_collect_response, **server_kwargs) if exceptions: raise ValueError("Exception during request: {}".format(exceptions)) if gather_request: try: > request, response = results E ValueError: too many values to unpack (expected 2) sanic/utils.py:47: ValueError During handling of the above exception, another exception occurred: utils_app = <sanic.sanic.Sanic object at 0x1045fda20> def test_redirect(utils_app): """Test sanic_endpoint_test is working for redirection""" > request, response = sanic_endpoint_test(utils_app, uri='/1') tests/test_utils.py:33: _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ app = <sanic.sanic.Sanic object at 0x1045fda20>, method = 'get', uri = '/1', gather_request = True, debug = False server_kwargs = {}, request_args = (), request_kwargs = {} _collect_request = <function sanic_endpoint_test.<locals>._collect_request at 0x1045ec950> _collect_response = <function sanic_endpoint_test.<locals>._collect_response at 0x1045ec7b8> def sanic_endpoint_test(app, method='get', uri='/', gather_request=True, debug=False, server_kwargs={}, *request_args, **request_kwargs): results = [] exceptions = [] if gather_request: def _collect_request(request): results.append(request) app.request_middleware.appendleft(_collect_request) async def _collect_response(sanic, loop): try: response = await local_request(method, uri, *request_args, **request_kwargs) results.append(response) except Exception as e: exceptions.append(e) app.stop() app.run(host=HOST, debug=debug, port=PORT, after_start=_collect_response, **server_kwargs) if exceptions: raise ValueError("Exception during request: {}".format(exceptions)) if gather_request: try: request, response = results return request, response except: raise ValueError( "Request and response object expected, got ({})".format( > results)) E ValueError: Request and response object expected, got ([{}, {}, {}, <ClientResponse(http://127.0.0.1:42101/3) [200 OK]> E <CIMultiDictProxy('Content-Type': 'text/plain; charset=utf-8', 'Content-Length': '2', 'Connection': 'keep-alive', 'Keep-Alive': 'timeout=1')> E ]) sanic/utils.py:52: ValueError ```
2017-02-02 09:51:33 +00:00
2018-08-26 15:43:14 +01:00
def test_invalid_response(app):
@app.exception(ServerError)
def handler_exception(request, exception):
2018-12-30 11:18:06 +00:00
return text("Internal Server Error.", 500)
2016-12-14 05:24:26 +00:00
2018-12-30 11:18:06 +00:00
@app.route("/")
async def handler(request):
2018-12-30 11:18:06 +00:00
return "This should fail"
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/")
assert response.status == 500
assert response.text == "Internal Server Error."
Fix sanic_endpoint_test working with redirects Before fix, it raises error like: ``` tests/test_utils.py F ================================= FAILURES ================================= ______________________________ test_redirect _______________________________ app = <sanic.sanic.Sanic object at 0x1045fda20>, method = 'get', uri = '/1', gather_request = True, debug = False server_kwargs = {}, request_args = (), request_kwargs = {} _collect_request = <function sanic_endpoint_test.<locals>._collect_request at 0x1045ec950> _collect_response = <function sanic_endpoint_test.<locals>._collect_response at 0x1045ec7b8> def sanic_endpoint_test(app, method='get', uri='/', gather_request=True, debug=False, server_kwargs={}, *request_args, **request_kwargs): results = [] exceptions = [] if gather_request: def _collect_request(request): results.append(request) app.request_middleware.appendleft(_collect_request) async def _collect_response(sanic, loop): try: response = await local_request(method, uri, *request_args, **request_kwargs) results.append(response) except Exception as e: exceptions.append(e) app.stop() app.run(host=HOST, debug=debug, port=PORT, after_start=_collect_response, **server_kwargs) if exceptions: raise ValueError("Exception during request: {}".format(exceptions)) if gather_request: try: > request, response = results E ValueError: too many values to unpack (expected 2) sanic/utils.py:47: ValueError During handling of the above exception, another exception occurred: utils_app = <sanic.sanic.Sanic object at 0x1045fda20> def test_redirect(utils_app): """Test sanic_endpoint_test is working for redirection""" > request, response = sanic_endpoint_test(utils_app, uri='/1') tests/test_utils.py:33: _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ app = <sanic.sanic.Sanic object at 0x1045fda20>, method = 'get', uri = '/1', gather_request = True, debug = False server_kwargs = {}, request_args = (), request_kwargs = {} _collect_request = <function sanic_endpoint_test.<locals>._collect_request at 0x1045ec950> _collect_response = <function sanic_endpoint_test.<locals>._collect_response at 0x1045ec7b8> def sanic_endpoint_test(app, method='get', uri='/', gather_request=True, debug=False, server_kwargs={}, *request_args, **request_kwargs): results = [] exceptions = [] if gather_request: def _collect_request(request): results.append(request) app.request_middleware.appendleft(_collect_request) async def _collect_response(sanic, loop): try: response = await local_request(method, uri, *request_args, **request_kwargs) results.append(response) except Exception as e: exceptions.append(e) app.stop() app.run(host=HOST, debug=debug, port=PORT, after_start=_collect_response, **server_kwargs) if exceptions: raise ValueError("Exception during request: {}".format(exceptions)) if gather_request: try: request, response = results return request, response except: raise ValueError( "Request and response object expected, got ({})".format( > results)) E ValueError: Request and response object expected, got ([{}, {}, {}, <ClientResponse(http://127.0.0.1:42101/3) [200 OK]> E <CIMultiDictProxy('Content-Type': 'text/plain; charset=utf-8', 'Content-Length': '2', 'Connection': 'keep-alive', 'Keep-Alive': 'timeout=1')> E ]) sanic/utils.py:52: ValueError ```
2017-02-02 09:51:33 +00:00
2018-08-26 15:43:14 +01:00
def test_json(app):
2018-12-30 11:18:06 +00:00
@app.route("/")
async def handler(request):
return json({"test": True})
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/")
2017-03-06 08:33:34 +00:00
results = json_loads(response.text)
2018-12-30 11:18:06 +00:00
assert results.get("test") is True
2018-08-26 15:43:14 +01:00
def test_empty_json(app):
2018-12-30 11:18:06 +00:00
@app.route("/")
2017-03-06 08:33:34 +00:00
async def handler(request):
assert request.json is None
2017-03-06 08:33:34 +00:00
return json(request.json)
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/")
2017-03-06 08:33:34 +00:00
assert response.status == 200
2018-12-30 11:18:06 +00:00
assert response.text == "null"
2018-08-26 15:43:14 +01:00
def test_invalid_json(app):
2018-12-30 11:18:06 +00:00
@app.route("/")
2016-12-08 04:33:56 +00:00
async def handler(request):
2017-03-06 08:33:34 +00:00
return json(request.json)
2016-12-08 04:33:56 +00:00
data = "I am not json"
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/", data=data)
2016-12-08 04:33:56 +00:00
assert response.status == 400
2018-08-26 15:43:14 +01:00
def test_query_string(app):
2018-12-30 11:18:06 +00:00
@app.route("/")
async def handler(request):
2018-12-30 11:18:06 +00:00
return text("OK")
2017-02-14 19:51:20 +00:00
request, response = app.test_client.get(
2018-12-30 11:18:06 +00:00
"/", params=[("test1", "1"), ("test2", "false"), ("test2", "true")]
)
2018-12-30 11:18:06 +00:00
assert request.args.get("test1") == "1"
assert request.args.get("test2") == "false"
assert request.args.getlist("test2") == ["false", "true"]
assert request.args.getlist("test1") == ["1"]
assert request.args.get("test3", default="My value") == "My value"
2018-08-26 15:43:14 +01:00
def test_uri_template(app):
2018-12-30 11:18:06 +00:00
@app.route("/foo/<id:int>/bar/<name:[A-z]+>")
async def handler(request, id, name):
2018-12-30 11:18:06 +00:00
return text("OK")
2017-04-30 11:01:17 +01:00
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/foo/123/bar/baz")
assert request.uri_template == "/foo/<id:int>/bar/<name:[A-z]+>"
2017-04-30 11:01:17 +01:00
2018-08-26 15:43:14 +01:00
def test_token(app):
2018-12-30 11:18:06 +00:00
@app.route("/")
async def handler(request):
2018-12-30 11:18:06 +00:00
return text("OK")
# uuid4 generated token.
2018-12-30 11:18:06 +00:00
token = "a1d895e0-553a-421a-8e22-5ff8ecb48cbf"
2017-04-22 06:36:02 +01:00
headers = {
2018-12-30 11:18:06 +00:00
"content-type": "application/json",
"Authorization": "{}".format(token),
2017-04-22 06:36:02 +01:00
}
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/", headers=headers)
2017-04-22 06:36:02 +01:00
assert request.token == token
2018-12-30 11:18:06 +00:00
token = "a1d895e0-553a-421a-8e22-5ff8ecb48cbf"
headers = {
2018-12-30 11:18:06 +00:00
"content-type": "application/json",
"Authorization": "Token {}".format(token),
}
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/", headers=headers)
assert request.token == token
2018-12-30 11:18:06 +00:00
token = "a1d895e0-553a-421a-8e22-5ff8ecb48cbf"
headers = {
2018-12-30 11:18:06 +00:00
"content-type": "application/json",
"Authorization": "Bearer {}".format(token),
}
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/", headers=headers)
2017-04-22 06:36:02 +01:00
assert request.token == token
2017-05-17 10:15:45 +01:00
# no Authorization headers
2018-12-30 11:18:06 +00:00
headers = {"content-type": "application/json"}
2017-05-17 10:15:45 +01:00
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/", headers=headers)
2017-05-17 10:15:45 +01:00
assert request.token is None
2017-04-22 06:36:02 +01:00
2018-08-26 15:43:14 +01:00
def test_content_type(app):
2018-12-30 11:18:06 +00:00
@app.route("/")
2017-06-08 04:48:07 +01:00
async def handler(request):
2017-06-09 01:25:22 +01:00
return text(request.content_type)
2017-06-08 04:48:07 +01:00
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/")
2017-06-08 04:48:07 +01:00
assert request.content_type == DEFAULT_HTTP_CONTENT_TYPE
2017-06-09 01:25:22 +01:00
assert response.text == DEFAULT_HTTP_CONTENT_TYPE
2017-06-08 04:48:07 +01:00
2018-12-30 11:18:06 +00:00
headers = {"content-type": "application/json"}
request, response = app.test_client.get("/", headers=headers)
assert request.content_type == "application/json"
assert response.text == "application/json"
2017-06-08 04:48:07 +01:00
def test_remote_addr_with_two_proxies(app):
app.config.PROXIES_COUNT = 2
2018-12-30 11:18:06 +00:00
@app.route("/")
2017-07-14 17:29:16 +01:00
async def handler(request):
return text(request.remote_addr)
headers = {"X-Real-IP": "127.0.0.2", "X-Forwarded-For": "127.0.1.1"}
request, response = app.test_client.get("/", headers=headers)
assert request.remote_addr == "127.0.0.2"
assert response.text == "127.0.0.2"
headers = {"X-Forwarded-For": "127.0.1.1"}
request, response = app.test_client.get("/", headers=headers)
assert request.remote_addr == ""
assert response.text == ""
2018-12-30 11:18:06 +00:00
headers = {"X-Forwarded-For": "127.0.0.1, 127.0.1.2"}
request, response = app.test_client.get("/", headers=headers)
assert request.remote_addr == "127.0.0.1"
assert response.text == "127.0.0.1"
2017-07-14 17:29:16 +01:00
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/")
assert request.remote_addr == ""
assert response.text == ""
2017-07-14 17:29:16 +01:00
2018-12-30 11:18:06 +00:00
headers = {"X-Forwarded-For": "127.0.0.1, , ,,127.0.1.2"}
request, response = app.test_client.get("/", headers=headers)
assert request.remote_addr == "127.0.0.1"
assert response.text == "127.0.0.1"
2017-07-14 17:29:16 +01:00
headers = {
"X-Forwarded-For": ", 127.0.2.2, , ,127.0.0.1, , ,,127.0.1.2"
}
request, response = app.test_client.get("/", headers=headers)
assert request.remote_addr == "127.0.0.1"
assert response.text == "127.0.0.1"
def test_remote_addr_with_infinite_number_of_proxies(app):
app.config.PROXIES_COUNT = -1
@app.route("/")
async def handler(request):
return text(request.remote_addr)
headers = {"X-Real-IP": "127.0.0.2", "X-Forwarded-For": "127.0.1.1"}
request, response = app.test_client.get("/", headers=headers)
assert request.remote_addr == "127.0.0.2"
assert response.text == "127.0.0.2"
headers = {"X-Forwarded-For": "127.0.1.1"}
request, response = app.test_client.get("/", headers=headers)
assert request.remote_addr == "127.0.1.1"
assert response.text == "127.0.1.1"
headers = {
"X-Forwarded-For": "127.0.0.5, 127.0.0.4, 127.0.0.3, 127.0.0.2, 127.0.0.1"
}
request, response = app.test_client.get("/", headers=headers)
assert request.remote_addr == "127.0.0.5"
assert response.text == "127.0.0.5"
def test_remote_addr_without_proxy(app):
app.config.PROXIES_COUNT = 0
@app.route("/")
async def handler(request):
return text(request.remote_addr)
headers = {"X-Real-IP": "127.0.0.2", "X-Forwarded-For": "127.0.1.1"}
request, response = app.test_client.get("/", headers=headers)
assert request.remote_addr == ""
assert response.text == ""
headers = {"X-Forwarded-For": "127.0.1.1"}
request, response = app.test_client.get("/", headers=headers)
assert request.remote_addr == ""
assert response.text == ""
headers = {"X-Forwarded-For": "127.0.0.1, 127.0.1.2"}
request, response = app.test_client.get("/", headers=headers)
assert request.remote_addr == ""
assert response.text == ""
def test_remote_addr_custom_headers(app):
app.config.PROXIES_COUNT = 1
app.config.REAL_IP_HEADER = "Client-IP"
app.config.FORWARDED_FOR_HEADER = "Forwarded"
@app.route("/")
async def handler(request):
return text(request.remote_addr)
headers = {"X-Real-IP": "127.0.0.2", "Forwarded": "127.0.1.1"}
request, response = app.test_client.get("/", headers=headers)
assert request.remote_addr == "127.0.1.1"
assert response.text == "127.0.1.1"
headers = {"X-Forwarded-For": "127.0.1.1"}
request, response = app.test_client.get("/", headers=headers)
assert request.remote_addr == ""
assert response.text == ""
headers = {"Client-IP": "127.0.0.2", "Forwarded": "127.0.1.1"}
request, response = app.test_client.get("/", headers=headers)
assert request.remote_addr == "127.0.0.2"
assert response.text == "127.0.0.2"
2017-07-14 17:29:16 +01:00
2018-08-26 15:43:14 +01:00
def test_match_info(app):
2018-12-30 11:18:06 +00:00
@app.route("/api/v1/user/<user_id>/")
2017-06-17 17:47:58 +01:00
async def handler(request, user_id):
return json(request.match_info)
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/api/v1/user/sanic_user/")
2017-06-17 17:47:58 +01:00
assert request.match_info == {"user_id": "sanic_user"}
assert json_loads(response.text) == {"user_id": "sanic_user"}
# ------------------------------------------------------------ #
# POST
# ------------------------------------------------------------ #
2018-12-30 11:18:06 +00:00
def test_post_json(app):
@app.route("/", methods=["POST"])
async def handler(request):
2018-12-30 11:18:06 +00:00
return text("OK")
2018-12-30 11:18:06 +00:00
payload = {"test": "OK"}
headers = {"content-type": "application/json"}
2017-02-23 02:36:08 +00:00
request, response = app.test_client.post(
2018-12-30 11:18:06 +00:00
"/", data=json_dumps(payload), headers=headers
)
2018-12-30 11:18:06 +00:00
assert request.json.get("test") == "OK"
assert request.json.get("test") == "OK" # for request.parsed_json
assert response.text == "OK"
2016-10-19 08:23:44 +01:00
2018-08-26 15:43:14 +01:00
def test_post_form_urlencoded(app):
2018-12-30 11:18:06 +00:00
@app.route("/", methods=["POST"])
2016-10-19 08:23:44 +01:00
async def handler(request):
2018-12-30 11:18:06 +00:00
return text("OK")
2016-10-19 08:23:44 +01:00
2018-12-30 11:18:06 +00:00
payload = "test=OK"
headers = {"content-type": "application/x-www-form-urlencoded"}
2016-10-19 08:23:44 +01:00
2018-12-30 11:18:06 +00:00
request, response = app.test_client.post(
"/", data=payload, headers=headers
)
2016-10-19 08:23:44 +01:00
2018-12-30 11:18:06 +00:00
assert request.form.get("test") == "OK"
assert request.form.get("test") == "OK" # For request.parsed_form
2016-10-19 08:23:44 +01:00
2017-07-14 17:29:16 +01:00
@pytest.mark.parametrize(
2018-12-30 11:18:06 +00:00
"payload",
[
"------sanic\r\n"
2018-10-22 21:25:38 +01:00
'Content-Disposition: form-data; name="test"\r\n'
2018-12-30 11:18:06 +00:00
"\r\n"
"OK\r\n"
"------sanic--\r\n",
"------sanic\r\n"
2018-10-22 21:25:38 +01:00
'content-disposition: form-data; name="test"\r\n'
2018-12-30 11:18:06 +00:00
"\r\n"
"OK\r\n"
"------sanic--\r\n",
],
)
2018-08-26 15:43:14 +01:00
def test_post_form_multipart_form_data(app, payload):
2018-12-30 11:18:06 +00:00
@app.route("/", methods=["POST"])
2016-10-19 08:23:44 +01:00
async def handler(request):
2018-12-30 11:18:06 +00:00
return text("OK")
2016-10-19 08:23:44 +01:00
2018-12-30 11:18:06 +00:00
headers = {"content-type": "multipart/form-data; boundary=----sanic"}
2016-10-19 08:23:44 +01:00
2017-02-23 02:36:08 +00:00
request, response = app.test_client.post(data=payload, headers=headers)
2016-10-19 08:23:44 +01:00
2018-12-30 11:18:06 +00:00
assert request.form.get("test") == "OK"
2017-03-03 16:44:50 +00:00
@pytest.mark.parametrize(
2018-12-30 11:18:06 +00:00
"path,query,expected_url",
[
("/foo", "", "http://{}:{}/foo"),
("/bar/baz", "", "http://{}:{}/bar/baz"),
("/moo/boo", "arg1=val1", "http://{}:{}/moo/boo?arg1=val1"),
],
)
2018-08-26 15:43:14 +01:00
def test_url_attributes_no_ssl(app, path, query, expected_url):
2017-03-03 16:44:50 +00:00
async def handler(request):
2018-12-30 11:18:06 +00:00
return text("OK")
2017-03-03 16:44:50 +00:00
app.add_route(handler, path)
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get(path + "?{}".format(query))
2018-03-16 04:28:52 +00:00
assert request.url == expected_url.format(HOST, PORT)
2017-03-03 16:44:50 +00:00
parsed = urlparse(request.url)
assert parsed.scheme == request.scheme
assert parsed.path == request.path
assert parsed.query == request.query_string
2017-03-03 18:32:32 +00:00
assert parsed.netloc == request.host
2017-03-03 16:44:50 +00:00
@pytest.mark.parametrize(
2018-12-30 11:18:06 +00:00
"path,query,expected_url",
[
("/foo", "", "https://{}:{}/foo"),
("/bar/baz", "", "https://{}:{}/bar/baz"),
("/moo/boo", "arg1=val1", "https://{}:{}/moo/boo?arg1=val1"),
],
)
2018-12-13 17:50:50 +00:00
def test_url_attributes_with_ssl_context(app, path, query, expected_url):
2017-03-03 16:44:50 +00:00
current_dir = os.path.dirname(os.path.realpath(__file__))
context = ssl.create_default_context(purpose=ssl.Purpose.CLIENT_AUTH)
context.load_cert_chain(
2018-12-30 11:18:06 +00:00
os.path.join(current_dir, "certs/selfsigned.cert"),
keyfile=os.path.join(current_dir, "certs/selfsigned.key"),
)
2017-03-03 16:44:50 +00:00
async def handler(request):
2018-12-30 11:18:06 +00:00
return text("OK")
2017-03-03 16:44:50 +00:00
app.add_route(handler, path)
request, response = app.test_client.get(
2018-12-30 11:18:06 +00:00
"https://{}:{}".format(HOST, PORT) + path + "?{}".format(query),
server_kwargs={"ssl": context},
)
2018-03-16 04:28:52 +00:00
assert request.url == expected_url.format(HOST, PORT)
2017-03-03 16:44:50 +00:00
parsed = urlparse(request.url)
assert parsed.scheme == request.scheme
assert parsed.path == request.path
assert parsed.query == request.query_string
2017-03-03 18:32:32 +00:00
assert parsed.netloc == request.host
2018-12-13 17:50:50 +00:00
@pytest.mark.parametrize(
2018-12-30 11:18:06 +00:00
"path,query,expected_url",
[
("/foo", "", "https://{}:{}/foo"),
("/bar/baz", "", "https://{}:{}/bar/baz"),
("/moo/boo", "arg1=val1", "https://{}:{}/moo/boo?arg1=val1"),
],
)
2018-12-13 17:50:50 +00:00
def test_url_attributes_with_ssl_dict(app, path, query, expected_url):
current_dir = os.path.dirname(os.path.realpath(__file__))
2018-12-30 11:18:06 +00:00
ssl_cert = os.path.join(current_dir, "certs/selfsigned.cert")
ssl_key = os.path.join(current_dir, "certs/selfsigned.key")
2018-12-13 17:50:50 +00:00
2018-12-30 11:18:06 +00:00
ssl_dict = {"cert": ssl_cert, "key": ssl_key}
2018-12-13 17:50:50 +00:00
async def handler(request):
2018-12-30 11:18:06 +00:00
return text("OK")
2018-12-13 17:50:50 +00:00
app.add_route(handler, path)
request, response = app.test_client.get(
2018-12-30 11:18:06 +00:00
"https://{}:{}".format(HOST, PORT) + path + "?{}".format(query),
server_kwargs={"ssl": ssl_dict},
)
2018-12-13 17:50:50 +00:00
assert request.url == expected_url.format(HOST, PORT)
parsed = urlparse(request.url)
assert parsed.scheme == request.scheme
assert parsed.path == request.path
assert parsed.query == request.query_string
assert parsed.netloc == request.host
def test_invalid_ssl_dict(app):
2018-12-30 11:18:06 +00:00
@app.get("/test")
2018-12-13 17:50:50 +00:00
async def handler(request):
2018-12-30 11:18:06 +00:00
return text("ssl test")
2018-12-13 17:50:50 +00:00
2018-12-30 11:18:06 +00:00
ssl_dict = {"cert": None, "key": None}
2018-12-13 17:50:50 +00:00
with pytest.raises(ValueError) as excinfo:
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get(
"/test", server_kwargs={"ssl": ssl_dict}
)
2018-12-13 17:50:50 +00:00
2018-12-30 11:18:06 +00:00
assert str(excinfo.value) == "SSLContext or certificate and key required."
2018-12-13 17:50:50 +00:00
def test_form_with_multiple_values(app):
2018-12-30 11:18:06 +00:00
@app.route("/", methods=["POST"])
async def handler(request):
return text("OK")
2018-12-30 11:18:06 +00:00
payload = "selectedItems=v1&selectedItems=v2&selectedItems=v3"
2018-12-30 11:18:06 +00:00
headers = {"content-type": "application/x-www-form-urlencoded"}
2018-12-30 11:18:06 +00:00
request, response = app.test_client.post(
"/", data=payload, headers=headers
)
assert request.form.getlist("selectedItems") == ["v1", "v2", "v3"]
def test_request_string_representation(app):
2018-12-30 11:18:06 +00:00
@app.route("/", methods=["GET"])
async def get(request):
return text("OK")
request, _ = app.test_client.get("/")
2018-12-30 11:18:06 +00:00
assert repr(request) == "<Request: GET />"
@pytest.mark.parametrize(
"payload,filename",
2018-12-30 11:18:06 +00:00
[
(
"------sanic\r\n"
'Content-Disposition: form-data; filename="filename"; name="test"\r\n'
"\r\n"
"OK\r\n"
"------sanic--\r\n",
"filename",
),
(
"------sanic\r\n"
'content-disposition: form-data; filename="filename"; name="test"\r\n'
"\r\n"
'content-type: application/json; {"field": "value"}\r\n'
"------sanic--\r\n",
"filename",
),
(
"------sanic\r\n"
'Content-Disposition: form-data; filename=""; name="test"\r\n'
"\r\n"
"OK\r\n"
"------sanic--\r\n",
"",
),
(
"------sanic\r\n"
'content-disposition: form-data; filename=""; name="test"\r\n'
"\r\n"
'content-type: application/json; {"field": "value"}\r\n'
"------sanic--\r\n",
"",
),
(
"------sanic\r\n"
'Content-Disposition: form-data; filename*="utf-8\'\'filename_%C2%A0_test"; name="test"\r\n'
"\r\n"
"OK\r\n"
"------sanic--\r\n",
"filename_\u00A0_test",
),
(
"------sanic\r\n"
'content-disposition: form-data; filename*="utf-8\'\'filename_%C2%A0_test"; name="test"\r\n'
"\r\n"
'content-type: application/json; {"field": "value"}\r\n'
"------sanic--\r\n",
"filename_\u00A0_test",
),
2018-12-30 11:18:06 +00:00
],
)
def test_request_multipart_files(app, payload, filename):
@app.route("/", methods=["POST"])
async def post(request):
return text("OK")
2018-12-30 11:18:06 +00:00
headers = {"content-type": "multipart/form-data; boundary=----sanic"}
request, _ = app.test_client.post(data=payload, headers=headers)
assert request.files.get("test").name == filename
def test_request_multipart_file_with_json_content_type(app):
@app.route("/", methods=["POST"])
async def post(request):
return text("OK")
payload = (
2018-12-30 11:18:06 +00:00
"------sanic\r\n"
'Content-Disposition: form-data; name="file"; filename="test.json"\r\n'
2018-12-30 11:18:06 +00:00
"Content-Type: application/json\r\n"
"Content-Length: 0"
"\r\n"
"\r\n"
"------sanic--"
)
2018-12-30 11:18:06 +00:00
headers = {"content-type": "multipart/form-data; boundary=------sanic"}
request, _ = app.test_client.post(data=payload, headers=headers)
2018-12-30 11:18:06 +00:00
assert request.files.get("file").type == "application/json"
def test_request_multipart_file_without_field_name(app, caplog):
@app.route("/", methods=["POST"])
async def post(request):
return text("OK")
payload = (
'------sanic\r\nContent-Disposition: form-data; filename="test.json"'
2018-12-30 11:18:06 +00:00
"\r\nContent-Type: application/json\r\n\r\n\r\n------sanic--"
)
2018-12-30 11:18:06 +00:00
headers = {"content-type": "multipart/form-data; boundary=------sanic"}
2018-12-30 11:18:06 +00:00
request, _ = app.test_client.post(
data=payload, headers=headers, debug=True
)
with caplog.at_level(logging.DEBUG):
request.form
2018-12-30 11:18:06 +00:00
assert caplog.record_tuples[-1] == (
"sanic.root",
logging.DEBUG,
"Form-data field does not have a 'name' parameter "
2018-12-30 11:18:06 +00:00
"in the Content-Disposition header",
)
def test_request_multipart_file_duplicate_filed_name(app):
@app.route("/", methods=["POST"])
async def post(request):
return text("OK")
payload = (
2018-12-30 11:18:06 +00:00
"--e73ffaa8b1b2472b8ec848de833cb05b\r\n"
'Content-Disposition: form-data; name="file"\r\n'
2018-12-30 11:18:06 +00:00
"Content-Type: application/octet-stream\r\n"
"Content-Length: 15\r\n"
"\r\n"
'{"test":"json"}\r\n'
2018-12-30 11:18:06 +00:00
"--e73ffaa8b1b2472b8ec848de833cb05b\r\n"
'Content-Disposition: form-data; name="file"\r\n'
2018-12-30 11:18:06 +00:00
"Content-Type: application/octet-stream\r\n"
"Content-Length: 15\r\n"
"\r\n"
'{"test":"json2"}\r\n'
2018-12-30 11:18:06 +00:00
"--e73ffaa8b1b2472b8ec848de833cb05b--\r\n"
)
headers = {
2018-12-30 11:18:06 +00:00
"Content-Type": "multipart/form-data; boundary=e73ffaa8b1b2472b8ec848de833cb05b"
}
2018-12-30 11:18:06 +00:00
request, _ = app.test_client.post(
data=payload, headers=headers, debug=True
)
assert request.form.getlist("file") == [
'{"test":"json"}',
'{"test":"json2"}',
]
def test_request_multipart_with_multiple_files_and_type(app):
@app.route("/", methods=["POST"])
async def post(request):
return text("OK")
2018-12-30 11:18:06 +00:00
payload = (
'------sanic\r\nContent-Disposition: form-data; name="file"; filename="test.json"'
"\r\nContent-Type: application/json\r\n\r\n\r\n"
'------sanic\r\nContent-Disposition: form-data; name="file"; filename="some_file.pdf"\r\n'
"Content-Type: application/pdf\r\n\r\n\r\n------sanic--"
)
headers = {"content-type": "multipart/form-data; boundary=------sanic"}
request, _ = app.test_client.post(data=payload, headers=headers)
2018-12-30 11:18:06 +00:00
assert len(request.files.getlist("file")) == 2
assert request.files.getlist("file")[0].type == "application/json"
assert request.files.getlist("file")[1].type == "application/pdf"
def test_request_repr(app):
2018-12-30 11:18:06 +00:00
@app.get("/")
def handler(request):
2018-12-30 11:18:06 +00:00
return text("pass")
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/")
assert repr(request) == "<Request: GET />"
request.method = None
assert repr(request) == "<Request: None />"
def test_request_bool(app):
2018-12-30 11:18:06 +00:00
@app.get("/")
def handler(request):
2018-12-30 11:18:06 +00:00
return text("pass")
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/")
assert bool(request)
request.transport = False
assert not bool(request)
def test_request_parsing_form_failed(app, caplog):
2018-12-30 11:18:06 +00:00
@app.route("/", methods=["POST"])
async def handler(request):
2018-12-30 11:18:06 +00:00
return text("OK")
2018-12-30 11:18:06 +00:00
payload = "test=OK"
headers = {"content-type": "multipart/form-data"}
2018-12-30 11:18:06 +00:00
request, response = app.test_client.post(
"/", data=payload, headers=headers
)
with caplog.at_level(logging.ERROR):
request.form
2018-12-30 11:18:06 +00:00
assert caplog.record_tuples[-1] == (
"sanic.error",
logging.ERROR,
"Failed when parsing form",
)
def test_request_args_no_query_string(app):
2018-12-30 11:18:06 +00:00
@app.get("/")
def handler(request):
2018-12-30 11:18:06 +00:00
return text("pass")
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/")
assert request.args == {}
def test_request_raw_args(app):
2018-12-30 11:18:06 +00:00
params = {"test": "OK"}
2018-12-30 11:18:06 +00:00
@app.get("/")
def handler(request):
2018-12-30 11:18:06 +00:00
return text("pass")
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/", params=params)
assert request.raw_args == params
def test_request_query_args(app):
# test multiple params with the same key
params = [("test", "value1"), ("test", "value2")]
@app.get("/")
def handler(request):
return text("pass")
request, response = app.test_client.get("/", params=params)
assert request.query_args == params
# test cached value
assert (
request.parsed_not_grouped_args[(False, False, "utf-8", "replace")]
== request.query_args
)
# test params directly in the url
request, response = app.test_client.get("/?test=value1&test=value2")
assert request.query_args == params
# test unique params
params = [("test1", "value1"), ("test2", "value2")]
request, response = app.test_client.get("/", params=params)
assert request.query_args == params
# test no params
request, response = app.test_client.get("/")
assert not request.query_args
def test_request_query_args_custom_parsing(app):
@app.get("/")
def handler(request):
return text("pass")
request, response = app.test_client.get(
"/?test1=value1&test2=&test3=value3"
)
assert request.get_query_args(keep_blank_values=True) == [
("test1", "value1"),
("test2", ""),
("test3", "value3"),
]
assert request.query_args == [("test1", "value1"), ("test3", "value3")]
assert request.get_query_args(keep_blank_values=False) == [
("test1", "value1"),
("test3", "value3"),
]
assert request.get_args(keep_blank_values=True) == RequestParameters(
{"test1": ["value1"], "test2": [""], "test3": ["value3"]}
)
assert request.args == RequestParameters(
{"test1": ["value1"], "test3": ["value3"]}
)
assert request.get_args(keep_blank_values=False) == RequestParameters(
{"test1": ["value1"], "test3": ["value3"]}
)
def test_request_cookies(app):
2018-12-30 11:18:06 +00:00
cookies = {"test": "OK"}
2018-12-30 11:18:06 +00:00
@app.get("/")
def handler(request):
2018-12-30 11:18:06 +00:00
return text("OK")
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/", cookies=cookies)
assert request.cookies == cookies
2018-12-30 11:18:06 +00:00
assert request.cookies == cookies # For request._cookies
def test_request_cookies_without_cookies(app):
2018-12-30 11:18:06 +00:00
@app.get("/")
def handler(request):
2018-12-30 11:18:06 +00:00
return text("OK")
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/")
assert request.cookies == {}
def test_request_port(app):
2018-12-30 11:18:06 +00:00
@app.get("/")
def handler(request):
2018-12-30 11:18:06 +00:00
return text("OK")
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/")
port = request.port
assert isinstance(port, int)
2018-12-30 11:18:06 +00:00
delattr(request, "_socket")
delattr(request, "_port")
port = request.port
assert isinstance(port, int)
2018-12-30 11:18:06 +00:00
assert hasattr(request, "_socket")
assert hasattr(request, "_port")
def test_request_socket(app):
2018-12-30 11:18:06 +00:00
@app.get("/")
def handler(request):
2018-12-30 11:18:06 +00:00
return text("OK")
2018-12-30 11:18:06 +00:00
request, response = app.test_client.get("/")
socket = request.socket
assert isinstance(socket, tuple)
ip = socket[0]
port = socket[1]
assert ip == request.ip
assert port == request.port
2018-12-30 11:18:06 +00:00
delattr(request, "_socket")
socket = request.socket
assert isinstance(socket, tuple)
2018-12-30 11:18:06 +00:00
assert hasattr(request, "_socket")
def test_request_form_invalid_content_type(app):
@app.route("/", methods=["POST"])
async def post(request):
return text("OK")
2018-12-30 11:18:06 +00:00
request, response = app.test_client.post("/", json={"test": "OK"})
assert request.form == {}
def test_endpoint_basic():
app = Sanic()
@app.route("/")
def my_unique_handler(request):
return text("Hello")
request, response = app.test_client.get("/")
assert request.endpoint == "test_requests.my_unique_handler"
def test_endpoint_named_app():
app = Sanic("named")
@app.route("/")
def my_unique_handler(request):
return text("Hello")
request, response = app.test_client.get("/")
assert request.endpoint == "named.my_unique_handler"
def test_endpoint_blueprint():
bp = Blueprint("my_blueprint", url_prefix="/bp")
@bp.route("/")
async def bp_root(request):
return text("Hello")
app = Sanic("named")
app.blueprint(bp)
request, response = app.test_client.get("/bp")
assert request.endpoint == "named.my_blueprint.bp_root"