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 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
import bzrlib.urlutils as urlutils
73
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
75
default_transport = LocalRelpathServer
78
MODULES_TO_DOCTEST = [
80
bzrlib.bundle.serializer,
93
def packages_to_test():
94
"""Return a list of packages to test.
96
The packages are not globally imported so that import failures are
97
triggered when running selftest, not when importing the command.
100
import bzrlib.tests.blackbox
101
import bzrlib.tests.branch_implementations
102
import bzrlib.tests.bzrdir_implementations
103
import bzrlib.tests.interrepository_implementations
104
import bzrlib.tests.interversionedfile_implementations
105
import bzrlib.tests.repository_implementations
106
import bzrlib.tests.revisionstore_implementations
107
import bzrlib.tests.workingtree_implementations
110
bzrlib.tests.blackbox,
111
bzrlib.tests.branch_implementations,
112
bzrlib.tests.bzrdir_implementations,
113
bzrlib.tests.interrepository_implementations,
114
bzrlib.tests.interversionedfile_implementations,
115
bzrlib.tests.repository_implementations,
116
bzrlib.tests.revisionstore_implementations,
117
bzrlib.tests.workingtree_implementations,
121
class _MyResult(unittest._TextTestResult):
122
"""Custom TestResult.
124
Shows output in a different format, including displaying runtime for tests.
128
def __init__(self, stream, descriptions, verbosity, pb=None):
129
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
132
def extractBenchmarkTime(self, testCase):
133
"""Add a benchmark time for the current test case."""
134
self._benchmarkTime = getattr(testCase, "_benchtime", None)
136
def _elapsedTestTimeString(self):
137
"""Return a time string for the overall time the current test has taken."""
138
return self._formatTime(time.time() - self._start_time)
140
def _testTimeString(self):
141
if self._benchmarkTime is not None:
143
self._formatTime(self._benchmarkTime),
144
self._elapsedTestTimeString())
146
return " %s" % self._elapsedTestTimeString()
148
def _formatTime(self, seconds):
149
"""Format seconds as milliseconds with leading spaces."""
150
return "%5dms" % (1000 * seconds)
152
def _ellipsise_unimportant_words(self, a_string, final_width,
154
"""Add ellipses (sp?) for overly long strings.
156
:param keep_start: If true preserve the start of a_string rather
160
if len(a_string) > final_width:
161
result = a_string[:final_width-3] + '...'
165
if len(a_string) > final_width:
166
result = '...' + a_string[3-final_width:]
169
return result.ljust(final_width)
171
def startTest(self, test):
172
unittest.TestResult.startTest(self, test)
173
# In a short description, the important words are in
174
# the beginning, but in an id, the important words are
176
SHOW_DESCRIPTIONS = False
178
if not self.showAll and self.dots and self.pb is not None:
181
final_width = osutils.terminal_width()
182
final_width = final_width - 15 - 8
184
if SHOW_DESCRIPTIONS:
185
what = test.shortDescription()
187
what = self._ellipsise_unimportant_words(what, final_width, keep_start=True)
190
if what.startswith('bzrlib.tests.'):
192
what = self._ellipsise_unimportant_words(what, final_width)
194
self.stream.write(what)
195
elif self.dots and self.pb is not None:
196
self.pb.update(what, self.testsRun - 1, None)
198
self._recordTestStartTime()
200
def _recordTestStartTime(self):
201
"""Record that a test has started."""
202
self._start_time = time.time()
204
def addError(self, test, err):
205
if isinstance(err[1], TestSkipped):
206
return self.addSkipped(test, err)
207
unittest.TestResult.addError(self, test, err)
208
self.extractBenchmarkTime(test)
210
self.stream.writeln("ERROR %s" % self._testTimeString())
211
elif self.dots and self.pb is None:
212
self.stream.write('E')
214
self.pb.update(self._ellipsise_unimportant_words('ERROR', 13), self.testsRun, None)
219
def addFailure(self, test, err):
220
unittest.TestResult.addFailure(self, test, err)
221
self.extractBenchmarkTime(test)
223
self.stream.writeln(" FAIL %s" % self._testTimeString())
224
elif self.dots and self.pb is None:
225
self.stream.write('F')
227
self.pb.update(self._ellipsise_unimportant_words('FAIL', 13), self.testsRun, None)
232
def addSuccess(self, test):
233
self.extractBenchmarkTime(test)
235
self.stream.writeln(' OK %s' % self._testTimeString())
236
for bench_called, stats in getattr(test, '_benchcalls', []):
237
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
238
stats.pprint(file=self.stream)
239
elif self.dots and self.pb is None:
240
self.stream.write('~')
242
self.pb.update(self._ellipsise_unimportant_words('OK', 13), self.testsRun, None)
244
unittest.TestResult.addSuccess(self, test)
246
def addSkipped(self, test, skip_excinfo):
247
self.extractBenchmarkTime(test)
249
print >>self.stream, ' SKIP %s' % self._testTimeString()
250
print >>self.stream, ' %s' % skip_excinfo[1]
251
elif self.dots and self.pb is None:
252
self.stream.write('S')
254
self.pb.update(self._ellipsise_unimportant_words('SKIP', 13), self.testsRun, None)
256
# seems best to treat this as success from point-of-view of unittest
257
# -- it actually does nothing so it barely matters :)
258
unittest.TestResult.addSuccess(self, test)
260
def printErrorList(self, flavour, errors):
261
for test, err in errors:
262
self.stream.writeln(self.separator1)
263
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
264
if getattr(test, '_get_log', None) is not None:
266
print >>self.stream, \
267
('vvvv[log from %s]' % test.id()).ljust(78,'-')
268
print >>self.stream, test._get_log()
269
print >>self.stream, \
270
('^^^^[log from %s]' % test.id()).ljust(78,'-')
271
self.stream.writeln(self.separator2)
272
self.stream.writeln("%s" % err)
275
class TextTestRunner(object):
276
stop_on_failure = False
284
self.stream = unittest._WritelnDecorator(stream)
285
self.descriptions = descriptions
286
self.verbosity = verbosity
287
self.keep_output = keep_output
290
def _makeResult(self):
291
result = _MyResult(self.stream,
295
result.stop_early = self.stop_on_failure
299
"Run the given test case or test suite."
300
result = self._makeResult()
301
startTime = time.time()
302
if self.pb is not None:
303
self.pb.update('Running tests', 0, test.countTestCases())
305
stopTime = time.time()
306
timeTaken = stopTime - startTime
308
self.stream.writeln(result.separator2)
309
run = result.testsRun
310
self.stream.writeln("Ran %d test%s in %.3fs" %
311
(run, run != 1 and "s" or "", timeTaken))
312
self.stream.writeln()
313
if not result.wasSuccessful():
314
self.stream.write("FAILED (")
315
failed, errored = map(len, (result.failures, result.errors))
317
self.stream.write("failures=%d" % failed)
319
if failed: self.stream.write(", ")
320
self.stream.write("errors=%d" % errored)
321
self.stream.writeln(")")
323
self.stream.writeln("OK")
324
if self.pb is not None:
325
self.pb.update('Cleaning up', 0, 1)
326
# This is still a little bogus,
327
# but only a little. Folk not using our testrunner will
328
# have to delete their temp directories themselves.
329
test_root = TestCaseInTempDir.TEST_ROOT
330
if result.wasSuccessful() or not self.keep_output:
331
if test_root is not None:
332
# If LANG=C we probably have created some bogus paths
333
# which rmtree(unicode) will fail to delete
334
# so make sure we are using rmtree(str) to delete everything
335
osutils.rmtree(test_root.encode(
336
sys.getfilesystemencoding()))
338
if self.pb is not None:
339
self.pb.note("Failed tests working directories are in '%s'\n",
343
"Failed tests working directories are in '%s'\n" %
345
TestCaseInTempDir.TEST_ROOT = None
346
if self.pb is not None:
351
def iter_suite_tests(suite):
352
"""Return all tests in a suite, recursing through nested suites"""
353
for item in suite._tests:
354
if isinstance(item, unittest.TestCase):
356
elif isinstance(item, unittest.TestSuite):
357
for r in iter_suite_tests(item):
360
raise Exception('unknown object %r inside test suite %r'
364
class TestSkipped(Exception):
365
"""Indicates that a test was intentionally skipped, rather than failing."""
369
class CommandFailed(Exception):
373
class StringIOWrapper(object):
374
"""A wrapper around cStringIO which just adds an encoding attribute.
376
Internally we can check sys.stdout to see what the output encoding
377
should be. However, cStringIO has no encoding attribute that we can
378
set. So we wrap it instead.
383
def __init__(self, s=None):
385
self.__dict__['_cstring'] = StringIO(s)
387
self.__dict__['_cstring'] = StringIO()
389
def __getattr__(self, name, getattr=getattr):
390
return getattr(self.__dict__['_cstring'], name)
392
def __setattr__(self, name, val):
393
if name == 'encoding':
394
self.__dict__['encoding'] = val
396
return setattr(self._cstring, name, val)
399
class TestCase(unittest.TestCase):
400
"""Base class for bzr unit tests.
402
Tests that need access to disk resources should subclass
403
TestCaseInTempDir not TestCase.
405
Error and debug log messages are redirected from their usual
406
location into a temporary file, the contents of which can be
407
retrieved by _get_log(). We use a real OS file, not an in-memory object,
408
so that it can also capture file IO. When the test completes this file
409
is read into memory and removed from disk.
411
There are also convenience functions to invoke bzr's command-line
412
routine, and to build and check bzr trees.
414
In addition to the usual method of overriding tearDown(), this class also
415
allows subclasses to register functions into the _cleanups list, which is
416
run in order as the object is torn down. It's less likely this will be
417
accidentally overlooked.
420
_log_file_name = None
422
# record lsprof data when performing benchmark calls.
423
_gather_lsprof_in_benchmarks = False
425
def __init__(self, methodName='testMethod'):
426
super(TestCase, self).__init__(methodName)
430
unittest.TestCase.setUp(self)
431
self._cleanEnvironment()
432
bzrlib.trace.disable_default_logging()
434
self._benchcalls = []
435
self._benchtime = None
437
def _ndiff_strings(self, a, b):
438
"""Return ndiff between two strings containing lines.
440
A trailing newline is added if missing to make the strings
442
if b and b[-1] != '\n':
444
if a and a[-1] != '\n':
446
difflines = difflib.ndiff(a.splitlines(True),
448
linejunk=lambda x: False,
449
charjunk=lambda x: False)
450
return ''.join(difflines)
452
def assertEqualDiff(self, a, b, message=None):
453
"""Assert two texts are equal, if not raise an exception.
455
This is intended for use with multi-line strings where it can
456
be hard to find the differences by eye.
458
# TODO: perhaps override assertEquals to call this for strings?
462
message = "texts not equal:\n"
463
raise AssertionError(message +
464
self._ndiff_strings(a, b))
466
def assertEqualMode(self, mode, mode_test):
467
self.assertEqual(mode, mode_test,
468
'mode mismatch %o != %o' % (mode, mode_test))
470
def assertStartsWith(self, s, prefix):
471
if not s.startswith(prefix):
472
raise AssertionError('string %r does not start with %r' % (s, prefix))
474
def assertEndsWith(self, s, suffix):
475
"""Asserts that s ends with suffix."""
476
if not s.endswith(suffix):
477
raise AssertionError('string %r does not end with %r' % (s, suffix))
479
def assertContainsRe(self, haystack, needle_re):
480
"""Assert that a contains something matching a regular expression."""
481
if not re.search(needle_re, haystack):
482
raise AssertionError('pattern "%s" not found in "%s"'
483
% (needle_re, haystack))
485
def assertSubset(self, sublist, superlist):
486
"""Assert that every entry in sublist is present in superlist."""
488
for entry in sublist:
489
if entry not in superlist:
490
missing.append(entry)
492
raise AssertionError("value(s) %r not present in container %r" %
493
(missing, superlist))
495
def assertIs(self, left, right):
496
if not (left is right):
497
raise AssertionError("%r is not %r." % (left, right))
499
def assertTransportMode(self, transport, path, mode):
500
"""Fail if a path does not have mode mode.
502
If modes are not supported on this transport, the assertion is ignored.
504
if not transport._can_roundtrip_unix_modebits():
506
path_stat = transport.stat(path)
507
actual_mode = stat.S_IMODE(path_stat.st_mode)
508
self.assertEqual(mode, actual_mode,
509
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
511
def assertIsInstance(self, obj, kls):
512
"""Fail if obj is not an instance of kls"""
513
if not isinstance(obj, kls):
514
self.fail("%r is an instance of %s rather than %s" % (
515
obj, obj.__class__, kls))
517
def _startLogFile(self):
518
"""Send bzr and test log messages to a temporary file.
520
The file is removed as the test is torn down.
522
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
523
encoder, decoder, stream_reader, stream_writer = codecs.lookup('UTF-8')
524
self._log_file = stream_writer(os.fdopen(fileno, 'w+'))
525
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
526
self._log_file_name = name
527
self.addCleanup(self._finishLogFile)
529
def _finishLogFile(self):
530
"""Finished with the log file.
532
Read contents into memory, close, and delete.
534
bzrlib.trace.disable_test_log(self._log_nonce)
535
self._log_file.seek(0)
536
self._log_contents = self._log_file.read()
537
self._log_file.close()
538
os.remove(self._log_file_name)
539
self._log_file = self._log_file_name = None
541
def addCleanup(self, callable):
542
"""Arrange to run a callable when this case is torn down.
544
Callables are run in the reverse of the order they are registered,
545
ie last-in first-out.
547
if callable in self._cleanups:
548
raise ValueError("cleanup function %r already registered on %s"
550
self._cleanups.append(callable)
552
def _cleanEnvironment(self):
555
'APPDATA': os.getcwd(),
560
self.addCleanup(self._restoreEnvironment)
561
for name, value in new_env.iteritems():
562
self._captureVar(name, value)
565
def _captureVar(self, name, newvalue):
566
"""Set an environment variable, preparing it to be reset when finished."""
567
self.__old_env[name] = os.environ.get(name, None)
569
if name in os.environ:
572
os.environ[name] = newvalue
575
def _restoreVar(name, value):
577
if name in os.environ:
580
os.environ[name] = value
582
def _restoreEnvironment(self):
583
for name, value in self.__old_env.iteritems():
584
self._restoreVar(name, value)
588
unittest.TestCase.tearDown(self)
590
def time(self, callable, *args, **kwargs):
591
"""Run callable and accrue the time it takes to the benchmark time.
593
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
594
this will cause lsprofile statistics to be gathered and stored in
597
if self._benchtime is None:
601
if not self._gather_lsprof_in_benchmarks:
602
return callable(*args, **kwargs)
604
# record this benchmark
605
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
607
self._benchcalls.append(((callable, args, kwargs), stats))
610
self._benchtime += time.time() - start
612
def _runCleanups(self):
613
"""Run registered cleanup functions.
615
This should only be called from TestCase.tearDown.
617
# TODO: Perhaps this should keep running cleanups even if
619
for cleanup_fn in reversed(self._cleanups):
622
def log(self, *args):
626
"""Return as a string the log for this test"""
627
if self._log_file_name:
628
return open(self._log_file_name).read()
630
return self._log_contents
631
# TODO: Delete the log after it's been read in
633
def capture(self, cmd, retcode=0):
634
"""Shortcut that splits cmd into words, runs, and returns stdout"""
635
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
637
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None):
638
"""Invoke bzr and return (stdout, stderr).
640
Useful for code that wants to check the contents of the
641
output, the way error messages are presented, etc.
643
This should be the main method for tests that want to exercise the
644
overall behavior of the bzr application (rather than a unit test
645
or a functional test of the library.)
647
Much of the old code runs bzr by forking a new copy of Python, but
648
that is slower, harder to debug, and generally not necessary.
650
This runs bzr through the interface that catches and reports
651
errors, and with logging set to something approximating the
652
default, so that error reporting can be checked.
654
:param argv: arguments to invoke bzr
655
:param retcode: expected return code, or None for don't-care.
656
:param encoding: encoding for sys.stdout and sys.stderr
657
:param stdin: A string to be used as stdin for the command.
660
encoding = bzrlib.user_encoding
661
if stdin is not None:
662
stdin = StringIO(stdin)
663
stdout = StringIOWrapper()
664
stderr = StringIOWrapper()
665
stdout.encoding = encoding
666
stderr.encoding = encoding
668
self.log('run bzr: %r', argv)
669
# FIXME: don't call into logging here
670
handler = logging.StreamHandler(stderr)
671
handler.setFormatter(bzrlib.trace.QuietFormatter())
672
handler.setLevel(logging.INFO)
673
logger = logging.getLogger('')
674
logger.addHandler(handler)
675
old_ui_factory = bzrlib.ui.ui_factory
676
bzrlib.ui.ui_factory = bzrlib.tests.blackbox.TestUIFactory(
679
bzrlib.ui.ui_factory.stdin = stdin
681
result = self.apply_redirected(stdin, stdout, stderr,
682
bzrlib.commands.run_bzr_catch_errors,
685
logger.removeHandler(handler)
686
bzrlib.ui.ui_factory = old_ui_factory
688
out = stdout.getvalue()
689
err = stderr.getvalue()
691
self.log('output:\n%r', out)
693
self.log('errors:\n%r', err)
694
if retcode is not None:
695
self.assertEquals(retcode, result)
698
def run_bzr(self, *args, **kwargs):
699
"""Invoke bzr, as if it were run from the command line.
701
This should be the main method for tests that want to exercise the
702
overall behavior of the bzr application (rather than a unit test
703
or a functional test of the library.)
705
This sends the stdout/stderr results into the test's log,
706
where it may be useful for debugging. See also run_captured.
708
:param stdin: A string to be used as stdin for the command.
710
retcode = kwargs.pop('retcode', 0)
711
encoding = kwargs.pop('encoding', None)
712
stdin = kwargs.pop('stdin', None)
713
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding, stdin=stdin)
715
def run_bzr_decode(self, *args, **kwargs):
716
if kwargs.has_key('encoding'):
717
encoding = kwargs['encoding']
719
encoding = bzrlib.user_encoding
720
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
722
def check_inventory_shape(self, inv, shape):
723
"""Compare an inventory to a list of expected names.
725
Fail if they are not precisely equal.
728
shape = list(shape) # copy
729
for path, ie in inv.entries():
730
name = path.replace('\\', '/')
738
self.fail("expected paths not found in inventory: %r" % shape)
740
self.fail("unexpected paths found in inventory: %r" % extras)
742
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
743
a_callable=None, *args, **kwargs):
744
"""Call callable with redirected std io pipes.
746
Returns the return code."""
747
if not callable(a_callable):
748
raise ValueError("a_callable must be callable.")
752
if getattr(self, "_log_file", None) is not None:
753
stdout = self._log_file
757
if getattr(self, "_log_file", None is not None):
758
stderr = self._log_file
761
real_stdin = sys.stdin
762
real_stdout = sys.stdout
763
real_stderr = sys.stderr
768
return a_callable(*args, **kwargs)
770
sys.stdout = real_stdout
771
sys.stderr = real_stderr
772
sys.stdin = real_stdin
774
def merge(self, branch_from, wt_to):
775
"""A helper for tests to do a ui-less merge.
777
This should move to the main library when someone has time to integrate
780
# minimal ui-less merge.
781
wt_to.branch.fetch(branch_from)
782
base_rev = common_ancestor(branch_from.last_revision(),
783
wt_to.branch.last_revision(),
784
wt_to.branch.repository)
785
merge_inner(wt_to.branch, branch_from.basis_tree(),
786
wt_to.branch.repository.revision_tree(base_rev),
788
wt_to.add_pending_merge(branch_from.last_revision())
791
BzrTestBase = TestCase
794
class TestCaseInTempDir(TestCase):
795
"""Derived class that runs a test within a temporary directory.
797
This is useful for tests that need to create a branch, etc.
799
The directory is created in a slightly complex way: for each
800
Python invocation, a new temporary top-level directory is created.
801
All test cases create their own directory within that. If the
802
tests complete successfully, the directory is removed.
804
InTempDir is an old alias for FunctionalTestCase.
809
OVERRIDE_PYTHON = 'python'
811
def check_file_contents(self, filename, expect):
812
self.log("check contents of file %s" % filename)
813
contents = file(filename, 'r').read()
814
if contents != expect:
815
self.log("expected: %r" % expect)
816
self.log("actually: %r" % contents)
817
self.fail("contents of %s not as expected" % filename)
819
def _make_test_root(self):
820
if TestCaseInTempDir.TEST_ROOT is not None:
824
root = u'test%04d.tmp' % i
828
if e.errno == errno.EEXIST:
833
# successfully created
834
TestCaseInTempDir.TEST_ROOT = osutils.abspath(root)
836
# make a fake bzr directory there to prevent any tests propagating
837
# up onto the source directory's real branch
838
bzrdir.BzrDir.create_standalone_workingtree(TestCaseInTempDir.TEST_ROOT)
841
super(TestCaseInTempDir, self).setUp()
842
self._make_test_root()
843
_currentdir = os.getcwdu()
844
# shorten the name, to avoid test failures due to path length
845
short_id = self.id().replace('bzrlib.tests.', '') \
846
.replace('__main__.', '')[-100:]
847
# it's possible the same test class is run several times for
848
# parameterized tests, so make sure the names don't collide.
852
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
854
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
855
if os.path.exists(candidate_dir):
859
self.test_dir = candidate_dir
860
os.mkdir(self.test_dir)
861
os.chdir(self.test_dir)
863
os.environ['HOME'] = self.test_dir
864
os.environ['APPDATA'] = self.test_dir
865
def _leaveDirectory():
866
os.chdir(_currentdir)
867
self.addCleanup(_leaveDirectory)
869
def build_tree(self, shape, line_endings='native', transport=None):
870
"""Build a test tree according to a pattern.
872
shape is a sequence of file specifications. If the final
873
character is '/', a directory is created.
875
This doesn't add anything to a branch.
876
:param line_endings: Either 'binary' or 'native'
877
in binary mode, exact contents are written
878
in native mode, the line endings match the
879
default platform endings.
881
:param transport: A transport to write to, for building trees on
882
VFS's. If the transport is readonly or None,
883
"." is opened automatically.
885
# XXX: It's OK to just create them using forward slashes on windows?
886
if transport is None or transport.is_readonly():
887
transport = get_transport(".")
889
self.assert_(isinstance(name, basestring))
891
transport.mkdir(urlutils.escape(name[:-1]))
893
if line_endings == 'binary':
895
elif line_endings == 'native':
898
raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
899
content = "contents of %s%s" % (name.encode('utf-8'), end)
900
transport.put(urlutils.escape(name), StringIO(content))
902
def build_tree_contents(self, shape):
903
build_tree_contents(shape)
905
def failUnlessExists(self, path):
906
"""Fail unless path, which may be abs or relative, exists."""
907
self.failUnless(osutils.lexists(path))
909
def failIfExists(self, path):
910
"""Fail if path, which may be abs or relative, exists."""
911
self.failIf(osutils.lexists(path))
913
def assertFileEqual(self, content, path):
914
"""Fail if path does not contain 'content'."""
915
self.failUnless(osutils.lexists(path))
916
# TODO: jam 20060427 Shouldn't this be 'rb'?
917
self.assertEqualDiff(content, open(path, 'r').read())
920
class TestCaseWithTransport(TestCaseInTempDir):
921
"""A test case that provides get_url and get_readonly_url facilities.
923
These back onto two transport servers, one for readonly access and one for
926
If no explicit class is provided for readonly access, a
927
ReadonlyTransportDecorator is used instead which allows the use of non disk
928
based read write transports.
930
If an explicit class is provided for readonly access, that server and the
931
readwrite one must both define get_url() as resolving to os.getcwd().
934
def __init__(self, methodName='testMethod'):
935
super(TestCaseWithTransport, self).__init__(methodName)
936
self.__readonly_server = None
938
self.transport_server = default_transport
939
self.transport_readonly_server = None
941
def get_readonly_url(self, relpath=None):
942
"""Get a URL for the readonly transport.
944
This will either be backed by '.' or a decorator to the transport
945
used by self.get_url()
946
relpath provides for clients to get a path relative to the base url.
947
These should only be downwards relative, not upwards.
949
base = self.get_readonly_server().get_url()
950
if relpath is not None:
951
if not base.endswith('/'):
953
base = base + relpath
956
def get_readonly_server(self):
957
"""Get the server instance for the readonly transport
959
This is useful for some tests with specific servers to do diagnostics.
961
if self.__readonly_server is None:
962
if self.transport_readonly_server is None:
963
# readonly decorator requested
964
# bring up the server
966
self.__readonly_server = ReadonlyServer()
967
self.__readonly_server.setUp(self.__server)
969
self.__readonly_server = self.transport_readonly_server()
970
self.__readonly_server.setUp()
971
self.addCleanup(self.__readonly_server.tearDown)
972
return self.__readonly_server
974
def get_server(self):
975
"""Get the read/write server instance.
977
This is useful for some tests with specific servers that need
980
if self.__server is None:
981
self.__server = self.transport_server()
982
self.__server.setUp()
983
self.addCleanup(self.__server.tearDown)
986
def get_url(self, relpath=None):
987
"""Get a URL for the readwrite transport.
989
This will either be backed by '.' or to an equivalent non-file based
991
relpath provides for clients to get a path relative to the base url.
992
These should only be downwards relative, not upwards.
994
base = self.get_server().get_url()
995
if relpath is not None and relpath != '.':
996
if not base.endswith('/'):
998
base = base + urlutils.escape(relpath)
1001
def get_transport(self):
1002
"""Return a writeable transport for the test scratch space"""
1003
t = get_transport(self.get_url())
1004
self.assertFalse(t.is_readonly())
1007
def get_readonly_transport(self):
1008
"""Return a readonly transport for the test scratch space
1010
This can be used to test that operations which should only need
1011
readonly access in fact do not try to write.
1013
t = get_transport(self.get_readonly_url())
1014
self.assertTrue(t.is_readonly())
1017
def make_branch(self, relpath, format=None):
1018
"""Create a branch on the transport at relpath."""
1019
repo = self.make_repository(relpath, format=format)
1020
return repo.bzrdir.create_branch()
1022
def make_bzrdir(self, relpath, format=None):
1024
url = self.get_url(relpath)
1025
mutter('relpath %r => url %r', relpath, url)
1026
segments = url.split('/')
1027
if segments and segments[-1] not in ('', '.'):
1028
parent = '/'.join(segments[:-1])
1029
t = get_transport(parent)
1031
t.mkdir(segments[-1])
1032
except errors.FileExists:
1035
format=bzrlib.bzrdir.BzrDirFormat.get_default_format()
1036
# FIXME: make this use a single transport someday. RBC 20060418
1037
return format.initialize_on_transport(get_transport(relpath))
1038
except errors.UninitializableFormat:
1039
raise TestSkipped("Format %s is not initializable." % format)
1041
def make_repository(self, relpath, shared=False, format=None):
1042
"""Create a repository on our default transport at relpath."""
1043
made_control = self.make_bzrdir(relpath, format=format)
1044
return made_control.create_repository(shared=shared)
1046
def make_branch_and_tree(self, relpath, format=None):
1047
"""Create a branch on the transport and a tree locally.
1051
# TODO: always use the local disk path for the working tree,
1052
# this obviously requires a format that supports branch references
1053
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1055
b = self.make_branch(relpath, format=format)
1057
return b.bzrdir.create_workingtree()
1058
except errors.NotLocalUrl:
1059
# new formats - catch No tree error and create
1060
# a branch reference and a checkout.
1061
# old formats at that point - raise TestSkipped.
1062
# TODO: rbc 20060208
1063
return WorkingTreeFormat2().initialize(bzrdir.BzrDir.open(relpath))
1065
def assertIsDirectory(self, relpath, transport):
1066
"""Assert that relpath within transport is a directory.
1068
This may not be possible on all transports; in that case it propagates
1069
a TransportNotPossible.
1072
mode = transport.stat(relpath).st_mode
1073
except errors.NoSuchFile:
1074
self.fail("path %s is not a directory; no such file"
1076
if not stat.S_ISDIR(mode):
1077
self.fail("path %s is not a directory; has mode %#o"
1081
class ChrootedTestCase(TestCaseWithTransport):
1082
"""A support class that provides readonly urls outside the local namespace.
1084
This is done by checking if self.transport_server is a MemoryServer. if it
1085
is then we are chrooted already, if it is not then an HttpServer is used
1088
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1089
be used without needed to redo it when a different
1090
subclass is in use ?
1094
super(ChrootedTestCase, self).setUp()
1095
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
1096
self.transport_readonly_server = bzrlib.transport.http.HttpServer
1099
def filter_suite_by_re(suite, pattern):
1100
result = TestSuite()
1101
filter_re = re.compile(pattern)
1102
for test in iter_suite_tests(suite):
1103
if filter_re.search(test.id()):
1104
result.addTest(test)
1108
def run_suite(suite, name='test', verbose=False, pattern=".*",
1109
stop_on_failure=False, keep_output=False,
1110
transport=None, lsprof_timed=None):
1111
TestCaseInTempDir._TEST_NAME = name
1112
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1118
pb = progress.ProgressBar()
1119
runner = TextTestRunner(stream=sys.stdout,
1121
verbosity=verbosity,
1122
keep_output=keep_output,
1124
runner.stop_on_failure=stop_on_failure
1126
suite = filter_suite_by_re(suite, pattern)
1127
result = runner.run(suite)
1128
return result.wasSuccessful()
1131
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1134
test_suite_factory=None,
1136
"""Run the whole test suite under the enhanced runner"""
1137
global default_transport
1138
if transport is None:
1139
transport = default_transport
1140
old_transport = default_transport
1141
default_transport = transport
1143
if test_suite_factory is None:
1144
suite = test_suite()
1146
suite = test_suite_factory()
1147
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1148
stop_on_failure=stop_on_failure, keep_output=keep_output,
1149
transport=transport,
1150
lsprof_timed=lsprof_timed)
1152
default_transport = old_transport
1156
"""Build and return TestSuite for the whole of bzrlib.
1158
This function can be replaced if you need to change the default test
1159
suite on a global basis, but it is not encouraged.
1161
from doctest import DocTestSuite
1163
global MODULES_TO_DOCTEST
1166
'bzrlib.tests.test_ancestry',
1167
'bzrlib.tests.test_api',
1168
'bzrlib.tests.test_bad_files',
1169
'bzrlib.tests.test_branch',
1170
'bzrlib.tests.test_bundle',
1171
'bzrlib.tests.test_bzrdir',
1172
'bzrlib.tests.test_command',
1173
'bzrlib.tests.test_commit',
1174
'bzrlib.tests.test_commit_merge',
1175
'bzrlib.tests.test_config',
1176
'bzrlib.tests.test_conflicts',
1177
'bzrlib.tests.test_decorators',
1178
'bzrlib.tests.test_diff',
1179
'bzrlib.tests.test_doc_generate',
1180
'bzrlib.tests.test_errors',
1181
'bzrlib.tests.test_escaped_store',
1182
'bzrlib.tests.test_fetch',
1183
'bzrlib.tests.test_gpg',
1184
'bzrlib.tests.test_graph',
1185
'bzrlib.tests.test_hashcache',
1186
'bzrlib.tests.test_http',
1187
'bzrlib.tests.test_identitymap',
1188
'bzrlib.tests.test_inv',
1189
'bzrlib.tests.test_knit',
1190
'bzrlib.tests.test_lockdir',
1191
'bzrlib.tests.test_lockable_files',
1192
'bzrlib.tests.test_log',
1193
'bzrlib.tests.test_merge',
1194
'bzrlib.tests.test_merge3',
1195
'bzrlib.tests.test_merge_core',
1196
'bzrlib.tests.test_missing',
1197
'bzrlib.tests.test_msgeditor',
1198
'bzrlib.tests.test_nonascii',
1199
'bzrlib.tests.test_options',
1200
'bzrlib.tests.test_osutils',
1201
'bzrlib.tests.test_patch',
1202
'bzrlib.tests.test_patches',
1203
'bzrlib.tests.test_permissions',
1204
'bzrlib.tests.test_plugins',
1205
'bzrlib.tests.test_progress',
1206
'bzrlib.tests.test_reconcile',
1207
'bzrlib.tests.test_repository',
1208
'bzrlib.tests.test_revision',
1209
'bzrlib.tests.test_revisionnamespaces',
1210
'bzrlib.tests.test_revprops',
1211
'bzrlib.tests.test_rio',
1212
'bzrlib.tests.test_sampler',
1213
'bzrlib.tests.test_selftest',
1214
'bzrlib.tests.test_setup',
1215
'bzrlib.tests.test_sftp_transport',
1216
'bzrlib.tests.test_smart_add',
1217
'bzrlib.tests.test_source',
1218
'bzrlib.tests.test_status',
1219
'bzrlib.tests.test_store',
1220
'bzrlib.tests.test_symbol_versioning',
1221
'bzrlib.tests.test_testament',
1222
'bzrlib.tests.test_textfile',
1223
'bzrlib.tests.test_textmerge',
1224
'bzrlib.tests.test_trace',
1225
'bzrlib.tests.test_transactions',
1226
'bzrlib.tests.test_transform',
1227
'bzrlib.tests.test_transport',
1228
'bzrlib.tests.test_tsort',
1229
'bzrlib.tests.test_tuned_gzip',
1230
'bzrlib.tests.test_ui',
1231
'bzrlib.tests.test_upgrade',
1232
'bzrlib.tests.test_urlutils',
1233
'bzrlib.tests.test_versionedfile',
1234
'bzrlib.tests.test_weave',
1235
'bzrlib.tests.test_whitebox',
1236
'bzrlib.tests.test_workingtree',
1237
'bzrlib.tests.test_xml',
1239
test_transport_implementations = [
1240
'bzrlib.tests.test_transport_implementations']
1243
loader = TestUtil.TestLoader()
1244
from bzrlib.transport import TransportTestProviderAdapter
1245
adapter = TransportTestProviderAdapter()
1246
adapt_modules(test_transport_implementations, adapter, loader, suite)
1247
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1248
for package in packages_to_test():
1249
suite.addTest(package.test_suite())
1250
for m in MODULES_TO_TEST:
1251
suite.addTest(loader.loadTestsFromModule(m))
1252
for m in (MODULES_TO_DOCTEST):
1253
suite.addTest(DocTestSuite(m))
1254
for name, plugin in bzrlib.plugin.all_plugins().items():
1255
if getattr(plugin, 'test_suite', None) is not None:
1256
suite.addTest(plugin.test_suite())
1260
def adapt_modules(mods_list, adapter, loader, suite):
1261
"""Adapt the modules in mods_list using adapter and add to suite."""
1262
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1263
suite.addTests(adapter.adapt(test))
added
removed
bzrlib/tests/__init__.py
