1
# Copyright (C) 2005, 2006 by 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
47
import bzrlib.bzrdir as bzrdir
48
import bzrlib.commands
49
import bzrlib.bundle.serializer
50
import bzrlib.errors as errors
51
import bzrlib.inventory
52
import bzrlib.iterablefile
57
# lsprof not available
59
from bzrlib.merge import merge_inner
62
import bzrlib.osutils as osutils
64
import bzrlib.progress as progress
65
from bzrlib.revision import common_ancestor
67
from bzrlib import symbol_versioning
69
from bzrlib.transport import get_transport
70
import bzrlib.transport
71
from bzrlib.transport.local import LocalRelpathServer
72
from bzrlib.transport.readonly import ReadonlyServer
73
from bzrlib.trace import mutter
74
from bzrlib.tests import TestUtil
75
from bzrlib.tests.TestUtil import (
79
from bzrlib.tests.treeshape import build_tree_contents
80
import bzrlib.urlutils as urlutils
81
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
83
default_transport = LocalRelpathServer
86
MODULES_TO_DOCTEST = [
88
bzrlib.bundle.serializer,
102
def packages_to_test():
103
"""Return a list of packages to test.
105
The packages are not globally imported so that import failures are
106
triggered when running selftest, not when importing the command.
109
import bzrlib.tests.blackbox
110
import bzrlib.tests.branch_implementations
111
import bzrlib.tests.bzrdir_implementations
112
import bzrlib.tests.interrepository_implementations
113
import bzrlib.tests.interversionedfile_implementations
114
import bzrlib.tests.intertree_implementations
115
import bzrlib.tests.repository_implementations
116
import bzrlib.tests.revisionstore_implementations
117
import bzrlib.tests.tree_implementations
118
import bzrlib.tests.workingtree_implementations
121
bzrlib.tests.blackbox,
122
bzrlib.tests.branch_implementations,
123
bzrlib.tests.bzrdir_implementations,
124
bzrlib.tests.interrepository_implementations,
125
bzrlib.tests.interversionedfile_implementations,
126
bzrlib.tests.intertree_implementations,
127
bzrlib.tests.repository_implementations,
128
bzrlib.tests.revisionstore_implementations,
129
bzrlib.tests.tree_implementations,
130
bzrlib.tests.workingtree_implementations,
134
class _MyResult(unittest._TextTestResult):
135
"""Custom TestResult.
137
Shows output in a different format, including displaying runtime for tests.
141
def __init__(self, stream, descriptions, verbosity, pb=None,
143
"""Construct new TestResult.
145
:param bench_history: Optionally, a writable file object to accumulate
148
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
150
if bench_history is not None:
151
from bzrlib.version import _get_bzr_source_tree
152
src_tree = _get_bzr_source_tree()
155
revision_id = src_tree.get_parent_ids()[0]
157
# XXX: if this is a brand new tree, do the same as if there
161
# XXX: If there's no branch, what should we do?
163
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
164
self._bench_history = bench_history
166
def extractBenchmarkTime(self, testCase):
167
"""Add a benchmark time for the current test case."""
168
self._benchmarkTime = getattr(testCase, "_benchtime", None)
170
def _elapsedTestTimeString(self):
171
"""Return a time string for the overall time the current test has taken."""
172
return self._formatTime(time.time() - self._start_time)
174
def _testTimeString(self):
175
if self._benchmarkTime is not None:
177
self._formatTime(self._benchmarkTime),
178
self._elapsedTestTimeString())
180
return " %s" % self._elapsedTestTimeString()
182
def _formatTime(self, seconds):
183
"""Format seconds as milliseconds with leading spaces."""
184
return "%5dms" % (1000 * seconds)
186
def _ellipsise_unimportant_words(self, a_string, final_width,
188
"""Add ellipses (sp?) for overly long strings.
190
:param keep_start: If true preserve the start of a_string rather
194
if len(a_string) > final_width:
195
result = a_string[:final_width-3] + '...'
199
if len(a_string) > final_width:
200
result = '...' + a_string[3-final_width:]
203
return result.ljust(final_width)
205
def startTest(self, test):
206
unittest.TestResult.startTest(self, test)
207
# In a short description, the important words are in
208
# the beginning, but in an id, the important words are
210
SHOW_DESCRIPTIONS = False
212
if not self.showAll and self.dots and self.pb is not None:
215
final_width = osutils.terminal_width()
216
final_width = final_width - 15 - 8
218
if SHOW_DESCRIPTIONS:
219
what = test.shortDescription()
221
what = self._ellipsise_unimportant_words(what, final_width, keep_start=True)
224
if what.startswith('bzrlib.tests.'):
226
what = self._ellipsise_unimportant_words(what, final_width)
228
self.stream.write(what)
229
elif self.dots and self.pb is not None:
230
self.pb.update(what, self.testsRun - 1, None)
232
self._recordTestStartTime()
234
def _recordTestStartTime(self):
235
"""Record that a test has started."""
236
self._start_time = time.time()
238
def addError(self, test, err):
239
if isinstance(err[1], TestSkipped):
240
return self.addSkipped(test, err)
241
unittest.TestResult.addError(self, test, err)
242
self.extractBenchmarkTime(test)
244
self.stream.writeln("ERROR %s" % self._testTimeString())
245
elif self.dots and self.pb is None:
246
self.stream.write('E')
248
self.pb.update(self._ellipsise_unimportant_words('ERROR', 13), self.testsRun, None)
249
self.pb.note(self._ellipsise_unimportant_words(
250
test.id() + ': ERROR',
251
osutils.terminal_width()))
256
def addFailure(self, test, err):
257
unittest.TestResult.addFailure(self, test, err)
258
self.extractBenchmarkTime(test)
260
self.stream.writeln(" FAIL %s" % self._testTimeString())
261
elif self.dots and self.pb is None:
262
self.stream.write('F')
264
self.pb.update(self._ellipsise_unimportant_words('FAIL', 13), self.testsRun, None)
265
self.pb.note(self._ellipsise_unimportant_words(
266
test.id() + ': FAIL',
267
osutils.terminal_width()))
272
def addSuccess(self, test):
273
self.extractBenchmarkTime(test)
274
if self._bench_history is not None:
275
if self._benchmarkTime is not None:
276
self._bench_history.write("%s %s\n" % (
277
self._formatTime(self._benchmarkTime),
280
self.stream.writeln(' OK %s' % self._testTimeString())
281
for bench_called, stats in getattr(test, '_benchcalls', []):
282
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
283
stats.pprint(file=self.stream)
284
elif self.dots and self.pb is None:
285
self.stream.write('~')
287
self.pb.update(self._ellipsise_unimportant_words('OK', 13), self.testsRun, None)
289
unittest.TestResult.addSuccess(self, test)
291
def addSkipped(self, test, skip_excinfo):
292
self.extractBenchmarkTime(test)
294
print >>self.stream, ' SKIP %s' % self._testTimeString()
295
print >>self.stream, ' %s' % skip_excinfo[1]
296
elif self.dots and self.pb is None:
297
self.stream.write('S')
299
self.pb.update(self._ellipsise_unimportant_words('SKIP', 13), self.testsRun, None)
301
# seems best to treat this as success from point-of-view of unittest
302
# -- it actually does nothing so it barely matters :)
305
except KeyboardInterrupt:
308
self.addError(test, test.__exc_info())
310
unittest.TestResult.addSuccess(self, test)
312
def printErrorList(self, flavour, errors):
313
for test, err in errors:
314
self.stream.writeln(self.separator1)
315
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
316
if getattr(test, '_get_log', None) is not None:
318
print >>self.stream, \
319
('vvvv[log from %s]' % test.id()).ljust(78,'-')
320
print >>self.stream, test._get_log()
321
print >>self.stream, \
322
('^^^^[log from %s]' % test.id()).ljust(78,'-')
323
self.stream.writeln(self.separator2)
324
self.stream.writeln("%s" % err)
327
class TextTestRunner(object):
328
stop_on_failure = False
337
self.stream = unittest._WritelnDecorator(stream)
338
self.descriptions = descriptions
339
self.verbosity = verbosity
340
self.keep_output = keep_output
342
self._bench_history = bench_history
344
def _makeResult(self):
345
result = _MyResult(self.stream,
349
bench_history=self._bench_history)
350
result.stop_early = self.stop_on_failure
354
"Run the given test case or test suite."
355
result = self._makeResult()
356
startTime = time.time()
357
if self.pb is not None:
358
self.pb.update('Running tests', 0, test.countTestCases())
360
stopTime = time.time()
361
timeTaken = stopTime - startTime
363
self.stream.writeln(result.separator2)
364
run = result.testsRun
365
self.stream.writeln("Ran %d test%s in %.3fs" %
366
(run, run != 1 and "s" or "", timeTaken))
367
self.stream.writeln()
368
if not result.wasSuccessful():
369
self.stream.write("FAILED (")
370
failed, errored = map(len, (result.failures, result.errors))
372
self.stream.write("failures=%d" % failed)
374
if failed: self.stream.write(", ")
375
self.stream.write("errors=%d" % errored)
376
self.stream.writeln(")")
378
self.stream.writeln("OK")
379
if self.pb is not None:
380
self.pb.update('Cleaning up', 0, 1)
381
# This is still a little bogus,
382
# but only a little. Folk not using our testrunner will
383
# have to delete their temp directories themselves.
384
test_root = TestCaseInTempDir.TEST_ROOT
385
if result.wasSuccessful() or not self.keep_output:
386
if test_root is not None:
387
# If LANG=C we probably have created some bogus paths
388
# which rmtree(unicode) will fail to delete
389
# so make sure we are using rmtree(str) to delete everything
390
# except on win32, where rmtree(str) will fail
391
# since it doesn't have the property of byte-stream paths
392
# (they are either ascii or mbcs)
393
if sys.platform == 'win32':
394
# make sure we are using the unicode win32 api
395
test_root = unicode(test_root)
397
test_root = test_root.encode(
398
sys.getfilesystemencoding())
399
osutils.rmtree(test_root)
401
if self.pb is not None:
402
self.pb.note("Failed tests working directories are in '%s'\n",
406
"Failed tests working directories are in '%s'\n" %
408
TestCaseInTempDir.TEST_ROOT = None
409
if self.pb is not None:
414
def iter_suite_tests(suite):
415
"""Return all tests in a suite, recursing through nested suites"""
416
for item in suite._tests:
417
if isinstance(item, unittest.TestCase):
419
elif isinstance(item, unittest.TestSuite):
420
for r in iter_suite_tests(item):
423
raise Exception('unknown object %r inside test suite %r'
427
class TestSkipped(Exception):
428
"""Indicates that a test was intentionally skipped, rather than failing."""
431
class CommandFailed(Exception):
435
class StringIOWrapper(object):
436
"""A wrapper around cStringIO which just adds an encoding attribute.
438
Internally we can check sys.stdout to see what the output encoding
439
should be. However, cStringIO has no encoding attribute that we can
440
set. So we wrap it instead.
445
def __init__(self, s=None):
447
self.__dict__['_cstring'] = StringIO(s)
449
self.__dict__['_cstring'] = StringIO()
451
def __getattr__(self, name, getattr=getattr):
452
return getattr(self.__dict__['_cstring'], name)
454
def __setattr__(self, name, val):
455
if name == 'encoding':
456
self.__dict__['encoding'] = val
458
return setattr(self._cstring, name, val)
461
class TestCase(unittest.TestCase):
462
"""Base class for bzr unit tests.
464
Tests that need access to disk resources should subclass
465
TestCaseInTempDir not TestCase.
467
Error and debug log messages are redirected from their usual
468
location into a temporary file, the contents of which can be
469
retrieved by _get_log(). We use a real OS file, not an in-memory object,
470
so that it can also capture file IO. When the test completes this file
471
is read into memory and removed from disk.
473
There are also convenience functions to invoke bzr's command-line
474
routine, and to build and check bzr trees.
476
In addition to the usual method of overriding tearDown(), this class also
477
allows subclasses to register functions into the _cleanups list, which is
478
run in order as the object is torn down. It's less likely this will be
479
accidentally overlooked.
482
_log_file_name = None
484
# record lsprof data when performing benchmark calls.
485
_gather_lsprof_in_benchmarks = False
487
def __init__(self, methodName='testMethod'):
488
super(TestCase, self).__init__(methodName)
492
unittest.TestCase.setUp(self)
493
self._cleanEnvironment()
494
bzrlib.trace.disable_default_logging()
496
self._benchcalls = []
497
self._benchtime = None
499
def _ndiff_strings(self, a, b):
500
"""Return ndiff between two strings containing lines.
502
A trailing newline is added if missing to make the strings
504
if b and b[-1] != '\n':
506
if a and a[-1] != '\n':
508
difflines = difflib.ndiff(a.splitlines(True),
510
linejunk=lambda x: False,
511
charjunk=lambda x: False)
512
return ''.join(difflines)
514
def assertEqualDiff(self, a, b, message=None):
515
"""Assert two texts are equal, if not raise an exception.
517
This is intended for use with multi-line strings where it can
518
be hard to find the differences by eye.
520
# TODO: perhaps override assertEquals to call this for strings?
524
message = "texts not equal:\n"
525
raise AssertionError(message +
526
self._ndiff_strings(a, b))
528
def assertEqualMode(self, mode, mode_test):
529
self.assertEqual(mode, mode_test,
530
'mode mismatch %o != %o' % (mode, mode_test))
532
def assertStartsWith(self, s, prefix):
533
if not s.startswith(prefix):
534
raise AssertionError('string %r does not start with %r' % (s, prefix))
536
def assertEndsWith(self, s, suffix):
537
"""Asserts that s ends with suffix."""
538
if not s.endswith(suffix):
539
raise AssertionError('string %r does not end with %r' % (s, suffix))
541
def assertContainsRe(self, haystack, needle_re):
542
"""Assert that a contains something matching a regular expression."""
543
if not re.search(needle_re, haystack):
544
raise AssertionError('pattern "%s" not found in "%s"'
545
% (needle_re, haystack))
547
def assertNotContainsRe(self, haystack, needle_re):
548
"""Assert that a does not match a regular expression"""
549
if re.search(needle_re, haystack):
550
raise AssertionError('pattern "%s" found in "%s"'
551
% (needle_re, haystack))
553
def assertSubset(self, sublist, superlist):
554
"""Assert that every entry in sublist is present in superlist."""
556
for entry in sublist:
557
if entry not in superlist:
558
missing.append(entry)
560
raise AssertionError("value(s) %r not present in container %r" %
561
(missing, superlist))
563
def assertIs(self, left, right):
564
if not (left is right):
565
raise AssertionError("%r is not %r." % (left, right))
567
def assertTransportMode(self, transport, path, mode):
568
"""Fail if a path does not have mode mode.
570
If modes are not supported on this transport, the assertion is ignored.
572
if not transport._can_roundtrip_unix_modebits():
574
path_stat = transport.stat(path)
575
actual_mode = stat.S_IMODE(path_stat.st_mode)
576
self.assertEqual(mode, actual_mode,
577
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
579
def assertIsInstance(self, obj, kls):
580
"""Fail if obj is not an instance of kls"""
581
if not isinstance(obj, kls):
582
self.fail("%r is an instance of %s rather than %s" % (
583
obj, obj.__class__, kls))
585
def _capture_warnings(self, a_callable, *args, **kwargs):
586
"""A helper for callDeprecated and applyDeprecated.
588
:param a_callable: A callable to call.
589
:param args: The positional arguments for the callable
590
:param kwargs: The keyword arguments for the callable
591
:return: A tuple (warnings, result). result is the result of calling
592
a_callable(*args, **kwargs).
595
def capture_warnings(msg, cls, stacklevel=None):
596
# we've hooked into a deprecation specific callpath,
597
# only deprecations should getting sent via it.
598
self.assertEqual(cls, DeprecationWarning)
599
local_warnings.append(msg)
600
original_warning_method = symbol_versioning.warn
601
symbol_versioning.set_warning_method(capture_warnings)
603
result = a_callable(*args, **kwargs)
605
symbol_versioning.set_warning_method(original_warning_method)
606
return (local_warnings, result)
608
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
609
"""Call a deprecated callable without warning the user.
611
:param deprecation_format: The deprecation format that the callable
612
should have been deprecated with. This is the same type as the
613
parameter to deprecated_method/deprecated_function. If the
614
callable is not deprecated with this format, an assertion error
616
:param a_callable: A callable to call. This may be a bound method or
617
a regular function. It will be called with *args and **kwargs.
618
:param args: The positional arguments for the callable
619
:param kwargs: The keyword arguments for the callable
620
:return: The result of a_callable(*args, **kwargs)
622
call_warnings, result = self._capture_warnings(a_callable,
624
expected_first_warning = symbol_versioning.deprecation_string(
625
a_callable, deprecation_format)
626
if len(call_warnings) == 0:
627
self.fail("No assertion generated by call to %s" %
629
self.assertEqual(expected_first_warning, call_warnings[0])
632
def callDeprecated(self, expected, callable, *args, **kwargs):
633
"""Assert that a callable is deprecated in a particular way.
635
This is a very precise test for unusual requirements. The
636
applyDeprecated helper function is probably more suited for most tests
637
as it allows you to simply specify the deprecation format being used
638
and will ensure that that is issued for the function being called.
640
:param expected: a list of the deprecation warnings expected, in order
641
:param callable: The callable to call
642
:param args: The positional arguments for the callable
643
:param kwargs: The keyword arguments for the callable
645
call_warnings, result = self._capture_warnings(callable,
647
self.assertEqual(expected, call_warnings)
650
def _startLogFile(self):
651
"""Send bzr and test log messages to a temporary file.
653
The file is removed as the test is torn down.
655
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
656
self._log_file = os.fdopen(fileno, 'w+')
657
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
658
self._log_file_name = name
659
self.addCleanup(self._finishLogFile)
661
def _finishLogFile(self):
662
"""Finished with the log file.
664
Read contents into memory, close, and delete.
666
if self._log_file is None:
668
bzrlib.trace.disable_test_log(self._log_nonce)
669
self._log_file.seek(0)
670
self._log_contents = self._log_file.read()
671
self._log_file.close()
672
os.remove(self._log_file_name)
673
self._log_file = self._log_file_name = None
675
def addCleanup(self, callable):
676
"""Arrange to run a callable when this case is torn down.
678
Callables are run in the reverse of the order they are registered,
679
ie last-in first-out.
681
if callable in self._cleanups:
682
raise ValueError("cleanup function %r already registered on %s"
684
self._cleanups.append(callable)
686
def _cleanEnvironment(self):
689
'APPDATA': os.getcwd(),
691
'BZREMAIL': None, # may still be present in the environment
693
'BZR_PROGRESS_BAR': None,
696
self.addCleanup(self._restoreEnvironment)
697
for name, value in new_env.iteritems():
698
self._captureVar(name, value)
700
def _captureVar(self, name, newvalue):
701
"""Set an environment variable, and reset it when finished."""
702
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
704
def _restoreEnvironment(self):
705
for name, value in self.__old_env.iteritems():
706
osutils.set_or_unset_env(name, value)
710
unittest.TestCase.tearDown(self)
712
def time(self, callable, *args, **kwargs):
713
"""Run callable and accrue the time it takes to the benchmark time.
715
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
716
this will cause lsprofile statistics to be gathered and stored in
719
if self._benchtime is None:
723
if not self._gather_lsprof_in_benchmarks:
724
return callable(*args, **kwargs)
726
# record this benchmark
727
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
729
self._benchcalls.append(((callable, args, kwargs), stats))
732
self._benchtime += time.time() - start
734
def _runCleanups(self):
735
"""Run registered cleanup functions.
737
This should only be called from TestCase.tearDown.
739
# TODO: Perhaps this should keep running cleanups even if
741
for cleanup_fn in reversed(self._cleanups):
744
def log(self, *args):
748
"""Return as a string the log for this test"""
749
if self._log_file_name:
750
return open(self._log_file_name).read()
752
return self._log_contents
753
# TODO: Delete the log after it's been read in
755
def capture(self, cmd, retcode=0):
756
"""Shortcut that splits cmd into words, runs, and returns stdout"""
757
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
759
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None):
760
"""Invoke bzr and return (stdout, stderr).
762
Useful for code that wants to check the contents of the
763
output, the way error messages are presented, etc.
765
This should be the main method for tests that want to exercise the
766
overall behavior of the bzr application (rather than a unit test
767
or a functional test of the library.)
769
Much of the old code runs bzr by forking a new copy of Python, but
770
that is slower, harder to debug, and generally not necessary.
772
This runs bzr through the interface that catches and reports
773
errors, and with logging set to something approximating the
774
default, so that error reporting can be checked.
776
:param argv: arguments to invoke bzr
777
:param retcode: expected return code, or None for don't-care.
778
:param encoding: encoding for sys.stdout and sys.stderr
779
:param stdin: A string to be used as stdin for the command.
782
encoding = bzrlib.user_encoding
783
if stdin is not None:
784
stdin = StringIO(stdin)
785
stdout = StringIOWrapper()
786
stderr = StringIOWrapper()
787
stdout.encoding = encoding
788
stderr.encoding = encoding
790
self.log('run bzr: %r', argv)
791
# FIXME: don't call into logging here
792
handler = logging.StreamHandler(stderr)
793
handler.setLevel(logging.INFO)
794
logger = logging.getLogger('')
795
logger.addHandler(handler)
796
old_ui_factory = bzrlib.ui.ui_factory
797
bzrlib.ui.ui_factory = bzrlib.tests.blackbox.TestUIFactory(
800
bzrlib.ui.ui_factory.stdin = stdin
802
result = self.apply_redirected(stdin, stdout, stderr,
803
bzrlib.commands.run_bzr_catch_errors,
806
logger.removeHandler(handler)
807
bzrlib.ui.ui_factory = old_ui_factory
809
out = stdout.getvalue()
810
err = stderr.getvalue()
812
self.log('output:\n%r', out)
814
self.log('errors:\n%r', err)
815
if retcode is not None:
816
self.assertEquals(retcode, result)
819
def run_bzr(self, *args, **kwargs):
820
"""Invoke bzr, as if it were run from the command line.
822
This should be the main method for tests that want to exercise the
823
overall behavior of the bzr application (rather than a unit test
824
or a functional test of the library.)
826
This sends the stdout/stderr results into the test's log,
827
where it may be useful for debugging. See also run_captured.
829
:param stdin: A string to be used as stdin for the command.
831
retcode = kwargs.pop('retcode', 0)
832
encoding = kwargs.pop('encoding', None)
833
stdin = kwargs.pop('stdin', None)
834
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding, stdin=stdin)
836
def run_bzr_decode(self, *args, **kwargs):
837
if 'encoding' in kwargs:
838
encoding = kwargs['encoding']
840
encoding = bzrlib.user_encoding
841
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
843
def run_bzr_error(self, error_regexes, *args, **kwargs):
844
"""Run bzr, and check that stderr contains the supplied regexes
846
:param error_regexes: Sequence of regular expressions which
847
must each be found in the error output. The relative ordering
849
:param args: command-line arguments for bzr
850
:param kwargs: Keyword arguments which are interpreted by run_bzr
851
This function changes the default value of retcode to be 3,
852
since in most cases this is run when you expect bzr to fail.
853
:return: (out, err) The actual output of running the command (in case you
854
want to do more inspection)
857
# Make sure that commit is failing because there is nothing to do
858
self.run_bzr_error(['no changes to commit'],
859
'commit', '-m', 'my commit comment')
860
# Make sure --strict is handling an unknown file, rather than
861
# giving us the 'nothing to do' error
862
self.build_tree(['unknown'])
863
self.run_bzr_error(['Commit refused because there are unknown files'],
864
'commit', '--strict', '-m', 'my commit comment')
866
kwargs.setdefault('retcode', 3)
867
out, err = self.run_bzr(*args, **kwargs)
868
for regex in error_regexes:
869
self.assertContainsRe(err, regex)
872
def run_bzr_subprocess(self, *args, **kwargs):
873
"""Run bzr in a subprocess for testing.
875
This starts a new Python interpreter and runs bzr in there.
876
This should only be used for tests that have a justifiable need for
877
this isolation: e.g. they are testing startup time, or signal
878
handling, or early startup code, etc. Subprocess code can't be
879
profiled or debugged so easily.
881
:param retcode: The status code that is expected. Defaults to 0. If
882
None is supplied, the status code is not checked.
883
:param env_changes: A dictionary which lists changes to environment
884
variables. A value of None will unset the env variable.
885
The values must be strings. The change will only occur in the
886
child, so you don't need to fix the environment after running.
887
:param universal_newlines: Convert CRLF => LF
889
env_changes = kwargs.get('env_changes', {})
893
def cleanup_environment():
894
for env_var, value in env_changes.iteritems():
895
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
897
def restore_environment():
898
for env_var, value in old_env.iteritems():
899
osutils.set_or_unset_env(env_var, value)
901
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
905
# win32 subprocess doesn't support preexec_fn
906
# so we will avoid using it on all platforms, just to
907
# make sure the code path is used, and we don't break on win32
908
cleanup_environment()
909
process = Popen([sys.executable, bzr_path]+args,
910
stdout=PIPE, stderr=PIPE)
912
restore_environment()
914
out = process.stdout.read()
915
err = process.stderr.read()
917
if kwargs.get('universal_newlines', False):
918
out = out.replace('\r\n', '\n')
919
err = err.replace('\r\n', '\n')
921
retcode = process.wait()
922
supplied_retcode = kwargs.get('retcode', 0)
923
if supplied_retcode is not None:
924
assert supplied_retcode == retcode
927
def start_bzr_subprocess(self, *args):
928
"""Start bzr in a subprocess for testing.
930
This starts a new Python interpreter and runs bzr in there.
931
This should only be used for tests that have a justifiable need for
932
this isolation: e.g. they are testing startup time, or signal
933
handling, or early startup code, etc. Subprocess code can't be
934
profiled or debugged so easily.
936
:returns: Popen object for the started process.
938
# TODO: this ought to remove BZR_PDB when running the subprocess- the
939
# user probably doesn't want to debug it, and anyhow since its files
940
# are redirected they can't usefully get at it. It just makes the
942
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
944
process = Popen([sys.executable, bzr_path]+args, stdout=PIPE,
948
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None):
949
"""Finish the execution of process.
951
:param process: the Popen object returned from start_bzr_subprocess.
952
:param retcode: the expected return code of the process, if None any
953
value is accepted, otherwise if there is a difference a failure will
955
:param send_signal: an optional signal to send to the process.
956
:returns: (stdout, stderr)
958
if send_signal is not None:
959
os.kill(process.pid, send_signal)
960
result = process.communicate()
961
if retcode is not None:
962
self.assertEqual(retcode, process.returncode)
965
def check_inventory_shape(self, inv, shape):
966
"""Compare an inventory to a list of expected names.
968
Fail if they are not precisely equal.
971
shape = list(shape) # copy
972
for path, ie in inv.entries():
973
name = path.replace('\\', '/')
981
self.fail("expected paths not found in inventory: %r" % shape)
983
self.fail("unexpected paths found in inventory: %r" % extras)
985
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
986
a_callable=None, *args, **kwargs):
987
"""Call callable with redirected std io pipes.
989
Returns the return code."""
990
if not callable(a_callable):
991
raise ValueError("a_callable must be callable.")
995
if getattr(self, "_log_file", None) is not None:
996
stdout = self._log_file
1000
if getattr(self, "_log_file", None is not None):
1001
stderr = self._log_file
1004
real_stdin = sys.stdin
1005
real_stdout = sys.stdout
1006
real_stderr = sys.stderr
1011
return a_callable(*args, **kwargs)
1013
sys.stdout = real_stdout
1014
sys.stderr = real_stderr
1015
sys.stdin = real_stdin
1017
@symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
1018
def merge(self, branch_from, wt_to):
1019
"""A helper for tests to do a ui-less merge.
1021
This should move to the main library when someone has time to integrate
1024
# minimal ui-less merge.
1025
wt_to.branch.fetch(branch_from)
1026
base_rev = common_ancestor(branch_from.last_revision(),
1027
wt_to.branch.last_revision(),
1028
wt_to.branch.repository)
1029
merge_inner(wt_to.branch, branch_from.basis_tree(),
1030
wt_to.branch.repository.revision_tree(base_rev),
1032
wt_to.add_parent_tree_id(branch_from.last_revision())
1035
BzrTestBase = TestCase
1038
class TestCaseInTempDir(TestCase):
1039
"""Derived class that runs a test within a temporary directory.
1041
This is useful for tests that need to create a branch, etc.
1043
The directory is created in a slightly complex way: for each
1044
Python invocation, a new temporary top-level directory is created.
1045
All test cases create their own directory within that. If the
1046
tests complete successfully, the directory is removed.
1048
InTempDir is an old alias for FunctionalTestCase.
1053
OVERRIDE_PYTHON = 'python'
1055
def check_file_contents(self, filename, expect):
1056
self.log("check contents of file %s" % filename)
1057
contents = file(filename, 'r').read()
1058
if contents != expect:
1059
self.log("expected: %r" % expect)
1060
self.log("actually: %r" % contents)
1061
self.fail("contents of %s not as expected" % filename)
1063
def _make_test_root(self):
1064
if TestCaseInTempDir.TEST_ROOT is not None:
1068
root = u'test%04d.tmp' % i
1072
if e.errno == errno.EEXIST:
1077
# successfully created
1078
TestCaseInTempDir.TEST_ROOT = osutils.abspath(root)
1080
# make a fake bzr directory there to prevent any tests propagating
1081
# up onto the source directory's real branch
1082
bzrdir.BzrDir.create_standalone_workingtree(TestCaseInTempDir.TEST_ROOT)
1085
super(TestCaseInTempDir, self).setUp()
1086
self._make_test_root()
1087
_currentdir = os.getcwdu()
1088
# shorten the name, to avoid test failures due to path length
1089
short_id = self.id().replace('bzrlib.tests.', '') \
1090
.replace('__main__.', '')[-100:]
1091
# it's possible the same test class is run several times for
1092
# parameterized tests, so make sure the names don't collide.
1096
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1098
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1099
if os.path.exists(candidate_dir):
1103
os.mkdir(candidate_dir)
1104
self.test_home_dir = candidate_dir + '/home'
1105
os.mkdir(self.test_home_dir)
1106
self.test_dir = candidate_dir + '/work'
1107
os.mkdir(self.test_dir)
1108
os.chdir(self.test_dir)
1110
os.environ['HOME'] = self.test_home_dir
1111
os.environ['APPDATA'] = self.test_home_dir
1112
def _leaveDirectory():
1113
os.chdir(_currentdir)
1114
self.addCleanup(_leaveDirectory)
1116
def build_tree(self, shape, line_endings='native', transport=None):
1117
"""Build a test tree according to a pattern.
1119
shape is a sequence of file specifications. If the final
1120
character is '/', a directory is created.
1122
This assumes that all the elements in the tree being built are new.
1124
This doesn't add anything to a branch.
1125
:param line_endings: Either 'binary' or 'native'
1126
in binary mode, exact contents are written
1127
in native mode, the line endings match the
1128
default platform endings.
1130
:param transport: A transport to write to, for building trees on
1131
VFS's. If the transport is readonly or None,
1132
"." is opened automatically.
1134
# It's OK to just create them using forward slashes on windows.
1135
if transport is None or transport.is_readonly():
1136
transport = get_transport(".")
1138
self.assert_(isinstance(name, basestring))
1140
transport.mkdir(urlutils.escape(name[:-1]))
1142
if line_endings == 'binary':
1144
elif line_endings == 'native':
1147
raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
1148
content = "contents of %s%s" % (name.encode('utf-8'), end)
1149
# Technically 'put()' is the right command. However, put
1150
# uses an AtomicFile, which requires an extra rename into place
1151
# As long as the files didn't exist in the past, append() will
1152
# do the same thing as put()
1153
# On jam's machine, make_kernel_like_tree is:
1154
# put: 4.5-7.5s (averaging 6s)
1156
# put_non_atomic: 2.9-4.5s
1157
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1159
def build_tree_contents(self, shape):
1160
build_tree_contents(shape)
1162
def failUnlessExists(self, path):
1163
"""Fail unless path, which may be abs or relative, exists."""
1164
self.failUnless(osutils.lexists(path))
1166
def failIfExists(self, path):
1167
"""Fail if path, which may be abs or relative, exists."""
1168
self.failIf(osutils.lexists(path))
1170
def assertFileEqual(self, content, path):
1171
"""Fail if path does not contain 'content'."""
1172
self.failUnless(osutils.lexists(path))
1173
# TODO: jam 20060427 Shouldn't this be 'rb'?
1174
self.assertEqualDiff(content, open(path, 'r').read())
1177
class TestCaseWithTransport(TestCaseInTempDir):
1178
"""A test case that provides get_url and get_readonly_url facilities.
1180
These back onto two transport servers, one for readonly access and one for
1183
If no explicit class is provided for readonly access, a
1184
ReadonlyTransportDecorator is used instead which allows the use of non disk
1185
based read write transports.
1187
If an explicit class is provided for readonly access, that server and the
1188
readwrite one must both define get_url() as resolving to os.getcwd().
1191
def __init__(self, methodName='testMethod'):
1192
super(TestCaseWithTransport, self).__init__(methodName)
1193
self.__readonly_server = None
1194
self.__server = None
1195
self.transport_server = default_transport
1196
self.transport_readonly_server = None
1198
def get_readonly_url(self, relpath=None):
1199
"""Get a URL for the readonly transport.
1201
This will either be backed by '.' or a decorator to the transport
1202
used by self.get_url()
1203
relpath provides for clients to get a path relative to the base url.
1204
These should only be downwards relative, not upwards.
1206
base = self.get_readonly_server().get_url()
1207
if relpath is not None:
1208
if not base.endswith('/'):
1210
base = base + relpath
1213
def get_readonly_server(self):
1214
"""Get the server instance for the readonly transport
1216
This is useful for some tests with specific servers to do diagnostics.
1218
if self.__readonly_server is None:
1219
if self.transport_readonly_server is None:
1220
# readonly decorator requested
1221
# bring up the server
1223
self.__readonly_server = ReadonlyServer()
1224
self.__readonly_server.setUp(self.__server)
1226
self.__readonly_server = self.transport_readonly_server()
1227
self.__readonly_server.setUp()
1228
self.addCleanup(self.__readonly_server.tearDown)
1229
return self.__readonly_server
1231
def get_server(self):
1232
"""Get the read/write server instance.
1234
This is useful for some tests with specific servers that need
1237
if self.__server is None:
1238
self.__server = self.transport_server()
1239
self.__server.setUp()
1240
self.addCleanup(self.__server.tearDown)
1241
return self.__server
1243
def get_url(self, relpath=None):
1244
"""Get a URL (or maybe a path) for the readwrite transport.
1246
This will either be backed by '.' or to an equivalent non-file based
1248
relpath provides for clients to get a path relative to the base url.
1249
These should only be downwards relative, not upwards.
1251
base = self.get_server().get_url()
1252
if relpath is not None and relpath != '.':
1253
if not base.endswith('/'):
1255
# XXX: Really base should be a url; we did after all call
1256
# get_url()! But sometimes it's just a path (from
1257
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1258
# to a non-escaped local path.
1259
if base.startswith('./') or base.startswith('/'):
1262
base += urlutils.escape(relpath)
1265
def get_transport(self):
1266
"""Return a writeable transport for the test scratch space"""
1267
t = get_transport(self.get_url())
1268
self.assertFalse(t.is_readonly())
1271
def get_readonly_transport(self):
1272
"""Return a readonly transport for the test scratch space
1274
This can be used to test that operations which should only need
1275
readonly access in fact do not try to write.
1277
t = get_transport(self.get_readonly_url())
1278
self.assertTrue(t.is_readonly())
1281
def make_branch(self, relpath, format=None):
1282
"""Create a branch on the transport at relpath."""
1283
repo = self.make_repository(relpath, format=format)
1284
return repo.bzrdir.create_branch()
1286
def make_bzrdir(self, relpath, format=None):
1288
# might be a relative or absolute path
1289
maybe_a_url = self.get_url(relpath)
1290
segments = maybe_a_url.split('/')
1291
t = get_transport(maybe_a_url)
1292
if segments and segments[-1] not in ('', '.'):
1295
except errors.FileExists:
1298
format = bzrlib.bzrdir.BzrDirFormat.get_default_format()
1299
return format.initialize_on_transport(t)
1300
except errors.UninitializableFormat:
1301
raise TestSkipped("Format %s is not initializable." % format)
1303
def make_repository(self, relpath, shared=False, format=None):
1304
"""Create a repository on our default transport at relpath."""
1305
made_control = self.make_bzrdir(relpath, format=format)
1306
return made_control.create_repository(shared=shared)
1308
def make_branch_and_tree(self, relpath, format=None):
1309
"""Create a branch on the transport and a tree locally.
1311
If the transport is not a LocalTransport, the Tree can't be created on
1312
the transport. In that case the working tree is created in the local
1313
directory, and the returned tree's branch and repository will also be
1316
This will fail if the original default transport for this test
1317
case wasn't backed by the working directory, as the branch won't
1318
be on disk for us to open it.
1320
:param format: The BzrDirFormat.
1321
:returns: the WorkingTree.
1323
# TODO: always use the local disk path for the working tree,
1324
# this obviously requires a format that supports branch references
1325
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1327
b = self.make_branch(relpath, format=format)
1329
return b.bzrdir.create_workingtree()
1330
except errors.NotLocalUrl:
1331
# We can only make working trees locally at the moment. If the
1332
# transport can't support them, then reopen the branch on a local
1333
# transport, and create the working tree there.
1335
# Possibly we should instead keep
1336
# the non-disk-backed branch and create a local checkout?
1337
bd = bzrdir.BzrDir.open(relpath)
1338
return bd.create_workingtree()
1340
def assertIsDirectory(self, relpath, transport):
1341
"""Assert that relpath within transport is a directory.
1343
This may not be possible on all transports; in that case it propagates
1344
a TransportNotPossible.
1347
mode = transport.stat(relpath).st_mode
1348
except errors.NoSuchFile:
1349
self.fail("path %s is not a directory; no such file"
1351
if not stat.S_ISDIR(mode):
1352
self.fail("path %s is not a directory; has mode %#o"
1356
class ChrootedTestCase(TestCaseWithTransport):
1357
"""A support class that provides readonly urls outside the local namespace.
1359
This is done by checking if self.transport_server is a MemoryServer. if it
1360
is then we are chrooted already, if it is not then an HttpServer is used
1363
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1364
be used without needed to redo it when a different
1365
subclass is in use ?
1369
super(ChrootedTestCase, self).setUp()
1370
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
1371
self.transport_readonly_server = bzrlib.transport.http.HttpServer
1374
def filter_suite_by_re(suite, pattern):
1375
result = TestUtil.TestSuite()
1376
filter_re = re.compile(pattern)
1377
for test in iter_suite_tests(suite):
1378
if filter_re.search(test.id()):
1379
result.addTest(test)
1383
def run_suite(suite, name='test', verbose=False, pattern=".*",
1384
stop_on_failure=False, keep_output=False,
1385
transport=None, lsprof_timed=None, bench_history=None):
1386
TestCaseInTempDir._TEST_NAME = name
1387
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1393
pb = progress.ProgressBar()
1394
runner = TextTestRunner(stream=sys.stdout,
1396
verbosity=verbosity,
1397
keep_output=keep_output,
1399
bench_history=bench_history)
1400
runner.stop_on_failure=stop_on_failure
1402
suite = filter_suite_by_re(suite, pattern)
1403
result = runner.run(suite)
1404
return result.wasSuccessful()
1407
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1410
test_suite_factory=None,
1412
bench_history=None):
1413
"""Run the whole test suite under the enhanced runner"""
1414
# XXX: Very ugly way to do this...
1415
# Disable warning about old formats because we don't want it to disturb
1416
# any blackbox tests.
1417
from bzrlib import repository
1418
repository._deprecation_warning_done = True
1420
global default_transport
1421
if transport is None:
1422
transport = default_transport
1423
old_transport = default_transport
1424
default_transport = transport
1426
if test_suite_factory is None:
1427
suite = test_suite()
1429
suite = test_suite_factory()
1430
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1431
stop_on_failure=stop_on_failure, keep_output=keep_output,
1432
transport=transport,
1433
lsprof_timed=lsprof_timed,
1434
bench_history=bench_history)
1436
default_transport = old_transport
1440
"""Build and return TestSuite for the whole of bzrlib.
1442
This function can be replaced if you need to change the default test
1443
suite on a global basis, but it is not encouraged.
1446
'bzrlib.tests.test_ancestry',
1447
'bzrlib.tests.test_api',
1448
'bzrlib.tests.test_atomicfile',
1449
'bzrlib.tests.test_bad_files',
1450
'bzrlib.tests.test_branch',
1451
'bzrlib.tests.test_bundle',
1452
'bzrlib.tests.test_bzrdir',
1453
'bzrlib.tests.test_cache_utf8',
1454
'bzrlib.tests.test_command',
1455
'bzrlib.tests.test_commit',
1456
'bzrlib.tests.test_commit_merge',
1457
'bzrlib.tests.test_config',
1458
'bzrlib.tests.test_conflicts',
1459
'bzrlib.tests.test_decorators',
1460
'bzrlib.tests.test_diff',
1461
'bzrlib.tests.test_doc_generate',
1462
'bzrlib.tests.test_errors',
1463
'bzrlib.tests.test_escaped_store',
1464
'bzrlib.tests.test_fetch',
1465
'bzrlib.tests.test_ftp_transport',
1466
'bzrlib.tests.test_gpg',
1467
'bzrlib.tests.test_graph',
1468
'bzrlib.tests.test_hashcache',
1469
'bzrlib.tests.test_http',
1470
'bzrlib.tests.test_http_response',
1471
'bzrlib.tests.test_identitymap',
1472
'bzrlib.tests.test_ignores',
1473
'bzrlib.tests.test_inv',
1474
'bzrlib.tests.test_knit',
1475
'bzrlib.tests.test_lockdir',
1476
'bzrlib.tests.test_lockable_files',
1477
'bzrlib.tests.test_log',
1478
'bzrlib.tests.test_merge',
1479
'bzrlib.tests.test_merge3',
1480
'bzrlib.tests.test_merge_core',
1481
'bzrlib.tests.test_missing',
1482
'bzrlib.tests.test_msgeditor',
1483
'bzrlib.tests.test_nonascii',
1484
'bzrlib.tests.test_options',
1485
'bzrlib.tests.test_osutils',
1486
'bzrlib.tests.test_patch',
1487
'bzrlib.tests.test_patches',
1488
'bzrlib.tests.test_permissions',
1489
'bzrlib.tests.test_plugins',
1490
'bzrlib.tests.test_progress',
1491
'bzrlib.tests.test_reconcile',
1492
'bzrlib.tests.test_repository',
1493
'bzrlib.tests.test_revert',
1494
'bzrlib.tests.test_revision',
1495
'bzrlib.tests.test_revisionnamespaces',
1496
'bzrlib.tests.test_revisiontree',
1497
'bzrlib.tests.test_rio',
1498
'bzrlib.tests.test_sampler',
1499
'bzrlib.tests.test_selftest',
1500
'bzrlib.tests.test_setup',
1501
'bzrlib.tests.test_sftp_transport',
1502
'bzrlib.tests.test_smart_add',
1503
'bzrlib.tests.test_smart_transport',
1504
'bzrlib.tests.test_source',
1505
'bzrlib.tests.test_status',
1506
'bzrlib.tests.test_store',
1507
'bzrlib.tests.test_symbol_versioning',
1508
'bzrlib.tests.test_testament',
1509
'bzrlib.tests.test_textfile',
1510
'bzrlib.tests.test_textmerge',
1511
'bzrlib.tests.test_trace',
1512
'bzrlib.tests.test_transactions',
1513
'bzrlib.tests.test_transform',
1514
'bzrlib.tests.test_transport',
1515
'bzrlib.tests.test_tree',
1516
'bzrlib.tests.test_tsort',
1517
'bzrlib.tests.test_tuned_gzip',
1518
'bzrlib.tests.test_ui',
1519
'bzrlib.tests.test_upgrade',
1520
'bzrlib.tests.test_urlutils',
1521
'bzrlib.tests.test_versionedfile',
1522
'bzrlib.tests.test_version',
1523
'bzrlib.tests.test_weave',
1524
'bzrlib.tests.test_whitebox',
1525
'bzrlib.tests.test_workingtree',
1526
'bzrlib.tests.test_xml',
1528
test_transport_implementations = [
1529
'bzrlib.tests.test_transport_implementations',
1530
'bzrlib.tests.test_read_bundle',
1532
suite = TestUtil.TestSuite()
1533
loader = TestUtil.TestLoader()
1534
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1535
from bzrlib.transport import TransportTestProviderAdapter
1536
adapter = TransportTestProviderAdapter()
1537
adapt_modules(test_transport_implementations, adapter, loader, suite)
1538
for package in packages_to_test():
1539
suite.addTest(package.test_suite())
1540
for m in MODULES_TO_TEST:
1541
suite.addTest(loader.loadTestsFromModule(m))
1542
for m in MODULES_TO_DOCTEST:
1543
suite.addTest(doctest.DocTestSuite(m))
1544
for name, plugin in bzrlib.plugin.all_plugins().items():
1545
if getattr(plugin, 'test_suite', None) is not None:
1546
suite.addTest(plugin.test_suite())
1550
def adapt_modules(mods_list, adapter, loader, suite):
1551
"""Adapt the modules in mods_list using adapter and add to suite."""
1552
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1553
suite.addTests(adapter.adapt(test))
added
removed
bzrlib/tests/__init__.py
