1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: Perhaps there should be an API to find out if bzr running under the
19
# test suite -- some plugins might want to avoid making intrusive changes if
20
# this is the case. However, we want behaviour under to test to diverge as
21
# little as possible, so this should be used rarely if it's added at all.
22
# (Suggestion from j-a-meinel, 2005-11-24)
24
# NOTE: Some classes in here use camelCaseNaming() rather than
25
# underscore_naming(). That's for consistency with unittest; it's not the
26
# general style of bzrlib. Please continue that consistency when adding e.g.
27
# new assertFoo() methods.
30
from cStringIO import StringIO
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.HttpServer import HttpServer
83
from bzrlib.tests.TestUtil import (
87
from bzrlib.tests.treeshape import build_tree_contents
88
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
90
default_transport = LocalURLServer
93
MODULES_TO_DOCTEST = [
94
bzrlib.bundle.serializer,
106
def packages_to_test():
107
"""Return a list of packages to test.
109
The packages are not globally imported so that import failures are
110
triggered when running selftest, not when importing the command.
113
import bzrlib.tests.blackbox
114
import bzrlib.tests.branch_implementations
115
import bzrlib.tests.bzrdir_implementations
116
import bzrlib.tests.interrepository_implementations
117
import bzrlib.tests.interversionedfile_implementations
118
import bzrlib.tests.intertree_implementations
119
import bzrlib.tests.repository_implementations
120
import bzrlib.tests.revisionstore_implementations
121
import bzrlib.tests.tree_implementations
122
import bzrlib.tests.workingtree_implementations
125
bzrlib.tests.blackbox,
126
bzrlib.tests.branch_implementations,
127
bzrlib.tests.bzrdir_implementations,
128
bzrlib.tests.interrepository_implementations,
129
bzrlib.tests.interversionedfile_implementations,
130
bzrlib.tests.intertree_implementations,
131
bzrlib.tests.repository_implementations,
132
bzrlib.tests.revisionstore_implementations,
133
bzrlib.tests.tree_implementations,
134
bzrlib.tests.workingtree_implementations,
138
class ExtendedTestResult(unittest._TextTestResult):
139
"""Accepts, reports and accumulates the results of running tests.
141
Compared to this unittest version this class adds support for profiling,
142
benchmarking, stopping as soon as a test fails, and skipping tests.
143
There are further-specialized subclasses for different types of display.
148
def __init__(self, stream, descriptions, verbosity,
152
"""Construct new TestResult.
154
:param bench_history: Optionally, a writable file object to accumulate
157
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
158
if bench_history is not None:
159
from bzrlib.version import _get_bzr_source_tree
160
src_tree = _get_bzr_source_tree()
163
revision_id = src_tree.get_parent_ids()[0]
165
# XXX: if this is a brand new tree, do the same as if there
169
# XXX: If there's no branch, what should we do?
171
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
172
self._bench_history = bench_history
173
self.ui = bzrlib.ui.ui_factory
174
self.num_tests = num_tests
176
self.failure_count = 0
179
self._overall_start_time = time.time()
181
def extractBenchmarkTime(self, testCase):
182
"""Add a benchmark time for the current test case."""
183
self._benchmarkTime = getattr(testCase, "_benchtime", None)
185
def _elapsedTestTimeString(self):
186
"""Return a time string for the overall time the current test has taken."""
187
return self._formatTime(time.time() - self._start_time)
189
def _testTimeString(self):
190
if self._benchmarkTime is not None:
192
self._formatTime(self._benchmarkTime),
193
self._elapsedTestTimeString())
195
return " %s" % self._elapsedTestTimeString()
197
def _formatTime(self, seconds):
198
"""Format seconds as milliseconds with leading spaces."""
199
# some benchmarks can take thousands of seconds to run, so we need 8
201
return "%8dms" % (1000 * seconds)
203
def _shortened_test_description(self, test):
205
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
208
def startTest(self, test):
209
unittest.TestResult.startTest(self, test)
210
self.report_test_start(test)
211
self._recordTestStartTime()
213
def _recordTestStartTime(self):
214
"""Record that a test has started."""
215
self._start_time = time.time()
217
def addError(self, test, err):
218
if isinstance(err[1], TestSkipped):
219
return self.addSkipped(test, err)
220
unittest.TestResult.addError(self, test, err)
221
# We can only do this if we have one of our TestCases, not if
223
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
224
if setKeepLogfile is not None:
226
self.extractBenchmarkTime(test)
227
self.report_error(test, err)
231
def addFailure(self, test, err):
232
unittest.TestResult.addFailure(self, test, err)
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:
238
self.extractBenchmarkTime(test)
239
self.report_failure(test, err)
243
def addSuccess(self, test):
244
self.extractBenchmarkTime(test)
245
if self._bench_history is not None:
246
if self._benchmarkTime is not None:
247
self._bench_history.write("%s %s\n" % (
248
self._formatTime(self._benchmarkTime),
250
self.report_success(test)
251
unittest.TestResult.addSuccess(self, test)
253
def addSkipped(self, test, skip_excinfo):
254
self.extractBenchmarkTime(test)
255
self.report_skip(test, skip_excinfo)
256
# seems best to treat this as success from point-of-view of unittest
257
# -- it actually does nothing so it barely matters :)
260
except KeyboardInterrupt:
263
self.addError(test, test.__exc_info())
265
unittest.TestResult.addSuccess(self, test)
267
def printErrorList(self, flavour, errors):
268
for test, err in errors:
269
self.stream.writeln(self.separator1)
270
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
271
if getattr(test, '_get_log', None) is not None:
273
print >>self.stream, \
274
('vvvv[log from %s]' % test.id()).ljust(78,'-')
275
print >>self.stream, test._get_log()
276
print >>self.stream, \
277
('^^^^[log from %s]' % test.id()).ljust(78,'-')
278
self.stream.writeln(self.separator2)
279
self.stream.writeln("%s" % err)
284
def report_cleaning_up(self):
287
def report_success(self, test):
291
class TextTestResult(ExtendedTestResult):
292
"""Displays progress and results of tests in text form"""
294
def __init__(self, *args, **kw):
295
ExtendedTestResult.__init__(self, *args, **kw)
296
self.pb = self.ui.nested_progress_bar()
297
self.pb.show_pct = False
298
self.pb.show_spinner = False
299
self.pb.show_eta = False,
300
self.pb.show_count = False
301
self.pb.show_bar = False
303
def report_starting(self):
304
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
306
def _progress_prefix_text(self):
307
a = '[%d' % self.count
308
if self.num_tests is not None:
309
a +='/%d' % self.num_tests
310
a += ' in %ds' % (time.time() - self._overall_start_time)
312
a += ', %d errors' % self.error_count
313
if self.failure_count:
314
a += ', %d failed' % self.failure_count
316
a += ', %d skipped' % self.skip_count
320
def report_test_start(self, test):
323
self._progress_prefix_text()
325
+ self._shortened_test_description(test))
327
def report_error(self, test, err):
328
self.error_count += 1
329
self.pb.note('ERROR: %s\n %s\n',
330
self._shortened_test_description(test),
334
def report_failure(self, test, err):
335
self.failure_count += 1
336
self.pb.note('FAIL: %s\n %s\n',
337
self._shortened_test_description(test),
341
def report_skip(self, test, skip_excinfo):
344
# at the moment these are mostly not things we can fix
345
# and so they just produce stipple; use the verbose reporter
348
# show test and reason for skip
349
self.pb.note('SKIP: %s\n %s\n',
350
self._shortened_test_description(test),
353
# since the class name was left behind in the still-visible
355
self.pb.note('SKIP: %s', skip_excinfo[1])
357
def report_cleaning_up(self):
358
self.pb.update('cleaning up...')
364
class VerboseTestResult(ExtendedTestResult):
365
"""Produce long output, with one line per test run plus times"""
367
def _ellipsize_to_right(self, a_string, final_width):
368
"""Truncate and pad a string, keeping the right hand side"""
369
if len(a_string) > final_width:
370
result = '...' + a_string[3-final_width:]
373
return result.ljust(final_width)
375
def report_starting(self):
376
self.stream.write('running %d tests...\n' % self.num_tests)
378
def report_test_start(self, test):
380
name = self._shortened_test_description(test)
381
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
382
# numbers, plus a trailing blank
383
self.stream.write(self._ellipsize_to_right(name,
384
osutils.terminal_width()-30))
387
def report_error(self, test, err):
388
self.error_count += 1
389
self.stream.writeln('ERROR %s\n %s'
390
% (self._testTimeString(), err[1]))
392
def report_failure(self, test, err):
393
self.failure_count += 1
394
self.stream.writeln(' FAIL %s\n %s'
395
% (self._testTimeString(), err[1]))
397
def report_success(self, test):
398
self.stream.writeln(' OK %s' % self._testTimeString())
399
for bench_called, stats in getattr(test, '_benchcalls', []):
400
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
401
stats.pprint(file=self.stream)
404
def report_skip(self, test, skip_excinfo):
405
print >>self.stream, ' SKIP %s' % self._testTimeString()
406
print >>self.stream, ' %s' % skip_excinfo[1]
409
class TextTestRunner(object):
410
stop_on_failure = False
418
self.stream = unittest._WritelnDecorator(stream)
419
self.descriptions = descriptions
420
self.verbosity = verbosity
421
self.keep_output = keep_output
422
self._bench_history = bench_history
425
"Run the given test case or test suite."
426
startTime = time.time()
427
if self.verbosity == 1:
428
result_class = TextTestResult
429
elif self.verbosity >= 2:
430
result_class = VerboseTestResult
431
result = result_class(self.stream,
434
bench_history=self._bench_history,
435
num_tests=test.countTestCases(),
437
result.stop_early = self.stop_on_failure
438
result.report_starting()
440
stopTime = time.time()
441
timeTaken = stopTime - startTime
443
self.stream.writeln(result.separator2)
444
run = result.testsRun
445
self.stream.writeln("Ran %d test%s in %.3fs" %
446
(run, run != 1 and "s" or "", timeTaken))
447
self.stream.writeln()
448
if not result.wasSuccessful():
449
self.stream.write("FAILED (")
450
failed, errored = map(len, (result.failures, result.errors))
452
self.stream.write("failures=%d" % failed)
454
if failed: self.stream.write(", ")
455
self.stream.write("errors=%d" % errored)
456
self.stream.writeln(")")
458
self.stream.writeln("OK")
459
result.report_cleaning_up()
460
# This is still a little bogus,
461
# but only a little. Folk not using our testrunner will
462
# have to delete their temp directories themselves.
463
test_root = TestCaseWithMemoryTransport.TEST_ROOT
464
if result.wasSuccessful() or not self.keep_output:
465
if test_root is not None:
466
# If LANG=C we probably have created some bogus paths
467
# which rmtree(unicode) will fail to delete
468
# so make sure we are using rmtree(str) to delete everything
469
# except on win32, where rmtree(str) will fail
470
# since it doesn't have the property of byte-stream paths
471
# (they are either ascii or mbcs)
472
if sys.platform == 'win32':
473
# make sure we are using the unicode win32 api
474
test_root = unicode(test_root)
476
test_root = test_root.encode(
477
sys.getfilesystemencoding())
478
osutils.rmtree(test_root)
480
note("Failed tests working directories are in '%s'\n", test_root)
481
TestCaseWithMemoryTransport.TEST_ROOT = None
486
def iter_suite_tests(suite):
487
"""Return all tests in a suite, recursing through nested suites"""
488
for item in suite._tests:
489
if isinstance(item, unittest.TestCase):
491
elif isinstance(item, unittest.TestSuite):
492
for r in iter_suite_tests(item):
495
raise Exception('unknown object %r inside test suite %r'
499
class TestSkipped(Exception):
500
"""Indicates that a test was intentionally skipped, rather than failing."""
503
class CommandFailed(Exception):
507
class StringIOWrapper(object):
508
"""A wrapper around cStringIO which just adds an encoding attribute.
510
Internally we can check sys.stdout to see what the output encoding
511
should be. However, cStringIO has no encoding attribute that we can
512
set. So we wrap it instead.
517
def __init__(self, s=None):
519
self.__dict__['_cstring'] = StringIO(s)
521
self.__dict__['_cstring'] = StringIO()
523
def __getattr__(self, name, getattr=getattr):
524
return getattr(self.__dict__['_cstring'], name)
526
def __setattr__(self, name, val):
527
if name == 'encoding':
528
self.__dict__['encoding'] = val
530
return setattr(self._cstring, name, val)
533
class TestCase(unittest.TestCase):
534
"""Base class for bzr unit tests.
536
Tests that need access to disk resources should subclass
537
TestCaseInTempDir not TestCase.
539
Error and debug log messages are redirected from their usual
540
location into a temporary file, the contents of which can be
541
retrieved by _get_log(). We use a real OS file, not an in-memory object,
542
so that it can also capture file IO. When the test completes this file
543
is read into memory and removed from disk.
545
There are also convenience functions to invoke bzr's command-line
546
routine, and to build and check bzr trees.
548
In addition to the usual method of overriding tearDown(), this class also
549
allows subclasses to register functions into the _cleanups list, which is
550
run in order as the object is torn down. It's less likely this will be
551
accidentally overlooked.
554
_log_file_name = None
556
_keep_log_file = False
557
# record lsprof data when performing benchmark calls.
558
_gather_lsprof_in_benchmarks = False
560
def __init__(self, methodName='testMethod'):
561
super(TestCase, self).__init__(methodName)
565
unittest.TestCase.setUp(self)
566
self._cleanEnvironment()
567
bzrlib.trace.disable_default_logging()
570
self._benchcalls = []
571
self._benchtime = None
573
def _silenceUI(self):
574
"""Turn off UI for duration of test"""
575
# by default the UI is off; tests can turn it on if they want it.
576
saved = bzrlib.ui.ui_factory
578
bzrlib.ui.ui_factory = saved
579
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
580
self.addCleanup(_restore)
582
def _ndiff_strings(self, a, b):
583
"""Return ndiff between two strings containing lines.
585
A trailing newline is added if missing to make the strings
587
if b and b[-1] != '\n':
589
if a and a[-1] != '\n':
591
difflines = difflib.ndiff(a.splitlines(True),
593
linejunk=lambda x: False,
594
charjunk=lambda x: False)
595
return ''.join(difflines)
597
def assertEqualDiff(self, a, b, message=None):
598
"""Assert two texts are equal, if not raise an exception.
600
This is intended for use with multi-line strings where it can
601
be hard to find the differences by eye.
603
# TODO: perhaps override assertEquals to call this for strings?
607
message = "texts not equal:\n"
608
raise AssertionError(message +
609
self._ndiff_strings(a, b))
611
def assertEqualMode(self, mode, mode_test):
612
self.assertEqual(mode, mode_test,
613
'mode mismatch %o != %o' % (mode, mode_test))
615
def assertStartsWith(self, s, prefix):
616
if not s.startswith(prefix):
617
raise AssertionError('string %r does not start with %r' % (s, prefix))
619
def assertEndsWith(self, s, suffix):
620
"""Asserts that s ends with suffix."""
621
if not s.endswith(suffix):
622
raise AssertionError('string %r does not end with %r' % (s, suffix))
624
def assertContainsRe(self, haystack, needle_re):
625
"""Assert that a contains something matching a regular expression."""
626
if not re.search(needle_re, haystack):
627
raise AssertionError('pattern "%s" not found in "%s"'
628
% (needle_re, haystack))
630
def assertNotContainsRe(self, haystack, needle_re):
631
"""Assert that a does not match a regular expression"""
632
if re.search(needle_re, haystack):
633
raise AssertionError('pattern "%s" found in "%s"'
634
% (needle_re, haystack))
636
def assertSubset(self, sublist, superlist):
637
"""Assert that every entry in sublist is present in superlist."""
639
for entry in sublist:
640
if entry not in superlist:
641
missing.append(entry)
643
raise AssertionError("value(s) %r not present in container %r" %
644
(missing, superlist))
646
def assertListRaises(self, excClass, func, *args, **kwargs):
647
"""Fail unless excClass is raised when the iterator from func is used.
649
Many functions can return generators this makes sure
650
to wrap them in a list() call to make sure the whole generator
651
is run, and that the proper exception is raised.
654
list(func(*args, **kwargs))
658
if getattr(excClass,'__name__', None) is not None:
659
excName = excClass.__name__
661
excName = str(excClass)
662
raise self.failureException, "%s not raised" % excName
664
def assertIs(self, left, right):
665
if not (left is right):
666
raise AssertionError("%r is not %r." % (left, right))
668
def assertTransportMode(self, transport, path, mode):
669
"""Fail if a path does not have mode mode.
671
If modes are not supported on this transport, the assertion is ignored.
673
if not transport._can_roundtrip_unix_modebits():
675
path_stat = transport.stat(path)
676
actual_mode = stat.S_IMODE(path_stat.st_mode)
677
self.assertEqual(mode, actual_mode,
678
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
680
def assertIsInstance(self, obj, kls):
681
"""Fail if obj is not an instance of kls"""
682
if not isinstance(obj, kls):
683
self.fail("%r is an instance of %s rather than %s" % (
684
obj, obj.__class__, kls))
686
def _capture_warnings(self, a_callable, *args, **kwargs):
687
"""A helper for callDeprecated and applyDeprecated.
689
:param a_callable: A callable to call.
690
:param args: The positional arguments for the callable
691
:param kwargs: The keyword arguments for the callable
692
:return: A tuple (warnings, result). result is the result of calling
693
a_callable(*args, **kwargs).
696
def capture_warnings(msg, cls=None, stacklevel=None):
697
# we've hooked into a deprecation specific callpath,
698
# only deprecations should getting sent via it.
699
self.assertEqual(cls, DeprecationWarning)
700
local_warnings.append(msg)
701
original_warning_method = symbol_versioning.warn
702
symbol_versioning.set_warning_method(capture_warnings)
704
result = a_callable(*args, **kwargs)
706
symbol_versioning.set_warning_method(original_warning_method)
707
return (local_warnings, result)
709
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
710
"""Call a deprecated callable without warning the user.
712
:param deprecation_format: The deprecation format that the callable
713
should have been deprecated with. This is the same type as the
714
parameter to deprecated_method/deprecated_function. If the
715
callable is not deprecated with this format, an assertion error
717
:param a_callable: A callable to call. This may be a bound method or
718
a regular function. It will be called with *args and **kwargs.
719
:param args: The positional arguments for the callable
720
:param kwargs: The keyword arguments for the callable
721
:return: The result of a_callable(*args, **kwargs)
723
call_warnings, result = self._capture_warnings(a_callable,
725
expected_first_warning = symbol_versioning.deprecation_string(
726
a_callable, deprecation_format)
727
if len(call_warnings) == 0:
728
self.fail("No assertion generated by call to %s" %
730
self.assertEqual(expected_first_warning, call_warnings[0])
733
def callDeprecated(self, expected, callable, *args, **kwargs):
734
"""Assert that a callable is deprecated in a particular way.
736
This is a very precise test for unusual requirements. The
737
applyDeprecated helper function is probably more suited for most tests
738
as it allows you to simply specify the deprecation format being used
739
and will ensure that that is issued for the function being called.
741
:param expected: a list of the deprecation warnings expected, in order
742
:param callable: The callable to call
743
:param args: The positional arguments for the callable
744
:param kwargs: The keyword arguments for the callable
746
call_warnings, result = self._capture_warnings(callable,
748
self.assertEqual(expected, call_warnings)
751
def _startLogFile(self):
752
"""Send bzr and test log messages to a temporary file.
754
The file is removed as the test is torn down.
756
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
757
self._log_file = os.fdopen(fileno, 'w+')
758
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
759
self._log_file_name = name
760
self.addCleanup(self._finishLogFile)
762
def _finishLogFile(self):
763
"""Finished with the log file.
765
Close the file and delete it, unless setKeepLogfile was called.
767
if self._log_file is None:
769
bzrlib.trace.disable_test_log(self._log_nonce)
770
self._log_file.close()
771
self._log_file = None
772
if not self._keep_log_file:
773
os.remove(self._log_file_name)
774
self._log_file_name = None
776
def setKeepLogfile(self):
777
"""Make the logfile not be deleted when _finishLogFile is called."""
778
self._keep_log_file = True
780
def addCleanup(self, callable):
781
"""Arrange to run a callable when this case is torn down.
783
Callables are run in the reverse of the order they are registered,
784
ie last-in first-out.
786
if callable in self._cleanups:
787
raise ValueError("cleanup function %r already registered on %s"
789
self._cleanups.append(callable)
791
def _cleanEnvironment(self):
793
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
795
'APPDATA': os.getcwd(),
797
'BZREMAIL': None, # may still be present in the environment
799
'BZR_PROGRESS_BAR': None,
809
# Nobody cares about these ones AFAIK. So far at
810
# least. If you do (care), please update this comment
816
self.addCleanup(self._restoreEnvironment)
817
for name, value in new_env.iteritems():
818
self._captureVar(name, value)
820
def _captureVar(self, name, newvalue):
821
"""Set an environment variable, and reset it when finished."""
822
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
824
def _restoreEnvironment(self):
825
for name, value in self.__old_env.iteritems():
826
osutils.set_or_unset_env(name, value)
830
unittest.TestCase.tearDown(self)
832
def time(self, callable, *args, **kwargs):
833
"""Run callable and accrue the time it takes to the benchmark time.
835
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
836
this will cause lsprofile statistics to be gathered and stored in
839
if self._benchtime is None:
843
if not self._gather_lsprof_in_benchmarks:
844
return callable(*args, **kwargs)
846
# record this benchmark
847
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
849
self._benchcalls.append(((callable, args, kwargs), stats))
852
self._benchtime += time.time() - start
854
def _runCleanups(self):
855
"""Run registered cleanup functions.
857
This should only be called from TestCase.tearDown.
859
# TODO: Perhaps this should keep running cleanups even if
861
for cleanup_fn in reversed(self._cleanups):
864
def log(self, *args):
867
def _get_log(self, keep_log_file=False):
868
"""Return as a string the log for this test. If the file is still
869
on disk and keep_log_file=False, delete the log file and store the
870
content in self._log_contents."""
871
# flush the log file, to get all content
873
bzrlib.trace._trace_file.flush()
874
if self._log_contents:
875
return self._log_contents
876
if self._log_file_name is not None:
877
logfile = open(self._log_file_name)
879
log_contents = logfile.read()
882
if not keep_log_file:
883
self._log_contents = log_contents
884
os.remove(self._log_file_name)
887
return "DELETED log file to reduce memory footprint"
889
def capture(self, cmd, retcode=0):
890
"""Shortcut that splits cmd into words, runs, and returns stdout"""
891
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
893
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
895
"""Invoke bzr and return (stdout, stderr).
897
Useful for code that wants to check the contents of the
898
output, the way error messages are presented, etc.
900
This should be the main method for tests that want to exercise the
901
overall behavior of the bzr application (rather than a unit test
902
or a functional test of the library.)
904
Much of the old code runs bzr by forking a new copy of Python, but
905
that is slower, harder to debug, and generally not necessary.
907
This runs bzr through the interface that catches and reports
908
errors, and with logging set to something approximating the
909
default, so that error reporting can be checked.
911
:param argv: arguments to invoke bzr
912
:param retcode: expected return code, or None for don't-care.
913
:param encoding: encoding for sys.stdout and sys.stderr
914
:param stdin: A string to be used as stdin for the command.
915
:param working_dir: Change to this directory before running
918
encoding = bzrlib.user_encoding
919
if stdin is not None:
920
stdin = StringIO(stdin)
921
stdout = StringIOWrapper()
922
stderr = StringIOWrapper()
923
stdout.encoding = encoding
924
stderr.encoding = encoding
926
self.log('run bzr: %r', argv)
927
# FIXME: don't call into logging here
928
handler = logging.StreamHandler(stderr)
929
handler.setLevel(logging.INFO)
930
logger = logging.getLogger('')
931
logger.addHandler(handler)
932
old_ui_factory = bzrlib.ui.ui_factory
933
bzrlib.ui.ui_factory = bzrlib.tests.blackbox.TestUIFactory(
936
bzrlib.ui.ui_factory.stdin = stdin
939
if working_dir is not None:
940
cwd = osutils.getcwd()
941
os.chdir(working_dir)
944
saved_debug_flags = frozenset(debug.debug_flags)
945
debug.debug_flags.clear()
947
result = self.apply_redirected(stdin, stdout, stderr,
948
bzrlib.commands.run_bzr_catch_errors,
951
debug.debug_flags.update(saved_debug_flags)
953
logger.removeHandler(handler)
954
bzrlib.ui.ui_factory = old_ui_factory
958
out = stdout.getvalue()
959
err = stderr.getvalue()
961
self.log('output:\n%r', out)
963
self.log('errors:\n%r', err)
964
if retcode is not None:
965
self.assertEquals(retcode, result)
968
def run_bzr(self, *args, **kwargs):
969
"""Invoke bzr, as if it were run from the command line.
971
This should be the main method for tests that want to exercise the
972
overall behavior of the bzr application (rather than a unit test
973
or a functional test of the library.)
975
This sends the stdout/stderr results into the test's log,
976
where it may be useful for debugging. See also run_captured.
978
:param stdin: A string to be used as stdin for the command.
980
retcode = kwargs.pop('retcode', 0)
981
encoding = kwargs.pop('encoding', None)
982
stdin = kwargs.pop('stdin', None)
983
working_dir = kwargs.pop('working_dir', None)
984
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding,
985
stdin=stdin, working_dir=working_dir)
987
def run_bzr_decode(self, *args, **kwargs):
988
if 'encoding' in kwargs:
989
encoding = kwargs['encoding']
991
encoding = bzrlib.user_encoding
992
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
994
def run_bzr_error(self, error_regexes, *args, **kwargs):
995
"""Run bzr, and check that stderr contains the supplied regexes
997
:param error_regexes: Sequence of regular expressions which
998
must each be found in the error output. The relative ordering
1000
:param args: command-line arguments for bzr
1001
:param kwargs: Keyword arguments which are interpreted by run_bzr
1002
This function changes the default value of retcode to be 3,
1003
since in most cases this is run when you expect bzr to fail.
1004
:return: (out, err) The actual output of running the command (in case you
1005
want to do more inspection)
1008
# Make sure that commit is failing because there is nothing to do
1009
self.run_bzr_error(['no changes to commit'],
1010
'commit', '-m', 'my commit comment')
1011
# Make sure --strict is handling an unknown file, rather than
1012
# giving us the 'nothing to do' error
1013
self.build_tree(['unknown'])
1014
self.run_bzr_error(['Commit refused because there are unknown files'],
1015
'commit', '--strict', '-m', 'my commit comment')
1017
kwargs.setdefault('retcode', 3)
1018
out, err = self.run_bzr(*args, **kwargs)
1019
for regex in error_regexes:
1020
self.assertContainsRe(err, regex)
1023
def run_bzr_subprocess(self, *args, **kwargs):
1024
"""Run bzr in a subprocess for testing.
1026
This starts a new Python interpreter and runs bzr in there.
1027
This should only be used for tests that have a justifiable need for
1028
this isolation: e.g. they are testing startup time, or signal
1029
handling, or early startup code, etc. Subprocess code can't be
1030
profiled or debugged so easily.
1032
:param retcode: The status code that is expected. Defaults to 0. If
1033
None is supplied, the status code is not checked.
1034
:param env_changes: A dictionary which lists changes to environment
1035
variables. A value of None will unset the env variable.
1036
The values must be strings. The change will only occur in the
1037
child, so you don't need to fix the environment after running.
1038
:param universal_newlines: Convert CRLF => LF
1039
:param allow_plugins: By default the subprocess is run with
1040
--no-plugins to ensure test reproducibility. Also, it is possible
1041
for system-wide plugins to create unexpected output on stderr,
1042
which can cause unnecessary test failures.
1044
env_changes = kwargs.get('env_changes', {})
1045
working_dir = kwargs.get('working_dir', None)
1046
allow_plugins = kwargs.get('allow_plugins', False)
1047
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1048
working_dir=working_dir,
1049
allow_plugins=allow_plugins)
1050
# We distinguish between retcode=None and retcode not passed.
1051
supplied_retcode = kwargs.get('retcode', 0)
1052
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1053
universal_newlines=kwargs.get('universal_newlines', False),
1056
def start_bzr_subprocess(self, process_args, env_changes=None,
1057
skip_if_plan_to_signal=False,
1059
allow_plugins=False):
1060
"""Start bzr in a subprocess for testing.
1062
This starts a new Python interpreter and runs bzr in there.
1063
This should only be used for tests that have a justifiable need for
1064
this isolation: e.g. they are testing startup time, or signal
1065
handling, or early startup code, etc. Subprocess code can't be
1066
profiled or debugged so easily.
1068
:param process_args: a list of arguments to pass to the bzr executable,
1069
for example `['--version']`.
1070
:param env_changes: A dictionary which lists changes to environment
1071
variables. A value of None will unset the env variable.
1072
The values must be strings. The change will only occur in the
1073
child, so you don't need to fix the environment after running.
1074
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1076
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1078
:returns: Popen object for the started process.
1080
if skip_if_plan_to_signal:
1081
if not getattr(os, 'kill', None):
1082
raise TestSkipped("os.kill not available.")
1084
if env_changes is None:
1088
def cleanup_environment():
1089
for env_var, value in env_changes.iteritems():
1090
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1092
def restore_environment():
1093
for env_var, value in old_env.iteritems():
1094
osutils.set_or_unset_env(env_var, value)
1096
bzr_path = self.get_bzr_path()
1099
if working_dir is not None:
1100
cwd = osutils.getcwd()
1101
os.chdir(working_dir)
1104
# win32 subprocess doesn't support preexec_fn
1105
# so we will avoid using it on all platforms, just to
1106
# make sure the code path is used, and we don't break on win32
1107
cleanup_environment()
1108
command = [sys.executable, bzr_path]
1109
if not allow_plugins:
1110
command.append('--no-plugins')
1111
command.extend(process_args)
1112
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1114
restore_environment()
1120
def _popen(self, *args, **kwargs):
1121
"""Place a call to Popen.
1123
Allows tests to override this method to intercept the calls made to
1124
Popen for introspection.
1126
return Popen(*args, **kwargs)
1128
def get_bzr_path(self):
1129
"""Return the path of the 'bzr' executable for this test suite."""
1130
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1131
if not os.path.isfile(bzr_path):
1132
# We are probably installed. Assume sys.argv is the right file
1133
bzr_path = sys.argv[0]
1136
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1137
universal_newlines=False, process_args=None):
1138
"""Finish the execution of process.
1140
:param process: the Popen object returned from start_bzr_subprocess.
1141
:param retcode: The status code that is expected. Defaults to 0. If
1142
None is supplied, the status code is not checked.
1143
:param send_signal: an optional signal to send to the process.
1144
:param universal_newlines: Convert CRLF => LF
1145
:returns: (stdout, stderr)
1147
if send_signal is not None:
1148
os.kill(process.pid, send_signal)
1149
out, err = process.communicate()
1151
if universal_newlines:
1152
out = out.replace('\r\n', '\n')
1153
err = err.replace('\r\n', '\n')
1155
if retcode is not None and retcode != process.returncode:
1156
if process_args is None:
1157
process_args = "(unknown args)"
1158
mutter('Output of bzr %s:\n%s', process_args, out)
1159
mutter('Error for bzr %s:\n%s', process_args, err)
1160
self.fail('Command bzr %s failed with retcode %s != %s'
1161
% (process_args, retcode, process.returncode))
1164
def check_inventory_shape(self, inv, shape):
1165
"""Compare an inventory to a list of expected names.
1167
Fail if they are not precisely equal.
1170
shape = list(shape) # copy
1171
for path, ie in inv.entries():
1172
name = path.replace('\\', '/')
1173
if ie.kind == 'dir':
1180
self.fail("expected paths not found in inventory: %r" % shape)
1182
self.fail("unexpected paths found in inventory: %r" % extras)
1184
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1185
a_callable=None, *args, **kwargs):
1186
"""Call callable with redirected std io pipes.
1188
Returns the return code."""
1189
if not callable(a_callable):
1190
raise ValueError("a_callable must be callable.")
1192
stdin = StringIO("")
1194
if getattr(self, "_log_file", None) is not None:
1195
stdout = self._log_file
1199
if getattr(self, "_log_file", None is not None):
1200
stderr = self._log_file
1203
real_stdin = sys.stdin
1204
real_stdout = sys.stdout
1205
real_stderr = sys.stderr
1210
return a_callable(*args, **kwargs)
1212
sys.stdout = real_stdout
1213
sys.stderr = real_stderr
1214
sys.stdin = real_stdin
1216
@symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
1217
def merge(self, branch_from, wt_to):
1218
"""A helper for tests to do a ui-less merge.
1220
This should move to the main library when someone has time to integrate
1223
# minimal ui-less merge.
1224
wt_to.branch.fetch(branch_from)
1225
base_rev = common_ancestor(branch_from.last_revision(),
1226
wt_to.branch.last_revision(),
1227
wt_to.branch.repository)
1228
merge_inner(wt_to.branch, branch_from.basis_tree(),
1229
wt_to.branch.repository.revision_tree(base_rev),
1231
wt_to.add_parent_tree_id(branch_from.last_revision())
1234
BzrTestBase = TestCase
1237
class TestCaseWithMemoryTransport(TestCase):
1238
"""Common test class for tests that do not need disk resources.
1240
Tests that need disk resources should derive from TestCaseWithTransport.
1242
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1244
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1245
a directory which does not exist. This serves to help ensure test isolation
1246
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1247
must exist. However, TestCaseWithMemoryTransport does not offer local
1248
file defaults for the transport in tests, nor does it obey the command line
1249
override, so tests that accidentally write to the common directory should
1257
def __init__(self, methodName='runTest'):
1258
# allow test parameterisation after test construction and before test
1259
# execution. Variables that the parameteriser sets need to be
1260
# ones that are not set by setUp, or setUp will trash them.
1261
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1262
self.vfs_transport_factory = default_transport
1263
self.transport_server = None
1264
self.transport_readonly_server = None
1265
self.__vfs_server = None
1267
def failUnlessExists(self, path):
1268
"""Fail unless path, which may be abs or relative, exists."""
1269
self.failUnless(osutils.lexists(path))
1271
def failIfExists(self, path):
1272
"""Fail if path, which may be abs or relative, exists."""
1273
self.failIf(osutils.lexists(path))
1275
def get_transport(self):
1276
"""Return a writeable transport for the test scratch space"""
1277
t = get_transport(self.get_url())
1278
self.assertFalse(t.is_readonly())
1281
def get_readonly_transport(self):
1282
"""Return a readonly transport for the test scratch space
1284
This can be used to test that operations which should only need
1285
readonly access in fact do not try to write.
1287
t = get_transport(self.get_readonly_url())
1288
self.assertTrue(t.is_readonly())
1291
def create_transport_readonly_server(self):
1292
"""Create a transport server from class defined at init.
1294
This is mostly a hook for daughter classes.
1296
return self.transport_readonly_server()
1298
def get_readonly_server(self):
1299
"""Get the server instance for the readonly transport
1301
This is useful for some tests with specific servers to do diagnostics.
1303
if self.__readonly_server is None:
1304
if self.transport_readonly_server is None:
1305
# readonly decorator requested
1306
# bring up the server
1307
self.__readonly_server = ReadonlyServer()
1308
self.__readonly_server.setUp(self.get_vfs_only_server())
1310
self.__readonly_server = self.create_transport_readonly_server()
1311
self.__readonly_server.setUp(self.get_vfs_only_server())
1312
self.addCleanup(self.__readonly_server.tearDown)
1313
return self.__readonly_server
1315
def get_readonly_url(self, relpath=None):
1316
"""Get a URL for the readonly transport.
1318
This will either be backed by '.' or a decorator to the transport
1319
used by self.get_url()
1320
relpath provides for clients to get a path relative to the base url.
1321
These should only be downwards relative, not upwards.
1323
base = self.get_readonly_server().get_url()
1324
if relpath is not None:
1325
if not base.endswith('/'):
1327
base = base + relpath
1330
def get_vfs_only_server(self):
1331
"""Get the vfs only read/write server instance.
1333
This is useful for some tests with specific servers that need
1336
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1337
is no means to override it.
1339
if self.__vfs_server is None:
1340
self.__vfs_server = MemoryServer()
1341
self.__vfs_server.setUp()
1342
self.addCleanup(self.__vfs_server.tearDown)
1343
return self.__vfs_server
1345
def get_server(self):
1346
"""Get the read/write server instance.
1348
This is useful for some tests with specific servers that need
1351
This is built from the self.transport_server factory. If that is None,
1352
then the self.get_vfs_server is returned.
1354
if self.__server is None:
1355
if self.transport_server is None:
1356
return self.get_vfs_only_server()
1358
# bring up a decorated means of access to the vfs only server.
1359
self.__server = self.transport_server()
1360
self.__server.setUp(self.get_vfs_only_server())
1361
self.addCleanup(self.__server.tearDown)
1362
return self.__server
1364
def _adjust_url(self, base, relpath):
1365
"""Get a URL (or maybe a path) for the readwrite transport.
1367
This will either be backed by '.' or to an equivalent non-file based
1369
relpath provides for clients to get a path relative to the base url.
1370
These should only be downwards relative, not upwards.
1372
if relpath is not None and relpath != '.':
1373
if not base.endswith('/'):
1375
# XXX: Really base should be a url; we did after all call
1376
# get_url()! But sometimes it's just a path (from
1377
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1378
# to a non-escaped local path.
1379
if base.startswith('./') or base.startswith('/'):
1382
base += urlutils.escape(relpath)
1385
def get_url(self, relpath=None):
1386
"""Get a URL (or maybe a path) for the readwrite transport.
1388
This will either be backed by '.' or to an equivalent non-file based
1390
relpath provides for clients to get a path relative to the base url.
1391
These should only be downwards relative, not upwards.
1393
base = self.get_server().get_url()
1394
return self._adjust_url(base, relpath)
1396
def get_vfs_only_url(self, relpath=None):
1397
"""Get a URL (or maybe a path for the plain old vfs transport.
1399
This will never be a smart protocol.
1400
:param relpath: provides for clients to get a path relative to the base
1401
url. These should only be downwards relative, not upwards.
1403
base = self.get_vfs_only_server().get_url()
1404
return self._adjust_url(base, relpath)
1406
def _make_test_root(self):
1407
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1411
root = u'test%04d.tmp' % i
1415
if e.errno == errno.EEXIST:
1420
# successfully created
1421
TestCaseWithMemoryTransport.TEST_ROOT = osutils.abspath(root)
1423
# make a fake bzr directory there to prevent any tests propagating
1424
# up onto the source directory's real branch
1425
bzrdir.BzrDir.create_standalone_workingtree(
1426
TestCaseWithMemoryTransport.TEST_ROOT)
1428
def makeAndChdirToTestDir(self):
1429
"""Create a temporary directories for this one test.
1431
This must set self.test_home_dir and self.test_dir and chdir to
1434
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1436
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1437
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1438
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1440
def make_branch(self, relpath, format=None):
1441
"""Create a branch on the transport at relpath."""
1442
repo = self.make_repository(relpath, format=format)
1443
return repo.bzrdir.create_branch()
1445
def make_bzrdir(self, relpath, format=None):
1447
# might be a relative or absolute path
1448
maybe_a_url = self.get_url(relpath)
1449
segments = maybe_a_url.rsplit('/', 1)
1450
t = get_transport(maybe_a_url)
1451
if len(segments) > 1 and segments[-1] not in ('', '.'):
1454
except errors.FileExists:
1457
format = bzrlib.bzrdir.BzrDirFormat.get_default_format()
1458
return format.initialize_on_transport(t)
1459
except errors.UninitializableFormat:
1460
raise TestSkipped("Format %s is not initializable." % format)
1462
def make_repository(self, relpath, shared=False, format=None):
1463
"""Create a repository on our default transport at relpath."""
1464
made_control = self.make_bzrdir(relpath, format=format)
1465
return made_control.create_repository(shared=shared)
1467
def make_branch_and_memory_tree(self, relpath, format=None):
1468
"""Create a branch on the default transport and a MemoryTree for it."""
1469
b = self.make_branch(relpath, format=format)
1470
return memorytree.MemoryTree.create_on_branch(b)
1472
def overrideEnvironmentForTesting(self):
1473
os.environ['HOME'] = self.test_home_dir
1474
os.environ['APPDATA'] = self.test_home_dir
1477
super(TestCaseWithMemoryTransport, self).setUp()
1478
self._make_test_root()
1479
_currentdir = os.getcwdu()
1480
def _leaveDirectory():
1481
os.chdir(_currentdir)
1482
self.addCleanup(_leaveDirectory)
1483
self.makeAndChdirToTestDir()
1484
self.overrideEnvironmentForTesting()
1485
self.__readonly_server = None
1486
self.__server = None
1489
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1490
"""Derived class that runs a test within a temporary directory.
1492
This is useful for tests that need to create a branch, etc.
1494
The directory is created in a slightly complex way: for each
1495
Python invocation, a new temporary top-level directory is created.
1496
All test cases create their own directory within that. If the
1497
tests complete successfully, the directory is removed.
1499
InTempDir is an old alias for FunctionalTestCase.
1502
OVERRIDE_PYTHON = 'python'
1504
def check_file_contents(self, filename, expect):
1505
self.log("check contents of file %s" % filename)
1506
contents = file(filename, 'r').read()
1507
if contents != expect:
1508
self.log("expected: %r" % expect)
1509
self.log("actually: %r" % contents)
1510
self.fail("contents of %s not as expected" % filename)
1512
def makeAndChdirToTestDir(self):
1513
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1515
For TestCaseInTempDir we create a temporary directory based on the test
1516
name and then create two subdirs - test and home under it.
1518
# shorten the name, to avoid test failures due to path length
1519
short_id = self.id().replace('bzrlib.tests.', '') \
1520
.replace('__main__.', '')[-100:]
1521
# it's possible the same test class is run several times for
1522
# parameterized tests, so make sure the names don't collide.
1526
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1528
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1529
if os.path.exists(candidate_dir):
1533
os.mkdir(candidate_dir)
1534
self.test_home_dir = candidate_dir + '/home'
1535
os.mkdir(self.test_home_dir)
1536
self.test_dir = candidate_dir + '/work'
1537
os.mkdir(self.test_dir)
1538
os.chdir(self.test_dir)
1541
def build_tree(self, shape, line_endings='binary', transport=None):
1542
"""Build a test tree according to a pattern.
1544
shape is a sequence of file specifications. If the final
1545
character is '/', a directory is created.
1547
This assumes that all the elements in the tree being built are new.
1549
This doesn't add anything to a branch.
1550
:param line_endings: Either 'binary' or 'native'
1551
in binary mode, exact contents are written
1552
in native mode, the line endings match the
1553
default platform endings.
1555
:param transport: A transport to write to, for building trees on
1556
VFS's. If the transport is readonly or None,
1557
"." is opened automatically.
1559
# It's OK to just create them using forward slashes on windows.
1560
if transport is None or transport.is_readonly():
1561
transport = get_transport(".")
1563
self.assert_(isinstance(name, basestring))
1565
transport.mkdir(urlutils.escape(name[:-1]))
1567
if line_endings == 'binary':
1569
elif line_endings == 'native':
1572
raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
1573
content = "contents of %s%s" % (name.encode('utf-8'), end)
1574
# Technically 'put()' is the right command. However, put
1575
# uses an AtomicFile, which requires an extra rename into place
1576
# As long as the files didn't exist in the past, append() will
1577
# do the same thing as put()
1578
# On jam's machine, make_kernel_like_tree is:
1579
# put: 4.5-7.5s (averaging 6s)
1581
# put_non_atomic: 2.9-4.5s
1582
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1584
def build_tree_contents(self, shape):
1585
build_tree_contents(shape)
1587
def assertFileEqual(self, content, path):
1588
"""Fail if path does not contain 'content'."""
1589
self.failUnless(osutils.lexists(path))
1590
# TODO: jam 20060427 Shouldn't this be 'rb'?
1591
self.assertEqualDiff(content, open(path, 'r').read())
1594
class TestCaseWithTransport(TestCaseInTempDir):
1595
"""A test case that provides get_url and get_readonly_url facilities.
1597
These back onto two transport servers, one for readonly access and one for
1600
If no explicit class is provided for readonly access, a
1601
ReadonlyTransportDecorator is used instead which allows the use of non disk
1602
based read write transports.
1604
If an explicit class is provided for readonly access, that server and the
1605
readwrite one must both define get_url() as resolving to os.getcwd().
1608
def get_vfs_only_server(self):
1609
"""See TestCaseWithMemoryTransport.
1611
This is useful for some tests with specific servers that need
1614
if self.__vfs_server is None:
1615
self.__vfs_server = self.vfs_transport_factory()
1616
self.__vfs_server.setUp()
1617
self.addCleanup(self.__vfs_server.tearDown)
1618
return self.__vfs_server
1620
def make_branch_and_tree(self, relpath, format=None):
1621
"""Create a branch on the transport and a tree locally.
1623
If the transport is not a LocalTransport, the Tree can't be created on
1624
the transport. In that case the working tree is created in the local
1625
directory, and the returned tree's branch and repository will also be
1628
This will fail if the original default transport for this test
1629
case wasn't backed by the working directory, as the branch won't
1630
be on disk for us to open it.
1632
:param format: The BzrDirFormat.
1633
:returns: the WorkingTree.
1635
# TODO: always use the local disk path for the working tree,
1636
# this obviously requires a format that supports branch references
1637
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1639
b = self.make_branch(relpath, format=format)
1641
return b.bzrdir.create_workingtree()
1642
except errors.NotLocalUrl:
1643
# We can only make working trees locally at the moment. If the
1644
# transport can't support them, then reopen the branch on a local
1645
# transport, and create the working tree there.
1647
# Possibly we should instead keep
1648
# the non-disk-backed branch and create a local checkout?
1649
bd = bzrdir.BzrDir.open(relpath)
1650
return bd.create_workingtree()
1652
def assertIsDirectory(self, relpath, transport):
1653
"""Assert that relpath within transport is a directory.
1655
This may not be possible on all transports; in that case it propagates
1656
a TransportNotPossible.
1659
mode = transport.stat(relpath).st_mode
1660
except errors.NoSuchFile:
1661
self.fail("path %s is not a directory; no such file"
1663
if not stat.S_ISDIR(mode):
1664
self.fail("path %s is not a directory; has mode %#o"
1668
super(TestCaseWithTransport, self).setUp()
1669
self.__vfs_server = None
1672
class ChrootedTestCase(TestCaseWithTransport):
1673
"""A support class that provides readonly urls outside the local namespace.
1675
This is done by checking if self.transport_server is a MemoryServer. if it
1676
is then we are chrooted already, if it is not then an HttpServer is used
1679
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1680
be used without needed to redo it when a different
1681
subclass is in use ?
1685
super(ChrootedTestCase, self).setUp()
1686
# NB: one HttpServer is taught to decorate properly,
1687
# this hack can be removed.
1688
if not self.vfs_transport_factory == MemoryServer:
1689
self.transport_readonly_server = HttpServer
1692
def filter_suite_by_re(suite, pattern):
1693
result = TestUtil.TestSuite()
1694
filter_re = re.compile(pattern)
1695
for test in iter_suite_tests(suite):
1696
if filter_re.search(test.id()):
1697
result.addTest(test)
1701
def run_suite(suite, name='test', verbose=False, pattern=".*",
1702
stop_on_failure=False, keep_output=False,
1703
transport=None, lsprof_timed=None, bench_history=None):
1704
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1709
runner = TextTestRunner(stream=sys.stdout,
1711
verbosity=verbosity,
1712
keep_output=keep_output,
1713
bench_history=bench_history)
1714
runner.stop_on_failure=stop_on_failure
1716
suite = filter_suite_by_re(suite, pattern)
1717
result = runner.run(suite)
1718
return result.wasSuccessful()
1721
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1724
test_suite_factory=None,
1726
bench_history=None):
1727
"""Run the whole test suite under the enhanced runner"""
1728
# XXX: Very ugly way to do this...
1729
# Disable warning about old formats because we don't want it to disturb
1730
# any blackbox tests.
1731
from bzrlib import repository
1732
repository._deprecation_warning_done = True
1734
global default_transport
1735
if transport is None:
1736
transport = default_transport
1737
old_transport = default_transport
1738
default_transport = transport
1740
if test_suite_factory is None:
1741
suite = test_suite()
1743
suite = test_suite_factory()
1744
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1745
stop_on_failure=stop_on_failure, keep_output=keep_output,
1746
transport=transport,
1747
lsprof_timed=lsprof_timed,
1748
bench_history=bench_history)
1750
default_transport = old_transport
1754
"""Build and return TestSuite for the whole of bzrlib.
1756
This function can be replaced if you need to change the default test
1757
suite on a global basis, but it is not encouraged.
1760
'bzrlib.tests.test_ancestry',
1761
'bzrlib.tests.test_annotate',
1762
'bzrlib.tests.test_api',
1763
'bzrlib.tests.test_atomicfile',
1764
'bzrlib.tests.test_bad_files',
1765
'bzrlib.tests.test_branch',
1766
'bzrlib.tests.test_bundle',
1767
'bzrlib.tests.test_bzrdir',
1768
'bzrlib.tests.test_cache_utf8',
1769
'bzrlib.tests.test_commands',
1770
'bzrlib.tests.test_commit',
1771
'bzrlib.tests.test_commit_merge',
1772
'bzrlib.tests.test_config',
1773
'bzrlib.tests.test_conflicts',
1774
'bzrlib.tests.test_decorators',
1775
'bzrlib.tests.test_diff',
1776
'bzrlib.tests.test_doc_generate',
1777
'bzrlib.tests.test_errors',
1778
'bzrlib.tests.test_escaped_store',
1779
'bzrlib.tests.test_fetch',
1780
'bzrlib.tests.test_ftp_transport',
1781
'bzrlib.tests.test_generate_ids',
1782
'bzrlib.tests.test_globbing',
1783
'bzrlib.tests.test_gpg',
1784
'bzrlib.tests.test_graph',
1785
'bzrlib.tests.test_hashcache',
1786
'bzrlib.tests.test_http',
1787
'bzrlib.tests.test_http_response',
1788
'bzrlib.tests.test_identitymap',
1789
'bzrlib.tests.test_ignores',
1790
'bzrlib.tests.test_inv',
1791
'bzrlib.tests.test_knit',
1792
'bzrlib.tests.test_lazy_import',
1793
'bzrlib.tests.test_lazy_regex',
1794
'bzrlib.tests.test_lockdir',
1795
'bzrlib.tests.test_lockable_files',
1796
'bzrlib.tests.test_log',
1797
'bzrlib.tests.test_memorytree',
1798
'bzrlib.tests.test_merge',
1799
'bzrlib.tests.test_merge3',
1800
'bzrlib.tests.test_merge_core',
1801
'bzrlib.tests.test_missing',
1802
'bzrlib.tests.test_msgeditor',
1803
'bzrlib.tests.test_nonascii',
1804
'bzrlib.tests.test_options',
1805
'bzrlib.tests.test_osutils',
1806
'bzrlib.tests.test_patch',
1807
'bzrlib.tests.test_patches',
1808
'bzrlib.tests.test_permissions',
1809
'bzrlib.tests.test_plugins',
1810
'bzrlib.tests.test_progress',
1811
'bzrlib.tests.test_reconcile',
1812
'bzrlib.tests.test_registry',
1813
'bzrlib.tests.test_remote',
1814
'bzrlib.tests.test_repository',
1815
'bzrlib.tests.test_revert',
1816
'bzrlib.tests.test_revision',
1817
'bzrlib.tests.test_revisionnamespaces',
1818
'bzrlib.tests.test_revisiontree',
1819
'bzrlib.tests.test_rio',
1820
'bzrlib.tests.test_sampler',
1821
'bzrlib.tests.test_selftest',
1822
'bzrlib.tests.test_setup',
1823
'bzrlib.tests.test_sftp_transport',
1824
'bzrlib.tests.test_smart',
1825
'bzrlib.tests.test_smart_add',
1826
'bzrlib.tests.test_smart_transport',
1827
'bzrlib.tests.test_source',
1828
'bzrlib.tests.test_status',
1829
'bzrlib.tests.test_store',
1830
'bzrlib.tests.test_symbol_versioning',
1831
'bzrlib.tests.test_testament',
1832
'bzrlib.tests.test_textfile',
1833
'bzrlib.tests.test_textmerge',
1834
'bzrlib.tests.test_trace',
1835
'bzrlib.tests.test_transactions',
1836
'bzrlib.tests.test_transform',
1837
'bzrlib.tests.test_transport',
1838
'bzrlib.tests.test_tree',
1839
'bzrlib.tests.test_treebuilder',
1840
'bzrlib.tests.test_tsort',
1841
'bzrlib.tests.test_tuned_gzip',
1842
'bzrlib.tests.test_ui',
1843
'bzrlib.tests.test_upgrade',
1844
'bzrlib.tests.test_urlutils',
1845
'bzrlib.tests.test_versionedfile',
1846
'bzrlib.tests.test_version',
1847
'bzrlib.tests.test_version_info',
1848
'bzrlib.tests.test_weave',
1849
'bzrlib.tests.test_whitebox',
1850
'bzrlib.tests.test_workingtree',
1851
'bzrlib.tests.test_wsgi',
1852
'bzrlib.tests.test_xml',
1854
test_transport_implementations = [
1855
'bzrlib.tests.test_transport_implementations',
1856
'bzrlib.tests.test_read_bundle',
1858
suite = TestUtil.TestSuite()
1859
loader = TestUtil.TestLoader()
1860
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1861
from bzrlib.transport import TransportTestProviderAdapter
1862
adapter = TransportTestProviderAdapter()
1863
adapt_modules(test_transport_implementations, adapter, loader, suite)
1864
for package in packages_to_test():
1865
suite.addTest(package.test_suite())
1866
for m in MODULES_TO_TEST:
1867
suite.addTest(loader.loadTestsFromModule(m))
1868
for m in MODULES_TO_DOCTEST:
1870
suite.addTest(doctest.DocTestSuite(m))
1871
except ValueError, e:
1872
print '**failed to get doctest for: %s\n%s' %(m,e)
1874
for name, plugin in bzrlib.plugin.all_plugins().items():
1875
if getattr(plugin, 'test_suite', None) is not None:
1876
suite.addTest(plugin.test_suite())
1880
def adapt_modules(mods_list, adapter, loader, suite):
1881
"""Adapt the modules in mods_list using adapter and add to suite."""
1882
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1883
suite.addTests(adapter.adapt(test))
1886
def clean_selftest_output(root=None, quiet=False):
1887
"""Remove all selftest output directories from root directory.
1889
:param root: root directory for clean
1890
(if ommitted or None then clean current directory).
1891
:param quiet: suppress report about deleting directories
1896
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
1899
for i in os.listdir(root):
1900
if os.path.isdir(i) and re_dir.match(i):
1902
print 'delete directory:', i
added
removed
bzrlib/tests/__init__.py
