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
raise AssertionError('pattern "%r" not found in "%r"'
843
% (needle_re, haystack))
845
def assertNotContainsRe(self, haystack, needle_re):
846
"""Assert that a does not match a regular expression"""
847
if re.search(needle_re, haystack):
848
raise AssertionError('pattern "%s" found in "%s"'
849
% (needle_re, haystack))
851
def assertSubset(self, sublist, superlist):
852
"""Assert that every entry in sublist is present in superlist."""
854
for entry in sublist:
855
if entry not in superlist:
856
missing.append(entry)
858
raise AssertionError("value(s) %r not present in container %r" %
859
(missing, superlist))
861
def assertListRaises(self, excClass, func, *args, **kwargs):
862
"""Fail unless excClass is raised when the iterator from func is used.
864
Many functions can return generators this makes sure
865
to wrap them in a list() call to make sure the whole generator
866
is run, and that the proper exception is raised.
869
list(func(*args, **kwargs))
873
if getattr(excClass,'__name__', None) is not None:
874
excName = excClass.__name__
876
excName = str(excClass)
877
raise self.failureException, "%s not raised" % excName
879
def assertRaises(self, excClass, func, *args, **kwargs):
880
"""Assert that a callable raises a particular exception.
882
:param excClass: As for the except statement, this may be either an
883
exception class, or a tuple of classes.
885
Returns the exception so that you can examine it.
888
func(*args, **kwargs)
892
if getattr(excClass,'__name__', None) is not None:
893
excName = excClass.__name__
896
excName = str(excClass)
897
raise self.failureException, "%s not raised" % excName
899
def assertIs(self, left, right, message=None):
900
if not (left is right):
901
if message is not None:
902
raise AssertionError(message)
904
raise AssertionError("%r is not %r." % (left, right))
906
def assertIsNot(self, left, right, message=None):
908
if message is not None:
909
raise AssertionError(message)
911
raise AssertionError("%r is %r." % (left, right))
913
def assertTransportMode(self, transport, path, mode):
914
"""Fail if a path does not have mode mode.
916
If modes are not supported on this transport, the assertion is ignored.
918
if not transport._can_roundtrip_unix_modebits():
920
path_stat = transport.stat(path)
921
actual_mode = stat.S_IMODE(path_stat.st_mode)
922
self.assertEqual(mode, actual_mode,
923
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
925
def assertIsInstance(self, obj, kls):
926
"""Fail if obj is not an instance of kls"""
927
if not isinstance(obj, kls):
928
self.fail("%r is an instance of %s rather than %s" % (
929
obj, obj.__class__, kls))
931
def expectFailure(self, reason, assertion, *args, **kwargs):
932
"""Invoke a test, expecting it to fail for the given reason.
934
This is for assertions that ought to succeed, but currently fail.
935
(The failure is *expected* but not *wanted*.) Please be very precise
936
about the failure you're expecting. If a new bug is introduced,
937
AssertionError should be raised, not KnownFailure.
939
Frequently, expectFailure should be followed by an opposite assertion.
942
Intended to be used with a callable that raises AssertionError as the
943
'assertion' parameter. args and kwargs are passed to the 'assertion'.
945
Raises KnownFailure if the test fails. Raises AssertionError if the
950
self.expectFailure('Math is broken', self.assertNotEqual, 54,
952
self.assertEqual(42, dynamic_val)
954
This means that a dynamic_val of 54 will cause the test to raise
955
a KnownFailure. Once math is fixed and the expectFailure is removed,
956
only a dynamic_val of 42 will allow the test to pass. Anything other
957
than 54 or 42 will cause an AssertionError.
960
assertion(*args, **kwargs)
961
except AssertionError:
962
raise KnownFailure(reason)
964
self.fail('Unexpected success. Should have failed: %s' % reason)
966
def _capture_warnings(self, a_callable, *args, **kwargs):
967
"""A helper for callDeprecated and applyDeprecated.
969
:param a_callable: A callable to call.
970
:param args: The positional arguments for the callable
971
:param kwargs: The keyword arguments for the callable
972
:return: A tuple (warnings, result). result is the result of calling
973
a_callable(*args, **kwargs).
976
def capture_warnings(msg, cls=None, stacklevel=None):
977
# we've hooked into a deprecation specific callpath,
978
# only deprecations should getting sent via it.
979
self.assertEqual(cls, DeprecationWarning)
980
local_warnings.append(msg)
981
original_warning_method = symbol_versioning.warn
982
symbol_versioning.set_warning_method(capture_warnings)
984
result = a_callable(*args, **kwargs)
986
symbol_versioning.set_warning_method(original_warning_method)
987
return (local_warnings, result)
989
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
990
"""Call a deprecated callable without warning the user.
992
Note that this only captures warnings raised by symbol_versioning.warn,
993
not other callers that go direct to the warning module.
995
:param deprecation_format: The deprecation format that the callable
996
should have been deprecated with. This is the same type as the
997
parameter to deprecated_method/deprecated_function. If the
998
callable is not deprecated with this format, an assertion error
1000
:param a_callable: A callable to call. This may be a bound method or
1001
a regular function. It will be called with *args and **kwargs.
1002
:param args: The positional arguments for the callable
1003
:param kwargs: The keyword arguments for the callable
1004
:return: The result of a_callable(*args, **kwargs)
1006
call_warnings, result = self._capture_warnings(a_callable,
1008
expected_first_warning = symbol_versioning.deprecation_string(
1009
a_callable, deprecation_format)
1010
if len(call_warnings) == 0:
1011
self.fail("No deprecation warning generated by call to %s" %
1013
self.assertEqual(expected_first_warning, call_warnings[0])
1016
def callDeprecated(self, expected, callable, *args, **kwargs):
1017
"""Assert that a callable is deprecated in a particular way.
1019
This is a very precise test for unusual requirements. The
1020
applyDeprecated helper function is probably more suited for most tests
1021
as it allows you to simply specify the deprecation format being used
1022
and will ensure that that is issued for the function being called.
1024
Note that this only captures warnings raised by symbol_versioning.warn,
1025
not other callers that go direct to the warning module.
1027
:param expected: a list of the deprecation warnings expected, in order
1028
:param callable: The callable to call
1029
:param args: The positional arguments for the callable
1030
:param kwargs: The keyword arguments for the callable
1032
call_warnings, result = self._capture_warnings(callable,
1034
self.assertEqual(expected, call_warnings)
1037
def _startLogFile(self):
1038
"""Send bzr and test log messages to a temporary file.
1040
The file is removed as the test is torn down.
1042
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1043
self._log_file = os.fdopen(fileno, 'w+')
1044
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1045
self._log_file_name = name
1046
self.addCleanup(self._finishLogFile)
1048
def _finishLogFile(self):
1049
"""Finished with the log file.
1051
Close the file and delete it, unless setKeepLogfile was called.
1053
if self._log_file is None:
1055
bzrlib.trace.disable_test_log(self._log_nonce)
1056
self._log_file.close()
1057
self._log_file = None
1058
if not self._keep_log_file:
1059
os.remove(self._log_file_name)
1060
self._log_file_name = None
1062
def setKeepLogfile(self):
1063
"""Make the logfile not be deleted when _finishLogFile is called."""
1064
self._keep_log_file = True
1066
def addCleanup(self, callable):
1067
"""Arrange to run a callable when this case is torn down.
1069
Callables are run in the reverse of the order they are registered,
1070
ie last-in first-out.
1072
if callable in self._cleanups:
1073
raise ValueError("cleanup function %r already registered on %s"
1075
self._cleanups.append(callable)
1077
def _cleanEnvironment(self):
1079
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1080
'HOME': os.getcwd(),
1081
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1083
'BZREMAIL': None, # may still be present in the environment
1085
'BZR_PROGRESS_BAR': None,
1089
'https_proxy': None,
1090
'HTTPS_PROXY': None,
1095
# Nobody cares about these ones AFAIK. So far at
1096
# least. If you do (care), please update this comment
1100
'BZR_REMOTE_PATH': None,
1103
self.addCleanup(self._restoreEnvironment)
1104
for name, value in new_env.iteritems():
1105
self._captureVar(name, value)
1107
def _captureVar(self, name, newvalue):
1108
"""Set an environment variable, and reset it when finished."""
1109
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1111
def _restoreEnvironment(self):
1112
for name, value in self.__old_env.iteritems():
1113
osutils.set_or_unset_env(name, value)
1115
def _restoreHooks(self):
1116
for klass, hooks in self._preserved_hooks.items():
1117
setattr(klass, 'hooks', hooks)
1119
def knownFailure(self, reason):
1120
"""This test has failed for some known reason."""
1121
raise KnownFailure(reason)
1123
def run(self, result=None):
1124
if result is None: result = self.defaultTestResult()
1125
for feature in getattr(self, '_test_needs_features', []):
1126
if not feature.available():
1127
result.startTest(self)
1128
if getattr(result, 'addNotSupported', None):
1129
result.addNotSupported(self, feature)
1131
result.addSuccess(self)
1132
result.stopTest(self)
1134
return unittest.TestCase.run(self, result)
1138
unittest.TestCase.tearDown(self)
1140
def time(self, callable, *args, **kwargs):
1141
"""Run callable and accrue the time it takes to the benchmark time.
1143
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1144
this will cause lsprofile statistics to be gathered and stored in
1147
if self._benchtime is None:
1151
if not self._gather_lsprof_in_benchmarks:
1152
return callable(*args, **kwargs)
1154
# record this benchmark
1155
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1157
self._benchcalls.append(((callable, args, kwargs), stats))
1160
self._benchtime += time.time() - start
1162
def _runCleanups(self):
1163
"""Run registered cleanup functions.
1165
This should only be called from TestCase.tearDown.
1167
# TODO: Perhaps this should keep running cleanups even if
1168
# one of them fails?
1170
# Actually pop the cleanups from the list so tearDown running
1171
# twice is safe (this happens for skipped tests).
1172
while self._cleanups:
1173
self._cleanups.pop()()
1175
def log(self, *args):
1178
def _get_log(self, keep_log_file=False):
1179
"""Return as a string the log for this test. If the file is still
1180
on disk and keep_log_file=False, delete the log file and store the
1181
content in self._log_contents."""
1182
# flush the log file, to get all content
1184
bzrlib.trace._trace_file.flush()
1185
if self._log_contents:
1186
return self._log_contents
1187
if self._log_file_name is not None:
1188
logfile = open(self._log_file_name)
1190
log_contents = logfile.read()
1193
if not keep_log_file:
1194
self._log_contents = log_contents
1196
os.remove(self._log_file_name)
1198
if sys.platform == 'win32' and e.errno == errno.EACCES:
1199
print >>sys.stderr, ('Unable to delete log file '
1200
' %r' % self._log_file_name)
1205
return "DELETED log file to reduce memory footprint"
1207
@deprecated_method(zero_eighteen)
1208
def capture(self, cmd, retcode=0):
1209
"""Shortcut that splits cmd into words, runs, and returns stdout"""
1210
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
1212
def requireFeature(self, feature):
1213
"""This test requires a specific feature is available.
1215
:raises UnavailableFeature: When feature is not available.
1217
if not feature.available():
1218
raise UnavailableFeature(feature)
1220
@deprecated_method(zero_eighteen)
1221
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
1223
"""Invoke bzr and return (stdout, stderr).
1225
Don't call this method, just use run_bzr() which is equivalent.
1227
:param argv: Arguments to invoke bzr. This may be either a
1228
single string, in which case it is split by shlex into words,
1229
or a list of arguments.
1230
:param retcode: Expected return code, or None for don't-care.
1231
:param encoding: Encoding for sys.stdout and sys.stderr
1232
:param stdin: A string to be used as stdin for the command.
1233
:param working_dir: Change to this directory before running
1235
return self._run_bzr_autosplit(argv, retcode=retcode,
1236
encoding=encoding, stdin=stdin, working_dir=working_dir,
1239
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1241
"""Run bazaar command line, splitting up a string command line."""
1242
if isinstance(args, basestring):
1243
args = list(shlex.split(args))
1244
return self._run_bzr_core(args, retcode=retcode,
1245
encoding=encoding, stdin=stdin, working_dir=working_dir,
1248
def _run_bzr_core(self, args, retcode, encoding, stdin,
1250
if encoding is None:
1251
encoding = bzrlib.user_encoding
1252
stdout = StringIOWrapper()
1253
stderr = StringIOWrapper()
1254
stdout.encoding = encoding
1255
stderr.encoding = encoding
1257
self.log('run bzr: %r', args)
1258
# FIXME: don't call into logging here
1259
handler = logging.StreamHandler(stderr)
1260
handler.setLevel(logging.INFO)
1261
logger = logging.getLogger('')
1262
logger.addHandler(handler)
1263
old_ui_factory = ui.ui_factory
1264
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1267
if working_dir is not None:
1268
cwd = osutils.getcwd()
1269
os.chdir(working_dir)
1272
saved_debug_flags = frozenset(debug.debug_flags)
1273
debug.debug_flags.clear()
1275
result = self.apply_redirected(ui.ui_factory.stdin,
1277
bzrlib.commands.run_bzr_catch_errors,
1280
debug.debug_flags.update(saved_debug_flags)
1282
logger.removeHandler(handler)
1283
ui.ui_factory = old_ui_factory
1287
out = stdout.getvalue()
1288
err = stderr.getvalue()
1290
self.log('output:\n%r', out)
1292
self.log('errors:\n%r', err)
1293
if retcode is not None:
1294
self.assertEquals(retcode, result,
1295
message='Unexpected return code')
1298
def run_bzr(self, *args, **kwargs):
1299
"""Invoke bzr, as if it were run from the command line.
1301
The argument list should not include the bzr program name - the
1302
first argument is normally the bzr command. Arguments may be
1303
passed in three ways:
1305
1- A list of strings, eg ["commit", "a"]. This is recommended
1306
when the command contains whitespace or metacharacters, or
1307
is built up at run time.
1309
2- A single string, eg "add a". This is the most convenient
1310
for hardcoded commands.
1312
3- Several varargs parameters, eg run_bzr("add", "a").
1313
This is not recommended for new code.
1315
This runs bzr through the interface that catches and reports
1316
errors, and with logging set to something approximating the
1317
default, so that error reporting can be checked.
1319
This should be the main method for tests that want to exercise the
1320
overall behavior of the bzr application (rather than a unit test
1321
or a functional test of the library.)
1323
:param stdin: A string to be used as stdin for the command.
1324
:param retcode: The status code the command should return;
1326
:param working_dir: The directory to run the command in
1327
:param error_regexes: A list of expected error messages. If
1328
specified they must be seen in the error output of the command.
1330
retcode = kwargs.pop('retcode', 0)
1331
encoding = kwargs.pop('encoding', None)
1332
stdin = kwargs.pop('stdin', None)
1333
working_dir = kwargs.pop('working_dir', None)
1334
error_regexes = kwargs.pop('error_regexes', [])
1337
if isinstance(args[0], (list, basestring)):
1340
## symbol_versioning.warn(zero_eighteen % "passing varargs to run_bzr",
1341
## DeprecationWarning, stacklevel=2)
1342
# not done yet, because too many tests would need to be updated -
1343
# but please don't do this in new code. -- mbp 20070626
1346
out, err = self._run_bzr_autosplit(args=args,
1348
encoding=encoding, stdin=stdin, working_dir=working_dir,
1351
for regex in error_regexes:
1352
self.assertContainsRe(err, regex)
1355
def run_bzr_decode(self, *args, **kwargs):
1356
if 'encoding' in kwargs:
1357
encoding = kwargs['encoding']
1359
encoding = bzrlib.user_encoding
1360
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1362
def run_bzr_error(self, error_regexes, *args, **kwargs):
1363
"""Run bzr, and check that stderr contains the supplied regexes
1365
:param error_regexes: Sequence of regular expressions which
1366
must each be found in the error output. The relative ordering
1368
:param args: command-line arguments for bzr
1369
:param kwargs: Keyword arguments which are interpreted by run_bzr
1370
This function changes the default value of retcode to be 3,
1371
since in most cases this is run when you expect bzr to fail.
1372
:return: (out, err) The actual output of running the command (in case you
1373
want to do more inspection)
1376
# Make sure that commit is failing because there is nothing to do
1377
self.run_bzr_error(['no changes to commit'],
1378
'commit', '-m', 'my commit comment')
1379
# Make sure --strict is handling an unknown file, rather than
1380
# giving us the 'nothing to do' error
1381
self.build_tree(['unknown'])
1382
self.run_bzr_error(['Commit refused because there are unknown files'],
1383
'commit', '--strict', '-m', 'my commit comment')
1385
kwargs.setdefault('retcode', 3)
1386
out, err = self.run_bzr(error_regexes=error_regexes, *args, **kwargs)
1389
def run_bzr_subprocess(self, *args, **kwargs):
1390
"""Run bzr in a subprocess for testing.
1392
This starts a new Python interpreter and runs bzr in there.
1393
This should only be used for tests that have a justifiable need for
1394
this isolation: e.g. they are testing startup time, or signal
1395
handling, or early startup code, etc. Subprocess code can't be
1396
profiled or debugged so easily.
1398
:param retcode: The status code that is expected. Defaults to 0. If
1399
None is supplied, the status code is not checked.
1400
:param env_changes: A dictionary which lists changes to environment
1401
variables. A value of None will unset the env variable.
1402
The values must be strings. The change will only occur in the
1403
child, so you don't need to fix the environment after running.
1404
:param universal_newlines: Convert CRLF => LF
1405
:param allow_plugins: By default the subprocess is run with
1406
--no-plugins to ensure test reproducibility. Also, it is possible
1407
for system-wide plugins to create unexpected output on stderr,
1408
which can cause unnecessary test failures.
1410
env_changes = kwargs.get('env_changes', {})
1411
working_dir = kwargs.get('working_dir', None)
1412
allow_plugins = kwargs.get('allow_plugins', False)
1413
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1414
working_dir=working_dir,
1415
allow_plugins=allow_plugins)
1416
# We distinguish between retcode=None and retcode not passed.
1417
supplied_retcode = kwargs.get('retcode', 0)
1418
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1419
universal_newlines=kwargs.get('universal_newlines', False),
1422
def start_bzr_subprocess(self, process_args, env_changes=None,
1423
skip_if_plan_to_signal=False,
1425
allow_plugins=False):
1426
"""Start bzr in a subprocess for testing.
1428
This starts a new Python interpreter and runs bzr in there.
1429
This should only be used for tests that have a justifiable need for
1430
this isolation: e.g. they are testing startup time, or signal
1431
handling, or early startup code, etc. Subprocess code can't be
1432
profiled or debugged so easily.
1434
:param process_args: a list of arguments to pass to the bzr executable,
1435
for example `['--version']`.
1436
:param env_changes: A dictionary which lists changes to environment
1437
variables. A value of None will unset the env variable.
1438
The values must be strings. The change will only occur in the
1439
child, so you don't need to fix the environment after running.
1440
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1442
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1444
:returns: Popen object for the started process.
1446
if skip_if_plan_to_signal:
1447
if not getattr(os, 'kill', None):
1448
raise TestSkipped("os.kill not available.")
1450
if env_changes is None:
1454
def cleanup_environment():
1455
for env_var, value in env_changes.iteritems():
1456
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1458
def restore_environment():
1459
for env_var, value in old_env.iteritems():
1460
osutils.set_or_unset_env(env_var, value)
1462
bzr_path = self.get_bzr_path()
1465
if working_dir is not None:
1466
cwd = osutils.getcwd()
1467
os.chdir(working_dir)
1470
# win32 subprocess doesn't support preexec_fn
1471
# so we will avoid using it on all platforms, just to
1472
# make sure the code path is used, and we don't break on win32
1473
cleanup_environment()
1474
command = [sys.executable, bzr_path]
1475
if not allow_plugins:
1476
command.append('--no-plugins')
1477
command.extend(process_args)
1478
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1480
restore_environment()
1486
def _popen(self, *args, **kwargs):
1487
"""Place a call to Popen.
1489
Allows tests to override this method to intercept the calls made to
1490
Popen for introspection.
1492
return Popen(*args, **kwargs)
1494
def get_bzr_path(self):
1495
"""Return the path of the 'bzr' executable for this test suite."""
1496
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1497
if not os.path.isfile(bzr_path):
1498
# We are probably installed. Assume sys.argv is the right file
1499
bzr_path = sys.argv[0]
1502
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1503
universal_newlines=False, process_args=None):
1504
"""Finish the execution of process.
1506
:param process: the Popen object returned from start_bzr_subprocess.
1507
:param retcode: The status code that is expected. Defaults to 0. If
1508
None is supplied, the status code is not checked.
1509
:param send_signal: an optional signal to send to the process.
1510
:param universal_newlines: Convert CRLF => LF
1511
:returns: (stdout, stderr)
1513
if send_signal is not None:
1514
os.kill(process.pid, send_signal)
1515
out, err = process.communicate()
1517
if universal_newlines:
1518
out = out.replace('\r\n', '\n')
1519
err = err.replace('\r\n', '\n')
1521
if retcode is not None and retcode != process.returncode:
1522
if process_args is None:
1523
process_args = "(unknown args)"
1524
mutter('Output of bzr %s:\n%s', process_args, out)
1525
mutter('Error for bzr %s:\n%s', process_args, err)
1526
self.fail('Command bzr %s failed with retcode %s != %s'
1527
% (process_args, retcode, process.returncode))
1530
def check_inventory_shape(self, inv, shape):
1531
"""Compare an inventory to a list of expected names.
1533
Fail if they are not precisely equal.
1536
shape = list(shape) # copy
1537
for path, ie in inv.entries():
1538
name = path.replace('\\', '/')
1539
if ie.kind == 'dir':
1546
self.fail("expected paths not found in inventory: %r" % shape)
1548
self.fail("unexpected paths found in inventory: %r" % extras)
1550
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1551
a_callable=None, *args, **kwargs):
1552
"""Call callable with redirected std io pipes.
1554
Returns the return code."""
1555
if not callable(a_callable):
1556
raise ValueError("a_callable must be callable.")
1558
stdin = StringIO("")
1560
if getattr(self, "_log_file", None) is not None:
1561
stdout = self._log_file
1565
if getattr(self, "_log_file", None is not None):
1566
stderr = self._log_file
1569
real_stdin = sys.stdin
1570
real_stdout = sys.stdout
1571
real_stderr = sys.stderr
1576
return a_callable(*args, **kwargs)
1578
sys.stdout = real_stdout
1579
sys.stderr = real_stderr
1580
sys.stdin = real_stdin
1582
def reduceLockdirTimeout(self):
1583
"""Reduce the default lock timeout for the duration of the test, so that
1584
if LockContention occurs during a test, it does so quickly.
1586
Tests that expect to provoke LockContention errors should call this.
1588
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1590
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1591
self.addCleanup(resetTimeout)
1592
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1595
class TestCaseWithMemoryTransport(TestCase):
1596
"""Common test class for tests that do not need disk resources.
1598
Tests that need disk resources should derive from TestCaseWithTransport.
1600
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1602
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1603
a directory which does not exist. This serves to help ensure test isolation
1604
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1605
must exist. However, TestCaseWithMemoryTransport does not offer local
1606
file defaults for the transport in tests, nor does it obey the command line
1607
override, so tests that accidentally write to the common directory should
1610
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1611
a .bzr directory that stops us ascending higher into the filesystem.
1617
def __init__(self, methodName='runTest'):
1618
# allow test parameterisation after test construction and before test
1619
# execution. Variables that the parameteriser sets need to be
1620
# ones that are not set by setUp, or setUp will trash them.
1621
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1622
self.vfs_transport_factory = default_transport
1623
self.transport_server = None
1624
self.transport_readonly_server = None
1625
self.__vfs_server = None
1627
def get_transport(self):
1628
"""Return a writeable transport for the test scratch space"""
1629
t = get_transport(self.get_url())
1630
self.assertFalse(t.is_readonly())
1633
def get_readonly_transport(self):
1634
"""Return a readonly transport for the test scratch space
1636
This can be used to test that operations which should only need
1637
readonly access in fact do not try to write.
1639
t = get_transport(self.get_readonly_url())
1640
self.assertTrue(t.is_readonly())
1643
def create_transport_readonly_server(self):
1644
"""Create a transport server from class defined at init.
1646
This is mostly a hook for daughter classes.
1648
return self.transport_readonly_server()
1650
def get_readonly_server(self):
1651
"""Get the server instance for the readonly transport
1653
This is useful for some tests with specific servers to do diagnostics.
1655
if self.__readonly_server is None:
1656
if self.transport_readonly_server is None:
1657
# readonly decorator requested
1658
# bring up the server
1659
self.__readonly_server = ReadonlyServer()
1660
self.__readonly_server.setUp(self.get_vfs_only_server())
1662
self.__readonly_server = self.create_transport_readonly_server()
1663
self.__readonly_server.setUp(self.get_vfs_only_server())
1664
self.addCleanup(self.__readonly_server.tearDown)
1665
return self.__readonly_server
1667
def get_readonly_url(self, relpath=None):
1668
"""Get a URL for the readonly transport.
1670
This will either be backed by '.' or a decorator to the transport
1671
used by self.get_url()
1672
relpath provides for clients to get a path relative to the base url.
1673
These should only be downwards relative, not upwards.
1675
base = self.get_readonly_server().get_url()
1676
if relpath is not None:
1677
if not base.endswith('/'):
1679
base = base + relpath
1682
def get_vfs_only_server(self):
1683
"""Get the vfs only read/write server instance.
1685
This is useful for some tests with specific servers that need
1688
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1689
is no means to override it.
1691
if self.__vfs_server is None:
1692
self.__vfs_server = MemoryServer()
1693
self.__vfs_server.setUp()
1694
self.addCleanup(self.__vfs_server.tearDown)
1695
return self.__vfs_server
1697
def get_server(self):
1698
"""Get the read/write server instance.
1700
This is useful for some tests with specific servers that need
1703
This is built from the self.transport_server factory. If that is None,
1704
then the self.get_vfs_server is returned.
1706
if self.__server is None:
1707
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1708
return self.get_vfs_only_server()
1710
# bring up a decorated means of access to the vfs only server.
1711
self.__server = self.transport_server()
1713
self.__server.setUp(self.get_vfs_only_server())
1714
except TypeError, e:
1715
# This should never happen; the try:Except here is to assist
1716
# developers having to update code rather than seeing an
1717
# uninformative TypeError.
1718
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1719
self.addCleanup(self.__server.tearDown)
1720
return self.__server
1722
def _adjust_url(self, base, relpath):
1723
"""Get a URL (or maybe a path) for the readwrite transport.
1725
This will either be backed by '.' or to an equivalent non-file based
1727
relpath provides for clients to get a path relative to the base url.
1728
These should only be downwards relative, not upwards.
1730
if relpath is not None and relpath != '.':
1731
if not base.endswith('/'):
1733
# XXX: Really base should be a url; we did after all call
1734
# get_url()! But sometimes it's just a path (from
1735
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1736
# to a non-escaped local path.
1737
if base.startswith('./') or base.startswith('/'):
1740
base += urlutils.escape(relpath)
1743
def get_url(self, relpath=None):
1744
"""Get a URL (or maybe a path) for the readwrite transport.
1746
This will either be backed by '.' or to an equivalent non-file based
1748
relpath provides for clients to get a path relative to the base url.
1749
These should only be downwards relative, not upwards.
1751
base = self.get_server().get_url()
1752
return self._adjust_url(base, relpath)
1754
def get_vfs_only_url(self, relpath=None):
1755
"""Get a URL (or maybe a path for the plain old vfs transport.
1757
This will never be a smart protocol. It always has all the
1758
capabilities of the local filesystem, but it might actually be a
1759
MemoryTransport or some other similar virtual filesystem.
1761
This is the backing transport (if any) of the server returned by
1762
get_url and get_readonly_url.
1764
:param relpath: provides for clients to get a path relative to the base
1765
url. These should only be downwards relative, not upwards.
1767
base = self.get_vfs_only_server().get_url()
1768
return self._adjust_url(base, relpath)
1770
def _make_test_root(self):
1771
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1773
root = tempfile.mkdtemp(prefix='testbzr-', suffix='.tmp')
1774
TestCaseWithMemoryTransport.TEST_ROOT = root
1776
# make a fake bzr directory there to prevent any tests propagating
1777
# up onto the source directory's real branch
1778
bzrdir.BzrDir.create_standalone_workingtree(root)
1780
# The same directory is used by all tests, and we're not specifically
1781
# told when all tests are finished. This will do.
1782
atexit.register(_rmtree_temp_dir, root)
1784
def makeAndChdirToTestDir(self):
1785
"""Create a temporary directories for this one test.
1787
This must set self.test_home_dir and self.test_dir and chdir to
1790
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1792
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1793
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1794
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1796
def make_branch(self, relpath, format=None):
1797
"""Create a branch on the transport at relpath."""
1798
repo = self.make_repository(relpath, format=format)
1799
return repo.bzrdir.create_branch()
1801
def make_bzrdir(self, relpath, format=None):
1803
# might be a relative or absolute path
1804
maybe_a_url = self.get_url(relpath)
1805
segments = maybe_a_url.rsplit('/', 1)
1806
t = get_transport(maybe_a_url)
1807
if len(segments) > 1 and segments[-1] not in ('', '.'):
1811
if isinstance(format, basestring):
1812
format = bzrdir.format_registry.make_bzrdir(format)
1813
return format.initialize_on_transport(t)
1814
except errors.UninitializableFormat:
1815
raise TestSkipped("Format %s is not initializable." % format)
1817
def make_repository(self, relpath, shared=False, format=None):
1818
"""Create a repository on our default transport at relpath.
1820
Note that relpath must be a relative path, not a full url.
1822
# FIXME: If you create a remoterepository this returns the underlying
1823
# real format, which is incorrect. Actually we should make sure that
1824
# RemoteBzrDir returns a RemoteRepository.
1825
# maybe mbp 20070410
1826
made_control = self.make_bzrdir(relpath, format=format)
1827
return made_control.create_repository(shared=shared)
1829
def make_branch_and_memory_tree(self, relpath, format=None):
1830
"""Create a branch on the default transport and a MemoryTree for it."""
1831
b = self.make_branch(relpath, format=format)
1832
return memorytree.MemoryTree.create_on_branch(b)
1834
def overrideEnvironmentForTesting(self):
1835
os.environ['HOME'] = self.test_home_dir
1836
os.environ['BZR_HOME'] = self.test_home_dir
1839
super(TestCaseWithMemoryTransport, self).setUp()
1840
self._make_test_root()
1841
_currentdir = os.getcwdu()
1842
def _leaveDirectory():
1843
os.chdir(_currentdir)
1844
self.addCleanup(_leaveDirectory)
1845
self.makeAndChdirToTestDir()
1846
self.overrideEnvironmentForTesting()
1847
self.__readonly_server = None
1848
self.__server = None
1849
self.reduceLockdirTimeout()
1852
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1853
"""Derived class that runs a test within a temporary directory.
1855
This is useful for tests that need to create a branch, etc.
1857
The directory is created in a slightly complex way: for each
1858
Python invocation, a new temporary top-level directory is created.
1859
All test cases create their own directory within that. If the
1860
tests complete successfully, the directory is removed.
1862
:ivar test_base_dir: The path of the top-level directory for this
1863
test, which contains a home directory and a work directory.
1865
:ivar test_home_dir: An initially empty directory under test_base_dir
1866
which is used as $HOME for this test.
1868
:ivar test_dir: A directory under test_base_dir used as the current
1869
directory when the test proper is run.
1872
OVERRIDE_PYTHON = 'python'
1873
use_numbered_dirs = False
1875
def check_file_contents(self, filename, expect):
1876
self.log("check contents of file %s" % filename)
1877
contents = file(filename, 'r').read()
1878
if contents != expect:
1879
self.log("expected: %r" % expect)
1880
self.log("actually: %r" % contents)
1881
self.fail("contents of %s not as expected" % filename)
1883
def makeAndChdirToTestDir(self):
1884
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1886
For TestCaseInTempDir we create a temporary directory based on the test
1887
name and then create two subdirs - test and home under it.
1889
# create a directory within the top level test directory
1890
candidate_dir = tempfile.mkdtemp(dir=self.TEST_ROOT)
1891
# now create test and home directories within this dir
1892
self.test_base_dir = candidate_dir
1893
self.test_home_dir = self.test_base_dir + '/home'
1894
os.mkdir(self.test_home_dir)
1895
self.test_dir = self.test_base_dir + '/work'
1896
os.mkdir(self.test_dir)
1897
os.chdir(self.test_dir)
1898
# put name of test inside
1899
f = file(self.test_base_dir + '/name', 'w')
1904
self.addCleanup(self.deleteTestDir)
1906
def deleteTestDir(self):
1907
_rmtree_temp_dir(self.test_base_dir)
1909
def build_tree(self, shape, line_endings='binary', transport=None):
1910
"""Build a test tree according to a pattern.
1912
shape is a sequence of file specifications. If the final
1913
character is '/', a directory is created.
1915
This assumes that all the elements in the tree being built are new.
1917
This doesn't add anything to a branch.
1918
:param line_endings: Either 'binary' or 'native'
1919
in binary mode, exact contents are written
1920
in native mode, the line endings match the
1921
default platform endings.
1923
:param transport: A transport to write to, for building trees on
1924
VFS's. If the transport is readonly or None,
1925
"." is opened automatically.
1927
# It's OK to just create them using forward slashes on windows.
1928
if transport is None or transport.is_readonly():
1929
transport = get_transport(".")
1931
self.assert_(isinstance(name, basestring))
1933
transport.mkdir(urlutils.escape(name[:-1]))
1935
if line_endings == 'binary':
1937
elif line_endings == 'native':
1940
raise errors.BzrError(
1941
'Invalid line ending request %r' % line_endings)
1942
content = "contents of %s%s" % (name.encode('utf-8'), end)
1943
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1945
def build_tree_contents(self, shape):
1946
build_tree_contents(shape)
1948
def assertFileEqual(self, content, path):
1949
"""Fail if path does not contain 'content'."""
1950
self.failUnlessExists(path)
1951
f = file(path, 'rb')
1956
self.assertEqualDiff(content, s)
1958
def failUnlessExists(self, path):
1959
"""Fail unless path or paths, which may be abs or relative, exist."""
1960
if not isinstance(path, basestring):
1962
self.failUnlessExists(p)
1964
self.failUnless(osutils.lexists(path),path+" does not exist")
1966
def failIfExists(self, path):
1967
"""Fail if path or paths, which may be abs or relative, exist."""
1968
if not isinstance(path, basestring):
1970
self.failIfExists(p)
1972
self.failIf(osutils.lexists(path),path+" exists")
1974
def assertInWorkingTree(self,path,root_path='.',tree=None):
1975
"""Assert whether path or paths are in the WorkingTree"""
1977
tree = workingtree.WorkingTree.open(root_path)
1978
if not isinstance(path, basestring):
1980
self.assertInWorkingTree(p,tree=tree)
1982
self.assertIsNot(tree.path2id(path), None,
1983
path+' not in working tree.')
1985
def assertNotInWorkingTree(self,path,root_path='.',tree=None):
1986
"""Assert whether path or paths are not in the WorkingTree"""
1988
tree = workingtree.WorkingTree.open(root_path)
1989
if not isinstance(path, basestring):
1991
self.assertNotInWorkingTree(p,tree=tree)
1993
self.assertIs(tree.path2id(path), None, path+' in working tree.')
1996
class TestCaseWithTransport(TestCaseInTempDir):
1997
"""A test case that provides get_url and get_readonly_url facilities.
1999
These back onto two transport servers, one for readonly access and one for
2002
If no explicit class is provided for readonly access, a
2003
ReadonlyTransportDecorator is used instead which allows the use of non disk
2004
based read write transports.
2006
If an explicit class is provided for readonly access, that server and the
2007
readwrite one must both define get_url() as resolving to os.getcwd().
2010
def get_vfs_only_server(self):
2011
"""See TestCaseWithMemoryTransport.
2013
This is useful for some tests with specific servers that need
2016
if self.__vfs_server is None:
2017
self.__vfs_server = self.vfs_transport_factory()
2018
self.__vfs_server.setUp()
2019
self.addCleanup(self.__vfs_server.tearDown)
2020
return self.__vfs_server
2022
def make_branch_and_tree(self, relpath, format=None):
2023
"""Create a branch on the transport and a tree locally.
2025
If the transport is not a LocalTransport, the Tree can't be created on
2026
the transport. In that case if the vfs_transport_factory is
2027
LocalURLServer the working tree is created in the local
2028
directory backing the transport, and the returned tree's branch and
2029
repository will also be accessed locally. Otherwise a lightweight
2030
checkout is created and returned.
2032
:param format: The BzrDirFormat.
2033
:returns: the WorkingTree.
2035
# TODO: always use the local disk path for the working tree,
2036
# this obviously requires a format that supports branch references
2037
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2039
b = self.make_branch(relpath, format=format)
2041
return b.bzrdir.create_workingtree()
2042
except errors.NotLocalUrl:
2043
# We can only make working trees locally at the moment. If the
2044
# transport can't support them, then we keep the non-disk-backed
2045
# branch and create a local checkout.
2046
if self.vfs_transport_factory is LocalURLServer:
2047
# the branch is colocated on disk, we cannot create a checkout.
2048
# hopefully callers will expect this.
2049
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2050
return local_controldir.create_workingtree()
2052
return b.create_checkout(relpath, lightweight=True)
2054
def assertIsDirectory(self, relpath, transport):
2055
"""Assert that relpath within transport is a directory.
2057
This may not be possible on all transports; in that case it propagates
2058
a TransportNotPossible.
2061
mode = transport.stat(relpath).st_mode
2062
except errors.NoSuchFile:
2063
self.fail("path %s is not a directory; no such file"
2065
if not stat.S_ISDIR(mode):
2066
self.fail("path %s is not a directory; has mode %#o"
2069
def assertTreesEqual(self, left, right):
2070
"""Check that left and right have the same content and properties."""
2071
# we use a tree delta to check for equality of the content, and we
2072
# manually check for equality of other things such as the parents list.
2073
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2074
differences = left.changes_from(right)
2075
self.assertFalse(differences.has_changed(),
2076
"Trees %r and %r are different: %r" % (left, right, differences))
2079
super(TestCaseWithTransport, self).setUp()
2080
self.__vfs_server = None
2083
class ChrootedTestCase(TestCaseWithTransport):
2084
"""A support class that provides readonly urls outside the local namespace.
2086
This is done by checking if self.transport_server is a MemoryServer. if it
2087
is then we are chrooted already, if it is not then an HttpServer is used
2090
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2091
be used without needed to redo it when a different
2092
subclass is in use ?
2096
super(ChrootedTestCase, self).setUp()
2097
if not self.vfs_transport_factory == MemoryServer:
2098
self.transport_readonly_server = HttpServer
2101
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2102
random_order=False):
2103
"""Create a test suite by filtering another one.
2105
:param suite: the source suite
2106
:param pattern: pattern that names must match
2107
:param exclude_pattern: pattern that names must not match, if any
2108
:param random_order: if True, tests in the new suite will be put in
2110
:returns: the newly created suite
2112
return sort_suite_by_re(suite, pattern, exclude_pattern,
2113
random_order, False)
2116
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2117
random_order=False, append_rest=True):
2118
"""Create a test suite by sorting another one.
2120
:param suite: the source suite
2121
:param pattern: pattern that names must match in order to go
2122
first in the new suite
2123
:param exclude_pattern: pattern that names must not match, if any
2124
:param random_order: if True, tests in the new suite will be put in
2126
:param append_rest: if False, pattern is a strict filter and not
2127
just an ordering directive
2128
:returns: the newly created suite
2132
filter_re = re.compile(pattern)
2133
if exclude_pattern is not None:
2134
exclude_re = re.compile(exclude_pattern)
2135
for test in iter_suite_tests(suite):
2137
if exclude_pattern is None or not exclude_re.search(test_id):
2138
if filter_re.search(test_id):
2143
random.shuffle(first)
2144
random.shuffle(second)
2145
return TestUtil.TestSuite(first + second)
2148
def run_suite(suite, name='test', verbose=False, pattern=".*",
2149
stop_on_failure=False,
2150
transport=None, lsprof_timed=None, bench_history=None,
2151
matching_tests_first=None,
2155
exclude_pattern=None,
2157
use_numbered_dirs = bool(numbered_dirs)
2159
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2160
if numbered_dirs is not None:
2161
TestCaseInTempDir.use_numbered_dirs = use_numbered_dirs
2166
runner = TextTestRunner(stream=sys.stdout,
2168
verbosity=verbosity,
2169
bench_history=bench_history,
2170
use_numbered_dirs=use_numbered_dirs,
2171
list_only=list_only,
2173
runner.stop_on_failure=stop_on_failure
2174
# Initialise the random number generator and display the seed used.
2175
# We convert the seed to a long to make it reuseable across invocations.
2176
random_order = False
2177
if random_seed is not None:
2179
if random_seed == "now":
2180
random_seed = long(time.time())
2182
# Convert the seed to a long if we can
2184
random_seed = long(random_seed)
2187
runner.stream.writeln("Randomizing test order using seed %s\n" %
2189
random.seed(random_seed)
2190
# Customise the list of tests if requested
2191
if pattern != '.*' or exclude_pattern is not None or random_order:
2192
if matching_tests_first:
2193
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
2196
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
2198
result = runner.run(suite)
2199
return result.wasSuccessful()
2202
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2204
test_suite_factory=None,
2207
matching_tests_first=None,
2211
exclude_pattern=None):
2212
"""Run the whole test suite under the enhanced runner"""
2213
# XXX: Very ugly way to do this...
2214
# Disable warning about old formats because we don't want it to disturb
2215
# any blackbox tests.
2216
from bzrlib import repository
2217
repository._deprecation_warning_done = True
2219
global default_transport
2220
if transport is None:
2221
transport = default_transport
2222
old_transport = default_transport
2223
default_transport = transport
2225
if test_suite_factory is None:
2226
suite = test_suite()
2228
suite = test_suite_factory()
2229
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2230
stop_on_failure=stop_on_failure,
2231
transport=transport,
2232
lsprof_timed=lsprof_timed,
2233
bench_history=bench_history,
2234
matching_tests_first=matching_tests_first,
2235
numbered_dirs=numbered_dirs,
2236
list_only=list_only,
2237
random_seed=random_seed,
2238
exclude_pattern=exclude_pattern)
2240
default_transport = old_transport
2244
"""Build and return TestSuite for the whole of bzrlib.
2246
This function can be replaced if you need to change the default test
2247
suite on a global basis, but it is not encouraged.
2250
'bzrlib.tests.test_ancestry',
2251
'bzrlib.tests.test_annotate',
2252
'bzrlib.tests.test_api',
2253
'bzrlib.tests.test_atomicfile',
2254
'bzrlib.tests.test_bad_files',
2255
'bzrlib.tests.test_branch',
2256
'bzrlib.tests.test_branchbuilder',
2257
'bzrlib.tests.test_bugtracker',
2258
'bzrlib.tests.test_bundle',
2259
'bzrlib.tests.test_bzrdir',
2260
'bzrlib.tests.test_cache_utf8',
2261
'bzrlib.tests.test_commands',
2262
'bzrlib.tests.test_commit',
2263
'bzrlib.tests.test_commit_merge',
2264
'bzrlib.tests.test_config',
2265
'bzrlib.tests.test_conflicts',
2266
'bzrlib.tests.test_counted_lock',
2267
'bzrlib.tests.test_decorators',
2268
'bzrlib.tests.test_delta',
2269
'bzrlib.tests.test_diff',
2270
'bzrlib.tests.test_dirstate',
2271
'bzrlib.tests.test_errors',
2272
'bzrlib.tests.test_escaped_store',
2273
'bzrlib.tests.test_extract',
2274
'bzrlib.tests.test_fetch',
2275
'bzrlib.tests.test_ftp_transport',
2276
'bzrlib.tests.test_generate_docs',
2277
'bzrlib.tests.test_generate_ids',
2278
'bzrlib.tests.test_globbing',
2279
'bzrlib.tests.test_gpg',
2280
'bzrlib.tests.test_graph',
2281
'bzrlib.tests.test_hashcache',
2282
'bzrlib.tests.test_help',
2283
'bzrlib.tests.test_http',
2284
'bzrlib.tests.test_http_response',
2285
'bzrlib.tests.test_https_ca_bundle',
2286
'bzrlib.tests.test_identitymap',
2287
'bzrlib.tests.test_ignores',
2288
'bzrlib.tests.test_info',
2289
'bzrlib.tests.test_inv',
2290
'bzrlib.tests.test_knit',
2291
'bzrlib.tests.test_lazy_import',
2292
'bzrlib.tests.test_lazy_regex',
2293
'bzrlib.tests.test_lockdir',
2294
'bzrlib.tests.test_lockable_files',
2295
'bzrlib.tests.test_log',
2296
'bzrlib.tests.test_lsprof',
2297
'bzrlib.tests.test_memorytree',
2298
'bzrlib.tests.test_merge',
2299
'bzrlib.tests.test_merge3',
2300
'bzrlib.tests.test_merge_core',
2301
'bzrlib.tests.test_merge_directive',
2302
'bzrlib.tests.test_missing',
2303
'bzrlib.tests.test_msgeditor',
2304
'bzrlib.tests.test_nonascii',
2305
'bzrlib.tests.test_options',
2306
'bzrlib.tests.test_osutils',
2307
'bzrlib.tests.test_osutils_encodings',
2308
'bzrlib.tests.test_patch',
2309
'bzrlib.tests.test_patches',
2310
'bzrlib.tests.test_permissions',
2311
'bzrlib.tests.test_plugins',
2312
'bzrlib.tests.test_progress',
2313
'bzrlib.tests.test_reconcile',
2314
'bzrlib.tests.test_registry',
2315
'bzrlib.tests.test_remote',
2316
'bzrlib.tests.test_repository',
2317
'bzrlib.tests.test_revert',
2318
'bzrlib.tests.test_revision',
2319
'bzrlib.tests.test_revisionnamespaces',
2320
'bzrlib.tests.test_revisiontree',
2321
'bzrlib.tests.test_rio',
2322
'bzrlib.tests.test_sampler',
2323
'bzrlib.tests.test_selftest',
2324
'bzrlib.tests.test_setup',
2325
'bzrlib.tests.test_sftp_transport',
2326
'bzrlib.tests.test_smart',
2327
'bzrlib.tests.test_smart_add',
2328
'bzrlib.tests.test_smart_transport',
2329
'bzrlib.tests.test_source',
2330
'bzrlib.tests.test_ssh_transport',
2331
'bzrlib.tests.test_status',
2332
'bzrlib.tests.test_store',
2333
'bzrlib.tests.test_strace',
2334
'bzrlib.tests.test_subsume',
2335
'bzrlib.tests.test_symbol_versioning',
2336
'bzrlib.tests.test_tag',
2337
'bzrlib.tests.test_testament',
2338
'bzrlib.tests.test_textfile',
2339
'bzrlib.tests.test_textmerge',
2340
'bzrlib.tests.test_timestamp',
2341
'bzrlib.tests.test_trace',
2342
'bzrlib.tests.test_transactions',
2343
'bzrlib.tests.test_transform',
2344
'bzrlib.tests.test_transport',
2345
'bzrlib.tests.test_tree',
2346
'bzrlib.tests.test_treebuilder',
2347
'bzrlib.tests.test_tsort',
2348
'bzrlib.tests.test_tuned_gzip',
2349
'bzrlib.tests.test_ui',
2350
'bzrlib.tests.test_upgrade',
2351
'bzrlib.tests.test_urlutils',
2352
'bzrlib.tests.test_versionedfile',
2353
'bzrlib.tests.test_version',
2354
'bzrlib.tests.test_version_info',
2355
'bzrlib.tests.test_weave',
2356
'bzrlib.tests.test_whitebox',
2357
'bzrlib.tests.test_workingtree',
2358
'bzrlib.tests.test_workingtree_4',
2359
'bzrlib.tests.test_wsgi',
2360
'bzrlib.tests.test_xml',
2362
test_transport_implementations = [
2363
'bzrlib.tests.test_transport_implementations',
2364
'bzrlib.tests.test_read_bundle',
2366
suite = TestUtil.TestSuite()
2367
loader = TestUtil.TestLoader()
2368
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2369
from bzrlib.transport import TransportTestProviderAdapter
2370
adapter = TransportTestProviderAdapter()
2371
adapt_modules(test_transport_implementations, adapter, loader, suite)
2372
for package in packages_to_test():
2373
suite.addTest(package.test_suite())
2374
for m in MODULES_TO_TEST:
2375
suite.addTest(loader.loadTestsFromModule(m))
2376
for m in MODULES_TO_DOCTEST:
2378
suite.addTest(doctest.DocTestSuite(m))
2379
except ValueError, e:
2380
print '**failed to get doctest for: %s\n%s' %(m,e)
2382
for name, plugin in bzrlib.plugin.all_plugins().items():
2383
if getattr(plugin, 'test_suite', None) is not None:
2384
default_encoding = sys.getdefaultencoding()
2386
plugin_suite = plugin.test_suite()
2387
except ImportError, e:
2388
bzrlib.trace.warning(
2389
'Unable to test plugin "%s": %s', name, e)
2391
suite.addTest(plugin_suite)
2392
if default_encoding != sys.getdefaultencoding():
2393
bzrlib.trace.warning(
2394
'Plugin "%s" tried to reset default encoding to: %s', name,
2395
sys.getdefaultencoding())
2397
sys.setdefaultencoding(default_encoding)
2401
def adapt_modules(mods_list, adapter, loader, suite):
2402
"""Adapt the modules in mods_list using adapter and add to suite."""
2403
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2404
suite.addTests(adapter.adapt(test))
2407
def _rmtree_temp_dir(dirname):
2408
# If LANG=C we probably have created some bogus paths
2409
# which rmtree(unicode) will fail to delete
2410
# so make sure we are using rmtree(str) to delete everything
2411
# except on win32, where rmtree(str) will fail
2412
# since it doesn't have the property of byte-stream paths
2413
# (they are either ascii or mbcs)
2414
if sys.platform == 'win32':
2415
# make sure we are using the unicode win32 api
2416
dirname = unicode(dirname)
2418
dirname = dirname.encode(sys.getfilesystemencoding())
2420
osutils.rmtree(dirname)
2422
if sys.platform == 'win32' and e.errno == errno.EACCES:
2423
print >>sys.stderr, ('Permission denied: '
2424
'unable to remove testing dir '
2425
'%s' % os.path.basename(dirname))
2430
def clean_selftest_output(root=None, quiet=False):
2431
"""Remove all selftest output directories from root directory.
2433
:param root: root directory for clean
2434
(if ommitted or None then clean current directory).
2435
:param quiet: suppress report about deleting directories
2438
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
2441
for i in os.listdir(root):
2442
if os.path.isdir(i) and re_dir.match(i):
2444
print 'delete directory:', i
2448
class Feature(object):
2449
"""An operating system Feature."""
2452
self._available = None
2454
def available(self):
2455
"""Is the feature available?
2457
:return: True if the feature is available.
2459
if self._available is None:
2460
self._available = self._probe()
2461
return self._available
2464
"""Implement this method in concrete features.
2466
:return: True if the feature is available.
2468
raise NotImplementedError
2471
if getattr(self, 'feature_name', None):
2472
return self.feature_name()
2473
return self.__class__.__name__
added
removed
bzrlib/tests/__init__.py
