blob: a7142552bbd12a27944b80521306e8960e6ad711 [file] [log] [blame]
Fred Drake0aaed272000-10-23 13:39:15 +00001import os
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00002import sys
Fred Drakec02bc3e2001-05-21 20:23:21 +00003import time
Thomas Wouters477c8d52006-05-27 19:21:47 +00004import stat
5import socket
6import email
Thomas Woutersb2137042007-02-01 18:02:27 +00007import email.message
Thomas Wouters477c8d52006-05-27 19:21:47 +00008import rfc822
9import re
Guido van Rossum34d19282007-08-09 01:03:29 +000010import io
Barry Warsaw04f357c2002-07-23 19:04:11 +000011from test import test_support
Thomas Wouters477c8d52006-05-27 19:21:47 +000012import unittest
13import mailbox
14import glob
Guido van Rossum75ebb292001-04-10 15:01:20 +000015try:
Thomas Wouters477c8d52006-05-27 19:21:47 +000016 import fcntl
17except ImportError:
Guido van Rossum75ebb292001-04-10 15:01:20 +000018 pass
19
Thomas Wouters477c8d52006-05-27 19:21:47 +000020
21class TestBase(unittest.TestCase):
22
23 def _check_sample(self, msg):
24 # Inspect a mailbox.Message representation of the sample message
Thomas Woutersb2137042007-02-01 18:02:27 +000025 self.assert_(isinstance(msg, email.message.Message))
Thomas Wouters477c8d52006-05-27 19:21:47 +000026 self.assert_(isinstance(msg, mailbox.Message))
Guido van Rossumcc2b0162007-02-11 06:12:03 +000027 for key, value in _sample_headers.items():
Thomas Wouters477c8d52006-05-27 19:21:47 +000028 self.assert_(value in msg.get_all(key))
29 self.assert_(msg.is_multipart())
Guido van Rossume61fd5b2007-07-11 12:20:59 +000030 self.assertEqual(len(msg.get_payload()), len(_sample_payloads))
Thomas Wouters477c8d52006-05-27 19:21:47 +000031 for i, payload in enumerate(_sample_payloads):
32 part = msg.get_payload(i)
Thomas Woutersb2137042007-02-01 18:02:27 +000033 self.assert_(isinstance(part, email.message.Message))
Thomas Wouters477c8d52006-05-27 19:21:47 +000034 self.assert_(not isinstance(part, mailbox.Message))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000035 self.assertEqual(part.get_payload(), payload)
Thomas Wouters477c8d52006-05-27 19:21:47 +000036
37 def _delete_recursively(self, target):
38 # Delete a file or delete a directory recursively
39 if os.path.isdir(target):
40 for path, dirs, files in os.walk(target, topdown=False):
41 for name in files:
42 os.remove(os.path.join(path, name))
43 for name in dirs:
44 os.rmdir(os.path.join(path, name))
45 os.rmdir(target)
46 elif os.path.exists(target):
47 os.remove(target)
48
49
50class TestMailbox(TestBase):
51
52 _factory = None # Overridden by subclasses to reuse tests
53 _template = 'From: foo\n\n%s'
54
55 def setUp(self):
56 self._path = test_support.TESTFN
Guido van Rossumd8faa362007-04-27 19:54:29 +000057 self._delete_recursively(self._path)
Thomas Wouters477c8d52006-05-27 19:21:47 +000058 self._box = self._factory(self._path)
59
60 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +000061 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +000062 self._delete_recursively(self._path)
63
64 def test_add(self):
65 # Add copies of a sample message
66 keys = []
67 keys.append(self._box.add(self._template % 0))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000068 self.assertEqual(len(self._box), 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +000069 keys.append(self._box.add(mailbox.Message(_sample_message)))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000070 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +000071 keys.append(self._box.add(email.message_from_string(_sample_message)))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000072 self.assertEqual(len(self._box), 3)
Guido van Rossum34d19282007-08-09 01:03:29 +000073 keys.append(self._box.add(io.StringIO(_sample_message)))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000074 self.assertEqual(len(self._box), 4)
Thomas Wouters477c8d52006-05-27 19:21:47 +000075 keys.append(self._box.add(_sample_message))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000076 self.assertEqual(len(self._box), 5)
Guido van Rossumea834472007-07-27 05:17:50 +000077 self.assertEqual(self._box.get_string(keys[0]), self._template % 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +000078 for i in (1, 2, 3, 4):
79 self._check_sample(self._box[keys[i]])
80
81 def test_remove(self):
82 # Remove messages using remove()
83 self._test_remove_or_delitem(self._box.remove)
84
85 def test_delitem(self):
86 # Remove messages using __delitem__()
87 self._test_remove_or_delitem(self._box.__delitem__)
88
89 def _test_remove_or_delitem(self, method):
90 # (Used by test_remove() and test_delitem().)
91 key0 = self._box.add(self._template % 0)
92 key1 = self._box.add(self._template % 1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +000093 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +000094 method(key0)
95 l = len(self._box)
96 self.assert_(l == 1, "actual l: %s" % l)
97 self.assertRaises(KeyError, lambda: self._box[key0])
98 self.assertRaises(KeyError, lambda: method(key0))
Guido van Rossumea834472007-07-27 05:17:50 +000099 self.assertEqual(self._box.get_string(key1), self._template % 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000100 key2 = self._box.add(self._template % 2)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000101 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000102 method(key2)
103 l = len(self._box)
104 self.assert_(l == 1, "actual l: %s" % l)
105 self.assertRaises(KeyError, lambda: self._box[key2])
106 self.assertRaises(KeyError, lambda: method(key2))
Guido van Rossumea834472007-07-27 05:17:50 +0000107 self.assertEqual(self._box.get_string(key1), self._template % 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000108 method(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000109 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000110 self.assertRaises(KeyError, lambda: self._box[key1])
111 self.assertRaises(KeyError, lambda: method(key1))
112
113 def test_discard(self, repetitions=10):
114 # Discard messages
115 key0 = self._box.add(self._template % 0)
116 key1 = self._box.add(self._template % 1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000117 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000118 self._box.discard(key0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000119 self.assertEqual(len(self._box), 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000120 self.assertRaises(KeyError, lambda: self._box[key0])
121 self._box.discard(key0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000122 self.assertEqual(len(self._box), 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000123 self.assertRaises(KeyError, lambda: self._box[key0])
124
125 def test_get(self):
126 # Retrieve messages using get()
127 key0 = self._box.add(self._template % 0)
128 msg = self._box.get(key0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000129 self.assertEqual(msg['from'], 'foo')
130 self.assertEqual(msg.get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000131 self.assert_(self._box.get('foo') is None)
132 self.assert_(self._box.get('foo', False) is False)
133 self._box.close()
134 self._box = self._factory(self._path, factory=rfc822.Message)
135 key1 = self._box.add(self._template % 1)
136 msg = self._box.get(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000137 self.assertEqual(msg['from'], 'foo')
138 self.assertEqual(msg.fp.read(), '1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000139
140 def test_getitem(self):
141 # Retrieve message using __getitem__()
142 key0 = self._box.add(self._template % 0)
143 msg = self._box[key0]
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000144 self.assertEqual(msg['from'], 'foo')
145 self.assertEqual(msg.get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000146 self.assertRaises(KeyError, lambda: self._box['foo'])
147 self._box.discard(key0)
148 self.assertRaises(KeyError, lambda: self._box[key0])
149
150 def test_get_message(self):
151 # Get Message representations of messages
152 key0 = self._box.add(self._template % 0)
153 key1 = self._box.add(_sample_message)
154 msg0 = self._box.get_message(key0)
155 self.assert_(isinstance(msg0, mailbox.Message))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000156 self.assertEqual(msg0['from'], 'foo')
157 self.assertEqual(msg0.get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000158 self._check_sample(self._box.get_message(key1))
159
160 def test_get_string(self):
161 # Get string representations of messages
162 key0 = self._box.add(self._template % 0)
163 key1 = self._box.add(_sample_message)
Guido van Rossumea834472007-07-27 05:17:50 +0000164 self.assertEqual(self._box.get_string(key0), self._template % 0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000165 self.assertEqual(self._box.get_string(key1), _sample_message)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000166
167 def test_get_file(self):
168 # Get file representations of messages
169 key0 = self._box.add(self._template % 0)
170 key1 = self._box.add(_sample_message)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000171 data0 = self._box.get_file(key0).read()
172 data1 = self._box.get_file(key1).read()
173 self.assertEqual(data0.replace(os.linesep, '\n'),
Guido van Rossumea834472007-07-27 05:17:50 +0000174 self._template % 0)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000175 self.assertEqual(data1.replace(os.linesep, '\n'),
Guido van Rossumea834472007-07-27 05:17:50 +0000176 _sample_message)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000177
178 def test_iterkeys(self):
179 # Get keys using iterkeys()
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000180 self._check_iteration(self._box.keys, do_keys=True, do_values=False)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000181
182 def test_keys(self):
183 # Get keys using keys()
184 self._check_iteration(self._box.keys, do_keys=True, do_values=False)
185
186 def test_itervalues(self):
187 # Get values using itervalues()
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000188 self._check_iteration(self._box.values, do_keys=False,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000189 do_values=True)
190
191 def test_iter(self):
192 # Get values using __iter__()
193 self._check_iteration(self._box.__iter__, do_keys=False,
194 do_values=True)
195
196 def test_values(self):
197 # Get values using values()
198 self._check_iteration(self._box.values, do_keys=False, do_values=True)
199
200 def test_iteritems(self):
201 # Get keys and values using iteritems()
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000202 self._check_iteration(self._box.items, do_keys=True,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000203 do_values=True)
204
205 def test_items(self):
206 # Get keys and values using items()
207 self._check_iteration(self._box.items, do_keys=True, do_values=True)
208
209 def _check_iteration(self, method, do_keys, do_values, repetitions=10):
210 for value in method():
211 self.fail("Not empty")
212 keys, values = [], []
Guido van Rossum805365e2007-05-07 22:24:25 +0000213 for i in range(repetitions):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000214 keys.append(self._box.add(self._template % i))
215 values.append(self._template % i)
216 if do_keys and not do_values:
217 returned_keys = list(method())
218 elif do_values and not do_keys:
219 returned_values = list(method())
220 else:
221 returned_keys, returned_values = [], []
222 for key, value in method():
223 returned_keys.append(key)
224 returned_values.append(value)
225 if do_keys:
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000226 self.assertEqual(len(keys), len(returned_keys))
227 self.assertEqual(set(keys), set(returned_keys))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000228 if do_values:
229 count = 0
230 for value in returned_values:
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000231 self.assertEqual(value['from'], 'foo')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000232 self.assert_(int(value.get_payload()) < repetitions)
233 count += 1
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000234 self.assertEqual(len(values), count)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000235
Thomas Wouters477c8d52006-05-27 19:21:47 +0000236 def test_contains(self):
237 # Check existence of keys using __contains__()
Guido van Rossume2b70bc2006-08-18 22:13:04 +0000238 method = self._box.__contains__
Thomas Wouters477c8d52006-05-27 19:21:47 +0000239 self.assert_(not method('foo'))
240 key0 = self._box.add(self._template % 0)
241 self.assert_(method(key0))
242 self.assert_(not method('foo'))
243 key1 = self._box.add(self._template % 1)
244 self.assert_(method(key1))
245 self.assert_(method(key0))
246 self.assert_(not method('foo'))
247 self._box.remove(key0)
248 self.assert_(not method(key0))
249 self.assert_(method(key1))
250 self.assert_(not method('foo'))
251 self._box.remove(key1)
252 self.assert_(not method(key1))
253 self.assert_(not method(key0))
254 self.assert_(not method('foo'))
255
256 def test_len(self, repetitions=10):
257 # Get message count
258 keys = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000259 for i in range(repetitions):
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000260 self.assertEqual(len(self._box), i)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000261 keys.append(self._box.add(self._template % i))
Guido van Rossumea834472007-07-27 05:17:50 +0000262 self.assertEqual(len(self._box), i + 1)
Guido van Rossum805365e2007-05-07 22:24:25 +0000263 for i in range(repetitions):
Guido van Rossumea834472007-07-27 05:17:50 +0000264 self.assertEqual(len(self._box), repetitions - i)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000265 self._box.remove(keys[i])
Guido van Rossumea834472007-07-27 05:17:50 +0000266 self.assertEqual(len(self._box), repetitions - i - 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000267
268 def test_set_item(self):
269 # Modify messages using __setitem__()
270 key0 = self._box.add(self._template % 'original 0')
Guido van Rossumea834472007-07-27 05:17:50 +0000271 self.assertEqual(self._box.get_string(key0),
272 self._template % 'original 0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000273 key1 = self._box.add(self._template % 'original 1')
Guido van Rossumea834472007-07-27 05:17:50 +0000274 self.assertEqual(self._box.get_string(key1),
275 self._template % 'original 1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000276 self._box[key0] = self._template % 'changed 0'
Guido van Rossumea834472007-07-27 05:17:50 +0000277 self.assertEqual(self._box.get_string(key0),
278 self._template % 'changed 0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000279 self._box[key1] = self._template % 'changed 1'
Guido van Rossumea834472007-07-27 05:17:50 +0000280 self.assertEqual(self._box.get_string(key1),
281 self._template % 'changed 1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000282 self._box[key0] = _sample_message
283 self._check_sample(self._box[key0])
284 self._box[key1] = self._box[key0]
285 self._check_sample(self._box[key1])
286 self._box[key0] = self._template % 'original 0'
Guido van Rossumea834472007-07-27 05:17:50 +0000287 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000288 self._template % 'original 0')
289 self._check_sample(self._box[key1])
290 self.assertRaises(KeyError,
291 lambda: self._box.__setitem__('foo', 'bar'))
292 self.assertRaises(KeyError, lambda: self._box['foo'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000293 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000294
295 def test_clear(self, iterations=10):
296 # Remove all messages using clear()
297 keys = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000298 for i in range(iterations):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000299 self._box.add(self._template % i)
300 for i, key in enumerate(keys):
301 self.assert_(self._box.get_string(key) == self._template % i)
302 self._box.clear()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000303 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000304 for i, key in enumerate(keys):
305 self.assertRaises(KeyError, lambda: self._box.get_string(key))
306
307 def test_pop(self):
308 # Get and remove a message using pop()
309 key0 = self._box.add(self._template % 0)
310 self.assert_(key0 in self._box)
311 key1 = self._box.add(self._template % 1)
312 self.assert_(key1 in self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000313 self.assertEqual(self._box.pop(key0).get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000314 self.assert_(key0 not in self._box)
315 self.assert_(key1 in self._box)
316 key2 = self._box.add(self._template % 2)
317 self.assert_(key2 in self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000318 self.assertEqual(self._box.pop(key2).get_payload(), '2')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000319 self.assert_(key2 not in self._box)
320 self.assert_(key1 in self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000321 self.assertEqual(self._box.pop(key1).get_payload(), '1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000322 self.assert_(key1 not in self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000323 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000324
325 def test_popitem(self, iterations=10):
326 # Get and remove an arbitrary (key, message) using popitem()
327 keys = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000328 for i in range(10):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000329 keys.append(self._box.add(self._template % i))
330 seen = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000331 for i in range(10):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000332 key, msg = self._box.popitem()
333 self.assert_(key in keys)
334 self.assert_(key not in seen)
335 seen.append(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000336 self.assertEqual(int(msg.get_payload()), keys.index(key))
337 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000338 for key in keys:
339 self.assertRaises(KeyError, lambda: self._box[key])
340
341 def test_update(self):
342 # Modify multiple messages using update()
343 key0 = self._box.add(self._template % 'original 0')
344 key1 = self._box.add(self._template % 'original 1')
345 key2 = self._box.add(self._template % 'original 2')
346 self._box.update({key0: self._template % 'changed 0',
347 key2: _sample_message})
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000348 self.assertEqual(len(self._box), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000349 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000350 self._template % 'changed 0')
Guido van Rossumea834472007-07-27 05:17:50 +0000351 self.assertEqual(self._box.get_string(key1),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000352 self._template % 'original 1')
353 self._check_sample(self._box[key2])
354 self._box.update([(key2, self._template % 'changed 2'),
355 (key1, self._template % 'changed 1'),
356 (key0, self._template % 'original 0')])
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000357 self.assertEqual(len(self._box), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000358 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000359 self._template % 'original 0')
Guido van Rossumea834472007-07-27 05:17:50 +0000360 self.assertEqual(self._box.get_string(key1),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000361 self._template % 'changed 1')
Guido van Rossumea834472007-07-27 05:17:50 +0000362 self.assertEqual(self._box.get_string(key2),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000363 self._template % 'changed 2')
364 self.assertRaises(KeyError,
365 lambda: self._box.update({'foo': 'bar',
366 key0: self._template % "changed 0"}))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000367 self.assertEqual(len(self._box), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000368 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000369 self._template % "changed 0")
Guido van Rossumea834472007-07-27 05:17:50 +0000370 self.assertEqual(self._box.get_string(key1),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000371 self._template % "changed 1")
Guido van Rossumea834472007-07-27 05:17:50 +0000372 self.assertEqual(self._box.get_string(key2),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000373 self._template % "changed 2")
374
375 def test_flush(self):
376 # Write changes to disk
377 self._test_flush_or_close(self._box.flush)
378
379 def test_lock_unlock(self):
380 # Lock and unlock the mailbox
381 self.assert_(not os.path.exists(self._get_lock_path()))
382 self._box.lock()
383 self.assert_(os.path.exists(self._get_lock_path()))
384 self._box.unlock()
385 self.assert_(not os.path.exists(self._get_lock_path()))
386
387 def test_close(self):
388 # Close mailbox and flush changes to disk
389 self._test_flush_or_close(self._box.close)
390
391 def _test_flush_or_close(self, method):
Guido van Rossum805365e2007-05-07 22:24:25 +0000392 contents = [self._template % i for i in range(3)]
Thomas Wouters477c8d52006-05-27 19:21:47 +0000393 self._box.add(contents[0])
394 self._box.add(contents[1])
395 self._box.add(contents[2])
Guido van Rossumc12a8132007-10-26 04:29:23 +0000396 oldbox = self._box
Thomas Wouters477c8d52006-05-27 19:21:47 +0000397 method()
398 self._box = self._factory(self._path)
399 keys = self._box.keys()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000400 self.assertEqual(len(keys), 3)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000401 for key in keys:
402 self.assert_(self._box.get_string(key) in contents)
Guido van Rossumc12a8132007-10-26 04:29:23 +0000403 oldbox.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000404
405 def test_dump_message(self):
406 # Write message representations to disk
407 for input in (email.message_from_string(_sample_message),
Guido van Rossum34d19282007-08-09 01:03:29 +0000408 _sample_message, io.StringIO(_sample_message)):
409 output = io.StringIO()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000410 self._box._dump_message(input, output)
Guido van Rossumc12a8132007-10-26 04:29:23 +0000411 self.assertEqual(output.getvalue(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000412 _sample_message.replace('\n', os.linesep))
Guido van Rossum34d19282007-08-09 01:03:29 +0000413 output = io.StringIO()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000414 self.assertRaises(TypeError,
415 lambda: self._box._dump_message(None, output))
416
417 def _get_lock_path(self):
418 # Return the path of the dot lock file. May be overridden.
419 return self._path + '.lock'
420
421
422class TestMailboxSuperclass(TestBase):
423
424 def test_notimplemented(self):
425 # Test that all Mailbox methods raise NotImplementedException.
426 box = mailbox.Mailbox('path')
427 self.assertRaises(NotImplementedError, lambda: box.add(''))
428 self.assertRaises(NotImplementedError, lambda: box.remove(''))
429 self.assertRaises(NotImplementedError, lambda: box.__delitem__(''))
430 self.assertRaises(NotImplementedError, lambda: box.discard(''))
431 self.assertRaises(NotImplementedError, lambda: box.__setitem__('', ''))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000432 self.assertRaises(NotImplementedError, lambda: box.keys())
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000433 self.assertRaises(NotImplementedError, lambda: box.keys())
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000434 self.assertRaises(NotImplementedError, lambda: box.values().__next__())
435 self.assertRaises(NotImplementedError, lambda: box.__iter__().__next__())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000436 self.assertRaises(NotImplementedError, lambda: box.values())
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000437 self.assertRaises(NotImplementedError, lambda: box.items().next())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000438 self.assertRaises(NotImplementedError, lambda: box.items())
439 self.assertRaises(NotImplementedError, lambda: box.get(''))
440 self.assertRaises(NotImplementedError, lambda: box.__getitem__(''))
441 self.assertRaises(NotImplementedError, lambda: box.get_message(''))
442 self.assertRaises(NotImplementedError, lambda: box.get_string(''))
443 self.assertRaises(NotImplementedError, lambda: box.get_file(''))
Guido van Rossume2b70bc2006-08-18 22:13:04 +0000444 self.assertRaises(NotImplementedError, lambda: '' in box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000445 self.assertRaises(NotImplementedError, lambda: box.__contains__(''))
446 self.assertRaises(NotImplementedError, lambda: box.__len__())
447 self.assertRaises(NotImplementedError, lambda: box.clear())
448 self.assertRaises(NotImplementedError, lambda: box.pop(''))
449 self.assertRaises(NotImplementedError, lambda: box.popitem())
450 self.assertRaises(NotImplementedError, lambda: box.update((('', ''),)))
451 self.assertRaises(NotImplementedError, lambda: box.flush())
452 self.assertRaises(NotImplementedError, lambda: box.lock())
453 self.assertRaises(NotImplementedError, lambda: box.unlock())
454 self.assertRaises(NotImplementedError, lambda: box.close())
455
456
457class TestMaildir(TestMailbox):
458
459 _factory = lambda self, path, factory=None: mailbox.Maildir(path, factory)
460
461 def setUp(self):
462 TestMailbox.setUp(self)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000463 if os.name in ('nt', 'os2') or sys.platform == 'cygwin':
Thomas Wouters477c8d52006-05-27 19:21:47 +0000464 self._box.colon = '!'
465
466 def test_add_MM(self):
467 # Add a MaildirMessage instance
468 msg = mailbox.MaildirMessage(self._template % 0)
469 msg.set_subdir('cur')
470 msg.set_info('foo')
471 key = self._box.add(msg)
472 self.assert_(os.path.exists(os.path.join(self._path, 'cur', '%s%sfoo' %
473 (key, self._box.colon))))
474
475 def test_get_MM(self):
476 # Get a MaildirMessage instance
477 msg = mailbox.MaildirMessage(self._template % 0)
478 msg.set_subdir('cur')
479 msg.set_flags('RF')
480 key = self._box.add(msg)
481 msg_returned = self._box.get_message(key)
482 self.assert_(isinstance(msg_returned, mailbox.MaildirMessage))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000483 self.assertEqual(msg_returned.get_subdir(), 'cur')
484 self.assertEqual(msg_returned.get_flags(), 'FR')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000485
486 def test_set_MM(self):
487 # Set with a MaildirMessage instance
488 msg0 = mailbox.MaildirMessage(self._template % 0)
489 msg0.set_flags('TP')
490 key = self._box.add(msg0)
491 msg_returned = self._box.get_message(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000492 self.assertEqual(msg_returned.get_subdir(), 'new')
493 self.assertEqual(msg_returned.get_flags(), 'PT')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000494 msg1 = mailbox.MaildirMessage(self._template % 1)
495 self._box[key] = msg1
496 msg_returned = self._box.get_message(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000497 self.assertEqual(msg_returned.get_subdir(), 'new')
498 self.assertEqual(msg_returned.get_flags(), '')
499 self.assertEqual(msg_returned.get_payload(), '1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000500 msg2 = mailbox.MaildirMessage(self._template % 2)
501 msg2.set_info('2,S')
502 self._box[key] = msg2
503 self._box[key] = self._template % 3
504 msg_returned = self._box.get_message(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000505 self.assertEqual(msg_returned.get_subdir(), 'new')
506 self.assertEqual(msg_returned.get_flags(), 'S')
507 self.assertEqual(msg_returned.get_payload(), '3')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000508
509 def test_initialize_new(self):
510 # Initialize a non-existent mailbox
511 self.tearDown()
512 self._box = mailbox.Maildir(self._path)
513 self._check_basics(factory=rfc822.Message)
514 self._delete_recursively(self._path)
515 self._box = self._factory(self._path, factory=None)
516 self._check_basics()
517
518 def test_initialize_existing(self):
519 # Initialize an existing mailbox
520 self.tearDown()
521 for subdir in '', 'tmp', 'new', 'cur':
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000522 os.mkdir(os.path.normpath(os.path.join(self._path, subdir)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000523 self._box = mailbox.Maildir(self._path)
524 self._check_basics(factory=rfc822.Message)
525 self._box = mailbox.Maildir(self._path, factory=None)
526 self._check_basics()
527
528 def _check_basics(self, factory=None):
529 # (Used by test_open_new() and test_open_existing().)
530 self.assertEqual(self._box._path, os.path.abspath(self._path))
531 self.assertEqual(self._box._factory, factory)
532 for subdir in '', 'tmp', 'new', 'cur':
533 path = os.path.join(self._path, subdir)
534 mode = os.stat(path)[stat.ST_MODE]
535 self.assert_(stat.S_ISDIR(mode), "Not a directory: '%s'" % path)
536
537 def test_list_folders(self):
538 # List folders
539 self._box.add_folder('one')
540 self._box.add_folder('two')
541 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000542 self.assertEqual(len(self._box.list_folders()), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000543 self.assertEqual(set(self._box.list_folders()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000544 set(('one', 'two', 'three')))
545
546 def test_get_folder(self):
547 # Open folders
548 self._box.add_folder('foo.bar')
549 folder0 = self._box.get_folder('foo.bar')
550 folder0.add(self._template % 'bar')
551 self.assert_(os.path.isdir(os.path.join(self._path, '.foo.bar')))
552 folder1 = self._box.get_folder('foo.bar')
Guido van Rossumea834472007-07-27 05:17:50 +0000553 self.assertEqual(folder1.get_string(folder1.keys()[0]),
554 self._template % 'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000555
556 def test_add_and_remove_folders(self):
557 # Delete folders
558 self._box.add_folder('one')
559 self._box.add_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000560 self.assertEqual(len(self._box.list_folders()), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000561 self.assert_(set(self._box.list_folders()) == set(('one', 'two')))
562 self._box.remove_folder('one')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000563 self.assertEqual(len(self._box.list_folders()), 1)
564 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000565 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000566 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000567 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000568 self._box.remove_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000569 self.assertEqual(len(self._box.list_folders()), 1)
570 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000571 self._box.remove_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000572 self.assertEqual(len(self._box.list_folders()), 0)
573 self.assertEqual(self._box.list_folders(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000574
575 def test_clean(self):
576 # Remove old files from 'tmp'
577 foo_path = os.path.join(self._path, 'tmp', 'foo')
578 bar_path = os.path.join(self._path, 'tmp', 'bar')
579 f = open(foo_path, 'w')
580 f.write("@")
581 f.close()
582 f = open(bar_path, 'w')
583 f.write("@")
584 f.close()
585 self._box.clean()
586 self.assert_(os.path.exists(foo_path))
587 self.assert_(os.path.exists(bar_path))
588 foo_stat = os.stat(foo_path)
589 os.utime(foo_path, (time.time() - 129600 - 2,
590 foo_stat.st_mtime))
591 self._box.clean()
592 self.assert_(not os.path.exists(foo_path))
593 self.assert_(os.path.exists(bar_path))
594
595 def test_create_tmp(self, repetitions=10):
596 # Create files in tmp directory
597 hostname = socket.gethostname()
598 if '/' in hostname:
599 hostname = hostname.replace('/', r'\057')
600 if ':' in hostname:
601 hostname = hostname.replace(':', r'\072')
602 pid = os.getpid()
603 pattern = re.compile(r"(?P<time>\d+)\.M(?P<M>\d{1,6})P(?P<P>\d+)"
604 r"Q(?P<Q>\d+)\.(?P<host>[^:/]+)")
605 previous_groups = None
Guido van Rossum805365e2007-05-07 22:24:25 +0000606 for x in range(repetitions):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000607 tmp_file = self._box._create_tmp()
608 head, tail = os.path.split(tmp_file.name)
609 self.assertEqual(head, os.path.abspath(os.path.join(self._path,
610 "tmp")),
611 "File in wrong location: '%s'" % head)
612 match = pattern.match(tail)
613 self.assert_(match != None, "Invalid file name: '%s'" % tail)
614 groups = match.groups()
615 if previous_groups != None:
616 self.assert_(int(groups[0] >= previous_groups[0]),
617 "Non-monotonic seconds: '%s' before '%s'" %
618 (previous_groups[0], groups[0]))
619 self.assert_(int(groups[1] >= previous_groups[1]) or
620 groups[0] != groups[1],
621 "Non-monotonic milliseconds: '%s' before '%s'" %
622 (previous_groups[1], groups[1]))
Guido van Rossumea834472007-07-27 05:17:50 +0000623 self.assertEqual(int(groups[2]), pid,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000624 "Process ID mismatch: '%s' should be '%s'" %
625 (groups[2], pid))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000626 self.assertEqual(int(groups[3]), int(previous_groups[3]) + 1,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000627 "Non-sequential counter: '%s' before '%s'" %
628 (previous_groups[3], groups[3]))
Guido van Rossumea834472007-07-27 05:17:50 +0000629 self.assertEqual(groups[4], hostname,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000630 "Host name mismatch: '%s' should be '%s'" %
631 (groups[4], hostname))
632 previous_groups = groups
633 tmp_file.write(_sample_message)
634 tmp_file.seek(0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000635 self.assertEqual(tmp_file.read(), _sample_message)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000636 tmp_file.close()
637 file_count = len(os.listdir(os.path.join(self._path, "tmp")))
Guido van Rossumea834472007-07-27 05:17:50 +0000638 self.assertEqual(file_count, repetitions,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000639 "Wrong file count: '%s' should be '%s'" %
640 (file_count, repetitions))
641
642 def test_refresh(self):
643 # Update the table of contents
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000644 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000645 key0 = self._box.add(self._template % 0)
646 key1 = self._box.add(self._template % 1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000647 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000648 self._box._refresh()
Guido van Rossumea834472007-07-27 05:17:50 +0000649 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
650 key1: os.path.join('new', key1)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000651 key2 = self._box.add(self._template % 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000652 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
653 key1: os.path.join('new', key1)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000654 self._box._refresh()
Guido van Rossumea834472007-07-27 05:17:50 +0000655 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
656 key1: os.path.join('new', key1),
657 key2: os.path.join('new', key2)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000658
659 def test_lookup(self):
660 # Look up message subpaths in the TOC
661 self.assertRaises(KeyError, lambda: self._box._lookup('foo'))
662 key0 = self._box.add(self._template % 0)
Guido van Rossumea834472007-07-27 05:17:50 +0000663 self.assertEqual(self._box._lookup(key0), os.path.join('new', key0))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000664 os.remove(os.path.join(self._path, 'new', key0))
Guido van Rossumea834472007-07-27 05:17:50 +0000665 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000666 self.assertRaises(KeyError, lambda: self._box._lookup(key0))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000667 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000668
669 def test_lock_unlock(self):
670 # Lock and unlock the mailbox. For Maildir, this does nothing.
671 self._box.lock()
672 self._box.unlock()
673
Thomas Wouters89f507f2006-12-13 04:49:30 +0000674 def test_folder (self):
675 # Test for bug #1569790: verify that folders returned by .get_folder()
676 # use the same factory function.
677 def dummy_factory (s):
678 return None
679 box = self._factory(self._path, factory=dummy_factory)
680 folder = box.add_folder('folder1')
681 self.assert_(folder._factory is dummy_factory)
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000682
Thomas Wouters89f507f2006-12-13 04:49:30 +0000683 folder1_alias = box.get_folder('folder1')
684 self.assert_(folder1_alias._factory is dummy_factory)
685
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000686 def test_directory_in_folder (self):
687 # Test that mailboxes still work if there's a stray extra directory
688 # in a folder.
689 for i in range(10):
690 self._box.add(mailbox.Message(_sample_message))
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000691
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000692 # Create a stray directory
693 os.mkdir(os.path.join(self._path, 'cur', 'stray-dir'))
694
695 # Check that looping still works with the directory present.
696 for msg in self._box:
697 pass
Thomas Wouters477c8d52006-05-27 19:21:47 +0000698
699class _TestMboxMMDF(TestMailbox):
700
701 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +0000702 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000703 self._delete_recursively(self._path)
704 for lock_remnant in glob.glob(self._path + '.*'):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000705 test_support.unlink(lock_remnant)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000706
707 def test_add_from_string(self):
708 # Add a string starting with 'From ' to the mailbox
709 key = self._box.add('From foo@bar blah\nFrom: foo\n\n0')
Guido van Rossumea834472007-07-27 05:17:50 +0000710 self.assertEqual(self._box[key].get_from(), 'foo@bar blah')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000711 self.assertEqual(self._box[key].get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000712
713 def test_add_mbox_or_mmdf_message(self):
714 # Add an mboxMessage or MMDFMessage
715 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
716 msg = class_('From foo@bar blah\nFrom: foo\n\n0')
717 key = self._box.add(msg)
718
719 def test_open_close_open(self):
720 # Open and inspect previously-created mailbox
Guido van Rossum805365e2007-05-07 22:24:25 +0000721 values = [self._template % i for i in range(3)]
Thomas Wouters477c8d52006-05-27 19:21:47 +0000722 for value in values:
723 self._box.add(value)
724 self._box.close()
725 mtime = os.path.getmtime(self._path)
726 self._box = self._factory(self._path)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000727 self.assertEqual(len(self._box), 3)
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000728 for key in self._box.keys():
Thomas Wouters477c8d52006-05-27 19:21:47 +0000729 self.assert_(self._box.get_string(key) in values)
730 self._box.close()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000731 self.assertEqual(mtime, os.path.getmtime(self._path))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000732
733 def test_add_and_close(self):
734 # Verifying that closing a mailbox doesn't change added items
735 self._box.add(_sample_message)
Guido van Rossum805365e2007-05-07 22:24:25 +0000736 for i in range(3):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000737 self._box.add(self._template % i)
738 self._box.add(_sample_message)
739 self._box._file.flush()
740 self._box._file.seek(0)
741 contents = self._box._file.read()
742 self._box.close()
Guido van Rossumea834472007-07-27 05:17:50 +0000743 self.assertEqual(contents, open(self._path, 'r').read())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000744 self._box = self._factory(self._path)
745
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000746 def test_lock_conflict(self):
747 # Fork off a subprocess that will lock the file for 2 seconds,
748 # unlock it, and then exit.
749 if not hasattr(os, 'fork'):
750 return
751 pid = os.fork()
752 if pid == 0:
753 # In the child, lock the mailbox.
Guido van Rossum62cbc8a2007-04-09 00:41:25 +0000754 try:
755 self._box.lock()
756 time.sleep(2)
757 self._box.unlock()
758 finally:
759 os._exit(0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000760
761 # In the parent, sleep a bit to give the child time to acquire
762 # the lock.
763 time.sleep(0.5)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000764 try:
765 self.assertRaises(mailbox.ExternalClashError,
766 self._box.lock)
767 finally:
768 # Wait for child to exit. Locking should now succeed.
769 exited_pid, status = os.waitpid(pid, 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000770
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000771 self._box.lock()
772 self._box.unlock()
773
Thomas Wouters89f507f2006-12-13 04:49:30 +0000774 def test_relock(self):
775 # Test case for bug #1575506: the mailbox class was locking the
776 # wrong file object in its flush() method.
777 msg = "Subject: sub\n\nbody\n"
778 key1 = self._box.add(msg)
779 self._box.flush()
780 self._box.close()
781
782 self._box = self._factory(self._path)
783 self._box.lock()
784 key2 = self._box.add(msg)
785 self._box.flush()
786 self.assert_(self._box._locked)
787 self._box.close()
788
789
Thomas Wouters477c8d52006-05-27 19:21:47 +0000790
791class TestMbox(_TestMboxMMDF):
792
793 _factory = lambda self, path, factory=None: mailbox.mbox(path, factory)
794
795
796class TestMMDF(_TestMboxMMDF):
797
798 _factory = lambda self, path, factory=None: mailbox.MMDF(path, factory)
799
800
801class TestMH(TestMailbox):
802
803 _factory = lambda self, path, factory=None: mailbox.MH(path, factory)
804
805 def test_list_folders(self):
806 # List folders
807 self._box.add_folder('one')
808 self._box.add_folder('two')
809 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000810 self.assertEqual(len(self._box.list_folders()), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000811 self.assertEqual(set(self._box.list_folders()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000812 set(('one', 'two', 'three')))
813
814 def test_get_folder(self):
815 # Open folders
Thomas Wouters89f507f2006-12-13 04:49:30 +0000816 def dummy_factory (s):
817 return None
818 self._box = self._factory(self._path, dummy_factory)
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000819
Thomas Wouters89f507f2006-12-13 04:49:30 +0000820 new_folder = self._box.add_folder('foo.bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000821 folder0 = self._box.get_folder('foo.bar')
822 folder0.add(self._template % 'bar')
823 self.assert_(os.path.isdir(os.path.join(self._path, 'foo.bar')))
824 folder1 = self._box.get_folder('foo.bar')
Guido van Rossumea834472007-07-27 05:17:50 +0000825 self.assertEqual(folder1.get_string(folder1.keys()[0]),
826 self._template % 'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000827
Thomas Wouters89f507f2006-12-13 04:49:30 +0000828 # Test for bug #1569790: verify that folders returned by .get_folder()
829 # use the same factory function.
830 self.assert_(new_folder._factory is self._box._factory)
831 self.assert_(folder0._factory is self._box._factory)
832
Thomas Wouters477c8d52006-05-27 19:21:47 +0000833 def test_add_and_remove_folders(self):
834 # Delete folders
835 self._box.add_folder('one')
836 self._box.add_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000837 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000838 self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000839 self._box.remove_folder('one')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000840 self.assertEqual(len(self._box.list_folders()), 1)
841 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000842 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000843 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000844 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000845 self._box.remove_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000846 self.assertEqual(len(self._box.list_folders()), 1)
847 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000848 self._box.remove_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000849 self.assertEqual(len(self._box.list_folders()), 0)
850 self.assertEqual(self._box.list_folders(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000851
852 def test_sequences(self):
853 # Get and set sequences
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000854 self.assertEqual(self._box.get_sequences(), {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000855 msg0 = mailbox.MHMessage(self._template % 0)
856 msg0.add_sequence('foo')
857 key0 = self._box.add(msg0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000858 self.assertEqual(self._box.get_sequences(), {'foo':[key0]})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000859 msg1 = mailbox.MHMessage(self._template % 1)
860 msg1.set_sequences(['bar', 'replied', 'foo'])
861 key1 = self._box.add(msg1)
Guido van Rossumea834472007-07-27 05:17:50 +0000862 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000863 {'foo':[key0, key1], 'bar':[key1], 'replied':[key1]})
864 msg0.set_sequences(['flagged'])
865 self._box[key0] = msg0
Guido van Rossumea834472007-07-27 05:17:50 +0000866 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000867 {'foo':[key1], 'bar':[key1], 'replied':[key1],
868 'flagged':[key0]})
869 self._box.remove(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000870 self.assertEqual(self._box.get_sequences(), {'flagged':[key0]})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000871
872 def test_pack(self):
873 # Pack the contents of the mailbox
874 msg0 = mailbox.MHMessage(self._template % 0)
875 msg1 = mailbox.MHMessage(self._template % 1)
876 msg2 = mailbox.MHMessage(self._template % 2)
877 msg3 = mailbox.MHMessage(self._template % 3)
878 msg0.set_sequences(['foo', 'unseen'])
879 msg1.set_sequences(['foo'])
880 msg2.set_sequences(['foo', 'flagged'])
881 msg3.set_sequences(['foo', 'bar', 'replied'])
882 key0 = self._box.add(msg0)
883 key1 = self._box.add(msg1)
884 key2 = self._box.add(msg2)
885 key3 = self._box.add(msg3)
Guido van Rossumea834472007-07-27 05:17:50 +0000886 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000887 {'foo':[key0,key1,key2,key3], 'unseen':[key0],
888 'flagged':[key2], 'bar':[key3], 'replied':[key3]})
889 self._box.remove(key2)
Guido van Rossumea834472007-07-27 05:17:50 +0000890 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000891 {'foo':[key0,key1,key3], 'unseen':[key0], 'bar':[key3],
892 'replied':[key3]})
893 self._box.pack()
894 self.assert_(self._box.keys() == [1, 2, 3])
895 key0 = key0
896 key1 = key0 + 1
897 key2 = key1 + 1
Guido van Rossumea834472007-07-27 05:17:50 +0000898 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000899 {'foo':[1, 2, 3], 'unseen':[1], 'bar':[3], 'replied':[3]})
900
Thomas Wouters89f507f2006-12-13 04:49:30 +0000901 # Test case for packing while holding the mailbox locked.
902 key0 = self._box.add(msg1)
903 key1 = self._box.add(msg1)
904 key2 = self._box.add(msg1)
905 key3 = self._box.add(msg1)
906
907 self._box.remove(key0)
908 self._box.remove(key2)
909 self._box.lock()
910 self._box.pack()
911 self._box.unlock()
Guido van Rossumea834472007-07-27 05:17:50 +0000912 self.assertEqual(self._box.get_sequences(),
Thomas Wouters89f507f2006-12-13 04:49:30 +0000913 {'foo':[1, 2, 3, 4, 5],
914 'unseen':[1], 'bar':[3], 'replied':[3]})
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000915
Thomas Wouters477c8d52006-05-27 19:21:47 +0000916 def _get_lock_path(self):
917 return os.path.join(self._path, '.mh_sequences.lock')
918
919
920class TestBabyl(TestMailbox):
921
922 _factory = lambda self, path, factory=None: mailbox.Babyl(path, factory)
923
924 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +0000925 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000926 self._delete_recursively(self._path)
927 for lock_remnant in glob.glob(self._path + '.*'):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000928 test_support.unlink(lock_remnant)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000929
930 def test_labels(self):
931 # Get labels from the mailbox
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000932 self.assertEqual(self._box.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000933 msg0 = mailbox.BabylMessage(self._template % 0)
934 msg0.add_label('foo')
935 key0 = self._box.add(msg0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000936 self.assertEqual(self._box.get_labels(), ['foo'])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000937 msg1 = mailbox.BabylMessage(self._template % 1)
938 msg1.set_labels(['bar', 'answered', 'foo'])
939 key1 = self._box.add(msg1)
Guido van Rossumea834472007-07-27 05:17:50 +0000940 self.assertEqual(set(self._box.get_labels()), set(['foo', 'bar']))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000941 msg0.set_labels(['blah', 'filed'])
942 self._box[key0] = msg0
Guido van Rossumea834472007-07-27 05:17:50 +0000943 self.assertEqual(set(self._box.get_labels()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000944 set(['foo', 'bar', 'blah']))
945 self._box.remove(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000946 self.assertEqual(set(self._box.get_labels()), set(['blah']))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000947
948
949class TestMessage(TestBase):
950
951 _factory = mailbox.Message # Overridden by subclasses to reuse tests
952
953 def setUp(self):
954 self._path = test_support.TESTFN
955
956 def tearDown(self):
957 self._delete_recursively(self._path)
958
959 def test_initialize_with_eMM(self):
Thomas Woutersb2137042007-02-01 18:02:27 +0000960 # Initialize based on email.message.Message instance
Thomas Wouters477c8d52006-05-27 19:21:47 +0000961 eMM = email.message_from_string(_sample_message)
962 msg = self._factory(eMM)
963 self._post_initialize_hook(msg)
964 self._check_sample(msg)
965
966 def test_initialize_with_string(self):
967 # Initialize based on string
968 msg = self._factory(_sample_message)
969 self._post_initialize_hook(msg)
970 self._check_sample(msg)
971
972 def test_initialize_with_file(self):
973 # Initialize based on contents of file
974 f = open(self._path, 'w+')
975 f.write(_sample_message)
976 f.seek(0)
977 msg = self._factory(f)
978 self._post_initialize_hook(msg)
979 self._check_sample(msg)
980 f.close()
981
982 def test_initialize_with_nothing(self):
983 # Initialize without arguments
984 msg = self._factory()
985 self._post_initialize_hook(msg)
Thomas Woutersb2137042007-02-01 18:02:27 +0000986 self.assert_(isinstance(msg, email.message.Message))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000987 self.assert_(isinstance(msg, mailbox.Message))
988 self.assert_(isinstance(msg, self._factory))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000989 self.assertEqual(msg.keys(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000990 self.assert_(not msg.is_multipart())
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000991 self.assertEqual(msg.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000992
993 def test_initialize_incorrectly(self):
994 # Initialize with invalid argument
995 self.assertRaises(TypeError, lambda: self._factory(object()))
996
997 def test_become_message(self):
998 # Take on the state of another message
999 eMM = email.message_from_string(_sample_message)
1000 msg = self._factory()
1001 msg._become_message(eMM)
1002 self._check_sample(msg)
1003
1004 def test_explain_to(self):
1005 # Copy self's format-specific data to other message formats.
1006 # This test is superficial; better ones are in TestMessageConversion.
1007 msg = self._factory()
1008 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1009 mailbox.mboxMessage, mailbox.MHMessage,
1010 mailbox.BabylMessage, mailbox.MMDFMessage):
1011 other_msg = class_()
1012 msg._explain_to(other_msg)
Thomas Woutersb2137042007-02-01 18:02:27 +00001013 other_msg = email.message.Message()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001014 self.assertRaises(TypeError, lambda: msg._explain_to(other_msg))
1015
1016 def _post_initialize_hook(self, msg):
1017 # Overridden by subclasses to check extra things after initialization
1018 pass
1019
1020
1021class TestMaildirMessage(TestMessage):
1022
1023 _factory = mailbox.MaildirMessage
1024
1025 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001026 self.assertEqual(msg._subdir, 'new')
1027 self.assertEqual(msg._info, '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001028
1029 def test_subdir(self):
1030 # Use get_subdir() and set_subdir()
1031 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001032 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001033 msg.set_subdir('cur')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001034 self.assertEqual(msg.get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001035 msg.set_subdir('new')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001036 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001037 self.assertRaises(ValueError, lambda: msg.set_subdir('tmp'))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001038 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001039 msg.set_subdir('new')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001040 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001041 self._check_sample(msg)
1042
1043 def test_flags(self):
1044 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1045 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001046 self.assertEqual(msg.get_flags(), '')
1047 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001048 msg.set_flags('F')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001049 self.assertEqual(msg.get_subdir(), 'new')
1050 self.assertEqual(msg.get_flags(), 'F')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001051 msg.set_flags('SDTP')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001052 self.assertEqual(msg.get_flags(), 'DPST')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001053 msg.add_flag('FT')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001054 self.assertEqual(msg.get_flags(), 'DFPST')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001055 msg.remove_flag('TDRP')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001056 self.assertEqual(msg.get_flags(), 'FS')
1057 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001058 self._check_sample(msg)
1059
1060 def test_date(self):
1061 # Use get_date() and set_date()
1062 msg = mailbox.MaildirMessage(_sample_message)
1063 self.assert_(abs(msg.get_date() - time.time()) < 60)
1064 msg.set_date(0.0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001065 self.assertEqual(msg.get_date(), 0.0)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001066
1067 def test_info(self):
1068 # Use get_info() and set_info()
1069 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001070 self.assertEqual(msg.get_info(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001071 msg.set_info('1,foo=bar')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001072 self.assertEqual(msg.get_info(), '1,foo=bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001073 self.assertRaises(TypeError, lambda: msg.set_info(None))
1074 self._check_sample(msg)
1075
1076 def test_info_and_flags(self):
1077 # Test interaction of info and flag methods
1078 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001079 self.assertEqual(msg.get_info(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001080 msg.set_flags('SF')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001081 self.assertEqual(msg.get_flags(), 'FS')
1082 self.assertEqual(msg.get_info(), '2,FS')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001083 msg.set_info('1,')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001084 self.assertEqual(msg.get_flags(), '')
1085 self.assertEqual(msg.get_info(), '1,')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001086 msg.remove_flag('RPT')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001087 self.assertEqual(msg.get_flags(), '')
1088 self.assertEqual(msg.get_info(), '1,')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001089 msg.add_flag('D')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001090 self.assertEqual(msg.get_flags(), 'D')
1091 self.assertEqual(msg.get_info(), '2,D')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001092 self._check_sample(msg)
1093
1094
1095class _TestMboxMMDFMessage(TestMessage):
1096
1097 _factory = mailbox._mboxMMDFMessage
1098
1099 def _post_initialize_hook(self, msg):
1100 self._check_from(msg)
1101
1102 def test_initialize_with_unixfrom(self):
1103 # Initialize with a message that already has a _unixfrom attribute
1104 msg = mailbox.Message(_sample_message)
1105 msg.set_unixfrom('From foo@bar blah')
1106 msg = mailbox.mboxMessage(msg)
Guido van Rossumea834472007-07-27 05:17:50 +00001107 self.assertEqual(msg.get_from(), 'foo@bar blah', msg.get_from())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001108
1109 def test_from(self):
1110 # Get and set "From " line
1111 msg = mailbox.mboxMessage(_sample_message)
1112 self._check_from(msg)
1113 msg.set_from('foo bar')
Guido van Rossumea834472007-07-27 05:17:50 +00001114 self.assertEqual(msg.get_from(), 'foo bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001115 msg.set_from('foo@bar', True)
1116 self._check_from(msg, 'foo@bar')
1117 msg.set_from('blah@temp', time.localtime())
1118 self._check_from(msg, 'blah@temp')
1119
1120 def test_flags(self):
1121 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1122 msg = mailbox.mboxMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001123 self.assertEqual(msg.get_flags(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001124 msg.set_flags('F')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001125 self.assertEqual(msg.get_flags(), 'F')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001126 msg.set_flags('XODR')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001127 self.assertEqual(msg.get_flags(), 'RODX')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001128 msg.add_flag('FA')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001129 self.assertEqual(msg.get_flags(), 'RODFAX')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001130 msg.remove_flag('FDXA')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001131 self.assertEqual(msg.get_flags(), 'RO')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001132 self._check_sample(msg)
1133
1134 def _check_from(self, msg, sender=None):
1135 # Check contents of "From " line
1136 if sender is None:
1137 sender = "MAILER-DAEMON"
1138 self.assert_(re.match(sender + r" \w{3} \w{3} [\d ]\d [\d ]\d:\d{2}:"
1139 r"\d{2} \d{4}", msg.get_from()) is not None)
1140
1141
1142class TestMboxMessage(_TestMboxMMDFMessage):
1143
1144 _factory = mailbox.mboxMessage
1145
1146
1147class TestMHMessage(TestMessage):
1148
1149 _factory = mailbox.MHMessage
1150
1151 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001152 self.assertEqual(msg._sequences, [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001153
1154 def test_sequences(self):
1155 # Get, set, join, and leave sequences
1156 msg = mailbox.MHMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001157 self.assertEqual(msg.get_sequences(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001158 msg.set_sequences(['foobar'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001159 self.assertEqual(msg.get_sequences(), ['foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001160 msg.set_sequences([])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001161 self.assertEqual(msg.get_sequences(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001162 msg.add_sequence('unseen')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001163 self.assertEqual(msg.get_sequences(), ['unseen'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001164 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001165 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001166 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001167 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001168 msg.remove_sequence('unseen')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001169 self.assertEqual(msg.get_sequences(), ['flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001170 msg.add_sequence('foobar')
Guido van Rossumea834472007-07-27 05:17:50 +00001171 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001172 msg.remove_sequence('replied')
Guido van Rossumea834472007-07-27 05:17:50 +00001173 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001174 msg.set_sequences(['foobar', 'replied'])
Guido van Rossumea834472007-07-27 05:17:50 +00001175 self.assertEqual(msg.get_sequences(), ['foobar', 'replied'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001176
1177
1178class TestBabylMessage(TestMessage):
1179
1180 _factory = mailbox.BabylMessage
1181
1182 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001183 self.assertEqual(msg._labels, [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001184
1185 def test_labels(self):
1186 # Get, set, join, and leave labels
1187 msg = mailbox.BabylMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001188 self.assertEqual(msg.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001189 msg.set_labels(['foobar'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001190 self.assertEqual(msg.get_labels(), ['foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001191 msg.set_labels([])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001192 self.assertEqual(msg.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001193 msg.add_label('filed')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001194 self.assertEqual(msg.get_labels(), ['filed'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001195 msg.add_label('resent')
Guido van Rossumea834472007-07-27 05:17:50 +00001196 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001197 msg.add_label('resent')
Guido van Rossumea834472007-07-27 05:17:50 +00001198 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001199 msg.remove_label('filed')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001200 self.assertEqual(msg.get_labels(), ['resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001201 msg.add_label('foobar')
Guido van Rossumea834472007-07-27 05:17:50 +00001202 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001203 msg.remove_label('unseen')
Guido van Rossumea834472007-07-27 05:17:50 +00001204 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001205 msg.set_labels(['foobar', 'answered'])
Guido van Rossumea834472007-07-27 05:17:50 +00001206 self.assertEqual(msg.get_labels(), ['foobar', 'answered'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001207
1208 def test_visible(self):
1209 # Get, set, and update visible headers
1210 msg = mailbox.BabylMessage(_sample_message)
1211 visible = msg.get_visible()
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001212 self.assertEqual(visible.keys(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001213 self.assert_(visible.get_payload() is None)
1214 visible['User-Agent'] = 'FooBar 1.0'
1215 visible['X-Whatever'] = 'Blah'
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001216 self.assertEqual(msg.get_visible().keys(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001217 msg.set_visible(visible)
1218 visible = msg.get_visible()
1219 self.assert_(visible.keys() == ['User-Agent', 'X-Whatever'])
1220 self.assert_(visible['User-Agent'] == 'FooBar 1.0')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001221 self.assertEqual(visible['X-Whatever'], 'Blah')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001222 self.assert_(visible.get_payload() is None)
1223 msg.update_visible()
Guido van Rossumea834472007-07-27 05:17:50 +00001224 self.assertEqual(visible.keys(), ['User-Agent', 'X-Whatever'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001225 self.assert_(visible.get_payload() is None)
1226 visible = msg.get_visible()
Guido van Rossumea834472007-07-27 05:17:50 +00001227 self.assertEqual(visible.keys(), ['User-Agent', 'Date', 'From', 'To',
1228 'Subject'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001229 for header in ('User-Agent', 'Date', 'From', 'To', 'Subject'):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001230 self.assertEqual(visible[header], msg[header])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001231
1232
1233class TestMMDFMessage(_TestMboxMMDFMessage):
1234
1235 _factory = mailbox.MMDFMessage
1236
1237
1238class TestMessageConversion(TestBase):
1239
1240 def test_plain_to_x(self):
1241 # Convert Message to all formats
1242 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1243 mailbox.mboxMessage, mailbox.MHMessage,
1244 mailbox.BabylMessage, mailbox.MMDFMessage):
1245 msg_plain = mailbox.Message(_sample_message)
1246 msg = class_(msg_plain)
1247 self._check_sample(msg)
1248
1249 def test_x_to_plain(self):
1250 # Convert all formats to Message
1251 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1252 mailbox.mboxMessage, mailbox.MHMessage,
1253 mailbox.BabylMessage, mailbox.MMDFMessage):
1254 msg = class_(_sample_message)
1255 msg_plain = mailbox.Message(msg)
1256 self._check_sample(msg_plain)
1257
1258 def test_x_to_invalid(self):
1259 # Convert all formats to an invalid format
1260 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1261 mailbox.mboxMessage, mailbox.MHMessage,
1262 mailbox.BabylMessage, mailbox.MMDFMessage):
1263 self.assertRaises(TypeError, lambda: class_(False))
1264
1265 def test_maildir_to_maildir(self):
1266 # Convert MaildirMessage to MaildirMessage
1267 msg_maildir = mailbox.MaildirMessage(_sample_message)
1268 msg_maildir.set_flags('DFPRST')
1269 msg_maildir.set_subdir('cur')
1270 date = msg_maildir.get_date()
1271 msg = mailbox.MaildirMessage(msg_maildir)
1272 self._check_sample(msg)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001273 self.assertEqual(msg.get_flags(), 'DFPRST')
1274 self.assertEqual(msg.get_subdir(), 'cur')
1275 self.assertEqual(msg.get_date(), date)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001276
1277 def test_maildir_to_mboxmmdf(self):
1278 # Convert MaildirMessage to mboxmessage and MMDFMessage
1279 pairs = (('D', ''), ('F', 'F'), ('P', ''), ('R', 'A'), ('S', 'R'),
1280 ('T', 'D'), ('DFPRST', 'RDFA'))
1281 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1282 msg_maildir = mailbox.MaildirMessage(_sample_message)
1283 msg_maildir.set_date(0.0)
1284 for setting, result in pairs:
1285 msg_maildir.set_flags(setting)
1286 msg = class_(msg_maildir)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001287 self.assertEqual(msg.get_flags(), result)
Guido van Rossumea834472007-07-27 05:17:50 +00001288 self.assertEqual(msg.get_from(), 'MAILER-DAEMON %s' %
Thomas Wouters477c8d52006-05-27 19:21:47 +00001289 time.asctime(time.gmtime(0.0)))
1290 msg_maildir.set_subdir('cur')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001291 self.assertEqual(class_(msg_maildir).get_flags(), 'RODFA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001292
1293 def test_maildir_to_mh(self):
1294 # Convert MaildirMessage to MHMessage
1295 msg_maildir = mailbox.MaildirMessage(_sample_message)
1296 pairs = (('D', ['unseen']), ('F', ['unseen', 'flagged']),
1297 ('P', ['unseen']), ('R', ['unseen', 'replied']), ('S', []),
1298 ('T', ['unseen']), ('DFPRST', ['replied', 'flagged']))
1299 for setting, result in pairs:
1300 msg_maildir.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001301 self.assertEqual(mailbox.MHMessage(msg_maildir).get_sequences(),
1302 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001303
1304 def test_maildir_to_babyl(self):
1305 # Convert MaildirMessage to Babyl
1306 msg_maildir = mailbox.MaildirMessage(_sample_message)
1307 pairs = (('D', ['unseen']), ('F', ['unseen']),
1308 ('P', ['unseen', 'forwarded']), ('R', ['unseen', 'answered']),
1309 ('S', []), ('T', ['unseen', 'deleted']),
1310 ('DFPRST', ['deleted', 'answered', 'forwarded']))
1311 for setting, result in pairs:
1312 msg_maildir.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001313 self.assertEqual(mailbox.BabylMessage(msg_maildir).get_labels(),
1314 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001315
1316 def test_mboxmmdf_to_maildir(self):
1317 # Convert mboxMessage and MMDFMessage to MaildirMessage
1318 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1319 msg_mboxMMDF = class_(_sample_message)
1320 msg_mboxMMDF.set_from('foo@bar', time.gmtime(0.0))
1321 pairs = (('R', 'S'), ('O', ''), ('D', 'T'), ('F', 'F'), ('A', 'R'),
1322 ('RODFA', 'FRST'))
1323 for setting, result in pairs:
1324 msg_mboxMMDF.set_flags(setting)
1325 msg = mailbox.MaildirMessage(msg_mboxMMDF)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001326 self.assertEqual(msg.get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001327 self.assert_(msg.get_date() == 0.0, msg.get_date())
1328 msg_mboxMMDF.set_flags('O')
Guido van Rossumea834472007-07-27 05:17:50 +00001329 self.assertEqual(mailbox.MaildirMessage(msg_mboxMMDF).get_subdir(),
1330 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001331
1332 def test_mboxmmdf_to_mboxmmdf(self):
1333 # Convert mboxMessage and MMDFMessage to mboxMessage and MMDFMessage
1334 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1335 msg_mboxMMDF = class_(_sample_message)
1336 msg_mboxMMDF.set_flags('RODFA')
1337 msg_mboxMMDF.set_from('foo@bar')
1338 for class2_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1339 msg2 = class2_(msg_mboxMMDF)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001340 self.assertEqual(msg2.get_flags(), 'RODFA')
1341 self.assertEqual(msg2.get_from(), 'foo@bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001342
1343 def test_mboxmmdf_to_mh(self):
1344 # Convert mboxMessage and MMDFMessage to MHMessage
1345 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1346 msg_mboxMMDF = class_(_sample_message)
1347 pairs = (('R', []), ('O', ['unseen']), ('D', ['unseen']),
1348 ('F', ['unseen', 'flagged']),
1349 ('A', ['unseen', 'replied']),
1350 ('RODFA', ['replied', 'flagged']))
1351 for setting, result in pairs:
1352 msg_mboxMMDF.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001353 self.assertEqual(mailbox.MHMessage(msg_mboxMMDF).get_sequences(),
1354 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001355
1356 def test_mboxmmdf_to_babyl(self):
1357 # Convert mboxMessage and MMDFMessage to BabylMessage
1358 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1359 msg = class_(_sample_message)
1360 pairs = (('R', []), ('O', ['unseen']),
1361 ('D', ['unseen', 'deleted']), ('F', ['unseen']),
1362 ('A', ['unseen', 'answered']),
1363 ('RODFA', ['deleted', 'answered']))
1364 for setting, result in pairs:
1365 msg.set_flags(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001366 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001367
1368 def test_mh_to_maildir(self):
1369 # Convert MHMessage to MaildirMessage
1370 pairs = (('unseen', ''), ('replied', 'RS'), ('flagged', 'FS'))
1371 for setting, result in pairs:
1372 msg = mailbox.MHMessage(_sample_message)
1373 msg.add_sequence(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001374 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1375 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001376 msg = mailbox.MHMessage(_sample_message)
1377 msg.add_sequence('unseen')
1378 msg.add_sequence('replied')
1379 msg.add_sequence('flagged')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001380 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'FR')
1381 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001382
1383 def test_mh_to_mboxmmdf(self):
1384 # Convert MHMessage to mboxMessage and MMDFMessage
1385 pairs = (('unseen', 'O'), ('replied', 'ROA'), ('flagged', 'ROF'))
1386 for setting, result in pairs:
1387 msg = mailbox.MHMessage(_sample_message)
1388 msg.add_sequence(setting)
1389 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001390 self.assertEqual(class_(msg).get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001391 msg = mailbox.MHMessage(_sample_message)
1392 msg.add_sequence('unseen')
1393 msg.add_sequence('replied')
1394 msg.add_sequence('flagged')
1395 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001396 self.assertEqual(class_(msg).get_flags(), 'OFA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001397
1398 def test_mh_to_mh(self):
1399 # Convert MHMessage to MHMessage
1400 msg = mailbox.MHMessage(_sample_message)
1401 msg.add_sequence('unseen')
1402 msg.add_sequence('replied')
1403 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001404 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1405 ['unseen', 'replied', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001406
1407 def test_mh_to_babyl(self):
1408 # Convert MHMessage to BabylMessage
1409 pairs = (('unseen', ['unseen']), ('replied', ['answered']),
1410 ('flagged', []))
1411 for setting, result in pairs:
1412 msg = mailbox.MHMessage(_sample_message)
1413 msg.add_sequence(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001414 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001415 msg = mailbox.MHMessage(_sample_message)
1416 msg.add_sequence('unseen')
1417 msg.add_sequence('replied')
1418 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001419 self.assertEqual(mailbox.BabylMessage(msg).get_labels(),
1420 ['unseen', 'answered'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001421
1422 def test_babyl_to_maildir(self):
1423 # Convert BabylMessage to MaildirMessage
1424 pairs = (('unseen', ''), ('deleted', 'ST'), ('filed', 'S'),
1425 ('answered', 'RS'), ('forwarded', 'PS'), ('edited', 'S'),
1426 ('resent', 'PS'))
1427 for setting, result in pairs:
1428 msg = mailbox.BabylMessage(_sample_message)
1429 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001430 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1431 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001432 msg = mailbox.BabylMessage(_sample_message)
1433 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1434 'edited', 'resent'):
1435 msg.add_label(label)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001436 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'PRT')
1437 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001438
1439 def test_babyl_to_mboxmmdf(self):
1440 # Convert BabylMessage to mboxMessage and MMDFMessage
1441 pairs = (('unseen', 'O'), ('deleted', 'ROD'), ('filed', 'RO'),
1442 ('answered', 'ROA'), ('forwarded', 'RO'), ('edited', 'RO'),
1443 ('resent', 'RO'))
1444 for setting, result in pairs:
1445 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1446 msg = mailbox.BabylMessage(_sample_message)
1447 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001448 self.assertEqual(class_(msg).get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001449 msg = mailbox.BabylMessage(_sample_message)
1450 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1451 'edited', 'resent'):
1452 msg.add_label(label)
1453 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001454 self.assertEqual(class_(msg).get_flags(), 'ODA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001455
1456 def test_babyl_to_mh(self):
1457 # Convert BabylMessage to MHMessage
1458 pairs = (('unseen', ['unseen']), ('deleted', []), ('filed', []),
1459 ('answered', ['replied']), ('forwarded', []), ('edited', []),
1460 ('resent', []))
1461 for setting, result in pairs:
1462 msg = mailbox.BabylMessage(_sample_message)
1463 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001464 self.assertEqual(mailbox.MHMessage(msg).get_sequences(), 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)
Guido van Rossumea834472007-07-27 05:17:50 +00001469 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1470 ['unseen', 'replied'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001471
1472 def test_babyl_to_babyl(self):
1473 # Convert BabylMessage to BabylMessage
1474 msg = mailbox.BabylMessage(_sample_message)
1475 msg.update_visible()
1476 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1477 'edited', 'resent'):
1478 msg.add_label(label)
1479 msg2 = mailbox.BabylMessage(msg)
Guido van Rossumea834472007-07-27 05:17:50 +00001480 self.assertEqual(msg2.get_labels(), ['unseen', 'deleted', 'filed',
1481 'answered', 'forwarded', 'edited',
1482 'resent'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001483 self.assertEqual(msg.get_visible().keys(), msg2.get_visible().keys())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001484 for key in msg.get_visible().keys():
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001485 self.assertEqual(msg.get_visible()[key], msg2.get_visible()[key])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001486
1487
1488class TestProxyFileBase(TestBase):
1489
1490 def _test_read(self, proxy):
1491 # Read by byte
1492 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001493 self.assertEqual(proxy.read(), b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001494 proxy.seek(1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001495 self.assertEqual(proxy.read(), b'ar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001496 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001497 self.assertEqual(proxy.read(2), b'ba')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001498 proxy.seek(1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001499 self.assertEqual(proxy.read(-1), b'ar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001500 proxy.seek(2)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001501 self.assertEqual(proxy.read(1000), b'r')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001502
1503 def _test_readline(self, proxy):
1504 # Read by line
Guido van Rossum98297ee2007-11-06 21:34:58 +00001505 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001506 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001507 self.assertEqual(proxy.readline(), b'foo' + linesep)
1508 self.assertEqual(proxy.readline(), b'bar' + linesep)
1509 self.assertEqual(proxy.readline(), b'fred' + linesep)
1510 self.assertEqual(proxy.readline(), b'bob')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001511 proxy.seek(2)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001512 self.assertEqual(proxy.readline(), b'o' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001513 proxy.seek(6 + 2 * len(os.linesep))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001514 self.assertEqual(proxy.readline(), b'fred' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001515 proxy.seek(6 + 2 * len(os.linesep))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001516 self.assertEqual(proxy.readline(2), b'fr')
1517 self.assertEqual(proxy.readline(-10), b'ed' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001518
1519 def _test_readlines(self, proxy):
1520 # Read multiple lines
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.readlines(), [b'foo' + linesep,
1524 b'bar' + linesep,
1525 b'fred' + linesep, b'bob'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001526 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001527 self.assertEqual(proxy.readlines(2), [b'foo' + linesep])
1528 proxy.seek(3 + len(linesep))
1529 self.assertEqual(proxy.readlines(4 + len(linesep)),
1530 [b'bar' + linesep, b'fred' + linesep])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001531 proxy.seek(3)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001532 self.assertEqual(proxy.readlines(1000), [linesep, b'bar' + linesep,
1533 b'fred' + linesep, b'bob'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001534
1535 def _test_iteration(self, proxy):
1536 # Iterate by line
Guido van Rossum98297ee2007-11-06 21:34:58 +00001537 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001538 proxy.seek(0)
1539 iterator = iter(proxy)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001540 self.assertEqual(next(iterator), b'foo' + linesep)
1541 self.assertEqual(next(iterator), b'bar' + linesep)
1542 self.assertEqual(next(iterator), b'fred' + linesep)
1543 self.assertEqual(next(iterator), b'bob')
Georg Brandla18af4e2007-04-21 15:47:16 +00001544 self.assertRaises(StopIteration, next, iterator)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001545
1546 def _test_seek_and_tell(self, proxy):
1547 # Seek and use tell to check position
Guido van Rossum98297ee2007-11-06 21:34:58 +00001548 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001549 proxy.seek(3)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001550 self.assertEqual(proxy.tell(), 3)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001551 self.assertEqual(proxy.read(len(linesep)), linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001552 proxy.seek(2, 1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001553 self.assertEqual(proxy.read(1 + len(linesep)), b'r' + linesep)
1554 proxy.seek(-3 - len(linesep), 2)
1555 self.assertEqual(proxy.read(3), b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001556 proxy.seek(2, 0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001557 self.assertEqual(proxy.read(), b'o' + linesep + b'bar' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001558 proxy.seek(100)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001559 self.failIf(proxy.read())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001560
1561 def _test_close(self, proxy):
1562 # Close a file
1563 proxy.close()
1564 self.assertRaises(AttributeError, lambda: proxy.close())
1565
1566
1567class TestProxyFile(TestProxyFileBase):
1568
1569 def setUp(self):
1570 self._path = test_support.TESTFN
1571 self._file = open(self._path, 'wb+')
1572
1573 def tearDown(self):
1574 self._file.close()
1575 self._delete_recursively(self._path)
1576
1577 def test_initialize(self):
1578 # Initialize and check position
Neal Norwitz9a923102007-08-30 06:20:05 +00001579 self._file.write(b'foo')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001580 pos = self._file.tell()
1581 proxy0 = mailbox._ProxyFile(self._file)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001582 self.assertEqual(proxy0.tell(), pos)
1583 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001584 proxy1 = mailbox._ProxyFile(self._file, 0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001585 self.assertEqual(proxy1.tell(), 0)
1586 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001587
1588 def test_read(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001589 self._file.write(b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001590 self._test_read(mailbox._ProxyFile(self._file))
1591
1592 def test_readline(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001593 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1594 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001595 self._test_readline(mailbox._ProxyFile(self._file))
1596
1597 def test_readlines(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001598 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1599 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001600 self._test_readlines(mailbox._ProxyFile(self._file))
1601
1602 def test_iteration(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001603 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1604 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001605 self._test_iteration(mailbox._ProxyFile(self._file))
1606
1607 def test_seek_and_tell(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001608 self._file.write(bytes('foo%sbar%s' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001609 self._test_seek_and_tell(mailbox._ProxyFile(self._file))
1610
1611 def test_close(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001612 self._file.write(bytes('foo%sbar%s' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001613 self._test_close(mailbox._ProxyFile(self._file))
1614
1615
1616class TestPartialFile(TestProxyFileBase):
1617
1618 def setUp(self):
1619 self._path = test_support.TESTFN
1620 self._file = open(self._path, 'wb+')
1621
1622 def tearDown(self):
1623 self._file.close()
1624 self._delete_recursively(self._path)
1625
1626 def test_initialize(self):
1627 # Initialize and check position
Neal Norwitz9a923102007-08-30 06:20:05 +00001628 self._file.write(bytes('foo' + os.linesep + 'bar', 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001629 pos = self._file.tell()
1630 proxy = mailbox._PartialFile(self._file, 2, 5)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001631 self.assertEqual(proxy.tell(), 0)
1632 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001633
1634 def test_read(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001635 self._file.write(bytes('***bar***', 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001636 self._test_read(mailbox._PartialFile(self._file, 3, 6))
1637
1638 def test_readline(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001639 self._file.write(bytes('!!!!!foo%sbar%sfred%sbob!!!!!' %
1640 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001641 self._test_readline(mailbox._PartialFile(self._file, 5,
1642 18 + 3 * len(os.linesep)))
1643
1644 def test_readlines(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001645 self._file.write(bytes('foo%sbar%sfred%sbob?????' %
1646 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001647 self._test_readlines(mailbox._PartialFile(self._file, 0,
1648 13 + 3 * len(os.linesep)))
1649
1650 def test_iteration(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001651 self._file.write(bytes('____foo%sbar%sfred%sbob####' %
1652 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001653 self._test_iteration(mailbox._PartialFile(self._file, 4,
1654 17 + 3 * len(os.linesep)))
1655
1656 def test_seek_and_tell(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001657 self._file.write(bytes('(((foo%sbar%s$$$' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001658 self._test_seek_and_tell(mailbox._PartialFile(self._file, 3,
1659 9 + 2 * len(os.linesep)))
1660
1661 def test_close(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001662 self._file.write(bytes('&foo%sbar%s^' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001663 self._test_close(mailbox._PartialFile(self._file, 1,
1664 6 + 3 * len(os.linesep)))
1665
1666
1667## Start: tests from the original module (for backward compatibility).
1668
Skip Montanaro5253da12004-07-24 19:56:03 +00001669FROM_ = "From some.body@dummy.domain Sat Jul 24 13:43:35 2004\n"
Fred Drakec02bc3e2001-05-21 20:23:21 +00001670DUMMY_MESSAGE = """\
1671From: some.body@dummy.domain
1672To: me@my.domain
Skip Montanaro5253da12004-07-24 19:56:03 +00001673Subject: Simple Test
Fred Drakec02bc3e2001-05-21 20:23:21 +00001674
1675This is a dummy message.
1676"""
1677
Fred Drakec02bc3e2001-05-21 20:23:21 +00001678class MaildirTestCase(unittest.TestCase):
1679
1680 def setUp(self):
1681 # create a new maildir mailbox to work with:
1682 self._dir = test_support.TESTFN
1683 os.mkdir(self._dir)
1684 os.mkdir(os.path.join(self._dir, "cur"))
1685 os.mkdir(os.path.join(self._dir, "tmp"))
1686 os.mkdir(os.path.join(self._dir, "new"))
1687 self._counter = 1
1688 self._msgfiles = []
1689
1690 def tearDown(self):
Guido van Rossumc1f779c2007-07-03 08:25:58 +00001691 list(map(os.unlink, self._msgfiles))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001692 os.rmdir(os.path.join(self._dir, "cur"))
1693 os.rmdir(os.path.join(self._dir, "tmp"))
1694 os.rmdir(os.path.join(self._dir, "new"))
1695 os.rmdir(self._dir)
1696
Skip Montanaro5253da12004-07-24 19:56:03 +00001697 def createMessage(self, dir, mbox=False):
Jack Jansen97df7b62001-06-19 20:20:05 +00001698 t = int(time.time() % 1000000)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001699 pid = self._counter
1700 self._counter += 1
Skip Montanaro7a98be22007-08-16 14:35:24 +00001701 filename = ".".join((str(t), str(pid), "myhostname", "mydomain"))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001702 tmpname = os.path.join(self._dir, "tmp", filename)
1703 newname = os.path.join(self._dir, dir, filename)
1704 fp = open(tmpname, "w")
1705 self._msgfiles.append(tmpname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001706 if mbox:
1707 fp.write(FROM_)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001708 fp.write(DUMMY_MESSAGE)
1709 fp.close()
Tim Peters6626c1f2001-05-22 16:29:01 +00001710 if hasattr(os, "link"):
1711 os.link(tmpname, newname)
1712 else:
1713 fp = open(newname, "w")
1714 fp.write(DUMMY_MESSAGE)
1715 fp.close()
Fred Drakec02bc3e2001-05-21 20:23:21 +00001716 self._msgfiles.append(newname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001717 return tmpname
Fred Drakec02bc3e2001-05-21 20:23:21 +00001718
1719 def test_empty_maildir(self):
1720 """Test an empty maildir mailbox"""
1721 # Test for regression on bug #117490:
1722 # Make sure the boxes attribute actually gets set.
1723 self.mbox = mailbox.Maildir(test_support.TESTFN)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001724 #self.assert_(hasattr(self.mbox, "boxes"))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001725 #self.assertEqual(len(self.mbox.boxes), 0)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001726 self.assert_(self.mbox.next() is None)
1727 self.assert_(self.mbox.next() is None)
1728
1729 def test_nonempty_maildir_cur(self):
1730 self.createMessage("cur")
1731 self.mbox = mailbox.Maildir(test_support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001732 #self.assertEqual(len(self.mbox.boxes), 1)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001733 self.assert_(self.mbox.next() is not None)
1734 self.assert_(self.mbox.next() is None)
1735 self.assert_(self.mbox.next() is None)
1736
1737 def test_nonempty_maildir_new(self):
1738 self.createMessage("new")
1739 self.mbox = mailbox.Maildir(test_support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001740 #self.assertEqual(len(self.mbox.boxes), 1)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001741 self.assert_(self.mbox.next() is not None)
1742 self.assert_(self.mbox.next() is None)
1743 self.assert_(self.mbox.next() is None)
1744
1745 def test_nonempty_maildir_both(self):
1746 self.createMessage("cur")
1747 self.createMessage("new")
1748 self.mbox = mailbox.Maildir(test_support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001749 #self.assertEqual(len(self.mbox.boxes), 2)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001750 self.assert_(self.mbox.next() is not None)
1751 self.assert_(self.mbox.next() is not None)
1752 self.assert_(self.mbox.next() is None)
1753 self.assert_(self.mbox.next() is None)
Fred Drake0aaed272000-10-23 13:39:15 +00001754
Skip Montanaro5253da12004-07-24 19:56:03 +00001755 def test_unix_mbox(self):
1756 ### should be better!
Thomas Woutersb2137042007-02-01 18:02:27 +00001757 import email.parser
Skip Montanaro5253da12004-07-24 19:56:03 +00001758 fname = self.createMessage("cur", True)
1759 n = 0
1760 for msg in mailbox.PortableUnixMailbox(open(fname),
Thomas Woutersb2137042007-02-01 18:02:27 +00001761 email.parser.Parser().parse):
Skip Montanaro5253da12004-07-24 19:56:03 +00001762 n += 1
1763 self.assertEqual(msg["subject"], "Simple Test")
Guido van Rossum671117a2007-08-31 04:25:05 +00001764 # XXX Disabled until we figure out how to fix this
1765 ##self.assertEqual(len(str(msg)), len(FROM_)+len(DUMMY_MESSAGE))
Skip Montanaro5253da12004-07-24 19:56:03 +00001766 self.assertEqual(n, 1)
1767
Thomas Wouters477c8d52006-05-27 19:21:47 +00001768## End: classes from the original module (for backward compatibility).
1769
1770
1771_sample_message = """\
1772Return-Path: <gkj@gregorykjohnson.com>
1773X-Original-To: gkj+person@localhost
1774Delivered-To: gkj+person@localhost
1775Received: from localhost (localhost [127.0.0.1])
1776 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1777 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
1778Delivered-To: gkj@sundance.gregorykjohnson.com
1779Received: from localhost [127.0.0.1]
1780 by localhost with POP3 (fetchmail-6.2.5)
1781 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
1782Received: from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
1783 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1784 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
1785Received: by andy.gregorykjohnson.com (Postfix, from userid 1000)
1786 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
1787Date: Wed, 13 Jul 2005 17:23:11 -0400
1788From: "Gregory K. Johnson" <gkj@gregorykjohnson.com>
1789To: gkj@gregorykjohnson.com
1790Subject: Sample message
1791Message-ID: <20050713212311.GC4701@andy.gregorykjohnson.com>
1792Mime-Version: 1.0
1793Content-Type: multipart/mixed; boundary="NMuMz9nt05w80d4+"
1794Content-Disposition: inline
1795User-Agent: Mutt/1.5.9i
1796
1797
1798--NMuMz9nt05w80d4+
1799Content-Type: text/plain; charset=us-ascii
1800Content-Disposition: inline
1801
1802This is a sample message.
1803
1804--
1805Gregory K. Johnson
1806
1807--NMuMz9nt05w80d4+
1808Content-Type: application/octet-stream
1809Content-Disposition: attachment; filename="text.gz"
1810Content-Transfer-Encoding: base64
1811
1812H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
18133FYlAAAA
1814
1815--NMuMz9nt05w80d4+--
1816"""
1817
1818_sample_headers = {
1819 "Return-Path":"<gkj@gregorykjohnson.com>",
1820 "X-Original-To":"gkj+person@localhost",
1821 "Delivered-To":"gkj+person@localhost",
1822 "Received":"""from localhost (localhost [127.0.0.1])
1823 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1824 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
1825 "Delivered-To":"gkj@sundance.gregorykjohnson.com",
1826 "Received":"""from localhost [127.0.0.1]
1827 by localhost with POP3 (fetchmail-6.2.5)
1828 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
1829 "Received":"""from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
1830 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1831 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
1832 "Received":"""by andy.gregorykjohnson.com (Postfix, from userid 1000)
1833 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
1834 "Date":"Wed, 13 Jul 2005 17:23:11 -0400",
1835 "From":""""Gregory K. Johnson" <gkj@gregorykjohnson.com>""",
1836 "To":"gkj@gregorykjohnson.com",
1837 "Subject":"Sample message",
1838 "Mime-Version":"1.0",
1839 "Content-Type":"""multipart/mixed; boundary="NMuMz9nt05w80d4+\"""",
1840 "Content-Disposition":"inline",
1841 "User-Agent": "Mutt/1.5.9i" }
1842
1843_sample_payloads = ("""This is a sample message.
1844
1845--
1846Gregory K. Johnson
1847""",
1848"""H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
18493FYlAAAA
1850""")
Fred Drake0aaed272000-10-23 13:39:15 +00001851
Fred Drakec02bc3e2001-05-21 20:23:21 +00001852
Fred Drake2e2be372001-09-20 21:33:42 +00001853def test_main():
Thomas Wouters477c8d52006-05-27 19:21:47 +00001854 tests = (TestMailboxSuperclass, TestMaildir, TestMbox, TestMMDF, TestMH,
1855 TestBabyl, TestMessage, TestMaildirMessage, TestMboxMessage,
1856 TestMHMessage, TestBabylMessage, TestMMDFMessage,
1857 TestMessageConversion, TestProxyFile, TestPartialFile,
1858 MaildirTestCase)
1859 test_support.run_unittest(*tests)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001860 test_support.reap_children()
Fred Drake2e2be372001-09-20 21:33:42 +00001861
1862
Thomas Wouters477c8d52006-05-27 19:21:47 +00001863if __name__ == '__main__':
Fred Drake2e2be372001-09-20 21:33:42 +00001864 test_main()