1
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2005, 2006 by Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: Perhaps there should be an API to find out if bzr running under the
19
# test suite -- some plugins might want to avoid making intrusive changes if
20
# this is the case. However, we want behaviour under to test to diverge as
21
# little as possible, so this should be used rarely if it's added at all.
22
# (Suggestion from j-a-meinel, 2005-11-24)
24
# NOTE: Some classes in here use camelCaseNaming() rather than
25
# underscore_naming(). That's for consistency with unittest; it's not the
26
# general style of bzrlib. Please continue that consistency when adding e.g.
27
# new assertFoo() methods.
30
from cStringIO import StringIO
39
from subprocess import Popen, PIPE
25
from testsweet import run_suite
47
import bzrlib.bzrdir as bzrdir
26
48
import bzrlib.commands
49
import bzrlib.bundle.serializer
50
import bzrlib.errors as errors
51
import bzrlib.inventory
52
import bzrlib.iterablefile
57
# lsprof not available
59
from bzrlib.merge import merge_inner
62
import bzrlib.osutils as osutils
64
import bzrlib.progress as progress
65
from bzrlib.revision import common_ancestor
66
from bzrlib.revisionspec import RevisionSpec
28
68
import bzrlib.trace
69
from bzrlib.transport import get_transport
70
import bzrlib.transport
71
from bzrlib.transport.local import LocalRelpathServer
72
from bzrlib.transport.readonly import ReadonlyServer
73
from bzrlib.trace import mutter
74
from bzrlib.tests import TestUtil
75
from bzrlib.tests.TestUtil import (
79
from bzrlib.tests.treeshape import build_tree_contents
80
import bzrlib.urlutils as urlutils
81
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
83
default_transport = LocalRelpathServer
32
85
MODULES_TO_TEST = []
33
MODULES_TO_DOCTEST = []
35
from logging import debug, warning, error
86
MODULES_TO_DOCTEST = [
88
bzrlib.bundle.serializer,
101
def packages_to_test():
102
"""Return a list of packages to test.
104
The packages are not globally imported so that import failures are
105
triggered when running selftest, not when importing the command.
108
import bzrlib.tests.blackbox
109
import bzrlib.tests.branch_implementations
110
import bzrlib.tests.bzrdir_implementations
111
import bzrlib.tests.interrepository_implementations
112
import bzrlib.tests.interversionedfile_implementations
113
import bzrlib.tests.intertree_implementations
114
import bzrlib.tests.repository_implementations
115
import bzrlib.tests.revisionstore_implementations
116
import bzrlib.tests.tree_implementations
117
import bzrlib.tests.workingtree_implementations
120
bzrlib.tests.blackbox,
121
bzrlib.tests.branch_implementations,
122
bzrlib.tests.bzrdir_implementations,
123
bzrlib.tests.interrepository_implementations,
124
bzrlib.tests.interversionedfile_implementations,
125
bzrlib.tests.intertree_implementations,
126
bzrlib.tests.repository_implementations,
127
bzrlib.tests.revisionstore_implementations,
128
bzrlib.tests.tree_implementations,
129
bzrlib.tests.workingtree_implementations,
133
class _MyResult(unittest._TextTestResult):
134
"""Custom TestResult.
136
Shows output in a different format, including displaying runtime for tests.
140
def __init__(self, stream, descriptions, verbosity, pb=None,
142
"""Construct new TestResult.
144
:param bench_history: Optionally, a writable file object to accumulate
147
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
149
if bench_history is not None:
150
from bzrlib.version import _get_bzr_source_tree
151
src_tree = _get_bzr_source_tree()
153
revision_id = src_tree.last_revision()
155
# XXX: If there's no branch, what should we do?
157
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
158
self._bench_history = bench_history
160
def extractBenchmarkTime(self, testCase):
161
"""Add a benchmark time for the current test case."""
162
self._benchmarkTime = getattr(testCase, "_benchtime", None)
164
def _elapsedTestTimeString(self):
165
"""Return a time string for the overall time the current test has taken."""
166
return self._formatTime(time.time() - self._start_time)
168
def _testTimeString(self):
169
if self._benchmarkTime is not None:
171
self._formatTime(self._benchmarkTime),
172
self._elapsedTestTimeString())
174
return " %s" % self._elapsedTestTimeString()
176
def _formatTime(self, seconds):
177
"""Format seconds as milliseconds with leading spaces."""
178
return "%5dms" % (1000 * seconds)
180
def _ellipsise_unimportant_words(self, a_string, final_width,
182
"""Add ellipses (sp?) for overly long strings.
184
:param keep_start: If true preserve the start of a_string rather
188
if len(a_string) > final_width:
189
result = a_string[:final_width-3] + '...'
193
if len(a_string) > final_width:
194
result = '...' + a_string[3-final_width:]
197
return result.ljust(final_width)
199
def startTest(self, test):
200
unittest.TestResult.startTest(self, test)
201
# In a short description, the important words are in
202
# the beginning, but in an id, the important words are
204
SHOW_DESCRIPTIONS = False
206
if not self.showAll and self.dots and self.pb is not None:
209
final_width = osutils.terminal_width()
210
final_width = final_width - 15 - 8
212
if SHOW_DESCRIPTIONS:
213
what = test.shortDescription()
215
what = self._ellipsise_unimportant_words(what, final_width, keep_start=True)
218
if what.startswith('bzrlib.tests.'):
220
what = self._ellipsise_unimportant_words(what, final_width)
222
self.stream.write(what)
223
elif self.dots and self.pb is not None:
224
self.pb.update(what, self.testsRun - 1, None)
226
self._recordTestStartTime()
228
def _recordTestStartTime(self):
229
"""Record that a test has started."""
230
self._start_time = time.time()
232
def addError(self, test, err):
233
if isinstance(err[1], TestSkipped):
234
return self.addSkipped(test, err)
235
unittest.TestResult.addError(self, test, err)
236
self.extractBenchmarkTime(test)
238
self.stream.writeln("ERROR %s" % self._testTimeString())
239
elif self.dots and self.pb is None:
240
self.stream.write('E')
242
self.pb.update(self._ellipsise_unimportant_words('ERROR', 13), self.testsRun, None)
243
self.pb.note(self._ellipsise_unimportant_words(
244
test.id() + ': ERROR',
245
osutils.terminal_width()))
250
def addFailure(self, test, err):
251
unittest.TestResult.addFailure(self, test, err)
252
self.extractBenchmarkTime(test)
254
self.stream.writeln(" FAIL %s" % self._testTimeString())
255
elif self.dots and self.pb is None:
256
self.stream.write('F')
258
self.pb.update(self._ellipsise_unimportant_words('FAIL', 13), self.testsRun, None)
259
self.pb.note(self._ellipsise_unimportant_words(
260
test.id() + ': FAIL',
261
osutils.terminal_width()))
266
def addSuccess(self, test):
267
self.extractBenchmarkTime(test)
268
if self._bench_history is not None:
269
if self._benchmarkTime is not None:
270
self._bench_history.write("%s %s\n" % (
271
self._formatTime(self._benchmarkTime),
274
self.stream.writeln(' OK %s' % self._testTimeString())
275
for bench_called, stats in getattr(test, '_benchcalls', []):
276
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
277
stats.pprint(file=self.stream)
278
elif self.dots and self.pb is None:
279
self.stream.write('~')
281
self.pb.update(self._ellipsise_unimportant_words('OK', 13), self.testsRun, None)
283
unittest.TestResult.addSuccess(self, test)
285
def addSkipped(self, test, skip_excinfo):
286
self.extractBenchmarkTime(test)
288
print >>self.stream, ' SKIP %s' % self._testTimeString()
289
print >>self.stream, ' %s' % skip_excinfo[1]
290
elif self.dots and self.pb is None:
291
self.stream.write('S')
293
self.pb.update(self._ellipsise_unimportant_words('SKIP', 13), self.testsRun, None)
295
# seems best to treat this as success from point-of-view of unittest
296
# -- it actually does nothing so it barely matters :)
299
except KeyboardInterrupt:
302
self.addError(test, test.__exc_info())
304
unittest.TestResult.addSuccess(self, test)
306
def printErrorList(self, flavour, errors):
307
for test, err in errors:
308
self.stream.writeln(self.separator1)
309
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
310
if getattr(test, '_get_log', None) is not None:
312
print >>self.stream, \
313
('vvvv[log from %s]' % test.id()).ljust(78,'-')
314
print >>self.stream, test._get_log()
315
print >>self.stream, \
316
('^^^^[log from %s]' % test.id()).ljust(78,'-')
317
self.stream.writeln(self.separator2)
318
self.stream.writeln("%s" % err)
321
class TextTestRunner(object):
322
stop_on_failure = False
331
self.stream = unittest._WritelnDecorator(stream)
332
self.descriptions = descriptions
333
self.verbosity = verbosity
334
self.keep_output = keep_output
336
self._bench_history = bench_history
338
def _makeResult(self):
339
result = _MyResult(self.stream,
343
bench_history=self._bench_history)
344
result.stop_early = self.stop_on_failure
348
"Run the given test case or test suite."
349
result = self._makeResult()
350
startTime = time.time()
351
if self.pb is not None:
352
self.pb.update('Running tests', 0, test.countTestCases())
354
stopTime = time.time()
355
timeTaken = stopTime - startTime
357
self.stream.writeln(result.separator2)
358
run = result.testsRun
359
self.stream.writeln("Ran %d test%s in %.3fs" %
360
(run, run != 1 and "s" or "", timeTaken))
361
self.stream.writeln()
362
if not result.wasSuccessful():
363
self.stream.write("FAILED (")
364
failed, errored = map(len, (result.failures, result.errors))
366
self.stream.write("failures=%d" % failed)
368
if failed: self.stream.write(", ")
369
self.stream.write("errors=%d" % errored)
370
self.stream.writeln(")")
372
self.stream.writeln("OK")
373
if self.pb is not None:
374
self.pb.update('Cleaning up', 0, 1)
375
# This is still a little bogus,
376
# but only a little. Folk not using our testrunner will
377
# have to delete their temp directories themselves.
378
test_root = TestCaseInTempDir.TEST_ROOT
379
if result.wasSuccessful() or not self.keep_output:
380
if test_root is not None:
381
# If LANG=C we probably have created some bogus paths
382
# which rmtree(unicode) will fail to delete
383
# so make sure we are using rmtree(str) to delete everything
384
# except on win32, where rmtree(str) will fail
385
# since it doesn't have the property of byte-stream paths
386
# (they are either ascii or mbcs)
387
if sys.platform == 'win32':
388
# make sure we are using the unicode win32 api
389
test_root = unicode(test_root)
391
test_root = test_root.encode(
392
sys.getfilesystemencoding())
393
osutils.rmtree(test_root)
395
if self.pb is not None:
396
self.pb.note("Failed tests working directories are in '%s'\n",
400
"Failed tests working directories are in '%s'\n" %
402
TestCaseInTempDir.TEST_ROOT = None
403
if self.pb is not None:
408
def iter_suite_tests(suite):
409
"""Return all tests in a suite, recursing through nested suites"""
410
for item in suite._tests:
411
if isinstance(item, unittest.TestCase):
413
elif isinstance(item, unittest.TestSuite):
414
for r in iter_suite_tests(item):
417
raise Exception('unknown object %r inside test suite %r'
421
class TestSkipped(Exception):
422
"""Indicates that a test was intentionally skipped, rather than failing."""
37
425
class CommandFailed(Exception):
429
class StringIOWrapper(object):
430
"""A wrapper around cStringIO which just adds an encoding attribute.
432
Internally we can check sys.stdout to see what the output encoding
433
should be. However, cStringIO has no encoding attribute that we can
434
set. So we wrap it instead.
439
def __init__(self, s=None):
441
self.__dict__['_cstring'] = StringIO(s)
443
self.__dict__['_cstring'] = StringIO()
445
def __getattr__(self, name, getattr=getattr):
446
return getattr(self.__dict__['_cstring'], name)
448
def __setattr__(self, name, val):
449
if name == 'encoding':
450
self.__dict__['encoding'] = val
452
return setattr(self._cstring, name, val)
40
455
class TestCase(unittest.TestCase):
41
456
"""Base class for bzr unit tests.
46
461
Error and debug log messages are redirected from their usual
47
462
location into a temporary file, the contents of which can be
48
retrieved by _get_log().
463
retrieved by _get_log(). We use a real OS file, not an in-memory object,
464
so that it can also capture file IO. When the test completes this file
465
is read into memory and removed from disk.
50
467
There are also convenience functions to invoke bzr's command-line
51
routine, and to build and check bzr trees."""
468
routine, and to build and check bzr trees.
470
In addition to the usual method of overriding tearDown(), this class also
471
allows subclasses to register functions into the _cleanups list, which is
472
run in order as the object is torn down. It's less likely this will be
473
accidentally overlooked.
476
_log_file_name = None
478
# record lsprof data when performing benchmark calls.
479
_gather_lsprof_in_benchmarks = False
481
def __init__(self, methodName='testMethod'):
482
super(TestCase, self).__init__(methodName)
56
# this replaces the default testsweet.TestCase; we don't want logging changed
57
486
unittest.TestCase.setUp(self)
487
self._cleanEnvironment()
58
488
bzrlib.trace.disable_default_logging()
59
self._enable_file_logging()
62
def _enable_file_logging(self):
490
self._benchcalls = []
491
self._benchtime = None
493
def _ndiff_strings(self, a, b):
494
"""Return ndiff between two strings containing lines.
496
A trailing newline is added if missing to make the strings
498
if b and b[-1] != '\n':
500
if a and a[-1] != '\n':
502
difflines = difflib.ndiff(a.splitlines(True),
504
linejunk=lambda x: False,
505
charjunk=lambda x: False)
506
return ''.join(difflines)
508
def assertEqualDiff(self, a, b, message=None):
509
"""Assert two texts are equal, if not raise an exception.
511
This is intended for use with multi-line strings where it can
512
be hard to find the differences by eye.
514
# TODO: perhaps override assertEquals to call this for strings?
518
message = "texts not equal:\n"
519
raise AssertionError(message +
520
self._ndiff_strings(a, b))
522
def assertEqualMode(self, mode, mode_test):
523
self.assertEqual(mode, mode_test,
524
'mode mismatch %o != %o' % (mode, mode_test))
526
def assertStartsWith(self, s, prefix):
527
if not s.startswith(prefix):
528
raise AssertionError('string %r does not start with %r' % (s, prefix))
530
def assertEndsWith(self, s, suffix):
531
"""Asserts that s ends with suffix."""
532
if not s.endswith(suffix):
533
raise AssertionError('string %r does not end with %r' % (s, suffix))
535
def assertContainsRe(self, haystack, needle_re):
536
"""Assert that a contains something matching a regular expression."""
537
if not re.search(needle_re, haystack):
538
raise AssertionError('pattern "%s" not found in "%s"'
539
% (needle_re, haystack))
541
def assertNotContainsRe(self, haystack, needle_re):
542
"""Assert that a does not match a regular expression"""
543
if re.search(needle_re, haystack):
544
raise AssertionError('pattern "%s" found in "%s"'
545
% (needle_re, haystack))
547
def assertSubset(self, sublist, superlist):
548
"""Assert that every entry in sublist is present in superlist."""
550
for entry in sublist:
551
if entry not in superlist:
552
missing.append(entry)
554
raise AssertionError("value(s) %r not present in container %r" %
555
(missing, superlist))
557
def assertIs(self, left, right):
558
if not (left is right):
559
raise AssertionError("%r is not %r." % (left, right))
561
def assertTransportMode(self, transport, path, mode):
562
"""Fail if a path does not have mode mode.
564
If modes are not supported on this transport, the assertion is ignored.
566
if not transport._can_roundtrip_unix_modebits():
568
path_stat = transport.stat(path)
569
actual_mode = stat.S_IMODE(path_stat.st_mode)
570
self.assertEqual(mode, actual_mode,
571
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
573
def assertIsInstance(self, obj, kls):
574
"""Fail if obj is not an instance of kls"""
575
if not isinstance(obj, kls):
576
self.fail("%r is an instance of %s rather than %s" % (
577
obj, obj.__class__, kls))
579
def _startLogFile(self):
580
"""Send bzr and test log messages to a temporary file.
582
The file is removed as the test is torn down.
63
584
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
65
self._log_file = os.fdopen(fileno, 'w+')
67
hdlr = logging.StreamHandler(self._log_file)
68
hdlr.setLevel(logging.DEBUG)
69
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
70
logging.getLogger('').addHandler(hdlr)
71
logging.getLogger('').setLevel(logging.DEBUG)
73
debug('opened log file %s', name)
585
encoder, decoder, stream_reader, stream_writer = codecs.lookup('UTF-8')
586
self._log_file = stream_writer(os.fdopen(fileno, 'w+'))
587
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
75
588
self._log_file_name = name
79
logging.getLogger('').removeHandler(self._log_hdlr)
80
bzrlib.trace.enable_default_logging()
81
logging.debug('%s teardown', self.id())
589
self.addCleanup(self._finishLogFile)
591
def _finishLogFile(self):
592
"""Finished with the log file.
594
Read contents into memory, close, and delete.
596
if self._log_file is None:
598
bzrlib.trace.disable_test_log(self._log_nonce)
599
self._log_file.seek(0)
600
self._log_contents = self._log_file.read()
82
601
self._log_file.close()
602
os.remove(self._log_file_name)
603
self._log_file = self._log_file_name = None
605
def addCleanup(self, callable):
606
"""Arrange to run a callable when this case is torn down.
608
Callables are run in the reverse of the order they are registered,
609
ie last-in first-out.
611
if callable in self._cleanups:
612
raise ValueError("cleanup function %r already registered on %s"
614
self._cleanups.append(callable)
616
def _cleanEnvironment(self):
619
'APPDATA': os.getcwd(),
621
'BZREMAIL': None, # may still be present in the environment
625
self.addCleanup(self._restoreEnvironment)
626
for name, value in new_env.iteritems():
627
self._captureVar(name, value)
630
def _captureVar(self, name, newvalue):
631
"""Set an environment variable, preparing it to be reset when finished."""
632
self.__old_env[name] = os.environ.get(name, None)
634
if name in os.environ:
637
os.environ[name] = newvalue
640
def _restoreVar(name, value):
642
if name in os.environ:
645
os.environ[name] = value
647
def _restoreEnvironment(self):
648
for name, value in self.__old_env.iteritems():
649
self._restoreVar(name, value)
83
653
unittest.TestCase.tearDown(self)
655
def time(self, callable, *args, **kwargs):
656
"""Run callable and accrue the time it takes to the benchmark time.
658
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
659
this will cause lsprofile statistics to be gathered and stored in
662
if self._benchtime is None:
666
if not self._gather_lsprof_in_benchmarks:
667
return callable(*args, **kwargs)
669
# record this benchmark
670
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
672
self._benchcalls.append(((callable, args, kwargs), stats))
675
self._benchtime += time.time() - start
677
def _runCleanups(self):
678
"""Run registered cleanup functions.
680
This should only be called from TestCase.tearDown.
682
# TODO: Perhaps this should keep running cleanups even if
684
for cleanup_fn in reversed(self._cleanups):
86
687
def log(self, *args):
89
690
def _get_log(self):
90
691
"""Return as a string the log for this test"""
91
return open(self._log_file_name).read()
692
if self._log_file_name:
693
return open(self._log_file_name).read()
695
return self._log_contents
696
# TODO: Delete the log after it's been read in
698
def capture(self, cmd, retcode=0):
699
"""Shortcut that splits cmd into words, runs, and returns stdout"""
700
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
702
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None):
703
"""Invoke bzr and return (stdout, stderr).
705
Useful for code that wants to check the contents of the
706
output, the way error messages are presented, etc.
708
This should be the main method for tests that want to exercise the
709
overall behavior of the bzr application (rather than a unit test
710
or a functional test of the library.)
712
Much of the old code runs bzr by forking a new copy of Python, but
713
that is slower, harder to debug, and generally not necessary.
715
This runs bzr through the interface that catches and reports
716
errors, and with logging set to something approximating the
717
default, so that error reporting can be checked.
719
:param argv: arguments to invoke bzr
720
:param retcode: expected return code, or None for don't-care.
721
:param encoding: encoding for sys.stdout and sys.stderr
722
:param stdin: A string to be used as stdin for the command.
725
encoding = bzrlib.user_encoding
726
if stdin is not None:
727
stdin = StringIO(stdin)
728
stdout = StringIOWrapper()
729
stderr = StringIOWrapper()
730
stdout.encoding = encoding
731
stderr.encoding = encoding
733
self.log('run bzr: %r', argv)
734
# FIXME: don't call into logging here
735
handler = logging.StreamHandler(stderr)
736
handler.setLevel(logging.INFO)
737
logger = logging.getLogger('')
738
logger.addHandler(handler)
739
old_ui_factory = bzrlib.ui.ui_factory
740
bzrlib.ui.ui_factory = bzrlib.tests.blackbox.TestUIFactory(
743
bzrlib.ui.ui_factory.stdin = stdin
745
result = self.apply_redirected(stdin, stdout, stderr,
746
bzrlib.commands.run_bzr_catch_errors,
749
logger.removeHandler(handler)
750
bzrlib.ui.ui_factory = old_ui_factory
752
out = stdout.getvalue()
753
err = stderr.getvalue()
755
self.log('output:\n%r', out)
757
self.log('errors:\n%r', err)
758
if retcode is not None:
759
self.assertEquals(retcode, result)
93
762
def run_bzr(self, *args, **kwargs):
94
763
"""Invoke bzr, as if it were run from the command line.
181
931
if contents != expect:
182
932
self.log("expected: %r" % expect)
183
933
self.log("actually: %r" % contents)
184
self.fail("contents of %s not as expected")
934
self.fail("contents of %s not as expected" % filename)
186
936
def _make_test_root(self):
191
937
if TestCaseInTempDir.TEST_ROOT is not None:
193
TestCaseInTempDir.TEST_ROOT = os.path.abspath(
194
tempfile.mkdtemp(suffix='.tmp',
195
prefix=self._TEST_NAME + '-',
941
root = u'test%04d.tmp' % i
945
if e.errno == errno.EEXIST:
950
# successfully created
951
TestCaseInTempDir.TEST_ROOT = osutils.abspath(root)
198
953
# make a fake bzr directory there to prevent any tests propagating
199
954
# up onto the source directory's real branch
200
os.mkdir(os.path.join(TestCaseInTempDir.TEST_ROOT, '.bzr'))
955
bzrdir.BzrDir.create_standalone_workingtree(TestCaseInTempDir.TEST_ROOT)
203
958
super(TestCaseInTempDir, self).setUp()
205
959
self._make_test_root()
206
self._currentdir = os.getcwdu()
207
short_id = self.id().replace('bzrlib.selftest.', '')
208
self.test_dir = os.path.join(self.TEST_ROOT, short_id)
209
os.mkdir(self.test_dir)
210
os.chdir(self.test_dir)
960
_currentdir = os.getcwdu()
961
# shorten the name, to avoid test failures due to path length
962
short_id = self.id().replace('bzrlib.tests.', '') \
963
.replace('__main__.', '')[-100:]
964
# it's possible the same test class is run several times for
965
# parameterized tests, so make sure the names don't collide.
969
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
971
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
972
if os.path.exists(candidate_dir):
976
self.test_dir = candidate_dir
977
os.mkdir(self.test_dir)
978
os.chdir(self.test_dir)
980
os.environ['HOME'] = self.test_dir
981
os.environ['APPDATA'] = self.test_dir
982
def _leaveDirectory():
983
os.chdir(_currentdir)
984
self.addCleanup(_leaveDirectory)
214
os.chdir(self._currentdir)
215
super(TestCaseInTempDir, self).tearDown()
217
def _formcmd(self, cmd):
218
if isinstance(cmd, basestring):
221
cmd[0] = self.BZRPATH
222
if self.OVERRIDE_PYTHON:
223
cmd.insert(0, self.OVERRIDE_PYTHON)
224
self.log('$ %r' % cmd)
227
def runcmd(self, cmd, retcode=0):
228
"""Run one command and check the return code.
230
Returns a tuple of (stdout,stderr) strings.
232
If a single string is based, it is split into words.
233
For commands that are not simple space-separated words, please
234
pass a list instead."""
235
cmd = self._formcmd(cmd)
236
self.log('$ ' + ' '.join(cmd))
237
actual_retcode = subprocess.call(cmd, stdout=self._log_file,
238
stderr=self._log_file)
239
if retcode != actual_retcode:
240
raise CommandFailed("test failed: %r returned %d, expected %d"
241
% (cmd, actual_retcode, retcode))
243
def backtick(self, cmd, retcode=0):
244
"""Run a command and return its output"""
245
cmd = self._formcmd(cmd)
246
child = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=self._log_file)
247
outd, errd = child.communicate()
249
actual_retcode = child.wait()
251
outd = outd.replace('\r', '')
253
if retcode != actual_retcode:
254
raise CommandFailed("test failed: %r returned %d, expected %d"
255
% (cmd, actual_retcode, retcode))
261
def build_tree(self, shape):
986
def build_tree(self, shape, line_endings='native', transport=None):
262
987
"""Build a test tree according to a pattern.
264
989
shape is a sequence of file specifications. If the final
265
990
character is '/', a directory is created.
992
This assumes that all the elements in the tree being built are new.
267
994
This doesn't add anything to a branch.
995
:param line_endings: Either 'binary' or 'native'
996
in binary mode, exact contents are written
997
in native mode, the line endings match the
998
default platform endings.
1000
:param transport: A transport to write to, for building trees on
1001
VFS's. If the transport is readonly or None,
1002
"." is opened automatically.
269
# XXX: It's OK to just create them using forward slashes on windows?
1004
# It's OK to just create them using forward slashes on windows.
1005
if transport is None or transport.is_readonly():
1006
transport = get_transport(".")
271
1007
for name in shape:
272
assert isinstance(name, basestring)
1008
self.assert_(isinstance(name, basestring))
273
1009
if name[-1] == '/':
277
print >>f, "contents of", name
282
class MetaTestLog(TestCase):
283
def test_logging(self):
284
"""Test logs are captured when a test fails."""
285
logging.info('an info message')
286
warning('something looks dodgy...')
287
logging.debug('hello, test is running')
291
def selftest(verbose=False, pattern=".*"):
1010
transport.mkdir(urlutils.escape(name[:-1]))
1012
if line_endings == 'binary':
1014
elif line_endings == 'native':
1017
raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
1018
content = "contents of %s%s" % (name.encode('utf-8'), end)
1019
# Technically 'put()' is the right command. However, put
1020
# uses an AtomicFile, which requires an extra rename into place
1021
# As long as the files didn't exist in the past, append() will
1022
# do the same thing as put()
1023
# On jam's machine, make_kernel_like_tree is:
1024
# put: 4.5-7.5s (averaging 6s)
1026
transport.append(urlutils.escape(name), StringIO(content))
1028
def build_tree_contents(self, shape):
1029
build_tree_contents(shape)
1031
def failUnlessExists(self, path):
1032
"""Fail unless path, which may be abs or relative, exists."""
1033
self.failUnless(osutils.lexists(path))
1035
def failIfExists(self, path):
1036
"""Fail if path, which may be abs or relative, exists."""
1037
self.failIf(osutils.lexists(path))
1039
def assertFileEqual(self, content, path):
1040
"""Fail if path does not contain 'content'."""
1041
self.failUnless(osutils.lexists(path))
1042
# TODO: jam 20060427 Shouldn't this be 'rb'?
1043
self.assertEqualDiff(content, open(path, 'r').read())
1046
class TestCaseWithTransport(TestCaseInTempDir):
1047
"""A test case that provides get_url and get_readonly_url facilities.
1049
These back onto two transport servers, one for readonly access and one for
1052
If no explicit class is provided for readonly access, a
1053
ReadonlyTransportDecorator is used instead which allows the use of non disk
1054
based read write transports.
1056
If an explicit class is provided for readonly access, that server and the
1057
readwrite one must both define get_url() as resolving to os.getcwd().
1060
def __init__(self, methodName='testMethod'):
1061
super(TestCaseWithTransport, self).__init__(methodName)
1062
self.__readonly_server = None
1063
self.__server = None
1064
self.transport_server = default_transport
1065
self.transport_readonly_server = None
1067
def get_readonly_url(self, relpath=None):
1068
"""Get a URL for the readonly transport.
1070
This will either be backed by '.' or a decorator to the transport
1071
used by self.get_url()
1072
relpath provides for clients to get a path relative to the base url.
1073
These should only be downwards relative, not upwards.
1075
base = self.get_readonly_server().get_url()
1076
if relpath is not None:
1077
if not base.endswith('/'):
1079
base = base + relpath
1082
def get_readonly_server(self):
1083
"""Get the server instance for the readonly transport
1085
This is useful for some tests with specific servers to do diagnostics.
1087
if self.__readonly_server is None:
1088
if self.transport_readonly_server is None:
1089
# readonly decorator requested
1090
# bring up the server
1092
self.__readonly_server = ReadonlyServer()
1093
self.__readonly_server.setUp(self.__server)
1095
self.__readonly_server = self.transport_readonly_server()
1096
self.__readonly_server.setUp()
1097
self.addCleanup(self.__readonly_server.tearDown)
1098
return self.__readonly_server
1100
def get_server(self):
1101
"""Get the read/write server instance.
1103
This is useful for some tests with specific servers that need
1106
if self.__server is None:
1107
self.__server = self.transport_server()
1108
self.__server.setUp()
1109
self.addCleanup(self.__server.tearDown)
1110
return self.__server
1112
def get_url(self, relpath=None):
1113
"""Get a URL for the readwrite transport.
1115
This will either be backed by '.' or to an equivalent non-file based
1117
relpath provides for clients to get a path relative to the base url.
1118
These should only be downwards relative, not upwards.
1120
base = self.get_server().get_url()
1121
if relpath is not None and relpath != '.':
1122
if not base.endswith('/'):
1124
base = base + urlutils.escape(relpath)
1127
def get_transport(self):
1128
"""Return a writeable transport for the test scratch space"""
1129
t = get_transport(self.get_url())
1130
self.assertFalse(t.is_readonly())
1133
def get_readonly_transport(self):
1134
"""Return a readonly transport for the test scratch space
1136
This can be used to test that operations which should only need
1137
readonly access in fact do not try to write.
1139
t = get_transport(self.get_readonly_url())
1140
self.assertTrue(t.is_readonly())
1143
def make_branch(self, relpath, format=None):
1144
"""Create a branch on the transport at relpath."""
1145
repo = self.make_repository(relpath, format=format)
1146
return repo.bzrdir.create_branch()
1148
def make_bzrdir(self, relpath, format=None):
1150
url = self.get_url(relpath)
1151
mutter('relpath %r => url %r', relpath, url)
1152
segments = url.split('/')
1153
if segments and segments[-1] not in ('', '.'):
1154
parent = '/'.join(segments[:-1])
1155
t = get_transport(parent)
1157
t.mkdir(segments[-1])
1158
except errors.FileExists:
1161
format=bzrlib.bzrdir.BzrDirFormat.get_default_format()
1162
# FIXME: make this use a single transport someday. RBC 20060418
1163
return format.initialize_on_transport(get_transport(relpath))
1164
except errors.UninitializableFormat:
1165
raise TestSkipped("Format %s is not initializable." % format)
1167
def make_repository(self, relpath, shared=False, format=None):
1168
"""Create a repository on our default transport at relpath."""
1169
made_control = self.make_bzrdir(relpath, format=format)
1170
return made_control.create_repository(shared=shared)
1172
def make_branch_and_tree(self, relpath, format=None):
1173
"""Create a branch on the transport and a tree locally.
1177
# TODO: always use the local disk path for the working tree,
1178
# this obviously requires a format that supports branch references
1179
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1181
b = self.make_branch(relpath, format=format)
1183
return b.bzrdir.create_workingtree()
1184
except errors.NotLocalUrl:
1185
# new formats - catch No tree error and create
1186
# a branch reference and a checkout.
1187
# old formats at that point - raise TestSkipped.
1188
# TODO: rbc 20060208
1189
return WorkingTreeFormat2().initialize(bzrdir.BzrDir.open(relpath))
1191
def assertIsDirectory(self, relpath, transport):
1192
"""Assert that relpath within transport is a directory.
1194
This may not be possible on all transports; in that case it propagates
1195
a TransportNotPossible.
1198
mode = transport.stat(relpath).st_mode
1199
except errors.NoSuchFile:
1200
self.fail("path %s is not a directory; no such file"
1202
if not stat.S_ISDIR(mode):
1203
self.fail("path %s is not a directory; has mode %#o"
1207
class ChrootedTestCase(TestCaseWithTransport):
1208
"""A support class that provides readonly urls outside the local namespace.
1210
This is done by checking if self.transport_server is a MemoryServer. if it
1211
is then we are chrooted already, if it is not then an HttpServer is used
1214
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1215
be used without needed to redo it when a different
1216
subclass is in use ?
1220
super(ChrootedTestCase, self).setUp()
1221
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
1222
self.transport_readonly_server = bzrlib.transport.http.HttpServer
1225
def filter_suite_by_re(suite, pattern):
1226
result = TestUtil.TestSuite()
1227
filter_re = re.compile(pattern)
1228
for test in iter_suite_tests(suite):
1229
if filter_re.search(test.id()):
1230
result.addTest(test)
1234
def run_suite(suite, name='test', verbose=False, pattern=".*",
1235
stop_on_failure=False, keep_output=False,
1236
transport=None, lsprof_timed=None, bench_history=None):
1237
TestCaseInTempDir._TEST_NAME = name
1238
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1244
pb = progress.ProgressBar()
1245
runner = TextTestRunner(stream=sys.stdout,
1247
verbosity=verbosity,
1248
keep_output=keep_output,
1250
bench_history=bench_history)
1251
runner.stop_on_failure=stop_on_failure
1253
suite = filter_suite_by_re(suite, pattern)
1254
result = runner.run(suite)
1255
return result.wasSuccessful()
1258
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1261
test_suite_factory=None,
1263
bench_history=None):
292
1264
"""Run the whole test suite under the enhanced runner"""
293
return run_suite(test_suite(), 'testbzr', verbose=verbose, pattern=pattern)
1265
# XXX: Very ugly way to do this...
1266
# Disable warning about old formats because we don't want it to disturb
1267
# any blackbox tests.
1268
from bzrlib import repository
1269
repository._deprecation_warning_done = True
1271
global default_transport
1272
if transport is None:
1273
transport = default_transport
1274
old_transport = default_transport
1275
default_transport = transport
1277
if test_suite_factory is None:
1278
suite = test_suite()
1280
suite = test_suite_factory()
1281
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1282
stop_on_failure=stop_on_failure, keep_output=keep_output,
1283
transport=transport,
1284
lsprof_timed=lsprof_timed,
1285
bench_history=bench_history)
1287
default_transport = old_transport
296
1290
def test_suite():
297
"""Build and return TestSuite for the whole program."""
298
from bzrlib.selftest.TestUtil import TestLoader, TestSuite
299
import bzrlib, bzrlib.store, bzrlib.inventory, bzrlib.branch
300
import bzrlib.osutils, bzrlib.commands, bzrlib.merge3, bzrlib.plugin
301
from doctest import DocTestSuite
307
global MODULES_TO_TEST, MODULES_TO_DOCTEST
310
['bzrlib.selftest.MetaTestLog',
311
'bzrlib.selftest.testinv',
312
'bzrlib.selftest.versioning',
313
'bzrlib.selftest.testmerge3',
314
'bzrlib.selftest.testhashcache',
315
'bzrlib.selftest.teststatus',
316
'bzrlib.selftest.testlog',
317
'bzrlib.selftest.testrevisionnamespaces',
318
'bzrlib.selftest.testbranch',
319
'bzrlib.selftest.testrevision',
320
'bzrlib.selftest.test_merge_core',
321
'bzrlib.selftest.test_smart_add',
322
'bzrlib.selftest.testdiff',
323
'bzrlib.selftest.test_parent',
324
'bzrlib.selftest.test_xml',
325
'bzrlib.selftest.testfetch',
326
'bzrlib.selftest.whitebox',
327
'bzrlib.selftest.teststore',
328
'bzrlib.selftest.blackbox',
1291
"""Build and return TestSuite for the whole of bzrlib.
1293
This function can be replaced if you need to change the default test
1294
suite on a global basis, but it is not encouraged.
1297
'bzrlib.tests.test_ancestry',
1298
'bzrlib.tests.test_api',
1299
'bzrlib.tests.test_atomicfile',
1300
'bzrlib.tests.test_bad_files',
1301
'bzrlib.tests.test_branch',
1302
'bzrlib.tests.test_bundle',
1303
'bzrlib.tests.test_bzrdir',
1304
'bzrlib.tests.test_cache_utf8',
1305
'bzrlib.tests.test_command',
1306
'bzrlib.tests.test_commit',
1307
'bzrlib.tests.test_commit_merge',
1308
'bzrlib.tests.test_config',
1309
'bzrlib.tests.test_conflicts',
1310
'bzrlib.tests.test_decorators',
1311
'bzrlib.tests.test_diff',
1312
'bzrlib.tests.test_doc_generate',
1313
'bzrlib.tests.test_errors',
1314
'bzrlib.tests.test_escaped_store',
1315
'bzrlib.tests.test_fetch',
1316
'bzrlib.tests.test_gpg',
1317
'bzrlib.tests.test_graph',
1318
'bzrlib.tests.test_hashcache',
1319
'bzrlib.tests.test_http',
1320
'bzrlib.tests.test_http_response',
1321
'bzrlib.tests.test_identitymap',
1322
'bzrlib.tests.test_ignores',
1323
'bzrlib.tests.test_inv',
1324
'bzrlib.tests.test_knit',
1325
'bzrlib.tests.test_lockdir',
1326
'bzrlib.tests.test_lockable_files',
1327
'bzrlib.tests.test_log',
1328
'bzrlib.tests.test_merge',
1329
'bzrlib.tests.test_merge3',
1330
'bzrlib.tests.test_merge_core',
1331
'bzrlib.tests.test_missing',
1332
'bzrlib.tests.test_msgeditor',
1333
'bzrlib.tests.test_nonascii',
1334
'bzrlib.tests.test_options',
1335
'bzrlib.tests.test_osutils',
1336
'bzrlib.tests.test_patch',
1337
'bzrlib.tests.test_patches',
1338
'bzrlib.tests.test_permissions',
1339
'bzrlib.tests.test_plugins',
1340
'bzrlib.tests.test_progress',
1341
'bzrlib.tests.test_reconcile',
1342
'bzrlib.tests.test_repository',
1343
'bzrlib.tests.test_revision',
1344
'bzrlib.tests.test_revisionnamespaces',
1345
'bzrlib.tests.test_revisiontree',
1346
'bzrlib.tests.test_rio',
1347
'bzrlib.tests.test_sampler',
1348
'bzrlib.tests.test_selftest',
1349
'bzrlib.tests.test_setup',
1350
'bzrlib.tests.test_sftp_transport',
1351
'bzrlib.tests.test_smart_add',
1352
'bzrlib.tests.test_source',
1353
'bzrlib.tests.test_status',
1354
'bzrlib.tests.test_store',
1355
'bzrlib.tests.test_symbol_versioning',
1356
'bzrlib.tests.test_testament',
1357
'bzrlib.tests.test_textfile',
1358
'bzrlib.tests.test_textmerge',
1359
'bzrlib.tests.test_trace',
1360
'bzrlib.tests.test_transactions',
1361
'bzrlib.tests.test_transform',
1362
'bzrlib.tests.test_transport',
1363
'bzrlib.tests.test_tree',
1364
'bzrlib.tests.test_tsort',
1365
'bzrlib.tests.test_tuned_gzip',
1366
'bzrlib.tests.test_ui',
1367
'bzrlib.tests.test_upgrade',
1368
'bzrlib.tests.test_urlutils',
1369
'bzrlib.tests.test_versionedfile',
1370
'bzrlib.tests.test_version',
1371
'bzrlib.tests.test_weave',
1372
'bzrlib.tests.test_whitebox',
1373
'bzrlib.tests.test_workingtree',
1374
'bzrlib.tests.test_xml',
331
for m in (bzrlib.store, bzrlib.inventory, bzrlib.branch,
332
bzrlib.osutils, bzrlib.commands, bzrlib.merge3):
333
if m not in MODULES_TO_DOCTEST:
334
MODULES_TO_DOCTEST.append(m)
336
TestCase.BZRPATH = os.path.join(os.path.realpath(os.path.dirname(bzrlib.__path__[0])), 'bzr')
337
print '%-30s %s' % ('bzr binary', TestCase.BZRPATH)
340
suite.addTest(TestLoader().loadTestsFromNames(testmod_names))
1376
test_transport_implementations = [
1377
'bzrlib.tests.test_transport_implementations',
1378
'bzrlib.tests.test_read_bundle',
1380
suite = TestUtil.TestSuite()
1381
loader = TestUtil.TestLoader()
1382
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1383
from bzrlib.transport import TransportTestProviderAdapter
1384
adapter = TransportTestProviderAdapter()
1385
adapt_modules(test_transport_implementations, adapter, loader, suite)
1386
for package in packages_to_test():
1387
suite.addTest(package.test_suite())
341
1388
for m in MODULES_TO_TEST:
342
suite.addTest(TestLoader().loadTestsFromModule(m))
343
for m in (MODULES_TO_DOCTEST):
344
suite.addTest(DocTestSuite(m))
345
for p in bzrlib.plugin.all_plugins:
346
if hasattr(p, 'test_suite'):
347
suite.addTest(p.test_suite())
1389
suite.addTest(loader.loadTestsFromModule(m))
1390
for m in MODULES_TO_DOCTEST:
1391
suite.addTest(doctest.DocTestSuite(m))
1392
for name, plugin in bzrlib.plugin.all_plugins().items():
1393
if getattr(plugin, 'test_suite', None) is not None:
1394
suite.addTest(plugin.test_suite())
1398
def adapt_modules(mods_list, adapter, loader, suite):
1399
"""Adapt the modules in mods_list using adapter and add to suite."""
1400
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1401
suite.addTests(adapter.adapt(test))
added
removed
bzrlib/tests/__init__.py
