1
# Copyright (C) 2005, 2006 Canonical Ltd
1
# Copyright (C) 2005 by Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: Perhaps there should be an API to find out if bzr running under the
19
# test suite -- some plugins might want to avoid making intrusive changes if
20
# this is the case. However, we want behaviour under to test to diverge as
21
# little as possible, so this should be used rarely if it's added at all.
22
# (Suggestion from j-a-meinel, 2005-11-24)
24
# NOTE: Some classes in here use camelCaseNaming() rather than
25
# underscore_naming(). That's for consistency with unittest; it's not the
26
# general style of bzrlib. Please continue that consistency when adding e.g.
27
# new assertFoo() methods.
30
from cStringIO import StringIO
39
from subprocess import Popen, PIPE
56
import bzrlib.commands
57
import bzrlib.bundle.serializer
59
import bzrlib.inventory
60
import bzrlib.iterablefile
65
# lsprof not available
67
from bzrlib.merge import merge_inner
71
from bzrlib.revision import common_ancestor
73
from bzrlib import symbol_versioning
75
from bzrlib.transport import get_transport
76
import bzrlib.transport
77
from bzrlib.transport.local import LocalURLServer
78
from bzrlib.transport.memory import MemoryServer
79
from bzrlib.transport.readonly import ReadonlyServer
80
from bzrlib.trace import mutter, note
81
from bzrlib.tests import TestUtil
82
from bzrlib.tests.TestUtil import (
86
from bzrlib.tests.treeshape import build_tree_contents
87
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
89
default_transport = LocalURLServer
92
MODULES_TO_DOCTEST = [
93
bzrlib.bundle.serializer,
105
def packages_to_test():
106
"""Return a list of packages to test.
108
The packages are not globally imported so that import failures are
109
triggered when running selftest, not when importing the command.
112
import bzrlib.tests.blackbox
113
import bzrlib.tests.branch_implementations
114
import bzrlib.tests.bzrdir_implementations
115
import bzrlib.tests.interrepository_implementations
116
import bzrlib.tests.interversionedfile_implementations
117
import bzrlib.tests.intertree_implementations
118
import bzrlib.tests.repository_implementations
119
import bzrlib.tests.revisionstore_implementations
120
import bzrlib.tests.tree_implementations
121
import bzrlib.tests.workingtree_implementations
124
bzrlib.tests.blackbox,
125
bzrlib.tests.branch_implementations,
126
bzrlib.tests.bzrdir_implementations,
127
bzrlib.tests.interrepository_implementations,
128
bzrlib.tests.interversionedfile_implementations,
129
bzrlib.tests.intertree_implementations,
130
bzrlib.tests.repository_implementations,
131
bzrlib.tests.revisionstore_implementations,
132
bzrlib.tests.tree_implementations,
133
bzrlib.tests.workingtree_implementations,
137
class ExtendedTestResult(unittest._TextTestResult):
138
"""Accepts, reports and accumulates the results of running tests.
140
Compared to this unittest version this class adds support for profiling,
141
benchmarking, stopping as soon as a test fails, and skipping tests.
142
There are further-specialized subclasses for different types of display.
147
def __init__(self, stream, descriptions, verbosity,
151
"""Construct new TestResult.
153
:param bench_history: Optionally, a writable file object to accumulate
156
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
157
if bench_history is not None:
158
from bzrlib.version import _get_bzr_source_tree
159
src_tree = _get_bzr_source_tree()
162
revision_id = src_tree.get_parent_ids()[0]
164
# XXX: if this is a brand new tree, do the same as if there
168
# XXX: If there's no branch, what should we do?
170
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
171
self._bench_history = bench_history
172
self.ui = bzrlib.ui.ui_factory
173
self.num_tests = num_tests
175
self.failure_count = 0
178
self._overall_start_time = time.time()
180
def extractBenchmarkTime(self, testCase):
181
"""Add a benchmark time for the current test case."""
182
self._benchmarkTime = getattr(testCase, "_benchtime", None)
184
def _elapsedTestTimeString(self):
185
"""Return a time string for the overall time the current test has taken."""
186
return self._formatTime(time.time() - self._start_time)
188
def _testTimeString(self):
189
if self._benchmarkTime is not None:
191
self._formatTime(self._benchmarkTime),
192
self._elapsedTestTimeString())
194
return " %s" % self._elapsedTestTimeString()
196
def _formatTime(self, seconds):
197
"""Format seconds as milliseconds with leading spaces."""
198
return "%5dms" % (1000 * seconds)
200
def _shortened_test_description(self, test):
202
what = re.sub(r'^bzrlib\.(tests|benchmark)\.', '', what)
205
def startTest(self, test):
206
unittest.TestResult.startTest(self, test)
207
self.report_test_start(test)
208
self._recordTestStartTime()
210
def _recordTestStartTime(self):
211
"""Record that a test has started."""
212
self._start_time = time.time()
214
def addError(self, test, err):
215
if isinstance(err[1], TestSkipped):
216
return self.addSkipped(test, err)
217
unittest.TestResult.addError(self, test, err)
218
# We can only do this if we have one of our TestCases, not if
220
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
221
if setKeepLogfile is not None:
223
self.extractBenchmarkTime(test)
224
self.report_error(test, err)
228
def addFailure(self, test, err):
229
unittest.TestResult.addFailure(self, test, err)
230
# We can only do this if we have one of our TestCases, not if
232
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
233
if setKeepLogfile is not None:
235
self.extractBenchmarkTime(test)
236
self.report_failure(test, err)
240
def addSuccess(self, test):
241
self.extractBenchmarkTime(test)
242
if self._bench_history is not None:
243
if self._benchmarkTime is not None:
244
self._bench_history.write("%s %s\n" % (
245
self._formatTime(self._benchmarkTime),
247
self.report_success(test)
248
unittest.TestResult.addSuccess(self, test)
250
def addSkipped(self, test, skip_excinfo):
251
self.extractBenchmarkTime(test)
252
self.report_skip(test, skip_excinfo)
253
# seems best to treat this as success from point-of-view of unittest
254
# -- it actually does nothing so it barely matters :)
257
except KeyboardInterrupt:
260
self.addError(test, test.__exc_info())
262
unittest.TestResult.addSuccess(self, test)
264
def printErrorList(self, flavour, errors):
265
for test, err in errors:
266
self.stream.writeln(self.separator1)
267
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
268
if getattr(test, '_get_log', None) is not None:
270
print >>self.stream, \
271
('vvvv[log from %s]' % test.id()).ljust(78,'-')
272
print >>self.stream, test._get_log()
273
print >>self.stream, \
274
('^^^^[log from %s]' % test.id()).ljust(78,'-')
275
self.stream.writeln(self.separator2)
276
self.stream.writeln("%s" % err)
281
def report_cleaning_up(self):
284
def report_success(self, test):
288
class TextTestResult(ExtendedTestResult):
289
"""Displays progress and results of tests in text form"""
291
def __init__(self, *args, **kw):
292
ExtendedTestResult.__init__(self, *args, **kw)
293
self.pb = self.ui.nested_progress_bar()
294
self.pb.show_pct = False
295
self.pb.show_spinner = False
296
self.pb.show_eta = False,
297
self.pb.show_count = False
298
self.pb.show_bar = False
300
def report_starting(self):
301
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
303
def _progress_prefix_text(self):
304
a = '[%d' % self.count
305
if self.num_tests is not None:
306
a +='/%d' % self.num_tests
307
a += ' in %ds' % (time.time() - self._overall_start_time)
309
a += ', %d errors' % self.error_count
310
if self.failure_count:
311
a += ', %d failed' % self.failure_count
313
a += ', %d skipped' % self.skip_count
317
def report_test_start(self, test):
320
self._progress_prefix_text()
322
+ self._shortened_test_description(test))
324
def report_error(self, test, err):
325
self.error_count += 1
326
self.pb.note('ERROR: %s\n %s\n' % (
327
self._shortened_test_description(test),
331
def report_failure(self, test, err):
332
self.failure_count += 1
333
self.pb.note('FAIL: %s\n %s\n' % (
334
self._shortened_test_description(test),
338
def report_skip(self, test, skip_excinfo):
341
# at the moment these are mostly not things we can fix
342
# and so they just produce stipple; use the verbose reporter
345
# show test and reason for skip
346
self.pb.note('SKIP: %s\n %s\n' % (
347
self._shortened_test_description(test),
350
# since the class name was left behind in the still-visible
352
self.pb.note('SKIP: %s' % (skip_excinfo[1]))
354
def report_cleaning_up(self):
355
self.pb.update('cleaning up...')
361
class VerboseTestResult(ExtendedTestResult):
362
"""Produce long output, with one line per test run plus times"""
364
def _ellipsize_to_right(self, a_string, final_width):
365
"""Truncate and pad a string, keeping the right hand side"""
366
if len(a_string) > final_width:
367
result = '...' + a_string[3-final_width:]
370
return result.ljust(final_width)
372
def report_starting(self):
373
self.stream.write('running %d tests...\n' % self.num_tests)
375
def report_test_start(self, test):
377
name = self._shortened_test_description(test)
378
self.stream.write(self._ellipsize_to_right(name, 60))
381
def report_error(self, test, err):
382
self.error_count += 1
383
self.stream.writeln('ERROR %s\n %s'
384
% (self._testTimeString(), err[1]))
386
def report_failure(self, test, err):
387
self.failure_count += 1
388
self.stream.writeln('FAIL %s\n %s'
389
% (self._testTimeString(), err[1]))
391
def report_success(self, test):
392
self.stream.writeln(' OK %s' % self._testTimeString())
393
for bench_called, stats in getattr(test, '_benchcalls', []):
394
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
395
stats.pprint(file=self.stream)
398
def report_skip(self, test, skip_excinfo):
399
print >>self.stream, ' SKIP %s' % self._testTimeString()
400
print >>self.stream, ' %s' % skip_excinfo[1]
403
class TextTestRunner(object):
404
stop_on_failure = False
412
self.stream = unittest._WritelnDecorator(stream)
413
self.descriptions = descriptions
414
self.verbosity = verbosity
415
self.keep_output = keep_output
416
self._bench_history = bench_history
419
"Run the given test case or test suite."
420
startTime = time.time()
421
if self.verbosity == 1:
422
result_class = TextTestResult
423
elif self.verbosity >= 2:
424
result_class = VerboseTestResult
425
result = result_class(self.stream,
428
bench_history=self._bench_history,
429
num_tests=test.countTestCases(),
431
result.stop_early = self.stop_on_failure
432
result.report_starting()
434
stopTime = time.time()
435
timeTaken = stopTime - startTime
437
self.stream.writeln(result.separator2)
438
run = result.testsRun
439
self.stream.writeln("Ran %d test%s in %.3fs" %
440
(run, run != 1 and "s" or "", timeTaken))
441
self.stream.writeln()
442
if not result.wasSuccessful():
443
self.stream.write("FAILED (")
444
failed, errored = map(len, (result.failures, result.errors))
446
self.stream.write("failures=%d" % failed)
448
if failed: self.stream.write(", ")
449
self.stream.write("errors=%d" % errored)
450
self.stream.writeln(")")
452
self.stream.writeln("OK")
453
result.report_cleaning_up()
454
# This is still a little bogus,
455
# but only a little. Folk not using our testrunner will
456
# have to delete their temp directories themselves.
457
test_root = TestCaseWithMemoryTransport.TEST_ROOT
458
if result.wasSuccessful() or not self.keep_output:
459
if test_root is not None:
460
# If LANG=C we probably have created some bogus paths
461
# which rmtree(unicode) will fail to delete
462
# so make sure we are using rmtree(str) to delete everything
463
# except on win32, where rmtree(str) will fail
464
# since it doesn't have the property of byte-stream paths
465
# (they are either ascii or mbcs)
466
if sys.platform == 'win32':
467
# make sure we are using the unicode win32 api
468
test_root = unicode(test_root)
470
test_root = test_root.encode(
471
sys.getfilesystemencoding())
472
osutils.rmtree(test_root)
474
note("Failed tests working directories are in '%s'\n", test_root)
475
TestCaseWithMemoryTransport.TEST_ROOT = None
480
def iter_suite_tests(suite):
481
"""Return all tests in a suite, recursing through nested suites"""
482
for item in suite._tests:
483
if isinstance(item, unittest.TestCase):
485
elif isinstance(item, unittest.TestSuite):
486
for r in iter_suite_tests(item):
489
raise Exception('unknown object %r inside test suite %r'
493
class TestSkipped(Exception):
494
"""Indicates that a test was intentionally skipped, rather than failing."""
497
class CommandFailed(Exception):
501
class StringIOWrapper(object):
502
"""A wrapper around cStringIO which just adds an encoding attribute.
504
Internally we can check sys.stdout to see what the output encoding
505
should be. However, cStringIO has no encoding attribute that we can
506
set. So we wrap it instead.
511
def __init__(self, s=None):
513
self.__dict__['_cstring'] = StringIO(s)
515
self.__dict__['_cstring'] = StringIO()
517
def __getattr__(self, name, getattr=getattr):
518
return getattr(self.__dict__['_cstring'], name)
520
def __setattr__(self, name, val):
521
if name == 'encoding':
522
self.__dict__['encoding'] = val
524
return setattr(self._cstring, name, val)
527
class TestCase(unittest.TestCase):
528
"""Base class for bzr unit tests.
530
Tests that need access to disk resources should subclass
531
TestCaseInTempDir not TestCase.
533
Error and debug log messages are redirected from their usual
534
location into a temporary file, the contents of which can be
535
retrieved by _get_log(). We use a real OS file, not an in-memory object,
536
so that it can also capture file IO. When the test completes this file
537
is read into memory and removed from disk.
539
There are also convenience functions to invoke bzr's command-line
540
routine, and to build and check bzr trees.
542
In addition to the usual method of overriding tearDown(), this class also
543
allows subclasses to register functions into the _cleanups list, which is
544
run in order as the object is torn down. It's less likely this will be
545
accidentally overlooked.
548
_log_file_name = None
550
_keep_log_file = False
551
# record lsprof data when performing benchmark calls.
552
_gather_lsprof_in_benchmarks = False
554
def __init__(self, methodName='testMethod'):
555
super(TestCase, self).__init__(methodName)
559
unittest.TestCase.setUp(self)
560
self._cleanEnvironment()
561
bzrlib.trace.disable_default_logging()
564
self._benchcalls = []
565
self._benchtime = None
567
def _silenceUI(self):
568
"""Turn off UI for duration of test"""
569
# by default the UI is off; tests can turn it on if they want it.
570
saved = bzrlib.ui.ui_factory
572
bzrlib.ui.ui_factory = saved
573
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
574
self.addCleanup(_restore)
576
def _ndiff_strings(self, a, b):
577
"""Return ndiff between two strings containing lines.
579
A trailing newline is added if missing to make the strings
581
if b and b[-1] != '\n':
583
if a and a[-1] != '\n':
585
difflines = difflib.ndiff(a.splitlines(True),
587
linejunk=lambda x: False,
588
charjunk=lambda x: False)
589
return ''.join(difflines)
591
def assertEqualDiff(self, a, b, message=None):
592
"""Assert two texts are equal, if not raise an exception.
594
This is intended for use with multi-line strings where it can
595
be hard to find the differences by eye.
597
# TODO: perhaps override assertEquals to call this for strings?
601
message = "texts not equal:\n"
602
raise AssertionError(message +
603
self._ndiff_strings(a, b))
605
def assertEqualMode(self, mode, mode_test):
606
self.assertEqual(mode, mode_test,
607
'mode mismatch %o != %o' % (mode, mode_test))
609
def assertStartsWith(self, s, prefix):
610
if not s.startswith(prefix):
611
raise AssertionError('string %r does not start with %r' % (s, prefix))
613
def assertEndsWith(self, s, suffix):
614
"""Asserts that s ends with suffix."""
615
if not s.endswith(suffix):
616
raise AssertionError('string %r does not end with %r' % (s, suffix))
618
def assertContainsRe(self, haystack, needle_re):
619
"""Assert that a contains something matching a regular expression."""
620
if not re.search(needle_re, haystack):
621
raise AssertionError('pattern "%s" not found in "%s"'
622
% (needle_re, haystack))
624
def assertNotContainsRe(self, haystack, needle_re):
625
"""Assert that a does not match a regular expression"""
626
if re.search(needle_re, haystack):
627
raise AssertionError('pattern "%s" found in "%s"'
628
% (needle_re, haystack))
630
def assertSubset(self, sublist, superlist):
631
"""Assert that every entry in sublist is present in superlist."""
633
for entry in sublist:
634
if entry not in superlist:
635
missing.append(entry)
637
raise AssertionError("value(s) %r not present in container %r" %
638
(missing, superlist))
640
def assertIs(self, left, right):
641
if not (left is right):
642
raise AssertionError("%r is not %r." % (left, right))
644
def assertTransportMode(self, transport, path, mode):
645
"""Fail if a path does not have mode mode.
647
If modes are not supported on this transport, the assertion is ignored.
649
if not transport._can_roundtrip_unix_modebits():
651
path_stat = transport.stat(path)
652
actual_mode = stat.S_IMODE(path_stat.st_mode)
653
self.assertEqual(mode, actual_mode,
654
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
656
def assertIsInstance(self, obj, kls):
657
"""Fail if obj is not an instance of kls"""
658
if not isinstance(obj, kls):
659
self.fail("%r is an instance of %s rather than %s" % (
660
obj, obj.__class__, kls))
662
def _capture_warnings(self, a_callable, *args, **kwargs):
663
"""A helper for callDeprecated and applyDeprecated.
665
:param a_callable: A callable to call.
666
:param args: The positional arguments for the callable
667
:param kwargs: The keyword arguments for the callable
668
:return: A tuple (warnings, result). result is the result of calling
669
a_callable(*args, **kwargs).
672
def capture_warnings(msg, cls=None, stacklevel=None):
673
# we've hooked into a deprecation specific callpath,
674
# only deprecations should getting sent via it.
675
self.assertEqual(cls, DeprecationWarning)
676
local_warnings.append(msg)
677
original_warning_method = symbol_versioning.warn
678
symbol_versioning.set_warning_method(capture_warnings)
680
result = a_callable(*args, **kwargs)
682
symbol_versioning.set_warning_method(original_warning_method)
683
return (local_warnings, result)
685
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
686
"""Call a deprecated callable without warning the user.
688
:param deprecation_format: The deprecation format that the callable
689
should have been deprecated with. This is the same type as the
690
parameter to deprecated_method/deprecated_function. If the
691
callable is not deprecated with this format, an assertion error
693
:param a_callable: A callable to call. This may be a bound method or
694
a regular function. It will be called with *args and **kwargs.
695
:param args: The positional arguments for the callable
696
:param kwargs: The keyword arguments for the callable
697
:return: The result of a_callable(*args, **kwargs)
699
call_warnings, result = self._capture_warnings(a_callable,
701
expected_first_warning = symbol_versioning.deprecation_string(
702
a_callable, deprecation_format)
703
if len(call_warnings) == 0:
704
self.fail("No assertion generated by call to %s" %
706
self.assertEqual(expected_first_warning, call_warnings[0])
709
def callDeprecated(self, expected, callable, *args, **kwargs):
710
"""Assert that a callable is deprecated in a particular way.
712
This is a very precise test for unusual requirements. The
713
applyDeprecated helper function is probably more suited for most tests
714
as it allows you to simply specify the deprecation format being used
715
and will ensure that that is issued for the function being called.
717
:param expected: a list of the deprecation warnings expected, in order
718
:param callable: The callable to call
719
:param args: The positional arguments for the callable
720
:param kwargs: The keyword arguments for the callable
722
call_warnings, result = self._capture_warnings(callable,
724
self.assertEqual(expected, call_warnings)
727
def _startLogFile(self):
728
"""Send bzr and test log messages to a temporary file.
730
The file is removed as the test is torn down.
732
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
733
self._log_file = os.fdopen(fileno, 'w+')
734
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
735
self._log_file_name = name
736
self.addCleanup(self._finishLogFile)
738
def _finishLogFile(self):
739
"""Finished with the log file.
741
Close the file and delete it, unless setKeepLogfile was called.
743
if self._log_file is None:
745
bzrlib.trace.disable_test_log(self._log_nonce)
746
self._log_file.close()
747
self._log_file = None
748
if not self._keep_log_file:
749
os.remove(self._log_file_name)
750
self._log_file_name = None
752
def setKeepLogfile(self):
753
"""Make the logfile not be deleted when _finishLogFile is called."""
754
self._keep_log_file = True
756
def addCleanup(self, callable):
757
"""Arrange to run a callable when this case is torn down.
759
Callables are run in the reverse of the order they are registered,
760
ie last-in first-out.
762
if callable in self._cleanups:
763
raise ValueError("cleanup function %r already registered on %s"
765
self._cleanups.append(callable)
767
def _cleanEnvironment(self):
769
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
771
'APPDATA': os.getcwd(),
773
'BZREMAIL': None, # may still be present in the environment
775
'BZR_PROGRESS_BAR': None,
778
self.addCleanup(self._restoreEnvironment)
779
for name, value in new_env.iteritems():
780
self._captureVar(name, value)
782
def _captureVar(self, name, newvalue):
783
"""Set an environment variable, and reset it when finished."""
784
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
786
def _restoreEnvironment(self):
787
for name, value in self.__old_env.iteritems():
788
osutils.set_or_unset_env(name, value)
792
unittest.TestCase.tearDown(self)
794
def time(self, callable, *args, **kwargs):
795
"""Run callable and accrue the time it takes to the benchmark time.
797
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
798
this will cause lsprofile statistics to be gathered and stored in
801
if self._benchtime is None:
805
if not self._gather_lsprof_in_benchmarks:
806
return callable(*args, **kwargs)
808
# record this benchmark
809
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
811
self._benchcalls.append(((callable, args, kwargs), stats))
814
self._benchtime += time.time() - start
816
def _runCleanups(self):
817
"""Run registered cleanup functions.
819
This should only be called from TestCase.tearDown.
821
# TODO: Perhaps this should keep running cleanups even if
823
for cleanup_fn in reversed(self._cleanups):
826
def log(self, *args):
829
def _get_log(self, keep_log_file=False):
830
"""Return as a string the log for this test. If the file is still
831
on disk and keep_log_file=False, delete the log file and store the
832
content in self._log_contents."""
833
# flush the log file, to get all content
835
bzrlib.trace._trace_file.flush()
836
if self._log_contents:
837
return self._log_contents
838
if self._log_file_name is not None:
839
logfile = open(self._log_file_name)
841
log_contents = logfile.read()
844
if not keep_log_file:
845
self._log_contents = log_contents
846
os.remove(self._log_file_name)
849
return "DELETED log file to reduce memory footprint"
851
def capture(self, cmd, retcode=0):
852
"""Shortcut that splits cmd into words, runs, and returns stdout"""
853
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
855
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
857
"""Invoke bzr and return (stdout, stderr).
859
Useful for code that wants to check the contents of the
860
output, the way error messages are presented, etc.
862
This should be the main method for tests that want to exercise the
863
overall behavior of the bzr application (rather than a unit test
864
or a functional test of the library.)
866
Much of the old code runs bzr by forking a new copy of Python, but
867
that is slower, harder to debug, and generally not necessary.
869
This runs bzr through the interface that catches and reports
870
errors, and with logging set to something approximating the
871
default, so that error reporting can be checked.
873
:param argv: arguments to invoke bzr
874
:param retcode: expected return code, or None for don't-care.
875
:param encoding: encoding for sys.stdout and sys.stderr
876
:param stdin: A string to be used as stdin for the command.
877
:param working_dir: Change to this directory before running
880
encoding = bzrlib.user_encoding
881
if stdin is not None:
882
stdin = StringIO(stdin)
883
stdout = StringIOWrapper()
884
stderr = StringIOWrapper()
885
stdout.encoding = encoding
886
stderr.encoding = encoding
888
self.log('run bzr: %r', argv)
889
# FIXME: don't call into logging here
890
handler = logging.StreamHandler(stderr)
891
handler.setLevel(logging.INFO)
892
logger = logging.getLogger('')
893
logger.addHandler(handler)
894
old_ui_factory = bzrlib.ui.ui_factory
895
bzrlib.ui.ui_factory = bzrlib.tests.blackbox.TestUIFactory(
898
bzrlib.ui.ui_factory.stdin = stdin
901
if working_dir is not None:
902
cwd = osutils.getcwd()
903
os.chdir(working_dir)
906
saved_debug_flags = frozenset(debug.debug_flags)
907
debug.debug_flags.clear()
909
result = self.apply_redirected(stdin, stdout, stderr,
910
bzrlib.commands.run_bzr_catch_errors,
913
debug.debug_flags.update(saved_debug_flags)
915
logger.removeHandler(handler)
916
bzrlib.ui.ui_factory = old_ui_factory
920
out = stdout.getvalue()
921
err = stderr.getvalue()
923
self.log('output:\n%r', out)
925
self.log('errors:\n%r', err)
926
if retcode is not None:
927
self.assertEquals(retcode, result)
930
def run_bzr(self, *args, **kwargs):
931
"""Invoke bzr, as if it were run from the command line.
933
This should be the main method for tests that want to exercise the
934
overall behavior of the bzr application (rather than a unit test
935
or a functional test of the library.)
937
This sends the stdout/stderr results into the test's log,
938
where it may be useful for debugging. See also run_captured.
940
:param stdin: A string to be used as stdin for the command.
942
retcode = kwargs.pop('retcode', 0)
943
encoding = kwargs.pop('encoding', None)
944
stdin = kwargs.pop('stdin', None)
945
working_dir = kwargs.pop('working_dir', None)
946
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding,
947
stdin=stdin, working_dir=working_dir)
949
def run_bzr_decode(self, *args, **kwargs):
950
if 'encoding' in kwargs:
951
encoding = kwargs['encoding']
953
encoding = bzrlib.user_encoding
954
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
956
def run_bzr_error(self, error_regexes, *args, **kwargs):
957
"""Run bzr, and check that stderr contains the supplied regexes
959
:param error_regexes: Sequence of regular expressions which
960
must each be found in the error output. The relative ordering
962
:param args: command-line arguments for bzr
963
:param kwargs: Keyword arguments which are interpreted by run_bzr
964
This function changes the default value of retcode to be 3,
965
since in most cases this is run when you expect bzr to fail.
966
:return: (out, err) The actual output of running the command (in case you
967
want to do more inspection)
970
# Make sure that commit is failing because there is nothing to do
971
self.run_bzr_error(['no changes to commit'],
972
'commit', '-m', 'my commit comment')
973
# Make sure --strict is handling an unknown file, rather than
974
# giving us the 'nothing to do' error
975
self.build_tree(['unknown'])
976
self.run_bzr_error(['Commit refused because there are unknown files'],
977
'commit', '--strict', '-m', 'my commit comment')
979
kwargs.setdefault('retcode', 3)
980
out, err = self.run_bzr(*args, **kwargs)
981
for regex in error_regexes:
982
self.assertContainsRe(err, regex)
985
def run_bzr_subprocess(self, *args, **kwargs):
986
"""Run bzr in a subprocess for testing.
988
This starts a new Python interpreter and runs bzr in there.
989
This should only be used for tests that have a justifiable need for
990
this isolation: e.g. they are testing startup time, or signal
991
handling, or early startup code, etc. Subprocess code can't be
992
profiled or debugged so easily.
994
:param retcode: The status code that is expected. Defaults to 0. If
995
None is supplied, the status code is not checked.
996
:param env_changes: A dictionary which lists changes to environment
997
variables. A value of None will unset the env variable.
998
The values must be strings. The change will only occur in the
999
child, so you don't need to fix the environment after running.
1000
:param universal_newlines: Convert CRLF => LF
1001
:param allow_plugins: By default the subprocess is run with
1002
--no-plugins to ensure test reproducibility. Also, it is possible
1003
for system-wide plugins to create unexpected output on stderr,
1004
which can cause unnecessary test failures.
1006
env_changes = kwargs.get('env_changes', {})
1007
working_dir = kwargs.get('working_dir', None)
1008
allow_plugins = kwargs.get('allow_plugins', False)
1009
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1010
working_dir=working_dir,
1011
allow_plugins=allow_plugins)
1012
# We distinguish between retcode=None and retcode not passed.
1013
supplied_retcode = kwargs.get('retcode', 0)
1014
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1015
universal_newlines=kwargs.get('universal_newlines', False),
1018
def start_bzr_subprocess(self, process_args, env_changes=None,
1019
skip_if_plan_to_signal=False,
1021
allow_plugins=False):
1022
"""Start bzr in a subprocess for testing.
1024
This starts a new Python interpreter and runs bzr in there.
1025
This should only be used for tests that have a justifiable need for
1026
this isolation: e.g. they are testing startup time, or signal
1027
handling, or early startup code, etc. Subprocess code can't be
1028
profiled or debugged so easily.
1030
:param process_args: a list of arguments to pass to the bzr executable,
1031
for example `['--version']`.
1032
:param env_changes: A dictionary which lists changes to environment
1033
variables. A value of None will unset the env variable.
1034
The values must be strings. The change will only occur in the
1035
child, so you don't need to fix the environment after running.
1036
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1038
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1040
:returns: Popen object for the started process.
1042
if skip_if_plan_to_signal:
1043
if not getattr(os, 'kill', None):
1044
raise TestSkipped("os.kill not available.")
1046
if env_changes is None:
1050
def cleanup_environment():
1051
for env_var, value in env_changes.iteritems():
1052
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1054
def restore_environment():
1055
for env_var, value in old_env.iteritems():
1056
osutils.set_or_unset_env(env_var, value)
1058
bzr_path = self.get_bzr_path()
1061
if working_dir is not None:
1062
cwd = osutils.getcwd()
1063
os.chdir(working_dir)
1066
# win32 subprocess doesn't support preexec_fn
1067
# so we will avoid using it on all platforms, just to
1068
# make sure the code path is used, and we don't break on win32
1069
cleanup_environment()
1070
command = [sys.executable, bzr_path]
1071
if not allow_plugins:
1072
command.append('--no-plugins')
1073
command.extend(process_args)
1074
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1076
restore_environment()
1082
def _popen(self, *args, **kwargs):
1083
"""Place a call to Popen.
1085
Allows tests to override this method to intercept the calls made to
1086
Popen for introspection.
1088
return Popen(*args, **kwargs)
1090
def get_bzr_path(self):
1091
"""Return the path of the 'bzr' executable for this test suite."""
1092
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1093
if not os.path.isfile(bzr_path):
1094
# We are probably installed. Assume sys.argv is the right file
1095
bzr_path = sys.argv[0]
1098
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1099
universal_newlines=False, process_args=None):
1100
"""Finish the execution of process.
1102
:param process: the Popen object returned from start_bzr_subprocess.
1103
:param retcode: The status code that is expected. Defaults to 0. If
1104
None is supplied, the status code is not checked.
1105
:param send_signal: an optional signal to send to the process.
1106
:param universal_newlines: Convert CRLF => LF
1107
:returns: (stdout, stderr)
1109
if send_signal is not None:
1110
os.kill(process.pid, send_signal)
1111
out, err = process.communicate()
1113
if universal_newlines:
1114
out = out.replace('\r\n', '\n')
1115
err = err.replace('\r\n', '\n')
1117
if retcode is not None and retcode != process.returncode:
1118
if process_args is None:
1119
process_args = "(unknown args)"
1120
mutter('Output of bzr %s:\n%s', process_args, out)
1121
mutter('Error for bzr %s:\n%s', process_args, err)
1122
self.fail('Command bzr %s failed with retcode %s != %s'
1123
% (process_args, retcode, process.returncode))
1126
def check_inventory_shape(self, inv, shape):
1127
"""Compare an inventory to a list of expected names.
1129
Fail if they are not precisely equal.
1132
shape = list(shape) # copy
1133
for path, ie in inv.entries():
1134
name = path.replace('\\', '/')
1135
if ie.kind == 'dir':
1142
self.fail("expected paths not found in inventory: %r" % shape)
1144
self.fail("unexpected paths found in inventory: %r" % extras)
1146
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1147
a_callable=None, *args, **kwargs):
1148
"""Call callable with redirected std io pipes.
1150
Returns the return code."""
1151
if not callable(a_callable):
1152
raise ValueError("a_callable must be callable.")
1154
stdin = StringIO("")
1156
if getattr(self, "_log_file", None) is not None:
1157
stdout = self._log_file
1161
if getattr(self, "_log_file", None is not None):
1162
stderr = self._log_file
1165
real_stdin = sys.stdin
1166
real_stdout = sys.stdout
1167
real_stderr = sys.stderr
1172
return a_callable(*args, **kwargs)
1174
sys.stdout = real_stdout
1175
sys.stderr = real_stderr
1176
sys.stdin = real_stdin
1178
@symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
1179
def merge(self, branch_from, wt_to):
1180
"""A helper for tests to do a ui-less merge.
1182
This should move to the main library when someone has time to integrate
1185
# minimal ui-less merge.
1186
wt_to.branch.fetch(branch_from)
1187
base_rev = common_ancestor(branch_from.last_revision(),
1188
wt_to.branch.last_revision(),
1189
wt_to.branch.repository)
1190
merge_inner(wt_to.branch, branch_from.basis_tree(),
1191
wt_to.branch.repository.revision_tree(base_rev),
1193
wt_to.add_parent_tree_id(branch_from.last_revision())
1196
BzrTestBase = TestCase
1199
class TestCaseWithMemoryTransport(TestCase):
1200
"""Common test class for tests that do not need disk resources.
1202
Tests that need disk resources should derive from TestCaseWithTransport.
1204
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1206
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1207
a directory which does not exist. This serves to help ensure test isolation
1208
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1209
must exist. However, TestCaseWithMemoryTransport does not offer local
1210
file defaults for the transport in tests, nor does it obey the command line
1211
override, so tests that accidentally write to the common directory should
1219
def __init__(self, methodName='runTest'):
1220
# allow test parameterisation after test construction and before test
1221
# execution. Variables that the parameteriser sets need to be
1222
# ones that are not set by setUp, or setUp will trash them.
1223
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1224
self.transport_server = default_transport
1225
self.transport_readonly_server = None
1227
def failUnlessExists(self, path):
1228
"""Fail unless path, which may be abs or relative, exists."""
1229
self.failUnless(osutils.lexists(path))
1231
def failIfExists(self, path):
1232
"""Fail if path, which may be abs or relative, exists."""
1233
self.failIf(osutils.lexists(path))
1235
def get_transport(self):
1236
"""Return a writeable transport for the test scratch space"""
1237
t = get_transport(self.get_url())
1238
self.assertFalse(t.is_readonly())
1241
def get_readonly_transport(self):
1242
"""Return a readonly transport for the test scratch space
1244
This can be used to test that operations which should only need
1245
readonly access in fact do not try to write.
1247
t = get_transport(self.get_readonly_url())
1248
self.assertTrue(t.is_readonly())
1251
def get_readonly_server(self):
1252
"""Get the server instance for the readonly transport
1254
This is useful for some tests with specific servers to do diagnostics.
1256
if self.__readonly_server is None:
1257
if self.transport_readonly_server is None:
1258
# readonly decorator requested
1259
# bring up the server
1261
self.__readonly_server = ReadonlyServer()
1262
self.__readonly_server.setUp(self.__server)
1264
self.__readonly_server = self.transport_readonly_server()
1265
self.__readonly_server.setUp()
1266
self.addCleanup(self.__readonly_server.tearDown)
1267
return self.__readonly_server
1269
def get_readonly_url(self, relpath=None):
1270
"""Get a URL for the readonly transport.
1272
This will either be backed by '.' or a decorator to the transport
1273
used by self.get_url()
1274
relpath provides for clients to get a path relative to the base url.
1275
These should only be downwards relative, not upwards.
1277
base = self.get_readonly_server().get_url()
1278
if relpath is not None:
1279
if not base.endswith('/'):
1281
base = base + relpath
1284
def get_server(self):
1285
"""Get the read/write server instance.
1287
This is useful for some tests with specific servers that need
1290
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1291
is no means to override it.
1293
if self.__server is None:
1294
self.__server = MemoryServer()
1295
self.__server.setUp()
1296
self.addCleanup(self.__server.tearDown)
1297
return self.__server
1299
def get_url(self, relpath=None):
1300
"""Get a URL (or maybe a path) for the readwrite transport.
1302
This will either be backed by '.' or to an equivalent non-file based
1304
relpath provides for clients to get a path relative to the base url.
1305
These should only be downwards relative, not upwards.
1307
base = self.get_server().get_url()
1308
if relpath is not None and relpath != '.':
1309
if not base.endswith('/'):
1311
# XXX: Really base should be a url; we did after all call
1312
# get_url()! But sometimes it's just a path (from
1313
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1314
# to a non-escaped local path.
1315
if base.startswith('./') or base.startswith('/'):
1318
base += urlutils.escape(relpath)
1321
def _make_test_root(self):
1322
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1326
root = u'test%04d.tmp' % i
1330
if e.errno == errno.EEXIST:
1335
# successfully created
1336
TestCaseWithMemoryTransport.TEST_ROOT = osutils.abspath(root)
1338
# make a fake bzr directory there to prevent any tests propagating
1339
# up onto the source directory's real branch
1340
bzrdir.BzrDir.create_standalone_workingtree(
1341
TestCaseWithMemoryTransport.TEST_ROOT)
1343
def makeAndChdirToTestDir(self):
1344
"""Create a temporary directories for this one test.
1346
This must set self.test_home_dir and self.test_dir and chdir to
1349
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1351
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1352
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1353
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1355
def make_branch(self, relpath, format=None):
1356
"""Create a branch on the transport at relpath."""
1357
repo = self.make_repository(relpath, format=format)
1358
return repo.bzrdir.create_branch()
1360
def make_bzrdir(self, relpath, format=None):
1362
# might be a relative or absolute path
1363
maybe_a_url = self.get_url(relpath)
1364
segments = maybe_a_url.rsplit('/', 1)
1365
t = get_transport(maybe_a_url)
1366
if len(segments) > 1 and segments[-1] not in ('', '.'):
1369
except errors.FileExists:
1372
format = bzrlib.bzrdir.BzrDirFormat.get_default_format()
1373
return format.initialize_on_transport(t)
1374
except errors.UninitializableFormat:
1375
raise TestSkipped("Format %s is not initializable." % format)
1377
def make_repository(self, relpath, shared=False, format=None):
1378
"""Create a repository on our default transport at relpath."""
1379
made_control = self.make_bzrdir(relpath, format=format)
1380
return made_control.create_repository(shared=shared)
1382
def make_branch_and_memory_tree(self, relpath, format=None):
1383
"""Create a branch on the default transport and a MemoryTree for it."""
1384
b = self.make_branch(relpath, format=format)
1385
return memorytree.MemoryTree.create_on_branch(b)
1387
def overrideEnvironmentForTesting(self):
1388
os.environ['HOME'] = self.test_home_dir
1389
os.environ['APPDATA'] = self.test_home_dir
1392
super(TestCaseWithMemoryTransport, self).setUp()
1393
self._make_test_root()
1394
_currentdir = os.getcwdu()
1395
def _leaveDirectory():
1396
os.chdir(_currentdir)
1397
self.addCleanup(_leaveDirectory)
1398
self.makeAndChdirToTestDir()
1399
self.overrideEnvironmentForTesting()
1400
self.__readonly_server = None
1401
self.__server = None
1404
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1405
"""Derived class that runs a test within a temporary directory.
1407
This is useful for tests that need to create a branch, etc.
1409
The directory is created in a slightly complex way: for each
1410
Python invocation, a new temporary top-level directory is created.
1411
All test cases create their own directory within that. If the
1412
tests complete successfully, the directory is removed.
1414
InTempDir is an old alias for FunctionalTestCase.
1417
OVERRIDE_PYTHON = 'python'
1419
def check_file_contents(self, filename, expect):
1420
self.log("check contents of file %s" % filename)
1421
contents = file(filename, 'r').read()
1422
if contents != expect:
1423
self.log("expected: %r" % expect)
1424
self.log("actually: %r" % contents)
1425
self.fail("contents of %s not as expected" % filename)
1427
def makeAndChdirToTestDir(self):
1428
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1430
For TestCaseInTempDir we create a temporary directory based on the test
1431
name and then create two subdirs - test and home under it.
1433
# shorten the name, to avoid test failures due to path length
1434
short_id = self.id().replace('bzrlib.tests.', '') \
1435
.replace('__main__.', '')[-100:]
1436
# it's possible the same test class is run several times for
1437
# parameterized tests, so make sure the names don't collide.
1441
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1443
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1444
if os.path.exists(candidate_dir):
1448
os.mkdir(candidate_dir)
1449
self.test_home_dir = candidate_dir + '/home'
1450
os.mkdir(self.test_home_dir)
1451
self.test_dir = candidate_dir + '/work'
1452
os.mkdir(self.test_dir)
1453
os.chdir(self.test_dir)
1456
def build_tree(self, shape, line_endings='native', transport=None):
1457
"""Build a test tree according to a pattern.
1459
shape is a sequence of file specifications. If the final
1460
character is '/', a directory is created.
1462
This assumes that all the elements in the tree being built are new.
1464
This doesn't add anything to a branch.
1465
:param line_endings: Either 'binary' or 'native'
1466
in binary mode, exact contents are written
1467
in native mode, the line endings match the
1468
default platform endings.
1470
:param transport: A transport to write to, for building trees on
1471
VFS's. If the transport is readonly or None,
1472
"." is opened automatically.
1474
# It's OK to just create them using forward slashes on windows.
1475
if transport is None or transport.is_readonly():
1476
transport = get_transport(".")
1478
self.assert_(isinstance(name, basestring))
1480
transport.mkdir(urlutils.escape(name[:-1]))
1482
if line_endings == 'binary':
1484
elif line_endings == 'native':
1487
raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
1488
content = "contents of %s%s" % (name.encode('utf-8'), end)
1489
# Technically 'put()' is the right command. However, put
1490
# uses an AtomicFile, which requires an extra rename into place
1491
# As long as the files didn't exist in the past, append() will
1492
# do the same thing as put()
1493
# On jam's machine, make_kernel_like_tree is:
1494
# put: 4.5-7.5s (averaging 6s)
1496
# put_non_atomic: 2.9-4.5s
1497
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1499
def build_tree_contents(self, shape):
1500
build_tree_contents(shape)
1502
def assertFileEqual(self, content, path):
1503
"""Fail if path does not contain 'content'."""
1504
self.failUnless(osutils.lexists(path))
1505
# TODO: jam 20060427 Shouldn't this be 'rb'?
1506
self.assertEqualDiff(content, open(path, 'r').read())
1509
class TestCaseWithTransport(TestCaseInTempDir):
1510
"""A test case that provides get_url and get_readonly_url facilities.
1512
These back onto two transport servers, one for readonly access and one for
1515
If no explicit class is provided for readonly access, a
1516
ReadonlyTransportDecorator is used instead which allows the use of non disk
1517
based read write transports.
1519
If an explicit class is provided for readonly access, that server and the
1520
readwrite one must both define get_url() as resolving to os.getcwd().
1523
def get_server(self):
1524
"""See TestCaseWithMemoryTransport.
1526
This is useful for some tests with specific servers that need
1529
if self.__server is None:
1530
self.__server = self.transport_server()
1531
self.__server.setUp()
1532
self.addCleanup(self.__server.tearDown)
1533
return self.__server
1535
def make_branch_and_tree(self, relpath, format=None):
1536
"""Create a branch on the transport and a tree locally.
1538
If the transport is not a LocalTransport, the Tree can't be created on
1539
the transport. In that case the working tree is created in the local
1540
directory, and the returned tree's branch and repository will also be
1543
This will fail if the original default transport for this test
1544
case wasn't backed by the working directory, as the branch won't
1545
be on disk for us to open it.
1547
:param format: The BzrDirFormat.
1548
:returns: the WorkingTree.
1550
# TODO: always use the local disk path for the working tree,
1551
# this obviously requires a format that supports branch references
1552
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1554
b = self.make_branch(relpath, format=format)
1556
return b.bzrdir.create_workingtree()
1557
except errors.NotLocalUrl:
1558
# We can only make working trees locally at the moment. If the
1559
# transport can't support them, then reopen the branch on a local
1560
# transport, and create the working tree there.
1562
# Possibly we should instead keep
1563
# the non-disk-backed branch and create a local checkout?
1564
bd = bzrdir.BzrDir.open(relpath)
1565
return bd.create_workingtree()
1567
def assertIsDirectory(self, relpath, transport):
1568
"""Assert that relpath within transport is a directory.
1570
This may not be possible on all transports; in that case it propagates
1571
a TransportNotPossible.
1574
mode = transport.stat(relpath).st_mode
1575
except errors.NoSuchFile:
1576
self.fail("path %s is not a directory; no such file"
1578
if not stat.S_ISDIR(mode):
1579
self.fail("path %s is not a directory; has mode %#o"
1583
super(TestCaseWithTransport, self).setUp()
1584
self.__server = None
1587
class ChrootedTestCase(TestCaseWithTransport):
1588
"""A support class that provides readonly urls outside the local namespace.
1590
This is done by checking if self.transport_server is a MemoryServer. if it
1591
is then we are chrooted already, if it is not then an HttpServer is used
1594
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1595
be used without needed to redo it when a different
1596
subclass is in use ?
1600
super(ChrootedTestCase, self).setUp()
1601
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
1602
self.transport_readonly_server = bzrlib.transport.http.HttpServer
1605
def filter_suite_by_re(suite, pattern):
1606
result = TestUtil.TestSuite()
1607
filter_re = re.compile(pattern)
1608
for test in iter_suite_tests(suite):
1609
if filter_re.search(test.id()):
1610
result.addTest(test)
1614
def run_suite(suite, name='test', verbose=False, pattern=".*",
1615
stop_on_failure=False, keep_output=False,
1616
transport=None, lsprof_timed=None, bench_history=None):
1617
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1622
runner = TextTestRunner(stream=sys.stdout,
1624
verbosity=verbosity,
1625
keep_output=keep_output,
1626
bench_history=bench_history)
1627
runner.stop_on_failure=stop_on_failure
1629
suite = filter_suite_by_re(suite, pattern)
1630
result = runner.run(suite)
1631
return result.wasSuccessful()
1634
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1637
test_suite_factory=None,
1639
bench_history=None):
1640
"""Run the whole test suite under the enhanced runner"""
1641
# XXX: Very ugly way to do this...
1642
# Disable warning about old formats because we don't want it to disturb
1643
# any blackbox tests.
1644
from bzrlib import repository
1645
repository._deprecation_warning_done = True
1647
global default_transport
1648
if transport is None:
1649
transport = default_transport
1650
old_transport = default_transport
1651
default_transport = transport
1653
if test_suite_factory is None:
1654
suite = test_suite()
1656
suite = test_suite_factory()
1657
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1658
stop_on_failure=stop_on_failure, keep_output=keep_output,
1659
transport=transport,
1660
lsprof_timed=lsprof_timed,
1661
bench_history=bench_history)
1663
default_transport = old_transport
1667
"""Build and return TestSuite for the whole of bzrlib.
1669
This function can be replaced if you need to change the default test
1670
suite on a global basis, but it is not encouraged.
1673
'bzrlib.tests.test_ancestry',
1674
'bzrlib.tests.test_api',
1675
'bzrlib.tests.test_atomicfile',
1676
'bzrlib.tests.test_bad_files',
1677
'bzrlib.tests.test_branch',
1678
'bzrlib.tests.test_bundle',
1679
'bzrlib.tests.test_bzrdir',
1680
'bzrlib.tests.test_cache_utf8',
1681
'bzrlib.tests.test_command',
1682
'bzrlib.tests.test_commit',
1683
'bzrlib.tests.test_commit_merge',
1684
'bzrlib.tests.test_config',
1685
'bzrlib.tests.test_conflicts',
1686
'bzrlib.tests.test_decorators',
1687
'bzrlib.tests.test_diff',
1688
'bzrlib.tests.test_doc_generate',
1689
'bzrlib.tests.test_errors',
1690
'bzrlib.tests.test_escaped_store',
1691
'bzrlib.tests.test_fetch',
1692
'bzrlib.tests.test_ftp_transport',
1693
'bzrlib.tests.test_gpg',
1694
'bzrlib.tests.test_graph',
1695
'bzrlib.tests.test_hashcache',
1696
'bzrlib.tests.test_http',
1697
'bzrlib.tests.test_http_response',
1698
'bzrlib.tests.test_identitymap',
1699
'bzrlib.tests.test_ignores',
1700
'bzrlib.tests.test_inv',
1701
'bzrlib.tests.test_knit',
1702
'bzrlib.tests.test_lazy_import',
1703
'bzrlib.tests.test_lazy_regex',
1704
'bzrlib.tests.test_lockdir',
1705
'bzrlib.tests.test_lockable_files',
1706
'bzrlib.tests.test_log',
1707
'bzrlib.tests.test_memorytree',
1708
'bzrlib.tests.test_merge',
1709
'bzrlib.tests.test_merge3',
1710
'bzrlib.tests.test_merge_core',
1711
'bzrlib.tests.test_missing',
1712
'bzrlib.tests.test_msgeditor',
1713
'bzrlib.tests.test_nonascii',
1714
'bzrlib.tests.test_options',
1715
'bzrlib.tests.test_osutils',
1716
'bzrlib.tests.test_patch',
1717
'bzrlib.tests.test_patches',
1718
'bzrlib.tests.test_permissions',
1719
'bzrlib.tests.test_plugins',
1720
'bzrlib.tests.test_progress',
1721
'bzrlib.tests.test_reconcile',
1722
'bzrlib.tests.test_registry',
1723
'bzrlib.tests.test_repository',
1724
'bzrlib.tests.test_revert',
1725
'bzrlib.tests.test_revision',
1726
'bzrlib.tests.test_revisionnamespaces',
1727
'bzrlib.tests.test_revisiontree',
1728
'bzrlib.tests.test_rio',
1729
'bzrlib.tests.test_sampler',
1730
'bzrlib.tests.test_selftest',
1731
'bzrlib.tests.test_setup',
1732
'bzrlib.tests.test_sftp_transport',
1733
'bzrlib.tests.test_smart_add',
1734
'bzrlib.tests.test_smart_transport',
1735
'bzrlib.tests.test_source',
1736
'bzrlib.tests.test_status',
1737
'bzrlib.tests.test_store',
1738
'bzrlib.tests.test_symbol_versioning',
1739
'bzrlib.tests.test_testament',
1740
'bzrlib.tests.test_textfile',
1741
'bzrlib.tests.test_textmerge',
1742
'bzrlib.tests.test_trace',
1743
'bzrlib.tests.test_transactions',
1744
'bzrlib.tests.test_transform',
1745
'bzrlib.tests.test_transport',
1746
'bzrlib.tests.test_tree',
1747
'bzrlib.tests.test_treebuilder',
1748
'bzrlib.tests.test_tsort',
1749
'bzrlib.tests.test_tuned_gzip',
1750
'bzrlib.tests.test_ui',
1751
'bzrlib.tests.test_upgrade',
1752
'bzrlib.tests.test_urlutils',
1753
'bzrlib.tests.test_versionedfile',
1754
'bzrlib.tests.test_version',
1755
'bzrlib.tests.test_version_info',
1756
'bzrlib.tests.test_weave',
1757
'bzrlib.tests.test_whitebox',
1758
'bzrlib.tests.test_workingtree',
1759
'bzrlib.tests.test_xml',
1761
test_transport_implementations = [
1762
'bzrlib.tests.test_transport_implementations',
1763
'bzrlib.tests.test_read_bundle',
1765
suite = TestUtil.TestSuite()
1766
loader = TestUtil.TestLoader()
1767
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1768
from bzrlib.transport import TransportTestProviderAdapter
1769
adapter = TransportTestProviderAdapter()
1770
adapt_modules(test_transport_implementations, adapter, loader, suite)
1771
for package in packages_to_test():
1772
suite.addTest(package.test_suite())
1773
for m in MODULES_TO_TEST:
1774
suite.addTest(loader.loadTestsFromModule(m))
1775
for m in MODULES_TO_DOCTEST:
1777
suite.addTest(doctest.DocTestSuite(m))
1778
except ValueError, e:
1779
print '**failed to get doctest for: %s\n%s' %(m,e)
1781
for name, plugin in bzrlib.plugin.all_plugins().items():
1782
if getattr(plugin, 'test_suite', None) is not None:
1783
suite.addTest(plugin.test_suite())
1787
def adapt_modules(mods_list, adapter, loader, suite):
1788
"""Adapt the modules in mods_list using adapter and add to suite."""
1789
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1790
suite.addTests(adapter.adapt(test))
18
from testsweet import TestBase, run_suite, InTempDir
22
from unittest import TestLoader, TestSuite
23
import bzrlib, bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, bzrlib.commands
25
import bzrlib.selftest.whitebox
26
import bzrlib.selftest.blackbox
27
import bzrlib.selftest.versioning
28
import bzrlib.selftest.testmerge3
29
import bzrlib.selftest.testhashcache
30
import bzrlib.merge_core
31
from doctest import DocTestSuite
38
TestBase.BZRPATH = os.path.join(os.path.realpath(os.path.dirname(bzrlib.__path__[0])), 'bzr')
39
print '%-30s %s' % ('bzr binary', TestBase.BZRPATH)
45
# should also test bzrlib.merge_core, but they seem to be out of date with
49
# python2.3's TestLoader() doesn't seem to work well; don't know why
51
for m in (bzrlib.store,
57
suite.addTest(DocTestSuite(m))
59
for cl in (bzrlib.selftest.whitebox.TEST_CLASSES
60
+ bzrlib.selftest.versioning.TEST_CLASSES
61
+ bzrlib.selftest.testmerge3.TEST_CLASSES
62
+ bzrlib.selftest.testhashcache.TEST_CLASSES
63
+ bzrlib.selftest.blackbox.TEST_CLASSES):
66
suite.addTest(unittest.makeSuite(bzrlib.merge_core.MergeTest, 'test_'))
68
return run_suite(suite, 'testbzr')
added
removed
bzrlib/selftest/__init__.py
