Ticket #10899: 10899-proposal.patch

django/test/client.py

@@ -22 +22 @@
 from django.http import SimpleCookie, HttpRequest, QueryDict
 from django.template import TemplateDoesNotExist
 from django.test import signals
-from django.utils.functional import curry
+from django.utils.functional import cached_property, curry
 from django.utils.encoding import force_bytes, force_str
 from django.utils.http import urlencode
 from django.utils.importlib import import_module
@@ -378 +378 @@
         """
         self.exc_info = sys.exc_info()
 
-    def _session(self):
+    @cached_property
+    def session(self):
         """
         Obtains the current session variables.
         """
-        if 'django.contrib.sessions' in settings.INSTALLED_APPS:
-            engine = import_module(settings.SESSION_ENGINE)
-            cookie = self.cookies.get(settings.SESSION_COOKIE_NAME, None)
-            if cookie:
-                return engine.SessionStore(cookie.value)
-        return {}
-    session = property(_session)
+        if 'django.contrib.sessions' not in settings.INSTALLED_APPS:
+            return {}
 
+        engine = import_module(settings.SESSION_ENGINE)
+        cookie = self.cookies.get(settings.SESSION_COOKIE_NAME)
+        if cookie:
+            session_store = engine.SessionStore(cookie.value)
+        else:
+            session_store = engine.SessionStore()
+            session_store.create()
+            self.cookies[settings.SESSION_COOKIE_NAME] = session_store.session_key
+        return session_store
 
     def request(self, **request):
         """
@@ -400 +405 @@
         """
         environ = self._base_environ(**request)
 
+        if self.session:
+            if getattr(self.session, 'modified'):
+                self.session.save()
+
+            if 'django.contrib.sessions.middleware.SessionMiddleware' in settings.MIDDLEWARE_CLASSES:
+                # Update the session cookie since the session key can change
+                # due to login or logout and force the session to be reloaded
+                # on next access.
+                self.cookies[settings.SESSION_COOKIE_NAME] = self.session.session_key
+                self.session = None
+
         # Curry a data dictionary into an instance of the template renderer
         # callback function.
         data = {}
@@ -536 +552 @@
         user = authenticate(**credentials)
         if user and user.is_active \
                 and 'django.contrib.sessions' in settings.INSTALLED_APPS:
-            engine = import_module(settings.SESSION_ENGINE)
 
             # Create a fake request to store login details.
             request = HttpRequest()
-            if self.session:
-                request.session = self.session
-            else:
-                request.session = engine.SessionStore()
+            request.session = self.session
             login(request, user)
 
             # Save the session values.
@@ -576 +588 @@
         if session_cookie:
             session.delete(session_key=session_cookie.value)
         self.cookies = SimpleCookie()
+        self.session = None
 
     def _handle_redirects(self, response, **extra):
         "Follows any redirects by requesting responses from the server using GET."

docs/topics/testing/overview.txt

@@ -794 +794 @@
     A dictionary-like object containing session information. See the
     :doc:`session documentation</topics/http/sessions>` for full details.
 
-    To modify the session and then save it, it must be stored in a variable
-    first (because a new ``SessionStore`` is created every time this property
-    is accessed)::
+.. versionadded:: 1.6
+
+    If you wish to manipulate the session directly you can do that directly
+    on the client and the modified values will be saved on subsequent requests.
 
         def test_something(self):
-            session = self.client.session
-            session['somekey'] = 'test'
-            session.save()
+            self.client.session['somekey'] = value
+            self.client.session['anotherkey'] = value
+
 
 Example
 ~~~~~~~

tests/admin_views/tests.py

@@ -2583 +2583 @@
 
         # 4 queries are expected: 1 for the session, 1 for the user,
         # 1 for the count and 1 for the objects on the page
-        with self.assertNumQueries(4):
+        with self.assertNumQueries(6):
             resp = self.client.get('/test_admin/admin/admin_views/person/')
             self.assertEqual(resp.context['selection_note'], '0 of 2 selected')
             self.assertEqual(resp.context['selection_note_all'], 'All 2 selected')
@@ -3607 +3607 @@
         # Don't depend on a warm cache, see #17377.
         ContentType.objects.clear_cache()
 
-        expected_queries = 10
+        expected_queries = 12
         # Oracle doesn't implement "RELEASE SAVPOINT", see #20387.
         if connection.vendor == 'oracle':
             expected_queries -= 1
@@ -3650 +3650 @@
     def test_group_permission_performance(self):
         g = Group.objects.create(name="test_group")
 
-        expected_queries = 8
+        expected_queries = 10
         # Oracle doesn't implement "RELEASE SAVPOINT", see #20387.
         if connection.vendor == 'oracle':
             expected_queries -= 1

tests/test_client_regress/tests.py

@@ -756 +756 @@
         self.client.logout()
         self.client.logout()
 
+    def test_session_manipulation(self):
+        # Check that the session can be edited as documented before #10899.
+        session = self.client.session
+        session['session_var'] = b'foo'
+        session.save()
+
+        response = self.client.get('/test_client_regress/check_session/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.content, b'foo')
+
+    def test_direct_session_manipulation(self):
+        # Add a value to the session
+        self.client.session['session_var'] = b'bar'
+        self.assertEqual(self.client.session['session_var'], b'bar')
+
+        # Check that the session has been modified
+        response = self.client.get('/test_client_regress/check_session/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.content, b'bar')
+
+        # Check that the session variable persists over login
+        # when cycle_key() is called
+        self.client.login(username='testclient', password='password')
+        self.assertEqual(self.client.session['session_var'], b'bar')
+
+        response = self.client.get('/test_client_regress/check_session/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.content, b'bar')
+
+        # Check that new session is started after logout
+        self.client.logout()
+        self.assertEqual(self.client.session.get('session_var'), None)
+
+
 class RequestMethodTests(TestCase):
     def test_get(self):
         "Request a view via request method GET"