blob: 714bf252ba81cb535995c56ec621915c40cfddf8 [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
Neal Norwitz22b3e3a2008-03-26 05:19:41 +0000382 self._test_flush_or_close(self._box.flush, True)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000383
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
Neal Norwitz22b3e3a2008-03-26 05:19:41 +0000394 self._test_flush_or_close(self._box.close, False)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000395
Neal Norwitz22b3e3a2008-03-26 05:19:41 +0000396 def _test_flush_or_close(self, method, should_call_close):
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000397 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()
Neal Norwitz22b3e3a2008-03-26 05:19:41 +0000402 if should_call_close:
403 self._box.close()
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000404 self._box = self._factory(self._path)
405 keys = self._box.keys()
406 self.assert_(len(keys) == 3)
407 for key in keys:
408 self.assert_(self._box.get_string(key) in contents)
409
410 def test_dump_message(self):
411 # Write message representations to disk
412 for input in (email.message_from_string(_sample_message),
413 _sample_message, StringIO.StringIO(_sample_message)):
414 output = StringIO.StringIO()
415 self._box._dump_message(input, output)
416 self.assert_(output.getvalue() ==
417 _sample_message.replace('\n', os.linesep))
418 output = StringIO.StringIO()
419 self.assertRaises(TypeError,
420 lambda: self._box._dump_message(None, output))
421
422 def _get_lock_path(self):
423 # Return the path of the dot lock file. May be overridden.
424 return self._path + '.lock'
425
426
427class TestMailboxSuperclass(TestBase):
428
429 def test_notimplemented(self):
430 # Test that all Mailbox methods raise NotImplementedException.
431 box = mailbox.Mailbox('path')
432 self.assertRaises(NotImplementedError, lambda: box.add(''))
433 self.assertRaises(NotImplementedError, lambda: box.remove(''))
434 self.assertRaises(NotImplementedError, lambda: box.__delitem__(''))
435 self.assertRaises(NotImplementedError, lambda: box.discard(''))
436 self.assertRaises(NotImplementedError, lambda: box.__setitem__('', ''))
437 self.assertRaises(NotImplementedError, lambda: box.iterkeys())
438 self.assertRaises(NotImplementedError, lambda: box.keys())
439 self.assertRaises(NotImplementedError, lambda: box.itervalues().next())
440 self.assertRaises(NotImplementedError, lambda: box.__iter__().next())
441 self.assertRaises(NotImplementedError, lambda: box.values())
442 self.assertRaises(NotImplementedError, lambda: box.iteritems().next())
443 self.assertRaises(NotImplementedError, lambda: box.items())
444 self.assertRaises(NotImplementedError, lambda: box.get(''))
445 self.assertRaises(NotImplementedError, lambda: box.__getitem__(''))
446 self.assertRaises(NotImplementedError, lambda: box.get_message(''))
447 self.assertRaises(NotImplementedError, lambda: box.get_string(''))
448 self.assertRaises(NotImplementedError, lambda: box.get_file(''))
449 self.assertRaises(NotImplementedError, lambda: box.has_key(''))
450 self.assertRaises(NotImplementedError, lambda: box.__contains__(''))
451 self.assertRaises(NotImplementedError, lambda: box.__len__())
452 self.assertRaises(NotImplementedError, lambda: box.clear())
453 self.assertRaises(NotImplementedError, lambda: box.pop(''))
454 self.assertRaises(NotImplementedError, lambda: box.popitem())
455 self.assertRaises(NotImplementedError, lambda: box.update((('', ''),)))
456 self.assertRaises(NotImplementedError, lambda: box.flush())
457 self.assertRaises(NotImplementedError, lambda: box.lock())
458 self.assertRaises(NotImplementedError, lambda: box.unlock())
459 self.assertRaises(NotImplementedError, lambda: box.close())
460
461
462class TestMaildir(TestMailbox):
463
464 _factory = lambda self, path, factory=None: mailbox.Maildir(path, factory)
465
466 def setUp(self):
467 TestMailbox.setUp(self)
Neal Norwitz003c9e22006-08-11 06:09:41 +0000468 if os.name in ('nt', 'os2') or sys.platform == 'cygwin':
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000469 self._box.colon = '!'
470
471 def test_add_MM(self):
472 # Add a MaildirMessage instance
473 msg = mailbox.MaildirMessage(self._template % 0)
474 msg.set_subdir('cur')
475 msg.set_info('foo')
476 key = self._box.add(msg)
477 self.assert_(os.path.exists(os.path.join(self._path, 'cur', '%s%sfoo' %
478 (key, self._box.colon))))
479
480 def test_get_MM(self):
481 # Get a MaildirMessage instance
482 msg = mailbox.MaildirMessage(self._template % 0)
483 msg.set_subdir('cur')
484 msg.set_flags('RF')
485 key = self._box.add(msg)
486 msg_returned = self._box.get_message(key)
487 self.assert_(isinstance(msg_returned, mailbox.MaildirMessage))
488 self.assert_(msg_returned.get_subdir() == 'cur')
489 self.assert_(msg_returned.get_flags() == 'FR')
490
491 def test_set_MM(self):
492 # Set with a MaildirMessage instance
493 msg0 = mailbox.MaildirMessage(self._template % 0)
494 msg0.set_flags('TP')
495 key = self._box.add(msg0)
496 msg_returned = self._box.get_message(key)
497 self.assert_(msg_returned.get_subdir() == 'new')
498 self.assert_(msg_returned.get_flags() == 'PT')
499 msg1 = mailbox.MaildirMessage(self._template % 1)
500 self._box[key] = msg1
501 msg_returned = self._box.get_message(key)
502 self.assert_(msg_returned.get_subdir() == 'new')
503 self.assert_(msg_returned.get_flags() == '')
504 self.assert_(msg_returned.get_payload() == '1')
505 msg2 = mailbox.MaildirMessage(self._template % 2)
506 msg2.set_info('2,S')
507 self._box[key] = msg2
508 self._box[key] = self._template % 3
509 msg_returned = self._box.get_message(key)
510 self.assert_(msg_returned.get_subdir() == 'new')
511 self.assert_(msg_returned.get_flags() == 'S')
512 self.assert_(msg_returned.get_payload() == '3')
513
Andrew M. Kuchling15ce8802008-01-19 20:12:04 +0000514 def test_consistent_factory(self):
515 # Add a message.
516 msg = mailbox.MaildirMessage(self._template % 0)
517 msg.set_subdir('cur')
518 msg.set_flags('RF')
519 key = self._box.add(msg)
520
521 # Create new mailbox with
522 class FakeMessage(mailbox.MaildirMessage):
523 pass
524 box = mailbox.Maildir(self._path, factory=FakeMessage)
Amaury Forgeot d'Arc07974d72008-02-03 23:15:32 +0000525 box.colon = self._box.colon
Andrew M. Kuchling15ce8802008-01-19 20:12:04 +0000526 msg2 = box.get_message(key)
527 self.assert_(isinstance(msg2, FakeMessage))
528
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000529 def test_initialize_new(self):
530 # Initialize a non-existent mailbox
531 self.tearDown()
532 self._box = mailbox.Maildir(self._path)
533 self._check_basics(factory=rfc822.Message)
534 self._delete_recursively(self._path)
535 self._box = self._factory(self._path, factory=None)
536 self._check_basics()
537
538 def test_initialize_existing(self):
539 # Initialize an existing mailbox
540 self.tearDown()
541 for subdir in '', 'tmp', 'new', 'cur':
Andrew MacIntyreafa358f2006-07-23 13:04:00 +0000542 os.mkdir(os.path.normpath(os.path.join(self._path, subdir)))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000543 self._box = mailbox.Maildir(self._path)
544 self._check_basics(factory=rfc822.Message)
545 self._box = mailbox.Maildir(self._path, factory=None)
546 self._check_basics()
547
548 def _check_basics(self, factory=None):
549 # (Used by test_open_new() and test_open_existing().)
550 self.assertEqual(self._box._path, os.path.abspath(self._path))
551 self.assertEqual(self._box._factory, factory)
552 for subdir in '', 'tmp', 'new', 'cur':
553 path = os.path.join(self._path, subdir)
554 mode = os.stat(path)[stat.ST_MODE]
555 self.assert_(stat.S_ISDIR(mode), "Not a directory: '%s'" % path)
556
557 def test_list_folders(self):
558 # List folders
559 self._box.add_folder('one')
560 self._box.add_folder('two')
561 self._box.add_folder('three')
562 self.assert_(len(self._box.list_folders()) == 3)
563 self.assert_(set(self._box.list_folders()) ==
564 set(('one', 'two', 'three')))
565
566 def test_get_folder(self):
567 # Open folders
568 self._box.add_folder('foo.bar')
569 folder0 = self._box.get_folder('foo.bar')
570 folder0.add(self._template % 'bar')
571 self.assert_(os.path.isdir(os.path.join(self._path, '.foo.bar')))
572 folder1 = self._box.get_folder('foo.bar')
573 self.assert_(folder1.get_string(folder1.keys()[0]) == \
574 self._template % 'bar')
575
576 def test_add_and_remove_folders(self):
577 # Delete folders
578 self._box.add_folder('one')
579 self._box.add_folder('two')
580 self.assert_(len(self._box.list_folders()) == 2)
581 self.assert_(set(self._box.list_folders()) == set(('one', 'two')))
582 self._box.remove_folder('one')
583 self.assert_(len(self._box.list_folders()) == 1)
584 self.assert_(set(self._box.list_folders()) == set(('two',)))
585 self._box.add_folder('three')
586 self.assert_(len(self._box.list_folders()) == 2)
587 self.assert_(set(self._box.list_folders()) == set(('two', 'three')))
588 self._box.remove_folder('three')
589 self.assert_(len(self._box.list_folders()) == 1)
590 self.assert_(set(self._box.list_folders()) == set(('two',)))
591 self._box.remove_folder('two')
592 self.assert_(len(self._box.list_folders()) == 0)
593 self.assert_(self._box.list_folders() == [])
594
595 def test_clean(self):
596 # Remove old files from 'tmp'
597 foo_path = os.path.join(self._path, 'tmp', 'foo')
598 bar_path = os.path.join(self._path, 'tmp', 'bar')
Guido van Rossumb2045832006-05-02 20:47:36 +0000599 f = open(foo_path, 'w')
600 f.write("@")
601 f.close()
602 f = open(bar_path, 'w')
603 f.write("@")
604 f.close()
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000605 self._box.clean()
606 self.assert_(os.path.exists(foo_path))
607 self.assert_(os.path.exists(bar_path))
608 foo_stat = os.stat(foo_path)
Guido van Rossumb2045832006-05-02 20:47:36 +0000609 os.utime(foo_path, (time.time() - 129600 - 2,
610 foo_stat.st_mtime))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000611 self._box.clean()
612 self.assert_(not os.path.exists(foo_path))
613 self.assert_(os.path.exists(bar_path))
614
615 def test_create_tmp(self, repetitions=10):
616 # Create files in tmp directory
617 hostname = socket.gethostname()
618 if '/' in hostname:
619 hostname = hostname.replace('/', r'\057')
620 if ':' in hostname:
621 hostname = hostname.replace(':', r'\072')
622 pid = os.getpid()
623 pattern = re.compile(r"(?P<time>\d+)\.M(?P<M>\d{1,6})P(?P<P>\d+)"
624 r"Q(?P<Q>\d+)\.(?P<host>[^:/]+)")
625 previous_groups = None
626 for x in xrange(repetitions):
627 tmp_file = self._box._create_tmp()
628 head, tail = os.path.split(tmp_file.name)
629 self.assertEqual(head, os.path.abspath(os.path.join(self._path,
630 "tmp")),
631 "File in wrong location: '%s'" % head)
632 match = pattern.match(tail)
Benjamin Peterson5b63acd2008-03-29 15:24:25 +0000633 self.assert_(match is not None, "Invalid file name: '%s'" % tail)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000634 groups = match.groups()
Benjamin Peterson5b63acd2008-03-29 15:24:25 +0000635 if previous_groups is not None:
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000636 self.assert_(int(groups[0] >= previous_groups[0]),
637 "Non-monotonic seconds: '%s' before '%s'" %
638 (previous_groups[0], groups[0]))
639 self.assert_(int(groups[1] >= previous_groups[1]) or
640 groups[0] != groups[1],
641 "Non-monotonic milliseconds: '%s' before '%s'" %
642 (previous_groups[1], groups[1]))
643 self.assert_(int(groups[2]) == pid,
644 "Process ID mismatch: '%s' should be '%s'" %
645 (groups[2], pid))
646 self.assert_(int(groups[3]) == int(previous_groups[3]) + 1,
647 "Non-sequential counter: '%s' before '%s'" %
648 (previous_groups[3], groups[3]))
649 self.assert_(groups[4] == hostname,
650 "Host name mismatch: '%s' should be '%s'" %
651 (groups[4], hostname))
652 previous_groups = groups
653 tmp_file.write(_sample_message)
654 tmp_file.seek(0)
655 self.assert_(tmp_file.read() == _sample_message)
656 tmp_file.close()
657 file_count = len(os.listdir(os.path.join(self._path, "tmp")))
658 self.assert_(file_count == repetitions,
659 "Wrong file count: '%s' should be '%s'" %
660 (file_count, repetitions))
661
662 def test_refresh(self):
663 # Update the table of contents
664 self.assert_(self._box._toc == {})
665 key0 = self._box.add(self._template % 0)
666 key1 = self._box.add(self._template % 1)
667 self.assert_(self._box._toc == {})
668 self._box._refresh()
669 self.assert_(self._box._toc == {key0: os.path.join('new', key0),
670 key1: os.path.join('new', key1)})
671 key2 = self._box.add(self._template % 2)
672 self.assert_(self._box._toc == {key0: os.path.join('new', key0),
673 key1: os.path.join('new', key1)})
674 self._box._refresh()
675 self.assert_(self._box._toc == {key0: os.path.join('new', key0),
676 key1: os.path.join('new', key1),
677 key2: os.path.join('new', key2)})
678
679 def test_lookup(self):
680 # Look up message subpaths in the TOC
681 self.assertRaises(KeyError, lambda: self._box._lookup('foo'))
682 key0 = self._box.add(self._template % 0)
683 self.assert_(self._box._lookup(key0) == os.path.join('new', key0))
684 os.remove(os.path.join(self._path, 'new', key0))
685 self.assert_(self._box._toc == {key0: os.path.join('new', key0)})
686 self.assertRaises(KeyError, lambda: self._box._lookup(key0))
687 self.assert_(self._box._toc == {})
688
689 def test_lock_unlock(self):
690 # Lock and unlock the mailbox. For Maildir, this does nothing.
691 self._box.lock()
692 self._box.unlock()
693
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000694 def test_folder (self):
695 # Test for bug #1569790: verify that folders returned by .get_folder()
696 # use the same factory function.
697 def dummy_factory (s):
698 return None
699 box = self._factory(self._path, factory=dummy_factory)
700 folder = box.add_folder('folder1')
701 self.assert_(folder._factory is dummy_factory)
Tim Petersf733abb2007-01-30 03:03:46 +0000702
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000703 folder1_alias = box.get_folder('folder1')
704 self.assert_(folder1_alias._factory is dummy_factory)
705
Andrew M. Kuchling2b09ef02007-07-14 21:56:19 +0000706 def test_directory_in_folder (self):
707 # Test that mailboxes still work if there's a stray extra directory
708 # in a folder.
709 for i in range(10):
710 self._box.add(mailbox.Message(_sample_message))
Tim Petersf733abb2007-01-30 03:03:46 +0000711
Andrew M. Kuchling2b09ef02007-07-14 21:56:19 +0000712 # Create a stray directory
713 os.mkdir(os.path.join(self._path, 'cur', 'stray-dir'))
714
715 # Check that looping still works with the directory present.
716 for msg in self._box:
717 pass
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000718
Andrew M. Kuchling10288e12008-08-05 01:00:57 +0000719 def test_file_permissions(self):
720 # Verify that message files are created without execute permissions
721 if not hasattr(os, "stat") or not hasattr(os, "umask"):
722 return
723 msg = mailbox.MaildirMessage(self._template % 0)
724 orig_umask = os.umask(0)
725 try:
726 key = self._box.add(msg)
727 finally:
728 os.umask(orig_umask)
729 path = os.path.join(self._path, self._box._lookup(key))
730 mode = os.stat(path).st_mode
731 self.assert_(mode & 0111 == 0)
732
733 def test_folder_file_perms(self):
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000734 # From bug #3228, we want to verify that the file created inside a Maildir
735 # subfolder isn't marked as executable.
Andrew M. Kuchling10288e12008-08-05 01:00:57 +0000736 if not hasattr(os, "stat") or not hasattr(os, "umask"):
737 return
738
739 orig_umask = os.umask(0)
740 try:
741 subfolder = self._box.add_folder('subfolder')
742 finally:
743 os.umask(orig_umask)
744
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000745 path = os.path.join(subfolder._path, 'maildirfolder')
746 st = os.stat(path)
747 perms = st.st_mode
748 self.assertFalse((perms & 0111)) # Execute bits should all be off.
749
750
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000751class _TestMboxMMDF(TestMailbox):
752
753 def tearDown(self):
754 self._box.close()
755 self._delete_recursively(self._path)
756 for lock_remnant in glob.glob(self._path + '.*'):
Neal Norwitz6cbd8de2007-03-20 06:53:17 +0000757 test_support.unlink(lock_remnant)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000758
759 def test_add_from_string(self):
760 # Add a string starting with 'From ' to the mailbox
761 key = self._box.add('From foo@bar blah\nFrom: foo\n\n0')
762 self.assert_(self._box[key].get_from() == 'foo@bar blah')
763 self.assert_(self._box[key].get_payload() == '0')
764
765 def test_add_mbox_or_mmdf_message(self):
766 # Add an mboxMessage or MMDFMessage
767 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
768 msg = class_('From foo@bar blah\nFrom: foo\n\n0')
769 key = self._box.add(msg)
770
771 def test_open_close_open(self):
772 # Open and inspect previously-created mailbox
773 values = [self._template % i for i in xrange(3)]
774 for value in values:
775 self._box.add(value)
776 self._box.close()
777 mtime = os.path.getmtime(self._path)
778 self._box = self._factory(self._path)
779 self.assert_(len(self._box) == 3)
780 for key in self._box.iterkeys():
781 self.assert_(self._box.get_string(key) in values)
782 self._box.close()
783 self.assert_(mtime == os.path.getmtime(self._path))
784
785 def test_add_and_close(self):
786 # Verifying that closing a mailbox doesn't change added items
787 self._box.add(_sample_message)
788 for i in xrange(3):
789 self._box.add(self._template % i)
790 self._box.add(_sample_message)
791 self._box._file.flush()
792 self._box._file.seek(0)
793 contents = self._box._file.read()
794 self._box.close()
Andrew M. Kuchling214db632006-05-02 21:44:33 +0000795 self.assert_(contents == open(self._path, 'rb').read())
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000796 self._box = self._factory(self._path)
797
Andrew M. Kuchling9afbace2006-06-26 13:23:10 +0000798 def test_lock_conflict(self):
799 # Fork off a subprocess that will lock the file for 2 seconds,
800 # unlock it, and then exit.
Andrew M. Kuchlingec3c3682006-06-26 14:33:24 +0000801 if not hasattr(os, 'fork'):
802 return
Andrew M. Kuchling9afbace2006-06-26 13:23:10 +0000803 pid = os.fork()
804 if pid == 0:
805 # In the child, lock the mailbox.
806 self._box.lock()
807 time.sleep(2)
808 self._box.unlock()
809 os._exit(0)
810
811 # In the parent, sleep a bit to give the child time to acquire
812 # the lock.
813 time.sleep(0.5)
Neal Norwitz003c9e22006-08-11 06:09:41 +0000814 try:
815 self.assertRaises(mailbox.ExternalClashError,
816 self._box.lock)
817 finally:
818 # Wait for child to exit. Locking should now succeed.
819 exited_pid, status = os.waitpid(pid, 0)
Tim Peters3249d002006-06-27 11:52:49 +0000820
Andrew M. Kuchling9afbace2006-06-26 13:23:10 +0000821 self._box.lock()
822 self._box.unlock()
Tim Peters3249d002006-06-27 11:52:49 +0000823
Andrew M. Kuchling0f871832006-10-27 16:55:34 +0000824 def test_relock(self):
825 # Test case for bug #1575506: the mailbox class was locking the
826 # wrong file object in its flush() method.
827 msg = "Subject: sub\n\nbody\n"
828 key1 = self._box.add(msg)
829 self._box.flush()
830 self._box.close()
Tim Petersabd8a332006-11-03 02:32:46 +0000831
Andrew M. Kuchling0f871832006-10-27 16:55:34 +0000832 self._box = self._factory(self._path)
833 self._box.lock()
834 key2 = self._box.add(msg)
835 self._box.flush()
836 self.assert_(self._box._locked)
837 self._box.close()
Tim Petersabd8a332006-11-03 02:32:46 +0000838
839
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000840class TestMbox(_TestMboxMMDF):
841
842 _factory = lambda self, path, factory=None: mailbox.mbox(path, factory)
843
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000844 def test_file_perms(self):
845 # From bug #3228, we want to verify that the mailbox file isn't executable,
846 # even if the umask is set to something that would leave executable bits set.
847 # We only run this test on platforms that support umask.
Andrew M. Kuchling10288e12008-08-05 01:00:57 +0000848 if hasattr(os, 'umask') and hasattr(os, 'stat'):
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000849 try:
850 old_umask = os.umask(0077)
851 self._box.close()
852 os.unlink(self._path)
853 self._box = mailbox.mbox(self._path, create=True)
854 self._box.add('')
855 self._box.close()
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000856 finally:
857 os.umask(old_umask)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000858
Andrew M. Kuchling10288e12008-08-05 01:00:57 +0000859 st = os.stat(self._path)
860 perms = st.st_mode
861 self.assertFalse((perms & 0111)) # Execute bits should all be off.
862
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000863class TestMMDF(_TestMboxMMDF):
864
865 _factory = lambda self, path, factory=None: mailbox.MMDF(path, factory)
866
867
868class TestMH(TestMailbox):
869
870 _factory = lambda self, path, factory=None: mailbox.MH(path, factory)
871
872 def test_list_folders(self):
873 # List folders
874 self._box.add_folder('one')
875 self._box.add_folder('two')
876 self._box.add_folder('three')
877 self.assert_(len(self._box.list_folders()) == 3)
878 self.assert_(set(self._box.list_folders()) ==
879 set(('one', 'two', 'three')))
880
881 def test_get_folder(self):
882 # Open folders
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000883 def dummy_factory (s):
884 return None
885 self._box = self._factory(self._path, dummy_factory)
Tim Petersf733abb2007-01-30 03:03:46 +0000886
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000887 new_folder = self._box.add_folder('foo.bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000888 folder0 = self._box.get_folder('foo.bar')
889 folder0.add(self._template % 'bar')
890 self.assert_(os.path.isdir(os.path.join(self._path, 'foo.bar')))
891 folder1 = self._box.get_folder('foo.bar')
892 self.assert_(folder1.get_string(folder1.keys()[0]) == \
893 self._template % 'bar')
894
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000895 # Test for bug #1569790: verify that folders returned by .get_folder()
896 # use the same factory function.
897 self.assert_(new_folder._factory is self._box._factory)
898 self.assert_(folder0._factory is self._box._factory)
899
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000900 def test_add_and_remove_folders(self):
901 # Delete folders
902 self._box.add_folder('one')
903 self._box.add_folder('two')
904 self.assert_(len(self._box.list_folders()) == 2)
905 self.assert_(set(self._box.list_folders()) == set(('one', 'two')))
906 self._box.remove_folder('one')
907 self.assert_(len(self._box.list_folders()) == 1)
908 self.assert_(set(self._box.list_folders()) == set(('two',)))
909 self._box.add_folder('three')
910 self.assert_(len(self._box.list_folders()) == 2)
911 self.assert_(set(self._box.list_folders()) == set(('two', 'three')))
912 self._box.remove_folder('three')
913 self.assert_(len(self._box.list_folders()) == 1)
914 self.assert_(set(self._box.list_folders()) == set(('two',)))
915 self._box.remove_folder('two')
916 self.assert_(len(self._box.list_folders()) == 0)
917 self.assert_(self._box.list_folders() == [])
918
919 def test_sequences(self):
920 # Get and set sequences
921 self.assert_(self._box.get_sequences() == {})
922 msg0 = mailbox.MHMessage(self._template % 0)
923 msg0.add_sequence('foo')
924 key0 = self._box.add(msg0)
925 self.assert_(self._box.get_sequences() == {'foo':[key0]})
926 msg1 = mailbox.MHMessage(self._template % 1)
927 msg1.set_sequences(['bar', 'replied', 'foo'])
928 key1 = self._box.add(msg1)
929 self.assert_(self._box.get_sequences() ==
930 {'foo':[key0, key1], 'bar':[key1], 'replied':[key1]})
931 msg0.set_sequences(['flagged'])
932 self._box[key0] = msg0
933 self.assert_(self._box.get_sequences() ==
934 {'foo':[key1], 'bar':[key1], 'replied':[key1],
935 'flagged':[key0]})
936 self._box.remove(key1)
937 self.assert_(self._box.get_sequences() == {'flagged':[key0]})
938
R. David Murray52720c52009-04-02 14:05:35 +0000939 def test_issue2625(self):
940 msg0 = mailbox.MHMessage(self._template % 0)
941 msg0.add_sequence('foo')
942 key0 = self._box.add(msg0)
943 refmsg0 = self._box.get_message(key0)
944
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000945 def test_pack(self):
946 # Pack the contents of the mailbox
947 msg0 = mailbox.MHMessage(self._template % 0)
948 msg1 = mailbox.MHMessage(self._template % 1)
949 msg2 = mailbox.MHMessage(self._template % 2)
950 msg3 = mailbox.MHMessage(self._template % 3)
951 msg0.set_sequences(['foo', 'unseen'])
952 msg1.set_sequences(['foo'])
953 msg2.set_sequences(['foo', 'flagged'])
954 msg3.set_sequences(['foo', 'bar', 'replied'])
955 key0 = self._box.add(msg0)
956 key1 = self._box.add(msg1)
957 key2 = self._box.add(msg2)
958 key3 = self._box.add(msg3)
959 self.assert_(self._box.get_sequences() ==
960 {'foo':[key0,key1,key2,key3], 'unseen':[key0],
961 'flagged':[key2], 'bar':[key3], 'replied':[key3]})
962 self._box.remove(key2)
963 self.assert_(self._box.get_sequences() ==
964 {'foo':[key0,key1,key3], 'unseen':[key0], 'bar':[key3],
965 'replied':[key3]})
966 self._box.pack()
967 self.assert_(self._box.keys() == [1, 2, 3])
968 key0 = key0
969 key1 = key0 + 1
970 key2 = key1 + 1
971 self.assert_(self._box.get_sequences() ==
972 {'foo':[1, 2, 3], 'unseen':[1], 'bar':[3], 'replied':[3]})
973
Andrew M. Kuchling8c456f32006-11-17 13:30:25 +0000974 # Test case for packing while holding the mailbox locked.
975 key0 = self._box.add(msg1)
976 key1 = self._box.add(msg1)
977 key2 = self._box.add(msg1)
978 key3 = self._box.add(msg1)
979
980 self._box.remove(key0)
981 self._box.remove(key2)
982 self._box.lock()
983 self._box.pack()
984 self._box.unlock()
985 self.assert_(self._box.get_sequences() ==
986 {'foo':[1, 2, 3, 4, 5],
987 'unseen':[1], 'bar':[3], 'replied':[3]})
Tim Petersf733abb2007-01-30 03:03:46 +0000988
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000989 def _get_lock_path(self):
990 return os.path.join(self._path, '.mh_sequences.lock')
991
992
993class TestBabyl(TestMailbox):
994
995 _factory = lambda self, path, factory=None: mailbox.Babyl(path, factory)
996
997 def tearDown(self):
998 self._box.close()
999 self._delete_recursively(self._path)
1000 for lock_remnant in glob.glob(self._path + '.*'):
Neal Norwitz6cbd8de2007-03-20 06:53:17 +00001001 test_support.unlink(lock_remnant)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001002
1003 def test_labels(self):
1004 # Get labels from the mailbox
1005 self.assert_(self._box.get_labels() == [])
1006 msg0 = mailbox.BabylMessage(self._template % 0)
1007 msg0.add_label('foo')
1008 key0 = self._box.add(msg0)
1009 self.assert_(self._box.get_labels() == ['foo'])
1010 msg1 = mailbox.BabylMessage(self._template % 1)
1011 msg1.set_labels(['bar', 'answered', 'foo'])
1012 key1 = self._box.add(msg1)
1013 self.assert_(set(self._box.get_labels()) == set(['foo', 'bar']))
1014 msg0.set_labels(['blah', 'filed'])
1015 self._box[key0] = msg0
1016 self.assert_(set(self._box.get_labels()) ==
1017 set(['foo', 'bar', 'blah']))
1018 self._box.remove(key1)
1019 self.assert_(set(self._box.get_labels()) == set(['blah']))
1020
1021
1022class TestMessage(TestBase):
1023
1024 _factory = mailbox.Message # Overridden by subclasses to reuse tests
1025
1026 def setUp(self):
1027 self._path = test_support.TESTFN
1028
1029 def tearDown(self):
1030 self._delete_recursively(self._path)
1031
1032 def test_initialize_with_eMM(self):
Georg Brandl5a096e12007-01-22 19:40:21 +00001033 # Initialize based on email.message.Message instance
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001034 eMM = email.message_from_string(_sample_message)
1035 msg = self._factory(eMM)
1036 self._post_initialize_hook(msg)
1037 self._check_sample(msg)
1038
1039 def test_initialize_with_string(self):
1040 # Initialize based on string
1041 msg = self._factory(_sample_message)
1042 self._post_initialize_hook(msg)
1043 self._check_sample(msg)
1044
1045 def test_initialize_with_file(self):
1046 # Initialize based on contents of file
1047 f = open(self._path, 'w+')
1048 f.write(_sample_message)
1049 f.seek(0)
1050 msg = self._factory(f)
1051 self._post_initialize_hook(msg)
1052 self._check_sample(msg)
1053 f.close()
1054
1055 def test_initialize_with_nothing(self):
1056 # Initialize without arguments
1057 msg = self._factory()
1058 self._post_initialize_hook(msg)
Georg Brandl5a096e12007-01-22 19:40:21 +00001059 self.assert_(isinstance(msg, email.message.Message))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001060 self.assert_(isinstance(msg, mailbox.Message))
1061 self.assert_(isinstance(msg, self._factory))
1062 self.assert_(msg.keys() == [])
1063 self.assert_(not msg.is_multipart())
1064 self.assert_(msg.get_payload() == None)
1065
1066 def test_initialize_incorrectly(self):
1067 # Initialize with invalid argument
1068 self.assertRaises(TypeError, lambda: self._factory(object()))
1069
1070 def test_become_message(self):
1071 # Take on the state of another message
1072 eMM = email.message_from_string(_sample_message)
1073 msg = self._factory()
1074 msg._become_message(eMM)
1075 self._check_sample(msg)
1076
1077 def test_explain_to(self):
1078 # Copy self's format-specific data to other message formats.
1079 # This test is superficial; better ones are in TestMessageConversion.
1080 msg = self._factory()
1081 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1082 mailbox.mboxMessage, mailbox.MHMessage,
1083 mailbox.BabylMessage, mailbox.MMDFMessage):
1084 other_msg = class_()
1085 msg._explain_to(other_msg)
Georg Brandl5a096e12007-01-22 19:40:21 +00001086 other_msg = email.message.Message()
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001087 self.assertRaises(TypeError, lambda: msg._explain_to(other_msg))
1088
1089 def _post_initialize_hook(self, msg):
1090 # Overridden by subclasses to check extra things after initialization
1091 pass
1092
1093
1094class TestMaildirMessage(TestMessage):
1095
1096 _factory = mailbox.MaildirMessage
1097
1098 def _post_initialize_hook(self, msg):
1099 self.assert_(msg._subdir == 'new')
1100 self.assert_(msg._info == '')
1101
1102 def test_subdir(self):
1103 # Use get_subdir() and set_subdir()
1104 msg = mailbox.MaildirMessage(_sample_message)
1105 self.assert_(msg.get_subdir() == 'new')
1106 msg.set_subdir('cur')
1107 self.assert_(msg.get_subdir() == 'cur')
1108 msg.set_subdir('new')
1109 self.assert_(msg.get_subdir() == 'new')
1110 self.assertRaises(ValueError, lambda: msg.set_subdir('tmp'))
1111 self.assert_(msg.get_subdir() == 'new')
1112 msg.set_subdir('new')
1113 self.assert_(msg.get_subdir() == 'new')
1114 self._check_sample(msg)
1115
1116 def test_flags(self):
1117 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1118 msg = mailbox.MaildirMessage(_sample_message)
1119 self.assert_(msg.get_flags() == '')
1120 self.assert_(msg.get_subdir() == 'new')
1121 msg.set_flags('F')
1122 self.assert_(msg.get_subdir() == 'new')
1123 self.assert_(msg.get_flags() == 'F')
1124 msg.set_flags('SDTP')
1125 self.assert_(msg.get_flags() == 'DPST')
1126 msg.add_flag('FT')
1127 self.assert_(msg.get_flags() == 'DFPST')
1128 msg.remove_flag('TDRP')
1129 self.assert_(msg.get_flags() == 'FS')
1130 self.assert_(msg.get_subdir() == 'new')
1131 self._check_sample(msg)
1132
1133 def test_date(self):
1134 # Use get_date() and set_date()
1135 msg = mailbox.MaildirMessage(_sample_message)
1136 self.assert_(abs(msg.get_date() - time.time()) < 60)
1137 msg.set_date(0.0)
1138 self.assert_(msg.get_date() == 0.0)
1139
1140 def test_info(self):
1141 # Use get_info() and set_info()
1142 msg = mailbox.MaildirMessage(_sample_message)
1143 self.assert_(msg.get_info() == '')
1144 msg.set_info('1,foo=bar')
1145 self.assert_(msg.get_info() == '1,foo=bar')
1146 self.assertRaises(TypeError, lambda: msg.set_info(None))
1147 self._check_sample(msg)
1148
1149 def test_info_and_flags(self):
1150 # Test interaction of info and flag methods
1151 msg = mailbox.MaildirMessage(_sample_message)
1152 self.assert_(msg.get_info() == '')
1153 msg.set_flags('SF')
1154 self.assert_(msg.get_flags() == 'FS')
1155 self.assert_(msg.get_info() == '2,FS')
1156 msg.set_info('1,')
1157 self.assert_(msg.get_flags() == '')
1158 self.assert_(msg.get_info() == '1,')
1159 msg.remove_flag('RPT')
1160 self.assert_(msg.get_flags() == '')
1161 self.assert_(msg.get_info() == '1,')
1162 msg.add_flag('D')
1163 self.assert_(msg.get_flags() == 'D')
1164 self.assert_(msg.get_info() == '2,D')
1165 self._check_sample(msg)
1166
1167
1168class _TestMboxMMDFMessage(TestMessage):
1169
1170 _factory = mailbox._mboxMMDFMessage
1171
1172 def _post_initialize_hook(self, msg):
1173 self._check_from(msg)
1174
1175 def test_initialize_with_unixfrom(self):
1176 # Initialize with a message that already has a _unixfrom attribute
1177 msg = mailbox.Message(_sample_message)
1178 msg.set_unixfrom('From foo@bar blah')
1179 msg = mailbox.mboxMessage(msg)
1180 self.assert_(msg.get_from() == 'foo@bar blah', msg.get_from())
1181
1182 def test_from(self):
1183 # Get and set "From " line
1184 msg = mailbox.mboxMessage(_sample_message)
1185 self._check_from(msg)
1186 msg.set_from('foo bar')
1187 self.assert_(msg.get_from() == 'foo bar')
1188 msg.set_from('foo@bar', True)
1189 self._check_from(msg, 'foo@bar')
1190 msg.set_from('blah@temp', time.localtime())
1191 self._check_from(msg, 'blah@temp')
1192
1193 def test_flags(self):
1194 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1195 msg = mailbox.mboxMessage(_sample_message)
1196 self.assert_(msg.get_flags() == '')
1197 msg.set_flags('F')
1198 self.assert_(msg.get_flags() == 'F')
1199 msg.set_flags('XODR')
1200 self.assert_(msg.get_flags() == 'RODX')
1201 msg.add_flag('FA')
1202 self.assert_(msg.get_flags() == 'RODFAX')
1203 msg.remove_flag('FDXA')
1204 self.assert_(msg.get_flags() == 'RO')
1205 self._check_sample(msg)
1206
1207 def _check_from(self, msg, sender=None):
1208 # Check contents of "From " line
1209 if sender is None:
1210 sender = "MAILER-DAEMON"
1211 self.assert_(re.match(sender + r" \w{3} \w{3} [\d ]\d [\d ]\d:\d{2}:"
1212 r"\d{2} \d{4}", msg.get_from()) is not None)
1213
1214
1215class TestMboxMessage(_TestMboxMMDFMessage):
1216
1217 _factory = mailbox.mboxMessage
1218
1219
1220class TestMHMessage(TestMessage):
1221
1222 _factory = mailbox.MHMessage
1223
1224 def _post_initialize_hook(self, msg):
1225 self.assert_(msg._sequences == [])
1226
1227 def test_sequences(self):
1228 # Get, set, join, and leave sequences
1229 msg = mailbox.MHMessage(_sample_message)
1230 self.assert_(msg.get_sequences() == [])
1231 msg.set_sequences(['foobar'])
1232 self.assert_(msg.get_sequences() == ['foobar'])
1233 msg.set_sequences([])
1234 self.assert_(msg.get_sequences() == [])
1235 msg.add_sequence('unseen')
1236 self.assert_(msg.get_sequences() == ['unseen'])
1237 msg.add_sequence('flagged')
1238 self.assert_(msg.get_sequences() == ['unseen', 'flagged'])
1239 msg.add_sequence('flagged')
1240 self.assert_(msg.get_sequences() == ['unseen', 'flagged'])
1241 msg.remove_sequence('unseen')
1242 self.assert_(msg.get_sequences() == ['flagged'])
1243 msg.add_sequence('foobar')
1244 self.assert_(msg.get_sequences() == ['flagged', 'foobar'])
1245 msg.remove_sequence('replied')
1246 self.assert_(msg.get_sequences() == ['flagged', 'foobar'])
1247 msg.set_sequences(['foobar', 'replied'])
1248 self.assert_(msg.get_sequences() == ['foobar', 'replied'])
1249
1250
1251class TestBabylMessage(TestMessage):
1252
1253 _factory = mailbox.BabylMessage
1254
1255 def _post_initialize_hook(self, msg):
1256 self.assert_(msg._labels == [])
1257
1258 def test_labels(self):
1259 # Get, set, join, and leave labels
1260 msg = mailbox.BabylMessage(_sample_message)
1261 self.assert_(msg.get_labels() == [])
1262 msg.set_labels(['foobar'])
1263 self.assert_(msg.get_labels() == ['foobar'])
1264 msg.set_labels([])
1265 self.assert_(msg.get_labels() == [])
1266 msg.add_label('filed')
1267 self.assert_(msg.get_labels() == ['filed'])
1268 msg.add_label('resent')
1269 self.assert_(msg.get_labels() == ['filed', 'resent'])
1270 msg.add_label('resent')
1271 self.assert_(msg.get_labels() == ['filed', 'resent'])
1272 msg.remove_label('filed')
1273 self.assert_(msg.get_labels() == ['resent'])
1274 msg.add_label('foobar')
1275 self.assert_(msg.get_labels() == ['resent', 'foobar'])
1276 msg.remove_label('unseen')
1277 self.assert_(msg.get_labels() == ['resent', 'foobar'])
1278 msg.set_labels(['foobar', 'answered'])
1279 self.assert_(msg.get_labels() == ['foobar', 'answered'])
1280
1281 def test_visible(self):
1282 # Get, set, and update visible headers
1283 msg = mailbox.BabylMessage(_sample_message)
1284 visible = msg.get_visible()
1285 self.assert_(visible.keys() == [])
1286 self.assert_(visible.get_payload() is None)
1287 visible['User-Agent'] = 'FooBar 1.0'
1288 visible['X-Whatever'] = 'Blah'
1289 self.assert_(msg.get_visible().keys() == [])
1290 msg.set_visible(visible)
1291 visible = msg.get_visible()
1292 self.assert_(visible.keys() == ['User-Agent', 'X-Whatever'])
1293 self.assert_(visible['User-Agent'] == 'FooBar 1.0')
1294 self.assert_(visible['X-Whatever'] == 'Blah')
1295 self.assert_(visible.get_payload() is None)
1296 msg.update_visible()
1297 self.assert_(visible.keys() == ['User-Agent', 'X-Whatever'])
1298 self.assert_(visible.get_payload() is None)
1299 visible = msg.get_visible()
1300 self.assert_(visible.keys() == ['User-Agent', 'Date', 'From', 'To',
1301 'Subject'])
1302 for header in ('User-Agent', 'Date', 'From', 'To', 'Subject'):
1303 self.assert_(visible[header] == msg[header])
1304
1305
1306class TestMMDFMessage(_TestMboxMMDFMessage):
1307
1308 _factory = mailbox.MMDFMessage
1309
1310
1311class TestMessageConversion(TestBase):
1312
1313 def test_plain_to_x(self):
1314 # Convert Message to all formats
1315 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1316 mailbox.mboxMessage, mailbox.MHMessage,
1317 mailbox.BabylMessage, mailbox.MMDFMessage):
1318 msg_plain = mailbox.Message(_sample_message)
1319 msg = class_(msg_plain)
1320 self._check_sample(msg)
1321
1322 def test_x_to_plain(self):
1323 # Convert all formats to Message
1324 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1325 mailbox.mboxMessage, mailbox.MHMessage,
1326 mailbox.BabylMessage, mailbox.MMDFMessage):
1327 msg = class_(_sample_message)
1328 msg_plain = mailbox.Message(msg)
1329 self._check_sample(msg_plain)
1330
1331 def test_x_to_invalid(self):
1332 # Convert all formats to an invalid format
1333 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1334 mailbox.mboxMessage, mailbox.MHMessage,
1335 mailbox.BabylMessage, mailbox.MMDFMessage):
1336 self.assertRaises(TypeError, lambda: class_(False))
1337
1338 def test_maildir_to_maildir(self):
1339 # Convert MaildirMessage to MaildirMessage
1340 msg_maildir = mailbox.MaildirMessage(_sample_message)
1341 msg_maildir.set_flags('DFPRST')
1342 msg_maildir.set_subdir('cur')
1343 date = msg_maildir.get_date()
1344 msg = mailbox.MaildirMessage(msg_maildir)
1345 self._check_sample(msg)
1346 self.assert_(msg.get_flags() == 'DFPRST')
1347 self.assert_(msg.get_subdir() == 'cur')
1348 self.assert_(msg.get_date() == date)
1349
1350 def test_maildir_to_mboxmmdf(self):
1351 # Convert MaildirMessage to mboxmessage and MMDFMessage
1352 pairs = (('D', ''), ('F', 'F'), ('P', ''), ('R', 'A'), ('S', 'R'),
1353 ('T', 'D'), ('DFPRST', 'RDFA'))
1354 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1355 msg_maildir = mailbox.MaildirMessage(_sample_message)
1356 msg_maildir.set_date(0.0)
1357 for setting, result in pairs:
1358 msg_maildir.set_flags(setting)
1359 msg = class_(msg_maildir)
1360 self.assert_(msg.get_flags() == result)
1361 self.assert_(msg.get_from() == 'MAILER-DAEMON %s' %
1362 time.asctime(time.gmtime(0.0)))
1363 msg_maildir.set_subdir('cur')
1364 self.assert_(class_(msg_maildir).get_flags() == 'RODFA')
1365
1366 def test_maildir_to_mh(self):
1367 # Convert MaildirMessage to MHMessage
1368 msg_maildir = mailbox.MaildirMessage(_sample_message)
1369 pairs = (('D', ['unseen']), ('F', ['unseen', 'flagged']),
1370 ('P', ['unseen']), ('R', ['unseen', 'replied']), ('S', []),
1371 ('T', ['unseen']), ('DFPRST', ['replied', 'flagged']))
1372 for setting, result in pairs:
1373 msg_maildir.set_flags(setting)
1374 self.assert_(mailbox.MHMessage(msg_maildir).get_sequences() == \
1375 result)
1376
1377 def test_maildir_to_babyl(self):
1378 # Convert MaildirMessage to Babyl
1379 msg_maildir = mailbox.MaildirMessage(_sample_message)
1380 pairs = (('D', ['unseen']), ('F', ['unseen']),
1381 ('P', ['unseen', 'forwarded']), ('R', ['unseen', 'answered']),
1382 ('S', []), ('T', ['unseen', 'deleted']),
1383 ('DFPRST', ['deleted', 'answered', 'forwarded']))
1384 for setting, result in pairs:
1385 msg_maildir.set_flags(setting)
1386 self.assert_(mailbox.BabylMessage(msg_maildir).get_labels() == \
1387 result)
1388
1389 def test_mboxmmdf_to_maildir(self):
1390 # Convert mboxMessage and MMDFMessage to MaildirMessage
1391 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1392 msg_mboxMMDF = class_(_sample_message)
1393 msg_mboxMMDF.set_from('foo@bar', time.gmtime(0.0))
1394 pairs = (('R', 'S'), ('O', ''), ('D', 'T'), ('F', 'F'), ('A', 'R'),
1395 ('RODFA', 'FRST'))
1396 for setting, result in pairs:
1397 msg_mboxMMDF.set_flags(setting)
1398 msg = mailbox.MaildirMessage(msg_mboxMMDF)
1399 self.assert_(msg.get_flags() == result)
1400 self.assert_(msg.get_date() == 0.0, msg.get_date())
1401 msg_mboxMMDF.set_flags('O')
1402 self.assert_(mailbox.MaildirMessage(msg_mboxMMDF).get_subdir() == \
1403 'cur')
1404
1405 def test_mboxmmdf_to_mboxmmdf(self):
1406 # Convert mboxMessage and MMDFMessage to mboxMessage and MMDFMessage
1407 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1408 msg_mboxMMDF = class_(_sample_message)
1409 msg_mboxMMDF.set_flags('RODFA')
1410 msg_mboxMMDF.set_from('foo@bar')
1411 for class2_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1412 msg2 = class2_(msg_mboxMMDF)
1413 self.assert_(msg2.get_flags() == 'RODFA')
1414 self.assert_(msg2.get_from() == 'foo@bar')
1415
1416 def test_mboxmmdf_to_mh(self):
1417 # Convert mboxMessage and MMDFMessage to MHMessage
1418 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1419 msg_mboxMMDF = class_(_sample_message)
1420 pairs = (('R', []), ('O', ['unseen']), ('D', ['unseen']),
1421 ('F', ['unseen', 'flagged']),
1422 ('A', ['unseen', 'replied']),
1423 ('RODFA', ['replied', 'flagged']))
1424 for setting, result in pairs:
1425 msg_mboxMMDF.set_flags(setting)
1426 self.assert_(mailbox.MHMessage(msg_mboxMMDF).get_sequences() \
1427 == result)
1428
1429 def test_mboxmmdf_to_babyl(self):
1430 # Convert mboxMessage and MMDFMessage to BabylMessage
1431 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1432 msg = class_(_sample_message)
1433 pairs = (('R', []), ('O', ['unseen']),
1434 ('D', ['unseen', 'deleted']), ('F', ['unseen']),
1435 ('A', ['unseen', 'answered']),
1436 ('RODFA', ['deleted', 'answered']))
1437 for setting, result in pairs:
1438 msg.set_flags(setting)
1439 self.assert_(mailbox.BabylMessage(msg).get_labels() == result)
1440
1441 def test_mh_to_maildir(self):
1442 # Convert MHMessage to MaildirMessage
1443 pairs = (('unseen', ''), ('replied', 'RS'), ('flagged', 'FS'))
1444 for setting, result in pairs:
1445 msg = mailbox.MHMessage(_sample_message)
1446 msg.add_sequence(setting)
1447 self.assert_(mailbox.MaildirMessage(msg).get_flags() == result)
1448 self.assert_(mailbox.MaildirMessage(msg).get_subdir() == 'cur')
1449 msg = mailbox.MHMessage(_sample_message)
1450 msg.add_sequence('unseen')
1451 msg.add_sequence('replied')
1452 msg.add_sequence('flagged')
1453 self.assert_(mailbox.MaildirMessage(msg).get_flags() == 'FR')
1454 self.assert_(mailbox.MaildirMessage(msg).get_subdir() == 'cur')
1455
1456 def test_mh_to_mboxmmdf(self):
1457 # Convert MHMessage to mboxMessage and MMDFMessage
1458 pairs = (('unseen', 'O'), ('replied', 'ROA'), ('flagged', 'ROF'))
1459 for setting, result in pairs:
1460 msg = mailbox.MHMessage(_sample_message)
1461 msg.add_sequence(setting)
1462 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1463 self.assert_(class_(msg).get_flags() == result)
1464 msg = mailbox.MHMessage(_sample_message)
1465 msg.add_sequence('unseen')
1466 msg.add_sequence('replied')
1467 msg.add_sequence('flagged')
1468 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1469 self.assert_(class_(msg).get_flags() == 'OFA')
1470
1471 def test_mh_to_mh(self):
1472 # Convert MHMessage to MHMessage
1473 msg = mailbox.MHMessage(_sample_message)
1474 msg.add_sequence('unseen')
1475 msg.add_sequence('replied')
1476 msg.add_sequence('flagged')
1477 self.assert_(mailbox.MHMessage(msg).get_sequences() == \
1478 ['unseen', 'replied', 'flagged'])
1479
1480 def test_mh_to_babyl(self):
1481 # Convert MHMessage to BabylMessage
1482 pairs = (('unseen', ['unseen']), ('replied', ['answered']),
1483 ('flagged', []))
1484 for setting, result in pairs:
1485 msg = mailbox.MHMessage(_sample_message)
1486 msg.add_sequence(setting)
1487 self.assert_(mailbox.BabylMessage(msg).get_labels() == result)
1488 msg = mailbox.MHMessage(_sample_message)
1489 msg.add_sequence('unseen')
1490 msg.add_sequence('replied')
1491 msg.add_sequence('flagged')
1492 self.assert_(mailbox.BabylMessage(msg).get_labels() == \
1493 ['unseen', 'answered'])
1494
1495 def test_babyl_to_maildir(self):
1496 # Convert BabylMessage to MaildirMessage
1497 pairs = (('unseen', ''), ('deleted', 'ST'), ('filed', 'S'),
1498 ('answered', 'RS'), ('forwarded', 'PS'), ('edited', 'S'),
1499 ('resent', 'PS'))
1500 for setting, result in pairs:
1501 msg = mailbox.BabylMessage(_sample_message)
1502 msg.add_label(setting)
1503 self.assert_(mailbox.MaildirMessage(msg).get_flags() == result)
1504 self.assert_(mailbox.MaildirMessage(msg).get_subdir() == 'cur')
1505 msg = mailbox.BabylMessage(_sample_message)
1506 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1507 'edited', 'resent'):
1508 msg.add_label(label)
1509 self.assert_(mailbox.MaildirMessage(msg).get_flags() == 'PRT')
1510 self.assert_(mailbox.MaildirMessage(msg).get_subdir() == 'cur')
1511
1512 def test_babyl_to_mboxmmdf(self):
1513 # Convert BabylMessage to mboxMessage and MMDFMessage
1514 pairs = (('unseen', 'O'), ('deleted', 'ROD'), ('filed', 'RO'),
1515 ('answered', 'ROA'), ('forwarded', 'RO'), ('edited', 'RO'),
1516 ('resent', 'RO'))
1517 for setting, result in pairs:
1518 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1519 msg = mailbox.BabylMessage(_sample_message)
1520 msg.add_label(setting)
1521 self.assert_(class_(msg).get_flags() == result)
1522 msg = mailbox.BabylMessage(_sample_message)
1523 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1524 'edited', 'resent'):
1525 msg.add_label(label)
1526 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1527 self.assert_(class_(msg).get_flags() == 'ODA')
1528
1529 def test_babyl_to_mh(self):
1530 # Convert BabylMessage to MHMessage
1531 pairs = (('unseen', ['unseen']), ('deleted', []), ('filed', []),
1532 ('answered', ['replied']), ('forwarded', []), ('edited', []),
1533 ('resent', []))
1534 for setting, result in pairs:
1535 msg = mailbox.BabylMessage(_sample_message)
1536 msg.add_label(setting)
1537 self.assert_(mailbox.MHMessage(msg).get_sequences() == result)
1538 msg = mailbox.BabylMessage(_sample_message)
1539 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1540 'edited', 'resent'):
1541 msg.add_label(label)
1542 self.assert_(mailbox.MHMessage(msg).get_sequences() == \
1543 ['unseen', 'replied'])
1544
1545 def test_babyl_to_babyl(self):
1546 # Convert BabylMessage to BabylMessage
1547 msg = mailbox.BabylMessage(_sample_message)
1548 msg.update_visible()
1549 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1550 'edited', 'resent'):
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001551 msg.add_label(label)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001552 msg2 = mailbox.BabylMessage(msg)
1553 self.assert_(msg2.get_labels() == ['unseen', 'deleted', 'filed',
1554 'answered', 'forwarded', 'edited',
1555 'resent'])
1556 self.assert_(msg.get_visible().keys() == msg2.get_visible().keys())
1557 for key in msg.get_visible().keys():
1558 self.assert_(msg.get_visible()[key] == msg2.get_visible()[key])
1559
1560
1561class TestProxyFileBase(TestBase):
1562
1563 def _test_read(self, proxy):
1564 # Read by byte
1565 proxy.seek(0)
1566 self.assert_(proxy.read() == 'bar')
1567 proxy.seek(1)
1568 self.assert_(proxy.read() == 'ar')
1569 proxy.seek(0)
1570 self.assert_(proxy.read(2) == 'ba')
1571 proxy.seek(1)
1572 self.assert_(proxy.read(-1) == 'ar')
1573 proxy.seek(2)
1574 self.assert_(proxy.read(1000) == 'r')
1575
1576 def _test_readline(self, proxy):
1577 # Read by line
1578 proxy.seek(0)
1579 self.assert_(proxy.readline() == 'foo' + os.linesep)
1580 self.assert_(proxy.readline() == 'bar' + os.linesep)
1581 self.assert_(proxy.readline() == 'fred' + os.linesep)
1582 self.assert_(proxy.readline() == 'bob')
1583 proxy.seek(2)
1584 self.assert_(proxy.readline() == 'o' + os.linesep)
1585 proxy.seek(6 + 2 * len(os.linesep))
1586 self.assert_(proxy.readline() == 'fred' + os.linesep)
1587 proxy.seek(6 + 2 * len(os.linesep))
1588 self.assert_(proxy.readline(2) == 'fr')
1589 self.assert_(proxy.readline(-10) == 'ed' + os.linesep)
1590
1591 def _test_readlines(self, proxy):
1592 # Read multiple lines
1593 proxy.seek(0)
1594 self.assert_(proxy.readlines() == ['foo' + os.linesep,
1595 'bar' + os.linesep,
1596 'fred' + os.linesep, 'bob'])
1597 proxy.seek(0)
1598 self.assert_(proxy.readlines(2) == ['foo' + os.linesep])
1599 proxy.seek(3 + len(os.linesep))
1600 self.assert_(proxy.readlines(4 + len(os.linesep)) ==
1601 ['bar' + os.linesep, 'fred' + os.linesep])
1602 proxy.seek(3)
1603 self.assert_(proxy.readlines(1000) == [os.linesep, 'bar' + os.linesep,
1604 'fred' + os.linesep, 'bob'])
1605
1606 def _test_iteration(self, proxy):
1607 # Iterate by line
1608 proxy.seek(0)
1609 iterator = iter(proxy)
1610 self.assert_(iterator.next() == 'foo' + os.linesep)
1611 self.assert_(iterator.next() == 'bar' + os.linesep)
1612 self.assert_(iterator.next() == 'fred' + os.linesep)
1613 self.assert_(iterator.next() == 'bob')
1614 self.assertRaises(StopIteration, lambda: iterator.next())
1615
1616 def _test_seek_and_tell(self, proxy):
1617 # Seek and use tell to check position
1618 proxy.seek(3)
1619 self.assert_(proxy.tell() == 3)
1620 self.assert_(proxy.read(len(os.linesep)) == os.linesep)
1621 proxy.seek(2, 1)
1622 self.assert_(proxy.read(1 + len(os.linesep)) == 'r' + os.linesep)
1623 proxy.seek(-3 - len(os.linesep), 2)
1624 self.assert_(proxy.read(3) == 'bar')
1625 proxy.seek(2, 0)
1626 self.assert_(proxy.read() == 'o' + os.linesep + 'bar' + os.linesep)
1627 proxy.seek(100)
1628 self.assert_(proxy.read() == '')
1629
1630 def _test_close(self, proxy):
1631 # Close a file
1632 proxy.close()
1633 self.assertRaises(AttributeError, lambda: proxy.close())
1634
1635
1636class TestProxyFile(TestProxyFileBase):
1637
1638 def setUp(self):
1639 self._path = test_support.TESTFN
Andrew M. Kuchling214db632006-05-02 21:44:33 +00001640 self._file = open(self._path, 'wb+')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001641
1642 def tearDown(self):
1643 self._file.close()
1644 self._delete_recursively(self._path)
1645
1646 def test_initialize(self):
1647 # Initialize and check position
1648 self._file.write('foo')
1649 pos = self._file.tell()
1650 proxy0 = mailbox._ProxyFile(self._file)
1651 self.assert_(proxy0.tell() == pos)
1652 self.assert_(self._file.tell() == pos)
1653 proxy1 = mailbox._ProxyFile(self._file, 0)
1654 self.assert_(proxy1.tell() == 0)
1655 self.assert_(self._file.tell() == pos)
1656
1657 def test_read(self):
1658 self._file.write('bar')
1659 self._test_read(mailbox._ProxyFile(self._file))
1660
1661 def test_readline(self):
1662 self._file.write('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1663 os.linesep))
1664 self._test_readline(mailbox._ProxyFile(self._file))
1665
1666 def test_readlines(self):
1667 self._file.write('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1668 os.linesep))
1669 self._test_readlines(mailbox._ProxyFile(self._file))
1670
1671 def test_iteration(self):
1672 self._file.write('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1673 os.linesep))
1674 self._test_iteration(mailbox._ProxyFile(self._file))
1675
1676 def test_seek_and_tell(self):
1677 self._file.write('foo%sbar%s' % (os.linesep, os.linesep))
1678 self._test_seek_and_tell(mailbox._ProxyFile(self._file))
1679
1680 def test_close(self):
1681 self._file.write('foo%sbar%s' % (os.linesep, os.linesep))
1682 self._test_close(mailbox._ProxyFile(self._file))
1683
1684
1685class TestPartialFile(TestProxyFileBase):
1686
1687 def setUp(self):
1688 self._path = test_support.TESTFN
Andrew M. Kuchling214db632006-05-02 21:44:33 +00001689 self._file = open(self._path, 'wb+')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001690
1691 def tearDown(self):
1692 self._file.close()
1693 self._delete_recursively(self._path)
1694
1695 def test_initialize(self):
1696 # Initialize and check position
1697 self._file.write('foo' + os.linesep + 'bar')
1698 pos = self._file.tell()
1699 proxy = mailbox._PartialFile(self._file, 2, 5)
1700 self.assert_(proxy.tell() == 0)
1701 self.assert_(self._file.tell() == pos)
1702
1703 def test_read(self):
1704 self._file.write('***bar***')
1705 self._test_read(mailbox._PartialFile(self._file, 3, 6))
1706
1707 def test_readline(self):
1708 self._file.write('!!!!!foo%sbar%sfred%sbob!!!!!' %
1709 (os.linesep, os.linesep, os.linesep))
1710 self._test_readline(mailbox._PartialFile(self._file, 5,
1711 18 + 3 * len(os.linesep)))
1712
1713 def test_readlines(self):
1714 self._file.write('foo%sbar%sfred%sbob?????' %
1715 (os.linesep, os.linesep, os.linesep))
1716 self._test_readlines(mailbox._PartialFile(self._file, 0,
1717 13 + 3 * len(os.linesep)))
1718
1719 def test_iteration(self):
1720 self._file.write('____foo%sbar%sfred%sbob####' %
1721 (os.linesep, os.linesep, os.linesep))
1722 self._test_iteration(mailbox._PartialFile(self._file, 4,
1723 17 + 3 * len(os.linesep)))
1724
1725 def test_seek_and_tell(self):
1726 self._file.write('(((foo%sbar%s$$$' % (os.linesep, os.linesep))
1727 self._test_seek_and_tell(mailbox._PartialFile(self._file, 3,
1728 9 + 2 * len(os.linesep)))
1729
1730 def test_close(self):
1731 self._file.write('&foo%sbar%s^' % (os.linesep, os.linesep))
1732 self._test_close(mailbox._PartialFile(self._file, 1,
1733 6 + 3 * len(os.linesep)))
1734
1735
1736## Start: tests from the original module (for backward compatibility).
1737
Skip Montanaro5253da12004-07-24 19:56:03 +00001738FROM_ = "From some.body@dummy.domain Sat Jul 24 13:43:35 2004\n"
Fred Drakec02bc3e2001-05-21 20:23:21 +00001739DUMMY_MESSAGE = """\
1740From: some.body@dummy.domain
1741To: me@my.domain
Skip Montanaro5253da12004-07-24 19:56:03 +00001742Subject: Simple Test
Fred Drakec02bc3e2001-05-21 20:23:21 +00001743
1744This is a dummy message.
1745"""
1746
Fred Drakec02bc3e2001-05-21 20:23:21 +00001747class MaildirTestCase(unittest.TestCase):
1748
1749 def setUp(self):
1750 # create a new maildir mailbox to work with:
1751 self._dir = test_support.TESTFN
1752 os.mkdir(self._dir)
1753 os.mkdir(os.path.join(self._dir, "cur"))
1754 os.mkdir(os.path.join(self._dir, "tmp"))
1755 os.mkdir(os.path.join(self._dir, "new"))
1756 self._counter = 1
1757 self._msgfiles = []
1758
1759 def tearDown(self):
1760 map(os.unlink, self._msgfiles)
1761 os.rmdir(os.path.join(self._dir, "cur"))
1762 os.rmdir(os.path.join(self._dir, "tmp"))
1763 os.rmdir(os.path.join(self._dir, "new"))
1764 os.rmdir(self._dir)
1765
Skip Montanaro5253da12004-07-24 19:56:03 +00001766 def createMessage(self, dir, mbox=False):
Jack Jansen97df7b62001-06-19 20:20:05 +00001767 t = int(time.time() % 1000000)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001768 pid = self._counter
1769 self._counter += 1
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001770 filename = os.extsep.join((str(t), str(pid), "myhostname", "mydomain"))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001771 tmpname = os.path.join(self._dir, "tmp", filename)
1772 newname = os.path.join(self._dir, dir, filename)
1773 fp = open(tmpname, "w")
1774 self._msgfiles.append(tmpname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001775 if mbox:
1776 fp.write(FROM_)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001777 fp.write(DUMMY_MESSAGE)
1778 fp.close()
Tim Peters6626c1f2001-05-22 16:29:01 +00001779 if hasattr(os, "link"):
1780 os.link(tmpname, newname)
1781 else:
1782 fp = open(newname, "w")
1783 fp.write(DUMMY_MESSAGE)
1784 fp.close()
Fred Drakec02bc3e2001-05-21 20:23:21 +00001785 self._msgfiles.append(newname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001786 return tmpname
Fred Drakec02bc3e2001-05-21 20:23:21 +00001787
1788 def test_empty_maildir(self):
1789 """Test an empty maildir mailbox"""
1790 # Test for regression on bug #117490:
1791 # Make sure the boxes attribute actually gets set.
1792 self.mbox = mailbox.Maildir(test_support.TESTFN)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001793 #self.assert_(hasattr(self.mbox, "boxes"))
1794 #self.assert_(len(self.mbox.boxes) == 0)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001795 self.assert_(self.mbox.next() is None)
1796 self.assert_(self.mbox.next() is None)
1797
1798 def test_nonempty_maildir_cur(self):
1799 self.createMessage("cur")
1800 self.mbox = mailbox.Maildir(test_support.TESTFN)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001801 #self.assert_(len(self.mbox.boxes) == 1)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001802 self.assert_(self.mbox.next() is not None)
1803 self.assert_(self.mbox.next() is None)
1804 self.assert_(self.mbox.next() is None)
1805
1806 def test_nonempty_maildir_new(self):
1807 self.createMessage("new")
1808 self.mbox = mailbox.Maildir(test_support.TESTFN)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001809 #self.assert_(len(self.mbox.boxes) == 1)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001810 self.assert_(self.mbox.next() is not None)
1811 self.assert_(self.mbox.next() is None)
1812 self.assert_(self.mbox.next() is None)
1813
1814 def test_nonempty_maildir_both(self):
1815 self.createMessage("cur")
1816 self.createMessage("new")
1817 self.mbox = mailbox.Maildir(test_support.TESTFN)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001818 #self.assert_(len(self.mbox.boxes) == 2)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001819 self.assert_(self.mbox.next() is not None)
1820 self.assert_(self.mbox.next() is not None)
1821 self.assert_(self.mbox.next() is None)
1822 self.assert_(self.mbox.next() is None)
Fred Drake0aaed272000-10-23 13:39:15 +00001823
Skip Montanaro5253da12004-07-24 19:56:03 +00001824 def test_unix_mbox(self):
1825 ### should be better!
Georg Brandl5a096e12007-01-22 19:40:21 +00001826 import email.parser
Skip Montanaro5253da12004-07-24 19:56:03 +00001827 fname = self.createMessage("cur", True)
1828 n = 0
1829 for msg in mailbox.PortableUnixMailbox(open(fname),
Georg Brandl5a096e12007-01-22 19:40:21 +00001830 email.parser.Parser().parse):
Skip Montanaro5253da12004-07-24 19:56:03 +00001831 n += 1
1832 self.assertEqual(msg["subject"], "Simple Test")
1833 self.assertEqual(len(str(msg)), len(FROM_)+len(DUMMY_MESSAGE))
1834 self.assertEqual(n, 1)
1835
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001836## End: classes from the original module (for backward compatibility).
1837
1838
1839_sample_message = """\
1840Return-Path: <gkj@gregorykjohnson.com>
1841X-Original-To: gkj+person@localhost
1842Delivered-To: gkj+person@localhost
1843Received: from localhost (localhost [127.0.0.1])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001844 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1845 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001846Delivered-To: gkj@sundance.gregorykjohnson.com
1847Received: from localhost [127.0.0.1]
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001848 by localhost with POP3 (fetchmail-6.2.5)
1849 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001850Received: from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001851 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1852 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001853Received: by andy.gregorykjohnson.com (Postfix, from userid 1000)
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001854 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001855Date: Wed, 13 Jul 2005 17:23:11 -0400
1856From: "Gregory K. Johnson" <gkj@gregorykjohnson.com>
1857To: gkj@gregorykjohnson.com
1858Subject: Sample message
1859Message-ID: <20050713212311.GC4701@andy.gregorykjohnson.com>
1860Mime-Version: 1.0
1861Content-Type: multipart/mixed; boundary="NMuMz9nt05w80d4+"
1862Content-Disposition: inline
1863User-Agent: Mutt/1.5.9i
1864
1865
1866--NMuMz9nt05w80d4+
1867Content-Type: text/plain; charset=us-ascii
1868Content-Disposition: inline
1869
1870This is a sample message.
1871
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001872--
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001873Gregory K. Johnson
1874
1875--NMuMz9nt05w80d4+
1876Content-Type: application/octet-stream
1877Content-Disposition: attachment; filename="text.gz"
1878Content-Transfer-Encoding: base64
1879
1880H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
18813FYlAAAA
1882
1883--NMuMz9nt05w80d4+--
1884"""
1885
1886_sample_headers = {
1887 "Return-Path":"<gkj@gregorykjohnson.com>",
1888 "X-Original-To":"gkj+person@localhost",
1889 "Delivered-To":"gkj+person@localhost",
1890 "Received":"""from localhost (localhost [127.0.0.1])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001891 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1892 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001893 "Delivered-To":"gkj@sundance.gregorykjohnson.com",
1894 "Received":"""from localhost [127.0.0.1]
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001895 by localhost with POP3 (fetchmail-6.2.5)
1896 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001897 "Received":"""from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001898 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1899 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001900 "Received":"""by andy.gregorykjohnson.com (Postfix, from userid 1000)
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001901 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001902 "Date":"Wed, 13 Jul 2005 17:23:11 -0400",
1903 "From":""""Gregory K. Johnson" <gkj@gregorykjohnson.com>""",
1904 "To":"gkj@gregorykjohnson.com",
1905 "Subject":"Sample message",
1906 "Mime-Version":"1.0",
1907 "Content-Type":"""multipart/mixed; boundary="NMuMz9nt05w80d4+\"""",
1908 "Content-Disposition":"inline",
1909 "User-Agent": "Mutt/1.5.9i" }
1910
1911_sample_payloads = ("""This is a sample message.
1912
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001913--
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001914Gregory K. Johnson
1915""",
1916"""H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
19173FYlAAAA
1918""")
Fred Drake0aaed272000-10-23 13:39:15 +00001919
Fred Drakec02bc3e2001-05-21 20:23:21 +00001920
Fred Drake2e2be372001-09-20 21:33:42 +00001921def test_main():
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001922 tests = (TestMailboxSuperclass, TestMaildir, TestMbox, TestMMDF, TestMH,
1923 TestBabyl, TestMessage, TestMaildirMessage, TestMboxMessage,
1924 TestMHMessage, TestBabylMessage, TestMMDFMessage,
1925 TestMessageConversion, TestProxyFile, TestPartialFile,
1926 MaildirTestCase)
1927 test_support.run_unittest(*tests)
Neal Norwitzb15ac312006-06-29 04:10:08 +00001928 test_support.reap_children()
Fred Drake2e2be372001-09-20 21:33:42 +00001929
1930
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001931if __name__ == '__main__':
Fred Drake2e2be372001-09-20 21:33:42 +00001932 test_main()