1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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.
32
from cStringIO import StringIO
39
from pprint import pformat
44
from subprocess import Popen, PIPE, STDOUT
69
import bzrlib.commands
70
import bzrlib.timestamp
72
import bzrlib.inventory
73
import bzrlib.iterablefile
78
# lsprof not available
80
from bzrlib.merge import merge_inner
83
from bzrlib.smart import client, request, server
85
from bzrlib import symbol_versioning
86
from bzrlib.symbol_versioning import (
93
from bzrlib.transport import get_transport
94
import bzrlib.transport
95
from bzrlib.transport.local import LocalURLServer
96
from bzrlib.transport.memory import MemoryServer
97
from bzrlib.transport.readonly import ReadonlyServer
98
from bzrlib.trace import mutter, note
99
from bzrlib.tests import TestUtil
100
from bzrlib.tests.http_server import HttpServer
101
from bzrlib.tests.TestUtil import (
105
from bzrlib.tests.treeshape import build_tree_contents
106
from bzrlib.ui import NullProgressView
107
from bzrlib.ui.text import TextUIFactory
108
import bzrlib.version_info_formats.format_custom
109
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
111
# Mark this python module as being part of the implementation
112
# of unittest: this gives us better tracebacks where the last
113
# shown frame is the test code, not our assertXYZ.
116
default_transport = LocalURLServer
118
# Subunit result codes, defined here to prevent a hard dependency on subunit.
123
class ExtendedTestResult(unittest._TextTestResult):
124
"""Accepts, reports and accumulates the results of running tests.
126
Compared to the unittest version this class adds support for
127
profiling, benchmarking, stopping as soon as a test fails, and
128
skipping tests. There are further-specialized subclasses for
129
different types of display.
131
When a test finishes, in whatever way, it calls one of the addSuccess,
132
addFailure or addError classes. These in turn may redirect to a more
133
specific case for the special test results supported by our extended
136
Note that just one of these objects is fed the results from many tests.
141
def __init__(self, stream, descriptions, verbosity,
145
"""Construct new TestResult.
147
:param bench_history: Optionally, a writable file object to accumulate
150
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
151
if bench_history is not None:
152
from bzrlib.version import _get_bzr_source_tree
153
src_tree = _get_bzr_source_tree()
156
revision_id = src_tree.get_parent_ids()[0]
158
# XXX: if this is a brand new tree, do the same as if there
162
# XXX: If there's no branch, what should we do?
164
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
165
self._bench_history = bench_history
166
self.ui = ui.ui_factory
169
self.failure_count = 0
170
self.known_failure_count = 0
172
self.not_applicable_count = 0
173
self.unsupported = {}
175
self._overall_start_time = time.time()
176
self._strict = strict
178
def stopTestRun(self):
181
stopTime = time.time()
182
timeTaken = stopTime - self.startTime
184
self.stream.writeln(self.separator2)
185
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
186
run, run != 1 and "s" or "", timeTaken))
187
self.stream.writeln()
188
if not self.wasSuccessful():
189
self.stream.write("FAILED (")
190
failed, errored = map(len, (self.failures, self.errors))
192
self.stream.write("failures=%d" % failed)
194
if failed: self.stream.write(", ")
195
self.stream.write("errors=%d" % errored)
196
if self.known_failure_count:
197
if failed or errored: self.stream.write(", ")
198
self.stream.write("known_failure_count=%d" %
199
self.known_failure_count)
200
self.stream.writeln(")")
202
if self.known_failure_count:
203
self.stream.writeln("OK (known_failures=%d)" %
204
self.known_failure_count)
206
self.stream.writeln("OK")
207
if self.skip_count > 0:
208
skipped = self.skip_count
209
self.stream.writeln('%d test%s skipped' %
210
(skipped, skipped != 1 and "s" or ""))
212
for feature, count in sorted(self.unsupported.items()):
213
self.stream.writeln("Missing feature '%s' skipped %d tests." %
216
ok = self.wasStrictlySuccessful()
218
ok = self.wasSuccessful()
219
if TestCase._first_thread_leaker_id:
221
'%s is leaking threads among %d leaking tests.\n' % (
222
TestCase._first_thread_leaker_id,
223
TestCase._leaking_threads_tests))
225
def _extractBenchmarkTime(self, testCase):
226
"""Add a benchmark time for the current test case."""
227
return getattr(testCase, "_benchtime", None)
229
def _elapsedTestTimeString(self):
230
"""Return a time string for the overall time the current test has taken."""
231
return self._formatTime(time.time() - self._start_time)
233
def _testTimeString(self, testCase):
234
benchmark_time = self._extractBenchmarkTime(testCase)
235
if benchmark_time is not None:
236
return self._formatTime(benchmark_time) + "*"
238
return self._elapsedTestTimeString()
240
def _formatTime(self, seconds):
241
"""Format seconds as milliseconds with leading spaces."""
242
# some benchmarks can take thousands of seconds to run, so we need 8
244
return "%8dms" % (1000 * seconds)
246
def _shortened_test_description(self, test):
248
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
251
def startTest(self, test):
252
unittest.TestResult.startTest(self, test)
255
self.report_test_start(test)
256
test.number = self.count
257
self._recordTestStartTime()
259
def startTests(self):
261
if getattr(sys, 'frozen', None) is None:
262
bzr_path = osutils.realpath(sys.argv[0])
264
bzr_path = sys.executable
266
'testing: %s\n' % (bzr_path,))
269
bzrlib.__path__[0],))
271
' bzr-%s python-%s %s\n' % (
272
bzrlib.version_string,
273
bzrlib._format_version_tuple(sys.version_info),
274
platform.platform(aliased=1),
276
self.stream.write('\n')
278
def _recordTestStartTime(self):
279
"""Record that a test has started."""
280
self._start_time = time.time()
282
def _cleanupLogFile(self, test):
283
# We can only do this if we have one of our TestCases, not if
285
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
286
if setKeepLogfile is not None:
289
def addError(self, test, err):
290
"""Tell result that test finished with an error.
292
Called from the TestCase run() method when the test
293
fails with an unexpected error.
295
self._testConcluded(test)
296
if isinstance(err[1], TestNotApplicable):
297
return self._addNotApplicable(test, err)
298
elif isinstance(err[1], UnavailableFeature):
299
return self.addNotSupported(test, err[1].args[0])
301
unittest.TestResult.addError(self, test, err)
302
self.error_count += 1
303
self.report_error(test, err)
306
self._cleanupLogFile(test)
308
def addFailure(self, test, err):
309
"""Tell result that test failed.
311
Called from the TestCase run() method when the test
312
fails because e.g. an assert() method failed.
314
self._testConcluded(test)
315
if isinstance(err[1], KnownFailure):
316
return self._addKnownFailure(test, err)
318
unittest.TestResult.addFailure(self, test, err)
319
self.failure_count += 1
320
self.report_failure(test, err)
323
self._cleanupLogFile(test)
325
def addSuccess(self, test):
326
"""Tell result that test completed successfully.
328
Called from the TestCase run()
330
self._testConcluded(test)
331
if self._bench_history is not None:
332
benchmark_time = self._extractBenchmarkTime(test)
333
if benchmark_time is not None:
334
self._bench_history.write("%s %s\n" % (
335
self._formatTime(benchmark_time),
337
self.report_success(test)
338
self._cleanupLogFile(test)
339
unittest.TestResult.addSuccess(self, test)
340
test._log_contents = ''
342
def _testConcluded(self, test):
343
"""Common code when a test has finished.
345
Called regardless of whether it succeded, failed, etc.
349
def _addKnownFailure(self, test, err):
350
self.known_failure_count += 1
351
self.report_known_failure(test, err)
353
def addNotSupported(self, test, feature):
354
"""The test will not be run because of a missing feature.
356
# this can be called in two different ways: it may be that the
357
# test started running, and then raised (through addError)
358
# UnavailableFeature. Alternatively this method can be called
359
# while probing for features before running the tests; in that
360
# case we will see startTest and stopTest, but the test will never
362
self.unsupported.setdefault(str(feature), 0)
363
self.unsupported[str(feature)] += 1
364
self.report_unsupported(test, feature)
366
def addSkip(self, test, reason):
367
"""A test has not run for 'reason'."""
369
self.report_skip(test, reason)
371
def _addNotApplicable(self, test, skip_excinfo):
372
if isinstance(skip_excinfo[1], TestNotApplicable):
373
self.not_applicable_count += 1
374
self.report_not_applicable(test, skip_excinfo)
377
except KeyboardInterrupt:
380
self.addError(test, test.exc_info())
382
# seems best to treat this as success from point-of-view of unittest
383
# -- it actually does nothing so it barely matters :)
384
unittest.TestResult.addSuccess(self, test)
385
test._log_contents = ''
387
def printErrorList(self, flavour, errors):
388
for test, err in errors:
389
self.stream.writeln(self.separator1)
390
self.stream.write("%s: " % flavour)
391
self.stream.writeln(self.getDescription(test))
392
if getattr(test, '_get_log', None) is not None:
393
log_contents = test._get_log()
395
self.stream.write('\n')
397
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
398
self.stream.write('\n')
399
self.stream.write(log_contents)
400
self.stream.write('\n')
402
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
403
self.stream.write('\n')
404
self.stream.writeln(self.separator2)
405
self.stream.writeln("%s" % err)
407
def progress(self, offset, whence):
408
"""The test is adjusting the count of tests to run."""
409
if whence == SUBUNIT_SEEK_SET:
410
self.num_tests = offset
411
elif whence == SUBUNIT_SEEK_CUR:
412
self.num_tests += offset
414
raise errors.BzrError("Unknown whence %r" % whence)
416
def report_cleaning_up(self):
419
def startTestRun(self):
420
self.startTime = time.time()
422
def report_success(self, test):
425
def wasStrictlySuccessful(self):
426
if self.unsupported or self.known_failure_count:
428
return self.wasSuccessful()
431
class TextTestResult(ExtendedTestResult):
432
"""Displays progress and results of tests in text form"""
434
def __init__(self, stream, descriptions, verbosity,
439
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
440
bench_history, strict)
441
# We no longer pass them around, but just rely on the UIFactory stack
444
warnings.warn("Passing pb to TextTestResult is deprecated")
445
self.pb = self.ui.nested_progress_bar()
446
self.pb.show_pct = False
447
self.pb.show_spinner = False
448
self.pb.show_eta = False,
449
self.pb.show_count = False
450
self.pb.show_bar = False
451
self.pb.update_latency = 0
452
self.pb.show_transport_activity = False
454
def stopTestRun(self):
455
# called when the tests that are going to run have run
458
super(TextTestResult, self).stopTestRun()
460
def startTestRun(self):
461
super(TextTestResult, self).startTestRun()
462
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
464
def printErrors(self):
465
# clear the pb to make room for the error listing
467
super(TextTestResult, self).printErrors()
469
def _progress_prefix_text(self):
470
# the longer this text, the less space we have to show the test
472
a = '[%d' % self.count # total that have been run
473
# tests skipped as known not to be relevant are not important enough
475
## if self.skip_count:
476
## a += ', %d skip' % self.skip_count
477
## if self.known_failure_count:
478
## a += '+%dX' % self.known_failure_count
480
a +='/%d' % self.num_tests
482
runtime = time.time() - self._overall_start_time
484
a += '%dm%ds' % (runtime / 60, runtime % 60)
488
a += ', %d err' % self.error_count
489
if self.failure_count:
490
a += ', %d fail' % self.failure_count
492
a += ', %d missing' % len(self.unsupported)
496
def report_test_start(self, test):
499
self._progress_prefix_text()
501
+ self._shortened_test_description(test))
503
def _test_description(self, test):
504
return self._shortened_test_description(test)
506
def report_error(self, test, err):
507
self.pb.note('ERROR: %s\n %s\n',
508
self._test_description(test),
512
def report_failure(self, test, err):
513
self.pb.note('FAIL: %s\n %s\n',
514
self._test_description(test),
518
def report_known_failure(self, test, err):
519
self.pb.note('XFAIL: %s\n%s\n',
520
self._test_description(test), err[1])
522
def report_skip(self, test, reason):
525
def report_not_applicable(self, test, skip_excinfo):
528
def report_unsupported(self, test, feature):
529
"""test cannot be run because feature is missing."""
531
def report_cleaning_up(self):
532
self.pb.update('Cleaning up')
535
class VerboseTestResult(ExtendedTestResult):
536
"""Produce long output, with one line per test run plus times"""
538
def _ellipsize_to_right(self, a_string, final_width):
539
"""Truncate and pad a string, keeping the right hand side"""
540
if len(a_string) > final_width:
541
result = '...' + a_string[3-final_width:]
544
return result.ljust(final_width)
546
def startTestRun(self):
547
super(VerboseTestResult, self).startTestRun()
548
self.stream.write('running %d tests...\n' % self.num_tests)
550
def report_test_start(self, test):
552
name = self._shortened_test_description(test)
553
# width needs space for 6 char status, plus 1 for slash, plus an
554
# 11-char time string, plus a trailing blank
555
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
556
self.stream.write(self._ellipsize_to_right(name,
557
osutils.terminal_width()-18))
560
def _error_summary(self, err):
562
return '%s%s' % (indent, err[1])
564
def report_error(self, test, err):
565
self.stream.writeln('ERROR %s\n%s'
566
% (self._testTimeString(test),
567
self._error_summary(err)))
569
def report_failure(self, test, err):
570
self.stream.writeln(' FAIL %s\n%s'
571
% (self._testTimeString(test),
572
self._error_summary(err)))
574
def report_known_failure(self, test, err):
575
self.stream.writeln('XFAIL %s\n%s'
576
% (self._testTimeString(test),
577
self._error_summary(err)))
579
def report_success(self, test):
580
self.stream.writeln(' OK %s' % self._testTimeString(test))
581
for bench_called, stats in getattr(test, '_benchcalls', []):
582
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
583
stats.pprint(file=self.stream)
584
# flush the stream so that we get smooth output. This verbose mode is
585
# used to show the output in PQM.
588
def report_skip(self, test, reason):
589
self.stream.writeln(' SKIP %s\n%s'
590
% (self._testTimeString(test), reason))
592
def report_not_applicable(self, test, skip_excinfo):
593
self.stream.writeln(' N/A %s\n%s'
594
% (self._testTimeString(test),
595
self._error_summary(skip_excinfo)))
597
def report_unsupported(self, test, feature):
598
"""test cannot be run because feature is missing."""
599
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
600
%(self._testTimeString(test), feature))
603
class TextTestRunner(object):
604
stop_on_failure = False
612
result_decorators=None,
614
"""Create a TextTestRunner.
616
:param result_decorators: An optional list of decorators to apply
617
to the result object being used by the runner. Decorators are
618
applied left to right - the first element in the list is the
621
self.stream = unittest._WritelnDecorator(stream)
622
self.descriptions = descriptions
623
self.verbosity = verbosity
624
self._bench_history = bench_history
625
self._strict = strict
626
self._result_decorators = result_decorators or []
629
"Run the given test case or test suite."
630
if self.verbosity == 1:
631
result_class = TextTestResult
632
elif self.verbosity >= 2:
633
result_class = VerboseTestResult
634
original_result = result_class(self.stream,
637
bench_history=self._bench_history,
640
# Signal to result objects that look at stop early policy to stop,
641
original_result.stop_early = self.stop_on_failure
642
result = original_result
643
for decorator in self._result_decorators:
644
result = decorator(result)
645
result.stop_early = self.stop_on_failure
651
if isinstance(test, testtools.ConcurrentTestSuite):
652
# We need to catch bzr specific behaviors
653
result = BZRTransformingResult(result)
654
result.startTestRun()
659
# higher level code uses our extended protocol to determine
660
# what exit code to give.
661
return original_result
664
def iter_suite_tests(suite):
665
"""Return all tests in a suite, recursing through nested suites"""
666
if isinstance(suite, unittest.TestCase):
668
elif isinstance(suite, unittest.TestSuite):
670
for r in iter_suite_tests(item):
673
raise Exception('unknown type %r for object %r'
674
% (type(suite), suite))
677
class TestSkipped(Exception):
678
"""Indicates that a test was intentionally skipped, rather than failing."""
681
class TestNotApplicable(TestSkipped):
682
"""A test is not applicable to the situation where it was run.
684
This is only normally raised by parameterized tests, if they find that
685
the instance they're constructed upon does not support one aspect
690
class KnownFailure(AssertionError):
691
"""Indicates that a test failed in a precisely expected manner.
693
Such failures dont block the whole test suite from passing because they are
694
indicators of partially completed code or of future work. We have an
695
explicit error for them so that we can ensure that they are always visible:
696
KnownFailures are always shown in the output of bzr selftest.
700
class UnavailableFeature(Exception):
701
"""A feature required for this test was not available.
703
The feature should be used to construct the exception.
707
class CommandFailed(Exception):
711
class StringIOWrapper(object):
712
"""A wrapper around cStringIO which just adds an encoding attribute.
714
Internally we can check sys.stdout to see what the output encoding
715
should be. However, cStringIO has no encoding attribute that we can
716
set. So we wrap it instead.
721
def __init__(self, s=None):
723
self.__dict__['_cstring'] = StringIO(s)
725
self.__dict__['_cstring'] = StringIO()
727
def __getattr__(self, name, getattr=getattr):
728
return getattr(self.__dict__['_cstring'], name)
730
def __setattr__(self, name, val):
731
if name == 'encoding':
732
self.__dict__['encoding'] = val
734
return setattr(self._cstring, name, val)
737
class TestUIFactory(TextUIFactory):
738
"""A UI Factory for testing.
740
Hide the progress bar but emit note()s.
742
Allows get_password to be tested without real tty attached.
744
See also CannedInputUIFactory which lets you provide programmatic input in
747
# TODO: Capture progress events at the model level and allow them to be
748
# observed by tests that care.
750
# XXX: Should probably unify more with CannedInputUIFactory or a
751
# particular configuration of TextUIFactory, or otherwise have a clearer
752
# idea of how they're supposed to be different.
753
# See https://bugs.edge.launchpad.net/bzr/+bug/408213
755
def __init__(self, stdout=None, stderr=None, stdin=None):
756
if stdin is not None:
757
# We use a StringIOWrapper to be able to test various
758
# encodings, but the user is still responsible to
759
# encode the string and to set the encoding attribute
760
# of StringIOWrapper.
761
stdin = StringIOWrapper(stdin)
762
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
764
def get_non_echoed_password(self):
765
"""Get password from stdin without trying to handle the echo mode"""
766
password = self.stdin.readline()
769
if password[-1] == '\n':
770
password = password[:-1]
773
def make_progress_view(self):
774
return NullProgressView()
777
class TestCase(unittest.TestCase):
778
"""Base class for bzr unit tests.
780
Tests that need access to disk resources should subclass
781
TestCaseInTempDir not TestCase.
783
Error and debug log messages are redirected from their usual
784
location into a temporary file, the contents of which can be
785
retrieved by _get_log(). We use a real OS file, not an in-memory object,
786
so that it can also capture file IO. When the test completes this file
787
is read into memory and removed from disk.
789
There are also convenience functions to invoke bzr's command-line
790
routine, and to build and check bzr trees.
792
In addition to the usual method of overriding tearDown(), this class also
793
allows subclasses to register functions into the _cleanups list, which is
794
run in order as the object is torn down. It's less likely this will be
795
accidentally overlooked.
798
_active_threads = None
799
_leaking_threads_tests = 0
800
_first_thread_leaker_id = None
801
_log_file_name = None
803
_keep_log_file = False
804
# record lsprof data when performing benchmark calls.
805
_gather_lsprof_in_benchmarks = False
806
attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
807
'_log_contents', '_log_file_name', '_benchtime',
808
'_TestCase__testMethodName', '_TestCase__testMethodDoc',)
810
def __init__(self, methodName='testMethod'):
811
super(TestCase, self).__init__(methodName)
813
self._bzr_test_setUp_run = False
814
self._bzr_test_tearDown_run = False
817
unittest.TestCase.setUp(self)
818
self._bzr_test_setUp_run = True
819
self._cleanEnvironment()
822
self._benchcalls = []
823
self._benchtime = None
826
self._clear_debug_flags()
827
TestCase._active_threads = threading.activeCount()
828
self.addCleanup(self._check_leaked_threads)
833
pdb.Pdb().set_trace(sys._getframe().f_back)
835
def _check_leaked_threads(self):
836
active = threading.activeCount()
837
leaked_threads = active - TestCase._active_threads
838
TestCase._active_threads = active
840
TestCase._leaking_threads_tests += 1
841
if TestCase._first_thread_leaker_id is None:
842
TestCase._first_thread_leaker_id = self.id()
844
def _clear_debug_flags(self):
845
"""Prevent externally set debug flags affecting tests.
847
Tests that want to use debug flags can just set them in the
848
debug_flags set during setup/teardown.
850
self._preserved_debug_flags = set(debug.debug_flags)
851
if 'allow_debug' not in selftest_debug_flags:
852
debug.debug_flags.clear()
853
if 'disable_lock_checks' not in selftest_debug_flags:
854
debug.debug_flags.add('strict_locks')
855
self.addCleanup(self._restore_debug_flags)
857
def _clear_hooks(self):
858
# prevent hooks affecting tests
859
self._preserved_hooks = {}
860
for key, factory in hooks.known_hooks.items():
861
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
862
current_hooks = hooks.known_hooks_key_to_object(key)
863
self._preserved_hooks[parent] = (name, current_hooks)
864
self.addCleanup(self._restoreHooks)
865
for key, factory in hooks.known_hooks.items():
866
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
867
setattr(parent, name, factory())
868
# this hook should always be installed
869
request._install_hook()
871
def _silenceUI(self):
872
"""Turn off UI for duration of test"""
873
# by default the UI is off; tests can turn it on if they want it.
874
saved = ui.ui_factory
876
ui.ui_factory = saved
877
ui.ui_factory = ui.SilentUIFactory()
878
self.addCleanup(_restore)
880
def _check_locks(self):
881
"""Check that all lock take/release actions have been paired."""
882
# We always check for mismatched locks. If a mismatch is found, we
883
# fail unless -Edisable_lock_checks is supplied to selftest, in which
884
# case we just print a warning.
886
acquired_locks = [lock for action, lock in self._lock_actions
887
if action == 'acquired']
888
released_locks = [lock for action, lock in self._lock_actions
889
if action == 'released']
890
broken_locks = [lock for action, lock in self._lock_actions
891
if action == 'broken']
892
# trivially, given the tests for lock acquistion and release, if we
893
# have as many in each list, it should be ok. Some lock tests also
894
# break some locks on purpose and should be taken into account by
895
# considering that breaking a lock is just a dirty way of releasing it.
896
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
897
message = ('Different number of acquired and '
898
'released or broken locks. (%s, %s + %s)' %
899
(acquired_locks, released_locks, broken_locks))
900
if not self._lock_check_thorough:
901
# Rather than fail, just warn
902
print "Broken test %s: %s" % (self, message)
906
def _track_locks(self):
907
"""Track lock activity during tests."""
908
self._lock_actions = []
909
if 'disable_lock_checks' in selftest_debug_flags:
910
self._lock_check_thorough = False
912
self._lock_check_thorough = True
914
self.addCleanup(self._check_locks)
915
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
916
self._lock_acquired, None)
917
_mod_lock.Lock.hooks.install_named_hook('lock_released',
918
self._lock_released, None)
919
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
920
self._lock_broken, None)
922
def _lock_acquired(self, result):
923
self._lock_actions.append(('acquired', result))
925
def _lock_released(self, result):
926
self._lock_actions.append(('released', result))
928
def _lock_broken(self, result):
929
self._lock_actions.append(('broken', result))
931
def start_server(self, transport_server, backing_server=None):
932
"""Start transport_server for this test.
934
This starts the server, registers a cleanup for it and permits the
935
server's urls to be used.
937
if backing_server is None:
938
transport_server.setUp()
940
transport_server.setUp(backing_server)
941
self.addCleanup(transport_server.tearDown)
943
def _ndiff_strings(self, a, b):
944
"""Return ndiff between two strings containing lines.
946
A trailing newline is added if missing to make the strings
948
if b and b[-1] != '\n':
950
if a and a[-1] != '\n':
952
difflines = difflib.ndiff(a.splitlines(True),
954
linejunk=lambda x: False,
955
charjunk=lambda x: False)
956
return ''.join(difflines)
958
def assertEqual(self, a, b, message=''):
962
except UnicodeError, e:
963
# If we can't compare without getting a UnicodeError, then
964
# obviously they are different
965
mutter('UnicodeError: %s', e)
968
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
970
pformat(a), pformat(b)))
972
assertEquals = assertEqual
974
def assertEqualDiff(self, a, b, message=None):
975
"""Assert two texts are equal, if not raise an exception.
977
This is intended for use with multi-line strings where it can
978
be hard to find the differences by eye.
980
# TODO: perhaps override assertEquals to call this for strings?
984
message = "texts not equal:\n"
986
message = 'first string is missing a final newline.\n'
988
message = 'first string is missing a final newline.\n'
989
raise AssertionError(message +
990
self._ndiff_strings(a, b))
992
def assertEqualMode(self, mode, mode_test):
993
self.assertEqual(mode, mode_test,
994
'mode mismatch %o != %o' % (mode, mode_test))
996
def assertEqualStat(self, expected, actual):
997
"""assert that expected and actual are the same stat result.
999
:param expected: A stat result.
1000
:param actual: A stat result.
1001
:raises AssertionError: If the expected and actual stat values differ
1002
other than by atime.
1004
self.assertEqual(expected.st_size, actual.st_size)
1005
self.assertEqual(expected.st_mtime, actual.st_mtime)
1006
self.assertEqual(expected.st_ctime, actual.st_ctime)
1007
self.assertEqual(expected.st_dev, actual.st_dev)
1008
self.assertEqual(expected.st_ino, actual.st_ino)
1009
self.assertEqual(expected.st_mode, actual.st_mode)
1011
def assertLength(self, length, obj_with_len):
1012
"""Assert that obj_with_len is of length length."""
1013
if len(obj_with_len) != length:
1014
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1015
length, len(obj_with_len), obj_with_len))
1017
def assertPositive(self, val):
1018
"""Assert that val is greater than 0."""
1019
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1021
def assertNegative(self, val):
1022
"""Assert that val is less than 0."""
1023
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1025
def assertStartsWith(self, s, prefix):
1026
if not s.startswith(prefix):
1027
raise AssertionError('string %r does not start with %r' % (s, prefix))
1029
def assertEndsWith(self, s, suffix):
1030
"""Asserts that s ends with suffix."""
1031
if not s.endswith(suffix):
1032
raise AssertionError('string %r does not end with %r' % (s, suffix))
1034
def assertContainsRe(self, haystack, needle_re, flags=0):
1035
"""Assert that a contains something matching a regular expression."""
1036
if not re.search(needle_re, haystack, flags):
1037
if '\n' in haystack or len(haystack) > 60:
1038
# a long string, format it in a more readable way
1039
raise AssertionError(
1040
'pattern "%s" not found in\n"""\\\n%s"""\n'
1041
% (needle_re, haystack))
1043
raise AssertionError('pattern "%s" not found in "%s"'
1044
% (needle_re, haystack))
1046
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1047
"""Assert that a does not match a regular expression"""
1048
if re.search(needle_re, haystack, flags):
1049
raise AssertionError('pattern "%s" found in "%s"'
1050
% (needle_re, haystack))
1052
def assertSubset(self, sublist, superlist):
1053
"""Assert that every entry in sublist is present in superlist."""
1054
missing = set(sublist) - set(superlist)
1055
if len(missing) > 0:
1056
raise AssertionError("value(s) %r not present in container %r" %
1057
(missing, superlist))
1059
def assertListRaises(self, excClass, func, *args, **kwargs):
1060
"""Fail unless excClass is raised when the iterator from func is used.
1062
Many functions can return generators this makes sure
1063
to wrap them in a list() call to make sure the whole generator
1064
is run, and that the proper exception is raised.
1067
list(func(*args, **kwargs))
1071
if getattr(excClass,'__name__', None) is not None:
1072
excName = excClass.__name__
1074
excName = str(excClass)
1075
raise self.failureException, "%s not raised" % excName
1077
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1078
"""Assert that a callable raises a particular exception.
1080
:param excClass: As for the except statement, this may be either an
1081
exception class, or a tuple of classes.
1082
:param callableObj: A callable, will be passed ``*args`` and
1085
Returns the exception so that you can examine it.
1088
callableObj(*args, **kwargs)
1092
if getattr(excClass,'__name__', None) is not None:
1093
excName = excClass.__name__
1096
excName = str(excClass)
1097
raise self.failureException, "%s not raised" % excName
1099
def assertIs(self, left, right, message=None):
1100
if not (left is right):
1101
if message is not None:
1102
raise AssertionError(message)
1104
raise AssertionError("%r is not %r." % (left, right))
1106
def assertIsNot(self, left, right, message=None):
1108
if message is not None:
1109
raise AssertionError(message)
1111
raise AssertionError("%r is %r." % (left, right))
1113
def assertTransportMode(self, transport, path, mode):
1114
"""Fail if a path does not have mode "mode".
1116
If modes are not supported on this transport, the assertion is ignored.
1118
if not transport._can_roundtrip_unix_modebits():
1120
path_stat = transport.stat(path)
1121
actual_mode = stat.S_IMODE(path_stat.st_mode)
1122
self.assertEqual(mode, actual_mode,
1123
'mode of %r incorrect (%s != %s)'
1124
% (path, oct(mode), oct(actual_mode)))
1126
def assertIsSameRealPath(self, path1, path2):
1127
"""Fail if path1 and path2 points to different files"""
1128
self.assertEqual(osutils.realpath(path1),
1129
osutils.realpath(path2),
1130
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1132
def assertIsInstance(self, obj, kls, msg=None):
1133
"""Fail if obj is not an instance of kls
1135
:param msg: Supplementary message to show if the assertion fails.
1137
if not isinstance(obj, kls):
1138
m = "%r is an instance of %s rather than %s" % (
1139
obj, obj.__class__, kls)
1144
def expectFailure(self, reason, assertion, *args, **kwargs):
1145
"""Invoke a test, expecting it to fail for the given reason.
1147
This is for assertions that ought to succeed, but currently fail.
1148
(The failure is *expected* but not *wanted*.) Please be very precise
1149
about the failure you're expecting. If a new bug is introduced,
1150
AssertionError should be raised, not KnownFailure.
1152
Frequently, expectFailure should be followed by an opposite assertion.
1155
Intended to be used with a callable that raises AssertionError as the
1156
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1158
Raises KnownFailure if the test fails. Raises AssertionError if the
1163
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1165
self.assertEqual(42, dynamic_val)
1167
This means that a dynamic_val of 54 will cause the test to raise
1168
a KnownFailure. Once math is fixed and the expectFailure is removed,
1169
only a dynamic_val of 42 will allow the test to pass. Anything other
1170
than 54 or 42 will cause an AssertionError.
1173
assertion(*args, **kwargs)
1174
except AssertionError:
1175
raise KnownFailure(reason)
1177
self.fail('Unexpected success. Should have failed: %s' % reason)
1179
def assertFileEqual(self, content, path):
1180
"""Fail if path does not contain 'content'."""
1181
self.failUnlessExists(path)
1182
f = file(path, 'rb')
1187
self.assertEqualDiff(content, s)
1189
def failUnlessExists(self, path):
1190
"""Fail unless path or paths, which may be abs or relative, exist."""
1191
if not isinstance(path, basestring):
1193
self.failUnlessExists(p)
1195
self.failUnless(osutils.lexists(path),path+" does not exist")
1197
def failIfExists(self, path):
1198
"""Fail if path or paths, which may be abs or relative, exist."""
1199
if not isinstance(path, basestring):
1201
self.failIfExists(p)
1203
self.failIf(osutils.lexists(path),path+" exists")
1205
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1206
"""A helper for callDeprecated and applyDeprecated.
1208
:param a_callable: A callable to call.
1209
:param args: The positional arguments for the callable
1210
:param kwargs: The keyword arguments for the callable
1211
:return: A tuple (warnings, result). result is the result of calling
1212
a_callable(``*args``, ``**kwargs``).
1215
def capture_warnings(msg, cls=None, stacklevel=None):
1216
# we've hooked into a deprecation specific callpath,
1217
# only deprecations should getting sent via it.
1218
self.assertEqual(cls, DeprecationWarning)
1219
local_warnings.append(msg)
1220
original_warning_method = symbol_versioning.warn
1221
symbol_versioning.set_warning_method(capture_warnings)
1223
result = a_callable(*args, **kwargs)
1225
symbol_versioning.set_warning_method(original_warning_method)
1226
return (local_warnings, result)
1228
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1229
"""Call a deprecated callable without warning the user.
1231
Note that this only captures warnings raised by symbol_versioning.warn,
1232
not other callers that go direct to the warning module.
1234
To test that a deprecated method raises an error, do something like
1237
self.assertRaises(errors.ReservedId,
1238
self.applyDeprecated,
1239
deprecated_in((1, 5, 0)),
1243
:param deprecation_format: The deprecation format that the callable
1244
should have been deprecated with. This is the same type as the
1245
parameter to deprecated_method/deprecated_function. If the
1246
callable is not deprecated with this format, an assertion error
1248
:param a_callable: A callable to call. This may be a bound method or
1249
a regular function. It will be called with ``*args`` and
1251
:param args: The positional arguments for the callable
1252
:param kwargs: The keyword arguments for the callable
1253
:return: The result of a_callable(``*args``, ``**kwargs``)
1255
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1257
expected_first_warning = symbol_versioning.deprecation_string(
1258
a_callable, deprecation_format)
1259
if len(call_warnings) == 0:
1260
self.fail("No deprecation warning generated by call to %s" %
1262
self.assertEqual(expected_first_warning, call_warnings[0])
1265
def callCatchWarnings(self, fn, *args, **kw):
1266
"""Call a callable that raises python warnings.
1268
The caller's responsible for examining the returned warnings.
1270
If the callable raises an exception, the exception is not
1271
caught and propagates up to the caller. In that case, the list
1272
of warnings is not available.
1274
:returns: ([warning_object, ...], fn_result)
1276
# XXX: This is not perfect, because it completely overrides the
1277
# warnings filters, and some code may depend on suppressing particular
1278
# warnings. It's the easiest way to insulate ourselves from -Werror,
1279
# though. -- Andrew, 20071062
1281
def _catcher(message, category, filename, lineno, file=None, line=None):
1282
# despite the name, 'message' is normally(?) a Warning subclass
1284
wlist.append(message)
1285
saved_showwarning = warnings.showwarning
1286
saved_filters = warnings.filters
1288
warnings.showwarning = _catcher
1289
warnings.filters = []
1290
result = fn(*args, **kw)
1292
warnings.showwarning = saved_showwarning
1293
warnings.filters = saved_filters
1294
return wlist, result
1296
def callDeprecated(self, expected, callable, *args, **kwargs):
1297
"""Assert that a callable is deprecated in a particular way.
1299
This is a very precise test for unusual requirements. The
1300
applyDeprecated helper function is probably more suited for most tests
1301
as it allows you to simply specify the deprecation format being used
1302
and will ensure that that is issued for the function being called.
1304
Note that this only captures warnings raised by symbol_versioning.warn,
1305
not other callers that go direct to the warning module. To catch
1306
general warnings, use callCatchWarnings.
1308
:param expected: a list of the deprecation warnings expected, in order
1309
:param callable: The callable to call
1310
:param args: The positional arguments for the callable
1311
:param kwargs: The keyword arguments for the callable
1313
call_warnings, result = self._capture_deprecation_warnings(callable,
1315
self.assertEqual(expected, call_warnings)
1318
def _startLogFile(self):
1319
"""Send bzr and test log messages to a temporary file.
1321
The file is removed as the test is torn down.
1323
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1324
self._log_file = os.fdopen(fileno, 'w+')
1325
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1326
self._log_file_name = name
1327
self.addCleanup(self._finishLogFile)
1329
def _finishLogFile(self):
1330
"""Finished with the log file.
1332
Close the file and delete it, unless setKeepLogfile was called.
1334
if self._log_file is None:
1336
bzrlib.trace.pop_log_file(self._log_memento)
1337
self._log_file.close()
1338
self._log_file = None
1339
if not self._keep_log_file:
1340
os.remove(self._log_file_name)
1341
self._log_file_name = None
1343
def setKeepLogfile(self):
1344
"""Make the logfile not be deleted when _finishLogFile is called."""
1345
self._keep_log_file = True
1347
def thisFailsStrictLockCheck(self):
1348
"""It is known that this test would fail with -Dstrict_locks.
1350
By default, all tests are run with strict lock checking unless
1351
-Edisable_lock_checks is supplied. However there are some tests which
1352
we know fail strict locks at this point that have not been fixed.
1353
They should call this function to disable the strict checking.
1355
This should be used sparingly, it is much better to fix the locking
1356
issues rather than papering over the problem by calling this function.
1358
debug.debug_flags.discard('strict_locks')
1360
def addCleanup(self, callable, *args, **kwargs):
1361
"""Arrange to run a callable when this case is torn down.
1363
Callables are run in the reverse of the order they are registered,
1364
ie last-in first-out.
1366
self._cleanups.append((callable, args, kwargs))
1368
def _cleanEnvironment(self):
1370
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1371
'HOME': os.getcwd(),
1372
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1373
# tests do check our impls match APPDATA
1374
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1378
'BZREMAIL': None, # may still be present in the environment
1380
'BZR_PROGRESS_BAR': None,
1382
'BZR_PLUGIN_PATH': None,
1383
# Make sure that any text ui tests are consistent regardless of
1384
# the environment the test case is run in; you may want tests that
1385
# test other combinations. 'dumb' is a reasonable guess for tests
1386
# going to a pipe or a StringIO.
1391
'SSH_AUTH_SOCK': None,
1395
'https_proxy': None,
1396
'HTTPS_PROXY': None,
1401
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1402
# least. If you do (care), please update this comment
1406
'BZR_REMOTE_PATH': None,
1409
self.addCleanup(self._restoreEnvironment)
1410
for name, value in new_env.iteritems():
1411
self._captureVar(name, value)
1413
def _captureVar(self, name, newvalue):
1414
"""Set an environment variable, and reset it when finished."""
1415
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1417
def _restore_debug_flags(self):
1418
debug.debug_flags.clear()
1419
debug.debug_flags.update(self._preserved_debug_flags)
1421
def _restoreEnvironment(self):
1422
for name, value in self.__old_env.iteritems():
1423
osutils.set_or_unset_env(name, value)
1425
def _restoreHooks(self):
1426
for klass, (name, hooks) in self._preserved_hooks.items():
1427
setattr(klass, name, hooks)
1429
def knownFailure(self, reason):
1430
"""This test has failed for some known reason."""
1431
raise KnownFailure(reason)
1433
def _do_skip(self, result, reason):
1434
addSkip = getattr(result, 'addSkip', None)
1435
if not callable(addSkip):
1436
result.addError(self, sys.exc_info())
1438
addSkip(self, reason)
1440
def run(self, result=None):
1441
if result is None: result = self.defaultTestResult()
1442
for feature in getattr(self, '_test_needs_features', []):
1443
if not feature.available():
1444
result.startTest(self)
1445
if getattr(result, 'addNotSupported', None):
1446
result.addNotSupported(self, feature)
1448
result.addSuccess(self)
1449
result.stopTest(self)
1453
result.startTest(self)
1454
absent_attr = object()
1456
method_name = getattr(self, '_testMethodName', absent_attr)
1457
if method_name is absent_attr:
1459
method_name = getattr(self, '_TestCase__testMethodName')
1460
testMethod = getattr(self, method_name)
1464
if not self._bzr_test_setUp_run:
1466
"test setUp did not invoke "
1467
"bzrlib.tests.TestCase's setUp")
1468
except KeyboardInterrupt:
1471
except TestSkipped, e:
1472
self._do_skip(result, e.args[0])
1476
result.addError(self, sys.exc_info())
1484
except self.failureException:
1485
result.addFailure(self, sys.exc_info())
1486
except TestSkipped, e:
1488
reason = "No reason given."
1491
self._do_skip(result, reason)
1492
except KeyboardInterrupt:
1496
result.addError(self, sys.exc_info())
1500
if not self._bzr_test_tearDown_run:
1502
"test tearDown did not invoke "
1503
"bzrlib.tests.TestCase's tearDown")
1504
except KeyboardInterrupt:
1508
result.addError(self, sys.exc_info())
1511
if ok: result.addSuccess(self)
1513
result.stopTest(self)
1515
except TestNotApplicable:
1516
# Not moved from the result [yet].
1519
except KeyboardInterrupt:
1524
for attr_name in self.attrs_to_keep:
1525
if attr_name in self.__dict__:
1526
saved_attrs[attr_name] = self.__dict__[attr_name]
1527
self.__dict__ = saved_attrs
1531
self._log_contents = ''
1532
self._bzr_test_tearDown_run = True
1533
unittest.TestCase.tearDown(self)
1535
def time(self, callable, *args, **kwargs):
1536
"""Run callable and accrue the time it takes to the benchmark time.
1538
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1539
this will cause lsprofile statistics to be gathered and stored in
1542
if self._benchtime is None:
1546
if not self._gather_lsprof_in_benchmarks:
1547
return callable(*args, **kwargs)
1549
# record this benchmark
1550
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1552
self._benchcalls.append(((callable, args, kwargs), stats))
1555
self._benchtime += time.time() - start
1557
def _runCleanups(self):
1558
"""Run registered cleanup functions.
1560
This should only be called from TestCase.tearDown.
1562
# TODO: Perhaps this should keep running cleanups even if
1563
# one of them fails?
1565
# Actually pop the cleanups from the list so tearDown running
1566
# twice is safe (this happens for skipped tests).
1567
while self._cleanups:
1568
cleanup, args, kwargs = self._cleanups.pop()
1569
cleanup(*args, **kwargs)
1571
def log(self, *args):
1574
def _get_log(self, keep_log_file=False):
1575
"""Get the log from bzrlib.trace calls from this test.
1577
:param keep_log_file: When True, if the log is still a file on disk
1578
leave it as a file on disk. When False, if the log is still a file
1579
on disk, the log file is deleted and the log preserved as
1581
:return: A string containing the log.
1583
# flush the log file, to get all content
1585
if bzrlib.trace._trace_file:
1586
bzrlib.trace._trace_file.flush()
1587
if self._log_contents:
1588
# XXX: this can hardly contain the content flushed above --vila
1590
return self._log_contents
1591
if self._log_file_name is not None:
1592
logfile = open(self._log_file_name)
1594
log_contents = logfile.read()
1597
if not keep_log_file:
1598
self._log_contents = log_contents
1600
os.remove(self._log_file_name)
1602
if sys.platform == 'win32' and e.errno == errno.EACCES:
1603
sys.stderr.write(('Unable to delete log file '
1604
' %r\n' % self._log_file_name))
1609
return "DELETED log file to reduce memory footprint"
1611
def requireFeature(self, feature):
1612
"""This test requires a specific feature is available.
1614
:raises UnavailableFeature: When feature is not available.
1616
if not feature.available():
1617
raise UnavailableFeature(feature)
1619
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1621
"""Run bazaar command line, splitting up a string command line."""
1622
if isinstance(args, basestring):
1623
# shlex don't understand unicode strings,
1624
# so args should be plain string (bialix 20070906)
1625
args = list(shlex.split(str(args)))
1626
return self._run_bzr_core(args, retcode=retcode,
1627
encoding=encoding, stdin=stdin, working_dir=working_dir,
1630
def _run_bzr_core(self, args, retcode, encoding, stdin,
1632
if encoding is None:
1633
encoding = osutils.get_user_encoding()
1634
stdout = StringIOWrapper()
1635
stderr = StringIOWrapper()
1636
stdout.encoding = encoding
1637
stderr.encoding = encoding
1639
self.log('run bzr: %r', args)
1640
# FIXME: don't call into logging here
1641
handler = logging.StreamHandler(stderr)
1642
handler.setLevel(logging.INFO)
1643
logger = logging.getLogger('')
1644
logger.addHandler(handler)
1645
old_ui_factory = ui.ui_factory
1646
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1649
if working_dir is not None:
1650
cwd = osutils.getcwd()
1651
os.chdir(working_dir)
1654
result = self.apply_redirected(ui.ui_factory.stdin,
1656
bzrlib.commands.run_bzr_catch_user_errors,
1659
logger.removeHandler(handler)
1660
ui.ui_factory = old_ui_factory
1664
out = stdout.getvalue()
1665
err = stderr.getvalue()
1667
self.log('output:\n%r', out)
1669
self.log('errors:\n%r', err)
1670
if retcode is not None:
1671
self.assertEquals(retcode, result,
1672
message='Unexpected return code')
1675
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1676
working_dir=None, error_regexes=[], output_encoding=None):
1677
"""Invoke bzr, as if it were run from the command line.
1679
The argument list should not include the bzr program name - the
1680
first argument is normally the bzr command. Arguments may be
1681
passed in three ways:
1683
1- A list of strings, eg ["commit", "a"]. This is recommended
1684
when the command contains whitespace or metacharacters, or
1685
is built up at run time.
1687
2- A single string, eg "add a". This is the most convenient
1688
for hardcoded commands.
1690
This runs bzr through the interface that catches and reports
1691
errors, and with logging set to something approximating the
1692
default, so that error reporting can be checked.
1694
This should be the main method for tests that want to exercise the
1695
overall behavior of the bzr application (rather than a unit test
1696
or a functional test of the library.)
1698
This sends the stdout/stderr results into the test's log,
1699
where it may be useful for debugging. See also run_captured.
1701
:keyword stdin: A string to be used as stdin for the command.
1702
:keyword retcode: The status code the command should return;
1704
:keyword working_dir: The directory to run the command in
1705
:keyword error_regexes: A list of expected error messages. If
1706
specified they must be seen in the error output of the command.
1708
out, err = self._run_bzr_autosplit(
1713
working_dir=working_dir,
1715
self.assertIsInstance(error_regexes, (list, tuple))
1716
for regex in error_regexes:
1717
self.assertContainsRe(err, regex)
1720
def run_bzr_error(self, error_regexes, *args, **kwargs):
1721
"""Run bzr, and check that stderr contains the supplied regexes
1723
:param error_regexes: Sequence of regular expressions which
1724
must each be found in the error output. The relative ordering
1726
:param args: command-line arguments for bzr
1727
:param kwargs: Keyword arguments which are interpreted by run_bzr
1728
This function changes the default value of retcode to be 3,
1729
since in most cases this is run when you expect bzr to fail.
1731
:return: (out, err) The actual output of running the command (in case
1732
you want to do more inspection)
1736
# Make sure that commit is failing because there is nothing to do
1737
self.run_bzr_error(['no changes to commit'],
1738
['commit', '-m', 'my commit comment'])
1739
# Make sure --strict is handling an unknown file, rather than
1740
# giving us the 'nothing to do' error
1741
self.build_tree(['unknown'])
1742
self.run_bzr_error(['Commit refused because there are unknown files'],
1743
['commit', --strict', '-m', 'my commit comment'])
1745
kwargs.setdefault('retcode', 3)
1746
kwargs['error_regexes'] = error_regexes
1747
out, err = self.run_bzr(*args, **kwargs)
1750
def run_bzr_subprocess(self, *args, **kwargs):
1751
"""Run bzr in a subprocess for testing.
1753
This starts a new Python interpreter and runs bzr in there.
1754
This should only be used for tests that have a justifiable need for
1755
this isolation: e.g. they are testing startup time, or signal
1756
handling, or early startup code, etc. Subprocess code can't be
1757
profiled or debugged so easily.
1759
:keyword retcode: The status code that is expected. Defaults to 0. If
1760
None is supplied, the status code is not checked.
1761
:keyword env_changes: A dictionary which lists changes to environment
1762
variables. A value of None will unset the env variable.
1763
The values must be strings. The change will only occur in the
1764
child, so you don't need to fix the environment after running.
1765
:keyword universal_newlines: Convert CRLF => LF
1766
:keyword allow_plugins: By default the subprocess is run with
1767
--no-plugins to ensure test reproducibility. Also, it is possible
1768
for system-wide plugins to create unexpected output on stderr,
1769
which can cause unnecessary test failures.
1771
env_changes = kwargs.get('env_changes', {})
1772
working_dir = kwargs.get('working_dir', None)
1773
allow_plugins = kwargs.get('allow_plugins', False)
1775
if isinstance(args[0], list):
1777
elif isinstance(args[0], basestring):
1778
args = list(shlex.split(args[0]))
1780
raise ValueError("passing varargs to run_bzr_subprocess")
1781
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1782
working_dir=working_dir,
1783
allow_plugins=allow_plugins)
1784
# We distinguish between retcode=None and retcode not passed.
1785
supplied_retcode = kwargs.get('retcode', 0)
1786
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1787
universal_newlines=kwargs.get('universal_newlines', False),
1790
def start_bzr_subprocess(self, process_args, env_changes=None,
1791
skip_if_plan_to_signal=False,
1793
allow_plugins=False):
1794
"""Start bzr in a subprocess for testing.
1796
This starts a new Python interpreter and runs bzr in there.
1797
This should only be used for tests that have a justifiable need for
1798
this isolation: e.g. they are testing startup time, or signal
1799
handling, or early startup code, etc. Subprocess code can't be
1800
profiled or debugged so easily.
1802
:param process_args: a list of arguments to pass to the bzr executable,
1803
for example ``['--version']``.
1804
:param env_changes: A dictionary which lists changes to environment
1805
variables. A value of None will unset the env variable.
1806
The values must be strings. The change will only occur in the
1807
child, so you don't need to fix the environment after running.
1808
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1810
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1812
:returns: Popen object for the started process.
1814
if skip_if_plan_to_signal:
1815
if not getattr(os, 'kill', None):
1816
raise TestSkipped("os.kill not available.")
1818
if env_changes is None:
1822
def cleanup_environment():
1823
for env_var, value in env_changes.iteritems():
1824
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1826
def restore_environment():
1827
for env_var, value in old_env.iteritems():
1828
osutils.set_or_unset_env(env_var, value)
1830
bzr_path = self.get_bzr_path()
1833
if working_dir is not None:
1834
cwd = osutils.getcwd()
1835
os.chdir(working_dir)
1838
# win32 subprocess doesn't support preexec_fn
1839
# so we will avoid using it on all platforms, just to
1840
# make sure the code path is used, and we don't break on win32
1841
cleanup_environment()
1842
command = [sys.executable]
1843
# frozen executables don't need the path to bzr
1844
if getattr(sys, "frozen", None) is None:
1845
command.append(bzr_path)
1846
if not allow_plugins:
1847
command.append('--no-plugins')
1848
command.extend(process_args)
1849
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1851
restore_environment()
1857
def _popen(self, *args, **kwargs):
1858
"""Place a call to Popen.
1860
Allows tests to override this method to intercept the calls made to
1861
Popen for introspection.
1863
return Popen(*args, **kwargs)
1865
def get_bzr_path(self):
1866
"""Return the path of the 'bzr' executable for this test suite."""
1867
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1868
if not os.path.isfile(bzr_path):
1869
# We are probably installed. Assume sys.argv is the right file
1870
bzr_path = sys.argv[0]
1873
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1874
universal_newlines=False, process_args=None):
1875
"""Finish the execution of process.
1877
:param process: the Popen object returned from start_bzr_subprocess.
1878
:param retcode: The status code that is expected. Defaults to 0. If
1879
None is supplied, the status code is not checked.
1880
:param send_signal: an optional signal to send to the process.
1881
:param universal_newlines: Convert CRLF => LF
1882
:returns: (stdout, stderr)
1884
if send_signal is not None:
1885
os.kill(process.pid, send_signal)
1886
out, err = process.communicate()
1888
if universal_newlines:
1889
out = out.replace('\r\n', '\n')
1890
err = err.replace('\r\n', '\n')
1892
if retcode is not None and retcode != process.returncode:
1893
if process_args is None:
1894
process_args = "(unknown args)"
1895
mutter('Output of bzr %s:\n%s', process_args, out)
1896
mutter('Error for bzr %s:\n%s', process_args, err)
1897
self.fail('Command bzr %s failed with retcode %s != %s'
1898
% (process_args, retcode, process.returncode))
1901
def check_inventory_shape(self, inv, shape):
1902
"""Compare an inventory to a list of expected names.
1904
Fail if they are not precisely equal.
1907
shape = list(shape) # copy
1908
for path, ie in inv.entries():
1909
name = path.replace('\\', '/')
1910
if ie.kind == 'directory':
1917
self.fail("expected paths not found in inventory: %r" % shape)
1919
self.fail("unexpected paths found in inventory: %r" % extras)
1921
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1922
a_callable=None, *args, **kwargs):
1923
"""Call callable with redirected std io pipes.
1925
Returns the return code."""
1926
if not callable(a_callable):
1927
raise ValueError("a_callable must be callable.")
1929
stdin = StringIO("")
1931
if getattr(self, "_log_file", None) is not None:
1932
stdout = self._log_file
1936
if getattr(self, "_log_file", None is not None):
1937
stderr = self._log_file
1940
real_stdin = sys.stdin
1941
real_stdout = sys.stdout
1942
real_stderr = sys.stderr
1947
return a_callable(*args, **kwargs)
1949
sys.stdout = real_stdout
1950
sys.stderr = real_stderr
1951
sys.stdin = real_stdin
1953
def reduceLockdirTimeout(self):
1954
"""Reduce the default lock timeout for the duration of the test, so that
1955
if LockContention occurs during a test, it does so quickly.
1957
Tests that expect to provoke LockContention errors should call this.
1959
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1961
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1962
self.addCleanup(resetTimeout)
1963
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1965
def make_utf8_encoded_stringio(self, encoding_type=None):
1966
"""Return a StringIOWrapper instance, that will encode Unicode
1969
if encoding_type is None:
1970
encoding_type = 'strict'
1972
output_encoding = 'utf-8'
1973
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1974
sio.encoding = output_encoding
1977
def disable_verb(self, verb):
1978
"""Disable a smart server verb for one test."""
1979
from bzrlib.smart import request
1980
request_handlers = request.request_handlers
1981
orig_method = request_handlers.get(verb)
1982
request_handlers.remove(verb)
1984
request_handlers.register(verb, orig_method)
1985
self.addCleanup(restoreVerb)
1988
class CapturedCall(object):
1989
"""A helper for capturing smart server calls for easy debug analysis."""
1991
def __init__(self, params, prefix_length):
1992
"""Capture the call with params and skip prefix_length stack frames."""
1995
# The last 5 frames are the __init__, the hook frame, and 3 smart
1996
# client frames. Beyond this we could get more clever, but this is good
1998
stack = traceback.extract_stack()[prefix_length:-5]
1999
self.stack = ''.join(traceback.format_list(stack))
2002
return self.call.method
2005
return self.call.method
2011
class TestCaseWithMemoryTransport(TestCase):
2012
"""Common test class for tests that do not need disk resources.
2014
Tests that need disk resources should derive from TestCaseWithTransport.
2016
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2018
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2019
a directory which does not exist. This serves to help ensure test isolation
2020
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2021
must exist. However, TestCaseWithMemoryTransport does not offer local
2022
file defaults for the transport in tests, nor does it obey the command line
2023
override, so tests that accidentally write to the common directory should
2026
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2027
a .bzr directory that stops us ascending higher into the filesystem.
2033
def __init__(self, methodName='runTest'):
2034
# allow test parameterization after test construction and before test
2035
# execution. Variables that the parameterizer sets need to be
2036
# ones that are not set by setUp, or setUp will trash them.
2037
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2038
self.vfs_transport_factory = default_transport
2039
self.transport_server = None
2040
self.transport_readonly_server = None
2041
self.__vfs_server = None
2043
def get_transport(self, relpath=None):
2044
"""Return a writeable transport.
2046
This transport is for the test scratch space relative to
2049
:param relpath: a path relative to the base url.
2051
t = get_transport(self.get_url(relpath))
2052
self.assertFalse(t.is_readonly())
2055
def get_readonly_transport(self, relpath=None):
2056
"""Return a readonly transport for the test scratch space
2058
This can be used to test that operations which should only need
2059
readonly access in fact do not try to write.
2061
:param relpath: a path relative to the base url.
2063
t = get_transport(self.get_readonly_url(relpath))
2064
self.assertTrue(t.is_readonly())
2067
def create_transport_readonly_server(self):
2068
"""Create a transport server from class defined at init.
2070
This is mostly a hook for daughter classes.
2072
return self.transport_readonly_server()
2074
def get_readonly_server(self):
2075
"""Get the server instance for the readonly transport
2077
This is useful for some tests with specific servers to do diagnostics.
2079
if self.__readonly_server is None:
2080
if self.transport_readonly_server is None:
2081
# readonly decorator requested
2082
self.__readonly_server = ReadonlyServer()
2084
# explicit readonly transport.
2085
self.__readonly_server = self.create_transport_readonly_server()
2086
self.start_server(self.__readonly_server,
2087
self.get_vfs_only_server())
2088
return self.__readonly_server
2090
def get_readonly_url(self, relpath=None):
2091
"""Get a URL for the readonly transport.
2093
This will either be backed by '.' or a decorator to the transport
2094
used by self.get_url()
2095
relpath provides for clients to get a path relative to the base url.
2096
These should only be downwards relative, not upwards.
2098
base = self.get_readonly_server().get_url()
2099
return self._adjust_url(base, relpath)
2101
def get_vfs_only_server(self):
2102
"""Get the vfs only read/write server instance.
2104
This is useful for some tests with specific servers that need
2107
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2108
is no means to override it.
2110
if self.__vfs_server is None:
2111
self.__vfs_server = MemoryServer()
2112
self.start_server(self.__vfs_server)
2113
return self.__vfs_server
2115
def get_server(self):
2116
"""Get the read/write server instance.
2118
This is useful for some tests with specific servers that need
2121
This is built from the self.transport_server factory. If that is None,
2122
then the self.get_vfs_server is returned.
2124
if self.__server is None:
2125
if (self.transport_server is None or self.transport_server is
2126
self.vfs_transport_factory):
2127
self.__server = self.get_vfs_only_server()
2129
# bring up a decorated means of access to the vfs only server.
2130
self.__server = self.transport_server()
2131
self.start_server(self.__server, self.get_vfs_only_server())
2132
return self.__server
2134
def _adjust_url(self, base, relpath):
2135
"""Get a URL (or maybe a path) for the readwrite transport.
2137
This will either be backed by '.' or to an equivalent non-file based
2139
relpath provides for clients to get a path relative to the base url.
2140
These should only be downwards relative, not upwards.
2142
if relpath is not None and relpath != '.':
2143
if not base.endswith('/'):
2145
# XXX: Really base should be a url; we did after all call
2146
# get_url()! But sometimes it's just a path (from
2147
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2148
# to a non-escaped local path.
2149
if base.startswith('./') or base.startswith('/'):
2152
base += urlutils.escape(relpath)
2155
def get_url(self, relpath=None):
2156
"""Get a URL (or maybe a path) for the readwrite transport.
2158
This will either be backed by '.' or to an equivalent non-file based
2160
relpath provides for clients to get a path relative to the base url.
2161
These should only be downwards relative, not upwards.
2163
base = self.get_server().get_url()
2164
return self._adjust_url(base, relpath)
2166
def get_vfs_only_url(self, relpath=None):
2167
"""Get a URL (or maybe a path for the plain old vfs transport.
2169
This will never be a smart protocol. It always has all the
2170
capabilities of the local filesystem, but it might actually be a
2171
MemoryTransport or some other similar virtual filesystem.
2173
This is the backing transport (if any) of the server returned by
2174
get_url and get_readonly_url.
2176
:param relpath: provides for clients to get a path relative to the base
2177
url. These should only be downwards relative, not upwards.
2180
base = self.get_vfs_only_server().get_url()
2181
return self._adjust_url(base, relpath)
2183
def _create_safety_net(self):
2184
"""Make a fake bzr directory.
2186
This prevents any tests propagating up onto the TEST_ROOT directory's
2189
root = TestCaseWithMemoryTransport.TEST_ROOT
2190
bzrdir.BzrDir.create_standalone_workingtree(root)
2192
def _check_safety_net(self):
2193
"""Check that the safety .bzr directory have not been touched.
2195
_make_test_root have created a .bzr directory to prevent tests from
2196
propagating. This method ensures than a test did not leaked.
2198
root = TestCaseWithMemoryTransport.TEST_ROOT
2199
wt = workingtree.WorkingTree.open(root)
2200
last_rev = wt.last_revision()
2201
if last_rev != 'null:':
2202
# The current test have modified the /bzr directory, we need to
2203
# recreate a new one or all the followng tests will fail.
2204
# If you need to inspect its content uncomment the following line
2205
# import pdb; pdb.set_trace()
2206
_rmtree_temp_dir(root + '/.bzr')
2207
self._create_safety_net()
2208
raise AssertionError('%s/.bzr should not be modified' % root)
2210
def _make_test_root(self):
2211
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2212
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2213
TestCaseWithMemoryTransport.TEST_ROOT = root
2215
self._create_safety_net()
2217
# The same directory is used by all tests, and we're not
2218
# specifically told when all tests are finished. This will do.
2219
atexit.register(_rmtree_temp_dir, root)
2221
self.addCleanup(self._check_safety_net)
2223
def makeAndChdirToTestDir(self):
2224
"""Create a temporary directories for this one test.
2226
This must set self.test_home_dir and self.test_dir and chdir to
2229
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2231
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2232
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2233
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2235
def make_branch(self, relpath, format=None):
2236
"""Create a branch on the transport at relpath."""
2237
repo = self.make_repository(relpath, format=format)
2238
return repo.bzrdir.create_branch()
2240
def make_bzrdir(self, relpath, format=None):
2242
# might be a relative or absolute path
2243
maybe_a_url = self.get_url(relpath)
2244
segments = maybe_a_url.rsplit('/', 1)
2245
t = get_transport(maybe_a_url)
2246
if len(segments) > 1 and segments[-1] not in ('', '.'):
2250
if isinstance(format, basestring):
2251
format = bzrdir.format_registry.make_bzrdir(format)
2252
return format.initialize_on_transport(t)
2253
except errors.UninitializableFormat:
2254
raise TestSkipped("Format %s is not initializable." % format)
2256
def make_repository(self, relpath, shared=False, format=None):
2257
"""Create a repository on our default transport at relpath.
2259
Note that relpath must be a relative path, not a full url.
2261
# FIXME: If you create a remoterepository this returns the underlying
2262
# real format, which is incorrect. Actually we should make sure that
2263
# RemoteBzrDir returns a RemoteRepository.
2264
# maybe mbp 20070410
2265
made_control = self.make_bzrdir(relpath, format=format)
2266
return made_control.create_repository(shared=shared)
2268
def make_smart_server(self, path):
2269
smart_server = server.SmartTCPServer_for_testing()
2270
self.start_server(smart_server, self.get_server())
2271
remote_transport = get_transport(smart_server.get_url()).clone(path)
2272
return remote_transport
2274
def make_branch_and_memory_tree(self, relpath, format=None):
2275
"""Create a branch on the default transport and a MemoryTree for it."""
2276
b = self.make_branch(relpath, format=format)
2277
return memorytree.MemoryTree.create_on_branch(b)
2279
def make_branch_builder(self, relpath, format=None):
2280
branch = self.make_branch(relpath, format=format)
2281
return branchbuilder.BranchBuilder(branch=branch)
2283
def overrideEnvironmentForTesting(self):
2284
os.environ['HOME'] = self.test_home_dir
2285
os.environ['BZR_HOME'] = self.test_home_dir
2288
super(TestCaseWithMemoryTransport, self).setUp()
2289
self._make_test_root()
2290
_currentdir = os.getcwdu()
2291
def _leaveDirectory():
2292
os.chdir(_currentdir)
2293
self.addCleanup(_leaveDirectory)
2294
self.makeAndChdirToTestDir()
2295
self.overrideEnvironmentForTesting()
2296
self.__readonly_server = None
2297
self.__server = None
2298
self.reduceLockdirTimeout()
2300
def setup_smart_server_with_call_log(self):
2301
"""Sets up a smart server as the transport server with a call log."""
2302
self.transport_server = server.SmartTCPServer_for_testing
2303
self.hpss_calls = []
2305
# Skip the current stack down to the caller of
2306
# setup_smart_server_with_call_log
2307
prefix_length = len(traceback.extract_stack()) - 2
2308
def capture_hpss_call(params):
2309
self.hpss_calls.append(
2310
CapturedCall(params, prefix_length))
2311
client._SmartClient.hooks.install_named_hook(
2312
'call', capture_hpss_call, None)
2314
def reset_smart_call_log(self):
2315
self.hpss_calls = []
2318
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2319
"""Derived class that runs a test within a temporary directory.
2321
This is useful for tests that need to create a branch, etc.
2323
The directory is created in a slightly complex way: for each
2324
Python invocation, a new temporary top-level directory is created.
2325
All test cases create their own directory within that. If the
2326
tests complete successfully, the directory is removed.
2328
:ivar test_base_dir: The path of the top-level directory for this
2329
test, which contains a home directory and a work directory.
2331
:ivar test_home_dir: An initially empty directory under test_base_dir
2332
which is used as $HOME for this test.
2334
:ivar test_dir: A directory under test_base_dir used as the current
2335
directory when the test proper is run.
2338
OVERRIDE_PYTHON = 'python'
2340
def check_file_contents(self, filename, expect):
2341
self.log("check contents of file %s" % filename)
2342
contents = file(filename, 'r').read()
2343
if contents != expect:
2344
self.log("expected: %r" % expect)
2345
self.log("actually: %r" % contents)
2346
self.fail("contents of %s not as expected" % filename)
2348
def _getTestDirPrefix(self):
2349
# create a directory within the top level test directory
2350
if sys.platform in ('win32', 'cygwin'):
2351
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2352
# windows is likely to have path-length limits so use a short name
2353
name_prefix = name_prefix[-30:]
2355
name_prefix = re.sub('[/]', '_', self.id())
2358
def makeAndChdirToTestDir(self):
2359
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2361
For TestCaseInTempDir we create a temporary directory based on the test
2362
name and then create two subdirs - test and home under it.
2364
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2365
self._getTestDirPrefix())
2367
for i in range(100):
2368
if os.path.exists(name):
2369
name = name_prefix + '_' + str(i)
2373
# now create test and home directories within this dir
2374
self.test_base_dir = name
2375
self.test_home_dir = self.test_base_dir + '/home'
2376
os.mkdir(self.test_home_dir)
2377
self.test_dir = self.test_base_dir + '/work'
2378
os.mkdir(self.test_dir)
2379
os.chdir(self.test_dir)
2380
# put name of test inside
2381
f = file(self.test_base_dir + '/name', 'w')
2386
self.addCleanup(self.deleteTestDir)
2388
def deleteTestDir(self):
2389
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2390
_rmtree_temp_dir(self.test_base_dir)
2392
def build_tree(self, shape, line_endings='binary', transport=None):
2393
"""Build a test tree according to a pattern.
2395
shape is a sequence of file specifications. If the final
2396
character is '/', a directory is created.
2398
This assumes that all the elements in the tree being built are new.
2400
This doesn't add anything to a branch.
2402
:type shape: list or tuple.
2403
:param line_endings: Either 'binary' or 'native'
2404
in binary mode, exact contents are written in native mode, the
2405
line endings match the default platform endings.
2406
:param transport: A transport to write to, for building trees on VFS's.
2407
If the transport is readonly or None, "." is opened automatically.
2410
if type(shape) not in (list, tuple):
2411
raise AssertionError("Parameter 'shape' should be "
2412
"a list or a tuple. Got %r instead" % (shape,))
2413
# It's OK to just create them using forward slashes on windows.
2414
if transport is None or transport.is_readonly():
2415
transport = get_transport(".")
2417
self.assertIsInstance(name, basestring)
2419
transport.mkdir(urlutils.escape(name[:-1]))
2421
if line_endings == 'binary':
2423
elif line_endings == 'native':
2426
raise errors.BzrError(
2427
'Invalid line ending request %r' % line_endings)
2428
content = "contents of %s%s" % (name.encode('utf-8'), end)
2429
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2431
def build_tree_contents(self, shape):
2432
build_tree_contents(shape)
2434
def assertInWorkingTree(self, path, root_path='.', tree=None):
2435
"""Assert whether path or paths are in the WorkingTree"""
2437
tree = workingtree.WorkingTree.open(root_path)
2438
if not isinstance(path, basestring):
2440
self.assertInWorkingTree(p, tree=tree)
2442
self.assertIsNot(tree.path2id(path), None,
2443
path+' not in working tree.')
2445
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2446
"""Assert whether path or paths are not in the WorkingTree"""
2448
tree = workingtree.WorkingTree.open(root_path)
2449
if not isinstance(path, basestring):
2451
self.assertNotInWorkingTree(p,tree=tree)
2453
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2456
class TestCaseWithTransport(TestCaseInTempDir):
2457
"""A test case that provides get_url and get_readonly_url facilities.
2459
These back onto two transport servers, one for readonly access and one for
2462
If no explicit class is provided for readonly access, a
2463
ReadonlyTransportDecorator is used instead which allows the use of non disk
2464
based read write transports.
2466
If an explicit class is provided for readonly access, that server and the
2467
readwrite one must both define get_url() as resolving to os.getcwd().
2470
def get_vfs_only_server(self):
2471
"""See TestCaseWithMemoryTransport.
2473
This is useful for some tests with specific servers that need
2476
if self.__vfs_server is None:
2477
self.__vfs_server = self.vfs_transport_factory()
2478
self.start_server(self.__vfs_server)
2479
return self.__vfs_server
2481
def make_branch_and_tree(self, relpath, format=None):
2482
"""Create a branch on the transport and a tree locally.
2484
If the transport is not a LocalTransport, the Tree can't be created on
2485
the transport. In that case if the vfs_transport_factory is
2486
LocalURLServer the working tree is created in the local
2487
directory backing the transport, and the returned tree's branch and
2488
repository will also be accessed locally. Otherwise a lightweight
2489
checkout is created and returned.
2491
We do this because we can't physically create a tree in the local
2492
path, with a branch reference to the transport_factory url, and
2493
a branch + repository in the vfs_transport, unless the vfs_transport
2494
namespace is distinct from the local disk - the two branch objects
2495
would collide. While we could construct a tree with its branch object
2496
pointing at the transport_factory transport in memory, reopening it
2497
would behaving unexpectedly, and has in the past caused testing bugs
2498
when we tried to do it that way.
2500
:param format: The BzrDirFormat.
2501
:returns: the WorkingTree.
2503
# TODO: always use the local disk path for the working tree,
2504
# this obviously requires a format that supports branch references
2505
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2507
b = self.make_branch(relpath, format=format)
2509
return b.bzrdir.create_workingtree()
2510
except errors.NotLocalUrl:
2511
# We can only make working trees locally at the moment. If the
2512
# transport can't support them, then we keep the non-disk-backed
2513
# branch and create a local checkout.
2514
if self.vfs_transport_factory is LocalURLServer:
2515
# the branch is colocated on disk, we cannot create a checkout.
2516
# hopefully callers will expect this.
2517
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2518
wt = local_controldir.create_workingtree()
2519
if wt.branch._format != b._format:
2521
# Make sure that assigning to wt._branch fixes wt.branch,
2522
# in case the implementation details of workingtree objects
2524
self.assertIs(b, wt.branch)
2527
return b.create_checkout(relpath, lightweight=True)
2529
def assertIsDirectory(self, relpath, transport):
2530
"""Assert that relpath within transport is a directory.
2532
This may not be possible on all transports; in that case it propagates
2533
a TransportNotPossible.
2536
mode = transport.stat(relpath).st_mode
2537
except errors.NoSuchFile:
2538
self.fail("path %s is not a directory; no such file"
2540
if not stat.S_ISDIR(mode):
2541
self.fail("path %s is not a directory; has mode %#o"
2544
def assertTreesEqual(self, left, right):
2545
"""Check that left and right have the same content and properties."""
2546
# we use a tree delta to check for equality of the content, and we
2547
# manually check for equality of other things such as the parents list.
2548
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2549
differences = left.changes_from(right)
2550
self.assertFalse(differences.has_changed(),
2551
"Trees %r and %r are different: %r" % (left, right, differences))
2554
super(TestCaseWithTransport, self).setUp()
2555
self.__vfs_server = None
2558
class ChrootedTestCase(TestCaseWithTransport):
2559
"""A support class that provides readonly urls outside the local namespace.
2561
This is done by checking if self.transport_server is a MemoryServer. if it
2562
is then we are chrooted already, if it is not then an HttpServer is used
2565
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2566
be used without needed to redo it when a different
2567
subclass is in use ?
2571
super(ChrootedTestCase, self).setUp()
2572
if not self.vfs_transport_factory == MemoryServer:
2573
self.transport_readonly_server = HttpServer
2576
def condition_id_re(pattern):
2577
"""Create a condition filter which performs a re check on a test's id.
2579
:param pattern: A regular expression string.
2580
:return: A callable that returns True if the re matches.
2582
filter_re = osutils.re_compile_checked(pattern, 0,
2584
def condition(test):
2586
return filter_re.search(test_id)
2590
def condition_isinstance(klass_or_klass_list):
2591
"""Create a condition filter which returns isinstance(param, klass).
2593
:return: A callable which when called with one parameter obj return the
2594
result of isinstance(obj, klass_or_klass_list).
2597
return isinstance(obj, klass_or_klass_list)
2601
def condition_id_in_list(id_list):
2602
"""Create a condition filter which verify that test's id in a list.
2604
:param id_list: A TestIdList object.
2605
:return: A callable that returns True if the test's id appears in the list.
2607
def condition(test):
2608
return id_list.includes(test.id())
2612
def condition_id_startswith(starts):
2613
"""Create a condition filter verifying that test's id starts with a string.
2615
:param starts: A list of string.
2616
:return: A callable that returns True if the test's id starts with one of
2619
def condition(test):
2620
for start in starts:
2621
if test.id().startswith(start):
2627
def exclude_tests_by_condition(suite, condition):
2628
"""Create a test suite which excludes some tests from suite.
2630
:param suite: The suite to get tests from.
2631
:param condition: A callable whose result evaluates True when called with a
2632
test case which should be excluded from the result.
2633
:return: A suite which contains the tests found in suite that fail
2637
for test in iter_suite_tests(suite):
2638
if not condition(test):
2640
return TestUtil.TestSuite(result)
2643
def filter_suite_by_condition(suite, condition):
2644
"""Create a test suite by filtering another one.
2646
:param suite: The source suite.
2647
:param condition: A callable whose result evaluates True when called with a
2648
test case which should be included in the result.
2649
:return: A suite which contains the tests found in suite that pass
2653
for test in iter_suite_tests(suite):
2656
return TestUtil.TestSuite(result)
2659
def filter_suite_by_re(suite, pattern):
2660
"""Create a test suite by filtering another one.
2662
:param suite: the source suite
2663
:param pattern: pattern that names must match
2664
:returns: the newly created suite
2666
condition = condition_id_re(pattern)
2667
result_suite = filter_suite_by_condition(suite, condition)
2671
def filter_suite_by_id_list(suite, test_id_list):
2672
"""Create a test suite by filtering another one.
2674
:param suite: The source suite.
2675
:param test_id_list: A list of the test ids to keep as strings.
2676
:returns: the newly created suite
2678
condition = condition_id_in_list(test_id_list)
2679
result_suite = filter_suite_by_condition(suite, condition)
2683
def filter_suite_by_id_startswith(suite, start):
2684
"""Create a test suite by filtering another one.
2686
:param suite: The source suite.
2687
:param start: A list of string the test id must start with one of.
2688
:returns: the newly created suite
2690
condition = condition_id_startswith(start)
2691
result_suite = filter_suite_by_condition(suite, condition)
2695
def exclude_tests_by_re(suite, pattern):
2696
"""Create a test suite which excludes some tests from suite.
2698
:param suite: The suite to get tests from.
2699
:param pattern: A regular expression string. Test ids that match this
2700
pattern will be excluded from the result.
2701
:return: A TestSuite that contains all the tests from suite without the
2702
tests that matched pattern. The order of tests is the same as it was in
2705
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2708
def preserve_input(something):
2709
"""A helper for performing test suite transformation chains.
2711
:param something: Anything you want to preserve.
2717
def randomize_suite(suite):
2718
"""Return a new TestSuite with suite's tests in random order.
2720
The tests in the input suite are flattened into a single suite in order to
2721
accomplish this. Any nested TestSuites are removed to provide global
2724
tests = list(iter_suite_tests(suite))
2725
random.shuffle(tests)
2726
return TestUtil.TestSuite(tests)
2729
def split_suite_by_condition(suite, condition):
2730
"""Split a test suite into two by a condition.
2732
:param suite: The suite to split.
2733
:param condition: The condition to match on. Tests that match this
2734
condition are returned in the first test suite, ones that do not match
2735
are in the second suite.
2736
:return: A tuple of two test suites, where the first contains tests from
2737
suite matching the condition, and the second contains the remainder
2738
from suite. The order within each output suite is the same as it was in
2743
for test in iter_suite_tests(suite):
2745
matched.append(test)
2747
did_not_match.append(test)
2748
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2751
def split_suite_by_re(suite, pattern):
2752
"""Split a test suite into two by a regular expression.
2754
:param suite: The suite to split.
2755
:param pattern: A regular expression string. Test ids that match this
2756
pattern will be in the first test suite returned, and the others in the
2757
second test suite returned.
2758
:return: A tuple of two test suites, where the first contains tests from
2759
suite matching pattern, and the second contains the remainder from
2760
suite. The order within each output suite is the same as it was in
2763
return split_suite_by_condition(suite, condition_id_re(pattern))
2766
def run_suite(suite, name='test', verbose=False, pattern=".*",
2767
stop_on_failure=False,
2768
transport=None, lsprof_timed=None, bench_history=None,
2769
matching_tests_first=None,
2772
exclude_pattern=None,
2775
suite_decorators=None,
2777
result_decorators=None,
2779
"""Run a test suite for bzr selftest.
2781
:param runner_class: The class of runner to use. Must support the
2782
constructor arguments passed by run_suite which are more than standard
2784
:return: A boolean indicating success.
2786
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2791
if runner_class is None:
2792
runner_class = TextTestRunner
2795
runner = runner_class(stream=stream,
2797
verbosity=verbosity,
2798
bench_history=bench_history,
2800
result_decorators=result_decorators,
2802
runner.stop_on_failure=stop_on_failure
2803
# built in decorator factories:
2805
random_order(random_seed, runner),
2806
exclude_tests(exclude_pattern),
2808
if matching_tests_first:
2809
decorators.append(tests_first(pattern))
2811
decorators.append(filter_tests(pattern))
2812
if suite_decorators:
2813
decorators.extend(suite_decorators)
2814
# tell the result object how many tests will be running: (except if
2815
# --parallel=fork is being used. Robert said he will provide a better
2816
# progress design later -- vila 20090817)
2817
if fork_decorator not in decorators:
2818
decorators.append(CountingDecorator)
2819
for decorator in decorators:
2820
suite = decorator(suite)
2822
# Done after test suite decoration to allow randomisation etc
2823
# to take effect, though that is of marginal benefit.
2825
stream.write("Listing tests only ...\n")
2826
for t in iter_suite_tests(suite):
2827
stream.write("%s\n" % (t.id()))
2829
result = runner.run(suite)
2831
return result.wasStrictlySuccessful()
2833
return result.wasSuccessful()
2836
# A registry where get() returns a suite decorator.
2837
parallel_registry = registry.Registry()
2840
def fork_decorator(suite):
2841
concurrency = osutils.local_concurrency()
2842
if concurrency == 1:
2844
from testtools import ConcurrentTestSuite
2845
return ConcurrentTestSuite(suite, fork_for_tests)
2846
parallel_registry.register('fork', fork_decorator)
2849
def subprocess_decorator(suite):
2850
concurrency = osutils.local_concurrency()
2851
if concurrency == 1:
2853
from testtools import ConcurrentTestSuite
2854
return ConcurrentTestSuite(suite, reinvoke_for_tests)
2855
parallel_registry.register('subprocess', subprocess_decorator)
2858
def exclude_tests(exclude_pattern):
2859
"""Return a test suite decorator that excludes tests."""
2860
if exclude_pattern is None:
2861
return identity_decorator
2862
def decorator(suite):
2863
return ExcludeDecorator(suite, exclude_pattern)
2867
def filter_tests(pattern):
2869
return identity_decorator
2870
def decorator(suite):
2871
return FilterTestsDecorator(suite, pattern)
2875
def random_order(random_seed, runner):
2876
"""Return a test suite decorator factory for randomising tests order.
2878
:param random_seed: now, a string which casts to a long, or a long.
2879
:param runner: A test runner with a stream attribute to report on.
2881
if random_seed is None:
2882
return identity_decorator
2883
def decorator(suite):
2884
return RandomDecorator(suite, random_seed, runner.stream)
2888
def tests_first(pattern):
2890
return identity_decorator
2891
def decorator(suite):
2892
return TestFirstDecorator(suite, pattern)
2896
def identity_decorator(suite):
2901
class TestDecorator(TestSuite):
2902
"""A decorator for TestCase/TestSuite objects.
2904
Usually, subclasses should override __iter__(used when flattening test
2905
suites), which we do to filter, reorder, parallelise and so on, run() and
2909
def __init__(self, suite):
2910
TestSuite.__init__(self)
2913
def countTestCases(self):
2916
cases += test.countTestCases()
2923
def run(self, result):
2924
# Use iteration on self, not self._tests, to allow subclasses to hook
2927
if result.shouldStop:
2933
class CountingDecorator(TestDecorator):
2934
"""A decorator which calls result.progress(self.countTestCases)."""
2936
def run(self, result):
2937
progress_method = getattr(result, 'progress', None)
2938
if callable(progress_method):
2939
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
2940
return super(CountingDecorator, self).run(result)
2943
class ExcludeDecorator(TestDecorator):
2944
"""A decorator which excludes test matching an exclude pattern."""
2946
def __init__(self, suite, exclude_pattern):
2947
TestDecorator.__init__(self, suite)
2948
self.exclude_pattern = exclude_pattern
2949
self.excluded = False
2953
return iter(self._tests)
2954
self.excluded = True
2955
suite = exclude_tests_by_re(self, self.exclude_pattern)
2957
self.addTests(suite)
2958
return iter(self._tests)
2961
class FilterTestsDecorator(TestDecorator):
2962
"""A decorator which filters tests to those matching a pattern."""
2964
def __init__(self, suite, pattern):
2965
TestDecorator.__init__(self, suite)
2966
self.pattern = pattern
2967
self.filtered = False
2971
return iter(self._tests)
2972
self.filtered = True
2973
suite = filter_suite_by_re(self, self.pattern)
2975
self.addTests(suite)
2976
return iter(self._tests)
2979
class RandomDecorator(TestDecorator):
2980
"""A decorator which randomises the order of its tests."""
2982
def __init__(self, suite, random_seed, stream):
2983
TestDecorator.__init__(self, suite)
2984
self.random_seed = random_seed
2985
self.randomised = False
2986
self.stream = stream
2990
return iter(self._tests)
2991
self.randomised = True
2992
self.stream.writeln("Randomizing test order using seed %s\n" %
2993
(self.actual_seed()))
2994
# Initialise the random number generator.
2995
random.seed(self.actual_seed())
2996
suite = randomize_suite(self)
2998
self.addTests(suite)
2999
return iter(self._tests)
3001
def actual_seed(self):
3002
if self.random_seed == "now":
3003
# We convert the seed to a long to make it reuseable across
3004
# invocations (because the user can reenter it).
3005
self.random_seed = long(time.time())
3007
# Convert the seed to a long if we can
3009
self.random_seed = long(self.random_seed)
3012
return self.random_seed
3015
class TestFirstDecorator(TestDecorator):
3016
"""A decorator which moves named tests to the front."""
3018
def __init__(self, suite, pattern):
3019
TestDecorator.__init__(self, suite)
3020
self.pattern = pattern
3021
self.filtered = False
3025
return iter(self._tests)
3026
self.filtered = True
3027
suites = split_suite_by_re(self, self.pattern)
3029
self.addTests(suites)
3030
return iter(self._tests)
3033
def partition_tests(suite, count):
3034
"""Partition suite into count lists of tests."""
3036
tests = list(iter_suite_tests(suite))
3037
tests_per_process = int(math.ceil(float(len(tests)) / count))
3038
for block in range(count):
3039
low_test = block * tests_per_process
3040
high_test = low_test + tests_per_process
3041
process_tests = tests[low_test:high_test]
3042
result.append(process_tests)
3046
def fork_for_tests(suite):
3047
"""Take suite and start up one runner per CPU by forking()
3049
:return: An iterable of TestCase-like objects which can each have
3050
run(result) called on them to feed tests to result.
3052
concurrency = osutils.local_concurrency()
3054
from subunit import TestProtocolClient, ProtocolTestCase
3056
from subunit.test_results import AutoTimingTestResultDecorator
3058
AutoTimingTestResultDecorator = lambda x:x
3059
class TestInOtherProcess(ProtocolTestCase):
3060
# Should be in subunit, I think. RBC.
3061
def __init__(self, stream, pid):
3062
ProtocolTestCase.__init__(self, stream)
3065
def run(self, result):
3067
ProtocolTestCase.run(self, result)
3069
os.waitpid(self.pid, os.WNOHANG)
3071
test_blocks = partition_tests(suite, concurrency)
3072
for process_tests in test_blocks:
3073
process_suite = TestSuite()
3074
process_suite.addTests(process_tests)
3075
c2pread, c2pwrite = os.pipe()
3080
# Leave stderr and stdout open so we can see test noise
3081
# Close stdin so that the child goes away if it decides to
3082
# read from stdin (otherwise its a roulette to see what
3083
# child actually gets keystrokes for pdb etc).
3086
stream = os.fdopen(c2pwrite, 'wb', 1)
3087
subunit_result = AutoTimingTestResultDecorator(
3088
TestProtocolClient(stream))
3089
process_suite.run(subunit_result)
3094
stream = os.fdopen(c2pread, 'rb', 1)
3095
test = TestInOtherProcess(stream, pid)
3100
def reinvoke_for_tests(suite):
3101
"""Take suite and start up one runner per CPU using subprocess().
3103
:return: An iterable of TestCase-like objects which can each have
3104
run(result) called on them to feed tests to result.
3106
concurrency = osutils.local_concurrency()
3108
from subunit import ProtocolTestCase
3109
class TestInSubprocess(ProtocolTestCase):
3110
def __init__(self, process, name):
3111
ProtocolTestCase.__init__(self, process.stdout)
3112
self.process = process
3113
self.process.stdin.close()
3116
def run(self, result):
3118
ProtocolTestCase.run(self, result)
3121
os.unlink(self.name)
3122
# print "pid %d finished" % finished_process
3123
test_blocks = partition_tests(suite, concurrency)
3124
for process_tests in test_blocks:
3125
# ugly; currently reimplement rather than reuses TestCase methods.
3126
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3127
if not os.path.isfile(bzr_path):
3128
# We are probably installed. Assume sys.argv is the right file
3129
bzr_path = sys.argv[0]
3130
fd, test_list_file_name = tempfile.mkstemp()
3131
test_list_file = os.fdopen(fd, 'wb', 1)
3132
for test in process_tests:
3133
test_list_file.write(test.id() + '\n')
3134
test_list_file.close()
3136
argv = [bzr_path, 'selftest', '--load-list', test_list_file_name,
3138
if '--no-plugins' in sys.argv:
3139
argv.append('--no-plugins')
3140
# stderr=STDOUT would be ideal, but until we prevent noise on
3141
# stderr it can interrupt the subunit protocol.
3142
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3144
test = TestInSubprocess(process, test_list_file_name)
3147
os.unlink(test_list_file_name)
3152
class ForwardingResult(unittest.TestResult):
3154
def __init__(self, target):
3155
unittest.TestResult.__init__(self)
3156
self.result = target
3158
def startTest(self, test):
3159
self.result.startTest(test)
3161
def stopTest(self, test):
3162
self.result.stopTest(test)
3164
def startTestRun(self):
3165
self.result.startTestRun()
3167
def stopTestRun(self):
3168
self.result.stopTestRun()
3170
def addSkip(self, test, reason):
3171
self.result.addSkip(test, reason)
3173
def addSuccess(self, test):
3174
self.result.addSuccess(test)
3176
def addError(self, test, err):
3177
self.result.addError(test, err)
3179
def addFailure(self, test, err):
3180
self.result.addFailure(test, err)
3183
class BZRTransformingResult(ForwardingResult):
3185
def addError(self, test, err):
3186
feature = self._error_looks_like('UnavailableFeature: ', err)
3187
if feature is not None:
3188
self.result.addNotSupported(test, feature)
3190
self.result.addError(test, err)
3192
def addFailure(self, test, err):
3193
known = self._error_looks_like('KnownFailure: ', err)
3194
if known is not None:
3195
self.result._addKnownFailure(test, [KnownFailure,
3196
KnownFailure(known), None])
3198
self.result.addFailure(test, err)
3200
def _error_looks_like(self, prefix, err):
3201
"""Deserialize exception and returns the stringify value."""
3205
if isinstance(exc, subunit.RemoteException):
3206
# stringify the exception gives access to the remote traceback
3207
# We search the last line for 'prefix'
3208
lines = str(exc).split('\n')
3209
while lines and not lines[-1]:
3212
if lines[-1].startswith(prefix):
3213
value = lines[-1][len(prefix):]
3217
class ProfileResult(ForwardingResult):
3218
"""Generate profiling data for all activity between start and success.
3220
The profile data is appended to the test's _benchcalls attribute and can
3221
be accessed by the forwarded-to TestResult.
3223
While it might be cleaner do accumulate this in stopTest, addSuccess is
3224
where our existing output support for lsprof is, and this class aims to
3225
fit in with that: while it could be moved it's not necessary to accomplish
3226
test profiling, nor would it be dramatically cleaner.
3229
def startTest(self, test):
3230
self.profiler = bzrlib.lsprof.BzrProfiler()
3231
self.profiler.start()
3232
ForwardingResult.startTest(self, test)
3234
def addSuccess(self, test):
3235
stats = self.profiler.stop()
3237
calls = test._benchcalls
3238
except AttributeError:
3239
test._benchcalls = []
3240
calls = test._benchcalls
3241
calls.append(((test.id(), "", ""), stats))
3242
ForwardingResult.addSuccess(self, test)
3244
def stopTest(self, test):
3245
ForwardingResult.stopTest(self, test)
3246
self.profiler = None
3249
# Controlled by "bzr selftest -E=..." option
3250
# Currently supported:
3251
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3252
# preserves any flags supplied at the command line.
3253
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3254
# rather than failing tests. And no longer raise
3255
# LockContention when fctnl locks are not being used
3256
# with proper exclusion rules.
3257
selftest_debug_flags = set()
3260
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3262
test_suite_factory=None,
3265
matching_tests_first=None,
3268
exclude_pattern=None,
3274
suite_decorators=None,
3278
"""Run the whole test suite under the enhanced runner"""
3279
# XXX: Very ugly way to do this...
3280
# Disable warning about old formats because we don't want it to disturb
3281
# any blackbox tests.
3282
from bzrlib import repository
3283
repository._deprecation_warning_done = True
3285
global default_transport
3286
if transport is None:
3287
transport = default_transport
3288
old_transport = default_transport
3289
default_transport = transport
3290
global selftest_debug_flags
3291
old_debug_flags = selftest_debug_flags
3292
if debug_flags is not None:
3293
selftest_debug_flags = set(debug_flags)
3295
if load_list is None:
3298
keep_only = load_test_id_list(load_list)
3300
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3301
for start in starting_with]
3302
if test_suite_factory is None:
3303
# Reduce loading time by loading modules based on the starting_with
3305
suite = test_suite(keep_only, starting_with)
3307
suite = test_suite_factory()
3309
# But always filter as requested.
3310
suite = filter_suite_by_id_startswith(suite, starting_with)
3311
result_decorators = []
3313
result_decorators.append(ProfileResult)
3314
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3315
stop_on_failure=stop_on_failure,
3316
transport=transport,
3317
lsprof_timed=lsprof_timed,
3318
bench_history=bench_history,
3319
matching_tests_first=matching_tests_first,
3320
list_only=list_only,
3321
random_seed=random_seed,
3322
exclude_pattern=exclude_pattern,
3324
runner_class=runner_class,
3325
suite_decorators=suite_decorators,
3327
result_decorators=result_decorators,
3330
default_transport = old_transport
3331
selftest_debug_flags = old_debug_flags
3334
def load_test_id_list(file_name):
3335
"""Load a test id list from a text file.
3337
The format is one test id by line. No special care is taken to impose
3338
strict rules, these test ids are used to filter the test suite so a test id
3339
that do not match an existing test will do no harm. This allows user to add
3340
comments, leave blank lines, etc.
3344
ftest = open(file_name, 'rt')
3346
if e.errno != errno.ENOENT:
3349
raise errors.NoSuchFile(file_name)
3351
for test_name in ftest.readlines():
3352
test_list.append(test_name.strip())
3357
def suite_matches_id_list(test_suite, id_list):
3358
"""Warns about tests not appearing or appearing more than once.
3360
:param test_suite: A TestSuite object.
3361
:param test_id_list: The list of test ids that should be found in
3364
:return: (absents, duplicates) absents is a list containing the test found
3365
in id_list but not in test_suite, duplicates is a list containing the
3366
test found multiple times in test_suite.
3368
When using a prefined test id list, it may occurs that some tests do not
3369
exist anymore or that some tests use the same id. This function warns the
3370
tester about potential problems in his workflow (test lists are volatile)
3371
or in the test suite itself (using the same id for several tests does not
3372
help to localize defects).
3374
# Build a dict counting id occurrences
3376
for test in iter_suite_tests(test_suite):
3378
tests[id] = tests.get(id, 0) + 1
3383
occurs = tests.get(id, 0)
3385
not_found.append(id)
3387
duplicates.append(id)
3389
return not_found, duplicates
3392
class TestIdList(object):
3393
"""Test id list to filter a test suite.
3395
Relying on the assumption that test ids are built as:
3396
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3397
notation, this class offers methods to :
3398
- avoid building a test suite for modules not refered to in the test list,
3399
- keep only the tests listed from the module test suite.
3402
def __init__(self, test_id_list):
3403
# When a test suite needs to be filtered against us we compare test ids
3404
# for equality, so a simple dict offers a quick and simple solution.
3405
self.tests = dict().fromkeys(test_id_list, True)
3407
# While unittest.TestCase have ids like:
3408
# <module>.<class>.<method>[(<param+)],
3409
# doctest.DocTestCase can have ids like:
3412
# <module>.<function>
3413
# <module>.<class>.<method>
3415
# Since we can't predict a test class from its name only, we settle on
3416
# a simple constraint: a test id always begins with its module name.
3419
for test_id in test_id_list:
3420
parts = test_id.split('.')
3421
mod_name = parts.pop(0)
3422
modules[mod_name] = True
3424
mod_name += '.' + part
3425
modules[mod_name] = True
3426
self.modules = modules
3428
def refers_to(self, module_name):
3429
"""Is there tests for the module or one of its sub modules."""
3430
return self.modules.has_key(module_name)
3432
def includes(self, test_id):
3433
return self.tests.has_key(test_id)
3436
class TestPrefixAliasRegistry(registry.Registry):
3437
"""A registry for test prefix aliases.
3439
This helps implement shorcuts for the --starting-with selftest
3440
option. Overriding existing prefixes is not allowed but not fatal (a
3441
warning will be emitted).
3444
def register(self, key, obj, help=None, info=None,
3445
override_existing=False):
3446
"""See Registry.register.
3448
Trying to override an existing alias causes a warning to be emitted,
3449
not a fatal execption.
3452
super(TestPrefixAliasRegistry, self).register(
3453
key, obj, help=help, info=info, override_existing=False)
3455
actual = self.get(key)
3456
note('Test prefix alias %s is already used for %s, ignoring %s'
3457
% (key, actual, obj))
3459
def resolve_alias(self, id_start):
3460
"""Replace the alias by the prefix in the given string.
3462
Using an unknown prefix is an error to help catching typos.
3464
parts = id_start.split('.')
3466
parts[0] = self.get(parts[0])
3468
raise errors.BzrCommandError(
3469
'%s is not a known test prefix alias' % parts[0])
3470
return '.'.join(parts)
3473
test_prefix_alias_registry = TestPrefixAliasRegistry()
3474
"""Registry of test prefix aliases."""
3477
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3478
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3479
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3481
# Obvious higest levels prefixes, feel free to add your own via a plugin
3482
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3483
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3484
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3485
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3486
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3489
def _test_suite_testmod_names():
3490
"""Return the standard list of test module names to test."""
3493
'bzrlib.tests.blackbox',
3494
'bzrlib.tests.commands',
3495
'bzrlib.tests.per_branch',
3496
'bzrlib.tests.per_bzrdir',
3497
'bzrlib.tests.per_interrepository',
3498
'bzrlib.tests.per_intertree',
3499
'bzrlib.tests.per_inventory',
3500
'bzrlib.tests.per_interbranch',
3501
'bzrlib.tests.per_lock',
3502
'bzrlib.tests.per_transport',
3503
'bzrlib.tests.per_tree',
3504
'bzrlib.tests.per_pack_repository',
3505
'bzrlib.tests.per_repository',
3506
'bzrlib.tests.per_repository_chk',
3507
'bzrlib.tests.per_repository_reference',
3508
'bzrlib.tests.per_versionedfile',
3509
'bzrlib.tests.per_workingtree',
3510
'bzrlib.tests.test__annotator',
3511
'bzrlib.tests.test__chk_map',
3512
'bzrlib.tests.test__dirstate_helpers',
3513
'bzrlib.tests.test__groupcompress',
3514
'bzrlib.tests.test__known_graph',
3515
'bzrlib.tests.test__rio',
3516
'bzrlib.tests.test__walkdirs_win32',
3517
'bzrlib.tests.test_ancestry',
3518
'bzrlib.tests.test_annotate',
3519
'bzrlib.tests.test_api',
3520
'bzrlib.tests.test_atomicfile',
3521
'bzrlib.tests.test_bad_files',
3522
'bzrlib.tests.test_bencode',
3523
'bzrlib.tests.test_bisect_multi',
3524
'bzrlib.tests.test_branch',
3525
'bzrlib.tests.test_branchbuilder',
3526
'bzrlib.tests.test_btree_index',
3527
'bzrlib.tests.test_bugtracker',
3528
'bzrlib.tests.test_bundle',
3529
'bzrlib.tests.test_bzrdir',
3530
'bzrlib.tests.test__chunks_to_lines',
3531
'bzrlib.tests.test_cache_utf8',
3532
'bzrlib.tests.test_chk_map',
3533
'bzrlib.tests.test_chk_serializer',
3534
'bzrlib.tests.test_chunk_writer',
3535
'bzrlib.tests.test_clean_tree',
3536
'bzrlib.tests.test_commands',
3537
'bzrlib.tests.test_commit',
3538
'bzrlib.tests.test_commit_merge',
3539
'bzrlib.tests.test_config',
3540
'bzrlib.tests.test_conflicts',
3541
'bzrlib.tests.test_counted_lock',
3542
'bzrlib.tests.test_crash',
3543
'bzrlib.tests.test_decorators',
3544
'bzrlib.tests.test_delta',
3545
'bzrlib.tests.test_debug',
3546
'bzrlib.tests.test_deprecated_graph',
3547
'bzrlib.tests.test_diff',
3548
'bzrlib.tests.test_directory_service',
3549
'bzrlib.tests.test_dirstate',
3550
'bzrlib.tests.test_email_message',
3551
'bzrlib.tests.test_eol_filters',
3552
'bzrlib.tests.test_errors',
3553
'bzrlib.tests.test_export',
3554
'bzrlib.tests.test_extract',
3555
'bzrlib.tests.test_fetch',
3556
'bzrlib.tests.test_fifo_cache',
3557
'bzrlib.tests.test_filters',
3558
'bzrlib.tests.test_ftp_transport',
3559
'bzrlib.tests.test_foreign',
3560
'bzrlib.tests.test_generate_docs',
3561
'bzrlib.tests.test_generate_ids',
3562
'bzrlib.tests.test_globbing',
3563
'bzrlib.tests.test_gpg',
3564
'bzrlib.tests.test_graph',
3565
'bzrlib.tests.test_groupcompress',
3566
'bzrlib.tests.test_hashcache',
3567
'bzrlib.tests.test_help',
3568
'bzrlib.tests.test_hooks',
3569
'bzrlib.tests.test_http',
3570
'bzrlib.tests.test_http_response',
3571
'bzrlib.tests.test_https_ca_bundle',
3572
'bzrlib.tests.test_identitymap',
3573
'bzrlib.tests.test_ignores',
3574
'bzrlib.tests.test_index',
3575
'bzrlib.tests.test_info',
3576
'bzrlib.tests.test_inv',
3577
'bzrlib.tests.test_inventory_delta',
3578
'bzrlib.tests.test_knit',
3579
'bzrlib.tests.test_lazy_import',
3580
'bzrlib.tests.test_lazy_regex',
3581
'bzrlib.tests.test_lock',
3582
'bzrlib.tests.test_lockable_files',
3583
'bzrlib.tests.test_lockdir',
3584
'bzrlib.tests.test_log',
3585
'bzrlib.tests.test_lru_cache',
3586
'bzrlib.tests.test_lsprof',
3587
'bzrlib.tests.test_mail_client',
3588
'bzrlib.tests.test_memorytree',
3589
'bzrlib.tests.test_merge',
3590
'bzrlib.tests.test_merge3',
3591
'bzrlib.tests.test_merge_core',
3592
'bzrlib.tests.test_merge_directive',
3593
'bzrlib.tests.test_missing',
3594
'bzrlib.tests.test_msgeditor',
3595
'bzrlib.tests.test_multiparent',
3596
'bzrlib.tests.test_mutabletree',
3597
'bzrlib.tests.test_nonascii',
3598
'bzrlib.tests.test_options',
3599
'bzrlib.tests.test_osutils',
3600
'bzrlib.tests.test_osutils_encodings',
3601
'bzrlib.tests.test_pack',
3602
'bzrlib.tests.test_patch',
3603
'bzrlib.tests.test_patches',
3604
'bzrlib.tests.test_permissions',
3605
'bzrlib.tests.test_plugins',
3606
'bzrlib.tests.test_progress',
3607
'bzrlib.tests.test_read_bundle',
3608
'bzrlib.tests.test_reconcile',
3609
'bzrlib.tests.test_reconfigure',
3610
'bzrlib.tests.test_registry',
3611
'bzrlib.tests.test_remote',
3612
'bzrlib.tests.test_rename_map',
3613
'bzrlib.tests.test_repository',
3614
'bzrlib.tests.test_revert',
3615
'bzrlib.tests.test_revision',
3616
'bzrlib.tests.test_revisionspec',
3617
'bzrlib.tests.test_revisiontree',
3618
'bzrlib.tests.test_rio',
3619
'bzrlib.tests.test_rules',
3620
'bzrlib.tests.test_sampler',
3621
'bzrlib.tests.test_selftest',
3622
'bzrlib.tests.test_serializer',
3623
'bzrlib.tests.test_setup',
3624
'bzrlib.tests.test_sftp_transport',
3625
'bzrlib.tests.test_shelf',
3626
'bzrlib.tests.test_shelf_ui',
3627
'bzrlib.tests.test_smart',
3628
'bzrlib.tests.test_smart_add',
3629
'bzrlib.tests.test_smart_request',
3630
'bzrlib.tests.test_smart_transport',
3631
'bzrlib.tests.test_smtp_connection',
3632
'bzrlib.tests.test_source',
3633
'bzrlib.tests.test_ssh_transport',
3634
'bzrlib.tests.test_status',
3635
'bzrlib.tests.test_store',
3636
'bzrlib.tests.test_strace',
3637
'bzrlib.tests.test_subsume',
3638
'bzrlib.tests.test_switch',
3639
'bzrlib.tests.test_symbol_versioning',
3640
'bzrlib.tests.test_tag',
3641
'bzrlib.tests.test_testament',
3642
'bzrlib.tests.test_textfile',
3643
'bzrlib.tests.test_textmerge',
3644
'bzrlib.tests.test_timestamp',
3645
'bzrlib.tests.test_trace',
3646
'bzrlib.tests.test_transactions',
3647
'bzrlib.tests.test_transform',
3648
'bzrlib.tests.test_transport',
3649
'bzrlib.tests.test_transport_log',
3650
'bzrlib.tests.test_tree',
3651
'bzrlib.tests.test_treebuilder',
3652
'bzrlib.tests.test_tsort',
3653
'bzrlib.tests.test_tuned_gzip',
3654
'bzrlib.tests.test_ui',
3655
'bzrlib.tests.test_uncommit',
3656
'bzrlib.tests.test_upgrade',
3657
'bzrlib.tests.test_upgrade_stacked',
3658
'bzrlib.tests.test_urlutils',
3659
'bzrlib.tests.test_version',
3660
'bzrlib.tests.test_version_info',
3661
'bzrlib.tests.test_weave',
3662
'bzrlib.tests.test_whitebox',
3663
'bzrlib.tests.test_win32utils',
3664
'bzrlib.tests.test_workingtree',
3665
'bzrlib.tests.test_workingtree_4',
3666
'bzrlib.tests.test_wsgi',
3667
'bzrlib.tests.test_xml',
3671
def _test_suite_modules_to_doctest():
3672
"""Return the list of modules to doctest."""
3675
'bzrlib.branchbuilder',
3678
'bzrlib.iterablefile',
3682
'bzrlib.symbol_versioning',
3685
'bzrlib.version_info_formats.format_custom',
3689
def test_suite(keep_only=None, starting_with=None):
3690
"""Build and return TestSuite for the whole of bzrlib.
3692
:param keep_only: A list of test ids limiting the suite returned.
3694
:param starting_with: An id limiting the suite returned to the tests
3697
This function can be replaced if you need to change the default test
3698
suite on a global basis, but it is not encouraged.
3701
loader = TestUtil.TestLoader()
3703
if keep_only is not None:
3704
id_filter = TestIdList(keep_only)
3706
# We take precedence over keep_only because *at loading time* using
3707
# both options means we will load less tests for the same final result.
3708
def interesting_module(name):
3709
for start in starting_with:
3711
# Either the module name starts with the specified string
3712
name.startswith(start)
3713
# or it may contain tests starting with the specified string
3714
or start.startswith(name)
3718
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3720
elif keep_only is not None:
3721
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3722
def interesting_module(name):
3723
return id_filter.refers_to(name)
3726
loader = TestUtil.TestLoader()
3727
def interesting_module(name):
3728
# No filtering, all modules are interesting
3731
suite = loader.suiteClass()
3733
# modules building their suite with loadTestsFromModuleNames
3734
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3736
for mod in _test_suite_modules_to_doctest():
3737
if not interesting_module(mod):
3738
# No tests to keep here, move along
3741
# note that this really does mean "report only" -- doctest
3742
# still runs the rest of the examples
3743
doc_suite = doctest.DocTestSuite(mod,
3744
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3745
except ValueError, e:
3746
print '**failed to get doctest for: %s\n%s' % (mod, e)
3748
if len(doc_suite._tests) == 0:
3749
raise errors.BzrError("no doctests found in %s" % (mod,))
3750
suite.addTest(doc_suite)
3752
default_encoding = sys.getdefaultencoding()
3753
for name, plugin in bzrlib.plugin.plugins().items():
3754
if not interesting_module(plugin.module.__name__):
3756
plugin_suite = plugin.test_suite()
3757
# We used to catch ImportError here and turn it into just a warning,
3758
# but really if you don't have --no-plugins this should be a failure.
3759
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3760
if plugin_suite is None:
3761
plugin_suite = plugin.load_plugin_tests(loader)
3762
if plugin_suite is not None:
3763
suite.addTest(plugin_suite)
3764
if default_encoding != sys.getdefaultencoding():
3765
bzrlib.trace.warning(
3766
'Plugin "%s" tried to reset default encoding to: %s', name,
3767
sys.getdefaultencoding())
3769
sys.setdefaultencoding(default_encoding)
3771
if keep_only is not None:
3772
# Now that the referred modules have loaded their tests, keep only the
3774
suite = filter_suite_by_id_list(suite, id_filter)
3775
# Do some sanity checks on the id_list filtering
3776
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3778
# The tester has used both keep_only and starting_with, so he is
3779
# already aware that some tests are excluded from the list, there
3780
# is no need to tell him which.
3783
# Some tests mentioned in the list are not in the test suite. The
3784
# list may be out of date, report to the tester.
3785
for id in not_found:
3786
bzrlib.trace.warning('"%s" not found in the test suite', id)
3787
for id in duplicates:
3788
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3793
def multiply_scenarios(scenarios_left, scenarios_right):
3794
"""Multiply two sets of scenarios.
3796
:returns: the cartesian product of the two sets of scenarios, that is
3797
a scenario for every possible combination of a left scenario and a
3801
('%s,%s' % (left_name, right_name),
3802
dict(left_dict.items() + right_dict.items()))
3803
for left_name, left_dict in scenarios_left
3804
for right_name, right_dict in scenarios_right]
3807
def multiply_tests(tests, scenarios, result):
3808
"""Multiply tests_list by scenarios into result.
3810
This is the core workhorse for test parameterisation.
3812
Typically the load_tests() method for a per-implementation test suite will
3813
call multiply_tests and return the result.
3815
:param tests: The tests to parameterise.
3816
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3817
scenario_param_dict).
3818
:param result: A TestSuite to add created tests to.
3820
This returns the passed in result TestSuite with the cross product of all
3821
the tests repeated once for each scenario. Each test is adapted by adding
3822
the scenario name at the end of its id(), and updating the test object's
3823
__dict__ with the scenario_param_dict.
3825
>>> import bzrlib.tests.test_sampler
3826
>>> r = multiply_tests(
3827
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3828
... [('one', dict(param=1)),
3829
... ('two', dict(param=2))],
3831
>>> tests = list(iter_suite_tests(r))
3835
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3841
for test in iter_suite_tests(tests):
3842
apply_scenarios(test, scenarios, result)
3846
def apply_scenarios(test, scenarios, result):
3847
"""Apply the scenarios in scenarios to test and add to result.
3849
:param test: The test to apply scenarios to.
3850
:param scenarios: An iterable of scenarios to apply to test.
3852
:seealso: apply_scenario
3854
for scenario in scenarios:
3855
result.addTest(apply_scenario(test, scenario))
3859
def apply_scenario(test, scenario):
3860
"""Copy test and apply scenario to it.
3862
:param test: A test to adapt.
3863
:param scenario: A tuple describing the scenarion.
3864
The first element of the tuple is the new test id.
3865
The second element is a dict containing attributes to set on the
3867
:return: The adapted test.
3869
new_id = "%s(%s)" % (test.id(), scenario[0])
3870
new_test = clone_test(test, new_id)
3871
for name, value in scenario[1].items():
3872
setattr(new_test, name, value)
3876
def clone_test(test, new_id):
3877
"""Clone a test giving it a new id.
3879
:param test: The test to clone.
3880
:param new_id: The id to assign to it.
3881
:return: The new test.
3883
new_test = copy(test)
3884
new_test.id = lambda: new_id
3888
def _rmtree_temp_dir(dirname):
3889
# If LANG=C we probably have created some bogus paths
3890
# which rmtree(unicode) will fail to delete
3891
# so make sure we are using rmtree(str) to delete everything
3892
# except on win32, where rmtree(str) will fail
3893
# since it doesn't have the property of byte-stream paths
3894
# (they are either ascii or mbcs)
3895
if sys.platform == 'win32':
3896
# make sure we are using the unicode win32 api
3897
dirname = unicode(dirname)
3899
dirname = dirname.encode(sys.getfilesystemencoding())
3901
osutils.rmtree(dirname)
3903
# We don't want to fail here because some useful display will be lost
3904
# otherwise. Polluting the tmp dir is bad, but not giving all the
3905
# possible info to the test runner is even worse.
3906
sys.stderr.write('Unable to remove testing dir %s\n%s'
3907
% (os.path.basename(dirname), e))
3910
class Feature(object):
3911
"""An operating system Feature."""
3914
self._available = None
3916
def available(self):
3917
"""Is the feature available?
3919
:return: True if the feature is available.
3921
if self._available is None:
3922
self._available = self._probe()
3923
return self._available
3926
"""Implement this method in concrete features.
3928
:return: True if the feature is available.
3930
raise NotImplementedError
3933
if getattr(self, 'feature_name', None):
3934
return self.feature_name()
3935
return self.__class__.__name__
3938
class _SymlinkFeature(Feature):
3941
return osutils.has_symlinks()
3943
def feature_name(self):
3946
SymlinkFeature = _SymlinkFeature()
3949
class _HardlinkFeature(Feature):
3952
return osutils.has_hardlinks()
3954
def feature_name(self):
3957
HardlinkFeature = _HardlinkFeature()
3960
class _OsFifoFeature(Feature):
3963
return getattr(os, 'mkfifo', None)
3965
def feature_name(self):
3966
return 'filesystem fifos'
3968
OsFifoFeature = _OsFifoFeature()
3971
class _UnicodeFilenameFeature(Feature):
3972
"""Does the filesystem support Unicode filenames?"""
3976
# Check for character combinations unlikely to be covered by any
3977
# single non-unicode encoding. We use the characters
3978
# - greek small letter alpha (U+03B1) and
3979
# - braille pattern dots-123456 (U+283F).
3980
os.stat(u'\u03b1\u283f')
3981
except UnicodeEncodeError:
3983
except (IOError, OSError):
3984
# The filesystem allows the Unicode filename but the file doesn't
3988
# The filesystem allows the Unicode filename and the file exists,
3992
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3995
def probe_unicode_in_user_encoding():
3996
"""Try to encode several unicode strings to use in unicode-aware tests.
3997
Return first successfull match.
3999
:return: (unicode value, encoded plain string value) or (None, None)
4001
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4002
for uni_val in possible_vals:
4004
str_val = uni_val.encode(osutils.get_user_encoding())
4005
except UnicodeEncodeError:
4006
# Try a different character
4009
return uni_val, str_val
4013
def probe_bad_non_ascii(encoding):
4014
"""Try to find [bad] character with code [128..255]
4015
that cannot be decoded to unicode in some encoding.
4016
Return None if all non-ascii characters is valid
4019
for i in xrange(128, 256):
4022
char.decode(encoding)
4023
except UnicodeDecodeError:
4028
class _HTTPSServerFeature(Feature):
4029
"""Some tests want an https Server, check if one is available.
4031
Right now, the only way this is available is under python2.6 which provides
4042
def feature_name(self):
4043
return 'HTTPSServer'
4046
HTTPSServerFeature = _HTTPSServerFeature()
4049
class _UnicodeFilename(Feature):
4050
"""Does the filesystem support Unicode filenames?"""
4055
except UnicodeEncodeError:
4057
except (IOError, OSError):
4058
# The filesystem allows the Unicode filename but the file doesn't
4062
# The filesystem allows the Unicode filename and the file exists,
4066
UnicodeFilename = _UnicodeFilename()
4069
class _UTF8Filesystem(Feature):
4070
"""Is the filesystem UTF-8?"""
4073
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4077
UTF8Filesystem = _UTF8Filesystem()
4080
class _CaseInsCasePresFilenameFeature(Feature):
4081
"""Is the file-system case insensitive, but case-preserving?"""
4084
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4086
# first check truly case-preserving for created files, then check
4087
# case insensitive when opening existing files.
4088
name = osutils.normpath(name)
4089
base, rel = osutils.split(name)
4090
found_rel = osutils.canonical_relpath(base, name)
4091
return (found_rel == rel
4092
and os.path.isfile(name.upper())
4093
and os.path.isfile(name.lower()))
4098
def feature_name(self):
4099
return "case-insensitive case-preserving filesystem"
4101
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4104
class _CaseInsensitiveFilesystemFeature(Feature):
4105
"""Check if underlying filesystem is case-insensitive but *not* case
4108
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4109
# more likely to be case preserving, so this case is rare.
4112
if CaseInsCasePresFilenameFeature.available():
4115
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4116
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4117
TestCaseWithMemoryTransport.TEST_ROOT = root
4119
root = TestCaseWithMemoryTransport.TEST_ROOT
4120
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4122
name_a = osutils.pathjoin(tdir, 'a')
4123
name_A = osutils.pathjoin(tdir, 'A')
4125
result = osutils.isdir(name_A)
4126
_rmtree_temp_dir(tdir)
4129
def feature_name(self):
4130
return 'case-insensitive filesystem'
4132
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4135
class _SubUnitFeature(Feature):
4136
"""Check if subunit is available."""
4145
def feature_name(self):
4148
SubUnitFeature = _SubUnitFeature()
4149
# Only define SubUnitBzrRunner if subunit is available.
4151
from subunit import TestProtocolClient
4153
from subunit.test_results import AutoTimingTestResultDecorator
4155
AutoTimingTestResultDecorator = lambda x:x
4156
class SubUnitBzrRunner(TextTestRunner):
4157
def run(self, test):
4158
result = AutoTimingTestResultDecorator(
4159
TestProtocolClient(self.stream))
added
removed
bzrlib/tests/__init__.py
