test_mailbox.py 78 KB
Newer Older
1
import os
2
import sys
3
import time
4 5 6
import stat
import socket
import email
7
import email.message
8
import re
9
import io
10
from test import support
11 12 13
import unittest
import mailbox
import glob
14
try:
15 16
    import fcntl
except ImportError:
17 18
    pass

19 20 21 22 23

class TestBase(unittest.TestCase):

    def _check_sample(self, msg):
        # Inspect a mailbox.Message representation of the sample message
24 25
        self.assertTrue(isinstance(msg, email.message.Message))
        self.assertTrue(isinstance(msg, mailbox.Message))
26
        for key, value in _sample_headers.items():
27
            self.assertIn(value, msg.get_all(key))
28
        self.assertTrue(msg.is_multipart())
29
        self.assertEqual(len(msg.get_payload()), len(_sample_payloads))
30 31
        for i, payload in enumerate(_sample_payloads):
            part = msg.get_payload(i)
32
            self.assertTrue(isinstance(part, email.message.Message))
33
            self.assertFalse(isinstance(part, mailbox.Message))
34
            self.assertEqual(part.get_payload(), payload)
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54

    def _delete_recursively(self, target):
        # Delete a file or delete a directory recursively
        if os.path.isdir(target):
            for path, dirs, files in os.walk(target, topdown=False):
                for name in files:
                    os.remove(os.path.join(path, name))
                for name in dirs:
                    os.rmdir(os.path.join(path, name))
            os.rmdir(target)
        elif os.path.exists(target):
            os.remove(target)


class TestMailbox(TestBase):

    _factory = None     # Overridden by subclasses to reuse tests
    _template = 'From: foo\n\n%s'

    def setUp(self):
55
        self._path = support.TESTFN
56
        self._delete_recursively(self._path)
57 58 59
        self._box = self._factory(self._path)

    def tearDown(self):
60
        self._box.close()
61 62 63 64 65 66
        self._delete_recursively(self._path)

    def test_add(self):
        # Add copies of a sample message
        keys = []
        keys.append(self._box.add(self._template % 0))
67
        self.assertEqual(len(self._box), 1)
68
        keys.append(self._box.add(mailbox.Message(_sample_message)))
69
        self.assertEqual(len(self._box), 2)
70
        keys.append(self._box.add(email.message_from_string(_sample_message)))
71
        self.assertEqual(len(self._box), 3)
72
        keys.append(self._box.add(io.StringIO(_sample_message)))
73
        self.assertEqual(len(self._box), 4)
74
        keys.append(self._box.add(_sample_message))
75
        self.assertEqual(len(self._box), 5)
76
        self.assertEqual(self._box.get_string(keys[0]), self._template % 0)
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
        for i in (1, 2, 3, 4):
            self._check_sample(self._box[keys[i]])

    def test_remove(self):
        # Remove messages using remove()
        self._test_remove_or_delitem(self._box.remove)

    def test_delitem(self):
        # Remove messages using __delitem__()
        self._test_remove_or_delitem(self._box.__delitem__)

    def _test_remove_or_delitem(self, method):
        # (Used by test_remove() and test_delitem().)
        key0 = self._box.add(self._template % 0)
        key1 = self._box.add(self._template % 1)
92
        self.assertEqual(len(self._box), 2)
93
        method(key0)
94
        self.assertEqual(len(self._box), 1)
95 96
        self.assertRaises(KeyError, lambda: self._box[key0])
        self.assertRaises(KeyError, lambda: method(key0))
97
        self.assertEqual(self._box.get_string(key1), self._template % 1)
98
        key2 = self._box.add(self._template % 2)
99
        self.assertEqual(len(self._box), 2)
100
        method(key2)
101
        self.assertEqual(len(self._box), 1)
102 103
        self.assertRaises(KeyError, lambda: self._box[key2])
        self.assertRaises(KeyError, lambda: method(key2))
104
        self.assertEqual(self._box.get_string(key1), self._template % 1)
105
        method(key1)
106
        self.assertEqual(len(self._box), 0)
107 108 109 110 111 112 113
        self.assertRaises(KeyError, lambda: self._box[key1])
        self.assertRaises(KeyError, lambda: method(key1))

    def test_discard(self, repetitions=10):
        # Discard messages
        key0 = self._box.add(self._template % 0)
        key1 = self._box.add(self._template % 1)
114
        self.assertEqual(len(self._box), 2)
115
        self._box.discard(key0)
116
        self.assertEqual(len(self._box), 1)
117 118
        self.assertRaises(KeyError, lambda: self._box[key0])
        self._box.discard(key0)
119
        self.assertEqual(len(self._box), 1)
120 121 122 123 124 125
        self.assertRaises(KeyError, lambda: self._box[key0])

    def test_get(self):
        # Retrieve messages using get()
        key0 = self._box.add(self._template % 0)
        msg = self._box.get(key0)
126 127
        self.assertEqual(msg['from'], 'foo')
        self.assertEqual(msg.get_payload(), '0')
128 129
        self.assertIs(self._box.get('foo'), None)
        self.assertIs(self._box.get('foo', False), False)
130
        self._box.close()
131
        self._box = self._factory(self._path)
132 133
        key1 = self._box.add(self._template % 1)
        msg = self._box.get(key1)
134
        self.assertEqual(msg['from'], 'foo')
135
        self.assertEqual(msg.get_payload(), '1')
136 137 138 139 140

    def test_getitem(self):
        # Retrieve message using __getitem__()
        key0 = self._box.add(self._template % 0)
        msg = self._box[key0]
141 142
        self.assertEqual(msg['from'], 'foo')
        self.assertEqual(msg.get_payload(), '0')
143 144 145 146 147 148 149 150 151
        self.assertRaises(KeyError, lambda: self._box['foo'])
        self._box.discard(key0)
        self.assertRaises(KeyError, lambda: self._box[key0])

    def test_get_message(self):
        # Get Message representations of messages
        key0 = self._box.add(self._template % 0)
        key1 = self._box.add(_sample_message)
        msg0 = self._box.get_message(key0)
152
        self.assertTrue(isinstance(msg0, mailbox.Message))
153 154
        self.assertEqual(msg0['from'], 'foo')
        self.assertEqual(msg0.get_payload(), '0')
155 156 157 158 159 160
        self._check_sample(self._box.get_message(key1))

    def test_get_string(self):
        # Get string representations of messages
        key0 = self._box.add(self._template % 0)
        key1 = self._box.add(_sample_message)
161
        self.assertEqual(self._box.get_string(key0), self._template % 0)
162
        self.assertEqual(self._box.get_string(key1), _sample_message)
163 164 165 166 167

    def test_get_file(self):
        # Get file representations of messages
        key0 = self._box.add(self._template % 0)
        key1 = self._box.add(_sample_message)
168 169 170
        data0 = self._box.get_file(key0).read()
        data1 = self._box.get_file(key1).read()
        self.assertEqual(data0.replace(os.linesep, '\n'),
171
                         self._template % 0)
172
        self.assertEqual(data1.replace(os.linesep, '\n'),
173
                         _sample_message)
174 175 176

    def test_iterkeys(self):
        # Get keys using iterkeys()
177
        self._check_iteration(self._box.keys, do_keys=True, do_values=False)
178 179 180 181 182 183 184

    def test_keys(self):
        # Get keys using keys()
        self._check_iteration(self._box.keys, do_keys=True, do_values=False)

    def test_itervalues(self):
        # Get values using itervalues()
185
        self._check_iteration(self._box.values, do_keys=False,
186 187 188 189 190 191 192 193 194 195 196 197 198
                              do_values=True)

    def test_iter(self):
        # Get values using __iter__()
        self._check_iteration(self._box.__iter__, do_keys=False,
                              do_values=True)

    def test_values(self):
        # Get values using values()
        self._check_iteration(self._box.values, do_keys=False, do_values=True)

    def test_iteritems(self):
        # Get keys and values using iteritems()
199
        self._check_iteration(self._box.items, do_keys=True,
200 201 202 203 204 205 206 207 208 209
                              do_values=True)

    def test_items(self):
        # Get keys and values using items()
        self._check_iteration(self._box.items, do_keys=True, do_values=True)

    def _check_iteration(self, method, do_keys, do_values, repetitions=10):
        for value in method():
            self.fail("Not empty")
        keys, values = [], []
210
        for i in range(repetitions):
211 212 213 214 215 216 217 218 219 220 221 222
            keys.append(self._box.add(self._template % i))
            values.append(self._template % i)
        if do_keys and not do_values:
            returned_keys = list(method())
        elif do_values and not do_keys:
            returned_values = list(method())
        else:
            returned_keys, returned_values = [], []
            for key, value in method():
                returned_keys.append(key)
                returned_values.append(value)
        if do_keys:
223 224
            self.assertEqual(len(keys), len(returned_keys))
            self.assertEqual(set(keys), set(returned_keys))
225 226 227
        if do_values:
            count = 0
            for value in returned_values:
228
                self.assertEqual(value['from'], 'foo')
229
                self.assertLess(int(value.get_payload()), repetitions)
230
                count += 1
231
            self.assertEqual(len(values), count)
232 233 234

    def test_contains(self):
        # Check existence of keys using __contains__()
235
        self.assertNotIn('foo', self._box)
236
        key0 = self._box.add(self._template % 0)
237 238
        self.assertIn(key0, self._box)
        self.assertNotIn('foo', self._box)
239
        key1 = self._box.add(self._template % 1)
240 241 242
        self.assertIn(key1, self._box)
        self.assertIn(key0, self._box)
        self.assertNotIn('foo', self._box)
243
        self._box.remove(key0)
244 245 246
        self.assertNotIn(key0, self._box)
        self.assertIn(key1, self._box)
        self.assertNotIn('foo', self._box)
247
        self._box.remove(key1)
248 249 250
        self.assertNotIn(key1, self._box)
        self.assertNotIn(key0, self._box)
        self.assertNotIn('foo', self._box)
251 252 253 254

    def test_len(self, repetitions=10):
        # Get message count
        keys = []
255
        for i in range(repetitions):
256
            self.assertEqual(len(self._box), i)
257
            keys.append(self._box.add(self._template % i))
258
            self.assertEqual(len(self._box), i + 1)
259
        for i in range(repetitions):
260
            self.assertEqual(len(self._box), repetitions - i)
261
            self._box.remove(keys[i])
262
            self.assertEqual(len(self._box), repetitions - i - 1)
263 264 265 266

    def test_set_item(self):
        # Modify messages using __setitem__()
        key0 = self._box.add(self._template % 'original 0')
267 268
        self.assertEqual(self._box.get_string(key0),
                         self._template % 'original 0')
