Debian Codegraph @

django_mailman3/tests/test_mailman.py

raw
1 # -*- coding: utf-8 -*-
2 #
3 # Copyright (C) 2016-2023 by the Free Software Foundation, Inc.
4 #
5 # This file is part of Django-Mailman.
6 #
7 # Django-Mailman is free software: you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by the Free
9 # Software Foundation, either version 3 of the License, or (at your option)
10 # any later version.
11 #
12 # Django-Mailman is distributed in the hope that it will be useful, but WITHOUT
13 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 # more details.
16 #
17 # You should have received a copy of the GNU General Public License along with
18 # Django-Mailman. If not, see <http://www.gnu.org/licenses/>.
19 #
20 # Author: Aurelien Bompard <[email protected]>
21 #
22
23 from unittest import skip
24 from unittest.mock import Mock, call, patch
25 from urllib.error import HTTPError
26
27 from django.contrib.auth.models import User
28 from django.core.cache import cache
29 from django.db import IntegrityError
30 from django.test import override_settings
31
32 from allauth.account.models import EmailAddress
33
34 from django_mailman3.lib import mailman
35 from django_mailman3.tests.utils import (
36 FakeMMAddress, FakeMMAddressList, FakeMMList, FakeMMMember, TestCase)
37
38
39 class GetMailmanUserTestCase(TestCase):
40
41 def setUp(self):
42 self.user = User.objects.create_user(
43 'testuser', '[email protected]', 'testPass')
44 self.mm_user = Mock()
45 self.mm_user.user_id = "dummy"
46 self.mm_user.addresses = [Mock()]
47 self.mailman_client.get_user.side_effect = lambda e: self.mm_user
48
49 def test_get_user(self):
50 mm_user = mailman.get_mailman_user(self.user)
51 self.assertIs(mm_user, self.mm_user)
52
53 @patch('django_mailman3.lib.mailman.get_mailman_user',
54 return_value=None)
55 def test_get_nonexistent_user(self, mock_method):
56 # Test create user fails and get_mailman_user returns None.
57 mm_user = mailman.get_mailman_user(self.mm_user)
58 self.assertIsNone(mm_user)
59 mock_method.assert_called_with(self.mm_user)
60
61 def test_create_user(self):
62 self.mailman_client.get_user.side_effect = \
63 HTTPError(None, 404, None, None, None)
64 new_mm_user = Mock()
65 new_mm_user.user_id = "dummy2"
66 self.mailman_client.create_user.side_effect = lambda e, n: new_mm_user
67 mm_user = mailman.get_mailman_user(self.user)
68 self.assertEqual(
69 self.mailman_client.create_user.call_args_list,
70 [call(self.user.email, self.user.get_full_name())])
71 self.assertIs(mm_user, new_mm_user)
72
73 def test_connection_failed(self):
74 self.mailman_client.get_user.side_effect = \
75 HTTPError(None, 500, None, None, None)
76 with patch('django_mailman3.lib.mailman.logger') as mock_logging:
77 mm_user = mailman.get_mailman_user(self.user)
78 # Make sure that the returned user is None.
79 self.assertIsNone(mm_user)
80 # Make sure the failure is logged.
81 mock_logging.warning.assert_called()
82
83 def test_get_user_id(self):
84 mm_user_id = mailman.get_mailman_user_id(self.user)
85 self.assertEqual(mm_user_id, "dummy")
86
87 def test_bad_cached_user_id(self):
88 # Test that we lookup a user via email if the cached user_id is invalid
89 # and doesn't return a valid user.
90 new_mm_user = Mock()
91 new_mm_user.user_id = "dummy3"
92
93 def side_effect(user_id):
94 if user_id == '4':
95 raise HTTPError(
96 url='', code=404, msg='No user with id 4',
97 hdrs=None, fp=None)
98 elif user_id == '[email protected]':
99 return new_mm_user
100 return None
101
102 self.mailman_client.get_user.side_effect = side_effect
103 # Now, also set integer user_id 4 in the cache.
104 cache.set("User:{0}:mailman_user_id".format(self.user.id), '4', None)
105
106 mm_user = mailman.get_mailman_user(self.user)
107 self.assertIsNotNone(mm_user)
108 self.assertEqual(mm_user, new_mm_user)
109
110 expected = [call('4'), call('[email protected]')]
111 self.mailman_client.get_user.call_args_list == expected
112
113
114 class AddUserToMailmanTestCase(TestCase):
115
116 def setUp(self):
117 self.ml = FakeMMList("[email protected]")
118 self.mailman_client.get_list.side_effect = lambda n: self.ml
119 self.ml.get_member = Mock()
120 self.ml.subscribe = Mock()
121 self.user = User.objects.create_user(
122 'testuser', '[email protected]', 'testPass')
123 self.mm_user = Mock()
124 self.mm_user.user_id = "dummy"
125 self.mm_user.addresses = []
126 self.mailman_client.get_user.side_effect = lambda e: self.mm_user
127 self.mm_addresses = {}
128
129 def _get_or_add_address(self, email, **kw):
130 try:
131 mm_addr = self.mm_addresses[email]
132 except KeyError:
133 mm_addr = Mock()
134 mm_addr.email = email
135 mm_addr.verified_on = None
136 self.mm_addresses[email] = mm_addr
137 return mm_addr
138
139 def test_primary_address_unverified(self):
140 self.mailman_client.get_address.side_effect = self._get_or_add_address
141 self.mm_user.addresses = ["[email protected]"]
142 mailman.add_address_to_mailman_user(self.user, "[email protected]")
143 self.mm_addresses['[email protected]'].verify.assert_called_with()
144 self.assertFalse(self.mm_user.add_address.called)
145
146 def test_addresses_verified(self):
147 self.mm_user.add_address.side_effect = self._get_or_add_address
148 mailman.add_address_to_mailman_user(self.user, "[email protected]")
149 self.mm_user.add_address.assert_called_with(
150 "[email protected]", absorb_existing=True)
151 self.mm_addresses['[email protected]'].verify.assert_called_with()
152
153 def test_existing_address_but_not_verified(self):
154 # The secondary address exists but is not verified
155 self.mailman_client.get_address.side_effect = self._get_or_add_address
156 secondary_address = Mock()
157 secondary_address.email = "[email protected]"
158 secondary_address.verified_on = None
159 secondary_address.__str__ = lambda self: self.email
160 self.mm_user.addresses.append(secondary_address)
161 self.mm_addresses["[email protected]"] = secondary_address
162 mailman.add_address_to_mailman_user(self.user, "[email protected]")
163 # The secondary address must only have been verified.
164 self.assertFalse(self.mm_user.add_address.called)
165 secondary_address.verify.assert_called_with()
166
167 @patch('django_mailman3.lib.mailman.logger')
168 def test_add_new_address(self, mock_log):
169 secondary_address = Mock()
170 secondary_address.email = "[email protected]"
171 with patch('django_mailman3.lib.mailman.get_mailman_user',
172 return_value=None):
173 # If the user does not exist, function return and logs the result.
174 mailman.add_address_to_mailman_user(self.user, secondary_address)
175 mock_log.info.assert_called()
176
177
178 class SyncEmailAddressesTestCase(TestCase):
179
180 def setUp(self):
181 self.user = User.objects.create_user(
182 'testuser', '[email protected]', 'testPass')
183 EmailAddress.objects.create(
184 user=self.user, email=self.user.email, verified=True)
185 self.mm_user = Mock()
186 self.mm_user.user_id = "dummy"
187 self.mm_user.addresses = FakeMMAddressList()
188 self.mailman_client.get_user.side_effect = lambda e: self.mm_user
189
190 def test_sync_django(self):
191 # Addresses in Django are pushed to Mailman, verified bits are synced.
192 EmailAddress.objects.create(
193 user=self.user, email='[email protected]', verified=True)
194 not_verified = FakeMMAddress('[email protected]', verified=False)
195 self.mm_user.addresses.append(not_verified)
196 mailman.sync_email_addresses(self.user)
197 # The missing address must have been added
198 self.assertEqual(
199 self.mm_user.add_address.call_args_list,
200 [call('[email protected]', absorb_existing=True)])
201 # The unverified address must have been set verified
202 self.assertTrue(not_verified.verified)
203
204 def test_sync_mailman(self):
205 # Addresses in Mailman are pushed to Django, verified bits are synced.
206 self.mm_user.addresses.extend([
207 FakeMMAddress('[email protected]', verified=True),
208 FakeMMAddress('[email protected]', verified=False),
209 FakeMMAddress('[email protected]', verified=True),
210 ])
211 EmailAddress.objects.create(
212 user=self.user, email='[email protected]', verified=False)
213 mailman.sync_email_addresses(self.user)
214 self.assertEqual(
215 list(EmailAddress.objects.filter(
216 user=self.user, verified=True).order_by("email").values_list(
217 "email", flat=True)),
218 ['[email protected]', self.user.email,
219 '[email protected]'])
220
221 @skip('Why is this failing?')
222 def test_user_conflict(self):
223 # A user with two email addresses in Mailman is split in two Django
224 # users.
225 user2 = User.objects.create_user(
226 'testuser2', '[email protected]', 'testPass')
227 EmailAddress.objects.create(
228 user=user2, email=user2.email, verified=True)
229 self.mm_user.addresses.extend([
230 FakeMMAddress('[email protected]', verified=True),
231 FakeMMAddress('[email protected]', verified=True),
232 ])
233 try:
234 mailman.sync_email_addresses(self.user)
235 except IntegrityError as e:
236 self.fail(e)
237 self.assertEqual(
238 list(EmailAddress.objects.filter(
239 user=self.user).values_list("email", flat=True)),
240 [self.user.email])
241 self.assertEqual(
242 list(EmailAddress.objects.filter(
243 user=user2).values_list("email", flat=True)),
244 [user2.email])
245
246
247 class GetSubscriptionsTestCase(TestCase):
248
249 def setUp(self):
250 self.user = User.objects.create_user(
251 'testuser', '[email protected]', 'testPass')
252 EmailAddress.objects.create(
253 user=self.user, email=self.user.email, verified=True)
254 self.mm_user = Mock()
255 self.mm_user.user_id = "dummy"
256 self.mm_user.addresses = FakeMMAddressList()
257 self.mailman_client.get_user.side_effect = lambda e: self.mm_user
258
259 def test_get_subscriptions(self):
260 fake_member = FakeMMMember("list.example.com", "[email protected]")
261 self.mm_user.subscriptions = [fake_member]
262 self.assertEqual(
263 mailman.get_subscriptions(self.user),
264 {"list.example.com": "[email protected]"})
265
266 def test_get_subscriptions_no_user(self):
267 with patch('django_mailman3.lib.mailman.get_mailman_user') as gmu:
268 gmu.return_value = None
269 self.assertEqual(mailman.get_subscriptions(self.user), {})
270
271 def test_get_subscriptions_nonmember(self):
272 fake_member = FakeMMMember(
273 "list.example.com", "[email protected]", role="nonmember")
274 self.mm_user.subscriptions = [fake_member]
275 self.assertEqual(mailman.get_subscriptions(self.user), {})
276
277
278 class UpdatePreferredAddressTestCase(TestCase):
279
280 def setUp(self):
281 self.user = User.objects.create_user(
282 'testuser', '[email protected]', 'testPass')
283 EmailAddress.objects.create(
284 user=self.user, email=self.user.email, verified=True)
285 self.mm_user = Mock()
286 self.mm_user.user_id = "dummy"
287 self.mm_user.addresses = FakeMMAddressList()
288 self.mailman_client.get_user.side_effect = lambda e: self.mm_user
289
290 def test_update_preferred_address_updates_mailman(self):
291 """Updating preferred address in Django updates Core."""
292 self.mm_user.addresses.extend([
293 FakeMMAddress('[email protected]', verified=False),
294 FakeMMAddress('[email protected]', verified=True),
295 ])
296 email2 = EmailAddress.objects.create(
297 user=self.user, email='[email protected]', verified=False)
298 email2.set_as_primary()
299 mailman.update_preferred_address(self.user, email2)
300 # A non-verified address should never set the preferred address.
301 self.assertNotEqual(
302 self.mm_user.preferred_address, '[email protected]')
303 email3 = EmailAddress.objects.create(
304 user=self.user, email='[email protected]', verified=True)
305 email3.set_as_primary()
306 mailman.update_preferred_address(self.user, email3)
307 self.assertEqual(
308 self.mm_user.preferred_address, '[email protected]')
309
310 def test_update_preferred_address_adds_address(self):
311 """Setting a preferred address which isn't already created in Core."""
312 # Test that we can set an address which isn't already associated with
313 # the user in Mailman Core.
314 email4 = EmailAddress.objects.create(
315 user=self.user, email='[email protected]', verified=True)
316 email4.set_as_primary()
317 mailman.update_preferred_address(self.user, email4)
318 self.assertEqual(
319 self.mm_user.preferred_address, '[email protected]')
320 self.mm_user.add_address.assert_called_once_with(
321 '[email protected]', absorb_existing=True)
322
323
324 class TestGetMailmanclient(TestCase):
325
326 @override_settings(DEBUG=True)
327 def test_get_mailman_client_hooks(self):
328
329 @mailman.mailmanclient_request_hook
330 def hook(params):
331 return params
332
333 # When not in debug mode, the hooks aren't added to Client.
334 self.assertTrue(hook in mailman.get_request_hooks())
335 self.assertEqual(len(mailman.get_request_hooks()), 1)