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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
|
# 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
from cStringIO import StringIO
import logging
import unittest
import tempfile
import os
import sys
import errno
import subprocess
import shutil
import re
import bzrlib.commands
import bzrlib.trace
import bzrlib.fetch
from bzrlib.selftest import TestUtil
from bzrlib.selftest.TestUtil import TestLoader, TestSuite
MODULES_TO_TEST = []
MODULES_TO_DOCTEST = []
from logging import debug, warning, error
class EarlyStoppingTestResultAdapter(object):
"""An adapter for TestResult to stop at the first first failure or error"""
def __init__(self, result):
self._result = result
def addError(self, test, err):
self._result.addError(test, err)
self._result.stop()
def addFailure(self, test, err):
self._result.addFailure(test, err)
self._result.stop()
def __getattr__(self, name):
return getattr(self._result, name)
def __setattr__(self, name, value):
if name == '_result':
object.__setattr__(self, name, value)
return setattr(self._result, name, value)
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.shortDescription() or test.id()
if self.showAll:
self.stream.write('%-70.70s' % 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)))
if hasattr(test, '_get_log'):
self.stream.writeln()
self.stream.writeln('log from this test:')
print >>self.stream, test._get_log()
self.stream.writeln(self.separator2)
self.stream.writeln("%s" % err)
class TextTestRunner(unittest.TextTestRunner):
def _makeResult(self):
result = _MyResult(self.stream, self.descriptions, self.verbosity)
return EarlyStoppingTestResultAdapter(result)
def iter_suite_tests(suite):
"""Return all tests in a suite, recursing through nested suites"""
for item in suite._tests:
if isinstance(item, unittest.TestCase):
yield item
elif isinstance(item, unittest.TestSuite):
for r in iter_suite_tests(item):
yield r
else:
raise Exception('unknown object %r inside test suite %r'
% (item, suite))
class TestSkipped(Exception):
"""Indicates that a test was intentionally skipped, rather than failing."""
# XXX: Not used yet
class CommandFailed(Exception):
pass
class TestCase(unittest.TestCase):
"""Base class for bzr unit tests.
Tests that need access to disk resources should subclass
TestCaseInTempDir not TestCase.
Error and debug log messages are redirected from their usual
location into a temporary file, the contents of which can be
retrieved by _get_log().
There are also convenience functions to invoke bzr's command-line
routine, and to build and check bzr trees."""
BZRPATH = 'bzr'
def setUp(self):
unittest.TestCase.setUp(self)
bzrlib.trace.disable_default_logging()
self._enable_file_logging()
def _enable_file_logging(self):
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
self._log_file = os.fdopen(fileno, 'w+')
hdlr = logging.StreamHandler(self._log_file)
hdlr.setLevel(logging.DEBUG)
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
logging.getLogger('').addHandler(hdlr)
logging.getLogger('').setLevel(logging.DEBUG)
self._log_hdlr = hdlr
debug('opened log file %s', name)
self._log_file_name = name
def tearDown(self):
logging.getLogger('').removeHandler(self._log_hdlr)
bzrlib.trace.enable_default_logging()
logging.debug('%s teardown', self.id())
self._log_file.close()
unittest.TestCase.tearDown(self)
def log(self, *args):
logging.debug(*args)
def _get_log(self):
"""Return as a string the log for this test"""
return open(self._log_file_name).read()
def capture(self, cmd):
"""Shortcut that splits cmd into words, runs, and returns stdout"""
return self.run_bzr_captured(cmd.split())[0]
def run_bzr_captured(self, argv, retcode=0):
"""Invoke bzr and return (result, stdout, stderr).
Useful for code that wants to check the contents of the
output, the way error messages are presented, etc.
This should be the main method for tests that want to exercise the
overall behavior of the bzr application (rather than a unit test
or a functional test of the library.)
Much of the old code runs bzr by forking a new copy of Python, but
that is slower, harder to debug, and generally not necessary.
This runs bzr through the interface that catches and reports
errors, and with logging set to something approximating the
default, so that error reporting can be checked.
argv -- arguments to invoke bzr
retcode -- expected return code, or None for don't-care.
"""
stdout = StringIO()
stderr = StringIO()
self.log('run bzr: %s', ' '.join(argv))
handler = logging.StreamHandler(stderr)
handler.setFormatter(bzrlib.trace.QuietFormatter())
handler.setLevel(logging.INFO)
logger = logging.getLogger('')
logger.addHandler(handler)
try:
result = self.apply_redirected(None, stdout, stderr,
bzrlib.commands.run_bzr_catch_errors,
argv)
finally:
logger.removeHandler(handler)
out = stdout.getvalue()
err = stderr.getvalue()
if out:
self.log('output:\n%s', out)
if err:
self.log('errors:\n%s', err)
if retcode is not None:
self.assertEquals(result, retcode)
return out, err
def run_bzr(self, *args, **kwargs):
"""Invoke bzr, as if it were run from the command line.
This should be the main method for tests that want to exercise the
overall behavior of the bzr application (rather than a unit test
or a functional test of the library.)
This sends the stdout/stderr results into the test's log,
where it may be useful for debugging. See also run_captured.
"""
retcode = kwargs.pop('retcode', 0)
return self.run_bzr_captured(args, retcode)
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 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."""
if not callable(a_callable):
raise ValueError("a_callable must be callable.")
if stdin is None:
stdin = StringIO("")
if stdout is None:
if hasattr(self, "_log_file"):
stdout = self._log_file
else:
stdout = StringIO()
if stderr is None:
if hasattr(self, "_log_file"):
stderr = self._log_file
else:
stderr = StringIO()
real_stdin = sys.stdin
real_stdout = sys.stdout
real_stderr = sys.stderr
try:
sys.stdout = stdout
sys.stderr = stderr
sys.stdin = stdin
return a_callable(*args, **kwargs)
finally:
sys.stdout = real_stdout
sys.stderr = real_stderr
sys.stdin = real_stdin
BzrTestBase = TestCase
class TestCaseInTempDir(TestCase):
"""Derived class that runs a test within a temporary directory.
This is useful for tests that need to create a branch, etc.
The directory is created in a slightly complex way: for each
Python invocation, a new temporary top-level directory is created.
All test cases create their own directory within that. If the
tests complete successfully, the directory is removed.
InTempDir is an old alias for FunctionalTestCase.
"""
TEST_ROOT = None
_TEST_NAME = 'test'
OVERRIDE_PYTHON = 'python'
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" % filename)
def _make_test_root(self):
if TestCaseInTempDir.TEST_ROOT is not None:
return
i = 0
while True:
root = 'test%04d.tmp' % i
try:
os.mkdir(root)
except OSError, e:
if e.errno == errno.EEXIST:
i += 1
continue
else:
raise
# successfully created
TestCaseInTempDir.TEST_ROOT = os.path.abspath(root)
break
# make a fake bzr directory there to prevent any tests propagating
# up onto the source directory's real branch
os.mkdir(os.path.join(TestCaseInTempDir.TEST_ROOT, '.bzr'))
def setUp(self):
super(TestCaseInTempDir, self).setUp()
self._make_test_root()
self._currentdir = os.getcwdu()
short_id = self.id().replace('bzrlib.selftest.', '') \
.replace('__main__.', '')
self.test_dir = os.path.join(self.TEST_ROOT, short_id)
os.mkdir(self.test_dir)
os.chdir(self.test_dir)
def tearDown(self):
os.chdir(self._currentdir)
super(TestCaseInTempDir, self).tearDown()
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?
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()
def failUnlessExists(self, path):
"""Fail unless path, which may be abs or relative, exists."""
self.failUnless(os.path.exists(path))
class MetaTestLog(TestCase):
def test_logging(self):
"""Test logs are captured when a test fails."""
logging.info('an info message')
warning('something looks dodgy...')
logging.debug('hello, test is running')
##assert 0
def filter_suite_by_re(suite, pattern):
result = TestUtil.TestSuite()
filter_re = re.compile(pattern)
for test in iter_suite_tests(suite):
if filter_re.match(test.id()):
result.addTest(test)
return result
def filter_suite_by_names(suite, wanted_names):
"""Return a new suite containing only selected tests.
Names are considered to match if any name is a substring of the
fully-qualified test id (i.e. the class ."""
result = TestSuite()
for test in iter_suite_tests(suite):
this_id = test.id()
for p in wanted_names:
if this_id.find(p) != -1:
result.addTest(test)
return result
def run_suite(suite, name='test', verbose=False, pattern=".*", testnames=None):
TestCaseInTempDir._TEST_NAME = name
if verbose:
verbosity = 2
else:
verbosity = 1
runner = TextTestRunner(stream=sys.stdout,
descriptions=0,
verbosity=verbosity)
if testnames:
suite = filter_suite_by_names(suite, testnames)
if pattern != '.*':
suite = filter_suite_by_re(suite, pattern)
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():
if TestCaseInTempDir.TEST_ROOT is not None:
shutil.rmtree(TestCaseInTempDir.TEST_ROOT)
else:
print "Failed tests working directories are in '%s'\n" % TestCaseInTempDir.TEST_ROOT
return result.wasSuccessful()
def selftest(verbose=False, pattern=".*", testnames=None):
"""Run the whole test suite under the enhanced runner"""
return run_suite(test_suite(), 'testbzr', verbose=verbose, pattern=pattern,
testnames=testnames)
def test_suite():
"""Build and return TestSuite for the whole program."""
import bzrlib.store, bzrlib.inventory, bzrlib.branch
import bzrlib.osutils, bzrlib.merge3, bzrlib.plugin
from doctest import DocTestSuite
global MODULES_TO_TEST, MODULES_TO_DOCTEST
testmod_names = \
['bzrlib.selftest.MetaTestLog',
'bzrlib.selftest.testidentitymap',
'bzrlib.selftest.testinv',
'bzrlib.selftest.test_ancestry',
'bzrlib.selftest.test_commit',
'bzrlib.selftest.test_commit_merge',
'bzrlib.selftest.versioning',
'bzrlib.selftest.testmerge3',
'bzrlib.selftest.testmerge',
'bzrlib.selftest.testhashcache',
'bzrlib.selftest.teststatus',
'bzrlib.selftest.testlog',
'bzrlib.selftest.testrevisionnamespaces',
'bzrlib.selftest.testbranch',
'bzrlib.selftest.testrevision',
'bzrlib.selftest.test_revision_info',
'bzrlib.selftest.test_merge_core',
'bzrlib.selftest.test_smart_add',
'bzrlib.selftest.test_bad_files',
'bzrlib.selftest.testdiff',
'bzrlib.selftest.test_parent',
'bzrlib.selftest.test_xml',
'bzrlib.selftest.test_weave',
'bzrlib.selftest.testfetch',
'bzrlib.selftest.whitebox',
'bzrlib.selftest.teststore',
'bzrlib.selftest.blackbox',
'bzrlib.selftest.testsampler',
'bzrlib.selftest.testtransactions',
'bzrlib.selftest.testtransport',
'bzrlib.selftest.testgraph',
'bzrlib.selftest.testworkingtree',
'bzrlib.selftest.test_upgrade',
'bzrlib.selftest.test_conflicts',
]
for m in (bzrlib.store, bzrlib.inventory, bzrlib.branch,
bzrlib.osutils, bzrlib.commands, bzrlib.merge3):
if m not in MODULES_TO_DOCTEST:
MODULES_TO_DOCTEST.append(m)
TestCase.BZRPATH = os.path.join(os.path.realpath(os.path.dirname(bzrlib.__path__[0])), 'bzr')
print '%-30s %s' % ('bzr binary', TestCase.BZRPATH)
print
suite = TestSuite()
suite.addTest(TestLoader().loadTestsFromNames(testmod_names))
for m in MODULES_TO_TEST:
suite.addTest(TestLoader().loadTestsFromModule(m))
for m in (MODULES_TO_DOCTEST):
suite.addTest(DocTestSuite(m))
for p in bzrlib.plugin.all_plugins:
if hasattr(p, 'test_suite'):
suite.addTest(p.test_suite())
return suite
|