269
        key1 = self._box.add(self._template % 'original 1')
270 271
        self.assertEqual(self._box.get_string(key1),
                         self._template % 'original 1')
272
        self._box[key0] = self._template % 'changed 0'
273 274
        self.assertEqual(self._box.get_string(key0),
                         self._template % 'changed 0')
275
        self._box[key1] = self._template % 'changed 1'
276 277
        self.assertEqual(self._box.get_string(key1),
                         self._template % 'changed 1')
278 279 280 281 282
        self._box[key0] = _sample_message
        self._check_sample(self._box[key0])
        self._box[key1] = self._box[key0]
        self._check_sample(self._box[key1])
        self._box[key0] = self._template % 'original 0'
283
        self.assertEqual(self._box.get_string(key0),
284 285 286 287 288
                     self._template % 'original 0')
        self._check_sample(self._box[key1])
        self.assertRaises(KeyError,
                          lambda: self._box.__setitem__('foo', 'bar'))
        self.assertRaises(KeyError, lambda: self._box['foo'])
289
        self.assertEqual(len(self._box), 2)
290 291 292 293

    def test_clear(self, iterations=10):
        # Remove all messages using clear()
        keys = []
294
        for i in range(iterations):
295 296
            self._box.add(self._template % i)
        for i, key in enumerate(keys):
297
            self.assertEqual(self._box.get_string(key), self._template % i)
298
        self._box.clear()
299
        self.assertEqual(len(self._box), 0)
300 301 302 303 304 305
        for i, key in enumerate(keys):
            self.assertRaises(KeyError, lambda: self._box.get_string(key))

    def test_pop(self):
        # Get and remove a message using pop()
        key0 = self._box.add(self._template % 0)
306
        self.assertIn(key0, self._box)
307
        key1 = self._box.add(self._template % 1)
308
        self.assertIn(key1, self._box)
309
        self.assertEqual(self._box.pop(key0).get_payload(), '0')
310 311
        self.assertNotIn(key0, self._box)
        self.assertIn(key1, self._box)
312
        key2 = self._box.add(self._template % 2)
313
        self.assertIn(key2, self._box)
314
        self.assertEqual(self._box.pop(key2).get_payload(), '2')
315 316
        self.assertNotIn(key2, self._box)
        self.assertIn(key1, self._box)
317
        self.assertEqual(self._box.pop(key1).get_payload(), '1')
318
        self.assertNotIn(key1, self._box)
319
        self.assertEqual(len(self._box), 0)
320 321 322 323

    def test_popitem(self, iterations=10):
        # Get and remove an arbitrary (key, message) using popitem()
        keys = []
324
        for i in range(10):
325 326
            keys.append(self._box.add(self._template % i))
        seen = []
327
        for i in range(10):
328
            key, msg = self._box.popitem()
329 330
            self.assertIn(key, keys)
            self.assertNotIn(key, seen)
331
            seen.append(key)
332 333
            self.assertEqual(int(msg.get_payload()), keys.index(key))
        self.assertEqual(len(self._box), 0)
334 335 336 337 338 339 340 341 342 343
        for key in keys:
            self.assertRaises(KeyError, lambda: self._box[key])

    def test_update(self):
        # Modify multiple messages using update()
        key0 = self._box.add(self._template % 'original 0')
        key1 = self._box.add(self._template % 'original 1')
        key2 = self._box.add(self._template % 'original 2')
        self._box.update({key0: self._template % 'changed 0',
                          key2: _sample_message})
344
        self.assertEqual(len(self._box), 3)
345
        self.assertEqual(self._box.get_string(key0),
346
                     self._template % 'changed 0')
347
        self.assertEqual(self._box.get_string(key1),
348 349 350 351 352
                     self._template % 'original 1')
        self._check_sample(self._box[key2])
        self._box.update([(key2, self._template % 'changed 2'),
                    (key1, self._template % 'changed 1'),
                    (key0, self._template % 'original 0')])
353
        self.assertEqual(len(self._box), 3)
354
        self.assertEqual(self._box.get_string(key0),
355
                     self._template % 'original 0')
356
        self.assertEqual(self._box.get_string(key1),
357
                     self._template % 'changed 1')
358
        self.assertEqual(self._box.get_string(key2),
359 360 361 362
                     self._template % 'changed 2')
        self.assertRaises(KeyError,
                          lambda: self._box.update({'foo': 'bar',
                                          key0: self._template % "changed 0"}))
363
        self.assertEqual(len(self._box), 3)
364
        self.assertEqual(self._box.get_string(key0),
365
                     self._template % "changed 0")
366
        self.assertEqual(self._box.get_string(key1),
367
                     self._template % "changed 1")
368
        self.assertEqual(self._box.get_string(key2),
369 370 371 372
                     self._template % "changed 2")

    def test_flush(self):
        # Write changes to disk
Christian Heimes's avatar
Christian Heimes committed
373
        self._test_flush_or_close(self._box.flush, True)
374 375 376

    def test_lock_unlock(self):
        # Lock and unlock the mailbox
377
        self.assertFalse(os.path.exists(self._get_lock_path()))
378
        self._box.lock()
379
        self.assertTrue(os.path.exists(self._get_lock_path()))
380
        self._box.unlock()
381
        self.assertFalse(os.path.exists(self._get_lock_path()))
382 383 384

    def test_close(self):
        # Close mailbox and flush changes to disk
Christian Heimes's avatar
Christian Heimes committed
385
        self._test_flush_or_close(self._box.close, False)
386

Christian Heimes's avatar
Christian Heimes committed
387
    def _test_flush_or_close(self, method, should_call_close):
388
        contents = [self._template % i for i in range(3)]
389 390 391
        self._box.add(contents[0])
        self._box.add(contents[1])
        self._box.add(contents[2])
392
        oldbox = self._box
393
        method()
Christian Heimes's avatar
Christian Heimes committed
394 395
        if should_call_close:
            self._box.close()
396 397
        self._box = self._factory(self._path)
        keys = self._box.keys()
398
        self.assertEqual(len(keys), 3)
399
        for key in keys:
400
            self.assertIn(self._box.get_string(key), contents)
401
        oldbox.close()
402 403 404 405

    def test_dump_message(self):
        # Write message representations to disk
        for input in (email.message_from_string(_sample_message),
406 407
                      _sample_message, io.StringIO(_sample_message)):
            output = io.StringIO()
408
            self._box._dump_message(input, output)
409
            self.assertEqual(output.getvalue(), _sample_message)
410
        output = io.StringIO()
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
        self.assertRaises(TypeError,
                          lambda: self._box._dump_message(None, output))

    def _get_lock_path(self):
        # Return the path of the dot lock file. May be overridden.
        return self._path + '.lock'


class TestMailboxSuperclass(TestBase):

    def test_notimplemented(self):
        # Test that all Mailbox methods raise NotImplementedException.
        box = mailbox.Mailbox('path')
        self.assertRaises(NotImplementedError, lambda: box.add(''))
        self.assertRaises(NotImplementedError, lambda: box.remove(''))
        self.assertRaises(NotImplementedError, lambda: box.__delitem__(''))
        self.assertRaises(NotImplementedError, lambda: box.discard(''))
        self.assertRaises(NotImplementedError, lambda: box.__setitem__('', ''))
        self.assertRaises(NotImplementedError, lambda: box.keys())
430
        self.assertRaises(NotImplementedError, lambda: box.keys())
431 432
        self.assertRaises(NotImplementedError, lambda: box.values().__next__())
        self.assertRaises(NotImplementedError, lambda: box.__iter__().__next__())
433
        self.assertRaises(NotImplementedError, lambda: box.values())
434
        self.assertRaises(NotImplementedError, lambda: box.items().next())
435 436 437 438 439 440
        self.assertRaises(NotImplementedError, lambda: box.items())
        self.assertRaises(NotImplementedError, lambda: box.get(''))
        self.assertRaises(NotImplementedError, lambda: box.__getitem__(''))
        self.assertRaises(NotImplementedError, lambda: box.get_message(''))
        self.assertRaises(NotImplementedError, lambda: box.get_string(''))
        self.assertRaises(NotImplementedError, lambda: box.get_file(''))
441
        self.assertRaises(NotImplementedError, lambda: '' in box)
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
        self.assertRaises(NotImplementedError, lambda: box.__contains__(''))
        self.assertRaises(NotImplementedError, lambda: box.__len__())
        self.assertRaises(NotImplementedError, lambda: box.clear())
        self.assertRaises(NotImplementedError, lambda: box.pop(''))
        self.assertRaises(NotImplementedError, lambda: box.popitem())
        self.assertRaises(NotImplementedError, lambda: box.update((('', ''),)))
        self.assertRaises(NotImplementedError, lambda: box.flush())
        self.assertRaises(NotImplementedError, lambda: box.lock())
        self.assertRaises(NotImplementedError, lambda: box.unlock())
        self.assertRaises(NotImplementedError, lambda: box.close())


class TestMaildir(TestMailbox):

    _factory = lambda self, path, factory=None: mailbox.Maildir(path, factory)

    def setUp(self):
        TestMailbox.setUp(self)
460
        if os.name in ('nt', 'os2') or sys.platform == 'cygwin':
461 462 463 464 465 466 467 468
            self._box.colon = '!'

    def test_add_MM(self):
        # Add a MaildirMessage instance
        msg = mailbox.MaildirMessage(self._template % 0)
        msg.set_subdir('cur')
        msg.set_info('foo')
        key = self._box.add(msg)
469
        self.assertTrue(os.path.exists(os.path.join(self._path, 'cur', '%s%sfoo' %
470 471 472 473 474 475 476 477 478
                                                 (key, self._box.colon))))

    def test_get_MM(self):
        # Get a MaildirMessage instance
        msg = mailbox.MaildirMessage(self._template % 0)
        msg.set_subdir('cur')
        msg.set_flags('RF')
        key = self._box.add(msg)
        msg_returned = self._box.get_message(key)
479
        self.assertTrue(isinstance(msg_returned, mailbox.MaildirMessage))
480 481
        self.assertEqual(msg_returned.get_subdir(), 'cur')
        self.assertEqual(msg_returned.get_flags(), 'FR')
482 483 484 485 486 487 488

    def test_set_MM(self):
        # Set with a MaildirMessage instance
        msg0 = mailbox.MaildirMessage(self._template % 0)
        msg0.set_flags('TP')
        key = self._box.add(msg0)
        msg_returned = self._box.get_message(key)
489 490
        self.assertEqual(msg_returned.get_subdir(), 'new')
        self.assertEqual(msg_returned.get_flags(), 'PT')
491 492 493
        msg1 = mailbox.MaildirMessage(self._template % 1)
        self._box[key] = msg1
        msg_returned = self._box.get_message(key)
