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
59
import bzrlib.commands
60
import bzrlib.timestamp
62
import bzrlib.inventory
63
import bzrlib.iterablefile
68
# lsprof not available
70
from bzrlib.merge import merge_inner
74
from bzrlib.revision import common_ancestor
76
from bzrlib import symbol_versioning
78
from bzrlib.transport import get_transport
79
import bzrlib.transport
80
from bzrlib.transport.local import LocalURLServer
81
from bzrlib.transport.memory import MemoryServer
82
from bzrlib.transport.readonly import ReadonlyServer
83
from bzrlib.trace import mutter, note
84
from bzrlib.tests import TestUtil
85
from bzrlib.tests.HttpServer import HttpServer
86
from bzrlib.tests.TestUtil import (
90
from bzrlib.tests.treeshape import build_tree_contents
91
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
93
# Mark this python module as being part of the implementation
94
# of unittest: this gives us better tracebacks where the last
95
# shown frame is the test code, not our assertXYZ.
98
default_transport = LocalURLServer
101
MODULES_TO_DOCTEST = [
114
def packages_to_test():
115
"""Return a list of packages to test.
117
The packages are not globally imported so that import failures are
118
triggered when running selftest, not when importing the command.
121
import bzrlib.tests.blackbox
122
import bzrlib.tests.branch_implementations
123
import bzrlib.tests.bzrdir_implementations
124
import bzrlib.tests.interrepository_implementations
125
import bzrlib.tests.interversionedfile_implementations
126
import bzrlib.tests.intertree_implementations
127
import bzrlib.tests.per_lock
128
import bzrlib.tests.repository_implementations
129
import bzrlib.tests.revisionstore_implementations
130
import bzrlib.tests.tree_implementations
131
import bzrlib.tests.workingtree_implementations
134
bzrlib.tests.blackbox,
135
bzrlib.tests.branch_implementations,
136
bzrlib.tests.bzrdir_implementations,
137
bzrlib.tests.interrepository_implementations,
138
bzrlib.tests.interversionedfile_implementations,
139
bzrlib.tests.intertree_implementations,
140
bzrlib.tests.per_lock,
141
bzrlib.tests.repository_implementations,
142
bzrlib.tests.revisionstore_implementations,
143
bzrlib.tests.tree_implementations,
144
bzrlib.tests.workingtree_implementations,
148
class ExtendedTestResult(unittest._TextTestResult):
149
"""Accepts, reports and accumulates the results of running tests.
151
Compared to this unittest version this class adds support for profiling,
152
benchmarking, stopping as soon as a test fails, and skipping tests.
153
There are further-specialized subclasses for different types of display.
158
def __init__(self, stream, descriptions, verbosity,
161
use_numbered_dirs=False,
163
"""Construct new TestResult.
165
:param bench_history: Optionally, a writable file object to accumulate
168
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
169
if bench_history is not None:
170
from bzrlib.version import _get_bzr_source_tree
171
src_tree = _get_bzr_source_tree()
174
revision_id = src_tree.get_parent_ids()[0]
176
# XXX: if this is a brand new tree, do the same as if there
180
# XXX: If there's no branch, what should we do?
182
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
183
self._bench_history = bench_history
184
self.ui = ui.ui_factory
185
self.num_tests = num_tests
187
self.failure_count = 0
188
self.known_failure_count = 0
190
self.unsupported = {}
192
self.use_numbered_dirs = use_numbered_dirs
193
self._overall_start_time = time.time()
195
def extractBenchmarkTime(self, testCase):
196
"""Add a benchmark time for the current test case."""
197
self._benchmarkTime = getattr(testCase, "_benchtime", None)
199
def _elapsedTestTimeString(self):
200
"""Return a time string for the overall time the current test has taken."""
201
return self._formatTime(time.time() - self._start_time)
203
def _testTimeString(self):
204
if self._benchmarkTime is not None:
206
self._formatTime(self._benchmarkTime),
207
self._elapsedTestTimeString())
209
return " %s" % self._elapsedTestTimeString()
211
def _formatTime(self, seconds):
212
"""Format seconds as milliseconds with leading spaces."""
213
# some benchmarks can take thousands of seconds to run, so we need 8
215
return "%8dms" % (1000 * seconds)
217
def _shortened_test_description(self, test):
219
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
222
def startTest(self, test):
223
unittest.TestResult.startTest(self, test)
224
self.report_test_start(test)
225
test.number = self.count
226
self._recordTestStartTime()
228
def _recordTestStartTime(self):
229
"""Record that a test has started."""
230
self._start_time = time.time()
232
def _cleanupLogFile(self, test):
233
# We can only do this if we have one of our TestCases, not if
235
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
236
if setKeepLogfile is not None:
239
def addError(self, test, err):
240
self.extractBenchmarkTime(test)
241
self._cleanupLogFile(test)
242
if isinstance(err[1], TestSkipped):
243
return self.addSkipped(test, err)
244
elif isinstance(err[1], UnavailableFeature):
245
return self.addNotSupported(test, err[1].args[0])
246
unittest.TestResult.addError(self, test, err)
247
self.error_count += 1
248
self.report_error(test, err)
252
def addFailure(self, test, err):
253
self._cleanupLogFile(test)
254
self.extractBenchmarkTime(test)
255
if isinstance(err[1], KnownFailure):
256
return self.addKnownFailure(test, err)
257
unittest.TestResult.addFailure(self, test, err)
258
self.failure_count += 1
259
self.report_failure(test, err)
263
def addKnownFailure(self, test, err):
264
self.known_failure_count += 1
265
self.report_known_failure(test, err)
267
def addNotSupported(self, test, feature):
268
self.unsupported.setdefault(str(feature), 0)
269
self.unsupported[str(feature)] += 1
270
self.report_unsupported(test, feature)
272
def addSuccess(self, test):
273
self.extractBenchmarkTime(test)
274
if self._bench_history is not None:
275
if self._benchmarkTime is not None:
276
self._bench_history.write("%s %s\n" % (
277
self._formatTime(self._benchmarkTime),
279
self.report_success(test)
280
unittest.TestResult.addSuccess(self, test)
282
def addSkipped(self, test, skip_excinfo):
283
self.report_skip(test, skip_excinfo)
284
# seems best to treat this as success from point-of-view of unittest
285
# -- it actually does nothing so it barely matters :)
288
except KeyboardInterrupt:
291
self.addError(test, test.__exc_info())
293
unittest.TestResult.addSuccess(self, test)
295
def printErrorList(self, flavour, errors):
296
for test, err in errors:
297
self.stream.writeln(self.separator1)
298
self.stream.write("%s: " % flavour)
299
if self.use_numbered_dirs:
300
self.stream.write('#%d ' % test.number)
301
self.stream.writeln(self.getDescription(test))
302
if getattr(test, '_get_log', None) is not None:
304
print >>self.stream, \
305
('vvvv[log from %s]' % test.id()).ljust(78,'-')
306
print >>self.stream, test._get_log()
307
print >>self.stream, \
308
('^^^^[log from %s]' % test.id()).ljust(78,'-')
309
self.stream.writeln(self.separator2)
310
self.stream.writeln("%s" % err)
315
def report_cleaning_up(self):
318
def report_success(self, test):
322
class TextTestResult(ExtendedTestResult):
323
"""Displays progress and results of tests in text form"""
325
def __init__(self, stream, descriptions, verbosity,
329
use_numbered_dirs=False,
331
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
332
bench_history, num_tests, use_numbered_dirs)
334
self.pb = self.ui.nested_progress_bar()
335
self._supplied_pb = False
338
self._supplied_pb = True
339
self.pb.show_pct = False
340
self.pb.show_spinner = False
341
self.pb.show_eta = False,
342
self.pb.show_count = False
343
self.pb.show_bar = False
345
def report_starting(self):
346
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
348
def _progress_prefix_text(self):
349
a = '[%d' % self.count
350
if self.num_tests is not None:
351
a +='/%d' % self.num_tests
352
a += ' in %ds' % (time.time() - self._overall_start_time)
354
a += ', %d errors' % self.error_count
355
if self.failure_count:
356
a += ', %d failed' % self.failure_count
357
if self.known_failure_count:
358
a += ', %d known failures' % self.known_failure_count
360
a += ', %d skipped' % self.skip_count
362
a += ', %d missing features' % len(self.unsupported)
366
def report_test_start(self, test):
369
self._progress_prefix_text()
371
+ self._shortened_test_description(test))
373
def _test_description(self, test):
374
if self.use_numbered_dirs:
375
return '#%d %s' % (self.count,
376
self._shortened_test_description(test))
378
return self._shortened_test_description(test)
380
def report_error(self, test, err):
381
self.pb.note('ERROR: %s\n %s\n',
382
self._test_description(test),
386
def report_failure(self, test, err):
387
self.pb.note('FAIL: %s\n %s\n',
388
self._test_description(test),
392
def report_known_failure(self, test, err):
393
self.pb.note('XFAIL: %s\n%s\n',
394
self._test_description(test), err[1])
396
def report_skip(self, test, skip_excinfo):
399
# at the moment these are mostly not things we can fix
400
# and so they just produce stipple; use the verbose reporter
403
# show test and reason for skip
404
self.pb.note('SKIP: %s\n %s\n',
405
self._shortened_test_description(test),
408
# since the class name was left behind in the still-visible
410
self.pb.note('SKIP: %s', skip_excinfo[1])
412
def report_unsupported(self, test, feature):
413
"""test cannot be run because feature is missing."""
415
def report_cleaning_up(self):
416
self.pb.update('cleaning up...')
419
if not self._supplied_pb:
423
class VerboseTestResult(ExtendedTestResult):
424
"""Produce long output, with one line per test run plus times"""
426
def _ellipsize_to_right(self, a_string, final_width):
427
"""Truncate and pad a string, keeping the right hand side"""
428
if len(a_string) > final_width:
429
result = '...' + a_string[3-final_width:]
432
return result.ljust(final_width)
434
def report_starting(self):
435
self.stream.write('running %d tests...\n' % self.num_tests)
437
def report_test_start(self, test):
439
name = self._shortened_test_description(test)
440
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
441
# numbers, plus a trailing blank
442
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
443
if self.use_numbered_dirs:
444
self.stream.write('%5d ' % self.count)
445
self.stream.write(self._ellipsize_to_right(name,
446
osutils.terminal_width()-36))
448
self.stream.write(self._ellipsize_to_right(name,
449
osutils.terminal_width()-30))
452
def _error_summary(self, err):
454
if self.use_numbered_dirs:
456
return '%s%s' % (indent, err[1])
458
def report_error(self, test, err):
459
self.stream.writeln('ERROR %s\n%s'
460
% (self._testTimeString(),
461
self._error_summary(err)))
463
def report_failure(self, test, err):
464
self.stream.writeln(' FAIL %s\n%s'
465
% (self._testTimeString(),
466
self._error_summary(err)))
468
def report_known_failure(self, test, err):
469
self.stream.writeln('XFAIL %s\n%s'
470
% (self._testTimeString(),
471
self._error_summary(err)))
473
def report_success(self, test):
474
self.stream.writeln(' OK %s' % self._testTimeString())
475
for bench_called, stats in getattr(test, '_benchcalls', []):
476
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
477
stats.pprint(file=self.stream)
478
# flush the stream so that we get smooth output. This verbose mode is
479
# used to show the output in PQM.
482
def report_skip(self, test, skip_excinfo):
484
self.stream.writeln(' SKIP %s\n%s'
485
% (self._testTimeString(),
486
self._error_summary(skip_excinfo)))
488
def report_unsupported(self, test, feature):
489
"""test cannot be run because feature is missing."""
490
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
491
%(self._testTimeString(), feature))
495
class TextTestRunner(object):
496
stop_on_failure = False
504
use_numbered_dirs=False,
507
self.stream = unittest._WritelnDecorator(stream)
508
self.descriptions = descriptions
509
self.verbosity = verbosity
510
self.keep_output = keep_output
511
self._bench_history = bench_history
512
self.use_numbered_dirs = use_numbered_dirs
513
self.list_only = list_only
516
"Run the given test case or test suite."
517
startTime = time.time()
518
if self.verbosity == 1:
519
result_class = TextTestResult
520
elif self.verbosity >= 2:
521
result_class = VerboseTestResult
522
result = result_class(self.stream,
525
bench_history=self._bench_history,
526
num_tests=test.countTestCases(),
527
use_numbered_dirs=self.use_numbered_dirs,
529
result.stop_early = self.stop_on_failure
530
result.report_starting()
532
if self.verbosity >= 2:
533
self.stream.writeln("Listing tests only ...\n")
535
for t in iter_suite_tests(test):
536
self.stream.writeln("%s" % (t.id()))
538
actionTaken = "Listed"
541
run = result.testsRun
543
stopTime = time.time()
544
timeTaken = stopTime - startTime
546
self.stream.writeln(result.separator2)
547
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
548
run, run != 1 and "s" or "", timeTaken))
549
self.stream.writeln()
550
if not result.wasSuccessful():
551
self.stream.write("FAILED (")
552
failed, errored = map(len, (result.failures, result.errors))
554
self.stream.write("failures=%d" % failed)
556
if failed: self.stream.write(", ")
557
self.stream.write("errors=%d" % errored)
558
if result.known_failure_count:
559
if failed or errored: self.stream.write(", ")
560
self.stream.write("known_failure_count=%d" %
561
result.known_failure_count)
562
self.stream.writeln(")")
564
if result.known_failure_count:
565
self.stream.writeln("OK (known_failures=%d)" %
566
result.known_failure_count)
568
self.stream.writeln("OK")
569
if result.skip_count > 0:
570
skipped = result.skip_count
571
self.stream.writeln('%d test%s skipped' %
572
(skipped, skipped != 1 and "s" or ""))
573
if result.unsupported:
574
for feature, count in sorted(result.unsupported.items()):
575
self.stream.writeln("Missing feature '%s' skipped %d tests." %
577
result.report_cleaning_up()
578
# This is still a little bogus,
579
# but only a little. Folk not using our testrunner will
580
# have to delete their temp directories themselves.
581
test_root = TestCaseWithMemoryTransport.TEST_ROOT
582
if result.wasSuccessful() or not self.keep_output:
583
if test_root is not None:
584
# If LANG=C we probably have created some bogus paths
585
# which rmtree(unicode) will fail to delete
586
# so make sure we are using rmtree(str) to delete everything
587
# except on win32, where rmtree(str) will fail
588
# since it doesn't have the property of byte-stream paths
589
# (they are either ascii or mbcs)
590
if sys.platform == 'win32':
591
# make sure we are using the unicode win32 api
592
test_root = unicode(test_root)
594
test_root = test_root.encode(
595
sys.getfilesystemencoding())
596
_rmtree_temp_dir(test_root)
598
note("Failed tests working directories are in '%s'\n", test_root)
599
TestCaseWithMemoryTransport.TEST_ROOT = None
604
def iter_suite_tests(suite):
605
"""Return all tests in a suite, recursing through nested suites"""
606
for item in suite._tests:
607
if isinstance(item, unittest.TestCase):
609
elif isinstance(item, unittest.TestSuite):
610
for r in iter_suite_tests(item):
613
raise Exception('unknown object %r inside test suite %r'
617
class TestSkipped(Exception):
618
"""Indicates that a test was intentionally skipped, rather than failing."""
621
class KnownFailure(AssertionError):
622
"""Indicates that a test failed in a precisely expected manner.
624
Such failures dont block the whole test suite from passing because they are
625
indicators of partially completed code or of future work. We have an
626
explicit error for them so that we can ensure that they are always visible:
627
KnownFailures are always shown in the output of bzr selftest.
631
class UnavailableFeature(Exception):
632
"""A feature required for this test was not available.
634
The feature should be used to construct the exception.
638
class CommandFailed(Exception):
642
class StringIOWrapper(object):
643
"""A wrapper around cStringIO which just adds an encoding attribute.
645
Internally we can check sys.stdout to see what the output encoding
646
should be. However, cStringIO has no encoding attribute that we can
647
set. So we wrap it instead.
652
def __init__(self, s=None):
654
self.__dict__['_cstring'] = StringIO(s)
656
self.__dict__['_cstring'] = StringIO()
658
def __getattr__(self, name, getattr=getattr):
659
return getattr(self.__dict__['_cstring'], name)
661
def __setattr__(self, name, val):
662
if name == 'encoding':
663
self.__dict__['encoding'] = val
665
return setattr(self._cstring, name, val)
668
class TestUIFactory(ui.CLIUIFactory):
669
"""A UI Factory for testing.
671
Hide the progress bar but emit note()s.
673
Allows get_password to be tested without real tty attached.
680
super(TestUIFactory, self).__init__()
681
if stdin is not None:
682
# We use a StringIOWrapper to be able to test various
683
# encodings, but the user is still responsible to
684
# encode the string and to set the encoding attribute
685
# of StringIOWrapper.
686
self.stdin = StringIOWrapper(stdin)
688
self.stdout = sys.stdout
692
self.stderr = sys.stderr
697
"""See progress.ProgressBar.clear()."""
699
def clear_term(self):
700
"""See progress.ProgressBar.clear_term()."""
702
def clear_term(self):
703
"""See progress.ProgressBar.clear_term()."""
706
"""See progress.ProgressBar.finished()."""
708
def note(self, fmt_string, *args, **kwargs):
709
"""See progress.ProgressBar.note()."""
710
self.stdout.write((fmt_string + "\n") % args)
712
def progress_bar(self):
715
def nested_progress_bar(self):
718
def update(self, message, count=None, total=None):
719
"""See progress.ProgressBar.update()."""
721
def get_non_echoed_password(self, prompt):
722
"""Get password from stdin without trying to handle the echo mode"""
724
self.stdout.write(prompt)
725
password = self.stdin.readline()
728
if password[-1] == '\n':
729
password = password[:-1]
733
class TestCase(unittest.TestCase):
734
"""Base class for bzr unit tests.
736
Tests that need access to disk resources should subclass
737
TestCaseInTempDir not TestCase.
739
Error and debug log messages are redirected from their usual
740
location into a temporary file, the contents of which can be
741
retrieved by _get_log(). We use a real OS file, not an in-memory object,
742
so that it can also capture file IO. When the test completes this file
743
is read into memory and removed from disk.
745
There are also convenience functions to invoke bzr's command-line
746
routine, and to build and check bzr trees.
748
In addition to the usual method of overriding tearDown(), this class also
749
allows subclasses to register functions into the _cleanups list, which is
750
run in order as the object is torn down. It's less likely this will be
751
accidentally overlooked.
754
_log_file_name = None
756
_keep_log_file = False
757
# record lsprof data when performing benchmark calls.
758
_gather_lsprof_in_benchmarks = False
760
def __init__(self, methodName='testMethod'):
761
super(TestCase, self).__init__(methodName)
765
unittest.TestCase.setUp(self)
766
self._cleanEnvironment()
767
bzrlib.trace.disable_default_logging()
770
self._benchcalls = []
771
self._benchtime = None
774
def _clear_hooks(self):
775
# prevent hooks affecting tests
777
import bzrlib.smart.server
778
self._preserved_hooks = {
779
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
780
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
782
self.addCleanup(self._restoreHooks)
783
# reset all hooks to an empty instance of the appropriate type
784
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
785
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
786
# FIXME: Rather than constructing new objects like this, how about
787
# having save() and clear() methods on the base Hook class? mbp
790
def _silenceUI(self):
791
"""Turn off UI for duration of test"""
792
# by default the UI is off; tests can turn it on if they want it.
793
saved = ui.ui_factory
795
ui.ui_factory = saved
796
ui.ui_factory = ui.SilentUIFactory()
797
self.addCleanup(_restore)
799
def _ndiff_strings(self, a, b):
800
"""Return ndiff between two strings containing lines.
802
A trailing newline is added if missing to make the strings
804
if b and b[-1] != '\n':
806
if a and a[-1] != '\n':
808
difflines = difflib.ndiff(a.splitlines(True),
810
linejunk=lambda x: False,
811
charjunk=lambda x: False)
812
return ''.join(difflines)
814
def assertEqual(self, a, b, message=''):
818
except UnicodeError, e:
819
# If we can't compare without getting a UnicodeError, then
820
# obviously they are different
821
mutter('UnicodeError: %s', e)
824
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
826
pformat(a, indent=4), pformat(b, indent=4)))
828
assertEquals = assertEqual
830
def assertEqualDiff(self, a, b, message=None):
831
"""Assert two texts are equal, if not raise an exception.
833
This is intended for use with multi-line strings where it can
834
be hard to find the differences by eye.
836
# TODO: perhaps override assertEquals to call this for strings?
840
message = "texts not equal:\n"
841
raise AssertionError(message +
842
self._ndiff_strings(a, b))
844
def assertEqualMode(self, mode, mode_test):
845
self.assertEqual(mode, mode_test,
846
'mode mismatch %o != %o' % (mode, mode_test))
848
def assertStartsWith(self, s, prefix):
849
if not s.startswith(prefix):
850
raise AssertionError('string %r does not start with %r' % (s, prefix))
852
def assertEndsWith(self, s, suffix):
853
"""Asserts that s ends with suffix."""
854
if not s.endswith(suffix):
855
raise AssertionError('string %r does not end with %r' % (s, suffix))
857
def assertContainsRe(self, haystack, needle_re):
858
"""Assert that a contains something matching a regular expression."""
859
if not re.search(needle_re, haystack):
860
raise AssertionError('pattern "%r" not found in "%r"'
861
% (needle_re, haystack))
863
def assertNotContainsRe(self, haystack, needle_re):
864
"""Assert that a does not match a regular expression"""
865
if re.search(needle_re, haystack):
866
raise AssertionError('pattern "%s" found in "%s"'
867
% (needle_re, haystack))
869
def assertSubset(self, sublist, superlist):
870
"""Assert that every entry in sublist is present in superlist."""
872
for entry in sublist:
873
if entry not in superlist:
874
missing.append(entry)
876
raise AssertionError("value(s) %r not present in container %r" %
877
(missing, superlist))
879
def assertListRaises(self, excClass, func, *args, **kwargs):
880
"""Fail unless excClass is raised when the iterator from func is used.
882
Many functions can return generators this makes sure
883
to wrap them in a list() call to make sure the whole generator
884
is run, and that the proper exception is raised.
887
list(func(*args, **kwargs))
891
if getattr(excClass,'__name__', None) is not None:
892
excName = excClass.__name__
894
excName = str(excClass)
895
raise self.failureException, "%s not raised" % excName
897
def assertRaises(self, excClass, callableObj, *args, **kwargs):
898
"""Assert that a callable raises a particular exception.
900
:param excClass: As for the except statement, this may be either an
901
exception class, or a tuple of classes.
902
:param callableObj: A callable, will be passed ``*args`` and
905
Returns the exception so that you can examine it.
908
callableObj(*args, **kwargs)
912
if getattr(excClass,'__name__', None) is not None:
913
excName = excClass.__name__
916
excName = str(excClass)
917
raise self.failureException, "%s not raised" % excName
919
def assertIs(self, left, right, message=None):
920
if not (left is right):
921
if message is not None:
922
raise AssertionError(message)
924
raise AssertionError("%r is not %r." % (left, right))
926
def assertIsNot(self, left, right, message=None):
928
if message is not None:
929
raise AssertionError(message)
931
raise AssertionError("%r is %r." % (left, right))
933
def assertTransportMode(self, transport, path, mode):
934
"""Fail if a path does not have mode mode.
936
If modes are not supported on this transport, the assertion is ignored.
938
if not transport._can_roundtrip_unix_modebits():
940
path_stat = transport.stat(path)
941
actual_mode = stat.S_IMODE(path_stat.st_mode)
942
self.assertEqual(mode, actual_mode,
943
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
945
def assertIsInstance(self, obj, kls):
946
"""Fail if obj is not an instance of kls"""
947
if not isinstance(obj, kls):
948
self.fail("%r is an instance of %s rather than %s" % (
949
obj, obj.__class__, kls))
951
def expectFailure(self, reason, assertion, *args, **kwargs):
952
"""Invoke a test, expecting it to fail for the given reason.
954
This is for assertions that ought to succeed, but currently fail.
955
(The failure is *expected* but not *wanted*.) Please be very precise
956
about the failure you're expecting. If a new bug is introduced,
957
AssertionError should be raised, not KnownFailure.
959
Frequently, expectFailure should be followed by an opposite assertion.
962
Intended to be used with a callable that raises AssertionError as the
963
'assertion' parameter. args and kwargs are passed to the 'assertion'.
965
Raises KnownFailure if the test fails. Raises AssertionError if the
970
self.expectFailure('Math is broken', self.assertNotEqual, 54,
972
self.assertEqual(42, dynamic_val)
974
This means that a dynamic_val of 54 will cause the test to raise
975
a KnownFailure. Once math is fixed and the expectFailure is removed,
976
only a dynamic_val of 42 will allow the test to pass. Anything other
977
than 54 or 42 will cause an AssertionError.
980
assertion(*args, **kwargs)
981
except AssertionError:
982
raise KnownFailure(reason)
984
self.fail('Unexpected success. Should have failed: %s' % reason)
986
def _capture_warnings(self, a_callable, *args, **kwargs):
987
"""A helper for callDeprecated and applyDeprecated.
989
:param a_callable: A callable to call.
990
:param args: The positional arguments for the callable
991
:param kwargs: The keyword arguments for the callable
992
:return: A tuple (warnings, result). result is the result of calling
993
a_callable(``*args``, ``**kwargs``).
996
def capture_warnings(msg, cls=None, stacklevel=None):
997
# we've hooked into a deprecation specific callpath,
998
# only deprecations should getting sent via it.
999
self.assertEqual(cls, DeprecationWarning)
1000
local_warnings.append(msg)
1001
original_warning_method = symbol_versioning.warn
1002
symbol_versioning.set_warning_method(capture_warnings)
1004
result = a_callable(*args, **kwargs)
1006
symbol_versioning.set_warning_method(original_warning_method)
1007
return (local_warnings, result)
1009
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1010
"""Call a deprecated callable without warning the user.
1012
:param deprecation_format: The deprecation format that the callable
1013
should have been deprecated with. This is the same type as the
1014
parameter to deprecated_method/deprecated_function. If the
1015
callable is not deprecated with this format, an assertion error
1017
:param a_callable: A callable to call. This may be a bound method or
1018
a regular function. It will be called with ``*args`` and
1020
:param args: The positional arguments for the callable
1021
:param kwargs: The keyword arguments for the callable
1022
:return: The result of a_callable(``*args``, ``**kwargs``)
1024
call_warnings, result = self._capture_warnings(a_callable,
1026
expected_first_warning = symbol_versioning.deprecation_string(
1027
a_callable, deprecation_format)
1028
if len(call_warnings) == 0:
1029
self.fail("No deprecation warning generated by call to %s" %
1031
self.assertEqual(expected_first_warning, call_warnings[0])
1034
def callDeprecated(self, expected, callable, *args, **kwargs):
1035
"""Assert that a callable is deprecated in a particular way.
1037
This is a very precise test for unusual requirements. The
1038
applyDeprecated helper function is probably more suited for most tests
1039
as it allows you to simply specify the deprecation format being used
1040
and will ensure that that is issued for the function being called.
1042
:param expected: a list of the deprecation warnings expected, in order
1043
:param callable: The callable to call
1044
:param args: The positional arguments for the callable
1045
:param kwargs: The keyword arguments for the callable
1047
call_warnings, result = self._capture_warnings(callable,
1049
self.assertEqual(expected, call_warnings)
1052
def _startLogFile(self):
1053
"""Send bzr and test log messages to a temporary file.
1055
The file is removed as the test is torn down.
1057
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1058
self._log_file = os.fdopen(fileno, 'w+')
1059
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1060
self._log_file_name = name
1061
self.addCleanup(self._finishLogFile)
1063
def _finishLogFile(self):
1064
"""Finished with the log file.
1066
Close the file and delete it, unless setKeepLogfile was called.
1068
if self._log_file is None:
1070
bzrlib.trace.disable_test_log(self._log_nonce)
1071
self._log_file.close()
1072
self._log_file = None
1073
if not self._keep_log_file:
1074
os.remove(self._log_file_name)
1075
self._log_file_name = None
1077
def setKeepLogfile(self):
1078
"""Make the logfile not be deleted when _finishLogFile is called."""
1079
self._keep_log_file = True
1081
def addCleanup(self, callable):
1082
"""Arrange to run a callable when this case is torn down.
1084
Callables are run in the reverse of the order they are registered,
1085
ie last-in first-out.
1087
if callable in self._cleanups:
1088
raise ValueError("cleanup function %r already registered on %s"
1090
self._cleanups.append(callable)
1092
def _cleanEnvironment(self):
1094
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1095
'HOME': os.getcwd(),
1096
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1098
'BZREMAIL': None, # may still be present in the environment
1100
'BZR_PROGRESS_BAR': None,
1104
'https_proxy': None,
1105
'HTTPS_PROXY': None,
1110
# Nobody cares about these ones AFAIK. So far at
1111
# least. If you do (care), please update this comment
1117
self.addCleanup(self._restoreEnvironment)
1118
for name, value in new_env.iteritems():
1119
self._captureVar(name, value)
1121
def _captureVar(self, name, newvalue):
1122
"""Set an environment variable, and reset it when finished."""
1123
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1125
def _restoreEnvironment(self):
1126
for name, value in self.__old_env.iteritems():
1127
osutils.set_or_unset_env(name, value)
1129
def _restoreHooks(self):
1130
for klass, hooks in self._preserved_hooks.items():
1131
setattr(klass, 'hooks', hooks)
1133
def knownFailure(self, reason):
1134
"""This test has failed for some known reason."""
1135
raise KnownFailure(reason)
1137
def run(self, result=None):
1138
if result is None: result = self.defaultTestResult()
1139
for feature in getattr(self, '_test_needs_features', []):
1140
if not feature.available():
1141
result.startTest(self)
1142
if getattr(result, 'addNotSupported', None):
1143
result.addNotSupported(self, feature)
1145
result.addSuccess(self)
1146
result.stopTest(self)
1148
return unittest.TestCase.run(self, result)
1152
unittest.TestCase.tearDown(self)
1154
def time(self, callable, *args, **kwargs):
1155
"""Run callable and accrue the time it takes to the benchmark time.
1157
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1158
this will cause lsprofile statistics to be gathered and stored in
1161
if self._benchtime is None:
1165
if not self._gather_lsprof_in_benchmarks:
1166
return callable(*args, **kwargs)
1168
# record this benchmark
1169
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1171
self._benchcalls.append(((callable, args, kwargs), stats))
1174
self._benchtime += time.time() - start
1176
def _runCleanups(self):
1177
"""Run registered cleanup functions.
1179
This should only be called from TestCase.tearDown.
1181
# TODO: Perhaps this should keep running cleanups even if
1182
# one of them fails?
1184
# Actually pop the cleanups from the list so tearDown running
1185
# twice is safe (this happens for skipped tests).
1186
while self._cleanups:
1187
self._cleanups.pop()()
1189
def log(self, *args):
1192
def _get_log(self, keep_log_file=False):
1193
"""Return as a string the log for this test. If the file is still
1194
on disk and keep_log_file=False, delete the log file and store the
1195
content in self._log_contents."""
1196
# flush the log file, to get all content
1198
bzrlib.trace._trace_file.flush()
1199
if self._log_contents:
1200
return self._log_contents
1201
if self._log_file_name is not None:
1202
logfile = open(self._log_file_name)
1204
log_contents = logfile.read()
1207
if not keep_log_file:
1208
self._log_contents = log_contents
1210
os.remove(self._log_file_name)
1212
if sys.platform == 'win32' and e.errno == errno.EACCES:
1213
print >>sys.stderr, ('Unable to delete log file '
1214
' %r' % self._log_file_name)
1219
return "DELETED log file to reduce memory footprint"
1221
def capture(self, cmd, retcode=0):
1222
"""Shortcut that splits cmd into words, runs, and returns stdout"""
1223
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
1225
def requireFeature(self, feature):
1226
"""This test requires a specific feature is available.
1228
:raises UnavailableFeature: When feature is not available.
1230
if not feature.available():
1231
raise UnavailableFeature(feature)
1233
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
1235
"""Invoke bzr and return (stdout, stderr).
1237
Useful for code that wants to check the contents of the
1238
output, the way error messages are presented, etc.
1240
This should be the main method for tests that want to exercise the
1241
overall behavior of the bzr application (rather than a unit test
1242
or a functional test of the library.)
1244
Much of the old code runs bzr by forking a new copy of Python, but
1245
that is slower, harder to debug, and generally not necessary.
1247
This runs bzr through the interface that catches and reports
1248
errors, and with logging set to something approximating the
1249
default, so that error reporting can be checked.
1251
:param argv: arguments to invoke bzr
1252
:param retcode: expected return code, or None for don't-care.
1253
:param encoding: encoding for sys.stdout and sys.stderr
1254
:param stdin: A string to be used as stdin for the command.
1255
:param working_dir: Change to this directory before running
1257
if encoding is None:
1258
encoding = bzrlib.user_encoding
1259
stdout = StringIOWrapper()
1260
stderr = StringIOWrapper()
1261
stdout.encoding = encoding
1262
stderr.encoding = encoding
1264
self.log('run bzr: %r', argv)
1265
# FIXME: don't call into logging here
1266
handler = logging.StreamHandler(stderr)
1267
handler.setLevel(logging.INFO)
1268
logger = logging.getLogger('')
1269
logger.addHandler(handler)
1270
old_ui_factory = ui.ui_factory
1271
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1274
if working_dir is not None:
1275
cwd = osutils.getcwd()
1276
os.chdir(working_dir)
1279
saved_debug_flags = frozenset(debug.debug_flags)
1280
debug.debug_flags.clear()
1282
result = self.apply_redirected(ui.ui_factory.stdin,
1284
bzrlib.commands.run_bzr_catch_errors,
1287
debug.debug_flags.update(saved_debug_flags)
1289
logger.removeHandler(handler)
1290
ui.ui_factory = old_ui_factory
1294
out = stdout.getvalue()
1295
err = stderr.getvalue()
1297
self.log('output:\n%r', out)
1299
self.log('errors:\n%r', err)
1300
if retcode is not None:
1301
self.assertEquals(retcode, result,
1302
message='Unexpected return code')
1305
def run_bzr(self, *args, **kwargs):
1306
"""Invoke bzr, as if it were run from the command line.
1308
This should be the main method for tests that want to exercise the
1309
overall behavior of the bzr application (rather than a unit test
1310
or a functional test of the library.)
1312
This sends the stdout/stderr results into the test's log,
1313
where it may be useful for debugging. See also run_captured.
1315
:keyword stdin: A string to be used as stdin for the command.
1316
:keyword retcode: The status code the command should return
1317
:keyword working_dir: The directory to run the command in
1319
retcode = kwargs.pop('retcode', 0)
1320
encoding = kwargs.pop('encoding', None)
1321
stdin = kwargs.pop('stdin', None)
1322
working_dir = kwargs.pop('working_dir', None)
1323
error_regexes = kwargs.pop('error_regexes', [])
1325
out, err = self.run_bzr_captured(args, retcode=retcode,
1326
encoding=encoding, stdin=stdin, working_dir=working_dir)
1328
for regex in error_regexes:
1329
self.assertContainsRe(err, regex)
1333
def run_bzr_decode(self, *args, **kwargs):
1334
if 'encoding' in kwargs:
1335
encoding = kwargs['encoding']
1337
encoding = bzrlib.user_encoding
1338
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1340
def run_bzr_error(self, error_regexes, *args, **kwargs):
1341
"""Run bzr, and check that stderr contains the supplied regexes
1343
:param error_regexes: Sequence of regular expressions which
1344
must each be found in the error output. The relative ordering
1346
:param args: command-line arguments for bzr
1347
:param kwargs: Keyword arguments which are interpreted by run_bzr
1348
This function changes the default value of retcode to be 3,
1349
since in most cases this is run when you expect bzr to fail.
1350
:return: (out, err) The actual output of running the command (in case
1351
you want to do more inspection)
1355
# Make sure that commit is failing because there is nothing to do
1356
self.run_bzr_error(['no changes to commit'],
1357
'commit', '-m', 'my commit comment')
1358
# Make sure --strict is handling an unknown file, rather than
1359
# giving us the 'nothing to do' error
1360
self.build_tree(['unknown'])
1361
self.run_bzr_error(['Commit refused because there are unknown files'],
1362
'commit', '--strict', '-m', 'my commit comment')
1364
kwargs.setdefault('retcode', 3)
1365
out, err = self.run_bzr(error_regexes=error_regexes, *args, **kwargs)
1368
def run_bzr_subprocess(self, *args, **kwargs):
1369
"""Run bzr in a subprocess for testing.
1371
This starts a new Python interpreter and runs bzr in there.
1372
This should only be used for tests that have a justifiable need for
1373
this isolation: e.g. they are testing startup time, or signal
1374
handling, or early startup code, etc. Subprocess code can't be
1375
profiled or debugged so easily.
1377
:keyword retcode: The status code that is expected. Defaults to 0. If
1378
None is supplied, the status code is not checked.
1379
:keyword env_changes: A dictionary which lists changes to environment
1380
variables. A value of None will unset the env variable.
1381
The values must be strings. The change will only occur in the
1382
child, so you don't need to fix the environment after running.
1383
:keyword universal_newlines: Convert CRLF => LF
1384
:keyword allow_plugins: By default the subprocess is run with
1385
--no-plugins to ensure test reproducibility. Also, it is possible
1386
for system-wide plugins to create unexpected output on stderr,
1387
which can cause unnecessary test failures.
1389
env_changes = kwargs.get('env_changes', {})
1390
working_dir = kwargs.get('working_dir', None)
1391
allow_plugins = kwargs.get('allow_plugins', False)
1392
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1393
working_dir=working_dir,
1394
allow_plugins=allow_plugins)
1395
# We distinguish between retcode=None and retcode not passed.
1396
supplied_retcode = kwargs.get('retcode', 0)
1397
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1398
universal_newlines=kwargs.get('universal_newlines', False),
1401
def start_bzr_subprocess(self, process_args, env_changes=None,
1402
skip_if_plan_to_signal=False,
1404
allow_plugins=False):
1405
"""Start bzr in a subprocess for testing.
1407
This starts a new Python interpreter and runs bzr in there.
1408
This should only be used for tests that have a justifiable need for
1409
this isolation: e.g. they are testing startup time, or signal
1410
handling, or early startup code, etc. Subprocess code can't be
1411
profiled or debugged so easily.
1413
:param process_args: a list of arguments to pass to the bzr executable,
1414
for example ``['--version']``.
1415
:param env_changes: A dictionary which lists changes to environment
1416
variables. A value of None will unset the env variable.
1417
The values must be strings. The change will only occur in the
1418
child, so you don't need to fix the environment after running.
1419
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1421
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1423
:returns: Popen object for the started process.
1425
if skip_if_plan_to_signal:
1426
if not getattr(os, 'kill', None):
1427
raise TestSkipped("os.kill not available.")
1429
if env_changes is None:
1433
def cleanup_environment():
1434
for env_var, value in env_changes.iteritems():
1435
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1437
def restore_environment():
1438
for env_var, value in old_env.iteritems():
1439
osutils.set_or_unset_env(env_var, value)
1441
bzr_path = self.get_bzr_path()
1444
if working_dir is not None:
1445
cwd = osutils.getcwd()
1446
os.chdir(working_dir)
1449
# win32 subprocess doesn't support preexec_fn
1450
# so we will avoid using it on all platforms, just to
1451
# make sure the code path is used, and we don't break on win32
1452
cleanup_environment()
1453
command = [sys.executable, bzr_path]
1454
if not allow_plugins:
1455
command.append('--no-plugins')
1456
command.extend(process_args)
1457
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1459
restore_environment()
1465
def _popen(self, *args, **kwargs):
1466
"""Place a call to Popen.
1468
Allows tests to override this method to intercept the calls made to
1469
Popen for introspection.
1471
return Popen(*args, **kwargs)
1473
def get_bzr_path(self):
1474
"""Return the path of the 'bzr' executable for this test suite."""
1475
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1476
if not os.path.isfile(bzr_path):
1477
# We are probably installed. Assume sys.argv is the right file
1478
bzr_path = sys.argv[0]
1481
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1482
universal_newlines=False, process_args=None):
1483
"""Finish the execution of process.
1485
:param process: the Popen object returned from start_bzr_subprocess.
1486
:param retcode: The status code that is expected. Defaults to 0. If
1487
None is supplied, the status code is not checked.
1488
:param send_signal: an optional signal to send to the process.
1489
:param universal_newlines: Convert CRLF => LF
1490
:returns: (stdout, stderr)
1492
if send_signal is not None:
1493
os.kill(process.pid, send_signal)
1494
out, err = process.communicate()
1496
if universal_newlines:
1497
out = out.replace('\r\n', '\n')
1498
err = err.replace('\r\n', '\n')
1500
if retcode is not None and retcode != process.returncode:
1501
if process_args is None:
1502
process_args = "(unknown args)"
1503
mutter('Output of bzr %s:\n%s', process_args, out)
1504
mutter('Error for bzr %s:\n%s', process_args, err)
1505
self.fail('Command bzr %s failed with retcode %s != %s'
1506
% (process_args, retcode, process.returncode))
1509
def check_inventory_shape(self, inv, shape):
1510
"""Compare an inventory to a list of expected names.
1512
Fail if they are not precisely equal.
1515
shape = list(shape) # copy
1516
for path, ie in inv.entries():
1517
name = path.replace('\\', '/')
1518
if ie.kind == 'dir':
1525
self.fail("expected paths not found in inventory: %r" % shape)
1527
self.fail("unexpected paths found in inventory: %r" % extras)
1529
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1530
a_callable=None, *args, **kwargs):
1531
"""Call callable with redirected std io pipes.
1533
Returns the return code."""
1534
if not callable(a_callable):
1535
raise ValueError("a_callable must be callable.")
1537
stdin = StringIO("")
1539
if getattr(self, "_log_file", None) is not None:
1540
stdout = self._log_file
1544
if getattr(self, "_log_file", None is not None):
1545
stderr = self._log_file
1548
real_stdin = sys.stdin
1549
real_stdout = sys.stdout
1550
real_stderr = sys.stderr
1555
return a_callable(*args, **kwargs)
1557
sys.stdout = real_stdout
1558
sys.stderr = real_stderr
1559
sys.stdin = real_stdin
1561
@symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
1562
def merge(self, branch_from, wt_to):
1563
"""A helper for tests to do a ui-less merge.
1565
This should move to the main library when someone has time to integrate
1568
# minimal ui-less merge.
1569
wt_to.branch.fetch(branch_from)
1570
base_rev = common_ancestor(branch_from.last_revision(),
1571
wt_to.branch.last_revision(),
1572
wt_to.branch.repository)
1573
merge_inner(wt_to.branch, branch_from.basis_tree(),
1574
wt_to.branch.repository.revision_tree(base_rev),
1576
wt_to.add_parent_tree_id(branch_from.last_revision())
1578
def reduceLockdirTimeout(self):
1579
"""Reduce the default lock timeout for the duration of the test, so that
1580
if LockContention occurs during a test, it does so quickly.
1582
Tests that expect to provoke LockContention errors should call this.
1584
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1586
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1587
self.addCleanup(resetTimeout)
1588
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1590
BzrTestBase = TestCase
1593
class TestCaseWithMemoryTransport(TestCase):
1594
"""Common test class for tests that do not need disk resources.
1596
Tests that need disk resources should derive from TestCaseWithTransport.
1598
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1600
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1601
a directory which does not exist. This serves to help ensure test isolation
1602
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1603
must exist. However, TestCaseWithMemoryTransport does not offer local
1604
file defaults for the transport in tests, nor does it obey the command line
1605
override, so tests that accidentally write to the common directory should
1613
def __init__(self, methodName='runTest'):
1614
# allow test parameterisation after test construction and before test
1615
# execution. Variables that the parameteriser sets need to be
1616
# ones that are not set by setUp, or setUp will trash them.
1617
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1618
self.vfs_transport_factory = default_transport
1619
self.transport_server = None
1620
self.transport_readonly_server = None
1621
self.__vfs_server = None
1623
def get_transport(self):
1624
"""Return a writeable transport for the test scratch space"""
1625
t = get_transport(self.get_url())
1626
self.assertFalse(t.is_readonly())
1629
def get_readonly_transport(self):
1630
"""Return a readonly transport for the test scratch space
1632
This can be used to test that operations which should only need
1633
readonly access in fact do not try to write.
1635
t = get_transport(self.get_readonly_url())
1636
self.assertTrue(t.is_readonly())
1639
def create_transport_readonly_server(self):
1640
"""Create a transport server from class defined at init.
1642
This is mostly a hook for daughter classes.
1644
return self.transport_readonly_server()
1646
def get_readonly_server(self):
1647
"""Get the server instance for the readonly transport
1649
This is useful for some tests with specific servers to do diagnostics.
1651
if self.__readonly_server is None:
1652
if self.transport_readonly_server is None:
1653
# readonly decorator requested
1654
# bring up the server
1655
self.__readonly_server = ReadonlyServer()
1656
self.__readonly_server.setUp(self.get_vfs_only_server())
1658
self.__readonly_server = self.create_transport_readonly_server()
1659
self.__readonly_server.setUp(self.get_vfs_only_server())
1660
self.addCleanup(self.__readonly_server.tearDown)
1661
return self.__readonly_server
1663
def get_readonly_url(self, relpath=None):
1664
"""Get a URL for the readonly transport.
1666
This will either be backed by '.' or a decorator to the transport
1667
used by self.get_url()
1668
relpath provides for clients to get a path relative to the base url.
1669
These should only be downwards relative, not upwards.
1671
base = self.get_readonly_server().get_url()
1672
if relpath is not None:
1673
if not base.endswith('/'):
1675
base = base + relpath
1678
def get_vfs_only_server(self):
1679
"""Get the vfs only read/write server instance.
1681
This is useful for some tests with specific servers that need
1684
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1685
is no means to override it.
1687
if self.__vfs_server is None:
1688
self.__vfs_server = MemoryServer()
1689
self.__vfs_server.setUp()
1690
self.addCleanup(self.__vfs_server.tearDown)
1691
return self.__vfs_server
1693
def get_server(self):
1694
"""Get the read/write server instance.
1696
This is useful for some tests with specific servers that need
1699
This is built from the self.transport_server factory. If that is None,
1700
then the self.get_vfs_server is returned.
1702
if self.__server is None:
1703
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1704
return self.get_vfs_only_server()
1706
# bring up a decorated means of access to the vfs only server.
1707
self.__server = self.transport_server()
1709
self.__server.setUp(self.get_vfs_only_server())
1710
except TypeError, e:
1711
# This should never happen; the try:Except here is to assist
1712
# developers having to update code rather than seeing an
1713
# uninformative TypeError.
1714
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1715
self.addCleanup(self.__server.tearDown)
1716
return self.__server
1718
def _adjust_url(self, base, relpath):
1719
"""Get a URL (or maybe a path) for the readwrite transport.
1721
This will either be backed by '.' or to an equivalent non-file based
1723
relpath provides for clients to get a path relative to the base url.
1724
These should only be downwards relative, not upwards.
1726
if relpath is not None and relpath != '.':
1727
if not base.endswith('/'):
1729
# XXX: Really base should be a url; we did after all call
1730
# get_url()! But sometimes it's just a path (from
1731
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1732
# to a non-escaped local path.
1733
if base.startswith('./') or base.startswith('/'):
1736
base += urlutils.escape(relpath)
1739
def get_url(self, relpath=None):
1740
"""Get a URL (or maybe a path) for the readwrite transport.
1742
This will either be backed by '.' or to an equivalent non-file based
1744
relpath provides for clients to get a path relative to the base url.
1745
These should only be downwards relative, not upwards.
1747
base = self.get_server().get_url()
1748
return self._adjust_url(base, relpath)
1750
def get_vfs_only_url(self, relpath=None):
1751
"""Get a URL (or maybe a path for the plain old vfs transport.
1753
This will never be a smart protocol. It always has all the
1754
capabilities of the local filesystem, but it might actually be a
1755
MemoryTransport or some other similar virtual filesystem.
1757
This is the backing transport (if any) of the server returned by
1758
get_url and get_readonly_url.
1760
:param relpath: provides for clients to get a path relative to the base
1761
url. These should only be downwards relative, not upwards.
1764
base = self.get_vfs_only_server().get_url()
1765
return self._adjust_url(base, relpath)
1767
def _make_test_root(self):
1768
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1772
root = u'test%04d.tmp' % i
1776
if e.errno == errno.EEXIST:
1781
# successfully created
1782
TestCaseWithMemoryTransport.TEST_ROOT = osutils.abspath(root)
1784
# make a fake bzr directory there to prevent any tests propagating
1785
# up onto the source directory's real branch
1786
bzrdir.BzrDir.create_standalone_workingtree(
1787
TestCaseWithMemoryTransport.TEST_ROOT)
1789
def makeAndChdirToTestDir(self):
1790
"""Create a temporary directories for this one test.
1792
This must set self.test_home_dir and self.test_dir and chdir to
1795
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1797
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1798
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1799
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1801
def make_branch(self, relpath, format=None):
1802
"""Create a branch on the transport at relpath."""
1803
repo = self.make_repository(relpath, format=format)
1804
return repo.bzrdir.create_branch()
1806
def make_bzrdir(self, relpath, format=None):
1808
# might be a relative or absolute path
1809
maybe_a_url = self.get_url(relpath)
1810
segments = maybe_a_url.rsplit('/', 1)
1811
t = get_transport(maybe_a_url)
1812
if len(segments) > 1 and segments[-1] not in ('', '.'):
1815
except errors.FileExists:
1819
if isinstance(format, basestring):
1820
format = bzrdir.format_registry.make_bzrdir(format)
1821
return format.initialize_on_transport(t)
1822
except errors.UninitializableFormat:
1823
raise TestSkipped("Format %s is not initializable." % format)
1825
def make_repository(self, relpath, shared=False, format=None):
1826
"""Create a repository on our default transport at relpath.
1828
Note that relpath must be a relative path, not a full url.
1830
# FIXME: If you create a remoterepository this returns the underlying
1831
# real format, which is incorrect. Actually we should make sure that
1832
# RemoteBzrDir returns a RemoteRepository.
1833
# maybe mbp 20070410
1834
made_control = self.make_bzrdir(relpath, format=format)
1835
return made_control.create_repository(shared=shared)
1837
def make_branch_and_memory_tree(self, relpath, format=None):
1838
"""Create a branch on the default transport and a MemoryTree for it."""
1839
b = self.make_branch(relpath, format=format)
1840
return memorytree.MemoryTree.create_on_branch(b)
1842
def overrideEnvironmentForTesting(self):
1843
os.environ['HOME'] = self.test_home_dir
1844
os.environ['BZR_HOME'] = self.test_home_dir
1847
super(TestCaseWithMemoryTransport, self).setUp()
1848
self._make_test_root()
1849
_currentdir = os.getcwdu()
1850
def _leaveDirectory():
1851
os.chdir(_currentdir)
1852
self.addCleanup(_leaveDirectory)
1853
self.makeAndChdirToTestDir()
1854
self.overrideEnvironmentForTesting()
1855
self.__readonly_server = None
1856
self.__server = None
1857
self.reduceLockdirTimeout()
1860
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1861
"""Derived class that runs a test within a temporary directory.
1863
This is useful for tests that need to create a branch, etc.
1865
The directory is created in a slightly complex way: for each
1866
Python invocation, a new temporary top-level directory is created.
1867
All test cases create their own directory within that. If the
1868
tests complete successfully, the directory is removed.
1870
InTempDir is an old alias for FunctionalTestCase.
1873
OVERRIDE_PYTHON = 'python'
1874
use_numbered_dirs = False
1876
def check_file_contents(self, filename, expect):
1877
self.log("check contents of file %s" % filename)
1878
contents = file(filename, 'r').read()
1879
if contents != expect:
1880
self.log("expected: %r" % expect)
1881
self.log("actually: %r" % contents)
1882
self.fail("contents of %s not as expected" % filename)
1884
def makeAndChdirToTestDir(self):
1885
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1887
For TestCaseInTempDir we create a temporary directory based on the test
1888
name and then create two subdirs - test and home under it.
1890
if self.use_numbered_dirs: # strongly recommended on Windows
1891
# due the path length limitation (260 ch.)
1892
candidate_dir = '%s/%dK/%05d' % (self.TEST_ROOT,
1893
int(self.number/1000),
1895
os.makedirs(candidate_dir)
1896
self.test_home_dir = candidate_dir + '/home'
1897
os.mkdir(self.test_home_dir)
1898
self.test_dir = candidate_dir + '/work'
1899
os.mkdir(self.test_dir)
1900
os.chdir(self.test_dir)
1901
# put name of test inside
1902
f = file(candidate_dir + '/name', 'w')
1907
# shorten the name, to avoid test failures due to path length
1908
short_id = self.id().replace('bzrlib.tests.', '') \
1909
.replace('__main__.', '')[-100:]
1910
# it's possible the same test class is run several times for
1911
# parameterized tests, so make sure the names don't collide.
1915
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1917
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1918
if os.path.exists(candidate_dir):
1922
os.mkdir(candidate_dir)
1923
self.test_home_dir = candidate_dir + '/home'
1924
os.mkdir(self.test_home_dir)
1925
self.test_dir = candidate_dir + '/work'
1926
os.mkdir(self.test_dir)
1927
os.chdir(self.test_dir)
1930
def build_tree(self, shape, line_endings='binary', transport=None):
1931
"""Build a test tree according to a pattern.
1933
shape is a sequence of file specifications. If the final
1934
character is '/', a directory is created.
1936
This assumes that all the elements in the tree being built are new.
1938
This doesn't add anything to a branch.
1940
:param line_endings: Either 'binary' or 'native'
1941
in binary mode, exact contents are written in native mode, the
1942
line endings match the default platform endings.
1943
:param transport: A transport to write to, for building trees on VFS's.
1944
If the transport is readonly or None, "." is opened automatically.
1947
# It's OK to just create them using forward slashes on windows.
1948
if transport is None or transport.is_readonly():
1949
transport = get_transport(".")
1951
self.assert_(isinstance(name, basestring))
1953
transport.mkdir(urlutils.escape(name[:-1]))
1955
if line_endings == 'binary':
1957
elif line_endings == 'native':
1960
raise errors.BzrError(
1961
'Invalid line ending request %r' % line_endings)
1962
content = "contents of %s%s" % (name.encode('utf-8'), end)
1963
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1965
def build_tree_contents(self, shape):
1966
build_tree_contents(shape)
1968
def assertFileEqual(self, content, path):
1969
"""Fail if path does not contain 'content'."""
1970
self.failUnlessExists(path)
1971
# TODO: jam 20060427 Shouldn't this be 'rb'?
1977
self.assertEqualDiff(content, s)
1979
def failUnlessExists(self, path):
1980
"""Fail unless path or paths, which may be abs or relative, exist."""
1981
if not isinstance(path, basestring):
1983
self.failUnlessExists(p)
1985
self.failUnless(osutils.lexists(path),path+" does not exist")
1987
def failIfExists(self, path):
1988
"""Fail if path or paths, which may be abs or relative, exist."""
1989
if not isinstance(path, basestring):
1991
self.failIfExists(p)
1993
self.failIf(osutils.lexists(path),path+" exists")
1995
def assertInWorkingTree(self,path,root_path='.',tree=None):
1996
"""Assert whether path or paths are in the WorkingTree"""
1998
tree = workingtree.WorkingTree.open(root_path)
1999
if not isinstance(path, basestring):
2001
self.assertInWorkingTree(p,tree=tree)
2003
self.assertIsNot(tree.path2id(path), None,
2004
path+' not in working tree.')
2006
def assertNotInWorkingTree(self,path,root_path='.',tree=None):
2007
"""Assert whether path or paths are not in the WorkingTree"""
2009
tree = workingtree.WorkingTree.open(root_path)
2010
if not isinstance(path, basestring):
2012
self.assertNotInWorkingTree(p,tree=tree)
2014
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2017
class TestCaseWithTransport(TestCaseInTempDir):
2018
"""A test case that provides get_url and get_readonly_url facilities.
2020
These back onto two transport servers, one for readonly access and one for
2023
If no explicit class is provided for readonly access, a
2024
ReadonlyTransportDecorator is used instead which allows the use of non disk
2025
based read write transports.
2027
If an explicit class is provided for readonly access, that server and the
2028
readwrite one must both define get_url() as resolving to os.getcwd().
2031
def get_vfs_only_server(self):
2032
"""See TestCaseWithMemoryTransport.
2034
This is useful for some tests with specific servers that need
2037
if self.__vfs_server is None:
2038
self.__vfs_server = self.vfs_transport_factory()
2039
self.__vfs_server.setUp()
2040
self.addCleanup(self.__vfs_server.tearDown)
2041
return self.__vfs_server
2043
def make_branch_and_tree(self, relpath, format=None):
2044
"""Create a branch on the transport and a tree locally.
2046
If the transport is not a LocalTransport, the Tree can't be created on
2047
the transport. In that case if the vfs_transport_factory is
2048
LocalURLServer the working tree is created in the local
2049
directory backing the transport, and the returned tree's branch and
2050
repository will also be accessed locally. Otherwise a lightweight
2051
checkout is created and returned.
2053
:param format: The BzrDirFormat.
2054
:returns: the WorkingTree.
2056
# TODO: always use the local disk path for the working tree,
2057
# this obviously requires a format that supports branch references
2058
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2060
b = self.make_branch(relpath, format=format)
2062
return b.bzrdir.create_workingtree()
2063
except errors.NotLocalUrl:
2064
# We can only make working trees locally at the moment. If the
2065
# transport can't support them, then we keep the non-disk-backed
2066
# branch and create a local checkout.
2067
if self.vfs_transport_factory is LocalURLServer:
2068
# the branch is colocated on disk, we cannot create a checkout.
2069
# hopefully callers will expect this.
2070
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2071
return local_controldir.create_workingtree()
2073
return b.create_checkout(relpath, lightweight=True)
2075
def assertIsDirectory(self, relpath, transport):
2076
"""Assert that relpath within transport is a directory.
2078
This may not be possible on all transports; in that case it propagates
2079
a TransportNotPossible.
2082
mode = transport.stat(relpath).st_mode
2083
except errors.NoSuchFile:
2084
self.fail("path %s is not a directory; no such file"
2086
if not stat.S_ISDIR(mode):
2087
self.fail("path %s is not a directory; has mode %#o"
2090
def assertTreesEqual(self, left, right):
2091
"""Check that left and right have the same content and properties."""
2092
# we use a tree delta to check for equality of the content, and we
2093
# manually check for equality of other things such as the parents list.
2094
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2095
differences = left.changes_from(right)
2096
self.assertFalse(differences.has_changed(),
2097
"Trees %r and %r are different: %r" % (left, right, differences))
2100
super(TestCaseWithTransport, self).setUp()
2101
self.__vfs_server = None
2104
class ChrootedTestCase(TestCaseWithTransport):
2105
"""A support class that provides readonly urls outside the local namespace.
2107
This is done by checking if self.transport_server is a MemoryServer. if it
2108
is then we are chrooted already, if it is not then an HttpServer is used
2111
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2112
be used without needed to redo it when a different
2113
subclass is in use ?
2117
super(ChrootedTestCase, self).setUp()
2118
if not self.vfs_transport_factory == MemoryServer:
2119
self.transport_readonly_server = HttpServer
2122
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2123
random_order=False):
2124
"""Create a test suite by filtering another one.
2126
:param suite: the source suite
2127
:param pattern: pattern that names must match
2128
:param exclude_pattern: pattern that names must not match, if any
2129
:param random_order: if True, tests in the new suite will be put in
2131
:returns: the newly created suite
2133
return sort_suite_by_re(suite, pattern, exclude_pattern,
2134
random_order, False)
2137
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2138
random_order=False, append_rest=True):
2139
"""Create a test suite by sorting another one.
2141
:param suite: the source suite
2142
:param pattern: pattern that names must match in order to go
2143
first in the new suite
2144
:param exclude_pattern: pattern that names must not match, if any
2145
:param random_order: if True, tests in the new suite will be put in
2147
:param append_rest: if False, pattern is a strict filter and not
2148
just an ordering directive
2149
:returns: the newly created suite
2153
filter_re = re.compile(pattern)
2154
if exclude_pattern is not None:
2155
exclude_re = re.compile(exclude_pattern)
2156
for test in iter_suite_tests(suite):
2158
if exclude_pattern is None or not exclude_re.search(test_id):
2159
if filter_re.search(test_id):
2164
random.shuffle(first)
2165
random.shuffle(second)
2166
return TestUtil.TestSuite(first + second)
2169
def run_suite(suite, name='test', verbose=False, pattern=".*",
2170
stop_on_failure=False, keep_output=False,
2171
transport=None, lsprof_timed=None, bench_history=None,
2172
matching_tests_first=None,
2176
exclude_pattern=None,
2178
use_numbered_dirs = bool(numbered_dirs)
2180
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2181
if numbered_dirs is not None:
2182
TestCaseInTempDir.use_numbered_dirs = use_numbered_dirs
2187
runner = TextTestRunner(stream=sys.stdout,
2189
verbosity=verbosity,
2190
keep_output=keep_output,
2191
bench_history=bench_history,
2192
use_numbered_dirs=use_numbered_dirs,
2193
list_only=list_only,
2195
runner.stop_on_failure=stop_on_failure
2196
# Initialise the random number generator and display the seed used.
2197
# We convert the seed to a long to make it reuseable across invocations.
2198
random_order = False
2199
if random_seed is not None:
2201
if random_seed == "now":
2202
random_seed = long(time.time())
2204
# Convert the seed to a long if we can
2206
random_seed = long(random_seed)
2209
runner.stream.writeln("Randomizing test order using seed %s\n" %
2211
random.seed(random_seed)
2212
# Customise the list of tests if requested
2213
if pattern != '.*' or exclude_pattern is not None or random_order:
2214
if matching_tests_first:
2215
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
2218
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
2220
result = runner.run(suite)
2221
return result.wasSuccessful()
2224
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2227
test_suite_factory=None,
2230
matching_tests_first=None,
2234
exclude_pattern=None):
2235
"""Run the whole test suite under the enhanced runner"""
2236
# XXX: Very ugly way to do this...
2237
# Disable warning about old formats because we don't want it to disturb
2238
# any blackbox tests.
2239
from bzrlib import repository
2240
repository._deprecation_warning_done = True
2242
global default_transport
2243
if transport is None:
2244
transport = default_transport
2245
old_transport = default_transport
2246
default_transport = transport
2248
if test_suite_factory is None:
2249
suite = test_suite()
2251
suite = test_suite_factory()
2252
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2253
stop_on_failure=stop_on_failure, keep_output=keep_output,
2254
transport=transport,
2255
lsprof_timed=lsprof_timed,
2256
bench_history=bench_history,
2257
matching_tests_first=matching_tests_first,
2258
numbered_dirs=numbered_dirs,
2259
list_only=list_only,
2260
random_seed=random_seed,
2261
exclude_pattern=exclude_pattern)
2263
default_transport = old_transport
2267
"""Build and return TestSuite for the whole of bzrlib.
2269
This function can be replaced if you need to change the default test
2270
suite on a global basis, but it is not encouraged.
2273
'bzrlib.tests.test_ancestry',
2274
'bzrlib.tests.test_annotate',
2275
'bzrlib.tests.test_api',
2276
'bzrlib.tests.test_atomicfile',
2277
'bzrlib.tests.test_bad_files',
2278
'bzrlib.tests.test_branch',
2279
'bzrlib.tests.test_bugtracker',
2280
'bzrlib.tests.test_bundle',
2281
'bzrlib.tests.test_bzrdir',
2282
'bzrlib.tests.test_cache_utf8',
2283
'bzrlib.tests.test_commands',
2284
'bzrlib.tests.test_commit',
2285
'bzrlib.tests.test_commit_merge',
2286
'bzrlib.tests.test_config',
2287
'bzrlib.tests.test_conflicts',
2288
'bzrlib.tests.test_decorators',
2289
'bzrlib.tests.test_delta',
2290
'bzrlib.tests.test_diff',
2291
'bzrlib.tests.test_dirstate',
2292
'bzrlib.tests.test_errors',
2293
'bzrlib.tests.test_escaped_store',
2294
'bzrlib.tests.test_extract',
2295
'bzrlib.tests.test_fetch',
2296
'bzrlib.tests.test_ftp_transport',
2297
'bzrlib.tests.test_generate_docs',
2298
'bzrlib.tests.test_generate_ids',
2299
'bzrlib.tests.test_globbing',
2300
'bzrlib.tests.test_gpg',
2301
'bzrlib.tests.test_graph',
2302
'bzrlib.tests.test_hashcache',
2303
'bzrlib.tests.test_help',
2304
'bzrlib.tests.test_http',
2305
'bzrlib.tests.test_http_response',
2306
'bzrlib.tests.test_https_ca_bundle',
2307
'bzrlib.tests.test_identitymap',
2308
'bzrlib.tests.test_ignores',
2309
'bzrlib.tests.test_inv',
2310
'bzrlib.tests.test_knit',
2311
'bzrlib.tests.test_lazy_import',
2312
'bzrlib.tests.test_lazy_regex',
2313
'bzrlib.tests.test_lockdir',
2314
'bzrlib.tests.test_lockable_files',
2315
'bzrlib.tests.test_log',
2316
'bzrlib.tests.test_memorytree',
2317
'bzrlib.tests.test_merge',
2318
'bzrlib.tests.test_merge3',
2319
'bzrlib.tests.test_merge_core',
2320
'bzrlib.tests.test_merge_directive',
2321
'bzrlib.tests.test_missing',
2322
'bzrlib.tests.test_msgeditor',
2323
'bzrlib.tests.test_nonascii',
2324
'bzrlib.tests.test_options',
2325
'bzrlib.tests.test_osutils',
2326
'bzrlib.tests.test_osutils_encodings',
2327
'bzrlib.tests.test_patch',
2328
'bzrlib.tests.test_patches',
2329
'bzrlib.tests.test_permissions',
2330
'bzrlib.tests.test_plugins',
2331
'bzrlib.tests.test_progress',
2332
'bzrlib.tests.test_reconcile',
2333
'bzrlib.tests.test_registry',
2334
'bzrlib.tests.test_remote',
2335
'bzrlib.tests.test_repository',
2336
'bzrlib.tests.test_revert',
2337
'bzrlib.tests.test_revision',
2338
'bzrlib.tests.test_revisionnamespaces',
2339
'bzrlib.tests.test_revisiontree',
2340
'bzrlib.tests.test_rio',
2341
'bzrlib.tests.test_sampler',
2342
'bzrlib.tests.test_selftest',
2343
'bzrlib.tests.test_setup',
2344
'bzrlib.tests.test_sftp_transport',
2345
'bzrlib.tests.test_smart',
2346
'bzrlib.tests.test_smart_add',
2347
'bzrlib.tests.test_smart_transport',
2348
'bzrlib.tests.test_source',
2349
'bzrlib.tests.test_ssh_transport',
2350
'bzrlib.tests.test_status',
2351
'bzrlib.tests.test_store',
2352
'bzrlib.tests.test_strace',
2353
'bzrlib.tests.test_subsume',
2354
'bzrlib.tests.test_symbol_versioning',
2355
'bzrlib.tests.test_tag',
2356
'bzrlib.tests.test_testament',
2357
'bzrlib.tests.test_textfile',
2358
'bzrlib.tests.test_textmerge',
2359
'bzrlib.tests.test_timestamp',
2360
'bzrlib.tests.test_trace',
2361
'bzrlib.tests.test_transactions',
2362
'bzrlib.tests.test_transform',
2363
'bzrlib.tests.test_transport',
2364
'bzrlib.tests.test_tree',
2365
'bzrlib.tests.test_treebuilder',
2366
'bzrlib.tests.test_tsort',
2367
'bzrlib.tests.test_tuned_gzip',
2368
'bzrlib.tests.test_ui',
2369
'bzrlib.tests.test_upgrade',
2370
'bzrlib.tests.test_urlutils',
2371
'bzrlib.tests.test_versionedfile',
2372
'bzrlib.tests.test_version',
2373
'bzrlib.tests.test_version_info',
2374
'bzrlib.tests.test_weave',
2375
'bzrlib.tests.test_whitebox',
2376
'bzrlib.tests.test_workingtree',
2377
'bzrlib.tests.test_workingtree_4',
2378
'bzrlib.tests.test_wsgi',
2379
'bzrlib.tests.test_xml',
2381
test_transport_implementations = [
2382
'bzrlib.tests.test_transport_implementations',
2383
'bzrlib.tests.test_read_bundle',
2385
suite = TestUtil.TestSuite()
2386
loader = TestUtil.TestLoader()
2387
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2388
from bzrlib.transport import TransportTestProviderAdapter
2389
adapter = TransportTestProviderAdapter()
2390
adapt_modules(test_transport_implementations, adapter, loader, suite)
2391
for package in packages_to_test():
2392
suite.addTest(package.test_suite())
2393
for m in MODULES_TO_TEST:
2394
suite.addTest(loader.loadTestsFromModule(m))
2395
for m in MODULES_TO_DOCTEST:
2397
suite.addTest(doctest.DocTestSuite(m))
2398
except ValueError, e:
2399
print '**failed to get doctest for: %s\n%s' %(m,e)
2401
for name, plugin in bzrlib.plugin.all_plugins().items():
2402
if getattr(plugin, 'test_suite', None) is not None:
2403
default_encoding = sys.getdefaultencoding()
2405
plugin_suite = plugin.test_suite()
2406
except ImportError, e:
2407
bzrlib.trace.warning(
2408
'Unable to test plugin "%s": %s', name, e)
2410
suite.addTest(plugin_suite)
2411
if default_encoding != sys.getdefaultencoding():
2412
bzrlib.trace.warning(
2413
'Plugin "%s" tried to reset default encoding to: %s', name,
2414
sys.getdefaultencoding())
2416
sys.setdefaultencoding(default_encoding)
2420
def adapt_modules(mods_list, adapter, loader, suite):
2421
"""Adapt the modules in mods_list using adapter and add to suite."""
2422
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2423
suite.addTests(adapter.adapt(test))
2426
def _rmtree_temp_dir(dirname):
2428
osutils.rmtree(dirname)
2430
if sys.platform == 'win32' and e.errno == errno.EACCES:
2431
print >>sys.stderr, ('Permission denied: '
2432
'unable to remove testing dir '
2433
'%s' % os.path.basename(dirname))
2438
def clean_selftest_output(root=None, quiet=False):
2439
"""Remove all selftest output directories from root directory.
2441
:param root: root directory for clean
2442
(if ommitted or None then clean current directory).
2443
:param quiet: suppress report about deleting directories
2446
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
2449
for i in os.listdir(root):
2450
if os.path.isdir(i) and re_dir.match(i):
2452
print 'delete directory:', i
2456
class Feature(object):
2457
"""An operating system Feature."""
2460
self._available = None
2462
def available(self):
2463
"""Is the feature available?
2465
:return: True if the feature is available.
2467
if self._available is None:
2468
self._available = self._probe()
2469
return self._available
2472
"""Implement this method in concrete features.
2474
:return: True if the feature is available.
2476
raise NotImplementedError
2479
if getattr(self, 'feature_name', None):
2480
return self.feature_name()
2481
return self.__class__.__name__
added
removed
bzrlib/tests/__init__.py
