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.
30
from cStringIO import StringIO
36
from pprint import pformat
40
from subprocess import Popen, PIPE
58
import bzrlib.commands
59
import bzrlib.timestamp
61
import bzrlib.inventory
62
import bzrlib.iterablefile
67
# lsprof not available
69
from bzrlib.merge import merge_inner
73
from bzrlib.revision import common_ancestor
75
from bzrlib import symbol_versioning
77
from bzrlib.transport import get_transport
78
import bzrlib.transport
79
from bzrlib.transport.local import LocalURLServer
80
from bzrlib.transport.memory import MemoryServer
81
from bzrlib.transport.readonly import ReadonlyServer
82
from bzrlib.trace import mutter, note
83
from bzrlib.tests import TestUtil
84
from bzrlib.tests.HttpServer import HttpServer
85
from bzrlib.tests.TestUtil import (
89
from bzrlib.tests.treeshape import build_tree_contents
90
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
92
default_transport = LocalURLServer
95
MODULES_TO_DOCTEST = [
108
def packages_to_test():
109
"""Return a list of packages to test.
111
The packages are not globally imported so that import failures are
112
triggered when running selftest, not when importing the command.
115
import bzrlib.tests.blackbox
116
import bzrlib.tests.branch_implementations
117
import bzrlib.tests.bzrdir_implementations
118
import bzrlib.tests.interrepository_implementations
119
import bzrlib.tests.interversionedfile_implementations
120
import bzrlib.tests.intertree_implementations
121
import bzrlib.tests.per_lock
122
import bzrlib.tests.repository_implementations
123
import bzrlib.tests.revisionstore_implementations
124
import bzrlib.tests.tree_implementations
125
import bzrlib.tests.workingtree_implementations
128
bzrlib.tests.blackbox,
129
bzrlib.tests.branch_implementations,
130
bzrlib.tests.bzrdir_implementations,
131
bzrlib.tests.interrepository_implementations,
132
bzrlib.tests.interversionedfile_implementations,
133
bzrlib.tests.intertree_implementations,
134
bzrlib.tests.per_lock,
135
bzrlib.tests.repository_implementations,
136
bzrlib.tests.revisionstore_implementations,
137
bzrlib.tests.tree_implementations,
138
bzrlib.tests.workingtree_implementations,
142
class ExtendedTestResult(unittest._TextTestResult):
143
"""Accepts, reports and accumulates the results of running tests.
145
Compared to this unittest version this class adds support for profiling,
146
benchmarking, stopping as soon as a test fails, and skipping tests.
147
There are further-specialized subclasses for different types of display.
152
def __init__(self, stream, descriptions, verbosity,
155
use_numbered_dirs=False,
157
"""Construct new TestResult.
159
:param bench_history: Optionally, a writable file object to accumulate
162
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
163
if bench_history is not None:
164
from bzrlib.version import _get_bzr_source_tree
165
src_tree = _get_bzr_source_tree()
168
revision_id = src_tree.get_parent_ids()[0]
170
# XXX: if this is a brand new tree, do the same as if there
174
# XXX: If there's no branch, what should we do?
176
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
177
self._bench_history = bench_history
178
self.ui = ui.ui_factory
179
self.num_tests = num_tests
181
self.failure_count = 0
182
self.known_failure_count = 0
184
self.unsupported = {}
186
self.use_numbered_dirs = use_numbered_dirs
187
self._overall_start_time = time.time()
189
def extractBenchmarkTime(self, testCase):
190
"""Add a benchmark time for the current test case."""
191
self._benchmarkTime = getattr(testCase, "_benchtime", None)
193
def _elapsedTestTimeString(self):
194
"""Return a time string for the overall time the current test has taken."""
195
return self._formatTime(time.time() - self._start_time)
197
def _testTimeString(self):
198
if self._benchmarkTime is not None:
200
self._formatTime(self._benchmarkTime),
201
self._elapsedTestTimeString())
203
return " %s" % self._elapsedTestTimeString()
205
def _formatTime(self, seconds):
206
"""Format seconds as milliseconds with leading spaces."""
207
# some benchmarks can take thousands of seconds to run, so we need 8
209
return "%8dms" % (1000 * seconds)
211
def _shortened_test_description(self, test):
213
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
216
def startTest(self, test):
217
unittest.TestResult.startTest(self, test)
218
self.report_test_start(test)
219
test.number = self.count
220
self._recordTestStartTime()
222
def _recordTestStartTime(self):
223
"""Record that a test has started."""
224
self._start_time = time.time()
226
def _cleanupLogFile(self, test):
227
# We can only do this if we have one of our TestCases, not if
229
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
230
if setKeepLogfile is not None:
233
def addError(self, test, err):
234
self.extractBenchmarkTime(test)
235
self._cleanupLogFile(test)
236
if isinstance(err[1], TestSkipped):
237
return self.addSkipped(test, err)
238
elif isinstance(err[1], UnavailableFeature):
239
return self.addNotSupported(test, err[1].args[0])
240
unittest.TestResult.addError(self, test, err)
241
self.error_count += 1
242
self.report_error(test, err)
246
def addFailure(self, test, err):
247
self._cleanupLogFile(test)
248
self.extractBenchmarkTime(test)
249
if isinstance(err[1], KnownFailure):
250
return self.addKnownFailure(test, err)
251
unittest.TestResult.addFailure(self, test, err)
252
self.failure_count += 1
253
self.report_failure(test, err)
257
def addKnownFailure(self, test, err):
258
self.known_failure_count += 1
259
self.report_known_failure(test, err)
261
def addNotSupported(self, test, feature):
262
self.unsupported.setdefault(str(feature), 0)
263
self.unsupported[str(feature)] += 1
264
self.report_unsupported(test, feature)
266
def addSuccess(self, test):
267
self.extractBenchmarkTime(test)
268
if self._bench_history is not None:
269
if self._benchmarkTime is not None:
270
self._bench_history.write("%s %s\n" % (
271
self._formatTime(self._benchmarkTime),
273
self.report_success(test)
274
unittest.TestResult.addSuccess(self, test)
276
def addSkipped(self, test, skip_excinfo):
277
self.report_skip(test, skip_excinfo)
278
# seems best to treat this as success from point-of-view of unittest
279
# -- it actually does nothing so it barely matters :)
282
except KeyboardInterrupt:
285
self.addError(test, test.__exc_info())
287
unittest.TestResult.addSuccess(self, test)
289
def printErrorList(self, flavour, errors):
290
for test, err in errors:
291
self.stream.writeln(self.separator1)
292
self.stream.write("%s: " % flavour)
293
if self.use_numbered_dirs:
294
self.stream.write('#%d ' % test.number)
295
self.stream.writeln(self.getDescription(test))
296
if getattr(test, '_get_log', None) is not None:
298
print >>self.stream, \
299
('vvvv[log from %s]' % test.id()).ljust(78,'-')
300
print >>self.stream, test._get_log()
301
print >>self.stream, \
302
('^^^^[log from %s]' % test.id()).ljust(78,'-')
303
self.stream.writeln(self.separator2)
304
self.stream.writeln("%s" % err)
309
def report_cleaning_up(self):
312
def report_success(self, test):
316
class TextTestResult(ExtendedTestResult):
317
"""Displays progress and results of tests in text form"""
319
def __init__(self, stream, descriptions, verbosity,
323
use_numbered_dirs=False,
325
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
326
bench_history, num_tests, use_numbered_dirs)
328
self.pb = self.ui.nested_progress_bar()
329
self._supplied_pb = False
332
self._supplied_pb = True
333
self.pb.show_pct = False
334
self.pb.show_spinner = False
335
self.pb.show_eta = False,
336
self.pb.show_count = False
337
self.pb.show_bar = False
339
def report_starting(self):
340
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
342
def _progress_prefix_text(self):
343
a = '[%d' % self.count
344
if self.num_tests is not None:
345
a +='/%d' % self.num_tests
346
a += ' in %ds' % (time.time() - self._overall_start_time)
348
a += ', %d errors' % self.error_count
349
if self.failure_count:
350
a += ', %d failed' % self.failure_count
351
if self.known_failure_count:
352
a += ', %d known failures' % self.known_failure_count
354
a += ', %d skipped' % self.skip_count
356
a += ', %d missing features' % len(self.unsupported)
360
def report_test_start(self, test):
363
self._progress_prefix_text()
365
+ self._shortened_test_description(test))
367
def _test_description(self, test):
368
if self.use_numbered_dirs:
369
return '#%d %s' % (self.count,
370
self._shortened_test_description(test))
372
return self._shortened_test_description(test)
374
def report_error(self, test, err):
375
self.pb.note('ERROR: %s\n %s\n',
376
self._test_description(test),
380
def report_failure(self, test, err):
381
self.pb.note('FAIL: %s\n %s\n',
382
self._test_description(test),
386
def report_known_failure(self, test, err):
387
self.pb.note('XFAIL: %s\n%s\n',
388
self._test_description(test), err[1])
390
def report_skip(self, test, skip_excinfo):
393
# at the moment these are mostly not things we can fix
394
# and so they just produce stipple; use the verbose reporter
397
# show test and reason for skip
398
self.pb.note('SKIP: %s\n %s\n',
399
self._shortened_test_description(test),
402
# since the class name was left behind in the still-visible
404
self.pb.note('SKIP: %s', skip_excinfo[1])
406
def report_unsupported(self, test, feature):
407
"""test cannot be run because feature is missing."""
409
def report_cleaning_up(self):
410
self.pb.update('cleaning up...')
413
if not self._supplied_pb:
417
class VerboseTestResult(ExtendedTestResult):
418
"""Produce long output, with one line per test run plus times"""
420
def _ellipsize_to_right(self, a_string, final_width):
421
"""Truncate and pad a string, keeping the right hand side"""
422
if len(a_string) > final_width:
423
result = '...' + a_string[3-final_width:]
426
return result.ljust(final_width)
428
def report_starting(self):
429
self.stream.write('running %d tests...\n' % self.num_tests)
431
def report_test_start(self, test):
433
name = self._shortened_test_description(test)
434
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
435
# numbers, plus a trailing blank
436
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
437
if self.use_numbered_dirs:
438
self.stream.write('%5d ' % self.count)
439
self.stream.write(self._ellipsize_to_right(name,
440
osutils.terminal_width()-36))
442
self.stream.write(self._ellipsize_to_right(name,
443
osutils.terminal_width()-30))
446
def _error_summary(self, err):
448
if self.use_numbered_dirs:
450
return '%s%s' % (indent, err[1])
452
def report_error(self, test, err):
453
self.stream.writeln('ERROR %s\n%s'
454
% (self._testTimeString(),
455
self._error_summary(err)))
457
def report_failure(self, test, err):
458
self.stream.writeln(' FAIL %s\n%s'
459
% (self._testTimeString(),
460
self._error_summary(err)))
462
def report_known_failure(self, test, err):
463
self.stream.writeln('XFAIL %s\n%s'
464
% (self._testTimeString(),
465
self._error_summary(err)))
467
def report_success(self, test):
468
self.stream.writeln(' OK %s' % self._testTimeString())
469
for bench_called, stats in getattr(test, '_benchcalls', []):
470
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
471
stats.pprint(file=self.stream)
472
# flush the stream so that we get smooth output. This verbose mode is
473
# used to show the output in PQM.
476
def report_skip(self, test, skip_excinfo):
478
self.stream.writeln(' SKIP %s\n%s'
479
% (self._testTimeString(),
480
self._error_summary(skip_excinfo)))
482
def report_unsupported(self, test, feature):
483
"""test cannot be run because feature is missing."""
484
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
485
%(self._testTimeString(), feature))
489
class TextTestRunner(object):
490
stop_on_failure = False
498
use_numbered_dirs=False,
500
self.stream = unittest._WritelnDecorator(stream)
501
self.descriptions = descriptions
502
self.verbosity = verbosity
503
self.keep_output = keep_output
504
self._bench_history = bench_history
505
self.use_numbered_dirs = use_numbered_dirs
508
"Run the given test case or test suite."
509
startTime = time.time()
510
if self.verbosity == 1:
511
result_class = TextTestResult
512
elif self.verbosity >= 2:
513
result_class = VerboseTestResult
514
result = result_class(self.stream,
517
bench_history=self._bench_history,
518
num_tests=test.countTestCases(),
519
use_numbered_dirs=self.use_numbered_dirs,
521
result.stop_early = self.stop_on_failure
522
result.report_starting()
524
stopTime = time.time()
525
timeTaken = stopTime - startTime
527
self.stream.writeln(result.separator2)
528
run = result.testsRun
529
self.stream.writeln("Ran %d test%s in %.3fs" %
530
(run, run != 1 and "s" or "", timeTaken))
531
self.stream.writeln()
532
if not result.wasSuccessful():
533
self.stream.write("FAILED (")
534
failed, errored = map(len, (result.failures, result.errors))
536
self.stream.write("failures=%d" % failed)
538
if failed: self.stream.write(", ")
539
self.stream.write("errors=%d" % errored)
540
if result.known_failure_count:
541
if failed or errored: self.stream.write(", ")
542
self.stream.write("known_failure_count=%d" %
543
result.known_failure_count)
544
self.stream.writeln(")")
546
if result.known_failure_count:
547
self.stream.writeln("OK (known_failures=%d)" %
548
result.known_failure_count)
550
self.stream.writeln("OK")
551
if result.skip_count > 0:
552
skipped = result.skip_count
553
self.stream.writeln('%d test%s skipped' %
554
(skipped, skipped != 1 and "s" or ""))
555
if result.unsupported:
556
for feature, count in sorted(result.unsupported.items()):
557
self.stream.writeln("Missing feature '%s' skipped %d tests." %
559
result.report_cleaning_up()
560
# This is still a little bogus,
561
# but only a little. Folk not using our testrunner will
562
# have to delete their temp directories themselves.
563
test_root = TestCaseWithMemoryTransport.TEST_ROOT
564
if result.wasSuccessful() or not self.keep_output:
565
if test_root is not None:
566
# If LANG=C we probably have created some bogus paths
567
# which rmtree(unicode) will fail to delete
568
# so make sure we are using rmtree(str) to delete everything
569
# except on win32, where rmtree(str) will fail
570
# since it doesn't have the property of byte-stream paths
571
# (they are either ascii or mbcs)
572
if sys.platform == 'win32':
573
# make sure we are using the unicode win32 api
574
test_root = unicode(test_root)
576
test_root = test_root.encode(
577
sys.getfilesystemencoding())
578
_rmtree_temp_dir(test_root)
580
note("Failed tests working directories are in '%s'\n", test_root)
581
TestCaseWithMemoryTransport.TEST_ROOT = None
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)
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, indent=4), pformat(b, indent=4)))
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
:param deprecation_format: The deprecation format that the callable
993
should have been deprecated with. This is the same type as the
994
parameter to deprecated_method/deprecated_function. If the
995
callable is not deprecated with this format, an assertion error
997
:param a_callable: A callable to call. This may be a bound method or
998
a regular function. It will be called with *args and **kwargs.
999
:param args: The positional arguments for the callable
1000
:param kwargs: The keyword arguments for the callable
1001
:return: The result of a_callable(*args, **kwargs)
1003
call_warnings, result = self._capture_warnings(a_callable,
1005
expected_first_warning = symbol_versioning.deprecation_string(
1006
a_callable, deprecation_format)
1007
if len(call_warnings) == 0:
1008
self.fail("No deprecation warning generated by call to %s" %
1010
self.assertEqual(expected_first_warning, call_warnings[0])
1013
def callDeprecated(self, expected, callable, *args, **kwargs):
1014
"""Assert that a callable is deprecated in a particular way.
1016
This is a very precise test for unusual requirements. The
1017
applyDeprecated helper function is probably more suited for most tests
1018
as it allows you to simply specify the deprecation format being used
1019
and will ensure that that is issued for the function being called.
1021
:param expected: a list of the deprecation warnings expected, in order
1022
:param callable: The callable to call
1023
:param args: The positional arguments for the callable
1024
:param kwargs: The keyword arguments for the callable
1026
call_warnings, result = self._capture_warnings(callable,
1028
self.assertEqual(expected, call_warnings)
1031
def _startLogFile(self):
1032
"""Send bzr and test log messages to a temporary file.
1034
The file is removed as the test is torn down.
1036
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1037
self._log_file = os.fdopen(fileno, 'w+')
1038
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1039
self._log_file_name = name
1040
self.addCleanup(self._finishLogFile)
1042
def _finishLogFile(self):
1043
"""Finished with the log file.
1045
Close the file and delete it, unless setKeepLogfile was called.
1047
if self._log_file is None:
1049
bzrlib.trace.disable_test_log(self._log_nonce)
1050
self._log_file.close()
1051
self._log_file = None
1052
if not self._keep_log_file:
1053
os.remove(self._log_file_name)
1054
self._log_file_name = None
1056
def setKeepLogfile(self):
1057
"""Make the logfile not be deleted when _finishLogFile is called."""
1058
self._keep_log_file = True
1060
def addCleanup(self, callable):
1061
"""Arrange to run a callable when this case is torn down.
1063
Callables are run in the reverse of the order they are registered,
1064
ie last-in first-out.
1066
if callable in self._cleanups:
1067
raise ValueError("cleanup function %r already registered on %s"
1069
self._cleanups.append(callable)
1071
def _cleanEnvironment(self):
1073
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1074
'HOME': os.getcwd(),
1075
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1077
'BZREMAIL': None, # may still be present in the environment
1079
'BZR_PROGRESS_BAR': None,
1083
'https_proxy': None,
1084
'HTTPS_PROXY': None,
1089
# Nobody cares about these ones AFAIK. So far at
1090
# least. If you do (care), please update this comment
1096
self.addCleanup(self._restoreEnvironment)
1097
for name, value in new_env.iteritems():
1098
self._captureVar(name, value)
1100
def _captureVar(self, name, newvalue):
1101
"""Set an environment variable, and reset it when finished."""
1102
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1104
def _restoreEnvironment(self):
1105
for name, value in self.__old_env.iteritems():
1106
osutils.set_or_unset_env(name, value)
1108
def _restoreHooks(self):
1109
for klass, hooks in self._preserved_hooks.items():
1110
setattr(klass, 'hooks', hooks)
1112
def knownFailure(self, reason):
1113
"""This test has failed for some known reason."""
1114
raise KnownFailure(reason)
1116
def run(self, result=None):
1117
if result is None: result = self.defaultTestResult()
1118
for feature in getattr(self, '_test_needs_features', []):
1119
if not feature.available():
1120
result.startTest(self)
1121
if getattr(result, 'addNotSupported', None):
1122
result.addNotSupported(self, feature)
1124
result.addSuccess(self)
1125
result.stopTest(self)
1127
return unittest.TestCase.run(self, result)
1131
unittest.TestCase.tearDown(self)
1133
def time(self, callable, *args, **kwargs):
1134
"""Run callable and accrue the time it takes to the benchmark time.
1136
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1137
this will cause lsprofile statistics to be gathered and stored in
1140
if self._benchtime is None:
1144
if not self._gather_lsprof_in_benchmarks:
1145
return callable(*args, **kwargs)
1147
# record this benchmark
1148
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1150
self._benchcalls.append(((callable, args, kwargs), stats))
1153
self._benchtime += time.time() - start
1155
def _runCleanups(self):
1156
"""Run registered cleanup functions.
1158
This should only be called from TestCase.tearDown.
1160
# TODO: Perhaps this should keep running cleanups even if
1161
# one of them fails?
1163
# Actually pop the cleanups from the list so tearDown running
1164
# twice is safe (this happens for skipped tests).
1165
while self._cleanups:
1166
self._cleanups.pop()()
1168
def log(self, *args):
1171
def _get_log(self, keep_log_file=False):
1172
"""Return as a string the log for this test. If the file is still
1173
on disk and keep_log_file=False, delete the log file and store the
1174
content in self._log_contents."""
1175
# flush the log file, to get all content
1177
bzrlib.trace._trace_file.flush()
1178
if self._log_contents:
1179
return self._log_contents
1180
if self._log_file_name is not None:
1181
logfile = open(self._log_file_name)
1183
log_contents = logfile.read()
1186
if not keep_log_file:
1187
self._log_contents = log_contents
1189
os.remove(self._log_file_name)
1191
if sys.platform == 'win32' and e.errno == errno.EACCES:
1192
print >>sys.stderr, ('Unable to delete log file '
1193
' %r' % self._log_file_name)
1198
return "DELETED log file to reduce memory footprint"
1200
def capture(self, cmd, retcode=0):
1201
"""Shortcut that splits cmd into words, runs, and returns stdout"""
1202
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
1204
def requireFeature(self, feature):
1205
"""This test requires a specific feature is available.
1207
:raises UnavailableFeature: When feature is not available.
1209
if not feature.available():
1210
raise UnavailableFeature(feature)
1212
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
1214
"""Invoke bzr and return (stdout, stderr).
1216
Useful for code that wants to check the contents of the
1217
output, the way error messages are presented, etc.
1219
This should be the main method for tests that want to exercise the
1220
overall behavior of the bzr application (rather than a unit test
1221
or a functional test of the library.)
1223
Much of the old code runs bzr by forking a new copy of Python, but
1224
that is slower, harder to debug, and generally not necessary.
1226
This runs bzr through the interface that catches and reports
1227
errors, and with logging set to something approximating the
1228
default, so that error reporting can be checked.
1230
:param argv: arguments to invoke bzr
1231
:param retcode: expected return code, or None for don't-care.
1232
:param encoding: encoding for sys.stdout and sys.stderr
1233
:param stdin: A string to be used as stdin for the command.
1234
:param working_dir: Change to this directory before running
1236
if encoding is None:
1237
encoding = bzrlib.user_encoding
1238
stdout = StringIOWrapper()
1239
stderr = StringIOWrapper()
1240
stdout.encoding = encoding
1241
stderr.encoding = encoding
1243
self.log('run bzr: %r', argv)
1244
# FIXME: don't call into logging here
1245
handler = logging.StreamHandler(stderr)
1246
handler.setLevel(logging.INFO)
1247
logger = logging.getLogger('')
1248
logger.addHandler(handler)
1249
old_ui_factory = ui.ui_factory
1250
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1253
if working_dir is not None:
1254
cwd = osutils.getcwd()
1255
os.chdir(working_dir)
1258
saved_debug_flags = frozenset(debug.debug_flags)
1259
debug.debug_flags.clear()
1261
result = self.apply_redirected(ui.ui_factory.stdin,
1263
bzrlib.commands.run_bzr_catch_errors,
1266
debug.debug_flags.update(saved_debug_flags)
1268
logger.removeHandler(handler)
1269
ui.ui_factory = old_ui_factory
1273
out = stdout.getvalue()
1274
err = stderr.getvalue()
1276
self.log('output:\n%r', out)
1278
self.log('errors:\n%r', err)
1279
if retcode is not None:
1280
self.assertEquals(retcode, result)
1283
def run_bzr(self, *args, **kwargs):
1284
"""Invoke bzr, as if it were run from the command line.
1286
This should be the main method for tests that want to exercise the
1287
overall behavior of the bzr application (rather than a unit test
1288
or a functional test of the library.)
1290
This sends the stdout/stderr results into the test's log,
1291
where it may be useful for debugging. See also run_captured.
1293
:param stdin: A string to be used as stdin for the command.
1294
:param retcode: The status code the command should return
1295
:param working_dir: The directory to run the command in
1297
retcode = kwargs.pop('retcode', 0)
1298
encoding = kwargs.pop('encoding', None)
1299
stdin = kwargs.pop('stdin', None)
1300
working_dir = kwargs.pop('working_dir', None)
1301
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding,
1302
stdin=stdin, working_dir=working_dir)
1304
def run_bzr_decode(self, *args, **kwargs):
1305
if 'encoding' in kwargs:
1306
encoding = kwargs['encoding']
1308
encoding = bzrlib.user_encoding
1309
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1311
def run_bzr_error(self, error_regexes, *args, **kwargs):
1312
"""Run bzr, and check that stderr contains the supplied regexes
1314
:param error_regexes: Sequence of regular expressions which
1315
must each be found in the error output. The relative ordering
1317
:param args: command-line arguments for bzr
1318
:param kwargs: Keyword arguments which are interpreted by run_bzr
1319
This function changes the default value of retcode to be 3,
1320
since in most cases this is run when you expect bzr to fail.
1321
:return: (out, err) The actual output of running the command (in case you
1322
want to do more inspection)
1325
# Make sure that commit is failing because there is nothing to do
1326
self.run_bzr_error(['no changes to commit'],
1327
'commit', '-m', 'my commit comment')
1328
# Make sure --strict is handling an unknown file, rather than
1329
# giving us the 'nothing to do' error
1330
self.build_tree(['unknown'])
1331
self.run_bzr_error(['Commit refused because there are unknown files'],
1332
'commit', '--strict', '-m', 'my commit comment')
1334
kwargs.setdefault('retcode', 3)
1335
out, err = self.run_bzr(*args, **kwargs)
1336
for regex in error_regexes:
1337
self.assertContainsRe(err, regex)
1340
def run_bzr_subprocess(self, *args, **kwargs):
1341
"""Run bzr in a subprocess for testing.
1343
This starts a new Python interpreter and runs bzr in there.
1344
This should only be used for tests that have a justifiable need for
1345
this isolation: e.g. they are testing startup time, or signal
1346
handling, or early startup code, etc. Subprocess code can't be
1347
profiled or debugged so easily.
1349
:param retcode: The status code that is expected. Defaults to 0. If
1350
None is supplied, the status code is not checked.
1351
:param env_changes: A dictionary which lists changes to environment
1352
variables. A value of None will unset the env variable.
1353
The values must be strings. The change will only occur in the
1354
child, so you don't need to fix the environment after running.
1355
:param universal_newlines: Convert CRLF => LF
1356
:param allow_plugins: By default the subprocess is run with
1357
--no-plugins to ensure test reproducibility. Also, it is possible
1358
for system-wide plugins to create unexpected output on stderr,
1359
which can cause unnecessary test failures.
1361
env_changes = kwargs.get('env_changes', {})
1362
working_dir = kwargs.get('working_dir', None)
1363
allow_plugins = kwargs.get('allow_plugins', False)
1364
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1365
working_dir=working_dir,
1366
allow_plugins=allow_plugins)
1367
# We distinguish between retcode=None and retcode not passed.
1368
supplied_retcode = kwargs.get('retcode', 0)
1369
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1370
universal_newlines=kwargs.get('universal_newlines', False),
1373
def start_bzr_subprocess(self, process_args, env_changes=None,
1374
skip_if_plan_to_signal=False,
1376
allow_plugins=False):
1377
"""Start bzr in a subprocess for testing.
1379
This starts a new Python interpreter and runs bzr in there.
1380
This should only be used for tests that have a justifiable need for
1381
this isolation: e.g. they are testing startup time, or signal
1382
handling, or early startup code, etc. Subprocess code can't be
1383
profiled or debugged so easily.
1385
:param process_args: a list of arguments to pass to the bzr executable,
1386
for example `['--version']`.
1387
:param env_changes: A dictionary which lists changes to environment
1388
variables. A value of None will unset the env variable.
1389
The values must be strings. The change will only occur in the
1390
child, so you don't need to fix the environment after running.
1391
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1393
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1395
:returns: Popen object for the started process.
1397
if skip_if_plan_to_signal:
1398
if not getattr(os, 'kill', None):
1399
raise TestSkipped("os.kill not available.")
1401
if env_changes is None:
1405
def cleanup_environment():
1406
for env_var, value in env_changes.iteritems():
1407
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1409
def restore_environment():
1410
for env_var, value in old_env.iteritems():
1411
osutils.set_or_unset_env(env_var, value)
1413
bzr_path = self.get_bzr_path()
1416
if working_dir is not None:
1417
cwd = osutils.getcwd()
1418
os.chdir(working_dir)
1421
# win32 subprocess doesn't support preexec_fn
1422
# so we will avoid using it on all platforms, just to
1423
# make sure the code path is used, and we don't break on win32
1424
cleanup_environment()
1425
command = [sys.executable, bzr_path]
1426
if not allow_plugins:
1427
command.append('--no-plugins')
1428
command.extend(process_args)
1429
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1431
restore_environment()
1437
def _popen(self, *args, **kwargs):
1438
"""Place a call to Popen.
1440
Allows tests to override this method to intercept the calls made to
1441
Popen for introspection.
1443
return Popen(*args, **kwargs)
1445
def get_bzr_path(self):
1446
"""Return the path of the 'bzr' executable for this test suite."""
1447
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1448
if not os.path.isfile(bzr_path):
1449
# We are probably installed. Assume sys.argv is the right file
1450
bzr_path = sys.argv[0]
1453
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1454
universal_newlines=False, process_args=None):
1455
"""Finish the execution of process.
1457
:param process: the Popen object returned from start_bzr_subprocess.
1458
:param retcode: The status code that is expected. Defaults to 0. If
1459
None is supplied, the status code is not checked.
1460
:param send_signal: an optional signal to send to the process.
1461
:param universal_newlines: Convert CRLF => LF
1462
:returns: (stdout, stderr)
1464
if send_signal is not None:
1465
os.kill(process.pid, send_signal)
1466
out, err = process.communicate()
1468
if universal_newlines:
1469
out = out.replace('\r\n', '\n')
1470
err = err.replace('\r\n', '\n')
1472
if retcode is not None and retcode != process.returncode:
1473
if process_args is None:
1474
process_args = "(unknown args)"
1475
mutter('Output of bzr %s:\n%s', process_args, out)
1476
mutter('Error for bzr %s:\n%s', process_args, err)
1477
self.fail('Command bzr %s failed with retcode %s != %s'
1478
% (process_args, retcode, process.returncode))
1481
def check_inventory_shape(self, inv, shape):
1482
"""Compare an inventory to a list of expected names.
1484
Fail if they are not precisely equal.
1487
shape = list(shape) # copy
1488
for path, ie in inv.entries():
1489
name = path.replace('\\', '/')
1490
if ie.kind == 'dir':
1497
self.fail("expected paths not found in inventory: %r" % shape)
1499
self.fail("unexpected paths found in inventory: %r" % extras)
1501
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1502
a_callable=None, *args, **kwargs):
1503
"""Call callable with redirected std io pipes.
1505
Returns the return code."""
1506
if not callable(a_callable):
1507
raise ValueError("a_callable must be callable.")
1509
stdin = StringIO("")
1511
if getattr(self, "_log_file", None) is not None:
1512
stdout = self._log_file
1516
if getattr(self, "_log_file", None is not None):
1517
stderr = self._log_file
1520
real_stdin = sys.stdin
1521
real_stdout = sys.stdout
1522
real_stderr = sys.stderr
1527
return a_callable(*args, **kwargs)
1529
sys.stdout = real_stdout
1530
sys.stderr = real_stderr
1531
sys.stdin = real_stdin
1533
@symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
1534
def merge(self, branch_from, wt_to):
1535
"""A helper for tests to do a ui-less merge.
1537
This should move to the main library when someone has time to integrate
1540
# minimal ui-less merge.
1541
wt_to.branch.fetch(branch_from)
1542
base_rev = common_ancestor(branch_from.last_revision(),
1543
wt_to.branch.last_revision(),
1544
wt_to.branch.repository)
1545
merge_inner(wt_to.branch, branch_from.basis_tree(),
1546
wt_to.branch.repository.revision_tree(base_rev),
1548
wt_to.add_parent_tree_id(branch_from.last_revision())
1550
def reduceLockdirTimeout(self):
1551
"""Reduce the default lock timeout for the duration of the test, so that
1552
if LockContention occurs during a test, it does so quickly.
1554
Tests that expect to provoke LockContention errors should call this.
1556
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1558
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1559
self.addCleanup(resetTimeout)
1560
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1562
BzrTestBase = TestCase
1565
class TestCaseWithMemoryTransport(TestCase):
1566
"""Common test class for tests that do not need disk resources.
1568
Tests that need disk resources should derive from TestCaseWithTransport.
1570
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1572
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1573
a directory which does not exist. This serves to help ensure test isolation
1574
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1575
must exist. However, TestCaseWithMemoryTransport does not offer local
1576
file defaults for the transport in tests, nor does it obey the command line
1577
override, so tests that accidentally write to the common directory should
1585
def __init__(self, methodName='runTest'):
1586
# allow test parameterisation after test construction and before test
1587
# execution. Variables that the parameteriser sets need to be
1588
# ones that are not set by setUp, or setUp will trash them.
1589
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1590
self.vfs_transport_factory = default_transport
1591
self.transport_server = None
1592
self.transport_readonly_server = None
1593
self.__vfs_server = None
1595
def get_transport(self):
1596
"""Return a writeable transport for the test scratch space"""
1597
t = get_transport(self.get_url())
1598
self.assertFalse(t.is_readonly())
1601
def get_readonly_transport(self):
1602
"""Return a readonly transport for the test scratch space
1604
This can be used to test that operations which should only need
1605
readonly access in fact do not try to write.
1607
t = get_transport(self.get_readonly_url())
1608
self.assertTrue(t.is_readonly())
1611
def create_transport_readonly_server(self):
1612
"""Create a transport server from class defined at init.
1614
This is mostly a hook for daughter classes.
1616
return self.transport_readonly_server()
1618
def get_readonly_server(self):
1619
"""Get the server instance for the readonly transport
1621
This is useful for some tests with specific servers to do diagnostics.
1623
if self.__readonly_server is None:
1624
if self.transport_readonly_server is None:
1625
# readonly decorator requested
1626
# bring up the server
1627
self.__readonly_server = ReadonlyServer()
1628
self.__readonly_server.setUp(self.get_vfs_only_server())
1630
self.__readonly_server = self.create_transport_readonly_server()
1631
self.__readonly_server.setUp(self.get_vfs_only_server())
1632
self.addCleanup(self.__readonly_server.tearDown)
1633
return self.__readonly_server
1635
def get_readonly_url(self, relpath=None):
1636
"""Get a URL for the readonly transport.
1638
This will either be backed by '.' or a decorator to the transport
1639
used by self.get_url()
1640
relpath provides for clients to get a path relative to the base url.
1641
These should only be downwards relative, not upwards.
1643
base = self.get_readonly_server().get_url()
1644
if relpath is not None:
1645
if not base.endswith('/'):
1647
base = base + relpath
1650
def get_vfs_only_server(self):
1651
"""Get the vfs only read/write server instance.
1653
This is useful for some tests with specific servers that need
1656
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1657
is no means to override it.
1659
if self.__vfs_server is None:
1660
self.__vfs_server = MemoryServer()
1661
self.__vfs_server.setUp()
1662
self.addCleanup(self.__vfs_server.tearDown)
1663
return self.__vfs_server
1665
def get_server(self):
1666
"""Get the read/write server instance.
1668
This is useful for some tests with specific servers that need
1671
This is built from the self.transport_server factory. If that is None,
1672
then the self.get_vfs_server is returned.
1674
if self.__server is None:
1675
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1676
return self.get_vfs_only_server()
1678
# bring up a decorated means of access to the vfs only server.
1679
self.__server = self.transport_server()
1681
self.__server.setUp(self.get_vfs_only_server())
1682
except TypeError, e:
1683
# This should never happen; the try:Except here is to assist
1684
# developers having to update code rather than seeing an
1685
# uninformative TypeError.
1686
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1687
self.addCleanup(self.__server.tearDown)
1688
return self.__server
1690
def _adjust_url(self, base, relpath):
1691
"""Get a URL (or maybe a path) for the readwrite transport.
1693
This will either be backed by '.' or to an equivalent non-file based
1695
relpath provides for clients to get a path relative to the base url.
1696
These should only be downwards relative, not upwards.
1698
if relpath is not None and relpath != '.':
1699
if not base.endswith('/'):
1701
# XXX: Really base should be a url; we did after all call
1702
# get_url()! But sometimes it's just a path (from
1703
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1704
# to a non-escaped local path.
1705
if base.startswith('./') or base.startswith('/'):
1708
base += urlutils.escape(relpath)
1711
def get_url(self, relpath=None):
1712
"""Get a URL (or maybe a path) for the readwrite transport.
1714
This will either be backed by '.' or to an equivalent non-file based
1716
relpath provides for clients to get a path relative to the base url.
1717
These should only be downwards relative, not upwards.
1719
base = self.get_server().get_url()
1720
return self._adjust_url(base, relpath)
1722
def get_vfs_only_url(self, relpath=None):
1723
"""Get a URL (or maybe a path for the plain old vfs transport.
1725
This will never be a smart protocol. It always has all the
1726
capabilities of the local filesystem, but it might actually be a
1727
MemoryTransport or some other similar virtual filesystem.
1729
This is the backing transport (if any) of the server returned by
1730
get_url and get_readonly_url.
1732
:param relpath: provides for clients to get a path relative to the base
1733
url. These should only be downwards relative, not upwards.
1735
base = self.get_vfs_only_server().get_url()
1736
return self._adjust_url(base, relpath)
1738
def _make_test_root(self):
1739
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1743
root = u'test%04d.tmp' % i
1747
if e.errno == errno.EEXIST:
1752
# successfully created
1753
TestCaseWithMemoryTransport.TEST_ROOT = osutils.abspath(root)
1755
# make a fake bzr directory there to prevent any tests propagating
1756
# up onto the source directory's real branch
1757
bzrdir.BzrDir.create_standalone_workingtree(
1758
TestCaseWithMemoryTransport.TEST_ROOT)
1760
def makeAndChdirToTestDir(self):
1761
"""Create a temporary directories for this one test.
1763
This must set self.test_home_dir and self.test_dir and chdir to
1766
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1768
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1769
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1770
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1772
def make_branch(self, relpath, format=None):
1773
"""Create a branch on the transport at relpath."""
1774
repo = self.make_repository(relpath, format=format)
1775
return repo.bzrdir.create_branch()
1777
def make_bzrdir(self, relpath, format=None):
1779
# might be a relative or absolute path
1780
maybe_a_url = self.get_url(relpath)
1781
segments = maybe_a_url.rsplit('/', 1)
1782
t = get_transport(maybe_a_url)
1783
if len(segments) > 1 and segments[-1] not in ('', '.'):
1786
except errors.FileExists:
1790
if isinstance(format, basestring):
1791
format = bzrdir.format_registry.make_bzrdir(format)
1792
return format.initialize_on_transport(t)
1793
except errors.UninitializableFormat:
1794
raise TestSkipped("Format %s is not initializable." % format)
1796
def make_repository(self, relpath, shared=False, format=None):
1797
"""Create a repository on our default transport at relpath.
1799
Note that relpath must be a relative path, not a full url.
1801
# FIXME: If you create a remoterepository this returns the underlying
1802
# real format, which is incorrect. Actually we should make sure that
1803
# RemoteBzrDir returns a RemoteRepository.
1804
# maybe mbp 20070410
1805
made_control = self.make_bzrdir(relpath, format=format)
1806
return made_control.create_repository(shared=shared)
1808
def make_branch_and_memory_tree(self, relpath, format=None):
1809
"""Create a branch on the default transport and a MemoryTree for it."""
1810
b = self.make_branch(relpath, format=format)
1811
return memorytree.MemoryTree.create_on_branch(b)
1813
def overrideEnvironmentForTesting(self):
1814
os.environ['HOME'] = self.test_home_dir
1815
os.environ['BZR_HOME'] = self.test_home_dir
1818
super(TestCaseWithMemoryTransport, self).setUp()
1819
self._make_test_root()
1820
_currentdir = os.getcwdu()
1821
def _leaveDirectory():
1822
os.chdir(_currentdir)
1823
self.addCleanup(_leaveDirectory)
1824
self.makeAndChdirToTestDir()
1825
self.overrideEnvironmentForTesting()
1826
self.__readonly_server = None
1827
self.__server = None
1828
self.reduceLockdirTimeout()
1831
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1832
"""Derived class that runs a test within a temporary directory.
1834
This is useful for tests that need to create a branch, etc.
1836
The directory is created in a slightly complex way: for each
1837
Python invocation, a new temporary top-level directory is created.
1838
All test cases create their own directory within that. If the
1839
tests complete successfully, the directory is removed.
1841
InTempDir is an old alias for FunctionalTestCase.
1844
OVERRIDE_PYTHON = 'python'
1845
use_numbered_dirs = False
1847
def check_file_contents(self, filename, expect):
1848
self.log("check contents of file %s" % filename)
1849
contents = file(filename, 'r').read()
1850
if contents != expect:
1851
self.log("expected: %r" % expect)
1852
self.log("actually: %r" % contents)
1853
self.fail("contents of %s not as expected" % filename)
1855
def makeAndChdirToTestDir(self):
1856
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1858
For TestCaseInTempDir we create a temporary directory based on the test
1859
name and then create two subdirs - test and home under it.
1861
if self.use_numbered_dirs: # strongly recommended on Windows
1862
# due the path length limitation (260 ch.)
1863
candidate_dir = '%s/%dK/%05d' % (self.TEST_ROOT,
1864
int(self.number/1000),
1866
os.makedirs(candidate_dir)
1867
self.test_home_dir = candidate_dir + '/home'
1868
os.mkdir(self.test_home_dir)
1869
self.test_dir = candidate_dir + '/work'
1870
os.mkdir(self.test_dir)
1871
os.chdir(self.test_dir)
1872
# put name of test inside
1873
f = file(candidate_dir + '/name', 'w')
1878
# shorten the name, to avoid test failures due to path length
1879
short_id = self.id().replace('bzrlib.tests.', '') \
1880
.replace('__main__.', '')[-100:]
1881
# it's possible the same test class is run several times for
1882
# parameterized tests, so make sure the names don't collide.
1886
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1888
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1889
if os.path.exists(candidate_dir):
1893
os.mkdir(candidate_dir)
1894
self.test_home_dir = candidate_dir + '/home'
1895
os.mkdir(self.test_home_dir)
1896
self.test_dir = candidate_dir + '/work'
1897
os.mkdir(self.test_dir)
1898
os.chdir(self.test_dir)
1901
def build_tree(self, shape, line_endings='binary', transport=None):
1902
"""Build a test tree according to a pattern.
1904
shape is a sequence of file specifications. If the final
1905
character is '/', a directory is created.
1907
This assumes that all the elements in the tree being built are new.
1909
This doesn't add anything to a branch.
1910
:param line_endings: Either 'binary' or 'native'
1911
in binary mode, exact contents are written
1912
in native mode, the line endings match the
1913
default platform endings.
1915
:param transport: A transport to write to, for building trees on
1916
VFS's. If the transport is readonly or None,
1917
"." is opened automatically.
1919
# It's OK to just create them using forward slashes on windows.
1920
if transport is None or transport.is_readonly():
1921
transport = get_transport(".")
1923
self.assert_(isinstance(name, basestring))
1925
transport.mkdir(urlutils.escape(name[:-1]))
1927
if line_endings == 'binary':
1929
elif line_endings == 'native':
1932
raise errors.BzrError(
1933
'Invalid line ending request %r' % line_endings)
1934
content = "contents of %s%s" % (name.encode('utf-8'), end)
1935
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1937
def build_tree_contents(self, shape):
1938
build_tree_contents(shape)
1940
def assertFileEqual(self, content, path):
1941
"""Fail if path does not contain 'content'."""
1942
self.failUnlessExists(path)
1943
# TODO: jam 20060427 Shouldn't this be 'rb'?
1949
self.assertEqualDiff(content, s)
1951
def failUnlessExists(self, path):
1952
"""Fail unless path, which may be abs or relative, exists."""
1953
self.failUnless(osutils.lexists(path),path+" does not exist")
1955
def failIfExists(self, path):
1956
"""Fail if path, which may be abs or relative, exists."""
1957
self.failIf(osutils.lexists(path),path+" exists")
1960
class TestCaseWithTransport(TestCaseInTempDir):
1961
"""A test case that provides get_url and get_readonly_url facilities.
1963
These back onto two transport servers, one for readonly access and one for
1966
If no explicit class is provided for readonly access, a
1967
ReadonlyTransportDecorator is used instead which allows the use of non disk
1968
based read write transports.
1970
If an explicit class is provided for readonly access, that server and the
1971
readwrite one must both define get_url() as resolving to os.getcwd().
1974
def get_vfs_only_server(self):
1975
"""See TestCaseWithMemoryTransport.
1977
This is useful for some tests with specific servers that need
1980
if self.__vfs_server is None:
1981
self.__vfs_server = self.vfs_transport_factory()
1982
self.__vfs_server.setUp()
1983
self.addCleanup(self.__vfs_server.tearDown)
1984
return self.__vfs_server
1986
def make_branch_and_tree(self, relpath, format=None):
1987
"""Create a branch on the transport and a tree locally.
1989
If the transport is not a LocalTransport, the Tree can't be created on
1990
the transport. In that case if the vfs_transport_factory is
1991
LocalURLServer the working tree is created in the local
1992
directory backing the transport, and the returned tree's branch and
1993
repository will also be accessed locally. Otherwise a lightweight
1994
checkout is created and returned.
1996
:param format: The BzrDirFormat.
1997
:returns: the WorkingTree.
1999
# TODO: always use the local disk path for the working tree,
2000
# this obviously requires a format that supports branch references
2001
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2003
b = self.make_branch(relpath, format=format)
2005
return b.bzrdir.create_workingtree()
2006
except errors.NotLocalUrl:
2007
# We can only make working trees locally at the moment. If the
2008
# transport can't support them, then we keep the non-disk-backed
2009
# branch and create a local checkout.
2010
if self.vfs_transport_factory is LocalURLServer:
2011
# the branch is colocated on disk, we cannot create a checkout.
2012
# hopefully callers will expect this.
2013
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2014
return local_controldir.create_workingtree()
2016
return b.create_checkout(relpath, lightweight=True)
2018
def assertIsDirectory(self, relpath, transport):
2019
"""Assert that relpath within transport is a directory.
2021
This may not be possible on all transports; in that case it propagates
2022
a TransportNotPossible.
2025
mode = transport.stat(relpath).st_mode
2026
except errors.NoSuchFile:
2027
self.fail("path %s is not a directory; no such file"
2029
if not stat.S_ISDIR(mode):
2030
self.fail("path %s is not a directory; has mode %#o"
2033
def assertTreesEqual(self, left, right):
2034
"""Check that left and right have the same content and properties."""
2035
# we use a tree delta to check for equality of the content, and we
2036
# manually check for equality of other things such as the parents list.
2037
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2038
differences = left.changes_from(right)
2039
self.assertFalse(differences.has_changed(),
2040
"Trees %r and %r are different: %r" % (left, right, differences))
2043
super(TestCaseWithTransport, self).setUp()
2044
self.__vfs_server = None
2047
class ChrootedTestCase(TestCaseWithTransport):
2048
"""A support class that provides readonly urls outside the local namespace.
2050
This is done by checking if self.transport_server is a MemoryServer. if it
2051
is then we are chrooted already, if it is not then an HttpServer is used
2054
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2055
be used without needed to redo it when a different
2056
subclass is in use ?
2060
super(ChrootedTestCase, self).setUp()
2061
if not self.vfs_transport_factory == MemoryServer:
2062
self.transport_readonly_server = HttpServer
2065
def filter_suite_by_re(suite, pattern):
2066
result = TestUtil.TestSuite()
2067
filter_re = re.compile(pattern)
2068
for test in iter_suite_tests(suite):
2069
if filter_re.search(test.id()):
2070
result.addTest(test)
2074
def sort_suite_by_re(suite, pattern):
2077
filter_re = re.compile(pattern)
2078
for test in iter_suite_tests(suite):
2079
if filter_re.search(test.id()):
2083
return TestUtil.TestSuite(first + second)
2086
def run_suite(suite, name='test', verbose=False, pattern=".*",
2087
stop_on_failure=False, keep_output=False,
2088
transport=None, lsprof_timed=None, bench_history=None,
2089
matching_tests_first=None,
2090
numbered_dirs=None):
2091
use_numbered_dirs = bool(numbered_dirs)
2093
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2094
if numbered_dirs is not None:
2095
TestCaseInTempDir.use_numbered_dirs = use_numbered_dirs
2100
runner = TextTestRunner(stream=sys.stdout,
2102
verbosity=verbosity,
2103
keep_output=keep_output,
2104
bench_history=bench_history,
2105
use_numbered_dirs=use_numbered_dirs,
2107
runner.stop_on_failure=stop_on_failure
2109
if matching_tests_first:
2110
suite = sort_suite_by_re(suite, pattern)
2112
suite = filter_suite_by_re(suite, pattern)
2113
result = runner.run(suite)
2114
return result.wasSuccessful()
2117
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2120
test_suite_factory=None,
2123
matching_tests_first=None,
2124
numbered_dirs=None):
2125
"""Run the whole test suite under the enhanced runner"""
2126
# XXX: Very ugly way to do this...
2127
# Disable warning about old formats because we don't want it to disturb
2128
# any blackbox tests.
2129
from bzrlib import repository
2130
repository._deprecation_warning_done = True
2132
global default_transport
2133
if transport is None:
2134
transport = default_transport
2135
old_transport = default_transport
2136
default_transport = transport
2138
if test_suite_factory is None:
2139
suite = test_suite()
2141
suite = test_suite_factory()
2142
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2143
stop_on_failure=stop_on_failure, keep_output=keep_output,
2144
transport=transport,
2145
lsprof_timed=lsprof_timed,
2146
bench_history=bench_history,
2147
matching_tests_first=matching_tests_first,
2148
numbered_dirs=numbered_dirs)
2150
default_transport = old_transport
2154
"""Build and return TestSuite for the whole of bzrlib.
2156
This function can be replaced if you need to change the default test
2157
suite on a global basis, but it is not encouraged.
2160
'bzrlib.tests.test_ancestry',
2161
'bzrlib.tests.test_annotate',
2162
'bzrlib.tests.test_api',
2163
'bzrlib.tests.test_atomicfile',
2164
'bzrlib.tests.test_bad_files',
2165
'bzrlib.tests.test_branch',
2166
'bzrlib.tests.test_bundle',
2167
'bzrlib.tests.test_bzrdir',
2168
'bzrlib.tests.test_cache_utf8',
2169
'bzrlib.tests.test_commands',
2170
'bzrlib.tests.test_commit',
2171
'bzrlib.tests.test_commit_merge',
2172
'bzrlib.tests.test_config',
2173
'bzrlib.tests.test_conflicts',
2174
'bzrlib.tests.test_decorators',
2175
'bzrlib.tests.test_delta',
2176
'bzrlib.tests.test_diff',
2177
'bzrlib.tests.test_dirstate',
2178
'bzrlib.tests.test_doc_generate',
2179
'bzrlib.tests.test_errors',
2180
'bzrlib.tests.test_escaped_store',
2181
'bzrlib.tests.test_extract',
2182
'bzrlib.tests.test_fetch',
2183
'bzrlib.tests.test_ftp_transport',
2184
'bzrlib.tests.test_generate_docs',
2185
'bzrlib.tests.test_generate_ids',
2186
'bzrlib.tests.test_globbing',
2187
'bzrlib.tests.test_gpg',
2188
'bzrlib.tests.test_graph',
2189
'bzrlib.tests.test_hashcache',
2190
'bzrlib.tests.test_help',
2191
'bzrlib.tests.test_http',
2192
'bzrlib.tests.test_http_response',
2193
'bzrlib.tests.test_https_ca_bundle',
2194
'bzrlib.tests.test_identitymap',
2195
'bzrlib.tests.test_ignores',
2196
'bzrlib.tests.test_inv',
2197
'bzrlib.tests.test_knit',
2198
'bzrlib.tests.test_lazy_import',
2199
'bzrlib.tests.test_lazy_regex',
2200
'bzrlib.tests.test_lockdir',
2201
'bzrlib.tests.test_lockable_files',
2202
'bzrlib.tests.test_log',
2203
'bzrlib.tests.test_memorytree',
2204
'bzrlib.tests.test_merge',
2205
'bzrlib.tests.test_merge3',
2206
'bzrlib.tests.test_merge_core',
2207
'bzrlib.tests.test_merge_directive',
2208
'bzrlib.tests.test_missing',
2209
'bzrlib.tests.test_msgeditor',
2210
'bzrlib.tests.test_nonascii',
2211
'bzrlib.tests.test_options',
2212
'bzrlib.tests.test_osutils',
2213
'bzrlib.tests.test_osutils_encodings',
2214
'bzrlib.tests.test_patch',
2215
'bzrlib.tests.test_patches',
2216
'bzrlib.tests.test_permissions',
2217
'bzrlib.tests.test_plugins',
2218
'bzrlib.tests.test_progress',
2219
'bzrlib.tests.test_reconcile',
2220
'bzrlib.tests.test_registry',
2221
'bzrlib.tests.test_remote',
2222
'bzrlib.tests.test_repository',
2223
'bzrlib.tests.test_revert',
2224
'bzrlib.tests.test_revision',
2225
'bzrlib.tests.test_revisionnamespaces',
2226
'bzrlib.tests.test_revisiontree',
2227
'bzrlib.tests.test_rio',
2228
'bzrlib.tests.test_sampler',
2229
'bzrlib.tests.test_selftest',
2230
'bzrlib.tests.test_setup',
2231
'bzrlib.tests.test_sftp_transport',
2232
'bzrlib.tests.test_smart',
2233
'bzrlib.tests.test_smart_add',
2234
'bzrlib.tests.test_smart_transport',
2235
'bzrlib.tests.test_source',
2236
'bzrlib.tests.test_ssh_transport',
2237
'bzrlib.tests.test_status',
2238
'bzrlib.tests.test_store',
2239
'bzrlib.tests.test_strace',
2240
'bzrlib.tests.test_subsume',
2241
'bzrlib.tests.test_symbol_versioning',
2242
'bzrlib.tests.test_tag',
2243
'bzrlib.tests.test_testament',
2244
'bzrlib.tests.test_textfile',
2245
'bzrlib.tests.test_textmerge',
2246
'bzrlib.tests.test_timestamp',
2247
'bzrlib.tests.test_trace',
2248
'bzrlib.tests.test_transactions',
2249
'bzrlib.tests.test_transform',
2250
'bzrlib.tests.test_transport',
2251
'bzrlib.tests.test_tree',
2252
'bzrlib.tests.test_treebuilder',
2253
'bzrlib.tests.test_tsort',
2254
'bzrlib.tests.test_tuned_gzip',
2255
'bzrlib.tests.test_ui',
2256
'bzrlib.tests.test_upgrade',
2257
'bzrlib.tests.test_urlutils',
2258
'bzrlib.tests.test_versionedfile',
2259
'bzrlib.tests.test_version',
2260
'bzrlib.tests.test_version_info',
2261
'bzrlib.tests.test_weave',
2262
'bzrlib.tests.test_whitebox',
2263
'bzrlib.tests.test_workingtree',
2264
'bzrlib.tests.test_workingtree_4',
2265
'bzrlib.tests.test_wsgi',
2266
'bzrlib.tests.test_xml',
2268
test_transport_implementations = [
2269
'bzrlib.tests.test_transport_implementations',
2270
'bzrlib.tests.test_read_bundle',
2272
suite = TestUtil.TestSuite()
2273
loader = TestUtil.TestLoader()
2274
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2275
from bzrlib.transport import TransportTestProviderAdapter
2276
adapter = TransportTestProviderAdapter()
2277
adapt_modules(test_transport_implementations, adapter, loader, suite)
2278
for package in packages_to_test():
2279
suite.addTest(package.test_suite())
2280
for m in MODULES_TO_TEST:
2281
suite.addTest(loader.loadTestsFromModule(m))
2282
for m in MODULES_TO_DOCTEST:
2284
suite.addTest(doctest.DocTestSuite(m))
2285
except ValueError, e:
2286
print '**failed to get doctest for: %s\n%s' %(m,e)
2288
for name, plugin in bzrlib.plugin.all_plugins().items():
2289
if getattr(plugin, 'test_suite', None) is not None:
2290
default_encoding = sys.getdefaultencoding()
2292
plugin_suite = plugin.test_suite()
2293
except ImportError, e:
2294
bzrlib.trace.warning(
2295
'Unable to test plugin "%s": %s', name, e)
2297
suite.addTest(plugin_suite)
2298
if default_encoding != sys.getdefaultencoding():
2299
bzrlib.trace.warning(
2300
'Plugin "%s" tried to reset default encoding to: %s', name,
2301
sys.getdefaultencoding())
2303
sys.setdefaultencoding(default_encoding)
2307
def adapt_modules(mods_list, adapter, loader, suite):
2308
"""Adapt the modules in mods_list using adapter and add to suite."""
2309
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2310
suite.addTests(adapter.adapt(test))
2313
def _rmtree_temp_dir(dirname):
2315
osutils.rmtree(dirname)
2317
if sys.platform == 'win32' and e.errno == errno.EACCES:
2318
print >>sys.stderr, ('Permission denied: '
2319
'unable to remove testing dir '
2320
'%s' % os.path.basename(dirname))
2325
def clean_selftest_output(root=None, quiet=False):
2326
"""Remove all selftest output directories from root directory.
2328
:param root: root directory for clean
2329
(if ommitted or None then clean current directory).
2330
:param quiet: suppress report about deleting directories
2333
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
2336
for i in os.listdir(root):
2337
if os.path.isdir(i) and re_dir.match(i):
2339
print 'delete directory:', i
2343
class Feature(object):
2344
"""An operating system Feature."""
2347
self._available = None
2349
def available(self):
2350
"""Is the feature available?
2352
:return: True if the feature is available.
2354
if self._available is None:
2355
self._available = self._probe()
2356
return self._available
2359
"""Implement this method in concrete features.
2361
:return: True if the feature is available.
2363
raise NotImplementedError
2366
if getattr(self, 'feature_name', None):
2367
return self.feature_name()
2368
return self.__class__.__name__
added
removed
bzrlib/tests/__init__.py
