1
# Copyright (C) 2005, 2006, 2007 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
36
from pprint import pformat
40
from subprocess import Popen, PIPE
58
import bzrlib.commands
59
import bzrlib.timestamp
61
import bzrlib.inventory
62
import bzrlib.iterablefile
67
# lsprof not available
69
from bzrlib.merge import merge_inner
73
from bzrlib.revision import common_ancestor
75
from bzrlib import symbol_versioning
77
from bzrlib.transport import get_transport
78
import bzrlib.transport
79
from bzrlib.transport.local import LocalURLServer
80
from bzrlib.transport.memory import MemoryServer
81
from bzrlib.transport.readonly import ReadonlyServer
82
from bzrlib.trace import mutter, note
83
from bzrlib.tests import TestUtil
84
from bzrlib.tests.HttpServer import HttpServer
85
from bzrlib.tests.TestUtil import (
89
from bzrlib.tests.treeshape import build_tree_contents
90
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
92
default_transport = LocalURLServer
95
MODULES_TO_DOCTEST = [
107
NUMBERED_DIRS = False # dirs kind for TestCaseInTempDir (numbered or named)
110
def packages_to_test():
111
"""Return a list of packages to test.
113
The packages are not globally imported so that import failures are
114
triggered when running selftest, not when importing the command.
117
import bzrlib.tests.blackbox
118
import bzrlib.tests.branch_implementations
119
import bzrlib.tests.bzrdir_implementations
120
import bzrlib.tests.interrepository_implementations
121
import bzrlib.tests.interversionedfile_implementations
122
import bzrlib.tests.intertree_implementations
123
import bzrlib.tests.per_lock
124
import bzrlib.tests.repository_implementations
125
import bzrlib.tests.revisionstore_implementations
126
import bzrlib.tests.tree_implementations
127
import bzrlib.tests.workingtree_implementations
130
bzrlib.tests.blackbox,
131
bzrlib.tests.branch_implementations,
132
bzrlib.tests.bzrdir_implementations,
133
bzrlib.tests.interrepository_implementations,
134
bzrlib.tests.interversionedfile_implementations,
135
bzrlib.tests.intertree_implementations,
136
bzrlib.tests.per_lock,
137
bzrlib.tests.repository_implementations,
138
bzrlib.tests.revisionstore_implementations,
139
bzrlib.tests.tree_implementations,
140
bzrlib.tests.workingtree_implementations,
144
class ExtendedTestResult(unittest._TextTestResult):
145
"""Accepts, reports and accumulates the results of running tests.
147
Compared to this unittest version this class adds support for profiling,
148
benchmarking, stopping as soon as a test fails, and skipping tests.
149
There are further-specialized subclasses for different types of display.
154
def __init__(self, stream, descriptions, verbosity,
158
"""Construct new TestResult.
160
:param bench_history: Optionally, a writable file object to accumulate
163
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
164
if bench_history is not None:
165
from bzrlib.version import _get_bzr_source_tree
166
src_tree = _get_bzr_source_tree()
169
revision_id = src_tree.get_parent_ids()[0]
171
# XXX: if this is a brand new tree, do the same as if there
175
# XXX: If there's no branch, what should we do?
177
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
178
self._bench_history = bench_history
179
self.ui = ui.ui_factory
180
self.num_tests = num_tests
182
self.failure_count = 0
185
self._overall_start_time = time.time()
187
def extractBenchmarkTime(self, testCase):
188
"""Add a benchmark time for the current test case."""
189
self._benchmarkTime = getattr(testCase, "_benchtime", None)
191
def _elapsedTestTimeString(self):
192
"""Return a time string for the overall time the current test has taken."""
193
return self._formatTime(time.time() - self._start_time)
195
def _testTimeString(self):
196
if self._benchmarkTime is not None:
198
self._formatTime(self._benchmarkTime),
199
self._elapsedTestTimeString())
201
return " %s" % self._elapsedTestTimeString()
203
def _formatTime(self, seconds):
204
"""Format seconds as milliseconds with leading spaces."""
205
# some benchmarks can take thousands of seconds to run, so we need 8
207
return "%8dms" % (1000 * seconds)
209
def _shortened_test_description(self, test):
211
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
214
def startTest(self, test):
215
unittest.TestResult.startTest(self, test)
216
self.report_test_start(test)
217
test.number = self.count
218
self._recordTestStartTime()
220
def _recordTestStartTime(self):
221
"""Record that a test has started."""
222
self._start_time = time.time()
224
def addError(self, test, err):
225
if isinstance(err[1], TestSkipped):
226
return self.addSkipped(test, err)
227
unittest.TestResult.addError(self, test, err)
228
# We can only do this if we have one of our TestCases, not if
230
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
231
if setKeepLogfile is not None:
233
self.extractBenchmarkTime(test)
234
self.report_error(test, err)
238
def addFailure(self, test, err):
239
unittest.TestResult.addFailure(self, test, err)
240
# We can only do this if we have one of our TestCases, not if
242
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
243
if setKeepLogfile is not None:
245
self.extractBenchmarkTime(test)
246
self.report_failure(test, err)
250
def addSuccess(self, test):
251
self.extractBenchmarkTime(test)
252
if self._bench_history is not None:
253
if self._benchmarkTime is not None:
254
self._bench_history.write("%s %s\n" % (
255
self._formatTime(self._benchmarkTime),
257
self.report_success(test)
258
unittest.TestResult.addSuccess(self, test)
260
def addSkipped(self, test, skip_excinfo):
261
self.extractBenchmarkTime(test)
262
self.report_skip(test, skip_excinfo)
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.write("%s: " % flavour)
279
self.stream.write('#%d ' % test.number)
280
self.stream.writeln(self.getDescription(test))
281
if getattr(test, '_get_log', None) is not None:
283
print >>self.stream, \
284
('vvvv[log from %s]' % test.id()).ljust(78,'-')
285
print >>self.stream, test._get_log()
286
print >>self.stream, \
287
('^^^^[log from %s]' % test.id()).ljust(78,'-')
288
self.stream.writeln(self.separator2)
289
self.stream.writeln("%s" % err)
294
def report_cleaning_up(self):
297
def report_success(self, test):
301
class TextTestResult(ExtendedTestResult):
302
"""Displays progress and results of tests in text form"""
304
def __init__(self, *args, **kw):
305
ExtendedTestResult.__init__(self, *args, **kw)
306
self.pb = self.ui.nested_progress_bar()
307
self.pb.show_pct = False
308
self.pb.show_spinner = False
309
self.pb.show_eta = False,
310
self.pb.show_count = False
311
self.pb.show_bar = False
313
def report_starting(self):
314
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
316
def _progress_prefix_text(self):
317
a = '[%d' % self.count
318
if self.num_tests is not None:
319
a +='/%d' % self.num_tests
320
a += ' in %ds' % (time.time() - self._overall_start_time)
322
a += ', %d errors' % self.error_count
323
if self.failure_count:
324
a += ', %d failed' % self.failure_count
326
a += ', %d skipped' % self.skip_count
330
def report_test_start(self, test):
333
self._progress_prefix_text()
335
+ self._shortened_test_description(test))
337
def _test_description(self, test):
339
return '#%d %s' % (self.count,
340
self._shortened_test_description(test))
342
return self._shortened_test_description(test)
344
def report_error(self, test, err):
345
self.error_count += 1
346
self.pb.note('ERROR: %s\n %s\n',
347
self._test_description(test),
351
def report_failure(self, test, err):
352
self.failure_count += 1
353
self.pb.note('FAIL: %s\n %s\n',
354
self._test_description(test),
358
def report_skip(self, test, skip_excinfo):
361
# at the moment these are mostly not things we can fix
362
# and so they just produce stipple; use the verbose reporter
365
# show test and reason for skip
366
self.pb.note('SKIP: %s\n %s\n',
367
self._shortened_test_description(test),
370
# since the class name was left behind in the still-visible
372
self.pb.note('SKIP: %s', skip_excinfo[1])
374
def report_cleaning_up(self):
375
self.pb.update('cleaning up...')
381
class VerboseTestResult(ExtendedTestResult):
382
"""Produce long output, with one line per test run plus times"""
384
def _ellipsize_to_right(self, a_string, final_width):
385
"""Truncate and pad a string, keeping the right hand side"""
386
if len(a_string) > final_width:
387
result = '...' + a_string[3-final_width:]
390
return result.ljust(final_width)
392
def report_starting(self):
393
self.stream.write('running %d tests...\n' % self.num_tests)
395
def report_test_start(self, test):
397
name = self._shortened_test_description(test)
398
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
399
# numbers, plus a trailing blank
400
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
402
self.stream.write('%5d ' % self.count)
403
self.stream.write(self._ellipsize_to_right(name,
404
osutils.terminal_width()-36))
406
self.stream.write(self._ellipsize_to_right(name,
407
osutils.terminal_width()-30))
410
def _error_summary(self, err):
414
return '%s%s' % (indent, err[1])
416
def report_error(self, test, err):
417
self.error_count += 1
418
self.stream.writeln('ERROR %s\n%s'
419
% (self._testTimeString(),
420
self._error_summary(err)))
422
def report_failure(self, test, err):
423
self.failure_count += 1
424
self.stream.writeln(' FAIL %s\n%s'
425
% (self._testTimeString(),
426
self._error_summary(err)))
428
def report_success(self, test):
429
self.stream.writeln(' OK %s' % self._testTimeString())
430
for bench_called, stats in getattr(test, '_benchcalls', []):
431
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
432
stats.pprint(file=self.stream)
435
def report_skip(self, test, skip_excinfo):
437
self.stream.writeln(' SKIP %s\n%s'
438
% (self._testTimeString(),
439
self._error_summary(skip_excinfo)))
442
class TextTestRunner(object):
443
stop_on_failure = False
451
self.stream = unittest._WritelnDecorator(stream)
452
self.descriptions = descriptions
453
self.verbosity = verbosity
454
self.keep_output = keep_output
455
self._bench_history = bench_history
458
"Run the given test case or test suite."
459
startTime = time.time()
460
if self.verbosity == 1:
461
result_class = TextTestResult
462
elif self.verbosity >= 2:
463
result_class = VerboseTestResult
464
result = result_class(self.stream,
467
bench_history=self._bench_history,
468
num_tests=test.countTestCases(),
470
result.stop_early = self.stop_on_failure
471
result.report_starting()
473
stopTime = time.time()
474
timeTaken = stopTime - startTime
476
self.stream.writeln(result.separator2)
477
run = result.testsRun
478
self.stream.writeln("Ran %d test%s in %.3fs" %
479
(run, run != 1 and "s" or "", timeTaken))
480
self.stream.writeln()
481
if not result.wasSuccessful():
482
self.stream.write("FAILED (")
483
failed, errored = map(len, (result.failures, result.errors))
485
self.stream.write("failures=%d" % failed)
487
if failed: self.stream.write(", ")
488
self.stream.write("errors=%d" % errored)
489
self.stream.writeln(")")
491
self.stream.writeln("OK")
492
if result.skip_count > 0:
493
skipped = result.skip_count
494
self.stream.writeln('%d test%s skipped' %
495
(skipped, skipped != 1 and "s" or ""))
496
result.report_cleaning_up()
497
# This is still a little bogus,
498
# but only a little. Folk not using our testrunner will
499
# have to delete their temp directories themselves.
500
test_root = TestCaseWithMemoryTransport.TEST_ROOT
501
if result.wasSuccessful() or not self.keep_output:
502
if test_root is not None:
503
# If LANG=C we probably have created some bogus paths
504
# which rmtree(unicode) will fail to delete
505
# so make sure we are using rmtree(str) to delete everything
506
# except on win32, where rmtree(str) will fail
507
# since it doesn't have the property of byte-stream paths
508
# (they are either ascii or mbcs)
509
if sys.platform == 'win32':
510
# make sure we are using the unicode win32 api
511
test_root = unicode(test_root)
513
test_root = test_root.encode(
514
sys.getfilesystemencoding())
516
osutils.rmtree(test_root)
518
if sys.platform == 'win32' and e.errno == errno.EACCES:
519
print >>sys.stderr, ('Permission denied: '
520
'unable to remove testing dir '
521
'%s' % os.path.basename(test_root))
525
note("Failed tests working directories are in '%s'\n", test_root)
526
TestCaseWithMemoryTransport.TEST_ROOT = None
531
def iter_suite_tests(suite):
532
"""Return all tests in a suite, recursing through nested suites"""
533
for item in suite._tests:
534
if isinstance(item, unittest.TestCase):
536
elif isinstance(item, unittest.TestSuite):
537
for r in iter_suite_tests(item):
540
raise Exception('unknown object %r inside test suite %r'
544
class TestSkipped(Exception):
545
"""Indicates that a test was intentionally skipped, rather than failing."""
548
class CommandFailed(Exception):
552
class StringIOWrapper(object):
553
"""A wrapper around cStringIO which just adds an encoding attribute.
555
Internally we can check sys.stdout to see what the output encoding
556
should be. However, cStringIO has no encoding attribute that we can
557
set. So we wrap it instead.
562
def __init__(self, s=None):
564
self.__dict__['_cstring'] = StringIO(s)
566
self.__dict__['_cstring'] = StringIO()
568
def __getattr__(self, name, getattr=getattr):
569
return getattr(self.__dict__['_cstring'], name)
571
def __setattr__(self, name, val):
572
if name == 'encoding':
573
self.__dict__['encoding'] = val
575
return setattr(self._cstring, name, val)
578
class TestUIFactory(ui.CLIUIFactory):
579
"""A UI Factory for testing.
581
Hide the progress bar but emit note()s.
583
Allows get_password to be tested without real tty attached.
590
super(TestUIFactory, self).__init__()
591
if stdin is not None:
592
# We use a StringIOWrapper to be able to test various
593
# encodings, but the user is still responsible to
594
# encode the string and to set the encoding attribute
595
# of StringIOWrapper.
596
self.stdin = StringIOWrapper(stdin)
598
self.stdout = sys.stdout
602
self.stderr = sys.stderr
607
"""See progress.ProgressBar.clear()."""
609
def clear_term(self):
610
"""See progress.ProgressBar.clear_term()."""
612
def clear_term(self):
613
"""See progress.ProgressBar.clear_term()."""
616
"""See progress.ProgressBar.finished()."""
618
def note(self, fmt_string, *args, **kwargs):
619
"""See progress.ProgressBar.note()."""
620
self.stdout.write((fmt_string + "\n") % args)
622
def progress_bar(self):
625
def nested_progress_bar(self):
628
def update(self, message, count=None, total=None):
629
"""See progress.ProgressBar.update()."""
631
def get_non_echoed_password(self, prompt):
632
"""Get password from stdin without trying to handle the echo mode"""
634
self.stdout.write(prompt)
635
password = self.stdin.readline()
638
if password[-1] == '\n':
639
password = password[:-1]
643
class TestCase(unittest.TestCase):
644
"""Base class for bzr unit tests.
646
Tests that need access to disk resources should subclass
647
TestCaseInTempDir not TestCase.
649
Error and debug log messages are redirected from their usual
650
location into a temporary file, the contents of which can be
651
retrieved by _get_log(). We use a real OS file, not an in-memory object,
652
so that it can also capture file IO. When the test completes this file
653
is read into memory and removed from disk.
655
There are also convenience functions to invoke bzr's command-line
656
routine, and to build and check bzr trees.
658
In addition to the usual method of overriding tearDown(), this class also
659
allows subclasses to register functions into the _cleanups list, which is
660
run in order as the object is torn down. It's less likely this will be
661
accidentally overlooked.
664
_log_file_name = None
666
_keep_log_file = False
667
# record lsprof data when performing benchmark calls.
668
_gather_lsprof_in_benchmarks = False
670
def __init__(self, methodName='testMethod'):
671
super(TestCase, self).__init__(methodName)
675
unittest.TestCase.setUp(self)
676
self._cleanEnvironment()
677
bzrlib.trace.disable_default_logging()
680
self._benchcalls = []
681
self._benchtime = None
682
# prevent hooks affecting tests
683
self._preserved_hooks = bzrlib.branch.Branch.hooks
684
self.addCleanup(self._restoreHooks)
685
# this list of hooks must be kept in sync with the defaults
687
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
689
def _silenceUI(self):
690
"""Turn off UI for duration of test"""
691
# by default the UI is off; tests can turn it on if they want it.
692
saved = ui.ui_factory
694
ui.ui_factory = saved
695
ui.ui_factory = ui.SilentUIFactory()
696
self.addCleanup(_restore)
698
def _ndiff_strings(self, a, b):
699
"""Return ndiff between two strings containing lines.
701
A trailing newline is added if missing to make the strings
703
if b and b[-1] != '\n':
705
if a and a[-1] != '\n':
707
difflines = difflib.ndiff(a.splitlines(True),
709
linejunk=lambda x: False,
710
charjunk=lambda x: False)
711
return ''.join(difflines)
713
def assertEqual(self, a, b, message=''):
717
except UnicodeError, e:
718
# If we can't compare without getting a UnicodeError, then
719
# obviously they are different
720
mutter('UnicodeError: %s', e)
723
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
725
pformat(a, indent=4), pformat(b, indent=4)))
727
assertEquals = assertEqual
729
def assertEqualDiff(self, a, b, message=None):
730
"""Assert two texts are equal, if not raise an exception.
732
This is intended for use with multi-line strings where it can
733
be hard to find the differences by eye.
735
# TODO: perhaps override assertEquals to call this for strings?
739
message = "texts not equal:\n"
740
raise AssertionError(message +
741
self._ndiff_strings(a, b))
743
def assertEqualMode(self, mode, mode_test):
744
self.assertEqual(mode, mode_test,
745
'mode mismatch %o != %o' % (mode, mode_test))
747
def assertStartsWith(self, s, prefix):
748
if not s.startswith(prefix):
749
raise AssertionError('string %r does not start with %r' % (s, prefix))
751
def assertEndsWith(self, s, suffix):
752
"""Asserts that s ends with suffix."""
753
if not s.endswith(suffix):
754
raise AssertionError('string %r does not end with %r' % (s, suffix))
756
def assertContainsRe(self, haystack, needle_re):
757
"""Assert that a contains something matching a regular expression."""
758
if not re.search(needle_re, haystack):
759
raise AssertionError('pattern "%r" not found in "%r"'
760
% (needle_re, haystack))
762
def assertNotContainsRe(self, haystack, needle_re):
763
"""Assert that a does not match a regular expression"""
764
if re.search(needle_re, haystack):
765
raise AssertionError('pattern "%s" found in "%s"'
766
% (needle_re, haystack))
768
def assertSubset(self, sublist, superlist):
769
"""Assert that every entry in sublist is present in superlist."""
771
for entry in sublist:
772
if entry not in superlist:
773
missing.append(entry)
775
raise AssertionError("value(s) %r not present in container %r" %
776
(missing, superlist))
778
def assertListRaises(self, excClass, func, *args, **kwargs):
779
"""Fail unless excClass is raised when the iterator from func is used.
781
Many functions can return generators this makes sure
782
to wrap them in a list() call to make sure the whole generator
783
is run, and that the proper exception is raised.
786
list(func(*args, **kwargs))
790
if getattr(excClass,'__name__', None) is not None:
791
excName = excClass.__name__
793
excName = str(excClass)
794
raise self.failureException, "%s not raised" % excName
796
def assertIs(self, left, right, message=None):
797
if not (left is right):
798
if message is not None:
799
raise AssertionError(message)
801
raise AssertionError("%r is not %r." % (left, right))
803
def assertIsNot(self, left, right, message=None):
805
if message is not None:
806
raise AssertionError(message)
808
raise AssertionError("%r is %r." % (left, right))
810
def assertTransportMode(self, transport, path, mode):
811
"""Fail if a path does not have mode mode.
813
If modes are not supported on this transport, the assertion is ignored.
815
if not transport._can_roundtrip_unix_modebits():
817
path_stat = transport.stat(path)
818
actual_mode = stat.S_IMODE(path_stat.st_mode)
819
self.assertEqual(mode, actual_mode,
820
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
822
def assertIsInstance(self, obj, kls):
823
"""Fail if obj is not an instance of kls"""
824
if not isinstance(obj, kls):
825
self.fail("%r is an instance of %s rather than %s" % (
826
obj, obj.__class__, kls))
828
def _capture_warnings(self, a_callable, *args, **kwargs):
829
"""A helper for callDeprecated and applyDeprecated.
831
:param a_callable: A callable to call.
832
:param args: The positional arguments for the callable
833
:param kwargs: The keyword arguments for the callable
834
:return: A tuple (warnings, result). result is the result of calling
835
a_callable(*args, **kwargs).
838
def capture_warnings(msg, cls=None, stacklevel=None):
839
# we've hooked into a deprecation specific callpath,
840
# only deprecations should getting sent via it.
841
self.assertEqual(cls, DeprecationWarning)
842
local_warnings.append(msg)
843
original_warning_method = symbol_versioning.warn
844
symbol_versioning.set_warning_method(capture_warnings)
846
result = a_callable(*args, **kwargs)
848
symbol_versioning.set_warning_method(original_warning_method)
849
return (local_warnings, result)
851
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
852
"""Call a deprecated callable without warning the user.
854
:param deprecation_format: The deprecation format that the callable
855
should have been deprecated with. This is the same type as the
856
parameter to deprecated_method/deprecated_function. If the
857
callable is not deprecated with this format, an assertion error
859
:param a_callable: A callable to call. This may be a bound method or
860
a regular function. It will be called with *args and **kwargs.
861
:param args: The positional arguments for the callable
862
:param kwargs: The keyword arguments for the callable
863
:return: The result of a_callable(*args, **kwargs)
865
call_warnings, result = self._capture_warnings(a_callable,
867
expected_first_warning = symbol_versioning.deprecation_string(
868
a_callable, deprecation_format)
869
if len(call_warnings) == 0:
870
self.fail("No deprecation warning generated by call to %s" %
872
self.assertEqual(expected_first_warning, call_warnings[0])
875
def callDeprecated(self, expected, callable, *args, **kwargs):
876
"""Assert that a callable is deprecated in a particular way.
878
This is a very precise test for unusual requirements. The
879
applyDeprecated helper function is probably more suited for most tests
880
as it allows you to simply specify the deprecation format being used
881
and will ensure that that is issued for the function being called.
883
:param expected: a list of the deprecation warnings expected, in order
884
:param callable: The callable to call
885
:param args: The positional arguments for the callable
886
:param kwargs: The keyword arguments for the callable
888
call_warnings, result = self._capture_warnings(callable,
890
self.assertEqual(expected, call_warnings)
893
def _startLogFile(self):
894
"""Send bzr and test log messages to a temporary file.
896
The file is removed as the test is torn down.
898
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
899
self._log_file = os.fdopen(fileno, 'w+')
900
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
901
self._log_file_name = name
902
self.addCleanup(self._finishLogFile)
904
def _finishLogFile(self):
905
"""Finished with the log file.
907
Close the file and delete it, unless setKeepLogfile was called.
909
if self._log_file is None:
911
bzrlib.trace.disable_test_log(self._log_nonce)
912
self._log_file.close()
913
self._log_file = None
914
if not self._keep_log_file:
915
os.remove(self._log_file_name)
916
self._log_file_name = None
918
def setKeepLogfile(self):
919
"""Make the logfile not be deleted when _finishLogFile is called."""
920
self._keep_log_file = True
922
def addCleanup(self, callable):
923
"""Arrange to run a callable when this case is torn down.
925
Callables are run in the reverse of the order they are registered,
926
ie last-in first-out.
928
if callable in self._cleanups:
929
raise ValueError("cleanup function %r already registered on %s"
931
self._cleanups.append(callable)
933
def _cleanEnvironment(self):
935
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
937
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
939
'BZREMAIL': None, # may still be present in the environment
941
'BZR_PROGRESS_BAR': None,
951
# Nobody cares about these ones AFAIK. So far at
952
# least. If you do (care), please update this comment
958
self.addCleanup(self._restoreEnvironment)
959
for name, value in new_env.iteritems():
960
self._captureVar(name, value)
962
def _captureVar(self, name, newvalue):
963
"""Set an environment variable, and reset it when finished."""
964
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
966
def _restoreEnvironment(self):
967
for name, value in self.__old_env.iteritems():
968
osutils.set_or_unset_env(name, value)
970
def _restoreHooks(self):
971
bzrlib.branch.Branch.hooks = self._preserved_hooks
975
unittest.TestCase.tearDown(self)
977
def time(self, callable, *args, **kwargs):
978
"""Run callable and accrue the time it takes to the benchmark time.
980
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
981
this will cause lsprofile statistics to be gathered and stored in
984
if self._benchtime is None:
988
if not self._gather_lsprof_in_benchmarks:
989
return callable(*args, **kwargs)
991
# record this benchmark
992
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
994
self._benchcalls.append(((callable, args, kwargs), stats))
997
self._benchtime += time.time() - start
999
def _runCleanups(self):
1000
"""Run registered cleanup functions.
1002
This should only be called from TestCase.tearDown.
1004
# TODO: Perhaps this should keep running cleanups even if
1005
# one of them fails?
1007
# Actually pop the cleanups from the list so tearDown running
1008
# twice is safe (this happens for skipped tests).
1009
while self._cleanups:
1010
self._cleanups.pop()()
1012
def log(self, *args):
1015
def _get_log(self, keep_log_file=False):
1016
"""Return as a string the log for this test. If the file is still
1017
on disk and keep_log_file=False, delete the log file and store the
1018
content in self._log_contents."""
1019
# flush the log file, to get all content
1021
bzrlib.trace._trace_file.flush()
1022
if self._log_contents:
1023
return self._log_contents
1024
if self._log_file_name is not None:
1025
logfile = open(self._log_file_name)
1027
log_contents = logfile.read()
1030
if not keep_log_file:
1031
self._log_contents = log_contents
1033
os.remove(self._log_file_name)
1035
if sys.platform == 'win32' and e.errno == errno.EACCES:
1036
print >>sys.stderr, ('Unable to delete log file '
1037
' %r' % self._log_file_name)
1042
return "DELETED log file to reduce memory footprint"
1044
def capture(self, cmd, retcode=0):
1045
"""Shortcut that splits cmd into words, runs, and returns stdout"""
1046
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
1048
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
1050
"""Invoke bzr and return (stdout, stderr).
1052
Useful for code that wants to check the contents of the
1053
output, the way error messages are presented, etc.
1055
This should be the main method for tests that want to exercise the
1056
overall behavior of the bzr application (rather than a unit test
1057
or a functional test of the library.)
1059
Much of the old code runs bzr by forking a new copy of Python, but
1060
that is slower, harder to debug, and generally not necessary.
1062
This runs bzr through the interface that catches and reports
1063
errors, and with logging set to something approximating the
1064
default, so that error reporting can be checked.
1066
:param argv: arguments to invoke bzr
1067
:param retcode: expected return code, or None for don't-care.
1068
:param encoding: encoding for sys.stdout and sys.stderr
1069
:param stdin: A string to be used as stdin for the command.
1070
:param working_dir: Change to this directory before running
1072
if encoding is None:
1073
encoding = bzrlib.user_encoding
1074
stdout = StringIOWrapper()
1075
stderr = StringIOWrapper()
1076
stdout.encoding = encoding
1077
stderr.encoding = encoding
1079
self.log('run bzr: %r', argv)
1080
# FIXME: don't call into logging here
1081
handler = logging.StreamHandler(stderr)
1082
handler.setLevel(logging.INFO)
1083
logger = logging.getLogger('')
1084
logger.addHandler(handler)
1085
old_ui_factory = ui.ui_factory
1086
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1089
if working_dir is not None:
1090
cwd = osutils.getcwd()
1091
os.chdir(working_dir)
1094
saved_debug_flags = frozenset(debug.debug_flags)
1095
debug.debug_flags.clear()
1097
result = self.apply_redirected(ui.ui_factory.stdin,
1099
bzrlib.commands.run_bzr_catch_errors,
1102
debug.debug_flags.update(saved_debug_flags)
1104
logger.removeHandler(handler)
1105
ui.ui_factory = old_ui_factory
1109
out = stdout.getvalue()
1110
err = stderr.getvalue()
1112
self.log('output:\n%r', out)
1114
self.log('errors:\n%r', err)
1115
if retcode is not None:
1116
self.assertEquals(retcode, result)
1119
def run_bzr(self, *args, **kwargs):
1120
"""Invoke bzr, as if it were run from the command line.
1122
This should be the main method for tests that want to exercise the
1123
overall behavior of the bzr application (rather than a unit test
1124
or a functional test of the library.)
1126
This sends the stdout/stderr results into the test's log,
1127
where it may be useful for debugging. See also run_captured.
1129
:param stdin: A string to be used as stdin for the command.
1130
:param retcode: The status code the command should return
1131
:param working_dir: The directory to run the command in
1133
retcode = kwargs.pop('retcode', 0)
1134
encoding = kwargs.pop('encoding', None)
1135
stdin = kwargs.pop('stdin', None)
1136
working_dir = kwargs.pop('working_dir', None)
1137
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding,
1138
stdin=stdin, working_dir=working_dir)
1140
def run_bzr_decode(self, *args, **kwargs):
1141
if 'encoding' in kwargs:
1142
encoding = kwargs['encoding']
1144
encoding = bzrlib.user_encoding
1145
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1147
def run_bzr_error(self, error_regexes, *args, **kwargs):
1148
"""Run bzr, and check that stderr contains the supplied regexes
1150
:param error_regexes: Sequence of regular expressions which
1151
must each be found in the error output. The relative ordering
1153
:param args: command-line arguments for bzr
1154
:param kwargs: Keyword arguments which are interpreted by run_bzr
1155
This function changes the default value of retcode to be 3,
1156
since in most cases this is run when you expect bzr to fail.
1157
:return: (out, err) The actual output of running the command (in case you
1158
want to do more inspection)
1161
# Make sure that commit is failing because there is nothing to do
1162
self.run_bzr_error(['no changes to commit'],
1163
'commit', '-m', 'my commit comment')
1164
# Make sure --strict is handling an unknown file, rather than
1165
# giving us the 'nothing to do' error
1166
self.build_tree(['unknown'])
1167
self.run_bzr_error(['Commit refused because there are unknown files'],
1168
'commit', '--strict', '-m', 'my commit comment')
1170
kwargs.setdefault('retcode', 3)
1171
out, err = self.run_bzr(*args, **kwargs)
1172
for regex in error_regexes:
1173
self.assertContainsRe(err, regex)
1176
def run_bzr_subprocess(self, *args, **kwargs):
1177
"""Run bzr in a subprocess for testing.
1179
This starts a new Python interpreter and runs bzr in there.
1180
This should only be used for tests that have a justifiable need for
1181
this isolation: e.g. they are testing startup time, or signal
1182
handling, or early startup code, etc. Subprocess code can't be
1183
profiled or debugged so easily.
1185
:param retcode: The status code that is expected. Defaults to 0. If
1186
None is supplied, the status code is not checked.
1187
:param env_changes: A dictionary which lists changes to environment
1188
variables. A value of None will unset the env variable.
1189
The values must be strings. The change will only occur in the
1190
child, so you don't need to fix the environment after running.
1191
:param universal_newlines: Convert CRLF => LF
1192
:param allow_plugins: By default the subprocess is run with
1193
--no-plugins to ensure test reproducibility. Also, it is possible
1194
for system-wide plugins to create unexpected output on stderr,
1195
which can cause unnecessary test failures.
1197
env_changes = kwargs.get('env_changes', {})
1198
working_dir = kwargs.get('working_dir', None)
1199
allow_plugins = kwargs.get('allow_plugins', False)
1200
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1201
working_dir=working_dir,
1202
allow_plugins=allow_plugins)
1203
# We distinguish between retcode=None and retcode not passed.
1204
supplied_retcode = kwargs.get('retcode', 0)
1205
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1206
universal_newlines=kwargs.get('universal_newlines', False),
1209
def start_bzr_subprocess(self, process_args, env_changes=None,
1210
skip_if_plan_to_signal=False,
1212
allow_plugins=False):
1213
"""Start bzr in a subprocess for testing.
1215
This starts a new Python interpreter and runs bzr in there.
1216
This should only be used for tests that have a justifiable need for
1217
this isolation: e.g. they are testing startup time, or signal
1218
handling, or early startup code, etc. Subprocess code can't be
1219
profiled or debugged so easily.
1221
:param process_args: a list of arguments to pass to the bzr executable,
1222
for example `['--version']`.
1223
:param env_changes: A dictionary which lists changes to environment
1224
variables. A value of None will unset the env variable.
1225
The values must be strings. The change will only occur in the
1226
child, so you don't need to fix the environment after running.
1227
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1229
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1231
:returns: Popen object for the started process.
1233
if skip_if_plan_to_signal:
1234
if not getattr(os, 'kill', None):
1235
raise TestSkipped("os.kill not available.")
1237
if env_changes is None:
1241
def cleanup_environment():
1242
for env_var, value in env_changes.iteritems():
1243
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1245
def restore_environment():
1246
for env_var, value in old_env.iteritems():
1247
osutils.set_or_unset_env(env_var, value)
1249
bzr_path = self.get_bzr_path()
1252
if working_dir is not None:
1253
cwd = osutils.getcwd()
1254
os.chdir(working_dir)
1257
# win32 subprocess doesn't support preexec_fn
1258
# so we will avoid using it on all platforms, just to
1259
# make sure the code path is used, and we don't break on win32
1260
cleanup_environment()
1261
command = [sys.executable, bzr_path]
1262
if not allow_plugins:
1263
command.append('--no-plugins')
1264
command.extend(process_args)
1265
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1267
restore_environment()
1273
def _popen(self, *args, **kwargs):
1274
"""Place a call to Popen.
1276
Allows tests to override this method to intercept the calls made to
1277
Popen for introspection.
1279
return Popen(*args, **kwargs)
1281
def get_bzr_path(self):
1282
"""Return the path of the 'bzr' executable for this test suite."""
1283
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1284
if not os.path.isfile(bzr_path):
1285
# We are probably installed. Assume sys.argv is the right file
1286
bzr_path = sys.argv[0]
1289
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1290
universal_newlines=False, process_args=None):
1291
"""Finish the execution of process.
1293
:param process: the Popen object returned from start_bzr_subprocess.
1294
:param retcode: The status code that is expected. Defaults to 0. If
1295
None is supplied, the status code is not checked.
1296
:param send_signal: an optional signal to send to the process.
1297
:param universal_newlines: Convert CRLF => LF
1298
:returns: (stdout, stderr)
1300
if send_signal is not None:
1301
os.kill(process.pid, send_signal)
1302
out, err = process.communicate()
1304
if universal_newlines:
1305
out = out.replace('\r\n', '\n')
1306
err = err.replace('\r\n', '\n')
1308
if retcode is not None and retcode != process.returncode:
1309
if process_args is None:
1310
process_args = "(unknown args)"
1311
mutter('Output of bzr %s:\n%s', process_args, out)
1312
mutter('Error for bzr %s:\n%s', process_args, err)
1313
self.fail('Command bzr %s failed with retcode %s != %s'
1314
% (process_args, retcode, process.returncode))
1317
def check_inventory_shape(self, inv, shape):
1318
"""Compare an inventory to a list of expected names.
1320
Fail if they are not precisely equal.
1323
shape = list(shape) # copy
1324
for path, ie in inv.entries():
1325
name = path.replace('\\', '/')
1326
if ie.kind == 'dir':
1333
self.fail("expected paths not found in inventory: %r" % shape)
1335
self.fail("unexpected paths found in inventory: %r" % extras)
1337
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1338
a_callable=None, *args, **kwargs):
1339
"""Call callable with redirected std io pipes.
1341
Returns the return code."""
1342
if not callable(a_callable):
1343
raise ValueError("a_callable must be callable.")
1345
stdin = StringIO("")
1347
if getattr(self, "_log_file", None) is not None:
1348
stdout = self._log_file
1352
if getattr(self, "_log_file", None is not None):
1353
stderr = self._log_file
1356
real_stdin = sys.stdin
1357
real_stdout = sys.stdout
1358
real_stderr = sys.stderr
1363
return a_callable(*args, **kwargs)
1365
sys.stdout = real_stdout
1366
sys.stderr = real_stderr
1367
sys.stdin = real_stdin
1369
@symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
1370
def merge(self, branch_from, wt_to):
1371
"""A helper for tests to do a ui-less merge.
1373
This should move to the main library when someone has time to integrate
1376
# minimal ui-less merge.
1377
wt_to.branch.fetch(branch_from)
1378
base_rev = common_ancestor(branch_from.last_revision(),
1379
wt_to.branch.last_revision(),
1380
wt_to.branch.repository)
1381
merge_inner(wt_to.branch, branch_from.basis_tree(),
1382
wt_to.branch.repository.revision_tree(base_rev),
1384
wt_to.add_parent_tree_id(branch_from.last_revision())
1387
BzrTestBase = TestCase
1390
class TestCaseWithMemoryTransport(TestCase):
1391
"""Common test class for tests that do not need disk resources.
1393
Tests that need disk resources should derive from TestCaseWithTransport.
1395
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1397
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1398
a directory which does not exist. This serves to help ensure test isolation
1399
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1400
must exist. However, TestCaseWithMemoryTransport does not offer local
1401
file defaults for the transport in tests, nor does it obey the command line
1402
override, so tests that accidentally write to the common directory should
1410
def __init__(self, methodName='runTest'):
1411
# allow test parameterisation after test construction and before test
1412
# execution. Variables that the parameteriser sets need to be
1413
# ones that are not set by setUp, or setUp will trash them.
1414
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1415
self.transport_server = default_transport
1416
self.transport_readonly_server = None
1418
def get_transport(self):
1419
"""Return a writeable transport for the test scratch space"""
1420
t = get_transport(self.get_url())
1421
self.assertFalse(t.is_readonly())
1424
def get_readonly_transport(self):
1425
"""Return a readonly transport for the test scratch space
1427
This can be used to test that operations which should only need
1428
readonly access in fact do not try to write.
1430
t = get_transport(self.get_readonly_url())
1431
self.assertTrue(t.is_readonly())
1434
def create_transport_readonly_server(self):
1435
"""Create a transport server from class defined at init.
1437
This is mostly a hook for daughter classes.
1439
return self.transport_readonly_server()
1441
def get_readonly_server(self):
1442
"""Get the server instance for the readonly transport
1444
This is useful for some tests with specific servers to do diagnostics.
1446
if self.__readonly_server is None:
1447
if self.transport_readonly_server is None:
1448
# readonly decorator requested
1449
# bring up the server
1451
self.__readonly_server = ReadonlyServer()
1452
self.__readonly_server.setUp(self.__server)
1454
self.__readonly_server = self.create_transport_readonly_server()
1455
self.__readonly_server.setUp()
1456
self.addCleanup(self.__readonly_server.tearDown)
1457
return self.__readonly_server
1459
def get_readonly_url(self, relpath=None):
1460
"""Get a URL for the readonly transport.
1462
This will either be backed by '.' or a decorator to the transport
1463
used by self.get_url()
1464
relpath provides for clients to get a path relative to the base url.
1465
These should only be downwards relative, not upwards.
1467
base = self.get_readonly_server().get_url()
1468
if relpath is not None:
1469
if not base.endswith('/'):
1471
base = base + relpath
1474
def get_server(self):
1475
"""Get the read/write server instance.
1477
This is useful for some tests with specific servers that need
1480
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1481
is no means to override it.
1483
if self.__server is None:
1484
self.__server = MemoryServer()
1485
self.__server.setUp()
1486
self.addCleanup(self.__server.tearDown)
1487
return self.__server
1489
def get_url(self, relpath=None):
1490
"""Get a URL (or maybe a path) for the readwrite transport.
1492
This will either be backed by '.' or to an equivalent non-file based
1494
relpath provides for clients to get a path relative to the base url.
1495
These should only be downwards relative, not upwards.
1497
base = self.get_server().get_url()
1498
if relpath is not None and relpath != '.':
1499
if not base.endswith('/'):
1501
# XXX: Really base should be a url; we did after all call
1502
# get_url()! But sometimes it's just a path (from
1503
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1504
# to a non-escaped local path.
1505
if base.startswith('./') or base.startswith('/'):
1508
base += urlutils.escape(relpath)
1511
def _make_test_root(self):
1512
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1516
root = u'test%04d.tmp' % i
1520
if e.errno == errno.EEXIST:
1525
# successfully created
1526
TestCaseWithMemoryTransport.TEST_ROOT = osutils.abspath(root)
1528
# make a fake bzr directory there to prevent any tests propagating
1529
# up onto the source directory's real branch
1530
bzrdir.BzrDir.create_standalone_workingtree(
1531
TestCaseWithMemoryTransport.TEST_ROOT)
1533
def makeAndChdirToTestDir(self):
1534
"""Create a temporary directories for this one test.
1536
This must set self.test_home_dir and self.test_dir and chdir to
1539
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1541
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1542
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1543
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1545
def make_branch(self, relpath, format=None):
1546
"""Create a branch on the transport at relpath."""
1547
repo = self.make_repository(relpath, format=format)
1548
return repo.bzrdir.create_branch()
1550
def make_bzrdir(self, relpath, format=None):
1552
# might be a relative or absolute path
1553
maybe_a_url = self.get_url(relpath)
1554
segments = maybe_a_url.rsplit('/', 1)
1555
t = get_transport(maybe_a_url)
1556
if len(segments) > 1 and segments[-1] not in ('', '.'):
1559
except errors.FileExists:
1563
if isinstance(format, basestring):
1564
format = bzrdir.format_registry.make_bzrdir(format)
1565
return format.initialize_on_transport(t)
1566
except errors.UninitializableFormat:
1567
raise TestSkipped("Format %s is not initializable." % format)
1569
def make_repository(self, relpath, shared=False, format=None):
1570
"""Create a repository on our default transport at relpath."""
1571
made_control = self.make_bzrdir(relpath, format=format)
1572
return made_control.create_repository(shared=shared)
1574
def make_branch_and_memory_tree(self, relpath, format=None):
1575
"""Create a branch on the default transport and a MemoryTree for it."""
1576
b = self.make_branch(relpath, format=format)
1577
return memorytree.MemoryTree.create_on_branch(b)
1579
def overrideEnvironmentForTesting(self):
1580
os.environ['HOME'] = self.test_home_dir
1581
os.environ['BZR_HOME'] = self.test_home_dir
1584
super(TestCaseWithMemoryTransport, self).setUp()
1585
self._make_test_root()
1586
_currentdir = os.getcwdu()
1587
def _leaveDirectory():
1588
os.chdir(_currentdir)
1589
self.addCleanup(_leaveDirectory)
1590
self.makeAndChdirToTestDir()
1591
self.overrideEnvironmentForTesting()
1592
self.__readonly_server = None
1593
self.__server = None
1596
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1597
"""Derived class that runs a test within a temporary directory.
1599
This is useful for tests that need to create a branch, etc.
1601
The directory is created in a slightly complex way: for each
1602
Python invocation, a new temporary top-level directory is created.
1603
All test cases create their own directory within that. If the
1604
tests complete successfully, the directory is removed.
1606
InTempDir is an old alias for FunctionalTestCase.
1609
OVERRIDE_PYTHON = 'python'
1611
def check_file_contents(self, filename, expect):
1612
self.log("check contents of file %s" % filename)
1613
contents = file(filename, 'r').read()
1614
if contents != expect:
1615
self.log("expected: %r" % expect)
1616
self.log("actually: %r" % contents)
1617
self.fail("contents of %s not as expected" % filename)
1619
def makeAndChdirToTestDir(self):
1620
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1622
For TestCaseInTempDir we create a temporary directory based on the test
1623
name and then create two subdirs - test and home under it.
1625
if NUMBERED_DIRS: # strongly recommended on Windows
1626
# due the path length limitation (260 chars)
1627
candidate_dir = '%s/%dK/%05d' % (self.TEST_ROOT,
1628
int(self.number/1000),
1630
os.makedirs(candidate_dir)
1631
self.test_home_dir = candidate_dir + '/home'
1632
os.mkdir(self.test_home_dir)
1633
self.test_dir = candidate_dir + '/work'
1634
os.mkdir(self.test_dir)
1635
os.chdir(self.test_dir)
1636
# put name of test inside
1637
f = file(candidate_dir + '/name', 'w')
1642
# shorten the name, to avoid test failures due to path length
1643
short_id = self.id().replace('bzrlib.tests.', '') \
1644
.replace('__main__.', '')[-100:]
1645
# it's possible the same test class is run several times for
1646
# parameterized tests, so make sure the names don't collide.
1650
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1652
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1653
if os.path.exists(candidate_dir):
1657
os.mkdir(candidate_dir)
1658
self.test_home_dir = candidate_dir + '/home'
1659
os.mkdir(self.test_home_dir)
1660
self.test_dir = candidate_dir + '/work'
1661
os.mkdir(self.test_dir)
1662
os.chdir(self.test_dir)
1665
def build_tree(self, shape, line_endings='binary', transport=None):
1666
"""Build a test tree according to a pattern.
1668
shape is a sequence of file specifications. If the final
1669
character is '/', a directory is created.
1671
This assumes that all the elements in the tree being built are new.
1673
This doesn't add anything to a branch.
1674
:param line_endings: Either 'binary' or 'native'
1675
in binary mode, exact contents are written
1676
in native mode, the line endings match the
1677
default platform endings.
1679
:param transport: A transport to write to, for building trees on
1680
VFS's. If the transport is readonly or None,
1681
"." is opened automatically.
1683
# It's OK to just create them using forward slashes on windows.
1684
if transport is None or transport.is_readonly():
1685
transport = get_transport(".")
1687
self.assert_(isinstance(name, basestring))
1689
transport.mkdir(urlutils.escape(name[:-1]))
1691
if line_endings == 'binary':
1693
elif line_endings == 'native':
1696
raise errors.BzrError(
1697
'Invalid line ending request %r' % line_endings)
1698
content = "contents of %s%s" % (name.encode('utf-8'), end)
1699
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1701
def build_tree_contents(self, shape):
1702
build_tree_contents(shape)
1704
def assertFileEqual(self, content, path):
1705
"""Fail if path does not contain 'content'."""
1706
self.failUnlessExists(path)
1707
# TODO: jam 20060427 Shouldn't this be 'rb'?
1713
self.assertEqualDiff(content, s)
1715
def failUnlessExists(self, path):
1716
"""Fail unless path, which may be abs or relative, exists."""
1717
self.failUnless(osutils.lexists(path),path+" does not exist")
1719
def failIfExists(self, path):
1720
"""Fail if path, which may be abs or relative, exists."""
1721
self.failIf(osutils.lexists(path),path+" exists")
1724
class TestCaseWithTransport(TestCaseInTempDir):
1725
"""A test case that provides get_url and get_readonly_url facilities.
1727
These back onto two transport servers, one for readonly access and one for
1730
If no explicit class is provided for readonly access, a
1731
ReadonlyTransportDecorator is used instead which allows the use of non disk
1732
based read write transports.
1734
If an explicit class is provided for readonly access, that server and the
1735
readwrite one must both define get_url() as resolving to os.getcwd().
1738
def create_transport_server(self):
1739
"""Create a transport server from class defined at init.
1741
This is mostly a hook for daughter classes.
1743
return self.transport_server()
1745
def get_server(self):
1746
"""See TestCaseWithMemoryTransport.
1748
This is useful for some tests with specific servers that need
1751
if self.__server is None:
1752
self.__server = self.create_transport_server()
1753
self.__server.setUp()
1754
self.addCleanup(self.__server.tearDown)
1755
return self.__server
1757
def make_branch_and_tree(self, relpath, format=None):
1758
"""Create a branch on the transport and a tree locally.
1760
If the transport is not a LocalTransport, the Tree can't be created on
1761
the transport. In that case the working tree is created in the local
1762
directory, and the returned tree's branch and repository will also be
1765
This will fail if the original default transport for this test
1766
case wasn't backed by the working directory, as the branch won't
1767
be on disk for us to open it.
1769
:param format: The BzrDirFormat.
1770
:returns: the WorkingTree.
1772
# TODO: always use the local disk path for the working tree,
1773
# this obviously requires a format that supports branch references
1774
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1776
b = self.make_branch(relpath, format=format)
1778
return b.bzrdir.create_workingtree()
1779
except errors.NotLocalUrl:
1780
# We can only make working trees locally at the moment. If the
1781
# transport can't support them, then reopen the branch on a local
1782
# transport, and create the working tree there.
1784
# Possibly we should instead keep
1785
# the non-disk-backed branch and create a local checkout?
1786
bd = bzrdir.BzrDir.open(relpath)
1787
return bd.create_workingtree()
1789
def assertIsDirectory(self, relpath, transport):
1790
"""Assert that relpath within transport is a directory.
1792
This may not be possible on all transports; in that case it propagates
1793
a TransportNotPossible.
1796
mode = transport.stat(relpath).st_mode
1797
except errors.NoSuchFile:
1798
self.fail("path %s is not a directory; no such file"
1800
if not stat.S_ISDIR(mode):
1801
self.fail("path %s is not a directory; has mode %#o"
1804
def assertTreesEqual(self, left, right):
1805
"""Check that left and right have the same content and properties."""
1806
# we use a tree delta to check for equality of the content, and we
1807
# manually check for equality of other things such as the parents list.
1808
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
1809
differences = left.changes_from(right)
1810
self.assertFalse(differences.has_changed(),
1811
"Trees %r and %r are different: %r" % (left, right, differences))
1814
super(TestCaseWithTransport, self).setUp()
1815
self.__server = None
1818
class ChrootedTestCase(TestCaseWithTransport):
1819
"""A support class that provides readonly urls outside the local namespace.
1821
This is done by checking if self.transport_server is a MemoryServer. if it
1822
is then we are chrooted already, if it is not then an HttpServer is used
1825
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1826
be used without needed to redo it when a different
1827
subclass is in use ?
1831
super(ChrootedTestCase, self).setUp()
1832
if not self.transport_server == MemoryServer:
1833
self.transport_readonly_server = HttpServer
1836
def filter_suite_by_re(suite, pattern):
1837
result = TestUtil.TestSuite()
1838
filter_re = re.compile(pattern)
1839
for test in iter_suite_tests(suite):
1840
if filter_re.search(test.id()):
1841
result.addTest(test)
1845
def sort_suite_by_re(suite, pattern):
1848
filter_re = re.compile(pattern)
1849
for test in iter_suite_tests(suite):
1850
if filter_re.search(test.id()):
1854
return TestUtil.TestSuite(first + second)
1857
def run_suite(suite, name='test', verbose=False, pattern=".*",
1858
stop_on_failure=False, keep_output=False,
1859
transport=None, lsprof_timed=None, bench_history=None,
1860
matching_tests_first=None,
1861
numbered_dirs=None):
1862
global NUMBERED_DIRS
1863
if numbered_dirs is not None:
1864
NUMBERED_DIRS = bool(numbered_dirs)
1866
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1871
runner = TextTestRunner(stream=sys.stdout,
1873
verbosity=verbosity,
1874
keep_output=keep_output,
1875
bench_history=bench_history)
1876
runner.stop_on_failure=stop_on_failure
1878
if matching_tests_first:
1879
suite = sort_suite_by_re(suite, pattern)
1881
suite = filter_suite_by_re(suite, pattern)
1882
result = runner.run(suite)
1883
return result.wasSuccessful()
1886
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1889
test_suite_factory=None,
1892
matching_tests_first=None,
1893
numbered_dirs=None):
1894
"""Run the whole test suite under the enhanced runner"""
1895
# XXX: Very ugly way to do this...
1896
# Disable warning about old formats because we don't want it to disturb
1897
# any blackbox tests.
1898
from bzrlib import repository
1899
repository._deprecation_warning_done = True
1901
global default_transport
1902
if transport is None:
1903
transport = default_transport
1904
old_transport = default_transport
1905
default_transport = transport
1907
if test_suite_factory is None:
1908
suite = test_suite()
1910
suite = test_suite_factory()
1911
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1912
stop_on_failure=stop_on_failure, keep_output=keep_output,
1913
transport=transport,
1914
lsprof_timed=lsprof_timed,
1915
bench_history=bench_history,
1916
matching_tests_first=matching_tests_first,
1917
numbered_dirs=numbered_dirs)
1919
default_transport = old_transport
1923
"""Build and return TestSuite for the whole of bzrlib.
1925
This function can be replaced if you need to change the default test
1926
suite on a global basis, but it is not encouraged.
1929
'bzrlib.tests.test_ancestry',
1930
'bzrlib.tests.test_annotate',
1931
'bzrlib.tests.test_api',
1932
'bzrlib.tests.test_atomicfile',
1933
'bzrlib.tests.test_bad_files',
1934
'bzrlib.tests.test_branch',
1935
'bzrlib.tests.test_bundle',
1936
'bzrlib.tests.test_bzrdir',
1937
'bzrlib.tests.test_cache_utf8',
1938
'bzrlib.tests.test_commands',
1939
'bzrlib.tests.test_commit',
1940
'bzrlib.tests.test_commit_merge',
1941
'bzrlib.tests.test_config',
1942
'bzrlib.tests.test_conflicts',
1943
'bzrlib.tests.test_decorators',
1944
'bzrlib.tests.test_delta',
1945
'bzrlib.tests.test_diff',
1946
'bzrlib.tests.test_dirstate',
1947
'bzrlib.tests.test_doc_generate',
1948
'bzrlib.tests.test_errors',
1949
'bzrlib.tests.test_escaped_store',
1950
'bzrlib.tests.test_extract',
1951
'bzrlib.tests.test_fetch',
1952
'bzrlib.tests.test_ftp_transport',
1953
'bzrlib.tests.test_generate_docs',
1954
'bzrlib.tests.test_generate_ids',
1955
'bzrlib.tests.test_globbing',
1956
'bzrlib.tests.test_gpg',
1957
'bzrlib.tests.test_graph',
1958
'bzrlib.tests.test_hashcache',
1959
'bzrlib.tests.test_http',
1960
'bzrlib.tests.test_http_response',
1961
'bzrlib.tests.test_https_ca_bundle',
1962
'bzrlib.tests.test_identitymap',
1963
'bzrlib.tests.test_ignores',
1964
'bzrlib.tests.test_inv',
1965
'bzrlib.tests.test_knit',
1966
'bzrlib.tests.test_lazy_import',
1967
'bzrlib.tests.test_lazy_regex',
1968
'bzrlib.tests.test_lockdir',
1969
'bzrlib.tests.test_lockable_files',
1970
'bzrlib.tests.test_log',
1971
'bzrlib.tests.test_memorytree',
1972
'bzrlib.tests.test_merge',
1973
'bzrlib.tests.test_merge3',
1974
'bzrlib.tests.test_merge_core',
1975
'bzrlib.tests.test_merge_directive',
1976
'bzrlib.tests.test_missing',
1977
'bzrlib.tests.test_msgeditor',
1978
'bzrlib.tests.test_nonascii',
1979
'bzrlib.tests.test_options',
1980
'bzrlib.tests.test_osutils',
1981
'bzrlib.tests.test_osutils_encodings',
1982
'bzrlib.tests.test_patch',
1983
'bzrlib.tests.test_patches',
1984
'bzrlib.tests.test_permissions',
1985
'bzrlib.tests.test_plugins',
1986
'bzrlib.tests.test_progress',
1987
'bzrlib.tests.test_reconcile',
1988
'bzrlib.tests.test_registry',
1989
'bzrlib.tests.test_repository',
1990
'bzrlib.tests.test_revert',
1991
'bzrlib.tests.test_revision',
1992
'bzrlib.tests.test_revisionnamespaces',
1993
'bzrlib.tests.test_revisiontree',
1994
'bzrlib.tests.test_rio',
1995
'bzrlib.tests.test_sampler',
1996
'bzrlib.tests.test_selftest',
1997
'bzrlib.tests.test_setup',
1998
'bzrlib.tests.test_sftp_transport',
1999
'bzrlib.tests.test_smart_add',
2000
'bzrlib.tests.test_smart_transport',
2001
'bzrlib.tests.test_source',
2002
'bzrlib.tests.test_ssh_transport',
2003
'bzrlib.tests.test_status',
2004
'bzrlib.tests.test_store',
2005
'bzrlib.tests.test_subsume',
2006
'bzrlib.tests.test_symbol_versioning',
2007
'bzrlib.tests.test_tag',
2008
'bzrlib.tests.test_testament',
2009
'bzrlib.tests.test_textfile',
2010
'bzrlib.tests.test_textmerge',
2011
'bzrlib.tests.test_timestamp',
2012
'bzrlib.tests.test_trace',
2013
'bzrlib.tests.test_transactions',
2014
'bzrlib.tests.test_transform',
2015
'bzrlib.tests.test_transport',
2016
'bzrlib.tests.test_tree',
2017
'bzrlib.tests.test_treebuilder',
2018
'bzrlib.tests.test_tsort',
2019
'bzrlib.tests.test_tuned_gzip',
2020
'bzrlib.tests.test_ui',
2021
'bzrlib.tests.test_upgrade',
2022
'bzrlib.tests.test_urlutils',
2023
'bzrlib.tests.test_versionedfile',
2024
'bzrlib.tests.test_version',
2025
'bzrlib.tests.test_version_info',
2026
'bzrlib.tests.test_weave',
2027
'bzrlib.tests.test_whitebox',
2028
'bzrlib.tests.test_workingtree',
2029
'bzrlib.tests.test_workingtree_4',
2030
'bzrlib.tests.test_wsgi',
2031
'bzrlib.tests.test_xml',
2033
test_transport_implementations = [
2034
'bzrlib.tests.test_transport_implementations',
2035
'bzrlib.tests.test_read_bundle',
2037
suite = TestUtil.TestSuite()
2038
loader = TestUtil.TestLoader()
2039
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2040
from bzrlib.transport import TransportTestProviderAdapter
2041
adapter = TransportTestProviderAdapter()
2042
adapt_modules(test_transport_implementations, adapter, loader, suite)
2043
for package in packages_to_test():
2044
suite.addTest(package.test_suite())
2045
for m in MODULES_TO_TEST:
2046
suite.addTest(loader.loadTestsFromModule(m))
2047
for m in MODULES_TO_DOCTEST:
2049
suite.addTest(doctest.DocTestSuite(m))
2050
except ValueError, e:
2051
print '**failed to get doctest for: %s\n%s' %(m,e)
2053
for name, plugin in bzrlib.plugin.all_plugins().items():
2054
if getattr(plugin, 'test_suite', None) is not None:
2055
default_encoding = sys.getdefaultencoding()
2057
plugin_suite = plugin.test_suite()
2058
except ImportError, e:
2059
bzrlib.trace.warning(
2060
'Unable to test plugin "%s": %s', name, e)
2062
suite.addTest(plugin_suite)
2063
if default_encoding != sys.getdefaultencoding():
2064
bzrlib.trace.warning(
2065
'Plugin "%s" tried to reset default encoding to: %s', name,
2066
sys.getdefaultencoding())
2068
sys.setdefaultencoding(default_encoding)
2072
def adapt_modules(mods_list, adapter, loader, suite):
2073
"""Adapt the modules in mods_list using adapter and add to suite."""
2074
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2075
suite.addTests(adapter.adapt(test))
2078
def clean_selftest_output(root=None, quiet=False):
2079
"""Remove all selftest output directories from root directory.
2081
:param root: root directory for clean
2082
(if ommitted or None then clean current directory).
2083
:param quiet: suppress report about deleting directories
2088
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
2091
for i in os.listdir(root):
2092
if os.path.isdir(i) and re_dir.match(i):
2094
print 'delete directory:', i
added
removed
bzrlib/tests/__init__.py
