forked from chaoss/grimoirelab-perceval
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathtest_hyperkitty.py
369 lines (278 loc) · 15 KB
/
test_hyperkitty.py
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Copyright (C) 2015-2020 Bitergia
#
# This program 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.
#
# This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
#
# Authors:
# Santiago Dueñas <[email protected]>
# Valerio Cosentino <[email protected]>
# Miguel Ángel Fernández <[email protected]>
# Harshal Mittal <[email protected]>
#
import datetime
import os
import shutil
import tempfile
import unittest
import unittest.mock
import dateutil.tz
import httpretty
from perceval.backend import BackendCommandArgumentParser
from perceval.utils import DEFAULT_DATETIME
from perceval.backends.core.mbox import MailingList
from perceval.backends.core.hyperkitty import (HyperKitty,
HyperKittyCommand,
HyperKittyList)
HYPERKITTY_URL = 'http://example.com/archives/list/[email protected]/'
HYPERKITTY_MARCH_MBOX_URL = HYPERKITTY_URL + '/export/2016-03.mbox.gz'
HYPERKITTY_APRIL_MBOX_URL = HYPERKITTY_URL + '/export/2016-04.mbox.gz'
def read_file(filename, mode='r'):
with open(os.path.join(os.path.dirname(os.path.abspath(__file__)), filename), mode) as f:
content = f.read()
return content
class TestHyperKittyList(unittest.TestCase):
"""Tests for HyperKittyList class"""
def setUp(self):
self.tmp_path = tempfile.mkdtemp(prefix='perceval_')
def tearDown(self):
shutil.rmtree(self.tmp_path)
def test_init(self):
"""Check attributes initialization"""
hkls = HyperKittyList(HYPERKITTY_URL, self.tmp_path)
self.assertIsInstance(hkls, MailingList)
self.assertEqual(hkls.uri, HYPERKITTY_URL)
self.assertEqual(hkls.dirpath, self.tmp_path)
self.assertEqual(hkls.client.base_url, HYPERKITTY_URL)
@httpretty.activate
@unittest.mock.patch('perceval.backends.core.hyperkitty.datetime_utcnow')
def test_fetch(self, mock_utcnow):
"""Test whether archives are fetched"""
mock_utcnow.return_value = datetime.datetime(2016, 4, 10,
tzinfo=dateutil.tz.tzutc())
mbox_march = read_file('data/hyperkitty/hyperkitty_2016_march.mbox')
mbox_april = read_file('data/hyperkitty/hyperkitty_2016_april.mbox')
httpretty.register_uri(httpretty.GET,
HYPERKITTY_URL,
body="")
httpretty.register_uri(httpretty.GET,
HYPERKITTY_URL + 'export/2016-03.mbox.gz',
body=mbox_march)
httpretty.register_uri(httpretty.GET,
HYPERKITTY_URL + 'export/2016-04.mbox.gz',
body=mbox_april)
from_date = datetime.datetime(2016, 3, 10)
hkls = HyperKittyList('http://example.com/archives/list/[email protected]/',
self.tmp_path)
fetched = hkls.fetch(from_date=from_date)
self.assertEqual(len(fetched), 2)
self.assertEqual(fetched[0][0], HYPERKITTY_URL + 'export/2016-03.mbox.gz')
self.assertEqual(fetched[0][1], os.path.join(self.tmp_path, '2016-03.mbox.gz'))
self.assertEqual(fetched[1][0], HYPERKITTY_URL + 'export/2016-04.mbox.gz')
self.assertEqual(fetched[1][1], os.path.join(self.tmp_path, '2016-04.mbox.gz'))
mboxes = hkls.mboxes
self.assertEqual(mboxes[0].filepath, os.path.join(self.tmp_path, '2016-03.mbox.gz'))
self.assertEqual(mboxes[1].filepath, os.path.join(self.tmp_path, '2016-04.mbox.gz'))
@httpretty.activate
@unittest.mock.patch('perceval.backends.core.hyperkitty.datetime_utcnow')
def test_fetch_from_date_after_current_day(self, mock_utcnow):
"""Test if it does not store anything when from_date is a date from the future"""
mock_utcnow.return_value = datetime.datetime(2016, 4, 10,
tzinfo=dateutil.tz.tzutc())
httpretty.register_uri(httpretty.GET,
HYPERKITTY_URL,
body="")
from_date = datetime.datetime(2017, 1, 10)
hkls = HyperKittyList('http://example.com/archives/list/[email protected]/',
self.tmp_path)
fetched = hkls.fetch(from_date=from_date)
self.assertEqual(len(fetched), 0)
def test_mboxes(self):
"""Test whether it returns the mboxes ordered by the date on their filenames"""
# Simulate the fetch process copying the files
shutil.copy(os.path.join(os.path.dirname(os.path.abspath(__file__)), 'data/hyperkitty/hyperkitty_2016_march.mbox'),
os.path.join(self.tmp_path, '2016-03.mbox.gz'))
shutil.copy(os.path.join(os.path.dirname(os.path.abspath(__file__)), 'data/hyperkitty/hyperkitty_2016_april.mbox'),
os.path.join(self.tmp_path, '2016-04.mbox.gz'))
hkls = HyperKittyList('http://example.com/archives/list/[email protected]/',
self.tmp_path)
mboxes = hkls.mboxes
self.assertEqual(mboxes[0].filepath, os.path.join(self.tmp_path, '2016-03.mbox.gz'))
self.assertEqual(mboxes[1].filepath, os.path.join(self.tmp_path, '2016-04.mbox.gz'))
class TestHyperKittyBackend(unittest.TestCase):
"""Tests for HyperKitty backend class"""
def setUp(self):
self.tmp_path = tempfile.mkdtemp(prefix='perceval_')
def tearDown(self):
shutil.rmtree(self.tmp_path)
def test_initialization(self):
"""Test whether attributes are initializated"""
backend = HyperKitty('http://example.com/', self.tmp_path, tag='test')
self.assertEqual(backend.url, 'http://example.com/')
self.assertEqual(backend.uri, 'http://example.com/')
self.assertEqual(backend.dirpath, self.tmp_path)
self.assertEqual(backend.origin, 'http://example.com/')
self.assertEqual(backend.tag, 'test')
self.assertTrue(backend.ssl_verify)
# When tag is empty or None it will be set to
# the value in uri
backend = HyperKitty('http://example.com/', self.tmp_path, ssl_verify=False)
self.assertEqual(backend.origin, 'http://example.com/')
self.assertEqual(backend.tag, 'http://example.com/')
self.assertFalse(backend.ssl_verify)
backend = HyperKitty('http://example.com/', self.tmp_path, tag='')
self.assertEqual(backend.origin, 'http://example.com/')
self.assertEqual(backend.tag, 'http://example.com/')
def test_has_archiving(self):
"""Test if it returns False when has_archiving is called"""
self.assertEqual(HyperKitty.has_archiving(), False)
def test_has_resuming(self):
"""Test if it returns True when has_resuming is called"""
self.assertEqual(HyperKitty.has_resuming(), True)
@httpretty.activate
@unittest.mock.patch('perceval.backends.core.hyperkitty.datetime_utcnow')
def test_fetch(self, mock_utcnow):
"""Test whether archives are fetched"""
mock_utcnow.return_value = datetime.datetime(2016, 4, 10,
tzinfo=dateutil.tz.tzutc())
mbox_march = read_file('data/hyperkitty/hyperkitty_2016_march.mbox')
mbox_april = read_file('data/hyperkitty/hyperkitty_2016_april.mbox')
httpretty.register_uri(httpretty.GET,
HYPERKITTY_URL,
body="")
httpretty.register_uri(httpretty.GET,
HYPERKITTY_URL + 'export/2016-03.mbox.gz',
body=mbox_march)
httpretty.register_uri(httpretty.GET,
HYPERKITTY_URL + 'export/2016-04.mbox.gz',
body=mbox_april)
from_date = datetime.datetime(2016, 3, 10)
backend = HyperKitty('http://example.com/archives/list/[email protected]/',
self.tmp_path)
messages = [m for m in backend.fetch(from_date=from_date)]
# Although there is a message in the mbox from March, this message
# was sent previous to the given date, so it is not included
# into the expected result
expected = [('<[email protected]>',
'26ad05669b2d2e6f6a8e244b2fd65cefafdb3d53', 1460624816.0),
('<[email protected]>',
'c785b05dd2a267d267e8497303157cea4a871838', 1461428336.0),
('<[email protected]>',
'fc3f60f140bba0e7f3fcad82890928e6b580a923', 1461621607.0)]
self.assertEqual(len(messages), 3)
for x in range(len(messages)):
message = messages[x]
self.assertEqual(message['data']['Message-ID'], expected[x][0])
self.assertEqual(message['origin'], 'http://example.com/archives/list/[email protected]/')
self.assertEqual(message['uuid'], expected[x][1])
self.assertEqual(message['updated_on'], expected[x][2])
self.assertEqual(message['category'], 'message')
self.assertEqual(message['tag'], 'http://example.com/archives/list/[email protected]/')
@httpretty.activate
@unittest.mock.patch('perceval.backends.core.hyperkitty.datetime_utcnow')
def test_search_fields(self, mock_utcnow):
"""Test whether the search_fields is properly set"""
mock_utcnow.return_value = datetime.datetime(2016, 4, 10,
tzinfo=dateutil.tz.tzutc())
mbox_march = read_file('data/hyperkitty/hyperkitty_2016_march.mbox')
mbox_april = read_file('data/hyperkitty/hyperkitty_2016_april.mbox')
httpretty.register_uri(httpretty.GET,
HYPERKITTY_URL,
body="")
httpretty.register_uri(httpretty.GET,
HYPERKITTY_URL + 'export/2016-03.mbox.gz',
body=mbox_march)
httpretty.register_uri(httpretty.GET,
HYPERKITTY_URL + 'export/2016-04.mbox.gz',
body=mbox_april)
from_date = datetime.datetime(2016, 3, 10)
backend = HyperKitty('http://example.com/archives/list/[email protected]/',
self.tmp_path)
messages = [m for m in backend.fetch(from_date=from_date)]
for message in messages:
self.assertEqual(backend.metadata_id(message['data']), message['search_fields']['item_id'])
@httpretty.activate
@unittest.mock.patch('perceval.backends.core.hyperkitty.datetime_utcnow')
def test_fetch_from_date_after_current_day(self, mock_utcnow):
"""Test if it does not fetch anything when from_date is a date from the future"""
mock_utcnow.return_value = datetime.datetime(2016, 4, 10,
tzinfo=dateutil.tz.tzutc())
httpretty.register_uri(httpretty.GET,
HYPERKITTY_URL,
body="")
from_date = datetime.datetime(2017, 1, 10)
backend = HyperKitty('http://example.com/archives/list/[email protected]/',
self.tmp_path)
messages = [m for m in backend.fetch(from_date=from_date)]
self.assertEqual(len(messages), 0)
class TestHyperKittyCommand(unittest.TestCase):
"""Tests for HyperKittyCommand class"""
def setUp(self):
self.tmp_path = tempfile.mkdtemp(prefix='perceval_')
def tearDown(self):
shutil.rmtree(self.tmp_path)
def test_backend_class(self):
"""Test if the backend class is Pipermail"""
self.assertIs(HyperKittyCommand.BACKEND, HyperKitty)
@httpretty.activate
@unittest.mock.patch('os.path.expanduser')
def test_mboxes_path_init(self, mock_expanduser):
"""Test dirpath initialization"""
mock_expanduser.return_value = os.path.join(self.tmp_path, 'testpath')
args = ['http://example.com/archives/list/[email protected]/']
cmd = HyperKittyCommand(*args)
self.assertEqual(cmd.parsed_args.dirpath,
os.path.join(self.tmp_path,
'testpath/http://example.com/archives/list/[email protected]/'))
args = ['http://example.com/archives/list/[email protected]/',
'--mboxes-path', '/tmp/perceval/']
cmd = HyperKittyCommand(*args)
self.assertEqual(cmd.parsed_args.dirpath, '/tmp/perceval/')
def test_parsing_on_init(self):
"""Test if the class is initialized"""
args = ['http://example.com/archives/list/[email protected]/',
'--mboxes-path', '/tmp/perceval/',
'--tag', 'test']
cmd = HyperKittyCommand(*args)
self.assertEqual(cmd.parsed_args.url, 'http://example.com/archives/list/[email protected]/')
self.assertEqual(cmd.parsed_args.mboxes_path, '/tmp/perceval/')
self.assertEqual(cmd.parsed_args.tag, 'test')
def test_setup_cmd_parser(self):
"""Test if it parser object is correctly initialized"""
parser = HyperKittyCommand.setup_cmd_parser()
self.assertIsInstance(parser, BackendCommandArgumentParser)
self.assertEqual(parser._backend, HyperKitty)
args = ['http://example.com/archives/list/[email protected]/',
'--mboxes-path', '/tmp/perceval/',
'--tag', 'test',
'--from-date', '1970-01-01']
parsed_args = parser.parse(*args)
self.assertEqual(parsed_args.url, 'http://example.com/archives/list/[email protected]/')
self.assertEqual(parsed_args.mboxes_path, '/tmp/perceval/')
self.assertEqual(parsed_args.tag, 'test')
self.assertEqual(parsed_args.from_date, DEFAULT_DATETIME)
self.assertTrue(parsed_args.ssl_verify)
args = ['http://example.com/archives/list/[email protected]/',
'--mboxes-path', '/tmp/perceval/',
'--tag', 'test', '--no-ssl-verify',
'--from-date', '1970-01-01']
parsed_args = parser.parse(*args)
self.assertEqual(parsed_args.url, 'http://example.com/archives/list/[email protected]/')
self.assertEqual(parsed_args.mboxes_path, '/tmp/perceval/')
self.assertEqual(parsed_args.tag, 'test')
self.assertEqual(parsed_args.from_date, DEFAULT_DATETIME)
self.assertFalse(parsed_args.ssl_verify)
if __name__ == "__main__":
unittest.main(warnings='ignore')