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
osutils.rmtree(test_root.encode(sys.getfilesystemencoding()))
334
if self.pb is not None:
335
self.pb.note("Failed tests working directories are in '%s'\n",
339
"Failed tests working directories are in '%s'\n" %
341
TestCaseInTempDir.TEST_ROOT = None
342
if self.pb is not None:
347
def iter_suite_tests(suite):
348
"""Return all tests in a suite, recursing through nested suites"""
349
for item in suite._tests:
350
if isinstance(item, unittest.TestCase):
352
elif isinstance(item, unittest.TestSuite):
353
for r in iter_suite_tests(item):
356
raise Exception('unknown object %r inside test suite %r'
360
class TestSkipped(Exception):
361
"""Indicates that a test was intentionally skipped, rather than failing."""
365
class CommandFailed(Exception):
369
class StringIOWrapper(object):
370
"""A wrapper around cStringIO which just adds an encoding attribute.
372
Internally we can check sys.stdout to see what the output encoding
373
should be. However, cStringIO has no encoding attribute that we can
374
set. So we wrap it instead.
379
def __init__(self, s=None):
381
self.__dict__['_cstring'] = StringIO(s)
383
self.__dict__['_cstring'] = StringIO()
385
def __getattr__(self, name, getattr=getattr):
386
return getattr(self.__dict__['_cstring'], name)
388
def __setattr__(self, name, val):
389
if name == 'encoding':
390
self.__dict__['encoding'] = val
392
return setattr(self._cstring, name, val)
395
class TestCase(unittest.TestCase):
396
"""Base class for bzr unit tests.
398
Tests that need access to disk resources should subclass
399
TestCaseInTempDir not TestCase.
401
Error and debug log messages are redirected from their usual
402
location into a temporary file, the contents of which can be
403
retrieved by _get_log(). We use a real OS file, not an in-memory object,
404
so that it can also capture file IO. When the test completes this file
405
is read into memory and removed from disk.
407
There are also convenience functions to invoke bzr's command-line
408
routine, and to build and check bzr trees.
410
In addition to the usual method of overriding tearDown(), this class also
411
allows subclasses to register functions into the _cleanups list, which is
412
run in order as the object is torn down. It's less likely this will be
413
accidentally overlooked.
416
_log_file_name = None
418
# record lsprof data when performing benchmark calls.
419
_gather_lsprof_in_benchmarks = False
421
def __init__(self, methodName='testMethod'):
422
super(TestCase, self).__init__(methodName)
426
unittest.TestCase.setUp(self)
427
self._cleanEnvironment()
428
bzrlib.trace.disable_default_logging()
430
self._benchcalls = []
431
self._benchtime = None
433
def _ndiff_strings(self, a, b):
434
"""Return ndiff between two strings containing lines.
436
A trailing newline is added if missing to make the strings
438
if b and b[-1] != '\n':
440
if a and a[-1] != '\n':
442
difflines = difflib.ndiff(a.splitlines(True),
444
linejunk=lambda x: False,
445
charjunk=lambda x: False)
446
return ''.join(difflines)
448
def assertEqualDiff(self, a, b, message=None):
449
"""Assert two texts are equal, if not raise an exception.
451
This is intended for use with multi-line strings where it can
452
be hard to find the differences by eye.
454
# TODO: perhaps override assertEquals to call this for strings?
458
message = "texts not equal:\n"
459
raise AssertionError(message +
460
self._ndiff_strings(a, b))
462
def assertEqualMode(self, mode, mode_test):
463
self.assertEqual(mode, mode_test,
464
'mode mismatch %o != %o' % (mode, mode_test))
466
def assertStartsWith(self, s, prefix):
467
if not s.startswith(prefix):
468
raise AssertionError('string %r does not start with %r' % (s, prefix))
470
def assertEndsWith(self, s, suffix):
471
"""Asserts that s ends with suffix."""
472
if not s.endswith(suffix):
473
raise AssertionError('string %r does not end with %r' % (s, suffix))
475
def assertContainsRe(self, haystack, needle_re):
476
"""Assert that a contains something matching a regular expression."""
477
if not re.search(needle_re, haystack):
478
raise AssertionError('pattern "%s" not found in "%s"'
479
% (needle_re, haystack))
481
def assertSubset(self, sublist, superlist):
482
"""Assert that every entry in sublist is present in superlist."""
484
for entry in sublist:
485
if entry not in superlist:
486
missing.append(entry)
488
raise AssertionError("value(s) %r not present in container %r" %
489
(missing, superlist))
491
def assertIs(self, left, right):
492
if not (left is right):
493
raise AssertionError("%r is not %r." % (left, right))
495
def assertTransportMode(self, transport, path, mode):
496
"""Fail if a path does not have mode mode.
498
If modes are not supported on this transport, the assertion is ignored.
500
if not transport._can_roundtrip_unix_modebits():
502
path_stat = transport.stat(path)
503
actual_mode = stat.S_IMODE(path_stat.st_mode)
504
self.assertEqual(mode, actual_mode,
505
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
507
def assertIsInstance(self, obj, kls):
508
"""Fail if obj is not an instance of kls"""
509
if not isinstance(obj, kls):
510
self.fail("%r is an instance of %s rather than %s" % (
511
obj, obj.__class__, kls))
513
def _startLogFile(self):
514
"""Send bzr and test log messages to a temporary file.
516
The file is removed as the test is torn down.
518
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
519
encoder, decoder, stream_reader, stream_writer = codecs.lookup('UTF-8')
520
self._log_file = stream_writer(os.fdopen(fileno, 'w+'))
521
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
522
self._log_file_name = name
523
self.addCleanup(self._finishLogFile)
525
def _finishLogFile(self):
526
"""Finished with the log file.
528
Read contents into memory, close, and delete.
530
bzrlib.trace.disable_test_log(self._log_nonce)
531
self._log_file.seek(0)
532
self._log_contents = self._log_file.read()
533
self._log_file.close()
534
os.remove(self._log_file_name)
535
self._log_file = self._log_file_name = None
537
def addCleanup(self, callable):
538
"""Arrange to run a callable when this case is torn down.
540
Callables are run in the reverse of the order they are registered,
541
ie last-in first-out.
543
if callable in self._cleanups:
544
raise ValueError("cleanup function %r already registered on %s"
546
self._cleanups.append(callable)
548
def _cleanEnvironment(self):
551
'APPDATA': os.getcwd(),
556
self.addCleanup(self._restoreEnvironment)
557
for name, value in new_env.iteritems():
558
self._captureVar(name, value)
561
def _captureVar(self, name, newvalue):
562
"""Set an environment variable, preparing it to be reset when finished."""
563
self.__old_env[name] = os.environ.get(name, None)
565
if name in os.environ:
568
os.environ[name] = newvalue
571
def _restoreVar(name, value):
573
if name in os.environ:
576
os.environ[name] = value
578
def _restoreEnvironment(self):
579
for name, value in self.__old_env.iteritems():
580
self._restoreVar(name, value)
584
unittest.TestCase.tearDown(self)
586
def time(self, callable, *args, **kwargs):
587
"""Run callable and accrue the time it takes to the benchmark time.
589
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
590
this will cause lsprofile statistics to be gathered and stored in
593
if self._benchtime is None:
597
if not self._gather_lsprof_in_benchmarks:
598
return callable(*args, **kwargs)
600
# record this benchmark
601
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
603
self._benchcalls.append(((callable, args, kwargs), stats))
606
self._benchtime += time.time() - start
608
def _runCleanups(self):
609
"""Run registered cleanup functions.
611
This should only be called from TestCase.tearDown.
613
# TODO: Perhaps this should keep running cleanups even if
615
for cleanup_fn in reversed(self._cleanups):
618
def log(self, *args):
622
"""Return as a string the log for this test"""
623
if self._log_file_name:
624
return open(self._log_file_name).read()
626
return self._log_contents
627
# TODO: Delete the log after it's been read in
629
def capture(self, cmd, retcode=0):
630
"""Shortcut that splits cmd into words, runs, and returns stdout"""
631
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
633
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None):
634
"""Invoke bzr and return (stdout, stderr).
636
Useful for code that wants to check the contents of the
637
output, the way error messages are presented, etc.
639
This should be the main method for tests that want to exercise the
640
overall behavior of the bzr application (rather than a unit test
641
or a functional test of the library.)
643
Much of the old code runs bzr by forking a new copy of Python, but
644
that is slower, harder to debug, and generally not necessary.
646
This runs bzr through the interface that catches and reports
647
errors, and with logging set to something approximating the
648
default, so that error reporting can be checked.
650
:param argv: arguments to invoke bzr
651
:param retcode: expected return code, or None for don't-care.
652
:param encoding: encoding for sys.stdout and sys.stderr
653
:param stdin: A string to be used as stdin for the command.
656
encoding = bzrlib.user_encoding
657
if stdin is not None:
658
stdin = StringIO(stdin)
659
stdout = StringIOWrapper()
660
stderr = StringIOWrapper()
661
stdout.encoding = encoding
662
stderr.encoding = encoding
664
self.log('run bzr: %r', argv)
665
# FIXME: don't call into logging here
666
handler = logging.StreamHandler(stderr)
667
handler.setFormatter(bzrlib.trace.QuietFormatter())
668
handler.setLevel(logging.INFO)
669
logger = logging.getLogger('')
670
logger.addHandler(handler)
671
old_ui_factory = bzrlib.ui.ui_factory
672
bzrlib.ui.ui_factory = bzrlib.tests.blackbox.TestUIFactory(
675
bzrlib.ui.ui_factory.stdin = stdin
677
result = self.apply_redirected(stdin, stdout, stderr,
678
bzrlib.commands.run_bzr_catch_errors,
681
logger.removeHandler(handler)
682
bzrlib.ui.ui_factory = old_ui_factory
684
out = stdout.getvalue()
685
err = stderr.getvalue()
687
self.log('output:\n%r', out)
689
self.log('errors:\n%r', err)
690
if retcode is not None:
691
self.assertEquals(retcode, result)
694
def run_bzr(self, *args, **kwargs):
695
"""Invoke bzr, as if it were run from the command line.
697
This should be the main method for tests that want to exercise the
698
overall behavior of the bzr application (rather than a unit test
699
or a functional test of the library.)
701
This sends the stdout/stderr results into the test's log,
702
where it may be useful for debugging. See also run_captured.
704
:param stdin: A string to be used as stdin for the command.
706
retcode = kwargs.pop('retcode', 0)
707
encoding = kwargs.pop('encoding', None)
708
stdin = kwargs.pop('stdin', None)
709
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding, stdin=stdin)
711
def run_bzr_decode(self, *args, **kwargs):
712
if kwargs.has_key('encoding'):
713
encoding = kwargs['encoding']
715
encoding = bzrlib.user_encoding
716
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
718
def check_inventory_shape(self, inv, shape):
719
"""Compare an inventory to a list of expected names.
721
Fail if they are not precisely equal.
724
shape = list(shape) # copy
725
for path, ie in inv.entries():
726
name = path.replace('\\', '/')
734
self.fail("expected paths not found in inventory: %r" % shape)
736
self.fail("unexpected paths found in inventory: %r" % extras)
738
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
739
a_callable=None, *args, **kwargs):
740
"""Call callable with redirected std io pipes.
742
Returns the return code."""
743
if not callable(a_callable):
744
raise ValueError("a_callable must be callable.")
748
if getattr(self, "_log_file", None) is not None:
749
stdout = self._log_file
753
if getattr(self, "_log_file", None is not None):
754
stderr = self._log_file
757
real_stdin = sys.stdin
758
real_stdout = sys.stdout
759
real_stderr = sys.stderr
764
return a_callable(*args, **kwargs)
766
sys.stdout = real_stdout
767
sys.stderr = real_stderr
768
sys.stdin = real_stdin
770
def merge(self, branch_from, wt_to):
771
"""A helper for tests to do a ui-less merge.
773
This should move to the main library when someone has time to integrate
776
# minimal ui-less merge.
777
wt_to.branch.fetch(branch_from)
778
base_rev = common_ancestor(branch_from.last_revision(),
779
wt_to.branch.last_revision(),
780
wt_to.branch.repository)
781
merge_inner(wt_to.branch, branch_from.basis_tree(),
782
wt_to.branch.repository.revision_tree(base_rev),
784
wt_to.add_pending_merge(branch_from.last_revision())
787
BzrTestBase = TestCase
790
class TestCaseInTempDir(TestCase):
791
"""Derived class that runs a test within a temporary directory.
793
This is useful for tests that need to create a branch, etc.
795
The directory is created in a slightly complex way: for each
796
Python invocation, a new temporary top-level directory is created.
797
All test cases create their own directory within that. If the
798
tests complete successfully, the directory is removed.
800
InTempDir is an old alias for FunctionalTestCase.
805
OVERRIDE_PYTHON = 'python'
807
def check_file_contents(self, filename, expect):
808
self.log("check contents of file %s" % filename)
809
contents = file(filename, 'r').read()
810
if contents != expect:
811
self.log("expected: %r" % expect)
812
self.log("actually: %r" % contents)
813
self.fail("contents of %s not as expected" % filename)
815
def _make_test_root(self):
816
if TestCaseInTempDir.TEST_ROOT is not None:
820
root = u'test%04d.tmp' % i
824
if e.errno == errno.EEXIST:
829
# successfully created
830
TestCaseInTempDir.TEST_ROOT = osutils.abspath(root)
832
# make a fake bzr directory there to prevent any tests propagating
833
# up onto the source directory's real branch
834
bzrdir.BzrDir.create_standalone_workingtree(TestCaseInTempDir.TEST_ROOT)
837
super(TestCaseInTempDir, self).setUp()
838
self._make_test_root()
839
_currentdir = os.getcwdu()
840
# shorten the name, to avoid test failures due to path length
841
short_id = self.id().replace('bzrlib.tests.', '') \
842
.replace('__main__.', '')[-100:]
843
# it's possible the same test class is run several times for
844
# parameterized tests, so make sure the names don't collide.
848
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
850
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
851
if os.path.exists(candidate_dir):
855
self.test_dir = candidate_dir
856
os.mkdir(self.test_dir)
857
os.chdir(self.test_dir)
859
os.environ['HOME'] = self.test_dir
860
os.environ['APPDATA'] = self.test_dir
861
def _leaveDirectory():
862
os.chdir(_currentdir)
863
self.addCleanup(_leaveDirectory)
865
def build_tree(self, shape, line_endings='native', transport=None):
866
"""Build a test tree according to a pattern.
868
shape is a sequence of file specifications. If the final
869
character is '/', a directory is created.
871
This doesn't add anything to a branch.
872
:param line_endings: Either 'binary' or 'native'
873
in binary mode, exact contents are written
874
in native mode, the line endings match the
875
default platform endings.
877
:param transport: A transport to write to, for building trees on
878
VFS's. If the transport is readonly or None,
879
"." is opened automatically.
881
# XXX: It's OK to just create them using forward slashes on windows?
882
if transport is None or transport.is_readonly():
883
transport = get_transport(".")
885
self.assert_(isinstance(name, basestring))
887
transport.mkdir(urlutils.escape(name[:-1]))
889
if line_endings == 'binary':
891
elif line_endings == 'native':
894
raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
895
content = "contents of %s%s" % (name.encode('utf-8'), end)
896
transport.put(urlutils.escape(name), StringIO(content))
898
def build_tree_contents(self, shape):
899
build_tree_contents(shape)
901
def failUnlessExists(self, path):
902
"""Fail unless path, which may be abs or relative, exists."""
903
self.failUnless(osutils.lexists(path))
905
def failIfExists(self, path):
906
"""Fail if path, which may be abs or relative, exists."""
907
self.failIf(osutils.lexists(path))
909
def assertFileEqual(self, content, path):
910
"""Fail if path does not contain 'content'."""
911
self.failUnless(osutils.lexists(path))
912
# TODO: jam 20060427 Shouldn't this be 'rb'?
913
self.assertEqualDiff(content, open(path, 'r').read())
916
class TestCaseWithTransport(TestCaseInTempDir):
917
"""A test case that provides get_url and get_readonly_url facilities.
919
These back onto two transport servers, one for readonly access and one for
922
If no explicit class is provided for readonly access, a
923
ReadonlyTransportDecorator is used instead which allows the use of non disk
924
based read write transports.
926
If an explicit class is provided for readonly access, that server and the
927
readwrite one must both define get_url() as resolving to os.getcwd().
930
def __init__(self, methodName='testMethod'):
931
super(TestCaseWithTransport, self).__init__(methodName)
932
self.__readonly_server = None
934
self.transport_server = default_transport
935
self.transport_readonly_server = None
937
def get_readonly_url(self, relpath=None):
938
"""Get a URL for the readonly transport.
940
This will either be backed by '.' or a decorator to the transport
941
used by self.get_url()
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_readonly_server().get_url()
946
if relpath is not None:
947
if not base.endswith('/'):
949
base = base + relpath
952
def get_readonly_server(self):
953
"""Get the server instance for the readonly transport
955
This is useful for some tests with specific servers to do diagnostics.
957
if self.__readonly_server is None:
958
if self.transport_readonly_server is None:
959
# readonly decorator requested
960
# bring up the server
962
self.__readonly_server = ReadonlyServer()
963
self.__readonly_server.setUp(self.__server)
965
self.__readonly_server = self.transport_readonly_server()
966
self.__readonly_server.setUp()
967
self.addCleanup(self.__readonly_server.tearDown)
968
return self.__readonly_server
970
def get_server(self):
971
"""Get the read/write server instance.
973
This is useful for some tests with specific servers that need
976
if self.__server is None:
977
self.__server = self.transport_server()
978
self.__server.setUp()
979
self.addCleanup(self.__server.tearDown)
982
def get_url(self, relpath=None):
983
"""Get a URL for the readwrite transport.
985
This will either be backed by '.' or to an equivalent non-file based
987
relpath provides for clients to get a path relative to the base url.
988
These should only be downwards relative, not upwards.
990
base = self.get_server().get_url()
991
if relpath is not None and relpath != '.':
992
if not base.endswith('/'):
994
base = base + urlutils.escape(relpath)
997
def get_transport(self):
998
"""Return a writeable transport for the test scratch space"""
999
t = get_transport(self.get_url())
1000
self.assertFalse(t.is_readonly())
1003
def get_readonly_transport(self):
1004
"""Return a readonly transport for the test scratch space
1006
This can be used to test that operations which should only need
1007
readonly access in fact do not try to write.
1009
t = get_transport(self.get_readonly_url())
1010
self.assertTrue(t.is_readonly())
1013
def make_branch(self, relpath, format=None):
1014
"""Create a branch on the transport at relpath."""
1015
repo = self.make_repository(relpath, format=format)
1016
return repo.bzrdir.create_branch()
1018
def make_bzrdir(self, relpath, format=None):
1020
url = self.get_url(relpath)
1021
mutter('relpath %r => url %r', relpath, url)
1022
segments = url.split('/')
1023
if segments and segments[-1] not in ('', '.'):
1024
parent = '/'.join(segments[:-1])
1025
t = get_transport(parent)
1027
t.mkdir(segments[-1])
1028
except errors.FileExists:
1031
format=bzrlib.bzrdir.BzrDirFormat.get_default_format()
1032
# FIXME: make this use a single transport someday. RBC 20060418
1033
return format.initialize_on_transport(get_transport(relpath))
1034
except errors.UninitializableFormat:
1035
raise TestSkipped("Format %s is not initializable." % format)
1037
def make_repository(self, relpath, shared=False, format=None):
1038
"""Create a repository on our default transport at relpath."""
1039
made_control = self.make_bzrdir(relpath, format=format)
1040
return made_control.create_repository(shared=shared)
1042
def make_branch_and_tree(self, relpath, format=None):
1043
"""Create a branch on the transport and a tree locally.
1047
# TODO: always use the local disk path for the working tree,
1048
# this obviously requires a format that supports branch references
1049
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1051
b = self.make_branch(relpath, format=format)
1053
return b.bzrdir.create_workingtree()
1054
except errors.NotLocalUrl:
1055
# new formats - catch No tree error and create
1056
# a branch reference and a checkout.
1057
# old formats at that point - raise TestSkipped.
1058
# TODO: rbc 20060208
1059
return WorkingTreeFormat2().initialize(bzrdir.BzrDir.open(relpath))
1061
def assertIsDirectory(self, relpath, transport):
1062
"""Assert that relpath within transport is a directory.
1064
This may not be possible on all transports; in that case it propagates
1065
a TransportNotPossible.
1068
mode = transport.stat(relpath).st_mode
1069
except errors.NoSuchFile:
1070
self.fail("path %s is not a directory; no such file"
1072
if not stat.S_ISDIR(mode):
1073
self.fail("path %s is not a directory; has mode %#o"
1077
class ChrootedTestCase(TestCaseWithTransport):
1078
"""A support class that provides readonly urls outside the local namespace.
1080
This is done by checking if self.transport_server is a MemoryServer. if it
1081
is then we are chrooted already, if it is not then an HttpServer is used
1084
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1085
be used without needed to redo it when a different
1086
subclass is in use ?
1090
super(ChrootedTestCase, self).setUp()
1091
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
1092
self.transport_readonly_server = bzrlib.transport.http.HttpServer
1095
def filter_suite_by_re(suite, pattern):
1096
result = TestSuite()
1097
filter_re = re.compile(pattern)
1098
for test in iter_suite_tests(suite):
1099
if filter_re.search(test.id()):
1100
result.addTest(test)
1104
def run_suite(suite, name='test', verbose=False, pattern=".*",
1105
stop_on_failure=False, keep_output=False,
1106
transport=None, lsprof_timed=None):
1107
TestCaseInTempDir._TEST_NAME = name
1108
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1114
pb = progress.ProgressBar()
1115
runner = TextTestRunner(stream=sys.stdout,
1117
verbosity=verbosity,
1118
keep_output=keep_output,
1120
runner.stop_on_failure=stop_on_failure
1122
suite = filter_suite_by_re(suite, pattern)
1123
result = runner.run(suite)
1124
return result.wasSuccessful()
1127
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1130
test_suite_factory=None,
1132
"""Run the whole test suite under the enhanced runner"""
1133
global default_transport
1134
if transport is None:
1135
transport = default_transport
1136
old_transport = default_transport
1137
default_transport = transport
1139
if test_suite_factory is None:
1140
suite = test_suite()
1142
suite = test_suite_factory()
1143
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1144
stop_on_failure=stop_on_failure, keep_output=keep_output,
1145
transport=transport,
1146
lsprof_timed=lsprof_timed)
1148
default_transport = old_transport
1152
"""Build and return TestSuite for the whole of bzrlib.
1154
This function can be replaced if you need to change the default test
1155
suite on a global basis, but it is not encouraged.
1157
from doctest import DocTestSuite
1159
global MODULES_TO_DOCTEST
1162
'bzrlib.tests.test_ancestry',
1163
'bzrlib.tests.test_api',
1164
'bzrlib.tests.test_bad_files',
1165
'bzrlib.tests.test_branch',
1166
'bzrlib.tests.test_bundle',
1167
'bzrlib.tests.test_bzrdir',
1168
'bzrlib.tests.test_command',
1169
'bzrlib.tests.test_commit',
1170
'bzrlib.tests.test_commit_merge',
1171
'bzrlib.tests.test_config',
1172
'bzrlib.tests.test_conflicts',
1173
'bzrlib.tests.test_decorators',
1174
'bzrlib.tests.test_diff',
1175
'bzrlib.tests.test_doc_generate',
1176
'bzrlib.tests.test_errors',
1177
'bzrlib.tests.test_escaped_store',
1178
'bzrlib.tests.test_fetch',
1179
'bzrlib.tests.test_gpg',
1180
'bzrlib.tests.test_graph',
1181
'bzrlib.tests.test_hashcache',
1182
'bzrlib.tests.test_http',
1183
'bzrlib.tests.test_identitymap',
1184
'bzrlib.tests.test_inv',
1185
'bzrlib.tests.test_knit',
1186
'bzrlib.tests.test_lockdir',
1187
'bzrlib.tests.test_lockable_files',
1188
'bzrlib.tests.test_log',
1189
'bzrlib.tests.test_merge',
1190
'bzrlib.tests.test_merge3',
1191
'bzrlib.tests.test_merge_core',
1192
'bzrlib.tests.test_missing',
1193
'bzrlib.tests.test_msgeditor',
1194
'bzrlib.tests.test_nonascii',
1195
'bzrlib.tests.test_options',
1196
'bzrlib.tests.test_osutils',
1197
'bzrlib.tests.test_patch',
1198
'bzrlib.tests.test_patches',
1199
'bzrlib.tests.test_permissions',
1200
'bzrlib.tests.test_plugins',
1201
'bzrlib.tests.test_progress',
1202
'bzrlib.tests.test_reconcile',
1203
'bzrlib.tests.test_repository',
1204
'bzrlib.tests.test_revision',
1205
'bzrlib.tests.test_revisionnamespaces',
1206
'bzrlib.tests.test_revprops',
1207
'bzrlib.tests.test_rio',
1208
'bzrlib.tests.test_sampler',
1209
'bzrlib.tests.test_selftest',
1210
'bzrlib.tests.test_setup',
1211
'bzrlib.tests.test_sftp_transport',
1212
'bzrlib.tests.test_smart_add',
1213
'bzrlib.tests.test_source',
1214
'bzrlib.tests.test_status',
1215
'bzrlib.tests.test_store',
1216
'bzrlib.tests.test_symbol_versioning',
1217
'bzrlib.tests.test_testament',
1218
'bzrlib.tests.test_textfile',
1219
'bzrlib.tests.test_textmerge',
1220
'bzrlib.tests.test_trace',
1221
'bzrlib.tests.test_transactions',
1222
'bzrlib.tests.test_transform',
1223
'bzrlib.tests.test_transport',
1224
'bzrlib.tests.test_tsort',
1225
'bzrlib.tests.test_tuned_gzip',
1226
'bzrlib.tests.test_ui',
1227
'bzrlib.tests.test_upgrade',
1228
'bzrlib.tests.test_urlutils',
1229
'bzrlib.tests.test_versionedfile',
1230
'bzrlib.tests.test_weave',
1231
'bzrlib.tests.test_whitebox',
1232
'bzrlib.tests.test_workingtree',
1233
'bzrlib.tests.test_xml',
1235
test_transport_implementations = [
1236
'bzrlib.tests.test_transport_implementations']
1239
loader = TestUtil.TestLoader()
1240
from bzrlib.transport import TransportTestProviderAdapter
1241
adapter = TransportTestProviderAdapter()
1242
adapt_modules(test_transport_implementations, adapter, loader, suite)
1243
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1244
for package in packages_to_test():
1245
suite.addTest(package.test_suite())
1246
for m in MODULES_TO_TEST:
1247
suite.addTest(loader.loadTestsFromModule(m))
1248
for m in (MODULES_TO_DOCTEST):
1249
suite.addTest(DocTestSuite(m))
1250
for name, plugin in bzrlib.plugin.all_plugins().items():
1251
if getattr(plugin, 'test_suite', None) is not None:
1252
suite.addTest(plugin.test_suite())
1256
def adapt_modules(mods_list, adapter, loader, suite):
1257
"""Adapt the modules in mods_list using adapter and add to suite."""
1258
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1259
suite.addTests(adapter.adapt(test))
added
removed
bzrlib/tests/__init__.py
