← Back to branch summary

~didrocks/unity/altf10

« back to all changes in this revision

Viewing changes to grackle/tests/test_client.py

  • Committer: Aaron Bentley
  • Date: 2012-01-12 10:05:32 UTC
  • Revision ID: aaron@canonical.com-20120112100532-gljok11rzp7i3y11
Test unsupported orders.

Show diffs side-by-side

added added

removed removed

Lines of Context:
grackle/tests/test_client.py
3
3
    BaseHTTPRequestHandler,
4
4
    )
5
5
import httplib
6
 
import logging
7
6
import os
8
7
from signal import SIGKILL
9
8
import simplejson
10
9
from StringIO import StringIO
11
 
import sys
12
10
from unittest import TestCase
13
11
from urlparse import urlparse
14
12
from urlparse import parse_qs
21
19
    )
22
20
 
23
21
 
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
22
class ForkedFake:
115
23
 
116
 
    def __init__(self, port, messages=None, write_logs=False):
 
24
    def __init__(self, port, messages=None):
117
25
        self.pid = None
118
26
        self.port = port
119
 
        if messages is None:
120
 
            self.messages = {}
121
 
        else:
122
 
            self.messages = messages
 
27
        self.messages = messages
123
28
        self.read_end, self.write_end = os.pipe()
124
 
        self.write_logs = write_logs
125
 
 
126
 
    @staticmethod
127
 
    def from_client(client, messages=None):
128
 
        return ForkedFake(client.port, messages)
129
29
 
130
30
    def is_ready(self):
131
31
        os.write(self.write_end, 'asdf')
140
40
 
141
41
    def start_server(self):
142
42
        service = HTTPServer(('', self.port), FakeGrackleRequestHandler)
143
 
        service.store = GrackleStore(self.messages)
144
 
        for archive_id, messages in service.store.messages.iteritems():
145
 
            for message in messages:
146
 
                message.setdefault('headers', {})
 
43
        service.messages = self.messages
147
44
        self.is_ready()
148
 
        if self.write_logs:
149
 
            logging.basicConfig(
150
 
                stream=sys.stderr, level=logging.INFO)
151
45
        service.serve_forever()
152
46
 
153
47
    def __exit__(self, exc_type, exc_val, traceback):
154
48
        os.kill(self.pid, SIGKILL)
155
49
 
156
50
 
157
 
SUPPORTED_ORDERS = set(
158
 
    ['date', 'author', 'subject', 'thread_newest', 'thread_oldest',
159
 
     'thread_subject'])
 
51
SUPPORTED_ORDERS = set(['date'])
160
52
 
161
53
 
162
54
class FakeGrackleRequestHandler(BaseHTTPRequestHandler):
163
55
 
164
 
    def __init__(self, *args, **kwargs):
165
 
        self.logger = logging.getLogger('http')
166
 
        BaseHTTPRequestHandler.__init__(self, *args, **kwargs)
167
 
 
168
56
    def do_POST(self):
169
57
        message = self.rfile.read(int(self.headers['content-length']))
170
58
        if message == 'This is a message':
177
65
    def do_GET(self):
178
66
        scheme, netloc, path, params, query_string, fragments = (
179
67
            urlparse(self.path))
180
 
        parts = path.split('/')
181
 
        if parts[1] == 'archive':
182
 
            try:
183
 
                response = self.server.store.get_messages(
184
 
                    parts[2], query_string)
185
 
                self.send_response(httplib.OK)
186
 
                self.end_headers()
187
 
                self.wfile.write(simplejson.dumps(response))
188
 
            except UnsupportedOrder:
 
68
        archive = os.path.split(path)[1]
 
69
        query = parse_qs(query_string)
 
70
        parameters = simplejson.loads(query['parameters'][0])
 
71
        messages = [m for m in self.server.messages[archive] if 'message_ids'
 
72
                    not in parameters or m['message_id'] in
 
73
                    parameters['message_ids']]
 
74
        if 'order' in parameters:
 
75
            if parameters['order'] not in SUPPORTED_ORDERS:
189
76
                self.send_response(httplib.BAD_REQUEST)
190
77
                self.wfile.write('Unsupported order')
191
78
                return
192
 
 
193
 
    def log_message(self, format, *args):
194
 
        message = "%s - - [%s] %s\n" % (
195
 
            self.address_string(), self.log_date_time_string(), format%args)
196
 
        self.logger.info(message)
 
79
            messages.sort(key=lambda m: m[parameters['order']])
 
80
        self.send_response(httplib.OK)
 
81
        self.end_headers()
 
82
        limit = parameters.get('limit', 100)
 
83
        memo = parameters.get('memo')
 
84
        message_id_indices = dict(
 
85
            (m['message_id'], idx) for idx, m in enumerate(messages))
 
86
        if memo is None:
 
87
            start = 0
 
88
        else:
 
89
            start = message_id_indices[memo.encode('rot13')]
 
90
        if start > 0:
 