494 495 496
        self.assertEqual(msg_returned.get_subdir(), 'new')
        self.assertEqual(msg_returned.get_flags(), '')
        self.assertEqual(msg_returned.get_payload(), '1')
497 498 499 500 501
        msg2 = mailbox.MaildirMessage(self._template % 2)
        msg2.set_info('2,S')
        self._box[key] = msg2
        self._box[key] = self._template % 3
        msg_returned = self._box.get_message(key)
502 503 504
        self.assertEqual(msg_returned.get_subdir(), 'new')
        self.assertEqual(msg_returned.get_flags(), 'S')
        self.assertEqual(msg_returned.get_payload(), '3')
505

506 507 508 509 510 511 512 513 514 515 516
    def test_consistent_factory(self):
        # Add a message.
        msg = mailbox.MaildirMessage(self._template % 0)
        msg.set_subdir('cur')
        msg.set_flags('RF')
        key = self._box.add(msg)

        # Create new mailbox with
        class FakeMessage(mailbox.MaildirMessage):
            pass
        box = mailbox.Maildir(self._path, factory=FakeMessage)
Christian Heimes's avatar
Christian Heimes committed
517
        box.colon = self._box.colon
518
        msg2 = box.get_message(key)
519
        self.assertTrue(isinstance(msg2, FakeMessage))
520

521 522 523 524
    def test_initialize_new(self):
        # Initialize a non-existent mailbox
        self.tearDown()
        self._box = mailbox.Maildir(self._path)
525
        self._check_basics()
526 527 528 529 530 531 532 533
        self._delete_recursively(self._path)
        self._box = self._factory(self._path, factory=None)
        self._check_basics()

    def test_initialize_existing(self):
        # Initialize an existing mailbox
        self.tearDown()
        for subdir in '', 'tmp', 'new', 'cur':
534
            os.mkdir(os.path.normpath(os.path.join(self._path, subdir)))
535 536 537 538 539 540 541 542 543 544
        self._box = mailbox.Maildir(self._path)
        self._check_basics()

    def _check_basics(self, factory=None):
        # (Used by test_open_new() and test_open_existing().)
        self.assertEqual(self._box._path, os.path.abspath(self._path))
        self.assertEqual(self._box._factory, factory)
        for subdir in '', 'tmp', 'new', 'cur':
            path = os.path.join(self._path, subdir)
            mode = os.stat(path)[stat.ST_MODE]
545
            self.assertTrue(stat.S_ISDIR(mode), "Not a directory: '%s'" % path)
546 547 548 549 550 551

    def test_list_folders(self):
        # List folders
        self._box.add_folder('one')
        self._box.add_folder('two')
        self._box.add_folder('three')
552
        self.assertEqual(len(self._box.list_folders()), 3)
553
        self.assertEqual(set(self._box.list_folders()),
554 555 556 557 558 559 560
                     set(('one', 'two', 'three')))

    def test_get_folder(self):
        # Open folders
        self._box.add_folder('foo.bar')
        folder0 = self._box.get_folder('foo.bar')
        folder0.add(self._template % 'bar')
561
        self.assertTrue(os.path.isdir(os.path.join(self._path, '.foo.bar')))
562
        folder1 = self._box.get_folder('foo.bar')
563 564
        self.assertEqual(folder1.get_string(folder1.keys()[0]),
                         self._template % 'bar')
565 566 567 568 569

    def test_add_and_remove_folders(self):
        # Delete folders
        self._box.add_folder('one')
        self._box.add_folder('two')
570
        self.assertEqual(len(self._box.list_folders()), 2)
571
        self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
572
        self._box.remove_folder('one')
573 574
        self.assertEqual(len(self._box.list_folders()), 1)
        self.assertEqual(set(self._box.list_folders()), set(('two',)))
575
        self._box.add_folder('three')
576
        self.assertEqual(len(self._box.list_folders()), 2)
577
        self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
578
        self._box.remove_folder('three')
579 580
        self.assertEqual(len(self._box.list_folders()), 1)
        self.assertEqual(set(self._box.list_folders()), set(('two',)))
581
        self._box.remove_folder('two')
582 583
        self.assertEqual(len(self._box.list_folders()), 0)
        self.assertEqual(self._box.list_folders(), [])
584 585 586 587 588 589 590 591 592 593 594 595

    def test_clean(self):
        # Remove old files from 'tmp'
        foo_path = os.path.join(self._path, 'tmp', 'foo')
        bar_path = os.path.join(self._path, 'tmp', 'bar')
        f = open(foo_path, 'w')
        f.write("@")
        f.close()
        f = open(bar_path, 'w')
        f.write("@")
        f.close()
        self._box.clean()
596 597
        self.assertTrue(os.path.exists(foo_path))
        self.assertTrue(os.path.exists(bar_path))
598 599 600 601
        foo_stat = os.stat(foo_path)
        os.utime(foo_path, (time.time() - 129600 - 2,
                            foo_stat.st_mtime))
        self._box.clean()
602
        self.assertFalse(os.path.exists(foo_path))
603
        self.assertTrue(os.path.exists(bar_path))
604 605 606 607 608 609 610 611 612 613 614 615

    def test_create_tmp(self, repetitions=10):
        # Create files in tmp directory
        hostname = socket.gethostname()
        if '/' in hostname:
            hostname = hostname.replace('/', r'\057')
        if ':' in hostname:
            hostname = hostname.replace(':', r'\072')
        pid = os.getpid()
        pattern = re.compile(r"(?P<time>\d+)\.M(?P<M>\d{1,6})P(?P<P>\d+)"
                             r"Q(?P<Q>\d+)\.(?P<host>[^:/]+)")
        previous_groups = None
616
        for x in range(repetitions):
617 618 619 620 621 622
            tmp_file = self._box._create_tmp()
            head, tail = os.path.split(tmp_file.name)
            self.assertEqual(head, os.path.abspath(os.path.join(self._path,
                                                                "tmp")),
                             "File in wrong location: '%s'" % head)
            match = pattern.match(tail)
623
            self.assertIsNot(match, None, "Invalid file name: '%s'" % tail)
624
            groups = match.groups()
625
            if previous_groups is not None:
626
                self.assertTrue(int(groups[0] >= previous_groups[0]),
627 628
                             "Non-monotonic seconds: '%s' before '%s'" %
                             (previous_groups[0], groups[0]))
629
                self.assertTrue(int(groups[1] >= previous_groups[1]) or
630 631 632
                             groups[0] != groups[1],
                             "Non-monotonic milliseconds: '%s' before '%s'" %
                             (previous_groups[1], groups[1]))
633
                self.assertEqual(int(groups[2]), pid,
634 635
                             "Process ID mismatch: '%s' should be '%s'" %
                             (groups[2], pid))
636
                self.assertEqual(int(groups[3]), int(previous_groups[3]) + 1,
637 638
                             "Non-sequential counter: '%s' before '%s'" %
                             (previous_groups[3], groups[3]))
639
                self.assertEqual(groups[4], hostname,
640 641 642 643 644
                             "Host name mismatch: '%s' should be '%s'" %
                             (groups[4], hostname))
            previous_groups = groups
            tmp_file.write(_sample_message)
            tmp_file.seek(0)
645
            self.assertEqual(tmp_file.read(), _sample_message)
646 647
            tmp_file.close()
        file_count = len(os.listdir(os.path.join(self._path, "tmp")))
648
        self.assertEqual(file_count, repetitions,
649 650 651 652 653
                     "Wrong file count: '%s' should be '%s'" %
                     (file_count, repetitions))

    def test_refresh(self):
        # Update the table of contents
654
        self.assertEqual(self._box._toc, {})
655 656
        key0 = self._box.add(self._template % 0)
        key1 = self._box.add(self._template % 1)
657
        self.assertEqual(self._box._toc, {})
658
        self._box._refresh()
659 660
        self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
                                          key1: os.path.join('new', key1)})
661
        key2 = self._box.add(self._template % 2)
662 663
        self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
                                          key1: os.path.join('new', key1)})
664
        self._box._refresh()
665 666 667
        self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
                                          key1: os.path.join('new', key1),
                                          key2: os.path.join('new', key2)})
668 669 670 671 672

    def test_lookup(self):
        # Look up message subpaths in the TOC
        self.assertRaises(KeyError, lambda: self._box._lookup('foo'))
        key0 = self._box.add(self._template % 0)
673
        self.assertEqual(self._box._lookup(key0), os.path.join('new', key0))
674
        os.remove(os.path.join(self._path, 'new', key0))
675
        self.assertEqual(self._box._toc, {key0: os.path.join('new', key0)})
676 677 678
        # Be sure that the TOC is read back from disk (see issue #6896
        # about bad mtime behaviour on some systems).
        self._box.flush()
679
        self.assertRaises(KeyError, lambda: self._box._lookup(key0))
680
        self.assertEqual(self._box._toc, {})
681 682 683 684 685 686

    def test_lock_unlock(self):
        # Lock and unlock the mailbox. For Maildir, this does nothing.
        self._box.lock()
        self._box.unlock()

687 688 689 690 691 692 693
    def test_folder (self):
        # Test for bug #1569790: verify that folders returned by .get_folder()
        # use the same factory function.
        def dummy_factory (s):
            return None
        box = self._factory(self._path, factory=dummy_factory)
        folder = box.add_folder('folder1')
694
        self.assertIs(folder._factory, dummy_factory)
695

696
        folder1_alias = box.get_folder('folder1')
697
        self.assertIs(folder1_alias._factory, dummy_factory)
698

699 700 701 702 703 704 705 706
    def test_directory_in_folder (self):
        # Test that mailboxes still work if there's a stray extra directory
        # in a folder.
        for i in range(10):
            self._box.add(mailbox.Message(_sample_message))

        # Create a stray directory
        os.mkdir(os.path.join(self._path, 'cur', 'stray-dir'))
707

708 709 710
        # Check that looping still works with the directory present.
        for msg in self._box:
            pass
711

Georg Brandl's avatar
Georg Brandl committed
712 713 714 715 716 717 718 719 720 721 722 723
    def test_file_permissions(self):
        # Verify that message files are created without execute permissions
        if not hasattr(os, "stat") or not hasattr(os, "umask"):
            return
        msg = mailbox.MaildirMessage(self._template % 0)
        orig_umask = os.umask(0)
        try:
            key = self._box.add(msg)
        finally:
            os.umask(orig_umask)
        path = os.path.join(self._path, self._box._lookup(key))
        mode = os.stat(path).st_mode
724
        self.assertFalse(mode & 0o111)
