1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
# Copyright (C) 2011-2015 by the Free Software Foundation, Inc.
#
# This file is part of GNU Mailman.
#
# GNU Mailman is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option)
# any later version.
#
# GNU Mailman is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
# more details.
#
# You should have received a copy of the GNU General Public License along with
# GNU Mailman. If not, see <http://www.gnu.org/licenses/>.
"""Tests for the subscription service."""
__all__ = [
'TestJoin',
'TestSubscriptionWorkflow',
]
import uuid
import unittest
from mailman.app.lifecycle import create_list
from mailman.app.subscriptions import SubscriptionWorkflow
from mailman.interfaces.address import InvalidEmailAddressError
from mailman.interfaces.member import MemberRole, MissingPreferredAddressError
from mailman.interfaces.requests import IListRequests, RequestType
from mailman.interfaces.subscriptions import (
MissingUserError, ISubscriptionService)
from mailman.testing.layers import ConfigLayer
from mailman.interfaces.mailinglist import SubscriptionPolicy
from mailman.interfaces.usermanager import IUserManager
from mailman.utilities.datetime import now
from zope.component import getUtility
class TestJoin(unittest.TestCase):
layer = ConfigLayer
def setUp(self):
self._mlist = create_list('test@example.com')
self._service = getUtility(ISubscriptionService)
def test_join_user_with_bogus_id(self):
# When `subscriber` is a missing user id, an exception is raised.
with self.assertRaises(MissingUserError) as cm:
self._service.join('test.example.com', uuid.UUID(int=99))
self.assertEqual(cm.exception.user_id, uuid.UUID(int=99))
def test_join_user_with_invalid_email_address(self):
# When `subscriber` is a string that is not an email address, an
# exception is raised.
with self.assertRaises(InvalidEmailAddressError) as cm:
self._service.join('test.example.com', 'bogus')
self.assertEqual(cm.exception.email, 'bogus')
def test_missing_preferred_address(self):
# A user cannot join a mailing list if they have no preferred address.
anne = self._service.join(
'test.example.com', 'anne@example.com', 'Anne Person')
# Try to join Anne as a user with a different role. Her user has no
# preferred address, so this will fail.
self.assertRaises(MissingPreferredAddressError,
self._service.join,
'test.example.com', anne.user.user_id,
role=MemberRole.owner)
class TestSubscriptionWorkflow(unittest.TestCase):
layer = ConfigLayer
def setUp(self):
self._mlist = create_list('test@example.com')
self._anne = 'anne@example.com'
self._user_manager = getUtility(IUserManager)
def test_save_restore(self):
anne = self._user_manager.create_address(self._anne, 'Anne Person')
workflow = SubscriptionWorkflow(
self._mlist, anne,
pre_verified=True, pre_confirmed=False, pre_approved=False)
next(workflow)
next_step = workflow._next[0]
workflow.save_state()
# Now create a new instance and restore
workflow = SubscriptionWorkflow(
self._mlist, anne,
pre_verified=None, pre_confirmed=None, pre_approved=None)
workflow.restore_state()
self.assertEqual(next_step, workflow._next[0])
self.assertEqual(workflow.pre_verified, True)
self.assertEqual(workflow.pre_confirmed, False)
self.assertEqual(workflow.pre_approved, False)
def test_save_restore_no_next_step(self):
anne = self._user_manager.create_address(self._anne, 'Anne Person')
workflow = SubscriptionWorkflow(
self._mlist, anne,
pre_verified=True, pre_confirmed=False, pre_approved=False)
workflow._next.pop()
self.assertEqual(len(workflow._next), 0)
workflow.save_state()
# Now create a new instance and restore
workflow = SubscriptionWorkflow(
self._mlist, anne,
pre_verified=None, pre_confirmed=None, pre_approved=None)
workflow.restore_state()
self.assertEqual(len(workflow._next), 0)
def test_preverified_address_joins_open_list(self):
# The mailing list has an open subscription policy, so the subscriber
# becomes a member with no human intervention.
self._mlist.subscription_policy = SubscriptionPolicy.open
anne = self._user_manager.create_address(self._anne, 'Anne Person')
self.assertIsNone(anne.verified_on)
self.assertIsNone(anne.user)
self.assertIsNone(self._mlist.subscribers.get_member(self._anne))
workflow = SubscriptionWorkflow(
self._mlist, anne,
pre_verified=True, pre_confirmed=False, pre_approved=False)
# Run the state machine to the end. The result is that her address
# will be verified, linked to a user, and subscribed to the mailing
# list.
list(workflow)
self.assertIsNotNone(anne.verified_on)
self.assertIsNotNone(anne.user)
self.assertIsNotNone(self._mlist.subscribers.get_member(self._anne))
def test_verified_address_joins_moderated_list(self):
# The mailing list is moderated but the subscriber is not a verified
# address and the subscription request is not pre-verified.
# A confirmation email must be sent, it will serve as the verification
# email too.
anne = self._user_manager.create_address(self._anne, 'Anne Person')
request_db = IListRequests(self._mlist)
def _do_check():
anne.verified_on = now()
self.assertIsNone(self._mlist.subscribers.get_member(self._anne))
workflow = SubscriptionWorkflow(
self._mlist, anne,
pre_verified=False, pre_confirmed=True, pre_approved=False)
# Run the state machine to the end.
list(workflow)
# Look in the requests db
requests = list(request_db.of_type(RequestType.subscription))
self.assertEqual(len(requests), 1)
self.assertEqual(requests[0].key, anne.email)
request_db.delete_request(requests[0].id)
self._mlist.subscription_policy = SubscriptionPolicy.moderate
_do_check()
self._mlist.subscription_policy = SubscriptionPolicy.confirm_then_moderate
_do_check()
|
