Debian Codegraph @

tests/messages_tests/tests.py

raw
1 import importlib
2 import sys
3 import traceback
4 import unittest
5 from unittest import mock
6
7 from django.conf import settings
8 from django.contrib.messages import Message, add_message, constants
9 from django.contrib.messages.storage import base
10 from django.contrib.messages.test import MessagesTestMixin
11 from django.test import RequestFactory, SimpleTestCase, override_settings
12
13 from .utils import DummyStorage
14
15
16 class MessageTests(SimpleTestCase):
17 def test_eq(self):
18 msg_1 = Message(constants.INFO, "Test message 1")
19 msg_2 = Message(constants.INFO, "Test message 2")
20 msg_3 = Message(constants.WARNING, "Test message 1")
21 self.assertEqual(msg_1, msg_1)
22 self.assertEqual(msg_1, mock.ANY)
23 self.assertNotEqual(msg_1, msg_2)
24 self.assertNotEqual(msg_1, msg_3)
25 self.assertNotEqual(msg_2, msg_3)
26
27 @override_settings(
28 MESSAGE_TAGS={
29 constants.WARNING: "caution",
30 constants.ERROR: "",
31 12: "custom",
32 }
33 )
34 def test_repr(self):
35 tests = [
36 (constants.INFO, "thing", "", "Message(level=20, message='thing')"),
37 (
38 constants.WARNING,
39 "careful",
40 "tag1 tag2",
41 "Message(level=30, message='careful', extra_tags='tag1 tag2')",
42 ),
43 (
44 constants.ERROR,
45 "oops",
46 "tag",
47 "Message(level=40, message='oops', extra_tags='tag')",
48 ),
49 (12, "custom", "", "Message(level=12, message='custom')"),
50 ]
51 for level, message, extra_tags, expected in tests:
52 with self.subTest(level=level, message=message):
53 msg = Message(level, message, extra_tags=extra_tags)
54 self.assertEqual(repr(msg), expected)
55
56
57 class TestLevelTags(SimpleTestCase):
58 message_tags = {
59 constants.INFO: "info",
60 constants.DEBUG: "",
61 constants.WARNING: "",
62 constants.ERROR: "bad",
63 constants.SUCCESS: "",
64 12: "custom",
65 }
66
67 @override_settings(MESSAGE_TAGS=message_tags)
68 def test_override_settings_level_tags(self):
69 self.assertEqual(base.LEVEL_TAGS, self.message_tags)
70
71 def test_lazy(self):
72 storage_base_import_path = "django.contrib.messages.storage.base"
73 in_use_base = sys.modules.pop(storage_base_import_path)
74 self.addCleanup(sys.modules.__setitem__, storage_base_import_path, in_use_base)
75 # Don't use @override_settings to avoid calling the setting_changed
76 # signal, but ensure that base.LEVEL_TAGS hasn't been read yet (this
77 # means that we need to ensure the `base` module is freshly imported).
78 base = importlib.import_module(storage_base_import_path)
79 old_message_tags = getattr(settings, "MESSAGE_TAGS", None)
80 settings.MESSAGE_TAGS = {constants.ERROR: "bad"}
81 try:
82 self.assertEqual(base.LEVEL_TAGS[constants.ERROR], "bad")
83 finally:
84 if old_message_tags is None:
85 del settings.MESSAGE_TAGS
86 else:
87 settings.MESSAGE_TAGS = old_message_tags
88
89 @override_settings(MESSAGE_TAGS=message_tags)
90 def test_override_settings_lazy(self):
91 # The update_level_tags handler has been called at least once before
92 # running this code when using @override_settings.
93 settings.MESSAGE_TAGS = {constants.ERROR: "very-bad"}
94 self.assertEqual(base.LEVEL_TAGS[constants.ERROR], "very-bad")
95
96
97 class FakeResponse:
98 def __init__(self):
99 request = RequestFactory().get("/")
100 request._messages = DummyStorage()
101 self.wsgi_request = request
102
103
104 class AssertMessagesTest(MessagesTestMixin, SimpleTestCase):
105 def test_assertion(self):
106 response = FakeResponse()
107 add_message(response.wsgi_request, constants.DEBUG, "DEBUG message.")
108 add_message(response.wsgi_request, constants.INFO, "INFO message.")
109 add_message(response.wsgi_request, constants.SUCCESS, "SUCCESS message.")
110 add_message(response.wsgi_request, constants.WARNING, "WARNING message.")
111 add_message(response.wsgi_request, constants.ERROR, "ERROR message.")
112 self.assertMessages(
113 response,
114 [
115 Message(constants.DEBUG, "DEBUG message."),
116 Message(constants.INFO, "INFO message."),
117 Message(constants.SUCCESS, "SUCCESS message."),
118 Message(constants.WARNING, "WARNING message."),
119 Message(constants.ERROR, "ERROR message."),
120 ],
121 )
122
123 def test_with_tags(self):
124 response = FakeResponse()
125 add_message(
126 response.wsgi_request,
127 constants.INFO,
128 "INFO message.",
129 extra_tags="extra-info",
130 )
131 add_message(
132 response.wsgi_request,
133 constants.SUCCESS,
134 "SUCCESS message.",
135 extra_tags="extra-success",
136 )
137 add_message(
138 response.wsgi_request,
139 constants.WARNING,
140 "WARNING message.",
141 extra_tags="extra-warning",
142 )
143 add_message(
144 response.wsgi_request,
145 constants.ERROR,
146 "ERROR message.",
147 extra_tags="extra-error",
148 )
149 self.assertMessages(
150 response,
151 [
152 Message(constants.INFO, "INFO message.", "extra-info"),
153 Message(constants.SUCCESS, "SUCCESS message.", "extra-success"),
154 Message(constants.WARNING, "WARNING message.", "extra-warning"),
155 Message(constants.ERROR, "ERROR message.", "extra-error"),
156 ],
157 )
158
159 @override_settings(MESSAGE_TAGS={42: "CUSTOM"})
160 def test_custom_levelname(self):
161 response = FakeResponse()
162 add_message(response.wsgi_request, 42, "CUSTOM message.")
163 self.assertMessages(response, [Message(42, "CUSTOM message.")])
164
165 def test_ordered(self):
166 response = FakeResponse()
167 add_message(response.wsgi_request, constants.INFO, "First message.")
168 add_message(response.wsgi_request, constants.WARNING, "Second message.")
169 expected_messages = [
170 Message(constants.WARNING, "Second message."),
171 Message(constants.INFO, "First message."),
172 ]
173 self.assertMessages(response, expected_messages, ordered=False)
174 with self.assertRaisesMessage(AssertionError, "Lists differ: "):
175 self.assertMessages(response, expected_messages)
176
177 def test_mismatching_length(self):
178 response = FakeResponse()
179 add_message(response.wsgi_request, constants.INFO, "INFO message.")
180 msg = (
181 "Lists differ: [Message(level=20, message='INFO message.')] != []\n\n"
182 "First list contains 1 additional elements.\n"
183 "First extra element 0:\n"
184 "Message(level=20, message='INFO message.')\n\n"
185 "- [Message(level=20, message='INFO message.')]\n"
186 "+ []"
187 )
188 with self.assertRaisesMessage(AssertionError, msg):
189 self.assertMessages(response, [])
190
191 def test_method_frames_ignored_by_unittest(self):
192 response = FakeResponse()
193 try:
194 self.assertMessages(response, [object()])
195 except AssertionError:
196 exc_type, exc, tb = sys.exc_info()
197
198 result = unittest.TestResult()
199 result.addFailure(self, (exc_type, exc, tb))
200 stack = traceback.extract_tb(exc.__traceback__)
201 self.assertEqual(len(stack), 1)
202 # Top element in the stack is this method, not assertMessages.
203 self.assertEqual(stack[-1].name, "test_method_frames_ignored_by_unittest")