« back to all changes in this revision
Viewing changes to testsweet.py
- browse files at revision 1153
- compare with another revision
- download diff
- download tarball
- view history from revision 1153
- Committer: Martin Pool
- Date: 2005-08-30 06:10:39 UTC
- Revision ID: mbp@sourcefrog.net-20050830061039-1d0347fb236c39ad
- clean up some code in revision.py
- move all exceptions to bzrlib.errors
- move all exceptions to bzrlib.errors
- files added:
- Makefile
- bzrlib/util
- files removed:
- plugins/changeset
- files renamed:
- plugins/ => bzrlib/plugins/
- effbot/ => bzrlib/util/effbot/
- elementtree/ => bzrlib/util/elementtree/
- urlgrabber/ => bzrlib/util/urlgrabber/
- files modified:
- .bzrignore
added
removed
testsweet.py
30
30
* utilities to run external commands and check their return code
31
31
and/or output
32
32
33
Test cases should normally subclass TestBase. The test runner should
33
Test cases should normally subclass testsweet.TestCase. The test runner should
34
34
call runsuite().
35
35
36
36
This is meant to become independent of bzr, though that's not quite
37
37
true yet.
38
38
"""
39
39
40
41
from unittest import TestResult, TestCase
40
import unittest
41
import sys
42
from bzrlib.selftest import TestUtil
42
43
43
44
# XXX: Don't need this anymore now we depend on python2.4
44
45
def _need_subprocess():
50
51
pass
51
52
52
53
53
54
54
class TestSkipped(Exception):
55
55
"""Indicates that a test was intentionally skipped, rather than failing."""
56
56
# XXX: Not used yet
57
57
58
58
59
class TestBase(TestCase):
60
"""Base class for bzr test cases.
61
62
Just defines some useful helper functions; doesn't actually test
63
anything.
64
"""
65
66
# TODO: Special methods to invoke bzr, so that we can run it
67
# through a specified Python intepreter
68
69
OVERRIDE_PYTHON = None # to run with alternative python 'python'
70
BZRPATH = 'bzr'
71
72
_log_buf = ""
73
74
75
def setUp(self):
76
super(TestBase, self).setUp()
77
self.log("%s setup" % self.id())
78
79
80
def tearDown(self):
81
super(TestBase, self).tearDown()
82
self.log("%s teardown" % self.id())
83
self.log('')
84
85
86
def formcmd(self, cmd):
87
if isinstance(cmd, basestring):
88
cmd = cmd.split()
89
90
if cmd[0] == 'bzr':
91
cmd[0] = self.BZRPATH
92
if self.OVERRIDE_PYTHON:
93
cmd.insert(0, self.OVERRIDE_PYTHON)
94
95
self.log('$ %r' % cmd)
96
97
return cmd
98
99
100
def runcmd(self, cmd, retcode=0):
101
"""Run one command and check the return code.
102
103
Returns a tuple of (stdout,stderr) strings.
104
105
If a single string is based, it is split into words.
106
For commands that are not simple space-separated words, please
107
pass a list instead."""
108
try:
109
import shutil
110
from subprocess import call
111
except ImportError, e:
112
_need_subprocess()
113
raise
114
115
116
cmd = self.formcmd(cmd)
117
118
self.log('$ ' + ' '.join(cmd))
119
actual_retcode = call(cmd, stdout=self.TEST_LOG, stderr=self.TEST_LOG)
120
121
if retcode != actual_retcode:
122
raise CommandFailed("test failed: %r returned %d, expected %d"
123
% (cmd, actual_retcode, retcode))
124
125
126
def backtick(self, cmd, retcode=0):
127
"""Run a command and return its output"""
128
try:
129
import shutil
130
from subprocess import Popen, PIPE
131
except ImportError, e:
132
_need_subprocess()
133
raise
134
135
cmd = self.formcmd(cmd)
136
child = Popen(cmd, stdout=PIPE, stderr=self.TEST_LOG)
137
outd, errd = child.communicate()
138
self.log(outd)
139
actual_retcode = child.wait()
140
141
outd = outd.replace('\r', '')
142
143
if retcode != actual_retcode:
144
raise CommandFailed("test failed: %r returned %d, expected %d"
145
% (cmd, actual_retcode, retcode))
146
147
return outd
148
149
150
151
def build_tree(self, shape):
152
"""Build a test tree according to a pattern.
153
154
shape is a sequence of file specifications. If the final
155
character is '/', a directory is created.
156
157
This doesn't add anything to a branch.
158
"""
159
# XXX: It's OK to just create them using forward slashes on windows?
160
import os
161
for name in shape:
162
assert isinstance(name, basestring)
163
if name[-1] == '/':
164
os.mkdir(name[:-1])
165
else:
166
f = file(name, 'wt')
167
print >>f, "contents of", name
168
f.close()
169
170
171
def log(self, msg):
172
"""Log a message to a progress file"""
173
# XXX: The problem with this is that code that writes straight
174
# to the log file won't be shown when we display the log
175
# buffer; would be better to not have the in-memory buffer and
176
# instead just a log file per test, which is read in and
177
# displayed if the test fails. That seems to imply one log
178
# per test case, not globally. OK?
179
self._log_buf = self._log_buf + str(msg) + '\n'
180
print >>self.TEST_LOG, msg
181
182
183
def check_inventory_shape(self, inv, shape):
184
"""
185
Compare an inventory to a list of expected names.
186
187
Fail if they are not precisely equal.
188
"""
189
extras = []
190
shape = list(shape) # copy
191
for path, ie in inv.entries():
192
name = path.replace('\\', '/')
193
if ie.kind == 'dir':
194
name = name + '/'
195
if name in shape:
196
shape.remove(name)
197
else:
198
extras.append(name)
199
if shape:
200
self.fail("expected paths not found in inventory: %r" % shape)
201
if extras:
202
self.fail("unexpected paths found in inventory: %r" % extras)
203
204
205
def check_file_contents(self, filename, expect):
206
self.log("check contents of file %s" % filename)
207
contents = file(filename, 'r').read()
208
if contents != expect:
209
self.log("expected: %r" % expect)
210
self.log("actually: %r" % contents)
211
self.fail("contents of %s not as expected")
212
213
214
215
class InTempDir(TestBase):
216
"""Base class for tests run in a temporary branch."""
217
def setUp(self):
218
import os
219
self.test_dir = os.path.join(self.TEST_ROOT, self.__class__.__name__)
220
os.mkdir(self.test_dir)
221
os.chdir(self.test_dir)
222
223
def tearDown(self):
224
import os
225
os.chdir(self.TEST_ROOT)
226
227
228
229
230
231
class _MyResult(TestResult):
59
60
class EarlyStoppingTestResultAdapter(object):
61
"""An adapter for TestResult to stop at the first first failure or error"""
62
63
def __init__(self, result):
64
self._result = result
65
66
def addError(self, test, err):
67
self._result.addError(test, err)
68
self._result.stop()
69
70
def addFailure(self, test, err):
71
self._result.addFailure(test, err)
72
self._result.stop()
73
74
def __getattr__(self, name):
75
return getattr(self._result, name)
76
77
def __setattr__(self, name, value):
78
if name == '_result':
79
object.__setattr__(self, name, value)
80
return setattr(self._result, name, value)
81
82
83
class _MyResult(unittest._TextTestResult):
232
84
"""
233
85
Custom TestResult.
234
86
235
87
No special behaviour for now.
236
88
"""
237
def __init__(self, out, style):
238
self.out = out
239
TestResult.__init__(self)
240
assert style in ('none', 'progress', 'verbose')
241
self.style = style
242
243
89
244
90
def startTest(self, test):
91
unittest.TestResult.startTest(self, test)
245
92
# TODO: Maybe show test.shortDescription somewhere?
246
93
what = test.id()
247
94
# python2.3 has the bad habit of just "runit" for doctests
248
95
if what == 'runit':
249
96
what = test.shortDescription()
250
251
if self.style == 'verbose':
252
print >>self.out, '%-60.60s' % what,
253
self.out.flush()
254
elif self.style == 'progress':
255
self.out.write('~')
256
self.out.flush()
257
TestResult.startTest(self, test)
258
259
260
def stopTest(self, test):
261
# print
262
TestResult.stopTest(self, test)
263
97
if self.showAll:
98
self.stream.write('%-60.60s' % what)
99
self.stream.flush()
264
100
265
101
def addError(self, test, err):
266
if self.style == 'verbose':
267
print >>self.out, 'ERROR'
268
TestResult.addError(self, test, err)
269
_show_test_failure('error', test, err, self.out)
102
super(_MyResult, self).addError(test, err)
103
self.stream.flush()
270
104
271
105
def addFailure(self, test, err):
272
if self.style == 'verbose':
273
print >>self.out, 'FAILURE'
274
TestResult.addFailure(self, test, err)
275
_show_test_failure('failure', test, err, self.out)
106
super(_MyResult, self).addFailure(test, err)
107
self.stream.flush()
276
108
277
109
def addSuccess(self, test):
278
if self.style == 'verbose':
279
print >>self.out, 'OK'
280
TestResult.addSuccess(self, test)
281
282
283
284
def run_suite(suite, name='test', verbose=False):
285
import os
110
if self.showAll:
111
self.stream.writeln('OK')
112
elif self.dots:
113
self.stream.write('~')
114
self.stream.flush()
115
unittest.TestResult.addSuccess(self, test)
116
117
def printErrorList(self, flavour, errors):
118
for test, err in errors:
119
self.stream.writeln(self.separator1)
120
self.stream.writeln("%s: %s" % (flavour,self.getDescription(test)))
121
self.stream.writeln(self.separator2)
122
self.stream.writeln("%s" % err)
123
if hasattr(test, '_get_log'):
124
self.stream.writeln()
125
self.stream.writeln('log from this test:')
126
print >>self.stream, test._get_log()
127
128
129
class TextTestRunner(unittest.TextTestRunner):
130
131
def _makeResult(self):
132
result = _MyResult(self.stream, self.descriptions, self.verbosity)
133
return EarlyStoppingTestResultAdapter(result)
134
135
136
class filteringVisitor(TestUtil.TestVisitor):
137
"""I accruse all the testCases I visit that pass a regexp filter on id
138
into my suite
139
"""
140
141
def __init__(self, filter):
142
import re
143
TestUtil.TestVisitor.__init__(self)
144
self._suite=None
145
self.filter=re.compile(filter)
146
147
def suite(self):
148
"""answer the suite we are building"""
149
if self._suite is None:
150
self._suite=TestUtil.TestSuite()
151
return self._suite
152
153
def visitCase(self, aCase):
154
if self.filter.match(aCase.id()):
155
self.suite().addTest(aCase)
156
157
158
def run_suite(suite, name='test', verbose=False, pattern=".*"):
286
159
import shutil
287
import time
288
import sys
289
290
_setup_test_log(name)
291
_setup_test_dir(name)
292
print
293
294
# save stdout & stderr so there's no leakage from code-under-test
295
real_stdout = sys.stdout
296
real_stderr = sys.stderr
297
sys.stdout = sys.stderr = TestBase.TEST_LOG
298
try:
299
if verbose:
300
style = 'verbose'
301
else:
302
style = 'progress'
303
result = _MyResult(real_stdout, style)
304
suite.run(result)
305
finally:
306
sys.stdout = real_stdout
307
sys.stderr = real_stderr
308
309
_show_results(result)
310
160
from bzrlib.selftest import TestCaseInTempDir
161
TestCaseInTempDir._TEST_NAME = name
162
if verbose:
163
verbosity = 2
164
else:
165
verbosity = 1
166
runner = TextTestRunner(stream=sys.stdout,
167
descriptions=0,
168
verbosity=verbosity)
169
visitor = filteringVisitor(pattern)
170
suite.visit(visitor)
171
result = runner.run(visitor.suite())
172
# This is still a little bogus,
173
# but only a little. Folk not using our testrunner will
174
# have to delete their temp directories themselves.
175
if result.wasSuccessful():
176
if TestCaseInTempDir.TEST_ROOT:
177
shutil.rmtree(TestCaseInTempDir.TEST_ROOT)
178
else:
179
print "Failed tests working directories are in '%s'\n" % TestCaseInTempDir.TEST_ROOT
311
180
return result.wasSuccessful()
312
313
314
315
def _setup_test_log(name):
316
import time
317
import os
318
319
log_filename = os.path.abspath(name + '.log')
320
TestBase.TEST_LOG = open(log_filename, 'wt', buffering=1) # line buffered
321
322
print >>TestBase.TEST_LOG, "tests run at " + time.ctime()
323
print '%-30s %s' % ('test log', log_filename)
324
325
326
def _setup_test_dir(name):
327
import os
328
import shutil
329
330
TestBase.ORIG_DIR = os.getcwdu()
331
TestBase.TEST_ROOT = os.path.abspath(name + '.tmp')
332
333
print '%-30s %s' % ('running tests in', TestBase.TEST_ROOT)
334
335
if os.path.exists(TestBase.TEST_ROOT):
336
shutil.rmtree(TestBase.TEST_ROOT)
337
os.mkdir(TestBase.TEST_ROOT)
338
os.chdir(TestBase.TEST_ROOT)
339
340
# make a fake bzr directory there to prevent any tests propagating
341
# up onto the source directory's real branch
342
os.mkdir(os.path.join(TestBase.TEST_ROOT, '.bzr'))
343
344
345
346
def _show_results(result):
347
print
348
print '%4d tests run' % result.testsRun
349
print '%4d errors' % len(result.errors)
350
print '%4d failures' % len(result.failures)
351
352
353
354
def _show_test_failure(kind, case, exc_info, out):
355
from traceback import print_exception
356
357
print >>out
358
print >>out, '-' * 60
359
print >>out, case
360
361
desc = case.shortDescription()
362
if desc:
363
print >>out, ' (%s)' % desc
364
365
print_exception(exc_info[0], exc_info[1], exc_info[2], None, out)
366
367
if isinstance(case, TestBase):
368
print >>out
369
print >>out, 'log from this test:'
370
print >>out, case._log_buf
371
372
print >>out, '-' * 60
373
374
Loggerhead is a web-based interface for Breezy
Version: 2.0.1