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