blob: e14516d533bc09aee33f2d976c99b3772a5cb98b [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
Christian Heimesf6cd9672008-03-26 13:45:42 +0000377 self._test_flush_or_close(self._box.flush, True)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000378
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
Christian Heimesf6cd9672008-03-26 13:45:42 +0000389 self._test_flush_or_close(self._box.close, False)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000390
Christian Heimesf6cd9672008-03-26 13:45:42 +0000391 def _test_flush_or_close(self, method, should_call_close):
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()
Christian Heimesf6cd9672008-03-26 13:45:42 +0000398 if should_call_close:
399 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000400 self._box = self._factory(self._path)
401 keys = self._box.keys()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000402 self.assertEqual(len(keys), 3)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000403 for key in keys:
404 self.assert_(self._box.get_string(key) in contents)
Guido van Rossumc12a8132007-10-26 04:29:23 +0000405 oldbox.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000406
407 def test_dump_message(self):
408 # Write message representations to disk
409 for input in (email.message_from_string(_sample_message),
Guido van Rossum34d19282007-08-09 01:03:29 +0000410 _sample_message, io.StringIO(_sample_message)):
411 output = io.StringIO()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000412 self._box._dump_message(input, output)
Amaury Forgeot d'Arc9edef042008-03-26 19:49:26 +0000413 self.assertEqual(output.getvalue(), _sample_message)
Guido van Rossum34d19282007-08-09 01:03:29 +0000414 output = io.StringIO()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000415 self.assertRaises(TypeError,
416 lambda: self._box._dump_message(None, output))
417
418 def _get_lock_path(self):
419 # Return the path of the dot lock file. May be overridden.
420 return self._path + '.lock'
421
422
423class TestMailboxSuperclass(TestBase):
424
425 def test_notimplemented(self):
426 # Test that all Mailbox methods raise NotImplementedException.
427 box = mailbox.Mailbox('path')
428 self.assertRaises(NotImplementedError, lambda: box.add(''))
429 self.assertRaises(NotImplementedError, lambda: box.remove(''))
430 self.assertRaises(NotImplementedError, lambda: box.__delitem__(''))
431 self.assertRaises(NotImplementedError, lambda: box.discard(''))
432 self.assertRaises(NotImplementedError, lambda: box.__setitem__('', ''))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000433 self.assertRaises(NotImplementedError, lambda: box.keys())
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000434 self.assertRaises(NotImplementedError, lambda: box.keys())
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000435 self.assertRaises(NotImplementedError, lambda: box.values().__next__())
436 self.assertRaises(NotImplementedError, lambda: box.__iter__().__next__())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000437 self.assertRaises(NotImplementedError, lambda: box.values())
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000438 self.assertRaises(NotImplementedError, lambda: box.items().next())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000439 self.assertRaises(NotImplementedError, lambda: box.items())
440 self.assertRaises(NotImplementedError, lambda: box.get(''))
441 self.assertRaises(NotImplementedError, lambda: box.__getitem__(''))
442 self.assertRaises(NotImplementedError, lambda: box.get_message(''))
443 self.assertRaises(NotImplementedError, lambda: box.get_string(''))
444 self.assertRaises(NotImplementedError, lambda: box.get_file(''))
Guido van Rossume2b70bc2006-08-18 22:13:04 +0000445 self.assertRaises(NotImplementedError, lambda: '' in box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000446 self.assertRaises(NotImplementedError, lambda: box.__contains__(''))
447 self.assertRaises(NotImplementedError, lambda: box.__len__())
448 self.assertRaises(NotImplementedError, lambda: box.clear())
449 self.assertRaises(NotImplementedError, lambda: box.pop(''))
450 self.assertRaises(NotImplementedError, lambda: box.popitem())
451 self.assertRaises(NotImplementedError, lambda: box.update((('', ''),)))
452 self.assertRaises(NotImplementedError, lambda: box.flush())
453 self.assertRaises(NotImplementedError, lambda: box.lock())
454 self.assertRaises(NotImplementedError, lambda: box.unlock())
455 self.assertRaises(NotImplementedError, lambda: box.close())
456
457
458class TestMaildir(TestMailbox):
459
460 _factory = lambda self, path, factory=None: mailbox.Maildir(path, factory)
461
462 def setUp(self):
463 TestMailbox.setUp(self)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000464 if os.name in ('nt', 'os2') or sys.platform == 'cygwin':
Thomas Wouters477c8d52006-05-27 19:21:47 +0000465 self._box.colon = '!'
466
467 def test_add_MM(self):
468 # Add a MaildirMessage instance
469 msg = mailbox.MaildirMessage(self._template % 0)
470 msg.set_subdir('cur')
471 msg.set_info('foo')
472 key = self._box.add(msg)
473 self.assert_(os.path.exists(os.path.join(self._path, 'cur', '%s%sfoo' %
474 (key, self._box.colon))))
475
476 def test_get_MM(self):
477 # Get a MaildirMessage instance
478 msg = mailbox.MaildirMessage(self._template % 0)
479 msg.set_subdir('cur')
480 msg.set_flags('RF')
481 key = self._box.add(msg)
482 msg_returned = self._box.get_message(key)
483 self.assert_(isinstance(msg_returned, mailbox.MaildirMessage))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000484 self.assertEqual(msg_returned.get_subdir(), 'cur')
485 self.assertEqual(msg_returned.get_flags(), 'FR')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000486
487 def test_set_MM(self):
488 # Set with a MaildirMessage instance
489 msg0 = mailbox.MaildirMessage(self._template % 0)
490 msg0.set_flags('TP')
491 key = self._box.add(msg0)
492 msg_returned = self._box.get_message(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000493 self.assertEqual(msg_returned.get_subdir(), 'new')
494 self.assertEqual(msg_returned.get_flags(), 'PT')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000495 msg1 = mailbox.MaildirMessage(self._template % 1)
496 self._box[key] = msg1
497 msg_returned = self._box.get_message(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000498 self.assertEqual(msg_returned.get_subdir(), 'new')
499 self.assertEqual(msg_returned.get_flags(), '')
500 self.assertEqual(msg_returned.get_payload(), '1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000501 msg2 = mailbox.MaildirMessage(self._template % 2)
502 msg2.set_info('2,S')
503 self._box[key] = msg2
504 self._box[key] = self._template % 3
505 msg_returned = self._box.get_message(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000506 self.assertEqual(msg_returned.get_subdir(), 'new')
507 self.assertEqual(msg_returned.get_flags(), 'S')
508 self.assertEqual(msg_returned.get_payload(), '3')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000509
Christian Heimesfdab48e2008-01-20 09:06:41 +0000510 def test_consistent_factory(self):
511 # Add a message.
512 msg = mailbox.MaildirMessage(self._template % 0)
513 msg.set_subdir('cur')
514 msg.set_flags('RF')
515 key = self._box.add(msg)
516
517 # Create new mailbox with
518 class FakeMessage(mailbox.MaildirMessage):
519 pass
520 box = mailbox.Maildir(self._path, factory=FakeMessage)
Christian Heimes15ebc882008-02-04 18:48:49 +0000521 box.colon = self._box.colon
Christian Heimesfdab48e2008-01-20 09:06:41 +0000522 msg2 = box.get_message(key)
523 self.assert_(isinstance(msg2, FakeMessage))
524
Thomas Wouters477c8d52006-05-27 19:21:47 +0000525 def test_initialize_new(self):
526 # Initialize a non-existent mailbox
527 self.tearDown()
528 self._box = mailbox.Maildir(self._path)
529 self._check_basics(factory=rfc822.Message)
530 self._delete_recursively(self._path)
531 self._box = self._factory(self._path, factory=None)
532 self._check_basics()
533
534 def test_initialize_existing(self):
535 # Initialize an existing mailbox
536 self.tearDown()
537 for subdir in '', 'tmp', 'new', 'cur':
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000538 os.mkdir(os.path.normpath(os.path.join(self._path, subdir)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000539 self._box = mailbox.Maildir(self._path)
540 self._check_basics(factory=rfc822.Message)
541 self._box = mailbox.Maildir(self._path, factory=None)
542 self._check_basics()
543
544 def _check_basics(self, factory=None):
545 # (Used by test_open_new() and test_open_existing().)
546 self.assertEqual(self._box._path, os.path.abspath(self._path))
547 self.assertEqual(self._box._factory, factory)
548 for subdir in '', 'tmp', 'new', 'cur':
549 path = os.path.join(self._path, subdir)
550 mode = os.stat(path)[stat.ST_MODE]
551 self.assert_(stat.S_ISDIR(mode), "Not a directory: '%s'" % path)
552
553 def test_list_folders(self):
554 # List folders
555 self._box.add_folder('one')
556 self._box.add_folder('two')
557 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000558 self.assertEqual(len(self._box.list_folders()), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000559 self.assertEqual(set(self._box.list_folders()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000560 set(('one', 'two', 'three')))
561
562 def test_get_folder(self):
563 # Open folders
564 self._box.add_folder('foo.bar')
565 folder0 = self._box.get_folder('foo.bar')
566 folder0.add(self._template % 'bar')
567 self.assert_(os.path.isdir(os.path.join(self._path, '.foo.bar')))
568 folder1 = self._box.get_folder('foo.bar')
Guido van Rossumea834472007-07-27 05:17:50 +0000569 self.assertEqual(folder1.get_string(folder1.keys()[0]),
570 self._template % 'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000571
572 def test_add_and_remove_folders(self):
573 # Delete folders
574 self._box.add_folder('one')
575 self._box.add_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000576 self.assertEqual(len(self._box.list_folders()), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000577 self.assert_(set(self._box.list_folders()) == set(('one', 'two')))
578 self._box.remove_folder('one')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000579 self.assertEqual(len(self._box.list_folders()), 1)
580 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000581 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000582 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000583 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000584 self._box.remove_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000585 self.assertEqual(len(self._box.list_folders()), 1)
586 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000587 self._box.remove_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000588 self.assertEqual(len(self._box.list_folders()), 0)
589 self.assertEqual(self._box.list_folders(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000590
591 def test_clean(self):
592 # Remove old files from 'tmp'
593 foo_path = os.path.join(self._path, 'tmp', 'foo')
594 bar_path = os.path.join(self._path, 'tmp', 'bar')
595 f = open(foo_path, 'w')
596 f.write("@")
597 f.close()
598 f = open(bar_path, 'w')
599 f.write("@")
600 f.close()
601 self._box.clean()
602 self.assert_(os.path.exists(foo_path))
603 self.assert_(os.path.exists(bar_path))
604 foo_stat = os.stat(foo_path)
605 os.utime(foo_path, (time.time() - 129600 - 2,
606 foo_stat.st_mtime))
607 self._box.clean()
608 self.assert_(not os.path.exists(foo_path))
609 self.assert_(os.path.exists(bar_path))
610
611 def test_create_tmp(self, repetitions=10):
612 # Create files in tmp directory
613 hostname = socket.gethostname()
614 if '/' in hostname:
615 hostname = hostname.replace('/', r'\057')
616 if ':' in hostname:
617 hostname = hostname.replace(':', r'\072')
618 pid = os.getpid()
619 pattern = re.compile(r"(?P<time>\d+)\.M(?P<M>\d{1,6})P(?P<P>\d+)"
620 r"Q(?P<Q>\d+)\.(?P<host>[^:/]+)")
621 previous_groups = None
Guido van Rossum805365e2007-05-07 22:24:25 +0000622 for x in range(repetitions):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000623 tmp_file = self._box._create_tmp()
624 head, tail = os.path.split(tmp_file.name)
625 self.assertEqual(head, os.path.abspath(os.path.join(self._path,
626 "tmp")),
627 "File in wrong location: '%s'" % head)
628 match = pattern.match(tail)
Benjamin Peterson2a691a82008-03-31 01:51:45 +0000629 self.assert_(match is not None, "Invalid file name: '%s'" % tail)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000630 groups = match.groups()
Benjamin Peterson2a691a82008-03-31 01:51:45 +0000631 if previous_groups is not None:
Thomas Wouters477c8d52006-05-27 19:21:47 +0000632 self.assert_(int(groups[0] >= previous_groups[0]),
633 "Non-monotonic seconds: '%s' before '%s'" %
634 (previous_groups[0], groups[0]))
635 self.assert_(int(groups[1] >= previous_groups[1]) or
636 groups[0] != groups[1],
637 "Non-monotonic milliseconds: '%s' before '%s'" %
638 (previous_groups[1], groups[1]))
Guido van Rossumea834472007-07-27 05:17:50 +0000639 self.assertEqual(int(groups[2]), pid,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000640 "Process ID mismatch: '%s' should be '%s'" %
641 (groups[2], pid))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000642 self.assertEqual(int(groups[3]), int(previous_groups[3]) + 1,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000643 "Non-sequential counter: '%s' before '%s'" %
644 (previous_groups[3], groups[3]))
Guido van Rossumea834472007-07-27 05:17:50 +0000645 self.assertEqual(groups[4], hostname,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000646 "Host name mismatch: '%s' should be '%s'" %
647 (groups[4], hostname))
648 previous_groups = groups
649 tmp_file.write(_sample_message)
650 tmp_file.seek(0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000651 self.assertEqual(tmp_file.read(), _sample_message)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000652 tmp_file.close()
653 file_count = len(os.listdir(os.path.join(self._path, "tmp")))
Guido van Rossumea834472007-07-27 05:17:50 +0000654 self.assertEqual(file_count, repetitions,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000655 "Wrong file count: '%s' should be '%s'" %
656 (file_count, repetitions))
657
658 def test_refresh(self):
659 # Update the table of contents
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000660 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000661 key0 = self._box.add(self._template % 0)
662 key1 = self._box.add(self._template % 1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000663 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000664 self._box._refresh()
Guido van Rossumea834472007-07-27 05:17:50 +0000665 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
666 key1: os.path.join('new', key1)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000667 key2 = self._box.add(self._template % 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000668 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
669 key1: os.path.join('new', key1)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000670 self._box._refresh()
Guido van Rossumea834472007-07-27 05:17:50 +0000671 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
672 key1: os.path.join('new', key1),
673 key2: os.path.join('new', key2)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000674
675 def test_lookup(self):
676 # Look up message subpaths in the TOC
677 self.assertRaises(KeyError, lambda: self._box._lookup('foo'))
678 key0 = self._box.add(self._template % 0)
Guido van Rossumea834472007-07-27 05:17:50 +0000679 self.assertEqual(self._box._lookup(key0), os.path.join('new', key0))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000680 os.remove(os.path.join(self._path, 'new', key0))
Guido van Rossumea834472007-07-27 05:17:50 +0000681 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000682 self.assertRaises(KeyError, lambda: self._box._lookup(key0))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000683 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000684
685 def test_lock_unlock(self):
686 # Lock and unlock the mailbox. For Maildir, this does nothing.
687 self._box.lock()
688 self._box.unlock()
689
Thomas Wouters89f507f2006-12-13 04:49:30 +0000690 def test_folder (self):
691 # Test for bug #1569790: verify that folders returned by .get_folder()
692 # use the same factory function.
693 def dummy_factory (s):
694 return None
695 box = self._factory(self._path, factory=dummy_factory)
696 folder = box.add_folder('folder1')
697 self.assert_(folder._factory is dummy_factory)
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000698
Thomas Wouters89f507f2006-12-13 04:49:30 +0000699 folder1_alias = box.get_folder('folder1')
700 self.assert_(folder1_alias._factory is dummy_factory)
701
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000702 def test_directory_in_folder (self):
703 # Test that mailboxes still work if there's a stray extra directory
704 # in a folder.
705 for i in range(10):
706 self._box.add(mailbox.Message(_sample_message))
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000707
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000708 # Create a stray directory
709 os.mkdir(os.path.join(self._path, 'cur', 'stray-dir'))
710
711 # Check that looping still works with the directory present.
712 for msg in self._box:
713 pass
Thomas Wouters477c8d52006-05-27 19:21:47 +0000714
715class _TestMboxMMDF(TestMailbox):
716
717 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +0000718 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000719 self._delete_recursively(self._path)
720 for lock_remnant in glob.glob(self._path + '.*'):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000721 test_support.unlink(lock_remnant)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000722
723 def test_add_from_string(self):
724 # Add a string starting with 'From ' to the mailbox
725 key = self._box.add('From foo@bar blah\nFrom: foo\n\n0')
Guido van Rossumea834472007-07-27 05:17:50 +0000726 self.assertEqual(self._box[key].get_from(), 'foo@bar blah')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000727 self.assertEqual(self._box[key].get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000728
729 def test_add_mbox_or_mmdf_message(self):
730 # Add an mboxMessage or MMDFMessage
731 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
732 msg = class_('From foo@bar blah\nFrom: foo\n\n0')
733 key = self._box.add(msg)
734
735 def test_open_close_open(self):
736 # Open and inspect previously-created mailbox
Guido van Rossum805365e2007-05-07 22:24:25 +0000737 values = [self._template % i for i in range(3)]
Thomas Wouters477c8d52006-05-27 19:21:47 +0000738 for value in values:
739 self._box.add(value)
740 self._box.close()
741 mtime = os.path.getmtime(self._path)
742 self._box = self._factory(self._path)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000743 self.assertEqual(len(self._box), 3)
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000744 for key in self._box.keys():
Thomas Wouters477c8d52006-05-27 19:21:47 +0000745 self.assert_(self._box.get_string(key) in values)
746 self._box.close()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000747 self.assertEqual(mtime, os.path.getmtime(self._path))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000748
749 def test_add_and_close(self):
750 # Verifying that closing a mailbox doesn't change added items
751 self._box.add(_sample_message)
Guido van Rossum805365e2007-05-07 22:24:25 +0000752 for i in range(3):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000753 self._box.add(self._template % i)
754 self._box.add(_sample_message)
755 self._box._file.flush()
756 self._box._file.seek(0)
757 contents = self._box._file.read()
758 self._box.close()
Amaury Forgeot d'Arc9edef042008-03-26 19:49:26 +0000759 self.assertEqual(contents, open(self._path, 'r', newline='').read())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000760 self._box = self._factory(self._path)
761
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000762 def test_lock_conflict(self):
763 # Fork off a subprocess that will lock the file for 2 seconds,
764 # unlock it, and then exit.
765 if not hasattr(os, 'fork'):
766 return
767 pid = os.fork()
768 if pid == 0:
769 # In the child, lock the mailbox.
Guido van Rossum62cbc8a2007-04-09 00:41:25 +0000770 try:
771 self._box.lock()
772 time.sleep(2)
773 self._box.unlock()
774 finally:
775 os._exit(0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000776
777 # In the parent, sleep a bit to give the child time to acquire
778 # the lock.
779 time.sleep(0.5)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000780 try:
781 self.assertRaises(mailbox.ExternalClashError,
782 self._box.lock)
783 finally:
784 # Wait for child to exit. Locking should now succeed.
785 exited_pid, status = os.waitpid(pid, 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000786
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000787 self._box.lock()
788 self._box.unlock()
789
Thomas Wouters89f507f2006-12-13 04:49:30 +0000790 def test_relock(self):
791 # Test case for bug #1575506: the mailbox class was locking the
792 # wrong file object in its flush() method.
793 msg = "Subject: sub\n\nbody\n"
794 key1 = self._box.add(msg)
795 self._box.flush()
796 self._box.close()
797
798 self._box = self._factory(self._path)
799 self._box.lock()
800 key2 = self._box.add(msg)
801 self._box.flush()
802 self.assert_(self._box._locked)
803 self._box.close()
804
805
Thomas Wouters477c8d52006-05-27 19:21:47 +0000806
807class TestMbox(_TestMboxMMDF):
808
809 _factory = lambda self, path, factory=None: mailbox.mbox(path, factory)
810
811
812class TestMMDF(_TestMboxMMDF):
813
814 _factory = lambda self, path, factory=None: mailbox.MMDF(path, factory)
815
816
817class TestMH(TestMailbox):
818
819 _factory = lambda self, path, factory=None: mailbox.MH(path, factory)
820
821 def test_list_folders(self):
822 # List folders
823 self._box.add_folder('one')
824 self._box.add_folder('two')
825 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000826 self.assertEqual(len(self._box.list_folders()), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000827 self.assertEqual(set(self._box.list_folders()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000828 set(('one', 'two', 'three')))
829
830 def test_get_folder(self):
831 # Open folders
Thomas Wouters89f507f2006-12-13 04:49:30 +0000832 def dummy_factory (s):
833 return None
834 self._box = self._factory(self._path, dummy_factory)
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000835
Thomas Wouters89f507f2006-12-13 04:49:30 +0000836 new_folder = self._box.add_folder('foo.bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000837 folder0 = self._box.get_folder('foo.bar')
838 folder0.add(self._template % 'bar')
839 self.assert_(os.path.isdir(os.path.join(self._path, 'foo.bar')))
840 folder1 = self._box.get_folder('foo.bar')
Guido van Rossumea834472007-07-27 05:17:50 +0000841 self.assertEqual(folder1.get_string(folder1.keys()[0]),
842 self._template % 'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000843
Thomas Wouters89f507f2006-12-13 04:49:30 +0000844 # Test for bug #1569790: verify that folders returned by .get_folder()
845 # use the same factory function.
846 self.assert_(new_folder._factory is self._box._factory)
847 self.assert_(folder0._factory is self._box._factory)
848
Thomas Wouters477c8d52006-05-27 19:21:47 +0000849 def test_add_and_remove_folders(self):
850 # Delete folders
851 self._box.add_folder('one')
852 self._box.add_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000853 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000854 self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000855 self._box.remove_folder('one')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000856 self.assertEqual(len(self._box.list_folders()), 1)
857 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000858 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000859 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000860 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000861 self._box.remove_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000862 self.assertEqual(len(self._box.list_folders()), 1)
863 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000864 self._box.remove_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000865 self.assertEqual(len(self._box.list_folders()), 0)
866 self.assertEqual(self._box.list_folders(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000867
868 def test_sequences(self):
869 # Get and set sequences
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000870 self.assertEqual(self._box.get_sequences(), {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000871 msg0 = mailbox.MHMessage(self._template % 0)
872 msg0.add_sequence('foo')
873 key0 = self._box.add(msg0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000874 self.assertEqual(self._box.get_sequences(), {'foo':[key0]})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000875 msg1 = mailbox.MHMessage(self._template % 1)
876 msg1.set_sequences(['bar', 'replied', 'foo'])
877 key1 = self._box.add(msg1)
Guido van Rossumea834472007-07-27 05:17:50 +0000878 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000879 {'foo':[key0, key1], 'bar':[key1], 'replied':[key1]})
880 msg0.set_sequences(['flagged'])
881 self._box[key0] = msg0
Guido van Rossumea834472007-07-27 05:17:50 +0000882 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000883 {'foo':[key1], 'bar':[key1], 'replied':[key1],
884 'flagged':[key0]})
885 self._box.remove(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000886 self.assertEqual(self._box.get_sequences(), {'flagged':[key0]})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000887
888 def test_pack(self):
889 # Pack the contents of the mailbox
890 msg0 = mailbox.MHMessage(self._template % 0)
891 msg1 = mailbox.MHMessage(self._template % 1)
892 msg2 = mailbox.MHMessage(self._template % 2)
893 msg3 = mailbox.MHMessage(self._template % 3)
894 msg0.set_sequences(['foo', 'unseen'])
895 msg1.set_sequences(['foo'])
896 msg2.set_sequences(['foo', 'flagged'])
897 msg3.set_sequences(['foo', 'bar', 'replied'])
898 key0 = self._box.add(msg0)
899 key1 = self._box.add(msg1)
900 key2 = self._box.add(msg2)
901 key3 = self._box.add(msg3)
Guido van Rossumea834472007-07-27 05:17:50 +0000902 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000903 {'foo':[key0,key1,key2,key3], 'unseen':[key0],
904 'flagged':[key2], 'bar':[key3], 'replied':[key3]})
905 self._box.remove(key2)
Guido van Rossumea834472007-07-27 05:17:50 +0000906 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000907 {'foo':[key0,key1,key3], 'unseen':[key0], 'bar':[key3],
908 'replied':[key3]})
909 self._box.pack()
910 self.assert_(self._box.keys() == [1, 2, 3])
911 key0 = key0
912 key1 = key0 + 1
913 key2 = key1 + 1
Guido van Rossumea834472007-07-27 05:17:50 +0000914 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000915 {'foo':[1, 2, 3], 'unseen':[1], 'bar':[3], 'replied':[3]})
916
Thomas Wouters89f507f2006-12-13 04:49:30 +0000917 # Test case for packing while holding the mailbox locked.
918 key0 = self._box.add(msg1)
919 key1 = self._box.add(msg1)
920 key2 = self._box.add(msg1)
921 key3 = self._box.add(msg1)
922
923 self._box.remove(key0)
924 self._box.remove(key2)
925 self._box.lock()
926 self._box.pack()
927 self._box.unlock()
Guido van Rossumea834472007-07-27 05:17:50 +0000928 self.assertEqual(self._box.get_sequences(),
Thomas Wouters89f507f2006-12-13 04:49:30 +0000929 {'foo':[1, 2, 3, 4, 5],
930 'unseen':[1], 'bar':[3], 'replied':[3]})
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000931
Thomas Wouters477c8d52006-05-27 19:21:47 +0000932 def _get_lock_path(self):
933 return os.path.join(self._path, '.mh_sequences.lock')
934
935
936class TestBabyl(TestMailbox):
937
938 _factory = lambda self, path, factory=None: mailbox.Babyl(path, factory)
939
940 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +0000941 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000942 self._delete_recursively(self._path)
943 for lock_remnant in glob.glob(self._path + '.*'):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000944 test_support.unlink(lock_remnant)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000945
946 def test_labels(self):
947 # Get labels from the mailbox
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000948 self.assertEqual(self._box.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000949 msg0 = mailbox.BabylMessage(self._template % 0)
950 msg0.add_label('foo')
951 key0 = self._box.add(msg0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000952 self.assertEqual(self._box.get_labels(), ['foo'])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000953 msg1 = mailbox.BabylMessage(self._template % 1)
954 msg1.set_labels(['bar', 'answered', 'foo'])
955 key1 = self._box.add(msg1)
Guido van Rossumea834472007-07-27 05:17:50 +0000956 self.assertEqual(set(self._box.get_labels()), set(['foo', 'bar']))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000957 msg0.set_labels(['blah', 'filed'])
958 self._box[key0] = msg0
Guido van Rossumea834472007-07-27 05:17:50 +0000959 self.assertEqual(set(self._box.get_labels()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000960 set(['foo', 'bar', 'blah']))
961 self._box.remove(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000962 self.assertEqual(set(self._box.get_labels()), set(['blah']))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000963
964
965class TestMessage(TestBase):
966
967 _factory = mailbox.Message # Overridden by subclasses to reuse tests
968
969 def setUp(self):
970 self._path = test_support.TESTFN
971
972 def tearDown(self):
973 self._delete_recursively(self._path)
974
975 def test_initialize_with_eMM(self):
Thomas Woutersb2137042007-02-01 18:02:27 +0000976 # Initialize based on email.message.Message instance
Thomas Wouters477c8d52006-05-27 19:21:47 +0000977 eMM = email.message_from_string(_sample_message)
978 msg = self._factory(eMM)
979 self._post_initialize_hook(msg)
980 self._check_sample(msg)
981
982 def test_initialize_with_string(self):
983 # Initialize based on string
984 msg = self._factory(_sample_message)
985 self._post_initialize_hook(msg)
986 self._check_sample(msg)
987
988 def test_initialize_with_file(self):
989 # Initialize based on contents of file
990 f = open(self._path, 'w+')
991 f.write(_sample_message)
992 f.seek(0)
993 msg = self._factory(f)
994 self._post_initialize_hook(msg)
995 self._check_sample(msg)
996 f.close()
997
998 def test_initialize_with_nothing(self):
999 # Initialize without arguments
1000 msg = self._factory()
1001 self._post_initialize_hook(msg)
Thomas Woutersb2137042007-02-01 18:02:27 +00001002 self.assert_(isinstance(msg, email.message.Message))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001003 self.assert_(isinstance(msg, mailbox.Message))
1004 self.assert_(isinstance(msg, self._factory))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001005 self.assertEqual(msg.keys(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001006 self.assert_(not msg.is_multipart())
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001007 self.assertEqual(msg.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001008
1009 def test_initialize_incorrectly(self):
1010 # Initialize with invalid argument
1011 self.assertRaises(TypeError, lambda: self._factory(object()))
1012
1013 def test_become_message(self):
1014 # Take on the state of another message
1015 eMM = email.message_from_string(_sample_message)
1016 msg = self._factory()
1017 msg._become_message(eMM)
1018 self._check_sample(msg)
1019
1020 def test_explain_to(self):
1021 # Copy self's format-specific data to other message formats.
1022 # This test is superficial; better ones are in TestMessageConversion.
1023 msg = self._factory()
1024 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1025 mailbox.mboxMessage, mailbox.MHMessage,
1026 mailbox.BabylMessage, mailbox.MMDFMessage):
1027 other_msg = class_()
1028 msg._explain_to(other_msg)
Thomas Woutersb2137042007-02-01 18:02:27 +00001029 other_msg = email.message.Message()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001030 self.assertRaises(TypeError, lambda: msg._explain_to(other_msg))
1031
1032 def _post_initialize_hook(self, msg):
1033 # Overridden by subclasses to check extra things after initialization
1034 pass
1035
1036
1037class TestMaildirMessage(TestMessage):
1038
1039 _factory = mailbox.MaildirMessage
1040
1041 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001042 self.assertEqual(msg._subdir, 'new')
1043 self.assertEqual(msg._info, '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001044
1045 def test_subdir(self):
1046 # Use get_subdir() and set_subdir()
1047 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001048 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001049 msg.set_subdir('cur')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001050 self.assertEqual(msg.get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001051 msg.set_subdir('new')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001052 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001053 self.assertRaises(ValueError, lambda: msg.set_subdir('tmp'))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001054 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001055 msg.set_subdir('new')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001056 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001057 self._check_sample(msg)
1058
1059 def test_flags(self):
1060 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1061 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001062 self.assertEqual(msg.get_flags(), '')
1063 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001064 msg.set_flags('F')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001065 self.assertEqual(msg.get_subdir(), 'new')
1066 self.assertEqual(msg.get_flags(), 'F')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001067 msg.set_flags('SDTP')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001068 self.assertEqual(msg.get_flags(), 'DPST')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001069 msg.add_flag('FT')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001070 self.assertEqual(msg.get_flags(), 'DFPST')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001071 msg.remove_flag('TDRP')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001072 self.assertEqual(msg.get_flags(), 'FS')
1073 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001074 self._check_sample(msg)
1075
1076 def test_date(self):
1077 # Use get_date() and set_date()
1078 msg = mailbox.MaildirMessage(_sample_message)
1079 self.assert_(abs(msg.get_date() - time.time()) < 60)
1080 msg.set_date(0.0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001081 self.assertEqual(msg.get_date(), 0.0)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001082
1083 def test_info(self):
1084 # Use get_info() and set_info()
1085 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001086 self.assertEqual(msg.get_info(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001087 msg.set_info('1,foo=bar')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001088 self.assertEqual(msg.get_info(), '1,foo=bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001089 self.assertRaises(TypeError, lambda: msg.set_info(None))
1090 self._check_sample(msg)
1091
1092 def test_info_and_flags(self):
1093 # Test interaction of info and flag methods
1094 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001095 self.assertEqual(msg.get_info(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001096 msg.set_flags('SF')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001097 self.assertEqual(msg.get_flags(), 'FS')
1098 self.assertEqual(msg.get_info(), '2,FS')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001099 msg.set_info('1,')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001100 self.assertEqual(msg.get_flags(), '')
1101 self.assertEqual(msg.get_info(), '1,')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001102 msg.remove_flag('RPT')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001103 self.assertEqual(msg.get_flags(), '')
1104 self.assertEqual(msg.get_info(), '1,')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001105 msg.add_flag('D')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001106 self.assertEqual(msg.get_flags(), 'D')
1107 self.assertEqual(msg.get_info(), '2,D')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001108 self._check_sample(msg)
1109
1110
1111class _TestMboxMMDFMessage(TestMessage):
1112
1113 _factory = mailbox._mboxMMDFMessage
1114
1115 def _post_initialize_hook(self, msg):
1116 self._check_from(msg)
1117
1118 def test_initialize_with_unixfrom(self):
1119 # Initialize with a message that already has a _unixfrom attribute
1120 msg = mailbox.Message(_sample_message)
1121 msg.set_unixfrom('From foo@bar blah')
1122 msg = mailbox.mboxMessage(msg)
Guido van Rossumea834472007-07-27 05:17:50 +00001123 self.assertEqual(msg.get_from(), 'foo@bar blah', msg.get_from())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001124
1125 def test_from(self):
1126 # Get and set "From " line
1127 msg = mailbox.mboxMessage(_sample_message)
1128 self._check_from(msg)
1129 msg.set_from('foo bar')
Guido van Rossumea834472007-07-27 05:17:50 +00001130 self.assertEqual(msg.get_from(), 'foo bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001131 msg.set_from('foo@bar', True)
1132 self._check_from(msg, 'foo@bar')
1133 msg.set_from('blah@temp', time.localtime())
1134 self._check_from(msg, 'blah@temp')
1135
1136 def test_flags(self):
1137 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1138 msg = mailbox.mboxMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001139 self.assertEqual(msg.get_flags(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001140 msg.set_flags('F')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001141 self.assertEqual(msg.get_flags(), 'F')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001142 msg.set_flags('XODR')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001143 self.assertEqual(msg.get_flags(), 'RODX')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001144 msg.add_flag('FA')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001145 self.assertEqual(msg.get_flags(), 'RODFAX')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001146 msg.remove_flag('FDXA')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001147 self.assertEqual(msg.get_flags(), 'RO')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001148 self._check_sample(msg)
1149
1150 def _check_from(self, msg, sender=None):
1151 # Check contents of "From " line
1152 if sender is None:
1153 sender = "MAILER-DAEMON"
1154 self.assert_(re.match(sender + r" \w{3} \w{3} [\d ]\d [\d ]\d:\d{2}:"
1155 r"\d{2} \d{4}", msg.get_from()) is not None)
1156
1157
1158class TestMboxMessage(_TestMboxMMDFMessage):
1159
1160 _factory = mailbox.mboxMessage
1161
1162
1163class TestMHMessage(TestMessage):
1164
1165 _factory = mailbox.MHMessage
1166
1167 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001168 self.assertEqual(msg._sequences, [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001169
1170 def test_sequences(self):
1171 # Get, set, join, and leave sequences
1172 msg = mailbox.MHMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001173 self.assertEqual(msg.get_sequences(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001174 msg.set_sequences(['foobar'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001175 self.assertEqual(msg.get_sequences(), ['foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001176 msg.set_sequences([])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001177 self.assertEqual(msg.get_sequences(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001178 msg.add_sequence('unseen')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001179 self.assertEqual(msg.get_sequences(), ['unseen'])
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.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001183 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001184 msg.remove_sequence('unseen')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001185 self.assertEqual(msg.get_sequences(), ['flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001186 msg.add_sequence('foobar')
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.remove_sequence('replied')
Guido van Rossumea834472007-07-27 05:17:50 +00001189 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001190 msg.set_sequences(['foobar', 'replied'])
Guido van Rossumea834472007-07-27 05:17:50 +00001191 self.assertEqual(msg.get_sequences(), ['foobar', 'replied'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001192
1193
1194class TestBabylMessage(TestMessage):
1195
1196 _factory = mailbox.BabylMessage
1197
1198 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001199 self.assertEqual(msg._labels, [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001200
1201 def test_labels(self):
1202 # Get, set, join, and leave labels
1203 msg = mailbox.BabylMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001204 self.assertEqual(msg.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001205 msg.set_labels(['foobar'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001206 self.assertEqual(msg.get_labels(), ['foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001207 msg.set_labels([])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001208 self.assertEqual(msg.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001209 msg.add_label('filed')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001210 self.assertEqual(msg.get_labels(), ['filed'])
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.add_label('resent')
Guido van Rossumea834472007-07-27 05:17:50 +00001214 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001215 msg.remove_label('filed')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001216 self.assertEqual(msg.get_labels(), ['resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001217 msg.add_label('foobar')
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.remove_label('unseen')
Guido van Rossumea834472007-07-27 05:17:50 +00001220 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001221 msg.set_labels(['foobar', 'answered'])
Guido van Rossumea834472007-07-27 05:17:50 +00001222 self.assertEqual(msg.get_labels(), ['foobar', 'answered'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001223
1224 def test_visible(self):
1225 # Get, set, and update visible headers
1226 msg = mailbox.BabylMessage(_sample_message)
1227 visible = msg.get_visible()
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001228 self.assertEqual(visible.keys(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001229 self.assert_(visible.get_payload() is None)
1230 visible['User-Agent'] = 'FooBar 1.0'
1231 visible['X-Whatever'] = 'Blah'
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001232 self.assertEqual(msg.get_visible().keys(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001233 msg.set_visible(visible)
1234 visible = msg.get_visible()
1235 self.assert_(visible.keys() == ['User-Agent', 'X-Whatever'])
1236 self.assert_(visible['User-Agent'] == 'FooBar 1.0')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001237 self.assertEqual(visible['X-Whatever'], 'Blah')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001238 self.assert_(visible.get_payload() is None)
1239 msg.update_visible()
Guido van Rossumea834472007-07-27 05:17:50 +00001240 self.assertEqual(visible.keys(), ['User-Agent', 'X-Whatever'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001241 self.assert_(visible.get_payload() is None)
1242 visible = msg.get_visible()
Guido van Rossumea834472007-07-27 05:17:50 +00001243 self.assertEqual(visible.keys(), ['User-Agent', 'Date', 'From', 'To',
1244 'Subject'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001245 for header in ('User-Agent', 'Date', 'From', 'To', 'Subject'):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001246 self.assertEqual(visible[header], msg[header])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001247
1248
1249class TestMMDFMessage(_TestMboxMMDFMessage):
1250
1251 _factory = mailbox.MMDFMessage
1252
1253
1254class TestMessageConversion(TestBase):
1255
1256 def test_plain_to_x(self):
1257 # Convert Message to all formats
1258 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1259 mailbox.mboxMessage, mailbox.MHMessage,
1260 mailbox.BabylMessage, mailbox.MMDFMessage):
1261 msg_plain = mailbox.Message(_sample_message)
1262 msg = class_(msg_plain)
1263 self._check_sample(msg)
1264
1265 def test_x_to_plain(self):
1266 # Convert all formats to Message
1267 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1268 mailbox.mboxMessage, mailbox.MHMessage,
1269 mailbox.BabylMessage, mailbox.MMDFMessage):
1270 msg = class_(_sample_message)
1271 msg_plain = mailbox.Message(msg)
1272 self._check_sample(msg_plain)
1273
1274 def test_x_to_invalid(self):
1275 # Convert all formats to an invalid format
1276 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1277 mailbox.mboxMessage, mailbox.MHMessage,
1278 mailbox.BabylMessage, mailbox.MMDFMessage):
1279 self.assertRaises(TypeError, lambda: class_(False))
1280
1281 def test_maildir_to_maildir(self):
1282 # Convert MaildirMessage to MaildirMessage
1283 msg_maildir = mailbox.MaildirMessage(_sample_message)
1284 msg_maildir.set_flags('DFPRST')
1285 msg_maildir.set_subdir('cur')
1286 date = msg_maildir.get_date()
1287 msg = mailbox.MaildirMessage(msg_maildir)
1288 self._check_sample(msg)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001289 self.assertEqual(msg.get_flags(), 'DFPRST')
1290 self.assertEqual(msg.get_subdir(), 'cur')
1291 self.assertEqual(msg.get_date(), date)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001292
1293 def test_maildir_to_mboxmmdf(self):
1294 # Convert MaildirMessage to mboxmessage and MMDFMessage
1295 pairs = (('D', ''), ('F', 'F'), ('P', ''), ('R', 'A'), ('S', 'R'),
1296 ('T', 'D'), ('DFPRST', 'RDFA'))
1297 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1298 msg_maildir = mailbox.MaildirMessage(_sample_message)
1299 msg_maildir.set_date(0.0)
1300 for setting, result in pairs:
1301 msg_maildir.set_flags(setting)
1302 msg = class_(msg_maildir)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001303 self.assertEqual(msg.get_flags(), result)
Guido van Rossumea834472007-07-27 05:17:50 +00001304 self.assertEqual(msg.get_from(), 'MAILER-DAEMON %s' %
Thomas Wouters477c8d52006-05-27 19:21:47 +00001305 time.asctime(time.gmtime(0.0)))
1306 msg_maildir.set_subdir('cur')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001307 self.assertEqual(class_(msg_maildir).get_flags(), 'RODFA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001308
1309 def test_maildir_to_mh(self):
1310 # Convert MaildirMessage to MHMessage
1311 msg_maildir = mailbox.MaildirMessage(_sample_message)
1312 pairs = (('D', ['unseen']), ('F', ['unseen', 'flagged']),
1313 ('P', ['unseen']), ('R', ['unseen', 'replied']), ('S', []),
1314 ('T', ['unseen']), ('DFPRST', ['replied', 'flagged']))
1315 for setting, result in pairs:
1316 msg_maildir.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001317 self.assertEqual(mailbox.MHMessage(msg_maildir).get_sequences(),
1318 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001319
1320 def test_maildir_to_babyl(self):
1321 # Convert MaildirMessage to Babyl
1322 msg_maildir = mailbox.MaildirMessage(_sample_message)
1323 pairs = (('D', ['unseen']), ('F', ['unseen']),
1324 ('P', ['unseen', 'forwarded']), ('R', ['unseen', 'answered']),
1325 ('S', []), ('T', ['unseen', 'deleted']),
1326 ('DFPRST', ['deleted', 'answered', 'forwarded']))
1327 for setting, result in pairs:
1328 msg_maildir.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001329 self.assertEqual(mailbox.BabylMessage(msg_maildir).get_labels(),
1330 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001331
1332 def test_mboxmmdf_to_maildir(self):
1333 # Convert mboxMessage and MMDFMessage to MaildirMessage
1334 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1335 msg_mboxMMDF = class_(_sample_message)
1336 msg_mboxMMDF.set_from('foo@bar', time.gmtime(0.0))
1337 pairs = (('R', 'S'), ('O', ''), ('D', 'T'), ('F', 'F'), ('A', 'R'),
1338 ('RODFA', 'FRST'))
1339 for setting, result in pairs:
1340 msg_mboxMMDF.set_flags(setting)
1341 msg = mailbox.MaildirMessage(msg_mboxMMDF)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001342 self.assertEqual(msg.get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001343 self.assert_(msg.get_date() == 0.0, msg.get_date())
1344 msg_mboxMMDF.set_flags('O')
Guido van Rossumea834472007-07-27 05:17:50 +00001345 self.assertEqual(mailbox.MaildirMessage(msg_mboxMMDF).get_subdir(),
1346 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001347
1348 def test_mboxmmdf_to_mboxmmdf(self):
1349 # Convert mboxMessage and MMDFMessage to mboxMessage and MMDFMessage
1350 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1351 msg_mboxMMDF = class_(_sample_message)
1352 msg_mboxMMDF.set_flags('RODFA')
1353 msg_mboxMMDF.set_from('foo@bar')
1354 for class2_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1355 msg2 = class2_(msg_mboxMMDF)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001356 self.assertEqual(msg2.get_flags(), 'RODFA')
1357 self.assertEqual(msg2.get_from(), 'foo@bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001358
1359 def test_mboxmmdf_to_mh(self):
1360 # Convert mboxMessage and MMDFMessage to MHMessage
1361 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1362 msg_mboxMMDF = class_(_sample_message)
1363 pairs = (('R', []), ('O', ['unseen']), ('D', ['unseen']),
1364 ('F', ['unseen', 'flagged']),
1365 ('A', ['unseen', 'replied']),
1366 ('RODFA', ['replied', 'flagged']))
1367 for setting, result in pairs:
1368 msg_mboxMMDF.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001369 self.assertEqual(mailbox.MHMessage(msg_mboxMMDF).get_sequences(),
1370 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001371
1372 def test_mboxmmdf_to_babyl(self):
1373 # Convert mboxMessage and MMDFMessage to BabylMessage
1374 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1375 msg = class_(_sample_message)
1376 pairs = (('R', []), ('O', ['unseen']),
1377 ('D', ['unseen', 'deleted']), ('F', ['unseen']),
1378 ('A', ['unseen', 'answered']),
1379 ('RODFA', ['deleted', 'answered']))
1380 for setting, result in pairs:
1381 msg.set_flags(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001382 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001383
1384 def test_mh_to_maildir(self):
1385 # Convert MHMessage to MaildirMessage
1386 pairs = (('unseen', ''), ('replied', 'RS'), ('flagged', 'FS'))
1387 for setting, result in pairs:
1388 msg = mailbox.MHMessage(_sample_message)
1389 msg.add_sequence(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001390 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1391 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001392 msg = mailbox.MHMessage(_sample_message)
1393 msg.add_sequence('unseen')
1394 msg.add_sequence('replied')
1395 msg.add_sequence('flagged')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001396 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'FR')
1397 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001398
1399 def test_mh_to_mboxmmdf(self):
1400 # Convert MHMessage to mboxMessage and MMDFMessage
1401 pairs = (('unseen', 'O'), ('replied', 'ROA'), ('flagged', 'ROF'))
1402 for setting, result in pairs:
1403 msg = mailbox.MHMessage(_sample_message)
1404 msg.add_sequence(setting)
1405 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001406 self.assertEqual(class_(msg).get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001407 msg = mailbox.MHMessage(_sample_message)
1408 msg.add_sequence('unseen')
1409 msg.add_sequence('replied')
1410 msg.add_sequence('flagged')
1411 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001412 self.assertEqual(class_(msg).get_flags(), 'OFA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001413
1414 def test_mh_to_mh(self):
1415 # Convert MHMessage to MHMessage
1416 msg = mailbox.MHMessage(_sample_message)
1417 msg.add_sequence('unseen')
1418 msg.add_sequence('replied')
1419 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001420 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1421 ['unseen', 'replied', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001422
1423 def test_mh_to_babyl(self):
1424 # Convert MHMessage to BabylMessage
1425 pairs = (('unseen', ['unseen']), ('replied', ['answered']),
1426 ('flagged', []))
1427 for setting, result in pairs:
1428 msg = mailbox.MHMessage(_sample_message)
1429 msg.add_sequence(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001430 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001431 msg = mailbox.MHMessage(_sample_message)
1432 msg.add_sequence('unseen')
1433 msg.add_sequence('replied')
1434 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001435 self.assertEqual(mailbox.BabylMessage(msg).get_labels(),
1436 ['unseen', 'answered'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001437
1438 def test_babyl_to_maildir(self):
1439 # Convert BabylMessage to MaildirMessage
1440 pairs = (('unseen', ''), ('deleted', 'ST'), ('filed', 'S'),
1441 ('answered', 'RS'), ('forwarded', 'PS'), ('edited', 'S'),
1442 ('resent', 'PS'))
1443 for setting, result in pairs:
1444 msg = mailbox.BabylMessage(_sample_message)
1445 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001446 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1447 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001448 msg = mailbox.BabylMessage(_sample_message)
1449 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1450 'edited', 'resent'):
1451 msg.add_label(label)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001452 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'PRT')
1453 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001454
1455 def test_babyl_to_mboxmmdf(self):
1456 # Convert BabylMessage to mboxMessage and MMDFMessage
1457 pairs = (('unseen', 'O'), ('deleted', 'ROD'), ('filed', 'RO'),
1458 ('answered', 'ROA'), ('forwarded', 'RO'), ('edited', 'RO'),
1459 ('resent', 'RO'))
1460 for setting, result in pairs:
1461 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1462 msg = mailbox.BabylMessage(_sample_message)
1463 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001464 self.assertEqual(class_(msg).get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001465 msg = mailbox.BabylMessage(_sample_message)
1466 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1467 'edited', 'resent'):
1468 msg.add_label(label)
1469 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001470 self.assertEqual(class_(msg).get_flags(), 'ODA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001471
1472 def test_babyl_to_mh(self):
1473 # Convert BabylMessage to MHMessage
1474 pairs = (('unseen', ['unseen']), ('deleted', []), ('filed', []),
1475 ('answered', ['replied']), ('forwarded', []), ('edited', []),
1476 ('resent', []))
1477 for setting, result in pairs:
1478 msg = mailbox.BabylMessage(_sample_message)
1479 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001480 self.assertEqual(mailbox.MHMessage(msg).get_sequences(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001481 msg = mailbox.BabylMessage(_sample_message)
1482 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1483 'edited', 'resent'):
1484 msg.add_label(label)
Guido van Rossumea834472007-07-27 05:17:50 +00001485 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1486 ['unseen', 'replied'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001487
1488 def test_babyl_to_babyl(self):
1489 # Convert BabylMessage to BabylMessage
1490 msg = mailbox.BabylMessage(_sample_message)
1491 msg.update_visible()
1492 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1493 'edited', 'resent'):
1494 msg.add_label(label)
1495 msg2 = mailbox.BabylMessage(msg)
Guido van Rossumea834472007-07-27 05:17:50 +00001496 self.assertEqual(msg2.get_labels(), ['unseen', 'deleted', 'filed',
1497 'answered', 'forwarded', 'edited',
1498 'resent'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001499 self.assertEqual(msg.get_visible().keys(), msg2.get_visible().keys())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001500 for key in msg.get_visible().keys():
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001501 self.assertEqual(msg.get_visible()[key], msg2.get_visible()[key])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001502
1503
1504class TestProxyFileBase(TestBase):
1505
1506 def _test_read(self, proxy):
1507 # Read by byte
1508 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001509 self.assertEqual(proxy.read(), b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001510 proxy.seek(1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001511 self.assertEqual(proxy.read(), b'ar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001512 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001513 self.assertEqual(proxy.read(2), b'ba')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001514 proxy.seek(1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001515 self.assertEqual(proxy.read(-1), b'ar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001516 proxy.seek(2)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001517 self.assertEqual(proxy.read(1000), b'r')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001518
1519 def _test_readline(self, proxy):
1520 # Read by line
Guido van Rossum98297ee2007-11-06 21:34:58 +00001521 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001522 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001523 self.assertEqual(proxy.readline(), b'foo' + linesep)
1524 self.assertEqual(proxy.readline(), b'bar' + linesep)
1525 self.assertEqual(proxy.readline(), b'fred' + linesep)
1526 self.assertEqual(proxy.readline(), b'bob')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001527 proxy.seek(2)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001528 self.assertEqual(proxy.readline(), b'o' + 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(), b'fred' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001531 proxy.seek(6 + 2 * len(os.linesep))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001532 self.assertEqual(proxy.readline(2), b'fr')
1533 self.assertEqual(proxy.readline(-10), b'ed' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001534
1535 def _test_readlines(self, proxy):
1536 # Read multiple lines
Guido van Rossum98297ee2007-11-06 21:34:58 +00001537 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001538 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001539 self.assertEqual(proxy.readlines(), [b'foo' + linesep,
1540 b'bar' + linesep,
1541 b'fred' + linesep, b'bob'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001542 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001543 self.assertEqual(proxy.readlines(2), [b'foo' + linesep])
1544 proxy.seek(3 + len(linesep))
1545 self.assertEqual(proxy.readlines(4 + len(linesep)),
1546 [b'bar' + linesep, b'fred' + linesep])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001547 proxy.seek(3)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001548 self.assertEqual(proxy.readlines(1000), [linesep, b'bar' + linesep,
1549 b'fred' + linesep, b'bob'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001550
1551 def _test_iteration(self, proxy):
1552 # Iterate by line
Guido van Rossum98297ee2007-11-06 21:34:58 +00001553 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001554 proxy.seek(0)
1555 iterator = iter(proxy)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001556 self.assertEqual(next(iterator), b'foo' + linesep)
1557 self.assertEqual(next(iterator), b'bar' + linesep)
1558 self.assertEqual(next(iterator), b'fred' + linesep)
1559 self.assertEqual(next(iterator), b'bob')
Georg Brandla18af4e2007-04-21 15:47:16 +00001560 self.assertRaises(StopIteration, next, iterator)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001561
1562 def _test_seek_and_tell(self, proxy):
1563 # Seek and use tell to check position
Guido van Rossum98297ee2007-11-06 21:34:58 +00001564 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001565 proxy.seek(3)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001566 self.assertEqual(proxy.tell(), 3)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001567 self.assertEqual(proxy.read(len(linesep)), linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001568 proxy.seek(2, 1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001569 self.assertEqual(proxy.read(1 + len(linesep)), b'r' + linesep)
1570 proxy.seek(-3 - len(linesep), 2)
1571 self.assertEqual(proxy.read(3), b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001572 proxy.seek(2, 0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001573 self.assertEqual(proxy.read(), b'o' + linesep + b'bar' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001574 proxy.seek(100)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001575 self.failIf(proxy.read())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001576
1577 def _test_close(self, proxy):
1578 # Close a file
1579 proxy.close()
1580 self.assertRaises(AttributeError, lambda: proxy.close())
1581
1582
1583class TestProxyFile(TestProxyFileBase):
1584
1585 def setUp(self):
1586 self._path = test_support.TESTFN
1587 self._file = open(self._path, 'wb+')
1588
1589 def tearDown(self):
1590 self._file.close()
1591 self._delete_recursively(self._path)
1592
1593 def test_initialize(self):
1594 # Initialize and check position
Neal Norwitz9a923102007-08-30 06:20:05 +00001595 self._file.write(b'foo')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001596 pos = self._file.tell()
1597 proxy0 = mailbox._ProxyFile(self._file)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001598 self.assertEqual(proxy0.tell(), pos)
1599 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001600 proxy1 = mailbox._ProxyFile(self._file, 0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001601 self.assertEqual(proxy1.tell(), 0)
1602 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001603
1604 def test_read(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001605 self._file.write(b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001606 self._test_read(mailbox._ProxyFile(self._file))
1607
1608 def test_readline(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001609 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1610 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001611 self._test_readline(mailbox._ProxyFile(self._file))
1612
1613 def test_readlines(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001614 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1615 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001616 self._test_readlines(mailbox._ProxyFile(self._file))
1617
1618 def test_iteration(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001619 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1620 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001621 self._test_iteration(mailbox._ProxyFile(self._file))
1622
1623 def test_seek_and_tell(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001624 self._file.write(bytes('foo%sbar%s' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001625 self._test_seek_and_tell(mailbox._ProxyFile(self._file))
1626
1627 def test_close(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001628 self._file.write(bytes('foo%sbar%s' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001629 self._test_close(mailbox._ProxyFile(self._file))
1630
1631
1632class TestPartialFile(TestProxyFileBase):
1633
1634 def setUp(self):
1635 self._path = test_support.TESTFN
1636 self._file = open(self._path, 'wb+')
1637
1638 def tearDown(self):
1639 self._file.close()
1640 self._delete_recursively(self._path)
1641
1642 def test_initialize(self):
1643 # Initialize and check position
Neal Norwitz9a923102007-08-30 06:20:05 +00001644 self._file.write(bytes('foo' + os.linesep + 'bar', 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001645 pos = self._file.tell()
1646 proxy = mailbox._PartialFile(self._file, 2, 5)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001647 self.assertEqual(proxy.tell(), 0)
1648 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001649
1650 def test_read(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001651 self._file.write(bytes('***bar***', 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001652 self._test_read(mailbox._PartialFile(self._file, 3, 6))
1653
1654 def test_readline(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001655 self._file.write(bytes('!!!!!foo%sbar%sfred%sbob!!!!!' %
1656 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001657 self._test_readline(mailbox._PartialFile(self._file, 5,
1658 18 + 3 * len(os.linesep)))
1659
1660 def test_readlines(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001661 self._file.write(bytes('foo%sbar%sfred%sbob?????' %
1662 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001663 self._test_readlines(mailbox._PartialFile(self._file, 0,
1664 13 + 3 * len(os.linesep)))
1665
1666 def test_iteration(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001667 self._file.write(bytes('____foo%sbar%sfred%sbob####' %
1668 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001669 self._test_iteration(mailbox._PartialFile(self._file, 4,
1670 17 + 3 * len(os.linesep)))
1671
1672 def test_seek_and_tell(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001673 self._file.write(bytes('(((foo%sbar%s$$$' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001674 self._test_seek_and_tell(mailbox._PartialFile(self._file, 3,
1675 9 + 2 * len(os.linesep)))
1676
1677 def test_close(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001678 self._file.write(bytes('&foo%sbar%s^' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001679 self._test_close(mailbox._PartialFile(self._file, 1,
1680 6 + 3 * len(os.linesep)))
1681
1682
1683## Start: tests from the original module (for backward compatibility).
1684
Skip Montanaro5253da12004-07-24 19:56:03 +00001685FROM_ = "From some.body@dummy.domain Sat Jul 24 13:43:35 2004\n"
Fred Drakec02bc3e2001-05-21 20:23:21 +00001686DUMMY_MESSAGE = """\
1687From: some.body@dummy.domain
1688To: me@my.domain
Skip Montanaro5253da12004-07-24 19:56:03 +00001689Subject: Simple Test
Fred Drakec02bc3e2001-05-21 20:23:21 +00001690
1691This is a dummy message.
1692"""
1693
Fred Drakec02bc3e2001-05-21 20:23:21 +00001694class MaildirTestCase(unittest.TestCase):
1695
1696 def setUp(self):
1697 # create a new maildir mailbox to work with:
1698 self._dir = test_support.TESTFN
1699 os.mkdir(self._dir)
1700 os.mkdir(os.path.join(self._dir, "cur"))
1701 os.mkdir(os.path.join(self._dir, "tmp"))
1702 os.mkdir(os.path.join(self._dir, "new"))
1703 self._counter = 1
1704 self._msgfiles = []
1705
1706 def tearDown(self):
Guido van Rossumc1f779c2007-07-03 08:25:58 +00001707 list(map(os.unlink, self._msgfiles))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001708 os.rmdir(os.path.join(self._dir, "cur"))
1709 os.rmdir(os.path.join(self._dir, "tmp"))
1710 os.rmdir(os.path.join(self._dir, "new"))
1711 os.rmdir(self._dir)
1712
Skip Montanaro5253da12004-07-24 19:56:03 +00001713 def createMessage(self, dir, mbox=False):
Jack Jansen97df7b62001-06-19 20:20:05 +00001714 t = int(time.time() % 1000000)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001715 pid = self._counter
1716 self._counter += 1
Skip Montanaro7a98be22007-08-16 14:35:24 +00001717 filename = ".".join((str(t), str(pid), "myhostname", "mydomain"))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001718 tmpname = os.path.join(self._dir, "tmp", filename)
1719 newname = os.path.join(self._dir, dir, filename)
1720 fp = open(tmpname, "w")
1721 self._msgfiles.append(tmpname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001722 if mbox:
1723 fp.write(FROM_)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001724 fp.write(DUMMY_MESSAGE)
1725 fp.close()
Tim Peters6626c1f2001-05-22 16:29:01 +00001726 if hasattr(os, "link"):
1727 os.link(tmpname, newname)
1728 else:
1729 fp = open(newname, "w")
1730 fp.write(DUMMY_MESSAGE)
1731 fp.close()
Fred Drakec02bc3e2001-05-21 20:23:21 +00001732 self._msgfiles.append(newname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001733 return tmpname
Fred Drakec02bc3e2001-05-21 20:23:21 +00001734
1735 def test_empty_maildir(self):
1736 """Test an empty maildir mailbox"""
1737 # Test for regression on bug #117490:
1738 # Make sure the boxes attribute actually gets set.
1739 self.mbox = mailbox.Maildir(test_support.TESTFN)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001740 #self.assert_(hasattr(self.mbox, "boxes"))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001741 #self.assertEqual(len(self.mbox.boxes), 0)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001742 self.assert_(self.mbox.next() is None)
1743 self.assert_(self.mbox.next() is None)
1744
1745 def test_nonempty_maildir_cur(self):
1746 self.createMessage("cur")
1747 self.mbox = mailbox.Maildir(test_support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001748 #self.assertEqual(len(self.mbox.boxes), 1)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001749 self.assert_(self.mbox.next() is not None)
1750 self.assert_(self.mbox.next() is None)
1751 self.assert_(self.mbox.next() is None)
1752
1753 def test_nonempty_maildir_new(self):
1754 self.createMessage("new")
1755 self.mbox = mailbox.Maildir(test_support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001756 #self.assertEqual(len(self.mbox.boxes), 1)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001757 self.assert_(self.mbox.next() is not None)
1758 self.assert_(self.mbox.next() is None)
1759 self.assert_(self.mbox.next() is None)
1760
1761 def test_nonempty_maildir_both(self):
1762 self.createMessage("cur")
1763 self.createMessage("new")
1764 self.mbox = mailbox.Maildir(test_support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001765 #self.assertEqual(len(self.mbox.boxes), 2)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001766 self.assert_(self.mbox.next() is not None)
1767 self.assert_(self.mbox.next() is not None)
1768 self.assert_(self.mbox.next() is None)
1769 self.assert_(self.mbox.next() is None)
Fred Drake0aaed272000-10-23 13:39:15 +00001770
Georg Brandledb978f2008-05-11 08:59:40 +00001771## End: tests from the original module (for backward compatibility).
Thomas Wouters477c8d52006-05-27 19:21:47 +00001772
1773
1774_sample_message = """\
1775Return-Path: <gkj@gregorykjohnson.com>
1776X-Original-To: gkj+person@localhost
1777Delivered-To: gkj+person@localhost
1778Received: from localhost (localhost [127.0.0.1])
1779 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1780 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
1781Delivered-To: gkj@sundance.gregorykjohnson.com
1782Received: from localhost [127.0.0.1]
1783 by localhost with POP3 (fetchmail-6.2.5)
1784 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
1785Received: from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
1786 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1787 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
1788Received: by andy.gregorykjohnson.com (Postfix, from userid 1000)
1789 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
1790Date: Wed, 13 Jul 2005 17:23:11 -0400
1791From: "Gregory K. Johnson" <gkj@gregorykjohnson.com>
1792To: gkj@gregorykjohnson.com
1793Subject: Sample message
1794Message-ID: <20050713212311.GC4701@andy.gregorykjohnson.com>
1795Mime-Version: 1.0
1796Content-Type: multipart/mixed; boundary="NMuMz9nt05w80d4+"
1797Content-Disposition: inline
1798User-Agent: Mutt/1.5.9i
1799
1800
1801--NMuMz9nt05w80d4+
1802Content-Type: text/plain; charset=us-ascii
1803Content-Disposition: inline
1804
1805This is a sample message.
1806
1807--
1808Gregory K. Johnson
1809
1810--NMuMz9nt05w80d4+
1811Content-Type: application/octet-stream
1812Content-Disposition: attachment; filename="text.gz"
1813Content-Transfer-Encoding: base64
1814
1815H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
18163FYlAAAA
1817
1818--NMuMz9nt05w80d4+--
1819"""
1820
1821_sample_headers = {
1822 "Return-Path":"<gkj@gregorykjohnson.com>",
1823 "X-Original-To":"gkj+person@localhost",
1824 "Delivered-To":"gkj+person@localhost",
1825 "Received":"""from localhost (localhost [127.0.0.1])
1826 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1827 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
1828 "Delivered-To":"gkj@sundance.gregorykjohnson.com",
1829 "Received":"""from localhost [127.0.0.1]
1830 by localhost with POP3 (fetchmail-6.2.5)
1831 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
1832 "Received":"""from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
1833 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1834 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
1835 "Received":"""by andy.gregorykjohnson.com (Postfix, from userid 1000)
1836 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
1837 "Date":"Wed, 13 Jul 2005 17:23:11 -0400",
1838 "From":""""Gregory K. Johnson" <gkj@gregorykjohnson.com>""",
1839 "To":"gkj@gregorykjohnson.com",
1840 "Subject":"Sample message",
1841 "Mime-Version":"1.0",
1842 "Content-Type":"""multipart/mixed; boundary="NMuMz9nt05w80d4+\"""",
1843 "Content-Disposition":"inline",
1844 "User-Agent": "Mutt/1.5.9i" }
1845
1846_sample_payloads = ("""This is a sample message.
1847
1848--
1849Gregory K. Johnson
1850""",
1851"""H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
18523FYlAAAA
1853""")
Fred Drake0aaed272000-10-23 13:39:15 +00001854
Fred Drakec02bc3e2001-05-21 20:23:21 +00001855
Fred Drake2e2be372001-09-20 21:33:42 +00001856def test_main():
Thomas Wouters477c8d52006-05-27 19:21:47 +00001857 tests = (TestMailboxSuperclass, TestMaildir, TestMbox, TestMMDF, TestMH,
1858 TestBabyl, TestMessage, TestMaildirMessage, TestMboxMessage,
1859 TestMHMessage, TestBabylMessage, TestMMDFMessage,
1860 TestMessageConversion, TestProxyFile, TestPartialFile,
1861 MaildirTestCase)
1862 test_support.run_unittest(*tests)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001863 test_support.reap_children()
Fred Drake2e2be372001-09-20 21:33:42 +00001864
1865
Thomas Wouters477c8d52006-05-27 19:21:47 +00001866if __name__ == '__main__':
Fred Drake2e2be372001-09-20 21:33:42 +00001867 test_main()