~unity-2d-team/unity-2d/Shell-MultiMonitor

« back to all changes in this revision

Viewing changes to grackle/tests/test_model.py

  • Committer: Aaron Bentley
  • Date: 2012-01-10 11:16:56 UTC
  • Revision ID: aaron@canonical.com-20120110111656-9daoyj766z8r184a
Add test framework.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (c) 2012 Canonical Ltd
2
 
#
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.
7
 
#
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.
12
 
#
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/>.
16
 
 
17
 
__metaclass__ = type
18
 
 
19
 
import datetime
20
 
from email.utils import formatdate
21
 
import os
22
 
from tempfile import _RandomNameSequence
23
 
import time
24
 
import unittest
25
 
 
26
 
from dateutil.tz import (
27
 
    tzoffset,
28
 
    tzutc,
29
 
    )
30
 
from pycassa.util import convert_uuid_to_time
31
 
 
32
 
from grackle.model import (
33
 
    CassandraConnection,
34
 
    FORMATS,
35
 
    _format_message,
36
 
    _parse_message,
37
 
    )
38
 
 
39
 
 
40
 
TEMPLATE_MESSAGE = """\
41
 
From: sysadmin@example.com
42
 
To: developer@example.com
43
 
Subject: Everything is broken
44
 
Date: {date}
45
 
Message-Id: {id}
46
 
 
47
 
Help, everything has just broken.
48
 
"""
49
 
 
50
 
TEST_MESSAGE = TEMPLATE_MESSAGE.format(
51
 
    date='Sat, 1 Jan 2000 11:02:34 +1100',
52
 
    id='<aaaaaaaaaaaaa@example.com>')
53
 
 
54
 
 
55
 
class TestParseMessage(unittest.TestCase):
56
 
 
57
 
    def test_works(self):
58
 
        # _parse_message extracts interesting fields. It also parses the
59
 
        # date and returns it separately.
60
 
        date, msg = _parse_message(TEST_MESSAGE)
61
 
        self.assertEqual('sysadmin@example.com', msg['from'])
62
 
        self.assertEqual('developer@example.com', msg['to'])
63
 
        self.assertEqual('Everything is broken', msg['subject'])
64
 
        self.assertEqual('2000-01-01T11:02:34+11:00', msg['date'])
65
 
        self.assertEqual('<aaaaaaaaaaaaa@example.com>', msg['message-id'])
66
 
        self.assertEqual(
67
 
            datetime.datetime(
68
 
                2000, 1, 1, 11, 2, 34, tzinfo=tzoffset('', 39600)),
69
 
            date)
70
 
 
71
 
 
72
 
class TestAddMessage(unittest.TestCase):
73
 
 
74
 
    def test_add_message(self):
75
 
        c = CassandraConnection(
76
 
            os.environ['GRACKLE_TEST_KEYSPACE'], ['localhost:9160'])
77
 
        archive = next(_RandomNameSequence())
78
 
 
79
 
        # Write the message out to Cassandra, and read it back in.
80
 
        key = c.add_message(archive, TEST_MESSAGE)
81
 
        cmsg = c.messages.get(key)
82
 
 
83
 
        # The archive should contain a single message, a reference to
84
 
        # our new key.
85
 
        archive_messages = c.archive_messages.get(archive).items()
86
 
        self.assertEqual(1, len(archive_messages))
87
 
        self.assertEqual(key, archive_messages[0][1])
88
 
 
89
 
        # The key in archive_message is a TimeUUID for the Date field in
90
 
        # the message. There is no UTC equivalent of time.mktime, so we
91
 
        # must subtract the offset.
92
 
        utctime = time.mktime(datetime.datetime(
93
 
            2000, 1, 1, 0, 2, 34, tzinfo=tzutc()).timetuple()) - time.timezone
94
 
        self.assertEqual(
95
 
            utctime,
96
 
            convert_uuid_to_time(archive_messages[0][0]))
97
 
 
98
 
        # The stored message contains the full original text of the
99
 
        # message, as well as interesting fields parsed out.
