blob: aaf40971227e7af15a535e449824eb5e3f16d05c [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
511 def test_initialize_new(self):
512 # Initialize a non-existent mailbox
513 self.tearDown()
514 self._box = mailbox.Maildir(self._path)
515 self._check_basics(factory=rfc822.Message)
516 self._delete_recursively(self._path)
517 self._box = self._factory(self._path, factory=None)
518 self._check_basics()
519
520 def test_initialize_existing(self):
521 # Initialize an existing mailbox
522 self.tearDown()
523 for subdir in '', 'tmp', 'new', 'cur':
Andrew MacIntyreafa358f2006-07-23 13:04:00 +0000524 os.mkdir(os.path.normpath(os.path.join(self._path, subdir)))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000525 self._box = mailbox.Maildir(self._path)
526 self._check_basics(factory=rfc822.Message)
527 self._box = mailbox.Maildir(self._path, factory=None)
528 self._check_basics()
529
530 def _check_basics(self, factory=None):
531 # (Used by test_open_new() and test_open_existing().)
532 self.assertEqual(self._box._path, os.path.abspath(self._path))
533 self.assertEqual(self._box._factory, factory)
534 for subdir in '', 'tmp', 'new', 'cur':
535 path = os.path.join(self._path, subdir)
536 mode = os.stat(path)[stat.ST_MODE]
537 self.assert_(stat.S_ISDIR(mode), "Not a directory: '%s'" % path)
538
539 def test_list_folders(self):
540 # List folders
541 self._box.add_folder('one')
542 self._box.add_folder('two')
543 self._box.add_folder('three')
544 self.assert_(len(self._box.list_folders()) == 3)
545 self.assert_(set(self._box.list_folders()) ==
546 set(('one', 'two', 'three')))
547
548 def test_get_folder(self):
549 # Open folders
550 self._box.add_folder('foo.bar')
551 folder0 = self._box.get_folder('foo.bar')
552 folder0.add(self._template % 'bar')
553 self.assert_(os.path.isdir(os.path.join(self._path, '.foo.bar')))
554 folder1 = self._box.get_folder('foo.bar')
555 self.assert_(folder1.get_string(folder1.keys()[0]) == \
556 self._template % 'bar')
557
558 def test_add_and_remove_folders(self):
559 # Delete folders
560 self._box.add_folder('one')
561 self._box.add_folder('two')
562 self.assert_(len(self._box.list_folders()) == 2)
563 self.assert_(set(self._box.list_folders()) == set(('one', 'two')))
564 self._box.remove_folder('one')
565 self.assert_(len(self._box.list_folders()) == 1)
566 self.assert_(set(self._box.list_folders()) == set(('two',)))
567 self._box.add_folder('three')
568 self.assert_(len(self._box.list_folders()) == 2)
569 self.assert_(set(self._box.list_folders()) == set(('two', 'three')))
570 self._box.remove_folder('three')
571 self.assert_(len(self._box.list_folders()) == 1)
572 self.assert_(set(self._box.list_folders()) == set(('two',)))
573 self._box.remove_folder('two')
574 self.assert_(len(self._box.list_folders()) == 0)
575 self.assert_(self._box.list_folders() == [])
576
577 def test_clean(self):
578 # Remove old files from 'tmp'
579 foo_path = os.path.join(self._path, 'tmp', 'foo')
580 bar_path = os.path.join(self._path, 'tmp', 'bar')
Guido van Rossumb2045832006-05-02 20:47:36 +0000581 f = open(foo_path, 'w')
582 f.write("@")
583 f.close()
584 f = open(bar_path, 'w')
585 f.write("@")
586 f.close()
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000587 self._box.clean()
588 self.assert_(os.path.exists(foo_path))
589 self.assert_(os.path.exists(bar_path))
590 foo_stat = os.stat(foo_path)
Guido van Rossumb2045832006-05-02 20:47:36 +0000591 os.utime(foo_path, (time.time() - 129600 - 2,
592 foo_stat.st_mtime))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000593 self._box.clean()
594 self.assert_(not os.path.exists(foo_path))
595 self.assert_(os.path.exists(bar_path))
596
597 def test_create_tmp(self, repetitions=10):
598 # Create files in tmp directory
599 hostname = socket.gethostname()
600 if '/' in hostname:
601 hostname = hostname.replace('/', r'\057')
602 if ':' in hostname:
603 hostname = hostname.replace(':', r'\072')
604 pid = os.getpid()
605 pattern = re.compile(r"(?P<time>\d+)\.M(?P<M>\d{1,6})P(?P<P>\d+)"
606 r"Q(?P<Q>\d+)\.(?P<host>[^:/]+)")
607 previous_groups = None
608 for x in xrange(repetitions):
609 tmp_file = self._box._create_tmp()
610 head, tail = os.path.split(tmp_file.name)
611 self.assertEqual(head, os.path.abspath(os.path.join(self._path,
612 "tmp")),
613 "File in wrong location: '%s'" % head)
614 match = pattern.match(tail)
615 self.assert_(match != None, "Invalid file name: '%s'" % tail)
616 groups = match.groups()
617 if previous_groups != None:
618 self.assert_(int(groups[0] >= previous_groups[0]),
619 "Non-monotonic seconds: '%s' before '%s'" %
620 (previous_groups[0], groups[0]))
621 self.assert_(int(groups[1] >= previous_groups[1]) or
622 groups[0] != groups[1],
623 "Non-monotonic milliseconds: '%s' before '%s'" %
624 (previous_groups[1], groups[1]))
625 self.assert_(int(groups[2]) == pid,
626 "Process ID mismatch: '%s' should be '%s'" %
627 (groups[2], pid))
628 self.assert_(int(groups[3]) == int(previous_groups[3]) + 1,
629 "Non-sequential counter: '%s' before '%s'" %
630 (previous_groups[3], groups[3]))
631 self.assert_(groups[4] == hostname,
632 "Host name mismatch: '%s' should be '%s'" %
633 (groups[4], hostname))
634 previous_groups = groups
635 tmp_file.write(_sample_message)
636 tmp_file.seek(0)
637 self.assert_(tmp_file.read() == _sample_message)
638 tmp_file.close()
639 file_count = len(os.listdir(os.path.join(self._path, "tmp")))
640 self.assert_(file_count == repetitions,
641 "Wrong file count: '%s' should be '%s'" %
642 (file_count, repetitions))
643
644 def test_refresh(self):
645 # Update the table of contents
646 self.assert_(self._box._toc == {})
647 key0 = self._box.add(self._template % 0)
648 key1 = self._box.add(self._template % 1)
649 self.assert_(self._box._toc == {})
650 self._box._refresh()
651 self.assert_(self._box._toc == {key0: os.path.join('new', key0),
652 key1: os.path.join('new', key1)})
653 key2 = self._box.add(self._template % 2)
654 self.assert_(self._box._toc == {key0: os.path.join('new', key0),
655 key1: os.path.join('new', key1)})
656 self._box._refresh()
657 self.assert_(self._box._toc == {key0: os.path.join('new', key0),
658 key1: os.path.join('new', key1),
659 key2: os.path.join('new', key2)})
660
661 def test_lookup(self):
662 # Look up message subpaths in the TOC
663 self.assertRaises(KeyError, lambda: self._box._lookup('foo'))
664 key0 = self._box.add(self._template % 0)
665 self.assert_(self._box._lookup(key0) == os.path.join('new', key0))
666 os.remove(os.path.join(self._path, 'new', key0))
667 self.assert_(self._box._toc == {key0: os.path.join('new', key0)})
668 self.assertRaises(KeyError, lambda: self._box._lookup(key0))
669 self.assert_(self._box._toc == {})
670
671 def test_lock_unlock(self):
672 # Lock and unlock the mailbox. For Maildir, this does nothing.
673 self._box.lock()
674 self._box.unlock()
675
Andrew M. Kuchlingd52a0b82006-11-09 13:33:53 +0000676 def test_folder (self):
677 # Test for bug #1569790: verify that folders returned by .get_folder()
678 # use the same factory function.
679 def dummy_factory (s):
680 return None
681 box = self._factory(self._path, factory=dummy_factory)
682 folder = box.add_folder('folder1')
683 self.assert_(folder._factory is dummy_factory)
684
685 folder1_alias = box.get_folder('folder1')
686 self.assert_(folder1_alias._factory is dummy_factory)
687
688
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000689
690class _TestMboxMMDF(TestMailbox):
691
692 def tearDown(self):
693 self._box.close()
694 self._delete_recursively(self._path)
695 for lock_remnant in glob.glob(self._path + '.*'):
696 os.remove(lock_remnant)
697
698 def test_add_from_string(self):
699 # Add a string starting with 'From ' to the mailbox
700 key = self._box.add('From foo@bar blah\nFrom: foo\n\n0')
701 self.assert_(self._box[key].get_from() == 'foo@bar blah')
702 self.assert_(self._box[key].get_payload() == '0')
703
704 def test_add_mbox_or_mmdf_message(self):
705 # Add an mboxMessage or MMDFMessage
706 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
707 msg = class_('From foo@bar blah\nFrom: foo\n\n0')
708 key = self._box.add(msg)
709
710 def test_open_close_open(self):
711 # Open and inspect previously-created mailbox
712 values = [self._template % i for i in xrange(3)]
713 for value in values:
714 self._box.add(value)
715 self._box.close()
716 mtime = os.path.getmtime(self._path)
717 self._box = self._factory(self._path)
718 self.assert_(len(self._box) == 3)
719 for key in self._box.iterkeys():
720 self.assert_(self._box.get_string(key) in values)
721 self._box.close()
722 self.assert_(mtime == os.path.getmtime(self._path))
723
724 def test_add_and_close(self):
725 # Verifying that closing a mailbox doesn't change added items
726 self._box.add(_sample_message)
727 for i in xrange(3):
728 self._box.add(self._template % i)
729 self._box.add(_sample_message)
730 self._box._file.flush()
731 self._box._file.seek(0)
732 contents = self._box._file.read()
733 self._box.close()
Andrew M. Kuchling214db632006-05-02 21:44:33 +0000734 self.assert_(contents == open(self._path, 'rb').read())
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000735 self._box = self._factory(self._path)
736
Andrew M. Kuchling9afbace2006-06-26 13:23:10 +0000737 def test_lock_conflict(self):
738 # Fork off a subprocess that will lock the file for 2 seconds,
739 # unlock it, and then exit.
Andrew M. Kuchlingec3c3682006-06-26 14:33:24 +0000740 if not hasattr(os, 'fork'):
741 return
Andrew M. Kuchling9afbace2006-06-26 13:23:10 +0000742 pid = os.fork()
743 if pid == 0:
744 # In the child, lock the mailbox.
745 self._box.lock()
746 time.sleep(2)
747 self._box.unlock()
748 os._exit(0)
749
750 # In the parent, sleep a bit to give the child time to acquire
751 # the lock.
752 time.sleep(0.5)
Neal Norwitz003c9e22006-08-11 06:09:41 +0000753 try:
754 self.assertRaises(mailbox.ExternalClashError,
755 self._box.lock)
756 finally:
757 # Wait for child to exit. Locking should now succeed.
758 exited_pid, status = os.waitpid(pid, 0)
Tim Peters3249d002006-06-27 11:52:49 +0000759
Andrew M. Kuchling9afbace2006-06-26 13:23:10 +0000760 self._box.lock()
761 self._box.unlock()
Tim Peters3249d002006-06-27 11:52:49 +0000762
Andrew M. Kuchling7d1d5402006-10-27 16:57:44 +0000763 def test_relock(self):
764 # Test case for bug #1575506: the mailbox class was locking the
765 # wrong file object in its flush() method.
766 msg = "Subject: sub\n\nbody\n"
767 key1 = self._box.add(msg)
768 self._box.flush()
769 self._box.close()
770
771 self._box = self._factory(self._path)
772 self._box.lock()
773 key2 = self._box.add(msg)
774 self._box.flush()
775 self.assert_(self._box._locked)
776 self._box.close()
777
778
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000779
780class TestMbox(_TestMboxMMDF):
781
782 _factory = lambda self, path, factory=None: mailbox.mbox(path, factory)
783
784
785class TestMMDF(_TestMboxMMDF):
786
787 _factory = lambda self, path, factory=None: mailbox.MMDF(path, factory)
788
789
790class TestMH(TestMailbox):
791
792 _factory = lambda self, path, factory=None: mailbox.MH(path, factory)
793
794 def test_list_folders(self):
795 # List folders
796 self._box.add_folder('one')
797 self._box.add_folder('two')
798 self._box.add_folder('three')
799 self.assert_(len(self._box.list_folders()) == 3)
800 self.assert_(set(self._box.list_folders()) ==
801 set(('one', 'two', 'three')))
802
803 def test_get_folder(self):
804 # Open folders
Andrew M. Kuchlingd52a0b82006-11-09 13:33:53 +0000805 def dummy_factory (s):
806 return None
807 self._box = self._factory(self._path, dummy_factory)
808
809 new_folder = self._box.add_folder('foo.bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000810 folder0 = self._box.get_folder('foo.bar')
811 folder0.add(self._template % 'bar')
812 self.assert_(os.path.isdir(os.path.join(self._path, 'foo.bar')))
813 folder1 = self._box.get_folder('foo.bar')
814 self.assert_(folder1.get_string(folder1.keys()[0]) == \
815 self._template % 'bar')
816
Andrew M. Kuchlingd52a0b82006-11-09 13:33:53 +0000817 # Test for bug #1569790: verify that folders returned by .get_folder()
818 # use the same factory function.
819 self.assert_(new_folder._factory is self._box._factory)
820 self.assert_(folder0._factory is self._box._factory)
821
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000822 def test_add_and_remove_folders(self):
823 # Delete folders
824 self._box.add_folder('one')
825 self._box.add_folder('two')
826 self.assert_(len(self._box.list_folders()) == 2)
827 self.assert_(set(self._box.list_folders()) == set(('one', 'two')))
828 self._box.remove_folder('one')
829 self.assert_(len(self._box.list_folders()) == 1)
830 self.assert_(set(self._box.list_folders()) == set(('two',)))
831 self._box.add_folder('three')
832 self.assert_(len(self._box.list_folders()) == 2)
833 self.assert_(set(self._box.list_folders()) == set(('two', 'three')))
834 self._box.remove_folder('three')
835 self.assert_(len(self._box.list_folders()) == 1)
836 self.assert_(set(self._box.list_folders()) == set(('two',)))
837 self._box.remove_folder('two')
838 self.assert_(len(self._box.list_folders()) == 0)
839 self.assert_(self._box.list_folders() == [])
840
841 def test_sequences(self):
842 # Get and set sequences
843 self.assert_(self._box.get_sequences() == {})
844 msg0 = mailbox.MHMessage(self._template % 0)
845 msg0.add_sequence('foo')
846 key0 = self._box.add(msg0)
847 self.assert_(self._box.get_sequences() == {'foo':[key0]})
848 msg1 = mailbox.MHMessage(self._template % 1)
849 msg1.set_sequences(['bar', 'replied', 'foo'])
850 key1 = self._box.add(msg1)
851 self.assert_(self._box.get_sequences() ==
852 {'foo':[key0, key1], 'bar':[key1], 'replied':[key1]})
853 msg0.set_sequences(['flagged'])
854 self._box[key0] = msg0
855 self.assert_(self._box.get_sequences() ==
856 {'foo':[key1], 'bar':[key1], 'replied':[key1],
857 'flagged':[key0]})
858 self._box.remove(key1)
859 self.assert_(self._box.get_sequences() == {'flagged':[key0]})
860
861 def test_pack(self):
862 # Pack the contents of the mailbox
863 msg0 = mailbox.MHMessage(self._template % 0)
864 msg1 = mailbox.MHMessage(self._template % 1)
865 msg2 = mailbox.MHMessage(self._template % 2)
866 msg3 = mailbox.MHMessage(self._template % 3)
867 msg0.set_sequences(['foo', 'unseen'])
868 msg1.set_sequences(['foo'])
869 msg2.set_sequences(['foo', 'flagged'])
870 msg3.set_sequences(['foo', 'bar', 'replied'])
871 key0 = self._box.add(msg0)
872 key1 = self._box.add(msg1)
873 key2 = self._box.add(msg2)
874 key3 = self._box.add(msg3)
875 self.assert_(self._box.get_sequences() ==
876 {'foo':[key0,key1,key2,key3], 'unseen':[key0],
877 'flagged':[key2], 'bar':[key3], 'replied':[key3]})
878 self._box.remove(key2)
879 self.assert_(self._box.get_sequences() ==
880 {'foo':[key0,key1,key3], 'unseen':[key0], 'bar':[key3],
881 'replied':[key3]})
882 self._box.pack()
883 self.assert_(self._box.keys() == [1, 2, 3])
884 key0 = key0
885 key1 = key0 + 1
886 key2 = key1 + 1
887 self.assert_(self._box.get_sequences() ==
888 {'foo':[1, 2, 3], 'unseen':[1], 'bar':[3], 'replied':[3]})
889
890 def _get_lock_path(self):
891 return os.path.join(self._path, '.mh_sequences.lock')
892
893
894class TestBabyl(TestMailbox):
895
896 _factory = lambda self, path, factory=None: mailbox.Babyl(path, factory)
897
898 def tearDown(self):
899 self._box.close()
900 self._delete_recursively(self._path)
901 for lock_remnant in glob.glob(self._path + '.*'):
902 os.remove(lock_remnant)
903
904 def test_labels(self):
905 # Get labels from the mailbox
906 self.assert_(self._box.get_labels() == [])
907 msg0 = mailbox.BabylMessage(self._template % 0)
908 msg0.add_label('foo')
909 key0 = self._box.add(msg0)
910 self.assert_(self._box.get_labels() == ['foo'])
911 msg1 = mailbox.BabylMessage(self._template % 1)
912 msg1.set_labels(['bar', 'answered', 'foo'])
913 key1 = self._box.add(msg1)
914 self.assert_(set(self._box.get_labels()) == set(['foo', 'bar']))
915 msg0.set_labels(['blah', 'filed'])
916 self._box[key0] = msg0
917 self.assert_(set(self._box.get_labels()) ==
918 set(['foo', 'bar', 'blah']))
919 self._box.remove(key1)
920 self.assert_(set(self._box.get_labels()) == set(['blah']))
921
922
923class TestMessage(TestBase):
924
925 _factory = mailbox.Message # Overridden by subclasses to reuse tests
926
927 def setUp(self):
928 self._path = test_support.TESTFN
929
930 def tearDown(self):
931 self._delete_recursively(self._path)
932
933 def test_initialize_with_eMM(self):
934 # Initialize based on email.Message.Message instance
935 eMM = email.message_from_string(_sample_message)
936 msg = self._factory(eMM)
937 self._post_initialize_hook(msg)
938 self._check_sample(msg)
939
940 def test_initialize_with_string(self):
941 # Initialize based on string
942 msg = self._factory(_sample_message)
943 self._post_initialize_hook(msg)
944 self._check_sample(msg)
945
946 def test_initialize_with_file(self):
947 # Initialize based on contents of file
948 f = open(self._path, 'w+')
949 f.write(_sample_message)
950 f.seek(0)
951 msg = self._factory(f)
952 self._post_initialize_hook(msg)
953 self._check_sample(msg)
954 f.close()
955
956 def test_initialize_with_nothing(self):
957 # Initialize without arguments
958 msg = self._factory()
959 self._post_initialize_hook(msg)
960 self.assert_(isinstance(msg, email.Message.Message))
961 self.assert_(isinstance(msg, mailbox.Message))
962 self.assert_(isinstance(msg, self._factory))
963 self.assert_(msg.keys() == [])
964 self.assert_(not msg.is_multipart())
965 self.assert_(msg.get_payload() == None)
966
967 def test_initialize_incorrectly(self):
968 # Initialize with invalid argument
969 self.assertRaises(TypeError, lambda: self._factory(object()))
970
971 def test_become_message(self):
972 # Take on the state of another message
973 eMM = email.message_from_string(_sample_message)
974 msg = self._factory()
975 msg._become_message(eMM)
976 self._check_sample(msg)
977
978 def test_explain_to(self):
979 # Copy self's format-specific data to other message formats.
980 # This test is superficial; better ones are in TestMessageConversion.
981 msg = self._factory()
982 for class_ in (mailbox.Message, mailbox.MaildirMessage,
983 mailbox.mboxMessage, mailbox.MHMessage,
984 mailbox.BabylMessage, mailbox.MMDFMessage):
985 other_msg = class_()
986 msg._explain_to(other_msg)
987 other_msg = email.Message.Message()
988 self.assertRaises(TypeError, lambda: msg._explain_to(other_msg))
989
990 def _post_initialize_hook(self, msg):
991 # Overridden by subclasses to check extra things after initialization
992 pass
993
994
995class TestMaildirMessage(TestMessage):
996
997 _factory = mailbox.MaildirMessage
998
999 def _post_initialize_hook(self, msg):
1000 self.assert_(msg._subdir == 'new')
1001 self.assert_(msg._info == '')
1002
1003 def test_subdir(self):
1004 # Use get_subdir() and set_subdir()
1005 msg = mailbox.MaildirMessage(_sample_message)
1006 self.assert_(msg.get_subdir() == 'new')
1007 msg.set_subdir('cur')
1008 self.assert_(msg.get_subdir() == 'cur')
1009 msg.set_subdir('new')
1010 self.assert_(msg.get_subdir() == 'new')
1011 self.assertRaises(ValueError, lambda: msg.set_subdir('tmp'))
1012 self.assert_(msg.get_subdir() == 'new')
1013 msg.set_subdir('new')
1014 self.assert_(msg.get_subdir() == 'new')
1015 self._check_sample(msg)
1016
1017 def test_flags(self):
1018 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1019 msg = mailbox.MaildirMessage(_sample_message)
1020 self.assert_(msg.get_flags() == '')
1021 self.assert_(msg.get_subdir() == 'new')
1022 msg.set_flags('F')
1023 self.assert_(msg.get_subdir() == 'new')
1024 self.assert_(msg.get_flags() == 'F')
1025 msg.set_flags('SDTP')
1026 self.assert_(msg.get_flags() == 'DPST')
1027 msg.add_flag('FT')
1028 self.assert_(msg.get_flags() == 'DFPST')
1029 msg.remove_flag('TDRP')
1030 self.assert_(msg.get_flags() == 'FS')
1031 self.assert_(msg.get_subdir() == 'new')
1032 self._check_sample(msg)
1033
1034 def test_date(self):
1035 # Use get_date() and set_date()
1036 msg = mailbox.MaildirMessage(_sample_message)
1037 self.assert_(abs(msg.get_date() - time.time()) < 60)
1038 msg.set_date(0.0)
1039 self.assert_(msg.get_date() == 0.0)
1040
1041 def test_info(self):
1042 # Use get_info() and set_info()
1043 msg = mailbox.MaildirMessage(_sample_message)
1044 self.assert_(msg.get_info() == '')
1045 msg.set_info('1,foo=bar')
1046 self.assert_(msg.get_info() == '1,foo=bar')
1047 self.assertRaises(TypeError, lambda: msg.set_info(None))
1048 self._check_sample(msg)
1049
1050 def test_info_and_flags(self):
1051 # Test interaction of info and flag methods
1052 msg = mailbox.MaildirMessage(_sample_message)
1053 self.assert_(msg.get_info() == '')
1054 msg.set_flags('SF')
1055 self.assert_(msg.get_flags() == 'FS')
1056 self.assert_(msg.get_info() == '2,FS')
1057 msg.set_info('1,')
1058 self.assert_(msg.get_flags() == '')
1059 self.assert_(msg.get_info() == '1,')
1060 msg.remove_flag('RPT')
1061 self.assert_(msg.get_flags() == '')
1062 self.assert_(msg.get_info() == '1,')
1063 msg.add_flag('D')
1064 self.assert_(msg.get_flags() == 'D')
1065 self.assert_(msg.get_info() == '2,D')
1066 self._check_sample(msg)
1067
1068
1069class _TestMboxMMDFMessage(TestMessage):
1070
1071 _factory = mailbox._mboxMMDFMessage
1072
1073 def _post_initialize_hook(self, msg):
1074 self._check_from(msg)
1075
1076 def test_initialize_with_unixfrom(self):
1077 # Initialize with a message that already has a _unixfrom attribute
1078 msg = mailbox.Message(_sample_message)
1079 msg.set_unixfrom('From foo@bar blah')
1080 msg = mailbox.mboxMessage(msg)
1081 self.assert_(msg.get_from() == 'foo@bar blah', msg.get_from())
1082
1083 def test_from(self):
1084 # Get and set "From " line
1085 msg = mailbox.mboxMessage(_sample_message)
1086 self._check_from(msg)
1087 msg.set_from('foo bar')
1088 self.assert_(msg.get_from() == 'foo bar')
1089 msg.set_from('foo@bar', True)
1090 self._check_from(msg, 'foo@bar')
1091 msg.set_from('blah@temp', time.localtime())
1092 self._check_from(msg, 'blah@temp')
1093
1094 def test_flags(self):
1095 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1096 msg = mailbox.mboxMessage(_sample_message)
1097 self.assert_(msg.get_flags() == '')
1098 msg.set_flags('F')
1099 self.assert_(msg.get_flags() == 'F')
1100 msg.set_flags('XODR')
1101 self.assert_(msg.get_flags() == 'RODX')
1102 msg.add_flag('FA')
1103 self.assert_(msg.get_flags() == 'RODFAX')
1104 msg.remove_flag('FDXA')
1105 self.assert_(msg.get_flags() == 'RO')
1106 self._check_sample(msg)
1107
1108 def _check_from(self, msg, sender=None):
1109 # Check contents of "From " line
1110 if sender is None:
1111 sender = "MAILER-DAEMON"
1112 self.assert_(re.match(sender + r" \w{3} \w{3} [\d ]\d [\d ]\d:\d{2}:"
1113 r"\d{2} \d{4}", msg.get_from()) is not None)
1114
1115
1116class TestMboxMessage(_TestMboxMMDFMessage):
1117
1118 _factory = mailbox.mboxMessage
1119
1120
1121class TestMHMessage(TestMessage):
1122
1123 _factory = mailbox.MHMessage
1124
1125 def _post_initialize_hook(self, msg):
1126 self.assert_(msg._sequences == [])
1127
1128 def test_sequences(self):
1129 # Get, set, join, and leave sequences
1130 msg = mailbox.MHMessage(_sample_message)
1131 self.assert_(msg.get_sequences() == [])
1132 msg.set_sequences(['foobar'])
1133 self.assert_(msg.get_sequences() == ['foobar'])
1134 msg.set_sequences([])
1135 self.assert_(msg.get_sequences() == [])
1136 msg.add_sequence('unseen')
1137 self.assert_(msg.get_sequences() == ['unseen'])
1138 msg.add_sequence('flagged')
1139 self.assert_(msg.get_sequences() == ['unseen', 'flagged'])
1140 msg.add_sequence('flagged')
1141 self.assert_(msg.get_sequences() == ['unseen', 'flagged'])
1142 msg.remove_sequence('unseen')
1143 self.assert_(msg.get_sequences() == ['flagged'])
1144 msg.add_sequence('foobar')
1145 self.assert_(msg.get_sequences() == ['flagged', 'foobar'])
1146 msg.remove_sequence('replied')
1147 self.assert_(msg.get_sequences() == ['flagged', 'foobar'])
1148 msg.set_sequences(['foobar', 'replied'])
1149 self.assert_(msg.get_sequences() == ['foobar', 'replied'])
1150
1151
1152class TestBabylMessage(TestMessage):
1153
1154 _factory = mailbox.BabylMessage
1155
1156 def _post_initialize_hook(self, msg):
1157 self.assert_(msg._labels == [])
1158
1159 def test_labels(self):
1160 # Get, set, join, and leave labels
1161 msg = mailbox.BabylMessage(_sample_message)
1162 self.assert_(msg.get_labels() == [])
1163 msg.set_labels(['foobar'])
1164 self.assert_(msg.get_labels() == ['foobar'])
1165 msg.set_labels([])
1166 self.assert_(msg.get_labels() == [])
1167 msg.add_label('filed')
1168 self.assert_(msg.get_labels() == ['filed'])
1169 msg.add_label('resent')
1170 self.assert_(msg.get_labels() == ['filed', 'resent'])
1171 msg.add_label('resent')
1172 self.assert_(msg.get_labels() == ['filed', 'resent'])
1173 msg.remove_label('filed')
1174 self.assert_(msg.get_labels() == ['resent'])
1175 msg.add_label('foobar')
1176 self.assert_(msg.get_labels() == ['resent', 'foobar'])
1177 msg.remove_label('unseen')
1178 self.assert_(msg.get_labels() == ['resent', 'foobar'])
1179 msg.set_labels(['foobar', 'answered'])
1180 self.assert_(msg.get_labels() == ['foobar', 'answered'])
1181
1182 def test_visible(self):
1183 # Get, set, and update visible headers
1184 msg = mailbox.BabylMessage(_sample_message)
1185 visible = msg.get_visible()
1186 self.assert_(visible.keys() == [])
1187 self.assert_(visible.get_payload() is None)
1188 visible['User-Agent'] = 'FooBar 1.0'
1189 visible['X-Whatever'] = 'Blah'
1190 self.assert_(msg.get_visible().keys() == [])
1191 msg.set_visible(visible)
1192 visible = msg.get_visible()
1193 self.assert_(visible.keys() == ['User-Agent', 'X-Whatever'])
1194 self.assert_(visible['User-Agent'] == 'FooBar 1.0')
1195 self.assert_(visible['X-Whatever'] == 'Blah')
1196 self.assert_(visible.get_payload() is None)
1197 msg.update_visible()
1198 self.assert_(visible.keys() == ['User-Agent', 'X-Whatever'])
1199 self.assert_(visible.get_payload() is None)
1200 visible = msg.get_visible()
1201 self.assert_(visible.keys() == ['User-Agent', 'Date', 'From', 'To',
1202 'Subject'])
1203 for header in ('User-Agent', 'Date', 'From', 'To', 'Subject'):
1204 self.assert_(visible[header] == msg[header])
1205
1206
1207class TestMMDFMessage(_TestMboxMMDFMessage):
1208
1209 _factory = mailbox.MMDFMessage
1210
1211
1212class TestMessageConversion(TestBase):
1213
1214 def test_plain_to_x(self):
1215 # Convert Message to all formats
1216 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1217 mailbox.mboxMessage, mailbox.MHMessage,
1218 mailbox.BabylMessage, mailbox.MMDFMessage):
1219 msg_plain = mailbox.Message(_sample_message)
1220 msg = class_(msg_plain)
1221 self._check_sample(msg)
1222
1223 def test_x_to_plain(self):
1224 # Convert all formats to Message
1225 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1226 mailbox.mboxMessage, mailbox.MHMessage,
1227 mailbox.BabylMessage, mailbox.MMDFMessage):
1228 msg = class_(_sample_message)
1229 msg_plain = mailbox.Message(msg)
1230 self._check_sample(msg_plain)
1231
1232 def test_x_to_invalid(self):
1233 # Convert all formats to an invalid format
1234 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1235 mailbox.mboxMessage, mailbox.MHMessage,
1236 mailbox.BabylMessage, mailbox.MMDFMessage):
1237 self.assertRaises(TypeError, lambda: class_(False))
1238
1239 def test_maildir_to_maildir(self):
1240 # Convert MaildirMessage to MaildirMessage
1241 msg_maildir = mailbox.MaildirMessage(_sample_message)
1242 msg_maildir.set_flags('DFPRST')
1243 msg_maildir.set_subdir('cur')
1244 date = msg_maildir.get_date()
1245 msg = mailbox.MaildirMessage(msg_maildir)
1246 self._check_sample(msg)
1247 self.assert_(msg.get_flags() == 'DFPRST')
1248 self.assert_(msg.get_subdir() == 'cur')
1249 self.assert_(msg.get_date() == date)
1250
1251 def test_maildir_to_mboxmmdf(self):
1252 # Convert MaildirMessage to mboxmessage and MMDFMessage
1253 pairs = (('D', ''), ('F', 'F'), ('P', ''), ('R', 'A'), ('S', 'R'),
1254 ('T', 'D'), ('DFPRST', 'RDFA'))
1255 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1256 msg_maildir = mailbox.MaildirMessage(_sample_message)
1257 msg_maildir.set_date(0.0)
1258 for setting, result in pairs:
1259 msg_maildir.set_flags(setting)
1260 msg = class_(msg_maildir)
1261 self.assert_(msg.get_flags() == result)
1262 self.assert_(msg.get_from() == 'MAILER-DAEMON %s' %
1263 time.asctime(time.gmtime(0.0)))
1264 msg_maildir.set_subdir('cur')
1265 self.assert_(class_(msg_maildir).get_flags() == 'RODFA')
1266
1267 def test_maildir_to_mh(self):
1268 # Convert MaildirMessage to MHMessage
1269 msg_maildir = mailbox.MaildirMessage(_sample_message)
1270 pairs = (('D', ['unseen']), ('F', ['unseen', 'flagged']),
1271 ('P', ['unseen']), ('R', ['unseen', 'replied']), ('S', []),
1272 ('T', ['unseen']), ('DFPRST', ['replied', 'flagged']))
1273 for setting, result in pairs:
1274 msg_maildir.set_flags(setting)
1275 self.assert_(mailbox.MHMessage(msg_maildir).get_sequences() == \
1276 result)
1277
1278 def test_maildir_to_babyl(self):
1279 # Convert MaildirMessage to Babyl
1280 msg_maildir = mailbox.MaildirMessage(_sample_message)
1281 pairs = (('D', ['unseen']), ('F', ['unseen']),
1282 ('P', ['unseen', 'forwarded']), ('R', ['unseen', 'answered']),
1283 ('S', []), ('T', ['unseen', 'deleted']),
1284 ('DFPRST', ['deleted', 'answered', 'forwarded']))
1285 for setting, result in pairs:
1286 msg_maildir.set_flags(setting)
1287 self.assert_(mailbox.BabylMessage(msg_maildir).get_labels() == \
1288 result)
1289
1290 def test_mboxmmdf_to_maildir(self):
1291 # Convert mboxMessage and MMDFMessage to MaildirMessage
1292 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1293 msg_mboxMMDF = class_(_sample_message)
1294 msg_mboxMMDF.set_from('foo@bar', time.gmtime(0.0))
1295 pairs = (('R', 'S'), ('O', ''), ('D', 'T'), ('F', 'F'), ('A', 'R'),
1296 ('RODFA', 'FRST'))
1297 for setting, result in pairs:
1298 msg_mboxMMDF.set_flags(setting)
1299 msg = mailbox.MaildirMessage(msg_mboxMMDF)
1300 self.assert_(msg.get_flags() == result)
1301 self.assert_(msg.get_date() == 0.0, msg.get_date())
1302 msg_mboxMMDF.set_flags('O')
1303 self.assert_(mailbox.MaildirMessage(msg_mboxMMDF).get_subdir() == \
1304 'cur')
1305
1306 def test_mboxmmdf_to_mboxmmdf(self):
1307 # Convert mboxMessage and MMDFMessage to mboxMessage and MMDFMessage
1308 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1309 msg_mboxMMDF = class_(_sample_message)
1310 msg_mboxMMDF.set_flags('RODFA')
1311 msg_mboxMMDF.set_from('foo@bar')
1312 for class2_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1313 msg2 = class2_(msg_mboxMMDF)
1314 self.assert_(msg2.get_flags() == 'RODFA')
1315 self.assert_(msg2.get_from() == 'foo@bar')
1316
1317 def test_mboxmmdf_to_mh(self):
1318 # Convert mboxMessage and MMDFMessage to MHMessage
1319 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1320 msg_mboxMMDF = class_(_sample_message)
1321 pairs = (('R', []), ('O', ['unseen']), ('D', ['unseen']),
1322 ('F', ['unseen', 'flagged']),
1323 ('A', ['unseen', 'replied']),
1324 ('RODFA', ['replied', 'flagged']))
1325 for setting, result in pairs:
1326 msg_mboxMMDF.set_flags(setting)
1327 self.assert_(mailbox.MHMessage(msg_mboxMMDF).get_sequences() \
1328 == result)
1329
1330 def test_mboxmmdf_to_babyl(self):
1331 # Convert mboxMessage and MMDFMessage to BabylMessage
1332 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1333 msg = class_(_sample_message)
1334 pairs = (('R', []), ('O', ['unseen']),
1335 ('D', ['unseen', 'deleted']), ('F', ['unseen']),
1336 ('A', ['unseen', 'answered']),
1337 ('RODFA', ['deleted', 'answered']))
1338 for setting, result in pairs:
1339 msg.set_flags(setting)
1340 self.assert_(mailbox.BabylMessage(msg).get_labels() == result)
1341
1342 def test_mh_to_maildir(self):
1343 # Convert MHMessage to MaildirMessage
1344 pairs = (('unseen', ''), ('replied', 'RS'), ('flagged', 'FS'))
1345 for setting, result in pairs:
1346 msg = mailbox.MHMessage(_sample_message)
1347 msg.add_sequence(setting)
1348 self.assert_(mailbox.MaildirMessage(msg).get_flags() == result)
1349 self.assert_(mailbox.MaildirMessage(msg).get_subdir() == 'cur')
1350 msg = mailbox.MHMessage(_sample_message)
1351 msg.add_sequence('unseen')
1352 msg.add_sequence('replied')
1353 msg.add_sequence('flagged')
1354 self.assert_(mailbox.MaildirMessage(msg).get_flags() == 'FR')
1355 self.assert_(mailbox.MaildirMessage(msg).get_subdir() == 'cur')
1356
1357 def test_mh_to_mboxmmdf(self):
1358 # Convert MHMessage to mboxMessage and MMDFMessage
1359 pairs = (('unseen', 'O'), ('replied', 'ROA'), ('flagged', 'ROF'))
1360 for setting, result in pairs:
1361 msg = mailbox.MHMessage(_sample_message)
1362 msg.add_sequence(setting)
1363 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1364 self.assert_(class_(msg).get_flags() == result)
1365 msg = mailbox.MHMessage(_sample_message)
1366 msg.add_sequence('unseen')
1367 msg.add_sequence('replied')
1368 msg.add_sequence('flagged')
1369 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1370 self.assert_(class_(msg).get_flags() == 'OFA')
1371
1372 def test_mh_to_mh(self):
1373 # Convert MHMessage to MHMessage
1374 msg = mailbox.MHMessage(_sample_message)
1375 msg.add_sequence('unseen')
1376 msg.add_sequence('replied')
1377 msg.add_sequence('flagged')
1378 self.assert_(mailbox.MHMessage(msg).get_sequences() == \
1379 ['unseen', 'replied', 'flagged'])
1380
1381 def test_mh_to_babyl(self):
1382 # Convert MHMessage to BabylMessage
1383 pairs = (('unseen', ['unseen']), ('replied', ['answered']),
1384 ('flagged', []))
1385 for setting, result in pairs:
1386 msg = mailbox.MHMessage(_sample_message)
1387 msg.add_sequence(setting)
1388 self.assert_(mailbox.BabylMessage(msg).get_labels() == result)
1389 msg = mailbox.MHMessage(_sample_message)
1390 msg.add_sequence('unseen')
1391 msg.add_sequence('replied')
1392 msg.add_sequence('flagged')
1393 self.assert_(mailbox.BabylMessage(msg).get_labels() == \
1394 ['unseen', 'answered'])
1395
1396 def test_babyl_to_maildir(self):
1397 # Convert BabylMessage to MaildirMessage
1398 pairs = (('unseen', ''), ('deleted', 'ST'), ('filed', 'S'),
1399 ('answered', 'RS'), ('forwarded', 'PS'), ('edited', 'S'),
1400 ('resent', 'PS'))
1401 for setting, result in pairs:
1402 msg = mailbox.BabylMessage(_sample_message)
1403 msg.add_label(setting)
1404 self.assert_(mailbox.MaildirMessage(msg).get_flags() == result)
1405 self.assert_(mailbox.MaildirMessage(msg).get_subdir() == 'cur')
1406 msg = mailbox.BabylMessage(_sample_message)
1407 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1408 'edited', 'resent'):
1409 msg.add_label(label)
1410 self.assert_(mailbox.MaildirMessage(msg).get_flags() == 'PRT')
1411 self.assert_(mailbox.MaildirMessage(msg).get_subdir() == 'cur')
1412
1413 def test_babyl_to_mboxmmdf(self):
1414 # Convert BabylMessage to mboxMessage and MMDFMessage
1415 pairs = (('unseen', 'O'), ('deleted', 'ROD'), ('filed', 'RO'),
1416 ('answered', 'ROA'), ('forwarded', 'RO'), ('edited', 'RO'),
1417 ('resent', 'RO'))
1418 for setting, result in pairs:
1419 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1420 msg = mailbox.BabylMessage(_sample_message)
1421 msg.add_label(setting)
1422 self.assert_(class_(msg).get_flags() == result)
1423 msg = mailbox.BabylMessage(_sample_message)
1424 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1425 'edited', 'resent'):
1426 msg.add_label(label)
1427 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1428 self.assert_(class_(msg).get_flags() == 'ODA')
1429
1430 def test_babyl_to_mh(self):
1431 # Convert BabylMessage to MHMessage
1432 pairs = (('unseen', ['unseen']), ('deleted', []), ('filed', []),
1433 ('answered', ['replied']), ('forwarded', []), ('edited', []),
1434 ('resent', []))
1435 for setting, result in pairs:
1436 msg = mailbox.BabylMessage(_sample_message)
1437 msg.add_label(setting)
1438 self.assert_(mailbox.MHMessage(msg).get_sequences() == result)
1439 msg = mailbox.BabylMessage(_sample_message)
1440 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1441 'edited', 'resent'):
1442 msg.add_label(label)
1443 self.assert_(mailbox.MHMessage(msg).get_sequences() == \
1444 ['unseen', 'replied'])
1445
1446 def test_babyl_to_babyl(self):
1447 # Convert BabylMessage to BabylMessage
1448 msg = mailbox.BabylMessage(_sample_message)
1449 msg.update_visible()
1450 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1451 'edited', 'resent'):
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001452 msg.add_label(label)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001453 msg2 = mailbox.BabylMessage(msg)
1454 self.assert_(msg2.get_labels() == ['unseen', 'deleted', 'filed',
1455 'answered', 'forwarded', 'edited',
1456 'resent'])
1457 self.assert_(msg.get_visible().keys() == msg2.get_visible().keys())
1458 for key in msg.get_visible().keys():
1459 self.assert_(msg.get_visible()[key] == msg2.get_visible()[key])
1460
1461
1462class TestProxyFileBase(TestBase):
1463
1464 def _test_read(self, proxy):
1465 # Read by byte
1466 proxy.seek(0)
1467 self.assert_(proxy.read() == 'bar')
1468 proxy.seek(1)
1469 self.assert_(proxy.read() == 'ar')
1470 proxy.seek(0)
1471 self.assert_(proxy.read(2) == 'ba')
1472 proxy.seek(1)
1473 self.assert_(proxy.read(-1) == 'ar')
1474 proxy.seek(2)
1475 self.assert_(proxy.read(1000) == 'r')
1476
1477 def _test_readline(self, proxy):
1478 # Read by line
1479 proxy.seek(0)
1480 self.assert_(proxy.readline() == 'foo' + os.linesep)
1481 self.assert_(proxy.readline() == 'bar' + os.linesep)
1482 self.assert_(proxy.readline() == 'fred' + os.linesep)
1483 self.assert_(proxy.readline() == 'bob')
1484 proxy.seek(2)
1485 self.assert_(proxy.readline() == 'o' + os.linesep)
1486 proxy.seek(6 + 2 * len(os.linesep))
1487 self.assert_(proxy.readline() == 'fred' + os.linesep)
1488 proxy.seek(6 + 2 * len(os.linesep))
1489 self.assert_(proxy.readline(2) == 'fr')
1490 self.assert_(proxy.readline(-10) == 'ed' + os.linesep)
1491
1492 def _test_readlines(self, proxy):
1493 # Read multiple lines
1494 proxy.seek(0)
1495 self.assert_(proxy.readlines() == ['foo' + os.linesep,
1496 'bar' + os.linesep,
1497 'fred' + os.linesep, 'bob'])
1498 proxy.seek(0)
1499 self.assert_(proxy.readlines(2) == ['foo' + os.linesep])
1500 proxy.seek(3 + len(os.linesep))
1501 self.assert_(proxy.readlines(4 + len(os.linesep)) ==
1502 ['bar' + os.linesep, 'fred' + os.linesep])
1503 proxy.seek(3)
1504 self.assert_(proxy.readlines(1000) == [os.linesep, 'bar' + os.linesep,
1505 'fred' + os.linesep, 'bob'])
1506
1507 def _test_iteration(self, proxy):
1508 # Iterate by line
1509 proxy.seek(0)
1510 iterator = iter(proxy)
1511 self.assert_(iterator.next() == 'foo' + os.linesep)
1512 self.assert_(iterator.next() == 'bar' + os.linesep)
1513 self.assert_(iterator.next() == 'fred' + os.linesep)
1514 self.assert_(iterator.next() == 'bob')
1515 self.assertRaises(StopIteration, lambda: iterator.next())
1516
1517 def _test_seek_and_tell(self, proxy):
1518 # Seek and use tell to check position
1519 proxy.seek(3)
1520 self.assert_(proxy.tell() == 3)
1521 self.assert_(proxy.read(len(os.linesep)) == os.linesep)
1522 proxy.seek(2, 1)
1523 self.assert_(proxy.read(1 + len(os.linesep)) == 'r' + os.linesep)
1524 proxy.seek(-3 - len(os.linesep), 2)
1525 self.assert_(proxy.read(3) == 'bar')
1526 proxy.seek(2, 0)
1527 self.assert_(proxy.read() == 'o' + os.linesep + 'bar' + os.linesep)
1528 proxy.seek(100)
1529 self.assert_(proxy.read() == '')
1530
1531 def _test_close(self, proxy):
1532 # Close a file
1533 proxy.close()
1534 self.assertRaises(AttributeError, lambda: proxy.close())
1535
1536
1537class TestProxyFile(TestProxyFileBase):
1538
1539 def setUp(self):
1540 self._path = test_support.TESTFN
Andrew M. Kuchling214db632006-05-02 21:44:33 +00001541 self._file = open(self._path, 'wb+')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001542
1543 def tearDown(self):
1544 self._file.close()
1545 self._delete_recursively(self._path)
1546
1547 def test_initialize(self):
1548 # Initialize and check position
1549 self._file.write('foo')
1550 pos = self._file.tell()
1551 proxy0 = mailbox._ProxyFile(self._file)
1552 self.assert_(proxy0.tell() == pos)
1553 self.assert_(self._file.tell() == pos)
1554 proxy1 = mailbox._ProxyFile(self._file, 0)
1555 self.assert_(proxy1.tell() == 0)
1556 self.assert_(self._file.tell() == pos)
1557
1558 def test_read(self):
1559 self._file.write('bar')
1560 self._test_read(mailbox._ProxyFile(self._file))
1561
1562 def test_readline(self):
1563 self._file.write('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1564 os.linesep))
1565 self._test_readline(mailbox._ProxyFile(self._file))
1566
1567 def test_readlines(self):
1568 self._file.write('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1569 os.linesep))
1570 self._test_readlines(mailbox._ProxyFile(self._file))
1571
1572 def test_iteration(self):
1573 self._file.write('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1574 os.linesep))
1575 self._test_iteration(mailbox._ProxyFile(self._file))
1576
1577 def test_seek_and_tell(self):
1578 self._file.write('foo%sbar%s' % (os.linesep, os.linesep))
1579 self._test_seek_and_tell(mailbox._ProxyFile(self._file))
1580
1581 def test_close(self):
1582 self._file.write('foo%sbar%s' % (os.linesep, os.linesep))
1583 self._test_close(mailbox._ProxyFile(self._file))
1584
1585
1586class TestPartialFile(TestProxyFileBase):
1587
1588 def setUp(self):
1589 self._path = test_support.TESTFN
Andrew M. Kuchling214db632006-05-02 21:44:33 +00001590 self._file = open(self._path, 'wb+')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001591
1592 def tearDown(self):
1593 self._file.close()
1594 self._delete_recursively(self._path)
1595
1596 def test_initialize(self):
1597 # Initialize and check position
1598 self._file.write('foo' + os.linesep + 'bar')
1599 pos = self._file.tell()
1600 proxy = mailbox._PartialFile(self._file, 2, 5)
1601 self.assert_(proxy.tell() == 0)
1602 self.assert_(self._file.tell() == pos)
1603
1604 def test_read(self):
1605 self._file.write('***bar***')
1606 self._test_read(mailbox._PartialFile(self._file, 3, 6))
1607
1608 def test_readline(self):
1609 self._file.write('!!!!!foo%sbar%sfred%sbob!!!!!' %
1610 (os.linesep, os.linesep, os.linesep))
1611 self._test_readline(mailbox._PartialFile(self._file, 5,
1612 18 + 3 * len(os.linesep)))
1613
1614 def test_readlines(self):
1615 self._file.write('foo%sbar%sfred%sbob?????' %
1616 (os.linesep, os.linesep, os.linesep))
1617 self._test_readlines(mailbox._PartialFile(self._file, 0,
1618 13 + 3 * len(os.linesep)))
1619
1620 def test_iteration(self):
1621 self._file.write('____foo%sbar%sfred%sbob####' %
1622 (os.linesep, os.linesep, os.linesep))
1623 self._test_iteration(mailbox._PartialFile(self._file, 4,
1624 17 + 3 * len(os.linesep)))
1625
1626 def test_seek_and_tell(self):
1627 self._file.write('(((foo%sbar%s$$$' % (os.linesep, os.linesep))
1628 self._test_seek_and_tell(mailbox._PartialFile(self._file, 3,
1629 9 + 2 * len(os.linesep)))
1630
1631 def test_close(self):
1632 self._file.write('&foo%sbar%s^' % (os.linesep, os.linesep))
1633 self._test_close(mailbox._PartialFile(self._file, 1,
1634 6 + 3 * len(os.linesep)))
1635
1636
1637## Start: tests from the original module (for backward compatibility).
1638
Skip Montanaro5253da12004-07-24 19:56:03 +00001639FROM_ = "From some.body@dummy.domain Sat Jul 24 13:43:35 2004\n"
Fred Drakec02bc3e2001-05-21 20:23:21 +00001640DUMMY_MESSAGE = """\
1641From: some.body@dummy.domain
1642To: me@my.domain
Skip Montanaro5253da12004-07-24 19:56:03 +00001643Subject: Simple Test
Fred Drakec02bc3e2001-05-21 20:23:21 +00001644
1645This is a dummy message.
1646"""
1647
Fred Drakec02bc3e2001-05-21 20:23:21 +00001648class MaildirTestCase(unittest.TestCase):
1649
1650 def setUp(self):
1651 # create a new maildir mailbox to work with:
1652 self._dir = test_support.TESTFN
1653 os.mkdir(self._dir)
1654 os.mkdir(os.path.join(self._dir, "cur"))
1655 os.mkdir(os.path.join(self._dir, "tmp"))
1656 os.mkdir(os.path.join(self._dir, "new"))
1657 self._counter = 1
1658 self._msgfiles = []
1659
1660 def tearDown(self):
1661 map(os.unlink, self._msgfiles)
1662 os.rmdir(os.path.join(self._dir, "cur"))
1663 os.rmdir(os.path.join(self._dir, "tmp"))
1664 os.rmdir(os.path.join(self._dir, "new"))
1665 os.rmdir(self._dir)
1666
Skip Montanaro5253da12004-07-24 19:56:03 +00001667 def createMessage(self, dir, mbox=False):
Jack Jansen97df7b62001-06-19 20:20:05 +00001668 t = int(time.time() % 1000000)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001669 pid = self._counter
1670 self._counter += 1
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001671 filename = os.extsep.join((str(t), str(pid), "myhostname", "mydomain"))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001672 tmpname = os.path.join(self._dir, "tmp", filename)
1673 newname = os.path.join(self._dir, dir, filename)
1674 fp = open(tmpname, "w")
1675 self._msgfiles.append(tmpname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001676 if mbox:
1677 fp.write(FROM_)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001678 fp.write(DUMMY_MESSAGE)
1679 fp.close()
Tim Peters6626c1f2001-05-22 16:29:01 +00001680 if hasattr(os, "link"):
1681 os.link(tmpname, newname)
1682 else:
1683 fp = open(newname, "w")
1684 fp.write(DUMMY_MESSAGE)
1685 fp.close()
Fred Drakec02bc3e2001-05-21 20:23:21 +00001686 self._msgfiles.append(newname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001687 return tmpname
Fred Drakec02bc3e2001-05-21 20:23:21 +00001688
1689 def test_empty_maildir(self):
1690 """Test an empty maildir mailbox"""
1691 # Test for regression on bug #117490:
1692 # Make sure the boxes attribute actually gets set.
1693 self.mbox = mailbox.Maildir(test_support.TESTFN)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001694 #self.assert_(hasattr(self.mbox, "boxes"))
1695 #self.assert_(len(self.mbox.boxes) == 0)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001696 self.assert_(self.mbox.next() is None)
1697 self.assert_(self.mbox.next() is None)
1698
1699 def test_nonempty_maildir_cur(self):
1700 self.createMessage("cur")
1701 self.mbox = mailbox.Maildir(test_support.TESTFN)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001702 #self.assert_(len(self.mbox.boxes) == 1)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001703 self.assert_(self.mbox.next() is not None)
1704 self.assert_(self.mbox.next() is None)
1705 self.assert_(self.mbox.next() is None)
1706
1707 def test_nonempty_maildir_new(self):
1708 self.createMessage("new")
1709 self.mbox = mailbox.Maildir(test_support.TESTFN)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001710 #self.assert_(len(self.mbox.boxes) == 1)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001711 self.assert_(self.mbox.next() is not None)
1712 self.assert_(self.mbox.next() is None)
1713 self.assert_(self.mbox.next() is None)
1714
1715 def test_nonempty_maildir_both(self):
1716 self.createMessage("cur")
1717 self.createMessage("new")
1718 self.mbox = mailbox.Maildir(test_support.TESTFN)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001719 #self.assert_(len(self.mbox.boxes) == 2)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001720 self.assert_(self.mbox.next() is not None)
1721 self.assert_(self.mbox.next() is not None)
1722 self.assert_(self.mbox.next() is None)
1723 self.assert_(self.mbox.next() is None)
Fred Drake0aaed272000-10-23 13:39:15 +00001724
Skip Montanaro5253da12004-07-24 19:56:03 +00001725 def test_unix_mbox(self):
1726 ### should be better!
1727 import email.Parser
1728 fname = self.createMessage("cur", True)
1729 n = 0
1730 for msg in mailbox.PortableUnixMailbox(open(fname),
1731 email.Parser.Parser().parse):
1732 n += 1
1733 self.assertEqual(msg["subject"], "Simple Test")
1734 self.assertEqual(len(str(msg)), len(FROM_)+len(DUMMY_MESSAGE))
1735 self.assertEqual(n, 1)
1736
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001737## End: classes from the original module (for backward compatibility).
1738
1739
1740_sample_message = """\
1741Return-Path: <gkj@gregorykjohnson.com>
1742X-Original-To: gkj+person@localhost
1743Delivered-To: gkj+person@localhost
1744Received: from localhost (localhost [127.0.0.1])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001745 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1746 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001747Delivered-To: gkj@sundance.gregorykjohnson.com
1748Received: from localhost [127.0.0.1]
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001749 by localhost with POP3 (fetchmail-6.2.5)
1750 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001751Received: from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001752 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1753 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001754Received: by andy.gregorykjohnson.com (Postfix, from userid 1000)
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001755 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001756Date: Wed, 13 Jul 2005 17:23:11 -0400
1757From: "Gregory K. Johnson" <gkj@gregorykjohnson.com>
1758To: gkj@gregorykjohnson.com
1759Subject: Sample message
1760Message-ID: <20050713212311.GC4701@andy.gregorykjohnson.com>
1761Mime-Version: 1.0
1762Content-Type: multipart/mixed; boundary="NMuMz9nt05w80d4+"
1763Content-Disposition: inline
1764User-Agent: Mutt/1.5.9i
1765
1766
1767--NMuMz9nt05w80d4+
1768Content-Type: text/plain; charset=us-ascii
1769Content-Disposition: inline
1770
1771This is a sample message.
1772
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001773--
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001774Gregory K. Johnson
1775
1776--NMuMz9nt05w80d4+
1777Content-Type: application/octet-stream
1778Content-Disposition: attachment; filename="text.gz"
1779Content-Transfer-Encoding: base64
1780
1781H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
17823FYlAAAA
1783
1784--NMuMz9nt05w80d4+--
1785"""
1786
1787_sample_headers = {
1788 "Return-Path":"<gkj@gregorykjohnson.com>",
1789 "X-Original-To":"gkj+person@localhost",
1790 "Delivered-To":"gkj+person@localhost",
1791 "Received":"""from localhost (localhost [127.0.0.1])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001792 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1793 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001794 "Delivered-To":"gkj@sundance.gregorykjohnson.com",
1795 "Received":"""from localhost [127.0.0.1]
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001796 by localhost with POP3 (fetchmail-6.2.5)
1797 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001798 "Received":"""from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001799 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1800 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001801 "Received":"""by andy.gregorykjohnson.com (Postfix, from userid 1000)
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001802 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001803 "Date":"Wed, 13 Jul 2005 17:23:11 -0400",
1804 "From":""""Gregory K. Johnson" <gkj@gregorykjohnson.com>""",
1805 "To":"gkj@gregorykjohnson.com",
1806 "Subject":"Sample message",
1807 "Mime-Version":"1.0",
1808 "Content-Type":"""multipart/mixed; boundary="NMuMz9nt05w80d4+\"""",
1809 "Content-Disposition":"inline",
1810 "User-Agent": "Mutt/1.5.9i" }
1811
1812_sample_payloads = ("""This 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"""H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
18183FYlAAAA
1819""")
Fred Drake0aaed272000-10-23 13:39:15 +00001820
Fred Drakec02bc3e2001-05-21 20:23:21 +00001821
Fred Drake2e2be372001-09-20 21:33:42 +00001822def test_main():
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001823 tests = (TestMailboxSuperclass, TestMaildir, TestMbox, TestMMDF, TestMH,
1824 TestBabyl, TestMessage, TestMaildirMessage, TestMboxMessage,
1825 TestMHMessage, TestBabylMessage, TestMMDFMessage,
1826 TestMessageConversion, TestProxyFile, TestPartialFile,
1827 MaildirTestCase)
1828 test_support.run_unittest(*tests)
Neal Norwitzb15ac312006-06-29 04:10:08 +00001829 test_support.reap_children()
Fred Drake2e2be372001-09-20 21:33:42 +00001830
1831
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001832if __name__ == '__main__':
Fred Drake2e2be372001-09-20 21:33:42 +00001833 test_main()