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,
101
def packages_to_test():
102
"""Return a list of packages to test.
104
The packages are not globally imported so that import failures are
105
triggered when running selftest, not when importing the command.
108
import bzrlib.tests.blackbox
109
import bzrlib.tests.branch_implementations
110
import bzrlib.tests.bzrdir_implementations
111
import bzrlib.tests.interrepository_implementations
112
import bzrlib.tests.interversionedfile_implementations
113
import bzrlib.tests.intertree_implementations
114
import bzrlib.tests.repository_implementations
115
import bzrlib.tests.revisionstore_implementations
116
import bzrlib.tests.tree_implementations
117
import bzrlib.tests.workingtree_implementations
120
bzrlib.tests.blackbox,
121
bzrlib.tests.branch_implementations,
122
bzrlib.tests.bzrdir_implementations,
123
bzrlib.tests.interrepository_implementations,
124
bzrlib.tests.interversionedfile_implementations,
125
bzrlib.tests.intertree_implementations,
126
bzrlib.tests.repository_implementations,
127
bzrlib.tests.revisionstore_implementations,
128
bzrlib.tests.tree_implementations,
129
bzrlib.tests.workingtree_implementations,
133
class _MyResult(unittest._TextTestResult):
134
"""Custom TestResult.
136
Shows output in a different format, including displaying runtime for tests.
140
def __init__(self, stream, descriptions, verbosity, pb=None,
142
"""Construct new TestResult.
144
:param bench_history: Optionally, a writable file object to accumulate
147
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
149
if bench_history is not None:
150
from bzrlib.version import _get_bzr_source_tree
151
src_tree = _get_bzr_source_tree()
154
revision_id = src_tree.get_parent_ids()[0]
156
# XXX: if this is a brand new tree, do the same as if there
160
# XXX: If there's no branch, what should we do?
162
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
163
self._bench_history = bench_history
165
def extractBenchmarkTime(self, testCase):
166
"""Add a benchmark time for the current test case."""
167
self._benchmarkTime = getattr(testCase, "_benchtime", None)
169
def _elapsedTestTimeString(self):
170
"""Return a time string for the overall time the current test has taken."""
171
return self._formatTime(time.time() - self._start_time)
173
def _testTimeString(self):
174
if self._benchmarkTime is not None:
176
self._formatTime(self._benchmarkTime),
177
self._elapsedTestTimeString())
179
return " %s" % self._elapsedTestTimeString()
181
def _formatTime(self, seconds):
182
"""Format seconds as milliseconds with leading spaces."""
183
return "%5dms" % (1000 * seconds)
185
def _ellipsise_unimportant_words(self, a_string, final_width,
187
"""Add ellipses (sp?) for overly long strings.
189
:param keep_start: If true preserve the start of a_string rather
193
if len(a_string) > final_width:
194
result = a_string[:final_width-3] + '...'
198
if len(a_string) > final_width:
199
result = '...' + a_string[3-final_width:]
202
return result.ljust(final_width)
204
def startTest(self, test):
205
unittest.TestResult.startTest(self, test)
206
# In a short description, the important words are in
207
# the beginning, but in an id, the important words are
209
SHOW_DESCRIPTIONS = False
211
if not self.showAll and self.dots and self.pb is not None:
214
final_width = osutils.terminal_width()
215
final_width = final_width - 15 - 8
217
if SHOW_DESCRIPTIONS:
218
what = test.shortDescription()
220
what = self._ellipsise_unimportant_words(what, final_width, keep_start=True)
223
if what.startswith('bzrlib.tests.'):
225
what = self._ellipsise_unimportant_words(what, final_width)
227
self.stream.write(what)
228
elif self.dots and self.pb is not None:
229
self.pb.update(what, self.testsRun - 1, None)
231
self._recordTestStartTime()
233
def _recordTestStartTime(self):
234
"""Record that a test has started."""
235
self._start_time = time.time()
237
def addError(self, test, err):
238
if isinstance(err[1], TestSkipped):
239
return self.addSkipped(test, err)
240
unittest.TestResult.addError(self, test, err)
241
self.extractBenchmarkTime(test)
243
self.stream.writeln("ERROR %s" % self._testTimeString())
244
elif self.dots and self.pb is None:
245
self.stream.write('E')
247
self.pb.update(self._ellipsise_unimportant_words('ERROR', 13), self.testsRun, None)
248
self.pb.note(self._ellipsise_unimportant_words(
249
test.id() + ': ERROR',
250
osutils.terminal_width()))
255
def addFailure(self, test, err):
256
unittest.TestResult.addFailure(self, test, err)
257
self.extractBenchmarkTime(test)
259
self.stream.writeln(" FAIL %s" % self._testTimeString())
260
elif self.dots and self.pb is None:
261
self.stream.write('F')
263
self.pb.update(self._ellipsise_unimportant_words('FAIL', 13), self.testsRun, None)
264
self.pb.note(self._ellipsise_unimportant_words(
265
test.id() + ': FAIL',
266
osutils.terminal_width()))
271
def addSuccess(self, test):
272
self.extractBenchmarkTime(test)
273
if self._bench_history is not None:
274
if self._benchmarkTime is not None:
275
self._bench_history.write("%s %s\n" % (
276
self._formatTime(self._benchmarkTime),
279
self.stream.writeln(' OK %s' % self._testTimeString())
280
for bench_called, stats in getattr(test, '_benchcalls', []):
281
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
282
stats.pprint(file=self.stream)
283
elif self.dots and self.pb is None:
284
self.stream.write('~')
286
self.pb.update(self._ellipsise_unimportant_words('OK', 13), self.testsRun, None)
288
unittest.TestResult.addSuccess(self, test)
290
def addSkipped(self, test, skip_excinfo):
291
self.extractBenchmarkTime(test)
293
print >>self.stream, ' SKIP %s' % self._testTimeString()
294
print >>self.stream, ' %s' % skip_excinfo[1]
295
elif self.dots and self.pb is None:
296
self.stream.write('S')
298
self.pb.update(self._ellipsise_unimportant_words('SKIP', 13), self.testsRun, None)
300
# seems best to treat this as success from point-of-view of unittest
301
# -- it actually does nothing so it barely matters :)
304
except KeyboardInterrupt:
307
self.addError(test, test.__exc_info())
309
unittest.TestResult.addSuccess(self, test)
311
def printErrorList(self, flavour, errors):
312
for test, err in errors:
313
self.stream.writeln(self.separator1)
314
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
315
if getattr(test, '_get_log', None) is not None:
317
print >>self.stream, \
318
('vvvv[log from %s]' % test.id()).ljust(78,'-')
319
print >>self.stream, test._get_log()
320
print >>self.stream, \
321
('^^^^[log from %s]' % test.id()).ljust(78,'-')
322
self.stream.writeln(self.separator2)
323
self.stream.writeln("%s" % err)
326
class TextTestRunner(object):
327
stop_on_failure = False
336
self.stream = unittest._WritelnDecorator(stream)
337
self.descriptions = descriptions
338
self.verbosity = verbosity
339
self.keep_output = keep_output
341
self._bench_history = bench_history
343
def _makeResult(self):
344
result = _MyResult(self.stream,
348
bench_history=self._bench_history)
349
result.stop_early = self.stop_on_failure
353
"Run the given test case or test suite."
354
result = self._makeResult()
355
startTime = time.time()
356
if self.pb is not None:
357
self.pb.update('Running tests', 0, test.countTestCases())
359
stopTime = time.time()
360
timeTaken = stopTime - startTime
362
self.stream.writeln(result.separator2)
363
run = result.testsRun
364
self.stream.writeln("Ran %d test%s in %.3fs" %
365
(run, run != 1 and "s" or "", timeTaken))
366
self.stream.writeln()
367
if not result.wasSuccessful():
368
self.stream.write("FAILED (")
369
failed, errored = map(len, (result.failures, result.errors))
371
self.stream.write("failures=%d" % failed)
373
if failed: self.stream.write(", ")
374
self.stream.write("errors=%d" % errored)
375
self.stream.writeln(")")
377
self.stream.writeln("OK")
378
if self.pb is not None:
379
self.pb.update('Cleaning up', 0, 1)
380
# This is still a little bogus,
381
# but only a little. Folk not using our testrunner will
382
# have to delete their temp directories themselves.
383
test_root = TestCaseInTempDir.TEST_ROOT
384
if result.wasSuccessful() or not self.keep_output:
385
if test_root is not None:
386
# If LANG=C we probably have created some bogus paths
387
# which rmtree(unicode) will fail to delete
388
# so make sure we are using rmtree(str) to delete everything
389
# except on win32, where rmtree(str) will fail
390
# since it doesn't have the property of byte-stream paths
391
# (they are either ascii or mbcs)
392
if sys.platform == 'win32':
393
# make sure we are using the unicode win32 api
394
test_root = unicode(test_root)
396
test_root = test_root.encode(
397
sys.getfilesystemencoding())
398
osutils.rmtree(test_root)
400
if self.pb is not None:
401
self.pb.note("Failed tests working directories are in '%s'\n",
405
"Failed tests working directories are in '%s'\n" %
407
TestCaseInTempDir.TEST_ROOT = None
408
if self.pb is not None:
413
def iter_suite_tests(suite):
414
"""Return all tests in a suite, recursing through nested suites"""
415
for item in suite._tests:
416
if isinstance(item, unittest.TestCase):
418
elif isinstance(item, unittest.TestSuite):
419
for r in iter_suite_tests(item):
422
raise Exception('unknown object %r inside test suite %r'
426
class TestSkipped(Exception):
427
"""Indicates that a test was intentionally skipped, rather than failing."""
430
class CommandFailed(Exception):
434
class StringIOWrapper(object):
435
"""A wrapper around cStringIO which just adds an encoding attribute.
437
Internally we can check sys.stdout to see what the output encoding
438
should be. However, cStringIO has no encoding attribute that we can
439
set. So we wrap it instead.
444
def __init__(self, s=None):
446
self.__dict__['_cstring'] = StringIO(s)
448
self.__dict__['_cstring'] = StringIO()
450
def __getattr__(self, name, getattr=getattr):
451
return getattr(self.__dict__['_cstring'], name)
453
def __setattr__(self, name, val):
454
if name == 'encoding':
455
self.__dict__['encoding'] = val
457
return setattr(self._cstring, name, val)
460
class TestCase(unittest.TestCase):
461
"""Base class for bzr unit tests.
463
Tests that need access to disk resources should subclass
464
TestCaseInTempDir not TestCase.
466
Error and debug log messages are redirected from their usual
467
location into a temporary file, the contents of which can be
468
retrieved by _get_log(). We use a real OS file, not an in-memory object,
469
so that it can also capture file IO. When the test completes this file
470
is read into memory and removed from disk.
472
There are also convenience functions to invoke bzr's command-line
473
routine, and to build and check bzr trees.
475
In addition to the usual method of overriding tearDown(), this class also
476
allows subclasses to register functions into the _cleanups list, which is
477
run in order as the object is torn down. It's less likely this will be
478
accidentally overlooked.
481
_log_file_name = None
483
# record lsprof data when performing benchmark calls.
484
_gather_lsprof_in_benchmarks = False
486
def __init__(self, methodName='testMethod'):
487
super(TestCase, self).__init__(methodName)
491
unittest.TestCase.setUp(self)
492
self._cleanEnvironment()
493
bzrlib.trace.disable_default_logging()
495
self._benchcalls = []
496
self._benchtime = None
498
def _ndiff_strings(self, a, b):
499
"""Return ndiff between two strings containing lines.
501
A trailing newline is added if missing to make the strings
503
if b and b[-1] != '\n':
505
if a and a[-1] != '\n':
507
difflines = difflib.ndiff(a.splitlines(True),
509
linejunk=lambda x: False,
510
charjunk=lambda x: False)
511
return ''.join(difflines)
513
def assertEqualDiff(self, a, b, message=None):
514
"""Assert two texts are equal, if not raise an exception.
516
This is intended for use with multi-line strings where it can
517
be hard to find the differences by eye.
519
# TODO: perhaps override assertEquals to call this for strings?
523
message = "texts not equal:\n"
524
raise AssertionError(message +
525
self._ndiff_strings(a, b))
527
def assertEqualMode(self, mode, mode_test):
528
self.assertEqual(mode, mode_test,
529
'mode mismatch %o != %o' % (mode, mode_test))
531
def assertStartsWith(self, s, prefix):
532
if not s.startswith(prefix):
533
raise AssertionError('string %r does not start with %r' % (s, prefix))
535
def assertEndsWith(self, s, suffix):
536
"""Asserts that s ends with suffix."""
537
if not s.endswith(suffix):
538
raise AssertionError('string %r does not end with %r' % (s, suffix))
540
def assertContainsRe(self, haystack, needle_re):
541
"""Assert that a contains something matching a regular expression."""
542
if not re.search(needle_re, haystack):
543
raise AssertionError('pattern "%s" not found in "%s"'
544
% (needle_re, haystack))
546
def assertNotContainsRe(self, haystack, needle_re):
547
"""Assert that a does not match a regular expression"""
548
if re.search(needle_re, haystack):
549
raise AssertionError('pattern "%s" found in "%s"'
550
% (needle_re, haystack))
552
def assertSubset(self, sublist, superlist):
553
"""Assert that every entry in sublist is present in superlist."""
555
for entry in sublist:
556
if entry not in superlist:
557
missing.append(entry)
559
raise AssertionError("value(s) %r not present in container %r" %
560
(missing, superlist))
562
def assertIs(self, left, right):
563
if not (left is right):
564
raise AssertionError("%r is not %r." % (left, right))
566
def assertTransportMode(self, transport, path, mode):
567
"""Fail if a path does not have mode mode.
569
If modes are not supported on this transport, the assertion is ignored.
571
if not transport._can_roundtrip_unix_modebits():
573
path_stat = transport.stat(path)
574
actual_mode = stat.S_IMODE(path_stat.st_mode)
575
self.assertEqual(mode, actual_mode,
576
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
578
def assertIsInstance(self, obj, kls):
579
"""Fail if obj is not an instance of kls"""
580
if not isinstance(obj, kls):
581
self.fail("%r is an instance of %s rather than %s" % (
582
obj, obj.__class__, kls))
584
def _capture_warnings(self, a_callable, *args, **kwargs):
585
"""A helper for callDeprecated and applyDeprecated.
587
:param a_callable: A callable to call.
588
:param args: The positional arguments for the callable
589
:param kwargs: The keyword arguments for the callable
590
:return: A tuple (warnings, result). result is the result of calling
591
a_callable(*args, **kwargs).
594
def capture_warnings(msg, cls, stacklevel=None):
595
# we've hooked into a deprecation specific callpath,
596
# only deprecations should getting sent via it.
597
self.assertEqual(cls, DeprecationWarning)
598
local_warnings.append(msg)
599
original_warning_method = symbol_versioning.warn
600
symbol_versioning.set_warning_method(capture_warnings)
602
result = a_callable(*args, **kwargs)
604
symbol_versioning.set_warning_method(original_warning_method)
605
return (local_warnings, result)
607
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
608
"""Call a deprecated callable without warning the user.
610
:param deprecation_format: The deprecation format that the callable
611
should have been deprecated with. This is the same type as the
612
parameter to deprecated_method/deprecated_function. If the
613
callable is not deprecated with this format, an assertion error
615
:param a_callable: A callable to call. This may be a bound method or
616
a regular function. It will be called with *args and **kwargs.
617
:param args: The positional arguments for the callable
618
:param kwargs: The keyword arguments for the callable
619
:return: The result of a_callable(*args, **kwargs)
621
call_warnings, result = self._capture_warnings(a_callable,
623
expected_first_warning = symbol_versioning.deprecation_string(
624
a_callable, deprecation_format)
625
if len(call_warnings) == 0:
626
self.fail("No assertion generated by call to %s" %
628
self.assertEqual(expected_first_warning, call_warnings[0])
631
def callDeprecated(self, expected, callable, *args, **kwargs):
632
"""Assert that a callable is deprecated in a particular way.
634
This is a very precise test for unusual requirements. The
635
applyDeprecated helper function is probably more suited for most tests
636
as it allows you to simply specify the deprecation format being used
637
and will ensure that that is issued for the function being called.
639
:param expected: a list of the deprecation warnings expected, in order
640
:param callable: The callable to call
641
:param args: The positional arguments for the callable
642
:param kwargs: The keyword arguments for the callable
644
call_warnings, result = self._capture_warnings(callable,
646
self.assertEqual(expected, call_warnings)
649
def _startLogFile(self):
650
"""Send bzr and test log messages to a temporary file.
652
The file is removed as the test is torn down.
654
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
655
self._log_file = os.fdopen(fileno, 'w+')
656
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
657
self._log_file_name = name
658
self.addCleanup(self._finishLogFile)
660
def _finishLogFile(self):
661
"""Finished with the log file.
663
Read contents into memory, close, and delete.
665
if self._log_file is None:
667
bzrlib.trace.disable_test_log(self._log_nonce)
668
self._log_file.seek(0)
669
self._log_contents = self._log_file.read()
670
self._log_file.close()
671
os.remove(self._log_file_name)
672
self._log_file = self._log_file_name = None
674
def addCleanup(self, callable):
675
"""Arrange to run a callable when this case is torn down.
677
Callables are run in the reverse of the order they are registered,
678
ie last-in first-out.
680
if callable in self._cleanups:
681
raise ValueError("cleanup function %r already registered on %s"
683
self._cleanups.append(callable)
685
def _cleanEnvironment(self):
688
'APPDATA': os.getcwd(),
690
'BZREMAIL': None, # may still be present in the environment
692
'BZR_PROGRESS_BAR': None,
695
self.addCleanup(self._restoreEnvironment)
696
for name, value in new_env.iteritems():
697
self._captureVar(name, value)
699
def _captureVar(self, name, newvalue):
700
"""Set an environment variable, and reset it when finished."""
701
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
703
def _restoreEnvironment(self):
704
for name, value in self.__old_env.iteritems():
705
osutils.set_or_unset_env(name, value)
709
unittest.TestCase.tearDown(self)
711
def time(self, callable, *args, **kwargs):
712
"""Run callable and accrue the time it takes to the benchmark time.
714
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
715
this will cause lsprofile statistics to be gathered and stored in
718
if self._benchtime is None:
722
if not self._gather_lsprof_in_benchmarks:
723
return callable(*args, **kwargs)
725
# record this benchmark
726
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
728
self._benchcalls.append(((callable, args, kwargs), stats))
731
self._benchtime += time.time() - start
733
def _runCleanups(self):
734
"""Run registered cleanup functions.
736
This should only be called from TestCase.tearDown.
738
# TODO: Perhaps this should keep running cleanups even if
740
for cleanup_fn in reversed(self._cleanups):
743
def log(self, *args):
747
"""Return as a string the log for this test"""
748
if self._log_file_name:
749
return open(self._log_file_name).read()
751
return self._log_contents
752
# TODO: Delete the log after it's been read in
754
def capture(self, cmd, retcode=0):
755
"""Shortcut that splits cmd into words, runs, and returns stdout"""
756
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
758
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None):
759
"""Invoke bzr and return (stdout, stderr).
761
Useful for code that wants to check the contents of the
762
output, the way error messages are presented, etc.
764
This should be the main method for tests that want to exercise the
765
overall behavior of the bzr application (rather than a unit test
766
or a functional test of the library.)
768
Much of the old code runs bzr by forking a new copy of Python, but
769
that is slower, harder to debug, and generally not necessary.
771
This runs bzr through the interface that catches and reports
772
errors, and with logging set to something approximating the
773
default, so that error reporting can be checked.
775
:param argv: arguments to invoke bzr
776
:param retcode: expected return code, or None for don't-care.
777
:param encoding: encoding for sys.stdout and sys.stderr
778
:param stdin: A string to be used as stdin for the command.
781
encoding = bzrlib.user_encoding
782
if stdin is not None:
783
stdin = StringIO(stdin)
784
stdout = StringIOWrapper()
785
stderr = StringIOWrapper()
786
stdout.encoding = encoding
787
stderr.encoding = encoding
789
self.log('run bzr: %r', argv)
790
# FIXME: don't call into logging here
791
handler = logging.StreamHandler(stderr)
792
handler.setLevel(logging.INFO)
793
logger = logging.getLogger('')
794
logger.addHandler(handler)
795
old_ui_factory = bzrlib.ui.ui_factory
796
bzrlib.ui.ui_factory = bzrlib.tests.blackbox.TestUIFactory(
799
bzrlib.ui.ui_factory.stdin = stdin
801
result = self.apply_redirected(stdin, stdout, stderr,
802
bzrlib.commands.run_bzr_catch_errors,
805
logger.removeHandler(handler)
806
bzrlib.ui.ui_factory = old_ui_factory
808
out = stdout.getvalue()
809
err = stderr.getvalue()
811
self.log('output:\n%r', out)
813
self.log('errors:\n%r', err)
814
if retcode is not None:
815
self.assertEquals(retcode, result)
818
def run_bzr(self, *args, **kwargs):
819
"""Invoke bzr, as if it were run from the command line.
821
This should be the main method for tests that want to exercise the
822
overall behavior of the bzr application (rather than a unit test
823
or a functional test of the library.)
825
This sends the stdout/stderr results into the test's log,
826
where it may be useful for debugging. See also run_captured.
828
:param stdin: A string to be used as stdin for the command.
830
retcode = kwargs.pop('retcode', 0)
831
encoding = kwargs.pop('encoding', None)
832
stdin = kwargs.pop('stdin', None)
833
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding, stdin=stdin)
835
def run_bzr_decode(self, *args, **kwargs):
836
if 'encoding' in kwargs:
837
encoding = kwargs['encoding']
839
encoding = bzrlib.user_encoding
840
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
842
def run_bzr_error(self, error_regexes, *args, **kwargs):
843
"""Run bzr, and check that stderr contains the supplied regexes
845
:param error_regexes: Sequence of regular expressions which
846
must each be found in the error output. The relative ordering
848
:param args: command-line arguments for bzr
849
:param kwargs: Keyword arguments which are interpreted by run_bzr
850
This function changes the default value of retcode to be 3,
851
since in most cases this is run when you expect bzr to fail.
852
:return: (out, err) The actual output of running the command (in case you
853
want to do more inspection)
856
# Make sure that commit is failing because there is nothing to do
857
self.run_bzr_error(['no changes to commit'],
858
'commit', '-m', 'my commit comment')
859
# Make sure --strict is handling an unknown file, rather than
860
# giving us the 'nothing to do' error
861
self.build_tree(['unknown'])
862
self.run_bzr_error(['Commit refused because there are unknown files'],
863
'commit', '--strict', '-m', 'my commit comment')
865
kwargs.setdefault('retcode', 3)
866
out, err = self.run_bzr(*args, **kwargs)
867
for regex in error_regexes:
868
self.assertContainsRe(err, regex)
871
def run_bzr_subprocess(self, *args, **kwargs):
872
"""Run bzr in a subprocess for testing.
874
This starts a new Python interpreter and runs bzr in there.
875
This should only be used for tests that have a justifiable need for
876
this isolation: e.g. they are testing startup time, or signal
877
handling, or early startup code, etc. Subprocess code can't be
878
profiled or debugged so easily.
880
:param retcode: The status code that is expected. Defaults to 0. If
881
None is supplied, the status code is not checked.
882
:param env_changes: A dictionary which lists changes to environment
883
variables. A value of None will unset the env variable.
884
The values must be strings. The change will only occur in the
885
child, so you don't need to fix the environment after running.
886
:param universal_newlines: Convert CRLF => LF
888
env_changes = kwargs.get('env_changes', {})
892
def cleanup_environment():
893
for env_var, value in env_changes.iteritems():
894
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
896
def restore_environment():
897
for env_var, value in old_env.iteritems():
898
osutils.set_or_unset_env(env_var, value)
900
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
901
if not os.path.isfile(bzr_path):
902
# We are probably installed. Assume sys.argv is the right file
903
bzr_path = sys.argv[0]
907
# win32 subprocess doesn't support preexec_fn
908
# so we will avoid using it on all platforms, just to
909
# make sure the code path is used, and we don't break on win32
910
cleanup_environment()
911
process = Popen([sys.executable, bzr_path]+args,
912
stdout=PIPE, stderr=PIPE)
914
restore_environment()
916
out = process.stdout.read()
917
err = process.stderr.read()
919
if kwargs.get('universal_newlines', False):
920
out = out.replace('\r\n', '\n')
921
err = err.replace('\r\n', '\n')
923
retcode = process.wait()
924
supplied_retcode = kwargs.get('retcode', 0)
925
if supplied_retcode is not None:
926
assert supplied_retcode == retcode
929
def check_inventory_shape(self, inv, shape):
930
"""Compare an inventory to a list of expected names.
932
Fail if they are not precisely equal.
935
shape = list(shape) # copy
936
for path, ie in inv.entries():
937
name = path.replace('\\', '/')
945
self.fail("expected paths not found in inventory: %r" % shape)
947
self.fail("unexpected paths found in inventory: %r" % extras)
949
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
950
a_callable=None, *args, **kwargs):
951
"""Call callable with redirected std io pipes.
953
Returns the return code."""
954
if not callable(a_callable):
955
raise ValueError("a_callable must be callable.")
959
if getattr(self, "_log_file", None) is not None:
960
stdout = self._log_file
964
if getattr(self, "_log_file", None is not None):
965
stderr = self._log_file
968
real_stdin = sys.stdin
969
real_stdout = sys.stdout
970
real_stderr = sys.stderr
975
return a_callable(*args, **kwargs)
977
sys.stdout = real_stdout
978
sys.stderr = real_stderr
979
sys.stdin = real_stdin
981
@symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
982
def merge(self, branch_from, wt_to):
983
"""A helper for tests to do a ui-less merge.
985
This should move to the main library when someone has time to integrate
988
# minimal ui-less merge.
989
wt_to.branch.fetch(branch_from)
990
base_rev = common_ancestor(branch_from.last_revision(),
991
wt_to.branch.last_revision(),
992
wt_to.branch.repository)
993
merge_inner(wt_to.branch, branch_from.basis_tree(),
994
wt_to.branch.repository.revision_tree(base_rev),
996
wt_to.add_parent_tree_id(branch_from.last_revision())
999
BzrTestBase = TestCase
1002
class TestCaseInTempDir(TestCase):
1003
"""Derived class that runs a test within a temporary directory.
1005
This is useful for tests that need to create a branch, etc.
1007
The directory is created in a slightly complex way: for each
1008
Python invocation, a new temporary top-level directory is created.
1009
All test cases create their own directory within that. If the
1010
tests complete successfully, the directory is removed.
1012
InTempDir is an old alias for FunctionalTestCase.
1017
OVERRIDE_PYTHON = 'python'
1019
def check_file_contents(self, filename, expect):
1020
self.log("check contents of file %s" % filename)
1021
contents = file(filename, 'r').read()
1022
if contents != expect:
1023
self.log("expected: %r" % expect)
1024
self.log("actually: %r" % contents)
1025
self.fail("contents of %s not as expected" % filename)
1027
def _make_test_root(self):
1028
if TestCaseInTempDir.TEST_ROOT is not None:
1032
root = u'test%04d.tmp' % i
1036
if e.errno == errno.EEXIST:
1041
# successfully created
1042
TestCaseInTempDir.TEST_ROOT = osutils.abspath(root)
1044
# make a fake bzr directory there to prevent any tests propagating
1045
# up onto the source directory's real branch
1046
bzrdir.BzrDir.create_standalone_workingtree(TestCaseInTempDir.TEST_ROOT)
1049
super(TestCaseInTempDir, self).setUp()
1050
self._make_test_root()
1051
_currentdir = os.getcwdu()
1052
# shorten the name, to avoid test failures due to path length
1053
short_id = self.id().replace('bzrlib.tests.', '') \
1054
.replace('__main__.', '')[-100:]
1055
# it's possible the same test class is run several times for
1056
# parameterized tests, so make sure the names don't collide.
1060
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1062
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1063
if os.path.exists(candidate_dir):
1067
os.mkdir(candidate_dir)
1068
self.test_home_dir = candidate_dir + '/home'
1069
os.mkdir(self.test_home_dir)
1070
self.test_dir = candidate_dir + '/work'
1071
os.mkdir(self.test_dir)
1072
os.chdir(self.test_dir)
1074
os.environ['HOME'] = self.test_home_dir
1075
os.environ['APPDATA'] = self.test_home_dir
1076
def _leaveDirectory():
1077
os.chdir(_currentdir)
1078
self.addCleanup(_leaveDirectory)
1080
def build_tree(self, shape, line_endings='native', transport=None):
1081
"""Build a test tree according to a pattern.
1083
shape is a sequence of file specifications. If the final
1084
character is '/', a directory is created.
1086
This assumes that all the elements in the tree being built are new.
1088
This doesn't add anything to a branch.
1089
:param line_endings: Either 'binary' or 'native'
1090
in binary mode, exact contents are written
1091
in native mode, the line endings match the
1092
default platform endings.
1094
:param transport: A transport to write to, for building trees on
1095
VFS's. If the transport is readonly or None,
1096
"." is opened automatically.
1098
# It's OK to just create them using forward slashes on windows.
1099
if transport is None or transport.is_readonly():
1100
transport = get_transport(".")
1102
self.assert_(isinstance(name, basestring))
1104
transport.mkdir(urlutils.escape(name[:-1]))
1106
if line_endings == 'binary':
1108
elif line_endings == 'native':
1111
raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
1112
content = "contents of %s%s" % (name.encode('utf-8'), end)
1113
# Technically 'put()' is the right command. However, put
1114
# uses an AtomicFile, which requires an extra rename into place
1115
# As long as the files didn't exist in the past, append() will
1116
# do the same thing as put()
1117
# On jam's machine, make_kernel_like_tree is:
1118
# put: 4.5-7.5s (averaging 6s)
1120
# put_non_atomic: 2.9-4.5s
1121
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1123
def build_tree_contents(self, shape):
1124
build_tree_contents(shape)
1126
def failUnlessExists(self, path):
1127
"""Fail unless path, which may be abs or relative, exists."""
1128
self.failUnless(osutils.lexists(path))
1130
def failIfExists(self, path):
1131
"""Fail if path, which may be abs or relative, exists."""
1132
self.failIf(osutils.lexists(path))
1134
def assertFileEqual(self, content, path):
1135
"""Fail if path does not contain 'content'."""
1136
self.failUnless(osutils.lexists(path))
1137
# TODO: jam 20060427 Shouldn't this be 'rb'?
1138
self.assertEqualDiff(content, open(path, 'r').read())
1141
class TestCaseWithTransport(TestCaseInTempDir):
1142
"""A test case that provides get_url and get_readonly_url facilities.
1144
These back onto two transport servers, one for readonly access and one for
1147
If no explicit class is provided for readonly access, a
1148
ReadonlyTransportDecorator is used instead which allows the use of non disk
1149
based read write transports.
1151
If an explicit class is provided for readonly access, that server and the
1152
readwrite one must both define get_url() as resolving to os.getcwd().
1155
def __init__(self, methodName='testMethod'):
1156
super(TestCaseWithTransport, self).__init__(methodName)
1157
self.__readonly_server = None
1158
self.__server = None
1159
self.transport_server = default_transport
1160
self.transport_readonly_server = None
1162
def get_readonly_url(self, relpath=None):
1163
"""Get a URL for the readonly transport.
1165
This will either be backed by '.' or a decorator to the transport
1166
used by self.get_url()
1167
relpath provides for clients to get a path relative to the base url.
1168
These should only be downwards relative, not upwards.
1170
base = self.get_readonly_server().get_url()
1171
if relpath is not None:
1172
if not base.endswith('/'):
1174
base = base + relpath
1177
def get_readonly_server(self):
1178
"""Get the server instance for the readonly transport
1180
This is useful for some tests with specific servers to do diagnostics.
1182
if self.__readonly_server is None:
1183
if self.transport_readonly_server is None:
1184
# readonly decorator requested
1185
# bring up the server
1187
self.__readonly_server = ReadonlyServer()
1188
self.__readonly_server.setUp(self.__server)
1190
self.__readonly_server = self.transport_readonly_server()
1191
self.__readonly_server.setUp()
1192
self.addCleanup(self.__readonly_server.tearDown)
1193
return self.__readonly_server
1195
def get_server(self):
1196
"""Get the read/write server instance.
1198
This is useful for some tests with specific servers that need
1201
if self.__server is None:
1202
self.__server = self.transport_server()
1203
self.__server.setUp()
1204
self.addCleanup(self.__server.tearDown)
1205
return self.__server
1207
def get_url(self, relpath=None):
1208
"""Get a URL for the readwrite transport.
1210
This will either be backed by '.' or to an equivalent non-file based
1212
relpath provides for clients to get a path relative to the base url.
1213
These should only be downwards relative, not upwards.
1215
base = self.get_server().get_url()
1216
if relpath is not None and relpath != '.':
1217
if not base.endswith('/'):
1219
base = base + urlutils.escape(relpath)
1222
def get_transport(self):
1223
"""Return a writeable transport for the test scratch space"""
1224
t = get_transport(self.get_url())
1225
self.assertFalse(t.is_readonly())
1228
def get_readonly_transport(self):
1229
"""Return a readonly transport for the test scratch space
1231
This can be used to test that operations which should only need
1232
readonly access in fact do not try to write.
1234
t = get_transport(self.get_readonly_url())
1235
self.assertTrue(t.is_readonly())
1238
def make_branch(self, relpath, format=None):
1239
"""Create a branch on the transport at relpath."""
1240
repo = self.make_repository(relpath, format=format)
1241
return repo.bzrdir.create_branch()
1243
def make_bzrdir(self, relpath, format=None):
1245
url = self.get_url(relpath)
1246
mutter('relpath %r => url %r', relpath, url)
1247
segments = url.split('/')
1248
if segments and segments[-1] not in ('', '.'):
1249
parent = '/'.join(segments[:-1])
1250
t = get_transport(parent)
1252
t.mkdir(segments[-1])
1253
except errors.FileExists:
1256
format=bzrlib.bzrdir.BzrDirFormat.get_default_format()
1257
# FIXME: make this use a single transport someday. RBC 20060418
1258
return format.initialize_on_transport(get_transport(relpath))
1259
except errors.UninitializableFormat:
1260
raise TestSkipped("Format %s is not initializable." % format)
1262
def make_repository(self, relpath, shared=False, format=None):
1263
"""Create a repository on our default transport at relpath."""
1264
made_control = self.make_bzrdir(relpath, format=format)
1265
return made_control.create_repository(shared=shared)
1267
def make_branch_and_tree(self, relpath, format=None):
1268
"""Create a branch on the transport and a tree locally.
1272
# TODO: always use the local disk path for the working tree,
1273
# this obviously requires a format that supports branch references
1274
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1276
b = self.make_branch(relpath, format=format)
1278
return b.bzrdir.create_workingtree()
1279
except errors.NotLocalUrl:
1280
# new formats - catch No tree error and create
1281
# a branch reference and a checkout.
1282
# old formats at that point - raise TestSkipped.
1283
# TODO: rbc 20060208
1284
return WorkingTreeFormat2().initialize(bzrdir.BzrDir.open(relpath))
1286
def assertIsDirectory(self, relpath, transport):
1287
"""Assert that relpath within transport is a directory.
1289
This may not be possible on all transports; in that case it propagates
1290
a TransportNotPossible.
1293
mode = transport.stat(relpath).st_mode
1294
except errors.NoSuchFile:
1295
self.fail("path %s is not a directory; no such file"
1297
if not stat.S_ISDIR(mode):
1298
self.fail("path %s is not a directory; has mode %#o"
1302
class ChrootedTestCase(TestCaseWithTransport):
1303
"""A support class that provides readonly urls outside the local namespace.
1305
This is done by checking if self.transport_server is a MemoryServer. if it
1306
is then we are chrooted already, if it is not then an HttpServer is used
1309
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1310
be used without needed to redo it when a different
1311
subclass is in use ?
1315
super(ChrootedTestCase, self).setUp()
1316
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
1317
self.transport_readonly_server = bzrlib.transport.http.HttpServer
1320
def filter_suite_by_re(suite, pattern):
1321
result = TestUtil.TestSuite()
1322
filter_re = re.compile(pattern)
1323
for test in iter_suite_tests(suite):
1324
if filter_re.search(test.id()):
1325
result.addTest(test)
1329
def run_suite(suite, name='test', verbose=False, pattern=".*",
1330
stop_on_failure=False, keep_output=False,
1331
transport=None, lsprof_timed=None, bench_history=None):
1332
TestCaseInTempDir._TEST_NAME = name
1333
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1339
pb = progress.ProgressBar()
1340
runner = TextTestRunner(stream=sys.stdout,
1342
verbosity=verbosity,
1343
keep_output=keep_output,
1345
bench_history=bench_history)
1346
runner.stop_on_failure=stop_on_failure
1348
suite = filter_suite_by_re(suite, pattern)
1349
result = runner.run(suite)
1350
return result.wasSuccessful()
1353
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1356
test_suite_factory=None,
1358
bench_history=None):
1359
"""Run the whole test suite under the enhanced runner"""
1360
# XXX: Very ugly way to do this...
1361
# Disable warning about old formats because we don't want it to disturb
1362
# any blackbox tests.
1363
from bzrlib import repository
1364
repository._deprecation_warning_done = True
1366
global default_transport
1367
if transport is None:
1368
transport = default_transport
1369
old_transport = default_transport
1370
default_transport = transport
1372
if test_suite_factory is None:
1373
suite = test_suite()
1375
suite = test_suite_factory()
1376
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1377
stop_on_failure=stop_on_failure, keep_output=keep_output,
1378
transport=transport,
1379
lsprof_timed=lsprof_timed,
1380
bench_history=bench_history)
1382
default_transport = old_transport
1386
"""Build and return TestSuite for the whole of bzrlib.
1388
This function can be replaced if you need to change the default test
1389
suite on a global basis, but it is not encouraged.
1392
'bzrlib.tests.test_ancestry',
1393
'bzrlib.tests.test_api',
1394
'bzrlib.tests.test_atomicfile',
1395
'bzrlib.tests.test_bad_files',
1396
'bzrlib.tests.test_branch',
1397
'bzrlib.tests.test_bundle',
1398
'bzrlib.tests.test_bzrdir',
1399
'bzrlib.tests.test_cache_utf8',
1400
'bzrlib.tests.test_command',
1401
'bzrlib.tests.test_commit',
1402
'bzrlib.tests.test_commit_merge',
1403
'bzrlib.tests.test_config',
1404
'bzrlib.tests.test_conflicts',
1405
'bzrlib.tests.test_decorators',
1406
'bzrlib.tests.test_diff',
1407
'bzrlib.tests.test_doc_generate',
1408
'bzrlib.tests.test_errors',
1409
'bzrlib.tests.test_escaped_store',
1410
'bzrlib.tests.test_fetch',
1411
'bzrlib.tests.test_gpg',
1412
'bzrlib.tests.test_graph',
1413
'bzrlib.tests.test_hashcache',
1414
'bzrlib.tests.test_http',
1415
'bzrlib.tests.test_http_response',
1416
'bzrlib.tests.test_identitymap',
1417
'bzrlib.tests.test_ignores',
1418
'bzrlib.tests.test_inv',
1419
'bzrlib.tests.test_knit',
1420
'bzrlib.tests.test_lockdir',
1421
'bzrlib.tests.test_lockable_files',
1422
'bzrlib.tests.test_log',
1423
'bzrlib.tests.test_merge',
1424
'bzrlib.tests.test_merge3',
1425
'bzrlib.tests.test_merge_core',
1426
'bzrlib.tests.test_missing',
1427
'bzrlib.tests.test_msgeditor',
1428
'bzrlib.tests.test_nonascii',
1429
'bzrlib.tests.test_options',
1430
'bzrlib.tests.test_osutils',
1431
'bzrlib.tests.test_patch',
1432
'bzrlib.tests.test_patches',
1433
'bzrlib.tests.test_permissions',
1434
'bzrlib.tests.test_plugins',
1435
'bzrlib.tests.test_progress',
1436
'bzrlib.tests.test_reconcile',
1437
'bzrlib.tests.test_repository',
1438
'bzrlib.tests.test_revert',
1439
'bzrlib.tests.test_revision',
1440
'bzrlib.tests.test_revisionnamespaces',
1441
'bzrlib.tests.test_revisiontree',
1442
'bzrlib.tests.test_rio',
1443
'bzrlib.tests.test_sampler',
1444
'bzrlib.tests.test_selftest',
1445
'bzrlib.tests.test_setup',
1446
'bzrlib.tests.test_sftp_transport',
1447
'bzrlib.tests.test_ftp_transport',
1448
'bzrlib.tests.test_smart_add',
1449
'bzrlib.tests.test_source',
1450
'bzrlib.tests.test_status',
1451
'bzrlib.tests.test_store',
1452
'bzrlib.tests.test_symbol_versioning',
1453
'bzrlib.tests.test_testament',
1454
'bzrlib.tests.test_textfile',
1455
'bzrlib.tests.test_textmerge',
1456
'bzrlib.tests.test_trace',
1457
'bzrlib.tests.test_transactions',
1458
'bzrlib.tests.test_transform',
1459
'bzrlib.tests.test_transport',
1460
'bzrlib.tests.test_tree',
1461
'bzrlib.tests.test_tsort',
1462
'bzrlib.tests.test_tuned_gzip',
1463
'bzrlib.tests.test_ui',
1464
'bzrlib.tests.test_upgrade',
1465
'bzrlib.tests.test_urlutils',
1466
'bzrlib.tests.test_versionedfile',
1467
'bzrlib.tests.test_version',
1468
'bzrlib.tests.test_weave',
1469
'bzrlib.tests.test_whitebox',
1470
'bzrlib.tests.test_workingtree',
1471
'bzrlib.tests.test_xml',
1473
test_transport_implementations = [
1474
'bzrlib.tests.test_transport_implementations',
1475
'bzrlib.tests.test_read_bundle',
1477
suite = TestUtil.TestSuite()
1478
loader = TestUtil.TestLoader()
1479
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1480
from bzrlib.transport import TransportTestProviderAdapter
1481
adapter = TransportTestProviderAdapter()
1482
adapt_modules(test_transport_implementations, adapter, loader, suite)
1483
for package in packages_to_test():
1484
suite.addTest(package.test_suite())
1485
for m in MODULES_TO_TEST:
1486
suite.addTest(loader.loadTestsFromModule(m))
1487
for m in MODULES_TO_DOCTEST:
1488
suite.addTest(doctest.DocTestSuite(m))
1489
for name, plugin in bzrlib.plugin.all_plugins().items():
1490
if getattr(plugin, 'test_suite', None) is not None:
1491
suite.addTest(plugin.test_suite())
1495
def adapt_modules(mods_list, adapter, loader, suite):
1496
"""Adapt the modules in mods_list using adapter and add to suite."""
1497
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1498
suite.addTests(adapter.adapt(test))
added
removed
bzrlib/tests/__init__.py
