~didrocks/unity/altf10

« back to all changes in this revision

Viewing changes to grackle/tests/test_client.py

  • Committer: William Grant
  • Date: 2012-01-25 06:19:56 UTC
  • Revision ID: william.grant@canonical.com-20120125061956-4tltjt6a4xf5yufj
Fix test.

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
    HTTPServer,
3
3
    BaseHTTPRequestHandler,
4
4
    )
5
 
from email.message import Message
6
 
from email.mime.multipart import MIMEMultipart
7
 
from email.mime.text import MIMEText
8
5
import httplib
9
6
import logging
10
7
import os
14
11
import sys
15
12
from unittest import TestCase
16
13
from urlparse import urlparse
 
14
from urlparse import parse_qs
17
15
 
18
16
from testtools import ExpectedException
19
17
 
20
18
from grackle.client import (
21
19
    GrackleClient,
22
 
    UnparsableDateRange,
23
 
    UnsupportedDisplayType,
24
20
    UnsupportedOrder,
25
21
    )
26
 
from grackle.store import (
27
 
    make_json_message,
28
 
    MemoryStore,
29
 
    )
30
 
 
31
 
 
32
 
def make_message(message_id, body='body', headers=None, hidden=False):
33
 
    if headers is None:
34
 
        headers = {}
35
 
    message_headers = {
36
 
        'Message-Id': message_id,
37
 
        'date': '2005-01-01',
38
 
        'subject': 'subject',
39
 
        'from': 'author',
40
 
        'replies': '',
41
 
        }
42
 
    message_headers.update(headers.items())
43
 
    message = Message()
44
 
    message.set_payload(body)
45
 
    for key, value in message_headers.items():
46
 
        message[key] = value
47
 
    return make_json_message(message_id, message.as_string(), hidden)
48
 
 
49
 
 
50
 
def make_mime_message(message_id, body='body', headers=None, hidden=False,
51
 
                      attachment_type=None):
52
 
    parts = MIMEMultipart()
53
 
    parts.attach(MIMEText(body))
54
 
    if attachment_type is not None:
55
 
        attachment = Message()
56
 
        attachment.set_payload('attactment data.')
57
 
        attachment['Content-Type'] = attachment_type
58
 
        attachment['Content-Disposition'] = 'attachment; filename="file.ext"'
59
 
        parts.attach(attachment)
60
 
    return make_message(message_id, parts.as_string(), headers, hidden)
61
 
 
62
 
 
63
 
class ForkedFakeService:
 
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
    """A memory-backed message store."""
 
41
 
 
42
    def __init__(self, messages):
 
43
        """Constructor."""
 
44
        self.messages = messages
 
45
 
 
46
    def get_messages(self, archive_id, query_string):
 
47
        """Return matching messages.
 
48
 
 
49
        :param archive_id: The archive to retrieve from.
 
50
        :param query_string: Contains 'parameters', which is a JSON-format
 
51
            string describing parameters.
 
52
        """
 
53
        query = parse_qs(query_string)
 
54
        parameters = simplejson.loads(query['parameters'][0])
 
55
        order = parameters.get('order')
 
56
        messages = self.messages[archive_id]
 
57
        if order is not None :
 
58
            if order not in SUPPORTED_ORDERS:
 
59
                raise UnsupportedOrder
 
60
            elif order.startswith('thread_'):
 
61
                threaded = threaded_messages(messages)
 
62
                messages = []
 
63
                if order == 'thread_subject':
 
64
                    threaded.sort(key=lambda t: t[0]['subject'])
 
65
                if order == 'thread_oldest':
 
66
                    threaded.sort(key=lambda t: min(m['date'] for m in t))
 
67
                if order == 'thread_newest':
 
68
                    threaded.sort(key=lambda t: max(m['date'] for m in t))
 
69
                for thread in threaded:
 
70
                    messages.extend(thread)
 
71
            else:
 
72
                messages.sort(key=lambda m: m[order])
 
73
        new_messages = []
 
74
        for message in messages:
 
75
            if (
 
76
                not parameters['include_hidden']
 
77
                and message.get('hidden', False)):
 
78
                continue
 
79
 
 
80
            if ('message_ids' in parameters and
 
81
                message['message_id'] not in parameters['message_ids']):
 
82
                continue
 
