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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
|
# Copyright (C) 2005 by Canonical Ltd
# This program 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 2 of the License, or
# (at your option) any later version.
# This program 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 this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""Enhanced layer on unittest.
This does several things:
* nicer reporting as tests run
* test code can log messages into a buffer that is recorded to disk
and displayed if the test fails
* tests can be run in a separate directory, which is useful for code that
wants to create files
* utilities to run external commands and check their return code
and/or output
Test cases should normally subclass testsweet.TestCase. The test runner should
call runsuite().
This is meant to become independent of bzr, though that's not quite
true yet.
"""
import unittest
import sys
# XXX: Don't need this anymore now we depend on python2.4
def _need_subprocess():
sys.stderr.write("sorry, this test suite requires the subprocess module\n"
"this is shipped with python2.4 and available separately for 2.3\n")
class CommandFailed(Exception):
pass
class TestSkipped(Exception):
"""Indicates that a test was intentionally skipped, rather than failing."""
# XXX: Not used yet
class TestCase(unittest.TestCase):
"""Base class for bzr unit tests.
Tests that need access to disk resources should subclass
FunctionalTestCase not TestCase.
"""
# TODO: Special methods to invoke bzr, so that we can run it
# through a specified Python intepreter
OVERRIDE_PYTHON = None # to run with alternative python 'python'
BZRPATH = 'bzr'
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
a_callable=None, *args, **kwargs):
"""Call callable with redirected std io pipes.
Returns the return code."""
from StringIO import StringIO
if not callable(a_callable):
raise ValueError("a_callable must be callable.")
if stdin is None:
stdin = StringIO("")
if stdout is None:
stdout = self.TEST_LOG
if stderr is None:
stderr = self.TEST_LOG
real_stdin = sys.stdin
real_stdout = sys.stdout
real_stderr = sys.stderr
result = None
try:
sys.stdout = stdout
sys.stderr = stderr
sys.stdin = stdin
result = a_callable(*args, **kwargs)
finally:
sys.stdout = real_stdout
sys.stderr = real_stderr
sys.stdin = real_stdin
return result
def setUp(self):
super(TestCase, self).setUp()
# setup a temporary log for the test
import tempfile
self.TEST_LOG = tempfile.NamedTemporaryFile(mode='wt', bufsize=0)
self.log("%s setup" % self.id())
def tearDown(self):
self.log("%s teardown" % self.id())
self.log('')
super(TestCase, self).tearDown()
def log(self, msg):
"""Log a message to a progress file"""
print >>self.TEST_LOG, msg
def check_inventory_shape(self, inv, shape):
"""
Compare an inventory to a list of expected names.
Fail if they are not precisely equal.
"""
extras = []
shape = list(shape) # copy
for path, ie in inv.entries():
name = path.replace('\\', '/')
if ie.kind == 'dir':
name = name + '/'
if name in shape:
shape.remove(name)
else:
extras.append(name)
if shape:
self.fail("expected paths not found in inventory: %r" % shape)
if extras:
self.fail("unexpected paths found in inventory: %r" % extras)
def _get_log(self):
"""Get the log the test case used. This can only be called once,
after which an exception will be raised.
"""
self.TEST_LOG.flush()
log = open(self.TEST_LOG.name, 'rt').read()
self.TEST_LOG.close()
return log
class FunctionalTestCase(TestCase):
"""Base class for tests that perform function testing - running bzr,
using files on disk, and similar activities.
InTempDir is an old alias for FunctionalTestCase.
"""
TEST_ROOT = None
_TEST_NAME = 'test'
def check_file_contents(self, filename, expect):
self.log("check contents of file %s" % filename)
contents = file(filename, 'r').read()
if contents != expect:
self.log("expected: %r" % expect)
self.log("actually: %r" % contents)
self.fail("contents of %s not as expected")
def _make_test_root(self):
import os
import shutil
import tempfile
if FunctionalTestCase.TEST_ROOT is not None:
return
FunctionalTestCase.TEST_ROOT = os.path.abspath(
tempfile.mkdtemp(suffix='.tmp',
prefix=self._TEST_NAME + '-',
dir=os.curdir))
# make a fake bzr directory there to prevent any tests propagating
# up onto the source directory's real branch
os.mkdir(os.path.join(FunctionalTestCase.TEST_ROOT, '.bzr'))
def setUp(self):
super(FunctionalTestCase, self).setUp()
import os
self._make_test_root()
self._currentdir = os.getcwdu()
self.test_dir = os.path.join(self.TEST_ROOT, self.id())
os.mkdir(self.test_dir)
os.chdir(self.test_dir)
def tearDown(self):
import os
os.chdir(self._currentdir)
super(FunctionalTestCase, self).tearDown()
def formcmd(self, cmd):
if isinstance(cmd, basestring):
cmd = cmd.split()
if cmd[0] == 'bzr':
cmd[0] = self.BZRPATH
if self.OVERRIDE_PYTHON:
cmd.insert(0, self.OVERRIDE_PYTHON)
self.log('$ %r' % cmd)
return cmd
def runcmd(self, cmd, retcode=0):
"""Run one command and check the return code.
Returns a tuple of (stdout,stderr) strings.
If a single string is based, it is split into words.
For commands that are not simple space-separated words, please
pass a list instead."""
try:
import shutil
from subprocess import call
except ImportError, e:
_need_subprocess()
raise
cmd = self.formcmd(cmd)
self.log('$ ' + ' '.join(cmd))
actual_retcode = call(cmd, stdout=self.TEST_LOG, stderr=self.TEST_LOG)
if retcode != actual_retcode:
raise CommandFailed("test failed: %r returned %d, expected %d"
% (cmd, actual_retcode, retcode))
def backtick(self, cmd, retcode=0):
"""Run a command and return its output"""
try:
import shutil
from subprocess import Popen, PIPE
except ImportError, e:
_need_subprocess()
raise
cmd = self.formcmd(cmd)
child = Popen(cmd, stdout=PIPE, stderr=self.TEST_LOG)
outd, errd = child.communicate()
self.log(outd)
actual_retcode = child.wait()
outd = outd.replace('\r', '')
if retcode != actual_retcode:
raise CommandFailed("test failed: %r returned %d, expected %d"
% (cmd, actual_retcode, retcode))
return outd
def build_tree(self, shape):
"""Build a test tree according to a pattern.
shape is a sequence of file specifications. If the final
character is '/', a directory is created.
This doesn't add anything to a branch.
"""
# XXX: It's OK to just create them using forward slashes on windows?
import os
for name in shape:
assert isinstance(name, basestring)
if name[-1] == '/':
os.mkdir(name[:-1])
else:
f = file(name, 'wt')
print >>f, "contents of", name
f.close()
InTempDir = FunctionalTestCase
class _MyResult(unittest._TextTestResult):
"""
Custom TestResult.
No special behaviour for now.
"""
def startTest(self, test):
unittest.TestResult.startTest(self, test)
# TODO: Maybe show test.shortDescription somewhere?
what = test.id()
# python2.3 has the bad habit of just "runit" for doctests
if what == 'runit':
what = test.shortDescription()
if self.showAll:
self.stream.write('%-60.60s' % what)
self.stream.flush()
def addError(self, test, err):
super(_MyResult, self).addError(test, err)
self.stream.flush()
def addFailure(self, test, err):
super(_MyResult, self).addFailure(test, err)
self.stream.flush()
def addSuccess(self, test):
if self.showAll:
self.stream.writeln('OK')
elif self.dots:
self.stream.write('~')
self.stream.flush()
unittest.TestResult.addSuccess(self, test)
def printErrorList(self, flavour, errors):
for test, err in errors:
self.stream.writeln(self.separator1)
self.stream.writeln("%s: %s" % (flavour,self.getDescription(test)))
self.stream.writeln(self.separator2)
self.stream.writeln("%s" % err)
if isinstance(test, TestCase):
self.stream.writeln()
self.stream.writeln('log from this test:')
print >>self.stream, test._get_log()
class TextTestRunner(unittest.TextTestRunner):
def _makeResult(self):
return _MyResult(self.stream, self.descriptions, self.verbosity)
def run_suite(suite, name='test', verbose=False):
import shutil
FunctionalTestCase._TEST_NAME = name
if verbose:
verbosity = 2
else:
verbosity = 1
runner = TextTestRunner(stream=sys.stdout,
descriptions=0,
verbosity=verbosity)
result = runner.run(suite)
# This is still a little bogus,
# but only a little. Folk not using our testrunner will
# have to delete their temp directories themselves.
if result.wasSuccessful():
shutil.rmtree(FunctionalTestCase.TEST_ROOT)
else:
print "Failed tests working directories are in '%s'\n" % FunctionalTestCase.TEST_ROOT
return result.wasSuccessful()
|