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()
153
revision_id = src_tree.last_revision()
155
# XXX: If there's no branch, what should we do?
157
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
158
self._bench_history = bench_history
160
def extractBenchmarkTime(self, testCase):
161
"""Add a benchmark time for the current test case."""
162
self._benchmarkTime = getattr(testCase, "_benchtime", None)
164
def _elapsedTestTimeString(self):
165
"""Return a time string for the overall time the current test has taken."""
166
return self._formatTime(time.time() - self._start_time)
168
def _testTimeString(self):
169
if self._benchmarkTime is not None:
171
self._formatTime(self._benchmarkTime),
172
self._elapsedTestTimeString())
174
return " %s" % self._elapsedTestTimeString()
176
def _formatTime(self, seconds):
177
"""Format seconds as milliseconds with leading spaces."""
178
return "%5dms" % (1000 * seconds)
180
def _ellipsise_unimportant_words(self, a_string, final_width,
182
"""Add ellipses (sp?) for overly long strings.
184
:param keep_start: If true preserve the start of a_string rather
188
if len(a_string) > final_width:
189
result = a_string[:final_width-3] + '...'
193
if len(a_string) > final_width:
194
result = '...' + a_string[3-final_width:]
197
return result.ljust(final_width)
199
def startTest(self, test):
200
unittest.TestResult.startTest(self, test)
201
# In a short description, the important words are in
202
# the beginning, but in an id, the important words are
204
SHOW_DESCRIPTIONS = False
206
if not self.showAll and self.dots and self.pb is not None:
209
final_width = osutils.terminal_width()
210
final_width = final_width - 15 - 8
212
if SHOW_DESCRIPTIONS:
213
what = test.shortDescription()
215
what = self._ellipsise_unimportant_words(what, final_width, keep_start=True)
218
if what.startswith('bzrlib.tests.'):
220
what = self._ellipsise_unimportant_words(what, final_width)
222
self.stream.write(what)
223
elif self.dots and self.pb is not None:
224
self.pb.update(what, self.testsRun - 1, None)
226
self._recordTestStartTime()
228
def _recordTestStartTime(self):
229
"""Record that a test has started."""
230
self._start_time = time.time()
232
def addError(self, test, err):
233
if isinstance(err[1], TestSkipped):
234
return self.addSkipped(test, err)
235
unittest.TestResult.addError(self, test, err)
236
self.extractBenchmarkTime(test)
238
self.stream.writeln("ERROR %s" % self._testTimeString())
239
elif self.dots and self.pb is None:
240
self.stream.write('E')
242
self.pb.update(self._ellipsise_unimportant_words('ERROR', 13), self.testsRun, None)
243
self.pb.note(self._ellipsise_unimportant_words(
244
test.id() + ': ERROR',
245
osutils.terminal_width()))
250
def addFailure(self, test, err):
251
unittest.TestResult.addFailure(self, test, err)
252
self.extractBenchmarkTime(test)
254
self.stream.writeln(" FAIL %s" % self._testTimeString())
255
elif self.dots and self.pb is None:
256
self.stream.write('F')
258
self.pb.update(self._ellipsise_unimportant_words('FAIL', 13), self.testsRun, None)
259
self.pb.note(self._ellipsise_unimportant_words(
260
test.id() + ': FAIL',
261
osutils.terminal_width()))
266
def addSuccess(self, test):
267
self.extractBenchmarkTime(test)
268
if self._bench_history is not None:
269
if self._benchmarkTime is not None:
270
self._bench_history.write("%s %s\n" % (
271
self._formatTime(self._benchmarkTime),
274
self.stream.writeln(' OK %s' % self._testTimeString())
275
for bench_called, stats in getattr(test, '_benchcalls', []):
276
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
277
stats.pprint(file=self.stream)
278
elif self.dots and self.pb is None:
279
self.stream.write('~')
281
self.pb.update(self._ellipsise_unimportant_words('OK', 13), self.testsRun, None)
283
unittest.TestResult.addSuccess(self, test)
285
def addSkipped(self, test, skip_excinfo):
286
self.extractBenchmarkTime(test)
288
print >>self.stream, ' SKIP %s' % self._testTimeString()
289
print >>self.stream, ' %s' % skip_excinfo[1]
290
elif self.dots and self.pb is None:
291
self.stream.write('S')
293
self.pb.update(self._ellipsise_unimportant_words('SKIP', 13), self.testsRun, None)
295
# seems best to treat this as success from point-of-view of unittest
296
# -- it actually does nothing so it barely matters :)
299
except KeyboardInterrupt:
302
self.addError(test, test.__exc_info())
304
unittest.TestResult.addSuccess(self, test)
306
def printErrorList(self, flavour, errors):
307
for test, err in errors:
308
self.stream.writeln(self.separator1)
309
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
310
if getattr(test, '_get_log', None) is not None:
312
print >>self.stream, \
313
('vvvv[log from %s]' % test.id()).ljust(78,'-')
314
print >>self.stream, test._get_log()
315
print >>self.stream, \
316
('^^^^[log from %s]' % test.id()).ljust(78,'-')
317
self.stream.writeln(self.separator2)
318
self.stream.writeln("%s" % err)
321
class TextTestRunner(object):
322
stop_on_failure = False
331
self.stream = unittest._WritelnDecorator(stream)
332
self.descriptions = descriptions
333
self.verbosity = verbosity
334
self.keep_output = keep_output
336
self._bench_history = bench_history
338
def _makeResult(self):
339
result = _MyResult(self.stream,
343
bench_history=self._bench_history)
344
result.stop_early = self.stop_on_failure
348
"Run the given test case or test suite."
349
result = self._makeResult()
350
startTime = time.time()
351
if self.pb is not None:
352
self.pb.update('Running tests', 0, test.countTestCases())
354
stopTime = time.time()
355
timeTaken = stopTime - startTime
357
self.stream.writeln(result.separator2)
358
run = result.testsRun
359
self.stream.writeln("Ran %d test%s in %.3fs" %
360
(run, run != 1 and "s" or "", timeTaken))
361
self.stream.writeln()
362
if not result.wasSuccessful():
363
self.stream.write("FAILED (")
364
failed, errored = map(len, (result.failures, result.errors))
366
self.stream.write("failures=%d" % failed)
368
if failed: self.stream.write(", ")
369
self.stream.write("errors=%d" % errored)
370
self.stream.writeln(")")
372
self.stream.writeln("OK")
373
if self.pb is not None:
374
self.pb.update('Cleaning up', 0, 1)
375
# This is still a little bogus,
376
# but only a little. Folk not using our testrunner will
377
# have to delete their temp directories themselves.
378
test_root = TestCaseInTempDir.TEST_ROOT
379
if result.wasSuccessful() or not self.keep_output:
380
if test_root is not None:
381
# If LANG=C we probably have created some bogus paths
382
# which rmtree(unicode) will fail to delete
383
# so make sure we are using rmtree(str) to delete everything
384
# except on win32, where rmtree(str) will fail
385
# since it doesn't have the property of byte-stream paths
386
# (they are either ascii or mbcs)
387
if sys.platform == 'win32':
388
# make sure we are using the unicode win32 api
389
test_root = unicode(test_root)
391
test_root = test_root.encode(
392
sys.getfilesystemencoding())
393
osutils.rmtree(test_root)
395
if self.pb is not None:
396
self.pb.note("Failed tests working directories are in '%s'\n",
400
"Failed tests working directories are in '%s'\n" %
402
TestCaseInTempDir.TEST_ROOT = None
403
if self.pb is not None:
408
def iter_suite_tests(suite):
409
"""Return all tests in a suite, recursing through nested suites"""
410
for item in suite._tests:
411
if isinstance(item, unittest.TestCase):
413
elif isinstance(item, unittest.TestSuite):
414
for r in iter_suite_tests(item):
417
raise Exception('unknown object %r inside test suite %r'
421
class TestSkipped(Exception):
422
"""Indicates that a test was intentionally skipped, rather than failing."""
425
class CommandFailed(Exception):
429
class StringIOWrapper(object):
430
"""A wrapper around cStringIO which just adds an encoding attribute.
432
Internally we can check sys.stdout to see what the output encoding
433
should be. However, cStringIO has no encoding attribute that we can
434
set. So we wrap it instead.
439
def __init__(self, s=None):
441
self.__dict__['_cstring'] = StringIO(s)
443
self.__dict__['_cstring'] = StringIO()
445
def __getattr__(self, name, getattr=getattr):
446
return getattr(self.__dict__['_cstring'], name)
448
def __setattr__(self, name, val):
449
if name == 'encoding':
450
self.__dict__['encoding'] = val
452
return setattr(self._cstring, name, val)
455
class TestCase(unittest.TestCase):
456
"""Base class for bzr unit tests.
458
Tests that need access to disk resources should subclass
459
TestCaseInTempDir not TestCase.
461
Error and debug log messages are redirected from their usual
462
location into a temporary file, the contents of which can be
463
retrieved by _get_log(). We use a real OS file, not an in-memory object,
464
so that it can also capture file IO. When the test completes this file
465
is read into memory and removed from disk.
467
There are also convenience functions to invoke bzr's command-line
468
routine, and to build and check bzr trees.
470
In addition to the usual method of overriding tearDown(), this class also
471
allows subclasses to register functions into the _cleanups list, which is
472
run in order as the object is torn down. It's less likely this will be
473
accidentally overlooked.
476
_log_file_name = None
478
# record lsprof data when performing benchmark calls.
479
_gather_lsprof_in_benchmarks = False
481
def __init__(self, methodName='testMethod'):
482
super(TestCase, self).__init__(methodName)
486
unittest.TestCase.setUp(self)
487
self._cleanEnvironment()
488
bzrlib.trace.disable_default_logging()
490
self._benchcalls = []
491
self._benchtime = None
493
def _ndiff_strings(self, a, b):
494
"""Return ndiff between two strings containing lines.
496
A trailing newline is added if missing to make the strings
498
if b and b[-1] != '\n':
500
if a and a[-1] != '\n':
502
difflines = difflib.ndiff(a.splitlines(True),
504
linejunk=lambda x: False,
505
charjunk=lambda x: False)
506
return ''.join(difflines)
508
def assertEqualDiff(self, a, b, message=None):
509
"""Assert two texts are equal, if not raise an exception.
511
This is intended for use with multi-line strings where it can
512
be hard to find the differences by eye.
514
# TODO: perhaps override assertEquals to call this for strings?
518
message = "texts not equal:\n"
519
raise AssertionError(message +
520
self._ndiff_strings(a, b))
522
def assertEqualMode(self, mode, mode_test):
523
self.assertEqual(mode, mode_test,
524
'mode mismatch %o != %o' % (mode, mode_test))
526
def assertStartsWith(self, s, prefix):
527
if not s.startswith(prefix):
528
raise AssertionError('string %r does not start with %r' % (s, prefix))
530
def assertEndsWith(self, s, suffix):
531
"""Asserts that s ends with suffix."""
532
if not s.endswith(suffix):
533
raise AssertionError('string %r does not end with %r' % (s, suffix))
535
def assertContainsRe(self, haystack, needle_re):
536
"""Assert that a contains something matching a regular expression."""
537
if not re.search(needle_re, haystack):
538
raise AssertionError('pattern "%s" not found in "%s"'
539
% (needle_re, haystack))
541
def assertNotContainsRe(self, haystack, needle_re):
542
"""Assert that a does not match a regular expression"""
543
if re.search(needle_re, haystack):
544
raise AssertionError('pattern "%s" found in "%s"'
545
% (needle_re, haystack))
547
def assertSubset(self, sublist, superlist):
548
"""Assert that every entry in sublist is present in superlist."""
550
for entry in sublist:
551
if entry not in superlist:
552
missing.append(entry)
554
raise AssertionError("value(s) %r not present in container %r" %
555
(missing, superlist))
557
def assertIs(self, left, right):
558
if not (left is right):
559
raise AssertionError("%r is not %r." % (left, right))
561
def assertTransportMode(self, transport, path, mode):
562
"""Fail if a path does not have mode mode.
564
If modes are not supported on this transport, the assertion is ignored.
566
if not transport._can_roundtrip_unix_modebits():
568
path_stat = transport.stat(path)
569
actual_mode = stat.S_IMODE(path_stat.st_mode)
570
self.assertEqual(mode, actual_mode,
571
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
573
def assertIsInstance(self, obj, kls):
574
"""Fail if obj is not an instance of kls"""
575
if not isinstance(obj, kls):
576
self.fail("%r is an instance of %s rather than %s" % (
577
obj, obj.__class__, kls))
579
def _capture_warnings(self, a_callable, *args, **kwargs):
580
"""A helper for callDeprecated and applyDeprecated.
582
:param a_callable: A callable to call.
583
:param args: The positional arguments for the callable
584
:param kwargs: The keyword arguments for the callable
585
:return: A tuple (warnings, result). result is the result of calling
586
a_callable(*args, **kwargs).
589
def capture_warnings(msg, cls, stacklevel=None):
590
# we've hooked into a deprecation specific callpath,
591
# only deprecations should getting sent via it.
592
self.assertEqual(cls, DeprecationWarning)
593
local_warnings.append(msg)
594
original_warning_method = symbol_versioning.warn
595
symbol_versioning.set_warning_method(capture_warnings)
597
result = a_callable(*args, **kwargs)
599
symbol_versioning.set_warning_method(original_warning_method)
600
return (local_warnings, result)
602
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
603
"""Call a deprecated callable without warning the user.
605
:param deprecation_format: The deprecation format that the callable
606
should have been deprecated with. This is the same type as the
607
parameter to deprecated_method/deprecated_function. If the
608
callable is not deprecated with this format, an assertion error
610
:param a_callable: A callable to call. This may be a bound method or
611
a regular function. It will be called with *args and **kwargs.
612
:param args: The positional arguments for the callable
613
:param kwargs: The keyword arguments for the callable
614
:return: The result of a_callable(*args, **kwargs)
616
call_warnings, result = self._capture_warnings(a_callable,
618
expected_first_warning = symbol_versioning.deprecation_string(
619
a_callable, deprecation_format)
620
if len(call_warnings) == 0:
621
raise AssertionError("No assertion generated by call to %s" %
623
self.assertEqual(expected_first_warning, call_warnings[0])
626
def callDeprecated(self, expected, callable, *args, **kwargs):
627
"""Assert that a callable is deprecated in a particular way.
629
This is a very precise test for unusual requirements. The
630
applyDeprecated helper function is probably more suited for most tests
631
as it allows you to simply specify the deprecation format being used
632
and will ensure that that is issued for the function being called.
634
:param expected: a list of the deprecation warnings expected, in order
635
:param callable: The callable to call
636
:param args: The positional arguments for the callable
637
:param kwargs: The keyword arguments for the callable
639
call_warnings, result = self._capture_warnings(callable,
641
self.assertEqual(expected, call_warnings)
644
def _startLogFile(self):
645
"""Send bzr and test log messages to a temporary file.
647
The file is removed as the test is torn down.
649
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
650
self._log_file = os.fdopen(fileno, 'w+')
651
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
652
self._log_file_name = name
653
self.addCleanup(self._finishLogFile)
655
def _finishLogFile(self):
656
"""Finished with the log file.
658
Read contents into memory, close, and delete.
660
if self._log_file is None:
662
bzrlib.trace.disable_test_log(self._log_nonce)
663
self._log_file.seek(0)
664
self._log_contents = self._log_file.read()
665
self._log_file.close()
666
os.remove(self._log_file_name)
667
self._log_file = self._log_file_name = None
669
def addCleanup(self, callable):
670
"""Arrange to run a callable when this case is torn down.
672
Callables are run in the reverse of the order they are registered,
673
ie last-in first-out.
675
if callable in self._cleanups:
676
raise ValueError("cleanup function %r already registered on %s"
678
self._cleanups.append(callable)
680
def _cleanEnvironment(self):
683
'APPDATA': os.getcwd(),
685
'BZREMAIL': None, # may still be present in the environment
689
self.addCleanup(self._restoreEnvironment)
690
for name, value in new_env.iteritems():
691
self._captureVar(name, value)
694
def _captureVar(self, name, newvalue):
695
"""Set an environment variable, preparing it to be reset when finished."""
696
self.__old_env[name] = os.environ.get(name, None)
698
if name in os.environ:
701
os.environ[name] = newvalue
704
def _restoreVar(name, value):
706
if name in os.environ:
709
os.environ[name] = value
711
def _restoreEnvironment(self):
712
for name, value in self.__old_env.iteritems():
713
self._restoreVar(name, value)
717
unittest.TestCase.tearDown(self)
719
def time(self, callable, *args, **kwargs):
720
"""Run callable and accrue the time it takes to the benchmark time.
722
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
723
this will cause lsprofile statistics to be gathered and stored in
726
if self._benchtime is None:
730
if not self._gather_lsprof_in_benchmarks:
731
return callable(*args, **kwargs)
733
# record this benchmark
734
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
736
self._benchcalls.append(((callable, args, kwargs), stats))
739
self._benchtime += time.time() - start
741
def _runCleanups(self):
742
"""Run registered cleanup functions.
744
This should only be called from TestCase.tearDown.
746
# TODO: Perhaps this should keep running cleanups even if
748
for cleanup_fn in reversed(self._cleanups):
751
def log(self, *args):
755
"""Return as a string the log for this test"""
756
if self._log_file_name:
757
return open(self._log_file_name).read()
759
return self._log_contents
760
# TODO: Delete the log after it's been read in
762
def capture(self, cmd, retcode=0):
763
"""Shortcut that splits cmd into words, runs, and returns stdout"""
764
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
766
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None):
767
"""Invoke bzr and return (stdout, stderr).
769
Useful for code that wants to check the contents of the
770
output, the way error messages are presented, etc.
772
This should be the main method for tests that want to exercise the
773
overall behavior of the bzr application (rather than a unit test
774
or a functional test of the library.)
776
Much of the old code runs bzr by forking a new copy of Python, but
777
that is slower, harder to debug, and generally not necessary.
779
This runs bzr through the interface that catches and reports
780
errors, and with logging set to something approximating the
781
default, so that error reporting can be checked.
783
:param argv: arguments to invoke bzr
784
:param retcode: expected return code, or None for don't-care.
785
:param encoding: encoding for sys.stdout and sys.stderr
786
:param stdin: A string to be used as stdin for the command.
789
encoding = bzrlib.user_encoding
790
if stdin is not None:
791
stdin = StringIO(stdin)
792
stdout = StringIOWrapper()
793
stderr = StringIOWrapper()
794
stdout.encoding = encoding
795
stderr.encoding = encoding
797
self.log('run bzr: %r', argv)
798
# FIXME: don't call into logging here
799
handler = logging.StreamHandler(stderr)
800
handler.setLevel(logging.INFO)
801
logger = logging.getLogger('')
802
logger.addHandler(handler)
803
old_ui_factory = bzrlib.ui.ui_factory
804
bzrlib.ui.ui_factory = bzrlib.tests.blackbox.TestUIFactory(
807
bzrlib.ui.ui_factory.stdin = stdin
809
result = self.apply_redirected(stdin, stdout, stderr,
810
bzrlib.commands.run_bzr_catch_errors,
813
logger.removeHandler(handler)
814
bzrlib.ui.ui_factory = old_ui_factory
816
out = stdout.getvalue()
817
err = stderr.getvalue()
819
self.log('output:\n%r', out)
821
self.log('errors:\n%r', err)
822
if retcode is not None:
823
self.assertEquals(retcode, result)
826
def run_bzr(self, *args, **kwargs):
827
"""Invoke bzr, as if it were run from the command line.
829
This should be the main method for tests that want to exercise the
830
overall behavior of the bzr application (rather than a unit test
831
or a functional test of the library.)
833
This sends the stdout/stderr results into the test's log,
834
where it may be useful for debugging. See also run_captured.
836
:param stdin: A string to be used as stdin for the command.
838
retcode = kwargs.pop('retcode', 0)
839
encoding = kwargs.pop('encoding', None)
840
stdin = kwargs.pop('stdin', None)
841
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding, stdin=stdin)
843
def run_bzr_decode(self, *args, **kwargs):
844
if 'encoding' in kwargs:
845
encoding = kwargs['encoding']
847
encoding = bzrlib.user_encoding
848
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
850
def run_bzr_error(self, error_regexes, *args, **kwargs):
851
"""Run bzr, and check that stderr contains the supplied regexes
853
:param error_regexes: Sequence of regular expressions which
854
must each be found in the error output. The relative ordering
856
:param args: command-line arguments for bzr
857
:param kwargs: Keyword arguments which are interpreted by run_bzr
858
This function changes the default value of retcode to be 3,
859
since in most cases this is run when you expect bzr to fail.
860
:return: (out, err) The actual output of running the command (in case you
861
want to do more inspection)
864
# Make sure that commit is failing because there is nothing to do
865
self.run_bzr_error(['no changes to commit'],
866
'commit', '-m', 'my commit comment')
867
# Make sure --strict is handling an unknown file, rather than
868
# giving us the 'nothing to do' error
869
self.build_tree(['unknown'])
870
self.run_bzr_error(['Commit refused because there are unknown files'],
871
'commit', '--strict', '-m', 'my commit comment')
873
kwargs.setdefault('retcode', 3)
874
out, err = self.run_bzr(*args, **kwargs)
875
for regex in error_regexes:
876
self.assertContainsRe(err, regex)
879
def run_bzr_subprocess(self, *args, **kwargs):
880
"""Run bzr in a subprocess for testing.
882
This starts a new Python interpreter and runs bzr in there.
883
This should only be used for tests that have a justifiable need for
884
this isolation: e.g. they are testing startup time, or signal
885
handling, or early startup code, etc. Subprocess code can't be
886
profiled or debugged so easily.
888
:param retcode: The status code that is expected. Defaults to 0. If
889
None is supplied, the status code is not checked.
890
:param env_changes: A dictionary which lists changes to environment
891
variables. A value of None will unset the env variable.
892
The values must be strings. The change will only occur in the
893
child, so you don't need to fix the environment after running.
895
env_changes = kwargs.get('env_changes', {})
896
def cleanup_environment():
897
for env_var, value in env_changes.iteritems():
899
del os.environ[env_var]
901
os.environ[env_var] = value
903
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
905
process = Popen([sys.executable, bzr_path]+args,
906
stdout=PIPE, stderr=PIPE,
907
preexec_fn=cleanup_environment)
908
out = process.stdout.read()
909
err = process.stderr.read()
910
retcode = process.wait()
911
supplied_retcode = kwargs.get('retcode', 0)
912
if supplied_retcode is not None:
913
assert supplied_retcode == retcode
916
def check_inventory_shape(self, inv, shape):
917
"""Compare an inventory to a list of expected names.
919
Fail if they are not precisely equal.
922
shape = list(shape) # copy
923
for path, ie in inv.entries():
924
name = path.replace('\\', '/')
932
self.fail("expected paths not found in inventory: %r" % shape)
934
self.fail("unexpected paths found in inventory: %r" % extras)
936
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
937
a_callable=None, *args, **kwargs):
938
"""Call callable with redirected std io pipes.
940
Returns the return code."""
941
if not callable(a_callable):
942
raise ValueError("a_callable must be callable.")
946
if getattr(self, "_log_file", None) is not None:
947
stdout = self._log_file
951
if getattr(self, "_log_file", None is not None):
952
stderr = self._log_file
955
real_stdin = sys.stdin
956
real_stdout = sys.stdout
957
real_stderr = sys.stderr
962
return a_callable(*args, **kwargs)
964
sys.stdout = real_stdout
965
sys.stderr = real_stderr
966
sys.stdin = real_stdin
968
@symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
969
def merge(self, branch_from, wt_to):
970
"""A helper for tests to do a ui-less merge.
972
This should move to the main library when someone has time to integrate
975
# minimal ui-less merge.
976
wt_to.branch.fetch(branch_from)
977
base_rev = common_ancestor(branch_from.last_revision(),
978
wt_to.branch.last_revision(),
979
wt_to.branch.repository)
980
merge_inner(wt_to.branch, branch_from.basis_tree(),
981
wt_to.branch.repository.revision_tree(base_rev),
983
wt_to.add_parent_tree_id(branch_from.last_revision())
986
BzrTestBase = TestCase
989
class TestCaseInTempDir(TestCase):
990
"""Derived class that runs a test within a temporary directory.
992
This is useful for tests that need to create a branch, etc.
994
The directory is created in a slightly complex way: for each
995
Python invocation, a new temporary top-level directory is created.
996
All test cases create their own directory within that. If the
997
tests complete successfully, the directory is removed.
999
InTempDir is an old alias for FunctionalTestCase.
1004
OVERRIDE_PYTHON = 'python'
1006
def check_file_contents(self, filename, expect):
1007
self.log("check contents of file %s" % filename)
1008
contents = file(filename, 'r').read()
1009
if contents != expect:
1010
self.log("expected: %r" % expect)
1011
self.log("actually: %r" % contents)
1012
self.fail("contents of %s not as expected" % filename)
1014
def _make_test_root(self):
1015
if TestCaseInTempDir.TEST_ROOT is not None:
1019
root = u'test%04d.tmp' % i
1023
if e.errno == errno.EEXIST:
1028
# successfully created
1029
TestCaseInTempDir.TEST_ROOT = osutils.abspath(root)
1031
# make a fake bzr directory there to prevent any tests propagating
1032
# up onto the source directory's real branch
1033
bzrdir.BzrDir.create_standalone_workingtree(TestCaseInTempDir.TEST_ROOT)
1036
super(TestCaseInTempDir, self).setUp()
1037
self._make_test_root()
1038
_currentdir = os.getcwdu()
1039
# shorten the name, to avoid test failures due to path length
1040
short_id = self.id().replace('bzrlib.tests.', '') \
1041
.replace('__main__.', '')[-100:]
1042
# it's possible the same test class is run several times for
1043
# parameterized tests, so make sure the names don't collide.
1047
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1049
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1050
if os.path.exists(candidate_dir):
1054
self.test_dir = candidate_dir
1055
os.mkdir(self.test_dir)
1056
os.chdir(self.test_dir)
1058
os.environ['HOME'] = self.test_dir
1059
os.environ['APPDATA'] = self.test_dir
1060
def _leaveDirectory():
1061
os.chdir(_currentdir)
1062
self.addCleanup(_leaveDirectory)
1064
def build_tree(self, shape, line_endings='native', transport=None):
1065
"""Build a test tree according to a pattern.
1067
shape is a sequence of file specifications. If the final
1068
character is '/', a directory is created.
1070
This assumes that all the elements in the tree being built are new.
1072
This doesn't add anything to a branch.
1073
:param line_endings: Either 'binary' or 'native'
1074
in binary mode, exact contents are written
1075
in native mode, the line endings match the
1076
default platform endings.
1078
:param transport: A transport to write to, for building trees on
1079
VFS's. If the transport is readonly or None,
1080
"." is opened automatically.
1082
# It's OK to just create them using forward slashes on windows.
1083
if transport is None or transport.is_readonly():
1084
transport = get_transport(".")
1086
self.assert_(isinstance(name, basestring))
1088
transport.mkdir(urlutils.escape(name[:-1]))
1090
if line_endings == 'binary':
1092
elif line_endings == 'native':
1095
raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
1096
content = "contents of %s%s" % (name.encode('utf-8'), end)
1097
# Technically 'put()' is the right command. However, put
1098
# uses an AtomicFile, which requires an extra rename into place
1099
# As long as the files didn't exist in the past, append() will
1100
# do the same thing as put()
1101
# On jam's machine, make_kernel_like_tree is:
1102
# put: 4.5-7.5s (averaging 6s)
1104
transport.append(urlutils.escape(name), StringIO(content))
1106
def build_tree_contents(self, shape):
1107
build_tree_contents(shape)
1109
def failUnlessExists(self, path):
1110
"""Fail unless path, which may be abs or relative, exists."""
1111
self.failUnless(osutils.lexists(path))
1113
def failIfExists(self, path):
1114
"""Fail if path, which may be abs or relative, exists."""
1115
self.failIf(osutils.lexists(path))
1117
def assertFileEqual(self, content, path):
1118
"""Fail if path does not contain 'content'."""
1119
self.failUnless(osutils.lexists(path))
1120
# TODO: jam 20060427 Shouldn't this be 'rb'?
1121
self.assertEqualDiff(content, open(path, 'r').read())
1124
class TestCaseWithTransport(TestCaseInTempDir):
1125
"""A test case that provides get_url and get_readonly_url facilities.
1127
These back onto two transport servers, one for readonly access and one for
1130
If no explicit class is provided for readonly access, a
1131
ReadonlyTransportDecorator is used instead which allows the use of non disk
1132
based read write transports.
1134
If an explicit class is provided for readonly access, that server and the
1135
readwrite one must both define get_url() as resolving to os.getcwd().
1138
def __init__(self, methodName='testMethod'):
1139
super(TestCaseWithTransport, self).__init__(methodName)
1140
self.__readonly_server = None
1141
self.__server = None
1142
self.transport_server = default_transport
1143
self.transport_readonly_server = None
1145
def get_readonly_url(self, relpath=None):
1146
"""Get a URL for the readonly transport.
1148
This will either be backed by '.' or a decorator to the transport
1149
used by self.get_url()
1150
relpath provides for clients to get a path relative to the base url.
1151
These should only be downwards relative, not upwards.
1153
base = self.get_readonly_server().get_url()
1154
if relpath is not None:
1155
if not base.endswith('/'):
1157
base = base + relpath
1160
def get_readonly_server(self):
1161
"""Get the server instance for the readonly transport
1163
This is useful for some tests with specific servers to do diagnostics.
1165
if self.__readonly_server is None:
1166
if self.transport_readonly_server is None:
1167
# readonly decorator requested
1168
# bring up the server
1170
self.__readonly_server = ReadonlyServer()
1171
self.__readonly_server.setUp(self.__server)
1173
self.__readonly_server = self.transport_readonly_server()
1174
self.__readonly_server.setUp()
1175
self.addCleanup(self.__readonly_server.tearDown)
1176
return self.__readonly_server
1178
def get_server(self):
1179
"""Get the read/write server instance.
1181
This is useful for some tests with specific servers that need
1184
if self.__server is None:
1185
self.__server = self.transport_server()
1186
self.__server.setUp()
1187
self.addCleanup(self.__server.tearDown)
1188
return self.__server
1190
def get_url(self, relpath=None):
1191
"""Get a URL for the readwrite transport.
1193
This will either be backed by '.' or to an equivalent non-file based
1195
relpath provides for clients to get a path relative to the base url.
1196
These should only be downwards relative, not upwards.
1198
base = self.get_server().get_url()
1199
if relpath is not None and relpath != '.':
1200
if not base.endswith('/'):
1202
base = base + urlutils.escape(relpath)
1205
def get_transport(self):
1206
"""Return a writeable transport for the test scratch space"""
1207
t = get_transport(self.get_url())
1208
self.assertFalse(t.is_readonly())
1211
def get_readonly_transport(self):
1212
"""Return a readonly transport for the test scratch space
1214
This can be used to test that operations which should only need
1215
readonly access in fact do not try to write.
1217
t = get_transport(self.get_readonly_url())
1218
self.assertTrue(t.is_readonly())
1221
def make_branch(self, relpath, format=None):
1222
"""Create a branch on the transport at relpath."""
1223
repo = self.make_repository(relpath, format=format)
1224
return repo.bzrdir.create_branch()
1226
def make_bzrdir(self, relpath, format=None):
1228
url = self.get_url(relpath)
1229
mutter('relpath %r => url %r', relpath, url)
1230
segments = url.split('/')
1231
if segments and segments[-1] not in ('', '.'):
1232
parent = '/'.join(segments[:-1])
1233
t = get_transport(parent)
1235
t.mkdir(segments[-1])
1236
except errors.FileExists:
1239
format=bzrlib.bzrdir.BzrDirFormat.get_default_format()
1240
# FIXME: make this use a single transport someday. RBC 20060418
1241
return format.initialize_on_transport(get_transport(relpath))
1242
except errors.UninitializableFormat:
1243
raise TestSkipped("Format %s is not initializable." % format)
1245
def make_repository(self, relpath, shared=False, format=None):
1246
"""Create a repository on our default transport at relpath."""
1247
made_control = self.make_bzrdir(relpath, format=format)
1248
return made_control.create_repository(shared=shared)
1250
def make_branch_and_tree(self, relpath, format=None):
1251
"""Create a branch on the transport and a tree locally.
1255
# TODO: always use the local disk path for the working tree,
1256
# this obviously requires a format that supports branch references
1257
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1259
b = self.make_branch(relpath, format=format)
1261
return b.bzrdir.create_workingtree()
1262
except errors.NotLocalUrl:
1263
# new formats - catch No tree error and create
1264
# a branch reference and a checkout.
1265
# old formats at that point - raise TestSkipped.
1266
# TODO: rbc 20060208
1267
return WorkingTreeFormat2().initialize(bzrdir.BzrDir.open(relpath))
1269
def assertIsDirectory(self, relpath, transport):
1270
"""Assert that relpath within transport is a directory.
1272
This may not be possible on all transports; in that case it propagates
1273
a TransportNotPossible.
1276
mode = transport.stat(relpath).st_mode
1277
except errors.NoSuchFile:
1278
self.fail("path %s is not a directory; no such file"
1280
if not stat.S_ISDIR(mode):
1281
self.fail("path %s is not a directory; has mode %#o"
1285
class ChrootedTestCase(TestCaseWithTransport):
1286
"""A support class that provides readonly urls outside the local namespace.
1288
This is done by checking if self.transport_server is a MemoryServer. if it
1289
is then we are chrooted already, if it is not then an HttpServer is used
1292
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1293
be used without needed to redo it when a different
1294
subclass is in use ?
1298
super(ChrootedTestCase, self).setUp()
1299
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
1300
self.transport_readonly_server = bzrlib.transport.http.HttpServer
1303
def filter_suite_by_re(suite, pattern):
1304
result = TestUtil.TestSuite()
1305
filter_re = re.compile(pattern)
1306
for test in iter_suite_tests(suite):
1307
if filter_re.search(test.id()):
1308
result.addTest(test)
1312
def run_suite(suite, name='test', verbose=False, pattern=".*",
1313
stop_on_failure=False, keep_output=False,
1314
transport=None, lsprof_timed=None, bench_history=None):
1315
TestCaseInTempDir._TEST_NAME = name
1316
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1322
pb = progress.ProgressBar()
1323
runner = TextTestRunner(stream=sys.stdout,
1325
verbosity=verbosity,
1326
keep_output=keep_output,
1328
bench_history=bench_history)
1329
runner.stop_on_failure=stop_on_failure
1331
suite = filter_suite_by_re(suite, pattern)
1332
result = runner.run(suite)
1333
return result.wasSuccessful()
1336
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1339
test_suite_factory=None,
1341
bench_history=None):
1342
"""Run the whole test suite under the enhanced runner"""
1343
# XXX: Very ugly way to do this...
1344
# Disable warning about old formats because we don't want it to disturb
1345
# any blackbox tests.
1346
from bzrlib import repository
1347
repository._deprecation_warning_done = True
1349
global default_transport
1350
if transport is None:
1351
transport = default_transport
1352
old_transport = default_transport
1353
default_transport = transport
1355
if test_suite_factory is None:
1356
suite = test_suite()
1358
suite = test_suite_factory()
1359
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1360
stop_on_failure=stop_on_failure, keep_output=keep_output,
1361
transport=transport,
1362
lsprof_timed=lsprof_timed,
1363
bench_history=bench_history)
1365
default_transport = old_transport
1369
"""Build and return TestSuite for the whole of bzrlib.
1371
This function can be replaced if you need to change the default test
1372
suite on a global basis, but it is not encouraged.
1375
'bzrlib.tests.test_ancestry',
1376
'bzrlib.tests.test_api',
1377
'bzrlib.tests.test_atomicfile',
1378
'bzrlib.tests.test_bad_files',
1379
'bzrlib.tests.test_branch',
1380
'bzrlib.tests.test_bundle',
1381
'bzrlib.tests.test_bzrdir',
1382
'bzrlib.tests.test_cache_utf8',
1383
'bzrlib.tests.test_command',
1384
'bzrlib.tests.test_commit',
1385
'bzrlib.tests.test_commit_merge',
1386
'bzrlib.tests.test_config',
1387
'bzrlib.tests.test_conflicts',
1388
'bzrlib.tests.test_decorators',
1389
'bzrlib.tests.test_diff',
1390
'bzrlib.tests.test_doc_generate',
1391
'bzrlib.tests.test_errors',
1392
'bzrlib.tests.test_escaped_store',
1393
'bzrlib.tests.test_fetch',
1394
'bzrlib.tests.test_gpg',
1395
'bzrlib.tests.test_graph',
1396
'bzrlib.tests.test_hashcache',
1397
'bzrlib.tests.test_http',
1398
'bzrlib.tests.test_http_response',
1399
'bzrlib.tests.test_identitymap',
1400
'bzrlib.tests.test_ignores',
1401
'bzrlib.tests.test_inv',
1402
'bzrlib.tests.test_knit',
1403
'bzrlib.tests.test_lockdir',
1404
'bzrlib.tests.test_lockable_files',
1405
'bzrlib.tests.test_log',
1406
'bzrlib.tests.test_merge',
1407
'bzrlib.tests.test_merge3',
1408
'bzrlib.tests.test_merge_core',
1409
'bzrlib.tests.test_missing',
1410
'bzrlib.tests.test_msgeditor',
1411
'bzrlib.tests.test_nonascii',
1412
'bzrlib.tests.test_options',
1413
'bzrlib.tests.test_osutils',
1414
'bzrlib.tests.test_patch',
1415
'bzrlib.tests.test_patches',
1416
'bzrlib.tests.test_permissions',
1417
'bzrlib.tests.test_plugins',
1418
'bzrlib.tests.test_progress',
1419
'bzrlib.tests.test_reconcile',
1420
'bzrlib.tests.test_repository',
1421
'bzrlib.tests.test_revert',
1422
'bzrlib.tests.test_revision',
1423
'bzrlib.tests.test_revisionnamespaces',
1424
'bzrlib.tests.test_revisiontree',
1425
'bzrlib.tests.test_rio',
1426
'bzrlib.tests.test_sampler',
1427
'bzrlib.tests.test_selftest',
1428
'bzrlib.tests.test_setup',
1429
'bzrlib.tests.test_sftp_transport',
1430
'bzrlib.tests.test_ftp_transport',
1431
'bzrlib.tests.test_smart_add',
1432
'bzrlib.tests.test_source',
1433
'bzrlib.tests.test_status',
1434
'bzrlib.tests.test_store',
1435
'bzrlib.tests.test_symbol_versioning',
1436
'bzrlib.tests.test_testament',
1437
'bzrlib.tests.test_textfile',
1438
'bzrlib.tests.test_textmerge',
1439
'bzrlib.tests.test_trace',
1440
'bzrlib.tests.test_transactions',
1441
'bzrlib.tests.test_transform',
1442
'bzrlib.tests.test_transport',
1443
'bzrlib.tests.test_tree',
1444
'bzrlib.tests.test_tsort',
1445
'bzrlib.tests.test_tuned_gzip',
1446
'bzrlib.tests.test_ui',
1447
'bzrlib.tests.test_upgrade',
1448
'bzrlib.tests.test_urlutils',
1449
'bzrlib.tests.test_versionedfile',
1450
'bzrlib.tests.test_version',
1451
'bzrlib.tests.test_weave',
1452
'bzrlib.tests.test_whitebox',
1453
'bzrlib.tests.test_workingtree',
1454
'bzrlib.tests.test_xml',
1456
test_transport_implementations = [
1457
'bzrlib.tests.test_transport_implementations',
1458
'bzrlib.tests.test_read_bundle',
1460
suite = TestUtil.TestSuite()
1461
loader = TestUtil.TestLoader()
1462
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1463
from bzrlib.transport import TransportTestProviderAdapter
1464
adapter = TransportTestProviderAdapter()
1465
adapt_modules(test_transport_implementations, adapter, loader, suite)
1466
for package in packages_to_test():
1467
suite.addTest(package.test_suite())
1468
for m in MODULES_TO_TEST:
1469
suite.addTest(loader.loadTestsFromModule(m))
1470
for m in MODULES_TO_DOCTEST:
1471
suite.addTest(doctest.DocTestSuite(m))
1472
for name, plugin in bzrlib.plugin.all_plugins().items():
1473
if getattr(plugin, 'test_suite', None) is not None:
1474
suite.addTest(plugin.test_suite())
1478
def adapt_modules(mods_list, adapter, loader, suite):
1479
"""Adapt the modules in mods_list using adapter and add to suite."""
1480
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1481
suite.addTests(adapter.adapt(test))
added
removed
bzrlib/tests/__init__.py
