| 1 |
from django.contrib.messages import Message, constants |
| 2 |
from django.contrib.messages.storage.session import SessionStorage |
| 3 |
from django.core.exceptions import ImproperlyConfigured |
| 4 |
from django.http import HttpRequest |
| 5 |
from django.test import TestCase |
| 6 |
from django.utils.safestring import SafeData, mark_safe |
| 7 |
|
| 8 |
from .base import BaseTests |
| 9 |
|
| 10 |
|
| 11 |
def set_session_data(storage, messages): |
| 12 |
""" |
| 13 |
Sets the messages into the backend request's session and remove the |
| 14 |
backend's loaded data cache. |
| 15 |
""" |
| 16 |
storage.request.session[storage.session_key] = storage.serialize_messages(messages) |
| 17 |
if hasattr(storage, "_loaded_data"): |
| 18 |
del storage._loaded_data |
| 19 |
|
| 20 |
|
| 21 |
def stored_session_messages_count(storage): |
| 22 |
data = storage.deserialize_messages( |
| 23 |
storage.request.session.get(storage.session_key, []) |
| 24 |
) |
| 25 |
return len(data) |
| 26 |
|
| 27 |
|
| 28 |
class SessionTests(BaseTests, TestCase): |
| 29 |
storage_class = SessionStorage |
| 30 |
|
| 31 |
def get_request(self): |
| 32 |
self.session = {} |
| 33 |
request = super().get_request() |
| 34 |
request.session = self.session |
| 35 |
return request |
| 36 |
|
| 37 |
def stored_messages_count(self, storage, response): |
| 38 |
return stored_session_messages_count(storage) |
| 39 |
|
| 40 |
def test_no_session(self): |
| 41 |
msg = ( |
| 42 |
"The session-based temporary message storage requires session " |
| 43 |
"middleware to be installed, and come before the message " |
| 44 |
"middleware in the MIDDLEWARE list." |
| 45 |
) |
| 46 |
with self.assertRaisesMessage(ImproperlyConfigured, msg): |
| 47 |
self.storage_class(HttpRequest()) |
| 48 |
|
| 49 |
def test_get(self): |
| 50 |
storage = self.storage_class(self.get_request()) |
| 51 |
example_messages = ["test", "me"] |
| 52 |
set_session_data(storage, example_messages) |
| 53 |
self.assertEqual(list(storage), example_messages) |
| 54 |
|
| 55 |
def test_safedata(self): |
| 56 |
""" |
| 57 |
A message containing SafeData keeps its safe status when retrieved from |
| 58 |
the message storage. |
| 59 |
""" |
| 60 |
storage = self.get_storage() |
| 61 |
message = Message(constants.DEBUG, mark_safe("<b>Hello Django!</b>")) |
| 62 |
set_session_data(storage, [message]) |
| 63 |
self.assertIsInstance(list(storage)[0].message, SafeData) |