« back to all changes in this revision
Viewing changes to grackle/tests/test_client.py
- browse files at revision 16
- compare with another revision
- download diff
- download tarball
- view history from revision 16
- Committer: Aaron Bentley
- Date: 2012-01-11 15:44:02 UTC
- Revision ID: aaron@canonical.com-20120111154402-qi5nk23wwd7czvrj
Include next_memo, previous_memo in get_messages response.
- files removed:
- grackle/error.py
- files modified:
- grackle-put-message
added
removed
grackle/tests/test_client.py
1
__metaclass__ = type
2
3
from email.message import Message
4
from email.mime.multipart import MIMEMultipart
5
from email.mime.text import MIMEText
1
from BaseHTTPServer import (
2
HTTPServer,
3
BaseHTTPRequestHandler,
4
)
5
import httplib
6
import os
7
from signal import SIGKILL
8
import simplejson
6
9
from StringIO import StringIO
7
10
from unittest import TestCase
11
from urlparse import urlparse
12
from urlparse import parse_qs
8
13
9
14
from testtools import ExpectedException
10
15
11
from grackle.client import GrackleClient
12
from grackle.error import (
13
ArchiveIdExists,
14
UnparsableDateRange,
15
UnsupportedDisplayType,
16
UnsupportedOrder,
16
from grackle.client import (
17
GrackleClient,
17
18
)
18
from grackle.service import ForkedFakeService
19
from grackle.store import make_json_message
20
21
22
def make_message(message_id, body='body', headers=None, hidden=False):
23
if headers is None:
24
headers = {}
25
message_headers = {
26
'Message-Id': message_id,
27
'date': '2005-01-01',
28
'subject': 'subject',
29
'from': 'author',
30
'replies': '',
31
}
32
message_headers.update(headers.items())
33
message = Message()
34
message.set_payload(body)
35
for key, value in message_headers.items():
36
message[key] = value
37
return make_json_message(message_id, message.as_string(), hidden)
38
39
40
def make_mime_message(message_id, body='body', headers=None, hidden=False,
41
attachment_type=None):
42
parts = MIMEMultipart()
43
parts.attach(MIMEText(body))
44
if attachment_type is not None:
45
attachment = Message()
46
attachment.set_payload('attactment data.')
47
attachment['Content-Type'] = attachment_type
48
attachment['Content-Disposition'] = 'attachment; filename="file.ext"'
49
parts.attach(attachment)
50
return make_message(message_id, parts.as_string(), headers, hidden)
51
52
53
class TestPutArchive(TestCase):
54
55
def test_put_archive(self):
56
client = GrackleClient('localhost', 8410)
57
message_archives = {}
58
with ForkedFakeService.from_client(client, message_archives):
59
client.put_archive('arch1')
60
response = client.get_messages('arch1')
61
self.assertEqual(0, len(response['messages']))
62
63
def test_put_archive_existing_archive(self):
64
client = GrackleClient('localhost', 8411)
65
message_archives = {'arch1': []}
66
with ForkedFakeService.from_client(client, message_archives):
67
with ExpectedException(ArchiveIdExists, ''):
68
client.put_archive('arch1')
19
20
21
class ForkedFake:
22
23
def __init__(self, port, messages=None):
24
self.pid = None
25
self.port = port
26
self.messages = messages
27
self.read_end, self.write_end = os.pipe()
28
29
def is_ready(self):
30
os.write(self.write_end, 'asdf')
31
32
def __enter__(self):
33
pid = os.fork()
34
if pid == 0:
35
self.start_server()
36
self.pid = pid
37
os.read(self.read_end, 1)
38
return
39
40
def start_server(self):
41
service = HTTPServer(('', self.port), FakeGrackleRequestHandler)
42
service.messages = self.messages
43
self.is_ready()
44
service.serve_forever()
45
46
def __exit__(self, exc_type, exc_val, traceback):
47
os.kill(self.pid, SIGKILL)
48
49
50
class FakeGrackleRequestHandler(BaseHTTPRequestHandler):
51
52
def do_POST(self):
53
message = self.rfile.read(int(self.headers['content-length']))
54
if message == 'This is a message':
55
self.send_response(httplib.CREATED)
56
self.end_headers()
57
self.wfile.close()
58
else:
59
self.send_error(httplib.BAD_REQUEST)
60
61
def do_GET(self):
62
scheme, netloc, path, params, query_string, fragments = (
63
urlparse(self.path))
64
archive = os.path.split(path)[1]
65
query = parse_qs(query_string)
66
parameters = simplejson.loads(query['parameters'][0])
67
self.send_response(httplib.OK)
68
self.end_headers()
69
messages = [m for m in self.server.messages[archive] if 'message_ids'
70
not in parameters or m['message-id'] in
71
parameters['message_ids']]
72
response = {
73
'messages': messages,
74
'next_memo': None,
75
'previous_memo': None
76
}
77
self.wfile.write(simplejson.dumps(response))
78
79
80
def fake_grackle_service(client, messages=None):
81
if messages is None:
82
messages = {}
83
return ForkedFake(client.port, messages)
69
84
70
85
71
86
class TestPutMessage(TestCase):
72
87
73
88
def test_put_message(self):
74
client = GrackleClient('localhost', 8420)
75
message_archives = {'arch1': []}
76
with ForkedFakeService.from_client(client, message_archives):
77
client.put_message('arch1', 'id1', StringIO('This is a message'))
78
response = client.get_messages('arch1')
79
self.assertEqual(1, len(response['messages']))
80
message = response['messages'][0]
81
self.assertEqual('id1', message['message_id'])
82
83
def test_put_message_without_archive(self):
84
client = GrackleClient('localhost', 8421)
85
message_archives = {'arch1': []}
86
with ForkedFakeService.from_client(client, message_archives):
89
client = GrackleClient('localhost', 8436)
90
with fake_grackle_service(client):
91
client.put_message('arch1', 'asdf', StringIO('This is a message'))
87
92
with ExpectedException(Exception, 'wtf'):
88
client.put_message('no-archive', 'id1', StringIO('message'))
93
client.put_message('arch1', 'asdf',
94
StringIO('This is not a message'))
89
95
90
96
91
97
class TestGetMessages(TestCase):
92
98
93
def assertIDOrder(self, ids, messages):
94
self.assertEqual(ids, [m['message_id'] for m in messages])
95
96
def assertMessageIDs(self, ids, messages):
97
self.assertIDOrder(
98
sorted(ids), sorted(messages, key=lambda m: m['message_id']))
99
100
99
def test_get_messages(self):
101
client = GrackleClient('localhost', 8430)
102
archive = {
103
'baz': [make_message('foo'), make_message('bar')]}
104
with ForkedFakeService.from_client(client, archive):
100
client = GrackleClient('localhost', 8435)
101
with fake_grackle_service(client,
102
{'baz':
103
[{'message-id': 'foo'},
104
{'message-id': 'bar'}]}):
105
105
response = client.get_messages('baz')
106
self.assertEqual(['bar', 'foo'], sorted(m['message_id'] for m in
106
self.assertEqual(['bar', 'foo'], sorted(m['message-id'] for m in
107
107
response['messages']))
108
108
self.assertIs(None, response['next_memo'])
109
109
self.assertIs(None, response['previous_memo'])
110
110
111
111
def test_get_messages_by_id(self):
112
112
client = GrackleClient('localhost', 8437)
113
archive = {
114
'baz': [make_message('foo'), make_message('bar')]}
115
with ForkedFakeService.from_client(client, archive):
113
with fake_grackle_service(client,
114
{'baz':
115
[{'message-id': 'foo'},
116
{'message-id': 'bar'}]}):
116
117
response = client.get_messages('baz', message_ids=['foo'])
117
118
message, = response['messages']
118
self.assertEqual('foo', message['message_id'])
119
120
def test_get_messages_batching(self):
121
client = GrackleClient('localhost', 8438)
122
archive = {'baz': [make_message('foo'), make_message('bar')]}
123
with ForkedFakeService.from_client(client, archive):
124
response = client.get_messages('baz', limit=1)
125
self.assertEqual(1, len(response['messages']))
126
messages = response['messages']
127
response = client.get_messages(
128
'baz', limit=1, memo=response['next_memo'])
129
self.assertEqual(1, len(response['messages']))
130
messages.extend(response['messages'])
131
self.assertMessageIDs(['foo', 'bar'], messages)
132
133
def get_messages_member_order_test(self, key):
134
client = GrackleClient('localhost', 8439)
135
if key == 'author':
136
header_name = 'from'
137
else:
138
header_name = key
139
archive = {
140
'baz': [
141
make_message('foo', headers={header_name: '2011-03-25'}),
142
make_message('bar', headers={header_name: '2011-03-24'}),
143
]}
144
with ForkedFakeService.from_client(client, archive):
145
response = client.get_messages('baz')
146
self.assertIDOrder(['foo', 'bar'], response['messages'])
147
response = client.get_messages('baz', order=key)
148
self.assertIDOrder(['bar', 'foo'], response['messages'])
149
150
def test_get_messages_date_order(self):
151
self.get_messages_member_order_test('date')
152
153
def test_get_messages_author_order(self):
154
self.get_messages_member_order_test('author')
155
156
def test_get_messages_subject_order(self):
157
self.get_messages_member_order_test('subject')
158
159
def test_get_messages_thread_subject_order(self):
160
archive = {
161
'baz': [
162
make_message('bar', headers={'subject': 'y'}),
163
make_message('qux', headers={'subject': 'z'}),
164
make_message('foo', headers={'subject': 'x',
165
'in-reply-to': 'qux'}),
166
]}
167
client = GrackleClient('localhost', 8439)
168
with ForkedFakeService.from_client(client, archive):
169
response = client.get_messages('baz')
170
self.assertIDOrder(['bar', 'qux', 'foo'], response['messages'])
171
response = client.get_messages('baz', order='subject')
172
self.assertIDOrder(['foo', 'bar', 'qux'], response['messages'])
173
response = client.get_messages('baz', order='thread_subject')
174
self.assertIDOrder(['bar', 'qux', 'foo'], response['messages'])
175
176
def test_get_messages_thread_oldest_order(self):
177
client = GrackleClient('localhost', 8439)
178
archive = {
179
'baz': [
180
make_message('bar', headers={'date': 'x'}),
181
make_message('qux', headers={'date': 'z'}),
182
make_message('foo', headers={'date': 'y',
183
'in-reply-to': 'qux'}),
184
]}
185
with ForkedFakeService.from_client(client, archive):
186
response = client.get_messages('baz')
187
self.assertIDOrder(['bar', 'qux', 'foo'], response['messages'])
188
response = client.get_messages('baz', order='date')
189
self.assertIDOrder(['bar', 'foo', 'qux'], response['messages'])
190
response = client.get_messages('baz', order='thread_oldest')
191
self.assertIDOrder(['bar', 'qux', 'foo'], response['messages'])
192
193
def test_get_messages_thread_newest_order(self):
194
client = GrackleClient('localhost', 8439)
195
archive = {
196
'baz': [
197
make_message('bar', headers={'date': 'x'}),
198
make_message('qux', headers={'date': 'w'}),
199
make_message('foo', headers={'date': 'y',
200
'in-reply-to': 'bar'}),
201
make_message('baz', headers={'date': 'z',
202
'in-reply-to': 'qux'}),
203
]}
204
with ForkedFakeService.from_client(client, archive):
205
response = client.get_messages('baz', order='date')
206
self.assertIDOrder(
207
['qux', 'bar', 'foo', 'baz'], response['messages'])
208
response = client.get_messages('baz', order='thread_newest')
209
self.assertIDOrder(
210
['bar', 'foo', 'qux', 'baz'], response['messages'])
211
212
def test_get_messages_unsupported_order(self):
213
client = GrackleClient('localhost', 8439)
214
archive = {
215
'baz': [
216
make_message('foo', headers={'date': '2011-03-25'}),
217
make_message('foo', headers={'date': '2011-03-24'}),
218
]}
219
with ForkedFakeService.from_client(client, archive):
220
with ExpectedException(UnsupportedOrder, ''):
221
client.get_messages('baz', order='nonsense')
222
223
def test_get_messages_headers_no_headers(self):
224
client = GrackleClient('localhost', 8440)
225
archive = {'baz': [make_message('foo')]}
226
with ForkedFakeService.from_client(client, archive):
227
response = client.get_messages('baz', headers=[
228
'Subject', 'Date', 'X-Launchpad-Message-Rationale'])
229
first_message = response['messages'][0]
230
self.assertEqual('foo', first_message['message_id'])
231
self.assertEqual({}, first_message['headers'])
232
233
def test_get_messages_headers_exclude_headers(self):
234
client = GrackleClient('localhost', 8441)
235
archive = {
236
'baz': [make_message('foo', headers={'From': 'me'})]}
237
with ForkedFakeService.from_client(client, archive):
238
response = client.get_messages('baz', headers=[
239
'Subject', 'Date', 'X-Launchpad-Message-Rationale'])
240
first_message = response['messages'][0]
241
self.assertEqual('foo', first_message['message_id'])
242
self.assertEqual({}, first_message['headers'])
243
244
def test_get_messages_headers_include_headers(self):
245
client = GrackleClient('localhost', 8442)
246
archive = {
247
'baz': [
248
make_message('foo', headers={'From': 'me', 'To': 'you'})]}
249
with ForkedFakeService.from_client(client, archive):
250
response = client.get_messages('baz', headers=[
251
'From', 'To'])
252
first_message = response['messages'][0]
253
self.assertEqual('foo', first_message['message_id'])
254
self.assertEqual({'From': 'me', 'To': 'you'}, first_message['headers'])
255
256
def test_get_messages_max_body_length(self):
257
client = GrackleClient('localhost', 8443)
258
archive = {'baz': [make_message('foo', body=u'abcdefghi')]}
259
with ForkedFakeService.from_client(client, archive):
260
response = client.get_messages('baz', max_body_length=3)
261
first_message = response['messages'][0]
262
self.assertEqual('abc', first_message['body'])
263
264
def test_include_hidden(self):
265
client = GrackleClient('localhost', 8444)
266
archive = {
267
'baz': [
268
make_message('foo', hidden=True),
269
make_message('bar', hidden=False),
270
]}
271
with ForkedFakeService.from_client(client, archive):
272
response = client.get_messages('baz', include_hidden=True)
273
self.assertMessageIDs(['bar', 'foo'], response['messages'])
274
response = client.get_messages('baz', include_hidden=False)
275
self.assertMessageIDs(['bar'], response['messages'])
276
277
def test_display_type_unknown_value(self):
278
client = GrackleClient('localhost', 8445)
279
archive = {'baz': [make_message('foo', body=u'abcdefghi')]}
280
with ForkedFakeService.from_client(client, archive):
281
with ExpectedException(UnsupportedDisplayType, ''):
282
client.get_messages('baz', display_type='unknown')
283
284
def test_display_type_headers_only(self):
285
client = GrackleClient('localhost', 8446)
286
archive = {
287
'baz': [
288
make_message('foo', body=u'abcdefghi',
289
headers={'From': 'me', 'To': 'you'})]}
290
with ForkedFakeService.from_client(client, archive):
291
response = client.get_messages('baz', display_type='headers-only')
292
first_message = response['messages'][0]
293
self.assertEqual('foo', first_message['message_id'])
294
self.assertEqual(
295
archive['baz'][0]['headers'], first_message['headers'])
296
self.assertNotIn('body', first_message)
297
298
def test_display_type_text_only(self):
299
client = GrackleClient('localhost', 8446)
300
archive = {
301
'baz': [
302
make_mime_message(
303
'foo', 'abcdefghi',
304
headers={'From': 'me', 'To': 'you'},
305
attachment_type='text/x-diff')]}
306
with ForkedFakeService.from_client(client, archive):
307
response = client.get_messages('baz', display_type='text-only')
308
first_message = response['messages'][0]
309
self.assertEqual('foo', first_message['message_id'])
310
self.assertEqual('me', first_message['headers']['From'])
311
self.assertEqual('you', first_message['headers']['To'])
312
self.assertEqual(archive['baz'][0]['body'], first_message['body'])
313
314
def test_display_type_all(self):
315
client = GrackleClient('localhost', 8447)
316
archive = {
317
'baz': [
318
make_mime_message(
319
'foo', 'abcdefghi',
320
headers={'From': 'me', 'To': 'you'},
321
attachment_type='text/x-diff')]}
322
with ForkedFakeService.from_client(client, archive):
323
response = client.get_messages('baz', display_type='all')
324
first_message = response['messages'][0]
325
self.assertEqual('foo', first_message['message_id'])
326
self.assertEqual('me', first_message['headers']['From'])
327
self.assertEqual('you', first_message['headers']['To'])
328
self.assertEqual(archive['baz'][0]['body'], first_message['body'])
329
330
def test_date_range(self):
331
client = GrackleClient('localhost', 8448)
332
archive = {
333
'baz': [
334
make_mime_message(
335
'foo', 'abcdefghi', headers={'date': '2011-12-31'}),
336
make_mime_message(
337
'bar', 'abcdefghi', headers={'date': '2012-01-01'}),
338
make_mime_message(
339
'qux', 'abcdefghi', headers={'date': '2012-01-15'}),
340
make_mime_message(
341
'naf', 'abcdefghi', headers={'date': '2012-01-31'}),
342
make_mime_message(
343
'doh', 'abcdefghi', headers={'date': '2012-02-01'}),
344
]}
345
with ForkedFakeService.from_client(client, archive):
346
response = client.get_messages(
347
'baz', date_range='2012-01-01..2012-01-31')
348
ids = sorted(m['message_id'] for m in response['messages'])
349
self.assertEqual(['bar', 'naf', 'qux'], ids)
350
351
def test_date_range_unparsabledaterange(self):
352
client = GrackleClient('localhost', 8449)
353
archive = {'baz': [make_message('foo', body=u'abcdefghi')]}
354
with ForkedFakeService.from_client(client, archive):
355
with ExpectedException(UnparsableDateRange, ''):
356
client.get_messages('baz', date_range='2012-01-01')
357
358
def test_date_range_unparsabledaterange_missing_part(self):
359
client = GrackleClient('localhost', 8450)
360
archive = {'baz': [make_message('foo', body=u'abcdefghi')]}
361
with ForkedFakeService.from_client(client, archive):
362
with ExpectedException(UnparsableDateRange, ''):
363
client.get_messages('baz', date_range='2012-01-01..')
364
365
def test_date_range_unparsabledaterange_extra_part(self):
366
client = GrackleClient('localhost', 8451)
367
archive = {'baz': [make_message('foo', body=u'abcdefghi')]}
368
with ForkedFakeService.from_client(client, archive):
369
with ExpectedException(UnparsableDateRange, ''):
370
client.get_messages('baz', date_range='2012-01..12-02..12-03')
371
372
373
class TestHideMessages(TestCase):
374
375
def test_hide_message_true(self):
376
client = GrackleClient('localhost', 8470)
377
archive = {
378
'baz': [
379
make_message('foo', hidden=False),
380
]}
381
with ForkedFakeService.from_client(client, archive):
382
response = client.hide_message('baz', 'foo', hidden=True)
383
self.assertEqual('foo', response['message_id'])
384
self.assertIs(True, response['hidden'])
385
386
def test_hide_message_false(self):
387
client = GrackleClient('localhost', 8470)
388
archive = {
389
'baz': [
390
make_message('foo', hidden=True),
391
]}
392
with ForkedFakeService.from_client(client, archive):
393
response = client.hide_message('baz', 'foo', hidden=False)
394
self.assertEqual('foo', response['message_id'])
395
self.assertIs(False, response['hidden'])
119
self.assertEqual('foo', message['message-id'])
Loggerhead is a web-based interface for Breezy
Version: 2.0.1