21
21
# little as possible, so this should be used rarely if it's added at all.
22
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.
24
30
from cStringIO import StringIO
39
from subprocess import Popen, PIPE
37
46
import bzrlib.branch
47
import bzrlib.bzrdir as bzrdir
38
48
import bzrlib.commands
39
from bzrlib.errors import BzrError
49
import bzrlib.bundle.serializer
50
import bzrlib.errors as errors
40
51
import bzrlib.inventory
52
import bzrlib.iterablefile
57
# lsprof not available
59
from bzrlib.merge import merge_inner
41
60
import bzrlib.merge3
42
61
import bzrlib.osutils
43
62
import bzrlib.osutils as osutils
44
63
import bzrlib.plugin
64
import bzrlib.progress as progress
65
from bzrlib.revision import common_ancestor
66
from bzrlib.revisionspec import RevisionSpec
45
67
import bzrlib.store
68
from bzrlib import symbol_versioning
46
69
import bzrlib.trace
70
from bzrlib.transport import get_transport
71
import bzrlib.transport
72
from bzrlib.transport.local import LocalRelpathServer
73
from bzrlib.transport.readonly import ReadonlyServer
47
74
from bzrlib.trace import mutter
48
from bzrlib.tests.TestUtil import TestLoader, TestSuite
75
from bzrlib.tests import TestUtil
76
from bzrlib.tests.TestUtil import (
49
80
from bzrlib.tests.treeshape import build_tree_contents
81
import bzrlib.urlutils as urlutils
82
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
84
default_transport = LocalRelpathServer
51
86
MODULES_TO_TEST = []
52
87
MODULES_TO_DOCTEST = [
89
bzrlib.bundle.serializer,
61
102
def packages_to_test():
103
"""Return a list of packages to test.
105
The packages are not globally imported so that import failures are
106
triggered when running selftest, not when importing the command.
62
109
import bzrlib.tests.blackbox
110
import bzrlib.tests.branch_implementations
111
import bzrlib.tests.bzrdir_implementations
112
import bzrlib.tests.interrepository_implementations
113
import bzrlib.tests.interversionedfile_implementations
114
import bzrlib.tests.intertree_implementations
115
import bzrlib.tests.repository_implementations
116
import bzrlib.tests.revisionstore_implementations
117
import bzrlib.tests.tree_implementations
118
import bzrlib.tests.workingtree_implementations
121
bzrlib.tests.blackbox,
122
bzrlib.tests.branch_implementations,
123
bzrlib.tests.bzrdir_implementations,
124
bzrlib.tests.interrepository_implementations,
125
bzrlib.tests.interversionedfile_implementations,
126
bzrlib.tests.intertree_implementations,
127
bzrlib.tests.repository_implementations,
128
bzrlib.tests.revisionstore_implementations,
129
bzrlib.tests.tree_implementations,
130
bzrlib.tests.workingtree_implementations,
68
class EarlyStoppingTestResultAdapter(object):
69
"""An adapter for TestResult to stop at the first first failure or error"""
71
def __init__(self, result):
74
def addError(self, test, err):
75
self._result.addError(test, err)
78
def addFailure(self, test, err):
79
self._result.addFailure(test, err)
82
def __getattr__(self, name):
83
return getattr(self._result, name)
85
def __setattr__(self, name, value):
87
object.__setattr__(self, name, value)
88
return setattr(self._result, name, value)
91
134
class _MyResult(unittest._TextTestResult):
92
135
"""Custom TestResult.
94
137
Shows output in a different format, including displaying runtime for tests.
97
def _elapsedTime(self):
98
return "%5dms" % (1000 * (time.time() - self._start_time))
141
def __init__(self, stream, descriptions, verbosity, pb=None,
143
"""Construct new TestResult.
145
:param bench_history: Optionally, a writable file object to accumulate
148
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
150
if bench_history is not None:
151
from bzrlib.version import _get_bzr_source_tree
152
src_tree = _get_bzr_source_tree()
154
revision_id = src_tree.last_revision()
156
# XXX: If there's no branch, what should we do?
158
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
159
self._bench_history = bench_history
161
def extractBenchmarkTime(self, testCase):
162
"""Add a benchmark time for the current test case."""
163
self._benchmarkTime = getattr(testCase, "_benchtime", None)
165
def _elapsedTestTimeString(self):
166
"""Return a time string for the overall time the current test has taken."""
167
return self._formatTime(time.time() - self._start_time)
169
def _testTimeString(self):
170
if self._benchmarkTime is not None:
172
self._formatTime(self._benchmarkTime),
173
self._elapsedTestTimeString())
175
return " %s" % self._elapsedTestTimeString()
177
def _formatTime(self, seconds):
178
"""Format seconds as milliseconds with leading spaces."""
179
return "%5dms" % (1000 * seconds)
181
def _ellipsise_unimportant_words(self, a_string, final_width,
183
"""Add ellipses (sp?) for overly long strings.
185
:param keep_start: If true preserve the start of a_string rather
189
if len(a_string) > final_width:
190
result = a_string[:final_width-3] + '...'
194
if len(a_string) > final_width:
195
result = '...' + a_string[3-final_width:]
198
return result.ljust(final_width)
100
200
def startTest(self, test):
101
201
unittest.TestResult.startTest(self, test)
103
203
# the beginning, but in an id, the important words are
105
205
SHOW_DESCRIPTIONS = False
207
if not self.showAll and self.dots and self.pb is not None:
210
final_width = osutils.terminal_width()
211
final_width = final_width - 15 - 8
213
if SHOW_DESCRIPTIONS:
214
what = test.shortDescription()
216
what = self._ellipsise_unimportant_words(what, final_width, keep_start=True)
219
if what.startswith('bzrlib.tests.'):
221
what = self._ellipsise_unimportant_words(what, final_width)
107
width = osutils.terminal_width()
108
name_width = width - 15
110
if SHOW_DESCRIPTIONS:
111
what = test.shortDescription()
113
if len(what) > name_width:
114
what = what[:name_width-3] + '...'
117
if what.startswith('bzrlib.tests.'):
119
if len(what) > name_width:
120
what = '...' + what[3-name_width:]
121
what = what.ljust(name_width)
122
223
self.stream.write(what)
224
elif self.dots and self.pb is not None:
225
self.pb.update(what, self.testsRun - 1, None)
123
226
self.stream.flush()
227
self._recordTestStartTime()
229
def _recordTestStartTime(self):
230
"""Record that a test has started."""
124
231
self._start_time = time.time()
126
233
def addError(self, test, err):
127
234
if isinstance(err[1], TestSkipped):
128
235
return self.addSkipped(test, err)
129
236
unittest.TestResult.addError(self, test, err)
237
self.extractBenchmarkTime(test)
131
self.stream.writeln("ERROR %s" % self._elapsedTime())
239
self.stream.writeln("ERROR %s" % self._testTimeString())
240
elif self.dots and self.pb is None:
133
241
self.stream.write('E')
243
self.pb.update(self._ellipsise_unimportant_words('ERROR', 13), self.testsRun, None)
244
self.pb.note(self._ellipsise_unimportant_words(
245
test.id() + ': ERROR',
246
osutils.terminal_width()))
134
247
self.stream.flush()
136
251
def addFailure(self, test, err):
137
252
unittest.TestResult.addFailure(self, test, err)
253
self.extractBenchmarkTime(test)
139
self.stream.writeln(" FAIL %s" % self._elapsedTime())
255
self.stream.writeln(" FAIL %s" % self._testTimeString())
256
elif self.dots and self.pb is None:
141
257
self.stream.write('F')
259
self.pb.update(self._ellipsise_unimportant_words('FAIL', 13), self.testsRun, None)
260
self.pb.note(self._ellipsise_unimportant_words(
261
test.id() + ': FAIL',
262
osutils.terminal_width()))
142
263
self.stream.flush()
144
267
def addSuccess(self, test):
268
self.extractBenchmarkTime(test)
269
if self._bench_history is not None:
270
if self._benchmarkTime is not None:
271
self._bench_history.write("%s %s\n" % (
272
self._formatTime(self._benchmarkTime),
146
self.stream.writeln(' OK %s' % self._elapsedTime())
275
self.stream.writeln(' OK %s' % self._testTimeString())
276
for bench_called, stats in getattr(test, '_benchcalls', []):
277
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
278
stats.pprint(file=self.stream)
279
elif self.dots and self.pb is None:
148
280
self.stream.write('~')
282
self.pb.update(self._ellipsise_unimportant_words('OK', 13), self.testsRun, None)
149
283
self.stream.flush()
150
284
unittest.TestResult.addSuccess(self, test)
152
286
def addSkipped(self, test, skip_excinfo):
287
self.extractBenchmarkTime(test)
154
print >>self.stream, ' SKIP %s' % self._elapsedTime()
289
print >>self.stream, ' SKIP %s' % self._testTimeString()
155
290
print >>self.stream, ' %s' % skip_excinfo[1]
291
elif self.dots and self.pb is None:
157
292
self.stream.write('S')
294
self.pb.update(self._ellipsise_unimportant_words('SKIP', 13), self.testsRun, None)
158
295
self.stream.flush()
159
296
# seems best to treat this as success from point-of-view of unittest
160
297
# -- it actually does nothing so it barely matters :)
161
unittest.TestResult.addSuccess(self, test)
300
except KeyboardInterrupt:
303
self.addError(test, test.__exc_info())
305
unittest.TestResult.addSuccess(self, test)
163
307
def printErrorList(self, flavour, errors):
164
308
for test, err in errors:
165
309
self.stream.writeln(self.separator1)
166
self.stream.writeln("%s: %s" % (flavour,self.getDescription(test)))
167
if hasattr(test, '_get_log'):
310
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
311
if getattr(test, '_get_log', None) is not None:
168
312
print >>self.stream
169
313
print >>self.stream, \
170
('vvvv[log from %s]' % test).ljust(78,'-')
314
('vvvv[log from %s]' % test.id()).ljust(78,'-')
171
315
print >>self.stream, test._get_log()
172
316
print >>self.stream, \
173
('^^^^[log from %s]' % test).ljust(78,'-')
317
('^^^^[log from %s]' % test.id()).ljust(78,'-')
174
318
self.stream.writeln(self.separator2)
175
319
self.stream.writeln("%s" % err)
178
class TextTestRunner(unittest.TextTestRunner):
322
class TextTestRunner(object):
179
323
stop_on_failure = False
332
self.stream = unittest._WritelnDecorator(stream)
333
self.descriptions = descriptions
334
self.verbosity = verbosity
335
self.keep_output = keep_output
337
self._bench_history = bench_history
181
339
def _makeResult(self):
182
result = _MyResult(self.stream, self.descriptions, self.verbosity)
183
if self.stop_on_failure:
184
result = EarlyStoppingTestResultAdapter(result)
340
result = _MyResult(self.stream,
344
bench_history=self._bench_history)
345
result.stop_early = self.stop_on_failure
349
"Run the given test case or test suite."
350
result = self._makeResult()
351
startTime = time.time()
352
if self.pb is not None:
353
self.pb.update('Running tests', 0, test.countTestCases())
355
stopTime = time.time()
356
timeTaken = stopTime - startTime
358
self.stream.writeln(result.separator2)
359
run = result.testsRun
360
self.stream.writeln("Ran %d test%s in %.3fs" %
361
(run, run != 1 and "s" or "", timeTaken))
362
self.stream.writeln()
363
if not result.wasSuccessful():
364
self.stream.write("FAILED (")
365
failed, errored = map(len, (result.failures, result.errors))
367
self.stream.write("failures=%d" % failed)
369
if failed: self.stream.write(", ")
370
self.stream.write("errors=%d" % errored)
371
self.stream.writeln(")")
373
self.stream.writeln("OK")
374
if self.pb is not None:
375
self.pb.update('Cleaning up', 0, 1)
376
# This is still a little bogus,
377
# but only a little. Folk not using our testrunner will
378
# have to delete their temp directories themselves.
379
test_root = TestCaseInTempDir.TEST_ROOT
380
if result.wasSuccessful() or not self.keep_output:
381
if test_root is not None:
382
# If LANG=C we probably have created some bogus paths
383
# which rmtree(unicode) will fail to delete
384
# so make sure we are using rmtree(str) to delete everything
385
# except on win32, where rmtree(str) will fail
386
# since it doesn't have the property of byte-stream paths
387
# (they are either ascii or mbcs)
388
if sys.platform == 'win32':
389
# make sure we are using the unicode win32 api
390
test_root = unicode(test_root)
392
test_root = test_root.encode(
393
sys.getfilesystemencoding())
394
osutils.rmtree(test_root)
396
if self.pb is not None:
397
self.pb.note("Failed tests working directories are in '%s'\n",
401
"Failed tests working directories are in '%s'\n" %
403
TestCaseInTempDir.TEST_ROOT = None
404
if self.pb is not None:
289
555
raise AssertionError("value(s) %r not present in container %r" %
290
556
(missing, superlist))
558
def assertIs(self, left, right):
559
if not (left is right):
560
raise AssertionError("%r is not %r." % (left, right))
562
def assertTransportMode(self, transport, path, mode):
563
"""Fail if a path does not have mode mode.
565
If modes are not supported on this transport, the assertion is ignored.
567
if not transport._can_roundtrip_unix_modebits():
569
path_stat = transport.stat(path)
570
actual_mode = stat.S_IMODE(path_stat.st_mode)
571
self.assertEqual(mode, actual_mode,
572
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
574
def assertIsInstance(self, obj, kls):
575
"""Fail if obj is not an instance of kls"""
576
if not isinstance(obj, kls):
577
self.fail("%r is an instance of %s rather than %s" % (
578
obj, obj.__class__, kls))
580
def callDeprecated(self, expected, callable, *args, **kwargs):
581
"""Assert that a callable is deprecated in a particular way.
583
:param expected: a list of the deprecation warnings expected, in order
584
:param callable: The callable to call
585
:param args: The positional arguments for the callable
586
:param kwargs: The keyword arguments for the callable
589
def capture_warnings(msg, cls, stacklevel=None):
590
self.assertEqual(cls, DeprecationWarning)
591
local_warnings.append(msg)
592
method = symbol_versioning.warn
593
symbol_versioning.set_warning_method(capture_warnings)
595
result = callable(*args, **kwargs)
597
symbol_versioning.set_warning_method(method)
598
self.assertEqual(expected, local_warnings)
292
601
def _startLogFile(self):
293
602
"""Send bzr and test log messages to a temporary file.
295
604
The file is removed as the test is torn down.
297
606
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
298
encoder, decoder, stream_reader, stream_writer = codecs.lookup('UTF-8')
299
self._log_file = stream_writer(os.fdopen(fileno, 'w+'))
300
bzrlib.trace.enable_test_log(self._log_file)
607
self._log_file = os.fdopen(fileno, 'w+')
608
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
301
609
self._log_file_name = name
302
610
self.addCleanup(self._finishLogFile)
402
737
errors, and with logging set to something approximating the
403
738
default, so that error reporting can be checked.
405
argv -- arguments to invoke bzr
406
retcode -- expected return code, or None for don't-care.
740
:param argv: arguments to invoke bzr
741
:param retcode: expected return code, or None for don't-care.
742
:param encoding: encoding for sys.stdout and sys.stderr
743
:param stdin: A string to be used as stdin for the command.
410
self.log('run bzr: %s', ' '.join(argv))
746
encoding = bzrlib.user_encoding
747
if stdin is not None:
748
stdin = StringIO(stdin)
749
stdout = StringIOWrapper()
750
stderr = StringIOWrapper()
751
stdout.encoding = encoding
752
stderr.encoding = encoding
754
self.log('run bzr: %r', argv)
411
755
# FIXME: don't call into logging here
412
756
handler = logging.StreamHandler(stderr)
413
handler.setFormatter(bzrlib.trace.QuietFormatter())
414
757
handler.setLevel(logging.INFO)
415
758
logger = logging.getLogger('')
416
759
logger.addHandler(handler)
760
old_ui_factory = bzrlib.ui.ui_factory
761
bzrlib.ui.ui_factory = bzrlib.tests.blackbox.TestUIFactory(
764
bzrlib.ui.ui_factory.stdin = stdin
418
result = self.apply_redirected(None, stdout, stderr,
766
result = self.apply_redirected(stdin, stdout, stderr,
419
767
bzrlib.commands.run_bzr_catch_errors,
422
770
logger.removeHandler(handler)
771
bzrlib.ui.ui_factory = old_ui_factory
423
773
out = stdout.getvalue()
424
774
err = stderr.getvalue()
426
self.log('output:\n%s', out)
776
self.log('output:\n%r', out)
428
self.log('errors:\n%s', err)
778
self.log('errors:\n%r', err)
429
779
if retcode is not None:
430
self.assertEquals(result, retcode)
780
self.assertEquals(retcode, result)
433
783
def run_bzr(self, *args, **kwargs):
440
790
This sends the stdout/stderr results into the test's log,
441
791
where it may be useful for debugging. See also run_captured.
793
:param stdin: A string to be used as stdin for the command.
443
795
retcode = kwargs.pop('retcode', 0)
444
return self.run_bzr_captured(args, retcode)
796
encoding = kwargs.pop('encoding', None)
797
stdin = kwargs.pop('stdin', None)
798
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding, stdin=stdin)
800
def run_bzr_decode(self, *args, **kwargs):
801
if kwargs.has_key('encoding'):
802
encoding = kwargs['encoding']
804
encoding = bzrlib.user_encoding
805
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
807
def run_bzr_error(self, error_regexes, *args, **kwargs):
808
"""Run bzr, and check that stderr contains the supplied regexes
810
:param error_regexes: Sequence of regular expressions which
811
must each be found in the error output. The relative ordering
813
:param args: command-line arguments for bzr
814
:param kwargs: Keyword arguments which are interpreted by run_bzr
815
This function changes the default value of retcode to be 3,
816
since in most cases this is run when you expect bzr to fail.
817
:return: (out, err) The actual output of running the command (in case you
818
want to do more inspection)
821
# Make sure that commit is failing because there is nothing to do
822
self.run_bzr_error(['no changes to commit'],
823
'commit', '-m', 'my commit comment')
824
# Make sure --strict is handling an unknown file, rather than
825
# giving us the 'nothing to do' error
826
self.build_tree(['unknown'])
827
self.run_bzr_error(['Commit refused because there are unknown files'],
828
'commit', '--strict', '-m', 'my commit comment')
830
kwargs.setdefault('retcode', 3)
831
out, err = self.run_bzr(*args, **kwargs)
832
for regex in error_regexes:
833
self.assertContainsRe(err, regex)
836
def run_bzr_subprocess(self, *args, **kwargs):
837
"""Run bzr in a subprocess for testing.
839
This starts a new Python interpreter and runs bzr in there.
840
This should only be used for tests that have a justifiable need for
841
this isolation: e.g. they are testing startup time, or signal
842
handling, or early startup code, etc. Subprocess code can't be
843
profiled or debugged so easily.
845
:param retcode: The status code that is expected. Defaults to 0. If
846
None is supplied, the status code is not checked.
848
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
850
process = Popen([sys.executable, bzr_path]+args, stdout=PIPE,
852
out = process.stdout.read()
853
err = process.stderr.read()
854
retcode = process.wait()
855
supplied_retcode = kwargs.get('retcode', 0)
856
if supplied_retcode is not None:
857
assert supplied_retcode == retcode
446
860
def check_inventory_shape(self, inv, shape):
447
861
"""Compare an inventory to a list of expected names.
544
974
# make a fake bzr directory there to prevent any tests propagating
545
975
# up onto the source directory's real branch
546
os.mkdir(osutils.pathjoin(TestCaseInTempDir.TEST_ROOT, '.bzr'))
976
bzrdir.BzrDir.create_standalone_workingtree(TestCaseInTempDir.TEST_ROOT)
549
979
super(TestCaseInTempDir, self).setUp()
550
980
self._make_test_root()
551
981
_currentdir = os.getcwdu()
982
# shorten the name, to avoid test failures due to path length
552
983
short_id = self.id().replace('bzrlib.tests.', '') \
553
.replace('__main__.', '')
554
self.test_dir = osutils.pathjoin(self.TEST_ROOT, short_id)
555
os.mkdir(self.test_dir)
556
os.chdir(self.test_dir)
984
.replace('__main__.', '')[-100:]
985
# it's possible the same test class is run several times for
986
# parameterized tests, so make sure the names don't collide.
990
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
992
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
993
if os.path.exists(candidate_dir):
997
self.test_dir = candidate_dir
998
os.mkdir(self.test_dir)
999
os.chdir(self.test_dir)
557
1001
os.environ['HOME'] = self.test_dir
558
1002
os.environ['APPDATA'] = self.test_dir
559
1003
def _leaveDirectory():
560
1004
os.chdir(_currentdir)
561
1005
self.addCleanup(_leaveDirectory)
563
def build_tree(self, shape, line_endings='native'):
1007
def build_tree(self, shape, line_endings='native', transport=None):
564
1008
"""Build a test tree according to a pattern.
566
1010
shape is a sequence of file specifications. If the final
567
1011
character is '/', a directory is created.
1013
This assumes that all the elements in the tree being built are new.
569
1015
This doesn't add anything to a branch.
570
1016
:param line_endings: Either 'binary' or 'native'
571
1017
in binary mode, exact contents are written
572
1018
in native mode, the line endings match the
573
1019
default platform endings.
1021
:param transport: A transport to write to, for building trees on
1022
VFS's. If the transport is readonly or None,
1023
"." is opened automatically.
575
# XXX: It's OK to just create them using forward slashes on windows?
1025
# It's OK to just create them using forward slashes on windows.
1026
if transport is None or transport.is_readonly():
1027
transport = get_transport(".")
576
1028
for name in shape:
577
1029
self.assert_(isinstance(name, basestring))
578
1030
if name[-1] == '/':
1031
transport.mkdir(urlutils.escape(name[:-1]))
581
1033
if line_endings == 'binary':
583
1035
elif line_endings == 'native':
586
raise BzrError('Invalid line ending request %r' % (line_endings,))
587
print >>f, "contents of", name
1038
raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
1039
content = "contents of %s%s" % (name.encode('utf-8'), end)
1040
# Technically 'put()' is the right command. However, put
1041
# uses an AtomicFile, which requires an extra rename into place
1042
# As long as the files didn't exist in the past, append() will
1043
# do the same thing as put()
1044
# On jam's machine, make_kernel_like_tree is:
1045
# put: 4.5-7.5s (averaging 6s)
1047
transport.append(urlutils.escape(name), StringIO(content))
590
1049
def build_tree_contents(self, shape):
591
1050
build_tree_contents(shape)
601
1060
def assertFileEqual(self, content, path):
602
1061
"""Fail if path does not contain 'content'."""
603
1062
self.failUnless(osutils.lexists(path))
1063
# TODO: jam 20060427 Shouldn't this be 'rb'?
604
1064
self.assertEqualDiff(content, open(path, 'r').read())
1067
class TestCaseWithTransport(TestCaseInTempDir):
1068
"""A test case that provides get_url and get_readonly_url facilities.
1070
These back onto two transport servers, one for readonly access and one for
1073
If no explicit class is provided for readonly access, a
1074
ReadonlyTransportDecorator is used instead which allows the use of non disk
1075
based read write transports.
1077
If an explicit class is provided for readonly access, that server and the
1078
readwrite one must both define get_url() as resolving to os.getcwd().
1081
def __init__(self, methodName='testMethod'):
1082
super(TestCaseWithTransport, self).__init__(methodName)
1083
self.__readonly_server = None
1084
self.__server = None
1085
self.transport_server = default_transport
1086
self.transport_readonly_server = None
1088
def get_readonly_url(self, relpath=None):
1089
"""Get a URL for the readonly transport.
1091
This will either be backed by '.' or a decorator to the transport
1092
used by self.get_url()
1093
relpath provides for clients to get a path relative to the base url.
1094
These should only be downwards relative, not upwards.
1096
base = self.get_readonly_server().get_url()
1097
if relpath is not None:
1098
if not base.endswith('/'):
1100
base = base + relpath
1103
def get_readonly_server(self):
1104
"""Get the server instance for the readonly transport
1106
This is useful for some tests with specific servers to do diagnostics.
1108
if self.__readonly_server is None:
1109
if self.transport_readonly_server is None:
1110
# readonly decorator requested
1111
# bring up the server
1113
self.__readonly_server = ReadonlyServer()
1114
self.__readonly_server.setUp(self.__server)
1116
self.__readonly_server = self.transport_readonly_server()
1117
self.__readonly_server.setUp()
1118
self.addCleanup(self.__readonly_server.tearDown)
1119
return self.__readonly_server
1121
def get_server(self):
1122
"""Get the read/write server instance.
1124
This is useful for some tests with specific servers that need
1127
if self.__server is None:
1128
self.__server = self.transport_server()
1129
self.__server.setUp()
1130
self.addCleanup(self.__server.tearDown)
1131
return self.__server
1133
def get_url(self, relpath=None):
1134
"""Get a URL for the readwrite transport.
1136
This will either be backed by '.' or to an equivalent non-file based
1138
relpath provides for clients to get a path relative to the base url.
1139
These should only be downwards relative, not upwards.
1141
base = self.get_server().get_url()
1142
if relpath is not None and relpath != '.':
1143
if not base.endswith('/'):
1145
base = base + urlutils.escape(relpath)
1148
def get_transport(self):
1149
"""Return a writeable transport for the test scratch space"""
1150
t = get_transport(self.get_url())
1151
self.assertFalse(t.is_readonly())
1154
def get_readonly_transport(self):
1155
"""Return a readonly transport for the test scratch space
1157
This can be used to test that operations which should only need
1158
readonly access in fact do not try to write.
1160
t = get_transport(self.get_readonly_url())
1161
self.assertTrue(t.is_readonly())
1164
def make_branch(self, relpath, format=None):
1165
"""Create a branch on the transport at relpath."""
1166
repo = self.make_repository(relpath, format=format)
1167
return repo.bzrdir.create_branch()
1169
def make_bzrdir(self, relpath, format=None):
1171
url = self.get_url(relpath)
1172
mutter('relpath %r => url %r', relpath, url)
1173
segments = url.split('/')
1174
if segments and segments[-1] not in ('', '.'):
1175
parent = '/'.join(segments[:-1])
1176
t = get_transport(parent)
1178
t.mkdir(segments[-1])
1179
except errors.FileExists:
1182
format=bzrlib.bzrdir.BzrDirFormat.get_default_format()
1183
# FIXME: make this use a single transport someday. RBC 20060418
1184
return format.initialize_on_transport(get_transport(relpath))
1185
except errors.UninitializableFormat:
1186
raise TestSkipped("Format %s is not initializable." % format)
1188
def make_repository(self, relpath, shared=False, format=None):
1189
"""Create a repository on our default transport at relpath."""
1190
made_control = self.make_bzrdir(relpath, format=format)
1191
return made_control.create_repository(shared=shared)
1193
def make_branch_and_tree(self, relpath, format=None):
1194
"""Create a branch on the transport and a tree locally.
1198
# TODO: always use the local disk path for the working tree,
1199
# this obviously requires a format that supports branch references
1200
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1202
b = self.make_branch(relpath, format=format)
1204
return b.bzrdir.create_workingtree()
1205
except errors.NotLocalUrl:
1206
# new formats - catch No tree error and create
1207
# a branch reference and a checkout.
1208
# old formats at that point - raise TestSkipped.
1209
# TODO: rbc 20060208
1210
return WorkingTreeFormat2().initialize(bzrdir.BzrDir.open(relpath))
1212
def assertIsDirectory(self, relpath, transport):
1213
"""Assert that relpath within transport is a directory.
1215
This may not be possible on all transports; in that case it propagates
1216
a TransportNotPossible.
1219
mode = transport.stat(relpath).st_mode
1220
except errors.NoSuchFile:
1221
self.fail("path %s is not a directory; no such file"
1223
if not stat.S_ISDIR(mode):
1224
self.fail("path %s is not a directory; has mode %#o"
1228
class ChrootedTestCase(TestCaseWithTransport):
1229
"""A support class that provides readonly urls outside the local namespace.
1231
This is done by checking if self.transport_server is a MemoryServer. if it
1232
is then we are chrooted already, if it is not then an HttpServer is used
1235
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1236
be used without needed to redo it when a different
1237
subclass is in use ?
1241
super(ChrootedTestCase, self).setUp()
1242
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
1243
self.transport_readonly_server = bzrlib.transport.http.HttpServer
607
1246
def filter_suite_by_re(suite, pattern):
1247
result = TestUtil.TestSuite()
609
1248
filter_re = re.compile(pattern)
610
1249
for test in iter_suite_tests(suite):
611
1250
if filter_re.search(test.id()):
616
1255
def run_suite(suite, name='test', verbose=False, pattern=".*",
617
stop_on_failure=False, keep_output=False):
1256
stop_on_failure=False, keep_output=False,
1257
transport=None, lsprof_timed=None, bench_history=None):
618
1258
TestCaseInTempDir._TEST_NAME = name
1259
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1265
pb = progress.ProgressBar()
623
1266
runner = TextTestRunner(stream=sys.stdout,
1268
verbosity=verbosity,
1269
keep_output=keep_output,
1271
bench_history=bench_history)
626
1272
runner.stop_on_failure=stop_on_failure
627
1273
if pattern != '.*':
628
1274
suite = filter_suite_by_re(suite, pattern)
629
1275
result = runner.run(suite)
630
# This is still a little bogus,
631
# but only a little. Folk not using our testrunner will
632
# have to delete their temp directories themselves.
633
if result.wasSuccessful() or not keep_output:
634
if TestCaseInTempDir.TEST_ROOT is not None:
635
shutil.rmtree(TestCaseInTempDir.TEST_ROOT)
637
print "Failed tests working directories are in '%s'\n" % TestCaseInTempDir.TEST_ROOT
638
1276
return result.wasSuccessful()
641
1279
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1282
test_suite_factory=None,
1284
bench_history=None):
643
1285
"""Run the whole test suite under the enhanced runner"""
644
return run_suite(test_suite(), 'testbzr', verbose=verbose, pattern=pattern,
645
stop_on_failure=stop_on_failure, keep_output=keep_output)
1286
# XXX: Very ugly way to do this...
1287
# Disable warning about old formats because we don't want it to disturb
1288
# any blackbox tests.
1289
from bzrlib import repository
1290
repository._deprecation_warning_done = True
1292
global default_transport
1293
if transport is None:
1294
transport = default_transport
1295
old_transport = default_transport
1296
default_transport = transport
1298
if test_suite_factory is None:
1299
suite = test_suite()
1301
suite = test_suite_factory()
1302
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1303
stop_on_failure=stop_on_failure, keep_output=keep_output,
1304
transport=transport,
1305
lsprof_timed=lsprof_timed,
1306
bench_history=bench_history)
1308
default_transport = old_transport
648
1311
def test_suite():
649
"""Build and return TestSuite for the whole program."""
650
from doctest import DocTestSuite
652
global MODULES_TO_DOCTEST
1312
"""Build and return TestSuite for the whole of bzrlib.
1314
This function can be replaced if you need to change the default test
1315
suite on a global basis, but it is not encouraged.
655
1318
'bzrlib.tests.test_ancestry',
656
'bzrlib.tests.test_annotate',
657
1319
'bzrlib.tests.test_api',
1320
'bzrlib.tests.test_atomicfile',
658
1321
'bzrlib.tests.test_bad_files',
659
'bzrlib.tests.test_basis_inventory',
660
1322
'bzrlib.tests.test_branch',
1323
'bzrlib.tests.test_bundle',
1324
'bzrlib.tests.test_bzrdir',
1325
'bzrlib.tests.test_cache_utf8',
661
1326
'bzrlib.tests.test_command',
662
1327
'bzrlib.tests.test_commit',
663
1328
'bzrlib.tests.test_commit_merge',
664
1329
'bzrlib.tests.test_config',
665
1330
'bzrlib.tests.test_conflicts',
1331
'bzrlib.tests.test_decorators',
666
1332
'bzrlib.tests.test_diff',
1333
'bzrlib.tests.test_doc_generate',
1334
'bzrlib.tests.test_errors',
1335
'bzrlib.tests.test_escaped_store',
667
1336
'bzrlib.tests.test_fetch',
668
1337
'bzrlib.tests.test_gpg',
669
1338
'bzrlib.tests.test_graph',
670
1339
'bzrlib.tests.test_hashcache',
671
1340
'bzrlib.tests.test_http',
1341
'bzrlib.tests.test_http_response',
672
1342
'bzrlib.tests.test_identitymap',
1343
'bzrlib.tests.test_ignores',
673
1344
'bzrlib.tests.test_inv',
1345
'bzrlib.tests.test_knit',
1346
'bzrlib.tests.test_lockdir',
1347
'bzrlib.tests.test_lockable_files',
674
1348
'bzrlib.tests.test_log',
675
1349
'bzrlib.tests.test_merge',
676
1350
'bzrlib.tests.test_merge3',
680
1354
'bzrlib.tests.test_nonascii',
681
1355
'bzrlib.tests.test_options',
682
1356
'bzrlib.tests.test_osutils',
683
'bzrlib.tests.test_parent',
1357
'bzrlib.tests.test_patch',
1358
'bzrlib.tests.test_patches',
684
1359
'bzrlib.tests.test_permissions',
685
1360
'bzrlib.tests.test_plugins',
686
'bzrlib.tests.test_remove',
1361
'bzrlib.tests.test_progress',
1362
'bzrlib.tests.test_reconcile',
1363
'bzrlib.tests.test_repository',
1364
'bzrlib.tests.test_revert',
687
1365
'bzrlib.tests.test_revision',
688
1366
'bzrlib.tests.test_revisionnamespaces',
689
'bzrlib.tests.test_revprops',
690
'bzrlib.tests.test_reweave',
1367
'bzrlib.tests.test_revisiontree',
691
1368
'bzrlib.tests.test_rio',
692
1369
'bzrlib.tests.test_sampler',
693
1370
'bzrlib.tests.test_selftest',
694
1371
'bzrlib.tests.test_setup',
695
1372
'bzrlib.tests.test_sftp_transport',
1373
'bzrlib.tests.test_ftp_transport',
696
1374
'bzrlib.tests.test_smart_add',
697
1375
'bzrlib.tests.test_source',
698
1376
'bzrlib.tests.test_status',
699
1377
'bzrlib.tests.test_store',
700
1378
'bzrlib.tests.test_symbol_versioning',
701
1379
'bzrlib.tests.test_testament',
1380
'bzrlib.tests.test_textfile',
1381
'bzrlib.tests.test_textmerge',
702
1382
'bzrlib.tests.test_trace',
703
1383
'bzrlib.tests.test_transactions',
1384
'bzrlib.tests.test_transform',
704
1385
'bzrlib.tests.test_transport',
1386
'bzrlib.tests.test_tree',
705
1387
'bzrlib.tests.test_tsort',
1388
'bzrlib.tests.test_tuned_gzip',
706
1389
'bzrlib.tests.test_ui',
707
'bzrlib.tests.test_uncommit',
708
1390
'bzrlib.tests.test_upgrade',
1391
'bzrlib.tests.test_urlutils',
1392
'bzrlib.tests.test_versionedfile',
1393
'bzrlib.tests.test_version',
709
1394
'bzrlib.tests.test_weave',
710
1395
'bzrlib.tests.test_whitebox',
711
1396
'bzrlib.tests.test_workingtree',
712
1397
'bzrlib.tests.test_xml',
715
TestCase.BZRPATH = osutils.pathjoin(
716
osutils.realpath(osutils.dirname(bzrlib.__path__[0])), 'bzr')
717
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
718
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
721
# python2.4's TestLoader.loadTestsFromNames gives very poor
722
# errors if it fails to load a named module - no indication of what's
723
# actually wrong, just "no such module". We should probably override that
724
# class, but for the moment just load them ourselves. (mbp 20051202)
725
loader = TestLoader()
726
for mod_name in testmod_names:
727
mod = _load_module_by_name(mod_name)
728
suite.addTest(loader.loadTestsFromModule(mod))
1399
test_transport_implementations = [
1400
'bzrlib.tests.test_transport_implementations',
1401
'bzrlib.tests.test_read_bundle',
1403
suite = TestUtil.TestSuite()
1404
loader = TestUtil.TestLoader()
1405
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1406
from bzrlib.transport import TransportTestProviderAdapter
1407
adapter = TransportTestProviderAdapter()
1408
adapt_modules(test_transport_implementations, adapter, loader, suite)
729
1409
for package in packages_to_test():
730
1410
suite.addTest(package.test_suite())
731
1411
for m in MODULES_TO_TEST:
732
1412
suite.addTest(loader.loadTestsFromModule(m))
733
for m in (MODULES_TO_DOCTEST):
734
suite.addTest(DocTestSuite(m))
1413
for m in MODULES_TO_DOCTEST:
1414
suite.addTest(doctest.DocTestSuite(m))
735
1415
for name, plugin in bzrlib.plugin.all_plugins().items():
736
if hasattr(plugin, 'test_suite'):
1416
if getattr(plugin, 'test_suite', None) is not None:
737
1417
suite.addTest(plugin.test_suite())
741
def _load_module_by_name(mod_name):
742
parts = mod_name.split('.')
743
module = __import__(mod_name)
745
# for historical reasons python returns the top-level module even though
746
# it loads the submodule; we need to walk down to get the one we want.
748
module = getattr(module, parts.pop(0))
1421
def adapt_modules(mods_list, adapter, loader, suite):
1422
"""Adapt the modules in mods_list using adapter and add to suite."""
1423
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1424
suite.addTests(adapter.adapt(test))
added
removed
bzrlib/tests/__init__.py
