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."""
867
for entry in sublist:
868
if entry not in superlist:
869
missing.append(entry)
871
raise AssertionError("value(s) %r not present in container %r" %
872
(missing, superlist))
874
def assertListRaises(self, excClass, func, *args, **kwargs):
875
"""Fail unless excClass is raised when the iterator from func is used.
877
Many functions can return generators this makes sure
878
to wrap them in a list() call to make sure the whole generator
879
is run, and that the proper exception is raised.
882
list(func(*args, **kwargs))
886
if getattr(excClass,'__name__', None) is not None:
887
excName = excClass.__name__
889
excName = str(excClass)
890
raise self.failureException, "%s not raised" % excName
892
def assertRaises(self, excClass, callableObj, *args, **kwargs):
893
"""Assert that a callable raises a particular exception.
895
:param excClass: As for the except statement, this may be either an
896
exception class, or a tuple of classes.
897
:param callableObj: A callable, will be passed ``*args`` and
900
Returns the exception so that you can examine it.
903
callableObj(*args, **kwargs)
907
if getattr(excClass,'__name__', None) is not None:
908
excName = excClass.__name__
911
excName = str(excClass)
912
raise self.failureException, "%s not raised" % excName
914
def assertIs(self, left, right, message=None):
915
if not (left is right):
916
if message is not None:
917
raise AssertionError(message)
919
raise AssertionError("%r is not %r." % (left, right))
921
def assertIsNot(self, left, right, message=None):
923
if message is not None:
924
raise AssertionError(message)
926
raise AssertionError("%r is %r." % (left, right))
928
def assertTransportMode(self, transport, path, mode):
929
"""Fail if a path does not have mode mode.
931
If modes are not supported on this transport, the assertion is ignored.
933
if not transport._can_roundtrip_unix_modebits():
935
path_stat = transport.stat(path)
936
actual_mode = stat.S_IMODE(path_stat.st_mode)
937
self.assertEqual(mode, actual_mode,
938
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
940
def assertIsInstance(self, obj, kls):
941
"""Fail if obj is not an instance of kls"""
942
if not isinstance(obj, kls):
943
self.fail("%r is an instance of %s rather than %s" % (
944
obj, obj.__class__, kls))
946
def expectFailure(self, reason, assertion, *args, **kwargs):
947
"""Invoke a test, expecting it to fail for the given reason.
949
This is for assertions that ought to succeed, but currently fail.
950
(The failure is *expected* but not *wanted*.) Please be very precise
951
about the failure you're expecting. If a new bug is introduced,
952
AssertionError should be raised, not KnownFailure.
954
Frequently, expectFailure should be followed by an opposite assertion.
957
Intended to be used with a callable that raises AssertionError as the
958
'assertion' parameter. args and kwargs are passed to the 'assertion'.
960
Raises KnownFailure if the test fails. Raises AssertionError if the
965
self.expectFailure('Math is broken', self.assertNotEqual, 54,
967
self.assertEqual(42, dynamic_val)
969
This means that a dynamic_val of 54 will cause the test to raise
970
a KnownFailure. Once math is fixed and the expectFailure is removed,
971
only a dynamic_val of 42 will allow the test to pass. Anything other
972
than 54 or 42 will cause an AssertionError.
975
assertion(*args, **kwargs)
976
except AssertionError:
977
raise KnownFailure(reason)
979
self.fail('Unexpected success. Should have failed: %s' % reason)
981
def _capture_warnings(self, a_callable, *args, **kwargs):
982
"""A helper for callDeprecated and applyDeprecated.
984
:param a_callable: A callable to call.
985
:param args: The positional arguments for the callable
986
:param kwargs: The keyword arguments for the callable
987
:return: A tuple (warnings, result). result is the result of calling
988
a_callable(``*args``, ``**kwargs``).
991
def capture_warnings(msg, cls=None, stacklevel=None):
992
# we've hooked into a deprecation specific callpath,
993
# only deprecations should getting sent via it.
994
self.assertEqual(cls, DeprecationWarning)
995
local_warnings.append(msg)
996
original_warning_method = symbol_versioning.warn
997
symbol_versioning.set_warning_method(capture_warnings)
999
result = a_callable(*args, **kwargs)
1001
symbol_versioning.set_warning_method(original_warning_method)
1002
return (local_warnings, result)
1004
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1005
"""Call a deprecated callable without warning the user.
1007
Note that this only captures warnings raised by symbol_versioning.warn,
1008
not other callers that go direct to the warning module.
1010
:param deprecation_format: The deprecation format that the callable
1011
should have been deprecated with. This is the same type as the
1012
parameter to deprecated_method/deprecated_function. If the
1013
callable is not deprecated with this format, an assertion error
1015
:param a_callable: A callable to call. This may be a bound method or
1016
a regular function. It will be called with ``*args`` and
1018
:param args: The positional arguments for the callable
1019
:param kwargs: The keyword arguments for the callable
1020
:return: The result of a_callable(``*args``, ``**kwargs``)
1022
call_warnings, result = self._capture_warnings(a_callable,
1024
expected_first_warning = symbol_versioning.deprecation_string(
1025
a_callable, deprecation_format)
1026
if len(call_warnings) == 0:
1027
self.fail("No deprecation warning generated by call to %s" %
1029
self.assertEqual(expected_first_warning, call_warnings[0])
1032
def callDeprecated(self, expected, callable, *args, **kwargs):
1033
"""Assert that a callable is deprecated in a particular way.
1035
This is a very precise test for unusual requirements. The
1036
applyDeprecated helper function is probably more suited for most tests
1037
as it allows you to simply specify the deprecation format being used
1038
and will ensure that that is issued for the function being called.
1040
Note that this only captures warnings raised by symbol_versioning.warn,
1041
not other callers that go direct to the warning module.
1043
:param expected: a list of the deprecation warnings expected, in order
1044
:param callable: The callable to call
1045
:param args: The positional arguments for the callable
1046
:param kwargs: The keyword arguments for the callable
1048
call_warnings, result = self._capture_warnings(callable,
1050
self.assertEqual(expected, call_warnings)
1053
def _startLogFile(self):
1054
"""Send bzr and test log messages to a temporary file.
1056
The file is removed as the test is torn down.
1058
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1059
self._log_file = os.fdopen(fileno, 'w+')
1060
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1061
self._log_file_name = name
1062
self.addCleanup(self._finishLogFile)
1064
def _finishLogFile(self):
1065
"""Finished with the log file.
1067
Close the file and delete it, unless setKeepLogfile was called.
1069
if self._log_file is None:
1071
bzrlib.trace.disable_test_log(self._log_nonce)
1072
self._log_file.close()
1073
self._log_file = None
1074
if not self._keep_log_file:
1075
os.remove(self._log_file_name)
1076
self._log_file_name = None
1078
def setKeepLogfile(self):
1079
"""Make the logfile not be deleted when _finishLogFile is called."""
1080
self._keep_log_file = True
1082
def addCleanup(self, callable):
1083
"""Arrange to run a callable when this case is torn down.
1085
Callables are run in the reverse of the order they are registered,
1086
ie last-in first-out.
1088
if callable in self._cleanups:
1089
raise ValueError("cleanup function %r already registered on %s"
1091
self._cleanups.append(callable)
1093
def _cleanEnvironment(self):
1095
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1096
'HOME': os.getcwd(),
1097
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1099
'BZREMAIL': None, # may still be present in the environment
1101
'BZR_PROGRESS_BAR': None,
1103
'SSH_AUTH_SOCK': None,
1107
'https_proxy': None,
1108
'HTTPS_PROXY': None,
1113
# Nobody cares about these ones AFAIK. So far at
1114
# least. If you do (care), please update this comment
1118
'BZR_REMOTE_PATH': None,
1121
self.addCleanup(self._restoreEnvironment)
1122
for name, value in new_env.iteritems():
1123
self._captureVar(name, value)
1125
def _captureVar(self, name, newvalue):
1126
"""Set an environment variable, and reset it when finished."""
1127
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1129
def _restore_debug_flags(self):
1130
debug.debug_flags.clear()
1131
debug.debug_flags.update(self._preserved_debug_flags)
1133
def _restoreEnvironment(self):
1134
for name, value in self.__old_env.iteritems():
1135
osutils.set_or_unset_env(name, value)
1137
def _restoreHooks(self):
1138
for klass, hooks in self._preserved_hooks.items():
1139
setattr(klass, 'hooks', hooks)
1141
def knownFailure(self, reason):
1142
"""This test has failed for some known reason."""
1143
raise KnownFailure(reason)
1145
def run(self, result=None):
1146
if result is None: result = self.defaultTestResult()
1147
for feature in getattr(self, '_test_needs_features', []):
1148
if not feature.available():
1149
result.startTest(self)
1150
if getattr(result, 'addNotSupported', None):
1151
result.addNotSupported(self, feature)
1153
result.addSuccess(self)
1154
result.stopTest(self)
1156
return unittest.TestCase.run(self, result)
1160
unittest.TestCase.tearDown(self)
1162
def time(self, callable, *args, **kwargs):
1163
"""Run callable and accrue the time it takes to the benchmark time.
1165
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1166
this will cause lsprofile statistics to be gathered and stored in
1169
if self._benchtime is None:
1173
if not self._gather_lsprof_in_benchmarks:
1174
return callable(*args, **kwargs)
1176
# record this benchmark
1177
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1179
self._benchcalls.append(((callable, args, kwargs), stats))
1182
self._benchtime += time.time() - start
1184
def _runCleanups(self):
1185
"""Run registered cleanup functions.
1187
This should only be called from TestCase.tearDown.
1189
# TODO: Perhaps this should keep running cleanups even if
1190
# one of them fails?
1192
# Actually pop the cleanups from the list so tearDown running
1193
# twice is safe (this happens for skipped tests).
1194
while self._cleanups:
1195
self._cleanups.pop()()
1197
def log(self, *args):
1200
def _get_log(self, keep_log_file=False):
1201
"""Return as a string the log for this test. If the file is still
1202
on disk and keep_log_file=False, delete the log file and store the
1203
content in self._log_contents."""
1204
# flush the log file, to get all content
1206
bzrlib.trace._trace_file.flush()
1207
if self._log_contents:
1208
return self._log_contents
1209
if self._log_file_name is not None:
1210
logfile = open(self._log_file_name)
1212
log_contents = logfile.read()
1215
if not keep_log_file:
1216
self._log_contents = log_contents
1218
os.remove(self._log_file_name)
1220
if sys.platform == 'win32' and e.errno == errno.EACCES:
1221
print >>sys.stderr, ('Unable to delete log file '
1222
' %r' % self._log_file_name)
1227
return "DELETED log file to reduce memory footprint"
1229
@deprecated_method(zero_eighteen)
1230
def capture(self, cmd, retcode=0):
1231
"""Shortcut that splits cmd into words, runs, and returns stdout"""
1232
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
1234
def requireFeature(self, feature):
1235
"""This test requires a specific feature is available.
1237
:raises UnavailableFeature: When feature is not available.
1239
if not feature.available():
1240
raise UnavailableFeature(feature)
1242
@deprecated_method(zero_eighteen)
1243
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
1245
"""Invoke bzr and return (stdout, stderr).
1247
Don't call this method, just use run_bzr() which is equivalent.
1249
:param argv: Arguments to invoke bzr. This may be either a
1250
single string, in which case it is split by shlex into words,
1251
or a list of arguments.
1252
:param retcode: Expected return code, or None for don't-care.
1253
:param encoding: Encoding for sys.stdout and sys.stderr
1254
:param stdin: A string to be used as stdin for the command.
1255
:param working_dir: Change to this directory before running
1257
return self._run_bzr_autosplit(argv, retcode=retcode,
1258
encoding=encoding, stdin=stdin, working_dir=working_dir,
1261
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1263
"""Run bazaar command line, splitting up a string command line."""
1264
if isinstance(args, basestring):
1265
args = list(shlex.split(args))
1266
return self._run_bzr_core(args, retcode=retcode,
1267
encoding=encoding, stdin=stdin, working_dir=working_dir,
1270
def _run_bzr_core(self, args, retcode, encoding, stdin,
1272
if encoding is None:
1273
encoding = bzrlib.user_encoding
1274
stdout = StringIOWrapper()
1275
stderr = StringIOWrapper()
1276
stdout.encoding = encoding
1277
stderr.encoding = encoding
1279
self.log('run bzr: %r', args)
1280
# FIXME: don't call into logging here
1281
handler = logging.StreamHandler(stderr)
1282
handler.setLevel(logging.INFO)
1283
logger = logging.getLogger('')
1284
logger.addHandler(handler)
1285
old_ui_factory = ui.ui_factory
1286
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1289
if working_dir is not None:
1290
cwd = osutils.getcwd()
1291
os.chdir(working_dir)
1294
result = self.apply_redirected(ui.ui_factory.stdin,
1296
bzrlib.commands.run_bzr_catch_errors,
1299
logger.removeHandler(handler)
1300
ui.ui_factory = old_ui_factory
1304
out = stdout.getvalue()
1305
err = stderr.getvalue()
1307
self.log('output:\n%r', out)
1309
self.log('errors:\n%r', err)
1310
if retcode is not None:
1311
self.assertEquals(retcode, result,
1312
message='Unexpected return code')
1315
def run_bzr(self, *args, **kwargs):
1316
"""Invoke bzr, as if it were run from the command line.
1318
The argument list should not include the bzr program name - the
1319
first argument is normally the bzr command. Arguments may be
1320
passed in three ways:
1322
1- A list of strings, eg ["commit", "a"]. This is recommended
1323
when the command contains whitespace or metacharacters, or
1324
is built up at run time.
1326
2- A single string, eg "add a". This is the most convenient
1327
for hardcoded commands.
1329
3- Several varargs parameters, eg run_bzr("add", "a").
1330
This is not recommended for new code.
1332
This runs bzr through the interface that catches and reports
1333
errors, and with logging set to something approximating the
1334
default, so that error reporting can be checked.
1336
This should be the main method for tests that want to exercise the
1337
overall behavior of the bzr application (rather than a unit test
1338
or a functional test of the library.)
1340
This sends the stdout/stderr results into the test's log,
1341
where it may be useful for debugging. See also run_captured.
1343
:keyword stdin: A string to be used as stdin for the command.
1344
:keyword retcode: The status code the command should return;
1346
:keyword working_dir: The directory to run the command in
1347
:keyword error_regexes: A list of expected error messages. If
1348
specified they must be seen in the error output of the command.
1350
retcode = kwargs.pop('retcode', 0)
1351
encoding = kwargs.pop('encoding', None)
1352
stdin = kwargs.pop('stdin', None)
1353
working_dir = kwargs.pop('working_dir', None)
1354
error_regexes = kwargs.pop('error_regexes', [])
1357
raise TypeError("run_bzr() got unexpected keyword arguments '%s'"
1361
if isinstance(args[0], (list, basestring)):
1364
symbol_versioning.warn(zero_eighteen % "passing varargs to run_bzr",
1365
DeprecationWarning, stacklevel=3)
1367
out, err = self._run_bzr_autosplit(args=args,
1369
encoding=encoding, stdin=stdin, working_dir=working_dir,
1372
for regex in error_regexes:
1373
self.assertContainsRe(err, regex)
1376
def run_bzr_decode(self, *args, **kwargs):
1377
if 'encoding' in kwargs:
1378
encoding = kwargs['encoding']
1380
encoding = bzrlib.user_encoding
1381
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1383
def run_bzr_error(self, error_regexes, *args, **kwargs):
1384
"""Run bzr, and check that stderr contains the supplied regexes
1386
:param error_regexes: Sequence of regular expressions which
1387
must each be found in the error output. The relative ordering
1389
:param args: command-line arguments for bzr
1390
:param kwargs: Keyword arguments which are interpreted by run_bzr
1391
This function changes the default value of retcode to be 3,
1392
since in most cases this is run when you expect bzr to fail.
1394
:return: (out, err) The actual output of running the command (in case
1395
you want to do more inspection)
1399
# Make sure that commit is failing because there is nothing to do
1400
self.run_bzr_error(['no changes to commit'],
1401
['commit', '-m', 'my commit comment'])
1402
# Make sure --strict is handling an unknown file, rather than
1403
# giving us the 'nothing to do' error
1404
self.build_tree(['unknown'])
1405
self.run_bzr_error(['Commit refused because there are unknown files'],
1406
['commit', --strict', '-m', 'my commit comment'])
1408
kwargs.setdefault('retcode', 3)
1409
kwargs['error_regexes'] = error_regexes
1410
out, err = self.run_bzr(*args, **kwargs)
1413
def run_bzr_subprocess(self, *args, **kwargs):
1414
"""Run bzr in a subprocess for testing.
1416
This starts a new Python interpreter and runs bzr in there.
1417
This should only be used for tests that have a justifiable need for
1418
this isolation: e.g. they are testing startup time, or signal
1419
handling, or early startup code, etc. Subprocess code can't be
1420
profiled or debugged so easily.
1422
:keyword retcode: The status code that is expected. Defaults to 0. If
1423
None is supplied, the status code is not checked.
1424
:keyword env_changes: A dictionary which lists changes to environment
1425
variables. A value of None will unset the env variable.
1426
The values must be strings. The change will only occur in the
1427
child, so you don't need to fix the environment after running.
1428
:keyword universal_newlines: Convert CRLF => LF
1429
:keyword allow_plugins: By default the subprocess is run with
1430
--no-plugins to ensure test reproducibility. Also, it is possible
1431
for system-wide plugins to create unexpected output on stderr,
1432
which can cause unnecessary test failures.
1434
env_changes = kwargs.get('env_changes', {})
1435
working_dir = kwargs.get('working_dir', None)
1436
allow_plugins = kwargs.get('allow_plugins', False)
1438
if isinstance(args[0], list):
1440
elif isinstance(args[0], basestring):
1441
args = list(shlex.split(args[0]))
1443
symbol_versioning.warn(zero_ninetyone %
1444
"passing varargs to run_bzr_subprocess",
1445
DeprecationWarning, stacklevel=3)
1446
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1447
working_dir=working_dir,
1448
allow_plugins=allow_plugins)
1449
# We distinguish between retcode=None and retcode not passed.
1450
supplied_retcode = kwargs.get('retcode', 0)
1451
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1452
universal_newlines=kwargs.get('universal_newlines', False),
1455
def start_bzr_subprocess(self, process_args, env_changes=None,
1456
skip_if_plan_to_signal=False,
1458
allow_plugins=False):
1459
"""Start bzr in a subprocess for testing.
1461
This starts a new Python interpreter and runs bzr in there.
1462
This should only be used for tests that have a justifiable need for
1463
this isolation: e.g. they are testing startup time, or signal
1464
handling, or early startup code, etc. Subprocess code can't be
1465
profiled or debugged so easily.
1467
:param process_args: a list of arguments to pass to the bzr executable,
1468
for example ``['--version']``.
1469
:param env_changes: A dictionary which lists changes to environment
1470
variables. A value of None will unset the env variable.
1471
The values must be strings. The change will only occur in the
1472
child, so you don't need to fix the environment after running.
1473
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1475
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1477
:returns: Popen object for the started process.
1479
if skip_if_plan_to_signal:
1480
if not getattr(os, 'kill', None):
1481
raise TestSkipped("os.kill not available.")
1483
if env_changes is None:
1487
def cleanup_environment():
1488
for env_var, value in env_changes.iteritems():
1489
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1491
def restore_environment():
1492
for env_var, value in old_env.iteritems():
1493
osutils.set_or_unset_env(env_var, value)
1495
bzr_path = self.get_bzr_path()
1498
if working_dir is not None:
1499
cwd = osutils.getcwd()
1500
os.chdir(working_dir)
1503
# win32 subprocess doesn't support preexec_fn
1504
# so we will avoid using it on all platforms, just to
1505
# make sure the code path is used, and we don't break on win32
1506
cleanup_environment()
1507
command = [sys.executable, bzr_path]
1508
if not allow_plugins:
1509
command.append('--no-plugins')
1510
command.extend(process_args)
1511
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1513
restore_environment()
1519
def _popen(self, *args, **kwargs):
1520
"""Place a call to Popen.
1522
Allows tests to override this method to intercept the calls made to
1523
Popen for introspection.
1525
return Popen(*args, **kwargs)
1527
def get_bzr_path(self):
1528
"""Return the path of the 'bzr' executable for this test suite."""
1529
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1530
if not os.path.isfile(bzr_path):
1531
# We are probably installed. Assume sys.argv is the right file
1532
bzr_path = sys.argv[0]
1535
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1536
universal_newlines=False, process_args=None):
1537
"""Finish the execution of process.
1539
:param process: the Popen object returned from start_bzr_subprocess.
1540
:param retcode: The status code that is expected. Defaults to 0. If
1541
None is supplied, the status code is not checked.
1542
:param send_signal: an optional signal to send to the process.
1543
:param universal_newlines: Convert CRLF => LF
1544
:returns: (stdout, stderr)
1546
if send_signal is not None:
1547
os.kill(process.pid, send_signal)
1548
out, err = process.communicate()
1550
if universal_newlines:
1551
out = out.replace('\r\n', '\n')
1552
err = err.replace('\r\n', '\n')
1554
if retcode is not None and retcode != process.returncode:
1555
if process_args is None:
1556
process_args = "(unknown args)"
1557
mutter('Output of bzr %s:\n%s', process_args, out)
1558
mutter('Error for bzr %s:\n%s', process_args, err)
1559
self.fail('Command bzr %s failed with retcode %s != %s'
1560
% (process_args, retcode, process.returncode))
1563
def check_inventory_shape(self, inv, shape):
1564
"""Compare an inventory to a list of expected names.
1566
Fail if they are not precisely equal.
1569
shape = list(shape) # copy
1570
for path, ie in inv.entries():
1571
name = path.replace('\\', '/')
1572
if ie.kind == 'directory':
1579
self.fail("expected paths not found in inventory: %r" % shape)
1581
self.fail("unexpected paths found in inventory: %r" % extras)
1583
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1584
a_callable=None, *args, **kwargs):
1585
"""Call callable with redirected std io pipes.
1587
Returns the return code."""
1588
if not callable(a_callable):
1589
raise ValueError("a_callable must be callable.")
1591
stdin = StringIO("")
1593
if getattr(self, "_log_file", None) is not None:
1594
stdout = self._log_file
1598
if getattr(self, "_log_file", None is not None):
1599
stderr = self._log_file
1602
real_stdin = sys.stdin
1603
real_stdout = sys.stdout
1604
real_stderr = sys.stderr
1609
return a_callable(*args, **kwargs)
1611
sys.stdout = real_stdout
1612
sys.stderr = real_stderr
1613
sys.stdin = real_stdin
1615
def reduceLockdirTimeout(self):
1616
"""Reduce the default lock timeout for the duration of the test, so that
1617
if LockContention occurs during a test, it does so quickly.
1619
Tests that expect to provoke LockContention errors should call this.
1621
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1623
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1624
self.addCleanup(resetTimeout)
1625
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1628
class TestCaseWithMemoryTransport(TestCase):
1629
"""Common test class for tests that do not need disk resources.
1631
Tests that need disk resources should derive from TestCaseWithTransport.
1633
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1635
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1636
a directory which does not exist. This serves to help ensure test isolation
1637
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1638
must exist. However, TestCaseWithMemoryTransport does not offer local
1639
file defaults for the transport in tests, nor does it obey the command line
1640
override, so tests that accidentally write to the common directory should
1643
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1644
a .bzr directory that stops us ascending higher into the filesystem.
1650
def __init__(self, methodName='runTest'):
1651
# allow test parameterisation after test construction and before test
1652
# execution. Variables that the parameteriser sets need to be
1653
# ones that are not set by setUp, or setUp will trash them.
1654
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1655
self.vfs_transport_factory = default_transport
1656
self.transport_server = None
1657
self.transport_readonly_server = None
1658
self.__vfs_server = None
1660
def get_transport(self, relpath=None):
1661
"""Return a writeable transport.
1663
This transport is for the test scratch space relative to
1666
:param relpath: a path relative to the base url.
1668
t = get_transport(self.get_url(relpath))
1669
self.assertFalse(t.is_readonly())
1672
def get_readonly_transport(self, relpath=None):
1673
"""Return a readonly transport for the test scratch space
1675
This can be used to test that operations which should only need
1676
readonly access in fact do not try to write.
1678
:param relpath: a path relative to the base url.
1680
t = get_transport(self.get_readonly_url(relpath))
1681
self.assertTrue(t.is_readonly())
1684
def create_transport_readonly_server(self):
1685
"""Create a transport server from class defined at init.
1687
This is mostly a hook for daughter classes.
1689
return self.transport_readonly_server()
1691
def get_readonly_server(self):
1692
"""Get the server instance for the readonly transport
1694
This is useful for some tests with specific servers to do diagnostics.
1696
if self.__readonly_server is None:
1697
if self.transport_readonly_server is None:
1698
# readonly decorator requested
1699
# bring up the server
1700
self.__readonly_server = ReadonlyServer()
1701
self.__readonly_server.setUp(self.get_vfs_only_server())
1703
self.__readonly_server = self.create_transport_readonly_server()
1704
self.__readonly_server.setUp(self.get_vfs_only_server())
1705
self.addCleanup(self.__readonly_server.tearDown)
1706
return self.__readonly_server
1708
def get_readonly_url(self, relpath=None):
1709
"""Get a URL for the readonly transport.
1711
This will either be backed by '.' or a decorator to the transport
1712
used by self.get_url()
1713
relpath provides for clients to get a path relative to the base url.
1714
These should only be downwards relative, not upwards.
1716
base = self.get_readonly_server().get_url()
1717
return self._adjust_url(base, relpath)
1719
def get_vfs_only_server(self):
1720
"""Get the vfs only read/write server instance.
1722
This is useful for some tests with specific servers that need
1725
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1726
is no means to override it.
1728
if self.__vfs_server is None:
1729
self.__vfs_server = MemoryServer()
1730
self.__vfs_server.setUp()
1731
self.addCleanup(self.__vfs_server.tearDown)
1732
return self.__vfs_server
1734
def get_server(self):
1735
"""Get the read/write server instance.
1737
This is useful for some tests with specific servers that need
1740
This is built from the self.transport_server factory. If that is None,
1741
then the self.get_vfs_server is returned.
1743
if self.__server is None:
1744
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1745
return self.get_vfs_only_server()
1747
# bring up a decorated means of access to the vfs only server.
1748
self.__server = self.transport_server()
1750
self.__server.setUp(self.get_vfs_only_server())
1751
except TypeError, e:
1752
# This should never happen; the try:Except here is to assist
1753
# developers having to update code rather than seeing an
1754
# uninformative TypeError.
1755
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1756
self.addCleanup(self.__server.tearDown)
1757
return self.__server
1759
def _adjust_url(self, base, relpath):
1760
"""Get a URL (or maybe a path) for the readwrite transport.
1762
This will either be backed by '.' or to an equivalent non-file based
1764
relpath provides for clients to get a path relative to the base url.
1765
These should only be downwards relative, not upwards.
1767
if relpath is not None and relpath != '.':
1768
if not base.endswith('/'):
1770
# XXX: Really base should be a url; we did after all call
1771
# get_url()! But sometimes it's just a path (from
1772
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1773
# to a non-escaped local path.
1774
if base.startswith('./') or base.startswith('/'):
1777
base += urlutils.escape(relpath)
1780
def get_url(self, relpath=None):
1781
"""Get a URL (or maybe a path) for the readwrite transport.
1783
This will either be backed by '.' or to an equivalent non-file based
1785
relpath provides for clients to get a path relative to the base url.
1786
These should only be downwards relative, not upwards.
1788
base = self.get_server().get_url()
1789
return self._adjust_url(base, relpath)
1791
def get_vfs_only_url(self, relpath=None):
1792
"""Get a URL (or maybe a path for the plain old vfs transport.
1794
This will never be a smart protocol. It always has all the
1795
capabilities of the local filesystem, but it might actually be a
1796
MemoryTransport or some other similar virtual filesystem.
1798
This is the backing transport (if any) of the server returned by
1799
get_url and get_readonly_url.
1801
:param relpath: provides for clients to get a path relative to the base
1802
url. These should only be downwards relative, not upwards.
1805
base = self.get_vfs_only_server().get_url()
1806
return self._adjust_url(base, relpath)
1808
def _make_test_root(self):
1809
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1811
root = tempfile.mkdtemp(prefix='testbzr-', suffix='.tmp')
1812
TestCaseWithMemoryTransport.TEST_ROOT = root
1814
# make a fake bzr directory there to prevent any tests propagating
1815
# up onto the source directory's real branch
1816
bzrdir.BzrDir.create_standalone_workingtree(root)
1818
# The same directory is used by all tests, and we're not specifically
1819
# told when all tests are finished. This will do.
1820
atexit.register(_rmtree_temp_dir, root)
1822
def makeAndChdirToTestDir(self):
1823
"""Create a temporary directories for this one test.
1825
This must set self.test_home_dir and self.test_dir and chdir to
1828
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1830
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1831
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1832
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1834
def make_branch(self, relpath, format=None):
1835
"""Create a branch on the transport at relpath."""
1836
repo = self.make_repository(relpath, format=format)
1837
return repo.bzrdir.create_branch()
1839
def make_bzrdir(self, relpath, format=None):
1841
# might be a relative or absolute path
1842
maybe_a_url = self.get_url(relpath)
1843
segments = maybe_a_url.rsplit('/', 1)
1844
t = get_transport(maybe_a_url)
1845
if len(segments) > 1 and segments[-1] not in ('', '.'):
1849
if isinstance(format, basestring):
1850
format = bzrdir.format_registry.make_bzrdir(format)
1851
return format.initialize_on_transport(t)
1852
except errors.UninitializableFormat:
1853
raise TestSkipped("Format %s is not initializable." % format)
1855
def make_repository(self, relpath, shared=False, format=None):
1856
"""Create a repository on our default transport at relpath.
1858
Note that relpath must be a relative path, not a full url.
1860
# FIXME: If you create a remoterepository this returns the underlying
1861
# real format, which is incorrect. Actually we should make sure that
1862
# RemoteBzrDir returns a RemoteRepository.
1863
# maybe mbp 20070410
1864
made_control = self.make_bzrdir(relpath, format=format)
1865
return made_control.create_repository(shared=shared)
1867
def make_branch_and_memory_tree(self, relpath, format=None):
1868
"""Create a branch on the default transport and a MemoryTree for it."""
1869
b = self.make_branch(relpath, format=format)
1870
return memorytree.MemoryTree.create_on_branch(b)
1872
def overrideEnvironmentForTesting(self):
1873
os.environ['HOME'] = self.test_home_dir
1874
os.environ['BZR_HOME'] = self.test_home_dir
1877
super(TestCaseWithMemoryTransport, self).setUp()
1878
self._make_test_root()
1879
_currentdir = os.getcwdu()
1880
def _leaveDirectory():
1881
os.chdir(_currentdir)
1882
self.addCleanup(_leaveDirectory)
1883
self.makeAndChdirToTestDir()
1884
self.overrideEnvironmentForTesting()
1885
self.__readonly_server = None
1886
self.__server = None
1887
self.reduceLockdirTimeout()
1890
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1891
"""Derived class that runs a test within a temporary directory.
1893
This is useful for tests that need to create a branch, etc.
1895
The directory is created in a slightly complex way: for each
1896
Python invocation, a new temporary top-level directory is created.
1897
All test cases create their own directory within that. If the
1898
tests complete successfully, the directory is removed.
1900
:ivar test_base_dir: The path of the top-level directory for this
1901
test, which contains a home directory and a work directory.
1903
:ivar test_home_dir: An initially empty directory under test_base_dir
1904
which is used as $HOME for this test.
1906
:ivar test_dir: A directory under test_base_dir used as the current
1907
directory when the test proper is run.
1910
OVERRIDE_PYTHON = 'python'
1912
def check_file_contents(self, filename, expect):
1913
self.log("check contents of file %s" % filename)
1914
contents = file(filename, 'r').read()
1915
if contents != expect:
1916
self.log("expected: %r" % expect)
1917
self.log("actually: %r" % contents)
1918
self.fail("contents of %s not as expected" % filename)
1920
def makeAndChdirToTestDir(self):
1921
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1923
For TestCaseInTempDir we create a temporary directory based on the test
1924
name and then create two subdirs - test and home under it.
1926
# create a directory within the top level test directory
1927
candidate_dir = tempfile.mkdtemp(dir=self.TEST_ROOT)
1928
# now create test and home directories within this dir
1929
self.test_base_dir = candidate_dir
1930
self.test_home_dir = self.test_base_dir + '/home'
1931
os.mkdir(self.test_home_dir)
1932
self.test_dir = self.test_base_dir + '/work'
1933
os.mkdir(self.test_dir)
1934
os.chdir(self.test_dir)
1935
# put name of test inside
1936
f = file(self.test_base_dir + '/name', 'w')
1941
self.addCleanup(self.deleteTestDir)
1943
def deleteTestDir(self):
1944
os.chdir(self.TEST_ROOT)
1945
_rmtree_temp_dir(self.test_base_dir)
1947
def build_tree(self, shape, line_endings='binary', transport=None):
1948
"""Build a test tree according to a pattern.
1950
shape is a sequence of file specifications. If the final
1951
character is '/', a directory is created.
1953
This assumes that all the elements in the tree being built are new.
1955
This doesn't add anything to a branch.
1957
:param line_endings: Either 'binary' or 'native'
1958
in binary mode, exact contents are written in native mode, the
1959
line endings match the default platform endings.
1960
:param transport: A transport to write to, for building trees on VFS's.
1961
If the transport is readonly or None, "." is opened automatically.
1964
# It's OK to just create them using forward slashes on windows.
1965
if transport is None or transport.is_readonly():
1966
transport = get_transport(".")
1968
self.assert_(isinstance(name, basestring))
1970
transport.mkdir(urlutils.escape(name[:-1]))
1972
if line_endings == 'binary':
1974
elif line_endings == 'native':
1977
raise errors.BzrError(
1978
'Invalid line ending request %r' % line_endings)
1979
content = "contents of %s%s" % (name.encode('utf-8'), end)
1980
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1982
def build_tree_contents(self, shape):
1983
build_tree_contents(shape)
1985
def assertFileEqual(self, content, path):
1986
"""Fail if path does not contain 'content'."""
1987
self.failUnlessExists(path)
1988
f = file(path, 'rb')
1993
self.assertEqualDiff(content, s)
1995
def failUnlessExists(self, path):
1996
"""Fail unless path or paths, which may be abs or relative, exist."""
1997
if not isinstance(path, basestring):
1999
self.failUnlessExists(p)
2001
self.failUnless(osutils.lexists(path),path+" does not exist")
2003
def failIfExists(self, path):
2004
"""Fail if path or paths, which may be abs or relative, exist."""
2005
if not isinstance(path, basestring):
2007
self.failIfExists(p)
2009
self.failIf(osutils.lexists(path),path+" exists")
2011
def assertInWorkingTree(self,path,root_path='.',tree=None):
2012
"""Assert whether path or paths are in the WorkingTree"""
2014
tree = workingtree.WorkingTree.open(root_path)
2015
if not isinstance(path, basestring):
2017
self.assertInWorkingTree(p,tree=tree)
2019
self.assertIsNot(tree.path2id(path), None,
2020
path+' not in working tree.')
2022
def assertNotInWorkingTree(self,path,root_path='.',tree=None):
2023
"""Assert whether path or paths are not in the WorkingTree"""
2025
tree = workingtree.WorkingTree.open(root_path)
2026
if not isinstance(path, basestring):
2028
self.assertNotInWorkingTree(p,tree=tree)
2030
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2033
class TestCaseWithTransport(TestCaseInTempDir):
2034
"""A test case that provides get_url and get_readonly_url facilities.
2036
These back onto two transport servers, one for readonly access and one for
2039
If no explicit class is provided for readonly access, a
2040
ReadonlyTransportDecorator is used instead which allows the use of non disk
2041
based read write transports.
2043
If an explicit class is provided for readonly access, that server and the
2044
readwrite one must both define get_url() as resolving to os.getcwd().
2047
def get_vfs_only_server(self):
2048
"""See TestCaseWithMemoryTransport.
2050
This is useful for some tests with specific servers that need
2053
if self.__vfs_server is None:
2054
self.__vfs_server = self.vfs_transport_factory()
2055
self.__vfs_server.setUp()
2056
self.addCleanup(self.__vfs_server.tearDown)
2057
return self.__vfs_server
2059
def make_branch_and_tree(self, relpath, format=None):
2060
"""Create a branch on the transport and a tree locally.
2062
If the transport is not a LocalTransport, the Tree can't be created on
2063
the transport. In that case if the vfs_transport_factory is
2064
LocalURLServer the working tree is created in the local
2065
directory backing the transport, and the returned tree's branch and
2066
repository will also be accessed locally. Otherwise a lightweight
2067
checkout is created and returned.
2069
:param format: The BzrDirFormat.
2070
:returns: the WorkingTree.
2072
# TODO: always use the local disk path for the working tree,
2073
# this obviously requires a format that supports branch references
2074
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2076
b = self.make_branch(relpath, format=format)
2078
return b.bzrdir.create_workingtree()
2079
except errors.NotLocalUrl:
2080
# We can only make working trees locally at the moment. If the
2081
# transport can't support them, then we keep the non-disk-backed
2082
# branch and create a local checkout.
2083
if self.vfs_transport_factory is LocalURLServer:
2084
# the branch is colocated on disk, we cannot create a checkout.
2085
# hopefully callers will expect this.
2086
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2087
return local_controldir.create_workingtree()
2089
return b.create_checkout(relpath, lightweight=True)
2091
def assertIsDirectory(self, relpath, transport):
2092
"""Assert that relpath within transport is a directory.
2094
This may not be possible on all transports; in that case it propagates
2095
a TransportNotPossible.
2098
mode = transport.stat(relpath).st_mode
2099
except errors.NoSuchFile:
2100
self.fail("path %s is not a directory; no such file"
2102
if not stat.S_ISDIR(mode):
2103
self.fail("path %s is not a directory; has mode %#o"
2106
def assertTreesEqual(self, left, right):
2107
"""Check that left and right have the same content and properties."""
2108
# we use a tree delta to check for equality of the content, and we
2109
# manually check for equality of other things such as the parents list.
2110
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2111
differences = left.changes_from(right)
2112
self.assertFalse(differences.has_changed(),
2113
"Trees %r and %r are different: %r" % (left, right, differences))
2116
super(TestCaseWithTransport, self).setUp()
2117
self.__vfs_server = None
2120
class ChrootedTestCase(TestCaseWithTransport):
2121
"""A support class that provides readonly urls outside the local namespace.
2123
This is done by checking if self.transport_server is a MemoryServer. if it
2124
is then we are chrooted already, if it is not then an HttpServer is used
2127
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2128
be used without needed to redo it when a different
2129
subclass is in use ?
2133
super(ChrootedTestCase, self).setUp()
2134
if not self.vfs_transport_factory == MemoryServer:
2135
self.transport_readonly_server = HttpServer
2138
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2139
random_order=False):
2140
"""Create a test suite by filtering another one.
2142
:param suite: the source suite
2143
:param pattern: pattern that names must match
2144
:param exclude_pattern: pattern that names must not match, if any
2145
:param random_order: if True, tests in the new suite will be put in
2147
:returns: the newly created suite
2149
return sort_suite_by_re(suite, pattern, exclude_pattern,
2150
random_order, False)
2153
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2154
random_order=False, append_rest=True):
2155
"""Create a test suite by sorting another one.
2157
:param suite: the source suite
2158
:param pattern: pattern that names must match in order to go
2159
first in the new suite
2160
:param exclude_pattern: pattern that names must not match, if any
2161
:param random_order: if True, tests in the new suite will be put in
2163
:param append_rest: if False, pattern is a strict filter and not
2164
just an ordering directive
2165
:returns: the newly created suite
2169
filter_re = re.compile(pattern)
2170
if exclude_pattern is not None:
2171
exclude_re = re.compile(exclude_pattern)
2172
for test in iter_suite_tests(suite):
2174
if exclude_pattern is None or not exclude_re.search(test_id):
2175
if filter_re.search(test_id):
2180
random.shuffle(first)
2181
random.shuffle(second)
2182
return TestUtil.TestSuite(first + second)
2185
def run_suite(suite, name='test', verbose=False, pattern=".*",
2186
stop_on_failure=False,
2187
transport=None, lsprof_timed=None, bench_history=None,
2188
matching_tests_first=None,
2191
exclude_pattern=None,
2194
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2199
runner = TextTestRunner(stream=sys.stdout,
2201
verbosity=verbosity,
2202
bench_history=bench_history,
2203
list_only=list_only,
2205
runner.stop_on_failure=stop_on_failure
2206
# Initialise the random number generator and display the seed used.
2207
# We convert the seed to a long to make it reuseable across invocations.
2208
random_order = False
2209
if random_seed is not None:
2211
if random_seed == "now":
2212
random_seed = long(time.time())
2214
# Convert the seed to a long if we can
2216
random_seed = long(random_seed)
2219
runner.stream.writeln("Randomizing test order using seed %s\n" %
2221
random.seed(random_seed)
2222
# Customise the list of tests if requested
2223
if pattern != '.*' or exclude_pattern is not None or random_order:
2224
if matching_tests_first:
2225
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
2228
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
2230
result = runner.run(suite)
2233
return result.wasStrictlySuccessful()
2235
return result.wasSuccessful()
2238
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2240
test_suite_factory=None,
2243
matching_tests_first=None,
2246
exclude_pattern=None,
2249
"""Run the whole test suite under the enhanced runner"""
2250
# XXX: Very ugly way to do this...
2251
# Disable warning about old formats because we don't want it to disturb
2252
# any blackbox tests.
2253
from bzrlib import repository
2254
repository._deprecation_warning_done = True
2256
global default_transport
2257
if transport is None:
2258
transport = default_transport
2259
old_transport = default_transport
2260
default_transport = transport
2262
if test_suite_factory is None:
2263
suite = test_suite()
2265
suite = test_suite_factory()
2266
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2267
stop_on_failure=stop_on_failure,
2268
transport=transport,
2269
lsprof_timed=lsprof_timed,
2270
bench_history=bench_history,
2271
matching_tests_first=matching_tests_first,
2272
list_only=list_only,
2273
random_seed=random_seed,
2274
exclude_pattern=exclude_pattern,
2277
default_transport = old_transport
2281
"""Build and return TestSuite for the whole of bzrlib.
2283
This function can be replaced if you need to change the default test
2284
suite on a global basis, but it is not encouraged.
2287
'bzrlib.util.tests.test_bencode',
2288
'bzrlib.tests.test__dirstate_helpers',
2289
'bzrlib.tests.test_ancestry',
2290
'bzrlib.tests.test_annotate',
2291
'bzrlib.tests.test_api',
2292
'bzrlib.tests.test_atomicfile',
2293
'bzrlib.tests.test_bad_files',
2294
'bzrlib.tests.test_branch',
2295
'bzrlib.tests.test_branchbuilder',
2296
'bzrlib.tests.test_bugtracker',
2297
'bzrlib.tests.test_bundle',
2298
'bzrlib.tests.test_bzrdir',
2299
'bzrlib.tests.test_cache_utf8',
2300
'bzrlib.tests.test_commands',
2301
'bzrlib.tests.test_commit',
2302
'bzrlib.tests.test_commit_merge',
2303
'bzrlib.tests.test_config',
2304
'bzrlib.tests.test_conflicts',
2305
'bzrlib.tests.test_counted_lock',
2306
'bzrlib.tests.test_decorators',
2307
'bzrlib.tests.test_delta',
2308
'bzrlib.tests.test_deprecated_graph',
2309
'bzrlib.tests.test_diff',
2310
'bzrlib.tests.test_dirstate',
2311
'bzrlib.tests.test_email_message',
2312
'bzrlib.tests.test_errors',
2313
'bzrlib.tests.test_escaped_store',
2314
'bzrlib.tests.test_extract',
2315
'bzrlib.tests.test_fetch',
2316
'bzrlib.tests.test_ftp_transport',
2317
'bzrlib.tests.test_generate_docs',
2318
'bzrlib.tests.test_generate_ids',
2319
'bzrlib.tests.test_globbing',
2320
'bzrlib.tests.test_gpg',
2321
'bzrlib.tests.test_graph',
2322
'bzrlib.tests.test_hashcache',
2323
'bzrlib.tests.test_help',
2324
'bzrlib.tests.test_hooks',
2325
'bzrlib.tests.test_http',
2326
'bzrlib.tests.test_http_response',
2327
'bzrlib.tests.test_https_ca_bundle',
2328
'bzrlib.tests.test_identitymap',
2329
'bzrlib.tests.test_ignores',
2330
'bzrlib.tests.test_index',
2331
'bzrlib.tests.test_info',
2332
'bzrlib.tests.test_inv',
2333
'bzrlib.tests.test_knit',
2334
'bzrlib.tests.test_lazy_import',
2335
'bzrlib.tests.test_lazy_regex',
2336
'bzrlib.tests.test_lockdir',
2337
'bzrlib.tests.test_lockable_files',
2338
'bzrlib.tests.test_log',
2339
'bzrlib.tests.test_lsprof',
2340
'bzrlib.tests.test_memorytree',
2341
'bzrlib.tests.test_merge',
2342
'bzrlib.tests.test_merge3',
2343
'bzrlib.tests.test_merge_core',
2344
'bzrlib.tests.test_merge_directive',
2345
'bzrlib.tests.test_missing',
2346
'bzrlib.tests.test_msgeditor',
2347
'bzrlib.tests.test_multiparent',
2348
'bzrlib.tests.test_nonascii',
2349
'bzrlib.tests.test_options',
2350
'bzrlib.tests.test_osutils',
2351
'bzrlib.tests.test_osutils_encodings',
2352
'bzrlib.tests.test_pack',
2353
'bzrlib.tests.test_patch',
2354
'bzrlib.tests.test_patches',
2355
'bzrlib.tests.test_permissions',
2356
'bzrlib.tests.test_plugins',
2357
'bzrlib.tests.test_progress',
2358
'bzrlib.tests.test_reconcile',
2359
'bzrlib.tests.test_registry',
2360
'bzrlib.tests.test_remote',
2361
'bzrlib.tests.test_repository',
2362
'bzrlib.tests.test_revert',
2363
'bzrlib.tests.test_revision',
2364
'bzrlib.tests.test_revisionnamespaces',
2365
'bzrlib.tests.test_revisiontree',
2366
'bzrlib.tests.test_rio',
2367
'bzrlib.tests.test_sampler',
2368
'bzrlib.tests.test_selftest',
2369
'bzrlib.tests.test_setup',
2370
'bzrlib.tests.test_sftp_transport',
2371
'bzrlib.tests.test_smart',
2372
'bzrlib.tests.test_smart_add',
2373
'bzrlib.tests.test_smart_transport',
2374
'bzrlib.tests.test_smtp_connection',
2375
'bzrlib.tests.test_source',
2376
'bzrlib.tests.test_ssh_transport',
2377
'bzrlib.tests.test_status',
2378
'bzrlib.tests.test_store',
2379
'bzrlib.tests.test_strace',
2380
'bzrlib.tests.test_subsume',
2381
'bzrlib.tests.test_symbol_versioning',
2382
'bzrlib.tests.test_tag',
2383
'bzrlib.tests.test_testament',
2384
'bzrlib.tests.test_textfile',
2385
'bzrlib.tests.test_textmerge',
2386
'bzrlib.tests.test_timestamp',
2387
'bzrlib.tests.test_trace',
2388
'bzrlib.tests.test_transactions',
2389
'bzrlib.tests.test_transform',
2390
'bzrlib.tests.test_transport',
2391
'bzrlib.tests.test_tree',
2392
'bzrlib.tests.test_treebuilder',
2393
'bzrlib.tests.test_tsort',
2394
'bzrlib.tests.test_tuned_gzip',
2395
'bzrlib.tests.test_ui',
2396
'bzrlib.tests.test_upgrade',
2397
'bzrlib.tests.test_urlutils',
2398
'bzrlib.tests.test_versionedfile',
2399
'bzrlib.tests.test_version',
2400
'bzrlib.tests.test_version_info',
2401
'bzrlib.tests.test_weave',
2402
'bzrlib.tests.test_whitebox',
2403
'bzrlib.tests.test_win32utils',
2404
'bzrlib.tests.test_workingtree',
2405
'bzrlib.tests.test_workingtree_4',
2406
'bzrlib.tests.test_wsgi',
2407
'bzrlib.tests.test_xml',
2409
test_transport_implementations = [
2410
'bzrlib.tests.test_transport_implementations',
2411
'bzrlib.tests.test_read_bundle',
2413
suite = TestUtil.TestSuite()
2414
loader = TestUtil.TestLoader()
2415
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2416
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2417
adapter = TransportTestProviderAdapter()
2418
adapt_modules(test_transport_implementations, adapter, loader, suite)
2419
for package in packages_to_test():
2420
suite.addTest(package.test_suite())
2421
for m in MODULES_TO_TEST:
2422
suite.addTest(loader.loadTestsFromModule(m))
2423
for m in MODULES_TO_DOCTEST:
2425
suite.addTest(doctest.DocTestSuite(m))
2426
except ValueError, e:
2427
print '**failed to get doctest for: %s\n%s' %(m,e)
2429
for name, plugin in bzrlib.plugin.all_plugins().items():
2430
if getattr(plugin, 'test_suite', None) is not None:
2431
default_encoding = sys.getdefaultencoding()
2433
plugin_suite = plugin.test_suite()
2434
except ImportError, e:
2435
bzrlib.trace.warning(
2436
'Unable to test plugin "%s": %s', name, e)
2438
suite.addTest(plugin_suite)
2439
if default_encoding != sys.getdefaultencoding():
2440
bzrlib.trace.warning(
2441
'Plugin "%s" tried to reset default encoding to: %s', name,
2442
sys.getdefaultencoding())
2444
sys.setdefaultencoding(default_encoding)
2448
def adapt_modules(mods_list, adapter, loader, suite):
2449
"""Adapt the modules in mods_list using adapter and add to suite."""
2450
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2451
suite.addTests(adapter.adapt(test))
2454
def _rmtree_temp_dir(dirname):
2455
# If LANG=C we probably have created some bogus paths
2456
# which rmtree(unicode) will fail to delete
2457
# so make sure we are using rmtree(str) to delete everything
2458
# except on win32, where rmtree(str) will fail
2459
# since it doesn't have the property of byte-stream paths
2460
# (they are either ascii or mbcs)
2461
if sys.platform == 'win32':
2462
# make sure we are using the unicode win32 api
2463
dirname = unicode(dirname)
2465
dirname = dirname.encode(sys.getfilesystemencoding())
2467
osutils.rmtree(dirname)
2469
if sys.platform == 'win32' and e.errno == errno.EACCES:
2470
print >>sys.stderr, ('Permission denied: '
2471
'unable to remove testing dir '
2472
'%s' % os.path.basename(dirname))
2477
class Feature(object):
2478
"""An operating system Feature."""
2481
self._available = None
2483
def available(self):
2484
"""Is the feature available?
2486
:return: True if the feature is available.
2488
if self._available is None:
2489
self._available = self._probe()
2490
return self._available
2493
"""Implement this method in concrete features.
2495
:return: True if the feature is available.
2497
raise NotImplementedError
2500
if getattr(self, 'feature_name', None):
2501
return self.feature_name()
2502
return self.__class__.__name__
2505
class TestScenarioApplier(object):
2506
"""A tool to apply scenarios to tests."""
2508
def adapt(self, test):
2509
"""Return a TestSuite containing a copy of test for each scenario."""
2510
result = unittest.TestSuite()
2511
for scenario in self.scenarios:
2512
result.addTest(self.adapt_test_to_scenario(test, scenario))
2515
def adapt_test_to_scenario(self, test, scenario):
2516
"""Copy test and apply scenario to it.
2518
:param test: A test to adapt.
2519
:param scenario: A tuple describing the scenarion.
2520
The first element of the tuple is the new test id.
2521
The second element is a dict containing attributes to set on the
2523
:return: The adapted test.
2525
from copy import deepcopy
2526
new_test = deepcopy(test)
2527
for name, value in scenario[1].items():
2528
setattr(new_test, name, value)
2529
new_id = "%s(%s)" % (new_test.id(), scenario[0])
2530
new_test.id = lambda: new_id
added
removed
bzrlib/tests/__init__.py
