sanic/tests/test_middleware.py
L. Kärkkäinen ba9b432993 No tracebacks on normal errors and prettier error pages (#1768)
* Default error handler now only logs traceback on 500 errors and all responses are HTML formatted.

* Tests passing.

* Ability to flag any exception object with self.quiet = True following @ashleysommer suggestion.

* Refactor HTML formatting into errorpages.py. String escapes for debug tracebacks.

* Remove extra includes

* Auto-set quiet flag also when decorator is used.

* Cleanup, make error pages (probably) HTML5-compliant and similar for debug and non-debug modes.

* Fix lookup of non-existant status codes

* No logging of 503 errors after all.

* lint
2020-01-20 08:58:14 -06:00

187 lines
4.6 KiB
Python

import logging
from asyncio import CancelledError
from sanic.exceptions import NotFound, SanicException
from sanic.request import Request
from sanic.response import HTTPResponse, text
# ------------------------------------------------------------ #
# GET
# ------------------------------------------------------------ #
def test_middleware_request(app):
results = []
@app.middleware
async def handler1(request):
results.append(request)
@app.route("/")
async def handler2(request):
return text("OK")
request, response = app.test_client.get("/")
assert response.text == "OK"
assert type(results[0]) is Request
def test_middleware_response(app):
results = []
@app.middleware("request")
async def process_request(request):
results.append(request)
@app.middleware("response")
async def process_response(request, response):
results.append(request)
results.append(response)
@app.route("/")
async def handler(request):
return text("OK")
request, response = app.test_client.get("/")
assert response.text == "OK"
assert type(results[0]) is Request
assert type(results[1]) is Request
assert isinstance(results[2], HTTPResponse)
def test_middleware_response_exception(app):
result = {"status_code": None}
@app.middleware("response")
async def process_response(request, response):
result["status_code"] = response.status
return response
@app.exception(NotFound)
async def error_handler(request, exception):
return text("OK", exception.status_code)
@app.route("/")
async def handler(request):
return text("FAIL")
request, response = app.test_client.get("/page_not_found")
assert response.text == "OK"
assert result["status_code"] == 404
def test_middleware_response_raise_cancelled_error(app, caplog):
app.config.RESPONSE_TIMEOUT = 1
@app.middleware("response")
async def process_response(request, response):
raise CancelledError("CancelledError at response middleware")
@app.get("/")
def handler(request):
return text("OK")
with caplog.at_level(logging.ERROR):
reqrequest, response = app.test_client.get("/")
assert response.status == 503
assert (
"sanic.root",
logging.ERROR,
"Exception occurred while handling uri: 'http://127.0.0.1:42101/'",
) not in caplog.record_tuples
def test_middleware_response_raise_exception(app, caplog):
@app.middleware("response")
async def process_response(request, response):
raise Exception("Exception at response middleware")
with caplog.at_level(logging.ERROR):
reqrequest, response = app.test_client.get("/fail")
assert response.status == 404
# 404 errors are not logged
assert (
"sanic.root",
logging.ERROR,
"Exception occurred while handling uri: 'http://127.0.0.1:42101/'",
) not in caplog.record_tuples
# Middleware exception ignored but logged
assert (
"sanic.error",
logging.ERROR,
"Exception occurred in one of response middleware handlers",
) in caplog.record_tuples
def test_middleware_override_request(app):
@app.middleware
async def halt_request(request):
return text("OK")
@app.route("/")
async def handler(request):
return text("FAIL")
response = app.test_client.get("/", gather_request=False)
assert response.status == 200
assert response.text == "OK"
def test_middleware_override_response(app):
@app.middleware("response")
async def process_response(request, response):
return text("OK")
@app.route("/")
async def handler(request):
return text("FAIL")
request, response = app.test_client.get("/")
assert response.status == 200
assert response.text == "OK"
def test_middleware_order(app):
order = []
@app.middleware("request")
async def request1(request):
order.append(1)
@app.middleware("request")
async def request2(request):
order.append(2)
@app.middleware("request")
async def request3(request):
order.append(3)
@app.middleware("response")
async def response1(request, response):
order.append(6)
@app.middleware("response")
async def response2(request, response):
order.append(5)
@app.middleware("response")
async def response3(request, response):
order.append(4)
@app.route("/")
async def handler(request):
return text("OK")
request, response = app.test_client.get("/")
assert response.status == 200
assert order == [1, 2, 3, 4, 5, 6]