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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
|
# Copyright (C) 2011-2014 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/>.
"""REST list tests."""
from __future__ import absolute_import, print_function, unicode_literals
__metaclass__ = type
__all__ = [
'TestListArchivers',
'TestListPagination',
'TestLists',
'TestListsMissing',
]
import unittest
from urllib2 import HTTPError
from zope.component import getUtility
from mailman.app.lifecycle import create_list
from mailman.database.transaction import transaction
from mailman.interfaces.usermanager import IUserManager
from mailman.testing.helpers import call_api
from mailman.testing.layers import RESTLayer
class TestListsMissing(unittest.TestCase):
"""Test expected failures."""
layer = RESTLayer
def test_missing_list_roster_member_404(self):
# /lists/<missing>/roster/member gives 404
with self.assertRaises(HTTPError) as cm:
call_api('http://localhost:9001/3.0/lists/missing@example.com'
'/roster/member')
self.assertEqual(cm.exception.code, 404)
def test_missing_list_roster_owner_404(self):
# /lists/<missing>/roster/owner gives 404
with self.assertRaises(HTTPError) as cm:
call_api('http://localhost:9001/3.0/lists/missing@example.com'
'/roster/owner')
self.assertEqual(cm.exception.code, 404)
def test_missing_list_roster_moderator_404(self):
# /lists/<missing>/roster/member gives 404
with self.assertRaises(HTTPError) as cm:
call_api('http://localhost:9001/3.0/lists/missing@example.com'
'/roster/moderator')
self.assertEqual(cm.exception.code, 404)
def test_missing_list_configuration_404(self):
# /lists/<missing>/config gives 404
with self.assertRaises(HTTPError) as cm:
call_api(
'http://localhost:9001/3.0/lists/missing@example.com/config')
self.assertEqual(cm.exception.code, 404)
class TestLists(unittest.TestCase):
"""Test various aspects of mailing list resources."""
layer = RESTLayer
def setUp(self):
with transaction():
self._mlist = create_list('test@example.com')
self._usermanager = getUtility(IUserManager)
def test_member_count_with_no_members(self):
# The list initially has 0 members.
resource, response = call_api(
'http://localhost:9001/3.0/lists/test@example.com')
self.assertEqual(response.status, 200)
self.assertEqual(resource['member_count'], 0)
def test_member_count_with_one_member(self):
# Add a member to a list and check that the resource reflects this.
with transaction():
anne = self._usermanager.create_address('anne@example.com')
self._mlist.subscribe(anne)
resource, response = call_api(
'http://localhost:9001/3.0/lists/test@example.com')
self.assertEqual(response.status, 200)
self.assertEqual(resource['member_count'], 1)
def test_member_count_with_two_members(self):
# Add two members to a list and check that the resource reflects this.
with transaction():
anne = self._usermanager.create_address('anne@example.com')
self._mlist.subscribe(anne)
bart = self._usermanager.create_address('bar@example.com')
self._mlist.subscribe(bart)
resource, response = call_api(
'http://localhost:9001/3.0/lists/test@example.com')
self.assertEqual(response.status, 200)
self.assertEqual(resource['member_count'], 2)
def test_query_for_lists_in_missing_domain(self):
# You cannot ask all the mailing lists in a non-existent domain.
with self.assertRaises(HTTPError) as cm:
call_api('http://localhost:9001/3.0/domains/no.example.org/lists')
self.assertEqual(cm.exception.code, 404)
def test_cannot_create_list_in_missing_domain(self):
# You cannot create a mailing list in a domain that does not exist.
with self.assertRaises(HTTPError) as cm:
call_api('http://localhost:9001/3.0/lists', {
'fqdn_listname': 'ant@no-domain.example.org',
})
self.assertEqual(cm.exception.code, 400)
self.assertEqual(cm.exception.reason,
'Domain does not exist: no-domain.example.org')
def test_cannot_create_duplicate_list(self):
# You cannot create a list that already exists.
call_api('http://localhost:9001/3.0/lists', {
'fqdn_listname': 'ant@example.com',
})
with self.assertRaises(HTTPError) as cm:
call_api('http://localhost:9001/3.0/lists', {
'fqdn_listname': 'ant@example.com',
})
self.assertEqual(cm.exception.code, 400)
self.assertEqual(cm.exception.reason, 'Mailing list exists')
def test_cannot_delete_missing_list(self):
# You cannot delete a list that does not exist.
with self.assertRaises(HTTPError) as cm:
call_api('http://localhost:9001/3.0/lists/bee.example.com',
method='DELETE')
self.assertEqual(cm.exception.code, 404)
def test_cannot_delete_already_deleted_list(self):
# You cannot delete a list twice.
call_api('http://localhost:9001/3.0/lists', {
'fqdn_listname': 'ant@example.com',
})
call_api('http://localhost:9001/3.0/lists/ant.example.com',
method='DELETE')
with self.assertRaises(HTTPError) as cm:
call_api('http://localhost:9001/3.0/lists/ant.example.com',
method='DELETE')
self.assertEqual(cm.exception.code, 404)
def test_roster(self):
# Lists have rosters which can be accessed by role.
with transaction():
anne = self._usermanager.create_address('anne@example.com')
bart = self._usermanager.create_address('bart@example.com')
self._mlist.subscribe(anne)
self._mlist.subscribe(bart)
resource, response = call_api(
'http://localhost:9001/3.0/lists/test@example.com/roster/member')
self.assertEqual(resource['start'], 0)
self.assertEqual(resource['total_size'], 2)
member = resource['entries'][0]
self.assertEqual(member['email'], 'anne@example.com')
self.assertEqual(member['role'], 'member')
member = resource['entries'][1]
self.assertEqual(member['email'], 'bart@example.com')
self.assertEqual(member['role'], 'member')
class TestListArchivers(unittest.TestCase):
"""Test corner cases for list archivers."""
layer = RESTLayer
def setUp(self):
with transaction():
self._mlist = create_list('ant@example.com')
def test_archiver_statuses(self):
resource, response = call_api(
'http://localhost:9001/3.0/lists/ant.example.com/archivers')
self.assertEqual(response.status, 200)
# Remove the variable data.
resource.pop('http_etag')
self.assertEqual(resource, {
'mail-archive': True,
'mhonarc': True,
'prototype': True,
})
def test_archiver_statuses_on_missing_lists(self):
# You cannot get the archiver statuses on a list that doesn't exist.
with self.assertRaises(HTTPError) as cm:
call_api(
'http://localhost:9001/3.0/lists/bee.example.com/archivers')
self.assertEqual(cm.exception.code, 404)
def test_patch_status_on_bogus_archiver(self):
# You cannot set the status on an archiver the list doesn't know about.
with self.assertRaises(HTTPError) as cm:
call_api(
'http://localhost:9001/3.0/lists/ant.example.com/archivers', {
'bogus-archiver': True,
},
method='PATCH')
self.assertEqual(cm.exception.code, 400)
self.assertEqual(cm.exception.reason,
'Unexpected parameters: bogus-archiver')
def test_put_incomplete_statuses(self):
# PUT requires the full resource representation. This one forgets to
# specify the prototype and mhonarc archiver.
with self.assertRaises(HTTPError) as cm:
call_api(
'http://localhost:9001/3.0/lists/ant.example.com/archivers', {
'mail-archive': True,
},
method='PUT')
self.assertEqual(cm.exception.code, 400)
self.assertEqual(cm.exception.reason,
'Missing parameters: mhonarc, prototype')
def test_patch_bogus_status(self):
# Archiver statuses must be interpretable as booleans.
with self.assertRaises(HTTPError) as cm:
call_api(
'http://localhost:9001/3.0/lists/ant.example.com/archivers', {
'mail-archive': 'sure',
'mhonarc': False,
'prototype': 'no'
},
method='PATCH')
self.assertEqual(cm.exception.code, 400)
self.assertEqual(cm.exception.reason, 'Invalid boolean value: sure')
class TestListPagination(unittest.TestCase):
"""Test mailing list pagination functionality.
We create a bunch of mailing lists within a domain. When we want to
get all the lists in that domain via the REST API, we need to
paginate over them, otherwise there could be too many for display.
"""
layer = RESTLayer
def setUp(self):
with transaction():
# Create a bunch of mailing lists in the example.com domain.
create_list('ant@example.com')
create_list('bee@example.com')
create_list('cat@example.com')
create_list('dog@example.com')
create_list('emu@example.com')
create_list('fly@example.com')
def test_first_page(self):
resource, response = call_api(
'http://localhost:9001/3.0/domains/example.com/lists'
'?count=1&page=1')
# There are 6 total lists, but only the first one in the page.
self.assertEqual(resource['total_size'], 1)
self.assertEqual(resource['start'], 0)
self.assertEqual(len(resource['entries']), 1)
entry = resource['entries'][0]
self.assertEqual(entry['fqdn_listname'], 'ant@example.com')
def test_second_page(self):
resource, response = call_api(
'http://localhost:9001/3.0/domains/example.com/lists'
'?count=1&page=2')
# There are 6 total lists, but only the first one in the page.
self.assertEqual(resource['total_size'], 1)
self.assertEqual(resource['start'], 0)
self.assertEqual(len(resource['entries']), 1)
entry = resource['entries'][0]
self.assertEqual(entry['fqdn_listname'], 'bee@example.com')
def test_last_page(self):
resource, response = call_api(
'http://localhost:9001/3.0/domains/example.com/lists'
'?count=1&page=6')
# There are 6 total lists, but only the first one in the page.
self.assertEqual(resource['total_size'], 1)
self.assertEqual(resource['start'], 0)
self.assertEqual(len(resource['entries']), 1)
entry = resource['entries'][0]
self.assertEqual(entry['fqdn_listname'], 'fly@example.com')
def test_zeroth_page(self):
# Page numbers start at one.
with self.assertRaises(HTTPError) as cm:
resource, response = call_api(
'http://localhost:9001/3.0/domains/example.com/lists'
'?count=1&page=0')
self.assertEqual(cm.exception.code, 400)
def test_negative_page(self):
# Negative pages are not allowed.
with self.assertRaises(HTTPError) as cm:
resource, response = call_api(
'http://localhost:9001/3.0/domains/example.com/lists'
'?count=1&page=-1')
self.assertEqual(cm.exception.code, 400)
def test_past_last_page(self):
# The 7th page doesn't exist so the collection is empty.
resource, response = call_api(
'http://localhost:9001/3.0/domains/example.com/lists'
'?count=1&page=7')
# There are 6 total lists, but only the first one in the page.
self.assertEqual(resource['total_size'], 0)
self.assertEqual(resource['start'], 0)
self.assertNotIn('entries', resource)
|
