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
|
# Copyright (C) 2012-2017 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 system-wide global configuration."""
import os
import unittest
from contextlib import ExitStack
from mailman.config.config import (
Configuration, external_configuration, load_external)
from mailman.interfaces.configuration import (
ConfigurationUpdatedEvent, MissingConfigurationFileError)
from mailman.testing.helpers import configuration, event_subscribers
from mailman.testing.layers import ConfigLayer
from pkg_resources import resource_filename
from tempfile import NamedTemporaryFile, TemporaryDirectory
from unittest import mock
class TestConfiguration(unittest.TestCase):
layer = ConfigLayer
def test_push_and_pop_trigger_events(self):
# Pushing a new configuration onto the stack triggers a
# post-processing event.
events = []
def on_event(event): # noqa: E306
if isinstance(event, ConfigurationUpdatedEvent):
# Record both the event and the top overlay.
events.append(event.config.overlays[0].name)
# Do two pushes, and then pop one of them.
with event_subscribers(on_event):
with configuration('test', _configname='first'):
with configuration('test', _configname='second'):
pass
self.assertEqual(events, ['first', 'second', 'first'])
def test_config_template_dir_is_source(self):
# This test will leave a 'var' directory in the top-level source
# directory. Be sure to clean it up.
config = Configuration()
with ExitStack() as resources:
fp = resources.enter_context(
NamedTemporaryFile('w', encoding='utf-8'))
var_dir = resources.enter_context(TemporaryDirectory())
# Don't let the post-processing after the config.load() to put a
# 'var' directory in the source tree's top level directory.
print("""\
[paths.here]
template_dir: :source:
var_dir: {}
""".format(var_dir), file=fp)
fp.flush()
config.load(fp.name)
import mailman.templates
self.assertEqual(config.TEMPLATE_DIR,
os.path.dirname(mailman.templates.__file__))
class TestExternal(unittest.TestCase):
"""Test external configuration file loading APIs."""
def test_load_external_by_filename(self):
filename = resource_filename('mailman.config', 'postfix.cfg')
contents = load_external(filename)
self.assertEqual(contents[:9], '[postfix]')
def test_load_external_by_path(self):
contents = load_external('python:mailman.config.postfix')
self.assertEqual(contents[:9], '[postfix]')
def test_external_configuration_by_filename(self):
filename = resource_filename('mailman.config', 'postfix.cfg')
parser = external_configuration(filename)
self.assertEqual(parser.get('postfix', 'postmap_command'),
'/usr/sbin/postmap')
def test_external_configuration_by_path(self):
parser = external_configuration('python:mailman.config.postfix')
self.assertEqual(parser.get('postfix', 'postmap_command'),
'/usr/sbin/postmap')
def test_missing_configuration_file(self):
with self.assertRaises(MissingConfigurationFileError) as cm:
external_configuration('path:mailman.config.missing')
self.assertEqual(cm.exception.path, 'path:mailman.config.missing')
class TestConfigurationErrors(unittest.TestCase):
layer = ConfigLayer
def test_bad_path_layout_specifier(self):
# Using a [mailman]layout name that doesn't exist is a fatal error.
config = Configuration()
with ExitStack() as resources:
fp = resources.enter_context(
NamedTemporaryFile('w', encoding='utf-8'))
print("""\
[mailman]
layout: nonesuch
""", file=fp)
fp.flush()
# Suppress warning messages in the test output. Also, make sure
# that the config.load() call doesn't break global state.
resources.enter_context(mock.patch('sys.stderr'))
resources.enter_context(mock.patch.object(config, '_clear'))
cm = resources.enter_context(self.assertRaises(SystemExit))
config.load(fp.name)
self.assertEqual(cm.exception.args, (1,))
def test_path_expansion_infloop(self):
# A path expansion never completes because it references a non-existent
# substitution variable.
config = Configuration()
with ExitStack() as resources:
fp = resources.enter_context(
NamedTemporaryFile('w', encoding='utf-8'))
print("""\
[paths.here]
log_dir: $nopath/log_dir
""", file=fp)
fp.flush()
# Suppress warning messages in the test output. Also, make sure
# that the config.load() call doesn't break global state.
resources.enter_context(mock.patch('sys.stderr'))
resources.enter_context(mock.patch.object(config, '_clear'))
cm = resources.enter_context(self.assertRaises(SystemExit))
config.load(fp.name)
self.assertEqual(cm.exception.args, (1,))
|
