Merge pull request #431 from subyraman/test-client-v2

Add Flask-like `test_client` to replace `sanic_endpoint_test`

sanic/sanic.py

@@ -17,6 +17,7 @@ from .response import HTTPResponse
 from .router import Router
 from .server import serve, serve_multiple, HttpProtocol
 from .static import register as static_register
+from .testing import TestClient
 from .views import CompositionView
 
 
@@ -409,6 +410,14 @@ class Sanic:
 
         response_callback(response)
 
+    # -------------------------------------------------------------------- #
+    # Testing
+    # -------------------------------------------------------------------- #
+
+    @property
+    def test_client(self):
+        return TestClient(self)
+
     # -------------------------------------------------------------------- #
     # Execution
     # -------------------------------------------------------------------- #

sanic/testing.py

@@ -0,0 +1,91 @@
+from sanic.log import log
+
+HOST = '127.0.0.1'
+PORT = 42101
+
+
+class TestClient:
+    def __init__(self, app):
+        self.app = app
+
+    async def _local_request(self, method, uri, cookies=None, *args, **kwargs):
+        import aiohttp
+        if uri.startswith(('http:', 'https:', 'ftp:', 'ftps://' '//')):
+            url = uri
+        else:
+            url = 'http://{host}:{port}{uri}'.format(
+                host=HOST, port=PORT, uri=uri)
+
+        log.info(url)
+        async with aiohttp.ClientSession(cookies=cookies) as session:
+            async with getattr(
+                    session, method.lower())(url, *args, **kwargs) as response:
+                response.text = await response.text()
+                response.body = await response.read()
+                return response
+
+    def _sanic_endpoint_test(
+            self, method='get', uri='/', gather_request=True,
+            debug=False, server_kwargs={},
+            *request_args, **request_kwargs):
+        results = [None, None]
+        exceptions = []
+
+        if gather_request:
+            def _collect_request(request):
+                if results[0] is None:
+                    results[0] = request
+            self.app.request_middleware.appendleft(_collect_request)
+
+        @self.app.listener('after_server_start')
+        async def _collect_response(sanic, loop):
+            try:
+                response = await self._local_request(
+                    method, uri, *request_args,
+                    **request_kwargs)
+                results[-1] = response
+            except Exception as e:
+                exceptions.self.append(e)
+            self.app.stop()
+
+        self.app.run(host=HOST, debug=debug, port=PORT, **server_kwargs)
+        self.app.listeners['after_server_start'].pop()
+
+        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))
+        else:
+            try:
+                return results[-1]
+            except:
+                raise ValueError(
+                    "Request object expected, got ({})".format(results))
+
+    def get(self, *args, **kwargs):
+        return self._sanic_endpoint_test('get', *args, **kwargs)
+
+    def post(self, *args, **kwargs):
+        return self._sanic_endpoint_test('post', *args, **kwargs)
+
+    def put(self, *args, **kwargs):
+        return self._sanic_endpoint_test('put', *args, **kwargs)
+
+    def delete(self, *args, **kwargs):
+        return self._sanic_endpoint_test('delete', *args, **kwargs)
+
+    def patch(self, *args, **kwargs):
+        return self._sanic_endpoint_test('patch', *args, **kwargs)
+
+    def options(self, *args, **kwargs):
+        return self._sanic_endpoint_test('options', *args, **kwargs)
+
+    def head(self, *args, **kwargs):
+        return self._sanic_endpoint_test('head', *args, **kwargs)

sanic/utils.py

@@ -1,64 +1,16 @@
-import aiohttp
-from sanic.log import log
-
-HOST = '127.0.0.1'
-PORT = 42101
-
-
-async def local_request(method, uri, cookies=None, *args, **kwargs):
-    if uri.startswith(('http:', 'https:', 'ftp:', 'ftps://' '//')):
-        url = uri
-    else:
-        url = 'http://{host}:{port}{uri}'.format(host=HOST, port=PORT, uri=uri)
-
-    log.info(url)
-    async with aiohttp.ClientSession(cookies=cookies) as session:
-        async with getattr(
-                session, method.lower())(url, *args, **kwargs) as response:
-            response.text = await response.text()
-            response.body = await response.read()
-            return response
+import warnings
+from sanic.testing import TestClient
 
 
 def sanic_endpoint_test(app, method='get', uri='/', gather_request=True,
-                        debug=False, server_kwargs={}, *request_args,
-                        **request_kwargs):
-    results = [None, None]
-    exceptions = []
+                        debug=False, server_kwargs={},
+                        *request_args, **request_kwargs):
+    warnings.warn(
+        "Use of sanic_endpoint_test will be deprecated in"
+        "the next major version after 0.4.0.  Please use the `test_client` "
+        "available on the app object.", DeprecationWarning)
 
-    if gather_request:
-        def _collect_request(request):
-            if results[0] is None:
-                results[0] = request
-        app.request_middleware.appendleft(_collect_request)
-
-    @app.listener('after_server_start')
-    async def _collect_response(sanic, loop):
-        try:
-            response = await local_request(method, uri, *request_args,
-                                           **request_kwargs)
-            results[-1] = response
-        except Exception as e:
-            exceptions.append(e)
-        app.stop()
-
-    app.run(host=HOST, debug=debug, port=PORT, **server_kwargs)
-    app.listeners['after_server_start'].pop()
-
-    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))
-    else:
-        try:
-            return results[-1]
-        except:
-            raise ValueError(
-                "Request object expected, got ({})".format(results))
+    test_client = TestClient(app)
+    return test_client._sanic_endpoint_test(
+        method, uri, gather_request, debug, server_kwargs,
+        *request_args, **request_kwargs)