blob: 75e0a8d4f6cd977d92d8e015b1adea8eb56d6c46 [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 Melottia2d46532010-01-30 07:22:54 +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
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000026 self.assertIsInstance(msg, email.message.Message)
27 self.assertIsInstance(msg, mailbox.Message)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000028 for key, value in _sample_headers.iteritems():
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000029 self.assertIn(value, msg.get_all(key))
Benjamin Peterson5c8da862009-06-30 22:57:08 +000030 self.assertTrue(msg.is_multipart())
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000031 self.assertEqual(len(msg.get_payload()), len(_sample_payloads))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000032 for i, payload in enumerate(_sample_payloads):
33 part = msg.get_payload(i)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000034 self.assertIsInstance(part, email.message.Message)
35 self.assertNotIsInstance(part, mailbox.Message)
36 self.assertEqual(part.get_payload(), payload)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000037
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))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000069 self.assertEqual(len(self._box), 1)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000070 keys.append(self._box.add(mailbox.Message(_sample_message)))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000071 self.assertEqual(len(self._box), 2)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000072 keys.append(self._box.add(email.message_from_string(_sample_message)))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000073 self.assertEqual(len(self._box), 3)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000074 keys.append(self._box.add(StringIO.StringIO(_sample_message)))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000075 self.assertEqual(len(self._box), 4)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000076 keys.append(self._box.add(_sample_message))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000077 self.assertEqual(len(self._box), 5)
78 self.assertEqual(self._box.get_string(keys[0]), self._template % 0)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000079 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)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000094 self.assertEqual(len(self._box), 2)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000095 method(key0)
96 l = len(self._box)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000097 self.assertEqual(l, 1)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000098 self.assertRaises(KeyError, lambda: self._box[key0])
99 self.assertRaises(KeyError, lambda: method(key0))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000100 self.assertEqual(self._box.get_string(key1), self._template % 1)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000101 key2 = self._box.add(self._template % 2)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000102 self.assertEqual(len(self._box), 2)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000103 method(key2)
104 l = len(self._box)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000105 self.assertEqual(l, 1)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000106 self.assertRaises(KeyError, lambda: self._box[key2])
107 self.assertRaises(KeyError, lambda: method(key2))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000108 self.assertEqual(self._box.get_string(key1), self._template % 1)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000109 method(key1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000110 self.assertEqual(len(self._box), 0)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000111 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)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000118 self.assertEqual(len(self._box), 2)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000119 self._box.discard(key0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000120 self.assertEqual(len(self._box), 1)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000121 self.assertRaises(KeyError, lambda: self._box[key0])
122 self._box.discard(key0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000123 self.assertEqual(len(self._box), 1)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000124 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)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000130 self.assertEqual(msg['from'], 'foo')
131 self.assertEqual(msg.get_payload(), '0')
132 self.assertIs(self._box.get('foo'), None)
133 self.assertFalse(self._box.get('foo', False))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000134 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)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000138 self.assertEqual(msg['from'], 'foo')
139 self.assertEqual(msg.fp.read(), '1')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000140
141 def test_getitem(self):
142 # Retrieve message using __getitem__()
143 key0 = self._box.add(self._template % 0)
144 msg = self._box[key0]
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000145 self.assertEqual(msg['from'], 'foo')
146 self.assertEqual(msg.get_payload(), '0')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000147 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)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000156 self.assertIsInstance(msg0, mailbox.Message)
157 self.assertEqual(msg0['from'], 'foo')
158 self.assertEqual(msg0.get_payload(), '0')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000159 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)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000165 self.assertEqual(self._box.get_string(key0), self._template % 0)
166 self.assertEqual(self._box.get_string(key1), _sample_message)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000167
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)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000172 self.assertEqual(self._box.get_file(key0).read().replace(os.linesep, '\n'),
173 self._template % 0)
174 self.assertEqual(self._box.get_file(key1).read().replace(os.linesep, '\n'),
175 _sample_message)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000176
R David Murrayf1138bb2011-06-17 22:23:04 -0400177 def test_get_file_can_be_closed_twice(self):
178 # Issue 11700
179 key = self._box.add(_sample_message)
180 f = self._box.get_file(key)
181 f.close()
182 f.close()
183
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000184 def test_iterkeys(self):
185 # Get keys using iterkeys()
186 self._check_iteration(self._box.iterkeys, do_keys=True, do_values=False)
187
188 def test_keys(self):
189 # Get keys using keys()
190 self._check_iteration(self._box.keys, do_keys=True, do_values=False)
191
192 def test_itervalues(self):
193 # Get values using itervalues()
194 self._check_iteration(self._box.itervalues, do_keys=False,
195 do_values=True)
196
197 def test_iter(self):
198 # Get values using __iter__()
199 self._check_iteration(self._box.__iter__, do_keys=False,
200 do_values=True)
201
202 def test_values(self):
203 # Get values using values()
204 self._check_iteration(self._box.values, do_keys=False, do_values=True)
205
206 def test_iteritems(self):
207 # Get keys and values using iteritems()
208 self._check_iteration(self._box.iteritems, do_keys=True,
209 do_values=True)
210
211 def test_items(self):
212 # Get keys and values using items()
213 self._check_iteration(self._box.items, do_keys=True, do_values=True)
214
215 def _check_iteration(self, method, do_keys, do_values, repetitions=10):
216 for value in method():
217 self.fail("Not empty")
218 keys, values = [], []
219 for i in xrange(repetitions):
220 keys.append(self._box.add(self._template % i))
221 values.append(self._template % i)
222 if do_keys and not do_values:
223 returned_keys = list(method())
224 elif do_values and not do_keys:
225 returned_values = list(method())
226 else:
227 returned_keys, returned_values = [], []
228 for key, value in method():
229 returned_keys.append(key)
230 returned_values.append(value)
231 if do_keys:
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000232 self.assertEqual(len(keys), len(returned_keys))
233 self.assertEqual(set(keys), set(returned_keys))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000234 if do_values:
235 count = 0
236 for value in returned_values:
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000237 self.assertEqual(value['from'], 'foo')
238 self.assertTrue(int(value.get_payload()) < repetitions,
239 (value.get_payload(), repetitions))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000240 count += 1
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000241 self.assertEqual(len(values), count)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000242
243 def test_has_key(self):
244 # Check existence of keys using has_key()
245 self._test_has_key_or_contains(self._box.has_key)
246
247 def test_contains(self):
248 # Check existence of keys using __contains__()
249 self._test_has_key_or_contains(self._box.__contains__)
250
251 def _test_has_key_or_contains(self, method):
252 # (Used by test_has_key() and test_contains().)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000253 self.assertFalse(method('foo'))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000254 key0 = self._box.add(self._template % 0)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000255 self.assertTrue(method(key0))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000256 self.assertFalse(method('foo'))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000257 key1 = self._box.add(self._template % 1)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000258 self.assertTrue(method(key1))
259 self.assertTrue(method(key0))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000260 self.assertFalse(method('foo'))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000261 self._box.remove(key0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000262 self.assertFalse(method(key0))
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000263 self.assertTrue(method(key1))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000264 self.assertFalse(method('foo'))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000265 self._box.remove(key1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000266 self.assertFalse(method(key1))
267 self.assertFalse(method(key0))
268 self.assertFalse(method('foo'))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000269
270 def test_len(self, repetitions=10):
271 # Get message count
272 keys = []
273 for i in xrange(repetitions):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000274 self.assertEqual(len(self._box), i)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000275 keys.append(self._box.add(self._template % i))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000276 self.assertEqual(len(self._box), i + 1)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000277 for i in xrange(repetitions):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000278 self.assertEqual(len(self._box), repetitions - i)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000279 self._box.remove(keys[i])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000280 self.assertEqual(len(self._box), repetitions - i - 1)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000281
282 def test_set_item(self):
283 # Modify messages using __setitem__()
284 key0 = self._box.add(self._template % 'original 0')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000285 self.assertEqual(self._box.get_string(key0),
286 self._template % 'original 0')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000287 key1 = self._box.add(self._template % 'original 1')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000288 self.assertEqual(self._box.get_string(key1),
289 self._template % 'original 1')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000290 self._box[key0] = self._template % 'changed 0'
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000291 self.assertEqual(self._box.get_string(key0),
292 self._template % 'changed 0')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000293 self._box[key1] = self._template % 'changed 1'
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000294 self.assertEqual(self._box.get_string(key1),
295 self._template % 'changed 1')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000296 self._box[key0] = _sample_message
297 self._check_sample(self._box[key0])
298 self._box[key1] = self._box[key0]
299 self._check_sample(self._box[key1])
300 self._box[key0] = self._template % 'original 0'
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000301 self.assertEqual(self._box.get_string(key0),
302 self._template % 'original 0')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000303 self._check_sample(self._box[key1])
304 self.assertRaises(KeyError,
305 lambda: self._box.__setitem__('foo', 'bar'))
306 self.assertRaises(KeyError, lambda: self._box['foo'])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000307 self.assertEqual(len(self._box), 2)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000308
309 def test_clear(self, iterations=10):
310 # Remove all messages using clear()
311 keys = []
312 for i in xrange(iterations):
313 self._box.add(self._template % i)
314 for i, key in enumerate(keys):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000315 self.assertEqual(self._box.get_string(key), self._template % i)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000316 self._box.clear()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000317 self.assertEqual(len(self._box), 0)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000318 for i, key in enumerate(keys):
319 self.assertRaises(KeyError, lambda: self._box.get_string(key))
320
321 def test_pop(self):
322 # Get and remove a message using pop()
323 key0 = self._box.add(self._template % 0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000324 self.assertIn(key0, self._box)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000325 key1 = self._box.add(self._template % 1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000326 self.assertIn(key1, self._box)
327 self.assertEqual(self._box.pop(key0).get_payload(), '0')
328 self.assertNotIn(key0, self._box)
329 self.assertIn(key1, self._box)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000330 key2 = self._box.add(self._template % 2)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000331 self.assertIn(key2, self._box)
332 self.assertEqual(self._box.pop(key2).get_payload(), '2')
333 self.assertNotIn(key2, self._box)
334 self.assertIn(key1, self._box)
335 self.assertEqual(self._box.pop(key1).get_payload(), '1')
336 self.assertNotIn(key1, self._box)
337 self.assertEqual(len(self._box), 0)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000338
339 def test_popitem(self, iterations=10):
340 # Get and remove an arbitrary (key, message) using popitem()
341 keys = []
342 for i in xrange(10):
343 keys.append(self._box.add(self._template % i))
344 seen = []
345 for i in xrange(10):
346 key, msg = self._box.popitem()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000347 self.assertIn(key, keys)
348 self.assertNotIn(key, seen)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000349 seen.append(key)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000350 self.assertEqual(int(msg.get_payload()), keys.index(key))
351 self.assertEqual(len(self._box), 0)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000352 for key in keys:
353 self.assertRaises(KeyError, lambda: self._box[key])
354
355 def test_update(self):
356 # Modify multiple messages using update()
357 key0 = self._box.add(self._template % 'original 0')
358 key1 = self._box.add(self._template % 'original 1')
359 key2 = self._box.add(self._template % 'original 2')
360 self._box.update({key0: self._template % 'changed 0',
361 key2: _sample_message})
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000362 self.assertEqual(len(self._box), 3)
363 self.assertEqual(self._box.get_string(key0),
364 self._template % 'changed 0')
365 self.assertEqual(self._box.get_string(key1),
366 self._template % 'original 1')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000367 self._check_sample(self._box[key2])
368 self._box.update([(key2, self._template % 'changed 2'),
369 (key1, self._template % 'changed 1'),
370 (key0, self._template % 'original 0')])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000371 self.assertEqual(len(self._box), 3)
372 self.assertEqual(self._box.get_string(key0),
373 self._template % 'original 0')
374 self.assertEqual(self._box.get_string(key1),
375 self._template % 'changed 1')
376 self.assertEqual(self._box.get_string(key2),
377 self._template % 'changed 2')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000378 self.assertRaises(KeyError,
379 lambda: self._box.update({'foo': 'bar',
380 key0: self._template % "changed 0"}))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000381 self.assertEqual(len(self._box), 3)
382 self.assertEqual(self._box.get_string(key0),
383 self._template % "changed 0")
384 self.assertEqual(self._box.get_string(key1),
385 self._template % "changed 1")
386 self.assertEqual(self._box.get_string(key2),
387 self._template % "changed 2")
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000388
389 def test_flush(self):
390 # Write changes to disk
Neal Norwitz22b3e3a2008-03-26 05:19:41 +0000391 self._test_flush_or_close(self._box.flush, True)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000392
393 def test_lock_unlock(self):
394 # Lock and unlock the mailbox
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000395 self.assertFalse(os.path.exists(self._get_lock_path()))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000396 self._box.lock()
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000397 self.assertTrue(os.path.exists(self._get_lock_path()))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000398 self._box.unlock()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000399 self.assertFalse(os.path.exists(self._get_lock_path()))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000400
401 def test_close(self):
402 # Close mailbox and flush changes to disk
Neal Norwitz22b3e3a2008-03-26 05:19:41 +0000403 self._test_flush_or_close(self._box.close, False)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000404
Neal Norwitz22b3e3a2008-03-26 05:19:41 +0000405 def _test_flush_or_close(self, method, should_call_close):
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000406 contents = [self._template % i for i in xrange(3)]
407 self._box.add(contents[0])
408 self._box.add(contents[1])
409 self._box.add(contents[2])
410 method()
Neal Norwitz22b3e3a2008-03-26 05:19:41 +0000411 if should_call_close:
412 self._box.close()
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000413 self._box = self._factory(self._path)
414 keys = self._box.keys()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000415 self.assertEqual(len(keys), 3)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000416 for key in keys:
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000417 self.assertIn(self._box.get_string(key), contents)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000418
419 def test_dump_message(self):
420 # Write message representations to disk
421 for input in (email.message_from_string(_sample_message),
422 _sample_message, StringIO.StringIO(_sample_message)):
423 output = StringIO.StringIO()
424 self._box._dump_message(input, output)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000425 self.assertEqual(output.getvalue(),
426 _sample_message.replace('\n', os.linesep))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000427 output = StringIO.StringIO()
428 self.assertRaises(TypeError,
429 lambda: self._box._dump_message(None, output))
430
431 def _get_lock_path(self):
432 # Return the path of the dot lock file. May be overridden.
433 return self._path + '.lock'
434
435
436class TestMailboxSuperclass(TestBase):
437
438 def test_notimplemented(self):
439 # Test that all Mailbox methods raise NotImplementedException.
440 box = mailbox.Mailbox('path')
441 self.assertRaises(NotImplementedError, lambda: box.add(''))
442 self.assertRaises(NotImplementedError, lambda: box.remove(''))
443 self.assertRaises(NotImplementedError, lambda: box.__delitem__(''))
444 self.assertRaises(NotImplementedError, lambda: box.discard(''))
445 self.assertRaises(NotImplementedError, lambda: box.__setitem__('', ''))
446 self.assertRaises(NotImplementedError, lambda: box.iterkeys())
447 self.assertRaises(NotImplementedError, lambda: box.keys())
448 self.assertRaises(NotImplementedError, lambda: box.itervalues().next())
449 self.assertRaises(NotImplementedError, lambda: box.__iter__().next())
450 self.assertRaises(NotImplementedError, lambda: box.values())
451 self.assertRaises(NotImplementedError, lambda: box.iteritems().next())
452 self.assertRaises(NotImplementedError, lambda: box.items())
453 self.assertRaises(NotImplementedError, lambda: box.get(''))
454 self.assertRaises(NotImplementedError, lambda: box.__getitem__(''))
455 self.assertRaises(NotImplementedError, lambda: box.get_message(''))
456 self.assertRaises(NotImplementedError, lambda: box.get_string(''))
457 self.assertRaises(NotImplementedError, lambda: box.get_file(''))
458 self.assertRaises(NotImplementedError, lambda: box.has_key(''))
459 self.assertRaises(NotImplementedError, lambda: box.__contains__(''))
460 self.assertRaises(NotImplementedError, lambda: box.__len__())
461 self.assertRaises(NotImplementedError, lambda: box.clear())
462 self.assertRaises(NotImplementedError, lambda: box.pop(''))
463 self.assertRaises(NotImplementedError, lambda: box.popitem())
464 self.assertRaises(NotImplementedError, lambda: box.update((('', ''),)))
465 self.assertRaises(NotImplementedError, lambda: box.flush())
466 self.assertRaises(NotImplementedError, lambda: box.lock())
467 self.assertRaises(NotImplementedError, lambda: box.unlock())
468 self.assertRaises(NotImplementedError, lambda: box.close())
469
470
471class TestMaildir(TestMailbox):
472
473 _factory = lambda self, path, factory=None: mailbox.Maildir(path, factory)
474
475 def setUp(self):
476 TestMailbox.setUp(self)
Neal Norwitz003c9e22006-08-11 06:09:41 +0000477 if os.name in ('nt', 'os2') or sys.platform == 'cygwin':
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000478 self._box.colon = '!'
479
480 def test_add_MM(self):
481 # Add a MaildirMessage instance
482 msg = mailbox.MaildirMessage(self._template % 0)
483 msg.set_subdir('cur')
484 msg.set_info('foo')
485 key = self._box.add(msg)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000486 self.assertTrue(os.path.exists(os.path.join(self._path, 'cur', '%s%sfoo' %
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000487 (key, self._box.colon))))
488
489 def test_get_MM(self):
490 # Get a MaildirMessage instance
491 msg = mailbox.MaildirMessage(self._template % 0)
492 msg.set_subdir('cur')
493 msg.set_flags('RF')
494 key = self._box.add(msg)
495 msg_returned = self._box.get_message(key)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000496 self.assertIsInstance(msg_returned, mailbox.MaildirMessage)
497 self.assertEqual(msg_returned.get_subdir(), 'cur')
498 self.assertEqual(msg_returned.get_flags(), 'FR')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000499
500 def test_set_MM(self):
501 # Set with a MaildirMessage instance
502 msg0 = mailbox.MaildirMessage(self._template % 0)
503 msg0.set_flags('TP')
504 key = self._box.add(msg0)
505 msg_returned = self._box.get_message(key)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000506 self.assertEqual(msg_returned.get_subdir(), 'new')
507 self.assertEqual(msg_returned.get_flags(), 'PT')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000508 msg1 = mailbox.MaildirMessage(self._template % 1)
509 self._box[key] = msg1
510 msg_returned = self._box.get_message(key)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000511 self.assertEqual(msg_returned.get_subdir(), 'new')
512 self.assertEqual(msg_returned.get_flags(), '')
513 self.assertEqual(msg_returned.get_payload(), '1')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000514 msg2 = mailbox.MaildirMessage(self._template % 2)
515 msg2.set_info('2,S')
516 self._box[key] = msg2
517 self._box[key] = self._template % 3
518 msg_returned = self._box.get_message(key)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000519 self.assertEqual(msg_returned.get_subdir(), 'new')
520 self.assertEqual(msg_returned.get_flags(), 'S')
521 self.assertEqual(msg_returned.get_payload(), '3')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000522
Andrew M. Kuchling15ce8802008-01-19 20:12:04 +0000523 def test_consistent_factory(self):
524 # Add a message.
525 msg = mailbox.MaildirMessage(self._template % 0)
526 msg.set_subdir('cur')
527 msg.set_flags('RF')
528 key = self._box.add(msg)
529
530 # Create new mailbox with
531 class FakeMessage(mailbox.MaildirMessage):
532 pass
533 box = mailbox.Maildir(self._path, factory=FakeMessage)
Amaury Forgeot d'Arc07974d72008-02-03 23:15:32 +0000534 box.colon = self._box.colon
Andrew M. Kuchling15ce8802008-01-19 20:12:04 +0000535 msg2 = box.get_message(key)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000536 self.assertIsInstance(msg2, FakeMessage)
Andrew M. Kuchling15ce8802008-01-19 20:12:04 +0000537
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000538 def test_initialize_new(self):
539 # Initialize a non-existent mailbox
540 self.tearDown()
541 self._box = mailbox.Maildir(self._path)
542 self._check_basics(factory=rfc822.Message)
543 self._delete_recursively(self._path)
544 self._box = self._factory(self._path, factory=None)
545 self._check_basics()
546
547 def test_initialize_existing(self):
548 # Initialize an existing mailbox
549 self.tearDown()
550 for subdir in '', 'tmp', 'new', 'cur':
Andrew MacIntyreafa358f2006-07-23 13:04:00 +0000551 os.mkdir(os.path.normpath(os.path.join(self._path, subdir)))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000552 self._box = mailbox.Maildir(self._path)
553 self._check_basics(factory=rfc822.Message)
554 self._box = mailbox.Maildir(self._path, factory=None)
555 self._check_basics()
556
557 def _check_basics(self, factory=None):
558 # (Used by test_open_new() and test_open_existing().)
559 self.assertEqual(self._box._path, os.path.abspath(self._path))
560 self.assertEqual(self._box._factory, factory)
561 for subdir in '', 'tmp', 'new', 'cur':
562 path = os.path.join(self._path, subdir)
563 mode = os.stat(path)[stat.ST_MODE]
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000564 self.assertTrue(stat.S_ISDIR(mode), "Not a directory: '%s'" % path)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000565
566 def test_list_folders(self):
567 # List folders
568 self._box.add_folder('one')
569 self._box.add_folder('two')
570 self._box.add_folder('three')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000571 self.assertEqual(len(self._box.list_folders()), 3)
572 self.assertEqual(set(self._box.list_folders()),
573 set(('one', 'two', 'three')))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000574
575 def test_get_folder(self):
576 # Open folders
577 self._box.add_folder('foo.bar')
578 folder0 = self._box.get_folder('foo.bar')
579 folder0.add(self._template % 'bar')
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000580 self.assertTrue(os.path.isdir(os.path.join(self._path, '.foo.bar')))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000581 folder1 = self._box.get_folder('foo.bar')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000582 self.assertEqual(folder1.get_string(folder1.keys()[0]),
583 self._template % 'bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000584
585 def test_add_and_remove_folders(self):
586 # Delete folders
587 self._box.add_folder('one')
588 self._box.add_folder('two')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000589 self.assertEqual(len(self._box.list_folders()), 2)
590 self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000591 self._box.remove_folder('one')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000592 self.assertEqual(len(self._box.list_folders()), 1)
593 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000594 self._box.add_folder('three')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000595 self.assertEqual(len(self._box.list_folders()), 2)
596 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000597 self._box.remove_folder('three')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000598 self.assertEqual(len(self._box.list_folders()), 1)
599 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000600 self._box.remove_folder('two')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000601 self.assertEqual(len(self._box.list_folders()), 0)
602 self.assertEqual(self._box.list_folders(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000603
604 def test_clean(self):
605 # Remove old files from 'tmp'
606 foo_path = os.path.join(self._path, 'tmp', 'foo')
607 bar_path = os.path.join(self._path, 'tmp', 'bar')
Brian Curtin04d8b222010-10-14 01:14:36 +0000608 with open(foo_path, 'w') as f:
609 f.write("@")
610 with open(bar_path, 'w') as f:
611 f.write("@")
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000612 self._box.clean()
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000613 self.assertTrue(os.path.exists(foo_path))
614 self.assertTrue(os.path.exists(bar_path))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000615 foo_stat = os.stat(foo_path)
Guido van Rossumb2045832006-05-02 20:47:36 +0000616 os.utime(foo_path, (time.time() - 129600 - 2,
617 foo_stat.st_mtime))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000618 self._box.clean()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000619 self.assertFalse(os.path.exists(foo_path))
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000620 self.assertTrue(os.path.exists(bar_path))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000621
622 def test_create_tmp(self, repetitions=10):
623 # Create files in tmp directory
624 hostname = socket.gethostname()
625 if '/' in hostname:
626 hostname = hostname.replace('/', r'\057')
627 if ':' in hostname:
628 hostname = hostname.replace(':', r'\072')
629 pid = os.getpid()
630 pattern = re.compile(r"(?P<time>\d+)\.M(?P<M>\d{1,6})P(?P<P>\d+)"
631 r"Q(?P<Q>\d+)\.(?P<host>[^:/]+)")
632 previous_groups = None
633 for x in xrange(repetitions):
634 tmp_file = self._box._create_tmp()
635 head, tail = os.path.split(tmp_file.name)
636 self.assertEqual(head, os.path.abspath(os.path.join(self._path,
637 "tmp")),
638 "File in wrong location: '%s'" % head)
639 match = pattern.match(tail)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000640 self.assertTrue(match is not None, "Invalid file name: '%s'" % tail)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000641 groups = match.groups()
Benjamin Peterson5b63acd2008-03-29 15:24:25 +0000642 if previous_groups is not None:
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000643 self.assertTrue(int(groups[0] >= previous_groups[0]),
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000644 "Non-monotonic seconds: '%s' before '%s'" %
645 (previous_groups[0], groups[0]))
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000646 self.assertTrue(int(groups[1] >= previous_groups[1]) or
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000647 groups[0] != groups[1],
648 "Non-monotonic milliseconds: '%s' before '%s'" %
649 (previous_groups[1], groups[1]))
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000650 self.assertTrue(int(groups[2]) == pid,
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000651 "Process ID mismatch: '%s' should be '%s'" %
652 (groups[2], pid))
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000653 self.assertTrue(int(groups[3]) == int(previous_groups[3]) + 1,
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000654 "Non-sequential counter: '%s' before '%s'" %
655 (previous_groups[3], groups[3]))
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000656 self.assertTrue(groups[4] == hostname,
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000657 "Host name mismatch: '%s' should be '%s'" %
658 (groups[4], hostname))
659 previous_groups = groups
660 tmp_file.write(_sample_message)
661 tmp_file.seek(0)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000662 self.assertTrue(tmp_file.read() == _sample_message)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000663 tmp_file.close()
664 file_count = len(os.listdir(os.path.join(self._path, "tmp")))
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000665 self.assertTrue(file_count == repetitions,
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000666 "Wrong file count: '%s' should be '%s'" %
667 (file_count, repetitions))
668
669 def test_refresh(self):
670 # Update the table of contents
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000671 self.assertEqual(self._box._toc, {})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000672 key0 = self._box.add(self._template % 0)
673 key1 = self._box.add(self._template % 1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000674 self.assertEqual(self._box._toc, {})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000675 self._box._refresh()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000676 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
677 key1: os.path.join('new', key1)})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000678 key2 = self._box.add(self._template % 2)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000679 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
680 key1: os.path.join('new', key1)})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000681 self._box._refresh()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000682 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
683 key1: os.path.join('new', key1),
684 key2: os.path.join('new', key2)})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000685
Petri Lehtinen49aa72e2011-11-05 09:50:37 +0200686 def test_refresh_after_safety_period(self):
687 # Issue #13254: Call _refresh after the "file system safety
688 # period" of 2 seconds has passed; _toc should still be
689 # updated because this is the first call to _refresh.
690 key0 = self._box.add(self._template % 0)
691 key1 = self._box.add(self._template % 1)
692
693 self._box = self._factory(self._path)
694 self.assertEqual(self._box._toc, {})
695
696 # Emulate sleeping. Instead of sleeping for 2 seconds, use the
697 # skew factor to make _refresh think that the filesystem
698 # safety period has passed and re-reading the _toc is only
699 # required if mtimes differ.
Petri Lehtinenab42abd2011-11-12 21:02:42 +0200700 self._box._skewfactor = -3
Petri Lehtinen49aa72e2011-11-05 09:50:37 +0200701
702 self._box._refresh()
703 self.assertEqual(sorted(self._box._toc.keys()), sorted([key0, key1]))
704
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000705 def test_lookup(self):
706 # Look up message subpaths in the TOC
707 self.assertRaises(KeyError, lambda: self._box._lookup('foo'))
708 key0 = self._box.add(self._template % 0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000709 self.assertEqual(self._box._lookup(key0), os.path.join('new', key0))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000710 os.remove(os.path.join(self._path, 'new', key0))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000711 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0)})
Antoine Pitroue4c6b162009-11-01 21:29:33 +0000712 # Be sure that the TOC is read back from disk (see issue #6896
713 # about bad mtime behaviour on some systems).
714 self._box.flush()
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000715 self.assertRaises(KeyError, lambda: self._box._lookup(key0))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000716 self.assertEqual(self._box._toc, {})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000717
718 def test_lock_unlock(self):
719 # Lock and unlock the mailbox. For Maildir, this does nothing.
720 self._box.lock()
721 self._box.unlock()
722
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000723 def test_folder (self):
724 # Test for bug #1569790: verify that folders returned by .get_folder()
725 # use the same factory function.
726 def dummy_factory (s):
727 return None
728 box = self._factory(self._path, factory=dummy_factory)
729 folder = box.add_folder('folder1')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000730 self.assertIs(folder._factory, dummy_factory)
Tim Petersf733abb2007-01-30 03:03:46 +0000731
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000732 folder1_alias = box.get_folder('folder1')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000733 self.assertIs(folder1_alias._factory, dummy_factory)
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000734
Andrew M. Kuchling2b09ef02007-07-14 21:56:19 +0000735 def test_directory_in_folder (self):
736 # Test that mailboxes still work if there's a stray extra directory
737 # in a folder.
738 for i in range(10):
739 self._box.add(mailbox.Message(_sample_message))
Tim Petersf733abb2007-01-30 03:03:46 +0000740
Andrew M. Kuchling2b09ef02007-07-14 21:56:19 +0000741 # Create a stray directory
742 os.mkdir(os.path.join(self._path, 'cur', 'stray-dir'))
743
744 # Check that looping still works with the directory present.
745 for msg in self._box:
746 pass
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000747
Andrew M. Kuchling10288e12008-08-05 01:00:57 +0000748 def test_file_permissions(self):
749 # Verify that message files are created without execute permissions
750 if not hasattr(os, "stat") or not hasattr(os, "umask"):
751 return
752 msg = mailbox.MaildirMessage(self._template % 0)
753 orig_umask = os.umask(0)
754 try:
755 key = self._box.add(msg)
756 finally:
757 os.umask(orig_umask)
758 path = os.path.join(self._path, self._box._lookup(key))
759 mode = os.stat(path).st_mode
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000760 self.assertEqual(mode & 0111, 0)
Andrew M. Kuchling10288e12008-08-05 01:00:57 +0000761
762 def test_folder_file_perms(self):
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000763 # From bug #3228, we want to verify that the file created inside a Maildir
764 # subfolder isn't marked as executable.
Andrew M. Kuchling10288e12008-08-05 01:00:57 +0000765 if not hasattr(os, "stat") or not hasattr(os, "umask"):
766 return
767
768 orig_umask = os.umask(0)
769 try:
770 subfolder = self._box.add_folder('subfolder')
771 finally:
772 os.umask(orig_umask)
773
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000774 path = os.path.join(subfolder._path, 'maildirfolder')
775 st = os.stat(path)
776 perms = st.st_mode
777 self.assertFalse((perms & 0111)) # Execute bits should all be off.
778
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000779 def test_reread(self):
Petri Lehtinen49aa72e2011-11-05 09:50:37 +0200780 # Do an initial unconditional refresh
781 self._box._refresh()
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000782
R David Murray8b26c4b2011-05-06 21:56:22 -0400783 # Put the last modified times more than two seconds into the past
784 # (because mtime may have only a two second granularity).
785 for subdir in ('cur', 'new'):
786 os.utime(os.path.join(self._box._path, subdir),
787 (time.time()-5,)*2)
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000788
R David Murray8b26c4b2011-05-06 21:56:22 -0400789 # Because mtime has a two second granularity in worst case (FAT), a
790 # refresh is done unconditionally if called for within
791 # two-second-plus-a-bit of the last one, just in case the mbox has
792 # changed; so now we have to wait for that interval to expire.
Petri Lehtinenab42abd2011-11-12 21:02:42 +0200793 #
794 # Because this is a test, emulate sleeping. Instead of
795 # sleeping for 2 seconds, use the skew factor to make _refresh
796 # think that 2 seconds have passed and re-reading the _toc is
797 # only required if mtimes differ.
798 self._box._skewfactor = -3
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000799
R David Murray8b26c4b2011-05-06 21:56:22 -0400800 # Re-reading causes the ._toc attribute to be assigned a new dictionary
801 # object, so we'll check that the ._toc attribute isn't a different
802 # object.
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000803 orig_toc = self._box._toc
804 def refreshed():
805 return self._box._toc is not orig_toc
806
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000807 self._box._refresh()
R David Murray8b26c4b2011-05-06 21:56:22 -0400808 self.assertFalse(refreshed())
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000809
810 # Now, write something into cur and remove it. This changes
Petri Lehtinenab42abd2011-11-12 21:02:42 +0200811 # the mtime and should cause a re-read. Note that "sleep
812 # emulation" is still in effect, as skewfactor is -3.
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000813 filename = os.path.join(self._path, 'cur', 'stray-file')
814 f = open(filename, 'w')
815 f.close()
816 os.unlink(filename)
817 self._box._refresh()
R David Murray8b26c4b2011-05-06 21:56:22 -0400818 self.assertTrue(refreshed())
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000819
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000820class _TestMboxMMDF(TestMailbox):
821
822 def tearDown(self):
823 self._box.close()
824 self._delete_recursively(self._path)
825 for lock_remnant in glob.glob(self._path + '.*'):
Neal Norwitz6cbd8de2007-03-20 06:53:17 +0000826 test_support.unlink(lock_remnant)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000827
828 def test_add_from_string(self):
829 # Add a string starting with 'From ' to the mailbox
830 key = self._box.add('From foo@bar blah\nFrom: foo\n\n0')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000831 self.assertEqual(self._box[key].get_from(), 'foo@bar blah')
832 self.assertEqual(self._box[key].get_payload(), '0')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000833
834 def test_add_mbox_or_mmdf_message(self):
835 # Add an mboxMessage or MMDFMessage
836 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
837 msg = class_('From foo@bar blah\nFrom: foo\n\n0')
838 key = self._box.add(msg)
839
840 def test_open_close_open(self):
841 # Open and inspect previously-created mailbox
842 values = [self._template % i for i in xrange(3)]
843 for value in values:
844 self._box.add(value)
845 self._box.close()
846 mtime = os.path.getmtime(self._path)
847 self._box = self._factory(self._path)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000848 self.assertEqual(len(self._box), 3)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000849 for key in self._box.iterkeys():
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000850 self.assertIn(self._box.get_string(key), values)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000851 self._box.close()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000852 self.assertEqual(mtime, os.path.getmtime(self._path))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000853
854 def test_add_and_close(self):
855 # Verifying that closing a mailbox doesn't change added items
856 self._box.add(_sample_message)
857 for i in xrange(3):
858 self._box.add(self._template % i)
859 self._box.add(_sample_message)
860 self._box._file.flush()
861 self._box._file.seek(0)
862 contents = self._box._file.read()
863 self._box.close()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000864 with open(self._path, 'rb') as f:
865 self.assertEqual(contents, f.read())
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000866 self._box = self._factory(self._path)
867
Andrew M. Kuchling9afbace2006-06-26 13:23:10 +0000868 def test_lock_conflict(self):
869 # Fork off a subprocess that will lock the file for 2 seconds,
870 # unlock it, and then exit.
Andrew M. Kuchlingec3c3682006-06-26 14:33:24 +0000871 if not hasattr(os, 'fork'):
872 return
Andrew M. Kuchling9afbace2006-06-26 13:23:10 +0000873 pid = os.fork()
874 if pid == 0:
875 # In the child, lock the mailbox.
876 self._box.lock()
877 time.sleep(2)
878 self._box.unlock()
879 os._exit(0)
880
881 # In the parent, sleep a bit to give the child time to acquire
882 # the lock.
883 time.sleep(0.5)
Neal Norwitz003c9e22006-08-11 06:09:41 +0000884 try:
885 self.assertRaises(mailbox.ExternalClashError,
886 self._box.lock)
887 finally:
888 # Wait for child to exit. Locking should now succeed.
889 exited_pid, status = os.waitpid(pid, 0)
Tim Peters3249d002006-06-27 11:52:49 +0000890
Andrew M. Kuchling9afbace2006-06-26 13:23:10 +0000891 self._box.lock()
892 self._box.unlock()
Tim Peters3249d002006-06-27 11:52:49 +0000893
Andrew M. Kuchling0f871832006-10-27 16:55:34 +0000894 def test_relock(self):
895 # Test case for bug #1575506: the mailbox class was locking the
896 # wrong file object in its flush() method.
897 msg = "Subject: sub\n\nbody\n"
898 key1 = self._box.add(msg)
899 self._box.flush()
900 self._box.close()
Tim Petersabd8a332006-11-03 02:32:46 +0000901
Andrew M. Kuchling0f871832006-10-27 16:55:34 +0000902 self._box = self._factory(self._path)
903 self._box.lock()
904 key2 = self._box.add(msg)
905 self._box.flush()
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000906 self.assertTrue(self._box._locked)
Andrew M. Kuchling0f871832006-10-27 16:55:34 +0000907 self._box.close()
Tim Petersabd8a332006-11-03 02:32:46 +0000908
909
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000910class TestMbox(_TestMboxMMDF):
911
912 _factory = lambda self, path, factory=None: mailbox.mbox(path, factory)
913
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000914 def test_file_perms(self):
915 # From bug #3228, we want to verify that the mailbox file isn't executable,
916 # even if the umask is set to something that would leave executable bits set.
917 # We only run this test on platforms that support umask.
Andrew M. Kuchling10288e12008-08-05 01:00:57 +0000918 if hasattr(os, 'umask') and hasattr(os, 'stat'):
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000919 try:
920 old_umask = os.umask(0077)
921 self._box.close()
922 os.unlink(self._path)
923 self._box = mailbox.mbox(self._path, create=True)
924 self._box.add('')
925 self._box.close()
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000926 finally:
927 os.umask(old_umask)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000928
Andrew M. Kuchling10288e12008-08-05 01:00:57 +0000929 st = os.stat(self._path)
930 perms = st.st_mode
931 self.assertFalse((perms & 0111)) # Execute bits should all be off.
932
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000933class TestMMDF(_TestMboxMMDF):
934
935 _factory = lambda self, path, factory=None: mailbox.MMDF(path, factory)
936
937
938class TestMH(TestMailbox):
939
940 _factory = lambda self, path, factory=None: mailbox.MH(path, factory)
941
942 def test_list_folders(self):
943 # List folders
944 self._box.add_folder('one')
945 self._box.add_folder('two')
946 self._box.add_folder('three')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000947 self.assertEqual(len(self._box.list_folders()), 3)
948 self.assertEqual(set(self._box.list_folders()),
949 set(('one', 'two', 'three')))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000950
951 def test_get_folder(self):
952 # Open folders
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000953 def dummy_factory (s):
954 return None
955 self._box = self._factory(self._path, dummy_factory)
Tim Petersf733abb2007-01-30 03:03:46 +0000956
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000957 new_folder = self._box.add_folder('foo.bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000958 folder0 = self._box.get_folder('foo.bar')
959 folder0.add(self._template % 'bar')
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000960 self.assertTrue(os.path.isdir(os.path.join(self._path, 'foo.bar')))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000961 folder1 = self._box.get_folder('foo.bar')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000962 self.assertEqual(folder1.get_string(folder1.keys()[0]),
963 self._template % 'bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000964
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000965 # Test for bug #1569790: verify that folders returned by .get_folder()
966 # use the same factory function.
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000967 self.assertIs(new_folder._factory, self._box._factory)
968 self.assertIs(folder0._factory, self._box._factory)
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000969
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000970 def test_add_and_remove_folders(self):
971 # Delete folders
972 self._box.add_folder('one')
973 self._box.add_folder('two')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000974 self.assertEqual(len(self._box.list_folders()), 2)
975 self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000976 self._box.remove_folder('one')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000977 self.assertEqual(len(self._box.list_folders()), 1)
978 self.assertEqual(set(self._box.list_folders()), set(('two', )))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000979 self._box.add_folder('three')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000980 self.assertEqual(len(self._box.list_folders()), 2)
981 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000982 self._box.remove_folder('three')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000983 self.assertEqual(len(self._box.list_folders()), 1)
984 self.assertEqual(set(self._box.list_folders()), set(('two', )))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000985 self._box.remove_folder('two')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000986 self.assertEqual(len(self._box.list_folders()), 0)
987 self.assertEqual(self._box.list_folders(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000988
989 def test_sequences(self):
990 # Get and set sequences
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000991 self.assertEqual(self._box.get_sequences(), {})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000992 msg0 = mailbox.MHMessage(self._template % 0)
993 msg0.add_sequence('foo')
994 key0 = self._box.add(msg0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000995 self.assertEqual(self._box.get_sequences(), {'foo':[key0]})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000996 msg1 = mailbox.MHMessage(self._template % 1)
997 msg1.set_sequences(['bar', 'replied', 'foo'])
998 key1 = self._box.add(msg1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000999 self.assertEqual(self._box.get_sequences(),
1000 {'foo':[key0, key1], 'bar':[key1], 'replied':[key1]})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001001 msg0.set_sequences(['flagged'])
1002 self._box[key0] = msg0
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001003 self.assertEqual(self._box.get_sequences(),
1004 {'foo':[key1], 'bar':[key1], 'replied':[key1],
1005 'flagged':[key0]})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001006 self._box.remove(key1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001007 self.assertEqual(self._box.get_sequences(), {'flagged':[key0]})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001008
R. David Murray52720c52009-04-02 14:05:35 +00001009 def test_issue2625(self):
1010 msg0 = mailbox.MHMessage(self._template % 0)
1011 msg0.add_sequence('foo')
1012 key0 = self._box.add(msg0)
1013 refmsg0 = self._box.get_message(key0)
1014
Andrew M. Kuchlingb72b0eb2010-02-22 18:42:07 +00001015 def test_issue7627(self):
1016 msg0 = mailbox.MHMessage(self._template % 0)
1017 key0 = self._box.add(msg0)
1018 self._box.lock()
1019 self._box.remove(key0)
1020 self._box.unlock()
1021
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001022 def test_pack(self):
1023 # Pack the contents of the mailbox
1024 msg0 = mailbox.MHMessage(self._template % 0)
1025 msg1 = mailbox.MHMessage(self._template % 1)
1026 msg2 = mailbox.MHMessage(self._template % 2)
1027 msg3 = mailbox.MHMessage(self._template % 3)
1028 msg0.set_sequences(['foo', 'unseen'])
1029 msg1.set_sequences(['foo'])
1030 msg2.set_sequences(['foo', 'flagged'])
1031 msg3.set_sequences(['foo', 'bar', 'replied'])
1032 key0 = self._box.add(msg0)
1033 key1 = self._box.add(msg1)
1034 key2 = self._box.add(msg2)
1035 key3 = self._box.add(msg3)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001036 self.assertEqual(self._box.get_sequences(),
1037 {'foo':[key0,key1,key2,key3], 'unseen':[key0],
1038 'flagged':[key2], 'bar':[key3], 'replied':[key3]})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001039 self._box.remove(key2)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001040 self.assertEqual(self._box.get_sequences(),
1041 {'foo':[key0,key1,key3], 'unseen':[key0], 'bar':[key3],
1042 'replied':[key3]})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001043 self._box.pack()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001044 self.assertEqual(self._box.keys(), [1, 2, 3])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001045 key0 = key0
1046 key1 = key0 + 1
1047 key2 = key1 + 1
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001048 self.assertEqual(self._box.get_sequences(),
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001049 {'foo':[1, 2, 3], 'unseen':[1], 'bar':[3], 'replied':[3]})
1050
Andrew M. Kuchling8c456f32006-11-17 13:30:25 +00001051 # Test case for packing while holding the mailbox locked.
1052 key0 = self._box.add(msg1)
1053 key1 = self._box.add(msg1)
1054 key2 = self._box.add(msg1)
1055 key3 = self._box.add(msg1)
1056
1057 self._box.remove(key0)
1058 self._box.remove(key2)
1059 self._box.lock()
1060 self._box.pack()
1061 self._box.unlock()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001062 self.assertEqual(self._box.get_sequences(),
1063 {'foo':[1, 2, 3, 4, 5],
1064 'unseen':[1], 'bar':[3], 'replied':[3]})
Tim Petersf733abb2007-01-30 03:03:46 +00001065
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001066 def _get_lock_path(self):
1067 return os.path.join(self._path, '.mh_sequences.lock')
1068
1069
1070class TestBabyl(TestMailbox):
1071
1072 _factory = lambda self, path, factory=None: mailbox.Babyl(path, factory)
1073
1074 def tearDown(self):
1075 self._box.close()
1076 self._delete_recursively(self._path)
1077 for lock_remnant in glob.glob(self._path + '.*'):
Neal Norwitz6cbd8de2007-03-20 06:53:17 +00001078 test_support.unlink(lock_remnant)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001079
1080 def test_labels(self):
1081 # Get labels from the mailbox
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001082 self.assertEqual(self._box.get_labels(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001083 msg0 = mailbox.BabylMessage(self._template % 0)
1084 msg0.add_label('foo')
1085 key0 = self._box.add(msg0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001086 self.assertEqual(self._box.get_labels(), ['foo'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001087 msg1 = mailbox.BabylMessage(self._template % 1)
1088 msg1.set_labels(['bar', 'answered', 'foo'])
1089 key1 = self._box.add(msg1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001090 self.assertEqual(set(self._box.get_labels()), set(['foo', 'bar']))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001091 msg0.set_labels(['blah', 'filed'])
1092 self._box[key0] = msg0
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001093 self.assertEqual(set(self._box.get_labels()),
1094 set(['foo', 'bar', 'blah']))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001095 self._box.remove(key1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001096 self.assertEqual(set(self._box.get_labels()), set(['blah']))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001097
1098
1099class TestMessage(TestBase):
1100
1101 _factory = mailbox.Message # Overridden by subclasses to reuse tests
1102
1103 def setUp(self):
1104 self._path = test_support.TESTFN
1105
1106 def tearDown(self):
1107 self._delete_recursively(self._path)
1108
1109 def test_initialize_with_eMM(self):
Georg Brandl5a096e12007-01-22 19:40:21 +00001110 # Initialize based on email.message.Message instance
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001111 eMM = email.message_from_string(_sample_message)
1112 msg = self._factory(eMM)
1113 self._post_initialize_hook(msg)
1114 self._check_sample(msg)
1115
1116 def test_initialize_with_string(self):
1117 # Initialize based on string
1118 msg = self._factory(_sample_message)
1119 self._post_initialize_hook(msg)
1120 self._check_sample(msg)
1121
1122 def test_initialize_with_file(self):
1123 # Initialize based on contents of file
Brian Curtin04d8b222010-10-14 01:14:36 +00001124 with open(self._path, 'w+') as f:
1125 f.write(_sample_message)
1126 f.seek(0)
1127 msg = self._factory(f)
1128 self._post_initialize_hook(msg)
1129 self._check_sample(msg)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001130
1131 def test_initialize_with_nothing(self):
1132 # Initialize without arguments
1133 msg = self._factory()
1134 self._post_initialize_hook(msg)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001135 self.assertIsInstance(msg, email.message.Message)
1136 self.assertIsInstance(msg, mailbox.Message)
1137 self.assertIsInstance(msg, self._factory)
1138 self.assertEqual(msg.keys(), [])
1139 self.assertFalse(msg.is_multipart())
1140 self.assertEqual(msg.get_payload(), None)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001141
1142 def test_initialize_incorrectly(self):
1143 # Initialize with invalid argument
1144 self.assertRaises(TypeError, lambda: self._factory(object()))
1145
1146 def test_become_message(self):
1147 # Take on the state of another message
1148 eMM = email.message_from_string(_sample_message)
1149 msg = self._factory()
1150 msg._become_message(eMM)
1151 self._check_sample(msg)
1152
1153 def test_explain_to(self):
1154 # Copy self's format-specific data to other message formats.
1155 # This test is superficial; better ones are in TestMessageConversion.
1156 msg = self._factory()
1157 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1158 mailbox.mboxMessage, mailbox.MHMessage,
1159 mailbox.BabylMessage, mailbox.MMDFMessage):
1160 other_msg = class_()
1161 msg._explain_to(other_msg)
Georg Brandl5a096e12007-01-22 19:40:21 +00001162 other_msg = email.message.Message()
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001163 self.assertRaises(TypeError, lambda: msg._explain_to(other_msg))
1164
1165 def _post_initialize_hook(self, msg):
1166 # Overridden by subclasses to check extra things after initialization
1167 pass
1168
1169
1170class TestMaildirMessage(TestMessage):
1171
1172 _factory = mailbox.MaildirMessage
1173
1174 def _post_initialize_hook(self, msg):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001175 self.assertEqual(msg._subdir, 'new')
1176 self.assertEqual(msg._info,'')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001177
1178 def test_subdir(self):
1179 # Use get_subdir() and set_subdir()
1180 msg = mailbox.MaildirMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001181 self.assertEqual(msg.get_subdir(), 'new')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001182 msg.set_subdir('cur')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001183 self.assertEqual(msg.get_subdir(), 'cur')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001184 msg.set_subdir('new')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001185 self.assertEqual(msg.get_subdir(), 'new')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001186 self.assertRaises(ValueError, lambda: msg.set_subdir('tmp'))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001187 self.assertEqual(msg.get_subdir(), 'new')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001188 msg.set_subdir('new')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001189 self.assertEqual(msg.get_subdir(), 'new')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001190 self._check_sample(msg)
1191
1192 def test_flags(self):
1193 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1194 msg = mailbox.MaildirMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001195 self.assertEqual(msg.get_flags(), '')
1196 self.assertEqual(msg.get_subdir(), 'new')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001197 msg.set_flags('F')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001198 self.assertEqual(msg.get_subdir(), 'new')
1199 self.assertEqual(msg.get_flags(), 'F')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001200 msg.set_flags('SDTP')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001201 self.assertEqual(msg.get_flags(), 'DPST')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001202 msg.add_flag('FT')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001203 self.assertEqual(msg.get_flags(), 'DFPST')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001204 msg.remove_flag('TDRP')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001205 self.assertEqual(msg.get_flags(), 'FS')
1206 self.assertEqual(msg.get_subdir(), 'new')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001207 self._check_sample(msg)
1208
1209 def test_date(self):
1210 # Use get_date() and set_date()
1211 msg = mailbox.MaildirMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001212 diff = msg.get_date() - time.time()
1213 self.assertTrue(abs(diff) < 60, diff)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001214 msg.set_date(0.0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001215 self.assertEqual(msg.get_date(), 0.0)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001216
1217 def test_info(self):
1218 # Use get_info() and set_info()
1219 msg = mailbox.MaildirMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001220 self.assertEqual(msg.get_info(), '')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001221 msg.set_info('1,foo=bar')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001222 self.assertEqual(msg.get_info(), '1,foo=bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001223 self.assertRaises(TypeError, lambda: msg.set_info(None))
1224 self._check_sample(msg)
1225
1226 def test_info_and_flags(self):
1227 # Test interaction of info and flag methods
1228 msg = mailbox.MaildirMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001229 self.assertEqual(msg.get_info(), '')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001230 msg.set_flags('SF')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001231 self.assertEqual(msg.get_flags(), 'FS')
1232 self.assertEqual(msg.get_info(), '2,FS')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001233 msg.set_info('1,')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001234 self.assertEqual(msg.get_flags(), '')
1235 self.assertEqual(msg.get_info(), '1,')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001236 msg.remove_flag('RPT')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001237 self.assertEqual(msg.get_flags(), '')
1238 self.assertEqual(msg.get_info(), '1,')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001239 msg.add_flag('D')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001240 self.assertEqual(msg.get_flags(), 'D')
1241 self.assertEqual(msg.get_info(), '2,D')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001242 self._check_sample(msg)
1243
1244
1245class _TestMboxMMDFMessage(TestMessage):
1246
1247 _factory = mailbox._mboxMMDFMessage
1248
1249 def _post_initialize_hook(self, msg):
1250 self._check_from(msg)
1251
1252 def test_initialize_with_unixfrom(self):
1253 # Initialize with a message that already has a _unixfrom attribute
1254 msg = mailbox.Message(_sample_message)
1255 msg.set_unixfrom('From foo@bar blah')
1256 msg = mailbox.mboxMessage(msg)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001257 self.assertEqual(msg.get_from(), 'foo@bar blah')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001258
1259 def test_from(self):
1260 # Get and set "From " line
1261 msg = mailbox.mboxMessage(_sample_message)
1262 self._check_from(msg)
1263 msg.set_from('foo bar')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001264 self.assertEqual(msg.get_from(), 'foo bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001265 msg.set_from('foo@bar', True)
1266 self._check_from(msg, 'foo@bar')
1267 msg.set_from('blah@temp', time.localtime())
1268 self._check_from(msg, 'blah@temp')
1269
1270 def test_flags(self):
1271 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1272 msg = mailbox.mboxMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001273 self.assertEqual(msg.get_flags(), '')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001274 msg.set_flags('F')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001275 self.assertEqual(msg.get_flags(), 'F')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001276 msg.set_flags('XODR')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001277 self.assertEqual(msg.get_flags(), 'RODX')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001278 msg.add_flag('FA')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001279 self.assertEqual(msg.get_flags(), 'RODFAX')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001280 msg.remove_flag('FDXA')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001281 self.assertEqual(msg.get_flags(), 'RO')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001282 self._check_sample(msg)
1283
1284 def _check_from(self, msg, sender=None):
1285 # Check contents of "From " line
1286 if sender is None:
1287 sender = "MAILER-DAEMON"
Benjamin Peterson5c8da862009-06-30 22:57:08 +00001288 self.assertTrue(re.match(sender + r" \w{3} \w{3} [\d ]\d [\d ]\d:\d{2}:"
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001289 r"\d{2} \d{4}", msg.get_from()))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001290
1291
1292class TestMboxMessage(_TestMboxMMDFMessage):
1293
1294 _factory = mailbox.mboxMessage
1295
1296
1297class TestMHMessage(TestMessage):
1298
1299 _factory = mailbox.MHMessage
1300
1301 def _post_initialize_hook(self, msg):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001302 self.assertEqual(msg._sequences, [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001303
1304 def test_sequences(self):
1305 # Get, set, join, and leave sequences
1306 msg = mailbox.MHMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001307 self.assertEqual(msg.get_sequences(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001308 msg.set_sequences(['foobar'])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001309 self.assertEqual(msg.get_sequences(), ['foobar'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001310 msg.set_sequences([])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001311 self.assertEqual(msg.get_sequences(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001312 msg.add_sequence('unseen')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001313 self.assertEqual(msg.get_sequences(), ['unseen'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001314 msg.add_sequence('flagged')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001315 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001316 msg.add_sequence('flagged')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001317 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001318 msg.remove_sequence('unseen')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001319 self.assertEqual(msg.get_sequences(), ['flagged'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001320 msg.add_sequence('foobar')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001321 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001322 msg.remove_sequence('replied')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001323 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001324 msg.set_sequences(['foobar', 'replied'])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001325 self.assertEqual(msg.get_sequences(), ['foobar', 'replied'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001326
1327
1328class TestBabylMessage(TestMessage):
1329
1330 _factory = mailbox.BabylMessage
1331
1332 def _post_initialize_hook(self, msg):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001333 self.assertEqual(msg._labels, [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001334
1335 def test_labels(self):
1336 # Get, set, join, and leave labels
1337 msg = mailbox.BabylMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001338 self.assertEqual(msg.get_labels(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001339 msg.set_labels(['foobar'])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001340 self.assertEqual(msg.get_labels(), ['foobar'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001341 msg.set_labels([])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001342 self.assertEqual(msg.get_labels(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001343 msg.add_label('filed')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001344 self.assertEqual(msg.get_labels(), ['filed'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001345 msg.add_label('resent')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001346 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001347 msg.add_label('resent')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001348 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001349 msg.remove_label('filed')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001350 self.assertEqual(msg.get_labels(), ['resent'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001351 msg.add_label('foobar')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001352 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001353 msg.remove_label('unseen')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001354 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001355 msg.set_labels(['foobar', 'answered'])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001356 self.assertEqual(msg.get_labels(), ['foobar', 'answered'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001357
1358 def test_visible(self):
1359 # Get, set, and update visible headers
1360 msg = mailbox.BabylMessage(_sample_message)
1361 visible = msg.get_visible()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001362 self.assertEqual(visible.keys(), [])
1363 self.assertIs(visible.get_payload(), None)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001364 visible['User-Agent'] = 'FooBar 1.0'
1365 visible['X-Whatever'] = 'Blah'
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001366 self.assertEqual(msg.get_visible().keys(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001367 msg.set_visible(visible)
1368 visible = msg.get_visible()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001369 self.assertEqual(visible.keys(), ['User-Agent', 'X-Whatever'])
1370 self.assertEqual(visible['User-Agent'], 'FooBar 1.0')
1371 self.assertEqual(visible['X-Whatever'], 'Blah')
1372 self.assertIs(visible.get_payload(), None)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001373 msg.update_visible()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001374 self.assertEqual(visible.keys(), ['User-Agent', 'X-Whatever'])
1375 self.assertIs(visible.get_payload(), None)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001376 visible = msg.get_visible()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001377 self.assertEqual(visible.keys(), ['User-Agent', 'Date', 'From', 'To',
1378 'Subject'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001379 for header in ('User-Agent', 'Date', 'From', 'To', 'Subject'):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001380 self.assertEqual(visible[header], msg[header])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001381
1382
1383class TestMMDFMessage(_TestMboxMMDFMessage):
1384
1385 _factory = mailbox.MMDFMessage
1386
1387
1388class TestMessageConversion(TestBase):
1389
1390 def test_plain_to_x(self):
1391 # Convert Message to all formats
1392 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1393 mailbox.mboxMessage, mailbox.MHMessage,
1394 mailbox.BabylMessage, mailbox.MMDFMessage):
1395 msg_plain = mailbox.Message(_sample_message)
1396 msg = class_(msg_plain)
1397 self._check_sample(msg)
1398
1399 def test_x_to_plain(self):
1400 # Convert all formats to Message
1401 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1402 mailbox.mboxMessage, mailbox.MHMessage,
1403 mailbox.BabylMessage, mailbox.MMDFMessage):
1404 msg = class_(_sample_message)
1405 msg_plain = mailbox.Message(msg)
1406 self._check_sample(msg_plain)
1407
1408 def test_x_to_invalid(self):
1409 # Convert all formats to an invalid format
1410 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1411 mailbox.mboxMessage, mailbox.MHMessage,
1412 mailbox.BabylMessage, mailbox.MMDFMessage):
1413 self.assertRaises(TypeError, lambda: class_(False))
1414
1415 def test_maildir_to_maildir(self):
1416 # Convert MaildirMessage to MaildirMessage
1417 msg_maildir = mailbox.MaildirMessage(_sample_message)
1418 msg_maildir.set_flags('DFPRST')
1419 msg_maildir.set_subdir('cur')
1420 date = msg_maildir.get_date()
1421 msg = mailbox.MaildirMessage(msg_maildir)
1422 self._check_sample(msg)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001423 self.assertEqual(msg.get_flags(), 'DFPRST')
1424 self.assertEqual(msg.get_subdir(), 'cur')
1425 self.assertEqual(msg.get_date(), date)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001426
1427 def test_maildir_to_mboxmmdf(self):
1428 # Convert MaildirMessage to mboxmessage and MMDFMessage
1429 pairs = (('D', ''), ('F', 'F'), ('P', ''), ('R', 'A'), ('S', 'R'),
1430 ('T', 'D'), ('DFPRST', 'RDFA'))
1431 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1432 msg_maildir = mailbox.MaildirMessage(_sample_message)
1433 msg_maildir.set_date(0.0)
1434 for setting, result in pairs:
1435 msg_maildir.set_flags(setting)
1436 msg = class_(msg_maildir)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001437 self.assertEqual(msg.get_flags(), result)
1438 self.assertEqual(msg.get_from(), 'MAILER-DAEMON %s' %
1439 time.asctime(time.gmtime(0.0)))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001440 msg_maildir.set_subdir('cur')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001441 self.assertEqual(class_(msg_maildir).get_flags(), 'RODFA')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001442
1443 def test_maildir_to_mh(self):
1444 # Convert MaildirMessage to MHMessage
1445 msg_maildir = mailbox.MaildirMessage(_sample_message)
1446 pairs = (('D', ['unseen']), ('F', ['unseen', 'flagged']),
1447 ('P', ['unseen']), ('R', ['unseen', 'replied']), ('S', []),
1448 ('T', ['unseen']), ('DFPRST', ['replied', 'flagged']))
1449 for setting, result in pairs:
1450 msg_maildir.set_flags(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001451 self.assertEqual(mailbox.MHMessage(msg_maildir).get_sequences(),
1452 result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001453
1454 def test_maildir_to_babyl(self):
1455 # Convert MaildirMessage to Babyl
1456 msg_maildir = mailbox.MaildirMessage(_sample_message)
1457 pairs = (('D', ['unseen']), ('F', ['unseen']),
1458 ('P', ['unseen', 'forwarded']), ('R', ['unseen', 'answered']),
1459 ('S', []), ('T', ['unseen', 'deleted']),
1460 ('DFPRST', ['deleted', 'answered', 'forwarded']))
1461 for setting, result in pairs:
1462 msg_maildir.set_flags(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001463 self.assertEqual(mailbox.BabylMessage(msg_maildir).get_labels(),
1464 result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001465
1466 def test_mboxmmdf_to_maildir(self):
1467 # Convert mboxMessage and MMDFMessage to MaildirMessage
1468 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1469 msg_mboxMMDF = class_(_sample_message)
1470 msg_mboxMMDF.set_from('foo@bar', time.gmtime(0.0))
1471 pairs = (('R', 'S'), ('O', ''), ('D', 'T'), ('F', 'F'), ('A', 'R'),
1472 ('RODFA', 'FRST'))
1473 for setting, result in pairs:
1474 msg_mboxMMDF.set_flags(setting)
1475 msg = mailbox.MaildirMessage(msg_mboxMMDF)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001476 self.assertEqual(msg.get_flags(), result)
1477 self.assertEqual(msg.get_date(), 0.0)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001478 msg_mboxMMDF.set_flags('O')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001479 self.assertEqual(mailbox.MaildirMessage(msg_mboxMMDF).get_subdir(),
1480 'cur')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001481
1482 def test_mboxmmdf_to_mboxmmdf(self):
1483 # Convert mboxMessage and MMDFMessage to mboxMessage and MMDFMessage
1484 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1485 msg_mboxMMDF = class_(_sample_message)
1486 msg_mboxMMDF.set_flags('RODFA')
1487 msg_mboxMMDF.set_from('foo@bar')
1488 for class2_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1489 msg2 = class2_(msg_mboxMMDF)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001490 self.assertEqual(msg2.get_flags(), 'RODFA')
1491 self.assertEqual(msg2.get_from(), 'foo@bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001492
1493 def test_mboxmmdf_to_mh(self):
1494 # Convert mboxMessage and MMDFMessage to MHMessage
1495 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1496 msg_mboxMMDF = class_(_sample_message)
1497 pairs = (('R', []), ('O', ['unseen']), ('D', ['unseen']),
1498 ('F', ['unseen', 'flagged']),
1499 ('A', ['unseen', 'replied']),
1500 ('RODFA', ['replied', 'flagged']))
1501 for setting, result in pairs:
1502 msg_mboxMMDF.set_flags(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001503 self.assertEqual(mailbox.MHMessage(msg_mboxMMDF).get_sequences(),
1504 result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001505
1506 def test_mboxmmdf_to_babyl(self):
1507 # Convert mboxMessage and MMDFMessage to BabylMessage
1508 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1509 msg = class_(_sample_message)
1510 pairs = (('R', []), ('O', ['unseen']),
1511 ('D', ['unseen', 'deleted']), ('F', ['unseen']),
1512 ('A', ['unseen', 'answered']),
1513 ('RODFA', ['deleted', 'answered']))
1514 for setting, result in pairs:
1515 msg.set_flags(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001516 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001517
1518 def test_mh_to_maildir(self):
1519 # Convert MHMessage to MaildirMessage
1520 pairs = (('unseen', ''), ('replied', 'RS'), ('flagged', 'FS'))
1521 for setting, result in pairs:
1522 msg = mailbox.MHMessage(_sample_message)
1523 msg.add_sequence(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001524 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1525 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001526 msg = mailbox.MHMessage(_sample_message)
1527 msg.add_sequence('unseen')
1528 msg.add_sequence('replied')
1529 msg.add_sequence('flagged')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001530 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'FR')
1531 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001532
1533 def test_mh_to_mboxmmdf(self):
1534 # Convert MHMessage to mboxMessage and MMDFMessage
1535 pairs = (('unseen', 'O'), ('replied', 'ROA'), ('flagged', 'ROF'))
1536 for setting, result in pairs:
1537 msg = mailbox.MHMessage(_sample_message)
1538 msg.add_sequence(setting)
1539 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001540 self.assertEqual(class_(msg).get_flags(), result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001541 msg = mailbox.MHMessage(_sample_message)
1542 msg.add_sequence('unseen')
1543 msg.add_sequence('replied')
1544 msg.add_sequence('flagged')
1545 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001546 self.assertEqual(class_(msg).get_flags(), 'OFA')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001547
1548 def test_mh_to_mh(self):
1549 # Convert MHMessage to MHMessage
1550 msg = mailbox.MHMessage(_sample_message)
1551 msg.add_sequence('unseen')
1552 msg.add_sequence('replied')
1553 msg.add_sequence('flagged')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001554 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1555 ['unseen', 'replied', 'flagged'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001556
1557 def test_mh_to_babyl(self):
1558 # Convert MHMessage to BabylMessage
1559 pairs = (('unseen', ['unseen']), ('replied', ['answered']),
1560 ('flagged', []))
1561 for setting, result in pairs:
1562 msg = mailbox.MHMessage(_sample_message)
1563 msg.add_sequence(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001564 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001565 msg = mailbox.MHMessage(_sample_message)
1566 msg.add_sequence('unseen')
1567 msg.add_sequence('replied')
1568 msg.add_sequence('flagged')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001569 self.assertEqual(mailbox.BabylMessage(msg).get_labels(),
1570 ['unseen', 'answered'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001571
1572 def test_babyl_to_maildir(self):
1573 # Convert BabylMessage to MaildirMessage
1574 pairs = (('unseen', ''), ('deleted', 'ST'), ('filed', 'S'),
1575 ('answered', 'RS'), ('forwarded', 'PS'), ('edited', 'S'),
1576 ('resent', 'PS'))
1577 for setting, result in pairs:
1578 msg = mailbox.BabylMessage(_sample_message)
1579 msg.add_label(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001580 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1581 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001582 msg = mailbox.BabylMessage(_sample_message)
1583 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1584 'edited', 'resent'):
1585 msg.add_label(label)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001586 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'PRT')
1587 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001588
1589 def test_babyl_to_mboxmmdf(self):
1590 # Convert BabylMessage to mboxMessage and MMDFMessage
1591 pairs = (('unseen', 'O'), ('deleted', 'ROD'), ('filed', 'RO'),
1592 ('answered', 'ROA'), ('forwarded', 'RO'), ('edited', 'RO'),
1593 ('resent', 'RO'))
1594 for setting, result in pairs:
1595 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1596 msg = mailbox.BabylMessage(_sample_message)
1597 msg.add_label(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001598 self.assertEqual(class_(msg).get_flags(), result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001599 msg = mailbox.BabylMessage(_sample_message)
1600 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1601 'edited', 'resent'):
1602 msg.add_label(label)
1603 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001604 self.assertEqual(class_(msg).get_flags(), 'ODA')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001605
1606 def test_babyl_to_mh(self):
1607 # Convert BabylMessage to MHMessage
1608 pairs = (('unseen', ['unseen']), ('deleted', []), ('filed', []),
1609 ('answered', ['replied']), ('forwarded', []), ('edited', []),
1610 ('resent', []))
1611 for setting, result in pairs:
1612 msg = mailbox.BabylMessage(_sample_message)
1613 msg.add_label(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001614 self.assertEqual(mailbox.MHMessage(msg).get_sequences(), result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001615 msg = mailbox.BabylMessage(_sample_message)
1616 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1617 'edited', 'resent'):
1618 msg.add_label(label)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001619 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1620 ['unseen', 'replied'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001621
1622 def test_babyl_to_babyl(self):
1623 # Convert BabylMessage to BabylMessage
1624 msg = mailbox.BabylMessage(_sample_message)
1625 msg.update_visible()
1626 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1627 'edited', 'resent'):
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001628 msg.add_label(label)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001629 msg2 = mailbox.BabylMessage(msg)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001630 self.assertEqual(msg2.get_labels(), ['unseen', 'deleted', 'filed',
1631 'answered', 'forwarded', 'edited',
1632 'resent'])
1633 self.assertEqual(msg.get_visible().keys(), msg2.get_visible().keys())
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001634 for key in msg.get_visible().keys():
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001635 self.assertEqual(msg.get_visible()[key], msg2.get_visible()[key])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001636
1637
1638class TestProxyFileBase(TestBase):
1639
1640 def _test_read(self, proxy):
1641 # Read by byte
1642 proxy.seek(0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001643 self.assertEqual(proxy.read(), 'bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001644 proxy.seek(1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001645 self.assertEqual(proxy.read(), 'ar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001646 proxy.seek(0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001647 self.assertEqual(proxy.read(2), 'ba')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001648 proxy.seek(1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001649 self.assertEqual(proxy.read(-1), 'ar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001650 proxy.seek(2)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001651 self.assertEqual(proxy.read(1000), 'r')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001652
1653 def _test_readline(self, proxy):
1654 # Read by line
1655 proxy.seek(0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001656 self.assertEqual(proxy.readline(), 'foo' + os.linesep)
1657 self.assertEqual(proxy.readline(), 'bar' + os.linesep)
1658 self.assertEqual(proxy.readline(), 'fred' + os.linesep)
1659 self.assertEqual(proxy.readline(), 'bob')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001660 proxy.seek(2)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001661 self.assertEqual(proxy.readline(), 'o' + os.linesep)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001662 proxy.seek(6 + 2 * len(os.linesep))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001663 self.assertEqual(proxy.readline(), 'fred' + os.linesep)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001664 proxy.seek(6 + 2 * len(os.linesep))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001665 self.assertEqual(proxy.readline(2), 'fr')
1666 self.assertEqual(proxy.readline(-10), 'ed' + os.linesep)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001667
1668 def _test_readlines(self, proxy):
1669 # Read multiple lines
1670 proxy.seek(0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001671 self.assertEqual(proxy.readlines(), ['foo' + os.linesep,
1672 'bar' + os.linesep,
1673 'fred' + os.linesep, 'bob'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001674 proxy.seek(0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001675 self.assertEqual(proxy.readlines(2), ['foo' + os.linesep])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001676 proxy.seek(3 + len(os.linesep))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001677 self.assertEqual(proxy.readlines(4 + len(os.linesep)),
1678 ['bar' + os.linesep, 'fred' + os.linesep])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001679 proxy.seek(3)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001680 self.assertEqual(proxy.readlines(1000), [os.linesep, 'bar' + os.linesep,
1681 'fred' + os.linesep, 'bob'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001682
1683 def _test_iteration(self, proxy):
1684 # Iterate by line
1685 proxy.seek(0)
1686 iterator = iter(proxy)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001687 self.assertEqual(list(iterator),
1688 ['foo' + os.linesep, 'bar' + os.linesep, 'fred' + os.linesep, 'bob'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001689
1690 def _test_seek_and_tell(self, proxy):
1691 # Seek and use tell to check position
1692 proxy.seek(3)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001693 self.assertEqual(proxy.tell(), 3)
1694 self.assertEqual(proxy.read(len(os.linesep)), os.linesep)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001695 proxy.seek(2, 1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001696 self.assertEqual(proxy.read(1 + len(os.linesep)), 'r' + os.linesep)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001697 proxy.seek(-3 - len(os.linesep), 2)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001698 self.assertEqual(proxy.read(3), 'bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001699 proxy.seek(2, 0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001700 self.assertEqual(proxy.read(), 'o' + os.linesep + 'bar' + os.linesep)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001701 proxy.seek(100)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001702 self.assertEqual(proxy.read(), '')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001703
1704 def _test_close(self, proxy):
1705 # Close a file
1706 proxy.close()
R David Murrayf1138bb2011-06-17 22:23:04 -04001707 # Issue 11700 subsequent closes should be a no-op, not an error.
1708 proxy.close()
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001709
1710
1711class TestProxyFile(TestProxyFileBase):
1712
1713 def setUp(self):
1714 self._path = test_support.TESTFN
Andrew M. Kuchling214db632006-05-02 21:44:33 +00001715 self._file = open(self._path, 'wb+')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001716
1717 def tearDown(self):
1718 self._file.close()
1719 self._delete_recursively(self._path)
1720
1721 def test_initialize(self):
1722 # Initialize and check position
1723 self._file.write('foo')
1724 pos = self._file.tell()
1725 proxy0 = mailbox._ProxyFile(self._file)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001726 self.assertEqual(proxy0.tell(), pos)
1727 self.assertEqual(self._file.tell(), pos)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001728 proxy1 = mailbox._ProxyFile(self._file, 0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001729 self.assertEqual(proxy1.tell(), 0)
1730 self.assertEqual(self._file.tell(), pos)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001731
1732 def test_read(self):
1733 self._file.write('bar')
1734 self._test_read(mailbox._ProxyFile(self._file))
1735
1736 def test_readline(self):
1737 self._file.write('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1738 os.linesep))
1739 self._test_readline(mailbox._ProxyFile(self._file))
1740
1741 def test_readlines(self):
1742 self._file.write('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1743 os.linesep))
1744 self._test_readlines(mailbox._ProxyFile(self._file))
1745
1746 def test_iteration(self):
1747 self._file.write('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1748 os.linesep))
1749 self._test_iteration(mailbox._ProxyFile(self._file))
1750
1751 def test_seek_and_tell(self):
1752 self._file.write('foo%sbar%s' % (os.linesep, os.linesep))
1753 self._test_seek_and_tell(mailbox._ProxyFile(self._file))
1754
1755 def test_close(self):
1756 self._file.write('foo%sbar%s' % (os.linesep, os.linesep))
1757 self._test_close(mailbox._ProxyFile(self._file))
1758
1759
1760class TestPartialFile(TestProxyFileBase):
1761
1762 def setUp(self):
1763 self._path = test_support.TESTFN
Andrew M. Kuchling214db632006-05-02 21:44:33 +00001764 self._file = open(self._path, 'wb+')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001765
1766 def tearDown(self):
1767 self._file.close()
1768 self._delete_recursively(self._path)
1769
1770 def test_initialize(self):
1771 # Initialize and check position
1772 self._file.write('foo' + os.linesep + 'bar')
1773 pos = self._file.tell()
1774 proxy = mailbox._PartialFile(self._file, 2, 5)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001775 self.assertEqual(proxy.tell(), 0)
1776 self.assertEqual(self._file.tell(), pos)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001777
1778 def test_read(self):
1779 self._file.write('***bar***')
1780 self._test_read(mailbox._PartialFile(self._file, 3, 6))
1781
1782 def test_readline(self):
1783 self._file.write('!!!!!foo%sbar%sfred%sbob!!!!!' %
1784 (os.linesep, os.linesep, os.linesep))
1785 self._test_readline(mailbox._PartialFile(self._file, 5,
1786 18 + 3 * len(os.linesep)))
1787
1788 def test_readlines(self):
1789 self._file.write('foo%sbar%sfred%sbob?????' %
1790 (os.linesep, os.linesep, os.linesep))
1791 self._test_readlines(mailbox._PartialFile(self._file, 0,
1792 13 + 3 * len(os.linesep)))
1793
1794 def test_iteration(self):
1795 self._file.write('____foo%sbar%sfred%sbob####' %
1796 (os.linesep, os.linesep, os.linesep))
1797 self._test_iteration(mailbox._PartialFile(self._file, 4,
1798 17 + 3 * len(os.linesep)))
1799
1800 def test_seek_and_tell(self):
1801 self._file.write('(((foo%sbar%s$$$' % (os.linesep, os.linesep))
1802 self._test_seek_and_tell(mailbox._PartialFile(self._file, 3,
1803 9 + 2 * len(os.linesep)))
1804
1805 def test_close(self):
1806 self._file.write('&foo%sbar%s^' % (os.linesep, os.linesep))
1807 self._test_close(mailbox._PartialFile(self._file, 1,
1808 6 + 3 * len(os.linesep)))
1809
1810
1811## Start: tests from the original module (for backward compatibility).
1812
Skip Montanaro5253da12004-07-24 19:56:03 +00001813FROM_ = "From some.body@dummy.domain Sat Jul 24 13:43:35 2004\n"
Fred Drakec02bc3e2001-05-21 20:23:21 +00001814DUMMY_MESSAGE = """\
1815From: some.body@dummy.domain
1816To: me@my.domain
Skip Montanaro5253da12004-07-24 19:56:03 +00001817Subject: Simple Test
Fred Drakec02bc3e2001-05-21 20:23:21 +00001818
1819This is a dummy message.
1820"""
1821
Fred Drakec02bc3e2001-05-21 20:23:21 +00001822class MaildirTestCase(unittest.TestCase):
1823
1824 def setUp(self):
1825 # create a new maildir mailbox to work with:
1826 self._dir = test_support.TESTFN
1827 os.mkdir(self._dir)
1828 os.mkdir(os.path.join(self._dir, "cur"))
1829 os.mkdir(os.path.join(self._dir, "tmp"))
1830 os.mkdir(os.path.join(self._dir, "new"))
1831 self._counter = 1
1832 self._msgfiles = []
1833
1834 def tearDown(self):
1835 map(os.unlink, self._msgfiles)
1836 os.rmdir(os.path.join(self._dir, "cur"))
1837 os.rmdir(os.path.join(self._dir, "tmp"))
1838 os.rmdir(os.path.join(self._dir, "new"))
1839 os.rmdir(self._dir)
1840
Skip Montanaro5253da12004-07-24 19:56:03 +00001841 def createMessage(self, dir, mbox=False):
Jack Jansen97df7b62001-06-19 20:20:05 +00001842 t = int(time.time() % 1000000)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001843 pid = self._counter
1844 self._counter += 1
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001845 filename = os.extsep.join((str(t), str(pid), "myhostname", "mydomain"))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001846 tmpname = os.path.join(self._dir, "tmp", filename)
1847 newname = os.path.join(self._dir, dir, filename)
Brian Curtin04d8b222010-10-14 01:14:36 +00001848 with open(tmpname, "w") as fp:
1849 self._msgfiles.append(tmpname)
1850 if mbox:
1851 fp.write(FROM_)
1852 fp.write(DUMMY_MESSAGE)
Tim Peters6626c1f2001-05-22 16:29:01 +00001853 if hasattr(os, "link"):
1854 os.link(tmpname, newname)
1855 else:
Brian Curtin04d8b222010-10-14 01:14:36 +00001856 with open(newname, "w") as fp:
1857 fp.write(DUMMY_MESSAGE)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001858 self._msgfiles.append(newname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001859 return tmpname
Fred Drakec02bc3e2001-05-21 20:23:21 +00001860
1861 def test_empty_maildir(self):
1862 """Test an empty maildir mailbox"""
1863 # Test for regression on bug #117490:
1864 # Make sure the boxes attribute actually gets set.
1865 self.mbox = mailbox.Maildir(test_support.TESTFN)
Benjamin Peterson5c8da862009-06-30 22:57:08 +00001866 #self.assertTrue(hasattr(self.mbox, "boxes"))
1867 #self.assertTrue(len(self.mbox.boxes) == 0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001868 self.assertIs(self.mbox.next(), None)
1869 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001870
1871 def test_nonempty_maildir_cur(self):
1872 self.createMessage("cur")
1873 self.mbox = mailbox.Maildir(test_support.TESTFN)
Benjamin Peterson5c8da862009-06-30 22:57:08 +00001874 #self.assertTrue(len(self.mbox.boxes) == 1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001875 self.assertIsNot(self.mbox.next(), None)
1876 self.assertIs(self.mbox.next(), None)
1877 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001878
1879 def test_nonempty_maildir_new(self):
1880 self.createMessage("new")
1881 self.mbox = mailbox.Maildir(test_support.TESTFN)
Benjamin Peterson5c8da862009-06-30 22:57:08 +00001882 #self.assertTrue(len(self.mbox.boxes) == 1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001883 self.assertIsNot(self.mbox.next(), None)
1884 self.assertIs(self.mbox.next(), None)
1885 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001886
1887 def test_nonempty_maildir_both(self):
1888 self.createMessage("cur")
1889 self.createMessage("new")
1890 self.mbox = mailbox.Maildir(test_support.TESTFN)
Benjamin Peterson5c8da862009-06-30 22:57:08 +00001891 #self.assertTrue(len(self.mbox.boxes) == 2)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001892 self.assertIsNot(self.mbox.next(), None)
1893 self.assertIsNot(self.mbox.next(), None)
1894 self.assertIs(self.mbox.next(), None)
1895 self.assertIs(self.mbox.next(), None)
Fred Drake0aaed272000-10-23 13:39:15 +00001896
Skip Montanaro5253da12004-07-24 19:56:03 +00001897 def test_unix_mbox(self):
1898 ### should be better!
Georg Brandl5a096e12007-01-22 19:40:21 +00001899 import email.parser
Skip Montanaro5253da12004-07-24 19:56:03 +00001900 fname = self.createMessage("cur", True)
1901 n = 0
1902 for msg in mailbox.PortableUnixMailbox(open(fname),
Georg Brandl5a096e12007-01-22 19:40:21 +00001903 email.parser.Parser().parse):
Skip Montanaro5253da12004-07-24 19:56:03 +00001904 n += 1
1905 self.assertEqual(msg["subject"], "Simple Test")
1906 self.assertEqual(len(str(msg)), len(FROM_)+len(DUMMY_MESSAGE))
1907 self.assertEqual(n, 1)
1908
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001909## End: classes from the original module (for backward compatibility).
1910
1911
1912_sample_message = """\
1913Return-Path: <gkj@gregorykjohnson.com>
1914X-Original-To: gkj+person@localhost
1915Delivered-To: gkj+person@localhost
1916Received: from localhost (localhost [127.0.0.1])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001917 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1918 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001919Delivered-To: gkj@sundance.gregorykjohnson.com
1920Received: from localhost [127.0.0.1]
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001921 by localhost with POP3 (fetchmail-6.2.5)
1922 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001923Received: from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001924 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1925 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001926Received: by andy.gregorykjohnson.com (Postfix, from userid 1000)
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001927 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001928Date: Wed, 13 Jul 2005 17:23:11 -0400
1929From: "Gregory K. Johnson" <gkj@gregorykjohnson.com>
1930To: gkj@gregorykjohnson.com
1931Subject: Sample message
1932Message-ID: <20050713212311.GC4701@andy.gregorykjohnson.com>
1933Mime-Version: 1.0
1934Content-Type: multipart/mixed; boundary="NMuMz9nt05w80d4+"
1935Content-Disposition: inline
1936User-Agent: Mutt/1.5.9i
1937
1938
1939--NMuMz9nt05w80d4+
1940Content-Type: text/plain; charset=us-ascii
1941Content-Disposition: inline
1942
1943This is a sample message.
1944
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001945--
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001946Gregory K. Johnson
1947
1948--NMuMz9nt05w80d4+
1949Content-Type: application/octet-stream
1950Content-Disposition: attachment; filename="text.gz"
1951Content-Transfer-Encoding: base64
1952
1953H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
19543FYlAAAA
1955
1956--NMuMz9nt05w80d4+--
1957"""
1958
1959_sample_headers = {
1960 "Return-Path":"<gkj@gregorykjohnson.com>",
1961 "X-Original-To":"gkj+person@localhost",
1962 "Delivered-To":"gkj+person@localhost",
1963 "Received":"""from localhost (localhost [127.0.0.1])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001964 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1965 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001966 "Delivered-To":"gkj@sundance.gregorykjohnson.com",
1967 "Received":"""from localhost [127.0.0.1]
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001968 by localhost with POP3 (fetchmail-6.2.5)
1969 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001970 "Received":"""from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001971 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1972 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001973 "Received":"""by andy.gregorykjohnson.com (Postfix, from userid 1000)
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001974 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001975 "Date":"Wed, 13 Jul 2005 17:23:11 -0400",
1976 "From":""""Gregory K. Johnson" <gkj@gregorykjohnson.com>""",
1977 "To":"gkj@gregorykjohnson.com",
1978 "Subject":"Sample message",
1979 "Mime-Version":"1.0",
1980 "Content-Type":"""multipart/mixed; boundary="NMuMz9nt05w80d4+\"""",
1981 "Content-Disposition":"inline",
1982 "User-Agent": "Mutt/1.5.9i" }
1983
1984_sample_payloads = ("""This is a sample message.
1985
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001986--
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001987Gregory K. Johnson
1988""",
1989"""H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
19903FYlAAAA
1991""")
Fred Drake0aaed272000-10-23 13:39:15 +00001992
Fred Drakec02bc3e2001-05-21 20:23:21 +00001993
Fred Drake2e2be372001-09-20 21:33:42 +00001994def test_main():
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001995 tests = (TestMailboxSuperclass, TestMaildir, TestMbox, TestMMDF, TestMH,
1996 TestBabyl, TestMessage, TestMaildirMessage, TestMboxMessage,
1997 TestMHMessage, TestBabylMessage, TestMMDFMessage,
1998 TestMessageConversion, TestProxyFile, TestPartialFile,
1999 MaildirTestCase)
2000 test_support.run_unittest(*tests)
Neal Norwitzb15ac312006-06-29 04:10:08 +00002001 test_support.reap_children()
Fred Drake2e2be372001-09-20 21:33:42 +00002002
2003
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00002004if __name__ == '__main__':
Fred Drake2e2be372001-09-20 21:33:42 +00002005 test_main()