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
41
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
# this list of hooks must be kept in sync with the defaults
785
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
786
bzrlib.smart.server.SmartTCPServer.hooks = \
787
bzrlib.smart.server.SmartServerHooks()
789
def _silenceUI(self):
790
"""Turn off UI for duration of test"""
791
# by default the UI is off; tests can turn it on if they want it.
792
saved = ui.ui_factory
794
ui.ui_factory = saved
795
ui.ui_factory = ui.SilentUIFactory()
796
self.addCleanup(_restore)
798
def _ndiff_strings(self, a, b):
799
"""Return ndiff between two strings containing lines.
801
A trailing newline is added if missing to make the strings
803
if b and b[-1] != '\n':
805
if a and a[-1] != '\n':
807
difflines = difflib.ndiff(a.splitlines(True),
809
linejunk=lambda x: False,
810
charjunk=lambda x: False)
811
return ''.join(difflines)
813
def assertEqual(self, a, b, message=''):
817
except UnicodeError, e:
818
# If we can't compare without getting a UnicodeError, then
819
# obviously they are different
820
mutter('UnicodeError: %s', e)
823
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
825
pformat(a, indent=4), pformat(b, indent=4)))
827
assertEquals = assertEqual
829
def assertEqualDiff(self, a, b, message=None):
830
"""Assert two texts are equal, if not raise an exception.
832
This is intended for use with multi-line strings where it can
833
be hard to find the differences by eye.
835
# TODO: perhaps override assertEquals to call this for strings?
839
message = "texts not equal:\n"
840
raise AssertionError(message +
841
self._ndiff_strings(a, b))
843
def assertEqualMode(self, mode, mode_test):
844
self.assertEqual(mode, mode_test,
845
'mode mismatch %o != %o' % (mode, mode_test))
847
def assertStartsWith(self, s, prefix):
848
if not s.startswith(prefix):
849
raise AssertionError('string %r does not start with %r' % (s, prefix))
851
def assertEndsWith(self, s, suffix):
852
"""Asserts that s ends with suffix."""
853
if not s.endswith(suffix):
854
raise AssertionError('string %r does not end with %r' % (s, suffix))
856
def assertContainsRe(self, haystack, needle_re):
857
"""Assert that a contains something matching a regular expression."""
858
if not re.search(needle_re, haystack):
859
raise AssertionError('pattern "%r" not found in "%r"'
860
% (needle_re, haystack))
862
def assertNotContainsRe(self, haystack, needle_re):
863
"""Assert that a does not match a regular expression"""
864
if re.search(needle_re, haystack):
865
raise AssertionError('pattern "%s" found in "%s"'
866
% (needle_re, haystack))
868
def assertSubset(self, sublist, superlist):
869
"""Assert that every entry in sublist is present in superlist."""
871
for entry in sublist:
872
if entry not in superlist:
873
missing.append(entry)
875
raise AssertionError("value(s) %r not present in container %r" %
876
(missing, superlist))
878
def assertListRaises(self, excClass, func, *args, **kwargs):
879
"""Fail unless excClass is raised when the iterator from func is used.
881
Many functions can return generators this makes sure
882
to wrap them in a list() call to make sure the whole generator
883
is run, and that the proper exception is raised.
886
list(func(*args, **kwargs))
890
if getattr(excClass,'__name__', None) is not None:
891
excName = excClass.__name__
893
excName = str(excClass)
894
raise self.failureException, "%s not raised" % excName
896
def assertRaises(self, excClass, func, *args, **kwargs):
897
"""Assert that a callable raises a particular exception.
899
:param excClass: As for the except statement, this may be either an
900
exception class, or a tuple of classes.
902
Returns the exception so that you can examine it.
905
func(*args, **kwargs)
909
if getattr(excClass,'__name__', None) is not None:
910
excName = excClass.__name__
913
excName = str(excClass)
914
raise self.failureException, "%s not raised" % excName
916
def assertIs(self, left, right, message=None):
917
if not (left is right):
918
if message is not None:
919
raise AssertionError(message)
921
raise AssertionError("%r is not %r." % (left, right))
923
def assertIsNot(self, left, right, message=None):
925
if message is not None:
926
raise AssertionError(message)
928
raise AssertionError("%r is %r." % (left, right))
930
def assertTransportMode(self, transport, path, mode):
931
"""Fail if a path does not have mode mode.
933
If modes are not supported on this transport, the assertion is ignored.
935
if not transport._can_roundtrip_unix_modebits():
937
path_stat = transport.stat(path)
938
actual_mode = stat.S_IMODE(path_stat.st_mode)
939
self.assertEqual(mode, actual_mode,
940
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
942
def assertIsInstance(self, obj, kls):
943
"""Fail if obj is not an instance of kls"""
944
if not isinstance(obj, kls):
945
self.fail("%r is an instance of %s rather than %s" % (
946
obj, obj.__class__, kls))
948
def expectFailure(self, reason, assertion, *args, **kwargs):
949
"""Invoke a test, expecting it to fail for the given reason.
951
This is for assertions that ought to succeed, but currently fail.
952
(The failure is *expected* but not *wanted*.) Please be very precise
953
about the failure you're expecting. If a new bug is introduced,
954
AssertionError should be raised, not KnownFailure.
956
Frequently, expectFailure should be followed by an opposite assertion.
959
Intended to be used with a callable that raises AssertionError as the
960
'assertion' parameter. args and kwargs are passed to the 'assertion'.
962
Raises KnownFailure if the test fails. Raises AssertionError if the
967
self.expectFailure('Math is broken', self.assertNotEqual, 54,
969
self.assertEqual(42, dynamic_val)
971
This means that a dynamic_val of 54 will cause the test to raise
972
a KnownFailure. Once math is fixed and the expectFailure is removed,
973
only a dynamic_val of 42 will allow the test to pass. Anything other
974
than 54 or 42 will cause an AssertionError.
977
assertion(*args, **kwargs)
978
except AssertionError:
979
raise KnownFailure(reason)
981
self.fail('Unexpected success. Should have failed: %s' % reason)
983
def _capture_warnings(self, a_callable, *args, **kwargs):
984
"""A helper for callDeprecated and applyDeprecated.
986
:param a_callable: A callable to call.
987
:param args: The positional arguments for the callable
988
:param kwargs: The keyword arguments for the callable
989
:return: A tuple (warnings, result). result is the result of calling
990
a_callable(*args, **kwargs).
993
def capture_warnings(msg, cls=None, stacklevel=None):
994
# we've hooked into a deprecation specific callpath,
995
# only deprecations should getting sent via it.
996
self.assertEqual(cls, DeprecationWarning)
997
local_warnings.append(msg)
998
original_warning_method = symbol_versioning.warn
999
symbol_versioning.set_warning_method(capture_warnings)
1001
result = a_callable(*args, **kwargs)
1003
symbol_versioning.set_warning_method(original_warning_method)
1004
return (local_warnings, result)
1006
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1007
"""Call a deprecated callable without warning the user.
1009
:param deprecation_format: The deprecation format that the callable
1010
should have been deprecated with. This is the same type as the
1011
parameter to deprecated_method/deprecated_function. If the
1012
callable is not deprecated with this format, an assertion error
1014
:param a_callable: A callable to call. This may be a bound method or
1015
a regular function. It will be called with *args and **kwargs.
1016
:param args: The positional arguments for the callable
1017
:param kwargs: The keyword arguments for the callable
1018
:return: The result of a_callable(*args, **kwargs)
1020
call_warnings, result = self._capture_warnings(a_callable,
1022
expected_first_warning = symbol_versioning.deprecation_string(
1023
a_callable, deprecation_format)
1024
if len(call_warnings) == 0:
1025
self.fail("No deprecation warning generated by call to %s" %
1027
self.assertEqual(expected_first_warning, call_warnings[0])
1030
def callDeprecated(self, expected, callable, *args, **kwargs):
1031
"""Assert that a callable is deprecated in a particular way.
1033
This is a very precise test for unusual requirements. The
1034
applyDeprecated helper function is probably more suited for most tests
1035
as it allows you to simply specify the deprecation format being used
1036
and will ensure that that is issued for the function being called.
1038
:param expected: a list of the deprecation warnings expected, in order
1039
:param callable: The callable to call
1040
:param args: The positional arguments for the callable
1041
:param kwargs: The keyword arguments for the callable
1043
call_warnings, result = self._capture_warnings(callable,
1045
self.assertEqual(expected, call_warnings)
1048
def _startLogFile(self):
1049
"""Send bzr and test log messages to a temporary file.
1051
The file is removed as the test is torn down.
1053
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1054
self._log_file = os.fdopen(fileno, 'w+')
1055
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1056
self._log_file_name = name
1057
self.addCleanup(self._finishLogFile)
1059
def _finishLogFile(self):
1060
"""Finished with the log file.
1062
Close the file and delete it, unless setKeepLogfile was called.
1064
if self._log_file is None:
1066
bzrlib.trace.disable_test_log(self._log_nonce)
1067
self._log_file.close()
1068
self._log_file = None
1069
if not self._keep_log_file:
1070
os.remove(self._log_file_name)
1071
self._log_file_name = None
1073
def setKeepLogfile(self):
1074
"""Make the logfile not be deleted when _finishLogFile is called."""
1075
self._keep_log_file = True
1077
def addCleanup(self, callable):
1078
"""Arrange to run a callable when this case is torn down.
1080
Callables are run in the reverse of the order they are registered,
1081
ie last-in first-out.
1083
if callable in self._cleanups:
1084
raise ValueError("cleanup function %r already registered on %s"
1086
self._cleanups.append(callable)
1088
def _cleanEnvironment(self):
1090
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1091
'HOME': os.getcwd(),
1092
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1094
'BZREMAIL': None, # may still be present in the environment
1096
'BZR_PROGRESS_BAR': None,
1100
'https_proxy': None,
1101
'HTTPS_PROXY': None,
1106
# Nobody cares about these ones AFAIK. So far at
1107
# least. If you do (care), please update this comment
1113
self.addCleanup(self._restoreEnvironment)
1114
for name, value in new_env.iteritems():
1115
self._captureVar(name, value)
1117
def _captureVar(self, name, newvalue):
1118
"""Set an environment variable, and reset it when finished."""
1119
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1121
def _restoreEnvironment(self):
1122
for name, value in self.__old_env.iteritems():
1123
osutils.set_or_unset_env(name, value)
1125
def _restoreHooks(self):
1126
for klass, hooks in self._preserved_hooks.items():
1127
setattr(klass, 'hooks', hooks)
1129
def knownFailure(self, reason):
1130
"""This test has failed for some known reason."""
1131
raise KnownFailure(reason)
1133
def run(self, result=None):
1134
if result is None: result = self.defaultTestResult()
1135
for feature in getattr(self, '_test_needs_features', []):
1136
if not feature.available():
1137
result.startTest(self)
1138
if getattr(result, 'addNotSupported', None):
1139
result.addNotSupported(self, feature)
1141
result.addSuccess(self)
1142
result.stopTest(self)
1144
return unittest.TestCase.run(self, result)
1148
unittest.TestCase.tearDown(self)
1150
def time(self, callable, *args, **kwargs):
1151
"""Run callable and accrue the time it takes to the benchmark time.
1153
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1154
this will cause lsprofile statistics to be gathered and stored in
1157
if self._benchtime is None:
1161
if not self._gather_lsprof_in_benchmarks:
1162
return callable(*args, **kwargs)
1164
# record this benchmark
1165
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1167
self._benchcalls.append(((callable, args, kwargs), stats))
1170
self._benchtime += time.time() - start
1172
def _runCleanups(self):
1173
"""Run registered cleanup functions.
1175
This should only be called from TestCase.tearDown.
1177
# TODO: Perhaps this should keep running cleanups even if
1178
# one of them fails?
1180
# Actually pop the cleanups from the list so tearDown running
1181
# twice is safe (this happens for skipped tests).
1182
while self._cleanups:
1183
self._cleanups.pop()()
1185
def log(self, *args):
1188
def _get_log(self, keep_log_file=False):
1189
"""Return as a string the log for this test. If the file is still
1190
on disk and keep_log_file=False, delete the log file and store the
1191
content in self._log_contents."""
1192
# flush the log file, to get all content
1194
bzrlib.trace._trace_file.flush()
1195
if self._log_contents:
1196
return self._log_contents
1197
if self._log_file_name is not None:
1198
logfile = open(self._log_file_name)
1200
log_contents = logfile.read()
1203
if not keep_log_file:
1204
self._log_contents = log_contents
1206
os.remove(self._log_file_name)
1208
if sys.platform == 'win32' and e.errno == errno.EACCES:
1209
print >>sys.stderr, ('Unable to delete log file '
1210
' %r' % self._log_file_name)
1215
return "DELETED log file to reduce memory footprint"
1217
def capture(self, cmd, retcode=0):
1218
"""Shortcut that splits cmd into words, runs, and returns stdout"""
1219
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
1221
def requireFeature(self, feature):
1222
"""This test requires a specific feature is available.
1224
:raises UnavailableFeature: When feature is not available.
1226
if not feature.available():
1227
raise UnavailableFeature(feature)
1229
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
1231
"""Invoke bzr and return (stdout, stderr).
1233
Useful for code that wants to check the contents of the
1234
output, the way error messages are presented, etc.
1236
This should be the main method for tests that want to exercise the
1237
overall behavior of the bzr application (rather than a unit test
1238
or a functional test of the library.)
1240
Much of the old code runs bzr by forking a new copy of Python, but
1241
that is slower, harder to debug, and generally not necessary.
1243
This runs bzr through the interface that catches and reports
1244
errors, and with logging set to something approximating the
1245
default, so that error reporting can be checked.
1247
:param argv: arguments to invoke bzr
1248
:param retcode: expected return code, or None for don't-care.
1249
:param encoding: encoding for sys.stdout and sys.stderr
1250
:param stdin: A string to be used as stdin for the command.
1251
:param working_dir: Change to this directory before running
1253
if encoding is None:
1254
encoding = bzrlib.user_encoding
1255
stdout = StringIOWrapper()
1256
stderr = StringIOWrapper()
1257
stdout.encoding = encoding
1258
stderr.encoding = encoding
1260
self.log('run bzr: %r', argv)
1261
# FIXME: don't call into logging here
1262
handler = logging.StreamHandler(stderr)
1263
handler.setLevel(logging.INFO)
1264
logger = logging.getLogger('')
1265
logger.addHandler(handler)
1266
old_ui_factory = ui.ui_factory
1267
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1270
if working_dir is not None:
1271
cwd = osutils.getcwd()
1272
os.chdir(working_dir)
1275
saved_debug_flags = frozenset(debug.debug_flags)
1276
debug.debug_flags.clear()
1278
result = self.apply_redirected(ui.ui_factory.stdin,
1280
bzrlib.commands.run_bzr_catch_errors,
1283
debug.debug_flags.update(saved_debug_flags)
1285
logger.removeHandler(handler)
1286
ui.ui_factory = old_ui_factory
1290
out = stdout.getvalue()
1291
err = stderr.getvalue()
1293
self.log('output:\n%r', out)
1295
self.log('errors:\n%r', err)
1296
if retcode is not None:
1297
self.assertEquals(retcode, result)
1300
def run_bzr(self, *args, **kwargs):
1301
"""Invoke bzr, as if it were run from the command line.
1303
This should be the main method for tests that want to exercise the
1304
overall behavior of the bzr application (rather than a unit test
1305
or a functional test of the library.)
1307
This sends the stdout/stderr results into the test's log,
1308
where it may be useful for debugging. See also run_captured.
1310
:param stdin: A string to be used as stdin for the command.
1311
:param retcode: The status code the command should return
1312
:param working_dir: The directory to run the command in
1314
retcode = kwargs.pop('retcode', 0)
1315
encoding = kwargs.pop('encoding', None)
1316
stdin = kwargs.pop('stdin', None)
1317
working_dir = kwargs.pop('working_dir', None)
1318
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding,
1319
stdin=stdin, working_dir=working_dir)
1321
def run_bzr_decode(self, *args, **kwargs):
1322
if 'encoding' in kwargs:
1323
encoding = kwargs['encoding']
1325
encoding = bzrlib.user_encoding
1326
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1328
def run_bzr_error(self, error_regexes, *args, **kwargs):
1329
"""Run bzr, and check that stderr contains the supplied regexes
1331
:param error_regexes: Sequence of regular expressions which
1332
must each be found in the error output. The relative ordering
1334
:param args: command-line arguments for bzr
1335
:param kwargs: Keyword arguments which are interpreted by run_bzr
1336
This function changes the default value of retcode to be 3,
1337
since in most cases this is run when you expect bzr to fail.
1338
:return: (out, err) The actual output of running the command (in case you
1339
want to do more inspection)
1342
# Make sure that commit is failing because there is nothing to do
1343
self.run_bzr_error(['no changes to commit'],
1344
'commit', '-m', 'my commit comment')
1345
# Make sure --strict is handling an unknown file, rather than
1346
# giving us the 'nothing to do' error
1347
self.build_tree(['unknown'])
1348
self.run_bzr_error(['Commit refused because there are unknown files'],
1349
'commit', '--strict', '-m', 'my commit comment')
1351
kwargs.setdefault('retcode', 3)
1352
out, err = self.run_bzr(*args, **kwargs)
1353
for regex in error_regexes:
1354
self.assertContainsRe(err, regex)
1357
def run_bzr_subprocess(self, *args, **kwargs):
1358
"""Run bzr in a subprocess for testing.
1360
This starts a new Python interpreter and runs bzr in there.
1361
This should only be used for tests that have a justifiable need for
1362
this isolation: e.g. they are testing startup time, or signal
1363
handling, or early startup code, etc. Subprocess code can't be
1364
profiled or debugged so easily.
1366
:param retcode: The status code that is expected. Defaults to 0. If
1367
None is supplied, the status code is not checked.
1368
:param env_changes: A dictionary which lists changes to environment
1369
variables. A value of None will unset the env variable.
1370
The values must be strings. The change will only occur in the
1371
child, so you don't need to fix the environment after running.
1372
:param universal_newlines: Convert CRLF => LF
1373
:param allow_plugins: By default the subprocess is run with
1374
--no-plugins to ensure test reproducibility. Also, it is possible
1375
for system-wide plugins to create unexpected output on stderr,
1376
which can cause unnecessary test failures.
1378
env_changes = kwargs.get('env_changes', {})
1379
working_dir = kwargs.get('working_dir', None)
1380
allow_plugins = kwargs.get('allow_plugins', False)
1381
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1382
working_dir=working_dir,
1383
allow_plugins=allow_plugins)
1384
# We distinguish between retcode=None and retcode not passed.
1385
supplied_retcode = kwargs.get('retcode', 0)
1386
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1387
universal_newlines=kwargs.get('universal_newlines', False),
1390
def start_bzr_subprocess(self, process_args, env_changes=None,
1391
skip_if_plan_to_signal=False,
1393
allow_plugins=False):
1394
"""Start bzr in a subprocess for testing.
1396
This starts a new Python interpreter and runs bzr in there.
1397
This should only be used for tests that have a justifiable need for
1398
this isolation: e.g. they are testing startup time, or signal
1399
handling, or early startup code, etc. Subprocess code can't be
1400
profiled or debugged so easily.
1402
:param process_args: a list of arguments to pass to the bzr executable,
1403
for example `['--version']`.
1404
:param env_changes: A dictionary which lists changes to environment
1405
variables. A value of None will unset the env variable.
1406
The values must be strings. The change will only occur in the
1407
child, so you don't need to fix the environment after running.
1408
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1410
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1412
:returns: Popen object for the started process.
1414
if skip_if_plan_to_signal:
1415
if not getattr(os, 'kill', None):
1416
raise TestSkipped("os.kill not available.")
1418
if env_changes is None:
1422
def cleanup_environment():
1423
for env_var, value in env_changes.iteritems():
1424
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1426
def restore_environment():
1427
for env_var, value in old_env.iteritems():
1428
osutils.set_or_unset_env(env_var, value)
1430
bzr_path = self.get_bzr_path()
1433
if working_dir is not None:
1434
cwd = osutils.getcwd()
1435
os.chdir(working_dir)
1438
# win32 subprocess doesn't support preexec_fn
1439
# so we will avoid using it on all platforms, just to
1440
# make sure the code path is used, and we don't break on win32
1441
cleanup_environment()
1442
command = [sys.executable, bzr_path]
1443
if not allow_plugins:
1444
command.append('--no-plugins')
1445
command.extend(process_args)
1446
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1448
restore_environment()
1454
def _popen(self, *args, **kwargs):
1455
"""Place a call to Popen.
1457
Allows tests to override this method to intercept the calls made to
1458
Popen for introspection.
1460
return Popen(*args, **kwargs)
1462
def get_bzr_path(self):
1463
"""Return the path of the 'bzr' executable for this test suite."""
1464
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1465
if not os.path.isfile(bzr_path):
1466
# We are probably installed. Assume sys.argv is the right file
1467
bzr_path = sys.argv[0]
1470
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1471
universal_newlines=False, process_args=None):
1472
"""Finish the execution of process.
1474
:param process: the Popen object returned from start_bzr_subprocess.
1475
:param retcode: The status code that is expected. Defaults to 0. If
1476
None is supplied, the status code is not checked.
1477
:param send_signal: an optional signal to send to the process.
1478
:param universal_newlines: Convert CRLF => LF
1479
:returns: (stdout, stderr)
1481
if send_signal is not None:
1482
os.kill(process.pid, send_signal)
1483
out, err = process.communicate()
1485
if universal_newlines:
1486
out = out.replace('\r\n', '\n')
1487
err = err.replace('\r\n', '\n')
1489
if retcode is not None and retcode != process.returncode:
1490
if process_args is None:
1491
process_args = "(unknown args)"
1492
mutter('Output of bzr %s:\n%s', process_args, out)
1493
mutter('Error for bzr %s:\n%s', process_args, err)
1494
self.fail('Command bzr %s failed with retcode %s != %s'
1495
% (process_args, retcode, process.returncode))
1498
def check_inventory_shape(self, inv, shape):
1499
"""Compare an inventory to a list of expected names.
1501
Fail if they are not precisely equal.
1504
shape = list(shape) # copy
1505
for path, ie in inv.entries():
1506
name = path.replace('\\', '/')
1507
if ie.kind == 'dir':
1514
self.fail("expected paths not found in inventory: %r" % shape)
1516
self.fail("unexpected paths found in inventory: %r" % extras)
1518
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1519
a_callable=None, *args, **kwargs):
1520
"""Call callable with redirected std io pipes.
1522
Returns the return code."""
1523
if not callable(a_callable):
1524
raise ValueError("a_callable must be callable.")
1526
stdin = StringIO("")
1528
if getattr(self, "_log_file", None) is not None:
1529
stdout = self._log_file
1533
if getattr(self, "_log_file", None is not None):
1534
stderr = self._log_file
1537
real_stdin = sys.stdin
1538
real_stdout = sys.stdout
1539
real_stderr = sys.stderr
1544
return a_callable(*args, **kwargs)
1546
sys.stdout = real_stdout
1547
sys.stderr = real_stderr
1548
sys.stdin = real_stdin
1550
@symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
1551
def merge(self, branch_from, wt_to):
1552
"""A helper for tests to do a ui-less merge.
1554
This should move to the main library when someone has time to integrate
1557
# minimal ui-less merge.
1558
wt_to.branch.fetch(branch_from)
1559
base_rev = common_ancestor(branch_from.last_revision(),
1560
wt_to.branch.last_revision(),
1561
wt_to.branch.repository)
1562
merge_inner(wt_to.branch, branch_from.basis_tree(),
1563
wt_to.branch.repository.revision_tree(base_rev),
1565
wt_to.add_parent_tree_id(branch_from.last_revision())
1567
def reduceLockdirTimeout(self):
1568
"""Reduce the default lock timeout for the duration of the test, so that
1569
if LockContention occurs during a test, it does so quickly.
1571
Tests that expect to provoke LockContention errors should call this.
1573
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1575
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1576
self.addCleanup(resetTimeout)
1577
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1579
BzrTestBase = TestCase
1582
class TestCaseWithMemoryTransport(TestCase):
1583
"""Common test class for tests that do not need disk resources.
1585
Tests that need disk resources should derive from TestCaseWithTransport.
1587
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1589
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1590
a directory which does not exist. This serves to help ensure test isolation
1591
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1592
must exist. However, TestCaseWithMemoryTransport does not offer local
1593
file defaults for the transport in tests, nor does it obey the command line
1594
override, so tests that accidentally write to the common directory should
1602
def __init__(self, methodName='runTest'):
1603
# allow test parameterisation after test construction and before test
1604
# execution. Variables that the parameteriser sets need to be
1605
# ones that are not set by setUp, or setUp will trash them.
1606
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1607
self.vfs_transport_factory = default_transport
1608
self.transport_server = None
1609
self.transport_readonly_server = None
1610
self.__vfs_server = None
1612
def get_transport(self):
1613
"""Return a writeable transport for the test scratch space"""
1614
t = get_transport(self.get_url())
1615
self.assertFalse(t.is_readonly())
1618
def get_readonly_transport(self):
1619
"""Return a readonly transport for the test scratch space
1621
This can be used to test that operations which should only need
1622
readonly access in fact do not try to write.
1624
t = get_transport(self.get_readonly_url())
1625
self.assertTrue(t.is_readonly())
1628
def create_transport_readonly_server(self):
1629
"""Create a transport server from class defined at init.
1631
This is mostly a hook for daughter classes.
1633
return self.transport_readonly_server()
1635
def get_readonly_server(self):
1636
"""Get the server instance for the readonly transport
1638
This is useful for some tests with specific servers to do diagnostics.
1640
if self.__readonly_server is None:
1641
if self.transport_readonly_server is None:
1642
# readonly decorator requested
1643
# bring up the server
1644
self.__readonly_server = ReadonlyServer()
1645
self.__readonly_server.setUp(self.get_vfs_only_server())
1647
self.__readonly_server = self.create_transport_readonly_server()
1648
self.__readonly_server.setUp(self.get_vfs_only_server())
1649
self.addCleanup(self.__readonly_server.tearDown)
1650
return self.__readonly_server
1652
def get_readonly_url(self, relpath=None):
1653
"""Get a URL for the readonly transport.
1655
This will either be backed by '.' or a decorator to the transport
1656
used by self.get_url()
1657
relpath provides for clients to get a path relative to the base url.
1658
These should only be downwards relative, not upwards.
1660
base = self.get_readonly_server().get_url()
1661
if relpath is not None:
1662
if not base.endswith('/'):
1664
base = base + relpath
1667
def get_vfs_only_server(self):
1668
"""Get the vfs only read/write server instance.
1670
This is useful for some tests with specific servers that need
1673
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1674
is no means to override it.
1676
if self.__vfs_server is None:
1677
self.__vfs_server = MemoryServer()
1678
self.__vfs_server.setUp()
1679
self.addCleanup(self.__vfs_server.tearDown)
1680
return self.__vfs_server
1682
def get_server(self):
1683
"""Get the read/write server instance.
1685
This is useful for some tests with specific servers that need
1688
This is built from the self.transport_server factory. If that is None,
1689
then the self.get_vfs_server is returned.
1691
if self.__server is None:
1692
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1693
return self.get_vfs_only_server()
1695
# bring up a decorated means of access to the vfs only server.
1696
self.__server = self.transport_server()
1698
self.__server.setUp(self.get_vfs_only_server())
1699
except TypeError, e:
1700
# This should never happen; the try:Except here is to assist
1701
# developers having to update code rather than seeing an
1702
# uninformative TypeError.
1703
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1704
self.addCleanup(self.__server.tearDown)
1705
return self.__server
1707
def _adjust_url(self, base, relpath):
1708
"""Get a URL (or maybe a path) for the readwrite transport.
1710
This will either be backed by '.' or to an equivalent non-file based
1712
relpath provides for clients to get a path relative to the base url.
1713
These should only be downwards relative, not upwards.
1715
if relpath is not None and relpath != '.':
1716
if not base.endswith('/'):
1718
# XXX: Really base should be a url; we did after all call
1719
# get_url()! But sometimes it's just a path (from
1720
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1721
# to a non-escaped local path.
1722
if base.startswith('./') or base.startswith('/'):
1725
base += urlutils.escape(relpath)
1728
def get_url(self, relpath=None):
1729
"""Get a URL (or maybe a path) for the readwrite transport.
1731
This will either be backed by '.' or to an equivalent non-file based
1733
relpath provides for clients to get a path relative to the base url.
1734
These should only be downwards relative, not upwards.
1736
base = self.get_server().get_url()
1737
return self._adjust_url(base, relpath)
1739
def get_vfs_only_url(self, relpath=None):
1740
"""Get a URL (or maybe a path for the plain old vfs transport.
1742
This will never be a smart protocol.
1743
:param relpath: provides for clients to get a path relative to the base
1744
url. These should only be downwards relative, not upwards.
1746
base = self.get_vfs_only_server().get_url()
1747
return self._adjust_url(base, relpath)
1749
def _make_test_root(self):
1750
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1754
root = u'test%04d.tmp' % i
1758
if e.errno == errno.EEXIST:
1763
# successfully created
1764
TestCaseWithMemoryTransport.TEST_ROOT = osutils.abspath(root)
1766
# make a fake bzr directory there to prevent any tests propagating
1767
# up onto the source directory's real branch
1768
bzrdir.BzrDir.create_standalone_workingtree(
1769
TestCaseWithMemoryTransport.TEST_ROOT)
1771
def makeAndChdirToTestDir(self):
1772
"""Create a temporary directories for this one test.
1774
This must set self.test_home_dir and self.test_dir and chdir to
1777
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1779
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1780
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1781
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1783
def make_branch(self, relpath, format=None):
1784
"""Create a branch on the transport at relpath."""
1785
repo = self.make_repository(relpath, format=format)
1786
return repo.bzrdir.create_branch()
1788
def make_bzrdir(self, relpath, format=None):
1790
# might be a relative or absolute path
1791
maybe_a_url = self.get_url(relpath)
1792
segments = maybe_a_url.rsplit('/', 1)
1793
t = get_transport(maybe_a_url)
1794
if len(segments) > 1 and segments[-1] not in ('', '.'):
1797
except errors.FileExists:
1801
if isinstance(format, basestring):
1802
format = bzrdir.format_registry.make_bzrdir(format)
1803
return format.initialize_on_transport(t)
1804
except errors.UninitializableFormat:
1805
raise TestSkipped("Format %s is not initializable." % format)
1807
def make_repository(self, relpath, shared=False, format=None):
1808
"""Create a repository on our default transport at relpath."""
1809
made_control = self.make_bzrdir(relpath, format=format)
1810
return made_control.create_repository(shared=shared)
1812
def make_branch_and_memory_tree(self, relpath, format=None):
1813
"""Create a branch on the default transport and a MemoryTree for it."""
1814
b = self.make_branch(relpath, format=format)
1815
return memorytree.MemoryTree.create_on_branch(b)
1817
def overrideEnvironmentForTesting(self):
1818
os.environ['HOME'] = self.test_home_dir
1819
os.environ['BZR_HOME'] = self.test_home_dir
1822
super(TestCaseWithMemoryTransport, self).setUp()
1823
self._make_test_root()
1824
_currentdir = os.getcwdu()
1825
def _leaveDirectory():
1826
os.chdir(_currentdir)
1827
self.addCleanup(_leaveDirectory)
1828
self.makeAndChdirToTestDir()
1829
self.overrideEnvironmentForTesting()
1830
self.__readonly_server = None
1831
self.__server = None
1832
self.reduceLockdirTimeout()
1835
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1836
"""Derived class that runs a test within a temporary directory.
1838
This is useful for tests that need to create a branch, etc.
1840
The directory is created in a slightly complex way: for each
1841
Python invocation, a new temporary top-level directory is created.
1842
All test cases create their own directory within that. If the
1843
tests complete successfully, the directory is removed.
1845
InTempDir is an old alias for FunctionalTestCase.
1848
OVERRIDE_PYTHON = 'python'
1849
use_numbered_dirs = False
1851
def check_file_contents(self, filename, expect):
1852
self.log("check contents of file %s" % filename)
1853
contents = file(filename, 'r').read()
1854
if contents != expect:
1855
self.log("expected: %r" % expect)
1856
self.log("actually: %r" % contents)
1857
self.fail("contents of %s not as expected" % filename)
1859
def makeAndChdirToTestDir(self):
1860
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1862
For TestCaseInTempDir we create a temporary directory based on the test
1863
name and then create two subdirs - test and home under it.
1865
if self.use_numbered_dirs: # strongly recommended on Windows
1866
# due the path length limitation (260 ch.)
1867
candidate_dir = '%s/%dK/%05d' % (self.TEST_ROOT,
1868
int(self.number/1000),
1870
os.makedirs(candidate_dir)
1871
self.test_home_dir = candidate_dir + '/home'
1872
os.mkdir(self.test_home_dir)
1873
self.test_dir = candidate_dir + '/work'
1874
os.mkdir(self.test_dir)
1875
os.chdir(self.test_dir)
1876
# put name of test inside
1877
f = file(candidate_dir + '/name', 'w')
1882
# shorten the name, to avoid test failures due to path length
1883
short_id = self.id().replace('bzrlib.tests.', '') \
1884
.replace('__main__.', '')[-100:]
1885
# it's possible the same test class is run several times for
1886
# parameterized tests, so make sure the names don't collide.
1890
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1892
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1893
if os.path.exists(candidate_dir):
1897
os.mkdir(candidate_dir)
1898
self.test_home_dir = candidate_dir + '/home'
1899
os.mkdir(self.test_home_dir)
1900
self.test_dir = candidate_dir + '/work'
1901
os.mkdir(self.test_dir)
1902
os.chdir(self.test_dir)
1905
def build_tree(self, shape, line_endings='binary', transport=None):
1906
"""Build a test tree according to a pattern.
1908
shape is a sequence of file specifications. If the final
1909
character is '/', a directory is created.
1911
This assumes that all the elements in the tree being built are new.
1913
This doesn't add anything to a branch.
1914
:param line_endings: Either 'binary' or 'native'
1915
in binary mode, exact contents are written
1916
in native mode, the line endings match the
1917
default platform endings.
1919
:param transport: A transport to write to, for building trees on
1920
VFS's. If the transport is readonly or None,
1921
"." is opened automatically.
1923
# It's OK to just create them using forward slashes on windows.
1924
if transport is None or transport.is_readonly():
1925
transport = get_transport(".")
1927
self.assert_(isinstance(name, basestring))
1929
transport.mkdir(urlutils.escape(name[:-1]))
1931
if line_endings == 'binary':
1933
elif line_endings == 'native':
1936
raise errors.BzrError(
1937
'Invalid line ending request %r' % line_endings)
1938
content = "contents of %s%s" % (name.encode('utf-8'), end)
1939
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1941
def build_tree_contents(self, shape):
1942
build_tree_contents(shape)
1944
def assertFileEqual(self, content, path):
1945
"""Fail if path does not contain 'content'."""
1946
self.failUnlessExists(path)
1947
# TODO: jam 20060427 Shouldn't this be 'rb'?
1953
self.assertEqualDiff(content, s)
1955
def failUnlessExists(self, path):
1956
"""Fail unless path, which may be abs or relative, exists."""
1957
self.failUnless(osutils.lexists(path),path+" does not exist")
1959
def failIfExists(self, path):
1960
"""Fail if path, which may be abs or relative, exists."""
1961
self.failIf(osutils.lexists(path),path+" exists")
1964
class TestCaseWithTransport(TestCaseInTempDir):
1965
"""A test case that provides get_url and get_readonly_url facilities.
1967
These back onto two transport servers, one for readonly access and one for
1970
If no explicit class is provided for readonly access, a
1971
ReadonlyTransportDecorator is used instead which allows the use of non disk
1972
based read write transports.
1974
If an explicit class is provided for readonly access, that server and the
1975
readwrite one must both define get_url() as resolving to os.getcwd().
1978
def get_vfs_only_server(self):
1979
"""See TestCaseWithMemoryTransport.
1981
This is useful for some tests with specific servers that need
1984
if self.__vfs_server is None:
1985
self.__vfs_server = self.vfs_transport_factory()
1986
self.__vfs_server.setUp()
1987
self.addCleanup(self.__vfs_server.tearDown)
1988
return self.__vfs_server
1990
def make_branch_and_tree(self, relpath, format=None):
1991
"""Create a branch on the transport and a tree locally.
1993
If the transport is not a LocalTransport, the Tree can't be created on
1994
the transport. In that case if the vfs_transport_factory is
1995
LocalURLServer the working tree is created in the local
1996
directory backing the transport, and the returned tree's branch and
1997
repository will also be accessed locally. Otherwise a lightweight
1998
checkout is created and returned.
2000
:param format: The BzrDirFormat.
2001
:returns: the WorkingTree.
2003
# TODO: always use the local disk path for the working tree,
2004
# this obviously requires a format that supports branch references
2005
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2007
b = self.make_branch(relpath, format=format)
2009
return b.bzrdir.create_workingtree()
2010
except errors.NotLocalUrl:
2011
# We can only make working trees locally at the moment. If the
2012
# transport can't support them, then we keep the non-disk-backed
2013
# branch and create a local checkout.
2014
if self.vfs_transport_factory is LocalURLServer:
2015
# the branch is colocated on disk, we cannot create a checkout.
2016
# hopefully callers will expect this.
2017
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2018
return local_controldir.create_workingtree()
2020
return b.create_checkout(relpath, lightweight=True)
2022
def assertIsDirectory(self, relpath, transport):
2023
"""Assert that relpath within transport is a directory.
2025
This may not be possible on all transports; in that case it propagates
2026
a TransportNotPossible.
2029
mode = transport.stat(relpath).st_mode
2030
except errors.NoSuchFile:
2031
self.fail("path %s is not a directory; no such file"
2033
if not stat.S_ISDIR(mode):
2034
self.fail("path %s is not a directory; has mode %#o"
2037
def assertTreesEqual(self, left, right):
2038
"""Check that left and right have the same content and properties."""
2039
# we use a tree delta to check for equality of the content, and we
2040
# manually check for equality of other things such as the parents list.
2041
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2042
differences = left.changes_from(right)
2043
self.assertFalse(differences.has_changed(),
2044
"Trees %r and %r are different: %r" % (left, right, differences))
2047
super(TestCaseWithTransport, self).setUp()
2048
self.__vfs_server = None
2051
class ChrootedTestCase(TestCaseWithTransport):
2052
"""A support class that provides readonly urls outside the local namespace.
2054
This is done by checking if self.transport_server is a MemoryServer. if it
2055
is then we are chrooted already, if it is not then an HttpServer is used
2058
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2059
be used without needed to redo it when a different
2060
subclass is in use ?
2064
super(ChrootedTestCase, self).setUp()
2065
if not self.vfs_transport_factory == MemoryServer:
2066
self.transport_readonly_server = HttpServer
2069
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2070
random_order=False):
2071
"""Create a test suite by filtering another one.
2073
:param suite: the source suite
2074
:param pattern: pattern that names must match
2075
:param exclude_pattern: pattern that names must not match, if any
2076
:param random_order: if True, tests in the new suite will be put in
2078
:returns: the newly created suite
2080
return sort_suite_by_re(suite, pattern, exclude_pattern,
2081
random_order, False)
2084
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2085
random_order=False, append_rest=True):
2086
"""Create a test suite by sorting another one.
2088
:param suite: the source suite
2089
:param pattern: pattern that names must match in order to go
2090
first in the new suite
2091
:param exclude_pattern: pattern that names must not match, if any
2092
:param random_order: if True, tests in the new suite will be put in
2094
:param append_rest: if False, pattern is a strict filter and not
2095
just an ordering directive
2096
:returns: the newly created suite
2100
filter_re = re.compile(pattern)
2101
if exclude_pattern is not None:
2102
exclude_re = re.compile(exclude_pattern)
2103
for test in iter_suite_tests(suite):
2105
if exclude_pattern is None or not exclude_re.search(test_id):
2106
if filter_re.search(test_id):
2111
random.shuffle(first)
2112
random.shuffle(second)
2113
return TestUtil.TestSuite(first + second)
2116
def run_suite(suite, name='test', verbose=False, pattern=".*",
2117
stop_on_failure=False, keep_output=False,
2118
transport=None, lsprof_timed=None, bench_history=None,
2119
matching_tests_first=None,
2123
exclude_pattern=None,
2125
use_numbered_dirs = bool(numbered_dirs)
2127
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2128
if numbered_dirs is not None:
2129
TestCaseInTempDir.use_numbered_dirs = use_numbered_dirs
2134
runner = TextTestRunner(stream=sys.stdout,
2136
verbosity=verbosity,
2137
keep_output=keep_output,
2138
bench_history=bench_history,
2139
use_numbered_dirs=use_numbered_dirs,
2140
list_only=list_only,
2142
runner.stop_on_failure=stop_on_failure
2143
# Initialise the random number generator and display the seed used.
2144
# We convert the seed to a long to make it reuseable across invocations.
2145
random_order = False
2146
if random_seed is not None:
2148
if random_seed == "now":
2149
random_seed = long(time.time())
2151
# Convert the seed to a long if we can
2153
random_seed = long(random_seed)
2156
runner.stream.writeln("Randomizing test order using seed %s\n" %
2158
random.seed(random_seed)
2159
# Customise the list of tests if requested
2160
if pattern != '.*' or exclude_pattern is not None or random_order:
2161
if matching_tests_first:
2162
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
2165
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
2167
result = runner.run(suite)
2168
return result.wasSuccessful()
2171
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2174
test_suite_factory=None,
2177
matching_tests_first=None,
2181
exclude_pattern=None):
2182
"""Run the whole test suite under the enhanced runner"""
2183
# XXX: Very ugly way to do this...
2184
# Disable warning about old formats because we don't want it to disturb
2185
# any blackbox tests.
2186
from bzrlib import repository
2187
repository._deprecation_warning_done = True
2189
global default_transport
2190
if transport is None:
2191
transport = default_transport
2192
old_transport = default_transport
2193
default_transport = transport
2195
if test_suite_factory is None:
2196
suite = test_suite()
2198
suite = test_suite_factory()
2199
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2200
stop_on_failure=stop_on_failure, keep_output=keep_output,
2201
transport=transport,
2202
lsprof_timed=lsprof_timed,
2203
bench_history=bench_history,
2204
matching_tests_first=matching_tests_first,
2205
numbered_dirs=numbered_dirs,
2206
list_only=list_only,
2207
random_seed=random_seed,
2208
exclude_pattern=exclude_pattern)
2210
default_transport = old_transport
2214
"""Build and return TestSuite for the whole of bzrlib.
2216
This function can be replaced if you need to change the default test
2217
suite on a global basis, but it is not encouraged.
2220
'bzrlib.tests.test_ancestry',
2221
'bzrlib.tests.test_annotate',
2222
'bzrlib.tests.test_api',
2223
'bzrlib.tests.test_atomicfile',
2224
'bzrlib.tests.test_bad_files',
2225
'bzrlib.tests.test_branch',
2226
'bzrlib.tests.test_bugtracker',
2227
'bzrlib.tests.test_bundle',
2228
'bzrlib.tests.test_bzrdir',
2229
'bzrlib.tests.test_cache_utf8',
2230
'bzrlib.tests.test_commands',
2231
'bzrlib.tests.test_commit',
2232
'bzrlib.tests.test_commit_merge',
2233
'bzrlib.tests.test_config',
2234
'bzrlib.tests.test_conflicts',
2235
'bzrlib.tests.test_decorators',
2236
'bzrlib.tests.test_delta',
2237
'bzrlib.tests.test_diff',
2238
'bzrlib.tests.test_dirstate',
2239
'bzrlib.tests.test_doc_generate',
2240
'bzrlib.tests.test_errors',
2241
'bzrlib.tests.test_escaped_store',
2242
'bzrlib.tests.test_extract',
2243
'bzrlib.tests.test_fetch',
2244
'bzrlib.tests.test_ftp_transport',
2245
'bzrlib.tests.test_generate_docs',
2246
'bzrlib.tests.test_generate_ids',
2247
'bzrlib.tests.test_globbing',
2248
'bzrlib.tests.test_gpg',
2249
'bzrlib.tests.test_graph',
2250
'bzrlib.tests.test_hashcache',
2251
'bzrlib.tests.test_help',
2252
'bzrlib.tests.test_http',
2253
'bzrlib.tests.test_http_response',
2254
'bzrlib.tests.test_https_ca_bundle',
2255
'bzrlib.tests.test_identitymap',
2256
'bzrlib.tests.test_ignores',
2257
'bzrlib.tests.test_inv',
2258
'bzrlib.tests.test_knit',
2259
'bzrlib.tests.test_lazy_import',
2260
'bzrlib.tests.test_lazy_regex',
2261
'bzrlib.tests.test_lockdir',
2262
'bzrlib.tests.test_lockable_files',
2263
'bzrlib.tests.test_log',
2264
'bzrlib.tests.test_memorytree',
2265
'bzrlib.tests.test_merge',
2266
'bzrlib.tests.test_merge3',
2267
'bzrlib.tests.test_merge_core',
2268
'bzrlib.tests.test_merge_directive',
2269
'bzrlib.tests.test_missing',
2270
'bzrlib.tests.test_msgeditor',
2271
'bzrlib.tests.test_nonascii',
2272
'bzrlib.tests.test_options',
2273
'bzrlib.tests.test_osutils',
2274
'bzrlib.tests.test_osutils_encodings',
2275
'bzrlib.tests.test_patch',
2276
'bzrlib.tests.test_patches',
2277
'bzrlib.tests.test_permissions',
2278
'bzrlib.tests.test_plugins',
2279
'bzrlib.tests.test_progress',
2280
'bzrlib.tests.test_reconcile',
2281
'bzrlib.tests.test_registry',
2282
'bzrlib.tests.test_remote',
2283
'bzrlib.tests.test_repository',
2284
'bzrlib.tests.test_revert',
2285
'bzrlib.tests.test_revision',
2286
'bzrlib.tests.test_revisionnamespaces',
2287
'bzrlib.tests.test_revisiontree',
2288
'bzrlib.tests.test_rio',
2289
'bzrlib.tests.test_sampler',
2290
'bzrlib.tests.test_selftest',
2291
'bzrlib.tests.test_setup',
2292
'bzrlib.tests.test_sftp_transport',
2293
'bzrlib.tests.test_smart',
2294
'bzrlib.tests.test_smart_add',
2295
'bzrlib.tests.test_smart_transport',
2296
'bzrlib.tests.test_source',
2297
'bzrlib.tests.test_ssh_transport',
2298
'bzrlib.tests.test_status',
2299
'bzrlib.tests.test_store',
2300
'bzrlib.tests.test_strace',
2301
'bzrlib.tests.test_subsume',
2302
'bzrlib.tests.test_symbol_versioning',
2303
'bzrlib.tests.test_tag',
2304
'bzrlib.tests.test_testament',
2305
'bzrlib.tests.test_textfile',
2306
'bzrlib.tests.test_textmerge',
2307
'bzrlib.tests.test_timestamp',
2308
'bzrlib.tests.test_trace',
2309
'bzrlib.tests.test_transactions',
2310
'bzrlib.tests.test_transform',
2311
'bzrlib.tests.test_transport',
2312
'bzrlib.tests.test_tree',
2313
'bzrlib.tests.test_treebuilder',
2314
'bzrlib.tests.test_tsort',
2315
'bzrlib.tests.test_tuned_gzip',
2316
'bzrlib.tests.test_ui',
2317
'bzrlib.tests.test_upgrade',
2318
'bzrlib.tests.test_urlutils',
2319
'bzrlib.tests.test_versionedfile',
2320
'bzrlib.tests.test_version',
2321
'bzrlib.tests.test_version_info',
2322
'bzrlib.tests.test_weave',
2323
'bzrlib.tests.test_whitebox',
2324
'bzrlib.tests.test_workingtree',
2325
'bzrlib.tests.test_workingtree_4',
2326
'bzrlib.tests.test_wsgi',
2327
'bzrlib.tests.test_xml',
2329
test_transport_implementations = [
2330
'bzrlib.tests.test_transport_implementations',
2331
'bzrlib.tests.test_read_bundle',
2333
suite = TestUtil.TestSuite()
2334
loader = TestUtil.TestLoader()
2335
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2336
from bzrlib.transport import TransportTestProviderAdapter
2337
adapter = TransportTestProviderAdapter()
2338
adapt_modules(test_transport_implementations, adapter, loader, suite)
2339
for package in packages_to_test():
2340
suite.addTest(package.test_suite())
2341
for m in MODULES_TO_TEST:
2342
suite.addTest(loader.loadTestsFromModule(m))
2343
for m in MODULES_TO_DOCTEST:
2345
suite.addTest(doctest.DocTestSuite(m))
2346
except ValueError, e:
2347
print '**failed to get doctest for: %s\n%s' %(m,e)
2349
for name, plugin in bzrlib.plugin.all_plugins().items():
2350
if getattr(plugin, 'test_suite', None) is not None:
2351
default_encoding = sys.getdefaultencoding()
2353
plugin_suite = plugin.test_suite()
2354
except ImportError, e:
2355
bzrlib.trace.warning(
2356
'Unable to test plugin "%s": %s', name, e)
2358
suite.addTest(plugin_suite)
2359
if default_encoding != sys.getdefaultencoding():
2360
bzrlib.trace.warning(
2361
'Plugin "%s" tried to reset default encoding to: %s', name,
2362
sys.getdefaultencoding())
2364
sys.setdefaultencoding(default_encoding)
2368
def adapt_modules(mods_list, adapter, loader, suite):
2369
"""Adapt the modules in mods_list using adapter and add to suite."""
2370
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2371
suite.addTests(adapter.adapt(test))
2374
def _rmtree_temp_dir(dirname):
2376
osutils.rmtree(dirname)
2378
if sys.platform == 'win32' and e.errno == errno.EACCES:
2379
print >>sys.stderr, ('Permission denied: '
2380
'unable to remove testing dir '
2381
'%s' % os.path.basename(dirname))
2386
def clean_selftest_output(root=None, quiet=False):
2387
"""Remove all selftest output directories from root directory.
2389
:param root: root directory for clean
2390
(if ommitted or None then clean current directory).
2391
:param quiet: suppress report about deleting directories
2394
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
2397
for i in os.listdir(root):
2398
if os.path.isdir(i) and re_dir.match(i):
2400
print 'delete directory:', i
2404
class Feature(object):
2405
"""An operating system Feature."""
2408
self._available = None
2410
def available(self):
2411
"""Is the feature available?
2413
:return: True if the feature is available.
2415
if self._available is None:
2416
self._available = self._probe()
2417
return self._available
2420
"""Implement this method in concrete features.
2422
:return: True if the feature is available.
2424
raise NotImplementedError
2427
if getattr(self, 'feature_name', None):
2428
return self.feature_name()
2429
return self.__class__.__name__
added
removed
bzrlib/tests/__init__.py
