1
# Copyright (c) 2012 Canonical Ltd
3
# This program is free software: you can redistribute it and/or modify
4
# it under the terms of the GNU Affero General Public License as published by
5
# the Free Software Foundation, either version 3 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU Affero General Public License for more details.
13
# You should have received a copy of the GNU Affero General Public
14
# License along with this program. If not, see
15
# <http://www.gnu.org/licenses/>.
20
from email.utils import formatdate
22
from tempfile import _RandomNameSequence
26
from dateutil.tz import (
30
from pycassa.util import convert_uuid_to_time
32
from grackle.model import (
39
TEMPLATE_MESSAGE = """\
40
From: sysadmin@example.com
41
To: developer@example.com
42
Subject: Everything is broken
46
Help, everything has just broken.
49
TEST_MESSAGE = TEMPLATE_MESSAGE.format(
50
date='Sat, 1 Jan 2000 11:02:34 +1100',
51
id='<aaaaaaaaaaaaa@example.com>')
54
class TestParseMessage(unittest.TestCase):
57
# _parse_message extracts interesting fields. It also parses the
58
# date and returns it separately.
59
date, msg = _parse_message(TEST_MESSAGE)
60
self.assertEqual('sysadmin@example.com', msg['from'])
61
self.assertEqual('developer@example.com', msg['to'])
62
self.assertEqual('Everything is broken', msg['subject'])
63
self.assertEqual('2000-01-01T11:02:34+11:00', msg['date'])
64
self.assertEqual('<aaaaaaaaaaaaa@example.com>', msg['message-id'])
67
2000, 1, 1, 11, 2, 34, tzinfo=tzoffset('', 39600)),
71
class TestAddMessage(unittest.TestCase):
73
def test_add_message(self):
74
c = CassandraConnection(
75
os.environ['GRACKLE_TEST_KEYSPACE'], ['localhost:9160'])
76
archive = next(_RandomNameSequence())
78
# Write the message out to Cassandra, and read it back in.
79
key = c.add_message(archive, TEST_MESSAGE)
80
cmsg = c.messages.get(key)
82
# The archive should contain a single message, a reference to
84
archive_messages = c.archive_messages.get(archive).items()
85
self.assertEqual(1, len(archive_messages))
86
self.assertEqual(key, archive_messages[0][1])
88
# The key in archive_message is a TimeUUID for the Date field in
89
# the message. There is no UTC equivalent of time.mktime, so we
90
# must subtract the offset.
91
utctime = time.mktime(datetime.datetime(
92
2000, 1, 1, 0, 2, 34, tzinfo=tzutc()).timetuple()) - time.timezone
95
convert_uuid_to_time(archive_messages[0][0]))
97
# The stored message contains the full original text of the
98
# message, as well as interesting fields parsed out.
99
self.assertEqual(TEST_MESSAGE, cmsg['content'])
100
parsed_message = _parse_message(TEST_MESSAGE)[1]
101
for key, value in parsed_message.iteritems():
102
self.assertEqual(value, cmsg[key])
105
class TestGetMessages(unittest.TestCase):
107
def assertMessages(self, expected_ids, messages):
109
'<message%d@example.com>' % id for id in expected_ids]
110
actual_msgids = [msg['headers']['message-id'] for msg in messages]
111
self.assertEqual(expected_msgids, actual_msgids)
113
def makeMessages(self, conn, archive, count):
117
TEMPLATE_MESSAGE.format(
118
date=formatdate(i * 100),
119
id='<message%d@example.com>' % i))
120
for i in range(count)]
122
def makeArchive(self):
123
conn = CassandraConnection(
124
os.environ['GRACKLE_TEST_KEYSPACE'], ['localhost:9160'])
125
archive = next(_RandomNameSequence())
128
def test_single_message(self):
129
conn, archive = self.makeArchive()
130
self.makeMessages(conn, archive, 1)
132
# We get a single message when we ask for it.
133
messages = conn.get_messages(archive, 'date', 1, '')[1]
134
self.assertMessages([0], messages)
137
# The content matches what we generated, and the result is
138
# formatted according to the default settings.
139
expected_content = TEMPLATE_MESSAGE.format(
140
date=formatdate(0), id='<message0@example.com>')
141
self.assertEqual(expected_content, messages[0]['content'])
142
pmsg = _parse_message(expected_content)[1]
143
pmsg['content'] = expected_content
147
headers=['date', 'from', 'subject', 'message-id'],
151
def test_limit(self):
152
conn, archive = self.makeArchive()
153
self.makeMessages(conn, archive, 4)
155
[0, 1], conn.get_messages(archive, 'date', 2, '')[1])
157
def test_order(self):
158
conn, archive = self.makeArchive()
159
self.makeMessages(conn, archive, 4)
161
[3, 2], conn.get_messages(archive, '-date', 2, '')[1])
163
def test_batching_forward(self):
164
conn, archive = self.makeArchive()
165
self.makeMessages(conn, archive, 5)
166
prev, messages, next = conn.get_messages(archive, 'date', 2, '')
167
self.assertMessages([0, 1], messages)
168
prev, messages, next = conn.get_messages(archive, 'date', 2, next)
169
self.assertMessages([2, 3], messages)
170
prev, messages, next = conn.get_messages(archive, 'date', 2, next)
171
self.assertMessages([4], messages)
172
prev, messages, next = conn.get_messages(archive, 'date', 2, next)
173
self.assertIs(None, prev)
174
self.assertMessages([], messages)
175
self.assertIs(None, next)
177
def test_batching_backward(self):
178
conn, archive = self.makeArchive()
179
self.makeMessages(conn, archive, 5)
180
prev, messages, next = conn.get_messages(archive, 'date', 2, '')
181
self.assertMessages([0, 1], messages)
182
prev, messages, next = conn.get_messages(archive, 'date', 2, next)
183
self.assertMessages([2, 3], messages)
184
prev, messages, next = conn.get_messages(
185
archive, 'date', 2, prev, backward=True)
186
self.assertMessages([0, 1], messages)
187
prev, messages, next = conn.get_messages(
188
archive, 'date', 2, prev, backward=True)
189
self.assertIs(None, prev)
190
self.assertMessages([], messages)
191
self.assertIs(None, next)
193
def test_date_filter(self):
194
conn, archive = self.makeArchive()
195
self.makeMessages(conn, archive, 10)
196
start = datetime.datetime.utcfromtimestamp(250).replace(
198
finish = datetime.datetime.utcfromtimestamp(500).replace(
200
prev, messages, next = conn.get_messages(
201
archive, 'date', 2, '', start_date=start, finish_date=finish)
202
self.assertMessages([3, 4], messages)
203
prev, messages, next = conn.get_messages(
204
archive, 'date', 2, next, start_date=start, finish_date=finish)
205
self.assertMessages([5], messages)
208
class TestMessageFormatter(unittest.TestCase):
211
parsed = _parse_message(TEST_MESSAGE)[1]
212
parsed['content'] = TEST_MESSAGE
213
formatted = _format_message(
215
headers=['date', 'from', 'subject', 'message-id'],
219
'date': '2000-01-01T11:02:34+11:00',
220
'from': 'sysadmin@example.com',
221
'message-id': '<aaaaaaaaaaaaa@example.com>',
222
'subject': 'Everything is broken',
224
'content': TEST_MESSAGE,
226
self.assertEqual(expected, formatted)