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
|
# Copyright (C) 2008 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/>.
"""Mailman test layers."""
__metaclass__ = type
__all__ = [
'ConfigLayer',
'SMTPLayer',
]
import os
import shutil
import tempfile
from pkg_resources import resource_string
from textwrap import dedent
from mailman.config import config
from mailman.core.initialize import initialize
from mailman.testing.helpers import SMTPServer
NL = '\n'
class ConfigLayer:
"""Layer for pushing and popping test configurations."""
var_dir = None
@classmethod
def setUp(cls):
initialize()
assert cls.var_dir is None, 'Layer already set up'
# Calculate a temporary VAR_DIR directory so that run-time artifacts
# of the tests won't tread on the installation's data. This also
# makes it easier to clean up after the tests are done, and insures
# isolation of test suite runs.
cls.var_dir = tempfile.mkdtemp()
# Create a section with the var directory.
test_config = dedent("""
[mailman]
var_dir: %s
""" % cls.var_dir)
# Read the testing config, but don't push it yet.
test_config += resource_string('mailman.testing', 'testing.cfg')
config.push('test config', test_config)
@classmethod
def tearDown(cls):
assert cls.var_dir is not None, 'Layer not set up'
config.pop('test config')
shutil.rmtree(cls.var_dir)
cls.var_dir = None
@classmethod
def testSetUp(self):
pass
@classmethod
def testTearDown(self):
# Reset the database between tests.
config.db._reset()
# Remove all residual queue files.
for dirpath, dirnames, filenames in os.walk(config.QUEUE_DIR):
for filename in filenames:
os.remove(os.path.join(dirpath, filename))
# Clear out messages in the message store.
for message in config.db.message_store.messages:
config.db.message_store.delete_message(message['message-id'])
config.db.commit()
class SMTPLayer(ConfigLayer):
"""Layer for starting, stopping, and accessing a test SMTP server."""
smtpd = None
@classmethod
def setUp(cls):
assert cls.smtpd is None, 'Layer already set up'
cls.smtpd = SMTPServer()
cls.smtpd.start()
@classmethod
def tearDown(cls):
assert cls.smtpd is not None, 'Layer not set up'
cls.smtpd.clear()
cls.smtpd.stop()
@classmethod
def testSetUp(cls):
pass
@classmethod
def testTearDown(cls):
pass
|