1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: Perhaps there should be an API to find out if bzr running under the
19
# test suite -- some plugins might want to avoid making intrusive changes if
20
# this is the case. However, we want behaviour under to test to diverge as
21
# little as possible, so this should be used rarely if it's added at all.
22
# (Suggestion from j-a-meinel, 2005-11-24)
24
# NOTE: Some classes in here use camelCaseNaming() rather than
25
# underscore_naming(). That's for consistency with unittest; it's not the
26
# general style of bzrlib. Please continue that consistency when adding e.g.
27
# new assertFoo() methods.
30
from cStringIO import StringIO
36
from pprint import pformat
40
from subprocess import Popen, PIPE
58
import bzrlib.commands
59
import bzrlib.timestamp
61
import bzrlib.inventory
62
import bzrlib.iterablefile
67
# lsprof not available
69
from bzrlib.merge import merge_inner
73
from bzrlib.revision import common_ancestor
75
from bzrlib import symbol_versioning
77
from bzrlib.transport import get_transport
78
import bzrlib.transport
79
from bzrlib.transport.local import LocalURLServer
80
from bzrlib.transport.memory import MemoryServer
81
from bzrlib.transport.readonly import ReadonlyServer
82
from bzrlib.trace import mutter, note
83
from bzrlib.tests import TestUtil
84
from bzrlib.tests.HttpServer import HttpServer
85
from bzrlib.tests.TestUtil import (
89
from bzrlib.tests.treeshape import build_tree_contents
90
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
92
default_transport = LocalURLServer
95
MODULES_TO_DOCTEST = [
107
NUMBERED_DIRS = False # dirs kind for TestCaseInTempDir (numbered or named)
110
def packages_to_test():
111
"""Return a list of packages to test.
113
The packages are not globally imported so that import failures are
114
triggered when running selftest, not when importing the command.
117
import bzrlib.tests.blackbox
118
import bzrlib.tests.branch_implementations
119
import bzrlib.tests.bzrdir_implementations
120
import bzrlib.tests.interrepository_implementations
121
import bzrlib.tests.interversionedfile_implementations
122
import bzrlib.tests.intertree_implementations
123
import bzrlib.tests.per_lock
124
import bzrlib.tests.repository_implementations
125
import bzrlib.tests.revisionstore_implementations
126
import bzrlib.tests.tree_implementations
127
import bzrlib.tests.workingtree_implementations
130
bzrlib.tests.blackbox,
131
bzrlib.tests.branch_implementations,
132
bzrlib.tests.bzrdir_implementations,
133
bzrlib.tests.interrepository_implementations,
134
bzrlib.tests.interversionedfile_implementations,
135
bzrlib.tests.intertree_implementations,
136
bzrlib.tests.per_lock,
137
bzrlib.tests.repository_implementations,
138
bzrlib.tests.revisionstore_implementations,
139
bzrlib.tests.tree_implementations,
140
bzrlib.tests.workingtree_implementations,
144
class ExtendedTestResult(unittest._TextTestResult):
145
"""Accepts, reports and accumulates the results of running tests.
147
Compared to this unittest version this class adds support for profiling,
148
benchmarking, stopping as soon as a test fails, and skipping tests.
149
There are further-specialized subclasses for different types of display.
154
def __init__(self, stream, descriptions, verbosity,
158
"""Construct new TestResult.
160
:param bench_history: Optionally, a writable file object to accumulate
163
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
164
if bench_history is not None:
165
from bzrlib.version import _get_bzr_source_tree
166
src_tree = _get_bzr_source_tree()
169
revision_id = src_tree.get_parent_ids()[0]
171
# XXX: if this is a brand new tree, do the same as if there
175
# XXX: If there's no branch, what should we do?
177
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
178
self._bench_history = bench_history
179
self.ui = ui.ui_factory
180
self.num_tests = num_tests
182
self.failure_count = 0
183
self.known_failure_count = 0
185
self.unsupported = {}
187
self._overall_start_time = time.time()
189
def extractBenchmarkTime(self, testCase):
190
"""Add a benchmark time for the current test case."""
191
self._benchmarkTime = getattr(testCase, "_benchtime", None)
193
def _elapsedTestTimeString(self):
194
"""Return a time string for the overall time the current test has taken."""
195
return self._formatTime(time.time() - self._start_time)
197
def _testTimeString(self):
198
if self._benchmarkTime is not None:
200
self._formatTime(self._benchmarkTime),
201
self._elapsedTestTimeString())
203
return " %s" % self._elapsedTestTimeString()
205
def _formatTime(self, seconds):
206
"""Format seconds as milliseconds with leading spaces."""
207
# some benchmarks can take thousands of seconds to run, so we need 8
209
return "%8dms" % (1000 * seconds)
211
def _shortened_test_description(self, test):
213
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
216
def startTest(self, test):
217
unittest.TestResult.startTest(self, test)
218
self.report_test_start(test)
219
test.number = self.count
220
self._recordTestStartTime()
222
def _recordTestStartTime(self):
223
"""Record that a test has started."""
224
self._start_time = time.time()
226
def _cleanupLogFile(self, test):
227
# We can only do this if we have one of our TestCases, not if
229
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
230
if setKeepLogfile is not None:
233
def addError(self, test, err):
234
self.extractBenchmarkTime(test)
235
self._cleanupLogFile(test)
236
if isinstance(err[1], TestSkipped):
237
return self.addSkipped(test, err)
238
elif isinstance(err[1], UnavailableFeature):
239
return self.addNotSupported(test, err[1].args[0])
240
unittest.TestResult.addError(self, test, err)
241
self.error_count += 1
242
self.report_error(test, err)
246
def addFailure(self, test, err):
247
self._cleanupLogFile(test)
248
self.extractBenchmarkTime(test)
249
if isinstance(err[1], KnownFailure):
250
return self.addKnownFailure(test, err)
251
unittest.TestResult.addFailure(self, test, err)
252
self.failure_count += 1
253
self.report_failure(test, err)
257
def addKnownFailure(self, test, err):
258
self.known_failure_count += 1
259
self.report_known_failure(test, err)
261
def addNotSupported(self, test, feature):
262
self.unsupported.setdefault(str(feature), 0)
263
self.unsupported[str(feature)] += 1
264
self.report_unsupported(test, feature)
266
def addSuccess(self, test):
267
self.extractBenchmarkTime(test)
268
if self._bench_history is not None:
269
if self._benchmarkTime is not None:
270
self._bench_history.write("%s %s\n" % (
271
self._formatTime(self._benchmarkTime),
273
self.report_success(test)
274
unittest.TestResult.addSuccess(self, test)
276
def addSkipped(self, test, skip_excinfo):
277
self.report_skip(test, skip_excinfo)
278
# seems best to treat this as success from point-of-view of unittest
279
# -- it actually does nothing so it barely matters :)
282
except KeyboardInterrupt:
285
self.addError(test, test.__exc_info())
287
unittest.TestResult.addSuccess(self, test)
289
def printErrorList(self, flavour, errors):
290
for test, err in errors:
291
self.stream.writeln(self.separator1)
292
self.stream.write("%s: " % flavour)
294
self.stream.write('#%d ' % test.number)
295
self.stream.writeln(self.getDescription(test))
296
if getattr(test, '_get_log', None) is not None:
298
print >>self.stream, \
299
('vvvv[log from %s]' % test.id()).ljust(78,'-')
300
print >>self.stream, test._get_log()
301
print >>self.stream, \
302
('^^^^[log from %s]' % test.id()).ljust(78,'-')
303
self.stream.writeln(self.separator2)
304
self.stream.writeln("%s" % err)
309
def report_cleaning_up(self):
312
def report_success(self, test):
316
class TextTestResult(ExtendedTestResult):
317
"""Displays progress and results of tests in text form"""
319
def __init__(self, stream, descriptions, verbosity,
324
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
325
bench_history, num_tests)
327
self.pb = self.ui.nested_progress_bar()
328
self._supplied_pb = False
331
self._supplied_pb = True
332
self.pb.show_pct = False
333
self.pb.show_spinner = False
334
self.pb.show_eta = False,
335
self.pb.show_count = False
336
self.pb.show_bar = False
338
def report_starting(self):
339
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
341
def _progress_prefix_text(self):
342
a = '[%d' % self.count
343
if self.num_tests is not None:
344
a +='/%d' % self.num_tests
345
a += ' in %ds' % (time.time() - self._overall_start_time)
347
a += ', %d errors' % self.error_count
348
if self.failure_count:
349
a += ', %d failed' % self.failure_count
350
if self.known_failure_count:
351
a += ', %d known failures' % self.known_failure_count
353
a += ', %d skipped' % self.skip_count
355
a += ', %d missing features' % len(self.unsupported)
359
def report_test_start(self, test):
362
self._progress_prefix_text()
364
+ self._shortened_test_description(test))
366
def _test_description(self, test):
368
return '#%d %s' % (self.count,
369
self._shortened_test_description(test))
371
return self._shortened_test_description(test)
373
def report_error(self, test, err):
374
self.pb.note('ERROR: %s\n %s\n',
375
self._test_description(test),
379
def report_failure(self, test, err):
380
self.pb.note('FAIL: %s\n %s\n',
381
self._test_description(test),
385
def report_known_failure(self, test, err):
386
self.pb.note('XFAIL: %s\n%s\n',
387
self._test_description(test), err[1])
389
def report_skip(self, test, skip_excinfo):
392
# at the moment these are mostly not things we can fix
393
# and so they just produce stipple; use the verbose reporter
396
# show test and reason for skip
397
self.pb.note('SKIP: %s\n %s\n',
398
self._shortened_test_description(test),
401
# since the class name was left behind in the still-visible
403
self.pb.note('SKIP: %s', skip_excinfo[1])
405
def report_unsupported(self, test, feature):
406
"""test cannot be run because feature is missing."""
408
def report_cleaning_up(self):
409
self.pb.update('cleaning up...')
412
if not self._supplied_pb:
416
class VerboseTestResult(ExtendedTestResult):
417
"""Produce long output, with one line per test run plus times"""
419
def _ellipsize_to_right(self, a_string, final_width):
420
"""Truncate and pad a string, keeping the right hand side"""
421
if len(a_string) > final_width:
422
result = '...' + a_string[3-final_width:]
425
return result.ljust(final_width)
427
def report_starting(self):
428
self.stream.write('running %d tests...\n' % self.num_tests)
430
def report_test_start(self, test):
432
name = self._shortened_test_description(test)
433
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
434
# numbers, plus a trailing blank
435
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
437
self.stream.write('%5d ' % self.count)
438
self.stream.write(self._ellipsize_to_right(name,
439
osutils.terminal_width()-36))
441
self.stream.write(self._ellipsize_to_right(name,
442
osutils.terminal_width()-30))
445
def _error_summary(self, err):
449
return '%s%s' % (indent, err[1])
451
def report_error(self, test, err):
452
self.stream.writeln('ERROR %s\n%s'
453
% (self._testTimeString(),
454
self._error_summary(err)))
456
def report_failure(self, test, err):
457
self.stream.writeln(' FAIL %s\n%s'
458
% (self._testTimeString(),
459
self._error_summary(err)))
461
def report_known_failure(self, test, err):
462
self.stream.writeln('XFAIL %s\n%s'
463
% (self._testTimeString(),
464
self._error_summary(err)))
466
def report_success(self, test):
467
self.stream.writeln(' OK %s' % self._testTimeString())
468
for bench_called, stats in getattr(test, '_benchcalls', []):
469
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
470
stats.pprint(file=self.stream)
471
# flush the stream so that we get smooth output. This verbose mode is
472
# used to show the output in PQM.
475
def report_skip(self, test, skip_excinfo):
477
self.stream.writeln(' SKIP %s\n%s'
478
% (self._testTimeString(),
479
self._error_summary(skip_excinfo)))
481
def report_unsupported(self, test, feature):
482
"""test cannot be run because feature is missing."""
483
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
484
%(self._testTimeString(), feature))
488
class TextTestRunner(object):
489
stop_on_failure = False
497
self.stream = unittest._WritelnDecorator(stream)
498
self.descriptions = descriptions
499
self.verbosity = verbosity
500
self.keep_output = keep_output
501
self._bench_history = bench_history
504
"Run the given test case or test suite."
505
startTime = time.time()
506
if self.verbosity == 1:
507
result_class = TextTestResult
508
elif self.verbosity >= 2:
509
result_class = VerboseTestResult
510
result = result_class(self.stream,
513
bench_history=self._bench_history,
514
num_tests=test.countTestCases(),
516
result.stop_early = self.stop_on_failure
517
result.report_starting()
519
stopTime = time.time()
520
timeTaken = stopTime - startTime
522
self.stream.writeln(result.separator2)
523
run = result.testsRun
524
self.stream.writeln("Ran %d test%s in %.3fs" %
525
(run, run != 1 and "s" or "", timeTaken))
526
self.stream.writeln()
527
if not result.wasSuccessful():
528
self.stream.write("FAILED (")
529
failed, errored = map(len, (result.failures, result.errors))
531
self.stream.write("failures=%d" % failed)
533
if failed: self.stream.write(", ")
534
self.stream.write("errors=%d" % errored)
535
if result.known_failure_count:
536
if failed or errored: self.stream.write(", ")
537
self.stream.write("known_failure_count=%d" %
538
result.known_failure_count)
539
self.stream.writeln(")")
541
if result.known_failure_count:
542
self.stream.writeln("OK (known_failures=%d)" %
543
result.known_failure_count)
545
self.stream.writeln("OK")
546
if result.skip_count > 0:
547
skipped = result.skip_count
548
self.stream.writeln('%d test%s skipped' %
549
(skipped, skipped != 1 and "s" or ""))
550
if result.unsupported:
551
for feature, count in sorted(result.unsupported.items()):
552
self.stream.writeln("Missing feature '%s' skipped %d tests." %
554
result.report_cleaning_up()
555
# This is still a little bogus,
556
# but only a little. Folk not using our testrunner will
557
# have to delete their temp directories themselves.
558
test_root = TestCaseWithMemoryTransport.TEST_ROOT
559
if result.wasSuccessful() or not self.keep_output:
560
if test_root is not None:
561
# If LANG=C we probably have created some bogus paths
562
# which rmtree(unicode) will fail to delete
563
# so make sure we are using rmtree(str) to delete everything
564
# except on win32, where rmtree(str) will fail
565
# since it doesn't have the property of byte-stream paths
566
# (they are either ascii or mbcs)
567
if sys.platform == 'win32':
568
# make sure we are using the unicode win32 api
569
test_root = unicode(test_root)
571
test_root = test_root.encode(
572
sys.getfilesystemencoding())
574
osutils.rmtree(test_root)
576
if sys.platform == 'win32' and e.errno == errno.EACCES:
577
print >>sys.stderr, ('Permission denied: '
578
'unable to remove testing dir '
579
'%s' % os.path.basename(test_root))
583
note("Failed tests working directories are in '%s'\n", test_root)
584
TestCaseWithMemoryTransport.TEST_ROOT = None
589
def iter_suite_tests(suite):
590
"""Return all tests in a suite, recursing through nested suites"""
591
for item in suite._tests:
592
if isinstance(item, unittest.TestCase):
594
elif isinstance(item, unittest.TestSuite):
595
for r in iter_suite_tests(item):
598
raise Exception('unknown object %r inside test suite %r'
602
class TestSkipped(Exception):
603
"""Indicates that a test was intentionally skipped, rather than failing."""
606
class KnownFailure(AssertionError):
607
"""Indicates that a test failed in a precisely expected manner.
609
Such failures dont block the whole test suite from passing because they are
610
indicators of partially completed code or of future work. We have an
611
explicit error for them so that we can ensure that they are always visible:
612
KnownFailures are always shown in the output of bzr selftest.
616
class UnavailableFeature(Exception):
617
"""A feature required for this test was not available.
619
The feature should be used to construct the exception.
623
class CommandFailed(Exception):
627
class StringIOWrapper(object):
628
"""A wrapper around cStringIO which just adds an encoding attribute.
630
Internally we can check sys.stdout to see what the output encoding
631
should be. However, cStringIO has no encoding attribute that we can
632
set. So we wrap it instead.
637
def __init__(self, s=None):
639
self.__dict__['_cstring'] = StringIO(s)
641
self.__dict__['_cstring'] = StringIO()
643
def __getattr__(self, name, getattr=getattr):
644
return getattr(self.__dict__['_cstring'], name)
646
def __setattr__(self, name, val):
647
if name == 'encoding':
648
self.__dict__['encoding'] = val
650
return setattr(self._cstring, name, val)
653
class TestUIFactory(ui.CLIUIFactory):
654
"""A UI Factory for testing.
656
Hide the progress bar but emit note()s.
658
Allows get_password to be tested without real tty attached.
665
super(TestUIFactory, self).__init__()
666
if stdin is not None:
667
# We use a StringIOWrapper to be able to test various
668
# encodings, but the user is still responsible to
669
# encode the string and to set the encoding attribute
670
# of StringIOWrapper.
671
self.stdin = StringIOWrapper(stdin)
673
self.stdout = sys.stdout
677
self.stderr = sys.stderr
682
"""See progress.ProgressBar.clear()."""
684
def clear_term(self):
685
"""See progress.ProgressBar.clear_term()."""
687
def clear_term(self):
688
"""See progress.ProgressBar.clear_term()."""
691
"""See progress.ProgressBar.finished()."""
693
def note(self, fmt_string, *args, **kwargs):
694
"""See progress.ProgressBar.note()."""
695
self.stdout.write((fmt_string + "\n") % args)
697
def progress_bar(self):
700
def nested_progress_bar(self):
703
def update(self, message, count=None, total=None):
704
"""See progress.ProgressBar.update()."""
706
def get_non_echoed_password(self, prompt):
707
"""Get password from stdin without trying to handle the echo mode"""
709
self.stdout.write(prompt)
710
password = self.stdin.readline()
713
if password[-1] == '\n':
714
password = password[:-1]
718
class TestCase(unittest.TestCase):
719
"""Base class for bzr unit tests.
721
Tests that need access to disk resources should subclass
722
TestCaseInTempDir not TestCase.
724
Error and debug log messages are redirected from their usual
725
location into a temporary file, the contents of which can be
726
retrieved by _get_log(). We use a real OS file, not an in-memory object,
727
so that it can also capture file IO. When the test completes this file
728
is read into memory and removed from disk.
730
There are also convenience functions to invoke bzr's command-line
731
routine, and to build and check bzr trees.
733
In addition to the usual method of overriding tearDown(), this class also
734
allows subclasses to register functions into the _cleanups list, which is
735
run in order as the object is torn down. It's less likely this will be
736
accidentally overlooked.
739
_log_file_name = None
741
_keep_log_file = False
742
# record lsprof data when performing benchmark calls.
743
_gather_lsprof_in_benchmarks = False
745
def __init__(self, methodName='testMethod'):
746
super(TestCase, self).__init__(methodName)
750
unittest.TestCase.setUp(self)
751
self._cleanEnvironment()
752
bzrlib.trace.disable_default_logging()
755
self._benchcalls = []
756
self._benchtime = None
757
# prevent hooks affecting tests
758
self._preserved_hooks = bzrlib.branch.Branch.hooks
759
self.addCleanup(self._restoreHooks)
760
# this list of hooks must be kept in sync with the defaults
762
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
764
def _silenceUI(self):
765
"""Turn off UI for duration of test"""
766
# by default the UI is off; tests can turn it on if they want it.
767
saved = ui.ui_factory
769
ui.ui_factory = saved
770
ui.ui_factory = ui.SilentUIFactory()
771
self.addCleanup(_restore)
773
def _ndiff_strings(self, a, b):
774
"""Return ndiff between two strings containing lines.
776
A trailing newline is added if missing to make the strings
778
if b and b[-1] != '\n':
780
if a and a[-1] != '\n':
782
difflines = difflib.ndiff(a.splitlines(True),
784
linejunk=lambda x: False,
785
charjunk=lambda x: False)
786
return ''.join(difflines)
788
def assertEqual(self, a, b, message=''):
792
except UnicodeError, e:
793
# If we can't compare without getting a UnicodeError, then
794
# obviously they are different
795
mutter('UnicodeError: %s', e)
798
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
800
pformat(a, indent=4), pformat(b, indent=4)))
802
assertEquals = assertEqual
804
def assertEqualDiff(self, a, b, message=None):
805
"""Assert two texts are equal, if not raise an exception.
807
This is intended for use with multi-line strings where it can
808
be hard to find the differences by eye.
810
# TODO: perhaps override assertEquals to call this for strings?
814
message = "texts not equal:\n"
815
raise AssertionError(message +
816
self._ndiff_strings(a, b))
818
def assertEqualMode(self, mode, mode_test):
819
self.assertEqual(mode, mode_test,
820
'mode mismatch %o != %o' % (mode, mode_test))
822
def assertStartsWith(self, s, prefix):
823
if not s.startswith(prefix):
824
raise AssertionError('string %r does not start with %r' % (s, prefix))
826
def assertEndsWith(self, s, suffix):
827
"""Asserts that s ends with suffix."""
828
if not s.endswith(suffix):
829
raise AssertionError('string %r does not end with %r' % (s, suffix))
831
def assertContainsRe(self, haystack, needle_re):
832
"""Assert that a contains something matching a regular expression."""
833
if not re.search(needle_re, haystack):
834
raise AssertionError('pattern "%r" not found in "%r"'
835
% (needle_re, haystack))
837
def assertNotContainsRe(self, haystack, needle_re):
838
"""Assert that a does not match a regular expression"""
839
if re.search(needle_re, haystack):
840
raise AssertionError('pattern "%s" found in "%s"'
841
% (needle_re, haystack))
843
def assertSubset(self, sublist, superlist):
844
"""Assert that every entry in sublist is present in superlist."""
846
for entry in sublist:
847
if entry not in superlist:
848
missing.append(entry)
850
raise AssertionError("value(s) %r not present in container %r" %
851
(missing, superlist))
853
def assertListRaises(self, excClass, func, *args, **kwargs):
854
"""Fail unless excClass is raised when the iterator from func is used.
856
Many functions can return generators this makes sure
857
to wrap them in a list() call to make sure the whole generator
858
is run, and that the proper exception is raised.
861
list(func(*args, **kwargs))
865
if getattr(excClass,'__name__', None) is not None:
866
excName = excClass.__name__
868
excName = str(excClass)
869
raise self.failureException, "%s not raised" % excName
871
def assertIs(self, left, right, message=None):
872
if not (left is right):
873
if message is not None:
874
raise AssertionError(message)
876
raise AssertionError("%r is not %r." % (left, right))
878
def assertIsNot(self, left, right, message=None):
880
if message is not None:
881
raise AssertionError(message)
883
raise AssertionError("%r is %r." % (left, right))
885
def assertTransportMode(self, transport, path, mode):
886
"""Fail if a path does not have mode mode.
888
If modes are not supported on this transport, the assertion is ignored.
890
if not transport._can_roundtrip_unix_modebits():
892
path_stat = transport.stat(path)
893
actual_mode = stat.S_IMODE(path_stat.st_mode)
894
self.assertEqual(mode, actual_mode,
895
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
897
def assertIsInstance(self, obj, kls):
898
"""Fail if obj is not an instance of kls"""
899
if not isinstance(obj, kls):
900
self.fail("%r is an instance of %s rather than %s" % (
901
obj, obj.__class__, kls))
903
def _capture_warnings(self, a_callable, *args, **kwargs):
904
"""A helper for callDeprecated and applyDeprecated.
906
:param a_callable: A callable to call.
907
:param args: The positional arguments for the callable
908
:param kwargs: The keyword arguments for the callable
909
:return: A tuple (warnings, result). result is the result of calling
910
a_callable(*args, **kwargs).
913
def capture_warnings(msg, cls=None, stacklevel=None):
914
# we've hooked into a deprecation specific callpath,
915
# only deprecations should getting sent via it.
916
self.assertEqual(cls, DeprecationWarning)
917
local_warnings.append(msg)
918
original_warning_method = symbol_versioning.warn
919
symbol_versioning.set_warning_method(capture_warnings)
921
result = a_callable(*args, **kwargs)
923
symbol_versioning.set_warning_method(original_warning_method)
924
return (local_warnings, result)
926
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
927
"""Call a deprecated callable without warning the user.
929
:param deprecation_format: The deprecation format that the callable
930
should have been deprecated with. This is the same type as the
931
parameter to deprecated_method/deprecated_function. If the
932
callable is not deprecated with this format, an assertion error
934
:param a_callable: A callable to call. This may be a bound method or
935
a regular function. It will be called with *args and **kwargs.
936
:param args: The positional arguments for the callable
937
:param kwargs: The keyword arguments for the callable
938
:return: The result of a_callable(*args, **kwargs)
940
call_warnings, result = self._capture_warnings(a_callable,
942
expected_first_warning = symbol_versioning.deprecation_string(
943
a_callable, deprecation_format)
944
if len(call_warnings) == 0:
945
self.fail("No deprecation warning generated by call to %s" %
947
self.assertEqual(expected_first_warning, call_warnings[0])
950
def callDeprecated(self, expected, callable, *args, **kwargs):
951
"""Assert that a callable is deprecated in a particular way.
953
This is a very precise test for unusual requirements. The
954
applyDeprecated helper function is probably more suited for most tests
955
as it allows you to simply specify the deprecation format being used
956
and will ensure that that is issued for the function being called.
958
:param expected: a list of the deprecation warnings expected, in order
959
:param callable: The callable to call
960
:param args: The positional arguments for the callable
961
:param kwargs: The keyword arguments for the callable
963
call_warnings, result = self._capture_warnings(callable,
965
self.assertEqual(expected, call_warnings)
968
def _startLogFile(self):
969
"""Send bzr and test log messages to a temporary file.
971
The file is removed as the test is torn down.
973
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
974
self._log_file = os.fdopen(fileno, 'w+')
975
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
976
self._log_file_name = name
977
self.addCleanup(self._finishLogFile)
979
def _finishLogFile(self):
980
"""Finished with the log file.
982
Close the file and delete it, unless setKeepLogfile was called.
984
if self._log_file is None:
986
bzrlib.trace.disable_test_log(self._log_nonce)
987
self._log_file.close()
988
self._log_file = None
989
if not self._keep_log_file:
990
os.remove(self._log_file_name)
991
self._log_file_name = None
993
def setKeepLogfile(self):
994
"""Make the logfile not be deleted when _finishLogFile is called."""
995
self._keep_log_file = True
997
def addCleanup(self, callable):
998
"""Arrange to run a callable when this case is torn down.
1000
Callables are run in the reverse of the order they are registered,
1001
ie last-in first-out.
1003
if callable in self._cleanups:
1004
raise ValueError("cleanup function %r already registered on %s"
1006
self._cleanups.append(callable)
1008
def _cleanEnvironment(self):
1010
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1011
'HOME': os.getcwd(),
1012
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1014
'BZREMAIL': None, # may still be present in the environment
1016
'BZR_PROGRESS_BAR': None,
1020
'https_proxy': None,
1021
'HTTPS_PROXY': None,
1026
# Nobody cares about these ones AFAIK. So far at
1027
# least. If you do (care), please update this comment
1033
self.addCleanup(self._restoreEnvironment)
1034
for name, value in new_env.iteritems():
1035
self._captureVar(name, value)
1037
def _captureVar(self, name, newvalue):
1038
"""Set an environment variable, and reset it when finished."""
1039
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1041
def _restoreEnvironment(self):
1042
for name, value in self.__old_env.iteritems():
1043
osutils.set_or_unset_env(name, value)
1045
def _restoreHooks(self):
1046
bzrlib.branch.Branch.hooks = self._preserved_hooks
1048
def knownFailure(self, reason):
1049
"""This test has failed for some known reason."""
1050
raise KnownFailure(reason)
1052
def run(self, result=None):
1053
if result is None: result = self.defaultTestResult()
1054
for feature in getattr(self, '_test_needs_features', []):
1055
if not feature.available():
1056
result.startTest(self)
1057
if getattr(result, 'addNotSupported', None):
1058
result.addNotSupported(self, feature)
1060
result.addSuccess(self)
1061
result.stopTest(self)
1063
return unittest.TestCase.run(self, result)
1067
unittest.TestCase.tearDown(self)
1069
def time(self, callable, *args, **kwargs):
1070
"""Run callable and accrue the time it takes to the benchmark time.
1072
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1073
this will cause lsprofile statistics to be gathered and stored in
1076
if self._benchtime is None:
1080
if not self._gather_lsprof_in_benchmarks:
1081
return callable(*args, **kwargs)
1083
# record this benchmark
1084
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1086
self._benchcalls.append(((callable, args, kwargs), stats))
1089
self._benchtime += time.time() - start
1091
def _runCleanups(self):
1092
"""Run registered cleanup functions.
1094
This should only be called from TestCase.tearDown.
1096
# TODO: Perhaps this should keep running cleanups even if
1097
# one of them fails?
1099
# Actually pop the cleanups from the list so tearDown running
1100
# twice is safe (this happens for skipped tests).
1101
while self._cleanups:
1102
self._cleanups.pop()()
1104
def log(self, *args):
1107
def _get_log(self, keep_log_file=False):
1108
"""Return as a string the log for this test. If the file is still
1109
on disk and keep_log_file=False, delete the log file and store the
1110
content in self._log_contents."""
1111
# flush the log file, to get all content
1113
bzrlib.trace._trace_file.flush()
1114
if self._log_contents:
1115
return self._log_contents
1116
if self._log_file_name is not None:
1117
logfile = open(self._log_file_name)
1119
log_contents = logfile.read()
1122
if not keep_log_file:
1123
self._log_contents = log_contents
1125
os.remove(self._log_file_name)
1127
if sys.platform == 'win32' and e.errno == errno.EACCES:
1128
print >>sys.stderr, ('Unable to delete log file '
1129
' %r' % self._log_file_name)
1134
return "DELETED log file to reduce memory footprint"
1136
def capture(self, cmd, retcode=0):
1137
"""Shortcut that splits cmd into words, runs, and returns stdout"""
1138
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
1140
def requireFeature(self, feature):
1141
"""This test requires a specific feature is available.
1143
:raises UnavailableFeature: When feature is not available.
1145
if not feature.available():
1146
raise UnavailableFeature(feature)
1148
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
1150
"""Invoke bzr and return (stdout, stderr).
1152
Useful for code that wants to check the contents of the
1153
output, the way error messages are presented, etc.
1155
This should be the main method for tests that want to exercise the
1156
overall behavior of the bzr application (rather than a unit test
1157
or a functional test of the library.)
1159
Much of the old code runs bzr by forking a new copy of Python, but
1160
that is slower, harder to debug, and generally not necessary.
1162
This runs bzr through the interface that catches and reports
1163
errors, and with logging set to something approximating the
1164
default, so that error reporting can be checked.
1166
:param argv: arguments to invoke bzr
1167
:param retcode: expected return code, or None for don't-care.
1168
:param encoding: encoding for sys.stdout and sys.stderr
1169
:param stdin: A string to be used as stdin for the command.
1170
:param working_dir: Change to this directory before running
1172
if encoding is None:
1173
encoding = bzrlib.user_encoding
1174
stdout = StringIOWrapper()
1175
stderr = StringIOWrapper()
1176
stdout.encoding = encoding
1177
stderr.encoding = encoding
1179
self.log('run bzr: %r', argv)
1180
# FIXME: don't call into logging here
1181
handler = logging.StreamHandler(stderr)
1182
handler.setLevel(logging.INFO)
1183
logger = logging.getLogger('')
1184
logger.addHandler(handler)
1185
old_ui_factory = ui.ui_factory
1186
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1189
if working_dir is not None:
1190
cwd = osutils.getcwd()
1191
os.chdir(working_dir)
1194
saved_debug_flags = frozenset(debug.debug_flags)
1195
debug.debug_flags.clear()
1197
result = self.apply_redirected(ui.ui_factory.stdin,
1199
bzrlib.commands.run_bzr_catch_errors,
1202
debug.debug_flags.update(saved_debug_flags)
1204
logger.removeHandler(handler)
1205
ui.ui_factory = old_ui_factory
1209
out = stdout.getvalue()
1210
err = stderr.getvalue()
1212
self.log('output:\n%r', out)
1214
self.log('errors:\n%r', err)
1215
if retcode is not None:
1216
self.assertEquals(retcode, result)
1219
def run_bzr(self, *args, **kwargs):
1220
"""Invoke bzr, as if it were run from the command line.
1222
This should be the main method for tests that want to exercise the
1223
overall behavior of the bzr application (rather than a unit test
1224
or a functional test of the library.)
1226
This sends the stdout/stderr results into the test's log,
1227
where it may be useful for debugging. See also run_captured.
1229
:param stdin: A string to be used as stdin for the command.
1230
:param retcode: The status code the command should return
1231
:param working_dir: The directory to run the command in
1233
retcode = kwargs.pop('retcode', 0)
1234
encoding = kwargs.pop('encoding', None)
1235
stdin = kwargs.pop('stdin', None)
1236
working_dir = kwargs.pop('working_dir', None)
1237
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding,
1238
stdin=stdin, working_dir=working_dir)
1240
def run_bzr_decode(self, *args, **kwargs):
1241
if 'encoding' in kwargs:
1242
encoding = kwargs['encoding']
1244
encoding = bzrlib.user_encoding
1245
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1247
def run_bzr_error(self, error_regexes, *args, **kwargs):
1248
"""Run bzr, and check that stderr contains the supplied regexes
1250
:param error_regexes: Sequence of regular expressions which
1251
must each be found in the error output. The relative ordering
1253
:param args: command-line arguments for bzr
1254
:param kwargs: Keyword arguments which are interpreted by run_bzr
1255
This function changes the default value of retcode to be 3,
1256
since in most cases this is run when you expect bzr to fail.
1257
:return: (out, err) The actual output of running the command (in case you
1258
want to do more inspection)
1261
# Make sure that commit is failing because there is nothing to do
1262
self.run_bzr_error(['no changes to commit'],
1263
'commit', '-m', 'my commit comment')
1264
# Make sure --strict is handling an unknown file, rather than
1265
# giving us the 'nothing to do' error
1266
self.build_tree(['unknown'])
1267
self.run_bzr_error(['Commit refused because there are unknown files'],
1268
'commit', '--strict', '-m', 'my commit comment')
1270
kwargs.setdefault('retcode', 3)
1271
out, err = self.run_bzr(*args, **kwargs)
1272
for regex in error_regexes:
1273
self.assertContainsRe(err, regex)
1276
def run_bzr_subprocess(self, *args, **kwargs):
1277
"""Run bzr in a subprocess for testing.
1279
This starts a new Python interpreter and runs bzr in there.
1280
This should only be used for tests that have a justifiable need for
1281
this isolation: e.g. they are testing startup time, or signal
1282
handling, or early startup code, etc. Subprocess code can't be
1283
profiled or debugged so easily.
1285
:param retcode: The status code that is expected. Defaults to 0. If
1286
None is supplied, the status code is not checked.
1287
:param env_changes: A dictionary which lists changes to environment
1288
variables. A value of None will unset the env variable.
1289
The values must be strings. The change will only occur in the
1290
child, so you don't need to fix the environment after running.
1291
:param universal_newlines: Convert CRLF => LF
1292
:param allow_plugins: By default the subprocess is run with
1293
--no-plugins to ensure test reproducibility. Also, it is possible
1294
for system-wide plugins to create unexpected output on stderr,
1295
which can cause unnecessary test failures.
1297
env_changes = kwargs.get('env_changes', {})
1298
working_dir = kwargs.get('working_dir', None)
1299
allow_plugins = kwargs.get('allow_plugins', False)
1300
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1301
working_dir=working_dir,
1302
allow_plugins=allow_plugins)
1303
# We distinguish between retcode=None and retcode not passed.
1304
supplied_retcode = kwargs.get('retcode', 0)
1305
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1306
universal_newlines=kwargs.get('universal_newlines', False),
1309
def start_bzr_subprocess(self, process_args, env_changes=None,
1310
skip_if_plan_to_signal=False,
1312
allow_plugins=False):
1313
"""Start bzr in a subprocess for testing.
1315
This starts a new Python interpreter and runs bzr in there.
1316
This should only be used for tests that have a justifiable need for
1317
this isolation: e.g. they are testing startup time, or signal
1318
handling, or early startup code, etc. Subprocess code can't be
1319
profiled or debugged so easily.
1321
:param process_args: a list of arguments to pass to the bzr executable,
1322
for example `['--version']`.
1323
:param env_changes: A dictionary which lists changes to environment
1324
variables. A value of None will unset the env variable.
1325
The values must be strings. The change will only occur in the
1326
child, so you don't need to fix the environment after running.
1327
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1329
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1331
:returns: Popen object for the started process.
1333
if skip_if_plan_to_signal:
1334
if not getattr(os, 'kill', None):
1335
raise TestSkipped("os.kill not available.")
1337
if env_changes is None:
1341
def cleanup_environment():
1342
for env_var, value in env_changes.iteritems():
1343
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1345
def restore_environment():
1346
for env_var, value in old_env.iteritems():
1347
osutils.set_or_unset_env(env_var, value)
1349
bzr_path = self.get_bzr_path()
1352
if working_dir is not None:
1353
cwd = osutils.getcwd()
1354
os.chdir(working_dir)
1357
# win32 subprocess doesn't support preexec_fn
1358
# so we will avoid using it on all platforms, just to
1359
# make sure the code path is used, and we don't break on win32
1360
cleanup_environment()
1361
command = [sys.executable, bzr_path]
1362
if not allow_plugins:
1363
command.append('--no-plugins')
1364
command.extend(process_args)
1365
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1367
restore_environment()
1373
def _popen(self, *args, **kwargs):
1374
"""Place a call to Popen.
1376
Allows tests to override this method to intercept the calls made to
1377
Popen for introspection.
1379
return Popen(*args, **kwargs)
1381
def get_bzr_path(self):
1382
"""Return the path of the 'bzr' executable for this test suite."""
1383
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1384
if not os.path.isfile(bzr_path):
1385
# We are probably installed. Assume sys.argv is the right file
1386
bzr_path = sys.argv[0]
1389
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1390
universal_newlines=False, process_args=None):
1391
"""Finish the execution of process.
1393
:param process: the Popen object returned from start_bzr_subprocess.
1394
:param retcode: The status code that is expected. Defaults to 0. If
1395
None is supplied, the status code is not checked.
1396
:param send_signal: an optional signal to send to the process.
1397
:param universal_newlines: Convert CRLF => LF
1398
:returns: (stdout, stderr)
1400
if send_signal is not None:
1401
os.kill(process.pid, send_signal)
1402
out, err = process.communicate()
1404
if universal_newlines:
1405
out = out.replace('\r\n', '\n')
1406
err = err.replace('\r\n', '\n')
1408
if retcode is not None and retcode != process.returncode:
1409
if process_args is None:
1410
process_args = "(unknown args)"
1411
mutter('Output of bzr %s:\n%s', process_args, out)
1412
mutter('Error for bzr %s:\n%s', process_args, err)
1413
self.fail('Command bzr %s failed with retcode %s != %s'
1414
% (process_args, retcode, process.returncode))
1417
def check_inventory_shape(self, inv, shape):
1418
"""Compare an inventory to a list of expected names.
1420
Fail if they are not precisely equal.
1423
shape = list(shape) # copy
1424
for path, ie in inv.entries():
1425
name = path.replace('\\', '/')
1426
if ie.kind == 'dir':
1433
self.fail("expected paths not found in inventory: %r" % shape)
1435
self.fail("unexpected paths found in inventory: %r" % extras)
1437
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1438
a_callable=None, *args, **kwargs):
1439
"""Call callable with redirected std io pipes.
1441
Returns the return code."""
1442
if not callable(a_callable):
1443
raise ValueError("a_callable must be callable.")
1445
stdin = StringIO("")
1447
if getattr(self, "_log_file", None) is not None:
1448
stdout = self._log_file
1452
if getattr(self, "_log_file", None is not None):
1453
stderr = self._log_file
1456
real_stdin = sys.stdin
1457
real_stdout = sys.stdout
1458
real_stderr = sys.stderr
1463
return a_callable(*args, **kwargs)
1465
sys.stdout = real_stdout
1466
sys.stderr = real_stderr
1467
sys.stdin = real_stdin
1469
@symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
1470
def merge(self, branch_from, wt_to):
1471
"""A helper for tests to do a ui-less merge.
1473
This should move to the main library when someone has time to integrate
1476
# minimal ui-less merge.
1477
wt_to.branch.fetch(branch_from)
1478
base_rev = common_ancestor(branch_from.last_revision(),
1479
wt_to.branch.last_revision(),
1480
wt_to.branch.repository)
1481
merge_inner(wt_to.branch, branch_from.basis_tree(),
1482
wt_to.branch.repository.revision_tree(base_rev),
1484
wt_to.add_parent_tree_id(branch_from.last_revision())
1487
BzrTestBase = TestCase
1490
class TestCaseWithMemoryTransport(TestCase):
1491
"""Common test class for tests that do not need disk resources.
1493
Tests that need disk resources should derive from TestCaseWithTransport.
1495
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1497
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1498
a directory which does not exist. This serves to help ensure test isolation
1499
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1500
must exist. However, TestCaseWithMemoryTransport does not offer local
1501
file defaults for the transport in tests, nor does it obey the command line
1502
override, so tests that accidentally write to the common directory should
1510
def __init__(self, methodName='runTest'):
1511
# allow test parameterisation after test construction and before test
1512
# execution. Variables that the parameteriser sets need to be
1513
# ones that are not set by setUp, or setUp will trash them.
1514
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1515
self.transport_server = default_transport
1516
self.transport_readonly_server = None
1518
def get_transport(self):
1519
"""Return a writeable transport for the test scratch space"""
1520
t = get_transport(self.get_url())
1521
self.assertFalse(t.is_readonly())
1524
def get_readonly_transport(self):
1525
"""Return a readonly transport for the test scratch space
1527
This can be used to test that operations which should only need
1528
readonly access in fact do not try to write.
1530
t = get_transport(self.get_readonly_url())
1531
self.assertTrue(t.is_readonly())
1534
def create_transport_readonly_server(self):
1535
"""Create a transport server from class defined at init.
1537
This is mostly a hook for daughter classes.
1539
return self.transport_readonly_server()
1541
def get_readonly_server(self):
1542
"""Get the server instance for the readonly transport
1544
This is useful for some tests with specific servers to do diagnostics.
1546
if self.__readonly_server is None:
1547
if self.transport_readonly_server is None:
1548
# readonly decorator requested
1549
# bring up the server
1551
self.__readonly_server = ReadonlyServer()
1552
self.__readonly_server.setUp(self.__server)
1554
self.__readonly_server = self.create_transport_readonly_server()
1555
self.__readonly_server.setUp()
1556
self.addCleanup(self.__readonly_server.tearDown)
1557
return self.__readonly_server
1559
def get_readonly_url(self, relpath=None):
1560
"""Get a URL for the readonly transport.
1562
This will either be backed by '.' or a decorator to the transport
1563
used by self.get_url()
1564
relpath provides for clients to get a path relative to the base url.
1565
These should only be downwards relative, not upwards.
1567
base = self.get_readonly_server().get_url()
1568
if relpath is not None:
1569
if not base.endswith('/'):
1571
base = base + relpath
1574
def get_server(self):
1575
"""Get the read/write server instance.
1577
This is useful for some tests with specific servers that need
1580
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1581
is no means to override it.
1583
if self.__server is None:
1584
self.__server = MemoryServer()
1585
self.__server.setUp()
1586
self.addCleanup(self.__server.tearDown)
1587
return self.__server
1589
def get_url(self, relpath=None):
1590
"""Get a URL (or maybe a path) for the readwrite transport.
1592
This will either be backed by '.' or to an equivalent non-file based
1594
relpath provides for clients to get a path relative to the base url.
1595
These should only be downwards relative, not upwards.
1597
base = self.get_server().get_url()
1598
if relpath is not None and relpath != '.':
1599
if not base.endswith('/'):
1601
# XXX: Really base should be a url; we did after all call
1602
# get_url()! But sometimes it's just a path (from
1603
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1604
# to a non-escaped local path.
1605
if base.startswith('./') or base.startswith('/'):
1608
base += urlutils.escape(relpath)
1611
def _make_test_root(self):
1612
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1616
root = u'test%04d.tmp' % i
1620
if e.errno == errno.EEXIST:
1625
# successfully created
1626
TestCaseWithMemoryTransport.TEST_ROOT = osutils.abspath(root)
1628
# make a fake bzr directory there to prevent any tests propagating
1629
# up onto the source directory's real branch
1630
bzrdir.BzrDir.create_standalone_workingtree(
1631
TestCaseWithMemoryTransport.TEST_ROOT)
1633
def makeAndChdirToTestDir(self):
1634
"""Create a temporary directories for this one test.
1636
This must set self.test_home_dir and self.test_dir and chdir to
1639
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1641
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1642
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1643
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1645
def make_branch(self, relpath, format=None):
1646
"""Create a branch on the transport at relpath."""
1647
repo = self.make_repository(relpath, format=format)
1648
return repo.bzrdir.create_branch()
1650
def make_bzrdir(self, relpath, format=None):
1652
# might be a relative or absolute path
1653
maybe_a_url = self.get_url(relpath)
1654
segments = maybe_a_url.rsplit('/', 1)
1655
t = get_transport(maybe_a_url)
1656
if len(segments) > 1 and segments[-1] not in ('', '.'):
1659
except errors.FileExists:
1663
if isinstance(format, basestring):
1664
format = bzrdir.format_registry.make_bzrdir(format)
1665
return format.initialize_on_transport(t)
1666
except errors.UninitializableFormat:
1667
raise TestSkipped("Format %s is not initializable." % format)
1669
def make_repository(self, relpath, shared=False, format=None):
1670
"""Create a repository on our default transport at relpath."""
1671
made_control = self.make_bzrdir(relpath, format=format)
1672
return made_control.create_repository(shared=shared)
1674
def make_branch_and_memory_tree(self, relpath, format=None):
1675
"""Create a branch on the default transport and a MemoryTree for it."""
1676
b = self.make_branch(relpath, format=format)
1677
return memorytree.MemoryTree.create_on_branch(b)
1679
def overrideEnvironmentForTesting(self):
1680
os.environ['HOME'] = self.test_home_dir
1681
os.environ['BZR_HOME'] = self.test_home_dir
1684
super(TestCaseWithMemoryTransport, self).setUp()
1685
self._make_test_root()
1686
_currentdir = os.getcwdu()
1687
def _leaveDirectory():
1688
os.chdir(_currentdir)
1689
self.addCleanup(_leaveDirectory)
1690
self.makeAndChdirToTestDir()
1691
self.overrideEnvironmentForTesting()
1692
self.__readonly_server = None
1693
self.__server = None
1696
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1697
"""Derived class that runs a test within a temporary directory.
1699
This is useful for tests that need to create a branch, etc.
1701
The directory is created in a slightly complex way: for each
1702
Python invocation, a new temporary top-level directory is created.
1703
All test cases create their own directory within that. If the
1704
tests complete successfully, the directory is removed.
1706
InTempDir is an old alias for FunctionalTestCase.
1709
OVERRIDE_PYTHON = 'python'
1711
def check_file_contents(self, filename, expect):
1712
self.log("check contents of file %s" % filename)
1713
contents = file(filename, 'r').read()
1714
if contents != expect:
1715
self.log("expected: %r" % expect)
1716
self.log("actually: %r" % contents)
1717
self.fail("contents of %s not as expected" % filename)
1719
def makeAndChdirToTestDir(self):
1720
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1722
For TestCaseInTempDir we create a temporary directory based on the test
1723
name and then create two subdirs - test and home under it.
1725
if NUMBERED_DIRS: # strongly recommended on Windows
1726
# due the path length limitation (260 chars)
1727
candidate_dir = '%s/%dK/%05d' % (self.TEST_ROOT,
1728
int(self.number/1000),
1730
os.makedirs(candidate_dir)
1731
self.test_home_dir = candidate_dir + '/home'
1732
os.mkdir(self.test_home_dir)
1733
self.test_dir = candidate_dir + '/work'
1734
os.mkdir(self.test_dir)
1735
os.chdir(self.test_dir)
1736
# put name of test inside
1737
f = file(candidate_dir + '/name', 'w')
1742
# shorten the name, to avoid test failures due to path length
1743
short_id = self.id().replace('bzrlib.tests.', '') \
1744
.replace('__main__.', '')[-100:]
1745
# it's possible the same test class is run several times for
1746
# parameterized tests, so make sure the names don't collide.
1750
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1752
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1753
if os.path.exists(candidate_dir):
1757
os.mkdir(candidate_dir)
1758
self.test_home_dir = candidate_dir + '/home'
1759
os.mkdir(self.test_home_dir)
1760
self.test_dir = candidate_dir + '/work'
1761
os.mkdir(self.test_dir)
1762
os.chdir(self.test_dir)
1765
def build_tree(self, shape, line_endings='binary', transport=None):
1766
"""Build a test tree according to a pattern.
1768
shape is a sequence of file specifications. If the final
1769
character is '/', a directory is created.
1771
This assumes that all the elements in the tree being built are new.
1773
This doesn't add anything to a branch.
1774
:param line_endings: Either 'binary' or 'native'
1775
in binary mode, exact contents are written
1776
in native mode, the line endings match the
1777
default platform endings.
1779
:param transport: A transport to write to, for building trees on
1780
VFS's. If the transport is readonly or None,
1781
"." is opened automatically.
1783
# It's OK to just create them using forward slashes on windows.
1784
if transport is None or transport.is_readonly():
1785
transport = get_transport(".")
1787
self.assert_(isinstance(name, basestring))
1789
transport.mkdir(urlutils.escape(name[:-1]))
1791
if line_endings == 'binary':
1793
elif line_endings == 'native':
1796
raise errors.BzrError(
1797
'Invalid line ending request %r' % line_endings)
1798
content = "contents of %s%s" % (name.encode('utf-8'), end)
1799
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1801
def build_tree_contents(self, shape):
1802
build_tree_contents(shape)
1804
def assertFileEqual(self, content, path):
1805
"""Fail if path does not contain 'content'."""
1806
self.failUnlessExists(path)
1807
# TODO: jam 20060427 Shouldn't this be 'rb'?
1813
self.assertEqualDiff(content, s)
1815
def failUnlessExists(self, path):
1816
"""Fail unless path, which may be abs or relative, exists."""
1817
self.failUnless(osutils.lexists(path),path+" does not exist")
1819
def failIfExists(self, path):
1820
"""Fail if path, which may be abs or relative, exists."""
1821
self.failIf(osutils.lexists(path),path+" exists")
1824
class TestCaseWithTransport(TestCaseInTempDir):
1825
"""A test case that provides get_url and get_readonly_url facilities.
1827
These back onto two transport servers, one for readonly access and one for
1830
If no explicit class is provided for readonly access, a
1831
ReadonlyTransportDecorator is used instead which allows the use of non disk
1832
based read write transports.
1834
If an explicit class is provided for readonly access, that server and the
1835
readwrite one must both define get_url() as resolving to os.getcwd().
1838
def create_transport_server(self):
1839
"""Create a transport server from class defined at init.
1841
This is mostly a hook for daughter classes.
1843
return self.transport_server()
1845
def get_server(self):
1846
"""See TestCaseWithMemoryTransport.
1848
This is useful for some tests with specific servers that need
1851
if self.__server is None:
1852
self.__server = self.create_transport_server()
1853
self.__server.setUp()
1854
self.addCleanup(self.__server.tearDown)
1855
return self.__server
1857
def make_branch_and_tree(self, relpath, format=None):
1858
"""Create a branch on the transport and a tree locally.
1860
If the transport is not a LocalTransport, the Tree can't be created on
1861
the transport. In that case the working tree is created in the local
1862
directory, and the returned tree's branch and repository will also be
1865
This will fail if the original default transport for this test
1866
case wasn't backed by the working directory, as the branch won't
1867
be on disk for us to open it.
1869
:param format: The BzrDirFormat.
1870
:returns: the WorkingTree.
1872
# TODO: always use the local disk path for the working tree,
1873
# this obviously requires a format that supports branch references
1874
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
1876
b = self.make_branch(relpath, format=format)
1878
return b.bzrdir.create_workingtree()
1879
except errors.NotLocalUrl:
1880
# We can only make working trees locally at the moment. If the
1881
# transport can't support them, then reopen the branch on a local
1882
# transport, and create the working tree there.
1884
# Possibly we should instead keep
1885
# the non-disk-backed branch and create a local checkout?
1886
bd = bzrdir.BzrDir.open(relpath)
1887
return bd.create_workingtree()
1889
def assertIsDirectory(self, relpath, transport):
1890
"""Assert that relpath within transport is a directory.
1892
This may not be possible on all transports; in that case it propagates
1893
a TransportNotPossible.
1896
mode = transport.stat(relpath).st_mode
1897
except errors.NoSuchFile:
1898
self.fail("path %s is not a directory; no such file"
1900
if not stat.S_ISDIR(mode):
1901
self.fail("path %s is not a directory; has mode %#o"
1904
def assertTreesEqual(self, left, right):
1905
"""Check that left and right have the same content and properties."""
1906
# we use a tree delta to check for equality of the content, and we
1907
# manually check for equality of other things such as the parents list.
1908
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
1909
differences = left.changes_from(right)
1910
self.assertFalse(differences.has_changed(),
1911
"Trees %r and %r are different: %r" % (left, right, differences))
1914
super(TestCaseWithTransport, self).setUp()
1915
self.__server = None
1918
class ChrootedTestCase(TestCaseWithTransport):
1919
"""A support class that provides readonly urls outside the local namespace.
1921
This is done by checking if self.transport_server is a MemoryServer. if it
1922
is then we are chrooted already, if it is not then an HttpServer is used
1925
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1926
be used without needed to redo it when a different
1927
subclass is in use ?
1931
super(ChrootedTestCase, self).setUp()
1932
if not self.transport_server == MemoryServer:
1933
self.transport_readonly_server = HttpServer
1936
def filter_suite_by_re(suite, pattern):
1937
result = TestUtil.TestSuite()
1938
filter_re = re.compile(pattern)
1939
for test in iter_suite_tests(suite):
1940
if filter_re.search(test.id()):
1941
result.addTest(test)
1945
def sort_suite_by_re(suite, pattern):
1948
filter_re = re.compile(pattern)
1949
for test in iter_suite_tests(suite):
1950
if filter_re.search(test.id()):
1954
return TestUtil.TestSuite(first + second)
1957
def run_suite(suite, name='test', verbose=False, pattern=".*",
1958
stop_on_failure=False, keep_output=False,
1959
transport=None, lsprof_timed=None, bench_history=None,
1960
matching_tests_first=None,
1961
numbered_dirs=None):
1962
global NUMBERED_DIRS
1963
if numbered_dirs is not None:
1964
NUMBERED_DIRS = bool(numbered_dirs)
1966
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1971
runner = TextTestRunner(stream=sys.stdout,
1973
verbosity=verbosity,
1974
keep_output=keep_output,
1975
bench_history=bench_history)
1976
runner.stop_on_failure=stop_on_failure
1978
if matching_tests_first:
1979
suite = sort_suite_by_re(suite, pattern)
1981
suite = filter_suite_by_re(suite, pattern)
1982
result = runner.run(suite)
1983
return result.wasSuccessful()
1986
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1989
test_suite_factory=None,
1992
matching_tests_first=None,
1993
numbered_dirs=None):
1994
"""Run the whole test suite under the enhanced runner"""
1995
# XXX: Very ugly way to do this...
1996
# Disable warning about old formats because we don't want it to disturb
1997
# any blackbox tests.
1998
from bzrlib import repository
1999
repository._deprecation_warning_done = True
2001
global default_transport
2002
if transport is None:
2003
transport = default_transport
2004
old_transport = default_transport
2005
default_transport = transport
2007
if test_suite_factory is None:
2008
suite = test_suite()
2010
suite = test_suite_factory()
2011
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2012
stop_on_failure=stop_on_failure, keep_output=keep_output,
2013
transport=transport,
2014
lsprof_timed=lsprof_timed,
2015
bench_history=bench_history,
2016
matching_tests_first=matching_tests_first,
2017
numbered_dirs=numbered_dirs)
2019
default_transport = old_transport
2023
"""Build and return TestSuite for the whole of bzrlib.
2025
This function can be replaced if you need to change the default test
2026
suite on a global basis, but it is not encouraged.
2029
'bzrlib.tests.test_ancestry',
2030
'bzrlib.tests.test_annotate',
2031
'bzrlib.tests.test_api',
2032
'bzrlib.tests.test_atomicfile',
2033
'bzrlib.tests.test_bad_files',
2034
'bzrlib.tests.test_branch',
2035
'bzrlib.tests.test_bundle',
2036
'bzrlib.tests.test_bzrdir',
2037
'bzrlib.tests.test_cache_utf8',
2038
'bzrlib.tests.test_commands',
2039
'bzrlib.tests.test_commit',
2040
'bzrlib.tests.test_commit_merge',
2041
'bzrlib.tests.test_config',
2042
'bzrlib.tests.test_conflicts',
2043
'bzrlib.tests.test_decorators',
2044
'bzrlib.tests.test_delta',
2045
'bzrlib.tests.test_diff',
2046
'bzrlib.tests.test_dirstate',
2047
'bzrlib.tests.test_doc_generate',
2048
'bzrlib.tests.test_errors',
2049
'bzrlib.tests.test_escaped_store',
2050
'bzrlib.tests.test_extract',
2051
'bzrlib.tests.test_fetch',
2052
'bzrlib.tests.test_ftp_transport',
2053
'bzrlib.tests.test_generate_docs',
2054
'bzrlib.tests.test_generate_ids',
2055
'bzrlib.tests.test_globbing',
2056
'bzrlib.tests.test_gpg',
2057
'bzrlib.tests.test_graph',
2058
'bzrlib.tests.test_hashcache',
2059
'bzrlib.tests.test_http',
2060
'bzrlib.tests.test_http_response',
2061
'bzrlib.tests.test_https_ca_bundle',
2062
'bzrlib.tests.test_identitymap',
2063
'bzrlib.tests.test_ignores',
2064
'bzrlib.tests.test_inv',
2065
'bzrlib.tests.test_knit',
2066
'bzrlib.tests.test_lazy_import',
2067
'bzrlib.tests.test_lazy_regex',
2068
'bzrlib.tests.test_lockdir',
2069
'bzrlib.tests.test_lockable_files',
2070
'bzrlib.tests.test_log',
2071
'bzrlib.tests.test_memorytree',
2072
'bzrlib.tests.test_merge',
2073
'bzrlib.tests.test_merge3',
2074
'bzrlib.tests.test_merge_core',
2075
'bzrlib.tests.test_merge_directive',
2076
'bzrlib.tests.test_missing',
2077
'bzrlib.tests.test_msgeditor',
2078
'bzrlib.tests.test_nonascii',
2079
'bzrlib.tests.test_options',
2080
'bzrlib.tests.test_osutils',
2081
'bzrlib.tests.test_osutils_encodings',
2082
'bzrlib.tests.test_patch',
2083
'bzrlib.tests.test_patches',
2084
'bzrlib.tests.test_permissions',
2085
'bzrlib.tests.test_plugins',
2086
'bzrlib.tests.test_progress',
2087
'bzrlib.tests.test_reconcile',
2088
'bzrlib.tests.test_registry',
2089
'bzrlib.tests.test_repository',
2090
'bzrlib.tests.test_revert',
2091
'bzrlib.tests.test_revision',
2092
'bzrlib.tests.test_revisionnamespaces',
2093
'bzrlib.tests.test_revisiontree',
2094
'bzrlib.tests.test_rio',
2095
'bzrlib.tests.test_sampler',
2096
'bzrlib.tests.test_selftest',
2097
'bzrlib.tests.test_setup',
2098
'bzrlib.tests.test_sftp_transport',
2099
'bzrlib.tests.test_smart_add',
2100
'bzrlib.tests.test_smart_transport',
2101
'bzrlib.tests.test_source',
2102
'bzrlib.tests.test_ssh_transport',
2103
'bzrlib.tests.test_status',
2104
'bzrlib.tests.test_store',
2105
'bzrlib.tests.test_strace',
2106
'bzrlib.tests.test_subsume',
2107
'bzrlib.tests.test_symbol_versioning',
2108
'bzrlib.tests.test_tag',
2109
'bzrlib.tests.test_testament',
2110
'bzrlib.tests.test_textfile',
2111
'bzrlib.tests.test_textmerge',
2112
'bzrlib.tests.test_timestamp',
2113
'bzrlib.tests.test_trace',
2114
'bzrlib.tests.test_transactions',
2115
'bzrlib.tests.test_transform',
2116
'bzrlib.tests.test_transport',
2117
'bzrlib.tests.test_tree',
2118
'bzrlib.tests.test_treebuilder',
2119
'bzrlib.tests.test_tsort',
2120
'bzrlib.tests.test_tuned_gzip',
2121
'bzrlib.tests.test_ui',
2122
'bzrlib.tests.test_upgrade',
2123
'bzrlib.tests.test_urlutils',
2124
'bzrlib.tests.test_versionedfile',
2125
'bzrlib.tests.test_version',
2126
'bzrlib.tests.test_version_info',
2127
'bzrlib.tests.test_weave',
2128
'bzrlib.tests.test_whitebox',
2129
'bzrlib.tests.test_workingtree',
2130
'bzrlib.tests.test_workingtree_4',
2131
'bzrlib.tests.test_wsgi',
2132
'bzrlib.tests.test_xml',
2134
test_transport_implementations = [
2135
'bzrlib.tests.test_transport_implementations',
2136
'bzrlib.tests.test_read_bundle',
2138
suite = TestUtil.TestSuite()
2139
loader = TestUtil.TestLoader()
2140
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2141
from bzrlib.transport import TransportTestProviderAdapter
2142
adapter = TransportTestProviderAdapter()
2143
adapt_modules(test_transport_implementations, adapter, loader, suite)
2144
for package in packages_to_test():
2145
suite.addTest(package.test_suite())
2146
for m in MODULES_TO_TEST:
2147
suite.addTest(loader.loadTestsFromModule(m))
2148
for m in MODULES_TO_DOCTEST:
2150
suite.addTest(doctest.DocTestSuite(m))
2151
except ValueError, e:
2152
print '**failed to get doctest for: %s\n%s' %(m,e)
2154
for name, plugin in bzrlib.plugin.all_plugins().items():
2155
if getattr(plugin, 'test_suite', None) is not None:
2156
default_encoding = sys.getdefaultencoding()
2158
plugin_suite = plugin.test_suite()
2159
except ImportError, e:
2160
bzrlib.trace.warning(
2161
'Unable to test plugin "%s": %s', name, e)
2163
suite.addTest(plugin_suite)
2164
if default_encoding != sys.getdefaultencoding():
2165
bzrlib.trace.warning(
2166
'Plugin "%s" tried to reset default encoding to: %s', name,
2167
sys.getdefaultencoding())
2169
sys.setdefaultencoding(default_encoding)
2173
def adapt_modules(mods_list, adapter, loader, suite):
2174
"""Adapt the modules in mods_list using adapter and add to suite."""
2175
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2176
suite.addTests(adapter.adapt(test))
2179
def clean_selftest_output(root=None, quiet=False):
2180
"""Remove all selftest output directories from root directory.
2182
:param root: root directory for clean
2183
(if ommitted or None then clean current directory).
2184
:param quiet: suppress report about deleting directories
2189
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
2192
for i in os.listdir(root):
2193
if os.path.isdir(i) and re_dir.match(i):
2195
print 'delete directory:', i
2199
class Feature(object):
2200
"""An operating system Feature."""
2203
self._available = None
2205
def available(self):
2206
"""Is the feature available?
2208
:return: True if the feature is available.
2210
if self._available is None:
2211
self._available = self._probe()
2212
return self._available
2215
"""Implement this method in concrete features.
2217
:return: True if the feature is available.
2219
raise NotImplementedError
2222
if getattr(self, 'feature_name', None):
2223
return self.feature_name()
2224
return self.__class__.__name__
added
removed
bzrlib/tests/__init__.py
