« back to all changes in this revision
Viewing changes to testsweet.py
- browse files at revision 723
- compare with another revision
- download diff
- download tarball
- view history from revision 723
- Committer: Martin Pool
- Date: 2005-06-21 06:10:18 UTC
- Revision ID: mbp@sourcefrog.net-20050621061017-12e8f0ff45228338
- move whitebox/blackbox modules into bzrlib.selftest subdirectory
- files removed:
- bzrlib/hashcache.py
- effbot
- effbot/org
- plugins
- plugins/changeset
- tools
- files modified:
- NEWS
added
removed
testsweet.py
1
# Copyright (C) 2005 by Canonical Ltd
2
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
7
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
12
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
17
18
"""Enhanced layer on unittest.
19
20
This does several things:
21
22
* nicer reporting as tests run
23
24
* test code can log messages into a buffer that is recorded to disk
25
and displayed if the test fails
26
27
* tests can be run in a separate directory, which is useful for code that
28
wants to create files
29
30
* utilities to run external commands and check their return code
31
and/or output
32
33
Test cases should normally subclass TestBase. The test runner should
34
call runsuite().
35
36
This is meant to become independent of bzr, though that's not quite
37
true yet.
38
"""
39
40
41
from unittest import TestResult, TestCase
42
43
def _need_subprocess():
44
sys.stderr.write("sorry, this test suite requires the subprocess module\n"
45
"this is shipped with python2.4 and available separately for 2.3\n")
46
47
48
class CommandFailed(Exception):
49
pass
50
51
52
53
class TestSkipped(Exception):
54
"""Indicates that a test was intentionally skipped, rather than failing."""
55
# XXX: Not used yet
56
57
58
class TestBase(TestCase):
59
"""Base class for bzr test cases.
60
61
Just defines some useful helper functions; doesn't actually test
62
anything.
63
"""
64
65
# TODO: Special methods to invoke bzr, so that we can run it
66
# through a specified Python intepreter
67
68
OVERRIDE_PYTHON = None # to run with alternative python 'python'
69
BZRPATH = 'bzr'
70
71
_log_buf = ""
72
73
74
def setUp(self):
75
super(TestBase, self).setUp()
76
self.log("%s setup" % self.id())
77
78
79
def tearDown(self):
80
super(TestBase, self).tearDown()
81
self.log("%s teardown" % self.id())
82
self.log('')
83
84
85
def formcmd(self, cmd):
86
if isinstance(cmd, basestring):
87
cmd = cmd.split()
88
89
if cmd[0] == 'bzr':
90
cmd[0] = self.BZRPATH
91
if self.OVERRIDE_PYTHON:
92
cmd.insert(0, self.OVERRIDE_PYTHON)
93
94
self.log('$ %r' % cmd)
95
96
return cmd
97
98
99
def runcmd(self, cmd, retcode=0):
100
"""Run one command and check the return code.
101
102
Returns a tuple of (stdout,stderr) strings.
103
104
If a single string is based, it is split into words.
105
For commands that are not simple space-separated words, please
106
pass a list instead."""
107
try:
108
import shutil
109
from subprocess import call
110
except ImportError, e:
111
_need_subprocess()
112
raise
113
114
115
cmd = self.formcmd(cmd)
116
117
self.log('$ ' + ' '.join(cmd))
118
actual_retcode = call(cmd, stdout=self.TEST_LOG, stderr=self.TEST_LOG)
119
120
if retcode != actual_retcode:
121
raise CommandFailed("test failed: %r returned %d, expected %d"
122
% (cmd, actual_retcode, retcode))
123
124
125
def backtick(self, cmd, retcode=0):
126
"""Run a command and return its output"""
127
try:
128
import shutil
129
from subprocess import Popen, PIPE
130
except ImportError, e:
131
_need_subprocess()
132
raise
133
134
cmd = self.formcmd(cmd)
135
child = Popen(cmd, stdout=PIPE, stderr=self.TEST_LOG)
136
outd, errd = child.communicate()
137
self.log(outd)
138
actual_retcode = child.wait()
139
140
outd = outd.replace('\r', '')
141
142
if retcode != actual_retcode:
143
raise CommandFailed("test failed: %r returned %d, expected %d"
144
% (cmd, actual_retcode, retcode))
145
146
return outd
147
148
149
150
def build_tree(self, shape):
151
"""Build a test tree according to a pattern.
152
153
shape is a sequence of file specifications. If the final
154
character is '/', a directory is created.
155
156
This doesn't add anything to a branch.
157
"""
158
# XXX: It's OK to just create them using forward slashes on windows?
159
import os
160
for name in shape:
161
assert isinstance(name, basestring)
162
if name[-1] == '/':
163
os.mkdir(name[:-1])
164
else:
165
f = file(name, 'wt')
166
print >>f, "contents of", name
167
f.close()
168
169
170
def log(self, msg):
171
"""Log a message to a progress file"""
172
self._log_buf = self._log_buf + str(msg) + '\n'
173
print >>self.TEST_LOG, msg
174
175
176
def check_inventory_shape(self, inv, shape):
177
"""
178
Compare an inventory to a list of expected names.
179
180
Fail if they are not precisely equal.
181
"""
182
extras = []
183
shape = list(shape) # copy
184
for path, ie in inv.entries():
185
name = path.replace('\\', '/')
186
if ie.kind == 'dir':
187
name = name + '/'
188
if name in shape:
189
shape.remove(name)
190
else:
191
extras.append(name)
192
if shape:
193
self.fail("expected paths not found in inventory: %r" % shape)
194
if extras:
195
self.fail("unexpected paths found in inventory: %r" % extras)
196
197
198
def check_file_contents(self, filename, expect):
199
self.log("check contents of file %s" % filename)
200
contents = file(filename, 'r').read()
201
if contents != expect:
202
self.log("expected: %r" % expected)
203
self.log("actually: %r" % contents)
204
self.fail("contents of %s not as expected")
205
206
207
208
class InTempDir(TestBase):
209
"""Base class for tests run in a temporary branch."""
210
def setUp(self):
211
import os
212
self.test_dir = os.path.join(self.TEST_ROOT, self.__class__.__name__)
213
os.mkdir(self.test_dir)
214
os.chdir(self.test_dir)
215
216
def tearDown(self):
217
import os
218
os.chdir(self.TEST_ROOT)
219
220
221
222
223
224
class _MyResult(TestResult):
225
"""
226
Custom TestResult.
227
228
No special behaviour for now.
229
"""
230
def __init__(self, out):
231
self.out = out
232
TestResult.__init__(self)
233
234
def startTest(self, test):
235
# TODO: Maybe show test.shortDescription somewhere?
236
what = test.id()
237
# python2.3 has the bad habit of just "runit" for doctests
238
if what == 'runit':
239
what = test.shortDescription()
240
241
print >>self.out, '%-60.60s' % what,
242
self.out.flush()
243
TestResult.startTest(self, test)
244
245
def stopTest(self, test):
246
# print
247
TestResult.stopTest(self, test)
248
249
250
def addError(self, test, err):
251
print >>self.out, 'ERROR'
252
TestResult.addError(self, test, err)
253
_show_test_failure('error', test, err, self.out)
254
255
def addFailure(self, test, err):
256
print >>self.out, 'FAILURE'
257
TestResult.addFailure(self, test, err)
258
_show_test_failure('failure', test, err, self.out)
259
260
def addSuccess(self, test):
261
print >>self.out, 'OK'
262
TestResult.addSuccess(self, test)
263
264
265
266
def run_suite(suite, name="test"):
267
import os
268
import shutil
269
import time
270
import sys
271
272
_setup_test_log(name)
273
_setup_test_dir(name)
274
print
275
276
# save stdout & stderr so there's no leakage from code-under-test
277
real_stdout = sys.stdout
278
real_stderr = sys.stderr
279
sys.stdout = sys.stderr = TestBase.TEST_LOG
280
try:
281
result = _MyResult(real_stdout)
282
suite.run(result)
283
finally:
284
sys.stdout = real_stdout
285
sys.stderr = real_stderr
286
287
_show_results(result)
288
289
return result.wasSuccessful()
290
291
292
293
def _setup_test_log(name):
294
import time
295
import os
296
297
log_filename = os.path.abspath(name + '.log')
298
TestBase.TEST_LOG = open(log_filename, 'wt', buffering=1) # line buffered
299
300
print >>TestBase.TEST_LOG, "tests run at " + time.ctime()
301
print '%-30s %s' % ('test log', log_filename)
302
303
304
def _setup_test_dir(name):
305
import os
306
import shutil
307
308
TestBase.ORIG_DIR = os.getcwdu()
309
TestBase.TEST_ROOT = os.path.abspath(name + '.tmp')
310
311
print '%-30s %s' % ('running tests in', TestBase.TEST_ROOT)
312
313
if os.path.exists(TestBase.TEST_ROOT):
314
shutil.rmtree(TestBase.TEST_ROOT)
315
os.mkdir(TestBase.TEST_ROOT)
316
os.chdir(TestBase.TEST_ROOT)
317
318
# make a fake bzr directory there to prevent any tests propagating
319
# up onto the source directory's real branch
320
os.mkdir(os.path.join(TestBase.TEST_ROOT, '.bzr'))
321
322
323
324
def _show_results(result):
325
print
326
print '%4d tests run' % result.testsRun
327
print '%4d errors' % len(result.errors)
328
print '%4d failures' % len(result.failures)
329
330
331
332
def _show_test_failure(kind, case, exc_info, out):
333
from traceback import print_exception
334
335
print >>out, '-' * 60
336
print >>out, case
337
338
desc = case.shortDescription()
339
if desc:
340
print >>out, ' (%s)' % desc
341
342
print_exception(exc_info[0], exc_info[1], exc_info[2], None, out)
343
344
if isinstance(case, TestBase):
345
print >>out
346
print >>out, 'log from this test:'
347
print >>out, case._log_buf
348
349
print >>out, '-' * 60
350
351
Loggerhead is a web-based interface for Breezy
Version: 2.0.1