blob: 97d304758e69a2e714ea86704be8f96dc9c74898 [file] [log] [blame]
Fred Drake0aaed272000-10-23 13:39:15 +00001import os
Neal Norwitz003c9e22006-08-11 06:09:41 +00002import sys
Fred Drakec02bc3e2001-05-21 20:23:21 +00003import time
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00004import stat
5import socket
6import email
Georg Brandl5a096e12007-01-22 19:40:21 +00007import email.message
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00008import re
9import StringIO
Barry Warsaw04f357c2002-07-23 19:04:11 +000010from test import test_support
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000011import unittest
12import mailbox
13import glob
Guido van Rossum75ebb292001-04-10 15:01:20 +000014try:
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000015 import fcntl
16except ImportError:
Guido van Rossum75ebb292001-04-10 15:01:20 +000017 pass
18
Ezio Melottia2d46532010-01-30 07:22:54 +000019# Silence Py3k warning
20rfc822 = test_support.import_module('rfc822', deprecated=True)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000021
22class TestBase(unittest.TestCase):
23
24 def _check_sample(self, msg):
25 # Inspect a mailbox.Message representation of the sample message
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000026 self.assertIsInstance(msg, email.message.Message)
27 self.assertIsInstance(msg, mailbox.Message)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000028 for key, value in _sample_headers.iteritems():
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000029 self.assertIn(value, msg.get_all(key))
Benjamin Peterson5c8da862009-06-30 22:57:08 +000030 self.assertTrue(msg.is_multipart())
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000031 self.assertEqual(len(msg.get_payload()), len(_sample_payloads))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000032 for i, payload in enumerate(_sample_payloads):
33 part = msg.get_payload(i)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000034 self.assertIsInstance(part, email.message.Message)
35 self.assertNotIsInstance(part, mailbox.Message)
36 self.assertEqual(part.get_payload(), payload)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000037
38 def _delete_recursively(self, target):
39 # Delete a file or delete a directory recursively
40 if os.path.isdir(target):
41 for path, dirs, files in os.walk(target, topdown=False):
42 for name in files:
43 os.remove(os.path.join(path, name))
44 for name in dirs:
45 os.rmdir(os.path.join(path, name))
46 os.rmdir(target)
47 elif os.path.exists(target):
48 os.remove(target)
49
50
51class TestMailbox(TestBase):
52
53 _factory = None # Overridden by subclasses to reuse tests
54 _template = 'From: foo\n\n%s'
55
56 def setUp(self):
57 self._path = test_support.TESTFN
Neal Norwitzb0a7d4e2007-03-20 06:16:26 +000058 self._delete_recursively(self._path)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000059 self._box = self._factory(self._path)
60
61 def tearDown(self):
62 self._box.close()
63 self._delete_recursively(self._path)
64
65 def test_add(self):
66 # Add copies of a sample message
67 keys = []
68 keys.append(self._box.add(self._template % 0))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000069 self.assertEqual(len(self._box), 1)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000070 keys.append(self._box.add(mailbox.Message(_sample_message)))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000071 self.assertEqual(len(self._box), 2)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000072 keys.append(self._box.add(email.message_from_string(_sample_message)))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000073 self.assertEqual(len(self._box), 3)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000074 keys.append(self._box.add(StringIO.StringIO(_sample_message)))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000075 self.assertEqual(len(self._box), 4)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000076 keys.append(self._box.add(_sample_message))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000077 self.assertEqual(len(self._box), 5)
78 self.assertEqual(self._box.get_string(keys[0]), self._template % 0)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000079 for i in (1, 2, 3, 4):
80 self._check_sample(self._box[keys[i]])
81
82 def test_remove(self):
83 # Remove messages using remove()
84 self._test_remove_or_delitem(self._box.remove)
85
86 def test_delitem(self):
87 # Remove messages using __delitem__()
88 self._test_remove_or_delitem(self._box.__delitem__)
89
90 def _test_remove_or_delitem(self, method):
91 # (Used by test_remove() and test_delitem().)
92 key0 = self._box.add(self._template % 0)
93 key1 = self._box.add(self._template % 1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000094 self.assertEqual(len(self._box), 2)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000095 method(key0)
96 l = len(self._box)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +000097 self.assertEqual(l, 1)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +000098 self.assertRaises(KeyError, lambda: self._box[key0])
99 self.assertRaises(KeyError, lambda: method(key0))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000100 self.assertEqual(self._box.get_string(key1), self._template % 1)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000101 key2 = self._box.add(self._template % 2)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000102 self.assertEqual(len(self._box), 2)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000103 method(key2)
104 l = len(self._box)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000105 self.assertEqual(l, 1)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000106 self.assertRaises(KeyError, lambda: self._box[key2])
107 self.assertRaises(KeyError, lambda: method(key2))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000108 self.assertEqual(self._box.get_string(key1), self._template % 1)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000109 method(key1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000110 self.assertEqual(len(self._box), 0)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000111 self.assertRaises(KeyError, lambda: self._box[key1])
112 self.assertRaises(KeyError, lambda: method(key1))
113
114 def test_discard(self, repetitions=10):
115 # Discard messages
116 key0 = self._box.add(self._template % 0)
117 key1 = self._box.add(self._template % 1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000118 self.assertEqual(len(self._box), 2)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000119 self._box.discard(key0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000120 self.assertEqual(len(self._box), 1)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000121 self.assertRaises(KeyError, lambda: self._box[key0])
122 self._box.discard(key0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000123 self.assertEqual(len(self._box), 1)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000124 self.assertRaises(KeyError, lambda: self._box[key0])
125
126 def test_get(self):
127 # Retrieve messages using get()
128 key0 = self._box.add(self._template % 0)
129 msg = self._box.get(key0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000130 self.assertEqual(msg['from'], 'foo')
131 self.assertEqual(msg.get_payload(), '0')
132 self.assertIs(self._box.get('foo'), None)
133 self.assertFalse(self._box.get('foo', False))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000134 self._box.close()
135 self._box = self._factory(self._path, factory=rfc822.Message)
136 key1 = self._box.add(self._template % 1)
137 msg = self._box.get(key1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000138 self.assertEqual(msg['from'], 'foo')
139 self.assertEqual(msg.fp.read(), '1')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000140
141 def test_getitem(self):
142 # Retrieve message using __getitem__()
143 key0 = self._box.add(self._template % 0)
144 msg = self._box[key0]
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000145 self.assertEqual(msg['from'], 'foo')
146 self.assertEqual(msg.get_payload(), '0')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000147 self.assertRaises(KeyError, lambda: self._box['foo'])
148 self._box.discard(key0)
149 self.assertRaises(KeyError, lambda: self._box[key0])
150
151 def test_get_message(self):
152 # Get Message representations of messages
153 key0 = self._box.add(self._template % 0)
154 key1 = self._box.add(_sample_message)
155 msg0 = self._box.get_message(key0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000156 self.assertIsInstance(msg0, mailbox.Message)
157 self.assertEqual(msg0['from'], 'foo')
158 self.assertEqual(msg0.get_payload(), '0')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000159 self._check_sample(self._box.get_message(key1))
160
161 def test_get_string(self):
162 # Get string representations of messages
163 key0 = self._box.add(self._template % 0)
164 key1 = self._box.add(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000165 self.assertEqual(self._box.get_string(key0), self._template % 0)
166 self.assertEqual(self._box.get_string(key1), _sample_message)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000167
168 def test_get_file(self):
169 # Get file representations of messages
170 key0 = self._box.add(self._template % 0)
171 key1 = self._box.add(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000172 self.assertEqual(self._box.get_file(key0).read().replace(os.linesep, '\n'),
173 self._template % 0)
174 self.assertEqual(self._box.get_file(key1).read().replace(os.linesep, '\n'),
175 _sample_message)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000176
R David Murrayf1138bb2011-06-17 22:23:04 -0400177 def test_get_file_can_be_closed_twice(self):
178 # Issue 11700
179 key = self._box.add(_sample_message)
180 f = self._box.get_file(key)
181 f.close()
182 f.close()
183
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000184 def test_iterkeys(self):
185 # Get keys using iterkeys()
186 self._check_iteration(self._box.iterkeys, do_keys=True, do_values=False)
187
188 def test_keys(self):
189 # Get keys using keys()
190 self._check_iteration(self._box.keys, do_keys=True, do_values=False)
191
192 def test_itervalues(self):
193 # Get values using itervalues()
194 self._check_iteration(self._box.itervalues, do_keys=False,
195 do_values=True)
196
197 def test_iter(self):
198 # Get values using __iter__()
199 self._check_iteration(self._box.__iter__, do_keys=False,
200 do_values=True)
201
202 def test_values(self):
203 # Get values using values()
204 self._check_iteration(self._box.values, do_keys=False, do_values=True)
205
206 def test_iteritems(self):
207 # Get keys and values using iteritems()
208 self._check_iteration(self._box.iteritems, do_keys=True,
209 do_values=True)
210
211 def test_items(self):
212 # Get keys and values using items()
213 self._check_iteration(self._box.items, do_keys=True, do_values=True)
214
215 def _check_iteration(self, method, do_keys, do_values, repetitions=10):
216 for value in method():
217 self.fail("Not empty")
218 keys, values = [], []
219 for i in xrange(repetitions):
220 keys.append(self._box.add(self._template % i))
221 values.append(self._template % i)
222 if do_keys and not do_values:
223 returned_keys = list(method())
224 elif do_values and not do_keys:
225 returned_values = list(method())
226 else:
227 returned_keys, returned_values = [], []
228 for key, value in method():
229 returned_keys.append(key)
230 returned_values.append(value)
231 if do_keys:
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000232 self.assertEqual(len(keys), len(returned_keys))
233 self.assertEqual(set(keys), set(returned_keys))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000234 if do_values:
235 count = 0
236 for value in returned_values:
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000237 self.assertEqual(value['from'], 'foo')
238 self.assertTrue(int(value.get_payload()) < repetitions,
239 (value.get_payload(), repetitions))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000240 count += 1
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000241 self.assertEqual(len(values), count)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000242
243 def test_has_key(self):
244 # Check existence of keys using has_key()
245 self._test_has_key_or_contains(self._box.has_key)
246
247 def test_contains(self):
248 # Check existence of keys using __contains__()
249 self._test_has_key_or_contains(self._box.__contains__)
250
251 def _test_has_key_or_contains(self, method):
252 # (Used by test_has_key() and test_contains().)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000253 self.assertFalse(method('foo'))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000254 key0 = self._box.add(self._template % 0)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000255 self.assertTrue(method(key0))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000256 self.assertFalse(method('foo'))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000257 key1 = self._box.add(self._template % 1)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000258 self.assertTrue(method(key1))
259 self.assertTrue(method(key0))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000260 self.assertFalse(method('foo'))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000261 self._box.remove(key0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000262 self.assertFalse(method(key0))
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000263 self.assertTrue(method(key1))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000264 self.assertFalse(method('foo'))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000265 self._box.remove(key1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000266 self.assertFalse(method(key1))
267 self.assertFalse(method(key0))
268 self.assertFalse(method('foo'))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000269
270 def test_len(self, repetitions=10):
271 # Get message count
272 keys = []
273 for i in xrange(repetitions):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000274 self.assertEqual(len(self._box), i)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000275 keys.append(self._box.add(self._template % i))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000276 self.assertEqual(len(self._box), i + 1)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000277 for i in xrange(repetitions):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000278 self.assertEqual(len(self._box), repetitions - i)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000279 self._box.remove(keys[i])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000280 self.assertEqual(len(self._box), repetitions - i - 1)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000281
282 def test_set_item(self):
283 # Modify messages using __setitem__()
284 key0 = self._box.add(self._template % 'original 0')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000285 self.assertEqual(self._box.get_string(key0),
286 self._template % 'original 0')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000287 key1 = self._box.add(self._template % 'original 1')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000288 self.assertEqual(self._box.get_string(key1),
289 self._template % 'original 1')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000290 self._box[key0] = self._template % 'changed 0'
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000291 self.assertEqual(self._box.get_string(key0),
292 self._template % 'changed 0')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000293 self._box[key1] = self._template % 'changed 1'
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000294 self.assertEqual(self._box.get_string(key1),
295 self._template % 'changed 1')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000296 self._box[key0] = _sample_message
297 self._check_sample(self._box[key0])
298 self._box[key1] = self._box[key0]
299 self._check_sample(self._box[key1])
300 self._box[key0] = self._template % 'original 0'
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000301 self.assertEqual(self._box.get_string(key0),
302 self._template % 'original 0')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000303 self._check_sample(self._box[key1])
304 self.assertRaises(KeyError,
305 lambda: self._box.__setitem__('foo', 'bar'))
306 self.assertRaises(KeyError, lambda: self._box['foo'])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000307 self.assertEqual(len(self._box), 2)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000308
309 def test_clear(self, iterations=10):
310 # Remove all messages using clear()
311 keys = []
312 for i in xrange(iterations):
313 self._box.add(self._template % i)
314 for i, key in enumerate(keys):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000315 self.assertEqual(self._box.get_string(key), self._template % i)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000316 self._box.clear()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000317 self.assertEqual(len(self._box), 0)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000318 for i, key in enumerate(keys):
319 self.assertRaises(KeyError, lambda: self._box.get_string(key))
320
321 def test_pop(self):
322 # Get and remove a message using pop()
323 key0 = self._box.add(self._template % 0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000324 self.assertIn(key0, self._box)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000325 key1 = self._box.add(self._template % 1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000326 self.assertIn(key1, self._box)
327 self.assertEqual(self._box.pop(key0).get_payload(), '0')
328 self.assertNotIn(key0, self._box)
329 self.assertIn(key1, self._box)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000330 key2 = self._box.add(self._template % 2)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000331 self.assertIn(key2, self._box)
332 self.assertEqual(self._box.pop(key2).get_payload(), '2')
333 self.assertNotIn(key2, self._box)
334 self.assertIn(key1, self._box)
335 self.assertEqual(self._box.pop(key1).get_payload(), '1')
336 self.assertNotIn(key1, self._box)
337 self.assertEqual(len(self._box), 0)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000338
339 def test_popitem(self, iterations=10):
340 # Get and remove an arbitrary (key, message) using popitem()
341 keys = []
342 for i in xrange(10):
343 keys.append(self._box.add(self._template % i))
344 seen = []
345 for i in xrange(10):
346 key, msg = self._box.popitem()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000347 self.assertIn(key, keys)
348 self.assertNotIn(key, seen)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000349 seen.append(key)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000350 self.assertEqual(int(msg.get_payload()), keys.index(key))
351 self.assertEqual(len(self._box), 0)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000352 for key in keys:
353 self.assertRaises(KeyError, lambda: self._box[key])
354
355 def test_update(self):
356 # Modify multiple messages using update()
357 key0 = self._box.add(self._template % 'original 0')
358 key1 = self._box.add(self._template % 'original 1')
359 key2 = self._box.add(self._template % 'original 2')
360 self._box.update({key0: self._template % 'changed 0',
361 key2: _sample_message})
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000362 self.assertEqual(len(self._box), 3)
363 self.assertEqual(self._box.get_string(key0),
364 self._template % 'changed 0')
365 self.assertEqual(self._box.get_string(key1),
366 self._template % 'original 1')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000367 self._check_sample(self._box[key2])
368 self._box.update([(key2, self._template % 'changed 2'),
369 (key1, self._template % 'changed 1'),
370 (key0, self._template % 'original 0')])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000371 self.assertEqual(len(self._box), 3)
372 self.assertEqual(self._box.get_string(key0),
373 self._template % 'original 0')
374 self.assertEqual(self._box.get_string(key1),
375 self._template % 'changed 1')
376 self.assertEqual(self._box.get_string(key2),
377 self._template % 'changed 2')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000378 self.assertRaises(KeyError,
379 lambda: self._box.update({'foo': 'bar',
380 key0: self._template % "changed 0"}))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000381 self.assertEqual(len(self._box), 3)
382 self.assertEqual(self._box.get_string(key0),
383 self._template % "changed 0")
384 self.assertEqual(self._box.get_string(key1),
385 self._template % "changed 1")
386 self.assertEqual(self._box.get_string(key2),
387 self._template % "changed 2")
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000388
389 def test_flush(self):
390 # Write changes to disk
Neal Norwitz22b3e3a2008-03-26 05:19:41 +0000391 self._test_flush_or_close(self._box.flush, True)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000392
393 def test_lock_unlock(self):
394 # Lock and unlock the mailbox
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000395 self.assertFalse(os.path.exists(self._get_lock_path()))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000396 self._box.lock()
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000397 self.assertTrue(os.path.exists(self._get_lock_path()))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000398 self._box.unlock()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000399 self.assertFalse(os.path.exists(self._get_lock_path()))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000400
401 def test_close(self):
402 # Close mailbox and flush changes to disk
Neal Norwitz22b3e3a2008-03-26 05:19:41 +0000403 self._test_flush_or_close(self._box.close, False)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000404
Neal Norwitz22b3e3a2008-03-26 05:19:41 +0000405 def _test_flush_or_close(self, method, should_call_close):
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000406 contents = [self._template % i for i in xrange(3)]
407 self._box.add(contents[0])
408 self._box.add(contents[1])
409 self._box.add(contents[2])
410 method()
Neal Norwitz22b3e3a2008-03-26 05:19:41 +0000411 if should_call_close:
412 self._box.close()
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000413 self._box = self._factory(self._path)
414 keys = self._box.keys()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000415 self.assertEqual(len(keys), 3)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000416 for key in keys:
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000417 self.assertIn(self._box.get_string(key), contents)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000418
419 def test_dump_message(self):
420 # Write message representations to disk
421 for input in (email.message_from_string(_sample_message),
422 _sample_message, StringIO.StringIO(_sample_message)):
423 output = StringIO.StringIO()
424 self._box._dump_message(input, output)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000425 self.assertEqual(output.getvalue(),
426 _sample_message.replace('\n', os.linesep))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000427 output = StringIO.StringIO()
428 self.assertRaises(TypeError,
429 lambda: self._box._dump_message(None, output))
430
431 def _get_lock_path(self):
432 # Return the path of the dot lock file. May be overridden.
433 return self._path + '.lock'
434
435
436class TestMailboxSuperclass(TestBase):
437
438 def test_notimplemented(self):
439 # Test that all Mailbox methods raise NotImplementedException.
440 box = mailbox.Mailbox('path')
441 self.assertRaises(NotImplementedError, lambda: box.add(''))
442 self.assertRaises(NotImplementedError, lambda: box.remove(''))
443 self.assertRaises(NotImplementedError, lambda: box.__delitem__(''))
444 self.assertRaises(NotImplementedError, lambda: box.discard(''))
445 self.assertRaises(NotImplementedError, lambda: box.__setitem__('', ''))
446 self.assertRaises(NotImplementedError, lambda: box.iterkeys())
447 self.assertRaises(NotImplementedError, lambda: box.keys())
448 self.assertRaises(NotImplementedError, lambda: box.itervalues().next())
449 self.assertRaises(NotImplementedError, lambda: box.__iter__().next())
450 self.assertRaises(NotImplementedError, lambda: box.values())
451 self.assertRaises(NotImplementedError, lambda: box.iteritems().next())
452 self.assertRaises(NotImplementedError, lambda: box.items())
453 self.assertRaises(NotImplementedError, lambda: box.get(''))
454 self.assertRaises(NotImplementedError, lambda: box.__getitem__(''))
455 self.assertRaises(NotImplementedError, lambda: box.get_message(''))
456 self.assertRaises(NotImplementedError, lambda: box.get_string(''))
457 self.assertRaises(NotImplementedError, lambda: box.get_file(''))
458 self.assertRaises(NotImplementedError, lambda: box.has_key(''))
459 self.assertRaises(NotImplementedError, lambda: box.__contains__(''))
460 self.assertRaises(NotImplementedError, lambda: box.__len__())
461 self.assertRaises(NotImplementedError, lambda: box.clear())
462 self.assertRaises(NotImplementedError, lambda: box.pop(''))
463 self.assertRaises(NotImplementedError, lambda: box.popitem())
464 self.assertRaises(NotImplementedError, lambda: box.update((('', ''),)))
465 self.assertRaises(NotImplementedError, lambda: box.flush())
466 self.assertRaises(NotImplementedError, lambda: box.lock())
467 self.assertRaises(NotImplementedError, lambda: box.unlock())
468 self.assertRaises(NotImplementedError, lambda: box.close())
469
470
471class TestMaildir(TestMailbox):
472
473 _factory = lambda self, path, factory=None: mailbox.Maildir(path, factory)
474
475 def setUp(self):
476 TestMailbox.setUp(self)
Neal Norwitz003c9e22006-08-11 06:09:41 +0000477 if os.name in ('nt', 'os2') or sys.platform == 'cygwin':
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000478 self._box.colon = '!'
479
480 def test_add_MM(self):
481 # Add a MaildirMessage instance
482 msg = mailbox.MaildirMessage(self._template % 0)
483 msg.set_subdir('cur')
484 msg.set_info('foo')
485 key = self._box.add(msg)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000486 self.assertTrue(os.path.exists(os.path.join(self._path, 'cur', '%s%sfoo' %
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000487 (key, self._box.colon))))
488
489 def test_get_MM(self):
490 # Get a MaildirMessage instance
491 msg = mailbox.MaildirMessage(self._template % 0)
492 msg.set_subdir('cur')
493 msg.set_flags('RF')
494 key = self._box.add(msg)
495 msg_returned = self._box.get_message(key)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000496 self.assertIsInstance(msg_returned, mailbox.MaildirMessage)
497 self.assertEqual(msg_returned.get_subdir(), 'cur')
498 self.assertEqual(msg_returned.get_flags(), 'FR')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000499
500 def test_set_MM(self):
501 # Set with a MaildirMessage instance
502 msg0 = mailbox.MaildirMessage(self._template % 0)
503 msg0.set_flags('TP')
504 key = self._box.add(msg0)
505 msg_returned = self._box.get_message(key)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000506 self.assertEqual(msg_returned.get_subdir(), 'new')
507 self.assertEqual(msg_returned.get_flags(), 'PT')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000508 msg1 = mailbox.MaildirMessage(self._template % 1)
509 self._box[key] = msg1
510 msg_returned = self._box.get_message(key)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000511 self.assertEqual(msg_returned.get_subdir(), 'new')
512 self.assertEqual(msg_returned.get_flags(), '')
513 self.assertEqual(msg_returned.get_payload(), '1')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000514 msg2 = mailbox.MaildirMessage(self._template % 2)
515 msg2.set_info('2,S')
516 self._box[key] = msg2
517 self._box[key] = self._template % 3
518 msg_returned = self._box.get_message(key)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000519 self.assertEqual(msg_returned.get_subdir(), 'new')
520 self.assertEqual(msg_returned.get_flags(), 'S')
521 self.assertEqual(msg_returned.get_payload(), '3')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000522
Andrew M. Kuchling15ce8802008-01-19 20:12:04 +0000523 def test_consistent_factory(self):
524 # Add a message.
525 msg = mailbox.MaildirMessage(self._template % 0)
526 msg.set_subdir('cur')
527 msg.set_flags('RF')
528 key = self._box.add(msg)
529
530 # Create new mailbox with
531 class FakeMessage(mailbox.MaildirMessage):
532 pass
533 box = mailbox.Maildir(self._path, factory=FakeMessage)
Amaury Forgeot d'Arc07974d72008-02-03 23:15:32 +0000534 box.colon = self._box.colon
Andrew M. Kuchling15ce8802008-01-19 20:12:04 +0000535 msg2 = box.get_message(key)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000536 self.assertIsInstance(msg2, FakeMessage)
Andrew M. Kuchling15ce8802008-01-19 20:12:04 +0000537
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000538 def test_initialize_new(self):
539 # Initialize a non-existent mailbox
540 self.tearDown()
541 self._box = mailbox.Maildir(self._path)
542 self._check_basics(factory=rfc822.Message)
543 self._delete_recursively(self._path)
544 self._box = self._factory(self._path, factory=None)
545 self._check_basics()
546
547 def test_initialize_existing(self):
548 # Initialize an existing mailbox
549 self.tearDown()
550 for subdir in '', 'tmp', 'new', 'cur':
Andrew MacIntyreafa358f2006-07-23 13:04:00 +0000551 os.mkdir(os.path.normpath(os.path.join(self._path, subdir)))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000552 self._box = mailbox.Maildir(self._path)
553 self._check_basics(factory=rfc822.Message)
554 self._box = mailbox.Maildir(self._path, factory=None)
555 self._check_basics()
556
557 def _check_basics(self, factory=None):
558 # (Used by test_open_new() and test_open_existing().)
559 self.assertEqual(self._box._path, os.path.abspath(self._path))
560 self.assertEqual(self._box._factory, factory)
561 for subdir in '', 'tmp', 'new', 'cur':
562 path = os.path.join(self._path, subdir)
563 mode = os.stat(path)[stat.ST_MODE]
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000564 self.assertTrue(stat.S_ISDIR(mode), "Not a directory: '%s'" % path)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000565
566 def test_list_folders(self):
567 # List folders
568 self._box.add_folder('one')
569 self._box.add_folder('two')
570 self._box.add_folder('three')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000571 self.assertEqual(len(self._box.list_folders()), 3)
572 self.assertEqual(set(self._box.list_folders()),
573 set(('one', 'two', 'three')))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000574
575 def test_get_folder(self):
576 # Open folders
577 self._box.add_folder('foo.bar')
578 folder0 = self._box.get_folder('foo.bar')
579 folder0.add(self._template % 'bar')
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000580 self.assertTrue(os.path.isdir(os.path.join(self._path, '.foo.bar')))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000581 folder1 = self._box.get_folder('foo.bar')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000582 self.assertEqual(folder1.get_string(folder1.keys()[0]),
583 self._template % 'bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000584
585 def test_add_and_remove_folders(self):
586 # Delete folders
587 self._box.add_folder('one')
588 self._box.add_folder('two')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000589 self.assertEqual(len(self._box.list_folders()), 2)
590 self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000591 self._box.remove_folder('one')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000592 self.assertEqual(len(self._box.list_folders()), 1)
593 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000594 self._box.add_folder('three')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000595 self.assertEqual(len(self._box.list_folders()), 2)
596 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000597 self._box.remove_folder('three')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000598 self.assertEqual(len(self._box.list_folders()), 1)
599 self.assertEqual(set(self._box.list_folders()), set(('two',)))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000600 self._box.remove_folder('two')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000601 self.assertEqual(len(self._box.list_folders()), 0)
602 self.assertEqual(self._box.list_folders(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000603
604 def test_clean(self):
605 # Remove old files from 'tmp'
606 foo_path = os.path.join(self._path, 'tmp', 'foo')
607 bar_path = os.path.join(self._path, 'tmp', 'bar')
Brian Curtin04d8b222010-10-14 01:14:36 +0000608 with open(foo_path, 'w') as f:
609 f.write("@")
610 with open(bar_path, 'w') as f:
611 f.write("@")
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000612 self._box.clean()
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000613 self.assertTrue(os.path.exists(foo_path))
614 self.assertTrue(os.path.exists(bar_path))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000615 foo_stat = os.stat(foo_path)
Guido van Rossumb2045832006-05-02 20:47:36 +0000616 os.utime(foo_path, (time.time() - 129600 - 2,
617 foo_stat.st_mtime))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000618 self._box.clean()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000619 self.assertFalse(os.path.exists(foo_path))
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000620 self.assertTrue(os.path.exists(bar_path))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000621
622 def test_create_tmp(self, repetitions=10):
623 # Create files in tmp directory
624 hostname = socket.gethostname()
625 if '/' in hostname:
626 hostname = hostname.replace('/', r'\057')
627 if ':' in hostname:
628 hostname = hostname.replace(':', r'\072')
629 pid = os.getpid()
630 pattern = re.compile(r"(?P<time>\d+)\.M(?P<M>\d{1,6})P(?P<P>\d+)"
631 r"Q(?P<Q>\d+)\.(?P<host>[^:/]+)")
632 previous_groups = None
633 for x in xrange(repetitions):
634 tmp_file = self._box._create_tmp()
635 head, tail = os.path.split(tmp_file.name)
636 self.assertEqual(head, os.path.abspath(os.path.join(self._path,
637 "tmp")),
638 "File in wrong location: '%s'" % head)
639 match = pattern.match(tail)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000640 self.assertTrue(match is not None, "Invalid file name: '%s'" % tail)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000641 groups = match.groups()
Benjamin Peterson5b63acd2008-03-29 15:24:25 +0000642 if previous_groups is not None:
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000643 self.assertTrue(int(groups[0] >= previous_groups[0]),
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000644 "Non-monotonic seconds: '%s' before '%s'" %
645 (previous_groups[0], groups[0]))
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000646 self.assertTrue(int(groups[1] >= previous_groups[1]) or
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000647 groups[0] != groups[1],
648 "Non-monotonic milliseconds: '%s' before '%s'" %
649 (previous_groups[1], groups[1]))
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000650 self.assertTrue(int(groups[2]) == pid,
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000651 "Process ID mismatch: '%s' should be '%s'" %
652 (groups[2], pid))
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000653 self.assertTrue(int(groups[3]) == int(previous_groups[3]) + 1,
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000654 "Non-sequential counter: '%s' before '%s'" %
655 (previous_groups[3], groups[3]))
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000656 self.assertTrue(groups[4] == hostname,
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000657 "Host name mismatch: '%s' should be '%s'" %
658 (groups[4], hostname))
659 previous_groups = groups
660 tmp_file.write(_sample_message)
661 tmp_file.seek(0)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000662 self.assertTrue(tmp_file.read() == _sample_message)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000663 tmp_file.close()
664 file_count = len(os.listdir(os.path.join(self._path, "tmp")))
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000665 self.assertTrue(file_count == repetitions,
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000666 "Wrong file count: '%s' should be '%s'" %
667 (file_count, repetitions))
668
669 def test_refresh(self):
670 # Update the table of contents
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000671 self.assertEqual(self._box._toc, {})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000672 key0 = self._box.add(self._template % 0)
673 key1 = self._box.add(self._template % 1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000674 self.assertEqual(self._box._toc, {})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000675 self._box._refresh()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000676 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
677 key1: os.path.join('new', key1)})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000678 key2 = self._box.add(self._template % 2)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000679 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
680 key1: os.path.join('new', key1)})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000681 self._box._refresh()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000682 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
683 key1: os.path.join('new', key1),
684 key2: os.path.join('new', key2)})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000685
Petri Lehtinen49aa72e2011-11-05 09:50:37 +0200686 def test_refresh_after_safety_period(self):
687 # Issue #13254: Call _refresh after the "file system safety
688 # period" of 2 seconds has passed; _toc should still be
689 # updated because this is the first call to _refresh.
690 key0 = self._box.add(self._template % 0)
691 key1 = self._box.add(self._template % 1)
692
693 self._box = self._factory(self._path)
694 self.assertEqual(self._box._toc, {})
695
696 # Emulate sleeping. Instead of sleeping for 2 seconds, use the
697 # skew factor to make _refresh think that the filesystem
698 # safety period has passed and re-reading the _toc is only
699 # required if mtimes differ.
700 self._box._skewfactor = -2
701
702 self._box._refresh()
703 self.assertEqual(sorted(self._box._toc.keys()), sorted([key0, key1]))
704
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000705 def test_lookup(self):
706 # Look up message subpaths in the TOC
707 self.assertRaises(KeyError, lambda: self._box._lookup('foo'))
708 key0 = self._box.add(self._template % 0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000709 self.assertEqual(self._box._lookup(key0), os.path.join('new', key0))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000710 os.remove(os.path.join(self._path, 'new', key0))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000711 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0)})
Antoine Pitroue4c6b162009-11-01 21:29:33 +0000712 # Be sure that the TOC is read back from disk (see issue #6896
713 # about bad mtime behaviour on some systems).
714 self._box.flush()
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000715 self.assertRaises(KeyError, lambda: self._box._lookup(key0))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000716 self.assertEqual(self._box._toc, {})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000717
718 def test_lock_unlock(self):
719 # Lock and unlock the mailbox. For Maildir, this does nothing.
720 self._box.lock()
721 self._box.unlock()
722
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000723 def test_folder (self):
724 # Test for bug #1569790: verify that folders returned by .get_folder()
725 # use the same factory function.
726 def dummy_factory (s):
727 return None
728 box = self._factory(self._path, factory=dummy_factory)
729 folder = box.add_folder('folder1')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000730 self.assertIs(folder._factory, dummy_factory)
Tim Petersf733abb2007-01-30 03:03:46 +0000731
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000732 folder1_alias = box.get_folder('folder1')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000733 self.assertIs(folder1_alias._factory, dummy_factory)
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000734
Andrew M. Kuchling2b09ef02007-07-14 21:56:19 +0000735 def test_directory_in_folder (self):
736 # Test that mailboxes still work if there's a stray extra directory
737 # in a folder.
738 for i in range(10):
739 self._box.add(mailbox.Message(_sample_message))
Tim Petersf733abb2007-01-30 03:03:46 +0000740
Andrew M. Kuchling2b09ef02007-07-14 21:56:19 +0000741 # Create a stray directory
742 os.mkdir(os.path.join(self._path, 'cur', 'stray-dir'))
743
744 # Check that looping still works with the directory present.
745 for msg in self._box:
746 pass
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000747
Andrew M. Kuchling10288e12008-08-05 01:00:57 +0000748 def test_file_permissions(self):
749 # Verify that message files are created without execute permissions
750 if not hasattr(os, "stat") or not hasattr(os, "umask"):
751 return
752 msg = mailbox.MaildirMessage(self._template % 0)
753 orig_umask = os.umask(0)
754 try:
755 key = self._box.add(msg)
756 finally:
757 os.umask(orig_umask)
758 path = os.path.join(self._path, self._box._lookup(key))
759 mode = os.stat(path).st_mode
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000760 self.assertEqual(mode & 0111, 0)
Andrew M. Kuchling10288e12008-08-05 01:00:57 +0000761
762 def test_folder_file_perms(self):
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000763 # From bug #3228, we want to verify that the file created inside a Maildir
764 # subfolder isn't marked as executable.
Andrew M. Kuchling10288e12008-08-05 01:00:57 +0000765 if not hasattr(os, "stat") or not hasattr(os, "umask"):
766 return
767
768 orig_umask = os.umask(0)
769 try:
770 subfolder = self._box.add_folder('subfolder')
771 finally:
772 os.umask(orig_umask)
773
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000774 path = os.path.join(subfolder._path, 'maildirfolder')
775 st = os.stat(path)
776 perms = st.st_mode
777 self.assertFalse((perms & 0111)) # Execute bits should all be off.
778
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000779 def test_reread(self):
Petri Lehtinen49aa72e2011-11-05 09:50:37 +0200780 # Do an initial unconditional refresh
781 self._box._refresh()
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000782
R David Murray8b26c4b2011-05-06 21:56:22 -0400783 # Put the last modified times more than two seconds into the past
784 # (because mtime may have only a two second granularity).
785 for subdir in ('cur', 'new'):
786 os.utime(os.path.join(self._box._path, subdir),
787 (time.time()-5,)*2)
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000788
R David Murray8b26c4b2011-05-06 21:56:22 -0400789 # Because mtime has a two second granularity in worst case (FAT), a
790 # refresh is done unconditionally if called for within
791 # two-second-plus-a-bit of the last one, just in case the mbox has
792 # changed; so now we have to wait for that interval to expire.
793 time.sleep(2.01 + self._box._skewfactor)
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000794
R David Murray8b26c4b2011-05-06 21:56:22 -0400795 # Re-reading causes the ._toc attribute to be assigned a new dictionary
796 # object, so we'll check that the ._toc attribute isn't a different
797 # object.
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000798 orig_toc = self._box._toc
799 def refreshed():
800 return self._box._toc is not orig_toc
801
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000802 self._box._refresh()
R David Murray8b26c4b2011-05-06 21:56:22 -0400803 self.assertFalse(refreshed())
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000804
805 # Now, write something into cur and remove it. This changes
806 # the mtime and should cause a re-read.
807 filename = os.path.join(self._path, 'cur', 'stray-file')
808 f = open(filename, 'w')
809 f.close()
810 os.unlink(filename)
811 self._box._refresh()
R David Murray8b26c4b2011-05-06 21:56:22 -0400812 self.assertTrue(refreshed())
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000813
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000814class _TestMboxMMDF(TestMailbox):
815
816 def tearDown(self):
817 self._box.close()
818 self._delete_recursively(self._path)
819 for lock_remnant in glob.glob(self._path + '.*'):
Neal Norwitz6cbd8de2007-03-20 06:53:17 +0000820 test_support.unlink(lock_remnant)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000821
822 def test_add_from_string(self):
823 # Add a string starting with 'From ' to the mailbox
824 key = self._box.add('From foo@bar blah\nFrom: foo\n\n0')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000825 self.assertEqual(self._box[key].get_from(), 'foo@bar blah')
826 self.assertEqual(self._box[key].get_payload(), '0')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000827
828 def test_add_mbox_or_mmdf_message(self):
829 # Add an mboxMessage or MMDFMessage
830 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
831 msg = class_('From foo@bar blah\nFrom: foo\n\n0')
832 key = self._box.add(msg)
833
834 def test_open_close_open(self):
835 # Open and inspect previously-created mailbox
836 values = [self._template % i for i in xrange(3)]
837 for value in values:
838 self._box.add(value)
839 self._box.close()
840 mtime = os.path.getmtime(self._path)
841 self._box = self._factory(self._path)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000842 self.assertEqual(len(self._box), 3)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000843 for key in self._box.iterkeys():
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000844 self.assertIn(self._box.get_string(key), values)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000845 self._box.close()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000846 self.assertEqual(mtime, os.path.getmtime(self._path))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000847
848 def test_add_and_close(self):
849 # Verifying that closing a mailbox doesn't change added items
850 self._box.add(_sample_message)
851 for i in xrange(3):
852 self._box.add(self._template % i)
853 self._box.add(_sample_message)
854 self._box._file.flush()
855 self._box._file.seek(0)
856 contents = self._box._file.read()
857 self._box.close()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000858 with open(self._path, 'rb') as f:
859 self.assertEqual(contents, f.read())
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000860 self._box = self._factory(self._path)
861
Andrew M. Kuchling9afbace2006-06-26 13:23:10 +0000862 def test_lock_conflict(self):
863 # Fork off a subprocess that will lock the file for 2 seconds,
864 # unlock it, and then exit.
Andrew M. Kuchlingec3c3682006-06-26 14:33:24 +0000865 if not hasattr(os, 'fork'):
866 return
Andrew M. Kuchling9afbace2006-06-26 13:23:10 +0000867 pid = os.fork()
868 if pid == 0:
869 # In the child, lock the mailbox.
870 self._box.lock()
871 time.sleep(2)
872 self._box.unlock()
873 os._exit(0)
874
875 # In the parent, sleep a bit to give the child time to acquire
876 # the lock.
877 time.sleep(0.5)
Neal Norwitz003c9e22006-08-11 06:09:41 +0000878 try:
879 self.assertRaises(mailbox.ExternalClashError,
880 self._box.lock)
881 finally:
882 # Wait for child to exit. Locking should now succeed.
883 exited_pid, status = os.waitpid(pid, 0)
Tim Peters3249d002006-06-27 11:52:49 +0000884
Andrew M. Kuchling9afbace2006-06-26 13:23:10 +0000885 self._box.lock()
886 self._box.unlock()
Tim Peters3249d002006-06-27 11:52:49 +0000887
Andrew M. Kuchling0f871832006-10-27 16:55:34 +0000888 def test_relock(self):
889 # Test case for bug #1575506: the mailbox class was locking the
890 # wrong file object in its flush() method.
891 msg = "Subject: sub\n\nbody\n"
892 key1 = self._box.add(msg)
893 self._box.flush()
894 self._box.close()
Tim Petersabd8a332006-11-03 02:32:46 +0000895
Andrew M. Kuchling0f871832006-10-27 16:55:34 +0000896 self._box = self._factory(self._path)
897 self._box.lock()
898 key2 = self._box.add(msg)
899 self._box.flush()
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000900 self.assertTrue(self._box._locked)
Andrew M. Kuchling0f871832006-10-27 16:55:34 +0000901 self._box.close()
Tim Petersabd8a332006-11-03 02:32:46 +0000902
903
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000904class TestMbox(_TestMboxMMDF):
905
906 _factory = lambda self, path, factory=None: mailbox.mbox(path, factory)
907
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000908 def test_file_perms(self):
909 # From bug #3228, we want to verify that the mailbox file isn't executable,
910 # even if the umask is set to something that would leave executable bits set.
911 # We only run this test on platforms that support umask.
Andrew M. Kuchling10288e12008-08-05 01:00:57 +0000912 if hasattr(os, 'umask') and hasattr(os, 'stat'):
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000913 try:
914 old_umask = os.umask(0077)
915 self._box.close()
916 os.unlink(self._path)
917 self._box = mailbox.mbox(self._path, create=True)
918 self._box.add('')
919 self._box.close()
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000920 finally:
921 os.umask(old_umask)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000922
Andrew M. Kuchling10288e12008-08-05 01:00:57 +0000923 st = os.stat(self._path)
924 perms = st.st_mode
925 self.assertFalse((perms & 0111)) # Execute bits should all be off.
926
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000927class TestMMDF(_TestMboxMMDF):
928
929 _factory = lambda self, path, factory=None: mailbox.MMDF(path, factory)
930
931
932class TestMH(TestMailbox):
933
934 _factory = lambda self, path, factory=None: mailbox.MH(path, factory)
935
936 def test_list_folders(self):
937 # List folders
938 self._box.add_folder('one')
939 self._box.add_folder('two')
940 self._box.add_folder('three')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000941 self.assertEqual(len(self._box.list_folders()), 3)
942 self.assertEqual(set(self._box.list_folders()),
943 set(('one', 'two', 'three')))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000944
945 def test_get_folder(self):
946 # Open folders
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000947 def dummy_factory (s):
948 return None
949 self._box = self._factory(self._path, dummy_factory)
Tim Petersf733abb2007-01-30 03:03:46 +0000950
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000951 new_folder = self._box.add_folder('foo.bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000952 folder0 = self._box.get_folder('foo.bar')
953 folder0.add(self._template % 'bar')
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000954 self.assertTrue(os.path.isdir(os.path.join(self._path, 'foo.bar')))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000955 folder1 = self._box.get_folder('foo.bar')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000956 self.assertEqual(folder1.get_string(folder1.keys()[0]),
957 self._template % 'bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000958
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000959 # Test for bug #1569790: verify that folders returned by .get_folder()
960 # use the same factory function.
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000961 self.assertIs(new_folder._factory, self._box._factory)
962 self.assertIs(folder0._factory, self._box._factory)
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000963
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000964 def test_add_and_remove_folders(self):
965 # Delete folders
966 self._box.add_folder('one')
967 self._box.add_folder('two')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000968 self.assertEqual(len(self._box.list_folders()), 2)
969 self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000970 self._box.remove_folder('one')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000971 self.assertEqual(len(self._box.list_folders()), 1)
972 self.assertEqual(set(self._box.list_folders()), set(('two', )))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000973 self._box.add_folder('three')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000974 self.assertEqual(len(self._box.list_folders()), 2)
975 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000976 self._box.remove_folder('three')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000977 self.assertEqual(len(self._box.list_folders()), 1)
978 self.assertEqual(set(self._box.list_folders()), set(('two', )))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000979 self._box.remove_folder('two')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000980 self.assertEqual(len(self._box.list_folders()), 0)
981 self.assertEqual(self._box.list_folders(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000982
983 def test_sequences(self):
984 # Get and set sequences
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000985 self.assertEqual(self._box.get_sequences(), {})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000986 msg0 = mailbox.MHMessage(self._template % 0)
987 msg0.add_sequence('foo')
988 key0 = self._box.add(msg0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000989 self.assertEqual(self._box.get_sequences(), {'foo':[key0]})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000990 msg1 = mailbox.MHMessage(self._template % 1)
991 msg1.set_sequences(['bar', 'replied', 'foo'])
992 key1 = self._box.add(msg1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000993 self.assertEqual(self._box.get_sequences(),
994 {'foo':[key0, key1], 'bar':[key1], 'replied':[key1]})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000995 msg0.set_sequences(['flagged'])
996 self._box[key0] = msg0
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000997 self.assertEqual(self._box.get_sequences(),
998 {'foo':[key1], 'bar':[key1], 'replied':[key1],
999 'flagged':[key0]})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001000 self._box.remove(key1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001001 self.assertEqual(self._box.get_sequences(), {'flagged':[key0]})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001002
R. David Murray52720c52009-04-02 14:05:35 +00001003 def test_issue2625(self):
1004 msg0 = mailbox.MHMessage(self._template % 0)
1005 msg0.add_sequence('foo')
1006 key0 = self._box.add(msg0)
1007 refmsg0 = self._box.get_message(key0)
1008
Andrew M. Kuchlingb72b0eb2010-02-22 18:42:07 +00001009 def test_issue7627(self):
1010 msg0 = mailbox.MHMessage(self._template % 0)
1011 key0 = self._box.add(msg0)
1012 self._box.lock()
1013 self._box.remove(key0)
1014 self._box.unlock()
1015
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001016 def test_pack(self):
1017 # Pack the contents of the mailbox
1018 msg0 = mailbox.MHMessage(self._template % 0)
1019 msg1 = mailbox.MHMessage(self._template % 1)
1020 msg2 = mailbox.MHMessage(self._template % 2)
1021 msg3 = mailbox.MHMessage(self._template % 3)
1022 msg0.set_sequences(['foo', 'unseen'])
1023 msg1.set_sequences(['foo'])
1024 msg2.set_sequences(['foo', 'flagged'])
1025 msg3.set_sequences(['foo', 'bar', 'replied'])
1026 key0 = self._box.add(msg0)
1027 key1 = self._box.add(msg1)
1028 key2 = self._box.add(msg2)
1029 key3 = self._box.add(msg3)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001030 self.assertEqual(self._box.get_sequences(),
1031 {'foo':[key0,key1,key2,key3], 'unseen':[key0],
1032 'flagged':[key2], 'bar':[key3], 'replied':[key3]})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001033 self._box.remove(key2)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001034 self.assertEqual(self._box.get_sequences(),
1035 {'foo':[key0,key1,key3], 'unseen':[key0], 'bar':[key3],
1036 'replied':[key3]})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001037 self._box.pack()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001038 self.assertEqual(self._box.keys(), [1, 2, 3])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001039 key0 = key0
1040 key1 = key0 + 1
1041 key2 = key1 + 1
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001042 self.assertEqual(self._box.get_sequences(),
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001043 {'foo':[1, 2, 3], 'unseen':[1], 'bar':[3], 'replied':[3]})
1044
Andrew M. Kuchling8c456f32006-11-17 13:30:25 +00001045 # Test case for packing while holding the mailbox locked.
1046 key0 = self._box.add(msg1)
1047 key1 = self._box.add(msg1)
1048 key2 = self._box.add(msg1)
1049 key3 = self._box.add(msg1)
1050
1051 self._box.remove(key0)
1052 self._box.remove(key2)
1053 self._box.lock()
1054 self._box.pack()
1055 self._box.unlock()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001056 self.assertEqual(self._box.get_sequences(),
1057 {'foo':[1, 2, 3, 4, 5],
1058 'unseen':[1], 'bar':[3], 'replied':[3]})
Tim Petersf733abb2007-01-30 03:03:46 +00001059
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001060 def _get_lock_path(self):
1061 return os.path.join(self._path, '.mh_sequences.lock')
1062
1063
1064class TestBabyl(TestMailbox):
1065
1066 _factory = lambda self, path, factory=None: mailbox.Babyl(path, factory)
1067
1068 def tearDown(self):
1069 self._box.close()
1070 self._delete_recursively(self._path)
1071 for lock_remnant in glob.glob(self._path + '.*'):
Neal Norwitz6cbd8de2007-03-20 06:53:17 +00001072 test_support.unlink(lock_remnant)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001073
1074 def test_labels(self):
1075 # Get labels from the mailbox
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001076 self.assertEqual(self._box.get_labels(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001077 msg0 = mailbox.BabylMessage(self._template % 0)
1078 msg0.add_label('foo')
1079 key0 = self._box.add(msg0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001080 self.assertEqual(self._box.get_labels(), ['foo'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001081 msg1 = mailbox.BabylMessage(self._template % 1)
1082 msg1.set_labels(['bar', 'answered', 'foo'])
1083 key1 = self._box.add(msg1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001084 self.assertEqual(set(self._box.get_labels()), set(['foo', 'bar']))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001085 msg0.set_labels(['blah', 'filed'])
1086 self._box[key0] = msg0
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001087 self.assertEqual(set(self._box.get_labels()),
1088 set(['foo', 'bar', 'blah']))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001089 self._box.remove(key1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001090 self.assertEqual(set(self._box.get_labels()), set(['blah']))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001091
1092
1093class TestMessage(TestBase):
1094
1095 _factory = mailbox.Message # Overridden by subclasses to reuse tests
1096
1097 def setUp(self):
1098 self._path = test_support.TESTFN
1099
1100 def tearDown(self):
1101 self._delete_recursively(self._path)
1102
1103 def test_initialize_with_eMM(self):
Georg Brandl5a096e12007-01-22 19:40:21 +00001104 # Initialize based on email.message.Message instance
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001105 eMM = email.message_from_string(_sample_message)
1106 msg = self._factory(eMM)
1107 self._post_initialize_hook(msg)
1108 self._check_sample(msg)
1109
1110 def test_initialize_with_string(self):
1111 # Initialize based on string
1112 msg = self._factory(_sample_message)
1113 self._post_initialize_hook(msg)
1114 self._check_sample(msg)
1115
1116 def test_initialize_with_file(self):
1117 # Initialize based on contents of file
Brian Curtin04d8b222010-10-14 01:14:36 +00001118 with open(self._path, 'w+') as f:
1119 f.write(_sample_message)
1120 f.seek(0)
1121 msg = self._factory(f)
1122 self._post_initialize_hook(msg)
1123 self._check_sample(msg)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001124
1125 def test_initialize_with_nothing(self):
1126 # Initialize without arguments
1127 msg = self._factory()
1128 self._post_initialize_hook(msg)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001129 self.assertIsInstance(msg, email.message.Message)
1130 self.assertIsInstance(msg, mailbox.Message)
1131 self.assertIsInstance(msg, self._factory)
1132 self.assertEqual(msg.keys(), [])
1133 self.assertFalse(msg.is_multipart())
1134 self.assertEqual(msg.get_payload(), None)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001135
1136 def test_initialize_incorrectly(self):
1137 # Initialize with invalid argument
1138 self.assertRaises(TypeError, lambda: self._factory(object()))
1139
1140 def test_become_message(self):
1141 # Take on the state of another message
1142 eMM = email.message_from_string(_sample_message)
1143 msg = self._factory()
1144 msg._become_message(eMM)
1145 self._check_sample(msg)
1146
1147 def test_explain_to(self):
1148 # Copy self's format-specific data to other message formats.
1149 # This test is superficial; better ones are in TestMessageConversion.
1150 msg = self._factory()
1151 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1152 mailbox.mboxMessage, mailbox.MHMessage,
1153 mailbox.BabylMessage, mailbox.MMDFMessage):
1154 other_msg = class_()
1155 msg._explain_to(other_msg)
Georg Brandl5a096e12007-01-22 19:40:21 +00001156 other_msg = email.message.Message()
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001157 self.assertRaises(TypeError, lambda: msg._explain_to(other_msg))
1158
1159 def _post_initialize_hook(self, msg):
1160 # Overridden by subclasses to check extra things after initialization
1161 pass
1162
1163
1164class TestMaildirMessage(TestMessage):
1165
1166 _factory = mailbox.MaildirMessage
1167
1168 def _post_initialize_hook(self, msg):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001169 self.assertEqual(msg._subdir, 'new')
1170 self.assertEqual(msg._info,'')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001171
1172 def test_subdir(self):
1173 # Use get_subdir() and set_subdir()
1174 msg = mailbox.MaildirMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001175 self.assertEqual(msg.get_subdir(), 'new')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001176 msg.set_subdir('cur')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001177 self.assertEqual(msg.get_subdir(), 'cur')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001178 msg.set_subdir('new')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001179 self.assertEqual(msg.get_subdir(), 'new')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001180 self.assertRaises(ValueError, lambda: msg.set_subdir('tmp'))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001181 self.assertEqual(msg.get_subdir(), 'new')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001182 msg.set_subdir('new')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001183 self.assertEqual(msg.get_subdir(), 'new')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001184 self._check_sample(msg)
1185
1186 def test_flags(self):
1187 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1188 msg = mailbox.MaildirMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001189 self.assertEqual(msg.get_flags(), '')
1190 self.assertEqual(msg.get_subdir(), 'new')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001191 msg.set_flags('F')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001192 self.assertEqual(msg.get_subdir(), 'new')
1193 self.assertEqual(msg.get_flags(), 'F')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001194 msg.set_flags('SDTP')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001195 self.assertEqual(msg.get_flags(), 'DPST')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001196 msg.add_flag('FT')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001197 self.assertEqual(msg.get_flags(), 'DFPST')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001198 msg.remove_flag('TDRP')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001199 self.assertEqual(msg.get_flags(), 'FS')
1200 self.assertEqual(msg.get_subdir(), 'new')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001201 self._check_sample(msg)
1202
1203 def test_date(self):
1204 # Use get_date() and set_date()
1205 msg = mailbox.MaildirMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001206 diff = msg.get_date() - time.time()
1207 self.assertTrue(abs(diff) < 60, diff)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001208 msg.set_date(0.0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001209 self.assertEqual(msg.get_date(), 0.0)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001210
1211 def test_info(self):
1212 # Use get_info() and set_info()
1213 msg = mailbox.MaildirMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001214 self.assertEqual(msg.get_info(), '')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001215 msg.set_info('1,foo=bar')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001216 self.assertEqual(msg.get_info(), '1,foo=bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001217 self.assertRaises(TypeError, lambda: msg.set_info(None))
1218 self._check_sample(msg)
1219
1220 def test_info_and_flags(self):
1221 # Test interaction of info and flag methods
1222 msg = mailbox.MaildirMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001223 self.assertEqual(msg.get_info(), '')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001224 msg.set_flags('SF')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001225 self.assertEqual(msg.get_flags(), 'FS')
1226 self.assertEqual(msg.get_info(), '2,FS')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001227 msg.set_info('1,')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001228 self.assertEqual(msg.get_flags(), '')
1229 self.assertEqual(msg.get_info(), '1,')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001230 msg.remove_flag('RPT')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001231 self.assertEqual(msg.get_flags(), '')
1232 self.assertEqual(msg.get_info(), '1,')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001233 msg.add_flag('D')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001234 self.assertEqual(msg.get_flags(), 'D')
1235 self.assertEqual(msg.get_info(), '2,D')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001236 self._check_sample(msg)
1237
1238
1239class _TestMboxMMDFMessage(TestMessage):
1240
1241 _factory = mailbox._mboxMMDFMessage
1242
1243 def _post_initialize_hook(self, msg):
1244 self._check_from(msg)
1245
1246 def test_initialize_with_unixfrom(self):
1247 # Initialize with a message that already has a _unixfrom attribute
1248 msg = mailbox.Message(_sample_message)
1249 msg.set_unixfrom('From foo@bar blah')
1250 msg = mailbox.mboxMessage(msg)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001251 self.assertEqual(msg.get_from(), 'foo@bar blah')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001252
1253 def test_from(self):
1254 # Get and set "From " line
1255 msg = mailbox.mboxMessage(_sample_message)
1256 self._check_from(msg)
1257 msg.set_from('foo bar')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001258 self.assertEqual(msg.get_from(), 'foo bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001259 msg.set_from('foo@bar', True)
1260 self._check_from(msg, 'foo@bar')
1261 msg.set_from('blah@temp', time.localtime())
1262 self._check_from(msg, 'blah@temp')
1263
1264 def test_flags(self):
1265 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1266 msg = mailbox.mboxMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001267 self.assertEqual(msg.get_flags(), '')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001268 msg.set_flags('F')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001269 self.assertEqual(msg.get_flags(), 'F')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001270 msg.set_flags('XODR')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001271 self.assertEqual(msg.get_flags(), 'RODX')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001272 msg.add_flag('FA')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001273 self.assertEqual(msg.get_flags(), 'RODFAX')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001274 msg.remove_flag('FDXA')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001275 self.assertEqual(msg.get_flags(), 'RO')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001276 self._check_sample(msg)
1277
1278 def _check_from(self, msg, sender=None):
1279 # Check contents of "From " line
1280 if sender is None:
1281 sender = "MAILER-DAEMON"
Benjamin Peterson5c8da862009-06-30 22:57:08 +00001282 self.assertTrue(re.match(sender + r" \w{3} \w{3} [\d ]\d [\d ]\d:\d{2}:"
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001283 r"\d{2} \d{4}", msg.get_from()))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001284
1285
1286class TestMboxMessage(_TestMboxMMDFMessage):
1287
1288 _factory = mailbox.mboxMessage
1289
1290
1291class TestMHMessage(TestMessage):
1292
1293 _factory = mailbox.MHMessage
1294
1295 def _post_initialize_hook(self, msg):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001296 self.assertEqual(msg._sequences, [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001297
1298 def test_sequences(self):
1299 # Get, set, join, and leave sequences
1300 msg = mailbox.MHMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001301 self.assertEqual(msg.get_sequences(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001302 msg.set_sequences(['foobar'])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001303 self.assertEqual(msg.get_sequences(), ['foobar'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001304 msg.set_sequences([])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001305 self.assertEqual(msg.get_sequences(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001306 msg.add_sequence('unseen')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001307 self.assertEqual(msg.get_sequences(), ['unseen'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001308 msg.add_sequence('flagged')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001309 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001310 msg.add_sequence('flagged')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001311 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001312 msg.remove_sequence('unseen')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001313 self.assertEqual(msg.get_sequences(), ['flagged'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001314 msg.add_sequence('foobar')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001315 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001316 msg.remove_sequence('replied')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001317 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001318 msg.set_sequences(['foobar', 'replied'])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001319 self.assertEqual(msg.get_sequences(), ['foobar', 'replied'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001320
1321
1322class TestBabylMessage(TestMessage):
1323
1324 _factory = mailbox.BabylMessage
1325
1326 def _post_initialize_hook(self, msg):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001327 self.assertEqual(msg._labels, [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001328
1329 def test_labels(self):
1330 # Get, set, join, and leave labels
1331 msg = mailbox.BabylMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001332 self.assertEqual(msg.get_labels(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001333 msg.set_labels(['foobar'])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001334 self.assertEqual(msg.get_labels(), ['foobar'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001335 msg.set_labels([])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001336 self.assertEqual(msg.get_labels(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001337 msg.add_label('filed')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001338 self.assertEqual(msg.get_labels(), ['filed'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001339 msg.add_label('resent')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001340 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001341 msg.add_label('resent')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001342 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001343 msg.remove_label('filed')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001344 self.assertEqual(msg.get_labels(), ['resent'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001345 msg.add_label('foobar')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001346 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001347 msg.remove_label('unseen')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001348 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001349 msg.set_labels(['foobar', 'answered'])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001350 self.assertEqual(msg.get_labels(), ['foobar', 'answered'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001351
1352 def test_visible(self):
1353 # Get, set, and update visible headers
1354 msg = mailbox.BabylMessage(_sample_message)
1355 visible = msg.get_visible()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001356 self.assertEqual(visible.keys(), [])
1357 self.assertIs(visible.get_payload(), None)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001358 visible['User-Agent'] = 'FooBar 1.0'
1359 visible['X-Whatever'] = 'Blah'
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001360 self.assertEqual(msg.get_visible().keys(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001361 msg.set_visible(visible)
1362 visible = msg.get_visible()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001363 self.assertEqual(visible.keys(), ['User-Agent', 'X-Whatever'])
1364 self.assertEqual(visible['User-Agent'], 'FooBar 1.0')
1365 self.assertEqual(visible['X-Whatever'], 'Blah')
1366 self.assertIs(visible.get_payload(), None)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001367 msg.update_visible()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001368 self.assertEqual(visible.keys(), ['User-Agent', 'X-Whatever'])
1369 self.assertIs(visible.get_payload(), None)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001370 visible = msg.get_visible()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001371 self.assertEqual(visible.keys(), ['User-Agent', 'Date', 'From', 'To',
1372 'Subject'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001373 for header in ('User-Agent', 'Date', 'From', 'To', 'Subject'):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001374 self.assertEqual(visible[header], msg[header])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001375
1376
1377class TestMMDFMessage(_TestMboxMMDFMessage):
1378
1379 _factory = mailbox.MMDFMessage
1380
1381
1382class TestMessageConversion(TestBase):
1383
1384 def test_plain_to_x(self):
1385 # Convert Message to all formats
1386 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1387 mailbox.mboxMessage, mailbox.MHMessage,
1388 mailbox.BabylMessage, mailbox.MMDFMessage):
1389 msg_plain = mailbox.Message(_sample_message)
1390 msg = class_(msg_plain)
1391 self._check_sample(msg)
1392
1393 def test_x_to_plain(self):
1394 # Convert all formats to Message
1395 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1396 mailbox.mboxMessage, mailbox.MHMessage,
1397 mailbox.BabylMessage, mailbox.MMDFMessage):
1398 msg = class_(_sample_message)
1399 msg_plain = mailbox.Message(msg)
1400 self._check_sample(msg_plain)
1401
1402 def test_x_to_invalid(self):
1403 # Convert all formats to an invalid format
1404 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1405 mailbox.mboxMessage, mailbox.MHMessage,
1406 mailbox.BabylMessage, mailbox.MMDFMessage):
1407 self.assertRaises(TypeError, lambda: class_(False))
1408
1409 def test_maildir_to_maildir(self):
1410 # Convert MaildirMessage to MaildirMessage
1411 msg_maildir = mailbox.MaildirMessage(_sample_message)
1412 msg_maildir.set_flags('DFPRST')
1413 msg_maildir.set_subdir('cur')
1414 date = msg_maildir.get_date()
1415 msg = mailbox.MaildirMessage(msg_maildir)
1416 self._check_sample(msg)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001417 self.assertEqual(msg.get_flags(), 'DFPRST')
1418 self.assertEqual(msg.get_subdir(), 'cur')
1419 self.assertEqual(msg.get_date(), date)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001420
1421 def test_maildir_to_mboxmmdf(self):
1422 # Convert MaildirMessage to mboxmessage and MMDFMessage
1423 pairs = (('D', ''), ('F', 'F'), ('P', ''), ('R', 'A'), ('S', 'R'),
1424 ('T', 'D'), ('DFPRST', 'RDFA'))
1425 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1426 msg_maildir = mailbox.MaildirMessage(_sample_message)
1427 msg_maildir.set_date(0.0)
1428 for setting, result in pairs:
1429 msg_maildir.set_flags(setting)
1430 msg = class_(msg_maildir)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001431 self.assertEqual(msg.get_flags(), result)
1432 self.assertEqual(msg.get_from(), 'MAILER-DAEMON %s' %
1433 time.asctime(time.gmtime(0.0)))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001434 msg_maildir.set_subdir('cur')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001435 self.assertEqual(class_(msg_maildir).get_flags(), 'RODFA')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001436
1437 def test_maildir_to_mh(self):
1438 # Convert MaildirMessage to MHMessage
1439 msg_maildir = mailbox.MaildirMessage(_sample_message)
1440 pairs = (('D', ['unseen']), ('F', ['unseen', 'flagged']),
1441 ('P', ['unseen']), ('R', ['unseen', 'replied']), ('S', []),
1442 ('T', ['unseen']), ('DFPRST', ['replied', 'flagged']))
1443 for setting, result in pairs:
1444 msg_maildir.set_flags(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001445 self.assertEqual(mailbox.MHMessage(msg_maildir).get_sequences(),
1446 result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001447
1448 def test_maildir_to_babyl(self):
1449 # Convert MaildirMessage to Babyl
1450 msg_maildir = mailbox.MaildirMessage(_sample_message)
1451 pairs = (('D', ['unseen']), ('F', ['unseen']),
1452 ('P', ['unseen', 'forwarded']), ('R', ['unseen', 'answered']),
1453 ('S', []), ('T', ['unseen', 'deleted']),
1454 ('DFPRST', ['deleted', 'answered', 'forwarded']))
1455 for setting, result in pairs:
1456 msg_maildir.set_flags(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001457 self.assertEqual(mailbox.BabylMessage(msg_maildir).get_labels(),
1458 result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001459
1460 def test_mboxmmdf_to_maildir(self):
1461 # Convert mboxMessage and MMDFMessage to MaildirMessage
1462 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1463 msg_mboxMMDF = class_(_sample_message)
1464 msg_mboxMMDF.set_from('foo@bar', time.gmtime(0.0))
1465 pairs = (('R', 'S'), ('O', ''), ('D', 'T'), ('F', 'F'), ('A', 'R'),
1466 ('RODFA', 'FRST'))
1467 for setting, result in pairs:
1468 msg_mboxMMDF.set_flags(setting)
1469 msg = mailbox.MaildirMessage(msg_mboxMMDF)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001470 self.assertEqual(msg.get_flags(), result)
1471 self.assertEqual(msg.get_date(), 0.0)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001472 msg_mboxMMDF.set_flags('O')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001473 self.assertEqual(mailbox.MaildirMessage(msg_mboxMMDF).get_subdir(),
1474 'cur')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001475
1476 def test_mboxmmdf_to_mboxmmdf(self):
1477 # Convert mboxMessage and MMDFMessage to mboxMessage and MMDFMessage
1478 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1479 msg_mboxMMDF = class_(_sample_message)
1480 msg_mboxMMDF.set_flags('RODFA')
1481 msg_mboxMMDF.set_from('foo@bar')
1482 for class2_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1483 msg2 = class2_(msg_mboxMMDF)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001484 self.assertEqual(msg2.get_flags(), 'RODFA')
1485 self.assertEqual(msg2.get_from(), 'foo@bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001486
1487 def test_mboxmmdf_to_mh(self):
1488 # Convert mboxMessage and MMDFMessage to MHMessage
1489 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1490 msg_mboxMMDF = class_(_sample_message)
1491 pairs = (('R', []), ('O', ['unseen']), ('D', ['unseen']),
1492 ('F', ['unseen', 'flagged']),
1493 ('A', ['unseen', 'replied']),
1494 ('RODFA', ['replied', 'flagged']))
1495 for setting, result in pairs:
1496 msg_mboxMMDF.set_flags(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001497 self.assertEqual(mailbox.MHMessage(msg_mboxMMDF).get_sequences(),
1498 result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001499
1500 def test_mboxmmdf_to_babyl(self):
1501 # Convert mboxMessage and MMDFMessage to BabylMessage
1502 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1503 msg = class_(_sample_message)
1504 pairs = (('R', []), ('O', ['unseen']),
1505 ('D', ['unseen', 'deleted']), ('F', ['unseen']),
1506 ('A', ['unseen', 'answered']),
1507 ('RODFA', ['deleted', 'answered']))
1508 for setting, result in pairs:
1509 msg.set_flags(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001510 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001511
1512 def test_mh_to_maildir(self):
1513 # Convert MHMessage to MaildirMessage
1514 pairs = (('unseen', ''), ('replied', 'RS'), ('flagged', 'FS'))
1515 for setting, result in pairs:
1516 msg = mailbox.MHMessage(_sample_message)
1517 msg.add_sequence(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001518 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1519 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001520 msg = mailbox.MHMessage(_sample_message)
1521 msg.add_sequence('unseen')
1522 msg.add_sequence('replied')
1523 msg.add_sequence('flagged')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001524 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'FR')
1525 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001526
1527 def test_mh_to_mboxmmdf(self):
1528 # Convert MHMessage to mboxMessage and MMDFMessage
1529 pairs = (('unseen', 'O'), ('replied', 'ROA'), ('flagged', 'ROF'))
1530 for setting, result in pairs:
1531 msg = mailbox.MHMessage(_sample_message)
1532 msg.add_sequence(setting)
1533 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001534 self.assertEqual(class_(msg).get_flags(), result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001535 msg = mailbox.MHMessage(_sample_message)
1536 msg.add_sequence('unseen')
1537 msg.add_sequence('replied')
1538 msg.add_sequence('flagged')
1539 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001540 self.assertEqual(class_(msg).get_flags(), 'OFA')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001541
1542 def test_mh_to_mh(self):
1543 # Convert MHMessage to MHMessage
1544 msg = mailbox.MHMessage(_sample_message)
1545 msg.add_sequence('unseen')
1546 msg.add_sequence('replied')
1547 msg.add_sequence('flagged')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001548 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1549 ['unseen', 'replied', 'flagged'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001550
1551 def test_mh_to_babyl(self):
1552 # Convert MHMessage to BabylMessage
1553 pairs = (('unseen', ['unseen']), ('replied', ['answered']),
1554 ('flagged', []))
1555 for setting, result in pairs:
1556 msg = mailbox.MHMessage(_sample_message)
1557 msg.add_sequence(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001558 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001559 msg = mailbox.MHMessage(_sample_message)
1560 msg.add_sequence('unseen')
1561 msg.add_sequence('replied')
1562 msg.add_sequence('flagged')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001563 self.assertEqual(mailbox.BabylMessage(msg).get_labels(),
1564 ['unseen', 'answered'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001565
1566 def test_babyl_to_maildir(self):
1567 # Convert BabylMessage to MaildirMessage
1568 pairs = (('unseen', ''), ('deleted', 'ST'), ('filed', 'S'),
1569 ('answered', 'RS'), ('forwarded', 'PS'), ('edited', 'S'),
1570 ('resent', 'PS'))
1571 for setting, result in pairs:
1572 msg = mailbox.BabylMessage(_sample_message)
1573 msg.add_label(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001574 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1575 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001576 msg = mailbox.BabylMessage(_sample_message)
1577 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1578 'edited', 'resent'):
1579 msg.add_label(label)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001580 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'PRT')
1581 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001582
1583 def test_babyl_to_mboxmmdf(self):
1584 # Convert BabylMessage to mboxMessage and MMDFMessage
1585 pairs = (('unseen', 'O'), ('deleted', 'ROD'), ('filed', 'RO'),
1586 ('answered', 'ROA'), ('forwarded', 'RO'), ('edited', 'RO'),
1587 ('resent', 'RO'))
1588 for setting, result in pairs:
1589 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1590 msg = mailbox.BabylMessage(_sample_message)
1591 msg.add_label(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001592 self.assertEqual(class_(msg).get_flags(), result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001593 msg = mailbox.BabylMessage(_sample_message)
1594 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1595 'edited', 'resent'):
1596 msg.add_label(label)
1597 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001598 self.assertEqual(class_(msg).get_flags(), 'ODA')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001599
1600 def test_babyl_to_mh(self):
1601 # Convert BabylMessage to MHMessage
1602 pairs = (('unseen', ['unseen']), ('deleted', []), ('filed', []),
1603 ('answered', ['replied']), ('forwarded', []), ('edited', []),
1604 ('resent', []))
1605 for setting, result in pairs:
1606 msg = mailbox.BabylMessage(_sample_message)
1607 msg.add_label(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001608 self.assertEqual(mailbox.MHMessage(msg).get_sequences(), result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001609 msg = mailbox.BabylMessage(_sample_message)
1610 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1611 'edited', 'resent'):
1612 msg.add_label(label)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001613 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1614 ['unseen', 'replied'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001615
1616 def test_babyl_to_babyl(self):
1617 # Convert BabylMessage to BabylMessage
1618 msg = mailbox.BabylMessage(_sample_message)
1619 msg.update_visible()
1620 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1621 'edited', 'resent'):
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001622 msg.add_label(label)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001623 msg2 = mailbox.BabylMessage(msg)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001624 self.assertEqual(msg2.get_labels(), ['unseen', 'deleted', 'filed',
1625 'answered', 'forwarded', 'edited',
1626 'resent'])
1627 self.assertEqual(msg.get_visible().keys(), msg2.get_visible().keys())
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001628 for key in msg.get_visible().keys():
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001629 self.assertEqual(msg.get_visible()[key], msg2.get_visible()[key])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001630
1631
1632class TestProxyFileBase(TestBase):
1633
1634 def _test_read(self, proxy):
1635 # Read by byte
1636 proxy.seek(0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001637 self.assertEqual(proxy.read(), 'bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001638 proxy.seek(1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001639 self.assertEqual(proxy.read(), 'ar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001640 proxy.seek(0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001641 self.assertEqual(proxy.read(2), 'ba')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001642 proxy.seek(1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001643 self.assertEqual(proxy.read(-1), 'ar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001644 proxy.seek(2)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001645 self.assertEqual(proxy.read(1000), 'r')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001646
1647 def _test_readline(self, proxy):
1648 # Read by line
1649 proxy.seek(0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001650 self.assertEqual(proxy.readline(), 'foo' + os.linesep)
1651 self.assertEqual(proxy.readline(), 'bar' + os.linesep)
1652 self.assertEqual(proxy.readline(), 'fred' + os.linesep)
1653 self.assertEqual(proxy.readline(), 'bob')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001654 proxy.seek(2)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001655 self.assertEqual(proxy.readline(), 'o' + os.linesep)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001656 proxy.seek(6 + 2 * len(os.linesep))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001657 self.assertEqual(proxy.readline(), 'fred' + os.linesep)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001658 proxy.seek(6 + 2 * len(os.linesep))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001659 self.assertEqual(proxy.readline(2), 'fr')
1660 self.assertEqual(proxy.readline(-10), 'ed' + os.linesep)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001661
1662 def _test_readlines(self, proxy):
1663 # Read multiple lines
1664 proxy.seek(0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001665 self.assertEqual(proxy.readlines(), ['foo' + os.linesep,
1666 'bar' + os.linesep,
1667 'fred' + os.linesep, 'bob'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001668 proxy.seek(0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001669 self.assertEqual(proxy.readlines(2), ['foo' + os.linesep])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001670 proxy.seek(3 + len(os.linesep))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001671 self.assertEqual(proxy.readlines(4 + len(os.linesep)),
1672 ['bar' + os.linesep, 'fred' + os.linesep])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001673 proxy.seek(3)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001674 self.assertEqual(proxy.readlines(1000), [os.linesep, 'bar' + os.linesep,
1675 'fred' + os.linesep, 'bob'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001676
1677 def _test_iteration(self, proxy):
1678 # Iterate by line
1679 proxy.seek(0)
1680 iterator = iter(proxy)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001681 self.assertEqual(list(iterator),
1682 ['foo' + os.linesep, 'bar' + os.linesep, 'fred' + os.linesep, 'bob'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001683
1684 def _test_seek_and_tell(self, proxy):
1685 # Seek and use tell to check position
1686 proxy.seek(3)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001687 self.assertEqual(proxy.tell(), 3)
1688 self.assertEqual(proxy.read(len(os.linesep)), os.linesep)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001689 proxy.seek(2, 1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001690 self.assertEqual(proxy.read(1 + len(os.linesep)), 'r' + os.linesep)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001691 proxy.seek(-3 - len(os.linesep), 2)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001692 self.assertEqual(proxy.read(3), 'bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001693 proxy.seek(2, 0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001694 self.assertEqual(proxy.read(), 'o' + os.linesep + 'bar' + os.linesep)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001695 proxy.seek(100)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001696 self.assertEqual(proxy.read(), '')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001697
1698 def _test_close(self, proxy):
1699 # Close a file
1700 proxy.close()
R David Murrayf1138bb2011-06-17 22:23:04 -04001701 # Issue 11700 subsequent closes should be a no-op, not an error.
1702 proxy.close()
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001703
1704
1705class TestProxyFile(TestProxyFileBase):
1706
1707 def setUp(self):
1708 self._path = test_support.TESTFN
Andrew M. Kuchling214db632006-05-02 21:44:33 +00001709 self._file = open(self._path, 'wb+')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001710
1711 def tearDown(self):
1712 self._file.close()
1713 self._delete_recursively(self._path)
1714
1715 def test_initialize(self):
1716 # Initialize and check position
1717 self._file.write('foo')
1718 pos = self._file.tell()
1719 proxy0 = mailbox._ProxyFile(self._file)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001720 self.assertEqual(proxy0.tell(), pos)
1721 self.assertEqual(self._file.tell(), pos)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001722 proxy1 = mailbox._ProxyFile(self._file, 0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001723 self.assertEqual(proxy1.tell(), 0)
1724 self.assertEqual(self._file.tell(), pos)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001725
1726 def test_read(self):
1727 self._file.write('bar')
1728 self._test_read(mailbox._ProxyFile(self._file))
1729
1730 def test_readline(self):
1731 self._file.write('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1732 os.linesep))
1733 self._test_readline(mailbox._ProxyFile(self._file))
1734
1735 def test_readlines(self):
1736 self._file.write('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1737 os.linesep))
1738 self._test_readlines(mailbox._ProxyFile(self._file))
1739
1740 def test_iteration(self):
1741 self._file.write('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1742 os.linesep))
1743 self._test_iteration(mailbox._ProxyFile(self._file))
1744
1745 def test_seek_and_tell(self):
1746 self._file.write('foo%sbar%s' % (os.linesep, os.linesep))
1747 self._test_seek_and_tell(mailbox._ProxyFile(self._file))
1748
1749 def test_close(self):
1750 self._file.write('foo%sbar%s' % (os.linesep, os.linesep))
1751 self._test_close(mailbox._ProxyFile(self._file))
1752
1753
1754class TestPartialFile(TestProxyFileBase):
1755
1756 def setUp(self):
1757 self._path = test_support.TESTFN
Andrew M. Kuchling214db632006-05-02 21:44:33 +00001758 self._file = open(self._path, 'wb+')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001759
1760 def tearDown(self):
1761 self._file.close()
1762 self._delete_recursively(self._path)
1763
1764 def test_initialize(self):
1765 # Initialize and check position
1766 self._file.write('foo' + os.linesep + 'bar')
1767 pos = self._file.tell()
1768 proxy = mailbox._PartialFile(self._file, 2, 5)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001769 self.assertEqual(proxy.tell(), 0)
1770 self.assertEqual(self._file.tell(), pos)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001771
1772 def test_read(self):
1773 self._file.write('***bar***')
1774 self._test_read(mailbox._PartialFile(self._file, 3, 6))
1775
1776 def test_readline(self):
1777 self._file.write('!!!!!foo%sbar%sfred%sbob!!!!!' %
1778 (os.linesep, os.linesep, os.linesep))
1779 self._test_readline(mailbox._PartialFile(self._file, 5,
1780 18 + 3 * len(os.linesep)))
1781
1782 def test_readlines(self):
1783 self._file.write('foo%sbar%sfred%sbob?????' %
1784 (os.linesep, os.linesep, os.linesep))
1785 self._test_readlines(mailbox._PartialFile(self._file, 0,
1786 13 + 3 * len(os.linesep)))
1787
1788 def test_iteration(self):
1789 self._file.write('____foo%sbar%sfred%sbob####' %
1790 (os.linesep, os.linesep, os.linesep))
1791 self._test_iteration(mailbox._PartialFile(self._file, 4,
1792 17 + 3 * len(os.linesep)))
1793
1794 def test_seek_and_tell(self):
1795 self._file.write('(((foo%sbar%s$$$' % (os.linesep, os.linesep))
1796 self._test_seek_and_tell(mailbox._PartialFile(self._file, 3,
1797 9 + 2 * len(os.linesep)))
1798
1799 def test_close(self):
1800 self._file.write('&foo%sbar%s^' % (os.linesep, os.linesep))
1801 self._test_close(mailbox._PartialFile(self._file, 1,
1802 6 + 3 * len(os.linesep)))
1803
1804
1805## Start: tests from the original module (for backward compatibility).
1806
Skip Montanaro5253da12004-07-24 19:56:03 +00001807FROM_ = "From some.body@dummy.domain Sat Jul 24 13:43:35 2004\n"
Fred Drakec02bc3e2001-05-21 20:23:21 +00001808DUMMY_MESSAGE = """\
1809From: some.body@dummy.domain
1810To: me@my.domain
Skip Montanaro5253da12004-07-24 19:56:03 +00001811Subject: Simple Test
Fred Drakec02bc3e2001-05-21 20:23:21 +00001812
1813This is a dummy message.
1814"""
1815
Fred Drakec02bc3e2001-05-21 20:23:21 +00001816class MaildirTestCase(unittest.TestCase):
1817
1818 def setUp(self):
1819 # create a new maildir mailbox to work with:
1820 self._dir = test_support.TESTFN
1821 os.mkdir(self._dir)
1822 os.mkdir(os.path.join(self._dir, "cur"))
1823 os.mkdir(os.path.join(self._dir, "tmp"))
1824 os.mkdir(os.path.join(self._dir, "new"))
1825 self._counter = 1
1826 self._msgfiles = []
1827
1828 def tearDown(self):
1829 map(os.unlink, self._msgfiles)
1830 os.rmdir(os.path.join(self._dir, "cur"))
1831 os.rmdir(os.path.join(self._dir, "tmp"))
1832 os.rmdir(os.path.join(self._dir, "new"))
1833 os.rmdir(self._dir)
1834
Skip Montanaro5253da12004-07-24 19:56:03 +00001835 def createMessage(self, dir, mbox=False):
Jack Jansen97df7b62001-06-19 20:20:05 +00001836 t = int(time.time() % 1000000)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001837 pid = self._counter
1838 self._counter += 1
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001839 filename = os.extsep.join((str(t), str(pid), "myhostname", "mydomain"))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001840 tmpname = os.path.join(self._dir, "tmp", filename)
1841 newname = os.path.join(self._dir, dir, filename)
Brian Curtin04d8b222010-10-14 01:14:36 +00001842 with open(tmpname, "w") as fp:
1843 self._msgfiles.append(tmpname)
1844 if mbox:
1845 fp.write(FROM_)
1846 fp.write(DUMMY_MESSAGE)
Tim Peters6626c1f2001-05-22 16:29:01 +00001847 if hasattr(os, "link"):
1848 os.link(tmpname, newname)
1849 else:
Brian Curtin04d8b222010-10-14 01:14:36 +00001850 with open(newname, "w") as fp:
1851 fp.write(DUMMY_MESSAGE)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001852 self._msgfiles.append(newname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001853 return tmpname
Fred Drakec02bc3e2001-05-21 20:23:21 +00001854
1855 def test_empty_maildir(self):
1856 """Test an empty maildir mailbox"""
1857 # Test for regression on bug #117490:
1858 # Make sure the boxes attribute actually gets set.
1859 self.mbox = mailbox.Maildir(test_support.TESTFN)
Benjamin Peterson5c8da862009-06-30 22:57:08 +00001860 #self.assertTrue(hasattr(self.mbox, "boxes"))
1861 #self.assertTrue(len(self.mbox.boxes) == 0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001862 self.assertIs(self.mbox.next(), None)
1863 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001864
1865 def test_nonempty_maildir_cur(self):
1866 self.createMessage("cur")
1867 self.mbox = mailbox.Maildir(test_support.TESTFN)
Benjamin Peterson5c8da862009-06-30 22:57:08 +00001868 #self.assertTrue(len(self.mbox.boxes) == 1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001869 self.assertIsNot(self.mbox.next(), None)
1870 self.assertIs(self.mbox.next(), None)
1871 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001872
1873 def test_nonempty_maildir_new(self):
1874 self.createMessage("new")
1875 self.mbox = mailbox.Maildir(test_support.TESTFN)
Benjamin Peterson5c8da862009-06-30 22:57:08 +00001876 #self.assertTrue(len(self.mbox.boxes) == 1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001877 self.assertIsNot(self.mbox.next(), None)
1878 self.assertIs(self.mbox.next(), None)
1879 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001880
1881 def test_nonempty_maildir_both(self):
1882 self.createMessage("cur")
1883 self.createMessage("new")
1884 self.mbox = mailbox.Maildir(test_support.TESTFN)
Benjamin Peterson5c8da862009-06-30 22:57:08 +00001885 #self.assertTrue(len(self.mbox.boxes) == 2)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001886 self.assertIsNot(self.mbox.next(), None)
1887 self.assertIsNot(self.mbox.next(), None)
1888 self.assertIs(self.mbox.next(), None)
1889 self.assertIs(self.mbox.next(), None)
Fred Drake0aaed272000-10-23 13:39:15 +00001890
Skip Montanaro5253da12004-07-24 19:56:03 +00001891 def test_unix_mbox(self):
1892 ### should be better!
Georg Brandl5a096e12007-01-22 19:40:21 +00001893 import email.parser
Skip Montanaro5253da12004-07-24 19:56:03 +00001894 fname = self.createMessage("cur", True)
1895 n = 0
1896 for msg in mailbox.PortableUnixMailbox(open(fname),
Georg Brandl5a096e12007-01-22 19:40:21 +00001897 email.parser.Parser().parse):
Skip Montanaro5253da12004-07-24 19:56:03 +00001898 n += 1
1899 self.assertEqual(msg["subject"], "Simple Test")
1900 self.assertEqual(len(str(msg)), len(FROM_)+len(DUMMY_MESSAGE))
1901 self.assertEqual(n, 1)
1902
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001903## End: classes from the original module (for backward compatibility).
1904
1905
1906_sample_message = """\
1907Return-Path: <gkj@gregorykjohnson.com>
1908X-Original-To: gkj+person@localhost
1909Delivered-To: gkj+person@localhost
1910Received: from localhost (localhost [127.0.0.1])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001911 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1912 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001913Delivered-To: gkj@sundance.gregorykjohnson.com
1914Received: from localhost [127.0.0.1]
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001915 by localhost with POP3 (fetchmail-6.2.5)
1916 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001917Received: from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001918 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1919 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001920Received: by andy.gregorykjohnson.com (Postfix, from userid 1000)
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001921 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001922Date: Wed, 13 Jul 2005 17:23:11 -0400
1923From: "Gregory K. Johnson" <gkj@gregorykjohnson.com>
1924To: gkj@gregorykjohnson.com
1925Subject: Sample message
1926Message-ID: <20050713212311.GC4701@andy.gregorykjohnson.com>
1927Mime-Version: 1.0
1928Content-Type: multipart/mixed; boundary="NMuMz9nt05w80d4+"
1929Content-Disposition: inline
1930User-Agent: Mutt/1.5.9i
1931
1932
1933--NMuMz9nt05w80d4+
1934Content-Type: text/plain; charset=us-ascii
1935Content-Disposition: inline
1936
1937This is a sample message.
1938
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001939--
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001940Gregory K. Johnson
1941
1942--NMuMz9nt05w80d4+
1943Content-Type: application/octet-stream
1944Content-Disposition: attachment; filename="text.gz"
1945Content-Transfer-Encoding: base64
1946
1947H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
19483FYlAAAA
1949
1950--NMuMz9nt05w80d4+--
1951"""
1952
1953_sample_headers = {
1954 "Return-Path":"<gkj@gregorykjohnson.com>",
1955 "X-Original-To":"gkj+person@localhost",
1956 "Delivered-To":"gkj+person@localhost",
1957 "Received":"""from localhost (localhost [127.0.0.1])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001958 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1959 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001960 "Delivered-To":"gkj@sundance.gregorykjohnson.com",
1961 "Received":"""from localhost [127.0.0.1]
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001962 by localhost with POP3 (fetchmail-6.2.5)
1963 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001964 "Received":"""from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001965 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1966 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001967 "Received":"""by andy.gregorykjohnson.com (Postfix, from userid 1000)
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001968 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001969 "Date":"Wed, 13 Jul 2005 17:23:11 -0400",
1970 "From":""""Gregory K. Johnson" <gkj@gregorykjohnson.com>""",
1971 "To":"gkj@gregorykjohnson.com",
1972 "Subject":"Sample message",
1973 "Mime-Version":"1.0",
1974 "Content-Type":"""multipart/mixed; boundary="NMuMz9nt05w80d4+\"""",
1975 "Content-Disposition":"inline",
1976 "User-Agent": "Mutt/1.5.9i" }
1977
1978_sample_payloads = ("""This is a sample message.
1979
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001980--
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001981Gregory K. Johnson
1982""",
1983"""H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
19843FYlAAAA
1985""")
Fred Drake0aaed272000-10-23 13:39:15 +00001986
Fred Drakec02bc3e2001-05-21 20:23:21 +00001987
Fred Drake2e2be372001-09-20 21:33:42 +00001988def test_main():
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001989 tests = (TestMailboxSuperclass, TestMaildir, TestMbox, TestMMDF, TestMH,
1990 TestBabyl, TestMessage, TestMaildirMessage, TestMboxMessage,
1991 TestMHMessage, TestBabylMessage, TestMMDFMessage,
1992 TestMessageConversion, TestProxyFile, TestPartialFile,
1993 MaildirTestCase)
1994 test_support.run_unittest(*tests)
Neal Norwitzb15ac312006-06-29 04:10:08 +00001995 test_support.reap_children()
Fred Drake2e2be372001-09-20 21:33:42 +00001996
1997
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001998if __name__ == '__main__':
Fred Drake2e2be372001-09-20 21:33:42 +00001999 test_main()