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,
105
NUMBERED_DIRS = False # dirs kind for TestCaseInTempDir (numbered or named)
108
def packages_to_test():
109
"""Return a list of packages to test.
111
The packages are not globally imported so that import failures are
112
triggered when running selftest, not when importing the command.
115
import bzrlib.tests.blackbox
116
import bzrlib.tests.branch_implementations
117
import bzrlib.tests.bzrdir_implementations
118
import bzrlib.tests.interrepository_implementations
119
import bzrlib.tests.interversionedfile_implementations
120
import bzrlib.tests.intertree_implementations
121
import bzrlib.tests.repository_implementations
122
import bzrlib.tests.revisionstore_implementations
123
import bzrlib.tests.tree_implementations
124
import bzrlib.tests.workingtree_implementations
127
bzrlib.tests.blackbox,
128
bzrlib.tests.branch_implementations,
129
bzrlib.tests.bzrdir_implementations,
130
bzrlib.tests.interrepository_implementations,
131
bzrlib.tests.interversionedfile_implementations,
132
bzrlib.tests.intertree_implementations,
133
bzrlib.tests.repository_implementations,
134
bzrlib.tests.revisionstore_implementations,
135
bzrlib.tests.tree_implementations,
136
bzrlib.tests.workingtree_implementations,
140
class ExtendedTestResult(unittest._TextTestResult):
141
"""Accepts, reports and accumulates the results of running tests.
143
Compared to this unittest version this class adds support for profiling,
144
benchmarking, stopping as soon as a test fails, and skipping tests.
145
There are further-specialized subclasses for different types of display.
150
def __init__(self, stream, descriptions, verbosity,
154
"""Construct new TestResult.
156
:param bench_history: Optionally, a writable file object to accumulate
159
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
160
if bench_history is not None:
161
from bzrlib.version import _get_bzr_source_tree
162
src_tree = _get_bzr_source_tree()
165
revision_id = src_tree.get_parent_ids()[0]
167
# XXX: if this is a brand new tree, do the same as if there
171
# XXX: If there's no branch, what should we do?
173
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
174
self._bench_history = bench_history
175
self.ui = bzrlib.ui.ui_factory
176
self.num_tests = num_tests
178
self.failure_count = 0
181
self._overall_start_time = time.time()
183
def extractBenchmarkTime(self, testCase):
184
"""Add a benchmark time for the current test case."""
185
self._benchmarkTime = getattr(testCase, "_benchtime", None)
187
def _elapsedTestTimeString(self):
188
"""Return a time string for the overall time the current test has taken."""
189
return self._formatTime(time.time() - self._start_time)
191
def _testTimeString(self):
192
if self._benchmarkTime is not None:
194
self._formatTime(self._benchmarkTime),
195
self._elapsedTestTimeString())
197
return " %s" % self._elapsedTestTimeString()
199
def _formatTime(self, seconds):
200
"""Format seconds as milliseconds with leading spaces."""
201
# some benchmarks can take thousands of seconds to run, so we need 8
203
return "%8dms" % (1000 * seconds)
205
def _shortened_test_description(self, test):
207
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
210
def startTest(self, test):
211
unittest.TestResult.startTest(self, test)
212
self.report_test_start(test)
213
test.number = self.count
214
self._recordTestStartTime()
216
def _recordTestStartTime(self):
217
"""Record that a test has started."""
218
self._start_time = time.time()
220
def addError(self, test, err):
221
if isinstance(err[1], TestSkipped):
222
return self.addSkipped(test, err)
223
unittest.TestResult.addError(self, test, err)
224
# We can only do this if we have one of our TestCases, not if
226
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
227
if setKeepLogfile is not None:
229
self.extractBenchmarkTime(test)
230
self.report_error(test, err)
234
def addFailure(self, test, err):
235
unittest.TestResult.addFailure(self, test, err)
236
# We can only do this if we have one of our TestCases, not if
238
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
239
if setKeepLogfile is not None:
241
self.extractBenchmarkTime(test)
242
self.report_failure(test, err)
246
def addSuccess(self, test):
247
self.extractBenchmarkTime(test)
248
if self._bench_history is not None:
249
if self._benchmarkTime is not None:
250
self._bench_history.write("%s %s\n" % (
251
self._formatTime(self._benchmarkTime),
253
self.report_success(test)
254
unittest.TestResult.addSuccess(self, test)
256
def addSkipped(self, test, skip_excinfo):
257
self.extractBenchmarkTime(test)
258
self.report_skip(test, skip_excinfo)
259
# seems best to treat this as success from point-of-view of unittest
260
# -- it actually does nothing so it barely matters :)
263
except KeyboardInterrupt:
266
self.addError(test, test.__exc_info())
268
unittest.TestResult.addSuccess(self, test)
270
def printErrorList(self, flavour, errors):
271
for test, err in errors:
272
self.stream.writeln(self.separator1)
273
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
274
if getattr(test, '_get_log', None) is not None:
276
print >>self.stream, \
277
('vvvv[log from %s]' % test.id()).ljust(78,'-')
278
print >>self.stream, test._get_log()
279
print >>self.stream, \
280
('^^^^[log from %s]' % test.id()).ljust(78,'-')
281
self.stream.writeln(self.separator2)
282
self.stream.writeln("%s" % err)
287
def report_cleaning_up(self):
290
def report_success(self, test):
294
class TextTestResult(ExtendedTestResult):
295
"""Displays progress and results of tests in text form"""
297
def __init__(self, *args, **kw):
298
ExtendedTestResult.__init__(self, *args, **kw)
299
self.pb = self.ui.nested_progress_bar()
300
self.pb.show_pct = False
301
self.pb.show_spinner = False
302
self.pb.show_eta = False,
303
self.pb.show_count = False
304
self.pb.show_bar = False
306
def report_starting(self):
307
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
309
def _progress_prefix_text(self):
310
a = '[%d' % self.count
311
if self.num_tests is not None:
312
a +='/%d' % self.num_tests
313
a += ' in %ds' % (time.time() - self._overall_start_time)
315
a += ', %d errors' % self.error_count
316
if self.failure_count:
317
a += ', %d failed' % self.failure_count
319
a += ', %d skipped' % self.skip_count
323
def report_test_start(self, test):
326
self._progress_prefix_text()
328
+ self._shortened_test_description(test))
330
def _test_description(self, test):
332
return '#%d %s' % (self.count,
333
self._shortened_test_description(test))
335
return self._shortened_test_description(test)
337
def report_error(self, test, err):
338
self.error_count += 1
339
self.pb.note('ERROR: %s\n %s\n',
340
self._test_description(test),
344
def report_failure(self, test, err):
345
self.failure_count += 1
346
self.pb.note('FAIL: %s\n %s\n',
347
self._test_description(test),
351
def report_skip(self, test, skip_excinfo):
354
# at the moment these are mostly not things we can fix
355
# and so they just produce stipple; use the verbose reporter
358
# show test and reason for skip
359
self.pb.note('SKIP: %s\n %s\n',
360
self._shortened_test_description(test),
363
# since the class name was left behind in the still-visible
365
self.pb.note('SKIP: %s', skip_excinfo[1])
367
def report_cleaning_up(self):
368
self.pb.update('cleaning up...')
374
class VerboseTestResult(ExtendedTestResult):
375
"""Produce long output, with one line per test run plus times"""
377
def _ellipsize_to_right(self, a_string, final_width):
378
"""Truncate and pad a string, keeping the right hand side"""
379
if len(a_string) > final_width:
380
result = '...' + a_string[3-final_width:]
383
return result.ljust(final_width)
385
def report_starting(self):
386
self.stream.write('running %d tests...\n' % self.num_tests)
388
def report_test_start(self, test):
390
name = self._shortened_test_description(test)
391
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
392
# numbers, plus a trailing blank
393
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
395
self.stream.write('%5d ' % self.count)
396
self.stream.write(self._ellipsize_to_right(name,
397
osutils.terminal_width()-36))
399
self.stream.write(self._ellipsize_to_right(name,
400
osutils.terminal_width()-30))
403
def _error_summary(self, err):
407
return '%s%s' % (indent, err[1])
409
def report_error(self, test, err):
410
self.error_count += 1
411
self.stream.writeln('ERROR %s\n%s'
412
% (self._testTimeString(),
413
self._error_summary(err)))
415
def report_failure(self, test, err):
416
self.failure_count += 1
417
self.stream.writeln(' FAIL %s\n%s'
418
% (self._testTimeString(),
419
self._error_summary(err)))
421
def report_success(self, test):
422
self.stream.writeln(' OK %s' % self._testTimeString())
423
for bench_called, stats in getattr(test, '_benchcalls', []):
425
self.stream.write(' ' * 6)
426
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
427
stats.pprint(file=self.stream)
430
def report_skip(self, test, skip_excinfo):
432
self.stream.writeln(' SKIP %s\n%s'
433
% (self._testTimeString(),
434
self._error_summary(skip_excinfo)))
437
class TextTestRunner(object):
438
stop_on_failure = False
446
self.stream = unittest._WritelnDecorator(stream)
447
self.descriptions = descriptions
448
self.verbosity = verbosity
449
self.keep_output = keep_output
450
self._bench_history = bench_history
453
"Run the given test case or test suite."
454
startTime = time.time()
455
if self.verbosity == 1:
456
result_class = TextTestResult
457
elif self.verbosity >= 2:
458
result_class = VerboseTestResult
459
result = result_class(self.stream,
462
bench_history=self._bench_history,
463
num_tests=test.countTestCases(),
465
result.stop_early = self.stop_on_failure
466
result.report_starting()
468
stopTime = time.time()
469
timeTaken = stopTime - startTime
471
self.stream.writeln(result.separator2)
472
run = result.testsRun
473
self.stream.writeln("Ran %d test%s in %.3fs" %
474
(run, run != 1 and "s" or "", timeTaken))
475
self.stream.writeln()
476
if not result.wasSuccessful():
477
self.stream.write("FAILED (")
478
failed, errored = map(len, (result.failures, result.errors))
480
self.stream.write("failures=%d" % failed)
482
if failed: self.stream.write(", ")
483
self.stream.write("errors=%d" % errored)
484
self.stream.writeln(")")
486
self.stream.writeln("OK")
487
if result.skip_count > 0:
488
skipped = result.skip_count
489
self.stream.writeln('%d test%s skipped' %
490
(skipped, skipped != 1 and "s" or ""))
491
result.report_cleaning_up()
492
# This is still a little bogus,
493
# but only a little. Folk not using our testrunner will
494
# have to delete their temp directories themselves.
495
test_root = TestCaseWithMemoryTransport.TEST_ROOT
496
if result.wasSuccessful() or not self.keep_output:
497
if test_root is not None:
498
# If LANG=C we probably have created some bogus paths
499
# which rmtree(unicode) will fail to delete
500
# so make sure we are using rmtree(str) to delete everything
501
# except on win32, where rmtree(str) will fail
502
# since it doesn't have the property of byte-stream paths
503
# (they are either ascii or mbcs)
504
if sys.platform == 'win32':
505
# make sure we are using the unicode win32 api
506
test_root = unicode(test_root)
508
test_root = test_root.encode(
509
sys.getfilesystemencoding())
511
osutils.rmtree(test_root)
513
if sys.platform == 'win32' and e.errno == errno.EACCES:
514
print >>sys.stderr, ('Permission denied: '
515
'unable to remove testing dir '
516
'%s' % os.path.basename(test_root))
520
note("Failed tests working directories are in '%s'\n", test_root)
521
TestCaseWithMemoryTransport.TEST_ROOT = None
526
def iter_suite_tests(suite):
527
"""Return all tests in a suite, recursing through nested suites"""
528
for item in suite._tests:
529
if isinstance(item, unittest.TestCase):
531
elif isinstance(item, unittest.TestSuite):
532
for r in iter_suite_tests(item):
535
raise Exception('unknown object %r inside test suite %r'
539
class TestSkipped(Exception):
540
"""Indicates that a test was intentionally skipped, rather than failing."""
543
class CommandFailed(Exception):
547
class StringIOWrapper(object):
548
"""A wrapper around cStringIO which just adds an encoding attribute.
550
Internally we can check sys.stdout to see what the output encoding
551
should be. However, cStringIO has no encoding attribute that we can
552
set. So we wrap it instead.
557
def __init__(self, s=None):
559
self.__dict__['_cstring'] = StringIO(s)
561
self.__dict__['_cstring'] = StringIO()
563
def __getattr__(self, name, getattr=getattr):
564
return getattr(self.__dict__['_cstring'], name)
566
def __setattr__(self, name, val):
567
if name == 'encoding':
568
self.__dict__['encoding'] = val
570
return setattr(self._cstring, name, val)
573
class TestCase(unittest.TestCase):
574
"""Base class for bzr unit tests.
576
Tests that need access to disk resources should subclass
577
TestCaseInTempDir not TestCase.
579
Error and debug log messages are redirected from their usual
580
location into a temporary file, the contents of which can be
581
retrieved by _get_log(). We use a real OS file, not an in-memory object,
582
so that it can also capture file IO. When the test completes this file
583
is read into memory and removed from disk.
585
There are also convenience functions to invoke bzr's command-line
586
routine, and to build and check bzr trees.
588
In addition to the usual method of overriding tearDown(), this class also
589
allows subclasses to register functions into the _cleanups list, which is
590
run in order as the object is torn down. It's less likely this will be
591
accidentally overlooked.
594
_log_file_name = None
596
_keep_log_file = False
597
# record lsprof data when performing benchmark calls.
598
_gather_lsprof_in_benchmarks = False
600
def __init__(self, methodName='testMethod'):
601
super(TestCase, self).__init__(methodName)
605
unittest.TestCase.setUp(self)
606
self._cleanEnvironment()
607
bzrlib.trace.disable_default_logging()
610
self._benchcalls = []
611
self._benchtime = None
612
# prevent hooks affecting tests
613
self._preserved_hooks = bzrlib.branch.Branch.hooks
614
self.addCleanup(self._restoreHooks)
615
# this list of hooks must be kept in sync with the defaults
617
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
619
def _silenceUI(self):
620
"""Turn off UI for duration of test"""
621
# by default the UI is off; tests can turn it on if they want it.
622
saved = bzrlib.ui.ui_factory
624
bzrlib.ui.ui_factory = saved
625
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
626
self.addCleanup(_restore)
628
def _ndiff_strings(self, a, b):
629
"""Return ndiff between two strings containing lines.
631
A trailing newline is added if missing to make the strings
633
if b and b[-1] != '\n':
635
if a and a[-1] != '\n':
637
difflines = difflib.ndiff(a.splitlines(True),
639
linejunk=lambda x: False,
640
charjunk=lambda x: False)
641
return ''.join(difflines)
643
def assertEqualDiff(self, a, b, message=None):
644
"""Assert two texts are equal, if not raise an exception.
646
This is intended for use with multi-line strings where it can
647
be hard to find the differences by eye.
649
# TODO: perhaps override assertEquals to call this for strings?
653
message = "texts not equal:\n"
654
raise AssertionError(message +
655
self._ndiff_strings(a, b))
657
def assertEqualMode(self, mode, mode_test):
658
self.assertEqual(mode, mode_test,
659
'mode mismatch %o != %o' % (mode, mode_test))
661
def assertStartsWith(self, s, prefix):
662
if not s.startswith(prefix):
663
raise AssertionError('string %r does not start with %r' % (s, prefix))
665
def assertEndsWith(self, s, suffix):
666
"""Asserts that s ends with suffix."""
667
if not s.endswith(suffix):
668
raise AssertionError('string %r does not end with %r' % (s, suffix))
670
def assertContainsRe(self, haystack, needle_re):
671
"""Assert that a contains something matching a regular expression."""
672
if not re.search(needle_re, haystack):
673
raise AssertionError('pattern "%s" not found in "%s"'
674
% (needle_re, haystack))
676
def assertNotContainsRe(self, haystack, needle_re):
677
"""Assert that a does not match a regular expression"""
678
if re.search(needle_re, haystack):
679
raise AssertionError('pattern "%s" found in "%s"'
680
% (needle_re, haystack))
682
def assertSubset(self, sublist, superlist):
683
"""Assert that every entry in sublist is present in superlist."""
685
for entry in sublist:
686
if entry not in superlist:
687
missing.append(entry)
689
raise AssertionError("value(s) %r not present in container %r" %
690
(missing, superlist))
692
def assertListRaises(self, excClass, func, *args, **kwargs):
693
"""Fail unless excClass is raised when the iterator from func is used.
695
Many functions can return generators this makes sure
696
to wrap them in a list() call to make sure the whole generator
697
is run, and that the proper exception is raised.
700
list(func(*args, **kwargs))
704
if getattr(excClass,'__name__', None) is not None:
705
excName = excClass.__name__
707
excName = str(excClass)
708
raise self.failureException, "%s not raised" % excName
710
def assertIs(self, left, right, message=None):
711
if not (left is right):
712
if message is not None:
713
raise AssertionError(message)
715
raise AssertionError("%r is not %r." % (left, right))
717
def assertIsNot(self, left, right, message=None):
719
if message is not None:
720
raise AssertionError(message)
722
raise AssertionError("%r is %r." % (left, right))
724
def assertTransportMode(self, transport, path, mode):
725
"""Fail if a path does not have mode mode.
727
If modes are not supported on this transport, the assertion is ignored.
729
if not transport._can_roundtrip_unix_modebits():
731
path_stat = transport.stat(path)
732
actual_mode = stat.S_IMODE(path_stat.st_mode)
733
self.assertEqual(mode, actual_mode,
734
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
736
def assertIsInstance(self, obj, kls):
737
"""Fail if obj is not an instance of kls"""
738
if not isinstance(obj, kls):
739
self.fail("%r is an instance of %s rather than %s" % (
740
obj, obj.__class__, kls))
742
def _capture_warnings(self, a_callable, *args, **kwargs):
743
"""A helper for callDeprecated and applyDeprecated.
745
:param a_callable: A callable to call.
746
:param args: The positional arguments for the callable
747
:param kwargs: The keyword arguments for the callable
748
:return: A tuple (warnings, result). result is the result of calling
749
a_callable(*args, **kwargs).
752
def capture_warnings(msg, cls=None, stacklevel=None):
753
# we've hooked into a deprecation specific callpath,
754
# only deprecations should getting sent via it.
755
self.assertEqual(cls, DeprecationWarning)
756
local_warnings.append(msg)
757
original_warning_method = symbol_versioning.warn
758
symbol_versioning.set_warning_method(capture_warnings)
760
result = a_callable(*args, **kwargs)
762
symbol_versioning.set_warning_method(original_warning_method)
763
return (local_warnings, result)
765
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
766
"""Call a deprecated callable without warning the user.
768
:param deprecation_format: The deprecation format that the callable
769
should have been deprecated with. This is the same type as the
770
parameter to deprecated_method/deprecated_function. If the
771
callable is not deprecated with this format, an assertion error
773
:param a_callable: A callable to call. This may be a bound method or
774
a regular function. It will be called with *args and **kwargs.
775
:param args: The positional arguments for the callable
776
:param kwargs: The keyword arguments for the callable
777
:return: The result of a_callable(*args, **kwargs)
779
call_warnings, result = self._capture_warnings(a_callable,
781
expected_first_warning = symbol_versioning.deprecation_string(
782
a_callable, deprecation_format)
783
if len(call_warnings) == 0:
784
self.fail("No assertion generated by call to %s" %
786
self.assertEqual(expected_first_warning, call_warnings[0])
789
def callDeprecated(self, expected, callable, *args, **kwargs):
790
"""Assert that a callable is deprecated in a particular way.
792
This is a very precise test for unusual requirements. The
793
applyDeprecated helper function is probably more suited for most tests
794
as it allows you to simply specify the deprecation format being used
795
and will ensure that that is issued for the function being called.
797
:param expected: a list of the deprecation warnings expected, in order
798
:param callable: The callable to call
799
:param args: The positional arguments for the callable
800
:param kwargs: The keyword arguments for the callable
802
call_warnings, result = self._capture_warnings(callable,
804
self.assertEqual(expected, call_warnings)
807
def _startLogFile(self):
808
"""Send bzr and test log messages to a temporary file.
810
The file is removed as the test is torn down.
812
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
813
self._log_file = os.fdopen(fileno, 'w+')
814
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
815
self._log_file_name = name
816
self.addCleanup(self._finishLogFile)
818
def _finishLogFile(self):
819
"""Finished with the log file.
821
Close the file and delete it, unless setKeepLogfile was called.
823
if self._log_file is None:
825
bzrlib.trace.disable_test_log(self._log_nonce)
826
self._log_file.close()
827
self._log_file = None
828
if not self._keep_log_file:
829
os.remove(self._log_file_name)
830
self._log_file_name = None
832
def setKeepLogfile(self):
833
"""Make the logfile not be deleted when _finishLogFile is called."""
834
self._keep_log_file = True
836
def addCleanup(self, callable):
837
"""Arrange to run a callable when this case is torn down.
839
Callables are run in the reverse of the order they are registered,
840
ie last-in first-out.
842
if callable in self._cleanups:
843
raise ValueError("cleanup function %r already registered on %s"
845
self._cleanups.append(callable)
847
def _cleanEnvironment(self):
849
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
851
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
853
'BZREMAIL': None, # may still be present in the environment
855
'BZR_PROGRESS_BAR': None,
865
# Nobody cares about these ones AFAIK. So far at
866
# least. If you do (care), please update this comment
872
self.addCleanup(self._restoreEnvironment)
873
for name, value in new_env.iteritems():
874
self._captureVar(name, value)
876
def _captureVar(self, name, newvalue):
877
"""Set an environment variable, and reset it when finished."""
878
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
880
def _restoreEnvironment(self):
881
for name, value in self.__old_env.iteritems():
882
osutils.set_or_unset_env(name, value)
884
def _restoreHooks(self):
885
bzrlib.branch.Branch.hooks = self._preserved_hooks
889
unittest.TestCase.tearDown(self)
891
def time(self, callable, *args, **kwargs):
892
"""Run callable and accrue the time it takes to the benchmark time.
894
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
895
this will cause lsprofile statistics to be gathered and stored in
898
if self._benchtime is None:
902
if not self._gather_lsprof_in_benchmarks:
903
return callable(*args, **kwargs)
905
# record this benchmark
906
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
908
self._benchcalls.append(((callable, args, kwargs), stats))
911
self._benchtime += time.time() - start
913
def _runCleanups(self):
914
"""Run registered cleanup functions.
916
This should only be called from TestCase.tearDown.
918
# TODO: Perhaps this should keep running cleanups even if
920
for cleanup_fn in reversed(self._cleanups):
923
def log(self, *args):
926
def _get_log(self, keep_log_file=False):
927
"""Return as a string the log for this test. If the file is still
928
on disk and keep_log_file=False, delete the log file and store the
929
content in self._log_contents."""
930
# flush the log file, to get all content
932
bzrlib.trace._trace_file.flush()
933
if self._log_contents:
934
return self._log_contents
935
if self._log_file_name is not None:
936
logfile = open(self._log_file_name)
938
log_contents = logfile.read()
941
if not keep_log_file:
942
self._log_contents = log_contents
944
os.remove(self._log_file_name)
946
if sys.platform == 'win32' and e.errno == errno.EACCES:
947
print >>sys.stderr, ('Unable to delete log file '
948
' %r' % self._log_file_name)
953
return "DELETED log file to reduce memory footprint"
955
def capture(self, cmd, retcode=0):
956
"""Shortcut that splits cmd into words, runs, and returns stdout"""
957
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
959
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
961
"""Invoke bzr and return (stdout, stderr).
963
Useful for code that wants to check the contents of the
964
output, the way error messages are presented, etc.
966
This should be the main method for tests that want to exercise the
967
overall behavior of the bzr application (rather than a unit test
968
or a functional test of the library.)
970
Much of the old code runs bzr by forking a new copy of Python, but
971
that is slower, harder to debug, and generally not necessary.
973
This runs bzr through the interface that catches and reports
974
errors, and with logging set to something approximating the
975
default, so that error reporting can be checked.
977
:param argv: arguments to invoke bzr
978
:param retcode: expected return code, or None for don't-care.
979
:param encoding: encoding for sys.stdout and sys.stderr
980
:param stdin: A string to be used as stdin for the command.
981
:param working_dir: Change to this directory before running
984
encoding = bzrlib.user_encoding
985
if stdin is not None:
986
stdin = StringIO(stdin)
987
stdout = StringIOWrapper()
988
stderr = StringIOWrapper()
989
stdout.encoding = encoding
990
stderr.encoding = encoding
992
self.log('run bzr: %r', argv)
993
# FIXME: don't call into logging here
994
handler = logging.StreamHandler(stderr)
995
handler.setLevel(logging.INFO)
996
logger = logging.getLogger('')
997
logger.addHandler(handler)
998
old_ui_factory = bzrlib.ui.ui_factory
999
bzrlib.ui.ui_factory = bzrlib.tests.blackbox.TestUIFactory(
1002
bzrlib.ui.ui_factory.stdin = stdin
1005
if working_dir is not None:
1006
cwd = osutils.getcwd()
1007
os.chdir(working_dir)
1010
saved_debug_flags = frozenset(debug.debug_flags)
1011
debug.debug_flags.clear()
1013
result = self.apply_redirected(stdin, stdout, stderr,
1014
bzrlib.commands.run_bzr_catch_errors,
1017
debug.debug_flags.update(saved_debug_flags)
1019
logger.removeHandler(handler)
1020
bzrlib.ui.ui_factory = old_ui_factory
1024
out = stdout.getvalue()
1025
err = stderr.getvalue()
1027
self.log('output:\n%r', out)
1029
self.log('errors:\n%r', err)
1030
if retcode is not None:
1031
self.assertEquals(retcode, result)
1034
def run_bzr(self, *args, **kwargs):
1035
"""Invoke bzr, as if it were run from the command line.
1037
This should be the main method for tests that want to exercise the
1038
overall behavior of the bzr application (rather than a unit test
1039
or a functional test of the library.)
1041
This sends the stdout/stderr results into the test's log,
1042
where it may be useful for debugging. See also run_captured.
1044
:param stdin: A string to be used as stdin for the command.
1046
retcode = kwargs.pop('retcode', 0)
1047
encoding = kwargs.pop('encoding', None)
1048
stdin = kwargs.pop('stdin', None)
1049
working_dir = kwargs.pop('working_dir', None)
1050
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding,
1051
stdin=stdin, working_dir=working_dir)
1053
def run_bzr_decode(self, *args, **kwargs):
1054
if 'encoding' in kwargs:
1055
encoding = kwargs['encoding']
1057
encoding = bzrlib.user_encoding
1058
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1060
def run_bzr_error(self, error_regexes, *args, **kwargs):
1061
"""Run bzr, and check that stderr contains the supplied regexes
1063
:param error_regexes: Sequence of regular expressions which
1064
must each be found in the error output. The relative ordering
1066
:param args: command-line arguments for bzr
1067
:param kwargs: Keyword arguments which are interpreted by run_bzr
1068
This function changes the default value of retcode to be 3,
1069
since in most cases this is run when you expect bzr to fail.
1070
:return: (out, err) The actual output of running the command (in case you
1071
want to do more inspection)
1074
# Make sure that commit is failing because there is nothing to do
1075
self.run_bzr_error(['no changes to commit'],
1076
'commit', '-m', 'my commit comment')
1077
# Make sure --strict is handling an unknown file, rather than
1078
# giving us the 'nothing to do' error
1079
self.build_tree(['unknown'])
1080
self.run_bzr_error(['Commit refused because there are unknown files'],
1081
'commit', '--strict', '-m', 'my commit comment')
1083
kwargs.setdefault('retcode', 3)
1084
out, err = self.run_bzr(*args, **kwargs)
1085
for regex in error_regexes:
1086
self.assertContainsRe(err, regex)
1089
def run_bzr_subprocess(self, *args, **kwargs):
1090
"""Run bzr in a subprocess for testing.
1092
This starts a new Python interpreter and runs bzr in there.
1093
This should only be used for tests that have a justifiable need for
1094
this isolation: e.g. they are testing startup time, or signal
1095
handling, or early startup code, etc. Subprocess code can't be
1096
profiled or debugged so easily.
1098
:param retcode: The status code that is expected. Defaults to 0. If
1099
None is supplied, the status code is not checked.
1100
:param env_changes: A dictionary which lists changes to environment
1101
variables. A value of None will unset the env variable.
1102
The values must be strings. The change will only occur in the
1103
child, so you don't need to fix the environment after running.
1104
:param universal_newlines: Convert CRLF => LF
1105
:param allow_plugins: By default the subprocess is run with
1106
--no-plugins to ensure test reproducibility. Also, it is possible
1107
for system-wide plugins to create unexpected output on stderr,
1108
which can cause unnecessary test failures.
1110
env_changes = kwargs.get('env_changes', {})
1111
working_dir = kwargs.get('working_dir', None)
1112
allow_plugins = kwargs.get('allow_plugins', False)
1113
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1114
working_dir=working_dir,
1115
allow_plugins=allow_plugins)
1116
# We distinguish between retcode=None and retcode not passed.
1117
supplied_retcode = kwargs.get('retcode', 0)
1118
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1119
universal_newlines=kwargs.get('universal_newlines', False),
1122
def start_bzr_subprocess(self, process_args, env_changes=None,
1123
skip_if_plan_to_signal=False,
1125
allow_plugins=False):
1126
"""Start bzr in a subprocess for testing.
1128
This starts a new Python interpreter and runs bzr in there.
1129
This should only be used for tests that have a justifiable need for
1130
this isolation: e.g. they are testing startup time, or signal
1131
handling, or early startup code, etc. Subprocess code can't be
1132
profiled or debugged so easily.
1134
:param process_args: a list of arguments to pass to the bzr executable,
1135
for example `['--version']`.
1136
:param env_changes: A dictionary which lists changes to environment
1137
variables. A value of None will unset the env variable.
1138
The values must be strings. The change will only occur in the
1139
child, so you don't need to fix the environment after running.
1140
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1142
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1144
:returns: Popen object for the started process.
1146
if skip_if_plan_to_signal:
1147
if not getattr(os, 'kill', None):
1148
raise TestSkipped("os.kill not available.")
1150
if env_changes is None:
1154
def cleanup_environment():
1155
for env_var, value in env_changes.iteritems():
1156
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1158
def restore_environment():
1159
for env_var, value in old_env.iteritems():
1160
osutils.set_or_unset_env(env_var, value)
1162
bzr_path = self.get_bzr_path()
1165
if working_dir is not None:
1166
cwd = osutils.getcwd()
1167
os.chdir(working_dir)
1170
# win32 subprocess doesn't support preexec_fn
1171
# so we will avoid using it on all platforms, just to
1172
# make sure the code path is used, and we don't break on win32
1173
cleanup_environment()
1174
command = [sys.executable, bzr_path]
1175
if not allow_plugins:
1176
command.append('--no-plugins')
1177
command.extend(process_args)
1178
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1180
restore_environment()
1186
def _popen(self, *args, **kwargs):
1187
"""Place a call to Popen.
1189
Allows tests to override this method to intercept the calls made to
1190
Popen for introspection.
1192
return Popen(*args, **kwargs)
1194
def get_bzr_path(self):
1195
"""Return the path of the 'bzr' executable for this test suite."""
1196
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1197
if not os.path.isfile(bzr_path):
1198
# We are probably installed. Assume sys.argv is the right file
1199
bzr_path = sys.argv[0]
1202
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1203
universal_newlines=False, process_args=None):
1204
"""Finish the execution of process.
1206
:param process: the Popen object returned from start_bzr_subprocess.
1207
:param retcode: The status code that is expected. Defaults to 0. If
1208
None is supplied, the status code is not checked.
1209
:param send_signal: an optional signal to send to the process.
1210
:param universal_newlines: Convert CRLF => LF
1211
:returns: (stdout, stderr)
1213
if send_signal is not None:
1214
os.kill(process.pid, send_signal)
1215
out, err = process.communicate()
1217
if universal_newlines:
1218
out = out.replace('\r\n', '\n')
1219
err = err.replace('\r\n', '\n')
1221
if retcode is not None and retcode != process.returncode:
1222
if process_args is None:
1223
process_args = "(unknown args)"
1224
mutter('Output of bzr %s:\n%s', process_args, out)
1225
mutter('Error for bzr %s:\n%s', process_args, err)
1226
self.fail('Command bzr %s failed with retcode %s != %s'
1227
% (process_args, retcode, process.returncode))
1230
def check_inventory_shape(self, inv, shape):
1231
"""Compare an inventory to a list of expected names.
1233
Fail if they are not precisely equal.
1236
shape = list(shape) # copy
1237
for path, ie in inv.entries():
1238
name = path.replace('\\', '/')
1239
if ie.kind == 'dir':
1246
self.fail("expected paths not found in inventory: %r" % shape)
1248
self.fail("unexpected paths found in inventory: %r" % extras)
1250
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1251
a_callable=None, *args, **kwargs):
1252
"""Call callable with redirected std io pipes.
1254
Returns the return code."""
1255
if not callable(a_callable):
1256
raise ValueError("a_callable must be callable.")
1258
stdin = StringIO("")
1260
if getattr(self, "_log_file", None) is not None:
1261
stdout = self._log_file
1265
if getattr(self, "_log_file", None is not None):
1266
stderr = self._log_file
1269
real_stdin = sys.stdin
1270
real_stdout = sys.stdout
1271
real_stderr = sys.stderr
1276
return a_callable(*args, **kwargs)
1278
sys.stdout = real_stdout
1279
sys.stderr = real_stderr
1280
sys.stdin = real_stdin
1282
@symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
1283
def merge(self, branch_from, wt_to):
1284
"""A helper for tests to do a ui-less merge.
1286
This should move to the main library when someone has time to integrate
1289
# minimal ui-less merge.
1290
wt_to.branch.fetch(branch_from)
1291
base_rev = common_ancestor(branch_from.last_revision(),
1292
wt_to.branch.last_revision(),
1293
wt_to.branch.repository)
1294
merge_inner(wt_to.branch, branch_from.basis_tree(),
1295
wt_to.branch.repository.revision_tree(base_rev),
1297
wt_to.add_parent_tree_id(branch_from.last_revision())
1300
BzrTestBase = TestCase
1303
class TestCaseWithMemoryTransport(TestCase):
1304
"""Common test class for tests that do not need disk resources.
1306
Tests that need disk resources should derive from TestCaseWithTransport.
1308
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1310
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1311
a directory which does not exist. This serves to help ensure test isolation
1312
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1313
must exist. However, TestCaseWithMemoryTransport does not offer local
1314
file defaults for the transport in tests, nor does it obey the command line
1315
override, so tests that accidentally write to the common directory should
1323
def __init__(self, methodName='runTest'):
1324
# allow test parameterisation after test construction and before test
1325
# execution. Variables that the parameteriser sets need to be
1326
# ones that are not set by setUp, or setUp will trash them.
1327
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1328
self.transport_server = default_transport
1329
self.transport_readonly_server = None
1331
def get_transport(self):
1332
"""Return a writeable transport for the test scratch space"""
1333
t = get_transport(self.get_url())
1334
self.assertFalse(t.is_readonly())
1337
def get_readonly_transport(self):
1338
"""Return a readonly transport for the test scratch space
1340
This can be used to test that operations which should only need
1341
readonly access in fact do not try to write.
1343
t = get_transport(self.get_readonly_url())
1344
self.assertTrue(t.is_readonly())
1347
def create_transport_readonly_server(self):
1348
"""Create a transport server from class defined at init.
1350
This is mostly a hook for daughter classes.
1352
return self.transport_readonly_server()
1354
def get_readonly_server(self):
1355
"""Get the server instance for the readonly transport
1357
This is useful for some tests with specific servers to do diagnostics.
1359
if self.__readonly_server is None:
1360
if self.transport_readonly_server is None:
1361
# readonly decorator requested
1362
# bring up the server
1364
self.__readonly_server = ReadonlyServer()
1365
self.__readonly_server.setUp(self.__server)
1367
self.__readonly_server = self.create_transport_readonly_server()
1368
self.__readonly_server.setUp()
1369
self.addCleanup(self.__readonly_server.tearDown)
1370
return self.__readonly_server
1372
def get_readonly_url(self, relpath=None):
1373
"""Get a URL for the readonly transport.
1375
This will either be backed by '.' or a decorator to the transport
1376
used by self.get_url()
1377
relpath provides for clients to get a path relative to the base url.
1378
These should only be downwards relative, not upwards.
1380
base = self.get_readonly_server().get_url()
1381
if relpath is not None:
1382
if not base.endswith('/'):
1384
base = base + relpath
1387
def get_server(self):
1388
"""Get the read/write server instance.
1390
This is useful for some tests with specific servers that need
1393
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1394
is no means to override it.
1396
if self.__server is None:
1397
self.__server = MemoryServer()
1398
self.__server.setUp()
1399
self.addCleanup(self.__server.tearDown)
1400
return self.__server
1402
def get_url(self, relpath=None):
1403
"""Get a URL (or maybe a path) for the readwrite transport.
1405
This will either be backed by '.' or to an equivalent non-file based
1407
relpath provides for clients to get a path relative to the base url.
1408
These should only be downwards relative, not upwards.
1410
base = self.get_server().get_url()
1411
if relpath is not None and relpath != '.':
1412
if not base.endswith('/'):
1414
# XXX: Really base should be a url; we did after all call
1415
# get_url()! But sometimes it's just a path (from
1416
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1417
# to a non-escaped local path.
1418
if base.startswith('./') or base.startswith('/'):
1421
base += urlutils.escape(relpath)
1424
def _make_test_root(self):
1425
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1429
root = u'test%04d.tmp' % i
1433
if e.errno == errno.EEXIST:
1438
# successfully created
1439
TestCaseWithMemoryTransport.TEST_ROOT = osutils.abspath(root)
1441
# make a fake bzr directory there to prevent any tests propagating
1442
# up onto the source directory's real branch
1443
bzrdir.BzrDir.create_standalone_workingtree(
1444
TestCaseWithMemoryTransport.TEST_ROOT)
1446
def makeAndChdirToTestDir(self):
1447
"""Create a temporary directories for this one test.
1449
This must set self.test_home_dir and self.test_dir and chdir to
1452
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1454
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1455
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1456
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1458
def make_branch(self, relpath, format=None):
1459
"""Create a branch on the transport at relpath."""
1460
repo = self.make_repository(relpath, format=format)
1461
return repo.bzrdir.create_branch()
1463
def make_bzrdir(self, relpath, format=None):
1465
# might be a relative or absolute path
1466
maybe_a_url = self.get_url(relpath)
1467
segments = maybe_a_url.rsplit('/', 1)
1468
t = get_transport(maybe_a_url)
1469
if len(segments) > 1 and segments[-1] not in ('', '.'):
1472
except errors.FileExists:
1476
if isinstance(format, basestring):
1477
format = bzrdir.format_registry.make_bzrdir(format)
1478
return format.initialize_on_transport(t)
1479
except errors.UninitializableFormat:
1480
raise TestSkipped("Format %s is not initializable." % format)
1482
def make_repository(self, relpath, shared=False, format=None):
1483
"""Create a repository on our default transport at relpath."""
1484
made_control = self.make_bzrdir(relpath, format=format)
1485
return made_control.create_repository(shared=shared)
1487
def make_branch_and_memory_tree(self, relpath, format=None):
1488
"""Create a branch on the default transport and a MemoryTree for it."""
1489
b = self.make_branch(relpath, format=format)
1490
return memorytree.MemoryTree.create_on_branch(b)
1492
def overrideEnvironmentForTesting(self):
1493
os.environ['HOME'] = self.test_home_dir
1494
os.environ['BZR_HOME'] = self.test_home_dir
1497
super(TestCaseWithMemoryTransport, self).setUp()
1498
self._make_test_root()
1499
_currentdir = os.getcwdu()
1500
def _leaveDirectory():
1501
os.chdir(_currentdir)
1502
self.addCleanup(_leaveDirectory)
1503
self.makeAndChdirToTestDir()
1504
self.overrideEnvironmentForTesting()
1505
self.__readonly_server = None
1506
self.__server = None
1509
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1510
"""Derived class that runs a test within a temporary directory.
1512
This is useful for tests that need to create a branch, etc.
1514
The directory is created in a slightly complex way: for each
1515
Python invocation, a new temporary top-level directory is created.
1516
All test cases create their own directory within that. If the
1517
tests complete successfully, the directory is removed.
1519
InTempDir is an old alias for FunctionalTestCase.
1522
OVERRIDE_PYTHON = 'python'
1524
def check_file_contents(self, filename, expect):
1525
self.log("check contents of file %s" % filename)
1526
contents = file(filename, 'r').read()
1527
if contents != expect:
1528
self.log("expected: %r" % expect)
1529
self.log("actually: %r" % contents)
1530
self.fail("contents of %s not as expected" % filename)
1532
def makeAndChdirToTestDir(self):
1533
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1535
For TestCaseInTempDir we create a temporary directory based on the test
1536
name and then create two subdirs - test and home under it.
1538
if NUMBERED_DIRS: # strongly recommended on Windows
1539
# due the path length limitation (260 chars)
1540
candidate_dir = '%s/%dK/%05d' % (self.TEST_ROOT,
1541
int(self.number/1000),
1543
os.makedirs(candidate_dir)
1544
self.test_home_dir = candidate_dir + '/home'
1545
os.mkdir(self.test_home_dir)
1546
self.test_dir = candidate_dir + '/work'
1547
os.mkdir(self.test_dir)
1548
os.chdir(self.test_dir)
1549
# put name of test inside
1550
f = file(candidate_dir + '/name', 'w')
1555
# shorten the name, to avoid test failures due to path length
1556
short_id = self.id().replace('bzrlib.tests.', '') \
1557
.replace('__main__.', '')[-100:]
1558
# it's possible the same test class is run several times for
1559
# parameterized tests, so make sure the names don't collide.
1563
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1565
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1566
if os.path.exists(candidate_dir):
1570
os.mkdir(candidate_dir)
1571
self.test_home_dir = candidate_dir + '/home'
1572
os.mkdir(self.test_home_dir)
1573
self.test_dir = candidate_dir + '/work'
1574
os.mkdir(self.test_dir)
1575
os.chdir(self.test_dir)
1578
def build_tree(self, shape, line_endings='binary', transport=None):
1579
"""Build a test tree according to a pattern.
1581
shape is a sequence of file specifications. If the final
1582
character is '/', a directory is created.
1584
This assumes that all the elements in the tree being built are new.
1586
This doesn't add anything to a branch.
1587
:param line_endings: Either 'binary' or 'native'
1588
in binary mode, exact contents are written
1589
in native mode, the line endings match the
1590
default platform endings.
1592
:param transport: A transport to write to, for building trees on
1593
VFS's. If the transport is readonly or None,
1594
"." is opened automatically.
1596
# It's OK to just create them using forward slashes on windows.
1597
if transport is None or transport.is_readonly():
1598
transport = get_transport(".")
1600
self.assert_(isinstance(name, basestring))
1602
transport.mkdir(urlutils.escape(name[:-1]))
1604
if line_endings == 'binary':
1606
elif line_endings == 'native':
1609
raise errors.BzrError(
1610
'Invalid line ending request %r' % line_endings)
1611
content = "contents of %s%s" % (name.encode('utf-8'), end)
1612
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1614
def build_tree_contents(self, shape):
1615
build_tree_contents(shape)
1617
def assertFileEqual(self, content, path):
1618
"""Fail if path does not contain 'content'."""
1619
self.failUnlessExists(path)
1620
# TODO: jam 20060427 Shouldn't this be 'rb'?
1621
self.assertEqualDiff(content, open(path, 'r').read())
1623
def failUnlessExists(self, path):
1624
"""Fail unless path, which may be abs or relative, exists."""
1625
self.failUnless(osutils.lexists(path),path+" does not exist")
1627
def failIfExists(self, path):
1628
"""Fail if path, which may be abs or relative, exists."""
1629
self.failIf(osutils.lexists(path),path+" exists")
1632
class TestCaseWithTransport(TestCaseInTempDir):
1633
"""A test case that provides get_url and get_readonly_url facilities.
1635
These back onto two transport servers, one for readonly access and one for
1638
If no explicit class is provided for readonly access, a
1639
ReadonlyTransportDecorator is used instead which allows the use of non disk
1640
based read write transports.
1642
If an explicit class is provided for readonly access, that server and the
1643
readwrite one must both define get_url() as resolving to os.getcwd().
1646
def create_transport_server(self):
1647
"""Create a transport server from class defined at init.
1649
This is mostly a hook for daughter classes.
1651
return self.transport_server()
1653
def get_server(self):
1654
"""See TestCaseWithMemoryTransport.
1656
This is useful for some tests with specific servers that need
1659
if self.__server is None:
1660
self.__server = self.create_transport_server()
1661
self.__server.setUp()
1662
self.addCleanup(self.__server.tearDown)
1663
return self.__server
1665
def make_branch_and_tree(self, relpath, format=None):
1666
"""Create a branch on the transport and a tree locally.
1668
If the transport is not a LocalTransport, the Tree can't be created on
1669
the transport. In that case the working tree is created in the local
1670
directory, and the returned tree's branch and repository will also be
1673
This will fail if the original default transport for this test
1674
case wasn't backed by the working directory, as the branch won't
1675
be on disk for us to open it.
1677
:param format: The BzrDirFormat.
1678
:returns: the WorkingTree.
1680
# TODO: always use the local disk path for the working tree,
1681
# this obviously requires a format that supports branch references
1682
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1684
b = self.make_branch(relpath, format=format)
1686
return b.bzrdir.create_workingtree()
1687
except errors.NotLocalUrl:
1688
# We can only make working trees locally at the moment. If the
1689
# transport can't support them, then reopen the branch on a local
1690
# transport, and create the working tree there.
1692
# Possibly we should instead keep
1693
# the non-disk-backed branch and create a local checkout?
1694
bd = bzrdir.BzrDir.open(relpath)
1695
return bd.create_workingtree()
1697
def assertIsDirectory(self, relpath, transport):
1698
"""Assert that relpath within transport is a directory.
1700
This may not be possible on all transports; in that case it propagates
1701
a TransportNotPossible.
1704
mode = transport.stat(relpath).st_mode
1705
except errors.NoSuchFile:
1706
self.fail("path %s is not a directory; no such file"
1708
if not stat.S_ISDIR(mode):
1709
self.fail("path %s is not a directory; has mode %#o"
1713
super(TestCaseWithTransport, self).setUp()
1714
self.__server = None
1717
class ChrootedTestCase(TestCaseWithTransport):
1718
"""A support class that provides readonly urls outside the local namespace.
1720
This is done by checking if self.transport_server is a MemoryServer. if it
1721
is then we are chrooted already, if it is not then an HttpServer is used
1724
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1725
be used without needed to redo it when a different
1726
subclass is in use ?
1730
super(ChrootedTestCase, self).setUp()
1731
if not self.transport_server == MemoryServer:
1732
self.transport_readonly_server = HttpServer
1735
def filter_suite_by_re(suite, pattern):
1736
result = TestUtil.TestSuite()
1737
filter_re = re.compile(pattern)
1738
for test in iter_suite_tests(suite):
1739
if filter_re.search(test.id()):
1740
result.addTest(test)
1744
def sort_suite_by_re(suite, pattern):
1747
filter_re = re.compile(pattern)
1748
for test in iter_suite_tests(suite):
1749
if filter_re.search(test.id()):
1753
return TestUtil.TestSuite(first + second)
1756
def run_suite(suite, name='test', verbose=False, pattern=".*",
1757
stop_on_failure=False, keep_output=False,
1758
transport=None, lsprof_timed=None, bench_history=None,
1759
matching_tests_first=None,
1760
numbered_dirs=False):
1761
global NUMBERED_DIRS
1762
NUMBERED_DIRS = bool(numbered_dirs)
1764
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1769
runner = TextTestRunner(stream=sys.stdout,
1771
verbosity=verbosity,
1772
keep_output=keep_output,
1773
bench_history=bench_history)
1774
runner.stop_on_failure=stop_on_failure
1776
if matching_tests_first:
1777
suite = sort_suite_by_re(suite, pattern)
1779
suite = filter_suite_by_re(suite, pattern)
1780
result = runner.run(suite)
1781
return result.wasSuccessful()
1784
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1787
test_suite_factory=None,
1790
matching_tests_first=None,
1791
numbered_dirs=False):
1792
"""Run the whole test suite under the enhanced runner"""
1793
# XXX: Very ugly way to do this...
1794
# Disable warning about old formats because we don't want it to disturb
1795
# any blackbox tests.
1796
from bzrlib import repository
1797
repository._deprecation_warning_done = True
1799
global default_transport
1800
if transport is None:
1801
transport = default_transport
1802
old_transport = default_transport
1803
default_transport = transport
1805
if test_suite_factory is None:
1806
suite = test_suite()
1808
suite = test_suite_factory()
1809
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1810
stop_on_failure=stop_on_failure, keep_output=keep_output,
1811
transport=transport,
1812
lsprof_timed=lsprof_timed,
1813
bench_history=bench_history,
1814
matching_tests_first=matching_tests_first,
1815
numbered_dirs=numbered_dirs)
1817
default_transport = old_transport
1821
"""Build and return TestSuite for the whole of bzrlib.
1823
This function can be replaced if you need to change the default test
1824
suite on a global basis, but it is not encouraged.
1827
'bzrlib.tests.test_ancestry',
1828
'bzrlib.tests.test_annotate',
1829
'bzrlib.tests.test_api',
1830
'bzrlib.tests.test_atomicfile',
1831
'bzrlib.tests.test_bad_files',
1832
'bzrlib.tests.test_branch',
1833
'bzrlib.tests.test_bundle',
1834
'bzrlib.tests.test_bzrdir',
1835
'bzrlib.tests.test_cache_utf8',
1836
'bzrlib.tests.test_commands',
1837
'bzrlib.tests.test_commit',
1838
'bzrlib.tests.test_commit_merge',
1839
'bzrlib.tests.test_config',
1840
'bzrlib.tests.test_conflicts',
1841
'bzrlib.tests.test_decorators',
1842
'bzrlib.tests.test_delta',
1843
'bzrlib.tests.test_diff',
1844
'bzrlib.tests.test_doc_generate',
1845
'bzrlib.tests.test_errors',
1846
'bzrlib.tests.test_escaped_store',
1847
'bzrlib.tests.test_fetch',
1848
'bzrlib.tests.test_ftp_transport',
1849
'bzrlib.tests.test_generate_docs',
1850
'bzrlib.tests.test_generate_ids',
1851
'bzrlib.tests.test_globbing',
1852
'bzrlib.tests.test_gpg',
1853
'bzrlib.tests.test_graph',
1854
'bzrlib.tests.test_hashcache',
1855
'bzrlib.tests.test_http',
1856
'bzrlib.tests.test_http_response',
1857
'bzrlib.tests.test_https_ca_bundle',
1858
'bzrlib.tests.test_identitymap',
1859
'bzrlib.tests.test_ignores',
1860
'bzrlib.tests.test_inv',
1861
'bzrlib.tests.test_knit',
1862
'bzrlib.tests.test_lazy_import',
1863
'bzrlib.tests.test_lazy_regex',
1864
'bzrlib.tests.test_lockdir',
1865
'bzrlib.tests.test_lockable_files',
1866
'bzrlib.tests.test_log',
1867
'bzrlib.tests.test_memorytree',
1868
'bzrlib.tests.test_merge',
1869
'bzrlib.tests.test_merge3',
1870
'bzrlib.tests.test_merge_core',
1871
'bzrlib.tests.test_missing',
1872
'bzrlib.tests.test_msgeditor',
1873
'bzrlib.tests.test_nonascii',
1874
'bzrlib.tests.test_options',
1875
'bzrlib.tests.test_osutils',
1876
'bzrlib.tests.test_osutils_encodings',
1877
'bzrlib.tests.test_patch',
1878
'bzrlib.tests.test_patches',
1879
'bzrlib.tests.test_permissions',
1880
'bzrlib.tests.test_plugins',
1881
'bzrlib.tests.test_progress',
1882
'bzrlib.tests.test_reconcile',
1883
'bzrlib.tests.test_registry',
1884
'bzrlib.tests.test_repository',
1885
'bzrlib.tests.test_revert',
1886
'bzrlib.tests.test_revision',
1887
'bzrlib.tests.test_revisionnamespaces',
1888
'bzrlib.tests.test_revisiontree',
1889
'bzrlib.tests.test_rio',
1890
'bzrlib.tests.test_sampler',
1891
'bzrlib.tests.test_selftest',
1892
'bzrlib.tests.test_setup',
1893
'bzrlib.tests.test_sftp_transport',
1894
'bzrlib.tests.test_smart_add',
1895
'bzrlib.tests.test_smart_transport',
1896
'bzrlib.tests.test_source',
1897
'bzrlib.tests.test_status',
1898
'bzrlib.tests.test_store',
1899
'bzrlib.tests.test_symbol_versioning',
1900
'bzrlib.tests.test_tag',
1901
'bzrlib.tests.test_testament',
1902
'bzrlib.tests.test_textfile',
1903
'bzrlib.tests.test_textmerge',
1904
'bzrlib.tests.test_trace',
1905
'bzrlib.tests.test_transactions',
1906
'bzrlib.tests.test_transform',
1907
'bzrlib.tests.test_transport',
1908
'bzrlib.tests.test_tree',
1909
'bzrlib.tests.test_treebuilder',
1910
'bzrlib.tests.test_tsort',
1911
'bzrlib.tests.test_tuned_gzip',
1912
'bzrlib.tests.test_ui',
1913
'bzrlib.tests.test_upgrade',
1914
'bzrlib.tests.test_urlutils',
1915
'bzrlib.tests.test_versionedfile',
1916
'bzrlib.tests.test_version',
1917
'bzrlib.tests.test_version_info',
1918
'bzrlib.tests.test_weave',
1919
'bzrlib.tests.test_whitebox',
1920
'bzrlib.tests.test_workingtree',
1921
'bzrlib.tests.test_wsgi',
1922
'bzrlib.tests.test_xml',
1924
test_transport_implementations = [
1925
'bzrlib.tests.test_transport_implementations',
1926
'bzrlib.tests.test_read_bundle',
1928
suite = TestUtil.TestSuite()
1929
loader = TestUtil.TestLoader()
1930
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1931
from bzrlib.transport import TransportTestProviderAdapter
1932
adapter = TransportTestProviderAdapter()
1933
adapt_modules(test_transport_implementations, adapter, loader, suite)
1934
for package in packages_to_test():
1935
suite.addTest(package.test_suite())
1936
for m in MODULES_TO_TEST:
1937
suite.addTest(loader.loadTestsFromModule(m))
1938
for m in MODULES_TO_DOCTEST:
1940
suite.addTest(doctest.DocTestSuite(m))
1941
except ValueError, e:
1942
print '**failed to get doctest for: %s\n%s' %(m,e)
1944
for name, plugin in bzrlib.plugin.all_plugins().items():
1945
if getattr(plugin, 'test_suite', None) is not None:
1946
default_encoding = sys.getdefaultencoding()
1948
plugin_suite = plugin.test_suite()
1949
except ImportError, e:
1950
bzrlib.trace.warning(
1951
'Unable to test plugin "%s": %s', name, e)
1953
suite.addTest(plugin_suite)
1954
if default_encoding != sys.getdefaultencoding():
1955
bzrlib.trace.warning(
1956
'Plugin "%s" tried to reset default encoding to: %s', name,
1957
sys.getdefaultencoding())
1959
sys.setdefaultencoding(default_encoding)
1963
def adapt_modules(mods_list, adapter, loader, suite):
1964
"""Adapt the modules in mods_list using adapter and add to suite."""
1965
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1966
suite.addTests(adapter.adapt(test))
1969
def clean_selftest_output(root=None, quiet=False):
1970
"""Remove all selftest output directories from root directory.
1972
:param root: root directory for clean
1973
(if ommitted or None then clean current directory).
1974
:param quiet: suppress report about deleting directories
1979
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
1982
for i in os.listdir(root):
1983
if os.path.isdir(i) and re_dir.match(i):
1985
print 'delete directory:', i
added
removed
bzrlib/tests/__init__.py
