3f7c9ea3f5
* feat: fixes exception due to unread bytes in stream * feat: additonal unit tests to cover changes * fix: automated changes by `make fix-import` * fix: additonal changes by `make fix-import` Co-authored-by: Adam Hopkins <admhpkns@gmail.com>
675 lines
20 KiB
Python
675 lines
20 KiB
Python
import pytest
|
|
import asyncio
|
|
|
|
from sanic.blueprints import Blueprint
|
|
from sanic.exceptions import HeaderExpectationFailed
|
|
from sanic.request import StreamBuffer
|
|
from sanic.response import json, stream, text
|
|
from sanic.views import CompositionView, HTTPMethodView
|
|
from sanic.views import stream as stream_decorator
|
|
from sanic.server import HttpProtocol
|
|
|
|
|
|
data = "abc" * 1_000_000
|
|
|
|
|
|
def test_request_stream_method_view(app):
|
|
"""for self.is_request_stream = True"""
|
|
|
|
class SimpleView(HTTPMethodView):
|
|
def get(self, request):
|
|
assert request.stream is None
|
|
return text("OK")
|
|
|
|
@stream_decorator
|
|
async def post(self, request):
|
|
assert isinstance(request.stream, StreamBuffer)
|
|
result = ""
|
|
while True:
|
|
body = await request.stream.read()
|
|
if body is None:
|
|
break
|
|
result += body.decode("utf-8")
|
|
return text(result)
|
|
|
|
app.add_route(SimpleView.as_view(), "/method_view")
|
|
|
|
assert app.is_request_stream is True
|
|
|
|
request, response = app.test_client.get("/method_view")
|
|
assert response.status == 200
|
|
assert response.text == "OK"
|
|
|
|
request, response = app.test_client.post("/method_view", data=data)
|
|
assert response.status == 200
|
|
assert response.text == data
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"headers, expect_raise_exception",
|
|
[
|
|
({"EXPECT": "100-continue"}, False),
|
|
({"EXPECT": "100-continue-extra"}, True),
|
|
],
|
|
)
|
|
def test_request_stream_100_continue(app, headers, expect_raise_exception):
|
|
class SimpleView(HTTPMethodView):
|
|
@stream_decorator
|
|
async def post(self, request):
|
|
assert isinstance(request.stream, StreamBuffer)
|
|
result = ""
|
|
while True:
|
|
body = await request.stream.read()
|
|
if body is None:
|
|
break
|
|
result += body.decode("utf-8")
|
|
return text(result)
|
|
|
|
app.add_route(SimpleView.as_view(), "/method_view")
|
|
|
|
assert app.is_request_stream is True
|
|
|
|
if not expect_raise_exception:
|
|
request, response = app.test_client.post(
|
|
"/method_view", data=data, headers={"EXPECT": "100-continue"}
|
|
)
|
|
assert response.status == 200
|
|
assert response.text == data
|
|
else:
|
|
with pytest.raises(ValueError) as e:
|
|
app.test_client.post(
|
|
"/method_view",
|
|
data=data,
|
|
headers={"EXPECT": "100-continue-extra"},
|
|
)
|
|
assert "Unknown Expect: 100-continue-extra" in str(e)
|
|
|
|
|
|
def test_request_stream_app(app):
|
|
"""for self.is_request_stream = True and decorators"""
|
|
|
|
@app.get("/get")
|
|
async def get(request):
|
|
assert request.stream is None
|
|
return text("GET")
|
|
|
|
@app.head("/head")
|
|
async def head(request):
|
|
assert request.stream is None
|
|
return text("HEAD")
|
|
|
|
@app.delete("/delete")
|
|
async def delete(request):
|
|
assert request.stream is None
|
|
return text("DELETE")
|
|
|
|
@app.options("/options")
|
|
async def options(request):
|
|
assert request.stream is None
|
|
return text("OPTIONS")
|
|
|
|
@app.post("/_post/<id>")
|
|
async def _post(request, id):
|
|
assert request.stream is None
|
|
return text("_POST")
|
|
|
|
@app.post("/post/<id>", stream=True)
|
|
async def post(request, id):
|
|
assert isinstance(request.stream, StreamBuffer)
|
|
result = ""
|
|
while True:
|
|
body = await request.stream.read()
|
|
if body is None:
|
|
break
|
|
result += body.decode("utf-8")
|
|
return text(result)
|
|
|
|
@app.put("/_put")
|
|
async def _put(request):
|
|
assert request.stream is None
|
|
return text("_PUT")
|
|
|
|
@app.put("/put", stream=True)
|
|
async def put(request):
|
|
assert isinstance(request.stream, StreamBuffer)
|
|
result = ""
|
|
while True:
|
|
body = await request.stream.read()
|
|
if body is None:
|
|
break
|
|
result += body.decode("utf-8")
|
|
return text(result)
|
|
|
|
@app.patch("/_patch")
|
|
async def _patch(request):
|
|
assert request.stream is None
|
|
return text("_PATCH")
|
|
|
|
@app.patch("/patch", stream=True)
|
|
async def patch(request):
|
|
assert isinstance(request.stream, StreamBuffer)
|
|
result = ""
|
|
while True:
|
|
body = await request.stream.read()
|
|
if body is None:
|
|
break
|
|
result += body.decode("utf-8")
|
|
return text(result)
|
|
|
|
assert app.is_request_stream is True
|
|
|
|
request, response = app.test_client.get("/get")
|
|
assert response.status == 200
|
|
assert response.text == "GET"
|
|
|
|
request, response = app.test_client.head("/head")
|
|
assert response.status == 200
|
|
assert response.text == ""
|
|
|
|
request, response = app.test_client.delete("/delete")
|
|
assert response.status == 200
|
|
assert response.text == "DELETE"
|
|
|
|
request, response = app.test_client.options("/options")
|
|
assert response.status == 200
|
|
assert response.text == "OPTIONS"
|
|
|
|
request, response = app.test_client.post("/_post/1", data=data)
|
|
assert response.status == 200
|
|
assert response.text == "_POST"
|
|
|
|
request, response = app.test_client.post("/post/1", data=data)
|
|
assert response.status == 200
|
|
assert response.text == data
|
|
|
|
request, response = app.test_client.put("/_put", data=data)
|
|
assert response.status == 200
|
|
assert response.text == "_PUT"
|
|
|
|
request, response = app.test_client.put("/put", data=data)
|
|
assert response.status == 200
|
|
assert response.text == data
|
|
|
|
request, response = app.test_client.patch("/_patch", data=data)
|
|
assert response.status == 200
|
|
assert response.text == "_PATCH"
|
|
|
|
request, response = app.test_client.patch("/patch", data=data)
|
|
assert response.status == 200
|
|
assert response.text == data
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_request_stream_app_asgi(app):
|
|
"""for self.is_request_stream = True and decorators"""
|
|
|
|
@app.get("/get")
|
|
async def get(request):
|
|
assert request.stream is None
|
|
return text("GET")
|
|
|
|
@app.head("/head")
|
|
async def head(request):
|
|
assert request.stream is None
|
|
return text("HEAD")
|
|
|
|
@app.delete("/delete")
|
|
async def delete(request):
|
|
assert request.stream is None
|
|
return text("DELETE")
|
|
|
|
@app.options("/options")
|
|
async def options(request):
|
|
assert request.stream is None
|
|
return text("OPTIONS")
|
|
|
|
@app.post("/_post/<id>")
|
|
async def _post(request, id):
|
|
assert request.stream is None
|
|
return text("_POST")
|
|
|
|
@app.post("/post/<id>", stream=True)
|
|
async def post(request, id):
|
|
assert isinstance(request.stream, StreamBuffer)
|
|
result = ""
|
|
while True:
|
|
body = await request.stream.read()
|
|
if body is None:
|
|
break
|
|
result += body.decode("utf-8")
|
|
return text(result)
|
|
|
|
@app.put("/_put")
|
|
async def _put(request):
|
|
assert request.stream is None
|
|
return text("_PUT")
|
|
|
|
@app.put("/put", stream=True)
|
|
async def put(request):
|
|
assert isinstance(request.stream, StreamBuffer)
|
|
result = ""
|
|
while True:
|
|
body = await request.stream.read()
|
|
if body is None:
|
|
break
|
|
result += body.decode("utf-8")
|
|
return text(result)
|
|
|
|
@app.patch("/_patch")
|
|
async def _patch(request):
|
|
assert request.stream is None
|
|
return text("_PATCH")
|
|
|
|
@app.patch("/patch", stream=True)
|
|
async def patch(request):
|
|
assert isinstance(request.stream, StreamBuffer)
|
|
result = ""
|
|
while True:
|
|
body = await request.stream.read()
|
|
if body is None:
|
|
break
|
|
result += body.decode("utf-8")
|
|
return text(result)
|
|
|
|
assert app.is_request_stream is True
|
|
|
|
request, response = await app.asgi_client.get("/get")
|
|
assert response.status == 200
|
|
assert response.text == "GET"
|
|
|
|
request, response = await app.asgi_client.head("/head")
|
|
assert response.status == 200
|
|
assert response.text == ""
|
|
|
|
request, response = await app.asgi_client.delete("/delete")
|
|
assert response.status == 200
|
|
assert response.text == "DELETE"
|
|
|
|
request, response = await app.asgi_client.options("/options")
|
|
assert response.status == 200
|
|
assert response.text == "OPTIONS"
|
|
|
|
request, response = await app.asgi_client.post("/_post/1", data=data)
|
|
assert response.status == 200
|
|
assert response.text == "_POST"
|
|
|
|
request, response = await app.asgi_client.post("/post/1", data=data)
|
|
assert response.status == 200
|
|
assert response.text == data
|
|
|
|
request, response = await app.asgi_client.put("/_put", data=data)
|
|
assert response.status == 200
|
|
assert response.text == "_PUT"
|
|
|
|
request, response = await app.asgi_client.put("/put", data=data)
|
|
assert response.status == 200
|
|
assert response.text == data
|
|
|
|
request, response = await app.asgi_client.patch("/_patch", data=data)
|
|
assert response.status == 200
|
|
assert response.text == "_PATCH"
|
|
|
|
request, response = await app.asgi_client.patch("/patch", data=data)
|
|
assert response.status == 200
|
|
assert response.text == data
|
|
|
|
|
|
def test_request_stream_handle_exception(app):
|
|
"""for handling exceptions properly"""
|
|
|
|
@app.post("/post/<id>", stream=True)
|
|
async def post(request, id):
|
|
assert isinstance(request.stream, StreamBuffer)
|
|
result = ""
|
|
while True:
|
|
body = await request.stream.read()
|
|
if body is None:
|
|
break
|
|
result += body.decode("utf-8")
|
|
return text(result)
|
|
|
|
# 404
|
|
request, response = app.test_client.post("/in_valid_post", data=data)
|
|
assert response.status == 404
|
|
assert "Requested URL /in_valid_post not found" in response.text
|
|
|
|
# 405
|
|
request, response = app.test_client.get("/post/random_id")
|
|
assert response.status == 405
|
|
assert "Method GET not allowed for URL /post/random_id" in response.text
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_request_stream_unread(app):
|
|
"""ensure no error is raised when leaving unread bytes in byte-buffer"""
|
|
|
|
err = None
|
|
protocol = HttpProtocol(loop=asyncio.get_event_loop(), app=app)
|
|
try:
|
|
protocol.request = None
|
|
protocol._body_chunks.append("this is a test")
|
|
await protocol.stream_append()
|
|
except AttributeError as e:
|
|
err = e
|
|
|
|
assert err is None and not protocol._body_chunks
|
|
|
|
|
|
def test_request_stream_blueprint(app):
|
|
"""for self.is_request_stream = True"""
|
|
bp = Blueprint("test_blueprint_request_stream_blueprint")
|
|
|
|
@app.get("/get")
|
|
async def get(request):
|
|
assert request.stream is None
|
|
return text("GET")
|
|
|
|
@bp.head("/head")
|
|
async def head(request):
|
|
assert request.stream is None
|
|
return text("HEAD")
|
|
|
|
@bp.delete("/delete")
|
|
async def delete(request):
|
|
assert request.stream is None
|
|
return text("DELETE")
|
|
|
|
@bp.options("/options")
|
|
async def options(request):
|
|
assert request.stream is None
|
|
return text("OPTIONS")
|
|
|
|
@bp.post("/_post/<id>")
|
|
async def _post(request, id):
|
|
assert request.stream is None
|
|
return text("_POST")
|
|
|
|
@bp.post("/post/<id>", stream=True)
|
|
async def post(request, id):
|
|
assert isinstance(request.stream, StreamBuffer)
|
|
result = ""
|
|
while True:
|
|
body = await request.stream.read()
|
|
if body is None:
|
|
break
|
|
result += body.decode("utf-8")
|
|
return text(result)
|
|
|
|
@bp.put("/_put")
|
|
async def _put(request):
|
|
assert request.stream is None
|
|
return text("_PUT")
|
|
|
|
@bp.put("/put", stream=True)
|
|
async def put(request):
|
|
assert isinstance(request.stream, StreamBuffer)
|
|
result = ""
|
|
while True:
|
|
body = await request.stream.read()
|
|
if body is None:
|
|
break
|
|
result += body.decode("utf-8")
|
|
return text(result)
|
|
|
|
@bp.patch("/_patch")
|
|
async def _patch(request):
|
|
assert request.stream is None
|
|
return text("_PATCH")
|
|
|
|
@bp.patch("/patch", stream=True)
|
|
async def patch(request):
|
|
assert isinstance(request.stream, StreamBuffer)
|
|
result = ""
|
|
while True:
|
|
body = await request.stream.read()
|
|
if body is None:
|
|
break
|
|
result += body.decode("utf-8")
|
|
return text(result)
|
|
|
|
async def post_add_route(request):
|
|
assert isinstance(request.stream, StreamBuffer)
|
|
result = ""
|
|
while True:
|
|
body = await request.stream.read()
|
|
if body is None:
|
|
break
|
|
result += body.decode("utf-8")
|
|
return text(result)
|
|
|
|
bp.add_route(
|
|
post_add_route, "/post/add_route", methods=["POST"], stream=True
|
|
)
|
|
app.blueprint(bp)
|
|
|
|
assert app.is_request_stream is True
|
|
|
|
request, response = app.test_client.get("/get")
|
|
assert response.status == 200
|
|
assert response.text == "GET"
|
|
|
|
request, response = app.test_client.head("/head")
|
|
assert response.status == 200
|
|
assert response.text == ""
|
|
|
|
request, response = app.test_client.delete("/delete")
|
|
assert response.status == 200
|
|
assert response.text == "DELETE"
|
|
|
|
request, response = app.test_client.options("/options")
|
|
assert response.status == 200
|
|
assert response.text == "OPTIONS"
|
|
|
|
request, response = app.test_client.post("/_post/1", data=data)
|
|
assert response.status == 200
|
|
assert response.text == "_POST"
|
|
|
|
request, response = app.test_client.post("/post/1", data=data)
|
|
assert response.status == 200
|
|
assert response.text == data
|
|
|
|
request, response = app.test_client.put("/_put", data=data)
|
|
assert response.status == 200
|
|
assert response.text == "_PUT"
|
|
|
|
request, response = app.test_client.put("/put", data=data)
|
|
assert response.status == 200
|
|
assert response.text == data
|
|
|
|
request, response = app.test_client.patch("/_patch", data=data)
|
|
assert response.status == 200
|
|
assert response.text == "_PATCH"
|
|
|
|
request, response = app.test_client.patch("/patch", data=data)
|
|
assert response.status == 200
|
|
assert response.text == data
|
|
|
|
request, response = app.test_client.post("/post/add_route", data=data)
|
|
assert response.status == 200
|
|
assert response.text == data
|
|
|
|
|
|
def test_request_stream_composition_view(app):
|
|
"""for self.is_request_stream = True"""
|
|
|
|
def get_handler(request):
|
|
assert request.stream is None
|
|
return text("OK")
|
|
|
|
async def post_handler(request):
|
|
assert isinstance(request.stream, StreamBuffer)
|
|
result = ""
|
|
while True:
|
|
body = await request.stream.read()
|
|
if body is None:
|
|
break
|
|
result += body.decode("utf-8")
|
|
return text(result)
|
|
|
|
view = CompositionView()
|
|
view.add(["GET"], get_handler)
|
|
view.add(["POST"], post_handler, stream=True)
|
|
app.add_route(view, "/composition_view")
|
|
|
|
assert app.is_request_stream is True
|
|
|
|
request, response = app.test_client.get("/composition_view")
|
|
assert response.status == 200
|
|
assert response.text == "OK"
|
|
|
|
request, response = app.test_client.post("/composition_view", data=data)
|
|
assert response.status == 200
|
|
assert response.text == data
|
|
|
|
|
|
def test_request_stream(app):
|
|
"""test for complex application"""
|
|
bp = Blueprint("test_blueprint_request_stream")
|
|
|
|
class SimpleView(HTTPMethodView):
|
|
def get(self, request):
|
|
assert request.stream is None
|
|
return text("OK")
|
|
|
|
@stream_decorator
|
|
async def post(self, request):
|
|
assert isinstance(request.stream, StreamBuffer)
|
|
result = ""
|
|
while True:
|
|
body = await request.stream.read()
|
|
if body is None:
|
|
break
|
|
result += body.decode("utf-8")
|
|
return text(result)
|
|
|
|
@app.post("/stream", stream=True)
|
|
async def handler(request):
|
|
assert isinstance(request.stream, StreamBuffer)
|
|
result = ""
|
|
while True:
|
|
body = await request.stream.read()
|
|
if body is None:
|
|
break
|
|
result += body.decode("utf-8")
|
|
return text(result)
|
|
|
|
@app.get("/get")
|
|
async def get(request):
|
|
assert request.stream is None
|
|
return text("OK")
|
|
|
|
@bp.post("/bp_stream", stream=True)
|
|
async def bp_stream(request):
|
|
assert isinstance(request.stream, StreamBuffer)
|
|
result = ""
|
|
while True:
|
|
body = await request.stream.read()
|
|
if body is None:
|
|
break
|
|
result += body.decode("utf-8")
|
|
return text(result)
|
|
|
|
@bp.get("/bp_get")
|
|
async def bp_get(request):
|
|
assert request.stream is None
|
|
return text("OK")
|
|
|
|
def get_handler(request):
|
|
assert request.stream is None
|
|
return text("OK")
|
|
|
|
async def post_handler(request):
|
|
assert isinstance(request.stream, StreamBuffer)
|
|
result = ""
|
|
while True:
|
|
body = await request.stream.read()
|
|
if body is None:
|
|
break
|
|
result += body.decode("utf-8")
|
|
return text(result)
|
|
|
|
app.add_route(SimpleView.as_view(), "/method_view")
|
|
|
|
view = CompositionView()
|
|
view.add(["GET"], get_handler)
|
|
view.add(["POST"], post_handler, stream=True)
|
|
|
|
app.blueprint(bp)
|
|
|
|
app.add_route(view, "/composition_view")
|
|
|
|
assert app.is_request_stream is True
|
|
|
|
request, response = app.test_client.get("/method_view")
|
|
assert response.status == 200
|
|
assert response.text == "OK"
|
|
|
|
request, response = app.test_client.post("/method_view", data=data)
|
|
assert response.status == 200
|
|
assert response.text == data
|
|
|
|
request, response = app.test_client.get("/composition_view")
|
|
assert response.status == 200
|
|
assert response.text == "OK"
|
|
|
|
request, response = app.test_client.post("/composition_view", data=data)
|
|
assert response.status == 200
|
|
assert response.text == data
|
|
|
|
request, response = app.test_client.get("/get")
|
|
assert response.status == 200
|
|
assert response.text == "OK"
|
|
|
|
request, response = app.test_client.post("/stream", data=data)
|
|
assert response.status == 200
|
|
assert response.text == data
|
|
|
|
request, response = app.test_client.get("/bp_get")
|
|
assert response.status == 200
|
|
assert response.text == "OK"
|
|
|
|
request, response = app.test_client.post("/bp_stream", data=data)
|
|
assert response.status == 200
|
|
assert response.text == data
|
|
|
|
|
|
def test_streaming_new_api(app):
|
|
@app.post("/non-stream")
|
|
async def handler(request):
|
|
assert request.body == b"x"
|
|
await request.receive_body() # This should do nothing
|
|
assert request.body == b"x"
|
|
return text("OK")
|
|
|
|
@app.post("/1", stream=True)
|
|
async def handler(request):
|
|
assert request.stream
|
|
assert not request.body
|
|
await request.receive_body()
|
|
return text(request.body.decode().upper())
|
|
|
|
@app.post("/2", stream=True)
|
|
async def handler(request):
|
|
ret = []
|
|
async for data in request.stream:
|
|
# We should have no b"" or None, just proper chunks
|
|
assert data
|
|
assert isinstance(data, bytes)
|
|
ret.append(data.decode("ASCII"))
|
|
return json(ret)
|
|
|
|
request, response = app.test_client.post("/non-stream", data="x")
|
|
assert response.status == 200
|
|
|
|
request, response = app.test_client.post("/1", data="TEST data")
|
|
assert request.body == b"TEST data"
|
|
assert response.status == 200
|
|
assert response.text == "TEST DATA"
|
|
|
|
request, response = app.test_client.post("/2", data=data)
|
|
assert response.status == 200
|
|
res = response.json
|
|
assert isinstance(res, list)
|
|
assert len(res) > 1
|
|
assert "".join(res) == data
|