blob: 69e70ed82b3cc28039c57b8b39b0ace757f69b9e [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
Ezio Melottie9615932010-01-24 19:26:24 +000024 self.assertIsInstance(msg, email.message.Message)
25 self.assertIsInstance(msg, mailbox.Message)
Guido van Rossumcc2b0162007-02-11 06:12:03 +000026 for key, value in _sample_headers.items():
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +000027 self.assertIn(value, msg.get_all(key))
Benjamin Petersonc9c0f202009-06-30 23:06:06 +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)
Ezio Melottie9615932010-01-24 19:26:24 +000032 self.assertIsInstance(part, email.message.Message)
33 self.assertNotIsInstance(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)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +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)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +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')
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +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)
Ezio Melottie9615932010-01-24 19:26:24 +0000152 self.assertIsInstance(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')
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +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__()
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000235 self.assertNotIn('foo', self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000236 key0 = self._box.add(self._template % 0)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +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)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +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)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +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)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +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):
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +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)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000306 self.assertIn(key0, self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000307 key1 = self._box.add(self._template % 1)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000308 self.assertIn(key1, self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000309 self.assertEqual(self._box.pop(key0).get_payload(), '0')
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +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)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000313 self.assertIn(key2, self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000314 self.assertEqual(self._box.pop(key2).get_payload(), '2')
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +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')
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +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()
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +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
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000377 self.assertFalse(os.path.exists(self._get_lock_path()))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000378 self._box.lock()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000379 self.assertTrue(os.path.exists(self._get_lock_path()))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000380 self._box.unlock()
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +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:
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +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)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +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)
Ezio Melottie9615932010-01-24 19:26:24 +0000479 self.assertIsInstance(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)
Ezio Melottie9615932010-01-24 19:26:24 +0000519 self.assertIsInstance(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]
Benjamin Petersonc9c0f202009-06-30 23:06:06 +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')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +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)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +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')
Brian Curtin5acec042010-10-13 02:29:46 +0000589 with open(foo_path, 'w') as f:
590 f.write("@")
591 with open(bar_path, 'w') as f:
592 f.write("@")
Thomas Wouters477c8d52006-05-27 19:21:47 +0000593 self._box.clean()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000594 self.assertTrue(os.path.exists(foo_path))
595 self.assertTrue(os.path.exists(bar_path))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000596 foo_stat = os.stat(foo_path)
597 os.utime(foo_path, (time.time() - 129600 - 2,
598 foo_stat.st_mtime))
599 self._box.clean()
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000600 self.assertFalse(os.path.exists(foo_path))
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000601 self.assertTrue(os.path.exists(bar_path))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000602
603 def test_create_tmp(self, repetitions=10):
604 # Create files in tmp directory
605 hostname = socket.gethostname()
606 if '/' in hostname:
607 hostname = hostname.replace('/', r'\057')
608 if ':' in hostname:
609 hostname = hostname.replace(':', r'\072')
610 pid = os.getpid()
611 pattern = re.compile(r"(?P<time>\d+)\.M(?P<M>\d{1,6})P(?P<P>\d+)"
612 r"Q(?P<Q>\d+)\.(?P<host>[^:/]+)")
613 previous_groups = None
Guido van Rossum805365e2007-05-07 22:24:25 +0000614 for x in range(repetitions):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000615 tmp_file = self._box._create_tmp()
616 head, tail = os.path.split(tmp_file.name)
617 self.assertEqual(head, os.path.abspath(os.path.join(self._path,
618 "tmp")),
619 "File in wrong location: '%s'" % head)
620 match = pattern.match(tail)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000621 self.assertIsNot(match, None, "Invalid file name: '%s'" % tail)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000622 groups = match.groups()
Benjamin Peterson2a691a82008-03-31 01:51:45 +0000623 if previous_groups is not None:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000624 self.assertTrue(int(groups[0] >= previous_groups[0]),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000625 "Non-monotonic seconds: '%s' before '%s'" %
626 (previous_groups[0], groups[0]))
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000627 self.assertTrue(int(groups[1] >= previous_groups[1]) or
Thomas Wouters477c8d52006-05-27 19:21:47 +0000628 groups[0] != groups[1],
629 "Non-monotonic milliseconds: '%s' before '%s'" %
630 (previous_groups[1], groups[1]))
Guido van Rossumea834472007-07-27 05:17:50 +0000631 self.assertEqual(int(groups[2]), pid,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000632 "Process ID mismatch: '%s' should be '%s'" %
633 (groups[2], pid))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000634 self.assertEqual(int(groups[3]), int(previous_groups[3]) + 1,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000635 "Non-sequential counter: '%s' before '%s'" %
636 (previous_groups[3], groups[3]))
Guido van Rossumea834472007-07-27 05:17:50 +0000637 self.assertEqual(groups[4], hostname,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000638 "Host name mismatch: '%s' should be '%s'" %
639 (groups[4], hostname))
640 previous_groups = groups
641 tmp_file.write(_sample_message)
642 tmp_file.seek(0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000643 self.assertEqual(tmp_file.read(), _sample_message)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000644 tmp_file.close()
645 file_count = len(os.listdir(os.path.join(self._path, "tmp")))
Guido van Rossumea834472007-07-27 05:17:50 +0000646 self.assertEqual(file_count, repetitions,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000647 "Wrong file count: '%s' should be '%s'" %
648 (file_count, repetitions))
649
650 def test_refresh(self):
651 # Update the table of contents
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000652 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000653 key0 = self._box.add(self._template % 0)
654 key1 = self._box.add(self._template % 1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000655 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000656 self._box._refresh()
Guido van Rossumea834472007-07-27 05:17:50 +0000657 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
658 key1: os.path.join('new', key1)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000659 key2 = self._box.add(self._template % 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000660 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
661 key1: os.path.join('new', key1)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000662 self._box._refresh()
Guido van Rossumea834472007-07-27 05:17:50 +0000663 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
664 key1: os.path.join('new', key1),
665 key2: os.path.join('new', key2)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000666
667 def test_lookup(self):
668 # Look up message subpaths in the TOC
669 self.assertRaises(KeyError, lambda: self._box._lookup('foo'))
670 key0 = self._box.add(self._template % 0)
Guido van Rossumea834472007-07-27 05:17:50 +0000671 self.assertEqual(self._box._lookup(key0), os.path.join('new', key0))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000672 os.remove(os.path.join(self._path, 'new', key0))
Guido van Rossumea834472007-07-27 05:17:50 +0000673 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0)})
Antoine Pitrou03f13442009-11-02 11:36:51 +0000674 # Be sure that the TOC is read back from disk (see issue #6896
675 # about bad mtime behaviour on some systems).
676 self._box.flush()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000677 self.assertRaises(KeyError, lambda: self._box._lookup(key0))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000678 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000679
680 def test_lock_unlock(self):
681 # Lock and unlock the mailbox. For Maildir, this does nothing.
682 self._box.lock()
683 self._box.unlock()
684
Thomas Wouters89f507f2006-12-13 04:49:30 +0000685 def test_folder (self):
686 # Test for bug #1569790: verify that folders returned by .get_folder()
687 # use the same factory function.
688 def dummy_factory (s):
689 return None
690 box = self._factory(self._path, factory=dummy_factory)
691 folder = box.add_folder('folder1')
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000692 self.assertIs(folder._factory, dummy_factory)
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000693
Thomas Wouters89f507f2006-12-13 04:49:30 +0000694 folder1_alias = box.get_folder('folder1')
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000695 self.assertIs(folder1_alias._factory, dummy_factory)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000696
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000697 def test_directory_in_folder (self):
698 # Test that mailboxes still work if there's a stray extra directory
699 # in a folder.
700 for i in range(10):
701 self._box.add(mailbox.Message(_sample_message))
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000702
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000703 # Create a stray directory
704 os.mkdir(os.path.join(self._path, 'cur', 'stray-dir'))
705
706 # Check that looping still works with the directory present.
707 for msg in self._box:
708 pass
Thomas Wouters477c8d52006-05-27 19:21:47 +0000709
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000710 def test_file_permissions(self):
711 # Verify that message files are created without execute permissions
712 if not hasattr(os, "stat") or not hasattr(os, "umask"):
713 return
714 msg = mailbox.MaildirMessage(self._template % 0)
715 orig_umask = os.umask(0)
716 try:
717 key = self._box.add(msg)
718 finally:
719 os.umask(orig_umask)
720 path = os.path.join(self._path, self._box._lookup(key))
721 mode = os.stat(path).st_mode
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000722 self.assertFalse(mode & 0o111)
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000723
724 def test_folder_file_perms(self):
725 # From bug #3228, we want to verify that the file created inside a Maildir
726 # subfolder isn't marked as executable.
727 if not hasattr(os, "stat") or not hasattr(os, "umask"):
728 return
729
730 orig_umask = os.umask(0)
731 try:
732 subfolder = self._box.add_folder('subfolder')
733 finally:
734 os.umask(orig_umask)
735
736 path = os.path.join(subfolder._path, 'maildirfolder')
737 st = os.stat(path)
738 perms = st.st_mode
739 self.assertFalse((perms & 0o111)) # Execute bits should all be off.
740
Andrew M. Kuchlingfa815342009-05-03 02:52:20 +0000741 def test_reread(self):
742 # Wait for 2 seconds
743 time.sleep(2)
744
745 # Initially, the mailbox has not been read and the time is null.
746 assert getattr(self._box, '_last_read', None) is None
747
748 # Refresh mailbox; the times should now be set to something.
749 self._box._refresh()
750 assert getattr(self._box, '_last_read', None) is not None
751
752 # Try calling _refresh() again; the modification times shouldn't have
753 # changed, so the mailbox should not be re-reading. Re-reading causes
754 # the ._toc attribute to be assigned a new dictionary object, so
755 # we'll check that the ._toc attribute isn't a different object.
756 orig_toc = self._box._toc
757 def refreshed():
758 return self._box._toc is not orig_toc
759
760 time.sleep(1) # Wait 1sec to ensure time.time()'s value changes
761 self._box._refresh()
762 assert not refreshed()
763
764 # Now, write something into cur and remove it. This changes
765 # the mtime and should cause a re-read.
766 filename = os.path.join(self._path, 'cur', 'stray-file')
767 f = open(filename, 'w')
768 f.close()
769 os.unlink(filename)
770 self._box._refresh()
771 assert refreshed()
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000772
Thomas Wouters477c8d52006-05-27 19:21:47 +0000773class _TestMboxMMDF(TestMailbox):
774
775 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +0000776 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000777 self._delete_recursively(self._path)
778 for lock_remnant in glob.glob(self._path + '.*'):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000779 support.unlink(lock_remnant)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000780
781 def test_add_from_string(self):
782 # Add a string starting with 'From ' to the mailbox
783 key = self._box.add('From foo@bar blah\nFrom: foo\n\n0')
Guido van Rossumea834472007-07-27 05:17:50 +0000784 self.assertEqual(self._box[key].get_from(), 'foo@bar blah')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000785 self.assertEqual(self._box[key].get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000786
787 def test_add_mbox_or_mmdf_message(self):
788 # Add an mboxMessage or MMDFMessage
789 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
790 msg = class_('From foo@bar blah\nFrom: foo\n\n0')
791 key = self._box.add(msg)
792
793 def test_open_close_open(self):
794 # Open and inspect previously-created mailbox
Guido van Rossum805365e2007-05-07 22:24:25 +0000795 values = [self._template % i for i in range(3)]
Thomas Wouters477c8d52006-05-27 19:21:47 +0000796 for value in values:
797 self._box.add(value)
798 self._box.close()
799 mtime = os.path.getmtime(self._path)
800 self._box = self._factory(self._path)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000801 self.assertEqual(len(self._box), 3)
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000802 for key in self._box.keys():
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000803 self.assertIn(self._box.get_string(key), values)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000804 self._box.close()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000805 self.assertEqual(mtime, os.path.getmtime(self._path))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000806
807 def test_add_and_close(self):
808 # Verifying that closing a mailbox doesn't change added items
809 self._box.add(_sample_message)
Guido van Rossum805365e2007-05-07 22:24:25 +0000810 for i in range(3):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000811 self._box.add(self._template % i)
812 self._box.add(_sample_message)
813 self._box._file.flush()
814 self._box._file.seek(0)
815 contents = self._box._file.read()
816 self._box.close()
Brian Curtin5acec042010-10-13 02:29:46 +0000817 with open(self._path, 'r', newline='') as f:
818 self.assertEqual(contents, f.read())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000819 self._box = self._factory(self._path)
820
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000821 def test_lock_conflict(self):
822 # Fork off a subprocess that will lock the file for 2 seconds,
823 # unlock it, and then exit.
824 if not hasattr(os, 'fork'):
825 return
826 pid = os.fork()
827 if pid == 0:
828 # In the child, lock the mailbox.
Guido van Rossum62cbc8a2007-04-09 00:41:25 +0000829 try:
830 self._box.lock()
831 time.sleep(2)
832 self._box.unlock()
833 finally:
834 os._exit(0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000835
836 # In the parent, sleep a bit to give the child time to acquire
837 # the lock.
838 time.sleep(0.5)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000839 try:
840 self.assertRaises(mailbox.ExternalClashError,
841 self._box.lock)
842 finally:
843 # Wait for child to exit. Locking should now succeed.
844 exited_pid, status = os.waitpid(pid, 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000845
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000846 self._box.lock()
847 self._box.unlock()
848
Thomas Wouters89f507f2006-12-13 04:49:30 +0000849 def test_relock(self):
850 # Test case for bug #1575506: the mailbox class was locking the
851 # wrong file object in its flush() method.
852 msg = "Subject: sub\n\nbody\n"
853 key1 = self._box.add(msg)
854 self._box.flush()
855 self._box.close()
856
857 self._box = self._factory(self._path)
858 self._box.lock()
859 key2 = self._box.add(msg)
860 self._box.flush()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000861 self.assertTrue(self._box._locked)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000862 self._box.close()
863
864
Thomas Wouters477c8d52006-05-27 19:21:47 +0000865class TestMbox(_TestMboxMMDF):
866
867 _factory = lambda self, path, factory=None: mailbox.mbox(path, factory)
868
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000869 def test_file_perms(self):
870 # From bug #3228, we want to verify that the mailbox file isn't executable,
871 # even if the umask is set to something that would leave executable bits set.
872 # We only run this test on platforms that support umask.
873 if hasattr(os, 'umask') and hasattr(os, 'stat'):
874 try:
875 old_umask = os.umask(0o077)
876 self._box.close()
877 os.unlink(self._path)
878 self._box = mailbox.mbox(self._path, create=True)
879 self._box.add('')
880 self._box.close()
881 finally:
882 os.umask(old_umask)
883
884 st = os.stat(self._path)
885 perms = st.st_mode
886 self.assertFalse((perms & 0o111)) # Execute bits should all be off.
Thomas Wouters477c8d52006-05-27 19:21:47 +0000887
888class TestMMDF(_TestMboxMMDF):
889
890 _factory = lambda self, path, factory=None: mailbox.MMDF(path, factory)
891
892
893class TestMH(TestMailbox):
894
895 _factory = lambda self, path, factory=None: mailbox.MH(path, factory)
896
897 def test_list_folders(self):
898 # List folders
899 self._box.add_folder('one')
900 self._box.add_folder('two')
901 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000902 self.assertEqual(len(self._box.list_folders()), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000903 self.assertEqual(set(self._box.list_folders()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000904 set(('one', 'two', 'three')))
905
906 def test_get_folder(self):
907 # Open folders
Thomas Wouters89f507f2006-12-13 04:49:30 +0000908 def dummy_factory (s):
909 return None
910 self._box = self._factory(self._path, dummy_factory)
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000911
Thomas Wouters89f507f2006-12-13 04:49:30 +0000912 new_folder = self._box.add_folder('foo.bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000913 folder0 = self._box.get_folder('foo.bar')
914 folder0.add(self._template % 'bar')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000915 self.assertTrue(os.path.isdir(os.path.join(self._path, 'foo.bar')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000916 folder1 = self._box.get_folder('foo.bar')
Guido van Rossumea834472007-07-27 05:17:50 +0000917 self.assertEqual(folder1.get_string(folder1.keys()[0]),
918 self._template % 'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000919
Thomas Wouters89f507f2006-12-13 04:49:30 +0000920 # Test for bug #1569790: verify that folders returned by .get_folder()
921 # use the same factory function.
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000922 self.assertIs(new_folder._factory, self._box._factory)
923 self.assertIs(folder0._factory, self._box._factory)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000924
Thomas Wouters477c8d52006-05-27 19:21:47 +0000925 def test_add_and_remove_folders(self):
926 # Delete folders
927 self._box.add_folder('one')
928 self._box.add_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000929 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000930 self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000931 self._box.remove_folder('one')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000932 self.assertEqual(len(self._box.list_folders()), 1)
933 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000934 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000935 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000936 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000937 self._box.remove_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000938 self.assertEqual(len(self._box.list_folders()), 1)
939 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000940 self._box.remove_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000941 self.assertEqual(len(self._box.list_folders()), 0)
942 self.assertEqual(self._box.list_folders(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000943
944 def test_sequences(self):
945 # Get and set sequences
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000946 self.assertEqual(self._box.get_sequences(), {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000947 msg0 = mailbox.MHMessage(self._template % 0)
948 msg0.add_sequence('foo')
949 key0 = self._box.add(msg0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000950 self.assertEqual(self._box.get_sequences(), {'foo':[key0]})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000951 msg1 = mailbox.MHMessage(self._template % 1)
952 msg1.set_sequences(['bar', 'replied', 'foo'])
953 key1 = self._box.add(msg1)
Guido van Rossumea834472007-07-27 05:17:50 +0000954 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000955 {'foo':[key0, key1], 'bar':[key1], 'replied':[key1]})
956 msg0.set_sequences(['flagged'])
957 self._box[key0] = msg0
Guido van Rossumea834472007-07-27 05:17:50 +0000958 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000959 {'foo':[key1], 'bar':[key1], 'replied':[key1],
960 'flagged':[key0]})
961 self._box.remove(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000962 self.assertEqual(self._box.get_sequences(), {'flagged':[key0]})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000963
R. David Murray548ac412009-04-02 19:44:43 +0000964 def test_issue2625(self):
965 msg0 = mailbox.MHMessage(self._template % 0)
966 msg0.add_sequence('foo')
967 key0 = self._box.add(msg0)
968 refmsg0 = self._box.get_message(key0)
969
Benjamin Peterson21896a32010-03-21 22:03:03 +0000970 def test_issue7627(self):
971 msg0 = mailbox.MHMessage(self._template % 0)
972 key0 = self._box.add(msg0)
973 self._box.lock()
974 self._box.remove(key0)
975 self._box.unlock()
976
Thomas Wouters477c8d52006-05-27 19:21:47 +0000977 def test_pack(self):
978 # Pack the contents of the mailbox
979 msg0 = mailbox.MHMessage(self._template % 0)
980 msg1 = mailbox.MHMessage(self._template % 1)
981 msg2 = mailbox.MHMessage(self._template % 2)
982 msg3 = mailbox.MHMessage(self._template % 3)
983 msg0.set_sequences(['foo', 'unseen'])
984 msg1.set_sequences(['foo'])
985 msg2.set_sequences(['foo', 'flagged'])
986 msg3.set_sequences(['foo', 'bar', 'replied'])
987 key0 = self._box.add(msg0)
988 key1 = self._box.add(msg1)
989 key2 = self._box.add(msg2)
990 key3 = self._box.add(msg3)
Guido van Rossumea834472007-07-27 05:17:50 +0000991 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000992 {'foo':[key0,key1,key2,key3], 'unseen':[key0],
993 'flagged':[key2], 'bar':[key3], 'replied':[key3]})
994 self._box.remove(key2)
Guido van Rossumea834472007-07-27 05:17:50 +0000995 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000996 {'foo':[key0,key1,key3], 'unseen':[key0], 'bar':[key3],
997 'replied':[key3]})
998 self._box.pack()
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000999 self.assertEqual(self._box.keys(), [1, 2, 3])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001000 key0 = key0
1001 key1 = key0 + 1
1002 key2 = key1 + 1
Guido van Rossumea834472007-07-27 05:17:50 +00001003 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +00001004 {'foo':[1, 2, 3], 'unseen':[1], 'bar':[3], 'replied':[3]})
1005
Thomas Wouters89f507f2006-12-13 04:49:30 +00001006 # Test case for packing while holding the mailbox locked.
1007 key0 = self._box.add(msg1)
1008 key1 = self._box.add(msg1)
1009 key2 = self._box.add(msg1)
1010 key3 = self._box.add(msg1)
1011
1012 self._box.remove(key0)
1013 self._box.remove(key2)
1014 self._box.lock()
1015 self._box.pack()
1016 self._box.unlock()
Guido van Rossumea834472007-07-27 05:17:50 +00001017 self.assertEqual(self._box.get_sequences(),
Thomas Wouters89f507f2006-12-13 04:49:30 +00001018 {'foo':[1, 2, 3, 4, 5],
1019 'unseen':[1], 'bar':[3], 'replied':[3]})
Thomas Wouters9fe394c2007-02-05 01:24:16 +00001020
Thomas Wouters477c8d52006-05-27 19:21:47 +00001021 def _get_lock_path(self):
1022 return os.path.join(self._path, '.mh_sequences.lock')
1023
1024
1025class TestBabyl(TestMailbox):
1026
1027 _factory = lambda self, path, factory=None: mailbox.Babyl(path, factory)
1028
1029 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +00001030 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001031 self._delete_recursively(self._path)
1032 for lock_remnant in glob.glob(self._path + '.*'):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001033 support.unlink(lock_remnant)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001034
1035 def test_labels(self):
1036 # Get labels from the mailbox
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001037 self.assertEqual(self._box.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001038 msg0 = mailbox.BabylMessage(self._template % 0)
1039 msg0.add_label('foo')
1040 key0 = self._box.add(msg0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001041 self.assertEqual(self._box.get_labels(), ['foo'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001042 msg1 = mailbox.BabylMessage(self._template % 1)
1043 msg1.set_labels(['bar', 'answered', 'foo'])
1044 key1 = self._box.add(msg1)
Guido van Rossumea834472007-07-27 05:17:50 +00001045 self.assertEqual(set(self._box.get_labels()), set(['foo', 'bar']))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001046 msg0.set_labels(['blah', 'filed'])
1047 self._box[key0] = msg0
Guido van Rossumea834472007-07-27 05:17:50 +00001048 self.assertEqual(set(self._box.get_labels()),
Thomas Wouters477c8d52006-05-27 19:21:47 +00001049 set(['foo', 'bar', 'blah']))
1050 self._box.remove(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001051 self.assertEqual(set(self._box.get_labels()), set(['blah']))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001052
1053
1054class TestMessage(TestBase):
1055
1056 _factory = mailbox.Message # Overridden by subclasses to reuse tests
1057
1058 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001059 self._path = support.TESTFN
Thomas Wouters477c8d52006-05-27 19:21:47 +00001060
1061 def tearDown(self):
1062 self._delete_recursively(self._path)
1063
1064 def test_initialize_with_eMM(self):
Thomas Woutersb2137042007-02-01 18:02:27 +00001065 # Initialize based on email.message.Message instance
Thomas Wouters477c8d52006-05-27 19:21:47 +00001066 eMM = email.message_from_string(_sample_message)
1067 msg = self._factory(eMM)
1068 self._post_initialize_hook(msg)
1069 self._check_sample(msg)
1070
1071 def test_initialize_with_string(self):
1072 # Initialize based on string
1073 msg = self._factory(_sample_message)
1074 self._post_initialize_hook(msg)
1075 self._check_sample(msg)
1076
1077 def test_initialize_with_file(self):
1078 # Initialize based on contents of file
Brian Curtin5acec042010-10-13 02:29:46 +00001079 with open(self._path, 'w+') as f:
1080 f.write(_sample_message)
1081 f.seek(0)
1082 msg = self._factory(f)
1083 self._post_initialize_hook(msg)
1084 self._check_sample(msg)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001085
1086 def test_initialize_with_nothing(self):
1087 # Initialize without arguments
1088 msg = self._factory()
1089 self._post_initialize_hook(msg)
Ezio Melottie9615932010-01-24 19:26:24 +00001090 self.assertIsInstance(msg, email.message.Message)
1091 self.assertIsInstance(msg, mailbox.Message)
1092 self.assertIsInstance(msg, self._factory)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001093 self.assertEqual(msg.keys(), [])
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001094 self.assertFalse(msg.is_multipart())
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001095 self.assertEqual(msg.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001096
1097 def test_initialize_incorrectly(self):
1098 # Initialize with invalid argument
1099 self.assertRaises(TypeError, lambda: self._factory(object()))
1100
1101 def test_become_message(self):
1102 # Take on the state of another message
1103 eMM = email.message_from_string(_sample_message)
1104 msg = self._factory()
1105 msg._become_message(eMM)
1106 self._check_sample(msg)
1107
1108 def test_explain_to(self):
1109 # Copy self's format-specific data to other message formats.
1110 # This test is superficial; better ones are in TestMessageConversion.
1111 msg = self._factory()
1112 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1113 mailbox.mboxMessage, mailbox.MHMessage,
1114 mailbox.BabylMessage, mailbox.MMDFMessage):
1115 other_msg = class_()
1116 msg._explain_to(other_msg)
Thomas Woutersb2137042007-02-01 18:02:27 +00001117 other_msg = email.message.Message()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001118 self.assertRaises(TypeError, lambda: msg._explain_to(other_msg))
1119
1120 def _post_initialize_hook(self, msg):
1121 # Overridden by subclasses to check extra things after initialization
1122 pass
1123
1124
1125class TestMaildirMessage(TestMessage):
1126
1127 _factory = mailbox.MaildirMessage
1128
1129 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001130 self.assertEqual(msg._subdir, 'new')
1131 self.assertEqual(msg._info, '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001132
1133 def test_subdir(self):
1134 # Use get_subdir() and set_subdir()
1135 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001136 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001137 msg.set_subdir('cur')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001138 self.assertEqual(msg.get_subdir(), 'cur')
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.assertRaises(ValueError, lambda: msg.set_subdir('tmp'))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001142 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001143 msg.set_subdir('new')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001144 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001145 self._check_sample(msg)
1146
1147 def test_flags(self):
1148 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1149 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001150 self.assertEqual(msg.get_flags(), '')
1151 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001152 msg.set_flags('F')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001153 self.assertEqual(msg.get_subdir(), 'new')
1154 self.assertEqual(msg.get_flags(), 'F')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001155 msg.set_flags('SDTP')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001156 self.assertEqual(msg.get_flags(), 'DPST')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001157 msg.add_flag('FT')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001158 self.assertEqual(msg.get_flags(), 'DFPST')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001159 msg.remove_flag('TDRP')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001160 self.assertEqual(msg.get_flags(), 'FS')
1161 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001162 self._check_sample(msg)
1163
1164 def test_date(self):
1165 # Use get_date() and set_date()
1166 msg = mailbox.MaildirMessage(_sample_message)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001167 self.assertLess(abs(msg.get_date() - time.time()), 60)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001168 msg.set_date(0.0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001169 self.assertEqual(msg.get_date(), 0.0)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001170
1171 def test_info(self):
1172 # Use get_info() and set_info()
1173 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001174 self.assertEqual(msg.get_info(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001175 msg.set_info('1,foo=bar')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001176 self.assertEqual(msg.get_info(), '1,foo=bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001177 self.assertRaises(TypeError, lambda: msg.set_info(None))
1178 self._check_sample(msg)
1179
1180 def test_info_and_flags(self):
1181 # Test interaction of info and flag methods
1182 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001183 self.assertEqual(msg.get_info(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001184 msg.set_flags('SF')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001185 self.assertEqual(msg.get_flags(), 'FS')
1186 self.assertEqual(msg.get_info(), '2,FS')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001187 msg.set_info('1,')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001188 self.assertEqual(msg.get_flags(), '')
1189 self.assertEqual(msg.get_info(), '1,')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001190 msg.remove_flag('RPT')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001191 self.assertEqual(msg.get_flags(), '')
1192 self.assertEqual(msg.get_info(), '1,')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001193 msg.add_flag('D')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001194 self.assertEqual(msg.get_flags(), 'D')
1195 self.assertEqual(msg.get_info(), '2,D')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001196 self._check_sample(msg)
1197
1198
1199class _TestMboxMMDFMessage(TestMessage):
1200
1201 _factory = mailbox._mboxMMDFMessage
1202
1203 def _post_initialize_hook(self, msg):
1204 self._check_from(msg)
1205
1206 def test_initialize_with_unixfrom(self):
1207 # Initialize with a message that already has a _unixfrom attribute
1208 msg = mailbox.Message(_sample_message)
1209 msg.set_unixfrom('From foo@bar blah')
1210 msg = mailbox.mboxMessage(msg)
Guido van Rossumea834472007-07-27 05:17:50 +00001211 self.assertEqual(msg.get_from(), 'foo@bar blah', msg.get_from())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001212
1213 def test_from(self):
1214 # Get and set "From " line
1215 msg = mailbox.mboxMessage(_sample_message)
1216 self._check_from(msg)
1217 msg.set_from('foo bar')
Guido van Rossumea834472007-07-27 05:17:50 +00001218 self.assertEqual(msg.get_from(), 'foo bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001219 msg.set_from('foo@bar', True)
1220 self._check_from(msg, 'foo@bar')
1221 msg.set_from('blah@temp', time.localtime())
1222 self._check_from(msg, 'blah@temp')
1223
1224 def test_flags(self):
1225 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1226 msg = mailbox.mboxMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001227 self.assertEqual(msg.get_flags(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001228 msg.set_flags('F')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001229 self.assertEqual(msg.get_flags(), 'F')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001230 msg.set_flags('XODR')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001231 self.assertEqual(msg.get_flags(), 'RODX')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001232 msg.add_flag('FA')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001233 self.assertEqual(msg.get_flags(), 'RODFAX')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001234 msg.remove_flag('FDXA')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001235 self.assertEqual(msg.get_flags(), 'RO')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001236 self._check_sample(msg)
1237
1238 def _check_from(self, msg, sender=None):
1239 # Check contents of "From " line
1240 if sender is None:
1241 sender = "MAILER-DAEMON"
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001242 self.assertTrue(re.match(sender + r" \w{3} \w{3} [\d ]\d [\d ]\d:\d{2}:"
Thomas Wouters477c8d52006-05-27 19:21:47 +00001243 r"\d{2} \d{4}", msg.get_from()) is not None)
1244
1245
1246class TestMboxMessage(_TestMboxMMDFMessage):
1247
1248 _factory = mailbox.mboxMessage
1249
1250
1251class TestMHMessage(TestMessage):
1252
1253 _factory = mailbox.MHMessage
1254
1255 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001256 self.assertEqual(msg._sequences, [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001257
1258 def test_sequences(self):
1259 # Get, set, join, and leave sequences
1260 msg = mailbox.MHMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001261 self.assertEqual(msg.get_sequences(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001262 msg.set_sequences(['foobar'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001263 self.assertEqual(msg.get_sequences(), ['foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001264 msg.set_sequences([])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001265 self.assertEqual(msg.get_sequences(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001266 msg.add_sequence('unseen')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001267 self.assertEqual(msg.get_sequences(), ['unseen'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001268 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001269 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001270 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001271 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001272 msg.remove_sequence('unseen')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001273 self.assertEqual(msg.get_sequences(), ['flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001274 msg.add_sequence('foobar')
Guido van Rossumea834472007-07-27 05:17:50 +00001275 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001276 msg.remove_sequence('replied')
Guido van Rossumea834472007-07-27 05:17:50 +00001277 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001278 msg.set_sequences(['foobar', 'replied'])
Guido van Rossumea834472007-07-27 05:17:50 +00001279 self.assertEqual(msg.get_sequences(), ['foobar', 'replied'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001280
1281
1282class TestBabylMessage(TestMessage):
1283
1284 _factory = mailbox.BabylMessage
1285
1286 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001287 self.assertEqual(msg._labels, [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001288
1289 def test_labels(self):
1290 # Get, set, join, and leave labels
1291 msg = mailbox.BabylMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001292 self.assertEqual(msg.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001293 msg.set_labels(['foobar'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001294 self.assertEqual(msg.get_labels(), ['foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001295 msg.set_labels([])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001296 self.assertEqual(msg.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001297 msg.add_label('filed')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001298 self.assertEqual(msg.get_labels(), ['filed'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001299 msg.add_label('resent')
Guido van Rossumea834472007-07-27 05:17:50 +00001300 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001301 msg.add_label('resent')
Guido van Rossumea834472007-07-27 05:17:50 +00001302 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001303 msg.remove_label('filed')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001304 self.assertEqual(msg.get_labels(), ['resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001305 msg.add_label('foobar')
Guido van Rossumea834472007-07-27 05:17:50 +00001306 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001307 msg.remove_label('unseen')
Guido van Rossumea834472007-07-27 05:17:50 +00001308 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001309 msg.set_labels(['foobar', 'answered'])
Guido van Rossumea834472007-07-27 05:17:50 +00001310 self.assertEqual(msg.get_labels(), ['foobar', 'answered'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001311
1312 def test_visible(self):
1313 # Get, set, and update visible headers
1314 msg = mailbox.BabylMessage(_sample_message)
1315 visible = msg.get_visible()
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001316 self.assertEqual(visible.keys(), [])
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001317 self.assertIs(visible.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001318 visible['User-Agent'] = 'FooBar 1.0'
1319 visible['X-Whatever'] = 'Blah'
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001320 self.assertEqual(msg.get_visible().keys(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001321 msg.set_visible(visible)
1322 visible = msg.get_visible()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001323 self.assertTrue(visible.keys() == ['User-Agent', 'X-Whatever'])
1324 self.assertTrue(visible['User-Agent'] == 'FooBar 1.0')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001325 self.assertEqual(visible['X-Whatever'], 'Blah')
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001326 self.assertIs(visible.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001327 msg.update_visible()
Guido van Rossumea834472007-07-27 05:17:50 +00001328 self.assertEqual(visible.keys(), ['User-Agent', 'X-Whatever'])
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001329 self.assertIs(visible.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001330 visible = msg.get_visible()
Guido van Rossumea834472007-07-27 05:17:50 +00001331 self.assertEqual(visible.keys(), ['User-Agent', 'Date', 'From', 'To',
1332 'Subject'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001333 for header in ('User-Agent', 'Date', 'From', 'To', 'Subject'):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001334 self.assertEqual(visible[header], msg[header])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001335
1336
1337class TestMMDFMessage(_TestMboxMMDFMessage):
1338
1339 _factory = mailbox.MMDFMessage
1340
1341
1342class TestMessageConversion(TestBase):
1343
1344 def test_plain_to_x(self):
1345 # Convert Message to all formats
1346 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1347 mailbox.mboxMessage, mailbox.MHMessage,
1348 mailbox.BabylMessage, mailbox.MMDFMessage):
1349 msg_plain = mailbox.Message(_sample_message)
1350 msg = class_(msg_plain)
1351 self._check_sample(msg)
1352
1353 def test_x_to_plain(self):
1354 # Convert all formats to Message
1355 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1356 mailbox.mboxMessage, mailbox.MHMessage,
1357 mailbox.BabylMessage, mailbox.MMDFMessage):
1358 msg = class_(_sample_message)
1359 msg_plain = mailbox.Message(msg)
1360 self._check_sample(msg_plain)
1361
1362 def test_x_to_invalid(self):
1363 # Convert all formats to an invalid format
1364 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1365 mailbox.mboxMessage, mailbox.MHMessage,
1366 mailbox.BabylMessage, mailbox.MMDFMessage):
1367 self.assertRaises(TypeError, lambda: class_(False))
1368
1369 def test_maildir_to_maildir(self):
1370 # Convert MaildirMessage to MaildirMessage
1371 msg_maildir = mailbox.MaildirMessage(_sample_message)
1372 msg_maildir.set_flags('DFPRST')
1373 msg_maildir.set_subdir('cur')
1374 date = msg_maildir.get_date()
1375 msg = mailbox.MaildirMessage(msg_maildir)
1376 self._check_sample(msg)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001377 self.assertEqual(msg.get_flags(), 'DFPRST')
1378 self.assertEqual(msg.get_subdir(), 'cur')
1379 self.assertEqual(msg.get_date(), date)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001380
1381 def test_maildir_to_mboxmmdf(self):
1382 # Convert MaildirMessage to mboxmessage and MMDFMessage
1383 pairs = (('D', ''), ('F', 'F'), ('P', ''), ('R', 'A'), ('S', 'R'),
1384 ('T', 'D'), ('DFPRST', 'RDFA'))
1385 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1386 msg_maildir = mailbox.MaildirMessage(_sample_message)
1387 msg_maildir.set_date(0.0)
1388 for setting, result in pairs:
1389 msg_maildir.set_flags(setting)
1390 msg = class_(msg_maildir)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001391 self.assertEqual(msg.get_flags(), result)
Guido van Rossumea834472007-07-27 05:17:50 +00001392 self.assertEqual(msg.get_from(), 'MAILER-DAEMON %s' %
Thomas Wouters477c8d52006-05-27 19:21:47 +00001393 time.asctime(time.gmtime(0.0)))
1394 msg_maildir.set_subdir('cur')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001395 self.assertEqual(class_(msg_maildir).get_flags(), 'RODFA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001396
1397 def test_maildir_to_mh(self):
1398 # Convert MaildirMessage to MHMessage
1399 msg_maildir = mailbox.MaildirMessage(_sample_message)
1400 pairs = (('D', ['unseen']), ('F', ['unseen', 'flagged']),
1401 ('P', ['unseen']), ('R', ['unseen', 'replied']), ('S', []),
1402 ('T', ['unseen']), ('DFPRST', ['replied', 'flagged']))
1403 for setting, result in pairs:
1404 msg_maildir.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001405 self.assertEqual(mailbox.MHMessage(msg_maildir).get_sequences(),
1406 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001407
1408 def test_maildir_to_babyl(self):
1409 # Convert MaildirMessage to Babyl
1410 msg_maildir = mailbox.MaildirMessage(_sample_message)
1411 pairs = (('D', ['unseen']), ('F', ['unseen']),
1412 ('P', ['unseen', 'forwarded']), ('R', ['unseen', 'answered']),
1413 ('S', []), ('T', ['unseen', 'deleted']),
1414 ('DFPRST', ['deleted', 'answered', 'forwarded']))
1415 for setting, result in pairs:
1416 msg_maildir.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001417 self.assertEqual(mailbox.BabylMessage(msg_maildir).get_labels(),
1418 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001419
1420 def test_mboxmmdf_to_maildir(self):
1421 # Convert mboxMessage and MMDFMessage to MaildirMessage
1422 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1423 msg_mboxMMDF = class_(_sample_message)
1424 msg_mboxMMDF.set_from('foo@bar', time.gmtime(0.0))
1425 pairs = (('R', 'S'), ('O', ''), ('D', 'T'), ('F', 'F'), ('A', 'R'),
1426 ('RODFA', 'FRST'))
1427 for setting, result in pairs:
1428 msg_mboxMMDF.set_flags(setting)
1429 msg = mailbox.MaildirMessage(msg_mboxMMDF)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001430 self.assertEqual(msg.get_flags(), result)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001431 self.assertEqual(msg.get_date(), 0.0)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001432 msg_mboxMMDF.set_flags('O')
Guido van Rossumea834472007-07-27 05:17:50 +00001433 self.assertEqual(mailbox.MaildirMessage(msg_mboxMMDF).get_subdir(),
1434 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001435
1436 def test_mboxmmdf_to_mboxmmdf(self):
1437 # Convert mboxMessage and MMDFMessage to mboxMessage and MMDFMessage
1438 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1439 msg_mboxMMDF = class_(_sample_message)
1440 msg_mboxMMDF.set_flags('RODFA')
1441 msg_mboxMMDF.set_from('foo@bar')
1442 for class2_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1443 msg2 = class2_(msg_mboxMMDF)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001444 self.assertEqual(msg2.get_flags(), 'RODFA')
1445 self.assertEqual(msg2.get_from(), 'foo@bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001446
1447 def test_mboxmmdf_to_mh(self):
1448 # Convert mboxMessage and MMDFMessage to MHMessage
1449 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1450 msg_mboxMMDF = class_(_sample_message)
1451 pairs = (('R', []), ('O', ['unseen']), ('D', ['unseen']),
1452 ('F', ['unseen', 'flagged']),
1453 ('A', ['unseen', 'replied']),
1454 ('RODFA', ['replied', 'flagged']))
1455 for setting, result in pairs:
1456 msg_mboxMMDF.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001457 self.assertEqual(mailbox.MHMessage(msg_mboxMMDF).get_sequences(),
1458 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001459
1460 def test_mboxmmdf_to_babyl(self):
1461 # Convert mboxMessage and MMDFMessage to BabylMessage
1462 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1463 msg = class_(_sample_message)
1464 pairs = (('R', []), ('O', ['unseen']),
1465 ('D', ['unseen', 'deleted']), ('F', ['unseen']),
1466 ('A', ['unseen', 'answered']),
1467 ('RODFA', ['deleted', 'answered']))
1468 for setting, result in pairs:
1469 msg.set_flags(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001470 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001471
1472 def test_mh_to_maildir(self):
1473 # Convert MHMessage to MaildirMessage
1474 pairs = (('unseen', ''), ('replied', 'RS'), ('flagged', 'FS'))
1475 for setting, result in pairs:
1476 msg = mailbox.MHMessage(_sample_message)
1477 msg.add_sequence(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001478 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1479 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001480 msg = mailbox.MHMessage(_sample_message)
1481 msg.add_sequence('unseen')
1482 msg.add_sequence('replied')
1483 msg.add_sequence('flagged')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001484 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'FR')
1485 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001486
1487 def test_mh_to_mboxmmdf(self):
1488 # Convert MHMessage to mboxMessage and MMDFMessage
1489 pairs = (('unseen', 'O'), ('replied', 'ROA'), ('flagged', 'ROF'))
1490 for setting, result in pairs:
1491 msg = mailbox.MHMessage(_sample_message)
1492 msg.add_sequence(setting)
1493 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001494 self.assertEqual(class_(msg).get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001495 msg = mailbox.MHMessage(_sample_message)
1496 msg.add_sequence('unseen')
1497 msg.add_sequence('replied')
1498 msg.add_sequence('flagged')
1499 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001500 self.assertEqual(class_(msg).get_flags(), 'OFA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001501
1502 def test_mh_to_mh(self):
1503 # Convert MHMessage to MHMessage
1504 msg = mailbox.MHMessage(_sample_message)
1505 msg.add_sequence('unseen')
1506 msg.add_sequence('replied')
1507 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001508 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1509 ['unseen', 'replied', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001510
1511 def test_mh_to_babyl(self):
1512 # Convert MHMessage to BabylMessage
1513 pairs = (('unseen', ['unseen']), ('replied', ['answered']),
1514 ('flagged', []))
1515 for setting, result in pairs:
1516 msg = mailbox.MHMessage(_sample_message)
1517 msg.add_sequence(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001518 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001519 msg = mailbox.MHMessage(_sample_message)
1520 msg.add_sequence('unseen')
1521 msg.add_sequence('replied')
1522 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001523 self.assertEqual(mailbox.BabylMessage(msg).get_labels(),
1524 ['unseen', 'answered'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001525
1526 def test_babyl_to_maildir(self):
1527 # Convert BabylMessage to MaildirMessage
1528 pairs = (('unseen', ''), ('deleted', 'ST'), ('filed', 'S'),
1529 ('answered', 'RS'), ('forwarded', 'PS'), ('edited', 'S'),
1530 ('resent', 'PS'))
1531 for setting, result in pairs:
1532 msg = mailbox.BabylMessage(_sample_message)
1533 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001534 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1535 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001536 msg = mailbox.BabylMessage(_sample_message)
1537 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1538 'edited', 'resent'):
1539 msg.add_label(label)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001540 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'PRT')
1541 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001542
1543 def test_babyl_to_mboxmmdf(self):
1544 # Convert BabylMessage to mboxMessage and MMDFMessage
1545 pairs = (('unseen', 'O'), ('deleted', 'ROD'), ('filed', 'RO'),
1546 ('answered', 'ROA'), ('forwarded', 'RO'), ('edited', 'RO'),
1547 ('resent', 'RO'))
1548 for setting, result in pairs:
1549 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1550 msg = mailbox.BabylMessage(_sample_message)
1551 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001552 self.assertEqual(class_(msg).get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001553 msg = mailbox.BabylMessage(_sample_message)
1554 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1555 'edited', 'resent'):
1556 msg.add_label(label)
1557 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001558 self.assertEqual(class_(msg).get_flags(), 'ODA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001559
1560 def test_babyl_to_mh(self):
1561 # Convert BabylMessage to MHMessage
1562 pairs = (('unseen', ['unseen']), ('deleted', []), ('filed', []),
1563 ('answered', ['replied']), ('forwarded', []), ('edited', []),
1564 ('resent', []))
1565 for setting, result in pairs:
1566 msg = mailbox.BabylMessage(_sample_message)
1567 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001568 self.assertEqual(mailbox.MHMessage(msg).get_sequences(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001569 msg = mailbox.BabylMessage(_sample_message)
1570 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1571 'edited', 'resent'):
1572 msg.add_label(label)
Guido van Rossumea834472007-07-27 05:17:50 +00001573 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1574 ['unseen', 'replied'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001575
1576 def test_babyl_to_babyl(self):
1577 # Convert BabylMessage to BabylMessage
1578 msg = mailbox.BabylMessage(_sample_message)
1579 msg.update_visible()
1580 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1581 'edited', 'resent'):
1582 msg.add_label(label)
1583 msg2 = mailbox.BabylMessage(msg)
Guido van Rossumea834472007-07-27 05:17:50 +00001584 self.assertEqual(msg2.get_labels(), ['unseen', 'deleted', 'filed',
1585 'answered', 'forwarded', 'edited',
1586 'resent'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001587 self.assertEqual(msg.get_visible().keys(), msg2.get_visible().keys())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001588 for key in msg.get_visible().keys():
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001589 self.assertEqual(msg.get_visible()[key], msg2.get_visible()[key])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001590
1591
1592class TestProxyFileBase(TestBase):
1593
1594 def _test_read(self, proxy):
1595 # Read by byte
1596 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001597 self.assertEqual(proxy.read(), b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001598 proxy.seek(1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001599 self.assertEqual(proxy.read(), b'ar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001600 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001601 self.assertEqual(proxy.read(2), b'ba')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001602 proxy.seek(1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001603 self.assertEqual(proxy.read(-1), b'ar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001604 proxy.seek(2)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001605 self.assertEqual(proxy.read(1000), b'r')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001606
1607 def _test_readline(self, proxy):
1608 # Read by line
Guido van Rossum98297ee2007-11-06 21:34:58 +00001609 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001610 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001611 self.assertEqual(proxy.readline(), b'foo' + linesep)
1612 self.assertEqual(proxy.readline(), b'bar' + linesep)
1613 self.assertEqual(proxy.readline(), b'fred' + linesep)
1614 self.assertEqual(proxy.readline(), b'bob')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001615 proxy.seek(2)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001616 self.assertEqual(proxy.readline(), b'o' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001617 proxy.seek(6 + 2 * len(os.linesep))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001618 self.assertEqual(proxy.readline(), b'fred' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001619 proxy.seek(6 + 2 * len(os.linesep))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001620 self.assertEqual(proxy.readline(2), b'fr')
1621 self.assertEqual(proxy.readline(-10), b'ed' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001622
1623 def _test_readlines(self, proxy):
1624 # Read multiple lines
Guido van Rossum98297ee2007-11-06 21:34:58 +00001625 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001626 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001627 self.assertEqual(proxy.readlines(), [b'foo' + linesep,
1628 b'bar' + linesep,
1629 b'fred' + linesep, b'bob'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001630 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001631 self.assertEqual(proxy.readlines(2), [b'foo' + linesep])
1632 proxy.seek(3 + len(linesep))
1633 self.assertEqual(proxy.readlines(4 + len(linesep)),
1634 [b'bar' + linesep, b'fred' + linesep])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001635 proxy.seek(3)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001636 self.assertEqual(proxy.readlines(1000), [linesep, b'bar' + linesep,
1637 b'fred' + linesep, b'bob'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001638
1639 def _test_iteration(self, proxy):
1640 # Iterate by line
Guido van Rossum98297ee2007-11-06 21:34:58 +00001641 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001642 proxy.seek(0)
1643 iterator = iter(proxy)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001644 self.assertEqual(next(iterator), b'foo' + linesep)
1645 self.assertEqual(next(iterator), b'bar' + linesep)
1646 self.assertEqual(next(iterator), b'fred' + linesep)
1647 self.assertEqual(next(iterator), b'bob')
Georg Brandla18af4e2007-04-21 15:47:16 +00001648 self.assertRaises(StopIteration, next, iterator)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001649
1650 def _test_seek_and_tell(self, proxy):
1651 # Seek and use tell to check position
Guido van Rossum98297ee2007-11-06 21:34:58 +00001652 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001653 proxy.seek(3)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001654 self.assertEqual(proxy.tell(), 3)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001655 self.assertEqual(proxy.read(len(linesep)), linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001656 proxy.seek(2, 1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001657 self.assertEqual(proxy.read(1 + len(linesep)), b'r' + linesep)
1658 proxy.seek(-3 - len(linesep), 2)
1659 self.assertEqual(proxy.read(3), b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001660 proxy.seek(2, 0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001661 self.assertEqual(proxy.read(), b'o' + linesep + b'bar' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001662 proxy.seek(100)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001663 self.assertFalse(proxy.read())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001664
1665 def _test_close(self, proxy):
1666 # Close a file
1667 proxy.close()
1668 self.assertRaises(AttributeError, lambda: proxy.close())
1669
1670
1671class TestProxyFile(TestProxyFileBase):
1672
1673 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001674 self._path = support.TESTFN
Thomas Wouters477c8d52006-05-27 19:21:47 +00001675 self._file = open(self._path, 'wb+')
1676
1677 def tearDown(self):
1678 self._file.close()
1679 self._delete_recursively(self._path)
1680
1681 def test_initialize(self):
1682 # Initialize and check position
Neal Norwitz9a923102007-08-30 06:20:05 +00001683 self._file.write(b'foo')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001684 pos = self._file.tell()
1685 proxy0 = mailbox._ProxyFile(self._file)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001686 self.assertEqual(proxy0.tell(), pos)
1687 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001688 proxy1 = mailbox._ProxyFile(self._file, 0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001689 self.assertEqual(proxy1.tell(), 0)
1690 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001691
1692 def test_read(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001693 self._file.write(b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001694 self._test_read(mailbox._ProxyFile(self._file))
1695
1696 def test_readline(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001697 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1698 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001699 self._test_readline(mailbox._ProxyFile(self._file))
1700
1701 def test_readlines(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001702 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1703 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001704 self._test_readlines(mailbox._ProxyFile(self._file))
1705
1706 def test_iteration(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001707 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1708 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001709 self._test_iteration(mailbox._ProxyFile(self._file))
1710
1711 def test_seek_and_tell(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_seek_and_tell(mailbox._ProxyFile(self._file))
1714
1715 def test_close(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001716 self._file.write(bytes('foo%sbar%s' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001717 self._test_close(mailbox._ProxyFile(self._file))
1718
1719
1720class TestPartialFile(TestProxyFileBase):
1721
1722 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001723 self._path = support.TESTFN
Thomas Wouters477c8d52006-05-27 19:21:47 +00001724 self._file = open(self._path, 'wb+')
1725
1726 def tearDown(self):
1727 self._file.close()
1728 self._delete_recursively(self._path)
1729
1730 def test_initialize(self):
1731 # Initialize and check position
Neal Norwitz9a923102007-08-30 06:20:05 +00001732 self._file.write(bytes('foo' + os.linesep + 'bar', 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001733 pos = self._file.tell()
1734 proxy = mailbox._PartialFile(self._file, 2, 5)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001735 self.assertEqual(proxy.tell(), 0)
1736 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001737
1738 def test_read(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001739 self._file.write(bytes('***bar***', 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001740 self._test_read(mailbox._PartialFile(self._file, 3, 6))
1741
1742 def test_readline(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001743 self._file.write(bytes('!!!!!foo%sbar%sfred%sbob!!!!!' %
1744 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001745 self._test_readline(mailbox._PartialFile(self._file, 5,
1746 18 + 3 * len(os.linesep)))
1747
1748 def test_readlines(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001749 self._file.write(bytes('foo%sbar%sfred%sbob?????' %
1750 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001751 self._test_readlines(mailbox._PartialFile(self._file, 0,
1752 13 + 3 * len(os.linesep)))
1753
1754 def test_iteration(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001755 self._file.write(bytes('____foo%sbar%sfred%sbob####' %
1756 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001757 self._test_iteration(mailbox._PartialFile(self._file, 4,
1758 17 + 3 * len(os.linesep)))
1759
1760 def test_seek_and_tell(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001761 self._file.write(bytes('(((foo%sbar%s$$$' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001762 self._test_seek_and_tell(mailbox._PartialFile(self._file, 3,
1763 9 + 2 * len(os.linesep)))
1764
1765 def test_close(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001766 self._file.write(bytes('&foo%sbar%s^' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001767 self._test_close(mailbox._PartialFile(self._file, 1,
1768 6 + 3 * len(os.linesep)))
1769
1770
1771## Start: tests from the original module (for backward compatibility).
1772
Skip Montanaro5253da12004-07-24 19:56:03 +00001773FROM_ = "From some.body@dummy.domain Sat Jul 24 13:43:35 2004\n"
Fred Drakec02bc3e2001-05-21 20:23:21 +00001774DUMMY_MESSAGE = """\
1775From: some.body@dummy.domain
1776To: me@my.domain
Skip Montanaro5253da12004-07-24 19:56:03 +00001777Subject: Simple Test
Fred Drakec02bc3e2001-05-21 20:23:21 +00001778
1779This is a dummy message.
1780"""
1781
Fred Drakec02bc3e2001-05-21 20:23:21 +00001782class MaildirTestCase(unittest.TestCase):
1783
1784 def setUp(self):
1785 # create a new maildir mailbox to work with:
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001786 self._dir = support.TESTFN
Fred Drakec02bc3e2001-05-21 20:23:21 +00001787 os.mkdir(self._dir)
1788 os.mkdir(os.path.join(self._dir, "cur"))
1789 os.mkdir(os.path.join(self._dir, "tmp"))
1790 os.mkdir(os.path.join(self._dir, "new"))
1791 self._counter = 1
1792 self._msgfiles = []
1793
1794 def tearDown(self):
Guido van Rossumc1f779c2007-07-03 08:25:58 +00001795 list(map(os.unlink, self._msgfiles))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001796 os.rmdir(os.path.join(self._dir, "cur"))
1797 os.rmdir(os.path.join(self._dir, "tmp"))
1798 os.rmdir(os.path.join(self._dir, "new"))
1799 os.rmdir(self._dir)
1800
Skip Montanaro5253da12004-07-24 19:56:03 +00001801 def createMessage(self, dir, mbox=False):
Jack Jansen97df7b62001-06-19 20:20:05 +00001802 t = int(time.time() % 1000000)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001803 pid = self._counter
1804 self._counter += 1
Skip Montanaro7a98be22007-08-16 14:35:24 +00001805 filename = ".".join((str(t), str(pid), "myhostname", "mydomain"))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001806 tmpname = os.path.join(self._dir, "tmp", filename)
1807 newname = os.path.join(self._dir, dir, filename)
Brian Curtin5acec042010-10-13 02:29:46 +00001808 with open(tmpname, "w") as fp:
1809 self._msgfiles.append(tmpname)
1810 if mbox:
1811 fp.write(FROM_)
1812 fp.write(DUMMY_MESSAGE)
Tim Peters6626c1f2001-05-22 16:29:01 +00001813 if hasattr(os, "link"):
1814 os.link(tmpname, newname)
1815 else:
Brian Curtin5acec042010-10-13 02:29:46 +00001816 with open(newname, "w") as fp:
1817 fp.write(DUMMY_MESSAGE)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001818 self._msgfiles.append(newname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001819 return tmpname
Fred Drakec02bc3e2001-05-21 20:23:21 +00001820
1821 def test_empty_maildir(self):
1822 """Test an empty maildir mailbox"""
1823 # Test for regression on bug #117490:
1824 # Make sure the boxes attribute actually gets set.
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001825 self.mbox = mailbox.Maildir(support.TESTFN)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001826 #self.assertTrue(hasattr(self.mbox, "boxes"))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001827 #self.assertEqual(len(self.mbox.boxes), 0)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001828 self.assertIs(self.mbox.next(), None)
1829 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001830
1831 def test_nonempty_maildir_cur(self):
1832 self.createMessage("cur")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001833 self.mbox = mailbox.Maildir(support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001834 #self.assertEqual(len(self.mbox.boxes), 1)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001835 self.assertIsNot(self.mbox.next(), None)
1836 self.assertIs(self.mbox.next(), None)
1837 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001838
1839 def test_nonempty_maildir_new(self):
1840 self.createMessage("new")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001841 self.mbox = mailbox.Maildir(support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001842 #self.assertEqual(len(self.mbox.boxes), 1)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001843 self.assertIsNot(self.mbox.next(), None)
1844 self.assertIs(self.mbox.next(), None)
1845 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001846
1847 def test_nonempty_maildir_both(self):
1848 self.createMessage("cur")
1849 self.createMessage("new")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001850 self.mbox = mailbox.Maildir(support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001851 #self.assertEqual(len(self.mbox.boxes), 2)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001852 self.assertIsNot(self.mbox.next(), None)
1853 self.assertIsNot(self.mbox.next(), None)
1854 self.assertIs(self.mbox.next(), None)
1855 self.assertIs(self.mbox.next(), None)
Fred Drake0aaed272000-10-23 13:39:15 +00001856
Georg Brandledb978f2008-05-11 08:59:40 +00001857## End: tests from the original module (for backward compatibility).
Thomas Wouters477c8d52006-05-27 19:21:47 +00001858
1859
1860_sample_message = """\
1861Return-Path: <gkj@gregorykjohnson.com>
1862X-Original-To: gkj+person@localhost
1863Delivered-To: gkj+person@localhost
1864Received: from localhost (localhost [127.0.0.1])
1865 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1866 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
1867Delivered-To: gkj@sundance.gregorykjohnson.com
1868Received: from localhost [127.0.0.1]
1869 by localhost with POP3 (fetchmail-6.2.5)
1870 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
1871Received: from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
1872 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1873 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
1874Received: by andy.gregorykjohnson.com (Postfix, from userid 1000)
1875 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
1876Date: Wed, 13 Jul 2005 17:23:11 -0400
1877From: "Gregory K. Johnson" <gkj@gregorykjohnson.com>
1878To: gkj@gregorykjohnson.com
1879Subject: Sample message
1880Message-ID: <20050713212311.GC4701@andy.gregorykjohnson.com>
1881Mime-Version: 1.0
1882Content-Type: multipart/mixed; boundary="NMuMz9nt05w80d4+"
1883Content-Disposition: inline
1884User-Agent: Mutt/1.5.9i
1885
1886
1887--NMuMz9nt05w80d4+
1888Content-Type: text/plain; charset=us-ascii
1889Content-Disposition: inline
1890
1891This is a sample message.
1892
1893--
1894Gregory K. Johnson
1895
1896--NMuMz9nt05w80d4+
1897Content-Type: application/octet-stream
1898Content-Disposition: attachment; filename="text.gz"
1899Content-Transfer-Encoding: base64
1900
1901H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
19023FYlAAAA
1903
1904--NMuMz9nt05w80d4+--
1905"""
1906
1907_sample_headers = {
1908 "Return-Path":"<gkj@gregorykjohnson.com>",
1909 "X-Original-To":"gkj+person@localhost",
1910 "Delivered-To":"gkj+person@localhost",
1911 "Received":"""from localhost (localhost [127.0.0.1])
1912 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1913 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
1914 "Delivered-To":"gkj@sundance.gregorykjohnson.com",
1915 "Received":"""from localhost [127.0.0.1]
1916 by localhost with POP3 (fetchmail-6.2.5)
1917 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
1918 "Received":"""from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
1919 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1920 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
1921 "Received":"""by andy.gregorykjohnson.com (Postfix, from userid 1000)
1922 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
1923 "Date":"Wed, 13 Jul 2005 17:23:11 -0400",
1924 "From":""""Gregory K. Johnson" <gkj@gregorykjohnson.com>""",
1925 "To":"gkj@gregorykjohnson.com",
1926 "Subject":"Sample message",
1927 "Mime-Version":"1.0",
1928 "Content-Type":"""multipart/mixed; boundary="NMuMz9nt05w80d4+\"""",
1929 "Content-Disposition":"inline",
1930 "User-Agent": "Mutt/1.5.9i" }
1931
1932_sample_payloads = ("""This is a sample message.
1933
1934--
1935Gregory K. Johnson
1936""",
1937"""H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
19383FYlAAAA
1939""")
Fred Drake0aaed272000-10-23 13:39:15 +00001940
Fred Drakec02bc3e2001-05-21 20:23:21 +00001941
Fred Drake2e2be372001-09-20 21:33:42 +00001942def test_main():
Thomas Wouters477c8d52006-05-27 19:21:47 +00001943 tests = (TestMailboxSuperclass, TestMaildir, TestMbox, TestMMDF, TestMH,
1944 TestBabyl, TestMessage, TestMaildirMessage, TestMboxMessage,
1945 TestMHMessage, TestBabylMessage, TestMMDFMessage,
1946 TestMessageConversion, TestProxyFile, TestPartialFile,
1947 MaildirTestCase)
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001948 support.run_unittest(*tests)
1949 support.reap_children()
Fred Drake2e2be372001-09-20 21:33:42 +00001950
1951
Thomas Wouters477c8d52006-05-27 19:21:47 +00001952if __name__ == '__main__':
Fred Drake2e2be372001-09-20 21:33:42 +00001953 test_main()