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.
31
from cStringIO import StringIO
38
from pprint import pformat
43
from subprocess import Popen, PIPE, STDOUT
68
import bzrlib.commands
69
import bzrlib.timestamp
71
import bzrlib.inventory
72
import bzrlib.iterablefile
77
# lsprof not available
79
from bzrlib.merge import merge_inner
82
from bzrlib.smart import client, request, server
84
from bzrlib import symbol_versioning
85
from bzrlib.symbol_versioning import (
92
from bzrlib.transport import get_transport
93
import bzrlib.transport
94
from bzrlib.transport.local import LocalURLServer
95
from bzrlib.transport.memory import MemoryServer
96
from bzrlib.transport.readonly import ReadonlyServer
97
from bzrlib.trace import mutter, note
98
from bzrlib.tests import TestUtil
99
from bzrlib.tests.http_server import HttpServer
100
from bzrlib.tests.TestUtil import (
104
from bzrlib.tests.treeshape import build_tree_contents
105
import bzrlib.version_info_formats.format_custom
106
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
108
# Mark this python module as being part of the implementation
109
# of unittest: this gives us better tracebacks where the last
110
# shown frame is the test code, not our assertXYZ.
113
default_transport = LocalURLServer
116
class ExtendedTestResult(unittest._TextTestResult):
117
"""Accepts, reports and accumulates the results of running tests.
119
Compared to the unittest version this class adds support for
120
profiling, benchmarking, stopping as soon as a test fails, and
121
skipping tests. There are further-specialized subclasses for
122
different types of display.
124
When a test finishes, in whatever way, it calls one of the addSuccess,
125
addFailure or addError classes. These in turn may redirect to a more
126
specific case for the special test results supported by our extended
129
Note that just one of these objects is fed the results from many tests.
134
def __init__(self, stream, descriptions, verbosity,
139
"""Construct new TestResult.
141
:param bench_history: Optionally, a writable file object to accumulate
144
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
145
if bench_history is not None:
146
from bzrlib.version import _get_bzr_source_tree
147
src_tree = _get_bzr_source_tree()
150
revision_id = src_tree.get_parent_ids()[0]
152
# XXX: if this is a brand new tree, do the same as if there
156
# XXX: If there's no branch, what should we do?
158
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
159
self._bench_history = bench_history
160
self.ui = ui.ui_factory
161
self.num_tests = num_tests
163
self.failure_count = 0
164
self.known_failure_count = 0
166
self.not_applicable_count = 0
167
self.unsupported = {}
169
self._overall_start_time = time.time()
170
self._strict = strict
174
ok = self.wasStrictlySuccessful()
176
ok = self.wasSuccessful()
178
self.stream.write('tests passed\n')
180
self.stream.write('tests failed\n')
181
if TestCase._first_thread_leaker_id:
183
'%s is leaking threads among %d leaking tests.\n' % (
184
TestCase._first_thread_leaker_id,
185
TestCase._leaking_threads_tests))
187
def _extractBenchmarkTime(self, testCase):
188
"""Add a benchmark time for the current test case."""
189
return getattr(testCase, "_benchtime", None)
191
def _elapsedTestTimeString(self):
192
"""Return a time string for the overall time the current test has taken."""
193
return self._formatTime(time.time() - self._start_time)
195
def _testTimeString(self, testCase):
196
benchmark_time = self._extractBenchmarkTime(testCase)
197
if benchmark_time is not None:
199
self._formatTime(benchmark_time),
200
self._elapsedTestTimeString())
202
return " %s" % self._elapsedTestTimeString()
204
def _formatTime(self, seconds):
205
"""Format seconds as milliseconds with leading spaces."""
206
# some benchmarks can take thousands of seconds to run, so we need 8
208
return "%8dms" % (1000 * seconds)
210
def _shortened_test_description(self, test):
212
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
215
def startTest(self, test):
216
unittest.TestResult.startTest(self, test)
219
self.report_test_start(test)
220
test.number = self.count
221
self._recordTestStartTime()
223
def startTests(self):
225
'testing: %s\n' % (osutils.realpath(sys.argv[0]),))
227
' %s (%s python%s)\n' % (
229
bzrlib.version_string,
230
bzrlib._format_version_tuple(sys.version_info),
232
self.stream.write('\n')
234
def _recordTestStartTime(self):
235
"""Record that a test has started."""
236
self._start_time = time.time()
238
def _cleanupLogFile(self, test):
239
# We can only do this if we have one of our TestCases, not if
241
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
242
if setKeepLogfile is not None:
245
def addError(self, test, err):
246
"""Tell result that test finished with an error.
248
Called from the TestCase run() method when the test
249
fails with an unexpected error.
251
self._testConcluded(test)
252
if isinstance(err[1], TestNotApplicable):
253
return self._addNotApplicable(test, err)
254
elif isinstance(err[1], UnavailableFeature):
255
return self.addNotSupported(test, err[1].args[0])
257
unittest.TestResult.addError(self, test, err)
258
self.error_count += 1
259
self.report_error(test, err)
262
self._cleanupLogFile(test)
264
def addFailure(self, test, err):
265
"""Tell result that test failed.
267
Called from the TestCase run() method when the test
268
fails because e.g. an assert() method failed.
270
self._testConcluded(test)
271
if isinstance(err[1], KnownFailure):
272
return self._addKnownFailure(test, err)
274
unittest.TestResult.addFailure(self, test, err)
275
self.failure_count += 1
276
self.report_failure(test, err)
279
self._cleanupLogFile(test)
281
def addSuccess(self, test):
282
"""Tell result that test completed successfully.
284
Called from the TestCase run()
286
self._testConcluded(test)
287
if self._bench_history is not None:
288
benchmark_time = self._extractBenchmarkTime(test)
289
if benchmark_time is not None:
290
self._bench_history.write("%s %s\n" % (
291
self._formatTime(benchmark_time),
293
self.report_success(test)
294
self._cleanupLogFile(test)
295
unittest.TestResult.addSuccess(self, test)
296
test._log_contents = ''
298
def _testConcluded(self, test):
299
"""Common code when a test has finished.
301
Called regardless of whether it succeded, failed, etc.
305
def _addKnownFailure(self, test, err):
306
self.known_failure_count += 1
307
self.report_known_failure(test, err)
309
def addNotSupported(self, test, feature):
310
"""The test will not be run because of a missing feature.
312
# this can be called in two different ways: it may be that the
313
# test started running, and then raised (through addError)
314
# UnavailableFeature. Alternatively this method can be called
315
# while probing for features before running the tests; in that
316
# case we will see startTest and stopTest, but the test will never
318
self.unsupported.setdefault(str(feature), 0)
319
self.unsupported[str(feature)] += 1
320
self.report_unsupported(test, feature)
322
def addSkip(self, test, reason):
323
"""A test has not run for 'reason'."""
325
self.report_skip(test, reason)
327
def _addNotApplicable(self, test, skip_excinfo):
328
if isinstance(skip_excinfo[1], TestNotApplicable):
329
self.not_applicable_count += 1
330
self.report_not_applicable(test, skip_excinfo)
333
except KeyboardInterrupt:
336
self.addError(test, test.exc_info())
338
# seems best to treat this as success from point-of-view of unittest
339
# -- it actually does nothing so it barely matters :)
340
unittest.TestResult.addSuccess(self, test)
341
test._log_contents = ''
343
def printErrorList(self, flavour, errors):
344
for test, err in errors:
345
self.stream.writeln(self.separator1)
346
self.stream.write("%s: " % flavour)
347
self.stream.writeln(self.getDescription(test))
348
if getattr(test, '_get_log', None) is not None:
349
self.stream.write('\n')
351
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
352
self.stream.write('\n')
353
self.stream.write(test._get_log())
354
self.stream.write('\n')
356
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
357
self.stream.write('\n')
358
self.stream.writeln(self.separator2)
359
self.stream.writeln("%s" % err)
364
def report_cleaning_up(self):
367
def report_success(self, test):
370
def wasStrictlySuccessful(self):
371
if self.unsupported or self.known_failure_count:
373
return self.wasSuccessful()
376
class TextTestResult(ExtendedTestResult):
377
"""Displays progress and results of tests in text form"""
379
def __init__(self, stream, descriptions, verbosity,
385
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
386
bench_history, num_tests, strict)
388
self.pb = self.ui.nested_progress_bar()
389
self._supplied_pb = False
392
self._supplied_pb = True
393
self.pb.show_pct = False
394
self.pb.show_spinner = False
395
self.pb.show_eta = False,
396
self.pb.show_count = False
397
self.pb.show_bar = False
399
def report_starting(self):
400
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
402
def _progress_prefix_text(self):
403
# the longer this text, the less space we have to show the test
405
a = '[%d' % self.count # total that have been run
406
# tests skipped as known not to be relevant are not important enough
408
## if self.skip_count:
409
## a += ', %d skip' % self.skip_count
410
## if self.known_failure_count:
411
## a += '+%dX' % self.known_failure_count
412
if self.num_tests is not None:
413
a +='/%d' % self.num_tests
415
runtime = time.time() - self._overall_start_time
417
a += '%dm%ds' % (runtime / 60, runtime % 60)
421
a += ', %d err' % self.error_count
422
if self.failure_count:
423
a += ', %d fail' % self.failure_count
425
a += ', %d missing' % len(self.unsupported)
429
def report_test_start(self, test):
432
self._progress_prefix_text()
434
+ self._shortened_test_description(test))
436
def _test_description(self, test):
437
return self._shortened_test_description(test)
439
def report_error(self, test, err):
440
self.pb.note('ERROR: %s\n %s\n',
441
self._test_description(test),
445
def report_failure(self, test, err):
446
self.pb.note('FAIL: %s\n %s\n',
447
self._test_description(test),
451
def report_known_failure(self, test, err):
452
self.pb.note('XFAIL: %s\n%s\n',
453
self._test_description(test), err[1])
455
def report_skip(self, test, reason):
458
def report_not_applicable(self, test, skip_excinfo):
461
def report_unsupported(self, test, feature):
462
"""test cannot be run because feature is missing."""
464
def report_cleaning_up(self):
465
self.pb.update('Cleaning up')
468
if not self._supplied_pb:
472
class VerboseTestResult(ExtendedTestResult):
473
"""Produce long output, with one line per test run plus times"""
475
def _ellipsize_to_right(self, a_string, final_width):
476
"""Truncate and pad a string, keeping the right hand side"""
477
if len(a_string) > final_width:
478
result = '...' + a_string[3-final_width:]
481
return result.ljust(final_width)
483
def report_starting(self):
484
self.stream.write('running %d tests...\n' % self.num_tests)
486
def report_test_start(self, test):
488
name = self._shortened_test_description(test)
489
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
490
# numbers, plus a trailing blank
491
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
492
self.stream.write(self._ellipsize_to_right(name,
493
osutils.terminal_width()-30))
496
def _error_summary(self, err):
498
return '%s%s' % (indent, err[1])
500
def report_error(self, test, err):
501
self.stream.writeln('ERROR %s\n%s'
502
% (self._testTimeString(test),
503
self._error_summary(err)))
505
def report_failure(self, test, err):
506
self.stream.writeln(' FAIL %s\n%s'
507
% (self._testTimeString(test),
508
self._error_summary(err)))
510
def report_known_failure(self, test, err):
511
self.stream.writeln('XFAIL %s\n%s'
512
% (self._testTimeString(test),
513
self._error_summary(err)))
515
def report_success(self, test):
516
self.stream.writeln(' OK %s' % self._testTimeString(test))
517
for bench_called, stats in getattr(test, '_benchcalls', []):
518
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
519
stats.pprint(file=self.stream)
520
# flush the stream so that we get smooth output. This verbose mode is
521
# used to show the output in PQM.
524
def report_skip(self, test, reason):
525
self.stream.writeln(' SKIP %s\n%s'
526
% (self._testTimeString(test), reason))
528
def report_not_applicable(self, test, skip_excinfo):
529
self.stream.writeln(' N/A %s\n%s'
530
% (self._testTimeString(test),
531
self._error_summary(skip_excinfo)))
533
def report_unsupported(self, test, feature):
534
"""test cannot be run because feature is missing."""
535
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
536
%(self._testTimeString(test), feature))
539
class TextTestRunner(object):
540
stop_on_failure = False
550
self.stream = unittest._WritelnDecorator(stream)
551
self.descriptions = descriptions
552
self.verbosity = verbosity
553
self._bench_history = bench_history
554
self.list_only = list_only
555
self._strict = strict
558
"Run the given test case or test suite."
559
startTime = time.time()
560
if self.verbosity == 1:
561
result_class = TextTestResult
562
elif self.verbosity >= 2:
563
result_class = VerboseTestResult
564
result = result_class(self.stream,
567
bench_history=self._bench_history,
568
num_tests=test.countTestCases(),
571
result.stop_early = self.stop_on_failure
572
result.report_starting()
574
if self.verbosity >= 2:
575
self.stream.writeln("Listing tests only ...\n")
577
for t in iter_suite_tests(test):
578
self.stream.writeln("%s" % (t.id()))
587
if isinstance(test, testtools.ConcurrentTestSuite):
588
# We need to catch bzr specific behaviors
589
test.run(BZRTransformingResult(result))
592
run = result.testsRun
594
stopTime = time.time()
595
timeTaken = stopTime - startTime
597
self.stream.writeln(result.separator2)
598
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
599
run, run != 1 and "s" or "", timeTaken))
600
self.stream.writeln()
601
if not result.wasSuccessful():
602
self.stream.write("FAILED (")
603
failed, errored = map(len, (result.failures, result.errors))
605
self.stream.write("failures=%d" % failed)
607
if failed: self.stream.write(", ")
608
self.stream.write("errors=%d" % errored)
609
if result.known_failure_count:
610
if failed or errored: self.stream.write(", ")
611
self.stream.write("known_failure_count=%d" %
612
result.known_failure_count)
613
self.stream.writeln(")")
615
if result.known_failure_count:
616
self.stream.writeln("OK (known_failures=%d)" %
617
result.known_failure_count)
619
self.stream.writeln("OK")
620
if result.skip_count > 0:
621
skipped = result.skip_count
622
self.stream.writeln('%d test%s skipped' %
623
(skipped, skipped != 1 and "s" or ""))
624
if result.unsupported:
625
for feature, count in sorted(result.unsupported.items()):
626
self.stream.writeln("Missing feature '%s' skipped %d tests." %
632
def iter_suite_tests(suite):
633
"""Return all tests in a suite, recursing through nested suites"""
634
if isinstance(suite, unittest.TestCase):
636
elif isinstance(suite, unittest.TestSuite):
638
for r in iter_suite_tests(item):
641
raise Exception('unknown type %r for object %r'
642
% (type(suite), suite))
645
class TestSkipped(Exception):
646
"""Indicates that a test was intentionally skipped, rather than failing."""
649
class TestNotApplicable(TestSkipped):
650
"""A test is not applicable to the situation where it was run.
652
This is only normally raised by parameterized tests, if they find that
653
the instance they're constructed upon does not support one aspect
658
class KnownFailure(AssertionError):
659
"""Indicates that a test failed in a precisely expected manner.
661
Such failures dont block the whole test suite from passing because they are
662
indicators of partially completed code or of future work. We have an
663
explicit error for them so that we can ensure that they are always visible:
664
KnownFailures are always shown in the output of bzr selftest.
668
class UnavailableFeature(Exception):
669
"""A feature required for this test was not available.
671
The feature should be used to construct the exception.
675
class CommandFailed(Exception):
679
class StringIOWrapper(object):
680
"""A wrapper around cStringIO which just adds an encoding attribute.
682
Internally we can check sys.stdout to see what the output encoding
683
should be. However, cStringIO has no encoding attribute that we can
684
set. So we wrap it instead.
689
def __init__(self, s=None):
691
self.__dict__['_cstring'] = StringIO(s)
693
self.__dict__['_cstring'] = StringIO()
695
def __getattr__(self, name, getattr=getattr):
696
return getattr(self.__dict__['_cstring'], name)
698
def __setattr__(self, name, val):
699
if name == 'encoding':
700
self.__dict__['encoding'] = val
702
return setattr(self._cstring, name, val)
705
class TestUIFactory(ui.CLIUIFactory):
706
"""A UI Factory for testing.
708
Hide the progress bar but emit note()s.
710
Allows get_password to be tested without real tty attached.
713
def __init__(self, stdout=None, stderr=None, stdin=None):
714
if stdin is not None:
715
# We use a StringIOWrapper to be able to test various
716
# encodings, but the user is still responsible to
717
# encode the string and to set the encoding attribute
718
# of StringIOWrapper.
719
stdin = StringIOWrapper(stdin)
720
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
723
"""See progress.ProgressBar.clear()."""
725
def clear_term(self):
726
"""See progress.ProgressBar.clear_term()."""
729
"""See progress.ProgressBar.finished()."""
731
def note(self, fmt_string, *args, **kwargs):
732
"""See progress.ProgressBar.note()."""
733
self.stdout.write((fmt_string + "\n") % args)
735
def progress_bar(self):
738
def nested_progress_bar(self):
741
def update(self, message, count=None, total=None):
742
"""See progress.ProgressBar.update()."""
744
def get_non_echoed_password(self):
745
"""Get password from stdin without trying to handle the echo mode"""
746
password = self.stdin.readline()
749
if password[-1] == '\n':
750
password = password[:-1]
754
class TestCase(unittest.TestCase):
755
"""Base class for bzr unit tests.
757
Tests that need access to disk resources should subclass
758
TestCaseInTempDir not TestCase.
760
Error and debug log messages are redirected from their usual
761
location into a temporary file, the contents of which can be
762
retrieved by _get_log(). We use a real OS file, not an in-memory object,
763
so that it can also capture file IO. When the test completes this file
764
is read into memory and removed from disk.
766
There are also convenience functions to invoke bzr's command-line
767
routine, and to build and check bzr trees.
769
In addition to the usual method of overriding tearDown(), this class also
770
allows subclasses to register functions into the _cleanups list, which is
771
run in order as the object is torn down. It's less likely this will be
772
accidentally overlooked.
775
_active_threads = None
776
_leaking_threads_tests = 0
777
_first_thread_leaker_id = None
778
_log_file_name = None
780
_keep_log_file = False
781
# record lsprof data when performing benchmark calls.
782
_gather_lsprof_in_benchmarks = False
783
attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
784
'_log_contents', '_log_file_name', '_benchtime',
785
'_TestCase__testMethodName', '_TestCase__testMethodDoc',)
787
def __init__(self, methodName='testMethod'):
788
super(TestCase, self).__init__(methodName)
790
self._bzr_test_setUp_run = False
791
self._bzr_test_tearDown_run = False
794
unittest.TestCase.setUp(self)
795
self._bzr_test_setUp_run = True
796
self._cleanEnvironment()
799
self._benchcalls = []
800
self._benchtime = None
802
# Track locks - needs to be called before _clear_debug_flags.
804
self._clear_debug_flags()
805
TestCase._active_threads = threading.activeCount()
806
self.addCleanup(self._check_leaked_threads)
811
pdb.Pdb().set_trace(sys._getframe().f_back)
813
def _check_leaked_threads(self):
814
active = threading.activeCount()
815
leaked_threads = active - TestCase._active_threads
816
TestCase._active_threads = active
818
TestCase._leaking_threads_tests += 1
819
if TestCase._first_thread_leaker_id is None:
820
TestCase._first_thread_leaker_id = self.id()
822
def _clear_debug_flags(self):
823
"""Prevent externally set debug flags affecting tests.
825
Tests that want to use debug flags can just set them in the
826
debug_flags set during setup/teardown.
828
self._preserved_debug_flags = set(debug.debug_flags)
829
if 'allow_debug' not in selftest_debug_flags:
830
debug.debug_flags.clear()
831
self.addCleanup(self._restore_debug_flags)
833
def _clear_hooks(self):
834
# prevent hooks affecting tests
835
self._preserved_hooks = {}
836
for key, factory in hooks.known_hooks.items():
837
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
838
current_hooks = hooks.known_hooks_key_to_object(key)
839
self._preserved_hooks[parent] = (name, current_hooks)
840
self.addCleanup(self._restoreHooks)
841
for key, factory in hooks.known_hooks.items():
842
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
843
setattr(parent, name, factory())
844
# this hook should always be installed
845
request._install_hook()
847
def _silenceUI(self):
848
"""Turn off UI for duration of test"""
849
# by default the UI is off; tests can turn it on if they want it.
850
saved = ui.ui_factory
852
ui.ui_factory = saved
853
ui.ui_factory = ui.SilentUIFactory()
854
self.addCleanup(_restore)
856
def _check_locks(self):
857
"""Check that all lock take/release actions have been paired."""
858
# once we have fixed all the current lock problems, we can change the
859
# following code to always check for mismatched locks, but only do
860
# traceback showing with -Dlock (self._lock_check_thorough is True).
861
# For now, because the test suite will fail, we only assert that lock
862
# matching has occured with -Dlock.
864
acquired_locks = [lock for action, lock in self._lock_actions
865
if action == 'acquired']
866
released_locks = [lock for action, lock in self._lock_actions
867
if action == 'released']
868
broken_locks = [lock for action, lock in self._lock_actions
869
if action == 'broken']
870
# trivially, given the tests for lock acquistion and release, if we
871
# have as many in each list, it should be ok. Some lock tests also
872
# break some locks on purpose and should be taken into account by
873
# considering that breaking a lock is just a dirty way of releasing it.
874
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
875
message = ('Different number of acquired and '
876
'released or broken locks. (%s, %s + %s)' %
877
(acquired_locks, released_locks, broken_locks))
878
if not self._lock_check_thorough:
879
# Rather than fail, just warn
880
print "Broken test %s: %s" % (self, message)
884
def _track_locks(self):
885
"""Track lock activity during tests."""
886
self._lock_actions = []
887
self._lock_check_thorough = 'lock' not in debug.debug_flags
888
self.addCleanup(self._check_locks)
889
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
890
self._lock_acquired, None)
891
_mod_lock.Lock.hooks.install_named_hook('lock_released',
892
self._lock_released, None)
893
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
894
self._lock_broken, None)
896
def _lock_acquired(self, result):
897
self._lock_actions.append(('acquired', result))
899
def _lock_released(self, result):
900
self._lock_actions.append(('released', result))
902
def _lock_broken(self, result):
903
self._lock_actions.append(('broken', result))
905
def _ndiff_strings(self, a, b):
906
"""Return ndiff between two strings containing lines.
908
A trailing newline is added if missing to make the strings
910
if b and b[-1] != '\n':
912
if a and a[-1] != '\n':
914
difflines = difflib.ndiff(a.splitlines(True),
916
linejunk=lambda x: False,
917
charjunk=lambda x: False)
918
return ''.join(difflines)
920
def assertEqual(self, a, b, message=''):
924
except UnicodeError, e:
925
# If we can't compare without getting a UnicodeError, then
926
# obviously they are different
927
mutter('UnicodeError: %s', e)
930
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
932
pformat(a), pformat(b)))
934
assertEquals = assertEqual
936
def assertEqualDiff(self, a, b, message=None):
937
"""Assert two texts are equal, if not raise an exception.
939
This is intended for use with multi-line strings where it can
940
be hard to find the differences by eye.
942
# TODO: perhaps override assertEquals to call this for strings?
946
message = "texts not equal:\n"
948
message = 'first string is missing a final newline.\n'
950
message = 'second string is missing a final newline.\n'
951
raise AssertionError(message +
952
self._ndiff_strings(a, b))
954
def assertEqualMode(self, mode, mode_test):
955
self.assertEqual(mode, mode_test,
956
'mode mismatch %o != %o' % (mode, mode_test))
958
def assertEqualStat(self, expected, actual):
959
"""assert that expected and actual are the same stat result.
961
:param expected: A stat result.
962
:param actual: A stat result.
963
:raises AssertionError: If the expected and actual stat values differ
966
self.assertEqual(expected.st_size, actual.st_size)
967
self.assertEqual(expected.st_mtime, actual.st_mtime)
968
self.assertEqual(expected.st_ctime, actual.st_ctime)
969
self.assertEqual(expected.st_dev, actual.st_dev)
970
self.assertEqual(expected.st_ino, actual.st_ino)
971
self.assertEqual(expected.st_mode, actual.st_mode)
973
def assertLength(self, length, obj_with_len):
974
"""Assert that obj_with_len is of length length."""
975
if len(obj_with_len) != length:
976
self.fail("Incorrect length: wanted %d, got %d for %r" % (
977
length, len(obj_with_len), obj_with_len))
979
def assertPositive(self, val):
980
"""Assert that val is greater than 0."""
981
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
983
def assertNegative(self, val):
984
"""Assert that val is less than 0."""
985
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
987
def assertStartsWith(self, s, prefix):
988
if not s.startswith(prefix):
989
raise AssertionError('string %r does not start with %r' % (s, prefix))
991
def assertEndsWith(self, s, suffix):
992
"""Asserts that s ends with suffix."""
993
if not s.endswith(suffix):
994
raise AssertionError('string %r does not end with %r' % (s, suffix))
996
def assertContainsRe(self, haystack, needle_re, flags=0):
997
"""Assert that a contains something matching a regular expression."""
998
if not re.search(needle_re, haystack, flags):
999
if '\n' in haystack or len(haystack) > 60:
1000
# a long string, format it in a more readable way
1001
raise AssertionError(
1002
'pattern "%s" not found in\n"""\\\n%s"""\n'
1003
% (needle_re, haystack))
1005
raise AssertionError('pattern "%s" not found in "%s"'
1006
% (needle_re, haystack))
1008
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1009
"""Assert that a does not match a regular expression"""
1010
if re.search(needle_re, haystack, flags):
1011
raise AssertionError('pattern "%s" found in "%s"'
1012
% (needle_re, haystack))
1014
def assertSubset(self, sublist, superlist):
1015
"""Assert that every entry in sublist is present in superlist."""
1016
missing = set(sublist) - set(superlist)
1017
if len(missing) > 0:
1018
raise AssertionError("value(s) %r not present in container %r" %
1019
(missing, superlist))
1021
def assertListRaises(self, excClass, func, *args, **kwargs):
1022
"""Fail unless excClass is raised when the iterator from func is used.
1024
Many functions can return generators this makes sure
1025
to wrap them in a list() call to make sure the whole generator
1026
is run, and that the proper exception is raised.
1029
list(func(*args, **kwargs))
1033
if getattr(excClass,'__name__', None) is not None:
1034
excName = excClass.__name__
1036
excName = str(excClass)
1037
raise self.failureException, "%s not raised" % excName
1039
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1040
"""Assert that a callable raises a particular exception.
1042
:param excClass: As for the except statement, this may be either an
1043
exception class, or a tuple of classes.
1044
:param callableObj: A callable, will be passed ``*args`` and
1047
Returns the exception so that you can examine it.
1050
callableObj(*args, **kwargs)
1054
if getattr(excClass,'__name__', None) is not None:
1055
excName = excClass.__name__
1058
excName = str(excClass)
1059
raise self.failureException, "%s not raised" % excName
1061
def assertIs(self, left, right, message=None):
1062
if not (left is right):
1063
if message is not None:
1064
raise AssertionError(message)
1066
raise AssertionError("%r is not %r." % (left, right))
1068
def assertIsNot(self, left, right, message=None):
1070
if message is not None:
1071
raise AssertionError(message)
1073
raise AssertionError("%r is %r." % (left, right))
1075
def assertTransportMode(self, transport, path, mode):
1076
"""Fail if a path does not have mode "mode".
1078
If modes are not supported on this transport, the assertion is ignored.
1080
if not transport._can_roundtrip_unix_modebits():
1082
path_stat = transport.stat(path)
1083
actual_mode = stat.S_IMODE(path_stat.st_mode)
1084
self.assertEqual(mode, actual_mode,
1085
'mode of %r incorrect (%s != %s)'
1086
% (path, oct(mode), oct(actual_mode)))
1088
def assertIsSameRealPath(self, path1, path2):
1089
"""Fail if path1 and path2 points to different files"""
1090
self.assertEqual(osutils.realpath(path1),
1091
osutils.realpath(path2),
1092
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1094
def assertIsInstance(self, obj, kls):
1095
"""Fail if obj is not an instance of kls"""
1096
if not isinstance(obj, kls):
1097
self.fail("%r is an instance of %s rather than %s" % (
1098
obj, obj.__class__, kls))
1100
def expectFailure(self, reason, assertion, *args, **kwargs):
1101
"""Invoke a test, expecting it to fail for the given reason.
1103
This is for assertions that ought to succeed, but currently fail.
1104
(The failure is *expected* but not *wanted*.) Please be very precise
1105
about the failure you're expecting. If a new bug is introduced,
1106
AssertionError should be raised, not KnownFailure.
1108
Frequently, expectFailure should be followed by an opposite assertion.
1111
Intended to be used with a callable that raises AssertionError as the
1112
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1114
Raises KnownFailure if the test fails. Raises AssertionError if the
1119
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1121
self.assertEqual(42, dynamic_val)
1123
This means that a dynamic_val of 54 will cause the test to raise
1124
a KnownFailure. Once math is fixed and the expectFailure is removed,
1125
only a dynamic_val of 42 will allow the test to pass. Anything other
1126
than 54 or 42 will cause an AssertionError.
1129
assertion(*args, **kwargs)
1130
except AssertionError:
1131
raise KnownFailure(reason)
1133
self.fail('Unexpected success. Should have failed: %s' % reason)
1135
def assertFileEqual(self, content, path):
1136
"""Fail if path does not contain 'content'."""
1137
self.failUnlessExists(path)
1138
f = file(path, 'rb')
1143
self.assertEqualDiff(content, s)
1145
def failUnlessExists(self, path):
1146
"""Fail unless path or paths, which may be abs or relative, exist."""
1147
if not isinstance(path, basestring):
1149
self.failUnlessExists(p)
1151
self.failUnless(osutils.lexists(path),path+" does not exist")
1153
def failIfExists(self, path):
1154
"""Fail if path or paths, which may be abs or relative, exist."""
1155
if not isinstance(path, basestring):
1157
self.failIfExists(p)
1159
self.failIf(osutils.lexists(path),path+" exists")
1161
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1162
"""A helper for callDeprecated and applyDeprecated.
1164
:param a_callable: A callable to call.
1165
:param args: The positional arguments for the callable
1166
:param kwargs: The keyword arguments for the callable
1167
:return: A tuple (warnings, result). result is the result of calling
1168
a_callable(``*args``, ``**kwargs``).
1171
def capture_warnings(msg, cls=None, stacklevel=None):
1172
# we've hooked into a deprecation specific callpath,
1173
# only deprecations should getting sent via it.
1174
self.assertEqual(cls, DeprecationWarning)
1175
local_warnings.append(msg)
1176
original_warning_method = symbol_versioning.warn
1177
symbol_versioning.set_warning_method(capture_warnings)
1179
result = a_callable(*args, **kwargs)
1181
symbol_versioning.set_warning_method(original_warning_method)
1182
return (local_warnings, result)
1184
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1185
"""Call a deprecated callable without warning the user.
1187
Note that this only captures warnings raised by symbol_versioning.warn,
1188
not other callers that go direct to the warning module.
1190
To test that a deprecated method raises an error, do something like
1193
self.assertRaises(errors.ReservedId,
1194
self.applyDeprecated,
1195
deprecated_in((1, 5, 0)),
1199
:param deprecation_format: The deprecation format that the callable
1200
should have been deprecated with. This is the same type as the
1201
parameter to deprecated_method/deprecated_function. If the
1202
callable is not deprecated with this format, an assertion error
1204
:param a_callable: A callable to call. This may be a bound method or
1205
a regular function. It will be called with ``*args`` and
1207
:param args: The positional arguments for the callable
1208
:param kwargs: The keyword arguments for the callable
1209
:return: The result of a_callable(``*args``, ``**kwargs``)
1211
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1213
expected_first_warning = symbol_versioning.deprecation_string(
1214
a_callable, deprecation_format)
1215
if len(call_warnings) == 0:
1216
self.fail("No deprecation warning generated by call to %s" %
1218
self.assertEqual(expected_first_warning, call_warnings[0])
1221
def callCatchWarnings(self, fn, *args, **kw):
1222
"""Call a callable that raises python warnings.
1224
The caller's responsible for examining the returned warnings.
1226
If the callable raises an exception, the exception is not
1227
caught and propagates up to the caller. In that case, the list
1228
of warnings is not available.
1230
:returns: ([warning_object, ...], fn_result)
1232
# XXX: This is not perfect, because it completely overrides the
1233
# warnings filters, and some code may depend on suppressing particular
1234
# warnings. It's the easiest way to insulate ourselves from -Werror,
1235
# though. -- Andrew, 20071062
1237
def _catcher(message, category, filename, lineno, file=None, line=None):
1238
# despite the name, 'message' is normally(?) a Warning subclass
1240
wlist.append(message)
1241
saved_showwarning = warnings.showwarning
1242
saved_filters = warnings.filters
1244
warnings.showwarning = _catcher
1245
warnings.filters = []
1246
result = fn(*args, **kw)
1248
warnings.showwarning = saved_showwarning
1249
warnings.filters = saved_filters
1250
return wlist, result
1252
def callDeprecated(self, expected, callable, *args, **kwargs):
1253
"""Assert that a callable is deprecated in a particular way.
1255
This is a very precise test for unusual requirements. The
1256
applyDeprecated helper function is probably more suited for most tests
1257
as it allows you to simply specify the deprecation format being used
1258
and will ensure that that is issued for the function being called.
1260
Note that this only captures warnings raised by symbol_versioning.warn,
1261
not other callers that go direct to the warning module. To catch
1262
general warnings, use callCatchWarnings.
1264
:param expected: a list of the deprecation warnings expected, in order
1265
:param callable: The callable to call
1266
:param args: The positional arguments for the callable
1267
:param kwargs: The keyword arguments for the callable
1269
call_warnings, result = self._capture_deprecation_warnings(callable,
1271
self.assertEqual(expected, call_warnings)
1274
def _startLogFile(self):
1275
"""Send bzr and test log messages to a temporary file.
1277
The file is removed as the test is torn down.
1279
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1280
self._log_file = os.fdopen(fileno, 'w+')
1281
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1282
self._log_file_name = name
1283
self.addCleanup(self._finishLogFile)
1285
def _finishLogFile(self):
1286
"""Finished with the log file.
1288
Close the file and delete it, unless setKeepLogfile was called.
1290
if self._log_file is None:
1292
bzrlib.trace.pop_log_file(self._log_memento)
1293
self._log_file.close()
1294
self._log_file = None
1295
if not self._keep_log_file:
1296
os.remove(self._log_file_name)
1297
self._log_file_name = None
1299
def setKeepLogfile(self):
1300
"""Make the logfile not be deleted when _finishLogFile is called."""
1301
self._keep_log_file = True
1303
def addCleanup(self, callable, *args, **kwargs):
1304
"""Arrange to run a callable when this case is torn down.
1306
Callables are run in the reverse of the order they are registered,
1307
ie last-in first-out.
1309
self._cleanups.append((callable, args, kwargs))
1311
def _cleanEnvironment(self):
1313
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1314
'HOME': os.getcwd(),
1315
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1316
# tests do check our impls match APPDATA
1317
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1321
'BZREMAIL': None, # may still be present in the environment
1323
'BZR_PROGRESS_BAR': None,
1325
'BZR_PLUGIN_PATH': None,
1327
'SSH_AUTH_SOCK': None,
1331
'https_proxy': None,
1332
'HTTPS_PROXY': None,
1337
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1338
# least. If you do (care), please update this comment
1342
'BZR_REMOTE_PATH': None,
1345
self.addCleanup(self._restoreEnvironment)
1346
for name, value in new_env.iteritems():
1347
self._captureVar(name, value)
1349
def _captureVar(self, name, newvalue):
1350
"""Set an environment variable, and reset it when finished."""
1351
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1353
def _restore_debug_flags(self):
1354
debug.debug_flags.clear()
1355
debug.debug_flags.update(self._preserved_debug_flags)
1357
def _restoreEnvironment(self):
1358
for name, value in self.__old_env.iteritems():
1359
osutils.set_or_unset_env(name, value)
1361
def _restoreHooks(self):
1362
for klass, (name, hooks) in self._preserved_hooks.items():
1363
setattr(klass, name, hooks)
1365
def knownFailure(self, reason):
1366
"""This test has failed for some known reason."""
1367
raise KnownFailure(reason)
1369
def _do_skip(self, result, reason):
1370
addSkip = getattr(result, 'addSkip', None)
1371
if not callable(addSkip):
1372
result.addError(self, sys.exc_info())
1374
addSkip(self, reason)
1376
def run(self, result=None):
1377
if result is None: result = self.defaultTestResult()
1378
for feature in getattr(self, '_test_needs_features', []):
1379
if not feature.available():
1380
result.startTest(self)
1381
if getattr(result, 'addNotSupported', None):
1382
result.addNotSupported(self, feature)
1384
result.addSuccess(self)
1385
result.stopTest(self)
1389
result.startTest(self)
1390
absent_attr = object()
1392
method_name = getattr(self, '_testMethodName', absent_attr)
1393
if method_name is absent_attr:
1395
method_name = getattr(self, '_TestCase__testMethodName')
1396
testMethod = getattr(self, method_name)
1400
if not self._bzr_test_setUp_run:
1402
"test setUp did not invoke "
1403
"bzrlib.tests.TestCase's setUp")
1404
except KeyboardInterrupt:
1407
except TestSkipped, e:
1408
self._do_skip(result, e.args[0])
1412
result.addError(self, sys.exc_info())
1420
except self.failureException:
1421
result.addFailure(self, sys.exc_info())
1422
except TestSkipped, e:
1424
reason = "No reason given."
1427
self._do_skip(result, reason)
1428
except KeyboardInterrupt:
1432
result.addError(self, sys.exc_info())
1436
if not self._bzr_test_tearDown_run:
1438
"test tearDown did not invoke "
1439
"bzrlib.tests.TestCase's tearDown")
1440
except KeyboardInterrupt:
1444
result.addError(self, sys.exc_info())
1447
if ok: result.addSuccess(self)
1449
result.stopTest(self)
1451
except TestNotApplicable:
1452
# Not moved from the result [yet].
1455
except KeyboardInterrupt:
1460
for attr_name in self.attrs_to_keep:
1461
if attr_name in self.__dict__:
1462
saved_attrs[attr_name] = self.__dict__[attr_name]
1463
self.__dict__ = saved_attrs
1467
self._log_contents = ''
1468
self._bzr_test_tearDown_run = True
1469
unittest.TestCase.tearDown(self)
1471
def time(self, callable, *args, **kwargs):
1472
"""Run callable and accrue the time it takes to the benchmark time.
1474
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1475
this will cause lsprofile statistics to be gathered and stored in
1478
if self._benchtime is None:
1482
if not self._gather_lsprof_in_benchmarks:
1483
return callable(*args, **kwargs)
1485
# record this benchmark
1486
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1488
self._benchcalls.append(((callable, args, kwargs), stats))
1491
self._benchtime += time.time() - start
1493
def _runCleanups(self):
1494
"""Run registered cleanup functions.
1496
This should only be called from TestCase.tearDown.
1498
# TODO: Perhaps this should keep running cleanups even if
1499
# one of them fails?
1501
# Actually pop the cleanups from the list so tearDown running
1502
# twice is safe (this happens for skipped tests).
1503
while self._cleanups:
1504
cleanup, args, kwargs = self._cleanups.pop()
1505
cleanup(*args, **kwargs)
1507
def log(self, *args):
1510
def _get_log(self, keep_log_file=False):
1511
"""Get the log from bzrlib.trace calls from this test.
1513
:param keep_log_file: When True, if the log is still a file on disk
1514
leave it as a file on disk. When False, if the log is still a file
1515
on disk, the log file is deleted and the log preserved as
1517
:return: A string containing the log.
1519
# flush the log file, to get all content
1521
if bzrlib.trace._trace_file:
1522
bzrlib.trace._trace_file.flush()
1523
if self._log_contents:
1524
# XXX: this can hardly contain the content flushed above --vila
1526
return self._log_contents
1527
if self._log_file_name is not None:
1528
logfile = open(self._log_file_name)
1530
log_contents = logfile.read()
1533
if not keep_log_file:
1534
self._log_contents = log_contents
1536
os.remove(self._log_file_name)
1538
if sys.platform == 'win32' and e.errno == errno.EACCES:
1539
sys.stderr.write(('Unable to delete log file '
1540
' %r\n' % self._log_file_name))
1545
return "DELETED log file to reduce memory footprint"
1547
def requireFeature(self, feature):
1548
"""This test requires a specific feature is available.
1550
:raises UnavailableFeature: When feature is not available.
1552
if not feature.available():
1553
raise UnavailableFeature(feature)
1555
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1557
"""Run bazaar command line, splitting up a string command line."""
1558
if isinstance(args, basestring):
1559
# shlex don't understand unicode strings,
1560
# so args should be plain string (bialix 20070906)
1561
args = list(shlex.split(str(args)))
1562
return self._run_bzr_core(args, retcode=retcode,
1563
encoding=encoding, stdin=stdin, working_dir=working_dir,
1566
def _run_bzr_core(self, args, retcode, encoding, stdin,
1568
if encoding is None:
1569
encoding = osutils.get_user_encoding()
1570
stdout = StringIOWrapper()
1571
stderr = StringIOWrapper()
1572
stdout.encoding = encoding
1573
stderr.encoding = encoding
1575
self.log('run bzr: %r', args)
1576
# FIXME: don't call into logging here
1577
handler = logging.StreamHandler(stderr)
1578
handler.setLevel(logging.INFO)
1579
logger = logging.getLogger('')
1580
logger.addHandler(handler)
1581
old_ui_factory = ui.ui_factory
1582
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1585
if working_dir is not None:
1586
cwd = osutils.getcwd()
1587
os.chdir(working_dir)
1590
result = self.apply_redirected(ui.ui_factory.stdin,
1592
bzrlib.commands.run_bzr_catch_user_errors,
1595
logger.removeHandler(handler)
1596
ui.ui_factory = old_ui_factory
1600
out = stdout.getvalue()
1601
err = stderr.getvalue()
1603
self.log('output:\n%r', out)
1605
self.log('errors:\n%r', err)
1606
if retcode is not None:
1607
self.assertEquals(retcode, result,
1608
message='Unexpected return code')
1611
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1612
working_dir=None, error_regexes=[], output_encoding=None):
1613
"""Invoke bzr, as if it were run from the command line.
1615
The argument list should not include the bzr program name - the
1616
first argument is normally the bzr command. Arguments may be
1617
passed in three ways:
1619
1- A list of strings, eg ["commit", "a"]. This is recommended
1620
when the command contains whitespace or metacharacters, or
1621
is built up at run time.
1623
2- A single string, eg "add a". This is the most convenient
1624
for hardcoded commands.
1626
This runs bzr through the interface that catches and reports
1627
errors, and with logging set to something approximating the
1628
default, so that error reporting can be checked.
1630
This should be the main method for tests that want to exercise the
1631
overall behavior of the bzr application (rather than a unit test
1632
or a functional test of the library.)
1634
This sends the stdout/stderr results into the test's log,
1635
where it may be useful for debugging. See also run_captured.
1637
:keyword stdin: A string to be used as stdin for the command.
1638
:keyword retcode: The status code the command should return;
1640
:keyword working_dir: The directory to run the command in
1641
:keyword error_regexes: A list of expected error messages. If
1642
specified they must be seen in the error output of the command.
1644
out, err = self._run_bzr_autosplit(
1649
working_dir=working_dir,
1651
self.assertIsInstance(error_regexes, (list, tuple))
1652
for regex in error_regexes:
1653
self.assertContainsRe(err, regex)
1656
def run_bzr_error(self, error_regexes, *args, **kwargs):
1657
"""Run bzr, and check that stderr contains the supplied regexes
1659
:param error_regexes: Sequence of regular expressions which
1660
must each be found in the error output. The relative ordering
1662
:param args: command-line arguments for bzr
1663
:param kwargs: Keyword arguments which are interpreted by run_bzr
1664
This function changes the default value of retcode to be 3,
1665
since in most cases this is run when you expect bzr to fail.
1667
:return: (out, err) The actual output of running the command (in case
1668
you want to do more inspection)
1672
# Make sure that commit is failing because there is nothing to do
1673
self.run_bzr_error(['no changes to commit'],
1674
['commit', '-m', 'my commit comment'])
1675
# Make sure --strict is handling an unknown file, rather than
1676
# giving us the 'nothing to do' error
1677
self.build_tree(['unknown'])
1678
self.run_bzr_error(['Commit refused because there are unknown files'],
1679
['commit', --strict', '-m', 'my commit comment'])
1681
kwargs.setdefault('retcode', 3)
1682
kwargs['error_regexes'] = error_regexes
1683
out, err = self.run_bzr(*args, **kwargs)
1686
def run_bzr_subprocess(self, *args, **kwargs):
1687
"""Run bzr in a subprocess for testing.
1689
This starts a new Python interpreter and runs bzr in there.
1690
This should only be used for tests that have a justifiable need for
1691
this isolation: e.g. they are testing startup time, or signal
1692
handling, or early startup code, etc. Subprocess code can't be
1693
profiled or debugged so easily.
1695
:keyword retcode: The status code that is expected. Defaults to 0. If
1696
None is supplied, the status code is not checked.
1697
:keyword env_changes: A dictionary which lists changes to environment
1698
variables. A value of None will unset the env variable.
1699
The values must be strings. The change will only occur in the
1700
child, so you don't need to fix the environment after running.
1701
:keyword universal_newlines: Convert CRLF => LF
1702
:keyword allow_plugins: By default the subprocess is run with
1703
--no-plugins to ensure test reproducibility. Also, it is possible
1704
for system-wide plugins to create unexpected output on stderr,
1705
which can cause unnecessary test failures.
1707
env_changes = kwargs.get('env_changes', {})
1708
working_dir = kwargs.get('working_dir', None)
1709
allow_plugins = kwargs.get('allow_plugins', False)
1711
if isinstance(args[0], list):
1713
elif isinstance(args[0], basestring):
1714
args = list(shlex.split(args[0]))
1716
raise ValueError("passing varargs to run_bzr_subprocess")
1717
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1718
working_dir=working_dir,
1719
allow_plugins=allow_plugins)
1720
# We distinguish between retcode=None and retcode not passed.
1721
supplied_retcode = kwargs.get('retcode', 0)
1722
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1723
universal_newlines=kwargs.get('universal_newlines', False),
1726
def start_bzr_subprocess(self, process_args, env_changes=None,
1727
skip_if_plan_to_signal=False,
1729
allow_plugins=False):
1730
"""Start bzr in a subprocess for testing.
1732
This starts a new Python interpreter and runs bzr in there.
1733
This should only be used for tests that have a justifiable need for
1734
this isolation: e.g. they are testing startup time, or signal
1735
handling, or early startup code, etc. Subprocess code can't be
1736
profiled or debugged so easily.
1738
:param process_args: a list of arguments to pass to the bzr executable,
1739
for example ``['--version']``.
1740
:param env_changes: A dictionary which lists changes to environment
1741
variables. A value of None will unset the env variable.
1742
The values must be strings. The change will only occur in the
1743
child, so you don't need to fix the environment after running.
1744
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1746
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1748
:returns: Popen object for the started process.
1750
if skip_if_plan_to_signal:
1751
if not getattr(os, 'kill', None):
1752
raise TestSkipped("os.kill not available.")
1754
if env_changes is None:
1758
def cleanup_environment():
1759
for env_var, value in env_changes.iteritems():
1760
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1762
def restore_environment():
1763
for env_var, value in old_env.iteritems():
1764
osutils.set_or_unset_env(env_var, value)
1766
bzr_path = self.get_bzr_path()
1769
if working_dir is not None:
1770
cwd = osutils.getcwd()
1771
os.chdir(working_dir)
1774
# win32 subprocess doesn't support preexec_fn
1775
# so we will avoid using it on all platforms, just to
1776
# make sure the code path is used, and we don't break on win32
1777
cleanup_environment()
1778
command = [sys.executable]
1779
# frozen executables don't need the path to bzr
1780
if getattr(sys, "frozen", None) is None:
1781
command.append(bzr_path)
1782
if not allow_plugins:
1783
command.append('--no-plugins')
1784
command.extend(process_args)
1785
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1787
restore_environment()
1793
def _popen(self, *args, **kwargs):
1794
"""Place a call to Popen.
1796
Allows tests to override this method to intercept the calls made to
1797
Popen for introspection.
1799
return Popen(*args, **kwargs)
1801
def get_bzr_path(self):
1802
"""Return the path of the 'bzr' executable for this test suite."""
1803
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1804
if not os.path.isfile(bzr_path):
1805
# We are probably installed. Assume sys.argv is the right file
1806
bzr_path = sys.argv[0]
1809
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1810
universal_newlines=False, process_args=None):
1811
"""Finish the execution of process.
1813
:param process: the Popen object returned from start_bzr_subprocess.
1814
:param retcode: The status code that is expected. Defaults to 0. If
1815
None is supplied, the status code is not checked.
1816
:param send_signal: an optional signal to send to the process.
1817
:param universal_newlines: Convert CRLF => LF
1818
:returns: (stdout, stderr)
1820
if send_signal is not None:
1821
os.kill(process.pid, send_signal)
1822
out, err = process.communicate()
1824
if universal_newlines:
1825
out = out.replace('\r\n', '\n')
1826
err = err.replace('\r\n', '\n')
1828
if retcode is not None and retcode != process.returncode:
1829
if process_args is None:
1830
process_args = "(unknown args)"
1831
mutter('Output of bzr %s:\n%s', process_args, out)
1832
mutter('Error for bzr %s:\n%s', process_args, err)
1833
self.fail('Command bzr %s failed with retcode %s != %s'
1834
% (process_args, retcode, process.returncode))
1837
def check_inventory_shape(self, inv, shape):
1838
"""Compare an inventory to a list of expected names.
1840
Fail if they are not precisely equal.
1843
shape = list(shape) # copy
1844
for path, ie in inv.entries():
1845
name = path.replace('\\', '/')
1846
if ie.kind == 'directory':
1853
self.fail("expected paths not found in inventory: %r" % shape)
1855
self.fail("unexpected paths found in inventory: %r" % extras)
1857
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1858
a_callable=None, *args, **kwargs):
1859
"""Call callable with redirected std io pipes.
1861
Returns the return code."""
1862
if not callable(a_callable):
1863
raise ValueError("a_callable must be callable.")
1865
stdin = StringIO("")
1867
if getattr(self, "_log_file", None) is not None:
1868
stdout = self._log_file
1872
if getattr(self, "_log_file", None is not None):
1873
stderr = self._log_file
1876
real_stdin = sys.stdin
1877
real_stdout = sys.stdout
1878
real_stderr = sys.stderr
1883
return a_callable(*args, **kwargs)
1885
sys.stdout = real_stdout
1886
sys.stderr = real_stderr
1887
sys.stdin = real_stdin
1889
def reduceLockdirTimeout(self):
1890
"""Reduce the default lock timeout for the duration of the test, so that
1891
if LockContention occurs during a test, it does so quickly.
1893
Tests that expect to provoke LockContention errors should call this.
1895
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1897
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1898
self.addCleanup(resetTimeout)
1899
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1901
def make_utf8_encoded_stringio(self, encoding_type=None):
1902
"""Return a StringIOWrapper instance, that will encode Unicode
1905
if encoding_type is None:
1906
encoding_type = 'strict'
1908
output_encoding = 'utf-8'
1909
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1910
sio.encoding = output_encoding
1914
class CapturedCall(object):
1915
"""A helper for capturing smart server calls for easy debug analysis."""
1917
def __init__(self, params, prefix_length):
1918
"""Capture the call with params and skip prefix_length stack frames."""
1921
# The last 5 frames are the __init__, the hook frame, and 3 smart
1922
# client frames. Beyond this we could get more clever, but this is good
1924
stack = traceback.extract_stack()[prefix_length:-5]
1925
self.stack = ''.join(traceback.format_list(stack))
1928
return self.call.method
1931
return self.call.method
1937
class TestCaseWithMemoryTransport(TestCase):
1938
"""Common test class for tests that do not need disk resources.
1940
Tests that need disk resources should derive from TestCaseWithTransport.
1942
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1944
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1945
a directory which does not exist. This serves to help ensure test isolation
1946
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1947
must exist. However, TestCaseWithMemoryTransport does not offer local
1948
file defaults for the transport in tests, nor does it obey the command line
1949
override, so tests that accidentally write to the common directory should
1952
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1953
a .bzr directory that stops us ascending higher into the filesystem.
1959
def __init__(self, methodName='runTest'):
1960
# allow test parameterization after test construction and before test
1961
# execution. Variables that the parameterizer sets need to be
1962
# ones that are not set by setUp, or setUp will trash them.
1963
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1964
self.vfs_transport_factory = default_transport
1965
self.transport_server = None
1966
self.transport_readonly_server = None
1967
self.__vfs_server = None
1969
def get_transport(self, relpath=None):
1970
"""Return a writeable transport.
1972
This transport is for the test scratch space relative to
1975
:param relpath: a path relative to the base url.
1977
t = get_transport(self.get_url(relpath))
1978
self.assertFalse(t.is_readonly())
1981
def get_readonly_transport(self, relpath=None):
1982
"""Return a readonly transport for the test scratch space
1984
This can be used to test that operations which should only need
1985
readonly access in fact do not try to write.
1987
:param relpath: a path relative to the base url.
1989
t = get_transport(self.get_readonly_url(relpath))
1990
self.assertTrue(t.is_readonly())
1993
def create_transport_readonly_server(self):
1994
"""Create a transport server from class defined at init.
1996
This is mostly a hook for daughter classes.
1998
return self.transport_readonly_server()
2000
def get_readonly_server(self):
2001
"""Get the server instance for the readonly transport
2003
This is useful for some tests with specific servers to do diagnostics.
2005
if self.__readonly_server is None:
2006
if self.transport_readonly_server is None:
2007
# readonly decorator requested
2008
# bring up the server
2009
self.__readonly_server = ReadonlyServer()
2010
self.__readonly_server.setUp(self.get_vfs_only_server())
2012
self.__readonly_server = self.create_transport_readonly_server()
2013
self.__readonly_server.setUp(self.get_vfs_only_server())
2014
self.addCleanup(self.__readonly_server.tearDown)
2015
return self.__readonly_server
2017
def get_readonly_url(self, relpath=None):
2018
"""Get a URL for the readonly transport.
2020
This will either be backed by '.' or a decorator to the transport
2021
used by self.get_url()
2022
relpath provides for clients to get a path relative to the base url.
2023
These should only be downwards relative, not upwards.
2025
base = self.get_readonly_server().get_url()
2026
return self._adjust_url(base, relpath)
2028
def get_vfs_only_server(self):
2029
"""Get the vfs only read/write server instance.
2031
This is useful for some tests with specific servers that need
2034
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2035
is no means to override it.
2037
if self.__vfs_server is None:
2038
self.__vfs_server = MemoryServer()
2039
self.__vfs_server.setUp()
2040
self.addCleanup(self.__vfs_server.tearDown)
2041
return self.__vfs_server
2043
def get_server(self):
2044
"""Get the read/write server instance.
2046
This is useful for some tests with specific servers that need
2049
This is built from the self.transport_server factory. If that is None,
2050
then the self.get_vfs_server is returned.
2052
if self.__server is None:
2053
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
2054
return self.get_vfs_only_server()
2056
# bring up a decorated means of access to the vfs only server.
2057
self.__server = self.transport_server()
2059
self.__server.setUp(self.get_vfs_only_server())
2060
except TypeError, e:
2061
# This should never happen; the try:Except here is to assist
2062
# developers having to update code rather than seeing an
2063
# uninformative TypeError.
2064
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
2065
self.addCleanup(self.__server.tearDown)
2066
return self.__server
2068
def _adjust_url(self, base, relpath):
2069
"""Get a URL (or maybe a path) for the readwrite transport.
2071
This will either be backed by '.' or to an equivalent non-file based
2073
relpath provides for clients to get a path relative to the base url.
2074
These should only be downwards relative, not upwards.
2076
if relpath is not None and relpath != '.':
2077
if not base.endswith('/'):
2079
# XXX: Really base should be a url; we did after all call
2080
# get_url()! But sometimes it's just a path (from
2081
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2082
# to a non-escaped local path.
2083
if base.startswith('./') or base.startswith('/'):
2086
base += urlutils.escape(relpath)
2089
def get_url(self, relpath=None):
2090
"""Get a URL (or maybe a path) for the readwrite transport.
2092
This will either be backed by '.' or to an equivalent non-file based
2094
relpath provides for clients to get a path relative to the base url.
2095
These should only be downwards relative, not upwards.
2097
base = self.get_server().get_url()
2098
return self._adjust_url(base, relpath)
2100
def get_vfs_only_url(self, relpath=None):
2101
"""Get a URL (or maybe a path for the plain old vfs transport.
2103
This will never be a smart protocol. It always has all the
2104
capabilities of the local filesystem, but it might actually be a
2105
MemoryTransport or some other similar virtual filesystem.
2107
This is the backing transport (if any) of the server returned by
2108
get_url and get_readonly_url.
2110
:param relpath: provides for clients to get a path relative to the base
2111
url. These should only be downwards relative, not upwards.
2114
base = self.get_vfs_only_server().get_url()
2115
return self._adjust_url(base, relpath)
2117
def _create_safety_net(self):
2118
"""Make a fake bzr directory.
2120
This prevents any tests propagating up onto the TEST_ROOT directory's
2123
root = TestCaseWithMemoryTransport.TEST_ROOT
2124
bzrdir.BzrDir.create_standalone_workingtree(root)
2126
def _check_safety_net(self):
2127
"""Check that the safety .bzr directory have not been touched.
2129
_make_test_root have created a .bzr directory to prevent tests from
2130
propagating. This method ensures than a test did not leaked.
2132
root = TestCaseWithMemoryTransport.TEST_ROOT
2133
wt = workingtree.WorkingTree.open(root)
2134
last_rev = wt.last_revision()
2135
if last_rev != 'null:':
2136
# The current test have modified the /bzr directory, we need to
2137
# recreate a new one or all the followng tests will fail.
2138
# If you need to inspect its content uncomment the following line
2139
# import pdb; pdb.set_trace()
2140
_rmtree_temp_dir(root + '/.bzr')
2141
self._create_safety_net()
2142
raise AssertionError('%s/.bzr should not be modified' % root)
2144
def _make_test_root(self):
2145
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2146
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2147
TestCaseWithMemoryTransport.TEST_ROOT = root
2149
self._create_safety_net()
2151
# The same directory is used by all tests, and we're not
2152
# specifically told when all tests are finished. This will do.
2153
atexit.register(_rmtree_temp_dir, root)
2155
self.addCleanup(self._check_safety_net)
2157
def makeAndChdirToTestDir(self):
2158
"""Create a temporary directories for this one test.
2160
This must set self.test_home_dir and self.test_dir and chdir to
2163
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2165
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2166
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2167
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2169
def make_branch(self, relpath, format=None):
2170
"""Create a branch on the transport at relpath."""
2171
repo = self.make_repository(relpath, format=format)
2172
return repo.bzrdir.create_branch()
2174
def make_bzrdir(self, relpath, format=None):
2176
# might be a relative or absolute path
2177
maybe_a_url = self.get_url(relpath)
2178
segments = maybe_a_url.rsplit('/', 1)
2179
t = get_transport(maybe_a_url)
2180
if len(segments) > 1 and segments[-1] not in ('', '.'):
2184
if isinstance(format, basestring):
2185
format = bzrdir.format_registry.make_bzrdir(format)
2186
return format.initialize_on_transport(t)
2187
except errors.UninitializableFormat:
2188
raise TestSkipped("Format %s is not initializable." % format)
2190
def make_repository(self, relpath, shared=False, format=None):
2191
"""Create a repository on our default transport at relpath.
2193
Note that relpath must be a relative path, not a full url.
2195
# FIXME: If you create a remoterepository this returns the underlying
2196
# real format, which is incorrect. Actually we should make sure that
2197
# RemoteBzrDir returns a RemoteRepository.
2198
# maybe mbp 20070410
2199
made_control = self.make_bzrdir(relpath, format=format)
2200
return made_control.create_repository(shared=shared)
2202
def make_smart_server(self, path):
2203
smart_server = server.SmartTCPServer_for_testing()
2204
smart_server.setUp(self.get_server())
2205
remote_transport = get_transport(smart_server.get_url()).clone(path)
2206
self.addCleanup(smart_server.tearDown)
2207
return remote_transport
2209
def make_branch_and_memory_tree(self, relpath, format=None):
2210
"""Create a branch on the default transport and a MemoryTree for it."""
2211
b = self.make_branch(relpath, format=format)
2212
return memorytree.MemoryTree.create_on_branch(b)
2214
def make_branch_builder(self, relpath, format=None):
2215
branch = self.make_branch(relpath, format=format)
2216
return branchbuilder.BranchBuilder(branch=branch)
2218
def overrideEnvironmentForTesting(self):
2219
os.environ['HOME'] = self.test_home_dir
2220
os.environ['BZR_HOME'] = self.test_home_dir
2223
super(TestCaseWithMemoryTransport, self).setUp()
2224
self._make_test_root()
2225
_currentdir = os.getcwdu()
2226
def _leaveDirectory():
2227
os.chdir(_currentdir)
2228
self.addCleanup(_leaveDirectory)
2229
self.makeAndChdirToTestDir()
2230
self.overrideEnvironmentForTesting()
2231
self.__readonly_server = None
2232
self.__server = None
2233
self.reduceLockdirTimeout()
2235
def setup_smart_server_with_call_log(self):
2236
"""Sets up a smart server as the transport server with a call log."""
2237
self.transport_server = server.SmartTCPServer_for_testing
2238
self.hpss_calls = []
2240
# Skip the current stack down to the caller of
2241
# setup_smart_server_with_call_log
2242
prefix_length = len(traceback.extract_stack()) - 2
2243
def capture_hpss_call(params):
2244
self.hpss_calls.append(
2245
CapturedCall(params, prefix_length))
2246
client._SmartClient.hooks.install_named_hook(
2247
'call', capture_hpss_call, None)
2249
def reset_smart_call_log(self):
2250
self.hpss_calls = []
2253
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2254
"""Derived class that runs a test within a temporary directory.
2256
This is useful for tests that need to create a branch, etc.
2258
The directory is created in a slightly complex way: for each
2259
Python invocation, a new temporary top-level directory is created.
2260
All test cases create their own directory within that. If the
2261
tests complete successfully, the directory is removed.
2263
:ivar test_base_dir: The path of the top-level directory for this
2264
test, which contains a home directory and a work directory.
2266
:ivar test_home_dir: An initially empty directory under test_base_dir
2267
which is used as $HOME for this test.
2269
:ivar test_dir: A directory under test_base_dir used as the current
2270
directory when the test proper is run.
2273
OVERRIDE_PYTHON = 'python'
2275
def check_file_contents(self, filename, expect):
2276
self.log("check contents of file %s" % filename)
2277
contents = file(filename, 'r').read()
2278
if contents != expect:
2279
self.log("expected: %r" % expect)
2280
self.log("actually: %r" % contents)
2281
self.fail("contents of %s not as expected" % filename)
2283
def _getTestDirPrefix(self):
2284
# create a directory within the top level test directory
2285
if sys.platform == 'win32':
2286
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2287
# windows is likely to have path-length limits so use a short name
2288
name_prefix = name_prefix[-30:]
2290
name_prefix = re.sub('[/]', '_', self.id())
2293
def makeAndChdirToTestDir(self):
2294
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2296
For TestCaseInTempDir we create a temporary directory based on the test
2297
name and then create two subdirs - test and home under it.
2299
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2300
self._getTestDirPrefix())
2302
for i in range(100):
2303
if os.path.exists(name):
2304
name = name_prefix + '_' + str(i)
2308
# now create test and home directories within this dir
2309
self.test_base_dir = name
2310
self.test_home_dir = self.test_base_dir + '/home'
2311
os.mkdir(self.test_home_dir)
2312
self.test_dir = self.test_base_dir + '/work'
2313
os.mkdir(self.test_dir)
2314
os.chdir(self.test_dir)
2315
# put name of test inside
2316
f = file(self.test_base_dir + '/name', 'w')
2321
self.addCleanup(self.deleteTestDir)
2323
def deleteTestDir(self):
2324
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2325
_rmtree_temp_dir(self.test_base_dir)
2327
def build_tree(self, shape, line_endings='binary', transport=None):
2328
"""Build a test tree according to a pattern.
2330
shape is a sequence of file specifications. If the final
2331
character is '/', a directory is created.
2333
This assumes that all the elements in the tree being built are new.
2335
This doesn't add anything to a branch.
2337
:type shape: list or tuple.
2338
:param line_endings: Either 'binary' or 'native'
2339
in binary mode, exact contents are written in native mode, the
2340
line endings match the default platform endings.
2341
:param transport: A transport to write to, for building trees on VFS's.
2342
If the transport is readonly or None, "." is opened automatically.
2345
if type(shape) not in (list, tuple):
2346
raise AssertionError("Parameter 'shape' should be "
2347
"a list or a tuple. Got %r instead" % (shape,))
2348
# It's OK to just create them using forward slashes on windows.
2349
if transport is None or transport.is_readonly():
2350
transport = get_transport(".")
2352
self.assertIsInstance(name, basestring)
2354
transport.mkdir(urlutils.escape(name[:-1]))
2356
if line_endings == 'binary':
2358
elif line_endings == 'native':
2361
raise errors.BzrError(
2362
'Invalid line ending request %r' % line_endings)
2363
content = "contents of %s%s" % (name.encode('utf-8'), end)
2364
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2366
def build_tree_contents(self, shape):
2367
build_tree_contents(shape)
2369
def assertInWorkingTree(self, path, root_path='.', tree=None):
2370
"""Assert whether path or paths are in the WorkingTree"""
2372
tree = workingtree.WorkingTree.open(root_path)
2373
if not isinstance(path, basestring):
2375
self.assertInWorkingTree(p, tree=tree)
2377
self.assertIsNot(tree.path2id(path), None,
2378
path+' not in working tree.')
2380
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2381
"""Assert whether path or paths are not in the WorkingTree"""
2383
tree = workingtree.WorkingTree.open(root_path)
2384
if not isinstance(path, basestring):
2386
self.assertNotInWorkingTree(p,tree=tree)
2388
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2391
class TestCaseWithTransport(TestCaseInTempDir):
2392
"""A test case that provides get_url and get_readonly_url facilities.
2394
These back onto two transport servers, one for readonly access and one for
2397
If no explicit class is provided for readonly access, a
2398
ReadonlyTransportDecorator is used instead which allows the use of non disk
2399
based read write transports.
2401
If an explicit class is provided for readonly access, that server and the
2402
readwrite one must both define get_url() as resolving to os.getcwd().
2405
def get_vfs_only_server(self):
2406
"""See TestCaseWithMemoryTransport.
2408
This is useful for some tests with specific servers that need
2411
if self.__vfs_server is None:
2412
self.__vfs_server = self.vfs_transport_factory()
2413
self.__vfs_server.setUp()
2414
self.addCleanup(self.__vfs_server.tearDown)
2415
return self.__vfs_server
2417
def make_branch_and_tree(self, relpath, format=None):
2418
"""Create a branch on the transport and a tree locally.
2420
If the transport is not a LocalTransport, the Tree can't be created on
2421
the transport. In that case if the vfs_transport_factory is
2422
LocalURLServer the working tree is created in the local
2423
directory backing the transport, and the returned tree's branch and
2424
repository will also be accessed locally. Otherwise a lightweight
2425
checkout is created and returned.
2427
:param format: The BzrDirFormat.
2428
:returns: the WorkingTree.
2430
# TODO: always use the local disk path for the working tree,
2431
# this obviously requires a format that supports branch references
2432
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2434
b = self.make_branch(relpath, format=format)
2436
return b.bzrdir.create_workingtree()
2437
except errors.NotLocalUrl:
2438
# We can only make working trees locally at the moment. If the
2439
# transport can't support them, then we keep the non-disk-backed
2440
# branch and create a local checkout.
2441
if self.vfs_transport_factory is LocalURLServer:
2442
# the branch is colocated on disk, we cannot create a checkout.
2443
# hopefully callers will expect this.
2444
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2445
wt = local_controldir.create_workingtree()
2446
if wt.branch._format != b._format:
2448
# Make sure that assigning to wt._branch fixes wt.branch,
2449
# in case the implementation details of workingtree objects
2451
self.assertIs(b, wt.branch)
2454
return b.create_checkout(relpath, lightweight=True)
2456
def assertIsDirectory(self, relpath, transport):
2457
"""Assert that relpath within transport is a directory.
2459
This may not be possible on all transports; in that case it propagates
2460
a TransportNotPossible.
2463
mode = transport.stat(relpath).st_mode
2464
except errors.NoSuchFile:
2465
self.fail("path %s is not a directory; no such file"
2467
if not stat.S_ISDIR(mode):
2468
self.fail("path %s is not a directory; has mode %#o"
2471
def assertTreesEqual(self, left, right):
2472
"""Check that left and right have the same content and properties."""
2473
# we use a tree delta to check for equality of the content, and we
2474
# manually check for equality of other things such as the parents list.
2475
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2476
differences = left.changes_from(right)
2477
self.assertFalse(differences.has_changed(),
2478
"Trees %r and %r are different: %r" % (left, right, differences))
2481
super(TestCaseWithTransport, self).setUp()
2482
self.__vfs_server = None
2485
class ChrootedTestCase(TestCaseWithTransport):
2486
"""A support class that provides readonly urls outside the local namespace.
2488
This is done by checking if self.transport_server is a MemoryServer. if it
2489
is then we are chrooted already, if it is not then an HttpServer is used
2492
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2493
be used without needed to redo it when a different
2494
subclass is in use ?
2498
super(ChrootedTestCase, self).setUp()
2499
if not self.vfs_transport_factory == MemoryServer:
2500
self.transport_readonly_server = HttpServer
2503
def condition_id_re(pattern):
2504
"""Create a condition filter which performs a re check on a test's id.
2506
:param pattern: A regular expression string.
2507
:return: A callable that returns True if the re matches.
2509
filter_re = osutils.re_compile_checked(pattern, 0,
2511
def condition(test):
2513
return filter_re.search(test_id)
2517
def condition_isinstance(klass_or_klass_list):
2518
"""Create a condition filter which returns isinstance(param, klass).
2520
:return: A callable which when called with one parameter obj return the
2521
result of isinstance(obj, klass_or_klass_list).
2524
return isinstance(obj, klass_or_klass_list)
2528
def condition_id_in_list(id_list):
2529
"""Create a condition filter which verify that test's id in a list.
2531
:param id_list: A TestIdList object.
2532
:return: A callable that returns True if the test's id appears in the list.
2534
def condition(test):
2535
return id_list.includes(test.id())
2539
def condition_id_startswith(starts):
2540
"""Create a condition filter verifying that test's id starts with a string.
2542
:param starts: A list of string.
2543
:return: A callable that returns True if the test's id starts with one of
2546
def condition(test):
2547
for start in starts:
2548
if test.id().startswith(start):
2554
def exclude_tests_by_condition(suite, condition):
2555
"""Create a test suite which excludes some tests from suite.
2557
:param suite: The suite to get tests from.
2558
:param condition: A callable whose result evaluates True when called with a
2559
test case which should be excluded from the result.
2560
:return: A suite which contains the tests found in suite that fail
2564
for test in iter_suite_tests(suite):
2565
if not condition(test):
2567
return TestUtil.TestSuite(result)
2570
def filter_suite_by_condition(suite, condition):
2571
"""Create a test suite by filtering another one.
2573
:param suite: The source suite.
2574
:param condition: A callable whose result evaluates True when called with a
2575
test case which should be included in the result.
2576
:return: A suite which contains the tests found in suite that pass
2580
for test in iter_suite_tests(suite):
2583
return TestUtil.TestSuite(result)
2586
def filter_suite_by_re(suite, pattern):
2587
"""Create a test suite by filtering another one.
2589
:param suite: the source suite
2590
:param pattern: pattern that names must match
2591
:returns: the newly created suite
2593
condition = condition_id_re(pattern)
2594
result_suite = filter_suite_by_condition(suite, condition)
2598
def filter_suite_by_id_list(suite, test_id_list):
2599
"""Create a test suite by filtering another one.
2601
:param suite: The source suite.
2602
:param test_id_list: A list of the test ids to keep as strings.
2603
:returns: the newly created suite
2605
condition = condition_id_in_list(test_id_list)
2606
result_suite = filter_suite_by_condition(suite, condition)
2610
def filter_suite_by_id_startswith(suite, start):
2611
"""Create a test suite by filtering another one.
2613
:param suite: The source suite.
2614
:param start: A list of string the test id must start with one of.
2615
:returns: the newly created suite
2617
condition = condition_id_startswith(start)
2618
result_suite = filter_suite_by_condition(suite, condition)
2622
def exclude_tests_by_re(suite, pattern):
2623
"""Create a test suite which excludes some tests from suite.
2625
:param suite: The suite to get tests from.
2626
:param pattern: A regular expression string. Test ids that match this
2627
pattern will be excluded from the result.
2628
:return: A TestSuite that contains all the tests from suite without the
2629
tests that matched pattern. The order of tests is the same as it was in
2632
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2635
def preserve_input(something):
2636
"""A helper for performing test suite transformation chains.
2638
:param something: Anything you want to preserve.
2644
def randomize_suite(suite):
2645
"""Return a new TestSuite with suite's tests in random order.
2647
The tests in the input suite are flattened into a single suite in order to
2648
accomplish this. Any nested TestSuites are removed to provide global
2651
tests = list(iter_suite_tests(suite))
2652
random.shuffle(tests)
2653
return TestUtil.TestSuite(tests)
2656
def split_suite_by_condition(suite, condition):
2657
"""Split a test suite into two by a condition.
2659
:param suite: The suite to split.
2660
:param condition: The condition to match on. Tests that match this
2661
condition are returned in the first test suite, ones that do not match
2662
are in the second suite.
2663
:return: A tuple of two test suites, where the first contains tests from
2664
suite matching the condition, and the second contains the remainder
2665
from suite. The order within each output suite is the same as it was in
2670
for test in iter_suite_tests(suite):
2672
matched.append(test)
2674
did_not_match.append(test)
2675
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2678
def split_suite_by_re(suite, pattern):
2679
"""Split a test suite into two by a regular expression.
2681
:param suite: The suite to split.
2682
:param pattern: A regular expression string. Test ids that match this
2683
pattern will be in the first test suite returned, and the others in the
2684
second test suite returned.
2685
:return: A tuple of two test suites, where the first contains tests from
2686
suite matching pattern, and the second contains the remainder from
2687
suite. The order within each output suite is the same as it was in
2690
return split_suite_by_condition(suite, condition_id_re(pattern))
2693
def run_suite(suite, name='test', verbose=False, pattern=".*",
2694
stop_on_failure=False,
2695
transport=None, lsprof_timed=None, bench_history=None,
2696
matching_tests_first=None,
2699
exclude_pattern=None,
2702
suite_decorators=None,
2704
"""Run a test suite for bzr selftest.
2706
:param runner_class: The class of runner to use. Must support the
2707
constructor arguments passed by run_suite which are more than standard
2709
:return: A boolean indicating success.
2711
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2716
if runner_class is None:
2717
runner_class = TextTestRunner
2720
runner = runner_class(stream=stream,
2722
verbosity=verbosity,
2723
bench_history=bench_history,
2724
list_only=list_only,
2727
runner.stop_on_failure=stop_on_failure
2728
# built in decorator factories:
2730
random_order(random_seed, runner),
2731
exclude_tests(exclude_pattern),
2733
if matching_tests_first:
2734
decorators.append(tests_first(pattern))
2736
decorators.append(filter_tests(pattern))
2737
if suite_decorators:
2738
decorators.extend(suite_decorators)
2739
for decorator in decorators:
2740
suite = decorator(suite)
2741
result = runner.run(suite)
2746
return result.wasStrictlySuccessful()
2748
return result.wasSuccessful()
2751
# A registry where get() returns a suite decorator.
2752
parallel_registry = registry.Registry()
2755
def fork_decorator(suite):
2756
concurrency = local_concurrency()
2757
if concurrency == 1:
2759
from testtools import ConcurrentTestSuite
2760
return ConcurrentTestSuite(suite, fork_for_tests)
2761
parallel_registry.register('fork', fork_decorator)
2764
def subprocess_decorator(suite):
2765
concurrency = local_concurrency()
2766
if concurrency == 1:
2768
from testtools import ConcurrentTestSuite
2769
return ConcurrentTestSuite(suite, reinvoke_for_tests)
2770
parallel_registry.register('subprocess', subprocess_decorator)
2773
def exclude_tests(exclude_pattern):
2774
"""Return a test suite decorator that excludes tests."""
2775
if exclude_pattern is None:
2776
return identity_decorator
2777
def decorator(suite):
2778
return ExcludeDecorator(suite, exclude_pattern)
2782
def filter_tests(pattern):
2784
return identity_decorator
2785
def decorator(suite):
2786
return FilterTestsDecorator(suite, pattern)
2790
def random_order(random_seed, runner):
2791
"""Return a test suite decorator factory for randomising tests order.
2793
:param random_seed: now, a string which casts to a long, or a long.
2794
:param runner: A test runner with a stream attribute to report on.
2796
if random_seed is None:
2797
return identity_decorator
2798
def decorator(suite):
2799
return RandomDecorator(suite, random_seed, runner.stream)
2803
def tests_first(pattern):
2805
return identity_decorator
2806
def decorator(suite):
2807
return TestFirstDecorator(suite, pattern)
2811
def identity_decorator(suite):
2816
class TestDecorator(TestSuite):
2817
"""A decorator for TestCase/TestSuite objects.
2819
Usually, subclasses should override __iter__(used when flattening test
2820
suites), which we do to filter, reorder, parallelise and so on, run() and
2824
def __init__(self, suite):
2825
TestSuite.__init__(self)
2828
def countTestCases(self):
2831
cases += test.countTestCases()
2838
def run(self, result):
2839
# Use iteration on self, not self._tests, to allow subclasses to hook
2842
if result.shouldStop:
2848
class ExcludeDecorator(TestDecorator):
2849
"""A decorator which excludes test matching an exclude pattern."""
2851
def __init__(self, suite, exclude_pattern):
2852
TestDecorator.__init__(self, suite)
2853
self.exclude_pattern = exclude_pattern
2854
self.excluded = False
2858
return iter(self._tests)
2859
self.excluded = True
2860
suite = exclude_tests_by_re(self, self.exclude_pattern)
2862
self.addTests(suite)
2863
return iter(self._tests)
2866
class FilterTestsDecorator(TestDecorator):
2867
"""A decorator which filters tests to those matching a pattern."""
2869
def __init__(self, suite, pattern):
2870
TestDecorator.__init__(self, suite)
2871
self.pattern = pattern
2872
self.filtered = False
2876
return iter(self._tests)
2877
self.filtered = True
2878
suite = filter_suite_by_re(self, self.pattern)
2880
self.addTests(suite)
2881
return iter(self._tests)
2884
class RandomDecorator(TestDecorator):
2885
"""A decorator which randomises the order of its tests."""
2887
def __init__(self, suite, random_seed, stream):
2888
TestDecorator.__init__(self, suite)
2889
self.random_seed = random_seed
2890
self.randomised = False
2891
self.stream = stream
2895
return iter(self._tests)
2896
self.randomised = True
2897
self.stream.writeln("Randomizing test order using seed %s\n" %
2898
(self.actual_seed()))
2899
# Initialise the random number generator.
2900
random.seed(self.actual_seed())
2901
suite = randomize_suite(self)
2903
self.addTests(suite)
2904
return iter(self._tests)
2906
def actual_seed(self):
2907
if self.random_seed == "now":
2908
# We convert the seed to a long to make it reuseable across
2909
# invocations (because the user can reenter it).
2910
self.random_seed = long(time.time())
2912
# Convert the seed to a long if we can
2914
self.random_seed = long(self.random_seed)
2917
return self.random_seed
2920
class TestFirstDecorator(TestDecorator):
2921
"""A decorator which moves named tests to the front."""
2923
def __init__(self, suite, pattern):
2924
TestDecorator.__init__(self, suite)
2925
self.pattern = pattern
2926
self.filtered = False
2930
return iter(self._tests)
2931
self.filtered = True
2932
suites = split_suite_by_re(self, self.pattern)
2934
self.addTests(suites)
2935
return iter(self._tests)
2938
def partition_tests(suite, count):
2939
"""Partition suite into count lists of tests."""
2941
tests = list(iter_suite_tests(suite))
2942
tests_per_process = int(math.ceil(float(len(tests)) / count))
2943
for block in range(count):
2944
low_test = block * tests_per_process
2945
high_test = low_test + tests_per_process
2946
process_tests = tests[low_test:high_test]
2947
result.append(process_tests)
2951
def fork_for_tests(suite):
2952
"""Take suite and start up one runner per CPU by forking()
2954
:return: An iterable of TestCase-like objects which can each have
2955
run(result) called on them to feed tests to result.
2957
concurrency = local_concurrency()
2959
from subunit import TestProtocolClient, ProtocolTestCase
2960
class TestInOtherProcess(ProtocolTestCase):
2961
# Should be in subunit, I think. RBC.
2962
def __init__(self, stream, pid):
2963
ProtocolTestCase.__init__(self, stream)
2966
def run(self, result):
2968
ProtocolTestCase.run(self, result)
2970
os.waitpid(self.pid, os.WNOHANG)
2972
test_blocks = partition_tests(suite, concurrency)
2973
for process_tests in test_blocks:
2974
process_suite = TestSuite()
2975
process_suite.addTests(process_tests)
2976
c2pread, c2pwrite = os.pipe()
2981
# Leave stderr and stdout open so we can see test noise
2982
# Close stdin so that the child goes away if it decides to
2983
# read from stdin (otherwise its a roulette to see what
2984
# child actually gets keystrokes for pdb etc).
2987
stream = os.fdopen(c2pwrite, 'wb', 1)
2988
subunit_result = TestProtocolClient(stream)
2989
process_suite.run(subunit_result)
2994
stream = os.fdopen(c2pread, 'rb', 1)
2995
test = TestInOtherProcess(stream, pid)
3000
def reinvoke_for_tests(suite):
3001
"""Take suite and start up one runner per CPU using subprocess().
3003
:return: An iterable of TestCase-like objects which can each have
3004
run(result) called on them to feed tests to result.
3006
concurrency = local_concurrency()
3008
from subunit import TestProtocolClient, ProtocolTestCase
3009
class TestInSubprocess(ProtocolTestCase):
3010
def __init__(self, process, name):
3011
ProtocolTestCase.__init__(self, process.stdout)
3012
self.process = process
3013
self.process.stdin.close()
3016
def run(self, result):
3018
ProtocolTestCase.run(self, result)
3021
os.unlink(self.name)
3022
# print "pid %d finished" % finished_process
3023
test_blocks = partition_tests(suite, concurrency)
3024
for process_tests in test_blocks:
3025
# ugly; currently reimplement rather than reuses TestCase methods.
3026
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3027
if not os.path.isfile(bzr_path):
3028
# We are probably installed. Assume sys.argv is the right file
3029
bzr_path = sys.argv[0]
3030
fd, test_list_file_name = tempfile.mkstemp()
3031
test_list_file = os.fdopen(fd, 'wb', 1)
3032
for test in process_tests:
3033
test_list_file.write(test.id() + '\n')
3034
test_list_file.close()
3036
argv = [bzr_path, 'selftest', '--load-list', test_list_file_name,
3038
if '--no-plugins' in sys.argv:
3039
argv.append('--no-plugins')
3040
# stderr=STDOUT would be ideal, but until we prevent noise on
3041
# stderr it can interrupt the subunit protocol.
3042
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3044
test = TestInSubprocess(process, test_list_file_name)
3047
os.unlink(test_list_file_name)
3052
def cpucount(content):
3053
lines = content.splitlines()
3054
prefix = 'processor'
3056
if line.startswith(prefix):
3057
concurrency = int(line[line.find(':')+1:]) + 1
3061
def local_concurrency():
3063
content = file('/proc/cpuinfo', 'rb').read()
3064
concurrency = cpucount(content)
3065
except Exception, e:
3070
class BZRTransformingResult(unittest.TestResult):
3072
def __init__(self, target):
3073
unittest.TestResult.__init__(self)
3074
self.result = target
3076
def startTest(self, test):
3077
self.result.startTest(test)
3079
def stopTest(self, test):
3080
self.result.stopTest(test)
3082
def addError(self, test, err):
3083
feature = self._error_looks_like('UnavailableFeature: ', err)
3084
if feature is not None:
3085
self.result.addNotSupported(test, feature)
3087
self.result.addError(test, err)
3089
def addFailure(self, test, err):
3090
known = self._error_looks_like('KnownFailure: ', err)
3091
if known is not None:
3092
self.result._addKnownFailure(test, [KnownFailure,
3093
KnownFailure(known), None])
3095
self.result.addFailure(test, err)
3097
def addSkip(self, test, reason):
3098
self.result.addSkip(test, reason)
3100
def addSuccess(self, test):
3101
self.result.addSuccess(test)
3103
def _error_looks_like(self, prefix, err):
3104
"""Deserialize exception and returns the stringify value."""
3108
if isinstance(exc, subunit.RemoteException):
3109
# stringify the exception gives access to the remote traceback
3110
# We search the last line for 'prefix'
3111
lines = str(exc).split('\n')
3112
while lines and not lines[-1]:
3115
if lines[-1].startswith(prefix):
3116
value = lines[-1][len(prefix):]
3120
# Controlled by "bzr selftest -E=..." option
3121
selftest_debug_flags = set()
3124
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3126
test_suite_factory=None,
3129
matching_tests_first=None,
3132
exclude_pattern=None,
3138
suite_decorators=None,
3140
"""Run the whole test suite under the enhanced runner"""
3141
# XXX: Very ugly way to do this...
3142
# Disable warning about old formats because we don't want it to disturb
3143
# any blackbox tests.
3144
from bzrlib import repository
3145
repository._deprecation_warning_done = True
3147
global default_transport
3148
if transport is None:
3149
transport = default_transport
3150
old_transport = default_transport
3151
default_transport = transport
3152
global selftest_debug_flags
3153
old_debug_flags = selftest_debug_flags
3154
if debug_flags is not None:
3155
selftest_debug_flags = set(debug_flags)
3157
if load_list is None:
3160
keep_only = load_test_id_list(load_list)
3161
if test_suite_factory is None:
3162
suite = test_suite(keep_only, starting_with)
3164
suite = test_suite_factory()
3165
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3166
stop_on_failure=stop_on_failure,
3167
transport=transport,
3168
lsprof_timed=lsprof_timed,
3169
bench_history=bench_history,
3170
matching_tests_first=matching_tests_first,
3171
list_only=list_only,
3172
random_seed=random_seed,
3173
exclude_pattern=exclude_pattern,
3175
runner_class=runner_class,
3176
suite_decorators=suite_decorators,
3179
default_transport = old_transport
3180
selftest_debug_flags = old_debug_flags
3183
def load_test_id_list(file_name):
3184
"""Load a test id list from a text file.
3186
The format is one test id by line. No special care is taken to impose
3187
strict rules, these test ids are used to filter the test suite so a test id
3188
that do not match an existing test will do no harm. This allows user to add
3189
comments, leave blank lines, etc.
3193
ftest = open(file_name, 'rt')
3195
if e.errno != errno.ENOENT:
3198
raise errors.NoSuchFile(file_name)
3200
for test_name in ftest.readlines():
3201
test_list.append(test_name.strip())
3206
def suite_matches_id_list(test_suite, id_list):
3207
"""Warns about tests not appearing or appearing more than once.
3209
:param test_suite: A TestSuite object.
3210
:param test_id_list: The list of test ids that should be found in
3213
:return: (absents, duplicates) absents is a list containing the test found
3214
in id_list but not in test_suite, duplicates is a list containing the
3215
test found multiple times in test_suite.
3217
When using a prefined test id list, it may occurs that some tests do not
3218
exist anymore or that some tests use the same id. This function warns the
3219
tester about potential problems in his workflow (test lists are volatile)
3220
or in the test suite itself (using the same id for several tests does not
3221
help to localize defects).
3223
# Build a dict counting id occurrences
3225
for test in iter_suite_tests(test_suite):
3227
tests[id] = tests.get(id, 0) + 1
3232
occurs = tests.get(id, 0)
3234
not_found.append(id)
3236
duplicates.append(id)
3238
return not_found, duplicates
3241
class TestIdList(object):
3242
"""Test id list to filter a test suite.
3244
Relying on the assumption that test ids are built as:
3245
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3246
notation, this class offers methods to :
3247
- avoid building a test suite for modules not refered to in the test list,
3248
- keep only the tests listed from the module test suite.
3251
def __init__(self, test_id_list):
3252
# When a test suite needs to be filtered against us we compare test ids
3253
# for equality, so a simple dict offers a quick and simple solution.
3254
self.tests = dict().fromkeys(test_id_list, True)
3256
# While unittest.TestCase have ids like:
3257
# <module>.<class>.<method>[(<param+)],
3258
# doctest.DocTestCase can have ids like:
3261
# <module>.<function>
3262
# <module>.<class>.<method>
3264
# Since we can't predict a test class from its name only, we settle on
3265
# a simple constraint: a test id always begins with its module name.
3268
for test_id in test_id_list:
3269
parts = test_id.split('.')
3270
mod_name = parts.pop(0)
3271
modules[mod_name] = True
3273
mod_name += '.' + part
3274
modules[mod_name] = True
3275
self.modules = modules
3277
def refers_to(self, module_name):
3278
"""Is there tests for the module or one of its sub modules."""
3279
return self.modules.has_key(module_name)
3281
def includes(self, test_id):
3282
return self.tests.has_key(test_id)
3285
class TestPrefixAliasRegistry(registry.Registry):
3286
"""A registry for test prefix aliases.
3288
This helps implement shorcuts for the --starting-with selftest
3289
option. Overriding existing prefixes is not allowed but not fatal (a
3290
warning will be emitted).
3293
def register(self, key, obj, help=None, info=None,
3294
override_existing=False):
3295
"""See Registry.register.
3297
Trying to override an existing alias causes a warning to be emitted,
3298
not a fatal execption.
3301
super(TestPrefixAliasRegistry, self).register(
3302
key, obj, help=help, info=info, override_existing=False)
3304
actual = self.get(key)
3305
note('Test prefix alias %s is already used for %s, ignoring %s'
3306
% (key, actual, obj))
3308
def resolve_alias(self, id_start):
3309
"""Replace the alias by the prefix in the given string.
3311
Using an unknown prefix is an error to help catching typos.
3313
parts = id_start.split('.')
3315
parts[0] = self.get(parts[0])
3317
raise errors.BzrCommandError(
3318
'%s is not a known test prefix alias' % parts[0])
3319
return '.'.join(parts)
3322
test_prefix_alias_registry = TestPrefixAliasRegistry()
3323
"""Registry of test prefix aliases."""
3326
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3327
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3328
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3330
# Obvious higest levels prefixes, feel free to add your own via a plugin
3331
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3332
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3333
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3334
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3335
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3338
def test_suite(keep_only=None, starting_with=None):
3339
"""Build and return TestSuite for the whole of bzrlib.
3341
:param keep_only: A list of test ids limiting the suite returned.
3343
:param starting_with: An id limiting the suite returned to the tests
3346
This function can be replaced if you need to change the default test
3347
suite on a global basis, but it is not encouraged.
3351
'bzrlib.tests.blackbox',
3352
'bzrlib.tests.branch_implementations',
3353
'bzrlib.tests.bzrdir_implementations',
3354
'bzrlib.tests.commands',
3355
'bzrlib.tests.interrepository_implementations',
3356
'bzrlib.tests.intertree_implementations',
3357
'bzrlib.tests.inventory_implementations',
3358
'bzrlib.tests.per_interbranch',
3359
'bzrlib.tests.per_lock',
3360
'bzrlib.tests.per_repository',
3361
'bzrlib.tests.per_repository_chk',
3362
'bzrlib.tests.per_repository_reference',
3363
'bzrlib.tests.test__chk_map',
3364
'bzrlib.tests.test__dirstate_helpers',
3365
'bzrlib.tests.test__groupcompress',
3366
'bzrlib.tests.test__rio',
3367
'bzrlib.tests.test__walkdirs_win32',
3368
'bzrlib.tests.test_ancestry',
3369
'bzrlib.tests.test_annotate',
3370
'bzrlib.tests.test_api',
3371
'bzrlib.tests.test_atomicfile',
3372
'bzrlib.tests.test_bad_files',
3373
'bzrlib.tests.test_bisect_multi',
3374
'bzrlib.tests.test_branch',
3375
'bzrlib.tests.test_branchbuilder',
3376
'bzrlib.tests.test_btree_index',
3377
'bzrlib.tests.test_bugtracker',
3378
'bzrlib.tests.test_bundle',
3379
'bzrlib.tests.test_bzrdir',
3380
'bzrlib.tests.test__chunks_to_lines',
3381
'bzrlib.tests.test_cache_utf8',
3382
'bzrlib.tests.test_chk_map',
3383
'bzrlib.tests.test_chunk_writer',
3384
'bzrlib.tests.test_clean_tree',
3385
'bzrlib.tests.test_commands',
3386
'bzrlib.tests.test_commit',
3387
'bzrlib.tests.test_commit_merge',
3388
'bzrlib.tests.test_config',
3389
'bzrlib.tests.test_conflicts',
3390
'bzrlib.tests.test_counted_lock',
3391
'bzrlib.tests.test_decorators',
3392
'bzrlib.tests.test_delta',
3393
'bzrlib.tests.test_debug',
3394
'bzrlib.tests.test_deprecated_graph',
3395
'bzrlib.tests.test_diff',
3396
'bzrlib.tests.test_directory_service',
3397
'bzrlib.tests.test_dirstate',
3398
'bzrlib.tests.test_email_message',
3399
'bzrlib.tests.test_eol_filters',
3400
'bzrlib.tests.test_errors',
3401
'bzrlib.tests.test_export',
3402
'bzrlib.tests.test_extract',
3403
'bzrlib.tests.test_fetch',
3404
'bzrlib.tests.test_fifo_cache',
3405
'bzrlib.tests.test_filters',
3406
'bzrlib.tests.test_ftp_transport',
3407
'bzrlib.tests.test_foreign',
3408
'bzrlib.tests.test_generate_docs',
3409
'bzrlib.tests.test_generate_ids',
3410
'bzrlib.tests.test_globbing',
3411
'bzrlib.tests.test_gpg',
3412
'bzrlib.tests.test_graph',
3413
'bzrlib.tests.test_groupcompress',
3414
'bzrlib.tests.test_hashcache',
3415
'bzrlib.tests.test_help',
3416
'bzrlib.tests.test_hooks',
3417
'bzrlib.tests.test_http',
3418
'bzrlib.tests.test_http_response',
3419
'bzrlib.tests.test_https_ca_bundle',
3420
'bzrlib.tests.test_identitymap',
3421
'bzrlib.tests.test_ignores',
3422
'bzrlib.tests.test_index',
3423
'bzrlib.tests.test_info',
3424
'bzrlib.tests.test_inv',
3425
'bzrlib.tests.test_inventory_delta',
3426
'bzrlib.tests.test_knit',
3427
'bzrlib.tests.test_lazy_import',
3428
'bzrlib.tests.test_lazy_regex',
3429
'bzrlib.tests.test_lockable_files',
3430
'bzrlib.tests.test_lockdir',
3431
'bzrlib.tests.test_log',
3432
'bzrlib.tests.test_lru_cache',
3433
'bzrlib.tests.test_lsprof',
3434
'bzrlib.tests.test_mail_client',
3435
'bzrlib.tests.test_memorytree',
3436
'bzrlib.tests.test_merge',
3437
'bzrlib.tests.test_merge3',
3438
'bzrlib.tests.test_merge_core',
3439
'bzrlib.tests.test_merge_directive',
3440
'bzrlib.tests.test_missing',
3441
'bzrlib.tests.test_msgeditor',
3442
'bzrlib.tests.test_multiparent',
3443
'bzrlib.tests.test_mutabletree',
3444
'bzrlib.tests.test_nonascii',
3445
'bzrlib.tests.test_options',
3446
'bzrlib.tests.test_osutils',
3447
'bzrlib.tests.test_osutils_encodings',
3448
'bzrlib.tests.test_pack',
3449
'bzrlib.tests.test_pack_repository',
3450
'bzrlib.tests.test_patch',
3451
'bzrlib.tests.test_patches',
3452
'bzrlib.tests.test_permissions',
3453
'bzrlib.tests.test_plugins',
3454
'bzrlib.tests.test_progress',
3455
'bzrlib.tests.test_read_bundle',
3456
'bzrlib.tests.test_reconcile',
3457
'bzrlib.tests.test_reconfigure',
3458
'bzrlib.tests.test_registry',
3459
'bzrlib.tests.test_remote',
3460
'bzrlib.tests.test_rename_map',
3461
'bzrlib.tests.test_repository',
3462
'bzrlib.tests.test_revert',
3463
'bzrlib.tests.test_revision',
3464
'bzrlib.tests.test_revisionspec',
3465
'bzrlib.tests.test_revisiontree',
3466
'bzrlib.tests.test_rio',
3467
'bzrlib.tests.test_rules',
3468
'bzrlib.tests.test_sampler',
3469
'bzrlib.tests.test_selftest',
3470
'bzrlib.tests.test_serializer',
3471
'bzrlib.tests.test_setup',
3472
'bzrlib.tests.test_sftp_transport',
3473
'bzrlib.tests.test_shelf',
3474
'bzrlib.tests.test_shelf_ui',
3475
'bzrlib.tests.test_smart',
3476
'bzrlib.tests.test_smart_add',
3477
'bzrlib.tests.test_smart_request',
3478
'bzrlib.tests.test_smart_transport',
3479
'bzrlib.tests.test_smtp_connection',
3480
'bzrlib.tests.test_source',
3481
'bzrlib.tests.test_ssh_transport',
3482
'bzrlib.tests.test_status',
3483
'bzrlib.tests.test_store',
3484
'bzrlib.tests.test_strace',
3485
'bzrlib.tests.test_subsume',
3486
'bzrlib.tests.test_switch',
3487
'bzrlib.tests.test_symbol_versioning',
3488
'bzrlib.tests.test_tag',
3489
'bzrlib.tests.test_testament',
3490
'bzrlib.tests.test_textfile',
3491
'bzrlib.tests.test_textmerge',
3492
'bzrlib.tests.test_timestamp',
3493
'bzrlib.tests.test_trace',
3494
'bzrlib.tests.test_transactions',
3495
'bzrlib.tests.test_transform',
3496
'bzrlib.tests.test_transport',
3497
'bzrlib.tests.test_transport_implementations',
3498
'bzrlib.tests.test_transport_log',
3499
'bzrlib.tests.test_tree',
3500
'bzrlib.tests.test_treebuilder',
3501
'bzrlib.tests.test_tsort',
3502
'bzrlib.tests.test_tuned_gzip',
3503
'bzrlib.tests.test_ui',
3504
'bzrlib.tests.test_uncommit',
3505
'bzrlib.tests.test_upgrade',
3506
'bzrlib.tests.test_upgrade_stacked',
3507
'bzrlib.tests.test_urlutils',
3508
'bzrlib.tests.test_version',
3509
'bzrlib.tests.test_version_info',
3510
'bzrlib.tests.test_versionedfile',
3511
'bzrlib.tests.test_weave',
3512
'bzrlib.tests.test_whitebox',
3513
'bzrlib.tests.test_win32utils',
3514
'bzrlib.tests.test_workingtree',
3515
'bzrlib.tests.test_workingtree_4',
3516
'bzrlib.tests.test_wsgi',
3517
'bzrlib.tests.test_xml',
3518
'bzrlib.tests.tree_implementations',
3519
'bzrlib.tests.workingtree_implementations',
3520
'bzrlib.util.tests.test_bencode',
3523
loader = TestUtil.TestLoader()
3526
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3527
for start in starting_with]
3528
# We take precedence over keep_only because *at loading time* using
3529
# both options means we will load less tests for the same final result.
3530
def interesting_module(name):
3531
for start in starting_with:
3533
# Either the module name starts with the specified string
3534
name.startswith(start)
3535
# or it may contain tests starting with the specified string
3536
or start.startswith(name)
3540
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3542
elif keep_only is not None:
3543
id_filter = TestIdList(keep_only)
3544
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3545
def interesting_module(name):
3546
return id_filter.refers_to(name)
3549
loader = TestUtil.TestLoader()
3550
def interesting_module(name):
3551
# No filtering, all modules are interesting
3554
suite = loader.suiteClass()
3556
# modules building their suite with loadTestsFromModuleNames
3557
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
3559
modules_to_doctest = [
3561
'bzrlib.branchbuilder',
3564
'bzrlib.iterablefile',
3568
'bzrlib.symbol_versioning',
3571
'bzrlib.version_info_formats.format_custom',
3574
for mod in modules_to_doctest:
3575
if not interesting_module(mod):
3576
# No tests to keep here, move along
3579
# note that this really does mean "report only" -- doctest
3580
# still runs the rest of the examples
3581
doc_suite = doctest.DocTestSuite(mod,
3582
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3583
except ValueError, e:
3584
print '**failed to get doctest for: %s\n%s' % (mod, e)
3586
if len(doc_suite._tests) == 0:
3587
raise errors.BzrError("no doctests found in %s" % (mod,))
3588
suite.addTest(doc_suite)
3590
default_encoding = sys.getdefaultencoding()
3591
for name, plugin in bzrlib.plugin.plugins().items():
3592
if not interesting_module(plugin.module.__name__):
3594
plugin_suite = plugin.test_suite()
3595
# We used to catch ImportError here and turn it into just a warning,
3596
# but really if you don't have --no-plugins this should be a failure.
3597
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3598
if plugin_suite is None:
3599
plugin_suite = plugin.load_plugin_tests(loader)
3600
if plugin_suite is not None:
3601
suite.addTest(plugin_suite)
3602
if default_encoding != sys.getdefaultencoding():
3603
bzrlib.trace.warning(
3604
'Plugin "%s" tried to reset default encoding to: %s', name,
3605
sys.getdefaultencoding())
3607
sys.setdefaultencoding(default_encoding)
3610
suite = filter_suite_by_id_startswith(suite, starting_with)
3612
if keep_only is not None:
3613
# Now that the referred modules have loaded their tests, keep only the
3615
suite = filter_suite_by_id_list(suite, id_filter)
3616
# Do some sanity checks on the id_list filtering
3617
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3619
# The tester has used both keep_only and starting_with, so he is
3620
# already aware that some tests are excluded from the list, there
3621
# is no need to tell him which.
3624
# Some tests mentioned in the list are not in the test suite. The
3625
# list may be out of date, report to the tester.
3626
for id in not_found:
3627
bzrlib.trace.warning('"%s" not found in the test suite', id)
3628
for id in duplicates:
3629
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3634
def multiply_scenarios(scenarios_left, scenarios_right):
3635
"""Multiply two sets of scenarios.
3637
:returns: the cartesian product of the two sets of scenarios, that is
3638
a scenario for every possible combination of a left scenario and a
3642
('%s,%s' % (left_name, right_name),
3643
dict(left_dict.items() + right_dict.items()))
3644
for left_name, left_dict in scenarios_left
3645
for right_name, right_dict in scenarios_right]
3648
def multiply_tests(tests, scenarios, result):
3649
"""Multiply tests_list by scenarios into result.
3651
This is the core workhorse for test parameterisation.
3653
Typically the load_tests() method for a per-implementation test suite will
3654
call multiply_tests and return the result.
3656
:param tests: The tests to parameterise.
3657
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3658
scenario_param_dict).
3659
:param result: A TestSuite to add created tests to.
3661
This returns the passed in result TestSuite with the cross product of all
3662
the tests repeated once for each scenario. Each test is adapted by adding
3663
the scenario name at the end of its id(), and updating the test object's
3664
__dict__ with the scenario_param_dict.
3666
>>> import bzrlib.tests.test_sampler
3667
>>> r = multiply_tests(
3668
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3669
... [('one', dict(param=1)),
3670
... ('two', dict(param=2))],
3672
>>> tests = list(iter_suite_tests(r))
3676
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3682
for test in iter_suite_tests(tests):
3683
apply_scenarios(test, scenarios, result)
3687
def apply_scenarios(test, scenarios, result):
3688
"""Apply the scenarios in scenarios to test and add to result.
3690
:param test: The test to apply scenarios to.
3691
:param scenarios: An iterable of scenarios to apply to test.
3693
:seealso: apply_scenario
3695
for scenario in scenarios:
3696
result.addTest(apply_scenario(test, scenario))
3700
def apply_scenario(test, scenario):
3701
"""Copy test and apply scenario to it.
3703
:param test: A test to adapt.
3704
:param scenario: A tuple describing the scenarion.
3705
The first element of the tuple is the new test id.
3706
The second element is a dict containing attributes to set on the
3708
:return: The adapted test.
3710
new_id = "%s(%s)" % (test.id(), scenario[0])
3711
new_test = clone_test(test, new_id)
3712
for name, value in scenario[1].items():
3713
setattr(new_test, name, value)
3717
def clone_test(test, new_id):
3718
"""Clone a test giving it a new id.
3720
:param test: The test to clone.
3721
:param new_id: The id to assign to it.
3722
:return: The new test.
3724
from copy import deepcopy
3725
new_test = deepcopy(test)
3726
new_test.id = lambda: new_id
3730
def _rmtree_temp_dir(dirname):
3731
# If LANG=C we probably have created some bogus paths
3732
# which rmtree(unicode) will fail to delete
3733
# so make sure we are using rmtree(str) to delete everything
3734
# except on win32, where rmtree(str) will fail
3735
# since it doesn't have the property of byte-stream paths
3736
# (they are either ascii or mbcs)
3737
if sys.platform == 'win32':
3738
# make sure we are using the unicode win32 api
3739
dirname = unicode(dirname)
3741
dirname = dirname.encode(sys.getfilesystemencoding())
3743
osutils.rmtree(dirname)
3745
if sys.platform == 'win32' and e.errno == errno.EACCES:
3746
sys.stderr.write('Permission denied: '
3747
'unable to remove testing dir '
3749
% (os.path.basename(dirname), e))
3754
class Feature(object):
3755
"""An operating system Feature."""
3758
self._available = None
3760
def available(self):
3761
"""Is the feature available?
3763
:return: True if the feature is available.
3765
if self._available is None:
3766
self._available = self._probe()
3767
return self._available
3770
"""Implement this method in concrete features.
3772
:return: True if the feature is available.
3774
raise NotImplementedError
3777
if getattr(self, 'feature_name', None):
3778
return self.feature_name()
3779
return self.__class__.__name__
3782
class _SymlinkFeature(Feature):
3785
return osutils.has_symlinks()
3787
def feature_name(self):
3790
SymlinkFeature = _SymlinkFeature()
3793
class _HardlinkFeature(Feature):
3796
return osutils.has_hardlinks()
3798
def feature_name(self):
3801
HardlinkFeature = _HardlinkFeature()
3804
class _OsFifoFeature(Feature):
3807
return getattr(os, 'mkfifo', None)
3809
def feature_name(self):
3810
return 'filesystem fifos'
3812
OsFifoFeature = _OsFifoFeature()
3815
class _UnicodeFilenameFeature(Feature):
3816
"""Does the filesystem support Unicode filenames?"""
3820
# Check for character combinations unlikely to be covered by any
3821
# single non-unicode encoding. We use the characters
3822
# - greek small letter alpha (U+03B1) and
3823
# - braille pattern dots-123456 (U+283F).
3824
os.stat(u'\u03b1\u283f')
3825
except UnicodeEncodeError:
3827
except (IOError, OSError):
3828
# The filesystem allows the Unicode filename but the file doesn't
3832
# The filesystem allows the Unicode filename and the file exists,
3836
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3839
def probe_unicode_in_user_encoding():
3840
"""Try to encode several unicode strings to use in unicode-aware tests.
3841
Return first successfull match.
3843
:return: (unicode value, encoded plain string value) or (None, None)
3845
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3846
for uni_val in possible_vals:
3848
str_val = uni_val.encode(osutils.get_user_encoding())
3849
except UnicodeEncodeError:
3850
# Try a different character
3853
return uni_val, str_val
3857
def probe_bad_non_ascii(encoding):
3858
"""Try to find [bad] character with code [128..255]
3859
that cannot be decoded to unicode in some encoding.
3860
Return None if all non-ascii characters is valid
3863
for i in xrange(128, 256):
3866
char.decode(encoding)
3867
except UnicodeDecodeError:
3872
class _HTTPSServerFeature(Feature):
3873
"""Some tests want an https Server, check if one is available.
3875
Right now, the only way this is available is under python2.6 which provides
3886
def feature_name(self):
3887
return 'HTTPSServer'
3890
HTTPSServerFeature = _HTTPSServerFeature()
3893
class _UnicodeFilename(Feature):
3894
"""Does the filesystem support Unicode filenames?"""
3899
except UnicodeEncodeError:
3901
except (IOError, OSError):
3902
# The filesystem allows the Unicode filename but the file doesn't
3906
# The filesystem allows the Unicode filename and the file exists,
3910
UnicodeFilename = _UnicodeFilename()
3913
class _UTF8Filesystem(Feature):
3914
"""Is the filesystem UTF-8?"""
3917
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3921
UTF8Filesystem = _UTF8Filesystem()
3924
class _CaseInsCasePresFilenameFeature(Feature):
3925
"""Is the file-system case insensitive, but case-preserving?"""
3928
fileno, name = tempfile.mkstemp(prefix='MixedCase')
3930
# first check truly case-preserving for created files, then check
3931
# case insensitive when opening existing files.
3932
name = osutils.normpath(name)
3933
base, rel = osutils.split(name)
3934
found_rel = osutils.canonical_relpath(base, name)
3935
return (found_rel == rel
3936
and os.path.isfile(name.upper())
3937
and os.path.isfile(name.lower()))
3942
def feature_name(self):
3943
return "case-insensitive case-preserving filesystem"
3945
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
3948
class _CaseInsensitiveFilesystemFeature(Feature):
3949
"""Check if underlying filesystem is case-insensitive but *not* case
3952
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
3953
# more likely to be case preserving, so this case is rare.
3956
if CaseInsCasePresFilenameFeature.available():
3959
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3960
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3961
TestCaseWithMemoryTransport.TEST_ROOT = root
3963
root = TestCaseWithMemoryTransport.TEST_ROOT
3964
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3966
name_a = osutils.pathjoin(tdir, 'a')
3967
name_A = osutils.pathjoin(tdir, 'A')
3969
result = osutils.isdir(name_A)
3970
_rmtree_temp_dir(tdir)
3973
def feature_name(self):
3974
return 'case-insensitive filesystem'
3976
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
3979
class _SubUnitFeature(Feature):
3980
"""Check if subunit is available."""
3989
def feature_name(self):
3992
SubUnitFeature = _SubUnitFeature()
3993
# Only define SubUnitBzrRunner if subunit is available.
3995
from subunit import TestProtocolClient
3996
class SubUnitBzrRunner(TextTestRunner):
3997
def run(self, test):
3998
result = TestProtocolClient(self.stream)
added
removed
bzrlib/tests/__init__.py
