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
70
import bzrlib.commands
71
import bzrlib.timestamp
73
import bzrlib.inventory
74
import bzrlib.iterablefile
79
# lsprof not available
81
from bzrlib.merge import merge_inner
84
from bzrlib.smart import client, request, server
86
from bzrlib import symbol_versioning
87
from bzrlib.symbol_versioning import (
94
from bzrlib.transport import get_transport, pathfilter
95
import bzrlib.transport
96
from bzrlib.transport.local import LocalURLServer
97
from bzrlib.transport.memory import MemoryServer
98
from bzrlib.transport.readonly import ReadonlyServer
99
from bzrlib.trace import mutter, note
100
from bzrlib.tests import TestUtil
101
from bzrlib.tests.http_server import HttpServer
102
from bzrlib.tests.TestUtil import (
106
from bzrlib.tests.treeshape import build_tree_contents
107
from bzrlib.ui import NullProgressView
108
from bzrlib.ui.text import TextUIFactory
109
import bzrlib.version_info_formats.format_custom
110
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
112
# Mark this python module as being part of the implementation
113
# of unittest: this gives us better tracebacks where the last
114
# shown frame is the test code, not our assertXYZ.
117
default_transport = LocalURLServer
119
# Subunit result codes, defined here to prevent a hard dependency on subunit.
124
class ExtendedTestResult(unittest._TextTestResult):
125
"""Accepts, reports and accumulates the results of running tests.
127
Compared to the unittest version this class adds support for
128
profiling, benchmarking, stopping as soon as a test fails, and
129
skipping tests. There are further-specialized subclasses for
130
different types of display.
132
When a test finishes, in whatever way, it calls one of the addSuccess,
133
addFailure or addError classes. These in turn may redirect to a more
134
specific case for the special test results supported by our extended
137
Note that just one of these objects is fed the results from many tests.
142
def __init__(self, stream, descriptions, verbosity,
146
"""Construct new TestResult.
148
:param bench_history: Optionally, a writable file object to accumulate
151
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
152
if bench_history is not None:
153
from bzrlib.version import _get_bzr_source_tree
154
src_tree = _get_bzr_source_tree()
157
revision_id = src_tree.get_parent_ids()[0]
159
# XXX: if this is a brand new tree, do the same as if there
163
# XXX: If there's no branch, what should we do?
165
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
166
self._bench_history = bench_history
167
self.ui = ui.ui_factory
170
self.failure_count = 0
171
self.known_failure_count = 0
173
self.not_applicable_count = 0
174
self.unsupported = {}
176
self._overall_start_time = time.time()
177
self._strict = strict
179
def stopTestRun(self):
182
stopTime = time.time()
183
timeTaken = stopTime - self.startTime
185
self.stream.writeln(self.separator2)
186
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
187
run, run != 1 and "s" or "", timeTaken))
188
self.stream.writeln()
189
if not self.wasSuccessful():
190
self.stream.write("FAILED (")
191
failed, errored = map(len, (self.failures, self.errors))
193
self.stream.write("failures=%d" % failed)
195
if failed: self.stream.write(", ")
196
self.stream.write("errors=%d" % errored)
197
if self.known_failure_count:
198
if failed or errored: self.stream.write(", ")
199
self.stream.write("known_failure_count=%d" %
200
self.known_failure_count)
201
self.stream.writeln(")")
203
if self.known_failure_count:
204
self.stream.writeln("OK (known_failures=%d)" %
205
self.known_failure_count)
207
self.stream.writeln("OK")
208
if self.skip_count > 0:
209
skipped = self.skip_count
210
self.stream.writeln('%d test%s skipped' %
211
(skipped, skipped != 1 and "s" or ""))
213
for feature, count in sorted(self.unsupported.items()):
214
self.stream.writeln("Missing feature '%s' skipped %d tests." %
217
ok = self.wasStrictlySuccessful()
219
ok = self.wasSuccessful()
220
if TestCase._first_thread_leaker_id:
222
'%s is leaking threads among %d leaking tests.\n' % (
223
TestCase._first_thread_leaker_id,
224
TestCase._leaking_threads_tests))
226
def _extractBenchmarkTime(self, testCase):
227
"""Add a benchmark time for the current test case."""
228
return getattr(testCase, "_benchtime", None)
230
def _elapsedTestTimeString(self):
231
"""Return a time string for the overall time the current test has taken."""
232
return self._formatTime(time.time() - self._start_time)
234
def _testTimeString(self, testCase):
235
benchmark_time = self._extractBenchmarkTime(testCase)
236
if benchmark_time is not None:
237
return self._formatTime(benchmark_time) + "*"
239
return self._elapsedTestTimeString()
241
def _formatTime(self, seconds):
242
"""Format seconds as milliseconds with leading spaces."""
243
# some benchmarks can take thousands of seconds to run, so we need 8
245
return "%8dms" % (1000 * seconds)
247
def _shortened_test_description(self, test):
249
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
252
def startTest(self, test):
253
unittest.TestResult.startTest(self, test)
256
self.report_test_start(test)
257
test.number = self.count
258
self._recordTestStartTime()
260
def startTests(self):
262
if getattr(sys, 'frozen', None) is None:
263
bzr_path = osutils.realpath(sys.argv[0])
265
bzr_path = sys.executable
267
'testing: %s\n' % (bzr_path,))
270
bzrlib.__path__[0],))
272
' bzr-%s python-%s %s\n' % (
273
bzrlib.version_string,
274
bzrlib._format_version_tuple(sys.version_info),
275
platform.platform(aliased=1),
277
self.stream.write('\n')
279
def _recordTestStartTime(self):
280
"""Record that a test has started."""
281
self._start_time = time.time()
283
def _cleanupLogFile(self, test):
284
# We can only do this if we have one of our TestCases, not if
286
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
287
if setKeepLogfile is not None:
290
def addError(self, test, err):
291
"""Tell result that test finished with an error.
293
Called from the TestCase run() method when the test
294
fails with an unexpected error.
296
self._testConcluded(test)
297
if isinstance(err[1], TestNotApplicable):
298
return self._addNotApplicable(test, err)
299
elif isinstance(err[1], UnavailableFeature):
300
return self.addNotSupported(test, err[1].args[0])
303
unittest.TestResult.addError(self, test, err)
304
self.error_count += 1
305
self.report_error(test, err)
308
self._cleanupLogFile(test)
310
def addFailure(self, test, err):
311
"""Tell result that test failed.
313
Called from the TestCase run() method when the test
314
fails because e.g. an assert() method failed.
316
self._testConcluded(test)
317
if isinstance(err[1], KnownFailure):
318
return self._addKnownFailure(test, err)
321
unittest.TestResult.addFailure(self, test, err)
322
self.failure_count += 1
323
self.report_failure(test, err)
326
self._cleanupLogFile(test)
328
def addSuccess(self, test):
329
"""Tell result that test completed successfully.
331
Called from the TestCase run()
333
self._testConcluded(test)
334
if self._bench_history is not None:
335
benchmark_time = self._extractBenchmarkTime(test)
336
if benchmark_time is not None:
337
self._bench_history.write("%s %s\n" % (
338
self._formatTime(benchmark_time),
340
self.report_success(test)
341
self._cleanupLogFile(test)
342
unittest.TestResult.addSuccess(self, test)
343
test._log_contents = ''
345
def _testConcluded(self, test):
346
"""Common code when a test has finished.
348
Called regardless of whether it succeded, failed, etc.
352
def _addKnownFailure(self, test, err):
353
self.known_failure_count += 1
354
self.report_known_failure(test, err)
356
def addNotSupported(self, test, feature):
357
"""The test will not be run because of a missing feature.
359
# this can be called in two different ways: it may be that the
360
# test started running, and then raised (through addError)
361
# UnavailableFeature. Alternatively this method can be called
362
# while probing for features before running the tests; in that
363
# case we will see startTest and stopTest, but the test will never
365
self.unsupported.setdefault(str(feature), 0)
366
self.unsupported[str(feature)] += 1
367
self.report_unsupported(test, feature)
369
def addSkip(self, test, reason):
370
"""A test has not run for 'reason'."""
372
self.report_skip(test, reason)
374
def _addNotApplicable(self, test, skip_excinfo):
375
if isinstance(skip_excinfo[1], TestNotApplicable):
376
self.not_applicable_count += 1
377
self.report_not_applicable(test, skip_excinfo)
380
except KeyboardInterrupt:
383
self.addError(test, test.exc_info())
385
# seems best to treat this as success from point-of-view of unittest
386
# -- it actually does nothing so it barely matters :)
387
unittest.TestResult.addSuccess(self, test)
388
test._log_contents = ''
390
def printErrorList(self, flavour, errors):
391
for test, err in errors:
392
self.stream.writeln(self.separator1)
393
self.stream.write("%s: " % flavour)
394
self.stream.writeln(self.getDescription(test))
395
if getattr(test, '_get_log', None) is not None:
396
log_contents = test._get_log()
398
self.stream.write('\n')
400
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
401
self.stream.write('\n')
402
self.stream.write(log_contents)
403
self.stream.write('\n')
405
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
406
self.stream.write('\n')
407
self.stream.writeln(self.separator2)
408
self.stream.writeln("%s" % err)
410
def _post_mortem(self):
411
"""Start a PDB post mortem session."""
412
if os.environ.get('BZR_TEST_PDB', None):
413
import pdb;pdb.post_mortem()
415
def progress(self, offset, whence):
416
"""The test is adjusting the count of tests to run."""
417
if whence == SUBUNIT_SEEK_SET:
418
self.num_tests = offset
419
elif whence == SUBUNIT_SEEK_CUR:
420
self.num_tests += offset
422
raise errors.BzrError("Unknown whence %r" % whence)
424
def report_cleaning_up(self):
427
def startTestRun(self):
428
self.startTime = time.time()
430
def report_success(self, test):
433
def wasStrictlySuccessful(self):
434
if self.unsupported or self.known_failure_count:
436
return self.wasSuccessful()
439
class TextTestResult(ExtendedTestResult):
440
"""Displays progress and results of tests in text form"""
442
def __init__(self, stream, descriptions, verbosity,
447
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
448
bench_history, strict)
449
# We no longer pass them around, but just rely on the UIFactory stack
452
warnings.warn("Passing pb to TextTestResult is deprecated")
453
self.pb = self.ui.nested_progress_bar()
454
self.pb.show_pct = False
455
self.pb.show_spinner = False
456
self.pb.show_eta = False,
457
self.pb.show_count = False
458
self.pb.show_bar = False
459
self.pb.update_latency = 0
460
self.pb.show_transport_activity = False
462
def stopTestRun(self):
463
# called when the tests that are going to run have run
466
super(TextTestResult, self).stopTestRun()
468
def startTestRun(self):
469
super(TextTestResult, self).startTestRun()
470
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
472
def printErrors(self):
473
# clear the pb to make room for the error listing
475
super(TextTestResult, self).printErrors()
477
def _progress_prefix_text(self):
478
# the longer this text, the less space we have to show the test
480
a = '[%d' % self.count # total that have been run
481
# tests skipped as known not to be relevant are not important enough
483
## if self.skip_count:
484
## a += ', %d skip' % self.skip_count
485
## if self.known_failure_count:
486
## a += '+%dX' % self.known_failure_count
488
a +='/%d' % self.num_tests
490
runtime = time.time() - self._overall_start_time
492
a += '%dm%ds' % (runtime / 60, runtime % 60)
496
a += ', %d err' % self.error_count
497
if self.failure_count:
498
a += ', %d fail' % self.failure_count
500
a += ', %d missing' % len(self.unsupported)
504
def report_test_start(self, test):
507
self._progress_prefix_text()
509
+ self._shortened_test_description(test))
511
def _test_description(self, test):
512
return self._shortened_test_description(test)
514
def report_error(self, test, err):
515
self.pb.note('ERROR: %s\n %s\n',
516
self._test_description(test),
520
def report_failure(self, test, err):
521
self.pb.note('FAIL: %s\n %s\n',
522
self._test_description(test),
526
def report_known_failure(self, test, err):
527
self.pb.note('XFAIL: %s\n%s\n',
528
self._test_description(test), err[1])
530
def report_skip(self, test, reason):
533
def report_not_applicable(self, test, skip_excinfo):
536
def report_unsupported(self, test, feature):
537
"""test cannot be run because feature is missing."""
539
def report_cleaning_up(self):
540
self.pb.update('Cleaning up')
543
class VerboseTestResult(ExtendedTestResult):
544
"""Produce long output, with one line per test run plus times"""
546
def _ellipsize_to_right(self, a_string, final_width):
547
"""Truncate and pad a string, keeping the right hand side"""
548
if len(a_string) > final_width:
549
result = '...' + a_string[3-final_width:]
552
return result.ljust(final_width)
554
def startTestRun(self):
555
super(VerboseTestResult, self).startTestRun()
556
self.stream.write('running %d tests...\n' % self.num_tests)
558
def report_test_start(self, test):
560
name = self._shortened_test_description(test)
561
# width needs space for 6 char status, plus 1 for slash, plus an
562
# 11-char time string, plus a trailing blank
563
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
564
self.stream.write(self._ellipsize_to_right(name,
565
osutils.terminal_width()-18))
568
def _error_summary(self, err):
570
return '%s%s' % (indent, err[1])
572
def report_error(self, test, err):
573
self.stream.writeln('ERROR %s\n%s'
574
% (self._testTimeString(test),
575
self._error_summary(err)))
577
def report_failure(self, test, err):
578
self.stream.writeln(' FAIL %s\n%s'
579
% (self._testTimeString(test),
580
self._error_summary(err)))
582
def report_known_failure(self, test, err):
583
self.stream.writeln('XFAIL %s\n%s'
584
% (self._testTimeString(test),
585
self._error_summary(err)))
587
def report_success(self, test):
588
self.stream.writeln(' OK %s' % self._testTimeString(test))
589
for bench_called, stats in getattr(test, '_benchcalls', []):
590
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
591
stats.pprint(file=self.stream)
592
# flush the stream so that we get smooth output. This verbose mode is
593
# used to show the output in PQM.
596
def report_skip(self, test, reason):
597
self.stream.writeln(' SKIP %s\n%s'
598
% (self._testTimeString(test), reason))
600
def report_not_applicable(self, test, skip_excinfo):
601
self.stream.writeln(' N/A %s\n%s'
602
% (self._testTimeString(test),
603
self._error_summary(skip_excinfo)))
605
def report_unsupported(self, test, feature):
606
"""test cannot be run because feature is missing."""
607
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
608
%(self._testTimeString(test), feature))
611
class TextTestRunner(object):
612
stop_on_failure = False
620
result_decorators=None,
622
"""Create a TextTestRunner.
624
:param result_decorators: An optional list of decorators to apply
625
to the result object being used by the runner. Decorators are
626
applied left to right - the first element in the list is the
629
self.stream = unittest._WritelnDecorator(stream)
630
self.descriptions = descriptions
631
self.verbosity = verbosity
632
self._bench_history = bench_history
633
self._strict = strict
634
self._result_decorators = result_decorators or []
637
"Run the given test case or test suite."
638
if self.verbosity == 1:
639
result_class = TextTestResult
640
elif self.verbosity >= 2:
641
result_class = VerboseTestResult
642
original_result = result_class(self.stream,
645
bench_history=self._bench_history,
648
# Signal to result objects that look at stop early policy to stop,
649
original_result.stop_early = self.stop_on_failure
650
result = original_result
651
for decorator in self._result_decorators:
652
result = decorator(result)
653
result.stop_early = self.stop_on_failure
659
if isinstance(test, testtools.ConcurrentTestSuite):
660
# We need to catch bzr specific behaviors
661
result = BZRTransformingResult(result)
662
result.startTestRun()
667
# higher level code uses our extended protocol to determine
668
# what exit code to give.
669
return original_result
672
def iter_suite_tests(suite):
673
"""Return all tests in a suite, recursing through nested suites"""
674
if isinstance(suite, unittest.TestCase):
676
elif isinstance(suite, unittest.TestSuite):
678
for r in iter_suite_tests(item):
681
raise Exception('unknown type %r for object %r'
682
% (type(suite), suite))
685
class TestSkipped(Exception):
686
"""Indicates that a test was intentionally skipped, rather than failing."""
689
class TestNotApplicable(TestSkipped):
690
"""A test is not applicable to the situation where it was run.
692
This is only normally raised by parameterized tests, if they find that
693
the instance they're constructed upon does not support one aspect
698
class KnownFailure(AssertionError):
699
"""Indicates that a test failed in a precisely expected manner.
701
Such failures dont block the whole test suite from passing because they are
702
indicators of partially completed code or of future work. We have an
703
explicit error for them so that we can ensure that they are always visible:
704
KnownFailures are always shown in the output of bzr selftest.
708
class UnavailableFeature(Exception):
709
"""A feature required for this test was not available.
711
The feature should be used to construct the exception.
715
class CommandFailed(Exception):
719
class StringIOWrapper(object):
720
"""A wrapper around cStringIO which just adds an encoding attribute.
722
Internally we can check sys.stdout to see what the output encoding
723
should be. However, cStringIO has no encoding attribute that we can
724
set. So we wrap it instead.
729
def __init__(self, s=None):
731
self.__dict__['_cstring'] = StringIO(s)
733
self.__dict__['_cstring'] = StringIO()
735
def __getattr__(self, name, getattr=getattr):
736
return getattr(self.__dict__['_cstring'], name)
738
def __setattr__(self, name, val):
739
if name == 'encoding':
740
self.__dict__['encoding'] = val
742
return setattr(self._cstring, name, val)
745
class TestUIFactory(TextUIFactory):
746
"""A UI Factory for testing.
748
Hide the progress bar but emit note()s.
750
Allows get_password to be tested without real tty attached.
752
See also CannedInputUIFactory which lets you provide programmatic input in
755
# TODO: Capture progress events at the model level and allow them to be
756
# observed by tests that care.
758
# XXX: Should probably unify more with CannedInputUIFactory or a
759
# particular configuration of TextUIFactory, or otherwise have a clearer
760
# idea of how they're supposed to be different.
761
# See https://bugs.edge.launchpad.net/bzr/+bug/408213
763
def __init__(self, stdout=None, stderr=None, stdin=None):
764
if stdin is not None:
765
# We use a StringIOWrapper to be able to test various
766
# encodings, but the user is still responsible to
767
# encode the string and to set the encoding attribute
768
# of StringIOWrapper.
769
stdin = StringIOWrapper(stdin)
770
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
772
def get_non_echoed_password(self):
773
"""Get password from stdin without trying to handle the echo mode"""
774
password = self.stdin.readline()
777
if password[-1] == '\n':
778
password = password[:-1]
781
def make_progress_view(self):
782
return NullProgressView()
785
class TestCase(unittest.TestCase):
786
"""Base class for bzr unit tests.
788
Tests that need access to disk resources should subclass
789
TestCaseInTempDir not TestCase.
791
Error and debug log messages are redirected from their usual
792
location into a temporary file, the contents of which can be
793
retrieved by _get_log(). We use a real OS file, not an in-memory object,
794
so that it can also capture file IO. When the test completes this file
795
is read into memory and removed from disk.
797
There are also convenience functions to invoke bzr's command-line
798
routine, and to build and check bzr trees.
800
In addition to the usual method of overriding tearDown(), this class also
801
allows subclasses to register functions into the _cleanups list, which is
802
run in order as the object is torn down. It's less likely this will be
803
accidentally overlooked.
806
_active_threads = None
807
_leaking_threads_tests = 0
808
_first_thread_leaker_id = None
809
_log_file_name = None
811
_keep_log_file = False
812
# record lsprof data when performing benchmark calls.
813
_gather_lsprof_in_benchmarks = False
814
attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
815
'_log_contents', '_log_file_name', '_benchtime',
816
'_TestCase__testMethodName', '_TestCase__testMethodDoc',)
818
def __init__(self, methodName='testMethod'):
819
super(TestCase, self).__init__(methodName)
821
self._bzr_test_setUp_run = False
822
self._bzr_test_tearDown_run = False
823
self._directory_isolation = True
826
unittest.TestCase.setUp(self)
827
self._bzr_test_setUp_run = True
828
self._cleanEnvironment()
831
self._benchcalls = []
832
self._benchtime = None
834
self._track_transports()
836
self._clear_debug_flags()
837
TestCase._active_threads = threading.activeCount()
838
self.addCleanup(self._check_leaked_threads)
843
pdb.Pdb().set_trace(sys._getframe().f_back)
845
def _check_leaked_threads(self):
846
active = threading.activeCount()
847
leaked_threads = active - TestCase._active_threads
848
TestCase._active_threads = active
850
TestCase._leaking_threads_tests += 1
851
if TestCase._first_thread_leaker_id is None:
852
TestCase._first_thread_leaker_id = self.id()
854
def _clear_debug_flags(self):
855
"""Prevent externally set debug flags affecting tests.
857
Tests that want to use debug flags can just set them in the
858
debug_flags set during setup/teardown.
860
self._preserved_debug_flags = set(debug.debug_flags)
861
if 'allow_debug' not in selftest_debug_flags:
862
debug.debug_flags.clear()
863
if 'disable_lock_checks' not in selftest_debug_flags:
864
debug.debug_flags.add('strict_locks')
865
self.addCleanup(self._restore_debug_flags)
867
def _clear_hooks(self):
868
# prevent hooks affecting tests
869
self._preserved_hooks = {}
870
for key, factory in hooks.known_hooks.items():
871
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
872
current_hooks = hooks.known_hooks_key_to_object(key)
873
self._preserved_hooks[parent] = (name, current_hooks)
874
self.addCleanup(self._restoreHooks)
875
for key, factory in hooks.known_hooks.items():
876
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
877
setattr(parent, name, factory())
878
# this hook should always be installed
879
request._install_hook()
881
def disable_directory_isolation(self):
882
"""Turn off directory isolation checks."""
883
self._directory_isolation = False
885
def enable_directory_isolation(self):
886
"""Enable directory isolation checks."""
887
self._directory_isolation = True
889
def _silenceUI(self):
890
"""Turn off UI for duration of test"""
891
# by default the UI is off; tests can turn it on if they want it.
892
saved = ui.ui_factory
894
ui.ui_factory = saved
895
ui.ui_factory = ui.SilentUIFactory()
896
self.addCleanup(_restore)
898
def _check_locks(self):
899
"""Check that all lock take/release actions have been paired."""
900
# We always check for mismatched locks. If a mismatch is found, we
901
# fail unless -Edisable_lock_checks is supplied to selftest, in which
902
# case we just print a warning.
904
acquired_locks = [lock for action, lock in self._lock_actions
905
if action == 'acquired']
906
released_locks = [lock for action, lock in self._lock_actions
907
if action == 'released']
908
broken_locks = [lock for action, lock in self._lock_actions
909
if action == 'broken']
910
# trivially, given the tests for lock acquistion and release, if we
911
# have as many in each list, it should be ok. Some lock tests also
912
# break some locks on purpose and should be taken into account by
913
# considering that breaking a lock is just a dirty way of releasing it.
914
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
915
message = ('Different number of acquired and '
916
'released or broken locks. (%s, %s + %s)' %
917
(acquired_locks, released_locks, broken_locks))
918
if not self._lock_check_thorough:
919
# Rather than fail, just warn
920
print "Broken test %s: %s" % (self, message)
924
def _track_locks(self):
925
"""Track lock activity during tests."""
926
self._lock_actions = []
927
if 'disable_lock_checks' in selftest_debug_flags:
928
self._lock_check_thorough = False
930
self._lock_check_thorough = True
932
self.addCleanup(self._check_locks)
933
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
934
self._lock_acquired, None)
935
_mod_lock.Lock.hooks.install_named_hook('lock_released',
936
self._lock_released, None)
937
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
938
self._lock_broken, None)
940
def _lock_acquired(self, result):
941
self._lock_actions.append(('acquired', result))
943
def _lock_released(self, result):
944
self._lock_actions.append(('released', result))
946
def _lock_broken(self, result):
947
self._lock_actions.append(('broken', result))
949
def permit_dir(self, name):
950
"""Permit a directory to be used by this test. See permit_url."""
951
name_transport = get_transport(name)
952
self.permit_url(name)
953
self.permit_url(name_transport.base)
955
def permit_url(self, url):
956
"""Declare that url is an ok url to use in this test.
958
Do this for memory transports, temporary test directory etc.
960
Do not do this for the current working directory, /tmp, or any other
961
preexisting non isolated url.
963
if not url.endswith('/'):
965
self._bzr_selftest_roots.append(url)
967
def permit_source_tree_branch_repo(self):
968
"""Permit the source tree bzr is running from to be opened.
970
Some code such as bzrlib.version attempts to read from the bzr branch
971
that bzr is executing from (if any). This method permits that directory
972
to be used in the test suite.
974
path = self.get_source_path()
975
self.record_directory_isolation()
978
workingtree.WorkingTree.open(path)
979
except (errors.NotBranchError, errors.NoWorkingTree):
982
self.enable_directory_isolation()
984
def _preopen_isolate_transport(self, transport):
985
"""Check that all transport openings are done in the test work area."""
986
while isinstance(transport, pathfilter.PathFilteringTransport):
987
# Unwrap pathfiltered transports
988
transport = transport.server.backing_transport.clone(
989
transport._filter('.'))
991
# ReadonlySmartTCPServer_for_testing decorates the backing transport
992
# urls it is given by prepending readonly+. This is appropriate as the
993
# client shouldn't know that the server is readonly (or not readonly).
994
# We could register all servers twice, with readonly+ prepending, but
995
# that makes for a long list; this is about the same but easier to
997
if url.startswith('readonly+'):
998
url = url[len('readonly+'):]
999
self._preopen_isolate_url(url)
1001
def _preopen_isolate_url(self, url):
1002
if not self._directory_isolation:
1004
if self._directory_isolation == 'record':
1005
self._bzr_selftest_roots.append(url)
1007
# This prevents all transports, including e.g. sftp ones backed on disk
1008
# from working unless they are explicitly granted permission. We then
1009
# depend on the code that sets up test transports to check that they are
1010
# appropriately isolated and enable their use by calling
1011
# self.permit_transport()
1012
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1013
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1014
% (url, self._bzr_selftest_roots))
1016
def record_directory_isolation(self):
1017
"""Gather accessed directories to permit later access.
1019
This is used for tests that access the branch bzr is running from.
1021
self._directory_isolation = "record"
1023
def start_server(self, transport_server, backing_server=None):
1024
"""Start transport_server for this test.
1026
This starts the server, registers a cleanup for it and permits the
1027
server's urls to be used.
1029
if backing_server is None:
1030
transport_server.setUp()
1032
transport_server.setUp(backing_server)
1033
self.addCleanup(transport_server.tearDown)
1034
# Obtain a real transport because if the server supplies a password, it
1035
# will be hidden from the base on the client side.
1036
t = get_transport(transport_server.get_url())
1037
# Some transport servers effectively chroot the backing transport;
1038
# others like SFTPServer don't - users of the transport can walk up the
1039
# transport to read the entire backing transport. This wouldn't matter
1040
# except that the workdir tests are given - and that they expect the
1041
# server's url to point at - is one directory under the safety net. So
1042
# Branch operations into the transport will attempt to walk up one
1043
# directory. Chrooting all servers would avoid this but also mean that
1044
# we wouldn't be testing directly against non-root urls. Alternatively
1045
# getting the test framework to start the server with a backing server
1046
# at the actual safety net directory would work too, but this then
1047
# means that the self.get_url/self.get_transport methods would need
1048
# to transform all their results. On balance its cleaner to handle it
1049
# here, and permit a higher url when we have one of these transports.
1050
if t.base.endswith('/work/'):
1051
# we have safety net/test root/work
1052
t = t.clone('../..')
1053
elif isinstance(transport_server, server.SmartTCPServer_for_testing):
1054
# The smart server adds a path similar to work, which is traversed
1055
# up from by the client. But the server is chrooted - the actual
1056
# backing transport is not escaped from, and VFS requests to the
1057
# root will error (because they try to escape the chroot).
1059
while t2.base != t.base:
1062
self.permit_url(t.base)
1064
def _track_transports(self):
1065
"""Install checks for transport usage."""
1066
# TestCase has no safe place it can write to.
1067
self._bzr_selftest_roots = []
1068
# Currently the easiest way to be sure that nothing is going on is to
1069
# hook into bzr dir opening. This leaves a small window of error for
1070
# transport tests, but they are well known, and we can improve on this
1072
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1073
self._preopen_isolate_transport, "Check bzr directories are safe.")
1075
def _ndiff_strings(self, a, b):
1076
"""Return ndiff between two strings containing lines.
1078
A trailing newline is added if missing to make the strings
1080
if b and b[-1] != '\n':
1082
if a and a[-1] != '\n':
1084
difflines = difflib.ndiff(a.splitlines(True),
1086
linejunk=lambda x: False,
1087
charjunk=lambda x: False)
1088
return ''.join(difflines)
1090
def assertEqual(self, a, b, message=''):
1094
except UnicodeError, e:
1095
# If we can't compare without getting a UnicodeError, then
1096
# obviously they are different
1097
mutter('UnicodeError: %s', e)
1100
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
1102
pformat(a), pformat(b)))
1104
assertEquals = assertEqual
1106
def assertEqualDiff(self, a, b, message=None):
1107
"""Assert two texts are equal, if not raise an exception.
1109
This is intended for use with multi-line strings where it can
1110
be hard to find the differences by eye.
1112
# TODO: perhaps override assertEquals to call this for strings?
1116
message = "texts not equal:\n"
1118
message = 'first string is missing a final newline.\n'
1120
message = 'second string is missing a final newline.\n'
1121
raise AssertionError(message +
1122
self._ndiff_strings(a, b))
1124
def assertEqualMode(self, mode, mode_test):
1125
self.assertEqual(mode, mode_test,
1126
'mode mismatch %o != %o' % (mode, mode_test))
1128
def assertEqualStat(self, expected, actual):
1129
"""assert that expected and actual are the same stat result.
1131
:param expected: A stat result.
1132
:param actual: A stat result.
1133
:raises AssertionError: If the expected and actual stat values differ
1134
other than by atime.
1136
self.assertEqual(expected.st_size, actual.st_size)
1137
self.assertEqual(expected.st_mtime, actual.st_mtime)
1138
self.assertEqual(expected.st_ctime, actual.st_ctime)
1139
self.assertEqual(expected.st_dev, actual.st_dev)
1140
self.assertEqual(expected.st_ino, actual.st_ino)
1141
self.assertEqual(expected.st_mode, actual.st_mode)
1143
def assertLength(self, length, obj_with_len):
1144
"""Assert that obj_with_len is of length length."""
1145
if len(obj_with_len) != length:
1146
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1147
length, len(obj_with_len), obj_with_len))
1149
def assertPositive(self, val):
1150
"""Assert that val is greater than 0."""
1151
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1153
def assertNegative(self, val):
1154
"""Assert that val is less than 0."""
1155
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1157
def assertStartsWith(self, s, prefix):
1158
if not s.startswith(prefix):
1159
raise AssertionError('string %r does not start with %r' % (s, prefix))
1161
def assertEndsWith(self, s, suffix):
1162
"""Asserts that s ends with suffix."""
1163
if not s.endswith(suffix):
1164
raise AssertionError('string %r does not end with %r' % (s, suffix))
1166
def assertContainsRe(self, haystack, needle_re, flags=0):
1167
"""Assert that a contains something matching a regular expression."""
1168
if not re.search(needle_re, haystack, flags):
1169
if '\n' in haystack or len(haystack) > 60:
1170
# a long string, format it in a more readable way
1171
raise AssertionError(
1172
'pattern "%s" not found in\n"""\\\n%s"""\n'
1173
% (needle_re, haystack))
1175
raise AssertionError('pattern "%s" not found in "%s"'
1176
% (needle_re, haystack))
1178
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1179
"""Assert that a does not match a regular expression"""
1180
if re.search(needle_re, haystack, flags):
1181
raise AssertionError('pattern "%s" found in "%s"'
1182
% (needle_re, haystack))
1184
def assertSubset(self, sublist, superlist):
1185
"""Assert that every entry in sublist is present in superlist."""
1186
missing = set(sublist) - set(superlist)
1187
if len(missing) > 0:
1188
raise AssertionError("value(s) %r not present in container %r" %
1189
(missing, superlist))
1191
def assertListRaises(self, excClass, func, *args, **kwargs):
1192
"""Fail unless excClass is raised when the iterator from func is used.
1194
Many functions can return generators this makes sure
1195
to wrap them in a list() call to make sure the whole generator
1196
is run, and that the proper exception is raised.
1199
list(func(*args, **kwargs))
1203
if getattr(excClass,'__name__', None) is not None:
1204
excName = excClass.__name__
1206
excName = str(excClass)
1207
raise self.failureException, "%s not raised" % excName
1209
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1210
"""Assert that a callable raises a particular exception.
1212
:param excClass: As for the except statement, this may be either an
1213
exception class, or a tuple of classes.
1214
:param callableObj: A callable, will be passed ``*args`` and
1217
Returns the exception so that you can examine it.
1220
callableObj(*args, **kwargs)
1224
if getattr(excClass,'__name__', None) is not None:
1225
excName = excClass.__name__
1228
excName = str(excClass)
1229
raise self.failureException, "%s not raised" % excName
1231
def assertIs(self, left, right, message=None):
1232
if not (left is right):
1233
if message is not None:
1234
raise AssertionError(message)
1236
raise AssertionError("%r is not %r." % (left, right))
1238
def assertIsNot(self, left, right, message=None):
1240
if message is not None:
1241
raise AssertionError(message)
1243
raise AssertionError("%r is %r." % (left, right))
1245
def assertTransportMode(self, transport, path, mode):
1246
"""Fail if a path does not have mode "mode".
1248
If modes are not supported on this transport, the assertion is ignored.
1250
if not transport._can_roundtrip_unix_modebits():
1252
path_stat = transport.stat(path)
1253
actual_mode = stat.S_IMODE(path_stat.st_mode)
1254
self.assertEqual(mode, actual_mode,
1255
'mode of %r incorrect (%s != %s)'
1256
% (path, oct(mode), oct(actual_mode)))
1258
def assertIsSameRealPath(self, path1, path2):
1259
"""Fail if path1 and path2 points to different files"""
1260
self.assertEqual(osutils.realpath(path1),
1261
osutils.realpath(path2),
1262
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1264
def assertIsInstance(self, obj, kls, msg=None):
1265
"""Fail if obj is not an instance of kls
1267
:param msg: Supplementary message to show if the assertion fails.
1269
if not isinstance(obj, kls):
1270
m = "%r is an instance of %s rather than %s" % (
1271
obj, obj.__class__, kls)
1276
def expectFailure(self, reason, assertion, *args, **kwargs):
1277
"""Invoke a test, expecting it to fail for the given reason.
1279
This is for assertions that ought to succeed, but currently fail.
1280
(The failure is *expected* but not *wanted*.) Please be very precise
1281
about the failure you're expecting. If a new bug is introduced,
1282
AssertionError should be raised, not KnownFailure.
1284
Frequently, expectFailure should be followed by an opposite assertion.
1287
Intended to be used with a callable that raises AssertionError as the
1288
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1290
Raises KnownFailure if the test fails. Raises AssertionError if the
1295
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1297
self.assertEqual(42, dynamic_val)
1299
This means that a dynamic_val of 54 will cause the test to raise
1300
a KnownFailure. Once math is fixed and the expectFailure is removed,
1301
only a dynamic_val of 42 will allow the test to pass. Anything other
1302
than 54 or 42 will cause an AssertionError.
1305
assertion(*args, **kwargs)
1306
except AssertionError:
1307
raise KnownFailure(reason)
1309
self.fail('Unexpected success. Should have failed: %s' % reason)
1311
def assertFileEqual(self, content, path):
1312
"""Fail if path does not contain 'content'."""
1313
self.failUnlessExists(path)
1314
f = file(path, 'rb')
1319
self.assertEqualDiff(content, s)
1321
def failUnlessExists(self, path):
1322
"""Fail unless path or paths, which may be abs or relative, exist."""
1323
if not isinstance(path, basestring):
1325
self.failUnlessExists(p)
1327
self.failUnless(osutils.lexists(path),path+" does not exist")
1329
def failIfExists(self, path):
1330
"""Fail if path or paths, which may be abs or relative, exist."""
1331
if not isinstance(path, basestring):
1333
self.failIfExists(p)
1335
self.failIf(osutils.lexists(path),path+" exists")
1337
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1338
"""A helper for callDeprecated and applyDeprecated.
1340
:param a_callable: A callable to call.
1341
:param args: The positional arguments for the callable
1342
:param kwargs: The keyword arguments for the callable
1343
:return: A tuple (warnings, result). result is the result of calling
1344
a_callable(``*args``, ``**kwargs``).
1347
def capture_warnings(msg, cls=None, stacklevel=None):
1348
# we've hooked into a deprecation specific callpath,
1349
# only deprecations should getting sent via it.
1350
self.assertEqual(cls, DeprecationWarning)
1351
local_warnings.append(msg)
1352
original_warning_method = symbol_versioning.warn
1353
symbol_versioning.set_warning_method(capture_warnings)
1355
result = a_callable(*args, **kwargs)
1357
symbol_versioning.set_warning_method(original_warning_method)
1358
return (local_warnings, result)
1360
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1361
"""Call a deprecated callable without warning the user.
1363
Note that this only captures warnings raised by symbol_versioning.warn,
1364
not other callers that go direct to the warning module.
1366
To test that a deprecated method raises an error, do something like
1369
self.assertRaises(errors.ReservedId,
1370
self.applyDeprecated,
1371
deprecated_in((1, 5, 0)),
1375
:param deprecation_format: The deprecation format that the callable
1376
should have been deprecated with. This is the same type as the
1377
parameter to deprecated_method/deprecated_function. If the
1378
callable is not deprecated with this format, an assertion error
1380
:param a_callable: A callable to call. This may be a bound method or
1381
a regular function. It will be called with ``*args`` and
1383
:param args: The positional arguments for the callable
1384
:param kwargs: The keyword arguments for the callable
1385
:return: The result of a_callable(``*args``, ``**kwargs``)
1387
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1389
expected_first_warning = symbol_versioning.deprecation_string(
1390
a_callable, deprecation_format)
1391
if len(call_warnings) == 0:
1392
self.fail("No deprecation warning generated by call to %s" %
1394
self.assertEqual(expected_first_warning, call_warnings[0])
1397
def callCatchWarnings(self, fn, *args, **kw):
1398
"""Call a callable that raises python warnings.
1400
The caller's responsible for examining the returned warnings.
1402
If the callable raises an exception, the exception is not
1403
caught and propagates up to the caller. In that case, the list
1404
of warnings is not available.
1406
:returns: ([warning_object, ...], fn_result)
1408
# XXX: This is not perfect, because it completely overrides the
1409
# warnings filters, and some code may depend on suppressing particular
1410
# warnings. It's the easiest way to insulate ourselves from -Werror,
1411
# though. -- Andrew, 20071062
1413
def _catcher(message, category, filename, lineno, file=None, line=None):
1414
# despite the name, 'message' is normally(?) a Warning subclass
1416
wlist.append(message)
1417
saved_showwarning = warnings.showwarning
1418
saved_filters = warnings.filters
1420
warnings.showwarning = _catcher
1421
warnings.filters = []
1422
result = fn(*args, **kw)
1424
warnings.showwarning = saved_showwarning
1425
warnings.filters = saved_filters
1426
return wlist, result
1428
def callDeprecated(self, expected, callable, *args, **kwargs):
1429
"""Assert that a callable is deprecated in a particular way.
1431
This is a very precise test for unusual requirements. The
1432
applyDeprecated helper function is probably more suited for most tests
1433
as it allows you to simply specify the deprecation format being used
1434
and will ensure that that is issued for the function being called.
1436
Note that this only captures warnings raised by symbol_versioning.warn,
1437
not other callers that go direct to the warning module. To catch
1438
general warnings, use callCatchWarnings.
1440
:param expected: a list of the deprecation warnings expected, in order
1441
:param callable: The callable to call
1442
:param args: The positional arguments for the callable
1443
:param kwargs: The keyword arguments for the callable
1445
call_warnings, result = self._capture_deprecation_warnings(callable,
1447
self.assertEqual(expected, call_warnings)
1450
def _startLogFile(self):
1451
"""Send bzr and test log messages to a temporary file.
1453
The file is removed as the test is torn down.
1455
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1456
self._log_file = os.fdopen(fileno, 'w+')
1457
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1458
self._log_file_name = name
1459
self.addCleanup(self._finishLogFile)
1461
def _finishLogFile(self):
1462
"""Finished with the log file.
1464
Close the file and delete it, unless setKeepLogfile was called.
1466
if self._log_file is None:
1468
bzrlib.trace.pop_log_file(self._log_memento)
1469
self._log_file.close()
1470
self._log_file = None
1471
if not self._keep_log_file:
1472
os.remove(self._log_file_name)
1473
self._log_file_name = None
1475
def setKeepLogfile(self):
1476
"""Make the logfile not be deleted when _finishLogFile is called."""
1477
self._keep_log_file = True
1479
def thisFailsStrictLockCheck(self):
1480
"""It is known that this test would fail with -Dstrict_locks.
1482
By default, all tests are run with strict lock checking unless
1483
-Edisable_lock_checks is supplied. However there are some tests which
1484
we know fail strict locks at this point that have not been fixed.
1485
They should call this function to disable the strict checking.
1487
This should be used sparingly, it is much better to fix the locking
1488
issues rather than papering over the problem by calling this function.
1490
debug.debug_flags.discard('strict_locks')
1492
def addCleanup(self, callable, *args, **kwargs):
1493
"""Arrange to run a callable when this case is torn down.
1495
Callables are run in the reverse of the order they are registered,
1496
ie last-in first-out.
1498
self._cleanups.append((callable, args, kwargs))
1500
def _cleanEnvironment(self):
1502
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1503
'HOME': os.getcwd(),
1504
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1505
# tests do check our impls match APPDATA
1506
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1510
'BZREMAIL': None, # may still be present in the environment
1512
'BZR_PROGRESS_BAR': None,
1514
'BZR_PLUGIN_PATH': None,
1515
# Make sure that any text ui tests are consistent regardless of
1516
# the environment the test case is run in; you may want tests that
1517
# test other combinations. 'dumb' is a reasonable guess for tests
1518
# going to a pipe or a StringIO.
1523
'SSH_AUTH_SOCK': None,
1527
'https_proxy': None,
1528
'HTTPS_PROXY': None,
1533
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1534
# least. If you do (care), please update this comment
1538
'BZR_REMOTE_PATH': None,
1541
self.addCleanup(self._restoreEnvironment)
1542
for name, value in new_env.iteritems():
1543
self._captureVar(name, value)
1545
def _captureVar(self, name, newvalue):
1546
"""Set an environment variable, and reset it when finished."""
1547
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1549
def _restore_debug_flags(self):
1550
debug.debug_flags.clear()
1551
debug.debug_flags.update(self._preserved_debug_flags)
1553
def _restoreEnvironment(self):
1554
for name, value in self.__old_env.iteritems():
1555
osutils.set_or_unset_env(name, value)
1557
def _restoreHooks(self):
1558
for klass, (name, hooks) in self._preserved_hooks.items():
1559
setattr(klass, name, hooks)
1561
def knownFailure(self, reason):
1562
"""This test has failed for some known reason."""
1563
raise KnownFailure(reason)
1565
def _do_skip(self, result, reason):
1566
addSkip = getattr(result, 'addSkip', None)
1567
if not callable(addSkip):
1568
result.addError(self, sys.exc_info())
1570
addSkip(self, reason)
1572
def run(self, result=None):
1573
if result is None: result = self.defaultTestResult()
1574
for feature in getattr(self, '_test_needs_features', []):
1575
if not feature.available():
1576
result.startTest(self)
1577
if getattr(result, 'addNotSupported', None):
1578
result.addNotSupported(self, feature)
1580
result.addSuccess(self)
1581
result.stopTest(self)
1585
result.startTest(self)
1586
absent_attr = object()
1588
method_name = getattr(self, '_testMethodName', absent_attr)
1589
if method_name is absent_attr:
1591
method_name = getattr(self, '_TestCase__testMethodName')
1592
testMethod = getattr(self, method_name)
1596
if not self._bzr_test_setUp_run:
1598
"test setUp did not invoke "
1599
"bzrlib.tests.TestCase's setUp")
1600
except KeyboardInterrupt:
1603
except TestSkipped, e:
1604
self._do_skip(result, e.args[0])
1608
result.addError(self, sys.exc_info())
1616
except self.failureException:
1617
result.addFailure(self, sys.exc_info())
1618
except TestSkipped, e:
1620
reason = "No reason given."
1623
self._do_skip(result, reason)
1624
except KeyboardInterrupt:
1628
result.addError(self, sys.exc_info())
1632
if not self._bzr_test_tearDown_run:
1634
"test tearDown did not invoke "
1635
"bzrlib.tests.TestCase's tearDown")
1636
except KeyboardInterrupt:
1640
result.addError(self, sys.exc_info())
1643
if ok: result.addSuccess(self)
1645
result.stopTest(self)
1647
except TestNotApplicable:
1648
# Not moved from the result [yet].
1651
except KeyboardInterrupt:
1656
for attr_name in self.attrs_to_keep:
1657
if attr_name in self.__dict__:
1658
saved_attrs[attr_name] = self.__dict__[attr_name]
1659
self.__dict__ = saved_attrs
1663
self._log_contents = ''
1664
self._bzr_test_tearDown_run = True
1665
unittest.TestCase.tearDown(self)
1667
def time(self, callable, *args, **kwargs):
1668
"""Run callable and accrue the time it takes to the benchmark time.
1670
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1671
this will cause lsprofile statistics to be gathered and stored in
1674
if self._benchtime is None:
1678
if not self._gather_lsprof_in_benchmarks:
1679
return callable(*args, **kwargs)
1681
# record this benchmark
1682
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1684
self._benchcalls.append(((callable, args, kwargs), stats))
1687
self._benchtime += time.time() - start
1689
def _runCleanups(self):
1690
"""Run registered cleanup functions.
1692
This should only be called from TestCase.tearDown.
1694
# TODO: Perhaps this should keep running cleanups even if
1695
# one of them fails?
1697
# Actually pop the cleanups from the list so tearDown running
1698
# twice is safe (this happens for skipped tests).
1699
while self._cleanups:
1700
cleanup, args, kwargs = self._cleanups.pop()
1701
cleanup(*args, **kwargs)
1703
def log(self, *args):
1706
def _get_log(self, keep_log_file=False):
1707
"""Get the log from bzrlib.trace calls from this test.
1709
:param keep_log_file: When True, if the log is still a file on disk
1710
leave it as a file on disk. When False, if the log is still a file
1711
on disk, the log file is deleted and the log preserved as
1713
:return: A string containing the log.
1715
# flush the log file, to get all content
1717
if bzrlib.trace._trace_file:
1718
bzrlib.trace._trace_file.flush()
1719
if self._log_contents:
1720
# XXX: this can hardly contain the content flushed above --vila
1722
return self._log_contents
1723
if self._log_file_name is not None:
1724
logfile = open(self._log_file_name)
1726
log_contents = logfile.read()
1729
if not keep_log_file:
1730
self._log_contents = log_contents
1732
os.remove(self._log_file_name)
1734
if sys.platform == 'win32' and e.errno == errno.EACCES:
1735
sys.stderr.write(('Unable to delete log file '
1736
' %r\n' % self._log_file_name))
1741
return "DELETED log file to reduce memory footprint"
1743
def requireFeature(self, feature):
1744
"""This test requires a specific feature is available.
1746
:raises UnavailableFeature: When feature is not available.
1748
if not feature.available():
1749
raise UnavailableFeature(feature)
1751
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1753
"""Run bazaar command line, splitting up a string command line."""
1754
if isinstance(args, basestring):
1755
# shlex don't understand unicode strings,
1756
# so args should be plain string (bialix 20070906)
1757
args = list(shlex.split(str(args)))
1758
return self._run_bzr_core(args, retcode=retcode,
1759
encoding=encoding, stdin=stdin, working_dir=working_dir,
1762
def _run_bzr_core(self, args, retcode, encoding, stdin,
1764
if encoding is None:
1765
encoding = osutils.get_user_encoding()
1766
stdout = StringIOWrapper()
1767
stderr = StringIOWrapper()
1768
stdout.encoding = encoding
1769
stderr.encoding = encoding
1771
self.log('run bzr: %r', args)
1772
# FIXME: don't call into logging here
1773
handler = logging.StreamHandler(stderr)
1774
handler.setLevel(logging.INFO)
1775
logger = logging.getLogger('')
1776
logger.addHandler(handler)
1777
old_ui_factory = ui.ui_factory
1778
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1781
if working_dir is not None:
1782
cwd = osutils.getcwd()
1783
os.chdir(working_dir)
1786
result = self.apply_redirected(ui.ui_factory.stdin,
1788
bzrlib.commands.run_bzr_catch_user_errors,
1791
logger.removeHandler(handler)
1792
ui.ui_factory = old_ui_factory
1796
out = stdout.getvalue()
1797
err = stderr.getvalue()
1799
self.log('output:\n%r', out)
1801
self.log('errors:\n%r', err)
1802
if retcode is not None:
1803
self.assertEquals(retcode, result,
1804
message='Unexpected return code')
1805
return result, out, err
1807
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1808
working_dir=None, error_regexes=[], output_encoding=None):
1809
"""Invoke bzr, as if it were run from the command line.
1811
The argument list should not include the bzr program name - the
1812
first argument is normally the bzr command. Arguments may be
1813
passed in three ways:
1815
1- A list of strings, eg ["commit", "a"]. This is recommended
1816
when the command contains whitespace or metacharacters, or
1817
is built up at run time.
1819
2- A single string, eg "add a". This is the most convenient
1820
for hardcoded commands.
1822
This runs bzr through the interface that catches and reports
1823
errors, and with logging set to something approximating the
1824
default, so that error reporting can be checked.
1826
This should be the main method for tests that want to exercise the
1827
overall behavior of the bzr application (rather than a unit test
1828
or a functional test of the library.)
1830
This sends the stdout/stderr results into the test's log,
1831
where it may be useful for debugging. See also run_captured.
1833
:keyword stdin: A string to be used as stdin for the command.
1834
:keyword retcode: The status code the command should return;
1836
:keyword working_dir: The directory to run the command in
1837
:keyword error_regexes: A list of expected error messages. If
1838
specified they must be seen in the error output of the command.
1840
retcode, out, err = self._run_bzr_autosplit(
1845
working_dir=working_dir,
1847
self.assertIsInstance(error_regexes, (list, tuple))
1848
for regex in error_regexes:
1849
self.assertContainsRe(err, regex)
1852
def run_bzr_error(self, error_regexes, *args, **kwargs):
1853
"""Run bzr, and check that stderr contains the supplied regexes
1855
:param error_regexes: Sequence of regular expressions which
1856
must each be found in the error output. The relative ordering
1858
:param args: command-line arguments for bzr
1859
:param kwargs: Keyword arguments which are interpreted by run_bzr
1860
This function changes the default value of retcode to be 3,
1861
since in most cases this is run when you expect bzr to fail.
1863
:return: (out, err) The actual output of running the command (in case
1864
you want to do more inspection)
1868
# Make sure that commit is failing because there is nothing to do
1869
self.run_bzr_error(['no changes to commit'],
1870
['commit', '-m', 'my commit comment'])
1871
# Make sure --strict is handling an unknown file, rather than
1872
# giving us the 'nothing to do' error
1873
self.build_tree(['unknown'])
1874
self.run_bzr_error(['Commit refused because there are unknown files'],
1875
['commit', --strict', '-m', 'my commit comment'])
1877
kwargs.setdefault('retcode', 3)
1878
kwargs['error_regexes'] = error_regexes
1879
out, err = self.run_bzr(*args, **kwargs)
1882
def run_bzr_subprocess(self, *args, **kwargs):
1883
"""Run bzr in a subprocess for testing.
1885
This starts a new Python interpreter and runs bzr in there.
1886
This should only be used for tests that have a justifiable need for
1887
this isolation: e.g. they are testing startup time, or signal
1888
handling, or early startup code, etc. Subprocess code can't be
1889
profiled or debugged so easily.
1891
:keyword retcode: The status code that is expected. Defaults to 0. If
1892
None is supplied, the status code is not checked.
1893
:keyword env_changes: A dictionary which lists changes to environment
1894
variables. A value of None will unset the env variable.
1895
The values must be strings. The change will only occur in the
1896
child, so you don't need to fix the environment after running.
1897
:keyword universal_newlines: Convert CRLF => LF
1898
:keyword allow_plugins: By default the subprocess is run with
1899
--no-plugins to ensure test reproducibility. Also, it is possible
1900
for system-wide plugins to create unexpected output on stderr,
1901
which can cause unnecessary test failures.
1903
env_changes = kwargs.get('env_changes', {})
1904
working_dir = kwargs.get('working_dir', None)
1905
allow_plugins = kwargs.get('allow_plugins', False)
1907
if isinstance(args[0], list):
1909
elif isinstance(args[0], basestring):
1910
args = list(shlex.split(args[0]))
1912
raise ValueError("passing varargs to run_bzr_subprocess")
1913
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1914
working_dir=working_dir,
1915
allow_plugins=allow_plugins)
1916
# We distinguish between retcode=None and retcode not passed.
1917
supplied_retcode = kwargs.get('retcode', 0)
1918
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1919
universal_newlines=kwargs.get('universal_newlines', False),
1922
def start_bzr_subprocess(self, process_args, env_changes=None,
1923
skip_if_plan_to_signal=False,
1925
allow_plugins=False):
1926
"""Start bzr in a subprocess for testing.
1928
This starts a new Python interpreter and runs bzr in there.
1929
This should only be used for tests that have a justifiable need for
1930
this isolation: e.g. they are testing startup time, or signal
1931
handling, or early startup code, etc. Subprocess code can't be
1932
profiled or debugged so easily.
1934
:param process_args: a list of arguments to pass to the bzr executable,
1935
for example ``['--version']``.
1936
:param env_changes: A dictionary which lists changes to environment
1937
variables. A value of None will unset the env variable.
1938
The values must be strings. The change will only occur in the
1939
child, so you don't need to fix the environment after running.
1940
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1942
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1944
:returns: Popen object for the started process.
1946
if skip_if_plan_to_signal:
1947
if not getattr(os, 'kill', None):
1948
raise TestSkipped("os.kill not available.")
1950
if env_changes is None:
1954
def cleanup_environment():
1955
for env_var, value in env_changes.iteritems():
1956
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1958
def restore_environment():
1959
for env_var, value in old_env.iteritems():
1960
osutils.set_or_unset_env(env_var, value)
1962
bzr_path = self.get_bzr_path()
1965
if working_dir is not None:
1966
cwd = osutils.getcwd()
1967
os.chdir(working_dir)
1970
# win32 subprocess doesn't support preexec_fn
1971
# so we will avoid using it on all platforms, just to
1972
# make sure the code path is used, and we don't break on win32
1973
cleanup_environment()
1974
command = [sys.executable]
1975
# frozen executables don't need the path to bzr
1976
if getattr(sys, "frozen", None) is None:
1977
command.append(bzr_path)
1978
if not allow_plugins:
1979
command.append('--no-plugins')
1980
command.extend(process_args)
1981
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1983
restore_environment()
1989
def _popen(self, *args, **kwargs):
1990
"""Place a call to Popen.
1992
Allows tests to override this method to intercept the calls made to
1993
Popen for introspection.
1995
return Popen(*args, **kwargs)
1997
def get_source_path(self):
1998
"""Return the path of the directory containing bzrlib."""
1999
return os.path.dirname(os.path.dirname(bzrlib.__file__))
2001
def get_bzr_path(self):
2002
"""Return the path of the 'bzr' executable for this test suite."""
2003
bzr_path = self.get_source_path()+'/bzr'
2004
if not os.path.isfile(bzr_path):
2005
# We are probably installed. Assume sys.argv is the right file
2006
bzr_path = sys.argv[0]
2009
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
2010
universal_newlines=False, process_args=None):
2011
"""Finish the execution of process.
2013
:param process: the Popen object returned from start_bzr_subprocess.
2014
:param retcode: The status code that is expected. Defaults to 0. If
2015
None is supplied, the status code is not checked.
2016
:param send_signal: an optional signal to send to the process.
2017
:param universal_newlines: Convert CRLF => LF
2018
:returns: (stdout, stderr)
2020
if send_signal is not None:
2021
os.kill(process.pid, send_signal)
2022
out, err = process.communicate()
2024
if universal_newlines:
2025
out = out.replace('\r\n', '\n')
2026
err = err.replace('\r\n', '\n')
2028
if retcode is not None and retcode != process.returncode:
2029
if process_args is None:
2030
process_args = "(unknown args)"
2031
mutter('Output of bzr %s:\n%s', process_args, out)
2032
mutter('Error for bzr %s:\n%s', process_args, err)
2033
self.fail('Command bzr %s failed with retcode %s != %s'
2034
% (process_args, retcode, process.returncode))
2037
def check_inventory_shape(self, inv, shape):
2038
"""Compare an inventory to a list of expected names.
2040
Fail if they are not precisely equal.
2043
shape = list(shape) # copy
2044
for path, ie in inv.entries():
2045
name = path.replace('\\', '/')
2046
if ie.kind == 'directory':
2053
self.fail("expected paths not found in inventory: %r" % shape)
2055
self.fail("unexpected paths found in inventory: %r" % extras)
2057
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2058
a_callable=None, *args, **kwargs):
2059
"""Call callable with redirected std io pipes.
2061
Returns the return code."""
2062
if not callable(a_callable):
2063
raise ValueError("a_callable must be callable.")
2065
stdin = StringIO("")
2067
if getattr(self, "_log_file", None) is not None:
2068
stdout = self._log_file
2072
if getattr(self, "_log_file", None is not None):
2073
stderr = self._log_file
2076
real_stdin = sys.stdin
2077
real_stdout = sys.stdout
2078
real_stderr = sys.stderr
2083
return a_callable(*args, **kwargs)
2085
sys.stdout = real_stdout
2086
sys.stderr = real_stderr
2087
sys.stdin = real_stdin
2089
def reduceLockdirTimeout(self):
2090
"""Reduce the default lock timeout for the duration of the test, so that
2091
if LockContention occurs during a test, it does so quickly.
2093
Tests that expect to provoke LockContention errors should call this.
2095
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
2097
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
2098
self.addCleanup(resetTimeout)
2099
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
2101
def make_utf8_encoded_stringio(self, encoding_type=None):
2102
"""Return a StringIOWrapper instance, that will encode Unicode
2105
if encoding_type is None:
2106
encoding_type = 'strict'
2108
output_encoding = 'utf-8'
2109
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2110
sio.encoding = output_encoding
2113
def disable_verb(self, verb):
2114
"""Disable a smart server verb for one test."""
2115
from bzrlib.smart import request
2116
request_handlers = request.request_handlers
2117
orig_method = request_handlers.get(verb)
2118
request_handlers.remove(verb)
2120
request_handlers.register(verb, orig_method)
2121
self.addCleanup(restoreVerb)
2124
class CapturedCall(object):
2125
"""A helper for capturing smart server calls for easy debug analysis."""
2127
def __init__(self, params, prefix_length):
2128
"""Capture the call with params and skip prefix_length stack frames."""
2131
# The last 5 frames are the __init__, the hook frame, and 3 smart
2132
# client frames. Beyond this we could get more clever, but this is good
2134
stack = traceback.extract_stack()[prefix_length:-5]
2135
self.stack = ''.join(traceback.format_list(stack))
2138
return self.call.method
2141
return self.call.method
2147
class TestCaseWithMemoryTransport(TestCase):
2148
"""Common test class for tests that do not need disk resources.
2150
Tests that need disk resources should derive from TestCaseWithTransport.
2152
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2154
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2155
a directory which does not exist. This serves to help ensure test isolation
2156
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2157
must exist. However, TestCaseWithMemoryTransport does not offer local
2158
file defaults for the transport in tests, nor does it obey the command line
2159
override, so tests that accidentally write to the common directory should
2162
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2163
a .bzr directory that stops us ascending higher into the filesystem.
2169
def __init__(self, methodName='runTest'):
2170
# allow test parameterization after test construction and before test
2171
# execution. Variables that the parameterizer sets need to be
2172
# ones that are not set by setUp, or setUp will trash them.
2173
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2174
self.vfs_transport_factory = default_transport
2175
self.transport_server = None
2176
self.transport_readonly_server = None
2177
self.__vfs_server = None
2179
def get_transport(self, relpath=None):
2180
"""Return a writeable transport.
2182
This transport is for the test scratch space relative to
2185
:param relpath: a path relative to the base url.
2187
t = get_transport(self.get_url(relpath))
2188
self.assertFalse(t.is_readonly())
2191
def get_readonly_transport(self, relpath=None):
2192
"""Return a readonly transport for the test scratch space
2194
This can be used to test that operations which should only need
2195
readonly access in fact do not try to write.
2197
:param relpath: a path relative to the base url.
2199
t = get_transport(self.get_readonly_url(relpath))
2200
self.assertTrue(t.is_readonly())
2203
def create_transport_readonly_server(self):
2204
"""Create a transport server from class defined at init.
2206
This is mostly a hook for daughter classes.
2208
return self.transport_readonly_server()
2210
def get_readonly_server(self):
2211
"""Get the server instance for the readonly transport
2213
This is useful for some tests with specific servers to do diagnostics.
2215
if self.__readonly_server is None:
2216
if self.transport_readonly_server is None:
2217
# readonly decorator requested
2218
self.__readonly_server = ReadonlyServer()
2220
# explicit readonly transport.
2221
self.__readonly_server = self.create_transport_readonly_server()
2222
self.start_server(self.__readonly_server,
2223
self.get_vfs_only_server())
2224
return self.__readonly_server
2226
def get_readonly_url(self, relpath=None):
2227
"""Get a URL for the readonly transport.
2229
This will either be backed by '.' or a decorator to the transport
2230
used by self.get_url()
2231
relpath provides for clients to get a path relative to the base url.
2232
These should only be downwards relative, not upwards.
2234
base = self.get_readonly_server().get_url()
2235
return self._adjust_url(base, relpath)
2237
def get_vfs_only_server(self):
2238
"""Get the vfs only read/write server instance.
2240
This is useful for some tests with specific servers that need
2243
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2244
is no means to override it.
2246
if self.__vfs_server is None:
2247
self.__vfs_server = MemoryServer()
2248
self.start_server(self.__vfs_server)
2249
return self.__vfs_server
2251
def get_server(self):
2252
"""Get the read/write server instance.
2254
This is useful for some tests with specific servers that need
2257
This is built from the self.transport_server factory. If that is None,
2258
then the self.get_vfs_server is returned.
2260
if self.__server is None:
2261
if (self.transport_server is None or self.transport_server is
2262
self.vfs_transport_factory):
2263
self.__server = self.get_vfs_only_server()
2265
# bring up a decorated means of access to the vfs only server.
2266
self.__server = self.transport_server()
2267
self.start_server(self.__server, self.get_vfs_only_server())
2268
return self.__server
2270
def _adjust_url(self, base, relpath):
2271
"""Get a URL (or maybe a path) for the readwrite transport.
2273
This will either be backed by '.' or to an equivalent non-file based
2275
relpath provides for clients to get a path relative to the base url.
2276
These should only be downwards relative, not upwards.
2278
if relpath is not None and relpath != '.':
2279
if not base.endswith('/'):
2281
# XXX: Really base should be a url; we did after all call
2282
# get_url()! But sometimes it's just a path (from
2283
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2284
# to a non-escaped local path.
2285
if base.startswith('./') or base.startswith('/'):
2288
base += urlutils.escape(relpath)
2291
def get_url(self, relpath=None):
2292
"""Get a URL (or maybe a path) for the readwrite transport.
2294
This will either be backed by '.' or to an equivalent non-file based
2296
relpath provides for clients to get a path relative to the base url.
2297
These should only be downwards relative, not upwards.
2299
base = self.get_server().get_url()
2300
return self._adjust_url(base, relpath)
2302
def get_vfs_only_url(self, relpath=None):
2303
"""Get a URL (or maybe a path for the plain old vfs transport.
2305
This will never be a smart protocol. It always has all the
2306
capabilities of the local filesystem, but it might actually be a
2307
MemoryTransport or some other similar virtual filesystem.
2309
This is the backing transport (if any) of the server returned by
2310
get_url and get_readonly_url.
2312
:param relpath: provides for clients to get a path relative to the base
2313
url. These should only be downwards relative, not upwards.
2316
base = self.get_vfs_only_server().get_url()
2317
return self._adjust_url(base, relpath)
2319
def _create_safety_net(self):
2320
"""Make a fake bzr directory.
2322
This prevents any tests propagating up onto the TEST_ROOT directory's
2325
root = TestCaseWithMemoryTransport.TEST_ROOT
2326
bzrdir.BzrDir.create_standalone_workingtree(root)
2328
def _check_safety_net(self):
2329
"""Check that the safety .bzr directory have not been touched.
2331
_make_test_root have created a .bzr directory to prevent tests from
2332
propagating. This method ensures than a test did not leaked.
2334
root = TestCaseWithMemoryTransport.TEST_ROOT
2335
self.permit_url(get_transport(root).base)
2336
wt = workingtree.WorkingTree.open(root)
2337
last_rev = wt.last_revision()
2338
if last_rev != 'null:':
2339
# The current test have modified the /bzr directory, we need to
2340
# recreate a new one or all the followng tests will fail.
2341
# If you need to inspect its content uncomment the following line
2342
# import pdb; pdb.set_trace()
2343
_rmtree_temp_dir(root + '/.bzr')
2344
self._create_safety_net()
2345
raise AssertionError('%s/.bzr should not be modified' % root)
2347
def _make_test_root(self):
2348
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2349
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2350
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2352
TestCaseWithMemoryTransport.TEST_ROOT = root
2354
self._create_safety_net()
2356
# The same directory is used by all tests, and we're not
2357
# specifically told when all tests are finished. This will do.
2358
atexit.register(_rmtree_temp_dir, root)
2360
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2361
self.addCleanup(self._check_safety_net)
2363
def makeAndChdirToTestDir(self):
2364
"""Create a temporary directories for this one test.
2366
This must set self.test_home_dir and self.test_dir and chdir to
2369
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2371
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2372
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2373
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2374
self.permit_dir(self.test_dir)
2376
def make_branch(self, relpath, format=None):
2377
"""Create a branch on the transport at relpath."""
2378
repo = self.make_repository(relpath, format=format)
2379
return repo.bzrdir.create_branch()
2381
def make_bzrdir(self, relpath, format=None):
2383
# might be a relative or absolute path
2384
maybe_a_url = self.get_url(relpath)
2385
segments = maybe_a_url.rsplit('/', 1)
2386
t = get_transport(maybe_a_url)
2387
if len(segments) > 1 and segments[-1] not in ('', '.'):
2391
if isinstance(format, basestring):
2392
format = bzrdir.format_registry.make_bzrdir(format)
2393
return format.initialize_on_transport(t)
2394
except errors.UninitializableFormat:
2395
raise TestSkipped("Format %s is not initializable." % format)
2397
def make_repository(self, relpath, shared=False, format=None):
2398
"""Create a repository on our default transport at relpath.
2400
Note that relpath must be a relative path, not a full url.
2402
# FIXME: If you create a remoterepository this returns the underlying
2403
# real format, which is incorrect. Actually we should make sure that
2404
# RemoteBzrDir returns a RemoteRepository.
2405
# maybe mbp 20070410
2406
made_control = self.make_bzrdir(relpath, format=format)
2407
return made_control.create_repository(shared=shared)
2409
def make_smart_server(self, path):
2410
smart_server = server.SmartTCPServer_for_testing()
2411
self.start_server(smart_server, self.get_server())
2412
remote_transport = get_transport(smart_server.get_url()).clone(path)
2413
return remote_transport
2415
def make_branch_and_memory_tree(self, relpath, format=None):
2416
"""Create a branch on the default transport and a MemoryTree for it."""
2417
b = self.make_branch(relpath, format=format)
2418
return memorytree.MemoryTree.create_on_branch(b)
2420
def make_branch_builder(self, relpath, format=None):
2421
branch = self.make_branch(relpath, format=format)
2422
return branchbuilder.BranchBuilder(branch=branch)
2424
def overrideEnvironmentForTesting(self):
2425
os.environ['HOME'] = self.test_home_dir
2426
os.environ['BZR_HOME'] = self.test_home_dir
2429
super(TestCaseWithMemoryTransport, self).setUp()
2430
self._make_test_root()
2431
_currentdir = os.getcwdu()
2432
def _leaveDirectory():
2433
os.chdir(_currentdir)
2434
self.addCleanup(_leaveDirectory)
2435
self.makeAndChdirToTestDir()
2436
self.overrideEnvironmentForTesting()
2437
self.__readonly_server = None
2438
self.__server = None
2439
self.reduceLockdirTimeout()
2441
def setup_smart_server_with_call_log(self):
2442
"""Sets up a smart server as the transport server with a call log."""
2443
self.transport_server = server.SmartTCPServer_for_testing
2444
self.hpss_calls = []
2446
# Skip the current stack down to the caller of
2447
# setup_smart_server_with_call_log
2448
prefix_length = len(traceback.extract_stack()) - 2
2449
def capture_hpss_call(params):
2450
self.hpss_calls.append(
2451
CapturedCall(params, prefix_length))
2452
client._SmartClient.hooks.install_named_hook(
2453
'call', capture_hpss_call, None)
2455
def reset_smart_call_log(self):
2456
self.hpss_calls = []
2459
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2460
"""Derived class that runs a test within a temporary directory.
2462
This is useful for tests that need to create a branch, etc.
2464
The directory is created in a slightly complex way: for each
2465
Python invocation, a new temporary top-level directory is created.
2466
All test cases create their own directory within that. If the
2467
tests complete successfully, the directory is removed.
2469
:ivar test_base_dir: The path of the top-level directory for this
2470
test, which contains a home directory and a work directory.
2472
:ivar test_home_dir: An initially empty directory under test_base_dir
2473
which is used as $HOME for this test.
2475
:ivar test_dir: A directory under test_base_dir used as the current
2476
directory when the test proper is run.
2479
OVERRIDE_PYTHON = 'python'
2481
def check_file_contents(self, filename, expect):
2482
self.log("check contents of file %s" % filename)
2483
contents = file(filename, 'r').read()
2484
if contents != expect:
2485
self.log("expected: %r" % expect)
2486
self.log("actually: %r" % contents)
2487
self.fail("contents of %s not as expected" % filename)
2489
def _getTestDirPrefix(self):
2490
# create a directory within the top level test directory
2491
if sys.platform in ('win32', 'cygwin'):
2492
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2493
# windows is likely to have path-length limits so use a short name
2494
name_prefix = name_prefix[-30:]
2496
name_prefix = re.sub('[/]', '_', self.id())
2499
def makeAndChdirToTestDir(self):
2500
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2502
For TestCaseInTempDir we create a temporary directory based on the test
2503
name and then create two subdirs - test and home under it.
2505
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2506
self._getTestDirPrefix())
2508
for i in range(100):
2509
if os.path.exists(name):
2510
name = name_prefix + '_' + str(i)
2512
# now create test and home directories within this dir
2513
self.test_base_dir = name
2514
self.addCleanup(self.deleteTestDir)
2515
os.mkdir(self.test_base_dir)
2517
self.permit_dir(self.test_base_dir)
2518
# 'sprouting' and 'init' of a branch both walk up the tree to find
2519
# stacking policy to honour; create a bzr dir with an unshared
2520
# repository (but not a branch - our code would be trying to escape
2521
# then!) to stop them, and permit it to be read.
2522
# control = bzrdir.BzrDir.create(self.test_base_dir)
2523
# control.create_repository()
2524
self.test_home_dir = self.test_base_dir + '/home'
2525
os.mkdir(self.test_home_dir)
2526
self.test_dir = self.test_base_dir + '/work'
2527
os.mkdir(self.test_dir)
2528
os.chdir(self.test_dir)
2529
# put name of test inside
2530
f = file(self.test_base_dir + '/name', 'w')
2536
def deleteTestDir(self):
2537
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2538
_rmtree_temp_dir(self.test_base_dir)
2540
def build_tree(self, shape, line_endings='binary', transport=None):
2541
"""Build a test tree according to a pattern.
2543
shape is a sequence of file specifications. If the final
2544
character is '/', a directory is created.
2546
This assumes that all the elements in the tree being built are new.
2548
This doesn't add anything to a branch.
2550
:type shape: list or tuple.
2551
:param line_endings: Either 'binary' or 'native'
2552
in binary mode, exact contents are written in native mode, the
2553
line endings match the default platform endings.
2554
:param transport: A transport to write to, for building trees on VFS's.
2555
If the transport is readonly or None, "." is opened automatically.
2558
if type(shape) not in (list, tuple):
2559
raise AssertionError("Parameter 'shape' should be "
2560
"a list or a tuple. Got %r instead" % (shape,))
2561
# It's OK to just create them using forward slashes on windows.
2562
if transport is None or transport.is_readonly():
2563
transport = get_transport(".")
2565
self.assertIsInstance(name, basestring)
2567
transport.mkdir(urlutils.escape(name[:-1]))
2569
if line_endings == 'binary':
2571
elif line_endings == 'native':
2574
raise errors.BzrError(
2575
'Invalid line ending request %r' % line_endings)
2576
content = "contents of %s%s" % (name.encode('utf-8'), end)
2577
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2579
def build_tree_contents(self, shape):
2580
build_tree_contents(shape)
2582
def assertInWorkingTree(self, path, root_path='.', tree=None):
2583
"""Assert whether path or paths are in the WorkingTree"""
2585
tree = workingtree.WorkingTree.open(root_path)
2586
if not isinstance(path, basestring):
2588
self.assertInWorkingTree(p, tree=tree)
2590
self.assertIsNot(tree.path2id(path), None,
2591
path+' not in working tree.')
2593
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2594
"""Assert whether path or paths are not in the WorkingTree"""
2596
tree = workingtree.WorkingTree.open(root_path)
2597
if not isinstance(path, basestring):
2599
self.assertNotInWorkingTree(p,tree=tree)
2601
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2604
class TestCaseWithTransport(TestCaseInTempDir):
2605
"""A test case that provides get_url and get_readonly_url facilities.
2607
These back onto two transport servers, one for readonly access and one for
2610
If no explicit class is provided for readonly access, a
2611
ReadonlyTransportDecorator is used instead which allows the use of non disk
2612
based read write transports.
2614
If an explicit class is provided for readonly access, that server and the
2615
readwrite one must both define get_url() as resolving to os.getcwd().
2618
def get_vfs_only_server(self):
2619
"""See TestCaseWithMemoryTransport.
2621
This is useful for some tests with specific servers that need
2624
if self.__vfs_server is None:
2625
self.__vfs_server = self.vfs_transport_factory()
2626
self.start_server(self.__vfs_server)
2627
return self.__vfs_server
2629
def make_branch_and_tree(self, relpath, format=None):
2630
"""Create a branch on the transport and a tree locally.
2632
If the transport is not a LocalTransport, the Tree can't be created on
2633
the transport. In that case if the vfs_transport_factory is
2634
LocalURLServer the working tree is created in the local
2635
directory backing the transport, and the returned tree's branch and
2636
repository will also be accessed locally. Otherwise a lightweight
2637
checkout is created and returned.
2639
We do this because we can't physically create a tree in the local
2640
path, with a branch reference to the transport_factory url, and
2641
a branch + repository in the vfs_transport, unless the vfs_transport
2642
namespace is distinct from the local disk - the two branch objects
2643
would collide. While we could construct a tree with its branch object
2644
pointing at the transport_factory transport in memory, reopening it
2645
would behaving unexpectedly, and has in the past caused testing bugs
2646
when we tried to do it that way.
2648
:param format: The BzrDirFormat.
2649
:returns: the WorkingTree.
2651
# TODO: always use the local disk path for the working tree,
2652
# this obviously requires a format that supports branch references
2653
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2655
b = self.make_branch(relpath, format=format)
2657
return b.bzrdir.create_workingtree()
2658
except errors.NotLocalUrl:
2659
# We can only make working trees locally at the moment. If the
2660
# transport can't support them, then we keep the non-disk-backed
2661
# branch and create a local checkout.
2662
if self.vfs_transport_factory is LocalURLServer:
2663
# the branch is colocated on disk, we cannot create a checkout.
2664
# hopefully callers will expect this.
2665
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2666
wt = local_controldir.create_workingtree()
2667
if wt.branch._format != b._format:
2669
# Make sure that assigning to wt._branch fixes wt.branch,
2670
# in case the implementation details of workingtree objects
2672
self.assertIs(b, wt.branch)
2675
return b.create_checkout(relpath, lightweight=True)
2677
def assertIsDirectory(self, relpath, transport):
2678
"""Assert that relpath within transport is a directory.
2680
This may not be possible on all transports; in that case it propagates
2681
a TransportNotPossible.
2684
mode = transport.stat(relpath).st_mode
2685
except errors.NoSuchFile:
2686
self.fail("path %s is not a directory; no such file"
2688
if not stat.S_ISDIR(mode):
2689
self.fail("path %s is not a directory; has mode %#o"
2692
def assertTreesEqual(self, left, right):
2693
"""Check that left and right have the same content and properties."""
2694
# we use a tree delta to check for equality of the content, and we
2695
# manually check for equality of other things such as the parents list.
2696
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2697
differences = left.changes_from(right)
2698
self.assertFalse(differences.has_changed(),
2699
"Trees %r and %r are different: %r" % (left, right, differences))
2702
super(TestCaseWithTransport, self).setUp()
2703
self.__vfs_server = None
2705
def disable_missing_extensions_warning(self):
2706
"""Some tests expect a precise stderr content.
2708
There is no point in forcing them to duplicate the extension related
2711
config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
2714
class ChrootedTestCase(TestCaseWithTransport):
2715
"""A support class that provides readonly urls outside the local namespace.
2717
This is done by checking if self.transport_server is a MemoryServer. if it
2718
is then we are chrooted already, if it is not then an HttpServer is used
2721
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2722
be used without needed to redo it when a different
2723
subclass is in use ?
2727
super(ChrootedTestCase, self).setUp()
2728
if not self.vfs_transport_factory == MemoryServer:
2729
self.transport_readonly_server = HttpServer
2732
def condition_id_re(pattern):
2733
"""Create a condition filter which performs a re check on a test's id.
2735
:param pattern: A regular expression string.
2736
:return: A callable that returns True if the re matches.
2738
filter_re = osutils.re_compile_checked(pattern, 0,
2740
def condition(test):
2742
return filter_re.search(test_id)
2746
def condition_isinstance(klass_or_klass_list):
2747
"""Create a condition filter which returns isinstance(param, klass).
2749
:return: A callable which when called with one parameter obj return the
2750
result of isinstance(obj, klass_or_klass_list).
2753
return isinstance(obj, klass_or_klass_list)
2757
def condition_id_in_list(id_list):
2758
"""Create a condition filter which verify that test's id in a list.
2760
:param id_list: A TestIdList object.
2761
:return: A callable that returns True if the test's id appears in the list.
2763
def condition(test):
2764
return id_list.includes(test.id())
2768
def condition_id_startswith(starts):
2769
"""Create a condition filter verifying that test's id starts with a string.
2771
:param starts: A list of string.
2772
:return: A callable that returns True if the test's id starts with one of
2775
def condition(test):
2776
for start in starts:
2777
if test.id().startswith(start):
2783
def exclude_tests_by_condition(suite, condition):
2784
"""Create a test suite which excludes some tests from suite.
2786
:param suite: The suite to get tests from.
2787
:param condition: A callable whose result evaluates True when called with a
2788
test case which should be excluded from the result.
2789
:return: A suite which contains the tests found in suite that fail
2793
for test in iter_suite_tests(suite):
2794
if not condition(test):
2796
return TestUtil.TestSuite(result)
2799
def filter_suite_by_condition(suite, condition):
2800
"""Create a test suite by filtering another one.
2802
:param suite: The source suite.
2803
:param condition: A callable whose result evaluates True when called with a
2804
test case which should be included in the result.
2805
:return: A suite which contains the tests found in suite that pass
2809
for test in iter_suite_tests(suite):
2812
return TestUtil.TestSuite(result)
2815
def filter_suite_by_re(suite, pattern):
2816
"""Create a test suite by filtering another one.
2818
:param suite: the source suite
2819
:param pattern: pattern that names must match
2820
:returns: the newly created suite
2822
condition = condition_id_re(pattern)
2823
result_suite = filter_suite_by_condition(suite, condition)
2827
def filter_suite_by_id_list(suite, test_id_list):
2828
"""Create a test suite by filtering another one.
2830
:param suite: The source suite.
2831
:param test_id_list: A list of the test ids to keep as strings.
2832
:returns: the newly created suite
2834
condition = condition_id_in_list(test_id_list)
2835
result_suite = filter_suite_by_condition(suite, condition)
2839
def filter_suite_by_id_startswith(suite, start):
2840
"""Create a test suite by filtering another one.
2842
:param suite: The source suite.
2843
:param start: A list of string the test id must start with one of.
2844
:returns: the newly created suite
2846
condition = condition_id_startswith(start)
2847
result_suite = filter_suite_by_condition(suite, condition)
2851
def exclude_tests_by_re(suite, pattern):
2852
"""Create a test suite which excludes some tests from suite.
2854
:param suite: The suite to get tests from.
2855
:param pattern: A regular expression string. Test ids that match this
2856
pattern will be excluded from the result.
2857
:return: A TestSuite that contains all the tests from suite without the
2858
tests that matched pattern. The order of tests is the same as it was in
2861
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2864
def preserve_input(something):
2865
"""A helper for performing test suite transformation chains.
2867
:param something: Anything you want to preserve.
2873
def randomize_suite(suite):
2874
"""Return a new TestSuite with suite's tests in random order.
2876
The tests in the input suite are flattened into a single suite in order to
2877
accomplish this. Any nested TestSuites are removed to provide global
2880
tests = list(iter_suite_tests(suite))
2881
random.shuffle(tests)
2882
return TestUtil.TestSuite(tests)
2885
def split_suite_by_condition(suite, condition):
2886
"""Split a test suite into two by a condition.
2888
:param suite: The suite to split.
2889
:param condition: The condition to match on. Tests that match this
2890
condition are returned in the first test suite, ones that do not match
2891
are in the second suite.
2892
:return: A tuple of two test suites, where the first contains tests from
2893
suite matching the condition, and the second contains the remainder
2894
from suite. The order within each output suite is the same as it was in
2899
for test in iter_suite_tests(suite):
2901
matched.append(test)
2903
did_not_match.append(test)
2904
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2907
def split_suite_by_re(suite, pattern):
2908
"""Split a test suite into two by a regular expression.
2910
:param suite: The suite to split.
2911
:param pattern: A regular expression string. Test ids that match this
2912
pattern will be in the first test suite returned, and the others in the
2913
second test suite returned.
2914
:return: A tuple of two test suites, where the first contains tests from
2915
suite matching pattern, and the second contains the remainder from
2916
suite. The order within each output suite is the same as it was in
2919
return split_suite_by_condition(suite, condition_id_re(pattern))
2922
def run_suite(suite, name='test', verbose=False, pattern=".*",
2923
stop_on_failure=False,
2924
transport=None, lsprof_timed=None, bench_history=None,
2925
matching_tests_first=None,
2928
exclude_pattern=None,
2931
suite_decorators=None,
2933
result_decorators=None,
2935
"""Run a test suite for bzr selftest.
2937
:param runner_class: The class of runner to use. Must support the
2938
constructor arguments passed by run_suite which are more than standard
2940
:return: A boolean indicating success.
2942
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2947
if runner_class is None:
2948
runner_class = TextTestRunner
2951
runner = runner_class(stream=stream,
2953
verbosity=verbosity,
2954
bench_history=bench_history,
2956
result_decorators=result_decorators,
2958
runner.stop_on_failure=stop_on_failure
2959
# built in decorator factories:
2961
random_order(random_seed, runner),
2962
exclude_tests(exclude_pattern),
2964
if matching_tests_first:
2965
decorators.append(tests_first(pattern))
2967
decorators.append(filter_tests(pattern))
2968
if suite_decorators:
2969
decorators.extend(suite_decorators)
2970
# tell the result object how many tests will be running: (except if
2971
# --parallel=fork is being used. Robert said he will provide a better
2972
# progress design later -- vila 20090817)
2973
if fork_decorator not in decorators:
2974
decorators.append(CountingDecorator)
2975
for decorator in decorators:
2976
suite = decorator(suite)
2978
# Done after test suite decoration to allow randomisation etc
2979
# to take effect, though that is of marginal benefit.
2981
stream.write("Listing tests only ...\n")
2982
for t in iter_suite_tests(suite):
2983
stream.write("%s\n" % (t.id()))
2985
result = runner.run(suite)
2987
return result.wasStrictlySuccessful()
2989
return result.wasSuccessful()
2992
# A registry where get() returns a suite decorator.
2993
parallel_registry = registry.Registry()
2996
def fork_decorator(suite):
2997
concurrency = osutils.local_concurrency()
2998
if concurrency == 1:
3000
from testtools import ConcurrentTestSuite
3001
return ConcurrentTestSuite(suite, fork_for_tests)
3002
parallel_registry.register('fork', fork_decorator)
3005
def subprocess_decorator(suite):
3006
concurrency = osutils.local_concurrency()
3007
if concurrency == 1:
3009
from testtools import ConcurrentTestSuite
3010
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3011
parallel_registry.register('subprocess', subprocess_decorator)
3014
def exclude_tests(exclude_pattern):
3015
"""Return a test suite decorator that excludes tests."""
3016
if exclude_pattern is None:
3017
return identity_decorator
3018
def decorator(suite):
3019
return ExcludeDecorator(suite, exclude_pattern)
3023
def filter_tests(pattern):
3025
return identity_decorator
3026
def decorator(suite):
3027
return FilterTestsDecorator(suite, pattern)
3031
def random_order(random_seed, runner):
3032
"""Return a test suite decorator factory for randomising tests order.
3034
:param random_seed: now, a string which casts to a long, or a long.
3035
:param runner: A test runner with a stream attribute to report on.
3037
if random_seed is None:
3038
return identity_decorator
3039
def decorator(suite):
3040
return RandomDecorator(suite, random_seed, runner.stream)
3044
def tests_first(pattern):
3046
return identity_decorator
3047
def decorator(suite):
3048
return TestFirstDecorator(suite, pattern)
3052
def identity_decorator(suite):
3057
class TestDecorator(TestSuite):
3058
"""A decorator for TestCase/TestSuite objects.
3060
Usually, subclasses should override __iter__(used when flattening test
3061
suites), which we do to filter, reorder, parallelise and so on, run() and
3065
def __init__(self, suite):
3066
TestSuite.__init__(self)
3069
def countTestCases(self):
3072
cases += test.countTestCases()
3079
def run(self, result):
3080
# Use iteration on self, not self._tests, to allow subclasses to hook
3083
if result.shouldStop:
3089
class CountingDecorator(TestDecorator):
3090
"""A decorator which calls result.progress(self.countTestCases)."""
3092
def run(self, result):
3093
progress_method = getattr(result, 'progress', None)
3094
if callable(progress_method):
3095
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3096
return super(CountingDecorator, self).run(result)
3099
class ExcludeDecorator(TestDecorator):
3100
"""A decorator which excludes test matching an exclude pattern."""
3102
def __init__(self, suite, exclude_pattern):
3103
TestDecorator.__init__(self, suite)
3104
self.exclude_pattern = exclude_pattern
3105
self.excluded = False
3109
return iter(self._tests)
3110
self.excluded = True
3111
suite = exclude_tests_by_re(self, self.exclude_pattern)
3113
self.addTests(suite)
3114
return iter(self._tests)
3117
class FilterTestsDecorator(TestDecorator):
3118
"""A decorator which filters tests to those matching a pattern."""
3120
def __init__(self, suite, pattern):
3121
TestDecorator.__init__(self, suite)
3122
self.pattern = pattern
3123
self.filtered = False
3127
return iter(self._tests)
3128
self.filtered = True
3129
suite = filter_suite_by_re(self, self.pattern)
3131
self.addTests(suite)
3132
return iter(self._tests)
3135
class RandomDecorator(TestDecorator):
3136
"""A decorator which randomises the order of its tests."""
3138
def __init__(self, suite, random_seed, stream):
3139
TestDecorator.__init__(self, suite)
3140
self.random_seed = random_seed
3141
self.randomised = False
3142
self.stream = stream
3146
return iter(self._tests)
3147
self.randomised = True
3148
self.stream.writeln("Randomizing test order using seed %s\n" %
3149
(self.actual_seed()))
3150
# Initialise the random number generator.
3151
random.seed(self.actual_seed())
3152
suite = randomize_suite(self)
3154
self.addTests(suite)
3155
return iter(self._tests)
3157
def actual_seed(self):
3158
if self.random_seed == "now":
3159
# We convert the seed to a long to make it reuseable across
3160
# invocations (because the user can reenter it).
3161
self.random_seed = long(time.time())
3163
# Convert the seed to a long if we can
3165
self.random_seed = long(self.random_seed)
3168
return self.random_seed
3171
class TestFirstDecorator(TestDecorator):
3172
"""A decorator which moves named tests to the front."""
3174
def __init__(self, suite, pattern):
3175
TestDecorator.__init__(self, suite)
3176
self.pattern = pattern
3177
self.filtered = False
3181
return iter(self._tests)
3182
self.filtered = True
3183
suites = split_suite_by_re(self, self.pattern)
3185
self.addTests(suites)
3186
return iter(self._tests)
3189
def partition_tests(suite, count):
3190
"""Partition suite into count lists of tests."""
3192
tests = list(iter_suite_tests(suite))
3193
tests_per_process = int(math.ceil(float(len(tests)) / count))
3194
for block in range(count):
3195
low_test = block * tests_per_process
3196
high_test = low_test + tests_per_process
3197
process_tests = tests[low_test:high_test]
3198
result.append(process_tests)
3202
def fork_for_tests(suite):
3203
"""Take suite and start up one runner per CPU by forking()
3205
:return: An iterable of TestCase-like objects which can each have
3206
run(result) called on them to feed tests to result.
3208
concurrency = osutils.local_concurrency()
3210
from subunit import TestProtocolClient, ProtocolTestCase
3212
from subunit.test_results import AutoTimingTestResultDecorator
3214
AutoTimingTestResultDecorator = lambda x:x
3215
class TestInOtherProcess(ProtocolTestCase):
3216
# Should be in subunit, I think. RBC.
3217
def __init__(self, stream, pid):
3218
ProtocolTestCase.__init__(self, stream)
3221
def run(self, result):
3223
ProtocolTestCase.run(self, result)
3225
os.waitpid(self.pid, os.WNOHANG)
3227
test_blocks = partition_tests(suite, concurrency)
3228
for process_tests in test_blocks:
3229
process_suite = TestSuite()
3230
process_suite.addTests(process_tests)
3231
c2pread, c2pwrite = os.pipe()
3236
# Leave stderr and stdout open so we can see test noise
3237
# Close stdin so that the child goes away if it decides to
3238
# read from stdin (otherwise its a roulette to see what
3239
# child actually gets keystrokes for pdb etc).
3242
stream = os.fdopen(c2pwrite, 'wb', 1)
3243
subunit_result = AutoTimingTestResultDecorator(
3244
TestProtocolClient(stream))
3245
process_suite.run(subunit_result)
3250
stream = os.fdopen(c2pread, 'rb', 1)
3251
test = TestInOtherProcess(stream, pid)
3256
def reinvoke_for_tests(suite):
3257
"""Take suite and start up one runner per CPU using subprocess().
3259
:return: An iterable of TestCase-like objects which can each have
3260
run(result) called on them to feed tests to result.
3262
concurrency = osutils.local_concurrency()
3264
from subunit import ProtocolTestCase
3265
class TestInSubprocess(ProtocolTestCase):
3266
def __init__(self, process, name):
3267
ProtocolTestCase.__init__(self, process.stdout)
3268
self.process = process
3269
self.process.stdin.close()
3272
def run(self, result):
3274
ProtocolTestCase.run(self, result)
3277
os.unlink(self.name)
3278
# print "pid %d finished" % finished_process
3279
test_blocks = partition_tests(suite, concurrency)
3280
for process_tests in test_blocks:
3281
# ugly; currently reimplement rather than reuses TestCase methods.
3282
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3283
if not os.path.isfile(bzr_path):
3284
# We are probably installed. Assume sys.argv is the right file
3285
bzr_path = sys.argv[0]
3286
fd, test_list_file_name = tempfile.mkstemp()
3287
test_list_file = os.fdopen(fd, 'wb', 1)
3288
for test in process_tests:
3289
test_list_file.write(test.id() + '\n')
3290
test_list_file.close()
3292
argv = [bzr_path, 'selftest', '--load-list', test_list_file_name,
3294
if '--no-plugins' in sys.argv:
3295
argv.append('--no-plugins')
3296
# stderr=STDOUT would be ideal, but until we prevent noise on
3297
# stderr it can interrupt the subunit protocol.
3298
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3300
test = TestInSubprocess(process, test_list_file_name)
3303
os.unlink(test_list_file_name)
3308
class ForwardingResult(unittest.TestResult):
3310
def __init__(self, target):
3311
unittest.TestResult.__init__(self)
3312
self.result = target
3314
def startTest(self, test):
3315
self.result.startTest(test)
3317
def stopTest(self, test):
3318
self.result.stopTest(test)
3320
def startTestRun(self):
3321
self.result.startTestRun()
3323
def stopTestRun(self):
3324
self.result.stopTestRun()
3326
def addSkip(self, test, reason):
3327
self.result.addSkip(test, reason)
3329
def addSuccess(self, test):
3330
self.result.addSuccess(test)
3332
def addError(self, test, err):
3333
self.result.addError(test, err)
3335
def addFailure(self, test, err):
3336
self.result.addFailure(test, err)
3339
class BZRTransformingResult(ForwardingResult):
3341
def addError(self, test, err):
3342
feature = self._error_looks_like('UnavailableFeature: ', err)
3343
if feature is not None:
3344
self.result.addNotSupported(test, feature)
3346
self.result.addError(test, err)
3348
def addFailure(self, test, err):
3349
known = self._error_looks_like('KnownFailure: ', err)
3350
if known is not None:
3351
self.result._addKnownFailure(test, [KnownFailure,
3352
KnownFailure(known), None])
3354
self.result.addFailure(test, err)
3356
def _error_looks_like(self, prefix, err):
3357
"""Deserialize exception and returns the stringify value."""
3361
if isinstance(exc, subunit.RemoteException):
3362
# stringify the exception gives access to the remote traceback
3363
# We search the last line for 'prefix'
3364
lines = str(exc).split('\n')
3365
while lines and not lines[-1]:
3368
if lines[-1].startswith(prefix):
3369
value = lines[-1][len(prefix):]
3373
class ProfileResult(ForwardingResult):
3374
"""Generate profiling data for all activity between start and success.
3376
The profile data is appended to the test's _benchcalls attribute and can
3377
be accessed by the forwarded-to TestResult.
3379
While it might be cleaner do accumulate this in stopTest, addSuccess is
3380
where our existing output support for lsprof is, and this class aims to
3381
fit in with that: while it could be moved it's not necessary to accomplish
3382
test profiling, nor would it be dramatically cleaner.
3385
def startTest(self, test):
3386
self.profiler = bzrlib.lsprof.BzrProfiler()
3387
self.profiler.start()
3388
ForwardingResult.startTest(self, test)
3390
def addSuccess(self, test):
3391
stats = self.profiler.stop()
3393
calls = test._benchcalls
3394
except AttributeError:
3395
test._benchcalls = []
3396
calls = test._benchcalls
3397
calls.append(((test.id(), "", ""), stats))
3398
ForwardingResult.addSuccess(self, test)
3400
def stopTest(self, test):
3401
ForwardingResult.stopTest(self, test)
3402
self.profiler = None
3405
# Controlled by "bzr selftest -E=..." option
3406
# Currently supported:
3407
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3408
# preserves any flags supplied at the command line.
3409
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3410
# rather than failing tests. And no longer raise
3411
# LockContention when fctnl locks are not being used
3412
# with proper exclusion rules.
3413
selftest_debug_flags = set()
3416
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3418
test_suite_factory=None,
3421
matching_tests_first=None,
3424
exclude_pattern=None,
3430
suite_decorators=None,
3434
"""Run the whole test suite under the enhanced runner"""
3435
# XXX: Very ugly way to do this...
3436
# Disable warning about old formats because we don't want it to disturb
3437
# any blackbox tests.
3438
from bzrlib import repository
3439
repository._deprecation_warning_done = True
3441
global default_transport
3442
if transport is None:
3443
transport = default_transport
3444
old_transport = default_transport
3445
default_transport = transport
3446
global selftest_debug_flags
3447
old_debug_flags = selftest_debug_flags
3448
if debug_flags is not None:
3449
selftest_debug_flags = set(debug_flags)
3451
if load_list is None:
3454
keep_only = load_test_id_list(load_list)
3456
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3457
for start in starting_with]
3458
if test_suite_factory is None:
3459
# Reduce loading time by loading modules based on the starting_with
3461
suite = test_suite(keep_only, starting_with)
3463
suite = test_suite_factory()
3465
# But always filter as requested.
3466
suite = filter_suite_by_id_startswith(suite, starting_with)
3467
result_decorators = []
3469
result_decorators.append(ProfileResult)
3470
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3471
stop_on_failure=stop_on_failure,
3472
transport=transport,
3473
lsprof_timed=lsprof_timed,
3474
bench_history=bench_history,
3475
matching_tests_first=matching_tests_first,
3476
list_only=list_only,
3477
random_seed=random_seed,
3478
exclude_pattern=exclude_pattern,
3480
runner_class=runner_class,
3481
suite_decorators=suite_decorators,
3483
result_decorators=result_decorators,
3486
default_transport = old_transport
3487
selftest_debug_flags = old_debug_flags
3490
def load_test_id_list(file_name):
3491
"""Load a test id list from a text file.
3493
The format is one test id by line. No special care is taken to impose
3494
strict rules, these test ids are used to filter the test suite so a test id
3495
that do not match an existing test will do no harm. This allows user to add
3496
comments, leave blank lines, etc.
3500
ftest = open(file_name, 'rt')
3502
if e.errno != errno.ENOENT:
3505
raise errors.NoSuchFile(file_name)
3507
for test_name in ftest.readlines():
3508
test_list.append(test_name.strip())
3513
def suite_matches_id_list(test_suite, id_list):
3514
"""Warns about tests not appearing or appearing more than once.
3516
:param test_suite: A TestSuite object.
3517
:param test_id_list: The list of test ids that should be found in
3520
:return: (absents, duplicates) absents is a list containing the test found
3521
in id_list but not in test_suite, duplicates is a list containing the
3522
test found multiple times in test_suite.
3524
When using a prefined test id list, it may occurs that some tests do not
3525
exist anymore or that some tests use the same id. This function warns the
3526
tester about potential problems in his workflow (test lists are volatile)
3527
or in the test suite itself (using the same id for several tests does not
3528
help to localize defects).
3530
# Build a dict counting id occurrences
3532
for test in iter_suite_tests(test_suite):
3534
tests[id] = tests.get(id, 0) + 1
3539
occurs = tests.get(id, 0)
3541
not_found.append(id)
3543
duplicates.append(id)
3545
return not_found, duplicates
3548
class TestIdList(object):
3549
"""Test id list to filter a test suite.
3551
Relying on the assumption that test ids are built as:
3552
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3553
notation, this class offers methods to :
3554
- avoid building a test suite for modules not refered to in the test list,
3555
- keep only the tests listed from the module test suite.
3558
def __init__(self, test_id_list):
3559
# When a test suite needs to be filtered against us we compare test ids
3560
# for equality, so a simple dict offers a quick and simple solution.
3561
self.tests = dict().fromkeys(test_id_list, True)
3563
# While unittest.TestCase have ids like:
3564
# <module>.<class>.<method>[(<param+)],
3565
# doctest.DocTestCase can have ids like:
3568
# <module>.<function>
3569
# <module>.<class>.<method>
3571
# Since we can't predict a test class from its name only, we settle on
3572
# a simple constraint: a test id always begins with its module name.
3575
for test_id in test_id_list:
3576
parts = test_id.split('.')
3577
mod_name = parts.pop(0)
3578
modules[mod_name] = True
3580
mod_name += '.' + part
3581
modules[mod_name] = True
3582
self.modules = modules
3584
def refers_to(self, module_name):
3585
"""Is there tests for the module or one of its sub modules."""
3586
return self.modules.has_key(module_name)
3588
def includes(self, test_id):
3589
return self.tests.has_key(test_id)
3592
class TestPrefixAliasRegistry(registry.Registry):
3593
"""A registry for test prefix aliases.
3595
This helps implement shorcuts for the --starting-with selftest
3596
option. Overriding existing prefixes is not allowed but not fatal (a
3597
warning will be emitted).
3600
def register(self, key, obj, help=None, info=None,
3601
override_existing=False):
3602
"""See Registry.register.
3604
Trying to override an existing alias causes a warning to be emitted,
3605
not a fatal execption.
3608
super(TestPrefixAliasRegistry, self).register(
3609
key, obj, help=help, info=info, override_existing=False)
3611
actual = self.get(key)
3612
note('Test prefix alias %s is already used for %s, ignoring %s'
3613
% (key, actual, obj))
3615
def resolve_alias(self, id_start):
3616
"""Replace the alias by the prefix in the given string.
3618
Using an unknown prefix is an error to help catching typos.
3620
parts = id_start.split('.')
3622
parts[0] = self.get(parts[0])
3624
raise errors.BzrCommandError(
3625
'%s is not a known test prefix alias' % parts[0])
3626
return '.'.join(parts)
3629
test_prefix_alias_registry = TestPrefixAliasRegistry()
3630
"""Registry of test prefix aliases."""
3633
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3634
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3635
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3637
# Obvious higest levels prefixes, feel free to add your own via a plugin
3638
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3639
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3640
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3641
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3642
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3645
def _test_suite_testmod_names():
3646
"""Return the standard list of test module names to test."""
3649
'bzrlib.tests.blackbox',
3650
'bzrlib.tests.commands',
3651
'bzrlib.tests.per_branch',
3652
'bzrlib.tests.per_bzrdir',
3653
'bzrlib.tests.per_interrepository',
3654
'bzrlib.tests.per_intertree',
3655
'bzrlib.tests.per_inventory',
3656
'bzrlib.tests.per_interbranch',
3657
'bzrlib.tests.per_lock',
3658
'bzrlib.tests.per_transport',
3659
'bzrlib.tests.per_tree',
3660
'bzrlib.tests.per_pack_repository',
3661
'bzrlib.tests.per_repository',
3662
'bzrlib.tests.per_repository_chk',
3663
'bzrlib.tests.per_repository_reference',
3664
'bzrlib.tests.per_versionedfile',
3665
'bzrlib.tests.per_workingtree',
3666
'bzrlib.tests.test__annotator',
3667
'bzrlib.tests.test__chk_map',
3668
'bzrlib.tests.test__dirstate_helpers',
3669
'bzrlib.tests.test__groupcompress',
3670
'bzrlib.tests.test__known_graph',
3671
'bzrlib.tests.test__rio',
3672
'bzrlib.tests.test__walkdirs_win32',
3673
'bzrlib.tests.test_ancestry',
3674
'bzrlib.tests.test_annotate',
3675
'bzrlib.tests.test_api',
3676
'bzrlib.tests.test_atomicfile',
3677
'bzrlib.tests.test_bad_files',
3678
'bzrlib.tests.test_bencode',
3679
'bzrlib.tests.test_bisect_multi',
3680
'bzrlib.tests.test_branch',
3681
'bzrlib.tests.test_branchbuilder',
3682
'bzrlib.tests.test_btree_index',
3683
'bzrlib.tests.test_bugtracker',
3684
'bzrlib.tests.test_bundle',
3685
'bzrlib.tests.test_bzrdir',
3686
'bzrlib.tests.test__chunks_to_lines',
3687
'bzrlib.tests.test_cache_utf8',
3688
'bzrlib.tests.test_chk_map',
3689
'bzrlib.tests.test_chk_serializer',
3690
'bzrlib.tests.test_chunk_writer',
3691
'bzrlib.tests.test_clean_tree',
3692
'bzrlib.tests.test_commands',
3693
'bzrlib.tests.test_commit',
3694
'bzrlib.tests.test_commit_merge',
3695
'bzrlib.tests.test_config',
3696
'bzrlib.tests.test_conflicts',
3697
'bzrlib.tests.test_counted_lock',
3698
'bzrlib.tests.test_crash',
3699
'bzrlib.tests.test_decorators',
3700
'bzrlib.tests.test_delta',
3701
'bzrlib.tests.test_debug',
3702
'bzrlib.tests.test_deprecated_graph',
3703
'bzrlib.tests.test_diff',
3704
'bzrlib.tests.test_directory_service',
3705
'bzrlib.tests.test_dirstate',
3706
'bzrlib.tests.test_email_message',
3707
'bzrlib.tests.test_eol_filters',
3708
'bzrlib.tests.test_errors',
3709
'bzrlib.tests.test_export',
3710
'bzrlib.tests.test_extract',
3711
'bzrlib.tests.test_fetch',
3712
'bzrlib.tests.test_fifo_cache',
3713
'bzrlib.tests.test_filters',
3714
'bzrlib.tests.test_ftp_transport',
3715
'bzrlib.tests.test_foreign',
3716
'bzrlib.tests.test_generate_docs',
3717
'bzrlib.tests.test_generate_ids',
3718
'bzrlib.tests.test_globbing',
3719
'bzrlib.tests.test_gpg',
3720
'bzrlib.tests.test_graph',
3721
'bzrlib.tests.test_groupcompress',
3722
'bzrlib.tests.test_hashcache',
3723
'bzrlib.tests.test_help',
3724
'bzrlib.tests.test_hooks',
3725
'bzrlib.tests.test_http',
3726
'bzrlib.tests.test_http_response',
3727
'bzrlib.tests.test_https_ca_bundle',
3728
'bzrlib.tests.test_identitymap',
3729
'bzrlib.tests.test_ignores',
3730
'bzrlib.tests.test_index',
3731
'bzrlib.tests.test_info',
3732
'bzrlib.tests.test_inv',
3733
'bzrlib.tests.test_inventory_delta',
3734
'bzrlib.tests.test_knit',
3735
'bzrlib.tests.test_lazy_import',
3736
'bzrlib.tests.test_lazy_regex',
3737
'bzrlib.tests.test_lock',
3738
'bzrlib.tests.test_lockable_files',
3739
'bzrlib.tests.test_lockdir',
3740
'bzrlib.tests.test_log',
3741
'bzrlib.tests.test_lru_cache',
3742
'bzrlib.tests.test_lsprof',
3743
'bzrlib.tests.test_mail_client',
3744
'bzrlib.tests.test_memorytree',
3745
'bzrlib.tests.test_merge',
3746
'bzrlib.tests.test_merge3',
3747
'bzrlib.tests.test_merge_core',
3748
'bzrlib.tests.test_merge_directive',
3749
'bzrlib.tests.test_missing',
3750
'bzrlib.tests.test_msgeditor',
3751
'bzrlib.tests.test_multiparent',
3752
'bzrlib.tests.test_mutabletree',
3753
'bzrlib.tests.test_nonascii',
3754
'bzrlib.tests.test_options',
3755
'bzrlib.tests.test_osutils',
3756
'bzrlib.tests.test_osutils_encodings',
3757
'bzrlib.tests.test_pack',
3758
'bzrlib.tests.test_patch',
3759
'bzrlib.tests.test_patches',
3760
'bzrlib.tests.test_permissions',
3761
'bzrlib.tests.test_plugins',
3762
'bzrlib.tests.test_progress',
3763
'bzrlib.tests.test_read_bundle',
3764
'bzrlib.tests.test_reconcile',
3765
'bzrlib.tests.test_reconfigure',
3766
'bzrlib.tests.test_registry',
3767
'bzrlib.tests.test_remote',
3768
'bzrlib.tests.test_rename_map',
3769
'bzrlib.tests.test_repository',
3770
'bzrlib.tests.test_revert',
3771
'bzrlib.tests.test_revision',
3772
'bzrlib.tests.test_revisionspec',
3773
'bzrlib.tests.test_revisiontree',
3774
'bzrlib.tests.test_rio',
3775
'bzrlib.tests.test_rules',
3776
'bzrlib.tests.test_sampler',
3777
'bzrlib.tests.test_script',
3778
'bzrlib.tests.test_selftest',
3779
'bzrlib.tests.test_serializer',
3780
'bzrlib.tests.test_setup',
3781
'bzrlib.tests.test_sftp_transport',
3782
'bzrlib.tests.test_shelf',
3783
'bzrlib.tests.test_shelf_ui',
3784
'bzrlib.tests.test_smart',
3785
'bzrlib.tests.test_smart_add',
3786
'bzrlib.tests.test_smart_request',
3787
'bzrlib.tests.test_smart_transport',
3788
'bzrlib.tests.test_smtp_connection',
3789
'bzrlib.tests.test_source',
3790
'bzrlib.tests.test_ssh_transport',
3791
'bzrlib.tests.test_status',
3792
'bzrlib.tests.test_store',
3793
'bzrlib.tests.test_strace',
3794
'bzrlib.tests.test_subsume',
3795
'bzrlib.tests.test_switch',
3796
'bzrlib.tests.test_symbol_versioning',
3797
'bzrlib.tests.test_tag',
3798
'bzrlib.tests.test_testament',
3799
'bzrlib.tests.test_textfile',
3800
'bzrlib.tests.test_textmerge',
3801
'bzrlib.tests.test_timestamp',
3802
'bzrlib.tests.test_trace',
3803
'bzrlib.tests.test_transactions',
3804
'bzrlib.tests.test_transform',
3805
'bzrlib.tests.test_transport',
3806
'bzrlib.tests.test_transport_log',
3807
'bzrlib.tests.test_tree',
3808
'bzrlib.tests.test_treebuilder',
3809
'bzrlib.tests.test_tsort',
3810
'bzrlib.tests.test_tuned_gzip',
3811
'bzrlib.tests.test_ui',
3812
'bzrlib.tests.test_uncommit',
3813
'bzrlib.tests.test_upgrade',
3814
'bzrlib.tests.test_upgrade_stacked',
3815
'bzrlib.tests.test_urlutils',
3816
'bzrlib.tests.test_version',
3817
'bzrlib.tests.test_version_info',
3818
'bzrlib.tests.test_weave',
3819
'bzrlib.tests.test_whitebox',
3820
'bzrlib.tests.test_win32utils',
3821
'bzrlib.tests.test_workingtree',
3822
'bzrlib.tests.test_workingtree_4',
3823
'bzrlib.tests.test_wsgi',
3824
'bzrlib.tests.test_xml',
3828
def _test_suite_modules_to_doctest():
3829
"""Return the list of modules to doctest."""
3832
'bzrlib.branchbuilder',
3835
'bzrlib.iterablefile',
3839
'bzrlib.symbol_versioning',
3842
'bzrlib.version_info_formats.format_custom',
3846
def test_suite(keep_only=None, starting_with=None):
3847
"""Build and return TestSuite for the whole of bzrlib.
3849
:param keep_only: A list of test ids limiting the suite returned.
3851
:param starting_with: An id limiting the suite returned to the tests
3854
This function can be replaced if you need to change the default test
3855
suite on a global basis, but it is not encouraged.
3858
loader = TestUtil.TestLoader()
3860
if keep_only is not None:
3861
id_filter = TestIdList(keep_only)
3863
# We take precedence over keep_only because *at loading time* using
3864
# both options means we will load less tests for the same final result.
3865
def interesting_module(name):
3866
for start in starting_with:
3868
# Either the module name starts with the specified string
3869
name.startswith(start)
3870
# or it may contain tests starting with the specified string
3871
or start.startswith(name)
3875
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3877
elif keep_only is not None:
3878
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3879
def interesting_module(name):
3880
return id_filter.refers_to(name)
3883
loader = TestUtil.TestLoader()
3884
def interesting_module(name):
3885
# No filtering, all modules are interesting
3888
suite = loader.suiteClass()
3890
# modules building their suite with loadTestsFromModuleNames
3891
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3893
for mod in _test_suite_modules_to_doctest():
3894
if not interesting_module(mod):
3895
# No tests to keep here, move along
3898
# note that this really does mean "report only" -- doctest
3899
# still runs the rest of the examples
3900
doc_suite = doctest.DocTestSuite(mod,
3901
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3902
except ValueError, e:
3903
print '**failed to get doctest for: %s\n%s' % (mod, e)
3905
if len(doc_suite._tests) == 0:
3906
raise errors.BzrError("no doctests found in %s" % (mod,))
3907
suite.addTest(doc_suite)
3909
default_encoding = sys.getdefaultencoding()
3910
for name, plugin in bzrlib.plugin.plugins().items():
3911
if not interesting_module(plugin.module.__name__):
3913
plugin_suite = plugin.test_suite()
3914
# We used to catch ImportError here and turn it into just a warning,
3915
# but really if you don't have --no-plugins this should be a failure.
3916
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3917
if plugin_suite is None:
3918
plugin_suite = plugin.load_plugin_tests(loader)
3919
if plugin_suite is not None:
3920
suite.addTest(plugin_suite)
3921
if default_encoding != sys.getdefaultencoding():
3922
bzrlib.trace.warning(
3923
'Plugin "%s" tried to reset default encoding to: %s', name,
3924
sys.getdefaultencoding())
3926
sys.setdefaultencoding(default_encoding)
3928
if keep_only is not None:
3929
# Now that the referred modules have loaded their tests, keep only the
3931
suite = filter_suite_by_id_list(suite, id_filter)
3932
# Do some sanity checks on the id_list filtering
3933
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3935
# The tester has used both keep_only and starting_with, so he is
3936
# already aware that some tests are excluded from the list, there
3937
# is no need to tell him which.
3940
# Some tests mentioned in the list are not in the test suite. The
3941
# list may be out of date, report to the tester.
3942
for id in not_found:
3943
bzrlib.trace.warning('"%s" not found in the test suite', id)
3944
for id in duplicates:
3945
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3950
def multiply_scenarios(scenarios_left, scenarios_right):
3951
"""Multiply two sets of scenarios.
3953
:returns: the cartesian product of the two sets of scenarios, that is
3954
a scenario for every possible combination of a left scenario and a
3958
('%s,%s' % (left_name, right_name),
3959
dict(left_dict.items() + right_dict.items()))
3960
for left_name, left_dict in scenarios_left
3961
for right_name, right_dict in scenarios_right]
3964
def multiply_tests(tests, scenarios, result):
3965
"""Multiply tests_list by scenarios into result.
3967
This is the core workhorse for test parameterisation.
3969
Typically the load_tests() method for a per-implementation test suite will
3970
call multiply_tests and return the result.
3972
:param tests: The tests to parameterise.
3973
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3974
scenario_param_dict).
3975
:param result: A TestSuite to add created tests to.
3977
This returns the passed in result TestSuite with the cross product of all
3978
the tests repeated once for each scenario. Each test is adapted by adding
3979
the scenario name at the end of its id(), and updating the test object's
3980
__dict__ with the scenario_param_dict.
3982
>>> import bzrlib.tests.test_sampler
3983
>>> r = multiply_tests(
3984
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3985
... [('one', dict(param=1)),
3986
... ('two', dict(param=2))],
3988
>>> tests = list(iter_suite_tests(r))
3992
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3998
for test in iter_suite_tests(tests):
3999
apply_scenarios(test, scenarios, result)
4003
def apply_scenarios(test, scenarios, result):
4004
"""Apply the scenarios in scenarios to test and add to result.
4006
:param test: The test to apply scenarios to.
4007
:param scenarios: An iterable of scenarios to apply to test.
4009
:seealso: apply_scenario
4011
for scenario in scenarios:
4012
result.addTest(apply_scenario(test, scenario))
4016
def apply_scenario(test, scenario):
4017
"""Copy test and apply scenario to it.
4019
:param test: A test to adapt.
4020
:param scenario: A tuple describing the scenarion.
4021
The first element of the tuple is the new test id.
4022
The second element is a dict containing attributes to set on the
4024
:return: The adapted test.
4026
new_id = "%s(%s)" % (test.id(), scenario[0])
4027
new_test = clone_test(test, new_id)
4028
for name, value in scenario[1].items():
4029
setattr(new_test, name, value)
4033
def clone_test(test, new_id):
4034
"""Clone a test giving it a new id.
4036
:param test: The test to clone.
4037
:param new_id: The id to assign to it.
4038
:return: The new test.
4040
new_test = copy(test)
4041
new_test.id = lambda: new_id
4045
def _rmtree_temp_dir(dirname):
4046
# If LANG=C we probably have created some bogus paths
4047
# which rmtree(unicode) will fail to delete
4048
# so make sure we are using rmtree(str) to delete everything
4049
# except on win32, where rmtree(str) will fail
4050
# since it doesn't have the property of byte-stream paths
4051
# (they are either ascii or mbcs)
4052
if sys.platform == 'win32':
4053
# make sure we are using the unicode win32 api
4054
dirname = unicode(dirname)
4056
dirname = dirname.encode(sys.getfilesystemencoding())
4058
osutils.rmtree(dirname)
4060
# We don't want to fail here because some useful display will be lost
4061
# otherwise. Polluting the tmp dir is bad, but not giving all the
4062
# possible info to the test runner is even worse.
4063
sys.stderr.write('Unable to remove testing dir %s\n%s'
4064
% (os.path.basename(dirname), e))
4067
class Feature(object):
4068
"""An operating system Feature."""
4071
self._available = None
4073
def available(self):
4074
"""Is the feature available?
4076
:return: True if the feature is available.
4078
if self._available is None:
4079
self._available = self._probe()
4080
return self._available
4083
"""Implement this method in concrete features.
4085
:return: True if the feature is available.
4087
raise NotImplementedError
4090
if getattr(self, 'feature_name', None):
4091
return self.feature_name()
4092
return self.__class__.__name__
4095
class _SymlinkFeature(Feature):
4098
return osutils.has_symlinks()
4100
def feature_name(self):
4103
SymlinkFeature = _SymlinkFeature()
4106
class _HardlinkFeature(Feature):
4109
return osutils.has_hardlinks()
4111
def feature_name(self):
4114
HardlinkFeature = _HardlinkFeature()
4117
class _OsFifoFeature(Feature):
4120
return getattr(os, 'mkfifo', None)
4122
def feature_name(self):
4123
return 'filesystem fifos'
4125
OsFifoFeature = _OsFifoFeature()
4128
class _UnicodeFilenameFeature(Feature):
4129
"""Does the filesystem support Unicode filenames?"""
4133
# Check for character combinations unlikely to be covered by any
4134
# single non-unicode encoding. We use the characters
4135
# - greek small letter alpha (U+03B1) and
4136
# - braille pattern dots-123456 (U+283F).
4137
os.stat(u'\u03b1\u283f')
4138
except UnicodeEncodeError:
4140
except (IOError, OSError):
4141
# The filesystem allows the Unicode filename but the file doesn't
4145
# The filesystem allows the Unicode filename and the file exists,
4149
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4152
def probe_unicode_in_user_encoding():
4153
"""Try to encode several unicode strings to use in unicode-aware tests.
4154
Return first successfull match.
4156
:return: (unicode value, encoded plain string value) or (None, None)
4158
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4159
for uni_val in possible_vals:
4161
str_val = uni_val.encode(osutils.get_user_encoding())
4162
except UnicodeEncodeError:
4163
# Try a different character
4166
return uni_val, str_val
4170
def probe_bad_non_ascii(encoding):
4171
"""Try to find [bad] character with code [128..255]
4172
that cannot be decoded to unicode in some encoding.
4173
Return None if all non-ascii characters is valid
4176
for i in xrange(128, 256):
4179
char.decode(encoding)
4180
except UnicodeDecodeError:
4185
class _HTTPSServerFeature(Feature):
4186
"""Some tests want an https Server, check if one is available.
4188
Right now, the only way this is available is under python2.6 which provides
4199
def feature_name(self):
4200
return 'HTTPSServer'
4203
HTTPSServerFeature = _HTTPSServerFeature()
4206
class _ParamikoFeature(Feature):
4207
"""Is paramiko available?"""
4211
from bzrlib.transport.sftp import SFTPAbsoluteServer
4213
except errors.ParamikoNotPresent:
4216
def feature_name(self):
4220
ParamikoFeature = _ParamikoFeature()
4223
class _UnicodeFilename(Feature):
4224
"""Does the filesystem support Unicode filenames?"""
4229
except UnicodeEncodeError:
4231
except (IOError, OSError):
4232
# The filesystem allows the Unicode filename but the file doesn't
4236
# The filesystem allows the Unicode filename and the file exists,
4240
UnicodeFilename = _UnicodeFilename()
4243
class _UTF8Filesystem(Feature):
4244
"""Is the filesystem UTF-8?"""
4247
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4251
UTF8Filesystem = _UTF8Filesystem()
4254
class _CaseInsCasePresFilenameFeature(Feature):
4255
"""Is the file-system case insensitive, but case-preserving?"""
4258
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4260
# first check truly case-preserving for created files, then check
4261
# case insensitive when opening existing files.
4262
name = osutils.normpath(name)
4263
base, rel = osutils.split(name)
4264
found_rel = osutils.canonical_relpath(base, name)
4265
return (found_rel == rel
4266
and os.path.isfile(name.upper())
4267
and os.path.isfile(name.lower()))
4272
def feature_name(self):
4273
return "case-insensitive case-preserving filesystem"
4275
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4278
class _CaseInsensitiveFilesystemFeature(Feature):
4279
"""Check if underlying filesystem is case-insensitive but *not* case
4282
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4283
# more likely to be case preserving, so this case is rare.
4286
if CaseInsCasePresFilenameFeature.available():
4289
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4290
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4291
TestCaseWithMemoryTransport.TEST_ROOT = root
4293
root = TestCaseWithMemoryTransport.TEST_ROOT
4294
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4296
name_a = osutils.pathjoin(tdir, 'a')
4297
name_A = osutils.pathjoin(tdir, 'A')
4299
result = osutils.isdir(name_A)
4300
_rmtree_temp_dir(tdir)
4303
def feature_name(self):
4304
return 'case-insensitive filesystem'
4306
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4309
class _SubUnitFeature(Feature):
4310
"""Check if subunit is available."""
4319
def feature_name(self):
4322
SubUnitFeature = _SubUnitFeature()
4323
# Only define SubUnitBzrRunner if subunit is available.
4325
from subunit import TestProtocolClient
4327
from subunit.test_results import AutoTimingTestResultDecorator
4329
AutoTimingTestResultDecorator = lambda x:x
4330
class SubUnitBzrRunner(TextTestRunner):
4331
def run(self, test):
4332
result = AutoTimingTestResultDecorator(
4333
TestProtocolClient(self.stream))
added
removed
bzrlib/tests/__init__.py
