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.
31
from cStringIO import StringIO
37
from pprint import pformat
42
from subprocess import Popen, PIPE
62
import bzrlib.commands
63
import bzrlib.timestamp
65
import bzrlib.inventory
66
import bzrlib.iterablefile
71
# lsprof not available
73
from bzrlib.merge import merge_inner
77
from bzrlib.revision import common_ancestor
79
from bzrlib import symbol_versioning
80
from bzrlib.symbol_versioning import (
85
from bzrlib.transport import get_transport
86
import bzrlib.transport
87
from bzrlib.transport.local import LocalURLServer
88
from bzrlib.transport.memory import MemoryServer
89
from bzrlib.transport.readonly import ReadonlyServer
90
from bzrlib.trace import mutter, note
91
from bzrlib.tests import TestUtil
92
from bzrlib.tests.HttpServer import HttpServer
93
from bzrlib.tests.TestUtil import (
97
from bzrlib.tests.treeshape import build_tree_contents
98
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
100
# Mark this python module as being part of the implementation
101
# of unittest: this gives us better tracebacks where the last
102
# shown frame is the test code, not our assertXYZ.
105
default_transport = LocalURLServer
108
MODULES_TO_DOCTEST = [
121
def packages_to_test():
122
"""Return a list of packages to test.
124
The packages are not globally imported so that import failures are
125
triggered when running selftest, not when importing the command.
128
import bzrlib.tests.blackbox
129
import bzrlib.tests.branch_implementations
130
import bzrlib.tests.bzrdir_implementations
131
import bzrlib.tests.interrepository_implementations
132
import bzrlib.tests.interversionedfile_implementations
133
import bzrlib.tests.intertree_implementations
134
import bzrlib.tests.per_lock
135
import bzrlib.tests.repository_implementations
136
import bzrlib.tests.revisionstore_implementations
137
import bzrlib.tests.tree_implementations
138
import bzrlib.tests.workingtree_implementations
141
bzrlib.tests.blackbox,
142
bzrlib.tests.branch_implementations,
143
bzrlib.tests.bzrdir_implementations,
144
bzrlib.tests.interrepository_implementations,
145
bzrlib.tests.interversionedfile_implementations,
146
bzrlib.tests.intertree_implementations,
147
bzrlib.tests.per_lock,
148
bzrlib.tests.repository_implementations,
149
bzrlib.tests.revisionstore_implementations,
150
bzrlib.tests.tree_implementations,
151
bzrlib.tests.workingtree_implementations,
155
class ExtendedTestResult(unittest._TextTestResult):
156
"""Accepts, reports and accumulates the results of running tests.
158
Compared to this unittest version this class adds support for profiling,
159
benchmarking, stopping as soon as a test fails, and skipping tests.
160
There are further-specialized subclasses for different types of display.
165
def __init__(self, stream, descriptions, verbosity,
168
use_numbered_dirs=False,
170
"""Construct new TestResult.
172
:param bench_history: Optionally, a writable file object to accumulate
175
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
176
if bench_history is not None:
177
from bzrlib.version import _get_bzr_source_tree
178
src_tree = _get_bzr_source_tree()
181
revision_id = src_tree.get_parent_ids()[0]
183
# XXX: if this is a brand new tree, do the same as if there
187
# XXX: If there's no branch, what should we do?
189
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
190
self._bench_history = bench_history
191
self.ui = ui.ui_factory
192
self.num_tests = num_tests
194
self.failure_count = 0
195
self.known_failure_count = 0
197
self.unsupported = {}
199
self.use_numbered_dirs = use_numbered_dirs
200
self._overall_start_time = time.time()
202
def extractBenchmarkTime(self, testCase):
203
"""Add a benchmark time for the current test case."""
204
self._benchmarkTime = getattr(testCase, "_benchtime", None)
206
def _elapsedTestTimeString(self):
207
"""Return a time string for the overall time the current test has taken."""
208
return self._formatTime(time.time() - self._start_time)
210
def _testTimeString(self):
211
if self._benchmarkTime is not None:
213
self._formatTime(self._benchmarkTime),
214
self._elapsedTestTimeString())
216
return " %s" % self._elapsedTestTimeString()
218
def _formatTime(self, seconds):
219
"""Format seconds as milliseconds with leading spaces."""
220
# some benchmarks can take thousands of seconds to run, so we need 8
222
return "%8dms" % (1000 * seconds)
224
def _shortened_test_description(self, test):
226
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
229
def startTest(self, test):
230
unittest.TestResult.startTest(self, test)
231
self.report_test_start(test)
232
test.number = self.count
233
self._recordTestStartTime()
235
def _recordTestStartTime(self):
236
"""Record that a test has started."""
237
self._start_time = time.time()
239
def _cleanupLogFile(self, test):
240
# We can only do this if we have one of our TestCases, not if
242
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
243
if setKeepLogfile is not None:
246
def addError(self, test, err):
247
self.extractBenchmarkTime(test)
248
self._cleanupLogFile(test)
249
if isinstance(err[1], TestSkipped):
250
return self.addSkipped(test, err)
251
elif isinstance(err[1], UnavailableFeature):
252
return self.addNotSupported(test, err[1].args[0])
253
unittest.TestResult.addError(self, test, err)
254
self.error_count += 1
255
self.report_error(test, err)
259
def addFailure(self, test, err):
260
self._cleanupLogFile(test)
261
self.extractBenchmarkTime(test)
262
if isinstance(err[1], KnownFailure):
263
return self.addKnownFailure(test, err)
264
unittest.TestResult.addFailure(self, test, err)
265
self.failure_count += 1
266
self.report_failure(test, err)
270
def addKnownFailure(self, test, err):
271
self.known_failure_count += 1
272
self.report_known_failure(test, err)
274
def addNotSupported(self, test, feature):
275
self.unsupported.setdefault(str(feature), 0)
276
self.unsupported[str(feature)] += 1
277
self.report_unsupported(test, feature)
279
def addSuccess(self, test):
280
self.extractBenchmarkTime(test)
281
if self._bench_history is not None:
282
if self._benchmarkTime is not None:
283
self._bench_history.write("%s %s\n" % (
284
self._formatTime(self._benchmarkTime),
286
self.report_success(test)
287
unittest.TestResult.addSuccess(self, test)
289
def addSkipped(self, test, skip_excinfo):
290
self.report_skip(test, skip_excinfo)
291
# seems best to treat this as success from point-of-view of unittest
292
# -- it actually does nothing so it barely matters :)
295
except KeyboardInterrupt:
298
self.addError(test, test.__exc_info())
300
unittest.TestResult.addSuccess(self, test)
302
def printErrorList(self, flavour, errors):
303
for test, err in errors:
304
self.stream.writeln(self.separator1)
305
self.stream.write("%s: " % flavour)
306
if self.use_numbered_dirs:
307
self.stream.write('#%d ' % test.number)
308
self.stream.writeln(self.getDescription(test))
309
if getattr(test, '_get_log', None) is not None:
311
print >>self.stream, \
312
('vvvv[log from %s]' % test.id()).ljust(78,'-')
313
print >>self.stream, test._get_log()
314
print >>self.stream, \
315
('^^^^[log from %s]' % test.id()).ljust(78,'-')
316
self.stream.writeln(self.separator2)
317
self.stream.writeln("%s" % err)
322
def report_cleaning_up(self):
325
def report_success(self, test):
329
class TextTestResult(ExtendedTestResult):
330
"""Displays progress and results of tests in text form"""
332
def __init__(self, stream, descriptions, verbosity,
336
use_numbered_dirs=False,
338
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
339
bench_history, num_tests, use_numbered_dirs)
341
self.pb = self.ui.nested_progress_bar()
342
self._supplied_pb = False
345
self._supplied_pb = True
346
self.pb.show_pct = False
347
self.pb.show_spinner = False
348
self.pb.show_eta = False,
349
self.pb.show_count = False
350
self.pb.show_bar = False
352
def report_starting(self):
353
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
355
def _progress_prefix_text(self):
356
a = '[%d' % self.count
357
if self.num_tests is not None:
358
a +='/%d' % self.num_tests
359
a += ' in %ds' % (time.time() - self._overall_start_time)
361
a += ', %d errors' % self.error_count
362
if self.failure_count:
363
a += ', %d failed' % self.failure_count
364
if self.known_failure_count:
365
a += ', %d known failures' % self.known_failure_count
367
a += ', %d skipped' % self.skip_count
369
a += ', %d missing features' % len(self.unsupported)
373
def report_test_start(self, test):
376
self._progress_prefix_text()
378
+ self._shortened_test_description(test))
380
def _test_description(self, test):
381
if self.use_numbered_dirs:
382
return '#%d %s' % (self.count,
383
self._shortened_test_description(test))
385
return self._shortened_test_description(test)
387
def report_error(self, test, err):
388
self.pb.note('ERROR: %s\n %s\n',
389
self._test_description(test),
393
def report_failure(self, test, err):
394
self.pb.note('FAIL: %s\n %s\n',
395
self._test_description(test),
399
def report_known_failure(self, test, err):
400
self.pb.note('XFAIL: %s\n%s\n',
401
self._test_description(test), err[1])
403
def report_skip(self, test, skip_excinfo):
406
# at the moment these are mostly not things we can fix
407
# and so they just produce stipple; use the verbose reporter
410
# show test and reason for skip
411
self.pb.note('SKIP: %s\n %s\n',
412
self._shortened_test_description(test),
415
# since the class name was left behind in the still-visible
417
self.pb.note('SKIP: %s', skip_excinfo[1])
419
def report_unsupported(self, test, feature):
420
"""test cannot be run because feature is missing."""
422
def report_cleaning_up(self):
423
self.pb.update('cleaning up...')
426
if not self._supplied_pb:
430
class VerboseTestResult(ExtendedTestResult):
431
"""Produce long output, with one line per test run plus times"""
433
def _ellipsize_to_right(self, a_string, final_width):
434
"""Truncate and pad a string, keeping the right hand side"""
435
if len(a_string) > final_width:
436
result = '...' + a_string[3-final_width:]
439
return result.ljust(final_width)
441
def report_starting(self):
442
self.stream.write('running %d tests...\n' % self.num_tests)
444
def report_test_start(self, test):
446
name = self._shortened_test_description(test)
447
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
448
# numbers, plus a trailing blank
449
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
450
if self.use_numbered_dirs:
451
self.stream.write('%5d ' % self.count)
452
self.stream.write(self._ellipsize_to_right(name,
453
osutils.terminal_width()-36))
455
self.stream.write(self._ellipsize_to_right(name,
456
osutils.terminal_width()-30))
459
def _error_summary(self, err):
461
if self.use_numbered_dirs:
463
return '%s%s' % (indent, err[1])
465
def report_error(self, test, err):
466
self.stream.writeln('ERROR %s\n%s'
467
% (self._testTimeString(),
468
self._error_summary(err)))
470
def report_failure(self, test, err):
471
self.stream.writeln(' FAIL %s\n%s'
472
% (self._testTimeString(),
473
self._error_summary(err)))
475
def report_known_failure(self, test, err):
476
self.stream.writeln('XFAIL %s\n%s'
477
% (self._testTimeString(),
478
self._error_summary(err)))
480
def report_success(self, test):
481
self.stream.writeln(' OK %s' % self._testTimeString())
482
for bench_called, stats in getattr(test, '_benchcalls', []):
483
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
484
stats.pprint(file=self.stream)
485
# flush the stream so that we get smooth output. This verbose mode is
486
# used to show the output in PQM.
489
def report_skip(self, test, skip_excinfo):
491
self.stream.writeln(' SKIP %s\n%s'
492
% (self._testTimeString(),
493
self._error_summary(skip_excinfo)))
495
def report_unsupported(self, test, feature):
496
"""test cannot be run because feature is missing."""
497
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
498
%(self._testTimeString(), feature))
502
class TextTestRunner(object):
503
stop_on_failure = False
510
use_numbered_dirs=False,
513
self.stream = unittest._WritelnDecorator(stream)
514
self.descriptions = descriptions
515
self.verbosity = verbosity
516
self._bench_history = bench_history
517
self.use_numbered_dirs = use_numbered_dirs
518
self.list_only = list_only
521
"Run the given test case or test suite."
522
startTime = time.time()
523
if self.verbosity == 1:
524
result_class = TextTestResult
525
elif self.verbosity >= 2:
526
result_class = VerboseTestResult
527
result = result_class(self.stream,
530
bench_history=self._bench_history,
531
num_tests=test.countTestCases(),
532
use_numbered_dirs=self.use_numbered_dirs,
534
result.stop_early = self.stop_on_failure
535
result.report_starting()
537
if self.verbosity >= 2:
538
self.stream.writeln("Listing tests only ...\n")
540
for t in iter_suite_tests(test):
541
self.stream.writeln("%s" % (t.id()))
543
actionTaken = "Listed"
546
run = result.testsRun
548
stopTime = time.time()
549
timeTaken = stopTime - startTime
551
self.stream.writeln(result.separator2)
552
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
553
run, run != 1 and "s" or "", timeTaken))
554
self.stream.writeln()
555
if not result.wasSuccessful():
556
self.stream.write("FAILED (")
557
failed, errored = map(len, (result.failures, result.errors))
559
self.stream.write("failures=%d" % failed)
561
if failed: self.stream.write(", ")
562
self.stream.write("errors=%d" % errored)
563
if result.known_failure_count:
564
if failed or errored: self.stream.write(", ")
565
self.stream.write("known_failure_count=%d" %
566
result.known_failure_count)
567
self.stream.writeln(")")
569
if result.known_failure_count:
570
self.stream.writeln("OK (known_failures=%d)" %
571
result.known_failure_count)
573
self.stream.writeln("OK")
574
if result.skip_count > 0:
575
skipped = result.skip_count
576
self.stream.writeln('%d test%s skipped' %
577
(skipped, skipped != 1 and "s" or ""))
578
if result.unsupported:
579
for feature, count in sorted(result.unsupported.items()):
580
self.stream.writeln("Missing feature '%s' skipped %d tests." %
586
def iter_suite_tests(suite):
587
"""Return all tests in a suite, recursing through nested suites"""
588
for item in suite._tests:
589
if isinstance(item, unittest.TestCase):
591
elif isinstance(item, unittest.TestSuite):
592
for r in iter_suite_tests(item):
595
raise Exception('unknown object %r inside test suite %r'
599
class TestSkipped(Exception):
600
"""Indicates that a test was intentionally skipped, rather than failing."""
603
class KnownFailure(AssertionError):
604
"""Indicates that a test failed in a precisely expected manner.
606
Such failures dont block the whole test suite from passing because they are
607
indicators of partially completed code or of future work. We have an
608
explicit error for them so that we can ensure that they are always visible:
609
KnownFailures are always shown in the output of bzr selftest.
613
class UnavailableFeature(Exception):
614
"""A feature required for this test was not available.
616
The feature should be used to construct the exception.
620
class CommandFailed(Exception):
624
class StringIOWrapper(object):
625
"""A wrapper around cStringIO which just adds an encoding attribute.
627
Internally we can check sys.stdout to see what the output encoding
628
should be. However, cStringIO has no encoding attribute that we can
629
set. So we wrap it instead.
634
def __init__(self, s=None):
636
self.__dict__['_cstring'] = StringIO(s)
638
self.__dict__['_cstring'] = StringIO()
640
def __getattr__(self, name, getattr=getattr):
641
return getattr(self.__dict__['_cstring'], name)
643
def __setattr__(self, name, val):
644
if name == 'encoding':
645
self.__dict__['encoding'] = val
647
return setattr(self._cstring, name, val)
650
class TestUIFactory(ui.CLIUIFactory):
651
"""A UI Factory for testing.
653
Hide the progress bar but emit note()s.
655
Allows get_password to be tested without real tty attached.
662
super(TestUIFactory, self).__init__()
663
if stdin is not None:
664
# We use a StringIOWrapper to be able to test various
665
# encodings, but the user is still responsible to
666
# encode the string and to set the encoding attribute
667
# of StringIOWrapper.
668
self.stdin = StringIOWrapper(stdin)
670
self.stdout = sys.stdout
674
self.stderr = sys.stderr
679
"""See progress.ProgressBar.clear()."""
681
def clear_term(self):
682
"""See progress.ProgressBar.clear_term()."""
684
def clear_term(self):
685
"""See progress.ProgressBar.clear_term()."""
688
"""See progress.ProgressBar.finished()."""
690
def note(self, fmt_string, *args, **kwargs):
691
"""See progress.ProgressBar.note()."""
692
self.stdout.write((fmt_string + "\n") % args)
694
def progress_bar(self):
697
def nested_progress_bar(self):
700
def update(self, message, count=None, total=None):
701
"""See progress.ProgressBar.update()."""
703
def get_non_echoed_password(self, prompt):
704
"""Get password from stdin without trying to handle the echo mode"""
706
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
707
password = self.stdin.readline()
710
if password[-1] == '\n':
711
password = password[:-1]
715
class TestCase(unittest.TestCase):
716
"""Base class for bzr unit tests.
718
Tests that need access to disk resources should subclass
719
TestCaseInTempDir not TestCase.
721
Error and debug log messages are redirected from their usual
722
location into a temporary file, the contents of which can be
723
retrieved by _get_log(). We use a real OS file, not an in-memory object,
724
so that it can also capture file IO. When the test completes this file
725
is read into memory and removed from disk.
727
There are also convenience functions to invoke bzr's command-line
728
routine, and to build and check bzr trees.
730
In addition to the usual method of overriding tearDown(), this class also
731
allows subclasses to register functions into the _cleanups list, which is
732
run in order as the object is torn down. It's less likely this will be
733
accidentally overlooked.
736
_log_file_name = None
738
_keep_log_file = False
739
# record lsprof data when performing benchmark calls.
740
_gather_lsprof_in_benchmarks = False
742
def __init__(self, methodName='testMethod'):
743
super(TestCase, self).__init__(methodName)
747
unittest.TestCase.setUp(self)
748
self._cleanEnvironment()
749
bzrlib.trace.disable_default_logging()
752
self._benchcalls = []
753
self._benchtime = None
755
self._clear_debug_flags()
757
def _clear_debug_flags(self):
758
"""Prevent externally set debug flags affecting tests.
760
Tests that want to use debug flags can just set them in the
761
debug_flags set during setup/teardown.
763
self._preserved_debug_flags = set(debug.debug_flags)
764
debug.debug_flags.clear()
765
self.addCleanup(self._restore_debug_flags)
767
def _clear_hooks(self):
768
# prevent hooks affecting tests
770
import bzrlib.smart.server
771
self._preserved_hooks = {
772
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
773
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
775
self.addCleanup(self._restoreHooks)
776
# reset all hooks to an empty instance of the appropriate type
777
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
778
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
780
def _silenceUI(self):
781
"""Turn off UI for duration of test"""
782
# by default the UI is off; tests can turn it on if they want it.
783
saved = ui.ui_factory
785
ui.ui_factory = saved
786
ui.ui_factory = ui.SilentUIFactory()
787
self.addCleanup(_restore)
789
def _ndiff_strings(self, a, b):
790
"""Return ndiff between two strings containing lines.
792
A trailing newline is added if missing to make the strings
794
if b and b[-1] != '\n':
796
if a and a[-1] != '\n':
798
difflines = difflib.ndiff(a.splitlines(True),
800
linejunk=lambda x: False,
801
charjunk=lambda x: False)
802
return ''.join(difflines)
804
def assertEqual(self, a, b, message=''):
808
except UnicodeError, e:
809
# If we can't compare without getting a UnicodeError, then
810
# obviously they are different
811
mutter('UnicodeError: %s', e)
814
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
816
pformat(a), pformat(b)))
818
assertEquals = assertEqual
820
def assertEqualDiff(self, a, b, message=None):
821
"""Assert two texts are equal, if not raise an exception.
823
This is intended for use with multi-line strings where it can
824
be hard to find the differences by eye.
826
# TODO: perhaps override assertEquals to call this for strings?
830
message = "texts not equal:\n"
831
raise AssertionError(message +
832
self._ndiff_strings(a, b))
834
def assertEqualMode(self, mode, mode_test):
835
self.assertEqual(mode, mode_test,
836
'mode mismatch %o != %o' % (mode, mode_test))
838
def assertStartsWith(self, s, prefix):
839
if not s.startswith(prefix):
840
raise AssertionError('string %r does not start with %r' % (s, prefix))
842
def assertEndsWith(self, s, suffix):
843
"""Asserts that s ends with suffix."""
844
if not s.endswith(suffix):
845
raise AssertionError('string %r does not end with %r' % (s, suffix))
847
def assertContainsRe(self, haystack, needle_re):
848
"""Assert that a contains something matching a regular expression."""
849
if not re.search(needle_re, haystack):
850
raise AssertionError('pattern "%r" not found in "%r"'
851
% (needle_re, haystack))
853
def assertNotContainsRe(self, haystack, needle_re):
854
"""Assert that a does not match a regular expression"""
855
if re.search(needle_re, haystack):
856
raise AssertionError('pattern "%s" found in "%s"'
857
% (needle_re, haystack))
859
def assertSubset(self, sublist, superlist):
860
"""Assert that every entry in sublist is present in superlist."""
862
for entry in sublist:
863
if entry not in superlist:
864
missing.append(entry)
866
raise AssertionError("value(s) %r not present in container %r" %
867
(missing, superlist))
869
def assertListRaises(self, excClass, func, *args, **kwargs):
870
"""Fail unless excClass is raised when the iterator from func is used.
872
Many functions can return generators this makes sure
873
to wrap them in a list() call to make sure the whole generator
874
is run, and that the proper exception is raised.
877
list(func(*args, **kwargs))
881
if getattr(excClass,'__name__', None) is not None:
882
excName = excClass.__name__
884
excName = str(excClass)
885
raise self.failureException, "%s not raised" % excName
887
def assertRaises(self, excClass, func, *args, **kwargs):
888
"""Assert that a callable raises a particular exception.
890
:param excClass: As for the except statement, this may be either an
891
exception class, or a tuple of classes.
893
Returns the exception so that you can examine it.
896
func(*args, **kwargs)
900
if getattr(excClass,'__name__', None) is not None:
901
excName = excClass.__name__
904
excName = str(excClass)
905
raise self.failureException, "%s not raised" % excName
907
def assertIs(self, left, right, message=None):
908
if not (left is right):
909
if message is not None:
910
raise AssertionError(message)
912
raise AssertionError("%r is not %r." % (left, right))
914
def assertIsNot(self, left, right, message=None):
916
if message is not None:
917
raise AssertionError(message)
919
raise AssertionError("%r is %r." % (left, right))
921
def assertTransportMode(self, transport, path, mode):
922
"""Fail if a path does not have mode mode.
924
If modes are not supported on this transport, the assertion is ignored.
926
if not transport._can_roundtrip_unix_modebits():
928
path_stat = transport.stat(path)
929
actual_mode = stat.S_IMODE(path_stat.st_mode)
930
self.assertEqual(mode, actual_mode,
931
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
933
def assertIsInstance(self, obj, kls):
934
"""Fail if obj is not an instance of kls"""
935
if not isinstance(obj, kls):
936
self.fail("%r is an instance of %s rather than %s" % (
937
obj, obj.__class__, kls))
939
def expectFailure(self, reason, assertion, *args, **kwargs):
940
"""Invoke a test, expecting it to fail for the given reason.
942
This is for assertions that ought to succeed, but currently fail.
943
(The failure is *expected* but not *wanted*.) Please be very precise
944
about the failure you're expecting. If a new bug is introduced,
945
AssertionError should be raised, not KnownFailure.
947
Frequently, expectFailure should be followed by an opposite assertion.
950
Intended to be used with a callable that raises AssertionError as the
951
'assertion' parameter. args and kwargs are passed to the 'assertion'.
953
Raises KnownFailure if the test fails. Raises AssertionError if the
958
self.expectFailure('Math is broken', self.assertNotEqual, 54,
960
self.assertEqual(42, dynamic_val)
962
This means that a dynamic_val of 54 will cause the test to raise
963
a KnownFailure. Once math is fixed and the expectFailure is removed,
964
only a dynamic_val of 42 will allow the test to pass. Anything other
965
than 54 or 42 will cause an AssertionError.
968
assertion(*args, **kwargs)
969
except AssertionError:
970
raise KnownFailure(reason)
972
self.fail('Unexpected success. Should have failed: %s' % reason)
974
def _capture_warnings(self, a_callable, *args, **kwargs):
975
"""A helper for callDeprecated and applyDeprecated.
977
:param a_callable: A callable to call.
978
:param args: The positional arguments for the callable
979
:param kwargs: The keyword arguments for the callable
980
:return: A tuple (warnings, result). result is the result of calling
981
a_callable(*args, **kwargs).
984
def capture_warnings(msg, cls=None, stacklevel=None):
985
# we've hooked into a deprecation specific callpath,
986
# only deprecations should getting sent via it.
987
self.assertEqual(cls, DeprecationWarning)
988
local_warnings.append(msg)
989
original_warning_method = symbol_versioning.warn
990
symbol_versioning.set_warning_method(capture_warnings)
992
result = a_callable(*args, **kwargs)
994
symbol_versioning.set_warning_method(original_warning_method)
995
return (local_warnings, result)
997
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
998
"""Call a deprecated callable without warning the user.
1000
Note that this only captures warnings raised by symbol_versioning.warn,
1001
not other callers that go direct to the warning module.
1003
:param deprecation_format: The deprecation format that the callable
1004
should have been deprecated with. This is the same type as the
1005
parameter to deprecated_method/deprecated_function. If the
1006
callable is not deprecated with this format, an assertion error
1008
:param a_callable: A callable to call. This may be a bound method or
1009
a regular function. It will be called with *args and **kwargs.
1010
:param args: The positional arguments for the callable
1011
:param kwargs: The keyword arguments for the callable
1012
:return: The result of a_callable(*args, **kwargs)
1014
call_warnings, result = self._capture_warnings(a_callable,
1016
expected_first_warning = symbol_versioning.deprecation_string(
1017
a_callable, deprecation_format)
1018
if len(call_warnings) == 0:
1019
self.fail("No deprecation warning generated by call to %s" %
1021
self.assertEqual(expected_first_warning, call_warnings[0])
1024
def callDeprecated(self, expected, callable, *args, **kwargs):
1025
"""Assert that a callable is deprecated in a particular way.
1027
This is a very precise test for unusual requirements. The
1028
applyDeprecated helper function is probably more suited for most tests
1029
as it allows you to simply specify the deprecation format being used
1030
and will ensure that that is issued for the function being called.
1032
Note that this only captures warnings raised by symbol_versioning.warn,
1033
not other callers that go direct to the warning module.
1035
:param expected: a list of the deprecation warnings expected, in order
1036
:param callable: The callable to call
1037
:param args: The positional arguments for the callable
1038
:param kwargs: The keyword arguments for the callable
1040
call_warnings, result = self._capture_warnings(callable,
1042
self.assertEqual(expected, call_warnings)
1045
def _startLogFile(self):
1046
"""Send bzr and test log messages to a temporary file.
1048
The file is removed as the test is torn down.
1050
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1051
self._log_file = os.fdopen(fileno, 'w+')
1052
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1053
self._log_file_name = name
1054
self.addCleanup(self._finishLogFile)
1056
def _finishLogFile(self):
1057
"""Finished with the log file.
1059
Close the file and delete it, unless setKeepLogfile was called.
1061
if self._log_file is None:
1063
bzrlib.trace.disable_test_log(self._log_nonce)
1064
self._log_file.close()
1065
self._log_file = None
1066
if not self._keep_log_file:
1067
os.remove(self._log_file_name)
1068
self._log_file_name = None
1070
def setKeepLogfile(self):
1071
"""Make the logfile not be deleted when _finishLogFile is called."""
1072
self._keep_log_file = True
1074
def addCleanup(self, callable):
1075
"""Arrange to run a callable when this case is torn down.
1077
Callables are run in the reverse of the order they are registered,
1078
ie last-in first-out.
1080
if callable in self._cleanups:
1081
raise ValueError("cleanup function %r already registered on %s"
1083
self._cleanups.append(callable)
1085
def _cleanEnvironment(self):
1087
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1088
'HOME': os.getcwd(),
1089
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1091
'BZREMAIL': None, # may still be present in the environment
1093
'BZR_PROGRESS_BAR': None,
1097
'https_proxy': None,
1098
'HTTPS_PROXY': None,
1103
# Nobody cares about these ones AFAIK. So far at
1104
# least. If you do (care), please update this comment
1108
'BZR_REMOTE_PATH': None,
1111
self.addCleanup(self._restoreEnvironment)
1112
for name, value in new_env.iteritems():
1113
self._captureVar(name, value)
1115
def _captureVar(self, name, newvalue):
1116
"""Set an environment variable, and reset it when finished."""
1117
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1119
def _restore_debug_flags(self):
1120
debug.debug_flags.clear()
1121
debug.debug_flags.update(self._preserved_debug_flags)
1123
def _restoreEnvironment(self):
1124
for name, value in self.__old_env.iteritems():
1125
osutils.set_or_unset_env(name, value)
1127
def _restoreHooks(self):
1128
for klass, hooks in self._preserved_hooks.items():
1129
setattr(klass, 'hooks', hooks)
1131
def knownFailure(self, reason):
1132
"""This test has failed for some known reason."""
1133
raise KnownFailure(reason)
1135
def run(self, result=None):
1136
if result is None: result = self.defaultTestResult()
1137
for feature in getattr(self, '_test_needs_features', []):
1138
if not feature.available():
1139
result.startTest(self)
1140
if getattr(result, 'addNotSupported', None):
1141
result.addNotSupported(self, feature)
1143
result.addSuccess(self)
1144
result.stopTest(self)
1146
return unittest.TestCase.run(self, result)
1150
unittest.TestCase.tearDown(self)
1152
def time(self, callable, *args, **kwargs):
1153
"""Run callable and accrue the time it takes to the benchmark time.
1155
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1156
this will cause lsprofile statistics to be gathered and stored in
1159
if self._benchtime is None:
1163
if not self._gather_lsprof_in_benchmarks:
1164
return callable(*args, **kwargs)
1166
# record this benchmark
1167
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1169
self._benchcalls.append(((callable, args, kwargs), stats))
1172
self._benchtime += time.time() - start
1174
def _runCleanups(self):
1175
"""Run registered cleanup functions.
1177
This should only be called from TestCase.tearDown.
1179
# TODO: Perhaps this should keep running cleanups even if
1180
# one of them fails?
1182
# Actually pop the cleanups from the list so tearDown running
1183
# twice is safe (this happens for skipped tests).
1184
while self._cleanups:
1185
self._cleanups.pop()()
1187
def log(self, *args):
1190
def _get_log(self, keep_log_file=False):
1191
"""Return as a string the log for this test. If the file is still
1192
on disk and keep_log_file=False, delete the log file and store the
1193
content in self._log_contents."""
1194
# flush the log file, to get all content
1196
bzrlib.trace._trace_file.flush()
1197
if self._log_contents:
1198
return self._log_contents
1199
if self._log_file_name is not None:
1200
logfile = open(self._log_file_name)
1202
log_contents = logfile.read()
1205
if not keep_log_file:
1206
self._log_contents = log_contents
1208
os.remove(self._log_file_name)
1210
if sys.platform == 'win32' and e.errno == errno.EACCES:
1211
print >>sys.stderr, ('Unable to delete log file '
1212
' %r' % self._log_file_name)
1217
return "DELETED log file to reduce memory footprint"
1219
@deprecated_method(zero_eighteen)
1220
def capture(self, cmd, retcode=0):
1221
"""Shortcut that splits cmd into words, runs, and returns stdout"""
1222
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
1224
def requireFeature(self, feature):
1225
"""This test requires a specific feature is available.
1227
:raises UnavailableFeature: When feature is not available.
1229
if not feature.available():
1230
raise UnavailableFeature(feature)
1232
@deprecated_method(zero_eighteen)
1233
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
1235
"""Invoke bzr and return (stdout, stderr).
1237
Don't call this method, just use run_bzr() which is equivalent.
1239
:param argv: Arguments to invoke bzr. This may be either a
1240
single string, in which case it is split by shlex into words,
1241
or a list of arguments.
1242
:param retcode: Expected return code, or None for don't-care.
1243
:param encoding: Encoding for sys.stdout and sys.stderr
1244
:param stdin: A string to be used as stdin for the command.
1245
:param working_dir: Change to this directory before running
1247
return self._run_bzr_autosplit(argv, retcode=retcode,
1248
encoding=encoding, stdin=stdin, working_dir=working_dir,
1251
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1253
"""Run bazaar command line, splitting up a string command line."""
1254
if isinstance(args, basestring):
1255
args = list(shlex.split(args))
1256
return self._run_bzr_core(args, retcode=retcode,
1257
encoding=encoding, stdin=stdin, working_dir=working_dir,
1260
def _run_bzr_core(self, args, retcode, encoding, stdin,
1262
if encoding is None:
1263
encoding = bzrlib.user_encoding
1264
stdout = StringIOWrapper()
1265
stderr = StringIOWrapper()
1266
stdout.encoding = encoding
1267
stderr.encoding = encoding
1269
self.log('run bzr: %r', args)
1270
# FIXME: don't call into logging here
1271
handler = logging.StreamHandler(stderr)
1272
handler.setLevel(logging.INFO)
1273
logger = logging.getLogger('')
1274
logger.addHandler(handler)
1275
old_ui_factory = ui.ui_factory
1276
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1279
if working_dir is not None:
1280
cwd = osutils.getcwd()
1281
os.chdir(working_dir)
1284
result = self.apply_redirected(ui.ui_factory.stdin,
1286
bzrlib.commands.run_bzr_catch_errors,
1289
logger.removeHandler(handler)
1290
ui.ui_factory = old_ui_factory
1294
out = stdout.getvalue()
1295
err = stderr.getvalue()
1297
self.log('output:\n%r', out)
1299
self.log('errors:\n%r', err)
1300
if retcode is not None:
1301
self.assertEquals(retcode, result,
1302
message='Unexpected return code')
1305
def run_bzr(self, *args, **kwargs):
1306
"""Invoke bzr, as if it were run from the command line.
1308
The argument list should not include the bzr program name - the
1309
first argument is normally the bzr command. Arguments may be
1310
passed in three ways:
1312
1- A list of strings, eg ["commit", "a"]. This is recommended
1313
when the command contains whitespace or metacharacters, or
1314
is built up at run time.
1316
2- A single string, eg "add a". This is the most convenient
1317
for hardcoded commands.
1319
3- Several varargs parameters, eg run_bzr("add", "a").
1320
This is not recommended for new code.
1322
This runs bzr through the interface that catches and reports
1323
errors, and with logging set to something approximating the
1324
default, so that error reporting can be checked.
1326
This should be the main method for tests that want to exercise the
1327
overall behavior of the bzr application (rather than a unit test
1328
or a functional test of the library.)
1330
:param stdin: A string to be used as stdin for the command.
1331
:param retcode: The status code the command should return;
1333
:param working_dir: The directory to run the command in
1334
:param error_regexes: A list of expected error messages. If
1335
specified they must be seen in the error output of the command.
1337
retcode = kwargs.pop('retcode', 0)
1338
encoding = kwargs.pop('encoding', None)
1339
stdin = kwargs.pop('stdin', None)
1340
working_dir = kwargs.pop('working_dir', None)
1341
error_regexes = kwargs.pop('error_regexes', [])
1344
if isinstance(args[0], (list, basestring)):
1347
## symbol_versioning.warn(zero_eighteen % "passing varargs to run_bzr",
1348
## DeprecationWarning, stacklevel=2)
1349
# not done yet, because too many tests would need to be updated -
1350
# but please don't do this in new code. -- mbp 20070626
1353
out, err = self._run_bzr_autosplit(args=args,
1355
encoding=encoding, stdin=stdin, working_dir=working_dir,
1358
for regex in error_regexes:
1359
self.assertContainsRe(err, regex)
1362
def run_bzr_decode(self, *args, **kwargs):
1363
if 'encoding' in kwargs:
1364
encoding = kwargs['encoding']
1366
encoding = bzrlib.user_encoding
1367
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1369
def run_bzr_error(self, error_regexes, *args, **kwargs):
1370
"""Run bzr, and check that stderr contains the supplied regexes
1372
:param error_regexes: Sequence of regular expressions which
1373
must each be found in the error output. The relative ordering
1375
:param args: command-line arguments for bzr
1376
:param kwargs: Keyword arguments which are interpreted by run_bzr
1377
This function changes the default value of retcode to be 3,
1378
since in most cases this is run when you expect bzr to fail.
1379
:return: (out, err) The actual output of running the command (in case you
1380
want to do more inspection)
1383
# Make sure that commit is failing because there is nothing to do
1384
self.run_bzr_error(['no changes to commit'],
1385
'commit', '-m', 'my commit comment')
1386
# Make sure --strict is handling an unknown file, rather than
1387
# giving us the 'nothing to do' error
1388
self.build_tree(['unknown'])
1389
self.run_bzr_error(['Commit refused because there are unknown files'],
1390
'commit', '--strict', '-m', 'my commit comment')
1392
kwargs.setdefault('retcode', 3)
1393
out, err = self.run_bzr(error_regexes=error_regexes, *args, **kwargs)
1396
def run_bzr_subprocess(self, *args, **kwargs):
1397
"""Run bzr in a subprocess for testing.
1399
This starts a new Python interpreter and runs bzr in there.
1400
This should only be used for tests that have a justifiable need for
1401
this isolation: e.g. they are testing startup time, or signal
1402
handling, or early startup code, etc. Subprocess code can't be
1403
profiled or debugged so easily.
1405
:param retcode: The status code that is expected. Defaults to 0. If
1406
None is supplied, the status code is not checked.
1407
:param env_changes: A dictionary which lists changes to environment
1408
variables. A value of None will unset the env variable.
1409
The values must be strings. The change will only occur in the
1410
child, so you don't need to fix the environment after running.
1411
:param universal_newlines: Convert CRLF => LF
1412
:param allow_plugins: By default the subprocess is run with
1413
--no-plugins to ensure test reproducibility. Also, it is possible
1414
for system-wide plugins to create unexpected output on stderr,
1415
which can cause unnecessary test failures.
1417
env_changes = kwargs.get('env_changes', {})
1418
working_dir = kwargs.get('working_dir', None)
1419
allow_plugins = kwargs.get('allow_plugins', False)
1420
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1421
working_dir=working_dir,
1422
allow_plugins=allow_plugins)
1423
# We distinguish between retcode=None and retcode not passed.
1424
supplied_retcode = kwargs.get('retcode', 0)
1425
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1426
universal_newlines=kwargs.get('universal_newlines', False),
1429
def start_bzr_subprocess(self, process_args, env_changes=None,
1430
skip_if_plan_to_signal=False,
1432
allow_plugins=False):
1433
"""Start bzr in a subprocess for testing.
1435
This starts a new Python interpreter and runs bzr in there.
1436
This should only be used for tests that have a justifiable need for
1437
this isolation: e.g. they are testing startup time, or signal
1438
handling, or early startup code, etc. Subprocess code can't be
1439
profiled or debugged so easily.
1441
:param process_args: a list of arguments to pass to the bzr executable,
1442
for example `['--version']`.
1443
:param env_changes: A dictionary which lists changes to environment
1444
variables. A value of None will unset the env variable.
1445
The values must be strings. The change will only occur in the
1446
child, so you don't need to fix the environment after running.
1447
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1449
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1451
:returns: Popen object for the started process.
1453
if skip_if_plan_to_signal:
1454
if not getattr(os, 'kill', None):
1455
raise TestSkipped("os.kill not available.")
1457
if env_changes is None:
1461
def cleanup_environment():
1462
for env_var, value in env_changes.iteritems():
1463
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1465
def restore_environment():
1466
for env_var, value in old_env.iteritems():
1467
osutils.set_or_unset_env(env_var, value)
1469
bzr_path = self.get_bzr_path()
1472
if working_dir is not None:
1473
cwd = osutils.getcwd()
1474
os.chdir(working_dir)
1477
# win32 subprocess doesn't support preexec_fn
1478
# so we will avoid using it on all platforms, just to
1479
# make sure the code path is used, and we don't break on win32
1480
cleanup_environment()
1481
command = [sys.executable, bzr_path]
1482
if not allow_plugins:
1483
command.append('--no-plugins')
1484
command.extend(process_args)
1485
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1487
restore_environment()
1493
def _popen(self, *args, **kwargs):
1494
"""Place a call to Popen.
1496
Allows tests to override this method to intercept the calls made to
1497
Popen for introspection.
1499
return Popen(*args, **kwargs)
1501
def get_bzr_path(self):
1502
"""Return the path of the 'bzr' executable for this test suite."""
1503
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1504
if not os.path.isfile(bzr_path):
1505
# We are probably installed. Assume sys.argv is the right file
1506
bzr_path = sys.argv[0]
1509
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1510
universal_newlines=False, process_args=None):
1511
"""Finish the execution of process.
1513
:param process: the Popen object returned from start_bzr_subprocess.
1514
:param retcode: The status code that is expected. Defaults to 0. If
1515
None is supplied, the status code is not checked.
1516
:param send_signal: an optional signal to send to the process.
1517
:param universal_newlines: Convert CRLF => LF
1518
:returns: (stdout, stderr)
1520
if send_signal is not None:
1521
os.kill(process.pid, send_signal)
1522
out, err = process.communicate()
1524
if universal_newlines:
1525
out = out.replace('\r\n', '\n')
1526
err = err.replace('\r\n', '\n')
1528
if retcode is not None and retcode != process.returncode:
1529
if process_args is None:
1530
process_args = "(unknown args)"
1531
mutter('Output of bzr %s:\n%s', process_args, out)
1532
mutter('Error for bzr %s:\n%s', process_args, err)
1533
self.fail('Command bzr %s failed with retcode %s != %s'
1534
% (process_args, retcode, process.returncode))
1537
def check_inventory_shape(self, inv, shape):
1538
"""Compare an inventory to a list of expected names.
1540
Fail if they are not precisely equal.
1543
shape = list(shape) # copy
1544
for path, ie in inv.entries():
1545
name = path.replace('\\', '/')
1546
if ie.kind == 'dir':
1553
self.fail("expected paths not found in inventory: %r" % shape)
1555
self.fail("unexpected paths found in inventory: %r" % extras)
1557
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1558
a_callable=None, *args, **kwargs):
1559
"""Call callable with redirected std io pipes.
1561
Returns the return code."""
1562
if not callable(a_callable):
1563
raise ValueError("a_callable must be callable.")
1565
stdin = StringIO("")
1567
if getattr(self, "_log_file", None) is not None:
1568
stdout = self._log_file
1572
if getattr(self, "_log_file", None is not None):
1573
stderr = self._log_file
1576
real_stdin = sys.stdin
1577
real_stdout = sys.stdout
1578
real_stderr = sys.stderr
1583
return a_callable(*args, **kwargs)
1585
sys.stdout = real_stdout
1586
sys.stderr = real_stderr
1587
sys.stdin = real_stdin
1589
def reduceLockdirTimeout(self):
1590
"""Reduce the default lock timeout for the duration of the test, so that
1591
if LockContention occurs during a test, it does so quickly.
1593
Tests that expect to provoke LockContention errors should call this.
1595
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1597
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1598
self.addCleanup(resetTimeout)
1599
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1602
class TestCaseWithMemoryTransport(TestCase):
1603
"""Common test class for tests that do not need disk resources.
1605
Tests that need disk resources should derive from TestCaseWithTransport.
1607
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1609
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1610
a directory which does not exist. This serves to help ensure test isolation
1611
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1612
must exist. However, TestCaseWithMemoryTransport does not offer local
1613
file defaults for the transport in tests, nor does it obey the command line
1614
override, so tests that accidentally write to the common directory should
1617
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1618
a .bzr directory that stops us ascending higher into the filesystem.
1624
def __init__(self, methodName='runTest'):
1625
# allow test parameterisation after test construction and before test
1626
# execution. Variables that the parameteriser sets need to be
1627
# ones that are not set by setUp, or setUp will trash them.
1628
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1629
self.vfs_transport_factory = default_transport
1630
self.transport_server = None
1631
self.transport_readonly_server = None
1632
self.__vfs_server = None
1634
def get_transport(self):
1635
"""Return a writeable transport for the test scratch space"""
1636
t = get_transport(self.get_url())
1637
self.assertFalse(t.is_readonly())
1640
def get_readonly_transport(self):
1641
"""Return a readonly transport for the test scratch space
1643
This can be used to test that operations which should only need
1644
readonly access in fact do not try to write.
1646
t = get_transport(self.get_readonly_url())
1647
self.assertTrue(t.is_readonly())
1650
def create_transport_readonly_server(self):
1651
"""Create a transport server from class defined at init.
1653
This is mostly a hook for daughter classes.
1655
return self.transport_readonly_server()
1657
def get_readonly_server(self):
1658
"""Get the server instance for the readonly transport
1660
This is useful for some tests with specific servers to do diagnostics.
1662
if self.__readonly_server is None:
1663
if self.transport_readonly_server is None:
1664
# readonly decorator requested
1665
# bring up the server
1666
self.__readonly_server = ReadonlyServer()
1667
self.__readonly_server.setUp(self.get_vfs_only_server())
1669
self.__readonly_server = self.create_transport_readonly_server()
1670
self.__readonly_server.setUp(self.get_vfs_only_server())
1671
self.addCleanup(self.__readonly_server.tearDown)
1672
return self.__readonly_server
1674
def get_readonly_url(self, relpath=None):
1675
"""Get a URL for the readonly transport.
1677
This will either be backed by '.' or a decorator to the transport
1678
used by self.get_url()
1679
relpath provides for clients to get a path relative to the base url.
1680
These should only be downwards relative, not upwards.
1682
base = self.get_readonly_server().get_url()
1683
if relpath is not None:
1684
if not base.endswith('/'):
1686
base = base + relpath
1689
def get_vfs_only_server(self):
1690
"""Get the vfs only read/write server instance.
1692
This is useful for some tests with specific servers that need
1695
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1696
is no means to override it.
1698
if self.__vfs_server is None:
1699
self.__vfs_server = MemoryServer()
1700
self.__vfs_server.setUp()
1701
self.addCleanup(self.__vfs_server.tearDown)
1702
return self.__vfs_server
1704
def get_server(self):
1705
"""Get the read/write server instance.
1707
This is useful for some tests with specific servers that need
1710
This is built from the self.transport_server factory. If that is None,
1711
then the self.get_vfs_server is returned.
1713
if self.__server is None:
1714
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1715
return self.get_vfs_only_server()
1717
# bring up a decorated means of access to the vfs only server.
1718
self.__server = self.transport_server()
1720
self.__server.setUp(self.get_vfs_only_server())
1721
except TypeError, e:
1722
# This should never happen; the try:Except here is to assist
1723
# developers having to update code rather than seeing an
1724
# uninformative TypeError.
1725
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1726
self.addCleanup(self.__server.tearDown)
1727
return self.__server
1729
def _adjust_url(self, base, relpath):
1730
"""Get a URL (or maybe a path) for the readwrite transport.
1732
This will either be backed by '.' or to an equivalent non-file based
1734
relpath provides for clients to get a path relative to the base url.
1735
These should only be downwards relative, not upwards.
1737
if relpath is not None and relpath != '.':
1738
if not base.endswith('/'):
1740
# XXX: Really base should be a url; we did after all call
1741
# get_url()! But sometimes it's just a path (from
1742
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1743
# to a non-escaped local path.
1744
if base.startswith('./') or base.startswith('/'):
1747
base += urlutils.escape(relpath)
1750
def get_url(self, relpath=None):
1751
"""Get a URL (or maybe a path) for the readwrite transport.
1753
This will either be backed by '.' or to an equivalent non-file based
1755
relpath provides for clients to get a path relative to the base url.
1756
These should only be downwards relative, not upwards.
1758
base = self.get_server().get_url()
1759
return self._adjust_url(base, relpath)
1761
def get_vfs_only_url(self, relpath=None):
1762
"""Get a URL (or maybe a path for the plain old vfs transport.
1764
This will never be a smart protocol. It always has all the
1765
capabilities of the local filesystem, but it might actually be a
1766
MemoryTransport or some other similar virtual filesystem.
1768
This is the backing transport (if any) of the server returned by
1769
get_url and get_readonly_url.
1771
:param relpath: provides for clients to get a path relative to the base
1772
url. These should only be downwards relative, not upwards.
1774
base = self.get_vfs_only_server().get_url()
1775
return self._adjust_url(base, relpath)
1777
def _make_test_root(self):
1778
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1780
root = tempfile.mkdtemp(prefix='testbzr-', suffix='.tmp')
1781
TestCaseWithMemoryTransport.TEST_ROOT = root
1783
# make a fake bzr directory there to prevent any tests propagating
1784
# up onto the source directory's real branch
1785
bzrdir.BzrDir.create_standalone_workingtree(root)
1787
# The same directory is used by all tests, and we're not specifically
1788
# told when all tests are finished. This will do.
1789
atexit.register(_rmtree_temp_dir, root)
1791
def makeAndChdirToTestDir(self):
1792
"""Create a temporary directories for this one test.
1794
This must set self.test_home_dir and self.test_dir and chdir to
1797
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1799
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1800
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1801
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1803
def make_branch(self, relpath, format=None):
1804
"""Create a branch on the transport at relpath."""
1805
repo = self.make_repository(relpath, format=format)
1806
return repo.bzrdir.create_branch()
1808
def make_bzrdir(self, relpath, format=None):
1810
# might be a relative or absolute path
1811
maybe_a_url = self.get_url(relpath)
1812
segments = maybe_a_url.rsplit('/', 1)
1813
t = get_transport(maybe_a_url)
1814
if len(segments) > 1 and segments[-1] not in ('', '.'):
1818
if isinstance(format, basestring):
1819
format = bzrdir.format_registry.make_bzrdir(format)
1820
return format.initialize_on_transport(t)
1821
except errors.UninitializableFormat:
1822
raise TestSkipped("Format %s is not initializable." % format)
1824
def make_repository(self, relpath, shared=False, format=None):
1825
"""Create a repository on our default transport at relpath.
1827
Note that relpath must be a relative path, not a full url.
1829
# FIXME: If you create a remoterepository this returns the underlying
1830
# real format, which is incorrect. Actually we should make sure that
1831
# RemoteBzrDir returns a RemoteRepository.
1832
# maybe mbp 20070410
1833
made_control = self.make_bzrdir(relpath, format=format)
1834
return made_control.create_repository(shared=shared)
1836
def make_branch_and_memory_tree(self, relpath, format=None):
1837
"""Create a branch on the default transport and a MemoryTree for it."""
1838
b = self.make_branch(relpath, format=format)
1839
return memorytree.MemoryTree.create_on_branch(b)
1841
def overrideEnvironmentForTesting(self):
1842
os.environ['HOME'] = self.test_home_dir
1843
os.environ['BZR_HOME'] = self.test_home_dir
1846
super(TestCaseWithMemoryTransport, self).setUp()
1847
self._make_test_root()
1848
_currentdir = os.getcwdu()
1849
def _leaveDirectory():
1850
os.chdir(_currentdir)
1851
self.addCleanup(_leaveDirectory)
1852
self.makeAndChdirToTestDir()
1853
self.overrideEnvironmentForTesting()
1854
self.__readonly_server = None
1855
self.__server = None
1856
self.reduceLockdirTimeout()
1859
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1860
"""Derived class that runs a test within a temporary directory.
1862
This is useful for tests that need to create a branch, etc.
1864
The directory is created in a slightly complex way: for each
1865
Python invocation, a new temporary top-level directory is created.
1866
All test cases create their own directory within that. If the
1867
tests complete successfully, the directory is removed.
1869
:ivar test_base_dir: The path of the top-level directory for this
1870
test, which contains a home directory and a work directory.
1872
:ivar test_home_dir: An initially empty directory under test_base_dir
1873
which is used as $HOME for this test.
1875
:ivar test_dir: A directory under test_base_dir used as the current
1876
directory when the test proper is run.
1879
OVERRIDE_PYTHON = 'python'
1880
use_numbered_dirs = False
1882
def check_file_contents(self, filename, expect):
1883
self.log("check contents of file %s" % filename)
1884
contents = file(filename, 'r').read()
1885
if contents != expect:
1886
self.log("expected: %r" % expect)
1887
self.log("actually: %r" % contents)
1888
self.fail("contents of %s not as expected" % filename)
1890
def makeAndChdirToTestDir(self):
1891
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1893
For TestCaseInTempDir we create a temporary directory based on the test
1894
name and then create two subdirs - test and home under it.
1896
# create a directory within the top level test directory
1897
candidate_dir = tempfile.mkdtemp(dir=self.TEST_ROOT)
1898
# now create test and home directories within this dir
1899
self.test_base_dir = candidate_dir
1900
self.test_home_dir = self.test_base_dir + '/home'
1901
os.mkdir(self.test_home_dir)
1902
self.test_dir = self.test_base_dir + '/work'
1903
os.mkdir(self.test_dir)
1904
os.chdir(self.test_dir)
1905
# put name of test inside
1906
f = file(self.test_base_dir + '/name', 'w')
1911
self.addCleanup(self.deleteTestDir)
1913
def deleteTestDir(self):
1914
_rmtree_temp_dir(self.test_base_dir)
1916
def build_tree(self, shape, line_endings='binary', transport=None):
1917
"""Build a test tree according to a pattern.
1919
shape is a sequence of file specifications. If the final
1920
character is '/', a directory is created.
1922
This assumes that all the elements in the tree being built are new.
1924
This doesn't add anything to a branch.
1925
:param line_endings: Either 'binary' or 'native'
1926
in binary mode, exact contents are written
1927
in native mode, the line endings match the
1928
default platform endings.
1930
:param transport: A transport to write to, for building trees on
1931
VFS's. If the transport is readonly or None,
1932
"." is opened automatically.
1934
# It's OK to just create them using forward slashes on windows.
1935
if transport is None or transport.is_readonly():
1936
transport = get_transport(".")
1938
self.assert_(isinstance(name, basestring))
1940
transport.mkdir(urlutils.escape(name[:-1]))
1942
if line_endings == 'binary':
1944
elif line_endings == 'native':
1947
raise errors.BzrError(
1948
'Invalid line ending request %r' % line_endings)
1949
content = "contents of %s%s" % (name.encode('utf-8'), end)
1950
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1952
def build_tree_contents(self, shape):
1953
build_tree_contents(shape)
1955
def assertFileEqual(self, content, path):
1956
"""Fail if path does not contain 'content'."""
1957
self.failUnlessExists(path)
1958
f = file(path, 'rb')
1963
self.assertEqualDiff(content, s)
1965
def failUnlessExists(self, path):
1966
"""Fail unless path or paths, which may be abs or relative, exist."""
1967
if not isinstance(path, basestring):
1969
self.failUnlessExists(p)
1971
self.failUnless(osutils.lexists(path),path+" does not exist")
1973
def failIfExists(self, path):
1974
"""Fail if path or paths, which may be abs or relative, exist."""
1975
if not isinstance(path, basestring):
1977
self.failIfExists(p)
1979
self.failIf(osutils.lexists(path),path+" exists")
1981
def assertInWorkingTree(self,path,root_path='.',tree=None):
1982
"""Assert whether path or paths are in the WorkingTree"""
1984
tree = workingtree.WorkingTree.open(root_path)
1985
if not isinstance(path, basestring):
1987
self.assertInWorkingTree(p,tree=tree)
1989
self.assertIsNot(tree.path2id(path), None,
1990
path+' not in working tree.')
1992
def assertNotInWorkingTree(self,path,root_path='.',tree=None):
1993
"""Assert whether path or paths are not in the WorkingTree"""
1995
tree = workingtree.WorkingTree.open(root_path)
1996
if not isinstance(path, basestring):
1998
self.assertNotInWorkingTree(p,tree=tree)
2000
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2003
class TestCaseWithTransport(TestCaseInTempDir):
2004
"""A test case that provides get_url and get_readonly_url facilities.
2006
These back onto two transport servers, one for readonly access and one for
2009
If no explicit class is provided for readonly access, a
2010
ReadonlyTransportDecorator is used instead which allows the use of non disk
2011
based read write transports.
2013
If an explicit class is provided for readonly access, that server and the
2014
readwrite one must both define get_url() as resolving to os.getcwd().
2017
def get_vfs_only_server(self):
2018
"""See TestCaseWithMemoryTransport.
2020
This is useful for some tests with specific servers that need
2023
if self.__vfs_server is None:
2024
self.__vfs_server = self.vfs_transport_factory()
2025
self.__vfs_server.setUp()
2026
self.addCleanup(self.__vfs_server.tearDown)
2027
return self.__vfs_server
2029
def make_branch_and_tree(self, relpath, format=None):
2030
"""Create a branch on the transport and a tree locally.
2032
If the transport is not a LocalTransport, the Tree can't be created on
2033
the transport. In that case if the vfs_transport_factory is
2034
LocalURLServer the working tree is created in the local
2035
directory backing the transport, and the returned tree's branch and
2036
repository will also be accessed locally. Otherwise a lightweight
2037
checkout is created and returned.
2039
:param format: The BzrDirFormat.
2040
:returns: the WorkingTree.
2042
# TODO: always use the local disk path for the working tree,
2043
# this obviously requires a format that supports branch references
2044
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2046
b = self.make_branch(relpath, format=format)
2048
return b.bzrdir.create_workingtree()
2049
except errors.NotLocalUrl:
2050
# We can only make working trees locally at the moment. If the
2051
# transport can't support them, then we keep the non-disk-backed
2052
# branch and create a local checkout.
2053
if self.vfs_transport_factory is LocalURLServer:
2054
# the branch is colocated on disk, we cannot create a checkout.
2055
# hopefully callers will expect this.
2056
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2057
return local_controldir.create_workingtree()
2059
return b.create_checkout(relpath, lightweight=True)
2061
def assertIsDirectory(self, relpath, transport):
2062
"""Assert that relpath within transport is a directory.
2064
This may not be possible on all transports; in that case it propagates
2065
a TransportNotPossible.
2068
mode = transport.stat(relpath).st_mode
2069
except errors.NoSuchFile:
2070
self.fail("path %s is not a directory; no such file"
2072
if not stat.S_ISDIR(mode):
2073
self.fail("path %s is not a directory; has mode %#o"
2076
def assertTreesEqual(self, left, right):
2077
"""Check that left and right have the same content and properties."""
2078
# we use a tree delta to check for equality of the content, and we
2079
# manually check for equality of other things such as the parents list.
2080
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2081
differences = left.changes_from(right)
2082
self.assertFalse(differences.has_changed(),
2083
"Trees %r and %r are different: %r" % (left, right, differences))
2086
super(TestCaseWithTransport, self).setUp()
2087
self.__vfs_server = None
2090
class ChrootedTestCase(TestCaseWithTransport):
2091
"""A support class that provides readonly urls outside the local namespace.
2093
This is done by checking if self.transport_server is a MemoryServer. if it
2094
is then we are chrooted already, if it is not then an HttpServer is used
2097
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2098
be used without needed to redo it when a different
2099
subclass is in use ?
2103
super(ChrootedTestCase, self).setUp()
2104
if not self.vfs_transport_factory == MemoryServer:
2105
self.transport_readonly_server = HttpServer
2108
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2109
random_order=False):
2110
"""Create a test suite by filtering another one.
2112
:param suite: the source suite
2113
:param pattern: pattern that names must match
2114
:param exclude_pattern: pattern that names must not match, if any
2115
:param random_order: if True, tests in the new suite will be put in
2117
:returns: the newly created suite
2119
return sort_suite_by_re(suite, pattern, exclude_pattern,
2120
random_order, False)
2123
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2124
random_order=False, append_rest=True):
2125
"""Create a test suite by sorting another one.
2127
:param suite: the source suite
2128
:param pattern: pattern that names must match in order to go
2129
first in the new suite
2130
:param exclude_pattern: pattern that names must not match, if any
2131
:param random_order: if True, tests in the new suite will be put in
2133
:param append_rest: if False, pattern is a strict filter and not
2134
just an ordering directive
2135
:returns: the newly created suite
2139
filter_re = re.compile(pattern)
2140
if exclude_pattern is not None:
2141
exclude_re = re.compile(exclude_pattern)
2142
for test in iter_suite_tests(suite):
2144
if exclude_pattern is None or not exclude_re.search(test_id):
2145
if filter_re.search(test_id):
2150
random.shuffle(first)
2151
random.shuffle(second)
2152
return TestUtil.TestSuite(first + second)
2155
def run_suite(suite, name='test', verbose=False, pattern=".*",
2156
stop_on_failure=False,
2157
transport=None, lsprof_timed=None, bench_history=None,
2158
matching_tests_first=None,
2162
exclude_pattern=None,
2164
use_numbered_dirs = bool(numbered_dirs)
2166
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2167
if numbered_dirs is not None:
2168
TestCaseInTempDir.use_numbered_dirs = use_numbered_dirs
2173
runner = TextTestRunner(stream=sys.stdout,
2175
verbosity=verbosity,
2176
bench_history=bench_history,
2177
use_numbered_dirs=use_numbered_dirs,
2178
list_only=list_only,
2180
runner.stop_on_failure=stop_on_failure
2181
# Initialise the random number generator and display the seed used.
2182
# We convert the seed to a long to make it reuseable across invocations.
2183
random_order = False
2184
if random_seed is not None:
2186
if random_seed == "now":
2187
random_seed = long(time.time())
2189
# Convert the seed to a long if we can
2191
random_seed = long(random_seed)
2194
runner.stream.writeln("Randomizing test order using seed %s\n" %
2196
random.seed(random_seed)
2197
# Customise the list of tests if requested
2198
if pattern != '.*' or exclude_pattern is not None or random_order:
2199
if matching_tests_first:
2200
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
2203
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
2205
result = runner.run(suite)
2206
return result.wasSuccessful()
2209
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2211
test_suite_factory=None,
2214
matching_tests_first=None,
2218
exclude_pattern=None):
2219
"""Run the whole test suite under the enhanced runner"""
2220
# XXX: Very ugly way to do this...
2221
# Disable warning about old formats because we don't want it to disturb
2222
# any blackbox tests.
2223
from bzrlib import repository
2224
repository._deprecation_warning_done = True
2226
global default_transport
2227
if transport is None:
2228
transport = default_transport
2229
old_transport = default_transport
2230
default_transport = transport
2232
if test_suite_factory is None:
2233
suite = test_suite()
2235
suite = test_suite_factory()
2236
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2237
stop_on_failure=stop_on_failure,
2238
transport=transport,
2239
lsprof_timed=lsprof_timed,
2240
bench_history=bench_history,
2241
matching_tests_first=matching_tests_first,
2242
numbered_dirs=numbered_dirs,
2243
list_only=list_only,
2244
random_seed=random_seed,
2245
exclude_pattern=exclude_pattern)
2247
default_transport = old_transport
2251
"""Build and return TestSuite for the whole of bzrlib.
2253
This function can be replaced if you need to change the default test
2254
suite on a global basis, but it is not encouraged.
2257
'bzrlib.tests.test_ancestry',
2258
'bzrlib.tests.test_annotate',
2259
'bzrlib.tests.test_api',
2260
'bzrlib.tests.test_atomicfile',
2261
'bzrlib.tests.test_bad_files',
2262
'bzrlib.tests.test_branch',
2263
'bzrlib.tests.test_branchbuilder',
2264
'bzrlib.tests.test_bugtracker',
2265
'bzrlib.tests.test_bundle',
2266
'bzrlib.tests.test_bzrdir',
2267
'bzrlib.tests.test_cache_utf8',
2268
'bzrlib.tests.test_commands',
2269
'bzrlib.tests.test_commit',
2270
'bzrlib.tests.test_commit_merge',
2271
'bzrlib.tests.test_config',
2272
'bzrlib.tests.test_conflicts',
2273
'bzrlib.tests.test_pack',
2274
'bzrlib.tests.test_counted_lock',
2275
'bzrlib.tests.test_decorators',
2276
'bzrlib.tests.test_delta',
2277
'bzrlib.tests.test_deprecated_graph',
2278
'bzrlib.tests.test_diff',
2279
'bzrlib.tests.test_dirstate',
2280
'bzrlib.tests.test_errors',
2281
'bzrlib.tests.test_escaped_store',
2282
'bzrlib.tests.test_extract',
2283
'bzrlib.tests.test_fetch',
2284
'bzrlib.tests.test_ftp_transport',
2285
'bzrlib.tests.test_generate_docs',
2286
'bzrlib.tests.test_generate_ids',
2287
'bzrlib.tests.test_globbing',
2288
'bzrlib.tests.test_gpg',
2289
'bzrlib.tests.test_graph',
2290
'bzrlib.tests.test_hashcache',
2291
'bzrlib.tests.test_help',
2292
'bzrlib.tests.test_hooks',
2293
'bzrlib.tests.test_http',
2294
'bzrlib.tests.test_http_response',
2295
'bzrlib.tests.test_https_ca_bundle',
2296
'bzrlib.tests.test_identitymap',
2297
'bzrlib.tests.test_ignores',
2298
'bzrlib.tests.test_info',
2299
'bzrlib.tests.test_inv',
2300
'bzrlib.tests.test_knit',
2301
'bzrlib.tests.test_lazy_import',
2302
'bzrlib.tests.test_lazy_regex',
2303
'bzrlib.tests.test_lockdir',
2304
'bzrlib.tests.test_lockable_files',
2305
'bzrlib.tests.test_log',
2306
'bzrlib.tests.test_lsprof',
2307
'bzrlib.tests.test_memorytree',
2308
'bzrlib.tests.test_merge',
2309
'bzrlib.tests.test_merge3',
2310
'bzrlib.tests.test_merge_core',
2311
'bzrlib.tests.test_merge_directive',
2312
'bzrlib.tests.test_missing',
2313
'bzrlib.tests.test_msgeditor',
2314
'bzrlib.tests.test_nonascii',
2315
'bzrlib.tests.test_options',
2316
'bzrlib.tests.test_osutils',
2317
'bzrlib.tests.test_osutils_encodings',
2318
'bzrlib.tests.test_patch',
2319
'bzrlib.tests.test_patches',
2320
'bzrlib.tests.test_permissions',
2321
'bzrlib.tests.test_plugins',
2322
'bzrlib.tests.test_progress',
2323
'bzrlib.tests.test_reconcile',
2324
'bzrlib.tests.test_registry',
2325
'bzrlib.tests.test_remote',
2326
'bzrlib.tests.test_repository',
2327
'bzrlib.tests.test_revert',
2328
'bzrlib.tests.test_revision',
2329
'bzrlib.tests.test_revisionnamespaces',
2330
'bzrlib.tests.test_revisiontree',
2331
'bzrlib.tests.test_rio',
2332
'bzrlib.tests.test_sampler',
2333
'bzrlib.tests.test_selftest',
2334
'bzrlib.tests.test_setup',
2335
'bzrlib.tests.test_sftp_transport',
2336
'bzrlib.tests.test_smart',
2337
'bzrlib.tests.test_smart_add',
2338
'bzrlib.tests.test_smart_transport',
2339
'bzrlib.tests.test_smtp_connection',
2340
'bzrlib.tests.test_source',
2341
'bzrlib.tests.test_ssh_transport',
2342
'bzrlib.tests.test_status',
2343
'bzrlib.tests.test_store',
2344
'bzrlib.tests.test_strace',
2345
'bzrlib.tests.test_subsume',
2346
'bzrlib.tests.test_symbol_versioning',
2347
'bzrlib.tests.test_tag',
2348
'bzrlib.tests.test_testament',
2349
'bzrlib.tests.test_textfile',
2350
'bzrlib.tests.test_textmerge',
2351
'bzrlib.tests.test_timestamp',
2352
'bzrlib.tests.test_trace',
2353
'bzrlib.tests.test_transactions',
2354
'bzrlib.tests.test_transform',
2355
'bzrlib.tests.test_transport',
2356
'bzrlib.tests.test_tree',
2357
'bzrlib.tests.test_treebuilder',
2358
'bzrlib.tests.test_tsort',
2359
'bzrlib.tests.test_tuned_gzip',
2360
'bzrlib.tests.test_ui',
2361
'bzrlib.tests.test_upgrade',
2362
'bzrlib.tests.test_urlutils',
2363
'bzrlib.tests.test_versionedfile',
2364
'bzrlib.tests.test_version',
2365
'bzrlib.tests.test_version_info',
2366
'bzrlib.tests.test_weave',
2367
'bzrlib.tests.test_whitebox',
2368
'bzrlib.tests.test_workingtree',
2369
'bzrlib.tests.test_workingtree_4',
2370
'bzrlib.tests.test_wsgi',
2371
'bzrlib.tests.test_xml',
2373
test_transport_implementations = [
2374
'bzrlib.tests.test_transport_implementations',
2375
'bzrlib.tests.test_read_bundle',
2377
suite = TestUtil.TestSuite()
2378
loader = TestUtil.TestLoader()
2379
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2380
from bzrlib.transport import TransportTestProviderAdapter
2381
adapter = TransportTestProviderAdapter()
2382
adapt_modules(test_transport_implementations, adapter, loader, suite)
2383
for package in packages_to_test():
2384
suite.addTest(package.test_suite())
2385
for m in MODULES_TO_TEST:
2386
suite.addTest(loader.loadTestsFromModule(m))
2387
for m in MODULES_TO_DOCTEST:
2389
suite.addTest(doctest.DocTestSuite(m))
2390
except ValueError, e:
2391
print '**failed to get doctest for: %s\n%s' %(m,e)
2393
for name, plugin in bzrlib.plugin.all_plugins().items():
2394
if getattr(plugin, 'test_suite', None) is not None:
2395
default_encoding = sys.getdefaultencoding()
2397
plugin_suite = plugin.test_suite()
2398
except ImportError, e:
2399
bzrlib.trace.warning(
2400
'Unable to test plugin "%s": %s', name, e)
2402
suite.addTest(plugin_suite)
2403
if default_encoding != sys.getdefaultencoding():
2404
bzrlib.trace.warning(
2405
'Plugin "%s" tried to reset default encoding to: %s', name,
2406
sys.getdefaultencoding())
2408
sys.setdefaultencoding(default_encoding)
2412
def adapt_modules(mods_list, adapter, loader, suite):
2413
"""Adapt the modules in mods_list using adapter and add to suite."""
2414
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2415
suite.addTests(adapter.adapt(test))
2418
def _rmtree_temp_dir(dirname):
2419
# If LANG=C we probably have created some bogus paths
2420
# which rmtree(unicode) will fail to delete
2421
# so make sure we are using rmtree(str) to delete everything
2422
# except on win32, where rmtree(str) will fail
2423
# since it doesn't have the property of byte-stream paths
2424
# (they are either ascii or mbcs)
2425
if sys.platform == 'win32':
2426
# make sure we are using the unicode win32 api
2427
dirname = unicode(dirname)
2429
dirname = dirname.encode(sys.getfilesystemencoding())
2431
osutils.rmtree(dirname)
2433
if sys.platform == 'win32' and e.errno == errno.EACCES:
2434
print >>sys.stderr, ('Permission denied: '
2435
'unable to remove testing dir '
2436
'%s' % os.path.basename(dirname))
2441
def clean_selftest_output(root=None, quiet=False):
2442
"""Remove all selftest output directories from root directory.
2444
:param root: root directory for clean
2445
(if ommitted or None then clean current directory).
2446
:param quiet: suppress report about deleting directories
2449
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
2452
for i in os.listdir(root):
2453
if os.path.isdir(i) and re_dir.match(i):
2455
print 'delete directory:', i
2459
class Feature(object):
2460
"""An operating system Feature."""
2463
self._available = None
2465
def available(self):
2466
"""Is the feature available?
2468
:return: True if the feature is available.
2470
if self._available is None:
2471
self._available = self._probe()
2472
return self._available
2475
"""Implement this method in concrete features.
2477
:return: True if the feature is available.
2479
raise NotImplementedError
2482
if getattr(self, 'feature_name', None):
2483
return self.feature_name()
2484
return self.__class__.__name__
added
removed
bzrlib/tests/__init__.py
