1
# Copyright (C) 2005, 2006 by Canonical Ltd
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.
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.
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
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
44
import bzrlib.bzrdir as bzrdir
45
import bzrlib.commands
46
import bzrlib.bundle.serializer
47
import bzrlib.errors as errors
48
import bzrlib.inventory
49
import bzrlib.iterablefile
54
# lsprof not available
56
from bzrlib.merge import merge_inner
59
import bzrlib.osutils as osutils
61
import bzrlib.progress as progress
62
from bzrlib.revision import common_ancestor
65
from bzrlib.transport import urlescape, get_transport
66
import bzrlib.transport
67
from bzrlib.transport.local import LocalRelpathServer
68
from bzrlib.transport.readonly import ReadonlyServer
69
from bzrlib.trace import mutter
70
from bzrlib.tests.TestUtil import TestLoader, TestSuite
71
from bzrlib.tests.treeshape import build_tree_contents
72
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
74
default_transport = LocalRelpathServer
77
MODULES_TO_DOCTEST = [
79
bzrlib.bundle.serializer,
92
def packages_to_test():
93
"""Return a list of packages to test.
95
The packages are not globally imported so that import failures are
96
triggered when running selftest, not when importing the command.
99
import bzrlib.tests.blackbox
100
import bzrlib.tests.branch_implementations
101
import bzrlib.tests.bzrdir_implementations
102
import bzrlib.tests.interrepository_implementations
103
import bzrlib.tests.interversionedfile_implementations
104
import bzrlib.tests.repository_implementations
105
import bzrlib.tests.revisionstore_implementations
106
import bzrlib.tests.workingtree_implementations
109
bzrlib.tests.blackbox,
110
bzrlib.tests.branch_implementations,
111
bzrlib.tests.bzrdir_implementations,
112
bzrlib.tests.interrepository_implementations,
113
bzrlib.tests.interversionedfile_implementations,
114
bzrlib.tests.repository_implementations,
115
bzrlib.tests.revisionstore_implementations,
116
bzrlib.tests.workingtree_implementations,
120
class _MyResult(unittest._TextTestResult):
121
"""Custom TestResult.
123
Shows output in a different format, including displaying runtime for tests.
127
def __init__(self, stream, descriptions, verbosity, pb=None):
128
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
131
def extractBenchmarkTime(self, testCase):
132
"""Add a benchmark time for the current test case."""
133
self._benchmarkTime = getattr(testCase, "_benchtime", None)
135
def _elapsedTestTimeString(self):
136
"""Return a time string for the overall time the current test has taken."""
137
return self._formatTime(time.time() - self._start_time)
139
def _testTimeString(self):
140
if self._benchmarkTime is not None:
142
self._formatTime(self._benchmarkTime),
143
self._elapsedTestTimeString())
145
return " %s" % self._elapsedTestTimeString()
147
def _formatTime(self, seconds):
148
"""Format seconds as milliseconds with leading spaces."""
149
return "%5dms" % (1000 * seconds)
151
def _ellipsise_unimportant_words(self, a_string, final_width,
153
"""Add ellipses (sp?) for overly long strings.
155
:param keep_start: If true preserve the start of a_string rather
159
if len(a_string) > final_width:
160
result = a_string[:final_width-3] + '...'
164
if len(a_string) > final_width:
165
result = '...' + a_string[3-final_width:]
168
return result.ljust(final_width)
170
def startTest(self, test):
171
unittest.TestResult.startTest(self, test)
172
# In a short description, the important words are in
173
# the beginning, but in an id, the important words are
175
SHOW_DESCRIPTIONS = False
177
if not self.showAll and self.dots and self.pb is not None:
180
final_width = osutils.terminal_width()
181
final_width = final_width - 15 - 8
183
if SHOW_DESCRIPTIONS:
184
what = test.shortDescription()
186
what = self._ellipsise_unimportant_words(what, final_width, keep_start=True)
189
if what.startswith('bzrlib.tests.'):
191
what = self._ellipsise_unimportant_words(what, final_width)
193
self.stream.write(what)
194
elif self.dots and self.pb is not None:
195
self.pb.update(what, self.testsRun - 1, None)
197
self._recordTestStartTime()
199
def _recordTestStartTime(self):
200
"""Record that a test has started."""
201
self._start_time = time.time()
203
def addError(self, test, err):
204
if isinstance(err[1], TestSkipped):
205
return self.addSkipped(test, err)
206
unittest.TestResult.addError(self, test, err)
207
self.extractBenchmarkTime(test)
209
self.stream.writeln("ERROR %s" % self._testTimeString())
210
elif self.dots and self.pb is None:
211
self.stream.write('E')
213
self.pb.update(self._ellipsise_unimportant_words('ERROR', 13), self.testsRun, None)
218
def addFailure(self, test, err):
219
unittest.TestResult.addFailure(self, test, err)
220
self.extractBenchmarkTime(test)
222
self.stream.writeln(" FAIL %s" % self._testTimeString())
223
elif self.dots and self.pb is None:
224
self.stream.write('F')
226
self.pb.update(self._ellipsise_unimportant_words('FAIL', 13), self.testsRun, None)
231
def addSuccess(self, test):
232
self.extractBenchmarkTime(test)
234
self.stream.writeln(' OK %s' % self._testTimeString())
235
for bench_called, stats in getattr(test, '_benchcalls', []):
236
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
237
stats.pprint(file=self.stream)
238
elif self.dots and self.pb is None:
239
self.stream.write('~')
241
self.pb.update(self._ellipsise_unimportant_words('OK', 13), self.testsRun, None)
243
unittest.TestResult.addSuccess(self, test)
245
def addSkipped(self, test, skip_excinfo):
246
self.extractBenchmarkTime(test)
248
print >>self.stream, ' SKIP %s' % self._testTimeString()
249
print >>self.stream, ' %s' % skip_excinfo[1]
250
elif self.dots and self.pb is None:
251
self.stream.write('S')
253
self.pb.update(self._ellipsise_unimportant_words('SKIP', 13), self.testsRun, None)
255
# seems best to treat this as success from point-of-view of unittest
256
# -- it actually does nothing so it barely matters :)
257
unittest.TestResult.addSuccess(self, test)
259
def printErrorList(self, flavour, errors):
260
for test, err in errors:
261
self.stream.writeln(self.separator1)
262
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
263
if getattr(test, '_get_log', None) is not None:
265
print >>self.stream, \
266
('vvvv[log from %s]' % test.id()).ljust(78,'-')
267
print >>self.stream, test._get_log()
268
print >>self.stream, \
269
('^^^^[log from %s]' % test.id()).ljust(78,'-')
270
self.stream.writeln(self.separator2)
271
self.stream.writeln("%s" % err)
274
class TextTestRunner(object):
275
stop_on_failure = False
283
self.stream = unittest._WritelnDecorator(stream)
284
self.descriptions = descriptions
285
self.verbosity = verbosity
286
self.keep_output = keep_output
289
def _makeResult(self):
290
result = _MyResult(self.stream,
294
result.stop_early = self.stop_on_failure
298
"Run the given test case or test suite."
299
result = self._makeResult()
300
startTime = time.time()
301
if self.pb is not None:
302
self.pb.update('Running tests', 0, test.countTestCases())
304
stopTime = time.time()
305
timeTaken = stopTime - startTime
307
self.stream.writeln(result.separator2)
308
run = result.testsRun
309
self.stream.writeln("Ran %d test%s in %.3fs" %
310
(run, run != 1 and "s" or "", timeTaken))
311
self.stream.writeln()
312
if not result.wasSuccessful():
313
self.stream.write("FAILED (")
314
failed, errored = map(len, (result.failures, result.errors))
316
self.stream.write("failures=%d" % failed)
318
if failed: self.stream.write(", ")
319
self.stream.write("errors=%d" % errored)
320
self.stream.writeln(")")
322
self.stream.writeln("OK")
323
if self.pb is not None:
324
self.pb.update('Cleaning up', 0, 1)
325
# This is still a little bogus,
326
# but only a little. Folk not using our testrunner will
327
# have to delete their temp directories themselves.
328
test_root = TestCaseInTempDir.TEST_ROOT
329
if result.wasSuccessful() or not self.keep_output:
330
if test_root is not None:
331
osutils.rmtree(test_root)
333
if self.pb is not None:
334
self.pb.note("Failed tests working directories are in '%s'\n",
338
"Failed tests working directories are in '%s'\n" %
340
TestCaseInTempDir.TEST_ROOT = None
341
if self.pb is not None:
346
def iter_suite_tests(suite):
347
"""Return all tests in a suite, recursing through nested suites"""
348
for item in suite._tests:
349
if isinstance(item, unittest.TestCase):
351
elif isinstance(item, unittest.TestSuite):
352
for r in iter_suite_tests(item):
355
raise Exception('unknown object %r inside test suite %r'
359
class TestSkipped(Exception):
360
"""Indicates that a test was intentionally skipped, rather than failing."""
364
class CommandFailed(Exception):
367
class TestCase(unittest.TestCase):
368
"""Base class for bzr unit tests.
370
Tests that need access to disk resources should subclass
371
TestCaseInTempDir not TestCase.
373
Error and debug log messages are redirected from their usual
374
location into a temporary file, the contents of which can be
375
retrieved by _get_log(). We use a real OS file, not an in-memory object,
376
so that it can also capture file IO. When the test completes this file
377
is read into memory and removed from disk.
379
There are also convenience functions to invoke bzr's command-line
380
routine, and to build and check bzr trees.
382
In addition to the usual method of overriding tearDown(), this class also
383
allows subclasses to register functions into the _cleanups list, which is
384
run in order as the object is torn down. It's less likely this will be
385
accidentally overlooked.
388
_log_file_name = None
390
# record lsprof data when performing benchmark calls.
391
_gather_lsprof_in_benchmarks = False
393
def __init__(self, methodName='testMethod'):
394
super(TestCase, self).__init__(methodName)
398
unittest.TestCase.setUp(self)
399
self._cleanEnvironment()
400
bzrlib.trace.disable_default_logging()
402
self._benchcalls = []
403
self._benchtime = None
405
def _ndiff_strings(self, a, b):
406
"""Return ndiff between two strings containing lines.
408
A trailing newline is added if missing to make the strings
410
if b and b[-1] != '\n':
412
if a and a[-1] != '\n':
414
difflines = difflib.ndiff(a.splitlines(True),
416
linejunk=lambda x: False,
417
charjunk=lambda x: False)
418
return ''.join(difflines)
420
def assertEqualDiff(self, a, b, message=None):
421
"""Assert two texts are equal, if not raise an exception.
423
This is intended for use with multi-line strings where it can
424
be hard to find the differences by eye.
426
# TODO: perhaps override assertEquals to call this for strings?
430
message = "texts not equal:\n"
431
raise AssertionError(message +
432
self._ndiff_strings(a, b))
434
def assertEqualMode(self, mode, mode_test):
435
self.assertEqual(mode, mode_test,
436
'mode mismatch %o != %o' % (mode, mode_test))
438
def assertStartsWith(self, s, prefix):
439
if not s.startswith(prefix):
440
raise AssertionError('string %r does not start with %r' % (s, prefix))
442
def assertEndsWith(self, s, suffix):
443
"""Asserts that s ends with suffix."""
444
if not s.endswith(suffix):
445
raise AssertionError('string %r does not end with %r' % (s, suffix))
447
def assertContainsRe(self, haystack, needle_re):
448
"""Assert that a contains something matching a regular expression."""
449
if not re.search(needle_re, haystack):
450
raise AssertionError('pattern "%s" not found in "%s"'
451
% (needle_re, haystack))
453
def assertSubset(self, sublist, superlist):
454
"""Assert that every entry in sublist is present in superlist."""
456
for entry in sublist:
457
if entry not in superlist:
458
missing.append(entry)
460
raise AssertionError("value(s) %r not present in container %r" %
461
(missing, superlist))
463
def assertIs(self, left, right):
464
if not (left is right):
465
raise AssertionError("%r is not %r." % (left, right))
467
def assertTransportMode(self, transport, path, mode):
468
"""Fail if a path does not have mode mode.
470
If modes are not supported on this transport, the assertion is ignored.
472
if not transport._can_roundtrip_unix_modebits():
474
path_stat = transport.stat(path)
475
actual_mode = stat.S_IMODE(path_stat.st_mode)
476
self.assertEqual(mode, actual_mode,
477
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
479
def assertIsInstance(self, obj, kls):
480
"""Fail if obj is not an instance of kls"""
481
if not isinstance(obj, kls):
482
self.fail("%r is an instance of %s rather than %s" % (
483
obj, obj.__class__, kls))
485
def _startLogFile(self):
486
"""Send bzr and test log messages to a temporary file.
488
The file is removed as the test is torn down.
490
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
491
encoder, decoder, stream_reader, stream_writer = codecs.lookup('UTF-8')
492
self._log_file = stream_writer(os.fdopen(fileno, 'w+'))
493
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
494
self._log_file_name = name
495
self.addCleanup(self._finishLogFile)
497
def _finishLogFile(self):
498
"""Finished with the log file.
500
Read contents into memory, close, and delete.
502
bzrlib.trace.disable_test_log(self._log_nonce)
503
self._log_file.seek(0)
504
self._log_contents = self._log_file.read()
505
self._log_file.close()
506
os.remove(self._log_file_name)
507
self._log_file = self._log_file_name = None
509
def addCleanup(self, callable):
510
"""Arrange to run a callable when this case is torn down.
512
Callables are run in the reverse of the order they are registered,
513
ie last-in first-out.
515
if callable in self._cleanups:
516
raise ValueError("cleanup function %r already registered on %s"
518
self._cleanups.append(callable)
520
def _cleanEnvironment(self):
523
'APPDATA': os.getcwd(),
528
self.addCleanup(self._restoreEnvironment)
529
for name, value in new_env.iteritems():
530
self._captureVar(name, value)
533
def _captureVar(self, name, newvalue):
534
"""Set an environment variable, preparing it to be reset when finished."""
535
self.__old_env[name] = os.environ.get(name, None)
537
if name in os.environ:
540
os.environ[name] = newvalue
543
def _restoreVar(name, value):
545
if name in os.environ:
548
os.environ[name] = value
550
def _restoreEnvironment(self):
551
for name, value in self.__old_env.iteritems():
552
self._restoreVar(name, value)
556
unittest.TestCase.tearDown(self)
558
def time(self, callable, *args, **kwargs):
559
"""Run callable and accrue the time it takes to the benchmark time.
561
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
562
this will cause lsprofile statistics to be gathered and stored in
565
if self._benchtime is None:
569
if not self._gather_lsprof_in_benchmarks:
570
return callable(*args, **kwargs)
572
# record this benchmark
573
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
575
self._benchcalls.append(((callable, args, kwargs), stats))
578
self._benchtime += time.time() - start
580
def _runCleanups(self):
581
"""Run registered cleanup functions.
583
This should only be called from TestCase.tearDown.
585
# TODO: Perhaps this should keep running cleanups even if
587
for cleanup_fn in reversed(self._cleanups):
590
def log(self, *args):
594
"""Return as a string the log for this test"""
595
if self._log_file_name:
596
return open(self._log_file_name).read()
598
return self._log_contents
599
# TODO: Delete the log after it's been read in
601
def capture(self, cmd, retcode=0):
602
"""Shortcut that splits cmd into words, runs, and returns stdout"""
603
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
605
def run_bzr_captured(self, argv, retcode=0, stdin=None):
606
"""Invoke bzr and return (stdout, stderr).
608
Useful for code that wants to check the contents of the
609
output, the way error messages are presented, etc.
611
This should be the main method for tests that want to exercise the
612
overall behavior of the bzr application (rather than a unit test
613
or a functional test of the library.)
615
Much of the old code runs bzr by forking a new copy of Python, but
616
that is slower, harder to debug, and generally not necessary.
618
This runs bzr through the interface that catches and reports
619
errors, and with logging set to something approximating the
620
default, so that error reporting can be checked.
622
argv -- arguments to invoke bzr
623
retcode -- expected return code, or None for don't-care.
624
:param stdin: A string to be used as stdin for the command.
626
if stdin is not None:
627
stdin = StringIO(stdin)
630
self.log('run bzr: %s', ' '.join(argv))
631
# FIXME: don't call into logging here
632
handler = logging.StreamHandler(stderr)
633
handler.setLevel(logging.INFO)
634
logger = logging.getLogger('')
635
logger.addHandler(handler)
636
old_ui_factory = bzrlib.ui.ui_factory
637
bzrlib.ui.ui_factory = bzrlib.tests.blackbox.TestUIFactory(
640
bzrlib.ui.ui_factory.stdin = stdin
642
result = self.apply_redirected(stdin, stdout, stderr,
643
bzrlib.commands.run_bzr_catch_errors,
646
logger.removeHandler(handler)
647
bzrlib.ui.ui_factory = old_ui_factory
648
out = stdout.getvalue()
649
err = stderr.getvalue()
651
self.log('output:\n%s', out)
653
self.log('errors:\n%s', err)
654
if retcode is not None:
655
self.assertEquals(result, retcode)
658
def run_bzr(self, *args, **kwargs):
659
"""Invoke bzr, as if it were run from the command line.
661
This should be the main method for tests that want to exercise the
662
overall behavior of the bzr application (rather than a unit test
663
or a functional test of the library.)
665
This sends the stdout/stderr results into the test's log,
666
where it may be useful for debugging. See also run_captured.
668
:param stdin: A string to be used as stdin for the command.
670
retcode = kwargs.pop('retcode', 0)
671
stdin = kwargs.pop('stdin', None)
672
return self.run_bzr_captured(args, retcode, stdin)
674
def check_inventory_shape(self, inv, shape):
675
"""Compare an inventory to a list of expected names.
677
Fail if they are not precisely equal.
680
shape = list(shape) # copy
681
for path, ie in inv.entries():
682
name = path.replace('\\', '/')
690
self.fail("expected paths not found in inventory: %r" % shape)
692
self.fail("unexpected paths found in inventory: %r" % extras)
694
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
695
a_callable=None, *args, **kwargs):
696
"""Call callable with redirected std io pipes.
698
Returns the return code."""
699
if not callable(a_callable):
700
raise ValueError("a_callable must be callable.")
704
if getattr(self, "_log_file", None) is not None:
705
stdout = self._log_file
709
if getattr(self, "_log_file", None is not None):
710
stderr = self._log_file
713
real_stdin = sys.stdin
714
real_stdout = sys.stdout
715
real_stderr = sys.stderr
720
return a_callable(*args, **kwargs)
722
sys.stdout = real_stdout
723
sys.stderr = real_stderr
724
sys.stdin = real_stdin
726
def merge(self, branch_from, wt_to):
727
"""A helper for tests to do a ui-less merge.
729
This should move to the main library when someone has time to integrate
732
# minimal ui-less merge.
733
wt_to.branch.fetch(branch_from)
734
base_rev = common_ancestor(branch_from.last_revision(),
735
wt_to.branch.last_revision(),
736
wt_to.branch.repository)
737
merge_inner(wt_to.branch, branch_from.basis_tree(),
738
wt_to.branch.repository.revision_tree(base_rev),
740
wt_to.add_pending_merge(branch_from.last_revision())
743
BzrTestBase = TestCase
746
class TestCaseInTempDir(TestCase):
747
"""Derived class that runs a test within a temporary directory.
749
This is useful for tests that need to create a branch, etc.
751
The directory is created in a slightly complex way: for each
752
Python invocation, a new temporary top-level directory is created.
753
All test cases create their own directory within that. If the
754
tests complete successfully, the directory is removed.
756
InTempDir is an old alias for FunctionalTestCase.
761
OVERRIDE_PYTHON = 'python'
763
def check_file_contents(self, filename, expect):
764
self.log("check contents of file %s" % filename)
765
contents = file(filename, 'r').read()
766
if contents != expect:
767
self.log("expected: %r" % expect)
768
self.log("actually: %r" % contents)
769
self.fail("contents of %s not as expected" % filename)
771
def _make_test_root(self):
772
if TestCaseInTempDir.TEST_ROOT is not None:
776
root = u'test%04d.tmp' % i
780
if e.errno == errno.EEXIST:
785
# successfully created
786
TestCaseInTempDir.TEST_ROOT = osutils.abspath(root)
788
# make a fake bzr directory there to prevent any tests propagating
789
# up onto the source directory's real branch
790
bzrdir.BzrDir.create_standalone_workingtree(TestCaseInTempDir.TEST_ROOT)
793
super(TestCaseInTempDir, self).setUp()
794
self._make_test_root()
795
_currentdir = os.getcwdu()
796
# shorten the name, to avoid test failures due to path length
797
short_id = self.id().replace('bzrlib.tests.', '') \
798
.replace('__main__.', '')[-100:]
799
# it's possible the same test class is run several times for
800
# parameterized tests, so make sure the names don't collide.
804
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
806
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
807
if os.path.exists(candidate_dir):
811
self.test_dir = candidate_dir
812
os.mkdir(self.test_dir)
813
os.chdir(self.test_dir)
815
os.environ['HOME'] = self.test_dir
816
os.environ['APPDATA'] = self.test_dir
817
def _leaveDirectory():
818
os.chdir(_currentdir)
819
self.addCleanup(_leaveDirectory)
821
def build_tree(self, shape, line_endings='native', transport=None):
822
"""Build a test tree according to a pattern.
824
shape is a sequence of file specifications. If the final
825
character is '/', a directory is created.
827
This doesn't add anything to a branch.
828
:param line_endings: Either 'binary' or 'native'
829
in binary mode, exact contents are written
830
in native mode, the line endings match the
831
default platform endings.
833
:param transport: A transport to write to, for building trees on
834
VFS's. If the transport is readonly or None,
835
"." is opened automatically.
837
# XXX: It's OK to just create them using forward slashes on windows?
838
if transport is None or transport.is_readonly():
839
transport = get_transport(".")
841
self.assert_(isinstance(name, basestring))
843
transport.mkdir(urlescape(name[:-1]))
845
if line_endings == 'binary':
847
elif line_endings == 'native':
850
raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
851
content = "contents of %s%s" % (name, end)
852
transport.put(urlescape(name), StringIO(content))
854
def build_tree_contents(self, shape):
855
build_tree_contents(shape)
857
def failUnlessExists(self, path):
858
"""Fail unless path, which may be abs or relative, exists."""
859
self.failUnless(osutils.lexists(path))
861
def failIfExists(self, path):
862
"""Fail if path, which may be abs or relative, exists."""
863
self.failIf(osutils.lexists(path))
865
def assertFileEqual(self, content, path):
866
"""Fail if path does not contain 'content'."""
867
self.failUnless(osutils.lexists(path))
868
self.assertEqualDiff(content, open(path, 'r').read())
871
class TestCaseWithTransport(TestCaseInTempDir):
872
"""A test case that provides get_url and get_readonly_url facilities.
874
These back onto two transport servers, one for readonly access and one for
877
If no explicit class is provided for readonly access, a
878
ReadonlyTransportDecorator is used instead which allows the use of non disk
879
based read write transports.
881
If an explicit class is provided for readonly access, that server and the
882
readwrite one must both define get_url() as resolving to os.getcwd().
885
def __init__(self, methodName='testMethod'):
886
super(TestCaseWithTransport, self).__init__(methodName)
887
self.__readonly_server = None
889
self.transport_server = default_transport
890
self.transport_readonly_server = None
892
def get_readonly_url(self, relpath=None):
893
"""Get a URL for the readonly transport.
895
This will either be backed by '.' or a decorator to the transport
896
used by self.get_url()
897
relpath provides for clients to get a path relative to the base url.
898
These should only be downwards relative, not upwards.
900
base = self.get_readonly_server().get_url()
901
if relpath is not None:
902
if not base.endswith('/'):
904
base = base + relpath
907
def get_readonly_server(self):
908
"""Get the server instance for the readonly transport
910
This is useful for some tests with specific servers to do diagnostics.
912
if self.__readonly_server is None:
913
if self.transport_readonly_server is None:
914
# readonly decorator requested
915
# bring up the server
917
self.__readonly_server = ReadonlyServer()
918
self.__readonly_server.setUp(self.__server)
920
self.__readonly_server = self.transport_readonly_server()
921
self.__readonly_server.setUp()
922
self.addCleanup(self.__readonly_server.tearDown)
923
return self.__readonly_server
925
def get_server(self):
926
"""Get the read/write server instance.
928
This is useful for some tests with specific servers that need
931
if self.__server is None:
932
self.__server = self.transport_server()
933
self.__server.setUp()
934
self.addCleanup(self.__server.tearDown)
937
def get_url(self, relpath=None):
938
"""Get a URL for the readwrite transport.
940
This will either be backed by '.' or to an equivalent non-file based
942
relpath provides for clients to get a path relative to the base url.
943
These should only be downwards relative, not upwards.
945
base = self.get_server().get_url()
946
if relpath is not None and relpath != '.':
947
if not base.endswith('/'):
949
base = base + relpath
952
def get_transport(self):
953
"""Return a writeable transport for the test scratch space"""
954
t = get_transport(self.get_url())
955
self.assertFalse(t.is_readonly())
958
def get_readonly_transport(self):
959
"""Return a readonly transport for the test scratch space
961
This can be used to test that operations which should only need
962
readonly access in fact do not try to write.
964
t = get_transport(self.get_readonly_url())
965
self.assertTrue(t.is_readonly())
968
def make_branch(self, relpath, format=None):
969
"""Create a branch on the transport at relpath."""
970
repo = self.make_repository(relpath, format=format)
971
return repo.bzrdir.create_branch()
973
def make_bzrdir(self, relpath, format=None):
975
url = self.get_url(relpath)
976
segments = relpath.split('/')
977
if segments and segments[-1] not in ('', '.'):
978
parent = self.get_url('/'.join(segments[:-1]))
979
t = get_transport(parent)
981
t.mkdir(segments[-1])
982
except errors.FileExists:
985
format=bzrlib.bzrdir.BzrDirFormat.get_default_format()
986
# FIXME: make this use a single transport someday. RBC 20060418
987
return format.initialize_on_transport(get_transport(relpath))
988
except errors.UninitializableFormat:
989
raise TestSkipped("Format %s is not initializable." % format)
991
def make_repository(self, relpath, shared=False, format=None):
992
"""Create a repository on our default transport at relpath."""
993
made_control = self.make_bzrdir(relpath, format=format)
994
return made_control.create_repository(shared=shared)
996
def make_branch_and_tree(self, relpath, format=None):
997
"""Create a branch on the transport and a tree locally.
1001
# TODO: always use the local disk path for the working tree,
1002
# this obviously requires a format that supports branch references
1003
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1005
b = self.make_branch(relpath, format=format)
1007
return b.bzrdir.create_workingtree()
1008
except errors.NotLocalUrl:
1009
# new formats - catch No tree error and create
1010
# a branch reference and a checkout.
1011
# old formats at that point - raise TestSkipped.
1012
# TODO: rbc 20060208
1013
return WorkingTreeFormat2().initialize(bzrdir.BzrDir.open(relpath))
1015
def assertIsDirectory(self, relpath, transport):
1016
"""Assert that relpath within transport is a directory.
1018
This may not be possible on all transports; in that case it propagates
1019
a TransportNotPossible.
1022
mode = transport.stat(relpath).st_mode
1023
except errors.NoSuchFile:
1024
self.fail("path %s is not a directory; no such file"
1026
if not stat.S_ISDIR(mode):
1027
self.fail("path %s is not a directory; has mode %#o"
1031
class ChrootedTestCase(TestCaseWithTransport):
1032
"""A support class that provides readonly urls outside the local namespace.
1034
This is done by checking if self.transport_server is a MemoryServer. if it
1035
is then we are chrooted already, if it is not then an HttpServer is used
1038
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1039
be used without needed to redo it when a different
1040
subclass is in use ?
1044
super(ChrootedTestCase, self).setUp()
1045
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
1046
self.transport_readonly_server = bzrlib.transport.http.HttpServer
1049
def filter_suite_by_re(suite, pattern):
1050
result = TestSuite()
1051
filter_re = re.compile(pattern)
1052
for test in iter_suite_tests(suite):
1053
if filter_re.search(test.id()):
1054
result.addTest(test)
1058
def run_suite(suite, name='test', verbose=False, pattern=".*",
1059
stop_on_failure=False, keep_output=False,
1060
transport=None, lsprof_timed=None):
1061
TestCaseInTempDir._TEST_NAME = name
1062
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1068
pb = progress.ProgressBar()
1069
runner = TextTestRunner(stream=sys.stdout,
1071
verbosity=verbosity,
1072
keep_output=keep_output,
1074
runner.stop_on_failure=stop_on_failure
1076
suite = filter_suite_by_re(suite, pattern)
1077
result = runner.run(suite)
1078
return result.wasSuccessful()
1081
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1084
test_suite_factory=None,
1086
"""Run the whole test suite under the enhanced runner"""
1087
global default_transport
1088
if transport is None:
1089
transport = default_transport
1090
old_transport = default_transport
1091
default_transport = transport
1093
if test_suite_factory is None:
1094
suite = test_suite()
1096
suite = test_suite_factory()
1097
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1098
stop_on_failure=stop_on_failure, keep_output=keep_output,
1099
transport=transport,
1100
lsprof_timed=lsprof_timed)
1102
default_transport = old_transport
1106
"""Build and return TestSuite for the whole of bzrlib.
1108
This function can be replaced if you need to change the default test
1109
suite on a global basis, but it is not encouraged.
1111
from doctest import DocTestSuite
1113
global MODULES_TO_DOCTEST
1116
'bzrlib.tests.test_ancestry',
1117
'bzrlib.tests.test_api',
1118
'bzrlib.tests.test_bad_files',
1119
'bzrlib.tests.test_branch',
1120
'bzrlib.tests.test_bundle',
1121
'bzrlib.tests.test_bzrdir',
1122
'bzrlib.tests.test_command',
1123
'bzrlib.tests.test_commit',
1124
'bzrlib.tests.test_commit_merge',
1125
'bzrlib.tests.test_config',
1126
'bzrlib.tests.test_conflicts',
1127
'bzrlib.tests.test_decorators',
1128
'bzrlib.tests.test_diff',
1129
'bzrlib.tests.test_doc_generate',
1130
'bzrlib.tests.test_errors',
1131
'bzrlib.tests.test_escaped_store',
1132
'bzrlib.tests.test_fetch',
1133
'bzrlib.tests.test_gpg',
1134
'bzrlib.tests.test_graph',
1135
'bzrlib.tests.test_hashcache',
1136
'bzrlib.tests.test_http',
1137
'bzrlib.tests.test_identitymap',
1138
'bzrlib.tests.test_inv',
1139
'bzrlib.tests.test_knit',
1140
'bzrlib.tests.test_lockdir',
1141
'bzrlib.tests.test_lockable_files',
1142
'bzrlib.tests.test_log',
1143
'bzrlib.tests.test_merge',
1144
'bzrlib.tests.test_merge3',
1145
'bzrlib.tests.test_merge_core',
1146
'bzrlib.tests.test_missing',
1147
'bzrlib.tests.test_msgeditor',
1148
'bzrlib.tests.test_nonascii',
1149
'bzrlib.tests.test_options',
1150
'bzrlib.tests.test_osutils',
1151
'bzrlib.tests.test_patch',
1152
'bzrlib.tests.test_patches',
1153
'bzrlib.tests.test_permissions',
1154
'bzrlib.tests.test_plugins',
1155
'bzrlib.tests.test_progress',
1156
'bzrlib.tests.test_reconcile',
1157
'bzrlib.tests.test_repository',
1158
'bzrlib.tests.test_revision',
1159
'bzrlib.tests.test_revisionnamespaces',
1160
'bzrlib.tests.test_revprops',
1161
'bzrlib.tests.test_rio',
1162
'bzrlib.tests.test_sampler',
1163
'bzrlib.tests.test_selftest',
1164
'bzrlib.tests.test_setup',
1165
'bzrlib.tests.test_sftp_transport',
1166
'bzrlib.tests.test_smart_add',
1167
'bzrlib.tests.test_source',
1168
'bzrlib.tests.test_status',
1169
'bzrlib.tests.test_store',
1170
'bzrlib.tests.test_symbol_versioning',
1171
'bzrlib.tests.test_testament',
1172
'bzrlib.tests.test_textfile',
1173
'bzrlib.tests.test_textmerge',
1174
'bzrlib.tests.test_trace',
1175
'bzrlib.tests.test_transactions',
1176
'bzrlib.tests.test_transform',
1177
'bzrlib.tests.test_transport',
1178
'bzrlib.tests.test_tsort',
1179
'bzrlib.tests.test_tuned_gzip',
1180
'bzrlib.tests.test_ui',
1181
'bzrlib.tests.test_upgrade',
1182
'bzrlib.tests.test_versionedfile',
1183
'bzrlib.tests.test_weave',
1184
'bzrlib.tests.test_whitebox',
1185
'bzrlib.tests.test_workingtree',
1186
'bzrlib.tests.test_xml',
1188
test_transport_implementations = [
1189
'bzrlib.tests.test_transport_implementations']
1192
loader = TestUtil.TestLoader()
1193
from bzrlib.transport import TransportTestProviderAdapter
1194
adapter = TransportTestProviderAdapter()
1195
adapt_modules(test_transport_implementations, adapter, loader, suite)
1196
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1197
for package in packages_to_test():
1198
suite.addTest(package.test_suite())
1199
for m in MODULES_TO_TEST:
1200
suite.addTest(loader.loadTestsFromModule(m))
1201
for m in (MODULES_TO_DOCTEST):
1202
suite.addTest(DocTestSuite(m))
1203
for name, plugin in bzrlib.plugin.all_plugins().items():
1204
if getattr(plugin, 'test_suite', None) is not None:
1205
suite.addTest(plugin.test_suite())
1209
def adapt_modules(mods_list, adapter, loader, suite):
1210
"""Adapt the modules in mods_list using adapter and add to suite."""
1211
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1212
suite.addTests(adapter.adapt(test))
added
removed
bzrlib/tests/__init__.py