100
 
        self.assertEqual(TEST_MESSAGE, cmsg['content'])
101
 
        parsed_message = _parse_message(TEST_MESSAGE)[1]
102
 
        for key, value in parsed_message.iteritems():
103
 
            self.assertEqual(value, cmsg[key])
104
 
 
105
 
 
106
 
class TestGetMessages(unittest.TestCase):
107
 
 
108
 
    def assertMessages(self, expected_ids, messages):
109
 
        expected_msgids = [
110
 
            '<message%d@example.com>' % id for id in expected_ids]
111
 
        actual_msgids = [msg['message-id'] for msg in messages]
112
 
        self.assertEqual(expected_msgids, actual_msgids)
113
 
 
114
 
    def makeMessages(self, conn, archive, count):
115
 
        return [
116
 
            conn.add_message(
117
 
                archive,
118
 
                TEMPLATE_MESSAGE.format(
119
 
                    date=formatdate(i * 100),
120
 
                    id='<message%d@example.com>' % i))
121
 
            for i in range(count)]
122
 
 
123
 
    def makeArchive(self):
124
 
        conn = CassandraConnection(
125
 
            os.environ['GRACKLE_TEST_KEYSPACE'], ['localhost:9160'])
126
 
        archive = next(_RandomNameSequence())
127
 
        return conn, archive
128
 
 
129
 
    def test_single_message(self):
130
 
        conn, archive = self.makeArchive()
131
 
        self.makeMessages(conn, archive, 1)
132
 
 
133
 
        # We get a single message when we ask for it.
134
 
        messages = conn.get_messages(archive, 'date', 1, '')[1]
135
 
        self.assertMessages([0], messages)
136
 
        cmsg = messages[0]
137
 
 
138
 
        # The content matches what we generated, and the result is
139
 
        # formatted according to the default settings.
140
 
        expected_content = TEMPLATE_MESSAGE.format(
141
 
            date=formatdate(0), id='<message0@example.com>')
142
 
        self.assertEqual(expected_content, messages[0]['content'])
143
 
        pmsg = _parse_message(expected_content)[1]
144
 
        pmsg['content'] = expected_content
145
 
        self.assertEqual(
146
 
            _format_message(
147
 
                ['date', 'from', 'subject', 'message-id', 'content'],
148
 
                pmsg),
149
 
            cmsg)
150
 
 
151
 
    def test_limit(self):
152
 
        conn, archive = self.makeArchive()
153
 
        self.makeMessages(conn, archive, 4)
154
 
        self.assertMessages(
155
 
            [0, 1], conn.get_messages(archive, 'date', 2, '')[1])
156
 
 
157
 
    def test_order(self):
158
 
        conn, archive = self.makeArchive()
159
 
        self.makeMessages(conn, archive, 4)
160
 
        self.assertMessages(
161
 
            [3, 2], conn.get_messages(archive, '-date', 2, '')[1])
162
 
 
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)
176
 
 
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)
192
 
 
193
 
    def test_date_filter(self):
194
 
        conn, archive = self.makeArchive()
195
 
        self.makeMessages(conn, archive, 10)
196
 
        start = datetime.datetime.utcfromtimestamp(250).replace(
197
 
            tzinfo=tzutc())
198
 
        finish = datetime.datetime.utcfromtimestamp(500).replace(
199
 
            tzinfo=tzutc())
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)
206
 
 
207
 
 
208
 
class TestMessageFormatters(unittest.TestCase):
209
 
 
210
 
    def test_all(self):
211
 
        parsed = _parse_message(TEST_MESSAGE)[1]
212
 
        parsed['content'] = TEST_MESSAGE
213
 
        want, func = FORMATS['all'](['date', 'from', 'subject', 'message-id'])
214
 
        self.assertEqual(
215
 
            ['content', 'date', 'from', 'message-id', 'subject'],
216
 
            sorted(want))
217
 
        formatted = func(parsed)
218
 
        expected = {
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',
223
 
            'content': TEST_MESSAGE,
224
 
            }
225
 
        self.assertEqual(expected, formatted)