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
|
# Copyright (C) 2012-2016 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 core modification pipelines."""
import unittest
from mailman.app.lifecycle import create_list
from mailman.config import config
from mailman.core.pipelines import process
from mailman.interfaces.handler import IHandler
from mailman.interfaces.member import MemberRole
from mailman.interfaces.pipeline import (
DiscardMessage, IPipeline, RejectMessage)
from mailman.interfaces.usermanager import IUserManager
from mailman.testing.helpers import (
LogFileMark, digest_mbox, get_queue_messages,
specialized_message_from_string as mfs)
from mailman.testing.layers import ConfigLayer
from operator import delitem
from zope.component import getUtility
from zope.interface import implementer
@implementer(IHandler)
class DiscardingHandler:
name = 'discarding'
def process(self, mlist, msg, msgdata):
raise DiscardMessage('by test handler')
@implementer(IHandler)
class RejectHandler:
name = 'rejecting'
def process(self, mlist, msg, msgdata):
raise RejectMessage('by test handler')
@implementer(IPipeline)
class DiscardingPipeline:
name = 'test-discarding'
description = 'Discarding test pipeline'
def __iter__(self):
yield DiscardingHandler()
@implementer(IPipeline)
class RejectingPipeline:
name = 'test-rejecting'
description = 'Rejectinging test pipeline'
def __iter__(self):
yield RejectHandler()
class TestPostingPipeline(unittest.TestCase):
"""Test various aspects of the built-in postings pipeline."""
layer = ConfigLayer
def setUp(self):
self._mlist = create_list('test@example.com')
config.pipelines['test-discarding'] = DiscardingPipeline()
self.addCleanup(delitem, config.pipelines, 'test-discarding')
config.pipelines['test-rejecting'] = RejectingPipeline()
self.addCleanup(delitem, config.pipelines, 'test-rejecting')
self._msg = mfs("""\
From: Anne Person <anne@example.org>
To: test@example.com
Subject: a test
Message-ID: <ant>
testing
""")
def test_rfc2369_headers(self):
# Ensure that RFC 2369 List-* headers are added.
msgdata = {}
process(self._mlist, self._msg, msgdata,
pipeline_name='default-posting-pipeline')
self.assertEqual(self._msg['list-id'], '<test.example.com>')
self.assertEqual(self._msg['list-post'], '<mailto:test@example.com>')
def test_discarding_pipeline(self):
# If a handler in the pipeline raises DiscardMessage, the message will
# be thrown away, but with a log message.
mark = LogFileMark('mailman.vette')
process(self._mlist, self._msg, {}, 'test-discarding')
line = mark.readline()[:-1]
self.assertTrue(line.endswith(
'<ant> discarded by "test-discarding" pipeline handler '
'"discarding": by test handler'))
def test_rejecting_pipeline(self):
# If a handler in the pipeline raises DiscardMessage, the message will
# be thrown away, but with a log message.
mark = LogFileMark('mailman.vette')
process(self._mlist, self._msg, {}, 'test-rejecting')
line = mark.readline()[:-1]
self.assertTrue(line.endswith(
'<ant> rejected by "test-rejecting" pipeline handler '
'"rejecting": by test handler'))
# In the rejection case, the original message will also be in the
# virgin queue.
items = get_queue_messages('virgin', expected_count=1)
self.assertEqual(str(items[0].msg['subject']), 'a test')
def test_decorate_bulk(self):
# Ensure that bulk postings get decorated with the footer.
process(self._mlist, self._msg, {},
pipeline_name='default-posting-pipeline')
payload = self._msg.get_payload()
self.assertIn('Test mailing list', payload)
def test_nodecorate_verp(self):
# Ensure that verp postings don't get decorated twice.
msgdata = {'verp': True}
process(self._mlist, self._msg, msgdata,
pipeline_name='default-posting-pipeline')
payload = self._msg.get_payload()
self.assertEqual(payload.count('Test mailing list'), 1)
def test_only_decorate_output(self):
# Ensure that decoration is not done on the archive, digest, or
# usenet copy of the message.
self.assertTrue(self._mlist.digests_enabled)
# Set up NNTP.
self._mlist.gateway_to_news = True
self._mlist.linked_newsgroup = 'testing'
self._mlist.nntp_host = 'news.example.com'
# Process the email.
process(self._mlist, self._msg, {},
pipeline_name='default-posting-pipeline')
for queue in ('archive', 'nntp'):
items = get_queue_messages(queue, expected_count=1)
payload = items[0].msg.get_payload()
self.assertNotIn('Test mailing list', payload)
self.assertEqual(len(digest_mbox(self._mlist)), 1)
payload = digest_mbox(self._mlist)[0].get_payload()
self.assertNotIn('Test mailing list', payload)
class TestOwnerPipeline(unittest.TestCase):
"""Test various aspects of the built-in owner pipeline."""
layer = ConfigLayer
def setUp(self):
self._mlist = create_list('test@example.com')
user_manager = getUtility(IUserManager)
anne = user_manager.create_address('anne@example.com')
bart = user_manager.create_address('bart@example.com')
self._mlist.subscribe(anne, MemberRole.owner)
self._mlist.subscribe(bart, MemberRole.moderator)
self._msg = mfs("""\
From: Anne Person <anne@example.org>
To: test-owner@example.com
""")
def test_calculate_recipients(self):
# Recipients are the administrators of the mailing list.
msgdata = dict(listname='test@example.com',
to_owner=True)
process(self._mlist, self._msg, msgdata,
pipeline_name='default-owner-pipeline')
self.assertEqual(msgdata['recipients'], set(('anne@example.com',
'bart@example.com')))
def test_to_outgoing(self):
# The message, with the calculated recipients, gets put in the
# outgoing queue.
process(self._mlist, self._msg, {},
pipeline_name='default-owner-pipeline')
items = get_queue_messages('out', sort_on='to', expected_count=1)
self.assertEqual(items[0].msgdata['recipients'],
set(('anne@example.com', 'bart@example.com')))
|
