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
36
from pprint import pformat
40
from subprocess import Popen, PIPE
57
import bzrlib.commands
58
import bzrlib.bundle.serializer
60
import bzrlib.inventory
61
import bzrlib.iterablefile
66
# lsprof not available
68
from bzrlib.merge import merge_inner
72
from bzrlib.revision import common_ancestor
74
from bzrlib import symbol_versioning
76
from bzrlib.transport import get_transport
77
import bzrlib.transport
78
from bzrlib.transport.local import LocalURLServer
79
from bzrlib.transport.memory import MemoryServer
80
from bzrlib.transport.readonly import ReadonlyServer
81
from bzrlib.trace import mutter, note
82
from bzrlib.tests import TestUtil
83
from bzrlib.tests.HttpServer import HttpServer
84
from bzrlib.tests.TestUtil import (
88
from bzrlib.tests.treeshape import build_tree_contents
89
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
91
default_transport = LocalURLServer
94
MODULES_TO_DOCTEST = [
95
bzrlib.bundle.serializer,
106
NUMBERED_DIRS = False # dirs kind for TestCaseInTempDir (numbered or named)
109
def packages_to_test():
110
"""Return a list of packages to test.
112
The packages are not globally imported so that import failures are
113
triggered when running selftest, not when importing the command.
116
import bzrlib.tests.blackbox
117
import bzrlib.tests.branch_implementations
118
import bzrlib.tests.bzrdir_implementations
119
import bzrlib.tests.interrepository_implementations
120
import bzrlib.tests.interversionedfile_implementations
121
import bzrlib.tests.intertree_implementations
122
import bzrlib.tests.repository_implementations
123
import bzrlib.tests.revisionstore_implementations
124
import bzrlib.tests.tree_implementations
125
import bzrlib.tests.workingtree_implementations
128
bzrlib.tests.blackbox,
129
bzrlib.tests.branch_implementations,
130
bzrlib.tests.bzrdir_implementations,
131
bzrlib.tests.interrepository_implementations,
132
bzrlib.tests.interversionedfile_implementations,
133
bzrlib.tests.intertree_implementations,
134
bzrlib.tests.repository_implementations,
135
bzrlib.tests.revisionstore_implementations,
136
bzrlib.tests.tree_implementations,
137
bzrlib.tests.workingtree_implementations,
141
class ExtendedTestResult(unittest._TextTestResult):
142
"""Accepts, reports and accumulates the results of running tests.
144
Compared to this unittest version this class adds support for profiling,
145
benchmarking, stopping as soon as a test fails, and skipping tests.
146
There are further-specialized subclasses for different types of display.
151
def __init__(self, stream, descriptions, verbosity,
155
"""Construct new TestResult.
157
:param bench_history: Optionally, a writable file object to accumulate
160
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
161
if bench_history is not None:
162
from bzrlib.version import _get_bzr_source_tree
163
src_tree = _get_bzr_source_tree()
166
revision_id = src_tree.get_parent_ids()[0]
168
# XXX: if this is a brand new tree, do the same as if there
172
# XXX: If there's no branch, what should we do?
174
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
175
self._bench_history = bench_history
176
self.ui = bzrlib.ui.ui_factory
177
self.num_tests = num_tests
179
self.failure_count = 0
182
self._overall_start_time = time.time()
184
def extractBenchmarkTime(self, testCase):
185
"""Add a benchmark time for the current test case."""
186
self._benchmarkTime = getattr(testCase, "_benchtime", None)
188
def _elapsedTestTimeString(self):
189
"""Return a time string for the overall time the current test has taken."""
190
return self._formatTime(time.time() - self._start_time)
192
def _testTimeString(self):
193
if self._benchmarkTime is not None:
195
self._formatTime(self._benchmarkTime),
196
self._elapsedTestTimeString())
198
return " %s" % self._elapsedTestTimeString()
200
def _formatTime(self, seconds):
201
"""Format seconds as milliseconds with leading spaces."""
202
# some benchmarks can take thousands of seconds to run, so we need 8
204
return "%8dms" % (1000 * seconds)
206
def _shortened_test_description(self, test):
208
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
211
def startTest(self, test):
212
unittest.TestResult.startTest(self, test)
213
self.report_test_start(test)
214
test.number = self.count
215
self._recordTestStartTime()
217
def _recordTestStartTime(self):
218
"""Record that a test has started."""
219
self._start_time = time.time()
221
def addError(self, test, err):
222
if isinstance(err[1], TestSkipped):
223
return self.addSkipped(test, err)
224
unittest.TestResult.addError(self, test, err)
225
# We can only do this if we have one of our TestCases, not if
227
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
228
if setKeepLogfile is not None:
230
self.extractBenchmarkTime(test)
231
self.report_error(test, err)
235
def addFailure(self, test, err):
236
unittest.TestResult.addFailure(self, test, err)
237
# We can only do this if we have one of our TestCases, not if
239
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
240
if setKeepLogfile is not None:
242
self.extractBenchmarkTime(test)
243
self.report_failure(test, err)
247
def addSuccess(self, test):
248
self.extractBenchmarkTime(test)
249
if self._bench_history is not None:
250
if self._benchmarkTime is not None:
251
self._bench_history.write("%s %s\n" % (
252
self._formatTime(self._benchmarkTime),
254
self.report_success(test)
255
unittest.TestResult.addSuccess(self, test)
257
def addSkipped(self, test, skip_excinfo):
258
self.extractBenchmarkTime(test)
259
self.report_skip(test, skip_excinfo)
260
# seems best to treat this as success from point-of-view of unittest
261
# -- it actually does nothing so it barely matters :)
264
except KeyboardInterrupt:
267
self.addError(test, test.__exc_info())
269
unittest.TestResult.addSuccess(self, test)
271
def printErrorList(self, flavour, errors):
272
for test, err in errors:
273
self.stream.writeln(self.separator1)
274
self.stream.write("%s: " % flavour)
276
self.stream.write('#%d ' % test.number)
277
self.stream.writeln(self.getDescription(test))
278
if getattr(test, '_get_log', None) is not None:
280
print >>self.stream, \
281
('vvvv[log from %s]' % test.id()).ljust(78,'-')
282
print >>self.stream, test._get_log()
283
print >>self.stream, \
284
('^^^^[log from %s]' % test.id()).ljust(78,'-')
285
self.stream.writeln(self.separator2)
286
self.stream.writeln("%s" % err)
291
def report_cleaning_up(self):
294
def report_success(self, test):
298
class TextTestResult(ExtendedTestResult):
299
"""Displays progress and results of tests in text form"""
301
def __init__(self, *args, **kw):
302
ExtendedTestResult.__init__(self, *args, **kw)
303
self.pb = self.ui.nested_progress_bar()
304
self.pb.show_pct = False
305
self.pb.show_spinner = False
306
self.pb.show_eta = False,
307
self.pb.show_count = False
308
self.pb.show_bar = False
310
def report_starting(self):
311
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
313
def _progress_prefix_text(self):
314
a = '[%d' % self.count
315
if self.num_tests is not None:
316
a +='/%d' % self.num_tests
317
a += ' in %ds' % (time.time() - self._overall_start_time)
319
a += ', %d errors' % self.error_count
320
if self.failure_count:
321
a += ', %d failed' % self.failure_count
323
a += ', %d skipped' % self.skip_count
327
def report_test_start(self, test):
330
self._progress_prefix_text()
332
+ self._shortened_test_description(test))
334
def _test_description(self, test):
336
return '#%d %s' % (self.count,
337
self._shortened_test_description(test))
339
return self._shortened_test_description(test)
341
def report_error(self, test, err):
342
self.error_count += 1
343
self.pb.note('ERROR: %s\n %s\n',
344
self._test_description(test),
348
def report_failure(self, test, err):
349
self.failure_count += 1
350
self.pb.note('FAIL: %s\n %s\n',
351
self._test_description(test),
355
def report_skip(self, test, skip_excinfo):
358
# at the moment these are mostly not things we can fix
359
# and so they just produce stipple; use the verbose reporter
362
# show test and reason for skip
363
self.pb.note('SKIP: %s\n %s\n',
364
self._shortened_test_description(test),
367
# since the class name was left behind in the still-visible
369
self.pb.note('SKIP: %s', skip_excinfo[1])
371
def report_cleaning_up(self):
372
self.pb.update('cleaning up...')
378
class VerboseTestResult(ExtendedTestResult):
379
"""Produce long output, with one line per test run plus times"""
381
def _ellipsize_to_right(self, a_string, final_width):
382
"""Truncate and pad a string, keeping the right hand side"""
383
if len(a_string) > final_width:
384
result = '...' + a_string[3-final_width:]
387
return result.ljust(final_width)
389
def report_starting(self):
390
self.stream.write('running %d tests...\n' % self.num_tests)
392
def report_test_start(self, test):
394
name = self._shortened_test_description(test)
395
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
396
# numbers, plus a trailing blank
397
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
399
self.stream.write('%5d ' % self.count)
400
self.stream.write(self._ellipsize_to_right(name,
401
osutils.terminal_width()-36))
403
self.stream.write(self._ellipsize_to_right(name,
404
osutils.terminal_width()-30))
407
def _error_summary(self, err):
411
return '%s%s' % (indent, err[1])
413
def report_error(self, test, err):
414
self.error_count += 1
415
self.stream.writeln('ERROR %s\n%s'
416
% (self._testTimeString(),
417
self._error_summary(err)))
419
def report_failure(self, test, err):
420
self.failure_count += 1
421
self.stream.writeln(' FAIL %s\n%s'
422
% (self._testTimeString(),
423
self._error_summary(err)))
425
def report_success(self, test):
426
self.stream.writeln(' OK %s' % self._testTimeString())
427
for bench_called, stats in getattr(test, '_benchcalls', []):
428
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
429
stats.pprint(file=self.stream)
432
def report_skip(self, test, skip_excinfo):
434
self.stream.writeln(' SKIP %s\n%s'
435
% (self._testTimeString(),
436
self._error_summary(skip_excinfo)))
439
class TextTestRunner(object):
440
stop_on_failure = False
448
self.stream = unittest._WritelnDecorator(stream)
449
self.descriptions = descriptions
450
self.verbosity = verbosity
451
self.keep_output = keep_output
452
self._bench_history = bench_history
455
"Run the given test case or test suite."
456
startTime = time.time()
457
if self.verbosity == 1:
458
result_class = TextTestResult
459
elif self.verbosity >= 2:
460
result_class = VerboseTestResult
461
result = result_class(self.stream,
464
bench_history=self._bench_history,
465
num_tests=test.countTestCases(),
467
result.stop_early = self.stop_on_failure
468
result.report_starting()
470
stopTime = time.time()
471
timeTaken = stopTime - startTime
473
self.stream.writeln(result.separator2)
474
run = result.testsRun
475
self.stream.writeln("Ran %d test%s in %.3fs" %
476
(run, run != 1 and "s" or "", timeTaken))
477
self.stream.writeln()
478
if not result.wasSuccessful():
479
self.stream.write("FAILED (")
480
failed, errored = map(len, (result.failures, result.errors))
482
self.stream.write("failures=%d" % failed)
484
if failed: self.stream.write(", ")
485
self.stream.write("errors=%d" % errored)
486
self.stream.writeln(")")
488
self.stream.writeln("OK")
489
if result.skip_count > 0:
490
skipped = result.skip_count
491
self.stream.writeln('%d test%s skipped' %
492
(skipped, skipped != 1 and "s" or ""))
493
result.report_cleaning_up()
494
# This is still a little bogus,
495
# but only a little. Folk not using our testrunner will
496
# have to delete their temp directories themselves.
497
test_root = TestCaseWithMemoryTransport.TEST_ROOT
498
if result.wasSuccessful() or not self.keep_output:
499
if test_root is not None:
500
# If LANG=C we probably have created some bogus paths
501
# which rmtree(unicode) will fail to delete
502
# so make sure we are using rmtree(str) to delete everything
503
# except on win32, where rmtree(str) will fail
504
# since it doesn't have the property of byte-stream paths
505
# (they are either ascii or mbcs)
506
if sys.platform == 'win32':
507
# make sure we are using the unicode win32 api
508
test_root = unicode(test_root)
510
test_root = test_root.encode(
511
sys.getfilesystemencoding())
513
osutils.rmtree(test_root)
515
if sys.platform == 'win32' and e.errno == errno.EACCES:
516
print >>sys.stderr, ('Permission denied: '
517
'unable to remove testing dir '
518
'%s' % os.path.basename(test_root))
522
note("Failed tests working directories are in '%s'\n", test_root)
523
TestCaseWithMemoryTransport.TEST_ROOT = None
528
def iter_suite_tests(suite):
529
"""Return all tests in a suite, recursing through nested suites"""
530
for item in suite._tests:
531
if isinstance(item, unittest.TestCase):
533
elif isinstance(item, unittest.TestSuite):
534
for r in iter_suite_tests(item):
537
raise Exception('unknown object %r inside test suite %r'
541
class TestSkipped(Exception):
542
"""Indicates that a test was intentionally skipped, rather than failing."""
545
class CommandFailed(Exception):
549
class StringIOWrapper(object):
550
"""A wrapper around cStringIO which just adds an encoding attribute.
552
Internally we can check sys.stdout to see what the output encoding
553
should be. However, cStringIO has no encoding attribute that we can
554
set. So we wrap it instead.
559
def __init__(self, s=None):
561
self.__dict__['_cstring'] = StringIO(s)
563
self.__dict__['_cstring'] = StringIO()
565
def __getattr__(self, name, getattr=getattr):
566
return getattr(self.__dict__['_cstring'], name)
568
def __setattr__(self, name, val):
569
if name == 'encoding':
570
self.__dict__['encoding'] = val
572
return setattr(self._cstring, name, val)
575
class TestCase(unittest.TestCase):
576
"""Base class for bzr unit tests.
578
Tests that need access to disk resources should subclass
579
TestCaseInTempDir not TestCase.
581
Error and debug log messages are redirected from their usual
582
location into a temporary file, the contents of which can be
583
retrieved by _get_log(). We use a real OS file, not an in-memory object,
584
so that it can also capture file IO. When the test completes this file
585
is read into memory and removed from disk.
587
There are also convenience functions to invoke bzr's command-line
588
routine, and to build and check bzr trees.
590
In addition to the usual method of overriding tearDown(), this class also
591
allows subclasses to register functions into the _cleanups list, which is
592
run in order as the object is torn down. It's less likely this will be
593
accidentally overlooked.
596
_log_file_name = None
598
_keep_log_file = False
599
# record lsprof data when performing benchmark calls.
600
_gather_lsprof_in_benchmarks = False
602
def __init__(self, methodName='testMethod'):
603
super(TestCase, self).__init__(methodName)
607
unittest.TestCase.setUp(self)
608
self._cleanEnvironment()
609
bzrlib.trace.disable_default_logging()
612
self._benchcalls = []
613
self._benchtime = None
614
# prevent hooks affecting tests
615
self._preserved_hooks = bzrlib.branch.Branch.hooks
616
self.addCleanup(self._restoreHooks)
617
# this list of hooks must be kept in sync with the defaults
619
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
621
def _silenceUI(self):
622
"""Turn off UI for duration of test"""
623
# by default the UI is off; tests can turn it on if they want it.
624
saved = bzrlib.ui.ui_factory
626
bzrlib.ui.ui_factory = saved
627
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
628
self.addCleanup(_restore)
630
def _ndiff_strings(self, a, b):
631
"""Return ndiff between two strings containing lines.
633
A trailing newline is added if missing to make the strings
635
if b and b[-1] != '\n':
637
if a and a[-1] != '\n':
639
difflines = difflib.ndiff(a.splitlines(True),
641
linejunk=lambda x: False,
642
charjunk=lambda x: False)
643
return ''.join(difflines)
645
def assertEqual(self, a, b, message=''):
650
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
652
pformat(a, indent=4), pformat(b, indent=4)))
654
assertEquals = assertEqual
656
def assertEqualDiff(self, a, b, message=None):
657
"""Assert two texts are equal, if not raise an exception.
659
This is intended for use with multi-line strings where it can
660
be hard to find the differences by eye.
662
# TODO: perhaps override assertEquals to call this for strings?
666
message = "texts not equal:\n"
667
raise AssertionError(message +
668
self._ndiff_strings(a, b))
670
def assertEqualMode(self, mode, mode_test):
671
self.assertEqual(mode, mode_test,
672
'mode mismatch %o != %o' % (mode, mode_test))
674
def assertStartsWith(self, s, prefix):
675
if not s.startswith(prefix):
676
raise AssertionError('string %r does not start with %r' % (s, prefix))
678
def assertEndsWith(self, s, suffix):
679
"""Asserts that s ends with suffix."""
680
if not s.endswith(suffix):
681
raise AssertionError('string %r does not end with %r' % (s, suffix))
683
def assertContainsRe(self, haystack, needle_re):
684
"""Assert that a contains something matching a regular expression."""
685
if not re.search(needle_re, haystack):
686
raise AssertionError('pattern "%r" not found in "%r"'
687
% (needle_re, haystack))
689
def assertNotContainsRe(self, haystack, needle_re):
690
"""Assert that a does not match a regular expression"""
691
if re.search(needle_re, haystack):
692
raise AssertionError('pattern "%s" found in "%s"'
693
% (needle_re, haystack))
695
def assertSubset(self, sublist, superlist):
696
"""Assert that every entry in sublist is present in superlist."""
698
for entry in sublist:
699
if entry not in superlist:
700
missing.append(entry)
702
raise AssertionError("value(s) %r not present in container %r" %
703
(missing, superlist))
705
def assertListRaises(self, excClass, func, *args, **kwargs):
706
"""Fail unless excClass is raised when the iterator from func is used.
708
Many functions can return generators this makes sure
709
to wrap them in a list() call to make sure the whole generator
710
is run, and that the proper exception is raised.
713
list(func(*args, **kwargs))
717
if getattr(excClass,'__name__', None) is not None:
718
excName = excClass.__name__
720
excName = str(excClass)
721
raise self.failureException, "%s not raised" % excName
723
def assertIs(self, left, right, message=None):
724
if not (left is right):
725
if message is not None:
726
raise AssertionError(message)
728
raise AssertionError("%r is not %r." % (left, right))
730
def assertIsNot(self, left, right, message=None):
732
if message is not None:
733
raise AssertionError(message)
735
raise AssertionError("%r is %r." % (left, right))
737
def assertTransportMode(self, transport, path, mode):
738
"""Fail if a path does not have mode mode.
740
If modes are not supported on this transport, the assertion is ignored.
742
if not transport._can_roundtrip_unix_modebits():
744
path_stat = transport.stat(path)
745
actual_mode = stat.S_IMODE(path_stat.st_mode)
746
self.assertEqual(mode, actual_mode,
747
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
749
def assertIsInstance(self, obj, kls):
750
"""Fail if obj is not an instance of kls"""
751
if not isinstance(obj, kls):
752
self.fail("%r is an instance of %s rather than %s" % (
753
obj, obj.__class__, kls))
755
def _capture_warnings(self, a_callable, *args, **kwargs):
756
"""A helper for callDeprecated and applyDeprecated.
758
:param a_callable: A callable to call.
759
:param args: The positional arguments for the callable
760
:param kwargs: The keyword arguments for the callable
761
:return: A tuple (warnings, result). result is the result of calling
762
a_callable(*args, **kwargs).
765
def capture_warnings(msg, cls=None, stacklevel=None):
766
# we've hooked into a deprecation specific callpath,
767
# only deprecations should getting sent via it.
768
self.assertEqual(cls, DeprecationWarning)
769
local_warnings.append(msg)
770
original_warning_method = symbol_versioning.warn
771
symbol_versioning.set_warning_method(capture_warnings)
773
result = a_callable(*args, **kwargs)
775
symbol_versioning.set_warning_method(original_warning_method)
776
return (local_warnings, result)
778
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
779
"""Call a deprecated callable without warning the user.
781
:param deprecation_format: The deprecation format that the callable
782
should have been deprecated with. This is the same type as the
783
parameter to deprecated_method/deprecated_function. If the
784
callable is not deprecated with this format, an assertion error
786
:param a_callable: A callable to call. This may be a bound method or
787
a regular function. It will be called with *args and **kwargs.
788
:param args: The positional arguments for the callable
789
:param kwargs: The keyword arguments for the callable
790
:return: The result of a_callable(*args, **kwargs)
792
call_warnings, result = self._capture_warnings(a_callable,
794
expected_first_warning = symbol_versioning.deprecation_string(
795
a_callable, deprecation_format)
796
if len(call_warnings) == 0:
797
self.fail("No deprecation warning generated by call to %s" %
799
self.assertEqual(expected_first_warning, call_warnings[0])
802
def callDeprecated(self, expected, callable, *args, **kwargs):
803
"""Assert that a callable is deprecated in a particular way.
805
This is a very precise test for unusual requirements. The
806
applyDeprecated helper function is probably more suited for most tests
807
as it allows you to simply specify the deprecation format being used
808
and will ensure that that is issued for the function being called.
810
:param expected: a list of the deprecation warnings expected, in order
811
:param callable: The callable to call
812
:param args: The positional arguments for the callable
813
:param kwargs: The keyword arguments for the callable
815
call_warnings, result = self._capture_warnings(callable,
817
self.assertEqual(expected, call_warnings)
820
def _startLogFile(self):
821
"""Send bzr and test log messages to a temporary file.
823
The file is removed as the test is torn down.
825
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
826
self._log_file = os.fdopen(fileno, 'w+')
827
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
828
self._log_file_name = name
829
self.addCleanup(self._finishLogFile)
831
def _finishLogFile(self):
832
"""Finished with the log file.
834
Close the file and delete it, unless setKeepLogfile was called.
836
if self._log_file is None:
838
bzrlib.trace.disable_test_log(self._log_nonce)
839
self._log_file.close()
840
self._log_file = None
841
if not self._keep_log_file:
842
os.remove(self._log_file_name)
843
self._log_file_name = None
845
def setKeepLogfile(self):
846
"""Make the logfile not be deleted when _finishLogFile is called."""
847
self._keep_log_file = True
849
def addCleanup(self, callable):
850
"""Arrange to run a callable when this case is torn down.
852
Callables are run in the reverse of the order they are registered,
853
ie last-in first-out.
855
if callable in self._cleanups:
856
raise ValueError("cleanup function %r already registered on %s"
858
self._cleanups.append(callable)
860
def _cleanEnvironment(self):
862
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
864
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
866
'BZREMAIL': None, # may still be present in the environment
868
'BZR_PROGRESS_BAR': None,
878
# Nobody cares about these ones AFAIK. So far at
879
# least. If you do (care), please update this comment
885
self.addCleanup(self._restoreEnvironment)
886
for name, value in new_env.iteritems():
887
self._captureVar(name, value)
889
def _captureVar(self, name, newvalue):
890
"""Set an environment variable, and reset it when finished."""
891
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
893
def _restoreEnvironment(self):
894
for name, value in self.__old_env.iteritems():
895
osutils.set_or_unset_env(name, value)
897
def _restoreHooks(self):
898
bzrlib.branch.Branch.hooks = self._preserved_hooks
902
unittest.TestCase.tearDown(self)
904
def time(self, callable, *args, **kwargs):
905
"""Run callable and accrue the time it takes to the benchmark time.
907
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
908
this will cause lsprofile statistics to be gathered and stored in
911
if self._benchtime is None:
915
if not self._gather_lsprof_in_benchmarks:
916
return callable(*args, **kwargs)
918
# record this benchmark
919
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
921
self._benchcalls.append(((callable, args, kwargs), stats))
924
self._benchtime += time.time() - start
926
def _runCleanups(self):
927
"""Run registered cleanup functions.
929
This should only be called from TestCase.tearDown.
931
# TODO: Perhaps this should keep running cleanups even if
933
for cleanup_fn in reversed(self._cleanups):
936
def log(self, *args):
939
def _get_log(self, keep_log_file=False):
940
"""Return as a string the log for this test. If the file is still
941
on disk and keep_log_file=False, delete the log file and store the
942
content in self._log_contents."""
943
# flush the log file, to get all content
945
bzrlib.trace._trace_file.flush()
946
if self._log_contents:
947
return self._log_contents
948
if self._log_file_name is not None:
949
logfile = open(self._log_file_name)
951
log_contents = logfile.read()
954
if not keep_log_file:
955
self._log_contents = log_contents
957
os.remove(self._log_file_name)
959
if sys.platform == 'win32' and e.errno == errno.EACCES:
960
print >>sys.stderr, ('Unable to delete log file '
961
' %r' % self._log_file_name)
966
return "DELETED log file to reduce memory footprint"
968
def capture(self, cmd, retcode=0):
969
"""Shortcut that splits cmd into words, runs, and returns stdout"""
970
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
972
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
974
"""Invoke bzr and return (stdout, stderr).
976
Useful for code that wants to check the contents of the
977
output, the way error messages are presented, etc.
979
This should be the main method for tests that want to exercise the
980
overall behavior of the bzr application (rather than a unit test
981
or a functional test of the library.)
983
Much of the old code runs bzr by forking a new copy of Python, but
984
that is slower, harder to debug, and generally not necessary.
986
This runs bzr through the interface that catches and reports
987
errors, and with logging set to something approximating the
988
default, so that error reporting can be checked.
990
:param argv: arguments to invoke bzr
991
:param retcode: expected return code, or None for don't-care.
992
:param encoding: encoding for sys.stdout and sys.stderr
993
:param stdin: A string to be used as stdin for the command.
994
:param working_dir: Change to this directory before running
997
encoding = bzrlib.user_encoding
998
if stdin is not None:
999
stdin = StringIO(stdin)
1000
stdout = StringIOWrapper()
1001
stderr = StringIOWrapper()
1002
stdout.encoding = encoding
1003
stderr.encoding = encoding
1005
self.log('run bzr: %r', argv)
1006
# FIXME: don't call into logging here
1007
handler = logging.StreamHandler(stderr)
1008
handler.setLevel(logging.INFO)
1009
logger = logging.getLogger('')
1010
logger.addHandler(handler)
1011
old_ui_factory = bzrlib.ui.ui_factory
1012
bzrlib.ui.ui_factory = bzrlib.tests.blackbox.TestUIFactory(
1015
bzrlib.ui.ui_factory.stdin = stdin
1018
if working_dir is not None:
1019
cwd = osutils.getcwd()
1020
os.chdir(working_dir)
1023
saved_debug_flags = frozenset(debug.debug_flags)
1024
debug.debug_flags.clear()
1026
result = self.apply_redirected(stdin, stdout, stderr,
1027
bzrlib.commands.run_bzr_catch_errors,
1030
debug.debug_flags.update(saved_debug_flags)
1032
logger.removeHandler(handler)
1033
bzrlib.ui.ui_factory = old_ui_factory
1037
out = stdout.getvalue()
1038
err = stderr.getvalue()
1040
self.log('output:\n%r', out)
1042
self.log('errors:\n%r', err)
1043
if retcode is not None:
1044
self.assertEquals(retcode, result)
1047
def run_bzr(self, *args, **kwargs):
1048
"""Invoke bzr, as if it were run from the command line.
1050
This should be the main method for tests that want to exercise the
1051
overall behavior of the bzr application (rather than a unit test
1052
or a functional test of the library.)
1054
This sends the stdout/stderr results into the test's log,
1055
where it may be useful for debugging. See also run_captured.
1057
:param stdin: A string to be used as stdin for the command.
1058
:param retcode: The status code the command should return
1059
:param working_dir: The directory to run the command in
1061
retcode = kwargs.pop('retcode', 0)
1062
encoding = kwargs.pop('encoding', None)
1063
stdin = kwargs.pop('stdin', None)
1064
working_dir = kwargs.pop('working_dir', None)
1065
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding,
1066
stdin=stdin, working_dir=working_dir)
1068
def run_bzr_decode(self, *args, **kwargs):
1069
if 'encoding' in kwargs:
1070
encoding = kwargs['encoding']
1072
encoding = bzrlib.user_encoding
1073
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1075
def run_bzr_error(self, error_regexes, *args, **kwargs):
1076
"""Run bzr, and check that stderr contains the supplied regexes
1078
:param error_regexes: Sequence of regular expressions which
1079
must each be found in the error output. The relative ordering
1081
:param args: command-line arguments for bzr
1082
:param kwargs: Keyword arguments which are interpreted by run_bzr
1083
This function changes the default value of retcode to be 3,
1084
since in most cases this is run when you expect bzr to fail.
1085
:return: (out, err) The actual output of running the command (in case you
1086
want to do more inspection)
1089
# Make sure that commit is failing because there is nothing to do
1090
self.run_bzr_error(['no changes to commit'],
1091
'commit', '-m', 'my commit comment')
1092
# Make sure --strict is handling an unknown file, rather than
1093
# giving us the 'nothing to do' error
1094
self.build_tree(['unknown'])
1095
self.run_bzr_error(['Commit refused because there are unknown files'],
1096
'commit', '--strict', '-m', 'my commit comment')
1098
kwargs.setdefault('retcode', 3)
1099
out, err = self.run_bzr(*args, **kwargs)
1100
for regex in error_regexes:
1101
self.assertContainsRe(err, regex)
1104
def run_bzr_subprocess(self, *args, **kwargs):
1105
"""Run bzr in a subprocess for testing.
1107
This starts a new Python interpreter and runs bzr in there.
1108
This should only be used for tests that have a justifiable need for
1109
this isolation: e.g. they are testing startup time, or signal
1110
handling, or early startup code, etc. Subprocess code can't be
1111
profiled or debugged so easily.
1113
:param retcode: The status code that is expected. Defaults to 0. If
1114
None is supplied, the status code is not checked.
1115
:param env_changes: A dictionary which lists changes to environment
1116
variables. A value of None will unset the env variable.
1117
The values must be strings. The change will only occur in the
1118
child, so you don't need to fix the environment after running.
1119
:param universal_newlines: Convert CRLF => LF
1120
:param allow_plugins: By default the subprocess is run with
1121
--no-plugins to ensure test reproducibility. Also, it is possible
1122
for system-wide plugins to create unexpected output on stderr,
1123
which can cause unnecessary test failures.
1125
env_changes = kwargs.get('env_changes', {})
1126
working_dir = kwargs.get('working_dir', None)
1127
allow_plugins = kwargs.get('allow_plugins', False)
1128
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1129
working_dir=working_dir,
1130
allow_plugins=allow_plugins)
1131
# We distinguish between retcode=None and retcode not passed.
1132
supplied_retcode = kwargs.get('retcode', 0)
1133
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1134
universal_newlines=kwargs.get('universal_newlines', False),
1137
def start_bzr_subprocess(self, process_args, env_changes=None,
1138
skip_if_plan_to_signal=False,
1140
allow_plugins=False):
1141
"""Start bzr in a subprocess for testing.
1143
This starts a new Python interpreter and runs bzr in there.
1144
This should only be used for tests that have a justifiable need for
1145
this isolation: e.g. they are testing startup time, or signal
1146
handling, or early startup code, etc. Subprocess code can't be
1147
profiled or debugged so easily.
1149
:param process_args: a list of arguments to pass to the bzr executable,
1150
for example `['--version']`.
1151
:param env_changes: A dictionary which lists changes to environment
1152
variables. A value of None will unset the env variable.
1153
The values must be strings. The change will only occur in the
1154
child, so you don't need to fix the environment after running.
1155
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1157
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1159
:returns: Popen object for the started process.
1161
if skip_if_plan_to_signal:
1162
if not getattr(os, 'kill', None):
1163
raise TestSkipped("os.kill not available.")
1165
if env_changes is None:
1169
def cleanup_environment():
1170
for env_var, value in env_changes.iteritems():
1171
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1173
def restore_environment():
1174
for env_var, value in old_env.iteritems():
1175
osutils.set_or_unset_env(env_var, value)
1177
bzr_path = self.get_bzr_path()
1180
if working_dir is not None:
1181
cwd = osutils.getcwd()
1182
os.chdir(working_dir)
1185
# win32 subprocess doesn't support preexec_fn
1186
# so we will avoid using it on all platforms, just to
1187
# make sure the code path is used, and we don't break on win32
1188
cleanup_environment()
1189
command = [sys.executable, bzr_path]
1190
if not allow_plugins:
1191
command.append('--no-plugins')
1192
command.extend(process_args)
1193
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1195
restore_environment()
1201
def _popen(self, *args, **kwargs):
1202
"""Place a call to Popen.
1204
Allows tests to override this method to intercept the calls made to
1205
Popen for introspection.
1207
return Popen(*args, **kwargs)
1209
def get_bzr_path(self):
1210
"""Return the path of the 'bzr' executable for this test suite."""
1211
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1212
if not os.path.isfile(bzr_path):
1213
# We are probably installed. Assume sys.argv is the right file
1214
bzr_path = sys.argv[0]
1217
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1218
universal_newlines=False, process_args=None):
1219
"""Finish the execution of process.
1221
:param process: the Popen object returned from start_bzr_subprocess.
1222
:param retcode: The status code that is expected. Defaults to 0. If
1223
None is supplied, the status code is not checked.
1224
:param send_signal: an optional signal to send to the process.
1225
:param universal_newlines: Convert CRLF => LF
1226
:returns: (stdout, stderr)
1228
if send_signal is not None:
1229
os.kill(process.pid, send_signal)
1230
out, err = process.communicate()
1232
if universal_newlines:
1233
out = out.replace('\r\n', '\n')
1234
err = err.replace('\r\n', '\n')
1236
if retcode is not None and retcode != process.returncode:
1237
if process_args is None:
1238
process_args = "(unknown args)"
1239
mutter('Output of bzr %s:\n%s', process_args, out)
1240
mutter('Error for bzr %s:\n%s', process_args, err)
1241
self.fail('Command bzr %s failed with retcode %s != %s'
1242
% (process_args, retcode, process.returncode))
1245
def check_inventory_shape(self, inv, shape):
1246
"""Compare an inventory to a list of expected names.
1248
Fail if they are not precisely equal.
1251
shape = list(shape) # copy
1252
for path, ie in inv.entries():
1253
name = path.replace('\\', '/')
1254
if ie.kind == 'dir':
1261
self.fail("expected paths not found in inventory: %r" % shape)
1263
self.fail("unexpected paths found in inventory: %r" % extras)
1265
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1266
a_callable=None, *args, **kwargs):
1267
"""Call callable with redirected std io pipes.
1269
Returns the return code."""
1270
if not callable(a_callable):
1271
raise ValueError("a_callable must be callable.")
1273
stdin = StringIO("")
1275
if getattr(self, "_log_file", None) is not None:
1276
stdout = self._log_file
1280
if getattr(self, "_log_file", None is not None):
1281
stderr = self._log_file
1284
real_stdin = sys.stdin
1285
real_stdout = sys.stdout
1286
real_stderr = sys.stderr
1291
return a_callable(*args, **kwargs)
1293
sys.stdout = real_stdout
1294
sys.stderr = real_stderr
1295
sys.stdin = real_stdin
1297
@symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
1298
def merge(self, branch_from, wt_to):
1299
"""A helper for tests to do a ui-less merge.
1301
This should move to the main library when someone has time to integrate
1304
# minimal ui-less merge.
1305
wt_to.branch.fetch(branch_from)
1306
base_rev = common_ancestor(branch_from.last_revision(),
1307
wt_to.branch.last_revision(),
1308
wt_to.branch.repository)
1309
merge_inner(wt_to.branch, branch_from.basis_tree(),
1310
wt_to.branch.repository.revision_tree(base_rev),
1312
wt_to.add_parent_tree_id(branch_from.last_revision())
1315
BzrTestBase = TestCase
1318
class TestCaseWithMemoryTransport(TestCase):
1319
"""Common test class for tests that do not need disk resources.
1321
Tests that need disk resources should derive from TestCaseWithTransport.
1323
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1325
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1326
a directory which does not exist. This serves to help ensure test isolation
1327
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1328
must exist. However, TestCaseWithMemoryTransport does not offer local
1329
file defaults for the transport in tests, nor does it obey the command line
1330
override, so tests that accidentally write to the common directory should
1338
def __init__(self, methodName='runTest'):
1339
# allow test parameterisation after test construction and before test
1340
# execution. Variables that the parameteriser sets need to be
1341
# ones that are not set by setUp, or setUp will trash them.
1342
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1343
self.transport_server = default_transport
1344
self.transport_readonly_server = None
1346
def get_transport(self):
1347
"""Return a writeable transport for the test scratch space"""
1348
t = get_transport(self.get_url())
1349
self.assertFalse(t.is_readonly())
1352
def get_readonly_transport(self):
1353
"""Return a readonly transport for the test scratch space
1355
This can be used to test that operations which should only need
1356
readonly access in fact do not try to write.
1358
t = get_transport(self.get_readonly_url())
1359
self.assertTrue(t.is_readonly())
1362
def create_transport_readonly_server(self):
1363
"""Create a transport server from class defined at init.
1365
This is mostly a hook for daughter classes.
1367
return self.transport_readonly_server()
1369
def get_readonly_server(self):
1370
"""Get the server instance for the readonly transport
1372
This is useful for some tests with specific servers to do diagnostics.
1374
if self.__readonly_server is None:
1375
if self.transport_readonly_server is None:
1376
# readonly decorator requested
1377
# bring up the server
1379
self.__readonly_server = ReadonlyServer()
1380
self.__readonly_server.setUp(self.__server)
1382
self.__readonly_server = self.create_transport_readonly_server()
1383
self.__readonly_server.setUp()
1384
self.addCleanup(self.__readonly_server.tearDown)
1385
return self.__readonly_server
1387
def get_readonly_url(self, relpath=None):
1388
"""Get a URL for the readonly transport.
1390
This will either be backed by '.' or a decorator to the transport
1391
used by self.get_url()
1392
relpath provides for clients to get a path relative to the base url.
1393
These should only be downwards relative, not upwards.
1395
base = self.get_readonly_server().get_url()
1396
if relpath is not None:
1397
if not base.endswith('/'):
1399
base = base + relpath
1402
def get_server(self):
1403
"""Get the read/write server instance.
1405
This is useful for some tests with specific servers that need
1408
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1409
is no means to override it.
1411
if self.__server is None:
1412
self.__server = MemoryServer()
1413
self.__server.setUp()
1414
self.addCleanup(self.__server.tearDown)
1415
return self.__server
1417
def get_url(self, relpath=None):
1418
"""Get a URL (or maybe a path) for the readwrite transport.
1420
This will either be backed by '.' or to an equivalent non-file based
1422
relpath provides for clients to get a path relative to the base url.
1423
These should only be downwards relative, not upwards.
1425
base = self.get_server().get_url()
1426
if relpath is not None and relpath != '.':
1427
if not base.endswith('/'):
1429
# XXX: Really base should be a url; we did after all call
1430
# get_url()! But sometimes it's just a path (from
1431
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1432
# to a non-escaped local path.
1433
if base.startswith('./') or base.startswith('/'):
1436
base += urlutils.escape(relpath)
1439
def _make_test_root(self):
1440
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1444
root = u'test%04d.tmp' % i
1448
if e.errno == errno.EEXIST:
1453
# successfully created
1454
TestCaseWithMemoryTransport.TEST_ROOT = osutils.abspath(root)
1456
# make a fake bzr directory there to prevent any tests propagating
1457
# up onto the source directory's real branch
1458
bzrdir.BzrDir.create_standalone_workingtree(
1459
TestCaseWithMemoryTransport.TEST_ROOT)
1461
def makeAndChdirToTestDir(self):
1462
"""Create a temporary directories for this one test.
1464
This must set self.test_home_dir and self.test_dir and chdir to
1467
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1469
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1470
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1471
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1473
def make_branch(self, relpath, format=None):
1474
"""Create a branch on the transport at relpath."""
1475
repo = self.make_repository(relpath, format=format)
1476
return repo.bzrdir.create_branch()
1478
def make_bzrdir(self, relpath, format=None):
1480
# might be a relative or absolute path
1481
maybe_a_url = self.get_url(relpath)
1482
segments = maybe_a_url.rsplit('/', 1)
1483
t = get_transport(maybe_a_url)
1484
if len(segments) > 1 and segments[-1] not in ('', '.'):
1487
except errors.FileExists:
1491
if isinstance(format, basestring):
1492
format = bzrdir.format_registry.make_bzrdir(format)
1493
return format.initialize_on_transport(t)
1494
except errors.UninitializableFormat:
1495
raise TestSkipped("Format %s is not initializable." % format)
1497
def make_repository(self, relpath, shared=False, format=None):
1498
"""Create a repository on our default transport at relpath."""
1499
made_control = self.make_bzrdir(relpath, format=format)
1500
return made_control.create_repository(shared=shared)
1502
def make_branch_and_memory_tree(self, relpath, format=None):
1503
"""Create a branch on the default transport and a MemoryTree for it."""
1504
b = self.make_branch(relpath, format=format)
1505
return memorytree.MemoryTree.create_on_branch(b)
1507
def overrideEnvironmentForTesting(self):
1508
os.environ['HOME'] = self.test_home_dir
1509
os.environ['BZR_HOME'] = self.test_home_dir
1512
super(TestCaseWithMemoryTransport, self).setUp()
1513
self._make_test_root()
1514
_currentdir = os.getcwdu()
1515
def _leaveDirectory():
1516
os.chdir(_currentdir)
1517
self.addCleanup(_leaveDirectory)
1518
self.makeAndChdirToTestDir()
1519
self.overrideEnvironmentForTesting()
1520
self.__readonly_server = None
1521
self.__server = None
1524
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1525
"""Derived class that runs a test within a temporary directory.
1527
This is useful for tests that need to create a branch, etc.
1529
The directory is created in a slightly complex way: for each
1530
Python invocation, a new temporary top-level directory is created.
1531
All test cases create their own directory within that. If the
1532
tests complete successfully, the directory is removed.
1534
InTempDir is an old alias for FunctionalTestCase.
1537
OVERRIDE_PYTHON = 'python'
1539
def check_file_contents(self, filename, expect):
1540
self.log("check contents of file %s" % filename)
1541
contents = file(filename, 'r').read()
1542
if contents != expect:
1543
self.log("expected: %r" % expect)
1544
self.log("actually: %r" % contents)
1545
self.fail("contents of %s not as expected" % filename)
1547
def makeAndChdirToTestDir(self):
1548
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1550
For TestCaseInTempDir we create a temporary directory based on the test
1551
name and then create two subdirs - test and home under it.
1553
if NUMBERED_DIRS: # strongly recommended on Windows
1554
# due the path length limitation (260 chars)
1555
candidate_dir = '%s/%dK/%05d' % (self.TEST_ROOT,
1556
int(self.number/1000),
1558
os.makedirs(candidate_dir)
1559
self.test_home_dir = candidate_dir + '/home'
1560
os.mkdir(self.test_home_dir)
1561
self.test_dir = candidate_dir + '/work'
1562
os.mkdir(self.test_dir)
1563
os.chdir(self.test_dir)
1564
# put name of test inside
1565
f = file(candidate_dir + '/name', 'w')
1570
# shorten the name, to avoid test failures due to path length
1571
short_id = self.id().replace('bzrlib.tests.', '') \
1572
.replace('__main__.', '')[-100:]
1573
# it's possible the same test class is run several times for
1574
# parameterized tests, so make sure the names don't collide.
1578
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1580
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1581
if os.path.exists(candidate_dir):
1585
os.mkdir(candidate_dir)
1586
self.test_home_dir = candidate_dir + '/home'
1587
os.mkdir(self.test_home_dir)
1588
self.test_dir = candidate_dir + '/work'
1589
os.mkdir(self.test_dir)
1590
os.chdir(self.test_dir)
1593
def build_tree(self, shape, line_endings='binary', transport=None):
1594
"""Build a test tree according to a pattern.
1596
shape is a sequence of file specifications. If the final
1597
character is '/', a directory is created.
1599
This assumes that all the elements in the tree being built are new.
1601
This doesn't add anything to a branch.
1602
:param line_endings: Either 'binary' or 'native'
1603
in binary mode, exact contents are written
1604
in native mode, the line endings match the
1605
default platform endings.
1607
:param transport: A transport to write to, for building trees on
1608
VFS's. If the transport is readonly or None,
1609
"." is opened automatically.
1611
# It's OK to just create them using forward slashes on windows.
1612
if transport is None or transport.is_readonly():
1613
transport = get_transport(".")
1615
self.assert_(isinstance(name, basestring))
1617
transport.mkdir(urlutils.escape(name[:-1]))
1619
if line_endings == 'binary':
1621
elif line_endings == 'native':
1624
raise errors.BzrError(
1625
'Invalid line ending request %r' % line_endings)
1626
content = "contents of %s%s" % (name.encode('utf-8'), end)
1627
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1629
def build_tree_contents(self, shape):
1630
build_tree_contents(shape)
1632
def assertFileEqual(self, content, path):
1633
"""Fail if path does not contain 'content'."""
1634
self.failUnlessExists(path)
1635
# TODO: jam 20060427 Shouldn't this be 'rb'?
1639
self.assertEqualDiff(content, s)
1641
def failUnlessExists(self, path):
1642
"""Fail unless path, which may be abs or relative, exists."""
1643
self.failUnless(osutils.lexists(path),path+" does not exist")
1645
def failIfExists(self, path):
1646
"""Fail if path, which may be abs or relative, exists."""
1647
self.failIf(osutils.lexists(path),path+" exists")
1650
class TestCaseWithTransport(TestCaseInTempDir):
1651
"""A test case that provides get_url and get_readonly_url facilities.
1653
These back onto two transport servers, one for readonly access and one for
1656
If no explicit class is provided for readonly access, a
1657
ReadonlyTransportDecorator is used instead which allows the use of non disk
1658
based read write transports.
1660
If an explicit class is provided for readonly access, that server and the
1661
readwrite one must both define get_url() as resolving to os.getcwd().
1664
def create_transport_server(self):
1665
"""Create a transport server from class defined at init.
1667
This is mostly a hook for daughter classes.
1669
return self.transport_server()
1671
def get_server(self):
1672
"""See TestCaseWithMemoryTransport.
1674
This is useful for some tests with specific servers that need
1677
if self.__server is None:
1678
self.__server = self.create_transport_server()
1679
self.__server.setUp()
1680
self.addCleanup(self.__server.tearDown)
1681
return self.__server
1683
def make_branch_and_tree(self, relpath, format=None):
1684
"""Create a branch on the transport and a tree locally.
1686
If the transport is not a LocalTransport, the Tree can't be created on
1687
the transport. In that case the working tree is created in the local
1688
directory, and the returned tree's branch and repository will also be
1691
This will fail if the original default transport for this test
1692
case wasn't backed by the working directory, as the branch won't
1693
be on disk for us to open it.
1695
:param format: The BzrDirFormat.
1696
:returns: the WorkingTree.
1698
# TODO: always use the local disk path for the working tree,
1699
# this obviously requires a format that supports branch references
1700
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1702
b = self.make_branch(relpath, format=format)
1704
return b.bzrdir.create_workingtree()
1705
except errors.NotLocalUrl:
1706
# We can only make working trees locally at the moment. If the
1707
# transport can't support them, then reopen the branch on a local
1708
# transport, and create the working tree there.
1710
# Possibly we should instead keep
1711
# the non-disk-backed branch and create a local checkout?
1712
bd = bzrdir.BzrDir.open(relpath)
1713
return bd.create_workingtree()
1715
def assertIsDirectory(self, relpath, transport):
1716
"""Assert that relpath within transport is a directory.
1718
This may not be possible on all transports; in that case it propagates
1719
a TransportNotPossible.
1722
mode = transport.stat(relpath).st_mode
1723
except errors.NoSuchFile:
1724
self.fail("path %s is not a directory; no such file"
1726
if not stat.S_ISDIR(mode):
1727
self.fail("path %s is not a directory; has mode %#o"
1730
def assertTreesEqual(self, left, right):
1731
"""Check that left and right have the same content and properties."""
1732
# we use a tree delta to check for equality of the content, and we
1733
# manually check for equality of other things such as the parents list.
1734
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
1735
differences = left.changes_from(right)
1736
self.assertFalse(differences.has_changed(),
1737
"Trees %r and %r are different: %r" % (left, right, differences))
1740
super(TestCaseWithTransport, self).setUp()
1741
self.__server = None
1744
class ChrootedTestCase(TestCaseWithTransport):
1745
"""A support class that provides readonly urls outside the local namespace.
1747
This is done by checking if self.transport_server is a MemoryServer. if it
1748
is then we are chrooted already, if it is not then an HttpServer is used
1751
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1752
be used without needed to redo it when a different
1753
subclass is in use ?
1757
super(ChrootedTestCase, self).setUp()
1758
if not self.transport_server == MemoryServer:
1759
self.transport_readonly_server = HttpServer
1762
def filter_suite_by_re(suite, pattern):
1763
result = TestUtil.TestSuite()
1764
filter_re = re.compile(pattern)
1765
for test in iter_suite_tests(suite):
1766
if filter_re.search(test.id()):
1767
result.addTest(test)
1771
def sort_suite_by_re(suite, pattern):
1774
filter_re = re.compile(pattern)
1775
for test in iter_suite_tests(suite):
1776
if filter_re.search(test.id()):
1780
return TestUtil.TestSuite(first + second)
1783
def run_suite(suite, name='test', verbose=False, pattern=".*",
1784
stop_on_failure=False, keep_output=False,
1785
transport=None, lsprof_timed=None, bench_history=None,
1786
matching_tests_first=None,
1787
numbered_dirs=None):
1788
global NUMBERED_DIRS
1789
if numbered_dirs is not None:
1790
NUMBERED_DIRS = bool(numbered_dirs)
1792
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1797
runner = TextTestRunner(stream=sys.stdout,
1799
verbosity=verbosity,
1800
keep_output=keep_output,
1801
bench_history=bench_history)
1802
runner.stop_on_failure=stop_on_failure
1804
if matching_tests_first:
1805
suite = sort_suite_by_re(suite, pattern)
1807
suite = filter_suite_by_re(suite, pattern)
1808
result = runner.run(suite)
1809
return result.wasSuccessful()
1812
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1815
test_suite_factory=None,
1818
matching_tests_first=None,
1819
numbered_dirs=None):
1820
"""Run the whole test suite under the enhanced runner"""
1821
# XXX: Very ugly way to do this...
1822
# Disable warning about old formats because we don't want it to disturb
1823
# any blackbox tests.
1824
from bzrlib import repository
1825
repository._deprecation_warning_done = True
1827
global default_transport
1828
if transport is None:
1829
transport = default_transport
1830
old_transport = default_transport
1831
default_transport = transport
1833
if test_suite_factory is None:
1834
suite = test_suite()
1836
suite = test_suite_factory()
1837
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1838
stop_on_failure=stop_on_failure, keep_output=keep_output,
1839
transport=transport,
1840
lsprof_timed=lsprof_timed,
1841
bench_history=bench_history,
1842
matching_tests_first=matching_tests_first,
1843
numbered_dirs=numbered_dirs)
1845
default_transport = old_transport
1849
"""Build and return TestSuite for the whole of bzrlib.
1851
This function can be replaced if you need to change the default test
1852
suite on a global basis, but it is not encouraged.
1855
'bzrlib.tests.test_ancestry',
1856
'bzrlib.tests.test_annotate',
1857
'bzrlib.tests.test_api',
1858
'bzrlib.tests.test_atomicfile',
1859
'bzrlib.tests.test_bad_files',
1860
'bzrlib.tests.test_branch',
1861
'bzrlib.tests.test_bundle',
1862
'bzrlib.tests.test_bzrdir',
1863
'bzrlib.tests.test_cache_utf8',
1864
'bzrlib.tests.test_commands',
1865
'bzrlib.tests.test_commit',
1866
'bzrlib.tests.test_commit_merge',
1867
'bzrlib.tests.test_config',
1868
'bzrlib.tests.test_conflicts',
1869
'bzrlib.tests.test_decorators',
1870
'bzrlib.tests.test_delta',
1871
'bzrlib.tests.test_diff',
1872
'bzrlib.tests.test_dirstate',
1873
'bzrlib.tests.test_doc_generate',
1874
'bzrlib.tests.test_errors',
1875
'bzrlib.tests.test_escaped_store',
1876
'bzrlib.tests.test_extract',
1877
'bzrlib.tests.test_fetch',
1878
'bzrlib.tests.test_ftp_transport',
1879
'bzrlib.tests.test_generate_docs',
1880
'bzrlib.tests.test_generate_ids',
1881
'bzrlib.tests.test_globbing',
1882
'bzrlib.tests.test_gpg',
1883
'bzrlib.tests.test_graph',
1884
'bzrlib.tests.test_hashcache',
1885
'bzrlib.tests.test_http',
1886
'bzrlib.tests.test_http_response',
1887
'bzrlib.tests.test_https_ca_bundle',
1888
'bzrlib.tests.test_identitymap',
1889
'bzrlib.tests.test_ignores',
1890
'bzrlib.tests.test_inv',
1891
'bzrlib.tests.test_knit',
1892
'bzrlib.tests.test_lazy_import',
1893
'bzrlib.tests.test_lazy_regex',
1894
'bzrlib.tests.test_lockdir',
1895
'bzrlib.tests.test_lockable_files',
1896
'bzrlib.tests.test_log',
1897
'bzrlib.tests.test_memorytree',
1898
'bzrlib.tests.test_merge',
1899
'bzrlib.tests.test_merge3',
1900
'bzrlib.tests.test_merge_core',
1901
'bzrlib.tests.test_missing',
1902
'bzrlib.tests.test_msgeditor',
1903
'bzrlib.tests.test_nonascii',
1904
'bzrlib.tests.test_options',
1905
'bzrlib.tests.test_osutils',
1906
'bzrlib.tests.test_osutils_encodings',
1907
'bzrlib.tests.test_patch',
1908
'bzrlib.tests.test_patches',
1909
'bzrlib.tests.test_permissions',
1910
'bzrlib.tests.test_plugins',
1911
'bzrlib.tests.test_progress',
1912
'bzrlib.tests.test_reconcile',
1913
'bzrlib.tests.test_registry',
1914
'bzrlib.tests.test_repository',
1915
'bzrlib.tests.test_revert',
1916
'bzrlib.tests.test_revision',
1917
'bzrlib.tests.test_revisionnamespaces',
1918
'bzrlib.tests.test_revisiontree',
1919
'bzrlib.tests.test_rio',
1920
'bzrlib.tests.test_sampler',
1921
'bzrlib.tests.test_selftest',
1922
'bzrlib.tests.test_setup',
1923
'bzrlib.tests.test_sftp_transport',
1924
'bzrlib.tests.test_smart_add',
1925
'bzrlib.tests.test_smart_transport',
1926
'bzrlib.tests.test_source',
1927
'bzrlib.tests.test_status',
1928
'bzrlib.tests.test_store',
1929
'bzrlib.tests.test_subsume',
1930
'bzrlib.tests.test_symbol_versioning',
1931
'bzrlib.tests.test_tag',
1932
'bzrlib.tests.test_testament',
1933
'bzrlib.tests.test_textfile',
1934
'bzrlib.tests.test_textmerge',
1935
'bzrlib.tests.test_trace',
1936
'bzrlib.tests.test_transactions',
1937
'bzrlib.tests.test_transform',
1938
'bzrlib.tests.test_transport',
1939
'bzrlib.tests.test_tree',
1940
'bzrlib.tests.test_treebuilder',
1941
'bzrlib.tests.test_tsort',
1942
'bzrlib.tests.test_tuned_gzip',
1943
'bzrlib.tests.test_ui',
1944
'bzrlib.tests.test_upgrade',
1945
'bzrlib.tests.test_urlutils',
1946
'bzrlib.tests.test_versionedfile',
1947
'bzrlib.tests.test_version',
1948
'bzrlib.tests.test_version_info',
1949
'bzrlib.tests.test_weave',
1950
'bzrlib.tests.test_whitebox',
1951
'bzrlib.tests.test_workingtree',
1952
'bzrlib.tests.test_workingtree_4',
1953
'bzrlib.tests.test_wsgi',
1954
'bzrlib.tests.test_xml',
1956
test_transport_implementations = [
1957
'bzrlib.tests.test_transport_implementations',
1958
'bzrlib.tests.test_read_bundle',
1960
suite = TestUtil.TestSuite()
1961
loader = TestUtil.TestLoader()
1962
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1963
from bzrlib.transport import TransportTestProviderAdapter
1964
adapter = TransportTestProviderAdapter()
1965
adapt_modules(test_transport_implementations, adapter, loader, suite)
1966
for package in packages_to_test():
1967
suite.addTest(package.test_suite())
1968
for m in MODULES_TO_TEST:
1969
suite.addTest(loader.loadTestsFromModule(m))
1970
for m in MODULES_TO_DOCTEST:
1972
suite.addTest(doctest.DocTestSuite(m))
1973
except ValueError, e:
1974
print '**failed to get doctest for: %s\n%s' %(m,e)
1976
for name, plugin in bzrlib.plugin.all_plugins().items():
1977
if getattr(plugin, 'test_suite', None) is not None:
1978
default_encoding = sys.getdefaultencoding()
1980
plugin_suite = plugin.test_suite()
1981
except ImportError, e:
1982
bzrlib.trace.warning(
1983
'Unable to test plugin "%s": %s', name, e)
1985
suite.addTest(plugin_suite)
1986
if default_encoding != sys.getdefaultencoding():
1987
bzrlib.trace.warning(
1988
'Plugin "%s" tried to reset default encoding to: %s', name,
1989
sys.getdefaultencoding())
1991
sys.setdefaultencoding(default_encoding)
1995
def adapt_modules(mods_list, adapter, loader, suite):
1996
"""Adapt the modules in mods_list using adapter and add to suite."""
1997
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1998
suite.addTests(adapter.adapt(test))
2001
def clean_selftest_output(root=None, quiet=False):
2002
"""Remove all selftest output directories from root directory.
2004
:param root: root directory for clean
2005
(if ommitted or None then clean current directory).
2006
:param quiet: suppress report about deleting directories
2011
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
2014
for i in os.listdir(root):
2015
if os.path.isdir(i) and re_dir.match(i):
2017
print 'delete directory:', i
added
removed
bzrlib/tests/__init__.py
