blob: 9be1332a3319c83d8a416bc2dfde6a00ec469e8e [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 re
Guido van Rossum34d19282007-08-09 01:03:29 +00009import io
Benjamin Petersonee8712c2008-05-20 21:35:26 +000010from test import support
Thomas Wouters477c8d52006-05-27 19:21:47 +000011import unittest
12import mailbox
13import glob
Guido van Rossum75ebb292001-04-10 15:01:20 +000014try:
Thomas Wouters477c8d52006-05-27 19:21:47 +000015 import fcntl
16except ImportError:
Guido van Rossum75ebb292001-04-10 15:01:20 +000017 pass
18
Thomas Wouters477c8d52006-05-27 19:21:47 +000019
20class TestBase(unittest.TestCase):
21
22 def _check_sample(self, msg):
23 # Inspect a mailbox.Message representation of the sample message
Georg Brandlab91fde2009-08-13 08:51:18 +000024 self.assertTrue(isinstance(msg, email.message.Message))
25 self.assertTrue(isinstance(msg, mailbox.Message))
Guido van Rossumcc2b0162007-02-11 06:12:03 +000026 for key, value in _sample_headers.items():
Georg Brandl194da4a2009-08-13 09:34:05 +000027 self.assertIn(value, msg.get_all(key))
Georg Brandlab91fde2009-08-13 08:51:18 +000028 self.assertTrue(msg.is_multipart())
Guido van Rossume61fd5b2007-07-11 12:20:59 +000029 self.assertEqual(len(msg.get_payload()), len(_sample_payloads))
Thomas Wouters477c8d52006-05-27 19:21:47 +000030 for i, payload in enumerate(_sample_payloads):
31 part = msg.get_payload(i)
Georg Brandlab91fde2009-08-13 08:51:18 +000032 self.assertTrue(isinstance(part, email.message.Message))
Georg Brandl194da4a2009-08-13 09:34:05 +000033 self.assertFalse(isinstance(part, mailbox.Message))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000034 self.assertEqual(part.get_payload(), payload)
Thomas Wouters477c8d52006-05-27 19:21:47 +000035
36 def _delete_recursively(self, target):
37 # Delete a file or delete a directory recursively
38 if os.path.isdir(target):
39 for path, dirs, files in os.walk(target, topdown=False):
40 for name in files:
41 os.remove(os.path.join(path, name))
42 for name in dirs:
43 os.rmdir(os.path.join(path, name))
44 os.rmdir(target)
45 elif os.path.exists(target):
46 os.remove(target)
47
48
49class TestMailbox(TestBase):
50
51 _factory = None # Overridden by subclasses to reuse tests
52 _template = 'From: foo\n\n%s'
53
54 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +000055 self._path = support.TESTFN
Guido van Rossumd8faa362007-04-27 19:54:29 +000056 self._delete_recursively(self._path)
Thomas Wouters477c8d52006-05-27 19:21:47 +000057 self._box = self._factory(self._path)
58
59 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +000060 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +000061 self._delete_recursively(self._path)
62
63 def test_add(self):
64 # Add copies of a sample message
65 keys = []
66 keys.append(self._box.add(self._template % 0))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000067 self.assertEqual(len(self._box), 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +000068 keys.append(self._box.add(mailbox.Message(_sample_message)))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000069 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +000070 keys.append(self._box.add(email.message_from_string(_sample_message)))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000071 self.assertEqual(len(self._box), 3)
Guido van Rossum34d19282007-08-09 01:03:29 +000072 keys.append(self._box.add(io.StringIO(_sample_message)))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000073 self.assertEqual(len(self._box), 4)
Thomas Wouters477c8d52006-05-27 19:21:47 +000074 keys.append(self._box.add(_sample_message))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000075 self.assertEqual(len(self._box), 5)
Guido van Rossumea834472007-07-27 05:17:50 +000076 self.assertEqual(self._box.get_string(keys[0]), self._template % 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +000077 for i in (1, 2, 3, 4):
78 self._check_sample(self._box[keys[i]])
79
80 def test_remove(self):
81 # Remove messages using remove()
82 self._test_remove_or_delitem(self._box.remove)
83
84 def test_delitem(self):
85 # Remove messages using __delitem__()
86 self._test_remove_or_delitem(self._box.__delitem__)
87
88 def _test_remove_or_delitem(self, method):
89 # (Used by test_remove() and test_delitem().)
90 key0 = self._box.add(self._template % 0)
91 key1 = self._box.add(self._template % 1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +000092 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +000093 method(key0)
Georg Brandl194da4a2009-08-13 09:34:05 +000094 self.assertEqual(len(self._box), 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +000095 self.assertRaises(KeyError, lambda: self._box[key0])
96 self.assertRaises(KeyError, lambda: method(key0))
Guido van Rossumea834472007-07-27 05:17:50 +000097 self.assertEqual(self._box.get_string(key1), self._template % 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +000098 key2 = self._box.add(self._template % 2)
Guido van Rossume61fd5b2007-07-11 12:20:59 +000099 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000100 method(key2)
Georg Brandl194da4a2009-08-13 09:34:05 +0000101 self.assertEqual(len(self._box), 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000102 self.assertRaises(KeyError, lambda: self._box[key2])
103 self.assertRaises(KeyError, lambda: method(key2))
Guido van Rossumea834472007-07-27 05:17:50 +0000104 self.assertEqual(self._box.get_string(key1), self._template % 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000105 method(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000106 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000107 self.assertRaises(KeyError, lambda: self._box[key1])
108 self.assertRaises(KeyError, lambda: method(key1))
109
110 def test_discard(self, repetitions=10):
111 # Discard messages
112 key0 = self._box.add(self._template % 0)
113 key1 = self._box.add(self._template % 1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000114 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000115 self._box.discard(key0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000116 self.assertEqual(len(self._box), 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000117 self.assertRaises(KeyError, lambda: self._box[key0])
118 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
122 def test_get(self):
123 # Retrieve messages using get()
124 key0 = self._box.add(self._template % 0)
125 msg = self._box.get(key0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000126 self.assertEqual(msg['from'], 'foo')
127 self.assertEqual(msg.get_payload(), '0')
Georg Brandl194da4a2009-08-13 09:34:05 +0000128 self.assertIs(self._box.get('foo'), None)
129 self.assertIs(self._box.get('foo', False), False)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000130 self._box.close()
Georg Brandlfb16cf12008-05-11 21:31:44 +0000131 self._box = self._factory(self._path)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000132 key1 = self._box.add(self._template % 1)
133 msg = self._box.get(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000134 self.assertEqual(msg['from'], 'foo')
Georg Brandlfb16cf12008-05-11 21:31:44 +0000135 self.assertEqual(msg.get_payload(), '1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000136
137 def test_getitem(self):
138 # Retrieve message using __getitem__()
139 key0 = self._box.add(self._template % 0)
140 msg = self._box[key0]
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000141 self.assertEqual(msg['from'], 'foo')
142 self.assertEqual(msg.get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000143 self.assertRaises(KeyError, lambda: self._box['foo'])
144 self._box.discard(key0)
145 self.assertRaises(KeyError, lambda: self._box[key0])
146
147 def test_get_message(self):
148 # Get Message representations of messages
149 key0 = self._box.add(self._template % 0)
150 key1 = self._box.add(_sample_message)
151 msg0 = self._box.get_message(key0)
Georg Brandlab91fde2009-08-13 08:51:18 +0000152 self.assertTrue(isinstance(msg0, mailbox.Message))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000153 self.assertEqual(msg0['from'], 'foo')
154 self.assertEqual(msg0.get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000155 self._check_sample(self._box.get_message(key1))
156
157 def test_get_string(self):
158 # Get string representations of messages
159 key0 = self._box.add(self._template % 0)
160 key1 = self._box.add(_sample_message)
Guido van Rossumea834472007-07-27 05:17:50 +0000161 self.assertEqual(self._box.get_string(key0), self._template % 0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000162 self.assertEqual(self._box.get_string(key1), _sample_message)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000163
164 def test_get_file(self):
165 # Get file representations of messages
166 key0 = self._box.add(self._template % 0)
167 key1 = self._box.add(_sample_message)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000168 data0 = self._box.get_file(key0).read()
169 data1 = self._box.get_file(key1).read()
170 self.assertEqual(data0.replace(os.linesep, '\n'),
Guido van Rossumea834472007-07-27 05:17:50 +0000171 self._template % 0)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000172 self.assertEqual(data1.replace(os.linesep, '\n'),
Guido van Rossumea834472007-07-27 05:17:50 +0000173 _sample_message)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000174
175 def test_iterkeys(self):
176 # Get keys using iterkeys()
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000177 self._check_iteration(self._box.keys, do_keys=True, do_values=False)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000178
179 def test_keys(self):
180 # Get keys using keys()
181 self._check_iteration(self._box.keys, do_keys=True, do_values=False)
182
183 def test_itervalues(self):
184 # Get values using itervalues()
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000185 self._check_iteration(self._box.values, do_keys=False,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000186 do_values=True)
187
188 def test_iter(self):
189 # Get values using __iter__()
190 self._check_iteration(self._box.__iter__, do_keys=False,
191 do_values=True)
192
193 def test_values(self):
194 # Get values using values()
195 self._check_iteration(self._box.values, do_keys=False, do_values=True)
196
197 def test_iteritems(self):
198 # Get keys and values using iteritems()
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000199 self._check_iteration(self._box.items, do_keys=True,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000200 do_values=True)
201
202 def test_items(self):
203 # Get keys and values using items()
204 self._check_iteration(self._box.items, do_keys=True, do_values=True)
205
206 def _check_iteration(self, method, do_keys, do_values, repetitions=10):
207 for value in method():
208 self.fail("Not empty")
209 keys, values = [], []
Guido van Rossum805365e2007-05-07 22:24:25 +0000210 for i in range(repetitions):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000211 keys.append(self._box.add(self._template % i))
212 values.append(self._template % i)
213 if do_keys and not do_values:
214 returned_keys = list(method())
215 elif do_values and not do_keys:
216 returned_values = list(method())
217 else:
218 returned_keys, returned_values = [], []
219 for key, value in method():
220 returned_keys.append(key)
221 returned_values.append(value)
222 if do_keys:
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000223 self.assertEqual(len(keys), len(returned_keys))
224 self.assertEqual(set(keys), set(returned_keys))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000225 if do_values:
226 count = 0
227 for value in returned_values:
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000228 self.assertEqual(value['from'], 'foo')
Georg Brandl194da4a2009-08-13 09:34:05 +0000229 self.assertLess(int(value.get_payload()), repetitions)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000230 count += 1
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000231 self.assertEqual(len(values), count)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000232
Thomas Wouters477c8d52006-05-27 19:21:47 +0000233 def test_contains(self):
234 # Check existence of keys using __contains__()
Georg Brandl194da4a2009-08-13 09:34:05 +0000235 self.assertNotIn('foo', self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000236 key0 = self._box.add(self._template % 0)
Georg Brandl194da4a2009-08-13 09:34:05 +0000237 self.assertIn(key0, self._box)
238 self.assertNotIn('foo', self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000239 key1 = self._box.add(self._template % 1)
Georg Brandl194da4a2009-08-13 09:34:05 +0000240 self.assertIn(key1, self._box)
241 self.assertIn(key0, self._box)
242 self.assertNotIn('foo', self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000243 self._box.remove(key0)
Georg Brandl194da4a2009-08-13 09:34:05 +0000244 self.assertNotIn(key0, self._box)
245 self.assertIn(key1, self._box)
246 self.assertNotIn('foo', self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000247 self._box.remove(key1)
Georg Brandl194da4a2009-08-13 09:34:05 +0000248 self.assertNotIn(key1, self._box)
249 self.assertNotIn(key0, self._box)
250 self.assertNotIn('foo', self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000251
252 def test_len(self, repetitions=10):
253 # Get message count
254 keys = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000255 for i in range(repetitions):
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000256 self.assertEqual(len(self._box), i)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000257 keys.append(self._box.add(self._template % i))
Guido van Rossumea834472007-07-27 05:17:50 +0000258 self.assertEqual(len(self._box), i + 1)
Guido van Rossum805365e2007-05-07 22:24:25 +0000259 for i in range(repetitions):
Guido van Rossumea834472007-07-27 05:17:50 +0000260 self.assertEqual(len(self._box), repetitions - i)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000261 self._box.remove(keys[i])
Guido van Rossumea834472007-07-27 05:17:50 +0000262 self.assertEqual(len(self._box), repetitions - i - 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000263
264 def test_set_item(self):
265 # Modify messages using __setitem__()
266 key0 = self._box.add(self._template % 'original 0')
Guido van Rossumea834472007-07-27 05:17:50 +0000267 self.assertEqual(self._box.get_string(key0),
268 self._template % 'original 0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000269 key1 = self._box.add(self._template % 'original 1')
Guido van Rossumea834472007-07-27 05:17:50 +0000270 self.assertEqual(self._box.get_string(key1),
271 self._template % 'original 1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000272 self._box[key0] = self._template % 'changed 0'
Guido van Rossumea834472007-07-27 05:17:50 +0000273 self.assertEqual(self._box.get_string(key0),
274 self._template % 'changed 0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000275 self._box[key1] = self._template % 'changed 1'
Guido van Rossumea834472007-07-27 05:17:50 +0000276 self.assertEqual(self._box.get_string(key1),
277 self._template % 'changed 1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000278 self._box[key0] = _sample_message
279 self._check_sample(self._box[key0])
280 self._box[key1] = self._box[key0]
281 self._check_sample(self._box[key1])
282 self._box[key0] = self._template % 'original 0'
Guido van Rossumea834472007-07-27 05:17:50 +0000283 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000284 self._template % 'original 0')
285 self._check_sample(self._box[key1])
286 self.assertRaises(KeyError,
287 lambda: self._box.__setitem__('foo', 'bar'))
288 self.assertRaises(KeyError, lambda: self._box['foo'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000289 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000290
291 def test_clear(self, iterations=10):
292 # Remove all messages using clear()
293 keys = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000294 for i in range(iterations):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000295 self._box.add(self._template % i)
296 for i, key in enumerate(keys):
Georg Brandl194da4a2009-08-13 09:34:05 +0000297 self.assertEqual(self._box.get_string(key), self._template % i)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000298 self._box.clear()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000299 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000300 for i, key in enumerate(keys):
301 self.assertRaises(KeyError, lambda: self._box.get_string(key))
302
303 def test_pop(self):
304 # Get and remove a message using pop()
305 key0 = self._box.add(self._template % 0)
Georg Brandl194da4a2009-08-13 09:34:05 +0000306 self.assertIn(key0, self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000307 key1 = self._box.add(self._template % 1)
Georg Brandl194da4a2009-08-13 09:34:05 +0000308 self.assertIn(key1, self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000309 self.assertEqual(self._box.pop(key0).get_payload(), '0')
Georg Brandl194da4a2009-08-13 09:34:05 +0000310 self.assertNotIn(key0, self._box)
311 self.assertIn(key1, self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000312 key2 = self._box.add(self._template % 2)
Georg Brandl194da4a2009-08-13 09:34:05 +0000313 self.assertIn(key2, self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000314 self.assertEqual(self._box.pop(key2).get_payload(), '2')
Georg Brandl194da4a2009-08-13 09:34:05 +0000315 self.assertNotIn(key2, self._box)
316 self.assertIn(key1, self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000317 self.assertEqual(self._box.pop(key1).get_payload(), '1')
Georg Brandl194da4a2009-08-13 09:34:05 +0000318 self.assertNotIn(key1, self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000319 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000320
321 def test_popitem(self, iterations=10):
322 # Get and remove an arbitrary (key, message) using popitem()
323 keys = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000324 for i in range(10):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000325 keys.append(self._box.add(self._template % i))
326 seen = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000327 for i in range(10):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000328 key, msg = self._box.popitem()
Georg Brandl194da4a2009-08-13 09:34:05 +0000329 self.assertIn(key, keys)
330 self.assertNotIn(key, seen)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000331 seen.append(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000332 self.assertEqual(int(msg.get_payload()), keys.index(key))
333 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000334 for key in keys:
335 self.assertRaises(KeyError, lambda: self._box[key])
336
337 def test_update(self):
338 # Modify multiple messages using update()
339 key0 = self._box.add(self._template % 'original 0')
340 key1 = self._box.add(self._template % 'original 1')
341 key2 = self._box.add(self._template % 'original 2')
342 self._box.update({key0: self._template % 'changed 0',
343 key2: _sample_message})
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000344 self.assertEqual(len(self._box), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000345 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000346 self._template % 'changed 0')
Guido van Rossumea834472007-07-27 05:17:50 +0000347 self.assertEqual(self._box.get_string(key1),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000348 self._template % 'original 1')
349 self._check_sample(self._box[key2])
350 self._box.update([(key2, self._template % 'changed 2'),
351 (key1, self._template % 'changed 1'),
352 (key0, self._template % 'original 0')])
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000353 self.assertEqual(len(self._box), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000354 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000355 self._template % 'original 0')
Guido van Rossumea834472007-07-27 05:17:50 +0000356 self.assertEqual(self._box.get_string(key1),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000357 self._template % 'changed 1')
Guido van Rossumea834472007-07-27 05:17:50 +0000358 self.assertEqual(self._box.get_string(key2),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000359 self._template % 'changed 2')
360 self.assertRaises(KeyError,
361 lambda: self._box.update({'foo': 'bar',
362 key0: self._template % "changed 0"}))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000363 self.assertEqual(len(self._box), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000364 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000365 self._template % "changed 0")
Guido van Rossumea834472007-07-27 05:17:50 +0000366 self.assertEqual(self._box.get_string(key1),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000367 self._template % "changed 1")
Guido van Rossumea834472007-07-27 05:17:50 +0000368 self.assertEqual(self._box.get_string(key2),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000369 self._template % "changed 2")
370
371 def test_flush(self):
372 # Write changes to disk
Christian Heimesf6cd9672008-03-26 13:45:42 +0000373 self._test_flush_or_close(self._box.flush, True)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000374
375 def test_lock_unlock(self):
376 # Lock and unlock the mailbox
Georg Brandl194da4a2009-08-13 09:34:05 +0000377 self.assertFalse(os.path.exists(self._get_lock_path()))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000378 self._box.lock()
Georg Brandlab91fde2009-08-13 08:51:18 +0000379 self.assertTrue(os.path.exists(self._get_lock_path()))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000380 self._box.unlock()
Georg Brandl194da4a2009-08-13 09:34:05 +0000381 self.assertFalse(os.path.exists(self._get_lock_path()))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000382
383 def test_close(self):
384 # Close mailbox and flush changes to disk
Christian Heimesf6cd9672008-03-26 13:45:42 +0000385 self._test_flush_or_close(self._box.close, False)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000386
Christian Heimesf6cd9672008-03-26 13:45:42 +0000387 def _test_flush_or_close(self, method, should_call_close):
Guido van Rossum805365e2007-05-07 22:24:25 +0000388 contents = [self._template % i for i in range(3)]
Thomas Wouters477c8d52006-05-27 19:21:47 +0000389 self._box.add(contents[0])
390 self._box.add(contents[1])
391 self._box.add(contents[2])
Guido van Rossumc12a8132007-10-26 04:29:23 +0000392 oldbox = self._box
Thomas Wouters477c8d52006-05-27 19:21:47 +0000393 method()
Christian Heimesf6cd9672008-03-26 13:45:42 +0000394 if should_call_close:
395 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000396 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:
Georg Brandl194da4a2009-08-13 09:34:05 +0000400 self.assertIn(self._box.get_string(key), 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)
Amaury Forgeot d'Arc9edef042008-03-26 19:49:26 +0000409 self.assertEqual(output.getvalue(), _sample_message)
Guido van Rossum34d19282007-08-09 01:03:29 +0000410 output = io.StringIO()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000411 self.assertRaises(TypeError,
412 lambda: self._box._dump_message(None, output))
413
414 def _get_lock_path(self):
415 # Return the path of the dot lock file. May be overridden.
416 return self._path + '.lock'
417
418
419class TestMailboxSuperclass(TestBase):
420
421 def test_notimplemented(self):
422 # Test that all Mailbox methods raise NotImplementedException.
423 box = mailbox.Mailbox('path')
424 self.assertRaises(NotImplementedError, lambda: box.add(''))
425 self.assertRaises(NotImplementedError, lambda: box.remove(''))
426 self.assertRaises(NotImplementedError, lambda: box.__delitem__(''))
427 self.assertRaises(NotImplementedError, lambda: box.discard(''))
428 self.assertRaises(NotImplementedError, lambda: box.__setitem__('', ''))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000429 self.assertRaises(NotImplementedError, lambda: box.keys())
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000430 self.assertRaises(NotImplementedError, lambda: box.keys())
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000431 self.assertRaises(NotImplementedError, lambda: box.values().__next__())
432 self.assertRaises(NotImplementedError, lambda: box.__iter__().__next__())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000433 self.assertRaises(NotImplementedError, lambda: box.values())
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000434 self.assertRaises(NotImplementedError, lambda: box.items().next())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000435 self.assertRaises(NotImplementedError, lambda: box.items())
436 self.assertRaises(NotImplementedError, lambda: box.get(''))
437 self.assertRaises(NotImplementedError, lambda: box.__getitem__(''))
438 self.assertRaises(NotImplementedError, lambda: box.get_message(''))
439 self.assertRaises(NotImplementedError, lambda: box.get_string(''))
440 self.assertRaises(NotImplementedError, lambda: box.get_file(''))
Guido van Rossume2b70bc2006-08-18 22:13:04 +0000441 self.assertRaises(NotImplementedError, lambda: '' in box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000442 self.assertRaises(NotImplementedError, lambda: box.__contains__(''))
443 self.assertRaises(NotImplementedError, lambda: box.__len__())
444 self.assertRaises(NotImplementedError, lambda: box.clear())
445 self.assertRaises(NotImplementedError, lambda: box.pop(''))
446 self.assertRaises(NotImplementedError, lambda: box.popitem())
447 self.assertRaises(NotImplementedError, lambda: box.update((('', ''),)))
448 self.assertRaises(NotImplementedError, lambda: box.flush())
449 self.assertRaises(NotImplementedError, lambda: box.lock())
450 self.assertRaises(NotImplementedError, lambda: box.unlock())
451 self.assertRaises(NotImplementedError, lambda: box.close())
452
453
454class TestMaildir(TestMailbox):
455
456 _factory = lambda self, path, factory=None: mailbox.Maildir(path, factory)
457
458 def setUp(self):
459 TestMailbox.setUp(self)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000460 if os.name in ('nt', 'os2') or sys.platform == 'cygwin':
Thomas Wouters477c8d52006-05-27 19:21:47 +0000461 self._box.colon = '!'
462
463 def test_add_MM(self):
464 # Add a MaildirMessage instance
465 msg = mailbox.MaildirMessage(self._template % 0)
466 msg.set_subdir('cur')
467 msg.set_info('foo')
468 key = self._box.add(msg)
Georg Brandlab91fde2009-08-13 08:51:18 +0000469 self.assertTrue(os.path.exists(os.path.join(self._path, 'cur', '%s%sfoo' %
Thomas Wouters477c8d52006-05-27 19:21:47 +0000470 (key, self._box.colon))))
471
472 def test_get_MM(self):
473 # Get a MaildirMessage instance
474 msg = mailbox.MaildirMessage(self._template % 0)
475 msg.set_subdir('cur')
476 msg.set_flags('RF')
477 key = self._box.add(msg)
478 msg_returned = self._box.get_message(key)
Georg Brandlab91fde2009-08-13 08:51:18 +0000479 self.assertTrue(isinstance(msg_returned, mailbox.MaildirMessage))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000480 self.assertEqual(msg_returned.get_subdir(), 'cur')
481 self.assertEqual(msg_returned.get_flags(), 'FR')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000482
483 def test_set_MM(self):
484 # Set with a MaildirMessage instance
485 msg0 = mailbox.MaildirMessage(self._template % 0)
486 msg0.set_flags('TP')
487 key = self._box.add(msg0)
488 msg_returned = self._box.get_message(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000489 self.assertEqual(msg_returned.get_subdir(), 'new')
490 self.assertEqual(msg_returned.get_flags(), 'PT')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000491 msg1 = mailbox.MaildirMessage(self._template % 1)
492 self._box[key] = msg1
493 msg_returned = self._box.get_message(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000494 self.assertEqual(msg_returned.get_subdir(), 'new')
495 self.assertEqual(msg_returned.get_flags(), '')
496 self.assertEqual(msg_returned.get_payload(), '1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000497 msg2 = mailbox.MaildirMessage(self._template % 2)
498 msg2.set_info('2,S')
499 self._box[key] = msg2
500 self._box[key] = self._template % 3
501 msg_returned = self._box.get_message(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000502 self.assertEqual(msg_returned.get_subdir(), 'new')
503 self.assertEqual(msg_returned.get_flags(), 'S')
504 self.assertEqual(msg_returned.get_payload(), '3')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000505
Christian Heimesfdab48e2008-01-20 09:06:41 +0000506 def test_consistent_factory(self):
507 # Add a message.
508 msg = mailbox.MaildirMessage(self._template % 0)
509 msg.set_subdir('cur')
510 msg.set_flags('RF')
511 key = self._box.add(msg)
512
513 # Create new mailbox with
514 class FakeMessage(mailbox.MaildirMessage):
515 pass
516 box = mailbox.Maildir(self._path, factory=FakeMessage)
Christian Heimes15ebc882008-02-04 18:48:49 +0000517 box.colon = self._box.colon
Christian Heimesfdab48e2008-01-20 09:06:41 +0000518 msg2 = box.get_message(key)
Georg Brandlab91fde2009-08-13 08:51:18 +0000519 self.assertTrue(isinstance(msg2, FakeMessage))
Christian Heimesfdab48e2008-01-20 09:06:41 +0000520
Thomas Wouters477c8d52006-05-27 19:21:47 +0000521 def test_initialize_new(self):
522 # Initialize a non-existent mailbox
523 self.tearDown()
524 self._box = mailbox.Maildir(self._path)
Georg Brandlfb16cf12008-05-11 21:31:44 +0000525 self._check_basics()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000526 self._delete_recursively(self._path)
527 self._box = self._factory(self._path, factory=None)
528 self._check_basics()
529
530 def test_initialize_existing(self):
531 # Initialize an existing mailbox
532 self.tearDown()
533 for subdir in '', 'tmp', 'new', 'cur':
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000534 os.mkdir(os.path.normpath(os.path.join(self._path, subdir)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000535 self._box = mailbox.Maildir(self._path)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000536 self._check_basics()
537
538 def _check_basics(self, factory=None):
539 # (Used by test_open_new() and test_open_existing().)
540 self.assertEqual(self._box._path, os.path.abspath(self._path))
541 self.assertEqual(self._box._factory, factory)
542 for subdir in '', 'tmp', 'new', 'cur':
543 path = os.path.join(self._path, subdir)
544 mode = os.stat(path)[stat.ST_MODE]
Georg Brandlab91fde2009-08-13 08:51:18 +0000545 self.assertTrue(stat.S_ISDIR(mode), "Not a directory: '%s'" % path)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000546
547 def test_list_folders(self):
548 # List folders
549 self._box.add_folder('one')
550 self._box.add_folder('two')
551 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000552 self.assertEqual(len(self._box.list_folders()), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000553 self.assertEqual(set(self._box.list_folders()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000554 set(('one', 'two', 'three')))
555
556 def test_get_folder(self):
557 # Open folders
558 self._box.add_folder('foo.bar')
559 folder0 = self._box.get_folder('foo.bar')
560 folder0.add(self._template % 'bar')
Georg Brandlab91fde2009-08-13 08:51:18 +0000561 self.assertTrue(os.path.isdir(os.path.join(self._path, '.foo.bar')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000562 folder1 = self._box.get_folder('foo.bar')
Guido van Rossumea834472007-07-27 05:17:50 +0000563 self.assertEqual(folder1.get_string(folder1.keys()[0]),
564 self._template % 'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000565
566 def test_add_and_remove_folders(self):
567 # Delete folders
568 self._box.add_folder('one')
569 self._box.add_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000570 self.assertEqual(len(self._box.list_folders()), 2)
Georg Brandl194da4a2009-08-13 09:34:05 +0000571 self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000572 self._box.remove_folder('one')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000573 self.assertEqual(len(self._box.list_folders()), 1)
574 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000575 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000576 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000577 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000578 self._box.remove_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000579 self.assertEqual(len(self._box.list_folders()), 1)
580 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000581 self._box.remove_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000582 self.assertEqual(len(self._box.list_folders()), 0)
583 self.assertEqual(self._box.list_folders(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000584
585 def test_clean(self):
586 # Remove old files from 'tmp'
587 foo_path = os.path.join(self._path, 'tmp', 'foo')
588 bar_path = os.path.join(self._path, 'tmp', 'bar')
589 f = open(foo_path, 'w')
590 f.write("@")
591 f.close()
592 f = open(bar_path, 'w')
593 f.write("@")
594 f.close()
595 self._box.clean()
Georg Brandlab91fde2009-08-13 08:51:18 +0000596 self.assertTrue(os.path.exists(foo_path))
597 self.assertTrue(os.path.exists(bar_path))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000598 foo_stat = os.stat(foo_path)
599 os.utime(foo_path, (time.time() - 129600 - 2,
600 foo_stat.st_mtime))
601 self._box.clean()
Georg Brandl194da4a2009-08-13 09:34:05 +0000602 self.assertFalse(os.path.exists(foo_path))
Georg Brandlab91fde2009-08-13 08:51:18 +0000603 self.assertTrue(os.path.exists(bar_path))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000604
605 def test_create_tmp(self, repetitions=10):
606 # Create files in tmp directory
607 hostname = socket.gethostname()
608 if '/' in hostname:
609 hostname = hostname.replace('/', r'\057')
610 if ':' in hostname:
611 hostname = hostname.replace(':', r'\072')
612 pid = os.getpid()
613 pattern = re.compile(r"(?P<time>\d+)\.M(?P<M>\d{1,6})P(?P<P>\d+)"
614 r"Q(?P<Q>\d+)\.(?P<host>[^:/]+)")
615 previous_groups = None
Guido van Rossum805365e2007-05-07 22:24:25 +0000616 for x in range(repetitions):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000617 tmp_file = self._box._create_tmp()
618 head, tail = os.path.split(tmp_file.name)
619 self.assertEqual(head, os.path.abspath(os.path.join(self._path,
620 "tmp")),
621 "File in wrong location: '%s'" % head)
622 match = pattern.match(tail)
Georg Brandl194da4a2009-08-13 09:34:05 +0000623 self.assertIsNot(match, None, "Invalid file name: '%s'" % tail)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000624 groups = match.groups()
Benjamin Peterson2a691a82008-03-31 01:51:45 +0000625 if previous_groups is not None:
Georg Brandlab91fde2009-08-13 08:51:18 +0000626 self.assertTrue(int(groups[0] >= previous_groups[0]),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000627 "Non-monotonic seconds: '%s' before '%s'" %
628 (previous_groups[0], groups[0]))
Georg Brandlab91fde2009-08-13 08:51:18 +0000629 self.assertTrue(int(groups[1] >= previous_groups[1]) or
Thomas Wouters477c8d52006-05-27 19:21:47 +0000630 groups[0] != groups[1],
631 "Non-monotonic milliseconds: '%s' before '%s'" %
632 (previous_groups[1], groups[1]))
Guido van Rossumea834472007-07-27 05:17:50 +0000633 self.assertEqual(int(groups[2]), pid,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000634 "Process ID mismatch: '%s' should be '%s'" %
635 (groups[2], pid))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000636 self.assertEqual(int(groups[3]), int(previous_groups[3]) + 1,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000637 "Non-sequential counter: '%s' before '%s'" %
638 (previous_groups[3], groups[3]))
Guido van Rossumea834472007-07-27 05:17:50 +0000639 self.assertEqual(groups[4], hostname,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000640 "Host name mismatch: '%s' should be '%s'" %
641 (groups[4], hostname))
642 previous_groups = groups
643 tmp_file.write(_sample_message)
644 tmp_file.seek(0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000645 self.assertEqual(tmp_file.read(), _sample_message)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000646 tmp_file.close()
647 file_count = len(os.listdir(os.path.join(self._path, "tmp")))
Guido van Rossumea834472007-07-27 05:17:50 +0000648 self.assertEqual(file_count, repetitions,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000649 "Wrong file count: '%s' should be '%s'" %
650 (file_count, repetitions))
651
652 def test_refresh(self):
653 # Update the table of contents
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000654 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000655 key0 = self._box.add(self._template % 0)
656 key1 = self._box.add(self._template % 1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000657 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000658 self._box._refresh()
Guido van Rossumea834472007-07-27 05:17:50 +0000659 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
660 key1: os.path.join('new', key1)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000661 key2 = self._box.add(self._template % 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000662 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
663 key1: os.path.join('new', key1)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000664 self._box._refresh()
Guido van Rossumea834472007-07-27 05:17:50 +0000665 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
666 key1: os.path.join('new', key1),
667 key2: os.path.join('new', key2)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000668
669 def test_lookup(self):
670 # Look up message subpaths in the TOC
671 self.assertRaises(KeyError, lambda: self._box._lookup('foo'))
672 key0 = self._box.add(self._template % 0)
Guido van Rossumea834472007-07-27 05:17:50 +0000673 self.assertEqual(self._box._lookup(key0), os.path.join('new', key0))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000674 os.remove(os.path.join(self._path, 'new', key0))
Guido van Rossumea834472007-07-27 05:17:50 +0000675 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0)})
Antoine Pitrou868b5782009-11-02 11:40:19 +0000676 # Be sure that the TOC is read back from disk (see issue #6896
677 # about bad mtime behaviour on some systems).
678 self._box.flush()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000679 self.assertRaises(KeyError, lambda: self._box._lookup(key0))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000680 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000681
682 def test_lock_unlock(self):
683 # Lock and unlock the mailbox. For Maildir, this does nothing.
684 self._box.lock()
685 self._box.unlock()
686
Thomas Wouters89f507f2006-12-13 04:49:30 +0000687 def test_folder (self):
688 # Test for bug #1569790: verify that folders returned by .get_folder()
689 # use the same factory function.
690 def dummy_factory (s):
691 return None
692 box = self._factory(self._path, factory=dummy_factory)
693 folder = box.add_folder('folder1')
Georg Brandl194da4a2009-08-13 09:34:05 +0000694 self.assertIs(folder._factory, dummy_factory)
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000695
Thomas Wouters89f507f2006-12-13 04:49:30 +0000696 folder1_alias = box.get_folder('folder1')
Georg Brandl194da4a2009-08-13 09:34:05 +0000697 self.assertIs(folder1_alias._factory, dummy_factory)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000698
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000699 def test_directory_in_folder (self):
700 # Test that mailboxes still work if there's a stray extra directory
701 # in a folder.
702 for i in range(10):
703 self._box.add(mailbox.Message(_sample_message))
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000704
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000705 # Create a stray directory
706 os.mkdir(os.path.join(self._path, 'cur', 'stray-dir'))
707
708 # Check that looping still works with the directory present.
709 for msg in self._box:
710 pass
Thomas Wouters477c8d52006-05-27 19:21:47 +0000711
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000712 def test_file_permissions(self):
713 # Verify that message files are created without execute permissions
714 if not hasattr(os, "stat") or not hasattr(os, "umask"):
715 return
716 msg = mailbox.MaildirMessage(self._template % 0)
717 orig_umask = os.umask(0)
718 try:
719 key = self._box.add(msg)
720 finally:
721 os.umask(orig_umask)
722 path = os.path.join(self._path, self._box._lookup(key))
723 mode = os.stat(path).st_mode
Georg Brandl194da4a2009-08-13 09:34:05 +0000724 self.assertFalse(mode & 0o111)
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000725
726 def test_folder_file_perms(self):
727 # From bug #3228, we want to verify that the file created inside a Maildir
728 # subfolder isn't marked as executable.
729 if not hasattr(os, "stat") or not hasattr(os, "umask"):
730 return
731
732 orig_umask = os.umask(0)
733 try:
734 subfolder = self._box.add_folder('subfolder')
735 finally:
736 os.umask(orig_umask)
737
738 path = os.path.join(subfolder._path, 'maildirfolder')
739 st = os.stat(path)
740 perms = st.st_mode
741 self.assertFalse((perms & 0o111)) # Execute bits should all be off.
742
Andrew M. Kuchlingfa815342009-05-03 02:52:20 +0000743 def test_reread(self):
Andrew M. Kuchlingfa815342009-05-03 02:52:20 +0000744
R David Murraycaed7fe2011-05-06 22:07:19 -0400745 # Put the last modified times more than two seconds into the past
746 # (because mtime may have a two second granularity)
R David Murrayb9a428d2011-03-25 16:03:47 -0400747 for subdir in ('cur', 'new'):
748 os.utime(os.path.join(self._box._path, subdir),
749 (time.time()-5,)*2)
750
R David Murraycaed7fe2011-05-06 22:07:19 -0400751 # Because mtime has a two second granularity in worst case (FAT), a
752 # refresh is done unconditionally if called for within
753 # two-second-plus-a-bit of the last one, just in case the mbox has
754 # changed; so now we have to wait for that interval to expire.
755 time.sleep(2.01 + self._box._skewfactor)
756
R David Murrayb9a428d2011-03-25 16:03:47 -0400757 # Re-reading causes the ._toc attribute to be assigned a new dictionary
758 # object, so we'll check that the ._toc attribute isn't a different
759 # object.
Andrew M. Kuchlingfa815342009-05-03 02:52:20 +0000760 orig_toc = self._box._toc
761 def refreshed():
762 return self._box._toc is not orig_toc
763
Andrew M. Kuchlingfa815342009-05-03 02:52:20 +0000764 self._box._refresh()
R David Murraycaed7fe2011-05-06 22:07:19 -0400765 self.assertFalse(refreshed())
Andrew M. Kuchlingfa815342009-05-03 02:52:20 +0000766
767 # Now, write something into cur and remove it. This changes
768 # the mtime and should cause a re-read.
769 filename = os.path.join(self._path, 'cur', 'stray-file')
770 f = open(filename, 'w')
771 f.close()
772 os.unlink(filename)
773 self._box._refresh()
R David Murraycaed7fe2011-05-06 22:07:19 -0400774 self.assertTrue(refreshed())
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000775
Thomas Wouters477c8d52006-05-27 19:21:47 +0000776class _TestMboxMMDF(TestMailbox):
777
778 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +0000779 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000780 self._delete_recursively(self._path)
781 for lock_remnant in glob.glob(self._path + '.*'):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000782 support.unlink(lock_remnant)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000783
784 def test_add_from_string(self):
785 # Add a string starting with 'From ' to the mailbox
786 key = self._box.add('From foo@bar blah\nFrom: foo\n\n0')
Guido van Rossumea834472007-07-27 05:17:50 +0000787 self.assertEqual(self._box[key].get_from(), 'foo@bar blah')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000788 self.assertEqual(self._box[key].get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000789
790 def test_add_mbox_or_mmdf_message(self):
791 # Add an mboxMessage or MMDFMessage
792 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
793 msg = class_('From foo@bar blah\nFrom: foo\n\n0')
794 key = self._box.add(msg)
795
796 def test_open_close_open(self):
797 # Open and inspect previously-created mailbox
Guido van Rossum805365e2007-05-07 22:24:25 +0000798 values = [self._template % i for i in range(3)]
Thomas Wouters477c8d52006-05-27 19:21:47 +0000799 for value in values:
800 self._box.add(value)
801 self._box.close()
802 mtime = os.path.getmtime(self._path)
803 self._box = self._factory(self._path)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000804 self.assertEqual(len(self._box), 3)
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000805 for key in self._box.keys():
Georg Brandl194da4a2009-08-13 09:34:05 +0000806 self.assertIn(self._box.get_string(key), values)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000807 self._box.close()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000808 self.assertEqual(mtime, os.path.getmtime(self._path))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000809
810 def test_add_and_close(self):
811 # Verifying that closing a mailbox doesn't change added items
812 self._box.add(_sample_message)
Guido van Rossum805365e2007-05-07 22:24:25 +0000813 for i in range(3):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000814 self._box.add(self._template % i)
815 self._box.add(_sample_message)
816 self._box._file.flush()
817 self._box._file.seek(0)
818 contents = self._box._file.read()
819 self._box.close()
Amaury Forgeot d'Arc9edef042008-03-26 19:49:26 +0000820 self.assertEqual(contents, open(self._path, 'r', newline='').read())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000821 self._box = self._factory(self._path)
822
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000823 def test_lock_conflict(self):
824 # Fork off a subprocess that will lock the file for 2 seconds,
825 # unlock it, and then exit.
826 if not hasattr(os, 'fork'):
827 return
828 pid = os.fork()
829 if pid == 0:
830 # In the child, lock the mailbox.
Guido van Rossum62cbc8a2007-04-09 00:41:25 +0000831 try:
832 self._box.lock()
833 time.sleep(2)
834 self._box.unlock()
835 finally:
836 os._exit(0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000837
838 # In the parent, sleep a bit to give the child time to acquire
839 # the lock.
840 time.sleep(0.5)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000841 try:
842 self.assertRaises(mailbox.ExternalClashError,
843 self._box.lock)
844 finally:
845 # Wait for child to exit. Locking should now succeed.
846 exited_pid, status = os.waitpid(pid, 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000847
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000848 self._box.lock()
849 self._box.unlock()
850
Thomas Wouters89f507f2006-12-13 04:49:30 +0000851 def test_relock(self):
852 # Test case for bug #1575506: the mailbox class was locking the
853 # wrong file object in its flush() method.
854 msg = "Subject: sub\n\nbody\n"
855 key1 = self._box.add(msg)
856 self._box.flush()
857 self._box.close()
858
859 self._box = self._factory(self._path)
860 self._box.lock()
861 key2 = self._box.add(msg)
862 self._box.flush()
Georg Brandlab91fde2009-08-13 08:51:18 +0000863 self.assertTrue(self._box._locked)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000864 self._box.close()
865
866
Thomas Wouters477c8d52006-05-27 19:21:47 +0000867class TestMbox(_TestMboxMMDF):
868
869 _factory = lambda self, path, factory=None: mailbox.mbox(path, factory)
870
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000871 def test_file_perms(self):
872 # From bug #3228, we want to verify that the mailbox file isn't executable,
873 # even if the umask is set to something that would leave executable bits set.
874 # We only run this test on platforms that support umask.
875 if hasattr(os, 'umask') and hasattr(os, 'stat'):
876 try:
877 old_umask = os.umask(0o077)
878 self._box.close()
879 os.unlink(self._path)
880 self._box = mailbox.mbox(self._path, create=True)
881 self._box.add('')
882 self._box.close()
883 finally:
884 os.umask(old_umask)
885
886 st = os.stat(self._path)
887 perms = st.st_mode
888 self.assertFalse((perms & 0o111)) # Execute bits should all be off.
Thomas Wouters477c8d52006-05-27 19:21:47 +0000889
890class TestMMDF(_TestMboxMMDF):
891
892 _factory = lambda self, path, factory=None: mailbox.MMDF(path, factory)
893
894
895class TestMH(TestMailbox):
896
897 _factory = lambda self, path, factory=None: mailbox.MH(path, factory)
898
899 def test_list_folders(self):
900 # List folders
901 self._box.add_folder('one')
902 self._box.add_folder('two')
903 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000904 self.assertEqual(len(self._box.list_folders()), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000905 self.assertEqual(set(self._box.list_folders()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000906 set(('one', 'two', 'three')))
907
908 def test_get_folder(self):
909 # Open folders
Thomas Wouters89f507f2006-12-13 04:49:30 +0000910 def dummy_factory (s):
911 return None
912 self._box = self._factory(self._path, dummy_factory)
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000913
Thomas Wouters89f507f2006-12-13 04:49:30 +0000914 new_folder = self._box.add_folder('foo.bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000915 folder0 = self._box.get_folder('foo.bar')
916 folder0.add(self._template % 'bar')
Georg Brandlab91fde2009-08-13 08:51:18 +0000917 self.assertTrue(os.path.isdir(os.path.join(self._path, 'foo.bar')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000918 folder1 = self._box.get_folder('foo.bar')
Guido van Rossumea834472007-07-27 05:17:50 +0000919 self.assertEqual(folder1.get_string(folder1.keys()[0]),
920 self._template % 'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000921
Thomas Wouters89f507f2006-12-13 04:49:30 +0000922 # Test for bug #1569790: verify that folders returned by .get_folder()
923 # use the same factory function.
Georg Brandl194da4a2009-08-13 09:34:05 +0000924 self.assertIs(new_folder._factory, self._box._factory)
925 self.assertIs(folder0._factory, self._box._factory)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000926
Thomas Wouters477c8d52006-05-27 19:21:47 +0000927 def test_add_and_remove_folders(self):
928 # Delete folders
929 self._box.add_folder('one')
930 self._box.add_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000931 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000932 self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000933 self._box.remove_folder('one')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000934 self.assertEqual(len(self._box.list_folders()), 1)
935 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000936 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000937 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000938 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000939 self._box.remove_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000940 self.assertEqual(len(self._box.list_folders()), 1)
941 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000942 self._box.remove_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000943 self.assertEqual(len(self._box.list_folders()), 0)
944 self.assertEqual(self._box.list_folders(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000945
946 def test_sequences(self):
947 # Get and set sequences
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000948 self.assertEqual(self._box.get_sequences(), {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000949 msg0 = mailbox.MHMessage(self._template % 0)
950 msg0.add_sequence('foo')
951 key0 = self._box.add(msg0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000952 self.assertEqual(self._box.get_sequences(), {'foo':[key0]})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000953 msg1 = mailbox.MHMessage(self._template % 1)
954 msg1.set_sequences(['bar', 'replied', 'foo'])
955 key1 = self._box.add(msg1)
Guido van Rossumea834472007-07-27 05:17:50 +0000956 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000957 {'foo':[key0, key1], 'bar':[key1], 'replied':[key1]})
958 msg0.set_sequences(['flagged'])
959 self._box[key0] = msg0
Guido van Rossumea834472007-07-27 05:17:50 +0000960 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000961 {'foo':[key1], 'bar':[key1], 'replied':[key1],
962 'flagged':[key0]})
963 self._box.remove(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000964 self.assertEqual(self._box.get_sequences(), {'flagged':[key0]})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000965
R. David Murray548ac412009-04-02 19:44:43 +0000966 def test_issue2625(self):
967 msg0 = mailbox.MHMessage(self._template % 0)
968 msg0.add_sequence('foo')
969 key0 = self._box.add(msg0)
970 refmsg0 = self._box.get_message(key0)
971
Thomas Wouters477c8d52006-05-27 19:21:47 +0000972 def test_pack(self):
973 # Pack the contents of the mailbox
974 msg0 = mailbox.MHMessage(self._template % 0)
975 msg1 = mailbox.MHMessage(self._template % 1)
976 msg2 = mailbox.MHMessage(self._template % 2)
977 msg3 = mailbox.MHMessage(self._template % 3)
978 msg0.set_sequences(['foo', 'unseen'])
979 msg1.set_sequences(['foo'])
980 msg2.set_sequences(['foo', 'flagged'])
981 msg3.set_sequences(['foo', 'bar', 'replied'])
982 key0 = self._box.add(msg0)
983 key1 = self._box.add(msg1)
984 key2 = self._box.add(msg2)
985 key3 = self._box.add(msg3)
Guido van Rossumea834472007-07-27 05:17:50 +0000986 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000987 {'foo':[key0,key1,key2,key3], 'unseen':[key0],
988 'flagged':[key2], 'bar':[key3], 'replied':[key3]})
989 self._box.remove(key2)
Guido van Rossumea834472007-07-27 05:17:50 +0000990 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000991 {'foo':[key0,key1,key3], 'unseen':[key0], 'bar':[key3],
992 'replied':[key3]})
993 self._box.pack()
Georg Brandl194da4a2009-08-13 09:34:05 +0000994 self.assertEqual(self._box.keys(), [1, 2, 3])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000995 key0 = key0
996 key1 = key0 + 1
997 key2 = key1 + 1
Guido van Rossumea834472007-07-27 05:17:50 +0000998 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000999 {'foo':[1, 2, 3], 'unseen':[1], 'bar':[3], 'replied':[3]})
1000
Thomas Wouters89f507f2006-12-13 04:49:30 +00001001 # Test case for packing while holding the mailbox locked.
1002 key0 = self._box.add(msg1)
1003 key1 = self._box.add(msg1)
1004 key2 = self._box.add(msg1)
1005 key3 = self._box.add(msg1)
1006
1007 self._box.remove(key0)
1008 self._box.remove(key2)
1009 self._box.lock()
1010 self._box.pack()
1011 self._box.unlock()
Guido van Rossumea834472007-07-27 05:17:50 +00001012 self.assertEqual(self._box.get_sequences(),
Thomas Wouters89f507f2006-12-13 04:49:30 +00001013 {'foo':[1, 2, 3, 4, 5],
1014 'unseen':[1], 'bar':[3], 'replied':[3]})
Thomas Wouters9fe394c2007-02-05 01:24:16 +00001015
Thomas Wouters477c8d52006-05-27 19:21:47 +00001016 def _get_lock_path(self):
1017 return os.path.join(self._path, '.mh_sequences.lock')
1018
1019
1020class TestBabyl(TestMailbox):
1021
1022 _factory = lambda self, path, factory=None: mailbox.Babyl(path, factory)
1023
1024 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +00001025 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001026 self._delete_recursively(self._path)
1027 for lock_remnant in glob.glob(self._path + '.*'):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001028 support.unlink(lock_remnant)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001029
1030 def test_labels(self):
1031 # Get labels from the mailbox
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001032 self.assertEqual(self._box.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001033 msg0 = mailbox.BabylMessage(self._template % 0)
1034 msg0.add_label('foo')
1035 key0 = self._box.add(msg0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001036 self.assertEqual(self._box.get_labels(), ['foo'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001037 msg1 = mailbox.BabylMessage(self._template % 1)
1038 msg1.set_labels(['bar', 'answered', 'foo'])
1039 key1 = self._box.add(msg1)
Guido van Rossumea834472007-07-27 05:17:50 +00001040 self.assertEqual(set(self._box.get_labels()), set(['foo', 'bar']))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001041 msg0.set_labels(['blah', 'filed'])
1042 self._box[key0] = msg0
Guido van Rossumea834472007-07-27 05:17:50 +00001043 self.assertEqual(set(self._box.get_labels()),
Thomas Wouters477c8d52006-05-27 19:21:47 +00001044 set(['foo', 'bar', 'blah']))
1045 self._box.remove(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001046 self.assertEqual(set(self._box.get_labels()), set(['blah']))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001047
1048
1049class TestMessage(TestBase):
1050
1051 _factory = mailbox.Message # Overridden by subclasses to reuse tests
1052
1053 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001054 self._path = support.TESTFN
Thomas Wouters477c8d52006-05-27 19:21:47 +00001055
1056 def tearDown(self):
1057 self._delete_recursively(self._path)
1058
1059 def test_initialize_with_eMM(self):
Thomas Woutersb2137042007-02-01 18:02:27 +00001060 # Initialize based on email.message.Message instance
Thomas Wouters477c8d52006-05-27 19:21:47 +00001061 eMM = email.message_from_string(_sample_message)
1062 msg = self._factory(eMM)
1063 self._post_initialize_hook(msg)
1064 self._check_sample(msg)
1065
1066 def test_initialize_with_string(self):
1067 # Initialize based on string
1068 msg = self._factory(_sample_message)
1069 self._post_initialize_hook(msg)
1070 self._check_sample(msg)
1071
1072 def test_initialize_with_file(self):
1073 # Initialize based on contents of file
1074 f = open(self._path, 'w+')
1075 f.write(_sample_message)
1076 f.seek(0)
1077 msg = self._factory(f)
1078 self._post_initialize_hook(msg)
1079 self._check_sample(msg)
1080 f.close()
1081
1082 def test_initialize_with_nothing(self):
1083 # Initialize without arguments
1084 msg = self._factory()
1085 self._post_initialize_hook(msg)
Georg Brandlab91fde2009-08-13 08:51:18 +00001086 self.assertTrue(isinstance(msg, email.message.Message))
1087 self.assertTrue(isinstance(msg, mailbox.Message))
1088 self.assertTrue(isinstance(msg, self._factory))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001089 self.assertEqual(msg.keys(), [])
Georg Brandl194da4a2009-08-13 09:34:05 +00001090 self.assertFalse(msg.is_multipart())
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001091 self.assertEqual(msg.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001092
1093 def test_initialize_incorrectly(self):
1094 # Initialize with invalid argument
1095 self.assertRaises(TypeError, lambda: self._factory(object()))
1096
1097 def test_become_message(self):
1098 # Take on the state of another message
1099 eMM = email.message_from_string(_sample_message)
1100 msg = self._factory()
1101 msg._become_message(eMM)
1102 self._check_sample(msg)
1103
1104 def test_explain_to(self):
1105 # Copy self's format-specific data to other message formats.
1106 # This test is superficial; better ones are in TestMessageConversion.
1107 msg = self._factory()
1108 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1109 mailbox.mboxMessage, mailbox.MHMessage,
1110 mailbox.BabylMessage, mailbox.MMDFMessage):
1111 other_msg = class_()
1112 msg._explain_to(other_msg)
Thomas Woutersb2137042007-02-01 18:02:27 +00001113 other_msg = email.message.Message()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001114 self.assertRaises(TypeError, lambda: msg._explain_to(other_msg))
1115
1116 def _post_initialize_hook(self, msg):
1117 # Overridden by subclasses to check extra things after initialization
1118 pass
1119
1120
1121class TestMaildirMessage(TestMessage):
1122
1123 _factory = mailbox.MaildirMessage
1124
1125 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001126 self.assertEqual(msg._subdir, 'new')
1127 self.assertEqual(msg._info, '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001128
1129 def test_subdir(self):
1130 # Use get_subdir() and set_subdir()
1131 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001132 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001133 msg.set_subdir('cur')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001134 self.assertEqual(msg.get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001135 msg.set_subdir('new')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001136 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001137 self.assertRaises(ValueError, lambda: msg.set_subdir('tmp'))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001138 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001139 msg.set_subdir('new')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001140 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001141 self._check_sample(msg)
1142
1143 def test_flags(self):
1144 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1145 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001146 self.assertEqual(msg.get_flags(), '')
1147 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001148 msg.set_flags('F')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001149 self.assertEqual(msg.get_subdir(), 'new')
1150 self.assertEqual(msg.get_flags(), 'F')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001151 msg.set_flags('SDTP')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001152 self.assertEqual(msg.get_flags(), 'DPST')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001153 msg.add_flag('FT')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001154 self.assertEqual(msg.get_flags(), 'DFPST')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001155 msg.remove_flag('TDRP')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001156 self.assertEqual(msg.get_flags(), 'FS')
1157 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001158 self._check_sample(msg)
1159
1160 def test_date(self):
1161 # Use get_date() and set_date()
1162 msg = mailbox.MaildirMessage(_sample_message)
Georg Brandl194da4a2009-08-13 09:34:05 +00001163 self.assertLess(abs(msg.get_date() - time.time()), 60)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001164 msg.set_date(0.0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001165 self.assertEqual(msg.get_date(), 0.0)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001166
1167 def test_info(self):
1168 # Use get_info() and set_info()
1169 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001170 self.assertEqual(msg.get_info(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001171 msg.set_info('1,foo=bar')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001172 self.assertEqual(msg.get_info(), '1,foo=bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001173 self.assertRaises(TypeError, lambda: msg.set_info(None))
1174 self._check_sample(msg)
1175
1176 def test_info_and_flags(self):
1177 # Test interaction of info and flag methods
1178 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001179 self.assertEqual(msg.get_info(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001180 msg.set_flags('SF')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001181 self.assertEqual(msg.get_flags(), 'FS')
1182 self.assertEqual(msg.get_info(), '2,FS')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001183 msg.set_info('1,')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001184 self.assertEqual(msg.get_flags(), '')
1185 self.assertEqual(msg.get_info(), '1,')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001186 msg.remove_flag('RPT')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001187 self.assertEqual(msg.get_flags(), '')
1188 self.assertEqual(msg.get_info(), '1,')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001189 msg.add_flag('D')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001190 self.assertEqual(msg.get_flags(), 'D')
1191 self.assertEqual(msg.get_info(), '2,D')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001192 self._check_sample(msg)
1193
1194
1195class _TestMboxMMDFMessage(TestMessage):
1196
1197 _factory = mailbox._mboxMMDFMessage
1198
1199 def _post_initialize_hook(self, msg):
1200 self._check_from(msg)
1201
1202 def test_initialize_with_unixfrom(self):
1203 # Initialize with a message that already has a _unixfrom attribute
1204 msg = mailbox.Message(_sample_message)
1205 msg.set_unixfrom('From foo@bar blah')
1206 msg = mailbox.mboxMessage(msg)
Guido van Rossumea834472007-07-27 05:17:50 +00001207 self.assertEqual(msg.get_from(), 'foo@bar blah', msg.get_from())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001208
1209 def test_from(self):
1210 # Get and set "From " line
1211 msg = mailbox.mboxMessage(_sample_message)
1212 self._check_from(msg)
1213 msg.set_from('foo bar')
Guido van Rossumea834472007-07-27 05:17:50 +00001214 self.assertEqual(msg.get_from(), 'foo bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001215 msg.set_from('foo@bar', True)
1216 self._check_from(msg, 'foo@bar')
1217 msg.set_from('blah@temp', time.localtime())
1218 self._check_from(msg, 'blah@temp')
1219
1220 def test_flags(self):
1221 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1222 msg = mailbox.mboxMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001223 self.assertEqual(msg.get_flags(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001224 msg.set_flags('F')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001225 self.assertEqual(msg.get_flags(), 'F')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001226 msg.set_flags('XODR')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001227 self.assertEqual(msg.get_flags(), 'RODX')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001228 msg.add_flag('FA')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001229 self.assertEqual(msg.get_flags(), 'RODFAX')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001230 msg.remove_flag('FDXA')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001231 self.assertEqual(msg.get_flags(), 'RO')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001232 self._check_sample(msg)
1233
1234 def _check_from(self, msg, sender=None):
1235 # Check contents of "From " line
1236 if sender is None:
1237 sender = "MAILER-DAEMON"
Georg Brandlab91fde2009-08-13 08:51:18 +00001238 self.assertTrue(re.match(sender + r" \w{3} \w{3} [\d ]\d [\d ]\d:\d{2}:"
Thomas Wouters477c8d52006-05-27 19:21:47 +00001239 r"\d{2} \d{4}", msg.get_from()) is not None)
1240
1241
1242class TestMboxMessage(_TestMboxMMDFMessage):
1243
1244 _factory = mailbox.mboxMessage
1245
1246
1247class TestMHMessage(TestMessage):
1248
1249 _factory = mailbox.MHMessage
1250
1251 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001252 self.assertEqual(msg._sequences, [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001253
1254 def test_sequences(self):
1255 # Get, set, join, and leave sequences
1256 msg = mailbox.MHMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001257 self.assertEqual(msg.get_sequences(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001258 msg.set_sequences(['foobar'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001259 self.assertEqual(msg.get_sequences(), ['foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001260 msg.set_sequences([])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001261 self.assertEqual(msg.get_sequences(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001262 msg.add_sequence('unseen')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001263 self.assertEqual(msg.get_sequences(), ['unseen'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001264 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001265 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001266 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001267 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001268 msg.remove_sequence('unseen')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001269 self.assertEqual(msg.get_sequences(), ['flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001270 msg.add_sequence('foobar')
Guido van Rossumea834472007-07-27 05:17:50 +00001271 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001272 msg.remove_sequence('replied')
Guido van Rossumea834472007-07-27 05:17:50 +00001273 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001274 msg.set_sequences(['foobar', 'replied'])
Guido van Rossumea834472007-07-27 05:17:50 +00001275 self.assertEqual(msg.get_sequences(), ['foobar', 'replied'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001276
1277
1278class TestBabylMessage(TestMessage):
1279
1280 _factory = mailbox.BabylMessage
1281
1282 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001283 self.assertEqual(msg._labels, [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001284
1285 def test_labels(self):
1286 # Get, set, join, and leave labels
1287 msg = mailbox.BabylMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001288 self.assertEqual(msg.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001289 msg.set_labels(['foobar'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001290 self.assertEqual(msg.get_labels(), ['foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001291 msg.set_labels([])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001292 self.assertEqual(msg.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001293 msg.add_label('filed')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001294 self.assertEqual(msg.get_labels(), ['filed'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001295 msg.add_label('resent')
Guido van Rossumea834472007-07-27 05:17:50 +00001296 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001297 msg.add_label('resent')
Guido van Rossumea834472007-07-27 05:17:50 +00001298 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001299 msg.remove_label('filed')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001300 self.assertEqual(msg.get_labels(), ['resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001301 msg.add_label('foobar')
Guido van Rossumea834472007-07-27 05:17:50 +00001302 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001303 msg.remove_label('unseen')
Guido van Rossumea834472007-07-27 05:17:50 +00001304 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001305 msg.set_labels(['foobar', 'answered'])
Guido van Rossumea834472007-07-27 05:17:50 +00001306 self.assertEqual(msg.get_labels(), ['foobar', 'answered'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001307
1308 def test_visible(self):
1309 # Get, set, and update visible headers
1310 msg = mailbox.BabylMessage(_sample_message)
1311 visible = msg.get_visible()
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001312 self.assertEqual(visible.keys(), [])
Georg Brandl194da4a2009-08-13 09:34:05 +00001313 self.assertIs(visible.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001314 visible['User-Agent'] = 'FooBar 1.0'
1315 visible['X-Whatever'] = 'Blah'
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001316 self.assertEqual(msg.get_visible().keys(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001317 msg.set_visible(visible)
1318 visible = msg.get_visible()
Georg Brandlab91fde2009-08-13 08:51:18 +00001319 self.assertTrue(visible.keys() == ['User-Agent', 'X-Whatever'])
1320 self.assertTrue(visible['User-Agent'] == 'FooBar 1.0')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001321 self.assertEqual(visible['X-Whatever'], 'Blah')
Georg Brandl194da4a2009-08-13 09:34:05 +00001322 self.assertIs(visible.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001323 msg.update_visible()
Guido van Rossumea834472007-07-27 05:17:50 +00001324 self.assertEqual(visible.keys(), ['User-Agent', 'X-Whatever'])
Georg Brandl194da4a2009-08-13 09:34:05 +00001325 self.assertIs(visible.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001326 visible = msg.get_visible()
Guido van Rossumea834472007-07-27 05:17:50 +00001327 self.assertEqual(visible.keys(), ['User-Agent', 'Date', 'From', 'To',
1328 'Subject'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001329 for header in ('User-Agent', 'Date', 'From', 'To', 'Subject'):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001330 self.assertEqual(visible[header], msg[header])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001331
1332
1333class TestMMDFMessage(_TestMboxMMDFMessage):
1334
1335 _factory = mailbox.MMDFMessage
1336
1337
1338class TestMessageConversion(TestBase):
1339
1340 def test_plain_to_x(self):
1341 # Convert Message to all formats
1342 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1343 mailbox.mboxMessage, mailbox.MHMessage,
1344 mailbox.BabylMessage, mailbox.MMDFMessage):
1345 msg_plain = mailbox.Message(_sample_message)
1346 msg = class_(msg_plain)
1347 self._check_sample(msg)
1348
1349 def test_x_to_plain(self):
1350 # Convert all formats to Message
1351 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1352 mailbox.mboxMessage, mailbox.MHMessage,
1353 mailbox.BabylMessage, mailbox.MMDFMessage):
1354 msg = class_(_sample_message)
1355 msg_plain = mailbox.Message(msg)
1356 self._check_sample(msg_plain)
1357
1358 def test_x_to_invalid(self):
1359 # Convert all formats to an invalid format
1360 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1361 mailbox.mboxMessage, mailbox.MHMessage,
1362 mailbox.BabylMessage, mailbox.MMDFMessage):
1363 self.assertRaises(TypeError, lambda: class_(False))
1364
1365 def test_maildir_to_maildir(self):
1366 # Convert MaildirMessage to MaildirMessage
1367 msg_maildir = mailbox.MaildirMessage(_sample_message)
1368 msg_maildir.set_flags('DFPRST')
1369 msg_maildir.set_subdir('cur')
1370 date = msg_maildir.get_date()
1371 msg = mailbox.MaildirMessage(msg_maildir)
1372 self._check_sample(msg)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001373 self.assertEqual(msg.get_flags(), 'DFPRST')
1374 self.assertEqual(msg.get_subdir(), 'cur')
1375 self.assertEqual(msg.get_date(), date)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001376
1377 def test_maildir_to_mboxmmdf(self):
1378 # Convert MaildirMessage to mboxmessage and MMDFMessage
1379 pairs = (('D', ''), ('F', 'F'), ('P', ''), ('R', 'A'), ('S', 'R'),
1380 ('T', 'D'), ('DFPRST', 'RDFA'))
1381 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1382 msg_maildir = mailbox.MaildirMessage(_sample_message)
1383 msg_maildir.set_date(0.0)
1384 for setting, result in pairs:
1385 msg_maildir.set_flags(setting)
1386 msg = class_(msg_maildir)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001387 self.assertEqual(msg.get_flags(), result)
Guido van Rossumea834472007-07-27 05:17:50 +00001388 self.assertEqual(msg.get_from(), 'MAILER-DAEMON %s' %
Thomas Wouters477c8d52006-05-27 19:21:47 +00001389 time.asctime(time.gmtime(0.0)))
1390 msg_maildir.set_subdir('cur')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001391 self.assertEqual(class_(msg_maildir).get_flags(), 'RODFA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001392
1393 def test_maildir_to_mh(self):
1394 # Convert MaildirMessage to MHMessage
1395 msg_maildir = mailbox.MaildirMessage(_sample_message)
1396 pairs = (('D', ['unseen']), ('F', ['unseen', 'flagged']),
1397 ('P', ['unseen']), ('R', ['unseen', 'replied']), ('S', []),
1398 ('T', ['unseen']), ('DFPRST', ['replied', 'flagged']))
1399 for setting, result in pairs:
1400 msg_maildir.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001401 self.assertEqual(mailbox.MHMessage(msg_maildir).get_sequences(),
1402 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001403
1404 def test_maildir_to_babyl(self):
1405 # Convert MaildirMessage to Babyl
1406 msg_maildir = mailbox.MaildirMessage(_sample_message)
1407 pairs = (('D', ['unseen']), ('F', ['unseen']),
1408 ('P', ['unseen', 'forwarded']), ('R', ['unseen', 'answered']),
1409 ('S', []), ('T', ['unseen', 'deleted']),
1410 ('DFPRST', ['deleted', 'answered', 'forwarded']))
1411 for setting, result in pairs:
1412 msg_maildir.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001413 self.assertEqual(mailbox.BabylMessage(msg_maildir).get_labels(),
1414 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001415
1416 def test_mboxmmdf_to_maildir(self):
1417 # Convert mboxMessage and MMDFMessage to MaildirMessage
1418 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1419 msg_mboxMMDF = class_(_sample_message)
1420 msg_mboxMMDF.set_from('foo@bar', time.gmtime(0.0))
1421 pairs = (('R', 'S'), ('O', ''), ('D', 'T'), ('F', 'F'), ('A', 'R'),
1422 ('RODFA', 'FRST'))
1423 for setting, result in pairs:
1424 msg_mboxMMDF.set_flags(setting)
1425 msg = mailbox.MaildirMessage(msg_mboxMMDF)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001426 self.assertEqual(msg.get_flags(), result)
Georg Brandl194da4a2009-08-13 09:34:05 +00001427 self.assertEqual(msg.get_date(), 0.0)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001428 msg_mboxMMDF.set_flags('O')
Guido van Rossumea834472007-07-27 05:17:50 +00001429 self.assertEqual(mailbox.MaildirMessage(msg_mboxMMDF).get_subdir(),
1430 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001431
1432 def test_mboxmmdf_to_mboxmmdf(self):
1433 # Convert mboxMessage and MMDFMessage to mboxMessage and MMDFMessage
1434 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1435 msg_mboxMMDF = class_(_sample_message)
1436 msg_mboxMMDF.set_flags('RODFA')
1437 msg_mboxMMDF.set_from('foo@bar')
1438 for class2_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1439 msg2 = class2_(msg_mboxMMDF)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001440 self.assertEqual(msg2.get_flags(), 'RODFA')
1441 self.assertEqual(msg2.get_from(), 'foo@bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001442
1443 def test_mboxmmdf_to_mh(self):
1444 # Convert mboxMessage and MMDFMessage to MHMessage
1445 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1446 msg_mboxMMDF = class_(_sample_message)
1447 pairs = (('R', []), ('O', ['unseen']), ('D', ['unseen']),
1448 ('F', ['unseen', 'flagged']),
1449 ('A', ['unseen', 'replied']),
1450 ('RODFA', ['replied', 'flagged']))
1451 for setting, result in pairs:
1452 msg_mboxMMDF.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001453 self.assertEqual(mailbox.MHMessage(msg_mboxMMDF).get_sequences(),
1454 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001455
1456 def test_mboxmmdf_to_babyl(self):
1457 # Convert mboxMessage and MMDFMessage to BabylMessage
1458 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1459 msg = class_(_sample_message)
1460 pairs = (('R', []), ('O', ['unseen']),
1461 ('D', ['unseen', 'deleted']), ('F', ['unseen']),
1462 ('A', ['unseen', 'answered']),
1463 ('RODFA', ['deleted', 'answered']))
1464 for setting, result in pairs:
1465 msg.set_flags(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001466 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001467
1468 def test_mh_to_maildir(self):
1469 # Convert MHMessage to MaildirMessage
1470 pairs = (('unseen', ''), ('replied', 'RS'), ('flagged', 'FS'))
1471 for setting, result in pairs:
1472 msg = mailbox.MHMessage(_sample_message)
1473 msg.add_sequence(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001474 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1475 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001476 msg = mailbox.MHMessage(_sample_message)
1477 msg.add_sequence('unseen')
1478 msg.add_sequence('replied')
1479 msg.add_sequence('flagged')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001480 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'FR')
1481 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001482
1483 def test_mh_to_mboxmmdf(self):
1484 # Convert MHMessage to mboxMessage and MMDFMessage
1485 pairs = (('unseen', 'O'), ('replied', 'ROA'), ('flagged', 'ROF'))
1486 for setting, result in pairs:
1487 msg = mailbox.MHMessage(_sample_message)
1488 msg.add_sequence(setting)
1489 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001490 self.assertEqual(class_(msg).get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001491 msg = mailbox.MHMessage(_sample_message)
1492 msg.add_sequence('unseen')
1493 msg.add_sequence('replied')
1494 msg.add_sequence('flagged')
1495 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001496 self.assertEqual(class_(msg).get_flags(), 'OFA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001497
1498 def test_mh_to_mh(self):
1499 # Convert MHMessage to MHMessage
1500 msg = mailbox.MHMessage(_sample_message)
1501 msg.add_sequence('unseen')
1502 msg.add_sequence('replied')
1503 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001504 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1505 ['unseen', 'replied', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001506
1507 def test_mh_to_babyl(self):
1508 # Convert MHMessage to BabylMessage
1509 pairs = (('unseen', ['unseen']), ('replied', ['answered']),
1510 ('flagged', []))
1511 for setting, result in pairs:
1512 msg = mailbox.MHMessage(_sample_message)
1513 msg.add_sequence(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001514 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001515 msg = mailbox.MHMessage(_sample_message)
1516 msg.add_sequence('unseen')
1517 msg.add_sequence('replied')
1518 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001519 self.assertEqual(mailbox.BabylMessage(msg).get_labels(),
1520 ['unseen', 'answered'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001521
1522 def test_babyl_to_maildir(self):
1523 # Convert BabylMessage to MaildirMessage
1524 pairs = (('unseen', ''), ('deleted', 'ST'), ('filed', 'S'),
1525 ('answered', 'RS'), ('forwarded', 'PS'), ('edited', 'S'),
1526 ('resent', 'PS'))
1527 for setting, result in pairs:
1528 msg = mailbox.BabylMessage(_sample_message)
1529 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001530 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1531 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001532 msg = mailbox.BabylMessage(_sample_message)
1533 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1534 'edited', 'resent'):
1535 msg.add_label(label)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001536 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'PRT')
1537 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001538
1539 def test_babyl_to_mboxmmdf(self):
1540 # Convert BabylMessage to mboxMessage and MMDFMessage
1541 pairs = (('unseen', 'O'), ('deleted', 'ROD'), ('filed', 'RO'),
1542 ('answered', 'ROA'), ('forwarded', 'RO'), ('edited', 'RO'),
1543 ('resent', 'RO'))
1544 for setting, result in pairs:
1545 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1546 msg = mailbox.BabylMessage(_sample_message)
1547 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001548 self.assertEqual(class_(msg).get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001549 msg = mailbox.BabylMessage(_sample_message)
1550 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1551 'edited', 'resent'):
1552 msg.add_label(label)
1553 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001554 self.assertEqual(class_(msg).get_flags(), 'ODA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001555
1556 def test_babyl_to_mh(self):
1557 # Convert BabylMessage to MHMessage
1558 pairs = (('unseen', ['unseen']), ('deleted', []), ('filed', []),
1559 ('answered', ['replied']), ('forwarded', []), ('edited', []),
1560 ('resent', []))
1561 for setting, result in pairs:
1562 msg = mailbox.BabylMessage(_sample_message)
1563 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001564 self.assertEqual(mailbox.MHMessage(msg).get_sequences(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001565 msg = mailbox.BabylMessage(_sample_message)
1566 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1567 'edited', 'resent'):
1568 msg.add_label(label)
Guido van Rossumea834472007-07-27 05:17:50 +00001569 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1570 ['unseen', 'replied'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001571
1572 def test_babyl_to_babyl(self):
1573 # Convert BabylMessage to BabylMessage
1574 msg = mailbox.BabylMessage(_sample_message)
1575 msg.update_visible()
1576 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1577 'edited', 'resent'):
1578 msg.add_label(label)
1579 msg2 = mailbox.BabylMessage(msg)
Guido van Rossumea834472007-07-27 05:17:50 +00001580 self.assertEqual(msg2.get_labels(), ['unseen', 'deleted', 'filed',
1581 'answered', 'forwarded', 'edited',
1582 'resent'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001583 self.assertEqual(msg.get_visible().keys(), msg2.get_visible().keys())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001584 for key in msg.get_visible().keys():
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001585 self.assertEqual(msg.get_visible()[key], msg2.get_visible()[key])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001586
1587
1588class TestProxyFileBase(TestBase):
1589
1590 def _test_read(self, proxy):
1591 # Read by byte
1592 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001593 self.assertEqual(proxy.read(), b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001594 proxy.seek(1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001595 self.assertEqual(proxy.read(), b'ar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001596 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001597 self.assertEqual(proxy.read(2), b'ba')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001598 proxy.seek(1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001599 self.assertEqual(proxy.read(-1), b'ar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001600 proxy.seek(2)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001601 self.assertEqual(proxy.read(1000), b'r')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001602
1603 def _test_readline(self, proxy):
1604 # Read by line
Guido van Rossum98297ee2007-11-06 21:34:58 +00001605 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001606 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001607 self.assertEqual(proxy.readline(), b'foo' + linesep)
1608 self.assertEqual(proxy.readline(), b'bar' + linesep)
1609 self.assertEqual(proxy.readline(), b'fred' + linesep)
1610 self.assertEqual(proxy.readline(), b'bob')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001611 proxy.seek(2)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001612 self.assertEqual(proxy.readline(), b'o' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001613 proxy.seek(6 + 2 * len(os.linesep))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001614 self.assertEqual(proxy.readline(), b'fred' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001615 proxy.seek(6 + 2 * len(os.linesep))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001616 self.assertEqual(proxy.readline(2), b'fr')
1617 self.assertEqual(proxy.readline(-10), b'ed' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001618
1619 def _test_readlines(self, proxy):
1620 # Read multiple lines
Guido van Rossum98297ee2007-11-06 21:34:58 +00001621 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001622 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001623 self.assertEqual(proxy.readlines(), [b'foo' + linesep,
1624 b'bar' + linesep,
1625 b'fred' + linesep, b'bob'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001626 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001627 self.assertEqual(proxy.readlines(2), [b'foo' + linesep])
1628 proxy.seek(3 + len(linesep))
1629 self.assertEqual(proxy.readlines(4 + len(linesep)),
1630 [b'bar' + linesep, b'fred' + linesep])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001631 proxy.seek(3)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001632 self.assertEqual(proxy.readlines(1000), [linesep, b'bar' + linesep,
1633 b'fred' + linesep, b'bob'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001634
1635 def _test_iteration(self, proxy):
1636 # Iterate by line
Guido van Rossum98297ee2007-11-06 21:34:58 +00001637 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001638 proxy.seek(0)
1639 iterator = iter(proxy)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001640 self.assertEqual(next(iterator), b'foo' + linesep)
1641 self.assertEqual(next(iterator), b'bar' + linesep)
1642 self.assertEqual(next(iterator), b'fred' + linesep)
1643 self.assertEqual(next(iterator), b'bob')
Georg Brandla18af4e2007-04-21 15:47:16 +00001644 self.assertRaises(StopIteration, next, iterator)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001645
1646 def _test_seek_and_tell(self, proxy):
1647 # Seek and use tell to check position
Guido van Rossum98297ee2007-11-06 21:34:58 +00001648 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001649 proxy.seek(3)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001650 self.assertEqual(proxy.tell(), 3)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001651 self.assertEqual(proxy.read(len(linesep)), linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001652 proxy.seek(2, 1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001653 self.assertEqual(proxy.read(1 + len(linesep)), b'r' + linesep)
1654 proxy.seek(-3 - len(linesep), 2)
1655 self.assertEqual(proxy.read(3), b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001656 proxy.seek(2, 0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001657 self.assertEqual(proxy.read(), b'o' + linesep + b'bar' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001658 proxy.seek(100)
Georg Brandlab91fde2009-08-13 08:51:18 +00001659 self.assertFalse(proxy.read())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001660
1661 def _test_close(self, proxy):
1662 # Close a file
1663 proxy.close()
1664 self.assertRaises(AttributeError, lambda: proxy.close())
1665
1666
1667class TestProxyFile(TestProxyFileBase):
1668
1669 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001670 self._path = support.TESTFN
Thomas Wouters477c8d52006-05-27 19:21:47 +00001671 self._file = open(self._path, 'wb+')
1672
1673 def tearDown(self):
1674 self._file.close()
1675 self._delete_recursively(self._path)
1676
1677 def test_initialize(self):
1678 # Initialize and check position
Neal Norwitz9a923102007-08-30 06:20:05 +00001679 self._file.write(b'foo')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001680 pos = self._file.tell()
1681 proxy0 = mailbox._ProxyFile(self._file)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001682 self.assertEqual(proxy0.tell(), pos)
1683 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001684 proxy1 = mailbox._ProxyFile(self._file, 0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001685 self.assertEqual(proxy1.tell(), 0)
1686 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001687
1688 def test_read(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001689 self._file.write(b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001690 self._test_read(mailbox._ProxyFile(self._file))
1691
1692 def test_readline(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001693 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1694 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001695 self._test_readline(mailbox._ProxyFile(self._file))
1696
1697 def test_readlines(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001698 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1699 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001700 self._test_readlines(mailbox._ProxyFile(self._file))
1701
1702 def test_iteration(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001703 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1704 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001705 self._test_iteration(mailbox._ProxyFile(self._file))
1706
1707 def test_seek_and_tell(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001708 self._file.write(bytes('foo%sbar%s' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001709 self._test_seek_and_tell(mailbox._ProxyFile(self._file))
1710
1711 def test_close(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001712 self._file.write(bytes('foo%sbar%s' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001713 self._test_close(mailbox._ProxyFile(self._file))
1714
1715
1716class TestPartialFile(TestProxyFileBase):
1717
1718 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001719 self._path = support.TESTFN
Thomas Wouters477c8d52006-05-27 19:21:47 +00001720 self._file = open(self._path, 'wb+')
1721
1722 def tearDown(self):
1723 self._file.close()
1724 self._delete_recursively(self._path)
1725
1726 def test_initialize(self):
1727 # Initialize and check position
Neal Norwitz9a923102007-08-30 06:20:05 +00001728 self._file.write(bytes('foo' + os.linesep + 'bar', 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001729 pos = self._file.tell()
1730 proxy = mailbox._PartialFile(self._file, 2, 5)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001731 self.assertEqual(proxy.tell(), 0)
1732 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001733
1734 def test_read(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001735 self._file.write(bytes('***bar***', 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001736 self._test_read(mailbox._PartialFile(self._file, 3, 6))
1737
1738 def test_readline(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001739 self._file.write(bytes('!!!!!foo%sbar%sfred%sbob!!!!!' %
1740 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001741 self._test_readline(mailbox._PartialFile(self._file, 5,
1742 18 + 3 * len(os.linesep)))
1743
1744 def test_readlines(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001745 self._file.write(bytes('foo%sbar%sfred%sbob?????' %
1746 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001747 self._test_readlines(mailbox._PartialFile(self._file, 0,
1748 13 + 3 * len(os.linesep)))
1749
1750 def test_iteration(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001751 self._file.write(bytes('____foo%sbar%sfred%sbob####' %
1752 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001753 self._test_iteration(mailbox._PartialFile(self._file, 4,
1754 17 + 3 * len(os.linesep)))
1755
1756 def test_seek_and_tell(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001757 self._file.write(bytes('(((foo%sbar%s$$$' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001758 self._test_seek_and_tell(mailbox._PartialFile(self._file, 3,
1759 9 + 2 * len(os.linesep)))
1760
1761 def test_close(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001762 self._file.write(bytes('&foo%sbar%s^' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001763 self._test_close(mailbox._PartialFile(self._file, 1,
1764 6 + 3 * len(os.linesep)))
1765
1766
1767## Start: tests from the original module (for backward compatibility).
1768
Skip Montanaro5253da12004-07-24 19:56:03 +00001769FROM_ = "From some.body@dummy.domain Sat Jul 24 13:43:35 2004\n"
Fred Drakec02bc3e2001-05-21 20:23:21 +00001770DUMMY_MESSAGE = """\
1771From: some.body@dummy.domain
1772To: me@my.domain
Skip Montanaro5253da12004-07-24 19:56:03 +00001773Subject: Simple Test
Fred Drakec02bc3e2001-05-21 20:23:21 +00001774
1775This is a dummy message.
1776"""
1777
Fred Drakec02bc3e2001-05-21 20:23:21 +00001778class MaildirTestCase(unittest.TestCase):
1779
1780 def setUp(self):
1781 # create a new maildir mailbox to work with:
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001782 self._dir = support.TESTFN
Fred Drakec02bc3e2001-05-21 20:23:21 +00001783 os.mkdir(self._dir)
1784 os.mkdir(os.path.join(self._dir, "cur"))
1785 os.mkdir(os.path.join(self._dir, "tmp"))
1786 os.mkdir(os.path.join(self._dir, "new"))
1787 self._counter = 1
1788 self._msgfiles = []
1789
1790 def tearDown(self):
Guido van Rossumc1f779c2007-07-03 08:25:58 +00001791 list(map(os.unlink, self._msgfiles))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001792 os.rmdir(os.path.join(self._dir, "cur"))
1793 os.rmdir(os.path.join(self._dir, "tmp"))
1794 os.rmdir(os.path.join(self._dir, "new"))
1795 os.rmdir(self._dir)
1796
Skip Montanaro5253da12004-07-24 19:56:03 +00001797 def createMessage(self, dir, mbox=False):
Jack Jansen97df7b62001-06-19 20:20:05 +00001798 t = int(time.time() % 1000000)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001799 pid = self._counter
1800 self._counter += 1
Skip Montanaro7a98be22007-08-16 14:35:24 +00001801 filename = ".".join((str(t), str(pid), "myhostname", "mydomain"))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001802 tmpname = os.path.join(self._dir, "tmp", filename)
1803 newname = os.path.join(self._dir, dir, filename)
1804 fp = open(tmpname, "w")
1805 self._msgfiles.append(tmpname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001806 if mbox:
1807 fp.write(FROM_)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001808 fp.write(DUMMY_MESSAGE)
1809 fp.close()
Tim Peters6626c1f2001-05-22 16:29:01 +00001810 if hasattr(os, "link"):
1811 os.link(tmpname, newname)
1812 else:
1813 fp = open(newname, "w")
1814 fp.write(DUMMY_MESSAGE)
1815 fp.close()
Fred Drakec02bc3e2001-05-21 20:23:21 +00001816 self._msgfiles.append(newname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001817 return tmpname
Fred Drakec02bc3e2001-05-21 20:23:21 +00001818
1819 def test_empty_maildir(self):
1820 """Test an empty maildir mailbox"""
1821 # Test for regression on bug #117490:
1822 # Make sure the boxes attribute actually gets set.
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001823 self.mbox = mailbox.Maildir(support.TESTFN)
Georg Brandlab91fde2009-08-13 08:51:18 +00001824 #self.assertTrue(hasattr(self.mbox, "boxes"))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001825 #self.assertEqual(len(self.mbox.boxes), 0)
Georg Brandl194da4a2009-08-13 09:34:05 +00001826 self.assertIs(self.mbox.next(), None)
1827 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001828
1829 def test_nonempty_maildir_cur(self):
1830 self.createMessage("cur")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001831 self.mbox = mailbox.Maildir(support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001832 #self.assertEqual(len(self.mbox.boxes), 1)
Georg Brandl194da4a2009-08-13 09:34:05 +00001833 self.assertIsNot(self.mbox.next(), None)
1834 self.assertIs(self.mbox.next(), None)
1835 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001836
1837 def test_nonempty_maildir_new(self):
1838 self.createMessage("new")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001839 self.mbox = mailbox.Maildir(support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001840 #self.assertEqual(len(self.mbox.boxes), 1)
Georg Brandl194da4a2009-08-13 09:34:05 +00001841 self.assertIsNot(self.mbox.next(), None)
1842 self.assertIs(self.mbox.next(), None)
1843 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001844
1845 def test_nonempty_maildir_both(self):
1846 self.createMessage("cur")
1847 self.createMessage("new")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001848 self.mbox = mailbox.Maildir(support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001849 #self.assertEqual(len(self.mbox.boxes), 2)
Georg Brandl194da4a2009-08-13 09:34:05 +00001850 self.assertIsNot(self.mbox.next(), None)
1851 self.assertIsNot(self.mbox.next(), None)
1852 self.assertIs(self.mbox.next(), None)
1853 self.assertIs(self.mbox.next(), None)
Fred Drake0aaed272000-10-23 13:39:15 +00001854
Georg Brandledb978f2008-05-11 08:59:40 +00001855## End: tests from the original module (for backward compatibility).
Thomas Wouters477c8d52006-05-27 19:21:47 +00001856
1857
1858_sample_message = """\
1859Return-Path: <gkj@gregorykjohnson.com>
1860X-Original-To: gkj+person@localhost
1861Delivered-To: gkj+person@localhost
1862Received: from localhost (localhost [127.0.0.1])
1863 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1864 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
1865Delivered-To: gkj@sundance.gregorykjohnson.com
1866Received: from localhost [127.0.0.1]
1867 by localhost with POP3 (fetchmail-6.2.5)
1868 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
1869Received: from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
1870 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1871 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
1872Received: by andy.gregorykjohnson.com (Postfix, from userid 1000)
1873 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
1874Date: Wed, 13 Jul 2005 17:23:11 -0400
1875From: "Gregory K. Johnson" <gkj@gregorykjohnson.com>
1876To: gkj@gregorykjohnson.com
1877Subject: Sample message
1878Message-ID: <20050713212311.GC4701@andy.gregorykjohnson.com>
1879Mime-Version: 1.0
1880Content-Type: multipart/mixed; boundary="NMuMz9nt05w80d4+"
1881Content-Disposition: inline
1882User-Agent: Mutt/1.5.9i
1883
1884
1885--NMuMz9nt05w80d4+
1886Content-Type: text/plain; charset=us-ascii
1887Content-Disposition: inline
1888
1889This is a sample message.
1890
1891--
1892Gregory K. Johnson
1893
1894--NMuMz9nt05w80d4+
1895Content-Type: application/octet-stream
1896Content-Disposition: attachment; filename="text.gz"
1897Content-Transfer-Encoding: base64
1898
1899H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
19003FYlAAAA
1901
1902--NMuMz9nt05w80d4+--
1903"""
1904
1905_sample_headers = {
1906 "Return-Path":"<gkj@gregorykjohnson.com>",
1907 "X-Original-To":"gkj+person@localhost",
1908 "Delivered-To":"gkj+person@localhost",
1909 "Received":"""from localhost (localhost [127.0.0.1])
1910 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1911 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
1912 "Delivered-To":"gkj@sundance.gregorykjohnson.com",
1913 "Received":"""from localhost [127.0.0.1]
1914 by localhost with POP3 (fetchmail-6.2.5)
1915 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
1916 "Received":"""from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
1917 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1918 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
1919 "Received":"""by andy.gregorykjohnson.com (Postfix, from userid 1000)
1920 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
1921 "Date":"Wed, 13 Jul 2005 17:23:11 -0400",
1922 "From":""""Gregory K. Johnson" <gkj@gregorykjohnson.com>""",
1923 "To":"gkj@gregorykjohnson.com",
1924 "Subject":"Sample message",
1925 "Mime-Version":"1.0",
1926 "Content-Type":"""multipart/mixed; boundary="NMuMz9nt05w80d4+\"""",
1927 "Content-Disposition":"inline",
1928 "User-Agent": "Mutt/1.5.9i" }
1929
1930_sample_payloads = ("""This is a sample message.
1931
1932--
1933Gregory K. Johnson
1934""",
1935"""H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
19363FYlAAAA
1937""")
Fred Drake0aaed272000-10-23 13:39:15 +00001938
Fred Drakec02bc3e2001-05-21 20:23:21 +00001939
Fred Drake2e2be372001-09-20 21:33:42 +00001940def test_main():
Thomas Wouters477c8d52006-05-27 19:21:47 +00001941 tests = (TestMailboxSuperclass, TestMaildir, TestMbox, TestMMDF, TestMH,
1942 TestBabyl, TestMessage, TestMaildirMessage, TestMboxMessage,
1943 TestMHMessage, TestBabylMessage, TestMMDFMessage,
1944 TestMessageConversion, TestProxyFile, TestPartialFile,
1945 MaildirTestCase)
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001946 support.run_unittest(*tests)
1947 support.reap_children()
Fred Drake2e2be372001-09-20 21:33:42 +00001948
1949
Thomas Wouters477c8d52006-05-27 19:21:47 +00001950if __name__ == '__main__':
Fred Drake2e2be372001-09-20 21:33:42 +00001951 test_main()