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'
904
# win32 subprocess doesn't support preexec_fn
905
# so we will avoid using it on all platforms, just to
906
# make sure the code path is used, and we don't break on win32
907
cleanup_environment()
908
process = Popen([sys.executable, bzr_path]+args,
909
stdout=PIPE, stderr=PIPE)
911
restore_environment()
913
out = process.stdout.read()
914
err = process.stderr.read()
916
if kwargs.get('universal_newlines', False):
917
out = out.replace('\r\n', '\n')
918
err = err.replace('\r\n', '\n')
920
retcode = process.wait()
921
supplied_retcode = kwargs.get('retcode', 0)
922
if supplied_retcode is not None:
923
assert supplied_retcode == retcode
926
def check_inventory_shape(self, inv, shape):
927
"""Compare an inventory to a list of expected names.
929
Fail if they are not precisely equal.
932
shape = list(shape) # copy
933
for path, ie in inv.entries():
934
name = path.replace('\\', '/')
942
self.fail("expected paths not found in inventory: %r" % shape)
944
self.fail("unexpected paths found in inventory: %r" % extras)
946
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
947
a_callable=None, *args, **kwargs):
948
"""Call callable with redirected std io pipes.
950
Returns the return code."""
951
if not callable(a_callable):
952
raise ValueError("a_callable must be callable.")
956
if getattr(self, "_log_file", None) is not None:
957
stdout = self._log_file
961
if getattr(self, "_log_file", None is not None):
962
stderr = self._log_file
965
real_stdin = sys.stdin
966
real_stdout = sys.stdout
967
real_stderr = sys.stderr
972
return a_callable(*args, **kwargs)
974
sys.stdout = real_stdout
975
sys.stderr = real_stderr
976
sys.stdin = real_stdin
978
@symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
979
def merge(self, branch_from, wt_to):
980
"""A helper for tests to do a ui-less merge.
982
This should move to the main library when someone has time to integrate
985
# minimal ui-less merge.
986
wt_to.branch.fetch(branch_from)
987
base_rev = common_ancestor(branch_from.last_revision(),
988
wt_to.branch.last_revision(),
989
wt_to.branch.repository)
990
merge_inner(wt_to.branch, branch_from.basis_tree(),
991
wt_to.branch.repository.revision_tree(base_rev),
993
wt_to.add_parent_tree_id(branch_from.last_revision())
996
BzrTestBase = TestCase
999
class TestCaseInTempDir(TestCase):
1000
"""Derived class that runs a test within a temporary directory.
1002
This is useful for tests that need to create a branch, etc.
1004
The directory is created in a slightly complex way: for each
1005
Python invocation, a new temporary top-level directory is created.
1006
All test cases create their own directory within that. If the
1007
tests complete successfully, the directory is removed.
1009
InTempDir is an old alias for FunctionalTestCase.
1014
OVERRIDE_PYTHON = 'python'
1016
def check_file_contents(self, filename, expect):
1017
self.log("check contents of file %s" % filename)
1018
contents = file(filename, 'r').read()
1019
if contents != expect:
1020
self.log("expected: %r" % expect)
1021
self.log("actually: %r" % contents)
1022
self.fail("contents of %s not as expected" % filename)
1024
def _make_test_root(self):
1025
if TestCaseInTempDir.TEST_ROOT is not None:
1029
root = u'test%04d.tmp' % i
1033
if e.errno == errno.EEXIST:
1038
# successfully created
1039
TestCaseInTempDir.TEST_ROOT = osutils.abspath(root)
1041
# make a fake bzr directory there to prevent any tests propagating
1042
# up onto the source directory's real branch
1043
bzrdir.BzrDir.create_standalone_workingtree(TestCaseInTempDir.TEST_ROOT)
1046
super(TestCaseInTempDir, self).setUp()
1047
self._make_test_root()
1048
_currentdir = os.getcwdu()
1049
# shorten the name, to avoid test failures due to path length
1050
short_id = self.id().replace('bzrlib.tests.', '') \
1051
.replace('__main__.', '')[-100:]
1052
# it's possible the same test class is run several times for
1053
# parameterized tests, so make sure the names don't collide.
1057
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1059
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1060
if os.path.exists(candidate_dir):
1064
os.mkdir(candidate_dir)
1065
self.test_home_dir = candidate_dir + '/home'
1066
os.mkdir(self.test_home_dir)
1067
self.test_dir = candidate_dir + '/work'
1068
os.mkdir(self.test_dir)
1069
os.chdir(self.test_dir)
1071
os.environ['HOME'] = self.test_home_dir
1072
os.environ['APPDATA'] = self.test_home_dir
1073
def _leaveDirectory():
1074
os.chdir(_currentdir)
1075
self.addCleanup(_leaveDirectory)
1077
def build_tree(self, shape, line_endings='native', transport=None):
1078
"""Build a test tree according to a pattern.
1080
shape is a sequence of file specifications. If the final
1081
character is '/', a directory is created.
1083
This assumes that all the elements in the tree being built are new.
1085
This doesn't add anything to a branch.
1086
:param line_endings: Either 'binary' or 'native'
1087
in binary mode, exact contents are written
1088
in native mode, the line endings match the
1089
default platform endings.
1091
:param transport: A transport to write to, for building trees on
1092
VFS's. If the transport is readonly or None,
1093
"." is opened automatically.
1095
# It's OK to just create them using forward slashes on windows.
1096
if transport is None or transport.is_readonly():
1097
transport = get_transport(".")
1099
self.assert_(isinstance(name, basestring))
1101
transport.mkdir(urlutils.escape(name[:-1]))
1103
if line_endings == 'binary':
1105
elif line_endings == 'native':
1108
raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
1109
content = "contents of %s%s" % (name.encode('utf-8'), end)
1110
# Technically 'put()' is the right command. However, put
1111
# uses an AtomicFile, which requires an extra rename into place
1112
# As long as the files didn't exist in the past, append() will
1113
# do the same thing as put()
1114
# On jam's machine, make_kernel_like_tree is:
1115
# put: 4.5-7.5s (averaging 6s)
1117
# put_non_atomic: 2.9-4.5s
1118
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1120
def build_tree_contents(self, shape):
1121
build_tree_contents(shape)
1123
def failUnlessExists(self, path):
1124
"""Fail unless path, which may be abs or relative, exists."""
1125
self.failUnless(osutils.lexists(path))
1127
def failIfExists(self, path):
1128
"""Fail if path, which may be abs or relative, exists."""
1129
self.failIf(osutils.lexists(path))
1131
def assertFileEqual(self, content, path):
1132
"""Fail if path does not contain 'content'."""
1133
self.failUnless(osutils.lexists(path))
1134
# TODO: jam 20060427 Shouldn't this be 'rb'?
1135
self.assertEqualDiff(content, open(path, 'r').read())
1138
class TestCaseWithTransport(TestCaseInTempDir):
1139
"""A test case that provides get_url and get_readonly_url facilities.
1141
These back onto two transport servers, one for readonly access and one for
1144
If no explicit class is provided for readonly access, a
1145
ReadonlyTransportDecorator is used instead which allows the use of non disk
1146
based read write transports.
1148
If an explicit class is provided for readonly access, that server and the
1149
readwrite one must both define get_url() as resolving to os.getcwd().
1152
def __init__(self, methodName='testMethod'):
1153
super(TestCaseWithTransport, self).__init__(methodName)
1154
self.__readonly_server = None
1155
self.__server = None
1156
self.transport_server = default_transport
1157
self.transport_readonly_server = None
1159
def get_readonly_url(self, relpath=None):
1160
"""Get a URL for the readonly transport.
1162
This will either be backed by '.' or a decorator to the transport
1163
used by self.get_url()
1164
relpath provides for clients to get a path relative to the base url.
1165
These should only be downwards relative, not upwards.
1167
base = self.get_readonly_server().get_url()
1168
if relpath is not None:
1169
if not base.endswith('/'):
1171
base = base + relpath
1174
def get_readonly_server(self):
1175
"""Get the server instance for the readonly transport
1177
This is useful for some tests with specific servers to do diagnostics.
1179
if self.__readonly_server is None:
1180
if self.transport_readonly_server is None:
1181
# readonly decorator requested
1182
# bring up the server
1184
self.__readonly_server = ReadonlyServer()
1185
self.__readonly_server.setUp(self.__server)
1187
self.__readonly_server = self.transport_readonly_server()
1188
self.__readonly_server.setUp()
1189
self.addCleanup(self.__readonly_server.tearDown)
1190
return self.__readonly_server
1192
def get_server(self):
1193
"""Get the read/write server instance.
1195
This is useful for some tests with specific servers that need
1198
if self.__server is None:
1199
self.__server = self.transport_server()
1200
self.__server.setUp()
1201
self.addCleanup(self.__server.tearDown)
1202
return self.__server
1204
def get_url(self, relpath=None):
1205
"""Get a URL for the readwrite transport.
1207
This will either be backed by '.' or to an equivalent non-file based
1209
relpath provides for clients to get a path relative to the base url.
1210
These should only be downwards relative, not upwards.
1212
base = self.get_server().get_url()
1213
if relpath is not None and relpath != '.':
1214
if not base.endswith('/'):
1216
base = base + urlutils.escape(relpath)
1219
def get_transport(self):
1220
"""Return a writeable transport for the test scratch space"""
1221
t = get_transport(self.get_url())
1222
self.assertFalse(t.is_readonly())
1225
def get_readonly_transport(self):
1226
"""Return a readonly transport for the test scratch space
1228
This can be used to test that operations which should only need
1229
readonly access in fact do not try to write.
1231
t = get_transport(self.get_readonly_url())
1232
self.assertTrue(t.is_readonly())
1235
def make_branch(self, relpath, format=None):
1236
"""Create a branch on the transport at relpath."""
1237
repo = self.make_repository(relpath, format=format)
1238
return repo.bzrdir.create_branch()
1240
def make_bzrdir(self, relpath, format=None):
1242
url = self.get_url(relpath)
1243
mutter('relpath %r => url %r', relpath, url)
1244
segments = url.split('/')
1245
if segments and segments[-1] not in ('', '.'):
1246
parent = '/'.join(segments[:-1])
1247
t = get_transport(parent)
1249
t.mkdir(segments[-1])
1250
except errors.FileExists:
1253
format=bzrlib.bzrdir.BzrDirFormat.get_default_format()
1254
# FIXME: make this use a single transport someday. RBC 20060418
1255
return format.initialize_on_transport(get_transport(relpath))
1256
except errors.UninitializableFormat:
1257
raise TestSkipped("Format %s is not initializable." % format)
1259
def make_repository(self, relpath, shared=False, format=None):
1260
"""Create a repository on our default transport at relpath."""
1261
made_control = self.make_bzrdir(relpath, format=format)
1262
return made_control.create_repository(shared=shared)
1264
def make_branch_and_tree(self, relpath, format=None):
1265
"""Create a branch on the transport and a tree locally.
1269
# TODO: always use the local disk path for the working tree,
1270
# this obviously requires a format that supports branch references
1271
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1273
b = self.make_branch(relpath, format=format)
1275
return b.bzrdir.create_workingtree()
1276
except errors.NotLocalUrl:
1277
# new formats - catch No tree error and create
1278
# a branch reference and a checkout.
1279
# old formats at that point - raise TestSkipped.
1280
# TODO: rbc 20060208
1281
return WorkingTreeFormat2().initialize(bzrdir.BzrDir.open(relpath))
1283
def assertIsDirectory(self, relpath, transport):
1284
"""Assert that relpath within transport is a directory.
1286
This may not be possible on all transports; in that case it propagates
1287
a TransportNotPossible.
1290
mode = transport.stat(relpath).st_mode
1291
except errors.NoSuchFile:
1292
self.fail("path %s is not a directory; no such file"
1294
if not stat.S_ISDIR(mode):
1295
self.fail("path %s is not a directory; has mode %#o"
1299
class ChrootedTestCase(TestCaseWithTransport):
1300
"""A support class that provides readonly urls outside the local namespace.
1302
This is done by checking if self.transport_server is a MemoryServer. if it
1303
is then we are chrooted already, if it is not then an HttpServer is used
1306
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1307
be used without needed to redo it when a different
1308
subclass is in use ?
1312
super(ChrootedTestCase, self).setUp()
1313
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
1314
self.transport_readonly_server = bzrlib.transport.http.HttpServer
1317
def filter_suite_by_re(suite, pattern):
1318
result = TestUtil.TestSuite()
1319
filter_re = re.compile(pattern)
1320
for test in iter_suite_tests(suite):
1321
if filter_re.search(test.id()):
1322
result.addTest(test)
1326
def run_suite(suite, name='test', verbose=False, pattern=".*",
1327
stop_on_failure=False, keep_output=False,
1328
transport=None, lsprof_timed=None, bench_history=None):
1329
TestCaseInTempDir._TEST_NAME = name
1330
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1336
pb = progress.ProgressBar()
1337
runner = TextTestRunner(stream=sys.stdout,
1339
verbosity=verbosity,
1340
keep_output=keep_output,
1342
bench_history=bench_history)
1343
runner.stop_on_failure=stop_on_failure
1345
suite = filter_suite_by_re(suite, pattern)
1346
result = runner.run(suite)
1347
return result.wasSuccessful()
1350
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1353
test_suite_factory=None,
1355
bench_history=None):
1356
"""Run the whole test suite under the enhanced runner"""
1357
# XXX: Very ugly way to do this...
1358
# Disable warning about old formats because we don't want it to disturb
1359
# any blackbox tests.
1360
from bzrlib import repository
1361
repository._deprecation_warning_done = True
1363
global default_transport
1364
if transport is None:
1365
transport = default_transport
1366
old_transport = default_transport
1367
default_transport = transport
1369
if test_suite_factory is None:
1370
suite = test_suite()
1372
suite = test_suite_factory()
1373
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1374
stop_on_failure=stop_on_failure, keep_output=keep_output,
1375
transport=transport,
1376
lsprof_timed=lsprof_timed,
1377
bench_history=bench_history)
1379
default_transport = old_transport
1383
"""Build and return TestSuite for the whole of bzrlib.
1385
This function can be replaced if you need to change the default test
1386
suite on a global basis, but it is not encouraged.
1389
'bzrlib.tests.test_ancestry',
1390
'bzrlib.tests.test_api',
1391
'bzrlib.tests.test_atomicfile',
1392
'bzrlib.tests.test_bad_files',
1393
'bzrlib.tests.test_branch',
1394
'bzrlib.tests.test_bundle',
1395
'bzrlib.tests.test_bzrdir',
1396
'bzrlib.tests.test_cache_utf8',
1397
'bzrlib.tests.test_command',
1398
'bzrlib.tests.test_commit',
1399
'bzrlib.tests.test_commit_merge',
1400
'bzrlib.tests.test_config',
1401
'bzrlib.tests.test_conflicts',
1402
'bzrlib.tests.test_decorators',
1403
'bzrlib.tests.test_diff',
1404
'bzrlib.tests.test_doc_generate',
1405
'bzrlib.tests.test_errors',
1406
'bzrlib.tests.test_escaped_store',
1407
'bzrlib.tests.test_fetch',
1408
'bzrlib.tests.test_gpg',
1409
'bzrlib.tests.test_graph',
1410
'bzrlib.tests.test_hashcache',
1411
'bzrlib.tests.test_http',
1412
'bzrlib.tests.test_http_response',
1413
'bzrlib.tests.test_identitymap',
1414
'bzrlib.tests.test_ignores',
1415
'bzrlib.tests.test_inv',
1416
'bzrlib.tests.test_knit',
1417
'bzrlib.tests.test_lockdir',
1418
'bzrlib.tests.test_lockable_files',
1419
'bzrlib.tests.test_log',
1420
'bzrlib.tests.test_merge',
1421
'bzrlib.tests.test_merge3',
1422
'bzrlib.tests.test_merge_core',
1423
'bzrlib.tests.test_missing',
1424
'bzrlib.tests.test_msgeditor',
1425
'bzrlib.tests.test_nonascii',
1426
'bzrlib.tests.test_options',
1427
'bzrlib.tests.test_osutils',
1428
'bzrlib.tests.test_patch',
1429
'bzrlib.tests.test_patches',
1430
'bzrlib.tests.test_permissions',
1431
'bzrlib.tests.test_plugins',
1432
'bzrlib.tests.test_progress',
1433
'bzrlib.tests.test_reconcile',
1434
'bzrlib.tests.test_repository',
1435
'bzrlib.tests.test_revert',
1436
'bzrlib.tests.test_revision',
1437
'bzrlib.tests.test_revisionnamespaces',
1438
'bzrlib.tests.test_revisiontree',
1439
'bzrlib.tests.test_rio',
1440
'bzrlib.tests.test_sampler',
1441
'bzrlib.tests.test_selftest',
1442
'bzrlib.tests.test_setup',
1443
'bzrlib.tests.test_sftp_transport',
1444
'bzrlib.tests.test_ftp_transport',
1445
'bzrlib.tests.test_smart_add',
1446
'bzrlib.tests.test_source',
1447
'bzrlib.tests.test_status',
1448
'bzrlib.tests.test_store',
1449
'bzrlib.tests.test_symbol_versioning',
1450
'bzrlib.tests.test_testament',
1451
'bzrlib.tests.test_textfile',
1452
'bzrlib.tests.test_textmerge',
1453
'bzrlib.tests.test_trace',
1454
'bzrlib.tests.test_transactions',
1455
'bzrlib.tests.test_transform',
1456
'bzrlib.tests.test_transport',
1457
'bzrlib.tests.test_tree',
1458
'bzrlib.tests.test_tsort',
1459
'bzrlib.tests.test_tuned_gzip',
1460
'bzrlib.tests.test_ui',
1461
'bzrlib.tests.test_upgrade',
1462
'bzrlib.tests.test_urlutils',
1463
'bzrlib.tests.test_versionedfile',
1464
'bzrlib.tests.test_version',
1465
'bzrlib.tests.test_weave',
1466
'bzrlib.tests.test_whitebox',
1467
'bzrlib.tests.test_workingtree',
1468
'bzrlib.tests.test_xml',
1470
test_transport_implementations = [
1471
'bzrlib.tests.test_transport_implementations',
1472
'bzrlib.tests.test_read_bundle',
1474
suite = TestUtil.TestSuite()
1475
loader = TestUtil.TestLoader()
1476
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1477
from bzrlib.transport import TransportTestProviderAdapter
1478
adapter = TransportTestProviderAdapter()
1479
adapt_modules(test_transport_implementations, adapter, loader, suite)
1480
for package in packages_to_test():
1481
suite.addTest(package.test_suite())
1482
for m in MODULES_TO_TEST:
1483
suite.addTest(loader.loadTestsFromModule(m))
1484
for m in MODULES_TO_DOCTEST:
1485
suite.addTest(doctest.DocTestSuite(m))
1486
for name, plugin in bzrlib.plugin.all_plugins().items():
1487
if getattr(plugin, 'test_suite', None) is not None:
1488
suite.addTest(plugin.test_suite())
1492
def adapt_modules(mods_list, adapter, loader, suite):
1493
"""Adapt the modules in mods_list using adapter and add to suite."""
1494
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1495
suite.addTests(adapter.adapt(test))
added
removed
bzrlib/tests/__init__.py
