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, message=None):
665
if not (left is right):
666
if message is not None:
667
raise AssertionError(message)
669
raise AssertionError("%r is not %r." % (left, right))
671
def assertIsNot(self, left, right, message=None):
673
if message is not None:
674
raise AssertionError(message)
676
raise AssertionError("%r is %r." % (left, right))
678
def assertTransportMode(self, transport, path, mode):
679
"""Fail if a path does not have mode mode.
681
If modes are not supported on this transport, the assertion is ignored.
683
if not transport._can_roundtrip_unix_modebits():
685
path_stat = transport.stat(path)
686
actual_mode = stat.S_IMODE(path_stat.st_mode)
687
self.assertEqual(mode, actual_mode,
688
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
690
def assertIsInstance(self, obj, kls):
691
"""Fail if obj is not an instance of kls"""
692
if not isinstance(obj, kls):
693
self.fail("%r is an instance of %s rather than %s" % (
694
obj, obj.__class__, kls))
696
def _capture_warnings(self, a_callable, *args, **kwargs):
697
"""A helper for callDeprecated and applyDeprecated.
699
:param a_callable: A callable to call.
700
:param args: The positional arguments for the callable
701
:param kwargs: The keyword arguments for the callable
702
:return: A tuple (warnings, result). result is the result of calling
703
a_callable(*args, **kwargs).
706
def capture_warnings(msg, cls=None, stacklevel=None):
707
# we've hooked into a deprecation specific callpath,
708
# only deprecations should getting sent via it.
709
self.assertEqual(cls, DeprecationWarning)
710
local_warnings.append(msg)
711
original_warning_method = symbol_versioning.warn
712
symbol_versioning.set_warning_method(capture_warnings)
714
result = a_callable(*args, **kwargs)
716
symbol_versioning.set_warning_method(original_warning_method)
717
return (local_warnings, result)
719
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
720
"""Call a deprecated callable without warning the user.
722
:param deprecation_format: The deprecation format that the callable
723
should have been deprecated with. This is the same type as the
724
parameter to deprecated_method/deprecated_function. If the
725
callable is not deprecated with this format, an assertion error
727
:param a_callable: A callable to call. This may be a bound method or
728
a regular function. It will be called with *args and **kwargs.
729
:param args: The positional arguments for the callable
730
:param kwargs: The keyword arguments for the callable
731
:return: The result of a_callable(*args, **kwargs)
733
call_warnings, result = self._capture_warnings(a_callable,
735
expected_first_warning = symbol_versioning.deprecation_string(
736
a_callable, deprecation_format)
737
if len(call_warnings) == 0:
738
self.fail("No assertion generated by call to %s" %
740
self.assertEqual(expected_first_warning, call_warnings[0])
743
def callDeprecated(self, expected, callable, *args, **kwargs):
744
"""Assert that a callable is deprecated in a particular way.
746
This is a very precise test for unusual requirements. The
747
applyDeprecated helper function is probably more suited for most tests
748
as it allows you to simply specify the deprecation format being used
749
and will ensure that that is issued for the function being called.
751
:param expected: a list of the deprecation warnings expected, in order
752
:param callable: The callable to call
753
:param args: The positional arguments for the callable
754
:param kwargs: The keyword arguments for the callable
756
call_warnings, result = self._capture_warnings(callable,
758
self.assertEqual(expected, call_warnings)
761
def _startLogFile(self):
762
"""Send bzr and test log messages to a temporary file.
764
The file is removed as the test is torn down.
766
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
767
self._log_file = os.fdopen(fileno, 'w+')
768
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
769
self._log_file_name = name
770
self.addCleanup(self._finishLogFile)
772
def _finishLogFile(self):
773
"""Finished with the log file.
775
Close the file and delete it, unless setKeepLogfile was called.
777
if self._log_file is None:
779
bzrlib.trace.disable_test_log(self._log_nonce)
780
self._log_file.close()
781
self._log_file = None
782
if not self._keep_log_file:
783
os.remove(self._log_file_name)
784
self._log_file_name = None
786
def setKeepLogfile(self):
787
"""Make the logfile not be deleted when _finishLogFile is called."""
788
self._keep_log_file = True
790
def addCleanup(self, callable):
791
"""Arrange to run a callable when this case is torn down.
793
Callables are run in the reverse of the order they are registered,
794
ie last-in first-out.
796
if callable in self._cleanups:
797
raise ValueError("cleanup function %r already registered on %s"
799
self._cleanups.append(callable)
801
def _cleanEnvironment(self):
803
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
805
'APPDATA': os.getcwd(),
807
'BZREMAIL': None, # may still be present in the environment
809
'BZR_PROGRESS_BAR': None,
819
# Nobody cares about these ones AFAIK. So far at
820
# least. If you do (care), please update this comment
826
self.addCleanup(self._restoreEnvironment)
827
for name, value in new_env.iteritems():
828
self._captureVar(name, value)
830
def _captureVar(self, name, newvalue):
831
"""Set an environment variable, and reset it when finished."""
832
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
834
def _restoreEnvironment(self):
835
for name, value in self.__old_env.iteritems():
836
osutils.set_or_unset_env(name, value)
840
unittest.TestCase.tearDown(self)
842
def time(self, callable, *args, **kwargs):
843
"""Run callable and accrue the time it takes to the benchmark time.
845
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
846
this will cause lsprofile statistics to be gathered and stored in
849
if self._benchtime is None:
853
if not self._gather_lsprof_in_benchmarks:
854
return callable(*args, **kwargs)
856
# record this benchmark
857
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
859
self._benchcalls.append(((callable, args, kwargs), stats))
862
self._benchtime += time.time() - start
864
def _runCleanups(self):
865
"""Run registered cleanup functions.
867
This should only be called from TestCase.tearDown.
869
# TODO: Perhaps this should keep running cleanups even if
871
for cleanup_fn in reversed(self._cleanups):
874
def log(self, *args):
877
def _get_log(self, keep_log_file=False):
878
"""Return as a string the log for this test. If the file is still
879
on disk and keep_log_file=False, delete the log file and store the
880
content in self._log_contents."""
881
# flush the log file, to get all content
883
bzrlib.trace._trace_file.flush()
884
if self._log_contents:
885
return self._log_contents
886
if self._log_file_name is not None:
887
logfile = open(self._log_file_name)
889
log_contents = logfile.read()
892
if not keep_log_file:
893
self._log_contents = log_contents
894
os.remove(self._log_file_name)
897
return "DELETED log file to reduce memory footprint"
899
def capture(self, cmd, retcode=0):
900
"""Shortcut that splits cmd into words, runs, and returns stdout"""
901
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
903
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
905
"""Invoke bzr and return (stdout, stderr).
907
Useful for code that wants to check the contents of the
908
output, the way error messages are presented, etc.
910
This should be the main method for tests that want to exercise the
911
overall behavior of the bzr application (rather than a unit test
912
or a functional test of the library.)
914
Much of the old code runs bzr by forking a new copy of Python, but
915
that is slower, harder to debug, and generally not necessary.
917
This runs bzr through the interface that catches and reports
918
errors, and with logging set to something approximating the
919
default, so that error reporting can be checked.
921
:param argv: arguments to invoke bzr
922
:param retcode: expected return code, or None for don't-care.
923
:param encoding: encoding for sys.stdout and sys.stderr
924
:param stdin: A string to be used as stdin for the command.
925
:param working_dir: Change to this directory before running
928
encoding = bzrlib.user_encoding
929
if stdin is not None:
930
stdin = StringIO(stdin)
931
stdout = StringIOWrapper()
932
stderr = StringIOWrapper()
933
stdout.encoding = encoding
934
stderr.encoding = encoding
936
self.log('run bzr: %r', argv)
937
# FIXME: don't call into logging here
938
handler = logging.StreamHandler(stderr)
939
handler.setLevel(logging.INFO)
940
logger = logging.getLogger('')
941
logger.addHandler(handler)
942
old_ui_factory = bzrlib.ui.ui_factory
943
bzrlib.ui.ui_factory = bzrlib.tests.blackbox.TestUIFactory(
946
bzrlib.ui.ui_factory.stdin = stdin
949
if working_dir is not None:
950
cwd = osutils.getcwd()
951
os.chdir(working_dir)
954
saved_debug_flags = frozenset(debug.debug_flags)
955
debug.debug_flags.clear()
957
result = self.apply_redirected(stdin, stdout, stderr,
958
bzrlib.commands.run_bzr_catch_errors,
961
debug.debug_flags.update(saved_debug_flags)
963
logger.removeHandler(handler)
964
bzrlib.ui.ui_factory = old_ui_factory
968
out = stdout.getvalue()
969
err = stderr.getvalue()
971
self.log('output:\n%r', out)
973
self.log('errors:\n%r', err)
974
if retcode is not None:
975
self.assertEquals(retcode, result)
978
def run_bzr(self, *args, **kwargs):
979
"""Invoke bzr, as if it were run from the command line.
981
This should be the main method for tests that want to exercise the
982
overall behavior of the bzr application (rather than a unit test
983
or a functional test of the library.)
985
This sends the stdout/stderr results into the test's log,
986
where it may be useful for debugging. See also run_captured.
988
:param stdin: A string to be used as stdin for the command.
990
retcode = kwargs.pop('retcode', 0)
991
encoding = kwargs.pop('encoding', None)
992
stdin = kwargs.pop('stdin', None)
993
working_dir = kwargs.pop('working_dir', None)
994
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding,
995
stdin=stdin, working_dir=working_dir)
997
def run_bzr_decode(self, *args, **kwargs):
998
if 'encoding' in kwargs:
999
encoding = kwargs['encoding']
1001
encoding = bzrlib.user_encoding
1002
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1004
def run_bzr_error(self, error_regexes, *args, **kwargs):
1005
"""Run bzr, and check that stderr contains the supplied regexes
1007
:param error_regexes: Sequence of regular expressions which
1008
must each be found in the error output. The relative ordering
1010
:param args: command-line arguments for bzr
1011
:param kwargs: Keyword arguments which are interpreted by run_bzr
1012
This function changes the default value of retcode to be 3,
1013
since in most cases this is run when you expect bzr to fail.
1014
:return: (out, err) The actual output of running the command (in case you
1015
want to do more inspection)
1018
# Make sure that commit is failing because there is nothing to do
1019
self.run_bzr_error(['no changes to commit'],
1020
'commit', '-m', 'my commit comment')
1021
# Make sure --strict is handling an unknown file, rather than
1022
# giving us the 'nothing to do' error
1023
self.build_tree(['unknown'])
1024
self.run_bzr_error(['Commit refused because there are unknown files'],
1025
'commit', '--strict', '-m', 'my commit comment')
1027
kwargs.setdefault('retcode', 3)
1028
out, err = self.run_bzr(*args, **kwargs)
1029
for regex in error_regexes:
1030
self.assertContainsRe(err, regex)
1033
def run_bzr_subprocess(self, *args, **kwargs):
1034
"""Run bzr in a subprocess for testing.
1036
This starts a new Python interpreter and runs bzr in there.
1037
This should only be used for tests that have a justifiable need for
1038
this isolation: e.g. they are testing startup time, or signal
1039
handling, or early startup code, etc. Subprocess code can't be
1040
profiled or debugged so easily.
1042
:param retcode: The status code that is expected. Defaults to 0. If
1043
None is supplied, the status code is not checked.
1044
:param env_changes: A dictionary which lists changes to environment
1045
variables. A value of None will unset the env variable.
1046
The values must be strings. The change will only occur in the
1047
child, so you don't need to fix the environment after running.
1048
:param universal_newlines: Convert CRLF => LF
1049
:param allow_plugins: By default the subprocess is run with
1050
--no-plugins to ensure test reproducibility. Also, it is possible
1051
for system-wide plugins to create unexpected output on stderr,
1052
which can cause unnecessary test failures.
1054
env_changes = kwargs.get('env_changes', {})
1055
working_dir = kwargs.get('working_dir', None)
1056
allow_plugins = kwargs.get('allow_plugins', False)
1057
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1058
working_dir=working_dir,
1059
allow_plugins=allow_plugins)
1060
# We distinguish between retcode=None and retcode not passed.
1061
supplied_retcode = kwargs.get('retcode', 0)
1062
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1063
universal_newlines=kwargs.get('universal_newlines', False),
1066
def start_bzr_subprocess(self, process_args, env_changes=None,
1067
skip_if_plan_to_signal=False,
1069
allow_plugins=False):
1070
"""Start bzr in a subprocess for testing.
1072
This starts a new Python interpreter and runs bzr in there.
1073
This should only be used for tests that have a justifiable need for
1074
this isolation: e.g. they are testing startup time, or signal
1075
handling, or early startup code, etc. Subprocess code can't be
1076
profiled or debugged so easily.
1078
:param process_args: a list of arguments to pass to the bzr executable,
1079
for example `['--version']`.
1080
:param env_changes: A dictionary which lists changes to environment
1081
variables. A value of None will unset the env variable.
1082
The values must be strings. The change will only occur in the
1083
child, so you don't need to fix the environment after running.
1084
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1086
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1088
:returns: Popen object for the started process.
1090
if skip_if_plan_to_signal:
1091
if not getattr(os, 'kill', None):
1092
raise TestSkipped("os.kill not available.")
1094
if env_changes is None:
1098
def cleanup_environment():
1099
for env_var, value in env_changes.iteritems():
1100
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1102
def restore_environment():
1103
for env_var, value in old_env.iteritems():
1104
osutils.set_or_unset_env(env_var, value)
1106
bzr_path = self.get_bzr_path()
1109
if working_dir is not None:
1110
cwd = osutils.getcwd()
1111
os.chdir(working_dir)
1114
# win32 subprocess doesn't support preexec_fn
1115
# so we will avoid using it on all platforms, just to
1116
# make sure the code path is used, and we don't break on win32
1117
cleanup_environment()
1118
command = [sys.executable, bzr_path]
1119
if not allow_plugins:
1120
command.append('--no-plugins')
1121
command.extend(process_args)
1122
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1124
restore_environment()
1130
def _popen(self, *args, **kwargs):
1131
"""Place a call to Popen.
1133
Allows tests to override this method to intercept the calls made to
1134
Popen for introspection.
1136
return Popen(*args, **kwargs)
1138
def get_bzr_path(self):
1139
"""Return the path of the 'bzr' executable for this test suite."""
1140
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1141
if not os.path.isfile(bzr_path):
1142
# We are probably installed. Assume sys.argv is the right file
1143
bzr_path = sys.argv[0]
1146
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1147
universal_newlines=False, process_args=None):
1148
"""Finish the execution of process.
1150
:param process: the Popen object returned from start_bzr_subprocess.
1151
:param retcode: The status code that is expected. Defaults to 0. If
1152
None is supplied, the status code is not checked.
1153
:param send_signal: an optional signal to send to the process.
1154
:param universal_newlines: Convert CRLF => LF
1155
:returns: (stdout, stderr)
1157
if send_signal is not None:
1158
os.kill(process.pid, send_signal)
1159
out, err = process.communicate()
1161
if universal_newlines:
1162
out = out.replace('\r\n', '\n')
1163
err = err.replace('\r\n', '\n')
1165
if retcode is not None and retcode != process.returncode:
1166
if process_args is None:
1167
process_args = "(unknown args)"
1168
mutter('Output of bzr %s:\n%s', process_args, out)
1169
mutter('Error for bzr %s:\n%s', process_args, err)
1170
self.fail('Command bzr %s failed with retcode %s != %s'
1171
% (process_args, retcode, process.returncode))
1174
def check_inventory_shape(self, inv, shape):
1175
"""Compare an inventory to a list of expected names.
1177
Fail if they are not precisely equal.
1180
shape = list(shape) # copy
1181
for path, ie in inv.entries():
1182
name = path.replace('\\', '/')
1183
if ie.kind == 'dir':
1190
self.fail("expected paths not found in inventory: %r" % shape)
1192
self.fail("unexpected paths found in inventory: %r" % extras)
1194
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1195
a_callable=None, *args, **kwargs):
1196
"""Call callable with redirected std io pipes.
1198
Returns the return code."""
1199
if not callable(a_callable):
1200
raise ValueError("a_callable must be callable.")
1202
stdin = StringIO("")
1204
if getattr(self, "_log_file", None) is not None:
1205
stdout = self._log_file
1209
if getattr(self, "_log_file", None is not None):
1210
stderr = self._log_file
1213
real_stdin = sys.stdin
1214
real_stdout = sys.stdout
1215
real_stderr = sys.stderr
1220
return a_callable(*args, **kwargs)
1222
sys.stdout = real_stdout
1223
sys.stderr = real_stderr
1224
sys.stdin = real_stdin
1226
@symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
1227
def merge(self, branch_from, wt_to):
1228
"""A helper for tests to do a ui-less merge.
1230
This should move to the main library when someone has time to integrate
1233
# minimal ui-less merge.
1234
wt_to.branch.fetch(branch_from)
1235
base_rev = common_ancestor(branch_from.last_revision(),
1236
wt_to.branch.last_revision(),
1237
wt_to.branch.repository)
1238
merge_inner(wt_to.branch, branch_from.basis_tree(),
1239
wt_to.branch.repository.revision_tree(base_rev),
1241
wt_to.add_parent_tree_id(branch_from.last_revision())
1244
BzrTestBase = TestCase
1247
class TestCaseWithMemoryTransport(TestCase):
1248
"""Common test class for tests that do not need disk resources.
1250
Tests that need disk resources should derive from TestCaseWithTransport.
1252
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1254
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1255
a directory which does not exist. This serves to help ensure test isolation
1256
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1257
must exist. However, TestCaseWithMemoryTransport does not offer local
1258
file defaults for the transport in tests, nor does it obey the command line
1259
override, so tests that accidentally write to the common directory should
1267
def __init__(self, methodName='runTest'):
1268
# allow test parameterisation after test construction and before test
1269
# execution. Variables that the parameteriser sets need to be
1270
# ones that are not set by setUp, or setUp will trash them.
1271
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1272
self.transport_server = default_transport
1273
self.transport_readonly_server = None
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
1308
self.__readonly_server = ReadonlyServer()
1309
self.__readonly_server.setUp(self.__server)
1311
self.__readonly_server = self.create_transport_readonly_server()
1312
self.__readonly_server.setUp()
1313
self.addCleanup(self.__readonly_server.tearDown)
1314
return self.__readonly_server
1316
def get_readonly_url(self, relpath=None):
1317
"""Get a URL for the readonly transport.
1319
This will either be backed by '.' or a decorator to the transport
1320
used by self.get_url()
1321
relpath provides for clients to get a path relative to the base url.
1322
These should only be downwards relative, not upwards.
1324
base = self.get_readonly_server().get_url()
1325
if relpath is not None:
1326
if not base.endswith('/'):
1328
base = base + relpath
1331
def get_server(self):
1332
"""Get the read/write server instance.
1334
This is useful for some tests with specific servers that need
1337
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1338
is no means to override it.
1340
if self.__server is None:
1341
self.__server = MemoryServer()
1342
self.__server.setUp()
1343
self.addCleanup(self.__server.tearDown)
1344
return self.__server
1346
def get_url(self, relpath=None):
1347
"""Get a URL (or maybe a path) for the readwrite transport.
1349
This will either be backed by '.' or to an equivalent non-file based
1351
relpath provides for clients to get a path relative to the base url.
1352
These should only be downwards relative, not upwards.
1354
base = self.get_server().get_url()
1355
if relpath is not None and relpath != '.':
1356
if not base.endswith('/'):
1358
# XXX: Really base should be a url; we did after all call
1359
# get_url()! But sometimes it's just a path (from
1360
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1361
# to a non-escaped local path.
1362
if base.startswith('./') or base.startswith('/'):
1365
base += urlutils.escape(relpath)
1368
def _make_test_root(self):
1369
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1373
root = u'test%04d.tmp' % i
1377
if e.errno == errno.EEXIST:
1382
# successfully created
1383
TestCaseWithMemoryTransport.TEST_ROOT = osutils.abspath(root)
1385
# make a fake bzr directory there to prevent any tests propagating
1386
# up onto the source directory's real branch
1387
bzrdir.BzrDir.create_standalone_workingtree(
1388
TestCaseWithMemoryTransport.TEST_ROOT)
1390
def makeAndChdirToTestDir(self):
1391
"""Create a temporary directories for this one test.
1393
This must set self.test_home_dir and self.test_dir and chdir to
1396
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1398
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1399
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1400
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1402
def make_branch(self, relpath, format=None):
1403
"""Create a branch on the transport at relpath."""
1404
repo = self.make_repository(relpath, format=format)
1405
return repo.bzrdir.create_branch()
1407
def make_bzrdir(self, relpath, format=None):
1409
# might be a relative or absolute path
1410
maybe_a_url = self.get_url(relpath)
1411
segments = maybe_a_url.rsplit('/', 1)
1412
t = get_transport(maybe_a_url)
1413
if len(segments) > 1 and segments[-1] not in ('', '.'):
1416
except errors.FileExists:
1418
if isinstance(format, basestring):
1419
format = bzrdir.format_registry.make_bzrdir(format)
1420
elif format is None:
1421
format = bzrlib.bzrdir.BzrDirFormat.get_default_format()
1422
return format.initialize_on_transport(t)
1423
except errors.UninitializableFormat:
1424
raise TestSkipped("Format %s is not initializable." % format)
1426
def make_repository(self, relpath, shared=False, format=None):
1427
"""Create a repository on our default transport at relpath."""
1428
made_control = self.make_bzrdir(relpath, format=format)
1429
return made_control.create_repository(shared=shared)
1431
def make_branch_and_memory_tree(self, relpath, format=None):
1432
"""Create a branch on the default transport and a MemoryTree for it."""
1433
b = self.make_branch(relpath, format=format)
1434
return memorytree.MemoryTree.create_on_branch(b)
1436
def overrideEnvironmentForTesting(self):
1437
os.environ['HOME'] = self.test_home_dir
1438
os.environ['APPDATA'] = self.test_home_dir
1441
super(TestCaseWithMemoryTransport, self).setUp()
1442
self._make_test_root()
1443
_currentdir = os.getcwdu()
1444
def _leaveDirectory():
1445
os.chdir(_currentdir)
1446
self.addCleanup(_leaveDirectory)
1447
self.makeAndChdirToTestDir()
1448
self.overrideEnvironmentForTesting()
1449
self.__readonly_server = None
1450
self.__server = None
1453
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1454
"""Derived class that runs a test within a temporary directory.
1456
This is useful for tests that need to create a branch, etc.
1458
The directory is created in a slightly complex way: for each
1459
Python invocation, a new temporary top-level directory is created.
1460
All test cases create their own directory within that. If the
1461
tests complete successfully, the directory is removed.
1463
InTempDir is an old alias for FunctionalTestCase.
1466
OVERRIDE_PYTHON = 'python'
1468
def check_file_contents(self, filename, expect):
1469
self.log("check contents of file %s" % filename)
1470
contents = file(filename, 'r').read()
1471
if contents != expect:
1472
self.log("expected: %r" % expect)
1473
self.log("actually: %r" % contents)
1474
self.fail("contents of %s not as expected" % filename)
1476
def makeAndChdirToTestDir(self):
1477
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1479
For TestCaseInTempDir we create a temporary directory based on the test
1480
name and then create two subdirs - test and home under it.
1482
# shorten the name, to avoid test failures due to path length
1483
short_id = self.id().replace('bzrlib.tests.', '') \
1484
.replace('__main__.', '')[-100:]
1485
# it's possible the same test class is run several times for
1486
# parameterized tests, so make sure the names don't collide.
1490
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1492
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1493
if os.path.exists(candidate_dir):
1497
os.mkdir(candidate_dir)
1498
self.test_home_dir = candidate_dir + '/home'
1499
os.mkdir(self.test_home_dir)
1500
self.test_dir = candidate_dir + '/work'
1501
os.mkdir(self.test_dir)
1502
os.chdir(self.test_dir)
1505
def build_tree(self, shape, line_endings='binary', transport=None):
1506
"""Build a test tree according to a pattern.
1508
shape is a sequence of file specifications. If the final
1509
character is '/', a directory is created.
1511
This assumes that all the elements in the tree being built are new.
1513
This doesn't add anything to a branch.
1514
:param line_endings: Either 'binary' or 'native'
1515
in binary mode, exact contents are written
1516
in native mode, the line endings match the
1517
default platform endings.
1519
:param transport: A transport to write to, for building trees on
1520
VFS's. If the transport is readonly or None,
1521
"." is opened automatically.
1523
# It's OK to just create them using forward slashes on windows.
1524
if transport is None or transport.is_readonly():
1525
transport = get_transport(".")
1527
self.assert_(isinstance(name, basestring))
1529
transport.mkdir(urlutils.escape(name[:-1]))
1531
if line_endings == 'binary':
1533
elif line_endings == 'native':
1536
raise errors.BzrError(
1537
'Invalid line ending request %r' % line_endings)
1538
content = "contents of %s%s" % (name.encode('utf-8'), end)
1539
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1541
def build_tree_contents(self, shape):
1542
build_tree_contents(shape)
1544
def assertFileEqual(self, content, path):
1545
"""Fail if path does not contain 'content'."""
1546
self.failUnlessExists(path)
1547
# TODO: jam 20060427 Shouldn't this be 'rb'?
1548
self.assertEqualDiff(content, open(path, 'r').read())
1550
def failUnlessExists(self, path):
1551
"""Fail unless path, which may be abs or relative, exists."""
1552
self.failUnless(osutils.lexists(path),path+" does not exist")
1554
def failIfExists(self, path):
1555
"""Fail if path, which may be abs or relative, exists."""
1556
self.failIf(osutils.lexists(path),path+" exists")
1559
class TestCaseWithTransport(TestCaseInTempDir):
1560
"""A test case that provides get_url and get_readonly_url facilities.
1562
These back onto two transport servers, one for readonly access and one for
1565
If no explicit class is provided for readonly access, a
1566
ReadonlyTransportDecorator is used instead which allows the use of non disk
1567
based read write transports.
1569
If an explicit class is provided for readonly access, that server and the
1570
readwrite one must both define get_url() as resolving to os.getcwd().
1573
def create_transport_server(self):
1574
"""Create a transport server from class defined at init.
1576
This is mostly a hook for daughter classes.
1578
return self.transport_server()
1580
def get_server(self):
1581
"""See TestCaseWithMemoryTransport.
1583
This is useful for some tests with specific servers that need
1586
if self.__server is None:
1587
self.__server = self.create_transport_server()
1588
self.__server.setUp()
1589
self.addCleanup(self.__server.tearDown)
1590
return self.__server
1592
def make_branch_and_tree(self, relpath, format=None):
1593
"""Create a branch on the transport and a tree locally.
1595
If the transport is not a LocalTransport, the Tree can't be created on
1596
the transport. In that case the working tree is created in the local
1597
directory, and the returned tree's branch and repository will also be
1600
This will fail if the original default transport for this test
1601
case wasn't backed by the working directory, as the branch won't
1602
be on disk for us to open it.
1604
:param format: The BzrDirFormat.
1605
:returns: the WorkingTree.
1607
# TODO: always use the local disk path for the working tree,
1608
# this obviously requires a format that supports branch references
1609
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1611
b = self.make_branch(relpath, format=format)
1613
return b.bzrdir.create_workingtree()
1614
except errors.NotLocalUrl:
1615
# We can only make working trees locally at the moment. If the
1616
# transport can't support them, then reopen the branch on a local
1617
# transport, and create the working tree there.
1619
# Possibly we should instead keep
1620
# the non-disk-backed branch and create a local checkout?
1621
bd = bzrdir.BzrDir.open(relpath)
1622
return bd.create_workingtree()
1624
def assertIsDirectory(self, relpath, transport):
1625
"""Assert that relpath within transport is a directory.
1627
This may not be possible on all transports; in that case it propagates
1628
a TransportNotPossible.
1631
mode = transport.stat(relpath).st_mode
1632
except errors.NoSuchFile:
1633
self.fail("path %s is not a directory; no such file"
1635
if not stat.S_ISDIR(mode):
1636
self.fail("path %s is not a directory; has mode %#o"
1640
super(TestCaseWithTransport, self).setUp()
1641
self.__server = None
1644
class ChrootedTestCase(TestCaseWithTransport):
1645
"""A support class that provides readonly urls outside the local namespace.
1647
This is done by checking if self.transport_server is a MemoryServer. if it
1648
is then we are chrooted already, if it is not then an HttpServer is used
1651
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1652
be used without needed to redo it when a different
1653
subclass is in use ?
1657
super(ChrootedTestCase, self).setUp()
1658
if not self.transport_server == MemoryServer:
1659
self.transport_readonly_server = HttpServer
1662
def filter_suite_by_re(suite, pattern):
1663
result = TestUtil.TestSuite()
1664
filter_re = re.compile(pattern)
1665
for test in iter_suite_tests(suite):
1666
if filter_re.search(test.id()):
1667
result.addTest(test)
1671
def sort_suite_by_re(suite, pattern):
1674
filter_re = re.compile(pattern)
1675
for test in iter_suite_tests(suite):
1676
if filter_re.search(test.id()):
1680
return TestUtil.TestSuite(first + second)
1683
def run_suite(suite, name='test', verbose=False, pattern=".*",
1684
stop_on_failure=False, keep_output=False,
1685
transport=None, lsprof_timed=None, bench_history=None,
1686
matching_tests_first=None):
1687
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1692
runner = TextTestRunner(stream=sys.stdout,
1694
verbosity=verbosity,
1695
keep_output=keep_output,
1696
bench_history=bench_history)
1697
runner.stop_on_failure=stop_on_failure
1699
if matching_tests_first:
1700
suite = sort_suite_by_re(suite, pattern)
1702
suite = filter_suite_by_re(suite, pattern)
1703
result = runner.run(suite)
1704
return result.wasSuccessful()
1707
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1710
test_suite_factory=None,
1713
matching_tests_first=None):
1714
"""Run the whole test suite under the enhanced runner"""
1715
# XXX: Very ugly way to do this...
1716
# Disable warning about old formats because we don't want it to disturb
1717
# any blackbox tests.
1718
from bzrlib import repository
1719
repository._deprecation_warning_done = True
1721
global default_transport
1722
if transport is None:
1723
transport = default_transport
1724
old_transport = default_transport
1725
default_transport = transport
1727
if test_suite_factory is None:
1728
suite = test_suite()
1730
suite = test_suite_factory()
1731
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1732
stop_on_failure=stop_on_failure, keep_output=keep_output,
1733
transport=transport,
1734
lsprof_timed=lsprof_timed,
1735
bench_history=bench_history,
1736
matching_tests_first=matching_tests_first)
1738
default_transport = old_transport
1742
"""Build and return TestSuite for the whole of bzrlib.
1744
This function can be replaced if you need to change the default test
1745
suite on a global basis, but it is not encouraged.
1748
'bzrlib.tests.test_ancestry',
1749
'bzrlib.tests.test_annotate',
1750
'bzrlib.tests.test_api',
1751
'bzrlib.tests.test_atomicfile',
1752
'bzrlib.tests.test_bad_files',
1753
'bzrlib.tests.test_branch',
1754
'bzrlib.tests.test_bundle',
1755
'bzrlib.tests.test_bzrdir',
1756
'bzrlib.tests.test_cache_utf8',
1757
'bzrlib.tests.test_commands',
1758
'bzrlib.tests.test_commit',
1759
'bzrlib.tests.test_commit_merge',
1760
'bzrlib.tests.test_config',
1761
'bzrlib.tests.test_conflicts',
1762
'bzrlib.tests.test_decorators',
1763
'bzrlib.tests.test_diff',
1764
'bzrlib.tests.test_doc_generate',
1765
'bzrlib.tests.test_errors',
1766
'bzrlib.tests.test_escaped_store',
1767
'bzrlib.tests.test_fetch',
1768
'bzrlib.tests.test_ftp_transport',
1769
'bzrlib.tests.test_generate_docs',
1770
'bzrlib.tests.test_generate_ids',
1771
'bzrlib.tests.test_globbing',
1772
'bzrlib.tests.test_gpg',
1773
'bzrlib.tests.test_graph',
1774
'bzrlib.tests.test_hashcache',
1775
'bzrlib.tests.test_http',
1776
'bzrlib.tests.test_http_response',
1777
'bzrlib.tests.test_identitymap',
1778
'bzrlib.tests.test_ignores',
1779
'bzrlib.tests.test_inv',
1780
'bzrlib.tests.test_knit',
1781
'bzrlib.tests.test_lazy_import',
1782
'bzrlib.tests.test_lazy_regex',
1783
'bzrlib.tests.test_lockdir',
1784
'bzrlib.tests.test_lockable_files',
1785
'bzrlib.tests.test_log',
1786
'bzrlib.tests.test_memorytree',
1787
'bzrlib.tests.test_merge',
1788
'bzrlib.tests.test_merge3',
1789
'bzrlib.tests.test_merge_core',
1790
'bzrlib.tests.test_missing',
1791
'bzrlib.tests.test_msgeditor',
1792
'bzrlib.tests.test_nonascii',
1793
'bzrlib.tests.test_options',
1794
'bzrlib.tests.test_osutils',
1795
'bzrlib.tests.test_osutils_encodings',
1796
'bzrlib.tests.test_patch',
1797
'bzrlib.tests.test_patches',
1798
'bzrlib.tests.test_permissions',
1799
'bzrlib.tests.test_plugins',
1800
'bzrlib.tests.test_progress',
1801
'bzrlib.tests.test_reconcile',
1802
'bzrlib.tests.test_registry',
1803
'bzrlib.tests.test_repository',
1804
'bzrlib.tests.test_revert',
1805
'bzrlib.tests.test_revision',
1806
'bzrlib.tests.test_revisionnamespaces',
1807
'bzrlib.tests.test_revisiontree',
1808
'bzrlib.tests.test_rio',
1809
'bzrlib.tests.test_sampler',
1810
'bzrlib.tests.test_selftest',
1811
'bzrlib.tests.test_setup',
1812
'bzrlib.tests.test_sftp_transport',
1813
'bzrlib.tests.test_smart_add',
1814
'bzrlib.tests.test_smart_transport',
1815
'bzrlib.tests.test_source',
1816
'bzrlib.tests.test_status',
1817
'bzrlib.tests.test_store',
1818
'bzrlib.tests.test_symbol_versioning',
1819
'bzrlib.tests.test_testament',
1820
'bzrlib.tests.test_textfile',
1821
'bzrlib.tests.test_textmerge',
1822
'bzrlib.tests.test_trace',
1823
'bzrlib.tests.test_transactions',
1824
'bzrlib.tests.test_transform',
1825
'bzrlib.tests.test_transport',
1826
'bzrlib.tests.test_tree',
1827
'bzrlib.tests.test_treebuilder',
1828
'bzrlib.tests.test_tsort',
1829
'bzrlib.tests.test_tuned_gzip',
1830
'bzrlib.tests.test_ui',
1831
'bzrlib.tests.test_upgrade',
1832
'bzrlib.tests.test_urlutils',
1833
'bzrlib.tests.test_versionedfile',
1834
'bzrlib.tests.test_version',
1835
'bzrlib.tests.test_version_info',
1836
'bzrlib.tests.test_weave',
1837
'bzrlib.tests.test_whitebox',
1838
'bzrlib.tests.test_workingtree',
1839
'bzrlib.tests.test_wsgi',
1840
'bzrlib.tests.test_xml',
1842
test_transport_implementations = [
1843
'bzrlib.tests.test_transport_implementations',
1844
'bzrlib.tests.test_read_bundle',
1846
suite = TestUtil.TestSuite()
1847
loader = TestUtil.TestLoader()
1848
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1849
from bzrlib.transport import TransportTestProviderAdapter
1850
adapter = TransportTestProviderAdapter()
1851
adapt_modules(test_transport_implementations, adapter, loader, suite)
1852
for package in packages_to_test():
1853
suite.addTest(package.test_suite())
1854
for m in MODULES_TO_TEST:
1855
suite.addTest(loader.loadTestsFromModule(m))
1856
for m in MODULES_TO_DOCTEST:
1858
suite.addTest(doctest.DocTestSuite(m))
1859
except ValueError, e:
1860
print '**failed to get doctest for: %s\n%s' %(m,e)
1862
for name, plugin in bzrlib.plugin.all_plugins().items():
1863
if getattr(plugin, 'test_suite', None) is not None:
1864
suite.addTest(plugin.test_suite())
1868
def adapt_modules(mods_list, adapter, loader, suite):
1869
"""Adapt the modules in mods_list using adapter and add to suite."""
1870
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1871
suite.addTests(adapter.adapt(test))
1874
def clean_selftest_output(root=None, quiet=False):
1875
"""Remove all selftest output directories from root directory.
1877
:param root: root directory for clean
1878
(if ommitted or None then clean current directory).
1879
:param quiet: suppress report about deleting directories
1884
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
1887
for i in os.listdir(root):
1888
if os.path.isdir(i) and re_dir.match(i):
1890
print 'delete directory:', i
added
removed
bzrlib/tests/__init__.py
