blob: 925f8781c132a70a63875fa85caa764642b8a967 [file] [log] [blame]
Fred Drake0aaed272000-10-23 13:39:15 +00001import os
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00002import sys
Fred Drakec02bc3e2001-05-21 20:23:21 +00003import time
Thomas Wouters477c8d52006-05-27 19:21:47 +00004import stat
5import socket
6import email
Thomas Woutersb2137042007-02-01 18:02:27 +00007import email.message
Thomas Wouters477c8d52006-05-27 19:21:47 +00008import rfc822
9import re
Guido van Rossum34d19282007-08-09 01:03:29 +000010import io
Barry Warsaw04f357c2002-07-23 19:04:11 +000011from test import test_support
Thomas Wouters477c8d52006-05-27 19:21:47 +000012import unittest
13import mailbox
14import glob
Guido van Rossum75ebb292001-04-10 15:01:20 +000015try:
Thomas Wouters477c8d52006-05-27 19:21:47 +000016 import fcntl
17except ImportError:
Guido van Rossum75ebb292001-04-10 15:01:20 +000018 pass
19
Thomas Wouters477c8d52006-05-27 19:21:47 +000020
21class TestBase(unittest.TestCase):
22
23 def _check_sample(self, msg):
24 # Inspect a mailbox.Message representation of the sample message
Thomas Woutersb2137042007-02-01 18:02:27 +000025 self.assert_(isinstance(msg, email.message.Message))
Thomas Wouters477c8d52006-05-27 19:21:47 +000026 self.assert_(isinstance(msg, mailbox.Message))
Guido van Rossumcc2b0162007-02-11 06:12:03 +000027 for key, value in _sample_headers.items():
Thomas Wouters477c8d52006-05-27 19:21:47 +000028 self.assert_(value in msg.get_all(key))
29 self.assert_(msg.is_multipart())
Guido van Rossume61fd5b2007-07-11 12:20:59 +000030 self.assertEqual(len(msg.get_payload()), len(_sample_payloads))
Thomas Wouters477c8d52006-05-27 19:21:47 +000031 for i, payload in enumerate(_sample_payloads):
32 part = msg.get_payload(i)
Thomas Woutersb2137042007-02-01 18:02:27 +000033 self.assert_(isinstance(part, email.message.Message))
Thomas Wouters477c8d52006-05-27 19:21:47 +000034 self.assert_(not isinstance(part, mailbox.Message))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000035 self.assertEqual(part.get_payload(), payload)
Thomas Wouters477c8d52006-05-27 19:21:47 +000036
37 def _delete_recursively(self, target):
38 # Delete a file or delete a directory recursively
39 if os.path.isdir(target):
40 for path, dirs, files in os.walk(target, topdown=False):
41 for name in files:
42 os.remove(os.path.join(path, name))
43 for name in dirs:
44 os.rmdir(os.path.join(path, name))
45 os.rmdir(target)
46 elif os.path.exists(target):
47 os.remove(target)
48
49
50class TestMailbox(TestBase):
51
52 _factory = None # Overridden by subclasses to reuse tests
53 _template = 'From: foo\n\n%s'
54
55 def setUp(self):
56 self._path = test_support.TESTFN
Guido van Rossumd8faa362007-04-27 19:54:29 +000057 self._delete_recursively(self._path)
Thomas Wouters477c8d52006-05-27 19:21:47 +000058 self._box = self._factory(self._path)
59
60 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +000061 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +000062 self._delete_recursively(self._path)
63
64 def test_add(self):
65 # Add copies of a sample message
66 keys = []
67 keys.append(self._box.add(self._template % 0))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000068 self.assertEqual(len(self._box), 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +000069 keys.append(self._box.add(mailbox.Message(_sample_message)))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000070 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +000071 keys.append(self._box.add(email.message_from_string(_sample_message)))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000072 self.assertEqual(len(self._box), 3)
Guido van Rossum34d19282007-08-09 01:03:29 +000073 keys.append(self._box.add(io.StringIO(_sample_message)))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000074 self.assertEqual(len(self._box), 4)
Thomas Wouters477c8d52006-05-27 19:21:47 +000075 keys.append(self._box.add(_sample_message))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000076 self.assertEqual(len(self._box), 5)
Guido van Rossumea834472007-07-27 05:17:50 +000077 self.assertEqual(self._box.get_string(keys[0]), self._template % 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +000078 for i in (1, 2, 3, 4):
79 self._check_sample(self._box[keys[i]])
80
81 def test_remove(self):
82 # Remove messages using remove()
83 self._test_remove_or_delitem(self._box.remove)
84
85 def test_delitem(self):
86 # Remove messages using __delitem__()
87 self._test_remove_or_delitem(self._box.__delitem__)
88
89 def _test_remove_or_delitem(self, method):
90 # (Used by test_remove() and test_delitem().)
91 key0 = self._box.add(self._template % 0)
92 key1 = self._box.add(self._template % 1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +000093 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +000094 method(key0)
95 l = len(self._box)
96 self.assert_(l == 1, "actual l: %s" % l)
97 self.assertRaises(KeyError, lambda: self._box[key0])
98 self.assertRaises(KeyError, lambda: method(key0))
Guido van Rossumea834472007-07-27 05:17:50 +000099 self.assertEqual(self._box.get_string(key1), self._template % 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000100 key2 = self._box.add(self._template % 2)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000101 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000102 method(key2)
103 l = len(self._box)
104 self.assert_(l == 1, "actual l: %s" % l)
105 self.assertRaises(KeyError, lambda: self._box[key2])
106 self.assertRaises(KeyError, lambda: method(key2))
Guido van Rossumea834472007-07-27 05:17:50 +0000107 self.assertEqual(self._box.get_string(key1), self._template % 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000108 method(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000109 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000110 self.assertRaises(KeyError, lambda: self._box[key1])
111 self.assertRaises(KeyError, lambda: method(key1))
112
113 def test_discard(self, repetitions=10):
114 # Discard messages
115 key0 = self._box.add(self._template % 0)
116 key1 = self._box.add(self._template % 1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000117 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000118 self._box.discard(key0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000119 self.assertEqual(len(self._box), 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000120 self.assertRaises(KeyError, lambda: self._box[key0])
121 self._box.discard(key0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000122 self.assertEqual(len(self._box), 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000123 self.assertRaises(KeyError, lambda: self._box[key0])
124
125 def test_get(self):
126 # Retrieve messages using get()
127 key0 = self._box.add(self._template % 0)
128 msg = self._box.get(key0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000129 self.assertEqual(msg['from'], 'foo')
130 self.assertEqual(msg.get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000131 self.assert_(self._box.get('foo') is None)
132 self.assert_(self._box.get('foo', False) is False)
133 self._box.close()
134 self._box = self._factory(self._path, factory=rfc822.Message)
135 key1 = self._box.add(self._template % 1)
136 msg = self._box.get(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000137 self.assertEqual(msg['from'], 'foo')
138 self.assertEqual(msg.fp.read(), '1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000139
140 def test_getitem(self):
141 # Retrieve message using __getitem__()
142 key0 = self._box.add(self._template % 0)
143 msg = self._box[key0]
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000144 self.assertEqual(msg['from'], 'foo')
145 self.assertEqual(msg.get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000146 self.assertRaises(KeyError, lambda: self._box['foo'])
147 self._box.discard(key0)
148 self.assertRaises(KeyError, lambda: self._box[key0])
149
150 def test_get_message(self):
151 # Get Message representations of messages
152 key0 = self._box.add(self._template % 0)
153 key1 = self._box.add(_sample_message)
154 msg0 = self._box.get_message(key0)
155 self.assert_(isinstance(msg0, mailbox.Message))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000156 self.assertEqual(msg0['from'], 'foo')
157 self.assertEqual(msg0.get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000158 self._check_sample(self._box.get_message(key1))
159
160 def test_get_string(self):
161 # Get string representations of messages
162 key0 = self._box.add(self._template % 0)
163 key1 = self._box.add(_sample_message)
Guido van Rossumea834472007-07-27 05:17:50 +0000164 self.assertEqual(self._box.get_string(key0), self._template % 0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000165 self.assertEqual(self._box.get_string(key1), _sample_message)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000166
167 def test_get_file(self):
168 # Get file representations of messages
169 key0 = self._box.add(self._template % 0)
170 key1 = self._box.add(_sample_message)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000171 data0 = self._box.get_file(key0).read()
172 data1 = self._box.get_file(key1).read()
173 self.assertEqual(data0.replace(os.linesep, '\n'),
Guido van Rossumea834472007-07-27 05:17:50 +0000174 self._template % 0)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000175 self.assertEqual(data1.replace(os.linesep, '\n'),
Guido van Rossumea834472007-07-27 05:17:50 +0000176 _sample_message)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000177
178 def test_iterkeys(self):
179 # Get keys using iterkeys()
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000180 self._check_iteration(self._box.keys, do_keys=True, do_values=False)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000181
182 def test_keys(self):
183 # Get keys using keys()
184 self._check_iteration(self._box.keys, do_keys=True, do_values=False)
185
186 def test_itervalues(self):
187 # Get values using itervalues()
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000188 self._check_iteration(self._box.values, do_keys=False,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000189 do_values=True)
190
191 def test_iter(self):
192 # Get values using __iter__()
193 self._check_iteration(self._box.__iter__, do_keys=False,
194 do_values=True)
195
196 def test_values(self):
197 # Get values using values()
198 self._check_iteration(self._box.values, do_keys=False, do_values=True)
199
200 def test_iteritems(self):
201 # Get keys and values using iteritems()
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000202 self._check_iteration(self._box.items, do_keys=True,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000203 do_values=True)
204
205 def test_items(self):
206 # Get keys and values using items()
207 self._check_iteration(self._box.items, do_keys=True, do_values=True)
208
209 def _check_iteration(self, method, do_keys, do_values, repetitions=10):
210 for value in method():
211 self.fail("Not empty")
212 keys, values = [], []
Guido van Rossum805365e2007-05-07 22:24:25 +0000213 for i in range(repetitions):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000214 keys.append(self._box.add(self._template % i))
215 values.append(self._template % i)
216 if do_keys and not do_values:
217 returned_keys = list(method())
218 elif do_values and not do_keys:
219 returned_values = list(method())
220 else:
221 returned_keys, returned_values = [], []
222 for key, value in method():
223 returned_keys.append(key)
224 returned_values.append(value)
225 if do_keys:
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000226 self.assertEqual(len(keys), len(returned_keys))
227 self.assertEqual(set(keys), set(returned_keys))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000228 if do_values:
229 count = 0
230 for value in returned_values:
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000231 self.assertEqual(value['from'], 'foo')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000232 self.assert_(int(value.get_payload()) < repetitions)
233 count += 1
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000234 self.assertEqual(len(values), count)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000235
Thomas Wouters477c8d52006-05-27 19:21:47 +0000236 def test_contains(self):
237 # Check existence of keys using __contains__()
Guido van Rossume2b70bc2006-08-18 22:13:04 +0000238 method = self._box.__contains__
Thomas Wouters477c8d52006-05-27 19:21:47 +0000239 self.assert_(not method('foo'))
240 key0 = self._box.add(self._template % 0)
241 self.assert_(method(key0))
242 self.assert_(not method('foo'))
243 key1 = self._box.add(self._template % 1)
244 self.assert_(method(key1))
245 self.assert_(method(key0))
246 self.assert_(not method('foo'))
247 self._box.remove(key0)
248 self.assert_(not method(key0))
249 self.assert_(method(key1))
250 self.assert_(not method('foo'))
251 self._box.remove(key1)
252 self.assert_(not method(key1))
253 self.assert_(not method(key0))
254 self.assert_(not method('foo'))
255
256 def test_len(self, repetitions=10):
257 # Get message count
258 keys = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000259 for i in range(repetitions):
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000260 self.assertEqual(len(self._box), i)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000261 keys.append(self._box.add(self._template % i))
Guido van Rossumea834472007-07-27 05:17:50 +0000262 self.assertEqual(len(self._box), i + 1)
Guido van Rossum805365e2007-05-07 22:24:25 +0000263 for i in range(repetitions):
Guido van Rossumea834472007-07-27 05:17:50 +0000264 self.assertEqual(len(self._box), repetitions - i)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000265 self._box.remove(keys[i])
Guido van Rossumea834472007-07-27 05:17:50 +0000266 self.assertEqual(len(self._box), repetitions - i - 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000267
268 def test_set_item(self):
269 # Modify messages using __setitem__()
270 key0 = self._box.add(self._template % 'original 0')
Guido van Rossumea834472007-07-27 05:17:50 +0000271 self.assertEqual(self._box.get_string(key0),
272 self._template % 'original 0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000273 key1 = self._box.add(self._template % 'original 1')
Guido van Rossumea834472007-07-27 05:17:50 +0000274 self.assertEqual(self._box.get_string(key1),
275 self._template % 'original 1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000276 self._box[key0] = self._template % 'changed 0'
Guido van Rossumea834472007-07-27 05:17:50 +0000277 self.assertEqual(self._box.get_string(key0),
278 self._template % 'changed 0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000279 self._box[key1] = self._template % 'changed 1'
Guido van Rossumea834472007-07-27 05:17:50 +0000280 self.assertEqual(self._box.get_string(key1),
281 self._template % 'changed 1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000282 self._box[key0] = _sample_message
283 self._check_sample(self._box[key0])
284 self._box[key1] = self._box[key0]
285 self._check_sample(self._box[key1])
286 self._box[key0] = self._template % 'original 0'
Guido van Rossumea834472007-07-27 05:17:50 +0000287 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000288 self._template % 'original 0')
289 self._check_sample(self._box[key1])
290 self.assertRaises(KeyError,
291 lambda: self._box.__setitem__('foo', 'bar'))
292 self.assertRaises(KeyError, lambda: self._box['foo'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000293 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000294
295 def test_clear(self, iterations=10):
296 # Remove all messages using clear()
297 keys = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000298 for i in range(iterations):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000299 self._box.add(self._template % i)
300 for i, key in enumerate(keys):
301 self.assert_(self._box.get_string(key) == self._template % i)
302 self._box.clear()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000303 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000304 for i, key in enumerate(keys):
305 self.assertRaises(KeyError, lambda: self._box.get_string(key))
306
307 def test_pop(self):
308 # Get and remove a message using pop()
309 key0 = self._box.add(self._template % 0)
310 self.assert_(key0 in self._box)
311 key1 = self._box.add(self._template % 1)
312 self.assert_(key1 in self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000313 self.assertEqual(self._box.pop(key0).get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000314 self.assert_(key0 not in self._box)
315 self.assert_(key1 in self._box)
316 key2 = self._box.add(self._template % 2)
317 self.assert_(key2 in self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000318 self.assertEqual(self._box.pop(key2).get_payload(), '2')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000319 self.assert_(key2 not in self._box)
320 self.assert_(key1 in self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000321 self.assertEqual(self._box.pop(key1).get_payload(), '1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000322 self.assert_(key1 not in self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000323 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000324
325 def test_popitem(self, iterations=10):
326 # Get and remove an arbitrary (key, message) using popitem()
327 keys = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000328 for i in range(10):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000329 keys.append(self._box.add(self._template % i))
330 seen = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000331 for i in range(10):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000332 key, msg = self._box.popitem()
333 self.assert_(key in keys)
334 self.assert_(key not in seen)
335 seen.append(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000336 self.assertEqual(int(msg.get_payload()), keys.index(key))
337 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000338 for key in keys:
339 self.assertRaises(KeyError, lambda: self._box[key])
340
341 def test_update(self):
342 # Modify multiple messages using update()
343 key0 = self._box.add(self._template % 'original 0')
344 key1 = self._box.add(self._template % 'original 1')
345 key2 = self._box.add(self._template % 'original 2')
346 self._box.update({key0: self._template % 'changed 0',
347 key2: _sample_message})
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000348 self.assertEqual(len(self._box), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000349 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000350 self._template % 'changed 0')
Guido van Rossumea834472007-07-27 05:17:50 +0000351 self.assertEqual(self._box.get_string(key1),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000352 self._template % 'original 1')
353 self._check_sample(self._box[key2])
354 self._box.update([(key2, self._template % 'changed 2'),
355 (key1, self._template % 'changed 1'),
356 (key0, self._template % 'original 0')])
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000357 self.assertEqual(len(self._box), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000358 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000359 self._template % 'original 0')
Guido van Rossumea834472007-07-27 05:17:50 +0000360 self.assertEqual(self._box.get_string(key1),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000361 self._template % 'changed 1')
Guido van Rossumea834472007-07-27 05:17:50 +0000362 self.assertEqual(self._box.get_string(key2),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000363 self._template % 'changed 2')
364 self.assertRaises(KeyError,
365 lambda: self._box.update({'foo': 'bar',
366 key0: self._template % "changed 0"}))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000367 self.assertEqual(len(self._box), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000368 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000369 self._template % "changed 0")
Guido van Rossumea834472007-07-27 05:17:50 +0000370 self.assertEqual(self._box.get_string(key1),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000371 self._template % "changed 1")
Guido van Rossumea834472007-07-27 05:17:50 +0000372 self.assertEqual(self._box.get_string(key2),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000373 self._template % "changed 2")
374
375 def test_flush(self):
376 # Write changes to disk
377 self._test_flush_or_close(self._box.flush)
378
379 def test_lock_unlock(self):
380 # Lock and unlock the mailbox
381 self.assert_(not os.path.exists(self._get_lock_path()))
382 self._box.lock()
383 self.assert_(os.path.exists(self._get_lock_path()))
384 self._box.unlock()
385 self.assert_(not os.path.exists(self._get_lock_path()))
386
387 def test_close(self):
388 # Close mailbox and flush changes to disk
389 self._test_flush_or_close(self._box.close)
390
391 def _test_flush_or_close(self, method):
Guido van Rossum805365e2007-05-07 22:24:25 +0000392 contents = [self._template % i for i in range(3)]
Thomas Wouters477c8d52006-05-27 19:21:47 +0000393 self._box.add(contents[0])
394 self._box.add(contents[1])
395 self._box.add(contents[2])
Guido van Rossumc12a8132007-10-26 04:29:23 +0000396 oldbox = self._box
Thomas Wouters477c8d52006-05-27 19:21:47 +0000397 method()
398 self._box = self._factory(self._path)
399 keys = self._box.keys()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000400 self.assertEqual(len(keys), 3)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000401 for key in keys:
402 self.assert_(self._box.get_string(key) in contents)
Guido van Rossumc12a8132007-10-26 04:29:23 +0000403 oldbox.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000404
405 def test_dump_message(self):
406 # Write message representations to disk
407 for input in (email.message_from_string(_sample_message),
Guido van Rossum34d19282007-08-09 01:03:29 +0000408 _sample_message, io.StringIO(_sample_message)):
409 output = io.StringIO()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000410 self._box._dump_message(input, output)
Guido van Rossumc12a8132007-10-26 04:29:23 +0000411 self.assertEqual(output.getvalue(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000412 _sample_message.replace('\n', os.linesep))
Guido van Rossum34d19282007-08-09 01:03:29 +0000413 output = io.StringIO()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000414 self.assertRaises(TypeError,
415 lambda: self._box._dump_message(None, output))
416
417 def _get_lock_path(self):
418 # Return the path of the dot lock file. May be overridden.
419 return self._path + '.lock'
420
421
422class TestMailboxSuperclass(TestBase):
423
424 def test_notimplemented(self):
425 # Test that all Mailbox methods raise NotImplementedException.
426 box = mailbox.Mailbox('path')
427 self.assertRaises(NotImplementedError, lambda: box.add(''))
428 self.assertRaises(NotImplementedError, lambda: box.remove(''))
429 self.assertRaises(NotImplementedError, lambda: box.__delitem__(''))
430 self.assertRaises(NotImplementedError, lambda: box.discard(''))
431 self.assertRaises(NotImplementedError, lambda: box.__setitem__('', ''))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000432 self.assertRaises(NotImplementedError, lambda: box.keys())
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000433 self.assertRaises(NotImplementedError, lambda: box.keys())
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000434 self.assertRaises(NotImplementedError, lambda: box.values().__next__())
435 self.assertRaises(NotImplementedError, lambda: box.__iter__().__next__())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000436 self.assertRaises(NotImplementedError, lambda: box.values())
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000437 self.assertRaises(NotImplementedError, lambda: box.items().next())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000438 self.assertRaises(NotImplementedError, lambda: box.items())
439 self.assertRaises(NotImplementedError, lambda: box.get(''))
440 self.assertRaises(NotImplementedError, lambda: box.__getitem__(''))
441 self.assertRaises(NotImplementedError, lambda: box.get_message(''))
442 self.assertRaises(NotImplementedError, lambda: box.get_string(''))
443 self.assertRaises(NotImplementedError, lambda: box.get_file(''))
Guido van Rossume2b70bc2006-08-18 22:13:04 +0000444 self.assertRaises(NotImplementedError, lambda: '' in box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000445 self.assertRaises(NotImplementedError, lambda: box.__contains__(''))
446 self.assertRaises(NotImplementedError, lambda: box.__len__())
447 self.assertRaises(NotImplementedError, lambda: box.clear())
448 self.assertRaises(NotImplementedError, lambda: box.pop(''))
449 self.assertRaises(NotImplementedError, lambda: box.popitem())
450 self.assertRaises(NotImplementedError, lambda: box.update((('', ''),)))
451 self.assertRaises(NotImplementedError, lambda: box.flush())
452 self.assertRaises(NotImplementedError, lambda: box.lock())
453 self.assertRaises(NotImplementedError, lambda: box.unlock())
454 self.assertRaises(NotImplementedError, lambda: box.close())
455
456
457class TestMaildir(TestMailbox):
458
459 _factory = lambda self, path, factory=None: mailbox.Maildir(path, factory)
460
461 def setUp(self):
462 TestMailbox.setUp(self)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000463 if os.name in ('nt', 'os2') or sys.platform == 'cygwin':
Thomas Wouters477c8d52006-05-27 19:21:47 +0000464 self._box.colon = '!'
465
466 def test_add_MM(self):
467 # Add a MaildirMessage instance
468 msg = mailbox.MaildirMessage(self._template % 0)
469 msg.set_subdir('cur')
470 msg.set_info('foo')
471 key = self._box.add(msg)
472 self.assert_(os.path.exists(os.path.join(self._path, 'cur', '%s%sfoo' %
473 (key, self._box.colon))))
474
475 def test_get_MM(self):
476 # Get a MaildirMessage instance
477 msg = mailbox.MaildirMessage(self._template % 0)
478 msg.set_subdir('cur')
479 msg.set_flags('RF')
480 key = self._box.add(msg)
481 msg_returned = self._box.get_message(key)
482 self.assert_(isinstance(msg_returned, mailbox.MaildirMessage))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000483 self.assertEqual(msg_returned.get_subdir(), 'cur')
484 self.assertEqual(msg_returned.get_flags(), 'FR')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000485
486 def test_set_MM(self):
487 # Set with a MaildirMessage instance
488 msg0 = mailbox.MaildirMessage(self._template % 0)
489 msg0.set_flags('TP')
490 key = self._box.add(msg0)
491 msg_returned = self._box.get_message(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000492 self.assertEqual(msg_returned.get_subdir(), 'new')
493 self.assertEqual(msg_returned.get_flags(), 'PT')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000494 msg1 = mailbox.MaildirMessage(self._template % 1)
495 self._box[key] = msg1
496 msg_returned = self._box.get_message(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000497 self.assertEqual(msg_returned.get_subdir(), 'new')
498 self.assertEqual(msg_returned.get_flags(), '')
499 self.assertEqual(msg_returned.get_payload(), '1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000500 msg2 = mailbox.MaildirMessage(self._template % 2)
501 msg2.set_info('2,S')
502 self._box[key] = msg2
503 self._box[key] = self._template % 3
504 msg_returned = self._box.get_message(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000505 self.assertEqual(msg_returned.get_subdir(), 'new')
506 self.assertEqual(msg_returned.get_flags(), 'S')
507 self.assertEqual(msg_returned.get_payload(), '3')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000508
Christian Heimesfdab48e2008-01-20 09:06:41 +0000509 def test_consistent_factory(self):
510 # Add a message.
511 msg = mailbox.MaildirMessage(self._template % 0)
512 msg.set_subdir('cur')
513 msg.set_flags('RF')
514 key = self._box.add(msg)
515
516 # Create new mailbox with
517 class FakeMessage(mailbox.MaildirMessage):
518 pass
519 box = mailbox.Maildir(self._path, factory=FakeMessage)
Christian Heimes15ebc882008-02-04 18:48:49 +0000520 box.colon = self._box.colon
Christian Heimesfdab48e2008-01-20 09:06:41 +0000521 msg2 = box.get_message(key)
522 self.assert_(isinstance(msg2, FakeMessage))
523
Thomas Wouters477c8d52006-05-27 19:21:47 +0000524 def test_initialize_new(self):
525 # Initialize a non-existent mailbox
526 self.tearDown()
527 self._box = mailbox.Maildir(self._path)
528 self._check_basics(factory=rfc822.Message)
529 self._delete_recursively(self._path)
530 self._box = self._factory(self._path, factory=None)
531 self._check_basics()
532
533 def test_initialize_existing(self):
534 # Initialize an existing mailbox
535 self.tearDown()
536 for subdir in '', 'tmp', 'new', 'cur':
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000537 os.mkdir(os.path.normpath(os.path.join(self._path, subdir)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000538 self._box = mailbox.Maildir(self._path)
539 self._check_basics(factory=rfc822.Message)
540 self._box = mailbox.Maildir(self._path, factory=None)
541 self._check_basics()
542
543 def _check_basics(self, factory=None):
544 # (Used by test_open_new() and test_open_existing().)
545 self.assertEqual(self._box._path, os.path.abspath(self._path))
546 self.assertEqual(self._box._factory, factory)
547 for subdir in '', 'tmp', 'new', 'cur':
548 path = os.path.join(self._path, subdir)
549 mode = os.stat(path)[stat.ST_MODE]
550 self.assert_(stat.S_ISDIR(mode), "Not a directory: '%s'" % path)
551
552 def test_list_folders(self):
553 # List folders
554 self._box.add_folder('one')
555 self._box.add_folder('two')
556 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000557 self.assertEqual(len(self._box.list_folders()), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000558 self.assertEqual(set(self._box.list_folders()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000559 set(('one', 'two', 'three')))
560
561 def test_get_folder(self):
562 # Open folders
563 self._box.add_folder('foo.bar')
564 folder0 = self._box.get_folder('foo.bar')
565 folder0.add(self._template % 'bar')
566 self.assert_(os.path.isdir(os.path.join(self._path, '.foo.bar')))
567 folder1 = self._box.get_folder('foo.bar')
Guido van Rossumea834472007-07-27 05:17:50 +0000568 self.assertEqual(folder1.get_string(folder1.keys()[0]),
569 self._template % 'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000570
571 def test_add_and_remove_folders(self):
572 # Delete folders
573 self._box.add_folder('one')
574 self._box.add_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000575 self.assertEqual(len(self._box.list_folders()), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000576 self.assert_(set(self._box.list_folders()) == set(('one', 'two')))
577 self._box.remove_folder('one')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000578 self.assertEqual(len(self._box.list_folders()), 1)
579 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000580 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000581 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000582 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000583 self._box.remove_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000584 self.assertEqual(len(self._box.list_folders()), 1)
585 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000586 self._box.remove_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000587 self.assertEqual(len(self._box.list_folders()), 0)
588 self.assertEqual(self._box.list_folders(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000589
590 def test_clean(self):
591 # Remove old files from 'tmp'
592 foo_path = os.path.join(self._path, 'tmp', 'foo')
593 bar_path = os.path.join(self._path, 'tmp', 'bar')
594 f = open(foo_path, 'w')
595 f.write("@")
596 f.close()
597 f = open(bar_path, 'w')
598 f.write("@")
599 f.close()
600 self._box.clean()
601 self.assert_(os.path.exists(foo_path))
602 self.assert_(os.path.exists(bar_path))
603 foo_stat = os.stat(foo_path)
604 os.utime(foo_path, (time.time() - 129600 - 2,
605 foo_stat.st_mtime))
606 self._box.clean()
607 self.assert_(not os.path.exists(foo_path))
608 self.assert_(os.path.exists(bar_path))
609
610 def test_create_tmp(self, repetitions=10):
611 # Create files in tmp directory
612 hostname = socket.gethostname()
613 if '/' in hostname:
614 hostname = hostname.replace('/', r'\057')
615 if ':' in hostname:
616 hostname = hostname.replace(':', r'\072')
617 pid = os.getpid()
618 pattern = re.compile(r"(?P<time>\d+)\.M(?P<M>\d{1,6})P(?P<P>\d+)"
619 r"Q(?P<Q>\d+)\.(?P<host>[^:/]+)")
620 previous_groups = None
Guido van Rossum805365e2007-05-07 22:24:25 +0000621 for x in range(repetitions):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000622 tmp_file = self._box._create_tmp()
623 head, tail = os.path.split(tmp_file.name)
624 self.assertEqual(head, os.path.abspath(os.path.join(self._path,
625 "tmp")),
626 "File in wrong location: '%s'" % head)
627 match = pattern.match(tail)
628 self.assert_(match != None, "Invalid file name: '%s'" % tail)
629 groups = match.groups()
630 if previous_groups != None:
631 self.assert_(int(groups[0] >= previous_groups[0]),
632 "Non-monotonic seconds: '%s' before '%s'" %
633 (previous_groups[0], groups[0]))
634 self.assert_(int(groups[1] >= previous_groups[1]) or
635 groups[0] != groups[1],
636 "Non-monotonic milliseconds: '%s' before '%s'" %
637 (previous_groups[1], groups[1]))
Guido van Rossumea834472007-07-27 05:17:50 +0000638 self.assertEqual(int(groups[2]), pid,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000639 "Process ID mismatch: '%s' should be '%s'" %
640 (groups[2], pid))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000641 self.assertEqual(int(groups[3]), int(previous_groups[3]) + 1,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000642 "Non-sequential counter: '%s' before '%s'" %
643 (previous_groups[3], groups[3]))
Guido van Rossumea834472007-07-27 05:17:50 +0000644 self.assertEqual(groups[4], hostname,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000645 "Host name mismatch: '%s' should be '%s'" %
646 (groups[4], hostname))
647 previous_groups = groups
648 tmp_file.write(_sample_message)
649 tmp_file.seek(0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000650 self.assertEqual(tmp_file.read(), _sample_message)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000651 tmp_file.close()
652 file_count = len(os.listdir(os.path.join(self._path, "tmp")))
Guido van Rossumea834472007-07-27 05:17:50 +0000653 self.assertEqual(file_count, repetitions,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000654 "Wrong file count: '%s' should be '%s'" %
655 (file_count, repetitions))
656
657 def test_refresh(self):
658 # Update the table of contents
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000659 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000660 key0 = self._box.add(self._template % 0)
661 key1 = self._box.add(self._template % 1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000662 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000663 self._box._refresh()
Guido van Rossumea834472007-07-27 05:17:50 +0000664 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
665 key1: os.path.join('new', key1)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000666 key2 = self._box.add(self._template % 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000667 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
668 key1: os.path.join('new', key1)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000669 self._box._refresh()
Guido van Rossumea834472007-07-27 05:17:50 +0000670 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
671 key1: os.path.join('new', key1),
672 key2: os.path.join('new', key2)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000673
674 def test_lookup(self):
675 # Look up message subpaths in the TOC
676 self.assertRaises(KeyError, lambda: self._box._lookup('foo'))
677 key0 = self._box.add(self._template % 0)
Guido van Rossumea834472007-07-27 05:17:50 +0000678 self.assertEqual(self._box._lookup(key0), os.path.join('new', key0))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000679 os.remove(os.path.join(self._path, 'new', key0))
Guido van Rossumea834472007-07-27 05:17:50 +0000680 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000681 self.assertRaises(KeyError, lambda: self._box._lookup(key0))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000682 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000683
684 def test_lock_unlock(self):
685 # Lock and unlock the mailbox. For Maildir, this does nothing.
686 self._box.lock()
687 self._box.unlock()
688
Thomas Wouters89f507f2006-12-13 04:49:30 +0000689 def test_folder (self):
690 # Test for bug #1569790: verify that folders returned by .get_folder()
691 # use the same factory function.
692 def dummy_factory (s):
693 return None
694 box = self._factory(self._path, factory=dummy_factory)
695 folder = box.add_folder('folder1')
696 self.assert_(folder._factory is dummy_factory)
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000697
Thomas Wouters89f507f2006-12-13 04:49:30 +0000698 folder1_alias = box.get_folder('folder1')
699 self.assert_(folder1_alias._factory is dummy_factory)
700
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000701 def test_directory_in_folder (self):
702 # Test that mailboxes still work if there's a stray extra directory
703 # in a folder.
704 for i in range(10):
705 self._box.add(mailbox.Message(_sample_message))
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000706
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000707 # Create a stray directory
708 os.mkdir(os.path.join(self._path, 'cur', 'stray-dir'))
709
710 # Check that looping still works with the directory present.
711 for msg in self._box:
712 pass
Thomas Wouters477c8d52006-05-27 19:21:47 +0000713
714class _TestMboxMMDF(TestMailbox):
715
716 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +0000717 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000718 self._delete_recursively(self._path)
719 for lock_remnant in glob.glob(self._path + '.*'):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000720 test_support.unlink(lock_remnant)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000721
722 def test_add_from_string(self):
723 # Add a string starting with 'From ' to the mailbox
724 key = self._box.add('From foo@bar blah\nFrom: foo\n\n0')
Guido van Rossumea834472007-07-27 05:17:50 +0000725 self.assertEqual(self._box[key].get_from(), 'foo@bar blah')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000726 self.assertEqual(self._box[key].get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000727
728 def test_add_mbox_or_mmdf_message(self):
729 # Add an mboxMessage or MMDFMessage
730 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
731 msg = class_('From foo@bar blah\nFrom: foo\n\n0')
732 key = self._box.add(msg)
733
734 def test_open_close_open(self):
735 # Open and inspect previously-created mailbox
Guido van Rossum805365e2007-05-07 22:24:25 +0000736 values = [self._template % i for i in range(3)]
Thomas Wouters477c8d52006-05-27 19:21:47 +0000737 for value in values:
738 self._box.add(value)
739 self._box.close()
740 mtime = os.path.getmtime(self._path)
741 self._box = self._factory(self._path)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000742 self.assertEqual(len(self._box), 3)
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000743 for key in self._box.keys():
Thomas Wouters477c8d52006-05-27 19:21:47 +0000744 self.assert_(self._box.get_string(key) in values)
745 self._box.close()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000746 self.assertEqual(mtime, os.path.getmtime(self._path))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000747
748 def test_add_and_close(self):
749 # Verifying that closing a mailbox doesn't change added items
750 self._box.add(_sample_message)
Guido van Rossum805365e2007-05-07 22:24:25 +0000751 for i in range(3):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000752 self._box.add(self._template % i)
753 self._box.add(_sample_message)
754 self._box._file.flush()
755 self._box._file.seek(0)
756 contents = self._box._file.read()
757 self._box.close()
Guido van Rossumea834472007-07-27 05:17:50 +0000758 self.assertEqual(contents, open(self._path, 'r').read())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000759 self._box = self._factory(self._path)
760
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000761 def test_lock_conflict(self):
762 # Fork off a subprocess that will lock the file for 2 seconds,
763 # unlock it, and then exit.
764 if not hasattr(os, 'fork'):
765 return
766 pid = os.fork()
767 if pid == 0:
768 # In the child, lock the mailbox.
Guido van Rossum62cbc8a2007-04-09 00:41:25 +0000769 try:
770 self._box.lock()
771 time.sleep(2)
772 self._box.unlock()
773 finally:
774 os._exit(0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000775
776 # In the parent, sleep a bit to give the child time to acquire
777 # the lock.
778 time.sleep(0.5)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000779 try:
780 self.assertRaises(mailbox.ExternalClashError,
781 self._box.lock)
782 finally:
783 # Wait for child to exit. Locking should now succeed.
784 exited_pid, status = os.waitpid(pid, 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000785
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000786 self._box.lock()
787 self._box.unlock()
788
Thomas Wouters89f507f2006-12-13 04:49:30 +0000789 def test_relock(self):
790 # Test case for bug #1575506: the mailbox class was locking the
791 # wrong file object in its flush() method.
792 msg = "Subject: sub\n\nbody\n"
793 key1 = self._box.add(msg)
794 self._box.flush()
795 self._box.close()
796
797 self._box = self._factory(self._path)
798 self._box.lock()
799 key2 = self._box.add(msg)
800 self._box.flush()
801 self.assert_(self._box._locked)
802 self._box.close()
803
804
Thomas Wouters477c8d52006-05-27 19:21:47 +0000805
806class TestMbox(_TestMboxMMDF):
807
808 _factory = lambda self, path, factory=None: mailbox.mbox(path, factory)
809
810
811class TestMMDF(_TestMboxMMDF):
812
813 _factory = lambda self, path, factory=None: mailbox.MMDF(path, factory)
814
815
816class TestMH(TestMailbox):
817
818 _factory = lambda self, path, factory=None: mailbox.MH(path, factory)
819
820 def test_list_folders(self):
821 # List folders
822 self._box.add_folder('one')
823 self._box.add_folder('two')
824 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000825 self.assertEqual(len(self._box.list_folders()), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000826 self.assertEqual(set(self._box.list_folders()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000827 set(('one', 'two', 'three')))
828
829 def test_get_folder(self):
830 # Open folders
Thomas Wouters89f507f2006-12-13 04:49:30 +0000831 def dummy_factory (s):
832 return None
833 self._box = self._factory(self._path, dummy_factory)
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000834
Thomas Wouters89f507f2006-12-13 04:49:30 +0000835 new_folder = self._box.add_folder('foo.bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000836 folder0 = self._box.get_folder('foo.bar')
837 folder0.add(self._template % 'bar')
838 self.assert_(os.path.isdir(os.path.join(self._path, 'foo.bar')))
839 folder1 = self._box.get_folder('foo.bar')
Guido van Rossumea834472007-07-27 05:17:50 +0000840 self.assertEqual(folder1.get_string(folder1.keys()[0]),
841 self._template % 'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000842
Thomas Wouters89f507f2006-12-13 04:49:30 +0000843 # Test for bug #1569790: verify that folders returned by .get_folder()
844 # use the same factory function.
845 self.assert_(new_folder._factory is self._box._factory)
846 self.assert_(folder0._factory is self._box._factory)
847
Thomas Wouters477c8d52006-05-27 19:21:47 +0000848 def test_add_and_remove_folders(self):
849 # Delete folders
850 self._box.add_folder('one')
851 self._box.add_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000852 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000853 self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000854 self._box.remove_folder('one')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000855 self.assertEqual(len(self._box.list_folders()), 1)
856 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000857 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000858 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000859 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000860 self._box.remove_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000861 self.assertEqual(len(self._box.list_folders()), 1)
862 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000863 self._box.remove_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000864 self.assertEqual(len(self._box.list_folders()), 0)
865 self.assertEqual(self._box.list_folders(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000866
867 def test_sequences(self):
868 # Get and set sequences
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000869 self.assertEqual(self._box.get_sequences(), {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000870 msg0 = mailbox.MHMessage(self._template % 0)
871 msg0.add_sequence('foo')
872 key0 = self._box.add(msg0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000873 self.assertEqual(self._box.get_sequences(), {'foo':[key0]})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000874 msg1 = mailbox.MHMessage(self._template % 1)
875 msg1.set_sequences(['bar', 'replied', 'foo'])
876 key1 = self._box.add(msg1)
Guido van Rossumea834472007-07-27 05:17:50 +0000877 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000878 {'foo':[key0, key1], 'bar':[key1], 'replied':[key1]})
879 msg0.set_sequences(['flagged'])
880 self._box[key0] = msg0
Guido van Rossumea834472007-07-27 05:17:50 +0000881 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000882 {'foo':[key1], 'bar':[key1], 'replied':[key1],
883 'flagged':[key0]})
884 self._box.remove(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000885 self.assertEqual(self._box.get_sequences(), {'flagged':[key0]})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000886
887 def test_pack(self):
888 # Pack the contents of the mailbox
889 msg0 = mailbox.MHMessage(self._template % 0)
890 msg1 = mailbox.MHMessage(self._template % 1)
891 msg2 = mailbox.MHMessage(self._template % 2)
892 msg3 = mailbox.MHMessage(self._template % 3)
893 msg0.set_sequences(['foo', 'unseen'])
894 msg1.set_sequences(['foo'])
895 msg2.set_sequences(['foo', 'flagged'])
896 msg3.set_sequences(['foo', 'bar', 'replied'])
897 key0 = self._box.add(msg0)
898 key1 = self._box.add(msg1)
899 key2 = self._box.add(msg2)
900 key3 = self._box.add(msg3)
Guido van Rossumea834472007-07-27 05:17:50 +0000901 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000902 {'foo':[key0,key1,key2,key3], 'unseen':[key0],
903 'flagged':[key2], 'bar':[key3], 'replied':[key3]})
904 self._box.remove(key2)
Guido van Rossumea834472007-07-27 05:17:50 +0000905 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000906 {'foo':[key0,key1,key3], 'unseen':[key0], 'bar':[key3],
907 'replied':[key3]})
908 self._box.pack()
909 self.assert_(self._box.keys() == [1, 2, 3])
910 key0 = key0
911 key1 = key0 + 1
912 key2 = key1 + 1
Guido van Rossumea834472007-07-27 05:17:50 +0000913 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000914 {'foo':[1, 2, 3], 'unseen':[1], 'bar':[3], 'replied':[3]})
915
Thomas Wouters89f507f2006-12-13 04:49:30 +0000916 # Test case for packing while holding the mailbox locked.
917 key0 = self._box.add(msg1)
918 key1 = self._box.add(msg1)
919 key2 = self._box.add(msg1)
920 key3 = self._box.add(msg1)
921
922 self._box.remove(key0)
923 self._box.remove(key2)
924 self._box.lock()
925 self._box.pack()
926 self._box.unlock()
Guido van Rossumea834472007-07-27 05:17:50 +0000927 self.assertEqual(self._box.get_sequences(),
Thomas Wouters89f507f2006-12-13 04:49:30 +0000928 {'foo':[1, 2, 3, 4, 5],
929 'unseen':[1], 'bar':[3], 'replied':[3]})
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000930
Thomas Wouters477c8d52006-05-27 19:21:47 +0000931 def _get_lock_path(self):
932 return os.path.join(self._path, '.mh_sequences.lock')
933
934
935class TestBabyl(TestMailbox):
936
937 _factory = lambda self, path, factory=None: mailbox.Babyl(path, factory)
938
939 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +0000940 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000941 self._delete_recursively(self._path)
942 for lock_remnant in glob.glob(self._path + '.*'):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000943 test_support.unlink(lock_remnant)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000944
945 def test_labels(self):
946 # Get labels from the mailbox
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000947 self.assertEqual(self._box.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000948 msg0 = mailbox.BabylMessage(self._template % 0)
949 msg0.add_label('foo')
950 key0 = self._box.add(msg0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000951 self.assertEqual(self._box.get_labels(), ['foo'])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000952 msg1 = mailbox.BabylMessage(self._template % 1)
953 msg1.set_labels(['bar', 'answered', 'foo'])
954 key1 = self._box.add(msg1)
Guido van Rossumea834472007-07-27 05:17:50 +0000955 self.assertEqual(set(self._box.get_labels()), set(['foo', 'bar']))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000956 msg0.set_labels(['blah', 'filed'])
957 self._box[key0] = msg0
Guido van Rossumea834472007-07-27 05:17:50 +0000958 self.assertEqual(set(self._box.get_labels()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000959 set(['foo', 'bar', 'blah']))
960 self._box.remove(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000961 self.assertEqual(set(self._box.get_labels()), set(['blah']))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000962
963
964class TestMessage(TestBase):
965
966 _factory = mailbox.Message # Overridden by subclasses to reuse tests
967
968 def setUp(self):
969 self._path = test_support.TESTFN
970
971 def tearDown(self):
972 self._delete_recursively(self._path)
973
974 def test_initialize_with_eMM(self):
Thomas Woutersb2137042007-02-01 18:02:27 +0000975 # Initialize based on email.message.Message instance
Thomas Wouters477c8d52006-05-27 19:21:47 +0000976 eMM = email.message_from_string(_sample_message)
977 msg = self._factory(eMM)
978 self._post_initialize_hook(msg)
979 self._check_sample(msg)
980
981 def test_initialize_with_string(self):
982 # Initialize based on string
983 msg = self._factory(_sample_message)
984 self._post_initialize_hook(msg)
985 self._check_sample(msg)
986
987 def test_initialize_with_file(self):
988 # Initialize based on contents of file
989 f = open(self._path, 'w+')
990 f.write(_sample_message)
991 f.seek(0)
992 msg = self._factory(f)
993 self._post_initialize_hook(msg)
994 self._check_sample(msg)
995 f.close()
996
997 def test_initialize_with_nothing(self):
998 # Initialize without arguments
999 msg = self._factory()
1000 self._post_initialize_hook(msg)
Thomas Woutersb2137042007-02-01 18:02:27 +00001001 self.assert_(isinstance(msg, email.message.Message))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001002 self.assert_(isinstance(msg, mailbox.Message))
1003 self.assert_(isinstance(msg, self._factory))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001004 self.assertEqual(msg.keys(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001005 self.assert_(not msg.is_multipart())
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001006 self.assertEqual(msg.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001007
1008 def test_initialize_incorrectly(self):
1009 # Initialize with invalid argument
1010 self.assertRaises(TypeError, lambda: self._factory(object()))
1011
1012 def test_become_message(self):
1013 # Take on the state of another message
1014 eMM = email.message_from_string(_sample_message)
1015 msg = self._factory()
1016 msg._become_message(eMM)
1017 self._check_sample(msg)
1018
1019 def test_explain_to(self):
1020 # Copy self's format-specific data to other message formats.
1021 # This test is superficial; better ones are in TestMessageConversion.
1022 msg = self._factory()
1023 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1024 mailbox.mboxMessage, mailbox.MHMessage,
1025 mailbox.BabylMessage, mailbox.MMDFMessage):
1026 other_msg = class_()
1027 msg._explain_to(other_msg)
Thomas Woutersb2137042007-02-01 18:02:27 +00001028 other_msg = email.message.Message()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001029 self.assertRaises(TypeError, lambda: msg._explain_to(other_msg))
1030
1031 def _post_initialize_hook(self, msg):
1032 # Overridden by subclasses to check extra things after initialization
1033 pass
1034
1035
1036class TestMaildirMessage(TestMessage):
1037
1038 _factory = mailbox.MaildirMessage
1039
1040 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001041 self.assertEqual(msg._subdir, 'new')
1042 self.assertEqual(msg._info, '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001043
1044 def test_subdir(self):
1045 # Use get_subdir() and set_subdir()
1046 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001047 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001048 msg.set_subdir('cur')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001049 self.assertEqual(msg.get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001050 msg.set_subdir('new')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001051 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001052 self.assertRaises(ValueError, lambda: msg.set_subdir('tmp'))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001053 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001054 msg.set_subdir('new')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001055 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001056 self._check_sample(msg)
1057
1058 def test_flags(self):
1059 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1060 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001061 self.assertEqual(msg.get_flags(), '')
1062 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001063 msg.set_flags('F')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001064 self.assertEqual(msg.get_subdir(), 'new')
1065 self.assertEqual(msg.get_flags(), 'F')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001066 msg.set_flags('SDTP')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001067 self.assertEqual(msg.get_flags(), 'DPST')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001068 msg.add_flag('FT')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001069 self.assertEqual(msg.get_flags(), 'DFPST')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001070 msg.remove_flag('TDRP')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001071 self.assertEqual(msg.get_flags(), 'FS')
1072 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001073 self._check_sample(msg)
1074
1075 def test_date(self):
1076 # Use get_date() and set_date()
1077 msg = mailbox.MaildirMessage(_sample_message)
1078 self.assert_(abs(msg.get_date() - time.time()) < 60)
1079 msg.set_date(0.0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001080 self.assertEqual(msg.get_date(), 0.0)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001081
1082 def test_info(self):
1083 # Use get_info() and set_info()
1084 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001085 self.assertEqual(msg.get_info(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001086 msg.set_info('1,foo=bar')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001087 self.assertEqual(msg.get_info(), '1,foo=bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001088 self.assertRaises(TypeError, lambda: msg.set_info(None))
1089 self._check_sample(msg)
1090
1091 def test_info_and_flags(self):
1092 # Test interaction of info and flag methods
1093 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001094 self.assertEqual(msg.get_info(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001095 msg.set_flags('SF')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001096 self.assertEqual(msg.get_flags(), 'FS')
1097 self.assertEqual(msg.get_info(), '2,FS')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001098 msg.set_info('1,')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001099 self.assertEqual(msg.get_flags(), '')
1100 self.assertEqual(msg.get_info(), '1,')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001101 msg.remove_flag('RPT')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001102 self.assertEqual(msg.get_flags(), '')
1103 self.assertEqual(msg.get_info(), '1,')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001104 msg.add_flag('D')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001105 self.assertEqual(msg.get_flags(), 'D')
1106 self.assertEqual(msg.get_info(), '2,D')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001107 self._check_sample(msg)
1108
1109
1110class _TestMboxMMDFMessage(TestMessage):
1111
1112 _factory = mailbox._mboxMMDFMessage
1113
1114 def _post_initialize_hook(self, msg):
1115 self._check_from(msg)
1116
1117 def test_initialize_with_unixfrom(self):
1118 # Initialize with a message that already has a _unixfrom attribute
1119 msg = mailbox.Message(_sample_message)
1120 msg.set_unixfrom('From foo@bar blah')
1121 msg = mailbox.mboxMessage(msg)
Guido van Rossumea834472007-07-27 05:17:50 +00001122 self.assertEqual(msg.get_from(), 'foo@bar blah', msg.get_from())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001123
1124 def test_from(self):
1125 # Get and set "From " line
1126 msg = mailbox.mboxMessage(_sample_message)
1127 self._check_from(msg)
1128 msg.set_from('foo bar')
Guido van Rossumea834472007-07-27 05:17:50 +00001129 self.assertEqual(msg.get_from(), 'foo bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001130 msg.set_from('foo@bar', True)
1131 self._check_from(msg, 'foo@bar')
1132 msg.set_from('blah@temp', time.localtime())
1133 self._check_from(msg, 'blah@temp')
1134
1135 def test_flags(self):
1136 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1137 msg = mailbox.mboxMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001138 self.assertEqual(msg.get_flags(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001139 msg.set_flags('F')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001140 self.assertEqual(msg.get_flags(), 'F')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001141 msg.set_flags('XODR')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001142 self.assertEqual(msg.get_flags(), 'RODX')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001143 msg.add_flag('FA')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001144 self.assertEqual(msg.get_flags(), 'RODFAX')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001145 msg.remove_flag('FDXA')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001146 self.assertEqual(msg.get_flags(), 'RO')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001147 self._check_sample(msg)
1148
1149 def _check_from(self, msg, sender=None):
1150 # Check contents of "From " line
1151 if sender is None:
1152 sender = "MAILER-DAEMON"
1153 self.assert_(re.match(sender + r" \w{3} \w{3} [\d ]\d [\d ]\d:\d{2}:"
1154 r"\d{2} \d{4}", msg.get_from()) is not None)
1155
1156
1157class TestMboxMessage(_TestMboxMMDFMessage):
1158
1159 _factory = mailbox.mboxMessage
1160
1161
1162class TestMHMessage(TestMessage):
1163
1164 _factory = mailbox.MHMessage
1165
1166 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001167 self.assertEqual(msg._sequences, [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001168
1169 def test_sequences(self):
1170 # Get, set, join, and leave sequences
1171 msg = mailbox.MHMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001172 self.assertEqual(msg.get_sequences(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001173 msg.set_sequences(['foobar'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001174 self.assertEqual(msg.get_sequences(), ['foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001175 msg.set_sequences([])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001176 self.assertEqual(msg.get_sequences(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001177 msg.add_sequence('unseen')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001178 self.assertEqual(msg.get_sequences(), ['unseen'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001179 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001180 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001181 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001182 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001183 msg.remove_sequence('unseen')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001184 self.assertEqual(msg.get_sequences(), ['flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001185 msg.add_sequence('foobar')
Guido van Rossumea834472007-07-27 05:17:50 +00001186 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001187 msg.remove_sequence('replied')
Guido van Rossumea834472007-07-27 05:17:50 +00001188 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001189 msg.set_sequences(['foobar', 'replied'])
Guido van Rossumea834472007-07-27 05:17:50 +00001190 self.assertEqual(msg.get_sequences(), ['foobar', 'replied'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001191
1192
1193class TestBabylMessage(TestMessage):
1194
1195 _factory = mailbox.BabylMessage
1196
1197 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001198 self.assertEqual(msg._labels, [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001199
1200 def test_labels(self):
1201 # Get, set, join, and leave labels
1202 msg = mailbox.BabylMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001203 self.assertEqual(msg.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001204 msg.set_labels(['foobar'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001205 self.assertEqual(msg.get_labels(), ['foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001206 msg.set_labels([])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001207 self.assertEqual(msg.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001208 msg.add_label('filed')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001209 self.assertEqual(msg.get_labels(), ['filed'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001210 msg.add_label('resent')
Guido van Rossumea834472007-07-27 05:17:50 +00001211 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001212 msg.add_label('resent')
Guido van Rossumea834472007-07-27 05:17:50 +00001213 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001214 msg.remove_label('filed')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001215 self.assertEqual(msg.get_labels(), ['resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001216 msg.add_label('foobar')
Guido van Rossumea834472007-07-27 05:17:50 +00001217 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001218 msg.remove_label('unseen')
Guido van Rossumea834472007-07-27 05:17:50 +00001219 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001220 msg.set_labels(['foobar', 'answered'])
Guido van Rossumea834472007-07-27 05:17:50 +00001221 self.assertEqual(msg.get_labels(), ['foobar', 'answered'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001222
1223 def test_visible(self):
1224 # Get, set, and update visible headers
1225 msg = mailbox.BabylMessage(_sample_message)
1226 visible = msg.get_visible()
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001227 self.assertEqual(visible.keys(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001228 self.assert_(visible.get_payload() is None)
1229 visible['User-Agent'] = 'FooBar 1.0'
1230 visible['X-Whatever'] = 'Blah'
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001231 self.assertEqual(msg.get_visible().keys(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001232 msg.set_visible(visible)
1233 visible = msg.get_visible()
1234 self.assert_(visible.keys() == ['User-Agent', 'X-Whatever'])
1235 self.assert_(visible['User-Agent'] == 'FooBar 1.0')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001236 self.assertEqual(visible['X-Whatever'], 'Blah')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001237 self.assert_(visible.get_payload() is None)
1238 msg.update_visible()
Guido van Rossumea834472007-07-27 05:17:50 +00001239 self.assertEqual(visible.keys(), ['User-Agent', 'X-Whatever'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001240 self.assert_(visible.get_payload() is None)
1241 visible = msg.get_visible()
Guido van Rossumea834472007-07-27 05:17:50 +00001242 self.assertEqual(visible.keys(), ['User-Agent', 'Date', 'From', 'To',
1243 'Subject'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001244 for header in ('User-Agent', 'Date', 'From', 'To', 'Subject'):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001245 self.assertEqual(visible[header], msg[header])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001246
1247
1248class TestMMDFMessage(_TestMboxMMDFMessage):
1249
1250 _factory = mailbox.MMDFMessage
1251
1252
1253class TestMessageConversion(TestBase):
1254
1255 def test_plain_to_x(self):
1256 # Convert Message to all formats
1257 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1258 mailbox.mboxMessage, mailbox.MHMessage,
1259 mailbox.BabylMessage, mailbox.MMDFMessage):
1260 msg_plain = mailbox.Message(_sample_message)
1261 msg = class_(msg_plain)
1262 self._check_sample(msg)
1263
1264 def test_x_to_plain(self):
1265 # Convert all formats to Message
1266 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1267 mailbox.mboxMessage, mailbox.MHMessage,
1268 mailbox.BabylMessage, mailbox.MMDFMessage):
1269 msg = class_(_sample_message)
1270 msg_plain = mailbox.Message(msg)
1271 self._check_sample(msg_plain)
1272
1273 def test_x_to_invalid(self):
1274 # Convert all formats to an invalid format
1275 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1276 mailbox.mboxMessage, mailbox.MHMessage,
1277 mailbox.BabylMessage, mailbox.MMDFMessage):
1278 self.assertRaises(TypeError, lambda: class_(False))
1279
1280 def test_maildir_to_maildir(self):
1281 # Convert MaildirMessage to MaildirMessage
1282 msg_maildir = mailbox.MaildirMessage(_sample_message)
1283 msg_maildir.set_flags('DFPRST')
1284 msg_maildir.set_subdir('cur')
1285 date = msg_maildir.get_date()
1286 msg = mailbox.MaildirMessage(msg_maildir)
1287 self._check_sample(msg)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001288 self.assertEqual(msg.get_flags(), 'DFPRST')
1289 self.assertEqual(msg.get_subdir(), 'cur')
1290 self.assertEqual(msg.get_date(), date)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001291
1292 def test_maildir_to_mboxmmdf(self):
1293 # Convert MaildirMessage to mboxmessage and MMDFMessage
1294 pairs = (('D', ''), ('F', 'F'), ('P', ''), ('R', 'A'), ('S', 'R'),
1295 ('T', 'D'), ('DFPRST', 'RDFA'))
1296 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1297 msg_maildir = mailbox.MaildirMessage(_sample_message)
1298 msg_maildir.set_date(0.0)
1299 for setting, result in pairs:
1300 msg_maildir.set_flags(setting)
1301 msg = class_(msg_maildir)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001302 self.assertEqual(msg.get_flags(), result)
Guido van Rossumea834472007-07-27 05:17:50 +00001303 self.assertEqual(msg.get_from(), 'MAILER-DAEMON %s' %
Thomas Wouters477c8d52006-05-27 19:21:47 +00001304 time.asctime(time.gmtime(0.0)))
1305 msg_maildir.set_subdir('cur')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001306 self.assertEqual(class_(msg_maildir).get_flags(), 'RODFA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001307
1308 def test_maildir_to_mh(self):
1309 # Convert MaildirMessage to MHMessage
1310 msg_maildir = mailbox.MaildirMessage(_sample_message)
1311 pairs = (('D', ['unseen']), ('F', ['unseen', 'flagged']),
1312 ('P', ['unseen']), ('R', ['unseen', 'replied']), ('S', []),
1313 ('T', ['unseen']), ('DFPRST', ['replied', 'flagged']))
1314 for setting, result in pairs:
1315 msg_maildir.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001316 self.assertEqual(mailbox.MHMessage(msg_maildir).get_sequences(),
1317 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001318
1319 def test_maildir_to_babyl(self):
1320 # Convert MaildirMessage to Babyl
1321 msg_maildir = mailbox.MaildirMessage(_sample_message)
1322 pairs = (('D', ['unseen']), ('F', ['unseen']),
1323 ('P', ['unseen', 'forwarded']), ('R', ['unseen', 'answered']),
1324 ('S', []), ('T', ['unseen', 'deleted']),
1325 ('DFPRST', ['deleted', 'answered', 'forwarded']))
1326 for setting, result in pairs:
1327 msg_maildir.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001328 self.assertEqual(mailbox.BabylMessage(msg_maildir).get_labels(),
1329 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001330
1331 def test_mboxmmdf_to_maildir(self):
1332 # Convert mboxMessage and MMDFMessage to MaildirMessage
1333 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1334 msg_mboxMMDF = class_(_sample_message)
1335 msg_mboxMMDF.set_from('foo@bar', time.gmtime(0.0))
1336 pairs = (('R', 'S'), ('O', ''), ('D', 'T'), ('F', 'F'), ('A', 'R'),
1337 ('RODFA', 'FRST'))
1338 for setting, result in pairs:
1339 msg_mboxMMDF.set_flags(setting)
1340 msg = mailbox.MaildirMessage(msg_mboxMMDF)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001341 self.assertEqual(msg.get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001342 self.assert_(msg.get_date() == 0.0, msg.get_date())
1343 msg_mboxMMDF.set_flags('O')
Guido van Rossumea834472007-07-27 05:17:50 +00001344 self.assertEqual(mailbox.MaildirMessage(msg_mboxMMDF).get_subdir(),
1345 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001346
1347 def test_mboxmmdf_to_mboxmmdf(self):
1348 # Convert mboxMessage and MMDFMessage to mboxMessage and MMDFMessage
1349 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1350 msg_mboxMMDF = class_(_sample_message)
1351 msg_mboxMMDF.set_flags('RODFA')
1352 msg_mboxMMDF.set_from('foo@bar')
1353 for class2_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1354 msg2 = class2_(msg_mboxMMDF)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001355 self.assertEqual(msg2.get_flags(), 'RODFA')
1356 self.assertEqual(msg2.get_from(), 'foo@bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001357
1358 def test_mboxmmdf_to_mh(self):
1359 # Convert mboxMessage and MMDFMessage to MHMessage
1360 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1361 msg_mboxMMDF = class_(_sample_message)
1362 pairs = (('R', []), ('O', ['unseen']), ('D', ['unseen']),
1363 ('F', ['unseen', 'flagged']),
1364 ('A', ['unseen', 'replied']),
1365 ('RODFA', ['replied', 'flagged']))
1366 for setting, result in pairs:
1367 msg_mboxMMDF.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001368 self.assertEqual(mailbox.MHMessage(msg_mboxMMDF).get_sequences(),
1369 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001370
1371 def test_mboxmmdf_to_babyl(self):
1372 # Convert mboxMessage and MMDFMessage to BabylMessage
1373 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1374 msg = class_(_sample_message)
1375 pairs = (('R', []), ('O', ['unseen']),
1376 ('D', ['unseen', 'deleted']), ('F', ['unseen']),
1377 ('A', ['unseen', 'answered']),
1378 ('RODFA', ['deleted', 'answered']))
1379 for setting, result in pairs:
1380 msg.set_flags(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001381 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001382
1383 def test_mh_to_maildir(self):
1384 # Convert MHMessage to MaildirMessage
1385 pairs = (('unseen', ''), ('replied', 'RS'), ('flagged', 'FS'))
1386 for setting, result in pairs:
1387 msg = mailbox.MHMessage(_sample_message)
1388 msg.add_sequence(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001389 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1390 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001391 msg = mailbox.MHMessage(_sample_message)
1392 msg.add_sequence('unseen')
1393 msg.add_sequence('replied')
1394 msg.add_sequence('flagged')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001395 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'FR')
1396 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001397
1398 def test_mh_to_mboxmmdf(self):
1399 # Convert MHMessage to mboxMessage and MMDFMessage
1400 pairs = (('unseen', 'O'), ('replied', 'ROA'), ('flagged', 'ROF'))
1401 for setting, result in pairs:
1402 msg = mailbox.MHMessage(_sample_message)
1403 msg.add_sequence(setting)
1404 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001405 self.assertEqual(class_(msg).get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001406 msg = mailbox.MHMessage(_sample_message)
1407 msg.add_sequence('unseen')
1408 msg.add_sequence('replied')
1409 msg.add_sequence('flagged')
1410 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001411 self.assertEqual(class_(msg).get_flags(), 'OFA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001412
1413 def test_mh_to_mh(self):
1414 # Convert MHMessage to MHMessage
1415 msg = mailbox.MHMessage(_sample_message)
1416 msg.add_sequence('unseen')
1417 msg.add_sequence('replied')
1418 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001419 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1420 ['unseen', 'replied', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001421
1422 def test_mh_to_babyl(self):
1423 # Convert MHMessage to BabylMessage
1424 pairs = (('unseen', ['unseen']), ('replied', ['answered']),
1425 ('flagged', []))
1426 for setting, result in pairs:
1427 msg = mailbox.MHMessage(_sample_message)
1428 msg.add_sequence(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001429 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001430 msg = mailbox.MHMessage(_sample_message)
1431 msg.add_sequence('unseen')
1432 msg.add_sequence('replied')
1433 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001434 self.assertEqual(mailbox.BabylMessage(msg).get_labels(),
1435 ['unseen', 'answered'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001436
1437 def test_babyl_to_maildir(self):
1438 # Convert BabylMessage to MaildirMessage
1439 pairs = (('unseen', ''), ('deleted', 'ST'), ('filed', 'S'),
1440 ('answered', 'RS'), ('forwarded', 'PS'), ('edited', 'S'),
1441 ('resent', 'PS'))
1442 for setting, result in pairs:
1443 msg = mailbox.BabylMessage(_sample_message)
1444 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001445 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1446 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001447 msg = mailbox.BabylMessage(_sample_message)
1448 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1449 'edited', 'resent'):
1450 msg.add_label(label)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001451 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'PRT')
1452 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001453
1454 def test_babyl_to_mboxmmdf(self):
1455 # Convert BabylMessage to mboxMessage and MMDFMessage
1456 pairs = (('unseen', 'O'), ('deleted', 'ROD'), ('filed', 'RO'),
1457 ('answered', 'ROA'), ('forwarded', 'RO'), ('edited', 'RO'),
1458 ('resent', 'RO'))
1459 for setting, result in pairs:
1460 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1461 msg = mailbox.BabylMessage(_sample_message)
1462 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001463 self.assertEqual(class_(msg).get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001464 msg = mailbox.BabylMessage(_sample_message)
1465 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1466 'edited', 'resent'):
1467 msg.add_label(label)
1468 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001469 self.assertEqual(class_(msg).get_flags(), 'ODA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001470
1471 def test_babyl_to_mh(self):
1472 # Convert BabylMessage to MHMessage
1473 pairs = (('unseen', ['unseen']), ('deleted', []), ('filed', []),
1474 ('answered', ['replied']), ('forwarded', []), ('edited', []),
1475 ('resent', []))
1476 for setting, result in pairs:
1477 msg = mailbox.BabylMessage(_sample_message)
1478 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001479 self.assertEqual(mailbox.MHMessage(msg).get_sequences(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001480 msg = mailbox.BabylMessage(_sample_message)
1481 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1482 'edited', 'resent'):
1483 msg.add_label(label)
Guido van Rossumea834472007-07-27 05:17:50 +00001484 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1485 ['unseen', 'replied'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001486
1487 def test_babyl_to_babyl(self):
1488 # Convert BabylMessage to BabylMessage
1489 msg = mailbox.BabylMessage(_sample_message)
1490 msg.update_visible()
1491 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1492 'edited', 'resent'):
1493 msg.add_label(label)
1494 msg2 = mailbox.BabylMessage(msg)
Guido van Rossumea834472007-07-27 05:17:50 +00001495 self.assertEqual(msg2.get_labels(), ['unseen', 'deleted', 'filed',
1496 'answered', 'forwarded', 'edited',
1497 'resent'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001498 self.assertEqual(msg.get_visible().keys(), msg2.get_visible().keys())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001499 for key in msg.get_visible().keys():
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001500 self.assertEqual(msg.get_visible()[key], msg2.get_visible()[key])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001501
1502
1503class TestProxyFileBase(TestBase):
1504
1505 def _test_read(self, proxy):
1506 # Read by byte
1507 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001508 self.assertEqual(proxy.read(), b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001509 proxy.seek(1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001510 self.assertEqual(proxy.read(), b'ar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001511 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001512 self.assertEqual(proxy.read(2), b'ba')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001513 proxy.seek(1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001514 self.assertEqual(proxy.read(-1), b'ar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001515 proxy.seek(2)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001516 self.assertEqual(proxy.read(1000), b'r')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001517
1518 def _test_readline(self, proxy):
1519 # Read by line
Guido van Rossum98297ee2007-11-06 21:34:58 +00001520 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001521 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001522 self.assertEqual(proxy.readline(), b'foo' + linesep)
1523 self.assertEqual(proxy.readline(), b'bar' + linesep)
1524 self.assertEqual(proxy.readline(), b'fred' + linesep)
1525 self.assertEqual(proxy.readline(), b'bob')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001526 proxy.seek(2)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001527 self.assertEqual(proxy.readline(), b'o' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001528 proxy.seek(6 + 2 * len(os.linesep))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001529 self.assertEqual(proxy.readline(), b'fred' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001530 proxy.seek(6 + 2 * len(os.linesep))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001531 self.assertEqual(proxy.readline(2), b'fr')
1532 self.assertEqual(proxy.readline(-10), b'ed' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001533
1534 def _test_readlines(self, proxy):
1535 # Read multiple lines
Guido van Rossum98297ee2007-11-06 21:34:58 +00001536 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001537 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001538 self.assertEqual(proxy.readlines(), [b'foo' + linesep,
1539 b'bar' + linesep,
1540 b'fred' + linesep, b'bob'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001541 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001542 self.assertEqual(proxy.readlines(2), [b'foo' + linesep])
1543 proxy.seek(3 + len(linesep))
1544 self.assertEqual(proxy.readlines(4 + len(linesep)),
1545 [b'bar' + linesep, b'fred' + linesep])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001546 proxy.seek(3)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001547 self.assertEqual(proxy.readlines(1000), [linesep, b'bar' + linesep,
1548 b'fred' + linesep, b'bob'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001549
1550 def _test_iteration(self, proxy):
1551 # Iterate by line
Guido van Rossum98297ee2007-11-06 21:34:58 +00001552 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001553 proxy.seek(0)
1554 iterator = iter(proxy)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001555 self.assertEqual(next(iterator), b'foo' + linesep)
1556 self.assertEqual(next(iterator), b'bar' + linesep)
1557 self.assertEqual(next(iterator), b'fred' + linesep)
1558 self.assertEqual(next(iterator), b'bob')
Georg Brandla18af4e2007-04-21 15:47:16 +00001559 self.assertRaises(StopIteration, next, iterator)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001560
1561 def _test_seek_and_tell(self, proxy):
1562 # Seek and use tell to check position
Guido van Rossum98297ee2007-11-06 21:34:58 +00001563 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001564 proxy.seek(3)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001565 self.assertEqual(proxy.tell(), 3)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001566 self.assertEqual(proxy.read(len(linesep)), linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001567 proxy.seek(2, 1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001568 self.assertEqual(proxy.read(1 + len(linesep)), b'r' + linesep)
1569 proxy.seek(-3 - len(linesep), 2)
1570 self.assertEqual(proxy.read(3), b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001571 proxy.seek(2, 0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001572 self.assertEqual(proxy.read(), b'o' + linesep + b'bar' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001573 proxy.seek(100)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001574 self.failIf(proxy.read())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001575
1576 def _test_close(self, proxy):
1577 # Close a file
1578 proxy.close()
1579 self.assertRaises(AttributeError, lambda: proxy.close())
1580
1581
1582class TestProxyFile(TestProxyFileBase):
1583
1584 def setUp(self):
1585 self._path = test_support.TESTFN
1586 self._file = open(self._path, 'wb+')
1587
1588 def tearDown(self):
1589 self._file.close()
1590 self._delete_recursively(self._path)
1591
1592 def test_initialize(self):
1593 # Initialize and check position
Neal Norwitz9a923102007-08-30 06:20:05 +00001594 self._file.write(b'foo')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001595 pos = self._file.tell()
1596 proxy0 = mailbox._ProxyFile(self._file)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001597 self.assertEqual(proxy0.tell(), pos)
1598 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001599 proxy1 = mailbox._ProxyFile(self._file, 0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001600 self.assertEqual(proxy1.tell(), 0)
1601 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001602
1603 def test_read(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001604 self._file.write(b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001605 self._test_read(mailbox._ProxyFile(self._file))
1606
1607 def test_readline(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001608 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1609 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001610 self._test_readline(mailbox._ProxyFile(self._file))
1611
1612 def test_readlines(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001613 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1614 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001615 self._test_readlines(mailbox._ProxyFile(self._file))
1616
1617 def test_iteration(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001618 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1619 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001620 self._test_iteration(mailbox._ProxyFile(self._file))
1621
1622 def test_seek_and_tell(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001623 self._file.write(bytes('foo%sbar%s' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001624 self._test_seek_and_tell(mailbox._ProxyFile(self._file))
1625
1626 def test_close(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001627 self._file.write(bytes('foo%sbar%s' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001628 self._test_close(mailbox._ProxyFile(self._file))
1629
1630
1631class TestPartialFile(TestProxyFileBase):
1632
1633 def setUp(self):
1634 self._path = test_support.TESTFN
1635 self._file = open(self._path, 'wb+')
1636
1637 def tearDown(self):
1638 self._file.close()
1639 self._delete_recursively(self._path)
1640
1641 def test_initialize(self):
1642 # Initialize and check position
Neal Norwitz9a923102007-08-30 06:20:05 +00001643 self._file.write(bytes('foo' + os.linesep + 'bar', 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001644 pos = self._file.tell()
1645 proxy = mailbox._PartialFile(self._file, 2, 5)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001646 self.assertEqual(proxy.tell(), 0)
1647 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001648
1649 def test_read(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001650 self._file.write(bytes('***bar***', 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001651 self._test_read(mailbox._PartialFile(self._file, 3, 6))
1652
1653 def test_readline(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001654 self._file.write(bytes('!!!!!foo%sbar%sfred%sbob!!!!!' %
1655 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001656 self._test_readline(mailbox._PartialFile(self._file, 5,
1657 18 + 3 * len(os.linesep)))
1658
1659 def test_readlines(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001660 self._file.write(bytes('foo%sbar%sfred%sbob?????' %
1661 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001662 self._test_readlines(mailbox._PartialFile(self._file, 0,
1663 13 + 3 * len(os.linesep)))
1664
1665 def test_iteration(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001666 self._file.write(bytes('____foo%sbar%sfred%sbob####' %
1667 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001668 self._test_iteration(mailbox._PartialFile(self._file, 4,
1669 17 + 3 * len(os.linesep)))
1670
1671 def test_seek_and_tell(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001672 self._file.write(bytes('(((foo%sbar%s$$$' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001673 self._test_seek_and_tell(mailbox._PartialFile(self._file, 3,
1674 9 + 2 * len(os.linesep)))
1675
1676 def test_close(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001677 self._file.write(bytes('&foo%sbar%s^' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001678 self._test_close(mailbox._PartialFile(self._file, 1,
1679 6 + 3 * len(os.linesep)))
1680
1681
1682## Start: tests from the original module (for backward compatibility).
1683
Skip Montanaro5253da12004-07-24 19:56:03 +00001684FROM_ = "From some.body@dummy.domain Sat Jul 24 13:43:35 2004\n"
Fred Drakec02bc3e2001-05-21 20:23:21 +00001685DUMMY_MESSAGE = """\
1686From: some.body@dummy.domain
1687To: me@my.domain
Skip Montanaro5253da12004-07-24 19:56:03 +00001688Subject: Simple Test
Fred Drakec02bc3e2001-05-21 20:23:21 +00001689
1690This is a dummy message.
1691"""
1692
Fred Drakec02bc3e2001-05-21 20:23:21 +00001693class MaildirTestCase(unittest.TestCase):
1694
1695 def setUp(self):
1696 # create a new maildir mailbox to work with:
1697 self._dir = test_support.TESTFN
1698 os.mkdir(self._dir)
1699 os.mkdir(os.path.join(self._dir, "cur"))
1700 os.mkdir(os.path.join(self._dir, "tmp"))
1701 os.mkdir(os.path.join(self._dir, "new"))
1702 self._counter = 1
1703 self._msgfiles = []
1704
1705 def tearDown(self):
Guido van Rossumc1f779c2007-07-03 08:25:58 +00001706 list(map(os.unlink, self._msgfiles))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001707 os.rmdir(os.path.join(self._dir, "cur"))
1708 os.rmdir(os.path.join(self._dir, "tmp"))
1709 os.rmdir(os.path.join(self._dir, "new"))
1710 os.rmdir(self._dir)
1711
Skip Montanaro5253da12004-07-24 19:56:03 +00001712 def createMessage(self, dir, mbox=False):
Jack Jansen97df7b62001-06-19 20:20:05 +00001713 t = int(time.time() % 1000000)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001714 pid = self._counter
1715 self._counter += 1
Skip Montanaro7a98be22007-08-16 14:35:24 +00001716 filename = ".".join((str(t), str(pid), "myhostname", "mydomain"))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001717 tmpname = os.path.join(self._dir, "tmp", filename)
1718 newname = os.path.join(self._dir, dir, filename)
1719 fp = open(tmpname, "w")
1720 self._msgfiles.append(tmpname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001721 if mbox:
1722 fp.write(FROM_)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001723 fp.write(DUMMY_MESSAGE)
1724 fp.close()
Tim Peters6626c1f2001-05-22 16:29:01 +00001725 if hasattr(os, "link"):
1726 os.link(tmpname, newname)
1727 else:
1728 fp = open(newname, "w")
1729 fp.write(DUMMY_MESSAGE)
1730 fp.close()
Fred Drakec02bc3e2001-05-21 20:23:21 +00001731 self._msgfiles.append(newname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001732 return tmpname
Fred Drakec02bc3e2001-05-21 20:23:21 +00001733
1734 def test_empty_maildir(self):
1735 """Test an empty maildir mailbox"""
1736 # Test for regression on bug #117490:
1737 # Make sure the boxes attribute actually gets set.
1738 self.mbox = mailbox.Maildir(test_support.TESTFN)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001739 #self.assert_(hasattr(self.mbox, "boxes"))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001740 #self.assertEqual(len(self.mbox.boxes), 0)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001741 self.assert_(self.mbox.next() is None)
1742 self.assert_(self.mbox.next() is None)
1743
1744 def test_nonempty_maildir_cur(self):
1745 self.createMessage("cur")
1746 self.mbox = mailbox.Maildir(test_support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001747 #self.assertEqual(len(self.mbox.boxes), 1)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001748 self.assert_(self.mbox.next() is not None)
1749 self.assert_(self.mbox.next() is None)
1750 self.assert_(self.mbox.next() is None)
1751
1752 def test_nonempty_maildir_new(self):
1753 self.createMessage("new")
1754 self.mbox = mailbox.Maildir(test_support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001755 #self.assertEqual(len(self.mbox.boxes), 1)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001756 self.assert_(self.mbox.next() is not None)
1757 self.assert_(self.mbox.next() is None)
1758 self.assert_(self.mbox.next() is None)
1759
1760 def test_nonempty_maildir_both(self):
1761 self.createMessage("cur")
1762 self.createMessage("new")
1763 self.mbox = mailbox.Maildir(test_support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001764 #self.assertEqual(len(self.mbox.boxes), 2)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001765 self.assert_(self.mbox.next() is not None)
1766 self.assert_(self.mbox.next() is not None)
1767 self.assert_(self.mbox.next() is None)
1768 self.assert_(self.mbox.next() is None)
Fred Drake0aaed272000-10-23 13:39:15 +00001769
Skip Montanaro5253da12004-07-24 19:56:03 +00001770 def test_unix_mbox(self):
1771 ### should be better!
Thomas Woutersb2137042007-02-01 18:02:27 +00001772 import email.parser
Skip Montanaro5253da12004-07-24 19:56:03 +00001773 fname = self.createMessage("cur", True)
1774 n = 0
1775 for msg in mailbox.PortableUnixMailbox(open(fname),
Thomas Woutersb2137042007-02-01 18:02:27 +00001776 email.parser.Parser().parse):
Skip Montanaro5253da12004-07-24 19:56:03 +00001777 n += 1
1778 self.assertEqual(msg["subject"], "Simple Test")
Guido van Rossum671117a2007-08-31 04:25:05 +00001779 # XXX Disabled until we figure out how to fix this
1780 ##self.assertEqual(len(str(msg)), len(FROM_)+len(DUMMY_MESSAGE))
Skip Montanaro5253da12004-07-24 19:56:03 +00001781 self.assertEqual(n, 1)
1782
Thomas Wouters477c8d52006-05-27 19:21:47 +00001783## End: classes from the original module (for backward compatibility).
1784
1785
1786_sample_message = """\
1787Return-Path: <gkj@gregorykjohnson.com>
1788X-Original-To: gkj+person@localhost
1789Delivered-To: gkj+person@localhost
1790Received: from localhost (localhost [127.0.0.1])
1791 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1792 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
1793Delivered-To: gkj@sundance.gregorykjohnson.com
1794Received: from localhost [127.0.0.1]
1795 by localhost with POP3 (fetchmail-6.2.5)
1796 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
1797Received: from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
1798 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1799 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
1800Received: by andy.gregorykjohnson.com (Postfix, from userid 1000)
1801 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
1802Date: Wed, 13 Jul 2005 17:23:11 -0400
1803From: "Gregory K. Johnson" <gkj@gregorykjohnson.com>
1804To: gkj@gregorykjohnson.com
1805Subject: Sample message
1806Message-ID: <20050713212311.GC4701@andy.gregorykjohnson.com>
1807Mime-Version: 1.0
1808Content-Type: multipart/mixed; boundary="NMuMz9nt05w80d4+"
1809Content-Disposition: inline
1810User-Agent: Mutt/1.5.9i
1811
1812
1813--NMuMz9nt05w80d4+
1814Content-Type: text/plain; charset=us-ascii
1815Content-Disposition: inline
1816
1817This is a sample message.
1818
1819--
1820Gregory K. Johnson
1821
1822--NMuMz9nt05w80d4+
1823Content-Type: application/octet-stream
1824Content-Disposition: attachment; filename="text.gz"
1825Content-Transfer-Encoding: base64
1826
1827H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
18283FYlAAAA
1829
1830--NMuMz9nt05w80d4+--
1831"""
1832
1833_sample_headers = {
1834 "Return-Path":"<gkj@gregorykjohnson.com>",
1835 "X-Original-To":"gkj+person@localhost",
1836 "Delivered-To":"gkj+person@localhost",
1837 "Received":"""from localhost (localhost [127.0.0.1])
1838 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1839 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
1840 "Delivered-To":"gkj@sundance.gregorykjohnson.com",
1841 "Received":"""from localhost [127.0.0.1]
1842 by localhost with POP3 (fetchmail-6.2.5)
1843 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
1844 "Received":"""from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
1845 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1846 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
1847 "Received":"""by andy.gregorykjohnson.com (Postfix, from userid 1000)
1848 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
1849 "Date":"Wed, 13 Jul 2005 17:23:11 -0400",
1850 "From":""""Gregory K. Johnson" <gkj@gregorykjohnson.com>""",
1851 "To":"gkj@gregorykjohnson.com",
1852 "Subject":"Sample message",
1853 "Mime-Version":"1.0",
1854 "Content-Type":"""multipart/mixed; boundary="NMuMz9nt05w80d4+\"""",
1855 "Content-Disposition":"inline",
1856 "User-Agent": "Mutt/1.5.9i" }
1857
1858_sample_payloads = ("""This is a sample message.
1859
1860--
1861Gregory K. Johnson
1862""",
1863"""H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
18643FYlAAAA
1865""")
Fred Drake0aaed272000-10-23 13:39:15 +00001866
Fred Drakec02bc3e2001-05-21 20:23:21 +00001867
Fred Drake2e2be372001-09-20 21:33:42 +00001868def test_main():
Thomas Wouters477c8d52006-05-27 19:21:47 +00001869 tests = (TestMailboxSuperclass, TestMaildir, TestMbox, TestMMDF, TestMH,
1870 TestBabyl, TestMessage, TestMaildirMessage, TestMboxMessage,
1871 TestMHMessage, TestBabylMessage, TestMMDFMessage,
1872 TestMessageConversion, TestProxyFile, TestPartialFile,
1873 MaildirTestCase)
1874 test_support.run_unittest(*tests)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001875 test_support.reap_children()
Fred Drake2e2be372001-09-20 21:33:42 +00001876
1877
Thomas Wouters477c8d52006-05-27 19:21:47 +00001878if __name__ == '__main__':
Fred Drake2e2be372001-09-20 21:33:42 +00001879 test_main()