blob: dd13c72e994af3d6f36b5fff59d0c6f4a5676b21 [file] [log] [blame]
Fred Drake0aaed272000-10-23 13:39:15 +00001import os
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00002import sys
Fred Drakec02bc3e2001-05-21 20:23:21 +00003import time
Thomas Wouters477c8d52006-05-27 19:21:47 +00004import stat
5import socket
6import email
Thomas Woutersb2137042007-02-01 18:02:27 +00007import email.message
Thomas Wouters477c8d52006-05-27 19:21:47 +00008import re
Guido van Rossum34d19282007-08-09 01:03:29 +00009import io
Benjamin Petersonee8712c2008-05-20 21:35:26 +000010from test import support
Thomas Wouters477c8d52006-05-27 19:21:47 +000011import unittest
12import mailbox
13import glob
Guido van Rossum75ebb292001-04-10 15:01:20 +000014try:
Thomas Wouters477c8d52006-05-27 19:21:47 +000015 import fcntl
16except ImportError:
Guido van Rossum75ebb292001-04-10 15:01:20 +000017 pass
18
Thomas Wouters477c8d52006-05-27 19:21:47 +000019
20class TestBase(unittest.TestCase):
21
22 def _check_sample(self, msg):
23 # Inspect a mailbox.Message representation of the sample message
Georg Brandlab91fde2009-08-13 08:51:18 +000024 self.assertTrue(isinstance(msg, email.message.Message))
25 self.assertTrue(isinstance(msg, mailbox.Message))
Guido van Rossumcc2b0162007-02-11 06:12:03 +000026 for key, value in _sample_headers.items():
Georg Brandl194da4a2009-08-13 09:34:05 +000027 self.assertIn(value, msg.get_all(key))
Georg Brandlab91fde2009-08-13 08:51:18 +000028 self.assertTrue(msg.is_multipart())
Guido van Rossume61fd5b2007-07-11 12:20:59 +000029 self.assertEqual(len(msg.get_payload()), len(_sample_payloads))
Thomas Wouters477c8d52006-05-27 19:21:47 +000030 for i, payload in enumerate(_sample_payloads):
31 part = msg.get_payload(i)
Georg Brandlab91fde2009-08-13 08:51:18 +000032 self.assertTrue(isinstance(part, email.message.Message))
Georg Brandl194da4a2009-08-13 09:34:05 +000033 self.assertFalse(isinstance(part, mailbox.Message))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000034 self.assertEqual(part.get_payload(), payload)
Thomas Wouters477c8d52006-05-27 19:21:47 +000035
36 def _delete_recursively(self, target):
37 # Delete a file or delete a directory recursively
38 if os.path.isdir(target):
39 for path, dirs, files in os.walk(target, topdown=False):
40 for name in files:
41 os.remove(os.path.join(path, name))
42 for name in dirs:
43 os.rmdir(os.path.join(path, name))
44 os.rmdir(target)
45 elif os.path.exists(target):
46 os.remove(target)
47
48
49class TestMailbox(TestBase):
50
51 _factory = None # Overridden by subclasses to reuse tests
52 _template = 'From: foo\n\n%s'
53
54 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +000055 self._path = support.TESTFN
Guido van Rossumd8faa362007-04-27 19:54:29 +000056 self._delete_recursively(self._path)
Thomas Wouters477c8d52006-05-27 19:21:47 +000057 self._box = self._factory(self._path)
58
59 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +000060 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +000061 self._delete_recursively(self._path)
62
63 def test_add(self):
64 # Add copies of a sample message
65 keys = []
66 keys.append(self._box.add(self._template % 0))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000067 self.assertEqual(len(self._box), 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +000068 keys.append(self._box.add(mailbox.Message(_sample_message)))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000069 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +000070 keys.append(self._box.add(email.message_from_string(_sample_message)))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000071 self.assertEqual(len(self._box), 3)
Guido van Rossum34d19282007-08-09 01:03:29 +000072 keys.append(self._box.add(io.StringIO(_sample_message)))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000073 self.assertEqual(len(self._box), 4)
Thomas Wouters477c8d52006-05-27 19:21:47 +000074 keys.append(self._box.add(_sample_message))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000075 self.assertEqual(len(self._box), 5)
Guido van Rossumea834472007-07-27 05:17:50 +000076 self.assertEqual(self._box.get_string(keys[0]), self._template % 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +000077 for i in (1, 2, 3, 4):
78 self._check_sample(self._box[keys[i]])
79
80 def test_remove(self):
81 # Remove messages using remove()
82 self._test_remove_or_delitem(self._box.remove)
83
84 def test_delitem(self):
85 # Remove messages using __delitem__()
86 self._test_remove_or_delitem(self._box.__delitem__)
87
88 def _test_remove_or_delitem(self, method):
89 # (Used by test_remove() and test_delitem().)
90 key0 = self._box.add(self._template % 0)
91 key1 = self._box.add(self._template % 1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +000092 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +000093 method(key0)
Georg Brandl194da4a2009-08-13 09:34:05 +000094 self.assertEqual(len(self._box), 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +000095 self.assertRaises(KeyError, lambda: self._box[key0])
96 self.assertRaises(KeyError, lambda: method(key0))
Guido van Rossumea834472007-07-27 05:17:50 +000097 self.assertEqual(self._box.get_string(key1), self._template % 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +000098 key2 = self._box.add(self._template % 2)
Guido van Rossume61fd5b2007-07-11 12:20:59 +000099 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000100 method(key2)
Georg Brandl194da4a2009-08-13 09:34:05 +0000101 self.assertEqual(len(self._box), 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000102 self.assertRaises(KeyError, lambda: self._box[key2])
103 self.assertRaises(KeyError, lambda: method(key2))
Guido van Rossumea834472007-07-27 05:17:50 +0000104 self.assertEqual(self._box.get_string(key1), self._template % 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000105 method(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000106 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000107 self.assertRaises(KeyError, lambda: self._box[key1])
108 self.assertRaises(KeyError, lambda: method(key1))
109
110 def test_discard(self, repetitions=10):
111 # Discard messages
112 key0 = self._box.add(self._template % 0)
113 key1 = self._box.add(self._template % 1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000114 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000115 self._box.discard(key0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000116 self.assertEqual(len(self._box), 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000117 self.assertRaises(KeyError, lambda: self._box[key0])
118 self._box.discard(key0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000119 self.assertEqual(len(self._box), 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000120 self.assertRaises(KeyError, lambda: self._box[key0])
121
122 def test_get(self):
123 # Retrieve messages using get()
124 key0 = self._box.add(self._template % 0)
125 msg = self._box.get(key0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000126 self.assertEqual(msg['from'], 'foo')
127 self.assertEqual(msg.get_payload(), '0')
Georg Brandl194da4a2009-08-13 09:34:05 +0000128 self.assertIs(self._box.get('foo'), None)
129 self.assertIs(self._box.get('foo', False), False)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000130 self._box.close()
Georg Brandlfb16cf12008-05-11 21:31:44 +0000131 self._box = self._factory(self._path)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000132 key1 = self._box.add(self._template % 1)
133 msg = self._box.get(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000134 self.assertEqual(msg['from'], 'foo')
Georg Brandlfb16cf12008-05-11 21:31:44 +0000135 self.assertEqual(msg.get_payload(), '1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000136
137 def test_getitem(self):
138 # Retrieve message using __getitem__()
139 key0 = self._box.add(self._template % 0)
140 msg = self._box[key0]
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000141 self.assertEqual(msg['from'], 'foo')
142 self.assertEqual(msg.get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000143 self.assertRaises(KeyError, lambda: self._box['foo'])
144 self._box.discard(key0)
145 self.assertRaises(KeyError, lambda: self._box[key0])
146
147 def test_get_message(self):
148 # Get Message representations of messages
149 key0 = self._box.add(self._template % 0)
150 key1 = self._box.add(_sample_message)
151 msg0 = self._box.get_message(key0)
Georg Brandlab91fde2009-08-13 08:51:18 +0000152 self.assertTrue(isinstance(msg0, mailbox.Message))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000153 self.assertEqual(msg0['from'], 'foo')
154 self.assertEqual(msg0.get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000155 self._check_sample(self._box.get_message(key1))
156
157 def test_get_string(self):
158 # Get string representations of messages
159 key0 = self._box.add(self._template % 0)
160 key1 = self._box.add(_sample_message)
Guido van Rossumea834472007-07-27 05:17:50 +0000161 self.assertEqual(self._box.get_string(key0), self._template % 0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000162 self.assertEqual(self._box.get_string(key1), _sample_message)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000163
164 def test_get_file(self):
165 # Get file representations of messages
166 key0 = self._box.add(self._template % 0)
167 key1 = self._box.add(_sample_message)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000168 data0 = self._box.get_file(key0).read()
169 data1 = self._box.get_file(key1).read()
170 self.assertEqual(data0.replace(os.linesep, '\n'),
Guido van Rossumea834472007-07-27 05:17:50 +0000171 self._template % 0)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000172 self.assertEqual(data1.replace(os.linesep, '\n'),
Guido van Rossumea834472007-07-27 05:17:50 +0000173 _sample_message)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000174
175 def test_iterkeys(self):
176 # Get keys using iterkeys()
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000177 self._check_iteration(self._box.keys, do_keys=True, do_values=False)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000178
179 def test_keys(self):
180 # Get keys using keys()
181 self._check_iteration(self._box.keys, do_keys=True, do_values=False)
182
183 def test_itervalues(self):
184 # Get values using itervalues()
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000185 self._check_iteration(self._box.values, do_keys=False,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000186 do_values=True)
187
188 def test_iter(self):
189 # Get values using __iter__()
190 self._check_iteration(self._box.__iter__, do_keys=False,
191 do_values=True)
192
193 def test_values(self):
194 # Get values using values()
195 self._check_iteration(self._box.values, do_keys=False, do_values=True)
196
197 def test_iteritems(self):
198 # Get keys and values using iteritems()
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000199 self._check_iteration(self._box.items, do_keys=True,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000200 do_values=True)
201
202 def test_items(self):
203 # Get keys and values using items()
204 self._check_iteration(self._box.items, do_keys=True, do_values=True)
205
206 def _check_iteration(self, method, do_keys, do_values, repetitions=10):
207 for value in method():
208 self.fail("Not empty")
209 keys, values = [], []
Guido van Rossum805365e2007-05-07 22:24:25 +0000210 for i in range(repetitions):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000211 keys.append(self._box.add(self._template % i))
212 values.append(self._template % i)
213 if do_keys and not do_values:
214 returned_keys = list(method())
215 elif do_values and not do_keys:
216 returned_values = list(method())
217 else:
218 returned_keys, returned_values = [], []
219 for key, value in method():
220 returned_keys.append(key)
221 returned_values.append(value)
222 if do_keys:
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000223 self.assertEqual(len(keys), len(returned_keys))
224 self.assertEqual(set(keys), set(returned_keys))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000225 if do_values:
226 count = 0
227 for value in returned_values:
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000228 self.assertEqual(value['from'], 'foo')
Georg Brandl194da4a2009-08-13 09:34:05 +0000229 self.assertLess(int(value.get_payload()), repetitions)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000230 count += 1
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000231 self.assertEqual(len(values), count)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000232
Thomas Wouters477c8d52006-05-27 19:21:47 +0000233 def test_contains(self):
234 # Check existence of keys using __contains__()
Georg Brandl194da4a2009-08-13 09:34:05 +0000235 self.assertNotIn('foo', self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000236 key0 = self._box.add(self._template % 0)
Georg Brandl194da4a2009-08-13 09:34:05 +0000237 self.assertIn(key0, self._box)
238 self.assertNotIn('foo', self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000239 key1 = self._box.add(self._template % 1)
Georg Brandl194da4a2009-08-13 09:34:05 +0000240 self.assertIn(key1, self._box)
241 self.assertIn(key0, self._box)
242 self.assertNotIn('foo', self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000243 self._box.remove(key0)
Georg Brandl194da4a2009-08-13 09:34:05 +0000244 self.assertNotIn(key0, self._box)
245 self.assertIn(key1, self._box)
246 self.assertNotIn('foo', self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000247 self._box.remove(key1)
Georg Brandl194da4a2009-08-13 09:34:05 +0000248 self.assertNotIn(key1, self._box)
249 self.assertNotIn(key0, self._box)
250 self.assertNotIn('foo', self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000251
252 def test_len(self, repetitions=10):
253 # Get message count
254 keys = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000255 for i in range(repetitions):
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000256 self.assertEqual(len(self._box), i)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000257 keys.append(self._box.add(self._template % i))
Guido van Rossumea834472007-07-27 05:17:50 +0000258 self.assertEqual(len(self._box), i + 1)
Guido van Rossum805365e2007-05-07 22:24:25 +0000259 for i in range(repetitions):
Guido van Rossumea834472007-07-27 05:17:50 +0000260 self.assertEqual(len(self._box), repetitions - i)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000261 self._box.remove(keys[i])
Guido van Rossumea834472007-07-27 05:17:50 +0000262 self.assertEqual(len(self._box), repetitions - i - 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000263
264 def test_set_item(self):
265 # Modify messages using __setitem__()
266 key0 = self._box.add(self._template % 'original 0')
Guido van Rossumea834472007-07-27 05:17:50 +0000267 self.assertEqual(self._box.get_string(key0),
268 self._template % 'original 0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000269 key1 = self._box.add(self._template % 'original 1')
Guido van Rossumea834472007-07-27 05:17:50 +0000270 self.assertEqual(self._box.get_string(key1),
271 self._template % 'original 1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000272 self._box[key0] = self._template % 'changed 0'
Guido van Rossumea834472007-07-27 05:17:50 +0000273 self.assertEqual(self._box.get_string(key0),
274 self._template % 'changed 0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000275 self._box[key1] = self._template % 'changed 1'
Guido van Rossumea834472007-07-27 05:17:50 +0000276 self.assertEqual(self._box.get_string(key1),
277 self._template % 'changed 1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000278 self._box[key0] = _sample_message
279 self._check_sample(self._box[key0])
280 self._box[key1] = self._box[key0]
281 self._check_sample(self._box[key1])
282 self._box[key0] = self._template % 'original 0'
Guido van Rossumea834472007-07-27 05:17:50 +0000283 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000284 self._template % 'original 0')
285 self._check_sample(self._box[key1])
286 self.assertRaises(KeyError,
287 lambda: self._box.__setitem__('foo', 'bar'))
288 self.assertRaises(KeyError, lambda: self._box['foo'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000289 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000290
291 def test_clear(self, iterations=10):
292 # Remove all messages using clear()
293 keys = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000294 for i in range(iterations):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000295 self._box.add(self._template % i)
296 for i, key in enumerate(keys):
Georg Brandl194da4a2009-08-13 09:34:05 +0000297 self.assertEqual(self._box.get_string(key), self._template % i)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000298 self._box.clear()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000299 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000300 for i, key in enumerate(keys):
301 self.assertRaises(KeyError, lambda: self._box.get_string(key))
302
303 def test_pop(self):
304 # Get and remove a message using pop()
305 key0 = self._box.add(self._template % 0)
Georg Brandl194da4a2009-08-13 09:34:05 +0000306 self.assertIn(key0, self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000307 key1 = self._box.add(self._template % 1)
Georg Brandl194da4a2009-08-13 09:34:05 +0000308 self.assertIn(key1, self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000309 self.assertEqual(self._box.pop(key0).get_payload(), '0')
Georg Brandl194da4a2009-08-13 09:34:05 +0000310 self.assertNotIn(key0, self._box)
311 self.assertIn(key1, self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000312 key2 = self._box.add(self._template % 2)
Georg Brandl194da4a2009-08-13 09:34:05 +0000313 self.assertIn(key2, self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000314 self.assertEqual(self._box.pop(key2).get_payload(), '2')
Georg Brandl194da4a2009-08-13 09:34:05 +0000315 self.assertNotIn(key2, self._box)
316 self.assertIn(key1, self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000317 self.assertEqual(self._box.pop(key1).get_payload(), '1')
Georg Brandl194da4a2009-08-13 09:34:05 +0000318 self.assertNotIn(key1, self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000319 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000320
321 def test_popitem(self, iterations=10):
322 # Get and remove an arbitrary (key, message) using popitem()
323 keys = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000324 for i in range(10):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000325 keys.append(self._box.add(self._template % i))
326 seen = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000327 for i in range(10):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000328 key, msg = self._box.popitem()
Georg Brandl194da4a2009-08-13 09:34:05 +0000329 self.assertIn(key, keys)
330 self.assertNotIn(key, seen)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000331 seen.append(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000332 self.assertEqual(int(msg.get_payload()), keys.index(key))
333 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000334 for key in keys:
335 self.assertRaises(KeyError, lambda: self._box[key])
336
337 def test_update(self):
338 # Modify multiple messages using update()
339 key0 = self._box.add(self._template % 'original 0')
340 key1 = self._box.add(self._template % 'original 1')
341 key2 = self._box.add(self._template % 'original 2')
342 self._box.update({key0: self._template % 'changed 0',
343 key2: _sample_message})
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000344 self.assertEqual(len(self._box), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000345 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000346 self._template % 'changed 0')
Guido van Rossumea834472007-07-27 05:17:50 +0000347 self.assertEqual(self._box.get_string(key1),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000348 self._template % 'original 1')
349 self._check_sample(self._box[key2])
350 self._box.update([(key2, self._template % 'changed 2'),
351 (key1, self._template % 'changed 1'),
352 (key0, self._template % 'original 0')])
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000353 self.assertEqual(len(self._box), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000354 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000355 self._template % 'original 0')
Guido van Rossumea834472007-07-27 05:17:50 +0000356 self.assertEqual(self._box.get_string(key1),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000357 self._template % 'changed 1')
Guido van Rossumea834472007-07-27 05:17:50 +0000358 self.assertEqual(self._box.get_string(key2),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000359 self._template % 'changed 2')
360 self.assertRaises(KeyError,
361 lambda: self._box.update({'foo': 'bar',
362 key0: self._template % "changed 0"}))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000363 self.assertEqual(len(self._box), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000364 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000365 self._template % "changed 0")
Guido van Rossumea834472007-07-27 05:17:50 +0000366 self.assertEqual(self._box.get_string(key1),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000367 self._template % "changed 1")
Guido van Rossumea834472007-07-27 05:17:50 +0000368 self.assertEqual(self._box.get_string(key2),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000369 self._template % "changed 2")
370
371 def test_flush(self):
372 # Write changes to disk
Christian Heimesf6cd9672008-03-26 13:45:42 +0000373 self._test_flush_or_close(self._box.flush, True)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000374
375 def test_lock_unlock(self):
376 # Lock and unlock the mailbox
Georg Brandl194da4a2009-08-13 09:34:05 +0000377 self.assertFalse(os.path.exists(self._get_lock_path()))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000378 self._box.lock()
Georg Brandlab91fde2009-08-13 08:51:18 +0000379 self.assertTrue(os.path.exists(self._get_lock_path()))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000380 self._box.unlock()
Georg Brandl194da4a2009-08-13 09:34:05 +0000381 self.assertFalse(os.path.exists(self._get_lock_path()))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000382
383 def test_close(self):
384 # Close mailbox and flush changes to disk
Christian Heimesf6cd9672008-03-26 13:45:42 +0000385 self._test_flush_or_close(self._box.close, False)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000386
Christian Heimesf6cd9672008-03-26 13:45:42 +0000387 def _test_flush_or_close(self, method, should_call_close):
Guido van Rossum805365e2007-05-07 22:24:25 +0000388 contents = [self._template % i for i in range(3)]
Thomas Wouters477c8d52006-05-27 19:21:47 +0000389 self._box.add(contents[0])
390 self._box.add(contents[1])
391 self._box.add(contents[2])
Guido van Rossumc12a8132007-10-26 04:29:23 +0000392 oldbox = self._box
Thomas Wouters477c8d52006-05-27 19:21:47 +0000393 method()
Christian Heimesf6cd9672008-03-26 13:45:42 +0000394 if should_call_close:
395 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000396 self._box = self._factory(self._path)
397 keys = self._box.keys()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000398 self.assertEqual(len(keys), 3)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000399 for key in keys:
Georg Brandl194da4a2009-08-13 09:34:05 +0000400 self.assertIn(self._box.get_string(key), contents)
Guido van Rossumc12a8132007-10-26 04:29:23 +0000401 oldbox.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000402
403 def test_dump_message(self):
404 # Write message representations to disk
405 for input in (email.message_from_string(_sample_message),
Guido van Rossum34d19282007-08-09 01:03:29 +0000406 _sample_message, io.StringIO(_sample_message)):
407 output = io.StringIO()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000408 self._box._dump_message(input, output)
Amaury Forgeot d'Arc9edef042008-03-26 19:49:26 +0000409 self.assertEqual(output.getvalue(), _sample_message)
Guido van Rossum34d19282007-08-09 01:03:29 +0000410 output = io.StringIO()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000411 self.assertRaises(TypeError,
412 lambda: self._box._dump_message(None, output))
413
414 def _get_lock_path(self):
415 # Return the path of the dot lock file. May be overridden.
416 return self._path + '.lock'
417
418
419class TestMailboxSuperclass(TestBase):
420
421 def test_notimplemented(self):
422 # Test that all Mailbox methods raise NotImplementedException.
423 box = mailbox.Mailbox('path')
424 self.assertRaises(NotImplementedError, lambda: box.add(''))
425 self.assertRaises(NotImplementedError, lambda: box.remove(''))
426 self.assertRaises(NotImplementedError, lambda: box.__delitem__(''))
427 self.assertRaises(NotImplementedError, lambda: box.discard(''))
428 self.assertRaises(NotImplementedError, lambda: box.__setitem__('', ''))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000429 self.assertRaises(NotImplementedError, lambda: box.keys())
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000430 self.assertRaises(NotImplementedError, lambda: box.keys())
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000431 self.assertRaises(NotImplementedError, lambda: box.values().__next__())
432 self.assertRaises(NotImplementedError, lambda: box.__iter__().__next__())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000433 self.assertRaises(NotImplementedError, lambda: box.values())
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000434 self.assertRaises(NotImplementedError, lambda: box.items().next())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000435 self.assertRaises(NotImplementedError, lambda: box.items())
436 self.assertRaises(NotImplementedError, lambda: box.get(''))
437 self.assertRaises(NotImplementedError, lambda: box.__getitem__(''))
438 self.assertRaises(NotImplementedError, lambda: box.get_message(''))
439 self.assertRaises(NotImplementedError, lambda: box.get_string(''))
440 self.assertRaises(NotImplementedError, lambda: box.get_file(''))
Guido van Rossume2b70bc2006-08-18 22:13:04 +0000441 self.assertRaises(NotImplementedError, lambda: '' in box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000442 self.assertRaises(NotImplementedError, lambda: box.__contains__(''))
443 self.assertRaises(NotImplementedError, lambda: box.__len__())
444 self.assertRaises(NotImplementedError, lambda: box.clear())
445 self.assertRaises(NotImplementedError, lambda: box.pop(''))
446 self.assertRaises(NotImplementedError, lambda: box.popitem())
447 self.assertRaises(NotImplementedError, lambda: box.update((('', ''),)))
448 self.assertRaises(NotImplementedError, lambda: box.flush())
449 self.assertRaises(NotImplementedError, lambda: box.lock())
450 self.assertRaises(NotImplementedError, lambda: box.unlock())
451 self.assertRaises(NotImplementedError, lambda: box.close())
452
453
454class TestMaildir(TestMailbox):
455
456 _factory = lambda self, path, factory=None: mailbox.Maildir(path, factory)
457
458 def setUp(self):
459 TestMailbox.setUp(self)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000460 if os.name in ('nt', 'os2') or sys.platform == 'cygwin':
Thomas Wouters477c8d52006-05-27 19:21:47 +0000461 self._box.colon = '!'
462
463 def test_add_MM(self):
464 # Add a MaildirMessage instance
465 msg = mailbox.MaildirMessage(self._template % 0)
466 msg.set_subdir('cur')
467 msg.set_info('foo')
468 key = self._box.add(msg)
Georg Brandlab91fde2009-08-13 08:51:18 +0000469 self.assertTrue(os.path.exists(os.path.join(self._path, 'cur', '%s%sfoo' %
Thomas Wouters477c8d52006-05-27 19:21:47 +0000470 (key, self._box.colon))))
471
472 def test_get_MM(self):
473 # Get a MaildirMessage instance
474 msg = mailbox.MaildirMessage(self._template % 0)
475 msg.set_subdir('cur')
476 msg.set_flags('RF')
477 key = self._box.add(msg)
478 msg_returned = self._box.get_message(key)
Georg Brandlab91fde2009-08-13 08:51:18 +0000479 self.assertTrue(isinstance(msg_returned, mailbox.MaildirMessage))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000480 self.assertEqual(msg_returned.get_subdir(), 'cur')
481 self.assertEqual(msg_returned.get_flags(), 'FR')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000482
483 def test_set_MM(self):
484 # Set with a MaildirMessage instance
485 msg0 = mailbox.MaildirMessage(self._template % 0)
486 msg0.set_flags('TP')
487 key = self._box.add(msg0)
488 msg_returned = self._box.get_message(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000489 self.assertEqual(msg_returned.get_subdir(), 'new')
490 self.assertEqual(msg_returned.get_flags(), 'PT')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000491 msg1 = mailbox.MaildirMessage(self._template % 1)
492 self._box[key] = msg1
493 msg_returned = self._box.get_message(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000494 self.assertEqual(msg_returned.get_subdir(), 'new')
495 self.assertEqual(msg_returned.get_flags(), '')
496 self.assertEqual(msg_returned.get_payload(), '1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000497 msg2 = mailbox.MaildirMessage(self._template % 2)
498 msg2.set_info('2,S')
499 self._box[key] = msg2
500 self._box[key] = self._template % 3
501 msg_returned = self._box.get_message(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000502 self.assertEqual(msg_returned.get_subdir(), 'new')
503 self.assertEqual(msg_returned.get_flags(), 'S')
504 self.assertEqual(msg_returned.get_payload(), '3')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000505
Christian Heimesfdab48e2008-01-20 09:06:41 +0000506 def test_consistent_factory(self):
507 # Add a message.
508 msg = mailbox.MaildirMessage(self._template % 0)
509 msg.set_subdir('cur')
510 msg.set_flags('RF')
511 key = self._box.add(msg)
512
513 # Create new mailbox with
514 class FakeMessage(mailbox.MaildirMessage):
515 pass
516 box = mailbox.Maildir(self._path, factory=FakeMessage)
Christian Heimes15ebc882008-02-04 18:48:49 +0000517 box.colon = self._box.colon
Christian Heimesfdab48e2008-01-20 09:06:41 +0000518 msg2 = box.get_message(key)
Georg Brandlab91fde2009-08-13 08:51:18 +0000519 self.assertTrue(isinstance(msg2, FakeMessage))
Christian Heimesfdab48e2008-01-20 09:06:41 +0000520
Thomas Wouters477c8d52006-05-27 19:21:47 +0000521 def test_initialize_new(self):
522 # Initialize a non-existent mailbox
523 self.tearDown()
524 self._box = mailbox.Maildir(self._path)
Georg Brandlfb16cf12008-05-11 21:31:44 +0000525 self._check_basics()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000526 self._delete_recursively(self._path)
527 self._box = self._factory(self._path, factory=None)
528 self._check_basics()
529
530 def test_initialize_existing(self):
531 # Initialize an existing mailbox
532 self.tearDown()
533 for subdir in '', 'tmp', 'new', 'cur':
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000534 os.mkdir(os.path.normpath(os.path.join(self._path, subdir)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000535 self._box = mailbox.Maildir(self._path)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000536 self._check_basics()
537
538 def _check_basics(self, factory=None):
539 # (Used by test_open_new() and test_open_existing().)
540 self.assertEqual(self._box._path, os.path.abspath(self._path))
541 self.assertEqual(self._box._factory, factory)
542 for subdir in '', 'tmp', 'new', 'cur':
543 path = os.path.join(self._path, subdir)
544 mode = os.stat(path)[stat.ST_MODE]
Georg Brandlab91fde2009-08-13 08:51:18 +0000545 self.assertTrue(stat.S_ISDIR(mode), "Not a directory: '%s'" % path)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000546
547 def test_list_folders(self):
548 # List folders
549 self._box.add_folder('one')
550 self._box.add_folder('two')
551 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000552 self.assertEqual(len(self._box.list_folders()), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000553 self.assertEqual(set(self._box.list_folders()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000554 set(('one', 'two', 'three')))
555
556 def test_get_folder(self):
557 # Open folders
558 self._box.add_folder('foo.bar')
559 folder0 = self._box.get_folder('foo.bar')
560 folder0.add(self._template % 'bar')
Georg Brandlab91fde2009-08-13 08:51:18 +0000561 self.assertTrue(os.path.isdir(os.path.join(self._path, '.foo.bar')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000562 folder1 = self._box.get_folder('foo.bar')
Guido van Rossumea834472007-07-27 05:17:50 +0000563 self.assertEqual(folder1.get_string(folder1.keys()[0]),
564 self._template % 'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000565
566 def test_add_and_remove_folders(self):
567 # Delete folders
568 self._box.add_folder('one')
569 self._box.add_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000570 self.assertEqual(len(self._box.list_folders()), 2)
Georg Brandl194da4a2009-08-13 09:34:05 +0000571 self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000572 self._box.remove_folder('one')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000573 self.assertEqual(len(self._box.list_folders()), 1)
574 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000575 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000576 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000577 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000578 self._box.remove_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000579 self.assertEqual(len(self._box.list_folders()), 1)
580 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000581 self._box.remove_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000582 self.assertEqual(len(self._box.list_folders()), 0)
583 self.assertEqual(self._box.list_folders(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000584
585 def test_clean(self):
586 # Remove old files from 'tmp'
587 foo_path = os.path.join(self._path, 'tmp', 'foo')
588 bar_path = os.path.join(self._path, 'tmp', 'bar')
589 f = open(foo_path, 'w')
590 f.write("@")
591 f.close()
592 f = open(bar_path, 'w')
593 f.write("@")
594 f.close()
595 self._box.clean()
Georg Brandlab91fde2009-08-13 08:51:18 +0000596 self.assertTrue(os.path.exists(foo_path))
597 self.assertTrue(os.path.exists(bar_path))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000598 foo_stat = os.stat(foo_path)
599 os.utime(foo_path, (time.time() - 129600 - 2,
600 foo_stat.st_mtime))
601 self._box.clean()
Georg Brandl194da4a2009-08-13 09:34:05 +0000602 self.assertFalse(os.path.exists(foo_path))
Georg Brandlab91fde2009-08-13 08:51:18 +0000603 self.assertTrue(os.path.exists(bar_path))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000604
605 def test_create_tmp(self, repetitions=10):
606 # Create files in tmp directory
607 hostname = socket.gethostname()
608 if '/' in hostname:
609 hostname = hostname.replace('/', r'\057')
610 if ':' in hostname:
611 hostname = hostname.replace(':', r'\072')
612 pid = os.getpid()
613 pattern = re.compile(r"(?P<time>\d+)\.M(?P<M>\d{1,6})P(?P<P>\d+)"
614 r"Q(?P<Q>\d+)\.(?P<host>[^:/]+)")
615 previous_groups = None
Guido van Rossum805365e2007-05-07 22:24:25 +0000616 for x in range(repetitions):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000617 tmp_file = self._box._create_tmp()
618 head, tail = os.path.split(tmp_file.name)
619 self.assertEqual(head, os.path.abspath(os.path.join(self._path,
620 "tmp")),
621 "File in wrong location: '%s'" % head)
622 match = pattern.match(tail)
Georg Brandl194da4a2009-08-13 09:34:05 +0000623 self.assertIsNot(match, None, "Invalid file name: '%s'" % tail)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000624 groups = match.groups()
Benjamin Peterson2a691a82008-03-31 01:51:45 +0000625 if previous_groups is not None:
Georg Brandlab91fde2009-08-13 08:51:18 +0000626 self.assertTrue(int(groups[0] >= previous_groups[0]),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000627 "Non-monotonic seconds: '%s' before '%s'" %
628 (previous_groups[0], groups[0]))
Georg Brandlab91fde2009-08-13 08:51:18 +0000629 self.assertTrue(int(groups[1] >= previous_groups[1]) or
Thomas Wouters477c8d52006-05-27 19:21:47 +0000630 groups[0] != groups[1],
631 "Non-monotonic milliseconds: '%s' before '%s'" %
632 (previous_groups[1], groups[1]))
Guido van Rossumea834472007-07-27 05:17:50 +0000633 self.assertEqual(int(groups[2]), pid,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000634 "Process ID mismatch: '%s' should be '%s'" %
635 (groups[2], pid))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000636 self.assertEqual(int(groups[3]), int(previous_groups[3]) + 1,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000637 "Non-sequential counter: '%s' before '%s'" %
638 (previous_groups[3], groups[3]))
Guido van Rossumea834472007-07-27 05:17:50 +0000639 self.assertEqual(groups[4], hostname,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000640 "Host name mismatch: '%s' should be '%s'" %
641 (groups[4], hostname))
642 previous_groups = groups
643 tmp_file.write(_sample_message)
644 tmp_file.seek(0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000645 self.assertEqual(tmp_file.read(), _sample_message)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000646 tmp_file.close()
647 file_count = len(os.listdir(os.path.join(self._path, "tmp")))
Guido van Rossumea834472007-07-27 05:17:50 +0000648 self.assertEqual(file_count, repetitions,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000649 "Wrong file count: '%s' should be '%s'" %
650 (file_count, repetitions))
651
652 def test_refresh(self):
653 # Update the table of contents
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000654 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000655 key0 = self._box.add(self._template % 0)
656 key1 = self._box.add(self._template % 1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000657 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000658 self._box._refresh()
Guido van Rossumea834472007-07-27 05:17:50 +0000659 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
660 key1: os.path.join('new', key1)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000661 key2 = self._box.add(self._template % 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000662 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
663 key1: os.path.join('new', key1)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000664 self._box._refresh()
Guido van Rossumea834472007-07-27 05:17:50 +0000665 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
666 key1: os.path.join('new', key1),
667 key2: os.path.join('new', key2)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000668
669 def test_lookup(self):
670 # Look up message subpaths in the TOC
671 self.assertRaises(KeyError, lambda: self._box._lookup('foo'))
672 key0 = self._box.add(self._template % 0)
Guido van Rossumea834472007-07-27 05:17:50 +0000673 self.assertEqual(self._box._lookup(key0), os.path.join('new', key0))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000674 os.remove(os.path.join(self._path, 'new', key0))
Guido van Rossumea834472007-07-27 05:17:50 +0000675 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0)})
Antoine Pitrou868b5782009-11-02 11:40:19 +0000676 # Be sure that the TOC is read back from disk (see issue #6896
677 # about bad mtime behaviour on some systems).
678 self._box.flush()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000679 self.assertRaises(KeyError, lambda: self._box._lookup(key0))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000680 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000681
682 def test_lock_unlock(self):
683 # Lock and unlock the mailbox. For Maildir, this does nothing.
684 self._box.lock()
685 self._box.unlock()
686
Thomas Wouters89f507f2006-12-13 04:49:30 +0000687 def test_folder (self):
688 # Test for bug #1569790: verify that folders returned by .get_folder()
689 # use the same factory function.
690 def dummy_factory (s):
691 return None
692 box = self._factory(self._path, factory=dummy_factory)
693 folder = box.add_folder('folder1')
Georg Brandl194da4a2009-08-13 09:34:05 +0000694 self.assertIs(folder._factory, dummy_factory)
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000695
Thomas Wouters89f507f2006-12-13 04:49:30 +0000696 folder1_alias = box.get_folder('folder1')
Georg Brandl194da4a2009-08-13 09:34:05 +0000697 self.assertIs(folder1_alias._factory, dummy_factory)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000698
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000699 def test_directory_in_folder (self):
700 # Test that mailboxes still work if there's a stray extra directory
701 # in a folder.
702 for i in range(10):
703 self._box.add(mailbox.Message(_sample_message))
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000704
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000705 # Create a stray directory
706 os.mkdir(os.path.join(self._path, 'cur', 'stray-dir'))
707
708 # Check that looping still works with the directory present.
709 for msg in self._box:
710 pass
Thomas Wouters477c8d52006-05-27 19:21:47 +0000711
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000712 def test_file_permissions(self):
713 # Verify that message files are created without execute permissions
714 if not hasattr(os, "stat") or not hasattr(os, "umask"):
715 return
716 msg = mailbox.MaildirMessage(self._template % 0)
717 orig_umask = os.umask(0)
718 try:
719 key = self._box.add(msg)
720 finally:
721 os.umask(orig_umask)
722 path = os.path.join(self._path, self._box._lookup(key))
723 mode = os.stat(path).st_mode
Georg Brandl194da4a2009-08-13 09:34:05 +0000724 self.assertFalse(mode & 0o111)
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000725
726 def test_folder_file_perms(self):
727 # From bug #3228, we want to verify that the file created inside a Maildir
728 # subfolder isn't marked as executable.
729 if not hasattr(os, "stat") or not hasattr(os, "umask"):
730 return
731
732 orig_umask = os.umask(0)
733 try:
734 subfolder = self._box.add_folder('subfolder')
735 finally:
736 os.umask(orig_umask)
737
738 path = os.path.join(subfolder._path, 'maildirfolder')
739 st = os.stat(path)
740 perms = st.st_mode
741 self.assertFalse((perms & 0o111)) # Execute bits should all be off.
742
Andrew M. Kuchlingfa815342009-05-03 02:52:20 +0000743 def test_reread(self):
Andrew M. Kuchlingfa815342009-05-03 02:52:20 +0000744
745 # Initially, the mailbox has not been read and the time is null.
746 assert getattr(self._box, '_last_read', None) is None
747
748 # Refresh mailbox; the times should now be set to something.
749 self._box._refresh()
750 assert getattr(self._box, '_last_read', None) is not None
751
R David Murrayb9a428d2011-03-25 16:03:47 -0400752 # Put the last modified times more than one second into the past
753 # (because mtime has a one second granularity, a refresh is done
754 # unconditionally if called for within the same second, just in case
755 # the mbox has changed).
756 for subdir in ('cur', 'new'):
757 os.utime(os.path.join(self._box._path, subdir),
758 (time.time()-5,)*2)
759
760 # Re-reading causes the ._toc attribute to be assigned a new dictionary
761 # object, so we'll check that the ._toc attribute isn't a different
762 # object.
Andrew M. Kuchlingfa815342009-05-03 02:52:20 +0000763 orig_toc = self._box._toc
764 def refreshed():
765 return self._box._toc is not orig_toc
766
Andrew M. Kuchlingfa815342009-05-03 02:52:20 +0000767 self._box._refresh()
768 assert not refreshed()
769
770 # Now, write something into cur and remove it. This changes
771 # the mtime and should cause a re-read.
772 filename = os.path.join(self._path, 'cur', 'stray-file')
773 f = open(filename, 'w')
774 f.close()
775 os.unlink(filename)
776 self._box._refresh()
777 assert refreshed()
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000778
Thomas Wouters477c8d52006-05-27 19:21:47 +0000779class _TestMboxMMDF(TestMailbox):
780
781 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +0000782 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000783 self._delete_recursively(self._path)
784 for lock_remnant in glob.glob(self._path + '.*'):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000785 support.unlink(lock_remnant)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000786
787 def test_add_from_string(self):
788 # Add a string starting with 'From ' to the mailbox
789 key = self._box.add('From foo@bar blah\nFrom: foo\n\n0')
Guido van Rossumea834472007-07-27 05:17:50 +0000790 self.assertEqual(self._box[key].get_from(), 'foo@bar blah')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000791 self.assertEqual(self._box[key].get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000792
793 def test_add_mbox_or_mmdf_message(self):
794 # Add an mboxMessage or MMDFMessage
795 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
796 msg = class_('From foo@bar blah\nFrom: foo\n\n0')
797 key = self._box.add(msg)
798
799 def test_open_close_open(self):
800 # Open and inspect previously-created mailbox
Guido van Rossum805365e2007-05-07 22:24:25 +0000801 values = [self._template % i for i in range(3)]
Thomas Wouters477c8d52006-05-27 19:21:47 +0000802 for value in values:
803 self._box.add(value)
804 self._box.close()
805 mtime = os.path.getmtime(self._path)
806 self._box = self._factory(self._path)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000807 self.assertEqual(len(self._box), 3)
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000808 for key in self._box.keys():
Georg Brandl194da4a2009-08-13 09:34:05 +0000809 self.assertIn(self._box.get_string(key), values)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000810 self._box.close()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000811 self.assertEqual(mtime, os.path.getmtime(self._path))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000812
813 def test_add_and_close(self):
814 # Verifying that closing a mailbox doesn't change added items
815 self._box.add(_sample_message)
Guido van Rossum805365e2007-05-07 22:24:25 +0000816 for i in range(3):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000817 self._box.add(self._template % i)
818 self._box.add(_sample_message)
819 self._box._file.flush()
820 self._box._file.seek(0)
821 contents = self._box._file.read()
822 self._box.close()
Amaury Forgeot d'Arc9edef042008-03-26 19:49:26 +0000823 self.assertEqual(contents, open(self._path, 'r', newline='').read())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000824 self._box = self._factory(self._path)
825
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000826 def test_lock_conflict(self):
827 # Fork off a subprocess that will lock the file for 2 seconds,
828 # unlock it, and then exit.
829 if not hasattr(os, 'fork'):
830 return
831 pid = os.fork()
832 if pid == 0:
833 # In the child, lock the mailbox.
Guido van Rossum62cbc8a2007-04-09 00:41:25 +0000834 try:
835 self._box.lock()
836 time.sleep(2)
837 self._box.unlock()
838 finally:
839 os._exit(0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000840
841 # In the parent, sleep a bit to give the child time to acquire
842 # the lock.
843 time.sleep(0.5)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000844 try:
845 self.assertRaises(mailbox.ExternalClashError,
846 self._box.lock)
847 finally:
848 # Wait for child to exit. Locking should now succeed.
849 exited_pid, status = os.waitpid(pid, 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000850
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000851 self._box.lock()
852 self._box.unlock()
853
Thomas Wouters89f507f2006-12-13 04:49:30 +0000854 def test_relock(self):
855 # Test case for bug #1575506: the mailbox class was locking the
856 # wrong file object in its flush() method.
857 msg = "Subject: sub\n\nbody\n"
858 key1 = self._box.add(msg)
859 self._box.flush()
860 self._box.close()
861
862 self._box = self._factory(self._path)
863 self._box.lock()
864 key2 = self._box.add(msg)
865 self._box.flush()
Georg Brandlab91fde2009-08-13 08:51:18 +0000866 self.assertTrue(self._box._locked)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000867 self._box.close()
868
869
Thomas Wouters477c8d52006-05-27 19:21:47 +0000870class TestMbox(_TestMboxMMDF):
871
872 _factory = lambda self, path, factory=None: mailbox.mbox(path, factory)
873
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000874 def test_file_perms(self):
875 # From bug #3228, we want to verify that the mailbox file isn't executable,
876 # even if the umask is set to something that would leave executable bits set.
877 # We only run this test on platforms that support umask.
878 if hasattr(os, 'umask') and hasattr(os, 'stat'):
879 try:
880 old_umask = os.umask(0o077)
881 self._box.close()
882 os.unlink(self._path)
883 self._box = mailbox.mbox(self._path, create=True)
884 self._box.add('')
885 self._box.close()
886 finally:
887 os.umask(old_umask)
888
889 st = os.stat(self._path)
890 perms = st.st_mode
891 self.assertFalse((perms & 0o111)) # Execute bits should all be off.
Thomas Wouters477c8d52006-05-27 19:21:47 +0000892
893class TestMMDF(_TestMboxMMDF):
894
895 _factory = lambda self, path, factory=None: mailbox.MMDF(path, factory)
896
897
898class TestMH(TestMailbox):
899
900 _factory = lambda self, path, factory=None: mailbox.MH(path, factory)
901
902 def test_list_folders(self):
903 # List folders
904 self._box.add_folder('one')
905 self._box.add_folder('two')
906 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000907 self.assertEqual(len(self._box.list_folders()), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000908 self.assertEqual(set(self._box.list_folders()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000909 set(('one', 'two', 'three')))
910
911 def test_get_folder(self):
912 # Open folders
Thomas Wouters89f507f2006-12-13 04:49:30 +0000913 def dummy_factory (s):
914 return None
915 self._box = self._factory(self._path, dummy_factory)
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000916
Thomas Wouters89f507f2006-12-13 04:49:30 +0000917 new_folder = self._box.add_folder('foo.bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000918 folder0 = self._box.get_folder('foo.bar')
919 folder0.add(self._template % 'bar')
Georg Brandlab91fde2009-08-13 08:51:18 +0000920 self.assertTrue(os.path.isdir(os.path.join(self._path, 'foo.bar')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000921 folder1 = self._box.get_folder('foo.bar')
Guido van Rossumea834472007-07-27 05:17:50 +0000922 self.assertEqual(folder1.get_string(folder1.keys()[0]),
923 self._template % 'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000924
Thomas Wouters89f507f2006-12-13 04:49:30 +0000925 # Test for bug #1569790: verify that folders returned by .get_folder()
926 # use the same factory function.
Georg Brandl194da4a2009-08-13 09:34:05 +0000927 self.assertIs(new_folder._factory, self._box._factory)
928 self.assertIs(folder0._factory, self._box._factory)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000929
Thomas Wouters477c8d52006-05-27 19:21:47 +0000930 def test_add_and_remove_folders(self):
931 # Delete folders
932 self._box.add_folder('one')
933 self._box.add_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000934 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000935 self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000936 self._box.remove_folder('one')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000937 self.assertEqual(len(self._box.list_folders()), 1)
938 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000939 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000940 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000941 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000942 self._box.remove_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000943 self.assertEqual(len(self._box.list_folders()), 1)
944 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000945 self._box.remove_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000946 self.assertEqual(len(self._box.list_folders()), 0)
947 self.assertEqual(self._box.list_folders(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000948
949 def test_sequences(self):
950 # Get and set sequences
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000951 self.assertEqual(self._box.get_sequences(), {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000952 msg0 = mailbox.MHMessage(self._template % 0)
953 msg0.add_sequence('foo')
954 key0 = self._box.add(msg0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000955 self.assertEqual(self._box.get_sequences(), {'foo':[key0]})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000956 msg1 = mailbox.MHMessage(self._template % 1)
957 msg1.set_sequences(['bar', 'replied', 'foo'])
958 key1 = self._box.add(msg1)
Guido van Rossumea834472007-07-27 05:17:50 +0000959 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000960 {'foo':[key0, key1], 'bar':[key1], 'replied':[key1]})
961 msg0.set_sequences(['flagged'])
962 self._box[key0] = msg0
Guido van Rossumea834472007-07-27 05:17:50 +0000963 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000964 {'foo':[key1], 'bar':[key1], 'replied':[key1],
965 'flagged':[key0]})
966 self._box.remove(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000967 self.assertEqual(self._box.get_sequences(), {'flagged':[key0]})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000968
R. David Murray548ac412009-04-02 19:44:43 +0000969 def test_issue2625(self):
970 msg0 = mailbox.MHMessage(self._template % 0)
971 msg0.add_sequence('foo')
972 key0 = self._box.add(msg0)
973 refmsg0 = self._box.get_message(key0)
974
Thomas Wouters477c8d52006-05-27 19:21:47 +0000975 def test_pack(self):
976 # Pack the contents of the mailbox
977 msg0 = mailbox.MHMessage(self._template % 0)
978 msg1 = mailbox.MHMessage(self._template % 1)
979 msg2 = mailbox.MHMessage(self._template % 2)
980 msg3 = mailbox.MHMessage(self._template % 3)
981 msg0.set_sequences(['foo', 'unseen'])
982 msg1.set_sequences(['foo'])
983 msg2.set_sequences(['foo', 'flagged'])
984 msg3.set_sequences(['foo', 'bar', 'replied'])
985 key0 = self._box.add(msg0)
986 key1 = self._box.add(msg1)
987 key2 = self._box.add(msg2)
988 key3 = self._box.add(msg3)
Guido van Rossumea834472007-07-27 05:17:50 +0000989 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000990 {'foo':[key0,key1,key2,key3], 'unseen':[key0],
991 'flagged':[key2], 'bar':[key3], 'replied':[key3]})
992 self._box.remove(key2)
Guido van Rossumea834472007-07-27 05:17:50 +0000993 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000994 {'foo':[key0,key1,key3], 'unseen':[key0], 'bar':[key3],
995 'replied':[key3]})
996 self._box.pack()
Georg Brandl194da4a2009-08-13 09:34:05 +0000997 self.assertEqual(self._box.keys(), [1, 2, 3])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000998 key0 = key0
999 key1 = key0 + 1
1000 key2 = key1 + 1
Guido van Rossumea834472007-07-27 05:17:50 +00001001 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +00001002 {'foo':[1, 2, 3], 'unseen':[1], 'bar':[3], 'replied':[3]})
1003
Thomas Wouters89f507f2006-12-13 04:49:30 +00001004 # Test case for packing while holding the mailbox locked.
1005 key0 = self._box.add(msg1)
1006 key1 = self._box.add(msg1)
1007 key2 = self._box.add(msg1)
1008 key3 = self._box.add(msg1)
1009
1010 self._box.remove(key0)
1011 self._box.remove(key2)
1012 self._box.lock()
1013 self._box.pack()
1014 self._box.unlock()
Guido van Rossumea834472007-07-27 05:17:50 +00001015 self.assertEqual(self._box.get_sequences(),
Thomas Wouters89f507f2006-12-13 04:49:30 +00001016 {'foo':[1, 2, 3, 4, 5],
1017 'unseen':[1], 'bar':[3], 'replied':[3]})
Thomas Wouters9fe394c2007-02-05 01:24:16 +00001018
Thomas Wouters477c8d52006-05-27 19:21:47 +00001019 def _get_lock_path(self):
1020 return os.path.join(self._path, '.mh_sequences.lock')
1021
1022
1023class TestBabyl(TestMailbox):
1024
1025 _factory = lambda self, path, factory=None: mailbox.Babyl(path, factory)
1026
1027 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +00001028 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001029 self._delete_recursively(self._path)
1030 for lock_remnant in glob.glob(self._path + '.*'):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001031 support.unlink(lock_remnant)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001032
1033 def test_labels(self):
1034 # Get labels from the mailbox
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001035 self.assertEqual(self._box.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001036 msg0 = mailbox.BabylMessage(self._template % 0)
1037 msg0.add_label('foo')
1038 key0 = self._box.add(msg0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001039 self.assertEqual(self._box.get_labels(), ['foo'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001040 msg1 = mailbox.BabylMessage(self._template % 1)
1041 msg1.set_labels(['bar', 'answered', 'foo'])
1042 key1 = self._box.add(msg1)
Guido van Rossumea834472007-07-27 05:17:50 +00001043 self.assertEqual(set(self._box.get_labels()), set(['foo', 'bar']))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001044 msg0.set_labels(['blah', 'filed'])
1045 self._box[key0] = msg0
Guido van Rossumea834472007-07-27 05:17:50 +00001046 self.assertEqual(set(self._box.get_labels()),
Thomas Wouters477c8d52006-05-27 19:21:47 +00001047 set(['foo', 'bar', 'blah']))
1048 self._box.remove(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001049 self.assertEqual(set(self._box.get_labels()), set(['blah']))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001050
1051
1052class TestMessage(TestBase):
1053
1054 _factory = mailbox.Message # Overridden by subclasses to reuse tests
1055
1056 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001057 self._path = support.TESTFN
Thomas Wouters477c8d52006-05-27 19:21:47 +00001058
1059 def tearDown(self):
1060 self._delete_recursively(self._path)
1061
1062 def test_initialize_with_eMM(self):
Thomas Woutersb2137042007-02-01 18:02:27 +00001063 # Initialize based on email.message.Message instance
Thomas Wouters477c8d52006-05-27 19:21:47 +00001064 eMM = email.message_from_string(_sample_message)
1065 msg = self._factory(eMM)
1066 self._post_initialize_hook(msg)
1067 self._check_sample(msg)
1068
1069 def test_initialize_with_string(self):
1070 # Initialize based on string
1071 msg = self._factory(_sample_message)
1072 self._post_initialize_hook(msg)
1073 self._check_sample(msg)
1074
1075 def test_initialize_with_file(self):
1076 # Initialize based on contents of file
1077 f = open(self._path, 'w+')
1078 f.write(_sample_message)
1079 f.seek(0)
1080 msg = self._factory(f)
1081 self._post_initialize_hook(msg)
1082 self._check_sample(msg)
1083 f.close()
1084
1085 def test_initialize_with_nothing(self):
1086 # Initialize without arguments
1087 msg = self._factory()
1088 self._post_initialize_hook(msg)
Georg Brandlab91fde2009-08-13 08:51:18 +00001089 self.assertTrue(isinstance(msg, email.message.Message))
1090 self.assertTrue(isinstance(msg, mailbox.Message))
1091 self.assertTrue(isinstance(msg, self._factory))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001092 self.assertEqual(msg.keys(), [])
Georg Brandl194da4a2009-08-13 09:34:05 +00001093 self.assertFalse(msg.is_multipart())
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001094 self.assertEqual(msg.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001095
1096 def test_initialize_incorrectly(self):
1097 # Initialize with invalid argument
1098 self.assertRaises(TypeError, lambda: self._factory(object()))
1099
1100 def test_become_message(self):
1101 # Take on the state of another message
1102 eMM = email.message_from_string(_sample_message)
1103 msg = self._factory()
1104 msg._become_message(eMM)
1105 self._check_sample(msg)
1106
1107 def test_explain_to(self):
1108 # Copy self's format-specific data to other message formats.
1109 # This test is superficial; better ones are in TestMessageConversion.
1110 msg = self._factory()
1111 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1112 mailbox.mboxMessage, mailbox.MHMessage,
1113 mailbox.BabylMessage, mailbox.MMDFMessage):
1114 other_msg = class_()
1115 msg._explain_to(other_msg)
Thomas Woutersb2137042007-02-01 18:02:27 +00001116 other_msg = email.message.Message()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001117 self.assertRaises(TypeError, lambda: msg._explain_to(other_msg))
1118
1119 def _post_initialize_hook(self, msg):
1120 # Overridden by subclasses to check extra things after initialization
1121 pass
1122
1123
1124class TestMaildirMessage(TestMessage):
1125
1126 _factory = mailbox.MaildirMessage
1127
1128 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001129 self.assertEqual(msg._subdir, 'new')
1130 self.assertEqual(msg._info, '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001131
1132 def test_subdir(self):
1133 # Use get_subdir() and set_subdir()
1134 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001135 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001136 msg.set_subdir('cur')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001137 self.assertEqual(msg.get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001138 msg.set_subdir('new')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001139 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001140 self.assertRaises(ValueError, lambda: msg.set_subdir('tmp'))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001141 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001142 msg.set_subdir('new')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001143 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001144 self._check_sample(msg)
1145
1146 def test_flags(self):
1147 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1148 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001149 self.assertEqual(msg.get_flags(), '')
1150 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001151 msg.set_flags('F')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001152 self.assertEqual(msg.get_subdir(), 'new')
1153 self.assertEqual(msg.get_flags(), 'F')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001154 msg.set_flags('SDTP')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001155 self.assertEqual(msg.get_flags(), 'DPST')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001156 msg.add_flag('FT')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001157 self.assertEqual(msg.get_flags(), 'DFPST')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001158 msg.remove_flag('TDRP')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001159 self.assertEqual(msg.get_flags(), 'FS')
1160 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001161 self._check_sample(msg)
1162
1163 def test_date(self):
1164 # Use get_date() and set_date()
1165 msg = mailbox.MaildirMessage(_sample_message)
Georg Brandl194da4a2009-08-13 09:34:05 +00001166 self.assertLess(abs(msg.get_date() - time.time()), 60)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001167 msg.set_date(0.0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001168 self.assertEqual(msg.get_date(), 0.0)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001169
1170 def test_info(self):
1171 # Use get_info() and set_info()
1172 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001173 self.assertEqual(msg.get_info(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001174 msg.set_info('1,foo=bar')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001175 self.assertEqual(msg.get_info(), '1,foo=bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001176 self.assertRaises(TypeError, lambda: msg.set_info(None))
1177 self._check_sample(msg)
1178
1179 def test_info_and_flags(self):
1180 # Test interaction of info and flag methods
1181 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001182 self.assertEqual(msg.get_info(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001183 msg.set_flags('SF')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001184 self.assertEqual(msg.get_flags(), 'FS')
1185 self.assertEqual(msg.get_info(), '2,FS')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001186 msg.set_info('1,')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001187 self.assertEqual(msg.get_flags(), '')
1188 self.assertEqual(msg.get_info(), '1,')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001189 msg.remove_flag('RPT')
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.add_flag('D')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001193 self.assertEqual(msg.get_flags(), 'D')
1194 self.assertEqual(msg.get_info(), '2,D')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001195 self._check_sample(msg)
1196
1197
1198class _TestMboxMMDFMessage(TestMessage):
1199
1200 _factory = mailbox._mboxMMDFMessage
1201
1202 def _post_initialize_hook(self, msg):
1203 self._check_from(msg)
1204
1205 def test_initialize_with_unixfrom(self):
1206 # Initialize with a message that already has a _unixfrom attribute
1207 msg = mailbox.Message(_sample_message)
1208 msg.set_unixfrom('From foo@bar blah')
1209 msg = mailbox.mboxMessage(msg)
Guido van Rossumea834472007-07-27 05:17:50 +00001210 self.assertEqual(msg.get_from(), 'foo@bar blah', msg.get_from())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001211
1212 def test_from(self):
1213 # Get and set "From " line
1214 msg = mailbox.mboxMessage(_sample_message)
1215 self._check_from(msg)
1216 msg.set_from('foo bar')
Guido van Rossumea834472007-07-27 05:17:50 +00001217 self.assertEqual(msg.get_from(), 'foo bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001218 msg.set_from('foo@bar', True)
1219 self._check_from(msg, 'foo@bar')
1220 msg.set_from('blah@temp', time.localtime())
1221 self._check_from(msg, 'blah@temp')
1222
1223 def test_flags(self):
1224 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1225 msg = mailbox.mboxMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001226 self.assertEqual(msg.get_flags(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001227 msg.set_flags('F')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001228 self.assertEqual(msg.get_flags(), 'F')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001229 msg.set_flags('XODR')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001230 self.assertEqual(msg.get_flags(), 'RODX')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001231 msg.add_flag('FA')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001232 self.assertEqual(msg.get_flags(), 'RODFAX')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001233 msg.remove_flag('FDXA')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001234 self.assertEqual(msg.get_flags(), 'RO')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001235 self._check_sample(msg)
1236
1237 def _check_from(self, msg, sender=None):
1238 # Check contents of "From " line
1239 if sender is None:
1240 sender = "MAILER-DAEMON"
Georg Brandlab91fde2009-08-13 08:51:18 +00001241 self.assertTrue(re.match(sender + r" \w{3} \w{3} [\d ]\d [\d ]\d:\d{2}:"
Thomas Wouters477c8d52006-05-27 19:21:47 +00001242 r"\d{2} \d{4}", msg.get_from()) is not None)
1243
1244
1245class TestMboxMessage(_TestMboxMMDFMessage):
1246
1247 _factory = mailbox.mboxMessage
1248
1249
1250class TestMHMessage(TestMessage):
1251
1252 _factory = mailbox.MHMessage
1253
1254 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001255 self.assertEqual(msg._sequences, [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001256
1257 def test_sequences(self):
1258 # Get, set, join, and leave sequences
1259 msg = mailbox.MHMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001260 self.assertEqual(msg.get_sequences(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001261 msg.set_sequences(['foobar'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001262 self.assertEqual(msg.get_sequences(), ['foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001263 msg.set_sequences([])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001264 self.assertEqual(msg.get_sequences(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001265 msg.add_sequence('unseen')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001266 self.assertEqual(msg.get_sequences(), ['unseen'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001267 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001268 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001269 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001270 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001271 msg.remove_sequence('unseen')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001272 self.assertEqual(msg.get_sequences(), ['flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001273 msg.add_sequence('foobar')
Guido van Rossumea834472007-07-27 05:17:50 +00001274 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001275 msg.remove_sequence('replied')
Guido van Rossumea834472007-07-27 05:17:50 +00001276 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001277 msg.set_sequences(['foobar', 'replied'])
Guido van Rossumea834472007-07-27 05:17:50 +00001278 self.assertEqual(msg.get_sequences(), ['foobar', 'replied'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001279
1280
1281class TestBabylMessage(TestMessage):
1282
1283 _factory = mailbox.BabylMessage
1284
1285 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001286 self.assertEqual(msg._labels, [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001287
1288 def test_labels(self):
1289 # Get, set, join, and leave labels
1290 msg = mailbox.BabylMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001291 self.assertEqual(msg.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001292 msg.set_labels(['foobar'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001293 self.assertEqual(msg.get_labels(), ['foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001294 msg.set_labels([])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001295 self.assertEqual(msg.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001296 msg.add_label('filed')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001297 self.assertEqual(msg.get_labels(), ['filed'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001298 msg.add_label('resent')
Guido van Rossumea834472007-07-27 05:17:50 +00001299 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001300 msg.add_label('resent')
Guido van Rossumea834472007-07-27 05:17:50 +00001301 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001302 msg.remove_label('filed')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001303 self.assertEqual(msg.get_labels(), ['resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001304 msg.add_label('foobar')
Guido van Rossumea834472007-07-27 05:17:50 +00001305 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001306 msg.remove_label('unseen')
Guido van Rossumea834472007-07-27 05:17:50 +00001307 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001308 msg.set_labels(['foobar', 'answered'])
Guido van Rossumea834472007-07-27 05:17:50 +00001309 self.assertEqual(msg.get_labels(), ['foobar', 'answered'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001310
1311 def test_visible(self):
1312 # Get, set, and update visible headers
1313 msg = mailbox.BabylMessage(_sample_message)
1314 visible = msg.get_visible()
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001315 self.assertEqual(visible.keys(), [])
Georg Brandl194da4a2009-08-13 09:34:05 +00001316 self.assertIs(visible.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001317 visible['User-Agent'] = 'FooBar 1.0'
1318 visible['X-Whatever'] = 'Blah'
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001319 self.assertEqual(msg.get_visible().keys(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001320 msg.set_visible(visible)
1321 visible = msg.get_visible()
Georg Brandlab91fde2009-08-13 08:51:18 +00001322 self.assertTrue(visible.keys() == ['User-Agent', 'X-Whatever'])
1323 self.assertTrue(visible['User-Agent'] == 'FooBar 1.0')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001324 self.assertEqual(visible['X-Whatever'], 'Blah')
Georg Brandl194da4a2009-08-13 09:34:05 +00001325 self.assertIs(visible.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001326 msg.update_visible()
Guido van Rossumea834472007-07-27 05:17:50 +00001327 self.assertEqual(visible.keys(), ['User-Agent', 'X-Whatever'])
Georg Brandl194da4a2009-08-13 09:34:05 +00001328 self.assertIs(visible.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001329 visible = msg.get_visible()
Guido van Rossumea834472007-07-27 05:17:50 +00001330 self.assertEqual(visible.keys(), ['User-Agent', 'Date', 'From', 'To',
1331 'Subject'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001332 for header in ('User-Agent', 'Date', 'From', 'To', 'Subject'):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001333 self.assertEqual(visible[header], msg[header])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001334
1335
1336class TestMMDFMessage(_TestMboxMMDFMessage):
1337
1338 _factory = mailbox.MMDFMessage
1339
1340
1341class TestMessageConversion(TestBase):
1342
1343 def test_plain_to_x(self):
1344 # Convert Message to all formats
1345 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1346 mailbox.mboxMessage, mailbox.MHMessage,
1347 mailbox.BabylMessage, mailbox.MMDFMessage):
1348 msg_plain = mailbox.Message(_sample_message)
1349 msg = class_(msg_plain)
1350 self._check_sample(msg)
1351
1352 def test_x_to_plain(self):
1353 # Convert all formats to Message
1354 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1355 mailbox.mboxMessage, mailbox.MHMessage,
1356 mailbox.BabylMessage, mailbox.MMDFMessage):
1357 msg = class_(_sample_message)
1358 msg_plain = mailbox.Message(msg)
1359 self._check_sample(msg_plain)
1360
1361 def test_x_to_invalid(self):
1362 # Convert all formats to an invalid format
1363 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1364 mailbox.mboxMessage, mailbox.MHMessage,
1365 mailbox.BabylMessage, mailbox.MMDFMessage):
1366 self.assertRaises(TypeError, lambda: class_(False))
1367
1368 def test_maildir_to_maildir(self):
1369 # Convert MaildirMessage to MaildirMessage
1370 msg_maildir = mailbox.MaildirMessage(_sample_message)
1371 msg_maildir.set_flags('DFPRST')
1372 msg_maildir.set_subdir('cur')
1373 date = msg_maildir.get_date()
1374 msg = mailbox.MaildirMessage(msg_maildir)
1375 self._check_sample(msg)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001376 self.assertEqual(msg.get_flags(), 'DFPRST')
1377 self.assertEqual(msg.get_subdir(), 'cur')
1378 self.assertEqual(msg.get_date(), date)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001379
1380 def test_maildir_to_mboxmmdf(self):
1381 # Convert MaildirMessage to mboxmessage and MMDFMessage
1382 pairs = (('D', ''), ('F', 'F'), ('P', ''), ('R', 'A'), ('S', 'R'),
1383 ('T', 'D'), ('DFPRST', 'RDFA'))
1384 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1385 msg_maildir = mailbox.MaildirMessage(_sample_message)
1386 msg_maildir.set_date(0.0)
1387 for setting, result in pairs:
1388 msg_maildir.set_flags(setting)
1389 msg = class_(msg_maildir)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001390 self.assertEqual(msg.get_flags(), result)
Guido van Rossumea834472007-07-27 05:17:50 +00001391 self.assertEqual(msg.get_from(), 'MAILER-DAEMON %s' %
Thomas Wouters477c8d52006-05-27 19:21:47 +00001392 time.asctime(time.gmtime(0.0)))
1393 msg_maildir.set_subdir('cur')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001394 self.assertEqual(class_(msg_maildir).get_flags(), 'RODFA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001395
1396 def test_maildir_to_mh(self):
1397 # Convert MaildirMessage to MHMessage
1398 msg_maildir = mailbox.MaildirMessage(_sample_message)
1399 pairs = (('D', ['unseen']), ('F', ['unseen', 'flagged']),
1400 ('P', ['unseen']), ('R', ['unseen', 'replied']), ('S', []),
1401 ('T', ['unseen']), ('DFPRST', ['replied', 'flagged']))
1402 for setting, result in pairs:
1403 msg_maildir.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001404 self.assertEqual(mailbox.MHMessage(msg_maildir).get_sequences(),
1405 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001406
1407 def test_maildir_to_babyl(self):
1408 # Convert MaildirMessage to Babyl
1409 msg_maildir = mailbox.MaildirMessage(_sample_message)
1410 pairs = (('D', ['unseen']), ('F', ['unseen']),
1411 ('P', ['unseen', 'forwarded']), ('R', ['unseen', 'answered']),
1412 ('S', []), ('T', ['unseen', 'deleted']),
1413 ('DFPRST', ['deleted', 'answered', 'forwarded']))
1414 for setting, result in pairs:
1415 msg_maildir.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001416 self.assertEqual(mailbox.BabylMessage(msg_maildir).get_labels(),
1417 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001418
1419 def test_mboxmmdf_to_maildir(self):
1420 # Convert mboxMessage and MMDFMessage to MaildirMessage
1421 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1422 msg_mboxMMDF = class_(_sample_message)
1423 msg_mboxMMDF.set_from('foo@bar', time.gmtime(0.0))
1424 pairs = (('R', 'S'), ('O', ''), ('D', 'T'), ('F', 'F'), ('A', 'R'),
1425 ('RODFA', 'FRST'))
1426 for setting, result in pairs:
1427 msg_mboxMMDF.set_flags(setting)
1428 msg = mailbox.MaildirMessage(msg_mboxMMDF)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001429 self.assertEqual(msg.get_flags(), result)
Georg Brandl194da4a2009-08-13 09:34:05 +00001430 self.assertEqual(msg.get_date(), 0.0)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001431 msg_mboxMMDF.set_flags('O')
Guido van Rossumea834472007-07-27 05:17:50 +00001432 self.assertEqual(mailbox.MaildirMessage(msg_mboxMMDF).get_subdir(),
1433 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001434
1435 def test_mboxmmdf_to_mboxmmdf(self):
1436 # Convert mboxMessage and MMDFMessage to mboxMessage and MMDFMessage
1437 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1438 msg_mboxMMDF = class_(_sample_message)
1439 msg_mboxMMDF.set_flags('RODFA')
1440 msg_mboxMMDF.set_from('foo@bar')
1441 for class2_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1442 msg2 = class2_(msg_mboxMMDF)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001443 self.assertEqual(msg2.get_flags(), 'RODFA')
1444 self.assertEqual(msg2.get_from(), 'foo@bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001445
1446 def test_mboxmmdf_to_mh(self):
1447 # Convert mboxMessage and MMDFMessage to MHMessage
1448 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1449 msg_mboxMMDF = class_(_sample_message)
1450 pairs = (('R', []), ('O', ['unseen']), ('D', ['unseen']),
1451 ('F', ['unseen', 'flagged']),
1452 ('A', ['unseen', 'replied']),
1453 ('RODFA', ['replied', 'flagged']))
1454 for setting, result in pairs:
1455 msg_mboxMMDF.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001456 self.assertEqual(mailbox.MHMessage(msg_mboxMMDF).get_sequences(),
1457 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001458
1459 def test_mboxmmdf_to_babyl(self):
1460 # Convert mboxMessage and MMDFMessage to BabylMessage
1461 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1462 msg = class_(_sample_message)
1463 pairs = (('R', []), ('O', ['unseen']),
1464 ('D', ['unseen', 'deleted']), ('F', ['unseen']),
1465 ('A', ['unseen', 'answered']),
1466 ('RODFA', ['deleted', 'answered']))
1467 for setting, result in pairs:
1468 msg.set_flags(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001469 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001470
1471 def test_mh_to_maildir(self):
1472 # Convert MHMessage to MaildirMessage
1473 pairs = (('unseen', ''), ('replied', 'RS'), ('flagged', 'FS'))
1474 for setting, result in pairs:
1475 msg = mailbox.MHMessage(_sample_message)
1476 msg.add_sequence(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001477 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1478 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001479 msg = mailbox.MHMessage(_sample_message)
1480 msg.add_sequence('unseen')
1481 msg.add_sequence('replied')
1482 msg.add_sequence('flagged')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001483 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'FR')
1484 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001485
1486 def test_mh_to_mboxmmdf(self):
1487 # Convert MHMessage to mboxMessage and MMDFMessage
1488 pairs = (('unseen', 'O'), ('replied', 'ROA'), ('flagged', 'ROF'))
1489 for setting, result in pairs:
1490 msg = mailbox.MHMessage(_sample_message)
1491 msg.add_sequence(setting)
1492 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001493 self.assertEqual(class_(msg).get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001494 msg = mailbox.MHMessage(_sample_message)
1495 msg.add_sequence('unseen')
1496 msg.add_sequence('replied')
1497 msg.add_sequence('flagged')
1498 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001499 self.assertEqual(class_(msg).get_flags(), 'OFA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001500
1501 def test_mh_to_mh(self):
1502 # Convert MHMessage to MHMessage
1503 msg = mailbox.MHMessage(_sample_message)
1504 msg.add_sequence('unseen')
1505 msg.add_sequence('replied')
1506 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001507 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1508 ['unseen', 'replied', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001509
1510 def test_mh_to_babyl(self):
1511 # Convert MHMessage to BabylMessage
1512 pairs = (('unseen', ['unseen']), ('replied', ['answered']),
1513 ('flagged', []))
1514 for setting, result in pairs:
1515 msg = mailbox.MHMessage(_sample_message)
1516 msg.add_sequence(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001517 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001518 msg = mailbox.MHMessage(_sample_message)
1519 msg.add_sequence('unseen')
1520 msg.add_sequence('replied')
1521 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001522 self.assertEqual(mailbox.BabylMessage(msg).get_labels(),
1523 ['unseen', 'answered'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001524
1525 def test_babyl_to_maildir(self):
1526 # Convert BabylMessage to MaildirMessage
1527 pairs = (('unseen', ''), ('deleted', 'ST'), ('filed', 'S'),
1528 ('answered', 'RS'), ('forwarded', 'PS'), ('edited', 'S'),
1529 ('resent', 'PS'))
1530 for setting, result in pairs:
1531 msg = mailbox.BabylMessage(_sample_message)
1532 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001533 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1534 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001535 msg = mailbox.BabylMessage(_sample_message)
1536 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1537 'edited', 'resent'):
1538 msg.add_label(label)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001539 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'PRT')
1540 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001541
1542 def test_babyl_to_mboxmmdf(self):
1543 # Convert BabylMessage to mboxMessage and MMDFMessage
1544 pairs = (('unseen', 'O'), ('deleted', 'ROD'), ('filed', 'RO'),
1545 ('answered', 'ROA'), ('forwarded', 'RO'), ('edited', 'RO'),
1546 ('resent', 'RO'))
1547 for setting, result in pairs:
1548 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1549 msg = mailbox.BabylMessage(_sample_message)
1550 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001551 self.assertEqual(class_(msg).get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001552 msg = mailbox.BabylMessage(_sample_message)
1553 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1554 'edited', 'resent'):
1555 msg.add_label(label)
1556 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001557 self.assertEqual(class_(msg).get_flags(), 'ODA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001558
1559 def test_babyl_to_mh(self):
1560 # Convert BabylMessage to MHMessage
1561 pairs = (('unseen', ['unseen']), ('deleted', []), ('filed', []),
1562 ('answered', ['replied']), ('forwarded', []), ('edited', []),
1563 ('resent', []))
1564 for setting, result in pairs:
1565 msg = mailbox.BabylMessage(_sample_message)
1566 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001567 self.assertEqual(mailbox.MHMessage(msg).get_sequences(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001568 msg = mailbox.BabylMessage(_sample_message)
1569 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1570 'edited', 'resent'):
1571 msg.add_label(label)
Guido van Rossumea834472007-07-27 05:17:50 +00001572 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1573 ['unseen', 'replied'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001574
1575 def test_babyl_to_babyl(self):
1576 # Convert BabylMessage to BabylMessage
1577 msg = mailbox.BabylMessage(_sample_message)
1578 msg.update_visible()
1579 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1580 'edited', 'resent'):
1581 msg.add_label(label)
1582 msg2 = mailbox.BabylMessage(msg)
Guido van Rossumea834472007-07-27 05:17:50 +00001583 self.assertEqual(msg2.get_labels(), ['unseen', 'deleted', 'filed',
1584 'answered', 'forwarded', 'edited',
1585 'resent'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001586 self.assertEqual(msg.get_visible().keys(), msg2.get_visible().keys())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001587 for key in msg.get_visible().keys():
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001588 self.assertEqual(msg.get_visible()[key], msg2.get_visible()[key])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001589
1590
1591class TestProxyFileBase(TestBase):
1592
1593 def _test_read(self, proxy):
1594 # Read by byte
1595 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001596 self.assertEqual(proxy.read(), b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001597 proxy.seek(1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001598 self.assertEqual(proxy.read(), b'ar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001599 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001600 self.assertEqual(proxy.read(2), b'ba')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001601 proxy.seek(1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001602 self.assertEqual(proxy.read(-1), b'ar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001603 proxy.seek(2)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001604 self.assertEqual(proxy.read(1000), b'r')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001605
1606 def _test_readline(self, proxy):
1607 # Read by line
Guido van Rossum98297ee2007-11-06 21:34:58 +00001608 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001609 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001610 self.assertEqual(proxy.readline(), b'foo' + linesep)
1611 self.assertEqual(proxy.readline(), b'bar' + linesep)
1612 self.assertEqual(proxy.readline(), b'fred' + linesep)
1613 self.assertEqual(proxy.readline(), b'bob')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001614 proxy.seek(2)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001615 self.assertEqual(proxy.readline(), b'o' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001616 proxy.seek(6 + 2 * len(os.linesep))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001617 self.assertEqual(proxy.readline(), b'fred' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001618 proxy.seek(6 + 2 * len(os.linesep))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001619 self.assertEqual(proxy.readline(2), b'fr')
1620 self.assertEqual(proxy.readline(-10), b'ed' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001621
1622 def _test_readlines(self, proxy):
1623 # Read multiple lines
Guido van Rossum98297ee2007-11-06 21:34:58 +00001624 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001625 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001626 self.assertEqual(proxy.readlines(), [b'foo' + linesep,
1627 b'bar' + linesep,
1628 b'fred' + linesep, b'bob'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001629 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001630 self.assertEqual(proxy.readlines(2), [b'foo' + linesep])
1631 proxy.seek(3 + len(linesep))
1632 self.assertEqual(proxy.readlines(4 + len(linesep)),
1633 [b'bar' + linesep, b'fred' + linesep])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001634 proxy.seek(3)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001635 self.assertEqual(proxy.readlines(1000), [linesep, b'bar' + linesep,
1636 b'fred' + linesep, b'bob'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001637
1638 def _test_iteration(self, proxy):
1639 # Iterate by line
Guido van Rossum98297ee2007-11-06 21:34:58 +00001640 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001641 proxy.seek(0)
1642 iterator = iter(proxy)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001643 self.assertEqual(next(iterator), b'foo' + linesep)
1644 self.assertEqual(next(iterator), b'bar' + linesep)
1645 self.assertEqual(next(iterator), b'fred' + linesep)
1646 self.assertEqual(next(iterator), b'bob')
Georg Brandla18af4e2007-04-21 15:47:16 +00001647 self.assertRaises(StopIteration, next, iterator)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001648
1649 def _test_seek_and_tell(self, proxy):
1650 # Seek and use tell to check position
Guido van Rossum98297ee2007-11-06 21:34:58 +00001651 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001652 proxy.seek(3)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001653 self.assertEqual(proxy.tell(), 3)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001654 self.assertEqual(proxy.read(len(linesep)), linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001655 proxy.seek(2, 1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001656 self.assertEqual(proxy.read(1 + len(linesep)), b'r' + linesep)
1657 proxy.seek(-3 - len(linesep), 2)
1658 self.assertEqual(proxy.read(3), b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001659 proxy.seek(2, 0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001660 self.assertEqual(proxy.read(), b'o' + linesep + b'bar' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001661 proxy.seek(100)
Georg Brandlab91fde2009-08-13 08:51:18 +00001662 self.assertFalse(proxy.read())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001663
1664 def _test_close(self, proxy):
1665 # Close a file
1666 proxy.close()
1667 self.assertRaises(AttributeError, lambda: proxy.close())
1668
1669
1670class TestProxyFile(TestProxyFileBase):
1671
1672 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001673 self._path = support.TESTFN
Thomas Wouters477c8d52006-05-27 19:21:47 +00001674 self._file = open(self._path, 'wb+')
1675
1676 def tearDown(self):
1677 self._file.close()
1678 self._delete_recursively(self._path)
1679
1680 def test_initialize(self):
1681 # Initialize and check position
Neal Norwitz9a923102007-08-30 06:20:05 +00001682 self._file.write(b'foo')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001683 pos = self._file.tell()
1684 proxy0 = mailbox._ProxyFile(self._file)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001685 self.assertEqual(proxy0.tell(), pos)
1686 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001687 proxy1 = mailbox._ProxyFile(self._file, 0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001688 self.assertEqual(proxy1.tell(), 0)
1689 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001690
1691 def test_read(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001692 self._file.write(b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001693 self._test_read(mailbox._ProxyFile(self._file))
1694
1695 def test_readline(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001696 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1697 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001698 self._test_readline(mailbox._ProxyFile(self._file))
1699
1700 def test_readlines(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001701 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1702 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001703 self._test_readlines(mailbox._ProxyFile(self._file))
1704
1705 def test_iteration(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001706 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1707 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001708 self._test_iteration(mailbox._ProxyFile(self._file))
1709
1710 def test_seek_and_tell(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001711 self._file.write(bytes('foo%sbar%s' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001712 self._test_seek_and_tell(mailbox._ProxyFile(self._file))
1713
1714 def test_close(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001715 self._file.write(bytes('foo%sbar%s' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001716 self._test_close(mailbox._ProxyFile(self._file))
1717
1718
1719class TestPartialFile(TestProxyFileBase):
1720
1721 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001722 self._path = support.TESTFN
Thomas Wouters477c8d52006-05-27 19:21:47 +00001723 self._file = open(self._path, 'wb+')
1724
1725 def tearDown(self):
1726 self._file.close()
1727 self._delete_recursively(self._path)
1728
1729 def test_initialize(self):
1730 # Initialize and check position
Neal Norwitz9a923102007-08-30 06:20:05 +00001731 self._file.write(bytes('foo' + os.linesep + 'bar', 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001732 pos = self._file.tell()
1733 proxy = mailbox._PartialFile(self._file, 2, 5)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001734 self.assertEqual(proxy.tell(), 0)
1735 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001736
1737 def test_read(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001738 self._file.write(bytes('***bar***', 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001739 self._test_read(mailbox._PartialFile(self._file, 3, 6))
1740
1741 def test_readline(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001742 self._file.write(bytes('!!!!!foo%sbar%sfred%sbob!!!!!' %
1743 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001744 self._test_readline(mailbox._PartialFile(self._file, 5,
1745 18 + 3 * len(os.linesep)))
1746
1747 def test_readlines(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001748 self._file.write(bytes('foo%sbar%sfred%sbob?????' %
1749 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001750 self._test_readlines(mailbox._PartialFile(self._file, 0,
1751 13 + 3 * len(os.linesep)))
1752
1753 def test_iteration(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001754 self._file.write(bytes('____foo%sbar%sfred%sbob####' %
1755 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001756 self._test_iteration(mailbox._PartialFile(self._file, 4,
1757 17 + 3 * len(os.linesep)))
1758
1759 def test_seek_and_tell(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001760 self._file.write(bytes('(((foo%sbar%s$$$' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001761 self._test_seek_and_tell(mailbox._PartialFile(self._file, 3,
1762 9 + 2 * len(os.linesep)))
1763
1764 def test_close(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001765 self._file.write(bytes('&foo%sbar%s^' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001766 self._test_close(mailbox._PartialFile(self._file, 1,
1767 6 + 3 * len(os.linesep)))
1768
1769
1770## Start: tests from the original module (for backward compatibility).
1771
Skip Montanaro5253da12004-07-24 19:56:03 +00001772FROM_ = "From some.body@dummy.domain Sat Jul 24 13:43:35 2004\n"
Fred Drakec02bc3e2001-05-21 20:23:21 +00001773DUMMY_MESSAGE = """\
1774From: some.body@dummy.domain
1775To: me@my.domain
Skip Montanaro5253da12004-07-24 19:56:03 +00001776Subject: Simple Test
Fred Drakec02bc3e2001-05-21 20:23:21 +00001777
1778This is a dummy message.
1779"""
1780
Fred Drakec02bc3e2001-05-21 20:23:21 +00001781class MaildirTestCase(unittest.TestCase):
1782
1783 def setUp(self):
1784 # create a new maildir mailbox to work with:
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001785 self._dir = support.TESTFN
Fred Drakec02bc3e2001-05-21 20:23:21 +00001786 os.mkdir(self._dir)
1787 os.mkdir(os.path.join(self._dir, "cur"))
1788 os.mkdir(os.path.join(self._dir, "tmp"))
1789 os.mkdir(os.path.join(self._dir, "new"))
1790 self._counter = 1
1791 self._msgfiles = []
1792
1793 def tearDown(self):
Guido van Rossumc1f779c2007-07-03 08:25:58 +00001794 list(map(os.unlink, self._msgfiles))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001795 os.rmdir(os.path.join(self._dir, "cur"))
1796 os.rmdir(os.path.join(self._dir, "tmp"))
1797 os.rmdir(os.path.join(self._dir, "new"))
1798 os.rmdir(self._dir)
1799
Skip Montanaro5253da12004-07-24 19:56:03 +00001800 def createMessage(self, dir, mbox=False):
Jack Jansen97df7b62001-06-19 20:20:05 +00001801 t = int(time.time() % 1000000)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001802 pid = self._counter
1803 self._counter += 1
Skip Montanaro7a98be22007-08-16 14:35:24 +00001804 filename = ".".join((str(t), str(pid), "myhostname", "mydomain"))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001805 tmpname = os.path.join(self._dir, "tmp", filename)
1806 newname = os.path.join(self._dir, dir, filename)
1807 fp = open(tmpname, "w")
1808 self._msgfiles.append(tmpname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001809 if mbox:
1810 fp.write(FROM_)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001811 fp.write(DUMMY_MESSAGE)
1812 fp.close()
Tim Peters6626c1f2001-05-22 16:29:01 +00001813 if hasattr(os, "link"):
1814 os.link(tmpname, newname)
1815 else:
1816 fp = open(newname, "w")
1817 fp.write(DUMMY_MESSAGE)
1818 fp.close()
Fred Drakec02bc3e2001-05-21 20:23:21 +00001819 self._msgfiles.append(newname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001820 return tmpname
Fred Drakec02bc3e2001-05-21 20:23:21 +00001821
1822 def test_empty_maildir(self):
1823 """Test an empty maildir mailbox"""
1824 # Test for regression on bug #117490:
1825 # Make sure the boxes attribute actually gets set.
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001826 self.mbox = mailbox.Maildir(support.TESTFN)
Georg Brandlab91fde2009-08-13 08:51:18 +00001827 #self.assertTrue(hasattr(self.mbox, "boxes"))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001828 #self.assertEqual(len(self.mbox.boxes), 0)
Georg Brandl194da4a2009-08-13 09:34:05 +00001829 self.assertIs(self.mbox.next(), None)
1830 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001831
1832 def test_nonempty_maildir_cur(self):
1833 self.createMessage("cur")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001834 self.mbox = mailbox.Maildir(support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001835 #self.assertEqual(len(self.mbox.boxes), 1)
Georg Brandl194da4a2009-08-13 09:34:05 +00001836 self.assertIsNot(self.mbox.next(), None)
1837 self.assertIs(self.mbox.next(), None)
1838 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001839
1840 def test_nonempty_maildir_new(self):
1841 self.createMessage("new")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001842 self.mbox = mailbox.Maildir(support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001843 #self.assertEqual(len(self.mbox.boxes), 1)
Georg Brandl194da4a2009-08-13 09:34:05 +00001844 self.assertIsNot(self.mbox.next(), None)
1845 self.assertIs(self.mbox.next(), None)
1846 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001847
1848 def test_nonempty_maildir_both(self):
1849 self.createMessage("cur")
1850 self.createMessage("new")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001851 self.mbox = mailbox.Maildir(support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001852 #self.assertEqual(len(self.mbox.boxes), 2)
Georg Brandl194da4a2009-08-13 09:34:05 +00001853 self.assertIsNot(self.mbox.next(), None)
1854 self.assertIsNot(self.mbox.next(), None)
1855 self.assertIs(self.mbox.next(), None)
1856 self.assertIs(self.mbox.next(), None)
Fred Drake0aaed272000-10-23 13:39:15 +00001857
Georg Brandledb978f2008-05-11 08:59:40 +00001858## End: tests from the original module (for backward compatibility).
Thomas Wouters477c8d52006-05-27 19:21:47 +00001859
1860
1861_sample_message = """\
1862Return-Path: <gkj@gregorykjohnson.com>
1863X-Original-To: gkj+person@localhost
1864Delivered-To: gkj+person@localhost
1865Received: from localhost (localhost [127.0.0.1])
1866 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1867 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
1868Delivered-To: gkj@sundance.gregorykjohnson.com
1869Received: from localhost [127.0.0.1]
1870 by localhost with POP3 (fetchmail-6.2.5)
1871 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
1872Received: from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
1873 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1874 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
1875Received: by andy.gregorykjohnson.com (Postfix, from userid 1000)
1876 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
1877Date: Wed, 13 Jul 2005 17:23:11 -0400
1878From: "Gregory K. Johnson" <gkj@gregorykjohnson.com>
1879To: gkj@gregorykjohnson.com
1880Subject: Sample message
1881Message-ID: <20050713212311.GC4701@andy.gregorykjohnson.com>
1882Mime-Version: 1.0
1883Content-Type: multipart/mixed; boundary="NMuMz9nt05w80d4+"
1884Content-Disposition: inline
1885User-Agent: Mutt/1.5.9i
1886
1887
1888--NMuMz9nt05w80d4+
1889Content-Type: text/plain; charset=us-ascii
1890Content-Disposition: inline
1891
1892This is a sample message.
1893
1894--
1895Gregory K. Johnson
1896
1897--NMuMz9nt05w80d4+
1898Content-Type: application/octet-stream
1899Content-Disposition: attachment; filename="text.gz"
1900Content-Transfer-Encoding: base64
1901
1902H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
19033FYlAAAA
1904
1905--NMuMz9nt05w80d4+--
1906"""
1907
1908_sample_headers = {
1909 "Return-Path":"<gkj@gregorykjohnson.com>",
1910 "X-Original-To":"gkj+person@localhost",
1911 "Delivered-To":"gkj+person@localhost",
1912 "Received":"""from localhost (localhost [127.0.0.1])
1913 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1914 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
1915 "Delivered-To":"gkj@sundance.gregorykjohnson.com",
1916 "Received":"""from localhost [127.0.0.1]
1917 by localhost with POP3 (fetchmail-6.2.5)
1918 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
1919 "Received":"""from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
1920 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1921 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
1922 "Received":"""by andy.gregorykjohnson.com (Postfix, from userid 1000)
1923 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
1924 "Date":"Wed, 13 Jul 2005 17:23:11 -0400",
1925 "From":""""Gregory K. Johnson" <gkj@gregorykjohnson.com>""",
1926 "To":"gkj@gregorykjohnson.com",
1927 "Subject":"Sample message",
1928 "Mime-Version":"1.0",
1929 "Content-Type":"""multipart/mixed; boundary="NMuMz9nt05w80d4+\"""",
1930 "Content-Disposition":"inline",
1931 "User-Agent": "Mutt/1.5.9i" }
1932
1933_sample_payloads = ("""This is a sample message.
1934
1935--
1936Gregory K. Johnson
1937""",
1938"""H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
19393FYlAAAA
1940""")
Fred Drake0aaed272000-10-23 13:39:15 +00001941
Fred Drakec02bc3e2001-05-21 20:23:21 +00001942
Fred Drake2e2be372001-09-20 21:33:42 +00001943def test_main():
Thomas Wouters477c8d52006-05-27 19:21:47 +00001944 tests = (TestMailboxSuperclass, TestMaildir, TestMbox, TestMMDF, TestMH,
1945 TestBabyl, TestMessage, TestMaildirMessage, TestMboxMessage,
1946 TestMHMessage, TestBabylMessage, TestMMDFMessage,
1947 TestMessageConversion, TestProxyFile, TestPartialFile,
1948 MaildirTestCase)
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001949 support.run_unittest(*tests)
1950 support.reap_children()
Fred Drake2e2be372001-09-20 21:33:42 +00001951
1952
Thomas Wouters477c8d52006-05-27 19:21:47 +00001953if __name__ == '__main__':
Fred Drake2e2be372001-09-20 21:33:42 +00001954 test_main()