blob: 918116a50469651e3a60a360b9e05e4cc5ef4dce [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)
520 msg2 = box.get_message(key)
521 self.assert_(isinstance(msg2, FakeMessage))
522
Thomas Wouters477c8d52006-05-27 19:21:47 +0000523 def test_initialize_new(self):
524 # Initialize a non-existent mailbox
525 self.tearDown()
526 self._box = mailbox.Maildir(self._path)
527 self._check_basics(factory=rfc822.Message)
528 self._delete_recursively(self._path)
529 self._box = self._factory(self._path, factory=None)
530 self._check_basics()
531
532 def test_initialize_existing(self):
533 # Initialize an existing mailbox
534 self.tearDown()
535 for subdir in '', 'tmp', 'new', 'cur':
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000536 os.mkdir(os.path.normpath(os.path.join(self._path, subdir)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000537 self._box = mailbox.Maildir(self._path)
538 self._check_basics(factory=rfc822.Message)
539 self._box = mailbox.Maildir(self._path, factory=None)
540 self._check_basics()
541
542 def _check_basics(self, factory=None):
543 # (Used by test_open_new() and test_open_existing().)
544 self.assertEqual(self._box._path, os.path.abspath(self._path))
545 self.assertEqual(self._box._factory, factory)
546 for subdir in '', 'tmp', 'new', 'cur':
547 path = os.path.join(self._path, subdir)
548 mode = os.stat(path)[stat.ST_MODE]
549 self.assert_(stat.S_ISDIR(mode), "Not a directory: '%s'" % path)
550
551 def test_list_folders(self):
552 # List folders
553 self._box.add_folder('one')
554 self._box.add_folder('two')
555 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000556 self.assertEqual(len(self._box.list_folders()), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000557 self.assertEqual(set(self._box.list_folders()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000558 set(('one', 'two', 'three')))
559
560 def test_get_folder(self):
561 # Open folders
562 self._box.add_folder('foo.bar')
563 folder0 = self._box.get_folder('foo.bar')
564 folder0.add(self._template % 'bar')
565 self.assert_(os.path.isdir(os.path.join(self._path, '.foo.bar')))
566 folder1 = self._box.get_folder('foo.bar')
Guido van Rossumea834472007-07-27 05:17:50 +0000567 self.assertEqual(folder1.get_string(folder1.keys()[0]),
568 self._template % 'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000569
570 def test_add_and_remove_folders(self):
571 # Delete folders
572 self._box.add_folder('one')
573 self._box.add_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000574 self.assertEqual(len(self._box.list_folders()), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000575 self.assert_(set(self._box.list_folders()) == set(('one', 'two')))
576 self._box.remove_folder('one')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000577 self.assertEqual(len(self._box.list_folders()), 1)
578 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000579 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000580 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000581 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000582 self._box.remove_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000583 self.assertEqual(len(self._box.list_folders()), 1)
584 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000585 self._box.remove_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000586 self.assertEqual(len(self._box.list_folders()), 0)
587 self.assertEqual(self._box.list_folders(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000588
589 def test_clean(self):
590 # Remove old files from 'tmp'
591 foo_path = os.path.join(self._path, 'tmp', 'foo')
592 bar_path = os.path.join(self._path, 'tmp', 'bar')
593 f = open(foo_path, 'w')
594 f.write("@")
595 f.close()
596 f = open(bar_path, 'w')
597 f.write("@")
598 f.close()
599 self._box.clean()
600 self.assert_(os.path.exists(foo_path))
601 self.assert_(os.path.exists(bar_path))
602 foo_stat = os.stat(foo_path)
603 os.utime(foo_path, (time.time() - 129600 - 2,
604 foo_stat.st_mtime))
605 self._box.clean()
606 self.assert_(not os.path.exists(foo_path))
607 self.assert_(os.path.exists(bar_path))
608
609 def test_create_tmp(self, repetitions=10):
610 # Create files in tmp directory
611 hostname = socket.gethostname()
612 if '/' in hostname:
613 hostname = hostname.replace('/', r'\057')
614 if ':' in hostname:
615 hostname = hostname.replace(':', r'\072')
616 pid = os.getpid()
617 pattern = re.compile(r"(?P<time>\d+)\.M(?P<M>\d{1,6})P(?P<P>\d+)"
618 r"Q(?P<Q>\d+)\.(?P<host>[^:/]+)")
619 previous_groups = None
Guido van Rossum805365e2007-05-07 22:24:25 +0000620 for x in range(repetitions):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000621 tmp_file = self._box._create_tmp()
622 head, tail = os.path.split(tmp_file.name)
623 self.assertEqual(head, os.path.abspath(os.path.join(self._path,
624 "tmp")),
625 "File in wrong location: '%s'" % head)
626 match = pattern.match(tail)
627 self.assert_(match != None, "Invalid file name: '%s'" % tail)
628 groups = match.groups()
629 if previous_groups != None:
630 self.assert_(int(groups[0] >= previous_groups[0]),
631 "Non-monotonic seconds: '%s' before '%s'" %
632 (previous_groups[0], groups[0]))
633 self.assert_(int(groups[1] >= previous_groups[1]) or
634 groups[0] != groups[1],
635 "Non-monotonic milliseconds: '%s' before '%s'" %
636 (previous_groups[1], groups[1]))
Guido van Rossumea834472007-07-27 05:17:50 +0000637 self.assertEqual(int(groups[2]), pid,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000638 "Process ID mismatch: '%s' should be '%s'" %
639 (groups[2], pid))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000640 self.assertEqual(int(groups[3]), int(previous_groups[3]) + 1,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000641 "Non-sequential counter: '%s' before '%s'" %
642 (previous_groups[3], groups[3]))
Guido van Rossumea834472007-07-27 05:17:50 +0000643 self.assertEqual(groups[4], hostname,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000644 "Host name mismatch: '%s' should be '%s'" %
645 (groups[4], hostname))
646 previous_groups = groups
647 tmp_file.write(_sample_message)
648 tmp_file.seek(0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000649 self.assertEqual(tmp_file.read(), _sample_message)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000650 tmp_file.close()
651 file_count = len(os.listdir(os.path.join(self._path, "tmp")))
Guido van Rossumea834472007-07-27 05:17:50 +0000652 self.assertEqual(file_count, repetitions,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000653 "Wrong file count: '%s' should be '%s'" %
654 (file_count, repetitions))
655
656 def test_refresh(self):
657 # Update the table of contents
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000658 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000659 key0 = self._box.add(self._template % 0)
660 key1 = self._box.add(self._template % 1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000661 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000662 self._box._refresh()
Guido van Rossumea834472007-07-27 05:17:50 +0000663 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
664 key1: os.path.join('new', key1)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000665 key2 = self._box.add(self._template % 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000666 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
667 key1: os.path.join('new', key1)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000668 self._box._refresh()
Guido van Rossumea834472007-07-27 05:17:50 +0000669 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
670 key1: os.path.join('new', key1),
671 key2: os.path.join('new', key2)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000672
673 def test_lookup(self):
674 # Look up message subpaths in the TOC
675 self.assertRaises(KeyError, lambda: self._box._lookup('foo'))
676 key0 = self._box.add(self._template % 0)
Guido van Rossumea834472007-07-27 05:17:50 +0000677 self.assertEqual(self._box._lookup(key0), os.path.join('new', key0))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000678 os.remove(os.path.join(self._path, 'new', key0))
Guido van Rossumea834472007-07-27 05:17:50 +0000679 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000680 self.assertRaises(KeyError, lambda: self._box._lookup(key0))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000681 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000682
683 def test_lock_unlock(self):
684 # Lock and unlock the mailbox. For Maildir, this does nothing.
685 self._box.lock()
686 self._box.unlock()
687
Thomas Wouters89f507f2006-12-13 04:49:30 +0000688 def test_folder (self):
689 # Test for bug #1569790: verify that folders returned by .get_folder()
690 # use the same factory function.
691 def dummy_factory (s):
692 return None
693 box = self._factory(self._path, factory=dummy_factory)
694 folder = box.add_folder('folder1')
695 self.assert_(folder._factory is dummy_factory)
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000696
Thomas Wouters89f507f2006-12-13 04:49:30 +0000697 folder1_alias = box.get_folder('folder1')
698 self.assert_(folder1_alias._factory is dummy_factory)
699
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000700 def test_directory_in_folder (self):
701 # Test that mailboxes still work if there's a stray extra directory
702 # in a folder.
703 for i in range(10):
704 self._box.add(mailbox.Message(_sample_message))
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000705
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000706 # Create a stray directory
707 os.mkdir(os.path.join(self._path, 'cur', 'stray-dir'))
708
709 # Check that looping still works with the directory present.
710 for msg in self._box:
711 pass
Thomas Wouters477c8d52006-05-27 19:21:47 +0000712
713class _TestMboxMMDF(TestMailbox):
714
715 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +0000716 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000717 self._delete_recursively(self._path)
718 for lock_remnant in glob.glob(self._path + '.*'):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000719 test_support.unlink(lock_remnant)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000720
721 def test_add_from_string(self):
722 # Add a string starting with 'From ' to the mailbox
723 key = self._box.add('From foo@bar blah\nFrom: foo\n\n0')
Guido van Rossumea834472007-07-27 05:17:50 +0000724 self.assertEqual(self._box[key].get_from(), 'foo@bar blah')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000725 self.assertEqual(self._box[key].get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000726
727 def test_add_mbox_or_mmdf_message(self):
728 # Add an mboxMessage or MMDFMessage
729 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
730 msg = class_('From foo@bar blah\nFrom: foo\n\n0')
731 key = self._box.add(msg)
732
733 def test_open_close_open(self):
734 # Open and inspect previously-created mailbox
Guido van Rossum805365e2007-05-07 22:24:25 +0000735 values = [self._template % i for i in range(3)]
Thomas Wouters477c8d52006-05-27 19:21:47 +0000736 for value in values:
737 self._box.add(value)
738 self._box.close()
739 mtime = os.path.getmtime(self._path)
740 self._box = self._factory(self._path)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000741 self.assertEqual(len(self._box), 3)
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000742 for key in self._box.keys():
Thomas Wouters477c8d52006-05-27 19:21:47 +0000743 self.assert_(self._box.get_string(key) in values)
744 self._box.close()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000745 self.assertEqual(mtime, os.path.getmtime(self._path))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000746
747 def test_add_and_close(self):
748 # Verifying that closing a mailbox doesn't change added items
749 self._box.add(_sample_message)
Guido van Rossum805365e2007-05-07 22:24:25 +0000750 for i in range(3):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000751 self._box.add(self._template % i)
752 self._box.add(_sample_message)
753 self._box._file.flush()
754 self._box._file.seek(0)
755 contents = self._box._file.read()
756 self._box.close()
Guido van Rossumea834472007-07-27 05:17:50 +0000757 self.assertEqual(contents, open(self._path, 'r').read())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000758 self._box = self._factory(self._path)
759
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000760 def test_lock_conflict(self):
761 # Fork off a subprocess that will lock the file for 2 seconds,
762 # unlock it, and then exit.
763 if not hasattr(os, 'fork'):
764 return
765 pid = os.fork()
766 if pid == 0:
767 # In the child, lock the mailbox.
Guido van Rossum62cbc8a2007-04-09 00:41:25 +0000768 try:
769 self._box.lock()
770 time.sleep(2)
771 self._box.unlock()
772 finally:
773 os._exit(0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000774
775 # In the parent, sleep a bit to give the child time to acquire
776 # the lock.
777 time.sleep(0.5)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000778 try:
779 self.assertRaises(mailbox.ExternalClashError,
780 self._box.lock)
781 finally:
782 # Wait for child to exit. Locking should now succeed.
783 exited_pid, status = os.waitpid(pid, 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000784
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000785 self._box.lock()
786 self._box.unlock()
787
Thomas Wouters89f507f2006-12-13 04:49:30 +0000788 def test_relock(self):
789 # Test case for bug #1575506: the mailbox class was locking the
790 # wrong file object in its flush() method.
791 msg = "Subject: sub\n\nbody\n"
792 key1 = self._box.add(msg)
793 self._box.flush()
794 self._box.close()
795
796 self._box = self._factory(self._path)
797 self._box.lock()
798 key2 = self._box.add(msg)
799 self._box.flush()
800 self.assert_(self._box._locked)
801 self._box.close()
802
803
Thomas Wouters477c8d52006-05-27 19:21:47 +0000804
805class TestMbox(_TestMboxMMDF):
806
807 _factory = lambda self, path, factory=None: mailbox.mbox(path, factory)
808
809
810class TestMMDF(_TestMboxMMDF):
811
812 _factory = lambda self, path, factory=None: mailbox.MMDF(path, factory)
813
814
815class TestMH(TestMailbox):
816
817 _factory = lambda self, path, factory=None: mailbox.MH(path, factory)
818
819 def test_list_folders(self):
820 # List folders
821 self._box.add_folder('one')
822 self._box.add_folder('two')
823 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000824 self.assertEqual(len(self._box.list_folders()), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000825 self.assertEqual(set(self._box.list_folders()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000826 set(('one', 'two', 'three')))
827
828 def test_get_folder(self):
829 # Open folders
Thomas Wouters89f507f2006-12-13 04:49:30 +0000830 def dummy_factory (s):
831 return None
832 self._box = self._factory(self._path, dummy_factory)
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000833
Thomas Wouters89f507f2006-12-13 04:49:30 +0000834 new_folder = self._box.add_folder('foo.bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000835 folder0 = self._box.get_folder('foo.bar')
836 folder0.add(self._template % 'bar')
837 self.assert_(os.path.isdir(os.path.join(self._path, 'foo.bar')))
838 folder1 = self._box.get_folder('foo.bar')
Guido van Rossumea834472007-07-27 05:17:50 +0000839 self.assertEqual(folder1.get_string(folder1.keys()[0]),
840 self._template % 'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000841
Thomas Wouters89f507f2006-12-13 04:49:30 +0000842 # Test for bug #1569790: verify that folders returned by .get_folder()
843 # use the same factory function.
844 self.assert_(new_folder._factory is self._box._factory)
845 self.assert_(folder0._factory is self._box._factory)
846
Thomas Wouters477c8d52006-05-27 19:21:47 +0000847 def test_add_and_remove_folders(self):
848 # Delete folders
849 self._box.add_folder('one')
850 self._box.add_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000851 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000852 self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000853 self._box.remove_folder('one')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000854 self.assertEqual(len(self._box.list_folders()), 1)
855 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000856 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000857 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000858 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000859 self._box.remove_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000860 self.assertEqual(len(self._box.list_folders()), 1)
861 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000862 self._box.remove_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000863 self.assertEqual(len(self._box.list_folders()), 0)
864 self.assertEqual(self._box.list_folders(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000865
866 def test_sequences(self):
867 # Get and set sequences
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000868 self.assertEqual(self._box.get_sequences(), {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000869 msg0 = mailbox.MHMessage(self._template % 0)
870 msg0.add_sequence('foo')
871 key0 = self._box.add(msg0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000872 self.assertEqual(self._box.get_sequences(), {'foo':[key0]})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000873 msg1 = mailbox.MHMessage(self._template % 1)
874 msg1.set_sequences(['bar', 'replied', 'foo'])
875 key1 = self._box.add(msg1)
Guido van Rossumea834472007-07-27 05:17:50 +0000876 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000877 {'foo':[key0, key1], 'bar':[key1], 'replied':[key1]})
878 msg0.set_sequences(['flagged'])
879 self._box[key0] = msg0
Guido van Rossumea834472007-07-27 05:17:50 +0000880 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000881 {'foo':[key1], 'bar':[key1], 'replied':[key1],
882 'flagged':[key0]})
883 self._box.remove(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000884 self.assertEqual(self._box.get_sequences(), {'flagged':[key0]})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000885
886 def test_pack(self):
887 # Pack the contents of the mailbox
888 msg0 = mailbox.MHMessage(self._template % 0)
889 msg1 = mailbox.MHMessage(self._template % 1)
890 msg2 = mailbox.MHMessage(self._template % 2)
891 msg3 = mailbox.MHMessage(self._template % 3)
892 msg0.set_sequences(['foo', 'unseen'])
893 msg1.set_sequences(['foo'])
894 msg2.set_sequences(['foo', 'flagged'])
895 msg3.set_sequences(['foo', 'bar', 'replied'])
896 key0 = self._box.add(msg0)
897 key1 = self._box.add(msg1)
898 key2 = self._box.add(msg2)
899 key3 = self._box.add(msg3)
Guido van Rossumea834472007-07-27 05:17:50 +0000900 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000901 {'foo':[key0,key1,key2,key3], 'unseen':[key0],
902 'flagged':[key2], 'bar':[key3], 'replied':[key3]})
903 self._box.remove(key2)
Guido van Rossumea834472007-07-27 05:17:50 +0000904 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000905 {'foo':[key0,key1,key3], 'unseen':[key0], 'bar':[key3],
906 'replied':[key3]})
907 self._box.pack()
908 self.assert_(self._box.keys() == [1, 2, 3])
909 key0 = key0
910 key1 = key0 + 1
911 key2 = key1 + 1
Guido van Rossumea834472007-07-27 05:17:50 +0000912 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000913 {'foo':[1, 2, 3], 'unseen':[1], 'bar':[3], 'replied':[3]})
914
Thomas Wouters89f507f2006-12-13 04:49:30 +0000915 # Test case for packing while holding the mailbox locked.
916 key0 = self._box.add(msg1)
917 key1 = self._box.add(msg1)
918 key2 = self._box.add(msg1)
919 key3 = self._box.add(msg1)
920
921 self._box.remove(key0)
922 self._box.remove(key2)
923 self._box.lock()
924 self._box.pack()
925 self._box.unlock()
Guido van Rossumea834472007-07-27 05:17:50 +0000926 self.assertEqual(self._box.get_sequences(),
Thomas Wouters89f507f2006-12-13 04:49:30 +0000927 {'foo':[1, 2, 3, 4, 5],
928 'unseen':[1], 'bar':[3], 'replied':[3]})
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000929
Thomas Wouters477c8d52006-05-27 19:21:47 +0000930 def _get_lock_path(self):
931 return os.path.join(self._path, '.mh_sequences.lock')
932
933
934class TestBabyl(TestMailbox):
935
936 _factory = lambda self, path, factory=None: mailbox.Babyl(path, factory)
937
938 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +0000939 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000940 self._delete_recursively(self._path)
941 for lock_remnant in glob.glob(self._path + '.*'):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000942 test_support.unlink(lock_remnant)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000943
944 def test_labels(self):
945 # Get labels from the mailbox
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000946 self.assertEqual(self._box.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000947 msg0 = mailbox.BabylMessage(self._template % 0)
948 msg0.add_label('foo')
949 key0 = self._box.add(msg0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000950 self.assertEqual(self._box.get_labels(), ['foo'])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000951 msg1 = mailbox.BabylMessage(self._template % 1)
952 msg1.set_labels(['bar', 'answered', 'foo'])
953 key1 = self._box.add(msg1)
Guido van Rossumea834472007-07-27 05:17:50 +0000954 self.assertEqual(set(self._box.get_labels()), set(['foo', 'bar']))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000955 msg0.set_labels(['blah', 'filed'])
956 self._box[key0] = msg0
Guido van Rossumea834472007-07-27 05:17:50 +0000957 self.assertEqual(set(self._box.get_labels()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000958 set(['foo', 'bar', 'blah']))
959 self._box.remove(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000960 self.assertEqual(set(self._box.get_labels()), set(['blah']))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000961
962
963class TestMessage(TestBase):
964
965 _factory = mailbox.Message # Overridden by subclasses to reuse tests
966
967 def setUp(self):
968 self._path = test_support.TESTFN
969
970 def tearDown(self):
971 self._delete_recursively(self._path)
972
973 def test_initialize_with_eMM(self):
Thomas Woutersb2137042007-02-01 18:02:27 +0000974 # Initialize based on email.message.Message instance
Thomas Wouters477c8d52006-05-27 19:21:47 +0000975 eMM = email.message_from_string(_sample_message)
976 msg = self._factory(eMM)
977 self._post_initialize_hook(msg)
978 self._check_sample(msg)
979
980 def test_initialize_with_string(self):
981 # Initialize based on string
982 msg = self._factory(_sample_message)
983 self._post_initialize_hook(msg)
984 self._check_sample(msg)
985
986 def test_initialize_with_file(self):
987 # Initialize based on contents of file
988 f = open(self._path, 'w+')
989 f.write(_sample_message)
990 f.seek(0)
991 msg = self._factory(f)
992 self._post_initialize_hook(msg)
993 self._check_sample(msg)
994 f.close()
995
996 def test_initialize_with_nothing(self):
997 # Initialize without arguments
998 msg = self._factory()
999 self._post_initialize_hook(msg)
Thomas Woutersb2137042007-02-01 18:02:27 +00001000 self.assert_(isinstance(msg, email.message.Message))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001001 self.assert_(isinstance(msg, mailbox.Message))
1002 self.assert_(isinstance(msg, self._factory))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001003 self.assertEqual(msg.keys(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001004 self.assert_(not msg.is_multipart())
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001005 self.assertEqual(msg.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001006
1007 def test_initialize_incorrectly(self):
1008 # Initialize with invalid argument
1009 self.assertRaises(TypeError, lambda: self._factory(object()))
1010
1011 def test_become_message(self):
1012 # Take on the state of another message
1013 eMM = email.message_from_string(_sample_message)
1014 msg = self._factory()
1015 msg._become_message(eMM)
1016 self._check_sample(msg)
1017
1018 def test_explain_to(self):
1019 # Copy self's format-specific data to other message formats.
1020 # This test is superficial; better ones are in TestMessageConversion.
1021 msg = self._factory()
1022 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1023 mailbox.mboxMessage, mailbox.MHMessage,
1024 mailbox.BabylMessage, mailbox.MMDFMessage):
1025 other_msg = class_()
1026 msg._explain_to(other_msg)
Thomas Woutersb2137042007-02-01 18:02:27 +00001027 other_msg = email.message.Message()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001028 self.assertRaises(TypeError, lambda: msg._explain_to(other_msg))
1029
1030 def _post_initialize_hook(self, msg):
1031 # Overridden by subclasses to check extra things after initialization
1032 pass
1033
1034
1035class TestMaildirMessage(TestMessage):
1036
1037 _factory = mailbox.MaildirMessage
1038
1039 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001040 self.assertEqual(msg._subdir, 'new')
1041 self.assertEqual(msg._info, '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001042
1043 def test_subdir(self):
1044 # Use get_subdir() and set_subdir()
1045 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001046 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001047 msg.set_subdir('cur')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001048 self.assertEqual(msg.get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001049 msg.set_subdir('new')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001050 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001051 self.assertRaises(ValueError, lambda: msg.set_subdir('tmp'))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001052 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001053 msg.set_subdir('new')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001054 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001055 self._check_sample(msg)
1056
1057 def test_flags(self):
1058 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1059 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001060 self.assertEqual(msg.get_flags(), '')
1061 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001062 msg.set_flags('F')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001063 self.assertEqual(msg.get_subdir(), 'new')
1064 self.assertEqual(msg.get_flags(), 'F')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001065 msg.set_flags('SDTP')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001066 self.assertEqual(msg.get_flags(), 'DPST')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001067 msg.add_flag('FT')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001068 self.assertEqual(msg.get_flags(), 'DFPST')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001069 msg.remove_flag('TDRP')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001070 self.assertEqual(msg.get_flags(), 'FS')
1071 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001072 self._check_sample(msg)
1073
1074 def test_date(self):
1075 # Use get_date() and set_date()
1076 msg = mailbox.MaildirMessage(_sample_message)
1077 self.assert_(abs(msg.get_date() - time.time()) < 60)
1078 msg.set_date(0.0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001079 self.assertEqual(msg.get_date(), 0.0)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001080
1081 def test_info(self):
1082 # Use get_info() and set_info()
1083 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001084 self.assertEqual(msg.get_info(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001085 msg.set_info('1,foo=bar')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001086 self.assertEqual(msg.get_info(), '1,foo=bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001087 self.assertRaises(TypeError, lambda: msg.set_info(None))
1088 self._check_sample(msg)
1089
1090 def test_info_and_flags(self):
1091 # Test interaction of info and flag methods
1092 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001093 self.assertEqual(msg.get_info(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001094 msg.set_flags('SF')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001095 self.assertEqual(msg.get_flags(), 'FS')
1096 self.assertEqual(msg.get_info(), '2,FS')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001097 msg.set_info('1,')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001098 self.assertEqual(msg.get_flags(), '')
1099 self.assertEqual(msg.get_info(), '1,')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001100 msg.remove_flag('RPT')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001101 self.assertEqual(msg.get_flags(), '')
1102 self.assertEqual(msg.get_info(), '1,')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001103 msg.add_flag('D')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001104 self.assertEqual(msg.get_flags(), 'D')
1105 self.assertEqual(msg.get_info(), '2,D')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001106 self._check_sample(msg)
1107
1108
1109class _TestMboxMMDFMessage(TestMessage):
1110
1111 _factory = mailbox._mboxMMDFMessage
1112
1113 def _post_initialize_hook(self, msg):
1114 self._check_from(msg)
1115
1116 def test_initialize_with_unixfrom(self):
1117 # Initialize with a message that already has a _unixfrom attribute
1118 msg = mailbox.Message(_sample_message)
1119 msg.set_unixfrom('From foo@bar blah')
1120 msg = mailbox.mboxMessage(msg)
Guido van Rossumea834472007-07-27 05:17:50 +00001121 self.assertEqual(msg.get_from(), 'foo@bar blah', msg.get_from())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001122
1123 def test_from(self):
1124 # Get and set "From " line
1125 msg = mailbox.mboxMessage(_sample_message)
1126 self._check_from(msg)
1127 msg.set_from('foo bar')
Guido van Rossumea834472007-07-27 05:17:50 +00001128 self.assertEqual(msg.get_from(), 'foo bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001129 msg.set_from('foo@bar', True)
1130 self._check_from(msg, 'foo@bar')
1131 msg.set_from('blah@temp', time.localtime())
1132 self._check_from(msg, 'blah@temp')
1133
1134 def test_flags(self):
1135 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1136 msg = mailbox.mboxMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001137 self.assertEqual(msg.get_flags(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001138 msg.set_flags('F')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001139 self.assertEqual(msg.get_flags(), 'F')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001140 msg.set_flags('XODR')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001141 self.assertEqual(msg.get_flags(), 'RODX')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001142 msg.add_flag('FA')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001143 self.assertEqual(msg.get_flags(), 'RODFAX')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001144 msg.remove_flag('FDXA')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001145 self.assertEqual(msg.get_flags(), 'RO')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001146 self._check_sample(msg)
1147
1148 def _check_from(self, msg, sender=None):
1149 # Check contents of "From " line
1150 if sender is None:
1151 sender = "MAILER-DAEMON"
1152 self.assert_(re.match(sender + r" \w{3} \w{3} [\d ]\d [\d ]\d:\d{2}:"
1153 r"\d{2} \d{4}", msg.get_from()) is not None)
1154
1155
1156class TestMboxMessage(_TestMboxMMDFMessage):
1157
1158 _factory = mailbox.mboxMessage
1159
1160
1161class TestMHMessage(TestMessage):
1162
1163 _factory = mailbox.MHMessage
1164
1165 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001166 self.assertEqual(msg._sequences, [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001167
1168 def test_sequences(self):
1169 # Get, set, join, and leave sequences
1170 msg = mailbox.MHMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001171 self.assertEqual(msg.get_sequences(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001172 msg.set_sequences(['foobar'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001173 self.assertEqual(msg.get_sequences(), ['foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001174 msg.set_sequences([])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001175 self.assertEqual(msg.get_sequences(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001176 msg.add_sequence('unseen')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001177 self.assertEqual(msg.get_sequences(), ['unseen'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001178 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001179 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001180 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001181 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001182 msg.remove_sequence('unseen')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001183 self.assertEqual(msg.get_sequences(), ['flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001184 msg.add_sequence('foobar')
Guido van Rossumea834472007-07-27 05:17:50 +00001185 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001186 msg.remove_sequence('replied')
Guido van Rossumea834472007-07-27 05:17:50 +00001187 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001188 msg.set_sequences(['foobar', 'replied'])
Guido van Rossumea834472007-07-27 05:17:50 +00001189 self.assertEqual(msg.get_sequences(), ['foobar', 'replied'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001190
1191
1192class TestBabylMessage(TestMessage):
1193
1194 _factory = mailbox.BabylMessage
1195
1196 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001197 self.assertEqual(msg._labels, [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001198
1199 def test_labels(self):
1200 # Get, set, join, and leave labels
1201 msg = mailbox.BabylMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001202 self.assertEqual(msg.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001203 msg.set_labels(['foobar'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001204 self.assertEqual(msg.get_labels(), ['foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001205 msg.set_labels([])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001206 self.assertEqual(msg.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001207 msg.add_label('filed')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001208 self.assertEqual(msg.get_labels(), ['filed'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001209 msg.add_label('resent')
Guido van Rossumea834472007-07-27 05:17:50 +00001210 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001211 msg.add_label('resent')
Guido van Rossumea834472007-07-27 05:17:50 +00001212 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001213 msg.remove_label('filed')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001214 self.assertEqual(msg.get_labels(), ['resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001215 msg.add_label('foobar')
Guido van Rossumea834472007-07-27 05:17:50 +00001216 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001217 msg.remove_label('unseen')
Guido van Rossumea834472007-07-27 05:17:50 +00001218 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001219 msg.set_labels(['foobar', 'answered'])
Guido van Rossumea834472007-07-27 05:17:50 +00001220 self.assertEqual(msg.get_labels(), ['foobar', 'answered'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001221
1222 def test_visible(self):
1223 # Get, set, and update visible headers
1224 msg = mailbox.BabylMessage(_sample_message)
1225 visible = msg.get_visible()
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001226 self.assertEqual(visible.keys(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001227 self.assert_(visible.get_payload() is None)
1228 visible['User-Agent'] = 'FooBar 1.0'
1229 visible['X-Whatever'] = 'Blah'
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001230 self.assertEqual(msg.get_visible().keys(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001231 msg.set_visible(visible)
1232 visible = msg.get_visible()
1233 self.assert_(visible.keys() == ['User-Agent', 'X-Whatever'])
1234 self.assert_(visible['User-Agent'] == 'FooBar 1.0')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001235 self.assertEqual(visible['X-Whatever'], 'Blah')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001236 self.assert_(visible.get_payload() is None)
1237 msg.update_visible()
Guido van Rossumea834472007-07-27 05:17:50 +00001238 self.assertEqual(visible.keys(), ['User-Agent', 'X-Whatever'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001239 self.assert_(visible.get_payload() is None)
1240 visible = msg.get_visible()
Guido van Rossumea834472007-07-27 05:17:50 +00001241 self.assertEqual(visible.keys(), ['User-Agent', 'Date', 'From', 'To',
1242 'Subject'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001243 for header in ('User-Agent', 'Date', 'From', 'To', 'Subject'):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001244 self.assertEqual(visible[header], msg[header])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001245
1246
1247class TestMMDFMessage(_TestMboxMMDFMessage):
1248
1249 _factory = mailbox.MMDFMessage
1250
1251
1252class TestMessageConversion(TestBase):
1253
1254 def test_plain_to_x(self):
1255 # Convert Message to all formats
1256 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1257 mailbox.mboxMessage, mailbox.MHMessage,
1258 mailbox.BabylMessage, mailbox.MMDFMessage):
1259 msg_plain = mailbox.Message(_sample_message)
1260 msg = class_(msg_plain)
1261 self._check_sample(msg)
1262
1263 def test_x_to_plain(self):
1264 # Convert all formats to Message
1265 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1266 mailbox.mboxMessage, mailbox.MHMessage,
1267 mailbox.BabylMessage, mailbox.MMDFMessage):
1268 msg = class_(_sample_message)
1269 msg_plain = mailbox.Message(msg)
1270 self._check_sample(msg_plain)
1271
1272 def test_x_to_invalid(self):
1273 # Convert all formats to an invalid format
1274 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1275 mailbox.mboxMessage, mailbox.MHMessage,
1276 mailbox.BabylMessage, mailbox.MMDFMessage):
1277 self.assertRaises(TypeError, lambda: class_(False))
1278
1279 def test_maildir_to_maildir(self):
1280 # Convert MaildirMessage to MaildirMessage
1281 msg_maildir = mailbox.MaildirMessage(_sample_message)
1282 msg_maildir.set_flags('DFPRST')
1283 msg_maildir.set_subdir('cur')
1284 date = msg_maildir.get_date()
1285 msg = mailbox.MaildirMessage(msg_maildir)
1286 self._check_sample(msg)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001287 self.assertEqual(msg.get_flags(), 'DFPRST')
1288 self.assertEqual(msg.get_subdir(), 'cur')
1289 self.assertEqual(msg.get_date(), date)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001290
1291 def test_maildir_to_mboxmmdf(self):
1292 # Convert MaildirMessage to mboxmessage and MMDFMessage
1293 pairs = (('D', ''), ('F', 'F'), ('P', ''), ('R', 'A'), ('S', 'R'),
1294 ('T', 'D'), ('DFPRST', 'RDFA'))
1295 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1296 msg_maildir = mailbox.MaildirMessage(_sample_message)
1297 msg_maildir.set_date(0.0)
1298 for setting, result in pairs:
1299 msg_maildir.set_flags(setting)
1300 msg = class_(msg_maildir)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001301 self.assertEqual(msg.get_flags(), result)
Guido van Rossumea834472007-07-27 05:17:50 +00001302 self.assertEqual(msg.get_from(), 'MAILER-DAEMON %s' %
Thomas Wouters477c8d52006-05-27 19:21:47 +00001303 time.asctime(time.gmtime(0.0)))
1304 msg_maildir.set_subdir('cur')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001305 self.assertEqual(class_(msg_maildir).get_flags(), 'RODFA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001306
1307 def test_maildir_to_mh(self):
1308 # Convert MaildirMessage to MHMessage
1309 msg_maildir = mailbox.MaildirMessage(_sample_message)
1310 pairs = (('D', ['unseen']), ('F', ['unseen', 'flagged']),
1311 ('P', ['unseen']), ('R', ['unseen', 'replied']), ('S', []),
1312 ('T', ['unseen']), ('DFPRST', ['replied', 'flagged']))
1313 for setting, result in pairs:
1314 msg_maildir.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001315 self.assertEqual(mailbox.MHMessage(msg_maildir).get_sequences(),
1316 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001317
1318 def test_maildir_to_babyl(self):
1319 # Convert MaildirMessage to Babyl
1320 msg_maildir = mailbox.MaildirMessage(_sample_message)
1321 pairs = (('D', ['unseen']), ('F', ['unseen']),
1322 ('P', ['unseen', 'forwarded']), ('R', ['unseen', 'answered']),
1323 ('S', []), ('T', ['unseen', 'deleted']),
1324 ('DFPRST', ['deleted', 'answered', 'forwarded']))
1325 for setting, result in pairs:
1326 msg_maildir.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001327 self.assertEqual(mailbox.BabylMessage(msg_maildir).get_labels(),
1328 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001329
1330 def test_mboxmmdf_to_maildir(self):
1331 # Convert mboxMessage and MMDFMessage to MaildirMessage
1332 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1333 msg_mboxMMDF = class_(_sample_message)
1334 msg_mboxMMDF.set_from('foo@bar', time.gmtime(0.0))
1335 pairs = (('R', 'S'), ('O', ''), ('D', 'T'), ('F', 'F'), ('A', 'R'),
1336 ('RODFA', 'FRST'))
1337 for setting, result in pairs:
1338 msg_mboxMMDF.set_flags(setting)
1339 msg = mailbox.MaildirMessage(msg_mboxMMDF)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001340 self.assertEqual(msg.get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001341 self.assert_(msg.get_date() == 0.0, msg.get_date())
1342 msg_mboxMMDF.set_flags('O')
Guido van Rossumea834472007-07-27 05:17:50 +00001343 self.assertEqual(mailbox.MaildirMessage(msg_mboxMMDF).get_subdir(),
1344 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001345
1346 def test_mboxmmdf_to_mboxmmdf(self):
1347 # Convert mboxMessage and MMDFMessage to mboxMessage and MMDFMessage
1348 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1349 msg_mboxMMDF = class_(_sample_message)
1350 msg_mboxMMDF.set_flags('RODFA')
1351 msg_mboxMMDF.set_from('foo@bar')
1352 for class2_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1353 msg2 = class2_(msg_mboxMMDF)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001354 self.assertEqual(msg2.get_flags(), 'RODFA')
1355 self.assertEqual(msg2.get_from(), 'foo@bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001356
1357 def test_mboxmmdf_to_mh(self):
1358 # Convert mboxMessage and MMDFMessage to MHMessage
1359 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1360 msg_mboxMMDF = class_(_sample_message)
1361 pairs = (('R', []), ('O', ['unseen']), ('D', ['unseen']),
1362 ('F', ['unseen', 'flagged']),
1363 ('A', ['unseen', 'replied']),
1364 ('RODFA', ['replied', 'flagged']))
1365 for setting, result in pairs:
1366 msg_mboxMMDF.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001367 self.assertEqual(mailbox.MHMessage(msg_mboxMMDF).get_sequences(),
1368 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001369
1370 def test_mboxmmdf_to_babyl(self):
1371 # Convert mboxMessage and MMDFMessage to BabylMessage
1372 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1373 msg = class_(_sample_message)
1374 pairs = (('R', []), ('O', ['unseen']),
1375 ('D', ['unseen', 'deleted']), ('F', ['unseen']),
1376 ('A', ['unseen', 'answered']),
1377 ('RODFA', ['deleted', 'answered']))
1378 for setting, result in pairs:
1379 msg.set_flags(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001380 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001381
1382 def test_mh_to_maildir(self):
1383 # Convert MHMessage to MaildirMessage
1384 pairs = (('unseen', ''), ('replied', 'RS'), ('flagged', 'FS'))
1385 for setting, result in pairs:
1386 msg = mailbox.MHMessage(_sample_message)
1387 msg.add_sequence(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001388 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1389 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001390 msg = mailbox.MHMessage(_sample_message)
1391 msg.add_sequence('unseen')
1392 msg.add_sequence('replied')
1393 msg.add_sequence('flagged')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001394 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'FR')
1395 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001396
1397 def test_mh_to_mboxmmdf(self):
1398 # Convert MHMessage to mboxMessage and MMDFMessage
1399 pairs = (('unseen', 'O'), ('replied', 'ROA'), ('flagged', 'ROF'))
1400 for setting, result in pairs:
1401 msg = mailbox.MHMessage(_sample_message)
1402 msg.add_sequence(setting)
1403 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001404 self.assertEqual(class_(msg).get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001405 msg = mailbox.MHMessage(_sample_message)
1406 msg.add_sequence('unseen')
1407 msg.add_sequence('replied')
1408 msg.add_sequence('flagged')
1409 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001410 self.assertEqual(class_(msg).get_flags(), 'OFA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001411
1412 def test_mh_to_mh(self):
1413 # Convert MHMessage to MHMessage
1414 msg = mailbox.MHMessage(_sample_message)
1415 msg.add_sequence('unseen')
1416 msg.add_sequence('replied')
1417 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001418 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1419 ['unseen', 'replied', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001420
1421 def test_mh_to_babyl(self):
1422 # Convert MHMessage to BabylMessage
1423 pairs = (('unseen', ['unseen']), ('replied', ['answered']),
1424 ('flagged', []))
1425 for setting, result in pairs:
1426 msg = mailbox.MHMessage(_sample_message)
1427 msg.add_sequence(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001428 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001429 msg = mailbox.MHMessage(_sample_message)
1430 msg.add_sequence('unseen')
1431 msg.add_sequence('replied')
1432 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001433 self.assertEqual(mailbox.BabylMessage(msg).get_labels(),
1434 ['unseen', 'answered'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001435
1436 def test_babyl_to_maildir(self):
1437 # Convert BabylMessage to MaildirMessage
1438 pairs = (('unseen', ''), ('deleted', 'ST'), ('filed', 'S'),
1439 ('answered', 'RS'), ('forwarded', 'PS'), ('edited', 'S'),
1440 ('resent', 'PS'))
1441 for setting, result in pairs:
1442 msg = mailbox.BabylMessage(_sample_message)
1443 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001444 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1445 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001446 msg = mailbox.BabylMessage(_sample_message)
1447 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1448 'edited', 'resent'):
1449 msg.add_label(label)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001450 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'PRT')
1451 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001452
1453 def test_babyl_to_mboxmmdf(self):
1454 # Convert BabylMessage to mboxMessage and MMDFMessage
1455 pairs = (('unseen', 'O'), ('deleted', 'ROD'), ('filed', 'RO'),
1456 ('answered', 'ROA'), ('forwarded', 'RO'), ('edited', 'RO'),
1457 ('resent', 'RO'))
1458 for setting, result in pairs:
1459 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1460 msg = mailbox.BabylMessage(_sample_message)
1461 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001462 self.assertEqual(class_(msg).get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001463 msg = mailbox.BabylMessage(_sample_message)
1464 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1465 'edited', 'resent'):
1466 msg.add_label(label)
1467 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001468 self.assertEqual(class_(msg).get_flags(), 'ODA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001469
1470 def test_babyl_to_mh(self):
1471 # Convert BabylMessage to MHMessage
1472 pairs = (('unseen', ['unseen']), ('deleted', []), ('filed', []),
1473 ('answered', ['replied']), ('forwarded', []), ('edited', []),
1474 ('resent', []))
1475 for setting, result in pairs:
1476 msg = mailbox.BabylMessage(_sample_message)
1477 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001478 self.assertEqual(mailbox.MHMessage(msg).get_sequences(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001479 msg = mailbox.BabylMessage(_sample_message)
1480 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1481 'edited', 'resent'):
1482 msg.add_label(label)
Guido van Rossumea834472007-07-27 05:17:50 +00001483 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1484 ['unseen', 'replied'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001485
1486 def test_babyl_to_babyl(self):
1487 # Convert BabylMessage to BabylMessage
1488 msg = mailbox.BabylMessage(_sample_message)
1489 msg.update_visible()
1490 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1491 'edited', 'resent'):
1492 msg.add_label(label)
1493 msg2 = mailbox.BabylMessage(msg)
Guido van Rossumea834472007-07-27 05:17:50 +00001494 self.assertEqual(msg2.get_labels(), ['unseen', 'deleted', 'filed',
1495 'answered', 'forwarded', 'edited',
1496 'resent'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001497 self.assertEqual(msg.get_visible().keys(), msg2.get_visible().keys())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001498 for key in msg.get_visible().keys():
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001499 self.assertEqual(msg.get_visible()[key], msg2.get_visible()[key])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001500
1501
1502class TestProxyFileBase(TestBase):
1503
1504 def _test_read(self, proxy):
1505 # Read by byte
1506 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001507 self.assertEqual(proxy.read(), b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001508 proxy.seek(1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001509 self.assertEqual(proxy.read(), b'ar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001510 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001511 self.assertEqual(proxy.read(2), b'ba')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001512 proxy.seek(1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001513 self.assertEqual(proxy.read(-1), b'ar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001514 proxy.seek(2)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001515 self.assertEqual(proxy.read(1000), b'r')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001516
1517 def _test_readline(self, proxy):
1518 # Read by line
Guido van Rossum98297ee2007-11-06 21:34:58 +00001519 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001520 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001521 self.assertEqual(proxy.readline(), b'foo' + linesep)
1522 self.assertEqual(proxy.readline(), b'bar' + linesep)
1523 self.assertEqual(proxy.readline(), b'fred' + linesep)
1524 self.assertEqual(proxy.readline(), b'bob')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001525 proxy.seek(2)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001526 self.assertEqual(proxy.readline(), b'o' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001527 proxy.seek(6 + 2 * len(os.linesep))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001528 self.assertEqual(proxy.readline(), b'fred' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001529 proxy.seek(6 + 2 * len(os.linesep))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001530 self.assertEqual(proxy.readline(2), b'fr')
1531 self.assertEqual(proxy.readline(-10), b'ed' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001532
1533 def _test_readlines(self, proxy):
1534 # Read multiple lines
Guido van Rossum98297ee2007-11-06 21:34:58 +00001535 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001536 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001537 self.assertEqual(proxy.readlines(), [b'foo' + linesep,
1538 b'bar' + linesep,
1539 b'fred' + linesep, b'bob'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001540 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001541 self.assertEqual(proxy.readlines(2), [b'foo' + linesep])
1542 proxy.seek(3 + len(linesep))
1543 self.assertEqual(proxy.readlines(4 + len(linesep)),
1544 [b'bar' + linesep, b'fred' + linesep])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001545 proxy.seek(3)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001546 self.assertEqual(proxy.readlines(1000), [linesep, b'bar' + linesep,
1547 b'fred' + linesep, b'bob'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001548
1549 def _test_iteration(self, proxy):
1550 # Iterate by line
Guido van Rossum98297ee2007-11-06 21:34:58 +00001551 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001552 proxy.seek(0)
1553 iterator = iter(proxy)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001554 self.assertEqual(next(iterator), b'foo' + linesep)
1555 self.assertEqual(next(iterator), b'bar' + linesep)
1556 self.assertEqual(next(iterator), b'fred' + linesep)
1557 self.assertEqual(next(iterator), b'bob')
Georg Brandla18af4e2007-04-21 15:47:16 +00001558 self.assertRaises(StopIteration, next, iterator)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001559
1560 def _test_seek_and_tell(self, proxy):
1561 # Seek and use tell to check position
Guido van Rossum98297ee2007-11-06 21:34:58 +00001562 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001563 proxy.seek(3)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001564 self.assertEqual(proxy.tell(), 3)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001565 self.assertEqual(proxy.read(len(linesep)), linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001566 proxy.seek(2, 1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001567 self.assertEqual(proxy.read(1 + len(linesep)), b'r' + linesep)
1568 proxy.seek(-3 - len(linesep), 2)
1569 self.assertEqual(proxy.read(3), b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001570 proxy.seek(2, 0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001571 self.assertEqual(proxy.read(), b'o' + linesep + b'bar' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001572 proxy.seek(100)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001573 self.failIf(proxy.read())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001574
1575 def _test_close(self, proxy):
1576 # Close a file
1577 proxy.close()
1578 self.assertRaises(AttributeError, lambda: proxy.close())
1579
1580
1581class TestProxyFile(TestProxyFileBase):
1582
1583 def setUp(self):
1584 self._path = test_support.TESTFN
1585 self._file = open(self._path, 'wb+')
1586
1587 def tearDown(self):
1588 self._file.close()
1589 self._delete_recursively(self._path)
1590
1591 def test_initialize(self):
1592 # Initialize and check position
Neal Norwitz9a923102007-08-30 06:20:05 +00001593 self._file.write(b'foo')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001594 pos = self._file.tell()
1595 proxy0 = mailbox._ProxyFile(self._file)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001596 self.assertEqual(proxy0.tell(), pos)
1597 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001598 proxy1 = mailbox._ProxyFile(self._file, 0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001599 self.assertEqual(proxy1.tell(), 0)
1600 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001601
1602 def test_read(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001603 self._file.write(b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001604 self._test_read(mailbox._ProxyFile(self._file))
1605
1606 def test_readline(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001607 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1608 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001609 self._test_readline(mailbox._ProxyFile(self._file))
1610
1611 def test_readlines(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001612 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1613 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001614 self._test_readlines(mailbox._ProxyFile(self._file))
1615
1616 def test_iteration(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001617 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1618 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001619 self._test_iteration(mailbox._ProxyFile(self._file))
1620
1621 def test_seek_and_tell(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001622 self._file.write(bytes('foo%sbar%s' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001623 self._test_seek_and_tell(mailbox._ProxyFile(self._file))
1624
1625 def test_close(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001626 self._file.write(bytes('foo%sbar%s' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001627 self._test_close(mailbox._ProxyFile(self._file))
1628
1629
1630class TestPartialFile(TestProxyFileBase):
1631
1632 def setUp(self):
1633 self._path = test_support.TESTFN
1634 self._file = open(self._path, 'wb+')
1635
1636 def tearDown(self):
1637 self._file.close()
1638 self._delete_recursively(self._path)
1639
1640 def test_initialize(self):
1641 # Initialize and check position
Neal Norwitz9a923102007-08-30 06:20:05 +00001642 self._file.write(bytes('foo' + os.linesep + 'bar', 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001643 pos = self._file.tell()
1644 proxy = mailbox._PartialFile(self._file, 2, 5)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001645 self.assertEqual(proxy.tell(), 0)
1646 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001647
1648 def test_read(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001649 self._file.write(bytes('***bar***', 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001650 self._test_read(mailbox._PartialFile(self._file, 3, 6))
1651
1652 def test_readline(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001653 self._file.write(bytes('!!!!!foo%sbar%sfred%sbob!!!!!' %
1654 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001655 self._test_readline(mailbox._PartialFile(self._file, 5,
1656 18 + 3 * len(os.linesep)))
1657
1658 def test_readlines(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001659 self._file.write(bytes('foo%sbar%sfred%sbob?????' %
1660 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001661 self._test_readlines(mailbox._PartialFile(self._file, 0,
1662 13 + 3 * len(os.linesep)))
1663
1664 def test_iteration(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001665 self._file.write(bytes('____foo%sbar%sfred%sbob####' %
1666 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001667 self._test_iteration(mailbox._PartialFile(self._file, 4,
1668 17 + 3 * len(os.linesep)))
1669
1670 def test_seek_and_tell(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001671 self._file.write(bytes('(((foo%sbar%s$$$' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001672 self._test_seek_and_tell(mailbox._PartialFile(self._file, 3,
1673 9 + 2 * len(os.linesep)))
1674
1675 def test_close(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001676 self._file.write(bytes('&foo%sbar%s^' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001677 self._test_close(mailbox._PartialFile(self._file, 1,
1678 6 + 3 * len(os.linesep)))
1679
1680
1681## Start: tests from the original module (for backward compatibility).
1682
Skip Montanaro5253da12004-07-24 19:56:03 +00001683FROM_ = "From some.body@dummy.domain Sat Jul 24 13:43:35 2004\n"
Fred Drakec02bc3e2001-05-21 20:23:21 +00001684DUMMY_MESSAGE = """\
1685From: some.body@dummy.domain
1686To: me@my.domain
Skip Montanaro5253da12004-07-24 19:56:03 +00001687Subject: Simple Test
Fred Drakec02bc3e2001-05-21 20:23:21 +00001688
1689This is a dummy message.
1690"""
1691
Fred Drakec02bc3e2001-05-21 20:23:21 +00001692class MaildirTestCase(unittest.TestCase):
1693
1694 def setUp(self):
1695 # create a new maildir mailbox to work with:
1696 self._dir = test_support.TESTFN
1697 os.mkdir(self._dir)
1698 os.mkdir(os.path.join(self._dir, "cur"))
1699 os.mkdir(os.path.join(self._dir, "tmp"))
1700 os.mkdir(os.path.join(self._dir, "new"))
1701 self._counter = 1
1702 self._msgfiles = []
1703
1704 def tearDown(self):
Guido van Rossumc1f779c2007-07-03 08:25:58 +00001705 list(map(os.unlink, self._msgfiles))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001706 os.rmdir(os.path.join(self._dir, "cur"))
1707 os.rmdir(os.path.join(self._dir, "tmp"))
1708 os.rmdir(os.path.join(self._dir, "new"))
1709 os.rmdir(self._dir)
1710
Skip Montanaro5253da12004-07-24 19:56:03 +00001711 def createMessage(self, dir, mbox=False):
Jack Jansen97df7b62001-06-19 20:20:05 +00001712 t = int(time.time() % 1000000)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001713 pid = self._counter
1714 self._counter += 1
Skip Montanaro7a98be22007-08-16 14:35:24 +00001715 filename = ".".join((str(t), str(pid), "myhostname", "mydomain"))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001716 tmpname = os.path.join(self._dir, "tmp", filename)
1717 newname = os.path.join(self._dir, dir, filename)
1718 fp = open(tmpname, "w")
1719 self._msgfiles.append(tmpname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001720 if mbox:
1721 fp.write(FROM_)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001722 fp.write(DUMMY_MESSAGE)
1723 fp.close()
Tim Peters6626c1f2001-05-22 16:29:01 +00001724 if hasattr(os, "link"):
1725 os.link(tmpname, newname)
1726 else:
1727 fp = open(newname, "w")
1728 fp.write(DUMMY_MESSAGE)
1729 fp.close()
Fred Drakec02bc3e2001-05-21 20:23:21 +00001730 self._msgfiles.append(newname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001731 return tmpname
Fred Drakec02bc3e2001-05-21 20:23:21 +00001732
1733 def test_empty_maildir(self):
1734 """Test an empty maildir mailbox"""
1735 # Test for regression on bug #117490:
1736 # Make sure the boxes attribute actually gets set.
1737 self.mbox = mailbox.Maildir(test_support.TESTFN)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001738 #self.assert_(hasattr(self.mbox, "boxes"))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001739 #self.assertEqual(len(self.mbox.boxes), 0)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001740 self.assert_(self.mbox.next() is None)
1741 self.assert_(self.mbox.next() is None)
1742
1743 def test_nonempty_maildir_cur(self):
1744 self.createMessage("cur")
1745 self.mbox = mailbox.Maildir(test_support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001746 #self.assertEqual(len(self.mbox.boxes), 1)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001747 self.assert_(self.mbox.next() is not None)
1748 self.assert_(self.mbox.next() is None)
1749 self.assert_(self.mbox.next() is None)
1750
1751 def test_nonempty_maildir_new(self):
1752 self.createMessage("new")
1753 self.mbox = mailbox.Maildir(test_support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001754 #self.assertEqual(len(self.mbox.boxes), 1)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001755 self.assert_(self.mbox.next() is not None)
1756 self.assert_(self.mbox.next() is None)
1757 self.assert_(self.mbox.next() is None)
1758
1759 def test_nonempty_maildir_both(self):
1760 self.createMessage("cur")
1761 self.createMessage("new")
1762 self.mbox = mailbox.Maildir(test_support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001763 #self.assertEqual(len(self.mbox.boxes), 2)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001764 self.assert_(self.mbox.next() is not None)
1765 self.assert_(self.mbox.next() is not None)
1766 self.assert_(self.mbox.next() is None)
1767 self.assert_(self.mbox.next() is None)
Fred Drake0aaed272000-10-23 13:39:15 +00001768
Skip Montanaro5253da12004-07-24 19:56:03 +00001769 def test_unix_mbox(self):
1770 ### should be better!
Thomas Woutersb2137042007-02-01 18:02:27 +00001771 import email.parser
Skip Montanaro5253da12004-07-24 19:56:03 +00001772 fname = self.createMessage("cur", True)
1773 n = 0
1774 for msg in mailbox.PortableUnixMailbox(open(fname),
Thomas Woutersb2137042007-02-01 18:02:27 +00001775 email.parser.Parser().parse):
Skip Montanaro5253da12004-07-24 19:56:03 +00001776 n += 1
1777 self.assertEqual(msg["subject"], "Simple Test")
Guido van Rossum671117a2007-08-31 04:25:05 +00001778 # XXX Disabled until we figure out how to fix this
1779 ##self.assertEqual(len(str(msg)), len(FROM_)+len(DUMMY_MESSAGE))
Skip Montanaro5253da12004-07-24 19:56:03 +00001780 self.assertEqual(n, 1)
1781
Thomas Wouters477c8d52006-05-27 19:21:47 +00001782## End: classes from the original module (for backward compatibility).
1783
1784
1785_sample_message = """\
1786Return-Path: <gkj@gregorykjohnson.com>
1787X-Original-To: gkj+person@localhost
1788Delivered-To: gkj+person@localhost
1789Received: from localhost (localhost [127.0.0.1])
1790 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1791 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
1792Delivered-To: gkj@sundance.gregorykjohnson.com
1793Received: from localhost [127.0.0.1]
1794 by localhost with POP3 (fetchmail-6.2.5)
1795 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
1796Received: from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
1797 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1798 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
1799Received: by andy.gregorykjohnson.com (Postfix, from userid 1000)
1800 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
1801Date: Wed, 13 Jul 2005 17:23:11 -0400
1802From: "Gregory K. Johnson" <gkj@gregorykjohnson.com>
1803To: gkj@gregorykjohnson.com
1804Subject: Sample message
1805Message-ID: <20050713212311.GC4701@andy.gregorykjohnson.com>
1806Mime-Version: 1.0
1807Content-Type: multipart/mixed; boundary="NMuMz9nt05w80d4+"
1808Content-Disposition: inline
1809User-Agent: Mutt/1.5.9i
1810
1811
1812--NMuMz9nt05w80d4+
1813Content-Type: text/plain; charset=us-ascii
1814Content-Disposition: inline
1815
1816This is a sample message.
1817
1818--
1819Gregory K. Johnson
1820
1821--NMuMz9nt05w80d4+
1822Content-Type: application/octet-stream
1823Content-Disposition: attachment; filename="text.gz"
1824Content-Transfer-Encoding: base64
1825
1826H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
18273FYlAAAA
1828
1829--NMuMz9nt05w80d4+--
1830"""
1831
1832_sample_headers = {
1833 "Return-Path":"<gkj@gregorykjohnson.com>",
1834 "X-Original-To":"gkj+person@localhost",
1835 "Delivered-To":"gkj+person@localhost",
1836 "Received":"""from localhost (localhost [127.0.0.1])
1837 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1838 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
1839 "Delivered-To":"gkj@sundance.gregorykjohnson.com",
1840 "Received":"""from localhost [127.0.0.1]
1841 by localhost with POP3 (fetchmail-6.2.5)
1842 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
1843 "Received":"""from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
1844 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1845 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
1846 "Received":"""by andy.gregorykjohnson.com (Postfix, from userid 1000)
1847 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
1848 "Date":"Wed, 13 Jul 2005 17:23:11 -0400",
1849 "From":""""Gregory K. Johnson" <gkj@gregorykjohnson.com>""",
1850 "To":"gkj@gregorykjohnson.com",
1851 "Subject":"Sample message",
1852 "Mime-Version":"1.0",
1853 "Content-Type":"""multipart/mixed; boundary="NMuMz9nt05w80d4+\"""",
1854 "Content-Disposition":"inline",
1855 "User-Agent": "Mutt/1.5.9i" }
1856
1857_sample_payloads = ("""This is a sample message.
1858
1859--
1860Gregory K. Johnson
1861""",
1862"""H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
18633FYlAAAA
1864""")
Fred Drake0aaed272000-10-23 13:39:15 +00001865
Fred Drakec02bc3e2001-05-21 20:23:21 +00001866
Fred Drake2e2be372001-09-20 21:33:42 +00001867def test_main():
Thomas Wouters477c8d52006-05-27 19:21:47 +00001868 tests = (TestMailboxSuperclass, TestMaildir, TestMbox, TestMMDF, TestMH,
1869 TestBabyl, TestMessage, TestMaildirMessage, TestMboxMessage,
1870 TestMHMessage, TestBabylMessage, TestMMDFMessage,
1871 TestMessageConversion, TestProxyFile, TestPartialFile,
1872 MaildirTestCase)
1873 test_support.run_unittest(*tests)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001874 test_support.reap_children()
Fred Drake2e2be372001-09-20 21:33:42 +00001875
1876
Thomas Wouters477c8d52006-05-27 19:21:47 +00001877if __name__ == '__main__':
Fred Drake2e2be372001-09-20 21:33:42 +00001878 test_main()