blob: 73ee69fc07f49c19941244792282a51f14e7c8ab [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')
589 f = open(foo_path, 'w')
590 f.write("@")
591 f.close()
592 f = open(bar_path, 'w')
593 f.write("@")
594 f.close()
595 self._box.clean()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000596 self.assertTrue(os.path.exists(foo_path))
597 self.assertTrue(os.path.exists(bar_path))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000598 foo_stat = os.stat(foo_path)
599 os.utime(foo_path, (time.time() - 129600 - 2,
600 foo_stat.st_mtime))
601 self._box.clean()
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000602 self.assertFalse(os.path.exists(foo_path))
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000603 self.assertTrue(os.path.exists(bar_path))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000604
605 def test_create_tmp(self, repetitions=10):
606 # Create files in tmp directory
607 hostname = socket.gethostname()
608 if '/' in hostname:
609 hostname = hostname.replace('/', r'\057')
610 if ':' in hostname:
611 hostname = hostname.replace(':', r'\072')
612 pid = os.getpid()
613 pattern = re.compile(r"(?P<time>\d+)\.M(?P<M>\d{1,6})P(?P<P>\d+)"
614 r"Q(?P<Q>\d+)\.(?P<host>[^:/]+)")
615 previous_groups = None
Guido van Rossum805365e2007-05-07 22:24:25 +0000616 for x in range(repetitions):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000617 tmp_file = self._box._create_tmp()
618 head, tail = os.path.split(tmp_file.name)
619 self.assertEqual(head, os.path.abspath(os.path.join(self._path,
620 "tmp")),
621 "File in wrong location: '%s'" % head)
622 match = pattern.match(tail)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000623 self.assertIsNot(match, None, "Invalid file name: '%s'" % tail)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000624 groups = match.groups()
Benjamin Peterson2a691a82008-03-31 01:51:45 +0000625 if previous_groups is not None:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000626 self.assertTrue(int(groups[0] >= previous_groups[0]),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000627 "Non-monotonic seconds: '%s' before '%s'" %
628 (previous_groups[0], groups[0]))
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000629 self.assertTrue(int(groups[1] >= previous_groups[1]) or
Thomas Wouters477c8d52006-05-27 19:21:47 +0000630 groups[0] != groups[1],
631 "Non-monotonic milliseconds: '%s' before '%s'" %
632 (previous_groups[1], groups[1]))
Guido van Rossumea834472007-07-27 05:17:50 +0000633 self.assertEqual(int(groups[2]), pid,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000634 "Process ID mismatch: '%s' should be '%s'" %
635 (groups[2], pid))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000636 self.assertEqual(int(groups[3]), int(previous_groups[3]) + 1,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000637 "Non-sequential counter: '%s' before '%s'" %
638 (previous_groups[3], groups[3]))
Guido van Rossumea834472007-07-27 05:17:50 +0000639 self.assertEqual(groups[4], hostname,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000640 "Host name mismatch: '%s' should be '%s'" %
641 (groups[4], hostname))
642 previous_groups = groups
643 tmp_file.write(_sample_message)
644 tmp_file.seek(0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000645 self.assertEqual(tmp_file.read(), _sample_message)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000646 tmp_file.close()
647 file_count = len(os.listdir(os.path.join(self._path, "tmp")))
Guido van Rossumea834472007-07-27 05:17:50 +0000648 self.assertEqual(file_count, repetitions,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000649 "Wrong file count: '%s' should be '%s'" %
650 (file_count, repetitions))
651
652 def test_refresh(self):
653 # Update the table of contents
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000654 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000655 key0 = self._box.add(self._template % 0)
656 key1 = self._box.add(self._template % 1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000657 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000658 self._box._refresh()
Guido van Rossumea834472007-07-27 05:17:50 +0000659 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
660 key1: os.path.join('new', key1)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000661 key2 = self._box.add(self._template % 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000662 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
663 key1: os.path.join('new', key1)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000664 self._box._refresh()
Guido van Rossumea834472007-07-27 05:17:50 +0000665 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
666 key1: os.path.join('new', key1),
667 key2: os.path.join('new', key2)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000668
669 def test_lookup(self):
670 # Look up message subpaths in the TOC
671 self.assertRaises(KeyError, lambda: self._box._lookup('foo'))
672 key0 = self._box.add(self._template % 0)
Guido van Rossumea834472007-07-27 05:17:50 +0000673 self.assertEqual(self._box._lookup(key0), os.path.join('new', key0))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000674 os.remove(os.path.join(self._path, 'new', key0))
Guido van Rossumea834472007-07-27 05:17:50 +0000675 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0)})
Antoine Pitrou03f13442009-11-02 11:36:51 +0000676 # Be sure that the TOC is read back from disk (see issue #6896
677 # about bad mtime behaviour on some systems).
678 self._box.flush()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000679 self.assertRaises(KeyError, lambda: self._box._lookup(key0))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000680 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000681
682 def test_lock_unlock(self):
683 # Lock and unlock the mailbox. For Maildir, this does nothing.
684 self._box.lock()
685 self._box.unlock()
686
Thomas Wouters89f507f2006-12-13 04:49:30 +0000687 def test_folder (self):
688 # Test for bug #1569790: verify that folders returned by .get_folder()
689 # use the same factory function.
690 def dummy_factory (s):
691 return None
692 box = self._factory(self._path, factory=dummy_factory)
693 folder = box.add_folder('folder1')
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000694 self.assertIs(folder._factory, dummy_factory)
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000695
Thomas Wouters89f507f2006-12-13 04:49:30 +0000696 folder1_alias = box.get_folder('folder1')
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000697 self.assertIs(folder1_alias._factory, dummy_factory)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000698
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000699 def test_directory_in_folder (self):
700 # Test that mailboxes still work if there's a stray extra directory
701 # in a folder.
702 for i in range(10):
703 self._box.add(mailbox.Message(_sample_message))
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000704
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000705 # Create a stray directory
706 os.mkdir(os.path.join(self._path, 'cur', 'stray-dir'))
707
708 # Check that looping still works with the directory present.
709 for msg in self._box:
710 pass
Thomas Wouters477c8d52006-05-27 19:21:47 +0000711
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000712 def test_file_permissions(self):
713 # Verify that message files are created without execute permissions
714 if not hasattr(os, "stat") or not hasattr(os, "umask"):
715 return
716 msg = mailbox.MaildirMessage(self._template % 0)
717 orig_umask = os.umask(0)
718 try:
719 key = self._box.add(msg)
720 finally:
721 os.umask(orig_umask)
722 path = os.path.join(self._path, self._box._lookup(key))
723 mode = os.stat(path).st_mode
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000724 self.assertFalse(mode & 0o111)
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000725
726 def test_folder_file_perms(self):
727 # From bug #3228, we want to verify that the file created inside a Maildir
728 # subfolder isn't marked as executable.
729 if not hasattr(os, "stat") or not hasattr(os, "umask"):
730 return
731
732 orig_umask = os.umask(0)
733 try:
734 subfolder = self._box.add_folder('subfolder')
735 finally:
736 os.umask(orig_umask)
737
738 path = os.path.join(subfolder._path, 'maildirfolder')
739 st = os.stat(path)
740 perms = st.st_mode
741 self.assertFalse((perms & 0o111)) # Execute bits should all be off.
742
Andrew M. Kuchlingfa815342009-05-03 02:52:20 +0000743 def test_reread(self):
744 # Wait for 2 seconds
745 time.sleep(2)
746
747 # Initially, the mailbox has not been read and the time is null.
748 assert getattr(self._box, '_last_read', None) is None
749
750 # Refresh mailbox; the times should now be set to something.
751 self._box._refresh()
752 assert getattr(self._box, '_last_read', None) is not None
753
754 # Try calling _refresh() again; the modification times shouldn't have
755 # changed, so the mailbox should not be re-reading. Re-reading causes
756 # the ._toc attribute to be assigned a new dictionary object, so
757 # we'll check that the ._toc attribute isn't a different object.
758 orig_toc = self._box._toc
759 def refreshed():
760 return self._box._toc is not orig_toc
761
762 time.sleep(1) # Wait 1sec to ensure time.time()'s value changes
763 self._box._refresh()
764 assert not refreshed()
765
766 # Now, write something into cur and remove it. This changes
767 # the mtime and should cause a re-read.
768 filename = os.path.join(self._path, 'cur', 'stray-file')
769 f = open(filename, 'w')
770 f.close()
771 os.unlink(filename)
772 self._box._refresh()
773 assert refreshed()
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000774
Thomas Wouters477c8d52006-05-27 19:21:47 +0000775class _TestMboxMMDF(TestMailbox):
776
777 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +0000778 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000779 self._delete_recursively(self._path)
780 for lock_remnant in glob.glob(self._path + '.*'):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000781 support.unlink(lock_remnant)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000782
783 def test_add_from_string(self):
784 # Add a string starting with 'From ' to the mailbox
785 key = self._box.add('From foo@bar blah\nFrom: foo\n\n0')
Guido van Rossumea834472007-07-27 05:17:50 +0000786 self.assertEqual(self._box[key].get_from(), 'foo@bar blah')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000787 self.assertEqual(self._box[key].get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000788
789 def test_add_mbox_or_mmdf_message(self):
790 # Add an mboxMessage or MMDFMessage
791 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
792 msg = class_('From foo@bar blah\nFrom: foo\n\n0')
793 key = self._box.add(msg)
794
795 def test_open_close_open(self):
796 # Open and inspect previously-created mailbox
Guido van Rossum805365e2007-05-07 22:24:25 +0000797 values = [self._template % i for i in range(3)]
Thomas Wouters477c8d52006-05-27 19:21:47 +0000798 for value in values:
799 self._box.add(value)
800 self._box.close()
801 mtime = os.path.getmtime(self._path)
802 self._box = self._factory(self._path)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000803 self.assertEqual(len(self._box), 3)
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000804 for key in self._box.keys():
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000805 self.assertIn(self._box.get_string(key), values)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000806 self._box.close()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000807 self.assertEqual(mtime, os.path.getmtime(self._path))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000808
809 def test_add_and_close(self):
810 # Verifying that closing a mailbox doesn't change added items
811 self._box.add(_sample_message)
Guido van Rossum805365e2007-05-07 22:24:25 +0000812 for i in range(3):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000813 self._box.add(self._template % i)
814 self._box.add(_sample_message)
815 self._box._file.flush()
816 self._box._file.seek(0)
817 contents = self._box._file.read()
818 self._box.close()
Amaury Forgeot d'Arc9edef042008-03-26 19:49:26 +0000819 self.assertEqual(contents, open(self._path, 'r', newline='').read())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000820 self._box = self._factory(self._path)
821
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000822 def test_lock_conflict(self):
823 # Fork off a subprocess that will lock the file for 2 seconds,
824 # unlock it, and then exit.
825 if not hasattr(os, 'fork'):
826 return
827 pid = os.fork()
828 if pid == 0:
829 # In the child, lock the mailbox.
Guido van Rossum62cbc8a2007-04-09 00:41:25 +0000830 try:
831 self._box.lock()
832 time.sleep(2)
833 self._box.unlock()
834 finally:
835 os._exit(0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000836
837 # In the parent, sleep a bit to give the child time to acquire
838 # the lock.
839 time.sleep(0.5)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000840 try:
841 self.assertRaises(mailbox.ExternalClashError,
842 self._box.lock)
843 finally:
844 # Wait for child to exit. Locking should now succeed.
845 exited_pid, status = os.waitpid(pid, 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000846
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000847 self._box.lock()
848 self._box.unlock()
849
Thomas Wouters89f507f2006-12-13 04:49:30 +0000850 def test_relock(self):
851 # Test case for bug #1575506: the mailbox class was locking the
852 # wrong file object in its flush() method.
853 msg = "Subject: sub\n\nbody\n"
854 key1 = self._box.add(msg)
855 self._box.flush()
856 self._box.close()
857
858 self._box = self._factory(self._path)
859 self._box.lock()
860 key2 = self._box.add(msg)
861 self._box.flush()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000862 self.assertTrue(self._box._locked)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000863 self._box.close()
864
865
Thomas Wouters477c8d52006-05-27 19:21:47 +0000866class TestMbox(_TestMboxMMDF):
867
868 _factory = lambda self, path, factory=None: mailbox.mbox(path, factory)
869
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000870 def test_file_perms(self):
871 # From bug #3228, we want to verify that the mailbox file isn't executable,
872 # even if the umask is set to something that would leave executable bits set.
873 # We only run this test on platforms that support umask.
874 if hasattr(os, 'umask') and hasattr(os, 'stat'):
875 try:
876 old_umask = os.umask(0o077)
877 self._box.close()
878 os.unlink(self._path)
879 self._box = mailbox.mbox(self._path, create=True)
880 self._box.add('')
881 self._box.close()
882 finally:
883 os.umask(old_umask)
884
885 st = os.stat(self._path)
886 perms = st.st_mode
887 self.assertFalse((perms & 0o111)) # Execute bits should all be off.
Thomas Wouters477c8d52006-05-27 19:21:47 +0000888
889class TestMMDF(_TestMboxMMDF):
890
891 _factory = lambda self, path, factory=None: mailbox.MMDF(path, factory)
892
893
894class TestMH(TestMailbox):
895
896 _factory = lambda self, path, factory=None: mailbox.MH(path, factory)
897
898 def test_list_folders(self):
899 # List folders
900 self._box.add_folder('one')
901 self._box.add_folder('two')
902 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000903 self.assertEqual(len(self._box.list_folders()), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000904 self.assertEqual(set(self._box.list_folders()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000905 set(('one', 'two', 'three')))
906
907 def test_get_folder(self):
908 # Open folders
Thomas Wouters89f507f2006-12-13 04:49:30 +0000909 def dummy_factory (s):
910 return None
911 self._box = self._factory(self._path, dummy_factory)
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000912
Thomas Wouters89f507f2006-12-13 04:49:30 +0000913 new_folder = self._box.add_folder('foo.bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000914 folder0 = self._box.get_folder('foo.bar')
915 folder0.add(self._template % 'bar')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000916 self.assertTrue(os.path.isdir(os.path.join(self._path, 'foo.bar')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000917 folder1 = self._box.get_folder('foo.bar')
Guido van Rossumea834472007-07-27 05:17:50 +0000918 self.assertEqual(folder1.get_string(folder1.keys()[0]),
919 self._template % 'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000920
Thomas Wouters89f507f2006-12-13 04:49:30 +0000921 # Test for bug #1569790: verify that folders returned by .get_folder()
922 # use the same factory function.
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000923 self.assertIs(new_folder._factory, self._box._factory)
924 self.assertIs(folder0._factory, self._box._factory)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000925
Thomas Wouters477c8d52006-05-27 19:21:47 +0000926 def test_add_and_remove_folders(self):
927 # Delete folders
928 self._box.add_folder('one')
929 self._box.add_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000930 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000931 self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000932 self._box.remove_folder('one')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000933 self.assertEqual(len(self._box.list_folders()), 1)
934 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000935 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000936 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000937 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000938 self._box.remove_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000939 self.assertEqual(len(self._box.list_folders()), 1)
940 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000941 self._box.remove_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000942 self.assertEqual(len(self._box.list_folders()), 0)
943 self.assertEqual(self._box.list_folders(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000944
945 def test_sequences(self):
946 # Get and set sequences
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000947 self.assertEqual(self._box.get_sequences(), {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000948 msg0 = mailbox.MHMessage(self._template % 0)
949 msg0.add_sequence('foo')
950 key0 = self._box.add(msg0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000951 self.assertEqual(self._box.get_sequences(), {'foo':[key0]})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000952 msg1 = mailbox.MHMessage(self._template % 1)
953 msg1.set_sequences(['bar', 'replied', 'foo'])
954 key1 = self._box.add(msg1)
Guido van Rossumea834472007-07-27 05:17:50 +0000955 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000956 {'foo':[key0, key1], 'bar':[key1], 'replied':[key1]})
957 msg0.set_sequences(['flagged'])
958 self._box[key0] = msg0
Guido van Rossumea834472007-07-27 05:17:50 +0000959 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000960 {'foo':[key1], 'bar':[key1], 'replied':[key1],
961 'flagged':[key0]})
962 self._box.remove(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000963 self.assertEqual(self._box.get_sequences(), {'flagged':[key0]})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000964
R. David Murray548ac412009-04-02 19:44:43 +0000965 def test_issue2625(self):
966 msg0 = mailbox.MHMessage(self._template % 0)
967 msg0.add_sequence('foo')
968 key0 = self._box.add(msg0)
969 refmsg0 = self._box.get_message(key0)
970
Benjamin Peterson21896a32010-03-21 22:03:03 +0000971 def test_issue7627(self):
972 msg0 = mailbox.MHMessage(self._template % 0)
973 key0 = self._box.add(msg0)
974 self._box.lock()
975 self._box.remove(key0)
976 self._box.unlock()
977
Thomas Wouters477c8d52006-05-27 19:21:47 +0000978 def test_pack(self):
979 # Pack the contents of the mailbox
980 msg0 = mailbox.MHMessage(self._template % 0)
981 msg1 = mailbox.MHMessage(self._template % 1)
982 msg2 = mailbox.MHMessage(self._template % 2)
983 msg3 = mailbox.MHMessage(self._template % 3)
984 msg0.set_sequences(['foo', 'unseen'])
985 msg1.set_sequences(['foo'])
986 msg2.set_sequences(['foo', 'flagged'])
987 msg3.set_sequences(['foo', 'bar', 'replied'])
988 key0 = self._box.add(msg0)
989 key1 = self._box.add(msg1)
990 key2 = self._box.add(msg2)
991 key3 = self._box.add(msg3)
Guido van Rossumea834472007-07-27 05:17:50 +0000992 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000993 {'foo':[key0,key1,key2,key3], 'unseen':[key0],
994 'flagged':[key2], 'bar':[key3], 'replied':[key3]})
995 self._box.remove(key2)
Guido van Rossumea834472007-07-27 05:17:50 +0000996 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000997 {'foo':[key0,key1,key3], 'unseen':[key0], 'bar':[key3],
998 'replied':[key3]})
999 self._box.pack()
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001000 self.assertEqual(self._box.keys(), [1, 2, 3])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001001 key0 = key0
1002 key1 = key0 + 1
1003 key2 = key1 + 1
Guido van Rossumea834472007-07-27 05:17:50 +00001004 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +00001005 {'foo':[1, 2, 3], 'unseen':[1], 'bar':[3], 'replied':[3]})
1006
Thomas Wouters89f507f2006-12-13 04:49:30 +00001007 # Test case for packing while holding the mailbox locked.
1008 key0 = self._box.add(msg1)
1009 key1 = self._box.add(msg1)
1010 key2 = self._box.add(msg1)
1011 key3 = self._box.add(msg1)
1012
1013 self._box.remove(key0)
1014 self._box.remove(key2)
1015 self._box.lock()
1016 self._box.pack()
1017 self._box.unlock()
Guido van Rossumea834472007-07-27 05:17:50 +00001018 self.assertEqual(self._box.get_sequences(),
Thomas Wouters89f507f2006-12-13 04:49:30 +00001019 {'foo':[1, 2, 3, 4, 5],
1020 'unseen':[1], 'bar':[3], 'replied':[3]})
Thomas Wouters9fe394c2007-02-05 01:24:16 +00001021
Thomas Wouters477c8d52006-05-27 19:21:47 +00001022 def _get_lock_path(self):
1023 return os.path.join(self._path, '.mh_sequences.lock')
1024
1025
1026class TestBabyl(TestMailbox):
1027
1028 _factory = lambda self, path, factory=None: mailbox.Babyl(path, factory)
1029
1030 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +00001031 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001032 self._delete_recursively(self._path)
1033 for lock_remnant in glob.glob(self._path + '.*'):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001034 support.unlink(lock_remnant)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001035
1036 def test_labels(self):
1037 # Get labels from the mailbox
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001038 self.assertEqual(self._box.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001039 msg0 = mailbox.BabylMessage(self._template % 0)
1040 msg0.add_label('foo')
1041 key0 = self._box.add(msg0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001042 self.assertEqual(self._box.get_labels(), ['foo'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001043 msg1 = mailbox.BabylMessage(self._template % 1)
1044 msg1.set_labels(['bar', 'answered', 'foo'])
1045 key1 = self._box.add(msg1)
Guido van Rossumea834472007-07-27 05:17:50 +00001046 self.assertEqual(set(self._box.get_labels()), set(['foo', 'bar']))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001047 msg0.set_labels(['blah', 'filed'])
1048 self._box[key0] = msg0
Guido van Rossumea834472007-07-27 05:17:50 +00001049 self.assertEqual(set(self._box.get_labels()),
Thomas Wouters477c8d52006-05-27 19:21:47 +00001050 set(['foo', 'bar', 'blah']))
1051 self._box.remove(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001052 self.assertEqual(set(self._box.get_labels()), set(['blah']))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001053
1054
1055class TestMessage(TestBase):
1056
1057 _factory = mailbox.Message # Overridden by subclasses to reuse tests
1058
1059 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001060 self._path = support.TESTFN
Thomas Wouters477c8d52006-05-27 19:21:47 +00001061
1062 def tearDown(self):
1063 self._delete_recursively(self._path)
1064
1065 def test_initialize_with_eMM(self):
Thomas Woutersb2137042007-02-01 18:02:27 +00001066 # Initialize based on email.message.Message instance
Thomas Wouters477c8d52006-05-27 19:21:47 +00001067 eMM = email.message_from_string(_sample_message)
1068 msg = self._factory(eMM)
1069 self._post_initialize_hook(msg)
1070 self._check_sample(msg)
1071
1072 def test_initialize_with_string(self):
1073 # Initialize based on string
1074 msg = self._factory(_sample_message)
1075 self._post_initialize_hook(msg)
1076 self._check_sample(msg)
1077
1078 def test_initialize_with_file(self):
1079 # Initialize based on contents of file
1080 f = open(self._path, 'w+')
1081 f.write(_sample_message)
1082 f.seek(0)
1083 msg = self._factory(f)
1084 self._post_initialize_hook(msg)
1085 self._check_sample(msg)
1086 f.close()
1087
1088 def test_initialize_with_nothing(self):
1089 # Initialize without arguments
1090 msg = self._factory()
1091 self._post_initialize_hook(msg)
Ezio Melottie9615932010-01-24 19:26:24 +00001092 self.assertIsInstance(msg, email.message.Message)
1093 self.assertIsInstance(msg, mailbox.Message)
1094 self.assertIsInstance(msg, self._factory)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001095 self.assertEqual(msg.keys(), [])
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001096 self.assertFalse(msg.is_multipart())
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001097 self.assertEqual(msg.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001098
1099 def test_initialize_incorrectly(self):
1100 # Initialize with invalid argument
1101 self.assertRaises(TypeError, lambda: self._factory(object()))
1102
1103 def test_become_message(self):
1104 # Take on the state of another message
1105 eMM = email.message_from_string(_sample_message)
1106 msg = self._factory()
1107 msg._become_message(eMM)
1108 self._check_sample(msg)
1109
1110 def test_explain_to(self):
1111 # Copy self's format-specific data to other message formats.
1112 # This test is superficial; better ones are in TestMessageConversion.
1113 msg = self._factory()
1114 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1115 mailbox.mboxMessage, mailbox.MHMessage,
1116 mailbox.BabylMessage, mailbox.MMDFMessage):
1117 other_msg = class_()
1118 msg._explain_to(other_msg)
Thomas Woutersb2137042007-02-01 18:02:27 +00001119 other_msg = email.message.Message()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001120 self.assertRaises(TypeError, lambda: msg._explain_to(other_msg))
1121
1122 def _post_initialize_hook(self, msg):
1123 # Overridden by subclasses to check extra things after initialization
1124 pass
1125
1126
1127class TestMaildirMessage(TestMessage):
1128
1129 _factory = mailbox.MaildirMessage
1130
1131 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001132 self.assertEqual(msg._subdir, 'new')
1133 self.assertEqual(msg._info, '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001134
1135 def test_subdir(self):
1136 # Use get_subdir() and set_subdir()
1137 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001138 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001139 msg.set_subdir('cur')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001140 self.assertEqual(msg.get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001141 msg.set_subdir('new')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001142 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001143 self.assertRaises(ValueError, lambda: msg.set_subdir('tmp'))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001144 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001145 msg.set_subdir('new')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001146 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001147 self._check_sample(msg)
1148
1149 def test_flags(self):
1150 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1151 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001152 self.assertEqual(msg.get_flags(), '')
1153 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001154 msg.set_flags('F')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001155 self.assertEqual(msg.get_subdir(), 'new')
1156 self.assertEqual(msg.get_flags(), 'F')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001157 msg.set_flags('SDTP')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001158 self.assertEqual(msg.get_flags(), 'DPST')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001159 msg.add_flag('FT')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001160 self.assertEqual(msg.get_flags(), 'DFPST')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001161 msg.remove_flag('TDRP')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001162 self.assertEqual(msg.get_flags(), 'FS')
1163 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001164 self._check_sample(msg)
1165
1166 def test_date(self):
1167 # Use get_date() and set_date()
1168 msg = mailbox.MaildirMessage(_sample_message)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001169 self.assertLess(abs(msg.get_date() - time.time()), 60)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001170 msg.set_date(0.0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001171 self.assertEqual(msg.get_date(), 0.0)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001172
1173 def test_info(self):
1174 # Use get_info() and set_info()
1175 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001176 self.assertEqual(msg.get_info(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001177 msg.set_info('1,foo=bar')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001178 self.assertEqual(msg.get_info(), '1,foo=bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001179 self.assertRaises(TypeError, lambda: msg.set_info(None))
1180 self._check_sample(msg)
1181
1182 def test_info_and_flags(self):
1183 # Test interaction of info and flag methods
1184 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001185 self.assertEqual(msg.get_info(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001186 msg.set_flags('SF')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001187 self.assertEqual(msg.get_flags(), 'FS')
1188 self.assertEqual(msg.get_info(), '2,FS')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001189 msg.set_info('1,')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001190 self.assertEqual(msg.get_flags(), '')
1191 self.assertEqual(msg.get_info(), '1,')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001192 msg.remove_flag('RPT')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001193 self.assertEqual(msg.get_flags(), '')
1194 self.assertEqual(msg.get_info(), '1,')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001195 msg.add_flag('D')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001196 self.assertEqual(msg.get_flags(), 'D')
1197 self.assertEqual(msg.get_info(), '2,D')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001198 self._check_sample(msg)
1199
1200
1201class _TestMboxMMDFMessage(TestMessage):
1202
1203 _factory = mailbox._mboxMMDFMessage
1204
1205 def _post_initialize_hook(self, msg):
1206 self._check_from(msg)
1207
1208 def test_initialize_with_unixfrom(self):
1209 # Initialize with a message that already has a _unixfrom attribute
1210 msg = mailbox.Message(_sample_message)
1211 msg.set_unixfrom('From foo@bar blah')
1212 msg = mailbox.mboxMessage(msg)
Guido van Rossumea834472007-07-27 05:17:50 +00001213 self.assertEqual(msg.get_from(), 'foo@bar blah', msg.get_from())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001214
1215 def test_from(self):
1216 # Get and set "From " line
1217 msg = mailbox.mboxMessage(_sample_message)
1218 self._check_from(msg)
1219 msg.set_from('foo bar')
Guido van Rossumea834472007-07-27 05:17:50 +00001220 self.assertEqual(msg.get_from(), 'foo bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001221 msg.set_from('foo@bar', True)
1222 self._check_from(msg, 'foo@bar')
1223 msg.set_from('blah@temp', time.localtime())
1224 self._check_from(msg, 'blah@temp')
1225
1226 def test_flags(self):
1227 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1228 msg = mailbox.mboxMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001229 self.assertEqual(msg.get_flags(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001230 msg.set_flags('F')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001231 self.assertEqual(msg.get_flags(), 'F')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001232 msg.set_flags('XODR')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001233 self.assertEqual(msg.get_flags(), 'RODX')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001234 msg.add_flag('FA')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001235 self.assertEqual(msg.get_flags(), 'RODFAX')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001236 msg.remove_flag('FDXA')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001237 self.assertEqual(msg.get_flags(), 'RO')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001238 self._check_sample(msg)
1239
1240 def _check_from(self, msg, sender=None):
1241 # Check contents of "From " line
1242 if sender is None:
1243 sender = "MAILER-DAEMON"
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001244 self.assertTrue(re.match(sender + r" \w{3} \w{3} [\d ]\d [\d ]\d:\d{2}:"
Thomas Wouters477c8d52006-05-27 19:21:47 +00001245 r"\d{2} \d{4}", msg.get_from()) is not None)
1246
1247
1248class TestMboxMessage(_TestMboxMMDFMessage):
1249
1250 _factory = mailbox.mboxMessage
1251
1252
1253class TestMHMessage(TestMessage):
1254
1255 _factory = mailbox.MHMessage
1256
1257 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001258 self.assertEqual(msg._sequences, [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001259
1260 def test_sequences(self):
1261 # Get, set, join, and leave sequences
1262 msg = mailbox.MHMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001263 self.assertEqual(msg.get_sequences(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001264 msg.set_sequences(['foobar'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001265 self.assertEqual(msg.get_sequences(), ['foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001266 msg.set_sequences([])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001267 self.assertEqual(msg.get_sequences(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001268 msg.add_sequence('unseen')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001269 self.assertEqual(msg.get_sequences(), ['unseen'])
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.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001273 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001274 msg.remove_sequence('unseen')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001275 self.assertEqual(msg.get_sequences(), ['flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001276 msg.add_sequence('foobar')
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.remove_sequence('replied')
Guido van Rossumea834472007-07-27 05:17:50 +00001279 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001280 msg.set_sequences(['foobar', 'replied'])
Guido van Rossumea834472007-07-27 05:17:50 +00001281 self.assertEqual(msg.get_sequences(), ['foobar', 'replied'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001282
1283
1284class TestBabylMessage(TestMessage):
1285
1286 _factory = mailbox.BabylMessage
1287
1288 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001289 self.assertEqual(msg._labels, [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001290
1291 def test_labels(self):
1292 # Get, set, join, and leave labels
1293 msg = mailbox.BabylMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001294 self.assertEqual(msg.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001295 msg.set_labels(['foobar'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001296 self.assertEqual(msg.get_labels(), ['foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001297 msg.set_labels([])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001298 self.assertEqual(msg.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001299 msg.add_label('filed')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001300 self.assertEqual(msg.get_labels(), ['filed'])
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.add_label('resent')
Guido van Rossumea834472007-07-27 05:17:50 +00001304 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001305 msg.remove_label('filed')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001306 self.assertEqual(msg.get_labels(), ['resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001307 msg.add_label('foobar')
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.remove_label('unseen')
Guido van Rossumea834472007-07-27 05:17:50 +00001310 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001311 msg.set_labels(['foobar', 'answered'])
Guido van Rossumea834472007-07-27 05:17:50 +00001312 self.assertEqual(msg.get_labels(), ['foobar', 'answered'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001313
1314 def test_visible(self):
1315 # Get, set, and update visible headers
1316 msg = mailbox.BabylMessage(_sample_message)
1317 visible = msg.get_visible()
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001318 self.assertEqual(visible.keys(), [])
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001319 self.assertIs(visible.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001320 visible['User-Agent'] = 'FooBar 1.0'
1321 visible['X-Whatever'] = 'Blah'
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001322 self.assertEqual(msg.get_visible().keys(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001323 msg.set_visible(visible)
1324 visible = msg.get_visible()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001325 self.assertTrue(visible.keys() == ['User-Agent', 'X-Whatever'])
1326 self.assertTrue(visible['User-Agent'] == 'FooBar 1.0')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001327 self.assertEqual(visible['X-Whatever'], 'Blah')
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001328 self.assertIs(visible.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001329 msg.update_visible()
Guido van Rossumea834472007-07-27 05:17:50 +00001330 self.assertEqual(visible.keys(), ['User-Agent', 'X-Whatever'])
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001331 self.assertIs(visible.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001332 visible = msg.get_visible()
Guido van Rossumea834472007-07-27 05:17:50 +00001333 self.assertEqual(visible.keys(), ['User-Agent', 'Date', 'From', 'To',
1334 'Subject'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001335 for header in ('User-Agent', 'Date', 'From', 'To', 'Subject'):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001336 self.assertEqual(visible[header], msg[header])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001337
1338
1339class TestMMDFMessage(_TestMboxMMDFMessage):
1340
1341 _factory = mailbox.MMDFMessage
1342
1343
1344class TestMessageConversion(TestBase):
1345
1346 def test_plain_to_x(self):
1347 # Convert Message to all formats
1348 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1349 mailbox.mboxMessage, mailbox.MHMessage,
1350 mailbox.BabylMessage, mailbox.MMDFMessage):
1351 msg_plain = mailbox.Message(_sample_message)
1352 msg = class_(msg_plain)
1353 self._check_sample(msg)
1354
1355 def test_x_to_plain(self):
1356 # Convert all formats to Message
1357 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1358 mailbox.mboxMessage, mailbox.MHMessage,
1359 mailbox.BabylMessage, mailbox.MMDFMessage):
1360 msg = class_(_sample_message)
1361 msg_plain = mailbox.Message(msg)
1362 self._check_sample(msg_plain)
1363
1364 def test_x_to_invalid(self):
1365 # Convert all formats to an invalid format
1366 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1367 mailbox.mboxMessage, mailbox.MHMessage,
1368 mailbox.BabylMessage, mailbox.MMDFMessage):
1369 self.assertRaises(TypeError, lambda: class_(False))
1370
1371 def test_maildir_to_maildir(self):
1372 # Convert MaildirMessage to MaildirMessage
1373 msg_maildir = mailbox.MaildirMessage(_sample_message)
1374 msg_maildir.set_flags('DFPRST')
1375 msg_maildir.set_subdir('cur')
1376 date = msg_maildir.get_date()
1377 msg = mailbox.MaildirMessage(msg_maildir)
1378 self._check_sample(msg)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001379 self.assertEqual(msg.get_flags(), 'DFPRST')
1380 self.assertEqual(msg.get_subdir(), 'cur')
1381 self.assertEqual(msg.get_date(), date)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001382
1383 def test_maildir_to_mboxmmdf(self):
1384 # Convert MaildirMessage to mboxmessage and MMDFMessage
1385 pairs = (('D', ''), ('F', 'F'), ('P', ''), ('R', 'A'), ('S', 'R'),
1386 ('T', 'D'), ('DFPRST', 'RDFA'))
1387 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1388 msg_maildir = mailbox.MaildirMessage(_sample_message)
1389 msg_maildir.set_date(0.0)
1390 for setting, result in pairs:
1391 msg_maildir.set_flags(setting)
1392 msg = class_(msg_maildir)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001393 self.assertEqual(msg.get_flags(), result)
Guido van Rossumea834472007-07-27 05:17:50 +00001394 self.assertEqual(msg.get_from(), 'MAILER-DAEMON %s' %
Thomas Wouters477c8d52006-05-27 19:21:47 +00001395 time.asctime(time.gmtime(0.0)))
1396 msg_maildir.set_subdir('cur')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001397 self.assertEqual(class_(msg_maildir).get_flags(), 'RODFA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001398
1399 def test_maildir_to_mh(self):
1400 # Convert MaildirMessage to MHMessage
1401 msg_maildir = mailbox.MaildirMessage(_sample_message)
1402 pairs = (('D', ['unseen']), ('F', ['unseen', 'flagged']),
1403 ('P', ['unseen']), ('R', ['unseen', 'replied']), ('S', []),
1404 ('T', ['unseen']), ('DFPRST', ['replied', 'flagged']))
1405 for setting, result in pairs:
1406 msg_maildir.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001407 self.assertEqual(mailbox.MHMessage(msg_maildir).get_sequences(),
1408 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001409
1410 def test_maildir_to_babyl(self):
1411 # Convert MaildirMessage to Babyl
1412 msg_maildir = mailbox.MaildirMessage(_sample_message)
1413 pairs = (('D', ['unseen']), ('F', ['unseen']),
1414 ('P', ['unseen', 'forwarded']), ('R', ['unseen', 'answered']),
1415 ('S', []), ('T', ['unseen', 'deleted']),
1416 ('DFPRST', ['deleted', 'answered', 'forwarded']))
1417 for setting, result in pairs:
1418 msg_maildir.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001419 self.assertEqual(mailbox.BabylMessage(msg_maildir).get_labels(),
1420 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001421
1422 def test_mboxmmdf_to_maildir(self):
1423 # Convert mboxMessage and MMDFMessage to MaildirMessage
1424 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1425 msg_mboxMMDF = class_(_sample_message)
1426 msg_mboxMMDF.set_from('foo@bar', time.gmtime(0.0))
1427 pairs = (('R', 'S'), ('O', ''), ('D', 'T'), ('F', 'F'), ('A', 'R'),
1428 ('RODFA', 'FRST'))
1429 for setting, result in pairs:
1430 msg_mboxMMDF.set_flags(setting)
1431 msg = mailbox.MaildirMessage(msg_mboxMMDF)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001432 self.assertEqual(msg.get_flags(), result)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001433 self.assertEqual(msg.get_date(), 0.0)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001434 msg_mboxMMDF.set_flags('O')
Guido van Rossumea834472007-07-27 05:17:50 +00001435 self.assertEqual(mailbox.MaildirMessage(msg_mboxMMDF).get_subdir(),
1436 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001437
1438 def test_mboxmmdf_to_mboxmmdf(self):
1439 # Convert mboxMessage and MMDFMessage to mboxMessage and MMDFMessage
1440 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1441 msg_mboxMMDF = class_(_sample_message)
1442 msg_mboxMMDF.set_flags('RODFA')
1443 msg_mboxMMDF.set_from('foo@bar')
1444 for class2_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1445 msg2 = class2_(msg_mboxMMDF)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001446 self.assertEqual(msg2.get_flags(), 'RODFA')
1447 self.assertEqual(msg2.get_from(), 'foo@bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001448
1449 def test_mboxmmdf_to_mh(self):
1450 # Convert mboxMessage and MMDFMessage to MHMessage
1451 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1452 msg_mboxMMDF = class_(_sample_message)
1453 pairs = (('R', []), ('O', ['unseen']), ('D', ['unseen']),
1454 ('F', ['unseen', 'flagged']),
1455 ('A', ['unseen', 'replied']),
1456 ('RODFA', ['replied', 'flagged']))
1457 for setting, result in pairs:
1458 msg_mboxMMDF.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001459 self.assertEqual(mailbox.MHMessage(msg_mboxMMDF).get_sequences(),
1460 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001461
1462 def test_mboxmmdf_to_babyl(self):
1463 # Convert mboxMessage and MMDFMessage to BabylMessage
1464 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1465 msg = class_(_sample_message)
1466 pairs = (('R', []), ('O', ['unseen']),
1467 ('D', ['unseen', 'deleted']), ('F', ['unseen']),
1468 ('A', ['unseen', 'answered']),
1469 ('RODFA', ['deleted', 'answered']))
1470 for setting, result in pairs:
1471 msg.set_flags(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001472 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001473
1474 def test_mh_to_maildir(self):
1475 # Convert MHMessage to MaildirMessage
1476 pairs = (('unseen', ''), ('replied', 'RS'), ('flagged', 'FS'))
1477 for setting, result in pairs:
1478 msg = mailbox.MHMessage(_sample_message)
1479 msg.add_sequence(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001480 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1481 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001482 msg = mailbox.MHMessage(_sample_message)
1483 msg.add_sequence('unseen')
1484 msg.add_sequence('replied')
1485 msg.add_sequence('flagged')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001486 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'FR')
1487 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001488
1489 def test_mh_to_mboxmmdf(self):
1490 # Convert MHMessage to mboxMessage and MMDFMessage
1491 pairs = (('unseen', 'O'), ('replied', 'ROA'), ('flagged', 'ROF'))
1492 for setting, result in pairs:
1493 msg = mailbox.MHMessage(_sample_message)
1494 msg.add_sequence(setting)
1495 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001496 self.assertEqual(class_(msg).get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001497 msg = mailbox.MHMessage(_sample_message)
1498 msg.add_sequence('unseen')
1499 msg.add_sequence('replied')
1500 msg.add_sequence('flagged')
1501 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001502 self.assertEqual(class_(msg).get_flags(), 'OFA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001503
1504 def test_mh_to_mh(self):
1505 # Convert MHMessage to MHMessage
1506 msg = mailbox.MHMessage(_sample_message)
1507 msg.add_sequence('unseen')
1508 msg.add_sequence('replied')
1509 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001510 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1511 ['unseen', 'replied', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001512
1513 def test_mh_to_babyl(self):
1514 # Convert MHMessage to BabylMessage
1515 pairs = (('unseen', ['unseen']), ('replied', ['answered']),
1516 ('flagged', []))
1517 for setting, result in pairs:
1518 msg = mailbox.MHMessage(_sample_message)
1519 msg.add_sequence(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001520 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001521 msg = mailbox.MHMessage(_sample_message)
1522 msg.add_sequence('unseen')
1523 msg.add_sequence('replied')
1524 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001525 self.assertEqual(mailbox.BabylMessage(msg).get_labels(),
1526 ['unseen', 'answered'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001527
1528 def test_babyl_to_maildir(self):
1529 # Convert BabylMessage to MaildirMessage
1530 pairs = (('unseen', ''), ('deleted', 'ST'), ('filed', 'S'),
1531 ('answered', 'RS'), ('forwarded', 'PS'), ('edited', 'S'),
1532 ('resent', 'PS'))
1533 for setting, result in pairs:
1534 msg = mailbox.BabylMessage(_sample_message)
1535 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001536 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1537 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001538 msg = mailbox.BabylMessage(_sample_message)
1539 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1540 'edited', 'resent'):
1541 msg.add_label(label)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001542 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'PRT')
1543 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001544
1545 def test_babyl_to_mboxmmdf(self):
1546 # Convert BabylMessage to mboxMessage and MMDFMessage
1547 pairs = (('unseen', 'O'), ('deleted', 'ROD'), ('filed', 'RO'),
1548 ('answered', 'ROA'), ('forwarded', 'RO'), ('edited', 'RO'),
1549 ('resent', 'RO'))
1550 for setting, result in pairs:
1551 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1552 msg = mailbox.BabylMessage(_sample_message)
1553 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001554 self.assertEqual(class_(msg).get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001555 msg = mailbox.BabylMessage(_sample_message)
1556 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1557 'edited', 'resent'):
1558 msg.add_label(label)
1559 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001560 self.assertEqual(class_(msg).get_flags(), 'ODA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001561
1562 def test_babyl_to_mh(self):
1563 # Convert BabylMessage to MHMessage
1564 pairs = (('unseen', ['unseen']), ('deleted', []), ('filed', []),
1565 ('answered', ['replied']), ('forwarded', []), ('edited', []),
1566 ('resent', []))
1567 for setting, result in pairs:
1568 msg = mailbox.BabylMessage(_sample_message)
1569 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001570 self.assertEqual(mailbox.MHMessage(msg).get_sequences(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001571 msg = mailbox.BabylMessage(_sample_message)
1572 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1573 'edited', 'resent'):
1574 msg.add_label(label)
Guido van Rossumea834472007-07-27 05:17:50 +00001575 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1576 ['unseen', 'replied'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001577
1578 def test_babyl_to_babyl(self):
1579 # Convert BabylMessage to BabylMessage
1580 msg = mailbox.BabylMessage(_sample_message)
1581 msg.update_visible()
1582 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1583 'edited', 'resent'):
1584 msg.add_label(label)
1585 msg2 = mailbox.BabylMessage(msg)
Guido van Rossumea834472007-07-27 05:17:50 +00001586 self.assertEqual(msg2.get_labels(), ['unseen', 'deleted', 'filed',
1587 'answered', 'forwarded', 'edited',
1588 'resent'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001589 self.assertEqual(msg.get_visible().keys(), msg2.get_visible().keys())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001590 for key in msg.get_visible().keys():
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001591 self.assertEqual(msg.get_visible()[key], msg2.get_visible()[key])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001592
1593
1594class TestProxyFileBase(TestBase):
1595
1596 def _test_read(self, proxy):
1597 # Read by byte
1598 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001599 self.assertEqual(proxy.read(), b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001600 proxy.seek(1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001601 self.assertEqual(proxy.read(), b'ar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001602 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001603 self.assertEqual(proxy.read(2), b'ba')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001604 proxy.seek(1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001605 self.assertEqual(proxy.read(-1), b'ar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001606 proxy.seek(2)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001607 self.assertEqual(proxy.read(1000), b'r')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001608
1609 def _test_readline(self, proxy):
1610 # Read by line
Guido van Rossum98297ee2007-11-06 21:34:58 +00001611 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001612 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001613 self.assertEqual(proxy.readline(), b'foo' + linesep)
1614 self.assertEqual(proxy.readline(), b'bar' + linesep)
1615 self.assertEqual(proxy.readline(), b'fred' + linesep)
1616 self.assertEqual(proxy.readline(), b'bob')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001617 proxy.seek(2)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001618 self.assertEqual(proxy.readline(), b'o' + 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(), b'fred' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001621 proxy.seek(6 + 2 * len(os.linesep))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001622 self.assertEqual(proxy.readline(2), b'fr')
1623 self.assertEqual(proxy.readline(-10), b'ed' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001624
1625 def _test_readlines(self, proxy):
1626 # Read multiple lines
Guido van Rossum98297ee2007-11-06 21:34:58 +00001627 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001628 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001629 self.assertEqual(proxy.readlines(), [b'foo' + linesep,
1630 b'bar' + linesep,
1631 b'fred' + linesep, b'bob'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001632 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001633 self.assertEqual(proxy.readlines(2), [b'foo' + linesep])
1634 proxy.seek(3 + len(linesep))
1635 self.assertEqual(proxy.readlines(4 + len(linesep)),
1636 [b'bar' + linesep, b'fred' + linesep])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001637 proxy.seek(3)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001638 self.assertEqual(proxy.readlines(1000), [linesep, b'bar' + linesep,
1639 b'fred' + linesep, b'bob'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001640
1641 def _test_iteration(self, proxy):
1642 # Iterate by line
Guido van Rossum98297ee2007-11-06 21:34:58 +00001643 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001644 proxy.seek(0)
1645 iterator = iter(proxy)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001646 self.assertEqual(next(iterator), b'foo' + linesep)
1647 self.assertEqual(next(iterator), b'bar' + linesep)
1648 self.assertEqual(next(iterator), b'fred' + linesep)
1649 self.assertEqual(next(iterator), b'bob')
Georg Brandla18af4e2007-04-21 15:47:16 +00001650 self.assertRaises(StopIteration, next, iterator)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001651
1652 def _test_seek_and_tell(self, proxy):
1653 # Seek and use tell to check position
Guido van Rossum98297ee2007-11-06 21:34:58 +00001654 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001655 proxy.seek(3)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001656 self.assertEqual(proxy.tell(), 3)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001657 self.assertEqual(proxy.read(len(linesep)), linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001658 proxy.seek(2, 1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001659 self.assertEqual(proxy.read(1 + len(linesep)), b'r' + linesep)
1660 proxy.seek(-3 - len(linesep), 2)
1661 self.assertEqual(proxy.read(3), b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001662 proxy.seek(2, 0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001663 self.assertEqual(proxy.read(), b'o' + linesep + b'bar' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001664 proxy.seek(100)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001665 self.assertFalse(proxy.read())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001666
1667 def _test_close(self, proxy):
1668 # Close a file
1669 proxy.close()
1670 self.assertRaises(AttributeError, lambda: proxy.close())
1671
1672
1673class TestProxyFile(TestProxyFileBase):
1674
1675 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001676 self._path = support.TESTFN
Thomas Wouters477c8d52006-05-27 19:21:47 +00001677 self._file = open(self._path, 'wb+')
1678
1679 def tearDown(self):
1680 self._file.close()
1681 self._delete_recursively(self._path)
1682
1683 def test_initialize(self):
1684 # Initialize and check position
Neal Norwitz9a923102007-08-30 06:20:05 +00001685 self._file.write(b'foo')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001686 pos = self._file.tell()
1687 proxy0 = mailbox._ProxyFile(self._file)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001688 self.assertEqual(proxy0.tell(), pos)
1689 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001690 proxy1 = mailbox._ProxyFile(self._file, 0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001691 self.assertEqual(proxy1.tell(), 0)
1692 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001693
1694 def test_read(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001695 self._file.write(b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001696 self._test_read(mailbox._ProxyFile(self._file))
1697
1698 def test_readline(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001699 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1700 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001701 self._test_readline(mailbox._ProxyFile(self._file))
1702
1703 def test_readlines(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001704 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1705 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001706 self._test_readlines(mailbox._ProxyFile(self._file))
1707
1708 def test_iteration(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001709 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1710 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001711 self._test_iteration(mailbox._ProxyFile(self._file))
1712
1713 def test_seek_and_tell(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001714 self._file.write(bytes('foo%sbar%s' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001715 self._test_seek_and_tell(mailbox._ProxyFile(self._file))
1716
1717 def test_close(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001718 self._file.write(bytes('foo%sbar%s' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001719 self._test_close(mailbox._ProxyFile(self._file))
1720
1721
1722class TestPartialFile(TestProxyFileBase):
1723
1724 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001725 self._path = support.TESTFN
Thomas Wouters477c8d52006-05-27 19:21:47 +00001726 self._file = open(self._path, 'wb+')
1727
1728 def tearDown(self):
1729 self._file.close()
1730 self._delete_recursively(self._path)
1731
1732 def test_initialize(self):
1733 # Initialize and check position
Neal Norwitz9a923102007-08-30 06:20:05 +00001734 self._file.write(bytes('foo' + os.linesep + 'bar', 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001735 pos = self._file.tell()
1736 proxy = mailbox._PartialFile(self._file, 2, 5)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001737 self.assertEqual(proxy.tell(), 0)
1738 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001739
1740 def test_read(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001741 self._file.write(bytes('***bar***', 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001742 self._test_read(mailbox._PartialFile(self._file, 3, 6))
1743
1744 def test_readline(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001745 self._file.write(bytes('!!!!!foo%sbar%sfred%sbob!!!!!' %
1746 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001747 self._test_readline(mailbox._PartialFile(self._file, 5,
1748 18 + 3 * len(os.linesep)))
1749
1750 def test_readlines(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001751 self._file.write(bytes('foo%sbar%sfred%sbob?????' %
1752 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001753 self._test_readlines(mailbox._PartialFile(self._file, 0,
1754 13 + 3 * len(os.linesep)))
1755
1756 def test_iteration(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001757 self._file.write(bytes('____foo%sbar%sfred%sbob####' %
1758 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001759 self._test_iteration(mailbox._PartialFile(self._file, 4,
1760 17 + 3 * len(os.linesep)))
1761
1762 def test_seek_and_tell(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001763 self._file.write(bytes('(((foo%sbar%s$$$' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001764 self._test_seek_and_tell(mailbox._PartialFile(self._file, 3,
1765 9 + 2 * len(os.linesep)))
1766
1767 def test_close(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001768 self._file.write(bytes('&foo%sbar%s^' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001769 self._test_close(mailbox._PartialFile(self._file, 1,
1770 6 + 3 * len(os.linesep)))
1771
1772
1773## Start: tests from the original module (for backward compatibility).
1774
Skip Montanaro5253da12004-07-24 19:56:03 +00001775FROM_ = "From some.body@dummy.domain Sat Jul 24 13:43:35 2004\n"
Fred Drakec02bc3e2001-05-21 20:23:21 +00001776DUMMY_MESSAGE = """\
1777From: some.body@dummy.domain
1778To: me@my.domain
Skip Montanaro5253da12004-07-24 19:56:03 +00001779Subject: Simple Test
Fred Drakec02bc3e2001-05-21 20:23:21 +00001780
1781This is a dummy message.
1782"""
1783
Fred Drakec02bc3e2001-05-21 20:23:21 +00001784class MaildirTestCase(unittest.TestCase):
1785
1786 def setUp(self):
1787 # create a new maildir mailbox to work with:
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001788 self._dir = support.TESTFN
Fred Drakec02bc3e2001-05-21 20:23:21 +00001789 os.mkdir(self._dir)
1790 os.mkdir(os.path.join(self._dir, "cur"))
1791 os.mkdir(os.path.join(self._dir, "tmp"))
1792 os.mkdir(os.path.join(self._dir, "new"))
1793 self._counter = 1
1794 self._msgfiles = []
1795
1796 def tearDown(self):
Guido van Rossumc1f779c2007-07-03 08:25:58 +00001797 list(map(os.unlink, self._msgfiles))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001798 os.rmdir(os.path.join(self._dir, "cur"))
1799 os.rmdir(os.path.join(self._dir, "tmp"))
1800 os.rmdir(os.path.join(self._dir, "new"))
1801 os.rmdir(self._dir)
1802
Skip Montanaro5253da12004-07-24 19:56:03 +00001803 def createMessage(self, dir, mbox=False):
Jack Jansen97df7b62001-06-19 20:20:05 +00001804 t = int(time.time() % 1000000)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001805 pid = self._counter
1806 self._counter += 1
Skip Montanaro7a98be22007-08-16 14:35:24 +00001807 filename = ".".join((str(t), str(pid), "myhostname", "mydomain"))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001808 tmpname = os.path.join(self._dir, "tmp", filename)
1809 newname = os.path.join(self._dir, dir, filename)
1810 fp = open(tmpname, "w")
1811 self._msgfiles.append(tmpname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001812 if mbox:
1813 fp.write(FROM_)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001814 fp.write(DUMMY_MESSAGE)
1815 fp.close()
Tim Peters6626c1f2001-05-22 16:29:01 +00001816 if hasattr(os, "link"):
1817 os.link(tmpname, newname)
1818 else:
1819 fp = open(newname, "w")
1820 fp.write(DUMMY_MESSAGE)
1821 fp.close()
Fred Drakec02bc3e2001-05-21 20:23:21 +00001822 self._msgfiles.append(newname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001823 return tmpname
Fred Drakec02bc3e2001-05-21 20:23:21 +00001824
1825 def test_empty_maildir(self):
1826 """Test an empty maildir mailbox"""
1827 # Test for regression on bug #117490:
1828 # Make sure the boxes attribute actually gets set.
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001829 self.mbox = mailbox.Maildir(support.TESTFN)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001830 #self.assertTrue(hasattr(self.mbox, "boxes"))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001831 #self.assertEqual(len(self.mbox.boxes), 0)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001832 self.assertIs(self.mbox.next(), None)
1833 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001834
1835 def test_nonempty_maildir_cur(self):
1836 self.createMessage("cur")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001837 self.mbox = mailbox.Maildir(support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001838 #self.assertEqual(len(self.mbox.boxes), 1)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001839 self.assertIsNot(self.mbox.next(), None)
1840 self.assertIs(self.mbox.next(), None)
1841 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001842
1843 def test_nonempty_maildir_new(self):
1844 self.createMessage("new")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001845 self.mbox = mailbox.Maildir(support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001846 #self.assertEqual(len(self.mbox.boxes), 1)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001847 self.assertIsNot(self.mbox.next(), None)
1848 self.assertIs(self.mbox.next(), None)
1849 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001850
1851 def test_nonempty_maildir_both(self):
1852 self.createMessage("cur")
1853 self.createMessage("new")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001854 self.mbox = mailbox.Maildir(support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001855 #self.assertEqual(len(self.mbox.boxes), 2)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001856 self.assertIsNot(self.mbox.next(), None)
1857 self.assertIsNot(self.mbox.next(), None)
1858 self.assertIs(self.mbox.next(), None)
1859 self.assertIs(self.mbox.next(), None)
Fred Drake0aaed272000-10-23 13:39:15 +00001860
Georg Brandledb978f2008-05-11 08:59:40 +00001861## End: tests from the original module (for backward compatibility).
Thomas Wouters477c8d52006-05-27 19:21:47 +00001862
1863
1864_sample_message = """\
1865Return-Path: <gkj@gregorykjohnson.com>
1866X-Original-To: gkj+person@localhost
1867Delivered-To: gkj+person@localhost
1868Received: from localhost (localhost [127.0.0.1])
1869 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1870 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
1871Delivered-To: gkj@sundance.gregorykjohnson.com
1872Received: from localhost [127.0.0.1]
1873 by localhost with POP3 (fetchmail-6.2.5)
1874 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
1875Received: from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
1876 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1877 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
1878Received: by andy.gregorykjohnson.com (Postfix, from userid 1000)
1879 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
1880Date: Wed, 13 Jul 2005 17:23:11 -0400
1881From: "Gregory K. Johnson" <gkj@gregorykjohnson.com>
1882To: gkj@gregorykjohnson.com
1883Subject: Sample message
1884Message-ID: <20050713212311.GC4701@andy.gregorykjohnson.com>
1885Mime-Version: 1.0
1886Content-Type: multipart/mixed; boundary="NMuMz9nt05w80d4+"
1887Content-Disposition: inline
1888User-Agent: Mutt/1.5.9i
1889
1890
1891--NMuMz9nt05w80d4+
1892Content-Type: text/plain; charset=us-ascii
1893Content-Disposition: inline
1894
1895This is a sample message.
1896
1897--
1898Gregory K. Johnson
1899
1900--NMuMz9nt05w80d4+
1901Content-Type: application/octet-stream
1902Content-Disposition: attachment; filename="text.gz"
1903Content-Transfer-Encoding: base64
1904
1905H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
19063FYlAAAA
1907
1908--NMuMz9nt05w80d4+--
1909"""
1910
1911_sample_headers = {
1912 "Return-Path":"<gkj@gregorykjohnson.com>",
1913 "X-Original-To":"gkj+person@localhost",
1914 "Delivered-To":"gkj+person@localhost",
1915 "Received":"""from localhost (localhost [127.0.0.1])
1916 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1917 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
1918 "Delivered-To":"gkj@sundance.gregorykjohnson.com",
1919 "Received":"""from localhost [127.0.0.1]
1920 by localhost with POP3 (fetchmail-6.2.5)
1921 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
1922 "Received":"""from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
1923 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1924 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
1925 "Received":"""by andy.gregorykjohnson.com (Postfix, from userid 1000)
1926 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
1927 "Date":"Wed, 13 Jul 2005 17:23:11 -0400",
1928 "From":""""Gregory K. Johnson" <gkj@gregorykjohnson.com>""",
1929 "To":"gkj@gregorykjohnson.com",
1930 "Subject":"Sample message",
1931 "Mime-Version":"1.0",
1932 "Content-Type":"""multipart/mixed; boundary="NMuMz9nt05w80d4+\"""",
1933 "Content-Disposition":"inline",
1934 "User-Agent": "Mutt/1.5.9i" }
1935
1936_sample_payloads = ("""This is a sample message.
1937
1938--
1939Gregory K. Johnson
1940""",
1941"""H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
19423FYlAAAA
1943""")
Fred Drake0aaed272000-10-23 13:39:15 +00001944
Fred Drakec02bc3e2001-05-21 20:23:21 +00001945
Fred Drake2e2be372001-09-20 21:33:42 +00001946def test_main():
Thomas Wouters477c8d52006-05-27 19:21:47 +00001947 tests = (TestMailboxSuperclass, TestMaildir, TestMbox, TestMMDF, TestMH,
1948 TestBabyl, TestMessage, TestMaildirMessage, TestMboxMessage,
1949 TestMHMessage, TestBabylMessage, TestMMDFMessage,
1950 TestMessageConversion, TestProxyFile, TestPartialFile,
1951 MaildirTestCase)
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001952 support.run_unittest(*tests)
1953 support.reap_children()
Fred Drake2e2be372001-09-20 21:33:42 +00001954
1955
Thomas Wouters477c8d52006-05-27 19:21:47 +00001956if __name__ == '__main__':
Fred Drake2e2be372001-09-20 21:33:42 +00001957 test_main()