1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: Perhaps there should be an API to find out if bzr running under the
19
# test suite -- some plugins might want to avoid making intrusive changes if
20
# this is the case. However, we want behaviour under to test to diverge as
21
# little as possible, so this should be used rarely if it's added at all.
22
# (Suggestion from j-a-meinel, 2005-11-24)
24
# NOTE: Some classes in here use camelCaseNaming() rather than
25
# underscore_naming(). That's for consistency with unittest; it's not the
26
# general style of bzrlib. Please continue that consistency when adding e.g.
27
# new assertFoo() methods.
31
from cStringIO import StringIO
37
from pprint import pformat
42
from subprocess import Popen, PIPE
62
import bzrlib.commands
63
import bzrlib.timestamp
65
import bzrlib.inventory
66
import bzrlib.iterablefile
71
# lsprof not available
73
from bzrlib.merge import merge_inner
77
from bzrlib.revision import common_ancestor
79
from bzrlib import symbol_versioning
80
from bzrlib.symbol_versioning import (
85
from bzrlib.transport import get_transport
86
import bzrlib.transport
87
from bzrlib.transport.local import LocalURLServer
88
from bzrlib.transport.memory import MemoryServer
89
from bzrlib.transport.readonly import ReadonlyServer
90
from bzrlib.trace import mutter, note
91
from bzrlib.tests import TestUtil
92
from bzrlib.tests.HttpServer import HttpServer
93
from bzrlib.tests.TestUtil import (
97
from bzrlib.tests.treeshape import build_tree_contents
98
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
100
# Mark this python module as being part of the implementation
101
# of unittest: this gives us better tracebacks where the last
102
# shown frame is the test code, not our assertXYZ.
105
default_transport = LocalURLServer
108
MODULES_TO_DOCTEST = [
121
def packages_to_test():
122
"""Return a list of packages to test.
124
The packages are not globally imported so that import failures are
125
triggered when running selftest, not when importing the command.
128
import bzrlib.tests.blackbox
129
import bzrlib.tests.branch_implementations
130
import bzrlib.tests.bzrdir_implementations
131
import bzrlib.tests.interrepository_implementations
132
import bzrlib.tests.interversionedfile_implementations
133
import bzrlib.tests.intertree_implementations
134
import bzrlib.tests.per_lock
135
import bzrlib.tests.repository_implementations
136
import bzrlib.tests.revisionstore_implementations
137
import bzrlib.tests.tree_implementations
138
import bzrlib.tests.workingtree_implementations
141
bzrlib.tests.blackbox,
142
bzrlib.tests.branch_implementations,
143
bzrlib.tests.bzrdir_implementations,
144
bzrlib.tests.interrepository_implementations,
145
bzrlib.tests.interversionedfile_implementations,
146
bzrlib.tests.intertree_implementations,
147
bzrlib.tests.per_lock,
148
bzrlib.tests.repository_implementations,
149
bzrlib.tests.revisionstore_implementations,
150
bzrlib.tests.tree_implementations,
151
bzrlib.tests.workingtree_implementations,
155
class ExtendedTestResult(unittest._TextTestResult):
156
"""Accepts, reports and accumulates the results of running tests.
158
Compared to this unittest version this class adds support for profiling,
159
benchmarking, stopping as soon as a test fails, and skipping tests.
160
There are further-specialized subclasses for different types of display.
165
def __init__(self, stream, descriptions, verbosity,
168
use_numbered_dirs=False,
170
"""Construct new TestResult.
172
:param bench_history: Optionally, a writable file object to accumulate
175
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
176
if bench_history is not None:
177
from bzrlib.version import _get_bzr_source_tree
178
src_tree = _get_bzr_source_tree()
181
revision_id = src_tree.get_parent_ids()[0]
183
# XXX: if this is a brand new tree, do the same as if there
187
# XXX: If there's no branch, what should we do?
189
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
190
self._bench_history = bench_history
191
self.ui = ui.ui_factory
192
self.num_tests = num_tests
194
self.failure_count = 0
195
self.known_failure_count = 0
197
self.unsupported = {}
199
self.use_numbered_dirs = use_numbered_dirs
200
self._overall_start_time = time.time()
202
def extractBenchmarkTime(self, testCase):
203
"""Add a benchmark time for the current test case."""
204
self._benchmarkTime = getattr(testCase, "_benchtime", None)
206
def _elapsedTestTimeString(self):
207
"""Return a time string for the overall time the current test has taken."""
208
return self._formatTime(time.time() - self._start_time)
210
def _testTimeString(self):
211
if self._benchmarkTime is not None:
213
self._formatTime(self._benchmarkTime),
214
self._elapsedTestTimeString())
216
return " %s" % self._elapsedTestTimeString()
218
def _formatTime(self, seconds):
219
"""Format seconds as milliseconds with leading spaces."""
220
# some benchmarks can take thousands of seconds to run, so we need 8
222
return "%8dms" % (1000 * seconds)
224
def _shortened_test_description(self, test):
226
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
229
def startTest(self, test):
230
unittest.TestResult.startTest(self, test)
231
self.report_test_start(test)
232
test.number = self.count
233
self._recordTestStartTime()
235
def _recordTestStartTime(self):
236
"""Record that a test has started."""
237
self._start_time = time.time()
239
def _cleanupLogFile(self, test):
240
# We can only do this if we have one of our TestCases, not if
242
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
243
if setKeepLogfile is not None:
246
def addError(self, test, err):
247
self.extractBenchmarkTime(test)
248
self._cleanupLogFile(test)
249
if isinstance(err[1], TestSkipped):
250
return self.addSkipped(test, err)
251
elif isinstance(err[1], UnavailableFeature):
252
return self.addNotSupported(test, err[1].args[0])
253
unittest.TestResult.addError(self, test, err)
254
self.error_count += 1
255
self.report_error(test, err)
259
def addFailure(self, test, err):
260
self._cleanupLogFile(test)
261
self.extractBenchmarkTime(test)
262
if isinstance(err[1], KnownFailure):
263
return self.addKnownFailure(test, err)
264
unittest.TestResult.addFailure(self, test, err)
265
self.failure_count += 1
266
self.report_failure(test, err)
270
def addKnownFailure(self, test, err):
271
self.known_failure_count += 1
272
self.report_known_failure(test, err)
274
def addNotSupported(self, test, feature):
275
self.unsupported.setdefault(str(feature), 0)
276
self.unsupported[str(feature)] += 1
277
self.report_unsupported(test, feature)
279
def addSuccess(self, test):
280
self.extractBenchmarkTime(test)
281
if self._bench_history is not None:
282
if self._benchmarkTime is not None:
283
self._bench_history.write("%s %s\n" % (
284
self._formatTime(self._benchmarkTime),
286
self.report_success(test)
287
unittest.TestResult.addSuccess(self, test)
289
def addSkipped(self, test, skip_excinfo):
290
self.report_skip(test, skip_excinfo)
291
# seems best to treat this as success from point-of-view of unittest
292
# -- it actually does nothing so it barely matters :)
295
except KeyboardInterrupt:
298
self.addError(test, test.__exc_info())
300
unittest.TestResult.addSuccess(self, test)
302
def printErrorList(self, flavour, errors):
303
for test, err in errors:
304
self.stream.writeln(self.separator1)
305
self.stream.write("%s: " % flavour)
306
if self.use_numbered_dirs:
307
self.stream.write('#%d ' % test.number)
308
self.stream.writeln(self.getDescription(test))
309
if getattr(test, '_get_log', None) is not None:
311
print >>self.stream, \
312
('vvvv[log from %s]' % test.id()).ljust(78,'-')
313
print >>self.stream, test._get_log()
314
print >>self.stream, \
315
('^^^^[log from %s]' % test.id()).ljust(78,'-')
316
self.stream.writeln(self.separator2)
317
self.stream.writeln("%s" % err)
322
def report_cleaning_up(self):
325
def report_success(self, test):
329
class TextTestResult(ExtendedTestResult):
330
"""Displays progress and results of tests in text form"""
332
def __init__(self, stream, descriptions, verbosity,
336
use_numbered_dirs=False,
338
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
339
bench_history, num_tests, use_numbered_dirs)
341
self.pb = self.ui.nested_progress_bar()
342
self._supplied_pb = False
345
self._supplied_pb = True
346
self.pb.show_pct = False
347
self.pb.show_spinner = False
348
self.pb.show_eta = False,
349
self.pb.show_count = False
350
self.pb.show_bar = False
352
def report_starting(self):
353
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
355
def _progress_prefix_text(self):
356
a = '[%d' % self.count
357
if self.num_tests is not None:
358
a +='/%d' % self.num_tests
359
a += ' in %ds' % (time.time() - self._overall_start_time)
361
a += ', %d errors' % self.error_count
362
if self.failure_count:
363
a += ', %d failed' % self.failure_count
364
if self.known_failure_count:
365
a += ', %d known failures' % self.known_failure_count
367
a += ', %d skipped' % self.skip_count
369
a += ', %d missing features' % len(self.unsupported)
373
def report_test_start(self, test):
376
self._progress_prefix_text()
378
+ self._shortened_test_description(test))
380
def _test_description(self, test):
381
if self.use_numbered_dirs:
382
return '#%d %s' % (self.count,
383
self._shortened_test_description(test))
385
return self._shortened_test_description(test)
387
def report_error(self, test, err):
388
self.pb.note('ERROR: %s\n %s\n',
389
self._test_description(test),
393
def report_failure(self, test, err):
394
self.pb.note('FAIL: %s\n %s\n',
395
self._test_description(test),
399
def report_known_failure(self, test, err):
400
self.pb.note('XFAIL: %s\n%s\n',
401
self._test_description(test), err[1])
403
def report_skip(self, test, skip_excinfo):
406
# at the moment these are mostly not things we can fix
407
# and so they just produce stipple; use the verbose reporter
410
# show test and reason for skip
411
self.pb.note('SKIP: %s\n %s\n',
412
self._shortened_test_description(test),
415
# since the class name was left behind in the still-visible
417
self.pb.note('SKIP: %s', skip_excinfo[1])
419
def report_unsupported(self, test, feature):
420
"""test cannot be run because feature is missing."""
422
def report_cleaning_up(self):
423
self.pb.update('cleaning up...')
426
if not self._supplied_pb:
430
class VerboseTestResult(ExtendedTestResult):
431
"""Produce long output, with one line per test run plus times"""
433
def _ellipsize_to_right(self, a_string, final_width):
434
"""Truncate and pad a string, keeping the right hand side"""
435
if len(a_string) > final_width:
436
result = '...' + a_string[3-final_width:]
439
return result.ljust(final_width)
441
def report_starting(self):
442
self.stream.write('running %d tests...\n' % self.num_tests)
444
def report_test_start(self, test):
446
name = self._shortened_test_description(test)
447
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
448
# numbers, plus a trailing blank
449
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
450
if self.use_numbered_dirs:
451
self.stream.write('%5d ' % self.count)
452
self.stream.write(self._ellipsize_to_right(name,
453
osutils.terminal_width()-36))
455
self.stream.write(self._ellipsize_to_right(name,
456
osutils.terminal_width()-30))
459
def _error_summary(self, err):
461
if self.use_numbered_dirs:
463
return '%s%s' % (indent, err[1])
465
def report_error(self, test, err):
466
self.stream.writeln('ERROR %s\n%s'
467
% (self._testTimeString(),
468
self._error_summary(err)))
470
def report_failure(self, test, err):
471
self.stream.writeln(' FAIL %s\n%s'
472
% (self._testTimeString(),
473
self._error_summary(err)))
475
def report_known_failure(self, test, err):
476
self.stream.writeln('XFAIL %s\n%s'
477
% (self._testTimeString(),
478
self._error_summary(err)))
480
def report_success(self, test):
481
self.stream.writeln(' OK %s' % self._testTimeString())
482
for bench_called, stats in getattr(test, '_benchcalls', []):
483
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
484
stats.pprint(file=self.stream)
485
# flush the stream so that we get smooth output. This verbose mode is
486
# used to show the output in PQM.
489
def report_skip(self, test, skip_excinfo):
491
self.stream.writeln(' SKIP %s\n%s'
492
% (self._testTimeString(),
493
self._error_summary(skip_excinfo)))
495
def report_unsupported(self, test, feature):
496
"""test cannot be run because feature is missing."""
497
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
498
%(self._testTimeString(), feature))
502
class TextTestRunner(object):
503
stop_on_failure = False
510
use_numbered_dirs=False,
513
self.stream = unittest._WritelnDecorator(stream)
514
self.descriptions = descriptions
515
self.verbosity = verbosity
516
self._bench_history = bench_history
517
self.use_numbered_dirs = use_numbered_dirs
518
self.list_only = list_only
521
"Run the given test case or test suite."
522
startTime = time.time()
523
if self.verbosity == 1:
524
result_class = TextTestResult
525
elif self.verbosity >= 2:
526
result_class = VerboseTestResult
527
result = result_class(self.stream,
530
bench_history=self._bench_history,
531
num_tests=test.countTestCases(),
532
use_numbered_dirs=self.use_numbered_dirs,
534
result.stop_early = self.stop_on_failure
535
result.report_starting()
537
if self.verbosity >= 2:
538
self.stream.writeln("Listing tests only ...\n")
540
for t in iter_suite_tests(test):
541
self.stream.writeln("%s" % (t.id()))
543
actionTaken = "Listed"
546
run = result.testsRun
548
stopTime = time.time()
549
timeTaken = stopTime - startTime
551
self.stream.writeln(result.separator2)
552
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
553
run, run != 1 and "s" or "", timeTaken))
554
self.stream.writeln()
555
if not result.wasSuccessful():
556
self.stream.write("FAILED (")
557
failed, errored = map(len, (result.failures, result.errors))
559
self.stream.write("failures=%d" % failed)
561
if failed: self.stream.write(", ")
562
self.stream.write("errors=%d" % errored)
563
if result.known_failure_count:
564
if failed or errored: self.stream.write(", ")
565
self.stream.write("known_failure_count=%d" %
566
result.known_failure_count)
567
self.stream.writeln(")")
569
if result.known_failure_count:
570
self.stream.writeln("OK (known_failures=%d)" %
571
result.known_failure_count)
573
self.stream.writeln("OK")
574
if result.skip_count > 0:
575
skipped = result.skip_count
576
self.stream.writeln('%d test%s skipped' %
577
(skipped, skipped != 1 and "s" or ""))
578
if result.unsupported:
579
for feature, count in sorted(result.unsupported.items()):
580
self.stream.writeln("Missing feature '%s' skipped %d tests." %
586
def iter_suite_tests(suite):
587
"""Return all tests in a suite, recursing through nested suites"""
588
for item in suite._tests:
589
if isinstance(item, unittest.TestCase):
591
elif isinstance(item, unittest.TestSuite):
592
for r in iter_suite_tests(item):
595
raise Exception('unknown object %r inside test suite %r'
599
class TestSkipped(Exception):
600
"""Indicates that a test was intentionally skipped, rather than failing."""
603
class KnownFailure(AssertionError):
604
"""Indicates that a test failed in a precisely expected manner.
606
Such failures dont block the whole test suite from passing because they are
607
indicators of partially completed code or of future work. We have an
608
explicit error for them so that we can ensure that they are always visible:
609
KnownFailures are always shown in the output of bzr selftest.
613
class UnavailableFeature(Exception):
614
"""A feature required for this test was not available.
616
The feature should be used to construct the exception.
620
class CommandFailed(Exception):
624
class StringIOWrapper(object):
625
"""A wrapper around cStringIO which just adds an encoding attribute.
627
Internally we can check sys.stdout to see what the output encoding
628
should be. However, cStringIO has no encoding attribute that we can
629
set. So we wrap it instead.
634
def __init__(self, s=None):
636
self.__dict__['_cstring'] = StringIO(s)
638
self.__dict__['_cstring'] = StringIO()
640
def __getattr__(self, name, getattr=getattr):
641
return getattr(self.__dict__['_cstring'], name)
643
def __setattr__(self, name, val):
644
if name == 'encoding':
645
self.__dict__['encoding'] = val
647
return setattr(self._cstring, name, val)
650
class TestUIFactory(ui.CLIUIFactory):
651
"""A UI Factory for testing.
653
Hide the progress bar but emit note()s.
655
Allows get_password to be tested without real tty attached.
662
super(TestUIFactory, self).__init__()
663
if stdin is not None:
664
# We use a StringIOWrapper to be able to test various
665
# encodings, but the user is still responsible to
666
# encode the string and to set the encoding attribute
667
# of StringIOWrapper.
668
self.stdin = StringIOWrapper(stdin)
670
self.stdout = sys.stdout
674
self.stderr = sys.stderr
679
"""See progress.ProgressBar.clear()."""
681
def clear_term(self):
682
"""See progress.ProgressBar.clear_term()."""
684
def clear_term(self):
685
"""See progress.ProgressBar.clear_term()."""
688
"""See progress.ProgressBar.finished()."""
690
def note(self, fmt_string, *args, **kwargs):
691
"""See progress.ProgressBar.note()."""
692
self.stdout.write((fmt_string + "\n") % args)
694
def progress_bar(self):
697
def nested_progress_bar(self):
700
def update(self, message, count=None, total=None):
701
"""See progress.ProgressBar.update()."""
703
def get_non_echoed_password(self, prompt):
704
"""Get password from stdin without trying to handle the echo mode"""
706
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
707
password = self.stdin.readline()
710
if password[-1] == '\n':
711
password = password[:-1]
715
class TestCase(unittest.TestCase):
716
"""Base class for bzr unit tests.
718
Tests that need access to disk resources should subclass
719
TestCaseInTempDir not TestCase.
721
Error and debug log messages are redirected from their usual
722
location into a temporary file, the contents of which can be
723
retrieved by _get_log(). We use a real OS file, not an in-memory object,
724
so that it can also capture file IO. When the test completes this file
725
is read into memory and removed from disk.
727
There are also convenience functions to invoke bzr's command-line
728
routine, and to build and check bzr trees.
730
In addition to the usual method of overriding tearDown(), this class also
731
allows subclasses to register functions into the _cleanups list, which is
732
run in order as the object is torn down. It's less likely this will be
733
accidentally overlooked.
736
_log_file_name = None
738
_keep_log_file = False
739
# record lsprof data when performing benchmark calls.
740
_gather_lsprof_in_benchmarks = False
742
def __init__(self, methodName='testMethod'):
743
super(TestCase, self).__init__(methodName)
747
unittest.TestCase.setUp(self)
748
self._cleanEnvironment()
749
bzrlib.trace.disable_default_logging()
752
self._benchcalls = []
753
self._benchtime = None
756
def _clear_hooks(self):
757
# prevent hooks affecting tests
759
import bzrlib.smart.server
760
self._preserved_hooks = {
761
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
762
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
764
self.addCleanup(self._restoreHooks)
765
# reset all hooks to an empty instance of the appropriate type
766
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
767
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
768
# FIXME: Rather than constructing new objects like this, how about
769
# having save() and clear() methods on the base Hook class? mbp
772
def _silenceUI(self):
773
"""Turn off UI for duration of test"""
774
# by default the UI is off; tests can turn it on if they want it.
775
saved = ui.ui_factory
777
ui.ui_factory = saved
778
ui.ui_factory = ui.SilentUIFactory()
779
self.addCleanup(_restore)
781
def _ndiff_strings(self, a, b):
782
"""Return ndiff between two strings containing lines.
784
A trailing newline is added if missing to make the strings
786
if b and b[-1] != '\n':
788
if a and a[-1] != '\n':
790
difflines = difflib.ndiff(a.splitlines(True),
792
linejunk=lambda x: False,
793
charjunk=lambda x: False)
794
return ''.join(difflines)
796
def assertEqual(self, a, b, message=''):
800
except UnicodeError, e:
801
# If we can't compare without getting a UnicodeError, then
802
# obviously they are different
803
mutter('UnicodeError: %s', e)
806
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
808
pformat(a), pformat(b)))
810
assertEquals = assertEqual
812
def assertEqualDiff(self, a, b, message=None):
813
"""Assert two texts are equal, if not raise an exception.
815
This is intended for use with multi-line strings where it can
816
be hard to find the differences by eye.
818
# TODO: perhaps override assertEquals to call this for strings?
822
message = "texts not equal:\n"
823
raise AssertionError(message +
824
self._ndiff_strings(a, b))
826
def assertEqualMode(self, mode, mode_test):
827
self.assertEqual(mode, mode_test,
828
'mode mismatch %o != %o' % (mode, mode_test))
830
def assertStartsWith(self, s, prefix):
831
if not s.startswith(prefix):
832
raise AssertionError('string %r does not start with %r' % (s, prefix))
834
def assertEndsWith(self, s, suffix):
835
"""Asserts that s ends with suffix."""
836
if not s.endswith(suffix):
837
raise AssertionError('string %r does not end with %r' % (s, suffix))
839
def assertContainsRe(self, haystack, needle_re):
840
"""Assert that a contains something matching a regular expression."""
841
if not re.search(needle_re, haystack):
842
if '\n' in haystack or len(haystack) > 60:
843
# a long string, format it in a more readable way
844
raise AssertionError(
845
'pattern "%s" not found in\n"""\\\n%s"""\n'
846
% (needle_re, haystack))
848
raise AssertionError('pattern "%s" not found in "%s"'
849
% (needle_re, haystack))
851
def assertNotContainsRe(self, haystack, needle_re):
852
"""Assert that a does not match a regular expression"""
853
if re.search(needle_re, haystack):
854
raise AssertionError('pattern "%s" found in "%s"'
855
% (needle_re, haystack))
857
def assertSubset(self, sublist, superlist):
858
"""Assert that every entry in sublist is present in superlist."""
860
for entry in sublist:
861
if entry not in superlist:
862
missing.append(entry)
864
raise AssertionError("value(s) %r not present in container %r" %
865
(missing, superlist))
867
def assertListRaises(self, excClass, func, *args, **kwargs):
868
"""Fail unless excClass is raised when the iterator from func is used.
870
Many functions can return generators this makes sure
871
to wrap them in a list() call to make sure the whole generator
872
is run, and that the proper exception is raised.
875
list(func(*args, **kwargs))
879
if getattr(excClass,'__name__', None) is not None:
880
excName = excClass.__name__
882
excName = str(excClass)
883
raise self.failureException, "%s not raised" % excName
885
def assertRaises(self, excClass, func, *args, **kwargs):
886
"""Assert that a callable raises a particular exception.
888
:param excClass: As for the except statement, this may be either an
889
exception class, or a tuple of classes.
891
Returns the exception so that you can examine it.
894
func(*args, **kwargs)
898
if getattr(excClass,'__name__', None) is not None:
899
excName = excClass.__name__
902
excName = str(excClass)
903
raise self.failureException, "%s not raised" % excName
905
def assertIs(self, left, right, message=None):
906
if not (left is right):
907
if message is not None:
908
raise AssertionError(message)
910
raise AssertionError("%r is not %r." % (left, right))
912
def assertIsNot(self, left, right, message=None):
914
if message is not None:
915
raise AssertionError(message)
917
raise AssertionError("%r is %r." % (left, right))
919
def assertTransportMode(self, transport, path, mode):
920
"""Fail if a path does not have mode mode.
922
If modes are not supported on this transport, the assertion is ignored.
924
if not transport._can_roundtrip_unix_modebits():
926
path_stat = transport.stat(path)
927
actual_mode = stat.S_IMODE(path_stat.st_mode)
928
self.assertEqual(mode, actual_mode,
929
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
931
def assertIsInstance(self, obj, kls):
932
"""Fail if obj is not an instance of kls"""
933
if not isinstance(obj, kls):
934
self.fail("%r is an instance of %s rather than %s" % (
935
obj, obj.__class__, kls))
937
def expectFailure(self, reason, assertion, *args, **kwargs):
938
"""Invoke a test, expecting it to fail for the given reason.
940
This is for assertions that ought to succeed, but currently fail.
941
(The failure is *expected* but not *wanted*.) Please be very precise
942
about the failure you're expecting. If a new bug is introduced,
943
AssertionError should be raised, not KnownFailure.
945
Frequently, expectFailure should be followed by an opposite assertion.
948
Intended to be used with a callable that raises AssertionError as the
949
'assertion' parameter. args and kwargs are passed to the 'assertion'.
951
Raises KnownFailure if the test fails. Raises AssertionError if the
956
self.expectFailure('Math is broken', self.assertNotEqual, 54,
958
self.assertEqual(42, dynamic_val)
960
This means that a dynamic_val of 54 will cause the test to raise
961
a KnownFailure. Once math is fixed and the expectFailure is removed,
962
only a dynamic_val of 42 will allow the test to pass. Anything other
963
than 54 or 42 will cause an AssertionError.
966
assertion(*args, **kwargs)
967
except AssertionError:
968
raise KnownFailure(reason)
970
self.fail('Unexpected success. Should have failed: %s' % reason)
972
def _capture_warnings(self, a_callable, *args, **kwargs):
973
"""A helper for callDeprecated and applyDeprecated.
975
:param a_callable: A callable to call.
976
:param args: The positional arguments for the callable
977
:param kwargs: The keyword arguments for the callable
978
:return: A tuple (warnings, result). result is the result of calling
979
a_callable(*args, **kwargs).
982
def capture_warnings(msg, cls=None, stacklevel=None):
983
# we've hooked into a deprecation specific callpath,
984
# only deprecations should getting sent via it.
985
self.assertEqual(cls, DeprecationWarning)
986
local_warnings.append(msg)
987
original_warning_method = symbol_versioning.warn
988
symbol_versioning.set_warning_method(capture_warnings)
990
result = a_callable(*args, **kwargs)
992
symbol_versioning.set_warning_method(original_warning_method)
993
return (local_warnings, result)
995
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
996
"""Call a deprecated callable without warning the user.
998
Note that this only captures warnings raised by symbol_versioning.warn,
999
not other callers that go direct to the warning module.
1001
:param deprecation_format: The deprecation format that the callable
1002
should have been deprecated with. This is the same type as the
1003
parameter to deprecated_method/deprecated_function. If the
1004
callable is not deprecated with this format, an assertion error
1006
:param a_callable: A callable to call. This may be a bound method or
1007
a regular function. It will be called with *args and **kwargs.
1008
:param args: The positional arguments for the callable
1009
:param kwargs: The keyword arguments for the callable
1010
:return: The result of a_callable(*args, **kwargs)
1012
call_warnings, result = self._capture_warnings(a_callable,
1014
expected_first_warning = symbol_versioning.deprecation_string(
1015
a_callable, deprecation_format)
1016
if len(call_warnings) == 0:
1017
self.fail("No deprecation warning generated by call to %s" %
1019
self.assertEqual(expected_first_warning, call_warnings[0])
1022
def callDeprecated(self, expected, callable, *args, **kwargs):
1023
"""Assert that a callable is deprecated in a particular way.
1025
This is a very precise test for unusual requirements. The
1026
applyDeprecated helper function is probably more suited for most tests
1027
as it allows you to simply specify the deprecation format being used
1028
and will ensure that that is issued for the function being called.
1030
Note that this only captures warnings raised by symbol_versioning.warn,
1031
not other callers that go direct to the warning module.
1033
:param expected: a list of the deprecation warnings expected, in order
1034
:param callable: The callable to call
1035
:param args: The positional arguments for the callable
1036
:param kwargs: The keyword arguments for the callable
1038
call_warnings, result = self._capture_warnings(callable,
1040
self.assertEqual(expected, call_warnings)
1043
def _startLogFile(self):
1044
"""Send bzr and test log messages to a temporary file.
1046
The file is removed as the test is torn down.
1048
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1049
self._log_file = os.fdopen(fileno, 'w+')
1050
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1051
self._log_file_name = name
1052
self.addCleanup(self._finishLogFile)
1054
def _finishLogFile(self):
1055
"""Finished with the log file.
1057
Close the file and delete it, unless setKeepLogfile was called.
1059
if self._log_file is None:
1061
bzrlib.trace.disable_test_log(self._log_nonce)
1062
self._log_file.close()
1063
self._log_file = None
1064
if not self._keep_log_file:
1065
os.remove(self._log_file_name)
1066
self._log_file_name = None
1068
def setKeepLogfile(self):
1069
"""Make the logfile not be deleted when _finishLogFile is called."""
1070
self._keep_log_file = True
1072
def addCleanup(self, callable):
1073
"""Arrange to run a callable when this case is torn down.
1075
Callables are run in the reverse of the order they are registered,
1076
ie last-in first-out.
1078
if callable in self._cleanups:
1079
raise ValueError("cleanup function %r already registered on %s"
1081
self._cleanups.append(callable)
1083
def _cleanEnvironment(self):
1085
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1086
'HOME': os.getcwd(),
1087
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1089
'BZREMAIL': None, # may still be present in the environment
1091
'BZR_PROGRESS_BAR': None,
1095
'https_proxy': None,
1096
'HTTPS_PROXY': None,
1101
# Nobody cares about these ones AFAIK. So far at
1102
# least. If you do (care), please update this comment
1106
'BZR_REMOTE_PATH': None,
1109
self.addCleanup(self._restoreEnvironment)
1110
for name, value in new_env.iteritems():
1111
self._captureVar(name, value)
1113
def _captureVar(self, name, newvalue):
1114
"""Set an environment variable, and reset it when finished."""
1115
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1117
def _restoreEnvironment(self):
1118
for name, value in self.__old_env.iteritems():
1119
osutils.set_or_unset_env(name, value)
1121
def _restoreHooks(self):
1122
for klass, hooks in self._preserved_hooks.items():
1123
setattr(klass, 'hooks', hooks)
1125
def knownFailure(self, reason):
1126
"""This test has failed for some known reason."""
1127
raise KnownFailure(reason)
1129
def run(self, result=None):
1130
if result is None: result = self.defaultTestResult()
1131
for feature in getattr(self, '_test_needs_features', []):
1132
if not feature.available():
1133
result.startTest(self)
1134
if getattr(result, 'addNotSupported', None):
1135
result.addNotSupported(self, feature)
1137
result.addSuccess(self)
1138
result.stopTest(self)
1140
return unittest.TestCase.run(self, result)
1144
unittest.TestCase.tearDown(self)
1146
def time(self, callable, *args, **kwargs):
1147
"""Run callable and accrue the time it takes to the benchmark time.
1149
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1150
this will cause lsprofile statistics to be gathered and stored in
1153
if self._benchtime is None:
1157
if not self._gather_lsprof_in_benchmarks:
1158
return callable(*args, **kwargs)
1160
# record this benchmark
1161
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1163
self._benchcalls.append(((callable, args, kwargs), stats))
1166
self._benchtime += time.time() - start
1168
def _runCleanups(self):
1169
"""Run registered cleanup functions.
1171
This should only be called from TestCase.tearDown.
1173
# TODO: Perhaps this should keep running cleanups even if
1174
# one of them fails?
1176
# Actually pop the cleanups from the list so tearDown running
1177
# twice is safe (this happens for skipped tests).
1178
while self._cleanups:
1179
self._cleanups.pop()()
1181
def log(self, *args):
1184
def _get_log(self, keep_log_file=False):
1185
"""Return as a string the log for this test. If the file is still
1186
on disk and keep_log_file=False, delete the log file and store the
1187
content in self._log_contents."""
1188
# flush the log file, to get all content
1190
bzrlib.trace._trace_file.flush()
1191
if self._log_contents:
1192
return self._log_contents
1193
if self._log_file_name is not None:
1194
logfile = open(self._log_file_name)
1196
log_contents = logfile.read()
1199
if not keep_log_file:
1200
self._log_contents = log_contents
1202
os.remove(self._log_file_name)
1204
if sys.platform == 'win32' and e.errno == errno.EACCES:
1205
print >>sys.stderr, ('Unable to delete log file '
1206
' %r' % self._log_file_name)
1211
return "DELETED log file to reduce memory footprint"
1213
@deprecated_method(zero_eighteen)
1214
def capture(self, cmd, retcode=0):
1215
"""Shortcut that splits cmd into words, runs, and returns stdout"""
1216
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
1218
def requireFeature(self, feature):
1219
"""This test requires a specific feature is available.
1221
:raises UnavailableFeature: When feature is not available.
1223
if not feature.available():
1224
raise UnavailableFeature(feature)
1226
@deprecated_method(zero_eighteen)
1227
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
1229
"""Invoke bzr and return (stdout, stderr).
1231
Don't call this method, just use run_bzr() which is equivalent.
1233
:param argv: Arguments to invoke bzr. This may be either a
1234
single string, in which case it is split by shlex into words,
1235
or a list of arguments.
1236
:param retcode: Expected return code, or None for don't-care.
1237
:param encoding: Encoding for sys.stdout and sys.stderr
1238
:param stdin: A string to be used as stdin for the command.
1239
:param working_dir: Change to this directory before running
1241
return self._run_bzr_autosplit(argv, retcode=retcode,
1242
encoding=encoding, stdin=stdin, working_dir=working_dir,
1245
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1247
"""Run bazaar command line, splitting up a string command line."""
1248
if isinstance(args, basestring):
1249
args = list(shlex.split(args))
1250
return self._run_bzr_core(args, retcode=retcode,
1251
encoding=encoding, stdin=stdin, working_dir=working_dir,
1254
def _run_bzr_core(self, args, retcode, encoding, stdin,
1256
if encoding is None:
1257
encoding = bzrlib.user_encoding
1258
stdout = StringIOWrapper()
1259
stderr = StringIOWrapper()
1260
stdout.encoding = encoding
1261
stderr.encoding = encoding
1263
self.log('run bzr: %r', args)
1264
# FIXME: don't call into logging here
1265
handler = logging.StreamHandler(stderr)
1266
handler.setLevel(logging.INFO)
1267
logger = logging.getLogger('')
1268
logger.addHandler(handler)
1269
old_ui_factory = ui.ui_factory
1270
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1273
if working_dir is not None:
1274
cwd = osutils.getcwd()
1275
os.chdir(working_dir)
1278
saved_debug_flags = frozenset(debug.debug_flags)
1279
debug.debug_flags.clear()
1281
result = self.apply_redirected(ui.ui_factory.stdin,
1283
bzrlib.commands.run_bzr_catch_errors,
1286
debug.debug_flags.update(saved_debug_flags)
1288
logger.removeHandler(handler)
1289
ui.ui_factory = old_ui_factory
1293
out = stdout.getvalue()
1294
err = stderr.getvalue()
1296
self.log('output:\n%r', out)
1298
self.log('errors:\n%r', err)
1299
if retcode is not None:
1300
self.assertEquals(retcode, result,
1301
message='Unexpected return code')
1304
def run_bzr(self, *args, **kwargs):
1305
"""Invoke bzr, as if it were run from the command line.
1307
The argument list should not include the bzr program name - the
1308
first argument is normally the bzr command. Arguments may be
1309
passed in three ways:
1311
1- A list of strings, eg ["commit", "a"]. This is recommended
1312
when the command contains whitespace or metacharacters, or
1313
is built up at run time.
1315
2- A single string, eg "add a". This is the most convenient
1316
for hardcoded commands.
1318
3- Several varargs parameters, eg run_bzr("add", "a").
1319
This is not recommended for new code.
1321
This runs bzr through the interface that catches and reports
1322
errors, and with logging set to something approximating the
1323
default, so that error reporting can be checked.
1325
This should be the main method for tests that want to exercise the
1326
overall behavior of the bzr application (rather than a unit test
1327
or a functional test of the library.)
1329
:param stdin: A string to be used as stdin for the command.
1330
:param retcode: The status code the command should return;
1332
:param working_dir: The directory to run the command in
1333
:param error_regexes: A list of expected error messages. If
1334
specified they must be seen in the error output of the command.
1336
retcode = kwargs.pop('retcode', 0)
1337
encoding = kwargs.pop('encoding', None)
1338
stdin = kwargs.pop('stdin', None)
1339
working_dir = kwargs.pop('working_dir', None)
1340
error_regexes = kwargs.pop('error_regexes', [])
1343
if isinstance(args[0], (list, basestring)):
1346
## symbol_versioning.warn(zero_eighteen % "passing varargs to run_bzr",
1347
## DeprecationWarning, stacklevel=2)
1348
# not done yet, because too many tests would need to be updated -
1349
# but please don't do this in new code. -- mbp 20070626
1352
out, err = self._run_bzr_autosplit(args=args,
1354
encoding=encoding, stdin=stdin, working_dir=working_dir,
1357
for regex in error_regexes:
1358
self.assertContainsRe(err, regex)
1361
def run_bzr_decode(self, *args, **kwargs):
1362
if 'encoding' in kwargs:
1363
encoding = kwargs['encoding']
1365
encoding = bzrlib.user_encoding
1366
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1368
def run_bzr_error(self, error_regexes, *args, **kwargs):
1369
"""Run bzr, and check that stderr contains the supplied regexes
1371
:param error_regexes: Sequence of regular expressions which
1372
must each be found in the error output. The relative ordering
1374
:param args: command-line arguments for bzr
1375
:param kwargs: Keyword arguments which are interpreted by run_bzr
1376
This function changes the default value of retcode to be 3,
1377
since in most cases this is run when you expect bzr to fail.
1378
:return: (out, err) The actual output of running the command (in case you
1379
want to do more inspection)
1382
# Make sure that commit is failing because there is nothing to do
1383
self.run_bzr_error(['no changes to commit'],
1384
'commit', '-m', 'my commit comment')
1385
# Make sure --strict is handling an unknown file, rather than
1386
# giving us the 'nothing to do' error
1387
self.build_tree(['unknown'])
1388
self.run_bzr_error(['Commit refused because there are unknown files'],
1389
'commit', '--strict', '-m', 'my commit comment')
1391
kwargs.setdefault('retcode', 3)
1392
out, err = self.run_bzr(error_regexes=error_regexes, *args, **kwargs)
1395
def run_bzr_subprocess(self, *args, **kwargs):
1396
"""Run bzr in a subprocess for testing.
1398
This starts a new Python interpreter and runs bzr in there.
1399
This should only be used for tests that have a justifiable need for
1400
this isolation: e.g. they are testing startup time, or signal
1401
handling, or early startup code, etc. Subprocess code can't be
1402
profiled or debugged so easily.
1404
:param retcode: The status code that is expected. Defaults to 0. If
1405
None is supplied, the status code is not checked.
1406
:param env_changes: A dictionary which lists changes to environment
1407
variables. A value of None will unset the env variable.
1408
The values must be strings. The change will only occur in the
1409
child, so you don't need to fix the environment after running.
1410
:param universal_newlines: Convert CRLF => LF
1411
:param allow_plugins: By default the subprocess is run with
1412
--no-plugins to ensure test reproducibility. Also, it is possible
1413
for system-wide plugins to create unexpected output on stderr,
1414
which can cause unnecessary test failures.
1416
env_changes = kwargs.get('env_changes', {})
1417
working_dir = kwargs.get('working_dir', None)
1418
allow_plugins = kwargs.get('allow_plugins', False)
1419
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1420
working_dir=working_dir,
1421
allow_plugins=allow_plugins)
1422
# We distinguish between retcode=None and retcode not passed.
1423
supplied_retcode = kwargs.get('retcode', 0)
1424
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1425
universal_newlines=kwargs.get('universal_newlines', False),
1428
def start_bzr_subprocess(self, process_args, env_changes=None,
1429
skip_if_plan_to_signal=False,
1431
allow_plugins=False):
1432
"""Start bzr in a subprocess for testing.
1434
This starts a new Python interpreter and runs bzr in there.
1435
This should only be used for tests that have a justifiable need for
1436
this isolation: e.g. they are testing startup time, or signal
1437
handling, or early startup code, etc. Subprocess code can't be
1438
profiled or debugged so easily.
1440
:param process_args: a list of arguments to pass to the bzr executable,
1441
for example `['--version']`.
1442
:param env_changes: A dictionary which lists changes to environment
1443
variables. A value of None will unset the env variable.
1444
The values must be strings. The change will only occur in the
1445
child, so you don't need to fix the environment after running.
1446
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1448
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1450
:returns: Popen object for the started process.
1452
if skip_if_plan_to_signal:
1453
if not getattr(os, 'kill', None):
1454
raise TestSkipped("os.kill not available.")
1456
if env_changes is None:
1460
def cleanup_environment():
1461
for env_var, value in env_changes.iteritems():
1462
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1464
def restore_environment():
1465
for env_var, value in old_env.iteritems():
1466
osutils.set_or_unset_env(env_var, value)
1468
bzr_path = self.get_bzr_path()
1471
if working_dir is not None:
1472
cwd = osutils.getcwd()
1473
os.chdir(working_dir)
1476
# win32 subprocess doesn't support preexec_fn
1477
# so we will avoid using it on all platforms, just to
1478
# make sure the code path is used, and we don't break on win32
1479
cleanup_environment()
1480
command = [sys.executable, bzr_path]
1481
if not allow_plugins:
1482
command.append('--no-plugins')
1483
command.extend(process_args)
1484
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1486
restore_environment()
1492
def _popen(self, *args, **kwargs):
1493
"""Place a call to Popen.
1495
Allows tests to override this method to intercept the calls made to
1496
Popen for introspection.
1498
return Popen(*args, **kwargs)
1500
def get_bzr_path(self):
1501
"""Return the path of the 'bzr' executable for this test suite."""
1502
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1503
if not os.path.isfile(bzr_path):
1504
# We are probably installed. Assume sys.argv is the right file
1505
bzr_path = sys.argv[0]
1508
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1509
universal_newlines=False, process_args=None):
1510
"""Finish the execution of process.
1512
:param process: the Popen object returned from start_bzr_subprocess.
1513
:param retcode: The status code that is expected. Defaults to 0. If
1514
None is supplied, the status code is not checked.
1515
:param send_signal: an optional signal to send to the process.
1516
:param universal_newlines: Convert CRLF => LF
1517
:returns: (stdout, stderr)
1519
if send_signal is not None:
1520
os.kill(process.pid, send_signal)
1521
out, err = process.communicate()
1523
if universal_newlines:
1524
out = out.replace('\r\n', '\n')
1525
err = err.replace('\r\n', '\n')
1527
if retcode is not None and retcode != process.returncode:
1528
if process_args is None:
1529
process_args = "(unknown args)"
1530
mutter('Output of bzr %s:\n%s', process_args, out)
1531
mutter('Error for bzr %s:\n%s', process_args, err)
1532
self.fail('Command bzr %s failed with retcode %s != %s'
1533
% (process_args, retcode, process.returncode))
1536
def check_inventory_shape(self, inv, shape):
1537
"""Compare an inventory to a list of expected names.
1539
Fail if they are not precisely equal.
1542
shape = list(shape) # copy
1543
for path, ie in inv.entries():
1544
name = path.replace('\\', '/')
1545
if ie.kind == 'dir':
1552
self.fail("expected paths not found in inventory: %r" % shape)
1554
self.fail("unexpected paths found in inventory: %r" % extras)
1556
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1557
a_callable=None, *args, **kwargs):
1558
"""Call callable with redirected std io pipes.
1560
Returns the return code."""
1561
if not callable(a_callable):
1562
raise ValueError("a_callable must be callable.")
1564
stdin = StringIO("")
1566
if getattr(self, "_log_file", None) is not None:
1567
stdout = self._log_file
1571
if getattr(self, "_log_file", None is not None):
1572
stderr = self._log_file
1575
real_stdin = sys.stdin
1576
real_stdout = sys.stdout
1577
real_stderr = sys.stderr
1582
return a_callable(*args, **kwargs)
1584
sys.stdout = real_stdout
1585
sys.stderr = real_stderr
1586
sys.stdin = real_stdin
1588
def reduceLockdirTimeout(self):
1589
"""Reduce the default lock timeout for the duration of the test, so that
1590
if LockContention occurs during a test, it does so quickly.
1592
Tests that expect to provoke LockContention errors should call this.
1594
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1596
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1597
self.addCleanup(resetTimeout)
1598
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1601
class TestCaseWithMemoryTransport(TestCase):
1602
"""Common test class for tests that do not need disk resources.
1604
Tests that need disk resources should derive from TestCaseWithTransport.
1606
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1608
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1609
a directory which does not exist. This serves to help ensure test isolation
1610
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1611
must exist. However, TestCaseWithMemoryTransport does not offer local
1612
file defaults for the transport in tests, nor does it obey the command line
1613
override, so tests that accidentally write to the common directory should
1616
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1617
a .bzr directory that stops us ascending higher into the filesystem.
1623
def __init__(self, methodName='runTest'):
1624
# allow test parameterisation after test construction and before test
1625
# execution. Variables that the parameteriser sets need to be
1626
# ones that are not set by setUp, or setUp will trash them.
1627
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1628
self.vfs_transport_factory = default_transport
1629
self.transport_server = None
1630
self.transport_readonly_server = None
1631
self.__vfs_server = None
1633
def get_transport(self):
1634
"""Return a writeable transport for the test scratch space"""
1635
t = get_transport(self.get_url())
1636
self.assertFalse(t.is_readonly())
1639
def get_readonly_transport(self):
1640
"""Return a readonly transport for the test scratch space
1642
This can be used to test that operations which should only need
1643
readonly access in fact do not try to write.
1645
t = get_transport(self.get_readonly_url())
1646
self.assertTrue(t.is_readonly())
1649
def create_transport_readonly_server(self):
1650
"""Create a transport server from class defined at init.
1652
This is mostly a hook for daughter classes.
1654
return self.transport_readonly_server()
1656
def get_readonly_server(self):
1657
"""Get the server instance for the readonly transport
1659
This is useful for some tests with specific servers to do diagnostics.
1661
if self.__readonly_server is None:
1662
if self.transport_readonly_server is None:
1663
# readonly decorator requested
1664
# bring up the server
1665
self.__readonly_server = ReadonlyServer()
1666
self.__readonly_server.setUp(self.get_vfs_only_server())
1668
self.__readonly_server = self.create_transport_readonly_server()
1669
self.__readonly_server.setUp(self.get_vfs_only_server())
1670
self.addCleanup(self.__readonly_server.tearDown)
1671
return self.__readonly_server
1673
def get_readonly_url(self, relpath=None):
1674
"""Get a URL for the readonly transport.
1676
This will either be backed by '.' or a decorator to the transport
1677
used by self.get_url()
1678
relpath provides for clients to get a path relative to the base url.
1679
These should only be downwards relative, not upwards.
1681
base = self.get_readonly_server().get_url()
1682
if relpath is not None:
1683
if not base.endswith('/'):
1685
base = base + relpath
1688
def get_vfs_only_server(self):
1689
"""Get the vfs only read/write server instance.
1691
This is useful for some tests with specific servers that need
1694
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1695
is no means to override it.
1697
if self.__vfs_server is None:
1698
self.__vfs_server = MemoryServer()
1699
self.__vfs_server.setUp()
1700
self.addCleanup(self.__vfs_server.tearDown)
1701
return self.__vfs_server
1703
def get_server(self):
1704
"""Get the read/write server instance.
1706
This is useful for some tests with specific servers that need
1709
This is built from the self.transport_server factory. If that is None,
1710
then the self.get_vfs_server is returned.
1712
if self.__server is None:
1713
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1714
return self.get_vfs_only_server()
1716
# bring up a decorated means of access to the vfs only server.
1717
self.__server = self.transport_server()
1719
self.__server.setUp(self.get_vfs_only_server())
1720
except TypeError, e:
1721
# This should never happen; the try:Except here is to assist
1722
# developers having to update code rather than seeing an
1723
# uninformative TypeError.
1724
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1725
self.addCleanup(self.__server.tearDown)
1726
return self.__server
1728
def _adjust_url(self, base, relpath):
1729
"""Get a URL (or maybe a path) for the readwrite transport.
1731
This will either be backed by '.' or to an equivalent non-file based
1733
relpath provides for clients to get a path relative to the base url.
1734
These should only be downwards relative, not upwards.
1736
if relpath is not None and relpath != '.':
1737
if not base.endswith('/'):
1739
# XXX: Really base should be a url; we did after all call
1740
# get_url()! But sometimes it's just a path (from
1741
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1742
# to a non-escaped local path.
1743
if base.startswith('./') or base.startswith('/'):
1746
base += urlutils.escape(relpath)
1749
def get_url(self, relpath=None):
1750
"""Get a URL (or maybe a path) for the readwrite transport.
1752
This will either be backed by '.' or to an equivalent non-file based
1754
relpath provides for clients to get a path relative to the base url.
1755
These should only be downwards relative, not upwards.
1757
base = self.get_server().get_url()
1758
return self._adjust_url(base, relpath)
1760
def get_vfs_only_url(self, relpath=None):
1761
"""Get a URL (or maybe a path for the plain old vfs transport.
1763
This will never be a smart protocol. It always has all the
1764
capabilities of the local filesystem, but it might actually be a
1765
MemoryTransport or some other similar virtual filesystem.
1767
This is the backing transport (if any) of the server returned by
1768
get_url and get_readonly_url.
1770
:param relpath: provides for clients to get a path relative to the base
1771
url. These should only be downwards relative, not upwards.
1773
base = self.get_vfs_only_server().get_url()
1774
return self._adjust_url(base, relpath)
1776
def _make_test_root(self):
1777
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1779
root = tempfile.mkdtemp(prefix='testbzr-', suffix='.tmp')
1780
TestCaseWithMemoryTransport.TEST_ROOT = root
1782
# make a fake bzr directory there to prevent any tests propagating
1783
# up onto the source directory's real branch
1784
bzrdir.BzrDir.create_standalone_workingtree(root)
1786
# The same directory is used by all tests, and we're not specifically
1787
# told when all tests are finished. This will do.
1788
atexit.register(_rmtree_temp_dir, root)
1790
def makeAndChdirToTestDir(self):
1791
"""Create a temporary directories for this one test.
1793
This must set self.test_home_dir and self.test_dir and chdir to
1796
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1798
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1799
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1800
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1802
def make_branch(self, relpath, format=None):
1803
"""Create a branch on the transport at relpath."""
1804
repo = self.make_repository(relpath, format=format)
1805
return repo.bzrdir.create_branch()
1807
def make_bzrdir(self, relpath, format=None):
1809
# might be a relative or absolute path
1810
maybe_a_url = self.get_url(relpath)
1811
segments = maybe_a_url.rsplit('/', 1)
1812
t = get_transport(maybe_a_url)
1813
if len(segments) > 1 and segments[-1] not in ('', '.'):
1817
if isinstance(format, basestring):
1818
format = bzrdir.format_registry.make_bzrdir(format)
1819
return format.initialize_on_transport(t)
1820
except errors.UninitializableFormat:
1821
raise TestSkipped("Format %s is not initializable." % format)
1823
def make_repository(self, relpath, shared=False, format=None):
1824
"""Create a repository on our default transport at relpath.
1826
Note that relpath must be a relative path, not a full url.
1828
# FIXME: If you create a remoterepository this returns the underlying
1829
# real format, which is incorrect. Actually we should make sure that
1830
# RemoteBzrDir returns a RemoteRepository.
1831
# maybe mbp 20070410
1832
made_control = self.make_bzrdir(relpath, format=format)
1833
return made_control.create_repository(shared=shared)
1835
def make_branch_and_memory_tree(self, relpath, format=None):
1836
"""Create a branch on the default transport and a MemoryTree for it."""
1837
b = self.make_branch(relpath, format=format)
1838
return memorytree.MemoryTree.create_on_branch(b)
1840
def overrideEnvironmentForTesting(self):
1841
os.environ['HOME'] = self.test_home_dir
1842
os.environ['BZR_HOME'] = self.test_home_dir
1845
super(TestCaseWithMemoryTransport, self).setUp()
1846
self._make_test_root()
1847
_currentdir = os.getcwdu()
1848
def _leaveDirectory():
1849
os.chdir(_currentdir)
1850
self.addCleanup(_leaveDirectory)
1851
self.makeAndChdirToTestDir()
1852
self.overrideEnvironmentForTesting()
1853
self.__readonly_server = None
1854
self.__server = None
1855
self.reduceLockdirTimeout()
1858
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1859
"""Derived class that runs a test within a temporary directory.
1861
This is useful for tests that need to create a branch, etc.
1863
The directory is created in a slightly complex way: for each
1864
Python invocation, a new temporary top-level directory is created.
1865
All test cases create their own directory within that. If the
1866
tests complete successfully, the directory is removed.
1868
:ivar test_base_dir: The path of the top-level directory for this
1869
test, which contains a home directory and a work directory.
1871
:ivar test_home_dir: An initially empty directory under test_base_dir
1872
which is used as $HOME for this test.
1874
:ivar test_dir: A directory under test_base_dir used as the current
1875
directory when the test proper is run.
1878
OVERRIDE_PYTHON = 'python'
1879
use_numbered_dirs = False
1881
def check_file_contents(self, filename, expect):
1882
self.log("check contents of file %s" % filename)
1883
contents = file(filename, 'r').read()
1884
if contents != expect:
1885
self.log("expected: %r" % expect)
1886
self.log("actually: %r" % contents)
1887
self.fail("contents of %s not as expected" % filename)
1889
def makeAndChdirToTestDir(self):
1890
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1892
For TestCaseInTempDir we create a temporary directory based on the test
1893
name and then create two subdirs - test and home under it.
1895
# create a directory within the top level test directory
1896
candidate_dir = tempfile.mkdtemp(dir=self.TEST_ROOT)
1897
# now create test and home directories within this dir
1898
self.test_base_dir = candidate_dir
1899
self.test_home_dir = self.test_base_dir + '/home'
1900
os.mkdir(self.test_home_dir)
1901
self.test_dir = self.test_base_dir + '/work'
1902
os.mkdir(self.test_dir)
1903
os.chdir(self.test_dir)
1904
# put name of test inside
1905
f = file(self.test_base_dir + '/name', 'w')
1910
self.addCleanup(self.deleteTestDir)
1912
def deleteTestDir(self):
1913
_rmtree_temp_dir(self.test_base_dir)
1915
def build_tree(self, shape, line_endings='binary', transport=None):
1916
"""Build a test tree according to a pattern.
1918
shape is a sequence of file specifications. If the final
1919
character is '/', a directory is created.
1921
This assumes that all the elements in the tree being built are new.
1923
This doesn't add anything to a branch.
1924
:param line_endings: Either 'binary' or 'native'
1925
in binary mode, exact contents are written
1926
in native mode, the line endings match the
1927
default platform endings.
1929
:param transport: A transport to write to, for building trees on
1930
VFS's. If the transport is readonly or None,
1931
"." is opened automatically.
1933
# It's OK to just create them using forward slashes on windows.
1934
if transport is None or transport.is_readonly():
1935
transport = get_transport(".")
1937
self.assert_(isinstance(name, basestring))
1939
transport.mkdir(urlutils.escape(name[:-1]))
1941
if line_endings == 'binary':
1943
elif line_endings == 'native':
1946
raise errors.BzrError(
1947
'Invalid line ending request %r' % line_endings)
1948
content = "contents of %s%s" % (name.encode('utf-8'), end)
1949
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1951
def build_tree_contents(self, shape):
1952
build_tree_contents(shape)
1954
def assertFileEqual(self, content, path):
1955
"""Fail if path does not contain 'content'."""
1956
self.failUnlessExists(path)
1957
f = file(path, 'rb')
1962
self.assertEqualDiff(content, s)
1964
def failUnlessExists(self, path):
1965
"""Fail unless path or paths, which may be abs or relative, exist."""
1966
if not isinstance(path, basestring):
1968
self.failUnlessExists(p)
1970
self.failUnless(osutils.lexists(path),path+" does not exist")
1972
def failIfExists(self, path):
1973
"""Fail if path or paths, which may be abs or relative, exist."""
1974
if not isinstance(path, basestring):
1976
self.failIfExists(p)
1978
self.failIf(osutils.lexists(path),path+" exists")
1980
def assertInWorkingTree(self,path,root_path='.',tree=None):
1981
"""Assert whether path or paths are in the WorkingTree"""
1983
tree = workingtree.WorkingTree.open(root_path)
1984
if not isinstance(path, basestring):
1986
self.assertInWorkingTree(p,tree=tree)
1988
self.assertIsNot(tree.path2id(path), None,
1989
path+' not in working tree.')
1991
def assertNotInWorkingTree(self,path,root_path='.',tree=None):
1992
"""Assert whether path or paths are not in the WorkingTree"""
1994
tree = workingtree.WorkingTree.open(root_path)
1995
if not isinstance(path, basestring):
1997
self.assertNotInWorkingTree(p,tree=tree)
1999
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2002
class TestCaseWithTransport(TestCaseInTempDir):
2003
"""A test case that provides get_url and get_readonly_url facilities.
2005
These back onto two transport servers, one for readonly access and one for
2008
If no explicit class is provided for readonly access, a
2009
ReadonlyTransportDecorator is used instead which allows the use of non disk
2010
based read write transports.
2012
If an explicit class is provided for readonly access, that server and the
2013
readwrite one must both define get_url() as resolving to os.getcwd().
2016
def get_vfs_only_server(self):
2017
"""See TestCaseWithMemoryTransport.
2019
This is useful for some tests with specific servers that need
2022
if self.__vfs_server is None:
2023
self.__vfs_server = self.vfs_transport_factory()
2024
self.__vfs_server.setUp()
2025
self.addCleanup(self.__vfs_server.tearDown)
2026
return self.__vfs_server
2028
def make_branch_and_tree(self, relpath, format=None):
2029
"""Create a branch on the transport and a tree locally.
2031
If the transport is not a LocalTransport, the Tree can't be created on
2032
the transport. In that case if the vfs_transport_factory is
2033
LocalURLServer the working tree is created in the local
2034
directory backing the transport, and the returned tree's branch and
2035
repository will also be accessed locally. Otherwise a lightweight
2036
checkout is created and returned.
2038
:param format: The BzrDirFormat.
2039
:returns: the WorkingTree.
2041
# TODO: always use the local disk path for the working tree,
2042
# this obviously requires a format that supports branch references
2043
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2045
b = self.make_branch(relpath, format=format)
2047
return b.bzrdir.create_workingtree()
2048
except errors.NotLocalUrl:
2049
# We can only make working trees locally at the moment. If the
2050
# transport can't support them, then we keep the non-disk-backed
2051
# branch and create a local checkout.
2052
if self.vfs_transport_factory is LocalURLServer:
2053
# the branch is colocated on disk, we cannot create a checkout.
2054
# hopefully callers will expect this.
2055
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2056
return local_controldir.create_workingtree()
2058
return b.create_checkout(relpath, lightweight=True)
2060
def assertIsDirectory(self, relpath, transport):
2061
"""Assert that relpath within transport is a directory.
2063
This may not be possible on all transports; in that case it propagates
2064
a TransportNotPossible.
2067
mode = transport.stat(relpath).st_mode
2068
except errors.NoSuchFile:
2069
self.fail("path %s is not a directory; no such file"
2071
if not stat.S_ISDIR(mode):
2072
self.fail("path %s is not a directory; has mode %#o"
2075
def assertTreesEqual(self, left, right):
2076
"""Check that left and right have the same content and properties."""
2077
# we use a tree delta to check for equality of the content, and we
2078
# manually check for equality of other things such as the parents list.
2079
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2080
differences = left.changes_from(right)
2081
self.assertFalse(differences.has_changed(),
2082
"Trees %r and %r are different: %r" % (left, right, differences))
2085
super(TestCaseWithTransport, self).setUp()
2086
self.__vfs_server = None
2089
class ChrootedTestCase(TestCaseWithTransport):
2090
"""A support class that provides readonly urls outside the local namespace.
2092
This is done by checking if self.transport_server is a MemoryServer. if it
2093
is then we are chrooted already, if it is not then an HttpServer is used
2096
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2097
be used without needed to redo it when a different
2098
subclass is in use ?
2102
super(ChrootedTestCase, self).setUp()
2103
if not self.vfs_transport_factory == MemoryServer:
2104
self.transport_readonly_server = HttpServer
2107
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2108
random_order=False):
2109
"""Create a test suite by filtering another one.
2111
:param suite: the source suite
2112
:param pattern: pattern that names must match
2113
:param exclude_pattern: pattern that names must not match, if any
2114
:param random_order: if True, tests in the new suite will be put in
2116
:returns: the newly created suite
2118
return sort_suite_by_re(suite, pattern, exclude_pattern,
2119
random_order, False)
2122
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2123
random_order=False, append_rest=True):
2124
"""Create a test suite by sorting another one.
2126
:param suite: the source suite
2127
:param pattern: pattern that names must match in order to go
2128
first in the new suite
2129
:param exclude_pattern: pattern that names must not match, if any
2130
:param random_order: if True, tests in the new suite will be put in
2132
:param append_rest: if False, pattern is a strict filter and not
2133
just an ordering directive
2134
:returns: the newly created suite
2138
filter_re = re.compile(pattern)
2139
if exclude_pattern is not None:
2140
exclude_re = re.compile(exclude_pattern)
2141
for test in iter_suite_tests(suite):
2143
if exclude_pattern is None or not exclude_re.search(test_id):
2144
if filter_re.search(test_id):
2149
random.shuffle(first)
2150
random.shuffle(second)
2151
return TestUtil.TestSuite(first + second)
2154
def run_suite(suite, name='test', verbose=False, pattern=".*",
2155
stop_on_failure=False,
2156
transport=None, lsprof_timed=None, bench_history=None,
2157
matching_tests_first=None,
2161
exclude_pattern=None,
2163
use_numbered_dirs = bool(numbered_dirs)
2165
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2166
if numbered_dirs is not None:
2167
TestCaseInTempDir.use_numbered_dirs = use_numbered_dirs
2172
runner = TextTestRunner(stream=sys.stdout,
2174
verbosity=verbosity,
2175
bench_history=bench_history,
2176
use_numbered_dirs=use_numbered_dirs,
2177
list_only=list_only,
2179
runner.stop_on_failure=stop_on_failure
2180
# Initialise the random number generator and display the seed used.
2181
# We convert the seed to a long to make it reuseable across invocations.
2182
random_order = False
2183
if random_seed is not None:
2185
if random_seed == "now":
2186
random_seed = long(time.time())
2188
# Convert the seed to a long if we can
2190
random_seed = long(random_seed)
2193
runner.stream.writeln("Randomizing test order using seed %s\n" %
2195
random.seed(random_seed)
2196
# Customise the list of tests if requested
2197
if pattern != '.*' or exclude_pattern is not None or random_order:
2198
if matching_tests_first:
2199
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
2202
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
2204
result = runner.run(suite)
2205
return result.wasSuccessful()
2208
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2210
test_suite_factory=None,
2213
matching_tests_first=None,
2217
exclude_pattern=None):
2218
"""Run the whole test suite under the enhanced runner"""
2219
# XXX: Very ugly way to do this...
2220
# Disable warning about old formats because we don't want it to disturb
2221
# any blackbox tests.
2222
from bzrlib import repository
2223
repository._deprecation_warning_done = True
2225
global default_transport
2226
if transport is None:
2227
transport = default_transport
2228
old_transport = default_transport
2229
default_transport = transport
2231
if test_suite_factory is None:
2232
suite = test_suite()
2234
suite = test_suite_factory()
2235
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2236
stop_on_failure=stop_on_failure,
2237
transport=transport,
2238
lsprof_timed=lsprof_timed,
2239
bench_history=bench_history,
2240
matching_tests_first=matching_tests_first,
2241
numbered_dirs=numbered_dirs,
2242
list_only=list_only,
2243
random_seed=random_seed,
2244
exclude_pattern=exclude_pattern)
2246
default_transport = old_transport
2250
"""Build and return TestSuite for the whole of bzrlib.
2252
This function can be replaced if you need to change the default test
2253
suite on a global basis, but it is not encouraged.
2256
'bzrlib.tests.test_ancestry',
2257
'bzrlib.tests.test_annotate',
2258
'bzrlib.tests.test_api',
2259
'bzrlib.tests.test_atomicfile',
2260
'bzrlib.tests.test_bad_files',
2261
'bzrlib.tests.test_branch',
2262
'bzrlib.tests.test_branchbuilder',
2263
'bzrlib.tests.test_bugtracker',
2264
'bzrlib.tests.test_bundle',
2265
'bzrlib.tests.test_bzrdir',
2266
'bzrlib.tests.test_cache_utf8',
2267
'bzrlib.tests.test_commands',
2268
'bzrlib.tests.test_commit',
2269
'bzrlib.tests.test_commit_merge',
2270
'bzrlib.tests.test_config',
2271
'bzrlib.tests.test_conflicts',
2272
'bzrlib.tests.test_counted_lock',
2273
'bzrlib.tests.test_decorators',
2274
'bzrlib.tests.test_delta',
2275
'bzrlib.tests.test_deprecated_graph',
2276
'bzrlib.tests.test_diff',
2277
'bzrlib.tests.test_dirstate',
2278
'bzrlib.tests.test_errors',
2279
'bzrlib.tests.test_escaped_store',
2280
'bzrlib.tests.test_extract',
2281
'bzrlib.tests.test_fetch',
2282
'bzrlib.tests.test_ftp_transport',
2283
'bzrlib.tests.test_generate_docs',
2284
'bzrlib.tests.test_generate_ids',
2285
'bzrlib.tests.test_globbing',
2286
'bzrlib.tests.test_gpg',
2287
'bzrlib.tests.test_graph',
2288
'bzrlib.tests.test_hashcache',
2289
'bzrlib.tests.test_help',
2290
'bzrlib.tests.test_http',
2291
'bzrlib.tests.test_http_response',
2292
'bzrlib.tests.test_https_ca_bundle',
2293
'bzrlib.tests.test_identitymap',
2294
'bzrlib.tests.test_ignores',
2295
'bzrlib.tests.test_info',
2296
'bzrlib.tests.test_inv',
2297
'bzrlib.tests.test_knit',
2298
'bzrlib.tests.test_lazy_import',
2299
'bzrlib.tests.test_lazy_regex',
2300
'bzrlib.tests.test_lockdir',
2301
'bzrlib.tests.test_lockable_files',
2302
'bzrlib.tests.test_log',
2303
'bzrlib.tests.test_lsprof',
2304
'bzrlib.tests.test_memorytree',
2305
'bzrlib.tests.test_merge',
2306
'bzrlib.tests.test_merge3',
2307
'bzrlib.tests.test_merge_core',
2308
'bzrlib.tests.test_merge_directive',
2309
'bzrlib.tests.test_missing',
2310
'bzrlib.tests.test_msgeditor',
2311
'bzrlib.tests.test_nonascii',
2312
'bzrlib.tests.test_options',
2313
'bzrlib.tests.test_osutils',
2314
'bzrlib.tests.test_osutils_encodings',
2315
'bzrlib.tests.test_patch',
2316
'bzrlib.tests.test_patches',
2317
'bzrlib.tests.test_permissions',
2318
'bzrlib.tests.test_plugins',
2319
'bzrlib.tests.test_progress',
2320
'bzrlib.tests.test_reconcile',
2321
'bzrlib.tests.test_registry',
2322
'bzrlib.tests.test_remote',
2323
'bzrlib.tests.test_repository',
2324
'bzrlib.tests.test_revert',
2325
'bzrlib.tests.test_revision',
2326
'bzrlib.tests.test_revisionnamespaces',
2327
'bzrlib.tests.test_revisiontree',
2328
'bzrlib.tests.test_rio',
2329
'bzrlib.tests.test_sampler',
2330
'bzrlib.tests.test_selftest',
2331
'bzrlib.tests.test_setup',
2332
'bzrlib.tests.test_sftp_transport',
2333
'bzrlib.tests.test_smart',
2334
'bzrlib.tests.test_smart_add',
2335
'bzrlib.tests.test_smart_transport',
2336
'bzrlib.tests.test_smtp_connection',
2337
'bzrlib.tests.test_source',
2338
'bzrlib.tests.test_ssh_transport',
2339
'bzrlib.tests.test_status',
2340
'bzrlib.tests.test_store',
2341
'bzrlib.tests.test_strace',
2342
'bzrlib.tests.test_subsume',
2343
'bzrlib.tests.test_symbol_versioning',
2344
'bzrlib.tests.test_tag',
2345
'bzrlib.tests.test_testament',
2346
'bzrlib.tests.test_textfile',
2347
'bzrlib.tests.test_textmerge',
2348
'bzrlib.tests.test_timestamp',
2349
'bzrlib.tests.test_trace',
2350
'bzrlib.tests.test_transactions',
2351
'bzrlib.tests.test_transform',
2352
'bzrlib.tests.test_transport',
2353
'bzrlib.tests.test_tree',
2354
'bzrlib.tests.test_treebuilder',
2355
'bzrlib.tests.test_tsort',
2356
'bzrlib.tests.test_tuned_gzip',
2357
'bzrlib.tests.test_ui',
2358
'bzrlib.tests.test_upgrade',
2359
'bzrlib.tests.test_urlutils',
2360
'bzrlib.tests.test_versionedfile',
2361
'bzrlib.tests.test_version',
2362
'bzrlib.tests.test_version_info',
2363
'bzrlib.tests.test_weave',
2364
'bzrlib.tests.test_whitebox',
2365
'bzrlib.tests.test_workingtree',
2366
'bzrlib.tests.test_workingtree_4',
2367
'bzrlib.tests.test_wsgi',
2368
'bzrlib.tests.test_xml',
2370
test_transport_implementations = [
2371
'bzrlib.tests.test_transport_implementations',
2372
'bzrlib.tests.test_read_bundle',
2374
suite = TestUtil.TestSuite()
2375
loader = TestUtil.TestLoader()
2376
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2377
from bzrlib.transport import TransportTestProviderAdapter
2378
adapter = TransportTestProviderAdapter()
2379
adapt_modules(test_transport_implementations, adapter, loader, suite)
2380
for package in packages_to_test():
2381
suite.addTest(package.test_suite())
2382
for m in MODULES_TO_TEST:
2383
suite.addTest(loader.loadTestsFromModule(m))
2384
for m in MODULES_TO_DOCTEST:
2386
suite.addTest(doctest.DocTestSuite(m))
2387
except ValueError, e:
2388
print '**failed to get doctest for: %s\n%s' %(m,e)
2390
for name, plugin in bzrlib.plugin.all_plugins().items():
2391
if getattr(plugin, 'test_suite', None) is not None:
2392
default_encoding = sys.getdefaultencoding()
2394
plugin_suite = plugin.test_suite()
2395
except ImportError, e:
2396
bzrlib.trace.warning(
2397
'Unable to test plugin "%s": %s', name, e)
2399
suite.addTest(plugin_suite)
2400
if default_encoding != sys.getdefaultencoding():
2401
bzrlib.trace.warning(
2402
'Plugin "%s" tried to reset default encoding to: %s', name,
2403
sys.getdefaultencoding())
2405
sys.setdefaultencoding(default_encoding)
2409
def adapt_modules(mods_list, adapter, loader, suite):
2410
"""Adapt the modules in mods_list using adapter and add to suite."""
2411
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2412
suite.addTests(adapter.adapt(test))
2415
def _rmtree_temp_dir(dirname):
2416
# If LANG=C we probably have created some bogus paths
2417
# which rmtree(unicode) will fail to delete
2418
# so make sure we are using rmtree(str) to delete everything
2419
# except on win32, where rmtree(str) will fail
2420
# since it doesn't have the property of byte-stream paths
2421
# (they are either ascii or mbcs)
2422
if sys.platform == 'win32':
2423
# make sure we are using the unicode win32 api
2424
dirname = unicode(dirname)
2426
dirname = dirname.encode(sys.getfilesystemencoding())
2428
osutils.rmtree(dirname)
2430
if sys.platform == 'win32' and e.errno == errno.EACCES:
2431
print >>sys.stderr, ('Permission denied: '
2432
'unable to remove testing dir '
2433
'%s' % os.path.basename(dirname))
2438
def clean_selftest_output(root=None, quiet=False):
2439
"""Remove all selftest output directories from root directory.
2441
:param root: root directory for clean
2442
(if ommitted or None then clean current directory).
2443
:param quiet: suppress report about deleting directories
2446
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
2449
for i in os.listdir(root):
2450
if os.path.isdir(i) and re_dir.match(i):
2452
print 'delete directory:', i
2456
class Feature(object):
2457
"""An operating system Feature."""
2460
self._available = None
2462
def available(self):
2463
"""Is the feature available?
2465
:return: True if the feature is available.
2467
if self._available is None:
2468
self._available = self._probe()
2469
return self._available
2472
"""Implement this method in concrete features.
2474
:return: True if the feature is available.
2476
raise NotImplementedError
2479
if getattr(self, 'feature_name', None):
2480
return self.feature_name()
2481
return self.__class__.__name__
added
removed
bzrlib/tests/__init__.py
