blob: 112497993c6512af89d17e71eb8b29f02b0b772b [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
686 def test_lookup(self):
687 # Look up message subpaths in the TOC
688 self.assertRaises(KeyError, lambda: self._box._lookup('foo'))
689 key0 = self._box.add(self._template % 0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000690 self.assertEqual(self._box._lookup(key0), os.path.join('new', key0))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000691 os.remove(os.path.join(self._path, 'new', key0))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000692 self.assertEqual(self._box._toc, {key0: os.path.join('new', key0)})
Antoine Pitroue4c6b162009-11-01 21:29:33 +0000693 # Be sure that the TOC is read back from disk (see issue #6896
694 # about bad mtime behaviour on some systems).
695 self._box.flush()
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000696 self.assertRaises(KeyError, lambda: self._box._lookup(key0))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000697 self.assertEqual(self._box._toc, {})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000698
699 def test_lock_unlock(self):
700 # Lock and unlock the mailbox. For Maildir, this does nothing.
701 self._box.lock()
702 self._box.unlock()
703
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000704 def test_folder (self):
705 # Test for bug #1569790: verify that folders returned by .get_folder()
706 # use the same factory function.
707 def dummy_factory (s):
708 return None
709 box = self._factory(self._path, factory=dummy_factory)
710 folder = box.add_folder('folder1')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000711 self.assertIs(folder._factory, dummy_factory)
Tim Petersf733abb2007-01-30 03:03:46 +0000712
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000713 folder1_alias = box.get_folder('folder1')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000714 self.assertIs(folder1_alias._factory, dummy_factory)
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000715
Andrew M. Kuchling2b09ef02007-07-14 21:56:19 +0000716 def test_directory_in_folder (self):
717 # Test that mailboxes still work if there's a stray extra directory
718 # in a folder.
719 for i in range(10):
720 self._box.add(mailbox.Message(_sample_message))
Tim Petersf733abb2007-01-30 03:03:46 +0000721
Andrew M. Kuchling2b09ef02007-07-14 21:56:19 +0000722 # Create a stray directory
723 os.mkdir(os.path.join(self._path, 'cur', 'stray-dir'))
724
725 # Check that looping still works with the directory present.
726 for msg in self._box:
727 pass
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000728
Andrew M. Kuchling10288e12008-08-05 01:00:57 +0000729 def test_file_permissions(self):
730 # Verify that message files are created without execute permissions
731 if not hasattr(os, "stat") or not hasattr(os, "umask"):
732 return
733 msg = mailbox.MaildirMessage(self._template % 0)
734 orig_umask = os.umask(0)
735 try:
736 key = self._box.add(msg)
737 finally:
738 os.umask(orig_umask)
739 path = os.path.join(self._path, self._box._lookup(key))
740 mode = os.stat(path).st_mode
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000741 self.assertEqual(mode & 0111, 0)
Andrew M. Kuchling10288e12008-08-05 01:00:57 +0000742
743 def test_folder_file_perms(self):
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000744 # From bug #3228, we want to verify that the file created inside a Maildir
745 # subfolder isn't marked as executable.
Andrew M. Kuchling10288e12008-08-05 01:00:57 +0000746 if not hasattr(os, "stat") or not hasattr(os, "umask"):
747 return
748
749 orig_umask = os.umask(0)
750 try:
751 subfolder = self._box.add_folder('subfolder')
752 finally:
753 os.umask(orig_umask)
754
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000755 path = os.path.join(subfolder._path, 'maildirfolder')
756 st = os.stat(path)
757 perms = st.st_mode
758 self.assertFalse((perms & 0111)) # Execute bits should all be off.
759
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000760 def test_reread(self):
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000761
R David Murray8b26c4b2011-05-06 21:56:22 -0400762 # Put the last modified times more than two seconds into the past
763 # (because mtime may have only a two second granularity).
764 for subdir in ('cur', 'new'):
765 os.utime(os.path.join(self._box._path, subdir),
766 (time.time()-5,)*2)
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000767
R David Murray8b26c4b2011-05-06 21:56:22 -0400768 # Because mtime has a two second granularity in worst case (FAT), a
769 # refresh is done unconditionally if called for within
770 # two-second-plus-a-bit of the last one, just in case the mbox has
771 # changed; so now we have to wait for that interval to expire.
772 time.sleep(2.01 + self._box._skewfactor)
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000773
R David Murray8b26c4b2011-05-06 21:56:22 -0400774 # Re-reading causes the ._toc attribute to be assigned a new dictionary
775 # object, so we'll check that the ._toc attribute isn't a different
776 # object.
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000777 orig_toc = self._box._toc
778 def refreshed():
779 return self._box._toc is not orig_toc
780
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000781 self._box._refresh()
R David Murray8b26c4b2011-05-06 21:56:22 -0400782 self.assertFalse(refreshed())
Andrew M. Kuchling420d4eb2009-05-02 19:17:28 +0000783
784 # Now, write something into cur and remove it. This changes
785 # the mtime and should cause a re-read.
786 filename = os.path.join(self._path, 'cur', 'stray-file')
787 f = open(filename, 'w')
788 f.close()
789 os.unlink(filename)
790 self._box._refresh()
R David Murray8b26c4b2011-05-06 21:56:22 -0400791 self.assertTrue(refreshed())
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000792
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000793class _TestMboxMMDF(TestMailbox):
794
795 def tearDown(self):
796 self._box.close()
797 self._delete_recursively(self._path)
798 for lock_remnant in glob.glob(self._path + '.*'):
Neal Norwitz6cbd8de2007-03-20 06:53:17 +0000799 test_support.unlink(lock_remnant)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000800
801 def test_add_from_string(self):
802 # Add a string starting with 'From ' to the mailbox
803 key = self._box.add('From foo@bar blah\nFrom: foo\n\n0')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000804 self.assertEqual(self._box[key].get_from(), 'foo@bar blah')
805 self.assertEqual(self._box[key].get_payload(), '0')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000806
807 def test_add_mbox_or_mmdf_message(self):
808 # Add an mboxMessage or MMDFMessage
809 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
810 msg = class_('From foo@bar blah\nFrom: foo\n\n0')
811 key = self._box.add(msg)
812
813 def test_open_close_open(self):
814 # Open and inspect previously-created mailbox
815 values = [self._template % i for i in xrange(3)]
816 for value in values:
817 self._box.add(value)
818 self._box.close()
819 mtime = os.path.getmtime(self._path)
820 self._box = self._factory(self._path)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000821 self.assertEqual(len(self._box), 3)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000822 for key in self._box.iterkeys():
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000823 self.assertIn(self._box.get_string(key), values)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000824 self._box.close()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000825 self.assertEqual(mtime, os.path.getmtime(self._path))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000826
827 def test_add_and_close(self):
828 # Verifying that closing a mailbox doesn't change added items
829 self._box.add(_sample_message)
830 for i in xrange(3):
831 self._box.add(self._template % i)
832 self._box.add(_sample_message)
833 self._box._file.flush()
834 self._box._file.seek(0)
835 contents = self._box._file.read()
836 self._box.close()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000837 with open(self._path, 'rb') as f:
838 self.assertEqual(contents, f.read())
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000839 self._box = self._factory(self._path)
840
Andrew M. Kuchling9afbace2006-06-26 13:23:10 +0000841 def test_lock_conflict(self):
842 # Fork off a subprocess that will lock the file for 2 seconds,
843 # unlock it, and then exit.
Andrew M. Kuchlingec3c3682006-06-26 14:33:24 +0000844 if not hasattr(os, 'fork'):
845 return
Andrew M. Kuchling9afbace2006-06-26 13:23:10 +0000846 pid = os.fork()
847 if pid == 0:
848 # In the child, lock the mailbox.
849 self._box.lock()
850 time.sleep(2)
851 self._box.unlock()
852 os._exit(0)
853
854 # In the parent, sleep a bit to give the child time to acquire
855 # the lock.
856 time.sleep(0.5)
Neal Norwitz003c9e22006-08-11 06:09:41 +0000857 try:
858 self.assertRaises(mailbox.ExternalClashError,
859 self._box.lock)
860 finally:
861 # Wait for child to exit. Locking should now succeed.
862 exited_pid, status = os.waitpid(pid, 0)
Tim Peters3249d002006-06-27 11:52:49 +0000863
Andrew M. Kuchling9afbace2006-06-26 13:23:10 +0000864 self._box.lock()
865 self._box.unlock()
Tim Peters3249d002006-06-27 11:52:49 +0000866
Andrew M. Kuchling0f871832006-10-27 16:55:34 +0000867 def test_relock(self):
868 # Test case for bug #1575506: the mailbox class was locking the
869 # wrong file object in its flush() method.
870 msg = "Subject: sub\n\nbody\n"
871 key1 = self._box.add(msg)
872 self._box.flush()
873 self._box.close()
Tim Petersabd8a332006-11-03 02:32:46 +0000874
Andrew M. Kuchling0f871832006-10-27 16:55:34 +0000875 self._box = self._factory(self._path)
876 self._box.lock()
877 key2 = self._box.add(msg)
878 self._box.flush()
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000879 self.assertTrue(self._box._locked)
Andrew M. Kuchling0f871832006-10-27 16:55:34 +0000880 self._box.close()
Tim Petersabd8a332006-11-03 02:32:46 +0000881
882
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000883class TestMbox(_TestMboxMMDF):
884
885 _factory = lambda self, path, factory=None: mailbox.mbox(path, factory)
886
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000887 def test_file_perms(self):
888 # From bug #3228, we want to verify that the mailbox file isn't executable,
889 # even if the umask is set to something that would leave executable bits set.
890 # We only run this test on platforms that support umask.
Andrew M. Kuchling10288e12008-08-05 01:00:57 +0000891 if hasattr(os, 'umask') and hasattr(os, 'stat'):
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000892 try:
893 old_umask = os.umask(0077)
894 self._box.close()
895 os.unlink(self._path)
896 self._box = mailbox.mbox(self._path, create=True)
897 self._box.add('')
898 self._box.close()
Andrew M. Kuchling70a6dbd2008-08-04 01:43:43 +0000899 finally:
900 os.umask(old_umask)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000901
Andrew M. Kuchling10288e12008-08-05 01:00:57 +0000902 st = os.stat(self._path)
903 perms = st.st_mode
904 self.assertFalse((perms & 0111)) # Execute bits should all be off.
905
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000906class TestMMDF(_TestMboxMMDF):
907
908 _factory = lambda self, path, factory=None: mailbox.MMDF(path, factory)
909
910
911class TestMH(TestMailbox):
912
913 _factory = lambda self, path, factory=None: mailbox.MH(path, factory)
914
915 def test_list_folders(self):
916 # List folders
917 self._box.add_folder('one')
918 self._box.add_folder('two')
919 self._box.add_folder('three')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000920 self.assertEqual(len(self._box.list_folders()), 3)
921 self.assertEqual(set(self._box.list_folders()),
922 set(('one', 'two', 'three')))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000923
924 def test_get_folder(self):
925 # Open folders
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000926 def dummy_factory (s):
927 return None
928 self._box = self._factory(self._path, dummy_factory)
Tim Petersf733abb2007-01-30 03:03:46 +0000929
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000930 new_folder = self._box.add_folder('foo.bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000931 folder0 = self._box.get_folder('foo.bar')
932 folder0.add(self._template % 'bar')
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000933 self.assertTrue(os.path.isdir(os.path.join(self._path, 'foo.bar')))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000934 folder1 = self._box.get_folder('foo.bar')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000935 self.assertEqual(folder1.get_string(folder1.keys()[0]),
936 self._template % 'bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000937
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000938 # Test for bug #1569790: verify that folders returned by .get_folder()
939 # use the same factory function.
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000940 self.assertIs(new_folder._factory, self._box._factory)
941 self.assertIs(folder0._factory, self._box._factory)
Andrew M. Kuchlinga3e5d372006-11-09 13:27:07 +0000942
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000943 def test_add_and_remove_folders(self):
944 # Delete folders
945 self._box.add_folder('one')
946 self._box.add_folder('two')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000947 self.assertEqual(len(self._box.list_folders()), 2)
948 self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000949 self._box.remove_folder('one')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000950 self.assertEqual(len(self._box.list_folders()), 1)
951 self.assertEqual(set(self._box.list_folders()), set(('two', )))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000952 self._box.add_folder('three')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000953 self.assertEqual(len(self._box.list_folders()), 2)
954 self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000955 self._box.remove_folder('three')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000956 self.assertEqual(len(self._box.list_folders()), 1)
957 self.assertEqual(set(self._box.list_folders()), set(('two', )))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000958 self._box.remove_folder('two')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000959 self.assertEqual(len(self._box.list_folders()), 0)
960 self.assertEqual(self._box.list_folders(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000961
962 def test_sequences(self):
963 # Get and set sequences
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000964 self.assertEqual(self._box.get_sequences(), {})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000965 msg0 = mailbox.MHMessage(self._template % 0)
966 msg0.add_sequence('foo')
967 key0 = self._box.add(msg0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000968 self.assertEqual(self._box.get_sequences(), {'foo':[key0]})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000969 msg1 = mailbox.MHMessage(self._template % 1)
970 msg1.set_sequences(['bar', 'replied', 'foo'])
971 key1 = self._box.add(msg1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000972 self.assertEqual(self._box.get_sequences(),
973 {'foo':[key0, key1], 'bar':[key1], 'replied':[key1]})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000974 msg0.set_sequences(['flagged'])
975 self._box[key0] = msg0
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000976 self.assertEqual(self._box.get_sequences(),
977 {'foo':[key1], 'bar':[key1], 'replied':[key1],
978 'flagged':[key0]})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000979 self._box.remove(key1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +0000980 self.assertEqual(self._box.get_sequences(), {'flagged':[key0]})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000981
R. David Murray52720c52009-04-02 14:05:35 +0000982 def test_issue2625(self):
983 msg0 = mailbox.MHMessage(self._template % 0)
984 msg0.add_sequence('foo')
985 key0 = self._box.add(msg0)
986 refmsg0 = self._box.get_message(key0)
987
Andrew M. Kuchlingb72b0eb2010-02-22 18:42:07 +0000988 def test_issue7627(self):
989 msg0 = mailbox.MHMessage(self._template % 0)
990 key0 = self._box.add(msg0)
991 self._box.lock()
992 self._box.remove(key0)
993 self._box.unlock()
994
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +0000995 def test_pack(self):
996 # Pack the contents of the mailbox
997 msg0 = mailbox.MHMessage(self._template % 0)
998 msg1 = mailbox.MHMessage(self._template % 1)
999 msg2 = mailbox.MHMessage(self._template % 2)
1000 msg3 = mailbox.MHMessage(self._template % 3)
1001 msg0.set_sequences(['foo', 'unseen'])
1002 msg1.set_sequences(['foo'])
1003 msg2.set_sequences(['foo', 'flagged'])
1004 msg3.set_sequences(['foo', 'bar', 'replied'])
1005 key0 = self._box.add(msg0)
1006 key1 = self._box.add(msg1)
1007 key2 = self._box.add(msg2)
1008 key3 = self._box.add(msg3)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001009 self.assertEqual(self._box.get_sequences(),
1010 {'foo':[key0,key1,key2,key3], 'unseen':[key0],
1011 'flagged':[key2], 'bar':[key3], 'replied':[key3]})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001012 self._box.remove(key2)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001013 self.assertEqual(self._box.get_sequences(),
1014 {'foo':[key0,key1,key3], 'unseen':[key0], 'bar':[key3],
1015 'replied':[key3]})
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001016 self._box.pack()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001017 self.assertEqual(self._box.keys(), [1, 2, 3])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001018 key0 = key0
1019 key1 = key0 + 1
1020 key2 = key1 + 1
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001021 self.assertEqual(self._box.get_sequences(),
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001022 {'foo':[1, 2, 3], 'unseen':[1], 'bar':[3], 'replied':[3]})
1023
Andrew M. Kuchling8c456f32006-11-17 13:30:25 +00001024 # Test case for packing while holding the mailbox locked.
1025 key0 = self._box.add(msg1)
1026 key1 = self._box.add(msg1)
1027 key2 = self._box.add(msg1)
1028 key3 = self._box.add(msg1)
1029
1030 self._box.remove(key0)
1031 self._box.remove(key2)
1032 self._box.lock()
1033 self._box.pack()
1034 self._box.unlock()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001035 self.assertEqual(self._box.get_sequences(),
1036 {'foo':[1, 2, 3, 4, 5],
1037 'unseen':[1], 'bar':[3], 'replied':[3]})
Tim Petersf733abb2007-01-30 03:03:46 +00001038
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001039 def _get_lock_path(self):
1040 return os.path.join(self._path, '.mh_sequences.lock')
1041
1042
1043class TestBabyl(TestMailbox):
1044
1045 _factory = lambda self, path, factory=None: mailbox.Babyl(path, factory)
1046
1047 def tearDown(self):
1048 self._box.close()
1049 self._delete_recursively(self._path)
1050 for lock_remnant in glob.glob(self._path + '.*'):
Neal Norwitz6cbd8de2007-03-20 06:53:17 +00001051 test_support.unlink(lock_remnant)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001052
1053 def test_labels(self):
1054 # Get labels from the mailbox
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001055 self.assertEqual(self._box.get_labels(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001056 msg0 = mailbox.BabylMessage(self._template % 0)
1057 msg0.add_label('foo')
1058 key0 = self._box.add(msg0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001059 self.assertEqual(self._box.get_labels(), ['foo'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001060 msg1 = mailbox.BabylMessage(self._template % 1)
1061 msg1.set_labels(['bar', 'answered', 'foo'])
1062 key1 = self._box.add(msg1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001063 self.assertEqual(set(self._box.get_labels()), set(['foo', 'bar']))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001064 msg0.set_labels(['blah', 'filed'])
1065 self._box[key0] = msg0
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001066 self.assertEqual(set(self._box.get_labels()),
1067 set(['foo', 'bar', 'blah']))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001068 self._box.remove(key1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001069 self.assertEqual(set(self._box.get_labels()), set(['blah']))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001070
1071
1072class TestMessage(TestBase):
1073
1074 _factory = mailbox.Message # Overridden by subclasses to reuse tests
1075
1076 def setUp(self):
1077 self._path = test_support.TESTFN
1078
1079 def tearDown(self):
1080 self._delete_recursively(self._path)
1081
1082 def test_initialize_with_eMM(self):
Georg Brandl5a096e12007-01-22 19:40:21 +00001083 # Initialize based on email.message.Message instance
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001084 eMM = email.message_from_string(_sample_message)
1085 msg = self._factory(eMM)
1086 self._post_initialize_hook(msg)
1087 self._check_sample(msg)
1088
1089 def test_initialize_with_string(self):
1090 # Initialize based on string
1091 msg = self._factory(_sample_message)
1092 self._post_initialize_hook(msg)
1093 self._check_sample(msg)
1094
1095 def test_initialize_with_file(self):
1096 # Initialize based on contents of file
Brian Curtin04d8b222010-10-14 01:14:36 +00001097 with open(self._path, 'w+') as f:
1098 f.write(_sample_message)
1099 f.seek(0)
1100 msg = self._factory(f)
1101 self._post_initialize_hook(msg)
1102 self._check_sample(msg)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001103
1104 def test_initialize_with_nothing(self):
1105 # Initialize without arguments
1106 msg = self._factory()
1107 self._post_initialize_hook(msg)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001108 self.assertIsInstance(msg, email.message.Message)
1109 self.assertIsInstance(msg, mailbox.Message)
1110 self.assertIsInstance(msg, self._factory)
1111 self.assertEqual(msg.keys(), [])
1112 self.assertFalse(msg.is_multipart())
1113 self.assertEqual(msg.get_payload(), None)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001114
1115 def test_initialize_incorrectly(self):
1116 # Initialize with invalid argument
1117 self.assertRaises(TypeError, lambda: self._factory(object()))
1118
1119 def test_become_message(self):
1120 # Take on the state of another message
1121 eMM = email.message_from_string(_sample_message)
1122 msg = self._factory()
1123 msg._become_message(eMM)
1124 self._check_sample(msg)
1125
1126 def test_explain_to(self):
1127 # Copy self's format-specific data to other message formats.
1128 # This test is superficial; better ones are in TestMessageConversion.
1129 msg = self._factory()
1130 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1131 mailbox.mboxMessage, mailbox.MHMessage,
1132 mailbox.BabylMessage, mailbox.MMDFMessage):
1133 other_msg = class_()
1134 msg._explain_to(other_msg)
Georg Brandl5a096e12007-01-22 19:40:21 +00001135 other_msg = email.message.Message()
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001136 self.assertRaises(TypeError, lambda: msg._explain_to(other_msg))
1137
1138 def _post_initialize_hook(self, msg):
1139 # Overridden by subclasses to check extra things after initialization
1140 pass
1141
1142
1143class TestMaildirMessage(TestMessage):
1144
1145 _factory = mailbox.MaildirMessage
1146
1147 def _post_initialize_hook(self, msg):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001148 self.assertEqual(msg._subdir, 'new')
1149 self.assertEqual(msg._info,'')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001150
1151 def test_subdir(self):
1152 # Use get_subdir() and set_subdir()
1153 msg = mailbox.MaildirMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001154 self.assertEqual(msg.get_subdir(), 'new')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001155 msg.set_subdir('cur')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001156 self.assertEqual(msg.get_subdir(), 'cur')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001157 msg.set_subdir('new')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001158 self.assertEqual(msg.get_subdir(), 'new')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001159 self.assertRaises(ValueError, lambda: msg.set_subdir('tmp'))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001160 self.assertEqual(msg.get_subdir(), 'new')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001161 msg.set_subdir('new')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001162 self.assertEqual(msg.get_subdir(), 'new')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001163 self._check_sample(msg)
1164
1165 def test_flags(self):
1166 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1167 msg = mailbox.MaildirMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001168 self.assertEqual(msg.get_flags(), '')
1169 self.assertEqual(msg.get_subdir(), 'new')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001170 msg.set_flags('F')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001171 self.assertEqual(msg.get_subdir(), 'new')
1172 self.assertEqual(msg.get_flags(), 'F')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001173 msg.set_flags('SDTP')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001174 self.assertEqual(msg.get_flags(), 'DPST')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001175 msg.add_flag('FT')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001176 self.assertEqual(msg.get_flags(), 'DFPST')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001177 msg.remove_flag('TDRP')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001178 self.assertEqual(msg.get_flags(), 'FS')
1179 self.assertEqual(msg.get_subdir(), 'new')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001180 self._check_sample(msg)
1181
1182 def test_date(self):
1183 # Use get_date() and set_date()
1184 msg = mailbox.MaildirMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001185 diff = msg.get_date() - time.time()
1186 self.assertTrue(abs(diff) < 60, diff)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001187 msg.set_date(0.0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001188 self.assertEqual(msg.get_date(), 0.0)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001189
1190 def test_info(self):
1191 # Use get_info() and set_info()
1192 msg = mailbox.MaildirMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001193 self.assertEqual(msg.get_info(), '')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001194 msg.set_info('1,foo=bar')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001195 self.assertEqual(msg.get_info(), '1,foo=bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001196 self.assertRaises(TypeError, lambda: msg.set_info(None))
1197 self._check_sample(msg)
1198
1199 def test_info_and_flags(self):
1200 # Test interaction of info and flag methods
1201 msg = mailbox.MaildirMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001202 self.assertEqual(msg.get_info(), '')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001203 msg.set_flags('SF')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001204 self.assertEqual(msg.get_flags(), 'FS')
1205 self.assertEqual(msg.get_info(), '2,FS')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001206 msg.set_info('1,')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001207 self.assertEqual(msg.get_flags(), '')
1208 self.assertEqual(msg.get_info(), '1,')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001209 msg.remove_flag('RPT')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001210 self.assertEqual(msg.get_flags(), '')
1211 self.assertEqual(msg.get_info(), '1,')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001212 msg.add_flag('D')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001213 self.assertEqual(msg.get_flags(), 'D')
1214 self.assertEqual(msg.get_info(), '2,D')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001215 self._check_sample(msg)
1216
1217
1218class _TestMboxMMDFMessage(TestMessage):
1219
1220 _factory = mailbox._mboxMMDFMessage
1221
1222 def _post_initialize_hook(self, msg):
1223 self._check_from(msg)
1224
1225 def test_initialize_with_unixfrom(self):
1226 # Initialize with a message that already has a _unixfrom attribute
1227 msg = mailbox.Message(_sample_message)
1228 msg.set_unixfrom('From foo@bar blah')
1229 msg = mailbox.mboxMessage(msg)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001230 self.assertEqual(msg.get_from(), 'foo@bar blah')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001231
1232 def test_from(self):
1233 # Get and set "From " line
1234 msg = mailbox.mboxMessage(_sample_message)
1235 self._check_from(msg)
1236 msg.set_from('foo bar')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001237 self.assertEqual(msg.get_from(), 'foo bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001238 msg.set_from('foo@bar', True)
1239 self._check_from(msg, 'foo@bar')
1240 msg.set_from('blah@temp', time.localtime())
1241 self._check_from(msg, 'blah@temp')
1242
1243 def test_flags(self):
1244 # Use get_flags(), set_flags(), add_flag(), remove_flag()
1245 msg = mailbox.mboxMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001246 self.assertEqual(msg.get_flags(), '')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001247 msg.set_flags('F')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001248 self.assertEqual(msg.get_flags(), 'F')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001249 msg.set_flags('XODR')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001250 self.assertEqual(msg.get_flags(), 'RODX')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001251 msg.add_flag('FA')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001252 self.assertEqual(msg.get_flags(), 'RODFAX')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001253 msg.remove_flag('FDXA')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001254 self.assertEqual(msg.get_flags(), 'RO')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001255 self._check_sample(msg)
1256
1257 def _check_from(self, msg, sender=None):
1258 # Check contents of "From " line
1259 if sender is None:
1260 sender = "MAILER-DAEMON"
Benjamin Peterson5c8da862009-06-30 22:57:08 +00001261 self.assertTrue(re.match(sender + r" \w{3} \w{3} [\d ]\d [\d ]\d:\d{2}:"
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001262 r"\d{2} \d{4}", msg.get_from()))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001263
1264
1265class TestMboxMessage(_TestMboxMMDFMessage):
1266
1267 _factory = mailbox.mboxMessage
1268
1269
1270class TestMHMessage(TestMessage):
1271
1272 _factory = mailbox.MHMessage
1273
1274 def _post_initialize_hook(self, msg):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001275 self.assertEqual(msg._sequences, [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001276
1277 def test_sequences(self):
1278 # Get, set, join, and leave sequences
1279 msg = mailbox.MHMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001280 self.assertEqual(msg.get_sequences(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001281 msg.set_sequences(['foobar'])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001282 self.assertEqual(msg.get_sequences(), ['foobar'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001283 msg.set_sequences([])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001284 self.assertEqual(msg.get_sequences(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001285 msg.add_sequence('unseen')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001286 self.assertEqual(msg.get_sequences(), ['unseen'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001287 msg.add_sequence('flagged')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001288 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001289 msg.add_sequence('flagged')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001290 self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001291 msg.remove_sequence('unseen')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001292 self.assertEqual(msg.get_sequences(), ['flagged'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001293 msg.add_sequence('foobar')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001294 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001295 msg.remove_sequence('replied')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001296 self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001297 msg.set_sequences(['foobar', 'replied'])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001298 self.assertEqual(msg.get_sequences(), ['foobar', 'replied'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001299
1300
1301class TestBabylMessage(TestMessage):
1302
1303 _factory = mailbox.BabylMessage
1304
1305 def _post_initialize_hook(self, msg):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001306 self.assertEqual(msg._labels, [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001307
1308 def test_labels(self):
1309 # Get, set, join, and leave labels
1310 msg = mailbox.BabylMessage(_sample_message)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001311 self.assertEqual(msg.get_labels(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001312 msg.set_labels(['foobar'])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001313 self.assertEqual(msg.get_labels(), ['foobar'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001314 msg.set_labels([])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001315 self.assertEqual(msg.get_labels(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001316 msg.add_label('filed')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001317 self.assertEqual(msg.get_labels(), ['filed'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001318 msg.add_label('resent')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001319 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001320 msg.add_label('resent')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001321 self.assertEqual(msg.get_labels(), ['filed', 'resent'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001322 msg.remove_label('filed')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001323 self.assertEqual(msg.get_labels(), ['resent'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001324 msg.add_label('foobar')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001325 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001326 msg.remove_label('unseen')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001327 self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001328 msg.set_labels(['foobar', 'answered'])
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001329 self.assertEqual(msg.get_labels(), ['foobar', 'answered'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001330
1331 def test_visible(self):
1332 # Get, set, and update visible headers
1333 msg = mailbox.BabylMessage(_sample_message)
1334 visible = msg.get_visible()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001335 self.assertEqual(visible.keys(), [])
1336 self.assertIs(visible.get_payload(), None)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001337 visible['User-Agent'] = 'FooBar 1.0'
1338 visible['X-Whatever'] = 'Blah'
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001339 self.assertEqual(msg.get_visible().keys(), [])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001340 msg.set_visible(visible)
1341 visible = msg.get_visible()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001342 self.assertEqual(visible.keys(), ['User-Agent', 'X-Whatever'])
1343 self.assertEqual(visible['User-Agent'], 'FooBar 1.0')
1344 self.assertEqual(visible['X-Whatever'], 'Blah')
1345 self.assertIs(visible.get_payload(), None)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001346 msg.update_visible()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001347 self.assertEqual(visible.keys(), ['User-Agent', 'X-Whatever'])
1348 self.assertIs(visible.get_payload(), None)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001349 visible = msg.get_visible()
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001350 self.assertEqual(visible.keys(), ['User-Agent', 'Date', 'From', 'To',
1351 'Subject'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001352 for header in ('User-Agent', 'Date', 'From', 'To', 'Subject'):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001353 self.assertEqual(visible[header], msg[header])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001354
1355
1356class TestMMDFMessage(_TestMboxMMDFMessage):
1357
1358 _factory = mailbox.MMDFMessage
1359
1360
1361class TestMessageConversion(TestBase):
1362
1363 def test_plain_to_x(self):
1364 # Convert Message to all formats
1365 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1366 mailbox.mboxMessage, mailbox.MHMessage,
1367 mailbox.BabylMessage, mailbox.MMDFMessage):
1368 msg_plain = mailbox.Message(_sample_message)
1369 msg = class_(msg_plain)
1370 self._check_sample(msg)
1371
1372 def test_x_to_plain(self):
1373 # Convert all formats to Message
1374 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1375 mailbox.mboxMessage, mailbox.MHMessage,
1376 mailbox.BabylMessage, mailbox.MMDFMessage):
1377 msg = class_(_sample_message)
1378 msg_plain = mailbox.Message(msg)
1379 self._check_sample(msg_plain)
1380
1381 def test_x_to_invalid(self):
1382 # Convert all formats to an invalid format
1383 for class_ in (mailbox.Message, mailbox.MaildirMessage,
1384 mailbox.mboxMessage, mailbox.MHMessage,
1385 mailbox.BabylMessage, mailbox.MMDFMessage):
1386 self.assertRaises(TypeError, lambda: class_(False))
1387
1388 def test_maildir_to_maildir(self):
1389 # Convert MaildirMessage to MaildirMessage
1390 msg_maildir = mailbox.MaildirMessage(_sample_message)
1391 msg_maildir.set_flags('DFPRST')
1392 msg_maildir.set_subdir('cur')
1393 date = msg_maildir.get_date()
1394 msg = mailbox.MaildirMessage(msg_maildir)
1395 self._check_sample(msg)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001396 self.assertEqual(msg.get_flags(), 'DFPRST')
1397 self.assertEqual(msg.get_subdir(), 'cur')
1398 self.assertEqual(msg.get_date(), date)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001399
1400 def test_maildir_to_mboxmmdf(self):
1401 # Convert MaildirMessage to mboxmessage and MMDFMessage
1402 pairs = (('D', ''), ('F', 'F'), ('P', ''), ('R', 'A'), ('S', 'R'),
1403 ('T', 'D'), ('DFPRST', 'RDFA'))
1404 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1405 msg_maildir = mailbox.MaildirMessage(_sample_message)
1406 msg_maildir.set_date(0.0)
1407 for setting, result in pairs:
1408 msg_maildir.set_flags(setting)
1409 msg = class_(msg_maildir)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001410 self.assertEqual(msg.get_flags(), result)
1411 self.assertEqual(msg.get_from(), 'MAILER-DAEMON %s' %
1412 time.asctime(time.gmtime(0.0)))
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001413 msg_maildir.set_subdir('cur')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001414 self.assertEqual(class_(msg_maildir).get_flags(), 'RODFA')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001415
1416 def test_maildir_to_mh(self):
1417 # Convert MaildirMessage to MHMessage
1418 msg_maildir = mailbox.MaildirMessage(_sample_message)
1419 pairs = (('D', ['unseen']), ('F', ['unseen', 'flagged']),
1420 ('P', ['unseen']), ('R', ['unseen', 'replied']), ('S', []),
1421 ('T', ['unseen']), ('DFPRST', ['replied', 'flagged']))
1422 for setting, result in pairs:
1423 msg_maildir.set_flags(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001424 self.assertEqual(mailbox.MHMessage(msg_maildir).get_sequences(),
1425 result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001426
1427 def test_maildir_to_babyl(self):
1428 # Convert MaildirMessage to Babyl
1429 msg_maildir = mailbox.MaildirMessage(_sample_message)
1430 pairs = (('D', ['unseen']), ('F', ['unseen']),
1431 ('P', ['unseen', 'forwarded']), ('R', ['unseen', 'answered']),
1432 ('S', []), ('T', ['unseen', 'deleted']),
1433 ('DFPRST', ['deleted', 'answered', 'forwarded']))
1434 for setting, result in pairs:
1435 msg_maildir.set_flags(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001436 self.assertEqual(mailbox.BabylMessage(msg_maildir).get_labels(),
1437 result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001438
1439 def test_mboxmmdf_to_maildir(self):
1440 # Convert mboxMessage and MMDFMessage to MaildirMessage
1441 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1442 msg_mboxMMDF = class_(_sample_message)
1443 msg_mboxMMDF.set_from('foo@bar', time.gmtime(0.0))
1444 pairs = (('R', 'S'), ('O', ''), ('D', 'T'), ('F', 'F'), ('A', 'R'),
1445 ('RODFA', 'FRST'))
1446 for setting, result in pairs:
1447 msg_mboxMMDF.set_flags(setting)
1448 msg = mailbox.MaildirMessage(msg_mboxMMDF)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001449 self.assertEqual(msg.get_flags(), result)
1450 self.assertEqual(msg.get_date(), 0.0)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001451 msg_mboxMMDF.set_flags('O')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001452 self.assertEqual(mailbox.MaildirMessage(msg_mboxMMDF).get_subdir(),
1453 'cur')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001454
1455 def test_mboxmmdf_to_mboxmmdf(self):
1456 # Convert mboxMessage and MMDFMessage to mboxMessage and MMDFMessage
1457 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1458 msg_mboxMMDF = class_(_sample_message)
1459 msg_mboxMMDF.set_flags('RODFA')
1460 msg_mboxMMDF.set_from('foo@bar')
1461 for class2_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1462 msg2 = class2_(msg_mboxMMDF)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001463 self.assertEqual(msg2.get_flags(), 'RODFA')
1464 self.assertEqual(msg2.get_from(), 'foo@bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001465
1466 def test_mboxmmdf_to_mh(self):
1467 # Convert mboxMessage and MMDFMessage to MHMessage
1468 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1469 msg_mboxMMDF = class_(_sample_message)
1470 pairs = (('R', []), ('O', ['unseen']), ('D', ['unseen']),
1471 ('F', ['unseen', 'flagged']),
1472 ('A', ['unseen', 'replied']),
1473 ('RODFA', ['replied', 'flagged']))
1474 for setting, result in pairs:
1475 msg_mboxMMDF.set_flags(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001476 self.assertEqual(mailbox.MHMessage(msg_mboxMMDF).get_sequences(),
1477 result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001478
1479 def test_mboxmmdf_to_babyl(self):
1480 # Convert mboxMessage and MMDFMessage to BabylMessage
1481 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1482 msg = class_(_sample_message)
1483 pairs = (('R', []), ('O', ['unseen']),
1484 ('D', ['unseen', 'deleted']), ('F', ['unseen']),
1485 ('A', ['unseen', 'answered']),
1486 ('RODFA', ['deleted', 'answered']))
1487 for setting, result in pairs:
1488 msg.set_flags(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001489 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001490
1491 def test_mh_to_maildir(self):
1492 # Convert MHMessage to MaildirMessage
1493 pairs = (('unseen', ''), ('replied', 'RS'), ('flagged', 'FS'))
1494 for setting, result in pairs:
1495 msg = mailbox.MHMessage(_sample_message)
1496 msg.add_sequence(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001497 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1498 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001499 msg = mailbox.MHMessage(_sample_message)
1500 msg.add_sequence('unseen')
1501 msg.add_sequence('replied')
1502 msg.add_sequence('flagged')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001503 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'FR')
1504 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001505
1506 def test_mh_to_mboxmmdf(self):
1507 # Convert MHMessage to mboxMessage and MMDFMessage
1508 pairs = (('unseen', 'O'), ('replied', 'ROA'), ('flagged', 'ROF'))
1509 for setting, result in pairs:
1510 msg = mailbox.MHMessage(_sample_message)
1511 msg.add_sequence(setting)
1512 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001513 self.assertEqual(class_(msg).get_flags(), result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001514 msg = mailbox.MHMessage(_sample_message)
1515 msg.add_sequence('unseen')
1516 msg.add_sequence('replied')
1517 msg.add_sequence('flagged')
1518 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001519 self.assertEqual(class_(msg).get_flags(), 'OFA')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001520
1521 def test_mh_to_mh(self):
1522 # Convert MHMessage to MHMessage
1523 msg = mailbox.MHMessage(_sample_message)
1524 msg.add_sequence('unseen')
1525 msg.add_sequence('replied')
1526 msg.add_sequence('flagged')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001527 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1528 ['unseen', 'replied', 'flagged'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001529
1530 def test_mh_to_babyl(self):
1531 # Convert MHMessage to BabylMessage
1532 pairs = (('unseen', ['unseen']), ('replied', ['answered']),
1533 ('flagged', []))
1534 for setting, result in pairs:
1535 msg = mailbox.MHMessage(_sample_message)
1536 msg.add_sequence(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001537 self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001538 msg = mailbox.MHMessage(_sample_message)
1539 msg.add_sequence('unseen')
1540 msg.add_sequence('replied')
1541 msg.add_sequence('flagged')
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001542 self.assertEqual(mailbox.BabylMessage(msg).get_labels(),
1543 ['unseen', 'answered'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001544
1545 def test_babyl_to_maildir(self):
1546 # Convert BabylMessage to MaildirMessage
1547 pairs = (('unseen', ''), ('deleted', 'ST'), ('filed', 'S'),
1548 ('answered', 'RS'), ('forwarded', 'PS'), ('edited', 'S'),
1549 ('resent', 'PS'))
1550 for setting, result in pairs:
1551 msg = mailbox.BabylMessage(_sample_message)
1552 msg.add_label(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001553 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
1554 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001555 msg = mailbox.BabylMessage(_sample_message)
1556 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1557 'edited', 'resent'):
1558 msg.add_label(label)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001559 self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'PRT')
1560 self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001561
1562 def test_babyl_to_mboxmmdf(self):
1563 # Convert BabylMessage to mboxMessage and MMDFMessage
1564 pairs = (('unseen', 'O'), ('deleted', 'ROD'), ('filed', 'RO'),
1565 ('answered', 'ROA'), ('forwarded', 'RO'), ('edited', 'RO'),
1566 ('resent', 'RO'))
1567 for setting, result in pairs:
1568 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1569 msg = mailbox.BabylMessage(_sample_message)
1570 msg.add_label(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001571 self.assertEqual(class_(msg).get_flags(), result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001572 msg = mailbox.BabylMessage(_sample_message)
1573 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1574 'edited', 'resent'):
1575 msg.add_label(label)
1576 for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001577 self.assertEqual(class_(msg).get_flags(), 'ODA')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001578
1579 def test_babyl_to_mh(self):
1580 # Convert BabylMessage to MHMessage
1581 pairs = (('unseen', ['unseen']), ('deleted', []), ('filed', []),
1582 ('answered', ['replied']), ('forwarded', []), ('edited', []),
1583 ('resent', []))
1584 for setting, result in pairs:
1585 msg = mailbox.BabylMessage(_sample_message)
1586 msg.add_label(setting)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001587 self.assertEqual(mailbox.MHMessage(msg).get_sequences(), result)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001588 msg = mailbox.BabylMessage(_sample_message)
1589 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1590 'edited', 'resent'):
1591 msg.add_label(label)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001592 self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
1593 ['unseen', 'replied'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001594
1595 def test_babyl_to_babyl(self):
1596 # Convert BabylMessage to BabylMessage
1597 msg = mailbox.BabylMessage(_sample_message)
1598 msg.update_visible()
1599 for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
1600 'edited', 'resent'):
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001601 msg.add_label(label)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001602 msg2 = mailbox.BabylMessage(msg)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001603 self.assertEqual(msg2.get_labels(), ['unseen', 'deleted', 'filed',
1604 'answered', 'forwarded', 'edited',
1605 'resent'])
1606 self.assertEqual(msg.get_visible().keys(), msg2.get_visible().keys())
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001607 for key in msg.get_visible().keys():
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001608 self.assertEqual(msg.get_visible()[key], msg2.get_visible()[key])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001609
1610
1611class TestProxyFileBase(TestBase):
1612
1613 def _test_read(self, proxy):
1614 # Read by byte
1615 proxy.seek(0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001616 self.assertEqual(proxy.read(), 'bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001617 proxy.seek(1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001618 self.assertEqual(proxy.read(), 'ar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001619 proxy.seek(0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001620 self.assertEqual(proxy.read(2), 'ba')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001621 proxy.seek(1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001622 self.assertEqual(proxy.read(-1), 'ar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001623 proxy.seek(2)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001624 self.assertEqual(proxy.read(1000), 'r')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001625
1626 def _test_readline(self, proxy):
1627 # Read by line
1628 proxy.seek(0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001629 self.assertEqual(proxy.readline(), 'foo' + os.linesep)
1630 self.assertEqual(proxy.readline(), 'bar' + os.linesep)
1631 self.assertEqual(proxy.readline(), 'fred' + os.linesep)
1632 self.assertEqual(proxy.readline(), 'bob')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001633 proxy.seek(2)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001634 self.assertEqual(proxy.readline(), 'o' + os.linesep)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001635 proxy.seek(6 + 2 * len(os.linesep))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001636 self.assertEqual(proxy.readline(), 'fred' + os.linesep)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001637 proxy.seek(6 + 2 * len(os.linesep))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001638 self.assertEqual(proxy.readline(2), 'fr')
1639 self.assertEqual(proxy.readline(-10), 'ed' + os.linesep)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001640
1641 def _test_readlines(self, proxy):
1642 # Read multiple lines
1643 proxy.seek(0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001644 self.assertEqual(proxy.readlines(), ['foo' + os.linesep,
1645 'bar' + os.linesep,
1646 'fred' + os.linesep, 'bob'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001647 proxy.seek(0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001648 self.assertEqual(proxy.readlines(2), ['foo' + os.linesep])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001649 proxy.seek(3 + len(os.linesep))
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001650 self.assertEqual(proxy.readlines(4 + len(os.linesep)),
1651 ['bar' + os.linesep, 'fred' + os.linesep])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001652 proxy.seek(3)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001653 self.assertEqual(proxy.readlines(1000), [os.linesep, 'bar' + os.linesep,
1654 'fred' + os.linesep, 'bob'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001655
1656 def _test_iteration(self, proxy):
1657 # Iterate by line
1658 proxy.seek(0)
1659 iterator = iter(proxy)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001660 self.assertEqual(list(iterator),
1661 ['foo' + os.linesep, 'bar' + os.linesep, 'fred' + os.linesep, 'bob'])
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001662
1663 def _test_seek_and_tell(self, proxy):
1664 # Seek and use tell to check position
1665 proxy.seek(3)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001666 self.assertEqual(proxy.tell(), 3)
1667 self.assertEqual(proxy.read(len(os.linesep)), os.linesep)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001668 proxy.seek(2, 1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001669 self.assertEqual(proxy.read(1 + len(os.linesep)), 'r' + os.linesep)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001670 proxy.seek(-3 - len(os.linesep), 2)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001671 self.assertEqual(proxy.read(3), 'bar')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001672 proxy.seek(2, 0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001673 self.assertEqual(proxy.read(), 'o' + os.linesep + 'bar' + os.linesep)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001674 proxy.seek(100)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001675 self.assertEqual(proxy.read(), '')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001676
1677 def _test_close(self, proxy):
1678 # Close a file
1679 proxy.close()
R David Murrayf1138bb2011-06-17 22:23:04 -04001680 # Issue 11700 subsequent closes should be a no-op, not an error.
1681 proxy.close()
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001682
1683
1684class TestProxyFile(TestProxyFileBase):
1685
1686 def setUp(self):
1687 self._path = test_support.TESTFN
Andrew M. Kuchling214db632006-05-02 21:44:33 +00001688 self._file = open(self._path, 'wb+')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001689
1690 def tearDown(self):
1691 self._file.close()
1692 self._delete_recursively(self._path)
1693
1694 def test_initialize(self):
1695 # Initialize and check position
1696 self._file.write('foo')
1697 pos = self._file.tell()
1698 proxy0 = mailbox._ProxyFile(self._file)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001699 self.assertEqual(proxy0.tell(), pos)
1700 self.assertEqual(self._file.tell(), pos)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001701 proxy1 = mailbox._ProxyFile(self._file, 0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001702 self.assertEqual(proxy1.tell(), 0)
1703 self.assertEqual(self._file.tell(), pos)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001704
1705 def test_read(self):
1706 self._file.write('bar')
1707 self._test_read(mailbox._ProxyFile(self._file))
1708
1709 def test_readline(self):
1710 self._file.write('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1711 os.linesep))
1712 self._test_readline(mailbox._ProxyFile(self._file))
1713
1714 def test_readlines(self):
1715 self._file.write('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1716 os.linesep))
1717 self._test_readlines(mailbox._ProxyFile(self._file))
1718
1719 def test_iteration(self):
1720 self._file.write('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
1721 os.linesep))
1722 self._test_iteration(mailbox._ProxyFile(self._file))
1723
1724 def test_seek_and_tell(self):
1725 self._file.write('foo%sbar%s' % (os.linesep, os.linesep))
1726 self._test_seek_and_tell(mailbox._ProxyFile(self._file))
1727
1728 def test_close(self):
1729 self._file.write('foo%sbar%s' % (os.linesep, os.linesep))
1730 self._test_close(mailbox._ProxyFile(self._file))
1731
1732
1733class TestPartialFile(TestProxyFileBase):
1734
1735 def setUp(self):
1736 self._path = test_support.TESTFN
Andrew M. Kuchling214db632006-05-02 21:44:33 +00001737 self._file = open(self._path, 'wb+')
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001738
1739 def tearDown(self):
1740 self._file.close()
1741 self._delete_recursively(self._path)
1742
1743 def test_initialize(self):
1744 # Initialize and check position
1745 self._file.write('foo' + os.linesep + 'bar')
1746 pos = self._file.tell()
1747 proxy = mailbox._PartialFile(self._file, 2, 5)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001748 self.assertEqual(proxy.tell(), 0)
1749 self.assertEqual(self._file.tell(), pos)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001750
1751 def test_read(self):
1752 self._file.write('***bar***')
1753 self._test_read(mailbox._PartialFile(self._file, 3, 6))
1754
1755 def test_readline(self):
1756 self._file.write('!!!!!foo%sbar%sfred%sbob!!!!!' %
1757 (os.linesep, os.linesep, os.linesep))
1758 self._test_readline(mailbox._PartialFile(self._file, 5,
1759 18 + 3 * len(os.linesep)))
1760
1761 def test_readlines(self):
1762 self._file.write('foo%sbar%sfred%sbob?????' %
1763 (os.linesep, os.linesep, os.linesep))
1764 self._test_readlines(mailbox._PartialFile(self._file, 0,
1765 13 + 3 * len(os.linesep)))
1766
1767 def test_iteration(self):
1768 self._file.write('____foo%sbar%sfred%sbob####' %
1769 (os.linesep, os.linesep, os.linesep))
1770 self._test_iteration(mailbox._PartialFile(self._file, 4,
1771 17 + 3 * len(os.linesep)))
1772
1773 def test_seek_and_tell(self):
1774 self._file.write('(((foo%sbar%s$$$' % (os.linesep, os.linesep))
1775 self._test_seek_and_tell(mailbox._PartialFile(self._file, 3,
1776 9 + 2 * len(os.linesep)))
1777
1778 def test_close(self):
1779 self._file.write('&foo%sbar%s^' % (os.linesep, os.linesep))
1780 self._test_close(mailbox._PartialFile(self._file, 1,
1781 6 + 3 * len(os.linesep)))
1782
1783
1784## Start: tests from the original module (for backward compatibility).
1785
Skip Montanaro5253da12004-07-24 19:56:03 +00001786FROM_ = "From some.body@dummy.domain Sat Jul 24 13:43:35 2004\n"
Fred Drakec02bc3e2001-05-21 20:23:21 +00001787DUMMY_MESSAGE = """\
1788From: some.body@dummy.domain
1789To: me@my.domain
Skip Montanaro5253da12004-07-24 19:56:03 +00001790Subject: Simple Test
Fred Drakec02bc3e2001-05-21 20:23:21 +00001791
1792This is a dummy message.
1793"""
1794
Fred Drakec02bc3e2001-05-21 20:23:21 +00001795class MaildirTestCase(unittest.TestCase):
1796
1797 def setUp(self):
1798 # create a new maildir mailbox to work with:
1799 self._dir = test_support.TESTFN
1800 os.mkdir(self._dir)
1801 os.mkdir(os.path.join(self._dir, "cur"))
1802 os.mkdir(os.path.join(self._dir, "tmp"))
1803 os.mkdir(os.path.join(self._dir, "new"))
1804 self._counter = 1
1805 self._msgfiles = []
1806
1807 def tearDown(self):
1808 map(os.unlink, self._msgfiles)
1809 os.rmdir(os.path.join(self._dir, "cur"))
1810 os.rmdir(os.path.join(self._dir, "tmp"))
1811 os.rmdir(os.path.join(self._dir, "new"))
1812 os.rmdir(self._dir)
1813
Skip Montanaro5253da12004-07-24 19:56:03 +00001814 def createMessage(self, dir, mbox=False):
Jack Jansen97df7b62001-06-19 20:20:05 +00001815 t = int(time.time() % 1000000)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001816 pid = self._counter
1817 self._counter += 1
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001818 filename = os.extsep.join((str(t), str(pid), "myhostname", "mydomain"))
Fred Drakec02bc3e2001-05-21 20:23:21 +00001819 tmpname = os.path.join(self._dir, "tmp", filename)
1820 newname = os.path.join(self._dir, dir, filename)
Brian Curtin04d8b222010-10-14 01:14:36 +00001821 with open(tmpname, "w") as fp:
1822 self._msgfiles.append(tmpname)
1823 if mbox:
1824 fp.write(FROM_)
1825 fp.write(DUMMY_MESSAGE)
Tim Peters6626c1f2001-05-22 16:29:01 +00001826 if hasattr(os, "link"):
1827 os.link(tmpname, newname)
1828 else:
Brian Curtin04d8b222010-10-14 01:14:36 +00001829 with open(newname, "w") as fp:
1830 fp.write(DUMMY_MESSAGE)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001831 self._msgfiles.append(newname)
Skip Montanaro5253da12004-07-24 19:56:03 +00001832 return tmpname
Fred Drakec02bc3e2001-05-21 20:23:21 +00001833
1834 def test_empty_maildir(self):
1835 """Test an empty maildir mailbox"""
1836 # Test for regression on bug #117490:
1837 # Make sure the boxes attribute actually gets set.
1838 self.mbox = mailbox.Maildir(test_support.TESTFN)
Benjamin Peterson5c8da862009-06-30 22:57:08 +00001839 #self.assertTrue(hasattr(self.mbox, "boxes"))
1840 #self.assertTrue(len(self.mbox.boxes) == 0)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001841 self.assertIs(self.mbox.next(), None)
1842 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001843
1844 def test_nonempty_maildir_cur(self):
1845 self.createMessage("cur")
1846 self.mbox = mailbox.Maildir(test_support.TESTFN)
Benjamin Peterson5c8da862009-06-30 22:57:08 +00001847 #self.assertTrue(len(self.mbox.boxes) == 1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001848 self.assertIsNot(self.mbox.next(), None)
1849 self.assertIs(self.mbox.next(), None)
1850 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001851
1852 def test_nonempty_maildir_new(self):
1853 self.createMessage("new")
1854 self.mbox = mailbox.Maildir(test_support.TESTFN)
Benjamin Peterson5c8da862009-06-30 22:57:08 +00001855 #self.assertTrue(len(self.mbox.boxes) == 1)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001856 self.assertIsNot(self.mbox.next(), None)
1857 self.assertIs(self.mbox.next(), None)
1858 self.assertIs(self.mbox.next(), None)
Fred Drakec02bc3e2001-05-21 20:23:21 +00001859
1860 def test_nonempty_maildir_both(self):
1861 self.createMessage("cur")
1862 self.createMessage("new")
1863 self.mbox = mailbox.Maildir(test_support.TESTFN)
Benjamin Peterson5c8da862009-06-30 22:57:08 +00001864 #self.assertTrue(len(self.mbox.boxes) == 2)
Antoine Pitrou0da5cb82009-10-31 23:19:52 +00001865 self.assertIsNot(self.mbox.next(), None)
1866 self.assertIsNot(self.mbox.next(), None)
1867 self.assertIs(self.mbox.next(), None)
1868 self.assertIs(self.mbox.next(), None)
Fred Drake0aaed272000-10-23 13:39:15 +00001869
Skip Montanaro5253da12004-07-24 19:56:03 +00001870 def test_unix_mbox(self):
1871 ### should be better!
Georg Brandl5a096e12007-01-22 19:40:21 +00001872 import email.parser
Skip Montanaro5253da12004-07-24 19:56:03 +00001873 fname = self.createMessage("cur", True)
1874 n = 0
1875 for msg in mailbox.PortableUnixMailbox(open(fname),
Georg Brandl5a096e12007-01-22 19:40:21 +00001876 email.parser.Parser().parse):
Skip Montanaro5253da12004-07-24 19:56:03 +00001877 n += 1
1878 self.assertEqual(msg["subject"], "Simple Test")
1879 self.assertEqual(len(str(msg)), len(FROM_)+len(DUMMY_MESSAGE))
1880 self.assertEqual(n, 1)
1881
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001882## End: classes from the original module (for backward compatibility).
1883
1884
1885_sample_message = """\
1886Return-Path: <gkj@gregorykjohnson.com>
1887X-Original-To: gkj+person@localhost
1888Delivered-To: gkj+person@localhost
1889Received: from localhost (localhost [127.0.0.1])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001890 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1891 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001892Delivered-To: gkj@sundance.gregorykjohnson.com
1893Received: from localhost [127.0.0.1]
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001894 by localhost with POP3 (fetchmail-6.2.5)
1895 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001896Received: from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001897 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1898 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001899Received: by andy.gregorykjohnson.com (Postfix, from userid 1000)
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001900 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001901Date: Wed, 13 Jul 2005 17:23:11 -0400
1902From: "Gregory K. Johnson" <gkj@gregorykjohnson.com>
1903To: gkj@gregorykjohnson.com
1904Subject: Sample message
1905Message-ID: <20050713212311.GC4701@andy.gregorykjohnson.com>
1906Mime-Version: 1.0
1907Content-Type: multipart/mixed; boundary="NMuMz9nt05w80d4+"
1908Content-Disposition: inline
1909User-Agent: Mutt/1.5.9i
1910
1911
1912--NMuMz9nt05w80d4+
1913Content-Type: text/plain; charset=us-ascii
1914Content-Disposition: inline
1915
1916This is a sample message.
1917
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001918--
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001919Gregory K. Johnson
1920
1921--NMuMz9nt05w80d4+
1922Content-Type: application/octet-stream
1923Content-Disposition: attachment; filename="text.gz"
1924Content-Transfer-Encoding: base64
1925
1926H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
19273FYlAAAA
1928
1929--NMuMz9nt05w80d4+--
1930"""
1931
1932_sample_headers = {
1933 "Return-Path":"<gkj@gregorykjohnson.com>",
1934 "X-Original-To":"gkj+person@localhost",
1935 "Delivered-To":"gkj+person@localhost",
1936 "Received":"""from localhost (localhost [127.0.0.1])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001937 by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
1938 for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001939 "Delivered-To":"gkj@sundance.gregorykjohnson.com",
1940 "Received":"""from localhost [127.0.0.1]
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001941 by localhost with POP3 (fetchmail-6.2.5)
1942 for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001943 "Received":"""from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001944 by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
1945 for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001946 "Received":"""by andy.gregorykjohnson.com (Postfix, from userid 1000)
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001947 id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001948 "Date":"Wed, 13 Jul 2005 17:23:11 -0400",
1949 "From":""""Gregory K. Johnson" <gkj@gregorykjohnson.com>""",
1950 "To":"gkj@gregorykjohnson.com",
1951 "Subject":"Sample message",
1952 "Mime-Version":"1.0",
1953 "Content-Type":"""multipart/mixed; boundary="NMuMz9nt05w80d4+\"""",
1954 "Content-Disposition":"inline",
1955 "User-Agent": "Mutt/1.5.9i" }
1956
1957_sample_payloads = ("""This is a sample message.
1958
Tim Peters6d7cd7d2006-04-22 05:52:59 +00001959--
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001960Gregory K. Johnson
1961""",
1962"""H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
19633FYlAAAA
1964""")
Fred Drake0aaed272000-10-23 13:39:15 +00001965
Fred Drakec02bc3e2001-05-21 20:23:21 +00001966
Fred Drake2e2be372001-09-20 21:33:42 +00001967def test_main():
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001968 tests = (TestMailboxSuperclass, TestMaildir, TestMbox, TestMMDF, TestMH,
1969 TestBabyl, TestMessage, TestMaildirMessage, TestMboxMessage,
1970 TestMHMessage, TestBabylMessage, TestMMDFMessage,
1971 TestMessageConversion, TestProxyFile, TestPartialFile,
1972 MaildirTestCase)
1973 test_support.run_unittest(*tests)
Neal Norwitzb15ac312006-06-29 04:10:08 +00001974 test_support.reap_children()
Fred Drake2e2be372001-09-20 21:33:42 +00001975
1976
Andrew M. Kuchling1da4a942006-04-22 02:32:43 +00001977if __name__ == '__main__':
Fred Drake2e2be372001-09-20 21:33:42 +00001978 test_main()