Georg Brandl's avatar
Georg Brandl committed
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742

    def test_folder_file_perms(self):
        # From bug #3228, we want to verify that the file created inside a Maildir
        # subfolder isn't marked as executable.
        if not hasattr(os, "stat") or not hasattr(os, "umask"):
            return

        orig_umask = os.umask(0)
        try:
            subfolder = self._box.add_folder('subfolder')
        finally:
            os.umask(orig_umask)

        path = os.path.join(subfolder._path, 'maildirfolder')
        st = os.stat(path)
        perms = st.st_mode
        self.assertFalse((perms & 0o111)) # Execute bits should all be off.

743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
    def test_reread(self):
        # Wait for 2 seconds
        time.sleep(2)

        # Initially, the mailbox has not been read and the time is null.
        assert getattr(self._box, '_last_read', None) is None

        # Refresh mailbox; the times should now be set to something.
        self._box._refresh()
        assert getattr(self._box, '_last_read', None) is not None

        # Try calling _refresh() again; the modification times shouldn't have
        # changed, so the mailbox should not be re-reading.  Re-reading causes
        # the ._toc attribute to be assigned a new dictionary object, so
        # we'll check that the ._toc attribute isn't a different object.
        orig_toc = self._box._toc
        def refreshed():
            return self._box._toc is not orig_toc

        time.sleep(1)         # Wait 1sec to ensure time.time()'s value changes
        self._box._refresh()
        assert not refreshed()

        # Now, write something into cur and remove it.  This changes
        # the mtime and should cause a re-read.
        filename = os.path.join(self._path, 'cur', 'stray-file')
        f = open(filename, 'w')
        f.close()
        os.unlink(filename)
        self._box._refresh()
        assert refreshed()
Georg Brandl's avatar
Georg Brandl committed
774

775 776 777
class _TestMboxMMDF(TestMailbox):

    def tearDown(self):
778
        self._box.close()
779 780
        self._delete_recursively(self._path)
        for lock_remnant in glob.glob(self._path + '.*'):
781
            support.unlink(lock_remnant)
782 783 784 785

    def test_add_from_string(self):
        # Add a string starting with 'From ' to the mailbox
        key = self._box.add('From foo@bar blah\nFrom: foo\n\n0')
786
        self.assertEqual(self._box[key].get_from(), 'foo@bar blah')
787
        self.assertEqual(self._box[key].get_payload(), '0')
788 789 790 791 792 793 794 795 796

    def test_add_mbox_or_mmdf_message(self):
        # Add an mboxMessage or MMDFMessage
        for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
            msg = class_('From foo@bar blah\nFrom: foo\n\n0')
            key = self._box.add(msg)

    def test_open_close_open(self):
        # Open and inspect previously-created mailbox
797
        values = [self._template % i for i in range(3)]
798 799 800 801 802
        for value in values:
            self._box.add(value)
        self._box.close()
        mtime = os.path.getmtime(self._path)
        self._box = self._factory(self._path)
803
        self.assertEqual(len(self._box), 3)
804
        for key in self._box.keys():
805
            self.assertIn(self._box.get_string(key), values)
806
        self._box.close()
807
        self.assertEqual(mtime, os.path.getmtime(self._path))
808 809 810 811

    def test_add_and_close(self):
        # Verifying that closing a mailbox doesn't change added items
        self._box.add(_sample_message)
812
        for i in range(3):
813 814 815 816 817 818
            self._box.add(self._template % i)
        self._box.add(_sample_message)
        self._box._file.flush()
        self._box._file.seek(0)
        contents = self._box._file.read()
        self._box.close()
819
        self.assertEqual(contents, open(self._path, 'r', newline='').read())
820 821
        self._box = self._factory(self._path)

822 823 824 825 826 827 828 829
    def test_lock_conflict(self):
        # Fork off a subprocess that will lock the file for 2 seconds,
        # unlock it, and then exit.
        if not hasattr(os, 'fork'):
            return
        pid = os.fork()
        if pid == 0:
            # In the child, lock the mailbox.
830 831 832 833 834 835
            try:
                self._box.lock()
                time.sleep(2)
                self._box.unlock()
            finally:
                os._exit(0)
836 837 838 839

        # In the parent, sleep a bit to give the child time to acquire
        # the lock.
        time.sleep(0.5)
840 841 842 843 844 845
        try:
            self.assertRaises(mailbox.ExternalClashError,
                              self._box.lock)
        finally:
            # Wait for child to exit.  Locking should now succeed.
            exited_pid, status = os.waitpid(pid, 0)
846 847 848 849

        self._box.lock()
        self._box.unlock()

850 851 852 853 854 855 856 857 858 859 860 861
    def test_relock(self):
        # Test case for bug #1575506: the mailbox class was locking the
        # wrong file object in its flush() method.
        msg = "Subject: sub\n\nbody\n"
        key1 = self._box.add(msg)
        self._box.flush()
        self._box.close()

        self._box = self._factory(self._path)
        self._box.lock()
        key2 = self._box.add(msg)
        self._box.flush()
862
        self.assertTrue(self._box._locked)
863 864 865
        self._box.close()


866 867 868 869
class TestMbox(_TestMboxMMDF):

    _factory = lambda self, path, factory=None: mailbox.mbox(path, factory)

Georg Brandl's avatar
Georg Brandl committed
870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
    def test_file_perms(self):
        # From bug #3228, we want to verify that the mailbox file isn't executable,
        # even if the umask is set to something that would leave executable bits set.
        # We only run this test on platforms that support umask.
        if hasattr(os, 'umask') and hasattr(os, 'stat'):
            try:
                old_umask = os.umask(0o077)
                self._box.close()
                os.unlink(self._path)
                self._box = mailbox.mbox(self._path, create=True)
                self._box.add('')
                self._box.close()
            finally:
                os.umask(old_umask)

            st = os.stat(self._path)
            perms = st.st_mode
            self.assertFalse((perms & 0o111)) # Execute bits should all be off.
888 889 890 891 892 893 894 895 896 897 898 899 900 901 902

class TestMMDF(_TestMboxMMDF):

    _factory = lambda self, path, factory=None: mailbox.MMDF(path, factory)


class TestMH(TestMailbox):

    _factory = lambda self, path, factory=None: mailbox.MH(path, factory)

    def test_list_folders(self):
        # List folders
        self._box.add_folder('one')
        self._box.add_folder('two')
        self._box.add_folder('three')
903
        self.assertEqual(len(self._box.list_folders()), 3)
904
        self.assertEqual(set(self._box.list_folders()),
905 906 907 908
                     set(('one', 'two', 'three')))

    def test_get_folder(self):
        # Open folders
909 910 911
        def dummy_factory (s):
            return None
        self._box = self._factory(self._path, dummy_factory)
912

913
        new_folder = self._box.add_folder('foo.bar')
914 915
        folder0 = self._box.get_folder('foo.bar')
        folder0.add(self._template % 'bar')
916
        self.assertTrue(os.path.isdir(os.path.join(self._path, 'foo.bar')))
917
        folder1 = self._box.get_folder('foo.bar')
918 919
        self.assertEqual(folder1.get_string(folder1.keys()[0]),
                         self._template % 'bar')
920

921 922
        # Test for bug #1569790: verify that folders returned by .get_folder()
        # use the same factory function.
923 924
        self.assertIs(new_folder._factory, self._box._factory)
        self.assertIs(folder0._factory, self._box._factory)
925

926 927 928 929
    def test_add_and_remove_folders(self):
        # Delete folders
        self._box.add_folder('one')
        self._box.add_folder('two')
930
        self.assertEqual(len(self._box.list_folders()), 2)
931
        self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
932
        self._box.remove_folder('one')
933 934
        self.assertEqual(len(self._box.list_folders()), 1)
        self.assertEqual(set(self._box.list_folders()), set(('two',)))
935
        self._box.add_folder('three')
936
        self.assertEqual(len(self._box.list_folders()), 2)
937
        self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
938
        self._box.remove_folder('three')
939 940
        self.assertEqual(len(self._box.list_folders()), 1)
        self.assertEqual(set(self._box.list_folders()), set(('two',)))
941
        self._box.remove_folder('two')
942 943
        self.assertEqual(len(self._box.list_folders()), 0)
        self.assertEqual(self._box.list_folders(), [])
944 945 946

    def test_sequences(self):
        # Get and set sequences
947
        self.assertEqual(self._box.get_sequences(), {})
948 949 950
        msg0 = mailbox.MHMessage(self._template % 0)
        msg0.add_sequence('foo')
        key0 = self._box.add(msg0)
951
        self.assertEqual(self._box.get_sequences(), {'foo':[key0]})
952 953 954
        msg1 = mailbox.MHMessage(self._template % 1)
        msg1.set_sequences(['bar', 'replied', 'foo'])
        key1 = self._box.add(msg1)
955
        self.assertEqual(self._box.get_sequences(),
956 957 958
                     {'foo':[key0, key1], 'bar':[key1], 'replied':[key1]})
        msg0.set_sequences(['flagged'])
        self._box[key0] = msg0
959
        self.assertEqual(self._box.get_sequences(),
960 961 962
                     {'foo':[key1], 'bar':[key1], 'replied':[key1],
                      'flagged':[key0]})
        self._box.remove(key1)
963
        self.assertEqual(self._box.get_sequences(), {'flagged':[key0]})
964

965 966 967 968 969 970
    def test_issue2625(self):
        msg0 = mailbox.MHMessage(self._template % 0)
        msg0.add_sequence('foo')
        key0 = self._box.add(msg0)
        refmsg0 = self._box.get_message(key0)

971 972 973 974 975 976 977 978 979 980 981 982 983 984
    def test_pack(self):
        # Pack the contents of the mailbox
        msg0 = mailbox.MHMessage(self._template % 0)
        msg1 = mailbox.MHMessage(self._template % 1)
        msg2 = mailbox.MHMessage(self._template % 2)
        msg3 = mailbox.MHMessage(self._template % 3)
        msg0.set_sequences(['foo', 'unseen'])
        msg1.set_sequences(['foo'])
        msg2.set_sequences(['foo', 'flagged'])
        msg3.set_sequences(['foo', 'bar', 'replied'])
        key0 = self._box.add(msg0)
        key1 = self._box.add(msg1)
        key2 = self._box.add(msg2)
        key3 = self._box.add(msg3)
985
        self.assertEqual(self._box.get_sequences(),
986 987 988
                     {'foo':[key0,key1,key2,key3], 'unseen':[key0],
                      'flagged':[key2], 'bar':[key3], 'replied':[key3]})
        self._box.remove(key2)
989
        self.assertEqual(self._box.get_sequences(),
990 991 992
                     {'foo':[key0,key1,key3], 'unseen':[key0], 'bar':[key3],
                      'replied':[key3]})
        self._box.pack()
993
        self.assertEqual(self._box.keys(), [1, 2, 3])
994 995 996
        key0 = key0
        key1 = key0 + 1
        key2 = key1 + 1
997
        self.assertEqual(self._box.get_sequences(),
998 999
                     {'foo':[1, 2, 3], 'unseen':[1], 'bar':[3], 'replied':[3]})

1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
        # Test case for packing while holding the mailbox locked.
        key0 = self._box.add(msg1)
        key1 = self._box.add(msg1)
        key2 = self._box.add(msg1)
        key3 = self._box.add(msg1)

        self._box.remove(key0)
        self._box.remove(key2)
        self._box.lock()
        self._box.pack()
        self._box.unlock()
1011
        self.assertEqual(self._box.get_sequences(),
1012 1013
                     {'foo':[1, 2, 3, 4, 5],
                      'unseen':[1], 'bar':[3], 'replied':[3]})
1014

1015 1016 1017 1018 1019 1020 1021 1022 1023
    def _get_lock_path(self):
        return os.path.join(self._path, '.mh_sequences.lock')


class TestBabyl(TestMailbox):

    _factory = lambda self, path, factory=None: mailbox.Babyl(path, factory)

    def tearDown(self):
1024
        self._box.close()
1025 1026
        self._delete_recursively(self._path)
        for lock_remnant in glob.glob(self._path + '.*'):
1027
            support.unlink(lock_remnant)
1028 1029 1030

    def test_labels(self):
        # Get labels from the mailbox
1031
        self.assertEqual(self._box.get_labels(), [])
1032 1033 1034
        msg0 = mailbox.BabylMessage(self._template % 0)
        msg0.add_label('foo')
        key0 = self._box.add(msg0)
1035
        self.assertEqual(self._box.get_labels(), ['foo'])
1036 1037 1038
        msg1 = mailbox.BabylMessage(self._template % 1)
        msg1.set_labels(['bar', 'answered', 'foo'])
        key1 = self._box.add(msg1)
1039
        self.assertEqual(set(self._box.get_labels()), set(['foo', 'bar']))
1040 1041
        msg0.set_labels(['blah', 'filed'])
        self._box[key0] = msg0
1042
        self.assertEqual(set(self._box.get_labels()),
1043 1044
                     set(['foo', 'bar', 'blah']))
        self._box.remove(key1)
1045
        self.assertEqual(set(self._box.get_labels()), set(['blah']))
1046 1047 1048 1049 1050 1051 1052


class TestMessage(TestBase):

    _factory = mailbox.Message      # Overridden by subclasses to reuse tests

    def setUp(self):
1053
        self._path = support.TESTFN
1054 1055 1056 1057 1058

    def tearDown(self):
        self._delete_recursively(self._path)

    def test_initialize_with_eMM(self):
1059
        # Initialize based on email.message.Message instance
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
        eMM = email.message_from_string(_sample_message)
        msg = self._factory(eMM)
        self._post_initialize_hook(msg)
        self._check_sample(msg)

    def test_initialize_with_string(self):
        # Initialize based on string
        msg = self._factory(_sample_message)
        self._post_initialize_hook(msg)
        self._check_sample(msg)

    def test_initialize_with_file(self):
        # Initialize based on contents of file
        f = open(self._path, 'w+')
        f.write(_sample_message)
        f.seek(0)
        msg = self._factory(f)
        self._post_initialize_hook(msg)
        self._check_sample(msg)
        f.close()

    def test_initialize_with_nothing(self):
        # Initialize without arguments
        msg = self._factory()
        self._post_initialize_hook(msg)
1085 1086 1087
        self.assertTrue(isinstance(msg, email.message.Message))
        self.assertTrue(isinstance(msg, mailbox.Message))
        self.assertTrue(isinstance(msg, self._factory))
1088
        self.assertEqual(msg.keys(), [])
1089
        self.assertFalse(msg.is_multipart())
1090
        self.assertEqual(msg.get_payload(), None)
1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111

    def test_initialize_incorrectly(self):
        # Initialize with invalid argument
        self.assertRaises(TypeError, lambda: self._factory(object()))

    def test_become_message(self):
        # Take on the state of another message
        eMM = email.message_from_string(_sample_message)
        msg = self._factory()
        msg._become_message(eMM)
        self._check_sample(msg)

    def test_explain_to(self):
        # Copy self's format-specific data to other message formats.
        # This test is superficial; better ones are in TestMessageConversion.
        msg = self._factory()
        for class_ in (mailbox.Message, mailbox.MaildirMessage,
                       mailbox.mboxMessage, mailbox.MHMessage,
                       mailbox.BabylMessage, mailbox.MMDFMessage):
            other_msg = class_()
            msg._explain_to(other_msg)
1112
        other_msg = email.message.Message()
1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
        self.assertRaises(TypeError, lambda: msg._explain_to(other_msg))

    def _post_initialize_hook(self, msg):
        # Overridden by subclasses to check extra things after initialization
        pass


class TestMaildirMessage(TestMessage):

    _factory = mailbox.MaildirMessage

    def _post_initialize_hook(self, msg):
1125 1126
        self.assertEqual(msg._subdir, 'new')
        self.assertEqual(msg._info, '')
1127 1128 1129 1130

    def test_subdir(self):
        # Use get_subdir() and set_subdir()
        msg = mailbox.MaildirMessage(_sample_message)
1131
        self.assertEqual(msg.get_subdir(), 'new')
1132
        msg.set_subdir('cur')
1133
        self.assertEqual(msg.get_subdir(), 'cur')
1134
        msg.set_subdir('new')
1135
        self.assertEqual(msg.get_subdir(), 'new')
1136
        self.assertRaises(ValueError, lambda: msg.set_subdir('tmp'))
1137
        self.assertEqual(msg.get_subdir(), 'new')
1138
        msg.set_subdir('new')
1139
        self.assertEqual(msg.get_subdir(), 'new')
1140 1141 1142 1143 1144
        self._check_sample(msg)

    def test_flags(self):
        # Use get_flags(), set_flags(), add_flag(), remove_flag()
        msg = mailbox.MaildirMessage(_sample_message)
1145 1146
        self.assertEqual(msg.get_flags(), '')
        self.assertEqual(msg.get_subdir(), 'new')
1147
        msg.set_flags('F')
1148 1149
        self.assertEqual(msg.get_subdir(), 'new')
        self.assertEqual(msg.get_flags(), 'F')
1150
        msg.set_flags('SDTP')
1151
        self.assertEqual(msg.get_flags(), 'DPST')
1152
        msg.add_flag('FT')
1153
        self.assertEqual(msg.get_flags(), 'DFPST')
1154
        msg.remove_flag('TDRP')
1155 1156
        self.assertEqual(msg.get_flags(), 'FS')
        self.assertEqual(msg.get_subdir(), 'new')
1157 1158 1159 1160 1161
        self._check_sample(msg)

    def test_date(self):
        # Use get_date() and set_date()
        msg = mailbox.MaildirMessage(_sample_message)
1162
        self.assertLess(abs(msg.get_date() - time.time()), 60)
1163
        msg.set_date(0.0)
1164
        self.assertEqual(msg.get_date(), 0.0)
1165 1166 1167 1168

    def test_info(self):
        # Use get_info() and set_info()
        msg = mailbox.MaildirMessage(_sample_message)
1169
        self.assertEqual(msg.get_info(), '')
1170
        msg.set_info('1,foo=bar')
1171
        self.assertEqual(msg.get_info(), '1,foo=bar')
1172 1173 1174 1175 1176 1177
        self.assertRaises(TypeError, lambda: msg.set_info(None))
        self._check_sample(msg)

    def test_info_and_flags(self):
        # Test interaction of info and flag methods
        msg = mailbox.MaildirMessage(_sample_message)
1178
        self.assertEqual(msg.get_info(), '')
1179
        msg.set_flags('SF')
1180 1181
        self.assertEqual(msg.get_flags(), 'FS')
        self.assertEqual(msg.get_info(), '2,FS')
1182
        msg.set_info('1,')
1183 1184
        self.assertEqual(msg.get_flags(), '')
        self.assertEqual(msg.get_info(), '1,')
1185
        msg.remove_flag('RPT')
1186 1187
        self.assertEqual(msg.get_flags(), '')
        self.assertEqual(msg.get_info(), '1,')
1188
        msg.add_flag('D')
1189 1190
        self.assertEqual(msg.get_flags(), 'D')
        self.assertEqual(msg.get_info(), '2,D')
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
        self._check_sample(msg)


class _TestMboxMMDFMessage(TestMessage):

    _factory = mailbox._mboxMMDFMessage

    def _post_initialize_hook(self, msg):
        self._check_from(msg)

    def test_initialize_with_unixfrom(self):
        # Initialize with a message that already has a _unixfrom attribute
        msg = mailbox.Message(_sample_message)
        msg.set_unixfrom('From foo@bar blah')
        msg = mailbox.mboxMessage(msg)
1206
        self.assertEqual(msg.get_from(), 'foo@bar blah', msg.get_from())
1207 1208 1209 1210 1211 1212

    def test_from(self):
        # Get and set "From " line
        msg = mailbox.mboxMessage(_sample_message)
        self._check_from(msg)
        msg.set_from('foo bar')
1213
        self.assertEqual(msg.get_from(), 'foo bar')
1214 1215 1216 1217 1218 1219 1220 1221
        msg.set_from('foo@bar', True)
        self._check_from(msg, 'foo@bar')
        msg.set_from('blah@temp', time.localtime())
        self._check_from(msg, 'blah@temp')

    def test_flags(self):
        # Use get_flags(), set_flags(), add_flag(), remove_flag()
        msg = mailbox.mboxMessage(_sample_message)
1222
        self.assertEqual(msg.get_flags(), '')
1223
        msg.set_flags('F')
1224
        self.assertEqual(msg.get_flags(), 'F')
1225
        msg.set_flags('XODR')
1226
        self.assertEqual(msg.get_flags(), 'RODX')
1227
        msg.add_flag('FA')
1228
        self.assertEqual(msg.get_flags(), 'RODFAX')
1229
        msg.remove_flag('FDXA')
1230
        self.assertEqual(msg.get_flags(), 'RO')
1231 1232 1233 1234 1235 1236
        self._check_sample(msg)

    def _check_from(self, msg, sender=None):
        # Check contents of "From " line
        if sender is None:
            sender = "MAILER-DAEMON"
1237
        self.assertTrue(re.match(sender + r" \w{3} \w{3} [\d ]\d [\d ]\d:\d{2}:"
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250
                              r"\d{2} \d{4}", msg.get_from()) is not None)


class TestMboxMessage(_TestMboxMMDFMessage):

    _factory = mailbox.mboxMessage


class TestMHMessage(TestMessage):

    _factory = mailbox.MHMessage

    def _post_initialize_hook(self, msg):
1251
        self.assertEqual(msg._sequences, [])
1252 1253 1254 1255

    def test_sequences(self):
        # Get, set, join, and leave sequences
        msg = mailbox.MHMessage(_sample_message)
1256
        self.assertEqual(msg.get_sequences(), [])
1257
        msg.set_sequences(['foobar'])
1258
        self.assertEqual(msg.get_sequences(), ['foobar'])
1259
        msg.set_sequences([])
1260
        self.assertEqual(msg.get_sequences(), [])
1261
        msg.add_sequence('unseen')
1262
        self.assertEqual(msg.get_sequences(), ['unseen'])
1263
        msg.add_sequence('flagged')
1264
        self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
1265
        msg.add_sequence('flagged')
1266
        self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
1267
        msg.remove_sequence('unseen')
1268
        self.assertEqual(msg.get_sequences(), ['flagged'])
1269
        msg.add_sequence('foobar')
1270
        self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
1271
        msg.remove_sequence('replied')
1272
        self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
1273
        msg.set_sequences(['foobar', 'replied'])
1274
        self.assertEqual(msg.get_sequences(), ['foobar', 'replied'])
1275 1276 1277 1278 1279 1280 1281


class TestBabylMessage(TestMessage):

    _factory = mailbox.BabylMessage

    def _post_initialize_hook(self, msg):
1282
        self.assertEqual(msg._labels, [])
1283 1284 1285 1286

    def test_labels(self):
        # Get, set, join, and leave labels
        msg = mailbox.BabylMessage(_sample_message)
1287
        self.assertEqual(msg.get_labels(), [])
1288
        msg.set_labels(['foobar'])
1289
        self.assertEqual(msg.get_labels(), ['foobar'])
1290
        msg.set_labels([])
1291
        self.assertEqual(msg.get_labels(), [])
1292
        msg.add_label('filed')
1293
        self.assertEqual(msg.get_labels(), ['filed'])
1294
        msg.add_label('resent')
1295
        self.assertEqual(msg.get_labels(), ['filed', 'resent'])
1296
        msg.add_label('resent')
1297
        self.assertEqual(msg.get_labels(), ['filed', 'resent'])
1298
        msg.remove_label('filed')
1299
        self.assertEqual(msg.get_labels(), ['resent'])
1300
        msg.add_label('foobar')
1301
        self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
1302
        msg.remove_label('unseen')
1303
        self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
1304
        msg.set_labels(['foobar', 'answered'])
1305
        self.assertEqual(msg.get_labels(), ['foobar', 'answered'])
1306 1307 1308 1309 1310

    def test_visible(self):
        # Get, set, and update visible headers
        msg = mailbox.BabylMessage(_sample_message)
        visible = msg.get_visible()
1311
        self.assertEqual(visible.keys(), [])
1312
        self.assertIs(visible.get_payload(), None)
1313 1314
        visible['User-Agent'] = 'FooBar 1.0'
        visible['X-Whatever'] = 'Blah'
1315
        self.assertEqual(msg.get_visible().keys(), [])
1316 1317
        msg.set_visible(visible)
        visible = msg.get_visible()
1318 1319
        self.assertTrue(visible.keys() == ['User-Agent', 'X-Whatever'])
        self.assertTrue(visible['User-Agent'] == 'FooBar 1.0')
1320
        self.assertEqual(visible['X-Whatever'], 'Blah')
1321
        self.assertIs(visible.get_payload(), None)
1322
        msg.update_visible()
1323
        self.assertEqual(visible.keys(), ['User-Agent', 'X-Whatever'])
1324
        self.assertIs(visible.get_payload(), None)
1325
        visible = msg.get_visible()
1326 1327
        self.assertEqual(visible.keys(), ['User-Agent', 'Date', 'From', 'To',
                                          'Subject'])
1328
        for header in ('User-Agent', 'Date', 'From', 'To', 'Subject'):
1329
            self.assertEqual(visible[header], msg[header])
1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371


class TestMMDFMessage(_TestMboxMMDFMessage):

    _factory = mailbox.MMDFMessage


class TestMessageConversion(TestBase):

    def test_plain_to_x(self):
        # Convert Message to all formats
        for class_ in (mailbox.Message, mailbox.MaildirMessage,
                       mailbox.mboxMessage, mailbox.MHMessage,
                       mailbox.BabylMessage, mailbox.MMDFMessage):
            msg_plain = mailbox.Message(_sample_message)
            msg = class_(msg_plain)
            self._check_sample(msg)

    def test_x_to_plain(self):
        # Convert all formats to Message
        for class_ in (mailbox.Message, mailbox.MaildirMessage,
                       mailbox.mboxMessage, mailbox.MHMessage,
                       mailbox.BabylMessage, mailbox.MMDFMessage):
            msg = class_(_sample_message)
            msg_plain = mailbox.Message(msg)
            self._check_sample(msg_plain)

    def test_x_to_invalid(self):
        # Convert all formats to an invalid format
        for class_ in (mailbox.Message, mailbox.MaildirMessage,
                       mailbox.mboxMessage, mailbox.MHMessage,
                       mailbox.BabylMessage, mailbox.MMDFMessage):
            self.assertRaises(TypeError, lambda: class_(False))

    def test_maildir_to_maildir(self):
        # Convert MaildirMessage to MaildirMessage
        msg_maildir = mailbox.MaildirMessage(_sample_message)
        msg_maildir.set_flags('DFPRST')
        msg_maildir.set_subdir('cur')
        date = msg_maildir.get_date()
        msg = mailbox.MaildirMessage(msg_maildir)
        self._check_sample(msg)
1372 1373 1374
        self.assertEqual(msg.get_flags(), 'DFPRST')
        self.assertEqual(msg.get_subdir(), 'cur')
        self.assertEqual(msg.get_date(), date)
1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385

    def test_maildir_to_mboxmmdf(self):
        # Convert MaildirMessage to mboxmessage and MMDFMessage
        pairs = (('D', ''), ('F', 'F'), ('P', ''), ('R', 'A'), ('S', 'R'),
                 ('T', 'D'), ('DFPRST', 'RDFA'))
        for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
            msg_maildir = mailbox.MaildirMessage(_sample_message)
            msg_maildir.set_date(0.0)
            for setting, result in pairs:
                msg_maildir.set_flags(setting)
                msg = class_(msg_maildir)
1386
                self.assertEqual(msg.get_flags(), result)
1387
                self.assertEqual(msg.get_from(), 'MAILER-DAEMON %s' %
1388 1389
                             time.asctime(time.gmtime(0.0)))
            msg_maildir.set_subdir('cur')
1390
            self.assertEqual(class_(msg_maildir).get_flags(), 'RODFA')
1391 1392 1393 1394 1395 1396 1397 1398 1399

    def test_maildir_to_mh(self):
        # Convert MaildirMessage to MHMessage
        msg_maildir = mailbox.MaildirMessage(_sample_message)
        pairs = (('D', ['unseen']), ('F', ['unseen', 'flagged']),
                 ('P', ['unseen']), ('R', ['unseen', 'replied']), ('S', []),
                 ('T', ['unseen']), ('DFPRST', ['replied', 'flagged']))
        for setting, result in pairs:
            msg_maildir.set_flags(setting)
1400 1401
            self.assertEqual(mailbox.MHMessage(msg_maildir).get_sequences(),
                             result)
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411

    def test_maildir_to_babyl(self):
        # Convert MaildirMessage to Babyl
        msg_maildir = mailbox.MaildirMessage(_sample_message)
        pairs = (('D', ['unseen']), ('F', ['unseen']),
                 ('P', ['unseen', 'forwarded']), ('R', ['unseen', 'answered']),
                 ('S', []), ('T', ['unseen', 'deleted']),
                 ('DFPRST', ['deleted', 'answered', 'forwarded']))
        for setting, result in pairs:
            msg_maildir.set_flags(setting)
1412 1413
            self.assertEqual(mailbox.BabylMessage(msg_maildir).get_labels(),
                             result)
1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424

    def test_mboxmmdf_to_maildir(self):
        # Convert mboxMessage and MMDFMessage to MaildirMessage
        for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
            msg_mboxMMDF = class_(_sample_message)
            msg_mboxMMDF.set_from('foo@bar', time.gmtime(0.0))
            pairs = (('R', 'S'), ('O', ''), ('D', 'T'), ('F', 'F'), ('A', 'R'),
                     ('RODFA', 'FRST'))
            for setting, result in pairs:
                msg_mboxMMDF.set_flags(setting)
                msg = mailbox.MaildirMessage(msg_mboxMMDF)
1425
                self.assertEqual(msg.get_flags(), result)
1426
                self.assertEqual(msg.get_date(), 0.0)
1427
            msg_mboxMMDF.set_flags('O')
1428 1429
            self.assertEqual(mailbox.MaildirMessage(msg_mboxMMDF).get_subdir(),
                             'cur')
1430 1431 1432 1433 1434 1435 1436 1437 1438

    def test_mboxmmdf_to_mboxmmdf(self):
        # Convert mboxMessage and MMDFMessage to mboxMessage and MMDFMessage
        for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
            msg_mboxMMDF = class_(_sample_message)
            msg_mboxMMDF.set_flags('RODFA')
            msg_mboxMMDF.set_from('foo@bar')
            for class2_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
                msg2 = class2_(msg_mboxMMDF)
1439 1440
                self.assertEqual(msg2.get_flags(), 'RODFA')
                self.assertEqual(msg2.get_from(), 'foo@bar')
1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451

    def test_mboxmmdf_to_mh(self):
        # Convert mboxMessage and MMDFMessage to MHMessage
        for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
            msg_mboxMMDF = class_(_sample_message)
            pairs = (('R', []), ('O', ['unseen']), ('D', ['unseen']),
                     ('F', ['unseen', 'flagged']),
                     ('A', ['unseen', 'replied']),
                     ('RODFA', ['replied', 'flagged']))
            for setting, result in pairs:
                msg_mboxMMDF.set_flags(setting)
1452 1453
                self.assertEqual(mailbox.MHMessage(msg_mboxMMDF).get_sequences(),
                                 result)
1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464

    def test_mboxmmdf_to_babyl(self):
        # Convert mboxMessage and MMDFMessage to BabylMessage
        for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
            msg = class_(_sample_message)
            pairs = (('R', []), ('O', ['unseen']),
                     ('D', ['unseen', 'deleted']), ('F', ['unseen']),
                     ('A', ['unseen', 'answered']),
                     ('RODFA', ['deleted', 'answered']))
            for setting, result in pairs:
                msg.set_flags(setting)
1465
                self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
1466 1467 1468 1469 1470 1471 1472

    def test_mh_to_maildir(self):
        # Convert MHMessage to MaildirMessage
        pairs = (('unseen', ''), ('replied', 'RS'), ('flagged', 'FS'))
        for setting, result in pairs:
            msg = mailbox.MHMessage(_sample_message)
            msg.add_sequence(setting)
1473 1474
            self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
            self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
1475 1476 1477 1478
        msg = mailbox.MHMessage(_sample_message)
        msg.add_sequence('unseen')
        msg.add_sequence('replied')
        msg.add_sequence('flagged')
1479 1480
        self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'FR')
        self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
1481 1482 1483 1484 1485 1486 1487 1488

    def test_mh_to_mboxmmdf(self):
        # Convert MHMessage to mboxMessage and MMDFMessage
        pairs = (('unseen', 'O'), ('replied', 'ROA'), ('flagged', 'ROF'))
        for setting, result in pairs:
            msg = mailbox.MHMessage(_sample_message)
            msg.add_sequence(setting)
            for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1489
                self.assertEqual(class_(msg).get_flags(), result)
1490 1491 1492 1493 1494
        msg = mailbox.MHMessage(_sample_message)
        msg.add_sequence('unseen')
        msg.add_sequence('replied')
        msg.add_sequence('flagged')
        for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1495
            self.assertEqual(class_(msg).get_flags(), 'OFA')
1496 1497 1498 1499 1500 1501 1502

    def test_mh_to_mh(self):
        # Convert MHMessage to MHMessage
        msg = mailbox.MHMessage(_sample_message)
        msg.add_sequence('unseen')
        msg.add_sequence('replied')
        msg.add_sequence('flagged')
1503 1504
        self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
                         ['unseen', 'replied', 'flagged'])
1505 1506 1507 1508 1509 1510 1511 1512

    def test_mh_to_babyl(self):
        # Convert MHMessage to BabylMessage
        pairs = (('unseen', ['unseen']), ('replied', ['answered']),
                 ('flagged', []))
        for setting, result in pairs:
            msg = mailbox.MHMessage(_sample_message)
            msg.add_sequence(setting)
1513
            self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
1514 1515 1516 1517
        msg = mailbox.MHMessage(_sample_message)
        msg.add_sequence('unseen')
        msg.add_sequence('replied')
        msg.add_sequence('flagged')
1518 1519
        self.assertEqual(mailbox.BabylMessage(msg).get_labels(),
                         ['unseen', 'answered'])
1520 1521 1522 1523 1524 1525 1526 1527 1528

    def test_babyl_to_maildir(self):
        # Convert BabylMessage to MaildirMessage
        pairs = (('unseen', ''), ('deleted', 'ST'), ('filed', 'S'),
                 ('answered', 'RS'), ('forwarded', 'PS'), ('edited', 'S'),
                 ('resent', 'PS'))
        for setting, result in pairs:
            msg = mailbox.BabylMessage(_sample_message)
            msg.add_label(setting)
1529 1530
            self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
            self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
1531 1532 1533 1534
        msg = mailbox.BabylMessage(_sample_message)
        for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
                      'edited', 'resent'):
            msg.add_label(label)
1535 1536
        self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'PRT')
        self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
1537 1538 1539 1540 1541 1542 1543 1544 1545 1546

    def test_babyl_to_mboxmmdf(self):
        # Convert BabylMessage to mboxMessage and MMDFMessage
        pairs = (('unseen', 'O'), ('deleted', 'ROD'), ('filed', 'RO'),
                 ('answered', 'ROA'), ('forwarded', 'RO'), ('edited', 'RO'),
                 ('resent', 'RO'))
        for setting, result in pairs:
            for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
                msg = mailbox.BabylMessage(_sample_message)
                msg.add_label(setting)
1547
                self.assertEqual(class_(msg).get_flags(), result)
1548 1549 1550 1551 1552
        msg = mailbox.BabylMessage(_sample_message)
        for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
                      'edited', 'resent'):
            msg.add_label(label)
        for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
1553
            self.assertEqual(class_(msg).get_flags(), 'ODA')
1554 1555 1556 1557 1558 1559 1560 1561 1562

    def test_babyl_to_mh(self):
        # Convert BabylMessage to MHMessage
        pairs = (('unseen', ['unseen']), ('deleted', []), ('filed', []),
                 ('answered', ['replied']), ('forwarded', []), ('edited', []),
                 ('resent', []))
        for setting, result in pairs:
            msg = mailbox.BabylMessage(_sample_message)
            msg.add_label(setting)
1563
            self.assertEqual(mailbox.MHMessage(msg).get_sequences(), result)
1564 1565 1566 1567
        msg = mailbox.BabylMessage(_sample_message)
        for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
                      'edited', 'resent'):
            msg.add_label(label)
1568 1569
        self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
                         ['unseen', 'replied'])
1570 1571 1572 1573 1574 1575 1576 1577 1578

    def test_babyl_to_babyl(self):
        # Convert BabylMessage to BabylMessage
        msg = mailbox.BabylMessage(_sample_message)
        msg.update_visible()
        for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
                      'edited', 'resent'):
            msg.add_label(label)
        msg2 = mailbox.BabylMessage(msg)
1579 1580 1581
        self.assertEqual(msg2.get_labels(), ['unseen', 'deleted', 'filed',
                                             'answered', 'forwarded', 'edited',
                                             'resent'])
1582
        self.assertEqual(msg.get_visible().keys(), msg2.get_visible().keys())
1583
        for key in msg.get_visible().keys():
1584
            self.assertEqual(msg.get_visible()[key], msg2.get_visible()[key])
1585 1586 1587 1588 1589 1590 1591


class TestProxyFileBase(TestBase):

    def _test_read(self, proxy):
        # Read by byte
        proxy.seek(0)
1592
        self.assertEqual(proxy.read(), b'bar')
1593
        proxy.seek(1)
1594
        self.assertEqual(proxy.read(), b'ar')
1595
        proxy.seek(0)
1596
        self.assertEqual(proxy.read(2), b'ba')
1597
        proxy.seek(1)
1598
        self.assertEqual(proxy.read(-1), b'ar')
1599
        proxy.seek(2)
1600
        self.assertEqual(proxy.read(1000), b'r')
1601 1602 1603

    def _test_readline(self, proxy):
        # Read by line
1604
        linesep = os.linesep.encode()
1605
        proxy.seek(0)
1606 1607 1608 1609
        self.assertEqual(proxy.readline(), b'foo' + linesep)
        self.assertEqual(proxy.readline(), b'bar' + linesep)
        self.assertEqual(proxy.readline(), b'fred' + linesep)
        self.assertEqual(proxy.readline(), b'bob')
1610
        proxy.seek(2)
1611
        self.assertEqual(proxy.readline(), b'o' + linesep)
1612
        proxy.seek(6 + 2 * len(os.linesep))
1613
        self.assertEqual(proxy.readline(), b'fred' + linesep)
1614
        proxy.seek(6 + 2 * len(os.linesep))
1615 1616
        self.assertEqual(proxy.readline(2), b'fr')
        self.assertEqual(proxy.readline(-10), b'ed' + linesep)
1617 1618 1619

    def _test_readlines(self, proxy):
        # Read multiple lines
1620
        linesep = os.linesep.encode()
1621
        proxy.seek(0)
1622 1623 1624
        self.assertEqual(proxy.readlines(), [b'foo' + linesep,
                                           b'bar' + linesep,
                                           b'fred' + linesep, b'bob'])
1625
        proxy.seek(0)
1626 1627 1628 1629
        self.assertEqual(proxy.readlines(2), [b'foo' + linesep])
        proxy.seek(3 + len(linesep))
        self.assertEqual(proxy.readlines(4 + len(linesep)),
                     [b'bar' + linesep, b'fred' + linesep])
1630
        proxy.seek(3)
1631 1632
        self.assertEqual(proxy.readlines(1000), [linesep, b'bar' + linesep,
                                               b'fred' + linesep, b'bob'])
1633 1634 1635

    def _test_iteration(self, proxy):
        # Iterate by line
1636
        linesep = os.linesep.encode()
1637 1638
        proxy.seek(0)
        iterator = iter(proxy)
1639 1640 1641 1642
        self.assertEqual(next(iterator), b'foo' + linesep)
        self.assertEqual(next(iterator), b'bar' + linesep)
        self.assertEqual(next(iterator), b'fred' + linesep)
        self.assertEqual(next(iterator), b'bob')
1643
        self.assertRaises(StopIteration, next, iterator)
1644 1645 1646

    def _test_seek_and_tell(self, proxy):
        # Seek and use tell to check position
1647
        linesep = os.linesep.encode()
1648
        proxy.seek(3)
1649
        self.assertEqual(proxy.tell(), 3)
1650
        self.assertEqual(proxy.read(len(linesep)), linesep)
1651
        proxy.seek(2, 1)
1652 1653 1654
        self.assertEqual(proxy.read(1 + len(linesep)), b'r' + linesep)
        proxy.seek(-3 - len(linesep), 2)
        self.assertEqual(proxy.read(3), b'bar')
1655
        proxy.seek(2, 0)
1656
        self.assertEqual(proxy.read(), b'o' + linesep + b'bar' + linesep)
1657
        proxy.seek(100)
1658
        self.assertFalse(proxy.read())
1659 1660 1661 1662 1663 1664 1665 1666 1667 1668

    def _test_close(self, proxy):
        # Close a file
        proxy.close()
        self.assertRaises(AttributeError, lambda: proxy.close())


class TestProxyFile(TestProxyFileBase):

    def setUp(self):
1669
        self._path = support.TESTFN
1670 1671 1672 1673 1674 1675 1676 1677
        self._file = open(self._path, 'wb+')

    def tearDown(self):
        self._file.close()
        self._delete_recursively(self._path)

    def test_initialize(self):
        # Initialize and check position
1678
        self._file.write(b'foo')
1679 1680
        pos = self._file.tell()
        proxy0 = mailbox._ProxyFile(self._file)
1681 1682
        self.assertEqual(proxy0.tell(), pos)
        self.assertEqual(self._file.tell(), pos)
1683
        proxy1 = mailbox._ProxyFile(self._file, 0)
1684 1685
        self.assertEqual(proxy1.tell(), 0)
        self.assertEqual(self._file.tell(), pos)
1686 1687

    def test_read(self):
1688
        self._file.write(b'bar')
1689 1690 1691
        self._test_read(mailbox._ProxyFile(self._file))

    def test_readline(self):
1692 1693
        self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
                                                  os.linesep), 'ascii'))
1694 1695 1696
        self._test_readline(mailbox._ProxyFile(self._file))

    def test_readlines(self):
