« back to all changes in this revision
Viewing changes to bzrlib/selftest/__init__.py
- browse files at revision 819
- compare with another revision
- download diff
- download tarball
- view history from revision 819
- Committer: Martin Pool
- Date: 2005-07-04 12:26:02 UTC
- Revision ID: mbp@sourcefrog.net-20050704122602-69901910521e62c3
- check command checks that all inventory-ids are the same as in the revision.
- files added:
- bzrlib/statcache.py
- plugins/changeset
- plugins/rsync
- files removed:
- HACKING
- bzrlib/util
- contrib/emacs
- tools
- files renamed:
- bzrlib/util/effbot/ => effbot/
- bzrlib/util/elementtree/ => elementtree/
- bzrlib/plugins/ => plugins/
- bzrlib/util/urlgrabber/ => urlgrabber/
- files modified:
- .bzrignore
added
removed
bzrlib/selftest/__init__.py
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
16
17
17
18
import logging
19
import unittest
20
import tempfile
21
import os
22
import sys
23
import subprocess
24
25
from testsweet import run_suite
26
import bzrlib.commands
27
28
import bzrlib.trace
29
import bzrlib.fetch
30
31
32
MODULES_TO_TEST = []
33
MODULES_TO_DOCTEST = []
34
35
from logging import debug, warning, error
18
from unittest import TestResult, TestCase
19
20
try:
21
import shutil
22
from subprocess import call, Popen, PIPE
23
except ImportError, e:
24
sys.stderr.write("testbzr: sorry, this test suite requires the subprocess module\n"
25
"this is shipped with python2.4 and available separately for 2.3\n")
26
raise
27
36
28
37
29
class CommandFailed(Exception):
38
30
pass
39
31
40
class TestCase(unittest.TestCase):
41
"""Base class for bzr unit tests.
32
33
class TestBase(TestCase):
34
"""Base class for bzr test cases.
35
36
Just defines some useful helper functions; doesn't actually test
37
anything.
38
"""
42
39
43
Tests that need access to disk resources should subclass
44
TestCaseInTempDir not TestCase.
45
46
Error and debug log messages are redirected from their usual
47
location into a temporary file, the contents of which can be
48
retrieved by _get_log().
49
50
There are also convenience functions to invoke bzr's command-line
51
routine, and to build and check bzr trees."""
52
40
# TODO: Special methods to invoke bzr, so that we can run it
41
# through a specified Python intepreter
42
43
OVERRIDE_PYTHON = None # to run with alternative python 'python'
53
44
BZRPATH = 'bzr'
54
45
55
def setUp(self):
56
# this replaces the default testsweet.TestCase; we don't want logging changed
57
unittest.TestCase.setUp(self)
58
bzrlib.trace.disable_default_logging()
59
self._enable_file_logging()
60
61
62
def _enable_file_logging(self):
63
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
64
65
self._log_file = os.fdopen(fileno, 'w+')
66
67
hdlr = logging.StreamHandler(self._log_file)
68
hdlr.setLevel(logging.DEBUG)
69
hdlr.setFormatter(logging.Formatter('%(levelname)4.4s %(message)s'))
70
logging.getLogger('').addHandler(hdlr)
71
logging.getLogger('').setLevel(logging.DEBUG)
72
self._log_hdlr = hdlr
73
debug('opened log file %s', name)
74
75
self._log_file_name = name
76
77
78
def tearDown(self):
79
logging.getLogger('').removeHandler(self._log_hdlr)
80
bzrlib.trace.enable_default_logging()
81
logging.debug('%s teardown', self.id())
82
self._log_file.close()
83
unittest.TestCase.tearDown(self)
84
85
86
def log(self, *args):
87
logging.debug(*args)
88
89
def _get_log(self):
90
"""Return as a string the log for this test"""
91
return open(self._log_file_name).read()
92
93
def run_bzr(self, *args, **kwargs):
94
"""Invoke bzr, as if it were run from the command line.
95
96
This should be the main method for tests that want to exercise the
97
overall behavior of the bzr application (rather than a unit test
98
or a functional test of the library.)
99
100
Much of the old code runs bzr by forking a new copy of Python, but
101
that is slower, harder to debug, and generally not necessary.
102
"""
103
retcode = kwargs.get('retcode', 0)
104
result = self.apply_redirected(None, None, None,
105
bzrlib.commands.run_bzr, args)
106
self.assertEquals(result, retcode)
107
108
109
def check_inventory_shape(self, inv, shape):
110
"""
111
Compare an inventory to a list of expected names.
112
113
Fail if they are not precisely equal.
114
"""
115
extras = []
116
shape = list(shape) # copy
117
for path, ie in inv.entries():
118
name = path.replace('\\', '/')
119
if ie.kind == 'dir':
120
name = name + '/'
121
if name in shape:
122
shape.remove(name)
123
else:
124
extras.append(name)
125
if shape:
126
self.fail("expected paths not found in inventory: %r" % shape)
127
if extras:
128
self.fail("unexpected paths found in inventory: %r" % extras)
129
130
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
131
a_callable=None, *args, **kwargs):
132
"""Call callable with redirected std io pipes.
133
134
Returns the return code."""
135
from StringIO import StringIO
136
if not callable(a_callable):
137
raise ValueError("a_callable must be callable.")
138
if stdin is None:
139
stdin = StringIO("")
140
if stdout is None:
141
stdout = self._log_file
142
if stderr is None:
143
stderr = self._log_file
144
real_stdin = sys.stdin
145
real_stdout = sys.stdout
146
real_stderr = sys.stderr
147
try:
148
sys.stdout = stdout
149
sys.stderr = stderr
150
sys.stdin = stdin
151
return a_callable(*args, **kwargs)
152
finally:
153
sys.stdout = real_stdout
154
sys.stderr = real_stderr
155
sys.stdin = real_stdin
156
157
158
BzrTestBase = TestCase
159
160
161
class TestCaseInTempDir(TestCase):
162
"""Derived class that runs a test within a temporary directory.
163
164
This is useful for tests that need to create a branch, etc.
165
166
The directory is created in a slightly complex way: for each
167
Python invocation, a new temporary top-level directory is created.
168
All test cases create their own directory within that. If the
169
tests complete successfully, the directory is removed.
170
171
InTempDir is an old alias for FunctionalTestCase.
172
"""
173
174
TEST_ROOT = None
175
_TEST_NAME = 'test'
176
OVERRIDE_PYTHON = 'python'
177
178
def check_file_contents(self, filename, expect):
179
self.log("check contents of file %s" % filename)
180
contents = file(filename, 'r').read()
181
if contents != expect:
182
self.log("expected: %r" % expect)
183
self.log("actually: %r" % contents)
184
self.fail("contents of %s not as expected")
185
186
def _make_test_root(self):
187
import os
188
import shutil
189
import tempfile
190
191
if TestCaseInTempDir.TEST_ROOT is not None:
192
return
193
TestCaseInTempDir.TEST_ROOT = os.path.abspath(
194
tempfile.mkdtemp(suffix='.tmp',
195
prefix=self._TEST_NAME + '-',
196
dir=os.curdir))
197
198
# make a fake bzr directory there to prevent any tests propagating
199
# up onto the source directory's real branch
200
os.mkdir(os.path.join(TestCaseInTempDir.TEST_ROOT, '.bzr'))
201
202
def setUp(self):
203
super(TestCaseInTempDir, self).setUp()
204
import os
205
self._make_test_root()
206
self._currentdir = os.getcwdu()
207
self.test_dir = os.path.join(self.TEST_ROOT, self.id())
208
os.mkdir(self.test_dir)
209
os.chdir(self.test_dir)
210
211
def tearDown(self):
212
import os
213
os.chdir(self._currentdir)
214
super(TestCaseInTempDir, self).tearDown()
215
216
def _formcmd(self, cmd):
46
_log_buf = ""
47
48
49
def formcmd(self, cmd):
217
50
if isinstance(cmd, basestring):
218
51
cmd = cmd.split()
52
219
53
if cmd[0] == 'bzr':
220
54
cmd[0] = self.BZRPATH
221
55
if self.OVERRIDE_PYTHON:
222
56
cmd.insert(0, self.OVERRIDE_PYTHON)
57
223
58
self.log('$ %r' % cmd)
59
224
60
return cmd
225
61
62
226
63
def runcmd(self, cmd, retcode=0):
227
64
"""Run one command and check the return code.
228
65
231
68
If a single string is based, it is split into words.
232
69
For commands that are not simple space-separated words, please
233
70
pass a list instead."""
234
cmd = self._formcmd(cmd)
71
cmd = self.formcmd(cmd)
72
235
73
self.log('$ ' + ' '.join(cmd))
236
actual_retcode = subprocess.call(cmd, stdout=self._log_file,
237
stderr=self._log_file)
74
actual_retcode = call(cmd, stdout=self.TEST_LOG, stderr=self.TEST_LOG)
75
238
76
if retcode != actual_retcode:
239
77
raise CommandFailed("test failed: %r returned %d, expected %d"
240
78
% (cmd, actual_retcode, retcode))
241
79
80
242
81
def backtick(self, cmd, retcode=0):
243
82
"""Run a command and return its output"""
244
cmd = self._formcmd(cmd)
245
child = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=self._log_file)
83
cmd = self.formcmd(cmd)
84
child = Popen(cmd, stdout=PIPE, stderr=self.TEST_LOG)
246
85
outd, errd = child.communicate()
247
86
self.log(outd)
248
87
actual_retcode = child.wait()
275
114
f = file(name, 'wt')
276
115
print >>f, "contents of", name
277
116
f.close()
278
279
280
281
class MetaTestLog(TestCase):
282
def test_logging(self):
283
"""Test logs are captured when a test fails."""
284
logging.info('an info message')
285
warning('something looks dodgy...')
286
logging.debug('hello, test is running')
287
##assert 0
288
289
290
def selftest(verbose=False, pattern=".*"):
291
return run_suite(test_suite(), 'testbzr', verbose=verbose, pattern=pattern)
292
293
294
def test_suite():
295
from bzrlib.selftest.TestUtil import TestLoader, TestSuite
296
import bzrlib, bzrlib.store, bzrlib.inventory, bzrlib.branch
297
import bzrlib.osutils, bzrlib.commands, bzrlib.merge3, bzrlib.plugin
117
118
119
def log(self, msg):
120
"""Log a message to a progress file"""
121
self._log_buf = self._log_buf + str(msg) + '\n'
122
print >>self.TEST_LOG, msg
123
124
125
def check_inventory_shape(self, inv, shape):
126
"""
127
Compare an inventory to a list of expected names.
128
129
Fail if they are not precisely equal.
130
"""
131
extras = []
132
shape = list(shape) # copy
133
for path, ie in inv.entries():
134
name = path.replace('\\', '/')
135
if ie.kind == 'dir':
136
name = name + '/'
137
if name in shape:
138
shape.remove(name)
139
else:
140
extras.append(name)
141
if shape:
142
self.fail("expected paths not found in inventory: %r" % shape)
143
if extras:
144
self.fail("unexpected paths found in inventory: %r" % extras)
145
146
147
def check_file_contents(self, filename, expect):
148
self.log("check contents of file %s" % filename)
149
contents = file(filename, 'r').read()
150
if contents != expect:
151
self.log("expected: %r" % expected)
152
self.log("actually: %r" % contents)
153
self.fail("contents of %s not as expected")
154
155
156
157
class InTempDir(TestBase):
158
"""Base class for tests run in a temporary branch."""
159
def setUp(self):
160
import os
161
self.test_dir = os.path.join(self.TEST_ROOT, self.__class__.__name__)
162
os.mkdir(self.test_dir)
163
os.chdir(self.test_dir)
164
165
def tearDown(self):
166
import os
167
os.chdir(self.TEST_ROOT)
168
169
170
171
172
173
class _MyResult(TestResult):
174
"""
175
Custom TestResult.
176
177
No special behaviour for now.
178
"""
179
def __init__(self, out):
180
self.out = out
181
TestResult.__init__(self)
182
183
def startTest(self, test):
184
# TODO: Maybe show test.shortDescription somewhere?
185
print >>self.out, '%-60.60s' % test.id(),
186
self.out.flush()
187
TestResult.startTest(self, test)
188
189
def stopTest(self, test):
190
# print
191
TestResult.stopTest(self, test)
192
193
194
def addError(self, test, err):
195
print >>self.out, 'ERROR'
196
TestResult.addError(self, test, err)
197
_show_test_failure('error', test, err, self.out)
198
199
def addFailure(self, test, err):
200
print >>self.out, 'FAILURE'
201
TestResult.addFailure(self, test, err)
202
_show_test_failure('failure', test, err, self.out)
203
204
def addSuccess(self, test):
205
print >>self.out, 'OK'
206
TestResult.addSuccess(self, test)
207
208
209
210
def selftest():
211
from unittest import TestLoader, TestSuite
212
import bzrlib, bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, bzrlib.commands
213
214
import bzrlib.selftest.whitebox
215
import bzrlib.selftest.blackbox
216
import bzrlib.selftest.versioning
217
import bzrlib.merge_core
298
218
from doctest import DocTestSuite
299
219
import os
300
220
import shutil
301
221
import time
302
222
import sys
303
223
304
global MODULES_TO_TEST, MODULES_TO_DOCTEST
305
306
testmod_names = \
307
['bzrlib.selftest.MetaTestLog',
308
'bzrlib.selftest.test_parent',
309
'bzrlib.selftest.testinv',
310
'bzrlib.selftest.testfetch',
311
'bzrlib.selftest.versioning',
312
'bzrlib.selftest.whitebox',
313
'bzrlib.selftest.testmerge3',
314
'bzrlib.selftest.testhashcache',
315
'bzrlib.selftest.teststatus',
316
'bzrlib.selftest.testlog',
317
'bzrlib.selftest.blackbox',
318
'bzrlib.selftest.testrevisionnamespaces',
319
'bzrlib.selftest.testbranch',
320
'bzrlib.selftest.testrevision',
321
'bzrlib.selftest.test_merge_core',
322
'bzrlib.selftest.test_smart_add',
323
'bzrlib.selftest.testdiff',
324
'bzrlib.selftest.test_xml',
325
'bzrlib.fetch',
326
'bzrlib.selftest.teststore',
327
]
328
329
for m in (bzrlib.store, bzrlib.inventory, bzrlib.branch,
330
bzrlib.osutils, bzrlib.commands, bzrlib.merge3):
331
if m not in MODULES_TO_DOCTEST:
332
MODULES_TO_DOCTEST.append(m)
333
334
TestCase.BZRPATH = os.path.join(os.path.realpath(os.path.dirname(bzrlib.__path__[0])), 'bzr')
335
print '%-30s %s' % ('bzr binary', TestCase.BZRPATH)
224
TestBase.BZRPATH = os.path.join(os.path.realpath(os.path.dirname(bzrlib.__path__[0])), 'bzr')
225
print '%-30s %s' % ('bzr binary', TestBase.BZRPATH)
226
227
_setup_test_log()
228
_setup_test_dir()
336
229
print
230
337
231
suite = TestSuite()
338
suite.addTest(TestLoader().loadTestsFromNames(testmod_names))
339
for m in MODULES_TO_TEST:
340
suite.addTest(TestLoader().loadTestsFromModule(m))
341
for m in (MODULES_TO_DOCTEST):
232
tl = TestLoader()
233
234
# should also test bzrlib.merge_core, but they seem to be out of date with
235
# the code.
236
237
for m in bzrlib.selftest.whitebox, \
238
bzrlib.selftest.versioning:
239
suite.addTest(tl.loadTestsFromModule(m))
240
241
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
242
bzrlib.commands:
342
243
suite.addTest(DocTestSuite(m))
343
for p in bzrlib.plugin.all_plugins:
344
if hasattr(p, 'test_suite'):
345
suite.addTest(p.test_suite())
346
return suite
244
245
suite.addTest(bzrlib.selftest.blackbox.suite())
246
247
# save stdout & stderr so there's no leakage from code-under-test
248
real_stdout = sys.stdout
249
real_stderr = sys.stderr
250
sys.stdout = sys.stderr = TestBase.TEST_LOG
251
try:
252
result = _MyResult(real_stdout)
253
suite.run(result)
254
finally:
255
sys.stdout = real_stdout
256
sys.stderr = real_stderr
257
258
_show_results(result)
259
260
return result.wasSuccessful()
261
262
263
264
265
def _setup_test_log():
266
import time
267
import os
268
269
log_filename = os.path.abspath('testbzr.log')
270
TestBase.TEST_LOG = open(log_filename, 'wt', buffering=1) # line buffered
271
272
print >>TestBase.TEST_LOG, "bzr tests run at " + time.ctime()
273
print '%-30s %s' % ('test log', log_filename)
274
275
276
def _setup_test_dir():
277
import os
278
import shutil
279
280
TestBase.ORIG_DIR = os.getcwdu()
281
TestBase.TEST_ROOT = os.path.abspath("testbzr.tmp")
282
283
print '%-30s %s' % ('running tests in', TestBase.TEST_ROOT)
284
285
if os.path.exists(TestBase.TEST_ROOT):
286
shutil.rmtree(TestBase.TEST_ROOT)
287
os.mkdir(TestBase.TEST_ROOT)
288
os.chdir(TestBase.TEST_ROOT)
289
290
# make a fake bzr directory there to prevent any tests propagating
291
# up onto the source directory's real branch
292
os.mkdir(os.path.join(TestBase.TEST_ROOT, '.bzr'))
293
294
295
296
def _show_results(result):
297
print
298
print '%4d tests run' % result.testsRun
299
print '%4d errors' % len(result.errors)
300
print '%4d failures' % len(result.failures)
301
302
303
304
def _show_test_failure(kind, case, exc_info, out):
305
from traceback import print_exception
306
307
print >>out, '-' * 60
308
print >>out, case
309
310
desc = case.shortDescription()
311
if desc:
312
print >>out, ' (%s)' % desc
313
314
print_exception(exc_info[0], exc_info[1], exc_info[2], None, out)
315
316
if isinstance(case, TestBase):
317
print >>out
318
print >>out, 'log from this test:'
319
print >>out, case._log_buf
320
321
print >>out, '-' * 60
322
347
323
Loggerhead is a web-based interface for Breezy
Version: 2.0.1