91
            previous_memo = messages[start - 1]['message_id'].encode('rot13')
 
92
        else:
 
93
            previous_memo = None
 
94
        end = min(start + limit, len(messages))
 
95
        if end < len(messages):
 
96
            next_memo = messages[end]['message_id'].encode('rot13')
 
97
        else:
 
98
            next_memo = None
 
99
        messages = messages[start:end]
 
100
        response = {
 
101
            'messages': messages,
 
102
            'next_memo': next_memo,
 
103
            'previous_memo': previous_memo
 
104
            }
 
105
        self.wfile.write(simplejson.dumps(response))
 
106
 
 
107
 
 
108
def fake_grackle_service(client, messages=None):
 
109
    if messages is None:
 
110
        messages = {}
 
111
    return ForkedFake(client.port, messages)
197
112
 
198
113
 
199
114
class TestPutMessage(TestCase):
200
115
 
201
116
    def test_put_message(self):
202
117
        client = GrackleClient('localhost', 8436)
203
 
        with ForkedFake.from_client(client):
 
118
        with fake_grackle_service(client):
204
119
            client.put_message('arch1', 'asdf', StringIO('This is a message'))
205
120
            with ExpectedException(Exception, 'wtf'):
206
121
                client.put_message('arch1', 'asdf',
218
133
 
219
134
    def test_get_messages(self):
220
135
        client = GrackleClient('localhost', 8435)
221
 
        with ForkedFake.from_client(client,
 
136
        with fake_grackle_service(client,
222
137
            {'baz':
223
138
            [{'message_id': 'foo'},
224
139
             {'message_id': 'bar'}]}):
230
145
 
231
146
    def test_get_messages_by_id(self):
232
147
        client = GrackleClient('localhost', 8437)
233
 
        with ForkedFake.from_client(client,
 
148
        with fake_grackle_service(client,
234
149
            {'baz':
235
150
            [{'message_id': 'foo'},
236
151
             {'message_id': 'bar'}]}):
240
155
 
241
156
    def test_get_messages_batching(self):
242
157
        client = GrackleClient('localhost', 8438)
243
 
        with ForkedFake.from_client(client,
 
158
        with fake_grackle_service(client,
244
159
            {'baz':
245
160
            [{'message_id': 'foo'},
246
161
             {'message_id': 'bar'}]}):
253
168
            messages.extend(response['messages'])
254
169
            self.assertMessageIDs(['foo', 'bar'], messages)
255
170
 
256
 
    def get_messages_member_order_test(self, key):
 
171
    def test_get_messages_date_order(self):
257
172
        client = GrackleClient('localhost', 8439)
258
 
        with ForkedFake.from_client(client,
259
 
                {'baz': [{'message_id': 'foo', key: '2011-03-25'},
260
 
                 {'message_id': 'bar', key: '2011-03-24'}]}):
 
173
        with fake_grackle_service(client,
 
174
                {'baz': [{'message_id': 'foo', 'date': '2011-03-25'},
 
175
                 {'message_id': 'bar', 'date': '2011-03-24'}]}):
261
176
            response = client.get_messages('baz')
262
177
            self.assertIDOrder(['foo', 'bar'], response['messages'])
263
 
            response = client.get_messages('baz', order=key)
 
178
            response = client.get_messages('baz', order='date')
264
179
            self.assertIDOrder(['bar', 'foo'], response['messages'])
265
180
 
266
 
    def test_get_messages_date_order(self):
267
 
        self.get_messages_member_order_test('date')
268
 
 
269
 
    def test_get_messages_author_order(self):
270
 
        self.get_messages_member_order_test('author')
271
 
 
272
 
    def test_get_messages_subject_order(self):
273
 
        self.get_messages_member_order_test('subject')
274
 
 
275
 
    def test_get_messages_thread_subject_order(self):
276
 
        client = GrackleClient('localhost', 8439)
277
 
        with ForkedFake.from_client(client, {'baz': [
278
 
            {'message_id': 'bar', 'subject': 'y'},
279
 
            {'message_id': 'qux', 'subject': 'z'},
280
 
            {'message_id': 'foo', 'subject': 'x', 'in_reply_to': 'qux'},
281
 
            ]}):
282
 
            response = client.get_messages('baz')
283
 
            self.assertIDOrder(['bar', 'qux', 'foo'], response['messages'])
284
 
            response = client.get_messages('baz', order='subject')
285
 
            self.assertIDOrder(['foo', 'bar', 'qux'], response['messages'])
286
 
            response = client.get_messages('baz', order='thread_subject')
287
 
            self.assertIDOrder(['bar', 'qux', 'foo'], response['messages'])
288
 
 
289
 
    def test_get_messages_thread_oldest_order(self):
290
 
        client = GrackleClient('localhost', 8439)
291
 
        with ForkedFake.from_client(client, {'baz': [
292
 
            {'message_id': 'bar', 'date': 'x'},
293
 
            {'message_id': 'qux', 'date': 'z'},
294
 
            {'message_id': 'foo', 'date': 'y', 'in_reply_to': 'qux'},
295
 
            ]}):
296
 
            response = client.get_messages('baz')
297
 
            self.assertIDOrder(['bar', 'qux', 'foo'], response['messages'])
298
 
            response = client.get_messages('baz', order='date')
299
 
            self.assertIDOrder(['bar', 'foo', 'qux'], response['messages'])
300
 
            response = client.get_messages('baz', order='thread_oldest')
301
 
            self.assertIDOrder(['bar', 'qux', 'foo'], response['messages'])
302
 
 
303
 
    def test_get_messages_thread_newest_order(self):
304
 
        client = GrackleClient('localhost', 8439)
305
 
        with ForkedFake.from_client(client, {'baz': [
306
 
            {'message_id': 'bar', 'date': 'x'},
307
 
            {'message_id': 'qux', 'date': 'w'},
308
 
            {'message_id': 'foo', 'date': 'y', 'in_reply_to': 'bar'},
309
 
            {'message_id': 'baz', 'date': 'z', 'in_reply_to': 'qux'},
310
 
            ]}):
311
 
            response = client.get_messages('baz', order='date')
312
 
            self.assertIDOrder(
313
 
                ['qux', 'bar', 'foo', 'baz'], response['messages'])
314
 
            response = client.get_messages('baz', order='thread_newest')
315
 
            self.assertIDOrder(
316
 
                ['bar', 'foo', 'qux', 'baz'], response['messages'])
317
 
 
318
181
    def test_get_messages_unsupported_order(self):
319
182
        client = GrackleClient('localhost', 8439)
320
 
        with ForkedFake.from_client(client,
 
183
        with fake_grackle_service(client,
321
184
                {'baz': [{'message_id': 'foo', 'date': '2011-03-25'},
322
185
                 {'message_id': 'bar', 'date': '2011-03-24'}]}):
323
186
            with ExpectedException(UnsupportedOrder):
324
187
                client.get_messages('baz', order='nonsense')
325
 
 
326
 
    def test_get_messages_headers_no_headers(self):
327
 
        client = GrackleClient('localhost', 8440)
328
 
        with ForkedFake.from_client(client,
329
 
            {'baz': [
330
 
                {'message_id': 'foo'}
331
 
            ]}):
332
 
            response = client.get_messages('baz', headers=[
333
 
                'Subject', 'Date', 'X-Launchpad-Message-Rationale'])
334
 
        first_message = response['messages'][0]
335
 
        self.assertEqual('foo', first_message['message_id'])
336
 
        self.assertEqual({}, first_message['headers'])
337
 
 
338
 
    def test_get_messages_headers_exclude_headers(self):
339
 
        client = GrackleClient('localhost', 8441)
340
 
        with ForkedFake.from_client(client,
341
 
            {'baz': [
342
 
                {'message_id': 'foo', 'headers': {'From': 'me'}}
343
 
            ]}):
344
 
            response = client.get_messages('baz', headers=[
345
 
                'Subject', 'Date', 'X-Launchpad-Message-Rationale'])
346
 
        first_message = response['messages'][0]
347
 
        self.assertEqual('foo', first_message['message_id'])
348
 
        self.assertEqual({}, first_message['headers'])
349
 
 
350
 
    def test_get_messages_headers_include_headers(self):
351
 
        client = GrackleClient('localhost', 8442)
352
 
        with ForkedFake.from_client(client,
353
 
            {'baz': [
354
 
                {'message_id': 'foo', 'headers': {'From': 'me', 'To': 'you'}}
355
 
            ]}):
356
 
            response = client.get_messages('baz', headers=[
357
 
                'From', 'To'])
358
 
        first_message = response['messages'][0]
359
 
        self.assertEqual('foo', first_message['message_id'])
360
 
        self.assertEqual({'From': 'me', 'To': 'you'}, first_message['headers'])
361
 
 
362
 
    def test_get_messages_max_body_length(self):
363
 
        client = GrackleClient('localhost', 8443)
364
 
        with ForkedFake.from_client(client,
365
 
            {'baz': [
366
 
                {'message_id': 'foo', 'body': u'abcdefghi'}
367
 
            ]}):
368
 
            response = client.get_messages('baz', max_body_length=3)
369
 
        first_message = response['messages'][0]
370
 
        self.assertEqual('abc', first_message['body'])
371
 
 
372
 
    def test_include_hidden(self):
373
 
        client = GrackleClient('localhost', 8444)
374
 
        with ForkedFake.from_client(client,
375
 
            {'baz': [
376
 
                {'message_id': 'foo', 'hidden': True},
377
 
                {'message_id': 'bar', 'hidden': False}
378
 
            ]}):
379
 
            response = client.get_messages('baz', include_hidden=True)
380
 
            self.assertMessageIDs(['bar', 'foo'], response['messages'])
381
 
            response = client.get_messages('baz', include_hidden=False)
382
 
            self.assertMessageIDs(['bar'], response['messages'])
383