1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
# Copyright (C) 2014-2015 by the Free Software Foundation, Inc.
#
# This file is part of GNU Mailman.
#
# GNU Mailman is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option)
# any later version.
#
# GNU Mailman is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
# more details.
#
# You should have received a copy of the GNU General Public License along with
# GNU Mailman. If not, see <http://www.gnu.org/licenses/>.
"""Test the message store."""
__all__ = [
'TestMessageStore',
]
import os
import unittest
from mailman.config import config
from mailman.interfaces.messages import IMessageStore
from mailman.model.message import Message
from mailman.testing.helpers import (
specialized_message_from_string as mfs)
from mailman.testing.layers import ConfigLayer
from mailman.utilities.email import add_message_hash
from zope.component import getUtility
class TestMessageStore(unittest.TestCase):
layer = ConfigLayer
def setUp(self):
self._store = getUtility(IMessageStore)
def test_message_id_required(self):
# The Message-ID header is required in order to add it to the store.
message = mfs("""\
Subject: An important message
This message is very important.
""")
self.assertRaises(ValueError, self._store.add, message)
def test_get_message_by_hash(self):
# Messages have an X-Message-ID-Hash header, the value of which can be
# used to look the message up in the message store.
msg = mfs("""\
Subject: An important message
Message-ID: <ant>
This message is very important.
""")
add_message_hash(msg)
self._store.add(msg)
self.assertEqual(msg['x-message-id-hash'],
'MS6QLWERIJLGCRF44J7USBFDELMNT2BW')
found = self._store.get_message_by_hash(
'MS6QLWERIJLGCRF44J7USBFDELMNT2BW')
self.assertEqual(found['message-id'], '<ant>')
self.assertEqual(found['x-message-id-hash'],
'MS6QLWERIJLGCRF44J7USBFDELMNT2BW')
def test_can_delete_missing_message(self):
# Deleting a message which isn't in the store does not raise an
# exception.
msg = mfs("""\
Message-ID: <ant>
""")
self._store.add(msg)
self.assertEqual(len(list(self._store.messages)), 1)
self._store.delete_message('missing')
self.assertEqual(len(list(self._store.messages)), 1)
def test_can_survive_missing_message_path(self):
# Deleting a message which is in the store, but which doesn't appear
# on the file system does not raise an exception, but still removes
# the message from the store.
msg = mfs("""\
Message-ID: <ant>
""")
self._store.add(msg)
self.assertEqual(len(list(self._store.messages)), 1)
# We have to use the SQLAlchemy API because the .get_message_by_*()
# methods return email Message objects, not IMessages. The former
# does not give us the path to the object on the file system.
row = config.db.store.query(Message).filter_by(
message_id='<ant>').first()
os.remove(os.path.join(config.MESSAGES_DIR, row.path))
self._store.delete_message('<ant>')
self.assertEqual(len(list(self._store.messages)), 0)
def test_message_id_hash(self):
# The new specification calls for a Message-ID-Hash header,
# specifically without the X- prefix.
msg = mfs("""\
Message-ID: <ant>
""")
self._store.add(msg)
stored_msg = self._store.get_message_by_id('<ant>')
self.assertEqual(stored_msg['message-id-hash'],
'MS6QLWERIJLGCRF44J7USBFDELMNT2BW')
# For backward compatibility with the old spec.
self.assertEqual(stored_msg['x-message-id-hash'],
'MS6QLWERIJLGCRF44J7USBFDELMNT2BW')
def test_message_id_hash_gets_replaced(self):
# Any existing Message-ID-Hash header (or for backward compatibility
# X-Message-ID-Hash) gets replaced with its new value.
msg = mfs("""\
Subject: Testing
Message-ID: <ant>
Message-ID-Hash: abc
X-Message-ID-Hash: abc
""")
self._store.add(msg)
stored_msg = self._store.get_message_by_id('<ant>')
message_id_hashes = stored_msg.get_all('message-id-hash')
self.assertEqual(len(message_id_hashes), 1)
self.assertEqual(message_id_hashes[0],
'MS6QLWERIJLGCRF44J7USBFDELMNT2BW')
# For backward compatibility with the old spec.
x_message_id_hashes = stored_msg.get_all('x-message-id-hash')
self.assertEqual(len(x_message_id_hashes), 1)
self.assertEqual(x_message_id_hashes[0],
'MS6QLWERIJLGCRF44J7USBFDELMNT2BW')
|