83
            message = dict(message)
 
84
            if 'headers' in parameters:
 
85
                headers = dict(
 
86
                    (k, v) for k, v in message['headers'].iteritems()
 
87
                    if k in parameters['headers'])
 
88
                message['headers'] = headers
 
89
            max_body = parameters.get('max_body_length')
 
90
            if max_body is not None:
 
91
                message['body'] = message['body'][:max_body]
 
92
            new_messages.append(message)
 
93
        messages = new_messages
 
94
        limit = parameters.get('limit', 100)
 
95
        memo = parameters.get('memo')
 
96
        message_id_indices = dict(
 
97
            (m['message_id'], idx) for idx, m in enumerate(messages))
 
98
        if memo is None:
 
99
            start = 0
 
100
        else:
 
101
            start = message_id_indices[memo.encode('rot13')]
 
102
        if start > 0:
 
103
            previous_memo = messages[start - 1]['message_id'].encode('rot13')
 
104
        else:
 
105
            previous_memo = None
 
106
        end = min(start + limit, len(messages))
 
107
        if end < len(messages):
 
108
            next_memo = messages[end]['message_id'].encode('rot13')
 
109
        else:
 
110
            next_memo = None
 
111
        messages = messages[start:end]
 
112
 
 
113
        response = {
 
114
            'messages': messages,
 
115
            'next_memo': next_memo,
 
116
            'previous_memo': previous_memo
 
117
            }
 
118
        return response
 
119
 
 
120
 
 
121
 
 
122
class ForkedFake:
64
123
    """A Grackle service fake, as a ContextManager."""
65
124
 
66
 
    def __init__(self, port, message_archives=None, write_logs=False):
 
125
    def __init__(self, port, messages=None, write_logs=False):
67
126
        """Constructor.
68
 
 
69
 
        :param port: The tcp port to use.
70
 
        :param message_archives: A dict of lists of dicts representing
71
 
            archives of messages. The outer dict represents the archive,
72
 
            the list represents the list of messages for that archive.
 
127
        :param port: The tcp port to use
 
128
        :param messages: A dict of lists of dicts representing messages.  The
 
129
            outer dict represents the archive, the list represents the list of
 
130
            messages for that archive.
73
131
        :param write_logs: If true, log messages will be written to stdout.
74
132
        """
75
133
        self.pid = None
76
134
        self.port = port
77
 
        if message_archives is None:
78
 
            self.message_archives = {}
 
135
        if messages is None:
 
136
            self.messages = {}
79
137
        else:
80
 
            self.message_archives = message_archives
 
138
            self.messages = messages
81
139
        self.read_end, self.write_end = os.pipe()
82
140
        self.write_logs = write_logs
83
141
 
84
142
    @staticmethod
85
 
    def from_client(client, message_archives=None):
86
 
        """Instantiate a ForkedFakeService from the client.
 
143
    def from_client(client, messages=None):
 
144
        """Instantiate a ForkedFake from the client.
87
145
 
88
 
        :param port: The client to provide service for.
89
 
        :param message_archives: A dict of lists of dicts representing
90
 
            archives of messages. The outer dict represents the archive,
91
 
            the list represents the list of messages for that archive.
 
146
        :param port: The client  to provide service for.
 
147
        :param messages: A dict of lists of dicts representing messages.  The
 
148
            outer dict represents the archive, the list represents the list of
 
149
            messages for that archive.
