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 (
86
from bzrlib.transport import get_transport
87
import bzrlib.transport
88
from bzrlib.transport.local import LocalURLServer
89
from bzrlib.transport.memory import MemoryServer
90
from bzrlib.transport.readonly import ReadonlyServer
91
from bzrlib.trace import mutter, note
92
from bzrlib.tests import TestUtil
93
from bzrlib.tests.HttpServer import HttpServer
94
from bzrlib.tests.TestUtil import (
98
from bzrlib.tests.treeshape import build_tree_contents
99
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
101
# Mark this python module as being part of the implementation
102
# of unittest: this gives us better tracebacks where the last
103
# shown frame is the test code, not our assertXYZ.
106
default_transport = LocalURLServer
109
MODULES_TO_DOCTEST = [
122
def packages_to_test():
123
"""Return a list of packages to test.
125
The packages are not globally imported so that import failures are
126
triggered when running selftest, not when importing the command.
129
import bzrlib.tests.blackbox
130
import bzrlib.tests.branch_implementations
131
import bzrlib.tests.bzrdir_implementations
132
import bzrlib.tests.commands
133
import bzrlib.tests.interrepository_implementations
134
import bzrlib.tests.interversionedfile_implementations
135
import bzrlib.tests.intertree_implementations
136
import bzrlib.tests.per_lock
137
import bzrlib.tests.repository_implementations
138
import bzrlib.tests.revisionstore_implementations
139
import bzrlib.tests.tree_implementations
140
import bzrlib.tests.workingtree_implementations
143
bzrlib.tests.blackbox,
144
bzrlib.tests.branch_implementations,
145
bzrlib.tests.bzrdir_implementations,
146
bzrlib.tests.commands,
147
bzrlib.tests.interrepository_implementations,
148
bzrlib.tests.interversionedfile_implementations,
149
bzrlib.tests.intertree_implementations,
150
bzrlib.tests.per_lock,
151
bzrlib.tests.repository_implementations,
152
bzrlib.tests.revisionstore_implementations,
153
bzrlib.tests.tree_implementations,
154
bzrlib.tests.workingtree_implementations,
158
class ExtendedTestResult(unittest._TextTestResult):
159
"""Accepts, reports and accumulates the results of running tests.
161
Compared to this unittest version this class adds support for profiling,
162
benchmarking, stopping as soon as a test fails, and skipping tests.
163
There are further-specialized subclasses for different types of display.
168
def __init__(self, stream, descriptions, verbosity,
172
"""Construct new TestResult.
174
:param bench_history: Optionally, a writable file object to accumulate
177
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
178
if bench_history is not None:
179
from bzrlib.version import _get_bzr_source_tree
180
src_tree = _get_bzr_source_tree()
183
revision_id = src_tree.get_parent_ids()[0]
185
# XXX: if this is a brand new tree, do the same as if there
189
# XXX: If there's no branch, what should we do?
191
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
192
self._bench_history = bench_history
193
self.ui = ui.ui_factory
194
self.num_tests = num_tests
196
self.failure_count = 0
197
self.known_failure_count = 0
199
self.unsupported = {}
201
self._overall_start_time = time.time()
203
def extractBenchmarkTime(self, testCase):
204
"""Add a benchmark time for the current test case."""
205
self._benchmarkTime = getattr(testCase, "_benchtime", None)
207
def _elapsedTestTimeString(self):
208
"""Return a time string for the overall time the current test has taken."""
209
return self._formatTime(time.time() - self._start_time)
211
def _testTimeString(self):
212
if self._benchmarkTime is not None:
214
self._formatTime(self._benchmarkTime),
215
self._elapsedTestTimeString())
217
return " %s" % self._elapsedTestTimeString()
219
def _formatTime(self, seconds):
220
"""Format seconds as milliseconds with leading spaces."""
221
# some benchmarks can take thousands of seconds to run, so we need 8
223
return "%8dms" % (1000 * seconds)
225
def _shortened_test_description(self, test):
227
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
230
def startTest(self, test):
231
unittest.TestResult.startTest(self, test)
232
self.report_test_start(test)
233
test.number = self.count
234
self._recordTestStartTime()
236
def _recordTestStartTime(self):
237
"""Record that a test has started."""
238
self._start_time = time.time()
240
def _cleanupLogFile(self, test):
241
# We can only do this if we have one of our TestCases, not if
243
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
244
if setKeepLogfile is not None:
247
def addError(self, test, err):
248
self.extractBenchmarkTime(test)
249
self._cleanupLogFile(test)
250
if isinstance(err[1], TestSkipped):
251
return self.addSkipped(test, err)
252
elif isinstance(err[1], UnavailableFeature):
253
return self.addNotSupported(test, err[1].args[0])
254
unittest.TestResult.addError(self, test, err)
255
self.error_count += 1
256
self.report_error(test, err)
260
def addFailure(self, test, err):
261
self._cleanupLogFile(test)
262
self.extractBenchmarkTime(test)
263
if isinstance(err[1], KnownFailure):
264
return self.addKnownFailure(test, err)
265
unittest.TestResult.addFailure(self, test, err)
266
self.failure_count += 1
267
self.report_failure(test, err)
271
def addKnownFailure(self, test, err):
272
self.known_failure_count += 1
273
self.report_known_failure(test, err)
275
def addNotSupported(self, test, feature):
276
self.unsupported.setdefault(str(feature), 0)
277
self.unsupported[str(feature)] += 1
278
self.report_unsupported(test, feature)
280
def addSuccess(self, test):
281
self.extractBenchmarkTime(test)
282
if self._bench_history is not None:
283
if self._benchmarkTime is not None:
284
self._bench_history.write("%s %s\n" % (
285
self._formatTime(self._benchmarkTime),
287
self.report_success(test)
288
unittest.TestResult.addSuccess(self, test)
290
def addSkipped(self, test, skip_excinfo):
291
self.report_skip(test, skip_excinfo)
292
# seems best to treat this as success from point-of-view of unittest
293
# -- it actually does nothing so it barely matters :)
296
except KeyboardInterrupt:
299
self.addError(test, test.__exc_info())
301
unittest.TestResult.addSuccess(self, test)
303
def printErrorList(self, flavour, errors):
304
for test, err in errors:
305
self.stream.writeln(self.separator1)
306
self.stream.write("%s: " % flavour)
307
self.stream.writeln(self.getDescription(test))
308
if getattr(test, '_get_log', None) is not None:
310
print >>self.stream, \
311
('vvvv[log from %s]' % test.id()).ljust(78,'-')
312
print >>self.stream, test._get_log()
313
print >>self.stream, \
314
('^^^^[log from %s]' % test.id()).ljust(78,'-')
315
self.stream.writeln(self.separator2)
316
self.stream.writeln("%s" % err)
321
def report_cleaning_up(self):
324
def report_success(self, test):
327
def wasStrictlySuccessful(self):
328
if self.unsupported or self.known_failure_count:
331
return self.wasSuccessful()
335
class TextTestResult(ExtendedTestResult):
336
"""Displays progress and results of tests in text form"""
338
def __init__(self, stream, descriptions, verbosity,
343
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
344
bench_history, num_tests)
346
self.pb = self.ui.nested_progress_bar()
347
self._supplied_pb = False
350
self._supplied_pb = True
351
self.pb.show_pct = False
352
self.pb.show_spinner = False
353
self.pb.show_eta = False,
354
self.pb.show_count = False
355
self.pb.show_bar = False
357
def report_starting(self):
358
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
360
def _progress_prefix_text(self):
361
a = '[%d' % self.count
362
if self.num_tests is not None:
363
a +='/%d' % self.num_tests
364
a += ' in %ds' % (time.time() - self._overall_start_time)
366
a += ', %d errors' % self.error_count
367
if self.failure_count:
368
a += ', %d failed' % self.failure_count
369
if self.known_failure_count:
370
a += ', %d known failures' % self.known_failure_count
372
a += ', %d skipped' % self.skip_count
374
a += ', %d missing features' % len(self.unsupported)
378
def report_test_start(self, test):
381
self._progress_prefix_text()
383
+ self._shortened_test_description(test))
385
def _test_description(self, test):
386
return self._shortened_test_description(test)
388
def report_error(self, test, err):
389
self.pb.note('ERROR: %s\n %s\n',
390
self._test_description(test),
394
def report_failure(self, test, err):
395
self.pb.note('FAIL: %s\n %s\n',
396
self._test_description(test),
400
def report_known_failure(self, test, err):
401
self.pb.note('XFAIL: %s\n%s\n',
402
self._test_description(test), err[1])
404
def report_skip(self, test, skip_excinfo):
407
# at the moment these are mostly not things we can fix
408
# and so they just produce stipple; use the verbose reporter
411
# show test and reason for skip
412
self.pb.note('SKIP: %s\n %s\n',
413
self._shortened_test_description(test),
416
# since the class name was left behind in the still-visible
418
self.pb.note('SKIP: %s', skip_excinfo[1])
420
def report_unsupported(self, test, feature):
421
"""test cannot be run because feature is missing."""
423
def report_cleaning_up(self):
424
self.pb.update('cleaning up...')
427
if not self._supplied_pb:
431
class VerboseTestResult(ExtendedTestResult):
432
"""Produce long output, with one line per test run plus times"""
434
def _ellipsize_to_right(self, a_string, final_width):
435
"""Truncate and pad a string, keeping the right hand side"""
436
if len(a_string) > final_width:
437
result = '...' + a_string[3-final_width:]
440
return result.ljust(final_width)
442
def report_starting(self):
443
self.stream.write('running %d tests...\n' % self.num_tests)
445
def report_test_start(self, test):
447
name = self._shortened_test_description(test)
448
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
449
# numbers, plus a trailing blank
450
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
451
self.stream.write(self._ellipsize_to_right(name,
452
osutils.terminal_width()-30))
455
def _error_summary(self, err):
457
return '%s%s' % (indent, err[1])
459
def report_error(self, test, err):
460
self.stream.writeln('ERROR %s\n%s'
461
% (self._testTimeString(),
462
self._error_summary(err)))
464
def report_failure(self, test, err):
465
self.stream.writeln(' FAIL %s\n%s'
466
% (self._testTimeString(),
467
self._error_summary(err)))
469
def report_known_failure(self, test, err):
470
self.stream.writeln('XFAIL %s\n%s'
471
% (self._testTimeString(),
472
self._error_summary(err)))
474
def report_success(self, test):
475
self.stream.writeln(' OK %s' % self._testTimeString())
476
for bench_called, stats in getattr(test, '_benchcalls', []):
477
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
478
stats.pprint(file=self.stream)
479
# flush the stream so that we get smooth output. This verbose mode is
480
# used to show the output in PQM.
483
def report_skip(self, test, skip_excinfo):
485
self.stream.writeln(' SKIP %s\n%s'
486
% (self._testTimeString(),
487
self._error_summary(skip_excinfo)))
489
def report_unsupported(self, test, feature):
490
"""test cannot be run because feature is missing."""
491
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
492
%(self._testTimeString(), feature))
496
class TextTestRunner(object):
497
stop_on_failure = False
506
self.stream = unittest._WritelnDecorator(stream)
507
self.descriptions = descriptions
508
self.verbosity = verbosity
509
self._bench_history = bench_history
510
self.list_only = list_only
513
"Run the given test case or test suite."
514
startTime = time.time()
515
if self.verbosity == 1:
516
result_class = TextTestResult
517
elif self.verbosity >= 2:
518
result_class = VerboseTestResult
519
result = result_class(self.stream,
522
bench_history=self._bench_history,
523
num_tests=test.countTestCases(),
525
result.stop_early = self.stop_on_failure
526
result.report_starting()
528
if self.verbosity >= 2:
529
self.stream.writeln("Listing tests only ...\n")
531
for t in iter_suite_tests(test):
532
self.stream.writeln("%s" % (t.id()))
534
actionTaken = "Listed"
537
run = result.testsRun
539
stopTime = time.time()
540
timeTaken = stopTime - startTime
542
self.stream.writeln(result.separator2)
543
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
544
run, run != 1 and "s" or "", timeTaken))
545
self.stream.writeln()
546
if not result.wasSuccessful():
547
self.stream.write("FAILED (")
548
failed, errored = map(len, (result.failures, result.errors))
550
self.stream.write("failures=%d" % failed)
552
if failed: self.stream.write(", ")
553
self.stream.write("errors=%d" % errored)
554
if result.known_failure_count:
555
if failed or errored: self.stream.write(", ")
556
self.stream.write("known_failure_count=%d" %
557
result.known_failure_count)
558
self.stream.writeln(")")
560
if result.known_failure_count:
561
self.stream.writeln("OK (known_failures=%d)" %
562
result.known_failure_count)
564
self.stream.writeln("OK")
565
if result.skip_count > 0:
566
skipped = result.skip_count
567
self.stream.writeln('%d test%s skipped' %
568
(skipped, skipped != 1 and "s" or ""))
569
if result.unsupported:
570
for feature, count in sorted(result.unsupported.items()):
571
self.stream.writeln("Missing feature '%s' skipped %d tests." %
577
def iter_suite_tests(suite):
578
"""Return all tests in a suite, recursing through nested suites"""
579
for item in suite._tests:
580
if isinstance(item, unittest.TestCase):
582
elif isinstance(item, unittest.TestSuite):
583
for r in iter_suite_tests(item):
586
raise Exception('unknown object %r inside test suite %r'
590
class TestSkipped(Exception):
591
"""Indicates that a test was intentionally skipped, rather than failing."""
594
class KnownFailure(AssertionError):
595
"""Indicates that a test failed in a precisely expected manner.
597
Such failures dont block the whole test suite from passing because they are
598
indicators of partially completed code or of future work. We have an
599
explicit error for them so that we can ensure that they are always visible:
600
KnownFailures are always shown in the output of bzr selftest.
604
class UnavailableFeature(Exception):
605
"""A feature required for this test was not available.
607
The feature should be used to construct the exception.
611
class CommandFailed(Exception):
615
class StringIOWrapper(object):
616
"""A wrapper around cStringIO which just adds an encoding attribute.
618
Internally we can check sys.stdout to see what the output encoding
619
should be. However, cStringIO has no encoding attribute that we can
620
set. So we wrap it instead.
625
def __init__(self, s=None):
627
self.__dict__['_cstring'] = StringIO(s)
629
self.__dict__['_cstring'] = StringIO()
631
def __getattr__(self, name, getattr=getattr):
632
return getattr(self.__dict__['_cstring'], name)
634
def __setattr__(self, name, val):
635
if name == 'encoding':
636
self.__dict__['encoding'] = val
638
return setattr(self._cstring, name, val)
641
class TestUIFactory(ui.CLIUIFactory):
642
"""A UI Factory for testing.
644
Hide the progress bar but emit note()s.
646
Allows get_password to be tested without real tty attached.
653
super(TestUIFactory, self).__init__()
654
if stdin is not None:
655
# We use a StringIOWrapper to be able to test various
656
# encodings, but the user is still responsible to
657
# encode the string and to set the encoding attribute
658
# of StringIOWrapper.
659
self.stdin = StringIOWrapper(stdin)
661
self.stdout = sys.stdout
665
self.stderr = sys.stderr
670
"""See progress.ProgressBar.clear()."""
672
def clear_term(self):
673
"""See progress.ProgressBar.clear_term()."""
675
def clear_term(self):
676
"""See progress.ProgressBar.clear_term()."""
679
"""See progress.ProgressBar.finished()."""
681
def note(self, fmt_string, *args, **kwargs):
682
"""See progress.ProgressBar.note()."""
683
self.stdout.write((fmt_string + "\n") % args)
685
def progress_bar(self):
688
def nested_progress_bar(self):
691
def update(self, message, count=None, total=None):
692
"""See progress.ProgressBar.update()."""
694
def get_non_echoed_password(self, prompt):
695
"""Get password from stdin without trying to handle the echo mode"""
697
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
698
password = self.stdin.readline()
701
if password[-1] == '\n':
702
password = password[:-1]
706
class TestCase(unittest.TestCase):
707
"""Base class for bzr unit tests.
709
Tests that need access to disk resources should subclass
710
TestCaseInTempDir not TestCase.
712
Error and debug log messages are redirected from their usual
713
location into a temporary file, the contents of which can be
714
retrieved by _get_log(). We use a real OS file, not an in-memory object,
715
so that it can also capture file IO. When the test completes this file
716
is read into memory and removed from disk.
718
There are also convenience functions to invoke bzr's command-line
719
routine, and to build and check bzr trees.
721
In addition to the usual method of overriding tearDown(), this class also
722
allows subclasses to register functions into the _cleanups list, which is
723
run in order as the object is torn down. It's less likely this will be
724
accidentally overlooked.
727
_log_file_name = None
729
_keep_log_file = False
730
# record lsprof data when performing benchmark calls.
731
_gather_lsprof_in_benchmarks = False
733
def __init__(self, methodName='testMethod'):
734
super(TestCase, self).__init__(methodName)
738
unittest.TestCase.setUp(self)
739
self._cleanEnvironment()
740
bzrlib.trace.disable_default_logging()
743
self._benchcalls = []
744
self._benchtime = None
746
self._clear_debug_flags()
748
def _clear_debug_flags(self):
749
"""Prevent externally set debug flags affecting tests.
751
Tests that want to use debug flags can just set them in the
752
debug_flags set during setup/teardown.
754
self._preserved_debug_flags = set(debug.debug_flags)
755
debug.debug_flags.clear()
756
self.addCleanup(self._restore_debug_flags)
758
def _clear_hooks(self):
759
# prevent hooks affecting tests
761
import bzrlib.smart.server
762
self._preserved_hooks = {
763
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
764
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
766
self.addCleanup(self._restoreHooks)
767
# reset all hooks to an empty instance of the appropriate type
768
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
769
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
771
def _silenceUI(self):
772
"""Turn off UI for duration of test"""
773
# by default the UI is off; tests can turn it on if they want it.
774
saved = ui.ui_factory
776
ui.ui_factory = saved
777
ui.ui_factory = ui.SilentUIFactory()
778
self.addCleanup(_restore)
780
def _ndiff_strings(self, a, b):
781
"""Return ndiff between two strings containing lines.
783
A trailing newline is added if missing to make the strings
785
if b and b[-1] != '\n':
787
if a and a[-1] != '\n':
789
difflines = difflib.ndiff(a.splitlines(True),
791
linejunk=lambda x: False,
792
charjunk=lambda x: False)
793
return ''.join(difflines)
795
def assertEqual(self, a, b, message=''):
799
except UnicodeError, e:
800
# If we can't compare without getting a UnicodeError, then
801
# obviously they are different
802
mutter('UnicodeError: %s', e)
805
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
807
pformat(a), pformat(b)))
809
assertEquals = assertEqual
811
def assertEqualDiff(self, a, b, message=None):
812
"""Assert two texts are equal, if not raise an exception.
814
This is intended for use with multi-line strings where it can
815
be hard to find the differences by eye.
817
# TODO: perhaps override assertEquals to call this for strings?
821
message = "texts not equal:\n"
822
raise AssertionError(message +
823
self._ndiff_strings(a, b))
825
def assertEqualMode(self, mode, mode_test):
826
self.assertEqual(mode, mode_test,
827
'mode mismatch %o != %o' % (mode, mode_test))
829
def assertPositive(self, val):
830
"""Assert that val is greater than 0."""
831
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
833
def assertNegative(self, val):
834
"""Assert that val is less than 0."""
835
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
837
def assertStartsWith(self, s, prefix):
838
if not s.startswith(prefix):
839
raise AssertionError('string %r does not start with %r' % (s, prefix))
841
def assertEndsWith(self, s, suffix):
842
"""Asserts that s ends with suffix."""
843
if not s.endswith(suffix):
844
raise AssertionError('string %r does not end with %r' % (s, suffix))
846
def assertContainsRe(self, haystack, needle_re):
847
"""Assert that a contains something matching a regular expression."""
848
if not re.search(needle_re, haystack):
849
if '\n' in haystack or len(haystack) > 60:
850
# a long string, format it in a more readable way
851
raise AssertionError(
852
'pattern "%s" not found in\n"""\\\n%s"""\n'
853
% (needle_re, haystack))
855
raise AssertionError('pattern "%s" not found in "%s"'
856
% (needle_re, haystack))
858
def assertNotContainsRe(self, haystack, needle_re):
859
"""Assert that a does not match a regular expression"""
860
if re.search(needle_re, haystack):
861
raise AssertionError('pattern "%s" found in "%s"'
862
% (needle_re, haystack))
864
def assertSubset(self, sublist, superlist):
865
"""Assert that every entry in sublist is present in superlist."""
866
missing = set(sublist) - set(superlist)
868
raise AssertionError("value(s) %r not present in container %r" %
869
(missing, superlist))
871
def assertListRaises(self, excClass, func, *args, **kwargs):
872
"""Fail unless excClass is raised when the iterator from func is used.
874
Many functions can return generators this makes sure
875
to wrap them in a list() call to make sure the whole generator
876
is run, and that the proper exception is raised.
879
list(func(*args, **kwargs))
883
if getattr(excClass,'__name__', None) is not None:
884
excName = excClass.__name__
886
excName = str(excClass)
887
raise self.failureException, "%s not raised" % excName
889
def assertRaises(self, excClass, callableObj, *args, **kwargs):
890
"""Assert that a callable raises a particular exception.
892
:param excClass: As for the except statement, this may be either an
893
exception class, or a tuple of classes.
894
:param callableObj: A callable, will be passed ``*args`` and
897
Returns the exception so that you can examine it.
900
callableObj(*args, **kwargs)
904
if getattr(excClass,'__name__', None) is not None:
905
excName = excClass.__name__
908
excName = str(excClass)
909
raise self.failureException, "%s not raised" % excName
911
def assertIs(self, left, right, message=None):
912
if not (left is right):
913
if message is not None:
914
raise AssertionError(message)
916
raise AssertionError("%r is not %r." % (left, right))
918
def assertIsNot(self, left, right, message=None):
920
if message is not None:
921
raise AssertionError(message)
923
raise AssertionError("%r is %r." % (left, right))
925
def assertTransportMode(self, transport, path, mode):
926
"""Fail if a path does not have mode mode.
928
If modes are not supported on this transport, the assertion is ignored.
930
if not transport._can_roundtrip_unix_modebits():
932
path_stat = transport.stat(path)
933
actual_mode = stat.S_IMODE(path_stat.st_mode)
934
self.assertEqual(mode, actual_mode,
935
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
937
def assertIsInstance(self, obj, kls):
938
"""Fail if obj is not an instance of kls"""
939
if not isinstance(obj, kls):
940
self.fail("%r is an instance of %s rather than %s" % (
941
obj, obj.__class__, kls))
943
def expectFailure(self, reason, assertion, *args, **kwargs):
944
"""Invoke a test, expecting it to fail for the given reason.
946
This is for assertions that ought to succeed, but currently fail.
947
(The failure is *expected* but not *wanted*.) Please be very precise
948
about the failure you're expecting. If a new bug is introduced,
949
AssertionError should be raised, not KnownFailure.
951
Frequently, expectFailure should be followed by an opposite assertion.
954
Intended to be used with a callable that raises AssertionError as the
955
'assertion' parameter. args and kwargs are passed to the 'assertion'.
957
Raises KnownFailure if the test fails. Raises AssertionError if the
962
self.expectFailure('Math is broken', self.assertNotEqual, 54,
964
self.assertEqual(42, dynamic_val)
966
This means that a dynamic_val of 54 will cause the test to raise
967
a KnownFailure. Once math is fixed and the expectFailure is removed,
968
only a dynamic_val of 42 will allow the test to pass. Anything other
969
than 54 or 42 will cause an AssertionError.
972
assertion(*args, **kwargs)
973
except AssertionError:
974
raise KnownFailure(reason)
976
self.fail('Unexpected success. Should have failed: %s' % reason)
978
def _capture_warnings(self, a_callable, *args, **kwargs):
979
"""A helper for callDeprecated and applyDeprecated.
981
:param a_callable: A callable to call.
982
:param args: The positional arguments for the callable
983
:param kwargs: The keyword arguments for the callable
984
:return: A tuple (warnings, result). result is the result of calling
985
a_callable(``*args``, ``**kwargs``).
988
def capture_warnings(msg, cls=None, stacklevel=None):
989
# we've hooked into a deprecation specific callpath,
990
# only deprecations should getting sent via it.
991
self.assertEqual(cls, DeprecationWarning)
992
local_warnings.append(msg)
993
original_warning_method = symbol_versioning.warn
994
symbol_versioning.set_warning_method(capture_warnings)
996
result = a_callable(*args, **kwargs)
998
symbol_versioning.set_warning_method(original_warning_method)
999
return (local_warnings, result)
1001
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1002
"""Call a deprecated callable without warning the user.
1004
Note that this only captures warnings raised by symbol_versioning.warn,
1005
not other callers that go direct to the warning module.
1007
To test that a deprecated method raises an error, do something like
1010
self.assertRaises(errors.ReservedId,
1011
self.applyDeprecated, zero_ninetyone,
1012
br.append_revision, 'current:')
1014
:param deprecation_format: The deprecation format that the callable
1015
should have been deprecated with. This is the same type as the
1016
parameter to deprecated_method/deprecated_function. If the
1017
callable is not deprecated with this format, an assertion error
1019
:param a_callable: A callable to call. This may be a bound method or
1020
a regular function. It will be called with ``*args`` and
1022
:param args: The positional arguments for the callable
1023
:param kwargs: The keyword arguments for the callable
1024
:return: The result of a_callable(``*args``, ``**kwargs``)
1026
call_warnings, result = self._capture_warnings(a_callable,
1028
expected_first_warning = symbol_versioning.deprecation_string(
1029
a_callable, deprecation_format)
1030
if len(call_warnings) == 0:
1031
self.fail("No deprecation warning generated by call to %s" %
1033
self.assertEqual(expected_first_warning, call_warnings[0])
1036
def callDeprecated(self, expected, callable, *args, **kwargs):
1037
"""Assert that a callable is deprecated in a particular way.
1039
This is a very precise test for unusual requirements. The
1040
applyDeprecated helper function is probably more suited for most tests
1041
as it allows you to simply specify the deprecation format being used
1042
and will ensure that that is issued for the function being called.
1044
Note that this only captures warnings raised by symbol_versioning.warn,
1045
not other callers that go direct to the warning module.
1047
:param expected: a list of the deprecation warnings expected, in order
1048
:param callable: The callable to call
1049
:param args: The positional arguments for the callable
1050
:param kwargs: The keyword arguments for the callable
1052
call_warnings, result = self._capture_warnings(callable,
1054
self.assertEqual(expected, call_warnings)
1057
def _startLogFile(self):
1058
"""Send bzr and test log messages to a temporary file.
1060
The file is removed as the test is torn down.
1062
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1063
self._log_file = os.fdopen(fileno, 'w+')
1064
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1065
self._log_file_name = name
1066
self.addCleanup(self._finishLogFile)
1068
def _finishLogFile(self):
1069
"""Finished with the log file.
1071
Close the file and delete it, unless setKeepLogfile was called.
1073
if self._log_file is None:
1075
bzrlib.trace.disable_test_log(self._log_nonce)
1076
self._log_file.close()
1077
self._log_file = None
1078
if not self._keep_log_file:
1079
os.remove(self._log_file_name)
1080
self._log_file_name = None
1082
def setKeepLogfile(self):
1083
"""Make the logfile not be deleted when _finishLogFile is called."""
1084
self._keep_log_file = True
1086
def addCleanup(self, callable):
1087
"""Arrange to run a callable when this case is torn down.
1089
Callables are run in the reverse of the order they are registered,
1090
ie last-in first-out.
1092
if callable in self._cleanups:
1093
raise ValueError("cleanup function %r already registered on %s"
1095
self._cleanups.append(callable)
1097
def _cleanEnvironment(self):
1099
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1100
'HOME': os.getcwd(),
1101
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1103
'BZREMAIL': None, # may still be present in the environment
1105
'BZR_PROGRESS_BAR': None,
1107
'SSH_AUTH_SOCK': None,
1111
'https_proxy': None,
1112
'HTTPS_PROXY': None,
1117
# Nobody cares about these ones AFAIK. So far at
1118
# least. If you do (care), please update this comment
1122
'BZR_REMOTE_PATH': None,
1125
self.addCleanup(self._restoreEnvironment)
1126
for name, value in new_env.iteritems():
1127
self._captureVar(name, value)
1129
def _captureVar(self, name, newvalue):
1130
"""Set an environment variable, and reset it when finished."""
1131
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1133
def _restore_debug_flags(self):
1134
debug.debug_flags.clear()
1135
debug.debug_flags.update(self._preserved_debug_flags)
1137
def _restoreEnvironment(self):
1138
for name, value in self.__old_env.iteritems():
1139
osutils.set_or_unset_env(name, value)
1141
def _restoreHooks(self):
1142
for klass, hooks in self._preserved_hooks.items():
1143
setattr(klass, 'hooks', hooks)
1145
def knownFailure(self, reason):
1146
"""This test has failed for some known reason."""
1147
raise KnownFailure(reason)
1149
def run(self, result=None):
1150
if result is None: result = self.defaultTestResult()
1151
for feature in getattr(self, '_test_needs_features', []):
1152
if not feature.available():
1153
result.startTest(self)
1154
if getattr(result, 'addNotSupported', None):
1155
result.addNotSupported(self, feature)
1157
result.addSuccess(self)
1158
result.stopTest(self)
1160
return unittest.TestCase.run(self, result)
1164
unittest.TestCase.tearDown(self)
1166
def time(self, callable, *args, **kwargs):
1167
"""Run callable and accrue the time it takes to the benchmark time.
1169
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1170
this will cause lsprofile statistics to be gathered and stored in
1173
if self._benchtime is None:
1177
if not self._gather_lsprof_in_benchmarks:
1178
return callable(*args, **kwargs)
1180
# record this benchmark
1181
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1183
self._benchcalls.append(((callable, args, kwargs), stats))
1186
self._benchtime += time.time() - start
1188
def _runCleanups(self):
1189
"""Run registered cleanup functions.
1191
This should only be called from TestCase.tearDown.
1193
# TODO: Perhaps this should keep running cleanups even if
1194
# one of them fails?
1196
# Actually pop the cleanups from the list so tearDown running
1197
# twice is safe (this happens for skipped tests).
1198
while self._cleanups:
1199
self._cleanups.pop()()
1201
def log(self, *args):
1204
def _get_log(self, keep_log_file=False):
1205
"""Return as a string the log for this test. If the file is still
1206
on disk and keep_log_file=False, delete the log file and store the
1207
content in self._log_contents."""
1208
# flush the log file, to get all content
1210
bzrlib.trace._trace_file.flush()
1211
if self._log_contents:
1212
return self._log_contents
1213
if self._log_file_name is not None:
1214
logfile = open(self._log_file_name)
1216
log_contents = logfile.read()
1219
if not keep_log_file:
1220
self._log_contents = log_contents
1222
os.remove(self._log_file_name)
1224
if sys.platform == 'win32' and e.errno == errno.EACCES:
1225
print >>sys.stderr, ('Unable to delete log file '
1226
' %r' % self._log_file_name)
1231
return "DELETED log file to reduce memory footprint"
1233
@deprecated_method(zero_eighteen)
1234
def capture(self, cmd, retcode=0):
1235
"""Shortcut that splits cmd into words, runs, and returns stdout"""
1236
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
1238
def requireFeature(self, feature):
1239
"""This test requires a specific feature is available.
1241
:raises UnavailableFeature: When feature is not available.
1243
if not feature.available():
1244
raise UnavailableFeature(feature)
1246
@deprecated_method(zero_eighteen)
1247
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
1249
"""Invoke bzr and return (stdout, stderr).
1251
Don't call this method, just use run_bzr() which is equivalent.
1253
:param argv: Arguments to invoke bzr. This may be either a
1254
single string, in which case it is split by shlex into words,
1255
or a list of arguments.
1256
:param retcode: Expected return code, or None for don't-care.
1257
:param encoding: Encoding for sys.stdout and sys.stderr
1258
:param stdin: A string to be used as stdin for the command.
1259
:param working_dir: Change to this directory before running
1261
return self._run_bzr_autosplit(argv, retcode=retcode,
1262
encoding=encoding, stdin=stdin, working_dir=working_dir,
1265
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1267
"""Run bazaar command line, splitting up a string command line."""
1268
if isinstance(args, basestring):
1269
args = list(shlex.split(args))
1270
return self._run_bzr_core(args, retcode=retcode,
1271
encoding=encoding, stdin=stdin, working_dir=working_dir,
1274
def _run_bzr_core(self, args, retcode, encoding, stdin,
1276
if encoding is None:
1277
encoding = bzrlib.user_encoding
1278
stdout = StringIOWrapper()
1279
stderr = StringIOWrapper()
1280
stdout.encoding = encoding
1281
stderr.encoding = encoding
1283
self.log('run bzr: %r', args)
1284
# FIXME: don't call into logging here
1285
handler = logging.StreamHandler(stderr)
1286
handler.setLevel(logging.INFO)
1287
logger = logging.getLogger('')
1288
logger.addHandler(handler)
1289
old_ui_factory = ui.ui_factory
1290
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1293
if working_dir is not None:
1294
cwd = osutils.getcwd()
1295
os.chdir(working_dir)
1298
result = self.apply_redirected(ui.ui_factory.stdin,
1300
bzrlib.commands.run_bzr_catch_errors,
1303
logger.removeHandler(handler)
1304
ui.ui_factory = old_ui_factory
1308
out = stdout.getvalue()
1309
err = stderr.getvalue()
1311
self.log('output:\n%r', out)
1313
self.log('errors:\n%r', err)
1314
if retcode is not None:
1315
self.assertEquals(retcode, result,
1316
message='Unexpected return code')
1319
def run_bzr(self, *args, **kwargs):
1320
"""Invoke bzr, as if it were run from the command line.
1322
The argument list should not include the bzr program name - the
1323
first argument is normally the bzr command. Arguments may be
1324
passed in three ways:
1326
1- A list of strings, eg ["commit", "a"]. This is recommended
1327
when the command contains whitespace or metacharacters, or
1328
is built up at run time.
1330
2- A single string, eg "add a". This is the most convenient
1331
for hardcoded commands.
1333
3- Several varargs parameters, eg run_bzr("add", "a").
1334
This is not recommended for new code.
1336
This runs bzr through the interface that catches and reports
1337
errors, and with logging set to something approximating the
1338
default, so that error reporting can be checked.
1340
This should be the main method for tests that want to exercise the
1341
overall behavior of the bzr application (rather than a unit test
1342
or a functional test of the library.)
1344
This sends the stdout/stderr results into the test's log,
1345
where it may be useful for debugging. See also run_captured.
1347
:keyword stdin: A string to be used as stdin for the command.
1348
:keyword retcode: The status code the command should return;
1350
:keyword working_dir: The directory to run the command in
1351
:keyword error_regexes: A list of expected error messages. If
1352
specified they must be seen in the error output of the command.
1354
retcode = kwargs.pop('retcode', 0)
1355
encoding = kwargs.pop('encoding', None)
1356
stdin = kwargs.pop('stdin', None)
1357
working_dir = kwargs.pop('working_dir', None)
1358
error_regexes = kwargs.pop('error_regexes', [])
1361
raise TypeError("run_bzr() got unexpected keyword arguments '%s'"
1365
if isinstance(args[0], (list, basestring)):
1368
symbol_versioning.warn(zero_eighteen % "passing varargs to run_bzr",
1369
DeprecationWarning, stacklevel=3)
1371
out, err = self._run_bzr_autosplit(args=args,
1373
encoding=encoding, stdin=stdin, working_dir=working_dir,
1376
for regex in error_regexes:
1377
self.assertContainsRe(err, regex)
1380
def run_bzr_decode(self, *args, **kwargs):
1381
if 'encoding' in kwargs:
1382
encoding = kwargs['encoding']
1384
encoding = bzrlib.user_encoding
1385
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1387
def run_bzr_error(self, error_regexes, *args, **kwargs):
1388
"""Run bzr, and check that stderr contains the supplied regexes
1390
:param error_regexes: Sequence of regular expressions which
1391
must each be found in the error output. The relative ordering
1393
:param args: command-line arguments for bzr
1394
:param kwargs: Keyword arguments which are interpreted by run_bzr
1395
This function changes the default value of retcode to be 3,
1396
since in most cases this is run when you expect bzr to fail.
1398
:return: (out, err) The actual output of running the command (in case
1399
you want to do more inspection)
1403
# Make sure that commit is failing because there is nothing to do
1404
self.run_bzr_error(['no changes to commit'],
1405
['commit', '-m', 'my commit comment'])
1406
# Make sure --strict is handling an unknown file, rather than
1407
# giving us the 'nothing to do' error
1408
self.build_tree(['unknown'])
1409
self.run_bzr_error(['Commit refused because there are unknown files'],
1410
['commit', --strict', '-m', 'my commit comment'])
1412
kwargs.setdefault('retcode', 3)
1413
kwargs['error_regexes'] = error_regexes
1414
out, err = self.run_bzr(*args, **kwargs)
1417
def run_bzr_subprocess(self, *args, **kwargs):
1418
"""Run bzr in a subprocess for testing.
1420
This starts a new Python interpreter and runs bzr in there.
1421
This should only be used for tests that have a justifiable need for
1422
this isolation: e.g. they are testing startup time, or signal
1423
handling, or early startup code, etc. Subprocess code can't be
1424
profiled or debugged so easily.
1426
:keyword retcode: The status code that is expected. Defaults to 0. If
1427
None is supplied, the status code is not checked.
1428
:keyword env_changes: A dictionary which lists changes to environment
1429
variables. A value of None will unset the env variable.
1430
The values must be strings. The change will only occur in the
1431
child, so you don't need to fix the environment after running.
1432
:keyword universal_newlines: Convert CRLF => LF
1433
:keyword allow_plugins: By default the subprocess is run with
1434
--no-plugins to ensure test reproducibility. Also, it is possible
1435
for system-wide plugins to create unexpected output on stderr,
1436
which can cause unnecessary test failures.
1438
env_changes = kwargs.get('env_changes', {})
1439
working_dir = kwargs.get('working_dir', None)
1440
allow_plugins = kwargs.get('allow_plugins', False)
1442
if isinstance(args[0], list):
1444
elif isinstance(args[0], basestring):
1445
args = list(shlex.split(args[0]))
1447
symbol_versioning.warn(zero_ninetyone %
1448
"passing varargs to run_bzr_subprocess",
1449
DeprecationWarning, stacklevel=3)
1450
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1451
working_dir=working_dir,
1452
allow_plugins=allow_plugins)
1453
# We distinguish between retcode=None and retcode not passed.
1454
supplied_retcode = kwargs.get('retcode', 0)
1455
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1456
universal_newlines=kwargs.get('universal_newlines', False),
1459
def start_bzr_subprocess(self, process_args, env_changes=None,
1460
skip_if_plan_to_signal=False,
1462
allow_plugins=False):
1463
"""Start bzr in a subprocess for testing.
1465
This starts a new Python interpreter and runs bzr in there.
1466
This should only be used for tests that have a justifiable need for
1467
this isolation: e.g. they are testing startup time, or signal
1468
handling, or early startup code, etc. Subprocess code can't be
1469
profiled or debugged so easily.
1471
:param process_args: a list of arguments to pass to the bzr executable,
1472
for example ``['--version']``.
1473
:param env_changes: A dictionary which lists changes to environment
1474
variables. A value of None will unset the env variable.
1475
The values must be strings. The change will only occur in the
1476
child, so you don't need to fix the environment after running.
1477
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1479
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1481
:returns: Popen object for the started process.
1483
if skip_if_plan_to_signal:
1484
if not getattr(os, 'kill', None):
1485
raise TestSkipped("os.kill not available.")
1487
if env_changes is None:
1491
def cleanup_environment():
1492
for env_var, value in env_changes.iteritems():
1493
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1495
def restore_environment():
1496
for env_var, value in old_env.iteritems():
1497
osutils.set_or_unset_env(env_var, value)
1499
bzr_path = self.get_bzr_path()
1502
if working_dir is not None:
1503
cwd = osutils.getcwd()
1504
os.chdir(working_dir)
1507
# win32 subprocess doesn't support preexec_fn
1508
# so we will avoid using it on all platforms, just to
1509
# make sure the code path is used, and we don't break on win32
1510
cleanup_environment()
1511
command = [sys.executable, bzr_path]
1512
if not allow_plugins:
1513
command.append('--no-plugins')
1514
command.extend(process_args)
1515
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1517
restore_environment()
1523
def _popen(self, *args, **kwargs):
1524
"""Place a call to Popen.
1526
Allows tests to override this method to intercept the calls made to
1527
Popen for introspection.
1529
return Popen(*args, **kwargs)
1531
def get_bzr_path(self):
1532
"""Return the path of the 'bzr' executable for this test suite."""
1533
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1534
if not os.path.isfile(bzr_path):
1535
# We are probably installed. Assume sys.argv is the right file
1536
bzr_path = sys.argv[0]
1539
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1540
universal_newlines=False, process_args=None):
1541
"""Finish the execution of process.
1543
:param process: the Popen object returned from start_bzr_subprocess.
1544
:param retcode: The status code that is expected. Defaults to 0. If
1545
None is supplied, the status code is not checked.
1546
:param send_signal: an optional signal to send to the process.
1547
:param universal_newlines: Convert CRLF => LF
1548
:returns: (stdout, stderr)
1550
if send_signal is not None:
1551
os.kill(process.pid, send_signal)
1552
out, err = process.communicate()
1554
if universal_newlines:
1555
out = out.replace('\r\n', '\n')
1556
err = err.replace('\r\n', '\n')
1558
if retcode is not None and retcode != process.returncode:
1559
if process_args is None:
1560
process_args = "(unknown args)"
1561
mutter('Output of bzr %s:\n%s', process_args, out)
1562
mutter('Error for bzr %s:\n%s', process_args, err)
1563
self.fail('Command bzr %s failed with retcode %s != %s'
1564
% (process_args, retcode, process.returncode))
1567
def check_inventory_shape(self, inv, shape):
1568
"""Compare an inventory to a list of expected names.
1570
Fail if they are not precisely equal.
1573
shape = list(shape) # copy
1574
for path, ie in inv.entries():
1575
name = path.replace('\\', '/')
1576
if ie.kind == 'directory':
1583
self.fail("expected paths not found in inventory: %r" % shape)
1585
self.fail("unexpected paths found in inventory: %r" % extras)
1587
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1588
a_callable=None, *args, **kwargs):
1589
"""Call callable with redirected std io pipes.
1591
Returns the return code."""
1592
if not callable(a_callable):
1593
raise ValueError("a_callable must be callable.")
1595
stdin = StringIO("")
1597
if getattr(self, "_log_file", None) is not None:
1598
stdout = self._log_file
1602
if getattr(self, "_log_file", None is not None):
1603
stderr = self._log_file
1606
real_stdin = sys.stdin
1607
real_stdout = sys.stdout
1608
real_stderr = sys.stderr
1613
return a_callable(*args, **kwargs)
1615
sys.stdout = real_stdout
1616
sys.stderr = real_stderr
1617
sys.stdin = real_stdin
1619
def reduceLockdirTimeout(self):
1620
"""Reduce the default lock timeout for the duration of the test, so that
1621
if LockContention occurs during a test, it does so quickly.
1623
Tests that expect to provoke LockContention errors should call this.
1625
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1627
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1628
self.addCleanup(resetTimeout)
1629
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1632
class TestCaseWithMemoryTransport(TestCase):
1633
"""Common test class for tests that do not need disk resources.
1635
Tests that need disk resources should derive from TestCaseWithTransport.
1637
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1639
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1640
a directory which does not exist. This serves to help ensure test isolation
1641
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1642
must exist. However, TestCaseWithMemoryTransport does not offer local
1643
file defaults for the transport in tests, nor does it obey the command line
1644
override, so tests that accidentally write to the common directory should
1647
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1648
a .bzr directory that stops us ascending higher into the filesystem.
1654
def __init__(self, methodName='runTest'):
1655
# allow test parameterisation after test construction and before test
1656
# execution. Variables that the parameteriser sets need to be
1657
# ones that are not set by setUp, or setUp will trash them.
1658
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1659
self.vfs_transport_factory = default_transport
1660
self.transport_server = None
1661
self.transport_readonly_server = None
1662
self.__vfs_server = None
1664
def get_transport(self, relpath=None):
1665
"""Return a writeable transport.
1667
This transport is for the test scratch space relative to
1670
:param relpath: a path relative to the base url.
1672
t = get_transport(self.get_url(relpath))
1673
self.assertFalse(t.is_readonly())
1676
def get_readonly_transport(self, relpath=None):
1677
"""Return a readonly transport for the test scratch space
1679
This can be used to test that operations which should only need
1680
readonly access in fact do not try to write.
1682
:param relpath: a path relative to the base url.
1684
t = get_transport(self.get_readonly_url(relpath))
1685
self.assertTrue(t.is_readonly())
1688
def create_transport_readonly_server(self):
1689
"""Create a transport server from class defined at init.
1691
This is mostly a hook for daughter classes.
1693
return self.transport_readonly_server()
1695
def get_readonly_server(self):
1696
"""Get the server instance for the readonly transport
1698
This is useful for some tests with specific servers to do diagnostics.
1700
if self.__readonly_server is None:
1701
if self.transport_readonly_server is None:
1702
# readonly decorator requested
1703
# bring up the server
1704
self.__readonly_server = ReadonlyServer()
1705
self.__readonly_server.setUp(self.get_vfs_only_server())
1707
self.__readonly_server = self.create_transport_readonly_server()
1708
self.__readonly_server.setUp(self.get_vfs_only_server())
1709
self.addCleanup(self.__readonly_server.tearDown)
1710
return self.__readonly_server
1712
def get_readonly_url(self, relpath=None):
1713
"""Get a URL for the readonly transport.
1715
This will either be backed by '.' or a decorator to the transport
1716
used by self.get_url()
1717
relpath provides for clients to get a path relative to the base url.
1718
These should only be downwards relative, not upwards.
1720
base = self.get_readonly_server().get_url()
1721
return self._adjust_url(base, relpath)
1723
def get_vfs_only_server(self):
1724
"""Get the vfs only read/write server instance.
1726
This is useful for some tests with specific servers that need
1729
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1730
is no means to override it.
1732
if self.__vfs_server is None:
1733
self.__vfs_server = MemoryServer()
1734
self.__vfs_server.setUp()
1735
self.addCleanup(self.__vfs_server.tearDown)
1736
return self.__vfs_server
1738
def get_server(self):
1739
"""Get the read/write server instance.
1741
This is useful for some tests with specific servers that need
1744
This is built from the self.transport_server factory. If that is None,
1745
then the self.get_vfs_server is returned.
1747
if self.__server is None:
1748
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1749
return self.get_vfs_only_server()
1751
# bring up a decorated means of access to the vfs only server.
1752
self.__server = self.transport_server()
1754
self.__server.setUp(self.get_vfs_only_server())
1755
except TypeError, e:
1756
# This should never happen; the try:Except here is to assist
1757
# developers having to update code rather than seeing an
1758
# uninformative TypeError.
1759
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1760
self.addCleanup(self.__server.tearDown)
1761
return self.__server
1763
def _adjust_url(self, base, relpath):
1764
"""Get a URL (or maybe a path) for the readwrite transport.
1766
This will either be backed by '.' or to an equivalent non-file based
1768
relpath provides for clients to get a path relative to the base url.
1769
These should only be downwards relative, not upwards.
1771
if relpath is not None and relpath != '.':
1772
if not base.endswith('/'):
1774
# XXX: Really base should be a url; we did after all call
1775
# get_url()! But sometimes it's just a path (from
1776
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1777
# to a non-escaped local path.
1778
if base.startswith('./') or base.startswith('/'):
1781
base += urlutils.escape(relpath)
1784
def get_url(self, relpath=None):
1785
"""Get a URL (or maybe a path) for the readwrite transport.
1787
This will either be backed by '.' or to an equivalent non-file based
1789
relpath provides for clients to get a path relative to the base url.
1790
These should only be downwards relative, not upwards.
1792
base = self.get_server().get_url()
1793
return self._adjust_url(base, relpath)
1795
def get_vfs_only_url(self, relpath=None):
1796
"""Get a URL (or maybe a path for the plain old vfs transport.
1798
This will never be a smart protocol. It always has all the
1799
capabilities of the local filesystem, but it might actually be a
1800
MemoryTransport or some other similar virtual filesystem.
1802
This is the backing transport (if any) of the server returned by
1803
get_url and get_readonly_url.
1805
:param relpath: provides for clients to get a path relative to the base
1806
url. These should only be downwards relative, not upwards.
1809
base = self.get_vfs_only_server().get_url()
1810
return self._adjust_url(base, relpath)
1812
def _make_test_root(self):
1813
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1815
root = tempfile.mkdtemp(prefix='testbzr-', suffix='.tmp')
1816
TestCaseWithMemoryTransport.TEST_ROOT = root
1818
# make a fake bzr directory there to prevent any tests propagating
1819
# up onto the source directory's real branch
1820
bzrdir.BzrDir.create_standalone_workingtree(root)
1822
# The same directory is used by all tests, and we're not specifically
1823
# told when all tests are finished. This will do.
1824
atexit.register(_rmtree_temp_dir, root)
1826
def makeAndChdirToTestDir(self):
1827
"""Create a temporary directories for this one test.
1829
This must set self.test_home_dir and self.test_dir and chdir to
1832
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1834
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1835
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1836
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1838
def make_branch(self, relpath, format=None):
1839
"""Create a branch on the transport at relpath."""
1840
repo = self.make_repository(relpath, format=format)
1841
return repo.bzrdir.create_branch()
1843
def make_bzrdir(self, relpath, format=None):
1845
# might be a relative or absolute path
1846
maybe_a_url = self.get_url(relpath)
1847
segments = maybe_a_url.rsplit('/', 1)
1848
t = get_transport(maybe_a_url)
1849
if len(segments) > 1 and segments[-1] not in ('', '.'):
1853
if isinstance(format, basestring):
1854
format = bzrdir.format_registry.make_bzrdir(format)
1855
return format.initialize_on_transport(t)
1856
except errors.UninitializableFormat:
1857
raise TestSkipped("Format %s is not initializable." % format)
1859
def make_repository(self, relpath, shared=False, format=None):
1860
"""Create a repository on our default transport at relpath.
1862
Note that relpath must be a relative path, not a full url.
1864
# FIXME: If you create a remoterepository this returns the underlying
1865
# real format, which is incorrect. Actually we should make sure that
1866
# RemoteBzrDir returns a RemoteRepository.
1867
# maybe mbp 20070410
1868
made_control = self.make_bzrdir(relpath, format=format)
1869
return made_control.create_repository(shared=shared)
1871
def make_branch_and_memory_tree(self, relpath, format=None):
1872
"""Create a branch on the default transport and a MemoryTree for it."""
1873
b = self.make_branch(relpath, format=format)
1874
return memorytree.MemoryTree.create_on_branch(b)
1876
def overrideEnvironmentForTesting(self):
1877
os.environ['HOME'] = self.test_home_dir
1878
os.environ['BZR_HOME'] = self.test_home_dir
1881
super(TestCaseWithMemoryTransport, self).setUp()
1882
self._make_test_root()
1883
_currentdir = os.getcwdu()
1884
def _leaveDirectory():
1885
os.chdir(_currentdir)
1886
self.addCleanup(_leaveDirectory)
1887
self.makeAndChdirToTestDir()
1888
self.overrideEnvironmentForTesting()
1889
self.__readonly_server = None
1890
self.__server = None
1891
self.reduceLockdirTimeout()
1894
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1895
"""Derived class that runs a test within a temporary directory.
1897
This is useful for tests that need to create a branch, etc.
1899
The directory is created in a slightly complex way: for each
1900
Python invocation, a new temporary top-level directory is created.
1901
All test cases create their own directory within that. If the
1902
tests complete successfully, the directory is removed.
1904
:ivar test_base_dir: The path of the top-level directory for this
1905
test, which contains a home directory and a work directory.
1907
:ivar test_home_dir: An initially empty directory under test_base_dir
1908
which is used as $HOME for this test.
1910
:ivar test_dir: A directory under test_base_dir used as the current
1911
directory when the test proper is run.
1914
OVERRIDE_PYTHON = 'python'
1916
def check_file_contents(self, filename, expect):
1917
self.log("check contents of file %s" % filename)
1918
contents = file(filename, 'r').read()
1919
if contents != expect:
1920
self.log("expected: %r" % expect)
1921
self.log("actually: %r" % contents)
1922
self.fail("contents of %s not as expected" % filename)
1924
def makeAndChdirToTestDir(self):
1925
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1927
For TestCaseInTempDir we create a temporary directory based on the test
1928
name and then create two subdirs - test and home under it.
1930
# create a directory within the top level test directory
1931
candidate_dir = tempfile.mkdtemp(dir=self.TEST_ROOT)
1932
# now create test and home directories within this dir
1933
self.test_base_dir = candidate_dir
1934
self.test_home_dir = self.test_base_dir + '/home'
1935
os.mkdir(self.test_home_dir)
1936
self.test_dir = self.test_base_dir + '/work'
1937
os.mkdir(self.test_dir)
1938
os.chdir(self.test_dir)
1939
# put name of test inside
1940
f = file(self.test_base_dir + '/name', 'w')
1945
self.addCleanup(self.deleteTestDir)
1947
def deleteTestDir(self):
1948
os.chdir(self.TEST_ROOT)
1949
_rmtree_temp_dir(self.test_base_dir)
1951
def build_tree(self, shape, line_endings='binary', transport=None):
1952
"""Build a test tree according to a pattern.
1954
shape is a sequence of file specifications. If the final
1955
character is '/', a directory is created.
1957
This assumes that all the elements in the tree being built are new.
1959
This doesn't add anything to a branch.
1961
:param line_endings: Either 'binary' or 'native'
1962
in binary mode, exact contents are written in native mode, the
1963
line endings match the default platform endings.
1964
:param transport: A transport to write to, for building trees on VFS's.
1965
If the transport is readonly or None, "." is opened automatically.
1968
# It's OK to just create them using forward slashes on windows.
1969
if transport is None or transport.is_readonly():
1970
transport = get_transport(".")
1972
self.assert_(isinstance(name, basestring))
1974
transport.mkdir(urlutils.escape(name[:-1]))
1976
if line_endings == 'binary':
1978
elif line_endings == 'native':
1981
raise errors.BzrError(
1982
'Invalid line ending request %r' % line_endings)
1983
content = "contents of %s%s" % (name.encode('utf-8'), end)
1984
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1986
def build_tree_contents(self, shape):
1987
build_tree_contents(shape)
1989
def assertFileEqual(self, content, path):
1990
"""Fail if path does not contain 'content'."""
1991
self.failUnlessExists(path)
1992
f = file(path, 'rb')
1997
self.assertEqualDiff(content, s)
1999
def failUnlessExists(self, path):
2000
"""Fail unless path or paths, which may be abs or relative, exist."""
2001
if not isinstance(path, basestring):
2003
self.failUnlessExists(p)
2005
self.failUnless(osutils.lexists(path),path+" does not exist")
2007
def failIfExists(self, path):
2008
"""Fail if path or paths, which may be abs or relative, exist."""
2009
if not isinstance(path, basestring):
2011
self.failIfExists(p)
2013
self.failIf(osutils.lexists(path),path+" exists")
2015
def assertInWorkingTree(self,path,root_path='.',tree=None):
2016
"""Assert whether path or paths are in the WorkingTree"""
2018
tree = workingtree.WorkingTree.open(root_path)
2019
if not isinstance(path, basestring):
2021
self.assertInWorkingTree(p,tree=tree)
2023
self.assertIsNot(tree.path2id(path), None,
2024
path+' not in working tree.')
2026
def assertNotInWorkingTree(self,path,root_path='.',tree=None):
2027
"""Assert whether path or paths are not in the WorkingTree"""
2029
tree = workingtree.WorkingTree.open(root_path)
2030
if not isinstance(path, basestring):
2032
self.assertNotInWorkingTree(p,tree=tree)
2034
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2037
class TestCaseWithTransport(TestCaseInTempDir):
2038
"""A test case that provides get_url and get_readonly_url facilities.
2040
These back onto two transport servers, one for readonly access and one for
2043
If no explicit class is provided for readonly access, a
2044
ReadonlyTransportDecorator is used instead which allows the use of non disk
2045
based read write transports.
2047
If an explicit class is provided for readonly access, that server and the
2048
readwrite one must both define get_url() as resolving to os.getcwd().
2051
def get_vfs_only_server(self):
2052
"""See TestCaseWithMemoryTransport.
2054
This is useful for some tests with specific servers that need
2057
if self.__vfs_server is None:
2058
self.__vfs_server = self.vfs_transport_factory()
2059
self.__vfs_server.setUp()
2060
self.addCleanup(self.__vfs_server.tearDown)
2061
return self.__vfs_server
2063
def make_branch_and_tree(self, relpath, format=None):
2064
"""Create a branch on the transport and a tree locally.
2066
If the transport is not a LocalTransport, the Tree can't be created on
2067
the transport. In that case if the vfs_transport_factory is
2068
LocalURLServer the working tree is created in the local
2069
directory backing the transport, and the returned tree's branch and
2070
repository will also be accessed locally. Otherwise a lightweight
2071
checkout is created and returned.
2073
:param format: The BzrDirFormat.
2074
:returns: the WorkingTree.
2076
# TODO: always use the local disk path for the working tree,
2077
# this obviously requires a format that supports branch references
2078
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2080
b = self.make_branch(relpath, format=format)
2082
return b.bzrdir.create_workingtree()
2083
except errors.NotLocalUrl:
2084
# We can only make working trees locally at the moment. If the
2085
# transport can't support them, then we keep the non-disk-backed
2086
# branch and create a local checkout.
2087
if self.vfs_transport_factory is LocalURLServer:
2088
# the branch is colocated on disk, we cannot create a checkout.
2089
# hopefully callers will expect this.
2090
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2091
return local_controldir.create_workingtree()
2093
return b.create_checkout(relpath, lightweight=True)
2095
def assertIsDirectory(self, relpath, transport):
2096
"""Assert that relpath within transport is a directory.
2098
This may not be possible on all transports; in that case it propagates
2099
a TransportNotPossible.
2102
mode = transport.stat(relpath).st_mode
2103
except errors.NoSuchFile:
2104
self.fail("path %s is not a directory; no such file"
2106
if not stat.S_ISDIR(mode):
2107
self.fail("path %s is not a directory; has mode %#o"
2110
def assertTreesEqual(self, left, right):
2111
"""Check that left and right have the same content and properties."""
2112
# we use a tree delta to check for equality of the content, and we
2113
# manually check for equality of other things such as the parents list.
2114
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2115
differences = left.changes_from(right)
2116
self.assertFalse(differences.has_changed(),
2117
"Trees %r and %r are different: %r" % (left, right, differences))
2120
super(TestCaseWithTransport, self).setUp()
2121
self.__vfs_server = None
2124
class ChrootedTestCase(TestCaseWithTransport):
2125
"""A support class that provides readonly urls outside the local namespace.
2127
This is done by checking if self.transport_server is a MemoryServer. if it
2128
is then we are chrooted already, if it is not then an HttpServer is used
2131
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2132
be used without needed to redo it when a different
2133
subclass is in use ?
2137
super(ChrootedTestCase, self).setUp()
2138
if not self.vfs_transport_factory == MemoryServer:
2139
self.transport_readonly_server = HttpServer
2142
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2143
random_order=False):
2144
"""Create a test suite by filtering another one.
2146
:param suite: the source suite
2147
:param pattern: pattern that names must match
2148
:param exclude_pattern: pattern that names must not match, if any
2149
:param random_order: if True, tests in the new suite will be put in
2151
:returns: the newly created suite
2153
return sort_suite_by_re(suite, pattern, exclude_pattern,
2154
random_order, False)
2157
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2158
random_order=False, append_rest=True):
2159
"""Create a test suite by sorting another one.
2161
:param suite: the source suite
2162
:param pattern: pattern that names must match in order to go
2163
first in the new suite
2164
:param exclude_pattern: pattern that names must not match, if any
2165
:param random_order: if True, tests in the new suite will be put in
2167
:param append_rest: if False, pattern is a strict filter and not
2168
just an ordering directive
2169
:returns: the newly created suite
2173
filter_re = re.compile(pattern)
2174
if exclude_pattern is not None:
2175
exclude_re = re.compile(exclude_pattern)
2176
for test in iter_suite_tests(suite):
2178
if exclude_pattern is None or not exclude_re.search(test_id):
2179
if filter_re.search(test_id):
2184
random.shuffle(first)
2185
random.shuffle(second)
2186
return TestUtil.TestSuite(first + second)
2189
def run_suite(suite, name='test', verbose=False, pattern=".*",
2190
stop_on_failure=False,
2191
transport=None, lsprof_timed=None, bench_history=None,
2192
matching_tests_first=None,
2195
exclude_pattern=None,
2198
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2203
runner = TextTestRunner(stream=sys.stdout,
2205
verbosity=verbosity,
2206
bench_history=bench_history,
2207
list_only=list_only,
2209
runner.stop_on_failure=stop_on_failure
2210
# Initialise the random number generator and display the seed used.
2211
# We convert the seed to a long to make it reuseable across invocations.
2212
random_order = False
2213
if random_seed is not None:
2215
if random_seed == "now":
2216
random_seed = long(time.time())
2218
# Convert the seed to a long if we can
2220
random_seed = long(random_seed)
2223
runner.stream.writeln("Randomizing test order using seed %s\n" %
2225
random.seed(random_seed)
2226
# Customise the list of tests if requested
2227
if pattern != '.*' or exclude_pattern is not None or random_order:
2228
if matching_tests_first:
2229
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
2232
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
2234
result = runner.run(suite)
2237
return result.wasStrictlySuccessful()
2239
return result.wasSuccessful()
2242
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2244
test_suite_factory=None,
2247
matching_tests_first=None,
2250
exclude_pattern=None,
2253
"""Run the whole test suite under the enhanced runner"""
2254
# XXX: Very ugly way to do this...
2255
# Disable warning about old formats because we don't want it to disturb
2256
# any blackbox tests.
2257
from bzrlib import repository
2258
repository._deprecation_warning_done = True
2260
global default_transport
2261
if transport is None:
2262
transport = default_transport
2263
old_transport = default_transport
2264
default_transport = transport
2266
if test_suite_factory is None:
2267
suite = test_suite()
2269
suite = test_suite_factory()
2270
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2271
stop_on_failure=stop_on_failure,
2272
transport=transport,
2273
lsprof_timed=lsprof_timed,
2274
bench_history=bench_history,
2275
matching_tests_first=matching_tests_first,
2276
list_only=list_only,
2277
random_seed=random_seed,
2278
exclude_pattern=exclude_pattern,
2281
default_transport = old_transport
2285
"""Build and return TestSuite for the whole of bzrlib.
2287
This function can be replaced if you need to change the default test
2288
suite on a global basis, but it is not encouraged.
2291
'bzrlib.util.tests.test_bencode',
2292
'bzrlib.tests.test__dirstate_helpers',
2293
'bzrlib.tests.test_ancestry',
2294
'bzrlib.tests.test_annotate',
2295
'bzrlib.tests.test_api',
2296
'bzrlib.tests.test_atomicfile',
2297
'bzrlib.tests.test_bad_files',
2298
'bzrlib.tests.test_branch',
2299
'bzrlib.tests.test_branchbuilder',
2300
'bzrlib.tests.test_bugtracker',
2301
'bzrlib.tests.test_bundle',
2302
'bzrlib.tests.test_bzrdir',
2303
'bzrlib.tests.test_cache_utf8',
2304
'bzrlib.tests.test_commands',
2305
'bzrlib.tests.test_commit',
2306
'bzrlib.tests.test_commit_merge',
2307
'bzrlib.tests.test_config',
2308
'bzrlib.tests.test_conflicts',
2309
'bzrlib.tests.test_counted_lock',
2310
'bzrlib.tests.test_decorators',
2311
'bzrlib.tests.test_delta',
2312
'bzrlib.tests.test_deprecated_graph',
2313
'bzrlib.tests.test_diff',
2314
'bzrlib.tests.test_dirstate',
2315
'bzrlib.tests.test_email_message',
2316
'bzrlib.tests.test_errors',
2317
'bzrlib.tests.test_escaped_store',
2318
'bzrlib.tests.test_extract',
2319
'bzrlib.tests.test_fetch',
2320
'bzrlib.tests.test_ftp_transport',
2321
'bzrlib.tests.test_generate_docs',
2322
'bzrlib.tests.test_generate_ids',
2323
'bzrlib.tests.test_globbing',
2324
'bzrlib.tests.test_gpg',
2325
'bzrlib.tests.test_graph',
2326
'bzrlib.tests.test_hashcache',
2327
'bzrlib.tests.test_help',
2328
'bzrlib.tests.test_hooks',
2329
'bzrlib.tests.test_http',
2330
'bzrlib.tests.test_http_response',
2331
'bzrlib.tests.test_https_ca_bundle',
2332
'bzrlib.tests.test_identitymap',
2333
'bzrlib.tests.test_ignores',
2334
'bzrlib.tests.test_index',
2335
'bzrlib.tests.test_info',
2336
'bzrlib.tests.test_inv',
2337
'bzrlib.tests.test_knit',
2338
'bzrlib.tests.test_lazy_import',
2339
'bzrlib.tests.test_lazy_regex',
2340
'bzrlib.tests.test_lockdir',
2341
'bzrlib.tests.test_lockable_files',
2342
'bzrlib.tests.test_log',
2343
'bzrlib.tests.test_lsprof',
2344
'bzrlib.tests.test_memorytree',
2345
'bzrlib.tests.test_merge',
2346
'bzrlib.tests.test_merge3',
2347
'bzrlib.tests.test_merge_core',
2348
'bzrlib.tests.test_merge_directive',
2349
'bzrlib.tests.test_missing',
2350
'bzrlib.tests.test_msgeditor',
2351
'bzrlib.tests.test_multiparent',
2352
'bzrlib.tests.test_nonascii',
2353
'bzrlib.tests.test_options',
2354
'bzrlib.tests.test_osutils',
2355
'bzrlib.tests.test_osutils_encodings',
2356
'bzrlib.tests.test_pack',
2357
'bzrlib.tests.test_patch',
2358
'bzrlib.tests.test_patches',
2359
'bzrlib.tests.test_permissions',
2360
'bzrlib.tests.test_plugins',
2361
'bzrlib.tests.test_progress',
2362
'bzrlib.tests.test_reconcile',
2363
'bzrlib.tests.test_registry',
2364
'bzrlib.tests.test_remote',
2365
'bzrlib.tests.test_repository',
2366
'bzrlib.tests.test_revert',
2367
'bzrlib.tests.test_revision',
2368
'bzrlib.tests.test_revisionnamespaces',
2369
'bzrlib.tests.test_revisiontree',
2370
'bzrlib.tests.test_rio',
2371
'bzrlib.tests.test_sampler',
2372
'bzrlib.tests.test_selftest',
2373
'bzrlib.tests.test_setup',
2374
'bzrlib.tests.test_sftp_transport',
2375
'bzrlib.tests.test_smart',
2376
'bzrlib.tests.test_smart_add',
2377
'bzrlib.tests.test_smart_transport',
2378
'bzrlib.tests.test_smtp_connection',
2379
'bzrlib.tests.test_source',
2380
'bzrlib.tests.test_ssh_transport',
2381
'bzrlib.tests.test_status',
2382
'bzrlib.tests.test_store',
2383
'bzrlib.tests.test_strace',
2384
'bzrlib.tests.test_subsume',
2385
'bzrlib.tests.test_symbol_versioning',
2386
'bzrlib.tests.test_tag',
2387
'bzrlib.tests.test_testament',
2388
'bzrlib.tests.test_textfile',
2389
'bzrlib.tests.test_textmerge',
2390
'bzrlib.tests.test_timestamp',
2391
'bzrlib.tests.test_trace',
2392
'bzrlib.tests.test_transactions',
2393
'bzrlib.tests.test_transform',
2394
'bzrlib.tests.test_transport',
2395
'bzrlib.tests.test_tree',
2396
'bzrlib.tests.test_treebuilder',
2397
'bzrlib.tests.test_tsort',
2398
'bzrlib.tests.test_tuned_gzip',
2399
'bzrlib.tests.test_ui',
2400
'bzrlib.tests.test_upgrade',
2401
'bzrlib.tests.test_urlutils',
2402
'bzrlib.tests.test_versionedfile',
2403
'bzrlib.tests.test_version',
2404
'bzrlib.tests.test_version_info',
2405
'bzrlib.tests.test_weave',
2406
'bzrlib.tests.test_whitebox',
2407
'bzrlib.tests.test_win32utils',
2408
'bzrlib.tests.test_workingtree',
2409
'bzrlib.tests.test_workingtree_4',
2410
'bzrlib.tests.test_wsgi',
2411
'bzrlib.tests.test_xml',
2413
test_transport_implementations = [
2414
'bzrlib.tests.test_transport_implementations',
2415
'bzrlib.tests.test_read_bundle',
2417
suite = TestUtil.TestSuite()
2418
loader = TestUtil.TestLoader()
2419
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2420
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2421
adapter = TransportTestProviderAdapter()
2422
adapt_modules(test_transport_implementations, adapter, loader, suite)
2423
for package in packages_to_test():
2424
suite.addTest(package.test_suite())
2425
for m in MODULES_TO_TEST:
2426
suite.addTest(loader.loadTestsFromModule(m))
2427
for m in MODULES_TO_DOCTEST:
2429
suite.addTest(doctest.DocTestSuite(m))
2430
except ValueError, e:
2431
print '**failed to get doctest for: %s\n%s' %(m,e)
2433
for name, plugin in bzrlib.plugin.all_plugins().items():
2434
if getattr(plugin, 'test_suite', None) is not None:
2435
default_encoding = sys.getdefaultencoding()
2437
plugin_suite = plugin.test_suite()
2438
except ImportError, e:
2439
bzrlib.trace.warning(
2440
'Unable to test plugin "%s": %s', name, e)
2442
suite.addTest(plugin_suite)
2443
if default_encoding != sys.getdefaultencoding():
2444
bzrlib.trace.warning(
2445
'Plugin "%s" tried to reset default encoding to: %s', name,
2446
sys.getdefaultencoding())
2448
sys.setdefaultencoding(default_encoding)
2452
def adapt_modules(mods_list, adapter, loader, suite):
2453
"""Adapt the modules in mods_list using adapter and add to suite."""
2454
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2455
suite.addTests(adapter.adapt(test))
2458
def _rmtree_temp_dir(dirname):
2459
# If LANG=C we probably have created some bogus paths
2460
# which rmtree(unicode) will fail to delete
2461
# so make sure we are using rmtree(str) to delete everything
2462
# except on win32, where rmtree(str) will fail
2463
# since it doesn't have the property of byte-stream paths
2464
# (they are either ascii or mbcs)
2465
if sys.platform == 'win32':
2466
# make sure we are using the unicode win32 api
2467
dirname = unicode(dirname)
2469
dirname = dirname.encode(sys.getfilesystemencoding())
2471
osutils.rmtree(dirname)
2473
if sys.platform == 'win32' and e.errno == errno.EACCES:
2474
print >>sys.stderr, ('Permission denied: '
2475
'unable to remove testing dir '
2476
'%s' % os.path.basename(dirname))
2481
class Feature(object):
2482
"""An operating system Feature."""
2485
self._available = None
2487
def available(self):
2488
"""Is the feature available?
2490
:return: True if the feature is available.
2492
if self._available is None:
2493
self._available = self._probe()
2494
return self._available
2497
"""Implement this method in concrete features.
2499
:return: True if the feature is available.
2501
raise NotImplementedError
2504
if getattr(self, 'feature_name', None):
2505
return self.feature_name()
2506
return self.__class__.__name__
2509
class TestScenarioApplier(object):
2510
"""A tool to apply scenarios to tests."""
2512
def adapt(self, test):
2513
"""Return a TestSuite containing a copy of test for each scenario."""
2514
result = unittest.TestSuite()
2515
for scenario in self.scenarios:
2516
result.addTest(self.adapt_test_to_scenario(test, scenario))
2519
def adapt_test_to_scenario(self, test, scenario):
2520
"""Copy test and apply scenario to it.
2522
:param test: A test to adapt.
2523
:param scenario: A tuple describing the scenarion.
2524
The first element of the tuple is the new test id.
2525
The second element is a dict containing attributes to set on the
2527
:return: The adapted test.
2529
from copy import deepcopy
2530
new_test = deepcopy(test)
2531
for name, value in scenario[1].items():
2532
setattr(new_test, name, value)
2533
new_id = "%s(%s)" % (new_test.id(), scenario[0])
2534
new_test.id = lambda: new_id
added
removed
bzrlib/tests/__init__.py
