blob: de6d4bd47c2f8c6831eae71b9604ada539fc4afc [file] [log] [blame]
Fred Drake0aaed272000-10-23 13:39:15 +00001import os
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00002import sys
Fred Drakec02bc3e2001-05-21 20:23:21 +00003import time
Thomas Wouters477c8d52006-05-27 19:21:47 +00004import stat
5import socket
6import email
Thomas Woutersb2137042007-02-01 18:02:27 +00007import email.message
Thomas Wouters477c8d52006-05-27 19:21:47 +00008import re
Guido van Rossum34d19282007-08-09 01:03:29 +00009import io
Benjamin Petersonee8712c2008-05-20 21:35:26 +000010from test import support
Thomas Wouters477c8d52006-05-27 19:21:47 +000011import unittest
12import mailbox
13import glob
Guido van Rossum75ebb292001-04-10 15:01:20 +000014try:
Thomas Wouters477c8d52006-05-27 19:21:47 +000015 import fcntl
16except ImportError:
Guido van Rossum75ebb292001-04-10 15:01:20 +000017 pass
18
Thomas Wouters477c8d52006-05-27 19:21:47 +000019
20class TestBase(unittest.TestCase):
21
22 def _check_sample(self, msg):
23 # Inspect a mailbox.Message representation of the sample message
Ezio Melottie9615932010-01-24 19:26:24 +000024 self.assertIsInstance(msg, email.message.Message)
25 self.assertIsInstance(msg, mailbox.Message)
Guido van Rossumcc2b0162007-02-11 06:12:03 +000026 for key, value in _sample_headers.items():
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +000027 self.assertIn(value, msg.get_all(key))
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000028 self.assertTrue(msg.is_multipart())
Guido van Rossume61fd5b2007-07-11 12:20:59 +000029 self.assertEqual(len(msg.get_payload()), len(_sample_payloads))
Thomas Wouters477c8d52006-05-27 19:21:47 +000030 for i, payload in enumerate(_sample_payloads):
31 part = msg.get_payload(i)
Ezio Melottie9615932010-01-24 19:26:24 +000032 self.assertIsInstance(part, email.message.Message)
33 self.assertNotIsInstance(part, mailbox.Message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +000034 self.assertEqual(part.get_payload(), payload)
Thomas Wouters477c8d52006-05-27 19:21:47 +000035
36 def _delete_recursively(self, target):
37 # Delete a file or delete a directory recursively
38 if os.path.isdir(target):
39 for path, dirs, files in os.walk(target, topdown=False):
40 for name in files:
41 os.remove(os.path.join(path, name))
42 for name in dirs:
43 os.rmdir(os.path.join(path, name))
44 os.rmdir(target)
45 elif os.path.exists(target):
46 os.remove(target)
47
48
49class TestMailbox(TestBase):
50
51 _factory = None # Overridden by subclasses to reuse tests
52 _template = 'From: foo\n\n%s'
53
54 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +000055 self._path = support.TESTFN
Guido van Rossumd8faa362007-04-27 19:54:29 +000056 self._delete_recursively(self._path)
Thomas Wouters477c8d52006-05-27 19:21:47 +000057 self._box = self._factory(self._path)
58
59 def tearDown(self):
Guido van Rossumc12a8132007-10-26 04:29:23 +000060 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +000061 self._delete_recursively(self._path)
62
63 def test_add(self):
64 # Add copies of a sample message
65 keys = []
66 keys.append(self._box.add(self._template % 0))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000067 self.assertEqual(len(self._box), 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +000068 keys.append(self._box.add(mailbox.Message(_sample_message)))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000069 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +000070 keys.append(self._box.add(email.message_from_string(_sample_message)))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000071 self.assertEqual(len(self._box), 3)
Guido van Rossum34d19282007-08-09 01:03:29 +000072 keys.append(self._box.add(io.StringIO(_sample_message)))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000073 self.assertEqual(len(self._box), 4)
Thomas Wouters477c8d52006-05-27 19:21:47 +000074 keys.append(self._box.add(_sample_message))
Guido van Rossume61fd5b2007-07-11 12:20:59 +000075 self.assertEqual(len(self._box), 5)
Guido van Rossumea834472007-07-27 05:17:50 +000076 self.assertEqual(self._box.get_string(keys[0]), self._template % 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +000077 for i in (1, 2, 3, 4):
78 self._check_sample(self._box[keys[i]])
79
80 def test_remove(self):
81 # Remove messages using remove()
82 self._test_remove_or_delitem(self._box.remove)
83
84 def test_delitem(self):
85 # Remove messages using __delitem__()
86 self._test_remove_or_delitem(self._box.__delitem__)
87
88 def _test_remove_or_delitem(self, method):
89 # (Used by test_remove() and test_delitem().)
90 key0 = self._box.add(self._template % 0)
91 key1 = self._box.add(self._template % 1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +000092 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +000093 method(key0)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +000094 self.assertEqual(len(self._box), 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +000095 self.assertRaises(KeyError, lambda: self._box[key0])
96 self.assertRaises(KeyError, lambda: method(key0))
Guido van Rossumea834472007-07-27 05:17:50 +000097 self.assertEqual(self._box.get_string(key1), self._template % 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +000098 key2 = self._box.add(self._template % 2)
Guido van Rossume61fd5b2007-07-11 12:20:59 +000099 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000100 method(key2)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000101 self.assertEqual(len(self._box), 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000102 self.assertRaises(KeyError, lambda: self._box[key2])
103 self.assertRaises(KeyError, lambda: method(key2))
Guido van Rossumea834472007-07-27 05:17:50 +0000104 self.assertEqual(self._box.get_string(key1), self._template % 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000105 method(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000106 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000107 self.assertRaises(KeyError, lambda: self._box[key1])
108 self.assertRaises(KeyError, lambda: method(key1))
109
110 def test_discard(self, repetitions=10):
111 # Discard messages
112 key0 = self._box.add(self._template % 0)
113 key1 = self._box.add(self._template % 1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000114 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000115 self._box.discard(key0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000116 self.assertEqual(len(self._box), 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000117 self.assertRaises(KeyError, lambda: self._box[key0])
118 self._box.discard(key0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000119 self.assertEqual(len(self._box), 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000120 self.assertRaises(KeyError, lambda: self._box[key0])
121
122 def test_get(self):
123 # Retrieve messages using get()
124 key0 = self._box.add(self._template % 0)
125 msg = self._box.get(key0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000126 self.assertEqual(msg['from'], 'foo')
127 self.assertEqual(msg.get_payload(), '0')
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000128 self.assertIs(self._box.get('foo'), None)
129 self.assertIs(self._box.get('foo', False), False)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000130 self._box.close()
Georg Brandlfb16cf12008-05-11 21:31:44 +0000131 self._box = self._factory(self._path)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000132 key1 = self._box.add(self._template % 1)
133 msg = self._box.get(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000134 self.assertEqual(msg['from'], 'foo')
Georg Brandlfb16cf12008-05-11 21:31:44 +0000135 self.assertEqual(msg.get_payload(), '1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000136
137 def test_getitem(self):
138 # Retrieve message using __getitem__()
139 key0 = self._box.add(self._template % 0)
140 msg = self._box[key0]
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000141 self.assertEqual(msg['from'], 'foo')
142 self.assertEqual(msg.get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000143 self.assertRaises(KeyError, lambda: self._box['foo'])
144 self._box.discard(key0)
145 self.assertRaises(KeyError, lambda: self._box[key0])
146
147 def test_get_message(self):
148 # Get Message representations of messages
149 key0 = self._box.add(self._template % 0)
150 key1 = self._box.add(_sample_message)
151 msg0 = self._box.get_message(key0)
Ezio Melottie9615932010-01-24 19:26:24 +0000152 self.assertIsInstance(msg0, mailbox.Message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000153 self.assertEqual(msg0['from'], 'foo')
154 self.assertEqual(msg0.get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000155 self._check_sample(self._box.get_message(key1))
156
157 def test_get_string(self):
158 # Get string representations of messages
159 key0 = self._box.add(self._template % 0)
160 key1 = self._box.add(_sample_message)
Guido van Rossumea834472007-07-27 05:17:50 +0000161 self.assertEqual(self._box.get_string(key0), self._template % 0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000162 self.assertEqual(self._box.get_string(key1), _sample_message)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000163
164 def test_get_file(self):
165 # Get file representations of messages
166 key0 = self._box.add(self._template % 0)
167 key1 = self._box.add(_sample_message)
Brett Cannon653238a2010-10-30 00:13:00 +0000168 with self._box.get_file(key0) as file:
169 data0 = file.read()
170 with self._box.get_file(key1) as file:
171 data1 = file.read()
Guido van Rossum98297ee2007-11-06 21:34:58 +0000172 self.assertEqual(data0.replace(os.linesep, '\n'),
Guido van Rossumea834472007-07-27 05:17:50 +0000173 self._template % 0)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000174 self.assertEqual(data1.replace(os.linesep, '\n'),
Guido van Rossumea834472007-07-27 05:17:50 +0000175 _sample_message)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000176
177 def test_iterkeys(self):
178 # Get keys using iterkeys()
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000179 self._check_iteration(self._box.keys, do_keys=True, do_values=False)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000180
181 def test_keys(self):
182 # Get keys using keys()
183 self._check_iteration(self._box.keys, do_keys=True, do_values=False)
184
185 def test_itervalues(self):
186 # Get values using itervalues()
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000187 self._check_iteration(self._box.values, do_keys=False,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000188 do_values=True)
189
190 def test_iter(self):
191 # Get values using __iter__()
192 self._check_iteration(self._box.__iter__, do_keys=False,
193 do_values=True)
194
195 def test_values(self):
196 # Get values using values()
197 self._check_iteration(self._box.values, do_keys=False, do_values=True)
198
199 def test_iteritems(self):
200 # Get keys and values using iteritems()
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000201 self._check_iteration(self._box.items, do_keys=True,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000202 do_values=True)
203
204 def test_items(self):
205 # Get keys and values using items()
206 self._check_iteration(self._box.items, do_keys=True, do_values=True)
207
208 def _check_iteration(self, method, do_keys, do_values, repetitions=10):
209 for value in method():
210 self.fail("Not empty")
211 keys, values = [], []
Guido van Rossum805365e2007-05-07 22:24:25 +0000212 for i in range(repetitions):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000213 keys.append(self._box.add(self._template % i))
214 values.append(self._template % i)
215 if do_keys and not do_values:
216 returned_keys = list(method())
217 elif do_values and not do_keys:
218 returned_values = list(method())
219 else:
220 returned_keys, returned_values = [], []
221 for key, value in method():
222 returned_keys.append(key)
223 returned_values.append(value)
224 if do_keys:
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000225 self.assertEqual(len(keys), len(returned_keys))
226 self.assertEqual(set(keys), set(returned_keys))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000227 if do_values:
228 count = 0
229 for value in returned_values:
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000230 self.assertEqual(value['from'], 'foo')
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000231 self.assertLess(int(value.get_payload()), repetitions)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000232 count += 1
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000233 self.assertEqual(len(values), count)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000234
Thomas Wouters477c8d52006-05-27 19:21:47 +0000235 def test_contains(self):
236 # Check existence of keys using __contains__()
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000237 self.assertNotIn('foo', self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000238 key0 = self._box.add(self._template % 0)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000239 self.assertIn(key0, self._box)
240 self.assertNotIn('foo', self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000241 key1 = self._box.add(self._template % 1)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000242 self.assertIn(key1, self._box)
243 self.assertIn(key0, self._box)
244 self.assertNotIn('foo', self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000245 self._box.remove(key0)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000246 self.assertNotIn(key0, self._box)
247 self.assertIn(key1, self._box)
248 self.assertNotIn('foo', self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000249 self._box.remove(key1)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000250 self.assertNotIn(key1, self._box)
251 self.assertNotIn(key0, self._box)
252 self.assertNotIn('foo', self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000253
254 def test_len(self, repetitions=10):
255 # Get message count
256 keys = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000257 for i in range(repetitions):
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000258 self.assertEqual(len(self._box), i)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000259 keys.append(self._box.add(self._template % i))
Guido van Rossumea834472007-07-27 05:17:50 +0000260 self.assertEqual(len(self._box), i + 1)
Guido van Rossum805365e2007-05-07 22:24:25 +0000261 for i in range(repetitions):
Guido van Rossumea834472007-07-27 05:17:50 +0000262 self.assertEqual(len(self._box), repetitions - i)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000263 self._box.remove(keys[i])
Guido van Rossumea834472007-07-27 05:17:50 +0000264 self.assertEqual(len(self._box), repetitions - i - 1)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000265
266 def test_set_item(self):
267 # Modify messages using __setitem__()
268 key0 = self._box.add(self._template % 'original 0')
Guido van Rossumea834472007-07-27 05:17:50 +0000269 self.assertEqual(self._box.get_string(key0),
270 self._template % 'original 0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000271 key1 = self._box.add(self._template % 'original 1')
Guido van Rossumea834472007-07-27 05:17:50 +0000272 self.assertEqual(self._box.get_string(key1),
273 self._template % 'original 1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000274 self._box[key0] = self._template % 'changed 0'
Guido van Rossumea834472007-07-27 05:17:50 +0000275 self.assertEqual(self._box.get_string(key0),
276 self._template % 'changed 0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000277 self._box[key1] = self._template % 'changed 1'
Guido van Rossumea834472007-07-27 05:17:50 +0000278 self.assertEqual(self._box.get_string(key1),
279 self._template % 'changed 1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000280 self._box[key0] = _sample_message
281 self._check_sample(self._box[key0])
282 self._box[key1] = self._box[key0]
283 self._check_sample(self._box[key1])
284 self._box[key0] = self._template % 'original 0'
Guido van Rossumea834472007-07-27 05:17:50 +0000285 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000286 self._template % 'original 0')
287 self._check_sample(self._box[key1])
288 self.assertRaises(KeyError,
289 lambda: self._box.__setitem__('foo', 'bar'))
290 self.assertRaises(KeyError, lambda: self._box['foo'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000291 self.assertEqual(len(self._box), 2)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000292
293 def test_clear(self, iterations=10):
294 # Remove all messages using clear()
295 keys = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000296 for i in range(iterations):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000297 self._box.add(self._template % i)
298 for i, key in enumerate(keys):
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000299 self.assertEqual(self._box.get_string(key), self._template % i)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000300 self._box.clear()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000301 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000302 for i, key in enumerate(keys):
303 self.assertRaises(KeyError, lambda: self._box.get_string(key))
304
305 def test_pop(self):
306 # Get and remove a message using pop()
307 key0 = self._box.add(self._template % 0)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000308 self.assertIn(key0, self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000309 key1 = self._box.add(self._template % 1)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000310 self.assertIn(key1, self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000311 self.assertEqual(self._box.pop(key0).get_payload(), '0')
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000312 self.assertNotIn(key0, self._box)
313 self.assertIn(key1, self._box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000314 key2 = self._box.add(self._template % 2)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000315 self.assertIn(key2, self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000316 self.assertEqual(self._box.pop(key2).get_payload(), '2')
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000317 self.assertNotIn(key2, self._box)
318 self.assertIn(key1, self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000319 self.assertEqual(self._box.pop(key1).get_payload(), '1')
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000320 self.assertNotIn(key1, self._box)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000321 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000322
323 def test_popitem(self, iterations=10):
324 # Get and remove an arbitrary (key, message) using popitem()
325 keys = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000326 for i in range(10):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000327 keys.append(self._box.add(self._template % i))
328 seen = []
Guido van Rossum805365e2007-05-07 22:24:25 +0000329 for i in range(10):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000330 key, msg = self._box.popitem()
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000331 self.assertIn(key, keys)
332 self.assertNotIn(key, seen)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000333 seen.append(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000334 self.assertEqual(int(msg.get_payload()), keys.index(key))
335 self.assertEqual(len(self._box), 0)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000336 for key in keys:
337 self.assertRaises(KeyError, lambda: self._box[key])
338
339 def test_update(self):
340 # Modify multiple messages using update()
341 key0 = self._box.add(self._template % 'original 0')
342 key1 = self._box.add(self._template % 'original 1')
343 key2 = self._box.add(self._template % 'original 2')
344 self._box.update({key0: self._template % 'changed 0',
345 key2: _sample_message})
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000346 self.assertEqual(len(self._box), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000347 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000348 self._template % 'changed 0')
Guido van Rossumea834472007-07-27 05:17:50 +0000349 self.assertEqual(self._box.get_string(key1),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000350 self._template % 'original 1')
351 self._check_sample(self._box[key2])
352 self._box.update([(key2, self._template % 'changed 2'),
353 (key1, self._template % 'changed 1'),
354 (key0, self._template % 'original 0')])
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000355 self.assertEqual(len(self._box), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000356 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000357 self._template % 'original 0')
Guido van Rossumea834472007-07-27 05:17:50 +0000358 self.assertEqual(self._box.get_string(key1),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000359 self._template % 'changed 1')
Guido van Rossumea834472007-07-27 05:17:50 +0000360 self.assertEqual(self._box.get_string(key2),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000361 self._template % 'changed 2')
362 self.assertRaises(KeyError,
363 lambda: self._box.update({'foo': 'bar',
364 key0: self._template % "changed 0"}))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000365 self.assertEqual(len(self._box), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000366 self.assertEqual(self._box.get_string(key0),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000367 self._template % "changed 0")
Guido van Rossumea834472007-07-27 05:17:50 +0000368 self.assertEqual(self._box.get_string(key1),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000369 self._template % "changed 1")
Guido van Rossumea834472007-07-27 05:17:50 +0000370 self.assertEqual(self._box.get_string(key2),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000371 self._template % "changed 2")
372
373 def test_flush(self):
374 # Write changes to disk
Christian Heimesf6cd9672008-03-26 13:45:42 +0000375 self._test_flush_or_close(self._box.flush, True)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000376
377 def test_lock_unlock(self):
378 # Lock and unlock the mailbox
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000379 self.assertFalse(os.path.exists(self._get_lock_path()))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000380 self._box.lock()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000381 self.assertTrue(os.path.exists(self._get_lock_path()))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000382 self._box.unlock()
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000383 self.assertFalse(os.path.exists(self._get_lock_path()))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000384
385 def test_close(self):
386 # Close mailbox and flush changes to disk
Christian Heimesf6cd9672008-03-26 13:45:42 +0000387 self._test_flush_or_close(self._box.close, False)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000388
Christian Heimesf6cd9672008-03-26 13:45:42 +0000389 def _test_flush_or_close(self, method, should_call_close):
Guido van Rossum805365e2007-05-07 22:24:25 +0000390 contents = [self._template % i for i in range(3)]
Thomas Wouters477c8d52006-05-27 19:21:47 +0000391 self._box.add(contents[0])
392 self._box.add(contents[1])
393 self._box.add(contents[2])
Guido van Rossumc12a8132007-10-26 04:29:23 +0000394 oldbox = self._box
Thomas Wouters477c8d52006-05-27 19:21:47 +0000395 method()
Christian Heimesf6cd9672008-03-26 13:45:42 +0000396 if should_call_close:
397 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000398 self._box = self._factory(self._path)
399 keys = self._box.keys()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000400 self.assertEqual(len(keys), 3)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000401 for key in keys:
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000402 self.assertIn(self._box.get_string(key), contents)
Guido van Rossumc12a8132007-10-26 04:29:23 +0000403 oldbox.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000404
405 def test_dump_message(self):
406 # Write message representations to disk
407 for input in (email.message_from_string(_sample_message),
Guido van Rossum34d19282007-08-09 01:03:29 +0000408 _sample_message, io.StringIO(_sample_message)):
409 output = io.StringIO()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000410 self._box._dump_message(input, output)
Amaury Forgeot d'Arc9edef042008-03-26 19:49:26 +0000411 self.assertEqual(output.getvalue(), _sample_message)
Guido van Rossum34d19282007-08-09 01:03:29 +0000412 output = io.StringIO()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000413 self.assertRaises(TypeError,
414 lambda: self._box._dump_message(None, output))
415
416 def _get_lock_path(self):
417 # Return the path of the dot lock file. May be overridden.
418 return self._path + '.lock'
419
420
421class TestMailboxSuperclass(TestBase):
422
423 def test_notimplemented(self):
424 # Test that all Mailbox methods raise NotImplementedException.
425 box = mailbox.Mailbox('path')
426 self.assertRaises(NotImplementedError, lambda: box.add(''))
427 self.assertRaises(NotImplementedError, lambda: box.remove(''))
428 self.assertRaises(NotImplementedError, lambda: box.__delitem__(''))
429 self.assertRaises(NotImplementedError, lambda: box.discard(''))
430 self.assertRaises(NotImplementedError, lambda: box.__setitem__('', ''))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000431 self.assertRaises(NotImplementedError, lambda: box.keys())
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000432 self.assertRaises(NotImplementedError, lambda: box.keys())
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000433 self.assertRaises(NotImplementedError, lambda: box.values().__next__())
434 self.assertRaises(NotImplementedError, lambda: box.__iter__().__next__())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000435 self.assertRaises(NotImplementedError, lambda: box.values())
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000436 self.assertRaises(NotImplementedError, lambda: box.items().next())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000437 self.assertRaises(NotImplementedError, lambda: box.items())
438 self.assertRaises(NotImplementedError, lambda: box.get(''))
439 self.assertRaises(NotImplementedError, lambda: box.__getitem__(''))
440 self.assertRaises(NotImplementedError, lambda: box.get_message(''))
441 self.assertRaises(NotImplementedError, lambda: box.get_string(''))
442 self.assertRaises(NotImplementedError, lambda: box.get_file(''))
Guido van Rossume2b70bc2006-08-18 22:13:04 +0000443 self.assertRaises(NotImplementedError, lambda: '' in box)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000444 self.assertRaises(NotImplementedError, lambda: box.__contains__(''))
445 self.assertRaises(NotImplementedError, lambda: box.__len__())
446 self.assertRaises(NotImplementedError, lambda: box.clear())
447 self.assertRaises(NotImplementedError, lambda: box.pop(''))
448 self.assertRaises(NotImplementedError, lambda: box.popitem())
449 self.assertRaises(NotImplementedError, lambda: box.update((('', ''),)))
450 self.assertRaises(NotImplementedError, lambda: box.flush())
451 self.assertRaises(NotImplementedError, lambda: box.lock())
452 self.assertRaises(NotImplementedError, lambda: box.unlock())
453 self.assertRaises(NotImplementedError, lambda: box.close())
454
455
456class TestMaildir(TestMailbox):
457
458 _factory = lambda self, path, factory=None: mailbox.Maildir(path, factory)
459
460 def setUp(self):
461 TestMailbox.setUp(self)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000462 if os.name in ('nt', 'os2') or sys.platform == 'cygwin':
Thomas Wouters477c8d52006-05-27 19:21:47 +0000463 self._box.colon = '!'
464
465 def test_add_MM(self):
466 # Add a MaildirMessage instance
467 msg = mailbox.MaildirMessage(self._template % 0)
468 msg.set_subdir('cur')
469 msg.set_info('foo')
470 key = self._box.add(msg)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000471 self.assertTrue(os.path.exists(os.path.join(self._path, 'cur', '%s%sfoo' %
Thomas Wouters477c8d52006-05-27 19:21:47 +0000472 (key, self._box.colon))))
473
474 def test_get_MM(self):
475 # Get a MaildirMessage instance
476 msg = mailbox.MaildirMessage(self._template % 0)
477 msg.set_subdir('cur')
478 msg.set_flags('RF')
479 key = self._box.add(msg)
480 msg_returned = self._box.get_message(key)
Ezio Melottie9615932010-01-24 19:26:24 +0000481 self.assertIsInstance(msg_returned, mailbox.MaildirMessage)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000482 self.assertEqual(msg_returned.get_subdir(), 'cur')
483 self.assertEqual(msg_returned.get_flags(), 'FR')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000484
485 def test_set_MM(self):
486 # Set with a MaildirMessage instance
487 msg0 = mailbox.MaildirMessage(self._template % 0)
488 msg0.set_flags('TP')
489 key = self._box.add(msg0)
490 msg_returned = self._box.get_message(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000491 self.assertEqual(msg_returned.get_subdir(), 'new')
492 self.assertEqual(msg_returned.get_flags(), 'PT')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000493 msg1 = mailbox.MaildirMessage(self._template % 1)
494 self._box[key] = msg1
495 msg_returned = self._box.get_message(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000496 self.assertEqual(msg_returned.get_subdir(), 'new')
497 self.assertEqual(msg_returned.get_flags(), '')
498 self.assertEqual(msg_returned.get_payload(), '1')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000499 msg2 = mailbox.MaildirMessage(self._template % 2)
500 msg2.set_info('2,S')
501 self._box[key] = msg2
502 self._box[key] = self._template % 3
503 msg_returned = self._box.get_message(key)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000504 self.assertEqual(msg_returned.get_subdir(), 'new')
505 self.assertEqual(msg_returned.get_flags(), 'S')
506 self.assertEqual(msg_returned.get_payload(), '3')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000507
Christian Heimesfdab48e2008-01-20 09:06:41 +0000508 def test_consistent_factory(self):
509 # Add a message.
510 msg = mailbox.MaildirMessage(self._template % 0)
511 msg.set_subdir('cur')
512 msg.set_flags('RF')
513 key = self._box.add(msg)
514
515 # Create new mailbox with
516 class FakeMessage(mailbox.MaildirMessage):
517 pass
518 box = mailbox.Maildir(self._path, factory=FakeMessage)
Christian Heimes15ebc882008-02-04 18:48:49 +0000519 box.colon = self._box.colon
Christian Heimesfdab48e2008-01-20 09:06:41 +0000520 msg2 = box.get_message(key)
Ezio Melottie9615932010-01-24 19:26:24 +0000521 self.assertIsInstance(msg2, FakeMessage)
Christian Heimesfdab48e2008-01-20 09:06:41 +0000522
Thomas Wouters477c8d52006-05-27 19:21:47 +0000523 def test_initialize_new(self):
524 # Initialize a non-existent mailbox
525 self.tearDown()
526 self._box = mailbox.Maildir(self._path)
Georg Brandlfb16cf12008-05-11 21:31:44 +0000527 self._check_basics()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000528 self._delete_recursively(self._path)
529 self._box = self._factory(self._path, factory=None)
530 self._check_basics()
531
532 def test_initialize_existing(self):
533 # Initialize an existing mailbox
534 self.tearDown()
535 for subdir in '', 'tmp', 'new', 'cur':
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000536 os.mkdir(os.path.normpath(os.path.join(self._path, subdir)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000537 self._box = mailbox.Maildir(self._path)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000538 self._check_basics()
539
540 def _check_basics(self, factory=None):
541 # (Used by test_open_new() and test_open_existing().)
542 self.assertEqual(self._box._path, os.path.abspath(self._path))
543 self.assertEqual(self._box._factory, factory)
544 for subdir in '', 'tmp', 'new', 'cur':
545 path = os.path.join(self._path, subdir)
546 mode = os.stat(path)[stat.ST_MODE]
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000547 self.assertTrue(stat.S_ISDIR(mode), "Not a directory: '%s'" % path)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000548
549 def test_list_folders(self):
550 # List folders
551 self._box.add_folder('one')
552 self._box.add_folder('two')
553 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000554 self.assertEqual(len(self._box.list_folders()), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000555 self.assertEqual(set(self._box.list_folders()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000556 set(('one', 'two', 'three')))
557
558 def test_get_folder(self):
559 # Open folders
560 self._box.add_folder('foo.bar')
561 folder0 = self._box.get_folder('foo.bar')
562 folder0.add(self._template % 'bar')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000563 self.assertTrue(os.path.isdir(os.path.join(self._path, '.foo.bar')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000564 folder1 = self._box.get_folder('foo.bar')
Guido van Rossumea834472007-07-27 05:17:50 +0000565 self.assertEqual(folder1.get_string(folder1.keys()[0]),
566 self._template % 'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000567
568 def test_add_and_remove_folders(self):
569 # Delete folders
570 self._box.add_folder('one')
571 self._box.add_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000572 self.assertEqual(len(self._box.list_folders()), 2)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000573 self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000574 self._box.remove_folder('one')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000575 self.assertEqual(len(self._box.list_folders()), 1)
576 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000577 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000578 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000579 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000580 self._box.remove_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000581 self.assertEqual(len(self._box.list_folders()), 1)
582 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000583 self._box.remove_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000584 self.assertEqual(len(self._box.list_folders()), 0)
585 self.assertEqual(self._box.list_folders(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000586
587 def test_clean(self):
588 # Remove old files from 'tmp'
589 foo_path = os.path.join(self._path, 'tmp', 'foo')
590 bar_path = os.path.join(self._path, 'tmp', 'bar')
Brian Curtin5acec042010-10-13 02:29:46 +0000591 with open(foo_path, 'w') as f:
592 f.write("@")
593 with open(bar_path, 'w') as f:
594 f.write("@")
Thomas Wouters477c8d52006-05-27 19:21:47 +0000595 self._box.clean()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000596 self.assertTrue(os.path.exists(foo_path))
597 self.assertTrue(os.path.exists(bar_path))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000598 foo_stat = os.stat(foo_path)
599 os.utime(foo_path, (time.time() - 129600 - 2,
600 foo_stat.st_mtime))
601 self._box.clean()
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000602 self.assertFalse(os.path.exists(foo_path))
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000603 self.assertTrue(os.path.exists(bar_path))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000604
605 def test_create_tmp(self, repetitions=10):
606 # Create files in tmp directory
607 hostname = socket.gethostname()
608 if '/' in hostname:
609 hostname = hostname.replace('/', r'\057')
610 if ':' in hostname:
611 hostname = hostname.replace(':', r'\072')
612 pid = os.getpid()
613 pattern = re.compile(r"(?P<time>\d+)\.M(?P<M>\d{1,6})P(?P<P>\d+)"
614 r"Q(?P<Q>\d+)\.(?P<host>[^:/]+)")
615 previous_groups = None
Guido van Rossum805365e2007-05-07 22:24:25 +0000616 for x in range(repetitions):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000617 tmp_file = self._box._create_tmp()
618 head, tail = os.path.split(tmp_file.name)
619 self.assertEqual(head, os.path.abspath(os.path.join(self._path,
620 "tmp")),
621 "File in wrong location: '%s'" % head)
622 match = pattern.match(tail)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000623 self.assertIsNot(match, None, "Invalid file name: '%s'" % tail)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000624 groups = match.groups()
Benjamin Peterson2a691a82008-03-31 01:51:45 +0000625 if previous_groups is not None:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000626 self.assertTrue(int(groups[0] >= previous_groups[0]),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000627 "Non-monotonic seconds: '%s' before '%s'" %
628 (previous_groups[0], groups[0]))
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000629 self.assertTrue(int(groups[1] >= previous_groups[1]) or
Thomas Wouters477c8d52006-05-27 19:21:47 +0000630 groups[0] != groups[1],
631 "Non-monotonic milliseconds: '%s' before '%s'" %
632 (previous_groups[1], groups[1]))
Guido van Rossumea834472007-07-27 05:17:50 +0000633 self.assertEqual(int(groups[2]), pid,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000634 "Process ID mismatch: '%s' should be '%s'" %
635 (groups[2], pid))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000636 self.assertEqual(int(groups[3]), int(previous_groups[3]) + 1,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000637 "Non-sequential counter: '%s' before '%s'" %
638 (previous_groups[3], groups[3]))
Guido van Rossumea834472007-07-27 05:17:50 +0000639 self.assertEqual(groups[4], hostname,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000640 "Host name mismatch: '%s' should be '%s'" %
641 (groups[4], hostname))
642 previous_groups = groups
643 tmp_file.write(_sample_message)
644 tmp_file.seek(0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000645 self.assertEqual(tmp_file.read(), _sample_message)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000646 tmp_file.close()
647 file_count = len(os.listdir(os.path.join(self._path, "tmp")))
Guido van Rossumea834472007-07-27 05:17:50 +0000648 self.assertEqual(file_count, repetitions,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000649 "Wrong file count: '%s' should be '%s'" %
650 (file_count, repetitions))
651
652 def test_refresh(self):
653 # Update the table of contents
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000654 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000655 key0 = self._box.add(self._template % 0)
656 key1 = self._box.add(self._template % 1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000657 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000658 self._box._refresh()
Guido van Rossumea834472007-07-27 05:17:50 +0000659 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
660 key1: os.path.join('new', key1)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000661 key2 = self._box.add(self._template % 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000662 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
663 key1: os.path.join('new', key1)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000664 self._box._refresh()
Guido van Rossumea834472007-07-27 05:17:50 +0000665 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
666 key1: os.path.join('new', key1),
667 key2: os.path.join('new', key2)})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000668
669 def test_lookup(self):
670 # Look up message subpaths in the TOC
671 self.assertRaises(KeyError, lambda: self._box._lookup('foo'))
672 key0 = self._box.add(self._template % 0)
Guido van Rossumea834472007-07-27 05:17:50 +0000673 self.assertEqual(self._box._lookup(key0), os.path.join('new', key0))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000674 os.remove(os.path.join(self._path, 'new', key0))
Guido van Rossumea834472007-07-27 05:17:50 +0000675 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0)})
Antoine Pitrou03f13442009-11-02 11:36:51 +0000676 # Be sure that the TOC is read back from disk (see issue #6896
677 # about bad mtime behaviour on some systems).
678 self._box.flush()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000679 self.assertRaises(KeyError, lambda: self._box._lookup(key0))
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000680 self.assertEqual(self._box._toc, {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000681
682 def test_lock_unlock(self):
683 # Lock and unlock the mailbox. For Maildir, this does nothing.
684 self._box.lock()
685 self._box.unlock()
686
Thomas Wouters89f507f2006-12-13 04:49:30 +0000687 def test_folder (self):
688 # Test for bug #1569790: verify that folders returned by .get_folder()
689 # use the same factory function.
690 def dummy_factory (s):
691 return None
692 box = self._factory(self._path, factory=dummy_factory)
693 folder = box.add_folder('folder1')
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000694 self.assertIs(folder._factory, dummy_factory)
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000695
Thomas Wouters89f507f2006-12-13 04:49:30 +0000696 folder1_alias = box.get_folder('folder1')
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000697 self.assertIs(folder1_alias._factory, dummy_factory)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000698
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000699 def test_directory_in_folder (self):
700 # Test that mailboxes still work if there's a stray extra directory
701 # in a folder.
702 for i in range(10):
703 self._box.add(mailbox.Message(_sample_message))
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000704
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000705 # Create a stray directory
706 os.mkdir(os.path.join(self._path, 'cur', 'stray-dir'))
707
708 # Check that looping still works with the directory present.
709 for msg in self._box:
710 pass
Thomas Wouters477c8d52006-05-27 19:21:47 +0000711
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000712 def test_file_permissions(self):
713 # Verify that message files are created without execute permissions
714 if not hasattr(os, "stat") or not hasattr(os, "umask"):
715 return
716 msg = mailbox.MaildirMessage(self._template % 0)
717 orig_umask = os.umask(0)
718 try:
719 key = self._box.add(msg)
720 finally:
721 os.umask(orig_umask)
722 path = os.path.join(self._path, self._box._lookup(key))
723 mode = os.stat(path).st_mode
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000724 self.assertFalse(mode & 0o111)
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000725
726 def test_folder_file_perms(self):
727 # From bug #3228, we want to verify that the file created inside a Maildir
728 # subfolder isn't marked as executable.
729 if not hasattr(os, "stat") or not hasattr(os, "umask"):
730 return
731
732 orig_umask = os.umask(0)
733 try:
734 subfolder = self._box.add_folder('subfolder')
735 finally:
736 os.umask(orig_umask)
737
738 path = os.path.join(subfolder._path, 'maildirfolder')
739 st = os.stat(path)
740 perms = st.st_mode
741 self.assertFalse((perms & 0o111)) # Execute bits should all be off.
742
Andrew M. Kuchlingfa815342009-05-03 02:52:20 +0000743 def test_reread(self):
744 # Wait for 2 seconds
745 time.sleep(2)
746
747 # Initially, the mailbox has not been read and the time is null.
748 assert getattr(self._box, '_last_read', None) is None
749
750 # Refresh mailbox; the times should now be set to something.
751 self._box._refresh()
752 assert getattr(self._box, '_last_read', None) is not None
753
754 # Try calling _refresh() again; the modification times shouldn't have
755 # changed, so the mailbox should not be re-reading. Re-reading causes
756 # the ._toc attribute to be assigned a new dictionary object, so
757 # we'll check that the ._toc attribute isn't a different object.
758 orig_toc = self._box._toc
759 def refreshed():
760 return self._box._toc is not orig_toc
761
762 time.sleep(1) # Wait 1sec to ensure time.time()'s value changes
763 self._box._refresh()
764 assert not refreshed()
765
766 # Now, write something into cur and remove it. This changes
767 # the mtime and should cause a re-read.
768 filename = os.path.join(self._path, 'cur', 'stray-file')
769 f = open(filename, 'w')
770 f.close()
771 os.unlink(filename)
772 self._box._refresh()
773 assert refreshed()
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000774
Thomas Wouters477c8d52006-05-27 19:21:47 +0000775class _TestMboxMMDF(TestMailbox):
776
777 def tearDown(self):
Brett Cannon653238a2010-10-30 00:13:00 +0000778 super().tearDown()
Guido van Rossumc12a8132007-10-26 04:29:23 +0000779 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +0000780 self._delete_recursively(self._path)
781 for lock_remnant in glob.glob(self._path + '.*'):
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000782 support.unlink(lock_remnant)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000783
784 def test_add_from_string(self):
785 # Add a string starting with 'From ' to the mailbox
786 key = self._box.add('From foo@bar blah\nFrom: foo\n\n0')
Guido van Rossumea834472007-07-27 05:17:50 +0000787 self.assertEqual(self._box[key].get_from(), 'foo@bar blah')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000788 self.assertEqual(self._box[key].get_payload(), '0')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000789
790 def test_add_mbox_or_mmdf_message(self):
791 # Add an mboxMessage or MMDFMessage
792 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
793 msg = class_('From foo@bar blah\nFrom: foo\n\n0')
794 key = self._box.add(msg)
795
796 def test_open_close_open(self):
797 # Open and inspect previously-created mailbox
Guido van Rossum805365e2007-05-07 22:24:25 +0000798 values = [self._template % i for i in range(3)]
Thomas Wouters477c8d52006-05-27 19:21:47 +0000799 for value in values:
800 self._box.add(value)
801 self._box.close()
802 mtime = os.path.getmtime(self._path)
803 self._box = self._factory(self._path)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000804 self.assertEqual(len(self._box), 3)
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000805 for key in self._box.keys():
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000806 self.assertIn(self._box.get_string(key), values)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000807 self._box.close()
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000808 self.assertEqual(mtime, os.path.getmtime(self._path))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000809
810 def test_add_and_close(self):
811 # Verifying that closing a mailbox doesn't change added items
812 self._box.add(_sample_message)
Guido van Rossum805365e2007-05-07 22:24:25 +0000813 for i in range(3):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000814 self._box.add(self._template % i)
815 self._box.add(_sample_message)
816 self._box._file.flush()
817 self._box._file.seek(0)
818 contents = self._box._file.read()
819 self._box.close()
Brian Curtin5acec042010-10-13 02:29:46 +0000820 with open(self._path, 'r', newline='') as f:
821 self.assertEqual(contents, f.read())
Thomas Wouters477c8d52006-05-27 19:21:47 +0000822 self._box = self._factory(self._path)
823
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000824 def test_lock_conflict(self):
825 # Fork off a subprocess that will lock the file for 2 seconds,
826 # unlock it, and then exit.
827 if not hasattr(os, 'fork'):
828 return
829 pid = os.fork()
830 if pid == 0:
831 # In the child, lock the mailbox.
Guido van Rossum62cbc8a2007-04-09 00:41:25 +0000832 try:
833 self._box.lock()
834 time.sleep(2)
835 self._box.unlock()
836 finally:
837 os._exit(0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000838
839 # In the parent, sleep a bit to give the child time to acquire
840 # the lock.
841 time.sleep(0.5)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000842 try:
843 self.assertRaises(mailbox.ExternalClashError,
844 self._box.lock)
845 finally:
846 # Wait for child to exit. Locking should now succeed.
847 exited_pid, status = os.waitpid(pid, 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000848
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000849 self._box.lock()
850 self._box.unlock()
851
Thomas Wouters89f507f2006-12-13 04:49:30 +0000852 def test_relock(self):
853 # Test case for bug #1575506: the mailbox class was locking the
854 # wrong file object in its flush() method.
855 msg = "Subject: sub\n\nbody\n"
856 key1 = self._box.add(msg)
857 self._box.flush()
858 self._box.close()
859
860 self._box = self._factory(self._path)
861 self._box.lock()
862 key2 = self._box.add(msg)
863 self._box.flush()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000864 self.assertTrue(self._box._locked)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000865 self._box.close()
866
867
Thomas Wouters477c8d52006-05-27 19:21:47 +0000868class TestMbox(_TestMboxMMDF):
869
870 _factory = lambda self, path, factory=None: mailbox.mbox(path, factory)
871
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000872 def test_file_perms(self):
873 # From bug #3228, we want to verify that the mailbox file isn't executable,
874 # even if the umask is set to something that would leave executable bits set.
875 # We only run this test on platforms that support umask.
876 if hasattr(os, 'umask') and hasattr(os, 'stat'):
877 try:
878 old_umask = os.umask(0o077)
879 self._box.close()
880 os.unlink(self._path)
881 self._box = mailbox.mbox(self._path, create=True)
882 self._box.add('')
883 self._box.close()
884 finally:
885 os.umask(old_umask)
886
887 st = os.stat(self._path)
888 perms = st.st_mode
889 self.assertFalse((perms & 0o111)) # Execute bits should all be off.
Thomas Wouters477c8d52006-05-27 19:21:47 +0000890
891class TestMMDF(_TestMboxMMDF):
892
893 _factory = lambda self, path, factory=None: mailbox.MMDF(path, factory)
894
895
896class TestMH(TestMailbox):
897
898 _factory = lambda self, path, factory=None: mailbox.MH(path, factory)
899
900 def test_list_folders(self):
901 # List folders
902 self._box.add_folder('one')
903 self._box.add_folder('two')
904 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000905 self.assertEqual(len(self._box.list_folders()), 3)
Guido van Rossumea834472007-07-27 05:17:50 +0000906 self.assertEqual(set(self._box.list_folders()),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000907 set(('one', 'two', 'three')))
908
909 def test_get_folder(self):
910 # Open folders
Thomas Wouters89f507f2006-12-13 04:49:30 +0000911 def dummy_factory (s):
912 return None
913 self._box = self._factory(self._path, dummy_factory)
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000914
Thomas Wouters89f507f2006-12-13 04:49:30 +0000915 new_folder = self._box.add_folder('foo.bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000916 folder0 = self._box.get_folder('foo.bar')
917 folder0.add(self._template % 'bar')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000918 self.assertTrue(os.path.isdir(os.path.join(self._path, 'foo.bar')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000919 folder1 = self._box.get_folder('foo.bar')
Guido van Rossumea834472007-07-27 05:17:50 +0000920 self.assertEqual(folder1.get_string(folder1.keys()[0]),
921 self._template % 'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +0000922
Thomas Wouters89f507f2006-12-13 04:49:30 +0000923 # Test for bug #1569790: verify that folders returned by .get_folder()
924 # use the same factory function.
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +0000925 self.assertIs(new_folder._factory, self._box._factory)
926 self.assertIs(folder0._factory, self._box._factory)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000927
Thomas Wouters477c8d52006-05-27 19:21:47 +0000928 def test_add_and_remove_folders(self):
929 # Delete folders
930 self._box.add_folder('one')
931 self._box.add_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000932 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000933 self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000934 self._box.remove_folder('one')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000935 self.assertEqual(len(self._box.list_folders()), 1)
936 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000937 self._box.add_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000938 self.assertEqual(len(self._box.list_folders()), 2)
Guido van Rossumea834472007-07-27 05:17:50 +0000939 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000940 self._box.remove_folder('three')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000941 self.assertEqual(len(self._box.list_folders()), 1)
942 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000943 self._box.remove_folder('two')
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000944 self.assertEqual(len(self._box.list_folders()), 0)
945 self.assertEqual(self._box.list_folders(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +0000946
947 def test_sequences(self):
948 # Get and set sequences
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000949 self.assertEqual(self._box.get_sequences(), {})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000950 msg0 = mailbox.MHMessage(self._template % 0)
951 msg0.add_sequence('foo')
952 key0 = self._box.add(msg0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000953 self.assertEqual(self._box.get_sequences(), {'foo':[key0]})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000954 msg1 = mailbox.MHMessage(self._template % 1)
955 msg1.set_sequences(['bar', 'replied', 'foo'])
956 key1 = self._box.add(msg1)
Guido van Rossumea834472007-07-27 05:17:50 +0000957 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000958 {'foo':[key0, key1], 'bar':[key1], 'replied':[key1]})
959 msg0.set_sequences(['flagged'])
960 self._box[key0] = msg0
Guido van Rossumea834472007-07-27 05:17:50 +0000961 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000962 {'foo':[key1], 'bar':[key1], 'replied':[key1],
963 'flagged':[key0]})
964 self._box.remove(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +0000965 self.assertEqual(self._box.get_sequences(), {'flagged':[key0]})
Thomas Wouters477c8d52006-05-27 19:21:47 +0000966
R. David Murray548ac412009-04-02 19:44:43 +0000967 def test_issue2625(self):
968 msg0 = mailbox.MHMessage(self._template % 0)
969 msg0.add_sequence('foo')
970 key0 = self._box.add(msg0)
971 refmsg0 = self._box.get_message(key0)
972
Benjamin Peterson21896a32010-03-21 22:03:03 +0000973 def test_issue7627(self):
974 msg0 = mailbox.MHMessage(self._template % 0)
975 key0 = self._box.add(msg0)
976 self._box.lock()
977 self._box.remove(key0)
978 self._box.unlock()
979
Thomas Wouters477c8d52006-05-27 19:21:47 +0000980 def test_pack(self):
981 # Pack the contents of the mailbox
982 msg0 = mailbox.MHMessage(self._template % 0)
983 msg1 = mailbox.MHMessage(self._template % 1)
984 msg2 = mailbox.MHMessage(self._template % 2)
985 msg3 = mailbox.MHMessage(self._template % 3)
986 msg0.set_sequences(['foo', 'unseen'])
987 msg1.set_sequences(['foo'])
988 msg2.set_sequences(['foo', 'flagged'])
989 msg3.set_sequences(['foo', 'bar', 'replied'])
990 key0 = self._box.add(msg0)
991 key1 = self._box.add(msg1)
992 key2 = self._box.add(msg2)
993 key3 = self._box.add(msg3)
Guido van Rossumea834472007-07-27 05:17:50 +0000994 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000995 {'foo':[key0,key1,key2,key3], 'unseen':[key0],
996 'flagged':[key2], 'bar':[key3], 'replied':[key3]})
997 self._box.remove(key2)
Guido van Rossumea834472007-07-27 05:17:50 +0000998 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +0000999 {'foo':[key0,key1,key3], 'unseen':[key0], 'bar':[key3],
1000 'replied':[key3]})
1001 self._box.pack()
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001002 self.assertEqual(self._box.keys(), [1, 2, 3])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001003 key0 = key0
1004 key1 = key0 + 1
1005 key2 = key1 + 1
Guido van Rossumea834472007-07-27 05:17:50 +00001006 self.assertEqual(self._box.get_sequences(),
Thomas Wouters477c8d52006-05-27 19:21:47 +00001007 {'foo':[1, 2, 3], 'unseen':[1], 'bar':[3], 'replied':[3]})
1008
Thomas Wouters89f507f2006-12-13 04:49:30 +00001009 # Test case for packing while holding the mailbox locked.
1010 key0 = self._box.add(msg1)
1011 key1 = self._box.add(msg1)
1012 key2 = self._box.add(msg1)
1013 key3 = self._box.add(msg1)
1014
1015 self._box.remove(key0)
1016 self._box.remove(key2)
1017 self._box.lock()
1018 self._box.pack()
1019 self._box.unlock()
Guido van Rossumea834472007-07-27 05:17:50 +00001020 self.assertEqual(self._box.get_sequences(),
Thomas Wouters89f507f2006-12-13 04:49:30 +00001021 {'foo':[1, 2, 3, 4, 5],
1022 'unseen':[1], 'bar':[3], 'replied':[3]})
Thomas Wouters9fe394c2007-02-05 01:24:16 +00001023
Thomas Wouters477c8d52006-05-27 19:21:47 +00001024 def _get_lock_path(self):
1025 return os.path.join(self._path, '.mh_sequences.lock')
1026
1027
1028class TestBabyl(TestMailbox):
1029
1030 _factory = lambda self, path, factory=None: mailbox.Babyl(path, factory)
1031
1032 def tearDown(self):
Brett Cannon653238a2010-10-30 00:13:00 +00001033 super().tearDown()
Guido van Rossumc12a8132007-10-26 04:29:23 +00001034 self._box.close()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001035 self._delete_recursively(self._path)
1036 for lock_remnant in glob.glob(self._path + '.*'):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001037 support.unlink(lock_remnant)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001038
1039 def test_labels(self):
1040 # Get labels from the mailbox
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001041 self.assertEqual(self._box.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001042 msg0 = mailbox.BabylMessage(self._template % 0)
1043 msg0.add_label('foo')
1044 key0 = self._box.add(msg0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001045 self.assertEqual(self._box.get_labels(), ['foo'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001046 msg1 = mailbox.BabylMessage(self._template % 1)
1047 msg1.set_labels(['bar', 'answered', 'foo'])
1048 key1 = self._box.add(msg1)
Guido van Rossumea834472007-07-27 05:17:50 +00001049 self.assertEqual(set(self._box.get_labels()), set(['foo', 'bar']))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001050 msg0.set_labels(['blah', 'filed'])
1051 self._box[key0] = msg0
Guido van Rossumea834472007-07-27 05:17:50 +00001052 self.assertEqual(set(self._box.get_labels()),
Thomas Wouters477c8d52006-05-27 19:21:47 +00001053 set(['foo', 'bar', 'blah']))
1054 self._box.remove(key1)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001055 self.assertEqual(set(self._box.get_labels()), set(['blah']))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001056
1057
1058class TestMessage(TestBase):
1059
1060 _factory = mailbox.Message # Overridden by subclasses to reuse tests
1061
1062 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001063 self._path = support.TESTFN
Thomas Wouters477c8d52006-05-27 19:21:47 +00001064
1065 def tearDown(self):
1066 self._delete_recursively(self._path)
1067
1068 def test_initialize_with_eMM(self):
Thomas Woutersb2137042007-02-01 18:02:27 +00001069 # Initialize based on email.message.Message instance
Thomas Wouters477c8d52006-05-27 19:21:47 +00001070 eMM = email.message_from_string(_sample_message)
1071 msg = self._factory(eMM)
1072 self._post_initialize_hook(msg)
1073 self._check_sample(msg)
1074
1075 def test_initialize_with_string(self):
1076 # Initialize based on string
1077 msg = self._factory(_sample_message)
1078 self._post_initialize_hook(msg)
1079 self._check_sample(msg)
1080
1081 def test_initialize_with_file(self):
1082 # Initialize based on contents of file
Brian Curtin5acec042010-10-13 02:29:46 +00001083 with open(self._path, 'w+') as f:
1084 f.write(_sample_message)
1085 f.seek(0)
1086 msg = self._factory(f)
1087 self._post_initialize_hook(msg)
1088 self._check_sample(msg)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001089
1090 def test_initialize_with_nothing(self):
1091 # Initialize without arguments
1092 msg = self._factory()
1093 self._post_initialize_hook(msg)
Ezio Melottie9615932010-01-24 19:26:24 +00001094 self.assertIsInstance(msg, email.message.Message)
1095 self.assertIsInstance(msg, mailbox.Message)
1096 self.assertIsInstance(msg, self._factory)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001097 self.assertEqual(msg.keys(), [])
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001098 self.assertFalse(msg.is_multipart())
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001099 self.assertEqual(msg.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001100
1101 def test_initialize_incorrectly(self):
1102 # Initialize with invalid argument
1103 self.assertRaises(TypeError, lambda: self._factory(object()))
1104
1105 def test_become_message(self):
1106 # Take on the state of another message
1107 eMM = email.message_from_string(_sample_message)
1108 msg = self._factory()
1109 msg._become_message(eMM)
1110 self._check_sample(msg)
1111
1112 def test_explain_to(self):
1113 # Copy self's format-specific data to other message formats.
1114 # This test is superficial; better ones are in TestMessageConversion.
1115 msg = self._factory()
1116 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1117 mailbox.mboxMessage, mailbox.MHMessage,
1118 mailbox.BabylMessage, mailbox.MMDFMessage):
1119 other_msg = class_()
1120 msg._explain_to(other_msg)
Thomas Woutersb2137042007-02-01 18:02:27 +00001121 other_msg = email.message.Message()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001122 self.assertRaises(TypeError, lambda: msg._explain_to(other_msg))
1123
1124 def _post_initialize_hook(self, msg):
1125 # Overridden by subclasses to check extra things after initialization
1126 pass
1127
1128
1129class TestMaildirMessage(TestMessage):
1130
1131 _factory = mailbox.MaildirMessage
1132
1133 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001134 self.assertEqual(msg._subdir, 'new')
1135 self.assertEqual(msg._info, '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001136
1137 def test_subdir(self):
1138 # Use get_subdir() and set_subdir()
1139 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001140 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001141 msg.set_subdir('cur')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001142 self.assertEqual(msg.get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001143 msg.set_subdir('new')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001144 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001145 self.assertRaises(ValueError, lambda: msg.set_subdir('tmp'))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001146 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001147 msg.set_subdir('new')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001148 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001149 self._check_sample(msg)
1150
1151 def test_flags(self):
1152 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1153 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001154 self.assertEqual(msg.get_flags(), '')
1155 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001156 msg.set_flags('F')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001157 self.assertEqual(msg.get_subdir(), 'new')
1158 self.assertEqual(msg.get_flags(), 'F')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001159 msg.set_flags('SDTP')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001160 self.assertEqual(msg.get_flags(), 'DPST')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001161 msg.add_flag('FT')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001162 self.assertEqual(msg.get_flags(), 'DFPST')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001163 msg.remove_flag('TDRP')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001164 self.assertEqual(msg.get_flags(), 'FS')
1165 self.assertEqual(msg.get_subdir(), 'new')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001166 self._check_sample(msg)
1167
1168 def test_date(self):
1169 # Use get_date() and set_date()
1170 msg = mailbox.MaildirMessage(_sample_message)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001171 self.assertLess(abs(msg.get_date() - time.time()), 60)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001172 msg.set_date(0.0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001173 self.assertEqual(msg.get_date(), 0.0)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001174
1175 def test_info(self):
1176 # Use get_info() and set_info()
1177 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001178 self.assertEqual(msg.get_info(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001179 msg.set_info('1,foo=bar')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001180 self.assertEqual(msg.get_info(), '1,foo=bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001181 self.assertRaises(TypeError, lambda: msg.set_info(None))
1182 self._check_sample(msg)
1183
1184 def test_info_and_flags(self):
1185 # Test interaction of info and flag methods
1186 msg = mailbox.MaildirMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001187 self.assertEqual(msg.get_info(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001188 msg.set_flags('SF')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001189 self.assertEqual(msg.get_flags(), 'FS')
1190 self.assertEqual(msg.get_info(), '2,FS')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001191 msg.set_info('1,')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001192 self.assertEqual(msg.get_flags(), '')
1193 self.assertEqual(msg.get_info(), '1,')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001194 msg.remove_flag('RPT')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001195 self.assertEqual(msg.get_flags(), '')
1196 self.assertEqual(msg.get_info(), '1,')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001197 msg.add_flag('D')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001198 self.assertEqual(msg.get_flags(), 'D')
1199 self.assertEqual(msg.get_info(), '2,D')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001200 self._check_sample(msg)
1201
1202
1203class _TestMboxMMDFMessage(TestMessage):
1204
1205 _factory = mailbox._mboxMMDFMessage
1206
1207 def _post_initialize_hook(self, msg):
1208 self._check_from(msg)
1209
1210 def test_initialize_with_unixfrom(self):
1211 # Initialize with a message that already has a _unixfrom attribute
1212 msg = mailbox.Message(_sample_message)
1213 msg.set_unixfrom('From foo@bar blah')
1214 msg = mailbox.mboxMessage(msg)
Guido van Rossumea834472007-07-27 05:17:50 +00001215 self.assertEqual(msg.get_from(), 'foo@bar blah', msg.get_from())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001216
1217 def test_from(self):
1218 # Get and set "From " line
1219 msg = mailbox.mboxMessage(_sample_message)
1220 self._check_from(msg)
1221 msg.set_from('foo bar')
Guido van Rossumea834472007-07-27 05:17:50 +00001222 self.assertEqual(msg.get_from(), 'foo bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001223 msg.set_from('foo@bar', True)
1224 self._check_from(msg, 'foo@bar')
1225 msg.set_from('blah@temp', time.localtime())
1226 self._check_from(msg, 'blah@temp')
1227
1228 def test_flags(self):
1229 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1230 msg = mailbox.mboxMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001231 self.assertEqual(msg.get_flags(), '')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001232 msg.set_flags('F')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001233 self.assertEqual(msg.get_flags(), 'F')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001234 msg.set_flags('XODR')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001235 self.assertEqual(msg.get_flags(), 'RODX')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001236 msg.add_flag('FA')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001237 self.assertEqual(msg.get_flags(), 'RODFAX')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001238 msg.remove_flag('FDXA')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001239 self.assertEqual(msg.get_flags(), 'RO')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001240 self._check_sample(msg)
1241
1242 def _check_from(self, msg, sender=None):
1243 # Check contents of "From " line
1244 if sender is None:
1245 sender = "MAILER-DAEMON"
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001246 self.assertTrue(re.match(sender + r" \w{3} \w{3} [\d ]\d [\d ]\d:\d{2}:"
Thomas Wouters477c8d52006-05-27 19:21:47 +00001247 r"\d{2} \d{4}", msg.get_from()) is not None)
1248
1249
1250class TestMboxMessage(_TestMboxMMDFMessage):
1251
1252 _factory = mailbox.mboxMessage
1253
1254
1255class TestMHMessage(TestMessage):
1256
1257 _factory = mailbox.MHMessage
1258
1259 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001260 self.assertEqual(msg._sequences, [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001261
1262 def test_sequences(self):
1263 # Get, set, join, and leave sequences
1264 msg = mailbox.MHMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001265 self.assertEqual(msg.get_sequences(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001266 msg.set_sequences(['foobar'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001267 self.assertEqual(msg.get_sequences(), ['foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001268 msg.set_sequences([])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001269 self.assertEqual(msg.get_sequences(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001270 msg.add_sequence('unseen')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001271 self.assertEqual(msg.get_sequences(), ['unseen'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001272 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001273 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001274 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001275 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001276 msg.remove_sequence('unseen')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001277 self.assertEqual(msg.get_sequences(), ['flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001278 msg.add_sequence('foobar')
Guido van Rossumea834472007-07-27 05:17:50 +00001279 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001280 msg.remove_sequence('replied')
Guido van Rossumea834472007-07-27 05:17:50 +00001281 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001282 msg.set_sequences(['foobar', 'replied'])
Guido van Rossumea834472007-07-27 05:17:50 +00001283 self.assertEqual(msg.get_sequences(), ['foobar', 'replied'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001284
1285
1286class TestBabylMessage(TestMessage):
1287
1288 _factory = mailbox.BabylMessage
1289
1290 def _post_initialize_hook(self, msg):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001291 self.assertEqual(msg._labels, [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001292
1293 def test_labels(self):
1294 # Get, set, join, and leave labels
1295 msg = mailbox.BabylMessage(_sample_message)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001296 self.assertEqual(msg.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001297 msg.set_labels(['foobar'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001298 self.assertEqual(msg.get_labels(), ['foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001299 msg.set_labels([])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001300 self.assertEqual(msg.get_labels(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001301 msg.add_label('filed')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001302 self.assertEqual(msg.get_labels(), ['filed'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001303 msg.add_label('resent')
Guido van Rossumea834472007-07-27 05:17:50 +00001304 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001305 msg.add_label('resent')
Guido van Rossumea834472007-07-27 05:17:50 +00001306 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001307 msg.remove_label('filed')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001308 self.assertEqual(msg.get_labels(), ['resent'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001309 msg.add_label('foobar')
Guido van Rossumea834472007-07-27 05:17:50 +00001310 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001311 msg.remove_label('unseen')
Guido van Rossumea834472007-07-27 05:17:50 +00001312 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001313 msg.set_labels(['foobar', 'answered'])
Guido van Rossumea834472007-07-27 05:17:50 +00001314 self.assertEqual(msg.get_labels(), ['foobar', 'answered'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001315
1316 def test_visible(self):
1317 # Get, set, and update visible headers
1318 msg = mailbox.BabylMessage(_sample_message)
1319 visible = msg.get_visible()
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001320 self.assertEqual(visible.keys(), [])
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001321 self.assertIs(visible.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001322 visible['User-Agent'] = 'FooBar 1.0'
1323 visible['X-Whatever'] = 'Blah'
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001324 self.assertEqual(msg.get_visible().keys(), [])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001325 msg.set_visible(visible)
1326 visible = msg.get_visible()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001327 self.assertTrue(visible.keys() == ['User-Agent', 'X-Whatever'])
1328 self.assertTrue(visible['User-Agent'] == 'FooBar 1.0')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001329 self.assertEqual(visible['X-Whatever'], 'Blah')
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001330 self.assertIs(visible.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001331 msg.update_visible()
Guido van Rossumea834472007-07-27 05:17:50 +00001332 self.assertEqual(visible.keys(), ['User-Agent', 'X-Whatever'])
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001333 self.assertIs(visible.get_payload(), None)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001334 visible = msg.get_visible()
Guido van Rossumea834472007-07-27 05:17:50 +00001335 self.assertEqual(visible.keys(), ['User-Agent', 'Date', 'From', 'To',
1336 'Subject'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001337 for header in ('User-Agent', 'Date', 'From', 'To', 'Subject'):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001338 self.assertEqual(visible[header], msg[header])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001339
1340
1341class TestMMDFMessage(_TestMboxMMDFMessage):
1342
1343 _factory = mailbox.MMDFMessage
1344
1345
1346class TestMessageConversion(TestBase):
1347
1348 def test_plain_to_x(self):
1349 # Convert Message to all formats
1350 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1351 mailbox.mboxMessage, mailbox.MHMessage,
1352 mailbox.BabylMessage, mailbox.MMDFMessage):
1353 msg_plain = mailbox.Message(_sample_message)
1354 msg = class_(msg_plain)
1355 self._check_sample(msg)
1356
1357 def test_x_to_plain(self):
1358 # Convert all formats to Message
1359 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1360 mailbox.mboxMessage, mailbox.MHMessage,
1361 mailbox.BabylMessage, mailbox.MMDFMessage):
1362 msg = class_(_sample_message)
1363 msg_plain = mailbox.Message(msg)
1364 self._check_sample(msg_plain)
1365
1366 def test_x_to_invalid(self):
1367 # Convert all formats to an invalid format
1368 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1369 mailbox.mboxMessage, mailbox.MHMessage,
1370 mailbox.BabylMessage, mailbox.MMDFMessage):
1371 self.assertRaises(TypeError, lambda: class_(False))
1372
1373 def test_maildir_to_maildir(self):
1374 # Convert MaildirMessage to MaildirMessage
1375 msg_maildir = mailbox.MaildirMessage(_sample_message)
1376 msg_maildir.set_flags('DFPRST')
1377 msg_maildir.set_subdir('cur')
1378 date = msg_maildir.get_date()
1379 msg = mailbox.MaildirMessage(msg_maildir)
1380 self._check_sample(msg)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001381 self.assertEqual(msg.get_flags(), 'DFPRST')
1382 self.assertEqual(msg.get_subdir(), 'cur')
1383 self.assertEqual(msg.get_date(), date)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001384
1385 def test_maildir_to_mboxmmdf(self):
1386 # Convert MaildirMessage to mboxmessage and MMDFMessage
1387 pairs = (('D', ''), ('F', 'F'), ('P', ''), ('R', 'A'), ('S', 'R'),
1388 ('T', 'D'), ('DFPRST', 'RDFA'))
1389 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1390 msg_maildir = mailbox.MaildirMessage(_sample_message)
1391 msg_maildir.set_date(0.0)
1392 for setting, result in pairs:
1393 msg_maildir.set_flags(setting)
1394 msg = class_(msg_maildir)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001395 self.assertEqual(msg.get_flags(), result)
Guido van Rossumea834472007-07-27 05:17:50 +00001396 self.assertEqual(msg.get_from(), 'MAILER-DAEMON %s' %
Thomas Wouters477c8d52006-05-27 19:21:47 +00001397 time.asctime(time.gmtime(0.0)))
1398 msg_maildir.set_subdir('cur')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001399 self.assertEqual(class_(msg_maildir).get_flags(), 'RODFA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001400
1401 def test_maildir_to_mh(self):
1402 # Convert MaildirMessage to MHMessage
1403 msg_maildir = mailbox.MaildirMessage(_sample_message)
1404 pairs = (('D', ['unseen']), ('F', ['unseen', 'flagged']),
1405 ('P', ['unseen']), ('R', ['unseen', 'replied']), ('S', []),
1406 ('T', ['unseen']), ('DFPRST', ['replied', 'flagged']))
1407 for setting, result in pairs:
1408 msg_maildir.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001409 self.assertEqual(mailbox.MHMessage(msg_maildir).get_sequences(),
1410 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001411
1412 def test_maildir_to_babyl(self):
1413 # Convert MaildirMessage to Babyl
1414 msg_maildir = mailbox.MaildirMessage(_sample_message)
1415 pairs = (('D', ['unseen']), ('F', ['unseen']),
1416 ('P', ['unseen', 'forwarded']), ('R', ['unseen', 'answered']),
1417 ('S', []), ('T', ['unseen', 'deleted']),
1418 ('DFPRST', ['deleted', 'answered', 'forwarded']))
1419 for setting, result in pairs:
1420 msg_maildir.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001421 self.assertEqual(mailbox.BabylMessage(msg_maildir).get_labels(),
1422 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001423
1424 def test_mboxmmdf_to_maildir(self):
1425 # Convert mboxMessage and MMDFMessage to MaildirMessage
1426 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1427 msg_mboxMMDF = class_(_sample_message)
1428 msg_mboxMMDF.set_from('foo@bar', time.gmtime(0.0))
1429 pairs = (('R', 'S'), ('O', ''), ('D', 'T'), ('F', 'F'), ('A', 'R'),
1430 ('RODFA', 'FRST'))
1431 for setting, result in pairs:
1432 msg_mboxMMDF.set_flags(setting)
1433 msg = mailbox.MaildirMessage(msg_mboxMMDF)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001434 self.assertEqual(msg.get_flags(), result)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001435 self.assertEqual(msg.get_date(), 0.0)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001436 msg_mboxMMDF.set_flags('O')
Guido van Rossumea834472007-07-27 05:17:50 +00001437 self.assertEqual(mailbox.MaildirMessage(msg_mboxMMDF).get_subdir(),
1438 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001439
1440 def test_mboxmmdf_to_mboxmmdf(self):
1441 # Convert mboxMessage and MMDFMessage to mboxMessage and MMDFMessage
1442 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1443 msg_mboxMMDF = class_(_sample_message)
1444 msg_mboxMMDF.set_flags('RODFA')
1445 msg_mboxMMDF.set_from('foo@bar')
1446 for class2_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1447 msg2 = class2_(msg_mboxMMDF)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001448 self.assertEqual(msg2.get_flags(), 'RODFA')
1449 self.assertEqual(msg2.get_from(), 'foo@bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001450
1451 def test_mboxmmdf_to_mh(self):
1452 # Convert mboxMessage and MMDFMessage to MHMessage
1453 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1454 msg_mboxMMDF = class_(_sample_message)
1455 pairs = (('R', []), ('O', ['unseen']), ('D', ['unseen']),
1456 ('F', ['unseen', 'flagged']),
1457 ('A', ['unseen', 'replied']),
1458 ('RODFA', ['replied', 'flagged']))
1459 for setting, result in pairs:
1460 msg_mboxMMDF.set_flags(setting)
Guido van Rossumea834472007-07-27 05:17:50 +00001461 self.assertEqual(mailbox.MHMessage(msg_mboxMMDF).get_sequences(),
1462 result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001463
1464 def test_mboxmmdf_to_babyl(self):
1465 # Convert mboxMessage and MMDFMessage to BabylMessage
1466 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1467 msg = class_(_sample_message)
1468 pairs = (('R', []), ('O', ['unseen']),
1469 ('D', ['unseen', 'deleted']), ('F', ['unseen']),
1470 ('A', ['unseen', 'answered']),
1471 ('RODFA', ['deleted', 'answered']))
1472 for setting, result in pairs:
1473 msg.set_flags(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001474 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001475
1476 def test_mh_to_maildir(self):
1477 # Convert MHMessage to MaildirMessage
1478 pairs = (('unseen', ''), ('replied', 'RS'), ('flagged', 'FS'))
1479 for setting, result in pairs:
1480 msg = mailbox.MHMessage(_sample_message)
1481 msg.add_sequence(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001482 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1483 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001484 msg = mailbox.MHMessage(_sample_message)
1485 msg.add_sequence('unseen')
1486 msg.add_sequence('replied')
1487 msg.add_sequence('flagged')
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001488 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'FR')
1489 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001490
1491 def test_mh_to_mboxmmdf(self):
1492 # Convert MHMessage to mboxMessage and MMDFMessage
1493 pairs = (('unseen', 'O'), ('replied', 'ROA'), ('flagged', 'ROF'))
1494 for setting, result in pairs:
1495 msg = mailbox.MHMessage(_sample_message)
1496 msg.add_sequence(setting)
1497 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001498 self.assertEqual(class_(msg).get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001499 msg = mailbox.MHMessage(_sample_message)
1500 msg.add_sequence('unseen')
1501 msg.add_sequence('replied')
1502 msg.add_sequence('flagged')
1503 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001504 self.assertEqual(class_(msg).get_flags(), 'OFA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001505
1506 def test_mh_to_mh(self):
1507 # Convert MHMessage to MHMessage
1508 msg = mailbox.MHMessage(_sample_message)
1509 msg.add_sequence('unseen')
1510 msg.add_sequence('replied')
1511 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001512 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1513 ['unseen', 'replied', 'flagged'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001514
1515 def test_mh_to_babyl(self):
1516 # Convert MHMessage to BabylMessage
1517 pairs = (('unseen', ['unseen']), ('replied', ['answered']),
1518 ('flagged', []))
1519 for setting, result in pairs:
1520 msg = mailbox.MHMessage(_sample_message)
1521 msg.add_sequence(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001522 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001523 msg = mailbox.MHMessage(_sample_message)
1524 msg.add_sequence('unseen')
1525 msg.add_sequence('replied')
1526 msg.add_sequence('flagged')
Guido van Rossumea834472007-07-27 05:17:50 +00001527 self.assertEqual(mailbox.BabylMessage(msg).get_labels(),
1528 ['unseen', 'answered'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001529
1530 def test_babyl_to_maildir(self):
1531 # Convert BabylMessage to MaildirMessage
1532 pairs = (('unseen', ''), ('deleted', 'ST'), ('filed', 'S'),
1533 ('answered', 'RS'), ('forwarded', 'PS'), ('edited', 'S'),
1534 ('resent', 'PS'))
1535 for setting, result in pairs:
1536 msg = mailbox.BabylMessage(_sample_message)
1537 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001538 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1539 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001540 msg = mailbox.BabylMessage(_sample_message)
1541 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1542 'edited', 'resent'):
1543 msg.add_label(label)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001544 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'PRT')
1545 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001546
1547 def test_babyl_to_mboxmmdf(self):
1548 # Convert BabylMessage to mboxMessage and MMDFMessage
1549 pairs = (('unseen', 'O'), ('deleted', 'ROD'), ('filed', 'RO'),
1550 ('answered', 'ROA'), ('forwarded', 'RO'), ('edited', 'RO'),
1551 ('resent', 'RO'))
1552 for setting, result in pairs:
1553 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1554 msg = mailbox.BabylMessage(_sample_message)
1555 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001556 self.assertEqual(class_(msg).get_flags(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001557 msg = mailbox.BabylMessage(_sample_message)
1558 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1559 'edited', 'resent'):
1560 msg.add_label(label)
1561 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001562 self.assertEqual(class_(msg).get_flags(), 'ODA')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001563
1564 def test_babyl_to_mh(self):
1565 # Convert BabylMessage to MHMessage
1566 pairs = (('unseen', ['unseen']), ('deleted', []), ('filed', []),
1567 ('answered', ['replied']), ('forwarded', []), ('edited', []),
1568 ('resent', []))
1569 for setting, result in pairs:
1570 msg = mailbox.BabylMessage(_sample_message)
1571 msg.add_label(setting)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001572 self.assertEqual(mailbox.MHMessage(msg).get_sequences(), result)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001573 msg = mailbox.BabylMessage(_sample_message)
1574 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1575 'edited', 'resent'):
1576 msg.add_label(label)
Guido van Rossumea834472007-07-27 05:17:50 +00001577 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1578 ['unseen', 'replied'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001579
1580 def test_babyl_to_babyl(self):
1581 # Convert BabylMessage to BabylMessage
1582 msg = mailbox.BabylMessage(_sample_message)
1583 msg.update_visible()
1584 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1585 'edited', 'resent'):
1586 msg.add_label(label)
1587 msg2 = mailbox.BabylMessage(msg)
Guido van Rossumea834472007-07-27 05:17:50 +00001588 self.assertEqual(msg2.get_labels(), ['unseen', 'deleted', 'filed',
1589 'answered', 'forwarded', 'edited',
1590 'resent'])
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001591 self.assertEqual(msg.get_visible().keys(), msg2.get_visible().keys())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001592 for key in msg.get_visible().keys():
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001593 self.assertEqual(msg.get_visible()[key], msg2.get_visible()[key])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001594
1595
1596class TestProxyFileBase(TestBase):
1597
1598 def _test_read(self, proxy):
1599 # Read by byte
1600 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001601 self.assertEqual(proxy.read(), b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001602 proxy.seek(1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001603 self.assertEqual(proxy.read(), b'ar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001604 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001605 self.assertEqual(proxy.read(2), b'ba')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001606 proxy.seek(1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001607 self.assertEqual(proxy.read(-1), b'ar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001608 proxy.seek(2)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001609 self.assertEqual(proxy.read(1000), b'r')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001610
1611 def _test_readline(self, proxy):
1612 # Read by line
Guido van Rossum98297ee2007-11-06 21:34:58 +00001613 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001614 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001615 self.assertEqual(proxy.readline(), b'foo' + linesep)
1616 self.assertEqual(proxy.readline(), b'bar' + linesep)
1617 self.assertEqual(proxy.readline(), b'fred' + linesep)
1618 self.assertEqual(proxy.readline(), b'bob')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001619 proxy.seek(2)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001620 self.assertEqual(proxy.readline(), b'o' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001621 proxy.seek(6 + 2 * len(os.linesep))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001622 self.assertEqual(proxy.readline(), b'fred' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001623 proxy.seek(6 + 2 * len(os.linesep))
Guido van Rossum98297ee2007-11-06 21:34:58 +00001624 self.assertEqual(proxy.readline(2), b'fr')
1625 self.assertEqual(proxy.readline(-10), b'ed' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001626
1627 def _test_readlines(self, proxy):
1628 # Read multiple lines
Guido van Rossum98297ee2007-11-06 21:34:58 +00001629 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001630 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001631 self.assertEqual(proxy.readlines(), [b'foo' + linesep,
1632 b'bar' + linesep,
1633 b'fred' + linesep, b'bob'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001634 proxy.seek(0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001635 self.assertEqual(proxy.readlines(2), [b'foo' + linesep])
1636 proxy.seek(3 + len(linesep))
1637 self.assertEqual(proxy.readlines(4 + len(linesep)),
1638 [b'bar' + linesep, b'fred' + linesep])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001639 proxy.seek(3)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001640 self.assertEqual(proxy.readlines(1000), [linesep, b'bar' + linesep,
1641 b'fred' + linesep, b'bob'])
Thomas Wouters477c8d52006-05-27 19:21:47 +00001642
1643 def _test_iteration(self, proxy):
1644 # Iterate by line
Guido van Rossum98297ee2007-11-06 21:34:58 +00001645 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001646 proxy.seek(0)
1647 iterator = iter(proxy)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001648 self.assertEqual(next(iterator), b'foo' + linesep)
1649 self.assertEqual(next(iterator), b'bar' + linesep)
1650 self.assertEqual(next(iterator), b'fred' + linesep)
1651 self.assertEqual(next(iterator), b'bob')
Georg Brandla18af4e2007-04-21 15:47:16 +00001652 self.assertRaises(StopIteration, next, iterator)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001653
1654 def _test_seek_and_tell(self, proxy):
1655 # Seek and use tell to check position
Guido van Rossum98297ee2007-11-06 21:34:58 +00001656 linesep = os.linesep.encode()
Thomas Wouters477c8d52006-05-27 19:21:47 +00001657 proxy.seek(3)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001658 self.assertEqual(proxy.tell(), 3)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001659 self.assertEqual(proxy.read(len(linesep)), linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001660 proxy.seek(2, 1)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001661 self.assertEqual(proxy.read(1 + len(linesep)), b'r' + linesep)
1662 proxy.seek(-3 - len(linesep), 2)
1663 self.assertEqual(proxy.read(3), b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001664 proxy.seek(2, 0)
Guido van Rossum98297ee2007-11-06 21:34:58 +00001665 self.assertEqual(proxy.read(), b'o' + linesep + b'bar' + linesep)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001666 proxy.seek(100)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001667 self.assertFalse(proxy.read())
Thomas Wouters477c8d52006-05-27 19:21:47 +00001668
1669 def _test_close(self, proxy):
1670 # Close a file
1671 proxy.close()
1672 self.assertRaises(AttributeError, lambda: proxy.close())
1673
1674
1675class TestProxyFile(TestProxyFileBase):
1676
1677 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001678 self._path = support.TESTFN
Thomas Wouters477c8d52006-05-27 19:21:47 +00001679 self._file = open(self._path, 'wb+')
1680
1681 def tearDown(self):
1682 self._file.close()
1683 self._delete_recursively(self._path)
1684
1685 def test_initialize(self):
1686 # Initialize and check position
Neal Norwitz9a923102007-08-30 06:20:05 +00001687 self._file.write(b'foo')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001688 pos = self._file.tell()
1689 proxy0 = mailbox._ProxyFile(self._file)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001690 self.assertEqual(proxy0.tell(), pos)
1691 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001692 proxy1 = mailbox._ProxyFile(self._file, 0)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001693 self.assertEqual(proxy1.tell(), 0)
1694 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001695
1696 def test_read(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001697 self._file.write(b'bar')
Thomas Wouters477c8d52006-05-27 19:21:47 +00001698 self._test_read(mailbox._ProxyFile(self._file))
1699
1700 def test_readline(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_readline(mailbox._ProxyFile(self._file))
1704
1705 def test_readlines(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_readlines(mailbox._ProxyFile(self._file))
1709
1710 def test_iteration(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001711 self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1712 os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001713 self._test_iteration(mailbox._ProxyFile(self._file))
1714
1715 def test_seek_and_tell(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001716 self._file.write(bytes('foo%sbar%s' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001717 self._test_seek_and_tell(mailbox._ProxyFile(self._file))
1718
1719 def test_close(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001720 self._file.write(bytes('foo%sbar%s' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001721 self._test_close(mailbox._ProxyFile(self._file))
1722
1723
1724class TestPartialFile(TestProxyFileBase):
1725
1726 def setUp(self):
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001727 self._path = support.TESTFN
Thomas Wouters477c8d52006-05-27 19:21:47 +00001728 self._file = open(self._path, 'wb+')
1729
1730 def tearDown(self):
1731 self._file.close()
1732 self._delete_recursively(self._path)
1733
1734 def test_initialize(self):
1735 # Initialize and check position
Neal Norwitz9a923102007-08-30 06:20:05 +00001736 self._file.write(bytes('foo' + os.linesep + 'bar', 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001737 pos = self._file.tell()
1738 proxy = mailbox._PartialFile(self._file, 2, 5)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001739 self.assertEqual(proxy.tell(), 0)
1740 self.assertEqual(self._file.tell(), pos)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001741
1742 def test_read(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001743 self._file.write(bytes('***bar***', 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001744 self._test_read(mailbox._PartialFile(self._file, 3, 6))
1745
1746 def test_readline(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001747 self._file.write(bytes('!!!!!foo%sbar%sfred%sbob!!!!!' %
1748 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001749 self._test_readline(mailbox._PartialFile(self._file, 5,
1750 18 + 3 * len(os.linesep)))
1751
1752 def test_readlines(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001753 self._file.write(bytes('foo%sbar%sfred%sbob?????' %
1754 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001755 self._test_readlines(mailbox._PartialFile(self._file, 0,
1756 13 + 3 * len(os.linesep)))
1757
1758 def test_iteration(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001759 self._file.write(bytes('____foo%sbar%sfred%sbob####' %
1760 (os.linesep, os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001761 self._test_iteration(mailbox._PartialFile(self._file, 4,
1762 17 + 3 * len(os.linesep)))
1763
1764 def test_seek_and_tell(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_seek_and_tell(mailbox._PartialFile(self._file, 3,
1767 9 + 2 * len(os.linesep)))
1768
1769 def test_close(self):
Neal Norwitz9a923102007-08-30 06:20:05 +00001770 self._file.write(bytes('&foo%sbar%s^' % (os.linesep, os.linesep), 'ascii'))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001771 self._test_close(mailbox._PartialFile(self._file, 1,
1772 6 + 3 * len(os.linesep)))
1773
1774
1775## Start: tests from the original module (for backward compatibility).
1776
Skip Montanaro5253da12004-07-24 19:56:03 +00001777FROM_ = "From some.body@dummy.domain Sat Jul 24 13:43:35 2004\n"
Fred Drakec02bc3e2001-05-21 20:23:21 +00001778DUMMY_MESSAGE = """\
1779From: some.body@dummy.domain
1780To: me@my.domain
Skip Montanaro5253da12004-07-24 19:56:03 +00001781Subject: Simple Test
Fred Drakec02bc3e2001-05-21 20:23:21 +00001782
1783This is a dummy message.
1784"""
1785
Fred Drakec02bc3e2001-05-21 20:23:21 +00001786class MaildirTestCase(unittest.TestCase):
1787
1788 def setUp(self):
1789 # create a new maildir mailbox to work with:
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001790 self._dir = support.TESTFN
Fred Drakec02bc3e2001-05-21 20:23:21 +00001791 os.mkdir(self._dir)
1792 os.mkdir(os.path.join(self._dir, "cur"))
1793 os.mkdir(os.path.join(self._dir, "tmp"))
1794 os.mkdir(os.path.join(self._dir, "new"))
1795 self._counter = 1
1796 self._msgfiles = []
1797
1798 def tearDown(self):
Guido van Rossumc1f779c2007-07-03 08:25:58 +00001799 list(map(os.unlink, self._msgfiles))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001800 os.rmdir(os.path.join(self._dir, "cur"))
1801 os.rmdir(os.path.join(self._dir, "tmp"))
1802 os.rmdir(os.path.join(self._dir, "new"))
1803 os.rmdir(self._dir)
1804
Skip Montanaro5253da12004-07-24 19:56:03 +00001805 def createMessage(self, dir, mbox=False):
Jack Jansen97df7b62001-06-19 20:20:05 +00001806 t = int(time.time() % 1000000)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001807 pid = self._counter
1808 self._counter += 1
Skip Montanaro7a98be22007-08-16 14:35:24 +00001809 filename = ".".join((str(t), str(pid), "myhostname", "mydomain"))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001810 tmpname = os.path.join(self._dir, "tmp", filename)
1811 newname = os.path.join(self._dir, dir, filename)
Brian Curtin5acec042010-10-13 02:29:46 +00001812 with open(tmpname, "w") as fp:
1813 self._msgfiles.append(tmpname)
1814 if mbox:
1815 fp.write(FROM_)
1816 fp.write(DUMMY_MESSAGE)
Tim Peters6626c1f2001-05-22 16:29:01 +00001817 if hasattr(os, "link"):
1818 os.link(tmpname, newname)
1819 else:
Brian Curtin5acec042010-10-13 02:29:46 +00001820 with open(newname, "w") as fp:
1821 fp.write(DUMMY_MESSAGE)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001822 self._msgfiles.append(newname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001823 return tmpname
Fred Drakec02bc3e2001-05-21 20:23:21 +00001824
1825 def test_empty_maildir(self):
1826 """Test an empty maildir mailbox"""
1827 # Test for regression on bug #117490:
1828 # Make sure the boxes attribute actually gets set.
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001829 self.mbox = mailbox.Maildir(support.TESTFN)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001830 #self.assertTrue(hasattr(self.mbox, "boxes"))
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001831 #self.assertEqual(len(self.mbox.boxes), 0)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001832 self.assertIs(self.mbox.next(), None)
1833 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001834
1835 def test_nonempty_maildir_cur(self):
1836 self.createMessage("cur")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001837 self.mbox = mailbox.Maildir(support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001838 #self.assertEqual(len(self.mbox.boxes), 1)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001839 self.assertIsNot(self.mbox.next(), None)
1840 self.assertIs(self.mbox.next(), None)
1841 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001842
1843 def test_nonempty_maildir_new(self):
1844 self.createMessage("new")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001845 self.mbox = mailbox.Maildir(support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001846 #self.assertEqual(len(self.mbox.boxes), 1)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001847 self.assertIsNot(self.mbox.next(), None)
1848 self.assertIs(self.mbox.next(), None)
1849 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001850
1851 def test_nonempty_maildir_both(self):
1852 self.createMessage("cur")
1853 self.createMessage("new")
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001854 self.mbox = mailbox.Maildir(support.TESTFN)
Guido van Rossume61fd5b2007-07-11 12:20:59 +00001855 #self.assertEqual(len(self.mbox.boxes), 2)
Alexandre Vassalottib27a1d22009-07-22 23:27:17 +00001856 self.assertIsNot(self.mbox.next(), None)
1857 self.assertIsNot(self.mbox.next(), None)
1858 self.assertIs(self.mbox.next(), None)
1859 self.assertIs(self.mbox.next(), None)
Fred Drake0aaed272000-10-23 13:39:15 +00001860
Georg Brandledb978f2008-05-11 08:59:40 +00001861## End: tests from the original module (for backward compatibility).
Thomas Wouters477c8d52006-05-27 19:21:47 +00001862
1863
1864_sample_message = """\
1865Return-Path: <gkj@gregorykjohnson.com>
1866X-Original-To: gkj+person@localhost
1867Delivered-To: gkj+person@localhost
1868Received: from localhost (localhost [127.0.0.1])
1869 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1870 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
1871Delivered-To: gkj@sundance.gregorykjohnson.com
1872Received: from localhost [127.0.0.1]
1873 by localhost with POP3 (fetchmail-6.2.5)
1874 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
1875Received: from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
1876 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1877 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
1878Received: by andy.gregorykjohnson.com (Postfix, from userid 1000)
1879 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
1880Date: Wed, 13 Jul 2005 17:23:11 -0400
1881From: "Gregory K. Johnson" <gkj@gregorykjohnson.com>
1882To: gkj@gregorykjohnson.com
1883Subject: Sample message
1884Message-ID: <20050713212311.GC4701@andy.gregorykjohnson.com>
1885Mime-Version: 1.0
1886Content-Type: multipart/mixed; boundary="NMuMz9nt05w80d4+"
1887Content-Disposition: inline
1888User-Agent: Mutt/1.5.9i
1889
1890
1891--NMuMz9nt05w80d4+
1892Content-Type: text/plain; charset=us-ascii
1893Content-Disposition: inline
1894
1895This is a sample message.
1896
1897--
1898Gregory K. Johnson
1899
1900--NMuMz9nt05w80d4+
1901Content-Type: application/octet-stream
1902Content-Disposition: attachment; filename="text.gz"
1903Content-Transfer-Encoding: base64
1904
1905H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
19063FYlAAAA
1907
1908--NMuMz9nt05w80d4+--
1909"""
1910
1911_sample_headers = {
1912 "Return-Path":"<gkj@gregorykjohnson.com>",
1913 "X-Original-To":"gkj+person@localhost",
1914 "Delivered-To":"gkj+person@localhost",
1915 "Received":"""from localhost (localhost [127.0.0.1])
1916 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1917 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
1918 "Delivered-To":"gkj@sundance.gregorykjohnson.com",
1919 "Received":"""from localhost [127.0.0.1]
1920 by localhost with POP3 (fetchmail-6.2.5)
1921 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
1922 "Received":"""from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
1923 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1924 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
1925 "Received":"""by andy.gregorykjohnson.com (Postfix, from userid 1000)
1926 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
1927 "Date":"Wed, 13 Jul 2005 17:23:11 -0400",
1928 "From":""""Gregory K. Johnson" <gkj@gregorykjohnson.com>""",
1929 "To":"gkj@gregorykjohnson.com",
1930 "Subject":"Sample message",
1931 "Mime-Version":"1.0",
1932 "Content-Type":"""multipart/mixed; boundary="NMuMz9nt05w80d4+\"""",
1933 "Content-Disposition":"inline",
1934 "User-Agent": "Mutt/1.5.9i" }
1935
1936_sample_payloads = ("""This is a sample message.
1937
1938--
1939Gregory K. Johnson
1940""",
1941"""H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
19423FYlAAAA
1943""")
Fred Drake0aaed272000-10-23 13:39:15 +00001944
Fred Drakec02bc3e2001-05-21 20:23:21 +00001945
Fred Drake2e2be372001-09-20 21:33:42 +00001946def test_main():
Thomas Wouters477c8d52006-05-27 19:21:47 +00001947 tests = (TestMailboxSuperclass, TestMaildir, TestMbox, TestMMDF, TestMH,
1948 TestBabyl, TestMessage, TestMaildirMessage, TestMboxMessage,
1949 TestMHMessage, TestBabylMessage, TestMMDFMessage,
1950 TestMessageConversion, TestProxyFile, TestPartialFile,
1951 MaildirTestCase)
Benjamin Petersonee8712c2008-05-20 21:35:26 +00001952 support.run_unittest(*tests)
1953 support.reap_children()
Fred Drake2e2be372001-09-20 21:33:42 +00001954
1955
Thomas Wouters477c8d52006-05-27 19:21:47 +00001956if __name__ == '__main__':
Fred Drake2e2be372001-09-20 21:33:42 +00001957 test_main()