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
|
# Copyright (C) 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 some additional plugin stuff."""
import sys
import unittest
from contextlib import ExitStack
from mailman.interfaces.plugin import IPlugin
from mailman.plugins.initialize import initialize
from mailman.plugins.testing.layer import PluginRESTLayer
from mailman.testing.helpers import call_api
from mailman.testing.layers import ConfigLayer
from tempfile import TemporaryDirectory
from types import SimpleNamespace
from unittest.mock import patch
from urllib.error import HTTPError
from zope.interface import implementer
class TestRESTPlugin(unittest.TestCase):
layer = PluginRESTLayer
def test_plugin_raises_exception(self):
with self.assertRaises(HTTPError) as cm:
call_api('http://localhost:9001/3.1/plugins/example/no')
self.assertEqual(cm.exception.code, 400)
@implementer(IPlugin)
class TestablePlugin:
def pre_hook(self):
pass
def post_hook(self):
pass
resource = None
class TestInitializePlugins(unittest.TestCase):
layer = ConfigLayer
def test_duplicate_plugin_name(self):
with ExitStack() as resources:
system_path = resources.enter_context(TemporaryDirectory())
fake_plugin_config = {
'path': system_path,
'enabled': 'yes',
'class': 'ExamplePlugin',
}
log_mock = resources.enter_context(
patch('mailman.plugins.initialize.log'))
fake_mailman_config = SimpleNamespace(
plugin_configs=[('example', fake_plugin_config)],
plugins=['example'],
)
resources.enter_context(patch(
'mailman.plugins.initialize.config', fake_mailman_config))
initialize()
log_mock.error.assert_called_once_with(
'Duplicate plugin name: example')
def test_does_not_implement(self):
with ExitStack() as resources:
system_path = resources.enter_context(TemporaryDirectory())
fake_plugin_config = {
'path': system_path,
'enabled': 'yes',
'class': 'ExamplePlugin',
}
log_mock = resources.enter_context(
patch('mailman.plugins.initialize.log'))
fake_mailman_config = SimpleNamespace(
plugin_configs=[('example', fake_plugin_config)],
plugins=[],
)
resources.enter_context(patch(
'mailman.plugins.initialize.config', fake_mailman_config))
resources.enter_context(patch(
'mailman.plugins.initialize.call_name',
# object() does not implement IPlugin.
return_value=object()))
initialize()
log_mock.error.assert_called_once_with(
'Plugin class does not implement IPlugin: ExamplePlugin')
self.assertNotIn(system_path, sys.path)
def test_adds_plugins_to_config(self):
with ExitStack() as resources:
system_path = resources.enter_context(TemporaryDirectory())
fake_plugin_config = {
'path': system_path,
'enabled': 'yes',
'class': 'ExamplePlugin',
}
fake_mailman_config = SimpleNamespace(
plugin_configs=[('example', fake_plugin_config)],
plugins={},
)
resources.enter_context(patch(
'mailman.plugins.initialize.config', fake_mailman_config))
testable_plugin = TestablePlugin()
resources.enter_context(patch(
'mailman.plugins.initialize.call_name',
# object() does not implement IPlugin.
return_value=testable_plugin))
initialize()
self.assertIn('example', fake_mailman_config.plugins)
self.assertEqual(
fake_mailman_config.plugins['example'],
testable_plugin)
def test_not_enabled(self):
with ExitStack() as resources:
fake_plugin_config = {
'path': '/does/not/exist',
'enabled': 'no',
'class': 'ExamplePlugin',
}
log_mock = resources.enter_context(
patch('mailman.plugins.initialize.log'))
fake_mailman_config = SimpleNamespace(
plugin_configs=[('example', fake_plugin_config)],
plugins={},
)
resources.enter_context(patch(
'mailman.plugins.initialize.config', fake_mailman_config))
initialize()
log_mock.info.assert_called_once_with(
'Plugin not enabled, or empty class path: example')
|
