1
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from testsweet import TestBase, run_suite, InTempDir
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
19
62
import bzrlib.commands
63
import bzrlib.timestamp
65
import bzrlib.inventory
66
import bzrlib.iterablefile
71
# lsprof not available
73
from bzrlib.merge import merge_inner
77
from bzrlib.revision import common_ancestor
79
from bzrlib import symbol_versioning
80
from bzrlib.symbol_versioning import (
85
from bzrlib.transport import get_transport
86
import bzrlib.transport
87
from bzrlib.transport.local import LocalURLServer
88
from bzrlib.transport.memory import MemoryServer
89
from bzrlib.transport.readonly import ReadonlyServer
90
from bzrlib.trace import mutter, note
91
from bzrlib.tests import TestUtil
92
from bzrlib.tests.HttpServer import HttpServer
93
from bzrlib.tests.TestUtil import (
97
from bzrlib.tests.treeshape import build_tree_contents
98
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
100
# Mark this python module as being part of the implementation
101
# of unittest: this gives us better tracebacks where the last
102
# shown frame is the test code, not our assertXYZ.
105
default_transport = LocalURLServer
21
107
MODULES_TO_TEST = []
22
MODULES_TO_DOCTEST = []
25
class BzrTestBase(InTempDir):
26
"""bzr-specific test base class"""
108
MODULES_TO_DOCTEST = [
121
def packages_to_test():
122
"""Return a list of packages to test.
124
The packages are not globally imported so that import failures are
125
triggered when running selftest, not when importing the command.
128
import bzrlib.tests.blackbox
129
import bzrlib.tests.branch_implementations
130
import bzrlib.tests.bzrdir_implementations
131
import bzrlib.tests.interrepository_implementations
132
import bzrlib.tests.interversionedfile_implementations
133
import bzrlib.tests.intertree_implementations
134
import bzrlib.tests.per_lock
135
import bzrlib.tests.repository_implementations
136
import bzrlib.tests.revisionstore_implementations
137
import bzrlib.tests.tree_implementations
138
import bzrlib.tests.workingtree_implementations
141
bzrlib.tests.blackbox,
142
bzrlib.tests.branch_implementations,
143
bzrlib.tests.bzrdir_implementations,
144
bzrlib.tests.interrepository_implementations,
145
bzrlib.tests.interversionedfile_implementations,
146
bzrlib.tests.intertree_implementations,
147
bzrlib.tests.per_lock,
148
bzrlib.tests.repository_implementations,
149
bzrlib.tests.revisionstore_implementations,
150
bzrlib.tests.tree_implementations,
151
bzrlib.tests.workingtree_implementations,
155
class ExtendedTestResult(unittest._TextTestResult):
156
"""Accepts, reports and accumulates the results of running tests.
158
Compared to this unittest version this class adds support for profiling,
159
benchmarking, stopping as soon as a test fails, and skipping tests.
160
There are further-specialized subclasses for different types of display.
165
def __init__(self, stream, descriptions, verbosity,
168
use_numbered_dirs=False,
170
"""Construct new TestResult.
172
:param bench_history: Optionally, a writable file object to accumulate
175
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
176
if bench_history is not None:
177
from bzrlib.version import _get_bzr_source_tree
178
src_tree = _get_bzr_source_tree()
181
revision_id = src_tree.get_parent_ids()[0]
183
# XXX: if this is a brand new tree, do the same as if there
187
# XXX: If there's no branch, what should we do?
189
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
190
self._bench_history = bench_history
191
self.ui = ui.ui_factory
192
self.num_tests = num_tests
194
self.failure_count = 0
195
self.known_failure_count = 0
197
self.unsupported = {}
199
self.use_numbered_dirs = use_numbered_dirs
200
self._overall_start_time = time.time()
202
def extractBenchmarkTime(self, testCase):
203
"""Add a benchmark time for the current test case."""
204
self._benchmarkTime = getattr(testCase, "_benchtime", None)
206
def _elapsedTestTimeString(self):
207
"""Return a time string for the overall time the current test has taken."""
208
return self._formatTime(time.time() - self._start_time)
210
def _testTimeString(self):
211
if self._benchmarkTime is not None:
213
self._formatTime(self._benchmarkTime),
214
self._elapsedTestTimeString())
216
return " %s" % self._elapsedTestTimeString()
218
def _formatTime(self, seconds):
219
"""Format seconds as milliseconds with leading spaces."""
220
# some benchmarks can take thousands of seconds to run, so we need 8
222
return "%8dms" % (1000 * seconds)
224
def _shortened_test_description(self, test):
226
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
229
def startTest(self, test):
230
unittest.TestResult.startTest(self, test)
231
self.report_test_start(test)
232
test.number = self.count
233
self._recordTestStartTime()
235
def _recordTestStartTime(self):
236
"""Record that a test has started."""
237
self._start_time = time.time()
239
def _cleanupLogFile(self, test):
240
# We can only do this if we have one of our TestCases, not if
242
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
243
if setKeepLogfile is not None:
246
def addError(self, test, err):
247
self.extractBenchmarkTime(test)
248
self._cleanupLogFile(test)
249
if isinstance(err[1], TestSkipped):
250
return self.addSkipped(test, err)
251
elif isinstance(err[1], UnavailableFeature):
252
return self.addNotSupported(test, err[1].args[0])
253
unittest.TestResult.addError(self, test, err)
254
self.error_count += 1
255
self.report_error(test, err)
259
def addFailure(self, test, err):
260
self._cleanupLogFile(test)
261
self.extractBenchmarkTime(test)
262
if isinstance(err[1], KnownFailure):
263
return self.addKnownFailure(test, err)
264
unittest.TestResult.addFailure(self, test, err)
265
self.failure_count += 1
266
self.report_failure(test, err)
270
def addKnownFailure(self, test, err):
271
self.known_failure_count += 1
272
self.report_known_failure(test, err)
274
def addNotSupported(self, test, feature):
275
self.unsupported.setdefault(str(feature), 0)
276
self.unsupported[str(feature)] += 1
277
self.report_unsupported(test, feature)
279
def addSuccess(self, test):
280
self.extractBenchmarkTime(test)
281
if self._bench_history is not None:
282
if self._benchmarkTime is not None:
283
self._bench_history.write("%s %s\n" % (
284
self._formatTime(self._benchmarkTime),
286
self.report_success(test)
287
unittest.TestResult.addSuccess(self, test)
289
def addSkipped(self, test, skip_excinfo):
290
self.report_skip(test, skip_excinfo)
291
# seems best to treat this as success from point-of-view of unittest
292
# -- it actually does nothing so it barely matters :)
295
except KeyboardInterrupt:
298
self.addError(test, test.__exc_info())
300
unittest.TestResult.addSuccess(self, test)
302
def printErrorList(self, flavour, errors):
303
for test, err in errors:
304
self.stream.writeln(self.separator1)
305
self.stream.write("%s: " % flavour)
306
if self.use_numbered_dirs:
307
self.stream.write('#%d ' % test.number)
308
self.stream.writeln(self.getDescription(test))
309
if getattr(test, '_get_log', None) is not None:
311
print >>self.stream, \
312
('vvvv[log from %s]' % test.id()).ljust(78,'-')
313
print >>self.stream, test._get_log()
314
print >>self.stream, \
315
('^^^^[log from %s]' % test.id()).ljust(78,'-')
316
self.stream.writeln(self.separator2)
317
self.stream.writeln("%s" % err)
322
def report_cleaning_up(self):
325
def report_success(self, test):
329
class TextTestResult(ExtendedTestResult):
330
"""Displays progress and results of tests in text form"""
332
def __init__(self, stream, descriptions, verbosity,
336
use_numbered_dirs=False,
338
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
339
bench_history, num_tests, use_numbered_dirs)
341
self.pb = self.ui.nested_progress_bar()
342
self._supplied_pb = False
345
self._supplied_pb = True
346
self.pb.show_pct = False
347
self.pb.show_spinner = False
348
self.pb.show_eta = False,
349
self.pb.show_count = False
350
self.pb.show_bar = False
352
def report_starting(self):
353
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
355
def _progress_prefix_text(self):
356
a = '[%d' % self.count
357
if self.num_tests is not None:
358
a +='/%d' % self.num_tests
359
a += ' in %ds' % (time.time() - self._overall_start_time)
361
a += ', %d errors' % self.error_count
362
if self.failure_count:
363
a += ', %d failed' % self.failure_count
364
if self.known_failure_count:
365
a += ', %d known failures' % self.known_failure_count
367
a += ', %d skipped' % self.skip_count
369
a += ', %d missing features' % len(self.unsupported)
373
def report_test_start(self, test):
376
self._progress_prefix_text()
378
+ self._shortened_test_description(test))
380
def _test_description(self, test):
381
if self.use_numbered_dirs:
382
return '#%d %s' % (self.count,
383
self._shortened_test_description(test))
385
return self._shortened_test_description(test)
387
def report_error(self, test, err):
388
self.pb.note('ERROR: %s\n %s\n',
389
self._test_description(test),
393
def report_failure(self, test, err):
394
self.pb.note('FAIL: %s\n %s\n',
395
self._test_description(test),
399
def report_known_failure(self, test, err):
400
self.pb.note('XFAIL: %s\n%s\n',
401
self._test_description(test), err[1])
403
def report_skip(self, test, skip_excinfo):
406
# at the moment these are mostly not things we can fix
407
# and so they just produce stipple; use the verbose reporter
410
# show test and reason for skip
411
self.pb.note('SKIP: %s\n %s\n',
412
self._shortened_test_description(test),
415
# since the class name was left behind in the still-visible
417
self.pb.note('SKIP: %s', skip_excinfo[1])
419
def report_unsupported(self, test, feature):
420
"""test cannot be run because feature is missing."""
422
def report_cleaning_up(self):
423
self.pb.update('cleaning up...')
426
if not self._supplied_pb:
430
class VerboseTestResult(ExtendedTestResult):
431
"""Produce long output, with one line per test run plus times"""
433
def _ellipsize_to_right(self, a_string, final_width):
434
"""Truncate and pad a string, keeping the right hand side"""
435
if len(a_string) > final_width:
436
result = '...' + a_string[3-final_width:]
439
return result.ljust(final_width)
441
def report_starting(self):
442
self.stream.write('running %d tests...\n' % self.num_tests)
444
def report_test_start(self, test):
446
name = self._shortened_test_description(test)
447
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
448
# numbers, plus a trailing blank
449
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
450
if self.use_numbered_dirs:
451
self.stream.write('%5d ' % self.count)
452
self.stream.write(self._ellipsize_to_right(name,
453
osutils.terminal_width()-36))
455
self.stream.write(self._ellipsize_to_right(name,
456
osutils.terminal_width()-30))
459
def _error_summary(self, err):
461
if self.use_numbered_dirs:
463
return '%s%s' % (indent, err[1])
465
def report_error(self, test, err):
466
self.stream.writeln('ERROR %s\n%s'
467
% (self._testTimeString(),
468
self._error_summary(err)))
470
def report_failure(self, test, err):
471
self.stream.writeln(' FAIL %s\n%s'
472
% (self._testTimeString(),
473
self._error_summary(err)))
475
def report_known_failure(self, test, err):
476
self.stream.writeln('XFAIL %s\n%s'
477
% (self._testTimeString(),
478
self._error_summary(err)))
480
def report_success(self, test):
481
self.stream.writeln(' OK %s' % self._testTimeString())
482
for bench_called, stats in getattr(test, '_benchcalls', []):
483
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
484
stats.pprint(file=self.stream)
485
# flush the stream so that we get smooth output. This verbose mode is
486
# used to show the output in PQM.
489
def report_skip(self, test, skip_excinfo):
491
self.stream.writeln(' SKIP %s\n%s'
492
% (self._testTimeString(),
493
self._error_summary(skip_excinfo)))
495
def report_unsupported(self, test, feature):
496
"""test cannot be run because feature is missing."""
497
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
498
%(self._testTimeString(), feature))
502
class TextTestRunner(object):
503
stop_on_failure = False
510
use_numbered_dirs=False,
513
self.stream = unittest._WritelnDecorator(stream)
514
self.descriptions = descriptions
515
self.verbosity = verbosity
516
self._bench_history = bench_history
517
self.use_numbered_dirs = use_numbered_dirs
518
self.list_only = list_only
521
"Run the given test case or test suite."
522
startTime = time.time()
523
if self.verbosity == 1:
524
result_class = TextTestResult
525
elif self.verbosity >= 2:
526
result_class = VerboseTestResult
527
result = result_class(self.stream,
530
bench_history=self._bench_history,
531
num_tests=test.countTestCases(),
532
use_numbered_dirs=self.use_numbered_dirs,
534
result.stop_early = self.stop_on_failure
535
result.report_starting()
537
if self.verbosity >= 2:
538
self.stream.writeln("Listing tests only ...\n")
540
for t in iter_suite_tests(test):
541
self.stream.writeln("%s" % (t.id()))
543
actionTaken = "Listed"
546
run = result.testsRun
548
stopTime = time.time()
549
timeTaken = stopTime - startTime
551
self.stream.writeln(result.separator2)
552
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
553
run, run != 1 and "s" or "", timeTaken))
554
self.stream.writeln()
555
if not result.wasSuccessful():
556
self.stream.write("FAILED (")
557
failed, errored = map(len, (result.failures, result.errors))
559
self.stream.write("failures=%d" % failed)
561
if failed: self.stream.write(", ")
562
self.stream.write("errors=%d" % errored)
563
if result.known_failure_count:
564
if failed or errored: self.stream.write(", ")
565
self.stream.write("known_failure_count=%d" %
566
result.known_failure_count)
567
self.stream.writeln(")")
569
if result.known_failure_count:
570
self.stream.writeln("OK (known_failures=%d)" %
571
result.known_failure_count)
573
self.stream.writeln("OK")
574
if result.skip_count > 0:
575
skipped = result.skip_count
576
self.stream.writeln('%d test%s skipped' %
577
(skipped, skipped != 1 and "s" or ""))
578
if result.unsupported:
579
for feature, count in sorted(result.unsupported.items()):
580
self.stream.writeln("Missing feature '%s' skipped %d tests." %
586
def iter_suite_tests(suite):
587
"""Return all tests in a suite, recursing through nested suites"""
588
for item in suite._tests:
589
if isinstance(item, unittest.TestCase):
591
elif isinstance(item, unittest.TestSuite):
592
for r in iter_suite_tests(item):
595
raise Exception('unknown object %r inside test suite %r'
599
class TestSkipped(Exception):
600
"""Indicates that a test was intentionally skipped, rather than failing."""
603
class KnownFailure(AssertionError):
604
"""Indicates that a test failed in a precisely expected manner.
606
Such failures dont block the whole test suite from passing because they are
607
indicators of partially completed code or of future work. We have an
608
explicit error for them so that we can ensure that they are always visible:
609
KnownFailures are always shown in the output of bzr selftest.
613
class UnavailableFeature(Exception):
614
"""A feature required for this test was not available.
616
The feature should be used to construct the exception.
620
class CommandFailed(Exception):
624
class StringIOWrapper(object):
625
"""A wrapper around cStringIO which just adds an encoding attribute.
627
Internally we can check sys.stdout to see what the output encoding
628
should be. However, cStringIO has no encoding attribute that we can
629
set. So we wrap it instead.
634
def __init__(self, s=None):
636
self.__dict__['_cstring'] = StringIO(s)
638
self.__dict__['_cstring'] = StringIO()
640
def __getattr__(self, name, getattr=getattr):
641
return getattr(self.__dict__['_cstring'], name)
643
def __setattr__(self, name, val):
644
if name == 'encoding':
645
self.__dict__['encoding'] = val
647
return setattr(self._cstring, name, val)
650
class TestUIFactory(ui.CLIUIFactory):
651
"""A UI Factory for testing.
653
Hide the progress bar but emit note()s.
655
Allows get_password to be tested without real tty attached.
662
super(TestUIFactory, self).__init__()
663
if stdin is not None:
664
# We use a StringIOWrapper to be able to test various
665
# encodings, but the user is still responsible to
666
# encode the string and to set the encoding attribute
667
# of StringIOWrapper.
668
self.stdin = StringIOWrapper(stdin)
670
self.stdout = sys.stdout
674
self.stderr = sys.stderr
679
"""See progress.ProgressBar.clear()."""
681
def clear_term(self):
682
"""See progress.ProgressBar.clear_term()."""
684
def clear_term(self):
685
"""See progress.ProgressBar.clear_term()."""
688
"""See progress.ProgressBar.finished()."""
690
def note(self, fmt_string, *args, **kwargs):
691
"""See progress.ProgressBar.note()."""
692
self.stdout.write((fmt_string + "\n") % args)
694
def progress_bar(self):
697
def nested_progress_bar(self):
700
def update(self, message, count=None, total=None):
701
"""See progress.ProgressBar.update()."""
703
def get_non_echoed_password(self, prompt):
704
"""Get password from stdin without trying to handle the echo mode"""
706
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
707
password = self.stdin.readline()
710
if password[-1] == '\n':
711
password = password[:-1]
715
class TestCase(unittest.TestCase):
716
"""Base class for bzr unit tests.
718
Tests that need access to disk resources should subclass
719
TestCaseInTempDir not TestCase.
721
Error and debug log messages are redirected from their usual
722
location into a temporary file, the contents of which can be
723
retrieved by _get_log(). We use a real OS file, not an in-memory object,
724
so that it can also capture file IO. When the test completes this file
725
is read into memory and removed from disk.
727
There are also convenience functions to invoke bzr's command-line
728
routine, and to build and check bzr trees.
730
In addition to the usual method of overriding tearDown(), this class also
731
allows subclasses to register functions into the _cleanups list, which is
732
run in order as the object is torn down. It's less likely this will be
733
accidentally overlooked.
736
_log_file_name = None
738
_keep_log_file = False
739
# record lsprof data when performing benchmark calls.
740
_gather_lsprof_in_benchmarks = False
742
def __init__(self, methodName='testMethod'):
743
super(TestCase, self).__init__(methodName)
747
unittest.TestCase.setUp(self)
748
self._cleanEnvironment()
749
bzrlib.trace.disable_default_logging()
752
self._benchcalls = []
753
self._benchtime = None
755
self._clear_debug_flags()
757
def _clear_debug_flags(self):
758
"""Prevent externally set debug flags affecting tests.
760
Tests that want to use debug flags can just set them in the
761
debug_flags set during setup/teardown.
763
self._preserved_debug_flags = set(debug.debug_flags)
764
debug.debug_flags.clear()
765
self.addCleanup(self._restore_debug_flags)
767
def _clear_hooks(self):
768
# prevent hooks affecting tests
770
import bzrlib.smart.server
771
self._preserved_hooks = {
772
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
773
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
775
self.addCleanup(self._restoreHooks)
776
# reset all hooks to an empty instance of the appropriate type
777
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
778
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
780
def _silenceUI(self):
781
"""Turn off UI for duration of test"""
782
# by default the UI is off; tests can turn it on if they want it.
783
saved = ui.ui_factory
785
ui.ui_factory = saved
786
ui.ui_factory = ui.SilentUIFactory()
787
self.addCleanup(_restore)
789
def _ndiff_strings(self, a, b):
790
"""Return ndiff between two strings containing lines.
792
A trailing newline is added if missing to make the strings
794
if b and b[-1] != '\n':
796
if a and a[-1] != '\n':
798
difflines = difflib.ndiff(a.splitlines(True),
800
linejunk=lambda x: False,
801
charjunk=lambda x: False)
802
return ''.join(difflines)
804
def assertEqual(self, a, b, message=''):
808
except UnicodeError, e:
809
# If we can't compare without getting a UnicodeError, then
810
# obviously they are different
811
mutter('UnicodeError: %s', e)
814
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
816
pformat(a), pformat(b)))
818
assertEquals = assertEqual
820
def assertEqualDiff(self, a, b, message=None):
821
"""Assert two texts are equal, if not raise an exception.
823
This is intended for use with multi-line strings where it can
824
be hard to find the differences by eye.
826
# TODO: perhaps override assertEquals to call this for strings?
830
message = "texts not equal:\n"
831
raise AssertionError(message +
832
self._ndiff_strings(a, b))
834
def assertEqualMode(self, mode, mode_test):
835
self.assertEqual(mode, mode_test,
836
'mode mismatch %o != %o' % (mode, mode_test))
838
def assertStartsWith(self, s, prefix):
839
if not s.startswith(prefix):
840
raise AssertionError('string %r does not start with %r' % (s, prefix))
842
def assertEndsWith(self, s, suffix):
843
"""Asserts that s ends with suffix."""
844
if not s.endswith(suffix):
845
raise AssertionError('string %r does not end with %r' % (s, suffix))
847
def assertContainsRe(self, haystack, needle_re):
848
"""Assert that a contains something matching a regular expression."""
849
if not re.search(needle_re, haystack):
850
raise AssertionError('pattern "%r" not found in "%r"'
851
% (needle_re, haystack))
853
def assertNotContainsRe(self, haystack, needle_re):
854
"""Assert that a does not match a regular expression"""
855
if re.search(needle_re, haystack):
856
raise AssertionError('pattern "%s" found in "%s"'
857
% (needle_re, haystack))
859
def assertSubset(self, sublist, superlist):
860
"""Assert that every entry in sublist is present in superlist."""
862
for entry in sublist:
863
if entry not in superlist:
864
missing.append(entry)
866
raise AssertionError("value(s) %r not present in container %r" %
867
(missing, superlist))
869
def assertListRaises(self, excClass, func, *args, **kwargs):
870
"""Fail unless excClass is raised when the iterator from func is used.
872
Many functions can return generators this makes sure
873
to wrap them in a list() call to make sure the whole generator
874
is run, and that the proper exception is raised.
877
list(func(*args, **kwargs))
881
if getattr(excClass,'__name__', None) is not None:
882
excName = excClass.__name__
884
excName = str(excClass)
885
raise self.failureException, "%s not raised" % excName
887
def assertRaises(self, excClass, callableObj, *args, **kwargs):
888
"""Assert that a callable raises a particular exception.
890
:param excClass: As for the except statement, this may be either an
891
exception class, or a tuple of classes.
892
:param callableObj: A callable, will be passed ``*args`` and
895
Returns the exception so that you can examine it.
898
callableObj(*args, **kwargs)
902
if getattr(excClass,'__name__', None) is not None:
903
excName = excClass.__name__
906
excName = str(excClass)
907
raise self.failureException, "%s not raised" % excName
909
def assertIs(self, left, right, message=None):
910
if not (left is right):
911
if message is not None:
912
raise AssertionError(message)
914
raise AssertionError("%r is not %r." % (left, right))
916
def assertIsNot(self, left, right, message=None):
918
if message is not None:
919
raise AssertionError(message)
921
raise AssertionError("%r is %r." % (left, right))
923
def assertTransportMode(self, transport, path, mode):
924
"""Fail if a path does not have mode mode.
926
If modes are not supported on this transport, the assertion is ignored.
928
if not transport._can_roundtrip_unix_modebits():
930
path_stat = transport.stat(path)
931
actual_mode = stat.S_IMODE(path_stat.st_mode)
932
self.assertEqual(mode, actual_mode,
933
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
935
def assertIsInstance(self, obj, kls):
936
"""Fail if obj is not an instance of kls"""
937
if not isinstance(obj, kls):
938
self.fail("%r is an instance of %s rather than %s" % (
939
obj, obj.__class__, kls))
941
def expectFailure(self, reason, assertion, *args, **kwargs):
942
"""Invoke a test, expecting it to fail for the given reason.
944
This is for assertions that ought to succeed, but currently fail.
945
(The failure is *expected* but not *wanted*.) Please be very precise
946
about the failure you're expecting. If a new bug is introduced,
947
AssertionError should be raised, not KnownFailure.
949
Frequently, expectFailure should be followed by an opposite assertion.
952
Intended to be used with a callable that raises AssertionError as the
953
'assertion' parameter. args and kwargs are passed to the 'assertion'.
955
Raises KnownFailure if the test fails. Raises AssertionError if the
960
self.expectFailure('Math is broken', self.assertNotEqual, 54,
962
self.assertEqual(42, dynamic_val)
964
This means that a dynamic_val of 54 will cause the test to raise
965
a KnownFailure. Once math is fixed and the expectFailure is removed,
966
only a dynamic_val of 42 will allow the test to pass. Anything other
967
than 54 or 42 will cause an AssertionError.
970
assertion(*args, **kwargs)
971
except AssertionError:
972
raise KnownFailure(reason)
974
self.fail('Unexpected success. Should have failed: %s' % reason)
976
def _capture_warnings(self, a_callable, *args, **kwargs):
977
"""A helper for callDeprecated and applyDeprecated.
979
:param a_callable: A callable to call.
980
:param args: The positional arguments for the callable
981
:param kwargs: The keyword arguments for the callable
982
:return: A tuple (warnings, result). result is the result of calling
983
a_callable(``*args``, ``**kwargs``).
986
def capture_warnings(msg, cls=None, stacklevel=None):
987
# we've hooked into a deprecation specific callpath,
988
# only deprecations should getting sent via it.
989
self.assertEqual(cls, DeprecationWarning)
990
local_warnings.append(msg)
991
original_warning_method = symbol_versioning.warn
992
symbol_versioning.set_warning_method(capture_warnings)
994
result = a_callable(*args, **kwargs)
996
symbol_versioning.set_warning_method(original_warning_method)
997
return (local_warnings, result)
999
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1000
"""Call a deprecated callable without warning the user.
1002
Note that this only captures warnings raised by symbol_versioning.warn,
1003
not other callers that go direct to the warning module.
1005
:param deprecation_format: The deprecation format that the callable
1006
should have been deprecated with. This is the same type as the
1007
parameter to deprecated_method/deprecated_function. If the
1008
callable is not deprecated with this format, an assertion error
1010
:param a_callable: A callable to call. This may be a bound method or
1011
a regular function. It will be called with ``*args`` and
1013
:param args: The positional arguments for the callable
1014
:param kwargs: The keyword arguments for the callable
1015
:return: The result of a_callable(``*args``, ``**kwargs``)
1017
call_warnings, result = self._capture_warnings(a_callable,
1019
expected_first_warning = symbol_versioning.deprecation_string(
1020
a_callable, deprecation_format)
1021
if len(call_warnings) == 0:
1022
self.fail("No deprecation warning generated by call to %s" %
1024
self.assertEqual(expected_first_warning, call_warnings[0])
1027
def callDeprecated(self, expected, callable, *args, **kwargs):
1028
"""Assert that a callable is deprecated in a particular way.
1030
This is a very precise test for unusual requirements. The
1031
applyDeprecated helper function is probably more suited for most tests
1032
as it allows you to simply specify the deprecation format being used
1033
and will ensure that that is issued for the function being called.
1035
Note that this only captures warnings raised by symbol_versioning.warn,
1036
not other callers that go direct to the warning module.
1038
:param expected: a list of the deprecation warnings expected, in order
1039
:param callable: The callable to call
1040
:param args: The positional arguments for the callable
1041
:param kwargs: The keyword arguments for the callable
1043
call_warnings, result = self._capture_warnings(callable,
1045
self.assertEqual(expected, call_warnings)
1048
def _startLogFile(self):
1049
"""Send bzr and test log messages to a temporary file.
1051
The file is removed as the test is torn down.
1053
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1054
self._log_file = os.fdopen(fileno, 'w+')
1055
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1056
self._log_file_name = name
1057
self.addCleanup(self._finishLogFile)
1059
def _finishLogFile(self):
1060
"""Finished with the log file.
1062
Close the file and delete it, unless setKeepLogfile was called.
1064
if self._log_file is None:
1066
bzrlib.trace.disable_test_log(self._log_nonce)
1067
self._log_file.close()
1068
self._log_file = None
1069
if not self._keep_log_file:
1070
os.remove(self._log_file_name)
1071
self._log_file_name = None
1073
def setKeepLogfile(self):
1074
"""Make the logfile not be deleted when _finishLogFile is called."""
1075
self._keep_log_file = True
1077
def addCleanup(self, callable):
1078
"""Arrange to run a callable when this case is torn down.
1080
Callables are run in the reverse of the order they are registered,
1081
ie last-in first-out.
1083
if callable in self._cleanups:
1084
raise ValueError("cleanup function %r already registered on %s"
1086
self._cleanups.append(callable)
1088
def _cleanEnvironment(self):
1090
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1091
'HOME': os.getcwd(),
1092
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1094
'BZREMAIL': None, # may still be present in the environment
1096
'BZR_PROGRESS_BAR': None,
1100
'https_proxy': None,
1101
'HTTPS_PROXY': None,
1106
# Nobody cares about these ones AFAIK. So far at
1107
# least. If you do (care), please update this comment
1111
'BZR_REMOTE_PATH': None,
1114
self.addCleanup(self._restoreEnvironment)
1115
for name, value in new_env.iteritems():
1116
self._captureVar(name, value)
1118
def _captureVar(self, name, newvalue):
1119
"""Set an environment variable, and reset it when finished."""
1120
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1122
def _restore_debug_flags(self):
1123
debug.debug_flags.clear()
1124
debug.debug_flags.update(self._preserved_debug_flags)
1126
def _restoreEnvironment(self):
1127
for name, value in self.__old_env.iteritems():
1128
osutils.set_or_unset_env(name, value)
1130
def _restoreHooks(self):
1131
for klass, hooks in self._preserved_hooks.items():
1132
setattr(klass, 'hooks', hooks)
1134
def knownFailure(self, reason):
1135
"""This test has failed for some known reason."""
1136
raise KnownFailure(reason)
1138
def run(self, result=None):
1139
if result is None: result = self.defaultTestResult()
1140
for feature in getattr(self, '_test_needs_features', []):
1141
if not feature.available():
1142
result.startTest(self)
1143
if getattr(result, 'addNotSupported', None):
1144
result.addNotSupported(self, feature)
1146
result.addSuccess(self)
1147
result.stopTest(self)
1149
return unittest.TestCase.run(self, result)
1153
unittest.TestCase.tearDown(self)
1155
def time(self, callable, *args, **kwargs):
1156
"""Run callable and accrue the time it takes to the benchmark time.
1158
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1159
this will cause lsprofile statistics to be gathered and stored in
1162
if self._benchtime is None:
1166
if not self._gather_lsprof_in_benchmarks:
1167
return callable(*args, **kwargs)
1169
# record this benchmark
1170
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1172
self._benchcalls.append(((callable, args, kwargs), stats))
1175
self._benchtime += time.time() - start
1177
def _runCleanups(self):
1178
"""Run registered cleanup functions.
1180
This should only be called from TestCase.tearDown.
1182
# TODO: Perhaps this should keep running cleanups even if
1183
# one of them fails?
1185
# Actually pop the cleanups from the list so tearDown running
1186
# twice is safe (this happens for skipped tests).
1187
while self._cleanups:
1188
self._cleanups.pop()()
1190
def log(self, *args):
1193
def _get_log(self, keep_log_file=False):
1194
"""Return as a string the log for this test. If the file is still
1195
on disk and keep_log_file=False, delete the log file and store the
1196
content in self._log_contents."""
1197
# flush the log file, to get all content
1199
bzrlib.trace._trace_file.flush()
1200
if self._log_contents:
1201
return self._log_contents
1202
if self._log_file_name is not None:
1203
logfile = open(self._log_file_name)
1205
log_contents = logfile.read()
1208
if not keep_log_file:
1209
self._log_contents = log_contents
1211
os.remove(self._log_file_name)
1213
if sys.platform == 'win32' and e.errno == errno.EACCES:
1214
print >>sys.stderr, ('Unable to delete log file '
1215
' %r' % self._log_file_name)
1220
return "DELETED log file to reduce memory footprint"
1222
@deprecated_method(zero_eighteen)
1223
def capture(self, cmd, retcode=0):
1224
"""Shortcut that splits cmd into words, runs, and returns stdout"""
1225
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
1227
def requireFeature(self, feature):
1228
"""This test requires a specific feature is available.
1230
:raises UnavailableFeature: When feature is not available.
1232
if not feature.available():
1233
raise UnavailableFeature(feature)
1235
@deprecated_method(zero_eighteen)
1236
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
1238
"""Invoke bzr and return (stdout, stderr).
1240
Don't call this method, just use run_bzr() which is equivalent.
1242
:param argv: Arguments to invoke bzr. This may be either a
1243
single string, in which case it is split by shlex into words,
1244
or a list of arguments.
1245
:param retcode: Expected return code, or None for don't-care.
1246
:param encoding: Encoding for sys.stdout and sys.stderr
1247
:param stdin: A string to be used as stdin for the command.
1248
:param working_dir: Change to this directory before running
1250
return self._run_bzr_autosplit(argv, retcode=retcode,
1251
encoding=encoding, stdin=stdin, working_dir=working_dir,
1254
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1256
"""Run bazaar command line, splitting up a string command line."""
1257
if isinstance(args, basestring):
1258
args = list(shlex.split(args))
1259
return self._run_bzr_core(args, retcode=retcode,
1260
encoding=encoding, stdin=stdin, working_dir=working_dir,
1263
def _run_bzr_core(self, args, retcode, encoding, stdin,
1265
if encoding is None:
1266
encoding = bzrlib.user_encoding
1267
stdout = StringIOWrapper()
1268
stderr = StringIOWrapper()
1269
stdout.encoding = encoding
1270
stderr.encoding = encoding
1272
self.log('run bzr: %r', args)
1273
# FIXME: don't call into logging here
1274
handler = logging.StreamHandler(stderr)
1275
handler.setLevel(logging.INFO)
1276
logger = logging.getLogger('')
1277
logger.addHandler(handler)
1278
old_ui_factory = ui.ui_factory
1279
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1282
if working_dir is not None:
1283
cwd = osutils.getcwd()
1284
os.chdir(working_dir)
1287
result = self.apply_redirected(ui.ui_factory.stdin,
1289
bzrlib.commands.run_bzr_catch_errors,
1292
logger.removeHandler(handler)
1293
ui.ui_factory = old_ui_factory
1297
out = stdout.getvalue()
1298
err = stderr.getvalue()
1300
self.log('output:\n%r', out)
1302
self.log('errors:\n%r', err)
1303
if retcode is not None:
1304
self.assertEquals(retcode, result,
1305
message='Unexpected return code')
27
1308
def run_bzr(self, *args, **kwargs):
28
retcode = kwargs.get('retcode', 0)
29
self.assertEquals(bzrlib.commands.run_bzr(args), retcode)
32
def selftest(verbose=False):
33
from unittest import TestLoader, TestSuite
34
import bzrlib, bzrlib.store, bzrlib.inventory, bzrlib.branch
35
import bzrlib.osutils, bzrlib.commands, bzrlib.merge3, bzrlib.plugin
36
from doctest import DocTestSuite
43
global MODULES_TO_TEST, MODULES_TO_DOCTEST
46
['bzrlib.selftest.whitebox',
47
'bzrlib.selftest.versioning',
48
'bzrlib.selftest.testinv',
49
'bzrlib.selftest.testmerge3',
50
'bzrlib.selftest.testhashcache',
51
'bzrlib.selftest.teststatus',
52
'bzrlib.selftest.testlog',
53
'bzrlib.selftest.blackbox',
54
'bzrlib.selftest.testrevisionnamespaces',
55
'bzrlib.selftest.testbranch',
56
'bzrlib.selftest.testrevision',
58
'bzrlib.selftest.testdiff',
1309
"""Invoke bzr, as if it were run from the command line.
1311
The argument list should not include the bzr program name - the
1312
first argument is normally the bzr command. Arguments may be
1313
passed in three ways:
1315
1- A list of strings, eg ["commit", "a"]. This is recommended
1316
when the command contains whitespace or metacharacters, or
1317
is built up at run time.
1319
2- A single string, eg "add a". This is the most convenient
1320
for hardcoded commands.
1322
3- Several varargs parameters, eg run_bzr("add", "a").
1323
This is not recommended for new code.
1325
This runs bzr through the interface that catches and reports
1326
errors, and with logging set to something approximating the
1327
default, so that error reporting can be checked.
1329
This should be the main method for tests that want to exercise the
1330
overall behavior of the bzr application (rather than a unit test
1331
or a functional test of the library.)
1333
This sends the stdout/stderr results into the test's log,
1334
where it may be useful for debugging. See also run_captured.
1336
:keyword stdin: A string to be used as stdin for the command.
1337
:keyword retcode: The status code the command should return;
1339
:keyword working_dir: The directory to run the command in
1340
:keyword error_regexes: A list of expected error messages. If
1341
specified they must be seen in the error output of the command.
1343
retcode = kwargs.pop('retcode', 0)
1344
encoding = kwargs.pop('encoding', None)
1345
stdin = kwargs.pop('stdin', None)
1346
working_dir = kwargs.pop('working_dir', None)
1347
error_regexes = kwargs.pop('error_regexes', [])
1350
if isinstance(args[0], (list, basestring)):
1353
symbol_versioning.warn(zero_eighteen % "passing varargs to run_bzr",
1354
DeprecationWarning, stacklevel=3)
1356
out, err = self._run_bzr_autosplit(args=args,
1358
encoding=encoding, stdin=stdin, working_dir=working_dir,
1361
for regex in error_regexes:
1362
self.assertContainsRe(err, regex)
1365
def run_bzr_decode(self, *args, **kwargs):
1366
if 'encoding' in kwargs:
1367
encoding = kwargs['encoding']
1369
encoding = bzrlib.user_encoding
1370
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1372
def run_bzr_error(self, error_regexes, *args, **kwargs):
1373
"""Run bzr, and check that stderr contains the supplied regexes
1375
:param error_regexes: Sequence of regular expressions which
1376
must each be found in the error output. The relative ordering
1378
:param args: command-line arguments for bzr
1379
:param kwargs: Keyword arguments which are interpreted by run_bzr
1380
This function changes the default value of retcode to be 3,
1381
since in most cases this is run when you expect bzr to fail.
1383
:return: (out, err) The actual output of running the command (in case
1384
you want to do more inspection)
1388
# Make sure that commit is failing because there is nothing to do
1389
self.run_bzr_error(['no changes to commit'],
1390
'commit', '-m', 'my commit comment')
1391
# Make sure --strict is handling an unknown file, rather than
1392
# giving us the 'nothing to do' error
1393
self.build_tree(['unknown'])
1394
self.run_bzr_error(['Commit refused because there are unknown files'],
1395
'commit', '--strict', '-m', 'my commit comment')
1397
kwargs.setdefault('retcode', 3)
1398
kwargs['error_regexes'] = error_regexes
1399
out, err = self.run_bzr(*args, **kwargs)
1402
def run_bzr_subprocess(self, *args, **kwargs):
1403
"""Run bzr in a subprocess for testing.
1405
This starts a new Python interpreter and runs bzr in there.
1406
This should only be used for tests that have a justifiable need for
1407
this isolation: e.g. they are testing startup time, or signal
1408
handling, or early startup code, etc. Subprocess code can't be
1409
profiled or debugged so easily.
1411
:keyword retcode: The status code that is expected. Defaults to 0. If
1412
None is supplied, the status code is not checked.
1413
:keyword env_changes: A dictionary which lists changes to environment
1414
variables. A value of None will unset the env variable.
1415
The values must be strings. The change will only occur in the
1416
child, so you don't need to fix the environment after running.
1417
:keyword universal_newlines: Convert CRLF => LF
1418
:keyword allow_plugins: By default the subprocess is run with
1419
--no-plugins to ensure test reproducibility. Also, it is possible
1420
for system-wide plugins to create unexpected output on stderr,
1421
which can cause unnecessary test failures.
1423
env_changes = kwargs.get('env_changes', {})
1424
working_dir = kwargs.get('working_dir', None)
1425
allow_plugins = kwargs.get('allow_plugins', False)
1426
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1427
working_dir=working_dir,
1428
allow_plugins=allow_plugins)
1429
# We distinguish between retcode=None and retcode not passed.
1430
supplied_retcode = kwargs.get('retcode', 0)
1431
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1432
universal_newlines=kwargs.get('universal_newlines', False),
1435
def start_bzr_subprocess(self, process_args, env_changes=None,
1436
skip_if_plan_to_signal=False,
1438
allow_plugins=False):
1439
"""Start bzr in a subprocess for testing.
1441
This starts a new Python interpreter and runs bzr in there.
1442
This should only be used for tests that have a justifiable need for
1443
this isolation: e.g. they are testing startup time, or signal
1444
handling, or early startup code, etc. Subprocess code can't be
1445
profiled or debugged so easily.
1447
:param process_args: a list of arguments to pass to the bzr executable,
1448
for example ``['--version']``.
1449
:param env_changes: A dictionary which lists changes to environment
1450
variables. A value of None will unset the env variable.
1451
The values must be strings. The change will only occur in the
1452
child, so you don't need to fix the environment after running.
1453
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1455
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1457
:returns: Popen object for the started process.
1459
if skip_if_plan_to_signal:
1460
if not getattr(os, 'kill', None):
1461
raise TestSkipped("os.kill not available.")
1463
if env_changes is None:
1467
def cleanup_environment():
1468
for env_var, value in env_changes.iteritems():
1469
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1471
def restore_environment():
1472
for env_var, value in old_env.iteritems():
1473
osutils.set_or_unset_env(env_var, value)
1475
bzr_path = self.get_bzr_path()
1478
if working_dir is not None:
1479
cwd = osutils.getcwd()
1480
os.chdir(working_dir)
1483
# win32 subprocess doesn't support preexec_fn
1484
# so we will avoid using it on all platforms, just to
1485
# make sure the code path is used, and we don't break on win32
1486
cleanup_environment()
1487
command = [sys.executable, bzr_path]
1488
if not allow_plugins:
1489
command.append('--no-plugins')
1490
command.extend(process_args)
1491
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1493
restore_environment()
1499
def _popen(self, *args, **kwargs):
1500
"""Place a call to Popen.
1502
Allows tests to override this method to intercept the calls made to
1503
Popen for introspection.
1505
return Popen(*args, **kwargs)
1507
def get_bzr_path(self):
1508
"""Return the path of the 'bzr' executable for this test suite."""
1509
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1510
if not os.path.isfile(bzr_path):
1511
# We are probably installed. Assume sys.argv is the right file
1512
bzr_path = sys.argv[0]
1515
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1516
universal_newlines=False, process_args=None):
1517
"""Finish the execution of process.
1519
:param process: the Popen object returned from start_bzr_subprocess.
1520
:param retcode: The status code that is expected. Defaults to 0. If
1521
None is supplied, the status code is not checked.
1522
:param send_signal: an optional signal to send to the process.
1523
:param universal_newlines: Convert CRLF => LF
1524
:returns: (stdout, stderr)
1526
if send_signal is not None:
1527
os.kill(process.pid, send_signal)
1528
out, err = process.communicate()
1530
if universal_newlines:
1531
out = out.replace('\r\n', '\n')
1532
err = err.replace('\r\n', '\n')
1534
if retcode is not None and retcode != process.returncode:
1535
if process_args is None:
1536
process_args = "(unknown args)"
1537
mutter('Output of bzr %s:\n%s', process_args, out)
1538
mutter('Error for bzr %s:\n%s', process_args, err)
1539
self.fail('Command bzr %s failed with retcode %s != %s'
1540
% (process_args, retcode, process.returncode))
1543
def check_inventory_shape(self, inv, shape):
1544
"""Compare an inventory to a list of expected names.
1546
Fail if they are not precisely equal.
1549
shape = list(shape) # copy
1550
for path, ie in inv.entries():
1551
name = path.replace('\\', '/')
1552
if ie.kind == 'directory':
1559
self.fail("expected paths not found in inventory: %r" % shape)
1561
self.fail("unexpected paths found in inventory: %r" % extras)
1563
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1564
a_callable=None, *args, **kwargs):
1565
"""Call callable with redirected std io pipes.
1567
Returns the return code."""
1568
if not callable(a_callable):
1569
raise ValueError("a_callable must be callable.")
1571
stdin = StringIO("")
1573
if getattr(self, "_log_file", None) is not None:
1574
stdout = self._log_file
1578
if getattr(self, "_log_file", None is not None):
1579
stderr = self._log_file
1582
real_stdin = sys.stdin
1583
real_stdout = sys.stdout
1584
real_stderr = sys.stderr
1589
return a_callable(*args, **kwargs)
1591
sys.stdout = real_stdout
1592
sys.stderr = real_stderr
1593
sys.stdin = real_stdin
1595
def reduceLockdirTimeout(self):
1596
"""Reduce the default lock timeout for the duration of the test, so that
1597
if LockContention occurs during a test, it does so quickly.
1599
Tests that expect to provoke LockContention errors should call this.
1601
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1603
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1604
self.addCleanup(resetTimeout)
1605
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1608
class TestCaseWithMemoryTransport(TestCase):
1609
"""Common test class for tests that do not need disk resources.
1611
Tests that need disk resources should derive from TestCaseWithTransport.
1613
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1615
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1616
a directory which does not exist. This serves to help ensure test isolation
1617
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1618
must exist. However, TestCaseWithMemoryTransport does not offer local
1619
file defaults for the transport in tests, nor does it obey the command line
1620
override, so tests that accidentally write to the common directory should
1623
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1624
a .bzr directory that stops us ascending higher into the filesystem.
1630
def __init__(self, methodName='runTest'):
1631
# allow test parameterisation after test construction and before test
1632
# execution. Variables that the parameteriser sets need to be
1633
# ones that are not set by setUp, or setUp will trash them.
1634
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1635
self.vfs_transport_factory = default_transport
1636
self.transport_server = None
1637
self.transport_readonly_server = None
1638
self.__vfs_server = None
1640
def get_transport(self, relpath=None):
1641
"""Return a writeable transport.
1643
This transport is for the test scratch space relative to
1646
:param relpath: a path relative to the base url.
1648
t = get_transport(self.get_url(relpath))
1649
self.assertFalse(t.is_readonly())
1652
def get_readonly_transport(self, relpath=None):
1653
"""Return a readonly transport for the test scratch space
1655
This can be used to test that operations which should only need
1656
readonly access in fact do not try to write.
1658
:param relpath: a path relative to the base url.
1660
t = get_transport(self.get_readonly_url(relpath))
1661
self.assertTrue(t.is_readonly())
1664
def create_transport_readonly_server(self):
1665
"""Create a transport server from class defined at init.
1667
This is mostly a hook for daughter classes.
1669
return self.transport_readonly_server()
1671
def get_readonly_server(self):
1672
"""Get the server instance for the readonly transport
1674
This is useful for some tests with specific servers to do diagnostics.
1676
if self.__readonly_server is None:
1677
if self.transport_readonly_server is None:
1678
# readonly decorator requested
1679
# bring up the server
1680
self.__readonly_server = ReadonlyServer()
1681
self.__readonly_server.setUp(self.get_vfs_only_server())
1683
self.__readonly_server = self.create_transport_readonly_server()
1684
self.__readonly_server.setUp(self.get_vfs_only_server())
1685
self.addCleanup(self.__readonly_server.tearDown)
1686
return self.__readonly_server
1688
def get_readonly_url(self, relpath=None):
1689
"""Get a URL for the readonly transport.
1691
This will either be backed by '.' or a decorator to the transport
1692
used by self.get_url()
1693
relpath provides for clients to get a path relative to the base url.
1694
These should only be downwards relative, not upwards.
1696
base = self.get_readonly_server().get_url()
1697
return self._adjust_url(base, relpath)
1699
def get_vfs_only_server(self):
1700
"""Get the vfs only read/write server instance.
1702
This is useful for some tests with specific servers that need
1705
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1706
is no means to override it.
1708
if self.__vfs_server is None:
1709
self.__vfs_server = MemoryServer()
1710
self.__vfs_server.setUp()
1711
self.addCleanup(self.__vfs_server.tearDown)
1712
return self.__vfs_server
1714
def get_server(self):
1715
"""Get the read/write server instance.
1717
This is useful for some tests with specific servers that need
1720
This is built from the self.transport_server factory. If that is None,
1721
then the self.get_vfs_server is returned.
1723
if self.__server is None:
1724
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1725
return self.get_vfs_only_server()
1727
# bring up a decorated means of access to the vfs only server.
1728
self.__server = self.transport_server()
1730
self.__server.setUp(self.get_vfs_only_server())
1731
except TypeError, e:
1732
# This should never happen; the try:Except here is to assist
1733
# developers having to update code rather than seeing an
1734
# uninformative TypeError.
1735
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1736
self.addCleanup(self.__server.tearDown)
1737
return self.__server
1739
def _adjust_url(self, base, relpath):
1740
"""Get a URL (or maybe a path) for the readwrite transport.
1742
This will either be backed by '.' or to an equivalent non-file based
1744
relpath provides for clients to get a path relative to the base url.
1745
These should only be downwards relative, not upwards.
1747
if relpath is not None and relpath != '.':
1748
if not base.endswith('/'):
1750
# XXX: Really base should be a url; we did after all call
1751
# get_url()! But sometimes it's just a path (from
1752
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1753
# to a non-escaped local path.
1754
if base.startswith('./') or base.startswith('/'):
1757
base += urlutils.escape(relpath)
1760
def get_url(self, relpath=None):
1761
"""Get a URL (or maybe a path) for the readwrite transport.
1763
This will either be backed by '.' or to an equivalent non-file based
1765
relpath provides for clients to get a path relative to the base url.
1766
These should only be downwards relative, not upwards.
1768
base = self.get_server().get_url()
1769
return self._adjust_url(base, relpath)
1771
def get_vfs_only_url(self, relpath=None):
1772
"""Get a URL (or maybe a path for the plain old vfs transport.
1774
This will never be a smart protocol. It always has all the
1775
capabilities of the local filesystem, but it might actually be a
1776
MemoryTransport or some other similar virtual filesystem.
1778
This is the backing transport (if any) of the server returned by
1779
get_url and get_readonly_url.
1781
:param relpath: provides for clients to get a path relative to the base
1782
url. These should only be downwards relative, not upwards.
1785
base = self.get_vfs_only_server().get_url()
1786
return self._adjust_url(base, relpath)
1788
def _make_test_root(self):
1789
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1791
root = tempfile.mkdtemp(prefix='testbzr-', suffix='.tmp')
1792
TestCaseWithMemoryTransport.TEST_ROOT = root
1794
# make a fake bzr directory there to prevent any tests propagating
1795
# up onto the source directory's real branch
1796
bzrdir.BzrDir.create_standalone_workingtree(root)
1798
# The same directory is used by all tests, and we're not specifically
1799
# told when all tests are finished. This will do.
1800
atexit.register(_rmtree_temp_dir, root)
1802
def makeAndChdirToTestDir(self):
1803
"""Create a temporary directories for this one test.
1805
This must set self.test_home_dir and self.test_dir and chdir to
1808
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1810
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1811
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1812
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1814
def make_branch(self, relpath, format=None):
1815
"""Create a branch on the transport at relpath."""
1816
repo = self.make_repository(relpath, format=format)
1817
return repo.bzrdir.create_branch()
1819
def make_bzrdir(self, relpath, format=None):
1821
# might be a relative or absolute path
1822
maybe_a_url = self.get_url(relpath)
1823
segments = maybe_a_url.rsplit('/', 1)
1824
t = get_transport(maybe_a_url)
1825
if len(segments) > 1 and segments[-1] not in ('', '.'):
1829
if isinstance(format, basestring):
1830
format = bzrdir.format_registry.make_bzrdir(format)
1831
return format.initialize_on_transport(t)
1832
except errors.UninitializableFormat:
1833
raise TestSkipped("Format %s is not initializable." % format)
1835
def make_repository(self, relpath, shared=False, format=None):
1836
"""Create a repository on our default transport at relpath.
1838
Note that relpath must be a relative path, not a full url.
1840
# FIXME: If you create a remoterepository this returns the underlying
1841
# real format, which is incorrect. Actually we should make sure that
1842
# RemoteBzrDir returns a RemoteRepository.
1843
# maybe mbp 20070410
1844
made_control = self.make_bzrdir(relpath, format=format)
1845
return made_control.create_repository(shared=shared)
1847
def make_branch_and_memory_tree(self, relpath, format=None):
1848
"""Create a branch on the default transport and a MemoryTree for it."""
1849
b = self.make_branch(relpath, format=format)
1850
return memorytree.MemoryTree.create_on_branch(b)
1852
def overrideEnvironmentForTesting(self):
1853
os.environ['HOME'] = self.test_home_dir
1854
os.environ['BZR_HOME'] = self.test_home_dir
1857
super(TestCaseWithMemoryTransport, self).setUp()
1858
self._make_test_root()
1859
_currentdir = os.getcwdu()
1860
def _leaveDirectory():
1861
os.chdir(_currentdir)
1862
self.addCleanup(_leaveDirectory)
1863
self.makeAndChdirToTestDir()
1864
self.overrideEnvironmentForTesting()
1865
self.__readonly_server = None
1866
self.__server = None
1867
self.reduceLockdirTimeout()
1870
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1871
"""Derived class that runs a test within a temporary directory.
1873
This is useful for tests that need to create a branch, etc.
1875
The directory is created in a slightly complex way: for each
1876
Python invocation, a new temporary top-level directory is created.
1877
All test cases create their own directory within that. If the
1878
tests complete successfully, the directory is removed.
1880
:ivar test_base_dir: The path of the top-level directory for this
1881
test, which contains a home directory and a work directory.
1883
:ivar test_home_dir: An initially empty directory under test_base_dir
1884
which is used as $HOME for this test.
1886
:ivar test_dir: A directory under test_base_dir used as the current
1887
directory when the test proper is run.
1890
OVERRIDE_PYTHON = 'python'
1891
use_numbered_dirs = False
1893
def check_file_contents(self, filename, expect):
1894
self.log("check contents of file %s" % filename)
1895
contents = file(filename, 'r').read()
1896
if contents != expect:
1897
self.log("expected: %r" % expect)
1898
self.log("actually: %r" % contents)
1899
self.fail("contents of %s not as expected" % filename)
1901
def makeAndChdirToTestDir(self):
1902
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1904
For TestCaseInTempDir we create a temporary directory based on the test
1905
name and then create two subdirs - test and home under it.
1907
# create a directory within the top level test directory
1908
candidate_dir = tempfile.mkdtemp(dir=self.TEST_ROOT)
1909
# now create test and home directories within this dir
1910
self.test_base_dir = candidate_dir
1911
self.test_home_dir = self.test_base_dir + '/home'
1912
os.mkdir(self.test_home_dir)
1913
self.test_dir = self.test_base_dir + '/work'
1914
os.mkdir(self.test_dir)
1915
os.chdir(self.test_dir)
1916
# put name of test inside
1917
f = file(self.test_base_dir + '/name', 'w')
1922
self.addCleanup(self.deleteTestDir)
1924
def deleteTestDir(self):
1925
os.chdir(self.TEST_ROOT)
1926
_rmtree_temp_dir(self.test_base_dir)
1928
def build_tree(self, shape, line_endings='binary', transport=None):
1929
"""Build a test tree according to a pattern.
1931
shape is a sequence of file specifications. If the final
1932
character is '/', a directory is created.
1934
This assumes that all the elements in the tree being built are new.
1936
This doesn't add anything to a branch.
1938
:param line_endings: Either 'binary' or 'native'
1939
in binary mode, exact contents are written in native mode, the
1940
line endings match the default platform endings.
1941
:param transport: A transport to write to, for building trees on VFS's.
1942
If the transport is readonly or None, "." is opened automatically.
1945
# It's OK to just create them using forward slashes on windows.
1946
if transport is None or transport.is_readonly():
1947
transport = get_transport(".")
1949
self.assert_(isinstance(name, basestring))
1951
transport.mkdir(urlutils.escape(name[:-1]))
1953
if line_endings == 'binary':
1955
elif line_endings == 'native':
1958
raise errors.BzrError(
1959
'Invalid line ending request %r' % line_endings)
1960
content = "contents of %s%s" % (name.encode('utf-8'), end)
1961
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1963
def build_tree_contents(self, shape):
1964
build_tree_contents(shape)
1966
def assertFileEqual(self, content, path):
1967
"""Fail if path does not contain 'content'."""
1968
self.failUnlessExists(path)
1969
f = file(path, 'rb')
1974
self.assertEqualDiff(content, s)
1976
def failUnlessExists(self, path):
1977
"""Fail unless path or paths, which may be abs or relative, exist."""
1978
if not isinstance(path, basestring):
1980
self.failUnlessExists(p)
1982
self.failUnless(osutils.lexists(path),path+" does not exist")
1984
def failIfExists(self, path):
1985
"""Fail if path or paths, which may be abs or relative, exist."""
1986
if not isinstance(path, basestring):
1988
self.failIfExists(p)
1990
self.failIf(osutils.lexists(path),path+" exists")
1992
def assertInWorkingTree(self,path,root_path='.',tree=None):
1993
"""Assert whether path or paths are in the WorkingTree"""
1995
tree = workingtree.WorkingTree.open(root_path)
1996
if not isinstance(path, basestring):
1998
self.assertInWorkingTree(p,tree=tree)
2000
self.assertIsNot(tree.path2id(path), None,
2001
path+' not in working tree.')
2003
def assertNotInWorkingTree(self,path,root_path='.',tree=None):
2004
"""Assert whether path or paths are not in the WorkingTree"""
2006
tree = workingtree.WorkingTree.open(root_path)
2007
if not isinstance(path, basestring):
2009
self.assertNotInWorkingTree(p,tree=tree)
2011
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2014
class TestCaseWithTransport(TestCaseInTempDir):
2015
"""A test case that provides get_url and get_readonly_url facilities.
2017
These back onto two transport servers, one for readonly access and one for
2020
If no explicit class is provided for readonly access, a
2021
ReadonlyTransportDecorator is used instead which allows the use of non disk
2022
based read write transports.
2024
If an explicit class is provided for readonly access, that server and the
2025
readwrite one must both define get_url() as resolving to os.getcwd().
2028
def get_vfs_only_server(self):
2029
"""See TestCaseWithMemoryTransport.
2031
This is useful for some tests with specific servers that need
2034
if self.__vfs_server is None:
2035
self.__vfs_server = self.vfs_transport_factory()
2036
self.__vfs_server.setUp()
2037
self.addCleanup(self.__vfs_server.tearDown)
2038
return self.__vfs_server
2040
def make_branch_and_tree(self, relpath, format=None):
2041
"""Create a branch on the transport and a tree locally.
2043
If the transport is not a LocalTransport, the Tree can't be created on
2044
the transport. In that case if the vfs_transport_factory is
2045
LocalURLServer the working tree is created in the local
2046
directory backing the transport, and the returned tree's branch and
2047
repository will also be accessed locally. Otherwise a lightweight
2048
checkout is created and returned.
2050
:param format: The BzrDirFormat.
2051
:returns: the WorkingTree.
2053
# TODO: always use the local disk path for the working tree,
2054
# this obviously requires a format that supports branch references
2055
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2057
b = self.make_branch(relpath, format=format)
2059
return b.bzrdir.create_workingtree()
2060
except errors.NotLocalUrl:
2061
# We can only make working trees locally at the moment. If the
2062
# transport can't support them, then we keep the non-disk-backed
2063
# branch and create a local checkout.
2064
if self.vfs_transport_factory is LocalURLServer:
2065
# the branch is colocated on disk, we cannot create a checkout.
2066
# hopefully callers will expect this.
2067
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2068
return local_controldir.create_workingtree()
2070
return b.create_checkout(relpath, lightweight=True)
2072
def assertIsDirectory(self, relpath, transport):
2073
"""Assert that relpath within transport is a directory.
2075
This may not be possible on all transports; in that case it propagates
2076
a TransportNotPossible.
2079
mode = transport.stat(relpath).st_mode
2080
except errors.NoSuchFile:
2081
self.fail("path %s is not a directory; no such file"
2083
if not stat.S_ISDIR(mode):
2084
self.fail("path %s is not a directory; has mode %#o"
2087
def assertTreesEqual(self, left, right):
2088
"""Check that left and right have the same content and properties."""
2089
# we use a tree delta to check for equality of the content, and we
2090
# manually check for equality of other things such as the parents list.
2091
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2092
differences = left.changes_from(right)
2093
self.assertFalse(differences.has_changed(),
2094
"Trees %r and %r are different: %r" % (left, right, differences))
2097
super(TestCaseWithTransport, self).setUp()
2098
self.__vfs_server = None
2101
class ChrootedTestCase(TestCaseWithTransport):
2102
"""A support class that provides readonly urls outside the local namespace.
2104
This is done by checking if self.transport_server is a MemoryServer. if it
2105
is then we are chrooted already, if it is not then an HttpServer is used
2108
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2109
be used without needed to redo it when a different
2110
subclass is in use ?
2114
super(ChrootedTestCase, self).setUp()
2115
if not self.vfs_transport_factory == MemoryServer:
2116
self.transport_readonly_server = HttpServer
2119
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2120
random_order=False):
2121
"""Create a test suite by filtering another one.
2123
:param suite: the source suite
2124
:param pattern: pattern that names must match
2125
:param exclude_pattern: pattern that names must not match, if any
2126
:param random_order: if True, tests in the new suite will be put in
2128
:returns: the newly created suite
2130
return sort_suite_by_re(suite, pattern, exclude_pattern,
2131
random_order, False)
2134
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2135
random_order=False, append_rest=True):
2136
"""Create a test suite by sorting another one.
2138
:param suite: the source suite
2139
:param pattern: pattern that names must match in order to go
2140
first in the new suite
2141
:param exclude_pattern: pattern that names must not match, if any
2142
:param random_order: if True, tests in the new suite will be put in
2144
:param append_rest: if False, pattern is a strict filter and not
2145
just an ordering directive
2146
:returns: the newly created suite
2150
filter_re = re.compile(pattern)
2151
if exclude_pattern is not None:
2152
exclude_re = re.compile(exclude_pattern)
2153
for test in iter_suite_tests(suite):
2155
if exclude_pattern is None or not exclude_re.search(test_id):
2156
if filter_re.search(test_id):
2161
random.shuffle(first)
2162
random.shuffle(second)
2163
return TestUtil.TestSuite(first + second)
2166
def run_suite(suite, name='test', verbose=False, pattern=".*",
2167
stop_on_failure=False,
2168
transport=None, lsprof_timed=None, bench_history=None,
2169
matching_tests_first=None,
2173
exclude_pattern=None,
2175
use_numbered_dirs = bool(numbered_dirs)
2177
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2178
if numbered_dirs is not None:
2179
TestCaseInTempDir.use_numbered_dirs = use_numbered_dirs
2184
runner = TextTestRunner(stream=sys.stdout,
2186
verbosity=verbosity,
2187
bench_history=bench_history,
2188
use_numbered_dirs=use_numbered_dirs,
2189
list_only=list_only,
2191
runner.stop_on_failure=stop_on_failure
2192
# Initialise the random number generator and display the seed used.
2193
# We convert the seed to a long to make it reuseable across invocations.
2194
random_order = False
2195
if random_seed is not None:
2197
if random_seed == "now":
2198
random_seed = long(time.time())
2200
# Convert the seed to a long if we can
2202
random_seed = long(random_seed)
2205
runner.stream.writeln("Randomizing test order using seed %s\n" %
2207
random.seed(random_seed)
2208
# Customise the list of tests if requested
2209
if pattern != '.*' or exclude_pattern is not None or random_order:
2210
if matching_tests_first:
2211
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
2214
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
2216
result = runner.run(suite)
2217
return result.wasSuccessful()
2220
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2222
test_suite_factory=None,
2225
matching_tests_first=None,
2229
exclude_pattern=None):
2230
"""Run the whole test suite under the enhanced runner"""
2231
# XXX: Very ugly way to do this...
2232
# Disable warning about old formats because we don't want it to disturb
2233
# any blackbox tests.
2234
from bzrlib import repository
2235
repository._deprecation_warning_done = True
2237
global default_transport
2238
if transport is None:
2239
transport = default_transport
2240
old_transport = default_transport
2241
default_transport = transport
2243
if test_suite_factory is None:
2244
suite = test_suite()
2246
suite = test_suite_factory()
2247
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2248
stop_on_failure=stop_on_failure,
2249
transport=transport,
2250
lsprof_timed=lsprof_timed,
2251
bench_history=bench_history,
2252
matching_tests_first=matching_tests_first,
2253
numbered_dirs=numbered_dirs,
2254
list_only=list_only,
2255
random_seed=random_seed,
2256
exclude_pattern=exclude_pattern)
2258
default_transport = old_transport
2262
"""Build and return TestSuite for the whole of bzrlib.
2264
This function can be replaced if you need to change the default test
2265
suite on a global basis, but it is not encouraged.
2268
'bzrlib.tests.test_ancestry',
2269
'bzrlib.tests.test_annotate',
2270
'bzrlib.tests.test_api',
2271
'bzrlib.tests.test_atomicfile',
2272
'bzrlib.tests.test_bad_files',
2273
'bzrlib.tests.test_branch',
2274
'bzrlib.tests.test_branchbuilder',
2275
'bzrlib.tests.test_bugtracker',
2276
'bzrlib.tests.test_bundle',
2277
'bzrlib.tests.test_bzrdir',
2278
'bzrlib.tests.test_cache_utf8',
2279
'bzrlib.tests.test_commands',
2280
'bzrlib.tests.test_commit',
2281
'bzrlib.tests.test_commit_merge',
2282
'bzrlib.tests.test_config',
2283
'bzrlib.tests.test_conflicts',
2284
'bzrlib.tests.test_pack',
2285
'bzrlib.tests.test_counted_lock',
2286
'bzrlib.tests.test_decorators',
2287
'bzrlib.tests.test_delta',
2288
'bzrlib.tests.test_deprecated_graph',
2289
'bzrlib.tests.test_diff',
2290
'bzrlib.tests.test_dirstate',
2291
'bzrlib.tests.test_errors',
2292
'bzrlib.tests.test_escaped_store',
2293
'bzrlib.tests.test_extract',
2294
'bzrlib.tests.test_fetch',
2295
'bzrlib.tests.test_ftp_transport',
2296
'bzrlib.tests.test_generate_docs',
2297
'bzrlib.tests.test_generate_ids',
2298
'bzrlib.tests.test_globbing',
2299
'bzrlib.tests.test_gpg',
2300
'bzrlib.tests.test_graph',
2301
'bzrlib.tests.test_hashcache',
2302
'bzrlib.tests.test_help',
2303
'bzrlib.tests.test_hooks',
2304
'bzrlib.tests.test_http',
2305
'bzrlib.tests.test_http_response',
2306
'bzrlib.tests.test_https_ca_bundle',
2307
'bzrlib.tests.test_identitymap',
2308
'bzrlib.tests.test_ignores',
2309
'bzrlib.tests.test_info',
2310
'bzrlib.tests.test_inv',
2311
'bzrlib.tests.test_knit',
2312
'bzrlib.tests.test_lazy_import',
2313
'bzrlib.tests.test_lazy_regex',
2314
'bzrlib.tests.test_lockdir',
2315
'bzrlib.tests.test_lockable_files',
2316
'bzrlib.tests.test_log',
2317
'bzrlib.tests.test_lsprof',
2318
'bzrlib.tests.test_memorytree',
2319
'bzrlib.tests.test_merge',
2320
'bzrlib.tests.test_merge3',
2321
'bzrlib.tests.test_merge_core',
2322
'bzrlib.tests.test_merge_directive',
2323
'bzrlib.tests.test_missing',
2324
'bzrlib.tests.test_msgeditor',
2325
'bzrlib.tests.test_nonascii',
2326
'bzrlib.tests.test_options',
2327
'bzrlib.tests.test_osutils',
2328
'bzrlib.tests.test_osutils_encodings',
2329
'bzrlib.tests.test_patch',
2330
'bzrlib.tests.test_patches',
2331
'bzrlib.tests.test_permissions',
2332
'bzrlib.tests.test_plugins',
2333
'bzrlib.tests.test_progress',
2334
'bzrlib.tests.test_reconcile',
2335
'bzrlib.tests.test_registry',
2336
'bzrlib.tests.test_remote',
2337
'bzrlib.tests.test_repository',
2338
'bzrlib.tests.test_revert',
2339
'bzrlib.tests.test_revision',
2340
'bzrlib.tests.test_revisionnamespaces',
2341
'bzrlib.tests.test_revisiontree',
2342
'bzrlib.tests.test_rio',
2343
'bzrlib.tests.test_sampler',
2344
'bzrlib.tests.test_selftest',
2345
'bzrlib.tests.test_setup',
2346
'bzrlib.tests.test_sftp_transport',
2347
'bzrlib.tests.test_smart',
2348
'bzrlib.tests.test_smart_add',
2349
'bzrlib.tests.test_smart_transport',
2350
'bzrlib.tests.test_smtp_connection',
2351
'bzrlib.tests.test_source',
2352
'bzrlib.tests.test_ssh_transport',
2353
'bzrlib.tests.test_status',
2354
'bzrlib.tests.test_store',
2355
'bzrlib.tests.test_strace',
2356
'bzrlib.tests.test_subsume',
2357
'bzrlib.tests.test_symbol_versioning',
2358
'bzrlib.tests.test_tag',
2359
'bzrlib.tests.test_testament',
2360
'bzrlib.tests.test_textfile',
2361
'bzrlib.tests.test_textmerge',
2362
'bzrlib.tests.test_timestamp',
2363
'bzrlib.tests.test_trace',
2364
'bzrlib.tests.test_transactions',
2365
'bzrlib.tests.test_transform',
2366
'bzrlib.tests.test_transport',
2367
'bzrlib.tests.test_tree',
2368
'bzrlib.tests.test_treebuilder',
2369
'bzrlib.tests.test_tsort',
2370
'bzrlib.tests.test_tuned_gzip',
2371
'bzrlib.tests.test_ui',
2372
'bzrlib.tests.test_upgrade',
2373
'bzrlib.tests.test_urlutils',
2374
'bzrlib.tests.test_versionedfile',
2375
'bzrlib.tests.test_version',
2376
'bzrlib.tests.test_version_info',
2377
'bzrlib.tests.test_weave',
2378
'bzrlib.tests.test_whitebox',
2379
'bzrlib.tests.test_workingtree',
2380
'bzrlib.tests.test_workingtree_4',
2381
'bzrlib.tests.test_wsgi',
2382
'bzrlib.tests.test_xml',
61
# XXX: should also test bzrlib.merge_core, but they seem to be out
62
# of date with the code.
64
for m in (bzrlib.store, bzrlib.inventory, bzrlib.branch,
65
bzrlib.osutils, bzrlib.commands, bzrlib.merge3):
66
if m not in MODULES_TO_DOCTEST:
67
MODULES_TO_DOCTEST.append(m)
70
TestBase.BZRPATH = os.path.join(os.path.realpath(os.path.dirname(bzrlib.__path__[0])), 'bzr')
71
print '%-30s %s' % ('bzr binary', TestBase.BZRPATH)
77
suite.addTest(TestLoader().loadTestsFromNames(testmod_names))
2384
test_transport_implementations = [
2385
'bzrlib.tests.test_transport_implementations',
2386
'bzrlib.tests.test_read_bundle',
2388
suite = TestUtil.TestSuite()
2389
loader = TestUtil.TestLoader()
2390
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2391
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2392
adapter = TransportTestProviderAdapter()
2393
adapt_modules(test_transport_implementations, adapter, loader, suite)
2394
for package in packages_to_test():
2395
suite.addTest(package.test_suite())
79
2396
for m in MODULES_TO_TEST:
80
suite.addTest(TestLoader().loadTestsFromModule(m))
82
for m in (MODULES_TO_DOCTEST):
83
suite.addTest(DocTestSuite(m))
85
for p in bzrlib.plugin.all_plugins:
86
if hasattr(p, 'test_suite'):
87
suite.addTest(p.test_suite())
89
import bzrlib.merge_core
90
suite.addTest(unittest.makeSuite(bzrlib.merge_core.MergeTest, 'test_'))
92
return run_suite(suite, 'testbzr', verbose=verbose)
2397
suite.addTest(loader.loadTestsFromModule(m))
2398
for m in MODULES_TO_DOCTEST:
2400
suite.addTest(doctest.DocTestSuite(m))
2401
except ValueError, e:
2402
print '**failed to get doctest for: %s\n%s' %(m,e)
2404
for name, plugin in bzrlib.plugin.all_plugins().items():
2405
if getattr(plugin, 'test_suite', None) is not None:
2406
default_encoding = sys.getdefaultencoding()
2408
plugin_suite = plugin.test_suite()
2409
except ImportError, e:
2410
bzrlib.trace.warning(
2411
'Unable to test plugin "%s": %s', name, e)
2413
suite.addTest(plugin_suite)
2414
if default_encoding != sys.getdefaultencoding():
2415
bzrlib.trace.warning(
2416
'Plugin "%s" tried to reset default encoding to: %s', name,
2417
sys.getdefaultencoding())
2419
sys.setdefaultencoding(default_encoding)
2423
def adapt_modules(mods_list, adapter, loader, suite):
2424
"""Adapt the modules in mods_list using adapter and add to suite."""
2425
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2426
suite.addTests(adapter.adapt(test))
2429
def _rmtree_temp_dir(dirname):
2430
# If LANG=C we probably have created some bogus paths
2431
# which rmtree(unicode) will fail to delete
2432
# so make sure we are using rmtree(str) to delete everything
2433
# except on win32, where rmtree(str) will fail
2434
# since it doesn't have the property of byte-stream paths
2435
# (they are either ascii or mbcs)
2436
if sys.platform == 'win32':
2437
# make sure we are using the unicode win32 api
2438
dirname = unicode(dirname)
2440
dirname = dirname.encode(sys.getfilesystemencoding())
2442
osutils.rmtree(dirname)
2444
if sys.platform == 'win32' and e.errno == errno.EACCES:
2445
print >>sys.stderr, ('Permission denied: '
2446
'unable to remove testing dir '
2447
'%s' % os.path.basename(dirname))
2452
def clean_selftest_output(root=None, quiet=False):
2453
"""Remove all selftest output directories from root directory.
2455
:param root: root directory for clean
2456
(if ommitted or None then clean current directory).
2457
:param quiet: suppress report about deleting directories
2460
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
2463
for i in os.listdir(root):
2464
if os.path.isdir(i) and re_dir.match(i):
2466
print 'delete directory:', i
2470
class Feature(object):
2471
"""An operating system Feature."""
2474
self._available = None
2476
def available(self):
2477
"""Is the feature available?
2479
:return: True if the feature is available.
2481
if self._available is None:
2482
self._available = self._probe()
2483
return self._available
2486
"""Implement this method in concrete features.
2488
:return: True if the feature is available.
2490
raise NotImplementedError
2493
if getattr(self, 'feature_name', None):
2494
return self.feature_name()
2495
return self.__class__.__name__
2498
class TestScenarioApplier(object):
2499
"""A tool to apply scenarios to tests."""
2501
def adapt(self, test):
2502
"""Return a TestSuite containing a copy of test for each scenario."""
2503
result = unittest.TestSuite()
2504
for scenario in self.scenarios:
2505
result.addTest(self.adapt_test_to_scenario(test, scenario))
2508
def adapt_test_to_scenario(self, test, scenario):
2509
"""Copy test and apply scenario to it.
2511
:param test: A test to adapt.
2512
:param scenario: A tuple describing the scenarion.
2513
The first element of the tuple is the new test id.
2514
The second element is a dict containing attributes to set on the
2516
:return: The adapted test.
2518
from copy import deepcopy
2519
new_test = deepcopy(test)
2520
for name, value in scenario[1].items():
2521
setattr(new_test, name, value)
2522
new_id = "%s(%s)" % (new_test.id(), scenario[0])
2523
new_test.id = lambda: new_id
added
removed
bzrlib/tests/__init__.py
