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
|
# Copyright (C) 2007-2010 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/>.
"""Harness for testing Mailman's documentation.
Note that doctest extraction does not currently work for zip file
distributions. doctest discovery currently requires file system traversal.
"""
from __future__ import absolute_import, unicode_literals
__metaclass__ = type
__all__ = [
'test_suite',
]
import os
import sys
import json
import random
import doctest
import unittest
from email import message_from_string
from httplib2 import Http
from urllib import urlencode
from urllib2 import HTTPError
import mailman
from mailman.app.lifecycle import create_list
from mailman.config import config
from mailman.email.message import Message
from mailman.testing.layers import SMTPLayer
DOT = '.'
COMMASPACE = ', '
class chdir:
"""A context manager for temporary directory changing."""
def __init__(self, directory):
self._curdir = None
self._directory = directory
def __enter__(self):
self._curdir = os.getcwd()
os.chdir(self._directory)
def __exit__(self, exc_type, exc_val, exc_tb):
os.chdir(self._curdir)
# Don't suppress exceptions.
return False
def specialized_message_from_string(unicode_text):
"""Parse text into a message object.
This is specialized in the sense that an instance of Mailman's own Message
object is returned, and this message object has an attribute
`original_size` which is the pre-calculated size in bytes of the message's
text representation.
Also, the text must be ASCII-only unicode.
"""
# This mimic what Switchboard.dequeue() does when parsing a message from
# text into a Message instance.
text = unicode_text.encode('ascii')
original_size = len(text)
message = message_from_string(text, Message)
message.original_size = original_size
return message
def stop():
"""Call into pdb.set_trace()"""
# Do the import here so that you get the wacky special hacked pdb instead
# of Python's normal pdb.
import pdb
pdb.set_trace()
def dump_msgdata(msgdata, *additional_skips):
"""Dump in a more readable way a message metadata dictionary."""
skips = set(additional_skips)
# Some stuff we always want to skip, because their values will always be
# variable data.
skips.add('received_time')
longest = max(len(key) for key in msgdata if key not in skips)
for key in sorted(msgdata):
if key in skips:
continue
print '{0:{2}}: {1}'.format(key, msgdata[key], longest)
def dump_json(url, data=None, method=None):
"""Print the JSON dictionary read from a URL.
:param url: The url to open, read, and print.
:type url: string
:param data: Data to use to POST to a URL.
:type data: dict
:param method: Alternative HTTP method to use.
:type method: str
"""
if data is not None:
data = urlencode(data)
headers = {}
if method is None:
if data is None:
method = 'GET'
else:
method = 'POST'
headers['Content-Type'] = 'application/x-www-form-urlencoded'
method = method.upper()
response, content = Http().request(url, method, data, headers)
# If we did not get a 2xx status code, make this look like a urllib2
# exception, for backward compatibility with existing doctests.
if response.status // 100 != 2:
raise HTTPError(url, response.status, response.reason, response, None)
# fp does not support the context manager protocol.
if len(content) == 0:
for header in sorted(response):
print '{0}: {1}'.format(header, response[header])
return
data = json.loads(content)
for key in sorted(data):
if key == 'entries':
for i, entry in enumerate(data[key]):
# entry is a dictionary.
print 'entry %d:' % i
for entry_key in sorted(entry):
print ' {0}: {1}'.format(entry_key, entry[entry_key])
else:
print '{0}: {1}'.format(key, data[key])
def setup(testobj):
"""Test setup."""
# Make sure future statements in our doctests are the same as everywhere
# else.
testobj.globs['absolute_import'] = absolute_import
testobj.globs['unicode_literals'] = unicode_literals
# In general, I don't like adding convenience functions, since I think
# doctests should do the imports themselves. It makes for better
# documentation that way. However, a few are really useful, or help to
# hide some icky test implementation details.
testobj.globs['config'] = config
testobj.globs['create_list'] = create_list
testobj.globs['dump_json'] = dump_json
testobj.globs['dump_msgdata'] = dump_msgdata
testobj.globs['message_from_string'] = specialized_message_from_string
testobj.globs['smtpd'] = SMTPLayer.smtpd
testobj.globs['stop'] = stop
testobj.globs['transaction'] = config.db
def test_suite():
suite = unittest.TestSuite()
topdir = os.path.dirname(mailman.__file__)
packages = []
for dirpath, dirnames, filenames in os.walk(topdir):
if 'docs' in dirnames:
docsdir = os.path.join(dirpath, 'docs')[len(topdir)+1:]
packages.append(docsdir)
# Under higher verbosity settings, report all doctest errors, not just the
# first one.
flags = (doctest.ELLIPSIS |
doctest.NORMALIZE_WHITESPACE |
doctest.REPORT_NDIFF)
# Add all the doctests in all subpackages.
doctest_files = {}
with chdir(topdir):
for docsdir in packages:
# Look to see if the package defines a test layer, otherwise use
# SMTPLayer.
package_path = 'mailman.' + DOT.join(docsdir.split(os.sep))
try:
__import__(package_path)
except ImportError:
layer = SMTPLayer
else:
layer = getattr(sys.modules[package_path], 'layer', SMTPLayer)
for filename in os.listdir(docsdir):
base, extension = os.path.splitext(filename)
if os.path.splitext(filename)[1] == '.txt':
module_path = package_path + '.' + base
doctest_files[module_path] = (
os.path.join(docsdir, filename), layer)
for module_path in sorted(doctest_files):
path, layer = doctest_files[module_path]
test = doctest.DocFileSuite(
path,
package='mailman',
optionflags=flags,
setUp=setup)
test.layer = layer
suite.addTest(test)
return suite
|
