Merge pull request #30 from vitalk/request-ctx-fixture

Request context fixture. Closes #29.

Author: vitalk

docs/features.rst

@@ -84,7 +84,7 @@ An instance of ``app.test_client``. Typically refers to
 
 .. hint::
 
-    During tests execution the application has pushed context, e.g.
+    During tests execution the request context has been pushed, e.g.
     ``url_for``, ``session`` and other context bound objects are available
     without context managers.
 
@@ -139,6 +139,26 @@ other headless browsers).
             assert res.code == 200
 
 
+``request_ctx`` - request context
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The request context which contains all request relevant information.
+
+.. hint::
+
+    The request context has been pushed implicitly any time the ``app``
+    fixture is applied and is kept around during test execution, so it's easy
+    to introspect the data:
+
+    .. code:: python
+
+        from flask import request, url_for
+
+        def test_request_headers(client):
+            res = client.get(url_for('ping'), headers=[('X-Something', '42')])
+            assert request.headers['X-Something'] == '42'
+
+
 Content negotiation
 ~~~~~~~~~~~~~~~~~~~
 

pytest_flask/__init__.py

@@ -1,4 +1,4 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-__version__ = "0.7.5"
+__version__ = "0.8.0"

pytest_flask/fixtures.py

@@ -10,6 +10,8 @@
 except ImportError:
     from urllib.request import urlopen
 
+from flask import _request_ctx_stack
+
 
 @pytest.yield_fixture
 def client(app):
@@ -132,6 +134,14 @@ def config(app):
     return app.config
 
 
+@pytest.fixture
+def request_ctx(app):
+    """The request context which contains all request relevant information,
+    e.g. `session`, `g`, `flashes`, etc.
+    """
+    return _request_ctx_stack.top
+
+
 @pytest.fixture(params=['application/json', 'text/html'])
 def mimetype(request):
     return request.param

pytest_flask/plugin.py

@@ -13,7 +13,7 @@
 
 from .fixtures import (
     client, config, accept_json, accept_jsonp, accept_any, accept_mimetype,
-    client_class, live_server
+    client_class, live_server, request_ctx
 )
 
 
@@ -64,8 +64,8 @@ def test_json(client):
 
 
 @pytest.fixture(autouse=True)
-def _push_application_context(request):
-    """During tests execution application has pushed context, e.g. `url_for`,
+def _push_request_context(request):
+    """During tests execution request context has been pushed, e.g. `url_for`,
     `session`, etc. can be used in tests as is::
 
         def test_app(app, client):

setup.py

@@ -17,6 +17,7 @@
 - ``config`` - you application config,
 - ``live_server`` - runs an application in the background (useful for tests
   with `Selenium <http://www.seleniumhq.org>`_ and other headless browsers),
+- ``request_ctx`` - the request context,
 - ``accept_json``, ``accept_jsonp``, ``accept_any`` - accept headers
   suitable to use as parameters in ``client``.
 
@@ -28,7 +29,7 @@
     def test_app(app):
       assert not app.debug, 'Ensure the app not in debug mode'
 
-During tests execution the application has pushed context, e.g. ``url_for``,
+During tests execution the request context has been pushed, e.g. ``url_for``,
 ``session`` and other context bound objects are available without context
 managers:
 

tests/test_fixtures.py

@@ -2,17 +2,14 @@
 # -*- coding: utf-8 -*-
 import pytest
 
-from flask import url_for
+from flask import request, url_for
 
 
 class TestFixtures:
 
     def test_config_access(self, config):
         assert config['SECRET_KEY'] == '42'
 
-    def test_application_has_pushed_context(self, app):
-        assert url_for('ping') == '/ping'
-
     def test_client(self, client):
         assert client.get(url_for('ping')).status == b'200 OK'
 
@@ -22,6 +19,13 @@ def test_accept_json(self, accept_json):
     def test_accept_jsonp(self, accept_jsonp):
         assert accept_jsonp == [('Accept', 'application/json-p')]
 
+    def test_request_ctx(self, app, request_ctx):
+        assert request_ctx.app is app
+
+    def test_request_ctx_is_kept_around(self, client):
+        res = client.get(url_for('index'), headers=[('X-Something', '42')])
+        assert request.headers['X-Something'] == '42'
+
 
 class TestJSONResponse: