PageRenderTime 63ms CodeModel.GetById 25ms RepoModel.GetById 0ms app.codeStats 1ms

/lib-python/2.7/test/test_mailbox.py

https://bitbucket.org/yrttyr/pypy
Python | 2016 lines | 1851 code | 85 blank | 80 comment | 60 complexity | 2bdea442a19270f27bdb462b86d799a8 MD5 | raw file
  1. import os
  2. import sys
  3. import time
  4. import stat
  5. import socket
  6. import email
  7. import email.message
  8. import re
  9. import StringIO
  10. from test import test_support
  11. import unittest
  12. import mailbox
  13. import glob
  14. try:
  15. import fcntl
  16. except ImportError:
  17. pass
  18. # Silence Py3k warning
  19. rfc822 = test_support.import_module('rfc822', deprecated=True)
  20. class TestBase(unittest.TestCase):
  21. def _check_sample(self, msg):
  22. # Inspect a mailbox.Message representation of the sample message
  23. self.assertIsInstance(msg, email.message.Message)
  24. self.assertIsInstance(msg, mailbox.Message)
  25. for key, value in _sample_headers.iteritems():
  26. self.assertIn(value, msg.get_all(key))
  27. self.assertTrue(msg.is_multipart())
  28. self.assertEqual(len(msg.get_payload()), len(_sample_payloads))
  29. for i, payload in enumerate(_sample_payloads):
  30. part = msg.get_payload(i)
  31. self.assertIsInstance(part, email.message.Message)
  32. self.assertNotIsInstance(part, mailbox.Message)
  33. self.assertEqual(part.get_payload(), payload)
  34. def _delete_recursively(self, target):
  35. # Delete a file or delete a directory recursively
  36. if os.path.isdir(target):
  37. for path, dirs, files in os.walk(target, topdown=False):
  38. for name in files:
  39. os.remove(os.path.join(path, name))
  40. for name in dirs:
  41. os.rmdir(os.path.join(path, name))
  42. os.rmdir(target)
  43. elif os.path.exists(target):
  44. os.remove(target)
  45. class TestMailbox(TestBase):
  46. _factory = None # Overridden by subclasses to reuse tests
  47. _template = 'From: foo\n\n%s'
  48. def setUp(self):
  49. self._path = test_support.TESTFN
  50. self._delete_recursively(self._path)
  51. self._box = self._factory(self._path)
  52. def tearDown(self):
  53. self._box.close()
  54. self._delete_recursively(self._path)
  55. def test_add(self):
  56. # Add copies of a sample message
  57. keys = []
  58. keys.append(self._box.add(self._template % 0))
  59. self.assertEqual(len(self._box), 1)
  60. keys.append(self._box.add(mailbox.Message(_sample_message)))
  61. self.assertEqual(len(self._box), 2)
  62. keys.append(self._box.add(email.message_from_string(_sample_message)))
  63. self.assertEqual(len(self._box), 3)
  64. keys.append(self._box.add(StringIO.StringIO(_sample_message)))
  65. self.assertEqual(len(self._box), 4)
  66. keys.append(self._box.add(_sample_message))
  67. self.assertEqual(len(self._box), 5)
  68. self.assertEqual(self._box.get_string(keys[0]), self._template % 0)
  69. for i in (1, 2, 3, 4):
  70. self._check_sample(self._box[keys[i]])
  71. def test_remove(self):
  72. # Remove messages using remove()
  73. self._test_remove_or_delitem(self._box.remove)
  74. def test_delitem(self):
  75. # Remove messages using __delitem__()
  76. self._test_remove_or_delitem(self._box.__delitem__)
  77. def _test_remove_or_delitem(self, method):
  78. # (Used by test_remove() and test_delitem().)
  79. key0 = self._box.add(self._template % 0)
  80. key1 = self._box.add(self._template % 1)
  81. self.assertEqual(len(self._box), 2)
  82. method(key0)
  83. l = len(self._box)
  84. self.assertEqual(l, 1)
  85. self.assertRaises(KeyError, lambda: self._box[key0])
  86. self.assertRaises(KeyError, lambda: method(key0))
  87. self.assertEqual(self._box.get_string(key1), self._template % 1)
  88. key2 = self._box.add(self._template % 2)
  89. self.assertEqual(len(self._box), 2)
  90. method(key2)
  91. l = len(self._box)
  92. self.assertEqual(l, 1)
  93. self.assertRaises(KeyError, lambda: self._box[key2])
  94. self.assertRaises(KeyError, lambda: method(key2))
  95. self.assertEqual(self._box.get_string(key1), self._template % 1)
  96. method(key1)
  97. self.assertEqual(len(self._box), 0)
  98. self.assertRaises(KeyError, lambda: self._box[key1])
  99. self.assertRaises(KeyError, lambda: method(key1))
  100. def test_discard(self, repetitions=10):
  101. # Discard messages
  102. key0 = self._box.add(self._template % 0)
  103. key1 = self._box.add(self._template % 1)
  104. self.assertEqual(len(self._box), 2)
  105. self._box.discard(key0)
  106. self.assertEqual(len(self._box), 1)
  107. self.assertRaises(KeyError, lambda: self._box[key0])
  108. self._box.discard(key0)
  109. self.assertEqual(len(self._box), 1)
  110. self.assertRaises(KeyError, lambda: self._box[key0])
  111. def test_get(self):
  112. # Retrieve messages using get()
  113. key0 = self._box.add(self._template % 0)
  114. msg = self._box.get(key0)
  115. self.assertEqual(msg['from'], 'foo')
  116. self.assertEqual(msg.get_payload(), '0')
  117. self.assertIs(self._box.get('foo'), None)
  118. self.assertFalse(self._box.get('foo', False))
  119. self._box.close()
  120. self._box = self._factory(self._path, factory=rfc822.Message)
  121. key1 = self._box.add(self._template % 1)
  122. msg = self._box.get(key1)
  123. self.assertEqual(msg['from'], 'foo')
  124. self.assertEqual(msg.fp.read(), '1')
  125. def test_getitem(self):
  126. # Retrieve message using __getitem__()
  127. key0 = self._box.add(self._template % 0)
  128. msg = self._box[key0]
  129. self.assertEqual(msg['from'], 'foo')
  130. self.assertEqual(msg.get_payload(), '0')
  131. self.assertRaises(KeyError, lambda: self._box['foo'])
  132. self._box.discard(key0)
  133. self.assertRaises(KeyError, lambda: self._box[key0])
  134. def test_get_message(self):
  135. # Get Message representations of messages
  136. key0 = self._box.add(self._template % 0)
  137. key1 = self._box.add(_sample_message)
  138. msg0 = self._box.get_message(key0)
  139. self.assertIsInstance(msg0, mailbox.Message)
  140. self.assertEqual(msg0['from'], 'foo')
  141. self.assertEqual(msg0.get_payload(), '0')
  142. self._check_sample(self._box.get_message(key1))
  143. def test_get_string(self):
  144. # Get string representations of messages
  145. key0 = self._box.add(self._template % 0)
  146. key1 = self._box.add(_sample_message)
  147. self.assertEqual(self._box.get_string(key0), self._template % 0)
  148. self.assertEqual(self._box.get_string(key1), _sample_message)
  149. def test_get_file(self):
  150. # Get file representations of messages
  151. key0 = self._box.add(self._template % 0)
  152. key1 = self._box.add(_sample_message)
  153. self.assertEqual(self._box.get_file(key0).read().replace(os.linesep, '\n'),
  154. self._template % 0)
  155. self.assertEqual(self._box.get_file(key1).read().replace(os.linesep, '\n'),
  156. _sample_message)
  157. def test_get_file_can_be_closed_twice(self):
  158. # Issue 11700
  159. key = self._box.add(_sample_message)
  160. f = self._box.get_file(key)
  161. f.close()
  162. f.close()
  163. def test_iterkeys(self):
  164. # Get keys using iterkeys()
  165. self._check_iteration(self._box.iterkeys, do_keys=True, do_values=False)
  166. def test_keys(self):
  167. # Get keys using keys()
  168. self._check_iteration(self._box.keys, do_keys=True, do_values=False)
  169. def test_itervalues(self):
  170. # Get values using itervalues()
  171. self._check_iteration(self._box.itervalues, do_keys=False,
  172. do_values=True)
  173. def test_iter(self):
  174. # Get values using __iter__()
  175. self._check_iteration(self._box.__iter__, do_keys=False,
  176. do_values=True)
  177. def test_values(self):
  178. # Get values using values()
  179. self._check_iteration(self._box.values, do_keys=False, do_values=True)
  180. def test_iteritems(self):
  181. # Get keys and values using iteritems()
  182. self._check_iteration(self._box.iteritems, do_keys=True,
  183. do_values=True)
  184. def test_items(self):
  185. # Get keys and values using items()
  186. self._check_iteration(self._box.items, do_keys=True, do_values=True)
  187. def _check_iteration(self, method, do_keys, do_values, repetitions=10):
  188. for value in method():
  189. self.fail("Not empty")
  190. keys, values = [], []
  191. for i in xrange(repetitions):
  192. keys.append(self._box.add(self._template % i))
  193. values.append(self._template % i)
  194. if do_keys and not do_values:
  195. returned_keys = list(method())
  196. elif do_values and not do_keys:
  197. returned_values = list(method())
  198. else:
  199. returned_keys, returned_values = [], []
  200. for key, value in method():
  201. returned_keys.append(key)
  202. returned_values.append(value)
  203. if do_keys:
  204. self.assertEqual(len(keys), len(returned_keys))
  205. self.assertEqual(set(keys), set(returned_keys))
  206. if do_values:
  207. count = 0
  208. for value in returned_values:
  209. self.assertEqual(value['from'], 'foo')
  210. self.assertTrue(int(value.get_payload()) < repetitions,
  211. (value.get_payload(), repetitions))
  212. count += 1
  213. self.assertEqual(len(values), count)
  214. def test_has_key(self):
  215. # Check existence of keys using has_key()
  216. self._test_has_key_or_contains(self._box.has_key)
  217. def test_contains(self):
  218. # Check existence of keys using __contains__()
  219. self._test_has_key_or_contains(self._box.__contains__)
  220. def _test_has_key_or_contains(self, method):
  221. # (Used by test_has_key() and test_contains().)
  222. self.assertFalse(method('foo'))
  223. key0 = self._box.add(self._template % 0)
  224. self.assertTrue(method(key0))
  225. self.assertFalse(method('foo'))
  226. key1 = self._box.add(self._template % 1)
  227. self.assertTrue(method(key1))
  228. self.assertTrue(method(key0))
  229. self.assertFalse(method('foo'))
  230. self._box.remove(key0)
  231. self.assertFalse(method(key0))
  232. self.assertTrue(method(key1))
  233. self.assertFalse(method('foo'))
  234. self._box.remove(key1)
  235. self.assertFalse(method(key1))
  236. self.assertFalse(method(key0))
  237. self.assertFalse(method('foo'))
  238. def test_len(self, repetitions=10):
  239. # Get message count
  240. keys = []
  241. for i in xrange(repetitions):
  242. self.assertEqual(len(self._box), i)
  243. keys.append(self._box.add(self._template % i))
  244. self.assertEqual(len(self._box), i + 1)
  245. for i in xrange(repetitions):
  246. self.assertEqual(len(self._box), repetitions - i)
  247. self._box.remove(keys[i])
  248. self.assertEqual(len(self._box), repetitions - i - 1)
  249. def test_set_item(self):
  250. # Modify messages using __setitem__()
  251. key0 = self._box.add(self._template % 'original 0')
  252. self.assertEqual(self._box.get_string(key0),
  253. self._template % 'original 0')
  254. key1 = self._box.add(self._template % 'original 1')
  255. self.assertEqual(self._box.get_string(key1),
  256. self._template % 'original 1')
  257. self._box[key0] = self._template % 'changed 0'
  258. self.assertEqual(self._box.get_string(key0),
  259. self._template % 'changed 0')
  260. self._box[key1] = self._template % 'changed 1'
  261. self.assertEqual(self._box.get_string(key1),
  262. self._template % 'changed 1')
  263. self._box[key0] = _sample_message
  264. self._check_sample(self._box[key0])
  265. self._box[key1] = self._box[key0]
  266. self._check_sample(self._box[key1])
  267. self._box[key0] = self._template % 'original 0'
  268. self.assertEqual(self._box.get_string(key0),
  269. self._template % 'original 0')
  270. self._check_sample(self._box[key1])
  271. self.assertRaises(KeyError,
  272. lambda: self._box.__setitem__('foo', 'bar'))
  273. self.assertRaises(KeyError, lambda: self._box['foo'])
  274. self.assertEqual(len(self._box), 2)
  275. def test_clear(self, iterations=10):
  276. # Remove all messages using clear()
  277. keys = []
  278. for i in xrange(iterations):
  279. self._box.add(self._template % i)
  280. for i, key in enumerate(keys):
  281. self.assertEqual(self._box.get_string(key), self._template % i)
  282. self._box.clear()
  283. self.assertEqual(len(self._box), 0)
  284. for i, key in enumerate(keys):
  285. self.assertRaises(KeyError, lambda: self._box.get_string(key))
  286. def test_pop(self):
  287. # Get and remove a message using pop()
  288. key0 = self._box.add(self._template % 0)
  289. self.assertIn(key0, self._box)
  290. key1 = self._box.add(self._template % 1)
  291. self.assertIn(key1, self._box)
  292. self.assertEqual(self._box.pop(key0).get_payload(), '0')
  293. self.assertNotIn(key0, self._box)
  294. self.assertIn(key1, self._box)
  295. key2 = self._box.add(self._template % 2)
  296. self.assertIn(key2, self._box)
  297. self.assertEqual(self._box.pop(key2).get_payload(), '2')
  298. self.assertNotIn(key2, self._box)
  299. self.assertIn(key1, self._box)
  300. self.assertEqual(self._box.pop(key1).get_payload(), '1')
  301. self.assertNotIn(key1, self._box)
  302. self.assertEqual(len(self._box), 0)
  303. def test_popitem(self, iterations=10):
  304. # Get and remove an arbitrary (key, message) using popitem()
  305. keys = []
  306. for i in xrange(10):
  307. keys.append(self._box.add(self._template % i))
  308. seen = []
  309. for i in xrange(10):
  310. key, msg = self._box.popitem()
  311. self.assertIn(key, keys)
  312. self.assertNotIn(key, seen)
  313. seen.append(key)
  314. self.assertEqual(int(msg.get_payload()), keys.index(key))
  315. self.assertEqual(len(self._box), 0)
  316. for key in keys:
  317. self.assertRaises(KeyError, lambda: self._box[key])
  318. def test_update(self):
  319. # Modify multiple messages using update()
  320. key0 = self._box.add(self._template % 'original 0')
  321. key1 = self._box.add(self._template % 'original 1')
  322. key2 = self._box.add(self._template % 'original 2')
  323. self._box.update({key0: self._template % 'changed 0',
  324. key2: _sample_message})
  325. self.assertEqual(len(self._box), 3)
  326. self.assertEqual(self._box.get_string(key0),
  327. self._template % 'changed 0')
  328. self.assertEqual(self._box.get_string(key1),
  329. self._template % 'original 1')
  330. self._check_sample(self._box[key2])
  331. self._box.update([(key2, self._template % 'changed 2'),
  332. (key1, self._template % 'changed 1'),
  333. (key0, self._template % 'original 0')])
  334. self.assertEqual(len(self._box), 3)
  335. self.assertEqual(self._box.get_string(key0),
  336. self._template % 'original 0')
  337. self.assertEqual(self._box.get_string(key1),
  338. self._template % 'changed 1')
  339. self.assertEqual(self._box.get_string(key2),
  340. self._template % 'changed 2')
  341. self.assertRaises(KeyError,
  342. lambda: self._box.update({'foo': 'bar',
  343. key0: self._template % "changed 0"}))
  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. self._template % "changed 1")
  349. self.assertEqual(self._box.get_string(key2),
  350. self._template % "changed 2")
  351. def test_flush(self):
  352. # Write changes to disk
  353. self._test_flush_or_close(self._box.flush, True)
  354. def test_lock_unlock(self):
  355. # Lock and unlock the mailbox
  356. self.assertFalse(os.path.exists(self._get_lock_path()))
  357. self._box.lock()
  358. self.assertTrue(os.path.exists(self._get_lock_path()))
  359. self._box.unlock()
  360. self.assertFalse(os.path.exists(self._get_lock_path()))
  361. def test_close(self):
  362. # Close mailbox and flush changes to disk
  363. self._test_flush_or_close(self._box.close, False)
  364. def _test_flush_or_close(self, method, should_call_close):
  365. contents = [self._template % i for i in xrange(3)]
  366. self._box.add(contents[0])
  367. self._box.add(contents[1])
  368. self._box.add(contents[2])
  369. method()
  370. if should_call_close:
  371. self._box.close()
  372. self._box = self._factory(self._path)
  373. keys = self._box.keys()
  374. self.assertEqual(len(keys), 3)
  375. for key in keys:
  376. self.assertIn(self._box.get_string(key), contents)
  377. def test_dump_message(self):
  378. # Write message representations to disk
  379. for input in (email.message_from_string(_sample_message),
  380. _sample_message, StringIO.StringIO(_sample_message)):
  381. output = StringIO.StringIO()
  382. self._box._dump_message(input, output)
  383. self.assertEqual(output.getvalue(),
  384. _sample_message.replace('\n', os.linesep))
  385. output = StringIO.StringIO()
  386. self.assertRaises(TypeError,
  387. lambda: self._box._dump_message(None, output))
  388. def _get_lock_path(self):
  389. # Return the path of the dot lock file. May be overridden.
  390. return self._path + '.lock'
  391. class TestMailboxSuperclass(TestBase):
  392. def test_notimplemented(self):
  393. # Test that all Mailbox methods raise NotImplementedException.
  394. box = mailbox.Mailbox('path')
  395. self.assertRaises(NotImplementedError, lambda: box.add(''))
  396. self.assertRaises(NotImplementedError, lambda: box.remove(''))
  397. self.assertRaises(NotImplementedError, lambda: box.__delitem__(''))
  398. self.assertRaises(NotImplementedError, lambda: box.discard(''))
  399. self.assertRaises(NotImplementedError, lambda: box.__setitem__('', ''))
  400. self.assertRaises(NotImplementedError, lambda: box.iterkeys())
  401. self.assertRaises(NotImplementedError, lambda: box.keys())
  402. self.assertRaises(NotImplementedError, lambda: box.itervalues().next())
  403. self.assertRaises(NotImplementedError, lambda: box.__iter__().next())
  404. self.assertRaises(NotImplementedError, lambda: box.values())
  405. self.assertRaises(NotImplementedError, lambda: box.iteritems().next())
  406. self.assertRaises(NotImplementedError, lambda: box.items())
  407. self.assertRaises(NotImplementedError, lambda: box.get(''))
  408. self.assertRaises(NotImplementedError, lambda: box.__getitem__(''))
  409. self.assertRaises(NotImplementedError, lambda: box.get_message(''))
  410. self.assertRaises(NotImplementedError, lambda: box.get_string(''))
  411. self.assertRaises(NotImplementedError, lambda: box.get_file(''))
  412. self.assertRaises(NotImplementedError, lambda: box.has_key(''))
  413. self.assertRaises(NotImplementedError, lambda: box.__contains__(''))
  414. self.assertRaises(NotImplementedError, lambda: box.__len__())
  415. self.assertRaises(NotImplementedError, lambda: box.clear())
  416. self.assertRaises(NotImplementedError, lambda: box.pop(''))
  417. self.assertRaises(NotImplementedError, lambda: box.popitem())
  418. self.assertRaises(NotImplementedError, lambda: box.update((('', ''),)))
  419. self.assertRaises(NotImplementedError, lambda: box.flush())
  420. self.assertRaises(NotImplementedError, lambda: box.lock())
  421. self.assertRaises(NotImplementedError, lambda: box.unlock())
  422. self.assertRaises(NotImplementedError, lambda: box.close())
  423. class TestMaildir(TestMailbox):
  424. _factory = lambda self, path, factory=None: mailbox.Maildir(path, factory)
  425. def setUp(self):
  426. TestMailbox.setUp(self)
  427. if os.name in ('nt', 'os2') or sys.platform == 'cygwin':
  428. self._box.colon = '!'
  429. def test_add_MM(self):
  430. # Add a MaildirMessage instance
  431. msg = mailbox.MaildirMessage(self._template % 0)
  432. msg.set_subdir('cur')
  433. msg.set_info('foo')
  434. key = self._box.add(msg)
  435. self.assertTrue(os.path.exists(os.path.join(self._path, 'cur', '%s%sfoo' %
  436. (key, self._box.colon))))
  437. def test_get_MM(self):
  438. # Get a MaildirMessage instance
  439. msg = mailbox.MaildirMessage(self._template % 0)
  440. msg.set_subdir('cur')
  441. msg.set_flags('RF')
  442. key = self._box.add(msg)
  443. msg_returned = self._box.get_message(key)
  444. self.assertIsInstance(msg_returned, mailbox.MaildirMessage)
  445. self.assertEqual(msg_returned.get_subdir(), 'cur')
  446. self.assertEqual(msg_returned.get_flags(), 'FR')
  447. def test_set_MM(self):
  448. # Set with a MaildirMessage instance
  449. msg0 = mailbox.MaildirMessage(self._template % 0)
  450. msg0.set_flags('TP')
  451. key = self._box.add(msg0)
  452. msg_returned = self._box.get_message(key)
  453. self.assertEqual(msg_returned.get_subdir(), 'new')
  454. self.assertEqual(msg_returned.get_flags(), 'PT')
  455. msg1 = mailbox.MaildirMessage(self._template % 1)
  456. self._box[key] = msg1
  457. msg_returned = self._box.get_message(key)
  458. self.assertEqual(msg_returned.get_subdir(), 'new')
  459. self.assertEqual(msg_returned.get_flags(), '')
  460. self.assertEqual(msg_returned.get_payload(), '1')
  461. msg2 = mailbox.MaildirMessage(self._template % 2)
  462. msg2.set_info('2,S')
  463. self._box[key] = msg2
  464. self._box[key] = self._template % 3
  465. msg_returned = self._box.get_message(key)
  466. self.assertEqual(msg_returned.get_subdir(), 'new')
  467. self.assertEqual(msg_returned.get_flags(), 'S')
  468. self.assertEqual(msg_returned.get_payload(), '3')
  469. def test_consistent_factory(self):
  470. # Add a message.
  471. msg = mailbox.MaildirMessage(self._template % 0)
  472. msg.set_subdir('cur')
  473. msg.set_flags('RF')
  474. key = self._box.add(msg)
  475. # Create new mailbox with
  476. class FakeMessage(mailbox.MaildirMessage):
  477. pass
  478. box = mailbox.Maildir(self._path, factory=FakeMessage)
  479. box.colon = self._box.colon
  480. msg2 = box.get_message(key)
  481. self.assertIsInstance(msg2, FakeMessage)
  482. def test_initialize_new(self):
  483. # Initialize a non-existent mailbox
  484. self.tearDown()
  485. self._box = mailbox.Maildir(self._path)
  486. self._check_basics(factory=rfc822.Message)
  487. self._delete_recursively(self._path)
  488. self._box = self._factory(self._path, factory=None)
  489. self._check_basics()
  490. def test_initialize_existing(self):
  491. # Initialize an existing mailbox
  492. self.tearDown()
  493. for subdir in '', 'tmp', 'new', 'cur':
  494. os.mkdir(os.path.normpath(os.path.join(self._path, subdir)))
  495. self._box = mailbox.Maildir(self._path)
  496. self._check_basics(factory=rfc822.Message)
  497. self._box = mailbox.Maildir(self._path, factory=None)
  498. self._check_basics()
  499. def _check_basics(self, factory=None):
  500. # (Used by test_open_new() and test_open_existing().)
  501. self.assertEqual(self._box._path, os.path.abspath(self._path))
  502. self.assertEqual(self._box._factory, factory)
  503. for subdir in '', 'tmp', 'new', 'cur':
  504. path = os.path.join(self._path, subdir)
  505. mode = os.stat(path)[stat.ST_MODE]
  506. self.assertTrue(stat.S_ISDIR(mode), "Not a directory: '%s'" % path)
  507. def test_list_folders(self):
  508. # List folders
  509. self._box.add_folder('one')
  510. self._box.add_folder('two')
  511. self._box.add_folder('three')
  512. self.assertEqual(len(self._box.list_folders()), 3)
  513. self.assertEqual(set(self._box.list_folders()),
  514. set(('one', 'two', 'three')))
  515. def test_get_folder(self):
  516. # Open folders
  517. self._box.add_folder('foo.bar')
  518. folder0 = self._box.get_folder('foo.bar')
  519. folder0.add(self._template % 'bar')
  520. self.assertTrue(os.path.isdir(os.path.join(self._path, '.foo.bar')))
  521. folder1 = self._box.get_folder('foo.bar')
  522. self.assertEqual(folder1.get_string(folder1.keys()[0]),
  523. self._template % 'bar')
  524. def test_add_and_remove_folders(self):
  525. # Delete folders
  526. self._box.add_folder('one')
  527. self._box.add_folder('two')
  528. self.assertEqual(len(self._box.list_folders()), 2)
  529. self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
  530. self._box.remove_folder('one')
  531. self.assertEqual(len(self._box.list_folders()), 1)
  532. self.assertEqual(set(self._box.list_folders()), set(('two',)))
  533. self._box.add_folder('three')
  534. self.assertEqual(len(self._box.list_folders()), 2)
  535. self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
  536. self._box.remove_folder('three')
  537. self.assertEqual(len(self._box.list_folders()), 1)
  538. self.assertEqual(set(self._box.list_folders()), set(('two',)))
  539. self._box.remove_folder('two')
  540. self.assertEqual(len(self._box.list_folders()), 0)
  541. self.assertEqual(self._box.list_folders(), [])
  542. def test_clean(self):
  543. # Remove old files from 'tmp'
  544. foo_path = os.path.join(self._path, 'tmp', 'foo')
  545. bar_path = os.path.join(self._path, 'tmp', 'bar')
  546. with open(foo_path, 'w') as f:
  547. f.write("@")
  548. with open(bar_path, 'w') as f:
  549. f.write("@")
  550. self._box.clean()
  551. self.assertTrue(os.path.exists(foo_path))
  552. self.assertTrue(os.path.exists(bar_path))
  553. foo_stat = os.stat(foo_path)
  554. os.utime(foo_path, (time.time() - 129600 - 2,
  555. foo_stat.st_mtime))
  556. self._box.clean()
  557. self.assertFalse(os.path.exists(foo_path))
  558. self.assertTrue(os.path.exists(bar_path))
  559. def test_create_tmp(self, repetitions=10):
  560. # Create files in tmp directory
  561. hostname = socket.gethostname()
  562. if '/' in hostname:
  563. hostname = hostname.replace('/', r'\057')
  564. if ':' in hostname:
  565. hostname = hostname.replace(':', r'\072')
  566. pid = os.getpid()
  567. pattern = re.compile(r"(?P<time>\d+)\.M(?P<M>\d{1,6})P(?P<P>\d+)"
  568. r"Q(?P<Q>\d+)\.(?P<host>[^:/]+)")
  569. previous_groups = None
  570. for x in xrange(repetitions):
  571. tmp_file = self._box._create_tmp()
  572. head, tail = os.path.split(tmp_file.name)
  573. self.assertEqual(head, os.path.abspath(os.path.join(self._path,
  574. "tmp")),
  575. "File in wrong location: '%s'" % head)
  576. match = pattern.match(tail)
  577. self.assertTrue(match is not None, "Invalid file name: '%s'" % tail)
  578. groups = match.groups()
  579. if previous_groups is not None:
  580. self.assertTrue(int(groups[0] >= previous_groups[0]),
  581. "Non-monotonic seconds: '%s' before '%s'" %
  582. (previous_groups[0], groups[0]))
  583. self.assertTrue(int(groups[1] >= previous_groups[1]) or
  584. groups[0] != groups[1],
  585. "Non-monotonic milliseconds: '%s' before '%s'" %
  586. (previous_groups[1], groups[1]))
  587. self.assertTrue(int(groups[2]) == pid,
  588. "Process ID mismatch: '%s' should be '%s'" %
  589. (groups[2], pid))
  590. self.assertTrue(int(groups[3]) == int(previous_groups[3]) + 1,
  591. "Non-sequential counter: '%s' before '%s'" %
  592. (previous_groups[3], groups[3]))
  593. self.assertTrue(groups[4] == hostname,
  594. "Host name mismatch: '%s' should be '%s'" %
  595. (groups[4], hostname))
  596. previous_groups = groups
  597. tmp_file.write(_sample_message)
  598. tmp_file.seek(0)
  599. self.assertTrue(tmp_file.read() == _sample_message)
  600. tmp_file.close()
  601. file_count = len(os.listdir(os.path.join(self._path, "tmp")))
  602. self.assertTrue(file_count == repetitions,
  603. "Wrong file count: '%s' should be '%s'" %
  604. (file_count, repetitions))
  605. def test_refresh(self):
  606. # Update the table of contents
  607. self.assertEqual(self._box._toc, {})
  608. key0 = self._box.add(self._template % 0)
  609. key1 = self._box.add(self._template % 1)
  610. self.assertEqual(self._box._toc, {})
  611. self._box._refresh()
  612. self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
  613. key1: os.path.join('new', key1)})
  614. key2 = self._box.add(self._template % 2)
  615. self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
  616. key1: os.path.join('new', key1)})
  617. self._box._refresh()
  618. self.assertEqual(self._box._toc, {key0: os.path.join('new', key0),
  619. key1: os.path.join('new', key1),
  620. key2: os.path.join('new', key2)})
  621. def test_refresh_after_safety_period(self):
  622. # Issue #13254: Call _refresh after the "file system safety
  623. # period" of 2 seconds has passed; _toc should still be
  624. # updated because this is the first call to _refresh.
  625. key0 = self._box.add(self._template % 0)
  626. key1 = self._box.add(self._template % 1)
  627. self._box = self._factory(self._path)
  628. self.assertEqual(self._box._toc, {})
  629. # Emulate sleeping. Instead of sleeping for 2 seconds, use the
  630. # skew factor to make _refresh think that the filesystem
  631. # safety period has passed and re-reading the _toc is only
  632. # required if mtimes differ.
  633. self._box._skewfactor = -3
  634. self._box._refresh()
  635. self.assertEqual(sorted(self._box._toc.keys()), sorted([key0, key1]))
  636. def test_lookup(self):
  637. # Look up message subpaths in the TOC
  638. self.assertRaises(KeyError, lambda: self._box._lookup('foo'))
  639. key0 = self._box.add(self._template % 0)
  640. self.assertEqual(self._box._lookup(key0), os.path.join('new', key0))
  641. os.remove(os.path.join(self._path, 'new', key0))
  642. self.assertEqual(self._box._toc, {key0: os.path.join('new', key0)})
  643. # Be sure that the TOC is read back from disk (see issue #6896
  644. # about bad mtime behaviour on some systems).
  645. self._box.flush()
  646. self.assertRaises(KeyError, lambda: self._box._lookup(key0))
  647. self.assertEqual(self._box._toc, {})
  648. def test_lock_unlock(self):
  649. # Lock and unlock the mailbox. For Maildir, this does nothing.
  650. self._box.lock()
  651. self._box.unlock()
  652. def test_folder (self):
  653. # Test for bug #1569790: verify that folders returned by .get_folder()
  654. # use the same factory function.
  655. def dummy_factory (s):
  656. return None
  657. box = self._factory(self._path, factory=dummy_factory)
  658. folder = box.add_folder('folder1')
  659. self.assertIs(folder._factory, dummy_factory)
  660. folder1_alias = box.get_folder('folder1')
  661. self.assertIs(folder1_alias._factory, dummy_factory)
  662. def test_directory_in_folder (self):
  663. # Test that mailboxes still work if there's a stray extra directory
  664. # in a folder.
  665. for i in range(10):
  666. self._box.add(mailbox.Message(_sample_message))
  667. # Create a stray directory
  668. os.mkdir(os.path.join(self._path, 'cur', 'stray-dir'))
  669. # Check that looping still works with the directory present.
  670. for msg in self._box:
  671. pass
  672. def test_file_permissions(self):
  673. # Verify that message files are created without execute permissions
  674. if not hasattr(os, "stat") or not hasattr(os, "umask"):
  675. return
  676. msg = mailbox.MaildirMessage(self._template % 0)
  677. orig_umask = os.umask(0)
  678. try:
  679. key = self._box.add(msg)
  680. finally:
  681. os.umask(orig_umask)
  682. path = os.path.join(self._path, self._box._lookup(key))
  683. mode = os.stat(path).st_mode
  684. self.assertEqual(mode & 0111, 0)
  685. def test_folder_file_perms(self):
  686. # From bug #3228, we want to verify that the file created inside a Maildir
  687. # subfolder isn't marked as executable.
  688. if not hasattr(os, "stat") or not hasattr(os, "umask"):
  689. return
  690. orig_umask = os.umask(0)
  691. try:
  692. subfolder = self._box.add_folder('subfolder')
  693. finally:
  694. os.umask(orig_umask)
  695. path = os.path.join(subfolder._path, 'maildirfolder')
  696. st = os.stat(path)
  697. perms = st.st_mode
  698. self.assertFalse((perms & 0111)) # Execute bits should all be off.
  699. def test_reread(self):
  700. # Do an initial unconditional refresh
  701. self._box._refresh()
  702. # Put the last modified times more than two seconds into the past
  703. # (because mtime may have only a two second granularity).
  704. for subdir in ('cur', 'new'):
  705. os.utime(os.path.join(self._box._path, subdir),
  706. (time.time()-5,)*2)
  707. # Because mtime has a two second granularity in worst case (FAT), a
  708. # refresh is done unconditionally if called for within
  709. # two-second-plus-a-bit of the last one, just in case the mbox has
  710. # changed; so now we have to wait for that interval to expire.
  711. #
  712. # Because this is a test, emulate sleeping. Instead of
  713. # sleeping for 2 seconds, use the skew factor to make _refresh
  714. # think that 2 seconds have passed and re-reading the _toc is
  715. # only required if mtimes differ.
  716. self._box._skewfactor = -3
  717. # Re-reading causes the ._toc attribute to be assigned a new dictionary
  718. # object, so we'll check that the ._toc attribute isn't a different
  719. # object.
  720. orig_toc = self._box._toc
  721. def refreshed():
  722. return self._box._toc is not orig_toc
  723. self._box._refresh()
  724. self.assertFalse(refreshed())
  725. # Now, write something into cur and remove it. This changes
  726. # the mtime and should cause a re-read. Note that "sleep
  727. # emulation" is still in effect, as skewfactor is -3.
  728. filename = os.path.join(self._path, 'cur', 'stray-file')
  729. f = open(filename, 'w')
  730. f.close()
  731. os.unlink(filename)
  732. self._box._refresh()
  733. self.assertTrue(refreshed())
  734. class _TestMboxMMDF(TestMailbox):
  735. def tearDown(self):
  736. self._box.close()
  737. self._delete_recursively(self._path)
  738. for lock_remnant in glob.glob(self._path + '.*'):
  739. test_support.unlink(lock_remnant)
  740. def test_add_from_string(self):
  741. # Add a string starting with 'From ' to the mailbox
  742. key = self._box.add('From foo@bar blah\nFrom: foo\n\n0')
  743. self.assertEqual(self._box[key].get_from(), 'foo@bar blah')
  744. self.assertEqual(self._box[key].get_payload(), '0')
  745. def test_add_mbox_or_mmdf_message(self):
  746. # Add an mboxMessage or MMDFMessage
  747. for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
  748. msg = class_('From foo@bar blah\nFrom: foo\n\n0')
  749. key = self._box.add(msg)
  750. def test_open_close_open(self):
  751. # Open and inspect previously-created mailbox
  752. values = [self._template % i for i in xrange(3)]
  753. for value in values:
  754. self._box.add(value)
  755. self._box.close()
  756. mtime = os.path.getmtime(self._path)
  757. self._box = self._factory(self._path)
  758. self.assertEqual(len(self._box), 3)
  759. for key in self._box.iterkeys():
  760. self.assertIn(self._box.get_string(key), values)
  761. self._box.close()
  762. self.assertEqual(mtime, os.path.getmtime(self._path))
  763. def test_add_and_close(self):
  764. # Verifying that closing a mailbox doesn't change added items
  765. self._box.add(_sample_message)
  766. for i in xrange(3):
  767. self._box.add(self._template % i)
  768. self._box.add(_sample_message)
  769. self._box._file.flush()
  770. self._box._file.seek(0)
  771. contents = self._box._file.read()
  772. self._box.close()
  773. with open(self._path, 'rb') as f:
  774. self.assertEqual(contents, f.read())
  775. self._box = self._factory(self._path)
  776. @unittest.skipUnless(hasattr(os, 'fork'), "Test needs fork().")
  777. @unittest.skipUnless(hasattr(socket, 'socketpair'), "Test needs socketpair().")
  778. def test_lock_conflict(self):
  779. # Fork off a child process that will lock the mailbox temporarily,
  780. # unlock it and exit.
  781. c, p = socket.socketpair()
  782. self.addCleanup(c.close)
  783. self.addCleanup(p.close)
  784. pid = os.fork()
  785. if pid == 0:
  786. # child
  787. try:
  788. # lock the mailbox, and signal the parent it can proceed
  789. self._box.lock()
  790. c.send(b'c')
  791. # wait until the parent is done, and unlock the mailbox
  792. c.recv(1)
  793. self._box.unlock()
  794. finally:
  795. os._exit(0)
  796. # In the parent, wait until the child signals it locked the mailbox.
  797. p.recv(1)
  798. try:
  799. self.assertRaises(mailbox.ExternalClashError,
  800. self._box.lock)
  801. finally:
  802. # Signal the child it can now release the lock and exit.
  803. p.send(b'p')
  804. # Wait for child to exit. Locking should now succeed.
  805. exited_pid, status = os.waitpid(pid, 0)
  806. self._box.lock()
  807. self._box.unlock()
  808. def test_relock(self):
  809. # Test case for bug #1575506: the mailbox class was locking the
  810. # wrong file object in its flush() method.
  811. msg = "Subject: sub\n\nbody\n"
  812. key1 = self._box.add(msg)
  813. self._box.flush()
  814. self._box.close()
  815. self._box = self._factory(self._path)
  816. self._box.lock()
  817. key2 = self._box.add(msg)
  818. self._box.flush()
  819. self.assertTrue(self._box._locked)
  820. self._box.close()
  821. class TestMbox(_TestMboxMMDF):
  822. _factory = lambda self, path, factory=None: mailbox.mbox(path, factory)
  823. def test_file_perms(self):
  824. # From bug #3228, we want to verify that the mailbox file isn't executable,
  825. # even if the umask is set to something that would leave executable bits set.
  826. # We only run this test on platforms that support umask.
  827. if hasattr(os, 'umask') and hasattr(os, 'stat'):
  828. try:
  829. old_umask = os.umask(0077)
  830. self._box.close()
  831. os.unlink(self._path)
  832. self._box = mailbox.mbox(self._path, create=True)
  833. self._box.add('')
  834. self._box.close()
  835. finally:
  836. os.umask(old_umask)
  837. st = os.stat(self._path)
  838. perms = st.st_mode
  839. self.assertFalse((perms & 0111)) # Execute bits should all be off.
  840. class TestMMDF(_TestMboxMMDF):
  841. _factory = lambda self, path, factory=None: mailbox.MMDF(path, factory)
  842. class TestMH(TestMailbox):
  843. _factory = lambda self, path, factory=None: mailbox.MH(path, factory)
  844. def test_list_folders(self):
  845. # List folders
  846. self._box.add_folder('one')
  847. self._box.add_folder('two')
  848. self._box.add_folder('three')
  849. self.assertEqual(len(self._box.list_folders()), 3)
  850. self.assertEqual(set(self._box.list_folders()),
  851. set(('one', 'two', 'three')))
  852. def test_get_folder(self):
  853. # Open folders
  854. def dummy_factory (s):
  855. return None
  856. self._box = self._factory(self._path, dummy_factory)
  857. new_folder = self._box.add_folder('foo.bar')
  858. folder0 = self._box.get_folder('foo.bar')
  859. folder0.add(self._template % 'bar')
  860. self.assertTrue(os.path.isdir(os.path.join(self._path, 'foo.bar')))
  861. folder1 = self._box.get_folder('foo.bar')
  862. self.assertEqual(folder1.get_string(folder1.keys()[0]),
  863. self._template % 'bar')
  864. # Test for bug #1569790: verify that folders returned by .get_folder()
  865. # use the same factory function.
  866. self.assertIs(new_folder._factory, self._box._factory)
  867. self.assertIs(folder0._factory, self._box._factory)
  868. def test_add_and_remove_folders(self):
  869. # Delete folders
  870. self._box.add_folder('one')
  871. self._box.add_folder('two')
  872. self.assertEqual(len(self._box.list_folders()), 2)
  873. self.assertEqual(set(self._box.list_folders()), set(('one', 'two')))
  874. self._box.remove_folder('one')
  875. self.assertEqual(len(self._box.list_folders()), 1)
  876. self.assertEqual(set(self._box.list_folders()), set(('two', )))
  877. self._box.add_folder('three')
  878. self.assertEqual(len(self._box.list_folders()), 2)
  879. self.assertEqual(set(self._box.list_folders()), set(('two', 'three')))
  880. self._box.remove_folder('three')
  881. self.assertEqual(len(self._box.list_folders()), 1)
  882. self.assertEqual(set(self._box.list_folders()), set(('two', )))
  883. self._box.remove_folder('two')
  884. self.assertEqual(len(self._box.list_folders()), 0)
  885. self.assertEqual(self._box.list_folders(), [])
  886. def test_sequences(self):
  887. # Get and set sequences
  888. self.assertEqual(self._box.get_sequences(), {})
  889. msg0 = mailbox.MHMessage(self._template % 0)
  890. msg0.add_sequence('foo')
  891. key0 = self._box.add(msg0)
  892. self.assertEqual(self._box.get_sequences(), {'foo':[key0]})
  893. msg1 = mailbox.MHMessage(self._template % 1)
  894. msg1.set_sequences(['bar', 'replied', 'foo'])
  895. key1 = self._box.add(msg1)
  896. self.assertEqual(self._box.get_sequences(),
  897. {'foo':[key0, key1], 'bar':[key1], 'replied':[key1]})
  898. msg0.set_sequences(['flagged'])
  899. self._box[key0] = msg0
  900. self.assertEqual(self._box.get_sequences(),
  901. {'foo':[key1], 'bar':[key1], 'replied':[key1],
  902. 'flagged':[key0]})
  903. self._box.remove(key1)
  904. self.assertEqual(self._box.get_sequences(), {'flagged':[key0]})
  905. def test_issue2625(self):
  906. msg0 = mailbox.MHMessage(self._template % 0)
  907. msg0.add_sequence('foo')
  908. key0 = self._box.add(msg0)
  909. refmsg0 = self._box.get_message(key0)
  910. def test_issue7627(self):
  911. msg0 = mailbox.MHMessage(self._template % 0)
  912. key0 = self._box.add(msg0)
  913. self._box.lock()
  914. self._box.remove(key0)
  915. self._box.unlock()
  916. def test_pack(self):
  917. # Pack the contents of the mailbox
  918. msg0 = mailbox.MHMessage(self._template % 0)
  919. msg1 = mailbox.MHMessage(self._template % 1)
  920. msg2 = mailbox.MHMessage(self._template % 2)
  921. msg3 = mailbox.MHMessage(self._template % 3)
  922. msg0.set_sequences(['foo', 'unseen'])
  923. msg1.set_sequences(['foo'])
  924. msg2.set_sequences(['foo', 'flagged'])
  925. msg3.set_sequences(['foo', 'bar', 'replied'])
  926. key0 = self._box.add(msg0)
  927. key1 = self._box.add(msg1)
  928. key2 = self._box.add(msg2)
  929. key3 = self._box.add(msg3)
  930. self.assertEqual(self._box.get_sequences(),
  931. {'foo':[key0,key1,key2,key3], 'unseen':[key0],
  932. 'flagged':[key2], 'bar':[key3], 'replied':[key3]})
  933. self._box.remove(key2)
  934. self.assertEqual(self._box.get_sequences(),
  935. {'foo':[key0,key1,key3], 'unseen':[key0], 'bar':[key3],
  936. 'replied':[key3]})
  937. self._box.pack()
  938. self.assertEqual(self._box.keys(), [1, 2, 3])
  939. key0 = key0
  940. key1 = key0 + 1
  941. key2 = key1 + 1
  942. self.assertEqual(self._box.get_sequences(),
  943. {'foo':[1, 2, 3], 'unseen':[1], 'bar':[3], 'replied':[3]})
  944. # Test case for packing while holding the mailbox locked.
  945. key0 = self._box.add(msg1)
  946. key1 = self._box.add(msg1)
  947. key2 = self._box.add(msg1)
  948. key3 = self._box.add(msg1)
  949. self._box.remove(key0)
  950. self._box.remove(key2)
  951. self._box.lock()
  952. self._box.pack()
  953. self._box.unlock()
  954. self.assertEqual(self._box.get_sequences(),
  955. {'foo':[1, 2, 3, 4, 5],
  956. 'unseen':[1], 'bar':[3], 'replied':[3]})
  957. def _get_lock_path(self):
  958. return os.path.join(self._path, '.mh_sequences.lock')
  959. class TestBabyl(TestMailbox):
  960. _factory = lambda self, path, factory=None: mailbox.Babyl(path, factory)
  961. def tearDown(self):
  962. self._box.close()
  963. self._delete_recursively(self._path)
  964. for lock_remnant in glob.glob(self._path + '.*'):
  965. test_support.unlink(lock_remnant)
  966. def test_labels(self):
  967. # Get labels from the mailbox
  968. self.assertEqual(self._box.get_labels(), [])
  969. msg0 = mailbox.BabylMessage(self._template % 0)
  970. msg0.add_label('foo')
  971. key0 = self._box.add(msg0)
  972. self.assertEqual(self._box.get_labels(), ['foo'])
  973. msg1 = mailbox.BabylMessage(self._template % 1)
  974. msg1.set_labels(['bar', 'answered', 'foo'])
  975. key1 = self._box.add(msg1)
  976. self.assertEqual(set(self._box.get_labels()), set(['foo', 'bar']))
  977. msg0.set_labels(['blah', 'filed'])
  978. self._box[key0] = msg0
  979. self.assertEqual(set(self._box.get_labels()),
  980. set(['foo', 'bar', 'blah']))
  981. self._box.remove(key1)
  982. self.assertEqual(set(self._box.get_labels()), set(['blah']))
  983. class TestMessage(TestBase):
  984. _factory = mailbox.Message # Overridden by subclasses to reuse tests
  985. def setUp(self):
  986. self._path = test_support.TESTFN
  987. def tearDown(self):
  988. self._delete_recursively(self._path)
  989. def test_initialize_with_eMM(self):
  990. # Initialize based on email.message.Message instance
  991. eMM = email.message_from_string(_sample_message)
  992. msg = self._factory(eMM)
  993. self._post_initialize_hook(msg)
  994. self._check_sample(msg)
  995. def test_initialize_with_string(self):
  996. # Initialize based on string
  997. msg = self._factory(_sample_message)
  998. self._post_initialize_hook(msg)
  999. self._check_sample(msg)
  1000. def test_initialize_with_file(self):
  1001. # Initialize based on contents of file
  1002. with open(self._path, 'w+') as f:
  1003. f.write(_sample_message)
  1004. f.seek(0)
  1005. msg = self._factory(f)
  1006. self._post_initialize_hook(msg)
  1007. self._check_sample(msg)
  1008. def test_initialize_with_nothing(self):
  1009. # Initialize without arguments
  1010. msg = self._factory()
  1011. self._post_initialize_hook(msg)
  1012. self.assertIsInstance(msg, email.message.Message)
  1013. self.assertIsInstance(msg, mailbox.Message)
  1014. self.assertIsInstance(msg, self._factory)
  1015. self.assertEqual(msg.keys(), [])
  1016. self.assertFalse(msg.is_multipart())
  1017. self.assertEqual(msg.get_payload(), None)
  1018. def test_initialize_incorrectly(self):
  1019. # Initialize with invalid argument
  1020. self.assertRaises(TypeError, lambda: self._factory(object()))
  1021. def test_become_message(self):
  1022. # Take on the state of another message
  1023. eMM = email.message_from_string(_sample_message)
  1024. msg = self._factory()
  1025. msg._become_message(eMM)
  1026. self._check_sample(msg)
  1027. def test_explain_to(self):
  1028. # Copy self's format-specific data to other message formats.
  1029. # This test is superficial; better ones are in TestMessageConversion.
  1030. msg = self._factory()
  1031. for class_ in (mailbox.Message, mailbox.MaildirMessage,
  1032. mailbox.mboxMessage, mailbox.MHMessage,
  1033. mailbox.BabylMessage, mailbox.MMDFMessage):
  1034. other_msg = class_()
  1035. msg._explain_to(other_msg)
  1036. other_msg = email.message.Message()
  1037. self.assertRaises(TypeError, lambda: msg._explain_to(other_msg))
  1038. def _post_initialize_hook(self, msg):
  1039. # Overridden by subclasses to check extra things after initialization
  1040. pass
  1041. class TestMaildirMessage(TestMessage):
  1042. _factory = mailbox.MaildirMessage
  1043. def _post_initialize_hook(self, msg):
  1044. self.assertEqual(msg._subdir, 'new')
  1045. self.assertEqual(msg._info,'')
  1046. def test_subdir(self):
  1047. # Use get_subdir() and set_subdir()
  1048. msg = mailbox.MaildirMessage(_sample_message)
  1049. self.assertEqual(msg.get_subdir(), 'new')
  1050. msg.set_subdir('cur')
  1051. self.assertEqual(msg.get_subdir(), 'cur')
  1052. msg.set_subdir('new')
  1053. self.assertEqual(msg.get_subdir(), 'new')
  1054. self.assertRaises(ValueError, lambda: msg.set_subdir('tmp'))
  1055. self.assertEqual(msg.get_subdir(), 'new')
  1056. msg.set_subdir('new')
  1057. self.assertEqual(msg.get_subdir(), 'new')
  1058. self._check_sample(msg)
  1059. def test_flags(self):
  1060. # Use get_flags(), set_flags(), add_flag(), remove_flag()
  1061. msg = mailbox.MaildirMessage(_sample_message)
  1062. self.assertEqual(msg.get_flags(), '')
  1063. self.assertEqual(msg.get_subdir(), 'new')
  1064. msg.set_flags('F')
  1065. self.assertEqual(msg.get_subdir(), 'new')
  1066. self.assertEqual(msg.get_flags(), 'F')
  1067. msg.set_flags('SDTP')
  1068. self.assertEqual(msg.get_flags(), 'DPST')
  1069. msg.add_flag('FT')
  1070. self.assertEqual(msg.get_flags(), 'DFPST')
  1071. msg.remove_flag('TDRP')
  1072. self.assertEqual(msg.get_flags(), 'FS')
  1073. self.assertEqual(msg.get_subdir(), 'new')
  1074. self._check_sample(msg)
  1075. def test_date(self):
  1076. # Use get_date() and set_date()
  1077. msg = mailbox.MaildirMessage(_sample_message)
  1078. diff = msg.get_date() - time.time()
  1079. self.assertTrue(abs(diff) < 60, diff)
  1080. msg.set_date(0.0)
  1081. self.assertEqual(msg.get_date(), 0.0)
  1082. def test_info(self):
  1083. # Use get_info() and set_info()
  1084. msg = mailbox.MaildirMessage(_sample_message)
  1085. self.assertEqual(msg.get_info(), '')
  1086. msg.set_info('1,foo=bar')
  1087. self.assertEqual(msg.get_info(), '1,foo=bar')
  1088. self.assertRaises(TypeError, lambda: msg.set_info(None))
  1089. self._check_sample(msg)
  1090. def test_info_and_flags(self):
  1091. # Test interaction of info and flag methods
  1092. msg = mailbox.MaildirMessage(_sample_message)
  1093. self.assertEqual(msg.get_info(), '')
  1094. msg.set_flags('SF')
  1095. self.assertEqual(msg.get_flags(), 'FS')
  1096. self.assertEqual(msg.get_info(), '2,FS')
  1097. msg.set_info('1,')
  1098. self.assertEqual(msg.get_flags(), '')
  1099. self.assertEqual(msg.get_info(), '1,')
  1100. msg.remove_flag('RPT')
  1101. self.assertEqual(msg.get_flags(), '')
  1102. self.assertEqual(msg.get_info(), '1,')
  1103. msg.add_flag('D')
  1104. self.assertEqual(msg.get_flags(), 'D')
  1105. self.assertEqual(msg.get_info(), '2,D')
  1106. self._check_sample(msg)
  1107. class _TestMboxMMDFMessage(TestMessage):
  1108. _factory = mailbox._mboxMMDFMessage
  1109. def _post_initialize_hook(self, msg):
  1110. self._check_from(msg)
  1111. def test_initialize_with_unixfrom(self):
  1112. # Initialize with a message that already has a _unixfrom attribute
  1113. msg = mailbox.Message(_sample_message)
  1114. msg.set_unixfrom('From foo@bar blah')
  1115. msg = mailbox.mboxMessage(msg)
  1116. self.assertEqual(msg.get_from(), 'foo@bar blah')
  1117. def test_from(self):
  1118. # Get and set "From " line
  1119. msg = mailbox.mboxMessage(_sample_message)
  1120. self._check_from(msg)
  1121. msg.set_from('foo bar')
  1122. self.assertEqual(msg.get_from(), 'foo bar')
  1123. msg.set_from('foo@bar', True)
  1124. self._check_from(msg, 'foo@bar')
  1125. msg.set_from('blah@temp', time.localtime())
  1126. self._check_from(msg, 'blah@temp')
  1127. def test_flags(self):
  1128. # Use get_flags(), set_flags(), add_flag(), remove_flag()
  1129. msg = mailbox.mboxMessage(_sample_message)
  1130. self.assertEqual(msg.get_flags(), '')
  1131. msg.set_flags('F')
  1132. self.assertEqual(msg.get_flags(), 'F')
  1133. msg.set_flags('XODR')
  1134. self.assertEqual(msg.get_flags(), 'RODX')
  1135. msg.add_flag('FA')
  1136. self.assertEqual(msg.get_flags(), 'RODFAX')
  1137. msg.remove_flag('FDXA')
  1138. self.assertEqual(msg.get_flags(), 'RO')
  1139. self._check_sample(msg)
  1140. def _check_from(self, msg, sender=None):
  1141. # Check contents of "From " line
  1142. if sender is None:
  1143. sender = "MAILER-DAEMON"
  1144. self.assertTrue(re.match(sender + r" \w{3} \w{3} [\d ]\d [\d ]\d:\d{2}:"
  1145. r"\d{2} \d{4}", msg.get_from()))
  1146. class TestMboxMessage(_TestMboxMMDFMessage):
  1147. _factory = mailbox.mboxMessage
  1148. class TestMHMessage(TestMessage):
  1149. _factory = mailbox.MHMessage
  1150. def _post_initialize_hook(self, msg):
  1151. self.assertEqual(msg._sequences, [])
  1152. def test_sequences(self):
  1153. # Get, set, join, and leave sequences
  1154. msg = mailbox.MHMessage(_sample_message)
  1155. self.assertEqual(msg.get_sequences(), [])
  1156. msg.set_sequences(['foobar'])
  1157. self.assertEqual(msg.get_sequences(), ['foobar'])
  1158. msg.set_sequences([])
  1159. self.assertEqual(msg.get_sequences(), [])
  1160. msg.add_sequence('unseen')
  1161. self.assertEqual(msg.get_sequences(), ['unseen'])
  1162. msg.add_sequence('flagged')
  1163. self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
  1164. msg.add_sequence('flagged')
  1165. self.assertEqual(msg.get_sequences(), ['unseen', 'flagged'])
  1166. msg.remove_sequence('unseen')
  1167. self.assertEqual(msg.get_sequences(), ['flagged'])
  1168. msg.add_sequence('foobar')
  1169. self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
  1170. msg.remove_sequence('replied')
  1171. self.assertEqual(msg.get_sequences(), ['flagged', 'foobar'])
  1172. msg.set_sequences(['foobar', 'replied'])
  1173. self.assertEqual(msg.get_sequences(), ['foobar', 'replied'])
  1174. class TestBabylMessage(TestMessage):
  1175. _factory = mailbox.BabylMessage
  1176. def _post_initialize_hook(self, msg):
  1177. self.assertEqual(msg._labels, [])
  1178. def test_labels(self):
  1179. # Get, set, join, and leave labels
  1180. msg = mailbox.BabylMessage(_sample_message)
  1181. self.assertEqual(msg.get_labels(), [])
  1182. msg.set_labels(['foobar'])
  1183. self.assertEqual(msg.get_labels(), ['foobar'])
  1184. msg.set_labels([])
  1185. self.assertEqual(msg.get_labels(), [])
  1186. msg.add_label('filed')
  1187. self.assertEqual(msg.get_labels(), ['filed'])
  1188. msg.add_label('resent')
  1189. self.assertEqual(msg.get_labels(), ['filed', 'resent'])
  1190. msg.add_label('resent')
  1191. self.assertEqual(msg.get_labels(), ['filed', 'resent'])
  1192. msg.remove_label('filed')
  1193. self.assertEqual(msg.get_labels(), ['resent'])
  1194. msg.add_label('foobar')
  1195. self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
  1196. msg.remove_label('unseen')
  1197. self.assertEqual(msg.get_labels(), ['resent', 'foobar'])
  1198. msg.set_labels(['foobar', 'answered'])
  1199. self.assertEqual(msg.get_labels(), ['foobar', 'answered'])
  1200. def test_visible(self):
  1201. # Get, set, and update visible headers
  1202. msg = mailbox.BabylMessage(_sample_message)
  1203. visible = msg.get_visible()
  1204. self.assertEqual(visible.keys(), [])
  1205. self.assertIs(visible.get_payload(), None)
  1206. visible['User-Agent'] = 'FooBar 1.0'
  1207. visible['X-Whatever'] = 'Blah'
  1208. self.assertEqual(msg.get_visible().keys(), [])
  1209. msg.set_visible(visible)
  1210. visible = msg.get_visible()
  1211. self.assertEqual(visible.keys(), ['User-Agent', 'X-Whatever'])
  1212. self.assertEqual(visible['User-Agent'], 'FooBar 1.0')
  1213. self.assertEqual(visible['X-Whatever'], 'Blah')
  1214. self.assertIs(visible.get_payload(), None)
  1215. msg.update_visible()
  1216. self.assertEqual(visible.keys(), ['User-Agent', 'X-Whatever'])
  1217. self.assertIs(visible.get_payload(), None)
  1218. visible = msg.get_visible()
  1219. self.assertEqual(visible.keys(), ['User-Agent', 'Date', 'From', 'To',
  1220. 'Subject'])
  1221. for header in ('User-Agent', 'Date', 'From', 'To', 'Subject'):
  1222. self.assertEqual(visible[header], msg[header])
  1223. class TestMMDFMessage(_TestMboxMMDFMessage):
  1224. _factory = mailbox.MMDFMessage
  1225. class TestMessageConversion(TestBase):
  1226. def test_plain_to_x(self):
  1227. # Convert Message to all formats
  1228. for class_ in (mailbox.Message, mailbox.MaildirMessage,
  1229. mailbox.mboxMessage, mailbox.MHMessage,
  1230. mailbox.BabylMessage, mailbox.MMDFMessage):
  1231. msg_plain = mailbox.Message(_sample_message)
  1232. msg = class_(msg_plain)
  1233. self._check_sample(msg)
  1234. def test_x_to_plain(self):
  1235. # Convert all formats to Message
  1236. for class_ in (mailbox.Message, mailbox.MaildirMessage,
  1237. mailbox.mboxMessage, mailbox.MHMessage,
  1238. mailbox.BabylMessage, mailbox.MMDFMessage):
  1239. msg = class_(_sample_message)
  1240. msg_plain = mailbox.Message(msg)
  1241. self._check_sample(msg_plain)
  1242. def test_x_to_invalid(self):
  1243. # Convert all formats to an invalid format
  1244. for class_ in (mailbox.Message, mailbox.MaildirMessage,
  1245. mailbox.mboxMessage, mailbox.MHMessage,
  1246. mailbox.BabylMessage, mailbox.MMDFMessage):
  1247. self.assertRaises(TypeError, lambda: class_(False))
  1248. def test_maildir_to_maildir(self):
  1249. # Convert MaildirMessage to MaildirMessage
  1250. msg_maildir = mailbox.MaildirMessage(_sample_message)
  1251. msg_maildir.set_flags('DFPRST')
  1252. msg_maildir.set_subdir('cur')
  1253. date = msg_maildir.get_date()
  1254. msg = mailbox.MaildirMessage(msg_maildir)
  1255. self._check_sample(msg)
  1256. self.assertEqual(msg.get_flags(), 'DFPRST')
  1257. self.assertEqual(msg.get_subdir(), 'cur')
  1258. self.assertEqual(msg.get_date(), date)
  1259. def test_maildir_to_mboxmmdf(self):
  1260. # Convert MaildirMessage to mboxmessage and MMDFMessage
  1261. pairs = (('D', ''), ('F', 'F'), ('P', ''), ('R', 'A'), ('S', 'R'),
  1262. ('T', 'D'), ('DFPRST', 'RDFA'))
  1263. for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
  1264. msg_maildir = mailbox.MaildirMessage(_sample_message)
  1265. msg_maildir.set_date(0.0)
  1266. for setting, result in pairs:
  1267. msg_maildir.set_flags(setting)
  1268. msg = class_(msg_maildir)
  1269. self.assertEqual(msg.get_flags(), result)
  1270. self.assertEqual(msg.get_from(), 'MAILER-DAEMON %s' %
  1271. time.asctime(time.gmtime(0.0)))
  1272. msg_maildir.set_subdir('cur')
  1273. self.assertEqual(class_(msg_maildir).get_flags(), 'RODFA')
  1274. def test_maildir_to_mh(self):
  1275. # Convert MaildirMessage to MHMessage
  1276. msg_maildir = mailbox.MaildirMessage(_sample_message)
  1277. pairs = (('D', ['unseen']), ('F', ['unseen', 'flagged']),
  1278. ('P', ['unseen']), ('R', ['unseen', 'replied']), ('S', []),
  1279. ('T', ['unseen']), ('DFPRST', ['replied', 'flagged']))
  1280. for setting, result in pairs:
  1281. msg_maildir.set_flags(setting)
  1282. self.assertEqual(mailbox.MHMessage(msg_maildir).get_sequences(),
  1283. result)
  1284. def test_maildir_to_babyl(self):
  1285. # Convert MaildirMessage to Babyl
  1286. msg_maildir = mailbox.MaildirMessage(_sample_message)
  1287. pairs = (('D', ['unseen']), ('F', ['unseen']),
  1288. ('P', ['unseen', 'forwarded']), ('R', ['unseen', 'answered']),
  1289. ('S', []), ('T', ['unseen', 'deleted']),
  1290. ('DFPRST', ['deleted', 'answered', 'forwarded']))
  1291. for setting, result in pairs:
  1292. msg_maildir.set_flags(setting)
  1293. self.assertEqual(mailbox.BabylMessage(msg_maildir).get_labels(),
  1294. result)
  1295. def test_mboxmmdf_to_maildir(self):
  1296. # Convert mboxMessage and MMDFMessage to MaildirMessage
  1297. for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
  1298. msg_mboxMMDF = class_(_sample_message)
  1299. msg_mboxMMDF.set_from('foo@bar', time.gmtime(0.0))
  1300. pairs = (('R', 'S'), ('O', ''), ('D', 'T'), ('F', 'F'), ('A', 'R'),
  1301. ('RODFA', 'FRST'))
  1302. for setting, result in pairs:
  1303. msg_mboxMMDF.set_flags(setting)
  1304. msg = mailbox.MaildirMessage(msg_mboxMMDF)
  1305. self.assertEqual(msg.get_flags(), result)
  1306. self.assertEqual(msg.get_date(), 0.0)
  1307. msg_mboxMMDF.set_flags('O')
  1308. self.assertEqual(mailbox.MaildirMessage(msg_mboxMMDF).get_subdir(),
  1309. 'cur')
  1310. def test_mboxmmdf_to_mboxmmdf(self):
  1311. # Convert mboxMessage and MMDFMessage to mboxMessage and MMDFMessage
  1312. for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
  1313. msg_mboxMMDF = class_(_sample_message)
  1314. msg_mboxMMDF.set_flags('RODFA')
  1315. msg_mboxMMDF.set_from('foo@bar')
  1316. for class2_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
  1317. msg2 = class2_(msg_mboxMMDF)
  1318. self.assertEqual(msg2.get_flags(), 'RODFA')
  1319. self.assertEqual(msg2.get_from(), 'foo@bar')
  1320. def test_mboxmmdf_to_mh(self):
  1321. # Convert mboxMessage and MMDFMessage to MHMessage
  1322. for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
  1323. msg_mboxMMDF = class_(_sample_message)
  1324. pairs = (('R', []), ('O', ['unseen']), ('D', ['unseen']),
  1325. ('F', ['unseen', 'flagged']),
  1326. ('A', ['unseen', 'replied']),
  1327. ('RODFA', ['replied', 'flagged']))
  1328. for setting, result in pairs:
  1329. msg_mboxMMDF.set_flags(setting)
  1330. self.assertEqual(mailbox.MHMessage(msg_mboxMMDF).get_sequences(),
  1331. result)
  1332. def test_mboxmmdf_to_babyl(self):
  1333. # Convert mboxMessage and MMDFMessage to BabylMessage
  1334. for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
  1335. msg = class_(_sample_message)
  1336. pairs = (('R', []), ('O', ['unseen']),
  1337. ('D', ['unseen', 'deleted']), ('F', ['unseen']),
  1338. ('A', ['unseen', 'answered']),
  1339. ('RODFA', ['deleted', 'answered']))
  1340. for setting, result in pairs:
  1341. msg.set_flags(setting)
  1342. self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
  1343. def test_mh_to_maildir(self):
  1344. # Convert MHMessage to MaildirMessage
  1345. pairs = (('unseen', ''), ('replied', 'RS'), ('flagged', 'FS'))
  1346. for setting, result in pairs:
  1347. msg = mailbox.MHMessage(_sample_message)
  1348. msg.add_sequence(setting)
  1349. self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
  1350. self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
  1351. msg = mailbox.MHMessage(_sample_message)
  1352. msg.add_sequence('unseen')
  1353. msg.add_sequence('replied')
  1354. msg.add_sequence('flagged')
  1355. self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'FR')
  1356. self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
  1357. def test_mh_to_mboxmmdf(self):
  1358. # Convert MHMessage to mboxMessage and MMDFMessage
  1359. pairs = (('unseen', 'O'), ('replied', 'ROA'), ('flagged', 'ROF'))
  1360. for setting, result in pairs:
  1361. msg = mailbox.MHMessage(_sample_message)
  1362. msg.add_sequence(setting)
  1363. for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
  1364. self.assertEqual(class_(msg).get_flags(), result)
  1365. msg = mailbox.MHMessage(_sample_message)
  1366. msg.add_sequence('unseen')
  1367. msg.add_sequence('replied')
  1368. msg.add_sequence('flagged')
  1369. for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
  1370. self.assertEqual(class_(msg).get_flags(), 'OFA')
  1371. def test_mh_to_mh(self):
  1372. # Convert MHMessage to MHMessage
  1373. msg = mailbox.MHMessage(_sample_message)
  1374. msg.add_sequence('unseen')
  1375. msg.add_sequence('replied')
  1376. msg.add_sequence('flagged')
  1377. self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
  1378. ['unseen', 'replied', 'flagged'])
  1379. def test_mh_to_babyl(self):
  1380. # Convert MHMessage to BabylMessage
  1381. pairs = (('unseen', ['unseen']), ('replied', ['answered']),
  1382. ('flagged', []))
  1383. for setting, result in pairs:
  1384. msg = mailbox.MHMessage(_sample_message)
  1385. msg.add_sequence(setting)
  1386. self.assertEqual(mailbox.BabylMessage(msg).get_labels(), result)
  1387. msg = mailbox.MHMessage(_sample_message)
  1388. msg.add_sequence('unseen')
  1389. msg.add_sequence('replied')
  1390. msg.add_sequence('flagged')
  1391. self.assertEqual(mailbox.BabylMessage(msg).get_labels(),
  1392. ['unseen', 'answered'])
  1393. def test_babyl_to_maildir(self):
  1394. # Convert BabylMessage to MaildirMessage
  1395. pairs = (('unseen', ''), ('deleted', 'ST'), ('filed', 'S'),
  1396. ('answered', 'RS'), ('forwarded', 'PS'), ('edited', 'S'),
  1397. ('resent', 'PS'))
  1398. for setting, result in pairs:
  1399. msg = mailbox.BabylMessage(_sample_message)
  1400. msg.add_label(setting)
  1401. self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), result)
  1402. self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
  1403. msg = mailbox.BabylMessage(_sample_message)
  1404. for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
  1405. 'edited', 'resent'):
  1406. msg.add_label(label)
  1407. self.assertEqual(mailbox.MaildirMessage(msg).get_flags(), 'PRT')
  1408. self.assertEqual(mailbox.MaildirMessage(msg).get_subdir(), 'cur')
  1409. def test_babyl_to_mboxmmdf(self):
  1410. # Convert BabylMessage to mboxMessage and MMDFMessage
  1411. pairs = (('unseen', 'O'), ('deleted', 'ROD'), ('filed', 'RO'),
  1412. ('answered', 'ROA'), ('forwarded', 'RO'), ('edited', 'RO'),
  1413. ('resent', 'RO'))
  1414. for setting, result in pairs:
  1415. for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
  1416. msg = mailbox.BabylMessage(_sample_message)
  1417. msg.add_label(setting)
  1418. self.assertEqual(class_(msg).get_flags(), result)
  1419. msg = mailbox.BabylMessage(_sample_message)
  1420. for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
  1421. 'edited', 'resent'):
  1422. msg.add_label(label)
  1423. for class_ in (mailbox.mboxMessage, mailbox.MMDFMessage):
  1424. self.assertEqual(class_(msg).get_flags(), 'ODA')
  1425. def test_babyl_to_mh(self):
  1426. # Convert BabylMessage to MHMessage
  1427. pairs = (('unseen', ['unseen']), ('deleted', []), ('filed', []),
  1428. ('answered', ['replied']), ('forwarded', []), ('edited', []),
  1429. ('resent', []))
  1430. for setting, result in pairs:
  1431. msg = mailbox.BabylMessage(_sample_message)
  1432. msg.add_label(setting)
  1433. self.assertEqual(mailbox.MHMessage(msg).get_sequences(), result)
  1434. msg = mailbox.BabylMessage(_sample_message)
  1435. for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
  1436. 'edited', 'resent'):
  1437. msg.add_label(label)
  1438. self.assertEqual(mailbox.MHMessage(msg).get_sequences(),
  1439. ['unseen', 'replied'])
  1440. def test_babyl_to_babyl(self):
  1441. # Convert BabylMessage to BabylMessage
  1442. msg = mailbox.BabylMessage(_sample_message)
  1443. msg.update_visible()
  1444. for label in ('unseen', 'deleted', 'filed', 'answered', 'forwarded',
  1445. 'edited', 'resent'):
  1446. msg.add_label(label)
  1447. msg2 = mailbox.BabylMessage(msg)
  1448. self.assertEqual(msg2.get_labels(), ['unseen', 'deleted', 'filed',
  1449. 'answered', 'forwarded', 'edited',
  1450. 'resent'])
  1451. self.assertEqual(msg.get_visible().keys(), msg2.get_visible().keys())
  1452. for key in msg.get_visible().keys():
  1453. self.assertEqual(msg.get_visible()[key], msg2.get_visible()[key])
  1454. class TestProxyFileBase(TestBase):
  1455. def _test_read(self, proxy):
  1456. # Read by byte
  1457. proxy.seek(0)
  1458. self.assertEqual(proxy.read(), 'bar')
  1459. proxy.seek(1)
  1460. self.assertEqual(proxy.read(), 'ar')
  1461. proxy.seek(0)
  1462. self.assertEqual(proxy.read(2), 'ba')
  1463. proxy.seek(1)
  1464. self.assertEqual(proxy.read(-1), 'ar')
  1465. proxy.seek(2)
  1466. self.assertEqual(proxy.read(1000), 'r')
  1467. def _test_readline(self, proxy):
  1468. # Read by line
  1469. proxy.seek(0)
  1470. self.assertEqual(proxy.readline(), 'foo' + os.linesep)
  1471. self.assertEqual(proxy.readline(), 'bar' + os.linesep)
  1472. self.assertEqual(proxy.readline(), 'fred' + os.linesep)
  1473. self.assertEqual(proxy.readline(), 'bob')
  1474. proxy.seek(2)
  1475. self.assertEqual(proxy.readline(), 'o' + os.linesep)
  1476. proxy.seek(6 + 2 * len(os.linesep))
  1477. self.assertEqual(proxy.readline(), 'fred' + os.linesep)
  1478. proxy.seek(6 + 2 * len(os.linesep))
  1479. self.assertEqual(proxy.readline(2), 'fr')
  1480. self.assertEqual(proxy.readline(-10), 'ed' + os.linesep)
  1481. def _test_readlines(self, proxy):
  1482. # Read multiple lines
  1483. proxy.seek(0)
  1484. self.assertEqual(proxy.readlines(), ['foo' + os.linesep,
  1485. 'bar' + os.linesep,
  1486. 'fred' + os.linesep, 'bob'])
  1487. proxy.seek(0)
  1488. self.assertEqual(proxy.readlines(2), ['foo' + os.linesep])
  1489. proxy.seek(3 + len(os.linesep))
  1490. self.assertEqual(proxy.readlines(4 + len(os.linesep)),
  1491. ['bar' + os.linesep, 'fred' + os.linesep])
  1492. proxy.seek(3)
  1493. self.assertEqual(proxy.readlines(1000), [os.linesep, 'bar' + os.linesep,
  1494. 'fred' + os.linesep, 'bob'])
  1495. def _test_iteration(self, proxy):
  1496. # Iterate by line
  1497. proxy.seek(0)
  1498. iterator = iter(proxy)
  1499. self.assertEqual(list(iterator),
  1500. ['foo' + os.linesep, 'bar' + os.linesep, 'fred' + os.linesep, 'bob'])
  1501. def _test_seek_and_tell(self, proxy):
  1502. # Seek and use tell to check position
  1503. proxy.seek(3)
  1504. self.assertEqual(proxy.tell(), 3)
  1505. self.assertEqual(proxy.read(len(os.linesep)), os.linesep)
  1506. proxy.seek(2, 1)
  1507. self.assertEqual(proxy.read(1 + len(os.linesep)), 'r' + os.linesep)
  1508. proxy.seek(-3 - len(os.linesep), 2)
  1509. self.assertEqual(proxy.read(3), 'bar')
  1510. proxy.seek(2, 0)
  1511. self.assertEqual(proxy.read(), 'o' + os.linesep + 'bar' + os.linesep)
  1512. proxy.seek(100)
  1513. self.assertEqual(proxy.read(), '')
  1514. def _test_close(self, proxy):
  1515. # Close a file
  1516. proxy.close()
  1517. # Issue 11700 subsequent closes should be a no-op, not an error.
  1518. proxy.close()
  1519. class TestProxyFile(TestProxyFileBase):
  1520. def setUp(self):
  1521. self._path = test_support.TESTFN
  1522. self._file = open(self._path, 'wb+')
  1523. def tearDown(self):
  1524. self._file.close()
  1525. self._delete_recursively(self._path)
  1526. def test_initialize(self):
  1527. # Initialize and check position
  1528. self._file.write('foo')
  1529. pos = self._file.tell()
  1530. proxy0 = mailbox._ProxyFile(self._file)
  1531. self.assertEqual(proxy0.tell(), pos)
  1532. self.assertEqual(self._file.tell(), pos)
  1533. proxy1 = mailbox._ProxyFile(self._file, 0)
  1534. self.assertEqual(proxy1.tell(), 0)
  1535. self.assertEqual(self._file.tell(), pos)
  1536. def test_read(self):
  1537. self._file.write('bar')
  1538. self._test_read(mailbox._ProxyFile(self._file))
  1539. def test_readline(self):
  1540. self._file.write('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
  1541. os.linesep))
  1542. self._test_readline(mailbox._ProxyFile(self._file))
  1543. def test_readlines(self):
  1544. self._file.write('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
  1545. os.linesep))
  1546. self._test_readlines(mailbox._ProxyFile(self._file))
  1547. def test_iteration(self):
  1548. self._file.write('foo%sbar%sfred%sbob' % (os.linesep, os.linesep,
  1549. os.linesep))
  1550. self._test_iteration(mailbox._ProxyFile(self._file))
  1551. def test_seek_and_tell(self):
  1552. self._file.write('foo%sbar%s' % (os.linesep, os.linesep))
  1553. self._test_seek_and_tell(mailbox._ProxyFile(self._file))
  1554. def test_close(self):
  1555. self._file.write('foo%sbar%s' % (os.linesep, os.linesep))
  1556. self._test_close(mailbox._ProxyFile(self._file))
  1557. class TestPartialFile(TestProxyFileBase):
  1558. def setUp(self):
  1559. self._path = test_support.TESTFN
  1560. self._file = open(self._path, 'wb+')
  1561. def tearDown(self):
  1562. self._file.close()
  1563. self._delete_recursively(self._path)
  1564. def test_initialize(self):
  1565. # Initialize and check position
  1566. self._file.write('foo' + os.linesep + 'bar')
  1567. pos = self._file.tell()
  1568. proxy = mailbox._PartialFile(self._file, 2, 5)
  1569. self.assertEqual(proxy.tell(), 0)
  1570. self.assertEqual(self._file.tell(), pos)
  1571. def test_read(self):
  1572. self._file.write('***bar***')
  1573. self._test_read(mailbox._PartialFile(self._file, 3, 6))
  1574. def test_readline(self):
  1575. self._file.write('!!!!!foo%sbar%sfred%sbob!!!!!' %
  1576. (os.linesep, os.linesep, os.linesep))
  1577. self._test_readline(mailbox._PartialFile(self._file, 5,
  1578. 18 + 3 * len(os.linesep)))
  1579. def test_readlines(self):
  1580. self._file.write('foo%sbar%sfred%sbob?????' %
  1581. (os.linesep, os.linesep, os.linesep))
  1582. self._test_readlines(mailbox._PartialFile(self._file, 0,
  1583. 13 + 3 * len(os.linesep)))
  1584. def test_iteration(self):
  1585. self._file.write('____foo%sbar%sfred%sbob####' %
  1586. (os.linesep, os.linesep, os.linesep))
  1587. self._test_iteration(mailbox._PartialFile(self._file, 4,
  1588. 17 + 3 * len(os.linesep)))
  1589. def test_seek_and_tell(self):
  1590. self._file.write('(((foo%sbar%s$$$' % (os.linesep, os.linesep))
  1591. self._test_seek_and_tell(mailbox._PartialFile(self._file, 3,
  1592. 9 + 2 * len(os.linesep)))
  1593. def test_close(self):
  1594. self._file.write('&foo%sbar%s^' % (os.linesep, os.linesep))
  1595. self._test_close(mailbox._PartialFile(self._file, 1,
  1596. 6 + 3 * len(os.linesep)))
  1597. ## Start: tests from the original module (for backward compatibility).
  1598. FROM_ = "From some.body@dummy.domain Sat Jul 24 13:43:35 2004\n"
  1599. DUMMY_MESSAGE = """\
  1600. From: some.body@dummy.domain
  1601. To: me@my.domain
  1602. Subject: Simple Test
  1603. This is a dummy message.
  1604. """
  1605. class MaildirTestCase(unittest.TestCase):
  1606. def setUp(self):
  1607. # create a new maildir mailbox to work with:
  1608. self._dir = test_support.TESTFN
  1609. os.mkdir(self._dir)
  1610. os.mkdir(os.path.join(self._dir, "cur"))
  1611. os.mkdir(os.path.join(self._dir, "tmp"))
  1612. os.mkdir(os.path.join(self._dir, "new"))
  1613. self._counter = 1
  1614. self._msgfiles = []
  1615. def tearDown(self):
  1616. map(os.unlink, self._msgfiles)
  1617. os.rmdir(os.path.join(self._dir, "cur"))
  1618. os.rmdir(os.path.join(self._dir, "tmp"))
  1619. os.rmdir(os.path.join(self._dir, "new"))
  1620. os.rmdir(self._dir)
  1621. def createMessage(self, dir, mbox=False):
  1622. t = int(time.time() % 1000000)
  1623. pid = self._counter
  1624. self._counter += 1
  1625. filename = os.extsep.join((str(t), str(pid), "myhostname", "mydomain"))
  1626. tmpname = os.path.join(self._dir, "tmp", filename)
  1627. newname = os.path.join(self._dir, dir, filename)
  1628. with open(tmpname, "w") as fp:
  1629. self._msgfiles.append(tmpname)
  1630. if mbox:
  1631. fp.write(FROM_)
  1632. fp.write(DUMMY_MESSAGE)
  1633. if hasattr(os, "link"):
  1634. os.link(tmpname, newname)
  1635. else:
  1636. with open(newname, "w") as fp:
  1637. fp.write(DUMMY_MESSAGE)
  1638. self._msgfiles.append(newname)
  1639. return tmpname
  1640. def test_empty_maildir(self):
  1641. """Test an empty maildir mailbox"""
  1642. # Test for regression on bug #117490:
  1643. # Make sure the boxes attribute actually gets set.
  1644. self.mbox = mailbox.Maildir(test_support.TESTFN)
  1645. #self.assertTrue(hasattr(self.mbox, "boxes"))
  1646. #self.assertTrue(len(self.mbox.boxes) == 0)
  1647. self.assertIs(self.mbox.next(), None)
  1648. self.assertIs(self.mbox.next(), None)
  1649. def test_nonempty_maildir_cur(self):
  1650. self.createMessage("cur")
  1651. self.mbox = mailbox.Maildir(test_support.TESTFN)
  1652. #self.assertTrue(len(self.mbox.boxes) == 1)
  1653. self.assertIsNot(self.mbox.next(), None)
  1654. self.assertIs(self.mbox.next(), None)
  1655. self.assertIs(self.mbox.next(), None)
  1656. def test_nonempty_maildir_new(self):
  1657. self.createMessage("new")
  1658. self.mbox = mailbox.Maildir(test_support.TESTFN)
  1659. #self.assertTrue(len(self.mbox.boxes) == 1)
  1660. self.assertIsNot(self.mbox.next(), None)
  1661. self.assertIs(self.mbox.next(), None)
  1662. self.assertIs(self.mbox.next(), None)
  1663. def test_nonempty_maildir_both(self):
  1664. self.createMessage("cur")
  1665. self.createMessage("new")
  1666. self.mbox = mailbox.Maildir(test_support.TESTFN)
  1667. #self.assertTrue(len(self.mbox.boxes) == 2)
  1668. self.assertIsNot(self.mbox.next(), None)
  1669. self.assertIsNot(self.mbox.next(), None)
  1670. self.assertIs(self.mbox.next(), None)
  1671. self.assertIs(self.mbox.next(), None)
  1672. def test_unix_mbox(self):
  1673. ### should be better!
  1674. import email.parser
  1675. fname = self.createMessage("cur", True)
  1676. n = 0
  1677. for msg in mailbox.PortableUnixMailbox(open(fname),
  1678. email.parser.Parser().parse):
  1679. n += 1
  1680. self.assertEqual(msg["subject"], "Simple Test")
  1681. self.assertEqual(len(str(msg)), len(FROM_)+len(DUMMY_MESSAGE))
  1682. self.assertEqual(n, 1)
  1683. ## End: classes from the original module (for backward compatibility).
  1684. _sample_message = """\
  1685. Return-Path: <gkj@gregorykjohnson.com>
  1686. X-Original-To: gkj+person@localhost
  1687. Delivered-To: gkj+person@localhost
  1688. Received: from localhost (localhost [127.0.0.1])
  1689. by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
  1690. for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
  1691. Delivered-To: gkj@sundance.gregorykjohnson.com
  1692. Received: from localhost [127.0.0.1]
  1693. by localhost with POP3 (fetchmail-6.2.5)
  1694. for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)
  1695. Received: from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
  1696. by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
  1697. for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
  1698. Received: by andy.gregorykjohnson.com (Postfix, from userid 1000)
  1699. id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)
  1700. Date: Wed, 13 Jul 2005 17:23:11 -0400
  1701. From: "Gregory K. Johnson" <gkj@gregorykjohnson.com>
  1702. To: gkj@gregorykjohnson.com
  1703. Subject: Sample message
  1704. Message-ID: <20050713212311.GC4701@andy.gregorykjohnson.com>
  1705. Mime-Version: 1.0
  1706. Content-Type: multipart/mixed; boundary="NMuMz9nt05w80d4+"
  1707. Content-Disposition: inline
  1708. User-Agent: Mutt/1.5.9i
  1709. --NMuMz9nt05w80d4+
  1710. Content-Type: text/plain; charset=us-ascii
  1711. Content-Disposition: inline
  1712. This is a sample message.
  1713. --
  1714. Gregory K. Johnson
  1715. --NMuMz9nt05w80d4+
  1716. Content-Type: application/octet-stream
  1717. Content-Disposition: attachment; filename="text.gz"
  1718. Content-Transfer-Encoding: base64
  1719. H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
  1720. 3FYlAAAA
  1721. --NMuMz9nt05w80d4+--
  1722. """
  1723. _sample_headers = {
  1724. "Return-Path":"<gkj@gregorykjohnson.com>",
  1725. "X-Original-To":"gkj+person@localhost",
  1726. "Delivered-To":"gkj+person@localhost",
  1727. "Received":"""from localhost (localhost [127.0.0.1])
  1728. by andy.gregorykjohnson.com (Postfix) with ESMTP id 356ED9DD17
  1729. for <gkj+person@localhost>; Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
  1730. "Delivered-To":"gkj@sundance.gregorykjohnson.com",
  1731. "Received":"""from localhost [127.0.0.1]
  1732. by localhost with POP3 (fetchmail-6.2.5)
  1733. for gkj+person@localhost (single-drop); Wed, 13 Jul 2005 17:23:16 -0400 (EDT)""",
  1734. "Received":"""from andy.gregorykjohnson.com (andy.gregorykjohnson.com [64.32.235.228])
  1735. by sundance.gregorykjohnson.com (Postfix) with ESMTP id 5B056316746
  1736. for <gkj@gregorykjohnson.com>; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
  1737. "Received":"""by andy.gregorykjohnson.com (Postfix, from userid 1000)
  1738. id 490CD9DD17; Wed, 13 Jul 2005 17:23:11 -0400 (EDT)""",
  1739. "Date":"Wed, 13 Jul 2005 17:23:11 -0400",
  1740. "From":""""Gregory K. Johnson" <gkj@gregorykjohnson.com>""",
  1741. "To":"gkj@gregorykjohnson.com",
  1742. "Subject":"Sample message",
  1743. "Mime-Version":"1.0",
  1744. "Content-Type":"""multipart/mixed; boundary="NMuMz9nt05w80d4+\"""",
  1745. "Content-Disposition":"inline",
  1746. "User-Agent": "Mutt/1.5.9i" }
  1747. _sample_payloads = ("""This is a sample message.
  1748. --
  1749. Gregory K. Johnson
  1750. """,
  1751. """H4sICM2D1UIAA3RleHQAC8nILFYAokSFktSKEoW0zJxUPa7wzJIMhZLyfIWczLzUYj0uAHTs
  1752. 3FYlAAAA
  1753. """)
  1754. def test_main():
  1755. tests = (TestMailboxSuperclass, TestMaildir, TestMbox, TestMMDF, TestMH,
  1756. TestBabyl, TestMessage, TestMaildirMessage, TestMboxMessage,
  1757. TestMHMessage, TestBabylMessage, TestMMDFMessage,
  1758. TestMessageConversion, TestProxyFile, TestPartialFile,
  1759. MaildirTestCase)
  1760. test_support.run_unittest(*tests)
  1761. test_support.reap_children()
  1762. if __name__ == '__main__':
  1763. test_main()