1697 1698
        self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
                                                  os.linesep), 'ascii'))
1699 1700 1701
        self._test_readlines(mailbox._ProxyFile(self._file))

    def test_iteration(self):
1702 1703
        self._file.write(bytes('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
                                                  os.linesep), 'ascii'))
1704 1705 1706
        self._test_iteration(mailbox._ProxyFile(self._file))

    def test_seek_and_tell(self):
1707
        self._file.write(bytes('foo%sbar%s' % (os.linesep, os.linesep), 'ascii'))
1708 1709 1710
        self._test_seek_and_tell(mailbox._ProxyFile(self._file))

    def test_close(self):
1711
        self._file.write(bytes('foo%sbar%s' % (os.linesep, os.linesep), 'ascii'))
1712 1713 1714 1715 1716 1717
        self._test_close(mailbox._ProxyFile(self._file))


class TestPartialFile(TestProxyFileBase):

    def setUp(self):
1718
        self._path = support.TESTFN
1719 1720 1721 1722 1723 1724 1725 1726
        self._file = open(self._path, 'wb+')

    def tearDown(self):
        self._file.close()
        self._delete_recursively(self._path)

    def test_initialize(self):
        # Initialize and check position
1727
        self._file.write(bytes('foo' + os.linesep + 'bar', 'ascii'))
1728 1729
        pos = self._file.tell()
        proxy = mailbox._PartialFile(self._file, 2, 5)
1730 1731
        self.assertEqual(proxy.tell(), 0)
        self.assertEqual(self._file.tell(), pos)
1732 1733

    def test_read(self):
1734
        self._file.write(bytes('***bar***', 'ascii'))
1735 1736 1737
        self._test_read(mailbox._PartialFile(self._file, 3, 6))

    def test_readline(self):
1738 1739
        self._file.write(bytes('!!!!!foo%sbar%sfred%sbob!!!!!' %
                         (os.linesep, os.linesep, os.linesep), 'ascii'))
1740 1741 1742 1743
        self._test_readline(mailbox._PartialFile(self._file, 5,
                                                 18 + 3 * len(os.linesep)))

    def test_readlines(self):
1744 1745
        self._file.write(bytes('foo%sbar%sfred%sbob?????' %
                         (os.linesep, os.linesep, os.linesep), 'ascii'))
1746 1747 1748 1749
        self._test_readlines(mailbox._PartialFile(self._file, 0,
                                                  13 + 3 * len(os.linesep)))

    def test_iteration(self):
1750 1751
        self._file.write(bytes('____foo%sbar%sfred%sbob####' %
                         (os.linesep, os.linesep, os.linesep), 'ascii'))
1752 1753 1754 1755
        self._test_iteration(mailbox._PartialFile(self._file, 4,
                                                  17 + 3 * len(os.linesep)))

    def test_seek_and_tell(self):
1756
        self._file.write(bytes('(((foo%sbar%s$$$' % (os.linesep, os.linesep), 'ascii'))
1757 1758 1759 1760
        self._test_seek_and_tell(mailbox._PartialFile(self._file, 3,
                                                      9 + 2 * len(os.linesep)))

    def test_close(self):
1761
        self._file.write(bytes('&foo%sbar%s^' % (os.linesep, os.linesep), 'ascii'))
1762 1763 1764 1765 1766 1767
        self._test_close(mailbox._PartialFile(self._file, 1,
                                              6 + 3 * len(os.linesep)))


## Start: tests from the original module (for backward compatibility).

1768
FROM_ = "From some.body@dummy.domain  Sat Jul 24 13:43:35 2004\n"
1769 1770 1771
DUMMY_MESSAGE = """\
From: some.body@dummy.domain
To: me@my.domain
1772
Subject: Simple Test
1773 1774 1775 1776 1777 1778 1779 1780

This is a dummy message.
"""

class MaildirTestCase(unittest.TestCase):

    def setUp(self):
        # create a new maildir mailbox to work with:
1781
        self._dir = support.TESTFN
1782 1783 1784 1785 1786 1787 1788 1789
        os.mkdir(self._dir)
        os.mkdir(os.path.join(self._dir, "cur"))
        os.mkdir(os.path.join(self._dir, "tmp"))
        os.mkdir(os.path.join(self._dir, "new"))
        self._counter = 1
        self._msgfiles = []

    def tearDown(self):
1790
        list(map(os.unlink, self._msgfiles))
1791 1792 1793 1794 1795
        os.rmdir(os.path.join(self._dir, "cur"))
        os.rmdir(os.path.join(self._dir, "tmp"))
        os.rmdir(os.path.join(self._dir, "new"))
        os.rmdir(self._dir)

1796
    def createMessage(self, dir, mbox=False):
1797
        t = int(time.time() % 1000000)
1798 1799
        pid = self._counter
        self._counter += 1
Skip Montanaro's avatar
Skip Montanaro committed
1800
        filename = ".".join((str(t), str(pid), "myhostname", "mydomain"))
1801 1802 1803 1804
        tmpname = os.path.join(self._dir, "tmp", filename)
        newname = os.path.join(self._dir, dir, filename)
        fp = open(tmpname, "w")
        self._msgfiles.append(tmpname)
1805 1806
        if mbox:
            fp.write(FROM_)
1807 1808
        fp.write(DUMMY_MESSAGE)
        fp.close()
1809 1810 1811 1812 1813 1814
        if hasattr(os, "link"):
            os.link(tmpname, newname)
        else:
            fp = open(newname, "w")
            fp.write(DUMMY_MESSAGE)
            fp.close()
1815
        self._msgfiles.append(newname)
1816
        return tmpname
1817 1818 1819 1820 1821

    def test_empty_maildir(self):
        """Test an empty maildir mailbox"""
        # Test for regression on bug #117490:
        # Make sure the boxes attribute actually gets set.
1822
        self.mbox = mailbox.Maildir(support.TESTFN)
1823
        #self.assertTrue(hasattr(self.mbox, "boxes"))
1824
        #self.assertEqual(len(self.mbox.boxes), 0)
1825 1826
        self.assertIs(self.mbox.next(), None)
        self.assertIs(self.mbox.next(), None)
1827 1828 1829

    def test_nonempty_maildir_cur(self):
        self.createMessage("cur")
1830
        self.mbox = mailbox.Maildir(support.TESTFN)
1831
        #self.assertEqual(len(self.mbox.boxes), 1)
1832 1833 1834
        self.assertIsNot(self.mbox.next(), None)
        self.assertIs(self.mbox.next(), None)
        self.assertIs(self.mbox.next(), None)
1835 1836 1837

    def test_nonempty_maildir_new(self):
        self.createMessage("new")
1838
        self.mbox = mailbox.Maildir(support.TESTFN)
1839
        #self.assertEqual(len(self.mbox.boxes), 1)
1840 1841 1842
        self.assertIsNot(self.mbox.next(), None)
        self.assertIs(self.mbox.next(), None)
        self.assertIs(self.mbox.next(), None)
1843 1844 1845 1846

    def test_nonempty_maildir_both(self):
        self.createMessage("cur")
        self.createMessage("new")
1847
        self.mbox = mailbox.Maildir(support.TESTFN)
1848
        #self.assertEqual(len(self.mbox.boxes), 2)
1849 1850 1851 1852
        self.assertIsNot(self.mbox.next(), None)
        self.assertIsNot(self.mbox.next(), None)
        self.assertIs(self.mbox.next(), None)
        self.assertIs(self.mbox.next(), None)
1853

1854
## End: tests from the original module (for backward compatibility).
1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936


_sample_message = """\
Return-Path: <gkj@gregorykjohnson.com>
X-Original-To: gkj+person@localhost
Delivered-To: gkj+person@localhost
Received: from localhost (localhost [127.0.0.1])
        by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
        for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
Delivered-To: gkj@sundance.gregorykjohnson.com
Received: from localhost [127.0.0.1]
        by localhost with POP3 (fetchmail-6.2.5)
        for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
Received: from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
        by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
        for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
Received: by andy.gregorykjohnson.com (Postfix, from userid 1000)
        id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
Date: Wed, 13 Jul 2005 17:23:11 -0400
From: "Gregory K. Johnson" <gkj@gregorykjohnson.com>
To: gkj@gregorykjohnson.com
Subject: Sample message
Message-ID: <20050713212311.GC4701@andy.gregorykjohnson.com>
Mime-Version: 1.0
Content-Type: multipart/mixed; boundary="NMuMz9nt05w80d4+"
Content-Disposition: inline
User-Agent: Mutt/1.5.9i


--NMuMz9nt05w80d4+
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

This is a sample message.

--
Gregory K. Johnson

--NMuMz9nt05w80d4+
Content-Type: application/octet-stream
Content-Disposition: attachment; filename="text.gz"
Content-Transfer-Encoding: base64

H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
3FYlAAAA

--NMuMz9nt05w80d4+--
"""

_sample_headers = {
    "Return-Path":"<gkj@gregorykjohnson.com>",
    "X-Original-To":"gkj+person@localhost",
    "Delivered-To":"gkj+person@localhost",
    "Received":"""from localhost (localhost [127.0.0.1])
        by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
        for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
    "Delivered-To":"gkj@sundance.gregorykjohnson.com",
    "Received":"""from localhost [127.0.0.1]
        by localhost with POP3 (fetchmail-6.2.5)
        for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
    "Received":"""from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
        by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
        for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
    "Received":"""by andy.gregorykjohnson.com (Postfix, from userid 1000)
        id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
    "Date":"Wed, 13 Jul 2005 17:23:11 -0400",
    "From":""""Gregory K. Johnson" <gkj@gregorykjohnson.com>""",
    "To":"gkj@gregorykjohnson.com",
    "Subject":"Sample message",
    "Mime-Version":"1.0",
    "Content-Type":"""multipart/mixed; boundary="NMuMz9nt05w80d4+\"""",
    "Content-Disposition":"inline",
    "User-Agent": "Mutt/1.5.9i" }

_sample_payloads = ("""This is a sample message.

--
Gregory K. Johnson
""",
"""H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
3FYlAAAA
""")
1937

1938

1939
def test_main():
1940 1941 1942 1943 1944
    tests = (TestMailboxSuperclass, TestMaildir, TestMbox, TestMMDF, TestMH,
             TestBabyl, TestMessage, TestMaildirMessage, TestMboxMessage,
             TestMHMessage, TestBabylMessage, TestMMDFMessage,
             TestMessageConversion, TestProxyFile, TestPartialFile,
             MaildirTestCase)
1945 1946
    support.run_unittest(*tests)
    support.reap_children()
1947 1948


1949
if __name__ == '__main__':
1950
    test_main()