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.encode(self.stdout.encoding, 'replace'))
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), pformat(b)))
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, func, *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.
903
Returns the exception so that you can examine it.
906
func(*args, **kwargs)
910
if getattr(excClass,'__name__', None) is not None:
911
excName = excClass.__name__
914
excName = str(excClass)
915
raise self.failureException, "%s not raised" % excName
917
def assertIs(self, left, right, message=None):
918
if not (left is right):
919
if message is not None:
920
raise AssertionError(message)
922
raise AssertionError("%r is not %r." % (left, right))
924
def assertIsNot(self, left, right, message=None):
926
if message is not None:
927
raise AssertionError(message)
929
raise AssertionError("%r is %r." % (left, right))
931
def assertTransportMode(self, transport, path, mode):
932
"""Fail if a path does not have mode mode.
934
If modes are not supported on this transport, the assertion is ignored.
936
if not transport._can_roundtrip_unix_modebits():
938
path_stat = transport.stat(path)
939
actual_mode = stat.S_IMODE(path_stat.st_mode)
940
self.assertEqual(mode, actual_mode,
941
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
943
def assertIsInstance(self, obj, kls):
944
"""Fail if obj is not an instance of kls"""
945
if not isinstance(obj, kls):
946
self.fail("%r is an instance of %s rather than %s" % (
947
obj, obj.__class__, kls))
949
def expectFailure(self, reason, assertion, *args, **kwargs):
950
"""Invoke a test, expecting it to fail for the given reason.
952
This is for assertions that ought to succeed, but currently fail.
953
(The failure is *expected* but not *wanted*.) Please be very precise
954
about the failure you're expecting. If a new bug is introduced,
955
AssertionError should be raised, not KnownFailure.
957
Frequently, expectFailure should be followed by an opposite assertion.
960
Intended to be used with a callable that raises AssertionError as the
961
'assertion' parameter. args and kwargs are passed to the 'assertion'.
963
Raises KnownFailure if the test fails. Raises AssertionError if the
968
self.expectFailure('Math is broken', self.assertNotEqual, 54,
970
self.assertEqual(42, dynamic_val)
972
This means that a dynamic_val of 54 will cause the test to raise
973
a KnownFailure. Once math is fixed and the expectFailure is removed,
974
only a dynamic_val of 42 will allow the test to pass. Anything other
975
than 54 or 42 will cause an AssertionError.
978
assertion(*args, **kwargs)
979
except AssertionError:
980
raise KnownFailure(reason)
982
self.fail('Unexpected success. Should have failed: %s' % reason)
984
def _capture_warnings(self, a_callable, *args, **kwargs):
985
"""A helper for callDeprecated and applyDeprecated.
987
:param a_callable: A callable to call.
988
:param args: The positional arguments for the callable
989
:param kwargs: The keyword arguments for the callable
990
:return: A tuple (warnings, result). result is the result of calling
991
a_callable(*args, **kwargs).
994
def capture_warnings(msg, cls=None, stacklevel=None):
995
# we've hooked into a deprecation specific callpath,
996
# only deprecations should getting sent via it.
997
self.assertEqual(cls, DeprecationWarning)
998
local_warnings.append(msg)
999
original_warning_method = symbol_versioning.warn
1000
symbol_versioning.set_warning_method(capture_warnings)
1002
result = a_callable(*args, **kwargs)
1004
symbol_versioning.set_warning_method(original_warning_method)
1005
return (local_warnings, result)
1007
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1008
"""Call a deprecated callable without warning the user.
1010
:param deprecation_format: The deprecation format that the callable
1011
should have been deprecated with. This is the same type as the
1012
parameter to deprecated_method/deprecated_function. If the
1013
callable is not deprecated with this format, an assertion error
1015
:param a_callable: A callable to call. This may be a bound method or
1016
a regular function. It will be called with *args and **kwargs.
1017
:param args: The positional arguments for the callable
1018
:param kwargs: The keyword arguments for the callable
1019
:return: The result of a_callable(*args, **kwargs)
1021
call_warnings, result = self._capture_warnings(a_callable,
1023
expected_first_warning = symbol_versioning.deprecation_string(
1024
a_callable, deprecation_format)
1025
if len(call_warnings) == 0:
1026
self.fail("No deprecation warning generated by call to %s" %
1028
self.assertEqual(expected_first_warning, call_warnings[0])
1031
def callDeprecated(self, expected, callable, *args, **kwargs):
1032
"""Assert that a callable is deprecated in a particular way.
1034
This is a very precise test for unusual requirements. The
1035
applyDeprecated helper function is probably more suited for most tests
1036
as it allows you to simply specify the deprecation format being used
1037
and will ensure that that is issued for the function being called.
1039
:param expected: a list of the deprecation warnings expected, in order
1040
:param callable: The callable to call
1041
:param args: The positional arguments for the callable
1042
:param kwargs: The keyword arguments for the callable
1044
call_warnings, result = self._capture_warnings(callable,
1046
self.assertEqual(expected, call_warnings)
1049
def _startLogFile(self):
1050
"""Send bzr and test log messages to a temporary file.
1052
The file is removed as the test is torn down.
1054
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1055
self._log_file = os.fdopen(fileno, 'w+')
1056
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1057
self._log_file_name = name
1058
self.addCleanup(self._finishLogFile)
1060
def _finishLogFile(self):
1061
"""Finished with the log file.
1063
Close the file and delete it, unless setKeepLogfile was called.
1065
if self._log_file is None:
1067
bzrlib.trace.disable_test_log(self._log_nonce)
1068
self._log_file.close()
1069
self._log_file = None
1070
if not self._keep_log_file:
1071
os.remove(self._log_file_name)
1072
self._log_file_name = None
1074
def setKeepLogfile(self):
1075
"""Make the logfile not be deleted when _finishLogFile is called."""
1076
self._keep_log_file = True
1078
def addCleanup(self, callable):
1079
"""Arrange to run a callable when this case is torn down.
1081
Callables are run in the reverse of the order they are registered,
1082
ie last-in first-out.
1084
if callable in self._cleanups:
1085
raise ValueError("cleanup function %r already registered on %s"
1087
self._cleanups.append(callable)
1089
def _cleanEnvironment(self):
1091
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1092
'HOME': os.getcwd(),
1093
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1095
'BZREMAIL': None, # may still be present in the environment
1097
'BZR_PROGRESS_BAR': None,
1101
'https_proxy': None,
1102
'HTTPS_PROXY': None,
1107
# Nobody cares about these ones AFAIK. So far at
1108
# least. If you do (care), please update this comment
1114
self.addCleanup(self._restoreEnvironment)
1115
for name, value in new_env.iteritems():
1116
self._captureVar(name, value)
1118
def _captureVar(self, name, newvalue):
1119
"""Set an environment variable, and reset it when finished."""
1120
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1122
def _restoreEnvironment(self):
1123
for name, value in self.__old_env.iteritems():
1124
osutils.set_or_unset_env(name, value)
1126
def _restoreHooks(self):
1127
for klass, hooks in self._preserved_hooks.items():
1128
setattr(klass, 'hooks', hooks)
1130
def knownFailure(self, reason):
1131
"""This test has failed for some known reason."""
1132
raise KnownFailure(reason)
1134
def run(self, result=None):
1135
if result is None: result = self.defaultTestResult()
1136
for feature in getattr(self, '_test_needs_features', []):
1137
if not feature.available():
1138
result.startTest(self)
1139
if getattr(result, 'addNotSupported', None):
1140
result.addNotSupported(self, feature)
1142
result.addSuccess(self)
1143
result.stopTest(self)
1145
return unittest.TestCase.run(self, result)
1149
unittest.TestCase.tearDown(self)
1151
def time(self, callable, *args, **kwargs):
1152
"""Run callable and accrue the time it takes to the benchmark time.
1154
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1155
this will cause lsprofile statistics to be gathered and stored in
1158
if self._benchtime is None:
1162
if not self._gather_lsprof_in_benchmarks:
1163
return callable(*args, **kwargs)
1165
# record this benchmark
1166
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1168
self._benchcalls.append(((callable, args, kwargs), stats))
1171
self._benchtime += time.time() - start
1173
def _runCleanups(self):
1174
"""Run registered cleanup functions.
1176
This should only be called from TestCase.tearDown.
1178
# TODO: Perhaps this should keep running cleanups even if
1179
# one of them fails?
1181
# Actually pop the cleanups from the list so tearDown running
1182
# twice is safe (this happens for skipped tests).
1183
while self._cleanups:
1184
self._cleanups.pop()()
1186
def log(self, *args):
1189
def _get_log(self, keep_log_file=False):
1190
"""Return as a string the log for this test. If the file is still
1191
on disk and keep_log_file=False, delete the log file and store the
1192
content in self._log_contents."""
1193
# flush the log file, to get all content
1195
bzrlib.trace._trace_file.flush()
1196
if self._log_contents:
1197
return self._log_contents
1198
if self._log_file_name is not None:
1199
logfile = open(self._log_file_name)
1201
log_contents = logfile.read()
1204
if not keep_log_file:
1205
self._log_contents = log_contents
1207
os.remove(self._log_file_name)
1209
if sys.platform == 'win32' and e.errno == errno.EACCES:
1210
print >>sys.stderr, ('Unable to delete log file '
1211
' %r' % self._log_file_name)
1216
return "DELETED log file to reduce memory footprint"
1218
def capture(self, cmd, retcode=0):
1219
"""Shortcut that splits cmd into words, runs, and returns stdout"""
1220
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
1222
def requireFeature(self, feature):
1223
"""This test requires a specific feature is available.
1225
:raises UnavailableFeature: When feature is not available.
1227
if not feature.available():
1228
raise UnavailableFeature(feature)
1230
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
1232
"""Invoke bzr and return (stdout, stderr).
1234
Useful for code that wants to check the contents of the
1235
output, the way error messages are presented, etc.
1237
This should be the main method for tests that want to exercise the
1238
overall behavior of the bzr application (rather than a unit test
1239
or a functional test of the library.)
1241
Much of the old code runs bzr by forking a new copy of Python, but
1242
that is slower, harder to debug, and generally not necessary.
1244
This runs bzr through the interface that catches and reports
1245
errors, and with logging set to something approximating the
1246
default, so that error reporting can be checked.
1248
:param argv: arguments to invoke bzr
1249
:param retcode: expected return code, or None for don't-care.
1250
:param encoding: encoding for sys.stdout and sys.stderr
1251
:param stdin: A string to be used as stdin for the command.
1252
:param working_dir: Change to this directory before running
1254
if encoding is None:
1255
encoding = bzrlib.user_encoding
1256
stdout = StringIOWrapper()
1257
stderr = StringIOWrapper()
1258
stdout.encoding = encoding
1259
stderr.encoding = encoding
1261
self.log('run bzr: %r', argv)
1262
# FIXME: don't call into logging here
1263
handler = logging.StreamHandler(stderr)
1264
handler.setLevel(logging.INFO)
1265
logger = logging.getLogger('')
1266
logger.addHandler(handler)
1267
old_ui_factory = ui.ui_factory
1268
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1271
if working_dir is not None:
1272
cwd = osutils.getcwd()
1273
os.chdir(working_dir)
1276
saved_debug_flags = frozenset(debug.debug_flags)
1277
debug.debug_flags.clear()
1279
result = self.apply_redirected(ui.ui_factory.stdin,
1281
bzrlib.commands.run_bzr_catch_errors,
1284
debug.debug_flags.update(saved_debug_flags)
1286
logger.removeHandler(handler)
1287
ui.ui_factory = old_ui_factory
1291
out = stdout.getvalue()
1292
err = stderr.getvalue()
1294
self.log('output:\n%r', out)
1296
self.log('errors:\n%r', err)
1297
if retcode is not None:
1298
self.assertEquals(retcode, result,
1299
message='Unexpected return code')
1302
def run_bzr(self, *args, **kwargs):
1303
"""Invoke bzr, as if it were run from the command line.
1305
This should be the main method for tests that want to exercise the
1306
overall behavior of the bzr application (rather than a unit test
1307
or a functional test of the library.)
1309
This sends the stdout/stderr results into the test's log,
1310
where it may be useful for debugging. See also run_captured.
1312
:param stdin: A string to be used as stdin for the command.
1313
:param retcode: The status code the command should return
1314
:param working_dir: The directory to run the command in
1316
retcode = kwargs.pop('retcode', 0)
1317
encoding = kwargs.pop('encoding', None)
1318
stdin = kwargs.pop('stdin', None)
1319
working_dir = kwargs.pop('working_dir', None)
1320
error_regexes = kwargs.pop('error_regexes', [])
1322
out, err = self.run_bzr_captured(args, retcode=retcode,
1323
encoding=encoding, stdin=stdin, working_dir=working_dir)
1325
for regex in error_regexes:
1326
self.assertContainsRe(err, regex)
1330
def run_bzr_decode(self, *args, **kwargs):
1331
if 'encoding' in kwargs:
1332
encoding = kwargs['encoding']
1334
encoding = bzrlib.user_encoding
1335
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1337
def run_bzr_error(self, error_regexes, *args, **kwargs):
1338
"""Run bzr, and check that stderr contains the supplied regexes
1340
:param error_regexes: Sequence of regular expressions which
1341
must each be found in the error output. The relative ordering
1343
:param args: command-line arguments for bzr
1344
:param kwargs: Keyword arguments which are interpreted by run_bzr
1345
This function changes the default value of retcode to be 3,
1346
since in most cases this is run when you expect bzr to fail.
1347
:return: (out, err) The actual output of running the command (in case you
1348
want to do more inspection)
1351
# Make sure that commit is failing because there is nothing to do
1352
self.run_bzr_error(['no changes to commit'],
1353
'commit', '-m', 'my commit comment')
1354
# Make sure --strict is handling an unknown file, rather than
1355
# giving us the 'nothing to do' error
1356
self.build_tree(['unknown'])
1357
self.run_bzr_error(['Commit refused because there are unknown files'],
1358
'commit', '--strict', '-m', 'my commit comment')
1360
kwargs.setdefault('retcode', 3)
1361
out, err = self.run_bzr(error_regexes=error_regexes, *args, **kwargs)
1364
def run_bzr_subprocess(self, *args, **kwargs):
1365
"""Run bzr in a subprocess for testing.
1367
This starts a new Python interpreter and runs bzr in there.
1368
This should only be used for tests that have a justifiable need for
1369
this isolation: e.g. they are testing startup time, or signal
1370
handling, or early startup code, etc. Subprocess code can't be
1371
profiled or debugged so easily.
1373
:param retcode: The status code that is expected. Defaults to 0. If
1374
None is supplied, the status code is not checked.
1375
:param env_changes: A dictionary which lists changes to environment
1376
variables. A value of None will unset the env variable.
1377
The values must be strings. The change will only occur in the
1378
child, so you don't need to fix the environment after running.
1379
:param universal_newlines: Convert CRLF => LF
1380
:param allow_plugins: By default the subprocess is run with
1381
--no-plugins to ensure test reproducibility. Also, it is possible
1382
for system-wide plugins to create unexpected output on stderr,
1383
which can cause unnecessary test failures.
1385
env_changes = kwargs.get('env_changes', {})
1386
working_dir = kwargs.get('working_dir', None)
1387
allow_plugins = kwargs.get('allow_plugins', False)
1388
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1389
working_dir=working_dir,
1390
allow_plugins=allow_plugins)
1391
# We distinguish between retcode=None and retcode not passed.
1392
supplied_retcode = kwargs.get('retcode', 0)
1393
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1394
universal_newlines=kwargs.get('universal_newlines', False),
1397
def start_bzr_subprocess(self, process_args, env_changes=None,
1398
skip_if_plan_to_signal=False,
1400
allow_plugins=False):
1401
"""Start bzr in a subprocess for testing.
1403
This starts a new Python interpreter and runs bzr in there.
1404
This should only be used for tests that have a justifiable need for
1405
this isolation: e.g. they are testing startup time, or signal
1406
handling, or early startup code, etc. Subprocess code can't be
1407
profiled or debugged so easily.
1409
:param process_args: a list of arguments to pass to the bzr executable,
1410
for example `['--version']`.
1411
:param env_changes: A dictionary which lists changes to environment
1412
variables. A value of None will unset the env variable.
1413
The values must be strings. The change will only occur in the
1414
child, so you don't need to fix the environment after running.
1415
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1417
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1419
:returns: Popen object for the started process.
1421
if skip_if_plan_to_signal:
1422
if not getattr(os, 'kill', None):
1423
raise TestSkipped("os.kill not available.")
1425
if env_changes is None:
1429
def cleanup_environment():
1430
for env_var, value in env_changes.iteritems():
1431
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1433
def restore_environment():
1434
for env_var, value in old_env.iteritems():
1435
osutils.set_or_unset_env(env_var, value)
1437
bzr_path = self.get_bzr_path()
1440
if working_dir is not None:
1441
cwd = osutils.getcwd()
1442
os.chdir(working_dir)
1445
# win32 subprocess doesn't support preexec_fn
1446
# so we will avoid using it on all platforms, just to
1447
# make sure the code path is used, and we don't break on win32
1448
cleanup_environment()
1449
command = [sys.executable, bzr_path]
1450
if not allow_plugins:
1451
command.append('--no-plugins')
1452
command.extend(process_args)
1453
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1455
restore_environment()
1461
def _popen(self, *args, **kwargs):
1462
"""Place a call to Popen.
1464
Allows tests to override this method to intercept the calls made to
1465
Popen for introspection.
1467
return Popen(*args, **kwargs)
1469
def get_bzr_path(self):
1470
"""Return the path of the 'bzr' executable for this test suite."""
1471
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1472
if not os.path.isfile(bzr_path):
1473
# We are probably installed. Assume sys.argv is the right file
1474
bzr_path = sys.argv[0]
1477
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1478
universal_newlines=False, process_args=None):
1479
"""Finish the execution of process.
1481
:param process: the Popen object returned from start_bzr_subprocess.
1482
:param retcode: The status code that is expected. Defaults to 0. If
1483
None is supplied, the status code is not checked.
1484
:param send_signal: an optional signal to send to the process.
1485
:param universal_newlines: Convert CRLF => LF
1486
:returns: (stdout, stderr)
1488
if send_signal is not None:
1489
os.kill(process.pid, send_signal)
1490
out, err = process.communicate()
1492
if universal_newlines:
1493
out = out.replace('\r\n', '\n')
1494
err = err.replace('\r\n', '\n')
1496
if retcode is not None and retcode != process.returncode:
1497
if process_args is None:
1498
process_args = "(unknown args)"
1499
mutter('Output of bzr %s:\n%s', process_args, out)
1500
mutter('Error for bzr %s:\n%s', process_args, err)
1501
self.fail('Command bzr %s failed with retcode %s != %s'
1502
% (process_args, retcode, process.returncode))
1505
def check_inventory_shape(self, inv, shape):
1506
"""Compare an inventory to a list of expected names.
1508
Fail if they are not precisely equal.
1511
shape = list(shape) # copy
1512
for path, ie in inv.entries():
1513
name = path.replace('\\', '/')
1514
if ie.kind == 'dir':
1521
self.fail("expected paths not found in inventory: %r" % shape)
1523
self.fail("unexpected paths found in inventory: %r" % extras)
1525
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1526
a_callable=None, *args, **kwargs):
1527
"""Call callable with redirected std io pipes.
1529
Returns the return code."""
1530
if not callable(a_callable):
1531
raise ValueError("a_callable must be callable.")
1533
stdin = StringIO("")
1535
if getattr(self, "_log_file", None) is not None:
1536
stdout = self._log_file
1540
if getattr(self, "_log_file", None is not None):
1541
stderr = self._log_file
1544
real_stdin = sys.stdin
1545
real_stdout = sys.stdout
1546
real_stderr = sys.stderr
1551
return a_callable(*args, **kwargs)
1553
sys.stdout = real_stdout
1554
sys.stderr = real_stderr
1555
sys.stdin = real_stdin
1557
@symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
1558
def merge(self, branch_from, wt_to):
1559
"""A helper for tests to do a ui-less merge.
1561
This should move to the main library when someone has time to integrate
1564
# minimal ui-less merge.
1565
wt_to.branch.fetch(branch_from)
1566
base_rev = common_ancestor(branch_from.last_revision(),
1567
wt_to.branch.last_revision(),
1568
wt_to.branch.repository)
1569
merge_inner(wt_to.branch, branch_from.basis_tree(),
1570
wt_to.branch.repository.revision_tree(base_rev),
1572
wt_to.add_parent_tree_id(branch_from.last_revision())
1574
def reduceLockdirTimeout(self):
1575
"""Reduce the default lock timeout for the duration of the test, so that
1576
if LockContention occurs during a test, it does so quickly.
1578
Tests that expect to provoke LockContention errors should call this.
1580
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1582
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1583
self.addCleanup(resetTimeout)
1584
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1586
BzrTestBase = TestCase
1589
class TestCaseWithMemoryTransport(TestCase):
1590
"""Common test class for tests that do not need disk resources.
1592
Tests that need disk resources should derive from TestCaseWithTransport.
1594
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1596
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1597
a directory which does not exist. This serves to help ensure test isolation
1598
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1599
must exist. However, TestCaseWithMemoryTransport does not offer local
1600
file defaults for the transport in tests, nor does it obey the command line
1601
override, so tests that accidentally write to the common directory should
1609
def __init__(self, methodName='runTest'):
1610
# allow test parameterisation after test construction and before test
1611
# execution. Variables that the parameteriser sets need to be
1612
# ones that are not set by setUp, or setUp will trash them.
1613
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1614
self.vfs_transport_factory = default_transport
1615
self.transport_server = None
1616
self.transport_readonly_server = None
1617
self.__vfs_server = None
1619
def get_transport(self):
1620
"""Return a writeable transport for the test scratch space"""
1621
t = get_transport(self.get_url())
1622
self.assertFalse(t.is_readonly())
1625
def get_readonly_transport(self):
1626
"""Return a readonly transport for the test scratch space
1628
This can be used to test that operations which should only need
1629
readonly access in fact do not try to write.
1631
t = get_transport(self.get_readonly_url())
1632
self.assertTrue(t.is_readonly())
1635
def create_transport_readonly_server(self):
1636
"""Create a transport server from class defined at init.
1638
This is mostly a hook for daughter classes.
1640
return self.transport_readonly_server()
1642
def get_readonly_server(self):
1643
"""Get the server instance for the readonly transport
1645
This is useful for some tests with specific servers to do diagnostics.
1647
if self.__readonly_server is None:
1648
if self.transport_readonly_server is None:
1649
# readonly decorator requested
1650
# bring up the server
1651
self.__readonly_server = ReadonlyServer()
1652
self.__readonly_server.setUp(self.get_vfs_only_server())
1654
self.__readonly_server = self.create_transport_readonly_server()
1655
self.__readonly_server.setUp(self.get_vfs_only_server())
1656
self.addCleanup(self.__readonly_server.tearDown)
1657
return self.__readonly_server
1659
def get_readonly_url(self, relpath=None):
1660
"""Get a URL for the readonly transport.
1662
This will either be backed by '.' or a decorator to the transport
1663
used by self.get_url()
1664
relpath provides for clients to get a path relative to the base url.
1665
These should only be downwards relative, not upwards.
1667
base = self.get_readonly_server().get_url()
1668
if relpath is not None:
1669
if not base.endswith('/'):
1671
base = base + relpath
1674
def get_vfs_only_server(self):
1675
"""Get the vfs only read/write server instance.
1677
This is useful for some tests with specific servers that need
1680
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1681
is no means to override it.
1683
if self.__vfs_server is None:
1684
self.__vfs_server = MemoryServer()
1685
self.__vfs_server.setUp()
1686
self.addCleanup(self.__vfs_server.tearDown)
1687
return self.__vfs_server
1689
def get_server(self):
1690
"""Get the read/write server instance.
1692
This is useful for some tests with specific servers that need
1695
This is built from the self.transport_server factory. If that is None,
1696
then the self.get_vfs_server is returned.
1698
if self.__server is None:
1699
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1700
return self.get_vfs_only_server()
1702
# bring up a decorated means of access to the vfs only server.
1703
self.__server = self.transport_server()
1705
self.__server.setUp(self.get_vfs_only_server())
1706
except TypeError, e:
1707
# This should never happen; the try:Except here is to assist
1708
# developers having to update code rather than seeing an
1709
# uninformative TypeError.
1710
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1711
self.addCleanup(self.__server.tearDown)
1712
return self.__server
1714
def _adjust_url(self, base, relpath):
1715
"""Get a URL (or maybe a path) for the readwrite transport.
1717
This will either be backed by '.' or to an equivalent non-file based
1719
relpath provides for clients to get a path relative to the base url.
1720
These should only be downwards relative, not upwards.
1722
if relpath is not None and relpath != '.':
1723
if not base.endswith('/'):
1725
# XXX: Really base should be a url; we did after all call
1726
# get_url()! But sometimes it's just a path (from
1727
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1728
# to a non-escaped local path.
1729
if base.startswith('./') or base.startswith('/'):
1732
base += urlutils.escape(relpath)
1735
def get_url(self, relpath=None):
1736
"""Get a URL (or maybe a path) for the readwrite transport.
1738
This will either be backed by '.' or to an equivalent non-file based
1740
relpath provides for clients to get a path relative to the base url.
1741
These should only be downwards relative, not upwards.
1743
base = self.get_server().get_url()
1744
return self._adjust_url(base, relpath)
1746
def get_vfs_only_url(self, relpath=None):
1747
"""Get a URL (or maybe a path for the plain old vfs transport.
1749
This will never be a smart protocol. It always has all the
1750
capabilities of the local filesystem, but it might actually be a
1751
MemoryTransport or some other similar virtual filesystem.
1753
This is the backing transport (if any) of the server returned by
1754
get_url and get_readonly_url.
1756
:param relpath: provides for clients to get a path relative to the base
1757
url. These should only be downwards relative, not upwards.
1759
base = self.get_vfs_only_server().get_url()
1760
return self._adjust_url(base, relpath)
1762
def _make_test_root(self):
1763
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1767
root = u'test%04d.tmp' % i
1771
if e.errno == errno.EEXIST:
1776
# successfully created
1777
TestCaseWithMemoryTransport.TEST_ROOT = osutils.abspath(root)
1779
# make a fake bzr directory there to prevent any tests propagating
1780
# up onto the source directory's real branch
1781
bzrdir.BzrDir.create_standalone_workingtree(
1782
TestCaseWithMemoryTransport.TEST_ROOT)
1784
def makeAndChdirToTestDir(self):
1785
"""Create a temporary directories for this one test.
1787
This must set self.test_home_dir and self.test_dir and chdir to
1790
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1792
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1793
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1794
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1796
def make_branch(self, relpath, format=None):
1797
"""Create a branch on the transport at relpath."""
1798
repo = self.make_repository(relpath, format=format)
1799
return repo.bzrdir.create_branch()
1801
def make_bzrdir(self, relpath, format=None):
1803
# might be a relative or absolute path
1804
maybe_a_url = self.get_url(relpath)
1805
segments = maybe_a_url.rsplit('/', 1)
1806
t = get_transport(maybe_a_url)
1807
if len(segments) > 1 and segments[-1] not in ('', '.'):
1811
if isinstance(format, basestring):
1812
format = bzrdir.format_registry.make_bzrdir(format)
1813
return format.initialize_on_transport(t)
1814
except errors.UninitializableFormat:
1815
raise TestSkipped("Format %s is not initializable." % format)
1817
def make_repository(self, relpath, shared=False, format=None):
1818
"""Create a repository on our default transport at relpath.
1820
Note that relpath must be a relative path, not a full url.
1822
# FIXME: If you create a remoterepository this returns the underlying
1823
# real format, which is incorrect. Actually we should make sure that
1824
# RemoteBzrDir returns a RemoteRepository.
1825
# maybe mbp 20070410
1826
made_control = self.make_bzrdir(relpath, format=format)
1827
return made_control.create_repository(shared=shared)
1829
def make_branch_and_memory_tree(self, relpath, format=None):
1830
"""Create a branch on the default transport and a MemoryTree for it."""
1831
b = self.make_branch(relpath, format=format)
1832
return memorytree.MemoryTree.create_on_branch(b)
1834
def overrideEnvironmentForTesting(self):
1835
os.environ['HOME'] = self.test_home_dir
1836
os.environ['BZR_HOME'] = self.test_home_dir
1839
super(TestCaseWithMemoryTransport, self).setUp()
1840
self._make_test_root()
1841
_currentdir = os.getcwdu()
1842
def _leaveDirectory():
1843
os.chdir(_currentdir)
1844
self.addCleanup(_leaveDirectory)
1845
self.makeAndChdirToTestDir()
1846
self.overrideEnvironmentForTesting()
1847
self.__readonly_server = None
1848
self.__server = None
1849
self.reduceLockdirTimeout()
1852
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1853
"""Derived class that runs a test within a temporary directory.
1855
This is useful for tests that need to create a branch, etc.
1857
The directory is created in a slightly complex way: for each
1858
Python invocation, a new temporary top-level directory is created.
1859
All test cases create their own directory within that. If the
1860
tests complete successfully, the directory is removed.
1862
InTempDir is an old alias for FunctionalTestCase.
1865
OVERRIDE_PYTHON = 'python'
1866
use_numbered_dirs = False
1868
def check_file_contents(self, filename, expect):
1869
self.log("check contents of file %s" % filename)
1870
contents = file(filename, 'r').read()
1871
if contents != expect:
1872
self.log("expected: %r" % expect)
1873
self.log("actually: %r" % contents)
1874
self.fail("contents of %s not as expected" % filename)
1876
def makeAndChdirToTestDir(self):
1877
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1879
For TestCaseInTempDir we create a temporary directory based on the test
1880
name and then create two subdirs - test and home under it.
1882
if self.use_numbered_dirs: # strongly recommended on Windows
1883
# due the path length limitation (260 ch.)
1884
candidate_dir = '%s/%dK/%05d' % (self.TEST_ROOT,
1885
int(self.number/1000),
1887
os.makedirs(candidate_dir)
1888
self.test_home_dir = candidate_dir + '/home'
1889
os.mkdir(self.test_home_dir)
1890
self.test_dir = candidate_dir + '/work'
1891
os.mkdir(self.test_dir)
1892
os.chdir(self.test_dir)
1893
# put name of test inside
1894
f = file(candidate_dir + '/name', 'w')
1899
# shorten the name, to avoid test failures due to path length
1900
short_id = self.id().replace('bzrlib.tests.', '') \
1901
.replace('__main__.', '')[-100:]
1902
# it's possible the same test class is run several times for
1903
# parameterized tests, so make sure the names don't collide.
1907
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1909
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1910
if os.path.exists(candidate_dir):
1914
os.mkdir(candidate_dir)
1915
self.test_home_dir = candidate_dir + '/home'
1916
os.mkdir(self.test_home_dir)
1917
self.test_dir = candidate_dir + '/work'
1918
os.mkdir(self.test_dir)
1919
os.chdir(self.test_dir)
1922
def build_tree(self, shape, line_endings='binary', transport=None):
1923
"""Build a test tree according to a pattern.
1925
shape is a sequence of file specifications. If the final
1926
character is '/', a directory is created.
1928
This assumes that all the elements in the tree being built are new.
1930
This doesn't add anything to a branch.
1931
:param line_endings: Either 'binary' or 'native'
1932
in binary mode, exact contents are written
1933
in native mode, the line endings match the
1934
default platform endings.
1936
:param transport: A transport to write to, for building trees on
1937
VFS's. If the transport is readonly or None,
1938
"." is opened automatically.
1940
# It's OK to just create them using forward slashes on windows.
1941
if transport is None or transport.is_readonly():
1942
transport = get_transport(".")
1944
self.assert_(isinstance(name, basestring))
1946
transport.mkdir(urlutils.escape(name[:-1]))
1948
if line_endings == 'binary':
1950
elif line_endings == 'native':
1953
raise errors.BzrError(
1954
'Invalid line ending request %r' % line_endings)
1955
content = "contents of %s%s" % (name.encode('utf-8'), end)
1956
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1958
def build_tree_contents(self, shape):
1959
build_tree_contents(shape)
1961
def assertFileEqual(self, content, path):
1962
"""Fail if path does not contain 'content'."""
1963
self.failUnlessExists(path)
1964
f = file(path, 'rb')
1969
self.assertEqualDiff(content, s)
1971
def failUnlessExists(self, path):
1972
"""Fail unless path or paths, which may be abs or relative, exist."""
1973
if not isinstance(path, basestring):
1975
self.failUnlessExists(p)
1977
self.failUnless(osutils.lexists(path),path+" does not exist")
1979
def failIfExists(self, path):
1980
"""Fail if path or paths, which may be abs or relative, exist."""
1981
if not isinstance(path, basestring):
1983
self.failIfExists(p)
1985
self.failIf(osutils.lexists(path),path+" exists")
1987
def assertInWorkingTree(self,path,root_path='.',tree=None):
1988
"""Assert whether path or paths are in the WorkingTree"""
1990
tree = workingtree.WorkingTree.open(root_path)
1991
if not isinstance(path, basestring):
1993
self.assertInWorkingTree(p,tree=tree)
1995
self.assertIsNot(tree.path2id(path), None,
1996
path+' not in working tree.')
1998
def assertNotInWorkingTree(self,path,root_path='.',tree=None):
1999
"""Assert whether path or paths are not in the WorkingTree"""
2001
tree = workingtree.WorkingTree.open(root_path)
2002
if not isinstance(path, basestring):
2004
self.assertNotInWorkingTree(p,tree=tree)
2006
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2009
class TestCaseWithTransport(TestCaseInTempDir):
2010
"""A test case that provides get_url and get_readonly_url facilities.
2012
These back onto two transport servers, one for readonly access and one for
2015
If no explicit class is provided for readonly access, a
2016
ReadonlyTransportDecorator is used instead which allows the use of non disk
2017
based read write transports.
2019
If an explicit class is provided for readonly access, that server and the
2020
readwrite one must both define get_url() as resolving to os.getcwd().
2023
def get_vfs_only_server(self):
2024
"""See TestCaseWithMemoryTransport.
2026
This is useful for some tests with specific servers that need
2029
if self.__vfs_server is None:
2030
self.__vfs_server = self.vfs_transport_factory()
2031
self.__vfs_server.setUp()
2032
self.addCleanup(self.__vfs_server.tearDown)
2033
return self.__vfs_server
2035
def make_branch_and_tree(self, relpath, format=None):
2036
"""Create a branch on the transport and a tree locally.
2038
If the transport is not a LocalTransport, the Tree can't be created on
2039
the transport. In that case if the vfs_transport_factory is
2040
LocalURLServer the working tree is created in the local
2041
directory backing the transport, and the returned tree's branch and
2042
repository will also be accessed locally. Otherwise a lightweight
2043
checkout is created and returned.
2045
:param format: The BzrDirFormat.
2046
:returns: the WorkingTree.
2048
# TODO: always use the local disk path for the working tree,
2049
# this obviously requires a format that supports branch references
2050
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2052
b = self.make_branch(relpath, format=format)
2054
return b.bzrdir.create_workingtree()
2055
except errors.NotLocalUrl:
2056
# We can only make working trees locally at the moment. If the
2057
# transport can't support them, then we keep the non-disk-backed
2058
# branch and create a local checkout.
2059
if self.vfs_transport_factory is LocalURLServer:
2060
# the branch is colocated on disk, we cannot create a checkout.
2061
# hopefully callers will expect this.
2062
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2063
return local_controldir.create_workingtree()
2065
return b.create_checkout(relpath, lightweight=True)
2067
def assertIsDirectory(self, relpath, transport):
2068
"""Assert that relpath within transport is a directory.
2070
This may not be possible on all transports; in that case it propagates
2071
a TransportNotPossible.
2074
mode = transport.stat(relpath).st_mode
2075
except errors.NoSuchFile:
2076
self.fail("path %s is not a directory; no such file"
2078
if not stat.S_ISDIR(mode):
2079
self.fail("path %s is not a directory; has mode %#o"
2082
def assertTreesEqual(self, left, right):
2083
"""Check that left and right have the same content and properties."""
2084
# we use a tree delta to check for equality of the content, and we
2085
# manually check for equality of other things such as the parents list.
2086
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2087
differences = left.changes_from(right)
2088
self.assertFalse(differences.has_changed(),
2089
"Trees %r and %r are different: %r" % (left, right, differences))
2092
super(TestCaseWithTransport, self).setUp()
2093
self.__vfs_server = None
2096
class ChrootedTestCase(TestCaseWithTransport):
2097
"""A support class that provides readonly urls outside the local namespace.
2099
This is done by checking if self.transport_server is a MemoryServer. if it
2100
is then we are chrooted already, if it is not then an HttpServer is used
2103
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2104
be used without needed to redo it when a different
2105
subclass is in use ?
2109
super(ChrootedTestCase, self).setUp()
2110
if not self.vfs_transport_factory == MemoryServer:
2111
self.transport_readonly_server = HttpServer
2114
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2115
random_order=False):
2116
"""Create a test suite by filtering another one.
2118
:param suite: the source suite
2119
:param pattern: pattern that names must match
2120
:param exclude_pattern: pattern that names must not match, if any
2121
:param random_order: if True, tests in the new suite will be put in
2123
:returns: the newly created suite
2125
return sort_suite_by_re(suite, pattern, exclude_pattern,
2126
random_order, False)
2129
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2130
random_order=False, append_rest=True):
2131
"""Create a test suite by sorting another one.
2133
:param suite: the source suite
2134
:param pattern: pattern that names must match in order to go
2135
first in the new suite
2136
:param exclude_pattern: pattern that names must not match, if any
2137
:param random_order: if True, tests in the new suite will be put in
2139
:param append_rest: if False, pattern is a strict filter and not
2140
just an ordering directive
2141
:returns: the newly created suite
2145
filter_re = re.compile(pattern)
2146
if exclude_pattern is not None:
2147
exclude_re = re.compile(exclude_pattern)
2148
for test in iter_suite_tests(suite):
2150
if exclude_pattern is None or not exclude_re.search(test_id):
2151
if filter_re.search(test_id):
2156
random.shuffle(first)
2157
random.shuffle(second)
2158
return TestUtil.TestSuite(first + second)
2161
def run_suite(suite, name='test', verbose=False, pattern=".*",
2162
stop_on_failure=False, keep_output=False,
2163
transport=None, lsprof_timed=None, bench_history=None,
2164
matching_tests_first=None,
2168
exclude_pattern=None,
2170
use_numbered_dirs = bool(numbered_dirs)
2172
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2173
if numbered_dirs is not None:
2174
TestCaseInTempDir.use_numbered_dirs = use_numbered_dirs
2179
runner = TextTestRunner(stream=sys.stdout,
2181
verbosity=verbosity,
2182
keep_output=keep_output,
2183
bench_history=bench_history,
2184
use_numbered_dirs=use_numbered_dirs,
2185
list_only=list_only,
2187
runner.stop_on_failure=stop_on_failure
2188
# Initialise the random number generator and display the seed used.
2189
# We convert the seed to a long to make it reuseable across invocations.
2190
random_order = False
2191
if random_seed is not None:
2193
if random_seed == "now":
2194
random_seed = long(time.time())
2196
# Convert the seed to a long if we can
2198
random_seed = long(random_seed)
2201
runner.stream.writeln("Randomizing test order using seed %s\n" %
2203
random.seed(random_seed)
2204
# Customise the list of tests if requested
2205
if pattern != '.*' or exclude_pattern is not None or random_order:
2206
if matching_tests_first:
2207
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
2210
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
2212
result = runner.run(suite)
2213
return result.wasSuccessful()
2216
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2219
test_suite_factory=None,
2222
matching_tests_first=None,
2226
exclude_pattern=None):
2227
"""Run the whole test suite under the enhanced runner"""
2228
# XXX: Very ugly way to do this...
2229
# Disable warning about old formats because we don't want it to disturb
2230
# any blackbox tests.
2231
from bzrlib import repository
2232
repository._deprecation_warning_done = True
2234
global default_transport
2235
if transport is None:
2236
transport = default_transport
2237
old_transport = default_transport
2238
default_transport = transport
2240
if test_suite_factory is None:
2241
suite = test_suite()
2243
suite = test_suite_factory()
2244
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2245
stop_on_failure=stop_on_failure, keep_output=keep_output,
2246
transport=transport,
2247
lsprof_timed=lsprof_timed,
2248
bench_history=bench_history,
2249
matching_tests_first=matching_tests_first,
2250
numbered_dirs=numbered_dirs,
2251
list_only=list_only,
2252
random_seed=random_seed,
2253
exclude_pattern=exclude_pattern)
2255
default_transport = old_transport
2259
"""Build and return TestSuite for the whole of bzrlib.
2261
This function can be replaced if you need to change the default test
2262
suite on a global basis, but it is not encouraged.
2265
'bzrlib.tests.test_ancestry',
2266
'bzrlib.tests.test_annotate',
2267
'bzrlib.tests.test_api',
2268
'bzrlib.tests.test_atomicfile',
2269
'bzrlib.tests.test_bad_files',
2270
'bzrlib.tests.test_branch',
2271
'bzrlib.tests.test_bugtracker',
2272
'bzrlib.tests.test_bundle',
2273
'bzrlib.tests.test_bzrdir',
2274
'bzrlib.tests.test_cache_utf8',
2275
'bzrlib.tests.test_commands',
2276
'bzrlib.tests.test_commit',
2277
'bzrlib.tests.test_commit_merge',
2278
'bzrlib.tests.test_config',
2279
'bzrlib.tests.test_conflicts',
2280
'bzrlib.tests.test_counted_lock',
2281
'bzrlib.tests.test_decorators',
2282
'bzrlib.tests.test_delta',
2283
'bzrlib.tests.test_diff',
2284
'bzrlib.tests.test_dirstate',
2285
'bzrlib.tests.test_errors',
2286
'bzrlib.tests.test_escaped_store',
2287
'bzrlib.tests.test_extract',
2288
'bzrlib.tests.test_fetch',
2289
'bzrlib.tests.test_ftp_transport',
2290
'bzrlib.tests.test_generate_docs',
2291
'bzrlib.tests.test_generate_ids',
2292
'bzrlib.tests.test_globbing',
2293
'bzrlib.tests.test_gpg',
2294
'bzrlib.tests.test_graph',
2295
'bzrlib.tests.test_hashcache',
2296
'bzrlib.tests.test_help',
2297
'bzrlib.tests.test_http',
2298
'bzrlib.tests.test_http_response',
2299
'bzrlib.tests.test_https_ca_bundle',
2300
'bzrlib.tests.test_identitymap',
2301
'bzrlib.tests.test_ignores',
2302
'bzrlib.tests.test_inv',
2303
'bzrlib.tests.test_knit',
2304
'bzrlib.tests.test_lazy_import',
2305
'bzrlib.tests.test_lazy_regex',
2306
'bzrlib.tests.test_lockdir',
2307
'bzrlib.tests.test_lockable_files',
2308
'bzrlib.tests.test_log',
2309
'bzrlib.tests.test_lsprof',
2310
'bzrlib.tests.test_memorytree',
2311
'bzrlib.tests.test_merge',
2312
'bzrlib.tests.test_merge3',
2313
'bzrlib.tests.test_merge_core',
2314
'bzrlib.tests.test_merge_directive',
2315
'bzrlib.tests.test_missing',
2316
'bzrlib.tests.test_msgeditor',
2317
'bzrlib.tests.test_nonascii',
2318
'bzrlib.tests.test_options',
2319
'bzrlib.tests.test_osutils',
2320
'bzrlib.tests.test_osutils_encodings',
2321
'bzrlib.tests.test_patch',
2322
'bzrlib.tests.test_patches',
2323
'bzrlib.tests.test_permissions',
2324
'bzrlib.tests.test_plugins',
2325
'bzrlib.tests.test_progress',
2326
'bzrlib.tests.test_reconcile',
2327
'bzrlib.tests.test_registry',
2328
'bzrlib.tests.test_remote',
2329
'bzrlib.tests.test_repository',
2330
'bzrlib.tests.test_revert',
2331
'bzrlib.tests.test_revision',
2332
'bzrlib.tests.test_revisionnamespaces',
2333
'bzrlib.tests.test_revisiontree',
2334
'bzrlib.tests.test_rio',
2335
'bzrlib.tests.test_sampler',
2336
'bzrlib.tests.test_selftest',
2337
'bzrlib.tests.test_setup',
2338
'bzrlib.tests.test_sftp_transport',
2339
'bzrlib.tests.test_smart',
2340
'bzrlib.tests.test_smart_add',
2341
'bzrlib.tests.test_smart_transport',
2342
'bzrlib.tests.test_source',
2343
'bzrlib.tests.test_ssh_transport',
2344
'bzrlib.tests.test_status',
2345
'bzrlib.tests.test_store',
2346
'bzrlib.tests.test_strace',
2347
'bzrlib.tests.test_subsume',
2348
'bzrlib.tests.test_symbol_versioning',
2349
'bzrlib.tests.test_tag',
2350
'bzrlib.tests.test_testament',
2351
'bzrlib.tests.test_textfile',
2352
'bzrlib.tests.test_textmerge',
2353
'bzrlib.tests.test_timestamp',
2354
'bzrlib.tests.test_trace',
2355
'bzrlib.tests.test_transactions',
2356
'bzrlib.tests.test_transform',
2357
'bzrlib.tests.test_transport',
2358
'bzrlib.tests.test_tree',
2359
'bzrlib.tests.test_treebuilder',
2360
'bzrlib.tests.test_tsort',
2361
'bzrlib.tests.test_tuned_gzip',
2362
'bzrlib.tests.test_ui',
2363
'bzrlib.tests.test_upgrade',
2364
'bzrlib.tests.test_urlutils',
2365
'bzrlib.tests.test_versionedfile',
2366
'bzrlib.tests.test_version',
2367
'bzrlib.tests.test_version_info',
2368
'bzrlib.tests.test_weave',
2369
'bzrlib.tests.test_whitebox',
2370
'bzrlib.tests.test_workingtree',
2371
'bzrlib.tests.test_workingtree_4',
2372
'bzrlib.tests.test_wsgi',
2373
'bzrlib.tests.test_xml',
2375
test_transport_implementations = [
2376
'bzrlib.tests.test_transport_implementations',
2377
'bzrlib.tests.test_read_bundle',
2379
suite = TestUtil.TestSuite()
2380
loader = TestUtil.TestLoader()
2381
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2382
from bzrlib.transport import TransportTestProviderAdapter
2383
adapter = TransportTestProviderAdapter()
2384
adapt_modules(test_transport_implementations, adapter, loader, suite)
2385
for package in packages_to_test():
2386
suite.addTest(package.test_suite())
2387
for m in MODULES_TO_TEST:
2388
suite.addTest(loader.loadTestsFromModule(m))
2389
for m in MODULES_TO_DOCTEST:
2391
suite.addTest(doctest.DocTestSuite(m))
2392
except ValueError, e:
2393
print '**failed to get doctest for: %s\n%s' %(m,e)
2395
for name, plugin in bzrlib.plugin.all_plugins().items():
2396
if getattr(plugin, 'test_suite', None) is not None:
2397
default_encoding = sys.getdefaultencoding()
2399
plugin_suite = plugin.test_suite()
2400
except ImportError, e:
2401
bzrlib.trace.warning(
2402
'Unable to test plugin "%s": %s', name, e)
2404
suite.addTest(plugin_suite)
2405
if default_encoding != sys.getdefaultencoding():
2406
bzrlib.trace.warning(
2407
'Plugin "%s" tried to reset default encoding to: %s', name,
2408
sys.getdefaultencoding())
2410
sys.setdefaultencoding(default_encoding)
2414
def adapt_modules(mods_list, adapter, loader, suite):
2415
"""Adapt the modules in mods_list using adapter and add to suite."""
2416
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2417
suite.addTests(adapter.adapt(test))
2420
def _rmtree_temp_dir(dirname):
2422
osutils.rmtree(dirname)
2424
if sys.platform == 'win32' and e.errno == errno.EACCES:
2425
print >>sys.stderr, ('Permission denied: '
2426
'unable to remove testing dir '
2427
'%s' % os.path.basename(dirname))
2432
def clean_selftest_output(root=None, quiet=False):
2433
"""Remove all selftest output directories from root directory.
2435
:param root: root directory for clean
2436
(if ommitted or None then clean current directory).
2437
:param quiet: suppress report about deleting directories
2440
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
2443
for i in os.listdir(root):
2444
if os.path.isdir(i) and re_dir.match(i):
2446
print 'delete directory:', i
2450
class Feature(object):
2451
"""An operating system Feature."""
2454
self._available = None
2456
def available(self):
2457
"""Is the feature available?
2459
:return: True if the feature is available.
2461
if self._available is None:
2462
self._available = self._probe()
2463
return self._available
2466
"""Implement this method in concrete features.
2468
:return: True if the feature is available.
2470
raise NotImplementedError
2473
if getattr(self, 'feature_name', None):
2474
return self.feature_name()
2475
return self.__class__.__name__
added
removed
bzrlib/tests/__init__.py
