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