« back to all changes in this revision
Viewing changes to grackle/tests/test_client.py
- browse files at revision 32
- compare with another revision
- download diff
- download tarball
- view history from revision 32
- Committer: Aaron Bentley
- Date: 2012-01-16 16:29:12 UTC
- Revision ID: aaron@canonical.com-20120116162912-cc760p6gn7q5qdwr
Switch test HTTP server to standard Python logging.
- files removed:
- grackle/error.py
- files modified:
- grackle-put-message
added
removed
grackle/tests/test_client.py
1
from email.message import Message
2
from email.mime.multipart import MIMEMultipart
3
from email.mime.text import MIMEText
1
from BaseHTTPServer import (
2
HTTPServer,
3
BaseHTTPRequestHandler,
4
)
5
import httplib
6
import logging
7
import os
8
from signal import SIGKILL
9
import simplejson
4
10
from StringIO import StringIO
11
import sys
5
12
from unittest import TestCase
13
from urlparse import urlparse
14
from urlparse import parse_qs
6
15
7
16
from testtools import ExpectedException
8
17
9
from grackle.client import GrackleClient
10
from grackle.error import (
11
ArchiveIdExists,
12
UnparsableDateRange,
13
UnsupportedDisplayType,
18
from grackle.client import (
19
GrackleClient,
14
20
UnsupportedOrder,
15
21
)
16
from grackle.service import ForkedFakeService
17
from grackle.store import (
18
make_json_message,
19
)
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')
22
23
24
def threaded_messages(messages):
25
threads = {}
26
count = 0
27
pending = []
28
for message in messages:
29
if message.get('in_reply_to') is None:
30
threads[message['message_id']] = [message]
31
count += 1
32
else:
33
pending.append(message)
34
for message in pending:
35
threads[message['in_reply_to']].append(message)
36
return threads.values()
37
38
39
class GrackleStore:
40
41
def __init__(self, messages):
42
self.messages = messages
43
44
def get_messages(self, archive_id, query_string):
45
query = parse_qs(query_string)
46
parameters = simplejson.loads(query['parameters'][0])
47
order = parameters.get('order')
48
messages = self.messages[archive_id]
49
if order is not None :
50
if order not in SUPPORTED_ORDERS:
51
raise UnsupportedOrder
52
elif order.startswith('thread_'):
53
threaded = threaded_messages(messages)
54
messages = []
55
if order == 'thread_subject':
56
threaded.sort(key=lambda t: t[0]['subject'])
57
if order == 'thread_oldest':
58
threaded.sort(key=lambda t: min(m['date'] for m in t))
59
if order == 'thread_newest':
60
threaded.sort(key=lambda t: max(m['date'] for m in t))
61
for thread in threaded:
62
messages.extend(thread)
63
else:
64
messages.sort(key=lambda m: m[order])
65
new_messages = []
66
for message in messages:
67
if (
68
not parameters['include_hidden']
69
and message.get('hidden', False)):
70
continue
71
72
if ('message_ids' in parameters and
73
message['message_id'] not in parameters['message_ids']):
74
continue
75
message = dict(message)
76
if 'headers' in parameters:
77
headers = dict(
78
(k, v) for k, v in message['headers'].iteritems()
79
if k in parameters['headers'])
80
message['headers'] = headers
81
max_body = parameters.get('max_body_length')
82
if max_body is not None:
83
message['body'] = message['body'][:max_body]
84
new_messages.append(message)
85
messages = new_messages
86
limit = parameters.get('limit', 100)
87
memo = parameters.get('memo')
88
message_id_indices = dict(
89
(m['message_id'], idx) for idx, m in enumerate(messages))
90
if memo is None:
91
start = 0
92
else:
93
start = message_id_indices[memo.encode('rot13')]
94
if start > 0:
95
previous_memo = messages[start - 1]['message_id'].encode('rot13')
96
else:
97
previous_memo = None
98
end = min(start + limit, len(messages))
99
if end < len(messages):
100
next_memo = messages[end]['message_id'].encode('rot13')
101
else:
102
next_memo = None
103
messages = messages[start:end]
104
105
response = {
106
'messages': messages,
107
'next_memo': next_memo,
108
'previous_memo': previous_memo
109
}
110
return response
111
112
113
114
class ForkedFake:
115
116
def __init__(self, port, messages=None):
117
self.pid = None
118
self.port = port
119
if messages is None:
120
self.messages = {}
121
else:
122
self.messages = messages
123
self.read_end, self.write_end = os.pipe()
124
125
@staticmethod
126
def from_client(client, messages=None):
127
return ForkedFake(client.port, messages)
128
129
def is_ready(self):
130
os.write(self.write_end, 'asdf')
131
132
def __enter__(self):
133
pid = os.fork()
134
if pid == 0:
135
self.start_server()
136
self.pid = pid
137
os.read(self.read_end, 1)
138
return
139
140
def start_server(self):
141
service = HTTPServer(('', self.port), FakeGrackleRequestHandler)
142
service.store = GrackleStore(self.messages)
143
for archive_id, messages in service.store.messages.iteritems():
144
for message in messages:
145
message.setdefault('headers', {})
146
self.is_ready()
147
# logging.basicConfig(
148
# stream=sys.stderr, level=logging.INFO)
149
service.serve_forever()
150
151
def __exit__(self, exc_type, exc_val, traceback):
152
os.kill(self.pid, SIGKILL)
153
154
155
SUPPORTED_ORDERS = set(
156
['date', 'author', 'subject', 'thread_newest', 'thread_oldest',
157
'thread_subject'])
158
159
160
class FakeGrackleRequestHandler(BaseHTTPRequestHandler):
161
162
def __init__(self, *args, **kwargs):
163
self.logger = logging.getLogger('http')
164
BaseHTTPRequestHandler.__init__(self, *args, **kwargs)
165
166
def do_POST(self):
167
message = self.rfile.read(int(self.headers['content-length']))
168
if message == 'This is a message':
169
self.send_response(httplib.CREATED)
170
self.end_headers()
171
self.wfile.close()
172
else:
173
self.send_error(httplib.BAD_REQUEST)
174
175
def do_GET(self):
176
scheme, netloc, path, params, query_string, fragments = (
177
urlparse(self.path))
178
parts = path.split('/')
179
if parts[1] == 'archive':
180
try:
181
response = self.server.store.get_messages(
182
parts[2], query_string)
183
self.send_response(httplib.OK)
184
self.end_headers()
185
self.wfile.write(simplejson.dumps(response))
186
except UnsupportedOrder:
187
self.send_response(httplib.BAD_REQUEST)
188
self.wfile.write('Unsupported order')
189
return
190
191
def log_message(self, format, *args):
192
message = "%s - - [%s] %s\n" % (
193
self.address_string(), self.log_date_time_string(), format%args)
194
self.logger.info(message)
69
195
70
196
71
197
class TestPutMessage(TestCase):
72
198
73
199
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):
200
client = GrackleClient('localhost', 8436)
201
with ForkedFake.from_client(client):
202
client.put_message('arch1', 'asdf', StringIO('This is a message'))
87
203
with ExpectedException(Exception, 'wtf'):
88
client.put_message('no-archive', 'id1', StringIO('message'))
204
client.put_message('arch1', 'asdf',
205
StringIO('This is not a message'))
89
206
90
207
91
208
class TestGetMessages(TestCase):
95
212
96
213
def assertMessageIDs(self, ids, messages):
97
214
self.assertIDOrder(
98
sorted(ids), sorted(messages, key=lambda m: m['message_id']))
215
sorted(ids), sorted(messages, key=lambda m:m['message_id']))
99
216
100
217
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):
218
client = GrackleClient('localhost', 8435)
219
with ForkedFake.from_client(client,
220
{'baz':
221
[{'message_id': 'foo'},
222
{'message_id': 'bar'}]}):
105
223
response = client.get_messages('baz')
106
224
self.assertEqual(['bar', 'foo'], sorted(m['message_id'] for m in
107
225
response['messages']))
110
228
111
229
def test_get_messages_by_id(self):
112
230
client = GrackleClient('localhost', 8437)
113
archive = {
114
'baz': [make_message('foo'), make_message('bar')]}
115
with ForkedFakeService.from_client(client, archive):
231
with ForkedFake.from_client(client,
232
{'baz':
233
[{'message_id': 'foo'},
234
{'message_id': 'bar'}]}):
116
235
response = client.get_messages('baz', message_ids=['foo'])
117
236
message, = response['messages']
118
237
self.assertEqual('foo', message['message_id'])
119
238
120
239
def test_get_messages_batching(self):
121
240
client = GrackleClient('localhost', 8438)
122
archive = {'baz': [make_message('foo'), make_message('bar')]}
123
with ForkedFakeService.from_client(client, archive):
241
with ForkedFake.from_client(client,
242
{'baz':
243
[{'message_id': 'foo'},
244
{'message_id': 'bar'}]}):
124
245
response = client.get_messages('baz', limit=1)
125
246
self.assertEqual(1, len(response['messages']))
126
247
messages = response['messages']
132
253
133
254
def get_messages_member_order_test(self, key):
134
255
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):
256
with ForkedFake.from_client(client,
257
{'baz': [{'message_id': 'foo', key: '2011-03-25'},
258
{'message_id': 'bar', key: '2011-03-24'}]}):
145
259
response = client.get_messages('baz')
146
260
self.assertIDOrder(['foo', 'bar'], response['messages'])
147
261
response = client.get_messages('baz', order=key)
157
271
self.get_messages_member_order_test('subject')
158
272
159
273
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
274
client = GrackleClient('localhost', 8439)
168
with ForkedFakeService.from_client(client, archive):
275
with ForkedFake.from_client(client, {'baz': [
276
{'message_id': 'bar', 'subject': 'y'},
277
{'message_id': 'qux', 'subject': 'z'},
278
{'message_id': 'foo', 'subject': 'x', 'in_reply_to': 'qux'},
279
]}):
169
280
response = client.get_messages('baz')
170
281
self.assertIDOrder(['bar', 'qux', 'foo'], response['messages'])
171
282
response = client.get_messages('baz', order='subject')
175
286
176
287
def test_get_messages_thread_oldest_order(self):
177
288
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):
289
with ForkedFake.from_client(client, {'baz': [
290
{'message_id': 'bar', 'date': 'x'},
291
{'message_id': 'qux', 'date': 'z'},
292
{'message_id': 'foo', 'date': 'y', 'in_reply_to': 'qux'},
293
]}):
186
294
response = client.get_messages('baz')
187
295
self.assertIDOrder(['bar', 'qux', 'foo'], response['messages'])
188
296
response = client.get_messages('baz', order='date')
192
300
193
301
def test_get_messages_thread_newest_order(self):
194
302
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):
303
with ForkedFake.from_client(client, {'baz': [
304
{'message_id': 'bar', 'date': 'x'},
305
{'message_id': 'qux', 'date': 'w'},
306
{'message_id': 'foo', 'date': 'y', 'in_reply_to': 'bar'},
307
{'message_id': 'baz', 'date': 'z', 'in_reply_to': 'qux'},
308
]}):
205
309
response = client.get_messages('baz', order='date')
206
310
self.assertIDOrder(
207
311
['qux', 'bar', 'foo', 'baz'], response['messages'])
211
315
212
316
def test_get_messages_unsupported_order(self):
213
317
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, ''):
318
with ForkedFake.from_client(client,
319
{'baz': [{'message_id': 'foo', 'date': '2011-03-25'},
320
{'message_id': 'bar', 'date': '2011-03-24'}]}):
321
with ExpectedException(UnsupportedOrder):
221
322
client.get_messages('baz', order='nonsense')
222
323
223
324
def test_get_messages_headers_no_headers(self):
224
325
client = GrackleClient('localhost', 8440)
225
archive = {'baz': [make_message('foo')]}
226
with ForkedFakeService.from_client(client, archive):
326
with ForkedFake.from_client(client,
327
{'baz': [
328
{'message_id': 'foo'}
329
]}):
227
330
response = client.get_messages('baz', headers=[
228
331
'Subject', 'Date', 'X-Launchpad-Message-Rationale'])
229
332
first_message = response['messages'][0]
232
335
233
336
def test_get_messages_headers_exclude_headers(self):
234
337
client = GrackleClient('localhost', 8441)
235
archive = {
236
'baz': [make_message('foo', headers={'From': 'me'})]}
237
with ForkedFakeService.from_client(client, archive):
338
with ForkedFake.from_client(client,
339
{'baz': [
340
{'message_id': 'foo', 'headers': {'From': 'me'}}
341
]}):
238
342
response = client.get_messages('baz', headers=[
239
343
'Subject', 'Date', 'X-Launchpad-Message-Rationale'])
240
344
first_message = response['messages'][0]
243
347
244
348
def test_get_messages_headers_include_headers(self):
245
349
client = GrackleClient('localhost', 8442)
246
archive = {
247
'baz': [
248
make_message('foo', headers={'From': 'me', 'To': 'you'})]}
249
with ForkedFakeService.from_client(client, archive):
350
with ForkedFake.from_client(client,
351
{'baz': [
352
{'message_id': 'foo', 'headers': {'From': 'me', 'To': 'you'}}
353
]}):
250
354
response = client.get_messages('baz', headers=[
251
355
'From', 'To'])
252
356
first_message = response['messages'][0]
255
359
256
360
def test_get_messages_max_body_length(self):
257
361
client = GrackleClient('localhost', 8443)
258
archive = {'baz': [make_message('foo', body=u'abcdefghi')]}
259
with ForkedFakeService.from_client(client, archive):
362
with ForkedFake.from_client(client,
363
{'baz': [
364
{'message_id': 'foo', 'body': u'abcdefghi'}
365
]}):
260
366
response = client.get_messages('baz', max_body_length=3)
261
367
first_message = response['messages'][0]
262
368
self.assertEqual('abc', first_message['body'])
263
369
264
370
def test_include_hidden(self):
265
371
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):
372
with ForkedFake.from_client(client,
373
{'baz': [
374
{'message_id': 'foo', 'hidden': True},
375
{'message_id': 'bar', 'hidden': False}
376
]}):
272
377
response = client.get_messages('baz', include_hidden=True)
273
378
self.assertMessageIDs(['bar', 'foo'], response['messages'])
274
379
response = client.get_messages('baz', include_hidden=False)
275
380
self.assertMessageIDs(['bar'], response['messages'])
276
381
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'])
Loggerhead is a web-based interface for Breezy
Version: 2.0.1