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 _ndiff_strings(self, a, b):
932
"""Return ndiff between two strings containing lines.
934
A trailing newline is added if missing to make the strings
936
if b and b[-1] != '\n':
938
if a and a[-1] != '\n':
940
difflines = difflib.ndiff(a.splitlines(True),
942
linejunk=lambda x: False,
943
charjunk=lambda x: False)
944
return ''.join(difflines)
946
def assertEqual(self, a, b, message=''):
950
except UnicodeError, e:
951
# If we can't compare without getting a UnicodeError, then
952
# obviously they are different
953
mutter('UnicodeError: %s', e)
956
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
958
pformat(a), pformat(b)))
960
assertEquals = assertEqual
962
def assertEqualDiff(self, a, b, message=None):
963
"""Assert two texts are equal, if not raise an exception.
965
This is intended for use with multi-line strings where it can
966
be hard to find the differences by eye.
968
# TODO: perhaps override assertEquals to call this for strings?
972
message = "texts not equal:\n"
974
message = 'first string is missing a final newline.\n'
976
message = 'second string is missing a final newline.\n'
977
raise AssertionError(message +
978
self._ndiff_strings(a, b))
980
def assertEqualMode(self, mode, mode_test):
981
self.assertEqual(mode, mode_test,
982
'mode mismatch %o != %o' % (mode, mode_test))
984
def assertEqualStat(self, expected, actual):
985
"""assert that expected and actual are the same stat result.
987
:param expected: A stat result.
988
:param actual: A stat result.
989
:raises AssertionError: If the expected and actual stat values differ
992
self.assertEqual(expected.st_size, actual.st_size)
993
self.assertEqual(expected.st_mtime, actual.st_mtime)
994
self.assertEqual(expected.st_ctime, actual.st_ctime)
995
self.assertEqual(expected.st_dev, actual.st_dev)
996
self.assertEqual(expected.st_ino, actual.st_ino)
997
self.assertEqual(expected.st_mode, actual.st_mode)
999
def assertLength(self, length, obj_with_len):
1000
"""Assert that obj_with_len is of length length."""
1001
if len(obj_with_len) != length:
1002
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1003
length, len(obj_with_len), obj_with_len))
1005
def assertPositive(self, val):
1006
"""Assert that val is greater than 0."""
1007
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1009
def assertNegative(self, val):
1010
"""Assert that val is less than 0."""
1011
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1013
def assertStartsWith(self, s, prefix):
1014
if not s.startswith(prefix):
1015
raise AssertionError('string %r does not start with %r' % (s, prefix))
1017
def assertEndsWith(self, s, suffix):
1018
"""Asserts that s ends with suffix."""
1019
if not s.endswith(suffix):
1020
raise AssertionError('string %r does not end with %r' % (s, suffix))
1022
def assertContainsRe(self, haystack, needle_re, flags=0):
1023
"""Assert that a contains something matching a regular expression."""
1024
if not re.search(needle_re, haystack, flags):
1025
if '\n' in haystack or len(haystack) > 60:
1026
# a long string, format it in a more readable way
1027
raise AssertionError(
1028
'pattern "%s" not found in\n"""\\\n%s"""\n'
1029
% (needle_re, haystack))
1031
raise AssertionError('pattern "%s" not found in "%s"'
1032
% (needle_re, haystack))
1034
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1035
"""Assert that a does not match a regular expression"""
1036
if re.search(needle_re, haystack, flags):
1037
raise AssertionError('pattern "%s" found in "%s"'
1038
% (needle_re, haystack))
1040
def assertSubset(self, sublist, superlist):
1041
"""Assert that every entry in sublist is present in superlist."""
1042
missing = set(sublist) - set(superlist)
1043
if len(missing) > 0:
1044
raise AssertionError("value(s) %r not present in container %r" %
1045
(missing, superlist))
1047
def assertListRaises(self, excClass, func, *args, **kwargs):
1048
"""Fail unless excClass is raised when the iterator from func is used.
1050
Many functions can return generators this makes sure
1051
to wrap them in a list() call to make sure the whole generator
1052
is run, and that the proper exception is raised.
1055
list(func(*args, **kwargs))
1059
if getattr(excClass,'__name__', None) is not None:
1060
excName = excClass.__name__
1062
excName = str(excClass)
1063
raise self.failureException, "%s not raised" % excName
1065
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1066
"""Assert that a callable raises a particular exception.
1068
:param excClass: As for the except statement, this may be either an
1069
exception class, or a tuple of classes.
1070
:param callableObj: A callable, will be passed ``*args`` and
1073
Returns the exception so that you can examine it.
1076
callableObj(*args, **kwargs)
1080
if getattr(excClass,'__name__', None) is not None:
1081
excName = excClass.__name__
1084
excName = str(excClass)
1085
raise self.failureException, "%s not raised" % excName
1087
def assertIs(self, left, right, message=None):
1088
if not (left is right):
1089
if message is not None:
1090
raise AssertionError(message)
1092
raise AssertionError("%r is not %r." % (left, right))
1094
def assertIsNot(self, left, right, message=None):
1096
if message is not None:
1097
raise AssertionError(message)
1099
raise AssertionError("%r is %r." % (left, right))
1101
def assertTransportMode(self, transport, path, mode):
1102
"""Fail if a path does not have mode "mode".
1104
If modes are not supported on this transport, the assertion is ignored.
1106
if not transport._can_roundtrip_unix_modebits():
1108
path_stat = transport.stat(path)
1109
actual_mode = stat.S_IMODE(path_stat.st_mode)
1110
self.assertEqual(mode, actual_mode,
1111
'mode of %r incorrect (%s != %s)'
1112
% (path, oct(mode), oct(actual_mode)))
1114
def assertIsSameRealPath(self, path1, path2):
1115
"""Fail if path1 and path2 points to different files"""
1116
self.assertEqual(osutils.realpath(path1),
1117
osutils.realpath(path2),
1118
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1120
def assertIsInstance(self, obj, kls, msg=None):
1121
"""Fail if obj is not an instance of kls
1123
:param msg: Supplementary message to show if the assertion fails.
1125
if not isinstance(obj, kls):
1126
m = "%r is an instance of %s rather than %s" % (
1127
obj, obj.__class__, kls)
1132
def expectFailure(self, reason, assertion, *args, **kwargs):
1133
"""Invoke a test, expecting it to fail for the given reason.
1135
This is for assertions that ought to succeed, but currently fail.
1136
(The failure is *expected* but not *wanted*.) Please be very precise
1137
about the failure you're expecting. If a new bug is introduced,
1138
AssertionError should be raised, not KnownFailure.
1140
Frequently, expectFailure should be followed by an opposite assertion.
1143
Intended to be used with a callable that raises AssertionError as the
1144
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1146
Raises KnownFailure if the test fails. Raises AssertionError if the
1151
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1153
self.assertEqual(42, dynamic_val)
1155
This means that a dynamic_val of 54 will cause the test to raise
1156
a KnownFailure. Once math is fixed and the expectFailure is removed,
1157
only a dynamic_val of 42 will allow the test to pass. Anything other
1158
than 54 or 42 will cause an AssertionError.
1161
assertion(*args, **kwargs)
1162
except AssertionError:
1163
raise KnownFailure(reason)
1165
self.fail('Unexpected success. Should have failed: %s' % reason)
1167
def assertFileEqual(self, content, path):
1168
"""Fail if path does not contain 'content'."""
1169
self.failUnlessExists(path)
1170
f = file(path, 'rb')
1175
self.assertEqualDiff(content, s)
1177
def failUnlessExists(self, path):
1178
"""Fail unless path or paths, which may be abs or relative, exist."""
1179
if not isinstance(path, basestring):
1181
self.failUnlessExists(p)
1183
self.failUnless(osutils.lexists(path),path+" does not exist")
1185
def failIfExists(self, path):
1186
"""Fail if path or paths, which may be abs or relative, exist."""
1187
if not isinstance(path, basestring):
1189
self.failIfExists(p)
1191
self.failIf(osutils.lexists(path),path+" exists")
1193
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1194
"""A helper for callDeprecated and applyDeprecated.
1196
:param a_callable: A callable to call.
1197
:param args: The positional arguments for the callable
1198
:param kwargs: The keyword arguments for the callable
1199
:return: A tuple (warnings, result). result is the result of calling
1200
a_callable(``*args``, ``**kwargs``).
1203
def capture_warnings(msg, cls=None, stacklevel=None):
1204
# we've hooked into a deprecation specific callpath,
1205
# only deprecations should getting sent via it.
1206
self.assertEqual(cls, DeprecationWarning)
1207
local_warnings.append(msg)
1208
original_warning_method = symbol_versioning.warn
1209
symbol_versioning.set_warning_method(capture_warnings)
1211
result = a_callable(*args, **kwargs)
1213
symbol_versioning.set_warning_method(original_warning_method)
1214
return (local_warnings, result)
1216
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1217
"""Call a deprecated callable without warning the user.
1219
Note that this only captures warnings raised by symbol_versioning.warn,
1220
not other callers that go direct to the warning module.
1222
To test that a deprecated method raises an error, do something like
1225
self.assertRaises(errors.ReservedId,
1226
self.applyDeprecated,
1227
deprecated_in((1, 5, 0)),
1231
:param deprecation_format: The deprecation format that the callable
1232
should have been deprecated with. This is the same type as the
1233
parameter to deprecated_method/deprecated_function. If the
1234
callable is not deprecated with this format, an assertion error
1236
:param a_callable: A callable to call. This may be a bound method or
1237
a regular function. It will be called with ``*args`` and
1239
:param args: The positional arguments for the callable
1240
:param kwargs: The keyword arguments for the callable
1241
:return: The result of a_callable(``*args``, ``**kwargs``)
1243
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1245
expected_first_warning = symbol_versioning.deprecation_string(
1246
a_callable, deprecation_format)
1247
if len(call_warnings) == 0:
1248
self.fail("No deprecation warning generated by call to %s" %
1250
self.assertEqual(expected_first_warning, call_warnings[0])
1253
def callCatchWarnings(self, fn, *args, **kw):
1254
"""Call a callable that raises python warnings.
1256
The caller's responsible for examining the returned warnings.
1258
If the callable raises an exception, the exception is not
1259
caught and propagates up to the caller. In that case, the list
1260
of warnings is not available.
1262
:returns: ([warning_object, ...], fn_result)
1264
# XXX: This is not perfect, because it completely overrides the
1265
# warnings filters, and some code may depend on suppressing particular
1266
# warnings. It's the easiest way to insulate ourselves from -Werror,
1267
# though. -- Andrew, 20071062
1269
def _catcher(message, category, filename, lineno, file=None, line=None):
1270
# despite the name, 'message' is normally(?) a Warning subclass
1272
wlist.append(message)
1273
saved_showwarning = warnings.showwarning
1274
saved_filters = warnings.filters
1276
warnings.showwarning = _catcher
1277
warnings.filters = []
1278
result = fn(*args, **kw)
1280
warnings.showwarning = saved_showwarning
1281
warnings.filters = saved_filters
1282
return wlist, result
1284
def callDeprecated(self, expected, callable, *args, **kwargs):
1285
"""Assert that a callable is deprecated in a particular way.
1287
This is a very precise test for unusual requirements. The
1288
applyDeprecated helper function is probably more suited for most tests
1289
as it allows you to simply specify the deprecation format being used
1290
and will ensure that that is issued for the function being called.
1292
Note that this only captures warnings raised by symbol_versioning.warn,
1293
not other callers that go direct to the warning module. To catch
1294
general warnings, use callCatchWarnings.
1296
:param expected: a list of the deprecation warnings expected, in order
1297
:param callable: The callable to call
1298
:param args: The positional arguments for the callable
1299
:param kwargs: The keyword arguments for the callable
1301
call_warnings, result = self._capture_deprecation_warnings(callable,
1303
self.assertEqual(expected, call_warnings)
1306
def _startLogFile(self):
1307
"""Send bzr and test log messages to a temporary file.
1309
The file is removed as the test is torn down.
1311
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1312
self._log_file = os.fdopen(fileno, 'w+')
1313
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1314
self._log_file_name = name
1315
self.addCleanup(self._finishLogFile)
1317
def _finishLogFile(self):
1318
"""Finished with the log file.
1320
Close the file and delete it, unless setKeepLogfile was called.
1322
if self._log_file is None:
1324
bzrlib.trace.pop_log_file(self._log_memento)
1325
self._log_file.close()
1326
self._log_file = None
1327
if not self._keep_log_file:
1328
os.remove(self._log_file_name)
1329
self._log_file_name = None
1331
def setKeepLogfile(self):
1332
"""Make the logfile not be deleted when _finishLogFile is called."""
1333
self._keep_log_file = True
1335
def thisFailsStrictLockCheck(self):
1336
"""It is known that this test would fail with -Dstrict_locks.
1338
By default, all tests are run with strict lock checking unless
1339
-Edisable_lock_checks is supplied. However there are some tests which
1340
we know fail strict locks at this point that have not been fixed.
1341
They should call this function to disable the strict checking.
1343
This should be used sparingly, it is much better to fix the locking
1344
issues rather than papering over the problem by calling this function.
1346
debug.debug_flags.discard('strict_locks')
1348
def addCleanup(self, callable, *args, **kwargs):
1349
"""Arrange to run a callable when this case is torn down.
1351
Callables are run in the reverse of the order they are registered,
1352
ie last-in first-out.
1354
self._cleanups.append((callable, args, kwargs))
1356
def _cleanEnvironment(self):
1358
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1359
'HOME': os.getcwd(),
1360
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1361
# tests do check our impls match APPDATA
1362
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1366
'BZREMAIL': None, # may still be present in the environment
1368
'BZR_PROGRESS_BAR': None,
1370
'BZR_PLUGIN_PATH': None,
1371
# Make sure that any text ui tests are consistent regardless of
1372
# the environment the test case is run in; you may want tests that
1373
# test other combinations. 'dumb' is a reasonable guess for tests
1374
# going to a pipe or a StringIO.
1379
'SSH_AUTH_SOCK': None,
1383
'https_proxy': None,
1384
'HTTPS_PROXY': None,
1389
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1390
# least. If you do (care), please update this comment
1394
'BZR_REMOTE_PATH': None,
1397
self.addCleanup(self._restoreEnvironment)
1398
for name, value in new_env.iteritems():
1399
self._captureVar(name, value)
1401
def _captureVar(self, name, newvalue):
1402
"""Set an environment variable, and reset it when finished."""
1403
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1405
def _restore_debug_flags(self):
1406
debug.debug_flags.clear()
1407
debug.debug_flags.update(self._preserved_debug_flags)
1409
def _restoreEnvironment(self):
1410
for name, value in self.__old_env.iteritems():
1411
osutils.set_or_unset_env(name, value)
1413
def _restoreHooks(self):
1414
for klass, (name, hooks) in self._preserved_hooks.items():
1415
setattr(klass, name, hooks)
1417
def knownFailure(self, reason):
1418
"""This test has failed for some known reason."""
1419
raise KnownFailure(reason)
1421
def _do_skip(self, result, reason):
1422
addSkip = getattr(result, 'addSkip', None)
1423
if not callable(addSkip):
1424
result.addError(self, sys.exc_info())
1426
addSkip(self, reason)
1428
def run(self, result=None):
1429
if result is None: result = self.defaultTestResult()
1430
for feature in getattr(self, '_test_needs_features', []):
1431
if not feature.available():
1432
result.startTest(self)
1433
if getattr(result, 'addNotSupported', None):
1434
result.addNotSupported(self, feature)
1436
result.addSuccess(self)
1437
result.stopTest(self)
1441
result.startTest(self)
1442
absent_attr = object()
1444
method_name = getattr(self, '_testMethodName', absent_attr)
1445
if method_name is absent_attr:
1447
method_name = getattr(self, '_TestCase__testMethodName')
1448
testMethod = getattr(self, method_name)
1452
if not self._bzr_test_setUp_run:
1454
"test setUp did not invoke "
1455
"bzrlib.tests.TestCase's setUp")
1456
except KeyboardInterrupt:
1459
except TestSkipped, e:
1460
self._do_skip(result, e.args[0])
1464
result.addError(self, sys.exc_info())
1472
except self.failureException:
1473
result.addFailure(self, sys.exc_info())
1474
except TestSkipped, e:
1476
reason = "No reason given."
1479
self._do_skip(result, reason)
1480
except KeyboardInterrupt:
1484
result.addError(self, sys.exc_info())
1488
if not self._bzr_test_tearDown_run:
1490
"test tearDown did not invoke "
1491
"bzrlib.tests.TestCase's tearDown")
1492
except KeyboardInterrupt:
1496
result.addError(self, sys.exc_info())
1499
if ok: result.addSuccess(self)
1501
result.stopTest(self)
1503
except TestNotApplicable:
1504
# Not moved from the result [yet].
1507
except KeyboardInterrupt:
1512
for attr_name in self.attrs_to_keep:
1513
if attr_name in self.__dict__:
1514
saved_attrs[attr_name] = self.__dict__[attr_name]
1515
self.__dict__ = saved_attrs
1519
self._log_contents = ''
1520
self._bzr_test_tearDown_run = True
1521
unittest.TestCase.tearDown(self)
1523
def time(self, callable, *args, **kwargs):
1524
"""Run callable and accrue the time it takes to the benchmark time.
1526
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1527
this will cause lsprofile statistics to be gathered and stored in
1530
if self._benchtime is None:
1534
if not self._gather_lsprof_in_benchmarks:
1535
return callable(*args, **kwargs)
1537
# record this benchmark
1538
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1540
self._benchcalls.append(((callable, args, kwargs), stats))
1543
self._benchtime += time.time() - start
1545
def _runCleanups(self):
1546
"""Run registered cleanup functions.
1548
This should only be called from TestCase.tearDown.
1550
# TODO: Perhaps this should keep running cleanups even if
1551
# one of them fails?
1553
# Actually pop the cleanups from the list so tearDown running
1554
# twice is safe (this happens for skipped tests).
1555
while self._cleanups:
1556
cleanup, args, kwargs = self._cleanups.pop()
1557
cleanup(*args, **kwargs)
1559
def log(self, *args):
1562
def _get_log(self, keep_log_file=False):
1563
"""Get the log from bzrlib.trace calls from this test.
1565
:param keep_log_file: When True, if the log is still a file on disk
1566
leave it as a file on disk. When False, if the log is still a file
1567
on disk, the log file is deleted and the log preserved as
1569
:return: A string containing the log.
1571
# flush the log file, to get all content
1573
if bzrlib.trace._trace_file:
1574
bzrlib.trace._trace_file.flush()
1575
if self._log_contents:
1576
# XXX: this can hardly contain the content flushed above --vila
1578
return self._log_contents
1579
if self._log_file_name is not None:
1580
logfile = open(self._log_file_name)
1582
log_contents = logfile.read()
1585
if not keep_log_file:
1586
self._log_contents = log_contents
1588
os.remove(self._log_file_name)
1590
if sys.platform == 'win32' and e.errno == errno.EACCES:
1591
sys.stderr.write(('Unable to delete log file '
1592
' %r\n' % self._log_file_name))
1597
return "DELETED log file to reduce memory footprint"
1599
def requireFeature(self, feature):
1600
"""This test requires a specific feature is available.
1602
:raises UnavailableFeature: When feature is not available.
1604
if not feature.available():
1605
raise UnavailableFeature(feature)
1607
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1609
"""Run bazaar command line, splitting up a string command line."""
1610
if isinstance(args, basestring):
1611
# shlex don't understand unicode strings,
1612
# so args should be plain string (bialix 20070906)
1613
args = list(shlex.split(str(args)))
1614
return self._run_bzr_core(args, retcode=retcode,
1615
encoding=encoding, stdin=stdin, working_dir=working_dir,
1618
def _run_bzr_core(self, args, retcode, encoding, stdin,
1620
if encoding is None:
1621
encoding = osutils.get_user_encoding()
1622
stdout = StringIOWrapper()
1623
stderr = StringIOWrapper()
1624
stdout.encoding = encoding
1625
stderr.encoding = encoding
1627
self.log('run bzr: %r', args)
1628
# FIXME: don't call into logging here
1629
handler = logging.StreamHandler(stderr)
1630
handler.setLevel(logging.INFO)
1631
logger = logging.getLogger('')
1632
logger.addHandler(handler)
1633
old_ui_factory = ui.ui_factory
1634
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1637
if working_dir is not None:
1638
cwd = osutils.getcwd()
1639
os.chdir(working_dir)
1642
result = self.apply_redirected(ui.ui_factory.stdin,
1644
bzrlib.commands.run_bzr_catch_user_errors,
1647
logger.removeHandler(handler)
1648
ui.ui_factory = old_ui_factory
1652
out = stdout.getvalue()
1653
err = stderr.getvalue()
1655
self.log('output:\n%r', out)
1657
self.log('errors:\n%r', err)
1658
if retcode is not None:
1659
self.assertEquals(retcode, result,
1660
message='Unexpected return code')
1663
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1664
working_dir=None, error_regexes=[], output_encoding=None):
1665
"""Invoke bzr, as if it were run from the command line.
1667
The argument list should not include the bzr program name - the
1668
first argument is normally the bzr command. Arguments may be
1669
passed in three ways:
1671
1- A list of strings, eg ["commit", "a"]. This is recommended
1672
when the command contains whitespace or metacharacters, or
1673
is built up at run time.
1675
2- A single string, eg "add a". This is the most convenient
1676
for hardcoded commands.
1678
This runs bzr through the interface that catches and reports
1679
errors, and with logging set to something approximating the
1680
default, so that error reporting can be checked.
1682
This should be the main method for tests that want to exercise the
1683
overall behavior of the bzr application (rather than a unit test
1684
or a functional test of the library.)
1686
This sends the stdout/stderr results into the test's log,
1687
where it may be useful for debugging. See also run_captured.
1689
:keyword stdin: A string to be used as stdin for the command.
1690
:keyword retcode: The status code the command should return;
1692
:keyword working_dir: The directory to run the command in
1693
:keyword error_regexes: A list of expected error messages. If
1694
specified they must be seen in the error output of the command.
1696
out, err = self._run_bzr_autosplit(
1701
working_dir=working_dir,
1703
self.assertIsInstance(error_regexes, (list, tuple))
1704
for regex in error_regexes:
1705
self.assertContainsRe(err, regex)
1708
def run_bzr_error(self, error_regexes, *args, **kwargs):
1709
"""Run bzr, and check that stderr contains the supplied regexes
1711
:param error_regexes: Sequence of regular expressions which
1712
must each be found in the error output. The relative ordering
1714
:param args: command-line arguments for bzr
1715
:param kwargs: Keyword arguments which are interpreted by run_bzr
1716
This function changes the default value of retcode to be 3,
1717
since in most cases this is run when you expect bzr to fail.
1719
:return: (out, err) The actual output of running the command (in case
1720
you want to do more inspection)
1724
# Make sure that commit is failing because there is nothing to do
1725
self.run_bzr_error(['no changes to commit'],
1726
['commit', '-m', 'my commit comment'])
1727
# Make sure --strict is handling an unknown file, rather than
1728
# giving us the 'nothing to do' error
1729
self.build_tree(['unknown'])
1730
self.run_bzr_error(['Commit refused because there are unknown files'],
1731
['commit', --strict', '-m', 'my commit comment'])
1733
kwargs.setdefault('retcode', 3)
1734
kwargs['error_regexes'] = error_regexes
1735
out, err = self.run_bzr(*args, **kwargs)
1738
def run_bzr_subprocess(self, *args, **kwargs):
1739
"""Run bzr in a subprocess for testing.
1741
This starts a new Python interpreter and runs bzr in there.
1742
This should only be used for tests that have a justifiable need for
1743
this isolation: e.g. they are testing startup time, or signal
1744
handling, or early startup code, etc. Subprocess code can't be
1745
profiled or debugged so easily.
1747
:keyword retcode: The status code that is expected. Defaults to 0. If
1748
None is supplied, the status code is not checked.
1749
:keyword env_changes: A dictionary which lists changes to environment
1750
variables. A value of None will unset the env variable.
1751
The values must be strings. The change will only occur in the
1752
child, so you don't need to fix the environment after running.
1753
:keyword universal_newlines: Convert CRLF => LF
1754
:keyword allow_plugins: By default the subprocess is run with
1755
--no-plugins to ensure test reproducibility. Also, it is possible
1756
for system-wide plugins to create unexpected output on stderr,
1757
which can cause unnecessary test failures.
1759
env_changes = kwargs.get('env_changes', {})
1760
working_dir = kwargs.get('working_dir', None)
1761
allow_plugins = kwargs.get('allow_plugins', False)
1763
if isinstance(args[0], list):
1765
elif isinstance(args[0], basestring):
1766
args = list(shlex.split(args[0]))
1768
raise ValueError("passing varargs to run_bzr_subprocess")
1769
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1770
working_dir=working_dir,
1771
allow_plugins=allow_plugins)
1772
# We distinguish between retcode=None and retcode not passed.
1773
supplied_retcode = kwargs.get('retcode', 0)
1774
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1775
universal_newlines=kwargs.get('universal_newlines', False),
1778
def start_bzr_subprocess(self, process_args, env_changes=None,
1779
skip_if_plan_to_signal=False,
1781
allow_plugins=False):
1782
"""Start bzr in a subprocess for testing.
1784
This starts a new Python interpreter and runs bzr in there.
1785
This should only be used for tests that have a justifiable need for
1786
this isolation: e.g. they are testing startup time, or signal
1787
handling, or early startup code, etc. Subprocess code can't be
1788
profiled or debugged so easily.
1790
:param process_args: a list of arguments to pass to the bzr executable,
1791
for example ``['--version']``.
1792
:param env_changes: A dictionary which lists changes to environment
1793
variables. A value of None will unset the env variable.
1794
The values must be strings. The change will only occur in the
1795
child, so you don't need to fix the environment after running.
1796
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1798
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1800
:returns: Popen object for the started process.
1802
if skip_if_plan_to_signal:
1803
if not getattr(os, 'kill', None):
1804
raise TestSkipped("os.kill not available.")
1806
if env_changes is None:
1810
def cleanup_environment():
1811
for env_var, value in env_changes.iteritems():
1812
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1814
def restore_environment():
1815
for env_var, value in old_env.iteritems():
1816
osutils.set_or_unset_env(env_var, value)
1818
bzr_path = self.get_bzr_path()
1821
if working_dir is not None:
1822
cwd = osutils.getcwd()
1823
os.chdir(working_dir)
1826
# win32 subprocess doesn't support preexec_fn
1827
# so we will avoid using it on all platforms, just to
1828
# make sure the code path is used, and we don't break on win32
1829
cleanup_environment()
1830
command = [sys.executable]
1831
# frozen executables don't need the path to bzr
1832
if getattr(sys, "frozen", None) is None:
1833
command.append(bzr_path)
1834
if not allow_plugins:
1835
command.append('--no-plugins')
1836
command.extend(process_args)
1837
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1839
restore_environment()
1845
def _popen(self, *args, **kwargs):
1846
"""Place a call to Popen.
1848
Allows tests to override this method to intercept the calls made to
1849
Popen for introspection.
1851
return Popen(*args, **kwargs)
1853
def get_bzr_path(self):
1854
"""Return the path of the 'bzr' executable for this test suite."""
1855
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1856
if not os.path.isfile(bzr_path):
1857
# We are probably installed. Assume sys.argv is the right file
1858
bzr_path = sys.argv[0]
1861
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1862
universal_newlines=False, process_args=None):
1863
"""Finish the execution of process.
1865
:param process: the Popen object returned from start_bzr_subprocess.
1866
:param retcode: The status code that is expected. Defaults to 0. If
1867
None is supplied, the status code is not checked.
1868
:param send_signal: an optional signal to send to the process.
1869
:param universal_newlines: Convert CRLF => LF
1870
:returns: (stdout, stderr)
1872
if send_signal is not None:
1873
os.kill(process.pid, send_signal)
1874
out, err = process.communicate()
1876
if universal_newlines:
1877
out = out.replace('\r\n', '\n')
1878
err = err.replace('\r\n', '\n')
1880
if retcode is not None and retcode != process.returncode:
1881
if process_args is None:
1882
process_args = "(unknown args)"
1883
mutter('Output of bzr %s:\n%s', process_args, out)
1884
mutter('Error for bzr %s:\n%s', process_args, err)
1885
self.fail('Command bzr %s failed with retcode %s != %s'
1886
% (process_args, retcode, process.returncode))
1889
def check_inventory_shape(self, inv, shape):
1890
"""Compare an inventory to a list of expected names.
1892
Fail if they are not precisely equal.
1895
shape = list(shape) # copy
1896
for path, ie in inv.entries():
1897
name = path.replace('\\', '/')
1898
if ie.kind == 'directory':
1905
self.fail("expected paths not found in inventory: %r" % shape)
1907
self.fail("unexpected paths found in inventory: %r" % extras)
1909
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1910
a_callable=None, *args, **kwargs):
1911
"""Call callable with redirected std io pipes.
1913
Returns the return code."""
1914
if not callable(a_callable):
1915
raise ValueError("a_callable must be callable.")
1917
stdin = StringIO("")
1919
if getattr(self, "_log_file", None) is not None:
1920
stdout = self._log_file
1924
if getattr(self, "_log_file", None is not None):
1925
stderr = self._log_file
1928
real_stdin = sys.stdin
1929
real_stdout = sys.stdout
1930
real_stderr = sys.stderr
1935
return a_callable(*args, **kwargs)
1937
sys.stdout = real_stdout
1938
sys.stderr = real_stderr
1939
sys.stdin = real_stdin
1941
def reduceLockdirTimeout(self):
1942
"""Reduce the default lock timeout for the duration of the test, so that
1943
if LockContention occurs during a test, it does so quickly.
1945
Tests that expect to provoke LockContention errors should call this.
1947
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1949
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1950
self.addCleanup(resetTimeout)
1951
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1953
def make_utf8_encoded_stringio(self, encoding_type=None):
1954
"""Return a StringIOWrapper instance, that will encode Unicode
1957
if encoding_type is None:
1958
encoding_type = 'strict'
1960
output_encoding = 'utf-8'
1961
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1962
sio.encoding = output_encoding
1965
def disable_verb(self, verb):
1966
"""Disable a smart server verb for one test."""
1967
from bzrlib.smart import request
1968
request_handlers = request.request_handlers
1969
orig_method = request_handlers.get(verb)
1970
request_handlers.remove(verb)
1972
request_handlers.register(verb, orig_method)
1973
self.addCleanup(restoreVerb)
1976
class CapturedCall(object):
1977
"""A helper for capturing smart server calls for easy debug analysis."""
1979
def __init__(self, params, prefix_length):
1980
"""Capture the call with params and skip prefix_length stack frames."""
1983
# The last 5 frames are the __init__, the hook frame, and 3 smart
1984
# client frames. Beyond this we could get more clever, but this is good
1986
stack = traceback.extract_stack()[prefix_length:-5]
1987
self.stack = ''.join(traceback.format_list(stack))
1990
return self.call.method
1993
return self.call.method
1999
class TestCaseWithMemoryTransport(TestCase):
2000
"""Common test class for tests that do not need disk resources.
2002
Tests that need disk resources should derive from TestCaseWithTransport.
2004
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2006
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2007
a directory which does not exist. This serves to help ensure test isolation
2008
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2009
must exist. However, TestCaseWithMemoryTransport does not offer local
2010
file defaults for the transport in tests, nor does it obey the command line
2011
override, so tests that accidentally write to the common directory should
2014
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2015
a .bzr directory that stops us ascending higher into the filesystem.
2021
def __init__(self, methodName='runTest'):
2022
# allow test parameterization after test construction and before test
2023
# execution. Variables that the parameterizer sets need to be
2024
# ones that are not set by setUp, or setUp will trash them.
2025
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2026
self.vfs_transport_factory = default_transport
2027
self.transport_server = None
2028
self.transport_readonly_server = None
2029
self.__vfs_server = None
2031
def get_transport(self, relpath=None):
2032
"""Return a writeable transport.
2034
This transport is for the test scratch space relative to
2037
:param relpath: a path relative to the base url.
2039
t = get_transport(self.get_url(relpath))
2040
self.assertFalse(t.is_readonly())
2043
def get_readonly_transport(self, relpath=None):
2044
"""Return a readonly transport for the test scratch space
2046
This can be used to test that operations which should only need
2047
readonly access in fact do not try to write.
2049
:param relpath: a path relative to the base url.
2051
t = get_transport(self.get_readonly_url(relpath))
2052
self.assertTrue(t.is_readonly())
2055
def create_transport_readonly_server(self):
2056
"""Create a transport server from class defined at init.
2058
This is mostly a hook for daughter classes.
2060
return self.transport_readonly_server()
2062
def get_readonly_server(self):
2063
"""Get the server instance for the readonly transport
2065
This is useful for some tests with specific servers to do diagnostics.
2067
if self.__readonly_server is None:
2068
if self.transport_readonly_server is None:
2069
# readonly decorator requested
2070
# bring up the server
2071
self.__readonly_server = ReadonlyServer()
2072
self.__readonly_server.setUp(self.get_vfs_only_server())
2074
self.__readonly_server = self.create_transport_readonly_server()
2075
self.__readonly_server.setUp(self.get_vfs_only_server())
2076
self.addCleanup(self.__readonly_server.tearDown)
2077
return self.__readonly_server
2079
def get_readonly_url(self, relpath=None):
2080
"""Get a URL for the readonly transport.
2082
This will either be backed by '.' or a decorator to the transport
2083
used by self.get_url()
2084
relpath provides for clients to get a path relative to the base url.
2085
These should only be downwards relative, not upwards.
2087
base = self.get_readonly_server().get_url()
2088
return self._adjust_url(base, relpath)
2090
def get_vfs_only_server(self):
2091
"""Get the vfs only read/write server instance.
2093
This is useful for some tests with specific servers that need
2096
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2097
is no means to override it.
2099
if self.__vfs_server is None:
2100
self.__vfs_server = MemoryServer()
2101
self.__vfs_server.setUp()
2102
self.addCleanup(self.__vfs_server.tearDown)
2103
return self.__vfs_server
2105
def get_server(self):
2106
"""Get the read/write server instance.
2108
This is useful for some tests with specific servers that need
2111
This is built from the self.transport_server factory. If that is None,
2112
then the self.get_vfs_server is returned.
2114
if self.__server is None:
2115
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
2116
return self.get_vfs_only_server()
2118
# bring up a decorated means of access to the vfs only server.
2119
self.__server = self.transport_server()
2121
self.__server.setUp(self.get_vfs_only_server())
2122
except TypeError, e:
2123
# This should never happen; the try:Except here is to assist
2124
# developers having to update code rather than seeing an
2125
# uninformative TypeError.
2126
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
2127
self.addCleanup(self.__server.tearDown)
2128
return self.__server
2130
def _adjust_url(self, base, relpath):
2131
"""Get a URL (or maybe a path) for the readwrite transport.
2133
This will either be backed by '.' or to an equivalent non-file based
2135
relpath provides for clients to get a path relative to the base url.
2136
These should only be downwards relative, not upwards.
2138
if relpath is not None and relpath != '.':
2139
if not base.endswith('/'):
2141
# XXX: Really base should be a url; we did after all call
2142
# get_url()! But sometimes it's just a path (from
2143
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2144
# to a non-escaped local path.
2145
if base.startswith('./') or base.startswith('/'):
2148
base += urlutils.escape(relpath)
2151
def get_url(self, relpath=None):
2152
"""Get a URL (or maybe a path) for the readwrite transport.
2154
This will either be backed by '.' or to an equivalent non-file based
2156
relpath provides for clients to get a path relative to the base url.
2157
These should only be downwards relative, not upwards.
2159
base = self.get_server().get_url()
2160
return self._adjust_url(base, relpath)
2162
def get_vfs_only_url(self, relpath=None):
2163
"""Get a URL (or maybe a path for the plain old vfs transport.
2165
This will never be a smart protocol. It always has all the
2166
capabilities of the local filesystem, but it might actually be a
2167
MemoryTransport or some other similar virtual filesystem.
2169
This is the backing transport (if any) of the server returned by
2170
get_url and get_readonly_url.
2172
:param relpath: provides for clients to get a path relative to the base
2173
url. These should only be downwards relative, not upwards.
2176
base = self.get_vfs_only_server().get_url()
2177
return self._adjust_url(base, relpath)
2179
def _create_safety_net(self):
2180
"""Make a fake bzr directory.
2182
This prevents any tests propagating up onto the TEST_ROOT directory's
2185
root = TestCaseWithMemoryTransport.TEST_ROOT
2186
bzrdir.BzrDir.create_standalone_workingtree(root)
2188
def _check_safety_net(self):
2189
"""Check that the safety .bzr directory have not been touched.
2191
_make_test_root have created a .bzr directory to prevent tests from
2192
propagating. This method ensures than a test did not leaked.
2194
root = TestCaseWithMemoryTransport.TEST_ROOT
2195
wt = workingtree.WorkingTree.open(root)
2196
last_rev = wt.last_revision()
2197
if last_rev != 'null:':
2198
# The current test have modified the /bzr directory, we need to
2199
# recreate a new one or all the followng tests will fail.
2200
# If you need to inspect its content uncomment the following line
2201
# import pdb; pdb.set_trace()
2202
_rmtree_temp_dir(root + '/.bzr')
2203
self._create_safety_net()
2204
raise AssertionError('%s/.bzr should not be modified' % root)
2206
def _make_test_root(self):
2207
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2208
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2209
TestCaseWithMemoryTransport.TEST_ROOT = root
2211
self._create_safety_net()
2213
# The same directory is used by all tests, and we're not
2214
# specifically told when all tests are finished. This will do.
2215
atexit.register(_rmtree_temp_dir, root)
2217
self.addCleanup(self._check_safety_net)
2219
def makeAndChdirToTestDir(self):
2220
"""Create a temporary directories for this one test.
2222
This must set self.test_home_dir and self.test_dir and chdir to
2225
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2227
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2228
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2229
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2231
def make_branch(self, relpath, format=None):
2232
"""Create a branch on the transport at relpath."""
2233
repo = self.make_repository(relpath, format=format)
2234
return repo.bzrdir.create_branch()
2236
def make_bzrdir(self, relpath, format=None):
2238
# might be a relative or absolute path
2239
maybe_a_url = self.get_url(relpath)
2240
segments = maybe_a_url.rsplit('/', 1)
2241
t = get_transport(maybe_a_url)
2242
if len(segments) > 1 and segments[-1] not in ('', '.'):
2246
if isinstance(format, basestring):
2247
format = bzrdir.format_registry.make_bzrdir(format)
2248
return format.initialize_on_transport(t)
2249
except errors.UninitializableFormat:
2250
raise TestSkipped("Format %s is not initializable." % format)
2252
def make_repository(self, relpath, shared=False, format=None):
2253
"""Create a repository on our default transport at relpath.
2255
Note that relpath must be a relative path, not a full url.
2257
# FIXME: If you create a remoterepository this returns the underlying
2258
# real format, which is incorrect. Actually we should make sure that
2259
# RemoteBzrDir returns a RemoteRepository.
2260
# maybe mbp 20070410
2261
made_control = self.make_bzrdir(relpath, format=format)
2262
return made_control.create_repository(shared=shared)
2264
def make_smart_server(self, path):
2265
smart_server = server.SmartTCPServer_for_testing()
2266
smart_server.setUp(self.get_server())
2267
remote_transport = get_transport(smart_server.get_url()).clone(path)
2268
self.addCleanup(smart_server.tearDown)
2269
return remote_transport
2271
def make_branch_and_memory_tree(self, relpath, format=None):
2272
"""Create a branch on the default transport and a MemoryTree for it."""
2273
b = self.make_branch(relpath, format=format)
2274
return memorytree.MemoryTree.create_on_branch(b)
2276
def make_branch_builder(self, relpath, format=None):
2277
branch = self.make_branch(relpath, format=format)
2278
return branchbuilder.BranchBuilder(branch=branch)
2280
def overrideEnvironmentForTesting(self):
2281
os.environ['HOME'] = self.test_home_dir
2282
os.environ['BZR_HOME'] = self.test_home_dir
2285
super(TestCaseWithMemoryTransport, self).setUp()
2286
self._make_test_root()
2287
_currentdir = os.getcwdu()
2288
def _leaveDirectory():
2289
os.chdir(_currentdir)
2290
self.addCleanup(_leaveDirectory)
2291
self.makeAndChdirToTestDir()
2292
self.overrideEnvironmentForTesting()
2293
self.__readonly_server = None
2294
self.__server = None
2295
self.reduceLockdirTimeout()
2297
def setup_smart_server_with_call_log(self):
2298
"""Sets up a smart server as the transport server with a call log."""
2299
self.transport_server = server.SmartTCPServer_for_testing
2300
self.hpss_calls = []
2302
# Skip the current stack down to the caller of
2303
# setup_smart_server_with_call_log
2304
prefix_length = len(traceback.extract_stack()) - 2
2305
def capture_hpss_call(params):
2306
self.hpss_calls.append(
2307
CapturedCall(params, prefix_length))
2308
client._SmartClient.hooks.install_named_hook(
2309
'call', capture_hpss_call, None)
2311
def reset_smart_call_log(self):
2312
self.hpss_calls = []
2315
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2316
"""Derived class that runs a test within a temporary directory.
2318
This is useful for tests that need to create a branch, etc.
2320
The directory is created in a slightly complex way: for each
2321
Python invocation, a new temporary top-level directory is created.
2322
All test cases create their own directory within that. If the
2323
tests complete successfully, the directory is removed.
2325
:ivar test_base_dir: The path of the top-level directory for this
2326
test, which contains a home directory and a work directory.
2328
:ivar test_home_dir: An initially empty directory under test_base_dir
2329
which is used as $HOME for this test.
2331
:ivar test_dir: A directory under test_base_dir used as the current
2332
directory when the test proper is run.
2335
OVERRIDE_PYTHON = 'python'
2337
def check_file_contents(self, filename, expect):
2338
self.log("check contents of file %s" % filename)
2339
contents = file(filename, 'r').read()
2340
if contents != expect:
2341
self.log("expected: %r" % expect)
2342
self.log("actually: %r" % contents)
2343
self.fail("contents of %s not as expected" % filename)
2345
def _getTestDirPrefix(self):
2346
# create a directory within the top level test directory
2347
if sys.platform in ('win32', 'cygwin'):
2348
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2349
# windows is likely to have path-length limits so use a short name
2350
name_prefix = name_prefix[-30:]
2352
name_prefix = re.sub('[/]', '_', self.id())
2355
def makeAndChdirToTestDir(self):
2356
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2358
For TestCaseInTempDir we create a temporary directory based on the test
2359
name and then create two subdirs - test and home under it.
2361
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2362
self._getTestDirPrefix())
2364
for i in range(100):
2365
if os.path.exists(name):
2366
name = name_prefix + '_' + str(i)
2370
# now create test and home directories within this dir
2371
self.test_base_dir = name
2372
self.test_home_dir = self.test_base_dir + '/home'
2373
os.mkdir(self.test_home_dir)
2374
self.test_dir = self.test_base_dir + '/work'
2375
os.mkdir(self.test_dir)
2376
os.chdir(self.test_dir)
2377
# put name of test inside
2378
f = file(self.test_base_dir + '/name', 'w')
2383
self.addCleanup(self.deleteTestDir)
2385
def deleteTestDir(self):
2386
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2387
_rmtree_temp_dir(self.test_base_dir)
2389
def build_tree(self, shape, line_endings='binary', transport=None):
2390
"""Build a test tree according to a pattern.
2392
shape is a sequence of file specifications. If the final
2393
character is '/', a directory is created.
2395
This assumes that all the elements in the tree being built are new.
2397
This doesn't add anything to a branch.
2399
:type shape: list or tuple.
2400
:param line_endings: Either 'binary' or 'native'
2401
in binary mode, exact contents are written in native mode, the
2402
line endings match the default platform endings.
2403
:param transport: A transport to write to, for building trees on VFS's.
2404
If the transport is readonly or None, "." is opened automatically.
2407
if type(shape) not in (list, tuple):
2408
raise AssertionError("Parameter 'shape' should be "
2409
"a list or a tuple. Got %r instead" % (shape,))
2410
# It's OK to just create them using forward slashes on windows.
2411
if transport is None or transport.is_readonly():
2412
transport = get_transport(".")
2414
self.assertIsInstance(name, basestring)
2416
transport.mkdir(urlutils.escape(name[:-1]))
2418
if line_endings == 'binary':
2420
elif line_endings == 'native':
2423
raise errors.BzrError(
2424
'Invalid line ending request %r' % line_endings)
2425
content = "contents of %s%s" % (name.encode('utf-8'), end)
2426
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2428
def build_tree_contents(self, shape):
2429
build_tree_contents(shape)
2431
def assertInWorkingTree(self, path, root_path='.', tree=None):
2432
"""Assert whether path or paths are in the WorkingTree"""
2434
tree = workingtree.WorkingTree.open(root_path)
2435
if not isinstance(path, basestring):
2437
self.assertInWorkingTree(p, tree=tree)
2439
self.assertIsNot(tree.path2id(path), None,
2440
path+' not in working tree.')
2442
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2443
"""Assert whether path or paths are not in the WorkingTree"""
2445
tree = workingtree.WorkingTree.open(root_path)
2446
if not isinstance(path, basestring):
2448
self.assertNotInWorkingTree(p,tree=tree)
2450
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2453
class TestCaseWithTransport(TestCaseInTempDir):
2454
"""A test case that provides get_url and get_readonly_url facilities.
2456
These back onto two transport servers, one for readonly access and one for
2459
If no explicit class is provided for readonly access, a
2460
ReadonlyTransportDecorator is used instead which allows the use of non disk
2461
based read write transports.
2463
If an explicit class is provided for readonly access, that server and the
2464
readwrite one must both define get_url() as resolving to os.getcwd().
2467
def get_vfs_only_server(self):
2468
"""See TestCaseWithMemoryTransport.
2470
This is useful for some tests with specific servers that need
2473
if self.__vfs_server is None:
2474
self.__vfs_server = self.vfs_transport_factory()
2475
self.__vfs_server.setUp()
2476
self.addCleanup(self.__vfs_server.tearDown)
2477
return self.__vfs_server
2479
def make_branch_and_tree(self, relpath, format=None):
2480
"""Create a branch on the transport and a tree locally.
2482
If the transport is not a LocalTransport, the Tree can't be created on
2483
the transport. In that case if the vfs_transport_factory is
2484
LocalURLServer the working tree is created in the local
2485
directory backing the transport, and the returned tree's branch and
2486
repository will also be accessed locally. Otherwise a lightweight
2487
checkout is created and returned.
2489
We do this because we can't physically create a tree in the local
2490
path, with a branch reference to the transport_factory url, and
2491
a branch + repository in the vfs_transport, unless the vfs_transport
2492
namespace is distinct from the local disk - the two branch objects
2493
would collide. While we could construct a tree with its branch object
2494
pointing at the transport_factory transport in memory, reopening it
2495
would behaving unexpectedly, and has in the past caused testing bugs
2496
when we tried to do it that way.
2498
:param format: The BzrDirFormat.
2499
:returns: the WorkingTree.
2501
# TODO: always use the local disk path for the working tree,
2502
# this obviously requires a format that supports branch references
2503
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2505
b = self.make_branch(relpath, format=format)
2507
return b.bzrdir.create_workingtree()
2508
except errors.NotLocalUrl:
2509
# We can only make working trees locally at the moment. If the
2510
# transport can't support them, then we keep the non-disk-backed
2511
# branch and create a local checkout.
2512
if self.vfs_transport_factory is LocalURLServer:
2513
# the branch is colocated on disk, we cannot create a checkout.
2514
# hopefully callers will expect this.
2515
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2516
wt = local_controldir.create_workingtree()
2517
if wt.branch._format != b._format:
2519
# Make sure that assigning to wt._branch fixes wt.branch,
2520
# in case the implementation details of workingtree objects
2522
self.assertIs(b, wt.branch)
2525
return b.create_checkout(relpath, lightweight=True)
2527
def assertIsDirectory(self, relpath, transport):
2528
"""Assert that relpath within transport is a directory.
2530
This may not be possible on all transports; in that case it propagates
2531
a TransportNotPossible.
2534
mode = transport.stat(relpath).st_mode
2535
except errors.NoSuchFile:
2536
self.fail("path %s is not a directory; no such file"
2538
if not stat.S_ISDIR(mode):
2539
self.fail("path %s is not a directory; has mode %#o"
2542
def assertTreesEqual(self, left, right):
2543
"""Check that left and right have the same content and properties."""
2544
# we use a tree delta to check for equality of the content, and we
2545
# manually check for equality of other things such as the parents list.
2546
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2547
differences = left.changes_from(right)
2548
self.assertFalse(differences.has_changed(),
2549
"Trees %r and %r are different: %r" % (left, right, differences))
2552
super(TestCaseWithTransport, self).setUp()
2553
self.__vfs_server = None
2556
class ChrootedTestCase(TestCaseWithTransport):
2557
"""A support class that provides readonly urls outside the local namespace.
2559
This is done by checking if self.transport_server is a MemoryServer. if it
2560
is then we are chrooted already, if it is not then an HttpServer is used
2563
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2564
be used without needed to redo it when a different
2565
subclass is in use ?
2569
super(ChrootedTestCase, self).setUp()
2570
if not self.vfs_transport_factory == MemoryServer:
2571
self.transport_readonly_server = HttpServer
2574
def condition_id_re(pattern):
2575
"""Create a condition filter which performs a re check on a test's id.
2577
:param pattern: A regular expression string.
2578
:return: A callable that returns True if the re matches.
2580
filter_re = osutils.re_compile_checked(pattern, 0,
2582
def condition(test):
2584
return filter_re.search(test_id)
2588
def condition_isinstance(klass_or_klass_list):
2589
"""Create a condition filter which returns isinstance(param, klass).
2591
:return: A callable which when called with one parameter obj return the
2592
result of isinstance(obj, klass_or_klass_list).
2595
return isinstance(obj, klass_or_klass_list)
2599
def condition_id_in_list(id_list):
2600
"""Create a condition filter which verify that test's id in a list.
2602
:param id_list: A TestIdList object.
2603
:return: A callable that returns True if the test's id appears in the list.
2605
def condition(test):
2606
return id_list.includes(test.id())
2610
def condition_id_startswith(starts):
2611
"""Create a condition filter verifying that test's id starts with a string.
2613
:param starts: A list of string.
2614
:return: A callable that returns True if the test's id starts with one of
2617
def condition(test):
2618
for start in starts:
2619
if test.id().startswith(start):
2625
def exclude_tests_by_condition(suite, condition):
2626
"""Create a test suite which excludes some tests from suite.
2628
:param suite: The suite to get tests from.
2629
:param condition: A callable whose result evaluates True when called with a
2630
test case which should be excluded from the result.
2631
:return: A suite which contains the tests found in suite that fail
2635
for test in iter_suite_tests(suite):
2636
if not condition(test):
2638
return TestUtil.TestSuite(result)
2641
def filter_suite_by_condition(suite, condition):
2642
"""Create a test suite by filtering another one.
2644
:param suite: The source suite.
2645
:param condition: A callable whose result evaluates True when called with a
2646
test case which should be included in the result.
2647
:return: A suite which contains the tests found in suite that pass
2651
for test in iter_suite_tests(suite):
2654
return TestUtil.TestSuite(result)
2657
def filter_suite_by_re(suite, pattern):
2658
"""Create a test suite by filtering another one.
2660
:param suite: the source suite
2661
:param pattern: pattern that names must match
2662
:returns: the newly created suite
2664
condition = condition_id_re(pattern)
2665
result_suite = filter_suite_by_condition(suite, condition)
2669
def filter_suite_by_id_list(suite, test_id_list):
2670
"""Create a test suite by filtering another one.
2672
:param suite: The source suite.
2673
:param test_id_list: A list of the test ids to keep as strings.
2674
:returns: the newly created suite
2676
condition = condition_id_in_list(test_id_list)
2677
result_suite = filter_suite_by_condition(suite, condition)
2681
def filter_suite_by_id_startswith(suite, start):
2682
"""Create a test suite by filtering another one.
2684
:param suite: The source suite.
2685
:param start: A list of string the test id must start with one of.
2686
:returns: the newly created suite
2688
condition = condition_id_startswith(start)
2689
result_suite = filter_suite_by_condition(suite, condition)
2693
def exclude_tests_by_re(suite, pattern):
2694
"""Create a test suite which excludes some tests from suite.
2696
:param suite: The suite to get tests from.
2697
:param pattern: A regular expression string. Test ids that match this
2698
pattern will be excluded from the result.
2699
:return: A TestSuite that contains all the tests from suite without the
2700
tests that matched pattern. The order of tests is the same as it was in
2703
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2706
def preserve_input(something):
2707
"""A helper for performing test suite transformation chains.
2709
:param something: Anything you want to preserve.
2715
def randomize_suite(suite):
2716
"""Return a new TestSuite with suite's tests in random order.
2718
The tests in the input suite are flattened into a single suite in order to
2719
accomplish this. Any nested TestSuites are removed to provide global
2722
tests = list(iter_suite_tests(suite))
2723
random.shuffle(tests)
2724
return TestUtil.TestSuite(tests)
2727
def split_suite_by_condition(suite, condition):
2728
"""Split a test suite into two by a condition.
2730
:param suite: The suite to split.
2731
:param condition: The condition to match on. Tests that match this
2732
condition are returned in the first test suite, ones that do not match
2733
are in the second suite.
2734
:return: A tuple of two test suites, where the first contains tests from
2735
suite matching the condition, and the second contains the remainder
2736
from suite. The order within each output suite is the same as it was in
2741
for test in iter_suite_tests(suite):
2743
matched.append(test)
2745
did_not_match.append(test)
2746
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2749
def split_suite_by_re(suite, pattern):
2750
"""Split a test suite into two by a regular expression.
2752
:param suite: The suite to split.
2753
:param pattern: A regular expression string. Test ids that match this
2754
pattern will be in the first test suite returned, and the others in the
2755
second test suite returned.
2756
:return: A tuple of two test suites, where the first contains tests from
2757
suite matching pattern, and the second contains the remainder from
2758
suite. The order within each output suite is the same as it was in
2761
return split_suite_by_condition(suite, condition_id_re(pattern))
2764
def run_suite(suite, name='test', verbose=False, pattern=".*",
2765
stop_on_failure=False,
2766
transport=None, lsprof_timed=None, bench_history=None,
2767
matching_tests_first=None,
2770
exclude_pattern=None,
2773
suite_decorators=None,
2775
result_decorators=None,
2777
"""Run a test suite for bzr selftest.
2779
:param runner_class: The class of runner to use. Must support the
2780
constructor arguments passed by run_suite which are more than standard
2782
:return: A boolean indicating success.
2784
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2789
if runner_class is None:
2790
runner_class = TextTestRunner
2793
runner = runner_class(stream=stream,
2795
verbosity=verbosity,
2796
bench_history=bench_history,
2798
result_decorators=result_decorators,
2800
runner.stop_on_failure=stop_on_failure
2801
# built in decorator factories:
2803
random_order(random_seed, runner),
2804
exclude_tests(exclude_pattern),
2806
if matching_tests_first:
2807
decorators.append(tests_first(pattern))
2809
decorators.append(filter_tests(pattern))
2810
if suite_decorators:
2811
decorators.extend(suite_decorators)
2812
# tell the result object how many tests will be running: (except if
2813
# --parallel=fork is being used. Robert said he will provide a better
2814
# progress design later -- vila 20090817)
2815
if fork_decorator not in decorators:
2816
decorators.append(CountingDecorator)
2817
for decorator in decorators:
2818
suite = decorator(suite)
2820
# Done after test suite decoration to allow randomisation etc
2821
# to take effect, though that is of marginal benefit.
2823
stream.write("Listing tests only ...\n")
2824
for t in iter_suite_tests(suite):
2825
stream.write("%s\n" % (t.id()))
2827
result = runner.run(suite)
2829
return result.wasStrictlySuccessful()
2831
return result.wasSuccessful()
2834
# A registry where get() returns a suite decorator.
2835
parallel_registry = registry.Registry()
2838
def fork_decorator(suite):
2839
concurrency = osutils.local_concurrency()
2840
if concurrency == 1:
2842
from testtools import ConcurrentTestSuite
2843
return ConcurrentTestSuite(suite, fork_for_tests)
2844
parallel_registry.register('fork', fork_decorator)
2847
def subprocess_decorator(suite):
2848
concurrency = osutils.local_concurrency()
2849
if concurrency == 1:
2851
from testtools import ConcurrentTestSuite
2852
return ConcurrentTestSuite(suite, reinvoke_for_tests)
2853
parallel_registry.register('subprocess', subprocess_decorator)
2856
def exclude_tests(exclude_pattern):
2857
"""Return a test suite decorator that excludes tests."""
2858
if exclude_pattern is None:
2859
return identity_decorator
2860
def decorator(suite):
2861
return ExcludeDecorator(suite, exclude_pattern)
2865
def filter_tests(pattern):
2867
return identity_decorator
2868
def decorator(suite):
2869
return FilterTestsDecorator(suite, pattern)
2873
def random_order(random_seed, runner):
2874
"""Return a test suite decorator factory for randomising tests order.
2876
:param random_seed: now, a string which casts to a long, or a long.
2877
:param runner: A test runner with a stream attribute to report on.
2879
if random_seed is None:
2880
return identity_decorator
2881
def decorator(suite):
2882
return RandomDecorator(suite, random_seed, runner.stream)
2886
def tests_first(pattern):
2888
return identity_decorator
2889
def decorator(suite):
2890
return TestFirstDecorator(suite, pattern)
2894
def identity_decorator(suite):
2899
class TestDecorator(TestSuite):
2900
"""A decorator for TestCase/TestSuite objects.
2902
Usually, subclasses should override __iter__(used when flattening test
2903
suites), which we do to filter, reorder, parallelise and so on, run() and
2907
def __init__(self, suite):
2908
TestSuite.__init__(self)
2911
def countTestCases(self):
2914
cases += test.countTestCases()
2921
def run(self, result):
2922
# Use iteration on self, not self._tests, to allow subclasses to hook
2925
if result.shouldStop:
2931
class CountingDecorator(TestDecorator):
2932
"""A decorator which calls result.progress(self.countTestCases)."""
2934
def run(self, result):
2935
progress_method = getattr(result, 'progress', None)
2936
if callable(progress_method):
2937
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
2938
return super(CountingDecorator, self).run(result)
2941
class ExcludeDecorator(TestDecorator):
2942
"""A decorator which excludes test matching an exclude pattern."""
2944
def __init__(self, suite, exclude_pattern):
2945
TestDecorator.__init__(self, suite)
2946
self.exclude_pattern = exclude_pattern
2947
self.excluded = False
2951
return iter(self._tests)
2952
self.excluded = True
2953
suite = exclude_tests_by_re(self, self.exclude_pattern)
2955
self.addTests(suite)
2956
return iter(self._tests)
2959
class FilterTestsDecorator(TestDecorator):
2960
"""A decorator which filters tests to those matching a pattern."""
2962
def __init__(self, suite, pattern):
2963
TestDecorator.__init__(self, suite)
2964
self.pattern = pattern
2965
self.filtered = False
2969
return iter(self._tests)
2970
self.filtered = True
2971
suite = filter_suite_by_re(self, self.pattern)
2973
self.addTests(suite)
2974
return iter(self._tests)
2977
class RandomDecorator(TestDecorator):
2978
"""A decorator which randomises the order of its tests."""
2980
def __init__(self, suite, random_seed, stream):
2981
TestDecorator.__init__(self, suite)
2982
self.random_seed = random_seed
2983
self.randomised = False
2984
self.stream = stream
2988
return iter(self._tests)
2989
self.randomised = True
2990
self.stream.writeln("Randomizing test order using seed %s\n" %
2991
(self.actual_seed()))
2992
# Initialise the random number generator.
2993
random.seed(self.actual_seed())
2994
suite = randomize_suite(self)
2996
self.addTests(suite)
2997
return iter(self._tests)
2999
def actual_seed(self):
3000
if self.random_seed == "now":
3001
# We convert the seed to a long to make it reuseable across
3002
# invocations (because the user can reenter it).
3003
self.random_seed = long(time.time())
3005
# Convert the seed to a long if we can
3007
self.random_seed = long(self.random_seed)
3010
return self.random_seed
3013
class TestFirstDecorator(TestDecorator):
3014
"""A decorator which moves named tests to the front."""
3016
def __init__(self, suite, pattern):
3017
TestDecorator.__init__(self, suite)
3018
self.pattern = pattern
3019
self.filtered = False
3023
return iter(self._tests)
3024
self.filtered = True
3025
suites = split_suite_by_re(self, self.pattern)
3027
self.addTests(suites)
3028
return iter(self._tests)
3031
def partition_tests(suite, count):
3032
"""Partition suite into count lists of tests."""
3034
tests = list(iter_suite_tests(suite))
3035
tests_per_process = int(math.ceil(float(len(tests)) / count))
3036
for block in range(count):
3037
low_test = block * tests_per_process
3038
high_test = low_test + tests_per_process
3039
process_tests = tests[low_test:high_test]
3040
result.append(process_tests)
3044
def fork_for_tests(suite):
3045
"""Take suite and start up one runner per CPU by forking()
3047
:return: An iterable of TestCase-like objects which can each have
3048
run(result) called on them to feed tests to result.
3050
concurrency = osutils.local_concurrency()
3052
from subunit import TestProtocolClient, ProtocolTestCase
3054
from subunit.test_results import AutoTimingTestResultDecorator
3056
AutoTimingTestResultDecorator = lambda x:x
3057
class TestInOtherProcess(ProtocolTestCase):
3058
# Should be in subunit, I think. RBC.
3059
def __init__(self, stream, pid):
3060
ProtocolTestCase.__init__(self, stream)
3063
def run(self, result):
3065
ProtocolTestCase.run(self, result)
3067
os.waitpid(self.pid, os.WNOHANG)
3069
test_blocks = partition_tests(suite, concurrency)
3070
for process_tests in test_blocks:
3071
process_suite = TestSuite()
3072
process_suite.addTests(process_tests)
3073
c2pread, c2pwrite = os.pipe()
3078
# Leave stderr and stdout open so we can see test noise
3079
# Close stdin so that the child goes away if it decides to
3080
# read from stdin (otherwise its a roulette to see what
3081
# child actually gets keystrokes for pdb etc).
3084
stream = os.fdopen(c2pwrite, 'wb', 1)
3085
subunit_result = AutoTimingTestResultDecorator(
3086
TestProtocolClient(stream))
3087
process_suite.run(subunit_result)
3092
stream = os.fdopen(c2pread, 'rb', 1)
3093
test = TestInOtherProcess(stream, pid)
3098
def reinvoke_for_tests(suite):
3099
"""Take suite and start up one runner per CPU using subprocess().
3101
:return: An iterable of TestCase-like objects which can each have
3102
run(result) called on them to feed tests to result.
3104
concurrency = osutils.local_concurrency()
3106
from subunit import ProtocolTestCase
3107
class TestInSubprocess(ProtocolTestCase):
3108
def __init__(self, process, name):
3109
ProtocolTestCase.__init__(self, process.stdout)
3110
self.process = process
3111
self.process.stdin.close()
3114
def run(self, result):
3116
ProtocolTestCase.run(self, result)
3119
os.unlink(self.name)
3120
# print "pid %d finished" % finished_process
3121
test_blocks = partition_tests(suite, concurrency)
3122
for process_tests in test_blocks:
3123
# ugly; currently reimplement rather than reuses TestCase methods.
3124
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3125
if not os.path.isfile(bzr_path):
3126
# We are probably installed. Assume sys.argv is the right file
3127
bzr_path = sys.argv[0]
3128
fd, test_list_file_name = tempfile.mkstemp()
3129
test_list_file = os.fdopen(fd, 'wb', 1)
3130
for test in process_tests:
3131
test_list_file.write(test.id() + '\n')
3132
test_list_file.close()
3134
argv = [bzr_path, 'selftest', '--load-list', test_list_file_name,
3136
if '--no-plugins' in sys.argv:
3137
argv.append('--no-plugins')
3138
# stderr=STDOUT would be ideal, but until we prevent noise on
3139
# stderr it can interrupt the subunit protocol.
3140
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3142
test = TestInSubprocess(process, test_list_file_name)
3145
os.unlink(test_list_file_name)
3150
class ForwardingResult(unittest.TestResult):
3152
def __init__(self, target):
3153
unittest.TestResult.__init__(self)
3154
self.result = target
3156
def startTest(self, test):
3157
self.result.startTest(test)
3159
def stopTest(self, test):
3160
self.result.stopTest(test)
3162
def startTestRun(self):
3163
self.result.startTestRun()
3165
def stopTestRun(self):
3166
self.result.stopTestRun()
3168
def addSkip(self, test, reason):
3169
self.result.addSkip(test, reason)
3171
def addSuccess(self, test):
3172
self.result.addSuccess(test)
3174
def addError(self, test, err):
3175
self.result.addError(test, err)
3177
def addFailure(self, test, err):
3178
self.result.addFailure(test, err)
3181
class BZRTransformingResult(ForwardingResult):
3183
def addError(self, test, err):
3184
feature = self._error_looks_like('UnavailableFeature: ', err)
3185
if feature is not None:
3186
self.result.addNotSupported(test, feature)
3188
self.result.addError(test, err)
3190
def addFailure(self, test, err):
3191
known = self._error_looks_like('KnownFailure: ', err)
3192
if known is not None:
3193
self.result._addKnownFailure(test, [KnownFailure,
3194
KnownFailure(known), None])
3196
self.result.addFailure(test, err)
3198
def _error_looks_like(self, prefix, err):
3199
"""Deserialize exception and returns the stringify value."""
3203
if isinstance(exc, subunit.RemoteException):
3204
# stringify the exception gives access to the remote traceback
3205
# We search the last line for 'prefix'
3206
lines = str(exc).split('\n')
3207
while lines and not lines[-1]:
3210
if lines[-1].startswith(prefix):
3211
value = lines[-1][len(prefix):]
3215
class ProfileResult(ForwardingResult):
3216
"""Generate profiling data for all activity between start and success.
3218
The profile data is appended to the test's _benchcalls attribute and can
3219
be accessed by the forwarded-to TestResult.
3221
While it might be cleaner do accumulate this in stopTest, addSuccess is
3222
where our existing output support for lsprof is, and this class aims to
3223
fit in with that: while it could be moved it's not necessary to accomplish
3224
test profiling, nor would it be dramatically cleaner.
3227
def startTest(self, test):
3228
self.profiler = bzrlib.lsprof.BzrProfiler()
3229
self.profiler.start()
3230
ForwardingResult.startTest(self, test)
3232
def addSuccess(self, test):
3233
stats = self.profiler.stop()
3235
calls = test._benchcalls
3236
except AttributeError:
3237
test._benchcalls = []
3238
calls = test._benchcalls
3239
calls.append(((test.id(), "", ""), stats))
3240
ForwardingResult.addSuccess(self, test)
3242
def stopTest(self, test):
3243
ForwardingResult.stopTest(self, test)
3244
self.profiler = None
3247
# Controlled by "bzr selftest -E=..." option
3248
# Currently supported:
3249
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3250
# preserves any flags supplied at the command line.
3251
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3252
# rather than failing tests. And no longer raise
3253
# LockContention when fctnl locks are not being used
3254
# with proper exclusion rules.
3255
selftest_debug_flags = set()
3258
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3260
test_suite_factory=None,
3263
matching_tests_first=None,
3266
exclude_pattern=None,
3272
suite_decorators=None,
3276
"""Run the whole test suite under the enhanced runner"""
3277
# XXX: Very ugly way to do this...
3278
# Disable warning about old formats because we don't want it to disturb
3279
# any blackbox tests.
3280
from bzrlib import repository
3281
repository._deprecation_warning_done = True
3283
global default_transport
3284
if transport is None:
3285
transport = default_transport
3286
old_transport = default_transport
3287
default_transport = transport
3288
global selftest_debug_flags
3289
old_debug_flags = selftest_debug_flags
3290
if debug_flags is not None:
3291
selftest_debug_flags = set(debug_flags)
3293
if load_list is None:
3296
keep_only = load_test_id_list(load_list)
3298
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3299
for start in starting_with]
3300
if test_suite_factory is None:
3301
# Reduce loading time by loading modules based on the starting_with
3303
suite = test_suite(keep_only, starting_with)
3305
suite = test_suite_factory()
3307
# But always filter as requested.
3308
suite = filter_suite_by_id_startswith(suite, starting_with)
3309
result_decorators = []
3311
result_decorators.append(ProfileResult)
3312
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3313
stop_on_failure=stop_on_failure,
3314
transport=transport,
3315
lsprof_timed=lsprof_timed,
3316
bench_history=bench_history,
3317
matching_tests_first=matching_tests_first,
3318
list_only=list_only,
3319
random_seed=random_seed,
3320
exclude_pattern=exclude_pattern,
3322
runner_class=runner_class,
3323
suite_decorators=suite_decorators,
3325
result_decorators=result_decorators,
3328
default_transport = old_transport
3329
selftest_debug_flags = old_debug_flags
3332
def load_test_id_list(file_name):
3333
"""Load a test id list from a text file.
3335
The format is one test id by line. No special care is taken to impose
3336
strict rules, these test ids are used to filter the test suite so a test id
3337
that do not match an existing test will do no harm. This allows user to add
3338
comments, leave blank lines, etc.
3342
ftest = open(file_name, 'rt')
3344
if e.errno != errno.ENOENT:
3347
raise errors.NoSuchFile(file_name)
3349
for test_name in ftest.readlines():
3350
test_list.append(test_name.strip())
3355
def suite_matches_id_list(test_suite, id_list):
3356
"""Warns about tests not appearing or appearing more than once.
3358
:param test_suite: A TestSuite object.
3359
:param test_id_list: The list of test ids that should be found in
3362
:return: (absents, duplicates) absents is a list containing the test found
3363
in id_list but not in test_suite, duplicates is a list containing the
3364
test found multiple times in test_suite.
3366
When using a prefined test id list, it may occurs that some tests do not
3367
exist anymore or that some tests use the same id. This function warns the
3368
tester about potential problems in his workflow (test lists are volatile)
3369
or in the test suite itself (using the same id for several tests does not
3370
help to localize defects).
3372
# Build a dict counting id occurrences
3374
for test in iter_suite_tests(test_suite):
3376
tests[id] = tests.get(id, 0) + 1
3381
occurs = tests.get(id, 0)
3383
not_found.append(id)
3385
duplicates.append(id)
3387
return not_found, duplicates
3390
class TestIdList(object):
3391
"""Test id list to filter a test suite.
3393
Relying on the assumption that test ids are built as:
3394
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3395
notation, this class offers methods to :
3396
- avoid building a test suite for modules not refered to in the test list,
3397
- keep only the tests listed from the module test suite.
3400
def __init__(self, test_id_list):
3401
# When a test suite needs to be filtered against us we compare test ids
3402
# for equality, so a simple dict offers a quick and simple solution.
3403
self.tests = dict().fromkeys(test_id_list, True)
3405
# While unittest.TestCase have ids like:
3406
# <module>.<class>.<method>[(<param+)],
3407
# doctest.DocTestCase can have ids like:
3410
# <module>.<function>
3411
# <module>.<class>.<method>
3413
# Since we can't predict a test class from its name only, we settle on
3414
# a simple constraint: a test id always begins with its module name.
3417
for test_id in test_id_list:
3418
parts = test_id.split('.')
3419
mod_name = parts.pop(0)
3420
modules[mod_name] = True
3422
mod_name += '.' + part
3423
modules[mod_name] = True
3424
self.modules = modules
3426
def refers_to(self, module_name):
3427
"""Is there tests for the module or one of its sub modules."""
3428
return self.modules.has_key(module_name)
3430
def includes(self, test_id):
3431
return self.tests.has_key(test_id)
3434
class TestPrefixAliasRegistry(registry.Registry):
3435
"""A registry for test prefix aliases.
3437
This helps implement shorcuts for the --starting-with selftest
3438
option. Overriding existing prefixes is not allowed but not fatal (a
3439
warning will be emitted).
3442
def register(self, key, obj, help=None, info=None,
3443
override_existing=False):
3444
"""See Registry.register.
3446
Trying to override an existing alias causes a warning to be emitted,
3447
not a fatal execption.
3450
super(TestPrefixAliasRegistry, self).register(
3451
key, obj, help=help, info=info, override_existing=False)
3453
actual = self.get(key)
3454
note('Test prefix alias %s is already used for %s, ignoring %s'
3455
% (key, actual, obj))
3457
def resolve_alias(self, id_start):
3458
"""Replace the alias by the prefix in the given string.
3460
Using an unknown prefix is an error to help catching typos.
3462
parts = id_start.split('.')
3464
parts[0] = self.get(parts[0])
3466
raise errors.BzrCommandError(
3467
'%s is not a known test prefix alias' % parts[0])
3468
return '.'.join(parts)
3471
test_prefix_alias_registry = TestPrefixAliasRegistry()
3472
"""Registry of test prefix aliases."""
3475
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3476
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3477
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3479
# Obvious higest levels prefixes, feel free to add your own via a plugin
3480
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3481
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3482
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3483
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3484
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3487
def _test_suite_testmod_names():
3488
"""Return the standard list of test module names to test."""
3491
'bzrlib.tests.blackbox',
3492
'bzrlib.tests.commands',
3493
'bzrlib.tests.per_branch',
3494
'bzrlib.tests.per_bzrdir',
3495
'bzrlib.tests.per_interrepository',
3496
'bzrlib.tests.per_intertree',
3497
'bzrlib.tests.per_inventory',
3498
'bzrlib.tests.per_interbranch',
3499
'bzrlib.tests.per_lock',
3500
'bzrlib.tests.per_transport',
3501
'bzrlib.tests.per_tree',
3502
'bzrlib.tests.per_pack_repository',
3503
'bzrlib.tests.per_repository',
3504
'bzrlib.tests.per_repository_chk',
3505
'bzrlib.tests.per_repository_reference',
3506
'bzrlib.tests.per_versionedfile',
3507
'bzrlib.tests.per_workingtree',
3508
'bzrlib.tests.test__annotator',
3509
'bzrlib.tests.test__chk_map',
3510
'bzrlib.tests.test__dirstate_helpers',
3511
'bzrlib.tests.test__groupcompress',
3512
'bzrlib.tests.test__known_graph',
3513
'bzrlib.tests.test__rio',
3514
'bzrlib.tests.test__walkdirs_win32',
3515
'bzrlib.tests.test_ancestry',
3516
'bzrlib.tests.test_annotate',
3517
'bzrlib.tests.test_api',
3518
'bzrlib.tests.test_atomicfile',
3519
'bzrlib.tests.test_bad_files',
3520
'bzrlib.tests.test_bencode',
3521
'bzrlib.tests.test_bisect_multi',
3522
'bzrlib.tests.test_branch',
3523
'bzrlib.tests.test_branchbuilder',
3524
'bzrlib.tests.test_btree_index',
3525
'bzrlib.tests.test_bugtracker',
3526
'bzrlib.tests.test_bundle',
3527
'bzrlib.tests.test_bzrdir',
3528
'bzrlib.tests.test__chunks_to_lines',
3529
'bzrlib.tests.test_cache_utf8',
3530
'bzrlib.tests.test_chk_map',
3531
'bzrlib.tests.test_chk_serializer',
3532
'bzrlib.tests.test_chunk_writer',
3533
'bzrlib.tests.test_clean_tree',
3534
'bzrlib.tests.test_commands',
3535
'bzrlib.tests.test_commit',
3536
'bzrlib.tests.test_commit_merge',
3537
'bzrlib.tests.test_config',
3538
'bzrlib.tests.test_conflicts',
3539
'bzrlib.tests.test_counted_lock',
3540
'bzrlib.tests.test_crash',
3541
'bzrlib.tests.test_decorators',
3542
'bzrlib.tests.test_delta',
3543
'bzrlib.tests.test_debug',
3544
'bzrlib.tests.test_deprecated_graph',
3545
'bzrlib.tests.test_diff',
3546
'bzrlib.tests.test_directory_service',
3547
'bzrlib.tests.test_dirstate',
3548
'bzrlib.tests.test_email_message',
3549
'bzrlib.tests.test_eol_filters',
3550
'bzrlib.tests.test_errors',
3551
'bzrlib.tests.test_export',
3552
'bzrlib.tests.test_extract',
3553
'bzrlib.tests.test_fetch',
3554
'bzrlib.tests.test_fifo_cache',
3555
'bzrlib.tests.test_filters',
3556
'bzrlib.tests.test_ftp_transport',
3557
'bzrlib.tests.test_foreign',
3558
'bzrlib.tests.test_generate_docs',
3559
'bzrlib.tests.test_generate_ids',
3560
'bzrlib.tests.test_globbing',
3561
'bzrlib.tests.test_gpg',
3562
'bzrlib.tests.test_graph',
3563
'bzrlib.tests.test_groupcompress',
3564
'bzrlib.tests.test_hashcache',
3565
'bzrlib.tests.test_help',
3566
'bzrlib.tests.test_hooks',
3567
'bzrlib.tests.test_http',
3568
'bzrlib.tests.test_http_response',
3569
'bzrlib.tests.test_https_ca_bundle',
3570
'bzrlib.tests.test_identitymap',
3571
'bzrlib.tests.test_ignores',
3572
'bzrlib.tests.test_index',
3573
'bzrlib.tests.test_info',
3574
'bzrlib.tests.test_inv',
3575
'bzrlib.tests.test_inventory_delta',
3576
'bzrlib.tests.test_knit',
3577
'bzrlib.tests.test_lazy_import',
3578
'bzrlib.tests.test_lazy_regex',
3579
'bzrlib.tests.test_lock',
3580
'bzrlib.tests.test_lockable_files',
3581
'bzrlib.tests.test_lockdir',
3582
'bzrlib.tests.test_log',
3583
'bzrlib.tests.test_lru_cache',
3584
'bzrlib.tests.test_lsprof',
3585
'bzrlib.tests.test_mail_client',
3586
'bzrlib.tests.test_memorytree',
3587
'bzrlib.tests.test_merge',
3588
'bzrlib.tests.test_merge3',
3589
'bzrlib.tests.test_merge_core',
3590
'bzrlib.tests.test_merge_directive',
3591
'bzrlib.tests.test_missing',
3592
'bzrlib.tests.test_msgeditor',
3593
'bzrlib.tests.test_multiparent',
3594
'bzrlib.tests.test_mutabletree',
3595
'bzrlib.tests.test_nonascii',
3596
'bzrlib.tests.test_options',
3597
'bzrlib.tests.test_osutils',
3598
'bzrlib.tests.test_osutils_encodings',
3599
'bzrlib.tests.test_pack',
3600
'bzrlib.tests.test_patch',
3601
'bzrlib.tests.test_patches',
3602
'bzrlib.tests.test_permissions',
3603
'bzrlib.tests.test_plugins',
3604
'bzrlib.tests.test_progress',
3605
'bzrlib.tests.test_read_bundle',
3606
'bzrlib.tests.test_reconcile',
3607
'bzrlib.tests.test_reconfigure',
3608
'bzrlib.tests.test_registry',
3609
'bzrlib.tests.test_remote',
3610
'bzrlib.tests.test_rename_map',
3611
'bzrlib.tests.test_repository',
3612
'bzrlib.tests.test_revert',
3613
'bzrlib.tests.test_revision',
3614
'bzrlib.tests.test_revisionspec',
3615
'bzrlib.tests.test_revisiontree',
3616
'bzrlib.tests.test_rio',
3617
'bzrlib.tests.test_rules',
3618
'bzrlib.tests.test_sampler',
3619
'bzrlib.tests.test_selftest',
3620
'bzrlib.tests.test_serializer',
3621
'bzrlib.tests.test_setup',
3622
'bzrlib.tests.test_sftp_transport',
3623
'bzrlib.tests.test_shelf',
3624
'bzrlib.tests.test_shelf_ui',
3625
'bzrlib.tests.test_smart',
3626
'bzrlib.tests.test_smart_add',
3627
'bzrlib.tests.test_smart_request',
3628
'bzrlib.tests.test_smart_transport',
3629
'bzrlib.tests.test_smtp_connection',
3630
'bzrlib.tests.test_source',
3631
'bzrlib.tests.test_ssh_transport',
3632
'bzrlib.tests.test_status',
3633
'bzrlib.tests.test_store',
3634
'bzrlib.tests.test_strace',
3635
'bzrlib.tests.test_subsume',
3636
'bzrlib.tests.test_switch',
3637
'bzrlib.tests.test_symbol_versioning',
3638
'bzrlib.tests.test_tag',
3639
'bzrlib.tests.test_testament',
3640
'bzrlib.tests.test_textfile',
3641
'bzrlib.tests.test_textmerge',
3642
'bzrlib.tests.test_timestamp',
3643
'bzrlib.tests.test_trace',
3644
'bzrlib.tests.test_transactions',
3645
'bzrlib.tests.test_transform',
3646
'bzrlib.tests.test_transport',
3647
'bzrlib.tests.test_transport_log',
3648
'bzrlib.tests.test_tree',
3649
'bzrlib.tests.test_treebuilder',
3650
'bzrlib.tests.test_tsort',
3651
'bzrlib.tests.test_tuned_gzip',
3652
'bzrlib.tests.test_ui',
3653
'bzrlib.tests.test_uncommit',
3654
'bzrlib.tests.test_upgrade',
3655
'bzrlib.tests.test_upgrade_stacked',
3656
'bzrlib.tests.test_urlutils',
3657
'bzrlib.tests.test_version',
3658
'bzrlib.tests.test_version_info',
3659
'bzrlib.tests.test_weave',
3660
'bzrlib.tests.test_whitebox',
3661
'bzrlib.tests.test_win32utils',
3662
'bzrlib.tests.test_workingtree',
3663
'bzrlib.tests.test_workingtree_4',
3664
'bzrlib.tests.test_wsgi',
3665
'bzrlib.tests.test_xml',
3669
def _test_suite_modules_to_doctest():
3670
"""Return the list of modules to doctest."""
3673
'bzrlib.branchbuilder',
3676
'bzrlib.iterablefile',
3680
'bzrlib.symbol_versioning',
3683
'bzrlib.version_info_formats.format_custom',
3687
def test_suite(keep_only=None, starting_with=None):
3688
"""Build and return TestSuite for the whole of bzrlib.
3690
:param keep_only: A list of test ids limiting the suite returned.
3692
:param starting_with: An id limiting the suite returned to the tests
3695
This function can be replaced if you need to change the default test
3696
suite on a global basis, but it is not encouraged.
3699
loader = TestUtil.TestLoader()
3701
if keep_only is not None:
3702
id_filter = TestIdList(keep_only)
3704
# We take precedence over keep_only because *at loading time* using
3705
# both options means we will load less tests for the same final result.
3706
def interesting_module(name):
3707
for start in starting_with:
3709
# Either the module name starts with the specified string
3710
name.startswith(start)
3711
# or it may contain tests starting with the specified string
3712
or start.startswith(name)
3716
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3718
elif keep_only is not None:
3719
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3720
def interesting_module(name):
3721
return id_filter.refers_to(name)
3724
loader = TestUtil.TestLoader()
3725
def interesting_module(name):
3726
# No filtering, all modules are interesting
3729
suite = loader.suiteClass()
3731
# modules building their suite with loadTestsFromModuleNames
3732
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3734
for mod in _test_suite_modules_to_doctest():
3735
if not interesting_module(mod):
3736
# No tests to keep here, move along
3739
# note that this really does mean "report only" -- doctest
3740
# still runs the rest of the examples
3741
doc_suite = doctest.DocTestSuite(mod,
3742
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3743
except ValueError, e:
3744
print '**failed to get doctest for: %s\n%s' % (mod, e)
3746
if len(doc_suite._tests) == 0:
3747
raise errors.BzrError("no doctests found in %s" % (mod,))
3748
suite.addTest(doc_suite)
3750
default_encoding = sys.getdefaultencoding()
3751
for name, plugin in bzrlib.plugin.plugins().items():
3752
if not interesting_module(plugin.module.__name__):
3754
plugin_suite = plugin.test_suite()
3755
# We used to catch ImportError here and turn it into just a warning,
3756
# but really if you don't have --no-plugins this should be a failure.
3757
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3758
if plugin_suite is None:
3759
plugin_suite = plugin.load_plugin_tests(loader)
3760
if plugin_suite is not None:
3761
suite.addTest(plugin_suite)
3762
if default_encoding != sys.getdefaultencoding():
3763
bzrlib.trace.warning(
3764
'Plugin "%s" tried to reset default encoding to: %s', name,
3765
sys.getdefaultencoding())
3767
sys.setdefaultencoding(default_encoding)
3769
if keep_only is not None:
3770
# Now that the referred modules have loaded their tests, keep only the
3772
suite = filter_suite_by_id_list(suite, id_filter)
3773
# Do some sanity checks on the id_list filtering
3774
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3776
# The tester has used both keep_only and starting_with, so he is
3777
# already aware that some tests are excluded from the list, there
3778
# is no need to tell him which.
3781
# Some tests mentioned in the list are not in the test suite. The
3782
# list may be out of date, report to the tester.
3783
for id in not_found:
3784
bzrlib.trace.warning('"%s" not found in the test suite', id)
3785
for id in duplicates:
3786
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3791
def multiply_scenarios(scenarios_left, scenarios_right):
3792
"""Multiply two sets of scenarios.
3794
:returns: the cartesian product of the two sets of scenarios, that is
3795
a scenario for every possible combination of a left scenario and a
3799
('%s,%s' % (left_name, right_name),
3800
dict(left_dict.items() + right_dict.items()))
3801
for left_name, left_dict in scenarios_left
3802
for right_name, right_dict in scenarios_right]
3805
def multiply_tests(tests, scenarios, result):
3806
"""Multiply tests_list by scenarios into result.
3808
This is the core workhorse for test parameterisation.
3810
Typically the load_tests() method for a per-implementation test suite will
3811
call multiply_tests and return the result.
3813
:param tests: The tests to parameterise.
3814
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3815
scenario_param_dict).
3816
:param result: A TestSuite to add created tests to.
3818
This returns the passed in result TestSuite with the cross product of all
3819
the tests repeated once for each scenario. Each test is adapted by adding
3820
the scenario name at the end of its id(), and updating the test object's
3821
__dict__ with the scenario_param_dict.
3823
>>> import bzrlib.tests.test_sampler
3824
>>> r = multiply_tests(
3825
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3826
... [('one', dict(param=1)),
3827
... ('two', dict(param=2))],
3829
>>> tests = list(iter_suite_tests(r))
3833
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3839
for test in iter_suite_tests(tests):
3840
apply_scenarios(test, scenarios, result)
3844
def apply_scenarios(test, scenarios, result):
3845
"""Apply the scenarios in scenarios to test and add to result.
3847
:param test: The test to apply scenarios to.
3848
:param scenarios: An iterable of scenarios to apply to test.
3850
:seealso: apply_scenario
3852
for scenario in scenarios:
3853
result.addTest(apply_scenario(test, scenario))
3857
def apply_scenario(test, scenario):
3858
"""Copy test and apply scenario to it.
3860
:param test: A test to adapt.
3861
:param scenario: A tuple describing the scenarion.
3862
The first element of the tuple is the new test id.
3863
The second element is a dict containing attributes to set on the
3865
:return: The adapted test.
3867
new_id = "%s(%s)" % (test.id(), scenario[0])
3868
new_test = clone_test(test, new_id)
3869
for name, value in scenario[1].items():
3870
setattr(new_test, name, value)
3874
def clone_test(test, new_id):
3875
"""Clone a test giving it a new id.
3877
:param test: The test to clone.
3878
:param new_id: The id to assign to it.
3879
:return: The new test.
3881
new_test = copy(test)
3882
new_test.id = lambda: new_id
3886
def _rmtree_temp_dir(dirname):
3887
# If LANG=C we probably have created some bogus paths
3888
# which rmtree(unicode) will fail to delete
3889
# so make sure we are using rmtree(str) to delete everything
3890
# except on win32, where rmtree(str) will fail
3891
# since it doesn't have the property of byte-stream paths
3892
# (they are either ascii or mbcs)
3893
if sys.platform == 'win32':
3894
# make sure we are using the unicode win32 api
3895
dirname = unicode(dirname)
3897
dirname = dirname.encode(sys.getfilesystemencoding())
3899
osutils.rmtree(dirname)
3901
# We don't want to fail here because some useful display will be lost
3902
# otherwise. Polluting the tmp dir is bad, but not giving all the
3903
# possible info to the test runner is even worse.
3904
sys.stderr.write('Unable to remove testing dir %s\n%s'
3905
% (os.path.basename(dirname), e))
3908
class Feature(object):
3909
"""An operating system Feature."""
3912
self._available = None
3914
def available(self):
3915
"""Is the feature available?
3917
:return: True if the feature is available.
3919
if self._available is None:
3920
self._available = self._probe()
3921
return self._available
3924
"""Implement this method in concrete features.
3926
:return: True if the feature is available.
3928
raise NotImplementedError
3931
if getattr(self, 'feature_name', None):
3932
return self.feature_name()
3933
return self.__class__.__name__
3936
class _SymlinkFeature(Feature):
3939
return osutils.has_symlinks()
3941
def feature_name(self):
3944
SymlinkFeature = _SymlinkFeature()
3947
class _HardlinkFeature(Feature):
3950
return osutils.has_hardlinks()
3952
def feature_name(self):
3955
HardlinkFeature = _HardlinkFeature()
3958
class _OsFifoFeature(Feature):
3961
return getattr(os, 'mkfifo', None)
3963
def feature_name(self):
3964
return 'filesystem fifos'
3966
OsFifoFeature = _OsFifoFeature()
3969
class _UnicodeFilenameFeature(Feature):
3970
"""Does the filesystem support Unicode filenames?"""
3974
# Check for character combinations unlikely to be covered by any
3975
# single non-unicode encoding. We use the characters
3976
# - greek small letter alpha (U+03B1) and
3977
# - braille pattern dots-123456 (U+283F).
3978
os.stat(u'\u03b1\u283f')
3979
except UnicodeEncodeError:
3981
except (IOError, OSError):
3982
# The filesystem allows the Unicode filename but the file doesn't
3986
# The filesystem allows the Unicode filename and the file exists,
3990
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3993
def probe_unicode_in_user_encoding():
3994
"""Try to encode several unicode strings to use in unicode-aware tests.
3995
Return first successfull match.
3997
:return: (unicode value, encoded plain string value) or (None, None)
3999
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4000
for uni_val in possible_vals:
4002
str_val = uni_val.encode(osutils.get_user_encoding())
4003
except UnicodeEncodeError:
4004
# Try a different character
4007
return uni_val, str_val
4011
def probe_bad_non_ascii(encoding):
4012
"""Try to find [bad] character with code [128..255]
4013
that cannot be decoded to unicode in some encoding.
4014
Return None if all non-ascii characters is valid
4017
for i in xrange(128, 256):
4020
char.decode(encoding)
4021
except UnicodeDecodeError:
4026
class _HTTPSServerFeature(Feature):
4027
"""Some tests want an https Server, check if one is available.
4029
Right now, the only way this is available is under python2.6 which provides
4040
def feature_name(self):
4041
return 'HTTPSServer'
4044
HTTPSServerFeature = _HTTPSServerFeature()
4047
class _UnicodeFilename(Feature):
4048
"""Does the filesystem support Unicode filenames?"""
4053
except UnicodeEncodeError:
4055
except (IOError, OSError):
4056
# The filesystem allows the Unicode filename but the file doesn't
4060
# The filesystem allows the Unicode filename and the file exists,
4064
UnicodeFilename = _UnicodeFilename()
4067
class _UTF8Filesystem(Feature):
4068
"""Is the filesystem UTF-8?"""
4071
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4075
UTF8Filesystem = _UTF8Filesystem()
4078
class _CaseInsCasePresFilenameFeature(Feature):
4079
"""Is the file-system case insensitive, but case-preserving?"""
4082
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4084
# first check truly case-preserving for created files, then check
4085
# case insensitive when opening existing files.
4086
name = osutils.normpath(name)
4087
base, rel = osutils.split(name)
4088
found_rel = osutils.canonical_relpath(base, name)
4089
return (found_rel == rel
4090
and os.path.isfile(name.upper())
4091
and os.path.isfile(name.lower()))
4096
def feature_name(self):
4097
return "case-insensitive case-preserving filesystem"
4099
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4102
class _CaseInsensitiveFilesystemFeature(Feature):
4103
"""Check if underlying filesystem is case-insensitive but *not* case
4106
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4107
# more likely to be case preserving, so this case is rare.
4110
if CaseInsCasePresFilenameFeature.available():
4113
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4114
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4115
TestCaseWithMemoryTransport.TEST_ROOT = root
4117
root = TestCaseWithMemoryTransport.TEST_ROOT
4118
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4120
name_a = osutils.pathjoin(tdir, 'a')
4121
name_A = osutils.pathjoin(tdir, 'A')
4123
result = osutils.isdir(name_A)
4124
_rmtree_temp_dir(tdir)
4127
def feature_name(self):
4128
return 'case-insensitive filesystem'
4130
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4133
class _SubUnitFeature(Feature):
4134
"""Check if subunit is available."""
4143
def feature_name(self):
4146
SubUnitFeature = _SubUnitFeature()
4147
# Only define SubUnitBzrRunner if subunit is available.
4149
from subunit import TestProtocolClient
4151
from subunit.test_results import AutoTimingTestResultDecorator
4153
AutoTimingTestResultDecorator = lambda x:x
4154
class SubUnitBzrRunner(TextTestRunner):
4155
def run(self, test):
4156
result = AutoTimingTestResultDecorator(
4157
TestProtocolClient(self.stream))
added
removed
bzrlib/tests/__init__.py
