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