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
66
from bzrlib.revisionspec import RevisionSpec
68
from bzrlib import symbol_versioning
70
from bzrlib.transport import get_transport
71
import bzrlib.transport
72
from bzrlib.transport.local import LocalRelpathServer
73
from bzrlib.transport.readonly import ReadonlyServer
74
from bzrlib.trace import mutter
75
from bzrlib.tests import TestUtil
76
from bzrlib.tests.TestUtil import (
80
from bzrlib.tests.treeshape import build_tree_contents
81
import bzrlib.urlutils as urlutils
82
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
84
default_transport = LocalRelpathServer
87
MODULES_TO_DOCTEST = [
89
bzrlib.bundle.serializer,
102
def packages_to_test():
103
"""Return a list of packages to test.
105
The packages are not globally imported so that import failures are
106
triggered when running selftest, not when importing the command.
109
import bzrlib.tests.blackbox
110
import bzrlib.tests.branch_implementations
111
import bzrlib.tests.bzrdir_implementations
112
import bzrlib.tests.interrepository_implementations
113
import bzrlib.tests.interversionedfile_implementations
114
import bzrlib.tests.intertree_implementations
115
import bzrlib.tests.repository_implementations
116
import bzrlib.tests.revisionstore_implementations
117
import bzrlib.tests.tree_implementations
118
import bzrlib.tests.workingtree_implementations
121
bzrlib.tests.blackbox,
122
bzrlib.tests.branch_implementations,
123
bzrlib.tests.bzrdir_implementations,
124
bzrlib.tests.interrepository_implementations,
125
bzrlib.tests.interversionedfile_implementations,
126
bzrlib.tests.intertree_implementations,
127
bzrlib.tests.repository_implementations,
128
bzrlib.tests.revisionstore_implementations,
129
bzrlib.tests.tree_implementations,
130
bzrlib.tests.workingtree_implementations,
134
class _MyResult(unittest._TextTestResult):
135
"""Custom TestResult.
137
Shows output in a different format, including displaying runtime for tests.
141
def __init__(self, stream, descriptions, verbosity, pb=None,
143
"""Construct new TestResult.
145
:param bench_history: Optionally, a writable file object to accumulate
148
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
150
if bench_history is not None:
151
from bzrlib.version import _get_bzr_source_tree
152
src_tree = _get_bzr_source_tree()
154
revision_id = src_tree.last_revision()
156
# XXX: If there's no branch, what should we do?
158
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
159
self._bench_history = bench_history
161
def extractBenchmarkTime(self, testCase):
162
"""Add a benchmark time for the current test case."""
163
self._benchmarkTime = getattr(testCase, "_benchtime", None)
165
def _elapsedTestTimeString(self):
166
"""Return a time string for the overall time the current test has taken."""
167
return self._formatTime(time.time() - self._start_time)
169
def _testTimeString(self):
170
if self._benchmarkTime is not None:
172
self._formatTime(self._benchmarkTime),
173
self._elapsedTestTimeString())
175
return " %s" % self._elapsedTestTimeString()
177
def _formatTime(self, seconds):
178
"""Format seconds as milliseconds with leading spaces."""
179
return "%5dms" % (1000 * seconds)
181
def _ellipsise_unimportant_words(self, a_string, final_width,
183
"""Add ellipses (sp?) for overly long strings.
185
:param keep_start: If true preserve the start of a_string rather
189
if len(a_string) > final_width:
190
result = a_string[:final_width-3] + '...'
194
if len(a_string) > final_width:
195
result = '...' + a_string[3-final_width:]
198
return result.ljust(final_width)
200
def startTest(self, test):
201
unittest.TestResult.startTest(self, test)
202
# In a short description, the important words are in
203
# the beginning, but in an id, the important words are
205
SHOW_DESCRIPTIONS = False
207
if not self.showAll and self.dots and self.pb is not None:
210
final_width = osutils.terminal_width()
211
final_width = final_width - 15 - 8
213
if SHOW_DESCRIPTIONS:
214
what = test.shortDescription()
216
what = self._ellipsise_unimportant_words(what, final_width, keep_start=True)
219
if what.startswith('bzrlib.tests.'):
221
what = self._ellipsise_unimportant_words(what, final_width)
223
self.stream.write(what)
224
elif self.dots and self.pb is not None:
225
self.pb.update(what, self.testsRun - 1, None)
227
self._recordTestStartTime()
229
def _recordTestStartTime(self):
230
"""Record that a test has started."""
231
self._start_time = time.time()
233
def addError(self, test, err):
234
if isinstance(err[1], TestSkipped):
235
return self.addSkipped(test, err)
236
unittest.TestResult.addError(self, test, err)
237
self.extractBenchmarkTime(test)
239
self.stream.writeln("ERROR %s" % self._testTimeString())
240
elif self.dots and self.pb is None:
241
self.stream.write('E')
243
self.pb.update(self._ellipsise_unimportant_words('ERROR', 13), self.testsRun, None)
244
self.pb.note(self._ellipsise_unimportant_words(
245
test.id() + ': ERROR',
246
osutils.terminal_width()))
251
def addFailure(self, test, err):
252
unittest.TestResult.addFailure(self, test, err)
253
self.extractBenchmarkTime(test)
255
self.stream.writeln(" FAIL %s" % self._testTimeString())
256
elif self.dots and self.pb is None:
257
self.stream.write('F')
259
self.pb.update(self._ellipsise_unimportant_words('FAIL', 13), self.testsRun, None)
260
self.pb.note(self._ellipsise_unimportant_words(
261
test.id() + ': FAIL',
262
osutils.terminal_width()))
267
def addSuccess(self, test):
268
self.extractBenchmarkTime(test)
269
if self._bench_history is not None:
270
if self._benchmarkTime is not None:
271
self._bench_history.write("%s %s\n" % (
272
self._formatTime(self._benchmarkTime),
275
self.stream.writeln(' OK %s' % self._testTimeString())
276
for bench_called, stats in getattr(test, '_benchcalls', []):
277
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
278
stats.pprint(file=self.stream)
279
elif self.dots and self.pb is None:
280
self.stream.write('~')
282
self.pb.update(self._ellipsise_unimportant_words('OK', 13), self.testsRun, None)
284
unittest.TestResult.addSuccess(self, test)
286
def addSkipped(self, test, skip_excinfo):
287
self.extractBenchmarkTime(test)
289
print >>self.stream, ' SKIP %s' % self._testTimeString()
290
print >>self.stream, ' %s' % skip_excinfo[1]
291
elif self.dots and self.pb is None:
292
self.stream.write('S')
294
self.pb.update(self._ellipsise_unimportant_words('SKIP', 13), self.testsRun, None)
296
# seems best to treat this as success from point-of-view of unittest
297
# -- it actually does nothing so it barely matters :)
300
except KeyboardInterrupt:
303
self.addError(test, test.__exc_info())
305
unittest.TestResult.addSuccess(self, test)
307
def printErrorList(self, flavour, errors):
308
for test, err in errors:
309
self.stream.writeln(self.separator1)
310
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
311
if getattr(test, '_get_log', None) is not None:
313
print >>self.stream, \
314
('vvvv[log from %s]' % test.id()).ljust(78,'-')
315
print >>self.stream, test._get_log()
316
print >>self.stream, \
317
('^^^^[log from %s]' % test.id()).ljust(78,'-')
318
self.stream.writeln(self.separator2)
319
self.stream.writeln("%s" % err)
322
class TextTestRunner(object):
323
stop_on_failure = False
332
self.stream = unittest._WritelnDecorator(stream)
333
self.descriptions = descriptions
334
self.verbosity = verbosity
335
self.keep_output = keep_output
337
self._bench_history = bench_history
339
def _makeResult(self):
340
result = _MyResult(self.stream,
344
bench_history=self._bench_history)
345
result.stop_early = self.stop_on_failure
349
"Run the given test case or test suite."
350
result = self._makeResult()
351
startTime = time.time()
352
if self.pb is not None:
353
self.pb.update('Running tests', 0, test.countTestCases())
355
stopTime = time.time()
356
timeTaken = stopTime - startTime
358
self.stream.writeln(result.separator2)
359
run = result.testsRun
360
self.stream.writeln("Ran %d test%s in %.3fs" %
361
(run, run != 1 and "s" or "", timeTaken))
362
self.stream.writeln()
363
if not result.wasSuccessful():
364
self.stream.write("FAILED (")
365
failed, errored = map(len, (result.failures, result.errors))
367
self.stream.write("failures=%d" % failed)
369
if failed: self.stream.write(", ")
370
self.stream.write("errors=%d" % errored)
371
self.stream.writeln(")")
373
self.stream.writeln("OK")
374
if self.pb is not None:
375
self.pb.update('Cleaning up', 0, 1)
376
# This is still a little bogus,
377
# but only a little. Folk not using our testrunner will
378
# have to delete their temp directories themselves.
379
test_root = TestCaseInTempDir.TEST_ROOT
380
if result.wasSuccessful() or not self.keep_output:
381
if test_root is not None:
382
# If LANG=C we probably have created some bogus paths
383
# which rmtree(unicode) will fail to delete
384
# so make sure we are using rmtree(str) to delete everything
385
# except on win32, where rmtree(str) will fail
386
# since it doesn't have the property of byte-stream paths
387
# (they are either ascii or mbcs)
388
if sys.platform == 'win32':
389
# make sure we are using the unicode win32 api
390
test_root = unicode(test_root)
392
test_root = test_root.encode(
393
sys.getfilesystemencoding())
394
osutils.rmtree(test_root)
396
if self.pb is not None:
397
self.pb.note("Failed tests working directories are in '%s'\n",
401
"Failed tests working directories are in '%s'\n" %
403
TestCaseInTempDir.TEST_ROOT = None
404
if self.pb is not None:
409
def iter_suite_tests(suite):
410
"""Return all tests in a suite, recursing through nested suites"""
411
for item in suite._tests:
412
if isinstance(item, unittest.TestCase):
414
elif isinstance(item, unittest.TestSuite):
415
for r in iter_suite_tests(item):
418
raise Exception('unknown object %r inside test suite %r'
422
class TestSkipped(Exception):
423
"""Indicates that a test was intentionally skipped, rather than failing."""
426
class CommandFailed(Exception):
430
class StringIOWrapper(object):
431
"""A wrapper around cStringIO which just adds an encoding attribute.
433
Internally we can check sys.stdout to see what the output encoding
434
should be. However, cStringIO has no encoding attribute that we can
435
set. So we wrap it instead.
440
def __init__(self, s=None):
442
self.__dict__['_cstring'] = StringIO(s)
444
self.__dict__['_cstring'] = StringIO()
446
def __getattr__(self, name, getattr=getattr):
447
return getattr(self.__dict__['_cstring'], name)
449
def __setattr__(self, name, val):
450
if name == 'encoding':
451
self.__dict__['encoding'] = val
453
return setattr(self._cstring, name, val)
456
class TestCase(unittest.TestCase):
457
"""Base class for bzr unit tests.
459
Tests that need access to disk resources should subclass
460
TestCaseInTempDir not TestCase.
462
Error and debug log messages are redirected from their usual
463
location into a temporary file, the contents of which can be
464
retrieved by _get_log(). We use a real OS file, not an in-memory object,
465
so that it can also capture file IO. When the test completes this file
466
is read into memory and removed from disk.
468
There are also convenience functions to invoke bzr's command-line
469
routine, and to build and check bzr trees.
471
In addition to the usual method of overriding tearDown(), this class also
472
allows subclasses to register functions into the _cleanups list, which is
473
run in order as the object is torn down. It's less likely this will be
474
accidentally overlooked.
477
_log_file_name = None
479
# record lsprof data when performing benchmark calls.
480
_gather_lsprof_in_benchmarks = False
482
def __init__(self, methodName='testMethod'):
483
super(TestCase, self).__init__(methodName)
487
unittest.TestCase.setUp(self)
488
self._cleanEnvironment()
489
bzrlib.trace.disable_default_logging()
491
self._benchcalls = []
492
self._benchtime = None
494
def _ndiff_strings(self, a, b):
495
"""Return ndiff between two strings containing lines.
497
A trailing newline is added if missing to make the strings
499
if b and b[-1] != '\n':
501
if a and a[-1] != '\n':
503
difflines = difflib.ndiff(a.splitlines(True),
505
linejunk=lambda x: False,
506
charjunk=lambda x: False)
507
return ''.join(difflines)
509
def assertEqualDiff(self, a, b, message=None):
510
"""Assert two texts are equal, if not raise an exception.
512
This is intended for use with multi-line strings where it can
513
be hard to find the differences by eye.
515
# TODO: perhaps override assertEquals to call this for strings?
519
message = "texts not equal:\n"
520
raise AssertionError(message +
521
self._ndiff_strings(a, b))
523
def assertEqualMode(self, mode, mode_test):
524
self.assertEqual(mode, mode_test,
525
'mode mismatch %o != %o' % (mode, mode_test))
527
def assertStartsWith(self, s, prefix):
528
if not s.startswith(prefix):
529
raise AssertionError('string %r does not start with %r' % (s, prefix))
531
def assertEndsWith(self, s, suffix):
532
"""Asserts that s ends with suffix."""
533
if not s.endswith(suffix):
534
raise AssertionError('string %r does not end with %r' % (s, suffix))
536
def assertContainsRe(self, haystack, needle_re):
537
"""Assert that a contains something matching a regular expression."""
538
if not re.search(needle_re, haystack):
539
raise AssertionError('pattern "%s" not found in "%s"'
540
% (needle_re, haystack))
542
def assertNotContainsRe(self, haystack, needle_re):
543
"""Assert that a does not match a regular expression"""
544
if re.search(needle_re, haystack):
545
raise AssertionError('pattern "%s" found in "%s"'
546
% (needle_re, haystack))
548
def assertSubset(self, sublist, superlist):
549
"""Assert that every entry in sublist is present in superlist."""
551
for entry in sublist:
552
if entry not in superlist:
553
missing.append(entry)
555
raise AssertionError("value(s) %r not present in container %r" %
556
(missing, superlist))
558
def assertIs(self, left, right):
559
if not (left is right):
560
raise AssertionError("%r is not %r." % (left, right))
562
def assertTransportMode(self, transport, path, mode):
563
"""Fail if a path does not have mode mode.
565
If modes are not supported on this transport, the assertion is ignored.
567
if not transport._can_roundtrip_unix_modebits():
569
path_stat = transport.stat(path)
570
actual_mode = stat.S_IMODE(path_stat.st_mode)
571
self.assertEqual(mode, actual_mode,
572
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
574
def assertIsInstance(self, obj, kls):
575
"""Fail if obj is not an instance of kls"""
576
if not isinstance(obj, kls):
577
self.fail("%r is an instance of %s rather than %s" % (
578
obj, obj.__class__, kls))
580
def callDeprecated(self, expected, callable, *args, **kwargs):
581
"""Assert that a callable is deprecated in a particular way.
583
:param expected: a list of the deprecation warnings expected, in order
584
:param callable: The callable to call
585
:param args: The positional arguments for the callable
586
:param kwargs: The keyword arguments for the callable
589
def capture_warnings(msg, cls, stacklevel=None):
590
self.assertEqual(cls, DeprecationWarning)
591
local_warnings.append(msg)
592
method = symbol_versioning.warn
593
symbol_versioning.set_warning_method(capture_warnings)
595
result = callable(*args, **kwargs)
597
symbol_versioning.set_warning_method(method)
598
self.assertEqual(expected, local_warnings)
601
def _startLogFile(self):
602
"""Send bzr and test log messages to a temporary file.
604
The file is removed as the test is torn down.
606
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
607
self._log_file = os.fdopen(fileno, 'w+')
608
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
609
self._log_file_name = name
610
self.addCleanup(self._finishLogFile)
612
def _finishLogFile(self):
613
"""Finished with the log file.
615
Read contents into memory, close, and delete.
617
if self._log_file is None:
619
bzrlib.trace.disable_test_log(self._log_nonce)
620
self._log_file.seek(0)
621
self._log_contents = self._log_file.read()
622
self._log_file.close()
623
os.remove(self._log_file_name)
624
self._log_file = self._log_file_name = None
626
def addCleanup(self, callable):
627
"""Arrange to run a callable when this case is torn down.
629
Callables are run in the reverse of the order they are registered,
630
ie last-in first-out.
632
if callable in self._cleanups:
633
raise ValueError("cleanup function %r already registered on %s"
635
self._cleanups.append(callable)
637
def _cleanEnvironment(self):
640
'APPDATA': os.getcwd(),
642
'BZREMAIL': None, # may still be present in the environment
644
'BZR_PROGRESS_BAR': None,
647
self.addCleanup(self._restoreEnvironment)
648
for name, value in new_env.iteritems():
649
self._captureVar(name, value)
651
def _captureVar(self, name, newvalue):
652
"""Set an environment variable, and reset it when finished."""
653
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
655
def _restoreEnvironment(self):
656
for name, value in self.__old_env.iteritems():
657
osutils.set_or_unset_env(name, value)
661
unittest.TestCase.tearDown(self)
663
def time(self, callable, *args, **kwargs):
664
"""Run callable and accrue the time it takes to the benchmark time.
666
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
667
this will cause lsprofile statistics to be gathered and stored in
670
if self._benchtime is None:
674
if not self._gather_lsprof_in_benchmarks:
675
return callable(*args, **kwargs)
677
# record this benchmark
678
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
680
self._benchcalls.append(((callable, args, kwargs), stats))
683
self._benchtime += time.time() - start
685
def _runCleanups(self):
686
"""Run registered cleanup functions.
688
This should only be called from TestCase.tearDown.
690
# TODO: Perhaps this should keep running cleanups even if
692
for cleanup_fn in reversed(self._cleanups):
695
def log(self, *args):
699
"""Return as a string the log for this test"""
700
if self._log_file_name:
701
return open(self._log_file_name).read()
703
return self._log_contents
704
# TODO: Delete the log after it's been read in
706
def capture(self, cmd, retcode=0):
707
"""Shortcut that splits cmd into words, runs, and returns stdout"""
708
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
710
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None):
711
"""Invoke bzr and return (stdout, stderr).
713
Useful for code that wants to check the contents of the
714
output, the way error messages are presented, etc.
716
This should be the main method for tests that want to exercise the
717
overall behavior of the bzr application (rather than a unit test
718
or a functional test of the library.)
720
Much of the old code runs bzr by forking a new copy of Python, but
721
that is slower, harder to debug, and generally not necessary.
723
This runs bzr through the interface that catches and reports
724
errors, and with logging set to something approximating the
725
default, so that error reporting can be checked.
727
:param argv: arguments to invoke bzr
728
:param retcode: expected return code, or None for don't-care.
729
:param encoding: encoding for sys.stdout and sys.stderr
730
:param stdin: A string to be used as stdin for the command.
733
encoding = bzrlib.user_encoding
734
if stdin is not None:
735
stdin = StringIO(stdin)
736
stdout = StringIOWrapper()
737
stderr = StringIOWrapper()
738
stdout.encoding = encoding
739
stderr.encoding = encoding
741
self.log('run bzr: %r', argv)
742
# FIXME: don't call into logging here
743
handler = logging.StreamHandler(stderr)
744
handler.setLevel(logging.INFO)
745
logger = logging.getLogger('')
746
logger.addHandler(handler)
747
old_ui_factory = bzrlib.ui.ui_factory
748
bzrlib.ui.ui_factory = bzrlib.tests.blackbox.TestUIFactory(
751
bzrlib.ui.ui_factory.stdin = stdin
753
result = self.apply_redirected(stdin, stdout, stderr,
754
bzrlib.commands.run_bzr_catch_errors,
757
logger.removeHandler(handler)
758
bzrlib.ui.ui_factory = old_ui_factory
760
out = stdout.getvalue()
761
err = stderr.getvalue()
763
self.log('output:\n%r', out)
765
self.log('errors:\n%r', err)
766
if retcode is not None:
767
self.assertEquals(retcode, result)
770
def run_bzr(self, *args, **kwargs):
771
"""Invoke bzr, as if it were run from the command line.
773
This should be the main method for tests that want to exercise the
774
overall behavior of the bzr application (rather than a unit test
775
or a functional test of the library.)
777
This sends the stdout/stderr results into the test's log,
778
where it may be useful for debugging. See also run_captured.
780
:param stdin: A string to be used as stdin for the command.
782
retcode = kwargs.pop('retcode', 0)
783
encoding = kwargs.pop('encoding', None)
784
stdin = kwargs.pop('stdin', None)
785
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding, stdin=stdin)
787
def run_bzr_decode(self, *args, **kwargs):
788
if kwargs.has_key('encoding'):
789
encoding = kwargs['encoding']
791
encoding = bzrlib.user_encoding
792
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
794
def run_bzr_error(self, error_regexes, *args, **kwargs):
795
"""Run bzr, and check that stderr contains the supplied regexes
797
:param error_regexes: Sequence of regular expressions which
798
must each be found in the error output. The relative ordering
800
:param args: command-line arguments for bzr
801
:param kwargs: Keyword arguments which are interpreted by run_bzr
802
This function changes the default value of retcode to be 3,
803
since in most cases this is run when you expect bzr to fail.
804
:return: (out, err) The actual output of running the command (in case you
805
want to do more inspection)
808
# Make sure that commit is failing because there is nothing to do
809
self.run_bzr_error(['no changes to commit'],
810
'commit', '-m', 'my commit comment')
811
# Make sure --strict is handling an unknown file, rather than
812
# giving us the 'nothing to do' error
813
self.build_tree(['unknown'])
814
self.run_bzr_error(['Commit refused because there are unknown files'],
815
'commit', '--strict', '-m', 'my commit comment')
817
kwargs.setdefault('retcode', 3)
818
out, err = self.run_bzr(*args, **kwargs)
819
for regex in error_regexes:
820
self.assertContainsRe(err, regex)
823
def run_bzr_subprocess(self, *args, **kwargs):
824
"""Run bzr in a subprocess for testing.
826
This starts a new Python interpreter and runs bzr in there.
827
This should only be used for tests that have a justifiable need for
828
this isolation: e.g. they are testing startup time, or signal
829
handling, or early startup code, etc. Subprocess code can't be
830
profiled or debugged so easily.
832
:param retcode: The status code that is expected. Defaults to 0. If
833
None is supplied, the status code is not checked.
834
:param env_changes: A dictionary which lists changes to environment
835
variables. A value of None will unset the env variable.
836
The values must be strings. The change will only occur in the
837
child, so you don't need to fix the environment after running.
839
env_changes = kwargs.get('env_changes', {})
843
def cleanup_environment():
844
for env_var, value in env_changes.iteritems():
845
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
847
def restore_environment():
848
for env_var, value in old_env.iteritems():
849
osutils.set_or_unset_env(env_var, value)
851
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
855
# win32 subprocess doesn't support preexec_fn
856
# so we will avoid using it on all platforms, just to
857
# make sure the code path is used, and we don't break on win32
858
cleanup_environment()
859
process = Popen([sys.executable, bzr_path]+args,
860
stdout=PIPE, stderr=PIPE)
862
restore_environment()
864
out = process.stdout.read()
865
err = process.stderr.read()
866
retcode = process.wait()
867
supplied_retcode = kwargs.get('retcode', 0)
868
if supplied_retcode is not None:
869
assert supplied_retcode == retcode
872
def check_inventory_shape(self, inv, shape):
873
"""Compare an inventory to a list of expected names.
875
Fail if they are not precisely equal.
878
shape = list(shape) # copy
879
for path, ie in inv.entries():
880
name = path.replace('\\', '/')
888
self.fail("expected paths not found in inventory: %r" % shape)
890
self.fail("unexpected paths found in inventory: %r" % extras)
892
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
893
a_callable=None, *args, **kwargs):
894
"""Call callable with redirected std io pipes.
896
Returns the return code."""
897
if not callable(a_callable):
898
raise ValueError("a_callable must be callable.")
902
if getattr(self, "_log_file", None) is not None:
903
stdout = self._log_file
907
if getattr(self, "_log_file", None is not None):
908
stderr = self._log_file
911
real_stdin = sys.stdin
912
real_stdout = sys.stdout
913
real_stderr = sys.stderr
918
return a_callable(*args, **kwargs)
920
sys.stdout = real_stdout
921
sys.stderr = real_stderr
922
sys.stdin = real_stdin
924
def merge(self, branch_from, wt_to):
925
"""A helper for tests to do a ui-less merge.
927
This should move to the main library when someone has time to integrate
930
# minimal ui-less merge.
931
wt_to.branch.fetch(branch_from)
932
base_rev = common_ancestor(branch_from.last_revision(),
933
wt_to.branch.last_revision(),
934
wt_to.branch.repository)
935
merge_inner(wt_to.branch, branch_from.basis_tree(),
936
wt_to.branch.repository.revision_tree(base_rev),
938
wt_to.add_parent_tree_id(branch_from.last_revision())
941
BzrTestBase = TestCase
944
class TestCaseInTempDir(TestCase):
945
"""Derived class that runs a test within a temporary directory.
947
This is useful for tests that need to create a branch, etc.
949
The directory is created in a slightly complex way: for each
950
Python invocation, a new temporary top-level directory is created.
951
All test cases create their own directory within that. If the
952
tests complete successfully, the directory is removed.
954
InTempDir is an old alias for FunctionalTestCase.
959
OVERRIDE_PYTHON = 'python'
961
def check_file_contents(self, filename, expect):
962
self.log("check contents of file %s" % filename)
963
contents = file(filename, 'r').read()
964
if contents != expect:
965
self.log("expected: %r" % expect)
966
self.log("actually: %r" % contents)
967
self.fail("contents of %s not as expected" % filename)
969
def _make_test_root(self):
970
if TestCaseInTempDir.TEST_ROOT is not None:
974
root = u'test%04d.tmp' % i
978
if e.errno == errno.EEXIST:
983
# successfully created
984
TestCaseInTempDir.TEST_ROOT = osutils.abspath(root)
986
# make a fake bzr directory there to prevent any tests propagating
987
# up onto the source directory's real branch
988
bzrdir.BzrDir.create_standalone_workingtree(TestCaseInTempDir.TEST_ROOT)
991
super(TestCaseInTempDir, self).setUp()
992
self._make_test_root()
993
_currentdir = os.getcwdu()
994
# shorten the name, to avoid test failures due to path length
995
short_id = self.id().replace('bzrlib.tests.', '') \
996
.replace('__main__.', '')[-100:]
997
# it's possible the same test class is run several times for
998
# parameterized tests, so make sure the names don't collide.
1002
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1004
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1005
if os.path.exists(candidate_dir):
1009
self.test_dir = candidate_dir
1010
os.mkdir(self.test_dir)
1011
os.chdir(self.test_dir)
1013
os.environ['HOME'] = self.test_dir
1014
os.environ['APPDATA'] = self.test_dir
1015
def _leaveDirectory():
1016
os.chdir(_currentdir)
1017
self.addCleanup(_leaveDirectory)
1019
def build_tree(self, shape, line_endings='native', transport=None):
1020
"""Build a test tree according to a pattern.
1022
shape is a sequence of file specifications. If the final
1023
character is '/', a directory is created.
1025
This assumes that all the elements in the tree being built are new.
1027
This doesn't add anything to a branch.
1028
:param line_endings: Either 'binary' or 'native'
1029
in binary mode, exact contents are written
1030
in native mode, the line endings match the
1031
default platform endings.
1033
:param transport: A transport to write to, for building trees on
1034
VFS's. If the transport is readonly or None,
1035
"." is opened automatically.
1037
# It's OK to just create them using forward slashes on windows.
1038
if transport is None or transport.is_readonly():
1039
transport = get_transport(".")
1041
self.assert_(isinstance(name, basestring))
1043
transport.mkdir(urlutils.escape(name[:-1]))
1045
if line_endings == 'binary':
1047
elif line_endings == 'native':
1050
raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
1051
content = "contents of %s%s" % (name.encode('utf-8'), end)
1052
# Technically 'put()' is the right command. However, put
1053
# uses an AtomicFile, which requires an extra rename into place
1054
# As long as the files didn't exist in the past, append() will
1055
# do the same thing as put()
1056
# On jam's machine, make_kernel_like_tree is:
1057
# put: 4.5-7.5s (averaging 6s)
1059
transport.append(urlutils.escape(name), StringIO(content))
1061
def build_tree_contents(self, shape):
1062
build_tree_contents(shape)
1064
def failUnlessExists(self, path):
1065
"""Fail unless path, which may be abs or relative, exists."""
1066
self.failUnless(osutils.lexists(path))
1068
def failIfExists(self, path):
1069
"""Fail if path, which may be abs or relative, exists."""
1070
self.failIf(osutils.lexists(path))
1072
def assertFileEqual(self, content, path):
1073
"""Fail if path does not contain 'content'."""
1074
self.failUnless(osutils.lexists(path))
1075
# TODO: jam 20060427 Shouldn't this be 'rb'?
1076
self.assertEqualDiff(content, open(path, 'r').read())
1079
class TestCaseWithTransport(TestCaseInTempDir):
1080
"""A test case that provides get_url and get_readonly_url facilities.
1082
These back onto two transport servers, one for readonly access and one for
1085
If no explicit class is provided for readonly access, a
1086
ReadonlyTransportDecorator is used instead which allows the use of non disk
1087
based read write transports.
1089
If an explicit class is provided for readonly access, that server and the
1090
readwrite one must both define get_url() as resolving to os.getcwd().
1093
def __init__(self, methodName='testMethod'):
1094
super(TestCaseWithTransport, self).__init__(methodName)
1095
self.__readonly_server = None
1096
self.__server = None
1097
self.transport_server = default_transport
1098
self.transport_readonly_server = None
1100
def get_readonly_url(self, relpath=None):
1101
"""Get a URL for the readonly transport.
1103
This will either be backed by '.' or a decorator to the transport
1104
used by self.get_url()
1105
relpath provides for clients to get a path relative to the base url.
1106
These should only be downwards relative, not upwards.
1108
base = self.get_readonly_server().get_url()
1109
if relpath is not None:
1110
if not base.endswith('/'):
1112
base = base + relpath
1115
def get_readonly_server(self):
1116
"""Get the server instance for the readonly transport
1118
This is useful for some tests with specific servers to do diagnostics.
1120
if self.__readonly_server is None:
1121
if self.transport_readonly_server is None:
1122
# readonly decorator requested
1123
# bring up the server
1125
self.__readonly_server = ReadonlyServer()
1126
self.__readonly_server.setUp(self.__server)
1128
self.__readonly_server = self.transport_readonly_server()
1129
self.__readonly_server.setUp()
1130
self.addCleanup(self.__readonly_server.tearDown)
1131
return self.__readonly_server
1133
def get_server(self):
1134
"""Get the read/write server instance.
1136
This is useful for some tests with specific servers that need
1139
if self.__server is None:
1140
self.__server = self.transport_server()
1141
self.__server.setUp()
1142
self.addCleanup(self.__server.tearDown)
1143
return self.__server
1145
def get_url(self, relpath=None):
1146
"""Get a URL for the readwrite transport.
1148
This will either be backed by '.' or to an equivalent non-file based
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_server().get_url()
1154
if relpath is not None and relpath != '.':
1155
if not base.endswith('/'):
1157
base = base + urlutils.escape(relpath)
1160
def get_transport(self):
1161
"""Return a writeable transport for the test scratch space"""
1162
t = get_transport(self.get_url())
1163
self.assertFalse(t.is_readonly())
1166
def get_readonly_transport(self):
1167
"""Return a readonly transport for the test scratch space
1169
This can be used to test that operations which should only need
1170
readonly access in fact do not try to write.
1172
t = get_transport(self.get_readonly_url())
1173
self.assertTrue(t.is_readonly())
1176
def make_branch(self, relpath, format=None):
1177
"""Create a branch on the transport at relpath."""
1178
repo = self.make_repository(relpath, format=format)
1179
return repo.bzrdir.create_branch()
1181
def make_bzrdir(self, relpath, format=None):
1183
url = self.get_url(relpath)
1184
mutter('relpath %r => url %r', relpath, url)
1185
segments = url.split('/')
1186
if segments and segments[-1] not in ('', '.'):
1187
parent = '/'.join(segments[:-1])
1188
t = get_transport(parent)
1190
t.mkdir(segments[-1])
1191
except errors.FileExists:
1194
format=bzrlib.bzrdir.BzrDirFormat.get_default_format()
1195
# FIXME: make this use a single transport someday. RBC 20060418
1196
return format.initialize_on_transport(get_transport(relpath))
1197
except errors.UninitializableFormat:
1198
raise TestSkipped("Format %s is not initializable." % format)
1200
def make_repository(self, relpath, shared=False, format=None):
1201
"""Create a repository on our default transport at relpath."""
1202
made_control = self.make_bzrdir(relpath, format=format)
1203
return made_control.create_repository(shared=shared)
1205
def make_branch_and_tree(self, relpath, format=None):
1206
"""Create a branch on the transport and a tree locally.
1210
# TODO: always use the local disk path for the working tree,
1211
# this obviously requires a format that supports branch references
1212
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1214
b = self.make_branch(relpath, format=format)
1216
return b.bzrdir.create_workingtree()
1217
except errors.NotLocalUrl:
1218
# new formats - catch No tree error and create
1219
# a branch reference and a checkout.
1220
# old formats at that point - raise TestSkipped.
1221
# TODO: rbc 20060208
1222
return WorkingTreeFormat2().initialize(bzrdir.BzrDir.open(relpath))
1224
def assertIsDirectory(self, relpath, transport):
1225
"""Assert that relpath within transport is a directory.
1227
This may not be possible on all transports; in that case it propagates
1228
a TransportNotPossible.
1231
mode = transport.stat(relpath).st_mode
1232
except errors.NoSuchFile:
1233
self.fail("path %s is not a directory; no such file"
1235
if not stat.S_ISDIR(mode):
1236
self.fail("path %s is not a directory; has mode %#o"
1240
class ChrootedTestCase(TestCaseWithTransport):
1241
"""A support class that provides readonly urls outside the local namespace.
1243
This is done by checking if self.transport_server is a MemoryServer. if it
1244
is then we are chrooted already, if it is not then an HttpServer is used
1247
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1248
be used without needed to redo it when a different
1249
subclass is in use ?
1253
super(ChrootedTestCase, self).setUp()
1254
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
1255
self.transport_readonly_server = bzrlib.transport.http.HttpServer
1258
def filter_suite_by_re(suite, pattern):
1259
result = TestUtil.TestSuite()
1260
filter_re = re.compile(pattern)
1261
for test in iter_suite_tests(suite):
1262
if filter_re.search(test.id()):
1263
result.addTest(test)
1267
def run_suite(suite, name='test', verbose=False, pattern=".*",
1268
stop_on_failure=False, keep_output=False,
1269
transport=None, lsprof_timed=None, bench_history=None):
1270
TestCaseInTempDir._TEST_NAME = name
1271
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1277
pb = progress.ProgressBar()
1278
runner = TextTestRunner(stream=sys.stdout,
1280
verbosity=verbosity,
1281
keep_output=keep_output,
1283
bench_history=bench_history)
1284
runner.stop_on_failure=stop_on_failure
1286
suite = filter_suite_by_re(suite, pattern)
1287
result = runner.run(suite)
1288
return result.wasSuccessful()
1291
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1294
test_suite_factory=None,
1296
bench_history=None):
1297
"""Run the whole test suite under the enhanced runner"""
1298
# XXX: Very ugly way to do this...
1299
# Disable warning about old formats because we don't want it to disturb
1300
# any blackbox tests.
1301
from bzrlib import repository
1302
repository._deprecation_warning_done = True
1304
global default_transport
1305
if transport is None:
1306
transport = default_transport
1307
old_transport = default_transport
1308
default_transport = transport
1310
if test_suite_factory is None:
1311
suite = test_suite()
1313
suite = test_suite_factory()
1314
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1315
stop_on_failure=stop_on_failure, keep_output=keep_output,
1316
transport=transport,
1317
lsprof_timed=lsprof_timed,
1318
bench_history=bench_history)
1320
default_transport = old_transport
1324
"""Build and return TestSuite for the whole of bzrlib.
1326
This function can be replaced if you need to change the default test
1327
suite on a global basis, but it is not encouraged.
1330
'bzrlib.tests.test_ancestry',
1331
'bzrlib.tests.test_api',
1332
'bzrlib.tests.test_atomicfile',
1333
'bzrlib.tests.test_bad_files',
1334
'bzrlib.tests.test_branch',
1335
'bzrlib.tests.test_bundle',
1336
'bzrlib.tests.test_bzrdir',
1337
'bzrlib.tests.test_cache_utf8',
1338
'bzrlib.tests.test_command',
1339
'bzrlib.tests.test_commit',
1340
'bzrlib.tests.test_commit_merge',
1341
'bzrlib.tests.test_config',
1342
'bzrlib.tests.test_conflicts',
1343
'bzrlib.tests.test_decorators',
1344
'bzrlib.tests.test_diff',
1345
'bzrlib.tests.test_doc_generate',
1346
'bzrlib.tests.test_errors',
1347
'bzrlib.tests.test_escaped_store',
1348
'bzrlib.tests.test_fetch',
1349
'bzrlib.tests.test_gpg',
1350
'bzrlib.tests.test_graph',
1351
'bzrlib.tests.test_hashcache',
1352
'bzrlib.tests.test_http',
1353
'bzrlib.tests.test_http_response',
1354
'bzrlib.tests.test_identitymap',
1355
'bzrlib.tests.test_ignores',
1356
'bzrlib.tests.test_inv',
1357
'bzrlib.tests.test_knit',
1358
'bzrlib.tests.test_lockdir',
1359
'bzrlib.tests.test_lockable_files',
1360
'bzrlib.tests.test_log',
1361
'bzrlib.tests.test_merge',
1362
'bzrlib.tests.test_merge3',
1363
'bzrlib.tests.test_merge_core',
1364
'bzrlib.tests.test_missing',
1365
'bzrlib.tests.test_msgeditor',
1366
'bzrlib.tests.test_nonascii',
1367
'bzrlib.tests.test_options',
1368
'bzrlib.tests.test_osutils',
1369
'bzrlib.tests.test_patch',
1370
'bzrlib.tests.test_patches',
1371
'bzrlib.tests.test_permissions',
1372
'bzrlib.tests.test_plugins',
1373
'bzrlib.tests.test_progress',
1374
'bzrlib.tests.test_reconcile',
1375
'bzrlib.tests.test_repository',
1376
'bzrlib.tests.test_revert',
1377
'bzrlib.tests.test_revision',
1378
'bzrlib.tests.test_revisionnamespaces',
1379
'bzrlib.tests.test_revisiontree',
1380
'bzrlib.tests.test_rio',
1381
'bzrlib.tests.test_sampler',
1382
'bzrlib.tests.test_selftest',
1383
'bzrlib.tests.test_setup',
1384
'bzrlib.tests.test_sftp_transport',
1385
'bzrlib.tests.test_ftp_transport',
1386
'bzrlib.tests.test_smart_add',
1387
'bzrlib.tests.test_source',
1388
'bzrlib.tests.test_status',
1389
'bzrlib.tests.test_store',
1390
'bzrlib.tests.test_symbol_versioning',
1391
'bzrlib.tests.test_testament',
1392
'bzrlib.tests.test_textfile',
1393
'bzrlib.tests.test_textmerge',
1394
'bzrlib.tests.test_trace',
1395
'bzrlib.tests.test_transactions',
1396
'bzrlib.tests.test_transform',
1397
'bzrlib.tests.test_transport',
1398
'bzrlib.tests.test_tree',
1399
'bzrlib.tests.test_tsort',
1400
'bzrlib.tests.test_tuned_gzip',
1401
'bzrlib.tests.test_ui',
1402
'bzrlib.tests.test_upgrade',
1403
'bzrlib.tests.test_urlutils',
1404
'bzrlib.tests.test_versionedfile',
1405
'bzrlib.tests.test_version',
1406
'bzrlib.tests.test_weave',
1407
'bzrlib.tests.test_whitebox',
1408
'bzrlib.tests.test_workingtree',
1409
'bzrlib.tests.test_xml',
1411
test_transport_implementations = [
1412
'bzrlib.tests.test_transport_implementations',
1413
'bzrlib.tests.test_read_bundle',
1415
suite = TestUtil.TestSuite()
1416
loader = TestUtil.TestLoader()
1417
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1418
from bzrlib.transport import TransportTestProviderAdapter
1419
adapter = TransportTestProviderAdapter()
1420
adapt_modules(test_transport_implementations, adapter, loader, suite)
1421
for package in packages_to_test():
1422
suite.addTest(package.test_suite())
1423
for m in MODULES_TO_TEST:
1424
suite.addTest(loader.loadTestsFromModule(m))
1425
for m in MODULES_TO_DOCTEST:
1426
suite.addTest(doctest.DocTestSuite(m))
1427
for name, plugin in bzrlib.plugin.all_plugins().items():
1428
if getattr(plugin, 'test_suite', None) is not None:
1429
suite.addTest(plugin.test_suite())
1433
def adapt_modules(mods_list, adapter, loader, suite):
1434
"""Adapt the modules in mods_list using adapter and add to suite."""
1435
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1436
suite.addTests(adapter.adapt(test))
added
removed
bzrlib/tests/__init__.py
