blob: 4345be715f89e504c7646b830356f4d15a9ae528 [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 Rossumea834472007-07-27 05:17:50 +0000171 self.assertEqual(self._box.get_file(key0).read().replace(os.linesep, '\n'),
172 self._template % 0)
173 self.assertEqual(self._box.get_file(key1).read().replace(os.linesep, '\n'),
174 _sample_message)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000175
176 def test_iterkeys(self):
177 # Get keys using iterkeys()
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000178 self._check_iteration(self._box.keys, do_keys=True, do_values=False)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000179
180 def test_keys(self):
181 # Get keys using keys()
182 self._check_iteration(self._box.keys, do_keys=True, do_values=False)
183
184 def test_itervalues(self):
185 # Get values using itervalues()
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000186 self._check_iteration(self._box.values, do_keys=False,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000187 do_values=True)
188
189 def test_iter(self):
190 # Get values using __iter__()
191 self._check_iteration(self._box.__iter__, do_keys=False,
192 do_values=True)
193
194 def test_values(self):
195 # Get values using values()
196 self._check_iteration(self._box.values, do_keys=False, do_values=True)
197
198 def test_iteritems(self):
199 # Get keys and values using iteritems()
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000200 self._check_iteration(self._box.items, do_keys=True,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000201 do_values=True)
202
203 def test_items(self):
204 # Get keys and values using items()
205 self._check_iteration(self._box.items, do_keys=True, do_values=True)
206
207 def _check_iteration(self, method, do_keys, do_values, repetitions=10):
208 for value in method():
209 self.fail("Not empty")
210 keys, values = [], []
Guido van Rossum805365e2007-05-07 22:24:25 +0000211 for i in range(repetitions):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000212 keys.append(self._box.add(self._template % i))
213 values.append(self._template % i)
214 if do_keys and not do_values:
215 returned_keys = list(method())
216 elif do_values and not do_keys:
217 returned_values = list(method())
218 else:
219 returned_keys, returned_values = [], []
220 for key, value in method():
221 returned_keys.append(key)
222 returned_values.append(value)
223 if do_keys:
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000224 self.assertEqual(len(keys), len(returned_keys))
225 self.assertEqual(set(keys), set(returned_keys))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000226 if do_values:
227 count = 0
228 for value in returned_values:
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000229 self.assertEqual(value['from'], 'foo')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000230 self.assert_(int(value.get_payload()) < repetitions)
231 count += 1
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000232 self.assertEqual(len(values), count)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000233
Thomas Wouters477c8d52006-05-27 19:21:47 +0000234 def test_contains(self):
235 # Check existence of keys using __contains__()
Guido van Rossume2b70bc2006-08-18 22:13:04 +0000236 method = self._box.__contains__
Thomas Wouters477c8d52006-05-27 19:21:47 +0000237 self.assert_(not method('foo'))
238 key0 = self._box.add(self._template % 0)
239 self.assert_(method(key0))
240 self.assert_(not method('foo'))
241 key1 = self._box.add(self._template % 1)
242 self.assert_(method(key1))
243 self.assert_(method(key0))
244 self.assert_(not method('foo'))
245 self._box.remove(key0)
246 self.assert_(not method(key0))
247 self.assert_(method(key1))
248 self.assert_(not method('foo'))
249 self._box.remove(key1)
250 self.assert_(not method(key1))
251 self.assert_(not method(key0))
252 self.assert_(not method('foo'))
253
254 def test_len(self, repetitions=10):
255 # Get message count
256 keys = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000257 for i in range(repetitions):
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000258 self.assertEqual(len(self._box), i)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000259 keys.append(self._box.add(self._template % i))
Guido van Rossumea834472007-07-27 05:17:50 +0000260 self.assertEqual(len(self._box), i + 1)
Guido van Rossum805365e2007-05-07 22:24:25 +0000261 for i in range(repetitions):
Guido van Rossumea834472007-07-27 05:17:50 +0000262 self.assertEqual(len(self._box), repetitions - i)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000263 self._box.remove(keys[i])
Guido van Rossumea834472007-07-27 05:17:50 +0000264 self.assertEqual(len(self._box), repetitions - i - 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000265
266 def test_set_item(self):
267 # Modify messages using __setitem__()
268 key0 = self._box.add(self._template % 'original 0')
Guido van Rossumea834472007-07-27 05:17:50 +0000269 self.assertEqual(self._box.get_string(key0),
270 self._template % 'original 0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000271 key1 = self._box.add(self._template % 'original 1')
Guido van Rossumea834472007-07-27 05:17:50 +0000272 self.assertEqual(self._box.get_string(key1),
273 self._template % 'original 1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000274 self._box[key0] = self._template % 'changed 0'
Guido van Rossumea834472007-07-27 05:17:50 +0000275 self.assertEqual(self._box.get_string(key0),
276 self._template % 'changed 0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000277 self._box[key1] = self._template % 'changed 1'
Guido van Rossumea834472007-07-27 05:17:50 +0000278 self.assertEqual(self._box.get_string(key1),
279 self._template % 'changed 1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000280 self._box[key0] = _sample_message
281 self._check_sample(self._box[key0])
282 self._box[key1] = self._box[key0]
283 self._check_sample(self._box[key1])
284 self._box[key0] = self._template % 'original 0'
Guido van Rossumea834472007-07-27 05:17:50 +0000285 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000286 self._template % 'original 0')
287 self._check_sample(self._box[key1])
288 self.assertRaises(KeyError,
289 lambda: self._box.__setitem__('foo', 'bar'))
290 self.assertRaises(KeyError, lambda: self._box['foo'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000291 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000292
293 def test_clear(self, iterations=10):
294 # Remove all messages using clear()
295 keys = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000296 for i in range(iterations):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000297 self._box.add(self._template % i)
298 for i, key in enumerate(keys):
299 self.assert_(self._box.get_string(key) == self._template % i)
300 self._box.clear()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000301 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000302 for i, key in enumerate(keys):
303 self.assertRaises(KeyError, lambda: self._box.get_string(key))
304
305 def test_pop(self):
306 # Get and remove a message using pop()
307 key0 = self._box.add(self._template % 0)
308 self.assert_(key0 in self._box)
309 key1 = self._box.add(self._template % 1)
310 self.assert_(key1 in self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000311 self.assertEqual(self._box.pop(key0).get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000312 self.assert_(key0 not in self._box)
313 self.assert_(key1 in self._box)
314 key2 = self._box.add(self._template % 2)
315 self.assert_(key2 in self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000316 self.assertEqual(self._box.pop(key2).get_payload(), '2')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000317 self.assert_(key2 not in self._box)
318 self.assert_(key1 in self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000319 self.assertEqual(self._box.pop(key1).get_payload(), '1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000320 self.assert_(key1 not in self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000321 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000322
323 def test_popitem(self, iterations=10):
324 # Get and remove an arbitrary (key, message) using popitem()
325 keys = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000326 for i in range(10):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000327 keys.append(self._box.add(self._template % i))
328 seen = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000329 for i in range(10):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000330 key, msg = self._box.popitem()
331 self.assert_(key in keys)
332 self.assert_(key not in seen)
333 seen.append(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000334 self.assertEqual(int(msg.get_payload()), keys.index(key))
335 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000336 for key in keys:
337 self.assertRaises(KeyError, lambda: self._box[key])
338
339 def test_update(self):
340 # Modify multiple messages using update()
341 key0 = self._box.add(self._template % 'original 0')
342 key1 = self._box.add(self._template % 'original 1')
343 key2 = self._box.add(self._template % 'original 2')
344 self._box.update({key0: self._template % 'changed 0',
345 key2: _sample_message})
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000346 self.assertEqual(len(self._box), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000347 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000348 self._template % 'changed 0')
Guido van Rossumea834472007-07-27 05:17:50 +0000349 self.assertEqual(self._box.get_string(key1),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000350 self._template % 'original 1')
351 self._check_sample(self._box[key2])
352 self._box.update([(key2, self._template % 'changed 2'),
353 (key1, self._template % 'changed 1'),
354 (key0, self._template % 'original 0')])
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000355 self.assertEqual(len(self._box), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000356 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000357 self._template % 'original 0')
Guido van Rossumea834472007-07-27 05:17:50 +0000358 self.assertEqual(self._box.get_string(key1),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000359 self._template % 'changed 1')
Guido van Rossumea834472007-07-27 05:17:50 +0000360 self.assertEqual(self._box.get_string(key2),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000361 self._template % 'changed 2')
362 self.assertRaises(KeyError,
363 lambda: self._box.update({'foo': 'bar',
364 key0: self._template % "changed 0"}))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000365 self.assertEqual(len(self._box), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000366 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000367 self._template % "changed 0")
Guido van Rossumea834472007-07-27 05:17:50 +0000368 self.assertEqual(self._box.get_string(key1),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000369 self._template % "changed 1")
Guido van Rossumea834472007-07-27 05:17:50 +0000370 self.assertEqual(self._box.get_string(key2),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000371 self._template % "changed 2")
372
373 def test_flush(self):
374 # Write changes to disk
375 self._test_flush_or_close(self._box.flush)
376
377 def test_lock_unlock(self):
378 # Lock and unlock the mailbox
379 self.assert_(not os.path.exists(self._get_lock_path()))
380 self._box.lock()
381 self.assert_(os.path.exists(self._get_lock_path()))
382 self._box.unlock()
383 self.assert_(not os.path.exists(self._get_lock_path()))
384
385 def test_close(self):
386 # Close mailbox and flush changes to disk
387 self._test_flush_or_close(self._box.close)
388
389 def _test_flush_or_close(self, method):
Guido van Rossum805365e2007-05-07 22:24:25 +0000390 contents = [self._template % i for i in range(3)]
Thomas Wouters477c8d52006-05-27 19:21:47 +0000391 self._box.add(contents[0])
392 self._box.add(contents[1])
393 self._box.add(contents[2])
Guido van Rossumc12a8132007-10-26 04:29:23 +0000394 oldbox = self._box
Thomas Wouters477c8d52006-05-27 19:21:47 +0000395 method()
396 self._box = self._factory(self._path)
397 keys = self._box.keys()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000398 self.assertEqual(len(keys), 3)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000399 for key in keys:
400 self.assert_(self._box.get_string(key) in contents)
Guido van Rossumc12a8132007-10-26 04:29:23 +0000401 oldbox.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000402
403 def test_dump_message(self):
404 # Write message representations to disk
405 for input in (email.message_from_string(_sample_message),
Guido van Rossum34d19282007-08-09 01:03:29 +0000406 _sample_message, io.StringIO(_sample_message)):
407 output = io.StringIO()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000408 self._box._dump_message(input, output)
Guido van Rossumc12a8132007-10-26 04:29:23 +0000409 self.assertEqual(output.getvalue(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000410 _sample_message.replace('\n', os.linesep))
Guido van Rossum34d19282007-08-09 01:03:29 +0000411 output = io.StringIO()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000412 self.assertRaises(TypeError,
413 lambda: self._box._dump_message(None, output))
414
415 def _get_lock_path(self):
416 # Return the path of the dot lock file. May be overridden.
417 return self._path + '.lock'
418
419
420class TestMailboxSuperclass(TestBase):
421
422 def test_notimplemented(self):
423 # Test that all Mailbox methods raise NotImplementedException.
424 box = mailbox.Mailbox('path')
425 self.assertRaises(NotImplementedError, lambda: box.add(''))
426 self.assertRaises(NotImplementedError, lambda: box.remove(''))
427 self.assertRaises(NotImplementedError, lambda: box.__delitem__(''))
428 self.assertRaises(NotImplementedError, lambda: box.discard(''))
429 self.assertRaises(NotImplementedError, lambda: box.__setitem__('', ''))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000430 self.assertRaises(NotImplementedError, lambda: box.keys())
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000431 self.assertRaises(NotImplementedError, lambda: box.keys())
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000432 self.assertRaises(NotImplementedError, lambda: box.values().__next__())
433 self.assertRaises(NotImplementedError, lambda: box.__iter__().__next__())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000434 self.assertRaises(NotImplementedError, lambda: box.values())
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000435 self.assertRaises(NotImplementedError, lambda: box.items().next())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000436 self.assertRaises(NotImplementedError, lambda: box.items())
437 self.assertRaises(NotImplementedError, lambda: box.get(''))
438 self.assertRaises(NotImplementedError, lambda: box.__getitem__(''))
439 self.assertRaises(NotImplementedError, lambda: box.get_message(''))
440 self.assertRaises(NotImplementedError, lambda: box.get_string(''))
441 self.assertRaises(NotImplementedError, lambda: box.get_file(''))
Guido van Rossume2b70bc2006-08-18 22:13:04 +0000442 self.assertRaises(NotImplementedError, lambda: '' in box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000443 self.assertRaises(NotImplementedError, lambda: box.__contains__(''))
444 self.assertRaises(NotImplementedError, lambda: box.__len__())
445 self.assertRaises(NotImplementedError, lambda: box.clear())
446 self.assertRaises(NotImplementedError, lambda: box.pop(''))
447 self.assertRaises(NotImplementedError, lambda: box.popitem())
448 self.assertRaises(NotImplementedError, lambda: box.update((('', ''),)))
449 self.assertRaises(NotImplementedError, lambda: box.flush())
450 self.assertRaises(NotImplementedError, lambda: box.lock())
451 self.assertRaises(NotImplementedError, lambda: box.unlock())
452 self.assertRaises(NotImplementedError, lambda: box.close())
453
454
455class TestMaildir(TestMailbox):
456
457 _factory = lambda self, path, factory=None: mailbox.Maildir(path, factory)
458
459 def setUp(self):
460 TestMailbox.setUp(self)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000461 if os.name in ('nt', 'os2') or sys.platform == 'cygwin':
Thomas Wouters477c8d52006-05-27 19:21:47 +0000462 self._box.colon = '!'
463
464 def test_add_MM(self):
465 # Add a MaildirMessage instance
466 msg = mailbox.MaildirMessage(self._template % 0)
467 msg.set_subdir('cur')
468 msg.set_info('foo')
469 key = self._box.add(msg)
470 self.assert_(os.path.exists(os.path.join(self._path, 'cur', '%s%sfoo' %
471 (key, self._box.colon))))
472
473 def test_get_MM(self):
474 # Get a MaildirMessage instance
475 msg = mailbox.MaildirMessage(self._template % 0)
476 msg.set_subdir('cur')
477 msg.set_flags('RF')
478 key = self._box.add(msg)
479 msg_returned = self._box.get_message(key)
480 self.assert_(isinstance(msg_returned, mailbox.MaildirMessage))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000481 self.assertEqual(msg_returned.get_subdir(), 'cur')
482 self.assertEqual(msg_returned.get_flags(), 'FR')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000483
484 def test_set_MM(self):
485 # Set with a MaildirMessage instance
486 msg0 = mailbox.MaildirMessage(self._template % 0)
487 msg0.set_flags('TP')
488 key = self._box.add(msg0)
489 msg_returned = self._box.get_message(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000490 self.assertEqual(msg_returned.get_subdir(), 'new')
491 self.assertEqual(msg_returned.get_flags(), 'PT')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000492 msg1 = mailbox.MaildirMessage(self._template % 1)
493 self._box[key] = msg1
494 msg_returned = self._box.get_message(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000495 self.assertEqual(msg_returned.get_subdir(), 'new')
496 self.assertEqual(msg_returned.get_flags(), '')
497 self.assertEqual(msg_returned.get_payload(), '1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000498 msg2 = mailbox.MaildirMessage(self._template % 2)
499 msg2.set_info('2,S')
500 self._box[key] = msg2
501 self._box[key] = self._template % 3
502 msg_returned = self._box.get_message(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000503 self.assertEqual(msg_returned.get_subdir(), 'new')
504 self.assertEqual(msg_returned.get_flags(), 'S')
505 self.assertEqual(msg_returned.get_payload(), '3')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000506
507 def test_initialize_new(self):
508 # Initialize a non-existent mailbox
509 self.tearDown()
510 self._box = mailbox.Maildir(self._path)
511 self._check_basics(factory=rfc822.Message)
512 self._delete_recursively(self._path)
513 self._box = self._factory(self._path, factory=None)
514 self._check_basics()
515
516 def test_initialize_existing(self):
517 # Initialize an existing mailbox
518 self.tearDown()
519 for subdir in '', 'tmp', 'new', 'cur':
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000520 os.mkdir(os.path.normpath(os.path.join(self._path, subdir)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000521 self._box = mailbox.Maildir(self._path)
522 self._check_basics(factory=rfc822.Message)
523 self._box = mailbox.Maildir(self._path, factory=None)
524 self._check_basics()
525
526 def _check_basics(self, factory=None):
527 # (Used by test_open_new() and test_open_existing().)
528 self.assertEqual(self._box._path, os.path.abspath(self._path))
529 self.assertEqual(self._box._factory, factory)
530 for subdir in '', 'tmp', 'new', 'cur':
531 path = os.path.join(self._path, subdir)
532 mode = os.stat(path)[stat.ST_MODE]
533 self.assert_(stat.S_ISDIR(mode), "Not a directory: '%s'" % path)
534
535 def test_list_folders(self):
536 # List folders
537 self._box.add_folder('one')
538 self._box.add_folder('two')
539 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000540 self.assertEqual(len(self._box.list_folders()), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000541 self.assertEqual(set(self._box.list_folders()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000542 set(('one', 'two', 'three')))
543
544 def test_get_folder(self):
545 # Open folders
546 self._box.add_folder('foo.bar')
547 folder0 = self._box.get_folder('foo.bar')
548 folder0.add(self._template % 'bar')
549 self.assert_(os.path.isdir(os.path.join(self._path, '.foo.bar')))
550 folder1 = self._box.get_folder('foo.bar')
Guido van Rossumea834472007-07-27 05:17:50 +0000551 self.assertEqual(folder1.get_string(folder1.keys()[0]),
552 self._template % 'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000553
554 def test_add_and_remove_folders(self):
555 # Delete folders
556 self._box.add_folder('one')
557 self._box.add_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000558 self.assertEqual(len(self._box.list_folders()), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000559 self.assert_(set(self._box.list_folders()) == set(('one', 'two')))
560 self._box.remove_folder('one')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000561 self.assertEqual(len(self._box.list_folders()), 1)
562 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000563 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000564 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000565 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000566 self._box.remove_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000567 self.assertEqual(len(self._box.list_folders()), 1)
568 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000569 self._box.remove_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000570 self.assertEqual(len(self._box.list_folders()), 0)
571 self.assertEqual(self._box.list_folders(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000572
573 def test_clean(self):
574 # Remove old files from 'tmp'
575 foo_path = os.path.join(self._path, 'tmp', 'foo')
576 bar_path = os.path.join(self._path, 'tmp', 'bar')
577 f = open(foo_path, 'w')
578 f.write("@")
579 f.close()
580 f = open(bar_path, 'w')
581 f.write("@")
582 f.close()
583 self._box.clean()
584 self.assert_(os.path.exists(foo_path))
585 self.assert_(os.path.exists(bar_path))
586 foo_stat = os.stat(foo_path)
587 os.utime(foo_path, (time.time() - 129600 - 2,
588 foo_stat.st_mtime))
589 self._box.clean()
590 self.assert_(not os.path.exists(foo_path))
591 self.assert_(os.path.exists(bar_path))
592
593 def test_create_tmp(self, repetitions=10):
594 # Create files in tmp directory
595 hostname = socket.gethostname()
596 if '/' in hostname:
597 hostname = hostname.replace('/', r'\057')
598 if ':' in hostname:
599 hostname = hostname.replace(':', r'\072')
600 pid = os.getpid()
601 pattern = re.compile(r"(?P<time>\d+)\.M(?P<M>\d{1,6})P(?P<P>\d+)"
602 r"Q(?P<Q>\d+)\.(?P<host>[^:/]+)")
603 previous_groups = None
Guido van Rossum805365e2007-05-07 22:24:25 +0000604 for x in range(repetitions):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000605 tmp_file = self._box._create_tmp()
606 head, tail = os.path.split(tmp_file.name)
607 self.assertEqual(head, os.path.abspath(os.path.join(self._path,
608 "tmp")),
609 "File in wrong location: '%s'" % head)
610 match = pattern.match(tail)
611 self.assert_(match != None, "Invalid file name: '%s'" % tail)
612 groups = match.groups()
613 if previous_groups != None:
614 self.assert_(int(groups[0] >= previous_groups[0]),
615 "Non-monotonic seconds: '%s' before '%s'" %
616 (previous_groups[0], groups[0]))
617 self.assert_(int(groups[1] >= previous_groups[1]) or
618 groups[0] != groups[1],
619 "Non-monotonic milliseconds: '%s' before '%s'" %
620 (previous_groups[1], groups[1]))
Guido van Rossumea834472007-07-27 05:17:50 +0000621 self.assertEqual(int(groups[2]), pid,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000622 "Process ID mismatch: '%s' should be '%s'" %
623 (groups[2], pid))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000624 self.assertEqual(int(groups[3]), int(previous_groups[3]) + 1,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000625 "Non-sequential counter: '%s' before '%s'" %
626 (previous_groups[3], groups[3]))
Guido van Rossumea834472007-07-27 05:17:50 +0000627 self.assertEqual(groups[4], hostname,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000628 "Host name mismatch: '%s' should be '%s'" %
629 (groups[4], hostname))
630 previous_groups = groups
631 tmp_file.write(_sample_message)
632 tmp_file.seek(0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000633 self.assertEqual(tmp_file.read(), _sample_message)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000634 tmp_file.close()
635 file_count = len(os.listdir(os.path.join(self._path, "tmp")))
Guido van Rossumea834472007-07-27 05:17:50 +0000636 self.assertEqual(file_count, repetitions,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000637 "Wrong file count: '%s' should be '%s'" %
638 (file_count, repetitions))
639
640 def test_refresh(self):
641 # Update the table of contents
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000642 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000643 key0 = self._box.add(self._template % 0)
644 key1 = self._box.add(self._template % 1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000645 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000646 self._box._refresh()
Guido van Rossumea834472007-07-27 05:17:50 +0000647 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
648 key1: os.path.join('new', key1)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000649 key2 = self._box.add(self._template % 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000650 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
651 key1: os.path.join('new', key1)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000652 self._box._refresh()
Guido van Rossumea834472007-07-27 05:17:50 +0000653 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
654 key1: os.path.join('new', key1),
655 key2: os.path.join('new', key2)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000656
657 def test_lookup(self):
658 # Look up message subpaths in the TOC
659 self.assertRaises(KeyError, lambda: self._box._lookup('foo'))
660 key0 = self._box.add(self._template % 0)
Guido van Rossumea834472007-07-27 05:17:50 +0000661 self.assertEqual(self._box._lookup(key0), os.path.join('new', key0))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000662 os.remove(os.path.join(self._path, 'new', key0))
Guido van Rossumea834472007-07-27 05:17:50 +0000663 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000664 self.assertRaises(KeyError, lambda: self._box._lookup(key0))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000665 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000666
667 def test_lock_unlock(self):
668 # Lock and unlock the mailbox. For Maildir, this does nothing.
669 self._box.lock()
670 self._box.unlock()
671
Thomas Wouters89f507f2006-12-13 04:49:30 +0000672 def test_folder (self):
673 # Test for bug #1569790: verify that folders returned by .get_folder()
674 # use the same factory function.
675 def dummy_factory (s):
676 return None
677 box = self._factory(self._path, factory=dummy_factory)
678 folder = box.add_folder('folder1')
679 self.assert_(folder._factory is dummy_factory)
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000680
Thomas Wouters89f507f2006-12-13 04:49:30 +0000681 folder1_alias = box.get_folder('folder1')
682 self.assert_(folder1_alias._factory is dummy_factory)
683
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000684 def test_directory_in_folder (self):
685 # Test that mailboxes still work if there's a stray extra directory
686 # in a folder.
687 for i in range(10):
688 self._box.add(mailbox.Message(_sample_message))
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000689
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000690 # Create a stray directory
691 os.mkdir(os.path.join(self._path, 'cur', 'stray-dir'))
692
693 # Check that looping still works with the directory present.
694 for msg in self._box:
695 pass
Thomas Wouters477c8d52006-05-27 19:21:47 +0000696
697class _TestMboxMMDF(TestMailbox):
698
699 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +0000700 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000701 self._delete_recursively(self._path)
702 for lock_remnant in glob.glob(self._path + '.*'):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000703 test_support.unlink(lock_remnant)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000704
705 def test_add_from_string(self):
706 # Add a string starting with 'From ' to the mailbox
707 key = self._box.add('From foo@bar blah\nFrom: foo\n\n0')
Guido van Rossumea834472007-07-27 05:17:50 +0000708 self.assertEqual(self._box[key].get_from(), 'foo@bar blah')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000709 self.assertEqual(self._box[key].get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000710
711 def test_add_mbox_or_mmdf_message(self):
712 # Add an mboxMessage or MMDFMessage
713 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
714 msg = class_('From foo@bar blah\nFrom: foo\n\n0')
715 key = self._box.add(msg)
716
717 def test_open_close_open(self):
718 # Open and inspect previously-created mailbox
Guido van Rossum805365e2007-05-07 22:24:25 +0000719 values = [self._template % i for i in range(3)]
Thomas Wouters477c8d52006-05-27 19:21:47 +0000720 for value in values:
721 self._box.add(value)
722 self._box.close()
723 mtime = os.path.getmtime(self._path)
724 self._box = self._factory(self._path)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000725 self.assertEqual(len(self._box), 3)
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000726 for key in self._box.keys():
Thomas Wouters477c8d52006-05-27 19:21:47 +0000727 self.assert_(self._box.get_string(key) in values)
728 self._box.close()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000729 self.assertEqual(mtime, os.path.getmtime(self._path))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000730
731 def test_add_and_close(self):
732 # Verifying that closing a mailbox doesn't change added items
733 self._box.add(_sample_message)
Guido van Rossum805365e2007-05-07 22:24:25 +0000734 for i in range(3):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000735 self._box.add(self._template % i)
736 self._box.add(_sample_message)
737 self._box._file.flush()
738 self._box._file.seek(0)
739 contents = self._box._file.read()
740 self._box.close()
Guido van Rossumea834472007-07-27 05:17:50 +0000741 self.assertEqual(contents, open(self._path, 'r').read())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000742 self._box = self._factory(self._path)
743
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000744 def test_lock_conflict(self):
745 # Fork off a subprocess that will lock the file for 2 seconds,
746 # unlock it, and then exit.
747 if not hasattr(os, 'fork'):
748 return
749 pid = os.fork()
750 if pid == 0:
751 # In the child, lock the mailbox.
Guido van Rossum62cbc8a2007-04-09 00:41:25 +0000752 try:
753 self._box.lock()
754 time.sleep(2)
755 self._box.unlock()
756 finally:
757 os._exit(0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000758
759 # In the parent, sleep a bit to give the child time to acquire
760 # the lock.
761 time.sleep(0.5)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000762 try:
763 self.assertRaises(mailbox.ExternalClashError,
764 self._box.lock)
765 finally:
766 # Wait for child to exit. Locking should now succeed.
767 exited_pid, status = os.waitpid(pid, 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000768
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000769 self._box.lock()
770 self._box.unlock()
771
Thomas Wouters89f507f2006-12-13 04:49:30 +0000772 def test_relock(self):
773 # Test case for bug #1575506: the mailbox class was locking the
774 # wrong file object in its flush() method.
775 msg = "Subject: sub\n\nbody\n"
776 key1 = self._box.add(msg)
777 self._box.flush()
778 self._box.close()
779
780 self._box = self._factory(self._path)
781 self._box.lock()
782 key2 = self._box.add(msg)
783 self._box.flush()
784 self.assert_(self._box._locked)
785 self._box.close()
786
787
Thomas Wouters477c8d52006-05-27 19:21:47 +0000788
789class TestMbox(_TestMboxMMDF):
790
791 _factory = lambda self, path, factory=None: mailbox.mbox(path, factory)
792
793
794class TestMMDF(_TestMboxMMDF):
795
796 _factory = lambda self, path, factory=None: mailbox.MMDF(path, factory)
797
798
799class TestMH(TestMailbox):
800
801 _factory = lambda self, path, factory=None: mailbox.MH(path, factory)
802
803 def test_list_folders(self):
804 # List folders
805 self._box.add_folder('one')
806 self._box.add_folder('two')
807 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000808 self.assertEqual(len(self._box.list_folders()), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000809 self.assertEqual(set(self._box.list_folders()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000810 set(('one', 'two', 'three')))
811
812 def test_get_folder(self):
813 # Open folders
Thomas Wouters89f507f2006-12-13 04:49:30 +0000814 def dummy_factory (s):
815 return None
816 self._box = self._factory(self._path, dummy_factory)
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000817
Thomas Wouters89f507f2006-12-13 04:49:30 +0000818 new_folder = self._box.add_folder('foo.bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000819 folder0 = self._box.get_folder('foo.bar')
820 folder0.add(self._template % 'bar')
821 self.assert_(os.path.isdir(os.path.join(self._path, 'foo.bar')))
822 folder1 = self._box.get_folder('foo.bar')
Guido van Rossumea834472007-07-27 05:17:50 +0000823 self.assertEqual(folder1.get_string(folder1.keys()[0]),
824 self._template % 'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000825
Thomas Wouters89f507f2006-12-13 04:49:30 +0000826 # Test for bug #1569790: verify that folders returned by .get_folder()
827 # use the same factory function.
828 self.assert_(new_folder._factory is self._box._factory)
829 self.assert_(folder0._factory is self._box._factory)
830
Thomas Wouters477c8d52006-05-27 19:21:47 +0000831 def test_add_and_remove_folders(self):
832 # Delete folders
833 self._box.add_folder('one')
834 self._box.add_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000835 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000836 self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000837 self._box.remove_folder('one')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000838 self.assertEqual(len(self._box.list_folders()), 1)
839 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000840 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000841 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000842 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000843 self._box.remove_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000844 self.assertEqual(len(self._box.list_folders()), 1)
845 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000846 self._box.remove_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000847 self.assertEqual(len(self._box.list_folders()), 0)
848 self.assertEqual(self._box.list_folders(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000849
850 def test_sequences(self):
851 # Get and set sequences
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000852 self.assertEqual(self._box.get_sequences(), {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000853 msg0 = mailbox.MHMessage(self._template % 0)
854 msg0.add_sequence('foo')
855 key0 = self._box.add(msg0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000856 self.assertEqual(self._box.get_sequences(), {'foo':[key0]})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000857 msg1 = mailbox.MHMessage(self._template % 1)
858 msg1.set_sequences(['bar', 'replied', 'foo'])
859 key1 = self._box.add(msg1)
Guido van Rossumea834472007-07-27 05:17:50 +0000860 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000861 {'foo':[key0, key1], 'bar':[key1], 'replied':[key1]})
862 msg0.set_sequences(['flagged'])
863 self._box[key0] = msg0
Guido van Rossumea834472007-07-27 05:17:50 +0000864 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000865 {'foo':[key1], 'bar':[key1], 'replied':[key1],
866 'flagged':[key0]})
867 self._box.remove(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000868 self.assertEqual(self._box.get_sequences(), {'flagged':[key0]})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000869
870 def test_pack(self):
871 # Pack the contents of the mailbox
872 msg0 = mailbox.MHMessage(self._template % 0)
873 msg1 = mailbox.MHMessage(self._template % 1)
874 msg2 = mailbox.MHMessage(self._template % 2)
875 msg3 = mailbox.MHMessage(self._template % 3)
876 msg0.set_sequences(['foo', 'unseen'])
877 msg1.set_sequences(['foo'])
878 msg2.set_sequences(['foo', 'flagged'])
879 msg3.set_sequences(['foo', 'bar', 'replied'])
880 key0 = self._box.add(msg0)
881 key1 = self._box.add(msg1)
882 key2 = self._box.add(msg2)
883 key3 = self._box.add(msg3)
Guido van Rossumea834472007-07-27 05:17:50 +0000884 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000885 {'foo':[key0,key1,key2,key3], 'unseen':[key0],
886 'flagged':[key2], 'bar':[key3], 'replied':[key3]})
887 self._box.remove(key2)
Guido van Rossumea834472007-07-27 05:17:50 +0000888 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000889 {'foo':[key0,key1,key3], 'unseen':[key0], 'bar':[key3],
890 'replied':[key3]})
891 self._box.pack()
892 self.assert_(self._box.keys() == [1, 2, 3])
893 key0 = key0
894 key1 = key0 + 1
895 key2 = key1 + 1
Guido van Rossumea834472007-07-27 05:17:50 +0000896 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000897 {'foo':[1, 2, 3], 'unseen':[1], 'bar':[3], 'replied':[3]})
898
Thomas Wouters89f507f2006-12-13 04:49:30 +0000899 # Test case for packing while holding the mailbox locked.
900 key0 = self._box.add(msg1)
901 key1 = self._box.add(msg1)
902 key2 = self._box.add(msg1)
903 key3 = self._box.add(msg1)
904
905 self._box.remove(key0)
906 self._box.remove(key2)
907 self._box.lock()
908 self._box.pack()
909 self._box.unlock()
Guido van Rossumea834472007-07-27 05:17:50 +0000910 self.assertEqual(self._box.get_sequences(),
Thomas Wouters89f507f2006-12-13 04:49:30 +0000911 {'foo':[1, 2, 3, 4, 5],
912 'unseen':[1], 'bar':[3], 'replied':[3]})
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000913
Thomas Wouters477c8d52006-05-27 19:21:47 +0000914 def _get_lock_path(self):
915 return os.path.join(self._path, '.mh_sequences.lock')
916
917
918class TestBabyl(TestMailbox):
919
920 _factory = lambda self, path, factory=None: mailbox.Babyl(path, factory)
921
922 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +0000923 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000924 self._delete_recursively(self._path)
925 for lock_remnant in glob.glob(self._path + '.*'):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000926 test_support.unlink(lock_remnant)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000927
928 def test_labels(self):
929 # Get labels from the mailbox
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000930 self.assertEqual(self._box.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000931 msg0 = mailbox.BabylMessage(self._template % 0)
932 msg0.add_label('foo')
933 key0 = self._box.add(msg0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000934 self.assertEqual(self._box.get_labels(), ['foo'])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000935 msg1 = mailbox.BabylMessage(self._template % 1)
936 msg1.set_labels(['bar', 'answered', 'foo'])
937 key1 = self._box.add(msg1)
Guido van Rossumea834472007-07-27 05:17:50 +0000938 self.assertEqual(set(self._box.get_labels()), set(['foo', 'bar']))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000939 msg0.set_labels(['blah', 'filed'])
940 self._box[key0] = msg0
Guido van Rossumea834472007-07-27 05:17:50 +0000941 self.assertEqual(set(self._box.get_labels()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000942 set(['foo', 'bar', 'blah']))
943 self._box.remove(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000944 self.assertEqual(set(self._box.get_labels()), set(['blah']))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000945
946
947class TestMessage(TestBase):
948
949 _factory = mailbox.Message # Overridden by subclasses to reuse tests
950
951 def setUp(self):
952 self._path = test_support.TESTFN
953
954 def tearDown(self):
955 self._delete_recursively(self._path)
956
957 def test_initialize_with_eMM(self):
Thomas Woutersb2137042007-02-01 18:02:27 +0000958 # Initialize based on email.message.Message instance
Thomas Wouters477c8d52006-05-27 19:21:47 +0000959 eMM = email.message_from_string(_sample_message)
960 msg = self._factory(eMM)
961 self._post_initialize_hook(msg)
962 self._check_sample(msg)
963
964 def test_initialize_with_string(self):
965 # Initialize based on string
966 msg = self._factory(_sample_message)
967 self._post_initialize_hook(msg)
968 self._check_sample(msg)
969
970 def test_initialize_with_file(self):
971 # Initialize based on contents of file
972 f = open(self._path, 'w+')
973 f.write(_sample_message)
974 f.seek(0)
975 msg = self._factory(f)
976 self._post_initialize_hook(msg)
977 self._check_sample(msg)
978 f.close()
979
980 def test_initialize_with_nothing(self):
981 # Initialize without arguments
982 msg = self._factory()
983 self._post_initialize_hook(msg)
Thomas Woutersb2137042007-02-01 18:02:27 +0000984 self.assert_(isinstance(msg, email.message.Message))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000985 self.assert_(isinstance(msg, mailbox.Message))
986 self.assert_(isinstance(msg, self._factory))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000987 self.assertEqual(msg.keys(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000988 self.assert_(not msg.is_multipart())
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000989 self.assertEqual(msg.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000990
991 def test_initialize_incorrectly(self):
992 # Initialize with invalid argument
993 self.assertRaises(TypeError, lambda: self._factory(object()))
994
995 def test_become_message(self):
996 # Take on the state of another message
997 eMM = email.message_from_string(_sample_message)
998 msg = self._factory()
999 msg._become_message(eMM)
1000 self._check_sample(msg)
1001
1002 def test_explain_to(self):
1003 # Copy self's format-specific data to other message formats.
1004 # This test is superficial; better ones are in TestMessageConversion.
1005 msg = self._factory()
1006 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1007 mailbox.mboxMessage, mailbox.MHMessage,
1008 mailbox.BabylMessage, mailbox.MMDFMessage):
1009 other_msg = class_()
1010 msg._explain_to(other_msg)
Thomas Woutersb2137042007-02-01 18:02:27 +00001011 other_msg = email.message.Message()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001012 self.assertRaises(TypeError, lambda: msg._explain_to(other_msg))
1013
1014 def _post_initialize_hook(self, msg):
1015 # Overridden by subclasses to check extra things after initialization
1016 pass
1017
1018
1019class TestMaildirMessage(TestMessage):
1020
1021 _factory = mailbox.MaildirMessage
1022
1023 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001024 self.assertEqual(msg._subdir, 'new')
1025 self.assertEqual(msg._info, '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001026
1027 def test_subdir(self):
1028 # Use get_subdir() and set_subdir()
1029 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001030 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001031 msg.set_subdir('cur')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001032 self.assertEqual(msg.get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001033 msg.set_subdir('new')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001034 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001035 self.assertRaises(ValueError, lambda: msg.set_subdir('tmp'))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001036 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001037 msg.set_subdir('new')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001038 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001039 self._check_sample(msg)
1040
1041 def test_flags(self):
1042 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1043 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001044 self.assertEqual(msg.get_flags(), '')
1045 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001046 msg.set_flags('F')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001047 self.assertEqual(msg.get_subdir(), 'new')
1048 self.assertEqual(msg.get_flags(), 'F')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001049 msg.set_flags('SDTP')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001050 self.assertEqual(msg.get_flags(), 'DPST')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001051 msg.add_flag('FT')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001052 self.assertEqual(msg.get_flags(), 'DFPST')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001053 msg.remove_flag('TDRP')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001054 self.assertEqual(msg.get_flags(), 'FS')
1055 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001056 self._check_sample(msg)
1057
1058 def test_date(self):
1059 # Use get_date() and set_date()
1060 msg = mailbox.MaildirMessage(_sample_message)
1061 self.assert_(abs(msg.get_date() - time.time()) < 60)
1062 msg.set_date(0.0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001063 self.assertEqual(msg.get_date(), 0.0)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001064
1065 def test_info(self):
1066 # Use get_info() and set_info()
1067 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001068 self.assertEqual(msg.get_info(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001069 msg.set_info('1,foo=bar')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001070 self.assertEqual(msg.get_info(), '1,foo=bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001071 self.assertRaises(TypeError, lambda: msg.set_info(None))
1072 self._check_sample(msg)
1073
1074 def test_info_and_flags(self):
1075 # Test interaction of info and flag methods
1076 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001077 self.assertEqual(msg.get_info(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001078 msg.set_flags('SF')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001079 self.assertEqual(msg.get_flags(), 'FS')
1080 self.assertEqual(msg.get_info(), '2,FS')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001081 msg.set_info('1,')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001082 self.assertEqual(msg.get_flags(), '')
1083 self.assertEqual(msg.get_info(), '1,')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001084 msg.remove_flag('RPT')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001085 self.assertEqual(msg.get_flags(), '')
1086 self.assertEqual(msg.get_info(), '1,')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001087 msg.add_flag('D')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001088 self.assertEqual(msg.get_flags(), 'D')
1089 self.assertEqual(msg.get_info(), '2,D')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001090 self._check_sample(msg)
1091
1092
1093class _TestMboxMMDFMessage(TestMessage):
1094
1095 _factory = mailbox._mboxMMDFMessage
1096
1097 def _post_initialize_hook(self, msg):
1098 self._check_from(msg)
1099
1100 def test_initialize_with_unixfrom(self):
1101 # Initialize with a message that already has a _unixfrom attribute
1102 msg = mailbox.Message(_sample_message)
1103 msg.set_unixfrom('From foo@bar blah')
1104 msg = mailbox.mboxMessage(msg)
Guido van Rossumea834472007-07-27 05:17:50 +00001105 self.assertEqual(msg.get_from(), 'foo@bar blah', msg.get_from())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001106
1107 def test_from(self):
1108 # Get and set "From " line
1109 msg = mailbox.mboxMessage(_sample_message)
1110 self._check_from(msg)
1111 msg.set_from('foo bar')
Guido van Rossumea834472007-07-27 05:17:50 +00001112 self.assertEqual(msg.get_from(), 'foo bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001113 msg.set_from('foo@bar', True)
1114 self._check_from(msg, 'foo@bar')
1115 msg.set_from('blah@temp', time.localtime())
1116 self._check_from(msg, 'blah@temp')
1117
1118 def test_flags(self):
1119 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1120 msg = mailbox.mboxMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001121 self.assertEqual(msg.get_flags(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001122 msg.set_flags('F')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001123 self.assertEqual(msg.get_flags(), 'F')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001124 msg.set_flags('XODR')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001125 self.assertEqual(msg.get_flags(), 'RODX')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001126 msg.add_flag('FA')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001127 self.assertEqual(msg.get_flags(), 'RODFAX')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001128 msg.remove_flag('FDXA')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001129 self.assertEqual(msg.get_flags(), 'RO')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001130 self._check_sample(msg)
1131
1132 def _check_from(self, msg, sender=None):
1133 # Check contents of "From " line
1134 if sender is None:
1135 sender = "MAILER-DAEMON"
1136 self.assert_(re.match(sender + r" \w{3} \w{3} [\d ]\d [\d ]\d:\d{2}:"
1137 r"\d{2} \d{4}", msg.get_from()) is not None)
1138
1139
1140class TestMboxMessage(_TestMboxMMDFMessage):
1141
1142 _factory = mailbox.mboxMessage
1143
1144
1145class TestMHMessage(TestMessage):
1146
1147 _factory = mailbox.MHMessage
1148
1149 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001150 self.assertEqual(msg._sequences, [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001151
1152 def test_sequences(self):
1153 # Get, set, join, and leave sequences
1154 msg = mailbox.MHMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001155 self.assertEqual(msg.get_sequences(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001156 msg.set_sequences(['foobar'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001157 self.assertEqual(msg.get_sequences(), ['foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001158 msg.set_sequences([])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001159 self.assertEqual(msg.get_sequences(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001160 msg.add_sequence('unseen')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001161 self.assertEqual(msg.get_sequences(), ['unseen'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001162 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001163 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
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.remove_sequence('unseen')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001167 self.assertEqual(msg.get_sequences(), ['flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001168 msg.add_sequence('foobar')
Guido van Rossumea834472007-07-27 05:17:50 +00001169 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001170 msg.remove_sequence('replied')
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.set_sequences(['foobar', 'replied'])
Guido van Rossumea834472007-07-27 05:17:50 +00001173 self.assertEqual(msg.get_sequences(), ['foobar', 'replied'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001174
1175
1176class TestBabylMessage(TestMessage):
1177
1178 _factory = mailbox.BabylMessage
1179
1180 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001181 self.assertEqual(msg._labels, [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001182
1183 def test_labels(self):
1184 # Get, set, join, and leave labels
1185 msg = mailbox.BabylMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001186 self.assertEqual(msg.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001187 msg.set_labels(['foobar'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001188 self.assertEqual(msg.get_labels(), ['foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001189 msg.set_labels([])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001190 self.assertEqual(msg.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001191 msg.add_label('filed')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001192 self.assertEqual(msg.get_labels(), ['filed'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001193 msg.add_label('resent')
Guido van Rossumea834472007-07-27 05:17:50 +00001194 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
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.remove_label('filed')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001198 self.assertEqual(msg.get_labels(), ['resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001199 msg.add_label('foobar')
Guido van Rossumea834472007-07-27 05:17:50 +00001200 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001201 msg.remove_label('unseen')
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.set_labels(['foobar', 'answered'])
Guido van Rossumea834472007-07-27 05:17:50 +00001204 self.assertEqual(msg.get_labels(), ['foobar', 'answered'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001205
1206 def test_visible(self):
1207 # Get, set, and update visible headers
1208 msg = mailbox.BabylMessage(_sample_message)
1209 visible = msg.get_visible()
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001210 self.assertEqual(visible.keys(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001211 self.assert_(visible.get_payload() is None)
1212 visible['User-Agent'] = 'FooBar 1.0'
1213 visible['X-Whatever'] = 'Blah'
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001214 self.assertEqual(msg.get_visible().keys(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001215 msg.set_visible(visible)
1216 visible = msg.get_visible()
1217 self.assert_(visible.keys() == ['User-Agent', 'X-Whatever'])
1218 self.assert_(visible['User-Agent'] == 'FooBar 1.0')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001219 self.assertEqual(visible['X-Whatever'], 'Blah')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001220 self.assert_(visible.get_payload() is None)
1221 msg.update_visible()
Guido van Rossumea834472007-07-27 05:17:50 +00001222 self.assertEqual(visible.keys(), ['User-Agent', 'X-Whatever'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001223 self.assert_(visible.get_payload() is None)
1224 visible = msg.get_visible()
Guido van Rossumea834472007-07-27 05:17:50 +00001225 self.assertEqual(visible.keys(), ['User-Agent', 'Date', 'From', 'To',
1226 'Subject'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001227 for header in ('User-Agent', 'Date', 'From', 'To', 'Subject'):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001228 self.assertEqual(visible[header], msg[header])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001229
1230
1231class TestMMDFMessage(_TestMboxMMDFMessage):
1232
1233 _factory = mailbox.MMDFMessage
1234
1235
1236class TestMessageConversion(TestBase):
1237
1238 def test_plain_to_x(self):
1239 # Convert Message to all formats
1240 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1241 mailbox.mboxMessage, mailbox.MHMessage,
1242 mailbox.BabylMessage, mailbox.MMDFMessage):
1243 msg_plain = mailbox.Message(_sample_message)
1244 msg = class_(msg_plain)
1245 self._check_sample(msg)
1246
1247 def test_x_to_plain(self):
1248 # Convert all formats to Message
1249 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1250 mailbox.mboxMessage, mailbox.MHMessage,
1251 mailbox.BabylMessage, mailbox.MMDFMessage):
1252 msg = class_(_sample_message)
1253 msg_plain = mailbox.Message(msg)
1254 self._check_sample(msg_plain)
1255
1256 def test_x_to_invalid(self):
1257 # Convert all formats to an invalid format
1258 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1259 mailbox.mboxMessage, mailbox.MHMessage,
1260 mailbox.BabylMessage, mailbox.MMDFMessage):
1261 self.assertRaises(TypeError, lambda: class_(False))
1262
1263 def test_maildir_to_maildir(self):
1264 # Convert MaildirMessage to MaildirMessage
1265 msg_maildir = mailbox.MaildirMessage(_sample_message)
1266 msg_maildir.set_flags('DFPRST')
1267 msg_maildir.set_subdir('cur')
1268 date = msg_maildir.get_date()
1269 msg = mailbox.MaildirMessage(msg_maildir)
1270 self._check_sample(msg)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001271 self.assertEqual(msg.get_flags(), 'DFPRST')
1272 self.assertEqual(msg.get_subdir(), 'cur')
1273 self.assertEqual(msg.get_date(), date)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001274
1275 def test_maildir_to_mboxmmdf(self):
1276 # Convert MaildirMessage to mboxmessage and MMDFMessage
1277 pairs = (('D', ''), ('F', 'F'), ('P', ''), ('R', 'A'), ('S', 'R'),
1278 ('T', 'D'), ('DFPRST', 'RDFA'))
1279 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1280 msg_maildir = mailbox.MaildirMessage(_sample_message)
1281 msg_maildir.set_date(0.0)
1282 for setting, result in pairs:
1283 msg_maildir.set_flags(setting)
1284 msg = class_(msg_maildir)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001285 self.assertEqual(msg.get_flags(), result)
Guido van Rossumea834472007-07-27 05:17:50 +00001286 self.assertEqual(msg.get_from(), 'MAILER-DAEMON %s' %
Thomas Wouters477c8d52006-05-27 19:21:47 +00001287 time.asctime(time.gmtime(0.0)))
1288 msg_maildir.set_subdir('cur')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001289 self.assertEqual(class_(msg_maildir).get_flags(), 'RODFA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001290
1291 def test_maildir_to_mh(self):
1292 # Convert MaildirMessage to MHMessage
1293 msg_maildir = mailbox.MaildirMessage(_sample_message)
1294 pairs = (('D', ['unseen']), ('F', ['unseen', 'flagged']),
1295 ('P', ['unseen']), ('R', ['unseen', 'replied']), ('S', []),
1296 ('T', ['unseen']), ('DFPRST', ['replied', 'flagged']))
1297 for setting, result in pairs:
1298 msg_maildir.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001299 self.assertEqual(mailbox.MHMessage(msg_maildir).get_sequences(),
1300 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001301
1302 def test_maildir_to_babyl(self):
1303 # Convert MaildirMessage to Babyl
1304 msg_maildir = mailbox.MaildirMessage(_sample_message)
1305 pairs = (('D', ['unseen']), ('F', ['unseen']),
1306 ('P', ['unseen', 'forwarded']), ('R', ['unseen', 'answered']),
1307 ('S', []), ('T', ['unseen', 'deleted']),
1308 ('DFPRST', ['deleted', 'answered', 'forwarded']))
1309 for setting, result in pairs:
1310 msg_maildir.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001311 self.assertEqual(mailbox.BabylMessage(msg_maildir).get_labels(),
1312 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001313
1314 def test_mboxmmdf_to_maildir(self):
1315 # Convert mboxMessage and MMDFMessage to MaildirMessage
1316 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1317 msg_mboxMMDF = class_(_sample_message)
1318 msg_mboxMMDF.set_from('foo@bar', time.gmtime(0.0))
1319 pairs = (('R', 'S'), ('O', ''), ('D', 'T'), ('F', 'F'), ('A', 'R'),
1320 ('RODFA', 'FRST'))
1321 for setting, result in pairs:
1322 msg_mboxMMDF.set_flags(setting)
1323 msg = mailbox.MaildirMessage(msg_mboxMMDF)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001324 self.assertEqual(msg.get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001325 self.assert_(msg.get_date() == 0.0, msg.get_date())
1326 msg_mboxMMDF.set_flags('O')
Guido van Rossumea834472007-07-27 05:17:50 +00001327 self.assertEqual(mailbox.MaildirMessage(msg_mboxMMDF).get_subdir(),
1328 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001329
1330 def test_mboxmmdf_to_mboxmmdf(self):
1331 # Convert mboxMessage and MMDFMessage to mboxMessage and MMDFMessage
1332 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1333 msg_mboxMMDF = class_(_sample_message)
1334 msg_mboxMMDF.set_flags('RODFA')
1335 msg_mboxMMDF.set_from('foo@bar')
1336 for class2_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1337 msg2 = class2_(msg_mboxMMDF)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001338 self.assertEqual(msg2.get_flags(), 'RODFA')
1339 self.assertEqual(msg2.get_from(), 'foo@bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001340
1341 def test_mboxmmdf_to_mh(self):
1342 # Convert mboxMessage and MMDFMessage to MHMessage
1343 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1344 msg_mboxMMDF = class_(_sample_message)
1345 pairs = (('R', []), ('O', ['unseen']), ('D', ['unseen']),
1346 ('F', ['unseen', 'flagged']),
1347 ('A', ['unseen', 'replied']),
1348 ('RODFA', ['replied', 'flagged']))
1349 for setting, result in pairs:
1350 msg_mboxMMDF.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001351 self.assertEqual(mailbox.MHMessage(msg_mboxMMDF).get_sequences(),
1352 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001353
1354 def test_mboxmmdf_to_babyl(self):
1355 # Convert mboxMessage and MMDFMessage to BabylMessage
1356 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1357 msg = class_(_sample_message)
1358 pairs = (('R', []), ('O', ['unseen']),
1359 ('D', ['unseen', 'deleted']), ('F', ['unseen']),
1360 ('A', ['unseen', 'answered']),
1361 ('RODFA', ['deleted', 'answered']))
1362 for setting, result in pairs:
1363 msg.set_flags(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001364 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001365
1366 def test_mh_to_maildir(self):
1367 # Convert MHMessage to MaildirMessage
1368 pairs = (('unseen', ''), ('replied', 'RS'), ('flagged', 'FS'))
1369 for setting, result in pairs:
1370 msg = mailbox.MHMessage(_sample_message)
1371 msg.add_sequence(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001372 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1373 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001374 msg = mailbox.MHMessage(_sample_message)
1375 msg.add_sequence('unseen')
1376 msg.add_sequence('replied')
1377 msg.add_sequence('flagged')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001378 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'FR')
1379 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001380
1381 def test_mh_to_mboxmmdf(self):
1382 # Convert MHMessage to mboxMessage and MMDFMessage
1383 pairs = (('unseen', 'O'), ('replied', 'ROA'), ('flagged', 'ROF'))
1384 for setting, result in pairs:
1385 msg = mailbox.MHMessage(_sample_message)
1386 msg.add_sequence(setting)
1387 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001388 self.assertEqual(class_(msg).get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001389 msg = mailbox.MHMessage(_sample_message)
1390 msg.add_sequence('unseen')
1391 msg.add_sequence('replied')
1392 msg.add_sequence('flagged')
1393 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001394 self.assertEqual(class_(msg).get_flags(), 'OFA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001395
1396 def test_mh_to_mh(self):
1397 # Convert MHMessage to MHMessage
1398 msg = mailbox.MHMessage(_sample_message)
1399 msg.add_sequence('unseen')
1400 msg.add_sequence('replied')
1401 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001402 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1403 ['unseen', 'replied', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001404
1405 def test_mh_to_babyl(self):
1406 # Convert MHMessage to BabylMessage
1407 pairs = (('unseen', ['unseen']), ('replied', ['answered']),
1408 ('flagged', []))
1409 for setting, result in pairs:
1410 msg = mailbox.MHMessage(_sample_message)
1411 msg.add_sequence(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001412 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001413 msg = mailbox.MHMessage(_sample_message)
1414 msg.add_sequence('unseen')
1415 msg.add_sequence('replied')
1416 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001417 self.assertEqual(mailbox.BabylMessage(msg).get_labels(),
1418 ['unseen', 'answered'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001419
1420 def test_babyl_to_maildir(self):
1421 # Convert BabylMessage to MaildirMessage
1422 pairs = (('unseen', ''), ('deleted', 'ST'), ('filed', 'S'),
1423 ('answered', 'RS'), ('forwarded', 'PS'), ('edited', 'S'),
1424 ('resent', 'PS'))
1425 for setting, result in pairs:
1426 msg = mailbox.BabylMessage(_sample_message)
1427 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001428 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1429 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001430 msg = mailbox.BabylMessage(_sample_message)
1431 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1432 'edited', 'resent'):
1433 msg.add_label(label)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001434 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'PRT')
1435 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001436
1437 def test_babyl_to_mboxmmdf(self):
1438 # Convert BabylMessage to mboxMessage and MMDFMessage
1439 pairs = (('unseen', 'O'), ('deleted', 'ROD'), ('filed', 'RO'),
1440 ('answered', 'ROA'), ('forwarded', 'RO'), ('edited', 'RO'),
1441 ('resent', 'RO'))
1442 for setting, result in pairs:
1443 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1444 msg = mailbox.BabylMessage(_sample_message)
1445 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001446 self.assertEqual(class_(msg).get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001447 msg = mailbox.BabylMessage(_sample_message)
1448 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1449 'edited', 'resent'):
1450 msg.add_label(label)
1451 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001452 self.assertEqual(class_(msg).get_flags(), 'ODA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001453
1454 def test_babyl_to_mh(self):
1455 # Convert BabylMessage to MHMessage
1456 pairs = (('unseen', ['unseen']), ('deleted', []), ('filed', []),
1457 ('answered', ['replied']), ('forwarded', []), ('edited', []),
1458 ('resent', []))
1459 for setting, result in pairs:
1460 msg = mailbox.BabylMessage(_sample_message)
1461 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001462 self.assertEqual(mailbox.MHMessage(msg).get_sequences(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001463 msg = mailbox.BabylMessage(_sample_message)
1464 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1465 'edited', 'resent'):
1466 msg.add_label(label)
Guido van Rossumea834472007-07-27 05:17:50 +00001467 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1468 ['unseen', 'replied'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001469
1470 def test_babyl_to_babyl(self):
1471 # Convert BabylMessage to BabylMessage
1472 msg = mailbox.BabylMessage(_sample_message)
1473 msg.update_visible()
1474 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1475 'edited', 'resent'):
1476 msg.add_label(label)
1477 msg2 = mailbox.BabylMessage(msg)
Guido van Rossumea834472007-07-27 05:17:50 +00001478 self.assertEqual(msg2.get_labels(), ['unseen', 'deleted', 'filed',
1479 'answered', 'forwarded', 'edited',
1480 'resent'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001481 self.assertEqual(msg.get_visible().keys(), msg2.get_visible().keys())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001482 for key in msg.get_visible().keys():
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001483 self.assertEqual(msg.get_visible()[key], msg2.get_visible()[key])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001484
1485
1486class TestProxyFileBase(TestBase):
1487
1488 def _test_read(self, proxy):
1489 # Read by byte
1490 proxy.seek(0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001491 self.assertEqual(proxy.read(), 'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001492 proxy.seek(1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001493 self.assertEqual(proxy.read(), 'ar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001494 proxy.seek(0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001495 self.assertEqual(proxy.read(2), 'ba')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001496 proxy.seek(1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001497 self.assertEqual(proxy.read(-1), 'ar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001498 proxy.seek(2)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001499 self.assertEqual(proxy.read(1000), 'r')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001500
1501 def _test_readline(self, proxy):
1502 # Read by line
1503 proxy.seek(0)
Guido van Rossumea834472007-07-27 05:17:50 +00001504 self.assertEqual(proxy.readline(), 'foo' + os.linesep)
1505 self.assertEqual(proxy.readline(), 'bar' + os.linesep)
1506 self.assertEqual(proxy.readline(), 'fred' + os.linesep)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001507 self.assertEqual(proxy.readline(), 'bob')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001508 proxy.seek(2)
Guido van Rossumea834472007-07-27 05:17:50 +00001509 self.assertEqual(proxy.readline(), 'o' + os.linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001510 proxy.seek(6 + 2 * len(os.linesep))
Guido van Rossumea834472007-07-27 05:17:50 +00001511 self.assertEqual(proxy.readline(), 'fred' + os.linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001512 proxy.seek(6 + 2 * len(os.linesep))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001513 self.assertEqual(proxy.readline(2), 'fr')
Guido van Rossumea834472007-07-27 05:17:50 +00001514 self.assertEqual(proxy.readline(-10), 'ed' + os.linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001515
1516 def _test_readlines(self, proxy):
1517 # Read multiple lines
1518 proxy.seek(0)
Guido van Rossumea834472007-07-27 05:17:50 +00001519 self.assertEqual(proxy.readlines(), ['foo' + os.linesep,
Thomas Wouters477c8d52006-05-27 19:21:47 +00001520 'bar' + os.linesep,
1521 'fred' + os.linesep, 'bob'])
1522 proxy.seek(0)
Guido van Rossumea834472007-07-27 05:17:50 +00001523 self.assertEqual(proxy.readlines(2), ['foo' + os.linesep])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001524 proxy.seek(3 + len(os.linesep))
Guido van Rossumea834472007-07-27 05:17:50 +00001525 self.assertEqual(proxy.readlines(4 + len(os.linesep)),
Thomas Wouters477c8d52006-05-27 19:21:47 +00001526 ['bar' + os.linesep, 'fred' + os.linesep])
1527 proxy.seek(3)
Guido van Rossumea834472007-07-27 05:17:50 +00001528 self.assertEqual(proxy.readlines(1000), [os.linesep, 'bar' + os.linesep,
Thomas Wouters477c8d52006-05-27 19:21:47 +00001529 'fred' + os.linesep, 'bob'])
1530
1531 def _test_iteration(self, proxy):
1532 # Iterate by line
1533 proxy.seek(0)
1534 iterator = iter(proxy)
Guido van Rossumea834472007-07-27 05:17:50 +00001535 self.assertEqual(next(iterator), 'foo' + os.linesep)
1536 self.assertEqual(next(iterator), 'bar' + os.linesep)
1537 self.assertEqual(next(iterator), 'fred' + os.linesep)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001538 self.assertEqual(next(iterator), 'bob')
Georg Brandla18af4e2007-04-21 15:47:16 +00001539 self.assertRaises(StopIteration, next, iterator)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001540
1541 def _test_seek_and_tell(self, proxy):
1542 # Seek and use tell to check position
1543 proxy.seek(3)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001544 self.assertEqual(proxy.tell(), 3)
1545 self.assertEqual(proxy.read(len(os.linesep)), os.linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001546 proxy.seek(2, 1)
Guido van Rossumea834472007-07-27 05:17:50 +00001547 self.assertEqual(proxy.read(1 + len(os.linesep)), 'r' + os.linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001548 proxy.seek(-3 - len(os.linesep), 2)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001549 self.assertEqual(proxy.read(3), 'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001550 proxy.seek(2, 0)
Guido van Rossumea834472007-07-27 05:17:50 +00001551 self.assertEqual(proxy.read(), 'o' + os.linesep + 'bar' + os.linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001552 proxy.seek(100)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001553 self.assertEqual(proxy.read(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001554
1555 def _test_close(self, proxy):
1556 # Close a file
1557 proxy.close()
1558 self.assertRaises(AttributeError, lambda: proxy.close())
1559
1560
1561class TestProxyFile(TestProxyFileBase):
1562
1563 def setUp(self):
1564 self._path = test_support.TESTFN
1565 self._file = open(self._path, 'wb+')
1566
1567 def tearDown(self):
1568 self._file.close()
1569 self._delete_recursively(self._path)
1570
1571 def test_initialize(self):
1572 # Initialize and check position
Neal Norwitz9a923102007-08-30 06:20:05 +00001573 self._file.write(b'foo')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001574 pos = self._file.tell()
1575 proxy0 = mailbox._ProxyFile(self._file)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001576 self.assertEqual(proxy0.tell(), pos)
1577 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001578 proxy1 = mailbox._ProxyFile(self._file, 0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001579 self.assertEqual(proxy1.tell(), 0)
1580 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001581
1582 def test_read(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001583 self._file.write(b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001584 self._test_read(mailbox._ProxyFile(self._file))
1585
1586 def test_readline(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001587 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1588 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001589 self._test_readline(mailbox._ProxyFile(self._file))
1590
1591 def test_readlines(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001592 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1593 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001594 self._test_readlines(mailbox._ProxyFile(self._file))
1595
1596 def test_iteration(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001597 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1598 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001599 self._test_iteration(mailbox._ProxyFile(self._file))
1600
1601 def test_seek_and_tell(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001602 self._file.write(bytes('foo%sbar%s' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001603 self._test_seek_and_tell(mailbox._ProxyFile(self._file))
1604
1605 def test_close(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001606 self._file.write(bytes('foo%sbar%s' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001607 self._test_close(mailbox._ProxyFile(self._file))
1608
1609
1610class TestPartialFile(TestProxyFileBase):
1611
1612 def setUp(self):
1613 self._path = test_support.TESTFN
1614 self._file = open(self._path, 'wb+')
1615
1616 def tearDown(self):
1617 self._file.close()
1618 self._delete_recursively(self._path)
1619
1620 def test_initialize(self):
1621 # Initialize and check position
Neal Norwitz9a923102007-08-30 06:20:05 +00001622 self._file.write(bytes('foo' + os.linesep + 'bar', 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001623 pos = self._file.tell()
1624 proxy = mailbox._PartialFile(self._file, 2, 5)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001625 self.assertEqual(proxy.tell(), 0)
1626 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001627
1628 def test_read(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001629 self._file.write(bytes('***bar***', 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001630 self._test_read(mailbox._PartialFile(self._file, 3, 6))
1631
1632 def test_readline(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001633 self._file.write(bytes('!!!!!foo%sbar%sfred%sbob!!!!!' %
1634 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001635 self._test_readline(mailbox._PartialFile(self._file, 5,
1636 18 + 3 * len(os.linesep)))
1637
1638 def test_readlines(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_readlines(mailbox._PartialFile(self._file, 0,
1642 13 + 3 * len(os.linesep)))
1643
1644 def test_iteration(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_iteration(mailbox._PartialFile(self._file, 4,
1648 17 + 3 * len(os.linesep)))
1649
1650 def test_seek_and_tell(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001651 self._file.write(bytes('(((foo%sbar%s$$$' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001652 self._test_seek_and_tell(mailbox._PartialFile(self._file, 3,
1653 9 + 2 * len(os.linesep)))
1654
1655 def test_close(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001656 self._file.write(bytes('&foo%sbar%s^' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001657 self._test_close(mailbox._PartialFile(self._file, 1,
1658 6 + 3 * len(os.linesep)))
1659
1660
1661## Start: tests from the original module (for backward compatibility).
1662
Skip Montanaro5253da12004-07-24 19:56:03 +00001663FROM_ = "From some.body@dummy.domain Sat Jul 24 13:43:35 2004\n"
Fred Drakec02bc3e2001-05-21 20:23:21 +00001664DUMMY_MESSAGE = """\
1665From: some.body@dummy.domain
1666To: me@my.domain
Skip Montanaro5253da12004-07-24 19:56:03 +00001667Subject: Simple Test
Fred Drakec02bc3e2001-05-21 20:23:21 +00001668
1669This is a dummy message.
1670"""
1671
Fred Drakec02bc3e2001-05-21 20:23:21 +00001672class MaildirTestCase(unittest.TestCase):
1673
1674 def setUp(self):
1675 # create a new maildir mailbox to work with:
1676 self._dir = test_support.TESTFN
1677 os.mkdir(self._dir)
1678 os.mkdir(os.path.join(self._dir, "cur"))
1679 os.mkdir(os.path.join(self._dir, "tmp"))
1680 os.mkdir(os.path.join(self._dir, "new"))
1681 self._counter = 1
1682 self._msgfiles = []
1683
1684 def tearDown(self):
Guido van Rossumc1f779c2007-07-03 08:25:58 +00001685 list(map(os.unlink, self._msgfiles))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001686 os.rmdir(os.path.join(self._dir, "cur"))
1687 os.rmdir(os.path.join(self._dir, "tmp"))
1688 os.rmdir(os.path.join(self._dir, "new"))
1689 os.rmdir(self._dir)
1690
Skip Montanaro5253da12004-07-24 19:56:03 +00001691 def createMessage(self, dir, mbox=False):
Jack Jansen97df7b62001-06-19 20:20:05 +00001692 t = int(time.time() % 1000000)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001693 pid = self._counter
1694 self._counter += 1
Skip Montanaro7a98be22007-08-16 14:35:24 +00001695 filename = ".".join((str(t), str(pid), "myhostname", "mydomain"))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001696 tmpname = os.path.join(self._dir, "tmp", filename)
1697 newname = os.path.join(self._dir, dir, filename)
1698 fp = open(tmpname, "w")
1699 self._msgfiles.append(tmpname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001700 if mbox:
1701 fp.write(FROM_)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001702 fp.write(DUMMY_MESSAGE)
1703 fp.close()
Tim Peters6626c1f2001-05-22 16:29:01 +00001704 if hasattr(os, "link"):
1705 os.link(tmpname, newname)
1706 else:
1707 fp = open(newname, "w")
1708 fp.write(DUMMY_MESSAGE)
1709 fp.close()
Fred Drakec02bc3e2001-05-21 20:23:21 +00001710 self._msgfiles.append(newname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001711 return tmpname
Fred Drakec02bc3e2001-05-21 20:23:21 +00001712
1713 def test_empty_maildir(self):
1714 """Test an empty maildir mailbox"""
1715 # Test for regression on bug #117490:
1716 # Make sure the boxes attribute actually gets set.
1717 self.mbox = mailbox.Maildir(test_support.TESTFN)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001718 #self.assert_(hasattr(self.mbox, "boxes"))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001719 #self.assertEqual(len(self.mbox.boxes), 0)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001720 self.assert_(self.mbox.next() is None)
1721 self.assert_(self.mbox.next() is None)
1722
1723 def test_nonempty_maildir_cur(self):
1724 self.createMessage("cur")
1725 self.mbox = mailbox.Maildir(test_support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001726 #self.assertEqual(len(self.mbox.boxes), 1)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001727 self.assert_(self.mbox.next() is not None)
1728 self.assert_(self.mbox.next() is None)
1729 self.assert_(self.mbox.next() is None)
1730
1731 def test_nonempty_maildir_new(self):
1732 self.createMessage("new")
1733 self.mbox = mailbox.Maildir(test_support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001734 #self.assertEqual(len(self.mbox.boxes), 1)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001735 self.assert_(self.mbox.next() is not None)
1736 self.assert_(self.mbox.next() is None)
1737 self.assert_(self.mbox.next() is None)
1738
1739 def test_nonempty_maildir_both(self):
1740 self.createMessage("cur")
1741 self.createMessage("new")
1742 self.mbox = mailbox.Maildir(test_support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001743 #self.assertEqual(len(self.mbox.boxes), 2)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001744 self.assert_(self.mbox.next() is not None)
1745 self.assert_(self.mbox.next() is not None)
1746 self.assert_(self.mbox.next() is None)
1747 self.assert_(self.mbox.next() is None)
Fred Drake0aaed272000-10-23 13:39:15 +00001748
Skip Montanaro5253da12004-07-24 19:56:03 +00001749 def test_unix_mbox(self):
1750 ### should be better!
Thomas Woutersb2137042007-02-01 18:02:27 +00001751 import email.parser
Skip Montanaro5253da12004-07-24 19:56:03 +00001752 fname = self.createMessage("cur", True)
1753 n = 0
1754 for msg in mailbox.PortableUnixMailbox(open(fname),
Thomas Woutersb2137042007-02-01 18:02:27 +00001755 email.parser.Parser().parse):
Skip Montanaro5253da12004-07-24 19:56:03 +00001756 n += 1
1757 self.assertEqual(msg["subject"], "Simple Test")
Guido van Rossum671117a2007-08-31 04:25:05 +00001758 # XXX Disabled until we figure out how to fix this
1759 ##self.assertEqual(len(str(msg)), len(FROM_)+len(DUMMY_MESSAGE))
Skip Montanaro5253da12004-07-24 19:56:03 +00001760 self.assertEqual(n, 1)
1761
Thomas Wouters477c8d52006-05-27 19:21:47 +00001762## End: classes from the original module (for backward compatibility).
1763
1764
1765_sample_message = """\
1766Return-Path: <gkj@gregorykjohnson.com>
1767X-Original-To: gkj+person@localhost
1768Delivered-To: gkj+person@localhost
1769Received: from localhost (localhost [127.0.0.1])
1770 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1771 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
1772Delivered-To: gkj@sundance.gregorykjohnson.com
1773Received: from localhost [127.0.0.1]
1774 by localhost with POP3 (fetchmail-6.2.5)
1775 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
1776Received: from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
1777 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1778 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
1779Received: by andy.gregorykjohnson.com (Postfix, from userid 1000)
1780 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
1781Date: Wed, 13 Jul 2005 17:23:11 -0400
1782From: "Gregory K. Johnson" <gkj@gregorykjohnson.com>
1783To: gkj@gregorykjohnson.com
1784Subject: Sample message
1785Message-ID: <20050713212311.GC4701@andy.gregorykjohnson.com>
1786Mime-Version: 1.0
1787Content-Type: multipart/mixed; boundary="NMuMz9nt05w80d4+"
1788Content-Disposition: inline
1789User-Agent: Mutt/1.5.9i
1790
1791
1792--NMuMz9nt05w80d4+
1793Content-Type: text/plain; charset=us-ascii
1794Content-Disposition: inline
1795
1796This is a sample message.
1797
1798--
1799Gregory K. Johnson
1800
1801--NMuMz9nt05w80d4+
1802Content-Type: application/octet-stream
1803Content-Disposition: attachment; filename="text.gz"
1804Content-Transfer-Encoding: base64
1805
1806H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
18073FYlAAAA
1808
1809--NMuMz9nt05w80d4+--
1810"""
1811
1812_sample_headers = {
1813 "Return-Path":"<gkj@gregorykjohnson.com>",
1814 "X-Original-To":"gkj+person@localhost",
1815 "Delivered-To":"gkj+person@localhost",
1816 "Received":"""from localhost (localhost [127.0.0.1])
1817 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1818 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
1819 "Delivered-To":"gkj@sundance.gregorykjohnson.com",
1820 "Received":"""from localhost [127.0.0.1]
1821 by localhost with POP3 (fetchmail-6.2.5)
1822 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
1823 "Received":"""from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
1824 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1825 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
1826 "Received":"""by andy.gregorykjohnson.com (Postfix, from userid 1000)
1827 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
1828 "Date":"Wed, 13 Jul 2005 17:23:11 -0400",
1829 "From":""""Gregory K. Johnson" <gkj@gregorykjohnson.com>""",
1830 "To":"gkj@gregorykjohnson.com",
1831 "Subject":"Sample message",
1832 "Mime-Version":"1.0",
1833 "Content-Type":"""multipart/mixed; boundary="NMuMz9nt05w80d4+\"""",
1834 "Content-Disposition":"inline",
1835 "User-Agent": "Mutt/1.5.9i" }
1836
1837_sample_payloads = ("""This is a sample message.
1838
1839--
1840Gregory K. Johnson
1841""",
1842"""H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
18433FYlAAAA
1844""")
Fred Drake0aaed272000-10-23 13:39:15 +00001845
Fred Drakec02bc3e2001-05-21 20:23:21 +00001846
Fred Drake2e2be372001-09-20 21:33:42 +00001847def test_main():
Thomas Wouters477c8d52006-05-27 19:21:47 +00001848 tests = (TestMailboxSuperclass, TestMaildir, TestMbox, TestMMDF, TestMH,
1849 TestBabyl, TestMessage, TestMaildirMessage, TestMboxMessage,
1850 TestMHMessage, TestBabylMessage, TestMMDFMessage,
1851 TestMessageConversion, TestProxyFile, TestPartialFile,
1852 MaildirTestCase)
1853 test_support.run_unittest(*tests)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001854 test_support.reap_children()
Fred Drake2e2be372001-09-20 21:33:42 +00001855
1856
Thomas Wouters477c8d52006-05-27 19:21:47 +00001857if __name__ == '__main__':
Fred Drake2e2be372001-09-20 21:33:42 +00001858 test_main()