~unity-2d-team/unity-2d/Shell-MultiMonitor
» Revision
45
(compared to revision 6.1.23)
: grackle/tests/test_client.py
« back to all changes in this revision
Viewing changes to grackle/tests/test_client.py
- browse files at revision 45
- compare with another revision
- download diff
- download tarball
- view history from revision 45
- Committer: William Grant
- Date: 2012-04-20 02:20:58 UTC
- mfrom: (6.1.70 trunk)
- Revision ID: william.grant@canonical.com-20120420022058-3nkracsmlg7akydu
Merge trunk.
- files added:
- grackle-create-instance
- grackle/testing
- files modified:
- Makefile
added
removed
grackle/tests/test_client.py
1
from BaseHTTPServer import (
2
HTTPServer,
3
BaseHTTPRequestHandler,
4
)
5
import httplib
6
import os
7
from signal import SIGKILL
8
import simplejson
1
__metaclass__ = type
2
3
from email.message import Message
4
from email.mime.multipart import MIMEMultipart
5
from email.mime.text import MIMEText
9
6
from StringIO import StringIO
10
7
from unittest import TestCase
11
from urlparse import urlparse
12
from urlparse import parse_qs
13
8
14
9
from testtools import ExpectedException
15
10
16
from grackle.client import (
17
GrackleClient,
11
from grackle.client import GrackleClient
12
from grackle.error import (
13
ArchiveIdExists,
14
UnparsableDateRange,
15
UnsupportedDisplayType,
18
16
UnsupportedOrder,
19
17
)
20
21
22
def threaded_messages(messages):
23
threads = {}
24
count = 0
25
pending = []
26
for message in messages:
27
if message.get('in_reply_to') is None:
28
threads[message['message_id']] = [message]
29
count += 1
30
else:
31
pending.append(message)
32
for message in pending:
33
threads[message['in_reply_to']].append(message)
34
return threads.values()
35
36
37
class GrackleStore:
38
39
def __init__(self, messages):
40
self.messages = messages
41
42
def get_messages(self, archive_id, query_string):
43
query = parse_qs(query_string)
44
parameters = simplejson.loads(query['parameters'][0])
45
order = parameters.get('order')
46
messages = self.messages[archive_id]
47
if order is not None :
48
if order not in SUPPORTED_ORDERS:
49
raise UnsupportedOrder
50
elif order.startswith('thread_'):
51
threaded = threaded_messages(messages)
52
messages = []
53
if order == 'thread_subject':
54
threaded.sort(key=lambda t: t[0]['subject'])
55
if order == 'thread_oldest':
56
threaded.sort(key=lambda t: min(m['date'] for m in t))
57
if order == 'thread_newest':
58
threaded.sort(key=lambda t: max(m['date'] for m in t))
59
for thread in threaded:
60
messages.extend(thread)
61
else:
62
messages.sort(key=lambda m: m[order])
63
messages = [m for m in messages
64
]
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
self.messages = messages
120
self.read_end, self.write_end = os.pipe()
121
122
def is_ready(self):
123
os.write(self.write_end, 'asdf')
124
125
def __enter__(self):
126
pid = os.fork()
127
if pid == 0:
128
self.start_server()
129
self.pid = pid
130
os.read(self.read_end, 1)
131
return
132
133
def start_server(self):
134
service = HTTPServer(('', self.port), FakeGrackleRequestHandler)
135
service.store = GrackleStore(self.messages)
136
for archive_id, messages in service.store.messages.iteritems():
137
for message in messages:
138
message.setdefault('headers', {})
139
self.is_ready()
140
service.serve_forever()
141
142
def __exit__(self, exc_type, exc_val, traceback):
143
os.kill(self.pid, SIGKILL)
144
145
146
SUPPORTED_ORDERS = set(
147
['date', 'author', 'subject', 'thread_newest', 'thread_oldest',
148
'thread_subject'])
149
150
151
class FakeGrackleRequestHandler(BaseHTTPRequestHandler):
152
153
def do_POST(self):
154
message = self.rfile.read(int(self.headers['content-length']))
155
if message == 'This is a message':
156
self.send_response(httplib.CREATED)
157
self.end_headers()
158
self.wfile.close()
159
else:
160
self.send_error(httplib.BAD_REQUEST)
161
162
def do_GET(self):
163
scheme, netloc, path, params, query_string, fragments = (
164
urlparse(self.path))
165
parts = path.split('/')
166
if parts[1] == 'archive':
167
try:
168
response = self.server.store.get_messages(
169
parts[2], query_string)
170
self.send_response(httplib.OK)
171
self.end_headers()
172
self.wfile.write(simplejson.dumps(response))
173
except UnsupportedOrder:
174
self.send_response(httplib.BAD_REQUEST)
175
self.wfile.write('Unsupported order')
176
return
177
178
179
def fake_grackle_service(client, messages=None):
180
if messages is None:
181
messages = {}
182
return ForkedFake(client.port, messages)
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')
183
69
184
70
185
71
class TestPutMessage(TestCase):
186
72
187
73
def test_put_message(self):
188
client = GrackleClient('localhost', 8436)
189
with fake_grackle_service(client):
190
client.put_message('arch1', 'asdf', StringIO('This is a message'))
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):
191
87
with ExpectedException(Exception, 'wtf'):
192
client.put_message('arch1', 'asdf',
193
StringIO('This is not a message'))
88
client.put_message('no-archive', 'id1', StringIO('message'))
194
89
195
90
196
91
class TestGetMessages(TestCase):
200
95
201
96
def assertMessageIDs(self, ids, messages):
202
97
self.assertIDOrder(
203
sorted(ids), sorted(messages, key=lambda m:m['message_id']))
98
sorted(ids), sorted(messages, key=lambda m: m['message_id']))
204
99
205
100
def test_get_messages(self):
206
client = GrackleClient('localhost', 8435)
207
with fake_grackle_service(client,
208
{'baz':
209
[{'message_id': 'foo'},
210
{'message_id': 'bar'}]}):
101
client = GrackleClient('localhost', 8430)
102
archive = {
103
'baz': [make_message('foo'), make_message('bar')]}
104
with ForkedFakeService.from_client(client, archive):
211
105
response = client.get_messages('baz')
212
106
self.assertEqual(['bar', 'foo'], sorted(m['message_id'] for m in
213
107
response['messages']))
216
110
217
111
def test_get_messages_by_id(self):
218
112
client = GrackleClient('localhost', 8437)
219
with fake_grackle_service(client,
220
{'baz':
221
[{'message_id': 'foo'},
222
{'message_id': 'bar'}]}):
113
archive = {
114
'baz': [make_message('foo'), make_message('bar')]}
115
with ForkedFakeService.from_client(client, archive):
223
116
response = client.get_messages('baz', message_ids=['foo'])
224
117
message, = response['messages']
225
118
self.assertEqual('foo', message['message_id'])
226
119
227
120
def test_get_messages_batching(self):
228
121
client = GrackleClient('localhost', 8438)
229
with fake_grackle_service(client,
230
{'baz':
231
[{'message_id': 'foo'},
232
{'message_id': 'bar'}]}):
122
archive = {'baz': [make_message('foo'), make_message('bar')]}
123
with ForkedFakeService.from_client(client, archive):
233
124
response = client.get_messages('baz', limit=1)
234
125
self.assertEqual(1, len(response['messages']))
235
126
messages = response['messages']
241
132
242
133
def get_messages_member_order_test(self, key):
243
134
client = GrackleClient('localhost', 8439)
244
with fake_grackle_service(client,
245
{'baz': [{'message_id': 'foo', key: '2011-03-25'},
246
{'message_id': 'bar', key: '2011-03-24'}]}):
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):
247
145
response = client.get_messages('baz')
248
146
self.assertIDOrder(['foo', 'bar'], response['messages'])
249
147
response = client.get_messages('baz', order=key)
259
157
self.get_messages_member_order_test('subject')
260
158
261
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
]}
262
167
client = GrackleClient('localhost', 8439)
263
with fake_grackle_service(client, {'baz': [
264
{'message_id': 'bar', 'subject': 'y'},
265
{'message_id': 'qux', 'subject': 'z'},
266
{'message_id': 'foo', 'subject': 'x', 'in_reply_to': 'qux'},
267
]}):
168
with ForkedFakeService.from_client(client, archive):
268
169
response = client.get_messages('baz')
269
170
self.assertIDOrder(['bar', 'qux', 'foo'], response['messages'])
270
171
response = client.get_messages('baz', order='subject')
274
175
275
176
def test_get_messages_thread_oldest_order(self):
276
177
client = GrackleClient('localhost', 8439)
277
with fake_grackle_service(client, {'baz': [
278
{'message_id': 'bar', 'date': 'x'},
279
{'message_id': 'qux', 'date': 'z'},
280
{'message_id': 'foo', 'date': 'y', 'in_reply_to': 'qux'},
281
]}):
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):
282
186
response = client.get_messages('baz')
283
187
self.assertIDOrder(['bar', 'qux', 'foo'], response['messages'])
284
188
response = client.get_messages('baz', order='date')
288
192
289
193
def test_get_messages_thread_newest_order(self):
290
194
client = GrackleClient('localhost', 8439)
291
with fake_grackle_service(client, {'baz': [
292
{'message_id': 'bar', 'date': 'x'},
293
{'message_id': 'qux', 'date': 'w'},
294
{'message_id': 'foo', 'date': 'y', 'in_reply_to': 'bar'},
295
{'message_id': 'baz', 'date': 'z', 'in_reply_to': 'qux'},
296
]}):
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):
297
205
response = client.get_messages('baz', order='date')
298
206
self.assertIDOrder(
299
207
['qux', 'bar', 'foo', 'baz'], response['messages'])
303
211
304
212
def test_get_messages_unsupported_order(self):
305
213
client = GrackleClient('localhost', 8439)
306
with fake_grackle_service(client,
307
{'baz': [{'message_id': 'foo', 'date': '2011-03-25'},
308
{'message_id': 'bar', 'date': '2011-03-24'}]}):
309
with ExpectedException(UnsupportedOrder):
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, ''):
310
221
client.get_messages('baz', order='nonsense')
311
222
312
223
def test_get_messages_headers_no_headers(self):
313
224
client = GrackleClient('localhost', 8440)
314
with fake_grackle_service(client,
315
{'baz': [
316
{'message_id': 'foo'}
317
]}):
225
archive = {'baz': [make_message('foo')]}
226
with ForkedFakeService.from_client(client, archive):
318
227
response = client.get_messages('baz', headers=[
319
228
'Subject', 'Date', 'X-Launchpad-Message-Rationale'])
320
229
first_message = response['messages'][0]
323
232
324
233
def test_get_messages_headers_exclude_headers(self):
325
234
client = GrackleClient('localhost', 8441)
326
with fake_grackle_service(client,
327
{'baz': [
328
{'message_id': 'foo', 'headers': {'From': 'me'}}
329
]}):
235
archive = {
236
'baz': [make_message('foo', headers={'From': 'me'})]}
237
with ForkedFakeService.from_client(client, archive):
330
238
response = client.get_messages('baz', headers=[
331
239
'Subject', 'Date', 'X-Launchpad-Message-Rationale'])
332
240
first_message = response['messages'][0]
335
243
336
244
def test_get_messages_headers_include_headers(self):
337
245
client = GrackleClient('localhost', 8442)
338
with fake_grackle_service(client,
339
{'baz': [
340
{'message_id': 'foo', 'headers': {'From': 'me', 'To': 'you'}}
341
]}):
246
archive = {
247
'baz': [
248
make_message('foo', headers={'From': 'me', 'To': 'you'})]}
249
with ForkedFakeService.from_client(client, archive):
342
250
response = client.get_messages('baz', headers=[
343
251
'From', 'To'])
344
252
first_message = response['messages'][0]
347
255
348
256
def test_get_messages_max_body_length(self):
349
257
client = GrackleClient('localhost', 8443)
350
with fake_grackle_service(client,
351
{'baz': [
352
{'message_id': 'foo', 'body': u'abcdefghi'}
353
]}):
258
archive = {'baz': [make_message('foo', body=u'abcdefghi')]}
259
with ForkedFakeService.from_client(client, archive):
354
260
response = client.get_messages('baz', max_body_length=3)
355
261
first_message = response['messages'][0]
356
262
self.assertEqual('abc', first_message['body'])
357
263
358
264
def test_include_hidden(self):
359
265
client = GrackleClient('localhost', 8444)
360
with fake_grackle_service(client,
361
{'baz': [
362
{'message_id': 'foo', 'hidden': True},
363
{'message_id': 'bar', 'hidden': False}
364
]}):
266
archive = {
267
'baz': [
268
make_message('foo', hidden=True),
269
make_message('bar', hidden=False),
270
]}
271
with ForkedFakeService.from_client(client, archive):
365
272
response = client.get_messages('baz', include_hidden=True)
366
273
self.assertMessageIDs(['bar', 'foo'], response['messages'])
367
274
response = client.get_messages('baz', include_hidden=False)
368
275
self.assertMessageIDs(['bar'], response['messages'])
369
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'])
Loggerhead is a web-based interface for Breezy
Version: 2.0.1