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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
# Copyright (C) 2014-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/>.
"""Test list configuration via the REST API."""
__all__ = [
'TestConfiguration',
]
import unittest
from mailman.app.lifecycle import create_list
from mailman.database.transaction import transaction
from mailman.interfaces.mailinglist import (
IAcceptableAliasSet, SubscriptionPolicy)
from mailman.testing.helpers import call_api
from mailman.testing.layers import RESTLayer
from urllib.error import HTTPError
# The representation of the listconf resource as a dictionary. This is used
# when PUTting to the list's configuration resource.
RESOURCE = dict(
acceptable_aliases=[
'ant@example.com',
'bee@example.com',
'cat@example.com',
],
admin_immed_notify=False,
admin_notify_mchanges=True,
administrivia=False,
advertised=False,
anonymous_list=True,
archive_policy='never',
autorespond_owner='respond_and_discard',
autorespond_postings='respond_and_continue',
autorespond_requests='respond_and_discard',
autoresponse_grace_period='45d',
autoresponse_owner_text='the owner',
autoresponse_postings_text='the mailing list',
autoresponse_request_text='the robot',
display_name='Fnords',
description='This is my mailing list',
include_rfc2369_headers=False,
allow_list_posts=False,
#digest_send_periodic='yes',
digest_size_threshold=10.5,
#digest_volume_frequency=1,
posting_pipeline='virgin',
filter_content=True,
first_strip_reply_to=True,
convert_html_to_plaintext=True,
collapse_alternatives=False,
reply_goes_to_list='point_to_list',
reply_to_address='bee@example.com',
send_welcome_message=False,
subject_prefix='[ant]',
subscription_policy='confirm_then_moderate',
welcome_message_uri='mailman:///welcome.txt',
default_member_action='hold',
default_nonmember_action='discard',
)
class TestConfiguration(unittest.TestCase):
"""Test list configuration via the REST API."""
layer = RESTLayer
def setUp(self):
with transaction():
self._mlist = create_list('ant@example.com')
def test_get_missing_attribute(self):
with self.assertRaises(HTTPError) as cm:
call_api(
'http://localhost:9001/3.0/lists/ant.example.com/config/bogus')
self.assertEqual(cm.exception.code, 404)
self.assertEqual(cm.exception.reason, b'Unknown attribute: bogus')
def test_put_configuration(self):
# When using PUT, all writable attributes must be included.
resource, response = call_api(
'http://localhost:9001/3.0/lists/ant.example.com/config',
RESOURCE,
'PUT')
self.assertEqual(response.status, 204)
self.assertEqual(self._mlist.display_name, 'Fnords')
# All three acceptable aliases were set.
self.assertEqual(set(IAcceptableAliasSet(self._mlist).aliases),
set(RESOURCE['acceptable_aliases']))
def test_put_attribute(self):
resource, response = call_api(
'http://localhost:9001/3.0/lists/ant.example.com'
'/config/reply_to_address')
self.assertEqual(resource['reply_to_address'], '')
resource, response = call_api(
'http://localhost:9001/3.0/lists/ant.example.com'
'/config/reply_to_address',
dict(reply_to_address='bar@ant.example.com'),
'PUT')
self.assertEqual(response.status, 204)
resource, response = call_api(
'http://localhost:9001/3.0/lists/ant.example.com'
'/config/reply_to_address')
self.assertEqual(resource['reply_to_address'], 'bar@ant.example.com')
def test_put_extra_attribute(self):
bogus_resource = RESOURCE.copy()
bogus_resource['bogus'] = 'yes'
with self.assertRaises(HTTPError) as cm:
call_api(
'http://localhost:9001/3.0/lists/ant.example.com/config',
bogus_resource,
'PUT')
self.assertEqual(cm.exception.code, 400)
self.assertEqual(cm.exception.reason, b'Unexpected parameters: bogus')
def test_put_attribute_mismatch(self):
resource, response = call_api(
'http://localhost:9001/3.0/lists/ant.example.com'
'/config/reply_to_address')
self.assertEqual(resource['reply_to_address'], '')
with self.assertRaises(HTTPError) as cm:
resource, response = call_api(
'http://localhost:9001/3.0/lists/ant.example.com'
'/config/reply_to_address',
dict(display_name='bar@ant.example.com'),
'PUT')
self.assertEqual(cm.exception.code, 400)
self.assertEqual(cm.exception.reason,
b'Unexpected parameters: display_name')
def test_put_attribute_double(self):
with self.assertRaises(HTTPError) as cm:
resource, response = call_api(
'http://localhost:9001/3.0/lists/ant.example.com'
'/config/reply_to_address',
dict(display_name='bar@ant.example.com',
reply_to_address='foo@example.com'),
'PUT')
self.assertEqual(cm.exception.code, 400)
self.assertEqual(cm.exception.reason,
b'Unexpected parameters: display_name')
def test_put_read_only_attribute(self):
with self.assertRaises(HTTPError) as cm:
call_api('http://localhost:9001/3.0/lists/ant.example.com'
'/config/mail_host',
dict(mail_host='foo.example.com'),
'PUT')
self.assertEqual(cm.exception.code, 400)
self.assertEqual(cm.exception.reason,
b'Read-only attribute: mail_host')
def test_put_missing_attribute(self):
with self.assertRaises(HTTPError) as cm:
call_api(
'http://localhost:9001/3.0/lists/ant.example.com/config/bogus',
dict(bogus='no matter'),
'PUT')
self.assertEqual(cm.exception.code, 404)
self.assertEqual(cm.exception.reason, b'Unknown attribute: bogus')
def test_patch_subscription_policy(self):
# The new subscription_policy value can be patched.
#
# To start with, the subscription policy is confirm by default.
resource, response = call_api(
'http://localhost:9001/3.0/lists/ant.example.com/config')
self.assertEqual(resource['subscription_policy'], 'confirm')
# Let's patch it to do some moderation.
resource, response = call_api(
'http://localhost:9001/3.0/lists/ant.example.com/config', dict(
subscription_policy='confirm_then_moderate'),
method='PATCH')
self.assertEqual(response.status, 204)
# And now we verify that it has the requested setting.
self.assertEqual(self._mlist.subscription_policy,
SubscriptionPolicy.confirm_then_moderate)
def test_patch_attribute_double(self):
with self.assertRaises(HTTPError) as cm:
resource, response = call_api(
'http://localhost:9001/3.0/lists/ant.example.com'
'/config/reply_to_address',
dict(display_name='bar@ant.example.com',
reply_to_address='foo'),
'PATCH')
self.assertEqual(cm.exception.code, 400)
self.assertEqual(cm.exception.reason, b'Expected 1 attribute, got 2')
def test_unknown_patch_attribute(self):
with self.assertRaises(HTTPError) as cm:
call_api('http://localhost:9001/3.0/lists/ant.example.com/config',
dict(bogus=1),
'PATCH')
self.assertEqual(cm.exception.code, 400)
self.assertEqual(cm.exception.reason, b'Unknown attribute: bogus')
def test_read_only_patch_attribute(self):
with self.assertRaises(HTTPError) as cm:
call_api('http://localhost:9001/3.0/lists/ant.example.com'
'/config/mail_host',
dict(mail_host='foo.example.com'),
'PATCH')
self.assertEqual(cm.exception.code, 400)
self.assertEqual(cm.exception.reason,
b'Read-only attribute: mail_host')
def test_patch_missing_attribute(self):
with self.assertRaises(HTTPError) as cm:
call_api(
'http://localhost:9001/3.0/lists/ant.example.com/config/bogus',
dict(bogus='no matter'),
'PATCH')
self.assertEqual(cm.exception.code, 404)
self.assertEqual(cm.exception.reason, b'Unknown attribute: bogus')
def test_patch_bad_value(self):
with self.assertRaises(HTTPError) as cm:
call_api(
'http://localhost:9001/3.0/lists/ant.example.com/config'
'/archive_policy',
dict(archive_policy='not a valid archive policy'),
'PATCH')
self.assertEqual(cm.exception.code, 400)
self.assertEqual(cm.exception.reason,
b'Cannot convert parameters: archive_policy')
def test_bad_pipeline_name(self):
with self.assertRaises(HTTPError) as cm:
call_api(
'http://localhost:9001/3.0/lists/ant.example.com/config'
'/posting_pipeline',
dict(posting_pipeline='not a valid pipeline'),
'PATCH')
self.assertEqual(cm.exception.code, 400)
self.assertEqual(cm.exception.reason,
b'Cannot convert parameters: posting_pipeline')
|
