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
996
for cleanup_fn in reversed(self._cleanups):
999
def log(self, *args):
1002
def _get_log(self, keep_log_file=False):
1003
"""Return as a string the log for this test. If the file is still
1004
on disk and keep_log_file=False, delete the log file and store the
1005
content in self._log_contents."""
1006
# flush the log file, to get all content
1008
bzrlib.trace._trace_file.flush()
1009
if self._log_contents:
1010
return self._log_contents
1011
if self._log_file_name is not None:
1012
logfile = open(self._log_file_name)
1014
log_contents = logfile.read()
1017
if not keep_log_file:
1018
self._log_contents = log_contents
1020
os.remove(self._log_file_name)
1022
if sys.platform == 'win32' and e.errno == errno.EACCES:
1023
print >>sys.stderr, ('Unable to delete log file '
1024
' %r' % self._log_file_name)
1029
return "DELETED log file to reduce memory footprint"
1031
def capture(self, cmd, retcode=0):
1032
"""Shortcut that splits cmd into words, runs, and returns stdout"""
1033
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
1035
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
1037
"""Invoke bzr and return (stdout, stderr).
1039
Useful for code that wants to check the contents of the
1040
output, the way error messages are presented, etc.
1042
This should be the main method for tests that want to exercise the
1043
overall behavior of the bzr application (rather than a unit test
1044
or a functional test of the library.)
1046
Much of the old code runs bzr by forking a new copy of Python, but
1047
that is slower, harder to debug, and generally not necessary.
1049
This runs bzr through the interface that catches and reports
1050
errors, and with logging set to something approximating the
1051
default, so that error reporting can be checked.
1053
:param argv: arguments to invoke bzr
1054
:param retcode: expected return code, or None for don't-care.
1055
:param encoding: encoding for sys.stdout and sys.stderr
1056
:param stdin: A string to be used as stdin for the command.
1057
:param working_dir: Change to this directory before running
1059
if encoding is None:
1060
encoding = bzrlib.user_encoding
1061
stdout = StringIOWrapper()
1062
stderr = StringIOWrapper()
1063
stdout.encoding = encoding
1064
stderr.encoding = encoding
1066
self.log('run bzr: %r', argv)
1067
# FIXME: don't call into logging here
1068
handler = logging.StreamHandler(stderr)
1069
handler.setLevel(logging.INFO)
1070
logger = logging.getLogger('')
1071
logger.addHandler(handler)
1072
old_ui_factory = ui.ui_factory
1073
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1076
if working_dir is not None:
1077
cwd = osutils.getcwd()
1078
os.chdir(working_dir)
1081
saved_debug_flags = frozenset(debug.debug_flags)
1082
debug.debug_flags.clear()
1084
result = self.apply_redirected(ui.ui_factory.stdin,
1086
bzrlib.commands.run_bzr_catch_errors,
1089
debug.debug_flags.update(saved_debug_flags)
1091
logger.removeHandler(handler)
1092
ui.ui_factory = old_ui_factory
1096
out = stdout.getvalue()
1097
err = stderr.getvalue()
1099
self.log('output:\n%r', out)
1101
self.log('errors:\n%r', err)
1102
if retcode is not None:
1103
self.assertEquals(retcode, result)
1106
def run_bzr(self, *args, **kwargs):
1107
"""Invoke bzr, as if it were run from the command line.
1109
This should be the main method for tests that want to exercise the
1110
overall behavior of the bzr application (rather than a unit test
1111
or a functional test of the library.)
1113
This sends the stdout/stderr results into the test's log,
1114
where it may be useful for debugging. See also run_captured.
1116
:param stdin: A string to be used as stdin for the command.
1117
:param retcode: The status code the command should return
1118
:param working_dir: The directory to run the command in
1120
retcode = kwargs.pop('retcode', 0)
1121
encoding = kwargs.pop('encoding', None)
1122
stdin = kwargs.pop('stdin', None)
1123
working_dir = kwargs.pop('working_dir', None)
1124
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding,
1125
stdin=stdin, working_dir=working_dir)
1127
def run_bzr_decode(self, *args, **kwargs):
1128
if 'encoding' in kwargs:
1129
encoding = kwargs['encoding']
1131
encoding = bzrlib.user_encoding
1132
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1134
def run_bzr_error(self, error_regexes, *args, **kwargs):
1135
"""Run bzr, and check that stderr contains the supplied regexes
1137
:param error_regexes: Sequence of regular expressions which
1138
must each be found in the error output. The relative ordering
1140
:param args: command-line arguments for bzr
1141
:param kwargs: Keyword arguments which are interpreted by run_bzr
1142
This function changes the default value of retcode to be 3,
1143
since in most cases this is run when you expect bzr to fail.
1144
:return: (out, err) The actual output of running the command (in case you
1145
want to do more inspection)
1148
# Make sure that commit is failing because there is nothing to do
1149
self.run_bzr_error(['no changes to commit'],
1150
'commit', '-m', 'my commit comment')
1151
# Make sure --strict is handling an unknown file, rather than
1152
# giving us the 'nothing to do' error
1153
self.build_tree(['unknown'])
1154
self.run_bzr_error(['Commit refused because there are unknown files'],
1155
'commit', '--strict', '-m', 'my commit comment')
1157
kwargs.setdefault('retcode', 3)
1158
out, err = self.run_bzr(*args, **kwargs)
1159
for regex in error_regexes:
1160
self.assertContainsRe(err, regex)
1163
def run_bzr_subprocess(self, *args, **kwargs):
1164
"""Run bzr in a subprocess for testing.
1166
This starts a new Python interpreter and runs bzr in there.
1167
This should only be used for tests that have a justifiable need for
1168
this isolation: e.g. they are testing startup time, or signal
1169
handling, or early startup code, etc. Subprocess code can't be
1170
profiled or debugged so easily.
1172
:param retcode: The status code that is expected. Defaults to 0. If
1173
None is supplied, the status code is not checked.
1174
:param env_changes: A dictionary which lists changes to environment
1175
variables. A value of None will unset the env variable.
1176
The values must be strings. The change will only occur in the
1177
child, so you don't need to fix the environment after running.
1178
:param universal_newlines: Convert CRLF => LF
1179
:param allow_plugins: By default the subprocess is run with
1180
--no-plugins to ensure test reproducibility. Also, it is possible
1181
for system-wide plugins to create unexpected output on stderr,
1182
which can cause unnecessary test failures.
1184
env_changes = kwargs.get('env_changes', {})
1185
working_dir = kwargs.get('working_dir', None)
1186
allow_plugins = kwargs.get('allow_plugins', False)
1187
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1188
working_dir=working_dir,
1189
allow_plugins=allow_plugins)
1190
# We distinguish between retcode=None and retcode not passed.
1191
supplied_retcode = kwargs.get('retcode', 0)
1192
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1193
universal_newlines=kwargs.get('universal_newlines', False),
1196
def start_bzr_subprocess(self, process_args, env_changes=None,
1197
skip_if_plan_to_signal=False,
1199
allow_plugins=False):
1200
"""Start bzr in a subprocess for testing.
1202
This starts a new Python interpreter and runs bzr in there.
1203
This should only be used for tests that have a justifiable need for
1204
this isolation: e.g. they are testing startup time, or signal
1205
handling, or early startup code, etc. Subprocess code can't be
1206
profiled or debugged so easily.
1208
:param process_args: a list of arguments to pass to the bzr executable,
1209
for example `['--version']`.
1210
:param env_changes: A dictionary which lists changes to environment
1211
variables. A value of None will unset the env variable.
1212
The values must be strings. The change will only occur in the
1213
child, so you don't need to fix the environment after running.
1214
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1216
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1218
:returns: Popen object for the started process.
1220
if skip_if_plan_to_signal:
1221
if not getattr(os, 'kill', None):
1222
raise TestSkipped("os.kill not available.")
1224
if env_changes is None:
1228
def cleanup_environment():
1229
for env_var, value in env_changes.iteritems():
1230
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1232
def restore_environment():
1233
for env_var, value in old_env.iteritems():
1234
osutils.set_or_unset_env(env_var, value)
1236
bzr_path = self.get_bzr_path()
1239
if working_dir is not None:
1240
cwd = osutils.getcwd()
1241
os.chdir(working_dir)
1244
# win32 subprocess doesn't support preexec_fn
1245
# so we will avoid using it on all platforms, just to
1246
# make sure the code path is used, and we don't break on win32
1247
cleanup_environment()
1248
command = [sys.executable, bzr_path]
1249
if not allow_plugins:
1250
command.append('--no-plugins')
1251
command.extend(process_args)
1252
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1254
restore_environment()
1260
def _popen(self, *args, **kwargs):
1261
"""Place a call to Popen.
1263
Allows tests to override this method to intercept the calls made to
1264
Popen for introspection.
1266
return Popen(*args, **kwargs)
1268
def get_bzr_path(self):
1269
"""Return the path of the 'bzr' executable for this test suite."""
1270
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1271
if not os.path.isfile(bzr_path):
1272
# We are probably installed. Assume sys.argv is the right file
1273
bzr_path = sys.argv[0]
1276
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1277
universal_newlines=False, process_args=None):
1278
"""Finish the execution of process.
1280
:param process: the Popen object returned from start_bzr_subprocess.
1281
:param retcode: The status code that is expected. Defaults to 0. If
1282
None is supplied, the status code is not checked.
1283
:param send_signal: an optional signal to send to the process.
1284
:param universal_newlines: Convert CRLF => LF
1285
:returns: (stdout, stderr)
1287
if send_signal is not None:
1288
os.kill(process.pid, send_signal)
1289
out, err = process.communicate()
1291
if universal_newlines:
1292
out = out.replace('\r\n', '\n')
1293
err = err.replace('\r\n', '\n')
1295
if retcode is not None and retcode != process.returncode:
1296
if process_args is None:
1297
process_args = "(unknown args)"
1298
mutter('Output of bzr %s:\n%s', process_args, out)
1299
mutter('Error for bzr %s:\n%s', process_args, err)
1300
self.fail('Command bzr %s failed with retcode %s != %s'
1301
% (process_args, retcode, process.returncode))
1304
def check_inventory_shape(self, inv, shape):
1305
"""Compare an inventory to a list of expected names.
1307
Fail if they are not precisely equal.
1310
shape = list(shape) # copy
1311
for path, ie in inv.entries():
1312
name = path.replace('\\', '/')
1313
if ie.kind == 'dir':
1320
self.fail("expected paths not found in inventory: %r" % shape)
1322
self.fail("unexpected paths found in inventory: %r" % extras)
1324
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1325
a_callable=None, *args, **kwargs):
1326
"""Call callable with redirected std io pipes.
1328
Returns the return code."""
1329
if not callable(a_callable):
1330
raise ValueError("a_callable must be callable.")
1332
stdin = StringIO("")
1334
if getattr(self, "_log_file", None) is not None:
1335
stdout = self._log_file
1339
if getattr(self, "_log_file", None is not None):
1340
stderr = self._log_file
1343
real_stdin = sys.stdin
1344
real_stdout = sys.stdout
1345
real_stderr = sys.stderr
1350
return a_callable(*args, **kwargs)
1352
sys.stdout = real_stdout
1353
sys.stderr = real_stderr
1354
sys.stdin = real_stdin
1356
@symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
1357
def merge(self, branch_from, wt_to):
1358
"""A helper for tests to do a ui-less merge.
1360
This should move to the main library when someone has time to integrate
1363
# minimal ui-less merge.
1364
wt_to.branch.fetch(branch_from)
1365
base_rev = common_ancestor(branch_from.last_revision(),
1366
wt_to.branch.last_revision(),
1367
wt_to.branch.repository)
1368
merge_inner(wt_to.branch, branch_from.basis_tree(),
1369
wt_to.branch.repository.revision_tree(base_rev),
1371
wt_to.add_parent_tree_id(branch_from.last_revision())
1374
BzrTestBase = TestCase
1377
class TestCaseWithMemoryTransport(TestCase):
1378
"""Common test class for tests that do not need disk resources.
1380
Tests that need disk resources should derive from TestCaseWithTransport.
1382
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1384
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1385
a directory which does not exist. This serves to help ensure test isolation
1386
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1387
must exist. However, TestCaseWithMemoryTransport does not offer local
1388
file defaults for the transport in tests, nor does it obey the command line
1389
override, so tests that accidentally write to the common directory should
1397
def __init__(self, methodName='runTest'):
1398
# allow test parameterisation after test construction and before test
1399
# execution. Variables that the parameteriser sets need to be
1400
# ones that are not set by setUp, or setUp will trash them.
1401
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1402
self.transport_server = default_transport
1403
self.transport_readonly_server = None
1405
def get_transport(self):
1406
"""Return a writeable transport for the test scratch space"""
1407
t = get_transport(self.get_url())
1408
self.assertFalse(t.is_readonly())
1411
def get_readonly_transport(self):
1412
"""Return a readonly transport for the test scratch space
1414
This can be used to test that operations which should only need
1415
readonly access in fact do not try to write.
1417
t = get_transport(self.get_readonly_url())
1418
self.assertTrue(t.is_readonly())
1421
def create_transport_readonly_server(self):
1422
"""Create a transport server from class defined at init.
1424
This is mostly a hook for daughter classes.
1426
return self.transport_readonly_server()
1428
def get_readonly_server(self):
1429
"""Get the server instance for the readonly transport
1431
This is useful for some tests with specific servers to do diagnostics.
1433
if self.__readonly_server is None:
1434
if self.transport_readonly_server is None:
1435
# readonly decorator requested
1436
# bring up the server
1438
self.__readonly_server = ReadonlyServer()
1439
self.__readonly_server.setUp(self.__server)
1441
self.__readonly_server = self.create_transport_readonly_server()
1442
self.__readonly_server.setUp()
1443
self.addCleanup(self.__readonly_server.tearDown)
1444
return self.__readonly_server
1446
def get_readonly_url(self, relpath=None):
1447
"""Get a URL for the readonly transport.
1449
This will either be backed by '.' or a decorator to the transport
1450
used by self.get_url()
1451
relpath provides for clients to get a path relative to the base url.
1452
These should only be downwards relative, not upwards.
1454
base = self.get_readonly_server().get_url()
1455
if relpath is not None:
1456
if not base.endswith('/'):
1458
base = base + relpath
1461
def get_server(self):
1462
"""Get the read/write server instance.
1464
This is useful for some tests with specific servers that need
1467
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1468
is no means to override it.
1470
if self.__server is None:
1471
self.__server = MemoryServer()
1472
self.__server.setUp()
1473
self.addCleanup(self.__server.tearDown)
1474
return self.__server
1476
def get_url(self, relpath=None):
1477
"""Get a URL (or maybe a path) for the readwrite transport.
1479
This will either be backed by '.' or to an equivalent non-file based
1481
relpath provides for clients to get a path relative to the base url.
1482
These should only be downwards relative, not upwards.
1484
base = self.get_server().get_url()
1485
if relpath is not None and relpath != '.':
1486
if not base.endswith('/'):
1488
# XXX: Really base should be a url; we did after all call
1489
# get_url()! But sometimes it's just a path (from
1490
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1491
# to a non-escaped local path.
1492
if base.startswith('./') or base.startswith('/'):
1495
base += urlutils.escape(relpath)
1498
def _make_test_root(self):
1499
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1503
root = u'test%04d.tmp' % i
1507
if e.errno == errno.EEXIST:
1512
# successfully created
1513
TestCaseWithMemoryTransport.TEST_ROOT = osutils.abspath(root)
1515
# make a fake bzr directory there to prevent any tests propagating
1516
# up onto the source directory's real branch
1517
bzrdir.BzrDir.create_standalone_workingtree(
1518
TestCaseWithMemoryTransport.TEST_ROOT)
1520
def makeAndChdirToTestDir(self):
1521
"""Create a temporary directories for this one test.
1523
This must set self.test_home_dir and self.test_dir and chdir to
1526
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1528
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1529
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1530
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1532
def make_branch(self, relpath, format=None):
1533
"""Create a branch on the transport at relpath."""
1534
repo = self.make_repository(relpath, format=format)
1535
return repo.bzrdir.create_branch()
1537
def make_bzrdir(self, relpath, format=None):
1539
# might be a relative or absolute path
1540
maybe_a_url = self.get_url(relpath)
1541
segments = maybe_a_url.rsplit('/', 1)
1542
t = get_transport(maybe_a_url)
1543
if len(segments) > 1 and segments[-1] not in ('', '.'):
1546
except errors.FileExists:
1550
if isinstance(format, basestring):
1551
format = bzrdir.format_registry.make_bzrdir(format)
1552
return format.initialize_on_transport(t)
1553
except errors.UninitializableFormat:
1554
raise TestSkipped("Format %s is not initializable." % format)
1556
def make_repository(self, relpath, shared=False, format=None):
1557
"""Create a repository on our default transport at relpath."""
1558
made_control = self.make_bzrdir(relpath, format=format)
1559
return made_control.create_repository(shared=shared)
1561
def make_branch_and_memory_tree(self, relpath, format=None):
1562
"""Create a branch on the default transport and a MemoryTree for it."""
1563
b = self.make_branch(relpath, format=format)
1564
return memorytree.MemoryTree.create_on_branch(b)
1566
def overrideEnvironmentForTesting(self):
1567
os.environ['HOME'] = self.test_home_dir
1568
os.environ['BZR_HOME'] = self.test_home_dir
1571
super(TestCaseWithMemoryTransport, self).setUp()
1572
self._make_test_root()
1573
_currentdir = os.getcwdu()
1574
def _leaveDirectory():
1575
os.chdir(_currentdir)
1576
self.addCleanup(_leaveDirectory)
1577
self.makeAndChdirToTestDir()
1578
self.overrideEnvironmentForTesting()
1579
self.__readonly_server = None
1580
self.__server = None
1583
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1584
"""Derived class that runs a test within a temporary directory.
1586
This is useful for tests that need to create a branch, etc.
1588
The directory is created in a slightly complex way: for each
1589
Python invocation, a new temporary top-level directory is created.
1590
All test cases create their own directory within that. If the
1591
tests complete successfully, the directory is removed.
1593
InTempDir is an old alias for FunctionalTestCase.
1596
OVERRIDE_PYTHON = 'python'
1598
def check_file_contents(self, filename, expect):
1599
self.log("check contents of file %s" % filename)
1600
contents = file(filename, 'r').read()
1601
if contents != expect:
1602
self.log("expected: %r" % expect)
1603
self.log("actually: %r" % contents)
1604
self.fail("contents of %s not as expected" % filename)
1606
def makeAndChdirToTestDir(self):
1607
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1609
For TestCaseInTempDir we create a temporary directory based on the test
1610
name and then create two subdirs - test and home under it.
1612
if NUMBERED_DIRS: # strongly recommended on Windows
1613
# due the path length limitation (260 chars)
1614
candidate_dir = '%s/%dK/%05d' % (self.TEST_ROOT,
1615
int(self.number/1000),
1617
os.makedirs(candidate_dir)
1618
self.test_home_dir = candidate_dir + '/home'
1619
os.mkdir(self.test_home_dir)
1620
self.test_dir = candidate_dir + '/work'
1621
os.mkdir(self.test_dir)
1622
os.chdir(self.test_dir)
1623
# put name of test inside
1624
f = file(candidate_dir + '/name', 'w')
1629
# shorten the name, to avoid test failures due to path length
1630
short_id = self.id().replace('bzrlib.tests.', '') \
1631
.replace('__main__.', '')[-100:]
1632
# it's possible the same test class is run several times for
1633
# parameterized tests, so make sure the names don't collide.
1637
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1639
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1640
if os.path.exists(candidate_dir):
1644
os.mkdir(candidate_dir)
1645
self.test_home_dir = candidate_dir + '/home'
1646
os.mkdir(self.test_home_dir)
1647
self.test_dir = candidate_dir + '/work'
1648
os.mkdir(self.test_dir)
1649
os.chdir(self.test_dir)
1652
def build_tree(self, shape, line_endings='binary', transport=None):
1653
"""Build a test tree according to a pattern.
1655
shape is a sequence of file specifications. If the final
1656
character is '/', a directory is created.
1658
This assumes that all the elements in the tree being built are new.
1660
This doesn't add anything to a branch.
1661
:param line_endings: Either 'binary' or 'native'
1662
in binary mode, exact contents are written
1663
in native mode, the line endings match the
1664
default platform endings.
1666
:param transport: A transport to write to, for building trees on
1667
VFS's. If the transport is readonly or None,
1668
"." is opened automatically.
1670
# It's OK to just create them using forward slashes on windows.
1671
if transport is None or transport.is_readonly():
1672
transport = get_transport(".")
1674
self.assert_(isinstance(name, basestring))
1676
transport.mkdir(urlutils.escape(name[:-1]))
1678
if line_endings == 'binary':
1680
elif line_endings == 'native':
1683
raise errors.BzrError(
1684
'Invalid line ending request %r' % line_endings)
1685
content = "contents of %s%s" % (name.encode('utf-8'), end)
1686
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1688
def build_tree_contents(self, shape):
1689
build_tree_contents(shape)
1691
def assertFileEqual(self, content, path):
1692
"""Fail if path does not contain 'content'."""
1693
self.failUnlessExists(path)
1694
# TODO: jam 20060427 Shouldn't this be 'rb'?
1695
self.assertEqualDiff(content, open(path, 'r').read())
1697
def failUnlessExists(self, path):
1698
"""Fail unless path, which may be abs or relative, exists."""
1699
self.failUnless(osutils.lexists(path),path+" does not exist")
1701
def failIfExists(self, path):
1702
"""Fail if path, which may be abs or relative, exists."""
1703
self.failIf(osutils.lexists(path),path+" exists")
1706
class TestCaseWithTransport(TestCaseInTempDir):
1707
"""A test case that provides get_url and get_readonly_url facilities.
1709
These back onto two transport servers, one for readonly access and one for
1712
If no explicit class is provided for readonly access, a
1713
ReadonlyTransportDecorator is used instead which allows the use of non disk
1714
based read write transports.
1716
If an explicit class is provided for readonly access, that server and the
1717
readwrite one must both define get_url() as resolving to os.getcwd().
1720
def create_transport_server(self):
1721
"""Create a transport server from class defined at init.
1723
This is mostly a hook for daughter classes.
1725
return self.transport_server()
1727
def get_server(self):
1728
"""See TestCaseWithMemoryTransport.
1730
This is useful for some tests with specific servers that need
1733
if self.__server is None:
1734
self.__server = self.create_transport_server()
1735
self.__server.setUp()
1736
self.addCleanup(self.__server.tearDown)
1737
return self.__server
1739
def make_branch_and_tree(self, relpath, format=None):
1740
"""Create a branch on the transport and a tree locally.
1742
If the transport is not a LocalTransport, the Tree can't be created on
1743
the transport. In that case the working tree is created in the local
1744
directory, and the returned tree's branch and repository will also be
1747
This will fail if the original default transport for this test
1748
case wasn't backed by the working directory, as the branch won't
1749
be on disk for us to open it.
1751
:param format: The BzrDirFormat.
1752
:returns: the WorkingTree.
1754
# TODO: always use the local disk path for the working tree,
1755
# this obviously requires a format that supports branch references
1756
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1758
b = self.make_branch(relpath, format=format)
1760
return b.bzrdir.create_workingtree()
1761
except errors.NotLocalUrl:
1762
# We can only make working trees locally at the moment. If the
1763
# transport can't support them, then reopen the branch on a local
1764
# transport, and create the working tree there.
1766
# Possibly we should instead keep
1767
# the non-disk-backed branch and create a local checkout?
1768
bd = bzrdir.BzrDir.open(relpath)
1769
return bd.create_workingtree()
1771
def assertIsDirectory(self, relpath, transport):
1772
"""Assert that relpath within transport is a directory.
1774
This may not be possible on all transports; in that case it propagates
1775
a TransportNotPossible.
1778
mode = transport.stat(relpath).st_mode
1779
except errors.NoSuchFile:
1780
self.fail("path %s is not a directory; no such file"
1782
if not stat.S_ISDIR(mode):
1783
self.fail("path %s is not a directory; has mode %#o"
1786
def assertTreesEqual(self, left, right):
1787
"""Check that left and right have the same content and properties."""
1788
# we use a tree delta to check for equality of the content, and we
1789
# manually check for equality of other things such as the parents list.
1790
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
1791
differences = left.changes_from(right)
1792
self.assertFalse(differences.has_changed(),
1793
"Trees %r and %r are different: %r" % (left, right, differences))
1796
super(TestCaseWithTransport, self).setUp()
1797
self.__server = None
1800
class ChrootedTestCase(TestCaseWithTransport):
1801
"""A support class that provides readonly urls outside the local namespace.
1803
This is done by checking if self.transport_server is a MemoryServer. if it
1804
is then we are chrooted already, if it is not then an HttpServer is used
1807
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1808
be used without needed to redo it when a different
1809
subclass is in use ?
1813
super(ChrootedTestCase, self).setUp()
1814
if not self.transport_server == MemoryServer:
1815
self.transport_readonly_server = HttpServer
1818
def filter_suite_by_re(suite, pattern):
1819
result = TestUtil.TestSuite()
1820
filter_re = re.compile(pattern)
1821
for test in iter_suite_tests(suite):
1822
if filter_re.search(test.id()):
1823
result.addTest(test)
1827
def sort_suite_by_re(suite, pattern):
1830
filter_re = re.compile(pattern)
1831
for test in iter_suite_tests(suite):
1832
if filter_re.search(test.id()):
1836
return TestUtil.TestSuite(first + second)
1839
def run_suite(suite, name='test', verbose=False, pattern=".*",
1840
stop_on_failure=False, keep_output=False,
1841
transport=None, lsprof_timed=None, bench_history=None,
1842
matching_tests_first=None,
1843
numbered_dirs=None):
1844
global NUMBERED_DIRS
1845
if numbered_dirs is not None:
1846
NUMBERED_DIRS = bool(numbered_dirs)
1848
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1853
runner = TextTestRunner(stream=sys.stdout,
1855
verbosity=verbosity,
1856
keep_output=keep_output,
1857
bench_history=bench_history)
1858
runner.stop_on_failure=stop_on_failure
1860
if matching_tests_first:
1861
suite = sort_suite_by_re(suite, pattern)
1863
suite = filter_suite_by_re(suite, pattern)
1864
result = runner.run(suite)
1865
return result.wasSuccessful()
1868
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1871
test_suite_factory=None,
1874
matching_tests_first=None,
1875
numbered_dirs=None):
1876
"""Run the whole test suite under the enhanced runner"""
1877
# XXX: Very ugly way to do this...
1878
# Disable warning about old formats because we don't want it to disturb
1879
# any blackbox tests.
1880
from bzrlib import repository
1881
repository._deprecation_warning_done = True
1883
global default_transport
1884
if transport is None:
1885
transport = default_transport
1886
old_transport = default_transport
1887
default_transport = transport
1889
if test_suite_factory is None:
1890
suite = test_suite()
1892
suite = test_suite_factory()
1893
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1894
stop_on_failure=stop_on_failure, keep_output=keep_output,
1895
transport=transport,
1896
lsprof_timed=lsprof_timed,
1897
bench_history=bench_history,
1898
matching_tests_first=matching_tests_first,
1899
numbered_dirs=numbered_dirs)
1901
default_transport = old_transport
1905
"""Build and return TestSuite for the whole of bzrlib.
1907
This function can be replaced if you need to change the default test
1908
suite on a global basis, but it is not encouraged.
1911
'bzrlib.tests.test_ancestry',
1912
'bzrlib.tests.test_annotate',
1913
'bzrlib.tests.test_api',
1914
'bzrlib.tests.test_atomicfile',
1915
'bzrlib.tests.test_bad_files',
1916
'bzrlib.tests.test_branch',
1917
'bzrlib.tests.test_bundle',
1918
'bzrlib.tests.test_bzrdir',
1919
'bzrlib.tests.test_cache_utf8',
1920
'bzrlib.tests.test_commands',
1921
'bzrlib.tests.test_commit',
1922
'bzrlib.tests.test_commit_merge',
1923
'bzrlib.tests.test_config',
1924
'bzrlib.tests.test_conflicts',
1925
'bzrlib.tests.test_decorators',
1926
'bzrlib.tests.test_delta',
1927
'bzrlib.tests.test_diff',
1928
'bzrlib.tests.test_dirstate',
1929
'bzrlib.tests.test_doc_generate',
1930
'bzrlib.tests.test_errors',
1931
'bzrlib.tests.test_escaped_store',
1932
'bzrlib.tests.test_extract',
1933
'bzrlib.tests.test_fetch',
1934
'bzrlib.tests.test_ftp_transport',
1935
'bzrlib.tests.test_generate_docs',
1936
'bzrlib.tests.test_generate_ids',
1937
'bzrlib.tests.test_globbing',
1938
'bzrlib.tests.test_gpg',
1939
'bzrlib.tests.test_graph',
1940
'bzrlib.tests.test_hashcache',
1941
'bzrlib.tests.test_http',
1942
'bzrlib.tests.test_http_response',
1943
'bzrlib.tests.test_https_ca_bundle',
1944
'bzrlib.tests.test_identitymap',
1945
'bzrlib.tests.test_ignores',
1946
'bzrlib.tests.test_inv',
1947
'bzrlib.tests.test_knit',
1948
'bzrlib.tests.test_lazy_import',
1949
'bzrlib.tests.test_lazy_regex',
1950
'bzrlib.tests.test_lockdir',
1951
'bzrlib.tests.test_lockable_files',
1952
'bzrlib.tests.test_log',
1953
'bzrlib.tests.test_memorytree',
1954
'bzrlib.tests.test_merge',
1955
'bzrlib.tests.test_merge3',
1956
'bzrlib.tests.test_merge_core',
1957
'bzrlib.tests.test_merge_directive',
1958
'bzrlib.tests.test_missing',
1959
'bzrlib.tests.test_msgeditor',
1960
'bzrlib.tests.test_nonascii',
1961
'bzrlib.tests.test_options',
1962
'bzrlib.tests.test_osutils',
1963
'bzrlib.tests.test_osutils_encodings',
1964
'bzrlib.tests.test_patch',
1965
'bzrlib.tests.test_patches',
1966
'bzrlib.tests.test_permissions',
1967
'bzrlib.tests.test_plugins',
1968
'bzrlib.tests.test_progress',
1969
'bzrlib.tests.test_reconcile',
1970
'bzrlib.tests.test_registry',
1971
'bzrlib.tests.test_repository',
1972
'bzrlib.tests.test_revert',
1973
'bzrlib.tests.test_revision',
1974
'bzrlib.tests.test_revisionnamespaces',
1975
'bzrlib.tests.test_revisiontree',
1976
'bzrlib.tests.test_rio',
1977
'bzrlib.tests.test_sampler',
1978
'bzrlib.tests.test_selftest',
1979
'bzrlib.tests.test_setup',
1980
'bzrlib.tests.test_sftp_transport',
1981
'bzrlib.tests.test_smart_add',
1982
'bzrlib.tests.test_smart_transport',
1983
'bzrlib.tests.test_source',
1984
'bzrlib.tests.test_ssh_transport',
1985
'bzrlib.tests.test_status',
1986
'bzrlib.tests.test_store',
1987
'bzrlib.tests.test_subsume',
1988
'bzrlib.tests.test_symbol_versioning',
1989
'bzrlib.tests.test_tag',
1990
'bzrlib.tests.test_testament',
1991
'bzrlib.tests.test_textfile',
1992
'bzrlib.tests.test_textmerge',
1993
'bzrlib.tests.test_timestamp',
1994
'bzrlib.tests.test_trace',
1995
'bzrlib.tests.test_transactions',
1996
'bzrlib.tests.test_transform',
1997
'bzrlib.tests.test_transport',
1998
'bzrlib.tests.test_tree',
1999
'bzrlib.tests.test_treebuilder',
2000
'bzrlib.tests.test_tsort',
2001
'bzrlib.tests.test_tuned_gzip',
2002
'bzrlib.tests.test_ui',
2003
'bzrlib.tests.test_upgrade',
2004
'bzrlib.tests.test_urlutils',
2005
'bzrlib.tests.test_versionedfile',
2006
'bzrlib.tests.test_version',
2007
'bzrlib.tests.test_version_info',
2008
'bzrlib.tests.test_weave',
2009
'bzrlib.tests.test_whitebox',
2010
'bzrlib.tests.test_workingtree',
2011
'bzrlib.tests.test_workingtree_4',
2012
'bzrlib.tests.test_wsgi',
2013
'bzrlib.tests.test_xml',
2015
test_transport_implementations = [
2016
'bzrlib.tests.test_transport_implementations',
2017
'bzrlib.tests.test_read_bundle',
2019
suite = TestUtil.TestSuite()
2020
loader = TestUtil.TestLoader()
2021
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2022
from bzrlib.transport import TransportTestProviderAdapter
2023
adapter = TransportTestProviderAdapter()
2024
adapt_modules(test_transport_implementations, adapter, loader, suite)
2025
for package in packages_to_test():
2026
suite.addTest(package.test_suite())
2027
for m in MODULES_TO_TEST:
2028
suite.addTest(loader.loadTestsFromModule(m))
2029
for m in MODULES_TO_DOCTEST:
2031
suite.addTest(doctest.DocTestSuite(m))
2032
except ValueError, e:
2033
print '**failed to get doctest for: %s\n%s' %(m,e)
2035
for name, plugin in bzrlib.plugin.all_plugins().items():
2036
if getattr(plugin, 'test_suite', None) is not None:
2037
default_encoding = sys.getdefaultencoding()
2039
plugin_suite = plugin.test_suite()
2040
except ImportError, e:
2041
bzrlib.trace.warning(
2042
'Unable to test plugin "%s": %s', name, e)
2044
suite.addTest(plugin_suite)
2045
if default_encoding != sys.getdefaultencoding():
2046
bzrlib.trace.warning(
2047
'Plugin "%s" tried to reset default encoding to: %s', name,
2048
sys.getdefaultencoding())
2050
sys.setdefaultencoding(default_encoding)
2054
def adapt_modules(mods_list, adapter, loader, suite):
2055
"""Adapt the modules in mods_list using adapter and add to suite."""
2056
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2057
suite.addTests(adapter.adapt(test))
2060
def clean_selftest_output(root=None, quiet=False):
2061
"""Remove all selftest output directories from root directory.
2063
:param root: root directory for clean
2064
(if ommitted or None then clean current directory).
2065
:param quiet: suppress report about deleting directories
2070
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
2073
for i in os.listdir(root):
2074
if os.path.isdir(i) and re_dir.match(i):
2076
print 'delete directory:', i
added
removed
bzrlib/tests/__init__.py
