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.repository_implementations
124
import bzrlib.tests.revisionstore_implementations
125
import bzrlib.tests.tree_implementations
126
import bzrlib.tests.workingtree_implementations
129
bzrlib.tests.blackbox,
130
bzrlib.tests.branch_implementations,
131
bzrlib.tests.bzrdir_implementations,
132
bzrlib.tests.interrepository_implementations,
133
bzrlib.tests.interversionedfile_implementations,
134
bzrlib.tests.intertree_implementations,
135
bzrlib.tests.repository_implementations,
136
bzrlib.tests.revisionstore_implementations,
137
bzrlib.tests.tree_implementations,
138
bzrlib.tests.workingtree_implementations,
142
class ExtendedTestResult(unittest._TextTestResult):
143
"""Accepts, reports and accumulates the results of running tests.
145
Compared to this unittest version this class adds support for profiling,
146
benchmarking, stopping as soon as a test fails, and skipping tests.
147
There are further-specialized subclasses for different types of display.
152
def __init__(self, stream, descriptions, verbosity,
156
"""Construct new TestResult.
158
:param bench_history: Optionally, a writable file object to accumulate
161
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
162
if bench_history is not None:
163
from bzrlib.version import _get_bzr_source_tree
164
src_tree = _get_bzr_source_tree()
167
revision_id = src_tree.get_parent_ids()[0]
169
# XXX: if this is a brand new tree, do the same as if there
173
# XXX: If there's no branch, what should we do?
175
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
176
self._bench_history = bench_history
177
self.ui = ui.ui_factory
178
self.num_tests = num_tests
180
self.failure_count = 0
183
self._overall_start_time = time.time()
185
def extractBenchmarkTime(self, testCase):
186
"""Add a benchmark time for the current test case."""
187
self._benchmarkTime = getattr(testCase, "_benchtime", None)
189
def _elapsedTestTimeString(self):
190
"""Return a time string for the overall time the current test has taken."""
191
return self._formatTime(time.time() - self._start_time)
193
def _testTimeString(self):
194
if self._benchmarkTime is not None:
196
self._formatTime(self._benchmarkTime),
197
self._elapsedTestTimeString())
199
return " %s" % self._elapsedTestTimeString()
201
def _formatTime(self, seconds):
202
"""Format seconds as milliseconds with leading spaces."""
203
# some benchmarks can take thousands of seconds to run, so we need 8
205
return "%8dms" % (1000 * seconds)
207
def _shortened_test_description(self, test):
209
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
212
def startTest(self, test):
213
unittest.TestResult.startTest(self, test)
214
self.report_test_start(test)
215
test.number = self.count
216
self._recordTestStartTime()
218
def _recordTestStartTime(self):
219
"""Record that a test has started."""
220
self._start_time = time.time()
222
def addError(self, test, err):
223
if isinstance(err[1], TestSkipped):
224
return self.addSkipped(test, err)
225
unittest.TestResult.addError(self, test, err)
226
# We can only do this if we have one of our TestCases, not if
228
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
229
if setKeepLogfile is not None:
231
self.extractBenchmarkTime(test)
232
self.report_error(test, err)
236
def addFailure(self, test, err):
237
unittest.TestResult.addFailure(self, test, err)
238
# We can only do this if we have one of our TestCases, not if
240
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
241
if setKeepLogfile is not None:
243
self.extractBenchmarkTime(test)
244
self.report_failure(test, err)
248
def addSuccess(self, test):
249
self.extractBenchmarkTime(test)
250
if self._bench_history is not None:
251
if self._benchmarkTime is not None:
252
self._bench_history.write("%s %s\n" % (
253
self._formatTime(self._benchmarkTime),
255
self.report_success(test)
256
unittest.TestResult.addSuccess(self, test)
258
def addSkipped(self, test, skip_excinfo):
259
self.extractBenchmarkTime(test)
260
self.report_skip(test, skip_excinfo)
261
# seems best to treat this as success from point-of-view of unittest
262
# -- it actually does nothing so it barely matters :)
265
except KeyboardInterrupt:
268
self.addError(test, test.__exc_info())
270
unittest.TestResult.addSuccess(self, test)
272
def printErrorList(self, flavour, errors):
273
for test, err in errors:
274
self.stream.writeln(self.separator1)
275
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
276
if getattr(test, '_get_log', None) is not None:
278
print >>self.stream, \
279
('vvvv[log from %s]' % test.id()).ljust(78,'-')
280
print >>self.stream, test._get_log()
281
print >>self.stream, \
282
('^^^^[log from %s]' % test.id()).ljust(78,'-')
283
self.stream.writeln(self.separator2)
284
self.stream.writeln("%s" % err)
289
def report_cleaning_up(self):
292
def report_success(self, test):
296
class TextTestResult(ExtendedTestResult):
297
"""Displays progress and results of tests in text form"""
299
def __init__(self, *args, **kw):
300
ExtendedTestResult.__init__(self, *args, **kw)
301
self.pb = self.ui.nested_progress_bar()
302
self.pb.show_pct = False
303
self.pb.show_spinner = False
304
self.pb.show_eta = False,
305
self.pb.show_count = False
306
self.pb.show_bar = False
308
def report_starting(self):
309
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
311
def _progress_prefix_text(self):
312
a = '[%d' % self.count
313
if self.num_tests is not None:
314
a +='/%d' % self.num_tests
315
a += ' in %ds' % (time.time() - self._overall_start_time)
317
a += ', %d errors' % self.error_count
318
if self.failure_count:
319
a += ', %d failed' % self.failure_count
321
a += ', %d skipped' % self.skip_count
325
def report_test_start(self, test):
328
self._progress_prefix_text()
330
+ self._shortened_test_description(test))
332
def _test_description(self, test):
334
return '#%d %s' % (self.count,
335
self._shortened_test_description(test))
337
return self._shortened_test_description(test)
339
def report_error(self, test, err):
340
self.error_count += 1
341
self.pb.note('ERROR: %s\n %s\n',
342
self._test_description(test),
346
def report_failure(self, test, err):
347
self.failure_count += 1
348
self.pb.note('FAIL: %s\n %s\n',
349
self._test_description(test),
353
def report_skip(self, test, skip_excinfo):
356
# at the moment these are mostly not things we can fix
357
# and so they just produce stipple; use the verbose reporter
360
# show test and reason for skip
361
self.pb.note('SKIP: %s\n %s\n',
362
self._shortened_test_description(test),
365
# since the class name was left behind in the still-visible
367
self.pb.note('SKIP: %s', skip_excinfo[1])
369
def report_cleaning_up(self):
370
self.pb.update('cleaning up...')
376
class VerboseTestResult(ExtendedTestResult):
377
"""Produce long output, with one line per test run plus times"""
379
def _ellipsize_to_right(self, a_string, final_width):
380
"""Truncate and pad a string, keeping the right hand side"""
381
if len(a_string) > final_width:
382
result = '...' + a_string[3-final_width:]
385
return result.ljust(final_width)
387
def report_starting(self):
388
self.stream.write('running %d tests...\n' % self.num_tests)
390
def report_test_start(self, test):
392
name = self._shortened_test_description(test)
393
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
394
# numbers, plus a trailing blank
395
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
397
self.stream.write('%5d ' % self.count)
398
self.stream.write(self._ellipsize_to_right(name,
399
osutils.terminal_width()-36))
401
self.stream.write(self._ellipsize_to_right(name,
402
osutils.terminal_width()-30))
405
def _error_summary(self, err):
409
return '%s%s' % (indent, err[1])
411
def report_error(self, test, err):
412
self.error_count += 1
413
self.stream.writeln('ERROR %s\n%s'
414
% (self._testTimeString(),
415
self._error_summary(err)))
417
def report_failure(self, test, err):
418
self.failure_count += 1
419
self.stream.writeln(' FAIL %s\n%s'
420
% (self._testTimeString(),
421
self._error_summary(err)))
423
def report_success(self, test):
424
self.stream.writeln(' OK %s' % self._testTimeString())
425
for bench_called, stats in getattr(test, '_benchcalls', []):
426
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
427
stats.pprint(file=self.stream)
430
def report_skip(self, test, skip_excinfo):
432
self.stream.writeln(' SKIP %s\n%s'
433
% (self._testTimeString(),
434
self._error_summary(skip_excinfo)))
437
class TextTestRunner(object):
438
stop_on_failure = False
446
self.stream = unittest._WritelnDecorator(stream)
447
self.descriptions = descriptions
448
self.verbosity = verbosity
449
self.keep_output = keep_output
450
self._bench_history = bench_history
453
"Run the given test case or test suite."
454
startTime = time.time()
455
if self.verbosity == 1:
456
result_class = TextTestResult
457
elif self.verbosity >= 2:
458
result_class = VerboseTestResult
459
result = result_class(self.stream,
462
bench_history=self._bench_history,
463
num_tests=test.countTestCases(),
465
result.stop_early = self.stop_on_failure
466
result.report_starting()
468
stopTime = time.time()
469
timeTaken = stopTime - startTime
471
self.stream.writeln(result.separator2)
472
run = result.testsRun
473
self.stream.writeln("Ran %d test%s in %.3fs" %
474
(run, run != 1 and "s" or "", timeTaken))
475
self.stream.writeln()
476
if not result.wasSuccessful():
477
self.stream.write("FAILED (")
478
failed, errored = map(len, (result.failures, result.errors))
480
self.stream.write("failures=%d" % failed)
482
if failed: self.stream.write(", ")
483
self.stream.write("errors=%d" % errored)
484
self.stream.writeln(")")
486
self.stream.writeln("OK")
487
if result.skip_count > 0:
488
skipped = result.skip_count
489
self.stream.writeln('%d test%s skipped' %
490
(skipped, skipped != 1 and "s" or ""))
491
result.report_cleaning_up()
492
# This is still a little bogus,
493
# but only a little. Folk not using our testrunner will
494
# have to delete their temp directories themselves.
495
test_root = TestCaseWithMemoryTransport.TEST_ROOT
496
if result.wasSuccessful() or not self.keep_output:
497
if test_root is not None:
498
# If LANG=C we probably have created some bogus paths
499
# which rmtree(unicode) will fail to delete
500
# so make sure we are using rmtree(str) to delete everything
501
# except on win32, where rmtree(str) will fail
502
# since it doesn't have the property of byte-stream paths
503
# (they are either ascii or mbcs)
504
if sys.platform == 'win32':
505
# make sure we are using the unicode win32 api
506
test_root = unicode(test_root)
508
test_root = test_root.encode(
509
sys.getfilesystemencoding())
511
osutils.rmtree(test_root)
513
if sys.platform == 'win32' and e.errno == errno.EACCES:
514
print >>sys.stderr, ('Permission denied: '
515
'unable to remove testing dir '
516
'%s' % os.path.basename(test_root))
520
note("Failed tests working directories are in '%s'\n", test_root)
521
TestCaseWithMemoryTransport.TEST_ROOT = None
526
def iter_suite_tests(suite):
527
"""Return all tests in a suite, recursing through nested suites"""
528
for item in suite._tests:
529
if isinstance(item, unittest.TestCase):
531
elif isinstance(item, unittest.TestSuite):
532
for r in iter_suite_tests(item):
535
raise Exception('unknown object %r inside test suite %r'
539
class TestSkipped(Exception):
540
"""Indicates that a test was intentionally skipped, rather than failing."""
543
class CommandFailed(Exception):
547
class StringIOWrapper(object):
548
"""A wrapper around cStringIO which just adds an encoding attribute.
550
Internally we can check sys.stdout to see what the output encoding
551
should be. However, cStringIO has no encoding attribute that we can
552
set. So we wrap it instead.
557
def __init__(self, s=None):
559
self.__dict__['_cstring'] = StringIO(s)
561
self.__dict__['_cstring'] = StringIO()
563
def __getattr__(self, name, getattr=getattr):
564
return getattr(self.__dict__['_cstring'], name)
566
def __setattr__(self, name, val):
567
if name == 'encoding':
568
self.__dict__['encoding'] = val
570
return setattr(self._cstring, name, val)
573
class TestUIFactory(ui.CLIUIFactory):
574
"""A UI Factory for testing.
576
Hide the progress bar but emit note()s.
578
Allows get_password to be tested without real tty attached.
585
super(TestUIFactory, self).__init__()
586
if stdin is not None:
587
# We use a StringIOWrapper to be able to test various
588
# encodings, but the user is still responsible to
589
# encode the string and to set the encoding attribute
590
# of StringIOWrapper.
591
self.stdin = StringIOWrapper(stdin)
593
self.stdout = sys.stdout
597
self.stderr = sys.stderr
602
"""See progress.ProgressBar.clear()."""
604
def clear_term(self):
605
"""See progress.ProgressBar.clear_term()."""
607
def clear_term(self):
608
"""See progress.ProgressBar.clear_term()."""
611
"""See progress.ProgressBar.finished()."""
613
def note(self, fmt_string, *args, **kwargs):
614
"""See progress.ProgressBar.note()."""
615
self.stdout.write((fmt_string + "\n") % args)
617
def progress_bar(self):
620
def nested_progress_bar(self):
623
def update(self, message, count=None, total=None):
624
"""See progress.ProgressBar.update()."""
626
def get_non_echoed_password(self, prompt):
627
"""Get password from stdin without trying to handle the echo mode"""
629
self.stdout.write(prompt)
630
password = self.stdin.readline()
633
if password[-1] == '\n':
634
password = password[:-1]
638
class TestCase(unittest.TestCase):
639
"""Base class for bzr unit tests.
641
Tests that need access to disk resources should subclass
642
TestCaseInTempDir not TestCase.
644
Error and debug log messages are redirected from their usual
645
location into a temporary file, the contents of which can be
646
retrieved by _get_log(). We use a real OS file, not an in-memory object,
647
so that it can also capture file IO. When the test completes this file
648
is read into memory and removed from disk.
650
There are also convenience functions to invoke bzr's command-line
651
routine, and to build and check bzr trees.
653
In addition to the usual method of overriding tearDown(), this class also
654
allows subclasses to register functions into the _cleanups list, which is
655
run in order as the object is torn down. It's less likely this will be
656
accidentally overlooked.
659
_log_file_name = None
661
_keep_log_file = False
662
# record lsprof data when performing benchmark calls.
663
_gather_lsprof_in_benchmarks = False
665
def __init__(self, methodName='testMethod'):
666
super(TestCase, self).__init__(methodName)
670
unittest.TestCase.setUp(self)
671
self._cleanEnvironment()
672
bzrlib.trace.disable_default_logging()
675
self._benchcalls = []
676
self._benchtime = None
677
# prevent hooks affecting tests
678
self._preserved_hooks = bzrlib.branch.Branch.hooks
679
self.addCleanup(self._restoreHooks)
680
# this list of hooks must be kept in sync with the defaults
682
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
684
def _silenceUI(self):
685
"""Turn off UI for duration of test"""
686
# by default the UI is off; tests can turn it on if they want it.
687
saved = ui.ui_factory
689
ui.ui_factory = saved
690
ui.ui_factory = ui.SilentUIFactory()
691
self.addCleanup(_restore)
693
def _ndiff_strings(self, a, b):
694
"""Return ndiff between two strings containing lines.
696
A trailing newline is added if missing to make the strings
698
if b and b[-1] != '\n':
700
if a and a[-1] != '\n':
702
difflines = difflib.ndiff(a.splitlines(True),
704
linejunk=lambda x: False,
705
charjunk=lambda x: False)
706
return ''.join(difflines)
708
def assertEqual(self, a, b, message=''):
713
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
715
pformat(a, indent=4), pformat(b, indent=4)))
717
assertEquals = assertEqual
719
def assertEqualDiff(self, a, b, message=None):
720
"""Assert two texts are equal, if not raise an exception.
722
This is intended for use with multi-line strings where it can
723
be hard to find the differences by eye.
725
# TODO: perhaps override assertEquals to call this for strings?
729
message = "texts not equal:\n"
730
raise AssertionError(message +
731
self._ndiff_strings(a, b))
733
def assertEqualMode(self, mode, mode_test):
734
self.assertEqual(mode, mode_test,
735
'mode mismatch %o != %o' % (mode, mode_test))
737
def assertStartsWith(self, s, prefix):
738
if not s.startswith(prefix):
739
raise AssertionError('string %r does not start with %r' % (s, prefix))
741
def assertEndsWith(self, s, suffix):
742
"""Asserts that s ends with suffix."""
743
if not s.endswith(suffix):
744
raise AssertionError('string %r does not end with %r' % (s, suffix))
746
def assertContainsRe(self, haystack, needle_re):
747
"""Assert that a contains something matching a regular expression."""
748
if not re.search(needle_re, haystack):
749
raise AssertionError('pattern "%r" not found in "%r"'
750
% (needle_re, haystack))
752
def assertNotContainsRe(self, haystack, needle_re):
753
"""Assert that a does not match a regular expression"""
754
if re.search(needle_re, haystack):
755
raise AssertionError('pattern "%s" found in "%s"'
756
% (needle_re, haystack))
758
def assertSubset(self, sublist, superlist):
759
"""Assert that every entry in sublist is present in superlist."""
761
for entry in sublist:
762
if entry not in superlist:
763
missing.append(entry)
765
raise AssertionError("value(s) %r not present in container %r" %
766
(missing, superlist))
768
def assertListRaises(self, excClass, func, *args, **kwargs):
769
"""Fail unless excClass is raised when the iterator from func is used.
771
Many functions can return generators this makes sure
772
to wrap them in a list() call to make sure the whole generator
773
is run, and that the proper exception is raised.
776
list(func(*args, **kwargs))
780
if getattr(excClass,'__name__', None) is not None:
781
excName = excClass.__name__
783
excName = str(excClass)
784
raise self.failureException, "%s not raised" % excName
786
def assertIs(self, left, right, message=None):
787
if not (left is right):
788
if message is not None:
789
raise AssertionError(message)
791
raise AssertionError("%r is not %r." % (left, right))
793
def assertIsNot(self, left, right, message=None):
795
if message is not None:
796
raise AssertionError(message)
798
raise AssertionError("%r is %r." % (left, right))
800
def assertTransportMode(self, transport, path, mode):
801
"""Fail if a path does not have mode mode.
803
If modes are not supported on this transport, the assertion is ignored.
805
if not transport._can_roundtrip_unix_modebits():
807
path_stat = transport.stat(path)
808
actual_mode = stat.S_IMODE(path_stat.st_mode)
809
self.assertEqual(mode, actual_mode,
810
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
812
def assertIsInstance(self, obj, kls):
813
"""Fail if obj is not an instance of kls"""
814
if not isinstance(obj, kls):
815
self.fail("%r is an instance of %s rather than %s" % (
816
obj, obj.__class__, kls))
818
def _capture_warnings(self, a_callable, *args, **kwargs):
819
"""A helper for callDeprecated and applyDeprecated.
821
:param a_callable: A callable to call.
822
:param args: The positional arguments for the callable
823
:param kwargs: The keyword arguments for the callable
824
:return: A tuple (warnings, result). result is the result of calling
825
a_callable(*args, **kwargs).
828
def capture_warnings(msg, cls=None, stacklevel=None):
829
# we've hooked into a deprecation specific callpath,
830
# only deprecations should getting sent via it.
831
self.assertEqual(cls, DeprecationWarning)
832
local_warnings.append(msg)
833
original_warning_method = symbol_versioning.warn
834
symbol_versioning.set_warning_method(capture_warnings)
836
result = a_callable(*args, **kwargs)
838
symbol_versioning.set_warning_method(original_warning_method)
839
return (local_warnings, result)
841
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
842
"""Call a deprecated callable without warning the user.
844
:param deprecation_format: The deprecation format that the callable
845
should have been deprecated with. This is the same type as the
846
parameter to deprecated_method/deprecated_function. If the
847
callable is not deprecated with this format, an assertion error
849
:param a_callable: A callable to call. This may be a bound method or
850
a regular function. It will be called with *args and **kwargs.
851
:param args: The positional arguments for the callable
852
:param kwargs: The keyword arguments for the callable
853
:return: The result of a_callable(*args, **kwargs)
855
call_warnings, result = self._capture_warnings(a_callable,
857
expected_first_warning = symbol_versioning.deprecation_string(
858
a_callable, deprecation_format)
859
if len(call_warnings) == 0:
860
self.fail("No deprecation warning generated by call to %s" %
862
self.assertEqual(expected_first_warning, call_warnings[0])
865
def callDeprecated(self, expected, callable, *args, **kwargs):
866
"""Assert that a callable is deprecated in a particular way.
868
This is a very precise test for unusual requirements. The
869
applyDeprecated helper function is probably more suited for most tests
870
as it allows you to simply specify the deprecation format being used
871
and will ensure that that is issued for the function being called.
873
:param expected: a list of the deprecation warnings expected, in order
874
:param callable: The callable to call
875
:param args: The positional arguments for the callable
876
:param kwargs: The keyword arguments for the callable
878
call_warnings, result = self._capture_warnings(callable,
880
self.assertEqual(expected, call_warnings)
883
def _startLogFile(self):
884
"""Send bzr and test log messages to a temporary file.
886
The file is removed as the test is torn down.
888
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
889
self._log_file = os.fdopen(fileno, 'w+')
890
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
891
self._log_file_name = name
892
self.addCleanup(self._finishLogFile)
894
def _finishLogFile(self):
895
"""Finished with the log file.
897
Close the file and delete it, unless setKeepLogfile was called.
899
if self._log_file is None:
901
bzrlib.trace.disable_test_log(self._log_nonce)
902
self._log_file.close()
903
self._log_file = None
904
if not self._keep_log_file:
905
os.remove(self._log_file_name)
906
self._log_file_name = None
908
def setKeepLogfile(self):
909
"""Make the logfile not be deleted when _finishLogFile is called."""
910
self._keep_log_file = True
912
def addCleanup(self, callable):
913
"""Arrange to run a callable when this case is torn down.
915
Callables are run in the reverse of the order they are registered,
916
ie last-in first-out.
918
if callable in self._cleanups:
919
raise ValueError("cleanup function %r already registered on %s"
921
self._cleanups.append(callable)
923
def _cleanEnvironment(self):
925
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
927
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
929
'BZREMAIL': None, # may still be present in the environment
931
'BZR_PROGRESS_BAR': None,
941
# Nobody cares about these ones AFAIK. So far at
942
# least. If you do (care), please update this comment
948
self.addCleanup(self._restoreEnvironment)
949
for name, value in new_env.iteritems():
950
self._captureVar(name, value)
952
def _captureVar(self, name, newvalue):
953
"""Set an environment variable, and reset it when finished."""
954
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
956
def _restoreEnvironment(self):
957
for name, value in self.__old_env.iteritems():
958
osutils.set_or_unset_env(name, value)
960
def _restoreHooks(self):
961
bzrlib.branch.Branch.hooks = self._preserved_hooks
965
unittest.TestCase.tearDown(self)
967
def time(self, callable, *args, **kwargs):
968
"""Run callable and accrue the time it takes to the benchmark time.
970
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
971
this will cause lsprofile statistics to be gathered and stored in
974
if self._benchtime is None:
978
if not self._gather_lsprof_in_benchmarks:
979
return callable(*args, **kwargs)
981
# record this benchmark
982
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
984
self._benchcalls.append(((callable, args, kwargs), stats))
987
self._benchtime += time.time() - start
989
def _runCleanups(self):
990
"""Run registered cleanup functions.
992
This should only be called from TestCase.tearDown.
994
# TODO: Perhaps this should keep running cleanups even if
997
# Actually pop the cleanups from the list so tearDown running
998
# twice is safe (this happens for skipped tests).
999
while self._cleanups:
1000
self._cleanups.pop()()
1002
def log(self, *args):
1005
def _get_log(self, keep_log_file=False):
1006
"""Return as a string the log for this test. If the file is still
1007
on disk and keep_log_file=False, delete the log file and store the
1008
content in self._log_contents."""
1009
# flush the log file, to get all content
1011
bzrlib.trace._trace_file.flush()
1012
if self._log_contents:
1013
return self._log_contents
1014
if self._log_file_name is not None:
1015
logfile = open(self._log_file_name)
1017
log_contents = logfile.read()
1020
if not keep_log_file:
1021
self._log_contents = log_contents
1023
os.remove(self._log_file_name)
1025
if sys.platform == 'win32' and e.errno == errno.EACCES:
1026
print >>sys.stderr, ('Unable to delete log file '
1027
' %r' % self._log_file_name)
1032
return "DELETED log file to reduce memory footprint"
1034
def capture(self, cmd, retcode=0):
1035
"""Shortcut that splits cmd into words, runs, and returns stdout"""
1036
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
1038
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
1040
"""Invoke bzr and return (stdout, stderr).
1042
Useful for code that wants to check the contents of the
1043
output, the way error messages are presented, etc.
1045
This should be the main method for tests that want to exercise the
1046
overall behavior of the bzr application (rather than a unit test
1047
or a functional test of the library.)
1049
Much of the old code runs bzr by forking a new copy of Python, but
1050
that is slower, harder to debug, and generally not necessary.
1052
This runs bzr through the interface that catches and reports
1053
errors, and with logging set to something approximating the
1054
default, so that error reporting can be checked.
1056
:param argv: arguments to invoke bzr
1057
:param retcode: expected return code, or None for don't-care.
1058
:param encoding: encoding for sys.stdout and sys.stderr
1059
:param stdin: A string to be used as stdin for the command.
1060
:param working_dir: Change to this directory before running
1062
if encoding is None:
1063
encoding = bzrlib.user_encoding
1064
stdout = StringIOWrapper()
1065
stderr = StringIOWrapper()
1066
stdout.encoding = encoding
1067
stderr.encoding = encoding
1069
self.log('run bzr: %r', argv)
1070
# FIXME: don't call into logging here
1071
handler = logging.StreamHandler(stderr)
1072
handler.setLevel(logging.INFO)
1073
logger = logging.getLogger('')
1074
logger.addHandler(handler)
1075
old_ui_factory = ui.ui_factory
1076
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1079
if working_dir is not None:
1080
cwd = osutils.getcwd()
1081
os.chdir(working_dir)
1084
saved_debug_flags = frozenset(debug.debug_flags)
1085
debug.debug_flags.clear()
1087
result = self.apply_redirected(ui.ui_factory.stdin,
1089
bzrlib.commands.run_bzr_catch_errors,
1092
debug.debug_flags.update(saved_debug_flags)
1094
logger.removeHandler(handler)
1095
ui.ui_factory = old_ui_factory
1099
out = stdout.getvalue()
1100
err = stderr.getvalue()
1102
self.log('output:\n%r', out)
1104
self.log('errors:\n%r', err)
1105
if retcode is not None:
1106
self.assertEquals(retcode, result)
1109
def run_bzr(self, *args, **kwargs):
1110
"""Invoke bzr, as if it were run from the command line.
1112
This should be the main method for tests that want to exercise the
1113
overall behavior of the bzr application (rather than a unit test
1114
or a functional test of the library.)
1116
This sends the stdout/stderr results into the test's log,
1117
where it may be useful for debugging. See also run_captured.
1119
:param stdin: A string to be used as stdin for the command.
1120
:param retcode: The status code the command should return
1121
:param working_dir: The directory to run the command in
1123
retcode = kwargs.pop('retcode', 0)
1124
encoding = kwargs.pop('encoding', None)
1125
stdin = kwargs.pop('stdin', None)
1126
working_dir = kwargs.pop('working_dir', None)
1127
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding,
1128
stdin=stdin, working_dir=working_dir)
1130
def run_bzr_decode(self, *args, **kwargs):
1131
if 'encoding' in kwargs:
1132
encoding = kwargs['encoding']
1134
encoding = bzrlib.user_encoding
1135
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1137
def run_bzr_error(self, error_regexes, *args, **kwargs):
1138
"""Run bzr, and check that stderr contains the supplied regexes
1140
:param error_regexes: Sequence of regular expressions which
1141
must each be found in the error output. The relative ordering
1143
:param args: command-line arguments for bzr
1144
:param kwargs: Keyword arguments which are interpreted by run_bzr
1145
This function changes the default value of retcode to be 3,
1146
since in most cases this is run when you expect bzr to fail.
1147
:return: (out, err) The actual output of running the command (in case you
1148
want to do more inspection)
1151
# Make sure that commit is failing because there is nothing to do
1152
self.run_bzr_error(['no changes to commit'],
1153
'commit', '-m', 'my commit comment')
1154
# Make sure --strict is handling an unknown file, rather than
1155
# giving us the 'nothing to do' error
1156
self.build_tree(['unknown'])
1157
self.run_bzr_error(['Commit refused because there are unknown files'],
1158
'commit', '--strict', '-m', 'my commit comment')
1160
kwargs.setdefault('retcode', 3)
1161
out, err = self.run_bzr(*args, **kwargs)
1162
for regex in error_regexes:
1163
self.assertContainsRe(err, regex)
1166
def run_bzr_subprocess(self, *args, **kwargs):
1167
"""Run bzr in a subprocess for testing.
1169
This starts a new Python interpreter and runs bzr in there.
1170
This should only be used for tests that have a justifiable need for
1171
this isolation: e.g. they are testing startup time, or signal
1172
handling, or early startup code, etc. Subprocess code can't be
1173
profiled or debugged so easily.
1175
:param retcode: The status code that is expected. Defaults to 0. If
1176
None is supplied, the status code is not checked.
1177
:param env_changes: A dictionary which lists changes to environment
1178
variables. A value of None will unset the env variable.
1179
The values must be strings. The change will only occur in the
1180
child, so you don't need to fix the environment after running.
1181
:param universal_newlines: Convert CRLF => LF
1182
:param allow_plugins: By default the subprocess is run with
1183
--no-plugins to ensure test reproducibility. Also, it is possible
1184
for system-wide plugins to create unexpected output on stderr,
1185
which can cause unnecessary test failures.
1187
env_changes = kwargs.get('env_changes', {})
1188
working_dir = kwargs.get('working_dir', None)
1189
allow_plugins = kwargs.get('allow_plugins', False)
1190
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1191
working_dir=working_dir,
1192
allow_plugins=allow_plugins)
1193
# We distinguish between retcode=None and retcode not passed.
1194
supplied_retcode = kwargs.get('retcode', 0)
1195
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1196
universal_newlines=kwargs.get('universal_newlines', False),
1199
def start_bzr_subprocess(self, process_args, env_changes=None,
1200
skip_if_plan_to_signal=False,
1202
allow_plugins=False):
1203
"""Start bzr in a subprocess for testing.
1205
This starts a new Python interpreter and runs bzr in there.
1206
This should only be used for tests that have a justifiable need for
1207
this isolation: e.g. they are testing startup time, or signal
1208
handling, or early startup code, etc. Subprocess code can't be
1209
profiled or debugged so easily.
1211
:param process_args: a list of arguments to pass to the bzr executable,
1212
for example `['--version']`.
1213
:param env_changes: A dictionary which lists changes to environment
1214
variables. A value of None will unset the env variable.
1215
The values must be strings. The change will only occur in the
1216
child, so you don't need to fix the environment after running.
1217
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1219
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1221
:returns: Popen object for the started process.
1223
if skip_if_plan_to_signal:
1224
if not getattr(os, 'kill', None):
1225
raise TestSkipped("os.kill not available.")
1227
if env_changes is None:
1231
def cleanup_environment():
1232
for env_var, value in env_changes.iteritems():
1233
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1235
def restore_environment():
1236
for env_var, value in old_env.iteritems():
1237
osutils.set_or_unset_env(env_var, value)
1239
bzr_path = self.get_bzr_path()
1242
if working_dir is not None:
1243
cwd = osutils.getcwd()
1244
os.chdir(working_dir)
1247
# win32 subprocess doesn't support preexec_fn
1248
# so we will avoid using it on all platforms, just to
1249
# make sure the code path is used, and we don't break on win32
1250
cleanup_environment()
1251
command = [sys.executable, bzr_path]
1252
if not allow_plugins:
1253
command.append('--no-plugins')
1254
command.extend(process_args)
1255
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1257
restore_environment()
1263
def _popen(self, *args, **kwargs):
1264
"""Place a call to Popen.
1266
Allows tests to override this method to intercept the calls made to
1267
Popen for introspection.
1269
return Popen(*args, **kwargs)
1271
def get_bzr_path(self):
1272
"""Return the path of the 'bzr' executable for this test suite."""
1273
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1274
if not os.path.isfile(bzr_path):
1275
# We are probably installed. Assume sys.argv is the right file
1276
bzr_path = sys.argv[0]
1279
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1280
universal_newlines=False, process_args=None):
1281
"""Finish the execution of process.
1283
:param process: the Popen object returned from start_bzr_subprocess.
1284
:param retcode: The status code that is expected. Defaults to 0. If
1285
None is supplied, the status code is not checked.
1286
:param send_signal: an optional signal to send to the process.
1287
:param universal_newlines: Convert CRLF => LF
1288
:returns: (stdout, stderr)
1290
if send_signal is not None:
1291
os.kill(process.pid, send_signal)
1292
out, err = process.communicate()
1294
if universal_newlines:
1295
out = out.replace('\r\n', '\n')
1296
err = err.replace('\r\n', '\n')
1298
if retcode is not None and retcode != process.returncode:
1299
if process_args is None:
1300
process_args = "(unknown args)"
1301
mutter('Output of bzr %s:\n%s', process_args, out)
1302
mutter('Error for bzr %s:\n%s', process_args, err)
1303
self.fail('Command bzr %s failed with retcode %s != %s'
1304
% (process_args, retcode, process.returncode))
1307
def check_inventory_shape(self, inv, shape):
1308
"""Compare an inventory to a list of expected names.
1310
Fail if they are not precisely equal.
1313
shape = list(shape) # copy
1314
for path, ie in inv.entries():
1315
name = path.replace('\\', '/')
1316
if ie.kind == 'dir':
1323
self.fail("expected paths not found in inventory: %r" % shape)
1325
self.fail("unexpected paths found in inventory: %r" % extras)
1327
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1328
a_callable=None, *args, **kwargs):
1329
"""Call callable with redirected std io pipes.
1331
Returns the return code."""
1332
if not callable(a_callable):
1333
raise ValueError("a_callable must be callable.")
1335
stdin = StringIO("")
1337
if getattr(self, "_log_file", None) is not None:
1338
stdout = self._log_file
1342
if getattr(self, "_log_file", None is not None):
1343
stderr = self._log_file
1346
real_stdin = sys.stdin
1347
real_stdout = sys.stdout
1348
real_stderr = sys.stderr
1353
return a_callable(*args, **kwargs)
1355
sys.stdout = real_stdout
1356
sys.stderr = real_stderr
1357
sys.stdin = real_stdin
1359
@symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
1360
def merge(self, branch_from, wt_to):
1361
"""A helper for tests to do a ui-less merge.
1363
This should move to the main library when someone has time to integrate
1366
# minimal ui-less merge.
1367
wt_to.branch.fetch(branch_from)
1368
base_rev = common_ancestor(branch_from.last_revision(),
1369
wt_to.branch.last_revision(),
1370
wt_to.branch.repository)
1371
merge_inner(wt_to.branch, branch_from.basis_tree(),
1372
wt_to.branch.repository.revision_tree(base_rev),
1374
wt_to.add_parent_tree_id(branch_from.last_revision())
1377
BzrTestBase = TestCase
1380
class TestCaseWithMemoryTransport(TestCase):
1381
"""Common test class for tests that do not need disk resources.
1383
Tests that need disk resources should derive from TestCaseWithTransport.
1385
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1387
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1388
a directory which does not exist. This serves to help ensure test isolation
1389
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1390
must exist. However, TestCaseWithMemoryTransport does not offer local
1391
file defaults for the transport in tests, nor does it obey the command line
1392
override, so tests that accidentally write to the common directory should
1400
def __init__(self, methodName='runTest'):
1401
# allow test parameterisation after test construction and before test
1402
# execution. Variables that the parameteriser sets need to be
1403
# ones that are not set by setUp, or setUp will trash them.
1404
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1405
self.transport_server = default_transport
1406
self.transport_readonly_server = None
1408
def get_transport(self):
1409
"""Return a writeable transport for the test scratch space"""
1410
t = get_transport(self.get_url())
1411
self.assertFalse(t.is_readonly())
1414
def get_readonly_transport(self):
1415
"""Return a readonly transport for the test scratch space
1417
This can be used to test that operations which should only need
1418
readonly access in fact do not try to write.
1420
t = get_transport(self.get_readonly_url())
1421
self.assertTrue(t.is_readonly())
1424
def create_transport_readonly_server(self):
1425
"""Create a transport server from class defined at init.
1427
This is mostly a hook for daughter classes.
1429
return self.transport_readonly_server()
1431
def get_readonly_server(self):
1432
"""Get the server instance for the readonly transport
1434
This is useful for some tests with specific servers to do diagnostics.
1436
if self.__readonly_server is None:
1437
if self.transport_readonly_server is None:
1438
# readonly decorator requested
1439
# bring up the server
1441
self.__readonly_server = ReadonlyServer()
1442
self.__readonly_server.setUp(self.__server)
1444
self.__readonly_server = self.create_transport_readonly_server()
1445
self.__readonly_server.setUp()
1446
self.addCleanup(self.__readonly_server.tearDown)
1447
return self.__readonly_server
1449
def get_readonly_url(self, relpath=None):
1450
"""Get a URL for the readonly transport.
1452
This will either be backed by '.' or a decorator to the transport
1453
used by self.get_url()
1454
relpath provides for clients to get a path relative to the base url.
1455
These should only be downwards relative, not upwards.
1457
base = self.get_readonly_server().get_url()
1458
if relpath is not None:
1459
if not base.endswith('/'):
1461
base = base + relpath
1464
def get_server(self):
1465
"""Get the read/write server instance.
1467
This is useful for some tests with specific servers that need
1470
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1471
is no means to override it.
1473
if self.__server is None:
1474
self.__server = MemoryServer()
1475
self.__server.setUp()
1476
self.addCleanup(self.__server.tearDown)
1477
return self.__server
1479
def get_url(self, relpath=None):
1480
"""Get a URL (or maybe a path) for the readwrite transport.
1482
This will either be backed by '.' or to an equivalent non-file based
1484
relpath provides for clients to get a path relative to the base url.
1485
These should only be downwards relative, not upwards.
1487
base = self.get_server().get_url()
1488
if relpath is not None and relpath != '.':
1489
if not base.endswith('/'):
1491
# XXX: Really base should be a url; we did after all call
1492
# get_url()! But sometimes it's just a path (from
1493
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1494
# to a non-escaped local path.
1495
if base.startswith('./') or base.startswith('/'):
1498
base += urlutils.escape(relpath)
1501
def _make_test_root(self):
1502
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1506
root = u'test%04d.tmp' % i
1510
if e.errno == errno.EEXIST:
1515
# successfully created
1516
TestCaseWithMemoryTransport.TEST_ROOT = osutils.abspath(root)
1518
# make a fake bzr directory there to prevent any tests propagating
1519
# up onto the source directory's real branch
1520
bzrdir.BzrDir.create_standalone_workingtree(
1521
TestCaseWithMemoryTransport.TEST_ROOT)
1523
def makeAndChdirToTestDir(self):
1524
"""Create a temporary directories for this one test.
1526
This must set self.test_home_dir and self.test_dir and chdir to
1529
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1531
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1532
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1533
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1535
def make_branch(self, relpath, format=None):
1536
"""Create a branch on the transport at relpath."""
1537
repo = self.make_repository(relpath, format=format)
1538
return repo.bzrdir.create_branch()
1540
def make_bzrdir(self, relpath, format=None):
1542
# might be a relative or absolute path
1543
maybe_a_url = self.get_url(relpath)
1544
segments = maybe_a_url.rsplit('/', 1)
1545
t = get_transport(maybe_a_url)
1546
if len(segments) > 1 and segments[-1] not in ('', '.'):
1549
except errors.FileExists:
1553
if isinstance(format, basestring):
1554
format = bzrdir.format_registry.make_bzrdir(format)
1555
return format.initialize_on_transport(t)
1556
except errors.UninitializableFormat:
1557
raise TestSkipped("Format %s is not initializable." % format)
1559
def make_repository(self, relpath, shared=False, format=None):
1560
"""Create a repository on our default transport at relpath."""
1561
made_control = self.make_bzrdir(relpath, format=format)
1562
return made_control.create_repository(shared=shared)
1564
def make_branch_and_memory_tree(self, relpath, format=None):
1565
"""Create a branch on the default transport and a MemoryTree for it."""
1566
b = self.make_branch(relpath, format=format)
1567
return memorytree.MemoryTree.create_on_branch(b)
1569
def overrideEnvironmentForTesting(self):
1570
os.environ['HOME'] = self.test_home_dir
1571
os.environ['BZR_HOME'] = self.test_home_dir
1574
super(TestCaseWithMemoryTransport, self).setUp()
1575
self._make_test_root()
1576
_currentdir = os.getcwdu()
1577
def _leaveDirectory():
1578
os.chdir(_currentdir)
1579
self.addCleanup(_leaveDirectory)
1580
self.makeAndChdirToTestDir()
1581
self.overrideEnvironmentForTesting()
1582
self.__readonly_server = None
1583
self.__server = None
1586
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1587
"""Derived class that runs a test within a temporary directory.
1589
This is useful for tests that need to create a branch, etc.
1591
The directory is created in a slightly complex way: for each
1592
Python invocation, a new temporary top-level directory is created.
1593
All test cases create their own directory within that. If the
1594
tests complete successfully, the directory is removed.
1596
InTempDir is an old alias for FunctionalTestCase.
1599
OVERRIDE_PYTHON = 'python'
1601
def check_file_contents(self, filename, expect):
1602
self.log("check contents of file %s" % filename)
1603
contents = file(filename, 'r').read()
1604
if contents != expect:
1605
self.log("expected: %r" % expect)
1606
self.log("actually: %r" % contents)
1607
self.fail("contents of %s not as expected" % filename)
1609
def makeAndChdirToTestDir(self):
1610
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1612
For TestCaseInTempDir we create a temporary directory based on the test
1613
name and then create two subdirs - test and home under it.
1615
if NUMBERED_DIRS: # strongly recommended on Windows
1616
# due the path length limitation (260 chars)
1617
candidate_dir = '%s/%dK/%05d' % (self.TEST_ROOT,
1618
int(self.number/1000),
1620
os.makedirs(candidate_dir)
1621
self.test_home_dir = candidate_dir + '/home'
1622
os.mkdir(self.test_home_dir)
1623
self.test_dir = candidate_dir + '/work'
1624
os.mkdir(self.test_dir)
1625
os.chdir(self.test_dir)
1626
# put name of test inside
1627
f = file(candidate_dir + '/name', 'w')
1632
# shorten the name, to avoid test failures due to path length
1633
short_id = self.id().replace('bzrlib.tests.', '') \
1634
.replace('__main__.', '')[-100:]
1635
# it's possible the same test class is run several times for
1636
# parameterized tests, so make sure the names don't collide.
1640
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1642
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1643
if os.path.exists(candidate_dir):
1647
os.mkdir(candidate_dir)
1648
self.test_home_dir = candidate_dir + '/home'
1649
os.mkdir(self.test_home_dir)
1650
self.test_dir = candidate_dir + '/work'
1651
os.mkdir(self.test_dir)
1652
os.chdir(self.test_dir)
1655
def build_tree(self, shape, line_endings='binary', transport=None):
1656
"""Build a test tree according to a pattern.
1658
shape is a sequence of file specifications. If the final
1659
character is '/', a directory is created.
1661
This assumes that all the elements in the tree being built are new.
1663
This doesn't add anything to a branch.
1664
:param line_endings: Either 'binary' or 'native'
1665
in binary mode, exact contents are written
1666
in native mode, the line endings match the
1667
default platform endings.
1669
:param transport: A transport to write to, for building trees on
1670
VFS's. If the transport is readonly or None,
1671
"." is opened automatically.
1673
# It's OK to just create them using forward slashes on windows.
1674
if transport is None or transport.is_readonly():
1675
transport = get_transport(".")
1677
self.assert_(isinstance(name, basestring))
1679
transport.mkdir(urlutils.escape(name[:-1]))
1681
if line_endings == 'binary':
1683
elif line_endings == 'native':
1686
raise errors.BzrError(
1687
'Invalid line ending request %r' % line_endings)
1688
content = "contents of %s%s" % (name.encode('utf-8'), end)
1689
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1691
def build_tree_contents(self, shape):
1692
build_tree_contents(shape)
1694
def assertFileEqual(self, content, path):
1695
"""Fail if path does not contain 'content'."""
1696
self.failUnlessExists(path)
1697
# TODO: jam 20060427 Shouldn't this be 'rb'?
1698
self.assertEqualDiff(content, open(path, 'r').read())
1700
def failUnlessExists(self, path):
1701
"""Fail unless path, which may be abs or relative, exists."""
1702
self.failUnless(osutils.lexists(path),path+" does not exist")
1704
def failIfExists(self, path):
1705
"""Fail if path, which may be abs or relative, exists."""
1706
self.failIf(osutils.lexists(path),path+" exists")
1709
class TestCaseWithTransport(TestCaseInTempDir):
1710
"""A test case that provides get_url and get_readonly_url facilities.
1712
These back onto two transport servers, one for readonly access and one for
1715
If no explicit class is provided for readonly access, a
1716
ReadonlyTransportDecorator is used instead which allows the use of non disk
1717
based read write transports.
1719
If an explicit class is provided for readonly access, that server and the
1720
readwrite one must both define get_url() as resolving to os.getcwd().
1723
def create_transport_server(self):
1724
"""Create a transport server from class defined at init.
1726
This is mostly a hook for daughter classes.
1728
return self.transport_server()
1730
def get_server(self):
1731
"""See TestCaseWithMemoryTransport.
1733
This is useful for some tests with specific servers that need
1736
if self.__server is None:
1737
self.__server = self.create_transport_server()
1738
self.__server.setUp()
1739
self.addCleanup(self.__server.tearDown)
1740
return self.__server
1742
def make_branch_and_tree(self, relpath, format=None):
1743
"""Create a branch on the transport and a tree locally.
1745
If the transport is not a LocalTransport, the Tree can't be created on
1746
the transport. In that case the working tree is created in the local
1747
directory, and the returned tree's branch and repository will also be
1750
This will fail if the original default transport for this test
1751
case wasn't backed by the working directory, as the branch won't
1752
be on disk for us to open it.
1754
:param format: The BzrDirFormat.
1755
:returns: the WorkingTree.
1757
# TODO: always use the local disk path for the working tree,
1758
# this obviously requires a format that supports branch references
1759
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1761
b = self.make_branch(relpath, format=format)
1763
return b.bzrdir.create_workingtree()
1764
except errors.NotLocalUrl:
1765
# We can only make working trees locally at the moment. If the
1766
# transport can't support them, then reopen the branch on a local
1767
# transport, and create the working tree there.
1769
# Possibly we should instead keep
1770
# the non-disk-backed branch and create a local checkout?
1771
bd = bzrdir.BzrDir.open(relpath)
1772
return bd.create_workingtree()
1774
def assertIsDirectory(self, relpath, transport):
1775
"""Assert that relpath within transport is a directory.
1777
This may not be possible on all transports; in that case it propagates
1778
a TransportNotPossible.
1781
mode = transport.stat(relpath).st_mode
1782
except errors.NoSuchFile:
1783
self.fail("path %s is not a directory; no such file"
1785
if not stat.S_ISDIR(mode):
1786
self.fail("path %s is not a directory; has mode %#o"
1789
def assertTreesEqual(self, left, right):
1790
"""Check that left and right have the same content and properties."""
1791
# we use a tree delta to check for equality of the content, and we
1792
# manually check for equality of other things such as the parents list.
1793
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
1794
differences = left.changes_from(right)
1795
self.assertFalse(differences.has_changed(),
1796
"Trees %r and %r are different: %r" % (left, right, differences))
1799
super(TestCaseWithTransport, self).setUp()
1800
self.__server = None
1803
class ChrootedTestCase(TestCaseWithTransport):
1804
"""A support class that provides readonly urls outside the local namespace.
1806
This is done by checking if self.transport_server is a MemoryServer. if it
1807
is then we are chrooted already, if it is not then an HttpServer is used
1810
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1811
be used without needed to redo it when a different
1812
subclass is in use ?
1816
super(ChrootedTestCase, self).setUp()
1817
if not self.transport_server == MemoryServer:
1818
self.transport_readonly_server = HttpServer
1821
def filter_suite_by_re(suite, pattern):
1822
result = TestUtil.TestSuite()
1823
filter_re = re.compile(pattern)
1824
for test in iter_suite_tests(suite):
1825
if filter_re.search(test.id()):
1826
result.addTest(test)
1830
def sort_suite_by_re(suite, pattern):
1833
filter_re = re.compile(pattern)
1834
for test in iter_suite_tests(suite):
1835
if filter_re.search(test.id()):
1839
return TestUtil.TestSuite(first + second)
1842
def run_suite(suite, name='test', verbose=False, pattern=".*",
1843
stop_on_failure=False, keep_output=False,
1844
transport=None, lsprof_timed=None, bench_history=None,
1845
matching_tests_first=None,
1846
numbered_dirs=None):
1847
global NUMBERED_DIRS
1848
if numbered_dirs is not None:
1849
NUMBERED_DIRS = bool(numbered_dirs)
1851
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1856
runner = TextTestRunner(stream=sys.stdout,
1858
verbosity=verbosity,
1859
keep_output=keep_output,
1860
bench_history=bench_history)
1861
runner.stop_on_failure=stop_on_failure
1863
if matching_tests_first:
1864
suite = sort_suite_by_re(suite, pattern)
1866
suite = filter_suite_by_re(suite, pattern)
1867
result = runner.run(suite)
1868
return result.wasSuccessful()
1871
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1874
test_suite_factory=None,
1877
matching_tests_first=None,
1878
numbered_dirs=None):
1879
"""Run the whole test suite under the enhanced runner"""
1880
# XXX: Very ugly way to do this...
1881
# Disable warning about old formats because we don't want it to disturb
1882
# any blackbox tests.
1883
from bzrlib import repository
1884
repository._deprecation_warning_done = True
1886
global default_transport
1887
if transport is None:
1888
transport = default_transport
1889
old_transport = default_transport
1890
default_transport = transport
1892
if test_suite_factory is None:
1893
suite = test_suite()
1895
suite = test_suite_factory()
1896
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1897
stop_on_failure=stop_on_failure, keep_output=keep_output,
1898
transport=transport,
1899
lsprof_timed=lsprof_timed,
1900
bench_history=bench_history,
1901
matching_tests_first=matching_tests_first,
1902
numbered_dirs=numbered_dirs)
1904
default_transport = old_transport
1908
"""Build and return TestSuite for the whole of bzrlib.
1910
This function can be replaced if you need to change the default test
1911
suite on a global basis, but it is not encouraged.
1914
'bzrlib.tests.test_ancestry',
1915
'bzrlib.tests.test_annotate',
1916
'bzrlib.tests.test_api',
1917
'bzrlib.tests.test_atomicfile',
1918
'bzrlib.tests.test_bad_files',
1919
'bzrlib.tests.test_branch',
1920
'bzrlib.tests.test_bundle',
1921
'bzrlib.tests.test_bzrdir',
1922
'bzrlib.tests.test_cache_utf8',
1923
'bzrlib.tests.test_commands',
1924
'bzrlib.tests.test_commit',
1925
'bzrlib.tests.test_commit_merge',
1926
'bzrlib.tests.test_config',
1927
'bzrlib.tests.test_conflicts',
1928
'bzrlib.tests.test_decorators',
1929
'bzrlib.tests.test_delta',
1930
'bzrlib.tests.test_diff',
1931
'bzrlib.tests.test_dirstate',
1932
'bzrlib.tests.test_doc_generate',
1933
'bzrlib.tests.test_errors',
1934
'bzrlib.tests.test_escaped_store',
1935
'bzrlib.tests.test_extract',
1936
'bzrlib.tests.test_fetch',
1937
'bzrlib.tests.test_ftp_transport',
1938
'bzrlib.tests.test_generate_docs',
1939
'bzrlib.tests.test_generate_ids',
1940
'bzrlib.tests.test_globbing',
1941
'bzrlib.tests.test_gpg',
1942
'bzrlib.tests.test_graph',
1943
'bzrlib.tests.test_hashcache',
1944
'bzrlib.tests.test_http',
1945
'bzrlib.tests.test_http_response',
1946
'bzrlib.tests.test_https_ca_bundle',
1947
'bzrlib.tests.test_identitymap',
1948
'bzrlib.tests.test_ignores',
1949
'bzrlib.tests.test_inv',
1950
'bzrlib.tests.test_knit',
1951
'bzrlib.tests.test_lazy_import',
1952
'bzrlib.tests.test_lazy_regex',
1953
'bzrlib.tests.test_lockdir',
1954
'bzrlib.tests.test_lockable_files',
1955
'bzrlib.tests.test_log',
1956
'bzrlib.tests.test_memorytree',
1957
'bzrlib.tests.test_merge',
1958
'bzrlib.tests.test_merge3',
1959
'bzrlib.tests.test_merge_core',
1960
'bzrlib.tests.test_merge_directive',
1961
'bzrlib.tests.test_missing',
1962
'bzrlib.tests.test_msgeditor',
1963
'bzrlib.tests.test_nonascii',
1964
'bzrlib.tests.test_options',
1965
'bzrlib.tests.test_osutils',
1966
'bzrlib.tests.test_osutils_encodings',
1967
'bzrlib.tests.test_patch',
1968
'bzrlib.tests.test_patches',
1969
'bzrlib.tests.test_permissions',
1970
'bzrlib.tests.test_plugins',
1971
'bzrlib.tests.test_progress',
1972
'bzrlib.tests.test_reconcile',
1973
'bzrlib.tests.test_registry',
1974
'bzrlib.tests.test_repository',
1975
'bzrlib.tests.test_revert',
1976
'bzrlib.tests.test_revision',
1977
'bzrlib.tests.test_revisionnamespaces',
1978
'bzrlib.tests.test_revisiontree',
1979
'bzrlib.tests.test_rio',
1980
'bzrlib.tests.test_sampler',
1981
'bzrlib.tests.test_selftest',
1982
'bzrlib.tests.test_setup',
1983
'bzrlib.tests.test_sftp_transport',
1984
'bzrlib.tests.test_smart_add',
1985
'bzrlib.tests.test_smart_transport',
1986
'bzrlib.tests.test_source',
1987
'bzrlib.tests.test_ssh_transport',
1988
'bzrlib.tests.test_status',
1989
'bzrlib.tests.test_store',
1990
'bzrlib.tests.test_subsume',
1991
'bzrlib.tests.test_symbol_versioning',
1992
'bzrlib.tests.test_tag',
1993
'bzrlib.tests.test_testament',
1994
'bzrlib.tests.test_textfile',
1995
'bzrlib.tests.test_textmerge',
1996
'bzrlib.tests.test_timestamp',
1997
'bzrlib.tests.test_trace',
1998
'bzrlib.tests.test_transactions',
1999
'bzrlib.tests.test_transform',
2000
'bzrlib.tests.test_transport',
2001
'bzrlib.tests.test_tree',
2002
'bzrlib.tests.test_treebuilder',
2003
'bzrlib.tests.test_tsort',
2004
'bzrlib.tests.test_tuned_gzip',
2005
'bzrlib.tests.test_ui',
2006
'bzrlib.tests.test_upgrade',
2007
'bzrlib.tests.test_urlutils',
2008
'bzrlib.tests.test_versionedfile',
2009
'bzrlib.tests.test_version',
2010
'bzrlib.tests.test_version_info',
2011
'bzrlib.tests.test_weave',
2012
'bzrlib.tests.test_whitebox',
2013
'bzrlib.tests.test_workingtree',
2014
'bzrlib.tests.test_workingtree_4',
2015
'bzrlib.tests.test_wsgi',
2016
'bzrlib.tests.test_xml',
2018
test_transport_implementations = [
2019
'bzrlib.tests.test_transport_implementations',
2020
'bzrlib.tests.test_read_bundle',
2022
suite = TestUtil.TestSuite()
2023
loader = TestUtil.TestLoader()
2024
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2025
from bzrlib.transport import TransportTestProviderAdapter
2026
adapter = TransportTestProviderAdapter()
2027
adapt_modules(test_transport_implementations, adapter, loader, suite)
2028
for package in packages_to_test():
2029
suite.addTest(package.test_suite())
2030
for m in MODULES_TO_TEST:
2031
suite.addTest(loader.loadTestsFromModule(m))
2032
for m in MODULES_TO_DOCTEST:
2034
suite.addTest(doctest.DocTestSuite(m))
2035
except ValueError, e:
2036
print '**failed to get doctest for: %s\n%s' %(m,e)
2038
for name, plugin in bzrlib.plugin.all_plugins().items():
2039
if getattr(plugin, 'test_suite', None) is not None:
2040
default_encoding = sys.getdefaultencoding()
2042
plugin_suite = plugin.test_suite()
2043
except ImportError, e:
2044
bzrlib.trace.warning(
2045
'Unable to test plugin "%s": %s', name, e)
2047
suite.addTest(plugin_suite)
2048
if default_encoding != sys.getdefaultencoding():
2049
bzrlib.trace.warning(
2050
'Plugin "%s" tried to reset default encoding to: %s', name,
2051
sys.getdefaultencoding())
2053
sys.setdefaultencoding(default_encoding)
2057
def adapt_modules(mods_list, adapter, loader, suite):
2058
"""Adapt the modules in mods_list using adapter and add to suite."""
2059
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2060
suite.addTests(adapter.adapt(test))
2063
def clean_selftest_output(root=None, quiet=False):
2064
"""Remove all selftest output directories from root directory.
2066
:param root: root directory for clean
2067
(if ommitted or None then clean current directory).
2068
:param quiet: suppress report about deleting directories
2073
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
2076
for i in os.listdir(root):
2077
if os.path.isdir(i) and re_dir.match(i):
2079
print 'delete directory:', i
added
removed
bzrlib/tests/__init__.py
