102
136
bzrlib.tests.bzrdir_implementations,
103
137
bzrlib.tests.interrepository_implementations,
104
138
bzrlib.tests.interversionedfile_implementations,
139
bzrlib.tests.intertree_implementations,
140
bzrlib.tests.per_lock,
105
141
bzrlib.tests.repository_implementations,
106
142
bzrlib.tests.revisionstore_implementations,
143
bzrlib.tests.tree_implementations,
107
144
bzrlib.tests.workingtree_implementations,
111
class _MyResult(unittest._TextTestResult):
112
"""Custom TestResult.
148
class ExtendedTestResult(unittest._TextTestResult):
149
"""Accepts, reports and accumulates the results of running tests.
114
Shows output in a different format, including displaying runtime for tests.
151
Compared to this unittest version this class adds support for profiling,
152
benchmarking, stopping as soon as a test fails, and skipping tests.
153
There are further-specialized subclasses for different types of display.
116
156
stop_early = False
118
def _elapsedTime(self):
119
return "%5dms" % (1000 * (time.time() - self._start_time))
158
def __init__(self, stream, descriptions, verbosity,
161
use_numbered_dirs=False,
163
"""Construct new TestResult.
165
:param bench_history: Optionally, a writable file object to accumulate
168
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
169
if bench_history is not None:
170
from bzrlib.version import _get_bzr_source_tree
171
src_tree = _get_bzr_source_tree()
174
revision_id = src_tree.get_parent_ids()[0]
176
# XXX: if this is a brand new tree, do the same as if there
180
# XXX: If there's no branch, what should we do?
182
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
183
self._bench_history = bench_history
184
self.ui = ui.ui_factory
185
self.num_tests = num_tests
187
self.failure_count = 0
188
self.known_failure_count = 0
190
self.unsupported = {}
192
self.use_numbered_dirs = use_numbered_dirs
193
self._overall_start_time = time.time()
195
def extractBenchmarkTime(self, testCase):
196
"""Add a benchmark time for the current test case."""
197
self._benchmarkTime = getattr(testCase, "_benchtime", None)
199
def _elapsedTestTimeString(self):
200
"""Return a time string for the overall time the current test has taken."""
201
return self._formatTime(time.time() - self._start_time)
203
def _testTimeString(self):
204
if self._benchmarkTime is not None:
206
self._formatTime(self._benchmarkTime),
207
self._elapsedTestTimeString())
209
return " %s" % self._elapsedTestTimeString()
211
def _formatTime(self, seconds):
212
"""Format seconds as milliseconds with leading spaces."""
213
# some benchmarks can take thousands of seconds to run, so we need 8
215
return "%8dms" % (1000 * seconds)
217
def _shortened_test_description(self, test):
219
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
121
222
def startTest(self, test):
122
223
unittest.TestResult.startTest(self, test)
123
# In a short description, the important words are in
124
# the beginning, but in an id, the important words are
126
SHOW_DESCRIPTIONS = False
128
width = osutils.terminal_width()
129
name_width = width - 15
131
if SHOW_DESCRIPTIONS:
132
what = test.shortDescription()
134
if len(what) > name_width:
135
what = what[:name_width-3] + '...'
138
if what.startswith('bzrlib.tests.'):
140
if len(what) > name_width:
141
what = '...' + what[3-name_width:]
142
what = what.ljust(name_width)
143
self.stream.write(what)
224
self.report_test_start(test)
225
test.number = self.count
226
self._recordTestStartTime()
228
def _recordTestStartTime(self):
229
"""Record that a test has started."""
145
230
self._start_time = time.time()
232
def _cleanupLogFile(self, test):
233
# We can only do this if we have one of our TestCases, not if
235
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
236
if setKeepLogfile is not None:
147
239
def addError(self, test, err):
240
self.extractBenchmarkTime(test)
241
self._cleanupLogFile(test)
148
242
if isinstance(err[1], TestSkipped):
149
return self.addSkipped(test, err)
243
return self.addSkipped(test, err)
244
elif isinstance(err[1], UnavailableFeature):
245
return self.addNotSupported(test, err[1].args[0])
150
246
unittest.TestResult.addError(self, test, err)
152
self.stream.writeln("ERROR %s" % self._elapsedTime())
154
self.stream.write('E')
247
self.error_count += 1
248
self.report_error(test, err)
156
249
if self.stop_early:
159
252
def addFailure(self, test, err):
253
self._cleanupLogFile(test)
254
self.extractBenchmarkTime(test)
255
if isinstance(err[1], KnownFailure):
256
return self.addKnownFailure(test, err)
160
257
unittest.TestResult.addFailure(self, test, err)
162
self.stream.writeln(" FAIL %s" % self._elapsedTime())
164
self.stream.write('F')
258
self.failure_count += 1
259
self.report_failure(test, err)
166
260
if self.stop_early:
263
def addKnownFailure(self, test, err):
264
self.known_failure_count += 1
265
self.report_known_failure(test, err)
267
def addNotSupported(self, test, feature):
268
self.unsupported.setdefault(str(feature), 0)
269
self.unsupported[str(feature)] += 1
270
self.report_unsupported(test, feature)
169
272
def addSuccess(self, test):
171
self.stream.writeln(' OK %s' % self._elapsedTime())
173
self.stream.write('~')
273
self.extractBenchmarkTime(test)
274
if self._bench_history is not None:
275
if self._benchmarkTime is not None:
276
self._bench_history.write("%s %s\n" % (
277
self._formatTime(self._benchmarkTime),
279
self.report_success(test)
175
280
unittest.TestResult.addSuccess(self, test)
177
282
def addSkipped(self, test, skip_excinfo):
179
print >>self.stream, ' SKIP %s' % self._elapsedTime()
180
print >>self.stream, ' %s' % skip_excinfo[1]
182
self.stream.write('S')
283
self.report_skip(test, skip_excinfo)
184
284
# seems best to treat this as success from point-of-view of unittest
185
285
# -- it actually does nothing so it barely matters :)
186
unittest.TestResult.addSuccess(self, test)
288
except KeyboardInterrupt:
291
self.addError(test, test.__exc_info())
293
unittest.TestResult.addSuccess(self, test)
188
295
def printErrorList(self, flavour, errors):
189
296
for test, err in errors:
190
297
self.stream.writeln(self.separator1)
191
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
298
self.stream.write("%s: " % flavour)
299
if self.use_numbered_dirs:
300
self.stream.write('#%d ' % test.number)
301
self.stream.writeln(self.getDescription(test))
192
302
if getattr(test, '_get_log', None) is not None:
193
303
print >>self.stream
194
304
print >>self.stream, \
199
309
self.stream.writeln(self.separator2)
200
310
self.stream.writeln("%s" % err)
203
class TextTestRunner(unittest.TextTestRunner):
315
def report_cleaning_up(self):
318
def report_success(self, test):
322
class TextTestResult(ExtendedTestResult):
323
"""Displays progress and results of tests in text form"""
325
def __init__(self, stream, descriptions, verbosity,
329
use_numbered_dirs=False,
331
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
332
bench_history, num_tests, use_numbered_dirs)
334
self.pb = self.ui.nested_progress_bar()
335
self._supplied_pb = False
338
self._supplied_pb = True
339
self.pb.show_pct = False
340
self.pb.show_spinner = False
341
self.pb.show_eta = False,
342
self.pb.show_count = False
343
self.pb.show_bar = False
345
def report_starting(self):
346
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
348
def _progress_prefix_text(self):
349
a = '[%d' % self.count
350
if self.num_tests is not None:
351
a +='/%d' % self.num_tests
352
a += ' in %ds' % (time.time() - self._overall_start_time)
354
a += ', %d errors' % self.error_count
355
if self.failure_count:
356
a += ', %d failed' % self.failure_count
357
if self.known_failure_count:
358
a += ', %d known failures' % self.known_failure_count
360
a += ', %d skipped' % self.skip_count
362
a += ', %d missing features' % len(self.unsupported)
366
def report_test_start(self, test):
369
self._progress_prefix_text()
371
+ self._shortened_test_description(test))
373
def _test_description(self, test):
374
if self.use_numbered_dirs:
375
return '#%d %s' % (self.count,
376
self._shortened_test_description(test))
378
return self._shortened_test_description(test)
380
def report_error(self, test, err):
381
self.pb.note('ERROR: %s\n %s\n',
382
self._test_description(test),
386
def report_failure(self, test, err):
387
self.pb.note('FAIL: %s\n %s\n',
388
self._test_description(test),
392
def report_known_failure(self, test, err):
393
self.pb.note('XFAIL: %s\n%s\n',
394
self._test_description(test), err[1])
396
def report_skip(self, test, skip_excinfo):
399
# at the moment these are mostly not things we can fix
400
# and so they just produce stipple; use the verbose reporter
403
# show test and reason for skip
404
self.pb.note('SKIP: %s\n %s\n',
405
self._shortened_test_description(test),
408
# since the class name was left behind in the still-visible
410
self.pb.note('SKIP: %s', skip_excinfo[1])
412
def report_unsupported(self, test, feature):
413
"""test cannot be run because feature is missing."""
415
def report_cleaning_up(self):
416
self.pb.update('cleaning up...')
419
if not self._supplied_pb:
423
class VerboseTestResult(ExtendedTestResult):
424
"""Produce long output, with one line per test run plus times"""
426
def _ellipsize_to_right(self, a_string, final_width):
427
"""Truncate and pad a string, keeping the right hand side"""
428
if len(a_string) > final_width:
429
result = '...' + a_string[3-final_width:]
432
return result.ljust(final_width)
434
def report_starting(self):
435
self.stream.write('running %d tests...\n' % self.num_tests)
437
def report_test_start(self, test):
439
name = self._shortened_test_description(test)
440
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
441
# numbers, plus a trailing blank
442
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
443
if self.use_numbered_dirs:
444
self.stream.write('%5d ' % self.count)
445
self.stream.write(self._ellipsize_to_right(name,
446
osutils.terminal_width()-36))
448
self.stream.write(self._ellipsize_to_right(name,
449
osutils.terminal_width()-30))
452
def _error_summary(self, err):
454
if self.use_numbered_dirs:
456
return '%s%s' % (indent, err[1])
458
def report_error(self, test, err):
459
self.stream.writeln('ERROR %s\n%s'
460
% (self._testTimeString(),
461
self._error_summary(err)))
463
def report_failure(self, test, err):
464
self.stream.writeln(' FAIL %s\n%s'
465
% (self._testTimeString(),
466
self._error_summary(err)))
468
def report_known_failure(self, test, err):
469
self.stream.writeln('XFAIL %s\n%s'
470
% (self._testTimeString(),
471
self._error_summary(err)))
473
def report_success(self, test):
474
self.stream.writeln(' OK %s' % self._testTimeString())
475
for bench_called, stats in getattr(test, '_benchcalls', []):
476
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
477
stats.pprint(file=self.stream)
478
# flush the stream so that we get smooth output. This verbose mode is
479
# used to show the output in PQM.
482
def report_skip(self, test, skip_excinfo):
484
self.stream.writeln(' SKIP %s\n%s'
485
% (self._testTimeString(),
486
self._error_summary(skip_excinfo)))
488
def report_unsupported(self, test, feature):
489
"""test cannot be run because feature is missing."""
490
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
491
%(self._testTimeString(), feature))
495
class TextTestRunner(object):
204
496
stop_on_failure = False
206
def _makeResult(self):
207
result = _MyResult(self.stream, self.descriptions, self.verbosity)
504
use_numbered_dirs=False,
507
self.stream = unittest._WritelnDecorator(stream)
508
self.descriptions = descriptions
509
self.verbosity = verbosity
510
self.keep_output = keep_output
511
self._bench_history = bench_history
512
self.use_numbered_dirs = use_numbered_dirs
513
self.list_only = list_only
516
"Run the given test case or test suite."
517
startTime = time.time()
518
if self.verbosity == 1:
519
result_class = TextTestResult
520
elif self.verbosity >= 2:
521
result_class = VerboseTestResult
522
result = result_class(self.stream,
525
bench_history=self._bench_history,
526
num_tests=test.countTestCases(),
527
use_numbered_dirs=self.use_numbered_dirs,
208
529
result.stop_early = self.stop_on_failure
530
result.report_starting()
532
if self.verbosity >= 2:
533
self.stream.writeln("Listing tests only ...\n")
535
for t in iter_suite_tests(test):
536
self.stream.writeln("%s" % (t.id()))
538
actionTaken = "Listed"
541
run = result.testsRun
543
stopTime = time.time()
544
timeTaken = stopTime - startTime
546
self.stream.writeln(result.separator2)
547
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
548
run, run != 1 and "s" or "", timeTaken))
549
self.stream.writeln()
550
if not result.wasSuccessful():
551
self.stream.write("FAILED (")
552
failed, errored = map(len, (result.failures, result.errors))
554
self.stream.write("failures=%d" % failed)
556
if failed: self.stream.write(", ")
557
self.stream.write("errors=%d" % errored)
558
if result.known_failure_count:
559
if failed or errored: self.stream.write(", ")
560
self.stream.write("known_failure_count=%d" %
561
result.known_failure_count)
562
self.stream.writeln(")")
564
if result.known_failure_count:
565
self.stream.writeln("OK (known_failures=%d)" %
566
result.known_failure_count)
568
self.stream.writeln("OK")
569
if result.skip_count > 0:
570
skipped = result.skip_count
571
self.stream.writeln('%d test%s skipped' %
572
(skipped, skipped != 1 and "s" or ""))
573
if result.unsupported:
574
for feature, count in sorted(result.unsupported.items()):
575
self.stream.writeln("Missing feature '%s' skipped %d tests." %
577
result.report_cleaning_up()
578
# This is still a little bogus,
579
# but only a little. Folk not using our testrunner will
580
# have to delete their temp directories themselves.
581
test_root = TestCaseWithMemoryTransport.TEST_ROOT
582
if result.wasSuccessful() or not self.keep_output:
583
if test_root is not None:
584
# If LANG=C we probably have created some bogus paths
585
# which rmtree(unicode) will fail to delete
586
# so make sure we are using rmtree(str) to delete everything
587
# except on win32, where rmtree(str) will fail
588
# since it doesn't have the property of byte-stream paths
589
# (they are either ascii or mbcs)
590
if sys.platform == 'win32':
591
# make sure we are using the unicode win32 api
592
test_root = unicode(test_root)
594
test_root = test_root.encode(
595
sys.getfilesystemencoding())
596
_rmtree_temp_dir(test_root)
598
note("Failed tests working directories are in '%s'\n", test_root)
599
TestCaseWithMemoryTransport.TEST_ROOT = None
341
942
def assertIsInstance(self, obj, kls):
342
943
"""Fail if obj is not an instance of kls"""
343
944
if not isinstance(obj, kls):
344
self.fail("%r is not an instance of %s" % (obj, kls))
945
self.fail("%r is an instance of %s rather than %s" % (
946
obj, obj.__class__, kls))
948
def expectFailure(self, reason, assertion, *args, **kwargs):
949
"""Invoke a test, expecting it to fail for the given reason.
951
This is for assertions that ought to succeed, but currently fail.
952
(The failure is *expected* but not *wanted*.) Please be very precise
953
about the failure you're expecting. If a new bug is introduced,
954
AssertionError should be raised, not KnownFailure.
956
Frequently, expectFailure should be followed by an opposite assertion.
959
Intended to be used with a callable that raises AssertionError as the
960
'assertion' parameter. args and kwargs are passed to the 'assertion'.
962
Raises KnownFailure if the test fails. Raises AssertionError if the
967
self.expectFailure('Math is broken', self.assertNotEqual, 54,
969
self.assertEqual(42, dynamic_val)
971
This means that a dynamic_val of 54 will cause the test to raise
972
a KnownFailure. Once math is fixed and the expectFailure is removed,
973
only a dynamic_val of 42 will allow the test to pass. Anything other
974
than 54 or 42 will cause an AssertionError.
977
assertion(*args, **kwargs)
978
except AssertionError:
979
raise KnownFailure(reason)
981
self.fail('Unexpected success. Should have failed: %s' % reason)
983
def _capture_warnings(self, a_callable, *args, **kwargs):
984
"""A helper for callDeprecated and applyDeprecated.
986
:param a_callable: A callable to call.
987
:param args: The positional arguments for the callable
988
:param kwargs: The keyword arguments for the callable
989
:return: A tuple (warnings, result). result is the result of calling
990
a_callable(*args, **kwargs).
993
def capture_warnings(msg, cls=None, stacklevel=None):
994
# we've hooked into a deprecation specific callpath,
995
# only deprecations should getting sent via it.
996
self.assertEqual(cls, DeprecationWarning)
997
local_warnings.append(msg)
998
original_warning_method = symbol_versioning.warn
999
symbol_versioning.set_warning_method(capture_warnings)
1001
result = a_callable(*args, **kwargs)
1003
symbol_versioning.set_warning_method(original_warning_method)
1004
return (local_warnings, result)
1006
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1007
"""Call a deprecated callable without warning the user.
1009
:param deprecation_format: The deprecation format that the callable
1010
should have been deprecated with. This is the same type as the
1011
parameter to deprecated_method/deprecated_function. If the
1012
callable is not deprecated with this format, an assertion error
1014
:param a_callable: A callable to call. This may be a bound method or
1015
a regular function. It will be called with *args and **kwargs.
1016
:param args: The positional arguments for the callable
1017
:param kwargs: The keyword arguments for the callable
1018
:return: The result of a_callable(*args, **kwargs)
1020
call_warnings, result = self._capture_warnings(a_callable,
1022
expected_first_warning = symbol_versioning.deprecation_string(
1023
a_callable, deprecation_format)
1024
if len(call_warnings) == 0:
1025
self.fail("No deprecation warning generated by call to %s" %
1027
self.assertEqual(expected_first_warning, call_warnings[0])
1030
def callDeprecated(self, expected, callable, *args, **kwargs):
1031
"""Assert that a callable is deprecated in a particular way.
1033
This is a very precise test for unusual requirements. The
1034
applyDeprecated helper function is probably more suited for most tests
1035
as it allows you to simply specify the deprecation format being used
1036
and will ensure that that is issued for the function being called.
1038
:param expected: a list of the deprecation warnings expected, in order
1039
:param callable: The callable to call
1040
:param args: The positional arguments for the callable
1041
:param kwargs: The keyword arguments for the callable
1043
call_warnings, result = self._capture_warnings(callable,
1045
self.assertEqual(expected, call_warnings)
346
1048
def _startLogFile(self):
347
1049
"""Send bzr and test log messages to a temporary file.
496
1308
This sends the stdout/stderr results into the test's log,
497
1309
where it may be useful for debugging. See also run_captured.
1311
:param stdin: A string to be used as stdin for the command.
1312
:param retcode: The status code the command should return
1313
:param working_dir: The directory to run the command in
499
1315
retcode = kwargs.pop('retcode', 0)
500
return self.run_bzr_captured(args, retcode)
1316
encoding = kwargs.pop('encoding', None)
1317
stdin = kwargs.pop('stdin', None)
1318
working_dir = kwargs.pop('working_dir', None)
1319
error_regexes = kwargs.pop('error_regexes', [])
1321
out, err = self.run_bzr_captured(args, retcode=retcode,
1322
encoding=encoding, stdin=stdin, working_dir=working_dir)
1324
for regex in error_regexes:
1325
self.assertContainsRe(err, regex)
1329
def run_bzr_decode(self, *args, **kwargs):
1330
if 'encoding' in kwargs:
1331
encoding = kwargs['encoding']
1333
encoding = bzrlib.user_encoding
1334
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1336
def run_bzr_error(self, error_regexes, *args, **kwargs):
1337
"""Run bzr, and check that stderr contains the supplied regexes
1339
:param error_regexes: Sequence of regular expressions which
1340
must each be found in the error output. The relative ordering
1342
:param args: command-line arguments for bzr
1343
:param kwargs: Keyword arguments which are interpreted by run_bzr
1344
This function changes the default value of retcode to be 3,
1345
since in most cases this is run when you expect bzr to fail.
1346
:return: (out, err) The actual output of running the command (in case you
1347
want to do more inspection)
1350
# Make sure that commit is failing because there is nothing to do
1351
self.run_bzr_error(['no changes to commit'],
1352
'commit', '-m', 'my commit comment')
1353
# Make sure --strict is handling an unknown file, rather than
1354
# giving us the 'nothing to do' error
1355
self.build_tree(['unknown'])
1356
self.run_bzr_error(['Commit refused because there are unknown files'],
1357
'commit', '--strict', '-m', 'my commit comment')
1359
kwargs.setdefault('retcode', 3)
1360
out, err = self.run_bzr(error_regexes=error_regexes, *args, **kwargs)
1363
def run_bzr_subprocess(self, *args, **kwargs):
1364
"""Run bzr in a subprocess for testing.
1366
This starts a new Python interpreter and runs bzr in there.
1367
This should only be used for tests that have a justifiable need for
1368
this isolation: e.g. they are testing startup time, or signal
1369
handling, or early startup code, etc. Subprocess code can't be
1370
profiled or debugged so easily.
1372
:param retcode: The status code that is expected. Defaults to 0. If
1373
None is supplied, the status code is not checked.
1374
:param env_changes: A dictionary which lists changes to environment
1375
variables. A value of None will unset the env variable.
1376
The values must be strings. The change will only occur in the
1377
child, so you don't need to fix the environment after running.
1378
:param universal_newlines: Convert CRLF => LF
1379
:param allow_plugins: By default the subprocess is run with
1380
--no-plugins to ensure test reproducibility. Also, it is possible
1381
for system-wide plugins to create unexpected output on stderr,
1382
which can cause unnecessary test failures.
1384
env_changes = kwargs.get('env_changes', {})
1385
working_dir = kwargs.get('working_dir', None)
1386
allow_plugins = kwargs.get('allow_plugins', False)
1387
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1388
working_dir=working_dir,
1389
allow_plugins=allow_plugins)
1390
# We distinguish between retcode=None and retcode not passed.
1391
supplied_retcode = kwargs.get('retcode', 0)
1392
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1393
universal_newlines=kwargs.get('universal_newlines', False),
1396
def start_bzr_subprocess(self, process_args, env_changes=None,
1397
skip_if_plan_to_signal=False,
1399
allow_plugins=False):
1400
"""Start bzr in a subprocess for testing.
1402
This starts a new Python interpreter and runs bzr in there.
1403
This should only be used for tests that have a justifiable need for
1404
this isolation: e.g. they are testing startup time, or signal
1405
handling, or early startup code, etc. Subprocess code can't be
1406
profiled or debugged so easily.
1408
:param process_args: a list of arguments to pass to the bzr executable,
1409
for example `['--version']`.
1410
:param env_changes: A dictionary which lists changes to environment
1411
variables. A value of None will unset the env variable.
1412
The values must be strings. The change will only occur in the
1413
child, so you don't need to fix the environment after running.
1414
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1416
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1418
:returns: Popen object for the started process.
1420
if skip_if_plan_to_signal:
1421
if not getattr(os, 'kill', None):
1422
raise TestSkipped("os.kill not available.")
1424
if env_changes is None:
1428
def cleanup_environment():
1429
for env_var, value in env_changes.iteritems():
1430
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1432
def restore_environment():
1433
for env_var, value in old_env.iteritems():
1434
osutils.set_or_unset_env(env_var, value)
1436
bzr_path = self.get_bzr_path()
1439
if working_dir is not None:
1440
cwd = osutils.getcwd()
1441
os.chdir(working_dir)
1444
# win32 subprocess doesn't support preexec_fn
1445
# so we will avoid using it on all platforms, just to
1446
# make sure the code path is used, and we don't break on win32
1447
cleanup_environment()
1448
command = [sys.executable, bzr_path]
1449
if not allow_plugins:
1450
command.append('--no-plugins')
1451
command.extend(process_args)
1452
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1454
restore_environment()
1460
def _popen(self, *args, **kwargs):
1461
"""Place a call to Popen.
1463
Allows tests to override this method to intercept the calls made to
1464
Popen for introspection.
1466
return Popen(*args, **kwargs)
1468
def get_bzr_path(self):
1469
"""Return the path of the 'bzr' executable for this test suite."""
1470
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1471
if not os.path.isfile(bzr_path):
1472
# We are probably installed. Assume sys.argv is the right file
1473
bzr_path = sys.argv[0]
1476
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1477
universal_newlines=False, process_args=None):
1478
"""Finish the execution of process.
1480
:param process: the Popen object returned from start_bzr_subprocess.
1481
:param retcode: The status code that is expected. Defaults to 0. If
1482
None is supplied, the status code is not checked.
1483
:param send_signal: an optional signal to send to the process.
1484
:param universal_newlines: Convert CRLF => LF
1485
:returns: (stdout, stderr)
1487
if send_signal is not None:
1488
os.kill(process.pid, send_signal)
1489
out, err = process.communicate()
1491
if universal_newlines:
1492
out = out.replace('\r\n', '\n')
1493
err = err.replace('\r\n', '\n')
1495
if retcode is not None and retcode != process.returncode:
1496
if process_args is None:
1497
process_args = "(unknown args)"
1498
mutter('Output of bzr %s:\n%s', process_args, out)
1499
mutter('Error for bzr %s:\n%s', process_args, err)
1500
self.fail('Command bzr %s failed with retcode %s != %s'
1501
% (process_args, retcode, process.returncode))
502
1504
def check_inventory_shape(self, inv, shape):
503
1505
"""Compare an inventory to a list of expected names.
562
1565
base_rev = common_ancestor(branch_from.last_revision(),
563
1566
wt_to.branch.last_revision(),
564
1567
wt_to.branch.repository)
565
merge_inner(wt_to.branch, branch_from.basis_tree(),
1568
merge_inner(wt_to.branch, branch_from.basis_tree(),
566
1569
wt_to.branch.repository.revision_tree(base_rev),
567
1570
this_tree=wt_to)
568
wt_to.add_pending_merge(branch_from.last_revision())
1571
wt_to.add_parent_tree_id(branch_from.last_revision())
1573
def reduceLockdirTimeout(self):
1574
"""Reduce the default lock timeout for the duration of the test, so that
1575
if LockContention occurs during a test, it does so quickly.
1577
Tests that expect to provoke LockContention errors should call this.
1579
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1581
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1582
self.addCleanup(resetTimeout)
1583
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
571
1585
BzrTestBase = TestCase
1588
class TestCaseWithMemoryTransport(TestCase):
1589
"""Common test class for tests that do not need disk resources.
1591
Tests that need disk resources should derive from TestCaseWithTransport.
1593
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1595
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1596
a directory which does not exist. This serves to help ensure test isolation
1597
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1598
must exist. However, TestCaseWithMemoryTransport does not offer local
1599
file defaults for the transport in tests, nor does it obey the command line
1600
override, so tests that accidentally write to the common directory should
1608
def __init__(self, methodName='runTest'):
1609
# allow test parameterisation after test construction and before test
1610
# execution. Variables that the parameteriser sets need to be
1611
# ones that are not set by setUp, or setUp will trash them.
1612
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1613
self.vfs_transport_factory = default_transport
1614
self.transport_server = None
1615
self.transport_readonly_server = None
1616
self.__vfs_server = None
1618
def get_transport(self):
1619
"""Return a writeable transport for the test scratch space"""
1620
t = get_transport(self.get_url())
1621
self.assertFalse(t.is_readonly())
1624
def get_readonly_transport(self):
1625
"""Return a readonly transport for the test scratch space
1627
This can be used to test that operations which should only need
1628
readonly access in fact do not try to write.
1630
t = get_transport(self.get_readonly_url())
1631
self.assertTrue(t.is_readonly())
1634
def create_transport_readonly_server(self):
1635
"""Create a transport server from class defined at init.
1637
This is mostly a hook for daughter classes.
1639
return self.transport_readonly_server()
1641
def get_readonly_server(self):
1642
"""Get the server instance for the readonly transport
1644
This is useful for some tests with specific servers to do diagnostics.
1646
if self.__readonly_server is None:
1647
if self.transport_readonly_server is None:
1648
# readonly decorator requested
1649
# bring up the server
1650
self.__readonly_server = ReadonlyServer()
1651
self.__readonly_server.setUp(self.get_vfs_only_server())
1653
self.__readonly_server = self.create_transport_readonly_server()
1654
self.__readonly_server.setUp(self.get_vfs_only_server())
1655
self.addCleanup(self.__readonly_server.tearDown)
1656
return self.__readonly_server
1658
def get_readonly_url(self, relpath=None):
1659
"""Get a URL for the readonly transport.
1661
This will either be backed by '.' or a decorator to the transport
1662
used by self.get_url()
1663
relpath provides for clients to get a path relative to the base url.
1664
These should only be downwards relative, not upwards.
1666
base = self.get_readonly_server().get_url()
1667
if relpath is not None:
1668
if not base.endswith('/'):
1670
base = base + relpath
1673
def get_vfs_only_server(self):
1674
"""Get the vfs only read/write server instance.
1676
This is useful for some tests with specific servers that need
1679
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1680
is no means to override it.
1682
if self.__vfs_server is None:
1683
self.__vfs_server = MemoryServer()
1684
self.__vfs_server.setUp()
1685
self.addCleanup(self.__vfs_server.tearDown)
1686
return self.__vfs_server
1688
def get_server(self):
1689
"""Get the read/write server instance.
1691
This is useful for some tests with specific servers that need
1694
This is built from the self.transport_server factory. If that is None,
1695
then the self.get_vfs_server is returned.
1697
if self.__server is None:
1698
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1699
return self.get_vfs_only_server()
1701
# bring up a decorated means of access to the vfs only server.
1702
self.__server = self.transport_server()
1704
self.__server.setUp(self.get_vfs_only_server())
1705
except TypeError, e:
1706
# This should never happen; the try:Except here is to assist
1707
# developers having to update code rather than seeing an
1708
# uninformative TypeError.
1709
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1710
self.addCleanup(self.__server.tearDown)
1711
return self.__server
1713
def _adjust_url(self, base, relpath):
1714
"""Get a URL (or maybe a path) for the readwrite transport.
1716
This will either be backed by '.' or to an equivalent non-file based
1718
relpath provides for clients to get a path relative to the base url.
1719
These should only be downwards relative, not upwards.
1721
if relpath is not None and relpath != '.':
1722
if not base.endswith('/'):
1724
# XXX: Really base should be a url; we did after all call
1725
# get_url()! But sometimes it's just a path (from
1726
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1727
# to a non-escaped local path.
1728
if base.startswith('./') or base.startswith('/'):
1731
base += urlutils.escape(relpath)
1734
def get_url(self, relpath=None):
1735
"""Get a URL (or maybe a path) for the readwrite transport.
1737
This will either be backed by '.' or to an equivalent non-file based
1739
relpath provides for clients to get a path relative to the base url.
1740
These should only be downwards relative, not upwards.
1742
base = self.get_server().get_url()
1743
return self._adjust_url(base, relpath)
1745
def get_vfs_only_url(self, relpath=None):
1746
"""Get a URL (or maybe a path for the plain old vfs transport.
1748
This will never be a smart protocol.
1749
:param relpath: provides for clients to get a path relative to the base
1750
url. These should only be downwards relative, not upwards.
1752
base = self.get_vfs_only_server().get_url()
1753
return self._adjust_url(base, relpath)
1755
def _make_test_root(self):
1756
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1760
root = u'test%04d.tmp' % i
1764
if e.errno == errno.EEXIST:
1769
# successfully created
1770
TestCaseWithMemoryTransport.TEST_ROOT = osutils.abspath(root)
1772
# make a fake bzr directory there to prevent any tests propagating
1773
# up onto the source directory's real branch
1774
bzrdir.BzrDir.create_standalone_workingtree(
1775
TestCaseWithMemoryTransport.TEST_ROOT)
1777
def makeAndChdirToTestDir(self):
1778
"""Create a temporary directories for this one test.
1780
This must set self.test_home_dir and self.test_dir and chdir to
1783
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1785
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1786
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1787
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1789
def make_branch(self, relpath, format=None):
1790
"""Create a branch on the transport at relpath."""
1791
repo = self.make_repository(relpath, format=format)
1792
return repo.bzrdir.create_branch()
1794
def make_bzrdir(self, relpath, format=None):
1796
# might be a relative or absolute path
1797
maybe_a_url = self.get_url(relpath)
1798
segments = maybe_a_url.rsplit('/', 1)
1799
t = get_transport(maybe_a_url)
1800
if len(segments) > 1 and segments[-1] not in ('', '.'):
1803
except errors.FileExists:
1807
if isinstance(format, basestring):
1808
format = bzrdir.format_registry.make_bzrdir(format)
1809
return format.initialize_on_transport(t)
1810
except errors.UninitializableFormat:
1811
raise TestSkipped("Format %s is not initializable." % format)
1813
def make_repository(self, relpath, shared=False, format=None):
1814
"""Create a repository on our default transport at relpath."""
1815
made_control = self.make_bzrdir(relpath, format=format)
1816
return made_control.create_repository(shared=shared)
1818
def make_branch_and_memory_tree(self, relpath, format=None):
1819
"""Create a branch on the default transport and a MemoryTree for it."""
1820
b = self.make_branch(relpath, format=format)
1821
return memorytree.MemoryTree.create_on_branch(b)
1823
def overrideEnvironmentForTesting(self):
1824
os.environ['HOME'] = self.test_home_dir
1825
os.environ['BZR_HOME'] = self.test_home_dir
1828
super(TestCaseWithMemoryTransport, self).setUp()
1829
self._make_test_root()
1830
_currentdir = os.getcwdu()
1831
def _leaveDirectory():
1832
os.chdir(_currentdir)
1833
self.addCleanup(_leaveDirectory)
1834
self.makeAndChdirToTestDir()
1835
self.overrideEnvironmentForTesting()
1836
self.__readonly_server = None
1837
self.__server = None
1838
self.reduceLockdirTimeout()
574
class TestCaseInTempDir(TestCase):
1841
class TestCaseInTempDir(TestCaseWithMemoryTransport):
575
1842
"""Derived class that runs a test within a temporary directory.
577
1844
This is useful for tests that need to create a branch, etc.
662
1926
VFS's. If the transport is readonly or None,
663
1927
"." is opened automatically.
665
# XXX: It's OK to just create them using forward slashes on windows?
1929
# It's OK to just create them using forward slashes on windows.
666
1930
if transport is None or transport.is_readonly():
667
1931
transport = get_transport(".")
668
1932
for name in shape:
669
1933
self.assert_(isinstance(name, basestring))
670
1934
if name[-1] == '/':
671
transport.mkdir(urlescape(name[:-1]))
1935
transport.mkdir(urlutils.escape(name[:-1]))
673
1937
if line_endings == 'binary':
675
1939
elif line_endings == 'native':
676
1940
end = os.linesep
678
raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
679
content = "contents of %s%s" % (name, end)
680
transport.put(urlescape(name), StringIO(content))
1942
raise errors.BzrError(
1943
'Invalid line ending request %r' % line_endings)
1944
content = "contents of %s%s" % (name.encode('utf-8'), end)
1945
transport.put_bytes_non_atomic(urlutils.escape(name), content)
682
1947
def build_tree_contents(self, shape):
683
1948
build_tree_contents(shape)
1950
def assertFileEqual(self, content, path):
1951
"""Fail if path does not contain 'content'."""
1952
self.failUnlessExists(path)
1953
# TODO: jam 20060427 Shouldn't this be 'rb'?
1959
self.assertEqualDiff(content, s)
685
1961
def failUnlessExists(self, path):
686
"""Fail unless path, which may be abs or relative, exists."""
687
self.failUnless(osutils.lexists(path))
1962
"""Fail unless path or paths, which may be abs or relative, exist."""
1963
if not isinstance(path, basestring):
1965
self.failUnlessExists(p)
1967
self.failUnless(osutils.lexists(path),path+" does not exist")
689
1969
def failIfExists(self, path):
690
"""Fail if path, which may be abs or relative, exists."""
691
self.failIf(osutils.lexists(path))
693
def assertFileEqual(self, content, path):
694
"""Fail if path does not contain 'content'."""
695
self.failUnless(osutils.lexists(path))
696
self.assertEqualDiff(content, open(path, 'r').read())
1970
"""Fail if path or paths, which may be abs or relative, exist."""
1971
if not isinstance(path, basestring):
1973
self.failIfExists(p)
1975
self.failIf(osutils.lexists(path),path+" exists")
1977
def assertInWorkingTree(self,path,root_path='.',tree=None):
1978
"""Assert whether path or paths are in the WorkingTree"""
1980
tree = workingtree.WorkingTree.open(root_path)
1981
if not isinstance(path, basestring):
1983
self.assertInWorkingTree(p,tree=tree)
1985
self.assertIsNot(tree.path2id(path), None,
1986
path+' not in working tree.')
1988
def assertNotInWorkingTree(self,path,root_path='.',tree=None):
1989
"""Assert whether path or paths are not in the WorkingTree"""
1991
tree = workingtree.WorkingTree.open(root_path)
1992
if not isinstance(path, basestring):
1994
self.assertNotInWorkingTree(p,tree=tree)
1996
self.assertIs(tree.path2id(path), None, path+' in working tree.')
699
1999
class TestCaseWithTransport(TestCaseInTempDir):
710
2010
readwrite one must both define get_url() as resolving to os.getcwd().
713
def __init__(self, methodName='testMethod'):
714
super(TestCaseWithTransport, self).__init__(methodName)
715
self.__readonly_server = None
717
self.transport_server = default_transport
718
self.transport_readonly_server = None
720
def get_readonly_url(self, relpath=None):
721
"""Get a URL for the readonly transport.
723
This will either be backed by '.' or a decorator to the transport
724
used by self.get_url()
725
relpath provides for clients to get a path relative to the base url.
726
These should only be downwards relative, not upwards.
728
base = self.get_readonly_server().get_url()
729
if relpath is not None:
730
if not base.endswith('/'):
732
base = base + relpath
735
def get_readonly_server(self):
736
"""Get the server instance for the readonly transport
738
This is useful for some tests with specific servers to do diagnostics.
740
if self.__readonly_server is None:
741
if self.transport_readonly_server is None:
742
# readonly decorator requested
743
# bring up the server
745
self.__readonly_server = ReadonlyServer()
746
self.__readonly_server.setUp(self.__server)
748
self.__readonly_server = self.transport_readonly_server()
749
self.__readonly_server.setUp()
750
self.addCleanup(self.__readonly_server.tearDown)
751
return self.__readonly_server
753
def get_server(self):
754
"""Get the read/write server instance.
2013
def get_vfs_only_server(self):
2014
"""See TestCaseWithMemoryTransport.
756
2016
This is useful for some tests with specific servers that need
759
if self.__server is None:
760
self.__server = self.transport_server()
761
self.__server.setUp()
762
self.addCleanup(self.__server.tearDown)
765
def get_url(self, relpath=None):
766
"""Get a URL for the readwrite transport.
768
This will either be backed by '.' or to an equivalent non-file based
770
relpath provides for clients to get a path relative to the base url.
771
These should only be downwards relative, not upwards.
773
base = self.get_server().get_url()
774
if relpath is not None and relpath != '.':
775
if not base.endswith('/'):
777
base = base + relpath
780
def get_transport(self):
781
"""Return a writeable transport for the test scratch space"""
782
t = get_transport(self.get_url())
783
self.assertFalse(t.is_readonly())
786
def get_readonly_transport(self):
787
"""Return a readonly transport for the test scratch space
789
This can be used to test that operations which should only need
790
readonly access in fact do not try to write.
792
t = get_transport(self.get_readonly_url())
793
self.assertTrue(t.is_readonly())
796
def make_branch(self, relpath):
797
"""Create a branch on the transport at relpath."""
798
repo = self.make_repository(relpath)
799
return repo.bzrdir.create_branch()
801
def make_bzrdir(self, relpath):
803
url = self.get_url(relpath)
804
segments = relpath.split('/')
805
if segments and segments[-1] not in ('', '.'):
806
parent = self.get_url('/'.join(segments[:-1]))
807
t = get_transport(parent)
809
t.mkdir(segments[-1])
810
except errors.FileExists:
812
return bzrlib.bzrdir.BzrDir.create(url)
813
except errors.UninitializableFormat:
814
raise TestSkipped("Format %s is not initializable.")
816
def make_repository(self, relpath, shared=False):
817
"""Create a repository on our default transport at relpath."""
818
made_control = self.make_bzrdir(relpath)
819
return made_control.create_repository(shared=shared)
821
def make_branch_and_tree(self, relpath):
2019
if self.__vfs_server is None:
2020
self.__vfs_server = self.vfs_transport_factory()
2021
self.__vfs_server.setUp()
2022
self.addCleanup(self.__vfs_server.tearDown)
2023
return self.__vfs_server
2025
def make_branch_and_tree(self, relpath, format=None):
822
2026
"""Create a branch on the transport and a tree locally.
2028
If the transport is not a LocalTransport, the Tree can't be created on
2029
the transport. In that case if the vfs_transport_factory is
2030
LocalURLServer the working tree is created in the local
2031
directory backing the transport, and the returned tree's branch and
2032
repository will also be accessed locally. Otherwise a lightweight
2033
checkout is created and returned.
2035
:param format: The BzrDirFormat.
2036
:returns: the WorkingTree.
826
2038
# TODO: always use the local disk path for the working tree,
827
2039
# this obviously requires a format that supports branch references
828
2040
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
830
b = self.make_branch(relpath)
2042
b = self.make_branch(relpath, format=format)
832
2044
return b.bzrdir.create_workingtree()
833
2045
except errors.NotLocalUrl:
834
# new formats - catch No tree error and create
835
# a branch reference and a checkout.
836
# old formats at that point - raise TestSkipped.
838
return WorkingTreeFormat2().initialize(bzrdir.BzrDir.open(relpath))
2046
# We can only make working trees locally at the moment. If the
2047
# transport can't support them, then we keep the non-disk-backed
2048
# branch and create a local checkout.
2049
if self.vfs_transport_factory is LocalURLServer:
2050
# the branch is colocated on disk, we cannot create a checkout.
2051
# hopefully callers will expect this.
2052
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2053
return local_controldir.create_workingtree()
2055
return b.create_checkout(relpath, lightweight=True)
840
2057
def assertIsDirectory(self, relpath, transport):
841
2058
"""Assert that relpath within transport is a directory.
868
2098
def setUp(self):
869
2099
super(ChrootedTestCase, self).setUp()
870
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
871
self.transport_readonly_server = bzrlib.transport.http.HttpServer
874
def filter_suite_by_re(suite, pattern):
2100
if not self.vfs_transport_factory == MemoryServer:
2101
self.transport_readonly_server = HttpServer
2104
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2105
random_order=False):
2106
"""Create a test suite by filtering another one.
2108
:param suite: the source suite
2109
:param pattern: pattern that names must match
2110
:param exclude_pattern: pattern that names must not match, if any
2111
:param random_order: if True, tests in the new suite will be put in
2113
:returns: the newly created suite
2115
return sort_suite_by_re(suite, pattern, exclude_pattern,
2116
random_order, False)
2119
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2120
random_order=False, append_rest=True):
2121
"""Create a test suite by sorting another one.
2123
:param suite: the source suite
2124
:param pattern: pattern that names must match in order to go
2125
first in the new suite
2126
:param exclude_pattern: pattern that names must not match, if any
2127
:param random_order: if True, tests in the new suite will be put in
2129
:param append_rest: if False, pattern is a strict filter and not
2130
just an ordering directive
2131
:returns: the newly created suite
876
2135
filter_re = re.compile(pattern)
2136
if exclude_pattern is not None:
2137
exclude_re = re.compile(exclude_pattern)
877
2138
for test in iter_suite_tests(suite):
878
if filter_re.search(test.id()):
2140
if exclude_pattern is None or not exclude_re.search(test_id):
2141
if filter_re.search(test_id):
2146
random.shuffle(first)
2147
random.shuffle(second)
2148
return TestUtil.TestSuite(first + second)
883
2151
def run_suite(suite, name='test', verbose=False, pattern=".*",
884
2152
stop_on_failure=False, keep_output=False,
886
TestCaseInTempDir._TEST_NAME = name
2153
transport=None, lsprof_timed=None, bench_history=None,
2154
matching_tests_first=None,
2158
exclude_pattern=None,
2160
use_numbered_dirs = bool(numbered_dirs)
2162
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2163
if numbered_dirs is not None:
2164
TestCaseInTempDir.use_numbered_dirs = use_numbered_dirs
891
2169
runner = TextTestRunner(stream=sys.stdout,
2171
verbosity=verbosity,
2172
keep_output=keep_output,
2173
bench_history=bench_history,
2174
use_numbered_dirs=use_numbered_dirs,
2175
list_only=list_only,
894
2177
runner.stop_on_failure=stop_on_failure
896
suite = filter_suite_by_re(suite, pattern)
2178
# Initialise the random number generator and display the seed used.
2179
# We convert the seed to a long to make it reuseable across invocations.
2180
random_order = False
2181
if random_seed is not None:
2183
if random_seed == "now":
2184
random_seed = long(time.time())
2186
# Convert the seed to a long if we can
2188
random_seed = long(random_seed)
2191
runner.stream.writeln("Randomizing test order using seed %s\n" %
2193
random.seed(random_seed)
2194
# Customise the list of tests if requested
2195
if pattern != '.*' or exclude_pattern is not None or random_order:
2196
if matching_tests_first:
2197
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
2200
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
897
2202
result = runner.run(suite)
898
# This is still a little bogus,
899
# but only a little. Folk not using our testrunner will
900
# have to delete their temp directories themselves.
901
test_root = TestCaseInTempDir.TEST_ROOT
902
if result.wasSuccessful() or not keep_output:
903
if test_root is not None:
904
print 'Deleting test root %s...' % test_root
906
shutil.rmtree(test_root)
910
print "Failed tests working directories are in '%s'\n" % TestCaseInTempDir.TEST_ROOT
911
2203
return result.wasSuccessful()
914
2206
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
915
2207
keep_output=False,
2209
test_suite_factory=None,
2212
matching_tests_first=None,
2216
exclude_pattern=None):
917
2217
"""Run the whole test suite under the enhanced runner"""
2218
# XXX: Very ugly way to do this...
2219
# Disable warning about old formats because we don't want it to disturb
2220
# any blackbox tests.
2221
from bzrlib import repository
2222
repository._deprecation_warning_done = True
918
2224
global default_transport
919
2225
if transport is None:
920
2226
transport = default_transport
921
2227
old_transport = default_transport
922
2228
default_transport = transport
2230
if test_suite_factory is None:
2231
suite = test_suite()
2233
suite = test_suite_factory()
925
2234
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
926
2235
stop_on_failure=stop_on_failure, keep_output=keep_output,
2236
transport=transport,
2237
lsprof_timed=lsprof_timed,
2238
bench_history=bench_history,
2239
matching_tests_first=matching_tests_first,
2240
numbered_dirs=numbered_dirs,
2241
list_only=list_only,
2242
random_seed=random_seed,
2243
exclude_pattern=exclude_pattern)
929
2245
default_transport = old_transport
933
2248
def test_suite():
934
"""Build and return TestSuite for the whole program."""
935
from doctest import DocTestSuite
937
global MODULES_TO_DOCTEST
2249
"""Build and return TestSuite for the whole of bzrlib.
2251
This function can be replaced if you need to change the default test
2252
suite on a global basis, but it is not encouraged.
940
2255
'bzrlib.tests.test_ancestry',
941
2256
'bzrlib.tests.test_annotate',
942
2257
'bzrlib.tests.test_api',
2258
'bzrlib.tests.test_atomicfile',
943
2259
'bzrlib.tests.test_bad_files',
944
'bzrlib.tests.test_basis_inventory',
945
2260
'bzrlib.tests.test_branch',
2261
'bzrlib.tests.test_bugtracker',
2262
'bzrlib.tests.test_bundle',
946
2263
'bzrlib.tests.test_bzrdir',
947
'bzrlib.tests.test_command',
2264
'bzrlib.tests.test_cache_utf8',
2265
'bzrlib.tests.test_commands',
948
2266
'bzrlib.tests.test_commit',
949
2267
'bzrlib.tests.test_commit_merge',
950
2268
'bzrlib.tests.test_config',
951
2269
'bzrlib.tests.test_conflicts',
952
2270
'bzrlib.tests.test_decorators',
2271
'bzrlib.tests.test_delta',
953
2272
'bzrlib.tests.test_diff',
954
'bzrlib.tests.test_doc_generate',
2273
'bzrlib.tests.test_dirstate',
955
2274
'bzrlib.tests.test_errors',
956
2275
'bzrlib.tests.test_escaped_store',
2276
'bzrlib.tests.test_extract',
957
2277
'bzrlib.tests.test_fetch',
2278
'bzrlib.tests.test_ftp_transport',
2279
'bzrlib.tests.test_generate_docs',
2280
'bzrlib.tests.test_generate_ids',
2281
'bzrlib.tests.test_globbing',
958
2282
'bzrlib.tests.test_gpg',
959
2283
'bzrlib.tests.test_graph',
960
2284
'bzrlib.tests.test_hashcache',
2285
'bzrlib.tests.test_help',
961
2286
'bzrlib.tests.test_http',
2287
'bzrlib.tests.test_http_response',
2288
'bzrlib.tests.test_https_ca_bundle',
962
2289
'bzrlib.tests.test_identitymap',
2290
'bzrlib.tests.test_ignores',
963
2291
'bzrlib.tests.test_inv',
964
2292
'bzrlib.tests.test_knit',
2293
'bzrlib.tests.test_lazy_import',
2294
'bzrlib.tests.test_lazy_regex',
965
2295
'bzrlib.tests.test_lockdir',
966
2296
'bzrlib.tests.test_lockable_files',
967
2297
'bzrlib.tests.test_log',
2298
'bzrlib.tests.test_memorytree',
968
2299
'bzrlib.tests.test_merge',
969
2300
'bzrlib.tests.test_merge3',
970
2301
'bzrlib.tests.test_merge_core',
2302
'bzrlib.tests.test_merge_directive',
971
2303
'bzrlib.tests.test_missing',
972
2304
'bzrlib.tests.test_msgeditor',
973
2305
'bzrlib.tests.test_nonascii',
974
2306
'bzrlib.tests.test_options',
975
2307
'bzrlib.tests.test_osutils',
2308
'bzrlib.tests.test_osutils_encodings',
2309
'bzrlib.tests.test_patch',
2310
'bzrlib.tests.test_patches',
976
2311
'bzrlib.tests.test_permissions',
977
2312
'bzrlib.tests.test_plugins',
978
2313
'bzrlib.tests.test_progress',
979
2314
'bzrlib.tests.test_reconcile',
2315
'bzrlib.tests.test_registry',
2316
'bzrlib.tests.test_remote',
980
2317
'bzrlib.tests.test_repository',
2318
'bzrlib.tests.test_revert',
981
2319
'bzrlib.tests.test_revision',
982
2320
'bzrlib.tests.test_revisionnamespaces',
983
'bzrlib.tests.test_revprops',
2321
'bzrlib.tests.test_revisiontree',
984
2322
'bzrlib.tests.test_rio',
985
2323
'bzrlib.tests.test_sampler',
986
2324
'bzrlib.tests.test_selftest',
987
2325
'bzrlib.tests.test_setup',
988
2326
'bzrlib.tests.test_sftp_transport',
2327
'bzrlib.tests.test_smart',
989
2328
'bzrlib.tests.test_smart_add',
2329
'bzrlib.tests.test_smart_transport',
990
2330
'bzrlib.tests.test_source',
2331
'bzrlib.tests.test_ssh_transport',
2332
'bzrlib.tests.test_status',
991
2333
'bzrlib.tests.test_store',
2334
'bzrlib.tests.test_strace',
2335
'bzrlib.tests.test_subsume',
992
2336
'bzrlib.tests.test_symbol_versioning',
2337
'bzrlib.tests.test_tag',
993
2338
'bzrlib.tests.test_testament',
2339
'bzrlib.tests.test_textfile',
2340
'bzrlib.tests.test_textmerge',
2341
'bzrlib.tests.test_timestamp',
994
2342
'bzrlib.tests.test_trace',
995
2343
'bzrlib.tests.test_transactions',
996
2344
'bzrlib.tests.test_transform',
997
2345
'bzrlib.tests.test_transport',
2346
'bzrlib.tests.test_tree',
2347
'bzrlib.tests.test_treebuilder',
998
2348
'bzrlib.tests.test_tsort',
2349
'bzrlib.tests.test_tuned_gzip',
999
2350
'bzrlib.tests.test_ui',
1000
2351
'bzrlib.tests.test_upgrade',
2352
'bzrlib.tests.test_urlutils',
1001
2353
'bzrlib.tests.test_versionedfile',
2354
'bzrlib.tests.test_version',
2355
'bzrlib.tests.test_version_info',
1002
2356
'bzrlib.tests.test_weave',
1003
2357
'bzrlib.tests.test_whitebox',
1004
2358
'bzrlib.tests.test_workingtree',
2359
'bzrlib.tests.test_workingtree_4',
2360
'bzrlib.tests.test_wsgi',
1005
2361
'bzrlib.tests.test_xml',
1007
2363
test_transport_implementations = [
1008
'bzrlib.tests.test_transport_implementations']
1010
TestCase.BZRPATH = osutils.pathjoin(
1011
osutils.realpath(osutils.dirname(bzrlib.__path__[0])), 'bzr')
1012
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
1013
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
1016
# python2.4's TestLoader.loadTestsFromNames gives very poor
1017
# errors if it fails to load a named module - no indication of what's
1018
# actually wrong, just "no such module". We should probably override that
1019
# class, but for the moment just load them ourselves. (mbp 20051202)
1020
loader = TestLoader()
2364
'bzrlib.tests.test_transport_implementations',
2365
'bzrlib.tests.test_read_bundle',
2367
suite = TestUtil.TestSuite()
2368
loader = TestUtil.TestLoader()
2369
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1021
2370
from bzrlib.transport import TransportTestProviderAdapter
1022
2371
adapter = TransportTestProviderAdapter()
1023
2372
adapt_modules(test_transport_implementations, adapter, loader, suite)
1024
for mod_name in testmod_names:
1025
mod = _load_module_by_name(mod_name)
1026
suite.addTest(loader.loadTestsFromModule(mod))
1027
2373
for package in packages_to_test():
1028
2374
suite.addTest(package.test_suite())
1029
2375
for m in MODULES_TO_TEST:
1030
2376
suite.addTest(loader.loadTestsFromModule(m))
1031
for m in (MODULES_TO_DOCTEST):
1032
suite.addTest(DocTestSuite(m))
2377
for m in MODULES_TO_DOCTEST:
2379
suite.addTest(doctest.DocTestSuite(m))
2380
except ValueError, e:
2381
print '**failed to get doctest for: %s\n%s' %(m,e)
1033
2383
for name, plugin in bzrlib.plugin.all_plugins().items():
1034
2384
if getattr(plugin, 'test_suite', None) is not None:
1035
suite.addTest(plugin.test_suite())
2385
default_encoding = sys.getdefaultencoding()
2387
plugin_suite = plugin.test_suite()
2388
except ImportError, e:
2389
bzrlib.trace.warning(
2390
'Unable to test plugin "%s": %s', name, e)
2392
suite.addTest(plugin_suite)
2393
if default_encoding != sys.getdefaultencoding():
2394
bzrlib.trace.warning(
2395
'Plugin "%s" tried to reset default encoding to: %s', name,
2396
sys.getdefaultencoding())
2398
sys.setdefaultencoding(default_encoding)
1039
2402
def adapt_modules(mods_list, adapter, loader, suite):
1040
2403
"""Adapt the modules in mods_list using adapter and add to suite."""
1041
for mod_name in mods_list:
1042
mod = _load_module_by_name(mod_name)
1043
for test in iter_suite_tests(loader.loadTestsFromModule(mod)):
1044
suite.addTests(adapter.adapt(test))
1047
def _load_module_by_name(mod_name):
1048
parts = mod_name.split('.')
1049
module = __import__(mod_name)
1051
# for historical reasons python returns the top-level module even though
1052
# it loads the submodule; we need to walk down to get the one we want.
1054
module = getattr(module, parts.pop(0))
2404
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2405
suite.addTests(adapter.adapt(test))
2408
def _rmtree_temp_dir(dirname):
2410
osutils.rmtree(dirname)
2412
if sys.platform == 'win32' and e.errno == errno.EACCES:
2413
print >>sys.stderr, ('Permission denied: '
2414
'unable to remove testing dir '
2415
'%s' % os.path.basename(dirname))
2420
def clean_selftest_output(root=None, quiet=False):
2421
"""Remove all selftest output directories from root directory.
2423
:param root: root directory for clean
2424
(if ommitted or None then clean current directory).
2425
:param quiet: suppress report about deleting directories
2428
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
2431
for i in os.listdir(root):
2432
if os.path.isdir(i) and re_dir.match(i):
2434
print 'delete directory:', i
2438
class Feature(object):
2439
"""An operating system Feature."""
2442
self._available = None
2444
def available(self):
2445
"""Is the feature available?
2447
:return: True if the feature is available.
2449
if self._available is None:
2450
self._available = self._probe()
2451
return self._available
2454
"""Implement this method in concrete features.
2456
:return: True if the feature is available.
2458
raise NotImplementedError
2461
if getattr(self, 'feature_name', None):
2462
return self.feature_name()
2463
return self.__class__.__name__