1
# Copyright (C) 2005, 2006, 2007 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())
479
osutils.rmtree(test_root)
481
if sys.platform == 'win32' and e.errno == errno.EACCES:
482
print >>sys.stderr, ('Permission denied: '
483
'unable to remove testing dir '
484
'%s' % os.path.basename(test_root))
488
note("Failed tests working directories are in '%s'\n", test_root)
489
TestCaseWithMemoryTransport.TEST_ROOT = None
494
def iter_suite_tests(suite):
495
"""Return all tests in a suite, recursing through nested suites"""
496
for item in suite._tests:
497
if isinstance(item, unittest.TestCase):
499
elif isinstance(item, unittest.TestSuite):
500
for r in iter_suite_tests(item):
503
raise Exception('unknown object %r inside test suite %r'
507
class TestSkipped(Exception):
508
"""Indicates that a test was intentionally skipped, rather than failing."""
511
class CommandFailed(Exception):
515
class StringIOWrapper(object):
516
"""A wrapper around cStringIO which just adds an encoding attribute.
518
Internally we can check sys.stdout to see what the output encoding
519
should be. However, cStringIO has no encoding attribute that we can
520
set. So we wrap it instead.
525
def __init__(self, s=None):
527
self.__dict__['_cstring'] = StringIO(s)
529
self.__dict__['_cstring'] = StringIO()
531
def __getattr__(self, name, getattr=getattr):
532
return getattr(self.__dict__['_cstring'], name)
534
def __setattr__(self, name, val):
535
if name == 'encoding':
536
self.__dict__['encoding'] = val
538
return setattr(self._cstring, name, val)
541
class TestCase(unittest.TestCase):
542
"""Base class for bzr unit tests.
544
Tests that need access to disk resources should subclass
545
TestCaseInTempDir not TestCase.
547
Error and debug log messages are redirected from their usual
548
location into a temporary file, the contents of which can be
549
retrieved by _get_log(). We use a real OS file, not an in-memory object,
550
so that it can also capture file IO. When the test completes this file
551
is read into memory and removed from disk.
553
There are also convenience functions to invoke bzr's command-line
554
routine, and to build and check bzr trees.
556
In addition to the usual method of overriding tearDown(), this class also
557
allows subclasses to register functions into the _cleanups list, which is
558
run in order as the object is torn down. It's less likely this will be
559
accidentally overlooked.
562
_log_file_name = None
564
_keep_log_file = False
565
# record lsprof data when performing benchmark calls.
566
_gather_lsprof_in_benchmarks = False
568
def __init__(self, methodName='testMethod'):
569
super(TestCase, self).__init__(methodName)
573
unittest.TestCase.setUp(self)
574
self._cleanEnvironment()
575
bzrlib.trace.disable_default_logging()
578
self._benchcalls = []
579
self._benchtime = None
580
# prevent hooks affecting tests
581
self._preserved_hooks = bzrlib.branch.Branch.hooks
582
self.addCleanup(self._restoreHooks)
583
# this list of hooks must be kept in sync with the defaults
585
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
587
def _silenceUI(self):
588
"""Turn off UI for duration of test"""
589
# by default the UI is off; tests can turn it on if they want it.
590
saved = bzrlib.ui.ui_factory
592
bzrlib.ui.ui_factory = saved
593
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
594
self.addCleanup(_restore)
596
def _ndiff_strings(self, a, b):
597
"""Return ndiff between two strings containing lines.
599
A trailing newline is added if missing to make the strings
601
if b and b[-1] != '\n':
603
if a and a[-1] != '\n':
605
difflines = difflib.ndiff(a.splitlines(True),
607
linejunk=lambda x: False,
608
charjunk=lambda x: False)
609
return ''.join(difflines)
611
def assertEqualDiff(self, a, b, message=None):
612
"""Assert two texts are equal, if not raise an exception.
614
This is intended for use with multi-line strings where it can
615
be hard to find the differences by eye.
617
# TODO: perhaps override assertEquals to call this for strings?
621
message = "texts not equal:\n"
622
raise AssertionError(message +
623
self._ndiff_strings(a, b))
625
def assertEqualMode(self, mode, mode_test):
626
self.assertEqual(mode, mode_test,
627
'mode mismatch %o != %o' % (mode, mode_test))
629
def assertStartsWith(self, s, prefix):
630
if not s.startswith(prefix):
631
raise AssertionError('string %r does not start with %r' % (s, prefix))
633
def assertEndsWith(self, s, suffix):
634
"""Asserts that s ends with suffix."""
635
if not s.endswith(suffix):
636
raise AssertionError('string %r does not end with %r' % (s, suffix))
638
def assertContainsRe(self, haystack, needle_re):
639
"""Assert that a contains something matching a regular expression."""
640
if not re.search(needle_re, haystack):
641
raise AssertionError('pattern "%s" not found in "%s"'
642
% (needle_re, haystack))
644
def assertNotContainsRe(self, haystack, needle_re):
645
"""Assert that a does not match a regular expression"""
646
if re.search(needle_re, haystack):
647
raise AssertionError('pattern "%s" found in "%s"'
648
% (needle_re, haystack))
650
def assertSubset(self, sublist, superlist):
651
"""Assert that every entry in sublist is present in superlist."""
653
for entry in sublist:
654
if entry not in superlist:
655
missing.append(entry)
657
raise AssertionError("value(s) %r not present in container %r" %
658
(missing, superlist))
660
def assertListRaises(self, excClass, func, *args, **kwargs):
661
"""Fail unless excClass is raised when the iterator from func is used.
663
Many functions can return generators this makes sure
664
to wrap them in a list() call to make sure the whole generator
665
is run, and that the proper exception is raised.
668
list(func(*args, **kwargs))
672
if getattr(excClass,'__name__', None) is not None:
673
excName = excClass.__name__
675
excName = str(excClass)
676
raise self.failureException, "%s not raised" % excName
678
def assertIs(self, left, right, message=None):
679
if not (left is right):
680
if message is not None:
681
raise AssertionError(message)
683
raise AssertionError("%r is not %r." % (left, right))
685
def assertIsNot(self, left, right, message=None):
687
if message is not None:
688
raise AssertionError(message)
690
raise AssertionError("%r is %r." % (left, right))
692
def assertTransportMode(self, transport, path, mode):
693
"""Fail if a path does not have mode mode.
695
If modes are not supported on this transport, the assertion is ignored.
697
if not transport._can_roundtrip_unix_modebits():
699
path_stat = transport.stat(path)
700
actual_mode = stat.S_IMODE(path_stat.st_mode)
701
self.assertEqual(mode, actual_mode,
702
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
704
def assertIsInstance(self, obj, kls):
705
"""Fail if obj is not an instance of kls"""
706
if not isinstance(obj, kls):
707
self.fail("%r is an instance of %s rather than %s" % (
708
obj, obj.__class__, kls))
710
def _capture_warnings(self, a_callable, *args, **kwargs):
711
"""A helper for callDeprecated and applyDeprecated.
713
:param a_callable: A callable to call.
714
:param args: The positional arguments for the callable
715
:param kwargs: The keyword arguments for the callable
716
:return: A tuple (warnings, result). result is the result of calling
717
a_callable(*args, **kwargs).
720
def capture_warnings(msg, cls=None, stacklevel=None):
721
# we've hooked into a deprecation specific callpath,
722
# only deprecations should getting sent via it.
723
self.assertEqual(cls, DeprecationWarning)
724
local_warnings.append(msg)
725
original_warning_method = symbol_versioning.warn
726
symbol_versioning.set_warning_method(capture_warnings)
728
result = a_callable(*args, **kwargs)
730
symbol_versioning.set_warning_method(original_warning_method)
731
return (local_warnings, result)
733
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
734
"""Call a deprecated callable without warning the user.
736
:param deprecation_format: The deprecation format that the callable
737
should have been deprecated with. This is the same type as the
738
parameter to deprecated_method/deprecated_function. If the
739
callable is not deprecated with this format, an assertion error
741
:param a_callable: A callable to call. This may be a bound method or
742
a regular function. It will be called with *args and **kwargs.
743
:param args: The positional arguments for the callable
744
:param kwargs: The keyword arguments for the callable
745
:return: The result of a_callable(*args, **kwargs)
747
call_warnings, result = self._capture_warnings(a_callable,
749
expected_first_warning = symbol_versioning.deprecation_string(
750
a_callable, deprecation_format)
751
if len(call_warnings) == 0:
752
self.fail("No assertion generated by call to %s" %
754
self.assertEqual(expected_first_warning, call_warnings[0])
757
def callDeprecated(self, expected, callable, *args, **kwargs):
758
"""Assert that a callable is deprecated in a particular way.
760
This is a very precise test for unusual requirements. The
761
applyDeprecated helper function is probably more suited for most tests
762
as it allows you to simply specify the deprecation format being used
763
and will ensure that that is issued for the function being called.
765
:param expected: a list of the deprecation warnings expected, in order
766
:param callable: The callable to call
767
:param args: The positional arguments for the callable
768
:param kwargs: The keyword arguments for the callable
770
call_warnings, result = self._capture_warnings(callable,
772
self.assertEqual(expected, call_warnings)
775
def _startLogFile(self):
776
"""Send bzr and test log messages to a temporary file.
778
The file is removed as the test is torn down.
780
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
781
self._log_file = os.fdopen(fileno, 'w+')
782
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
783
self._log_file_name = name
784
self.addCleanup(self._finishLogFile)
786
def _finishLogFile(self):
787
"""Finished with the log file.
789
Close the file and delete it, unless setKeepLogfile was called.
791
if self._log_file is None:
793
bzrlib.trace.disable_test_log(self._log_nonce)
794
self._log_file.close()
795
self._log_file = None
796
if not self._keep_log_file:
797
os.remove(self._log_file_name)
798
self._log_file_name = None
800
def setKeepLogfile(self):
801
"""Make the logfile not be deleted when _finishLogFile is called."""
802
self._keep_log_file = True
804
def addCleanup(self, callable):
805
"""Arrange to run a callable when this case is torn down.
807
Callables are run in the reverse of the order they are registered,
808
ie last-in first-out.
810
if callable in self._cleanups:
811
raise ValueError("cleanup function %r already registered on %s"
813
self._cleanups.append(callable)
815
def _cleanEnvironment(self):
817
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
819
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
821
'BZREMAIL': None, # may still be present in the environment
823
'BZR_PROGRESS_BAR': None,
833
# Nobody cares about these ones AFAIK. So far at
834
# least. If you do (care), please update this comment
840
self.addCleanup(self._restoreEnvironment)
841
for name, value in new_env.iteritems():
842
self._captureVar(name, value)
844
def _captureVar(self, name, newvalue):
845
"""Set an environment variable, and reset it when finished."""
846
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
848
def _restoreEnvironment(self):
849
for name, value in self.__old_env.iteritems():
850
osutils.set_or_unset_env(name, value)
852
def _restoreHooks(self):
853
bzrlib.branch.Branch.hooks = self._preserved_hooks
857
unittest.TestCase.tearDown(self)
859
def time(self, callable, *args, **kwargs):
860
"""Run callable and accrue the time it takes to the benchmark time.
862
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
863
this will cause lsprofile statistics to be gathered and stored in
866
if self._benchtime is None:
870
if not self._gather_lsprof_in_benchmarks:
871
return callable(*args, **kwargs)
873
# record this benchmark
874
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
876
self._benchcalls.append(((callable, args, kwargs), stats))
879
self._benchtime += time.time() - start
881
def _runCleanups(self):
882
"""Run registered cleanup functions.
884
This should only be called from TestCase.tearDown.
886
# TODO: Perhaps this should keep running cleanups even if
888
for cleanup_fn in reversed(self._cleanups):
891
def log(self, *args):
894
def _get_log(self, keep_log_file=False):
895
"""Return as a string the log for this test. If the file is still
896
on disk and keep_log_file=False, delete the log file and store the
897
content in self._log_contents."""
898
# flush the log file, to get all content
900
bzrlib.trace._trace_file.flush()
901
if self._log_contents:
902
return self._log_contents
903
if self._log_file_name is not None:
904
logfile = open(self._log_file_name)
906
log_contents = logfile.read()
909
if not keep_log_file:
910
self._log_contents = log_contents
912
os.remove(self._log_file_name)
914
if sys.platform == 'win32' and e.errno == errno.EACCES:
915
print >>sys.stderr, ('Unable to delete log file '
916
' %r' % self._log_file_name)
921
return "DELETED log file to reduce memory footprint"
923
def capture(self, cmd, retcode=0):
924
"""Shortcut that splits cmd into words, runs, and returns stdout"""
925
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
927
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
929
"""Invoke bzr and return (stdout, stderr).
931
Useful for code that wants to check the contents of the
932
output, the way error messages are presented, etc.
934
This should be the main method for tests that want to exercise the
935
overall behavior of the bzr application (rather than a unit test
936
or a functional test of the library.)
938
Much of the old code runs bzr by forking a new copy of Python, but
939
that is slower, harder to debug, and generally not necessary.
941
This runs bzr through the interface that catches and reports
942
errors, and with logging set to something approximating the
943
default, so that error reporting can be checked.
945
:param argv: arguments to invoke bzr
946
:param retcode: expected return code, or None for don't-care.
947
:param encoding: encoding for sys.stdout and sys.stderr
948
:param stdin: A string to be used as stdin for the command.
949
:param working_dir: Change to this directory before running
952
encoding = bzrlib.user_encoding
953
if stdin is not None:
954
stdin = StringIO(stdin)
955
stdout = StringIOWrapper()
956
stderr = StringIOWrapper()
957
stdout.encoding = encoding
958
stderr.encoding = encoding
960
self.log('run bzr: %r', argv)
961
# FIXME: don't call into logging here
962
handler = logging.StreamHandler(stderr)
963
handler.setLevel(logging.INFO)
964
logger = logging.getLogger('')
965
logger.addHandler(handler)
966
old_ui_factory = bzrlib.ui.ui_factory
967
bzrlib.ui.ui_factory = bzrlib.tests.blackbox.TestUIFactory(
970
bzrlib.ui.ui_factory.stdin = stdin
973
if working_dir is not None:
974
cwd = osutils.getcwd()
975
os.chdir(working_dir)
978
saved_debug_flags = frozenset(debug.debug_flags)
979
debug.debug_flags.clear()
981
result = self.apply_redirected(stdin, stdout, stderr,
982
bzrlib.commands.run_bzr_catch_errors,
985
debug.debug_flags.update(saved_debug_flags)
987
logger.removeHandler(handler)
988
bzrlib.ui.ui_factory = old_ui_factory
992
out = stdout.getvalue()
993
err = stderr.getvalue()
995
self.log('output:\n%r', out)
997
self.log('errors:\n%r', err)
998
if retcode is not None:
999
self.assertEquals(retcode, result)
1002
def run_bzr(self, *args, **kwargs):
1003
"""Invoke bzr, as if it were run from the command line.
1005
This should be the main method for tests that want to exercise the
1006
overall behavior of the bzr application (rather than a unit test
1007
or a functional test of the library.)
1009
This sends the stdout/stderr results into the test's log,
1010
where it may be useful for debugging. See also run_captured.
1012
:param stdin: A string to be used as stdin for the command.
1014
retcode = kwargs.pop('retcode', 0)
1015
encoding = kwargs.pop('encoding', None)
1016
stdin = kwargs.pop('stdin', None)
1017
working_dir = kwargs.pop('working_dir', None)
1018
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding,
1019
stdin=stdin, working_dir=working_dir)
1021
def run_bzr_decode(self, *args, **kwargs):
1022
if 'encoding' in kwargs:
1023
encoding = kwargs['encoding']
1025
encoding = bzrlib.user_encoding
1026
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1028
def run_bzr_error(self, error_regexes, *args, **kwargs):
1029
"""Run bzr, and check that stderr contains the supplied regexes
1031
:param error_regexes: Sequence of regular expressions which
1032
must each be found in the error output. The relative ordering
1034
:param args: command-line arguments for bzr
1035
:param kwargs: Keyword arguments which are interpreted by run_bzr
1036
This function changes the default value of retcode to be 3,
1037
since in most cases this is run when you expect bzr to fail.
1038
:return: (out, err) The actual output of running the command (in case you
1039
want to do more inspection)
1042
# Make sure that commit is failing because there is nothing to do
1043
self.run_bzr_error(['no changes to commit'],
1044
'commit', '-m', 'my commit comment')
1045
# Make sure --strict is handling an unknown file, rather than
1046
# giving us the 'nothing to do' error
1047
self.build_tree(['unknown'])
1048
self.run_bzr_error(['Commit refused because there are unknown files'],
1049
'commit', '--strict', '-m', 'my commit comment')
1051
kwargs.setdefault('retcode', 3)
1052
out, err = self.run_bzr(*args, **kwargs)
1053
for regex in error_regexes:
1054
self.assertContainsRe(err, regex)
1057
def run_bzr_subprocess(self, *args, **kwargs):
1058
"""Run bzr in a subprocess for testing.
1060
This starts a new Python interpreter and runs bzr in there.
1061
This should only be used for tests that have a justifiable need for
1062
this isolation: e.g. they are testing startup time, or signal
1063
handling, or early startup code, etc. Subprocess code can't be
1064
profiled or debugged so easily.
1066
:param retcode: The status code that is expected. Defaults to 0. If
1067
None is supplied, the status code is not checked.
1068
:param env_changes: A dictionary which lists changes to environment
1069
variables. A value of None will unset the env variable.
1070
The values must be strings. The change will only occur in the
1071
child, so you don't need to fix the environment after running.
1072
:param universal_newlines: Convert CRLF => LF
1073
:param allow_plugins: By default the subprocess is run with
1074
--no-plugins to ensure test reproducibility. Also, it is possible
1075
for system-wide plugins to create unexpected output on stderr,
1076
which can cause unnecessary test failures.
1078
env_changes = kwargs.get('env_changes', {})
1079
working_dir = kwargs.get('working_dir', None)
1080
allow_plugins = kwargs.get('allow_plugins', False)
1081
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1082
working_dir=working_dir,
1083
allow_plugins=allow_plugins)
1084
# We distinguish between retcode=None and retcode not passed.
1085
supplied_retcode = kwargs.get('retcode', 0)
1086
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1087
universal_newlines=kwargs.get('universal_newlines', False),
1090
def start_bzr_subprocess(self, process_args, env_changes=None,
1091
skip_if_plan_to_signal=False,
1093
allow_plugins=False):
1094
"""Start bzr in a subprocess for testing.
1096
This starts a new Python interpreter and runs bzr in there.
1097
This should only be used for tests that have a justifiable need for
1098
this isolation: e.g. they are testing startup time, or signal
1099
handling, or early startup code, etc. Subprocess code can't be
1100
profiled or debugged so easily.
1102
:param process_args: a list of arguments to pass to the bzr executable,
1103
for example `['--version']`.
1104
:param env_changes: A dictionary which lists changes to environment
1105
variables. A value of None will unset the env variable.
1106
The values must be strings. The change will only occur in the
1107
child, so you don't need to fix the environment after running.
1108
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1110
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1112
:returns: Popen object for the started process.
1114
if skip_if_plan_to_signal:
1115
if not getattr(os, 'kill', None):
1116
raise TestSkipped("os.kill not available.")
1118
if env_changes is None:
1122
def cleanup_environment():
1123
for env_var, value in env_changes.iteritems():
1124
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1126
def restore_environment():
1127
for env_var, value in old_env.iteritems():
1128
osutils.set_or_unset_env(env_var, value)
1130
bzr_path = self.get_bzr_path()
1133
if working_dir is not None:
1134
cwd = osutils.getcwd()
1135
os.chdir(working_dir)
1138
# win32 subprocess doesn't support preexec_fn
1139
# so we will avoid using it on all platforms, just to
1140
# make sure the code path is used, and we don't break on win32
1141
cleanup_environment()
1142
command = [sys.executable, bzr_path]
1143
if not allow_plugins:
1144
command.append('--no-plugins')
1145
command.extend(process_args)
1146
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1148
restore_environment()
1154
def _popen(self, *args, **kwargs):
1155
"""Place a call to Popen.
1157
Allows tests to override this method to intercept the calls made to
1158
Popen for introspection.
1160
return Popen(*args, **kwargs)
1162
def get_bzr_path(self):
1163
"""Return the path of the 'bzr' executable for this test suite."""
1164
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1165
if not os.path.isfile(bzr_path):
1166
# We are probably installed. Assume sys.argv is the right file
1167
bzr_path = sys.argv[0]
1170
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1171
universal_newlines=False, process_args=None):
1172
"""Finish the execution of process.
1174
:param process: the Popen object returned from start_bzr_subprocess.
1175
:param retcode: The status code that is expected. Defaults to 0. If
1176
None is supplied, the status code is not checked.
1177
:param send_signal: an optional signal to send to the process.
1178
:param universal_newlines: Convert CRLF => LF
1179
:returns: (stdout, stderr)
1181
if send_signal is not None:
1182
os.kill(process.pid, send_signal)
1183
out, err = process.communicate()
1185
if universal_newlines:
1186
out = out.replace('\r\n', '\n')
1187
err = err.replace('\r\n', '\n')
1189
if retcode is not None and retcode != process.returncode:
1190
if process_args is None:
1191
process_args = "(unknown args)"
1192
mutter('Output of bzr %s:\n%s', process_args, out)
1193
mutter('Error for bzr %s:\n%s', process_args, err)
1194
self.fail('Command bzr %s failed with retcode %s != %s'
1195
% (process_args, retcode, process.returncode))
1198
def check_inventory_shape(self, inv, shape):
1199
"""Compare an inventory to a list of expected names.
1201
Fail if they are not precisely equal.
1204
shape = list(shape) # copy
1205
for path, ie in inv.entries():
1206
name = path.replace('\\', '/')
1207
if ie.kind == 'dir':
1214
self.fail("expected paths not found in inventory: %r" % shape)
1216
self.fail("unexpected paths found in inventory: %r" % extras)
1218
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1219
a_callable=None, *args, **kwargs):
1220
"""Call callable with redirected std io pipes.
1222
Returns the return code."""
1223
if not callable(a_callable):
1224
raise ValueError("a_callable must be callable.")
1226
stdin = StringIO("")
1228
if getattr(self, "_log_file", None) is not None:
1229
stdout = self._log_file
1233
if getattr(self, "_log_file", None is not None):
1234
stderr = self._log_file
1237
real_stdin = sys.stdin
1238
real_stdout = sys.stdout
1239
real_stderr = sys.stderr
1244
return a_callable(*args, **kwargs)
1246
sys.stdout = real_stdout
1247
sys.stderr = real_stderr
1248
sys.stdin = real_stdin
1250
@symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
1251
def merge(self, branch_from, wt_to):
1252
"""A helper for tests to do a ui-less merge.
1254
This should move to the main library when someone has time to integrate
1257
# minimal ui-less merge.
1258
wt_to.branch.fetch(branch_from)
1259
base_rev = common_ancestor(branch_from.last_revision(),
1260
wt_to.branch.last_revision(),
1261
wt_to.branch.repository)
1262
merge_inner(wt_to.branch, branch_from.basis_tree(),
1263
wt_to.branch.repository.revision_tree(base_rev),
1265
wt_to.add_parent_tree_id(branch_from.last_revision())
1268
BzrTestBase = TestCase
1271
class TestCaseWithMemoryTransport(TestCase):
1272
"""Common test class for tests that do not need disk resources.
1274
Tests that need disk resources should derive from TestCaseWithTransport.
1276
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1278
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1279
a directory which does not exist. This serves to help ensure test isolation
1280
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1281
must exist. However, TestCaseWithMemoryTransport does not offer local
1282
file defaults for the transport in tests, nor does it obey the command line
1283
override, so tests that accidentally write to the common directory should
1291
def __init__(self, methodName='runTest'):
1292
# allow test parameterisation after test construction and before test
1293
# execution. Variables that the parameteriser sets need to be
1294
# ones that are not set by setUp, or setUp will trash them.
1295
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1296
self.transport_server = default_transport
1297
self.transport_readonly_server = None
1299
def get_transport(self):
1300
"""Return a writeable transport for the test scratch space"""
1301
t = get_transport(self.get_url())
1302
self.assertFalse(t.is_readonly())
1305
def get_readonly_transport(self):
1306
"""Return a readonly transport for the test scratch space
1308
This can be used to test that operations which should only need
1309
readonly access in fact do not try to write.
1311
t = get_transport(self.get_readonly_url())
1312
self.assertTrue(t.is_readonly())
1315
def create_transport_readonly_server(self):
1316
"""Create a transport server from class defined at init.
1318
This is mostly a hook for daughter classes.
1320
return self.transport_readonly_server()
1322
def get_readonly_server(self):
1323
"""Get the server instance for the readonly transport
1325
This is useful for some tests with specific servers to do diagnostics.
1327
if self.__readonly_server is None:
1328
if self.transport_readonly_server is None:
1329
# readonly decorator requested
1330
# bring up the server
1332
self.__readonly_server = ReadonlyServer()
1333
self.__readonly_server.setUp(self.__server)
1335
self.__readonly_server = self.create_transport_readonly_server()
1336
self.__readonly_server.setUp()
1337
self.addCleanup(self.__readonly_server.tearDown)
1338
return self.__readonly_server
1340
def get_readonly_url(self, relpath=None):
1341
"""Get a URL for the readonly transport.
1343
This will either be backed by '.' or a decorator to the transport
1344
used by self.get_url()
1345
relpath provides for clients to get a path relative to the base url.
1346
These should only be downwards relative, not upwards.
1348
base = self.get_readonly_server().get_url()
1349
if relpath is not None:
1350
if not base.endswith('/'):
1352
base = base + relpath
1355
def get_server(self):
1356
"""Get the read/write server instance.
1358
This is useful for some tests with specific servers that need
1361
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1362
is no means to override it.
1364
if self.__server is None:
1365
self.__server = MemoryServer()
1366
self.__server.setUp()
1367
self.addCleanup(self.__server.tearDown)
1368
return self.__server
1370
def get_url(self, relpath=None):
1371
"""Get a URL (or maybe a path) for the readwrite transport.
1373
This will either be backed by '.' or to an equivalent non-file based
1375
relpath provides for clients to get a path relative to the base url.
1376
These should only be downwards relative, not upwards.
1378
base = self.get_server().get_url()
1379
if relpath is not None and relpath != '.':
1380
if not base.endswith('/'):
1382
# XXX: Really base should be a url; we did after all call
1383
# get_url()! But sometimes it's just a path (from
1384
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1385
# to a non-escaped local path.
1386
if base.startswith('./') or base.startswith('/'):
1389
base += urlutils.escape(relpath)
1392
def _make_test_root(self):
1393
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1397
root = u'test%04d.tmp' % i
1401
if e.errno == errno.EEXIST:
1406
# successfully created
1407
TestCaseWithMemoryTransport.TEST_ROOT = osutils.abspath(root)
1409
# make a fake bzr directory there to prevent any tests propagating
1410
# up onto the source directory's real branch
1411
bzrdir.BzrDir.create_standalone_workingtree(
1412
TestCaseWithMemoryTransport.TEST_ROOT)
1414
def makeAndChdirToTestDir(self):
1415
"""Create a temporary directories for this one test.
1417
This must set self.test_home_dir and self.test_dir and chdir to
1420
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1422
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1423
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1424
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1426
def make_branch(self, relpath, format=None):
1427
"""Create a branch on the transport at relpath."""
1428
repo = self.make_repository(relpath, format=format)
1429
return repo.bzrdir.create_branch()
1431
def make_bzrdir(self, relpath, format=None):
1433
# might be a relative or absolute path
1434
maybe_a_url = self.get_url(relpath)
1435
segments = maybe_a_url.rsplit('/', 1)
1436
t = get_transport(maybe_a_url)
1437
if len(segments) > 1 and segments[-1] not in ('', '.'):
1440
except errors.FileExists:
1444
if isinstance(format, basestring):
1445
format = bzrdir.format_registry.make_bzrdir(format)
1446
return format.initialize_on_transport(t)
1447
except errors.UninitializableFormat:
1448
raise TestSkipped("Format %s is not initializable." % format)
1450
def make_repository(self, relpath, shared=False, format=None):
1451
"""Create a repository on our default transport at relpath."""
1452
made_control = self.make_bzrdir(relpath, format=format)
1453
return made_control.create_repository(shared=shared)
1455
def make_branch_and_memory_tree(self, relpath, format=None):
1456
"""Create a branch on the default transport and a MemoryTree for it."""
1457
b = self.make_branch(relpath, format=format)
1458
return memorytree.MemoryTree.create_on_branch(b)
1460
def overrideEnvironmentForTesting(self):
1461
os.environ['HOME'] = self.test_home_dir
1462
os.environ['BZR_HOME'] = self.test_home_dir
1465
super(TestCaseWithMemoryTransport, self).setUp()
1466
self._make_test_root()
1467
_currentdir = os.getcwdu()
1468
def _leaveDirectory():
1469
os.chdir(_currentdir)
1470
self.addCleanup(_leaveDirectory)
1471
self.makeAndChdirToTestDir()
1472
self.overrideEnvironmentForTesting()
1473
self.__readonly_server = None
1474
self.__server = None
1477
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1478
"""Derived class that runs a test within a temporary directory.
1480
This is useful for tests that need to create a branch, etc.
1482
The directory is created in a slightly complex way: for each
1483
Python invocation, a new temporary top-level directory is created.
1484
All test cases create their own directory within that. If the
1485
tests complete successfully, the directory is removed.
1487
InTempDir is an old alias for FunctionalTestCase.
1490
OVERRIDE_PYTHON = 'python'
1492
def check_file_contents(self, filename, expect):
1493
self.log("check contents of file %s" % filename)
1494
contents = file(filename, 'r').read()
1495
if contents != expect:
1496
self.log("expected: %r" % expect)
1497
self.log("actually: %r" % contents)
1498
self.fail("contents of %s not as expected" % filename)
1500
def makeAndChdirToTestDir(self):
1501
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1503
For TestCaseInTempDir we create a temporary directory based on the test
1504
name and then create two subdirs - test and home under it.
1506
# shorten the name, to avoid test failures due to path length
1507
short_id = self.id().replace('bzrlib.tests.', '') \
1508
.replace('__main__.', '')[-100:]
1509
# it's possible the same test class is run several times for
1510
# parameterized tests, so make sure the names don't collide.
1514
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1516
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1517
if os.path.exists(candidate_dir):
1521
os.mkdir(candidate_dir)
1522
self.test_home_dir = candidate_dir + '/home'
1523
os.mkdir(self.test_home_dir)
1524
self.test_dir = candidate_dir + '/work'
1525
os.mkdir(self.test_dir)
1526
os.chdir(self.test_dir)
1529
def build_tree(self, shape, line_endings='binary', transport=None):
1530
"""Build a test tree according to a pattern.
1532
shape is a sequence of file specifications. If the final
1533
character is '/', a directory is created.
1535
This assumes that all the elements in the tree being built are new.
1537
This doesn't add anything to a branch.
1538
:param line_endings: Either 'binary' or 'native'
1539
in binary mode, exact contents are written
1540
in native mode, the line endings match the
1541
default platform endings.
1543
:param transport: A transport to write to, for building trees on
1544
VFS's. If the transport is readonly or None,
1545
"." is opened automatically.
1547
# It's OK to just create them using forward slashes on windows.
1548
if transport is None or transport.is_readonly():
1549
transport = get_transport(".")
1551
self.assert_(isinstance(name, basestring))
1553
transport.mkdir(urlutils.escape(name[:-1]))
1555
if line_endings == 'binary':
1557
elif line_endings == 'native':
1560
raise errors.BzrError(
1561
'Invalid line ending request %r' % line_endings)
1562
content = "contents of %s%s" % (name.encode('utf-8'), end)
1563
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1565
def build_tree_contents(self, shape):
1566
build_tree_contents(shape)
1568
def assertFileEqual(self, content, path):
1569
"""Fail if path does not contain 'content'."""
1570
self.failUnlessExists(path)
1571
# TODO: jam 20060427 Shouldn't this be 'rb'?
1572
self.assertEqualDiff(content, open(path, 'r').read())
1574
def failUnlessExists(self, path):
1575
"""Fail unless path, which may be abs or relative, exists."""
1576
self.failUnless(osutils.lexists(path),path+" does not exist")
1578
def failIfExists(self, path):
1579
"""Fail if path, which may be abs or relative, exists."""
1580
self.failIf(osutils.lexists(path),path+" exists")
1583
class TestCaseWithTransport(TestCaseInTempDir):
1584
"""A test case that provides get_url and get_readonly_url facilities.
1586
These back onto two transport servers, one for readonly access and one for
1589
If no explicit class is provided for readonly access, a
1590
ReadonlyTransportDecorator is used instead which allows the use of non disk
1591
based read write transports.
1593
If an explicit class is provided for readonly access, that server and the
1594
readwrite one must both define get_url() as resolving to os.getcwd().
1597
def create_transport_server(self):
1598
"""Create a transport server from class defined at init.
1600
This is mostly a hook for daughter classes.
1602
return self.transport_server()
1604
def get_server(self):
1605
"""See TestCaseWithMemoryTransport.
1607
This is useful for some tests with specific servers that need
1610
if self.__server is None:
1611
self.__server = self.create_transport_server()
1612
self.__server.setUp()
1613
self.addCleanup(self.__server.tearDown)
1614
return self.__server
1616
def make_branch_and_tree(self, relpath, format=None):
1617
"""Create a branch on the transport and a tree locally.
1619
If the transport is not a LocalTransport, the Tree can't be created on
1620
the transport. In that case the working tree is created in the local
1621
directory, and the returned tree's branch and repository will also be
1624
This will fail if the original default transport for this test
1625
case wasn't backed by the working directory, as the branch won't
1626
be on disk for us to open it.
1628
:param format: The BzrDirFormat.
1629
:returns: the WorkingTree.
1631
# TODO: always use the local disk path for the working tree,
1632
# this obviously requires a format that supports branch references
1633
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1635
b = self.make_branch(relpath, format=format)
1637
return b.bzrdir.create_workingtree()
1638
except errors.NotLocalUrl:
1639
# We can only make working trees locally at the moment. If the
1640
# transport can't support them, then reopen the branch on a local
1641
# transport, and create the working tree there.
1643
# Possibly we should instead keep
1644
# the non-disk-backed branch and create a local checkout?
1645
bd = bzrdir.BzrDir.open(relpath)
1646
return bd.create_workingtree()
1648
def assertIsDirectory(self, relpath, transport):
1649
"""Assert that relpath within transport is a directory.
1651
This may not be possible on all transports; in that case it propagates
1652
a TransportNotPossible.
1655
mode = transport.stat(relpath).st_mode
1656
except errors.NoSuchFile:
1657
self.fail("path %s is not a directory; no such file"
1659
if not stat.S_ISDIR(mode):
1660
self.fail("path %s is not a directory; has mode %#o"
1664
super(TestCaseWithTransport, self).setUp()
1665
self.__server = None
1668
class ChrootedTestCase(TestCaseWithTransport):
1669
"""A support class that provides readonly urls outside the local namespace.
1671
This is done by checking if self.transport_server is a MemoryServer. if it
1672
is then we are chrooted already, if it is not then an HttpServer is used
1675
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1676
be used without needed to redo it when a different
1677
subclass is in use ?
1681
super(ChrootedTestCase, self).setUp()
1682
if not self.transport_server == MemoryServer:
1683
self.transport_readonly_server = HttpServer
1686
def filter_suite_by_re(suite, pattern):
1687
result = TestUtil.TestSuite()
1688
filter_re = re.compile(pattern)
1689
for test in iter_suite_tests(suite):
1690
if filter_re.search(test.id()):
1691
result.addTest(test)
1695
def sort_suite_by_re(suite, pattern):
1698
filter_re = re.compile(pattern)
1699
for test in iter_suite_tests(suite):
1700
if filter_re.search(test.id()):
1704
return TestUtil.TestSuite(first + second)
1707
def run_suite(suite, name='test', verbose=False, pattern=".*",
1708
stop_on_failure=False, keep_output=False,
1709
transport=None, lsprof_timed=None, bench_history=None,
1710
matching_tests_first=None):
1711
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1716
runner = TextTestRunner(stream=sys.stdout,
1718
verbosity=verbosity,
1719
keep_output=keep_output,
1720
bench_history=bench_history)
1721
runner.stop_on_failure=stop_on_failure
1723
if matching_tests_first:
1724
suite = sort_suite_by_re(suite, pattern)
1726
suite = filter_suite_by_re(suite, pattern)
1727
result = runner.run(suite)
1728
return result.wasSuccessful()
1731
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1734
test_suite_factory=None,
1737
matching_tests_first=None):
1738
"""Run the whole test suite under the enhanced runner"""
1739
# XXX: Very ugly way to do this...
1740
# Disable warning about old formats because we don't want it to disturb
1741
# any blackbox tests.
1742
from bzrlib import repository
1743
repository._deprecation_warning_done = True
1745
global default_transport
1746
if transport is None:
1747
transport = default_transport
1748
old_transport = default_transport
1749
default_transport = transport
1751
if test_suite_factory is None:
1752
suite = test_suite()
1754
suite = test_suite_factory()
1755
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1756
stop_on_failure=stop_on_failure, keep_output=keep_output,
1757
transport=transport,
1758
lsprof_timed=lsprof_timed,
1759
bench_history=bench_history,
1760
matching_tests_first=matching_tests_first)
1762
default_transport = old_transport
1766
"""Build and return TestSuite for the whole of bzrlib.
1768
This function can be replaced if you need to change the default test
1769
suite on a global basis, but it is not encouraged.
1772
'bzrlib.tests.test_ancestry',
1773
'bzrlib.tests.test_annotate',
1774
'bzrlib.tests.test_api',
1775
'bzrlib.tests.test_atomicfile',
1776
'bzrlib.tests.test_bad_files',
1777
'bzrlib.tests.test_branch',
1778
'bzrlib.tests.test_bundle',
1779
'bzrlib.tests.test_bzrdir',
1780
'bzrlib.tests.test_cache_utf8',
1781
'bzrlib.tests.test_commands',
1782
'bzrlib.tests.test_commit',
1783
'bzrlib.tests.test_commit_merge',
1784
'bzrlib.tests.test_config',
1785
'bzrlib.tests.test_conflicts',
1786
'bzrlib.tests.test_decorators',
1787
'bzrlib.tests.test_delta',
1788
'bzrlib.tests.test_diff',
1789
'bzrlib.tests.test_doc_generate',
1790
'bzrlib.tests.test_errors',
1791
'bzrlib.tests.test_escaped_store',
1792
'bzrlib.tests.test_fetch',
1793
'bzrlib.tests.test_ftp_transport',
1794
'bzrlib.tests.test_generate_docs',
1795
'bzrlib.tests.test_generate_ids',
1796
'bzrlib.tests.test_globbing',
1797
'bzrlib.tests.test_gpg',
1798
'bzrlib.tests.test_graph',
1799
'bzrlib.tests.test_hashcache',
1800
'bzrlib.tests.test_http',
1801
'bzrlib.tests.test_http_response',
1802
'bzrlib.tests.test_https_ca_bundle',
1803
'bzrlib.tests.test_identitymap',
1804
'bzrlib.tests.test_ignores',
1805
'bzrlib.tests.test_inv',
1806
'bzrlib.tests.test_knit',
1807
'bzrlib.tests.test_lazy_import',
1808
'bzrlib.tests.test_lazy_regex',
1809
'bzrlib.tests.test_lockdir',
1810
'bzrlib.tests.test_lockable_files',
1811
'bzrlib.tests.test_log',
1812
'bzrlib.tests.test_memorytree',
1813
'bzrlib.tests.test_merge',
1814
'bzrlib.tests.test_merge3',
1815
'bzrlib.tests.test_merge_core',
1816
'bzrlib.tests.test_missing',
1817
'bzrlib.tests.test_msgeditor',
1818
'bzrlib.tests.test_nonascii',
1819
'bzrlib.tests.test_options',
1820
'bzrlib.tests.test_osutils',
1821
'bzrlib.tests.test_osutils_encodings',
1822
'bzrlib.tests.test_patch',
1823
'bzrlib.tests.test_patches',
1824
'bzrlib.tests.test_permissions',
1825
'bzrlib.tests.test_plugins',
1826
'bzrlib.tests.test_progress',
1827
'bzrlib.tests.test_reconcile',
1828
'bzrlib.tests.test_registry',
1829
'bzrlib.tests.test_repository',
1830
'bzrlib.tests.test_revert',
1831
'bzrlib.tests.test_revision',
1832
'bzrlib.tests.test_revisionnamespaces',
1833
'bzrlib.tests.test_revisiontree',
1834
'bzrlib.tests.test_rio',
1835
'bzrlib.tests.test_sampler',
1836
'bzrlib.tests.test_selftest',
1837
'bzrlib.tests.test_setup',
1838
'bzrlib.tests.test_sftp_transport',
1839
'bzrlib.tests.test_smart_add',
1840
'bzrlib.tests.test_smart_transport',
1841
'bzrlib.tests.test_source',
1842
'bzrlib.tests.test_status',
1843
'bzrlib.tests.test_store',
1844
'bzrlib.tests.test_symbol_versioning',
1845
'bzrlib.tests.test_tag',
1846
'bzrlib.tests.test_testament',
1847
'bzrlib.tests.test_textfile',
1848
'bzrlib.tests.test_textmerge',
1849
'bzrlib.tests.test_trace',
1850
'bzrlib.tests.test_transactions',
1851
'bzrlib.tests.test_transform',
1852
'bzrlib.tests.test_transport',
1853
'bzrlib.tests.test_tree',
1854
'bzrlib.tests.test_treebuilder',
1855
'bzrlib.tests.test_tsort',
1856
'bzrlib.tests.test_tuned_gzip',
1857
'bzrlib.tests.test_ui',
1858
'bzrlib.tests.test_upgrade',
1859
'bzrlib.tests.test_urlutils',
1860
'bzrlib.tests.test_versionedfile',
1861
'bzrlib.tests.test_version',
1862
'bzrlib.tests.test_version_info',
1863
'bzrlib.tests.test_weave',
1864
'bzrlib.tests.test_whitebox',
1865
'bzrlib.tests.test_workingtree',
1866
'bzrlib.tests.test_wsgi',
1867
'bzrlib.tests.test_xml',
1869
test_transport_implementations = [
1870
'bzrlib.tests.test_transport_implementations',
1871
'bzrlib.tests.test_read_bundle',
1873
suite = TestUtil.TestSuite()
1874
loader = TestUtil.TestLoader()
1875
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1876
from bzrlib.transport import TransportTestProviderAdapter
1877
adapter = TransportTestProviderAdapter()
1878
adapt_modules(test_transport_implementations, adapter, loader, suite)
1879
for package in packages_to_test():
1880
suite.addTest(package.test_suite())
1881
for m in MODULES_TO_TEST:
1882
suite.addTest(loader.loadTestsFromModule(m))
1883
for m in MODULES_TO_DOCTEST:
1885
suite.addTest(doctest.DocTestSuite(m))
1886
except ValueError, e:
1887
print '**failed to get doctest for: %s\n%s' %(m,e)
1889
for name, plugin in bzrlib.plugin.all_plugins().items():
1890
if getattr(plugin, 'test_suite', None) is not None:
1891
default_encoding = sys.getdefaultencoding()
1893
plugin_suite = plugin.test_suite()
1894
except ImportError, e:
1895
bzrlib.trace.warning(
1896
'Unable to test plugin "%s": %s', name, e)
1898
suite.addTest(plugin_suite)
1899
if default_encoding != sys.getdefaultencoding():
1900
bzrlib.trace.warning(
1901
'Plugin "%s" tried to reset default encoding to: %s', name,
1902
sys.getdefaultencoding())
1904
sys.setdefaultencoding(default_encoding)
1908
def adapt_modules(mods_list, adapter, loader, suite):
1909
"""Adapt the modules in mods_list using adapter and add to suite."""
1910
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1911
suite.addTests(adapter.adapt(test))
1914
def clean_selftest_output(root=None, quiet=False):
1915
"""Remove all selftest output directories from root directory.
1917
:param root: root directory for clean
1918
(if ommitted or None then clean current directory).
1919
:param quiet: suppress report about deleting directories
1924
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
1927
for i in os.listdir(root):
1928
if os.path.isdir(i) and re_dir.match(i):
1930
print 'delete directory:', i
added
removed
bzrlib/tests/__init__.py