92
150
        """
93
 
        return ForkedFakeService(client.port, message_archives)
 
151
        return ForkedFake(client.port, messages)
94
152
 
95
153
    def is_ready(self):
96
154
        """Tell the parent process that the server is ready for writes."""
111
169
    def start_server(self):
112
170
        """Start the HTTP server."""
113
171
        service = HTTPServer(('', self.port), FakeGrackleRequestHandler)
114
 
        service.store = MemoryStore(self.message_archives)
115
 
        for archive_id, messages in service.store.message_archives.iteritems():
 
172
        service.store = GrackleStore(self.messages)
 
173
        for archive_id, messages in service.store.messages.iteritems():
116
174
            for message in messages:
117
175
                message.setdefault('headers', {})
118
176
        self.is_ready()
125
183
        os.kill(self.pid, SIGKILL)
126
184
 
127
185
 
 
186
SUPPORTED_ORDERS = set(
 
187
    ['date', 'author', 'subject', 'thread_newest', 'thread_oldest',
 
188
     'thread_subject'])
 
189
 
 
190
 
128
191
class FakeGrackleRequestHandler(BaseHTTPRequestHandler):
129
192
    """A request handler that forwards to server.store."""
130
193
 
135
198
 
136
199
    def do_POST(self):
137
200
        """Create a message on POST."""
138
 
        scheme, netloc, path, params, query_string, fragments = (
139
 
            urlparse(self.path))
140
 
        parts = path.split('/')
141
 
        if parts[1] != 'archive':
142
 
            # This is an unknonwn operation?
143
 
            return
144
 
        if 'content-length' in self.headers:
145
 
            operation = 'put_message'
 
201
        message = self.rfile.read(int(self.headers['content-length']))
 
202
        if message == 'This is a message':
 
203
            self.send_response(httplib.CREATED)
 
204
            self.end_headers()
 
205
            self.wfile.close()
146
206
        else:
147
 
            operation = 'hide_message'
148
 
        if operation == 'put_message':
149
 
            message = self.rfile.read(int(self.headers['content-length']))
150
 
            try:
151
 
                # This expected path is /archive/archive_id/message_id.
152
 
                self.server.store.put_message(parts[2], parts[3], message)
153
 
                self.send_response(httplib.CREATED)
154
 
                self.end_headers()
155
 
                self.wfile.close()
156
 
            except:
157
 
                self.send_error(httplib.BAD_REQUEST)
158
 
        elif operation == 'hide_message':
159
 
            try:
160
 
                # This expected path is /archive/archive_id/message_id.
161
 
                response = self.server.store.hide_message(
162
 
                    parts[2], parts[3], query_string)
163
 
                self.send_response(httplib.OK)
164
 
                self.end_headers()
165
 
                self.wfile.write(simplejson.dumps(response))
166
 
            except:
167
 
                self.send_error(httplib.BAD_REQUEST)
 
207
            self.send_error(httplib.BAD_REQUEST)
168
208
 
169
209
    def do_GET(self):
170
210
        """Retrieve a list of messages on GET."""
178
218
                self.send_response(httplib.OK)
179
219
                self.end_headers()
180
220
                self.wfile.write(simplejson.dumps(response))
181
 
            except Exception, error:
182
 
                self.send_response(
183
 
                    httplib.BAD_REQUEST, error.__doc__)
 
221
            except UnsupportedOrder:
 
222
                self.send_response(httplib.BAD_REQUEST)
 
223
                self.wfile.write('Unsupported order')
184
224
                return
185
225
 
186
226
    def log_message(self, format, *args):
187
227
        """Override log_message to use standard Python logging."""
188
228
        message = "%s - - [%s] %s\n" % (
189
 
            self.address_string(), self.log_date_time_string(), format % args)
 
229
            self.address_string(), self.log_date_time_string(), format%args)
190
230
        self.logger.info(message)
191
231
 
192
232
 
193
233
class TestPutMessage(TestCase):
194
234
 
195
235
    def test_put_message(self):
196
 
        client = GrackleClient('localhost', 8420)
197
 
        message_archives = {'arch1': []}
198
 
        with ForkedFakeService.from_client(client, message_archives):
199
 
            client.put_message('arch1', 'id1', StringIO('This is a message'))
200
 
            response = client.get_messages('arch1')
201
 
        self.assertEqual(1, len(response['messages']))
202
 
        message = response['messages'][0]
203
 
        self.assertEqual('id1', message['message_id'])
204
 
 
205
 
    def test_put_message_without_archive(self):
206
 
        client = GrackleClient('localhost', 8421)
207
 
        message_archives = {'arch1': []}
208
 
        with ForkedFakeService.from_client(client, message_archives):
 
236
        client = GrackleClient('localhost', 8436)
 
237
        with ForkedFake.from_client(client):
 
238
            client.put_message('arch1', 'asdf', StringIO('This is a message'))
209
239
            with ExpectedException(Exception, 'wtf'):
210
 
                client.put_message('no-archive', 'id1', StringIO('message'))
 
240
                client.put_message('arch1', 'asdf',
 
241
                    StringIO('This is not a message'))
211
242
 
212
243
 
213
244
class TestGetMessages(TestCase):
217
248
 
218
249
    def assertMessageIDs(self, ids, messages):
219
250
        self.assertIDOrder(
220
 
            sorted(ids), sorted(messages, key=lambda m: m['message_id']))
 
251
            sorted(ids), sorted(messages, key=lambda m:m['message_id']))
221
252
 
222
253
    def test_get_messages(self):
223
 
        client = GrackleClient('localhost', 8430)
224
 
        archive = {
225
 
            'baz': [make_message('foo'), make_message('bar')]}
226
 
        with ForkedFakeService.from_client(client, archive):
 
254
        client = GrackleClient('localhost', 8435)
 
255
        with ForkedFake.from_client(client,
 
256
            {'baz':
 
257
            [{'message_id': 'foo'},
 
258
             {'message_id': 'bar'}]}):
227
259
            response = client.get_messages('baz')
228
260
        self.assertEqual(['bar', 'foo'], sorted(m['message_id'] for m in
229
261
            response['messages']))
232
264
 
233
265
    def test_get_messages_by_id(self):
234
266
        client = GrackleClient('localhost', 8437)
235
 
        archive = {
236
 
            'baz': [make_message('foo'), make_message('bar')]}
237
 
        with ForkedFakeService.from_client(client, archive):
 
267
        with ForkedFake.from_client(client,
 
268
            {'baz':
 
269
            [{'message_id': 'foo'},
 
270
             {'message_id': 'bar'}]}):
238
271
            response = client.get_messages('baz', message_ids=['foo'])
239
272
        message, = response['messages']
240
273
        self.assertEqual('foo', message['message_id'])
241
274
 
242
275
    def test_get_messages_batching(self):
243
276
        client = GrackleClient('localhost', 8438)
244
 
        archive = {'baz': [make_message('foo'), make_message('bar')]}
245
 
        with ForkedFakeService.from_client(client, archive):
 
277
        with ForkedFake.from_client(client,
 
278
            {'baz':
 
279
            [{'message_id': 'foo'},
 
280
             {'message_id': 'bar'}]}):
246
281
            response = client.get_messages('baz', limit=1)
247
282
            self.assertEqual(1, len(response['messages']))
248
283
            messages = response['messages']
254
289
 
255
290
    def get_messages_member_order_test(self, key):
256
291
        client = GrackleClient('localhost', 8439)
257
 
        if key == 'author':
258
 
            header_name = 'from'
259
 
        else:
260
 
            header_name = key
261
 
        archive = {
262
 
            'baz': [
263
 
                make_message('foo', headers={header_name: '2011-03-25'}),
264
 
                make_message('bar', headers={header_name: '2011-03-24'}),
265
 
             ]}
266
 
        with ForkedFakeService.from_client(client, archive):
 
292
        with ForkedFake.from_client(client,
 
293
                {'baz': [{'message_id': 'foo', key: '2011-03-25'},
 
294
                 {'message_id': 'bar', key: '2011-03-24'}]}):
267
295
            response = client.get_messages('baz')
268
296
            self.assertIDOrder(['foo', 'bar'], response['messages'])
269
297
            response = client.get_messages('baz', order=key)
279
307
        self.get_messages_member_order_test('subject')
280
308
 
281
309
    def test_get_messages_thread_subject_order(self):
282
 
        archive = {
283
 
            'baz': [
284
 
                make_message('bar', headers={'subject': 'y'}),
285
 
                make_message('qux', headers={'subject': 'z'}),
286
 
                make_message('foo', headers={'subject': 'x',
287
 
                                             'in-reply-to': 'qux'}),
288
 
             ]}
289
310
        client = GrackleClient('localhost', 8439)
290
 
        with ForkedFakeService.from_client(client, archive):
 
311
        with ForkedFake.from_client(client, {'baz': [
 
312
            {'message_id': 'bar', 'subject': 'y'},
 
313
            {'message_id': 'qux', 'subject': 'z'},
 
314
            {'message_id': 'foo', 'subject': 'x', 'in_reply_to': 'qux'},
 
315
            ]}):
291
316
            response = client.get_messages('baz')
292
317
            self.assertIDOrder(['bar', 'qux', 'foo'], response['messages'])
293
318
            response = client.get_messages('baz', order='subject')
297
322
 
298
323
    def test_get_messages_thread_oldest_order(self):
299
324
        client = GrackleClient('localhost', 8439)
300
 
        archive = {
301
 
            'baz': [
302
 
                make_message('bar', headers={'date': 'x'}),
303
 
                make_message('qux', headers={'date': 'z'}),
304
 
                make_message('foo', headers={'date': 'y',
305
 
                                             'in-reply-to': 'qux'}),
306
 
            ]}
307
 
        with ForkedFakeService.from_client(client, archive):
 
325
        with ForkedFake.from_client(client, {'baz': [
 
326
            {'message_id': 'bar', 'date': 'x'},
 
327
            {'message_id': 'qux', 'date': 'z'},
 
328
            {'message_id': 'foo', 'date': 'y', 'in_reply_to': 'qux'},
 
329
            ]}):
308
330
            response = client.get_messages('baz')
309
331
            self.assertIDOrder(['bar', 'qux', 'foo'], response['messages'])
310
332
            response = client.get_messages('baz', order='date')
314
336
 
315
337
    def test_get_messages_thread_newest_order(self):
316
338
        client = GrackleClient('localhost', 8439)
317
 
        archive = {
318
 
            'baz': [
319
 
                make_message('bar', headers={'date': 'x'}),
320
 
                make_message('qux', headers={'date': 'w'}),
321
 
                make_message('foo', headers={'date': 'y',
322
 
                                             'in-reply-to': 'bar'}),
323
 
                make_message('baz', headers={'date': 'z',
324
 
                                             'in-reply-to': 'qux'}),
325
 
            ]}
326
 
        with ForkedFakeService.from_client(client, archive):
 
339
        with ForkedFake.from_client(client, {'baz': [
 
340
            {'message_id': 'bar', 'date': 'x'},
 
341
            {'message_id': 'qux', 'date': 'w'},
 
342
            {'message_id': 'foo', 'date': 'y', 'in_reply_to': 'bar'},
 
343
            {'message_id': 'baz', 'date': 'z', 'in_reply_to': 'qux'},
 
344
            ]}):
327
345
            response = client.get_messages('baz', order='date')
328
346
            self.assertIDOrder(
329
347
                ['qux', 'bar', 'foo', 'baz'], response['messages'])
333
351
 
334
352
    def test_get_messages_unsupported_order(self):
335
353
        client = GrackleClient('localhost', 8439)
336
 
        archive = {
337
 
            'baz': [
338
 
                make_message('foo', headers={'date': '2011-03-25'}),
339
 
                make_message('foo', headers={'date': '2011-03-24'}),
340
 
            ]}
341
 
        with ForkedFakeService.from_client(client, archive):
 
354
        with ForkedFake.from_client(client,
 
355
                {'baz': [{'message_id': 'foo', 'date': '2011-03-25'},
 
356
                 {'message_id': 'bar', 'date': '2011-03-24'}]}):
342
357
            with ExpectedException(UnsupportedOrder, ''):
343
358
                client.get_messages('baz', order='nonsense')
344
359
 
345
360
    def test_get_messages_headers_no_headers(self):
346
361
        client = GrackleClient('localhost', 8440)
347
 
        archive = {'baz': [make_message('foo')]}
348
 
        with ForkedFakeService.from_client(client, archive):
 
362
        with ForkedFake.from_client(client,
 
363
            {'baz': [
 
364
                {'message_id': 'foo'}
 
365
            ]}):
349
366
            response = client.get_messages('baz', headers=[
350
367
                'Subject', 'Date', 'X-Launchpad-Message-Rationale'])
351
368
        first_message = response['messages'][0]
354
371
 
355
372
    def test_get_messages_headers_exclude_headers(self):
356
373
        client = GrackleClient('localhost', 8441)
357
 
        archive = {
358
 
            'baz': [make_message('foo', headers={'From': 'me'})]}
359
 
        with ForkedFakeService.from_client(client, archive):
 
374
        with ForkedFake.from_client(client,
 
375
            {'baz': [
 
376
                {'message_id': 'foo', 'headers': {'From': 'me'}}
 
377
            ]}):
360
378
            response = client.get_messages('baz', headers=[
361
379
                'Subject', 'Date', 'X-Launchpad-Message-Rationale'])
362
380
        first_message = response['messages'][0]
365
383
 
366
384
    def test_get_messages_headers_include_headers(self):
367
385
        client = GrackleClient('localhost', 8442)
368
 
        archive = {
369
 
            'baz': [
370
 
                make_message('foo', headers={'From': 'me', 'To': 'you'})]}
371
 
        with ForkedFakeService.from_client(client, archive):
 
386
        with ForkedFake.from_client(client,
 
387
            {'baz': [
 
388
                {'message_id': 'foo', 'headers': {'From': 'me', 'To': 'you'}}
 
389
            ]}):
372
390
            response = client.get_messages('baz', headers=[
373
391
                'From', 'To'])
374
392
        first_message = response['messages'][0]
377
395
 
378
396
    def test_get_messages_max_body_length(self):
379
397
        client = GrackleClient('localhost', 8443)
380
 
        archive = {'baz': [make_message('foo', body=u'abcdefghi')]}
381
 
        with ForkedFakeService.from_client(client, archive):
 
398
        with ForkedFake.from_client(client,
 
399
            {'baz': [
 
400
                {'message_id': 'foo', 'body': u'abcdefghi'}
 
401
            ]}):
382
402
            response = client.get_messages('baz', max_body_length=3)
383
403
        first_message = response['messages'][0]
384
404
        self.assertEqual('abc', first_message['body'])
385
405
 
386
406
    def test_include_hidden(self):
387
407
        client = GrackleClient('localhost', 8444)
388
 
        archive = {
389
 
            'baz': [
390
 
                make_message('foo', hidden=True),
391
 
                make_message('bar', hidden=False),
392
 
            ]}
393
 
        with ForkedFakeService.from_client(client, archive):
 
408
        with ForkedFake.from_client(client,
 
409
            {'baz': [
 
410
                {'message_id': 'foo', 'hidden': True},
 
411
                {'message_id': 'bar', 'hidden': False}
 
412
            ]}):
394
413
            response = client.get_messages('baz', include_hidden=True)
395
414
            self.assertMessageIDs(['bar', 'foo'], response['messages'])
396
415
            response = client.get_messages('baz', include_hidden=False)
397
416
            self.assertMessageIDs(['bar'], response['messages'])
398
417
 
399
 
    def test_display_type_unknown_value(self):
400
 
        client = GrackleClient('localhost', 8445)
401
 
        archive = {'baz': [make_message('foo', body=u'abcdefghi')]}
402
 
        with ForkedFakeService.from_client(client, archive):
403
 
            with ExpectedException(UnsupportedDisplayType, ''):
404
 
                client.get_messages('baz', display_type='unknown')
405
 
 
406
 
    def test_display_type_headers_only(self):
407
 
        client = GrackleClient('localhost', 8446)
408
 
        archive = {
409
 
            'baz': [
410
 
                make_message('foo', body=u'abcdefghi',
411
 
                             headers={'From': 'me', 'To': 'you'})]}
412
 
        with ForkedFakeService.from_client(client, archive):
413
 
            response = client.get_messages('baz', display_type='headers-only')
414
 
        first_message = response['messages'][0]
415
 
        self.assertEqual('foo', first_message['message_id'])
416
 
        self.assertEqual(
417
 
            archive['baz'][0]['headers'], first_message['headers'])
418
 
        self.assertNotIn('body', first_message)
419
 
 
420
 
    def test_display_type_text_only(self):
421
 
        client = GrackleClient('localhost', 8446)
422
 
        archive = {
423
 
            'baz': [
424
 
                make_mime_message(
425
 
                    'foo', 'abcdefghi',
426
 
                    headers={'From': 'me', 'To': 'you'},
427
 
                    attachment_type='text/x-diff')]}
428
 
        with ForkedFakeService.from_client(client, archive):
429
 
            response = client.get_messages('baz', display_type='text-only')
430
 
        first_message = response['messages'][0]
431
 
        self.assertEqual('foo', first_message['message_id'])
432
 
        self.assertEqual('me', first_message['headers']['From'])
433
 
        self.assertEqual('you', first_message['headers']['To'])
434
 
        self.assertEqual(archive['baz'][0]['body'], first_message['body'])
435
 
 
436
 
    def test_display_type_all(self):
437
 
        client = GrackleClient('localhost', 8447)
438
 
        archive = {
439
 
            'baz': [
440
 
                make_mime_message(
441
 
                    'foo', 'abcdefghi',
442
 
                    headers={'From': 'me', 'To': 'you'},
443
 
                    attachment_type='text/x-diff')]}
444
 
        with ForkedFakeService.from_client(client, archive):
445
 
            response = client.get_messages('baz', display_type='all')
446
 
        first_message = response['messages'][0]
447
 
        self.assertEqual('foo', first_message['message_id'])
448
 
        self.assertEqual('me', first_message['headers']['From'])
449
 
        self.assertEqual('you', first_message['headers']['To'])
450
 
        self.assertEqual(archive['baz'][0]['body'], first_message['body'])
451
 
 
452
 
    def test_date_range(self):
453
 
        client = GrackleClient('localhost', 8448)
454
 
        archive = {
455
 
            'baz': [
456
 
                make_mime_message(
457
 
                    'foo', 'abcdefghi', headers={'date': '2011-12-31'}),
458
 
                make_mime_message(
459
 
                    'bar', 'abcdefghi', headers={'date': '2012-01-01'}),
460
 
                make_mime_message(
461
 
                    'qux', 'abcdefghi', headers={'date': '2012-01-15'}),
462
 
                make_mime_message(
463
 
                    'naf', 'abcdefghi', headers={'date': '2012-01-31'}),
464
 
                make_mime_message(
465
 
                    'doh', 'abcdefghi', headers={'date': '2012-02-01'}),
466
 
                    ]}
467
 
        with ForkedFakeService.from_client(client, archive):
468
 
            response = client.get_messages(
469
 
                'baz', date_range='2012-01-01..2012-01-31')
470
 
        ids = sorted(m['message_id'] for m in response['messages'])
471
 
        self.assertEqual(['bar', 'naf', 'qux'], ids)
472
 
 
473
 
    def test_date_range_unparsabledaterange(self):
474
 
        client = GrackleClient('localhost', 8449)
475
 
        archive = {'baz': [make_message('foo', body=u'abcdefghi')]}
476
 
        with ForkedFakeService.from_client(client, archive):
477
 
            with ExpectedException(UnparsableDateRange, ''):
478
 
                client.get_messages('baz', date_range='2012-01-01')
479
 
 
480
 
    def test_date_range_unparsabledaterange_missing_part(self):
481
 
        client = GrackleClient('localhost', 8450)
482
 
        archive = {'baz': [make_message('foo', body=u'abcdefghi')]}
483
 
        with ForkedFakeService.from_client(client, archive):
484
 
            with ExpectedException(UnparsableDateRange, ''):
485
 
                client.get_messages('baz', date_range='2012-01-01..')
486
 
 
487
 
    def test_date_range_unparsabledaterange_extra_part(self):
488
 
        client = GrackleClient('localhost', 8451)
489
 
        archive = {'baz': [make_message('foo', body=u'abcdefghi')]}
490
 
        with ForkedFakeService.from_client(client, archive):
491
 
            with ExpectedException(UnparsableDateRange, ''):
492
 
                client.get_messages('baz', date_range='2012-01..12-02..12-03')
493
 
 
494
 
 
495
 
class TestHideMessages(TestCase):
496
 
 
497
 
    def test_hide_message_true(self):
498
 
        client = GrackleClient('localhost', 8470)
499
 
        archive = {
500
 
            'baz': [
501
 
                make_message('foo', hidden=False),
502
 
            ]}
503
 
        with ForkedFakeService.from_client(client, archive):
504
 
            response = client.hide_message('baz', 'foo', hidden=True)
505
 
        self.assertEqual('foo', response['message_id'])
506
 
        self.assertIs(True, response['hidden'])
507
 
 
508
 
    def test_hide_message_false(self):
509
 
        client = GrackleClient('localhost', 8470)
510
 
        archive = {
511
 
            'baz': [
512
 
                make_message('foo', hidden=True),
513
 
            ]}
514
 
        with ForkedFakeService.from_client(client, archive):
515
 
            response = client.hide_message('baz', 'foo', hidden=False)
516
 
        self.assertEqual('foo', response['message_id'])
517
 
        self.assertIs(False, response['hidden'])