Merge pull request #386 from youknowone/sanic_endpoint_test

Fix sanic_endpoint_test working with redirects

sanic/utils.py

@@ -19,19 +19,20 @@ async def local_request(method, uri, cookies=None, *args, **kwargs):
 def sanic_endpoint_test(app, method='get', uri='/', gather_request=True,
                         debug=False, server_kwargs={},
                         *request_args, **request_kwargs):
-    results = []
+    results = [None, None]
     exceptions = []
 
     if gather_request:
         def _collect_request(request):
-            results.append(request)
+            if results[0] is None:
+                results[0] = 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)
+            results[-1] = response
         except Exception as e:
             exceptions.append(e)
         app.stop()
@@ -52,7 +53,7 @@ def sanic_endpoint_test(app, method='get', uri='/', gather_request=True,
                     results))
     else:
         try:
-            return results[0]
+            return results[-1]
         except:
             raise ValueError(
                 "Request object expected, got ({})".format(results))

tests/test_redirect.py

@@ -0,0 +1,96 @@
+import pytest
+
+from sanic import Sanic
+from sanic.response import text, redirect
+from sanic.utils import sanic_endpoint_test
+
+
+@pytest.fixture
+def redirect_app():
+    app = Sanic('test_redirection')
+
+    @app.route('/redirect_init')
+    async def redirect_init(request):
+        return redirect("/redirect_target")
+
+    @app.route('/redirect_init_with_301')
+    async def redirect_init_with_301(request):
+        return redirect("/redirect_target", status=301)
+
+    @app.route('/redirect_target')
+    async def redirect_target(request):
+        return text('OK')
+
+    @app.route('/1')
+    def handler(request):
+        return redirect('/2')
+
+    @app.route('/2')
+    def handler(request):
+        return redirect('/3')
+
+    @app.route('/3')
+    def handler(request):
+        return text('OK')
+
+    return app
+
+
+def test_redirect_default_302(redirect_app):
+    """
+    We expect a 302 default status code and the headers to be set.
+    """
+    request, response = sanic_endpoint_test(
+        redirect_app, method="get",
+        uri="/redirect_init",
+        allow_redirects=False)
+
+    assert response.status == 302
+    assert response.headers["Location"] == "/redirect_target"
+    assert response.headers["Content-Type"] == 'text/html; charset=utf-8'
+
+
+def test_redirect_headers_none(redirect_app):
+    request, response = sanic_endpoint_test(
+        redirect_app, method="get",
+        uri="/redirect_init",
+        headers=None,
+        allow_redirects=False)
+
+    assert response.status == 302
+    assert response.headers["Location"] == "/redirect_target"
+
+
+def test_redirect_with_301(redirect_app):
+    """
+    Test redirection with a different status code.
+    """
+    request, response = sanic_endpoint_test(
+        redirect_app, method="get",
+        uri="/redirect_init_with_301",
+        allow_redirects=False)
+
+    assert response.status == 301
+    assert response.headers["Location"] == "/redirect_target"
+
+
+def test_get_then_redirect_follow_redirect(redirect_app):
+    """
+    With `allow_redirects` we expect a 200.
+    """
+    response = sanic_endpoint_test(
+        redirect_app, method="get",
+        uri="/redirect_init", gather_request=False,
+        allow_redirects=True)
+
+    assert response.status == 200
+    assert response.text == 'OK'
+
+
+def test_chained_redirect(redirect_app):
+    """Test sanic_endpoint_test is working for redirection"""
+    request, response = sanic_endpoint_test(redirect_app, uri='/1')
+    assert request.url.endswith('/1')
+    assert response.status == 200
+    assert response.text == 'OK'
+    assert response.url.endswith('/3')

tests/test_requests.py

@@ -58,7 +58,7 @@ def test_non_str_headers():
     request, response = sanic_endpoint_test(app)
 
     assert response.headers.get('answer') == '42'
-    
+
 def test_invalid_response():
     app = Sanic('test_invalid_response')
 
@@ -73,8 +73,8 @@ def test_invalid_response():
     request, response = sanic_endpoint_test(app)
     assert response.status == 500
     assert response.text == "Internal Server Error."
-    
-    
+
+
 def test_json():
     app = Sanic('test_json')
 
@@ -189,73 +189,3 @@ def test_post_form_multipart_form_data():
     request, response = sanic_endpoint_test(app, data=payload, headers=headers)
 
     assert request.form.get('test') == 'OK'
-
-
-@pytest.fixture
-def redirect_app():
-    app = Sanic('test_redirection')
-
-    @app.route('/redirect_init')
-    async def redirect_init(request):
-        return redirect("/redirect_target")
-
-    @app.route('/redirect_init_with_301')
-    async def redirect_init_with_301(request):
-        return redirect("/redirect_target", status=301)
-
-    @app.route('/redirect_target')
-    async def redirect_target(request):
-        return text('OK')
-
-    return app
-
-
-def test_redirect_default_302(redirect_app):
-    """
-    We expect a 302 default status code and the headers to be set.
-    """
-    request, response = sanic_endpoint_test(
-        redirect_app, method="get",
-        uri="/redirect_init",
-        allow_redirects=False)
-
-    assert response.status == 302
-    assert response.headers["Location"] == "/redirect_target"
-    assert response.headers["Content-Type"] == 'text/html; charset=utf-8'
-
-
-def test_redirect_headers_none(redirect_app):
-    request, response = sanic_endpoint_test(
-        redirect_app, method="get",
-        uri="/redirect_init",
-        headers=None,
-        allow_redirects=False)
-
-    assert response.status == 302
-    assert response.headers["Location"] == "/redirect_target"
-
-
-def test_redirect_with_301(redirect_app):
-    """
-    Test redirection with a different status code.
-    """
-    request, response = sanic_endpoint_test(
-        redirect_app, method="get",
-        uri="/redirect_init_with_301",
-        allow_redirects=False)
-
-    assert response.status == 301
-    assert response.headers["Location"] == "/redirect_target"
-
-
-def test_get_then_redirect_follow_redirect(redirect_app):
-    """
-    With `allow_redirects` we expect a 200.
-    """
-    response = sanic_endpoint_test(
-        redirect_app, method="get",
-        uri="/redirect_init", gather_request=False,
-        allow_redirects=True)
-
-    assert response.status == 200
-    assert response.text == 'OK'