blob: 7dc5216f8bbc2252a721d1b342a2ee42e0da8ddc [file] [log] [blame]
Fred Drake0aaed272000-10-23 13:39:15 +00001import os
Neal Norwitz003c9e22006-08-11 06:09:41 +00002import sys
Fred Drakec02bc3e2001-05-21 20:23:21 +00003import time
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00004import stat
5import socket
6import email
7import email.Message
8import rfc822
9import re
10import StringIO
Barry Warsaw04f357c2002-07-23 19:04:11 +000011from test import test_support
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000012import unittest
13import mailbox
14import glob
Guido van Rossum75ebb292001-04-10 15:01:20 +000015try:
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000016 import fcntl
17except ImportError:
Guido van Rossum75ebb292001-04-10 15:01:20 +000018 pass
19
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000020
21class TestBase(unittest.TestCase):
22
23 def _check_sample(self, msg):
24 # Inspect a mailbox.Message representation of the sample message
25 self.assert_(isinstance(msg, email.Message.Message))
26 self.assert_(isinstance(msg, mailbox.Message))
27 for key, value in _sample_headers.iteritems():
28 self.assert_(value in msg.get_all(key))
29 self.assert_(msg.is_multipart())
30 self.assert_(len(msg.get_payload()) == len(_sample_payloads))
31 for i, payload in enumerate(_sample_payloads):
32 part = msg.get_payload(i)
33 self.assert_(isinstance(part, email.Message.Message))
34 self.assert_(not isinstance(part, mailbox.Message))
35 self.assert_(part.get_payload() == payload)
36
37 def _delete_recursively(self, target):
38 # Delete a file or delete a directory recursively
39 if os.path.isdir(target):
40 for path, dirs, files in os.walk(target, topdown=False):
41 for name in files:
42 os.remove(os.path.join(path, name))
43 for name in dirs:
44 os.rmdir(os.path.join(path, name))
45 os.rmdir(target)
46 elif os.path.exists(target):
47 os.remove(target)
48
49
50class TestMailbox(TestBase):
51
52 _factory = None # Overridden by subclasses to reuse tests
53 _template = 'From: foo\n\n%s'
54
55 def setUp(self):
56 self._path = test_support.TESTFN
57 self._box = self._factory(self._path)
58
59 def tearDown(self):
60 self._box.close()
61 self._delete_recursively(self._path)
62
63 def test_add(self):
64 # Add copies of a sample message
65 keys = []
66 keys.append(self._box.add(self._template % 0))
67 self.assert_(len(self._box) == 1)
68 keys.append(self._box.add(mailbox.Message(_sample_message)))
69 self.assert_(len(self._box) == 2)
70 keys.append(self._box.add(email.message_from_string(_sample_message)))
71 self.assert_(len(self._box) == 3)
72 keys.append(self._box.add(StringIO.StringIO(_sample_message)))
73 self.assert_(len(self._box) == 4)
74 keys.append(self._box.add(_sample_message))
75 self.assert_(len(self._box) == 5)
76 self.assert_(self._box.get_string(keys[0]) == self._template % 0)
77 for i in (1, 2, 3, 4):
78 self._check_sample(self._box[keys[i]])
79
80 def test_remove(self):
81 # Remove messages using remove()
82 self._test_remove_or_delitem(self._box.remove)
83
84 def test_delitem(self):
85 # Remove messages using __delitem__()
86 self._test_remove_or_delitem(self._box.__delitem__)
87
88 def _test_remove_or_delitem(self, method):
89 # (Used by test_remove() and test_delitem().)
90 key0 = self._box.add(self._template % 0)
91 key1 = self._box.add(self._template % 1)
92 self.assert_(len(self._box) == 2)
93 method(key0)
94 l = len(self._box)
95 self.assert_(l == 1, "actual l: %s" % l)
96 self.assertRaises(KeyError, lambda: self._box[key0])
97 self.assertRaises(KeyError, lambda: method(key0))
98 self.assert_(self._box.get_string(key1) == self._template % 1)
99 key2 = self._box.add(self._template % 2)
100 self.assert_(len(self._box) == 2)
101 method(key2)
102 l = len(self._box)
103 self.assert_(l == 1, "actual l: %s" % l)
104 self.assertRaises(KeyError, lambda: self._box[key2])
105 self.assertRaises(KeyError, lambda: method(key2))
106 self.assert_(self._box.get_string(key1) == self._template % 1)
107 method(key1)
108 self.assert_(len(self._box) == 0)
109 self.assertRaises(KeyError, lambda: self._box[key1])
110 self.assertRaises(KeyError, lambda: method(key1))
111
112 def test_discard(self, repetitions=10):
113 # Discard messages
114 key0 = self._box.add(self._template % 0)
115 key1 = self._box.add(self._template % 1)
116 self.assert_(len(self._box) == 2)
117 self._box.discard(key0)
118 self.assert_(len(self._box) == 1)
119 self.assertRaises(KeyError, lambda: self._box[key0])
120 self._box.discard(key0)
121 self.assert_(len(self._box) == 1)
122 self.assertRaises(KeyError, lambda: self._box[key0])
123
124 def test_get(self):
125 # Retrieve messages using get()
126 key0 = self._box.add(self._template % 0)
127 msg = self._box.get(key0)
128 self.assert_(msg['from'] == 'foo')
129 self.assert_(msg.get_payload() == '0')
130 self.assert_(self._box.get('foo') is None)
131 self.assert_(self._box.get('foo', False) is False)
132 self._box.close()
133 self._box = self._factory(self._path, factory=rfc822.Message)
134 key1 = self._box.add(self._template % 1)
135 msg = self._box.get(key1)
136 self.assert_(msg['from'] == 'foo')
137 self.assert_(msg.fp.read() == '1')
138
139 def test_getitem(self):
140 # Retrieve message using __getitem__()
141 key0 = self._box.add(self._template % 0)
142 msg = self._box[key0]
143 self.assert_(msg['from'] == 'foo')
144 self.assert_(msg.get_payload() == '0')
145 self.assertRaises(KeyError, lambda: self._box['foo'])
146 self._box.discard(key0)
147 self.assertRaises(KeyError, lambda: self._box[key0])
148
149 def test_get_message(self):
150 # Get Message representations of messages
151 key0 = self._box.add(self._template % 0)
152 key1 = self._box.add(_sample_message)
153 msg0 = self._box.get_message(key0)
154 self.assert_(isinstance(msg0, mailbox.Message))
155 self.assert_(msg0['from'] == 'foo')
156 self.assert_(msg0.get_payload() == '0')
157 self._check_sample(self._box.get_message(key1))
158
159 def test_get_string(self):
160 # Get string representations of messages
161 key0 = self._box.add(self._template % 0)
162 key1 = self._box.add(_sample_message)
163 self.assert_(self._box.get_string(key0) == self._template % 0)
164 self.assert_(self._box.get_string(key1) == _sample_message)
165
166 def test_get_file(self):
167 # Get file representations of messages
168 key0 = self._box.add(self._template % 0)
169 key1 = self._box.add(_sample_message)
170 self.assert_(self._box.get_file(key0).read().replace(os.linesep, '\n')
171 == self._template % 0)
172 self.assert_(self._box.get_file(key1).read().replace(os.linesep, '\n')
173 == _sample_message)
174
175 def test_iterkeys(self):
176 # Get keys using iterkeys()
177 self._check_iteration(self._box.iterkeys, do_keys=True, do_values=False)
178
179 def test_keys(self):
180 # Get keys using keys()
181 self._check_iteration(self._box.keys, do_keys=True, do_values=False)
182
183 def test_itervalues(self):
184 # Get values using itervalues()
185 self._check_iteration(self._box.itervalues, do_keys=False,
186 do_values=True)
187
188 def test_iter(self):
189 # Get values using __iter__()
190 self._check_iteration(self._box.__iter__, do_keys=False,
191 do_values=True)
192
193 def test_values(self):
194 # Get values using values()
195 self._check_iteration(self._box.values, do_keys=False, do_values=True)
196
197 def test_iteritems(self):
198 # Get keys and values using iteritems()
199 self._check_iteration(self._box.iteritems, do_keys=True,
200 do_values=True)
201
202 def test_items(self):
203 # Get keys and values using items()
204 self._check_iteration(self._box.items, do_keys=True, do_values=True)
205
206 def _check_iteration(self, method, do_keys, do_values, repetitions=10):
207 for value in method():
208 self.fail("Not empty")
209 keys, values = [], []
210 for i in xrange(repetitions):
211 keys.append(self._box.add(self._template % i))
212 values.append(self._template % i)
213 if do_keys and not do_values:
214 returned_keys = list(method())
215 elif do_values and not do_keys:
216 returned_values = list(method())
217 else:
218 returned_keys, returned_values = [], []
219 for key, value in method():
220 returned_keys.append(key)
221 returned_values.append(value)
222 if do_keys:
223 self.assert_(len(keys) == len(returned_keys))
224 self.assert_(set(keys) == set(returned_keys))
225 if do_values:
226 count = 0
227 for value in returned_values:
228 self.assert_(value['from'] == 'foo')
229 self.assert_(int(value.get_payload()) < repetitions)
230 count += 1
231 self.assert_(len(values) == count)
232
233 def test_has_key(self):
234 # Check existence of keys using has_key()
235 self._test_has_key_or_contains(self._box.has_key)
236
237 def test_contains(self):
238 # Check existence of keys using __contains__()
239 self._test_has_key_or_contains(self._box.__contains__)
240
241 def _test_has_key_or_contains(self, method):
242 # (Used by test_has_key() and test_contains().)
243 self.assert_(not method('foo'))
244 key0 = self._box.add(self._template % 0)
245 self.assert_(method(key0))
246 self.assert_(not method('foo'))
247 key1 = self._box.add(self._template % 1)
248 self.assert_(method(key1))
249 self.assert_(method(key0))
250 self.assert_(not method('foo'))
251 self._box.remove(key0)
252 self.assert_(not method(key0))
253 self.assert_(method(key1))
254 self.assert_(not method('foo'))
255 self._box.remove(key1)
256 self.assert_(not method(key1))
257 self.assert_(not method(key0))
258 self.assert_(not method('foo'))
259
260 def test_len(self, repetitions=10):
261 # Get message count
262 keys = []
263 for i in xrange(repetitions):
264 self.assert_(len(self._box) == i)
265 keys.append(self._box.add(self._template % i))
266 self.assert_(len(self._box) == i + 1)
267 for i in xrange(repetitions):
268 self.assert_(len(self._box) == repetitions - i)
269 self._box.remove(keys[i])
270 self.assert_(len(self._box) == repetitions - i - 1)
271
272 def test_set_item(self):
273 # Modify messages using __setitem__()
274 key0 = self._box.add(self._template % 'original 0')
275 self.assert_(self._box.get_string(key0) == \
276 self._template % 'original 0')
277 key1 = self._box.add(self._template % 'original 1')
278 self.assert_(self._box.get_string(key1) == \
279 self._template % 'original 1')
280 self._box[key0] = self._template % 'changed 0'
281 self.assert_(self._box.get_string(key0) == \
282 self._template % 'changed 0')
283 self._box[key1] = self._template % 'changed 1'
284 self.assert_(self._box.get_string(key1) == \
285 self._template % 'changed 1')
286 self._box[key0] = _sample_message
287 self._check_sample(self._box[key0])
288 self._box[key1] = self._box[key0]
289 self._check_sample(self._box[key1])
290 self._box[key0] = self._template % 'original 0'
291 self.assert_(self._box.get_string(key0) ==
292 self._template % 'original 0')
293 self._check_sample(self._box[key1])
294 self.assertRaises(KeyError,
295 lambda: self._box.__setitem__('foo', 'bar'))
296 self.assertRaises(KeyError, lambda: self._box['foo'])
297 self.assert_(len(self._box) == 2)
298
299 def test_clear(self, iterations=10):
300 # Remove all messages using clear()
301 keys = []
302 for i in xrange(iterations):
303 self._box.add(self._template % i)
304 for i, key in enumerate(keys):
305 self.assert_(self._box.get_string(key) == self._template % i)
306 self._box.clear()
307 self.assert_(len(self._box) == 0)
308 for i, key in enumerate(keys):
309 self.assertRaises(KeyError, lambda: self._box.get_string(key))
310
311 def test_pop(self):
312 # Get and remove a message using pop()
313 key0 = self._box.add(self._template % 0)
314 self.assert_(key0 in self._box)
315 key1 = self._box.add(self._template % 1)
316 self.assert_(key1 in self._box)
317 self.assert_(self._box.pop(key0).get_payload() == '0')
318 self.assert_(key0 not in self._box)
319 self.assert_(key1 in self._box)
320 key2 = self._box.add(self._template % 2)
321 self.assert_(key2 in self._box)
322 self.assert_(self._box.pop(key2).get_payload() == '2')
323 self.assert_(key2 not in self._box)
324 self.assert_(key1 in self._box)
325 self.assert_(self._box.pop(key1).get_payload() == '1')
326 self.assert_(key1 not in self._box)
327 self.assert_(len(self._box) == 0)
328
329 def test_popitem(self, iterations=10):
330 # Get and remove an arbitrary (key, message) using popitem()
331 keys = []
332 for i in xrange(10):
333 keys.append(self._box.add(self._template % i))
334 seen = []
335 for i in xrange(10):
336 key, msg = self._box.popitem()
337 self.assert_(key in keys)
338 self.assert_(key not in seen)
339 seen.append(key)
340 self.assert_(int(msg.get_payload()) == keys.index(key))
341 self.assert_(len(self._box) == 0)
342 for key in keys:
343 self.assertRaises(KeyError, lambda: self._box[key])
344
345 def test_update(self):
346 # Modify multiple messages using update()
347 key0 = self._box.add(self._template % 'original 0')
348 key1 = self._box.add(self._template % 'original 1')
349 key2 = self._box.add(self._template % 'original 2')
350 self._box.update({key0: self._template % 'changed 0',
351 key2: _sample_message})
352 self.assert_(len(self._box) == 3)
353 self.assert_(self._box.get_string(key0) ==
354 self._template % 'changed 0')
355 self.assert_(self._box.get_string(key1) ==
356 self._template % 'original 1')
357 self._check_sample(self._box[key2])
358 self._box.update([(key2, self._template % 'changed 2'),
359 (key1, self._template % 'changed 1'),
360 (key0, self._template % 'original 0')])
361 self.assert_(len(self._box) == 3)
362 self.assert_(self._box.get_string(key0) ==
363 self._template % 'original 0')
364 self.assert_(self._box.get_string(key1) ==
365 self._template % 'changed 1')
366 self.assert_(self._box.get_string(key2) ==
367 self._template % 'changed 2')
368 self.assertRaises(KeyError,
369 lambda: self._box.update({'foo': 'bar',
370 key0: self._template % "changed 0"}))
371 self.assert_(len(self._box) == 3)
372 self.assert_(self._box.get_string(key0) ==
373 self._template % "changed 0")
374 self.assert_(self._box.get_string(key1) ==
375 self._template % "changed 1")
376 self.assert_(self._box.get_string(key2) ==
377 self._template % "changed 2")
378
379 def test_flush(self):
380 # Write changes to disk
381 self._test_flush_or_close(self._box.flush)
382
383 def test_lock_unlock(self):
384 # Lock and unlock the mailbox
385 self.assert_(not os.path.exists(self._get_lock_path()))
386 self._box.lock()
387 self.assert_(os.path.exists(self._get_lock_path()))
388 self._box.unlock()
389 self.assert_(not os.path.exists(self._get_lock_path()))
390
391 def test_close(self):
392 # Close mailbox and flush changes to disk
393 self._test_flush_or_close(self._box.close)
394
395 def _test_flush_or_close(self, method):
396 contents = [self._template % i for i in xrange(3)]
397 self._box.add(contents[0])
398 self._box.add(contents[1])
399 self._box.add(contents[2])
400 method()
401 self._box = self._factory(self._path)
402 keys = self._box.keys()
403 self.assert_(len(keys) == 3)
404 for key in keys:
405 self.assert_(self._box.get_string(key) in contents)
406
407 def test_dump_message(self):
408 # Write message representations to disk
409 for input in (email.message_from_string(_sample_message),
410 _sample_message, StringIO.StringIO(_sample_message)):
411 output = StringIO.StringIO()
412 self._box._dump_message(input, output)
413 self.assert_(output.getvalue() ==
414 _sample_message.replace('\n', os.linesep))
415 output = StringIO.StringIO()
416 self.assertRaises(TypeError,
417 lambda: self._box._dump_message(None, output))
418
419 def _get_lock_path(self):
420 # Return the path of the dot lock file. May be overridden.
421 return self._path + '.lock'
422
423
424class TestMailboxSuperclass(TestBase):
425
426 def test_notimplemented(self):
427 # Test that all Mailbox methods raise NotImplementedException.
428 box = mailbox.Mailbox('path')
429 self.assertRaises(NotImplementedError, lambda: box.add(''))
430 self.assertRaises(NotImplementedError, lambda: box.remove(''))
431 self.assertRaises(NotImplementedError, lambda: box.__delitem__(''))
432 self.assertRaises(NotImplementedError, lambda: box.discard(''))
433 self.assertRaises(NotImplementedError, lambda: box.__setitem__('', ''))
434 self.assertRaises(NotImplementedError, lambda: box.iterkeys())
435 self.assertRaises(NotImplementedError, lambda: box.keys())
436 self.assertRaises(NotImplementedError, lambda: box.itervalues().next())
437 self.assertRaises(NotImplementedError, lambda: box.__iter__().next())
438 self.assertRaises(NotImplementedError, lambda: box.values())
439 self.assertRaises(NotImplementedError, lambda: box.iteritems().next())
440 self.assertRaises(NotImplementedError, lambda: box.items())
441 self.assertRaises(NotImplementedError, lambda: box.get(''))
442 self.assertRaises(NotImplementedError, lambda: box.__getitem__(''))
443 self.assertRaises(NotImplementedError, lambda: box.get_message(''))
444 self.assertRaises(NotImplementedError, lambda: box.get_string(''))
445 self.assertRaises(NotImplementedError, lambda: box.get_file(''))
446 self.assertRaises(NotImplementedError, lambda: box.has_key(''))
447 self.assertRaises(NotImplementedError, lambda: box.__contains__(''))
448 self.assertRaises(NotImplementedError, lambda: box.__len__())
449 self.assertRaises(NotImplementedError, lambda: box.clear())
450 self.assertRaises(NotImplementedError, lambda: box.pop(''))
451 self.assertRaises(NotImplementedError, lambda: box.popitem())
452 self.assertRaises(NotImplementedError, lambda: box.update((('', ''),)))
453 self.assertRaises(NotImplementedError, lambda: box.flush())
454 self.assertRaises(NotImplementedError, lambda: box.lock())
455 self.assertRaises(NotImplementedError, lambda: box.unlock())
456 self.assertRaises(NotImplementedError, lambda: box.close())
457
458
459class TestMaildir(TestMailbox):
460
461 _factory = lambda self, path, factory=None: mailbox.Maildir(path, factory)
462
463 def setUp(self):
464 TestMailbox.setUp(self)
Neal Norwitz003c9e22006-08-11 06:09:41 +0000465 if os.name in ('nt', 'os2') or sys.platform == 'cygwin':
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000466 self._box.colon = '!'
467
468 def test_add_MM(self):
469 # Add a MaildirMessage instance
470 msg = mailbox.MaildirMessage(self._template % 0)
471 msg.set_subdir('cur')
472 msg.set_info('foo')
473 key = self._box.add(msg)
474 self.assert_(os.path.exists(os.path.join(self._path, 'cur', '%s%sfoo' %
475 (key, self._box.colon))))
476
477 def test_get_MM(self):
478 # Get a MaildirMessage instance
479 msg = mailbox.MaildirMessage(self._template % 0)
480 msg.set_subdir('cur')
481 msg.set_flags('RF')
482 key = self._box.add(msg)
483 msg_returned = self._box.get_message(key)
484 self.assert_(isinstance(msg_returned, mailbox.MaildirMessage))
485 self.assert_(msg_returned.get_subdir() == 'cur')
486 self.assert_(msg_returned.get_flags() == 'FR')
487
488 def test_set_MM(self):
489 # Set with a MaildirMessage instance
490 msg0 = mailbox.MaildirMessage(self._template % 0)
491 msg0.set_flags('TP')
492 key = self._box.add(msg0)
493 msg_returned = self._box.get_message(key)
494 self.assert_(msg_returned.get_subdir() == 'new')
495 self.assert_(msg_returned.get_flags() == 'PT')
496 msg1 = mailbox.MaildirMessage(self._template % 1)
497 self._box[key] = msg1
498 msg_returned = self._box.get_message(key)
499 self.assert_(msg_returned.get_subdir() == 'new')
500 self.assert_(msg_returned.get_flags() == '')
501 self.assert_(msg_returned.get_payload() == '1')
502 msg2 = mailbox.MaildirMessage(self._template % 2)
503 msg2.set_info('2,S')
504 self._box[key] = msg2
505 self._box[key] = self._template % 3
506 msg_returned = self._box.get_message(key)
507 self.assert_(msg_returned.get_subdir() == 'new')
508 self.assert_(msg_returned.get_flags() == 'S')
509 self.assert_(msg_returned.get_payload() == '3')
510
Andrew M. Kuchlingea72dcb2008-01-19 20:14:40 +0000511 def test_consistent_factory(self):
512 # Add a message.
513 msg = mailbox.MaildirMessage(self._template % 0)
514 msg.set_subdir('cur')
515 msg.set_flags('RF')
516 key = self._box.add(msg)
517
518 # Create new mailbox with
519 class FakeMessage(mailbox.MaildirMessage):
520 pass
521 box = mailbox.Maildir(self._path, factory=FakeMessage)
Andrew M. Kuchling61c2c952008-01-24 14:08:00 +0000522 box.colon = self._box.colon
Andrew M. Kuchlingea72dcb2008-01-19 20:14:40 +0000523 msg2 = box.get_message(key)
524 self.assert_(isinstance(msg2, FakeMessage))
525
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000526 def test_initialize_new(self):
527 # Initialize a non-existent mailbox
528 self.tearDown()
529 self._box = mailbox.Maildir(self._path)
530 self._check_basics(factory=rfc822.Message)
531 self._delete_recursively(self._path)
532 self._box = self._factory(self._path, factory=None)
533 self._check_basics()
534
535 def test_initialize_existing(self):
536 # Initialize an existing mailbox
537 self.tearDown()
538 for subdir in '', 'tmp', 'new', 'cur':
Andrew MacIntyreafa358f2006-07-23 13:04:00 +0000539 os.mkdir(os.path.normpath(os.path.join(self._path, subdir)))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000540 self._box = mailbox.Maildir(self._path)
541 self._check_basics(factory=rfc822.Message)
542 self._box = mailbox.Maildir(self._path, factory=None)
543 self._check_basics()
544
545 def _check_basics(self, factory=None):
546 # (Used by test_open_new() and test_open_existing().)
547 self.assertEqual(self._box._path, os.path.abspath(self._path))
548 self.assertEqual(self._box._factory, factory)
549 for subdir in '', 'tmp', 'new', 'cur':
550 path = os.path.join(self._path, subdir)
551 mode = os.stat(path)[stat.ST_MODE]
552 self.assert_(stat.S_ISDIR(mode), "Not a directory: '%s'" % path)
553
554 def test_list_folders(self):
555 # List folders
556 self._box.add_folder('one')
557 self._box.add_folder('two')
558 self._box.add_folder('three')
559 self.assert_(len(self._box.list_folders()) == 3)
560 self.assert_(set(self._box.list_folders()) ==
561 set(('one', 'two', 'three')))
562
563 def test_get_folder(self):
564 # Open folders
565 self._box.add_folder('foo.bar')
566 folder0 = self._box.get_folder('foo.bar')
567 folder0.add(self._template % 'bar')
568 self.assert_(os.path.isdir(os.path.join(self._path, '.foo.bar')))
569 folder1 = self._box.get_folder('foo.bar')
570 self.assert_(folder1.get_string(folder1.keys()[0]) == \
571 self._template % 'bar')
572
573 def test_add_and_remove_folders(self):
574 # Delete folders
575 self._box.add_folder('one')
576 self._box.add_folder('two')
577 self.assert_(len(self._box.list_folders()) == 2)
578 self.assert_(set(self._box.list_folders()) == set(('one', 'two')))
579 self._box.remove_folder('one')
580 self.assert_(len(self._box.list_folders()) == 1)
581 self.assert_(set(self._box.list_folders()) == set(('two',)))
582 self._box.add_folder('three')
583 self.assert_(len(self._box.list_folders()) == 2)
584 self.assert_(set(self._box.list_folders()) == set(('two', 'three')))
585 self._box.remove_folder('three')
586 self.assert_(len(self._box.list_folders()) == 1)
587 self.assert_(set(self._box.list_folders()) == set(('two',)))
588 self._box.remove_folder('two')
589 self.assert_(len(self._box.list_folders()) == 0)
590 self.assert_(self._box.list_folders() == [])
591
592 def test_clean(self):
593 # Remove old files from 'tmp'
594 foo_path = os.path.join(self._path, 'tmp', 'foo')
595 bar_path = os.path.join(self._path, 'tmp', 'bar')
Guido van Rossumb2045832006-05-02 20:47:36 +0000596 f = open(foo_path, 'w')
597 f.write("@")
598 f.close()
599 f = open(bar_path, 'w')
600 f.write("@")
601 f.close()
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000602 self._box.clean()
603 self.assert_(os.path.exists(foo_path))
604 self.assert_(os.path.exists(bar_path))
605 foo_stat = os.stat(foo_path)
Guido van Rossumb2045832006-05-02 20:47:36 +0000606 os.utime(foo_path, (time.time() - 129600 - 2,
607 foo_stat.st_mtime))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000608 self._box.clean()
609 self.assert_(not os.path.exists(foo_path))
610 self.assert_(os.path.exists(bar_path))
611
612 def test_create_tmp(self, repetitions=10):
613 # Create files in tmp directory
614 hostname = socket.gethostname()
615 if '/' in hostname:
616 hostname = hostname.replace('/', r'\057')
617 if ':' in hostname:
618 hostname = hostname.replace(':', r'\072')
619 pid = os.getpid()
620 pattern = re.compile(r"(?P<time>\d+)\.M(?P<M>\d{1,6})P(?P<P>\d+)"
621 r"Q(?P<Q>\d+)\.(?P<host>[^:/]+)")
622 previous_groups = None
623 for x in xrange(repetitions):
624 tmp_file = self._box._create_tmp()
625 head, tail = os.path.split(tmp_file.name)
626 self.assertEqual(head, os.path.abspath(os.path.join(self._path,
627 "tmp")),
628 "File in wrong location: '%s'" % head)
629 match = pattern.match(tail)
630 self.assert_(match != None, "Invalid file name: '%s'" % tail)
631 groups = match.groups()
632 if previous_groups != None:
633 self.assert_(int(groups[0] >= previous_groups[0]),
634 "Non-monotonic seconds: '%s' before '%s'" %
635 (previous_groups[0], groups[0]))
636 self.assert_(int(groups[1] >= previous_groups[1]) or
637 groups[0] != groups[1],
638 "Non-monotonic milliseconds: '%s' before '%s'" %
639 (previous_groups[1], groups[1]))
640 self.assert_(int(groups[2]) == pid,
641 "Process ID mismatch: '%s' should be '%s'" %
642 (groups[2], pid))
643 self.assert_(int(groups[3]) == int(previous_groups[3]) + 1,
644 "Non-sequential counter: '%s' before '%s'" %
645 (previous_groups[3], groups[3]))
646 self.assert_(groups[4] == hostname,
647 "Host name mismatch: '%s' should be '%s'" %
648 (groups[4], hostname))
649 previous_groups = groups
650 tmp_file.write(_sample_message)
651 tmp_file.seek(0)
652 self.assert_(tmp_file.read() == _sample_message)
653 tmp_file.close()
654 file_count = len(os.listdir(os.path.join(self._path, "tmp")))
655 self.assert_(file_count == repetitions,
656 "Wrong file count: '%s' should be '%s'" %
657 (file_count, repetitions))
658
659 def test_refresh(self):
660 # Update the table of contents
661 self.assert_(self._box._toc == {})
662 key0 = self._box.add(self._template % 0)
663 key1 = self._box.add(self._template % 1)
664 self.assert_(self._box._toc == {})
665 self._box._refresh()
666 self.assert_(self._box._toc == {key0: os.path.join('new', key0),
667 key1: os.path.join('new', key1)})
668 key2 = self._box.add(self._template % 2)
669 self.assert_(self._box._toc == {key0: os.path.join('new', key0),
670 key1: os.path.join('new', key1)})
671 self._box._refresh()
672 self.assert_(self._box._toc == {key0: os.path.join('new', key0),
673 key1: os.path.join('new', key1),
674 key2: os.path.join('new', key2)})
675
676 def test_lookup(self):
677 # Look up message subpaths in the TOC
678 self.assertRaises(KeyError, lambda: self._box._lookup('foo'))
679 key0 = self._box.add(self._template % 0)
680 self.assert_(self._box._lookup(key0) == os.path.join('new', key0))
681 os.remove(os.path.join(self._path, 'new', key0))
682 self.assert_(self._box._toc == {key0: os.path.join('new', key0)})
683 self.assertRaises(KeyError, lambda: self._box._lookup(key0))
684 self.assert_(self._box._toc == {})
685
686 def test_lock_unlock(self):
687 # Lock and unlock the mailbox. For Maildir, this does nothing.
688 self._box.lock()
689 self._box.unlock()
690
Andrew M. Kuchlingd52a0b82006-11-09 13:33:53 +0000691 def test_folder (self):
692 # Test for bug #1569790: verify that folders returned by .get_folder()
693 # use the same factory function.
694 def dummy_factory (s):
695 return None
696 box = self._factory(self._path, factory=dummy_factory)
697 folder = box.add_folder('folder1')
698 self.assert_(folder._factory is dummy_factory)
Neal Norwitz44dab0a2007-04-25 06:42:41 +0000699
Andrew M. Kuchlingd52a0b82006-11-09 13:33:53 +0000700 folder1_alias = box.get_folder('folder1')
701 self.assert_(folder1_alias._factory is dummy_factory)
702
Andrew M. Kuchling6ecd4a02007-07-14 22:06:30 +0000703 def test_directory_in_folder (self):
704 # Test that mailboxes still work if there's a stray extra directory
705 # in a folder.
706 for i in range(10):
707 self._box.add(mailbox.Message(_sample_message))
Neal Norwitz44dab0a2007-04-25 06:42:41 +0000708
Andrew M. Kuchling6ecd4a02007-07-14 22:06:30 +0000709 # Create a stray directory
710 os.mkdir(os.path.join(self._path, 'cur', 'stray-dir'))
711
712 # Check that looping still works with the directory present.
713 for msg in self._box:
714 pass
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000715
716class _TestMboxMMDF(TestMailbox):
717
718 def tearDown(self):
719 self._box.close()
720 self._delete_recursively(self._path)
721 for lock_remnant in glob.glob(self._path + '.*'):
722 os.remove(lock_remnant)
723
724 def test_add_from_string(self):
725 # Add a string starting with 'From ' to the mailbox
726 key = self._box.add('From foo@bar blah\nFrom: foo\n\n0')
727 self.assert_(self._box[key].get_from() == 'foo@bar blah')
728 self.assert_(self._box[key].get_payload() == '0')
729
730 def test_add_mbox_or_mmdf_message(self):
731 # Add an mboxMessage or MMDFMessage
732 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
733 msg = class_('From foo@bar blah\nFrom: foo\n\n0')
734 key = self._box.add(msg)
735
736 def test_open_close_open(self):
737 # Open and inspect previously-created mailbox
738 values = [self._template % i for i in xrange(3)]
739 for value in values:
740 self._box.add(value)
741 self._box.close()
742 mtime = os.path.getmtime(self._path)
743 self._box = self._factory(self._path)
744 self.assert_(len(self._box) == 3)
745 for key in self._box.iterkeys():
746 self.assert_(self._box.get_string(key) in values)
747 self._box.close()
748 self.assert_(mtime == os.path.getmtime(self._path))
749
750 def test_add_and_close(self):
751 # Verifying that closing a mailbox doesn't change added items
752 self._box.add(_sample_message)
753 for i in xrange(3):
754 self._box.add(self._template % i)
755 self._box.add(_sample_message)
756 self._box._file.flush()
757 self._box._file.seek(0)
758 contents = self._box._file.read()
759 self._box.close()
Andrew M. Kuchling214db632006-05-02 21:44:33 +0000760 self.assert_(contents == open(self._path, 'rb').read())
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000761 self._box = self._factory(self._path)
762
Andrew M. Kuchling9afbace2006-06-26 13:23:10 +0000763 def test_lock_conflict(self):
764 # Fork off a subprocess that will lock the file for 2 seconds,
765 # unlock it, and then exit.
Andrew M. Kuchlingec3c3682006-06-26 14:33:24 +0000766 if not hasattr(os, 'fork'):
767 return
Andrew M. Kuchling9afbace2006-06-26 13:23:10 +0000768 pid = os.fork()
769 if pid == 0:
770 # In the child, lock the mailbox.
771 self._box.lock()
772 time.sleep(2)
773 self._box.unlock()
774 os._exit(0)
775
776 # In the parent, sleep a bit to give the child time to acquire
777 # the lock.
778 time.sleep(0.5)
Neal Norwitz003c9e22006-08-11 06:09:41 +0000779 try:
780 self.assertRaises(mailbox.ExternalClashError,
781 self._box.lock)
782 finally:
783 # Wait for child to exit. Locking should now succeed.
784 exited_pid, status = os.waitpid(pid, 0)
Tim Peters3249d002006-06-27 11:52:49 +0000785
Andrew M. Kuchling9afbace2006-06-26 13:23:10 +0000786 self._box.lock()
787 self._box.unlock()
Tim Peters3249d002006-06-27 11:52:49 +0000788
Andrew M. Kuchling7d1d5402006-10-27 16:57:44 +0000789 def test_relock(self):
790 # Test case for bug #1575506: the mailbox class was locking the
791 # wrong file object in its flush() method.
792 msg = "Subject: sub\n\nbody\n"
793 key1 = self._box.add(msg)
794 self._box.flush()
795 self._box.close()
Neal Norwitz44dab0a2007-04-25 06:42:41 +0000796
Andrew M. Kuchling7d1d5402006-10-27 16:57:44 +0000797 self._box = self._factory(self._path)
798 self._box.lock()
799 key2 = self._box.add(msg)
800 self._box.flush()
801 self.assert_(self._box._locked)
802 self._box.close()
Neal Norwitz44dab0a2007-04-25 06:42:41 +0000803
804
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000805
806class TestMbox(_TestMboxMMDF):
807
808 _factory = lambda self, path, factory=None: mailbox.mbox(path, factory)
809
810
811class TestMMDF(_TestMboxMMDF):
812
813 _factory = lambda self, path, factory=None: mailbox.MMDF(path, factory)
814
815
816class TestMH(TestMailbox):
817
818 _factory = lambda self, path, factory=None: mailbox.MH(path, factory)
819
820 def test_list_folders(self):
821 # List folders
822 self._box.add_folder('one')
823 self._box.add_folder('two')
824 self._box.add_folder('three')
825 self.assert_(len(self._box.list_folders()) == 3)
826 self.assert_(set(self._box.list_folders()) ==
827 set(('one', 'two', 'three')))
828
829 def test_get_folder(self):
830 # Open folders
Andrew M. Kuchlingd52a0b82006-11-09 13:33:53 +0000831 def dummy_factory (s):
832 return None
833 self._box = self._factory(self._path, dummy_factory)
Neal Norwitz44dab0a2007-04-25 06:42:41 +0000834
Andrew M. Kuchlingd52a0b82006-11-09 13:33:53 +0000835 new_folder = self._box.add_folder('foo.bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000836 folder0 = self._box.get_folder('foo.bar')
837 folder0.add(self._template % 'bar')
838 self.assert_(os.path.isdir(os.path.join(self._path, 'foo.bar')))
839 folder1 = self._box.get_folder('foo.bar')
840 self.assert_(folder1.get_string(folder1.keys()[0]) == \
841 self._template % 'bar')
842
Andrew M. Kuchlingd52a0b82006-11-09 13:33:53 +0000843 # Test for bug #1569790: verify that folders returned by .get_folder()
844 # use the same factory function.
845 self.assert_(new_folder._factory is self._box._factory)
846 self.assert_(folder0._factory is self._box._factory)
847
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000848 def test_add_and_remove_folders(self):
849 # Delete folders
850 self._box.add_folder('one')
851 self._box.add_folder('two')
852 self.assert_(len(self._box.list_folders()) == 2)
853 self.assert_(set(self._box.list_folders()) == set(('one', 'two')))
854 self._box.remove_folder('one')
855 self.assert_(len(self._box.list_folders()) == 1)
856 self.assert_(set(self._box.list_folders()) == set(('two',)))
857 self._box.add_folder('three')
858 self.assert_(len(self._box.list_folders()) == 2)
859 self.assert_(set(self._box.list_folders()) == set(('two', 'three')))
860 self._box.remove_folder('three')
861 self.assert_(len(self._box.list_folders()) == 1)
862 self.assert_(set(self._box.list_folders()) == set(('two',)))
863 self._box.remove_folder('two')
864 self.assert_(len(self._box.list_folders()) == 0)
865 self.assert_(self._box.list_folders() == [])
866
867 def test_sequences(self):
868 # Get and set sequences
869 self.assert_(self._box.get_sequences() == {})
870 msg0 = mailbox.MHMessage(self._template % 0)
871 msg0.add_sequence('foo')
872 key0 = self._box.add(msg0)
873 self.assert_(self._box.get_sequences() == {'foo':[key0]})
874 msg1 = mailbox.MHMessage(self._template % 1)
875 msg1.set_sequences(['bar', 'replied', 'foo'])
876 key1 = self._box.add(msg1)
877 self.assert_(self._box.get_sequences() ==
878 {'foo':[key0, key1], 'bar':[key1], 'replied':[key1]})
879 msg0.set_sequences(['flagged'])
880 self._box[key0] = msg0
881 self.assert_(self._box.get_sequences() ==
882 {'foo':[key1], 'bar':[key1], 'replied':[key1],
883 'flagged':[key0]})
884 self._box.remove(key1)
885 self.assert_(self._box.get_sequences() == {'flagged':[key0]})
886
887 def test_pack(self):
888 # Pack the contents of the mailbox
889 msg0 = mailbox.MHMessage(self._template % 0)
890 msg1 = mailbox.MHMessage(self._template % 1)
891 msg2 = mailbox.MHMessage(self._template % 2)
892 msg3 = mailbox.MHMessage(self._template % 3)
893 msg0.set_sequences(['foo', 'unseen'])
894 msg1.set_sequences(['foo'])
895 msg2.set_sequences(['foo', 'flagged'])
896 msg3.set_sequences(['foo', 'bar', 'replied'])
897 key0 = self._box.add(msg0)
898 key1 = self._box.add(msg1)
899 key2 = self._box.add(msg2)
900 key3 = self._box.add(msg3)
901 self.assert_(self._box.get_sequences() ==
902 {'foo':[key0,key1,key2,key3], 'unseen':[key0],
903 'flagged':[key2], 'bar':[key3], 'replied':[key3]})
904 self._box.remove(key2)
905 self.assert_(self._box.get_sequences() ==
906 {'foo':[key0,key1,key3], 'unseen':[key0], 'bar':[key3],
907 'replied':[key3]})
908 self._box.pack()
909 self.assert_(self._box.keys() == [1, 2, 3])
910 key0 = key0
911 key1 = key0 + 1
912 key2 = key1 + 1
913 self.assert_(self._box.get_sequences() ==
914 {'foo':[1, 2, 3], 'unseen':[1], 'bar':[3], 'replied':[3]})
915
Andrew M. Kuchling830358a2006-11-17 16:16:28 +0000916 # Test case for packing while holding the mailbox locked.
917 key0 = self._box.add(msg1)
918 key1 = self._box.add(msg1)
919 key2 = self._box.add(msg1)
920 key3 = self._box.add(msg1)
921
922 self._box.remove(key0)
923 self._box.remove(key2)
924 self._box.lock()
925 self._box.pack()
926 self._box.unlock()
927 self.assert_(self._box.get_sequences() ==
928 {'foo':[1, 2, 3, 4, 5],
929 'unseen':[1], 'bar':[3], 'replied':[3]})
Neal Norwitz44dab0a2007-04-25 06:42:41 +0000930
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000931 def _get_lock_path(self):
932 return os.path.join(self._path, '.mh_sequences.lock')
933
934
935class TestBabyl(TestMailbox):
936
937 _factory = lambda self, path, factory=None: mailbox.Babyl(path, factory)
938
939 def tearDown(self):
940 self._box.close()
941 self._delete_recursively(self._path)
942 for lock_remnant in glob.glob(self._path + '.*'):
943 os.remove(lock_remnant)
944
945 def test_labels(self):
946 # Get labels from the mailbox
947 self.assert_(self._box.get_labels() == [])
948 msg0 = mailbox.BabylMessage(self._template % 0)
949 msg0.add_label('foo')
950 key0 = self._box.add(msg0)
951 self.assert_(self._box.get_labels() == ['foo'])
952 msg1 = mailbox.BabylMessage(self._template % 1)
953 msg1.set_labels(['bar', 'answered', 'foo'])
954 key1 = self._box.add(msg1)
955 self.assert_(set(self._box.get_labels()) == set(['foo', 'bar']))
956 msg0.set_labels(['blah', 'filed'])
957 self._box[key0] = msg0
958 self.assert_(set(self._box.get_labels()) ==
959 set(['foo', 'bar', 'blah']))
960 self._box.remove(key1)
961 self.assert_(set(self._box.get_labels()) == set(['blah']))
962
963
964class TestMessage(TestBase):
965
966 _factory = mailbox.Message # Overridden by subclasses to reuse tests
967
968 def setUp(self):
969 self._path = test_support.TESTFN
970
971 def tearDown(self):
972 self._delete_recursively(self._path)
973
974 def test_initialize_with_eMM(self):
975 # Initialize based on email.Message.Message instance
976 eMM = email.message_from_string(_sample_message)
977 msg = self._factory(eMM)
978 self._post_initialize_hook(msg)
979 self._check_sample(msg)
980
981 def test_initialize_with_string(self):
982 # Initialize based on string
983 msg = self._factory(_sample_message)
984 self._post_initialize_hook(msg)
985 self._check_sample(msg)
986
987 def test_initialize_with_file(self):
988 # Initialize based on contents of file
989 f = open(self._path, 'w+')
990 f.write(_sample_message)
991 f.seek(0)
992 msg = self._factory(f)
993 self._post_initialize_hook(msg)
994 self._check_sample(msg)
995 f.close()
996
997 def test_initialize_with_nothing(self):
998 # Initialize without arguments
999 msg = self._factory()
1000 self._post_initialize_hook(msg)
1001 self.assert_(isinstance(msg, email.Message.Message))
1002 self.assert_(isinstance(msg, mailbox.Message))
1003 self.assert_(isinstance(msg, self._factory))
1004 self.assert_(msg.keys() == [])
1005 self.assert_(not msg.is_multipart())
1006 self.assert_(msg.get_payload() == None)
1007
1008 def test_initialize_incorrectly(self):
1009 # Initialize with invalid argument
1010 self.assertRaises(TypeError, lambda: self._factory(object()))
1011
1012 def test_become_message(self):
1013 # Take on the state of another message
1014 eMM = email.message_from_string(_sample_message)
1015 msg = self._factory()
1016 msg._become_message(eMM)
1017 self._check_sample(msg)
1018
1019 def test_explain_to(self):
1020 # Copy self's format-specific data to other message formats.
1021 # This test is superficial; better ones are in TestMessageConversion.
1022 msg = self._factory()
1023 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1024 mailbox.mboxMessage, mailbox.MHMessage,
1025 mailbox.BabylMessage, mailbox.MMDFMessage):
1026 other_msg = class_()
1027 msg._explain_to(other_msg)
1028 other_msg = email.Message.Message()
1029 self.assertRaises(TypeError, lambda: msg._explain_to(other_msg))
1030
1031 def _post_initialize_hook(self, msg):
1032 # Overridden by subclasses to check extra things after initialization
1033 pass
1034
1035
1036class TestMaildirMessage(TestMessage):
1037
1038 _factory = mailbox.MaildirMessage
1039
1040 def _post_initialize_hook(self, msg):
1041 self.assert_(msg._subdir == 'new')
1042 self.assert_(msg._info == '')
1043
1044 def test_subdir(self):
1045 # Use get_subdir() and set_subdir()
1046 msg = mailbox.MaildirMessage(_sample_message)
1047 self.assert_(msg.get_subdir() == 'new')
1048 msg.set_subdir('cur')
1049 self.assert_(msg.get_subdir() == 'cur')
1050 msg.set_subdir('new')
1051 self.assert_(msg.get_subdir() == 'new')
1052 self.assertRaises(ValueError, lambda: msg.set_subdir('tmp'))
1053 self.assert_(msg.get_subdir() == 'new')
1054 msg.set_subdir('new')
1055 self.assert_(msg.get_subdir() == 'new')
1056 self._check_sample(msg)
1057
1058 def test_flags(self):
1059 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1060 msg = mailbox.MaildirMessage(_sample_message)
1061 self.assert_(msg.get_flags() == '')
1062 self.assert_(msg.get_subdir() == 'new')
1063 msg.set_flags('F')
1064 self.assert_(msg.get_subdir() == 'new')
1065 self.assert_(msg.get_flags() == 'F')
1066 msg.set_flags('SDTP')
1067 self.assert_(msg.get_flags() == 'DPST')
1068 msg.add_flag('FT')
1069 self.assert_(msg.get_flags() == 'DFPST')
1070 msg.remove_flag('TDRP')
1071 self.assert_(msg.get_flags() == 'FS')
1072 self.assert_(msg.get_subdir() == 'new')
1073 self._check_sample(msg)
1074
1075 def test_date(self):
1076 # Use get_date() and set_date()
1077 msg = mailbox.MaildirMessage(_sample_message)
1078 self.assert_(abs(msg.get_date() - time.time()) < 60)
1079 msg.set_date(0.0)
1080 self.assert_(msg.get_date() == 0.0)
1081
1082 def test_info(self):
1083 # Use get_info() and set_info()
1084 msg = mailbox.MaildirMessage(_sample_message)
1085 self.assert_(msg.get_info() == '')
1086 msg.set_info('1,foo=bar')
1087 self.assert_(msg.get_info() == '1,foo=bar')
1088 self.assertRaises(TypeError, lambda: msg.set_info(None))
1089 self._check_sample(msg)
1090
1091 def test_info_and_flags(self):
1092 # Test interaction of info and flag methods
1093 msg = mailbox.MaildirMessage(_sample_message)
1094 self.assert_(msg.get_info() == '')
1095 msg.set_flags('SF')
1096 self.assert_(msg.get_flags() == 'FS')
1097 self.assert_(msg.get_info() == '2,FS')
1098 msg.set_info('1,')
1099 self.assert_(msg.get_flags() == '')
1100 self.assert_(msg.get_info() == '1,')
1101 msg.remove_flag('RPT')
1102 self.assert_(msg.get_flags() == '')
1103 self.assert_(msg.get_info() == '1,')
1104 msg.add_flag('D')
1105 self.assert_(msg.get_flags() == 'D')
1106 self.assert_(msg.get_info() == '2,D')
1107 self._check_sample(msg)
1108
1109
1110class _TestMboxMMDFMessage(TestMessage):
1111
1112 _factory = mailbox._mboxMMDFMessage
1113
1114 def _post_initialize_hook(self, msg):
1115 self._check_from(msg)
1116
1117 def test_initialize_with_unixfrom(self):
1118 # Initialize with a message that already has a _unixfrom attribute
1119 msg = mailbox.Message(_sample_message)
1120 msg.set_unixfrom('From foo@bar blah')
1121 msg = mailbox.mboxMessage(msg)
1122 self.assert_(msg.get_from() == 'foo@bar blah', msg.get_from())
1123
1124 def test_from(self):
1125 # Get and set "From " line
1126 msg = mailbox.mboxMessage(_sample_message)
1127 self._check_from(msg)
1128 msg.set_from('foo bar')
1129 self.assert_(msg.get_from() == 'foo bar')
1130 msg.set_from('foo@bar', True)
1131 self._check_from(msg, 'foo@bar')
1132 msg.set_from('blah@temp', time.localtime())
1133 self._check_from(msg, 'blah@temp')
1134
1135 def test_flags(self):
1136 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1137 msg = mailbox.mboxMessage(_sample_message)
1138 self.assert_(msg.get_flags() == '')
1139 msg.set_flags('F')
1140 self.assert_(msg.get_flags() == 'F')
1141 msg.set_flags('XODR')
1142 self.assert_(msg.get_flags() == 'RODX')
1143 msg.add_flag('FA')
1144 self.assert_(msg.get_flags() == 'RODFAX')
1145 msg.remove_flag('FDXA')
1146 self.assert_(msg.get_flags() == 'RO')
1147 self._check_sample(msg)
1148
1149 def _check_from(self, msg, sender=None):
1150 # Check contents of "From " line
1151 if sender is None:
1152 sender = "MAILER-DAEMON"
1153 self.assert_(re.match(sender + r" \w{3} \w{3} [\d ]\d [\d ]\d:\d{2}:"
1154 r"\d{2} \d{4}", msg.get_from()) is not None)
1155
1156
1157class TestMboxMessage(_TestMboxMMDFMessage):
1158
1159 _factory = mailbox.mboxMessage
1160
1161
1162class TestMHMessage(TestMessage):
1163
1164 _factory = mailbox.MHMessage
1165
1166 def _post_initialize_hook(self, msg):
1167 self.assert_(msg._sequences == [])
1168
1169 def test_sequences(self):
1170 # Get, set, join, and leave sequences
1171 msg = mailbox.MHMessage(_sample_message)
1172 self.assert_(msg.get_sequences() == [])
1173 msg.set_sequences(['foobar'])
1174 self.assert_(msg.get_sequences() == ['foobar'])
1175 msg.set_sequences([])
1176 self.assert_(msg.get_sequences() == [])
1177 msg.add_sequence('unseen')
1178 self.assert_(msg.get_sequences() == ['unseen'])
1179 msg.add_sequence('flagged')
1180 self.assert_(msg.get_sequences() == ['unseen', 'flagged'])
1181 msg.add_sequence('flagged')
1182 self.assert_(msg.get_sequences() == ['unseen', 'flagged'])
1183 msg.remove_sequence('unseen')
1184 self.assert_(msg.get_sequences() == ['flagged'])
1185 msg.add_sequence('foobar')
1186 self.assert_(msg.get_sequences() == ['flagged', 'foobar'])
1187 msg.remove_sequence('replied')
1188 self.assert_(msg.get_sequences() == ['flagged', 'foobar'])
1189 msg.set_sequences(['foobar', 'replied'])
1190 self.assert_(msg.get_sequences() == ['foobar', 'replied'])
1191
1192
1193class TestBabylMessage(TestMessage):
1194
1195 _factory = mailbox.BabylMessage
1196
1197 def _post_initialize_hook(self, msg):
1198 self.assert_(msg._labels == [])
1199
1200 def test_labels(self):
1201 # Get, set, join, and leave labels
1202 msg = mailbox.BabylMessage(_sample_message)
1203 self.assert_(msg.get_labels() == [])
1204 msg.set_labels(['foobar'])
1205 self.assert_(msg.get_labels() == ['foobar'])
1206 msg.set_labels([])
1207 self.assert_(msg.get_labels() == [])
1208 msg.add_label('filed')
1209 self.assert_(msg.get_labels() == ['filed'])
1210 msg.add_label('resent')
1211 self.assert_(msg.get_labels() == ['filed', 'resent'])
1212 msg.add_label('resent')
1213 self.assert_(msg.get_labels() == ['filed', 'resent'])
1214 msg.remove_label('filed')
1215 self.assert_(msg.get_labels() == ['resent'])
1216 msg.add_label('foobar')
1217 self.assert_(msg.get_labels() == ['resent', 'foobar'])
1218 msg.remove_label('unseen')
1219 self.assert_(msg.get_labels() == ['resent', 'foobar'])
1220 msg.set_labels(['foobar', 'answered'])
1221 self.assert_(msg.get_labels() == ['foobar', 'answered'])
1222
1223 def test_visible(self):
1224 # Get, set, and update visible headers
1225 msg = mailbox.BabylMessage(_sample_message)
1226 visible = msg.get_visible()
1227 self.assert_(visible.keys() == [])
1228 self.assert_(visible.get_payload() is None)
1229 visible['User-Agent'] = 'FooBar 1.0'
1230 visible['X-Whatever'] = 'Blah'
1231 self.assert_(msg.get_visible().keys() == [])
1232 msg.set_visible(visible)
1233 visible = msg.get_visible()
1234 self.assert_(visible.keys() == ['User-Agent', 'X-Whatever'])
1235 self.assert_(visible['User-Agent'] == 'FooBar 1.0')
1236 self.assert_(visible['X-Whatever'] == 'Blah')
1237 self.assert_(visible.get_payload() is None)
1238 msg.update_visible()
1239 self.assert_(visible.keys() == ['User-Agent', 'X-Whatever'])
1240 self.assert_(visible.get_payload() is None)
1241 visible = msg.get_visible()
1242 self.assert_(visible.keys() == ['User-Agent', 'Date', 'From', 'To',
1243 'Subject'])
1244 for header in ('User-Agent', 'Date', 'From', 'To', 'Subject'):
1245 self.assert_(visible[header] == msg[header])
1246
1247
1248class TestMMDFMessage(_TestMboxMMDFMessage):
1249
1250 _factory = mailbox.MMDFMessage
1251
1252
1253class TestMessageConversion(TestBase):
1254
1255 def test_plain_to_x(self):
1256 # Convert Message to all formats
1257 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1258 mailbox.mboxMessage, mailbox.MHMessage,
1259 mailbox.BabylMessage, mailbox.MMDFMessage):
1260 msg_plain = mailbox.Message(_sample_message)
1261 msg = class_(msg_plain)
1262 self._check_sample(msg)
1263
1264 def test_x_to_plain(self):
1265 # Convert all formats to Message
1266 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1267 mailbox.mboxMessage, mailbox.MHMessage,
1268 mailbox.BabylMessage, mailbox.MMDFMessage):
1269 msg = class_(_sample_message)
1270 msg_plain = mailbox.Message(msg)
1271 self._check_sample(msg_plain)
1272
1273 def test_x_to_invalid(self):
1274 # Convert all formats to an invalid format
1275 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1276 mailbox.mboxMessage, mailbox.MHMessage,
1277 mailbox.BabylMessage, mailbox.MMDFMessage):
1278 self.assertRaises(TypeError, lambda: class_(False))
1279
1280 def test_maildir_to_maildir(self):
1281 # Convert MaildirMessage to MaildirMessage
1282 msg_maildir = mailbox.MaildirMessage(_sample_message)
1283 msg_maildir.set_flags('DFPRST')
1284 msg_maildir.set_subdir('cur')
1285 date = msg_maildir.get_date()
1286 msg = mailbox.MaildirMessage(msg_maildir)
1287 self._check_sample(msg)
1288 self.assert_(msg.get_flags() == 'DFPRST')
1289 self.assert_(msg.get_subdir() == 'cur')
1290 self.assert_(msg.get_date() == date)
1291
1292 def test_maildir_to_mboxmmdf(self):
1293 # Convert MaildirMessage to mboxmessage and MMDFMessage
1294 pairs = (('D', ''), ('F', 'F'), ('P', ''), ('R', 'A'), ('S', 'R'),
1295 ('T', 'D'), ('DFPRST', 'RDFA'))
1296 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1297 msg_maildir = mailbox.MaildirMessage(_sample_message)
1298 msg_maildir.set_date(0.0)
1299 for setting, result in pairs:
1300 msg_maildir.set_flags(setting)
1301 msg = class_(msg_maildir)
1302 self.assert_(msg.get_flags() == result)
1303 self.assert_(msg.get_from() == 'MAILER-DAEMON %s' %
1304 time.asctime(time.gmtime(0.0)))
1305 msg_maildir.set_subdir('cur')
1306 self.assert_(class_(msg_maildir).get_flags() == 'RODFA')
1307
1308 def test_maildir_to_mh(self):
1309 # Convert MaildirMessage to MHMessage
1310 msg_maildir = mailbox.MaildirMessage(_sample_message)
1311 pairs = (('D', ['unseen']), ('F', ['unseen', 'flagged']),
1312 ('P', ['unseen']), ('R', ['unseen', 'replied']), ('S', []),
1313 ('T', ['unseen']), ('DFPRST', ['replied', 'flagged']))
1314 for setting, result in pairs:
1315 msg_maildir.set_flags(setting)
1316 self.assert_(mailbox.MHMessage(msg_maildir).get_sequences() == \
1317 result)
1318
1319 def test_maildir_to_babyl(self):
1320 # Convert MaildirMessage to Babyl
1321 msg_maildir = mailbox.MaildirMessage(_sample_message)
1322 pairs = (('D', ['unseen']), ('F', ['unseen']),
1323 ('P', ['unseen', 'forwarded']), ('R', ['unseen', 'answered']),
1324 ('S', []), ('T', ['unseen', 'deleted']),
1325 ('DFPRST', ['deleted', 'answered', 'forwarded']))
1326 for setting, result in pairs:
1327 msg_maildir.set_flags(setting)
1328 self.assert_(mailbox.BabylMessage(msg_maildir).get_labels() == \
1329 result)
1330
1331 def test_mboxmmdf_to_maildir(self):
1332 # Convert mboxMessage and MMDFMessage to MaildirMessage
1333 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1334 msg_mboxMMDF = class_(_sample_message)
1335 msg_mboxMMDF.set_from('foo@bar', time.gmtime(0.0))
1336 pairs = (('R', 'S'), ('O', ''), ('D', 'T'), ('F', 'F'), ('A', 'R'),
1337 ('RODFA', 'FRST'))
1338 for setting, result in pairs:
1339 msg_mboxMMDF.set_flags(setting)
1340 msg = mailbox.MaildirMessage(msg_mboxMMDF)
1341 self.assert_(msg.get_flags() == result)
1342 self.assert_(msg.get_date() == 0.0, msg.get_date())
1343 msg_mboxMMDF.set_flags('O')
1344 self.assert_(mailbox.MaildirMessage(msg_mboxMMDF).get_subdir() == \
1345 'cur')
1346
1347 def test_mboxmmdf_to_mboxmmdf(self):
1348 # Convert mboxMessage and MMDFMessage to mboxMessage and MMDFMessage
1349 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1350 msg_mboxMMDF = class_(_sample_message)
1351 msg_mboxMMDF.set_flags('RODFA')
1352 msg_mboxMMDF.set_from('foo@bar')
1353 for class2_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1354 msg2 = class2_(msg_mboxMMDF)
1355 self.assert_(msg2.get_flags() == 'RODFA')
1356 self.assert_(msg2.get_from() == 'foo@bar')
1357
1358 def test_mboxmmdf_to_mh(self):
1359 # Convert mboxMessage and MMDFMessage to MHMessage
1360 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1361 msg_mboxMMDF = class_(_sample_message)
1362 pairs = (('R', []), ('O', ['unseen']), ('D', ['unseen']),
1363 ('F', ['unseen', 'flagged']),
1364 ('A', ['unseen', 'replied']),
1365 ('RODFA', ['replied', 'flagged']))
1366 for setting, result in pairs:
1367 msg_mboxMMDF.set_flags(setting)
1368 self.assert_(mailbox.MHMessage(msg_mboxMMDF).get_sequences() \
1369 == result)
1370
1371 def test_mboxmmdf_to_babyl(self):
1372 # Convert mboxMessage and MMDFMessage to BabylMessage
1373 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1374 msg = class_(_sample_message)
1375 pairs = (('R', []), ('O', ['unseen']),
1376 ('D', ['unseen', 'deleted']), ('F', ['unseen']),
1377 ('A', ['unseen', 'answered']),
1378 ('RODFA', ['deleted', 'answered']))
1379 for setting, result in pairs:
1380 msg.set_flags(setting)
1381 self.assert_(mailbox.BabylMessage(msg).get_labels() == result)
1382
1383 def test_mh_to_maildir(self):
1384 # Convert MHMessage to MaildirMessage
1385 pairs = (('unseen', ''), ('replied', 'RS'), ('flagged', 'FS'))
1386 for setting, result in pairs:
1387 msg = mailbox.MHMessage(_sample_message)
1388 msg.add_sequence(setting)
1389 self.assert_(mailbox.MaildirMessage(msg).get_flags() == result)
1390 self.assert_(mailbox.MaildirMessage(msg).get_subdir() == 'cur')
1391 msg = mailbox.MHMessage(_sample_message)
1392 msg.add_sequence('unseen')
1393 msg.add_sequence('replied')
1394 msg.add_sequence('flagged')
1395 self.assert_(mailbox.MaildirMessage(msg).get_flags() == 'FR')
1396 self.assert_(mailbox.MaildirMessage(msg).get_subdir() == 'cur')
1397
1398 def test_mh_to_mboxmmdf(self):
1399 # Convert MHMessage to mboxMessage and MMDFMessage
1400 pairs = (('unseen', 'O'), ('replied', 'ROA'), ('flagged', 'ROF'))
1401 for setting, result in pairs:
1402 msg = mailbox.MHMessage(_sample_message)
1403 msg.add_sequence(setting)
1404 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1405 self.assert_(class_(msg).get_flags() == result)
1406 msg = mailbox.MHMessage(_sample_message)
1407 msg.add_sequence('unseen')
1408 msg.add_sequence('replied')
1409 msg.add_sequence('flagged')
1410 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1411 self.assert_(class_(msg).get_flags() == 'OFA')
1412
1413 def test_mh_to_mh(self):
1414 # Convert MHMessage to MHMessage
1415 msg = mailbox.MHMessage(_sample_message)
1416 msg.add_sequence('unseen')
1417 msg.add_sequence('replied')
1418 msg.add_sequence('flagged')
1419 self.assert_(mailbox.MHMessage(msg).get_sequences() == \
1420 ['unseen', 'replied', 'flagged'])
1421
1422 def test_mh_to_babyl(self):
1423 # Convert MHMessage to BabylMessage
1424 pairs = (('unseen', ['unseen']), ('replied', ['answered']),
1425 ('flagged', []))
1426 for setting, result in pairs:
1427 msg = mailbox.MHMessage(_sample_message)
1428 msg.add_sequence(setting)
1429 self.assert_(mailbox.BabylMessage(msg).get_labels() == result)
1430 msg = mailbox.MHMessage(_sample_message)
1431 msg.add_sequence('unseen')
1432 msg.add_sequence('replied')
1433 msg.add_sequence('flagged')
1434 self.assert_(mailbox.BabylMessage(msg).get_labels() == \
1435 ['unseen', 'answered'])
1436
1437 def test_babyl_to_maildir(self):
1438 # Convert BabylMessage to MaildirMessage
1439 pairs = (('unseen', ''), ('deleted', 'ST'), ('filed', 'S'),
1440 ('answered', 'RS'), ('forwarded', 'PS'), ('edited', 'S'),
1441 ('resent', 'PS'))
1442 for setting, result in pairs:
1443 msg = mailbox.BabylMessage(_sample_message)
1444 msg.add_label(setting)
1445 self.assert_(mailbox.MaildirMessage(msg).get_flags() == result)
1446 self.assert_(mailbox.MaildirMessage(msg).get_subdir() == 'cur')
1447 msg = mailbox.BabylMessage(_sample_message)
1448 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1449 'edited', 'resent'):
1450 msg.add_label(label)
1451 self.assert_(mailbox.MaildirMessage(msg).get_flags() == 'PRT')
1452 self.assert_(mailbox.MaildirMessage(msg).get_subdir() == 'cur')
1453
1454 def test_babyl_to_mboxmmdf(self):
1455 # Convert BabylMessage to mboxMessage and MMDFMessage
1456 pairs = (('unseen', 'O'), ('deleted', 'ROD'), ('filed', 'RO'),
1457 ('answered', 'ROA'), ('forwarded', 'RO'), ('edited', 'RO'),
1458 ('resent', 'RO'))
1459 for setting, result in pairs:
1460 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1461 msg = mailbox.BabylMessage(_sample_message)
1462 msg.add_label(setting)
1463 self.assert_(class_(msg).get_flags() == result)
1464 msg = mailbox.BabylMessage(_sample_message)
1465 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1466 'edited', 'resent'):
1467 msg.add_label(label)
1468 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1469 self.assert_(class_(msg).get_flags() == 'ODA')
1470
1471 def test_babyl_to_mh(self):
1472 # Convert BabylMessage to MHMessage
1473 pairs = (('unseen', ['unseen']), ('deleted', []), ('filed', []),
1474 ('answered', ['replied']), ('forwarded', []), ('edited', []),
1475 ('resent', []))
1476 for setting, result in pairs:
1477 msg = mailbox.BabylMessage(_sample_message)
1478 msg.add_label(setting)
1479 self.assert_(mailbox.MHMessage(msg).get_sequences() == result)
1480 msg = mailbox.BabylMessage(_sample_message)
1481 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1482 'edited', 'resent'):
1483 msg.add_label(label)
1484 self.assert_(mailbox.MHMessage(msg).get_sequences() == \
1485 ['unseen', 'replied'])
1486
1487 def test_babyl_to_babyl(self):
1488 # Convert BabylMessage to BabylMessage
1489 msg = mailbox.BabylMessage(_sample_message)
1490 msg.update_visible()
1491 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1492 'edited', 'resent'):
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001493 msg.add_label(label)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001494 msg2 = mailbox.BabylMessage(msg)
1495 self.assert_(msg2.get_labels() == ['unseen', 'deleted', 'filed',
1496 'answered', 'forwarded', 'edited',
1497 'resent'])
1498 self.assert_(msg.get_visible().keys() == msg2.get_visible().keys())
1499 for key in msg.get_visible().keys():
1500 self.assert_(msg.get_visible()[key] == msg2.get_visible()[key])
1501
1502
1503class TestProxyFileBase(TestBase):
1504
1505 def _test_read(self, proxy):
1506 # Read by byte
1507 proxy.seek(0)
1508 self.assert_(proxy.read() == 'bar')
1509 proxy.seek(1)
1510 self.assert_(proxy.read() == 'ar')
1511 proxy.seek(0)
1512 self.assert_(proxy.read(2) == 'ba')
1513 proxy.seek(1)
1514 self.assert_(proxy.read(-1) == 'ar')
1515 proxy.seek(2)
1516 self.assert_(proxy.read(1000) == 'r')
1517
1518 def _test_readline(self, proxy):
1519 # Read by line
1520 proxy.seek(0)
1521 self.assert_(proxy.readline() == 'foo' + os.linesep)
1522 self.assert_(proxy.readline() == 'bar' + os.linesep)
1523 self.assert_(proxy.readline() == 'fred' + os.linesep)
1524 self.assert_(proxy.readline() == 'bob')
1525 proxy.seek(2)
1526 self.assert_(proxy.readline() == 'o' + os.linesep)
1527 proxy.seek(6 + 2 * len(os.linesep))
1528 self.assert_(proxy.readline() == 'fred' + os.linesep)
1529 proxy.seek(6 + 2 * len(os.linesep))
1530 self.assert_(proxy.readline(2) == 'fr')
1531 self.assert_(proxy.readline(-10) == 'ed' + os.linesep)
1532
1533 def _test_readlines(self, proxy):
1534 # Read multiple lines
1535 proxy.seek(0)
1536 self.assert_(proxy.readlines() == ['foo' + os.linesep,
1537 'bar' + os.linesep,
1538 'fred' + os.linesep, 'bob'])
1539 proxy.seek(0)
1540 self.assert_(proxy.readlines(2) == ['foo' + os.linesep])
1541 proxy.seek(3 + len(os.linesep))
1542 self.assert_(proxy.readlines(4 + len(os.linesep)) ==
1543 ['bar' + os.linesep, 'fred' + os.linesep])
1544 proxy.seek(3)
1545 self.assert_(proxy.readlines(1000) == [os.linesep, 'bar' + os.linesep,
1546 'fred' + os.linesep, 'bob'])
1547
1548 def _test_iteration(self, proxy):
1549 # Iterate by line
1550 proxy.seek(0)
1551 iterator = iter(proxy)
1552 self.assert_(iterator.next() == 'foo' + os.linesep)
1553 self.assert_(iterator.next() == 'bar' + os.linesep)
1554 self.assert_(iterator.next() == 'fred' + os.linesep)
1555 self.assert_(iterator.next() == 'bob')
1556 self.assertRaises(StopIteration, lambda: iterator.next())
1557
1558 def _test_seek_and_tell(self, proxy):
1559 # Seek and use tell to check position
1560 proxy.seek(3)
1561 self.assert_(proxy.tell() == 3)
1562 self.assert_(proxy.read(len(os.linesep)) == os.linesep)
1563 proxy.seek(2, 1)
1564 self.assert_(proxy.read(1 + len(os.linesep)) == 'r' + os.linesep)
1565 proxy.seek(-3 - len(os.linesep), 2)
1566 self.assert_(proxy.read(3) == 'bar')
1567 proxy.seek(2, 0)
1568 self.assert_(proxy.read() == 'o' + os.linesep + 'bar' + os.linesep)
1569 proxy.seek(100)
1570 self.assert_(proxy.read() == '')
1571
1572 def _test_close(self, proxy):
1573 # Close a file
1574 proxy.close()
1575 self.assertRaises(AttributeError, lambda: proxy.close())
1576
1577
1578class TestProxyFile(TestProxyFileBase):
1579
1580 def setUp(self):
1581 self._path = test_support.TESTFN
Andrew M. Kuchling214db632006-05-02 21:44:33 +00001582 self._file = open(self._path, 'wb+')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001583
1584 def tearDown(self):
1585 self._file.close()
1586 self._delete_recursively(self._path)
1587
1588 def test_initialize(self):
1589 # Initialize and check position
1590 self._file.write('foo')
1591 pos = self._file.tell()
1592 proxy0 = mailbox._ProxyFile(self._file)
1593 self.assert_(proxy0.tell() == pos)
1594 self.assert_(self._file.tell() == pos)
1595 proxy1 = mailbox._ProxyFile(self._file, 0)
1596 self.assert_(proxy1.tell() == 0)
1597 self.assert_(self._file.tell() == pos)
1598
1599 def test_read(self):
1600 self._file.write('bar')
1601 self._test_read(mailbox._ProxyFile(self._file))
1602
1603 def test_readline(self):
1604 self._file.write('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1605 os.linesep))
1606 self._test_readline(mailbox._ProxyFile(self._file))
1607
1608 def test_readlines(self):
1609 self._file.write('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1610 os.linesep))
1611 self._test_readlines(mailbox._ProxyFile(self._file))
1612
1613 def test_iteration(self):
1614 self._file.write('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1615 os.linesep))
1616 self._test_iteration(mailbox._ProxyFile(self._file))
1617
1618 def test_seek_and_tell(self):
1619 self._file.write('foo%sbar%s' % (os.linesep, os.linesep))
1620 self._test_seek_and_tell(mailbox._ProxyFile(self._file))
1621
1622 def test_close(self):
1623 self._file.write('foo%sbar%s' % (os.linesep, os.linesep))
1624 self._test_close(mailbox._ProxyFile(self._file))
1625
1626
1627class TestPartialFile(TestProxyFileBase):
1628
1629 def setUp(self):
1630 self._path = test_support.TESTFN
Andrew M. Kuchling214db632006-05-02 21:44:33 +00001631 self._file = open(self._path, 'wb+')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001632
1633 def tearDown(self):
1634 self._file.close()
1635 self._delete_recursively(self._path)
1636
1637 def test_initialize(self):
1638 # Initialize and check position
1639 self._file.write('foo' + os.linesep + 'bar')
1640 pos = self._file.tell()
1641 proxy = mailbox._PartialFile(self._file, 2, 5)
1642 self.assert_(proxy.tell() == 0)
1643 self.assert_(self._file.tell() == pos)
1644
1645 def test_read(self):
1646 self._file.write('***bar***')
1647 self._test_read(mailbox._PartialFile(self._file, 3, 6))
1648
1649 def test_readline(self):
1650 self._file.write('!!!!!foo%sbar%sfred%sbob!!!!!' %
1651 (os.linesep, os.linesep, os.linesep))
1652 self._test_readline(mailbox._PartialFile(self._file, 5,
1653 18 + 3 * len(os.linesep)))
1654
1655 def test_readlines(self):
1656 self._file.write('foo%sbar%sfred%sbob?????' %
1657 (os.linesep, os.linesep, os.linesep))
1658 self._test_readlines(mailbox._PartialFile(self._file, 0,
1659 13 + 3 * len(os.linesep)))
1660
1661 def test_iteration(self):
1662 self._file.write('____foo%sbar%sfred%sbob####' %
1663 (os.linesep, os.linesep, os.linesep))
1664 self._test_iteration(mailbox._PartialFile(self._file, 4,
1665 17 + 3 * len(os.linesep)))
1666
1667 def test_seek_and_tell(self):
1668 self._file.write('(((foo%sbar%s$$$' % (os.linesep, os.linesep))
1669 self._test_seek_and_tell(mailbox._PartialFile(self._file, 3,
1670 9 + 2 * len(os.linesep)))
1671
1672 def test_close(self):
1673 self._file.write('&foo%sbar%s^' % (os.linesep, os.linesep))
1674 self._test_close(mailbox._PartialFile(self._file, 1,
1675 6 + 3 * len(os.linesep)))
1676
1677
1678## Start: tests from the original module (for backward compatibility).
1679
Skip Montanaro5253da12004-07-24 19:56:03 +00001680FROM_ = "From some.body@dummy.domain Sat Jul 24 13:43:35 2004\n"
Fred Drakec02bc3e2001-05-21 20:23:21 +00001681DUMMY_MESSAGE = """\
1682From: some.body@dummy.domain
1683To: me@my.domain
Skip Montanaro5253da12004-07-24 19:56:03 +00001684Subject: Simple Test
Fred Drakec02bc3e2001-05-21 20:23:21 +00001685
1686This is a dummy message.
1687"""
1688
Fred Drakec02bc3e2001-05-21 20:23:21 +00001689class MaildirTestCase(unittest.TestCase):
1690
1691 def setUp(self):
1692 # create a new maildir mailbox to work with:
1693 self._dir = test_support.TESTFN
1694 os.mkdir(self._dir)
1695 os.mkdir(os.path.join(self._dir, "cur"))
1696 os.mkdir(os.path.join(self._dir, "tmp"))
1697 os.mkdir(os.path.join(self._dir, "new"))
1698 self._counter = 1
1699 self._msgfiles = []
1700
1701 def tearDown(self):
1702 map(os.unlink, self._msgfiles)
1703 os.rmdir(os.path.join(self._dir, "cur"))
1704 os.rmdir(os.path.join(self._dir, "tmp"))
1705 os.rmdir(os.path.join(self._dir, "new"))
1706 os.rmdir(self._dir)
1707
Skip Montanaro5253da12004-07-24 19:56:03 +00001708 def createMessage(self, dir, mbox=False):
Jack Jansen97df7b62001-06-19 20:20:05 +00001709 t = int(time.time() % 1000000)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001710 pid = self._counter
1711 self._counter += 1
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001712 filename = os.extsep.join((str(t), str(pid), "myhostname", "mydomain"))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001713 tmpname = os.path.join(self._dir, "tmp", filename)
1714 newname = os.path.join(self._dir, dir, filename)
1715 fp = open(tmpname, "w")
1716 self._msgfiles.append(tmpname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001717 if mbox:
1718 fp.write(FROM_)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001719 fp.write(DUMMY_MESSAGE)
1720 fp.close()
Tim Peters6626c1f2001-05-22 16:29:01 +00001721 if hasattr(os, "link"):
1722 os.link(tmpname, newname)
1723 else:
1724 fp = open(newname, "w")
1725 fp.write(DUMMY_MESSAGE)
1726 fp.close()
Fred Drakec02bc3e2001-05-21 20:23:21 +00001727 self._msgfiles.append(newname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001728 return tmpname
Fred Drakec02bc3e2001-05-21 20:23:21 +00001729
1730 def test_empty_maildir(self):
1731 """Test an empty maildir mailbox"""
1732 # Test for regression on bug #117490:
1733 # Make sure the boxes attribute actually gets set.
1734 self.mbox = mailbox.Maildir(test_support.TESTFN)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001735 #self.assert_(hasattr(self.mbox, "boxes"))
1736 #self.assert_(len(self.mbox.boxes) == 0)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001737 self.assert_(self.mbox.next() is None)
1738 self.assert_(self.mbox.next() is None)
1739
1740 def test_nonempty_maildir_cur(self):
1741 self.createMessage("cur")
1742 self.mbox = mailbox.Maildir(test_support.TESTFN)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001743 #self.assert_(len(self.mbox.boxes) == 1)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001744 self.assert_(self.mbox.next() is not None)
1745 self.assert_(self.mbox.next() is None)
1746 self.assert_(self.mbox.next() is None)
1747
1748 def test_nonempty_maildir_new(self):
1749 self.createMessage("new")
1750 self.mbox = mailbox.Maildir(test_support.TESTFN)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001751 #self.assert_(len(self.mbox.boxes) == 1)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001752 self.assert_(self.mbox.next() is not None)
1753 self.assert_(self.mbox.next() is None)
1754 self.assert_(self.mbox.next() is None)
1755
1756 def test_nonempty_maildir_both(self):
1757 self.createMessage("cur")
1758 self.createMessage("new")
1759 self.mbox = mailbox.Maildir(test_support.TESTFN)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001760 #self.assert_(len(self.mbox.boxes) == 2)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001761 self.assert_(self.mbox.next() is not None)
1762 self.assert_(self.mbox.next() is not None)
1763 self.assert_(self.mbox.next() is None)
1764 self.assert_(self.mbox.next() is None)
Fred Drake0aaed272000-10-23 13:39:15 +00001765
Skip Montanaro5253da12004-07-24 19:56:03 +00001766 def test_unix_mbox(self):
1767 ### should be better!
1768 import email.Parser
1769 fname = self.createMessage("cur", True)
1770 n = 0
1771 for msg in mailbox.PortableUnixMailbox(open(fname),
1772 email.Parser.Parser().parse):
1773 n += 1
1774 self.assertEqual(msg["subject"], "Simple Test")
1775 self.assertEqual(len(str(msg)), len(FROM_)+len(DUMMY_MESSAGE))
1776 self.assertEqual(n, 1)
1777
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001778## End: classes from the original module (for backward compatibility).
1779
1780
1781_sample_message = """\
1782Return-Path: <gkj@gregorykjohnson.com>
1783X-Original-To: gkj+person@localhost
1784Delivered-To: gkj+person@localhost
1785Received: from localhost (localhost [127.0.0.1])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001786 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1787 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001788Delivered-To: gkj@sundance.gregorykjohnson.com
1789Received: from localhost [127.0.0.1]
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001790 by localhost with POP3 (fetchmail-6.2.5)
1791 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001792Received: from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001793 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1794 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001795Received: by andy.gregorykjohnson.com (Postfix, from userid 1000)
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001796 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001797Date: Wed, 13 Jul 2005 17:23:11 -0400
1798From: "Gregory K. Johnson" <gkj@gregorykjohnson.com>
1799To: gkj@gregorykjohnson.com
1800Subject: Sample message
1801Message-ID: <20050713212311.GC4701@andy.gregorykjohnson.com>
1802Mime-Version: 1.0
1803Content-Type: multipart/mixed; boundary="NMuMz9nt05w80d4+"
1804Content-Disposition: inline
1805User-Agent: Mutt/1.5.9i
1806
1807
1808--NMuMz9nt05w80d4+
1809Content-Type: text/plain; charset=us-ascii
1810Content-Disposition: inline
1811
1812This is a sample message.
1813
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001814--
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001815Gregory K. Johnson
1816
1817--NMuMz9nt05w80d4+
1818Content-Type: application/octet-stream
1819Content-Disposition: attachment; filename="text.gz"
1820Content-Transfer-Encoding: base64
1821
1822H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
18233FYlAAAA
1824
1825--NMuMz9nt05w80d4+--
1826"""
1827
1828_sample_headers = {
1829 "Return-Path":"<gkj@gregorykjohnson.com>",
1830 "X-Original-To":"gkj+person@localhost",
1831 "Delivered-To":"gkj+person@localhost",
1832 "Received":"""from localhost (localhost [127.0.0.1])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001833 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1834 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001835 "Delivered-To":"gkj@sundance.gregorykjohnson.com",
1836 "Received":"""from localhost [127.0.0.1]
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001837 by localhost with POP3 (fetchmail-6.2.5)
1838 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001839 "Received":"""from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001840 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1841 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001842 "Received":"""by andy.gregorykjohnson.com (Postfix, from userid 1000)
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001843 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001844 "Date":"Wed, 13 Jul 2005 17:23:11 -0400",
1845 "From":""""Gregory K. Johnson" <gkj@gregorykjohnson.com>""",
1846 "To":"gkj@gregorykjohnson.com",
1847 "Subject":"Sample message",
1848 "Mime-Version":"1.0",
1849 "Content-Type":"""multipart/mixed; boundary="NMuMz9nt05w80d4+\"""",
1850 "Content-Disposition":"inline",
1851 "User-Agent": "Mutt/1.5.9i" }
1852
1853_sample_payloads = ("""This is a sample message.
1854
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001855--
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001856Gregory K. Johnson
1857""",
1858"""H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
18593FYlAAAA
1860""")
Fred Drake0aaed272000-10-23 13:39:15 +00001861
Fred Drakec02bc3e2001-05-21 20:23:21 +00001862
Fred Drake2e2be372001-09-20 21:33:42 +00001863def test_main():
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001864 tests = (TestMailboxSuperclass, TestMaildir, TestMbox, TestMMDF, TestMH,
1865 TestBabyl, TestMessage, TestMaildirMessage, TestMboxMessage,
1866 TestMHMessage, TestBabylMessage, TestMMDFMessage,
1867 TestMessageConversion, TestProxyFile, TestPartialFile,
1868 MaildirTestCase)
1869 test_support.run_unittest(*tests)
Neal Norwitzb15ac312006-06-29 04:10:08 +00001870 test_support.reap_children()
Fred Drake2e2be372001-09-20 21:33:42 +00001871
1872
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001873if __name__ == '__main__':
Fred Drake2e2be372001-09-20 21:33:42 +00001874 test_main()