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
68
from bzrlib.transport import get_transport
69
import bzrlib.transport
70
from bzrlib.transport.local import LocalRelpathServer
71
from bzrlib.transport.readonly import ReadonlyServer
72
from bzrlib.trace import mutter
73
from bzrlib.tests import TestUtil
74
from bzrlib.tests.TestUtil import (
78
from bzrlib.tests.treeshape import build_tree_contents
79
import bzrlib.urlutils as urlutils
80
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
82
default_transport = LocalRelpathServer
85
MODULES_TO_DOCTEST = [
87
bzrlib.bundle.serializer,
100
def packages_to_test():
101
"""Return a list of packages to test.
103
The packages are not globally imported so that import failures are
104
triggered when running selftest, not when importing the command.
107
import bzrlib.tests.blackbox
108
import bzrlib.tests.branch_implementations
109
import bzrlib.tests.bzrdir_implementations
110
import bzrlib.tests.interrepository_implementations
111
import bzrlib.tests.interversionedfile_implementations
112
import bzrlib.tests.repository_implementations
113
import bzrlib.tests.revisionstore_implementations
114
import bzrlib.tests.workingtree_implementations
117
bzrlib.tests.blackbox,
118
bzrlib.tests.branch_implementations,
119
bzrlib.tests.bzrdir_implementations,
120
bzrlib.tests.interrepository_implementations,
121
bzrlib.tests.interversionedfile_implementations,
122
bzrlib.tests.repository_implementations,
123
bzrlib.tests.revisionstore_implementations,
124
bzrlib.tests.workingtree_implementations,
128
class _MyResult(unittest._TextTestResult):
129
"""Custom TestResult.
131
Shows output in a different format, including displaying runtime for tests.
135
def __init__(self, stream, descriptions, verbosity, pb=None):
136
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
139
def extractBenchmarkTime(self, testCase):
140
"""Add a benchmark time for the current test case."""
141
self._benchmarkTime = getattr(testCase, "_benchtime", None)
143
def _elapsedTestTimeString(self):
144
"""Return a time string for the overall time the current test has taken."""
145
return self._formatTime(time.time() - self._start_time)
147
def _testTimeString(self):
148
if self._benchmarkTime is not None:
150
self._formatTime(self._benchmarkTime),
151
self._elapsedTestTimeString())
153
return " %s" % self._elapsedTestTimeString()
155
def _formatTime(self, seconds):
156
"""Format seconds as milliseconds with leading spaces."""
157
return "%5dms" % (1000 * seconds)
159
def _ellipsise_unimportant_words(self, a_string, final_width,
161
"""Add ellipses (sp?) for overly long strings.
163
:param keep_start: If true preserve the start of a_string rather
167
if len(a_string) > final_width:
168
result = a_string[:final_width-3] + '...'
172
if len(a_string) > final_width:
173
result = '...' + a_string[3-final_width:]
176
return result.ljust(final_width)
178
def startTest(self, test):
179
unittest.TestResult.startTest(self, test)
180
# In a short description, the important words are in
181
# the beginning, but in an id, the important words are
183
SHOW_DESCRIPTIONS = False
185
if not self.showAll and self.dots and self.pb is not None:
188
final_width = osutils.terminal_width()
189
final_width = final_width - 15 - 8
191
if SHOW_DESCRIPTIONS:
192
what = test.shortDescription()
194
what = self._ellipsise_unimportant_words(what, final_width, keep_start=True)
197
if what.startswith('bzrlib.tests.'):
199
what = self._ellipsise_unimportant_words(what, final_width)
201
self.stream.write(what)
202
elif self.dots and self.pb is not None:
203
self.pb.update(what, self.testsRun - 1, None)
205
self._recordTestStartTime()
207
def _recordTestStartTime(self):
208
"""Record that a test has started."""
209
self._start_time = time.time()
211
def addError(self, test, err):
212
if isinstance(err[1], TestSkipped):
213
return self.addSkipped(test, err)
214
unittest.TestResult.addError(self, test, err)
215
self.extractBenchmarkTime(test)
217
self.stream.writeln("ERROR %s" % self._testTimeString())
218
elif self.dots and self.pb is None:
219
self.stream.write('E')
221
self.pb.update(self._ellipsise_unimportant_words('ERROR', 13), self.testsRun, None)
226
def addFailure(self, test, err):
227
unittest.TestResult.addFailure(self, test, err)
228
self.extractBenchmarkTime(test)
230
self.stream.writeln(" FAIL %s" % self._testTimeString())
231
elif self.dots and self.pb is None:
232
self.stream.write('F')
234
self.pb.update(self._ellipsise_unimportant_words('FAIL', 13), self.testsRun, None)
239
def addSuccess(self, test):
240
self.extractBenchmarkTime(test)
242
self.stream.writeln(' OK %s' % self._testTimeString())
243
for bench_called, stats in getattr(test, '_benchcalls', []):
244
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
245
stats.pprint(file=self.stream)
246
elif self.dots and self.pb is None:
247
self.stream.write('~')
249
self.pb.update(self._ellipsise_unimportant_words('OK', 13), self.testsRun, None)
251
unittest.TestResult.addSuccess(self, test)
253
def addSkipped(self, test, skip_excinfo):
254
self.extractBenchmarkTime(test)
256
print >>self.stream, ' SKIP %s' % self._testTimeString()
257
print >>self.stream, ' %s' % skip_excinfo[1]
258
elif self.dots and self.pb is None:
259
self.stream.write('S')
261
self.pb.update(self._ellipsise_unimportant_words('SKIP', 13), self.testsRun, None)
263
# seems best to treat this as success from point-of-view of unittest
264
# -- it actually does nothing so it barely matters :)
267
except KeyboardInterrupt:
270
self.addError(test, test.__exc_info())
272
unittest.TestResult.addSuccess(self, test)
274
def printErrorList(self, flavour, errors):
275
for test, err in errors:
276
self.stream.writeln(self.separator1)
277
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
278
if getattr(test, '_get_log', None) is not None:
280
print >>self.stream, \
281
('vvvv[log from %s]' % test.id()).ljust(78,'-')
282
print >>self.stream, test._get_log()
283
print >>self.stream, \
284
('^^^^[log from %s]' % test.id()).ljust(78,'-')
285
self.stream.writeln(self.separator2)
286
self.stream.writeln("%s" % err)
289
class TextTestRunner(object):
290
stop_on_failure = False
298
self.stream = unittest._WritelnDecorator(stream)
299
self.descriptions = descriptions
300
self.verbosity = verbosity
301
self.keep_output = keep_output
304
def _makeResult(self):
305
result = _MyResult(self.stream,
309
result.stop_early = self.stop_on_failure
313
"Run the given test case or test suite."
314
result = self._makeResult()
315
startTime = time.time()
316
if self.pb is not None:
317
self.pb.update('Running tests', 0, test.countTestCases())
319
stopTime = time.time()
320
timeTaken = stopTime - startTime
322
self.stream.writeln(result.separator2)
323
run = result.testsRun
324
self.stream.writeln("Ran %d test%s in %.3fs" %
325
(run, run != 1 and "s" or "", timeTaken))
326
self.stream.writeln()
327
if not result.wasSuccessful():
328
self.stream.write("FAILED (")
329
failed, errored = map(len, (result.failures, result.errors))
331
self.stream.write("failures=%d" % failed)
333
if failed: self.stream.write(", ")
334
self.stream.write("errors=%d" % errored)
335
self.stream.writeln(")")
337
self.stream.writeln("OK")
338
if self.pb is not None:
339
self.pb.update('Cleaning up', 0, 1)
340
# This is still a little bogus,
341
# but only a little. Folk not using our testrunner will
342
# have to delete their temp directories themselves.
343
test_root = TestCaseInTempDir.TEST_ROOT
344
if result.wasSuccessful() or not self.keep_output:
345
if test_root is not None:
346
# If LANG=C we probably have created some bogus paths
347
# which rmtree(unicode) will fail to delete
348
# so make sure we are using rmtree(str) to delete everything
349
# except on win32, where rmtree(str) will fail
350
# since it doesn't have the property of byte-stream paths
351
# (they are either ascii or mbcs)
352
if sys.platform == 'win32':
353
# make sure we are using the unicode win32 api
354
test_root = unicode(test_root)
356
test_root = test_root.encode(
357
sys.getfilesystemencoding())
358
osutils.rmtree(test_root)
360
if self.pb is not None:
361
self.pb.note("Failed tests working directories are in '%s'\n",
365
"Failed tests working directories are in '%s'\n" %
367
TestCaseInTempDir.TEST_ROOT = None
368
if self.pb is not None:
373
def iter_suite_tests(suite):
374
"""Return all tests in a suite, recursing through nested suites"""
375
for item in suite._tests:
376
if isinstance(item, unittest.TestCase):
378
elif isinstance(item, unittest.TestSuite):
379
for r in iter_suite_tests(item):
382
raise Exception('unknown object %r inside test suite %r'
386
class TestSkipped(Exception):
387
"""Indicates that a test was intentionally skipped, rather than failing."""
391
class CommandFailed(Exception):
395
class StringIOWrapper(object):
396
"""A wrapper around cStringIO which just adds an encoding attribute.
398
Internally we can check sys.stdout to see what the output encoding
399
should be. However, cStringIO has no encoding attribute that we can
400
set. So we wrap it instead.
405
def __init__(self, s=None):
407
self.__dict__['_cstring'] = StringIO(s)
409
self.__dict__['_cstring'] = StringIO()
411
def __getattr__(self, name, getattr=getattr):
412
return getattr(self.__dict__['_cstring'], name)
414
def __setattr__(self, name, val):
415
if name == 'encoding':
416
self.__dict__['encoding'] = val
418
return setattr(self._cstring, name, val)
421
class TestCase(unittest.TestCase):
422
"""Base class for bzr unit tests.
424
Tests that need access to disk resources should subclass
425
TestCaseInTempDir not TestCase.
427
Error and debug log messages are redirected from their usual
428
location into a temporary file, the contents of which can be
429
retrieved by _get_log(). We use a real OS file, not an in-memory object,
430
so that it can also capture file IO. When the test completes this file
431
is read into memory and removed from disk.
433
There are also convenience functions to invoke bzr's command-line
434
routine, and to build and check bzr trees.
436
In addition to the usual method of overriding tearDown(), this class also
437
allows subclasses to register functions into the _cleanups list, which is
438
run in order as the object is torn down. It's less likely this will be
439
accidentally overlooked.
442
_log_file_name = None
444
# record lsprof data when performing benchmark calls.
445
_gather_lsprof_in_benchmarks = False
447
def __init__(self, methodName='testMethod'):
448
super(TestCase, self).__init__(methodName)
452
unittest.TestCase.setUp(self)
453
self._cleanEnvironment()
454
bzrlib.trace.disable_default_logging()
456
self._benchcalls = []
457
self._benchtime = None
459
def _ndiff_strings(self, a, b):
460
"""Return ndiff between two strings containing lines.
462
A trailing newline is added if missing to make the strings
464
if b and b[-1] != '\n':
466
if a and a[-1] != '\n':
468
difflines = difflib.ndiff(a.splitlines(True),
470
linejunk=lambda x: False,
471
charjunk=lambda x: False)
472
return ''.join(difflines)
474
def assertEqualDiff(self, a, b, message=None):
475
"""Assert two texts are equal, if not raise an exception.
477
This is intended for use with multi-line strings where it can
478
be hard to find the differences by eye.
480
# TODO: perhaps override assertEquals to call this for strings?
484
message = "texts not equal:\n"
485
raise AssertionError(message +
486
self._ndiff_strings(a, b))
488
def assertEqualMode(self, mode, mode_test):
489
self.assertEqual(mode, mode_test,
490
'mode mismatch %o != %o' % (mode, mode_test))
492
def assertStartsWith(self, s, prefix):
493
if not s.startswith(prefix):
494
raise AssertionError('string %r does not start with %r' % (s, prefix))
496
def assertEndsWith(self, s, suffix):
497
"""Asserts that s ends with suffix."""
498
if not s.endswith(suffix):
499
raise AssertionError('string %r does not end with %r' % (s, suffix))
501
def assertContainsRe(self, haystack, needle_re):
502
"""Assert that a contains something matching a regular expression."""
503
if not re.search(needle_re, haystack):
504
raise AssertionError('pattern "%s" not found in "%s"'
505
% (needle_re, haystack))
507
def assertNotContainsRe(self, haystack, needle_re):
508
"""Assert that a does not match a regular expression"""
509
if re.search(needle_re, haystack):
510
raise AssertionError('pattern "%s" found in "%s"'
511
% (needle_re, haystack))
513
def assertSubset(self, sublist, superlist):
514
"""Assert that every entry in sublist is present in superlist."""
516
for entry in sublist:
517
if entry not in superlist:
518
missing.append(entry)
520
raise AssertionError("value(s) %r not present in container %r" %
521
(missing, superlist))
523
def assertIs(self, left, right):
524
if not (left is right):
525
raise AssertionError("%r is not %r." % (left, right))
527
def assertTransportMode(self, transport, path, mode):
528
"""Fail if a path does not have mode mode.
530
If modes are not supported on this transport, the assertion is ignored.
532
if not transport._can_roundtrip_unix_modebits():
534
path_stat = transport.stat(path)
535
actual_mode = stat.S_IMODE(path_stat.st_mode)
536
self.assertEqual(mode, actual_mode,
537
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
539
def assertIsInstance(self, obj, kls):
540
"""Fail if obj is not an instance of kls"""
541
if not isinstance(obj, kls):
542
self.fail("%r is an instance of %s rather than %s" % (
543
obj, obj.__class__, kls))
545
def _startLogFile(self):
546
"""Send bzr and test log messages to a temporary file.
548
The file is removed as the test is torn down.
550
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
551
encoder, decoder, stream_reader, stream_writer = codecs.lookup('UTF-8')
552
self._log_file = stream_writer(os.fdopen(fileno, 'w+'))
553
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
554
self._log_file_name = name
555
self.addCleanup(self._finishLogFile)
557
def _finishLogFile(self):
558
"""Finished with the log file.
560
Read contents into memory, close, and delete.
562
if self._log_file is None:
564
bzrlib.trace.disable_test_log(self._log_nonce)
565
self._log_file.seek(0)
566
self._log_contents = self._log_file.read()
567
self._log_file.close()
568
os.remove(self._log_file_name)
569
self._log_file = self._log_file_name = None
571
def addCleanup(self, callable):
572
"""Arrange to run a callable when this case is torn down.
574
Callables are run in the reverse of the order they are registered,
575
ie last-in first-out.
577
if callable in self._cleanups:
578
raise ValueError("cleanup function %r already registered on %s"
580
self._cleanups.append(callable)
582
def _cleanEnvironment(self):
585
'APPDATA': os.getcwd(),
590
self.addCleanup(self._restoreEnvironment)
591
for name, value in new_env.iteritems():
592
self._captureVar(name, value)
595
def _captureVar(self, name, newvalue):
596
"""Set an environment variable, preparing it to be reset when finished."""
597
self.__old_env[name] = os.environ.get(name, None)
599
if name in os.environ:
602
os.environ[name] = newvalue
605
def _restoreVar(name, value):
607
if name in os.environ:
610
os.environ[name] = value
612
def _restoreEnvironment(self):
613
for name, value in self.__old_env.iteritems():
614
self._restoreVar(name, value)
618
unittest.TestCase.tearDown(self)
620
def time(self, callable, *args, **kwargs):
621
"""Run callable and accrue the time it takes to the benchmark time.
623
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
624
this will cause lsprofile statistics to be gathered and stored in
627
if self._benchtime is None:
631
if not self._gather_lsprof_in_benchmarks:
632
return callable(*args, **kwargs)
634
# record this benchmark
635
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
637
self._benchcalls.append(((callable, args, kwargs), stats))
640
self._benchtime += time.time() - start
642
def _runCleanups(self):
643
"""Run registered cleanup functions.
645
This should only be called from TestCase.tearDown.
647
# TODO: Perhaps this should keep running cleanups even if
649
for cleanup_fn in reversed(self._cleanups):
652
def log(self, *args):
656
"""Return as a string the log for this test"""
657
if self._log_file_name:
658
return open(self._log_file_name).read()
660
return self._log_contents
661
# TODO: Delete the log after it's been read in
663
def capture(self, cmd, retcode=0):
664
"""Shortcut that splits cmd into words, runs, and returns stdout"""
665
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
667
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None):
668
"""Invoke bzr and return (stdout, stderr).
670
Useful for code that wants to check the contents of the
671
output, the way error messages are presented, etc.
673
This should be the main method for tests that want to exercise the
674
overall behavior of the bzr application (rather than a unit test
675
or a functional test of the library.)
677
Much of the old code runs bzr by forking a new copy of Python, but
678
that is slower, harder to debug, and generally not necessary.
680
This runs bzr through the interface that catches and reports
681
errors, and with logging set to something approximating the
682
default, so that error reporting can be checked.
684
:param argv: arguments to invoke bzr
685
:param retcode: expected return code, or None for don't-care.
686
:param encoding: encoding for sys.stdout and sys.stderr
687
:param stdin: A string to be used as stdin for the command.
690
encoding = bzrlib.user_encoding
691
if stdin is not None:
692
stdin = StringIO(stdin)
693
stdout = StringIOWrapper()
694
stderr = StringIOWrapper()
695
stdout.encoding = encoding
696
stderr.encoding = encoding
698
self.log('run bzr: %r', argv)
699
# FIXME: don't call into logging here
700
handler = logging.StreamHandler(stderr)
701
handler.setLevel(logging.INFO)
702
logger = logging.getLogger('')
703
logger.addHandler(handler)
704
old_ui_factory = bzrlib.ui.ui_factory
705
bzrlib.ui.ui_factory = bzrlib.tests.blackbox.TestUIFactory(
708
bzrlib.ui.ui_factory.stdin = stdin
710
result = self.apply_redirected(stdin, stdout, stderr,
711
bzrlib.commands.run_bzr_catch_errors,
714
logger.removeHandler(handler)
715
bzrlib.ui.ui_factory = old_ui_factory
717
out = stdout.getvalue()
718
err = stderr.getvalue()
720
self.log('output:\n%r', out)
722
self.log('errors:\n%r', err)
723
if retcode is not None:
724
self.assertEquals(retcode, result)
727
def run_bzr(self, *args, **kwargs):
728
"""Invoke bzr, as if it were run from the command line.
730
This should be the main method for tests that want to exercise the
731
overall behavior of the bzr application (rather than a unit test
732
or a functional test of the library.)
734
This sends the stdout/stderr results into the test's log,
735
where it may be useful for debugging. See also run_captured.
737
:param stdin: A string to be used as stdin for the command.
739
retcode = kwargs.pop('retcode', 0)
740
encoding = kwargs.pop('encoding', None)
741
stdin = kwargs.pop('stdin', None)
742
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding, stdin=stdin)
744
def run_bzr_decode(self, *args, **kwargs):
745
if kwargs.has_key('encoding'):
746
encoding = kwargs['encoding']
748
encoding = bzrlib.user_encoding
749
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
751
def run_bzr_error(self, error_regexes, *args, **kwargs):
752
"""Run bzr, and check that stderr contains the supplied regexes
754
:param error_regexes: Sequence of regular expressions which
755
must each be found in the error output. The relative ordering
757
:param args: command-line arguments for bzr
758
:param kwargs: Keyword arguments which are interpreted by run_bzr
759
This function changes the default value of retcode to be 3,
760
since in most cases this is run when you expect bzr to fail.
761
:return: (out, err) The actual output of running the command (in case you
762
want to do more inspection)
765
# Make sure that commit is failing because there is nothing to do
766
self.run_bzr_error(['no changes to commit'],
767
'commit', '-m', 'my commit comment')
768
# Make sure --strict is handling an unknown file, rather than
769
# giving us the 'nothing to do' error
770
self.build_tree(['unknown'])
771
self.run_bzr_error(['Commit refused because there are unknown files'],
772
'commit', '--strict', '-m', 'my commit comment')
774
kwargs.setdefault('retcode', 3)
775
out, err = self.run_bzr(*args, **kwargs)
776
for regex in error_regexes:
777
self.assertContainsRe(err, regex)
780
def run_bzr_subprocess(self, *args, **kwargs):
781
"""Run bzr in a subprocess for testing.
783
This starts a new Python interpreter and runs bzr in there.
784
This should only be used for tests that have a justifiable need for
785
this isolation: e.g. they are testing startup time, or signal
786
handling, or early startup code, etc. Subprocess code can't be
787
profiled or debugged so easily.
789
:param retcode: The status code that is expected. Defaults to 0. If
790
None is supplied, the status code is not checked.
792
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
794
process = Popen([sys.executable, bzr_path]+args, stdout=PIPE,
796
out = process.stdout.read()
797
err = process.stderr.read()
798
retcode = process.wait()
799
supplied_retcode = kwargs.get('retcode', 0)
800
if supplied_retcode is not None:
801
assert supplied_retcode == retcode
804
def check_inventory_shape(self, inv, shape):
805
"""Compare an inventory to a list of expected names.
807
Fail if they are not precisely equal.
810
shape = list(shape) # copy
811
for path, ie in inv.entries():
812
name = path.replace('\\', '/')
820
self.fail("expected paths not found in inventory: %r" % shape)
822
self.fail("unexpected paths found in inventory: %r" % extras)
824
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
825
a_callable=None, *args, **kwargs):
826
"""Call callable with redirected std io pipes.
828
Returns the return code."""
829
if not callable(a_callable):
830
raise ValueError("a_callable must be callable.")
834
if getattr(self, "_log_file", None) is not None:
835
stdout = self._log_file
839
if getattr(self, "_log_file", None is not None):
840
stderr = self._log_file
843
real_stdin = sys.stdin
844
real_stdout = sys.stdout
845
real_stderr = sys.stderr
850
return a_callable(*args, **kwargs)
852
sys.stdout = real_stdout
853
sys.stderr = real_stderr
854
sys.stdin = real_stdin
856
def merge(self, branch_from, wt_to):
857
"""A helper for tests to do a ui-less merge.
859
This should move to the main library when someone has time to integrate
862
# minimal ui-less merge.
863
wt_to.branch.fetch(branch_from)
864
base_rev = common_ancestor(branch_from.last_revision(),
865
wt_to.branch.last_revision(),
866
wt_to.branch.repository)
867
merge_inner(wt_to.branch, branch_from.basis_tree(),
868
wt_to.branch.repository.revision_tree(base_rev),
870
wt_to.add_pending_merge(branch_from.last_revision())
873
BzrTestBase = TestCase
876
class TestCaseInTempDir(TestCase):
877
"""Derived class that runs a test within a temporary directory.
879
This is useful for tests that need to create a branch, etc.
881
The directory is created in a slightly complex way: for each
882
Python invocation, a new temporary top-level directory is created.
883
All test cases create their own directory within that. If the
884
tests complete successfully, the directory is removed.
886
InTempDir is an old alias for FunctionalTestCase.
891
OVERRIDE_PYTHON = 'python'
893
def check_file_contents(self, filename, expect):
894
self.log("check contents of file %s" % filename)
895
contents = file(filename, 'r').read()
896
if contents != expect:
897
self.log("expected: %r" % expect)
898
self.log("actually: %r" % contents)
899
self.fail("contents of %s not as expected" % filename)
901
def _make_test_root(self):
902
if TestCaseInTempDir.TEST_ROOT is not None:
906
root = u'test%04d.tmp' % i
910
if e.errno == errno.EEXIST:
915
# successfully created
916
TestCaseInTempDir.TEST_ROOT = osutils.abspath(root)
918
# make a fake bzr directory there to prevent any tests propagating
919
# up onto the source directory's real branch
920
bzrdir.BzrDir.create_standalone_workingtree(TestCaseInTempDir.TEST_ROOT)
923
super(TestCaseInTempDir, self).setUp()
924
self._make_test_root()
925
_currentdir = os.getcwdu()
926
# shorten the name, to avoid test failures due to path length
927
short_id = self.id().replace('bzrlib.tests.', '') \
928
.replace('__main__.', '')[-100:]
929
# it's possible the same test class is run several times for
930
# parameterized tests, so make sure the names don't collide.
934
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
936
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
937
if os.path.exists(candidate_dir):
941
self.test_dir = candidate_dir
942
os.mkdir(self.test_dir)
943
os.chdir(self.test_dir)
945
os.environ['HOME'] = self.test_dir
946
os.environ['APPDATA'] = self.test_dir
947
def _leaveDirectory():
948
os.chdir(_currentdir)
949
self.addCleanup(_leaveDirectory)
951
def build_tree(self, shape, line_endings='native', transport=None):
952
"""Build a test tree according to a pattern.
954
shape is a sequence of file specifications. If the final
955
character is '/', a directory is created.
957
This doesn't add anything to a branch.
958
:param line_endings: Either 'binary' or 'native'
959
in binary mode, exact contents are written
960
in native mode, the line endings match the
961
default platform endings.
963
:param transport: A transport to write to, for building trees on
964
VFS's. If the transport is readonly or None,
965
"." is opened automatically.
967
# XXX: It's OK to just create them using forward slashes on windows?
968
if transport is None or transport.is_readonly():
969
transport = get_transport(".")
971
self.assert_(isinstance(name, basestring))
973
transport.mkdir(urlutils.escape(name[:-1]))
975
if line_endings == 'binary':
977
elif line_endings == 'native':
980
raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
981
content = "contents of %s%s" % (name.encode('utf-8'), end)
982
transport.put(urlutils.escape(name), StringIO(content))
984
def build_tree_contents(self, shape):
985
build_tree_contents(shape)
987
def failUnlessExists(self, path):
988
"""Fail unless path, which may be abs or relative, exists."""
989
self.failUnless(osutils.lexists(path))
991
def failIfExists(self, path):
992
"""Fail if path, which may be abs or relative, exists."""
993
self.failIf(osutils.lexists(path))
995
def assertFileEqual(self, content, path):
996
"""Fail if path does not contain 'content'."""
997
self.failUnless(osutils.lexists(path))
998
# TODO: jam 20060427 Shouldn't this be 'rb'?
999
self.assertEqualDiff(content, open(path, 'r').read())
1002
class TestCaseWithTransport(TestCaseInTempDir):
1003
"""A test case that provides get_url and get_readonly_url facilities.
1005
These back onto two transport servers, one for readonly access and one for
1008
If no explicit class is provided for readonly access, a
1009
ReadonlyTransportDecorator is used instead which allows the use of non disk
1010
based read write transports.
1012
If an explicit class is provided for readonly access, that server and the
1013
readwrite one must both define get_url() as resolving to os.getcwd().
1016
def __init__(self, methodName='testMethod'):
1017
super(TestCaseWithTransport, self).__init__(methodName)
1018
self.__readonly_server = None
1019
self.__server = None
1020
self.transport_server = default_transport
1021
self.transport_readonly_server = None
1023
def get_readonly_url(self, relpath=None):
1024
"""Get a URL for the readonly transport.
1026
This will either be backed by '.' or a decorator to the transport
1027
used by self.get_url()
1028
relpath provides for clients to get a path relative to the base url.
1029
These should only be downwards relative, not upwards.
1031
base = self.get_readonly_server().get_url()
1032
if relpath is not None:
1033
if not base.endswith('/'):
1035
base = base + relpath
1038
def get_readonly_server(self):
1039
"""Get the server instance for the readonly transport
1041
This is useful for some tests with specific servers to do diagnostics.
1043
if self.__readonly_server is None:
1044
if self.transport_readonly_server is None:
1045
# readonly decorator requested
1046
# bring up the server
1048
self.__readonly_server = ReadonlyServer()
1049
self.__readonly_server.setUp(self.__server)
1051
self.__readonly_server = self.transport_readonly_server()
1052
self.__readonly_server.setUp()
1053
self.addCleanup(self.__readonly_server.tearDown)
1054
return self.__readonly_server
1056
def get_server(self):
1057
"""Get the read/write server instance.
1059
This is useful for some tests with specific servers that need
1062
if self.__server is None:
1063
self.__server = self.transport_server()
1064
self.__server.setUp()
1065
self.addCleanup(self.__server.tearDown)
1066
return self.__server
1068
def get_url(self, relpath=None):
1069
"""Get a URL for the readwrite transport.
1071
This will either be backed by '.' or to an equivalent non-file based
1073
relpath provides for clients to get a path relative to the base url.
1074
These should only be downwards relative, not upwards.
1076
base = self.get_server().get_url()
1077
if relpath is not None and relpath != '.':
1078
if not base.endswith('/'):
1080
base = base + urlutils.escape(relpath)
1083
def get_transport(self):
1084
"""Return a writeable transport for the test scratch space"""
1085
t = get_transport(self.get_url())
1086
self.assertFalse(t.is_readonly())
1089
def get_readonly_transport(self):
1090
"""Return a readonly transport for the test scratch space
1092
This can be used to test that operations which should only need
1093
readonly access in fact do not try to write.
1095
t = get_transport(self.get_readonly_url())
1096
self.assertTrue(t.is_readonly())
1099
def make_branch(self, relpath, format=None):
1100
"""Create a branch on the transport at relpath."""
1101
repo = self.make_repository(relpath, format=format)
1102
return repo.bzrdir.create_branch()
1104
def make_bzrdir(self, relpath, format=None):
1106
url = self.get_url(relpath)
1107
mutter('relpath %r => url %r', relpath, url)
1108
segments = url.split('/')
1109
if segments and segments[-1] not in ('', '.'):
1110
parent = '/'.join(segments[:-1])
1111
t = get_transport(parent)
1113
t.mkdir(segments[-1])
1114
except errors.FileExists:
1117
format=bzrlib.bzrdir.BzrDirFormat.get_default_format()
1118
# FIXME: make this use a single transport someday. RBC 20060418
1119
return format.initialize_on_transport(get_transport(relpath))
1120
except errors.UninitializableFormat:
1121
raise TestSkipped("Format %s is not initializable." % format)
1123
def make_repository(self, relpath, shared=False, format=None):
1124
"""Create a repository on our default transport at relpath."""
1125
made_control = self.make_bzrdir(relpath, format=format)
1126
return made_control.create_repository(shared=shared)
1128
def make_branch_and_tree(self, relpath, format=None):
1129
"""Create a branch on the transport and a tree locally.
1133
# TODO: always use the local disk path for the working tree,
1134
# this obviously requires a format that supports branch references
1135
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1137
b = self.make_branch(relpath, format=format)
1139
return b.bzrdir.create_workingtree()
1140
except errors.NotLocalUrl:
1141
# new formats - catch No tree error and create
1142
# a branch reference and a checkout.
1143
# old formats at that point - raise TestSkipped.
1144
# TODO: rbc 20060208
1145
return WorkingTreeFormat2().initialize(bzrdir.BzrDir.open(relpath))
1147
def assertIsDirectory(self, relpath, transport):
1148
"""Assert that relpath within transport is a directory.
1150
This may not be possible on all transports; in that case it propagates
1151
a TransportNotPossible.
1154
mode = transport.stat(relpath).st_mode
1155
except errors.NoSuchFile:
1156
self.fail("path %s is not a directory; no such file"
1158
if not stat.S_ISDIR(mode):
1159
self.fail("path %s is not a directory; has mode %#o"
1163
class ChrootedTestCase(TestCaseWithTransport):
1164
"""A support class that provides readonly urls outside the local namespace.
1166
This is done by checking if self.transport_server is a MemoryServer. if it
1167
is then we are chrooted already, if it is not then an HttpServer is used
1170
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1171
be used without needed to redo it when a different
1172
subclass is in use ?
1176
super(ChrootedTestCase, self).setUp()
1177
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
1178
self.transport_readonly_server = bzrlib.transport.http.HttpServer
1181
def filter_suite_by_re(suite, pattern):
1182
result = TestUtil.TestSuite()
1183
filter_re = re.compile(pattern)
1184
for test in iter_suite_tests(suite):
1185
if filter_re.search(test.id()):
1186
result.addTest(test)
1190
def run_suite(suite, name='test', verbose=False, pattern=".*",
1191
stop_on_failure=False, keep_output=False,
1192
transport=None, lsprof_timed=None):
1193
TestCaseInTempDir._TEST_NAME = name
1194
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1200
pb = progress.ProgressBar()
1201
runner = TextTestRunner(stream=sys.stdout,
1203
verbosity=verbosity,
1204
keep_output=keep_output,
1206
runner.stop_on_failure=stop_on_failure
1208
suite = filter_suite_by_re(suite, pattern)
1209
result = runner.run(suite)
1210
return result.wasSuccessful()
1213
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1216
test_suite_factory=None,
1218
"""Run the whole test suite under the enhanced runner"""
1219
global default_transport
1220
if transport is None:
1221
transport = default_transport
1222
old_transport = default_transport
1223
default_transport = transport
1225
if test_suite_factory is None:
1226
suite = test_suite()
1228
suite = test_suite_factory()
1229
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1230
stop_on_failure=stop_on_failure, keep_output=keep_output,
1231
transport=transport,
1232
lsprof_timed=lsprof_timed)
1234
default_transport = old_transport
1238
"""Build and return TestSuite for the whole of bzrlib.
1240
This function can be replaced if you need to change the default test
1241
suite on a global basis, but it is not encouraged.
1244
'bzrlib.tests.test_ancestry',
1245
'bzrlib.tests.test_api',
1246
'bzrlib.tests.test_bad_files',
1247
'bzrlib.tests.test_branch',
1248
'bzrlib.tests.test_bundle',
1249
'bzrlib.tests.test_bzrdir',
1250
'bzrlib.tests.test_command',
1251
'bzrlib.tests.test_commit',
1252
'bzrlib.tests.test_commit_merge',
1253
'bzrlib.tests.test_config',
1254
'bzrlib.tests.test_conflicts',
1255
'bzrlib.tests.test_decorators',
1256
'bzrlib.tests.test_diff',
1257
'bzrlib.tests.test_doc_generate',
1258
'bzrlib.tests.test_emptytree',
1259
'bzrlib.tests.test_errors',
1260
'bzrlib.tests.test_escaped_store',
1261
'bzrlib.tests.test_fetch',
1262
'bzrlib.tests.test_gpg',
1263
'bzrlib.tests.test_graph',
1264
'bzrlib.tests.test_hashcache',
1265
'bzrlib.tests.test_http',
1266
'bzrlib.tests.test_identitymap',
1267
'bzrlib.tests.test_inv',
1268
'bzrlib.tests.test_knit',
1269
'bzrlib.tests.test_lockdir',
1270
'bzrlib.tests.test_lockable_files',
1271
'bzrlib.tests.test_log',
1272
'bzrlib.tests.test_merge',
1273
'bzrlib.tests.test_merge3',
1274
'bzrlib.tests.test_merge_core',
1275
'bzrlib.tests.test_missing',
1276
'bzrlib.tests.test_msgeditor',
1277
'bzrlib.tests.test_nonascii',
1278
'bzrlib.tests.test_options',
1279
'bzrlib.tests.test_osutils',
1280
'bzrlib.tests.test_patch',
1281
'bzrlib.tests.test_patches',
1282
'bzrlib.tests.test_permissions',
1283
'bzrlib.tests.test_plugins',
1284
'bzrlib.tests.test_progress',
1285
'bzrlib.tests.test_reconcile',
1286
'bzrlib.tests.test_repository',
1287
'bzrlib.tests.test_revision',
1288
'bzrlib.tests.test_revisionnamespaces',
1289
'bzrlib.tests.test_revprops',
1290
'bzrlib.tests.test_revisiontree',
1291
'bzrlib.tests.test_rio',
1292
'bzrlib.tests.test_sampler',
1293
'bzrlib.tests.test_selftest',
1294
'bzrlib.tests.test_setup',
1295
'bzrlib.tests.test_sftp_transport',
1296
'bzrlib.tests.test_smart_add',
1297
'bzrlib.tests.test_source',
1298
'bzrlib.tests.test_status',
1299
'bzrlib.tests.test_store',
1300
'bzrlib.tests.test_symbol_versioning',
1301
'bzrlib.tests.test_testament',
1302
'bzrlib.tests.test_textfile',
1303
'bzrlib.tests.test_textmerge',
1304
'bzrlib.tests.test_trace',
1305
'bzrlib.tests.test_transactions',
1306
'bzrlib.tests.test_transform',
1307
'bzrlib.tests.test_transport',
1308
'bzrlib.tests.test_tsort',
1309
'bzrlib.tests.test_tuned_gzip',
1310
'bzrlib.tests.test_ui',
1311
'bzrlib.tests.test_upgrade',
1312
'bzrlib.tests.test_urlutils',
1313
'bzrlib.tests.test_versionedfile',
1314
'bzrlib.tests.test_weave',
1315
'bzrlib.tests.test_whitebox',
1316
'bzrlib.tests.test_workingtree',
1317
'bzrlib.tests.test_xml',
1319
test_transport_implementations = [
1320
'bzrlib.tests.test_transport_implementations',
1321
'bzrlib.tests.test_read_bundle',
1323
suite = TestUtil.TestSuite()
1324
loader = TestUtil.TestLoader()
1325
from bzrlib.transport import TransportTestProviderAdapter
1326
adapter = TransportTestProviderAdapter()
1327
adapt_modules(test_transport_implementations, adapter, loader, suite)
1328
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1329
for package in packages_to_test():
1330
suite.addTest(package.test_suite())
1331
for m in MODULES_TO_TEST:
1332
suite.addTest(loader.loadTestsFromModule(m))
1333
for m in MODULES_TO_DOCTEST:
1334
suite.addTest(doctest.DocTestSuite(m))
1335
for name, plugin in bzrlib.plugin.all_plugins().items():
1336
if getattr(plugin, 'test_suite', None) is not None:
1337
suite.addTest(plugin.test_suite())
1341
def adapt_modules(mods_list, adapter, loader, suite):
1342
"""Adapt the modules in mods_list using adapter and add to suite."""
1343
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1344
suite.addTests(adapter.adapt(test))
added
removed
bzrlib/tests/__init__.py
